1
# Copyright (C) 2004-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.transport import memory
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
from bzrlib.smtp_connection import SMTPConnection
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import Command, display_command
64
from bzrlib.option import (
71
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
74
def tree_files(file_list, default_branch=u'.', canonicalize=True,
77
return internal_tree_files(file_list, default_branch, canonicalize,
79
except errors.FileInWrongBranch, e:
80
raise errors.BzrCommandError("%s is not in the same branch as %s" %
81
(e.path, file_list[0]))
84
def tree_files_for_add(file_list):
86
Return a tree and list of absolute paths from a file list.
88
Similar to tree_files, but add handles files a bit differently, so it a
89
custom implementation. In particular, MutableTreeTree.smart_add expects
90
absolute paths, which it immediately converts to relative paths.
92
# FIXME Would be nice to just return the relative paths like
93
# internal_tree_files does, but there are a large number of unit tests
94
# that assume the current interface to mutabletree.smart_add
96
tree, relpath = WorkingTree.open_containing(file_list[0])
97
if tree.supports_views():
98
view_files = tree.views.lookup_view()
100
for filename in file_list:
101
if not osutils.is_inside_any(view_files, filename):
102
raise errors.FileOutsideView(filename, view_files)
103
file_list = file_list[:]
104
file_list[0] = tree.abspath(relpath)
106
tree = WorkingTree.open_containing(u'.')[0]
107
if tree.supports_views():
108
view_files = tree.views.lookup_view()
110
file_list = view_files
111
view_str = views.view_display_str(view_files)
112
note("Ignoring files outside view. View is %s" % view_str)
113
return tree, file_list
116
def _get_one_revision(command_name, revisions):
117
if revisions is None:
119
if len(revisions) != 1:
120
raise errors.BzrCommandError(
121
'bzr %s --revision takes exactly one revision identifier' % (
126
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
127
"""Get a revision tree. Not suitable for commands that change the tree.
129
Specifically, the basis tree in dirstate trees is coupled to the dirstate
130
and doing a commit/uncommit/pull will at best fail due to changing the
133
If tree is passed in, it should be already locked, for lifetime management
134
of the trees internal cached state.
138
if revisions is None:
140
rev_tree = tree.basis_tree()
142
rev_tree = branch.basis_tree()
144
revision = _get_one_revision(command_name, revisions)
145
rev_tree = revision.as_tree(branch)
149
# XXX: Bad function name; should possibly also be a class method of
150
# WorkingTree rather than a function.
151
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
153
"""Convert command-line paths to a WorkingTree and relative paths.
155
This is typically used for command-line processors that take one or
156
more filenames, and infer the workingtree that contains them.
158
The filenames given are not required to exist.
160
:param file_list: Filenames to convert.
162
:param default_branch: Fallback tree path to use if file_list is empty or
165
:param apply_view: if True and a view is set, apply it or check that
166
specified files are within it
168
:return: workingtree, [relative_paths]
170
if file_list is None or len(file_list) == 0:
171
tree = WorkingTree.open_containing(default_branch)[0]
172
if tree.supports_views() and apply_view:
173
view_files = tree.views.lookup_view()
175
file_list = view_files
176
view_str = views.view_display_str(view_files)
177
note("Ignoring files outside view. View is %s" % view_str)
178
return tree, file_list
179
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
180
return tree, safe_relpath_files(tree, file_list, canonicalize,
181
apply_view=apply_view)
184
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
185
"""Convert file_list into a list of relpaths in tree.
187
:param tree: A tree to operate on.
188
:param file_list: A list of user provided paths or None.
189
:param apply_view: if True and a view is set, apply it or check that
190
specified files are within it
191
:return: A list of relative paths.
192
:raises errors.PathNotChild: When a provided path is in a different tree
195
if file_list is None:
197
if tree.supports_views() and apply_view:
198
view_files = tree.views.lookup_view()
202
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
203
# doesn't - fix that up here before we enter the loop.
205
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
208
for filename in file_list:
210
relpath = fixer(osutils.dereference_path(filename))
211
if view_files and not osutils.is_inside_any(view_files, relpath):
212
raise errors.FileOutsideView(filename, view_files)
213
new_list.append(relpath)
214
except errors.PathNotChild:
215
raise errors.FileInWrongBranch(tree.branch, filename)
219
def _get_view_info_for_change_reporter(tree):
220
"""Get the view information from a tree for change reporting."""
223
current_view = tree.views.get_view_info()[0]
224
if current_view is not None:
225
view_info = (current_view, tree.views.lookup_view())
226
except errors.ViewsNotSupported:
231
# TODO: Make sure no commands unconditionally use the working directory as a
232
# branch. If a filename argument is used, the first of them should be used to
233
# specify the branch. (Perhaps this can be factored out into some kind of
234
# Argument class, representing a file in a branch, where the first occurrence
237
class cmd_status(Command):
238
"""Display status summary.
240
This reports on versioned and unknown files, reporting them
241
grouped by state. Possible states are:
244
Versioned in the working copy but not in the previous revision.
247
Versioned in the previous revision but removed or deleted
251
Path of this file changed from the previous revision;
252
the text may also have changed. This includes files whose
253
parent directory was renamed.
256
Text has changed since the previous revision.
259
File kind has been changed (e.g. from file to directory).
262
Not versioned and not matching an ignore pattern.
264
Additionally for directories, symlinks and files with an executable
265
bit, Bazaar indicates their type using a trailing character: '/', '@'
268
To see ignored files use 'bzr ignored'. For details on the
269
changes to file texts, use 'bzr diff'.
271
Note that --short or -S gives status flags for each item, similar
272
to Subversion's status command. To get output similar to svn -q,
275
If no arguments are specified, the status of the entire working
276
directory is shown. Otherwise, only the status of the specified
277
files or directories is reported. If a directory is given, status
278
is reported for everything inside that directory.
280
Before merges are committed, the pending merge tip revisions are
281
shown. To see all pending merge revisions, use the -v option.
282
To skip the display of pending merge information altogether, use
283
the no-pending option or specify a file/directory.
285
If a revision argument is given, the status is calculated against
286
that revision, or between two revisions if two are provided.
289
# TODO: --no-recurse, --recurse options
291
takes_args = ['file*']
292
takes_options = ['show-ids', 'revision', 'change', 'verbose',
293
Option('short', help='Use short status indicators.',
295
Option('versioned', help='Only show versioned files.',
297
Option('no-pending', help='Don\'t show pending merges.',
300
aliases = ['st', 'stat']
302
encoding_type = 'replace'
303
_see_also = ['diff', 'revert', 'status-flags']
306
def run(self, show_ids=False, file_list=None, revision=None, short=False,
307
versioned=False, no_pending=False, verbose=False):
308
from bzrlib.status import show_tree_status
310
if revision and len(revision) > 2:
311
raise errors.BzrCommandError('bzr status --revision takes exactly'
312
' one or two revision specifiers')
314
tree, relfile_list = tree_files(file_list)
315
# Avoid asking for specific files when that is not needed.
316
if relfile_list == ['']:
318
# Don't disable pending merges for full trees other than '.'.
319
if file_list == ['.']:
321
# A specific path within a tree was given.
322
elif relfile_list is not None:
324
show_tree_status(tree, show_ids=show_ids,
325
specific_files=relfile_list, revision=revision,
326
to_file=self.outf, short=short, versioned=versioned,
327
show_pending=(not no_pending), verbose=verbose)
330
class cmd_cat_revision(Command):
331
"""Write out metadata for a revision.
333
The revision to print can either be specified by a specific
334
revision identifier, or you can use --revision.
338
takes_args = ['revision_id?']
339
takes_options = ['revision']
340
# cat-revision is more for frontends so should be exact
344
def run(self, revision_id=None, revision=None):
345
if revision_id is not None and revision is not None:
346
raise errors.BzrCommandError('You can only supply one of'
347
' revision_id or --revision')
348
if revision_id is None and revision is None:
349
raise errors.BzrCommandError('You must supply either'
350
' --revision or a revision_id')
351
b = WorkingTree.open_containing(u'.')[0].branch
353
# TODO: jam 20060112 should cat-revision always output utf-8?
354
if revision_id is not None:
355
revision_id = osutils.safe_revision_id(revision_id, warn=False)
357
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
358
except errors.NoSuchRevision:
359
msg = "The repository %s contains no revision %s." % (b.repository.base,
361
raise errors.BzrCommandError(msg)
362
elif revision is not None:
365
raise errors.BzrCommandError('You cannot specify a NULL'
367
rev_id = rev.as_revision_id(b)
368
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
371
class cmd_dump_btree(Command):
372
"""Dump the contents of a btree index file to stdout.
374
PATH is a btree index file, it can be any URL. This includes things like
375
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
377
By default, the tuples stored in the index file will be displayed. With
378
--raw, we will uncompress the pages, but otherwise display the raw bytes
382
# TODO: Do we want to dump the internal nodes as well?
383
# TODO: It would be nice to be able to dump the un-parsed information,
384
# rather than only going through iter_all_entries. However, this is
385
# good enough for a start
387
encoding_type = 'exact'
388
takes_args = ['path']
389
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
390
' rather than the parsed tuples.'),
393
def run(self, path, raw=False):
394
dirname, basename = osutils.split(path)
395
t = transport.get_transport(dirname)
397
self._dump_raw_bytes(t, basename)
399
self._dump_entries(t, basename)
401
def _get_index_and_bytes(self, trans, basename):
402
"""Create a BTreeGraphIndex and raw bytes."""
403
bt = btree_index.BTreeGraphIndex(trans, basename, None)
404
bytes = trans.get_bytes(basename)
405
bt._file = cStringIO.StringIO(bytes)
406
bt._size = len(bytes)
409
def _dump_raw_bytes(self, trans, basename):
412
# We need to parse at least the root node.
413
# This is because the first page of every row starts with an
414
# uncompressed header.
415
bt, bytes = self._get_index_and_bytes(trans, basename)
416
for page_idx, page_start in enumerate(xrange(0, len(bytes),
417
btree_index._PAGE_SIZE)):
418
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
419
page_bytes = bytes[page_start:page_end]
421
self.outf.write('Root node:\n')
422
header_end, data = bt._parse_header_from_bytes(page_bytes)
423
self.outf.write(page_bytes[:header_end])
425
self.outf.write('\nPage %d\n' % (page_idx,))
426
decomp_bytes = zlib.decompress(page_bytes)
427
self.outf.write(decomp_bytes)
428
self.outf.write('\n')
430
def _dump_entries(self, trans, basename):
432
st = trans.stat(basename)
433
except errors.TransportNotPossible:
434
# We can't stat, so we'll fake it because we have to do the 'get()'
436
bt, _ = self._get_index_and_bytes(trans, basename)
438
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
439
for node in bt.iter_all_entries():
440
# Node is made up of:
441
# (index, key, value, [references])
442
refs_as_tuples = static_tuple.as_tuples(node[3])
443
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
444
self.outf.write('%s\n' % (as_tuple,))
447
class cmd_remove_tree(Command):
448
"""Remove the working tree from a given branch/checkout.
450
Since a lightweight checkout is little more than a working tree
451
this will refuse to run against one.
453
To re-create the working tree, use "bzr checkout".
455
_see_also = ['checkout', 'working-trees']
456
takes_args = ['location?']
459
help='Remove the working tree even if it has '
460
'uncommitted changes.'),
463
def run(self, location='.', force=False):
464
d = bzrdir.BzrDir.open(location)
467
working = d.open_workingtree()
468
except errors.NoWorkingTree:
469
raise errors.BzrCommandError("No working tree to remove")
470
except errors.NotLocalUrl:
471
raise errors.BzrCommandError("You cannot remove the working tree"
474
if (working.has_changes()):
475
raise errors.UncommittedChanges(working)
477
working_path = working.bzrdir.root_transport.base
478
branch_path = working.branch.bzrdir.root_transport.base
479
if working_path != branch_path:
480
raise errors.BzrCommandError("You cannot remove the working tree"
481
" from a lightweight checkout")
483
d.destroy_workingtree()
486
class cmd_revno(Command):
487
"""Show current revision number.
489
This is equal to the number of revisions on this branch.
493
takes_args = ['location?']
495
Option('tree', help='Show revno of working tree'),
499
def run(self, tree=False, location=u'.'):
502
wt = WorkingTree.open_containing(location)[0]
504
except (errors.NoWorkingTree, errors.NotLocalUrl):
505
raise errors.NoWorkingTree(location)
506
self.add_cleanup(wt.unlock)
507
revid = wt.last_revision()
509
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
510
except errors.NoSuchRevision:
512
revno = ".".join(str(n) for n in revno_t)
514
b = Branch.open_containing(location)[0]
516
self.add_cleanup(b.unlock)
519
self.outf.write(str(revno) + '\n')
522
class cmd_revision_info(Command):
523
"""Show revision number and revision id for a given revision identifier.
526
takes_args = ['revision_info*']
530
help='Branch to examine, '
531
'rather than the one containing the working directory.',
535
Option('tree', help='Show revno of working tree'),
539
def run(self, revision=None, directory=u'.', tree=False,
540
revision_info_list=[]):
543
wt = WorkingTree.open_containing(directory)[0]
546
self.add_cleanup(wt.unlock)
547
except (errors.NoWorkingTree, errors.NotLocalUrl):
549
b = Branch.open_containing(directory)[0]
551
self.add_cleanup(b.unlock)
553
if revision is not None:
554
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
555
if revision_info_list is not None:
556
for rev_str in revision_info_list:
557
rev_spec = RevisionSpec.from_string(rev_str)
558
revision_ids.append(rev_spec.as_revision_id(b))
559
# No arguments supplied, default to the last revision
560
if len(revision_ids) == 0:
563
raise errors.NoWorkingTree(directory)
564
revision_ids.append(wt.last_revision())
566
revision_ids.append(b.last_revision())
570
for revision_id in revision_ids:
572
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
573
revno = '.'.join(str(i) for i in dotted_revno)
574
except errors.NoSuchRevision:
576
maxlen = max(maxlen, len(revno))
577
revinfos.append([revno, revision_id])
581
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
584
class cmd_add(Command):
585
"""Add specified files or directories.
587
In non-recursive mode, all the named items are added, regardless
588
of whether they were previously ignored. A warning is given if
589
any of the named files are already versioned.
591
In recursive mode (the default), files are treated the same way
592
but the behaviour for directories is different. Directories that
593
are already versioned do not give a warning. All directories,
594
whether already versioned or not, are searched for files or
595
subdirectories that are neither versioned or ignored, and these
596
are added. This search proceeds recursively into versioned
597
directories. If no names are given '.' is assumed.
599
Therefore simply saying 'bzr add' will version all files that
600
are currently unknown.
602
Adding a file whose parent directory is not versioned will
603
implicitly add the parent, and so on up to the root. This means
604
you should never need to explicitly add a directory, they'll just
605
get added when you add a file in the directory.
607
--dry-run will show which files would be added, but not actually
610
--file-ids-from will try to use the file ids from the supplied path.
611
It looks up ids trying to find a matching parent directory with the
612
same filename, and then by pure path. This option is rarely needed
613
but can be useful when adding the same logical file into two
614
branches that will be merged later (without showing the two different
615
adds as a conflict). It is also useful when merging another project
616
into a subdirectory of this one.
618
Any files matching patterns in the ignore list will not be added
619
unless they are explicitly mentioned.
621
takes_args = ['file*']
624
help="Don't recursively add the contents of directories."),
626
help="Show what would be done, but don't actually do anything."),
628
Option('file-ids-from',
630
help='Lookup file ids from this tree.'),
632
encoding_type = 'replace'
633
_see_also = ['remove', 'ignore']
635
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
640
if file_ids_from is not None:
642
base_tree, base_path = WorkingTree.open_containing(
644
except errors.NoWorkingTree:
645
base_branch, base_path = Branch.open_containing(
647
base_tree = base_branch.basis_tree()
649
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
650
to_file=self.outf, should_print=(not is_quiet()))
652
action = bzrlib.add.AddAction(to_file=self.outf,
653
should_print=(not is_quiet()))
656
base_tree.lock_read()
657
self.add_cleanup(base_tree.unlock)
658
tree, file_list = tree_files_for_add(file_list)
659
added, ignored = tree.smart_add(file_list, not
660
no_recurse, action=action, save=not dry_run)
664
for glob in sorted(ignored.keys()):
665
for path in ignored[glob]:
666
self.outf.write("ignored %s matching \"%s\"\n"
670
class cmd_mkdir(Command):
671
"""Create a new versioned directory.
673
This is equivalent to creating the directory and then adding it.
676
takes_args = ['dir+']
677
encoding_type = 'replace'
679
def run(self, dir_list):
682
wt, dd = WorkingTree.open_containing(d)
684
self.outf.write('added %s\n' % d)
687
class cmd_relpath(Command):
688
"""Show path of a file relative to root"""
690
takes_args = ['filename']
694
def run(self, filename):
695
# TODO: jam 20050106 Can relpath return a munged path if
696
# sys.stdout encoding cannot represent it?
697
tree, relpath = WorkingTree.open_containing(filename)
698
self.outf.write(relpath)
699
self.outf.write('\n')
702
class cmd_inventory(Command):
703
"""Show inventory of the current working copy or a revision.
705
It is possible to limit the output to a particular entry
706
type using the --kind option. For example: --kind file.
708
It is also possible to restrict the list of files to a specific
709
set. For example: bzr inventory --show-ids this/file
718
help='List entries of a particular kind: file, directory, symlink.',
721
takes_args = ['file*']
724
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
725
if kind and kind not in ['file', 'directory', 'symlink']:
726
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
728
revision = _get_one_revision('inventory', revision)
729
work_tree, file_list = tree_files(file_list)
730
work_tree.lock_read()
731
self.add_cleanup(work_tree.unlock)
732
if revision is not None:
733
tree = revision.as_tree(work_tree.branch)
735
extra_trees = [work_tree]
737
self.add_cleanup(tree.unlock)
742
if file_list is not None:
743
file_ids = tree.paths2ids(file_list, trees=extra_trees,
744
require_versioned=True)
745
# find_ids_across_trees may include some paths that don't
747
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
748
for file_id in file_ids if file_id in tree)
750
entries = tree.inventory.entries()
753
for path, entry in entries:
754
if kind and kind != entry.kind:
757
self.outf.write('%-50s %s\n' % (path, entry.file_id))
759
self.outf.write(path)
760
self.outf.write('\n')
763
class cmd_mv(Command):
764
"""Move or rename a file.
767
bzr mv OLDNAME NEWNAME
769
bzr mv SOURCE... DESTINATION
771
If the last argument is a versioned directory, all the other names
772
are moved into it. Otherwise, there must be exactly two arguments
773
and the file is changed to a new name.
775
If OLDNAME does not exist on the filesystem but is versioned and
776
NEWNAME does exist on the filesystem but is not versioned, mv
777
assumes that the file has been manually moved and only updates
778
its internal inventory to reflect that change.
779
The same is valid when moving many SOURCE files to a DESTINATION.
781
Files cannot be moved between branches.
784
takes_args = ['names*']
785
takes_options = [Option("after", help="Move only the bzr identifier"
786
" of the file, because the file has already been moved."),
787
Option('auto', help='Automatically guess renames.'),
788
Option('dry-run', help='Avoid making changes when guessing renames.'),
790
aliases = ['move', 'rename']
791
encoding_type = 'replace'
793
def run(self, names_list, after=False, auto=False, dry_run=False):
795
return self.run_auto(names_list, after, dry_run)
797
raise errors.BzrCommandError('--dry-run requires --auto.')
798
if names_list is None:
800
if len(names_list) < 2:
801
raise errors.BzrCommandError("missing file argument")
802
tree, rel_names = tree_files(names_list, canonicalize=False)
803
tree.lock_tree_write()
804
self.add_cleanup(tree.unlock)
805
self._run(tree, names_list, rel_names, after)
807
def run_auto(self, names_list, after, dry_run):
808
if names_list is not None and len(names_list) > 1:
809
raise errors.BzrCommandError('Only one path may be specified to'
812
raise errors.BzrCommandError('--after cannot be specified with'
814
work_tree, file_list = tree_files(names_list, default_branch='.')
815
work_tree.lock_tree_write()
816
self.add_cleanup(work_tree.unlock)
817
rename_map.RenameMap.guess_renames(work_tree, dry_run)
819
def _run(self, tree, names_list, rel_names, after):
820
into_existing = osutils.isdir(names_list[-1])
821
if into_existing and len(names_list) == 2:
823
# a. case-insensitive filesystem and change case of dir
824
# b. move directory after the fact (if the source used to be
825
# a directory, but now doesn't exist in the working tree
826
# and the target is an existing directory, just rename it)
827
if (not tree.case_sensitive
828
and rel_names[0].lower() == rel_names[1].lower()):
829
into_existing = False
832
# 'fix' the case of a potential 'from'
833
from_id = tree.path2id(
834
tree.get_canonical_inventory_path(rel_names[0]))
835
if (not osutils.lexists(names_list[0]) and
836
from_id and inv.get_file_kind(from_id) == "directory"):
837
into_existing = False
840
# move into existing directory
841
# All entries reference existing inventory items, so fix them up
842
# for cicp file-systems.
843
rel_names = tree.get_canonical_inventory_paths(rel_names)
844
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
846
self.outf.write("%s => %s\n" % (src, dest))
848
if len(names_list) != 2:
849
raise errors.BzrCommandError('to mv multiple files the'
850
' destination must be a versioned'
853
# for cicp file-systems: the src references an existing inventory
855
src = tree.get_canonical_inventory_path(rel_names[0])
856
# Find the canonical version of the destination: In all cases, the
857
# parent of the target must be in the inventory, so we fetch the
858
# canonical version from there (we do not always *use* the
859
# canonicalized tail portion - we may be attempting to rename the
861
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
862
dest_parent = osutils.dirname(canon_dest)
863
spec_tail = osutils.basename(rel_names[1])
864
# For a CICP file-system, we need to avoid creating 2 inventory
865
# entries that differ only by case. So regardless of the case
866
# we *want* to use (ie, specified by the user or the file-system),
867
# we must always choose to use the case of any existing inventory
868
# items. The only exception to this is when we are attempting a
869
# case-only rename (ie, canonical versions of src and dest are
871
dest_id = tree.path2id(canon_dest)
872
if dest_id is None or tree.path2id(src) == dest_id:
873
# No existing item we care about, so work out what case we
874
# are actually going to use.
876
# If 'after' is specified, the tail must refer to a file on disk.
878
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
880
# pathjoin with an empty tail adds a slash, which breaks
882
dest_parent_fq = tree.basedir
884
dest_tail = osutils.canonical_relpath(
886
osutils.pathjoin(dest_parent_fq, spec_tail))
888
# not 'after', so case as specified is used
889
dest_tail = spec_tail
891
# Use the existing item so 'mv' fails with AlreadyVersioned.
892
dest_tail = os.path.basename(canon_dest)
893
dest = osutils.pathjoin(dest_parent, dest_tail)
894
mutter("attempting to move %s => %s", src, dest)
895
tree.rename_one(src, dest, after=after)
897
self.outf.write("%s => %s\n" % (src, dest))
900
class cmd_pull(Command):
901
"""Turn this branch into a mirror of another branch.
903
By default, this command only works on branches that have not diverged.
904
Branches are considered diverged if the destination branch's most recent
905
commit is one that has not been merged (directly or indirectly) into the
908
If branches have diverged, you can use 'bzr merge' to integrate the changes
909
from one into the other. Once one branch has merged, the other should
910
be able to pull it again.
912
If you want to replace your local changes and just want your branch to
913
match the remote one, use pull --overwrite. This will work even if the two
914
branches have diverged.
916
If there is no default location set, the first pull will set it. After
917
that, you can omit the location to use the default. To change the
918
default, use --remember. The value will only be saved if the remote
919
location can be accessed.
921
Note: The location can be specified either in the form of a branch,
922
or in the form of a path to a file containing a merge directive generated
926
_see_also = ['push', 'update', 'status-flags', 'send']
927
takes_options = ['remember', 'overwrite', 'revision',
928
custom_help('verbose',
929
help='Show logs of pulled revisions.'),
931
help='Branch to pull into, '
932
'rather than the one containing the working directory.',
937
help="Perform a local pull in a bound "
938
"branch. Local pulls are not applied to "
942
takes_args = ['location?']
943
encoding_type = 'replace'
945
def run(self, location=None, remember=False, overwrite=False,
946
revision=None, verbose=False,
947
directory=None, local=False):
948
# FIXME: too much stuff is in the command class
951
if directory is None:
954
tree_to = WorkingTree.open_containing(directory)[0]
955
branch_to = tree_to.branch
956
except errors.NoWorkingTree:
958
branch_to = Branch.open_containing(directory)[0]
960
if local and not branch_to.get_bound_location():
961
raise errors.LocalRequiresBoundBranch()
963
possible_transports = []
964
if location is not None:
966
mergeable = bundle.read_mergeable_from_url(location,
967
possible_transports=possible_transports)
968
except errors.NotABundle:
971
stored_loc = branch_to.get_parent()
973
if stored_loc is None:
974
raise errors.BzrCommandError("No pull location known or"
977
display_url = urlutils.unescape_for_display(stored_loc,
980
self.outf.write("Using saved parent location: %s\n" % display_url)
981
location = stored_loc
983
revision = _get_one_revision('pull', revision)
984
if mergeable is not None:
985
if revision is not None:
986
raise errors.BzrCommandError(
987
'Cannot use -r with merge directives or bundles')
988
mergeable.install_revisions(branch_to.repository)
989
base_revision_id, revision_id, verified = \
990
mergeable.get_merge_request(branch_to.repository)
991
branch_from = branch_to
993
branch_from = Branch.open(location,
994
possible_transports=possible_transports)
996
if branch_to.get_parent() is None or remember:
997
branch_to.set_parent(branch_from.base)
999
if branch_from is not branch_to:
1000
branch_from.lock_read()
1001
self.add_cleanup(branch_from.unlock)
1002
if revision is not None:
1003
revision_id = revision.as_revision_id(branch_from)
1005
branch_to.lock_write()
1006
self.add_cleanup(branch_to.unlock)
1007
if tree_to is not None:
1008
view_info = _get_view_info_for_change_reporter(tree_to)
1009
change_reporter = delta._ChangeReporter(
1010
unversioned_filter=tree_to.is_ignored,
1011
view_info=view_info)
1012
result = tree_to.pull(
1013
branch_from, overwrite, revision_id, change_reporter,
1014
possible_transports=possible_transports, local=local)
1016
result = branch_to.pull(
1017
branch_from, overwrite, revision_id, local=local)
1019
result.report(self.outf)
1020
if verbose and result.old_revid != result.new_revid:
1021
log.show_branch_change(
1022
branch_to, self.outf, result.old_revno,
1026
class cmd_push(Command):
1027
"""Update a mirror of this branch.
1029
The target branch will not have its working tree populated because this
1030
is both expensive, and is not supported on remote file systems.
1032
Some smart servers or protocols *may* put the working tree in place in
1035
This command only works on branches that have not diverged. Branches are
1036
considered diverged if the destination branch's most recent commit is one
1037
that has not been merged (directly or indirectly) by the source branch.
1039
If branches have diverged, you can use 'bzr push --overwrite' to replace
1040
the other branch completely, discarding its unmerged changes.
1042
If you want to ensure you have the different changes in the other branch,
1043
do a merge (see bzr help merge) from the other branch, and commit that.
1044
After that you will be able to do a push without '--overwrite'.
1046
If there is no default push location set, the first push will set it.
1047
After that, you can omit the location to use the default. To change the
1048
default, use --remember. The value will only be saved if the remote
1049
location can be accessed.
1052
_see_also = ['pull', 'update', 'working-trees']
1053
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1054
Option('create-prefix',
1055
help='Create the path leading up to the branch '
1056
'if it does not already exist.'),
1058
help='Branch to push from, '
1059
'rather than the one containing the working directory.',
1063
Option('use-existing-dir',
1064
help='By default push will fail if the target'
1065
' directory exists, but does not already'
1066
' have a control directory. This flag will'
1067
' allow push to proceed.'),
1069
help='Create a stacked branch that references the public location '
1070
'of the parent branch.'),
1071
Option('stacked-on',
1072
help='Create a stacked branch that refers to another branch '
1073
'for the commit history. Only the work not present in the '
1074
'referenced branch is included in the branch created.',
1077
help='Refuse to push if there are uncommitted changes in'
1078
' the working tree, --no-strict disables the check.'),
1080
takes_args = ['location?']
1081
encoding_type = 'replace'
1083
def run(self, location=None, remember=False, overwrite=False,
1084
create_prefix=False, verbose=False, revision=None,
1085
use_existing_dir=False, directory=None, stacked_on=None,
1086
stacked=False, strict=None):
1087
from bzrlib.push import _show_push_branch
1089
if directory is None:
1091
# Get the source branch
1093
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1095
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1096
if strict is None: strict = True # default value
1097
# Get the tip's revision_id
1098
revision = _get_one_revision('push', revision)
1099
if revision is not None:
1100
revision_id = revision.in_history(br_from).rev_id
1103
if strict and tree is not None and revision_id is None:
1104
if (tree.has_changes()):
1105
raise errors.UncommittedChanges(
1106
tree, more='Use --no-strict to force the push.')
1107
if tree.last_revision() != tree.branch.last_revision():
1108
# The tree has lost sync with its branch, there is little
1109
# chance that the user is aware of it but he can still force
1110
# the push with --no-strict
1111
raise errors.OutOfDateTree(
1112
tree, more='Use --no-strict to force the push.')
1114
# Get the stacked_on branch, if any
1115
if stacked_on is not None:
1116
stacked_on = urlutils.normalize_url(stacked_on)
1118
parent_url = br_from.get_parent()
1120
parent = Branch.open(parent_url)
1121
stacked_on = parent.get_public_branch()
1123
# I considered excluding non-http url's here, thus forcing
1124
# 'public' branches only, but that only works for some
1125
# users, so it's best to just depend on the user spotting an
1126
# error by the feedback given to them. RBC 20080227.
1127
stacked_on = parent_url
1129
raise errors.BzrCommandError(
1130
"Could not determine branch to refer to.")
1132
# Get the destination location
1133
if location is None:
1134
stored_loc = br_from.get_push_location()
1135
if stored_loc is None:
1136
raise errors.BzrCommandError(
1137
"No push location known or specified.")
1139
display_url = urlutils.unescape_for_display(stored_loc,
1141
self.outf.write("Using saved push location: %s\n" % display_url)
1142
location = stored_loc
1144
_show_push_branch(br_from, revision_id, location, self.outf,
1145
verbose=verbose, overwrite=overwrite, remember=remember,
1146
stacked_on=stacked_on, create_prefix=create_prefix,
1147
use_existing_dir=use_existing_dir)
1150
class cmd_branch(Command):
1151
"""Create a new branch that is a copy of an existing branch.
1153
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1154
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1155
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1156
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1157
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1160
To retrieve the branch as of a particular revision, supply the --revision
1161
parameter, as in "branch foo/bar -r 5".
1164
_see_also = ['checkout']
1165
takes_args = ['from_location', 'to_location?']
1166
takes_options = ['revision', Option('hardlink',
1167
help='Hard-link working tree files where possible.'),
1169
help="Create a branch without a working-tree."),
1171
help="Switch the checkout in the current directory "
1172
"to the new branch."),
1174
help='Create a stacked branch referring to the source branch. '
1175
'The new branch will depend on the availability of the source '
1176
'branch for all operations.'),
1177
Option('standalone',
1178
help='Do not use a shared repository, even if available.'),
1179
Option('use-existing-dir',
1180
help='By default branch will fail if the target'
1181
' directory exists, but does not already'
1182
' have a control directory. This flag will'
1183
' allow branch to proceed.'),
1185
help="Bind new branch to from location."),
1187
aliases = ['get', 'clone']
1189
def run(self, from_location, to_location=None, revision=None,
1190
hardlink=False, stacked=False, standalone=False, no_tree=False,
1191
use_existing_dir=False, switch=False, bind=False):
1192
from bzrlib import switch as _mod_switch
1193
from bzrlib.tag import _merge_tags_if_possible
1194
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1196
revision = _get_one_revision('branch', revision)
1198
self.add_cleanup(br_from.unlock)
1199
if revision is not None:
1200
revision_id = revision.as_revision_id(br_from)
1202
# FIXME - wt.last_revision, fallback to branch, fall back to
1203
# None or perhaps NULL_REVISION to mean copy nothing
1205
revision_id = br_from.last_revision()
1206
if to_location is None:
1207
to_location = urlutils.derive_to_location(from_location)
1208
to_transport = transport.get_transport(to_location)
1210
to_transport.mkdir('.')
1211
except errors.FileExists:
1212
if not use_existing_dir:
1213
raise errors.BzrCommandError('Target directory "%s" '
1214
'already exists.' % to_location)
1217
bzrdir.BzrDir.open_from_transport(to_transport)
1218
except errors.NotBranchError:
1221
raise errors.AlreadyBranchError(to_location)
1222
except errors.NoSuchFile:
1223
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1226
# preserve whatever source format we have.
1227
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1228
possible_transports=[to_transport],
1229
accelerator_tree=accelerator_tree,
1230
hardlink=hardlink, stacked=stacked,
1231
force_new_repo=standalone,
1232
create_tree_if_local=not no_tree,
1233
source_branch=br_from)
1234
branch = dir.open_branch()
1235
except errors.NoSuchRevision:
1236
to_transport.delete_tree('.')
1237
msg = "The branch %s has no revision %s." % (from_location,
1239
raise errors.BzrCommandError(msg)
1240
_merge_tags_if_possible(br_from, branch)
1241
# If the source branch is stacked, the new branch may
1242
# be stacked whether we asked for that explicitly or not.
1243
# We therefore need a try/except here and not just 'if stacked:'
1245
note('Created new stacked branch referring to %s.' %
1246
branch.get_stacked_on_url())
1247
except (errors.NotStacked, errors.UnstackableBranchFormat,
1248
errors.UnstackableRepositoryFormat), e:
1249
note('Branched %d revision(s).' % branch.revno())
1251
# Bind to the parent
1252
parent_branch = Branch.open(from_location)
1253
branch.bind(parent_branch)
1254
note('New branch bound to %s' % from_location)
1256
# Switch to the new branch
1257
wt, _ = WorkingTree.open_containing('.')
1258
_mod_switch.switch(wt.bzrdir, branch)
1259
note('Switched to branch: %s',
1260
urlutils.unescape_for_display(branch.base, 'utf-8'))
1263
class cmd_checkout(Command):
1264
"""Create a new checkout of an existing branch.
1266
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1267
the branch found in '.'. This is useful if you have removed the working tree
1268
or if it was never created - i.e. if you pushed the branch to its current
1269
location using SFTP.
1271
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1272
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1273
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1274
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1275
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1278
To retrieve the branch as of a particular revision, supply the --revision
1279
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1280
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1284
_see_also = ['checkouts', 'branch']
1285
takes_args = ['branch_location?', 'to_location?']
1286
takes_options = ['revision',
1287
Option('lightweight',
1288
help="Perform a lightweight checkout. Lightweight "
1289
"checkouts depend on access to the branch for "
1290
"every operation. Normal checkouts can perform "
1291
"common operations like diff and status without "
1292
"such access, and also support local commits."
1294
Option('files-from', type=str,
1295
help="Get file contents from this tree."),
1297
help='Hard-link working tree files where possible.'
1302
def run(self, branch_location=None, to_location=None, revision=None,
1303
lightweight=False, files_from=None, hardlink=False):
1304
if branch_location is None:
1305
branch_location = osutils.getcwd()
1306
to_location = branch_location
1307
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1309
revision = _get_one_revision('checkout', revision)
1310
if files_from is not None:
1311
accelerator_tree = WorkingTree.open(files_from)
1312
if revision is not None:
1313
revision_id = revision.as_revision_id(source)
1316
if to_location is None:
1317
to_location = urlutils.derive_to_location(branch_location)
1318
# if the source and to_location are the same,
1319
# and there is no working tree,
1320
# then reconstitute a branch
1321
if (osutils.abspath(to_location) ==
1322
osutils.abspath(branch_location)):
1324
source.bzrdir.open_workingtree()
1325
except errors.NoWorkingTree:
1326
source.bzrdir.create_workingtree(revision_id)
1328
source.create_checkout(to_location, revision_id, lightweight,
1329
accelerator_tree, hardlink)
1332
class cmd_renames(Command):
1333
"""Show list of renamed files.
1335
# TODO: Option to show renames between two historical versions.
1337
# TODO: Only show renames under dir, rather than in the whole branch.
1338
_see_also = ['status']
1339
takes_args = ['dir?']
1342
def run(self, dir=u'.'):
1343
tree = WorkingTree.open_containing(dir)[0]
1345
self.add_cleanup(tree.unlock)
1346
new_inv = tree.inventory
1347
old_tree = tree.basis_tree()
1348
old_tree.lock_read()
1349
self.add_cleanup(old_tree.unlock)
1350
old_inv = old_tree.inventory
1352
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1353
for f, paths, c, v, p, n, k, e in iterator:
1354
if paths[0] == paths[1]:
1358
renames.append(paths)
1360
for old_name, new_name in renames:
1361
self.outf.write("%s => %s\n" % (old_name, new_name))
1364
class cmd_update(Command):
1365
"""Update a tree to have the latest code committed to its branch.
1367
This will perform a merge into the working tree, and may generate
1368
conflicts. If you have any local changes, you will still
1369
need to commit them after the update for the update to be complete.
1371
If you want to discard your local changes, you can just do a
1372
'bzr revert' instead of 'bzr commit' after the update.
1374
If the tree's branch is bound to a master branch, it will also update
1375
the branch from the master.
1378
_see_also = ['pull', 'working-trees', 'status-flags']
1379
takes_args = ['dir?']
1380
takes_options = ['revision']
1383
def run(self, dir='.', revision=None):
1384
if revision is not None and len(revision) != 1:
1385
raise errors.BzrCommandError(
1386
"bzr update --revision takes exactly one revision")
1387
tree = WorkingTree.open_containing(dir)[0]
1388
branch = tree.branch
1389
possible_transports = []
1390
master = branch.get_master_branch(
1391
possible_transports=possible_transports)
1392
if master is not None:
1394
branch_location = master.base
1396
tree.lock_tree_write()
1397
branch_location = tree.branch.base
1398
self.add_cleanup(tree.unlock)
1399
# get rid of the final '/' and be ready for display
1400
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1402
existing_pending_merges = tree.get_parent_ids()[1:]
1406
# may need to fetch data into a heavyweight checkout
1407
# XXX: this may take some time, maybe we should display a
1409
old_tip = branch.update(possible_transports)
1410
if revision is not None:
1411
revision_id = revision[0].as_revision_id(branch)
1413
revision_id = branch.last_revision()
1414
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1415
revno = branch.revision_id_to_revno(revision_id)
1416
note("Tree is up to date at revision %d of branch %s" %
1417
(revno, branch_location))
1419
view_info = _get_view_info_for_change_reporter(tree)
1420
change_reporter = delta._ChangeReporter(
1421
unversioned_filter=tree.is_ignored,
1422
view_info=view_info)
1424
conflicts = tree.update(
1426
possible_transports=possible_transports,
1427
revision=revision_id,
1429
except errors.NoSuchRevision, e:
1430
raise errors.BzrCommandError(
1431
"branch has no revision %s\n"
1432
"bzr update --revision only works"
1433
" for a revision in the branch history"
1435
revno = tree.branch.revision_id_to_revno(
1436
_mod_revision.ensure_null(tree.last_revision()))
1437
note('Updated to revision %d of branch %s' %
1438
(revno, branch_location))
1439
if tree.get_parent_ids()[1:] != existing_pending_merges:
1440
note('Your local commits will now show as pending merges with '
1441
"'bzr status', and can be committed with 'bzr commit'.")
1448
class cmd_info(Command):
1449
"""Show information about a working tree, branch or repository.
1451
This command will show all known locations and formats associated to the
1452
tree, branch or repository.
1454
In verbose mode, statistical information is included with each report.
1455
To see extended statistic information, use a verbosity level of 2 or
1456
higher by specifying the verbose option multiple times, e.g. -vv.
1458
Branches and working trees will also report any missing revisions.
1462
Display information on the format and related locations:
1466
Display the above together with extended format information and
1467
basic statistics (like the number of files in the working tree and
1468
number of revisions in the branch and repository):
1472
Display the above together with number of committers to the branch:
1476
_see_also = ['revno', 'working-trees', 'repositories']
1477
takes_args = ['location?']
1478
takes_options = ['verbose']
1479
encoding_type = 'replace'
1482
def run(self, location=None, verbose=False):
1484
noise_level = get_verbosity_level()
1487
from bzrlib.info import show_bzrdir_info
1488
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1489
verbose=noise_level, outfile=self.outf)
1492
class cmd_remove(Command):
1493
"""Remove files or directories.
1495
This makes bzr stop tracking changes to the specified files. bzr will delete
1496
them if they can easily be recovered using revert. If no options or
1497
parameters are given bzr will scan for files that are being tracked by bzr
1498
but missing in your tree and stop tracking them for you.
1500
takes_args = ['file*']
1501
takes_options = ['verbose',
1502
Option('new', help='Only remove files that have never been committed.'),
1503
RegistryOption.from_kwargs('file-deletion-strategy',
1504
'The file deletion mode to be used.',
1505
title='Deletion Strategy', value_switches=True, enum_switch=False,
1506
safe='Only delete files if they can be'
1507
' safely recovered (default).',
1508
keep='Delete from bzr but leave the working copy.',
1509
force='Delete all the specified files, even if they can not be '
1510
'recovered and even if they are non-empty directories.')]
1511
aliases = ['rm', 'del']
1512
encoding_type = 'replace'
1514
def run(self, file_list, verbose=False, new=False,
1515
file_deletion_strategy='safe'):
1516
tree, file_list = tree_files(file_list)
1518
if file_list is not None:
1519
file_list = [f for f in file_list]
1522
self.add_cleanup(tree.unlock)
1523
# Heuristics should probably all move into tree.remove_smart or
1526
added = tree.changes_from(tree.basis_tree(),
1527
specific_files=file_list).added
1528
file_list = sorted([f[0] for f in added], reverse=True)
1529
if len(file_list) == 0:
1530
raise errors.BzrCommandError('No matching files.')
1531
elif file_list is None:
1532
# missing files show up in iter_changes(basis) as
1533
# versioned-with-no-kind.
1535
for change in tree.iter_changes(tree.basis_tree()):
1536
# Find paths in the working tree that have no kind:
1537
if change[1][1] is not None and change[6][1] is None:
1538
missing.append(change[1][1])
1539
file_list = sorted(missing, reverse=True)
1540
file_deletion_strategy = 'keep'
1541
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1542
keep_files=file_deletion_strategy=='keep',
1543
force=file_deletion_strategy=='force')
1546
class cmd_file_id(Command):
1547
"""Print file_id of a particular file or directory.
1549
The file_id is assigned when the file is first added and remains the
1550
same through all revisions where the file exists, even when it is
1555
_see_also = ['inventory', 'ls']
1556
takes_args = ['filename']
1559
def run(self, filename):
1560
tree, relpath = WorkingTree.open_containing(filename)
1561
i = tree.path2id(relpath)
1563
raise errors.NotVersionedError(filename)
1565
self.outf.write(i + '\n')
1568
class cmd_file_path(Command):
1569
"""Print path of file_ids to a file or directory.
1571
This prints one line for each directory down to the target,
1572
starting at the branch root.
1576
takes_args = ['filename']
1579
def run(self, filename):
1580
tree, relpath = WorkingTree.open_containing(filename)
1581
fid = tree.path2id(relpath)
1583
raise errors.NotVersionedError(filename)
1584
segments = osutils.splitpath(relpath)
1585
for pos in range(1, len(segments) + 1):
1586
path = osutils.joinpath(segments[:pos])
1587
self.outf.write("%s\n" % tree.path2id(path))
1590
class cmd_reconcile(Command):
1591
"""Reconcile bzr metadata in a branch.
1593
This can correct data mismatches that may have been caused by
1594
previous ghost operations or bzr upgrades. You should only
1595
need to run this command if 'bzr check' or a bzr developer
1596
advises you to run it.
1598
If a second branch is provided, cross-branch reconciliation is
1599
also attempted, which will check that data like the tree root
1600
id which was not present in very early bzr versions is represented
1601
correctly in both branches.
1603
At the same time it is run it may recompress data resulting in
1604
a potential saving in disk space or performance gain.
1606
The branch *MUST* be on a listable system such as local disk or sftp.
1609
_see_also = ['check']
1610
takes_args = ['branch?']
1612
def run(self, branch="."):
1613
from bzrlib.reconcile import reconcile
1614
dir = bzrdir.BzrDir.open(branch)
1618
class cmd_revision_history(Command):
1619
"""Display the list of revision ids on a branch."""
1622
takes_args = ['location?']
1627
def run(self, location="."):
1628
branch = Branch.open_containing(location)[0]
1629
for revid in branch.revision_history():
1630
self.outf.write(revid)
1631
self.outf.write('\n')
1634
class cmd_ancestry(Command):
1635
"""List all revisions merged into this branch."""
1637
_see_also = ['log', 'revision-history']
1638
takes_args = ['location?']
1643
def run(self, location="."):
1645
wt = WorkingTree.open_containing(location)[0]
1646
except errors.NoWorkingTree:
1647
b = Branch.open(location)
1648
last_revision = b.last_revision()
1651
last_revision = wt.last_revision()
1653
revision_ids = b.repository.get_ancestry(last_revision)
1655
for revision_id in revision_ids:
1656
self.outf.write(revision_id + '\n')
1659
class cmd_init(Command):
1660
"""Make a directory into a versioned branch.
1662
Use this to create an empty branch, or before importing an
1665
If there is a repository in a parent directory of the location, then
1666
the history of the branch will be stored in the repository. Otherwise
1667
init creates a standalone branch which carries its own history
1668
in the .bzr directory.
1670
If there is already a branch at the location but it has no working tree,
1671
the tree can be populated with 'bzr checkout'.
1673
Recipe for importing a tree of files::
1679
bzr commit -m "imported project"
1682
_see_also = ['init-repository', 'branch', 'checkout']
1683
takes_args = ['location?']
1685
Option('create-prefix',
1686
help='Create the path leading up to the branch '
1687
'if it does not already exist.'),
1688
RegistryOption('format',
1689
help='Specify a format for this branch. '
1690
'See "help formats".',
1691
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1692
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1693
value_switches=True,
1694
title="Branch format",
1696
Option('append-revisions-only',
1697
help='Never change revnos or the existing log.'
1698
' Append revisions to it only.')
1700
def run(self, location=None, format=None, append_revisions_only=False,
1701
create_prefix=False):
1703
format = bzrdir.format_registry.make_bzrdir('default')
1704
if location is None:
1707
to_transport = transport.get_transport(location)
1709
# The path has to exist to initialize a
1710
# branch inside of it.
1711
# Just using os.mkdir, since I don't
1712
# believe that we want to create a bunch of
1713
# locations if the user supplies an extended path
1715
to_transport.ensure_base()
1716
except errors.NoSuchFile:
1717
if not create_prefix:
1718
raise errors.BzrCommandError("Parent directory of %s"
1720
"\nYou may supply --create-prefix to create all"
1721
" leading parent directories."
1723
to_transport.create_prefix()
1726
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1727
except errors.NotBranchError:
1728
# really a NotBzrDir error...
1729
create_branch = bzrdir.BzrDir.create_branch_convenience
1730
branch = create_branch(to_transport.base, format=format,
1731
possible_transports=[to_transport])
1732
a_bzrdir = branch.bzrdir
1734
from bzrlib.transport.local import LocalTransport
1735
if a_bzrdir.has_branch():
1736
if (isinstance(to_transport, LocalTransport)
1737
and not a_bzrdir.has_workingtree()):
1738
raise errors.BranchExistsWithoutWorkingTree(location)
1739
raise errors.AlreadyBranchError(location)
1740
branch = a_bzrdir.create_branch()
1741
a_bzrdir.create_workingtree()
1742
if append_revisions_only:
1744
branch.set_append_revisions_only(True)
1745
except errors.UpgradeRequired:
1746
raise errors.BzrCommandError('This branch format cannot be set'
1747
' to append-revisions-only. Try --default.')
1749
from bzrlib.info import describe_layout, describe_format
1751
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1752
except (errors.NoWorkingTree, errors.NotLocalUrl):
1754
repository = branch.repository
1755
layout = describe_layout(repository, branch, tree).lower()
1756
format = describe_format(a_bzrdir, repository, branch, tree)
1757
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1758
if repository.is_shared():
1759
#XXX: maybe this can be refactored into transport.path_or_url()
1760
url = repository.bzrdir.root_transport.external_url()
1762
url = urlutils.local_path_from_url(url)
1763
except errors.InvalidURL:
1765
self.outf.write("Using shared repository: %s\n" % url)
1768
class cmd_init_repository(Command):
1769
"""Create a shared repository for branches to share storage space.
1771
New branches created under the repository directory will store their
1772
revisions in the repository, not in the branch directory. For branches
1773
with shared history, this reduces the amount of storage needed and
1774
speeds up the creation of new branches.
1776
If the --no-trees option is given then the branches in the repository
1777
will not have working trees by default. They will still exist as
1778
directories on disk, but they will not have separate copies of the
1779
files at a certain revision. This can be useful for repositories that
1780
store branches which are interacted with through checkouts or remote
1781
branches, such as on a server.
1784
Create a shared repository holding just branches::
1786
bzr init-repo --no-trees repo
1789
Make a lightweight checkout elsewhere::
1791
bzr checkout --lightweight repo/trunk trunk-checkout
1796
_see_also = ['init', 'branch', 'checkout', 'repositories']
1797
takes_args = ["location"]
1798
takes_options = [RegistryOption('format',
1799
help='Specify a format for this repository. See'
1800
' "bzr help formats" for details.',
1801
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1802
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1803
value_switches=True, title='Repository format'),
1805
help='Branches in the repository will default to'
1806
' not having a working tree.'),
1808
aliases = ["init-repo"]
1810
def run(self, location, format=None, no_trees=False):
1812
format = bzrdir.format_registry.make_bzrdir('default')
1814
if location is None:
1817
to_transport = transport.get_transport(location)
1818
to_transport.ensure_base()
1820
newdir = format.initialize_on_transport(to_transport)
1821
repo = newdir.create_repository(shared=True)
1822
repo.set_make_working_trees(not no_trees)
1824
from bzrlib.info import show_bzrdir_info
1825
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1828
class cmd_diff(Command):
1829
"""Show differences in the working tree, between revisions or branches.
1831
If no arguments are given, all changes for the current tree are listed.
1832
If files are given, only the changes in those files are listed.
1833
Remote and multiple branches can be compared by using the --old and
1834
--new options. If not provided, the default for both is derived from
1835
the first argument, if any, or the current tree if no arguments are
1838
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1839
produces patches suitable for "patch -p1".
1843
2 - unrepresentable changes
1848
Shows the difference in the working tree versus the last commit::
1852
Difference between the working tree and revision 1::
1856
Difference between revision 3 and revision 1::
1860
Difference between revision 3 and revision 1 for branch xxx::
1864
To see the changes introduced in revision X::
1868
Note that in the case of a merge, the -c option shows the changes
1869
compared to the left hand parent. To see the changes against
1870
another parent, use::
1872
bzr diff -r<chosen_parent>..X
1874
The changes introduced by revision 2 (equivalent to -r1..2)::
1878
Show just the differences for file NEWS::
1882
Show the differences in working tree xxx for file NEWS::
1886
Show the differences from branch xxx to this working tree:
1890
Show the differences between two branches for file NEWS::
1892
bzr diff --old xxx --new yyy NEWS
1894
Same as 'bzr diff' but prefix paths with old/ and new/::
1896
bzr diff --prefix old/:new/
1898
_see_also = ['status']
1899
takes_args = ['file*']
1901
Option('diff-options', type=str,
1902
help='Pass these options to the external diff program.'),
1903
Option('prefix', type=str,
1905
help='Set prefixes added to old and new filenames, as '
1906
'two values separated by a colon. (eg "old/:new/").'),
1908
help='Branch/tree to compare from.',
1912
help='Branch/tree to compare to.',
1918
help='Use this command to compare files.',
1922
aliases = ['di', 'dif']
1923
encoding_type = 'exact'
1926
def run(self, revision=None, file_list=None, diff_options=None,
1927
prefix=None, old=None, new=None, using=None):
1928
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1930
if (prefix is None) or (prefix == '0'):
1938
old_label, new_label = prefix.split(":")
1940
raise errors.BzrCommandError(
1941
'--prefix expects two values separated by a colon'
1942
' (eg "old/:new/")')
1944
if revision and len(revision) > 2:
1945
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1946
' one or two revision specifiers')
1948
(old_tree, new_tree,
1949
old_branch, new_branch,
1950
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1951
file_list, revision, old, new, apply_view=True)
1952
return show_diff_trees(old_tree, new_tree, sys.stdout,
1953
specific_files=specific_files,
1954
external_diff_options=diff_options,
1955
old_label=old_label, new_label=new_label,
1956
extra_trees=extra_trees, using=using)
1959
class cmd_deleted(Command):
1960
"""List files deleted in the working tree.
1962
# TODO: Show files deleted since a previous revision, or
1963
# between two revisions.
1964
# TODO: Much more efficient way to do this: read in new
1965
# directories with readdir, rather than stating each one. Same
1966
# level of effort but possibly much less IO. (Or possibly not,
1967
# if the directories are very large...)
1968
_see_also = ['status', 'ls']
1969
takes_options = ['show-ids']
1972
def run(self, show_ids=False):
1973
tree = WorkingTree.open_containing(u'.')[0]
1975
self.add_cleanup(tree.unlock)
1976
old = tree.basis_tree()
1978
self.add_cleanup(old.unlock)
1979
for path, ie in old.inventory.iter_entries():
1980
if not tree.has_id(ie.file_id):
1981
self.outf.write(path)
1983
self.outf.write(' ')
1984
self.outf.write(ie.file_id)
1985
self.outf.write('\n')
1988
class cmd_modified(Command):
1989
"""List files modified in working tree.
1993
_see_also = ['status', 'ls']
1996
help='Write an ascii NUL (\\0) separator '
1997
'between files rather than a newline.')
2001
def run(self, null=False):
2002
tree = WorkingTree.open_containing(u'.')[0]
2003
td = tree.changes_from(tree.basis_tree())
2004
for path, id, kind, text_modified, meta_modified in td.modified:
2006
self.outf.write(path + '\0')
2008
self.outf.write(osutils.quotefn(path) + '\n')
2011
class cmd_added(Command):
2012
"""List files added in working tree.
2016
_see_also = ['status', 'ls']
2019
help='Write an ascii NUL (\\0) separator '
2020
'between files rather than a newline.')
2024
def run(self, null=False):
2025
wt = WorkingTree.open_containing(u'.')[0]
2027
self.add_cleanup(wt.unlock)
2028
basis = wt.basis_tree()
2030
self.add_cleanup(basis.unlock)
2031
basis_inv = basis.inventory
2034
if file_id in basis_inv:
2036
if inv.is_root(file_id) and len(basis_inv) == 0:
2038
path = inv.id2path(file_id)
2039
if not os.access(osutils.abspath(path), os.F_OK):
2042
self.outf.write(path + '\0')
2044
self.outf.write(osutils.quotefn(path) + '\n')
2047
class cmd_root(Command):
2048
"""Show the tree root directory.
2050
The root is the nearest enclosing directory with a .bzr control
2053
takes_args = ['filename?']
2055
def run(self, filename=None):
2056
"""Print the branch root."""
2057
tree = WorkingTree.open_containing(filename)[0]
2058
self.outf.write(tree.basedir + '\n')
2061
def _parse_limit(limitstring):
2063
return int(limitstring)
2065
msg = "The limit argument must be an integer."
2066
raise errors.BzrCommandError(msg)
2069
def _parse_levels(s):
2073
msg = "The levels argument must be an integer."
2074
raise errors.BzrCommandError(msg)
2077
class cmd_log(Command):
2078
"""Show historical log for a branch or subset of a branch.
2080
log is bzr's default tool for exploring the history of a branch.
2081
The branch to use is taken from the first parameter. If no parameters
2082
are given, the branch containing the working directory is logged.
2083
Here are some simple examples::
2085
bzr log log the current branch
2086
bzr log foo.py log a file in its branch
2087
bzr log http://server/branch log a branch on a server
2089
The filtering, ordering and information shown for each revision can
2090
be controlled as explained below. By default, all revisions are
2091
shown sorted (topologically) so that newer revisions appear before
2092
older ones and descendants always appear before ancestors. If displayed,
2093
merged revisions are shown indented under the revision in which they
2098
The log format controls how information about each revision is
2099
displayed. The standard log formats are called ``long``, ``short``
2100
and ``line``. The default is long. See ``bzr help log-formats``
2101
for more details on log formats.
2103
The following options can be used to control what information is
2106
-l N display a maximum of N revisions
2107
-n N display N levels of revisions (0 for all, 1 for collapsed)
2108
-v display a status summary (delta) for each revision
2109
-p display a diff (patch) for each revision
2110
--show-ids display revision-ids (and file-ids), not just revnos
2112
Note that the default number of levels to display is a function of the
2113
log format. If the -n option is not used, the standard log formats show
2114
just the top level (mainline).
2116
Status summaries are shown using status flags like A, M, etc. To see
2117
the changes explained using words like ``added`` and ``modified``
2118
instead, use the -vv option.
2122
To display revisions from oldest to newest, use the --forward option.
2123
In most cases, using this option will have little impact on the total
2124
time taken to produce a log, though --forward does not incrementally
2125
display revisions like --reverse does when it can.
2127
:Revision filtering:
2129
The -r option can be used to specify what revision or range of revisions
2130
to filter against. The various forms are shown below::
2132
-rX display revision X
2133
-rX.. display revision X and later
2134
-r..Y display up to and including revision Y
2135
-rX..Y display from X to Y inclusive
2137
See ``bzr help revisionspec`` for details on how to specify X and Y.
2138
Some common examples are given below::
2140
-r-1 show just the tip
2141
-r-10.. show the last 10 mainline revisions
2142
-rsubmit:.. show what's new on this branch
2143
-rancestor:path.. show changes since the common ancestor of this
2144
branch and the one at location path
2145
-rdate:yesterday.. show changes since yesterday
2147
When logging a range of revisions using -rX..Y, log starts at
2148
revision Y and searches back in history through the primary
2149
("left-hand") parents until it finds X. When logging just the
2150
top level (using -n1), an error is reported if X is not found
2151
along the way. If multi-level logging is used (-n0), X may be
2152
a nested merge revision and the log will be truncated accordingly.
2156
If parameters are given and the first one is not a branch, the log
2157
will be filtered to show only those revisions that changed the
2158
nominated files or directories.
2160
Filenames are interpreted within their historical context. To log a
2161
deleted file, specify a revision range so that the file existed at
2162
the end or start of the range.
2164
Historical context is also important when interpreting pathnames of
2165
renamed files/directories. Consider the following example:
2167
* revision 1: add tutorial.txt
2168
* revision 2: modify tutorial.txt
2169
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2173
* ``bzr log guide.txt`` will log the file added in revision 1
2175
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2177
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2178
the original file in revision 2.
2180
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2181
was no file called guide.txt in revision 2.
2183
Renames are always followed by log. By design, there is no need to
2184
explicitly ask for this (and no way to stop logging a file back
2185
until it was last renamed).
2189
The --message option can be used for finding revisions that match a
2190
regular expression in a commit message.
2194
GUI tools and IDEs are often better at exploring history than command
2195
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2196
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2197
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2198
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2200
You may find it useful to add the aliases below to ``bazaar.conf``::
2204
top = log -l10 --line
2207
``bzr tip`` will then show the latest revision while ``bzr top``
2208
will show the last 10 mainline revisions. To see the details of a
2209
particular revision X, ``bzr show -rX``.
2211
If you are interested in looking deeper into a particular merge X,
2212
use ``bzr log -n0 -rX``.
2214
``bzr log -v`` on a branch with lots of history is currently
2215
very slow. A fix for this issue is currently under development.
2216
With or without that fix, it is recommended that a revision range
2217
be given when using the -v option.
2219
bzr has a generic full-text matching plugin, bzr-search, that can be
2220
used to find revisions matching user names, commit messages, etc.
2221
Among other features, this plugin can find all revisions containing
2222
a list of words but not others.
2224
When exploring non-mainline history on large projects with deep
2225
history, the performance of log can be greatly improved by installing
2226
the historycache plugin. This plugin buffers historical information
2227
trading disk space for faster speed.
2229
takes_args = ['file*']
2230
_see_also = ['log-formats', 'revisionspec']
2233
help='Show from oldest to newest.'),
2235
custom_help('verbose',
2236
help='Show files changed in each revision.'),
2240
type=bzrlib.option._parse_revision_str,
2242
help='Show just the specified revision.'
2243
' See also "help revisionspec".'),
2247
help='Number of levels to display - 0 for all, 1 for flat.',
2249
type=_parse_levels),
2252
help='Show revisions whose message matches this '
2253
'regular expression.',
2257
help='Limit the output to the first N revisions.',
2262
help='Show changes made in each revision as a patch.'),
2263
Option('include-merges',
2264
help='Show merged revisions like --levels 0 does.'),
2266
encoding_type = 'replace'
2269
def run(self, file_list=None, timezone='original',
2280
include_merges=False):
2281
from bzrlib.log import (
2283
make_log_request_dict,
2284
_get_info_for_log_files,
2286
direction = (forward and 'forward') or 'reverse'
2291
raise errors.BzrCommandError(
2292
'--levels and --include-merges are mutually exclusive')
2294
if change is not None:
2296
raise errors.RangeInChangeOption()
2297
if revision is not None:
2298
raise errors.BzrCommandError(
2299
'--revision and --change are mutually exclusive')
2304
filter_by_dir = False
2306
# find the file ids to log and check for directory filtering
2307
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2308
revision, file_list)
2309
self.add_cleanup(b.unlock)
2310
for relpath, file_id, kind in file_info_list:
2312
raise errors.BzrCommandError(
2313
"Path unknown at end or start of revision range: %s" %
2315
# If the relpath is the top of the tree, we log everything
2320
file_ids.append(file_id)
2321
filter_by_dir = filter_by_dir or (
2322
kind in ['directory', 'tree-reference'])
2325
# FIXME ? log the current subdir only RBC 20060203
2326
if revision is not None \
2327
and len(revision) > 0 and revision[0].get_branch():
2328
location = revision[0].get_branch()
2331
dir, relpath = bzrdir.BzrDir.open_containing(location)
2332
b = dir.open_branch()
2334
self.add_cleanup(b.unlock)
2335
rev1, rev2 = _get_revision_range(revision, b, self.name())
2337
# Decide on the type of delta & diff filtering to use
2338
# TODO: add an --all-files option to make this configurable & consistent
2346
diff_type = 'partial'
2350
# Build the log formatter
2351
if log_format is None:
2352
log_format = log.log_formatter_registry.get_default(b)
2353
# Make a non-encoding output to include the diffs - bug 328007
2354
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2355
lf = log_format(show_ids=show_ids, to_file=self.outf,
2356
to_exact_file=unencoded_output,
2357
show_timezone=timezone,
2358
delta_format=get_verbosity_level(),
2360
show_advice=levels is None)
2362
# Choose the algorithm for doing the logging. It's annoying
2363
# having multiple code paths like this but necessary until
2364
# the underlying repository format is faster at generating
2365
# deltas or can provide everything we need from the indices.
2366
# The default algorithm - match-using-deltas - works for
2367
# multiple files and directories and is faster for small
2368
# amounts of history (200 revisions say). However, it's too
2369
# slow for logging a single file in a repository with deep
2370
# history, i.e. > 10K revisions. In the spirit of "do no
2371
# evil when adding features", we continue to use the
2372
# original algorithm - per-file-graph - for the "single
2373
# file that isn't a directory without showing a delta" case.
2374
partial_history = revision and b.repository._format.supports_chks
2375
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2376
or delta_type or partial_history)
2378
# Build the LogRequest and execute it
2379
if len(file_ids) == 0:
2381
rqst = make_log_request_dict(
2382
direction=direction, specific_fileids=file_ids,
2383
start_revision=rev1, end_revision=rev2, limit=limit,
2384
message_search=message, delta_type=delta_type,
2385
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2386
Logger(b, rqst).show(lf)
2389
def _get_revision_range(revisionspec_list, branch, command_name):
2390
"""Take the input of a revision option and turn it into a revision range.
2392
It returns RevisionInfo objects which can be used to obtain the rev_id's
2393
of the desired revisions. It does some user input validations.
2395
if revisionspec_list is None:
2398
elif len(revisionspec_list) == 1:
2399
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2400
elif len(revisionspec_list) == 2:
2401
start_spec = revisionspec_list[0]
2402
end_spec = revisionspec_list[1]
2403
if end_spec.get_branch() != start_spec.get_branch():
2404
# b is taken from revision[0].get_branch(), and
2405
# show_log will use its revision_history. Having
2406
# different branches will lead to weird behaviors.
2407
raise errors.BzrCommandError(
2408
"bzr %s doesn't accept two revisions in different"
2409
" branches." % command_name)
2410
rev1 = start_spec.in_history(branch)
2411
# Avoid loading all of history when we know a missing
2412
# end of range means the last revision ...
2413
if end_spec.spec is None:
2414
last_revno, last_revision_id = branch.last_revision_info()
2415
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2417
rev2 = end_spec.in_history(branch)
2419
raise errors.BzrCommandError(
2420
'bzr %s --revision takes one or two values.' % command_name)
2424
def _revision_range_to_revid_range(revision_range):
2427
if revision_range[0] is not None:
2428
rev_id1 = revision_range[0].rev_id
2429
if revision_range[1] is not None:
2430
rev_id2 = revision_range[1].rev_id
2431
return rev_id1, rev_id2
2433
def get_log_format(long=False, short=False, line=False, default='long'):
2434
log_format = default
2438
log_format = 'short'
2444
class cmd_touching_revisions(Command):
2445
"""Return revision-ids which affected a particular file.
2447
A more user-friendly interface is "bzr log FILE".
2451
takes_args = ["filename"]
2454
def run(self, filename):
2455
tree, relpath = WorkingTree.open_containing(filename)
2456
file_id = tree.path2id(relpath)
2459
self.add_cleanup(b.unlock)
2460
touching_revs = log.find_touching_revisions(b, file_id)
2461
for revno, revision_id, what in touching_revs:
2462
self.outf.write("%6d %s\n" % (revno, what))
2465
class cmd_ls(Command):
2466
"""List files in a tree.
2469
_see_also = ['status', 'cat']
2470
takes_args = ['path?']
2474
Option('recursive', short_name='R',
2475
help='Recurse into subdirectories.'),
2477
help='Print paths relative to the root of the branch.'),
2478
Option('unknown', help='Print unknown files.'),
2479
Option('versioned', help='Print versioned files.',
2481
Option('ignored', help='Print ignored files.'),
2483
help='Write an ascii NUL (\\0) separator '
2484
'between files rather than a newline.'),
2486
help='List entries of a particular kind: file, directory, symlink.',
2491
def run(self, revision=None, verbose=False,
2492
recursive=False, from_root=False,
2493
unknown=False, versioned=False, ignored=False,
2494
null=False, kind=None, show_ids=False, path=None):
2496
if kind and kind not in ('file', 'directory', 'symlink'):
2497
raise errors.BzrCommandError('invalid kind specified')
2499
if verbose and null:
2500
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2501
all = not (unknown or versioned or ignored)
2503
selection = {'I':ignored, '?':unknown, 'V':versioned}
2509
raise errors.BzrCommandError('cannot specify both --from-root'
2512
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2515
# Calculate the prefix to use
2519
prefix = relpath + '/'
2520
elif fs_path != '.' and not fs_path.endswith('/'):
2521
prefix = fs_path + '/'
2523
if revision is not None or tree is None:
2524
tree = _get_one_revision_tree('ls', revision, branch=branch)
2527
if isinstance(tree, WorkingTree) and tree.supports_views():
2528
view_files = tree.views.lookup_view()
2531
view_str = views.view_display_str(view_files)
2532
note("Ignoring files outside view. View is %s" % view_str)
2535
self.add_cleanup(tree.unlock)
2536
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2537
from_dir=relpath, recursive=recursive):
2538
# Apply additional masking
2539
if not all and not selection[fc]:
2541
if kind is not None and fkind != kind:
2546
fullpath = osutils.pathjoin(relpath, fp)
2549
views.check_path_in_view(tree, fullpath)
2550
except errors.FileOutsideView:
2555
fp = osutils.pathjoin(prefix, fp)
2556
kindch = entry.kind_character()
2557
outstring = fp + kindch
2558
ui.ui_factory.clear_term()
2560
outstring = '%-8s %s' % (fc, outstring)
2561
if show_ids and fid is not None:
2562
outstring = "%-50s %s" % (outstring, fid)
2563
self.outf.write(outstring + '\n')
2565
self.outf.write(fp + '\0')
2568
self.outf.write(fid)
2569
self.outf.write('\0')
2577
self.outf.write('%-50s %s\n' % (outstring, my_id))
2579
self.outf.write(outstring + '\n')
2582
class cmd_unknowns(Command):
2583
"""List unknown files.
2591
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2592
self.outf.write(osutils.quotefn(f) + '\n')
2595
class cmd_ignore(Command):
2596
"""Ignore specified files or patterns.
2598
See ``bzr help patterns`` for details on the syntax of patterns.
2600
If a .bzrignore file does not exist, the ignore command
2601
will create one and add the specified files or patterns to the newly
2602
created file. The ignore command will also automatically add the
2603
.bzrignore file to be versioned. Creating a .bzrignore file without
2604
the use of the ignore command will require an explicit add command.
2606
To remove patterns from the ignore list, edit the .bzrignore file.
2607
After adding, editing or deleting that file either indirectly by
2608
using this command or directly by using an editor, be sure to commit
2611
Patterns prefixed with '!' are exceptions to ignore patterns and take
2612
precedence over regular ignores. Such exceptions are used to specify
2613
files that should be versioned which would otherwise be ignored.
2615
Patterns prefixed with '!!' act as regular ignore patterns, but have
2616
precedence over the '!' exception patterns.
2618
Note: ignore patterns containing shell wildcards must be quoted from
2622
Ignore the top level Makefile::
2624
bzr ignore ./Makefile
2626
Ignore .class files in all directories...::
2628
bzr ignore "*.class"
2630
...but do not ignore "special.class"::
2632
bzr ignore "!special.class"
2634
Ignore .o files under the lib directory::
2636
bzr ignore "lib/**/*.o"
2638
Ignore .o files under the lib directory::
2640
bzr ignore "RE:lib/.*\.o"
2642
Ignore everything but the "debian" toplevel directory::
2644
bzr ignore "RE:(?!debian/).*"
2646
Ignore everything except the "local" toplevel directory,
2647
but always ignore "*~" autosave files, even under local/::
2650
bzr ignore "!./local"
2654
_see_also = ['status', 'ignored', 'patterns']
2655
takes_args = ['name_pattern*']
2657
Option('old-default-rules',
2658
help='Write out the ignore rules bzr < 0.9 always used.')
2661
def run(self, name_pattern_list=None, old_default_rules=None):
2662
from bzrlib import ignores
2663
if old_default_rules is not None:
2664
# dump the rules and exit
2665
for pattern in ignores.OLD_DEFAULTS:
2668
if not name_pattern_list:
2669
raise errors.BzrCommandError("ignore requires at least one "
2670
"NAME_PATTERN or --old-default-rules")
2671
name_pattern_list = [globbing.normalize_pattern(p)
2672
for p in name_pattern_list]
2673
for name_pattern in name_pattern_list:
2674
if (name_pattern[0] == '/' or
2675
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2676
raise errors.BzrCommandError(
2677
"NAME_PATTERN should not be an absolute path")
2678
tree, relpath = WorkingTree.open_containing(u'.')
2679
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2680
ignored = globbing.Globster(name_pattern_list)
2683
for entry in tree.list_files():
2687
if ignored.match(filename):
2688
matches.append(filename.encode('utf-8'))
2690
if len(matches) > 0:
2691
print "Warning: the following files are version controlled and" \
2692
" match your ignore pattern:\n%s" \
2693
"\nThese files will continue to be version controlled" \
2694
" unless you 'bzr remove' them." % ("\n".join(matches),)
2697
class cmd_ignored(Command):
2698
"""List ignored files and the patterns that matched them.
2700
List all the ignored files and the ignore pattern that caused the file to
2703
Alternatively, to list just the files::
2708
encoding_type = 'replace'
2709
_see_also = ['ignore', 'ls']
2713
tree = WorkingTree.open_containing(u'.')[0]
2715
self.add_cleanup(tree.unlock)
2716
for path, file_class, kind, file_id, entry in tree.list_files():
2717
if file_class != 'I':
2719
## XXX: Slightly inefficient since this was already calculated
2720
pat = tree.is_ignored(path)
2721
self.outf.write('%-50s %s\n' % (path, pat))
2724
class cmd_lookup_revision(Command):
2725
"""Lookup the revision-id from a revision-number
2728
bzr lookup-revision 33
2731
takes_args = ['revno']
2734
def run(self, revno):
2738
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2740
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2743
class cmd_export(Command):
2744
"""Export current or past revision to a destination directory or archive.
2746
If no revision is specified this exports the last committed revision.
2748
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2749
given, try to find the format with the extension. If no extension
2750
is found exports to a directory (equivalent to --format=dir).
2752
If root is supplied, it will be used as the root directory inside
2753
container formats (tar, zip, etc). If it is not supplied it will default
2754
to the exported filename. The root option has no effect for 'dir' format.
2756
If branch is omitted then the branch containing the current working
2757
directory will be used.
2759
Note: Export of tree with non-ASCII filenames to zip is not supported.
2761
================= =========================
2762
Supported formats Autodetected by extension
2763
================= =========================
2766
tbz2 .tar.bz2, .tbz2
2769
================= =========================
2771
takes_args = ['dest', 'branch_or_subdir?']
2774
help="Type of file to export to.",
2777
Option('filters', help='Apply content filters to export the '
2778
'convenient form.'),
2781
help="Name of the root directory inside the exported file."),
2783
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2784
root=None, filters=False):
2785
from bzrlib.export import export
2787
if branch_or_subdir is None:
2788
tree = WorkingTree.open_containing(u'.')[0]
2792
b, subdir = Branch.open_containing(branch_or_subdir)
2795
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2797
export(rev_tree, dest, format, root, subdir, filtered=filters)
2798
except errors.NoSuchExportFormat, e:
2799
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2802
class cmd_cat(Command):
2803
"""Write the contents of a file as of a given revision to standard output.
2805
If no revision is nominated, the last revision is used.
2807
Note: Take care to redirect standard output when using this command on a
2813
Option('name-from-revision', help='The path name in the old tree.'),
2814
Option('filters', help='Apply content filters to display the '
2815
'convenience form.'),
2818
takes_args = ['filename']
2819
encoding_type = 'exact'
2822
def run(self, filename, revision=None, name_from_revision=False,
2824
if revision is not None and len(revision) != 1:
2825
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2826
" one revision specifier")
2827
tree, branch, relpath = \
2828
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2830
self.add_cleanup(branch.unlock)
2831
return self._run(tree, branch, relpath, filename, revision,
2832
name_from_revision, filters)
2834
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2837
tree = b.basis_tree()
2838
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2839
rev_tree.lock_read()
2840
self.add_cleanup(rev_tree.unlock)
2842
old_file_id = rev_tree.path2id(relpath)
2844
if name_from_revision:
2845
# Try in revision if requested
2846
if old_file_id is None:
2847
raise errors.BzrCommandError(
2848
"%r is not present in revision %s" % (
2849
filename, rev_tree.get_revision_id()))
2851
content = rev_tree.get_file_text(old_file_id)
2853
cur_file_id = tree.path2id(relpath)
2855
if cur_file_id is not None:
2856
# Then try with the actual file id
2858
content = rev_tree.get_file_text(cur_file_id)
2860
except errors.NoSuchId:
2861
# The actual file id didn't exist at that time
2863
if not found and old_file_id is not None:
2864
# Finally try with the old file id
2865
content = rev_tree.get_file_text(old_file_id)
2868
# Can't be found anywhere
2869
raise errors.BzrCommandError(
2870
"%r is not present in revision %s" % (
2871
filename, rev_tree.get_revision_id()))
2873
from bzrlib.filters import (
2874
ContentFilterContext,
2875
filtered_output_bytes,
2877
filters = rev_tree._content_filter_stack(relpath)
2878
chunks = content.splitlines(True)
2879
content = filtered_output_bytes(chunks, filters,
2880
ContentFilterContext(relpath, rev_tree))
2882
self.outf.writelines(content)
2885
self.outf.write(content)
2888
class cmd_local_time_offset(Command):
2889
"""Show the offset in seconds from GMT to local time."""
2893
print osutils.local_time_offset()
2897
class cmd_commit(Command):
2898
"""Commit changes into a new revision.
2900
An explanatory message needs to be given for each commit. This is
2901
often done by using the --message option (getting the message from the
2902
command line) or by using the --file option (getting the message from
2903
a file). If neither of these options is given, an editor is opened for
2904
the user to enter the message. To see the changed files in the
2905
boilerplate text loaded into the editor, use the --show-diff option.
2907
By default, the entire tree is committed and the person doing the
2908
commit is assumed to be the author. These defaults can be overridden
2913
If selected files are specified, only changes to those files are
2914
committed. If a directory is specified then the directory and
2915
everything within it is committed.
2917
When excludes are given, they take precedence over selected files.
2918
For example, to commit only changes within foo, but not changes
2921
bzr commit foo -x foo/bar
2923
A selective commit after a merge is not yet supported.
2927
If the author of the change is not the same person as the committer,
2928
you can specify the author's name using the --author option. The
2929
name should be in the same format as a committer-id, e.g.
2930
"John Doe <jdoe@example.com>". If there is more than one author of
2931
the change you can specify the option multiple times, once for each
2936
A common mistake is to forget to add a new file or directory before
2937
running the commit command. The --strict option checks for unknown
2938
files and aborts the commit if any are found. More advanced pre-commit
2939
checks can be implemented by defining hooks. See ``bzr help hooks``
2944
If you accidentially commit the wrong changes or make a spelling
2945
mistake in the commit message say, you can use the uncommit command
2946
to undo it. See ``bzr help uncommit`` for details.
2948
Hooks can also be configured to run after a commit. This allows you
2949
to trigger updates to external systems like bug trackers. The --fixes
2950
option can be used to record the association between a revision and
2951
one or more bugs. See ``bzr help bugs`` for details.
2953
A selective commit may fail in some cases where the committed
2954
tree would be invalid. Consider::
2959
bzr commit foo -m "committing foo"
2960
bzr mv foo/bar foo/baz
2963
bzr commit foo/bar -m "committing bar but not baz"
2965
In the example above, the last commit will fail by design. This gives
2966
the user the opportunity to decide whether they want to commit the
2967
rename at the same time, separately first, or not at all. (As a general
2968
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2970
# TODO: Run hooks on tree to-be-committed, and after commit.
2972
# TODO: Strict commit that fails if there are deleted files.
2973
# (what does "deleted files" mean ??)
2975
# TODO: Give better message for -s, --summary, used by tla people
2977
# XXX: verbose currently does nothing
2979
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2980
takes_args = ['selected*']
2982
ListOption('exclude', type=str, short_name='x',
2983
help="Do not consider changes made to a given path."),
2984
Option('message', type=unicode,
2986
help="Description of the new revision."),
2989
help='Commit even if nothing has changed.'),
2990
Option('file', type=str,
2993
help='Take commit message from this file.'),
2995
help="Refuse to commit if there are unknown "
2996
"files in the working tree."),
2997
Option('commit-time', type=str,
2998
help="Manually set a commit time using commit date "
2999
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3000
ListOption('fixes', type=str,
3001
help="Mark a bug as being fixed by this revision "
3002
"(see \"bzr help bugs\")."),
3003
ListOption('author', type=unicode,
3004
help="Set the author's name, if it's different "
3005
"from the committer."),
3007
help="Perform a local commit in a bound "
3008
"branch. Local commits are not pushed to "
3009
"the master branch until a normal commit "
3013
help='When no message is supplied, show the diff along'
3014
' with the status summary in the message editor.'),
3016
aliases = ['ci', 'checkin']
3018
def _iter_bug_fix_urls(self, fixes, branch):
3019
# Configure the properties for bug fixing attributes.
3020
for fixed_bug in fixes:
3021
tokens = fixed_bug.split(':')
3022
if len(tokens) != 2:
3023
raise errors.BzrCommandError(
3024
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3025
"See \"bzr help bugs\" for more information on this "
3026
"feature.\nCommit refused." % fixed_bug)
3027
tag, bug_id = tokens
3029
yield bugtracker.get_bug_url(tag, branch, bug_id)
3030
except errors.UnknownBugTrackerAbbreviation:
3031
raise errors.BzrCommandError(
3032
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3033
except errors.MalformedBugIdentifier, e:
3034
raise errors.BzrCommandError(
3035
"%s\nCommit refused." % (str(e),))
3037
def run(self, message=None, file=None, verbose=False, selected_list=None,
3038
unchanged=False, strict=False, local=False, fixes=None,
3039
author=None, show_diff=False, exclude=None, commit_time=None):
3040
from bzrlib.errors import (
3045
from bzrlib.msgeditor import (
3046
edit_commit_message_encoded,
3047
generate_commit_message_template,
3048
make_commit_message_template_encoded
3051
commit_stamp = offset = None
3052
if commit_time is not None:
3054
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3055
except ValueError, e:
3056
raise errors.BzrCommandError(
3057
"Could not parse --commit-time: " + str(e))
3059
# TODO: Need a blackbox test for invoking the external editor; may be
3060
# slightly problematic to run this cross-platform.
3062
# TODO: do more checks that the commit will succeed before
3063
# spending the user's valuable time typing a commit message.
3067
tree, selected_list = tree_files(selected_list)
3068
if selected_list == ['']:
3069
# workaround - commit of root of tree should be exactly the same
3070
# as just default commit in that tree, and succeed even though
3071
# selected-file merge commit is not done yet
3076
bug_property = bugtracker.encode_fixes_bug_urls(
3077
self._iter_bug_fix_urls(fixes, tree.branch))
3079
properties['bugs'] = bug_property
3081
if local and not tree.branch.get_bound_location():
3082
raise errors.LocalRequiresBoundBranch()
3084
if message is not None:
3086
file_exists = osutils.lexists(message)
3087
except UnicodeError:
3088
# The commit message contains unicode characters that can't be
3089
# represented in the filesystem encoding, so that can't be a
3094
'The commit message is a file name: "%(f)s".\n'
3095
'(use --file "%(f)s" to take commit message from that file)'
3097
ui.ui_factory.show_warning(warning_msg)
3099
def get_message(commit_obj):
3100
"""Callback to get commit message"""
3101
my_message = message
3102
if my_message is not None and '\r' in my_message:
3103
my_message = my_message.replace('\r\n', '\n')
3104
my_message = my_message.replace('\r', '\n')
3105
if my_message is None and not file:
3106
t = make_commit_message_template_encoded(tree,
3107
selected_list, diff=show_diff,
3108
output_encoding=osutils.get_user_encoding())
3109
start_message = generate_commit_message_template(commit_obj)
3110
my_message = edit_commit_message_encoded(t,
3111
start_message=start_message)
3112
if my_message is None:
3113
raise errors.BzrCommandError("please specify a commit"
3114
" message with either --message or --file")
3115
elif my_message and file:
3116
raise errors.BzrCommandError(
3117
"please specify either --message or --file")
3119
my_message = codecs.open(file, 'rt',
3120
osutils.get_user_encoding()).read()
3121
if my_message == "":
3122
raise errors.BzrCommandError("empty commit message specified")
3125
# The API permits a commit with a filter of [] to mean 'select nothing'
3126
# but the command line should not do that.
3127
if not selected_list:
3128
selected_list = None
3130
tree.commit(message_callback=get_message,
3131
specific_files=selected_list,
3132
allow_pointless=unchanged, strict=strict, local=local,
3133
reporter=None, verbose=verbose, revprops=properties,
3134
authors=author, timestamp=commit_stamp,
3136
exclude=safe_relpath_files(tree, exclude))
3137
except PointlessCommit:
3138
# FIXME: This should really happen before the file is read in;
3139
# perhaps prepare the commit; get the message; then actually commit
3140
raise errors.BzrCommandError("No changes to commit."
3141
" Use --unchanged to commit anyhow.")
3142
except ConflictsInTree:
3143
raise errors.BzrCommandError('Conflicts detected in working '
3144
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3146
except StrictCommitFailed:
3147
raise errors.BzrCommandError("Commit refused because there are"
3148
" unknown files in the working tree.")
3149
except errors.BoundBranchOutOfDate, e:
3150
raise errors.BzrCommandError(str(e) + "\n"
3151
'To commit to master branch, run update and then commit.\n'
3152
'You can also pass --local to commit to continue working '
3156
class cmd_check(Command):
3157
"""Validate working tree structure, branch consistency and repository history.
3159
This command checks various invariants about branch and repository storage
3160
to detect data corruption or bzr bugs.
3162
The working tree and branch checks will only give output if a problem is
3163
detected. The output fields of the repository check are:
3166
This is just the number of revisions checked. It doesn't
3170
This is just the number of versionedfiles checked. It
3171
doesn't indicate a problem.
3173
unreferenced ancestors
3174
Texts that are ancestors of other texts, but
3175
are not properly referenced by the revision ancestry. This is a
3176
subtle problem that Bazaar can work around.
3179
This is the total number of unique file contents
3180
seen in the checked revisions. It does not indicate a problem.
3183
This is the total number of repeated texts seen
3184
in the checked revisions. Texts can be repeated when their file
3185
entries are modified, but the file contents are not. It does not
3188
If no restrictions are specified, all Bazaar data that is found at the given
3189
location will be checked.
3193
Check the tree and branch at 'foo'::
3195
bzr check --tree --branch foo
3197
Check only the repository at 'bar'::
3199
bzr check --repo bar
3201
Check everything at 'baz'::
3206
_see_also = ['reconcile']
3207
takes_args = ['path?']
3208
takes_options = ['verbose',
3209
Option('branch', help="Check the branch related to the"
3210
" current directory."),
3211
Option('repo', help="Check the repository related to the"
3212
" current directory."),
3213
Option('tree', help="Check the working tree related to"
3214
" the current directory.")]
3216
def run(self, path=None, verbose=False, branch=False, repo=False,
3218
from bzrlib.check import check_dwim
3221
if not branch and not repo and not tree:
3222
branch = repo = tree = True
3223
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3226
class cmd_upgrade(Command):
3227
"""Upgrade branch storage to current format.
3229
The check command or bzr developers may sometimes advise you to run
3230
this command. When the default format has changed you may also be warned
3231
during other operations to upgrade.
3234
_see_also = ['check']
3235
takes_args = ['url?']
3237
RegistryOption('format',
3238
help='Upgrade to a specific format. See "bzr help'
3239
' formats" for details.',
3240
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3241
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3242
value_switches=True, title='Branch format'),
3245
def run(self, url='.', format=None):
3246
from bzrlib.upgrade import upgrade
3247
upgrade(url, format)
3250
class cmd_whoami(Command):
3251
"""Show or set bzr user id.
3254
Show the email of the current user::
3258
Set the current user::
3260
bzr whoami "Frank Chu <fchu@example.com>"
3262
takes_options = [ Option('email',
3263
help='Display email address only.'),
3265
help='Set identity for the current branch instead of '
3268
takes_args = ['name?']
3269
encoding_type = 'replace'
3272
def run(self, email=False, branch=False, name=None):
3274
# use branch if we're inside one; otherwise global config
3276
c = Branch.open_containing('.')[0].get_config()
3277
except errors.NotBranchError:
3278
c = config.GlobalConfig()
3280
self.outf.write(c.user_email() + '\n')
3282
self.outf.write(c.username() + '\n')
3285
# display a warning if an email address isn't included in the given name.
3287
config.extract_email_address(name)
3288
except errors.NoEmailInUsername, e:
3289
warning('"%s" does not seem to contain an email address. '
3290
'This is allowed, but not recommended.', name)
3292
# use global config unless --branch given
3294
c = Branch.open_containing('.')[0].get_config()
3296
c = config.GlobalConfig()
3297
c.set_user_option('email', name)
3300
class cmd_nick(Command):
3301
"""Print or set the branch nickname.
3303
If unset, the tree root directory name is used as the nickname.
3304
To print the current nickname, execute with no argument.
3306
Bound branches use the nickname of its master branch unless it is set
3310
_see_also = ['info']
3311
takes_args = ['nickname?']
3312
def run(self, nickname=None):
3313
branch = Branch.open_containing(u'.')[0]
3314
if nickname is None:
3315
self.printme(branch)
3317
branch.nick = nickname
3320
def printme(self, branch):
3324
class cmd_alias(Command):
3325
"""Set/unset and display aliases.
3328
Show the current aliases::
3332
Show the alias specified for 'll'::
3336
Set an alias for 'll'::
3338
bzr alias ll="log --line -r-10..-1"
3340
To remove an alias for 'll'::
3342
bzr alias --remove ll
3345
takes_args = ['name?']
3347
Option('remove', help='Remove the alias.'),
3350
def run(self, name=None, remove=False):
3352
self.remove_alias(name)
3354
self.print_aliases()
3356
equal_pos = name.find('=')
3358
self.print_alias(name)
3360
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3362
def remove_alias(self, alias_name):
3363
if alias_name is None:
3364
raise errors.BzrCommandError(
3365
'bzr alias --remove expects an alias to remove.')
3366
# If alias is not found, print something like:
3367
# unalias: foo: not found
3368
c = config.GlobalConfig()
3369
c.unset_alias(alias_name)
3372
def print_aliases(self):
3373
"""Print out the defined aliases in a similar format to bash."""
3374
aliases = config.GlobalConfig().get_aliases()
3375
for key, value in sorted(aliases.iteritems()):
3376
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3379
def print_alias(self, alias_name):
3380
from bzrlib.commands import get_alias
3381
alias = get_alias(alias_name)
3383
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3386
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3388
def set_alias(self, alias_name, alias_command):
3389
"""Save the alias in the global config."""
3390
c = config.GlobalConfig()
3391
c.set_alias(alias_name, alias_command)
3394
class cmd_selftest(Command):
3395
"""Run internal test suite.
3397
If arguments are given, they are regular expressions that say which tests
3398
should run. Tests matching any expression are run, and other tests are
3401
Alternatively if --first is given, matching tests are run first and then
3402
all other tests are run. This is useful if you have been working in a
3403
particular area, but want to make sure nothing else was broken.
3405
If --exclude is given, tests that match that regular expression are
3406
excluded, regardless of whether they match --first or not.
3408
To help catch accidential dependencies between tests, the --randomize
3409
option is useful. In most cases, the argument used is the word 'now'.
3410
Note that the seed used for the random number generator is displayed
3411
when this option is used. The seed can be explicitly passed as the
3412
argument to this option if required. This enables reproduction of the
3413
actual ordering used if and when an order sensitive problem is encountered.
3415
If --list-only is given, the tests that would be run are listed. This is
3416
useful when combined with --first, --exclude and/or --randomize to
3417
understand their impact. The test harness reports "Listed nn tests in ..."
3418
instead of "Ran nn tests in ..." when list mode is enabled.
3420
If the global option '--no-plugins' is given, plugins are not loaded
3421
before running the selftests. This has two effects: features provided or
3422
modified by plugins will not be tested, and tests provided by plugins will
3425
Tests that need working space on disk use a common temporary directory,
3426
typically inside $TMPDIR or /tmp.
3428
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3429
into a pdb postmortem session.
3432
Run only tests relating to 'ignore'::
3436
Disable plugins and list tests as they're run::
3438
bzr --no-plugins selftest -v
3440
# NB: this is used from the class without creating an instance, which is
3441
# why it does not have a self parameter.
3442
def get_transport_type(typestring):
3443
"""Parse and return a transport specifier."""
3444
if typestring == "sftp":
3445
from bzrlib.tests import stub_sftp
3446
return stub_sftp.SFTPAbsoluteServer
3447
if typestring == "memory":
3448
from bzrlib.tests import test_server
3449
return memory.MemoryServer
3450
if typestring == "fakenfs":
3451
from bzrlib.tests import test_server
3452
return test_server.FakeNFSServer
3453
msg = "No known transport type %s. Supported types are: sftp\n" %\
3455
raise errors.BzrCommandError(msg)
3458
takes_args = ['testspecs*']
3459
takes_options = ['verbose',
3461
help='Stop when one test fails.',
3465
help='Use a different transport by default '
3466
'throughout the test suite.',
3467
type=get_transport_type),
3469
help='Run the benchmarks rather than selftests.'),
3470
Option('lsprof-timed',
3471
help='Generate lsprof output for benchmarked'
3472
' sections of code.'),
3473
Option('lsprof-tests',
3474
help='Generate lsprof output for each test.'),
3475
Option('cache-dir', type=str,
3476
help='Cache intermediate benchmark output in this '
3479
help='Run all tests, but run specified tests first.',
3483
help='List the tests instead of running them.'),
3484
RegistryOption('parallel',
3485
help="Run the test suite in parallel.",
3486
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3487
value_switches=False,
3489
Option('randomize', type=str, argname="SEED",
3490
help='Randomize the order of tests using the given'
3491
' seed or "now" for the current time.'),
3492
Option('exclude', type=str, argname="PATTERN",
3494
help='Exclude tests that match this regular'
3497
help='Output test progress via subunit.'),
3498
Option('strict', help='Fail on missing dependencies or '
3500
Option('load-list', type=str, argname='TESTLISTFILE',
3501
help='Load a test id list from a text file.'),
3502
ListOption('debugflag', type=str, short_name='E',
3503
help='Turn on a selftest debug flag.'),
3504
ListOption('starting-with', type=str, argname='TESTID',
3505
param_name='starting_with', short_name='s',
3507
'Load only the tests starting with TESTID.'),
3509
encoding_type = 'replace'
3512
Command.__init__(self)
3513
self.additional_selftest_args = {}
3515
def run(self, testspecs_list=None, verbose=False, one=False,
3516
transport=None, benchmark=None,
3517
lsprof_timed=None, cache_dir=None,
3518
first=False, list_only=False,
3519
randomize=None, exclude=None, strict=False,
3520
load_list=None, debugflag=None, starting_with=None, subunit=False,
3521
parallel=None, lsprof_tests=False):
3522
from bzrlib.tests import selftest
3523
import bzrlib.benchmarks as benchmarks
3524
from bzrlib.benchmarks import tree_creator
3526
# Make deprecation warnings visible, unless -Werror is set
3527
symbol_versioning.activate_deprecation_warnings(override=False)
3529
if cache_dir is not None:
3530
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3531
if testspecs_list is not None:
3532
pattern = '|'.join(testspecs_list)
3537
from bzrlib.tests import SubUnitBzrRunner
3539
raise errors.BzrCommandError("subunit not available. subunit "
3540
"needs to be installed to use --subunit.")
3541
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3543
self.additional_selftest_args.setdefault(
3544
'suite_decorators', []).append(parallel)
3546
test_suite_factory = benchmarks.test_suite
3547
# Unless user explicitly asks for quiet, be verbose in benchmarks
3548
verbose = not is_quiet()
3549
# TODO: should possibly lock the history file...
3550
benchfile = open(".perf_history", "at", buffering=1)
3551
self.add_cleanup(benchfile.close)
3553
test_suite_factory = None
3555
selftest_kwargs = {"verbose": verbose,
3557
"stop_on_failure": one,
3558
"transport": transport,
3559
"test_suite_factory": test_suite_factory,
3560
"lsprof_timed": lsprof_timed,
3561
"lsprof_tests": lsprof_tests,
3562
"bench_history": benchfile,
3563
"matching_tests_first": first,
3564
"list_only": list_only,
3565
"random_seed": randomize,
3566
"exclude_pattern": exclude,
3568
"load_list": load_list,
3569
"debug_flags": debugflag,
3570
"starting_with": starting_with
3572
selftest_kwargs.update(self.additional_selftest_args)
3573
result = selftest(**selftest_kwargs)
3574
return int(not result)
3577
class cmd_version(Command):
3578
"""Show version of bzr."""
3580
encoding_type = 'replace'
3582
Option("short", help="Print just the version number."),
3586
def run(self, short=False):
3587
from bzrlib.version import show_version
3589
self.outf.write(bzrlib.version_string + '\n')
3591
show_version(to_file=self.outf)
3594
class cmd_rocks(Command):
3595
"""Statement of optimism."""
3601
print "It sure does!"
3604
class cmd_find_merge_base(Command):
3605
"""Find and print a base revision for merging two branches."""
3606
# TODO: Options to specify revisions on either side, as if
3607
# merging only part of the history.
3608
takes_args = ['branch', 'other']
3612
def run(self, branch, other):
3613
from bzrlib.revision import ensure_null
3615
branch1 = Branch.open_containing(branch)[0]
3616
branch2 = Branch.open_containing(other)[0]
3618
self.add_cleanup(branch1.unlock)
3620
self.add_cleanup(branch2.unlock)
3621
last1 = ensure_null(branch1.last_revision())
3622
last2 = ensure_null(branch2.last_revision())
3624
graph = branch1.repository.get_graph(branch2.repository)
3625
base_rev_id = graph.find_unique_lca(last1, last2)
3627
print 'merge base is revision %s' % base_rev_id
3630
class cmd_merge(Command):
3631
"""Perform a three-way merge.
3633
The source of the merge can be specified either in the form of a branch,
3634
or in the form of a path to a file containing a merge directive generated
3635
with bzr send. If neither is specified, the default is the upstream branch
3636
or the branch most recently merged using --remember.
3638
When merging a branch, by default the tip will be merged. To pick a different
3639
revision, pass --revision. If you specify two values, the first will be used as
3640
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3641
available revisions, like this is commonly referred to as "cherrypicking".
3643
Revision numbers are always relative to the branch being merged.
3645
By default, bzr will try to merge in all new work from the other
3646
branch, automatically determining an appropriate base. If this
3647
fails, you may need to give an explicit base.
3649
Merge will do its best to combine the changes in two branches, but there
3650
are some kinds of problems only a human can fix. When it encounters those,
3651
it will mark a conflict. A conflict means that you need to fix something,
3652
before you should commit.
3654
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3656
If there is no default branch set, the first merge will set it. After
3657
that, you can omit the branch to use the default. To change the
3658
default, use --remember. The value will only be saved if the remote
3659
location can be accessed.
3661
The results of the merge are placed into the destination working
3662
directory, where they can be reviewed (with bzr diff), tested, and then
3663
committed to record the result of the merge.
3665
merge refuses to run if there are any uncommitted changes, unless
3666
--force is given. The --force option can also be used to create a
3667
merge revision which has more than two parents.
3669
If one would like to merge changes from the working tree of the other
3670
branch without merging any committed revisions, the --uncommitted option
3673
To select only some changes to merge, use "merge -i", which will prompt
3674
you to apply each diff hunk and file change, similar to "shelve".
3677
To merge the latest revision from bzr.dev::
3679
bzr merge ../bzr.dev
3681
To merge changes up to and including revision 82 from bzr.dev::
3683
bzr merge -r 82 ../bzr.dev
3685
To merge the changes introduced by 82, without previous changes::
3687
bzr merge -r 81..82 ../bzr.dev
3689
To apply a merge directive contained in /tmp/merge::
3691
bzr merge /tmp/merge
3693
To create a merge revision with three parents from two branches
3694
feature1a and feature1b:
3696
bzr merge ../feature1a
3697
bzr merge ../feature1b --force
3698
bzr commit -m 'revision with three parents'
3701
encoding_type = 'exact'
3702
_see_also = ['update', 'remerge', 'status-flags', 'send']
3703
takes_args = ['location?']
3708
help='Merge even if the destination tree has uncommitted changes.'),
3712
Option('show-base', help="Show base revision text in "
3714
Option('uncommitted', help='Apply uncommitted changes'
3715
' from a working copy, instead of branch changes.'),
3716
Option('pull', help='If the destination is already'
3717
' completely merged into the source, pull from the'
3718
' source rather than merging. When this happens,'
3719
' you do not need to commit the result.'),
3721
help='Branch to merge into, '
3722
'rather than the one containing the working directory.',
3726
Option('preview', help='Instead of merging, show a diff of the'
3728
Option('interactive', help='Select changes interactively.',
3732
def run(self, location=None, revision=None, force=False,
3733
merge_type=None, show_base=False, reprocess=None, remember=False,
3734
uncommitted=False, pull=False,
3739
if merge_type is None:
3740
merge_type = _mod_merge.Merge3Merger
3742
if directory is None: directory = u'.'
3743
possible_transports = []
3745
allow_pending = True
3746
verified = 'inapplicable'
3747
tree = WorkingTree.open_containing(directory)[0]
3750
basis_tree = tree.revision_tree(tree.last_revision())
3751
except errors.NoSuchRevision:
3752
basis_tree = tree.basis_tree()
3754
# die as quickly as possible if there are uncommitted changes
3756
if tree.has_changes():
3757
raise errors.UncommittedChanges(tree)
3759
view_info = _get_view_info_for_change_reporter(tree)
3760
change_reporter = delta._ChangeReporter(
3761
unversioned_filter=tree.is_ignored, view_info=view_info)
3762
pb = ui.ui_factory.nested_progress_bar()
3763
self.add_cleanup(pb.finished)
3765
self.add_cleanup(tree.unlock)
3766
if location is not None:
3768
mergeable = bundle.read_mergeable_from_url(location,
3769
possible_transports=possible_transports)
3770
except errors.NotABundle:
3774
raise errors.BzrCommandError('Cannot use --uncommitted'
3775
' with bundles or merge directives.')
3777
if revision is not None:
3778
raise errors.BzrCommandError(
3779
'Cannot use -r with merge directives or bundles')
3780
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3783
if merger is None and uncommitted:
3784
if revision is not None and len(revision) > 0:
3785
raise errors.BzrCommandError('Cannot use --uncommitted and'
3786
' --revision at the same time.')
3787
merger = self.get_merger_from_uncommitted(tree, location, pb)
3788
allow_pending = False
3791
merger, allow_pending = self._get_merger_from_branch(tree,
3792
location, revision, remember, possible_transports, pb)
3794
merger.merge_type = merge_type
3795
merger.reprocess = reprocess
3796
merger.show_base = show_base
3797
self.sanity_check_merger(merger)
3798
if (merger.base_rev_id == merger.other_rev_id and
3799
merger.other_rev_id is not None):
3800
note('Nothing to do.')
3803
if merger.interesting_files is not None:
3804
raise errors.BzrCommandError('Cannot pull individual files')
3805
if (merger.base_rev_id == tree.last_revision()):
3806
result = tree.pull(merger.other_branch, False,
3807
merger.other_rev_id)
3808
result.report(self.outf)
3810
if merger.this_basis is None:
3811
raise errors.BzrCommandError(
3812
"This branch has no commits."
3813
" (perhaps you would prefer 'bzr pull')")
3815
return self._do_preview(merger)
3817
return self._do_interactive(merger)
3819
return self._do_merge(merger, change_reporter, allow_pending,
3822
def _get_preview(self, merger):
3823
tree_merger = merger.make_merger()
3824
tt = tree_merger.make_preview_transform()
3825
self.add_cleanup(tt.finalize)
3826
result_tree = tt.get_preview_tree()
3829
def _do_preview(self, merger):
3830
from bzrlib.diff import show_diff_trees
3831
result_tree = self._get_preview(merger)
3832
show_diff_trees(merger.this_tree, result_tree, self.outf,
3833
old_label='', new_label='')
3835
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3836
merger.change_reporter = change_reporter
3837
conflict_count = merger.do_merge()
3839
merger.set_pending()
3840
if verified == 'failed':
3841
warning('Preview patch does not match changes')
3842
if conflict_count != 0:
3847
def _do_interactive(self, merger):
3848
"""Perform an interactive merge.
3850
This works by generating a preview tree of the merge, then using
3851
Shelver to selectively remove the differences between the working tree
3852
and the preview tree.
3854
from bzrlib import shelf_ui
3855
result_tree = self._get_preview(merger)
3856
writer = bzrlib.option.diff_writer_registry.get()
3857
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3858
reporter=shelf_ui.ApplyReporter(),
3859
diff_writer=writer(sys.stdout))
3865
def sanity_check_merger(self, merger):
3866
if (merger.show_base and
3867
not merger.merge_type is _mod_merge.Merge3Merger):
3868
raise errors.BzrCommandError("Show-base is not supported for this"
3869
" merge type. %s" % merger.merge_type)
3870
if merger.reprocess is None:
3871
if merger.show_base:
3872
merger.reprocess = False
3874
# Use reprocess if the merger supports it
3875
merger.reprocess = merger.merge_type.supports_reprocess
3876
if merger.reprocess and not merger.merge_type.supports_reprocess:
3877
raise errors.BzrCommandError("Conflict reduction is not supported"
3878
" for merge type %s." %
3880
if merger.reprocess and merger.show_base:
3881
raise errors.BzrCommandError("Cannot do conflict reduction and"
3884
def _get_merger_from_branch(self, tree, location, revision, remember,
3885
possible_transports, pb):
3886
"""Produce a merger from a location, assuming it refers to a branch."""
3887
from bzrlib.tag import _merge_tags_if_possible
3888
# find the branch locations
3889
other_loc, user_location = self._select_branch_location(tree, location,
3891
if revision is not None and len(revision) == 2:
3892
base_loc, _unused = self._select_branch_location(tree,
3893
location, revision, 0)
3895
base_loc = other_loc
3897
other_branch, other_path = Branch.open_containing(other_loc,
3898
possible_transports)
3899
if base_loc == other_loc:
3900
base_branch = other_branch
3902
base_branch, base_path = Branch.open_containing(base_loc,
3903
possible_transports)
3904
# Find the revision ids
3905
other_revision_id = None
3906
base_revision_id = None
3907
if revision is not None:
3908
if len(revision) >= 1:
3909
other_revision_id = revision[-1].as_revision_id(other_branch)
3910
if len(revision) == 2:
3911
base_revision_id = revision[0].as_revision_id(base_branch)
3912
if other_revision_id is None:
3913
other_revision_id = _mod_revision.ensure_null(
3914
other_branch.last_revision())
3915
# Remember where we merge from
3916
if ((remember or tree.branch.get_submit_branch() is None) and
3917
user_location is not None):
3918
tree.branch.set_submit_branch(other_branch.base)
3919
_merge_tags_if_possible(other_branch, tree.branch)
3920
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3921
other_revision_id, base_revision_id, other_branch, base_branch)
3922
if other_path != '':
3923
allow_pending = False
3924
merger.interesting_files = [other_path]
3926
allow_pending = True
3927
return merger, allow_pending
3929
def get_merger_from_uncommitted(self, tree, location, pb):
3930
"""Get a merger for uncommitted changes.
3932
:param tree: The tree the merger should apply to.
3933
:param location: The location containing uncommitted changes.
3934
:param pb: The progress bar to use for showing progress.
3936
location = self._select_branch_location(tree, location)[0]
3937
other_tree, other_path = WorkingTree.open_containing(location)
3938
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3939
if other_path != '':
3940
merger.interesting_files = [other_path]
3943
def _select_branch_location(self, tree, user_location, revision=None,
3945
"""Select a branch location, according to possible inputs.
3947
If provided, branches from ``revision`` are preferred. (Both
3948
``revision`` and ``index`` must be supplied.)
3950
Otherwise, the ``location`` parameter is used. If it is None, then the
3951
``submit`` or ``parent`` location is used, and a note is printed.
3953
:param tree: The working tree to select a branch for merging into
3954
:param location: The location entered by the user
3955
:param revision: The revision parameter to the command
3956
:param index: The index to use for the revision parameter. Negative
3957
indices are permitted.
3958
:return: (selected_location, user_location). The default location
3959
will be the user-entered location.
3961
if (revision is not None and index is not None
3962
and revision[index] is not None):
3963
branch = revision[index].get_branch()
3964
if branch is not None:
3965
return branch, branch
3966
if user_location is None:
3967
location = self._get_remembered(tree, 'Merging from')
3969
location = user_location
3970
return location, user_location
3972
def _get_remembered(self, tree, verb_string):
3973
"""Use tree.branch's parent if none was supplied.
3975
Report if the remembered location was used.
3977
stored_location = tree.branch.get_submit_branch()
3978
stored_location_type = "submit"
3979
if stored_location is None:
3980
stored_location = tree.branch.get_parent()
3981
stored_location_type = "parent"
3982
mutter("%s", stored_location)
3983
if stored_location is None:
3984
raise errors.BzrCommandError("No location specified or remembered")
3985
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3986
note(u"%s remembered %s location %s", verb_string,
3987
stored_location_type, display_url)
3988
return stored_location
3991
class cmd_remerge(Command):
3994
Use this if you want to try a different merge technique while resolving
3995
conflicts. Some merge techniques are better than others, and remerge
3996
lets you try different ones on different files.
3998
The options for remerge have the same meaning and defaults as the ones for
3999
merge. The difference is that remerge can (only) be run when there is a
4000
pending merge, and it lets you specify particular files.
4003
Re-do the merge of all conflicted files, and show the base text in
4004
conflict regions, in addition to the usual THIS and OTHER texts::
4006
bzr remerge --show-base
4008
Re-do the merge of "foobar", using the weave merge algorithm, with
4009
additional processing to reduce the size of conflict regions::
4011
bzr remerge --merge-type weave --reprocess foobar
4013
takes_args = ['file*']
4018
help="Show base revision text in conflicts."),
4021
def run(self, file_list=None, merge_type=None, show_base=False,
4023
if merge_type is None:
4024
merge_type = _mod_merge.Merge3Merger
4025
tree, file_list = tree_files(file_list)
4027
self.add_cleanup(tree.unlock)
4028
parents = tree.get_parent_ids()
4029
if len(parents) != 2:
4030
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4031
" merges. Not cherrypicking or"
4033
repository = tree.branch.repository
4034
interesting_ids = None
4036
conflicts = tree.conflicts()
4037
if file_list is not None:
4038
interesting_ids = set()
4039
for filename in file_list:
4040
file_id = tree.path2id(filename)
4042
raise errors.NotVersionedError(filename)
4043
interesting_ids.add(file_id)
4044
if tree.kind(file_id) != "directory":
4047
for name, ie in tree.inventory.iter_entries(file_id):
4048
interesting_ids.add(ie.file_id)
4049
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4051
# Remerge only supports resolving contents conflicts
4052
allowed_conflicts = ('text conflict', 'contents conflict')
4053
restore_files = [c.path for c in conflicts
4054
if c.typestring in allowed_conflicts]
4055
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4056
tree.set_conflicts(ConflictList(new_conflicts))
4057
if file_list is not None:
4058
restore_files = file_list
4059
for filename in restore_files:
4061
restore(tree.abspath(filename))
4062
except errors.NotConflicted:
4064
# Disable pending merges, because the file texts we are remerging
4065
# have not had those merges performed. If we use the wrong parents
4066
# list, we imply that the working tree text has seen and rejected
4067
# all the changes from the other tree, when in fact those changes
4068
# have not yet been seen.
4069
pb = ui.ui_factory.nested_progress_bar()
4070
tree.set_parent_ids(parents[:1])
4072
merger = _mod_merge.Merger.from_revision_ids(pb,
4074
merger.interesting_ids = interesting_ids
4075
merger.merge_type = merge_type
4076
merger.show_base = show_base
4077
merger.reprocess = reprocess
4078
conflicts = merger.do_merge()
4080
tree.set_parent_ids(parents)
4088
class cmd_revert(Command):
4089
"""Revert files to a previous revision.
4091
Giving a list of files will revert only those files. Otherwise, all files
4092
will be reverted. If the revision is not specified with '--revision', the
4093
last committed revision is used.
4095
To remove only some changes, without reverting to a prior version, use
4096
merge instead. For example, "merge . --revision -2..-3" will remove the
4097
changes introduced by -2, without affecting the changes introduced by -1.
4098
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4100
By default, any files that have been manually changed will be backed up
4101
first. (Files changed only by merge are not backed up.) Backup files have
4102
'.~#~' appended to their name, where # is a number.
4104
When you provide files, you can use their current pathname or the pathname
4105
from the target revision. So you can use revert to "undelete" a file by
4106
name. If you name a directory, all the contents of that directory will be
4109
If you have newly added files since the target revision, they will be
4110
removed. If the files to be removed have been changed, backups will be
4111
created as above. Directories containing unknown files will not be
4114
The working tree contains a list of revisions that have been merged but
4115
not yet committed. These revisions will be included as additional parents
4116
of the next commit. Normally, using revert clears that list as well as
4117
reverting the files. If any files are specified, revert leaves the list
4118
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4119
.`` in the tree root to revert all files but keep the recorded merges,
4120
and ``bzr revert --forget-merges`` to clear the pending merge list without
4121
reverting any files.
4123
Using "bzr revert --forget-merges", it is possible to apply all of the
4124
changes from a branch in a single revision. To do this, perform the merge
4125
as desired. Then doing revert with the "--forget-merges" option will keep
4126
the content of the tree as it was, but it will clear the list of pending
4127
merges. The next commit will then contain all of the changes that are
4128
present in the other branch, but without any other parent revisions.
4129
Because this technique forgets where these changes originated, it may
4130
cause additional conflicts on later merges involving the same source and
4134
_see_also = ['cat', 'export']
4137
Option('no-backup', "Do not save backups of reverted files."),
4138
Option('forget-merges',
4139
'Remove pending merge marker, without changing any files.'),
4141
takes_args = ['file*']
4143
def run(self, revision=None, no_backup=False, file_list=None,
4144
forget_merges=None):
4145
tree, file_list = tree_files(file_list)
4147
self.add_cleanup(tree.unlock)
4149
tree.set_parent_ids(tree.get_parent_ids()[:1])
4151
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4154
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4155
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4156
pb = ui.ui_factory.nested_progress_bar()
4158
tree.revert(file_list, rev_tree, not no_backup, pb,
4159
report_changes=True)
4164
class cmd_assert_fail(Command):
4165
"""Test reporting of assertion failures"""
4166
# intended just for use in testing
4171
raise AssertionError("always fails")
4174
class cmd_help(Command):
4175
"""Show help on a command or other topic.
4178
_see_also = ['topics']
4180
Option('long', 'Show help on all commands.'),
4182
takes_args = ['topic?']
4183
aliases = ['?', '--help', '-?', '-h']
4186
def run(self, topic=None, long=False):
4188
if topic is None and long:
4190
bzrlib.help.help(topic)
4193
class cmd_shell_complete(Command):
4194
"""Show appropriate completions for context.
4196
For a list of all available commands, say 'bzr shell-complete'.
4198
takes_args = ['context?']
4203
def run(self, context=None):
4204
import shellcomplete
4205
shellcomplete.shellcomplete(context)
4208
class cmd_missing(Command):
4209
"""Show unmerged/unpulled revisions between two branches.
4211
OTHER_BRANCH may be local or remote.
4213
To filter on a range of revisions, you can use the command -r begin..end
4214
-r revision requests a specific revision, -r ..end or -r begin.. are
4218
1 - some missing revisions
4219
0 - no missing revisions
4223
Determine the missing revisions between this and the branch at the
4224
remembered pull location::
4228
Determine the missing revisions between this and another branch::
4230
bzr missing http://server/branch
4232
Determine the missing revisions up to a specific revision on the other
4235
bzr missing -r ..-10
4237
Determine the missing revisions up to a specific revision on this
4240
bzr missing --my-revision ..-10
4243
_see_also = ['merge', 'pull']
4244
takes_args = ['other_branch?']
4246
Option('reverse', 'Reverse the order of revisions.'),
4248
'Display changes in the local branch only.'),
4249
Option('this' , 'Same as --mine-only.'),
4250
Option('theirs-only',
4251
'Display changes in the remote branch only.'),
4252
Option('other', 'Same as --theirs-only.'),
4256
custom_help('revision',
4257
help='Filter on other branch revisions (inclusive). '
4258
'See "help revisionspec" for details.'),
4259
Option('my-revision',
4260
type=_parse_revision_str,
4261
help='Filter on local branch revisions (inclusive). '
4262
'See "help revisionspec" for details.'),
4263
Option('include-merges',
4264
'Show all revisions in addition to the mainline ones.'),
4266
encoding_type = 'replace'
4269
def run(self, other_branch=None, reverse=False, mine_only=False,
4271
log_format=None, long=False, short=False, line=False,
4272
show_ids=False, verbose=False, this=False, other=False,
4273
include_merges=False, revision=None, my_revision=None):
4274
from bzrlib.missing import find_unmerged, iter_log_revisions
4283
# TODO: We should probably check that we don't have mine-only and
4284
# theirs-only set, but it gets complicated because we also have
4285
# this and other which could be used.
4292
local_branch = Branch.open_containing(u".")[0]
4293
parent = local_branch.get_parent()
4294
if other_branch is None:
4295
other_branch = parent
4296
if other_branch is None:
4297
raise errors.BzrCommandError("No peer location known"
4299
display_url = urlutils.unescape_for_display(parent,
4301
message("Using saved parent location: "
4302
+ display_url + "\n")
4304
remote_branch = Branch.open(other_branch)
4305
if remote_branch.base == local_branch.base:
4306
remote_branch = local_branch
4308
local_branch.lock_read()
4309
self.add_cleanup(local_branch.unlock)
4310
local_revid_range = _revision_range_to_revid_range(
4311
_get_revision_range(my_revision, local_branch,
4314
remote_branch.lock_read()
4315
self.add_cleanup(remote_branch.unlock)
4316
remote_revid_range = _revision_range_to_revid_range(
4317
_get_revision_range(revision,
4318
remote_branch, self.name()))
4320
local_extra, remote_extra = find_unmerged(
4321
local_branch, remote_branch, restrict,
4322
backward=not reverse,
4323
include_merges=include_merges,
4324
local_revid_range=local_revid_range,
4325
remote_revid_range=remote_revid_range)
4327
if log_format is None:
4328
registry = log.log_formatter_registry
4329
log_format = registry.get_default(local_branch)
4330
lf = log_format(to_file=self.outf,
4332
show_timezone='original')
4335
if local_extra and not theirs_only:
4336
message("You have %d extra revision(s):\n" %
4338
for revision in iter_log_revisions(local_extra,
4339
local_branch.repository,
4341
lf.log_revision(revision)
4342
printed_local = True
4345
printed_local = False
4347
if remote_extra and not mine_only:
4348
if printed_local is True:
4350
message("You are missing %d revision(s):\n" %
4352
for revision in iter_log_revisions(remote_extra,
4353
remote_branch.repository,
4355
lf.log_revision(revision)
4358
if mine_only and not local_extra:
4359
# We checked local, and found nothing extra
4360
message('This branch is up to date.\n')
4361
elif theirs_only and not remote_extra:
4362
# We checked remote, and found nothing extra
4363
message('Other branch is up to date.\n')
4364
elif not (mine_only or theirs_only or local_extra or
4366
# We checked both branches, and neither one had extra
4368
message("Branches are up to date.\n")
4370
if not status_code and parent is None and other_branch is not None:
4371
local_branch.lock_write()
4372
self.add_cleanup(local_branch.unlock)
4373
# handle race conditions - a parent might be set while we run.
4374
if local_branch.get_parent() is None:
4375
local_branch.set_parent(remote_branch.base)
4379
class cmd_pack(Command):
4380
"""Compress the data within a repository."""
4382
_see_also = ['repositories']
4383
takes_args = ['branch_or_repo?']
4385
def run(self, branch_or_repo='.'):
4386
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4388
branch = dir.open_branch()
4389
repository = branch.repository
4390
except errors.NotBranchError:
4391
repository = dir.open_repository()
4395
class cmd_plugins(Command):
4396
"""List the installed plugins.
4398
This command displays the list of installed plugins including
4399
version of plugin and a short description of each.
4401
--verbose shows the path where each plugin is located.
4403
A plugin is an external component for Bazaar that extends the
4404
revision control system, by adding or replacing code in Bazaar.
4405
Plugins can do a variety of things, including overriding commands,
4406
adding new commands, providing additional network transports and
4407
customizing log output.
4409
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4410
for further information on plugins including where to find them and how to
4411
install them. Instructions are also provided there on how to write new
4412
plugins using the Python programming language.
4414
takes_options = ['verbose']
4417
def run(self, verbose=False):
4418
import bzrlib.plugin
4419
from inspect import getdoc
4421
for name, plugin in bzrlib.plugin.plugins().items():
4422
version = plugin.__version__
4423
if version == 'unknown':
4425
name_ver = '%s %s' % (name, version)
4426
d = getdoc(plugin.module)
4428
doc = d.split('\n')[0]
4430
doc = '(no description)'
4431
result.append((name_ver, doc, plugin.path()))
4432
for name_ver, doc, path in sorted(result):
4440
class cmd_testament(Command):
4441
"""Show testament (signing-form) of a revision."""
4444
Option('long', help='Produce long-format testament.'),
4446
help='Produce a strict-format testament.')]
4447
takes_args = ['branch?']
4449
def run(self, branch=u'.', revision=None, long=False, strict=False):
4450
from bzrlib.testament import Testament, StrictTestament
4452
testament_class = StrictTestament
4454
testament_class = Testament
4456
b = Branch.open_containing(branch)[0]
4458
b = Branch.open(branch)
4460
self.add_cleanup(b.unlock)
4461
if revision is None:
4462
rev_id = b.last_revision()
4464
rev_id = revision[0].as_revision_id(b)
4465
t = testament_class.from_revision(b.repository, rev_id)
4467
sys.stdout.writelines(t.as_text_lines())
4469
sys.stdout.write(t.as_short_text())
4472
class cmd_annotate(Command):
4473
"""Show the origin of each line in a file.
4475
This prints out the given file with an annotation on the left side
4476
indicating which revision, author and date introduced the change.
4478
If the origin is the same for a run of consecutive lines, it is
4479
shown only at the top, unless the --all option is given.
4481
# TODO: annotate directories; showing when each file was last changed
4482
# TODO: if the working copy is modified, show annotations on that
4483
# with new uncommitted lines marked
4484
aliases = ['ann', 'blame', 'praise']
4485
takes_args = ['filename']
4486
takes_options = [Option('all', help='Show annotations on all lines.'),
4487
Option('long', help='Show commit date in annotations.'),
4491
encoding_type = 'exact'
4494
def run(self, filename, all=False, long=False, revision=None,
4496
from bzrlib.annotate import annotate_file, annotate_file_tree
4497
wt, branch, relpath = \
4498
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4501
self.add_cleanup(wt.unlock)
4504
self.add_cleanup(branch.unlock)
4505
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4507
self.add_cleanup(tree.unlock)
4509
file_id = wt.path2id(relpath)
4511
file_id = tree.path2id(relpath)
4513
raise errors.NotVersionedError(filename)
4514
file_version = tree.inventory[file_id].revision
4515
if wt is not None and revision is None:
4516
# If there is a tree and we're not annotating historical
4517
# versions, annotate the working tree's content.
4518
annotate_file_tree(wt, file_id, self.outf, long, all,
4521
annotate_file(branch, file_version, file_id, long, all, self.outf,
4525
class cmd_re_sign(Command):
4526
"""Create a digital signature for an existing revision."""
4527
# TODO be able to replace existing ones.
4529
hidden = True # is this right ?
4530
takes_args = ['revision_id*']
4531
takes_options = ['revision']
4533
def run(self, revision_id_list=None, revision=None):
4534
if revision_id_list is not None and revision is not None:
4535
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4536
if revision_id_list is None and revision is None:
4537
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4538
b = WorkingTree.open_containing(u'.')[0].branch
4540
self.add_cleanup(b.unlock)
4541
return self._run(b, revision_id_list, revision)
4543
def _run(self, b, revision_id_list, revision):
4544
import bzrlib.gpg as gpg
4545
gpg_strategy = gpg.GPGStrategy(b.get_config())
4546
if revision_id_list is not None:
4547
b.repository.start_write_group()
4549
for revision_id in revision_id_list:
4550
b.repository.sign_revision(revision_id, gpg_strategy)
4552
b.repository.abort_write_group()
4555
b.repository.commit_write_group()
4556
elif revision is not None:
4557
if len(revision) == 1:
4558
revno, rev_id = revision[0].in_history(b)
4559
b.repository.start_write_group()
4561
b.repository.sign_revision(rev_id, gpg_strategy)
4563
b.repository.abort_write_group()
4566
b.repository.commit_write_group()
4567
elif len(revision) == 2:
4568
# are they both on rh- if so we can walk between them
4569
# might be nice to have a range helper for arbitrary
4570
# revision paths. hmm.
4571
from_revno, from_revid = revision[0].in_history(b)
4572
to_revno, to_revid = revision[1].in_history(b)
4573
if to_revid is None:
4574
to_revno = b.revno()
4575
if from_revno is None or to_revno is None:
4576
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4577
b.repository.start_write_group()
4579
for revno in range(from_revno, to_revno + 1):
4580
b.repository.sign_revision(b.get_rev_id(revno),
4583
b.repository.abort_write_group()
4586
b.repository.commit_write_group()
4588
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4591
class cmd_bind(Command):
4592
"""Convert the current branch into a checkout of the supplied branch.
4594
Once converted into a checkout, commits must succeed on the master branch
4595
before they will be applied to the local branch.
4597
Bound branches use the nickname of its master branch unless it is set
4598
locally, in which case binding will update the local nickname to be
4602
_see_also = ['checkouts', 'unbind']
4603
takes_args = ['location?']
4606
def run(self, location=None):
4607
b, relpath = Branch.open_containing(u'.')
4608
if location is None:
4610
location = b.get_old_bound_location()
4611
except errors.UpgradeRequired:
4612
raise errors.BzrCommandError('No location supplied. '
4613
'This format does not remember old locations.')
4615
if location is None:
4616
if b.get_bound_location() is not None:
4617
raise errors.BzrCommandError('Branch is already bound')
4619
raise errors.BzrCommandError('No location supplied '
4620
'and no previous location known')
4621
b_other = Branch.open(location)
4624
except errors.DivergedBranches:
4625
raise errors.BzrCommandError('These branches have diverged.'
4626
' Try merging, and then bind again.')
4627
if b.get_config().has_explicit_nickname():
4628
b.nick = b_other.nick
4631
class cmd_unbind(Command):
4632
"""Convert the current checkout into a regular branch.
4634
After unbinding, the local branch is considered independent and subsequent
4635
commits will be local only.
4638
_see_also = ['checkouts', 'bind']
4643
b, relpath = Branch.open_containing(u'.')
4645
raise errors.BzrCommandError('Local branch is not bound')
4648
class cmd_uncommit(Command):
4649
"""Remove the last committed revision.
4651
--verbose will print out what is being removed.
4652
--dry-run will go through all the motions, but not actually
4655
If --revision is specified, uncommit revisions to leave the branch at the
4656
specified revision. For example, "bzr uncommit -r 15" will leave the
4657
branch at revision 15.
4659
Uncommit leaves the working tree ready for a new commit. The only change
4660
it may make is to restore any pending merges that were present before
4664
# TODO: jam 20060108 Add an option to allow uncommit to remove
4665
# unreferenced information in 'branch-as-repository' branches.
4666
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4667
# information in shared branches as well.
4668
_see_also = ['commit']
4669
takes_options = ['verbose', 'revision',
4670
Option('dry-run', help='Don\'t actually make changes.'),
4671
Option('force', help='Say yes to all questions.'),
4673
help="Only remove the commits from the local branch"
4674
" when in a checkout."
4677
takes_args = ['location?']
4679
encoding_type = 'replace'
4681
def run(self, location=None,
4682
dry_run=False, verbose=False,
4683
revision=None, force=False, local=False):
4684
if location is None:
4686
control, relpath = bzrdir.BzrDir.open_containing(location)
4688
tree = control.open_workingtree()
4690
except (errors.NoWorkingTree, errors.NotLocalUrl):
4692
b = control.open_branch()
4694
if tree is not None:
4696
self.add_cleanup(tree.unlock)
4699
self.add_cleanup(b.unlock)
4700
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4702
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4703
from bzrlib.log import log_formatter, show_log
4704
from bzrlib.uncommit import uncommit
4706
last_revno, last_rev_id = b.last_revision_info()
4709
if revision is None:
4711
rev_id = last_rev_id
4713
# 'bzr uncommit -r 10' actually means uncommit
4714
# so that the final tree is at revno 10.
4715
# but bzrlib.uncommit.uncommit() actually uncommits
4716
# the revisions that are supplied.
4717
# So we need to offset it by one
4718
revno = revision[0].in_history(b).revno + 1
4719
if revno <= last_revno:
4720
rev_id = b.get_rev_id(revno)
4722
if rev_id is None or _mod_revision.is_null(rev_id):
4723
ui.ui_factory.note('No revisions to uncommit.')
4726
log_collector = ui.ui_factory.make_output_stream()
4727
lf = log_formatter('short',
4728
to_file=log_collector,
4729
show_timezone='original')
4734
direction='forward',
4735
start_revision=revno,
4736
end_revision=last_revno)
4739
ui.ui_factory.note('Dry-run, pretending to remove the above revisions.')
4741
ui.ui_factory.note('The above revision(s) will be removed.')
4744
if not ui.ui_factory.get_boolean('Are you sure [y/N]? '):
4745
ui.ui_factory.note('Canceled')
4748
mutter('Uncommitting from {%s} to {%s}',
4749
last_rev_id, rev_id)
4750
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4751
revno=revno, local=local)
4752
ui.ui_factory.note('You can restore the old tip by running:\n'
4753
' bzr pull . -r revid:%s' % last_rev_id)
4756
class cmd_break_lock(Command):
4757
"""Break a dead lock on a repository, branch or working directory.
4759
CAUTION: Locks should only be broken when you are sure that the process
4760
holding the lock has been stopped.
4762
You can get information on what locks are open via the 'bzr info
4763
[location]' command.
4767
bzr break-lock bzr+ssh://example.com/bzr/foo
4769
takes_args = ['location?']
4771
def run(self, location=None, show=False):
4772
if location is None:
4774
control, relpath = bzrdir.BzrDir.open_containing(location)
4776
control.break_lock()
4777
except NotImplementedError:
4781
class cmd_wait_until_signalled(Command):
4782
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4784
This just prints a line to signal when it is ready, then blocks on stdin.
4790
sys.stdout.write("running\n")
4792
sys.stdin.readline()
4795
class cmd_serve(Command):
4796
"""Run the bzr server."""
4798
aliases = ['server']
4802
help='Serve on stdin/out for use from inetd or sshd.'),
4803
RegistryOption('protocol',
4804
help="Protocol to serve.",
4805
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4806
value_switches=True),
4808
help='Listen for connections on nominated port of the form '
4809
'[hostname:]portnumber. Passing 0 as the port number will '
4810
'result in a dynamically allocated port. The default port '
4811
'depends on the protocol.',
4814
help='Serve contents of this directory.',
4816
Option('allow-writes',
4817
help='By default the server is a readonly server. Supplying '
4818
'--allow-writes enables write access to the contents of '
4819
'the served directory and below. Note that ``bzr serve`` '
4820
'does not perform authentication, so unless some form of '
4821
'external authentication is arranged supplying this '
4822
'option leads to global uncontrolled write access to your '
4827
def get_host_and_port(self, port):
4828
"""Return the host and port to run the smart server on.
4830
If 'port' is None, None will be returned for the host and port.
4832
If 'port' has a colon in it, the string before the colon will be
4833
interpreted as the host.
4835
:param port: A string of the port to run the server on.
4836
:return: A tuple of (host, port), where 'host' is a host name or IP,
4837
and port is an integer TCP/IP port.
4840
if port is not None:
4842
host, port = port.split(':')
4846
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4848
from bzrlib.transport import get_transport, transport_server_registry
4849
if directory is None:
4850
directory = os.getcwd()
4851
if protocol is None:
4852
protocol = transport_server_registry.get()
4853
host, port = self.get_host_and_port(port)
4854
url = urlutils.local_path_to_url(directory)
4855
if not allow_writes:
4856
url = 'readonly+' + url
4857
transport = get_transport(url)
4858
protocol(transport, host, port, inet)
4861
class cmd_join(Command):
4862
"""Combine a tree into its containing tree.
4864
This command requires the target tree to be in a rich-root format.
4866
The TREE argument should be an independent tree, inside another tree, but
4867
not part of it. (Such trees can be produced by "bzr split", but also by
4868
running "bzr branch" with the target inside a tree.)
4870
The result is a combined tree, with the subtree no longer an independant
4871
part. This is marked as a merge of the subtree into the containing tree,
4872
and all history is preserved.
4875
_see_also = ['split']
4876
takes_args = ['tree']
4878
Option('reference', help='Join by reference.', hidden=True),
4881
def run(self, tree, reference=False):
4882
sub_tree = WorkingTree.open(tree)
4883
parent_dir = osutils.dirname(sub_tree.basedir)
4884
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4885
repo = containing_tree.branch.repository
4886
if not repo.supports_rich_root():
4887
raise errors.BzrCommandError(
4888
"Can't join trees because %s doesn't support rich root data.\n"
4889
"You can use bzr upgrade on the repository."
4893
containing_tree.add_reference(sub_tree)
4894
except errors.BadReferenceTarget, e:
4895
# XXX: Would be better to just raise a nicely printable
4896
# exception from the real origin. Also below. mbp 20070306
4897
raise errors.BzrCommandError("Cannot join %s. %s" %
4901
containing_tree.subsume(sub_tree)
4902
except errors.BadSubsumeSource, e:
4903
raise errors.BzrCommandError("Cannot join %s. %s" %
4907
class cmd_split(Command):
4908
"""Split a subdirectory of a tree into a separate tree.
4910
This command will produce a target tree in a format that supports
4911
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4912
converted into earlier formats like 'dirstate-tags'.
4914
The TREE argument should be a subdirectory of a working tree. That
4915
subdirectory will be converted into an independent tree, with its own
4916
branch. Commits in the top-level tree will not apply to the new subtree.
4919
_see_also = ['join']
4920
takes_args = ['tree']
4922
def run(self, tree):
4923
containing_tree, subdir = WorkingTree.open_containing(tree)
4924
sub_id = containing_tree.path2id(subdir)
4926
raise errors.NotVersionedError(subdir)
4928
containing_tree.extract(sub_id)
4929
except errors.RootNotRich:
4930
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4933
class cmd_merge_directive(Command):
4934
"""Generate a merge directive for auto-merge tools.
4936
A directive requests a merge to be performed, and also provides all the
4937
information necessary to do so. This means it must either include a
4938
revision bundle, or the location of a branch containing the desired
4941
A submit branch (the location to merge into) must be supplied the first
4942
time the command is issued. After it has been supplied once, it will
4943
be remembered as the default.
4945
A public branch is optional if a revision bundle is supplied, but required
4946
if --diff or --plain is specified. It will be remembered as the default
4947
after the first use.
4950
takes_args = ['submit_branch?', 'public_branch?']
4954
_see_also = ['send']
4957
RegistryOption.from_kwargs('patch-type',
4958
'The type of patch to include in the directive.',
4960
value_switches=True,
4962
bundle='Bazaar revision bundle (default).',
4963
diff='Normal unified diff.',
4964
plain='No patch, just directive.'),
4965
Option('sign', help='GPG-sign the directive.'), 'revision',
4966
Option('mail-to', type=str,
4967
help='Instead of printing the directive, email to this address.'),
4968
Option('message', type=str, short_name='m',
4969
help='Message to use when committing this merge.')
4972
encoding_type = 'exact'
4974
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4975
sign=False, revision=None, mail_to=None, message=None):
4976
from bzrlib.revision import ensure_null, NULL_REVISION
4977
include_patch, include_bundle = {
4978
'plain': (False, False),
4979
'diff': (True, False),
4980
'bundle': (True, True),
4982
branch = Branch.open('.')
4983
stored_submit_branch = branch.get_submit_branch()
4984
if submit_branch is None:
4985
submit_branch = stored_submit_branch
4987
if stored_submit_branch is None:
4988
branch.set_submit_branch(submit_branch)
4989
if submit_branch is None:
4990
submit_branch = branch.get_parent()
4991
if submit_branch is None:
4992
raise errors.BzrCommandError('No submit branch specified or known')
4994
stored_public_branch = branch.get_public_branch()
4995
if public_branch is None:
4996
public_branch = stored_public_branch
4997
elif stored_public_branch is None:
4998
branch.set_public_branch(public_branch)
4999
if not include_bundle and public_branch is None:
5000
raise errors.BzrCommandError('No public branch specified or'
5002
base_revision_id = None
5003
if revision is not None:
5004
if len(revision) > 2:
5005
raise errors.BzrCommandError('bzr merge-directive takes '
5006
'at most two one revision identifiers')
5007
revision_id = revision[-1].as_revision_id(branch)
5008
if len(revision) == 2:
5009
base_revision_id = revision[0].as_revision_id(branch)
5011
revision_id = branch.last_revision()
5012
revision_id = ensure_null(revision_id)
5013
if revision_id == NULL_REVISION:
5014
raise errors.BzrCommandError('No revisions to bundle.')
5015
directive = merge_directive.MergeDirective2.from_objects(
5016
branch.repository, revision_id, time.time(),
5017
osutils.local_time_offset(), submit_branch,
5018
public_branch=public_branch, include_patch=include_patch,
5019
include_bundle=include_bundle, message=message,
5020
base_revision_id=base_revision_id)
5023
self.outf.write(directive.to_signed(branch))
5025
self.outf.writelines(directive.to_lines())
5027
message = directive.to_email(mail_to, branch, sign)
5028
s = SMTPConnection(branch.get_config())
5029
s.send_email(message)
5032
class cmd_send(Command):
5033
"""Mail or create a merge-directive for submitting changes.
5035
A merge directive provides many things needed for requesting merges:
5037
* A machine-readable description of the merge to perform
5039
* An optional patch that is a preview of the changes requested
5041
* An optional bundle of revision data, so that the changes can be applied
5042
directly from the merge directive, without retrieving data from a
5045
`bzr send` creates a compact data set that, when applied using bzr
5046
merge, has the same effect as merging from the source branch.
5048
By default the merge directive is self-contained and can be applied to any
5049
branch containing submit_branch in its ancestory without needing access to
5052
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5053
revisions, but only a structured request to merge from the
5054
public_location. In that case the public_branch is needed and it must be
5055
up-to-date and accessible to the recipient. The public_branch is always
5056
included if known, so that people can check it later.
5058
The submit branch defaults to the parent of the source branch, but can be
5059
overridden. Both submit branch and public branch will be remembered in
5060
branch.conf the first time they are used for a particular branch. The
5061
source branch defaults to that containing the working directory, but can
5062
be changed using --from.
5064
In order to calculate those changes, bzr must analyse the submit branch.
5065
Therefore it is most efficient for the submit branch to be a local mirror.
5066
If a public location is known for the submit_branch, that location is used
5067
in the merge directive.
5069
The default behaviour is to send the merge directive by mail, unless -o is
5070
given, in which case it is sent to a file.
5072
Mail is sent using your preferred mail program. This should be transparent
5073
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5074
If the preferred client can't be found (or used), your editor will be used.
5076
To use a specific mail program, set the mail_client configuration option.
5077
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5078
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5079
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5080
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5083
If mail is being sent, a to address is required. This can be supplied
5084
either on the commandline, by setting the submit_to configuration
5085
option in the branch itself or the child_submit_to configuration option
5086
in the submit branch.
5088
Two formats are currently supported: "4" uses revision bundle format 4 and
5089
merge directive format 2. It is significantly faster and smaller than
5090
older formats. It is compatible with Bazaar 0.19 and later. It is the
5091
default. "0.9" uses revision bundle format 0.9 and merge directive
5092
format 1. It is compatible with Bazaar 0.12 - 0.18.
5094
The merge directives created by bzr send may be applied using bzr merge or
5095
bzr pull by specifying a file containing a merge directive as the location.
5097
bzr send makes extensive use of public locations to map local locations into
5098
URLs that can be used by other people. See `bzr help configuration` to
5099
set them, and use `bzr info` to display them.
5102
encoding_type = 'exact'
5104
_see_also = ['merge', 'pull']
5106
takes_args = ['submit_branch?', 'public_branch?']
5110
help='Do not include a bundle in the merge directive.'),
5111
Option('no-patch', help='Do not include a preview patch in the merge'
5114
help='Remember submit and public branch.'),
5116
help='Branch to generate the submission from, '
5117
'rather than the one containing the working directory.',
5120
Option('output', short_name='o',
5121
help='Write merge directive to this file; '
5122
'use - for stdout.',
5125
help='Refuse to send if there are uncommitted changes in'
5126
' the working tree, --no-strict disables the check.'),
5127
Option('mail-to', help='Mail the request to this address.',
5131
Option('body', help='Body for the email.', type=unicode),
5132
RegistryOption('format',
5133
help='Use the specified output format.',
5134
lazy_registry=('bzrlib.send', 'format_registry')),
5137
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5138
no_patch=False, revision=None, remember=False, output=None,
5139
format=None, mail_to=None, message=None, body=None,
5140
strict=None, **kwargs):
5141
from bzrlib.send import send
5142
return send(submit_branch, revision, public_branch, remember,
5143
format, no_bundle, no_patch, output,
5144
kwargs.get('from', '.'), mail_to, message, body,
5149
class cmd_bundle_revisions(cmd_send):
5150
"""Create a merge-directive for submitting changes.
5152
A merge directive provides many things needed for requesting merges:
5154
* A machine-readable description of the merge to perform
5156
* An optional patch that is a preview of the changes requested
5158
* An optional bundle of revision data, so that the changes can be applied
5159
directly from the merge directive, without retrieving data from a
5162
If --no-bundle is specified, then public_branch is needed (and must be
5163
up-to-date), so that the receiver can perform the merge using the
5164
public_branch. The public_branch is always included if known, so that
5165
people can check it later.
5167
The submit branch defaults to the parent, but can be overridden. Both
5168
submit branch and public branch will be remembered if supplied.
5170
If a public_branch is known for the submit_branch, that public submit
5171
branch is used in the merge instructions. This means that a local mirror
5172
can be used as your actual submit branch, once you have set public_branch
5175
Two formats are currently supported: "4" uses revision bundle format 4 and
5176
merge directive format 2. It is significantly faster and smaller than
5177
older formats. It is compatible with Bazaar 0.19 and later. It is the
5178
default. "0.9" uses revision bundle format 0.9 and merge directive
5179
format 1. It is compatible with Bazaar 0.12 - 0.18.
5184
help='Do not include a bundle in the merge directive.'),
5185
Option('no-patch', help='Do not include a preview patch in the merge'
5188
help='Remember submit and public branch.'),
5190
help='Branch to generate the submission from, '
5191
'rather than the one containing the working directory.',
5194
Option('output', short_name='o', help='Write directive to this file.',
5197
help='Refuse to bundle revisions if there are uncommitted'
5198
' changes in the working tree, --no-strict disables the check.'),
5200
RegistryOption('format',
5201
help='Use the specified output format.',
5202
lazy_registry=('bzrlib.send', 'format_registry')),
5204
aliases = ['bundle']
5206
_see_also = ['send', 'merge']
5210
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5211
no_patch=False, revision=None, remember=False, output=None,
5212
format=None, strict=None, **kwargs):
5215
from bzrlib.send import send
5216
return send(submit_branch, revision, public_branch, remember,
5217
format, no_bundle, no_patch, output,
5218
kwargs.get('from', '.'), None, None, None,
5219
self.outf, strict=strict)
5222
class cmd_tag(Command):
5223
"""Create, remove or modify a tag naming a revision.
5225
Tags give human-meaningful names to revisions. Commands that take a -r
5226
(--revision) option can be given -rtag:X, where X is any previously
5229
Tags are stored in the branch. Tags are copied from one branch to another
5230
along when you branch, push, pull or merge.
5232
It is an error to give a tag name that already exists unless you pass
5233
--force, in which case the tag is moved to point to the new revision.
5235
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5236
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5239
_see_also = ['commit', 'tags']
5240
takes_args = ['tag_name']
5243
help='Delete this tag rather than placing it.',
5246
help='Branch in which to place the tag.',
5251
help='Replace existing tags.',
5256
def run(self, tag_name,
5262
branch, relpath = Branch.open_containing(directory)
5264
self.add_cleanup(branch.unlock)
5266
branch.tags.delete_tag(tag_name)
5267
self.outf.write('Deleted tag %s.\n' % tag_name)
5270
if len(revision) != 1:
5271
raise errors.BzrCommandError(
5272
"Tags can only be placed on a single revision, "
5274
revision_id = revision[0].as_revision_id(branch)
5276
revision_id = branch.last_revision()
5277
if (not force) and branch.tags.has_tag(tag_name):
5278
raise errors.TagAlreadyExists(tag_name)
5279
branch.tags.set_tag(tag_name, revision_id)
5280
self.outf.write('Created tag %s.\n' % tag_name)
5283
class cmd_tags(Command):
5286
This command shows a table of tag names and the revisions they reference.
5292
help='Branch whose tags should be displayed.',
5296
RegistryOption.from_kwargs('sort',
5297
'Sort tags by different criteria.', title='Sorting',
5298
alpha='Sort tags lexicographically (default).',
5299
time='Sort tags chronologically.',
5312
branch, relpath = Branch.open_containing(directory)
5314
tags = branch.tags.get_tag_dict().items()
5319
self.add_cleanup(branch.unlock)
5321
graph = branch.repository.get_graph()
5322
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5323
revid1, revid2 = rev1.rev_id, rev2.rev_id
5324
# only show revisions between revid1 and revid2 (inclusive)
5325
tags = [(tag, revid) for tag, revid in tags if
5326
graph.is_between(revid, revid1, revid2)]
5329
elif sort == 'time':
5331
for tag, revid in tags:
5333
revobj = branch.repository.get_revision(revid)
5334
except errors.NoSuchRevision:
5335
timestamp = sys.maxint # place them at the end
5337
timestamp = revobj.timestamp
5338
timestamps[revid] = timestamp
5339
tags.sort(key=lambda x: timestamps[x[1]])
5341
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5342
for index, (tag, revid) in enumerate(tags):
5344
revno = branch.revision_id_to_dotted_revno(revid)
5345
if isinstance(revno, tuple):
5346
revno = '.'.join(map(str, revno))
5347
except errors.NoSuchRevision:
5348
# Bad tag data/merges can lead to tagged revisions
5349
# which are not in this branch. Fail gracefully ...
5351
tags[index] = (tag, revno)
5353
for tag, revspec in tags:
5354
self.outf.write('%-20s %s\n' % (tag, revspec))
5357
class cmd_reconfigure(Command):
5358
"""Reconfigure the type of a bzr directory.
5360
A target configuration must be specified.
5362
For checkouts, the bind-to location will be auto-detected if not specified.
5363
The order of preference is
5364
1. For a lightweight checkout, the current bound location.
5365
2. For branches that used to be checkouts, the previously-bound location.
5366
3. The push location.
5367
4. The parent location.
5368
If none of these is available, --bind-to must be specified.
5371
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5372
takes_args = ['location?']
5374
RegistryOption.from_kwargs(
5376
title='Target type',
5377
help='The type to reconfigure the directory to.',
5378
value_switches=True, enum_switch=False,
5379
branch='Reconfigure to be an unbound branch with no working tree.',
5380
tree='Reconfigure to be an unbound branch with a working tree.',
5381
checkout='Reconfigure to be a bound branch with a working tree.',
5382
lightweight_checkout='Reconfigure to be a lightweight'
5383
' checkout (with no local history).',
5384
standalone='Reconfigure to be a standalone branch '
5385
'(i.e. stop using shared repository).',
5386
use_shared='Reconfigure to use a shared repository.',
5387
with_trees='Reconfigure repository to create '
5388
'working trees on branches by default.',
5389
with_no_trees='Reconfigure repository to not create '
5390
'working trees on branches by default.'
5392
Option('bind-to', help='Branch to bind checkout to.', type=str),
5394
help='Perform reconfiguration even if local changes'
5396
Option('stacked-on',
5397
help='Reconfigure a branch to be stacked on another branch.',
5401
help='Reconfigure a branch to be unstacked. This '
5402
'may require copying substantial data into it.',
5406
def run(self, location=None, target_type=None, bind_to=None, force=False,
5409
directory = bzrdir.BzrDir.open(location)
5410
if stacked_on and unstacked:
5411
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5412
elif stacked_on is not None:
5413
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5415
reconfigure.ReconfigureUnstacked().apply(directory)
5416
# At the moment you can use --stacked-on and a different
5417
# reconfiguration shape at the same time; there seems no good reason
5419
if target_type is None:
5420
if stacked_on or unstacked:
5423
raise errors.BzrCommandError('No target configuration '
5425
elif target_type == 'branch':
5426
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5427
elif target_type == 'tree':
5428
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5429
elif target_type == 'checkout':
5430
reconfiguration = reconfigure.Reconfigure.to_checkout(
5432
elif target_type == 'lightweight-checkout':
5433
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5435
elif target_type == 'use-shared':
5436
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5437
elif target_type == 'standalone':
5438
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5439
elif target_type == 'with-trees':
5440
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5442
elif target_type == 'with-no-trees':
5443
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5445
reconfiguration.apply(force)
5448
class cmd_switch(Command):
5449
"""Set the branch of a checkout and update.
5451
For lightweight checkouts, this changes the branch being referenced.
5452
For heavyweight checkouts, this checks that there are no local commits
5453
versus the current bound branch, then it makes the local branch a mirror
5454
of the new location and binds to it.
5456
In both cases, the working tree is updated and uncommitted changes
5457
are merged. The user can commit or revert these as they desire.
5459
Pending merges need to be committed or reverted before using switch.
5461
The path to the branch to switch to can be specified relative to the parent
5462
directory of the current branch. For example, if you are currently in a
5463
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5466
Bound branches use the nickname of its master branch unless it is set
5467
locally, in which case switching will update the local nickname to be
5471
takes_args = ['to_location?']
5472
takes_options = [Option('force',
5473
help='Switch even if local commits will be lost.'),
5475
Option('create-branch', short_name='b',
5476
help='Create the target branch from this one before'
5477
' switching to it.'),
5480
def run(self, to_location=None, force=False, create_branch=False,
5482
from bzrlib import switch
5484
revision = _get_one_revision('switch', revision)
5485
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5486
if to_location is None:
5487
if revision is None:
5488
raise errors.BzrCommandError('You must supply either a'
5489
' revision or a location')
5492
branch = control_dir.open_branch()
5493
had_explicit_nick = branch.get_config().has_explicit_nickname()
5494
except errors.NotBranchError:
5496
had_explicit_nick = False
5499
raise errors.BzrCommandError('cannot create branch without'
5501
to_location = directory_service.directories.dereference(
5503
if '/' not in to_location and '\\' not in to_location:
5504
# This path is meant to be relative to the existing branch
5505
this_url = self._get_branch_location(control_dir)
5506
to_location = urlutils.join(this_url, '..', to_location)
5507
to_branch = branch.bzrdir.sprout(to_location,
5508
possible_transports=[branch.bzrdir.root_transport],
5509
source_branch=branch).open_branch()
5512
to_branch = Branch.open(to_location)
5513
except errors.NotBranchError:
5514
this_url = self._get_branch_location(control_dir)
5515
to_branch = Branch.open(
5516
urlutils.join(this_url, '..', to_location))
5517
if revision is not None:
5518
revision = revision.as_revision_id(to_branch)
5519
switch.switch(control_dir, to_branch, force, revision_id=revision)
5520
if had_explicit_nick:
5521
branch = control_dir.open_branch() #get the new branch!
5522
branch.nick = to_branch.nick
5523
note('Switched to branch: %s',
5524
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5526
def _get_branch_location(self, control_dir):
5527
"""Return location of branch for this control dir."""
5529
this_branch = control_dir.open_branch()
5530
# This may be a heavy checkout, where we want the master branch
5531
master_location = this_branch.get_bound_location()
5532
if master_location is not None:
5533
return master_location
5534
# If not, use a local sibling
5535
return this_branch.base
5536
except errors.NotBranchError:
5537
format = control_dir.find_branch_format()
5538
if getattr(format, 'get_reference', None) is not None:
5539
return format.get_reference(control_dir)
5541
return control_dir.root_transport.base
5544
class cmd_view(Command):
5545
"""Manage filtered views.
5547
Views provide a mask over the tree so that users can focus on
5548
a subset of a tree when doing their work. After creating a view,
5549
commands that support a list of files - status, diff, commit, etc -
5550
effectively have that list of files implicitly given each time.
5551
An explicit list of files can still be given but those files
5552
must be within the current view.
5554
In most cases, a view has a short life-span: it is created to make
5555
a selected change and is deleted once that change is committed.
5556
At other times, you may wish to create one or more named views
5557
and switch between them.
5559
To disable the current view without deleting it, you can switch to
5560
the pseudo view called ``off``. This can be useful when you need
5561
to see the whole tree for an operation or two (e.g. merge) but
5562
want to switch back to your view after that.
5565
To define the current view::
5567
bzr view file1 dir1 ...
5569
To list the current view::
5573
To delete the current view::
5577
To disable the current view without deleting it::
5579
bzr view --switch off
5581
To define a named view and switch to it::
5583
bzr view --name view-name file1 dir1 ...
5585
To list a named view::
5587
bzr view --name view-name
5589
To delete a named view::
5591
bzr view --name view-name --delete
5593
To switch to a named view::
5595
bzr view --switch view-name
5597
To list all views defined::
5601
To delete all views::
5603
bzr view --delete --all
5607
takes_args = ['file*']
5610
help='Apply list or delete action to all views.',
5613
help='Delete the view.',
5616
help='Name of the view to define, list or delete.',
5620
help='Name of the view to switch to.',
5625
def run(self, file_list,
5631
tree, file_list = tree_files(file_list, apply_view=False)
5632
current_view, view_dict = tree.views.get_view_info()
5637
raise errors.BzrCommandError(
5638
"Both --delete and a file list specified")
5640
raise errors.BzrCommandError(
5641
"Both --delete and --switch specified")
5643
tree.views.set_view_info(None, {})
5644
self.outf.write("Deleted all views.\n")
5646
raise errors.BzrCommandError("No current view to delete")
5648
tree.views.delete_view(name)
5649
self.outf.write("Deleted '%s' view.\n" % name)
5652
raise errors.BzrCommandError(
5653
"Both --switch and a file list specified")
5655
raise errors.BzrCommandError(
5656
"Both --switch and --all specified")
5657
elif switch == 'off':
5658
if current_view is None:
5659
raise errors.BzrCommandError("No current view to disable")
5660
tree.views.set_view_info(None, view_dict)
5661
self.outf.write("Disabled '%s' view.\n" % (current_view))
5663
tree.views.set_view_info(switch, view_dict)
5664
view_str = views.view_display_str(tree.views.lookup_view())
5665
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5668
self.outf.write('Views defined:\n')
5669
for view in sorted(view_dict):
5670
if view == current_view:
5674
view_str = views.view_display_str(view_dict[view])
5675
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5677
self.outf.write('No views defined.\n')
5680
# No name given and no current view set
5683
raise errors.BzrCommandError(
5684
"Cannot change the 'off' pseudo view")
5685
tree.views.set_view(name, sorted(file_list))
5686
view_str = views.view_display_str(tree.views.lookup_view())
5687
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5691
# No name given and no current view set
5692
self.outf.write('No current view.\n')
5694
view_str = views.view_display_str(tree.views.lookup_view(name))
5695
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5698
class cmd_hooks(Command):
5704
for hook_key in sorted(hooks.known_hooks.keys()):
5705
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5706
self.outf.write("%s:\n" % type(some_hooks).__name__)
5707
for hook_name, hook_point in sorted(some_hooks.items()):
5708
self.outf.write(" %s:\n" % (hook_name,))
5709
found_hooks = list(hook_point)
5711
for hook in found_hooks:
5712
self.outf.write(" %s\n" %
5713
(some_hooks.get_hook_name(hook),))
5715
self.outf.write(" <no hooks installed>\n")
5718
class cmd_shelve(Command):
5719
"""Temporarily set aside some changes from the current tree.
5721
Shelve allows you to temporarily put changes you've made "on the shelf",
5722
ie. out of the way, until a later time when you can bring them back from
5723
the shelf with the 'unshelve' command. The changes are stored alongside
5724
your working tree, and so they aren't propagated along with your branch nor
5725
will they survive its deletion.
5727
If shelve --list is specified, previously-shelved changes are listed.
5729
Shelve is intended to help separate several sets of changes that have
5730
been inappropriately mingled. If you just want to get rid of all changes
5731
and you don't need to restore them later, use revert. If you want to
5732
shelve all text changes at once, use shelve --all.
5734
If filenames are specified, only the changes to those files will be
5735
shelved. Other files will be left untouched.
5737
If a revision is specified, changes since that revision will be shelved.
5739
You can put multiple items on the shelf, and by default, 'unshelve' will
5740
restore the most recently shelved changes.
5743
takes_args = ['file*']
5747
Option('all', help='Shelve all changes.'),
5749
RegistryOption('writer', 'Method to use for writing diffs.',
5750
bzrlib.option.diff_writer_registry,
5751
value_switches=True, enum_switch=False),
5753
Option('list', help='List shelved changes.'),
5755
help='Destroy removed changes instead of shelving them.'),
5757
_see_also = ['unshelve']
5759
def run(self, revision=None, all=False, file_list=None, message=None,
5760
writer=None, list=False, destroy=False):
5762
return self.run_for_list()
5763
from bzrlib.shelf_ui import Shelver
5765
writer = bzrlib.option.diff_writer_registry.get()
5767
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5768
file_list, message, destroy=destroy)
5773
except errors.UserAbort:
5776
def run_for_list(self):
5777
tree = WorkingTree.open_containing('.')[0]
5779
self.add_cleanup(tree.unlock)
5780
manager = tree.get_shelf_manager()
5781
shelves = manager.active_shelves()
5782
if len(shelves) == 0:
5783
note('No shelved changes.')
5785
for shelf_id in reversed(shelves):
5786
message = manager.get_metadata(shelf_id).get('message')
5788
message = '<no message>'
5789
self.outf.write('%3d: %s\n' % (shelf_id, message))
5793
class cmd_unshelve(Command):
5794
"""Restore shelved changes.
5796
By default, the most recently shelved changes are restored. However if you
5797
specify a shelf by id those changes will be restored instead. This works
5798
best when the changes don't depend on each other.
5801
takes_args = ['shelf_id?']
5803
RegistryOption.from_kwargs(
5804
'action', help="The action to perform.",
5805
enum_switch=False, value_switches=True,
5806
apply="Apply changes and remove from the shelf.",
5807
dry_run="Show changes, but do not apply or remove them.",
5808
preview="Instead of unshelving the changes, show the diff that "
5809
"would result from unshelving.",
5810
delete_only="Delete changes without applying them.",
5811
keep="Apply changes but don't delete them.",
5814
_see_also = ['shelve']
5816
def run(self, shelf_id=None, action='apply'):
5817
from bzrlib.shelf_ui import Unshelver
5818
unshelver = Unshelver.from_args(shelf_id, action)
5822
unshelver.tree.unlock()
5825
class cmd_clean_tree(Command):
5826
"""Remove unwanted files from working tree.
5828
By default, only unknown files, not ignored files, are deleted. Versioned
5829
files are never deleted.
5831
Another class is 'detritus', which includes files emitted by bzr during
5832
normal operations and selftests. (The value of these files decreases with
5835
If no options are specified, unknown files are deleted. Otherwise, option
5836
flags are respected, and may be combined.
5838
To check what clean-tree will do, use --dry-run.
5840
takes_options = [Option('ignored', help='Delete all ignored files.'),
5841
Option('detritus', help='Delete conflict files, merge'
5842
' backups, and failed selftest dirs.'),
5844
help='Delete files unknown to bzr (default).'),
5845
Option('dry-run', help='Show files to delete instead of'
5847
Option('force', help='Do not prompt before deleting.')]
5848
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5850
from bzrlib.clean_tree import clean_tree
5851
if not (unknown or ignored or detritus):
5855
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5856
dry_run=dry_run, no_prompt=force)
5859
class cmd_reference(Command):
5860
"""list, view and set branch locations for nested trees.
5862
If no arguments are provided, lists the branch locations for nested trees.
5863
If one argument is provided, display the branch location for that tree.
5864
If two arguments are provided, set the branch location for that tree.
5869
takes_args = ['path?', 'location?']
5871
def run(self, path=None, location=None):
5873
if path is not None:
5875
tree, branch, relpath =(
5876
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5877
if path is not None:
5880
tree = branch.basis_tree()
5882
info = branch._get_all_reference_info().iteritems()
5883
self._display_reference_info(tree, branch, info)
5885
file_id = tree.path2id(path)
5887
raise errors.NotVersionedError(path)
5888
if location is None:
5889
info = [(file_id, branch.get_reference_info(file_id))]
5890
self._display_reference_info(tree, branch, info)
5892
branch.set_reference_info(file_id, path, location)
5894
def _display_reference_info(self, tree, branch, info):
5896
for file_id, (path, location) in info:
5898
path = tree.id2path(file_id)
5899
except errors.NoSuchId:
5901
ref_list.append((path, location))
5902
for path, location in sorted(ref_list):
5903
self.outf.write('%s %s\n' % (path, location))
5906
# these get imported and then picked up by the scan for cmd_*
5907
# TODO: Some more consistent way to split command definitions across files;
5908
# we do need to load at least some information about them to know of
5909
# aliases. ideally we would avoid loading the implementation until the
5910
# details were needed.
5911
from bzrlib.cmd_version_info import cmd_version_info
5912
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5913
from bzrlib.bundle.commands import (
5916
from bzrlib.foreign import cmd_dpush
5917
from bzrlib.sign_my_commits import cmd_sign_my_commits
5918
from bzrlib.weave_commands import cmd_versionedfile_list, \
5919
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
