1
# Copyright (C) 2005-2011 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"""
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
37
config as _mod_config,
47
revision as _mod_revision,
56
from bzrlib.branch import Branch
57
from bzrlib.conflicts import ConflictList
58
from bzrlib.transport import memory
59
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
60
from bzrlib.smtp_connection import SMTPConnection
61
from bzrlib.workingtree import WorkingTree
62
from bzrlib.i18n import gettext, ngettext
65
from bzrlib.commands import (
67
builtin_command_registry,
70
from bzrlib.option import (
77
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
83
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
84
def tree_files(file_list, default_branch=u'.', canonicalize=True,
86
return internal_tree_files(file_list, default_branch, canonicalize,
90
def tree_files_for_add(file_list):
92
Return a tree and list of absolute paths from a file list.
94
Similar to tree_files, but add handles files a bit differently, so it a
95
custom implementation. In particular, MutableTreeTree.smart_add expects
96
absolute paths, which it immediately converts to relative paths.
98
# FIXME Would be nice to just return the relative paths like
99
# internal_tree_files does, but there are a large number of unit tests
100
# that assume the current interface to mutabletree.smart_add
102
tree, relpath = WorkingTree.open_containing(file_list[0])
103
if tree.supports_views():
104
view_files = tree.views.lookup_view()
106
for filename in file_list:
107
if not osutils.is_inside_any(view_files, filename):
108
raise errors.FileOutsideView(filename, view_files)
109
file_list = file_list[:]
110
file_list[0] = tree.abspath(relpath)
112
tree = WorkingTree.open_containing(u'.')[0]
113
if tree.supports_views():
114
view_files = tree.views.lookup_view()
116
file_list = view_files
117
view_str = views.view_display_str(view_files)
118
note(gettext("Ignoring files outside view. View is %s") % view_str)
119
return tree, file_list
122
def _get_one_revision(command_name, revisions):
123
if revisions is None:
125
if len(revisions) != 1:
126
raise errors.BzrCommandError(gettext(
127
'bzr %s --revision takes exactly one revision identifier') % (
132
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
133
"""Get a revision tree. Not suitable for commands that change the tree.
135
Specifically, the basis tree in dirstate trees is coupled to the dirstate
136
and doing a commit/uncommit/pull will at best fail due to changing the
139
If tree is passed in, it should be already locked, for lifetime management
140
of the trees internal cached state.
144
if revisions is None:
146
rev_tree = tree.basis_tree()
148
rev_tree = branch.basis_tree()
150
revision = _get_one_revision(command_name, revisions)
151
rev_tree = revision.as_tree(branch)
155
# XXX: Bad function name; should possibly also be a class method of
156
# WorkingTree rather than a function.
157
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
158
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
160
"""Convert command-line paths to a WorkingTree and relative paths.
162
Deprecated: use WorkingTree.open_containing_paths instead.
164
This is typically used for command-line processors that take one or
165
more filenames, and infer the workingtree that contains them.
167
The filenames given are not required to exist.
169
:param file_list: Filenames to convert.
171
:param default_branch: Fallback tree path to use if file_list is empty or
174
:param apply_view: if True and a view is set, apply it or check that
175
specified files are within it
177
:return: workingtree, [relative_paths]
179
return WorkingTree.open_containing_paths(
180
file_list, default_directory='.',
185
def _get_view_info_for_change_reporter(tree):
186
"""Get the view information from a tree for change reporting."""
189
current_view = tree.views.get_view_info()[0]
190
if current_view is not None:
191
view_info = (current_view, tree.views.lookup_view())
192
except errors.ViewsNotSupported:
197
def _open_directory_or_containing_tree_or_branch(filename, directory):
198
"""Open the tree or branch containing the specified file, unless
199
the --directory option is used to specify a different branch."""
200
if directory is not None:
201
return (None, Branch.open(directory), filename)
202
return controldir.ControlDir.open_containing_tree_or_branch(filename)
205
# TODO: Make sure no commands unconditionally use the working directory as a
206
# branch. If a filename argument is used, the first of them should be used to
207
# specify the branch. (Perhaps this can be factored out into some kind of
208
# Argument class, representing a file in a branch, where the first occurrence
211
class cmd_status(Command):
212
__doc__ = """Display status summary.
214
This reports on versioned and unknown files, reporting them
215
grouped by state. Possible states are:
218
Versioned in the working copy but not in the previous revision.
221
Versioned in the previous revision but removed or deleted
225
Path of this file changed from the previous revision;
226
the text may also have changed. This includes files whose
227
parent directory was renamed.
230
Text has changed since the previous revision.
233
File kind has been changed (e.g. from file to directory).
236
Not versioned and not matching an ignore pattern.
238
Additionally for directories, symlinks and files with a changed
239
executable bit, Bazaar indicates their type using a trailing
240
character: '/', '@' or '*' respectively. These decorations can be
241
disabled using the '--no-classify' option.
243
To see ignored files use 'bzr ignored'. For details on the
244
changes to file texts, use 'bzr diff'.
246
Note that --short or -S gives status flags for each item, similar
247
to Subversion's status command. To get output similar to svn -q,
250
If no arguments are specified, the status of the entire working
251
directory is shown. Otherwise, only the status of the specified
252
files or directories is reported. If a directory is given, status
253
is reported for everything inside that directory.
255
Before merges are committed, the pending merge tip revisions are
256
shown. To see all pending merge revisions, use the -v option.
257
To skip the display of pending merge information altogether, use
258
the no-pending option or specify a file/directory.
260
To compare the working directory to a specific revision, pass a
261
single revision to the revision argument.
263
To see which files have changed in a specific revision, or between
264
two revisions, pass a revision range to the revision argument.
265
This will produce the same results as calling 'bzr diff --summarize'.
268
# TODO: --no-recurse, --recurse options
270
takes_args = ['file*']
271
takes_options = ['show-ids', 'revision', 'change', 'verbose',
272
Option('short', help='Use short status indicators.',
274
Option('versioned', help='Only show versioned files.',
276
Option('no-pending', help='Don\'t show pending merges.',
278
Option('no-classify',
279
help='Do not mark object type using indicator.',
282
aliases = ['st', 'stat']
284
encoding_type = 'replace'
285
_see_also = ['diff', 'revert', 'status-flags']
288
def run(self, show_ids=False, file_list=None, revision=None, short=False,
289
versioned=False, no_pending=False, verbose=False,
291
from bzrlib.status import show_tree_status
293
if revision and len(revision) > 2:
294
raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
295
' one or two revision specifiers'))
297
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
298
# Avoid asking for specific files when that is not needed.
299
if relfile_list == ['']:
301
# Don't disable pending merges for full trees other than '.'.
302
if file_list == ['.']:
304
# A specific path within a tree was given.
305
elif relfile_list is not None:
307
show_tree_status(tree, show_ids=show_ids,
308
specific_files=relfile_list, revision=revision,
309
to_file=self.outf, short=short, versioned=versioned,
310
show_pending=(not no_pending), verbose=verbose,
311
classify=not no_classify)
314
class cmd_cat_revision(Command):
315
__doc__ = """Write out metadata for a revision.
317
The revision to print can either be specified by a specific
318
revision identifier, or you can use --revision.
322
takes_args = ['revision_id?']
323
takes_options = ['directory', 'revision']
324
# cat-revision is more for frontends so should be exact
327
def print_revision(self, revisions, revid):
328
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
329
record = stream.next()
330
if record.storage_kind == 'absent':
331
raise errors.NoSuchRevision(revisions, revid)
332
revtext = record.get_bytes_as('fulltext')
333
self.outf.write(revtext.decode('utf-8'))
336
def run(self, revision_id=None, revision=None, directory=u'.'):
337
if revision_id is not None and revision is not None:
338
raise errors.BzrCommandError(gettext('You can only supply one of'
339
' revision_id or --revision'))
340
if revision_id is None and revision is None:
341
raise errors.BzrCommandError(gettext('You must supply either'
342
' --revision or a revision_id'))
344
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
346
revisions = b.repository.revisions
347
if revisions is None:
348
raise errors.BzrCommandError(gettext('Repository %r does not support '
349
'access to raw revision texts'))
351
b.repository.lock_read()
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.print_revision(revisions, revision_id)
358
except errors.NoSuchRevision:
359
msg = gettext("The repository {0} contains no revision {1}.").format(
360
b.repository.base, revision_id)
361
raise errors.BzrCommandError(msg)
362
elif revision is not None:
365
raise errors.BzrCommandError(
366
gettext('You cannot specify a NULL revision.'))
367
rev_id = rev.as_revision_id(b)
368
self.print_revision(revisions, rev_id)
370
b.repository.unlock()
373
class cmd_dump_btree(Command):
374
__doc__ = """Dump the contents of a btree index file to stdout.
376
PATH is a btree index file, it can be any URL. This includes things like
377
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
379
By default, the tuples stored in the index file will be displayed. With
380
--raw, we will uncompress the pages, but otherwise display the raw bytes
384
# TODO: Do we want to dump the internal nodes as well?
385
# TODO: It would be nice to be able to dump the un-parsed information,
386
# rather than only going through iter_all_entries. However, this is
387
# good enough for a start
389
encoding_type = 'exact'
390
takes_args = ['path']
391
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
392
' rather than the parsed tuples.'),
395
def run(self, path, raw=False):
396
dirname, basename = osutils.split(path)
397
t = transport.get_transport(dirname)
399
self._dump_raw_bytes(t, basename)
401
self._dump_entries(t, basename)
403
def _get_index_and_bytes(self, trans, basename):
404
"""Create a BTreeGraphIndex and raw bytes."""
405
bt = btree_index.BTreeGraphIndex(trans, basename, None)
406
bytes = trans.get_bytes(basename)
407
bt._file = cStringIO.StringIO(bytes)
408
bt._size = len(bytes)
411
def _dump_raw_bytes(self, trans, basename):
414
# We need to parse at least the root node.
415
# This is because the first page of every row starts with an
416
# uncompressed header.
417
bt, bytes = self._get_index_and_bytes(trans, basename)
418
for page_idx, page_start in enumerate(xrange(0, len(bytes),
419
btree_index._PAGE_SIZE)):
420
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
421
page_bytes = bytes[page_start:page_end]
423
self.outf.write('Root node:\n')
424
header_end, data = bt._parse_header_from_bytes(page_bytes)
425
self.outf.write(page_bytes[:header_end])
427
self.outf.write('\nPage %d\n' % (page_idx,))
428
if len(page_bytes) == 0:
429
self.outf.write('(empty)\n');
431
decomp_bytes = zlib.decompress(page_bytes)
432
self.outf.write(decomp_bytes)
433
self.outf.write('\n')
435
def _dump_entries(self, trans, basename):
437
st = trans.stat(basename)
438
except errors.TransportNotPossible:
439
# We can't stat, so we'll fake it because we have to do the 'get()'
441
bt, _ = self._get_index_and_bytes(trans, basename)
443
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
444
for node in bt.iter_all_entries():
445
# Node is made up of:
446
# (index, key, value, [references])
450
refs_as_tuples = None
452
refs_as_tuples = static_tuple.as_tuples(refs)
453
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
454
self.outf.write('%s\n' % (as_tuple,))
457
class cmd_remove_tree(Command):
458
__doc__ = """Remove the working tree from a given branch/checkout.
460
Since a lightweight checkout is little more than a working tree
461
this will refuse to run against one.
463
To re-create the working tree, use "bzr checkout".
465
_see_also = ['checkout', 'working-trees']
466
takes_args = ['location*']
469
help='Remove the working tree even if it has '
470
'uncommitted or shelved changes.'),
473
def run(self, location_list, force=False):
474
if not location_list:
477
for location in location_list:
478
d = controldir.ControlDir.open(location)
481
working = d.open_workingtree()
482
except errors.NoWorkingTree:
483
raise errors.BzrCommandError(gettext("No working tree to remove"))
484
except errors.NotLocalUrl:
485
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
486
" of a remote path"))
488
if (working.has_changes()):
489
raise errors.UncommittedChanges(working)
490
if working.get_shelf_manager().last_shelf() is not None:
491
raise errors.ShelvedChanges(working)
493
if working.user_url != working.branch.user_url:
494
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
495
" from a lightweight checkout"))
497
d.destroy_workingtree()
500
class cmd_repair_workingtree(Command):
501
__doc__ = """Reset the working tree state file.
503
This is not meant to be used normally, but more as a way to recover from
504
filesystem corruption, etc. This rebuilds the working inventory back to a
505
'known good' state. Any new modifications (adding a file, renaming, etc)
506
will be lost, though modified files will still be detected as such.
508
Most users will want something more like "bzr revert" or "bzr update"
509
unless the state file has become corrupted.
511
By default this attempts to recover the current state by looking at the
512
headers of the state file. If the state file is too corrupted to even do
513
that, you can supply --revision to force the state of the tree.
516
takes_options = ['revision', 'directory',
518
help='Reset the tree even if it doesn\'t appear to be'
523
def run(self, revision=None, directory='.', force=False):
524
tree, _ = WorkingTree.open_containing(directory)
525
self.add_cleanup(tree.lock_tree_write().unlock)
529
except errors.BzrError:
530
pass # There seems to be a real error here, so we'll reset
533
raise errors.BzrCommandError(gettext(
534
'The tree does not appear to be corrupt. You probably'
535
' want "bzr revert" instead. Use "--force" if you are'
536
' sure you want to reset the working tree.'))
540
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
542
tree.reset_state(revision_ids)
543
except errors.BzrError, e:
544
if revision_ids is None:
545
extra = (gettext(', the header appears corrupt, try passing -r -1'
546
' to set the state to the last commit'))
549
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
552
class cmd_revno(Command):
553
__doc__ = """Show current revision number.
555
This is equal to the number of revisions on this branch.
559
takes_args = ['location?']
561
Option('tree', help='Show revno of working tree.'),
566
def run(self, tree=False, location=u'.', revision=None):
567
if revision is not None and tree:
568
raise errors.BzrCommandError(gettext("--tree and --revision can "
569
"not be used together"))
573
wt = WorkingTree.open_containing(location)[0]
574
self.add_cleanup(wt.lock_read().unlock)
575
except (errors.NoWorkingTree, errors.NotLocalUrl):
576
raise errors.NoWorkingTree(location)
578
revid = wt.last_revision()
580
b = Branch.open_containing(location)[0]
581
self.add_cleanup(b.lock_read().unlock)
583
if len(revision) != 1:
584
raise errors.BzrCommandError(gettext(
585
"Tags can only be placed on a single revision, "
587
revid = revision[0].as_revision_id(b)
589
revid = b.last_revision()
591
revno_t = b.revision_id_to_dotted_revno(revid)
592
except errors.NoSuchRevision:
594
revno = ".".join(str(n) for n in revno_t)
596
self.outf.write(revno + '\n')
599
class cmd_revision_info(Command):
600
__doc__ = """Show revision number and revision id for a given revision identifier.
603
takes_args = ['revision_info*']
606
custom_help('directory',
607
help='Branch to examine, '
608
'rather than the one containing the working directory.'),
609
Option('tree', help='Show revno of working tree.'),
613
def run(self, revision=None, directory=u'.', tree=False,
614
revision_info_list=[]):
617
wt = WorkingTree.open_containing(directory)[0]
619
self.add_cleanup(wt.lock_read().unlock)
620
except (errors.NoWorkingTree, errors.NotLocalUrl):
622
b = Branch.open_containing(directory)[0]
623
self.add_cleanup(b.lock_read().unlock)
625
if revision is not None:
626
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
627
if revision_info_list is not None:
628
for rev_str in revision_info_list:
629
rev_spec = RevisionSpec.from_string(rev_str)
630
revision_ids.append(rev_spec.as_revision_id(b))
631
# No arguments supplied, default to the last revision
632
if len(revision_ids) == 0:
635
raise errors.NoWorkingTree(directory)
636
revision_ids.append(wt.last_revision())
638
revision_ids.append(b.last_revision())
642
for revision_id in revision_ids:
644
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
645
revno = '.'.join(str(i) for i in dotted_revno)
646
except errors.NoSuchRevision:
648
maxlen = max(maxlen, len(revno))
649
revinfos.append([revno, revision_id])
653
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
656
class cmd_add(Command):
657
__doc__ = """Add specified files or directories.
659
In non-recursive mode, all the named items are added, regardless
660
of whether they were previously ignored. A warning is given if
661
any of the named files are already versioned.
663
In recursive mode (the default), files are treated the same way
664
but the behaviour for directories is different. Directories that
665
are already versioned do not give a warning. All directories,
666
whether already versioned or not, are searched for files or
667
subdirectories that are neither versioned or ignored, and these
668
are added. This search proceeds recursively into versioned
669
directories. If no names are given '.' is assumed.
671
A warning will be printed when nested trees are encountered,
672
unless they are explicitly ignored.
674
Therefore simply saying 'bzr add' will version all files that
675
are currently unknown.
677
Adding a file whose parent directory is not versioned will
678
implicitly add the parent, and so on up to the root. This means
679
you should never need to explicitly add a directory, they'll just
680
get added when you add a file in the directory.
682
--dry-run will show which files would be added, but not actually
685
--file-ids-from will try to use the file ids from the supplied path.
686
It looks up ids trying to find a matching parent directory with the
687
same filename, and then by pure path. This option is rarely needed
688
but can be useful when adding the same logical file into two
689
branches that will be merged later (without showing the two different
690
adds as a conflict). It is also useful when merging another project
691
into a subdirectory of this one.
693
Any files matching patterns in the ignore list will not be added
694
unless they are explicitly mentioned.
696
In recursive mode, files larger than the configuration option
697
add.maximum_file_size will be skipped. Named items are never skipped due
700
takes_args = ['file*']
703
help="Don't recursively add the contents of directories."),
705
help="Show what would be done, but don't actually do anything."),
707
Option('file-ids-from',
709
help='Lookup file ids from this tree.'),
711
encoding_type = 'replace'
712
_see_also = ['remove', 'ignore']
714
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
719
if file_ids_from is not None:
721
base_tree, base_path = WorkingTree.open_containing(
723
except errors.NoWorkingTree:
724
base_branch, base_path = Branch.open_containing(
726
base_tree = base_branch.basis_tree()
728
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
729
to_file=self.outf, should_print=(not is_quiet()))
731
action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
732
should_print=(not is_quiet()))
735
self.add_cleanup(base_tree.lock_read().unlock)
736
tree, file_list = tree_files_for_add(file_list)
737
added, ignored = tree.smart_add(file_list, not
738
no_recurse, action=action, save=not dry_run)
742
for glob in sorted(ignored.keys()):
743
for path in ignored[glob]:
745
gettext("ignored {0} matching \"{1}\"\n").format(
749
class cmd_mkdir(Command):
750
__doc__ = """Create a new versioned directory.
752
This is equivalent to creating the directory and then adding it.
755
takes_args = ['dir+']
756
encoding_type = 'replace'
758
def run(self, dir_list):
760
wt, dd = WorkingTree.open_containing(d)
761
base = os.path.dirname(dd)
762
id = wt.path2id(base)
767
self.outf.write(gettext('added %s\n') % d)
769
raise errors.NotVersionedError(path=base)
772
class cmd_relpath(Command):
773
__doc__ = """Show path of a file relative to root"""
775
takes_args = ['filename']
779
def run(self, filename):
780
# TODO: jam 20050106 Can relpath return a munged path if
781
# sys.stdout encoding cannot represent it?
782
tree, relpath = WorkingTree.open_containing(filename)
783
self.outf.write(relpath)
784
self.outf.write('\n')
787
class cmd_inventory(Command):
788
__doc__ = """Show inventory of the current working copy or a revision.
790
It is possible to limit the output to a particular entry
791
type using the --kind option. For example: --kind file.
793
It is also possible to restrict the list of files to a specific
794
set. For example: bzr inventory --show-ids this/file
803
help='List entries of a particular kind: file, directory, symlink.',
806
takes_args = ['file*']
809
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
810
if kind and kind not in ['file', 'directory', 'symlink']:
811
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
813
revision = _get_one_revision('inventory', revision)
814
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
815
self.add_cleanup(work_tree.lock_read().unlock)
816
if revision is not None:
817
tree = revision.as_tree(work_tree.branch)
819
extra_trees = [work_tree]
820
self.add_cleanup(tree.lock_read().unlock)
825
if file_list is not None:
826
file_ids = tree.paths2ids(file_list, trees=extra_trees,
827
require_versioned=True)
828
# find_ids_across_trees may include some paths that don't
831
(tree.id2path(file_id), tree.inventory[file_id])
832
for file_id in file_ids if tree.has_id(file_id))
834
entries = tree.inventory.entries()
837
for path, entry in entries:
838
if kind and kind != entry.kind:
841
self.outf.write('%-50s %s\n' % (path, entry.file_id))
843
self.outf.write(path)
844
self.outf.write('\n')
847
class cmd_mv(Command):
848
__doc__ = """Move or rename a file.
851
bzr mv OLDNAME NEWNAME
853
bzr mv SOURCE... DESTINATION
855
If the last argument is a versioned directory, all the other names
856
are moved into it. Otherwise, there must be exactly two arguments
857
and the file is changed to a new name.
859
If OLDNAME does not exist on the filesystem but is versioned and
860
NEWNAME does exist on the filesystem but is not versioned, mv
861
assumes that the file has been manually moved and only updates
862
its internal inventory to reflect that change.
863
The same is valid when moving many SOURCE files to a DESTINATION.
865
Files cannot be moved between branches.
868
takes_args = ['names*']
869
takes_options = [Option("after", help="Move only the bzr identifier"
870
" of the file, because the file has already been moved."),
871
Option('auto', help='Automatically guess renames.'),
872
Option('dry-run', help='Avoid making changes when guessing renames.'),
874
aliases = ['move', 'rename']
875
encoding_type = 'replace'
877
def run(self, names_list, after=False, auto=False, dry_run=False):
879
return self.run_auto(names_list, after, dry_run)
881
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
882
if names_list is None:
884
if len(names_list) < 2:
885
raise errors.BzrCommandError(gettext("missing file argument"))
886
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
887
for file_name in rel_names[0:-1]:
889
raise errors.BzrCommandError(gettext("can not move root of branch"))
890
self.add_cleanup(tree.lock_tree_write().unlock)
891
self._run(tree, names_list, rel_names, after)
893
def run_auto(self, names_list, after, dry_run):
894
if names_list is not None and len(names_list) > 1:
895
raise errors.BzrCommandError(gettext('Only one path may be specified to'
898
raise errors.BzrCommandError(gettext('--after cannot be specified with'
900
work_tree, file_list = WorkingTree.open_containing_paths(
901
names_list, default_directory='.')
902
self.add_cleanup(work_tree.lock_tree_write().unlock)
903
rename_map.RenameMap.guess_renames(work_tree, dry_run)
905
def _run(self, tree, names_list, rel_names, after):
906
into_existing = osutils.isdir(names_list[-1])
907
if into_existing and len(names_list) == 2:
909
# a. case-insensitive filesystem and change case of dir
910
# b. move directory after the fact (if the source used to be
911
# a directory, but now doesn't exist in the working tree
912
# and the target is an existing directory, just rename it)
913
if (not tree.case_sensitive
914
and rel_names[0].lower() == rel_names[1].lower()):
915
into_existing = False
918
# 'fix' the case of a potential 'from'
919
from_id = tree.path2id(
920
tree.get_canonical_inventory_path(rel_names[0]))
921
if (not osutils.lexists(names_list[0]) and
922
from_id and inv.get_file_kind(from_id) == "directory"):
923
into_existing = False
926
# move into existing directory
927
# All entries reference existing inventory items, so fix them up
928
# for cicp file-systems.
929
rel_names = tree.get_canonical_inventory_paths(rel_names)
930
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
932
self.outf.write("%s => %s\n" % (src, dest))
934
if len(names_list) != 2:
935
raise errors.BzrCommandError(gettext('to mv multiple files the'
936
' destination must be a versioned'
939
# for cicp file-systems: the src references an existing inventory
941
src = tree.get_canonical_inventory_path(rel_names[0])
942
# Find the canonical version of the destination: In all cases, the
943
# parent of the target must be in the inventory, so we fetch the
944
# canonical version from there (we do not always *use* the
945
# canonicalized tail portion - we may be attempting to rename the
947
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
948
dest_parent = osutils.dirname(canon_dest)
949
spec_tail = osutils.basename(rel_names[1])
950
# For a CICP file-system, we need to avoid creating 2 inventory
951
# entries that differ only by case. So regardless of the case
952
# we *want* to use (ie, specified by the user or the file-system),
953
# we must always choose to use the case of any existing inventory
954
# items. The only exception to this is when we are attempting a
955
# case-only rename (ie, canonical versions of src and dest are
957
dest_id = tree.path2id(canon_dest)
958
if dest_id is None or tree.path2id(src) == dest_id:
959
# No existing item we care about, so work out what case we
960
# are actually going to use.
962
# If 'after' is specified, the tail must refer to a file on disk.
964
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
966
# pathjoin with an empty tail adds a slash, which breaks
968
dest_parent_fq = tree.basedir
970
dest_tail = osutils.canonical_relpath(
972
osutils.pathjoin(dest_parent_fq, spec_tail))
974
# not 'after', so case as specified is used
975
dest_tail = spec_tail
977
# Use the existing item so 'mv' fails with AlreadyVersioned.
978
dest_tail = os.path.basename(canon_dest)
979
dest = osutils.pathjoin(dest_parent, dest_tail)
980
mutter("attempting to move %s => %s", src, dest)
981
tree.rename_one(src, dest, after=after)
983
self.outf.write("%s => %s\n" % (src, dest))
986
class cmd_pull(Command):
987
__doc__ = """Turn this branch into a mirror of another branch.
989
By default, this command only works on branches that have not diverged.
990
Branches are considered diverged if the destination branch's most recent
991
commit is one that has not been merged (directly or indirectly) into the
994
If branches have diverged, you can use 'bzr merge' to integrate the changes
995
from one into the other. Once one branch has merged, the other should
996
be able to pull it again.
998
If you want to replace your local changes and just want your branch to
999
match the remote one, use pull --overwrite. This will work even if the two
1000
branches have diverged.
1002
If there is no default location set, the first pull will set it (use
1003
--no-remember to avoid setting it). After that, you can omit the
1004
location to use the default. To change the default, use --remember. The
1005
value will only be saved if the remote location can be accessed.
1007
The --verbose option will display the revisions pulled using the log_format
1008
configuration option. You can use a different format by overriding it with
1009
-Olog_format=<other_format>.
1011
Note: The location can be specified either in the form of a branch,
1012
or in the form of a path to a file containing a merge directive generated
1016
_see_also = ['push', 'update', 'status-flags', 'send']
1017
takes_options = ['remember', 'overwrite', 'revision',
1018
custom_help('verbose',
1019
help='Show logs of pulled revisions.'),
1020
custom_help('directory',
1021
help='Branch to pull into, '
1022
'rather than the one containing the working directory.'),
1024
help="Perform a local pull in a bound "
1025
"branch. Local pulls are not applied to "
1026
"the master branch."
1029
help="Show base revision text in conflicts.")
1031
takes_args = ['location?']
1032
encoding_type = 'replace'
1034
def run(self, location=None, remember=None, overwrite=False,
1035
revision=None, verbose=False,
1036
directory=None, local=False,
1038
# FIXME: too much stuff is in the command class
1041
if directory is None:
1044
tree_to = WorkingTree.open_containing(directory)[0]
1045
branch_to = tree_to.branch
1046
self.add_cleanup(tree_to.lock_write().unlock)
1047
except errors.NoWorkingTree:
1049
branch_to = Branch.open_containing(directory)[0]
1050
self.add_cleanup(branch_to.lock_write().unlock)
1052
if tree_to is None and show_base:
1053
raise errors.BzrCommandError(gettext("Need working tree for --show-base."))
1055
if local and not branch_to.get_bound_location():
1056
raise errors.LocalRequiresBoundBranch()
1058
possible_transports = []
1059
if location is not None:
1061
mergeable = bundle.read_mergeable_from_url(location,
1062
possible_transports=possible_transports)
1063
except errors.NotABundle:
1066
stored_loc = branch_to.get_parent()
1067
if location is None:
1068
if stored_loc is None:
1069
raise errors.BzrCommandError(gettext("No pull location known or"
1072
display_url = urlutils.unescape_for_display(stored_loc,
1075
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1076
location = stored_loc
1078
revision = _get_one_revision('pull', revision)
1079
if mergeable is not None:
1080
if revision is not None:
1081
raise errors.BzrCommandError(gettext(
1082
'Cannot use -r with merge directives or bundles'))
1083
mergeable.install_revisions(branch_to.repository)
1084
base_revision_id, revision_id, verified = \
1085
mergeable.get_merge_request(branch_to.repository)
1086
branch_from = branch_to
1088
branch_from = Branch.open(location,
1089
possible_transports=possible_transports)
1090
self.add_cleanup(branch_from.lock_read().unlock)
1091
# Remembers if asked explicitly or no previous location is set
1093
or (remember is None and branch_to.get_parent() is None)):
1094
branch_to.set_parent(branch_from.base)
1096
if revision is not None:
1097
revision_id = revision.as_revision_id(branch_from)
1099
if tree_to is not None:
1100
view_info = _get_view_info_for_change_reporter(tree_to)
1101
change_reporter = delta._ChangeReporter(
1102
unversioned_filter=tree_to.is_ignored,
1103
view_info=view_info)
1104
result = tree_to.pull(
1105
branch_from, overwrite, revision_id, change_reporter,
1106
local=local, show_base=show_base)
1108
result = branch_to.pull(
1109
branch_from, overwrite, revision_id, local=local)
1111
result.report(self.outf)
1112
if verbose and result.old_revid != result.new_revid:
1113
log.show_branch_change(
1114
branch_to, self.outf, result.old_revno,
1116
if getattr(result, 'tag_conflicts', None):
1122
class cmd_push(Command):
1123
__doc__ = """Update a mirror of this branch.
1125
The target branch will not have its working tree populated because this
1126
is both expensive, and is not supported on remote file systems.
1128
Some smart servers or protocols *may* put the working tree in place in
1131
This command only works on branches that have not diverged. Branches are
1132
considered diverged if the destination branch's most recent commit is one
1133
that has not been merged (directly or indirectly) by the source branch.
1135
If branches have diverged, you can use 'bzr push --overwrite' to replace
1136
the other branch completely, discarding its unmerged changes.
1138
If you want to ensure you have the different changes in the other branch,
1139
do a merge (see bzr help merge) from the other branch, and commit that.
1140
After that you will be able to do a push without '--overwrite'.
1142
If there is no default push location set, the first push will set it (use
1143
--no-remember to avoid setting it). After that, you can omit the
1144
location to use the default. To change the default, use --remember. The
1145
value will only be saved if the remote location can be accessed.
1147
The --verbose option will display the revisions pushed using the log_format
1148
configuration option. You can use a different format by overriding it with
1149
-Olog_format=<other_format>.
1152
_see_also = ['pull', 'update', 'working-trees']
1153
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1154
Option('create-prefix',
1155
help='Create the path leading up to the branch '
1156
'if it does not already exist.'),
1157
custom_help('directory',
1158
help='Branch to push from, '
1159
'rather than the one containing the working directory.'),
1160
Option('use-existing-dir',
1161
help='By default push will fail if the target'
1162
' directory exists, but does not already'
1163
' have a control directory. This flag will'
1164
' allow push to proceed.'),
1166
help='Create a stacked branch that references the public location '
1167
'of the parent branch.'),
1168
Option('stacked-on',
1169
help='Create a stacked branch that refers to another branch '
1170
'for the commit history. Only the work not present in the '
1171
'referenced branch is included in the branch created.',
1174
help='Refuse to push if there are uncommitted changes in'
1175
' the working tree, --no-strict disables the check.'),
1177
help="Don't populate the working tree, even for protocols"
1178
" that support it."),
1180
takes_args = ['location?']
1181
encoding_type = 'replace'
1183
def run(self, location=None, remember=None, overwrite=False,
1184
create_prefix=False, verbose=False, revision=None,
1185
use_existing_dir=False, directory=None, stacked_on=None,
1186
stacked=False, strict=None, no_tree=False):
1187
from bzrlib.push import _show_push_branch
1189
if directory is None:
1191
# Get the source branch
1193
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1194
# Get the tip's revision_id
1195
revision = _get_one_revision('push', revision)
1196
if revision is not None:
1197
revision_id = revision.in_history(br_from).rev_id
1200
if tree is not None and revision_id is None:
1201
tree.check_changed_or_out_of_date(
1202
strict, 'push_strict',
1203
more_error='Use --no-strict to force the push.',
1204
more_warning='Uncommitted changes will not be pushed.')
1205
# Get the stacked_on branch, if any
1206
if stacked_on is not None:
1207
stacked_on = urlutils.normalize_url(stacked_on)
1209
parent_url = br_from.get_parent()
1211
parent = Branch.open(parent_url)
1212
stacked_on = parent.get_public_branch()
1214
# I considered excluding non-http url's here, thus forcing
1215
# 'public' branches only, but that only works for some
1216
# users, so it's best to just depend on the user spotting an
1217
# error by the feedback given to them. RBC 20080227.
1218
stacked_on = parent_url
1220
raise errors.BzrCommandError(gettext(
1221
"Could not determine branch to refer to."))
1223
# Get the destination location
1224
if location is None:
1225
stored_loc = br_from.get_push_location()
1226
if stored_loc is None:
1227
raise errors.BzrCommandError(gettext(
1228
"No push location known or specified."))
1230
display_url = urlutils.unescape_for_display(stored_loc,
1232
note(gettext("Using saved push location: %s") % display_url)
1233
location = stored_loc
1235
_show_push_branch(br_from, revision_id, location, self.outf,
1236
verbose=verbose, overwrite=overwrite, remember=remember,
1237
stacked_on=stacked_on, create_prefix=create_prefix,
1238
use_existing_dir=use_existing_dir, no_tree=no_tree)
1241
class cmd_branch(Command):
1242
__doc__ = """Create a new branch that is a copy of an existing branch.
1244
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1245
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1246
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1247
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1248
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1251
To retrieve the branch as of a particular revision, supply the --revision
1252
parameter, as in "branch foo/bar -r 5".
1254
The synonyms 'clone' and 'get' for this command are deprecated.
1257
_see_also = ['checkout']
1258
takes_args = ['from_location', 'to_location?']
1259
takes_options = ['revision',
1260
Option('hardlink', help='Hard-link working tree files where possible.'),
1261
Option('files-from', type=str,
1262
help="Get file contents from this tree."),
1264
help="Create a branch without a working-tree."),
1266
help="Switch the checkout in the current directory "
1267
"to the new branch."),
1269
help='Create a stacked branch referring to the source branch. '
1270
'The new branch will depend on the availability of the source '
1271
'branch for all operations.'),
1272
Option('standalone',
1273
help='Do not use a shared repository, even if available.'),
1274
Option('use-existing-dir',
1275
help='By default branch will fail if the target'
1276
' directory exists, but does not already'
1277
' have a control directory. This flag will'
1278
' allow branch to proceed.'),
1280
help="Bind new branch to from location."),
1282
aliases = ['get', 'clone']
1284
def run(self, from_location, to_location=None, revision=None,
1285
hardlink=False, stacked=False, standalone=False, no_tree=False,
1286
use_existing_dir=False, switch=False, bind=False,
1288
from bzrlib import switch as _mod_switch
1289
from bzrlib.tag import _merge_tags_if_possible
1290
if self.invoked_as in ['get', 'clone']:
1291
ui.ui_factory.show_user_warning(
1292
'deprecated_command',
1293
deprecated_name=self.invoked_as,
1294
recommended_name='branch',
1295
deprecated_in_version='2.4')
1296
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1298
if not (hardlink or files_from):
1299
# accelerator_tree is usually slower because you have to read N
1300
# files (no readahead, lots of seeks, etc), but allow the user to
1301
# explicitly request it
1302
accelerator_tree = None
1303
if files_from is not None and files_from != from_location:
1304
accelerator_tree = WorkingTree.open(files_from)
1305
revision = _get_one_revision('branch', revision)
1306
self.add_cleanup(br_from.lock_read().unlock)
1307
if revision is not None:
1308
revision_id = revision.as_revision_id(br_from)
1310
# FIXME - wt.last_revision, fallback to branch, fall back to
1311
# None or perhaps NULL_REVISION to mean copy nothing
1313
revision_id = br_from.last_revision()
1314
if to_location is None:
1315
to_location = getattr(br_from, "name", None)
1316
if to_location is None:
1317
to_location = urlutils.derive_to_location(from_location)
1318
to_transport = transport.get_transport(to_location)
1320
to_transport.mkdir('.')
1321
except errors.FileExists:
1323
to_dir = controldir.ControlDir.open_from_transport(
1325
except errors.NotBranchError:
1326
if not use_existing_dir:
1327
raise errors.BzrCommandError(gettext('Target directory "%s" '
1328
'already exists.') % to_location)
1333
to_dir.open_branch()
1334
except errors.NotBranchError:
1337
raise errors.AlreadyBranchError(to_location)
1338
except errors.NoSuchFile:
1339
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1345
# preserve whatever source format we have.
1346
to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1347
possible_transports=[to_transport],
1348
accelerator_tree=accelerator_tree,
1349
hardlink=hardlink, stacked=stacked,
1350
force_new_repo=standalone,
1351
create_tree_if_local=not no_tree,
1352
source_branch=br_from)
1353
branch = to_dir.open_branch(
1354
possible_transports=[
1355
br_from.bzrdir.root_transport, to_transport])
1356
except errors.NoSuchRevision:
1357
to_transport.delete_tree('.')
1358
msg = gettext("The branch {0} has no revision {1}.").format(
1359
from_location, revision)
1360
raise errors.BzrCommandError(msg)
1362
branch = br_from.sprout(to_dir, revision_id=revision_id)
1363
_merge_tags_if_possible(br_from, branch)
1364
# If the source branch is stacked, the new branch may
1365
# be stacked whether we asked for that explicitly or not.
1366
# We therefore need a try/except here and not just 'if stacked:'
1368
note(gettext('Created new stacked branch referring to %s.') %
1369
branch.get_stacked_on_url())
1370
except (errors.NotStacked, errors.UnstackableBranchFormat,
1371
errors.UnstackableRepositoryFormat), e:
1372
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1374
# Bind to the parent
1375
parent_branch = Branch.open(from_location)
1376
branch.bind(parent_branch)
1377
note(gettext('New branch bound to %s') % from_location)
1379
# Switch to the new branch
1380
wt, _ = WorkingTree.open_containing('.')
1381
_mod_switch.switch(wt.bzrdir, branch)
1382
note(gettext('Switched to branch: %s'),
1383
urlutils.unescape_for_display(branch.base, 'utf-8'))
1386
class cmd_branches(Command):
1387
__doc__ = """List the branches available at the current location.
1389
This command will print the names of all the branches at the current
1393
takes_args = ['location?']
1395
Option('recursive', short_name='R',
1396
help='Recursively scan for branches rather than '
1397
'just looking in the specified location.')]
1399
def run(self, location=".", recursive=False):
1401
t = transport.get_transport(location)
1402
if not t.listable():
1403
raise errors.BzrCommandError(
1404
"Can't scan this type of location.")
1405
for b in controldir.ControlDir.find_branches(t):
1406
self.outf.write("%s\n" % urlutils.unescape_for_display(
1407
urlutils.relative_url(t.base, b.base),
1408
self.outf.encoding).rstrip("/"))
1410
dir = controldir.ControlDir.open_containing(location)[0]
1411
for branch in dir.list_branches():
1412
if branch.name is None:
1413
self.outf.write(gettext(" (default)\n"))
1415
self.outf.write(" %s\n" % branch.name.encode(
1416
self.outf.encoding))
1419
class cmd_checkout(Command):
1420
__doc__ = """Create a new checkout of an existing branch.
1422
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1423
the branch found in '.'. This is useful if you have removed the working tree
1424
or if it was never created - i.e. if you pushed the branch to its current
1425
location using SFTP.
1427
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1428
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1429
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1430
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1431
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1434
To retrieve the branch as of a particular revision, supply the --revision
1435
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1436
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1440
_see_also = ['checkouts', 'branch']
1441
takes_args = ['branch_location?', 'to_location?']
1442
takes_options = ['revision',
1443
Option('lightweight',
1444
help="Perform a lightweight checkout. Lightweight "
1445
"checkouts depend on access to the branch for "
1446
"every operation. Normal checkouts can perform "
1447
"common operations like diff and status without "
1448
"such access, and also support local commits."
1450
Option('files-from', type=str,
1451
help="Get file contents from this tree."),
1453
help='Hard-link working tree files where possible.'
1458
def run(self, branch_location=None, to_location=None, revision=None,
1459
lightweight=False, files_from=None, hardlink=False):
1460
if branch_location is None:
1461
branch_location = osutils.getcwd()
1462
to_location = branch_location
1463
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1465
if not (hardlink or files_from):
1466
# accelerator_tree is usually slower because you have to read N
1467
# files (no readahead, lots of seeks, etc), but allow the user to
1468
# explicitly request it
1469
accelerator_tree = None
1470
revision = _get_one_revision('checkout', revision)
1471
if files_from is not None and files_from != branch_location:
1472
accelerator_tree = WorkingTree.open(files_from)
1473
if revision is not None:
1474
revision_id = revision.as_revision_id(source)
1477
if to_location is None:
1478
to_location = urlutils.derive_to_location(branch_location)
1479
# if the source and to_location are the same,
1480
# and there is no working tree,
1481
# then reconstitute a branch
1482
if (osutils.abspath(to_location) ==
1483
osutils.abspath(branch_location)):
1485
source.bzrdir.open_workingtree()
1486
except errors.NoWorkingTree:
1487
source.bzrdir.create_workingtree(revision_id)
1489
source.create_checkout(to_location, revision_id, lightweight,
1490
accelerator_tree, hardlink)
1493
class cmd_renames(Command):
1494
__doc__ = """Show list of renamed files.
1496
# TODO: Option to show renames between two historical versions.
1498
# TODO: Only show renames under dir, rather than in the whole branch.
1499
_see_also = ['status']
1500
takes_args = ['dir?']
1503
def run(self, dir=u'.'):
1504
tree = WorkingTree.open_containing(dir)[0]
1505
self.add_cleanup(tree.lock_read().unlock)
1506
new_inv = tree.inventory
1507
old_tree = tree.basis_tree()
1508
self.add_cleanup(old_tree.lock_read().unlock)
1509
old_inv = old_tree.inventory
1511
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1512
for f, paths, c, v, p, n, k, e in iterator:
1513
if paths[0] == paths[1]:
1517
renames.append(paths)
1519
for old_name, new_name in renames:
1520
self.outf.write("%s => %s\n" % (old_name, new_name))
1523
class cmd_update(Command):
1524
__doc__ = """Update a working tree to a new revision.
1526
This will perform a merge of the destination revision (the tip of the
1527
branch, or the specified revision) into the working tree, and then make
1528
that revision the basis revision for the working tree.
1530
You can use this to visit an older revision, or to update a working tree
1531
that is out of date from its branch.
1533
If there are any uncommitted changes in the tree, they will be carried
1534
across and remain as uncommitted changes after the update. To discard
1535
these changes, use 'bzr revert'. The uncommitted changes may conflict
1536
with the changes brought in by the change in basis revision.
1538
If the tree's branch is bound to a master branch, bzr will also update
1539
the branch from the master.
1541
You cannot update just a single file or directory, because each Bazaar
1542
working tree has just a single basis revision. If you want to restore a
1543
file that has been removed locally, use 'bzr revert' instead of 'bzr
1544
update'. If you want to restore a file to its state in a previous
1545
revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
1546
out the old content of that file to a new location.
1548
The 'dir' argument, if given, must be the location of the root of a
1549
working tree to update. By default, the working tree that contains the
1550
current working directory is used.
1553
_see_also = ['pull', 'working-trees', 'status-flags']
1554
takes_args = ['dir?']
1555
takes_options = ['revision',
1557
help="Show base revision text in conflicts."),
1561
def run(self, dir=None, revision=None, show_base=None):
1562
if revision is not None and len(revision) != 1:
1563
raise errors.BzrCommandError(gettext(
1564
"bzr update --revision takes exactly one revision"))
1566
tree = WorkingTree.open_containing('.')[0]
1568
tree, relpath = WorkingTree.open_containing(dir)
1571
raise errors.BzrCommandError(gettext(
1572
"bzr update can only update a whole tree, "
1573
"not a file or subdirectory"))
1574
branch = tree.branch
1575
possible_transports = []
1576
master = branch.get_master_branch(
1577
possible_transports=possible_transports)
1578
if master is not None:
1579
branch_location = master.base
1582
branch_location = tree.branch.base
1583
tree.lock_tree_write()
1584
self.add_cleanup(tree.unlock)
1585
# get rid of the final '/' and be ready for display
1586
branch_location = urlutils.unescape_for_display(
1587
branch_location.rstrip('/'),
1589
existing_pending_merges = tree.get_parent_ids()[1:]
1593
# may need to fetch data into a heavyweight checkout
1594
# XXX: this may take some time, maybe we should display a
1596
old_tip = branch.update(possible_transports)
1597
if revision is not None:
1598
revision_id = revision[0].as_revision_id(branch)
1600
revision_id = branch.last_revision()
1601
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1602
revno = branch.revision_id_to_dotted_revno(revision_id)
1603
note(gettext("Tree is up to date at revision {0} of branch {1}"
1604
).format('.'.join(map(str, revno)), branch_location))
1606
view_info = _get_view_info_for_change_reporter(tree)
1607
change_reporter = delta._ChangeReporter(
1608
unversioned_filter=tree.is_ignored,
1609
view_info=view_info)
1611
conflicts = tree.update(
1613
possible_transports=possible_transports,
1614
revision=revision_id,
1616
show_base=show_base)
1617
except errors.NoSuchRevision, e:
1618
raise errors.BzrCommandError(gettext(
1619
"branch has no revision %s\n"
1620
"bzr update --revision only works"
1621
" for a revision in the branch history")
1623
revno = tree.branch.revision_id_to_dotted_revno(
1624
_mod_revision.ensure_null(tree.last_revision()))
1625
note(gettext('Updated to revision {0} of branch {1}').format(
1626
'.'.join(map(str, revno)), branch_location))
1627
parent_ids = tree.get_parent_ids()
1628
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1629
note(gettext('Your local commits will now show as pending merges with '
1630
"'bzr status', and can be committed with 'bzr commit'."))
1637
class cmd_info(Command):
1638
__doc__ = """Show information about a working tree, branch or repository.
1640
This command will show all known locations and formats associated to the
1641
tree, branch or repository.
1643
In verbose mode, statistical information is included with each report.
1644
To see extended statistic information, use a verbosity level of 2 or
1645
higher by specifying the verbose option multiple times, e.g. -vv.
1647
Branches and working trees will also report any missing revisions.
1651
Display information on the format and related locations:
1655
Display the above together with extended format information and
1656
basic statistics (like the number of files in the working tree and
1657
number of revisions in the branch and repository):
1661
Display the above together with number of committers to the branch:
1665
_see_also = ['revno', 'working-trees', 'repositories']
1666
takes_args = ['location?']
1667
takes_options = ['verbose']
1668
encoding_type = 'replace'
1671
def run(self, location=None, verbose=False):
1673
noise_level = get_verbosity_level()
1676
from bzrlib.info import show_bzrdir_info
1677
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1678
verbose=noise_level, outfile=self.outf)
1681
class cmd_remove(Command):
1682
__doc__ = """Remove files or directories.
1684
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1685
delete them if they can easily be recovered using revert otherwise they
1686
will be backed up (adding an extention of the form .~#~). If no options or
1687
parameters are given Bazaar will scan for files that are being tracked by
1688
Bazaar but missing in your tree and stop tracking them for you.
1690
takes_args = ['file*']
1691
takes_options = ['verbose',
1692
Option('new', help='Only remove files that have never been committed.'),
1693
RegistryOption.from_kwargs('file-deletion-strategy',
1694
'The file deletion mode to be used.',
1695
title='Deletion Strategy', value_switches=True, enum_switch=False,
1696
safe='Backup changed files (default).',
1697
keep='Delete from bzr but leave the working copy.',
1698
no_backup='Don\'t backup changed files.',
1699
force='Delete all the specified files, even if they can not be '
1700
'recovered and even if they are non-empty directories. '
1701
'(deprecated, use no-backup)')]
1702
aliases = ['rm', 'del']
1703
encoding_type = 'replace'
1705
def run(self, file_list, verbose=False, new=False,
1706
file_deletion_strategy='safe'):
1707
if file_deletion_strategy == 'force':
1708
note(gettext("(The --force option is deprecated, rather use --no-backup "
1710
file_deletion_strategy = 'no-backup'
1712
tree, file_list = WorkingTree.open_containing_paths(file_list)
1714
if file_list is not None:
1715
file_list = [f for f in file_list]
1717
self.add_cleanup(tree.lock_write().unlock)
1718
# Heuristics should probably all move into tree.remove_smart or
1721
added = tree.changes_from(tree.basis_tree(),
1722
specific_files=file_list).added
1723
file_list = sorted([f[0] for f in added], reverse=True)
1724
if len(file_list) == 0:
1725
raise errors.BzrCommandError(gettext('No matching files.'))
1726
elif file_list is None:
1727
# missing files show up in iter_changes(basis) as
1728
# versioned-with-no-kind.
1730
for change in tree.iter_changes(tree.basis_tree()):
1731
# Find paths in the working tree that have no kind:
1732
if change[1][1] is not None and change[6][1] is None:
1733
missing.append(change[1][1])
1734
file_list = sorted(missing, reverse=True)
1735
file_deletion_strategy = 'keep'
1736
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1737
keep_files=file_deletion_strategy=='keep',
1738
force=(file_deletion_strategy=='no-backup'))
1741
class cmd_file_id(Command):
1742
__doc__ = """Print file_id of a particular file or directory.
1744
The file_id is assigned when the file is first added and remains the
1745
same through all revisions where the file exists, even when it is
1750
_see_also = ['inventory', 'ls']
1751
takes_args = ['filename']
1754
def run(self, filename):
1755
tree, relpath = WorkingTree.open_containing(filename)
1756
i = tree.path2id(relpath)
1758
raise errors.NotVersionedError(filename)
1760
self.outf.write(i + '\n')
1763
class cmd_file_path(Command):
1764
__doc__ = """Print path of file_ids to a file or directory.
1766
This prints one line for each directory down to the target,
1767
starting at the branch root.
1771
takes_args = ['filename']
1774
def run(self, filename):
1775
tree, relpath = WorkingTree.open_containing(filename)
1776
fid = tree.path2id(relpath)
1778
raise errors.NotVersionedError(filename)
1779
segments = osutils.splitpath(relpath)
1780
for pos in range(1, len(segments) + 1):
1781
path = osutils.joinpath(segments[:pos])
1782
self.outf.write("%s\n" % tree.path2id(path))
1785
class cmd_reconcile(Command):
1786
__doc__ = """Reconcile bzr metadata in a branch.
1788
This can correct data mismatches that may have been caused by
1789
previous ghost operations or bzr upgrades. You should only
1790
need to run this command if 'bzr check' or a bzr developer
1791
advises you to run it.
1793
If a second branch is provided, cross-branch reconciliation is
1794
also attempted, which will check that data like the tree root
1795
id which was not present in very early bzr versions is represented
1796
correctly in both branches.
1798
At the same time it is run it may recompress data resulting in
1799
a potential saving in disk space or performance gain.
1801
The branch *MUST* be on a listable system such as local disk or sftp.
1804
_see_also = ['check']
1805
takes_args = ['branch?']
1807
Option('canonicalize-chks',
1808
help='Make sure CHKs are in canonical form (repairs '
1813
def run(self, branch=".", canonicalize_chks=False):
1814
from bzrlib.reconcile import reconcile
1815
dir = controldir.ControlDir.open(branch)
1816
reconcile(dir, canonicalize_chks=canonicalize_chks)
1819
class cmd_revision_history(Command):
1820
__doc__ = """Display the list of revision ids on a branch."""
1823
takes_args = ['location?']
1828
def run(self, location="."):
1829
branch = Branch.open_containing(location)[0]
1830
self.add_cleanup(branch.lock_read().unlock)
1831
graph = branch.repository.get_graph()
1832
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1833
[_mod_revision.NULL_REVISION]))
1834
for revid in reversed(history):
1835
self.outf.write(revid)
1836
self.outf.write('\n')
1839
class cmd_ancestry(Command):
1840
__doc__ = """List all revisions merged into this branch."""
1842
_see_also = ['log', 'revision-history']
1843
takes_args = ['location?']
1848
def run(self, location="."):
1850
wt = WorkingTree.open_containing(location)[0]
1851
except errors.NoWorkingTree:
1852
b = Branch.open(location)
1853
last_revision = b.last_revision()
1856
last_revision = wt.last_revision()
1858
self.add_cleanup(b.repository.lock_read().unlock)
1859
graph = b.repository.get_graph()
1860
revisions = [revid for revid, parents in
1861
graph.iter_ancestry([last_revision])]
1862
for revision_id in reversed(revisions):
1863
if _mod_revision.is_null(revision_id):
1865
self.outf.write(revision_id + '\n')
1868
class cmd_init(Command):
1869
__doc__ = """Make a directory into a versioned branch.
1871
Use this to create an empty branch, or before importing an
1874
If there is a repository in a parent directory of the location, then
1875
the history of the branch will be stored in the repository. Otherwise
1876
init creates a standalone branch which carries its own history
1877
in the .bzr directory.
1879
If there is already a branch at the location but it has no working tree,
1880
the tree can be populated with 'bzr checkout'.
1882
Recipe for importing a tree of files::
1888
bzr commit -m "imported project"
1891
_see_also = ['init-repository', 'branch', 'checkout']
1892
takes_args = ['location?']
1894
Option('create-prefix',
1895
help='Create the path leading up to the branch '
1896
'if it does not already exist.'),
1897
RegistryOption('format',
1898
help='Specify a format for this branch. '
1899
'See "help formats".',
1900
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1901
converter=lambda name: controldir.format_registry.make_bzrdir(name),
1902
value_switches=True,
1903
title="Branch format",
1905
Option('append-revisions-only',
1906
help='Never change revnos or the existing log.'
1907
' Append revisions to it only.'),
1909
'Create a branch without a working tree.')
1911
def run(self, location=None, format=None, append_revisions_only=False,
1912
create_prefix=False, no_tree=False):
1914
format = controldir.format_registry.make_bzrdir('default')
1915
if location is None:
1918
to_transport = transport.get_transport(location)
1920
# The path has to exist to initialize a
1921
# branch inside of it.
1922
# Just using os.mkdir, since I don't
1923
# believe that we want to create a bunch of
1924
# locations if the user supplies an extended path
1926
to_transport.ensure_base()
1927
except errors.NoSuchFile:
1928
if not create_prefix:
1929
raise errors.BzrCommandError(gettext("Parent directory of %s"
1931
"\nYou may supply --create-prefix to create all"
1932
" leading parent directories.")
1934
to_transport.create_prefix()
1937
a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
1938
except errors.NotBranchError:
1939
# really a NotBzrDir error...
1940
create_branch = controldir.ControlDir.create_branch_convenience
1942
force_new_tree = False
1944
force_new_tree = None
1945
branch = create_branch(to_transport.base, format=format,
1946
possible_transports=[to_transport],
1947
force_new_tree=force_new_tree)
1948
a_bzrdir = branch.bzrdir
1950
from bzrlib.transport.local import LocalTransport
1951
if a_bzrdir.has_branch():
1952
if (isinstance(to_transport, LocalTransport)
1953
and not a_bzrdir.has_workingtree()):
1954
raise errors.BranchExistsWithoutWorkingTree(location)
1955
raise errors.AlreadyBranchError(location)
1956
branch = a_bzrdir.create_branch()
1957
if not no_tree and not a_bzrdir.has_workingtree():
1958
a_bzrdir.create_workingtree()
1959
if append_revisions_only:
1961
branch.set_append_revisions_only(True)
1962
except errors.UpgradeRequired:
1963
raise errors.BzrCommandError(gettext('This branch format cannot be set'
1964
' to append-revisions-only. Try --default.'))
1966
from bzrlib.info import describe_layout, describe_format
1968
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1969
except (errors.NoWorkingTree, errors.NotLocalUrl):
1971
repository = branch.repository
1972
layout = describe_layout(repository, branch, tree).lower()
1973
format = describe_format(a_bzrdir, repository, branch, tree)
1974
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
1976
if repository.is_shared():
1977
#XXX: maybe this can be refactored into transport.path_or_url()
1978
url = repository.bzrdir.root_transport.external_url()
1980
url = urlutils.local_path_from_url(url)
1981
except errors.InvalidURL:
1983
self.outf.write(gettext("Using shared repository: %s\n") % url)
1986
class cmd_init_repository(Command):
1987
__doc__ = """Create a shared repository for branches to share storage space.
1989
New branches created under the repository directory will store their
1990
revisions in the repository, not in the branch directory. For branches
1991
with shared history, this reduces the amount of storage needed and
1992
speeds up the creation of new branches.
1994
If the --no-trees option is given then the branches in the repository
1995
will not have working trees by default. They will still exist as
1996
directories on disk, but they will not have separate copies of the
1997
files at a certain revision. This can be useful for repositories that
1998
store branches which are interacted with through checkouts or remote
1999
branches, such as on a server.
2002
Create a shared repository holding just branches::
2004
bzr init-repo --no-trees repo
2007
Make a lightweight checkout elsewhere::
2009
bzr checkout --lightweight repo/trunk trunk-checkout
2014
_see_also = ['init', 'branch', 'checkout', 'repositories']
2015
takes_args = ["location"]
2016
takes_options = [RegistryOption('format',
2017
help='Specify a format for this repository. See'
2018
' "bzr help formats" for details.',
2019
lazy_registry=('bzrlib.controldir', 'format_registry'),
2020
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2021
value_switches=True, title='Repository format'),
2023
help='Branches in the repository will default to'
2024
' not having a working tree.'),
2026
aliases = ["init-repo"]
2028
def run(self, location, format=None, no_trees=False):
2030
format = controldir.format_registry.make_bzrdir('default')
2032
if location is None:
2035
to_transport = transport.get_transport(location)
2036
to_transport.ensure_base()
2038
newdir = format.initialize_on_transport(to_transport)
2039
repo = newdir.create_repository(shared=True)
2040
repo.set_make_working_trees(not no_trees)
2042
from bzrlib.info import show_bzrdir_info
2043
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
2046
class cmd_diff(Command):
2047
__doc__ = """Show differences in the working tree, between revisions or branches.
2049
If no arguments are given, all changes for the current tree are listed.
2050
If files are given, only the changes in those files are listed.
2051
Remote and multiple branches can be compared by using the --old and
2052
--new options. If not provided, the default for both is derived from
2053
the first argument, if any, or the current tree if no arguments are
2056
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
2057
produces patches suitable for "patch -p1".
2059
Note that when using the -r argument with a range of revisions, the
2060
differences are computed between the two specified revisions. That
2061
is, the command does not show the changes introduced by the first
2062
revision in the range. This differs from the interpretation of
2063
revision ranges used by "bzr log" which includes the first revision
2068
2 - unrepresentable changes
2073
Shows the difference in the working tree versus the last commit::
2077
Difference between the working tree and revision 1::
2081
Difference between revision 3 and revision 1::
2085
Difference between revision 3 and revision 1 for branch xxx::
2089
The changes introduced by revision 2 (equivalent to -r1..2)::
2093
To see the changes introduced by revision X::
2097
Note that in the case of a merge, the -c option shows the changes
2098
compared to the left hand parent. To see the changes against
2099
another parent, use::
2101
bzr diff -r<chosen_parent>..X
2103
The changes between the current revision and the previous revision
2104
(equivalent to -c-1 and -r-2..-1)
2108
Show just the differences for file NEWS::
2112
Show the differences in working tree xxx for file NEWS::
2116
Show the differences from branch xxx to this working tree:
2120
Show the differences between two branches for file NEWS::
2122
bzr diff --old xxx --new yyy NEWS
2124
Same as 'bzr diff' but prefix paths with old/ and new/::
2126
bzr diff --prefix old/:new/
2128
Show the differences using a custom diff program with options::
2130
bzr diff --using /usr/bin/diff --diff-options -wu
2132
_see_also = ['status']
2133
takes_args = ['file*']
2135
Option('diff-options', type=str,
2136
help='Pass these options to the external diff program.'),
2137
Option('prefix', type=str,
2139
help='Set prefixes added to old and new filenames, as '
2140
'two values separated by a colon. (eg "old/:new/").'),
2142
help='Branch/tree to compare from.',
2146
help='Branch/tree to compare to.',
2152
help='Use this command to compare files.',
2155
RegistryOption('format',
2157
help='Diff format to use.',
2158
lazy_registry=('bzrlib.diff', 'format_registry'),
2159
title='Diff format'),
2161
aliases = ['di', 'dif']
2162
encoding_type = 'exact'
2165
def run(self, revision=None, file_list=None, diff_options=None,
2166
prefix=None, old=None, new=None, using=None, format=None):
2167
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2170
if (prefix is None) or (prefix == '0'):
2178
old_label, new_label = prefix.split(":")
2180
raise errors.BzrCommandError(gettext(
2181
'--prefix expects two values separated by a colon'
2182
' (eg "old/:new/")'))
2184
if revision and len(revision) > 2:
2185
raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
2186
' one or two revision specifiers'))
2188
if using is not None and format is not None:
2189
raise errors.BzrCommandError(gettext(
2190
'{0} and {1} are mutually exclusive').format(
2191
'--using', '--format'))
2193
(old_tree, new_tree,
2194
old_branch, new_branch,
2195
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2196
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2197
# GNU diff on Windows uses ANSI encoding for filenames
2198
path_encoding = osutils.get_diff_header_encoding()
2199
return show_diff_trees(old_tree, new_tree, sys.stdout,
2200
specific_files=specific_files,
2201
external_diff_options=diff_options,
2202
old_label=old_label, new_label=new_label,
2203
extra_trees=extra_trees,
2204
path_encoding=path_encoding,
2209
class cmd_deleted(Command):
2210
__doc__ = """List files deleted in the working tree.
2212
# TODO: Show files deleted since a previous revision, or
2213
# between two revisions.
2214
# TODO: Much more efficient way to do this: read in new
2215
# directories with readdir, rather than stating each one. Same
2216
# level of effort but possibly much less IO. (Or possibly not,
2217
# if the directories are very large...)
2218
_see_also = ['status', 'ls']
2219
takes_options = ['directory', 'show-ids']
2222
def run(self, show_ids=False, directory=u'.'):
2223
tree = WorkingTree.open_containing(directory)[0]
2224
self.add_cleanup(tree.lock_read().unlock)
2225
old = tree.basis_tree()
2226
self.add_cleanup(old.lock_read().unlock)
2227
for path, ie in old.inventory.iter_entries():
2228
if not tree.has_id(ie.file_id):
2229
self.outf.write(path)
2231
self.outf.write(' ')
2232
self.outf.write(ie.file_id)
2233
self.outf.write('\n')
2236
class cmd_modified(Command):
2237
__doc__ = """List files modified in working tree.
2241
_see_also = ['status', 'ls']
2242
takes_options = ['directory', 'null']
2245
def run(self, null=False, directory=u'.'):
2246
tree = WorkingTree.open_containing(directory)[0]
2247
self.add_cleanup(tree.lock_read().unlock)
2248
td = tree.changes_from(tree.basis_tree())
2250
for path, id, kind, text_modified, meta_modified in td.modified:
2252
self.outf.write(path + '\0')
2254
self.outf.write(osutils.quotefn(path) + '\n')
2257
class cmd_added(Command):
2258
__doc__ = """List files added in working tree.
2262
_see_also = ['status', 'ls']
2263
takes_options = ['directory', 'null']
2266
def run(self, null=False, directory=u'.'):
2267
wt = WorkingTree.open_containing(directory)[0]
2268
self.add_cleanup(wt.lock_read().unlock)
2269
basis = wt.basis_tree()
2270
self.add_cleanup(basis.lock_read().unlock)
2271
basis_inv = basis.inventory
2274
if basis_inv.has_id(file_id):
2276
if inv.is_root(file_id) and len(basis_inv) == 0:
2278
path = inv.id2path(file_id)
2279
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2282
self.outf.write(path + '\0')
2284
self.outf.write(osutils.quotefn(path) + '\n')
2287
class cmd_root(Command):
2288
__doc__ = """Show the tree root directory.
2290
The root is the nearest enclosing directory with a .bzr control
2293
takes_args = ['filename?']
2295
def run(self, filename=None):
2296
"""Print the branch root."""
2297
tree = WorkingTree.open_containing(filename)[0]
2298
self.outf.write(tree.basedir + '\n')
2301
def _parse_limit(limitstring):
2303
return int(limitstring)
2305
msg = gettext("The limit argument must be an integer.")
2306
raise errors.BzrCommandError(msg)
2309
def _parse_levels(s):
2313
msg = gettext("The levels argument must be an integer.")
2314
raise errors.BzrCommandError(msg)
2317
class cmd_log(Command):
2318
__doc__ = """Show historical log for a branch or subset of a branch.
2320
log is bzr's default tool for exploring the history of a branch.
2321
The branch to use is taken from the first parameter. If no parameters
2322
are given, the branch containing the working directory is logged.
2323
Here are some simple examples::
2325
bzr log log the current branch
2326
bzr log foo.py log a file in its branch
2327
bzr log http://server/branch log a branch on a server
2329
The filtering, ordering and information shown for each revision can
2330
be controlled as explained below. By default, all revisions are
2331
shown sorted (topologically) so that newer revisions appear before
2332
older ones and descendants always appear before ancestors. If displayed,
2333
merged revisions are shown indented under the revision in which they
2338
The log format controls how information about each revision is
2339
displayed. The standard log formats are called ``long``, ``short``
2340
and ``line``. The default is long. See ``bzr help log-formats``
2341
for more details on log formats.
2343
The following options can be used to control what information is
2346
-l N display a maximum of N revisions
2347
-n N display N levels of revisions (0 for all, 1 for collapsed)
2348
-v display a status summary (delta) for each revision
2349
-p display a diff (patch) for each revision
2350
--show-ids display revision-ids (and file-ids), not just revnos
2352
Note that the default number of levels to display is a function of the
2353
log format. If the -n option is not used, the standard log formats show
2354
just the top level (mainline).
2356
Status summaries are shown using status flags like A, M, etc. To see
2357
the changes explained using words like ``added`` and ``modified``
2358
instead, use the -vv option.
2362
To display revisions from oldest to newest, use the --forward option.
2363
In most cases, using this option will have little impact on the total
2364
time taken to produce a log, though --forward does not incrementally
2365
display revisions like --reverse does when it can.
2367
:Revision filtering:
2369
The -r option can be used to specify what revision or range of revisions
2370
to filter against. The various forms are shown below::
2372
-rX display revision X
2373
-rX.. display revision X and later
2374
-r..Y display up to and including revision Y
2375
-rX..Y display from X to Y inclusive
2377
See ``bzr help revisionspec`` for details on how to specify X and Y.
2378
Some common examples are given below::
2380
-r-1 show just the tip
2381
-r-10.. show the last 10 mainline revisions
2382
-rsubmit:.. show what's new on this branch
2383
-rancestor:path.. show changes since the common ancestor of this
2384
branch and the one at location path
2385
-rdate:yesterday.. show changes since yesterday
2387
When logging a range of revisions using -rX..Y, log starts at
2388
revision Y and searches back in history through the primary
2389
("left-hand") parents until it finds X. When logging just the
2390
top level (using -n1), an error is reported if X is not found
2391
along the way. If multi-level logging is used (-n0), X may be
2392
a nested merge revision and the log will be truncated accordingly.
2396
If parameters are given and the first one is not a branch, the log
2397
will be filtered to show only those revisions that changed the
2398
nominated files or directories.
2400
Filenames are interpreted within their historical context. To log a
2401
deleted file, specify a revision range so that the file existed at
2402
the end or start of the range.
2404
Historical context is also important when interpreting pathnames of
2405
renamed files/directories. Consider the following example:
2407
* revision 1: add tutorial.txt
2408
* revision 2: modify tutorial.txt
2409
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2413
* ``bzr log guide.txt`` will log the file added in revision 1
2415
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2417
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2418
the original file in revision 2.
2420
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2421
was no file called guide.txt in revision 2.
2423
Renames are always followed by log. By design, there is no need to
2424
explicitly ask for this (and no way to stop logging a file back
2425
until it was last renamed).
2429
The --match option can be used for finding revisions that match a
2430
regular expression in a commit message, committer, author or bug.
2431
Specifying the option several times will match any of the supplied
2432
expressions. --match-author, --match-bugs, --match-committer and
2433
--match-message can be used to only match a specific field.
2437
GUI tools and IDEs are often better at exploring history than command
2438
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2439
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2440
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2441
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2443
You may find it useful to add the aliases below to ``bazaar.conf``::
2447
top = log -l10 --line
2450
``bzr tip`` will then show the latest revision while ``bzr top``
2451
will show the last 10 mainline revisions. To see the details of a
2452
particular revision X, ``bzr show -rX``.
2454
If you are interested in looking deeper into a particular merge X,
2455
use ``bzr log -n0 -rX``.
2457
``bzr log -v`` on a branch with lots of history is currently
2458
very slow. A fix for this issue is currently under development.
2459
With or without that fix, it is recommended that a revision range
2460
be given when using the -v option.
2462
bzr has a generic full-text matching plugin, bzr-search, that can be
2463
used to find revisions matching user names, commit messages, etc.
2464
Among other features, this plugin can find all revisions containing
2465
a list of words but not others.
2467
When exploring non-mainline history on large projects with deep
2468
history, the performance of log can be greatly improved by installing
2469
the historycache plugin. This plugin buffers historical information
2470
trading disk space for faster speed.
2472
takes_args = ['file*']
2473
_see_also = ['log-formats', 'revisionspec']
2476
help='Show from oldest to newest.'),
2478
custom_help('verbose',
2479
help='Show files changed in each revision.'),
2483
type=bzrlib.option._parse_revision_str,
2485
help='Show just the specified revision.'
2486
' See also "help revisionspec".'),
2488
RegistryOption('authors',
2489
'What names to list as authors - first, all or committer.',
2491
lazy_registry=('bzrlib.log', 'author_list_registry'),
2495
help='Number of levels to display - 0 for all, 1 for flat.',
2497
type=_parse_levels),
2499
help='Show revisions whose message matches this '
2500
'regular expression.',
2505
help='Limit the output to the first N revisions.',
2510
help='Show changes made in each revision as a patch.'),
2511
Option('include-merged',
2512
help='Show merged revisions like --levels 0 does.'),
2513
Option('include-merges', hidden=True,
2514
help='Historical alias for --include-merged.'),
2515
Option('omit-merges',
2516
help='Do not report commits with more than one parent.'),
2517
Option('exclude-common-ancestry',
2518
help='Display only the revisions that are not part'
2519
' of both ancestries (require -rX..Y).'
2521
Option('signatures',
2522
help='Show digital signature validity.'),
2525
help='Show revisions whose properties match this '
2528
ListOption('match-message',
2529
help='Show revisions whose message matches this '
2532
ListOption('match-committer',
2533
help='Show revisions whose committer matches this '
2536
ListOption('match-author',
2537
help='Show revisions whose authors match this '
2540
ListOption('match-bugs',
2541
help='Show revisions whose bugs match this '
2545
encoding_type = 'replace'
2548
def run(self, file_list=None, timezone='original',
2559
include_merged=None,
2561
exclude_common_ancestry=False,
2565
match_committer=None,
2569
include_merges=symbol_versioning.DEPRECATED_PARAMETER,
2571
from bzrlib.log import (
2573
make_log_request_dict,
2574
_get_info_for_log_files,
2576
direction = (forward and 'forward') or 'reverse'
2577
if symbol_versioning.deprecated_passed(include_merges):
2578
ui.ui_factory.show_user_warning(
2579
'deprecated_command_option',
2580
deprecated_name='--include-merges',
2581
recommended_name='--include-merged',
2582
deprecated_in_version='2.5',
2583
command=self.invoked_as)
2584
if include_merged is None:
2585
include_merged = include_merges
2587
raise errors.BzrCommandError(gettext(
2588
'{0} and {1} are mutually exclusive').format(
2589
'--include-merges', '--include-merged'))
2590
if include_merged is None:
2591
include_merged = False
2592
if (exclude_common_ancestry
2593
and (revision is None or len(revision) != 2)):
2594
raise errors.BzrCommandError(gettext(
2595
'--exclude-common-ancestry requires -r with two revisions'))
2600
raise errors.BzrCommandError(gettext(
2601
'{0} and {1} are mutually exclusive').format(
2602
'--levels', '--include-merged'))
2604
if change is not None:
2606
raise errors.RangeInChangeOption()
2607
if revision is not None:
2608
raise errors.BzrCommandError(gettext(
2609
'{0} and {1} are mutually exclusive').format(
2610
'--revision', '--change'))
2615
filter_by_dir = False
2617
# find the file ids to log and check for directory filtering
2618
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2619
revision, file_list, self.add_cleanup)
2620
for relpath, file_id, kind in file_info_list:
2622
raise errors.BzrCommandError(gettext(
2623
"Path unknown at end or start of revision range: %s") %
2625
# If the relpath is the top of the tree, we log everything
2630
file_ids.append(file_id)
2631
filter_by_dir = filter_by_dir or (
2632
kind in ['directory', 'tree-reference'])
2635
# FIXME ? log the current subdir only RBC 20060203
2636
if revision is not None \
2637
and len(revision) > 0 and revision[0].get_branch():
2638
location = revision[0].get_branch()
2641
dir, relpath = controldir.ControlDir.open_containing(location)
2642
b = dir.open_branch()
2643
self.add_cleanup(b.lock_read().unlock)
2644
rev1, rev2 = _get_revision_range(revision, b, self.name())
2646
if b.get_config().validate_signatures_in_log():
2650
if not gpg.GPGStrategy.verify_signatures_available():
2651
raise errors.GpgmeNotInstalled(None)
2653
# Decide on the type of delta & diff filtering to use
2654
# TODO: add an --all-files option to make this configurable & consistent
2662
diff_type = 'partial'
2666
# Build the log formatter
2667
if log_format is None:
2668
log_format = log.log_formatter_registry.get_default(b)
2669
# Make a non-encoding output to include the diffs - bug 328007
2670
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2671
lf = log_format(show_ids=show_ids, to_file=self.outf,
2672
to_exact_file=unencoded_output,
2673
show_timezone=timezone,
2674
delta_format=get_verbosity_level(),
2676
show_advice=levels is None,
2677
author_list_handler=authors)
2679
# Choose the algorithm for doing the logging. It's annoying
2680
# having multiple code paths like this but necessary until
2681
# the underlying repository format is faster at generating
2682
# deltas or can provide everything we need from the indices.
2683
# The default algorithm - match-using-deltas - works for
2684
# multiple files and directories and is faster for small
2685
# amounts of history (200 revisions say). However, it's too
2686
# slow for logging a single file in a repository with deep
2687
# history, i.e. > 10K revisions. In the spirit of "do no
2688
# evil when adding features", we continue to use the
2689
# original algorithm - per-file-graph - for the "single
2690
# file that isn't a directory without showing a delta" case.
2691
partial_history = revision and b.repository._format.supports_chks
2692
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2693
or delta_type or partial_history)
2697
match_dict[''] = match
2699
match_dict['message'] = match_message
2701
match_dict['committer'] = match_committer
2703
match_dict['author'] = match_author
2705
match_dict['bugs'] = match_bugs
2707
# Build the LogRequest and execute it
2708
if len(file_ids) == 0:
2710
rqst = make_log_request_dict(
2711
direction=direction, specific_fileids=file_ids,
2712
start_revision=rev1, end_revision=rev2, limit=limit,
2713
message_search=message, delta_type=delta_type,
2714
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2715
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2716
signature=signatures, omit_merges=omit_merges,
2718
Logger(b, rqst).show(lf)
2721
def _get_revision_range(revisionspec_list, branch, command_name):
2722
"""Take the input of a revision option and turn it into a revision range.
2724
It returns RevisionInfo objects which can be used to obtain the rev_id's
2725
of the desired revisions. It does some user input validations.
2727
if revisionspec_list is None:
2730
elif len(revisionspec_list) == 1:
2731
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2732
elif len(revisionspec_list) == 2:
2733
start_spec = revisionspec_list[0]
2734
end_spec = revisionspec_list[1]
2735
if end_spec.get_branch() != start_spec.get_branch():
2736
# b is taken from revision[0].get_branch(), and
2737
# show_log will use its revision_history. Having
2738
# different branches will lead to weird behaviors.
2739
raise errors.BzrCommandError(gettext(
2740
"bzr %s doesn't accept two revisions in different"
2741
" branches.") % command_name)
2742
if start_spec.spec is None:
2743
# Avoid loading all the history.
2744
rev1 = RevisionInfo(branch, None, None)
2746
rev1 = start_spec.in_history(branch)
2747
# Avoid loading all of history when we know a missing
2748
# end of range means the last revision ...
2749
if end_spec.spec is None:
2750
last_revno, last_revision_id = branch.last_revision_info()
2751
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2753
rev2 = end_spec.in_history(branch)
2755
raise errors.BzrCommandError(gettext(
2756
'bzr %s --revision takes one or two values.') % command_name)
2760
def _revision_range_to_revid_range(revision_range):
2763
if revision_range[0] is not None:
2764
rev_id1 = revision_range[0].rev_id
2765
if revision_range[1] is not None:
2766
rev_id2 = revision_range[1].rev_id
2767
return rev_id1, rev_id2
2769
def get_log_format(long=False, short=False, line=False, default='long'):
2770
log_format = default
2774
log_format = 'short'
2780
class cmd_touching_revisions(Command):
2781
__doc__ = """Return revision-ids which affected a particular file.
2783
A more user-friendly interface is "bzr log FILE".
2787
takes_args = ["filename"]
2790
def run(self, filename):
2791
tree, relpath = WorkingTree.open_containing(filename)
2792
file_id = tree.path2id(relpath)
2794
self.add_cleanup(b.lock_read().unlock)
2795
touching_revs = log.find_touching_revisions(b, file_id)
2796
for revno, revision_id, what in touching_revs:
2797
self.outf.write("%6d %s\n" % (revno, what))
2800
class cmd_ls(Command):
2801
__doc__ = """List files in a tree.
2804
_see_also = ['status', 'cat']
2805
takes_args = ['path?']
2809
Option('recursive', short_name='R',
2810
help='Recurse into subdirectories.'),
2812
help='Print paths relative to the root of the branch.'),
2813
Option('unknown', short_name='u',
2814
help='Print unknown files.'),
2815
Option('versioned', help='Print versioned files.',
2817
Option('ignored', short_name='i',
2818
help='Print ignored files.'),
2819
Option('kind', short_name='k',
2820
help='List entries of a particular kind: file, directory, symlink.',
2827
def run(self, revision=None, verbose=False,
2828
recursive=False, from_root=False,
2829
unknown=False, versioned=False, ignored=False,
2830
null=False, kind=None, show_ids=False, path=None, directory=None):
2832
if kind and kind not in ('file', 'directory', 'symlink'):
2833
raise errors.BzrCommandError(gettext('invalid kind specified'))
2835
if verbose and null:
2836
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
2837
all = not (unknown or versioned or ignored)
2839
selection = {'I':ignored, '?':unknown, 'V':versioned}
2845
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
2848
tree, branch, relpath = \
2849
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2851
# Calculate the prefix to use
2855
prefix = relpath + '/'
2856
elif fs_path != '.' and not fs_path.endswith('/'):
2857
prefix = fs_path + '/'
2859
if revision is not None or tree is None:
2860
tree = _get_one_revision_tree('ls', revision, branch=branch)
2863
if isinstance(tree, WorkingTree) and tree.supports_views():
2864
view_files = tree.views.lookup_view()
2867
view_str = views.view_display_str(view_files)
2868
note(gettext("Ignoring files outside view. View is %s") % view_str)
2870
self.add_cleanup(tree.lock_read().unlock)
2871
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2872
from_dir=relpath, recursive=recursive):
2873
# Apply additional masking
2874
if not all and not selection[fc]:
2876
if kind is not None and fkind != kind:
2881
fullpath = osutils.pathjoin(relpath, fp)
2884
views.check_path_in_view(tree, fullpath)
2885
except errors.FileOutsideView:
2890
fp = osutils.pathjoin(prefix, fp)
2891
kindch = entry.kind_character()
2892
outstring = fp + kindch
2893
ui.ui_factory.clear_term()
2895
outstring = '%-8s %s' % (fc, outstring)
2896
if show_ids and fid is not None:
2897
outstring = "%-50s %s" % (outstring, fid)
2898
self.outf.write(outstring + '\n')
2900
self.outf.write(fp + '\0')
2903
self.outf.write(fid)
2904
self.outf.write('\0')
2912
self.outf.write('%-50s %s\n' % (outstring, my_id))
2914
self.outf.write(outstring + '\n')
2917
class cmd_unknowns(Command):
2918
__doc__ = """List unknown files.
2923
takes_options = ['directory']
2926
def run(self, directory=u'.'):
2927
for f in WorkingTree.open_containing(directory)[0].unknowns():
2928
self.outf.write(osutils.quotefn(f) + '\n')
2931
class cmd_ignore(Command):
2932
__doc__ = """Ignore specified files or patterns.
2934
See ``bzr help patterns`` for details on the syntax of patterns.
2936
If a .bzrignore file does not exist, the ignore command
2937
will create one and add the specified files or patterns to the newly
2938
created file. The ignore command will also automatically add the
2939
.bzrignore file to be versioned. Creating a .bzrignore file without
2940
the use of the ignore command will require an explicit add command.
2942
To remove patterns from the ignore list, edit the .bzrignore file.
2943
After adding, editing or deleting that file either indirectly by
2944
using this command or directly by using an editor, be sure to commit
2947
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2948
the global ignore file can be found in the application data directory as
2949
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2950
Global ignores are not touched by this command. The global ignore file
2951
can be edited directly using an editor.
2953
Patterns prefixed with '!' are exceptions to ignore patterns and take
2954
precedence over regular ignores. Such exceptions are used to specify
2955
files that should be versioned which would otherwise be ignored.
2957
Patterns prefixed with '!!' act as regular ignore patterns, but have
2958
precedence over the '!' exception patterns.
2962
* Ignore patterns containing shell wildcards must be quoted from
2965
* Ignore patterns starting with "#" act as comments in the ignore file.
2966
To ignore patterns that begin with that character, use the "RE:" prefix.
2969
Ignore the top level Makefile::
2971
bzr ignore ./Makefile
2973
Ignore .class files in all directories...::
2975
bzr ignore "*.class"
2977
...but do not ignore "special.class"::
2979
bzr ignore "!special.class"
2981
Ignore files whose name begins with the "#" character::
2985
Ignore .o files under the lib directory::
2987
bzr ignore "lib/**/*.o"
2989
Ignore .o files under the lib directory::
2991
bzr ignore "RE:lib/.*\.o"
2993
Ignore everything but the "debian" toplevel directory::
2995
bzr ignore "RE:(?!debian/).*"
2997
Ignore everything except the "local" toplevel directory,
2998
but always ignore autosave files ending in ~, even under local/::
3001
bzr ignore "!./local"
3005
_see_also = ['status', 'ignored', 'patterns']
3006
takes_args = ['name_pattern*']
3007
takes_options = ['directory',
3008
Option('default-rules',
3009
help='Display the default ignore rules that bzr uses.')
3012
def run(self, name_pattern_list=None, default_rules=None,
3014
from bzrlib import ignores
3015
if default_rules is not None:
3016
# dump the default rules and exit
3017
for pattern in ignores.USER_DEFAULTS:
3018
self.outf.write("%s\n" % pattern)
3020
if not name_pattern_list:
3021
raise errors.BzrCommandError(gettext("ignore requires at least one "
3022
"NAME_PATTERN or --default-rules."))
3023
name_pattern_list = [globbing.normalize_pattern(p)
3024
for p in name_pattern_list]
3026
bad_patterns_count = 0
3027
for p in name_pattern_list:
3028
if not globbing.Globster.is_pattern_valid(p):
3029
bad_patterns_count += 1
3030
bad_patterns += ('\n %s' % p)
3032
msg = (ngettext('Invalid ignore pattern found. %s',
3033
'Invalid ignore patterns found. %s',
3034
bad_patterns_count) % bad_patterns)
3035
ui.ui_factory.show_error(msg)
3036
raise errors.InvalidPattern('')
3037
for name_pattern in name_pattern_list:
3038
if (name_pattern[0] == '/' or
3039
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3040
raise errors.BzrCommandError(gettext(
3041
"NAME_PATTERN should not be an absolute path"))
3042
tree, relpath = WorkingTree.open_containing(directory)
3043
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3044
ignored = globbing.Globster(name_pattern_list)
3046
self.add_cleanup(tree.lock_read().unlock)
3047
for entry in tree.list_files():
3051
if ignored.match(filename):
3052
matches.append(filename)
3053
if len(matches) > 0:
3054
self.outf.write(gettext("Warning: the following files are version "
3055
"controlled and match your ignore pattern:\n%s"
3056
"\nThese files will continue to be version controlled"
3057
" unless you 'bzr remove' them.\n") % ("\n".join(matches),))
3060
class cmd_ignored(Command):
3061
__doc__ = """List ignored files and the patterns that matched them.
3063
List all the ignored files and the ignore pattern that caused the file to
3066
Alternatively, to list just the files::
3071
encoding_type = 'replace'
3072
_see_also = ['ignore', 'ls']
3073
takes_options = ['directory']
3076
def run(self, directory=u'.'):
3077
tree = WorkingTree.open_containing(directory)[0]
3078
self.add_cleanup(tree.lock_read().unlock)
3079
for path, file_class, kind, file_id, entry in tree.list_files():
3080
if file_class != 'I':
3082
## XXX: Slightly inefficient since this was already calculated
3083
pat = tree.is_ignored(path)
3084
self.outf.write('%-50s %s\n' % (path, pat))
3087
class cmd_lookup_revision(Command):
3088
__doc__ = """Lookup the revision-id from a revision-number
3091
bzr lookup-revision 33
3094
takes_args = ['revno']
3095
takes_options = ['directory']
3098
def run(self, revno, directory=u'.'):
3102
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3104
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3105
self.outf.write("%s\n" % revid)
3108
class cmd_export(Command):
3109
__doc__ = """Export current or past revision to a destination directory or archive.
3111
If no revision is specified this exports the last committed revision.
3113
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3114
given, try to find the format with the extension. If no extension
3115
is found exports to a directory (equivalent to --format=dir).
3117
If root is supplied, it will be used as the root directory inside
3118
container formats (tar, zip, etc). If it is not supplied it will default
3119
to the exported filename. The root option has no effect for 'dir' format.
3121
If branch is omitted then the branch containing the current working
3122
directory will be used.
3124
Note: Export of tree with non-ASCII filenames to zip is not supported.
3126
================= =========================
3127
Supported formats Autodetected by extension
3128
================= =========================
3131
tbz2 .tar.bz2, .tbz2
3134
================= =========================
3137
takes_args = ['dest', 'branch_or_subdir?']
3138
takes_options = ['directory',
3140
help="Type of file to export to.",
3143
Option('filters', help='Apply content filters to export the '
3144
'convenient form.'),
3147
help="Name of the root directory inside the exported file."),
3148
Option('per-file-timestamps',
3149
help='Set modification time of files to that of the last '
3150
'revision in which it was changed.'),
3152
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3153
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
3154
from bzrlib.export import export
3156
if branch_or_subdir is None:
3157
tree = WorkingTree.open_containing(directory)[0]
3161
b, subdir = Branch.open_containing(branch_or_subdir)
3164
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3166
export(rev_tree, dest, format, root, subdir, filtered=filters,
3167
per_file_timestamps=per_file_timestamps)
3168
except errors.NoSuchExportFormat, e:
3169
raise errors.BzrCommandError(gettext('Unsupported export format: %s') % e.format)
3172
class cmd_cat(Command):
3173
__doc__ = """Write the contents of a file as of a given revision to standard output.
3175
If no revision is nominated, the last revision is used.
3177
Note: Take care to redirect standard output when using this command on a
3182
takes_options = ['directory',
3183
Option('name-from-revision', help='The path name in the old tree.'),
3184
Option('filters', help='Apply content filters to display the '
3185
'convenience form.'),
3188
takes_args = ['filename']
3189
encoding_type = 'exact'
3192
def run(self, filename, revision=None, name_from_revision=False,
3193
filters=False, directory=None):
3194
if revision is not None and len(revision) != 1:
3195
raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
3196
" one revision specifier"))
3197
tree, branch, relpath = \
3198
_open_directory_or_containing_tree_or_branch(filename, directory)
3199
self.add_cleanup(branch.lock_read().unlock)
3200
return self._run(tree, branch, relpath, filename, revision,
3201
name_from_revision, filters)
3203
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3206
tree = b.basis_tree()
3207
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3208
self.add_cleanup(rev_tree.lock_read().unlock)
3210
old_file_id = rev_tree.path2id(relpath)
3212
# TODO: Split out this code to something that generically finds the
3213
# best id for a path across one or more trees; it's like
3214
# find_ids_across_trees but restricted to find just one. -- mbp
3216
if name_from_revision:
3217
# Try in revision if requested
3218
if old_file_id is None:
3219
raise errors.BzrCommandError(gettext(
3220
"{0!r} is not present in revision {1}").format(
3221
filename, rev_tree.get_revision_id()))
3223
actual_file_id = old_file_id
3225
cur_file_id = tree.path2id(relpath)
3226
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3227
actual_file_id = cur_file_id
3228
elif old_file_id is not None:
3229
actual_file_id = old_file_id
3231
raise errors.BzrCommandError(gettext(
3232
"{0!r} is not present in revision {1}").format(
3233
filename, rev_tree.get_revision_id()))
3235
from bzrlib.filter_tree import ContentFilterTree
3236
filter_tree = ContentFilterTree(rev_tree,
3237
rev_tree._content_filter_stack)
3238
content = filter_tree.get_file_text(actual_file_id)
3240
content = rev_tree.get_file_text(actual_file_id)
3242
self.outf.write(content)
3245
class cmd_local_time_offset(Command):
3246
__doc__ = """Show the offset in seconds from GMT to local time."""
3250
self.outf.write("%s\n" % osutils.local_time_offset())
3254
class cmd_commit(Command):
3255
__doc__ = """Commit changes into a new revision.
3257
An explanatory message needs to be given for each commit. This is
3258
often done by using the --message option (getting the message from the
3259
command line) or by using the --file option (getting the message from
3260
a file). If neither of these options is given, an editor is opened for
3261
the user to enter the message. To see the changed files in the
3262
boilerplate text loaded into the editor, use the --show-diff option.
3264
By default, the entire tree is committed and the person doing the
3265
commit is assumed to be the author. These defaults can be overridden
3270
If selected files are specified, only changes to those files are
3271
committed. If a directory is specified then the directory and
3272
everything within it is committed.
3274
When excludes are given, they take precedence over selected files.
3275
For example, to commit only changes within foo, but not changes
3278
bzr commit foo -x foo/bar
3280
A selective commit after a merge is not yet supported.
3284
If the author of the change is not the same person as the committer,
3285
you can specify the author's name using the --author option. The
3286
name should be in the same format as a committer-id, e.g.
3287
"John Doe <jdoe@example.com>". If there is more than one author of
3288
the change you can specify the option multiple times, once for each
3293
A common mistake is to forget to add a new file or directory before
3294
running the commit command. The --strict option checks for unknown
3295
files and aborts the commit if any are found. More advanced pre-commit
3296
checks can be implemented by defining hooks. See ``bzr help hooks``
3301
If you accidentially commit the wrong changes or make a spelling
3302
mistake in the commit message say, you can use the uncommit command
3303
to undo it. See ``bzr help uncommit`` for details.
3305
Hooks can also be configured to run after a commit. This allows you
3306
to trigger updates to external systems like bug trackers. The --fixes
3307
option can be used to record the association between a revision and
3308
one or more bugs. See ``bzr help bugs`` for details.
3311
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3312
takes_args = ['selected*']
3314
ListOption('exclude', type=str, short_name='x',
3315
help="Do not consider changes made to a given path."),
3316
Option('message', type=unicode,
3318
help="Description of the new revision."),
3321
help='Commit even if nothing has changed.'),
3322
Option('file', type=str,
3325
help='Take commit message from this file.'),
3327
help="Refuse to commit if there are unknown "
3328
"files in the working tree."),
3329
Option('commit-time', type=str,
3330
help="Manually set a commit time using commit date "
3331
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3332
ListOption('fixes', type=str,
3333
help="Mark a bug as being fixed by this revision "
3334
"(see \"bzr help bugs\")."),
3335
ListOption('author', type=unicode,
3336
help="Set the author's name, if it's different "
3337
"from the committer."),
3339
help="Perform a local commit in a bound "
3340
"branch. Local commits are not pushed to "
3341
"the master branch until a normal commit "
3344
Option('show-diff', short_name='p',
3345
help='When no message is supplied, show the diff along'
3346
' with the status summary in the message editor.'),
3348
help='When committing to a foreign version control '
3349
'system do not push data that can not be natively '
3352
aliases = ['ci', 'checkin']
3354
def _iter_bug_fix_urls(self, fixes, branch):
3355
default_bugtracker = None
3356
# Configure the properties for bug fixing attributes.
3357
for fixed_bug in fixes:
3358
tokens = fixed_bug.split(':')
3359
if len(tokens) == 1:
3360
if default_bugtracker is None:
3361
branch_config = branch.get_config()
3362
default_bugtracker = branch_config.get_user_option(
3364
if default_bugtracker is None:
3365
raise errors.BzrCommandError(gettext(
3366
"No tracker specified for bug %s. Use the form "
3367
"'tracker:id' or specify a default bug tracker "
3368
"using the `bugtracker` option.\nSee "
3369
"\"bzr help bugs\" for more information on this "
3370
"feature. Commit refused.") % fixed_bug)
3371
tag = default_bugtracker
3373
elif len(tokens) != 2:
3374
raise errors.BzrCommandError(gettext(
3375
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3376
"See \"bzr help bugs\" for more information on this "
3377
"feature.\nCommit refused.") % fixed_bug)
3379
tag, bug_id = tokens
3381
yield bugtracker.get_bug_url(tag, branch, bug_id)
3382
except errors.UnknownBugTrackerAbbreviation:
3383
raise errors.BzrCommandError(gettext(
3384
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3385
except errors.MalformedBugIdentifier, e:
3386
raise errors.BzrCommandError(gettext(
3387
"%s\nCommit refused.") % (str(e),))
3389
def run(self, message=None, file=None, verbose=False, selected_list=None,
3390
unchanged=False, strict=False, local=False, fixes=None,
3391
author=None, show_diff=False, exclude=None, commit_time=None,
3393
from bzrlib.errors import (
3398
from bzrlib.msgeditor import (
3399
edit_commit_message_encoded,
3400
generate_commit_message_template,
3401
make_commit_message_template_encoded,
3405
commit_stamp = offset = None
3406
if commit_time is not None:
3408
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3409
except ValueError, e:
3410
raise errors.BzrCommandError(gettext(
3411
"Could not parse --commit-time: " + str(e)))
3415
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3416
if selected_list == ['']:
3417
# workaround - commit of root of tree should be exactly the same
3418
# as just default commit in that tree, and succeed even though
3419
# selected-file merge commit is not done yet
3424
bug_property = bugtracker.encode_fixes_bug_urls(
3425
self._iter_bug_fix_urls(fixes, tree.branch))
3427
properties['bugs'] = bug_property
3429
if local and not tree.branch.get_bound_location():
3430
raise errors.LocalRequiresBoundBranch()
3432
if message is not None:
3434
file_exists = osutils.lexists(message)
3435
except UnicodeError:
3436
# The commit message contains unicode characters that can't be
3437
# represented in the filesystem encoding, so that can't be a
3442
'The commit message is a file name: "%(f)s".\n'
3443
'(use --file "%(f)s" to take commit message from that file)'
3445
ui.ui_factory.show_warning(warning_msg)
3447
message = message.replace('\r\n', '\n')
3448
message = message.replace('\r', '\n')
3450
raise errors.BzrCommandError(gettext(
3451
"please specify either --message or --file"))
3453
def get_message(commit_obj):
3454
"""Callback to get commit message"""
3458
my_message = f.read().decode(osutils.get_user_encoding())
3461
elif message is not None:
3462
my_message = message
3464
# No message supplied: make one up.
3465
# text is the status of the tree
3466
text = make_commit_message_template_encoded(tree,
3467
selected_list, diff=show_diff,
3468
output_encoding=osutils.get_user_encoding())
3469
# start_message is the template generated from hooks
3470
# XXX: Warning - looks like hooks return unicode,
3471
# make_commit_message_template_encoded returns user encoding.
3472
# We probably want to be using edit_commit_message instead to
3474
my_message = set_commit_message(commit_obj)
3475
if my_message is None:
3476
start_message = generate_commit_message_template(commit_obj)
3477
my_message = edit_commit_message_encoded(text,
3478
start_message=start_message)
3479
if my_message is None:
3480
raise errors.BzrCommandError(gettext("please specify a commit"
3481
" message with either --message or --file"))
3482
if my_message == "":
3483
raise errors.BzrCommandError(gettext("Empty commit message specified."
3484
" Please specify a commit message with either"
3485
" --message or --file or leave a blank message"
3486
" with --message \"\"."))
3489
# The API permits a commit with a filter of [] to mean 'select nothing'
3490
# but the command line should not do that.
3491
if not selected_list:
3492
selected_list = None
3494
tree.commit(message_callback=get_message,
3495
specific_files=selected_list,
3496
allow_pointless=unchanged, strict=strict, local=local,
3497
reporter=None, verbose=verbose, revprops=properties,
3498
authors=author, timestamp=commit_stamp,
3500
exclude=tree.safe_relpath_files(exclude),
3502
except PointlessCommit:
3503
raise errors.BzrCommandError(gettext("No changes to commit."
3504
" Please 'bzr add' the files you want to commit, or use"
3505
" --unchanged to force an empty commit."))
3506
except ConflictsInTree:
3507
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3508
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3510
except StrictCommitFailed:
3511
raise errors.BzrCommandError(gettext("Commit refused because there are"
3512
" unknown files in the working tree."))
3513
except errors.BoundBranchOutOfDate, e:
3514
e.extra_help = (gettext("\n"
3515
'To commit to master branch, run update and then commit.\n'
3516
'You can also pass --local to commit to continue working '
3521
class cmd_check(Command):
3522
__doc__ = """Validate working tree structure, branch consistency and repository history.
3524
This command checks various invariants about branch and repository storage
3525
to detect data corruption or bzr bugs.
3527
The working tree and branch checks will only give output if a problem is
3528
detected. The output fields of the repository check are:
3531
This is just the number of revisions checked. It doesn't
3535
This is just the number of versionedfiles checked. It
3536
doesn't indicate a problem.
3538
unreferenced ancestors
3539
Texts that are ancestors of other texts, but
3540
are not properly referenced by the revision ancestry. This is a
3541
subtle problem that Bazaar can work around.
3544
This is the total number of unique file contents
3545
seen in the checked revisions. It does not indicate a problem.
3548
This is the total number of repeated texts seen
3549
in the checked revisions. Texts can be repeated when their file
3550
entries are modified, but the file contents are not. It does not
3553
If no restrictions are specified, all Bazaar data that is found at the given
3554
location will be checked.
3558
Check the tree and branch at 'foo'::
3560
bzr check --tree --branch foo
3562
Check only the repository at 'bar'::
3564
bzr check --repo bar
3566
Check everything at 'baz'::
3571
_see_also = ['reconcile']
3572
takes_args = ['path?']
3573
takes_options = ['verbose',
3574
Option('branch', help="Check the branch related to the"
3575
" current directory."),
3576
Option('repo', help="Check the repository related to the"
3577
" current directory."),
3578
Option('tree', help="Check the working tree related to"
3579
" the current directory.")]
3581
def run(self, path=None, verbose=False, branch=False, repo=False,
3583
from bzrlib.check import check_dwim
3586
if not branch and not repo and not tree:
3587
branch = repo = tree = True
3588
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3591
class cmd_upgrade(Command):
3592
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3594
When the default format has changed after a major new release of
3595
Bazaar, you may be informed during certain operations that you
3596
should upgrade. Upgrading to a newer format may improve performance
3597
or make new features available. It may however limit interoperability
3598
with older repositories or with older versions of Bazaar.
3600
If you wish to upgrade to a particular format rather than the
3601
current default, that can be specified using the --format option.
3602
As a consequence, you can use the upgrade command this way to
3603
"downgrade" to an earlier format, though some conversions are
3604
a one way process (e.g. changing from the 1.x default to the
3605
2.x default) so downgrading is not always possible.
3607
A backup.bzr.~#~ directory is created at the start of the conversion
3608
process (where # is a number). By default, this is left there on
3609
completion. If the conversion fails, delete the new .bzr directory
3610
and rename this one back in its place. Use the --clean option to ask
3611
for the backup.bzr directory to be removed on successful conversion.
3612
Alternatively, you can delete it by hand if everything looks good
3615
If the location given is a shared repository, dependent branches
3616
are also converted provided the repository converts successfully.
3617
If the conversion of a branch fails, remaining branches are still
3620
For more information on upgrades, see the Bazaar Upgrade Guide,
3621
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3624
_see_also = ['check', 'reconcile', 'formats']
3625
takes_args = ['url?']
3627
RegistryOption('format',
3628
help='Upgrade to a specific format. See "bzr help'
3629
' formats" for details.',
3630
lazy_registry=('bzrlib.controldir', 'format_registry'),
3631
converter=lambda name: controldir.format_registry.make_bzrdir(name),
3632
value_switches=True, title='Branch format'),
3634
help='Remove the backup.bzr directory if successful.'),
3636
help="Show what would be done, but don't actually do anything."),
3639
def run(self, url='.', format=None, clean=False, dry_run=False):
3640
from bzrlib.upgrade import upgrade
3641
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3643
if len(exceptions) == 1:
3644
# Compatibility with historical behavior
3650
class cmd_whoami(Command):
3651
__doc__ = """Show or set bzr user id.
3654
Show the email of the current user::
3658
Set the current user::
3660
bzr whoami "Frank Chu <fchu@example.com>"
3662
takes_options = [ 'directory',
3664
help='Display email address only.'),
3666
help='Set identity for the current branch instead of '
3669
takes_args = ['name?']
3670
encoding_type = 'replace'
3673
def run(self, email=False, branch=False, name=None, directory=None):
3675
if directory is None:
3676
# use branch if we're inside one; otherwise global config
3678
c = Branch.open_containing(u'.')[0].get_config()
3679
except errors.NotBranchError:
3680
c = _mod_config.GlobalConfig()
3682
c = Branch.open(directory).get_config()
3684
self.outf.write(c.user_email() + '\n')
3686
self.outf.write(c.username() + '\n')
3690
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3693
# display a warning if an email address isn't included in the given name.
3695
_mod_config.extract_email_address(name)
3696
except errors.NoEmailInUsername, e:
3697
warning('"%s" does not seem to contain an email address. '
3698
'This is allowed, but not recommended.', name)
3700
# use global config unless --branch given
3702
if directory is None:
3703
c = Branch.open_containing(u'.')[0].get_config()
3705
c = Branch.open(directory).get_config()
3707
c = _mod_config.GlobalConfig()
3708
c.set_user_option('email', name)
3711
class cmd_nick(Command):
3712
__doc__ = """Print or set the branch nickname.
3714
If unset, the tree root directory name is used as the nickname.
3715
To print the current nickname, execute with no argument.
3717
Bound branches use the nickname of its master branch unless it is set
3721
_see_also = ['info']
3722
takes_args = ['nickname?']
3723
takes_options = ['directory']
3724
def run(self, nickname=None, directory=u'.'):
3725
branch = Branch.open_containing(directory)[0]
3726
if nickname is None:
3727
self.printme(branch)
3729
branch.nick = nickname
3732
def printme(self, branch):
3733
self.outf.write('%s\n' % branch.nick)
3736
class cmd_alias(Command):
3737
__doc__ = """Set/unset and display aliases.
3740
Show the current aliases::
3744
Show the alias specified for 'll'::
3748
Set an alias for 'll'::
3750
bzr alias ll="log --line -r-10..-1"
3752
To remove an alias for 'll'::
3754
bzr alias --remove ll
3757
takes_args = ['name?']
3759
Option('remove', help='Remove the alias.'),
3762
def run(self, name=None, remove=False):
3764
self.remove_alias(name)
3766
self.print_aliases()
3768
equal_pos = name.find('=')
3770
self.print_alias(name)
3772
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3774
def remove_alias(self, alias_name):
3775
if alias_name is None:
3776
raise errors.BzrCommandError(gettext(
3777
'bzr alias --remove expects an alias to remove.'))
3778
# If alias is not found, print something like:
3779
# unalias: foo: not found
3780
c = _mod_config.GlobalConfig()
3781
c.unset_alias(alias_name)
3784
def print_aliases(self):
3785
"""Print out the defined aliases in a similar format to bash."""
3786
aliases = _mod_config.GlobalConfig().get_aliases()
3787
for key, value in sorted(aliases.iteritems()):
3788
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3791
def print_alias(self, alias_name):
3792
from bzrlib.commands import get_alias
3793
alias = get_alias(alias_name)
3795
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3798
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3800
def set_alias(self, alias_name, alias_command):
3801
"""Save the alias in the global config."""
3802
c = _mod_config.GlobalConfig()
3803
c.set_alias(alias_name, alias_command)
3806
class cmd_selftest(Command):
3807
__doc__ = """Run internal test suite.
3809
If arguments are given, they are regular expressions that say which tests
3810
should run. Tests matching any expression are run, and other tests are
3813
Alternatively if --first is given, matching tests are run first and then
3814
all other tests are run. This is useful if you have been working in a
3815
particular area, but want to make sure nothing else was broken.
3817
If --exclude is given, tests that match that regular expression are
3818
excluded, regardless of whether they match --first or not.
3820
To help catch accidential dependencies between tests, the --randomize
3821
option is useful. In most cases, the argument used is the word 'now'.
3822
Note that the seed used for the random number generator is displayed
3823
when this option is used. The seed can be explicitly passed as the
3824
argument to this option if required. This enables reproduction of the
3825
actual ordering used if and when an order sensitive problem is encountered.
3827
If --list-only is given, the tests that would be run are listed. This is
3828
useful when combined with --first, --exclude and/or --randomize to
3829
understand their impact. The test harness reports "Listed nn tests in ..."
3830
instead of "Ran nn tests in ..." when list mode is enabled.
3832
If the global option '--no-plugins' is given, plugins are not loaded
3833
before running the selftests. This has two effects: features provided or
3834
modified by plugins will not be tested, and tests provided by plugins will
3837
Tests that need working space on disk use a common temporary directory,
3838
typically inside $TMPDIR or /tmp.
3840
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3841
into a pdb postmortem session.
3843
The --coverage=DIRNAME global option produces a report with covered code
3847
Run only tests relating to 'ignore'::
3851
Disable plugins and list tests as they're run::
3853
bzr --no-plugins selftest -v
3855
# NB: this is used from the class without creating an instance, which is
3856
# why it does not have a self parameter.
3857
def get_transport_type(typestring):
3858
"""Parse and return a transport specifier."""
3859
if typestring == "sftp":
3860
from bzrlib.tests import stub_sftp
3861
return stub_sftp.SFTPAbsoluteServer
3862
elif typestring == "memory":
3863
from bzrlib.tests import test_server
3864
return memory.MemoryServer
3865
elif typestring == "fakenfs":
3866
from bzrlib.tests import test_server
3867
return test_server.FakeNFSServer
3868
msg = "No known transport type %s. Supported types are: sftp\n" %\
3870
raise errors.BzrCommandError(msg)
3873
takes_args = ['testspecs*']
3874
takes_options = ['verbose',
3876
help='Stop when one test fails.',
3880
help='Use a different transport by default '
3881
'throughout the test suite.',
3882
type=get_transport_type),
3884
help='Run the benchmarks rather than selftests.',
3886
Option('lsprof-timed',
3887
help='Generate lsprof output for benchmarked'
3888
' sections of code.'),
3889
Option('lsprof-tests',
3890
help='Generate lsprof output for each test.'),
3892
help='Run all tests, but run specified tests first.',
3896
help='List the tests instead of running them.'),
3897
RegistryOption('parallel',
3898
help="Run the test suite in parallel.",
3899
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3900
value_switches=False,
3902
Option('randomize', type=str, argname="SEED",
3903
help='Randomize the order of tests using the given'
3904
' seed or "now" for the current time.'),
3905
ListOption('exclude', type=str, argname="PATTERN",
3907
help='Exclude tests that match this regular'
3910
help='Output test progress via subunit.'),
3911
Option('strict', help='Fail on missing dependencies or '
3913
Option('load-list', type=str, argname='TESTLISTFILE',
3914
help='Load a test id list from a text file.'),
3915
ListOption('debugflag', type=str, short_name='E',
3916
help='Turn on a selftest debug flag.'),
3917
ListOption('starting-with', type=str, argname='TESTID',
3918
param_name='starting_with', short_name='s',
3920
'Load only the tests starting with TESTID.'),
3922
help="By default we disable fsync and fdatasync"
3923
" while running the test suite.")
3925
encoding_type = 'replace'
3928
Command.__init__(self)
3929
self.additional_selftest_args = {}
3931
def run(self, testspecs_list=None, verbose=False, one=False,
3932
transport=None, benchmark=None,
3934
first=False, list_only=False,
3935
randomize=None, exclude=None, strict=False,
3936
load_list=None, debugflag=None, starting_with=None, subunit=False,
3937
parallel=None, lsprof_tests=False,
3939
from bzrlib import tests
3941
if testspecs_list is not None:
3942
pattern = '|'.join(testspecs_list)
3947
from bzrlib.tests import SubUnitBzrRunner
3949
raise errors.BzrCommandError(gettext("subunit not available. subunit "
3950
"needs to be installed to use --subunit."))
3951
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3952
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3953
# stdout, which would corrupt the subunit stream.
3954
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3955
# following code can be deleted when it's sufficiently deployed
3956
# -- vila/mgz 20100514
3957
if (sys.platform == "win32"
3958
and getattr(sys.stdout, 'fileno', None) is not None):
3960
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3962
self.additional_selftest_args.setdefault(
3963
'suite_decorators', []).append(parallel)
3965
raise errors.BzrCommandError(gettext(
3966
"--benchmark is no longer supported from bzr 2.2; "
3967
"use bzr-usertest instead"))
3968
test_suite_factory = None
3970
exclude_pattern = None
3972
exclude_pattern = '(' + '|'.join(exclude) + ')'
3974
self._disable_fsync()
3975
selftest_kwargs = {"verbose": verbose,
3977
"stop_on_failure": one,
3978
"transport": transport,
3979
"test_suite_factory": test_suite_factory,
3980
"lsprof_timed": lsprof_timed,
3981
"lsprof_tests": lsprof_tests,
3982
"matching_tests_first": first,
3983
"list_only": list_only,
3984
"random_seed": randomize,
3985
"exclude_pattern": exclude_pattern,
3987
"load_list": load_list,
3988
"debug_flags": debugflag,
3989
"starting_with": starting_with
3991
selftest_kwargs.update(self.additional_selftest_args)
3993
# Make deprecation warnings visible, unless -Werror is set
3994
cleanup = symbol_versioning.activate_deprecation_warnings(
3997
result = tests.selftest(**selftest_kwargs)
4000
return int(not result)
4002
def _disable_fsync(self):
4003
"""Change the 'os' functionality to not synchronize."""
4004
self._orig_fsync = getattr(os, 'fsync', None)
4005
if self._orig_fsync is not None:
4006
os.fsync = lambda filedes: None
4007
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4008
if self._orig_fdatasync is not None:
4009
os.fdatasync = lambda filedes: None
4012
class cmd_version(Command):
4013
__doc__ = """Show version of bzr."""
4015
encoding_type = 'replace'
4017
Option("short", help="Print just the version number."),
4021
def run(self, short=False):
4022
from bzrlib.version import show_version
4024
self.outf.write(bzrlib.version_string + '\n')
4026
show_version(to_file=self.outf)
4029
class cmd_rocks(Command):
4030
__doc__ = """Statement of optimism."""
4036
self.outf.write(gettext("It sure does!\n"))
4039
class cmd_find_merge_base(Command):
4040
__doc__ = """Find and print a base revision for merging two branches."""
4041
# TODO: Options to specify revisions on either side, as if
4042
# merging only part of the history.
4043
takes_args = ['branch', 'other']
4047
def run(self, branch, other):
4048
from bzrlib.revision import ensure_null
4050
branch1 = Branch.open_containing(branch)[0]
4051
branch2 = Branch.open_containing(other)[0]
4052
self.add_cleanup(branch1.lock_read().unlock)
4053
self.add_cleanup(branch2.lock_read().unlock)
4054
last1 = ensure_null(branch1.last_revision())
4055
last2 = ensure_null(branch2.last_revision())
4057
graph = branch1.repository.get_graph(branch2.repository)
4058
base_rev_id = graph.find_unique_lca(last1, last2)
4060
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4063
class cmd_merge(Command):
4064
__doc__ = """Perform a three-way merge.
4066
The source of the merge can be specified either in the form of a branch,
4067
or in the form of a path to a file containing a merge directive generated
4068
with bzr send. If neither is specified, the default is the upstream branch
4069
or the branch most recently merged using --remember. The source of the
4070
merge may also be specified in the form of a path to a file in another
4071
branch: in this case, only the modifications to that file are merged into
4072
the current working tree.
4074
When merging from a branch, by default bzr will try to merge in all new
4075
work from the other branch, automatically determining an appropriate base
4076
revision. If this fails, you may need to give an explicit base.
4078
To pick a different ending revision, pass "--revision OTHER". bzr will
4079
try to merge in all new work up to and including revision OTHER.
4081
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4082
through OTHER, excluding BASE but including OTHER, will be merged. If this
4083
causes some revisions to be skipped, i.e. if the destination branch does
4084
not already contain revision BASE, such a merge is commonly referred to as
4085
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4086
cherrypicks. The changes look like a normal commit, and the history of the
4087
changes from the other branch is not stored in the commit.
4089
Revision numbers are always relative to the source branch.
4091
Merge will do its best to combine the changes in two branches, but there
4092
are some kinds of problems only a human can fix. When it encounters those,
4093
it will mark a conflict. A conflict means that you need to fix something,
4094
before you should commit.
4096
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
4098
If there is no default branch set, the first merge will set it (use
4099
--no-remember to avoid setting it). After that, you can omit the branch
4100
to use the default. To change the default, use --remember. The value will
4101
only be saved if the remote location can be accessed.
4103
The results of the merge are placed into the destination working
4104
directory, where they can be reviewed (with bzr diff), tested, and then
4105
committed to record the result of the merge.
4107
merge refuses to run if there are any uncommitted changes, unless
4108
--force is given. If --force is given, then the changes from the source
4109
will be merged with the current working tree, including any uncommitted
4110
changes in the tree. The --force option can also be used to create a
4111
merge revision which has more than two parents.
4113
If one would like to merge changes from the working tree of the other
4114
branch without merging any committed revisions, the --uncommitted option
4117
To select only some changes to merge, use "merge -i", which will prompt
4118
you to apply each diff hunk and file change, similar to "shelve".
4121
To merge all new revisions from bzr.dev::
4123
bzr merge ../bzr.dev
4125
To merge changes up to and including revision 82 from bzr.dev::
4127
bzr merge -r 82 ../bzr.dev
4129
To merge the changes introduced by 82, without previous changes::
4131
bzr merge -r 81..82 ../bzr.dev
4133
To apply a merge directive contained in /tmp/merge::
4135
bzr merge /tmp/merge
4137
To create a merge revision with three parents from two branches
4138
feature1a and feature1b:
4140
bzr merge ../feature1a
4141
bzr merge ../feature1b --force
4142
bzr commit -m 'revision with three parents'
4145
encoding_type = 'exact'
4146
_see_also = ['update', 'remerge', 'status-flags', 'send']
4147
takes_args = ['location?']
4152
help='Merge even if the destination tree has uncommitted changes.'),
4156
Option('show-base', help="Show base revision text in "
4158
Option('uncommitted', help='Apply uncommitted changes'
4159
' from a working copy, instead of branch changes.'),
4160
Option('pull', help='If the destination is already'
4161
' completely merged into the source, pull from the'
4162
' source rather than merging. When this happens,'
4163
' you do not need to commit the result.'),
4164
custom_help('directory',
4165
help='Branch to merge into, '
4166
'rather than the one containing the working directory.'),
4167
Option('preview', help='Instead of merging, show a diff of the'
4169
Option('interactive', help='Select changes interactively.',
4173
def run(self, location=None, revision=None, force=False,
4174
merge_type=None, show_base=False, reprocess=None, remember=None,
4175
uncommitted=False, pull=False,
4180
if merge_type is None:
4181
merge_type = _mod_merge.Merge3Merger
4183
if directory is None: directory = u'.'
4184
possible_transports = []
4186
allow_pending = True
4187
verified = 'inapplicable'
4189
tree = WorkingTree.open_containing(directory)[0]
4190
if tree.branch.revno() == 0:
4191
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4192
'https://bugs.launchpad.net/bzr/+bug/308562'))
4195
basis_tree = tree.revision_tree(tree.last_revision())
4196
except errors.NoSuchRevision:
4197
basis_tree = tree.basis_tree()
4199
# die as quickly as possible if there are uncommitted changes
4201
if tree.has_changes():
4202
raise errors.UncommittedChanges(tree)
4204
view_info = _get_view_info_for_change_reporter(tree)
4205
change_reporter = delta._ChangeReporter(
4206
unversioned_filter=tree.is_ignored, view_info=view_info)
4207
pb = ui.ui_factory.nested_progress_bar()
4208
self.add_cleanup(pb.finished)
4209
self.add_cleanup(tree.lock_write().unlock)
4210
if location is not None:
4212
mergeable = bundle.read_mergeable_from_url(location,
4213
possible_transports=possible_transports)
4214
except errors.NotABundle:
4218
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4219
' with bundles or merge directives.'))
4221
if revision is not None:
4222
raise errors.BzrCommandError(gettext(
4223
'Cannot use -r with merge directives or bundles'))
4224
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4227
if merger is None and uncommitted:
4228
if revision is not None and len(revision) > 0:
4229
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4230
' --revision at the same time.'))
4231
merger = self.get_merger_from_uncommitted(tree, location, None)
4232
allow_pending = False
4235
merger, allow_pending = self._get_merger_from_branch(tree,
4236
location, revision, remember, possible_transports, None)
4238
merger.merge_type = merge_type
4239
merger.reprocess = reprocess
4240
merger.show_base = show_base
4241
self.sanity_check_merger(merger)
4242
if (merger.base_rev_id == merger.other_rev_id and
4243
merger.other_rev_id is not None):
4244
# check if location is a nonexistent file (and not a branch) to
4245
# disambiguate the 'Nothing to do'
4246
if merger.interesting_files:
4247
if not merger.other_tree.has_filename(
4248
merger.interesting_files[0]):
4249
note(gettext("merger: ") + str(merger))
4250
raise errors.PathsDoNotExist([location])
4251
note(gettext('Nothing to do.'))
4253
if pull and not preview:
4254
if merger.interesting_files is not None:
4255
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4256
if (merger.base_rev_id == tree.last_revision()):
4257
result = tree.pull(merger.other_branch, False,
4258
merger.other_rev_id)
4259
result.report(self.outf)
4261
if merger.this_basis is None:
4262
raise errors.BzrCommandError(gettext(
4263
"This branch has no commits."
4264
" (perhaps you would prefer 'bzr pull')"))
4266
return self._do_preview(merger)
4268
return self._do_interactive(merger)
4270
return self._do_merge(merger, change_reporter, allow_pending,
4273
def _get_preview(self, merger):
4274
tree_merger = merger.make_merger()
4275
tt = tree_merger.make_preview_transform()
4276
self.add_cleanup(tt.finalize)
4277
result_tree = tt.get_preview_tree()
4280
def _do_preview(self, merger):
4281
from bzrlib.diff import show_diff_trees
4282
result_tree = self._get_preview(merger)
4283
path_encoding = osutils.get_diff_header_encoding()
4284
show_diff_trees(merger.this_tree, result_tree, self.outf,
4285
old_label='', new_label='',
4286
path_encoding=path_encoding)
4288
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4289
merger.change_reporter = change_reporter
4290
conflict_count = merger.do_merge()
4292
merger.set_pending()
4293
if verified == 'failed':
4294
warning('Preview patch does not match changes')
4295
if conflict_count != 0:
4300
def _do_interactive(self, merger):
4301
"""Perform an interactive merge.
4303
This works by generating a preview tree of the merge, then using
4304
Shelver to selectively remove the differences between the working tree
4305
and the preview tree.
4307
from bzrlib import shelf_ui
4308
result_tree = self._get_preview(merger)
4309
writer = bzrlib.option.diff_writer_registry.get()
4310
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4311
reporter=shelf_ui.ApplyReporter(),
4312
diff_writer=writer(sys.stdout))
4318
def sanity_check_merger(self, merger):
4319
if (merger.show_base and
4320
not merger.merge_type is _mod_merge.Merge3Merger):
4321
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4322
" merge type. %s") % merger.merge_type)
4323
if merger.reprocess is None:
4324
if merger.show_base:
4325
merger.reprocess = False
4327
# Use reprocess if the merger supports it
4328
merger.reprocess = merger.merge_type.supports_reprocess
4329
if merger.reprocess and not merger.merge_type.supports_reprocess:
4330
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4331
" for merge type %s.") %
4333
if merger.reprocess and merger.show_base:
4334
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4337
def _get_merger_from_branch(self, tree, location, revision, remember,
4338
possible_transports, pb):
4339
"""Produce a merger from a location, assuming it refers to a branch."""
4340
from bzrlib.tag import _merge_tags_if_possible
4341
# find the branch locations
4342
other_loc, user_location = self._select_branch_location(tree, location,
4344
if revision is not None and len(revision) == 2:
4345
base_loc, _unused = self._select_branch_location(tree,
4346
location, revision, 0)
4348
base_loc = other_loc
4350
other_branch, other_path = Branch.open_containing(other_loc,
4351
possible_transports)
4352
if base_loc == other_loc:
4353
base_branch = other_branch
4355
base_branch, base_path = Branch.open_containing(base_loc,
4356
possible_transports)
4357
# Find the revision ids
4358
other_revision_id = None
4359
base_revision_id = None
4360
if revision is not None:
4361
if len(revision) >= 1:
4362
other_revision_id = revision[-1].as_revision_id(other_branch)
4363
if len(revision) == 2:
4364
base_revision_id = revision[0].as_revision_id(base_branch)
4365
if other_revision_id is None:
4366
other_revision_id = _mod_revision.ensure_null(
4367
other_branch.last_revision())
4368
# Remember where we merge from. We need to remember if:
4369
# - user specify a location (and we don't merge from the parent
4371
# - user ask to remember or there is no previous location set to merge
4372
# from and user didn't ask to *not* remember
4373
if (user_location is not None
4375
or (remember is None
4376
and tree.branch.get_submit_branch() is None)))):
4377
tree.branch.set_submit_branch(other_branch.base)
4378
# Merge tags (but don't set them in the master branch yet, the user
4379
# might revert this merge). Commit will propagate them.
4380
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4381
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4382
other_revision_id, base_revision_id, other_branch, base_branch)
4383
if other_path != '':
4384
allow_pending = False
4385
merger.interesting_files = [other_path]
4387
allow_pending = True
4388
return merger, allow_pending
4390
def get_merger_from_uncommitted(self, tree, location, pb):
4391
"""Get a merger for uncommitted changes.
4393
:param tree: The tree the merger should apply to.
4394
:param location: The location containing uncommitted changes.
4395
:param pb: The progress bar to use for showing progress.
4397
location = self._select_branch_location(tree, location)[0]
4398
other_tree, other_path = WorkingTree.open_containing(location)
4399
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4400
if other_path != '':
4401
merger.interesting_files = [other_path]
4404
def _select_branch_location(self, tree, user_location, revision=None,
4406
"""Select a branch location, according to possible inputs.
4408
If provided, branches from ``revision`` are preferred. (Both
4409
``revision`` and ``index`` must be supplied.)
4411
Otherwise, the ``location`` parameter is used. If it is None, then the
4412
``submit`` or ``parent`` location is used, and a note is printed.
4414
:param tree: The working tree to select a branch for merging into
4415
:param location: The location entered by the user
4416
:param revision: The revision parameter to the command
4417
:param index: The index to use for the revision parameter. Negative
4418
indices are permitted.
4419
:return: (selected_location, user_location). The default location
4420
will be the user-entered location.
4422
if (revision is not None and index is not None
4423
and revision[index] is not None):
4424
branch = revision[index].get_branch()
4425
if branch is not None:
4426
return branch, branch
4427
if user_location is None:
4428
location = self._get_remembered(tree, 'Merging from')
4430
location = user_location
4431
return location, user_location
4433
def _get_remembered(self, tree, verb_string):
4434
"""Use tree.branch's parent if none was supplied.
4436
Report if the remembered location was used.
4438
stored_location = tree.branch.get_submit_branch()
4439
stored_location_type = "submit"
4440
if stored_location is None:
4441
stored_location = tree.branch.get_parent()
4442
stored_location_type = "parent"
4443
mutter("%s", stored_location)
4444
if stored_location is None:
4445
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4446
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4447
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4448
stored_location_type, display_url))
4449
return stored_location
4452
class cmd_remerge(Command):
4453
__doc__ = """Redo a merge.
4455
Use this if you want to try a different merge technique while resolving
4456
conflicts. Some merge techniques are better than others, and remerge
4457
lets you try different ones on different files.
4459
The options for remerge have the same meaning and defaults as the ones for
4460
merge. The difference is that remerge can (only) be run when there is a
4461
pending merge, and it lets you specify particular files.
4464
Re-do the merge of all conflicted files, and show the base text in
4465
conflict regions, in addition to the usual THIS and OTHER texts::
4467
bzr remerge --show-base
4469
Re-do the merge of "foobar", using the weave merge algorithm, with
4470
additional processing to reduce the size of conflict regions::
4472
bzr remerge --merge-type weave --reprocess foobar
4474
takes_args = ['file*']
4479
help="Show base revision text in conflicts."),
4482
def run(self, file_list=None, merge_type=None, show_base=False,
4484
from bzrlib.conflicts import restore
4485
if merge_type is None:
4486
merge_type = _mod_merge.Merge3Merger
4487
tree, file_list = WorkingTree.open_containing_paths(file_list)
4488
self.add_cleanup(tree.lock_write().unlock)
4489
parents = tree.get_parent_ids()
4490
if len(parents) != 2:
4491
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4492
" merges. Not cherrypicking or"
4494
repository = tree.branch.repository
4495
interesting_ids = None
4497
conflicts = tree.conflicts()
4498
if file_list is not None:
4499
interesting_ids = set()
4500
for filename in file_list:
4501
file_id = tree.path2id(filename)
4503
raise errors.NotVersionedError(filename)
4504
interesting_ids.add(file_id)
4505
if tree.kind(file_id) != "directory":
4508
for name, ie in tree.inventory.iter_entries(file_id):
4509
interesting_ids.add(ie.file_id)
4510
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4512
# Remerge only supports resolving contents conflicts
4513
allowed_conflicts = ('text conflict', 'contents conflict')
4514
restore_files = [c.path for c in conflicts
4515
if c.typestring in allowed_conflicts]
4516
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4517
tree.set_conflicts(ConflictList(new_conflicts))
4518
if file_list is not None:
4519
restore_files = file_list
4520
for filename in restore_files:
4522
restore(tree.abspath(filename))
4523
except errors.NotConflicted:
4525
# Disable pending merges, because the file texts we are remerging
4526
# have not had those merges performed. If we use the wrong parents
4527
# list, we imply that the working tree text has seen and rejected
4528
# all the changes from the other tree, when in fact those changes
4529
# have not yet been seen.
4530
tree.set_parent_ids(parents[:1])
4532
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4533
merger.interesting_ids = interesting_ids
4534
merger.merge_type = merge_type
4535
merger.show_base = show_base
4536
merger.reprocess = reprocess
4537
conflicts = merger.do_merge()
4539
tree.set_parent_ids(parents)
4546
class cmd_revert(Command):
4547
__doc__ = """Revert files to a previous revision.
4549
Giving a list of files will revert only those files. Otherwise, all files
4550
will be reverted. If the revision is not specified with '--revision', the
4551
last committed revision is used.
4553
To remove only some changes, without reverting to a prior version, use
4554
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4555
will remove the changes introduced by the second last commit (-2), without
4556
affecting the changes introduced by the last commit (-1). To remove
4557
certain changes on a hunk-by-hunk basis, see the shelve command.
4559
By default, any files that have been manually changed will be backed up
4560
first. (Files changed only by merge are not backed up.) Backup files have
4561
'.~#~' appended to their name, where # is a number.
4563
When you provide files, you can use their current pathname or the pathname
4564
from the target revision. So you can use revert to "undelete" a file by
4565
name. If you name a directory, all the contents of that directory will be
4568
If you have newly added files since the target revision, they will be
4569
removed. If the files to be removed have been changed, backups will be
4570
created as above. Directories containing unknown files will not be
4573
The working tree contains a list of revisions that have been merged but
4574
not yet committed. These revisions will be included as additional parents
4575
of the next commit. Normally, using revert clears that list as well as
4576
reverting the files. If any files are specified, revert leaves the list
4577
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4578
.`` in the tree root to revert all files but keep the recorded merges,
4579
and ``bzr revert --forget-merges`` to clear the pending merge list without
4580
reverting any files.
4582
Using "bzr revert --forget-merges", it is possible to apply all of the
4583
changes from a branch in a single revision. To do this, perform the merge
4584
as desired. Then doing revert with the "--forget-merges" option will keep
4585
the content of the tree as it was, but it will clear the list of pending
4586
merges. The next commit will then contain all of the changes that are
4587
present in the other branch, but without any other parent revisions.
4588
Because this technique forgets where these changes originated, it may
4589
cause additional conflicts on later merges involving the same source and
4593
_see_also = ['cat', 'export', 'merge', 'shelve']
4596
Option('no-backup', "Do not save backups of reverted files."),
4597
Option('forget-merges',
4598
'Remove pending merge marker, without changing any files.'),
4600
takes_args = ['file*']
4602
def run(self, revision=None, no_backup=False, file_list=None,
4603
forget_merges=None):
4604
tree, file_list = WorkingTree.open_containing_paths(file_list)
4605
self.add_cleanup(tree.lock_tree_write().unlock)
4607
tree.set_parent_ids(tree.get_parent_ids()[:1])
4609
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4612
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4613
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4614
tree.revert(file_list, rev_tree, not no_backup, None,
4615
report_changes=True)
4618
class cmd_assert_fail(Command):
4619
__doc__ = """Test reporting of assertion failures"""
4620
# intended just for use in testing
4625
raise AssertionError("always fails")
4628
class cmd_help(Command):
4629
__doc__ = """Show help on a command or other topic.
4632
_see_also = ['topics']
4634
Option('long', 'Show help on all commands.'),
4636
takes_args = ['topic?']
4637
aliases = ['?', '--help', '-?', '-h']
4640
def run(self, topic=None, long=False):
4642
if topic is None and long:
4644
bzrlib.help.help(topic)
4647
class cmd_shell_complete(Command):
4648
__doc__ = """Show appropriate completions for context.
4650
For a list of all available commands, say 'bzr shell-complete'.
4652
takes_args = ['context?']
4657
def run(self, context=None):
4658
import shellcomplete
4659
shellcomplete.shellcomplete(context)
4662
class cmd_missing(Command):
4663
__doc__ = """Show unmerged/unpulled revisions between two branches.
4665
OTHER_BRANCH may be local or remote.
4667
To filter on a range of revisions, you can use the command -r begin..end
4668
-r revision requests a specific revision, -r ..end or -r begin.. are
4672
1 - some missing revisions
4673
0 - no missing revisions
4677
Determine the missing revisions between this and the branch at the
4678
remembered pull location::
4682
Determine the missing revisions between this and another branch::
4684
bzr missing http://server/branch
4686
Determine the missing revisions up to a specific revision on the other
4689
bzr missing -r ..-10
4691
Determine the missing revisions up to a specific revision on this
4694
bzr missing --my-revision ..-10
4697
_see_also = ['merge', 'pull']
4698
takes_args = ['other_branch?']
4701
Option('reverse', 'Reverse the order of revisions.'),
4703
'Display changes in the local branch only.'),
4704
Option('this' , 'Same as --mine-only.'),
4705
Option('theirs-only',
4706
'Display changes in the remote branch only.'),
4707
Option('other', 'Same as --theirs-only.'),
4711
custom_help('revision',
4712
help='Filter on other branch revisions (inclusive). '
4713
'See "help revisionspec" for details.'),
4714
Option('my-revision',
4715
type=_parse_revision_str,
4716
help='Filter on local branch revisions (inclusive). '
4717
'See "help revisionspec" for details.'),
4718
Option('include-merged',
4719
'Show all revisions in addition to the mainline ones.'),
4720
Option('include-merges', hidden=True,
4721
help='Historical alias for --include-merged.'),
4723
encoding_type = 'replace'
4726
def run(self, other_branch=None, reverse=False, mine_only=False,
4728
log_format=None, long=False, short=False, line=False,
4729
show_ids=False, verbose=False, this=False, other=False,
4730
include_merged=None, revision=None, my_revision=None,
4732
include_merges=symbol_versioning.DEPRECATED_PARAMETER):
4733
from bzrlib.missing import find_unmerged, iter_log_revisions
4738
if symbol_versioning.deprecated_passed(include_merges):
4739
ui.ui_factory.show_user_warning(
4740
'deprecated_command_option',
4741
deprecated_name='--include-merges',
4742
recommended_name='--include-merged',
4743
deprecated_in_version='2.5',
4744
command=self.invoked_as)
4745
if include_merged is None:
4746
include_merged = include_merges
4748
raise errors.BzrCommandError(gettext(
4749
'{0} and {1} are mutually exclusive').format(
4750
'--include-merges', '--include-merged'))
4751
if include_merged is None:
4752
include_merged = False
4757
# TODO: We should probably check that we don't have mine-only and
4758
# theirs-only set, but it gets complicated because we also have
4759
# this and other which could be used.
4766
local_branch = Branch.open_containing(directory)[0]
4767
self.add_cleanup(local_branch.lock_read().unlock)
4769
parent = local_branch.get_parent()
4770
if other_branch is None:
4771
other_branch = parent
4772
if other_branch is None:
4773
raise errors.BzrCommandError(gettext("No peer location known"
4775
display_url = urlutils.unescape_for_display(parent,
4777
message(gettext("Using saved parent location: {0}\n").format(
4780
remote_branch = Branch.open(other_branch)
4781
if remote_branch.base == local_branch.base:
4782
remote_branch = local_branch
4784
self.add_cleanup(remote_branch.lock_read().unlock)
4786
local_revid_range = _revision_range_to_revid_range(
4787
_get_revision_range(my_revision, local_branch,
4790
remote_revid_range = _revision_range_to_revid_range(
4791
_get_revision_range(revision,
4792
remote_branch, self.name()))
4794
local_extra, remote_extra = find_unmerged(
4795
local_branch, remote_branch, restrict,
4796
backward=not reverse,
4797
include_merged=include_merged,
4798
local_revid_range=local_revid_range,
4799
remote_revid_range=remote_revid_range)
4801
if log_format is None:
4802
registry = log.log_formatter_registry
4803
log_format = registry.get_default(local_branch)
4804
lf = log_format(to_file=self.outf,
4806
show_timezone='original')
4809
if local_extra and not theirs_only:
4810
message(ngettext("You have %d extra revision:\n",
4811
"You have %d extra revisions:\n",
4814
for revision in iter_log_revisions(local_extra,
4815
local_branch.repository,
4817
lf.log_revision(revision)
4818
printed_local = True
4821
printed_local = False
4823
if remote_extra and not mine_only:
4824
if printed_local is True:
4826
message(ngettext("You are missing %d revision:\n",
4827
"You are missing %d revisions:\n",
4828
len(remote_extra)) %
4830
for revision in iter_log_revisions(remote_extra,
4831
remote_branch.repository,
4833
lf.log_revision(revision)
4836
if mine_only and not local_extra:
4837
# We checked local, and found nothing extra
4838
message(gettext('This branch has no new revisions.\n'))
4839
elif theirs_only and not remote_extra:
4840
# We checked remote, and found nothing extra
4841
message(gettext('Other branch has no new revisions.\n'))
4842
elif not (mine_only or theirs_only or local_extra or
4844
# We checked both branches, and neither one had extra
4846
message(gettext("Branches are up to date.\n"))
4848
if not status_code and parent is None and other_branch is not None:
4849
self.add_cleanup(local_branch.lock_write().unlock)
4850
# handle race conditions - a parent might be set while we run.
4851
if local_branch.get_parent() is None:
4852
local_branch.set_parent(remote_branch.base)
4856
class cmd_pack(Command):
4857
__doc__ = """Compress the data within a repository.
4859
This operation compresses the data within a bazaar repository. As
4860
bazaar supports automatic packing of repository, this operation is
4861
normally not required to be done manually.
4863
During the pack operation, bazaar takes a backup of existing repository
4864
data, i.e. pack files. This backup is eventually removed by bazaar
4865
automatically when it is safe to do so. To save disk space by removing
4866
the backed up pack files, the --clean-obsolete-packs option may be
4869
Warning: If you use --clean-obsolete-packs and your machine crashes
4870
during or immediately after repacking, you may be left with a state
4871
where the deletion has been written to disk but the new packs have not
4872
been. In this case the repository may be unusable.
4875
_see_also = ['repositories']
4876
takes_args = ['branch_or_repo?']
4878
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4881
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4882
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
4884
branch = dir.open_branch()
4885
repository = branch.repository
4886
except errors.NotBranchError:
4887
repository = dir.open_repository()
4888
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4891
class cmd_plugins(Command):
4892
__doc__ = """List the installed plugins.
4894
This command displays the list of installed plugins including
4895
version of plugin and a short description of each.
4897
--verbose shows the path where each plugin is located.
4899
A plugin is an external component for Bazaar that extends the
4900
revision control system, by adding or replacing code in Bazaar.
4901
Plugins can do a variety of things, including overriding commands,
4902
adding new commands, providing additional network transports and
4903
customizing log output.
4905
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4906
for further information on plugins including where to find them and how to
4907
install them. Instructions are also provided there on how to write new
4908
plugins using the Python programming language.
4910
takes_options = ['verbose']
4913
def run(self, verbose=False):
4914
from bzrlib import plugin
4915
# Don't give writelines a generator as some codecs don't like that
4916
self.outf.writelines(
4917
list(plugin.describe_plugins(show_paths=verbose)))
4920
class cmd_testament(Command):
4921
__doc__ = """Show testament (signing-form) of a revision."""
4924
Option('long', help='Produce long-format testament.'),
4926
help='Produce a strict-format testament.')]
4927
takes_args = ['branch?']
4929
def run(self, branch=u'.', revision=None, long=False, strict=False):
4930
from bzrlib.testament import Testament, StrictTestament
4932
testament_class = StrictTestament
4934
testament_class = Testament
4936
b = Branch.open_containing(branch)[0]
4938
b = Branch.open(branch)
4939
self.add_cleanup(b.lock_read().unlock)
4940
if revision is None:
4941
rev_id = b.last_revision()
4943
rev_id = revision[0].as_revision_id(b)
4944
t = testament_class.from_revision(b.repository, rev_id)
4946
sys.stdout.writelines(t.as_text_lines())
4948
sys.stdout.write(t.as_short_text())
4951
class cmd_annotate(Command):
4952
__doc__ = """Show the origin of each line in a file.
4954
This prints out the given file with an annotation on the left side
4955
indicating which revision, author and date introduced the change.
4957
If the origin is the same for a run of consecutive lines, it is
4958
shown only at the top, unless the --all option is given.
4960
# TODO: annotate directories; showing when each file was last changed
4961
# TODO: if the working copy is modified, show annotations on that
4962
# with new uncommitted lines marked
4963
aliases = ['ann', 'blame', 'praise']
4964
takes_args = ['filename']
4965
takes_options = [Option('all', help='Show annotations on all lines.'),
4966
Option('long', help='Show commit date in annotations.'),
4971
encoding_type = 'exact'
4974
def run(self, filename, all=False, long=False, revision=None,
4975
show_ids=False, directory=None):
4976
from bzrlib.annotate import (
4979
wt, branch, relpath = \
4980
_open_directory_or_containing_tree_or_branch(filename, directory)
4982
self.add_cleanup(wt.lock_read().unlock)
4984
self.add_cleanup(branch.lock_read().unlock)
4985
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4986
self.add_cleanup(tree.lock_read().unlock)
4987
if wt is not None and revision is None:
4988
file_id = wt.path2id(relpath)
4990
file_id = tree.path2id(relpath)
4992
raise errors.NotVersionedError(filename)
4993
if wt is not None and revision is None:
4994
# If there is a tree and we're not annotating historical
4995
# versions, annotate the working tree's content.
4996
annotate_file_tree(wt, file_id, self.outf, long, all,
4999
annotate_file_tree(tree, file_id, self.outf, long, all,
5000
show_ids=show_ids, branch=branch)
5003
class cmd_re_sign(Command):
5004
__doc__ = """Create a digital signature for an existing revision."""
5005
# TODO be able to replace existing ones.
5007
hidden = True # is this right ?
5008
takes_args = ['revision_id*']
5009
takes_options = ['directory', 'revision']
5011
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5012
if revision_id_list is not None and revision is not None:
5013
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5014
if revision_id_list is None and revision is None:
5015
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5016
b = WorkingTree.open_containing(directory)[0].branch
5017
self.add_cleanup(b.lock_write().unlock)
5018
return self._run(b, revision_id_list, revision)
5020
def _run(self, b, revision_id_list, revision):
5021
import bzrlib.gpg as gpg
5022
gpg_strategy = gpg.GPGStrategy(b.get_config())
5023
if revision_id_list is not None:
5024
b.repository.start_write_group()
5026
for revision_id in revision_id_list:
5027
b.repository.sign_revision(revision_id, gpg_strategy)
5029
b.repository.abort_write_group()
5032
b.repository.commit_write_group()
5033
elif revision is not None:
5034
if len(revision) == 1:
5035
revno, rev_id = revision[0].in_history(b)
5036
b.repository.start_write_group()
5038
b.repository.sign_revision(rev_id, gpg_strategy)
5040
b.repository.abort_write_group()
5043
b.repository.commit_write_group()
5044
elif len(revision) == 2:
5045
# are they both on rh- if so we can walk between them
5046
# might be nice to have a range helper for arbitrary
5047
# revision paths. hmm.
5048
from_revno, from_revid = revision[0].in_history(b)
5049
to_revno, to_revid = revision[1].in_history(b)
5050
if to_revid is None:
5051
to_revno = b.revno()
5052
if from_revno is None or to_revno is None:
5053
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5054
b.repository.start_write_group()
5056
for revno in range(from_revno, to_revno + 1):
5057
b.repository.sign_revision(b.get_rev_id(revno),
5060
b.repository.abort_write_group()
5063
b.repository.commit_write_group()
5065
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5068
class cmd_bind(Command):
5069
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5070
If no branch is supplied, rebind to the last bound location.
5072
Once converted into a checkout, commits must succeed on the master branch
5073
before they will be applied to the local branch.
5075
Bound branches use the nickname of its master branch unless it is set
5076
locally, in which case binding will update the local nickname to be
5080
_see_also = ['checkouts', 'unbind']
5081
takes_args = ['location?']
5082
takes_options = ['directory']
5084
def run(self, location=None, directory=u'.'):
5085
b, relpath = Branch.open_containing(directory)
5086
if location is None:
5088
location = b.get_old_bound_location()
5089
except errors.UpgradeRequired:
5090
raise errors.BzrCommandError(gettext('No location supplied. '
5091
'This format does not remember old locations.'))
5093
if location is None:
5094
if b.get_bound_location() is not None:
5095
raise errors.BzrCommandError(gettext('Branch is already bound'))
5097
raise errors.BzrCommandError(gettext('No location supplied '
5098
'and no previous location known'))
5099
b_other = Branch.open(location)
5102
except errors.DivergedBranches:
5103
raise errors.BzrCommandError(gettext('These branches have diverged.'
5104
' Try merging, and then bind again.'))
5105
if b.get_config().has_explicit_nickname():
5106
b.nick = b_other.nick
5109
class cmd_unbind(Command):
5110
__doc__ = """Convert the current checkout into a regular branch.
5112
After unbinding, the local branch is considered independent and subsequent
5113
commits will be local only.
5116
_see_also = ['checkouts', 'bind']
5118
takes_options = ['directory']
5120
def run(self, directory=u'.'):
5121
b, relpath = Branch.open_containing(directory)
5123
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5126
class cmd_uncommit(Command):
5127
__doc__ = """Remove the last committed revision.
5129
--verbose will print out what is being removed.
5130
--dry-run will go through all the motions, but not actually
5133
If --revision is specified, uncommit revisions to leave the branch at the
5134
specified revision. For example, "bzr uncommit -r 15" will leave the
5135
branch at revision 15.
5137
Uncommit leaves the working tree ready for a new commit. The only change
5138
it may make is to restore any pending merges that were present before
5142
# TODO: jam 20060108 Add an option to allow uncommit to remove
5143
# unreferenced information in 'branch-as-repository' branches.
5144
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5145
# information in shared branches as well.
5146
_see_also = ['commit']
5147
takes_options = ['verbose', 'revision',
5148
Option('dry-run', help='Don\'t actually make changes.'),
5149
Option('force', help='Say yes to all questions.'),
5151
help='Keep tags that point to removed revisions.'),
5153
help="Only remove the commits from the local branch"
5154
" when in a checkout."
5157
takes_args = ['location?']
5159
encoding_type = 'replace'
5161
def run(self, location=None, dry_run=False, verbose=False,
5162
revision=None, force=False, local=False, keep_tags=False):
5163
if location is None:
5165
control, relpath = controldir.ControlDir.open_containing(location)
5167
tree = control.open_workingtree()
5169
except (errors.NoWorkingTree, errors.NotLocalUrl):
5171
b = control.open_branch()
5173
if tree is not None:
5174
self.add_cleanup(tree.lock_write().unlock)
5176
self.add_cleanup(b.lock_write().unlock)
5177
return self._run(b, tree, dry_run, verbose, revision, force,
5180
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5182
from bzrlib.log import log_formatter, show_log
5183
from bzrlib.uncommit import uncommit
5185
last_revno, last_rev_id = b.last_revision_info()
5188
if revision is None:
5190
rev_id = last_rev_id
5192
# 'bzr uncommit -r 10' actually means uncommit
5193
# so that the final tree is at revno 10.
5194
# but bzrlib.uncommit.uncommit() actually uncommits
5195
# the revisions that are supplied.
5196
# So we need to offset it by one
5197
revno = revision[0].in_history(b).revno + 1
5198
if revno <= last_revno:
5199
rev_id = b.get_rev_id(revno)
5201
if rev_id is None or _mod_revision.is_null(rev_id):
5202
self.outf.write(gettext('No revisions to uncommit.\n'))
5205
lf = log_formatter('short',
5207
show_timezone='original')
5212
direction='forward',
5213
start_revision=revno,
5214
end_revision=last_revno)
5217
self.outf.write(gettext('Dry-run, pretending to remove'
5218
' the above revisions.\n'))
5220
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5223
if not ui.ui_factory.confirm_action(
5224
gettext(u'Uncommit these revisions'),
5225
'bzrlib.builtins.uncommit',
5227
self.outf.write(gettext('Canceled\n'))
5230
mutter('Uncommitting from {%s} to {%s}',
5231
last_rev_id, rev_id)
5232
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5233
revno=revno, local=local, keep_tags=keep_tags)
5234
self.outf.write(gettext('You can restore the old tip by running:\n'
5235
' bzr pull . -r revid:%s\n') % last_rev_id)
5238
class cmd_break_lock(Command):
5239
__doc__ = """Break a dead lock.
5241
This command breaks a lock on a repository, branch, working directory or
5244
CAUTION: Locks should only be broken when you are sure that the process
5245
holding the lock has been stopped.
5247
You can get information on what locks are open via the 'bzr info
5248
[location]' command.
5252
bzr break-lock bzr+ssh://example.com/bzr/foo
5253
bzr break-lock --conf ~/.bazaar
5256
takes_args = ['location?']
5259
help='LOCATION is the directory where the config lock is.'),
5261
help='Do not ask for confirmation before breaking the lock.'),
5264
def run(self, location=None, config=False, force=False):
5265
if location is None:
5268
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5270
{'bzrlib.lockdir.break': True})
5272
conf = _mod_config.LockableConfig(file_name=location)
5275
control, relpath = controldir.ControlDir.open_containing(location)
5277
control.break_lock()
5278
except NotImplementedError:
5282
class cmd_wait_until_signalled(Command):
5283
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5285
This just prints a line to signal when it is ready, then blocks on stdin.
5291
sys.stdout.write("running\n")
5293
sys.stdin.readline()
5296
class cmd_serve(Command):
5297
__doc__ = """Run the bzr server."""
5299
aliases = ['server']
5303
help='Serve on stdin/out for use from inetd or sshd.'),
5304
RegistryOption('protocol',
5305
help="Protocol to serve.",
5306
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5307
value_switches=True),
5309
help='Listen for connections on nominated port of the form '
5310
'[hostname:]portnumber. Passing 0 as the port number will '
5311
'result in a dynamically allocated port. The default port '
5312
'depends on the protocol.',
5314
custom_help('directory',
5315
help='Serve contents of this directory.'),
5316
Option('allow-writes',
5317
help='By default the server is a readonly server. Supplying '
5318
'--allow-writes enables write access to the contents of '
5319
'the served directory and below. Note that ``bzr serve`` '
5320
'does not perform authentication, so unless some form of '
5321
'external authentication is arranged supplying this '
5322
'option leads to global uncontrolled write access to your '
5325
Option('client-timeout', type=float,
5326
help='Override the default idle client timeout (5min).'),
5329
def get_host_and_port(self, port):
5330
"""Return the host and port to run the smart server on.
5332
If 'port' is None, None will be returned for the host and port.
5334
If 'port' has a colon in it, the string before the colon will be
5335
interpreted as the host.
5337
:param port: A string of the port to run the server on.
5338
:return: A tuple of (host, port), where 'host' is a host name or IP,
5339
and port is an integer TCP/IP port.
5342
if port is not None:
5344
host, port = port.split(':')
5348
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5349
protocol=None, client_timeout=None):
5350
from bzrlib import transport
5351
if directory is None:
5352
directory = os.getcwd()
5353
if protocol is None:
5354
protocol = transport.transport_server_registry.get()
5355
host, port = self.get_host_and_port(port)
5356
url = transport.location_to_url(directory)
5357
if not allow_writes:
5358
url = 'readonly+' + url
5359
t = transport.get_transport_from_url(url)
5361
protocol(t, host, port, inet, client_timeout)
5362
except TypeError, e:
5363
# We use symbol_versioning.deprecated_in just so that people
5364
# grepping can find it here.
5365
# symbol_versioning.deprecated_in((2, 5, 0))
5366
symbol_versioning.warn(
5367
'Got TypeError(%s)\ntrying to call protocol: %s.%s\n'
5368
'Most likely it needs to be updated to support a'
5369
' "timeout" parameter (added in bzr 2.5.0)'
5370
% (e, protocol.__module__, protocol),
5372
protocol(t, host, port, inet)
5375
class cmd_join(Command):
5376
__doc__ = """Combine a tree into its containing tree.
5378
This command requires the target tree to be in a rich-root format.
5380
The TREE argument should be an independent tree, inside another tree, but
5381
not part of it. (Such trees can be produced by "bzr split", but also by
5382
running "bzr branch" with the target inside a tree.)
5384
The result is a combined tree, with the subtree no longer an independent
5385
part. This is marked as a merge of the subtree into the containing tree,
5386
and all history is preserved.
5389
_see_also = ['split']
5390
takes_args = ['tree']
5392
Option('reference', help='Join by reference.', hidden=True),
5395
def run(self, tree, reference=False):
5396
sub_tree = WorkingTree.open(tree)
5397
parent_dir = osutils.dirname(sub_tree.basedir)
5398
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5399
repo = containing_tree.branch.repository
5400
if not repo.supports_rich_root():
5401
raise errors.BzrCommandError(gettext(
5402
"Can't join trees because %s doesn't support rich root data.\n"
5403
"You can use bzr upgrade on the repository.")
5407
containing_tree.add_reference(sub_tree)
5408
except errors.BadReferenceTarget, e:
5409
# XXX: Would be better to just raise a nicely printable
5410
# exception from the real origin. Also below. mbp 20070306
5411
raise errors.BzrCommandError(
5412
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5415
containing_tree.subsume(sub_tree)
5416
except errors.BadSubsumeSource, e:
5417
raise errors.BzrCommandError(
5418
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5421
class cmd_split(Command):
5422
__doc__ = """Split a subdirectory of a tree into a separate tree.
5424
This command will produce a target tree in a format that supports
5425
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5426
converted into earlier formats like 'dirstate-tags'.
5428
The TREE argument should be a subdirectory of a working tree. That
5429
subdirectory will be converted into an independent tree, with its own
5430
branch. Commits in the top-level tree will not apply to the new subtree.
5433
_see_also = ['join']
5434
takes_args = ['tree']
5436
def run(self, tree):
5437
containing_tree, subdir = WorkingTree.open_containing(tree)
5438
sub_id = containing_tree.path2id(subdir)
5440
raise errors.NotVersionedError(subdir)
5442
containing_tree.extract(sub_id)
5443
except errors.RootNotRich:
5444
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5447
class cmd_merge_directive(Command):
5448
__doc__ = """Generate a merge directive for auto-merge tools.
5450
A directive requests a merge to be performed, and also provides all the
5451
information necessary to do so. This means it must either include a
5452
revision bundle, or the location of a branch containing the desired
5455
A submit branch (the location to merge into) must be supplied the first
5456
time the command is issued. After it has been supplied once, it will
5457
be remembered as the default.
5459
A public branch is optional if a revision bundle is supplied, but required
5460
if --diff or --plain is specified. It will be remembered as the default
5461
after the first use.
5464
takes_args = ['submit_branch?', 'public_branch?']
5468
_see_also = ['send']
5472
RegistryOption.from_kwargs('patch-type',
5473
'The type of patch to include in the directive.',
5475
value_switches=True,
5477
bundle='Bazaar revision bundle (default).',
5478
diff='Normal unified diff.',
5479
plain='No patch, just directive.'),
5480
Option('sign', help='GPG-sign the directive.'), 'revision',
5481
Option('mail-to', type=str,
5482
help='Instead of printing the directive, email to this address.'),
5483
Option('message', type=str, short_name='m',
5484
help='Message to use when committing this merge.')
5487
encoding_type = 'exact'
5489
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5490
sign=False, revision=None, mail_to=None, message=None,
5492
from bzrlib.revision import ensure_null, NULL_REVISION
5493
include_patch, include_bundle = {
5494
'plain': (False, False),
5495
'diff': (True, False),
5496
'bundle': (True, True),
5498
branch = Branch.open(directory)
5499
stored_submit_branch = branch.get_submit_branch()
5500
if submit_branch is None:
5501
submit_branch = stored_submit_branch
5503
if stored_submit_branch is None:
5504
branch.set_submit_branch(submit_branch)
5505
if submit_branch is None:
5506
submit_branch = branch.get_parent()
5507
if submit_branch is None:
5508
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5510
stored_public_branch = branch.get_public_branch()
5511
if public_branch is None:
5512
public_branch = stored_public_branch
5513
elif stored_public_branch is None:
5514
branch.set_public_branch(public_branch)
5515
if not include_bundle and public_branch is None:
5516
raise errors.BzrCommandError(gettext('No public branch specified or'
5518
base_revision_id = None
5519
if revision is not None:
5520
if len(revision) > 2:
5521
raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5522
'at most two one revision identifiers'))
5523
revision_id = revision[-1].as_revision_id(branch)
5524
if len(revision) == 2:
5525
base_revision_id = revision[0].as_revision_id(branch)
5527
revision_id = branch.last_revision()
5528
revision_id = ensure_null(revision_id)
5529
if revision_id == NULL_REVISION:
5530
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5531
directive = merge_directive.MergeDirective2.from_objects(
5532
branch.repository, revision_id, time.time(),
5533
osutils.local_time_offset(), submit_branch,
5534
public_branch=public_branch, include_patch=include_patch,
5535
include_bundle=include_bundle, message=message,
5536
base_revision_id=base_revision_id)
5539
self.outf.write(directive.to_signed(branch))
5541
self.outf.writelines(directive.to_lines())
5543
message = directive.to_email(mail_to, branch, sign)
5544
s = SMTPConnection(branch.get_config())
5545
s.send_email(message)
5548
class cmd_send(Command):
5549
__doc__ = """Mail or create a merge-directive for submitting changes.
5551
A merge directive provides many things needed for requesting merges:
5553
* A machine-readable description of the merge to perform
5555
* An optional patch that is a preview of the changes requested
5557
* An optional bundle of revision data, so that the changes can be applied
5558
directly from the merge directive, without retrieving data from a
5561
`bzr send` creates a compact data set that, when applied using bzr
5562
merge, has the same effect as merging from the source branch.
5564
By default the merge directive is self-contained and can be applied to any
5565
branch containing submit_branch in its ancestory without needing access to
5568
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5569
revisions, but only a structured request to merge from the
5570
public_location. In that case the public_branch is needed and it must be
5571
up-to-date and accessible to the recipient. The public_branch is always
5572
included if known, so that people can check it later.
5574
The submit branch defaults to the parent of the source branch, but can be
5575
overridden. Both submit branch and public branch will be remembered in
5576
branch.conf the first time they are used for a particular branch. The
5577
source branch defaults to that containing the working directory, but can
5578
be changed using --from.
5580
Both the submit branch and the public branch follow the usual behavior with
5581
respect to --remember: If there is no default location set, the first send
5582
will set it (use --no-remember to avoid setting it). After that, you can
5583
omit the location to use the default. To change the default, use
5584
--remember. The value will only be saved if the location can be accessed.
5586
In order to calculate those changes, bzr must analyse the submit branch.
5587
Therefore it is most efficient for the submit branch to be a local mirror.
5588
If a public location is known for the submit_branch, that location is used
5589
in the merge directive.
5591
The default behaviour is to send the merge directive by mail, unless -o is
5592
given, in which case it is sent to a file.
5594
Mail is sent using your preferred mail program. This should be transparent
5595
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5596
If the preferred client can't be found (or used), your editor will be used.
5598
To use a specific mail program, set the mail_client configuration option.
5599
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5600
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5601
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5602
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5605
If mail is being sent, a to address is required. This can be supplied
5606
either on the commandline, by setting the submit_to configuration
5607
option in the branch itself or the child_submit_to configuration option
5608
in the submit branch.
5610
Two formats are currently supported: "4" uses revision bundle format 4 and
5611
merge directive format 2. It is significantly faster and smaller than
5612
older formats. It is compatible with Bazaar 0.19 and later. It is the
5613
default. "0.9" uses revision bundle format 0.9 and merge directive
5614
format 1. It is compatible with Bazaar 0.12 - 0.18.
5616
The merge directives created by bzr send may be applied using bzr merge or
5617
bzr pull by specifying a file containing a merge directive as the location.
5619
bzr send makes extensive use of public locations to map local locations into
5620
URLs that can be used by other people. See `bzr help configuration` to
5621
set them, and use `bzr info` to display them.
5624
encoding_type = 'exact'
5626
_see_also = ['merge', 'pull']
5628
takes_args = ['submit_branch?', 'public_branch?']
5632
help='Do not include a bundle in the merge directive.'),
5633
Option('no-patch', help='Do not include a preview patch in the merge'
5636
help='Remember submit and public branch.'),
5638
help='Branch to generate the submission from, '
5639
'rather than the one containing the working directory.',
5642
Option('output', short_name='o',
5643
help='Write merge directive to this file or directory; '
5644
'use - for stdout.',
5647
help='Refuse to send if there are uncommitted changes in'
5648
' the working tree, --no-strict disables the check.'),
5649
Option('mail-to', help='Mail the request to this address.',
5653
Option('body', help='Body for the email.', type=unicode),
5654
RegistryOption('format',
5655
help='Use the specified output format.',
5656
lazy_registry=('bzrlib.send', 'format_registry')),
5659
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5660
no_patch=False, revision=None, remember=None, output=None,
5661
format=None, mail_to=None, message=None, body=None,
5662
strict=None, **kwargs):
5663
from bzrlib.send import send
5664
return send(submit_branch, revision, public_branch, remember,
5665
format, no_bundle, no_patch, output,
5666
kwargs.get('from', '.'), mail_to, message, body,
5671
class cmd_bundle_revisions(cmd_send):
5672
__doc__ = """Create a merge-directive for submitting changes.
5674
A merge directive provides many things needed for requesting merges:
5676
* A machine-readable description of the merge to perform
5678
* An optional patch that is a preview of the changes requested
5680
* An optional bundle of revision data, so that the changes can be applied
5681
directly from the merge directive, without retrieving data from a
5684
If --no-bundle is specified, then public_branch is needed (and must be
5685
up-to-date), so that the receiver can perform the merge using the
5686
public_branch. The public_branch is always included if known, so that
5687
people can check it later.
5689
The submit branch defaults to the parent, but can be overridden. Both
5690
submit branch and public branch will be remembered if supplied.
5692
If a public_branch is known for the submit_branch, that public submit
5693
branch is used in the merge instructions. This means that a local mirror
5694
can be used as your actual submit branch, once you have set public_branch
5697
Two formats are currently supported: "4" uses revision bundle format 4 and
5698
merge directive format 2. It is significantly faster and smaller than
5699
older formats. It is compatible with Bazaar 0.19 and later. It is the
5700
default. "0.9" uses revision bundle format 0.9 and merge directive
5701
format 1. It is compatible with Bazaar 0.12 - 0.18.
5706
help='Do not include a bundle in the merge directive.'),
5707
Option('no-patch', help='Do not include a preview patch in the merge'
5710
help='Remember submit and public branch.'),
5712
help='Branch to generate the submission from, '
5713
'rather than the one containing the working directory.',
5716
Option('output', short_name='o', help='Write directive to this file.',
5719
help='Refuse to bundle revisions if there are uncommitted'
5720
' changes in the working tree, --no-strict disables the check.'),
5722
RegistryOption('format',
5723
help='Use the specified output format.',
5724
lazy_registry=('bzrlib.send', 'format_registry')),
5726
aliases = ['bundle']
5728
_see_also = ['send', 'merge']
5732
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5733
no_patch=False, revision=None, remember=False, output=None,
5734
format=None, strict=None, **kwargs):
5737
from bzrlib.send import send
5738
return send(submit_branch, revision, public_branch, remember,
5739
format, no_bundle, no_patch, output,
5740
kwargs.get('from', '.'), None, None, None,
5741
self.outf, strict=strict)
5744
class cmd_tag(Command):
5745
__doc__ = """Create, remove or modify a tag naming a revision.
5747
Tags give human-meaningful names to revisions. Commands that take a -r
5748
(--revision) option can be given -rtag:X, where X is any previously
5751
Tags are stored in the branch. Tags are copied from one branch to another
5752
along when you branch, push, pull or merge.
5754
It is an error to give a tag name that already exists unless you pass
5755
--force, in which case the tag is moved to point to the new revision.
5757
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5758
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5760
If no tag name is specified it will be determined through the
5761
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5762
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5766
_see_also = ['commit', 'tags']
5767
takes_args = ['tag_name?']
5770
help='Delete this tag rather than placing it.',
5772
custom_help('directory',
5773
help='Branch in which to place the tag.'),
5775
help='Replace existing tags.',
5780
def run(self, tag_name=None,
5786
branch, relpath = Branch.open_containing(directory)
5787
self.add_cleanup(branch.lock_write().unlock)
5789
if tag_name is None:
5790
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5791
branch.tags.delete_tag(tag_name)
5792
note(gettext('Deleted tag %s.') % tag_name)
5795
if len(revision) != 1:
5796
raise errors.BzrCommandError(gettext(
5797
"Tags can only be placed on a single revision, "
5799
revision_id = revision[0].as_revision_id(branch)
5801
revision_id = branch.last_revision()
5802
if tag_name is None:
5803
tag_name = branch.automatic_tag_name(revision_id)
5804
if tag_name is None:
5805
raise errors.BzrCommandError(gettext(
5806
"Please specify a tag name."))
5808
existing_target = branch.tags.lookup_tag(tag_name)
5809
except errors.NoSuchTag:
5810
existing_target = None
5811
if not force and existing_target not in (None, revision_id):
5812
raise errors.TagAlreadyExists(tag_name)
5813
if existing_target == revision_id:
5814
note(gettext('Tag %s already exists for that revision.') % tag_name)
5816
branch.tags.set_tag(tag_name, revision_id)
5817
if existing_target is None:
5818
note(gettext('Created tag %s.') % tag_name)
5820
note(gettext('Updated tag %s.') % tag_name)
5823
class cmd_tags(Command):
5824
__doc__ = """List tags.
5826
This command shows a table of tag names and the revisions they reference.
5831
custom_help('directory',
5832
help='Branch whose tags should be displayed.'),
5833
RegistryOption('sort',
5834
'Sort tags by different criteria.', title='Sorting',
5835
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5842
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5843
from bzrlib.tag import tag_sort_methods
5844
branch, relpath = Branch.open_containing(directory)
5846
tags = branch.tags.get_tag_dict().items()
5850
self.add_cleanup(branch.lock_read().unlock)
5852
# Restrict to the specified range
5853
tags = self._tags_for_range(branch, revision)
5855
sort = tag_sort_methods.get()
5858
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5859
for index, (tag, revid) in enumerate(tags):
5861
revno = branch.revision_id_to_dotted_revno(revid)
5862
if isinstance(revno, tuple):
5863
revno = '.'.join(map(str, revno))
5864
except (errors.NoSuchRevision,
5865
errors.GhostRevisionsHaveNoRevno,
5866
errors.UnsupportedOperation):
5867
# Bad tag data/merges can lead to tagged revisions
5868
# which are not in this branch. Fail gracefully ...
5870
tags[index] = (tag, revno)
5872
for tag, revspec in tags:
5873
self.outf.write('%-20s %s\n' % (tag, revspec))
5875
def _tags_for_range(self, branch, revision):
5877
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5878
revid1, revid2 = rev1.rev_id, rev2.rev_id
5879
# _get_revision_range will always set revid2 if it's not specified.
5880
# If revid1 is None, it means we want to start from the branch
5881
# origin which is always a valid ancestor. If revid1 == revid2, the
5882
# ancestry check is useless.
5883
if revid1 and revid1 != revid2:
5884
# FIXME: We really want to use the same graph than
5885
# branch.iter_merge_sorted_revisions below, but this is not
5886
# easily available -- vila 2011-09-23
5887
if branch.repository.get_graph().is_ancestor(revid2, revid1):
5888
# We don't want to output anything in this case...
5890
# only show revisions between revid1 and revid2 (inclusive)
5891
tagged_revids = branch.tags.get_reverse_tag_dict()
5893
for r in branch.iter_merge_sorted_revisions(
5894
start_revision_id=revid2, stop_revision_id=revid1,
5895
stop_rule='include'):
5896
revid_tags = tagged_revids.get(r[0], None)
5898
found.extend([(tag, r[0]) for tag in revid_tags])
5902
class cmd_reconfigure(Command):
5903
__doc__ = """Reconfigure the type of a bzr directory.
5905
A target configuration must be specified.
5907
For checkouts, the bind-to location will be auto-detected if not specified.
5908
The order of preference is
5909
1. For a lightweight checkout, the current bound location.
5910
2. For branches that used to be checkouts, the previously-bound location.
5911
3. The push location.
5912
4. The parent location.
5913
If none of these is available, --bind-to must be specified.
5916
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5917
takes_args = ['location?']
5919
RegistryOption.from_kwargs(
5922
help='The relation between branch and tree.',
5923
value_switches=True, enum_switch=False,
5924
branch='Reconfigure to be an unbound branch with no working tree.',
5925
tree='Reconfigure to be an unbound branch with a working tree.',
5926
checkout='Reconfigure to be a bound branch with a working tree.',
5927
lightweight_checkout='Reconfigure to be a lightweight'
5928
' checkout (with no local history).',
5930
RegistryOption.from_kwargs(
5932
title='Repository type',
5933
help='Location fo the repository.',
5934
value_switches=True, enum_switch=False,
5935
standalone='Reconfigure to be a standalone branch '
5936
'(i.e. stop using shared repository).',
5937
use_shared='Reconfigure to use a shared repository.',
5939
RegistryOption.from_kwargs(
5941
title='Trees in Repository',
5942
help='Whether new branches in the repository have trees.',
5943
value_switches=True, enum_switch=False,
5944
with_trees='Reconfigure repository to create '
5945
'working trees on branches by default.',
5946
with_no_trees='Reconfigure repository to not create '
5947
'working trees on branches by default.'
5949
Option('bind-to', help='Branch to bind checkout to.', type=str),
5951
help='Perform reconfiguration even if local changes'
5953
Option('stacked-on',
5954
help='Reconfigure a branch to be stacked on another branch.',
5958
help='Reconfigure a branch to be unstacked. This '
5959
'may require copying substantial data into it.',
5963
def run(self, location=None, bind_to=None, force=False,
5964
tree_type=None, repository_type=None, repository_trees=None,
5965
stacked_on=None, unstacked=None):
5966
directory = controldir.ControlDir.open(location)
5967
if stacked_on and unstacked:
5968
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
5969
elif stacked_on is not None:
5970
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5972
reconfigure.ReconfigureUnstacked().apply(directory)
5973
# At the moment you can use --stacked-on and a different
5974
# reconfiguration shape at the same time; there seems no good reason
5976
if (tree_type is None and
5977
repository_type is None and
5978
repository_trees is None):
5979
if stacked_on or unstacked:
5982
raise errors.BzrCommandError(gettext('No target configuration '
5984
reconfiguration = None
5985
if tree_type == 'branch':
5986
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5987
elif tree_type == 'tree':
5988
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5989
elif tree_type == 'checkout':
5990
reconfiguration = reconfigure.Reconfigure.to_checkout(
5992
elif tree_type == 'lightweight-checkout':
5993
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5996
reconfiguration.apply(force)
5997
reconfiguration = None
5998
if repository_type == 'use-shared':
5999
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6000
elif repository_type == 'standalone':
6001
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6003
reconfiguration.apply(force)
6004
reconfiguration = None
6005
if repository_trees == 'with-trees':
6006
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6008
elif repository_trees == 'with-no-trees':
6009
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6012
reconfiguration.apply(force)
6013
reconfiguration = None
6016
class cmd_switch(Command):
6017
__doc__ = """Set the branch of a checkout and update.
6019
For lightweight checkouts, this changes the branch being referenced.
6020
For heavyweight checkouts, this checks that there are no local commits
6021
versus the current bound branch, then it makes the local branch a mirror
6022
of the new location and binds to it.
6024
In both cases, the working tree is updated and uncommitted changes
6025
are merged. The user can commit or revert these as they desire.
6027
Pending merges need to be committed or reverted before using switch.
6029
The path to the branch to switch to can be specified relative to the parent
6030
directory of the current branch. For example, if you are currently in a
6031
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6034
Bound branches use the nickname of its master branch unless it is set
6035
locally, in which case switching will update the local nickname to be
6039
takes_args = ['to_location?']
6040
takes_options = ['directory',
6042
help='Switch even if local commits will be lost.'),
6044
Option('create-branch', short_name='b',
6045
help='Create the target branch from this one before'
6046
' switching to it.'),
6049
def run(self, to_location=None, force=False, create_branch=False,
6050
revision=None, directory=u'.'):
6051
from bzrlib import switch
6052
tree_location = directory
6053
revision = _get_one_revision('switch', revision)
6054
control_dir = controldir.ControlDir.open_containing(tree_location)[0]
6055
if to_location is None:
6056
if revision is None:
6057
raise errors.BzrCommandError(gettext('You must supply either a'
6058
' revision or a location'))
6059
to_location = tree_location
6061
branch = control_dir.open_branch()
6062
had_explicit_nick = branch.get_config().has_explicit_nickname()
6063
except errors.NotBranchError:
6065
had_explicit_nick = False
6068
raise errors.BzrCommandError(gettext('cannot create branch without'
6070
to_location = directory_service.directories.dereference(
6072
if '/' not in to_location and '\\' not in to_location:
6073
# This path is meant to be relative to the existing branch
6074
this_url = self._get_branch_location(control_dir)
6075
# Perhaps the target control dir supports colocated branches?
6077
root = controldir.ControlDir.open(this_url,
6078
possible_transports=[control_dir.user_transport])
6079
except errors.NotBranchError:
6082
colocated = root._format.colocated_branches
6084
to_location = urlutils.join_segment_parameters(this_url,
6085
{"branch": urlutils.escape(to_location)})
6087
to_location = urlutils.join(
6088
this_url, '..', urlutils.escape(to_location))
6089
to_branch = branch.bzrdir.sprout(to_location,
6090
possible_transports=[branch.bzrdir.root_transport],
6091
source_branch=branch).open_branch()
6093
# Perhaps it's a colocated branch?
6095
to_branch = control_dir.open_branch(to_location)
6096
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
6098
to_branch = Branch.open(to_location)
6099
except errors.NotBranchError:
6100
this_url = self._get_branch_location(control_dir)
6101
to_branch = Branch.open(
6103
this_url, '..', urlutils.escape(to_location)))
6104
if revision is not None:
6105
revision = revision.as_revision_id(to_branch)
6106
switch.switch(control_dir, to_branch, force, revision_id=revision)
6107
if had_explicit_nick:
6108
branch = control_dir.open_branch() #get the new branch!
6109
branch.nick = to_branch.nick
6110
note(gettext('Switched to branch: %s'),
6111
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6113
def _get_branch_location(self, control_dir):
6114
"""Return location of branch for this control dir."""
6116
this_branch = control_dir.open_branch()
6117
# This may be a heavy checkout, where we want the master branch
6118
master_location = this_branch.get_bound_location()
6119
if master_location is not None:
6120
return master_location
6121
# If not, use a local sibling
6122
return this_branch.base
6123
except errors.NotBranchError:
6124
format = control_dir.find_branch_format()
6125
if getattr(format, 'get_reference', None) is not None:
6126
return format.get_reference(control_dir)
6128
return control_dir.root_transport.base
6131
class cmd_view(Command):
6132
__doc__ = """Manage filtered views.
6134
Views provide a mask over the tree so that users can focus on
6135
a subset of a tree when doing their work. After creating a view,
6136
commands that support a list of files - status, diff, commit, etc -
6137
effectively have that list of files implicitly given each time.
6138
An explicit list of files can still be given but those files
6139
must be within the current view.
6141
In most cases, a view has a short life-span: it is created to make
6142
a selected change and is deleted once that change is committed.
6143
At other times, you may wish to create one or more named views
6144
and switch between them.
6146
To disable the current view without deleting it, you can switch to
6147
the pseudo view called ``off``. This can be useful when you need
6148
to see the whole tree for an operation or two (e.g. merge) but
6149
want to switch back to your view after that.
6152
To define the current view::
6154
bzr view file1 dir1 ...
6156
To list the current view::
6160
To delete the current view::
6164
To disable the current view without deleting it::
6166
bzr view --switch off
6168
To define a named view and switch to it::
6170
bzr view --name view-name file1 dir1 ...
6172
To list a named view::
6174
bzr view --name view-name
6176
To delete a named view::
6178
bzr view --name view-name --delete
6180
To switch to a named view::
6182
bzr view --switch view-name
6184
To list all views defined::
6188
To delete all views::
6190
bzr view --delete --all
6194
takes_args = ['file*']
6197
help='Apply list or delete action to all views.',
6200
help='Delete the view.',
6203
help='Name of the view to define, list or delete.',
6207
help='Name of the view to switch to.',
6212
def run(self, file_list,
6218
tree, file_list = WorkingTree.open_containing_paths(file_list,
6220
current_view, view_dict = tree.views.get_view_info()
6225
raise errors.BzrCommandError(gettext(
6226
"Both --delete and a file list specified"))
6228
raise errors.BzrCommandError(gettext(
6229
"Both --delete and --switch specified"))
6231
tree.views.set_view_info(None, {})
6232
self.outf.write(gettext("Deleted all views.\n"))
6234
raise errors.BzrCommandError(gettext("No current view to delete"))
6236
tree.views.delete_view(name)
6237
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6240
raise errors.BzrCommandError(gettext(
6241
"Both --switch and a file list specified"))
6243
raise errors.BzrCommandError(gettext(
6244
"Both --switch and --all specified"))
6245
elif switch == 'off':
6246
if current_view is None:
6247
raise errors.BzrCommandError(gettext("No current view to disable"))
6248
tree.views.set_view_info(None, view_dict)
6249
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6251
tree.views.set_view_info(switch, view_dict)
6252
view_str = views.view_display_str(tree.views.lookup_view())
6253
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6256
self.outf.write(gettext('Views defined:\n'))
6257
for view in sorted(view_dict):
6258
if view == current_view:
6262
view_str = views.view_display_str(view_dict[view])
6263
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6265
self.outf.write(gettext('No views defined.\n'))
6268
# No name given and no current view set
6271
raise errors.BzrCommandError(gettext(
6272
"Cannot change the 'off' pseudo view"))
6273
tree.views.set_view(name, sorted(file_list))
6274
view_str = views.view_display_str(tree.views.lookup_view())
6275
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6279
# No name given and no current view set
6280
self.outf.write(gettext('No current view.\n'))
6282
view_str = views.view_display_str(tree.views.lookup_view(name))
6283
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6286
class cmd_hooks(Command):
6287
__doc__ = """Show hooks."""
6292
for hook_key in sorted(hooks.known_hooks.keys()):
6293
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6294
self.outf.write("%s:\n" % type(some_hooks).__name__)
6295
for hook_name, hook_point in sorted(some_hooks.items()):
6296
self.outf.write(" %s:\n" % (hook_name,))
6297
found_hooks = list(hook_point)
6299
for hook in found_hooks:
6300
self.outf.write(" %s\n" %
6301
(some_hooks.get_hook_name(hook),))
6303
self.outf.write(gettext(" <no hooks installed>\n"))
6306
class cmd_remove_branch(Command):
6307
__doc__ = """Remove a branch.
6309
This will remove the branch from the specified location but
6310
will keep any working tree or repository in place.
6314
Remove the branch at repo/trunk::
6316
bzr remove-branch repo/trunk
6320
takes_args = ["location?"]
6322
aliases = ["rmbranch"]
6324
def run(self, location=None):
6325
if location is None:
6327
branch = Branch.open_containing(location)[0]
6328
branch.bzrdir.destroy_branch()
6331
class cmd_shelve(Command):
6332
__doc__ = """Temporarily set aside some changes from the current tree.
6334
Shelve allows you to temporarily put changes you've made "on the shelf",
6335
ie. out of the way, until a later time when you can bring them back from
6336
the shelf with the 'unshelve' command. The changes are stored alongside
6337
your working tree, and so they aren't propagated along with your branch nor
6338
will they survive its deletion.
6340
If shelve --list is specified, previously-shelved changes are listed.
6342
Shelve is intended to help separate several sets of changes that have
6343
been inappropriately mingled. If you just want to get rid of all changes
6344
and you don't need to restore them later, use revert. If you want to
6345
shelve all text changes at once, use shelve --all.
6347
If filenames are specified, only the changes to those files will be
6348
shelved. Other files will be left untouched.
6350
If a revision is specified, changes since that revision will be shelved.
6352
You can put multiple items on the shelf, and by default, 'unshelve' will
6353
restore the most recently shelved changes.
6355
For complicated changes, it is possible to edit the changes in a separate
6356
editor program to decide what the file remaining in the working copy
6357
should look like. To do this, add the configuration option
6359
change_editor = PROGRAM @new_path @old_path
6361
where @new_path is replaced with the path of the new version of the
6362
file and @old_path is replaced with the path of the old version of
6363
the file. The PROGRAM should save the new file with the desired
6364
contents of the file in the working tree.
6368
takes_args = ['file*']
6373
Option('all', help='Shelve all changes.'),
6375
RegistryOption('writer', 'Method to use for writing diffs.',
6376
bzrlib.option.diff_writer_registry,
6377
value_switches=True, enum_switch=False),
6379
Option('list', help='List shelved changes.'),
6381
help='Destroy removed changes instead of shelving them.'),
6383
_see_also = ['unshelve', 'configuration']
6385
def run(self, revision=None, all=False, file_list=None, message=None,
6386
writer=None, list=False, destroy=False, directory=None):
6388
return self.run_for_list(directory=directory)
6389
from bzrlib.shelf_ui import Shelver
6391
writer = bzrlib.option.diff_writer_registry.get()
6393
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6394
file_list, message, destroy=destroy, directory=directory)
6399
except errors.UserAbort:
6402
def run_for_list(self, directory=None):
6403
if directory is None:
6405
tree = WorkingTree.open_containing(directory)[0]
6406
self.add_cleanup(tree.lock_read().unlock)
6407
manager = tree.get_shelf_manager()
6408
shelves = manager.active_shelves()
6409
if len(shelves) == 0:
6410
note(gettext('No shelved changes.'))
6412
for shelf_id in reversed(shelves):
6413
message = manager.get_metadata(shelf_id).get('message')
6415
message = '<no message>'
6416
self.outf.write('%3d: %s\n' % (shelf_id, message))
6420
class cmd_unshelve(Command):
6421
__doc__ = """Restore shelved changes.
6423
By default, the most recently shelved changes are restored. However if you
6424
specify a shelf by id those changes will be restored instead. This works
6425
best when the changes don't depend on each other.
6428
takes_args = ['shelf_id?']
6431
RegistryOption.from_kwargs(
6432
'action', help="The action to perform.",
6433
enum_switch=False, value_switches=True,
6434
apply="Apply changes and remove from the shelf.",
6435
dry_run="Show changes, but do not apply or remove them.",
6436
preview="Instead of unshelving the changes, show the diff that "
6437
"would result from unshelving.",
6438
delete_only="Delete changes without applying them.",
6439
keep="Apply changes but don't delete them.",
6442
_see_also = ['shelve']
6444
def run(self, shelf_id=None, action='apply', directory=u'.'):
6445
from bzrlib.shelf_ui import Unshelver
6446
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6450
unshelver.tree.unlock()
6453
class cmd_clean_tree(Command):
6454
__doc__ = """Remove unwanted files from working tree.
6456
By default, only unknown files, not ignored files, are deleted. Versioned
6457
files are never deleted.
6459
Another class is 'detritus', which includes files emitted by bzr during
6460
normal operations and selftests. (The value of these files decreases with
6463
If no options are specified, unknown files are deleted. Otherwise, option
6464
flags are respected, and may be combined.
6466
To check what clean-tree will do, use --dry-run.
6468
takes_options = ['directory',
6469
Option('ignored', help='Delete all ignored files.'),
6470
Option('detritus', help='Delete conflict files, merge and revert'
6471
' backups, and failed selftest dirs.'),
6473
help='Delete files unknown to bzr (default).'),
6474
Option('dry-run', help='Show files to delete instead of'
6476
Option('force', help='Do not prompt before deleting.')]
6477
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6478
force=False, directory=u'.'):
6479
from bzrlib.clean_tree import clean_tree
6480
if not (unknown or ignored or detritus):
6484
clean_tree(directory, unknown=unknown, ignored=ignored,
6485
detritus=detritus, dry_run=dry_run, no_prompt=force)
6488
class cmd_reference(Command):
6489
__doc__ = """list, view and set branch locations for nested trees.
6491
If no arguments are provided, lists the branch locations for nested trees.
6492
If one argument is provided, display the branch location for that tree.
6493
If two arguments are provided, set the branch location for that tree.
6498
takes_args = ['path?', 'location?']
6500
def run(self, path=None, location=None):
6502
if path is not None:
6504
tree, branch, relpath =(
6505
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6506
if path is not None:
6509
tree = branch.basis_tree()
6511
info = branch._get_all_reference_info().iteritems()
6512
self._display_reference_info(tree, branch, info)
6514
file_id = tree.path2id(path)
6516
raise errors.NotVersionedError(path)
6517
if location is None:
6518
info = [(file_id, branch.get_reference_info(file_id))]
6519
self._display_reference_info(tree, branch, info)
6521
branch.set_reference_info(file_id, path, location)
6523
def _display_reference_info(self, tree, branch, info):
6525
for file_id, (path, location) in info:
6527
path = tree.id2path(file_id)
6528
except errors.NoSuchId:
6530
ref_list.append((path, location))
6531
for path, location in sorted(ref_list):
6532
self.outf.write('%s %s\n' % (path, location))
6535
class cmd_export_pot(Command):
6536
__doc__ = """Export command helps and error messages in po format."""
6539
takes_options = [Option('plugin',
6540
help='Export help text from named command '\
6541
'(defaults to all built in commands).',
6544
def run(self, plugin=None):
6545
from bzrlib.export_pot import export_pot
6546
export_pot(self.outf, plugin)
6549
def _register_lazy_builtins():
6550
# register lazy builtins from other modules; called at startup and should
6551
# be only called once.
6552
for (name, aliases, module_name) in [
6553
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6554
('cmd_config', [], 'bzrlib.config'),
6555
('cmd_dpush', [], 'bzrlib.foreign'),
6556
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6557
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6558
('cmd_conflicts', [], 'bzrlib.conflicts'),
6559
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6560
('cmd_verify_signatures', [],
6561
'bzrlib.commit_signature_commands'),
6562
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6564
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
