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
from __future__ import absolute_import
19
"""builtin bzr commands"""
25
from bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
40
config as _mod_config,
50
revision as _mod_revision,
59
from bzrlib.branch import Branch
60
from bzrlib.conflicts import ConflictList
61
from bzrlib.transport import memory
62
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
63
from bzrlib.smtp_connection import SMTPConnection
64
from bzrlib.workingtree import WorkingTree
65
from bzrlib.i18n import gettext, ngettext
68
from bzrlib.commands import (
70
builtin_command_registry,
73
from bzrlib.option import (
80
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
86
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
87
def tree_files(file_list, default_branch=u'.', canonicalize=True,
89
return internal_tree_files(file_list, default_branch, canonicalize,
93
def tree_files_for_add(file_list):
95
Return a tree and list of absolute paths from a file list.
97
Similar to tree_files, but add handles files a bit differently, so it a
98
custom implementation. In particular, MutableTreeTree.smart_add expects
99
absolute paths, which it immediately converts to relative paths.
101
# FIXME Would be nice to just return the relative paths like
102
# internal_tree_files does, but there are a large number of unit tests
103
# that assume the current interface to mutabletree.smart_add
105
tree, relpath = WorkingTree.open_containing(file_list[0])
106
if tree.supports_views():
107
view_files = tree.views.lookup_view()
109
for filename in file_list:
110
if not osutils.is_inside_any(view_files, filename):
111
raise errors.FileOutsideView(filename, view_files)
112
file_list = file_list[:]
113
file_list[0] = tree.abspath(relpath)
115
tree = WorkingTree.open_containing(u'.')[0]
116
if tree.supports_views():
117
view_files = tree.views.lookup_view()
119
file_list = view_files
120
view_str = views.view_display_str(view_files)
121
note(gettext("Ignoring files outside view. View is %s") % view_str)
122
return tree, file_list
125
def _get_one_revision(command_name, revisions):
126
if revisions is None:
128
if len(revisions) != 1:
129
raise errors.BzrCommandError(gettext(
130
'bzr %s --revision takes exactly one revision identifier') % (
135
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
136
"""Get a revision tree. Not suitable for commands that change the tree.
138
Specifically, the basis tree in dirstate trees is coupled to the dirstate
139
and doing a commit/uncommit/pull will at best fail due to changing the
142
If tree is passed in, it should be already locked, for lifetime management
143
of the trees internal cached state.
147
if revisions is None:
149
rev_tree = tree.basis_tree()
151
rev_tree = branch.basis_tree()
153
revision = _get_one_revision(command_name, revisions)
154
rev_tree = revision.as_tree(branch)
158
# XXX: Bad function name; should possibly also be a class method of
159
# WorkingTree rather than a function.
160
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
161
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
163
"""Convert command-line paths to a WorkingTree and relative paths.
165
Deprecated: use WorkingTree.open_containing_paths instead.
167
This is typically used for command-line processors that take one or
168
more filenames, and infer the workingtree that contains them.
170
The filenames given are not required to exist.
172
:param file_list: Filenames to convert.
174
:param default_branch: Fallback tree path to use if file_list is empty or
177
:param apply_view: if True and a view is set, apply it or check that
178
specified files are within it
180
:return: workingtree, [relative_paths]
182
return WorkingTree.open_containing_paths(
183
file_list, default_directory='.',
188
def _get_view_info_for_change_reporter(tree):
189
"""Get the view information from a tree for change reporting."""
192
current_view = tree.views.get_view_info()[0]
193
if current_view is not None:
194
view_info = (current_view, tree.views.lookup_view())
195
except errors.ViewsNotSupported:
200
def _open_directory_or_containing_tree_or_branch(filename, directory):
201
"""Open the tree or branch containing the specified file, unless
202
the --directory option is used to specify a different branch."""
203
if directory is not None:
204
return (None, Branch.open(directory), filename)
205
return controldir.ControlDir.open_containing_tree_or_branch(filename)
208
# TODO: Make sure no commands unconditionally use the working directory as a
209
# branch. If a filename argument is used, the first of them should be used to
210
# specify the branch. (Perhaps this can be factored out into some kind of
211
# Argument class, representing a file in a branch, where the first occurrence
214
class cmd_status(Command):
215
__doc__ = """Display status summary.
217
This reports on versioned and unknown files, reporting them
218
grouped by state. Possible states are:
221
Versioned in the working copy but not in the previous revision.
224
Versioned in the previous revision but removed or deleted
228
Path of this file changed from the previous revision;
229
the text may also have changed. This includes files whose
230
parent directory was renamed.
233
Text has changed since the previous revision.
236
File kind has been changed (e.g. from file to directory).
239
Not versioned and not matching an ignore pattern.
241
Additionally for directories, symlinks and files with a changed
242
executable bit, Bazaar indicates their type using a trailing
243
character: '/', '@' or '*' respectively. These decorations can be
244
disabled using the '--no-classify' option.
246
To see ignored files use 'bzr ignored'. For details on the
247
changes to file texts, use 'bzr diff'.
249
Note that --short or -S gives status flags for each item, similar
250
to Subversion's status command. To get output similar to svn -q,
253
If no arguments are specified, the status of the entire working
254
directory is shown. Otherwise, only the status of the specified
255
files or directories is reported. If a directory is given, status
256
is reported for everything inside that directory.
258
Before merges are committed, the pending merge tip revisions are
259
shown. To see all pending merge revisions, use the -v option.
260
To skip the display of pending merge information altogether, use
261
the no-pending option or specify a file/directory.
263
To compare the working directory to a specific revision, pass a
264
single revision to the revision argument.
266
To see which files have changed in a specific revision, or between
267
two revisions, pass a revision range to the revision argument.
268
This will produce the same results as calling 'bzr diff --summarize'.
271
# TODO: --no-recurse, --recurse options
273
takes_args = ['file*']
274
takes_options = ['show-ids', 'revision', 'change', 'verbose',
275
Option('short', help='Use short status indicators.',
277
Option('versioned', help='Only show versioned files.',
279
Option('no-pending', help='Don\'t show pending merges.',
281
Option('no-classify',
282
help='Do not mark object type using indicator.',
285
aliases = ['st', 'stat']
287
encoding_type = 'replace'
288
_see_also = ['diff', 'revert', 'status-flags']
291
def run(self, show_ids=False, file_list=None, revision=None, short=False,
292
versioned=False, no_pending=False, verbose=False,
294
from bzrlib.status import show_tree_status
296
if revision and len(revision) > 2:
297
raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
298
' one or two revision specifiers'))
300
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
301
# Avoid asking for specific files when that is not needed.
302
if relfile_list == ['']:
304
# Don't disable pending merges for full trees other than '.'.
305
if file_list == ['.']:
307
# A specific path within a tree was given.
308
elif relfile_list is not None:
310
show_tree_status(tree, show_ids=show_ids,
311
specific_files=relfile_list, revision=revision,
312
to_file=self.outf, short=short, versioned=versioned,
313
show_pending=(not no_pending), verbose=verbose,
314
classify=not no_classify)
317
class cmd_cat_revision(Command):
318
__doc__ = """Write out metadata for a revision.
320
The revision to print can either be specified by a specific
321
revision identifier, or you can use --revision.
325
takes_args = ['revision_id?']
326
takes_options = ['directory', 'revision']
327
# cat-revision is more for frontends so should be exact
330
def print_revision(self, revisions, revid):
331
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
332
record = stream.next()
333
if record.storage_kind == 'absent':
334
raise errors.NoSuchRevision(revisions, revid)
335
revtext = record.get_bytes_as('fulltext')
336
self.outf.write(revtext.decode('utf-8'))
339
def run(self, revision_id=None, revision=None, directory=u'.'):
340
if revision_id is not None and revision is not None:
341
raise errors.BzrCommandError(gettext('You can only supply one of'
342
' revision_id or --revision'))
343
if revision_id is None and revision is None:
344
raise errors.BzrCommandError(gettext('You must supply either'
345
' --revision or a revision_id'))
347
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
349
revisions = b.repository.revisions
350
if revisions is None:
351
raise errors.BzrCommandError(gettext('Repository %r does not support '
352
'access to raw revision texts'))
354
b.repository.lock_read()
356
# TODO: jam 20060112 should cat-revision always output utf-8?
357
if revision_id is not None:
358
revision_id = osutils.safe_revision_id(revision_id, warn=False)
360
self.print_revision(revisions, revision_id)
361
except errors.NoSuchRevision:
362
msg = gettext("The repository {0} contains no revision {1}.").format(
363
b.repository.base, revision_id)
364
raise errors.BzrCommandError(msg)
365
elif revision is not None:
368
raise errors.BzrCommandError(
369
gettext('You cannot specify a NULL revision.'))
370
rev_id = rev.as_revision_id(b)
371
self.print_revision(revisions, rev_id)
373
b.repository.unlock()
376
class cmd_dump_btree(Command):
377
__doc__ = """Dump the contents of a btree index file to stdout.
379
PATH is a btree index file, it can be any URL. This includes things like
380
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
382
By default, the tuples stored in the index file will be displayed. With
383
--raw, we will uncompress the pages, but otherwise display the raw bytes
387
# TODO: Do we want to dump the internal nodes as well?
388
# TODO: It would be nice to be able to dump the un-parsed information,
389
# rather than only going through iter_all_entries. However, this is
390
# good enough for a start
392
encoding_type = 'exact'
393
takes_args = ['path']
394
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
395
' rather than the parsed tuples.'),
398
def run(self, path, raw=False):
399
dirname, basename = osutils.split(path)
400
t = transport.get_transport(dirname)
402
self._dump_raw_bytes(t, basename)
404
self._dump_entries(t, basename)
406
def _get_index_and_bytes(self, trans, basename):
407
"""Create a BTreeGraphIndex and raw bytes."""
408
bt = btree_index.BTreeGraphIndex(trans, basename, None)
409
bytes = trans.get_bytes(basename)
410
bt._file = cStringIO.StringIO(bytes)
411
bt._size = len(bytes)
414
def _dump_raw_bytes(self, trans, basename):
417
# We need to parse at least the root node.
418
# This is because the first page of every row starts with an
419
# uncompressed header.
420
bt, bytes = self._get_index_and_bytes(trans, basename)
421
for page_idx, page_start in enumerate(xrange(0, len(bytes),
422
btree_index._PAGE_SIZE)):
423
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
424
page_bytes = bytes[page_start:page_end]
426
self.outf.write('Root node:\n')
427
header_end, data = bt._parse_header_from_bytes(page_bytes)
428
self.outf.write(page_bytes[:header_end])
430
self.outf.write('\nPage %d\n' % (page_idx,))
431
if len(page_bytes) == 0:
432
self.outf.write('(empty)\n');
434
decomp_bytes = zlib.decompress(page_bytes)
435
self.outf.write(decomp_bytes)
436
self.outf.write('\n')
438
def _dump_entries(self, trans, basename):
440
st = trans.stat(basename)
441
except errors.TransportNotPossible:
442
# We can't stat, so we'll fake it because we have to do the 'get()'
444
bt, _ = self._get_index_and_bytes(trans, basename)
446
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
447
for node in bt.iter_all_entries():
448
# Node is made up of:
449
# (index, key, value, [references])
453
refs_as_tuples = None
455
refs_as_tuples = static_tuple.as_tuples(refs)
456
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
457
self.outf.write('%s\n' % (as_tuple,))
460
class cmd_remove_tree(Command):
461
__doc__ = """Remove the working tree from a given branch/checkout.
463
Since a lightweight checkout is little more than a working tree
464
this will refuse to run against one.
466
To re-create the working tree, use "bzr checkout".
468
_see_also = ['checkout', 'working-trees']
469
takes_args = ['location*']
472
help='Remove the working tree even if it has '
473
'uncommitted or shelved changes.'),
476
def run(self, location_list, force=False):
477
if not location_list:
480
for location in location_list:
481
d = controldir.ControlDir.open(location)
484
working = d.open_workingtree()
485
except errors.NoWorkingTree:
486
raise errors.BzrCommandError(gettext("No working tree to remove"))
487
except errors.NotLocalUrl:
488
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
489
" of a remote path"))
491
if (working.has_changes()):
492
raise errors.UncommittedChanges(working)
493
if working.get_shelf_manager().last_shelf() is not None:
494
raise errors.ShelvedChanges(working)
496
if working.user_url != working.branch.user_url:
497
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
498
" from a lightweight checkout"))
500
d.destroy_workingtree()
503
class cmd_repair_workingtree(Command):
504
__doc__ = """Reset the working tree state file.
506
This is not meant to be used normally, but more as a way to recover from
507
filesystem corruption, etc. This rebuilds the working inventory back to a
508
'known good' state. Any new modifications (adding a file, renaming, etc)
509
will be lost, though modified files will still be detected as such.
511
Most users will want something more like "bzr revert" or "bzr update"
512
unless the state file has become corrupted.
514
By default this attempts to recover the current state by looking at the
515
headers of the state file. If the state file is too corrupted to even do
516
that, you can supply --revision to force the state of the tree.
519
takes_options = ['revision', 'directory',
521
help='Reset the tree even if it doesn\'t appear to be'
526
def run(self, revision=None, directory='.', force=False):
527
tree, _ = WorkingTree.open_containing(directory)
528
self.add_cleanup(tree.lock_tree_write().unlock)
532
except errors.BzrError:
533
pass # There seems to be a real error here, so we'll reset
536
raise errors.BzrCommandError(gettext(
537
'The tree does not appear to be corrupt. You probably'
538
' want "bzr revert" instead. Use "--force" if you are'
539
' sure you want to reset the working tree.'))
543
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
545
tree.reset_state(revision_ids)
546
except errors.BzrError, e:
547
if revision_ids is None:
548
extra = (gettext(', the header appears corrupt, try passing -r -1'
549
' to set the state to the last commit'))
552
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
555
class cmd_revno(Command):
556
__doc__ = """Show current revision number.
558
This is equal to the number of revisions on this branch.
562
takes_args = ['location?']
564
Option('tree', help='Show revno of working tree.'),
569
def run(self, tree=False, location=u'.', revision=None):
570
if revision is not None and tree:
571
raise errors.BzrCommandError(gettext("--tree and --revision can "
572
"not be used together"))
576
wt = WorkingTree.open_containing(location)[0]
577
self.add_cleanup(wt.lock_read().unlock)
578
except (errors.NoWorkingTree, errors.NotLocalUrl):
579
raise errors.NoWorkingTree(location)
581
revid = wt.last_revision()
583
b = Branch.open_containing(location)[0]
584
self.add_cleanup(b.lock_read().unlock)
586
if len(revision) != 1:
587
raise errors.BzrCommandError(gettext(
588
"Tags can only be placed on a single revision, "
590
revid = revision[0].as_revision_id(b)
592
revid = b.last_revision()
594
revno_t = b.revision_id_to_dotted_revno(revid)
595
except errors.NoSuchRevision:
597
revno = ".".join(str(n) for n in revno_t)
599
self.outf.write(revno + '\n')
602
class cmd_revision_info(Command):
603
__doc__ = """Show revision number and revision id for a given revision identifier.
606
takes_args = ['revision_info*']
609
custom_help('directory',
610
help='Branch to examine, '
611
'rather than the one containing the working directory.'),
612
Option('tree', help='Show revno of working tree.'),
616
def run(self, revision=None, directory=u'.', tree=False,
617
revision_info_list=[]):
620
wt = WorkingTree.open_containing(directory)[0]
622
self.add_cleanup(wt.lock_read().unlock)
623
except (errors.NoWorkingTree, errors.NotLocalUrl):
625
b = Branch.open_containing(directory)[0]
626
self.add_cleanup(b.lock_read().unlock)
628
if revision is not None:
629
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
630
if revision_info_list is not None:
631
for rev_str in revision_info_list:
632
rev_spec = RevisionSpec.from_string(rev_str)
633
revision_ids.append(rev_spec.as_revision_id(b))
634
# No arguments supplied, default to the last revision
635
if len(revision_ids) == 0:
638
raise errors.NoWorkingTree(directory)
639
revision_ids.append(wt.last_revision())
641
revision_ids.append(b.last_revision())
645
for revision_id in revision_ids:
647
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
648
revno = '.'.join(str(i) for i in dotted_revno)
649
except errors.NoSuchRevision:
651
maxlen = max(maxlen, len(revno))
652
revinfos.append([revno, revision_id])
656
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
659
class cmd_add(Command):
660
__doc__ = """Add specified files or directories.
662
In non-recursive mode, all the named items are added, regardless
663
of whether they were previously ignored. A warning is given if
664
any of the named files are already versioned.
666
In recursive mode (the default), files are treated the same way
667
but the behaviour for directories is different. Directories that
668
are already versioned do not give a warning. All directories,
669
whether already versioned or not, are searched for files or
670
subdirectories that are neither versioned or ignored, and these
671
are added. This search proceeds recursively into versioned
672
directories. If no names are given '.' is assumed.
674
A warning will be printed when nested trees are encountered,
675
unless they are explicitly ignored.
677
Therefore simply saying 'bzr add' will version all files that
678
are currently unknown.
680
Adding a file whose parent directory is not versioned will
681
implicitly add the parent, and so on up to the root. This means
682
you should never need to explicitly add a directory, they'll just
683
get added when you add a file in the directory.
685
--dry-run will show which files would be added, but not actually
688
--file-ids-from will try to use the file ids from the supplied path.
689
It looks up ids trying to find a matching parent directory with the
690
same filename, and then by pure path. This option is rarely needed
691
but can be useful when adding the same logical file into two
692
branches that will be merged later (without showing the two different
693
adds as a conflict). It is also useful when merging another project
694
into a subdirectory of this one.
696
Any files matching patterns in the ignore list will not be added
697
unless they are explicitly mentioned.
699
In recursive mode, files larger than the configuration option
700
add.maximum_file_size will be skipped. Named items are never skipped due
703
takes_args = ['file*']
706
help="Don't recursively add the contents of directories."),
708
help="Show what would be done, but don't actually do anything."),
710
Option('file-ids-from',
712
help='Lookup file ids from this tree.'),
714
encoding_type = 'replace'
715
_see_also = ['remove', 'ignore']
717
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
722
if file_ids_from is not None:
724
base_tree, base_path = WorkingTree.open_containing(
726
except errors.NoWorkingTree:
727
base_branch, base_path = Branch.open_containing(
729
base_tree = base_branch.basis_tree()
731
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
732
to_file=self.outf, should_print=(not is_quiet()))
734
action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
735
should_print=(not is_quiet()))
738
self.add_cleanup(base_tree.lock_read().unlock)
739
tree, file_list = tree_files_for_add(file_list)
740
added, ignored = tree.smart_add(file_list, not
741
no_recurse, action=action, save=not dry_run)
745
for glob in sorted(ignored.keys()):
746
for path in ignored[glob]:
748
gettext("ignored {0} matching \"{1}\"\n").format(
752
class cmd_mkdir(Command):
753
__doc__ = """Create a new versioned directory.
755
This is equivalent to creating the directory and then adding it.
758
takes_args = ['dir+']
762
help='No error if existing, make parent directories as needed.',
766
encoding_type = 'replace'
769
def add_file_with_parents(cls, wt, relpath):
770
if wt.path2id(relpath) is not None:
772
cls.add_file_with_parents(wt, osutils.dirname(relpath))
776
def add_file_single(cls, wt, relpath):
779
def run(self, dir_list, parents=False):
781
add_file = self.add_file_with_parents
783
add_file = self.add_file_single
785
wt, relpath = WorkingTree.open_containing(dir)
790
if e.errno != errno.EEXIST:
794
add_file(wt, relpath)
796
self.outf.write(gettext('added %s\n') % dir)
799
class cmd_relpath(Command):
800
__doc__ = """Show path of a file relative to root"""
802
takes_args = ['filename']
806
def run(self, filename):
807
# TODO: jam 20050106 Can relpath return a munged path if
808
# sys.stdout encoding cannot represent it?
809
tree, relpath = WorkingTree.open_containing(filename)
810
self.outf.write(relpath)
811
self.outf.write('\n')
814
class cmd_inventory(Command):
815
__doc__ = """Show inventory of the current working copy or a revision.
817
It is possible to limit the output to a particular entry
818
type using the --kind option. For example: --kind file.
820
It is also possible to restrict the list of files to a specific
821
set. For example: bzr inventory --show-ids this/file
830
help='List entries of a particular kind: file, directory, symlink.',
833
takes_args = ['file*']
836
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
837
if kind and kind not in ['file', 'directory', 'symlink']:
838
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
840
revision = _get_one_revision('inventory', revision)
841
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
842
self.add_cleanup(work_tree.lock_read().unlock)
843
if revision is not None:
844
tree = revision.as_tree(work_tree.branch)
846
extra_trees = [work_tree]
847
self.add_cleanup(tree.lock_read().unlock)
852
if file_list is not None:
853
file_ids = tree.paths2ids(file_list, trees=extra_trees,
854
require_versioned=True)
855
# find_ids_across_trees may include some paths that don't
858
(tree.id2path(file_id), tree.inventory[file_id])
859
for file_id in file_ids if tree.has_id(file_id))
861
entries = tree.inventory.entries()
864
for path, entry in entries:
865
if kind and kind != entry.kind:
868
self.outf.write('%-50s %s\n' % (path, entry.file_id))
870
self.outf.write(path)
871
self.outf.write('\n')
874
class cmd_mv(Command):
875
__doc__ = """Move or rename a file.
878
bzr mv OLDNAME NEWNAME
880
bzr mv SOURCE... DESTINATION
882
If the last argument is a versioned directory, all the other names
883
are moved into it. Otherwise, there must be exactly two arguments
884
and the file is changed to a new name.
886
If OLDNAME does not exist on the filesystem but is versioned and
887
NEWNAME does exist on the filesystem but is not versioned, mv
888
assumes that the file has been manually moved and only updates
889
its internal inventory to reflect that change.
890
The same is valid when moving many SOURCE files to a DESTINATION.
892
Files cannot be moved between branches.
895
takes_args = ['names*']
896
takes_options = [Option("after", help="Move only the bzr identifier"
897
" of the file, because the file has already been moved."),
898
Option('auto', help='Automatically guess renames.'),
899
Option('dry-run', help='Avoid making changes when guessing renames.'),
901
aliases = ['move', 'rename']
902
encoding_type = 'replace'
904
def run(self, names_list, after=False, auto=False, dry_run=False):
906
return self.run_auto(names_list, after, dry_run)
908
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
909
if names_list is None:
911
if len(names_list) < 2:
912
raise errors.BzrCommandError(gettext("missing file argument"))
913
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
914
for file_name in rel_names[0:-1]:
916
raise errors.BzrCommandError(gettext("can not move root of branch"))
917
self.add_cleanup(tree.lock_tree_write().unlock)
918
self._run(tree, names_list, rel_names, after)
920
def run_auto(self, names_list, after, dry_run):
921
if names_list is not None and len(names_list) > 1:
922
raise errors.BzrCommandError(gettext('Only one path may be specified to'
925
raise errors.BzrCommandError(gettext('--after cannot be specified with'
927
work_tree, file_list = WorkingTree.open_containing_paths(
928
names_list, default_directory='.')
929
self.add_cleanup(work_tree.lock_tree_write().unlock)
930
rename_map.RenameMap.guess_renames(work_tree, dry_run)
932
def _run(self, tree, names_list, rel_names, after):
933
into_existing = osutils.isdir(names_list[-1])
934
if into_existing and len(names_list) == 2:
936
# a. case-insensitive filesystem and change case of dir
937
# b. move directory after the fact (if the source used to be
938
# a directory, but now doesn't exist in the working tree
939
# and the target is an existing directory, just rename it)
940
if (not tree.case_sensitive
941
and rel_names[0].lower() == rel_names[1].lower()):
942
into_existing = False
945
# 'fix' the case of a potential 'from'
946
from_id = tree.path2id(
947
tree.get_canonical_inventory_path(rel_names[0]))
948
if (not osutils.lexists(names_list[0]) and
949
from_id and inv.get_file_kind(from_id) == "directory"):
950
into_existing = False
953
# move into existing directory
954
# All entries reference existing inventory items, so fix them up
955
# for cicp file-systems.
956
rel_names = tree.get_canonical_inventory_paths(rel_names)
957
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
959
self.outf.write("%s => %s\n" % (src, dest))
961
if len(names_list) != 2:
962
raise errors.BzrCommandError(gettext('to mv multiple files the'
963
' destination must be a versioned'
966
# for cicp file-systems: the src references an existing inventory
968
src = tree.get_canonical_inventory_path(rel_names[0])
969
# Find the canonical version of the destination: In all cases, the
970
# parent of the target must be in the inventory, so we fetch the
971
# canonical version from there (we do not always *use* the
972
# canonicalized tail portion - we may be attempting to rename the
974
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
975
dest_parent = osutils.dirname(canon_dest)
976
spec_tail = osutils.basename(rel_names[1])
977
# For a CICP file-system, we need to avoid creating 2 inventory
978
# entries that differ only by case. So regardless of the case
979
# we *want* to use (ie, specified by the user or the file-system),
980
# we must always choose to use the case of any existing inventory
981
# items. The only exception to this is when we are attempting a
982
# case-only rename (ie, canonical versions of src and dest are
984
dest_id = tree.path2id(canon_dest)
985
if dest_id is None or tree.path2id(src) == dest_id:
986
# No existing item we care about, so work out what case we
987
# are actually going to use.
989
# If 'after' is specified, the tail must refer to a file on disk.
991
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
993
# pathjoin with an empty tail adds a slash, which breaks
995
dest_parent_fq = tree.basedir
997
dest_tail = osutils.canonical_relpath(
999
osutils.pathjoin(dest_parent_fq, spec_tail))
1001
# not 'after', so case as specified is used
1002
dest_tail = spec_tail
1004
# Use the existing item so 'mv' fails with AlreadyVersioned.
1005
dest_tail = os.path.basename(canon_dest)
1006
dest = osutils.pathjoin(dest_parent, dest_tail)
1007
mutter("attempting to move %s => %s", src, dest)
1008
tree.rename_one(src, dest, after=after)
1010
self.outf.write("%s => %s\n" % (src, dest))
1013
class cmd_pull(Command):
1014
__doc__ = """Turn this branch into a mirror of another branch.
1016
By default, this command only works on branches that have not diverged.
1017
Branches are considered diverged if the destination branch's most recent
1018
commit is one that has not been merged (directly or indirectly) into the
1021
If branches have diverged, you can use 'bzr merge' to integrate the changes
1022
from one into the other. Once one branch has merged, the other should
1023
be able to pull it again.
1025
If you want to replace your local changes and just want your branch to
1026
match the remote one, use pull --overwrite. This will work even if the two
1027
branches have diverged.
1029
If there is no default location set, the first pull will set it (use
1030
--no-remember to avoid setting it). After that, you can omit the
1031
location to use the default. To change the default, use --remember. The
1032
value will only be saved if the remote location can be accessed.
1034
The --verbose option will display the revisions pulled using the log_format
1035
configuration option. You can use a different format by overriding it with
1036
-Olog_format=<other_format>.
1038
Note: The location can be specified either in the form of a branch,
1039
or in the form of a path to a file containing a merge directive generated
1043
_see_also = ['push', 'update', 'status-flags', 'send']
1044
takes_options = ['remember', 'overwrite', 'revision',
1045
custom_help('verbose',
1046
help='Show logs of pulled revisions.'),
1047
custom_help('directory',
1048
help='Branch to pull into, '
1049
'rather than the one containing the working directory.'),
1051
help="Perform a local pull in a bound "
1052
"branch. Local pulls are not applied to "
1053
"the master branch."
1056
help="Show base revision text in conflicts.")
1058
takes_args = ['location?']
1059
encoding_type = 'replace'
1061
def run(self, location=None, remember=None, overwrite=False,
1062
revision=None, verbose=False,
1063
directory=None, local=False,
1065
# FIXME: too much stuff is in the command class
1068
if directory is None:
1071
tree_to = WorkingTree.open_containing(directory)[0]
1072
branch_to = tree_to.branch
1073
self.add_cleanup(tree_to.lock_write().unlock)
1074
except errors.NoWorkingTree:
1076
branch_to = Branch.open_containing(directory)[0]
1077
self.add_cleanup(branch_to.lock_write().unlock)
1079
if tree_to is None and show_base:
1080
raise errors.BzrCommandError(gettext("Need working tree for --show-base."))
1082
if local and not branch_to.get_bound_location():
1083
raise errors.LocalRequiresBoundBranch()
1085
possible_transports = []
1086
if location is not None:
1088
mergeable = bundle.read_mergeable_from_url(location,
1089
possible_transports=possible_transports)
1090
except errors.NotABundle:
1093
stored_loc = branch_to.get_parent()
1094
if location is None:
1095
if stored_loc is None:
1096
raise errors.BzrCommandError(gettext("No pull location known or"
1099
display_url = urlutils.unescape_for_display(stored_loc,
1102
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1103
location = stored_loc
1105
revision = _get_one_revision('pull', revision)
1106
if mergeable is not None:
1107
if revision is not None:
1108
raise errors.BzrCommandError(gettext(
1109
'Cannot use -r with merge directives or bundles'))
1110
mergeable.install_revisions(branch_to.repository)
1111
base_revision_id, revision_id, verified = \
1112
mergeable.get_merge_request(branch_to.repository)
1113
branch_from = branch_to
1115
branch_from = Branch.open(location,
1116
possible_transports=possible_transports)
1117
self.add_cleanup(branch_from.lock_read().unlock)
1118
# Remembers if asked explicitly or no previous location is set
1120
or (remember is None and branch_to.get_parent() is None)):
1121
branch_to.set_parent(branch_from.base)
1123
if revision is not None:
1124
revision_id = revision.as_revision_id(branch_from)
1126
if tree_to is not None:
1127
view_info = _get_view_info_for_change_reporter(tree_to)
1128
change_reporter = delta._ChangeReporter(
1129
unversioned_filter=tree_to.is_ignored,
1130
view_info=view_info)
1131
result = tree_to.pull(
1132
branch_from, overwrite, revision_id, change_reporter,
1133
local=local, show_base=show_base)
1135
result = branch_to.pull(
1136
branch_from, overwrite, revision_id, local=local)
1138
result.report(self.outf)
1139
if verbose and result.old_revid != result.new_revid:
1140
log.show_branch_change(
1141
branch_to, self.outf, result.old_revno,
1143
if getattr(result, 'tag_conflicts', None):
1149
class cmd_push(Command):
1150
__doc__ = """Update a mirror of this branch.
1152
The target branch will not have its working tree populated because this
1153
is both expensive, and is not supported on remote file systems.
1155
Some smart servers or protocols *may* put the working tree in place in
1158
This command only works on branches that have not diverged. Branches are
1159
considered diverged if the destination branch's most recent commit is one
1160
that has not been merged (directly or indirectly) by the source branch.
1162
If branches have diverged, you can use 'bzr push --overwrite' to replace
1163
the other branch completely, discarding its unmerged changes.
1165
If you want to ensure you have the different changes in the other branch,
1166
do a merge (see bzr help merge) from the other branch, and commit that.
1167
After that you will be able to do a push without '--overwrite'.
1169
If there is no default push location set, the first push will set it (use
1170
--no-remember to avoid setting it). After that, you can omit the
1171
location to use the default. To change the default, use --remember. The
1172
value will only be saved if the remote location can be accessed.
1174
The --verbose option will display the revisions pushed using the log_format
1175
configuration option. You can use a different format by overriding it with
1176
-Olog_format=<other_format>.
1179
_see_also = ['pull', 'update', 'working-trees']
1180
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1181
Option('create-prefix',
1182
help='Create the path leading up to the branch '
1183
'if it does not already exist.'),
1184
custom_help('directory',
1185
help='Branch to push from, '
1186
'rather than the one containing the working directory.'),
1187
Option('use-existing-dir',
1188
help='By default push will fail if the target'
1189
' directory exists, but does not already'
1190
' have a control directory. This flag will'
1191
' allow push to proceed.'),
1193
help='Create a stacked branch that references the public location '
1194
'of the parent branch.'),
1195
Option('stacked-on',
1196
help='Create a stacked branch that refers to another branch '
1197
'for the commit history. Only the work not present in the '
1198
'referenced branch is included in the branch created.',
1201
help='Refuse to push if there are uncommitted changes in'
1202
' the working tree, --no-strict disables the check.'),
1204
help="Don't populate the working tree, even for protocols"
1205
" that support it."),
1207
takes_args = ['location?']
1208
encoding_type = 'replace'
1210
def run(self, location=None, remember=None, overwrite=False,
1211
create_prefix=False, verbose=False, revision=None,
1212
use_existing_dir=False, directory=None, stacked_on=None,
1213
stacked=False, strict=None, no_tree=False):
1214
from bzrlib.push import _show_push_branch
1216
if directory is None:
1218
# Get the source branch
1220
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1221
# Get the tip's revision_id
1222
revision = _get_one_revision('push', revision)
1223
if revision is not None:
1224
revision_id = revision.in_history(br_from).rev_id
1227
if tree is not None and revision_id is None:
1228
tree.check_changed_or_out_of_date(
1229
strict, 'push_strict',
1230
more_error='Use --no-strict to force the push.',
1231
more_warning='Uncommitted changes will not be pushed.')
1232
# Get the stacked_on branch, if any
1233
if stacked_on is not None:
1234
stacked_on = urlutils.normalize_url(stacked_on)
1236
parent_url = br_from.get_parent()
1238
parent = Branch.open(parent_url)
1239
stacked_on = parent.get_public_branch()
1241
# I considered excluding non-http url's here, thus forcing
1242
# 'public' branches only, but that only works for some
1243
# users, so it's best to just depend on the user spotting an
1244
# error by the feedback given to them. RBC 20080227.
1245
stacked_on = parent_url
1247
raise errors.BzrCommandError(gettext(
1248
"Could not determine branch to refer to."))
1250
# Get the destination location
1251
if location is None:
1252
stored_loc = br_from.get_push_location()
1253
if stored_loc is None:
1254
raise errors.BzrCommandError(gettext(
1255
"No push location known or specified."))
1257
display_url = urlutils.unescape_for_display(stored_loc,
1259
note(gettext("Using saved push location: %s") % display_url)
1260
location = stored_loc
1262
_show_push_branch(br_from, revision_id, location, self.outf,
1263
verbose=verbose, overwrite=overwrite, remember=remember,
1264
stacked_on=stacked_on, create_prefix=create_prefix,
1265
use_existing_dir=use_existing_dir, no_tree=no_tree)
1268
class cmd_branch(Command):
1269
__doc__ = """Create a new branch that is a copy of an existing branch.
1271
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1272
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1273
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1274
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1275
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1278
To retrieve the branch as of a particular revision, supply the --revision
1279
parameter, as in "branch foo/bar -r 5".
1281
The synonyms 'clone' and 'get' for this command are deprecated.
1284
_see_also = ['checkout']
1285
takes_args = ['from_location', 'to_location?']
1286
takes_options = ['revision',
1287
Option('hardlink', help='Hard-link working tree files where possible.'),
1288
Option('files-from', type=str,
1289
help="Get file contents from this tree."),
1291
help="Create a branch without a working-tree."),
1293
help="Switch the checkout in the current directory "
1294
"to the new branch."),
1296
help='Create a stacked branch referring to the source branch. '
1297
'The new branch will depend on the availability of the source '
1298
'branch for all operations.'),
1299
Option('standalone',
1300
help='Do not use a shared repository, even if available.'),
1301
Option('use-existing-dir',
1302
help='By default branch will fail if the target'
1303
' directory exists, but does not already'
1304
' have a control directory. This flag will'
1305
' allow branch to proceed.'),
1307
help="Bind new branch to from location."),
1309
aliases = ['get', 'clone']
1311
def run(self, from_location, to_location=None, revision=None,
1312
hardlink=False, stacked=False, standalone=False, no_tree=False,
1313
use_existing_dir=False, switch=False, bind=False,
1315
from bzrlib import switch as _mod_switch
1316
from bzrlib.tag import _merge_tags_if_possible
1317
if self.invoked_as in ['get', 'clone']:
1318
ui.ui_factory.show_user_warning(
1319
'deprecated_command',
1320
deprecated_name=self.invoked_as,
1321
recommended_name='branch',
1322
deprecated_in_version='2.4')
1323
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1325
if not (hardlink or files_from):
1326
# accelerator_tree is usually slower because you have to read N
1327
# files (no readahead, lots of seeks, etc), but allow the user to
1328
# explicitly request it
1329
accelerator_tree = None
1330
if files_from is not None and files_from != from_location:
1331
accelerator_tree = WorkingTree.open(files_from)
1332
revision = _get_one_revision('branch', revision)
1333
self.add_cleanup(br_from.lock_read().unlock)
1334
if revision is not None:
1335
revision_id = revision.as_revision_id(br_from)
1337
# FIXME - wt.last_revision, fallback to branch, fall back to
1338
# None or perhaps NULL_REVISION to mean copy nothing
1340
revision_id = br_from.last_revision()
1341
if to_location is None:
1342
to_location = getattr(br_from, "name", None)
1343
if to_location is None:
1344
to_location = urlutils.derive_to_location(from_location)
1345
to_transport = transport.get_transport(to_location)
1347
to_transport.mkdir('.')
1348
except errors.FileExists:
1350
to_dir = controldir.ControlDir.open_from_transport(
1352
except errors.NotBranchError:
1353
if not use_existing_dir:
1354
raise errors.BzrCommandError(gettext('Target directory "%s" '
1355
'already exists.') % to_location)
1360
to_dir.open_branch()
1361
except errors.NotBranchError:
1364
raise errors.AlreadyBranchError(to_location)
1365
except errors.NoSuchFile:
1366
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1372
# preserve whatever source format we have.
1373
to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1374
possible_transports=[to_transport],
1375
accelerator_tree=accelerator_tree,
1376
hardlink=hardlink, stacked=stacked,
1377
force_new_repo=standalone,
1378
create_tree_if_local=not no_tree,
1379
source_branch=br_from)
1380
branch = to_dir.open_branch(
1381
possible_transports=[
1382
br_from.bzrdir.root_transport, to_transport])
1383
except errors.NoSuchRevision:
1384
to_transport.delete_tree('.')
1385
msg = gettext("The branch {0} has no revision {1}.").format(
1386
from_location, revision)
1387
raise errors.BzrCommandError(msg)
1389
branch = br_from.sprout(to_dir, revision_id=revision_id)
1390
_merge_tags_if_possible(br_from, branch)
1391
# If the source branch is stacked, the new branch may
1392
# be stacked whether we asked for that explicitly or not.
1393
# We therefore need a try/except here and not just 'if stacked:'
1395
note(gettext('Created new stacked branch referring to %s.') %
1396
branch.get_stacked_on_url())
1397
except (errors.NotStacked, errors.UnstackableBranchFormat,
1398
errors.UnstackableRepositoryFormat), e:
1399
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1401
# Bind to the parent
1402
parent_branch = Branch.open(from_location)
1403
branch.bind(parent_branch)
1404
note(gettext('New branch bound to %s') % from_location)
1406
# Switch to the new branch
1407
wt, _ = WorkingTree.open_containing('.')
1408
_mod_switch.switch(wt.bzrdir, branch)
1409
note(gettext('Switched to branch: %s'),
1410
urlutils.unescape_for_display(branch.base, 'utf-8'))
1413
class cmd_branches(Command):
1414
__doc__ = """List the branches available at the current location.
1416
This command will print the names of all the branches at the current
1420
takes_args = ['location?']
1422
Option('recursive', short_name='R',
1423
help='Recursively scan for branches rather than '
1424
'just looking in the specified location.')]
1426
def run(self, location=".", recursive=False):
1428
t = transport.get_transport(location)
1429
if not t.listable():
1430
raise errors.BzrCommandError(
1431
"Can't scan this type of location.")
1432
for b in controldir.ControlDir.find_branches(t):
1433
self.outf.write("%s\n" % urlutils.unescape_for_display(
1434
urlutils.relative_url(t.base, b.base),
1435
self.outf.encoding).rstrip("/"))
1437
dir = controldir.ControlDir.open_containing(location)[0]
1438
for branch in dir.list_branches():
1439
if branch.name is None:
1440
self.outf.write(gettext(" (default)\n"))
1442
self.outf.write(" %s\n" % branch.name.encode(
1443
self.outf.encoding))
1446
class cmd_checkout(Command):
1447
__doc__ = """Create a new checkout of an existing branch.
1449
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1450
the branch found in '.'. This is useful if you have removed the working tree
1451
or if it was never created - i.e. if you pushed the branch to its current
1452
location using SFTP.
1454
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1455
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1456
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1457
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1458
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1461
To retrieve the branch as of a particular revision, supply the --revision
1462
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1463
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1467
_see_also = ['checkouts', 'branch']
1468
takes_args = ['branch_location?', 'to_location?']
1469
takes_options = ['revision',
1470
Option('lightweight',
1471
help="Perform a lightweight checkout. Lightweight "
1472
"checkouts depend on access to the branch for "
1473
"every operation. Normal checkouts can perform "
1474
"common operations like diff and status without "
1475
"such access, and also support local commits."
1477
Option('files-from', type=str,
1478
help="Get file contents from this tree."),
1480
help='Hard-link working tree files where possible.'
1485
def run(self, branch_location=None, to_location=None, revision=None,
1486
lightweight=False, files_from=None, hardlink=False):
1487
if branch_location is None:
1488
branch_location = osutils.getcwd()
1489
to_location = branch_location
1490
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1492
if not (hardlink or files_from):
1493
# accelerator_tree is usually slower because you have to read N
1494
# files (no readahead, lots of seeks, etc), but allow the user to
1495
# explicitly request it
1496
accelerator_tree = None
1497
revision = _get_one_revision('checkout', revision)
1498
if files_from is not None and files_from != branch_location:
1499
accelerator_tree = WorkingTree.open(files_from)
1500
if revision is not None:
1501
revision_id = revision.as_revision_id(source)
1504
if to_location is None:
1505
to_location = urlutils.derive_to_location(branch_location)
1506
# if the source and to_location are the same,
1507
# and there is no working tree,
1508
# then reconstitute a branch
1509
if (osutils.abspath(to_location) ==
1510
osutils.abspath(branch_location)):
1512
source.bzrdir.open_workingtree()
1513
except errors.NoWorkingTree:
1514
source.bzrdir.create_workingtree(revision_id)
1516
source.create_checkout(to_location, revision_id, lightweight,
1517
accelerator_tree, hardlink)
1520
class cmd_renames(Command):
1521
__doc__ = """Show list of renamed files.
1523
# TODO: Option to show renames between two historical versions.
1525
# TODO: Only show renames under dir, rather than in the whole branch.
1526
_see_also = ['status']
1527
takes_args = ['dir?']
1530
def run(self, dir=u'.'):
1531
tree = WorkingTree.open_containing(dir)[0]
1532
self.add_cleanup(tree.lock_read().unlock)
1533
new_inv = tree.inventory
1534
old_tree = tree.basis_tree()
1535
self.add_cleanup(old_tree.lock_read().unlock)
1536
old_inv = old_tree.inventory
1538
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1539
for f, paths, c, v, p, n, k, e in iterator:
1540
if paths[0] == paths[1]:
1544
renames.append(paths)
1546
for old_name, new_name in renames:
1547
self.outf.write("%s => %s\n" % (old_name, new_name))
1550
class cmd_update(Command):
1551
__doc__ = """Update a working tree to a new revision.
1553
This will perform a merge of the destination revision (the tip of the
1554
branch, or the specified revision) into the working tree, and then make
1555
that revision the basis revision for the working tree.
1557
You can use this to visit an older revision, or to update a working tree
1558
that is out of date from its branch.
1560
If there are any uncommitted changes in the tree, they will be carried
1561
across and remain as uncommitted changes after the update. To discard
1562
these changes, use 'bzr revert'. The uncommitted changes may conflict
1563
with the changes brought in by the change in basis revision.
1565
If the tree's branch is bound to a master branch, bzr will also update
1566
the branch from the master.
1568
You cannot update just a single file or directory, because each Bazaar
1569
working tree has just a single basis revision. If you want to restore a
1570
file that has been removed locally, use 'bzr revert' instead of 'bzr
1571
update'. If you want to restore a file to its state in a previous
1572
revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
1573
out the old content of that file to a new location.
1575
The 'dir' argument, if given, must be the location of the root of a
1576
working tree to update. By default, the working tree that contains the
1577
current working directory is used.
1580
_see_also = ['pull', 'working-trees', 'status-flags']
1581
takes_args = ['dir?']
1582
takes_options = ['revision',
1584
help="Show base revision text in conflicts."),
1588
def run(self, dir=None, revision=None, show_base=None):
1589
if revision is not None and len(revision) != 1:
1590
raise errors.BzrCommandError(gettext(
1591
"bzr update --revision takes exactly one revision"))
1593
tree = WorkingTree.open_containing('.')[0]
1595
tree, relpath = WorkingTree.open_containing(dir)
1598
raise errors.BzrCommandError(gettext(
1599
"bzr update can only update a whole tree, "
1600
"not a file or subdirectory"))
1601
branch = tree.branch
1602
possible_transports = []
1603
master = branch.get_master_branch(
1604
possible_transports=possible_transports)
1605
if master is not None:
1606
branch_location = master.base
1609
branch_location = tree.branch.base
1610
tree.lock_tree_write()
1611
self.add_cleanup(tree.unlock)
1612
# get rid of the final '/' and be ready for display
1613
branch_location = urlutils.unescape_for_display(
1614
branch_location.rstrip('/'),
1616
existing_pending_merges = tree.get_parent_ids()[1:]
1620
# may need to fetch data into a heavyweight checkout
1621
# XXX: this may take some time, maybe we should display a
1623
old_tip = branch.update(possible_transports)
1624
if revision is not None:
1625
revision_id = revision[0].as_revision_id(branch)
1627
revision_id = branch.last_revision()
1628
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1629
revno = branch.revision_id_to_dotted_revno(revision_id)
1630
note(gettext("Tree is up to date at revision {0} of branch {1}"
1631
).format('.'.join(map(str, revno)), branch_location))
1633
view_info = _get_view_info_for_change_reporter(tree)
1634
change_reporter = delta._ChangeReporter(
1635
unversioned_filter=tree.is_ignored,
1636
view_info=view_info)
1638
conflicts = tree.update(
1640
possible_transports=possible_transports,
1641
revision=revision_id,
1643
show_base=show_base)
1644
except errors.NoSuchRevision, e:
1645
raise errors.BzrCommandError(gettext(
1646
"branch has no revision %s\n"
1647
"bzr update --revision only works"
1648
" for a revision in the branch history")
1650
revno = tree.branch.revision_id_to_dotted_revno(
1651
_mod_revision.ensure_null(tree.last_revision()))
1652
note(gettext('Updated to revision {0} of branch {1}').format(
1653
'.'.join(map(str, revno)), branch_location))
1654
parent_ids = tree.get_parent_ids()
1655
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1656
note(gettext('Your local commits will now show as pending merges with '
1657
"'bzr status', and can be committed with 'bzr commit'."))
1664
class cmd_info(Command):
1665
__doc__ = """Show information about a working tree, branch or repository.
1667
This command will show all known locations and formats associated to the
1668
tree, branch or repository.
1670
In verbose mode, statistical information is included with each report.
1671
To see extended statistic information, use a verbosity level of 2 or
1672
higher by specifying the verbose option multiple times, e.g. -vv.
1674
Branches and working trees will also report any missing revisions.
1678
Display information on the format and related locations:
1682
Display the above together with extended format information and
1683
basic statistics (like the number of files in the working tree and
1684
number of revisions in the branch and repository):
1688
Display the above together with number of committers to the branch:
1692
_see_also = ['revno', 'working-trees', 'repositories']
1693
takes_args = ['location?']
1694
takes_options = ['verbose']
1695
encoding_type = 'replace'
1698
def run(self, location=None, verbose=False):
1700
noise_level = get_verbosity_level()
1703
from bzrlib.info import show_bzrdir_info
1704
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1705
verbose=noise_level, outfile=self.outf)
1708
class cmd_remove(Command):
1709
__doc__ = """Remove files or directories.
1711
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1712
delete them if they can easily be recovered using revert otherwise they
1713
will be backed up (adding an extention of the form .~#~). If no options or
1714
parameters are given Bazaar will scan for files that are being tracked by
1715
Bazaar but missing in your tree and stop tracking them for you.
1717
takes_args = ['file*']
1718
takes_options = ['verbose',
1719
Option('new', help='Only remove files that have never been committed.'),
1720
RegistryOption.from_kwargs('file-deletion-strategy',
1721
'The file deletion mode to be used.',
1722
title='Deletion Strategy', value_switches=True, enum_switch=False,
1723
safe='Backup changed files (default).',
1724
keep='Delete from bzr but leave the working copy.',
1725
no_backup='Don\'t backup changed files.',
1726
force='Delete all the specified files, even if they can not be '
1727
'recovered and even if they are non-empty directories. '
1728
'(deprecated, use no-backup)')]
1729
aliases = ['rm', 'del']
1730
encoding_type = 'replace'
1732
def run(self, file_list, verbose=False, new=False,
1733
file_deletion_strategy='safe'):
1734
if file_deletion_strategy == 'force':
1735
note(gettext("(The --force option is deprecated, rather use --no-backup "
1737
file_deletion_strategy = 'no-backup'
1739
tree, file_list = WorkingTree.open_containing_paths(file_list)
1741
if file_list is not None:
1742
file_list = [f for f in file_list]
1744
self.add_cleanup(tree.lock_write().unlock)
1745
# Heuristics should probably all move into tree.remove_smart or
1748
added = tree.changes_from(tree.basis_tree(),
1749
specific_files=file_list).added
1750
file_list = sorted([f[0] for f in added], reverse=True)
1751
if len(file_list) == 0:
1752
raise errors.BzrCommandError(gettext('No matching files.'))
1753
elif file_list is None:
1754
# missing files show up in iter_changes(basis) as
1755
# versioned-with-no-kind.
1757
for change in tree.iter_changes(tree.basis_tree()):
1758
# Find paths in the working tree that have no kind:
1759
if change[1][1] is not None and change[6][1] is None:
1760
missing.append(change[1][1])
1761
file_list = sorted(missing, reverse=True)
1762
file_deletion_strategy = 'keep'
1763
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1764
keep_files=file_deletion_strategy=='keep',
1765
force=(file_deletion_strategy=='no-backup'))
1768
class cmd_file_id(Command):
1769
__doc__ = """Print file_id of a particular file or directory.
1771
The file_id is assigned when the file is first added and remains the
1772
same through all revisions where the file exists, even when it is
1777
_see_also = ['inventory', 'ls']
1778
takes_args = ['filename']
1781
def run(self, filename):
1782
tree, relpath = WorkingTree.open_containing(filename)
1783
i = tree.path2id(relpath)
1785
raise errors.NotVersionedError(filename)
1787
self.outf.write(i + '\n')
1790
class cmd_file_path(Command):
1791
__doc__ = """Print path of file_ids to a file or directory.
1793
This prints one line for each directory down to the target,
1794
starting at the branch root.
1798
takes_args = ['filename']
1801
def run(self, filename):
1802
tree, relpath = WorkingTree.open_containing(filename)
1803
fid = tree.path2id(relpath)
1805
raise errors.NotVersionedError(filename)
1806
segments = osutils.splitpath(relpath)
1807
for pos in range(1, len(segments) + 1):
1808
path = osutils.joinpath(segments[:pos])
1809
self.outf.write("%s\n" % tree.path2id(path))
1812
class cmd_reconcile(Command):
1813
__doc__ = """Reconcile bzr metadata in a branch.
1815
This can correct data mismatches that may have been caused by
1816
previous ghost operations or bzr upgrades. You should only
1817
need to run this command if 'bzr check' or a bzr developer
1818
advises you to run it.
1820
If a second branch is provided, cross-branch reconciliation is
1821
also attempted, which will check that data like the tree root
1822
id which was not present in very early bzr versions is represented
1823
correctly in both branches.
1825
At the same time it is run it may recompress data resulting in
1826
a potential saving in disk space or performance gain.
1828
The branch *MUST* be on a listable system such as local disk or sftp.
1831
_see_also = ['check']
1832
takes_args = ['branch?']
1834
Option('canonicalize-chks',
1835
help='Make sure CHKs are in canonical form (repairs '
1840
def run(self, branch=".", canonicalize_chks=False):
1841
from bzrlib.reconcile import reconcile
1842
dir = controldir.ControlDir.open(branch)
1843
reconcile(dir, canonicalize_chks=canonicalize_chks)
1846
class cmd_revision_history(Command):
1847
__doc__ = """Display the list of revision ids on a branch."""
1850
takes_args = ['location?']
1855
def run(self, location="."):
1856
branch = Branch.open_containing(location)[0]
1857
self.add_cleanup(branch.lock_read().unlock)
1858
graph = branch.repository.get_graph()
1859
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1860
[_mod_revision.NULL_REVISION]))
1861
for revid in reversed(history):
1862
self.outf.write(revid)
1863
self.outf.write('\n')
1866
class cmd_ancestry(Command):
1867
__doc__ = """List all revisions merged into this branch."""
1869
_see_also = ['log', 'revision-history']
1870
takes_args = ['location?']
1875
def run(self, location="."):
1877
wt = WorkingTree.open_containing(location)[0]
1878
except errors.NoWorkingTree:
1879
b = Branch.open(location)
1880
last_revision = b.last_revision()
1883
last_revision = wt.last_revision()
1885
self.add_cleanup(b.repository.lock_read().unlock)
1886
graph = b.repository.get_graph()
1887
revisions = [revid for revid, parents in
1888
graph.iter_ancestry([last_revision])]
1889
for revision_id in reversed(revisions):
1890
if _mod_revision.is_null(revision_id):
1892
self.outf.write(revision_id + '\n')
1895
class cmd_init(Command):
1896
__doc__ = """Make a directory into a versioned branch.
1898
Use this to create an empty branch, or before importing an
1901
If there is a repository in a parent directory of the location, then
1902
the history of the branch will be stored in the repository. Otherwise
1903
init creates a standalone branch which carries its own history
1904
in the .bzr directory.
1906
If there is already a branch at the location but it has no working tree,
1907
the tree can be populated with 'bzr checkout'.
1909
Recipe for importing a tree of files::
1915
bzr commit -m "imported project"
1918
_see_also = ['init-repository', 'branch', 'checkout']
1919
takes_args = ['location?']
1921
Option('create-prefix',
1922
help='Create the path leading up to the branch '
1923
'if it does not already exist.'),
1924
RegistryOption('format',
1925
help='Specify a format for this branch. '
1926
'See "help formats".',
1927
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1928
converter=lambda name: controldir.format_registry.make_bzrdir(name),
1929
value_switches=True,
1930
title="Branch format",
1932
Option('append-revisions-only',
1933
help='Never change revnos or the existing log.'
1934
' Append revisions to it only.'),
1936
'Create a branch without a working tree.')
1938
def run(self, location=None, format=None, append_revisions_only=False,
1939
create_prefix=False, no_tree=False):
1941
format = controldir.format_registry.make_bzrdir('default')
1942
if location is None:
1945
to_transport = transport.get_transport(location)
1947
# The path has to exist to initialize a
1948
# branch inside of it.
1949
# Just using os.mkdir, since I don't
1950
# believe that we want to create a bunch of
1951
# locations if the user supplies an extended path
1953
to_transport.ensure_base()
1954
except errors.NoSuchFile:
1955
if not create_prefix:
1956
raise errors.BzrCommandError(gettext("Parent directory of %s"
1958
"\nYou may supply --create-prefix to create all"
1959
" leading parent directories.")
1961
to_transport.create_prefix()
1964
a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
1965
except errors.NotBranchError:
1966
# really a NotBzrDir error...
1967
create_branch = controldir.ControlDir.create_branch_convenience
1969
force_new_tree = False
1971
force_new_tree = None
1972
branch = create_branch(to_transport.base, format=format,
1973
possible_transports=[to_transport],
1974
force_new_tree=force_new_tree)
1975
a_bzrdir = branch.bzrdir
1977
from bzrlib.transport.local import LocalTransport
1978
if a_bzrdir.has_branch():
1979
if (isinstance(to_transport, LocalTransport)
1980
and not a_bzrdir.has_workingtree()):
1981
raise errors.BranchExistsWithoutWorkingTree(location)
1982
raise errors.AlreadyBranchError(location)
1983
branch = a_bzrdir.create_branch()
1984
if not no_tree and not a_bzrdir.has_workingtree():
1985
a_bzrdir.create_workingtree()
1986
if append_revisions_only:
1988
branch.set_append_revisions_only(True)
1989
except errors.UpgradeRequired:
1990
raise errors.BzrCommandError(gettext('This branch format cannot be set'
1991
' to append-revisions-only. Try --default.'))
1993
from bzrlib.info import describe_layout, describe_format
1995
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1996
except (errors.NoWorkingTree, errors.NotLocalUrl):
1998
repository = branch.repository
1999
layout = describe_layout(repository, branch, tree).lower()
2000
format = describe_format(a_bzrdir, repository, branch, tree)
2001
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2003
if repository.is_shared():
2004
#XXX: maybe this can be refactored into transport.path_or_url()
2005
url = repository.bzrdir.root_transport.external_url()
2007
url = urlutils.local_path_from_url(url)
2008
except errors.InvalidURL:
2010
self.outf.write(gettext("Using shared repository: %s\n") % url)
2013
class cmd_init_repository(Command):
2014
__doc__ = """Create a shared repository for branches to share storage space.
2016
New branches created under the repository directory will store their
2017
revisions in the repository, not in the branch directory. For branches
2018
with shared history, this reduces the amount of storage needed and
2019
speeds up the creation of new branches.
2021
If the --no-trees option is given then the branches in the repository
2022
will not have working trees by default. They will still exist as
2023
directories on disk, but they will not have separate copies of the
2024
files at a certain revision. This can be useful for repositories that
2025
store branches which are interacted with through checkouts or remote
2026
branches, such as on a server.
2029
Create a shared repository holding just branches::
2031
bzr init-repo --no-trees repo
2034
Make a lightweight checkout elsewhere::
2036
bzr checkout --lightweight repo/trunk trunk-checkout
2041
_see_also = ['init', 'branch', 'checkout', 'repositories']
2042
takes_args = ["location"]
2043
takes_options = [RegistryOption('format',
2044
help='Specify a format for this repository. See'
2045
' "bzr help formats" for details.',
2046
lazy_registry=('bzrlib.controldir', 'format_registry'),
2047
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2048
value_switches=True, title='Repository format'),
2050
help='Branches in the repository will default to'
2051
' not having a working tree.'),
2053
aliases = ["init-repo"]
2055
def run(self, location, format=None, no_trees=False):
2057
format = controldir.format_registry.make_bzrdir('default')
2059
if location is None:
2062
to_transport = transport.get_transport(location)
2063
to_transport.ensure_base()
2065
newdir = format.initialize_on_transport(to_transport)
2066
repo = newdir.create_repository(shared=True)
2067
repo.set_make_working_trees(not no_trees)
2069
from bzrlib.info import show_bzrdir_info
2070
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
2073
class cmd_diff(Command):
2074
__doc__ = """Show differences in the working tree, between revisions or branches.
2076
If no arguments are given, all changes for the current tree are listed.
2077
If files are given, only the changes in those files are listed.
2078
Remote and multiple branches can be compared by using the --old and
2079
--new options. If not provided, the default for both is derived from
2080
the first argument, if any, or the current tree if no arguments are
2083
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
2084
produces patches suitable for "patch -p1".
2086
Note that when using the -r argument with a range of revisions, the
2087
differences are computed between the two specified revisions. That
2088
is, the command does not show the changes introduced by the first
2089
revision in the range. This differs from the interpretation of
2090
revision ranges used by "bzr log" which includes the first revision
2095
2 - unrepresentable changes
2100
Shows the difference in the working tree versus the last commit::
2104
Difference between the working tree and revision 1::
2108
Difference between revision 3 and revision 1::
2112
Difference between revision 3 and revision 1 for branch xxx::
2116
The changes introduced by revision 2 (equivalent to -r1..2)::
2120
To see the changes introduced by revision X::
2124
Note that in the case of a merge, the -c option shows the changes
2125
compared to the left hand parent. To see the changes against
2126
another parent, use::
2128
bzr diff -r<chosen_parent>..X
2130
The changes between the current revision and the previous revision
2131
(equivalent to -c-1 and -r-2..-1)
2135
Show just the differences for file NEWS::
2139
Show the differences in working tree xxx for file NEWS::
2143
Show the differences from branch xxx to this working tree:
2147
Show the differences between two branches for file NEWS::
2149
bzr diff --old xxx --new yyy NEWS
2151
Same as 'bzr diff' but prefix paths with old/ and new/::
2153
bzr diff --prefix old/:new/
2155
Show the differences using a custom diff program with options::
2157
bzr diff --using /usr/bin/diff --diff-options -wu
2159
_see_also = ['status']
2160
takes_args = ['file*']
2162
Option('diff-options', type=str,
2163
help='Pass these options to the external diff program.'),
2164
Option('prefix', type=str,
2166
help='Set prefixes added to old and new filenames, as '
2167
'two values separated by a colon. (eg "old/:new/").'),
2169
help='Branch/tree to compare from.',
2173
help='Branch/tree to compare to.',
2179
help='Use this command to compare files.',
2182
RegistryOption('format',
2184
help='Diff format to use.',
2185
lazy_registry=('bzrlib.diff', 'format_registry'),
2186
title='Diff format'),
2188
aliases = ['di', 'dif']
2189
encoding_type = 'exact'
2192
def run(self, revision=None, file_list=None, diff_options=None,
2193
prefix=None, old=None, new=None, using=None, format=None):
2194
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2197
if (prefix is None) or (prefix == '0'):
2205
old_label, new_label = prefix.split(":")
2207
raise errors.BzrCommandError(gettext(
2208
'--prefix expects two values separated by a colon'
2209
' (eg "old/:new/")'))
2211
if revision and len(revision) > 2:
2212
raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
2213
' one or two revision specifiers'))
2215
if using is not None and format is not None:
2216
raise errors.BzrCommandError(gettext(
2217
'{0} and {1} are mutually exclusive').format(
2218
'--using', '--format'))
2220
(old_tree, new_tree,
2221
old_branch, new_branch,
2222
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2223
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2224
# GNU diff on Windows uses ANSI encoding for filenames
2225
path_encoding = osutils.get_diff_header_encoding()
2226
return show_diff_trees(old_tree, new_tree, sys.stdout,
2227
specific_files=specific_files,
2228
external_diff_options=diff_options,
2229
old_label=old_label, new_label=new_label,
2230
extra_trees=extra_trees,
2231
path_encoding=path_encoding,
2236
class cmd_deleted(Command):
2237
__doc__ = """List files deleted in the working tree.
2239
# TODO: Show files deleted since a previous revision, or
2240
# between two revisions.
2241
# TODO: Much more efficient way to do this: read in new
2242
# directories with readdir, rather than stating each one. Same
2243
# level of effort but possibly much less IO. (Or possibly not,
2244
# if the directories are very large...)
2245
_see_also = ['status', 'ls']
2246
takes_options = ['directory', 'show-ids']
2249
def run(self, show_ids=False, directory=u'.'):
2250
tree = WorkingTree.open_containing(directory)[0]
2251
self.add_cleanup(tree.lock_read().unlock)
2252
old = tree.basis_tree()
2253
self.add_cleanup(old.lock_read().unlock)
2254
for path, ie in old.inventory.iter_entries():
2255
if not tree.has_id(ie.file_id):
2256
self.outf.write(path)
2258
self.outf.write(' ')
2259
self.outf.write(ie.file_id)
2260
self.outf.write('\n')
2263
class cmd_modified(Command):
2264
__doc__ = """List files modified in working tree.
2268
_see_also = ['status', 'ls']
2269
takes_options = ['directory', 'null']
2272
def run(self, null=False, directory=u'.'):
2273
tree = WorkingTree.open_containing(directory)[0]
2274
self.add_cleanup(tree.lock_read().unlock)
2275
td = tree.changes_from(tree.basis_tree())
2277
for path, id, kind, text_modified, meta_modified in td.modified:
2279
self.outf.write(path + '\0')
2281
self.outf.write(osutils.quotefn(path) + '\n')
2284
class cmd_added(Command):
2285
__doc__ = """List files added in working tree.
2289
_see_also = ['status', 'ls']
2290
takes_options = ['directory', 'null']
2293
def run(self, null=False, directory=u'.'):
2294
wt = WorkingTree.open_containing(directory)[0]
2295
self.add_cleanup(wt.lock_read().unlock)
2296
basis = wt.basis_tree()
2297
self.add_cleanup(basis.lock_read().unlock)
2298
basis_inv = basis.inventory
2301
if basis_inv.has_id(file_id):
2303
if inv.is_root(file_id) and len(basis_inv) == 0:
2305
path = inv.id2path(file_id)
2306
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2309
self.outf.write(path + '\0')
2311
self.outf.write(osutils.quotefn(path) + '\n')
2314
class cmd_root(Command):
2315
__doc__ = """Show the tree root directory.
2317
The root is the nearest enclosing directory with a .bzr control
2320
takes_args = ['filename?']
2322
def run(self, filename=None):
2323
"""Print the branch root."""
2324
tree = WorkingTree.open_containing(filename)[0]
2325
self.outf.write(tree.basedir + '\n')
2328
def _parse_limit(limitstring):
2330
return int(limitstring)
2332
msg = gettext("The limit argument must be an integer.")
2333
raise errors.BzrCommandError(msg)
2336
def _parse_levels(s):
2340
msg = gettext("The levels argument must be an integer.")
2341
raise errors.BzrCommandError(msg)
2344
class cmd_log(Command):
2345
__doc__ = """Show historical log for a branch or subset of a branch.
2347
log is bzr's default tool for exploring the history of a branch.
2348
The branch to use is taken from the first parameter. If no parameters
2349
are given, the branch containing the working directory is logged.
2350
Here are some simple examples::
2352
bzr log log the current branch
2353
bzr log foo.py log a file in its branch
2354
bzr log http://server/branch log a branch on a server
2356
The filtering, ordering and information shown for each revision can
2357
be controlled as explained below. By default, all revisions are
2358
shown sorted (topologically) so that newer revisions appear before
2359
older ones and descendants always appear before ancestors. If displayed,
2360
merged revisions are shown indented under the revision in which they
2365
The log format controls how information about each revision is
2366
displayed. The standard log formats are called ``long``, ``short``
2367
and ``line``. The default is long. See ``bzr help log-formats``
2368
for more details on log formats.
2370
The following options can be used to control what information is
2373
-l N display a maximum of N revisions
2374
-n N display N levels of revisions (0 for all, 1 for collapsed)
2375
-v display a status summary (delta) for each revision
2376
-p display a diff (patch) for each revision
2377
--show-ids display revision-ids (and file-ids), not just revnos
2379
Note that the default number of levels to display is a function of the
2380
log format. If the -n option is not used, the standard log formats show
2381
just the top level (mainline).
2383
Status summaries are shown using status flags like A, M, etc. To see
2384
the changes explained using words like ``added`` and ``modified``
2385
instead, use the -vv option.
2389
To display revisions from oldest to newest, use the --forward option.
2390
In most cases, using this option will have little impact on the total
2391
time taken to produce a log, though --forward does not incrementally
2392
display revisions like --reverse does when it can.
2394
:Revision filtering:
2396
The -r option can be used to specify what revision or range of revisions
2397
to filter against. The various forms are shown below::
2399
-rX display revision X
2400
-rX.. display revision X and later
2401
-r..Y display up to and including revision Y
2402
-rX..Y display from X to Y inclusive
2404
See ``bzr help revisionspec`` for details on how to specify X and Y.
2405
Some common examples are given below::
2407
-r-1 show just the tip
2408
-r-10.. show the last 10 mainline revisions
2409
-rsubmit:.. show what's new on this branch
2410
-rancestor:path.. show changes since the common ancestor of this
2411
branch and the one at location path
2412
-rdate:yesterday.. show changes since yesterday
2414
When logging a range of revisions using -rX..Y, log starts at
2415
revision Y and searches back in history through the primary
2416
("left-hand") parents until it finds X. When logging just the
2417
top level (using -n1), an error is reported if X is not found
2418
along the way. If multi-level logging is used (-n0), X may be
2419
a nested merge revision and the log will be truncated accordingly.
2423
If parameters are given and the first one is not a branch, the log
2424
will be filtered to show only those revisions that changed the
2425
nominated files or directories.
2427
Filenames are interpreted within their historical context. To log a
2428
deleted file, specify a revision range so that the file existed at
2429
the end or start of the range.
2431
Historical context is also important when interpreting pathnames of
2432
renamed files/directories. Consider the following example:
2434
* revision 1: add tutorial.txt
2435
* revision 2: modify tutorial.txt
2436
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2440
* ``bzr log guide.txt`` will log the file added in revision 1
2442
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2444
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2445
the original file in revision 2.
2447
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2448
was no file called guide.txt in revision 2.
2450
Renames are always followed by log. By design, there is no need to
2451
explicitly ask for this (and no way to stop logging a file back
2452
until it was last renamed).
2456
The --match option can be used for finding revisions that match a
2457
regular expression in a commit message, committer, author or bug.
2458
Specifying the option several times will match any of the supplied
2459
expressions. --match-author, --match-bugs, --match-committer and
2460
--match-message can be used to only match a specific field.
2464
GUI tools and IDEs are often better at exploring history than command
2465
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2466
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2467
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2468
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2470
You may find it useful to add the aliases below to ``bazaar.conf``::
2474
top = log -l10 --line
2477
``bzr tip`` will then show the latest revision while ``bzr top``
2478
will show the last 10 mainline revisions. To see the details of a
2479
particular revision X, ``bzr show -rX``.
2481
If you are interested in looking deeper into a particular merge X,
2482
use ``bzr log -n0 -rX``.
2484
``bzr log -v`` on a branch with lots of history is currently
2485
very slow. A fix for this issue is currently under development.
2486
With or without that fix, it is recommended that a revision range
2487
be given when using the -v option.
2489
bzr has a generic full-text matching plugin, bzr-search, that can be
2490
used to find revisions matching user names, commit messages, etc.
2491
Among other features, this plugin can find all revisions containing
2492
a list of words but not others.
2494
When exploring non-mainline history on large projects with deep
2495
history, the performance of log can be greatly improved by installing
2496
the historycache plugin. This plugin buffers historical information
2497
trading disk space for faster speed.
2499
takes_args = ['file*']
2500
_see_also = ['log-formats', 'revisionspec']
2503
help='Show from oldest to newest.'),
2505
custom_help('verbose',
2506
help='Show files changed in each revision.'),
2510
type=bzrlib.option._parse_revision_str,
2512
help='Show just the specified revision.'
2513
' See also "help revisionspec".'),
2515
RegistryOption('authors',
2516
'What names to list as authors - first, all or committer.',
2518
lazy_registry=('bzrlib.log', 'author_list_registry'),
2522
help='Number of levels to display - 0 for all, 1 for flat.',
2524
type=_parse_levels),
2526
help='Show revisions whose message matches this '
2527
'regular expression.',
2532
help='Limit the output to the first N revisions.',
2537
help='Show changes made in each revision as a patch.'),
2538
Option('include-merged',
2539
help='Show merged revisions like --levels 0 does.'),
2540
Option('include-merges', hidden=True,
2541
help='Historical alias for --include-merged.'),
2542
Option('omit-merges',
2543
help='Do not report commits with more than one parent.'),
2544
Option('exclude-common-ancestry',
2545
help='Display only the revisions that are not part'
2546
' of both ancestries (require -rX..Y).'
2548
Option('signatures',
2549
help='Show digital signature validity.'),
2552
help='Show revisions whose properties match this '
2555
ListOption('match-message',
2556
help='Show revisions whose message matches this '
2559
ListOption('match-committer',
2560
help='Show revisions whose committer matches this '
2563
ListOption('match-author',
2564
help='Show revisions whose authors match this '
2567
ListOption('match-bugs',
2568
help='Show revisions whose bugs match this '
2572
encoding_type = 'replace'
2575
def run(self, file_list=None, timezone='original',
2586
include_merged=None,
2588
exclude_common_ancestry=False,
2592
match_committer=None,
2596
include_merges=symbol_versioning.DEPRECATED_PARAMETER,
2598
from bzrlib.log import (
2600
make_log_request_dict,
2601
_get_info_for_log_files,
2603
direction = (forward and 'forward') or 'reverse'
2604
if symbol_versioning.deprecated_passed(include_merges):
2605
ui.ui_factory.show_user_warning(
2606
'deprecated_command_option',
2607
deprecated_name='--include-merges',
2608
recommended_name='--include-merged',
2609
deprecated_in_version='2.5',
2610
command=self.invoked_as)
2611
if include_merged is None:
2612
include_merged = include_merges
2614
raise errors.BzrCommandError(gettext(
2615
'{0} and {1} are mutually exclusive').format(
2616
'--include-merges', '--include-merged'))
2617
if include_merged is None:
2618
include_merged = False
2619
if (exclude_common_ancestry
2620
and (revision is None or len(revision) != 2)):
2621
raise errors.BzrCommandError(gettext(
2622
'--exclude-common-ancestry requires -r with two revisions'))
2627
raise errors.BzrCommandError(gettext(
2628
'{0} and {1} are mutually exclusive').format(
2629
'--levels', '--include-merged'))
2631
if change is not None:
2633
raise errors.RangeInChangeOption()
2634
if revision is not None:
2635
raise errors.BzrCommandError(gettext(
2636
'{0} and {1} are mutually exclusive').format(
2637
'--revision', '--change'))
2642
filter_by_dir = False
2644
# find the file ids to log and check for directory filtering
2645
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2646
revision, file_list, self.add_cleanup)
2647
for relpath, file_id, kind in file_info_list:
2649
raise errors.BzrCommandError(gettext(
2650
"Path unknown at end or start of revision range: %s") %
2652
# If the relpath is the top of the tree, we log everything
2657
file_ids.append(file_id)
2658
filter_by_dir = filter_by_dir or (
2659
kind in ['directory', 'tree-reference'])
2662
# FIXME ? log the current subdir only RBC 20060203
2663
if revision is not None \
2664
and len(revision) > 0 and revision[0].get_branch():
2665
location = revision[0].get_branch()
2668
dir, relpath = controldir.ControlDir.open_containing(location)
2669
b = dir.open_branch()
2670
self.add_cleanup(b.lock_read().unlock)
2671
rev1, rev2 = _get_revision_range(revision, b, self.name())
2673
if b.get_config().validate_signatures_in_log():
2677
if not gpg.GPGStrategy.verify_signatures_available():
2678
raise errors.GpgmeNotInstalled(None)
2680
# Decide on the type of delta & diff filtering to use
2681
# TODO: add an --all-files option to make this configurable & consistent
2689
diff_type = 'partial'
2693
# Build the log formatter
2694
if log_format is None:
2695
log_format = log.log_formatter_registry.get_default(b)
2696
# Make a non-encoding output to include the diffs - bug 328007
2697
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2698
lf = log_format(show_ids=show_ids, to_file=self.outf,
2699
to_exact_file=unencoded_output,
2700
show_timezone=timezone,
2701
delta_format=get_verbosity_level(),
2703
show_advice=levels is None,
2704
author_list_handler=authors)
2706
# Choose the algorithm for doing the logging. It's annoying
2707
# having multiple code paths like this but necessary until
2708
# the underlying repository format is faster at generating
2709
# deltas or can provide everything we need from the indices.
2710
# The default algorithm - match-using-deltas - works for
2711
# multiple files and directories and is faster for small
2712
# amounts of history (200 revisions say). However, it's too
2713
# slow for logging a single file in a repository with deep
2714
# history, i.e. > 10K revisions. In the spirit of "do no
2715
# evil when adding features", we continue to use the
2716
# original algorithm - per-file-graph - for the "single
2717
# file that isn't a directory without showing a delta" case.
2718
partial_history = revision and b.repository._format.supports_chks
2719
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2720
or delta_type or partial_history)
2724
match_dict[''] = match
2726
match_dict['message'] = match_message
2728
match_dict['committer'] = match_committer
2730
match_dict['author'] = match_author
2732
match_dict['bugs'] = match_bugs
2734
# Build the LogRequest and execute it
2735
if len(file_ids) == 0:
2737
rqst = make_log_request_dict(
2738
direction=direction, specific_fileids=file_ids,
2739
start_revision=rev1, end_revision=rev2, limit=limit,
2740
message_search=message, delta_type=delta_type,
2741
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2742
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2743
signature=signatures, omit_merges=omit_merges,
2745
Logger(b, rqst).show(lf)
2748
def _get_revision_range(revisionspec_list, branch, command_name):
2749
"""Take the input of a revision option and turn it into a revision range.
2751
It returns RevisionInfo objects which can be used to obtain the rev_id's
2752
of the desired revisions. It does some user input validations.
2754
if revisionspec_list is None:
2757
elif len(revisionspec_list) == 1:
2758
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2759
elif len(revisionspec_list) == 2:
2760
start_spec = revisionspec_list[0]
2761
end_spec = revisionspec_list[1]
2762
if end_spec.get_branch() != start_spec.get_branch():
2763
# b is taken from revision[0].get_branch(), and
2764
# show_log will use its revision_history. Having
2765
# different branches will lead to weird behaviors.
2766
raise errors.BzrCommandError(gettext(
2767
"bzr %s doesn't accept two revisions in different"
2768
" branches.") % command_name)
2769
if start_spec.spec is None:
2770
# Avoid loading all the history.
2771
rev1 = RevisionInfo(branch, None, None)
2773
rev1 = start_spec.in_history(branch)
2774
# Avoid loading all of history when we know a missing
2775
# end of range means the last revision ...
2776
if end_spec.spec is None:
2777
last_revno, last_revision_id = branch.last_revision_info()
2778
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2780
rev2 = end_spec.in_history(branch)
2782
raise errors.BzrCommandError(gettext(
2783
'bzr %s --revision takes one or two values.') % command_name)
2787
def _revision_range_to_revid_range(revision_range):
2790
if revision_range[0] is not None:
2791
rev_id1 = revision_range[0].rev_id
2792
if revision_range[1] is not None:
2793
rev_id2 = revision_range[1].rev_id
2794
return rev_id1, rev_id2
2796
def get_log_format(long=False, short=False, line=False, default='long'):
2797
log_format = default
2801
log_format = 'short'
2807
class cmd_touching_revisions(Command):
2808
__doc__ = """Return revision-ids which affected a particular file.
2810
A more user-friendly interface is "bzr log FILE".
2814
takes_args = ["filename"]
2817
def run(self, filename):
2818
tree, relpath = WorkingTree.open_containing(filename)
2819
file_id = tree.path2id(relpath)
2821
self.add_cleanup(b.lock_read().unlock)
2822
touching_revs = log.find_touching_revisions(b, file_id)
2823
for revno, revision_id, what in touching_revs:
2824
self.outf.write("%6d %s\n" % (revno, what))
2827
class cmd_ls(Command):
2828
__doc__ = """List files in a tree.
2831
_see_also = ['status', 'cat']
2832
takes_args = ['path?']
2836
Option('recursive', short_name='R',
2837
help='Recurse into subdirectories.'),
2839
help='Print paths relative to the root of the branch.'),
2840
Option('unknown', short_name='u',
2841
help='Print unknown files.'),
2842
Option('versioned', help='Print versioned files.',
2844
Option('ignored', short_name='i',
2845
help='Print ignored files.'),
2846
Option('kind', short_name='k',
2847
help='List entries of a particular kind: file, directory, symlink.',
2854
def run(self, revision=None, verbose=False,
2855
recursive=False, from_root=False,
2856
unknown=False, versioned=False, ignored=False,
2857
null=False, kind=None, show_ids=False, path=None, directory=None):
2859
if kind and kind not in ('file', 'directory', 'symlink'):
2860
raise errors.BzrCommandError(gettext('invalid kind specified'))
2862
if verbose and null:
2863
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
2864
all = not (unknown or versioned or ignored)
2866
selection = {'I':ignored, '?':unknown, 'V':versioned}
2872
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
2875
tree, branch, relpath = \
2876
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2878
# Calculate the prefix to use
2882
prefix = relpath + '/'
2883
elif fs_path != '.' and not fs_path.endswith('/'):
2884
prefix = fs_path + '/'
2886
if revision is not None or tree is None:
2887
tree = _get_one_revision_tree('ls', revision, branch=branch)
2890
if isinstance(tree, WorkingTree) and tree.supports_views():
2891
view_files = tree.views.lookup_view()
2894
view_str = views.view_display_str(view_files)
2895
note(gettext("Ignoring files outside view. View is %s") % view_str)
2897
self.add_cleanup(tree.lock_read().unlock)
2898
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2899
from_dir=relpath, recursive=recursive):
2900
# Apply additional masking
2901
if not all and not selection[fc]:
2903
if kind is not None and fkind != kind:
2908
fullpath = osutils.pathjoin(relpath, fp)
2911
views.check_path_in_view(tree, fullpath)
2912
except errors.FileOutsideView:
2917
fp = osutils.pathjoin(prefix, fp)
2918
kindch = entry.kind_character()
2919
outstring = fp + kindch
2920
ui.ui_factory.clear_term()
2922
outstring = '%-8s %s' % (fc, outstring)
2923
if show_ids and fid is not None:
2924
outstring = "%-50s %s" % (outstring, fid)
2925
self.outf.write(outstring + '\n')
2927
self.outf.write(fp + '\0')
2930
self.outf.write(fid)
2931
self.outf.write('\0')
2939
self.outf.write('%-50s %s\n' % (outstring, my_id))
2941
self.outf.write(outstring + '\n')
2944
class cmd_unknowns(Command):
2945
__doc__ = """List unknown files.
2950
takes_options = ['directory']
2953
def run(self, directory=u'.'):
2954
for f in WorkingTree.open_containing(directory)[0].unknowns():
2955
self.outf.write(osutils.quotefn(f) + '\n')
2958
class cmd_ignore(Command):
2959
__doc__ = """Ignore specified files or patterns.
2961
See ``bzr help patterns`` for details on the syntax of patterns.
2963
If a .bzrignore file does not exist, the ignore command
2964
will create one and add the specified files or patterns to the newly
2965
created file. The ignore command will also automatically add the
2966
.bzrignore file to be versioned. Creating a .bzrignore file without
2967
the use of the ignore command will require an explicit add command.
2969
To remove patterns from the ignore list, edit the .bzrignore file.
2970
After adding, editing or deleting that file either indirectly by
2971
using this command or directly by using an editor, be sure to commit
2974
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2975
the global ignore file can be found in the application data directory as
2976
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2977
Global ignores are not touched by this command. The global ignore file
2978
can be edited directly using an editor.
2980
Patterns prefixed with '!' are exceptions to ignore patterns and take
2981
precedence over regular ignores. Such exceptions are used to specify
2982
files that should be versioned which would otherwise be ignored.
2984
Patterns prefixed with '!!' act as regular ignore patterns, but have
2985
precedence over the '!' exception patterns.
2989
* Ignore patterns containing shell wildcards must be quoted from
2992
* Ignore patterns starting with "#" act as comments in the ignore file.
2993
To ignore patterns that begin with that character, use the "RE:" prefix.
2996
Ignore the top level Makefile::
2998
bzr ignore ./Makefile
3000
Ignore .class files in all directories...::
3002
bzr ignore "*.class"
3004
...but do not ignore "special.class"::
3006
bzr ignore "!special.class"
3008
Ignore files whose name begins with the "#" character::
3012
Ignore .o files under the lib directory::
3014
bzr ignore "lib/**/*.o"
3016
Ignore .o files under the lib directory::
3018
bzr ignore "RE:lib/.*\.o"
3020
Ignore everything but the "debian" toplevel directory::
3022
bzr ignore "RE:(?!debian/).*"
3024
Ignore everything except the "local" toplevel directory,
3025
but always ignore autosave files ending in ~, even under local/::
3028
bzr ignore "!./local"
3032
_see_also = ['status', 'ignored', 'patterns']
3033
takes_args = ['name_pattern*']
3034
takes_options = ['directory',
3035
Option('default-rules',
3036
help='Display the default ignore rules that bzr uses.')
3039
def run(self, name_pattern_list=None, default_rules=None,
3041
from bzrlib import ignores
3042
if default_rules is not None:
3043
# dump the default rules and exit
3044
for pattern in ignores.USER_DEFAULTS:
3045
self.outf.write("%s\n" % pattern)
3047
if not name_pattern_list:
3048
raise errors.BzrCommandError(gettext("ignore requires at least one "
3049
"NAME_PATTERN or --default-rules."))
3050
name_pattern_list = [globbing.normalize_pattern(p)
3051
for p in name_pattern_list]
3053
bad_patterns_count = 0
3054
for p in name_pattern_list:
3055
if not globbing.Globster.is_pattern_valid(p):
3056
bad_patterns_count += 1
3057
bad_patterns += ('\n %s' % p)
3059
msg = (ngettext('Invalid ignore pattern found. %s',
3060
'Invalid ignore patterns found. %s',
3061
bad_patterns_count) % bad_patterns)
3062
ui.ui_factory.show_error(msg)
3063
raise errors.InvalidPattern('')
3064
for name_pattern in name_pattern_list:
3065
if (name_pattern[0] == '/' or
3066
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3067
raise errors.BzrCommandError(gettext(
3068
"NAME_PATTERN should not be an absolute path"))
3069
tree, relpath = WorkingTree.open_containing(directory)
3070
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3071
ignored = globbing.Globster(name_pattern_list)
3073
self.add_cleanup(tree.lock_read().unlock)
3074
for entry in tree.list_files():
3078
if ignored.match(filename):
3079
matches.append(filename)
3080
if len(matches) > 0:
3081
self.outf.write(gettext("Warning: the following files are version "
3082
"controlled and match your ignore pattern:\n%s"
3083
"\nThese files will continue to be version controlled"
3084
" unless you 'bzr remove' them.\n") % ("\n".join(matches),))
3087
class cmd_ignored(Command):
3088
__doc__ = """List ignored files and the patterns that matched them.
3090
List all the ignored files and the ignore pattern that caused the file to
3093
Alternatively, to list just the files::
3098
encoding_type = 'replace'
3099
_see_also = ['ignore', 'ls']
3100
takes_options = ['directory']
3103
def run(self, directory=u'.'):
3104
tree = WorkingTree.open_containing(directory)[0]
3105
self.add_cleanup(tree.lock_read().unlock)
3106
for path, file_class, kind, file_id, entry in tree.list_files():
3107
if file_class != 'I':
3109
## XXX: Slightly inefficient since this was already calculated
3110
pat = tree.is_ignored(path)
3111
self.outf.write('%-50s %s\n' % (path, pat))
3114
class cmd_lookup_revision(Command):
3115
__doc__ = """Lookup the revision-id from a revision-number
3118
bzr lookup-revision 33
3121
takes_args = ['revno']
3122
takes_options = ['directory']
3125
def run(self, revno, directory=u'.'):
3129
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3131
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3132
self.outf.write("%s\n" % revid)
3135
class cmd_export(Command):
3136
__doc__ = """Export current or past revision to a destination directory or archive.
3138
If no revision is specified this exports the last committed revision.
3140
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3141
given, try to find the format with the extension. If no extension
3142
is found exports to a directory (equivalent to --format=dir).
3144
If root is supplied, it will be used as the root directory inside
3145
container formats (tar, zip, etc). If it is not supplied it will default
3146
to the exported filename. The root option has no effect for 'dir' format.
3148
If branch is omitted then the branch containing the current working
3149
directory will be used.
3151
Note: Export of tree with non-ASCII filenames to zip is not supported.
3153
================= =========================
3154
Supported formats Autodetected by extension
3155
================= =========================
3158
tbz2 .tar.bz2, .tbz2
3161
================= =========================
3164
takes_args = ['dest', 'branch_or_subdir?']
3165
takes_options = ['directory',
3167
help="Type of file to export to.",
3170
Option('filters', help='Apply content filters to export the '
3171
'convenient form.'),
3174
help="Name of the root directory inside the exported file."),
3175
Option('per-file-timestamps',
3176
help='Set modification time of files to that of the last '
3177
'revision in which it was changed.'),
3178
Option('uncommitted',
3179
help='Export the working tree contents rather than that of the '
3182
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3183
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3185
from bzrlib.export import export
3187
if branch_or_subdir is None:
3188
branch_or_subdir = directory
3190
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3192
if tree is not None:
3193
self.add_cleanup(tree.lock_read().unlock)
3197
raise errors.BzrCommandError(
3198
gettext("--uncommitted requires a working tree"))
3201
export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3203
export(export_tree, dest, format, root, subdir, filtered=filters,
3204
per_file_timestamps=per_file_timestamps)
3205
except errors.NoSuchExportFormat, e:
3206
raise errors.BzrCommandError(
3207
gettext('Unsupported export format: %s') % e.format)
3210
class cmd_cat(Command):
3211
__doc__ = """Write the contents of a file as of a given revision to standard output.
3213
If no revision is nominated, the last revision is used.
3215
Note: Take care to redirect standard output when using this command on a
3220
takes_options = ['directory',
3221
Option('name-from-revision', help='The path name in the old tree.'),
3222
Option('filters', help='Apply content filters to display the '
3223
'convenience form.'),
3226
takes_args = ['filename']
3227
encoding_type = 'exact'
3230
def run(self, filename, revision=None, name_from_revision=False,
3231
filters=False, directory=None):
3232
if revision is not None and len(revision) != 1:
3233
raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
3234
" one revision specifier"))
3235
tree, branch, relpath = \
3236
_open_directory_or_containing_tree_or_branch(filename, directory)
3237
self.add_cleanup(branch.lock_read().unlock)
3238
return self._run(tree, branch, relpath, filename, revision,
3239
name_from_revision, filters)
3241
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3244
tree = b.basis_tree()
3245
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3246
self.add_cleanup(rev_tree.lock_read().unlock)
3248
old_file_id = rev_tree.path2id(relpath)
3250
# TODO: Split out this code to something that generically finds the
3251
# best id for a path across one or more trees; it's like
3252
# find_ids_across_trees but restricted to find just one. -- mbp
3254
if name_from_revision:
3255
# Try in revision if requested
3256
if old_file_id is None:
3257
raise errors.BzrCommandError(gettext(
3258
"{0!r} is not present in revision {1}").format(
3259
filename, rev_tree.get_revision_id()))
3261
actual_file_id = old_file_id
3263
cur_file_id = tree.path2id(relpath)
3264
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3265
actual_file_id = cur_file_id
3266
elif old_file_id is not None:
3267
actual_file_id = old_file_id
3269
raise errors.BzrCommandError(gettext(
3270
"{0!r} is not present in revision {1}").format(
3271
filename, rev_tree.get_revision_id()))
3273
from bzrlib.filter_tree import ContentFilterTree
3274
filter_tree = ContentFilterTree(rev_tree,
3275
rev_tree._content_filter_stack)
3276
content = filter_tree.get_file_text(actual_file_id)
3278
content = rev_tree.get_file_text(actual_file_id)
3280
self.outf.write(content)
3283
class cmd_local_time_offset(Command):
3284
__doc__ = """Show the offset in seconds from GMT to local time."""
3288
self.outf.write("%s\n" % osutils.local_time_offset())
3292
class cmd_commit(Command):
3293
__doc__ = """Commit changes into a new revision.
3295
An explanatory message needs to be given for each commit. This is
3296
often done by using the --message option (getting the message from the
3297
command line) or by using the --file option (getting the message from
3298
a file). If neither of these options is given, an editor is opened for
3299
the user to enter the message. To see the changed files in the
3300
boilerplate text loaded into the editor, use the --show-diff option.
3302
By default, the entire tree is committed and the person doing the
3303
commit is assumed to be the author. These defaults can be overridden
3308
If selected files are specified, only changes to those files are
3309
committed. If a directory is specified then the directory and
3310
everything within it is committed.
3312
When excludes are given, they take precedence over selected files.
3313
For example, to commit only changes within foo, but not changes
3316
bzr commit foo -x foo/bar
3318
A selective commit after a merge is not yet supported.
3322
If the author of the change is not the same person as the committer,
3323
you can specify the author's name using the --author option. The
3324
name should be in the same format as a committer-id, e.g.
3325
"John Doe <jdoe@example.com>". If there is more than one author of
3326
the change you can specify the option multiple times, once for each
3331
A common mistake is to forget to add a new file or directory before
3332
running the commit command. The --strict option checks for unknown
3333
files and aborts the commit if any are found. More advanced pre-commit
3334
checks can be implemented by defining hooks. See ``bzr help hooks``
3339
If you accidentially commit the wrong changes or make a spelling
3340
mistake in the commit message say, you can use the uncommit command
3341
to undo it. See ``bzr help uncommit`` for details.
3343
Hooks can also be configured to run after a commit. This allows you
3344
to trigger updates to external systems like bug trackers. The --fixes
3345
option can be used to record the association between a revision and
3346
one or more bugs. See ``bzr help bugs`` for details.
3349
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3350
takes_args = ['selected*']
3352
ListOption('exclude', type=str, short_name='x',
3353
help="Do not consider changes made to a given path."),
3354
Option('message', type=unicode,
3356
help="Description of the new revision."),
3359
help='Commit even if nothing has changed.'),
3360
Option('file', type=str,
3363
help='Take commit message from this file.'),
3365
help="Refuse to commit if there are unknown "
3366
"files in the working tree."),
3367
Option('commit-time', type=str,
3368
help="Manually set a commit time using commit date "
3369
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3370
ListOption('fixes', type=str,
3371
help="Mark a bug as being fixed by this revision "
3372
"(see \"bzr help bugs\")."),
3373
ListOption('author', type=unicode,
3374
help="Set the author's name, if it's different "
3375
"from the committer."),
3377
help="Perform a local commit in a bound "
3378
"branch. Local commits are not pushed to "
3379
"the master branch until a normal commit "
3382
Option('show-diff', short_name='p',
3383
help='When no message is supplied, show the diff along'
3384
' with the status summary in the message editor.'),
3386
help='When committing to a foreign version control '
3387
'system do not push data that can not be natively '
3390
aliases = ['ci', 'checkin']
3392
def _iter_bug_fix_urls(self, fixes, branch):
3393
default_bugtracker = None
3394
# Configure the properties for bug fixing attributes.
3395
for fixed_bug in fixes:
3396
tokens = fixed_bug.split(':')
3397
if len(tokens) == 1:
3398
if default_bugtracker is None:
3399
branch_config = branch.get_config()
3400
default_bugtracker = branch_config.get_user_option(
3402
if default_bugtracker is None:
3403
raise errors.BzrCommandError(gettext(
3404
"No tracker specified for bug %s. Use the form "
3405
"'tracker:id' or specify a default bug tracker "
3406
"using the `bugtracker` option.\nSee "
3407
"\"bzr help bugs\" for more information on this "
3408
"feature. Commit refused.") % fixed_bug)
3409
tag = default_bugtracker
3411
elif len(tokens) != 2:
3412
raise errors.BzrCommandError(gettext(
3413
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3414
"See \"bzr help bugs\" for more information on this "
3415
"feature.\nCommit refused.") % fixed_bug)
3417
tag, bug_id = tokens
3419
yield bugtracker.get_bug_url(tag, branch, bug_id)
3420
except errors.UnknownBugTrackerAbbreviation:
3421
raise errors.BzrCommandError(gettext(
3422
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3423
except errors.MalformedBugIdentifier, e:
3424
raise errors.BzrCommandError(gettext(
3425
"%s\nCommit refused.") % (str(e),))
3427
def run(self, message=None, file=None, verbose=False, selected_list=None,
3428
unchanged=False, strict=False, local=False, fixes=None,
3429
author=None, show_diff=False, exclude=None, commit_time=None,
3431
from bzrlib.errors import (
3436
from bzrlib.msgeditor import (
3437
edit_commit_message_encoded,
3438
generate_commit_message_template,
3439
make_commit_message_template_encoded,
3443
commit_stamp = offset = None
3444
if commit_time is not None:
3446
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3447
except ValueError, e:
3448
raise errors.BzrCommandError(gettext(
3449
"Could not parse --commit-time: " + str(e)))
3453
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3454
if selected_list == ['']:
3455
# workaround - commit of root of tree should be exactly the same
3456
# as just default commit in that tree, and succeed even though
3457
# selected-file merge commit is not done yet
3462
bug_property = bugtracker.encode_fixes_bug_urls(
3463
self._iter_bug_fix_urls(fixes, tree.branch))
3465
properties['bugs'] = bug_property
3467
if local and not tree.branch.get_bound_location():
3468
raise errors.LocalRequiresBoundBranch()
3470
if message is not None:
3472
file_exists = osutils.lexists(message)
3473
except UnicodeError:
3474
# The commit message contains unicode characters that can't be
3475
# represented in the filesystem encoding, so that can't be a
3480
'The commit message is a file name: "%(f)s".\n'
3481
'(use --file "%(f)s" to take commit message from that file)'
3483
ui.ui_factory.show_warning(warning_msg)
3485
message = message.replace('\r\n', '\n')
3486
message = message.replace('\r', '\n')
3488
raise errors.BzrCommandError(gettext(
3489
"please specify either --message or --file"))
3491
def get_message(commit_obj):
3492
"""Callback to get commit message"""
3496
my_message = f.read().decode(osutils.get_user_encoding())
3499
elif message is not None:
3500
my_message = message
3502
# No message supplied: make one up.
3503
# text is the status of the tree
3504
text = make_commit_message_template_encoded(tree,
3505
selected_list, diff=show_diff,
3506
output_encoding=osutils.get_user_encoding())
3507
# start_message is the template generated from hooks
3508
# XXX: Warning - looks like hooks return unicode,
3509
# make_commit_message_template_encoded returns user encoding.
3510
# We probably want to be using edit_commit_message instead to
3512
my_message = set_commit_message(commit_obj)
3513
if my_message is None:
3514
start_message = generate_commit_message_template(commit_obj)
3515
my_message = edit_commit_message_encoded(text,
3516
start_message=start_message)
3517
if my_message is None:
3518
raise errors.BzrCommandError(gettext("please specify a commit"
3519
" message with either --message or --file"))
3520
if my_message == "":
3521
raise errors.BzrCommandError(gettext("Empty commit message specified."
3522
" Please specify a commit message with either"
3523
" --message or --file or leave a blank message"
3524
" with --message \"\"."))
3527
# The API permits a commit with a filter of [] to mean 'select nothing'
3528
# but the command line should not do that.
3529
if not selected_list:
3530
selected_list = None
3532
tree.commit(message_callback=get_message,
3533
specific_files=selected_list,
3534
allow_pointless=unchanged, strict=strict, local=local,
3535
reporter=None, verbose=verbose, revprops=properties,
3536
authors=author, timestamp=commit_stamp,
3538
exclude=tree.safe_relpath_files(exclude),
3540
except PointlessCommit:
3541
raise errors.BzrCommandError(gettext("No changes to commit."
3542
" Please 'bzr add' the files you want to commit, or use"
3543
" --unchanged to force an empty commit."))
3544
except ConflictsInTree:
3545
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3546
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3548
except StrictCommitFailed:
3549
raise errors.BzrCommandError(gettext("Commit refused because there are"
3550
" unknown files in the working tree."))
3551
except errors.BoundBranchOutOfDate, e:
3552
e.extra_help = (gettext("\n"
3553
'To commit to master branch, run update and then commit.\n'
3554
'You can also pass --local to commit to continue working '
3559
class cmd_check(Command):
3560
__doc__ = """Validate working tree structure, branch consistency and repository history.
3562
This command checks various invariants about branch and repository storage
3563
to detect data corruption or bzr bugs.
3565
The working tree and branch checks will only give output if a problem is
3566
detected. The output fields of the repository check are:
3569
This is just the number of revisions checked. It doesn't
3573
This is just the number of versionedfiles checked. It
3574
doesn't indicate a problem.
3576
unreferenced ancestors
3577
Texts that are ancestors of other texts, but
3578
are not properly referenced by the revision ancestry. This is a
3579
subtle problem that Bazaar can work around.
3582
This is the total number of unique file contents
3583
seen in the checked revisions. It does not indicate a problem.
3586
This is the total number of repeated texts seen
3587
in the checked revisions. Texts can be repeated when their file
3588
entries are modified, but the file contents are not. It does not
3591
If no restrictions are specified, all Bazaar data that is found at the given
3592
location will be checked.
3596
Check the tree and branch at 'foo'::
3598
bzr check --tree --branch foo
3600
Check only the repository at 'bar'::
3602
bzr check --repo bar
3604
Check everything at 'baz'::
3609
_see_also = ['reconcile']
3610
takes_args = ['path?']
3611
takes_options = ['verbose',
3612
Option('branch', help="Check the branch related to the"
3613
" current directory."),
3614
Option('repo', help="Check the repository related to the"
3615
" current directory."),
3616
Option('tree', help="Check the working tree related to"
3617
" the current directory.")]
3619
def run(self, path=None, verbose=False, branch=False, repo=False,
3621
from bzrlib.check import check_dwim
3624
if not branch and not repo and not tree:
3625
branch = repo = tree = True
3626
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3629
class cmd_upgrade(Command):
3630
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3632
When the default format has changed after a major new release of
3633
Bazaar, you may be informed during certain operations that you
3634
should upgrade. Upgrading to a newer format may improve performance
3635
or make new features available. It may however limit interoperability
3636
with older repositories or with older versions of Bazaar.
3638
If you wish to upgrade to a particular format rather than the
3639
current default, that can be specified using the --format option.
3640
As a consequence, you can use the upgrade command this way to
3641
"downgrade" to an earlier format, though some conversions are
3642
a one way process (e.g. changing from the 1.x default to the
3643
2.x default) so downgrading is not always possible.
3645
A backup.bzr.~#~ directory is created at the start of the conversion
3646
process (where # is a number). By default, this is left there on
3647
completion. If the conversion fails, delete the new .bzr directory
3648
and rename this one back in its place. Use the --clean option to ask
3649
for the backup.bzr directory to be removed on successful conversion.
3650
Alternatively, you can delete it by hand if everything looks good
3653
If the location given is a shared repository, dependent branches
3654
are also converted provided the repository converts successfully.
3655
If the conversion of a branch fails, remaining branches are still
3658
For more information on upgrades, see the Bazaar Upgrade Guide,
3659
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3662
_see_also = ['check', 'reconcile', 'formats']
3663
takes_args = ['url?']
3665
RegistryOption('format',
3666
help='Upgrade to a specific format. See "bzr help'
3667
' formats" for details.',
3668
lazy_registry=('bzrlib.controldir', 'format_registry'),
3669
converter=lambda name: controldir.format_registry.make_bzrdir(name),
3670
value_switches=True, title='Branch format'),
3672
help='Remove the backup.bzr directory if successful.'),
3674
help="Show what would be done, but don't actually do anything."),
3677
def run(self, url='.', format=None, clean=False, dry_run=False):
3678
from bzrlib.upgrade import upgrade
3679
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3681
if len(exceptions) == 1:
3682
# Compatibility with historical behavior
3688
class cmd_whoami(Command):
3689
__doc__ = """Show or set bzr user id.
3692
Show the email of the current user::
3696
Set the current user::
3698
bzr whoami "Frank Chu <fchu@example.com>"
3700
takes_options = [ 'directory',
3702
help='Display email address only.'),
3704
help='Set identity for the current branch instead of '
3707
takes_args = ['name?']
3708
encoding_type = 'replace'
3711
def run(self, email=False, branch=False, name=None, directory=None):
3713
if directory is None:
3714
# use branch if we're inside one; otherwise global config
3716
c = Branch.open_containing(u'.')[0].get_config_stack()
3717
except errors.NotBranchError:
3718
c = _mod_config.GlobalStack()
3720
c = Branch.open(directory).get_config_stack()
3721
identity = c.get('email')
3723
self.outf.write(_mod_config.extract_email_address(identity)
3726
self.outf.write(identity + '\n')
3730
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3733
# display a warning if an email address isn't included in the given name.
3735
_mod_config.extract_email_address(name)
3736
except errors.NoEmailInUsername, e:
3737
warning('"%s" does not seem to contain an email address. '
3738
'This is allowed, but not recommended.', name)
3740
# use global config unless --branch given
3742
if directory is None:
3743
c = Branch.open_containing(u'.')[0].get_config_stack()
3745
c = Branch.open(directory).get_config_stack()
3747
c = _mod_config.GlobalStack()
3748
c.set('email', name)
3751
class cmd_nick(Command):
3752
__doc__ = """Print or set the branch nickname.
3754
If unset, the tree root directory name is used as the nickname.
3755
To print the current nickname, execute with no argument.
3757
Bound branches use the nickname of its master branch unless it is set
3761
_see_also = ['info']
3762
takes_args = ['nickname?']
3763
takes_options = ['directory']
3764
def run(self, nickname=None, directory=u'.'):
3765
branch = Branch.open_containing(directory)[0]
3766
if nickname is None:
3767
self.printme(branch)
3769
branch.nick = nickname
3772
def printme(self, branch):
3773
self.outf.write('%s\n' % branch.nick)
3776
class cmd_alias(Command):
3777
__doc__ = """Set/unset and display aliases.
3780
Show the current aliases::
3784
Show the alias specified for 'll'::
3788
Set an alias for 'll'::
3790
bzr alias ll="log --line -r-10..-1"
3792
To remove an alias for 'll'::
3794
bzr alias --remove ll
3797
takes_args = ['name?']
3799
Option('remove', help='Remove the alias.'),
3802
def run(self, name=None, remove=False):
3804
self.remove_alias(name)
3806
self.print_aliases()
3808
equal_pos = name.find('=')
3810
self.print_alias(name)
3812
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3814
def remove_alias(self, alias_name):
3815
if alias_name is None:
3816
raise errors.BzrCommandError(gettext(
3817
'bzr alias --remove expects an alias to remove.'))
3818
# If alias is not found, print something like:
3819
# unalias: foo: not found
3820
c = _mod_config.GlobalConfig()
3821
c.unset_alias(alias_name)
3824
def print_aliases(self):
3825
"""Print out the defined aliases in a similar format to bash."""
3826
aliases = _mod_config.GlobalConfig().get_aliases()
3827
for key, value in sorted(aliases.iteritems()):
3828
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3831
def print_alias(self, alias_name):
3832
from bzrlib.commands import get_alias
3833
alias = get_alias(alias_name)
3835
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3838
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3840
def set_alias(self, alias_name, alias_command):
3841
"""Save the alias in the global config."""
3842
c = _mod_config.GlobalConfig()
3843
c.set_alias(alias_name, alias_command)
3846
class cmd_selftest(Command):
3847
__doc__ = """Run internal test suite.
3849
If arguments are given, they are regular expressions that say which tests
3850
should run. Tests matching any expression are run, and other tests are
3853
Alternatively if --first is given, matching tests are run first and then
3854
all other tests are run. This is useful if you have been working in a
3855
particular area, but want to make sure nothing else was broken.
3857
If --exclude is given, tests that match that regular expression are
3858
excluded, regardless of whether they match --first or not.
3860
To help catch accidential dependencies between tests, the --randomize
3861
option is useful. In most cases, the argument used is the word 'now'.
3862
Note that the seed used for the random number generator is displayed
3863
when this option is used. The seed can be explicitly passed as the
3864
argument to this option if required. This enables reproduction of the
3865
actual ordering used if and when an order sensitive problem is encountered.
3867
If --list-only is given, the tests that would be run are listed. This is
3868
useful when combined with --first, --exclude and/or --randomize to
3869
understand their impact. The test harness reports "Listed nn tests in ..."
3870
instead of "Ran nn tests in ..." when list mode is enabled.
3872
If the global option '--no-plugins' is given, plugins are not loaded
3873
before running the selftests. This has two effects: features provided or
3874
modified by plugins will not be tested, and tests provided by plugins will
3877
Tests that need working space on disk use a common temporary directory,
3878
typically inside $TMPDIR or /tmp.
3880
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3881
into a pdb postmortem session.
3883
The --coverage=DIRNAME global option produces a report with covered code
3887
Run only tests relating to 'ignore'::
3891
Disable plugins and list tests as they're run::
3893
bzr --no-plugins selftest -v
3895
# NB: this is used from the class without creating an instance, which is
3896
# why it does not have a self parameter.
3897
def get_transport_type(typestring):
3898
"""Parse and return a transport specifier."""
3899
if typestring == "sftp":
3900
from bzrlib.tests import stub_sftp
3901
return stub_sftp.SFTPAbsoluteServer
3902
elif typestring == "memory":
3903
from bzrlib.tests import test_server
3904
return memory.MemoryServer
3905
elif typestring == "fakenfs":
3906
from bzrlib.tests import test_server
3907
return test_server.FakeNFSServer
3908
msg = "No known transport type %s. Supported types are: sftp\n" %\
3910
raise errors.BzrCommandError(msg)
3913
takes_args = ['testspecs*']
3914
takes_options = ['verbose',
3916
help='Stop when one test fails.',
3920
help='Use a different transport by default '
3921
'throughout the test suite.',
3922
type=get_transport_type),
3924
help='Run the benchmarks rather than selftests.',
3926
Option('lsprof-timed',
3927
help='Generate lsprof output for benchmarked'
3928
' sections of code.'),
3929
Option('lsprof-tests',
3930
help='Generate lsprof output for each test.'),
3932
help='Run all tests, but run specified tests first.',
3936
help='List the tests instead of running them.'),
3937
RegistryOption('parallel',
3938
help="Run the test suite in parallel.",
3939
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3940
value_switches=False,
3942
Option('randomize', type=str, argname="SEED",
3943
help='Randomize the order of tests using the given'
3944
' seed or "now" for the current time.'),
3945
ListOption('exclude', type=str, argname="PATTERN",
3947
help='Exclude tests that match this regular'
3950
help='Output test progress via subunit.'),
3951
Option('strict', help='Fail on missing dependencies or '
3953
Option('load-list', type=str, argname='TESTLISTFILE',
3954
help='Load a test id list from a text file.'),
3955
ListOption('debugflag', type=str, short_name='E',
3956
help='Turn on a selftest debug flag.'),
3957
ListOption('starting-with', type=str, argname='TESTID',
3958
param_name='starting_with', short_name='s',
3960
'Load only the tests starting with TESTID.'),
3962
help="By default we disable fsync and fdatasync"
3963
" while running the test suite.")
3965
encoding_type = 'replace'
3968
Command.__init__(self)
3969
self.additional_selftest_args = {}
3971
def run(self, testspecs_list=None, verbose=False, one=False,
3972
transport=None, benchmark=None,
3974
first=False, list_only=False,
3975
randomize=None, exclude=None, strict=False,
3976
load_list=None, debugflag=None, starting_with=None, subunit=False,
3977
parallel=None, lsprof_tests=False,
3979
from bzrlib import tests
3981
if testspecs_list is not None:
3982
pattern = '|'.join(testspecs_list)
3987
from bzrlib.tests import SubUnitBzrRunner
3989
raise errors.BzrCommandError(gettext("subunit not available. subunit "
3990
"needs to be installed to use --subunit."))
3991
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3992
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3993
# stdout, which would corrupt the subunit stream.
3994
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3995
# following code can be deleted when it's sufficiently deployed
3996
# -- vila/mgz 20100514
3997
if (sys.platform == "win32"
3998
and getattr(sys.stdout, 'fileno', None) is not None):
4000
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4002
self.additional_selftest_args.setdefault(
4003
'suite_decorators', []).append(parallel)
4005
raise errors.BzrCommandError(gettext(
4006
"--benchmark is no longer supported from bzr 2.2; "
4007
"use bzr-usertest instead"))
4008
test_suite_factory = None
4010
exclude_pattern = None
4012
exclude_pattern = '(' + '|'.join(exclude) + ')'
4014
self._disable_fsync()
4015
selftest_kwargs = {"verbose": verbose,
4017
"stop_on_failure": one,
4018
"transport": transport,
4019
"test_suite_factory": test_suite_factory,
4020
"lsprof_timed": lsprof_timed,
4021
"lsprof_tests": lsprof_tests,
4022
"matching_tests_first": first,
4023
"list_only": list_only,
4024
"random_seed": randomize,
4025
"exclude_pattern": exclude_pattern,
4027
"load_list": load_list,
4028
"debug_flags": debugflag,
4029
"starting_with": starting_with
4031
selftest_kwargs.update(self.additional_selftest_args)
4033
# Make deprecation warnings visible, unless -Werror is set
4034
cleanup = symbol_versioning.activate_deprecation_warnings(
4037
result = tests.selftest(**selftest_kwargs)
4040
return int(not result)
4042
def _disable_fsync(self):
4043
"""Change the 'os' functionality to not synchronize."""
4044
self._orig_fsync = getattr(os, 'fsync', None)
4045
if self._orig_fsync is not None:
4046
os.fsync = lambda filedes: None
4047
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4048
if self._orig_fdatasync is not None:
4049
os.fdatasync = lambda filedes: None
4052
class cmd_version(Command):
4053
__doc__ = """Show version of bzr."""
4055
encoding_type = 'replace'
4057
Option("short", help="Print just the version number."),
4061
def run(self, short=False):
4062
from bzrlib.version import show_version
4064
self.outf.write(bzrlib.version_string + '\n')
4066
show_version(to_file=self.outf)
4069
class cmd_rocks(Command):
4070
__doc__ = """Statement of optimism."""
4076
self.outf.write(gettext("It sure does!\n"))
4079
class cmd_find_merge_base(Command):
4080
__doc__ = """Find and print a base revision for merging two branches."""
4081
# TODO: Options to specify revisions on either side, as if
4082
# merging only part of the history.
4083
takes_args = ['branch', 'other']
4087
def run(self, branch, other):
4088
from bzrlib.revision import ensure_null
4090
branch1 = Branch.open_containing(branch)[0]
4091
branch2 = Branch.open_containing(other)[0]
4092
self.add_cleanup(branch1.lock_read().unlock)
4093
self.add_cleanup(branch2.lock_read().unlock)
4094
last1 = ensure_null(branch1.last_revision())
4095
last2 = ensure_null(branch2.last_revision())
4097
graph = branch1.repository.get_graph(branch2.repository)
4098
base_rev_id = graph.find_unique_lca(last1, last2)
4100
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4103
class cmd_merge(Command):
4104
__doc__ = """Perform a three-way merge.
4106
The source of the merge can be specified either in the form of a branch,
4107
or in the form of a path to a file containing a merge directive generated
4108
with bzr send. If neither is specified, the default is the upstream branch
4109
or the branch most recently merged using --remember. The source of the
4110
merge may also be specified in the form of a path to a file in another
4111
branch: in this case, only the modifications to that file are merged into
4112
the current working tree.
4114
When merging from a branch, by default bzr will try to merge in all new
4115
work from the other branch, automatically determining an appropriate base
4116
revision. If this fails, you may need to give an explicit base.
4118
To pick a different ending revision, pass "--revision OTHER". bzr will
4119
try to merge in all new work up to and including revision OTHER.
4121
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4122
through OTHER, excluding BASE but including OTHER, will be merged. If this
4123
causes some revisions to be skipped, i.e. if the destination branch does
4124
not already contain revision BASE, such a merge is commonly referred to as
4125
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4126
cherrypicks. The changes look like a normal commit, and the history of the
4127
changes from the other branch is not stored in the commit.
4129
Revision numbers are always relative to the source branch.
4131
Merge will do its best to combine the changes in two branches, but there
4132
are some kinds of problems only a human can fix. When it encounters those,
4133
it will mark a conflict. A conflict means that you need to fix something,
4134
before you should commit.
4136
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
4138
If there is no default branch set, the first merge will set it (use
4139
--no-remember to avoid setting it). After that, you can omit the branch
4140
to use the default. To change the default, use --remember. The value will
4141
only be saved if the remote location can be accessed.
4143
The results of the merge are placed into the destination working
4144
directory, where they can be reviewed (with bzr diff), tested, and then
4145
committed to record the result of the merge.
4147
merge refuses to run if there are any uncommitted changes, unless
4148
--force is given. If --force is given, then the changes from the source
4149
will be merged with the current working tree, including any uncommitted
4150
changes in the tree. The --force option can also be used to create a
4151
merge revision which has more than two parents.
4153
If one would like to merge changes from the working tree of the other
4154
branch without merging any committed revisions, the --uncommitted option
4157
To select only some changes to merge, use "merge -i", which will prompt
4158
you to apply each diff hunk and file change, similar to "shelve".
4161
To merge all new revisions from bzr.dev::
4163
bzr merge ../bzr.dev
4165
To merge changes up to and including revision 82 from bzr.dev::
4167
bzr merge -r 82 ../bzr.dev
4169
To merge the changes introduced by 82, without previous changes::
4171
bzr merge -r 81..82 ../bzr.dev
4173
To apply a merge directive contained in /tmp/merge::
4175
bzr merge /tmp/merge
4177
To create a merge revision with three parents from two branches
4178
feature1a and feature1b:
4180
bzr merge ../feature1a
4181
bzr merge ../feature1b --force
4182
bzr commit -m 'revision with three parents'
4185
encoding_type = 'exact'
4186
_see_also = ['update', 'remerge', 'status-flags', 'send']
4187
takes_args = ['location?']
4192
help='Merge even if the destination tree has uncommitted changes.'),
4196
Option('show-base', help="Show base revision text in "
4198
Option('uncommitted', help='Apply uncommitted changes'
4199
' from a working copy, instead of branch changes.'),
4200
Option('pull', help='If the destination is already'
4201
' completely merged into the source, pull from the'
4202
' source rather than merging. When this happens,'
4203
' you do not need to commit the result.'),
4204
custom_help('directory',
4205
help='Branch to merge into, '
4206
'rather than the one containing the working directory.'),
4207
Option('preview', help='Instead of merging, show a diff of the'
4209
Option('interactive', help='Select changes interactively.',
4213
def run(self, location=None, revision=None, force=False,
4214
merge_type=None, show_base=False, reprocess=None, remember=None,
4215
uncommitted=False, pull=False,
4220
if merge_type is None:
4221
merge_type = _mod_merge.Merge3Merger
4223
if directory is None: directory = u'.'
4224
possible_transports = []
4226
allow_pending = True
4227
verified = 'inapplicable'
4229
tree = WorkingTree.open_containing(directory)[0]
4230
if tree.branch.revno() == 0:
4231
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4232
'https://bugs.launchpad.net/bzr/+bug/308562'))
4235
basis_tree = tree.revision_tree(tree.last_revision())
4236
except errors.NoSuchRevision:
4237
basis_tree = tree.basis_tree()
4239
# die as quickly as possible if there are uncommitted changes
4241
if tree.has_changes():
4242
raise errors.UncommittedChanges(tree)
4244
view_info = _get_view_info_for_change_reporter(tree)
4245
change_reporter = delta._ChangeReporter(
4246
unversioned_filter=tree.is_ignored, view_info=view_info)
4247
pb = ui.ui_factory.nested_progress_bar()
4248
self.add_cleanup(pb.finished)
4249
self.add_cleanup(tree.lock_write().unlock)
4250
if location is not None:
4252
mergeable = bundle.read_mergeable_from_url(location,
4253
possible_transports=possible_transports)
4254
except errors.NotABundle:
4258
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4259
' with bundles or merge directives.'))
4261
if revision is not None:
4262
raise errors.BzrCommandError(gettext(
4263
'Cannot use -r with merge directives or bundles'))
4264
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4267
if merger is None and uncommitted:
4268
if revision is not None and len(revision) > 0:
4269
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4270
' --revision at the same time.'))
4271
merger = self.get_merger_from_uncommitted(tree, location, None)
4272
allow_pending = False
4275
merger, allow_pending = self._get_merger_from_branch(tree,
4276
location, revision, remember, possible_transports, None)
4278
merger.merge_type = merge_type
4279
merger.reprocess = reprocess
4280
merger.show_base = show_base
4281
self.sanity_check_merger(merger)
4282
if (merger.base_rev_id == merger.other_rev_id and
4283
merger.other_rev_id is not None):
4284
# check if location is a nonexistent file (and not a branch) to
4285
# disambiguate the 'Nothing to do'
4286
if merger.interesting_files:
4287
if not merger.other_tree.has_filename(
4288
merger.interesting_files[0]):
4289
note(gettext("merger: ") + str(merger))
4290
raise errors.PathsDoNotExist([location])
4291
note(gettext('Nothing to do.'))
4293
if pull and not preview:
4294
if merger.interesting_files is not None:
4295
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4296
if (merger.base_rev_id == tree.last_revision()):
4297
result = tree.pull(merger.other_branch, False,
4298
merger.other_rev_id)
4299
result.report(self.outf)
4301
if merger.this_basis is None:
4302
raise errors.BzrCommandError(gettext(
4303
"This branch has no commits."
4304
" (perhaps you would prefer 'bzr pull')"))
4306
return self._do_preview(merger)
4308
return self._do_interactive(merger)
4310
return self._do_merge(merger, change_reporter, allow_pending,
4313
def _get_preview(self, merger):
4314
tree_merger = merger.make_merger()
4315
tt = tree_merger.make_preview_transform()
4316
self.add_cleanup(tt.finalize)
4317
result_tree = tt.get_preview_tree()
4320
def _do_preview(self, merger):
4321
from bzrlib.diff import show_diff_trees
4322
result_tree = self._get_preview(merger)
4323
path_encoding = osutils.get_diff_header_encoding()
4324
show_diff_trees(merger.this_tree, result_tree, self.outf,
4325
old_label='', new_label='',
4326
path_encoding=path_encoding)
4328
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4329
merger.change_reporter = change_reporter
4330
conflict_count = merger.do_merge()
4332
merger.set_pending()
4333
if verified == 'failed':
4334
warning('Preview patch does not match changes')
4335
if conflict_count != 0:
4340
def _do_interactive(self, merger):
4341
"""Perform an interactive merge.
4343
This works by generating a preview tree of the merge, then using
4344
Shelver to selectively remove the differences between the working tree
4345
and the preview tree.
4347
from bzrlib import shelf_ui
4348
result_tree = self._get_preview(merger)
4349
writer = bzrlib.option.diff_writer_registry.get()
4350
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4351
reporter=shelf_ui.ApplyReporter(),
4352
diff_writer=writer(sys.stdout))
4358
def sanity_check_merger(self, merger):
4359
if (merger.show_base and
4360
not merger.merge_type is _mod_merge.Merge3Merger):
4361
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4362
" merge type. %s") % merger.merge_type)
4363
if merger.reprocess is None:
4364
if merger.show_base:
4365
merger.reprocess = False
4367
# Use reprocess if the merger supports it
4368
merger.reprocess = merger.merge_type.supports_reprocess
4369
if merger.reprocess and not merger.merge_type.supports_reprocess:
4370
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4371
" for merge type %s.") %
4373
if merger.reprocess and merger.show_base:
4374
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4377
def _get_merger_from_branch(self, tree, location, revision, remember,
4378
possible_transports, pb):
4379
"""Produce a merger from a location, assuming it refers to a branch."""
4380
from bzrlib.tag import _merge_tags_if_possible
4381
# find the branch locations
4382
other_loc, user_location = self._select_branch_location(tree, location,
4384
if revision is not None and len(revision) == 2:
4385
base_loc, _unused = self._select_branch_location(tree,
4386
location, revision, 0)
4388
base_loc = other_loc
4390
other_branch, other_path = Branch.open_containing(other_loc,
4391
possible_transports)
4392
if base_loc == other_loc:
4393
base_branch = other_branch
4395
base_branch, base_path = Branch.open_containing(base_loc,
4396
possible_transports)
4397
# Find the revision ids
4398
other_revision_id = None
4399
base_revision_id = None
4400
if revision is not None:
4401
if len(revision) >= 1:
4402
other_revision_id = revision[-1].as_revision_id(other_branch)
4403
if len(revision) == 2:
4404
base_revision_id = revision[0].as_revision_id(base_branch)
4405
if other_revision_id is None:
4406
other_revision_id = _mod_revision.ensure_null(
4407
other_branch.last_revision())
4408
# Remember where we merge from. We need to remember if:
4409
# - user specify a location (and we don't merge from the parent
4411
# - user ask to remember or there is no previous location set to merge
4412
# from and user didn't ask to *not* remember
4413
if (user_location is not None
4415
or (remember is None
4416
and tree.branch.get_submit_branch() is None)))):
4417
tree.branch.set_submit_branch(other_branch.base)
4418
# Merge tags (but don't set them in the master branch yet, the user
4419
# might revert this merge). Commit will propagate them.
4420
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4421
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4422
other_revision_id, base_revision_id, other_branch, base_branch)
4423
if other_path != '':
4424
allow_pending = False
4425
merger.interesting_files = [other_path]
4427
allow_pending = True
4428
return merger, allow_pending
4430
def get_merger_from_uncommitted(self, tree, location, pb):
4431
"""Get a merger for uncommitted changes.
4433
:param tree: The tree the merger should apply to.
4434
:param location: The location containing uncommitted changes.
4435
:param pb: The progress bar to use for showing progress.
4437
location = self._select_branch_location(tree, location)[0]
4438
other_tree, other_path = WorkingTree.open_containing(location)
4439
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4440
if other_path != '':
4441
merger.interesting_files = [other_path]
4444
def _select_branch_location(self, tree, user_location, revision=None,
4446
"""Select a branch location, according to possible inputs.
4448
If provided, branches from ``revision`` are preferred. (Both
4449
``revision`` and ``index`` must be supplied.)
4451
Otherwise, the ``location`` parameter is used. If it is None, then the
4452
``submit`` or ``parent`` location is used, and a note is printed.
4454
:param tree: The working tree to select a branch for merging into
4455
:param location: The location entered by the user
4456
:param revision: The revision parameter to the command
4457
:param index: The index to use for the revision parameter. Negative
4458
indices are permitted.
4459
:return: (selected_location, user_location). The default location
4460
will be the user-entered location.
4462
if (revision is not None and index is not None
4463
and revision[index] is not None):
4464
branch = revision[index].get_branch()
4465
if branch is not None:
4466
return branch, branch
4467
if user_location is None:
4468
location = self._get_remembered(tree, 'Merging from')
4470
location = user_location
4471
return location, user_location
4473
def _get_remembered(self, tree, verb_string):
4474
"""Use tree.branch's parent if none was supplied.
4476
Report if the remembered location was used.
4478
stored_location = tree.branch.get_submit_branch()
4479
stored_location_type = "submit"
4480
if stored_location is None:
4481
stored_location = tree.branch.get_parent()
4482
stored_location_type = "parent"
4483
mutter("%s", stored_location)
4484
if stored_location is None:
4485
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4486
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4487
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4488
stored_location_type, display_url))
4489
return stored_location
4492
class cmd_remerge(Command):
4493
__doc__ = """Redo a merge.
4495
Use this if you want to try a different merge technique while resolving
4496
conflicts. Some merge techniques are better than others, and remerge
4497
lets you try different ones on different files.
4499
The options for remerge have the same meaning and defaults as the ones for
4500
merge. The difference is that remerge can (only) be run when there is a
4501
pending merge, and it lets you specify particular files.
4504
Re-do the merge of all conflicted files, and show the base text in
4505
conflict regions, in addition to the usual THIS and OTHER texts::
4507
bzr remerge --show-base
4509
Re-do the merge of "foobar", using the weave merge algorithm, with
4510
additional processing to reduce the size of conflict regions::
4512
bzr remerge --merge-type weave --reprocess foobar
4514
takes_args = ['file*']
4519
help="Show base revision text in conflicts."),
4522
def run(self, file_list=None, merge_type=None, show_base=False,
4524
from bzrlib.conflicts import restore
4525
if merge_type is None:
4526
merge_type = _mod_merge.Merge3Merger
4527
tree, file_list = WorkingTree.open_containing_paths(file_list)
4528
self.add_cleanup(tree.lock_write().unlock)
4529
parents = tree.get_parent_ids()
4530
if len(parents) != 2:
4531
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4532
" merges. Not cherrypicking or"
4534
repository = tree.branch.repository
4535
interesting_ids = None
4537
conflicts = tree.conflicts()
4538
if file_list is not None:
4539
interesting_ids = set()
4540
for filename in file_list:
4541
file_id = tree.path2id(filename)
4543
raise errors.NotVersionedError(filename)
4544
interesting_ids.add(file_id)
4545
if tree.kind(file_id) != "directory":
4548
for name, ie in tree.inventory.iter_entries(file_id):
4549
interesting_ids.add(ie.file_id)
4550
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4552
# Remerge only supports resolving contents conflicts
4553
allowed_conflicts = ('text conflict', 'contents conflict')
4554
restore_files = [c.path for c in conflicts
4555
if c.typestring in allowed_conflicts]
4556
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4557
tree.set_conflicts(ConflictList(new_conflicts))
4558
if file_list is not None:
4559
restore_files = file_list
4560
for filename in restore_files:
4562
restore(tree.abspath(filename))
4563
except errors.NotConflicted:
4565
# Disable pending merges, because the file texts we are remerging
4566
# have not had those merges performed. If we use the wrong parents
4567
# list, we imply that the working tree text has seen and rejected
4568
# all the changes from the other tree, when in fact those changes
4569
# have not yet been seen.
4570
tree.set_parent_ids(parents[:1])
4572
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4573
merger.interesting_ids = interesting_ids
4574
merger.merge_type = merge_type
4575
merger.show_base = show_base
4576
merger.reprocess = reprocess
4577
conflicts = merger.do_merge()
4579
tree.set_parent_ids(parents)
4586
class cmd_revert(Command):
4587
__doc__ = """Revert files to a previous revision.
4589
Giving a list of files will revert only those files. Otherwise, all files
4590
will be reverted. If the revision is not specified with '--revision', the
4591
last committed revision is used.
4593
To remove only some changes, without reverting to a prior version, use
4594
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4595
will remove the changes introduced by the second last commit (-2), without
4596
affecting the changes introduced by the last commit (-1). To remove
4597
certain changes on a hunk-by-hunk basis, see the shelve command.
4599
By default, any files that have been manually changed will be backed up
4600
first. (Files changed only by merge are not backed up.) Backup files have
4601
'.~#~' appended to their name, where # is a number.
4603
When you provide files, you can use their current pathname or the pathname
4604
from the target revision. So you can use revert to "undelete" a file by
4605
name. If you name a directory, all the contents of that directory will be
4608
If you have newly added files since the target revision, they will be
4609
removed. If the files to be removed have been changed, backups will be
4610
created as above. Directories containing unknown files will not be
4613
The working tree contains a list of revisions that have been merged but
4614
not yet committed. These revisions will be included as additional parents
4615
of the next commit. Normally, using revert clears that list as well as
4616
reverting the files. If any files are specified, revert leaves the list
4617
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4618
.`` in the tree root to revert all files but keep the recorded merges,
4619
and ``bzr revert --forget-merges`` to clear the pending merge list without
4620
reverting any files.
4622
Using "bzr revert --forget-merges", it is possible to apply all of the
4623
changes from a branch in a single revision. To do this, perform the merge
4624
as desired. Then doing revert with the "--forget-merges" option will keep
4625
the content of the tree as it was, but it will clear the list of pending
4626
merges. The next commit will then contain all of the changes that are
4627
present in the other branch, but without any other parent revisions.
4628
Because this technique forgets where these changes originated, it may
4629
cause additional conflicts on later merges involving the same source and
4633
_see_also = ['cat', 'export', 'merge', 'shelve']
4636
Option('no-backup', "Do not save backups of reverted files."),
4637
Option('forget-merges',
4638
'Remove pending merge marker, without changing any files.'),
4640
takes_args = ['file*']
4642
def run(self, revision=None, no_backup=False, file_list=None,
4643
forget_merges=None):
4644
tree, file_list = WorkingTree.open_containing_paths(file_list)
4645
self.add_cleanup(tree.lock_tree_write().unlock)
4647
tree.set_parent_ids(tree.get_parent_ids()[:1])
4649
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4652
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4653
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4654
tree.revert(file_list, rev_tree, not no_backup, None,
4655
report_changes=True)
4658
class cmd_assert_fail(Command):
4659
__doc__ = """Test reporting of assertion failures"""
4660
# intended just for use in testing
4665
raise AssertionError("always fails")
4668
class cmd_help(Command):
4669
__doc__ = """Show help on a command or other topic.
4672
_see_also = ['topics']
4674
Option('long', 'Show help on all commands.'),
4676
takes_args = ['topic?']
4677
aliases = ['?', '--help', '-?', '-h']
4680
def run(self, topic=None, long=False):
4682
if topic is None and long:
4684
bzrlib.help.help(topic)
4687
class cmd_shell_complete(Command):
4688
__doc__ = """Show appropriate completions for context.
4690
For a list of all available commands, say 'bzr shell-complete'.
4692
takes_args = ['context?']
4697
def run(self, context=None):
4698
import shellcomplete
4699
shellcomplete.shellcomplete(context)
4702
class cmd_missing(Command):
4703
__doc__ = """Show unmerged/unpulled revisions between two branches.
4705
OTHER_BRANCH may be local or remote.
4707
To filter on a range of revisions, you can use the command -r begin..end
4708
-r revision requests a specific revision, -r ..end or -r begin.. are
4712
1 - some missing revisions
4713
0 - no missing revisions
4717
Determine the missing revisions between this and the branch at the
4718
remembered pull location::
4722
Determine the missing revisions between this and another branch::
4724
bzr missing http://server/branch
4726
Determine the missing revisions up to a specific revision on the other
4729
bzr missing -r ..-10
4731
Determine the missing revisions up to a specific revision on this
4734
bzr missing --my-revision ..-10
4737
_see_also = ['merge', 'pull']
4738
takes_args = ['other_branch?']
4741
Option('reverse', 'Reverse the order of revisions.'),
4743
'Display changes in the local branch only.'),
4744
Option('this' , 'Same as --mine-only.'),
4745
Option('theirs-only',
4746
'Display changes in the remote branch only.'),
4747
Option('other', 'Same as --theirs-only.'),
4751
custom_help('revision',
4752
help='Filter on other branch revisions (inclusive). '
4753
'See "help revisionspec" for details.'),
4754
Option('my-revision',
4755
type=_parse_revision_str,
4756
help='Filter on local branch revisions (inclusive). '
4757
'See "help revisionspec" for details.'),
4758
Option('include-merged',
4759
'Show all revisions in addition to the mainline ones.'),
4760
Option('include-merges', hidden=True,
4761
help='Historical alias for --include-merged.'),
4763
encoding_type = 'replace'
4766
def run(self, other_branch=None, reverse=False, mine_only=False,
4768
log_format=None, long=False, short=False, line=False,
4769
show_ids=False, verbose=False, this=False, other=False,
4770
include_merged=None, revision=None, my_revision=None,
4772
include_merges=symbol_versioning.DEPRECATED_PARAMETER):
4773
from bzrlib.missing import find_unmerged, iter_log_revisions
4778
if symbol_versioning.deprecated_passed(include_merges):
4779
ui.ui_factory.show_user_warning(
4780
'deprecated_command_option',
4781
deprecated_name='--include-merges',
4782
recommended_name='--include-merged',
4783
deprecated_in_version='2.5',
4784
command=self.invoked_as)
4785
if include_merged is None:
4786
include_merged = include_merges
4788
raise errors.BzrCommandError(gettext(
4789
'{0} and {1} are mutually exclusive').format(
4790
'--include-merges', '--include-merged'))
4791
if include_merged is None:
4792
include_merged = False
4797
# TODO: We should probably check that we don't have mine-only and
4798
# theirs-only set, but it gets complicated because we also have
4799
# this and other which could be used.
4806
local_branch = Branch.open_containing(directory)[0]
4807
self.add_cleanup(local_branch.lock_read().unlock)
4809
parent = local_branch.get_parent()
4810
if other_branch is None:
4811
other_branch = parent
4812
if other_branch is None:
4813
raise errors.BzrCommandError(gettext("No peer location known"
4815
display_url = urlutils.unescape_for_display(parent,
4817
message(gettext("Using saved parent location: {0}\n").format(
4820
remote_branch = Branch.open(other_branch)
4821
if remote_branch.base == local_branch.base:
4822
remote_branch = local_branch
4824
self.add_cleanup(remote_branch.lock_read().unlock)
4826
local_revid_range = _revision_range_to_revid_range(
4827
_get_revision_range(my_revision, local_branch,
4830
remote_revid_range = _revision_range_to_revid_range(
4831
_get_revision_range(revision,
4832
remote_branch, self.name()))
4834
local_extra, remote_extra = find_unmerged(
4835
local_branch, remote_branch, restrict,
4836
backward=not reverse,
4837
include_merged=include_merged,
4838
local_revid_range=local_revid_range,
4839
remote_revid_range=remote_revid_range)
4841
if log_format is None:
4842
registry = log.log_formatter_registry
4843
log_format = registry.get_default(local_branch)
4844
lf = log_format(to_file=self.outf,
4846
show_timezone='original')
4849
if local_extra and not theirs_only:
4850
message(ngettext("You have %d extra revision:\n",
4851
"You have %d extra revisions:\n",
4854
for revision in iter_log_revisions(local_extra,
4855
local_branch.repository,
4857
lf.log_revision(revision)
4858
printed_local = True
4861
printed_local = False
4863
if remote_extra and not mine_only:
4864
if printed_local is True:
4866
message(ngettext("You are missing %d revision:\n",
4867
"You are missing %d revisions:\n",
4868
len(remote_extra)) %
4870
for revision in iter_log_revisions(remote_extra,
4871
remote_branch.repository,
4873
lf.log_revision(revision)
4876
if mine_only and not local_extra:
4877
# We checked local, and found nothing extra
4878
message(gettext('This branch has no new revisions.\n'))
4879
elif theirs_only and not remote_extra:
4880
# We checked remote, and found nothing extra
4881
message(gettext('Other branch has no new revisions.\n'))
4882
elif not (mine_only or theirs_only or local_extra or
4884
# We checked both branches, and neither one had extra
4886
message(gettext("Branches are up to date.\n"))
4888
if not status_code and parent is None and other_branch is not None:
4889
self.add_cleanup(local_branch.lock_write().unlock)
4890
# handle race conditions - a parent might be set while we run.
4891
if local_branch.get_parent() is None:
4892
local_branch.set_parent(remote_branch.base)
4896
class cmd_pack(Command):
4897
__doc__ = """Compress the data within a repository.
4899
This operation compresses the data within a bazaar repository. As
4900
bazaar supports automatic packing of repository, this operation is
4901
normally not required to be done manually.
4903
During the pack operation, bazaar takes a backup of existing repository
4904
data, i.e. pack files. This backup is eventually removed by bazaar
4905
automatically when it is safe to do so. To save disk space by removing
4906
the backed up pack files, the --clean-obsolete-packs option may be
4909
Warning: If you use --clean-obsolete-packs and your machine crashes
4910
during or immediately after repacking, you may be left with a state
4911
where the deletion has been written to disk but the new packs have not
4912
been. In this case the repository may be unusable.
4915
_see_also = ['repositories']
4916
takes_args = ['branch_or_repo?']
4918
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4921
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4922
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
4924
branch = dir.open_branch()
4925
repository = branch.repository
4926
except errors.NotBranchError:
4927
repository = dir.open_repository()
4928
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4931
class cmd_plugins(Command):
4932
__doc__ = """List the installed plugins.
4934
This command displays the list of installed plugins including
4935
version of plugin and a short description of each.
4937
--verbose shows the path where each plugin is located.
4939
A plugin is an external component for Bazaar that extends the
4940
revision control system, by adding or replacing code in Bazaar.
4941
Plugins can do a variety of things, including overriding commands,
4942
adding new commands, providing additional network transports and
4943
customizing log output.
4945
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4946
for further information on plugins including where to find them and how to
4947
install them. Instructions are also provided there on how to write new
4948
plugins using the Python programming language.
4950
takes_options = ['verbose']
4953
def run(self, verbose=False):
4954
from bzrlib import plugin
4955
# Don't give writelines a generator as some codecs don't like that
4956
self.outf.writelines(
4957
list(plugin.describe_plugins(show_paths=verbose)))
4960
class cmd_testament(Command):
4961
__doc__ = """Show testament (signing-form) of a revision."""
4964
Option('long', help='Produce long-format testament.'),
4966
help='Produce a strict-format testament.')]
4967
takes_args = ['branch?']
4969
def run(self, branch=u'.', revision=None, long=False, strict=False):
4970
from bzrlib.testament import Testament, StrictTestament
4972
testament_class = StrictTestament
4974
testament_class = Testament
4976
b = Branch.open_containing(branch)[0]
4978
b = Branch.open(branch)
4979
self.add_cleanup(b.lock_read().unlock)
4980
if revision is None:
4981
rev_id = b.last_revision()
4983
rev_id = revision[0].as_revision_id(b)
4984
t = testament_class.from_revision(b.repository, rev_id)
4986
sys.stdout.writelines(t.as_text_lines())
4988
sys.stdout.write(t.as_short_text())
4991
class cmd_annotate(Command):
4992
__doc__ = """Show the origin of each line in a file.
4994
This prints out the given file with an annotation on the left side
4995
indicating which revision, author and date introduced the change.
4997
If the origin is the same for a run of consecutive lines, it is
4998
shown only at the top, unless the --all option is given.
5000
# TODO: annotate directories; showing when each file was last changed
5001
# TODO: if the working copy is modified, show annotations on that
5002
# with new uncommitted lines marked
5003
aliases = ['ann', 'blame', 'praise']
5004
takes_args = ['filename']
5005
takes_options = [Option('all', help='Show annotations on all lines.'),
5006
Option('long', help='Show commit date in annotations.'),
5011
encoding_type = 'exact'
5014
def run(self, filename, all=False, long=False, revision=None,
5015
show_ids=False, directory=None):
5016
from bzrlib.annotate import (
5019
wt, branch, relpath = \
5020
_open_directory_or_containing_tree_or_branch(filename, directory)
5022
self.add_cleanup(wt.lock_read().unlock)
5024
self.add_cleanup(branch.lock_read().unlock)
5025
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5026
self.add_cleanup(tree.lock_read().unlock)
5027
if wt is not None and revision is None:
5028
file_id = wt.path2id(relpath)
5030
file_id = tree.path2id(relpath)
5032
raise errors.NotVersionedError(filename)
5033
if wt is not None and revision is None:
5034
# If there is a tree and we're not annotating historical
5035
# versions, annotate the working tree's content.
5036
annotate_file_tree(wt, file_id, self.outf, long, all,
5039
annotate_file_tree(tree, file_id, self.outf, long, all,
5040
show_ids=show_ids, branch=branch)
5043
class cmd_re_sign(Command):
5044
__doc__ = """Create a digital signature for an existing revision."""
5045
# TODO be able to replace existing ones.
5047
hidden = True # is this right ?
5048
takes_args = ['revision_id*']
5049
takes_options = ['directory', 'revision']
5051
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5052
if revision_id_list is not None and revision is not None:
5053
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5054
if revision_id_list is None and revision is None:
5055
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5056
b = WorkingTree.open_containing(directory)[0].branch
5057
self.add_cleanup(b.lock_write().unlock)
5058
return self._run(b, revision_id_list, revision)
5060
def _run(self, b, revision_id_list, revision):
5061
import bzrlib.gpg as gpg
5062
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5063
if revision_id_list is not None:
5064
b.repository.start_write_group()
5066
for revision_id in revision_id_list:
5067
b.repository.sign_revision(revision_id, gpg_strategy)
5069
b.repository.abort_write_group()
5072
b.repository.commit_write_group()
5073
elif revision is not None:
5074
if len(revision) == 1:
5075
revno, rev_id = revision[0].in_history(b)
5076
b.repository.start_write_group()
5078
b.repository.sign_revision(rev_id, gpg_strategy)
5080
b.repository.abort_write_group()
5083
b.repository.commit_write_group()
5084
elif len(revision) == 2:
5085
# are they both on rh- if so we can walk between them
5086
# might be nice to have a range helper for arbitrary
5087
# revision paths. hmm.
5088
from_revno, from_revid = revision[0].in_history(b)
5089
to_revno, to_revid = revision[1].in_history(b)
5090
if to_revid is None:
5091
to_revno = b.revno()
5092
if from_revno is None or to_revno is None:
5093
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5094
b.repository.start_write_group()
5096
for revno in range(from_revno, to_revno + 1):
5097
b.repository.sign_revision(b.get_rev_id(revno),
5100
b.repository.abort_write_group()
5103
b.repository.commit_write_group()
5105
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5108
class cmd_bind(Command):
5109
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5110
If no branch is supplied, rebind to the last bound location.
5112
Once converted into a checkout, commits must succeed on the master branch
5113
before they will be applied to the local branch.
5115
Bound branches use the nickname of its master branch unless it is set
5116
locally, in which case binding will update the local nickname to be
5120
_see_also = ['checkouts', 'unbind']
5121
takes_args = ['location?']
5122
takes_options = ['directory']
5124
def run(self, location=None, directory=u'.'):
5125
b, relpath = Branch.open_containing(directory)
5126
if location is None:
5128
location = b.get_old_bound_location()
5129
except errors.UpgradeRequired:
5130
raise errors.BzrCommandError(gettext('No location supplied. '
5131
'This format does not remember old locations.'))
5133
if location is None:
5134
if b.get_bound_location() is not None:
5135
raise errors.BzrCommandError(gettext('Branch is already bound'))
5137
raise errors.BzrCommandError(gettext('No location supplied '
5138
'and no previous location known'))
5139
b_other = Branch.open(location)
5142
except errors.DivergedBranches:
5143
raise errors.BzrCommandError(gettext('These branches have diverged.'
5144
' Try merging, and then bind again.'))
5145
if b.get_config().has_explicit_nickname():
5146
b.nick = b_other.nick
5149
class cmd_unbind(Command):
5150
__doc__ = """Convert the current checkout into a regular branch.
5152
After unbinding, the local branch is considered independent and subsequent
5153
commits will be local only.
5156
_see_also = ['checkouts', 'bind']
5158
takes_options = ['directory']
5160
def run(self, directory=u'.'):
5161
b, relpath = Branch.open_containing(directory)
5163
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5166
class cmd_uncommit(Command):
5167
__doc__ = """Remove the last committed revision.
5169
--verbose will print out what is being removed.
5170
--dry-run will go through all the motions, but not actually
5173
If --revision is specified, uncommit revisions to leave the branch at the
5174
specified revision. For example, "bzr uncommit -r 15" will leave the
5175
branch at revision 15.
5177
Uncommit leaves the working tree ready for a new commit. The only change
5178
it may make is to restore any pending merges that were present before
5182
# TODO: jam 20060108 Add an option to allow uncommit to remove
5183
# unreferenced information in 'branch-as-repository' branches.
5184
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5185
# information in shared branches as well.
5186
_see_also = ['commit']
5187
takes_options = ['verbose', 'revision',
5188
Option('dry-run', help='Don\'t actually make changes.'),
5189
Option('force', help='Say yes to all questions.'),
5191
help='Keep tags that point to removed revisions.'),
5193
help="Only remove the commits from the local branch"
5194
" when in a checkout."
5197
takes_args = ['location?']
5199
encoding_type = 'replace'
5201
def run(self, location=None, dry_run=False, verbose=False,
5202
revision=None, force=False, local=False, keep_tags=False):
5203
if location is None:
5205
control, relpath = controldir.ControlDir.open_containing(location)
5207
tree = control.open_workingtree()
5209
except (errors.NoWorkingTree, errors.NotLocalUrl):
5211
b = control.open_branch()
5213
if tree is not None:
5214
self.add_cleanup(tree.lock_write().unlock)
5216
self.add_cleanup(b.lock_write().unlock)
5217
return self._run(b, tree, dry_run, verbose, revision, force,
5220
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5222
from bzrlib.log import log_formatter, show_log
5223
from bzrlib.uncommit import uncommit
5225
last_revno, last_rev_id = b.last_revision_info()
5228
if revision is None:
5230
rev_id = last_rev_id
5232
# 'bzr uncommit -r 10' actually means uncommit
5233
# so that the final tree is at revno 10.
5234
# but bzrlib.uncommit.uncommit() actually uncommits
5235
# the revisions that are supplied.
5236
# So we need to offset it by one
5237
revno = revision[0].in_history(b).revno + 1
5238
if revno <= last_revno:
5239
rev_id = b.get_rev_id(revno)
5241
if rev_id is None or _mod_revision.is_null(rev_id):
5242
self.outf.write(gettext('No revisions to uncommit.\n'))
5245
lf = log_formatter('short',
5247
show_timezone='original')
5252
direction='forward',
5253
start_revision=revno,
5254
end_revision=last_revno)
5257
self.outf.write(gettext('Dry-run, pretending to remove'
5258
' the above revisions.\n'))
5260
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5263
if not ui.ui_factory.confirm_action(
5264
gettext(u'Uncommit these revisions'),
5265
'bzrlib.builtins.uncommit',
5267
self.outf.write(gettext('Canceled\n'))
5270
mutter('Uncommitting from {%s} to {%s}',
5271
last_rev_id, rev_id)
5272
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5273
revno=revno, local=local, keep_tags=keep_tags)
5274
self.outf.write(gettext('You can restore the old tip by running:\n'
5275
' bzr pull . -r revid:%s\n') % last_rev_id)
5278
class cmd_break_lock(Command):
5279
__doc__ = """Break a dead lock.
5281
This command breaks a lock on a repository, branch, working directory or
5284
CAUTION: Locks should only be broken when you are sure that the process
5285
holding the lock has been stopped.
5287
You can get information on what locks are open via the 'bzr info
5288
[location]' command.
5292
bzr break-lock bzr+ssh://example.com/bzr/foo
5293
bzr break-lock --conf ~/.bazaar
5296
takes_args = ['location?']
5299
help='LOCATION is the directory where the config lock is.'),
5301
help='Do not ask for confirmation before breaking the lock.'),
5304
def run(self, location=None, config=False, force=False):
5305
if location is None:
5308
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5310
{'bzrlib.lockdir.break': True})
5312
conf = _mod_config.LockableConfig(file_name=location)
5315
control, relpath = controldir.ControlDir.open_containing(location)
5317
control.break_lock()
5318
except NotImplementedError:
5322
class cmd_wait_until_signalled(Command):
5323
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5325
This just prints a line to signal when it is ready, then blocks on stdin.
5331
sys.stdout.write("running\n")
5333
sys.stdin.readline()
5336
class cmd_serve(Command):
5337
__doc__ = """Run the bzr server."""
5339
aliases = ['server']
5343
help='Serve on stdin/out for use from inetd or sshd.'),
5344
RegistryOption('protocol',
5345
help="Protocol to serve.",
5346
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5347
value_switches=True),
5349
help='Listen for connections on nominated port of the form '
5350
'[hostname:]portnumber. Passing 0 as the port number will '
5351
'result in a dynamically allocated port. The default port '
5352
'depends on the protocol.',
5354
custom_help('directory',
5355
help='Serve contents of this directory.'),
5356
Option('allow-writes',
5357
help='By default the server is a readonly server. Supplying '
5358
'--allow-writes enables write access to the contents of '
5359
'the served directory and below. Note that ``bzr serve`` '
5360
'does not perform authentication, so unless some form of '
5361
'external authentication is arranged supplying this '
5362
'option leads to global uncontrolled write access to your '
5365
Option('client-timeout', type=float,
5366
help='Override the default idle client timeout (5min).'),
5369
def get_host_and_port(self, port):
5370
"""Return the host and port to run the smart server on.
5372
If 'port' is None, None will be returned for the host and port.
5374
If 'port' has a colon in it, the string before the colon will be
5375
interpreted as the host.
5377
:param port: A string of the port to run the server on.
5378
:return: A tuple of (host, port), where 'host' is a host name or IP,
5379
and port is an integer TCP/IP port.
5382
if port is not None:
5384
host, port = port.split(':')
5388
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5389
protocol=None, client_timeout=None):
5390
from bzrlib import transport
5391
if directory is None:
5392
directory = os.getcwd()
5393
if protocol is None:
5394
protocol = transport.transport_server_registry.get()
5395
host, port = self.get_host_and_port(port)
5396
url = transport.location_to_url(directory)
5397
if not allow_writes:
5398
url = 'readonly+' + url
5399
t = transport.get_transport_from_url(url)
5401
protocol(t, host, port, inet, client_timeout)
5402
except TypeError, e:
5403
# We use symbol_versioning.deprecated_in just so that people
5404
# grepping can find it here.
5405
# symbol_versioning.deprecated_in((2, 5, 0))
5406
symbol_versioning.warn(
5407
'Got TypeError(%s)\ntrying to call protocol: %s.%s\n'
5408
'Most likely it needs to be updated to support a'
5409
' "timeout" parameter (added in bzr 2.5.0)'
5410
% (e, protocol.__module__, protocol),
5412
protocol(t, host, port, inet)
5415
class cmd_join(Command):
5416
__doc__ = """Combine a tree into its containing tree.
5418
This command requires the target tree to be in a rich-root format.
5420
The TREE argument should be an independent tree, inside another tree, but
5421
not part of it. (Such trees can be produced by "bzr split", but also by
5422
running "bzr branch" with the target inside a tree.)
5424
The result is a combined tree, with the subtree no longer an independent
5425
part. This is marked as a merge of the subtree into the containing tree,
5426
and all history is preserved.
5429
_see_also = ['split']
5430
takes_args = ['tree']
5432
Option('reference', help='Join by reference.', hidden=True),
5435
def run(self, tree, reference=False):
5436
sub_tree = WorkingTree.open(tree)
5437
parent_dir = osutils.dirname(sub_tree.basedir)
5438
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5439
repo = containing_tree.branch.repository
5440
if not repo.supports_rich_root():
5441
raise errors.BzrCommandError(gettext(
5442
"Can't join trees because %s doesn't support rich root data.\n"
5443
"You can use bzr upgrade on the repository.")
5447
containing_tree.add_reference(sub_tree)
5448
except errors.BadReferenceTarget, e:
5449
# XXX: Would be better to just raise a nicely printable
5450
# exception from the real origin. Also below. mbp 20070306
5451
raise errors.BzrCommandError(
5452
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5455
containing_tree.subsume(sub_tree)
5456
except errors.BadSubsumeSource, e:
5457
raise errors.BzrCommandError(
5458
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5461
class cmd_split(Command):
5462
__doc__ = """Split a subdirectory of a tree into a separate tree.
5464
This command will produce a target tree in a format that supports
5465
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5466
converted into earlier formats like 'dirstate-tags'.
5468
The TREE argument should be a subdirectory of a working tree. That
5469
subdirectory will be converted into an independent tree, with its own
5470
branch. Commits in the top-level tree will not apply to the new subtree.
5473
_see_also = ['join']
5474
takes_args = ['tree']
5476
def run(self, tree):
5477
containing_tree, subdir = WorkingTree.open_containing(tree)
5478
sub_id = containing_tree.path2id(subdir)
5480
raise errors.NotVersionedError(subdir)
5482
containing_tree.extract(sub_id)
5483
except errors.RootNotRich:
5484
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5487
class cmd_merge_directive(Command):
5488
__doc__ = """Generate a merge directive for auto-merge tools.
5490
A directive requests a merge to be performed, and also provides all the
5491
information necessary to do so. This means it must either include a
5492
revision bundle, or the location of a branch containing the desired
5495
A submit branch (the location to merge into) must be supplied the first
5496
time the command is issued. After it has been supplied once, it will
5497
be remembered as the default.
5499
A public branch is optional if a revision bundle is supplied, but required
5500
if --diff or --plain is specified. It will be remembered as the default
5501
after the first use.
5504
takes_args = ['submit_branch?', 'public_branch?']
5508
_see_also = ['send']
5512
RegistryOption.from_kwargs('patch-type',
5513
'The type of patch to include in the directive.',
5515
value_switches=True,
5517
bundle='Bazaar revision bundle (default).',
5518
diff='Normal unified diff.',
5519
plain='No patch, just directive.'),
5520
Option('sign', help='GPG-sign the directive.'), 'revision',
5521
Option('mail-to', type=str,
5522
help='Instead of printing the directive, email to this address.'),
5523
Option('message', type=str, short_name='m',
5524
help='Message to use when committing this merge.')
5527
encoding_type = 'exact'
5529
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5530
sign=False, revision=None, mail_to=None, message=None,
5532
from bzrlib.revision import ensure_null, NULL_REVISION
5533
include_patch, include_bundle = {
5534
'plain': (False, False),
5535
'diff': (True, False),
5536
'bundle': (True, True),
5538
branch = Branch.open(directory)
5539
stored_submit_branch = branch.get_submit_branch()
5540
if submit_branch is None:
5541
submit_branch = stored_submit_branch
5543
if stored_submit_branch is None:
5544
branch.set_submit_branch(submit_branch)
5545
if submit_branch is None:
5546
submit_branch = branch.get_parent()
5547
if submit_branch is None:
5548
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5550
stored_public_branch = branch.get_public_branch()
5551
if public_branch is None:
5552
public_branch = stored_public_branch
5553
elif stored_public_branch is None:
5554
branch.set_public_branch(public_branch)
5555
if not include_bundle and public_branch is None:
5556
raise errors.BzrCommandError(gettext('No public branch specified or'
5558
base_revision_id = None
5559
if revision is not None:
5560
if len(revision) > 2:
5561
raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5562
'at most two one revision identifiers'))
5563
revision_id = revision[-1].as_revision_id(branch)
5564
if len(revision) == 2:
5565
base_revision_id = revision[0].as_revision_id(branch)
5567
revision_id = branch.last_revision()
5568
revision_id = ensure_null(revision_id)
5569
if revision_id == NULL_REVISION:
5570
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5571
directive = merge_directive.MergeDirective2.from_objects(
5572
branch.repository, revision_id, time.time(),
5573
osutils.local_time_offset(), submit_branch,
5574
public_branch=public_branch, include_patch=include_patch,
5575
include_bundle=include_bundle, message=message,
5576
base_revision_id=base_revision_id)
5579
self.outf.write(directive.to_signed(branch))
5581
self.outf.writelines(directive.to_lines())
5583
message = directive.to_email(mail_to, branch, sign)
5584
s = SMTPConnection(branch.get_config())
5585
s.send_email(message)
5588
class cmd_send(Command):
5589
__doc__ = """Mail or create a merge-directive for submitting changes.
5591
A merge directive provides many things needed for requesting merges:
5593
* A machine-readable description of the merge to perform
5595
* An optional patch that is a preview of the changes requested
5597
* An optional bundle of revision data, so that the changes can be applied
5598
directly from the merge directive, without retrieving data from a
5601
`bzr send` creates a compact data set that, when applied using bzr
5602
merge, has the same effect as merging from the source branch.
5604
By default the merge directive is self-contained and can be applied to any
5605
branch containing submit_branch in its ancestory without needing access to
5608
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5609
revisions, but only a structured request to merge from the
5610
public_location. In that case the public_branch is needed and it must be
5611
up-to-date and accessible to the recipient. The public_branch is always
5612
included if known, so that people can check it later.
5614
The submit branch defaults to the parent of the source branch, but can be
5615
overridden. Both submit branch and public branch will be remembered in
5616
branch.conf the first time they are used for a particular branch. The
5617
source branch defaults to that containing the working directory, but can
5618
be changed using --from.
5620
Both the submit branch and the public branch follow the usual behavior with
5621
respect to --remember: If there is no default location set, the first send
5622
will set it (use --no-remember to avoid setting it). After that, you can
5623
omit the location to use the default. To change the default, use
5624
--remember. The value will only be saved if the location can be accessed.
5626
In order to calculate those changes, bzr must analyse the submit branch.
5627
Therefore it is most efficient for the submit branch to be a local mirror.
5628
If a public location is known for the submit_branch, that location is used
5629
in the merge directive.
5631
The default behaviour is to send the merge directive by mail, unless -o is
5632
given, in which case it is sent to a file.
5634
Mail is sent using your preferred mail program. This should be transparent
5635
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5636
If the preferred client can't be found (or used), your editor will be used.
5638
To use a specific mail program, set the mail_client configuration option.
5639
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5640
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5641
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5642
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5645
If mail is being sent, a to address is required. This can be supplied
5646
either on the commandline, by setting the submit_to configuration
5647
option in the branch itself or the child_submit_to configuration option
5648
in the submit branch.
5650
Two formats are currently supported: "4" uses revision bundle format 4 and
5651
merge directive format 2. It is significantly faster and smaller than
5652
older formats. It is compatible with Bazaar 0.19 and later. It is the
5653
default. "0.9" uses revision bundle format 0.9 and merge directive
5654
format 1. It is compatible with Bazaar 0.12 - 0.18.
5656
The merge directives created by bzr send may be applied using bzr merge or
5657
bzr pull by specifying a file containing a merge directive as the location.
5659
bzr send makes extensive use of public locations to map local locations into
5660
URLs that can be used by other people. See `bzr help configuration` to
5661
set them, and use `bzr info` to display them.
5664
encoding_type = 'exact'
5666
_see_also = ['merge', 'pull']
5668
takes_args = ['submit_branch?', 'public_branch?']
5672
help='Do not include a bundle in the merge directive.'),
5673
Option('no-patch', help='Do not include a preview patch in the merge'
5676
help='Remember submit and public branch.'),
5678
help='Branch to generate the submission from, '
5679
'rather than the one containing the working directory.',
5682
Option('output', short_name='o',
5683
help='Write merge directive to this file or directory; '
5684
'use - for stdout.',
5687
help='Refuse to send if there are uncommitted changes in'
5688
' the working tree, --no-strict disables the check.'),
5689
Option('mail-to', help='Mail the request to this address.',
5693
Option('body', help='Body for the email.', type=unicode),
5694
RegistryOption('format',
5695
help='Use the specified output format.',
5696
lazy_registry=('bzrlib.send', 'format_registry')),
5699
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5700
no_patch=False, revision=None, remember=None, output=None,
5701
format=None, mail_to=None, message=None, body=None,
5702
strict=None, **kwargs):
5703
from bzrlib.send import send
5704
return send(submit_branch, revision, public_branch, remember,
5705
format, no_bundle, no_patch, output,
5706
kwargs.get('from', '.'), mail_to, message, body,
5711
class cmd_bundle_revisions(cmd_send):
5712
__doc__ = """Create a merge-directive for submitting changes.
5714
A merge directive provides many things needed for requesting merges:
5716
* A machine-readable description of the merge to perform
5718
* An optional patch that is a preview of the changes requested
5720
* An optional bundle of revision data, so that the changes can be applied
5721
directly from the merge directive, without retrieving data from a
5724
If --no-bundle is specified, then public_branch is needed (and must be
5725
up-to-date), so that the receiver can perform the merge using the
5726
public_branch. The public_branch is always included if known, so that
5727
people can check it later.
5729
The submit branch defaults to the parent, but can be overridden. Both
5730
submit branch and public branch will be remembered if supplied.
5732
If a public_branch is known for the submit_branch, that public submit
5733
branch is used in the merge instructions. This means that a local mirror
5734
can be used as your actual submit branch, once you have set public_branch
5737
Two formats are currently supported: "4" uses revision bundle format 4 and
5738
merge directive format 2. It is significantly faster and smaller than
5739
older formats. It is compatible with Bazaar 0.19 and later. It is the
5740
default. "0.9" uses revision bundle format 0.9 and merge directive
5741
format 1. It is compatible with Bazaar 0.12 - 0.18.
5746
help='Do not include a bundle in the merge directive.'),
5747
Option('no-patch', help='Do not include a preview patch in the merge'
5750
help='Remember submit and public branch.'),
5752
help='Branch to generate the submission from, '
5753
'rather than the one containing the working directory.',
5756
Option('output', short_name='o', help='Write directive to this file.',
5759
help='Refuse to bundle revisions if there are uncommitted'
5760
' changes in the working tree, --no-strict disables the check.'),
5762
RegistryOption('format',
5763
help='Use the specified output format.',
5764
lazy_registry=('bzrlib.send', 'format_registry')),
5766
aliases = ['bundle']
5768
_see_also = ['send', 'merge']
5772
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5773
no_patch=False, revision=None, remember=False, output=None,
5774
format=None, strict=None, **kwargs):
5777
from bzrlib.send import send
5778
return send(submit_branch, revision, public_branch, remember,
5779
format, no_bundle, no_patch, output,
5780
kwargs.get('from', '.'), None, None, None,
5781
self.outf, strict=strict)
5784
class cmd_tag(Command):
5785
__doc__ = """Create, remove or modify a tag naming a revision.
5787
Tags give human-meaningful names to revisions. Commands that take a -r
5788
(--revision) option can be given -rtag:X, where X is any previously
5791
Tags are stored in the branch. Tags are copied from one branch to another
5792
along when you branch, push, pull or merge.
5794
It is an error to give a tag name that already exists unless you pass
5795
--force, in which case the tag is moved to point to the new revision.
5797
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5798
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5800
If no tag name is specified it will be determined through the
5801
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5802
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5806
_see_also = ['commit', 'tags']
5807
takes_args = ['tag_name?']
5810
help='Delete this tag rather than placing it.',
5812
custom_help('directory',
5813
help='Branch in which to place the tag.'),
5815
help='Replace existing tags.',
5820
def run(self, tag_name=None,
5826
branch, relpath = Branch.open_containing(directory)
5827
self.add_cleanup(branch.lock_write().unlock)
5829
if tag_name is None:
5830
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5831
branch.tags.delete_tag(tag_name)
5832
note(gettext('Deleted tag %s.') % tag_name)
5835
if len(revision) != 1:
5836
raise errors.BzrCommandError(gettext(
5837
"Tags can only be placed on a single revision, "
5839
revision_id = revision[0].as_revision_id(branch)
5841
revision_id = branch.last_revision()
5842
if tag_name is None:
5843
tag_name = branch.automatic_tag_name(revision_id)
5844
if tag_name is None:
5845
raise errors.BzrCommandError(gettext(
5846
"Please specify a tag name."))
5848
existing_target = branch.tags.lookup_tag(tag_name)
5849
except errors.NoSuchTag:
5850
existing_target = None
5851
if not force and existing_target not in (None, revision_id):
5852
raise errors.TagAlreadyExists(tag_name)
5853
if existing_target == revision_id:
5854
note(gettext('Tag %s already exists for that revision.') % tag_name)
5856
branch.tags.set_tag(tag_name, revision_id)
5857
if existing_target is None:
5858
note(gettext('Created tag %s.') % tag_name)
5860
note(gettext('Updated tag %s.') % tag_name)
5863
class cmd_tags(Command):
5864
__doc__ = """List tags.
5866
This command shows a table of tag names and the revisions they reference.
5871
custom_help('directory',
5872
help='Branch whose tags should be displayed.'),
5873
RegistryOption('sort',
5874
'Sort tags by different criteria.', title='Sorting',
5875
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5882
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5883
from bzrlib.tag import tag_sort_methods
5884
branch, relpath = Branch.open_containing(directory)
5886
tags = branch.tags.get_tag_dict().items()
5890
self.add_cleanup(branch.lock_read().unlock)
5892
# Restrict to the specified range
5893
tags = self._tags_for_range(branch, revision)
5895
sort = tag_sort_methods.get()
5898
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5899
for index, (tag, revid) in enumerate(tags):
5901
revno = branch.revision_id_to_dotted_revno(revid)
5902
if isinstance(revno, tuple):
5903
revno = '.'.join(map(str, revno))
5904
except (errors.NoSuchRevision,
5905
errors.GhostRevisionsHaveNoRevno,
5906
errors.UnsupportedOperation):
5907
# Bad tag data/merges can lead to tagged revisions
5908
# which are not in this branch. Fail gracefully ...
5910
tags[index] = (tag, revno)
5912
for tag, revspec in tags:
5913
self.outf.write('%-20s %s\n' % (tag, revspec))
5915
def _tags_for_range(self, branch, revision):
5917
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5918
revid1, revid2 = rev1.rev_id, rev2.rev_id
5919
# _get_revision_range will always set revid2 if it's not specified.
5920
# If revid1 is None, it means we want to start from the branch
5921
# origin which is always a valid ancestor. If revid1 == revid2, the
5922
# ancestry check is useless.
5923
if revid1 and revid1 != revid2:
5924
# FIXME: We really want to use the same graph than
5925
# branch.iter_merge_sorted_revisions below, but this is not
5926
# easily available -- vila 2011-09-23
5927
if branch.repository.get_graph().is_ancestor(revid2, revid1):
5928
# We don't want to output anything in this case...
5930
# only show revisions between revid1 and revid2 (inclusive)
5931
tagged_revids = branch.tags.get_reverse_tag_dict()
5933
for r in branch.iter_merge_sorted_revisions(
5934
start_revision_id=revid2, stop_revision_id=revid1,
5935
stop_rule='include'):
5936
revid_tags = tagged_revids.get(r[0], None)
5938
found.extend([(tag, r[0]) for tag in revid_tags])
5942
class cmd_reconfigure(Command):
5943
__doc__ = """Reconfigure the type of a bzr directory.
5945
A target configuration must be specified.
5947
For checkouts, the bind-to location will be auto-detected if not specified.
5948
The order of preference is
5949
1. For a lightweight checkout, the current bound location.
5950
2. For branches that used to be checkouts, the previously-bound location.
5951
3. The push location.
5952
4. The parent location.
5953
If none of these is available, --bind-to must be specified.
5956
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5957
takes_args = ['location?']
5959
RegistryOption.from_kwargs(
5962
help='The relation between branch and tree.',
5963
value_switches=True, enum_switch=False,
5964
branch='Reconfigure to be an unbound branch with no working tree.',
5965
tree='Reconfigure to be an unbound branch with a working tree.',
5966
checkout='Reconfigure to be a bound branch with a working tree.',
5967
lightweight_checkout='Reconfigure to be a lightweight'
5968
' checkout (with no local history).',
5970
RegistryOption.from_kwargs(
5972
title='Repository type',
5973
help='Location fo the repository.',
5974
value_switches=True, enum_switch=False,
5975
standalone='Reconfigure to be a standalone branch '
5976
'(i.e. stop using shared repository).',
5977
use_shared='Reconfigure to use a shared repository.',
5979
RegistryOption.from_kwargs(
5981
title='Trees in Repository',
5982
help='Whether new branches in the repository have trees.',
5983
value_switches=True, enum_switch=False,
5984
with_trees='Reconfigure repository to create '
5985
'working trees on branches by default.',
5986
with_no_trees='Reconfigure repository to not create '
5987
'working trees on branches by default.'
5989
Option('bind-to', help='Branch to bind checkout to.', type=str),
5991
help='Perform reconfiguration even if local changes'
5993
Option('stacked-on',
5994
help='Reconfigure a branch to be stacked on another branch.',
5998
help='Reconfigure a branch to be unstacked. This '
5999
'may require copying substantial data into it.',
6003
def run(self, location=None, bind_to=None, force=False,
6004
tree_type=None, repository_type=None, repository_trees=None,
6005
stacked_on=None, unstacked=None):
6006
directory = controldir.ControlDir.open(location)
6007
if stacked_on and unstacked:
6008
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6009
elif stacked_on is not None:
6010
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6012
reconfigure.ReconfigureUnstacked().apply(directory)
6013
# At the moment you can use --stacked-on and a different
6014
# reconfiguration shape at the same time; there seems no good reason
6016
if (tree_type is None and
6017
repository_type is None and
6018
repository_trees is None):
6019
if stacked_on or unstacked:
6022
raise errors.BzrCommandError(gettext('No target configuration '
6024
reconfiguration = None
6025
if tree_type == 'branch':
6026
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6027
elif tree_type == 'tree':
6028
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6029
elif tree_type == 'checkout':
6030
reconfiguration = reconfigure.Reconfigure.to_checkout(
6032
elif tree_type == 'lightweight-checkout':
6033
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6036
reconfiguration.apply(force)
6037
reconfiguration = None
6038
if repository_type == 'use-shared':
6039
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6040
elif repository_type == 'standalone':
6041
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6043
reconfiguration.apply(force)
6044
reconfiguration = None
6045
if repository_trees == 'with-trees':
6046
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6048
elif repository_trees == 'with-no-trees':
6049
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6052
reconfiguration.apply(force)
6053
reconfiguration = None
6056
class cmd_switch(Command):
6057
__doc__ = """Set the branch of a checkout and update.
6059
For lightweight checkouts, this changes the branch being referenced.
6060
For heavyweight checkouts, this checks that there are no local commits
6061
versus the current bound branch, then it makes the local branch a mirror
6062
of the new location and binds to it.
6064
In both cases, the working tree is updated and uncommitted changes
6065
are merged. The user can commit or revert these as they desire.
6067
Pending merges need to be committed or reverted before using switch.
6069
The path to the branch to switch to can be specified relative to the parent
6070
directory of the current branch. For example, if you are currently in a
6071
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6074
Bound branches use the nickname of its master branch unless it is set
6075
locally, in which case switching will update the local nickname to be
6079
takes_args = ['to_location?']
6080
takes_options = ['directory',
6082
help='Switch even if local commits will be lost.'),
6084
Option('create-branch', short_name='b',
6085
help='Create the target branch from this one before'
6086
' switching to it.'),
6089
def run(self, to_location=None, force=False, create_branch=False,
6090
revision=None, directory=u'.'):
6091
from bzrlib import switch
6092
tree_location = directory
6093
revision = _get_one_revision('switch', revision)
6094
control_dir = controldir.ControlDir.open_containing(tree_location)[0]
6095
if to_location is None:
6096
if revision is None:
6097
raise errors.BzrCommandError(gettext('You must supply either a'
6098
' revision or a location'))
6099
to_location = tree_location
6101
branch = control_dir.open_branch()
6102
had_explicit_nick = branch.get_config().has_explicit_nickname()
6103
except errors.NotBranchError:
6105
had_explicit_nick = False
6108
raise errors.BzrCommandError(gettext('cannot create branch without'
6110
to_location = directory_service.directories.dereference(
6112
if '/' not in to_location and '\\' not in to_location:
6113
# This path is meant to be relative to the existing branch
6114
this_url = self._get_branch_location(control_dir)
6115
# Perhaps the target control dir supports colocated branches?
6117
root = controldir.ControlDir.open(this_url,
6118
possible_transports=[control_dir.user_transport])
6119
except errors.NotBranchError:
6122
colocated = root._format.colocated_branches
6124
to_location = urlutils.join_segment_parameters(this_url,
6125
{"branch": urlutils.escape(to_location)})
6127
to_location = urlutils.join(
6128
this_url, '..', urlutils.escape(to_location))
6129
to_branch = branch.bzrdir.sprout(to_location,
6130
possible_transports=[branch.bzrdir.root_transport],
6131
source_branch=branch).open_branch()
6133
# Perhaps it's a colocated branch?
6135
to_branch = control_dir.open_branch(to_location)
6136
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
6138
to_branch = Branch.open(to_location)
6139
except errors.NotBranchError:
6140
this_url = self._get_branch_location(control_dir)
6141
to_branch = Branch.open(
6143
this_url, '..', urlutils.escape(to_location)))
6144
if revision is not None:
6145
revision = revision.as_revision_id(to_branch)
6146
switch.switch(control_dir, to_branch, force, revision_id=revision)
6147
if had_explicit_nick:
6148
branch = control_dir.open_branch() #get the new branch!
6149
branch.nick = to_branch.nick
6150
note(gettext('Switched to branch: %s'),
6151
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6153
def _get_branch_location(self, control_dir):
6154
"""Return location of branch for this control dir."""
6156
this_branch = control_dir.open_branch()
6157
# This may be a heavy checkout, where we want the master branch
6158
master_location = this_branch.get_bound_location()
6159
if master_location is not None:
6160
return master_location
6161
# If not, use a local sibling
6162
return this_branch.base
6163
except errors.NotBranchError:
6164
format = control_dir.find_branch_format()
6165
if getattr(format, 'get_reference', None) is not None:
6166
return format.get_reference(control_dir)
6168
return control_dir.root_transport.base
6171
class cmd_view(Command):
6172
__doc__ = """Manage filtered views.
6174
Views provide a mask over the tree so that users can focus on
6175
a subset of a tree when doing their work. After creating a view,
6176
commands that support a list of files - status, diff, commit, etc -
6177
effectively have that list of files implicitly given each time.
6178
An explicit list of files can still be given but those files
6179
must be within the current view.
6181
In most cases, a view has a short life-span: it is created to make
6182
a selected change and is deleted once that change is committed.
6183
At other times, you may wish to create one or more named views
6184
and switch between them.
6186
To disable the current view without deleting it, you can switch to
6187
the pseudo view called ``off``. This can be useful when you need
6188
to see the whole tree for an operation or two (e.g. merge) but
6189
want to switch back to your view after that.
6192
To define the current view::
6194
bzr view file1 dir1 ...
6196
To list the current view::
6200
To delete the current view::
6204
To disable the current view without deleting it::
6206
bzr view --switch off
6208
To define a named view and switch to it::
6210
bzr view --name view-name file1 dir1 ...
6212
To list a named view::
6214
bzr view --name view-name
6216
To delete a named view::
6218
bzr view --name view-name --delete
6220
To switch to a named view::
6222
bzr view --switch view-name
6224
To list all views defined::
6228
To delete all views::
6230
bzr view --delete --all
6234
takes_args = ['file*']
6237
help='Apply list or delete action to all views.',
6240
help='Delete the view.',
6243
help='Name of the view to define, list or delete.',
6247
help='Name of the view to switch to.',
6252
def run(self, file_list,
6258
tree, file_list = WorkingTree.open_containing_paths(file_list,
6260
current_view, view_dict = tree.views.get_view_info()
6265
raise errors.BzrCommandError(gettext(
6266
"Both --delete and a file list specified"))
6268
raise errors.BzrCommandError(gettext(
6269
"Both --delete and --switch specified"))
6271
tree.views.set_view_info(None, {})
6272
self.outf.write(gettext("Deleted all views.\n"))
6274
raise errors.BzrCommandError(gettext("No current view to delete"))
6276
tree.views.delete_view(name)
6277
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6280
raise errors.BzrCommandError(gettext(
6281
"Both --switch and a file list specified"))
6283
raise errors.BzrCommandError(gettext(
6284
"Both --switch and --all specified"))
6285
elif switch == 'off':
6286
if current_view is None:
6287
raise errors.BzrCommandError(gettext("No current view to disable"))
6288
tree.views.set_view_info(None, view_dict)
6289
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6291
tree.views.set_view_info(switch, view_dict)
6292
view_str = views.view_display_str(tree.views.lookup_view())
6293
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6296
self.outf.write(gettext('Views defined:\n'))
6297
for view in sorted(view_dict):
6298
if view == current_view:
6302
view_str = views.view_display_str(view_dict[view])
6303
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6305
self.outf.write(gettext('No views defined.\n'))
6308
# No name given and no current view set
6311
raise errors.BzrCommandError(gettext(
6312
"Cannot change the 'off' pseudo view"))
6313
tree.views.set_view(name, sorted(file_list))
6314
view_str = views.view_display_str(tree.views.lookup_view())
6315
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6319
# No name given and no current view set
6320
self.outf.write(gettext('No current view.\n'))
6322
view_str = views.view_display_str(tree.views.lookup_view(name))
6323
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6326
class cmd_hooks(Command):
6327
__doc__ = """Show hooks."""
6332
for hook_key in sorted(hooks.known_hooks.keys()):
6333
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6334
self.outf.write("%s:\n" % type(some_hooks).__name__)
6335
for hook_name, hook_point in sorted(some_hooks.items()):
6336
self.outf.write(" %s:\n" % (hook_name,))
6337
found_hooks = list(hook_point)
6339
for hook in found_hooks:
6340
self.outf.write(" %s\n" %
6341
(some_hooks.get_hook_name(hook),))
6343
self.outf.write(gettext(" <no hooks installed>\n"))
6346
class cmd_remove_branch(Command):
6347
__doc__ = """Remove a branch.
6349
This will remove the branch from the specified location but
6350
will keep any working tree or repository in place.
6354
Remove the branch at repo/trunk::
6356
bzr remove-branch repo/trunk
6360
takes_args = ["location?"]
6362
aliases = ["rmbranch"]
6364
def run(self, location=None):
6365
if location is None:
6367
branch = Branch.open_containing(location)[0]
6368
branch.bzrdir.destroy_branch()
6371
class cmd_shelve(Command):
6372
__doc__ = """Temporarily set aside some changes from the current tree.
6374
Shelve allows you to temporarily put changes you've made "on the shelf",
6375
ie. out of the way, until a later time when you can bring them back from
6376
the shelf with the 'unshelve' command. The changes are stored alongside
6377
your working tree, and so they aren't propagated along with your branch nor
6378
will they survive its deletion.
6380
If shelve --list is specified, previously-shelved changes are listed.
6382
Shelve is intended to help separate several sets of changes that have
6383
been inappropriately mingled. If you just want to get rid of all changes
6384
and you don't need to restore them later, use revert. If you want to
6385
shelve all text changes at once, use shelve --all.
6387
If filenames are specified, only the changes to those files will be
6388
shelved. Other files will be left untouched.
6390
If a revision is specified, changes since that revision will be shelved.
6392
You can put multiple items on the shelf, and by default, 'unshelve' will
6393
restore the most recently shelved changes.
6395
For complicated changes, it is possible to edit the changes in a separate
6396
editor program to decide what the file remaining in the working copy
6397
should look like. To do this, add the configuration option
6399
change_editor = PROGRAM @new_path @old_path
6401
where @new_path is replaced with the path of the new version of the
6402
file and @old_path is replaced with the path of the old version of
6403
the file. The PROGRAM should save the new file with the desired
6404
contents of the file in the working tree.
6408
takes_args = ['file*']
6413
Option('all', help='Shelve all changes.'),
6415
RegistryOption('writer', 'Method to use for writing diffs.',
6416
bzrlib.option.diff_writer_registry,
6417
value_switches=True, enum_switch=False),
6419
Option('list', help='List shelved changes.'),
6421
help='Destroy removed changes instead of shelving them.'),
6423
_see_also = ['unshelve', 'configuration']
6425
def run(self, revision=None, all=False, file_list=None, message=None,
6426
writer=None, list=False, destroy=False, directory=None):
6428
return self.run_for_list(directory=directory)
6429
from bzrlib.shelf_ui import Shelver
6431
writer = bzrlib.option.diff_writer_registry.get()
6433
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6434
file_list, message, destroy=destroy, directory=directory)
6439
except errors.UserAbort:
6442
def run_for_list(self, directory=None):
6443
if directory is None:
6445
tree = WorkingTree.open_containing(directory)[0]
6446
self.add_cleanup(tree.lock_read().unlock)
6447
manager = tree.get_shelf_manager()
6448
shelves = manager.active_shelves()
6449
if len(shelves) == 0:
6450
note(gettext('No shelved changes.'))
6452
for shelf_id in reversed(shelves):
6453
message = manager.get_metadata(shelf_id).get('message')
6455
message = '<no message>'
6456
self.outf.write('%3d: %s\n' % (shelf_id, message))
6460
class cmd_unshelve(Command):
6461
__doc__ = """Restore shelved changes.
6463
By default, the most recently shelved changes are restored. However if you
6464
specify a shelf by id those changes will be restored instead. This works
6465
best when the changes don't depend on each other.
6468
takes_args = ['shelf_id?']
6471
RegistryOption.from_kwargs(
6472
'action', help="The action to perform.",
6473
enum_switch=False, value_switches=True,
6474
apply="Apply changes and remove from the shelf.",
6475
dry_run="Show changes, but do not apply or remove them.",
6476
preview="Instead of unshelving the changes, show the diff that "
6477
"would result from unshelving.",
6478
delete_only="Delete changes without applying them.",
6479
keep="Apply changes but don't delete them.",
6482
_see_also = ['shelve']
6484
def run(self, shelf_id=None, action='apply', directory=u'.'):
6485
from bzrlib.shelf_ui import Unshelver
6486
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6490
unshelver.tree.unlock()
6493
class cmd_clean_tree(Command):
6494
__doc__ = """Remove unwanted files from working tree.
6496
By default, only unknown files, not ignored files, are deleted. Versioned
6497
files are never deleted.
6499
Another class is 'detritus', which includes files emitted by bzr during
6500
normal operations and selftests. (The value of these files decreases with
6503
If no options are specified, unknown files are deleted. Otherwise, option
6504
flags are respected, and may be combined.
6506
To check what clean-tree will do, use --dry-run.
6508
takes_options = ['directory',
6509
Option('ignored', help='Delete all ignored files.'),
6510
Option('detritus', help='Delete conflict files, merge and revert'
6511
' backups, and failed selftest dirs.'),
6513
help='Delete files unknown to bzr (default).'),
6514
Option('dry-run', help='Show files to delete instead of'
6516
Option('force', help='Do not prompt before deleting.')]
6517
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6518
force=False, directory=u'.'):
6519
from bzrlib.clean_tree import clean_tree
6520
if not (unknown or ignored or detritus):
6524
clean_tree(directory, unknown=unknown, ignored=ignored,
6525
detritus=detritus, dry_run=dry_run, no_prompt=force)
6528
class cmd_reference(Command):
6529
__doc__ = """list, view and set branch locations for nested trees.
6531
If no arguments are provided, lists the branch locations for nested trees.
6532
If one argument is provided, display the branch location for that tree.
6533
If two arguments are provided, set the branch location for that tree.
6538
takes_args = ['path?', 'location?']
6540
def run(self, path=None, location=None):
6542
if path is not None:
6544
tree, branch, relpath =(
6545
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6546
if path is not None:
6549
tree = branch.basis_tree()
6551
info = branch._get_all_reference_info().iteritems()
6552
self._display_reference_info(tree, branch, info)
6554
file_id = tree.path2id(path)
6556
raise errors.NotVersionedError(path)
6557
if location is None:
6558
info = [(file_id, branch.get_reference_info(file_id))]
6559
self._display_reference_info(tree, branch, info)
6561
branch.set_reference_info(file_id, path, location)
6563
def _display_reference_info(self, tree, branch, info):
6565
for file_id, (path, location) in info:
6567
path = tree.id2path(file_id)
6568
except errors.NoSuchId:
6570
ref_list.append((path, location))
6571
for path, location in sorted(ref_list):
6572
self.outf.write('%s %s\n' % (path, location))
6575
class cmd_export_pot(Command):
6576
__doc__ = """Export command helps and error messages in po format."""
6579
takes_options = [Option('plugin',
6580
help='Export help text from named command '\
6581
'(defaults to all built in commands).',
6583
Option('include-duplicates',
6584
help='Output multiple copies of the same msgid '
6585
'string if it appears more than once.'),
6588
def run(self, plugin=None, include_duplicates=False):
6589
from bzrlib.export_pot import export_pot
6590
export_pot(self.outf, plugin, include_duplicates)
6593
def _register_lazy_builtins():
6594
# register lazy builtins from other modules; called at startup and should
6595
# be only called once.
6596
for (name, aliases, module_name) in [
6597
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6598
('cmd_config', [], 'bzrlib.config'),
6599
('cmd_dpush', [], 'bzrlib.foreign'),
6600
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6601
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6602
('cmd_conflicts', [], 'bzrlib.conflicts'),
6603
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6604
('cmd_verify_signatures', [],
6605
'bzrlib.commit_signature_commands'),
6606
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6608
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
