1
# Copyright (C) 2005-2012 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
19
from __future__ import absolute_import
25
from bzrlib import lazy_import
26
lazy_import.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.lock_write()
1123
# FIXME: This shouldn't be done before the pull
1124
# succeeds... -- vila 2012-01-02
1125
branch_to.set_parent(branch_from.base)
1129
if revision is not None:
1130
revision_id = revision.as_revision_id(branch_from)
1132
if tree_to is not None:
1133
view_info = _get_view_info_for_change_reporter(tree_to)
1134
change_reporter = delta._ChangeReporter(
1135
unversioned_filter=tree_to.is_ignored,
1136
view_info=view_info)
1137
result = tree_to.pull(
1138
branch_from, overwrite, revision_id, change_reporter,
1139
local=local, show_base=show_base)
1141
result = branch_to.pull(
1142
branch_from, overwrite, revision_id, local=local)
1144
result.report(self.outf)
1145
if verbose and result.old_revid != result.new_revid:
1146
log.show_branch_change(
1147
branch_to, self.outf, result.old_revno,
1149
if getattr(result, 'tag_conflicts', None):
1155
class cmd_push(Command):
1156
__doc__ = """Update a mirror of this branch.
1158
The target branch will not have its working tree populated because this
1159
is both expensive, and is not supported on remote file systems.
1161
Some smart servers or protocols *may* put the working tree in place in
1164
This command only works on branches that have not diverged. Branches are
1165
considered diverged if the destination branch's most recent commit is one
1166
that has not been merged (directly or indirectly) by the source branch.
1168
If branches have diverged, you can use 'bzr push --overwrite' to replace
1169
the other branch completely, discarding its unmerged changes.
1171
If you want to ensure you have the different changes in the other branch,
1172
do a merge (see bzr help merge) from the other branch, and commit that.
1173
After that you will be able to do a push without '--overwrite'.
1175
If there is no default push location set, the first push will set it (use
1176
--no-remember to avoid setting it). After that, you can omit the
1177
location to use the default. To change the default, use --remember. The
1178
value will only be saved if the remote location can be accessed.
1180
The --verbose option will display the revisions pushed using the log_format
1181
configuration option. You can use a different format by overriding it with
1182
-Olog_format=<other_format>.
1185
_see_also = ['pull', 'update', 'working-trees']
1186
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1187
Option('create-prefix',
1188
help='Create the path leading up to the branch '
1189
'if it does not already exist.'),
1190
custom_help('directory',
1191
help='Branch to push from, '
1192
'rather than the one containing the working directory.'),
1193
Option('use-existing-dir',
1194
help='By default push will fail if the target'
1195
' directory exists, but does not already'
1196
' have a control directory. This flag will'
1197
' allow push to proceed.'),
1199
help='Create a stacked branch that references the public location '
1200
'of the parent branch.'),
1201
Option('stacked-on',
1202
help='Create a stacked branch that refers to another branch '
1203
'for the commit history. Only the work not present in the '
1204
'referenced branch is included in the branch created.',
1207
help='Refuse to push if there are uncommitted changes in'
1208
' the working tree, --no-strict disables the check.'),
1210
help="Don't populate the working tree, even for protocols"
1211
" that support it."),
1213
takes_args = ['location?']
1214
encoding_type = 'replace'
1216
def run(self, location=None, remember=None, overwrite=False,
1217
create_prefix=False, verbose=False, revision=None,
1218
use_existing_dir=False, directory=None, stacked_on=None,
1219
stacked=False, strict=None, no_tree=False):
1220
from bzrlib.push import _show_push_branch
1222
if directory is None:
1224
# Get the source branch
1226
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1227
# Get the tip's revision_id
1228
revision = _get_one_revision('push', revision)
1229
if revision is not None:
1230
revision_id = revision.in_history(br_from).rev_id
1233
if tree is not None and revision_id is None:
1234
tree.check_changed_or_out_of_date(
1235
strict, 'push_strict',
1236
more_error='Use --no-strict to force the push.',
1237
more_warning='Uncommitted changes will not be pushed.')
1238
# Get the stacked_on branch, if any
1239
if stacked_on is not None:
1240
stacked_on = urlutils.normalize_url(stacked_on)
1242
parent_url = br_from.get_parent()
1244
parent = Branch.open(parent_url)
1245
stacked_on = parent.get_public_branch()
1247
# I considered excluding non-http url's here, thus forcing
1248
# 'public' branches only, but that only works for some
1249
# users, so it's best to just depend on the user spotting an
1250
# error by the feedback given to them. RBC 20080227.
1251
stacked_on = parent_url
1253
raise errors.BzrCommandError(gettext(
1254
"Could not determine branch to refer to."))
1256
# Get the destination location
1257
if location is None:
1258
stored_loc = br_from.get_push_location()
1259
if stored_loc is None:
1260
parent_loc = br_from.get_parent()
1262
raise errors.BzrCommandError(gettext(
1263
"No push location known or specified. To push to the "
1264
"parent branch (at %s), use 'bzr push :parent'." %
1265
urlutils.unescape_for_display(parent_loc,
1266
self.outf.encoding)))
1268
raise errors.BzrCommandError(gettext(
1269
"No push location known or specified."))
1271
display_url = urlutils.unescape_for_display(stored_loc,
1273
note(gettext("Using saved push location: %s") % display_url)
1274
location = stored_loc
1276
_show_push_branch(br_from, revision_id, location, self.outf,
1277
verbose=verbose, overwrite=overwrite, remember=remember,
1278
stacked_on=stacked_on, create_prefix=create_prefix,
1279
use_existing_dir=use_existing_dir, no_tree=no_tree)
1282
class cmd_branch(Command):
1283
__doc__ = """Create a new branch that is a copy of an existing branch.
1285
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1286
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1287
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1288
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1289
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1292
To retrieve the branch as of a particular revision, supply the --revision
1293
parameter, as in "branch foo/bar -r 5".
1295
The synonyms 'clone' and 'get' for this command are deprecated.
1298
_see_also = ['checkout']
1299
takes_args = ['from_location', 'to_location?']
1300
takes_options = ['revision',
1301
Option('hardlink', help='Hard-link working tree files where possible.'),
1302
Option('files-from', type=str,
1303
help="Get file contents from this tree."),
1305
help="Create a branch without a working-tree."),
1307
help="Switch the checkout in the current directory "
1308
"to the new branch."),
1310
help='Create a stacked branch referring to the source branch. '
1311
'The new branch will depend on the availability of the source '
1312
'branch for all operations.'),
1313
Option('standalone',
1314
help='Do not use a shared repository, even if available.'),
1315
Option('use-existing-dir',
1316
help='By default branch will fail if the target'
1317
' directory exists, but does not already'
1318
' have a control directory. This flag will'
1319
' allow branch to proceed.'),
1321
help="Bind new branch to from location."),
1323
aliases = ['get', 'clone']
1325
def run(self, from_location, to_location=None, revision=None,
1326
hardlink=False, stacked=False, standalone=False, no_tree=False,
1327
use_existing_dir=False, switch=False, bind=False,
1329
from bzrlib import switch as _mod_switch
1330
from bzrlib.tag import _merge_tags_if_possible
1331
if self.invoked_as in ['get', 'clone']:
1332
ui.ui_factory.show_user_warning(
1333
'deprecated_command',
1334
deprecated_name=self.invoked_as,
1335
recommended_name='branch',
1336
deprecated_in_version='2.4')
1337
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1339
if not (hardlink or files_from):
1340
# accelerator_tree is usually slower because you have to read N
1341
# files (no readahead, lots of seeks, etc), but allow the user to
1342
# explicitly request it
1343
accelerator_tree = None
1344
if files_from is not None and files_from != from_location:
1345
accelerator_tree = WorkingTree.open(files_from)
1346
revision = _get_one_revision('branch', revision)
1347
self.add_cleanup(br_from.lock_read().unlock)
1348
if revision is not None:
1349
revision_id = revision.as_revision_id(br_from)
1351
# FIXME - wt.last_revision, fallback to branch, fall back to
1352
# None or perhaps NULL_REVISION to mean copy nothing
1354
revision_id = br_from.last_revision()
1355
if to_location is None:
1356
to_location = getattr(br_from, "name", None)
1357
if to_location is None:
1358
to_location = urlutils.derive_to_location(from_location)
1359
to_transport = transport.get_transport(to_location)
1361
to_transport.mkdir('.')
1362
except errors.FileExists:
1364
to_dir = controldir.ControlDir.open_from_transport(
1366
except errors.NotBranchError:
1367
if not use_existing_dir:
1368
raise errors.BzrCommandError(gettext('Target directory "%s" '
1369
'already exists.') % to_location)
1374
to_dir.open_branch()
1375
except errors.NotBranchError:
1378
raise errors.AlreadyBranchError(to_location)
1379
except errors.NoSuchFile:
1380
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1386
# preserve whatever source format we have.
1387
to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1388
possible_transports=[to_transport],
1389
accelerator_tree=accelerator_tree,
1390
hardlink=hardlink, stacked=stacked,
1391
force_new_repo=standalone,
1392
create_tree_if_local=not no_tree,
1393
source_branch=br_from)
1394
branch = to_dir.open_branch(
1395
possible_transports=[
1396
br_from.bzrdir.root_transport, to_transport])
1397
except errors.NoSuchRevision:
1398
to_transport.delete_tree('.')
1399
msg = gettext("The branch {0} has no revision {1}.").format(
1400
from_location, revision)
1401
raise errors.BzrCommandError(msg)
1403
branch = br_from.sprout(to_dir, revision_id=revision_id)
1404
_merge_tags_if_possible(br_from, branch)
1405
# If the source branch is stacked, the new branch may
1406
# be stacked whether we asked for that explicitly or not.
1407
# We therefore need a try/except here and not just 'if stacked:'
1409
note(gettext('Created new stacked branch referring to %s.') %
1410
branch.get_stacked_on_url())
1411
except (errors.NotStacked, errors.UnstackableBranchFormat,
1412
errors.UnstackableRepositoryFormat), e:
1413
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1415
# Bind to the parent
1416
parent_branch = Branch.open(from_location)
1417
branch.bind(parent_branch)
1418
note(gettext('New branch bound to %s') % from_location)
1420
# Switch to the new branch
1421
wt, _ = WorkingTree.open_containing('.')
1422
_mod_switch.switch(wt.bzrdir, branch)
1423
note(gettext('Switched to branch: %s'),
1424
urlutils.unescape_for_display(branch.base, 'utf-8'))
1427
class cmd_branches(Command):
1428
__doc__ = """List the branches available at the current location.
1430
This command will print the names of all the branches at the current
1434
takes_args = ['location?']
1436
Option('recursive', short_name='R',
1437
help='Recursively scan for branches rather than '
1438
'just looking in the specified location.')]
1440
def run(self, location=".", recursive=False):
1442
t = transport.get_transport(location)
1443
if not t.listable():
1444
raise errors.BzrCommandError(
1445
"Can't scan this type of location.")
1446
for b in controldir.ControlDir.find_branches(t):
1447
self.outf.write("%s\n" % urlutils.unescape_for_display(
1448
urlutils.relative_url(t.base, b.base),
1449
self.outf.encoding).rstrip("/"))
1451
dir = controldir.ControlDir.open_containing(location)[0]
1453
active_branch = dir.open_branch(name=None)
1454
except errors.NotBranchError:
1455
active_branch = None
1456
branches = dir.get_branches()
1458
for name, branch in branches.iteritems():
1461
active = (active_branch is not None and
1462
active_branch.base == branch.base)
1463
names[name] = active
1464
# Only mention the current branch explicitly if it's not
1465
# one of the colocated branches
1466
if not any(names.values()) and active_branch is not None:
1467
self.outf.write("* %s\n" % gettext("(default)"))
1468
for name in sorted(names.keys()):
1469
active = names[name]
1474
self.outf.write("%s %s\n" % (
1475
prefix, name.encode(self.outf.encoding)))
1478
class cmd_checkout(Command):
1479
__doc__ = """Create a new checkout of an existing branch.
1481
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1482
the branch found in '.'. This is useful if you have removed the working tree
1483
or if it was never created - i.e. if you pushed the branch to its current
1484
location using SFTP.
1486
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1487
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1488
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1489
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1490
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1493
To retrieve the branch as of a particular revision, supply the --revision
1494
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1495
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1499
_see_also = ['checkouts', 'branch']
1500
takes_args = ['branch_location?', 'to_location?']
1501
takes_options = ['revision',
1502
Option('lightweight',
1503
help="Perform a lightweight checkout. Lightweight "
1504
"checkouts depend on access to the branch for "
1505
"every operation. Normal checkouts can perform "
1506
"common operations like diff and status without "
1507
"such access, and also support local commits."
1509
Option('files-from', type=str,
1510
help="Get file contents from this tree."),
1512
help='Hard-link working tree files where possible.'
1517
def run(self, branch_location=None, to_location=None, revision=None,
1518
lightweight=False, files_from=None, hardlink=False):
1519
if branch_location is None:
1520
branch_location = osutils.getcwd()
1521
to_location = branch_location
1522
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1524
if not (hardlink or files_from):
1525
# accelerator_tree is usually slower because you have to read N
1526
# files (no readahead, lots of seeks, etc), but allow the user to
1527
# explicitly request it
1528
accelerator_tree = None
1529
revision = _get_one_revision('checkout', revision)
1530
if files_from is not None and files_from != branch_location:
1531
accelerator_tree = WorkingTree.open(files_from)
1532
if revision is not None:
1533
revision_id = revision.as_revision_id(source)
1536
if to_location is None:
1537
to_location = urlutils.derive_to_location(branch_location)
1538
# if the source and to_location are the same,
1539
# and there is no working tree,
1540
# then reconstitute a branch
1541
if (osutils.abspath(to_location) ==
1542
osutils.abspath(branch_location)):
1544
source.bzrdir.open_workingtree()
1545
except errors.NoWorkingTree:
1546
source.bzrdir.create_workingtree(revision_id)
1548
source.create_checkout(to_location, revision_id, lightweight,
1549
accelerator_tree, hardlink)
1552
class cmd_renames(Command):
1553
__doc__ = """Show list of renamed files.
1555
# TODO: Option to show renames between two historical versions.
1557
# TODO: Only show renames under dir, rather than in the whole branch.
1558
_see_also = ['status']
1559
takes_args = ['dir?']
1562
def run(self, dir=u'.'):
1563
tree = WorkingTree.open_containing(dir)[0]
1564
self.add_cleanup(tree.lock_read().unlock)
1565
new_inv = tree.inventory
1566
old_tree = tree.basis_tree()
1567
self.add_cleanup(old_tree.lock_read().unlock)
1568
old_inv = old_tree.inventory
1570
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1571
for f, paths, c, v, p, n, k, e in iterator:
1572
if paths[0] == paths[1]:
1576
renames.append(paths)
1578
for old_name, new_name in renames:
1579
self.outf.write("%s => %s\n" % (old_name, new_name))
1582
class cmd_update(Command):
1583
__doc__ = """Update a working tree to a new revision.
1585
This will perform a merge of the destination revision (the tip of the
1586
branch, or the specified revision) into the working tree, and then make
1587
that revision the basis revision for the working tree.
1589
You can use this to visit an older revision, or to update a working tree
1590
that is out of date from its branch.
1592
If there are any uncommitted changes in the tree, they will be carried
1593
across and remain as uncommitted changes after the update. To discard
1594
these changes, use 'bzr revert'. The uncommitted changes may conflict
1595
with the changes brought in by the change in basis revision.
1597
If the tree's branch is bound to a master branch, bzr will also update
1598
the branch from the master.
1600
You cannot update just a single file or directory, because each Bazaar
1601
working tree has just a single basis revision. If you want to restore a
1602
file that has been removed locally, use 'bzr revert' instead of 'bzr
1603
update'. If you want to restore a file to its state in a previous
1604
revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
1605
out the old content of that file to a new location.
1607
The 'dir' argument, if given, must be the location of the root of a
1608
working tree to update. By default, the working tree that contains the
1609
current working directory is used.
1612
_see_also = ['pull', 'working-trees', 'status-flags']
1613
takes_args = ['dir?']
1614
takes_options = ['revision',
1616
help="Show base revision text in conflicts."),
1620
def run(self, dir=None, revision=None, show_base=None):
1621
if revision is not None and len(revision) != 1:
1622
raise errors.BzrCommandError(gettext(
1623
"bzr update --revision takes exactly one revision"))
1625
tree = WorkingTree.open_containing('.')[0]
1627
tree, relpath = WorkingTree.open_containing(dir)
1630
raise errors.BzrCommandError(gettext(
1631
"bzr update can only update a whole tree, "
1632
"not a file or subdirectory"))
1633
branch = tree.branch
1634
possible_transports = []
1635
master = branch.get_master_branch(
1636
possible_transports=possible_transports)
1637
if master is not None:
1638
branch_location = master.base
1641
branch_location = tree.branch.base
1642
tree.lock_tree_write()
1643
self.add_cleanup(tree.unlock)
1644
# get rid of the final '/' and be ready for display
1645
branch_location = urlutils.unescape_for_display(
1646
branch_location.rstrip('/'),
1648
existing_pending_merges = tree.get_parent_ids()[1:]
1652
# may need to fetch data into a heavyweight checkout
1653
# XXX: this may take some time, maybe we should display a
1655
old_tip = branch.update(possible_transports)
1656
if revision is not None:
1657
revision_id = revision[0].as_revision_id(branch)
1659
revision_id = branch.last_revision()
1660
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1661
revno = branch.revision_id_to_dotted_revno(revision_id)
1662
note(gettext("Tree is up to date at revision {0} of branch {1}"
1663
).format('.'.join(map(str, revno)), branch_location))
1665
view_info = _get_view_info_for_change_reporter(tree)
1666
change_reporter = delta._ChangeReporter(
1667
unversioned_filter=tree.is_ignored,
1668
view_info=view_info)
1670
conflicts = tree.update(
1672
possible_transports=possible_transports,
1673
revision=revision_id,
1675
show_base=show_base)
1676
except errors.NoSuchRevision, e:
1677
raise errors.BzrCommandError(gettext(
1678
"branch has no revision %s\n"
1679
"bzr update --revision only works"
1680
" for a revision in the branch history")
1682
revno = tree.branch.revision_id_to_dotted_revno(
1683
_mod_revision.ensure_null(tree.last_revision()))
1684
note(gettext('Updated to revision {0} of branch {1}').format(
1685
'.'.join(map(str, revno)), branch_location))
1686
parent_ids = tree.get_parent_ids()
1687
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1688
note(gettext('Your local commits will now show as pending merges with '
1689
"'bzr status', and can be committed with 'bzr commit'."))
1696
class cmd_info(Command):
1697
__doc__ = """Show information about a working tree, branch or repository.
1699
This command will show all known locations and formats associated to the
1700
tree, branch or repository.
1702
In verbose mode, statistical information is included with each report.
1703
To see extended statistic information, use a verbosity level of 2 or
1704
higher by specifying the verbose option multiple times, e.g. -vv.
1706
Branches and working trees will also report any missing revisions.
1710
Display information on the format and related locations:
1714
Display the above together with extended format information and
1715
basic statistics (like the number of files in the working tree and
1716
number of revisions in the branch and repository):
1720
Display the above together with number of committers to the branch:
1724
_see_also = ['revno', 'working-trees', 'repositories']
1725
takes_args = ['location?']
1726
takes_options = ['verbose']
1727
encoding_type = 'replace'
1730
def run(self, location=None, verbose=False):
1732
noise_level = get_verbosity_level()
1735
from bzrlib.info import show_bzrdir_info
1736
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1737
verbose=noise_level, outfile=self.outf)
1740
class cmd_remove(Command):
1741
__doc__ = """Remove files or directories.
1743
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1744
delete them if they can easily be recovered using revert otherwise they
1745
will be backed up (adding an extention of the form .~#~). If no options or
1746
parameters are given Bazaar will scan for files that are being tracked by
1747
Bazaar but missing in your tree and stop tracking them for you.
1749
takes_args = ['file*']
1750
takes_options = ['verbose',
1751
Option('new', help='Only remove files that have never been committed.'),
1752
RegistryOption.from_kwargs('file-deletion-strategy',
1753
'The file deletion mode to be used.',
1754
title='Deletion Strategy', value_switches=True, enum_switch=False,
1755
safe='Backup changed files (default).',
1756
keep='Delete from bzr but leave the working copy.',
1757
no_backup='Don\'t backup changed files.',
1758
force='Delete all the specified files, even if they can not be '
1759
'recovered and even if they are non-empty directories. '
1760
'(deprecated, use no-backup)')]
1761
aliases = ['rm', 'del']
1762
encoding_type = 'replace'
1764
def run(self, file_list, verbose=False, new=False,
1765
file_deletion_strategy='safe'):
1766
if file_deletion_strategy == 'force':
1767
note(gettext("(The --force option is deprecated, rather use --no-backup "
1769
file_deletion_strategy = 'no-backup'
1771
tree, file_list = WorkingTree.open_containing_paths(file_list)
1773
if file_list is not None:
1774
file_list = [f for f in file_list]
1776
self.add_cleanup(tree.lock_write().unlock)
1777
# Heuristics should probably all move into tree.remove_smart or
1780
added = tree.changes_from(tree.basis_tree(),
1781
specific_files=file_list).added
1782
file_list = sorted([f[0] for f in added], reverse=True)
1783
if len(file_list) == 0:
1784
raise errors.BzrCommandError(gettext('No matching files.'))
1785
elif file_list is None:
1786
# missing files show up in iter_changes(basis) as
1787
# versioned-with-no-kind.
1789
for change in tree.iter_changes(tree.basis_tree()):
1790
# Find paths in the working tree that have no kind:
1791
if change[1][1] is not None and change[6][1] is None:
1792
missing.append(change[1][1])
1793
file_list = sorted(missing, reverse=True)
1794
file_deletion_strategy = 'keep'
1795
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1796
keep_files=file_deletion_strategy=='keep',
1797
force=(file_deletion_strategy=='no-backup'))
1800
class cmd_file_id(Command):
1801
__doc__ = """Print file_id of a particular file or directory.
1803
The file_id is assigned when the file is first added and remains the
1804
same through all revisions where the file exists, even when it is
1809
_see_also = ['inventory', 'ls']
1810
takes_args = ['filename']
1813
def run(self, filename):
1814
tree, relpath = WorkingTree.open_containing(filename)
1815
i = tree.path2id(relpath)
1817
raise errors.NotVersionedError(filename)
1819
self.outf.write(i + '\n')
1822
class cmd_file_path(Command):
1823
__doc__ = """Print path of file_ids to a file or directory.
1825
This prints one line for each directory down to the target,
1826
starting at the branch root.
1830
takes_args = ['filename']
1833
def run(self, filename):
1834
tree, relpath = WorkingTree.open_containing(filename)
1835
fid = tree.path2id(relpath)
1837
raise errors.NotVersionedError(filename)
1838
segments = osutils.splitpath(relpath)
1839
for pos in range(1, len(segments) + 1):
1840
path = osutils.joinpath(segments[:pos])
1841
self.outf.write("%s\n" % tree.path2id(path))
1844
class cmd_reconcile(Command):
1845
__doc__ = """Reconcile bzr metadata in a branch.
1847
This can correct data mismatches that may have been caused by
1848
previous ghost operations or bzr upgrades. You should only
1849
need to run this command if 'bzr check' or a bzr developer
1850
advises you to run it.
1852
If a second branch is provided, cross-branch reconciliation is
1853
also attempted, which will check that data like the tree root
1854
id which was not present in very early bzr versions is represented
1855
correctly in both branches.
1857
At the same time it is run it may recompress data resulting in
1858
a potential saving in disk space or performance gain.
1860
The branch *MUST* be on a listable system such as local disk or sftp.
1863
_see_also = ['check']
1864
takes_args = ['branch?']
1866
Option('canonicalize-chks',
1867
help='Make sure CHKs are in canonical form (repairs '
1872
def run(self, branch=".", canonicalize_chks=False):
1873
from bzrlib.reconcile import reconcile
1874
dir = controldir.ControlDir.open(branch)
1875
reconcile(dir, canonicalize_chks=canonicalize_chks)
1878
class cmd_revision_history(Command):
1879
__doc__ = """Display the list of revision ids on a branch."""
1882
takes_args = ['location?']
1887
def run(self, location="."):
1888
branch = Branch.open_containing(location)[0]
1889
self.add_cleanup(branch.lock_read().unlock)
1890
graph = branch.repository.get_graph()
1891
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1892
[_mod_revision.NULL_REVISION]))
1893
for revid in reversed(history):
1894
self.outf.write(revid)
1895
self.outf.write('\n')
1898
class cmd_ancestry(Command):
1899
__doc__ = """List all revisions merged into this branch."""
1901
_see_also = ['log', 'revision-history']
1902
takes_args = ['location?']
1907
def run(self, location="."):
1909
wt = WorkingTree.open_containing(location)[0]
1910
except errors.NoWorkingTree:
1911
b = Branch.open(location)
1912
last_revision = b.last_revision()
1915
last_revision = wt.last_revision()
1917
self.add_cleanup(b.repository.lock_read().unlock)
1918
graph = b.repository.get_graph()
1919
revisions = [revid for revid, parents in
1920
graph.iter_ancestry([last_revision])]
1921
for revision_id in reversed(revisions):
1922
if _mod_revision.is_null(revision_id):
1924
self.outf.write(revision_id + '\n')
1927
class cmd_init(Command):
1928
__doc__ = """Make a directory into a versioned branch.
1930
Use this to create an empty branch, or before importing an
1933
If there is a repository in a parent directory of the location, then
1934
the history of the branch will be stored in the repository. Otherwise
1935
init creates a standalone branch which carries its own history
1936
in the .bzr directory.
1938
If there is already a branch at the location but it has no working tree,
1939
the tree can be populated with 'bzr checkout'.
1941
Recipe for importing a tree of files::
1947
bzr commit -m "imported project"
1950
_see_also = ['init-repository', 'branch', 'checkout']
1951
takes_args = ['location?']
1953
Option('create-prefix',
1954
help='Create the path leading up to the branch '
1955
'if it does not already exist.'),
1956
RegistryOption('format',
1957
help='Specify a format for this branch. '
1958
'See "help formats".',
1959
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1960
converter=lambda name: controldir.format_registry.make_bzrdir(name),
1961
value_switches=True,
1962
title="Branch format",
1964
Option('append-revisions-only',
1965
help='Never change revnos or the existing log.'
1966
' Append revisions to it only.'),
1968
'Create a branch without a working tree.')
1970
def run(self, location=None, format=None, append_revisions_only=False,
1971
create_prefix=False, no_tree=False):
1973
format = controldir.format_registry.make_bzrdir('default')
1974
if location is None:
1977
to_transport = transport.get_transport(location)
1979
# The path has to exist to initialize a
1980
# branch inside of it.
1981
# Just using os.mkdir, since I don't
1982
# believe that we want to create a bunch of
1983
# locations if the user supplies an extended path
1985
to_transport.ensure_base()
1986
except errors.NoSuchFile:
1987
if not create_prefix:
1988
raise errors.BzrCommandError(gettext("Parent directory of %s"
1990
"\nYou may supply --create-prefix to create all"
1991
" leading parent directories.")
1993
to_transport.create_prefix()
1996
a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
1997
except errors.NotBranchError:
1998
# really a NotBzrDir error...
1999
create_branch = controldir.ControlDir.create_branch_convenience
2001
force_new_tree = False
2003
force_new_tree = None
2004
branch = create_branch(to_transport.base, format=format,
2005
possible_transports=[to_transport],
2006
force_new_tree=force_new_tree)
2007
a_bzrdir = branch.bzrdir
2009
from bzrlib.transport.local import LocalTransport
2010
if a_bzrdir.has_branch():
2011
if (isinstance(to_transport, LocalTransport)
2012
and not a_bzrdir.has_workingtree()):
2013
raise errors.BranchExistsWithoutWorkingTree(location)
2014
raise errors.AlreadyBranchError(location)
2015
branch = a_bzrdir.create_branch()
2016
if not no_tree and not a_bzrdir.has_workingtree():
2017
a_bzrdir.create_workingtree()
2018
if append_revisions_only:
2022
branch.set_append_revisions_only(True)
2025
except errors.UpgradeRequired:
2026
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2027
' to append-revisions-only. Try --default.'))
2029
from bzrlib.info import describe_layout, describe_format
2031
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
2032
except (errors.NoWorkingTree, errors.NotLocalUrl):
2034
repository = branch.repository
2035
layout = describe_layout(repository, branch, tree).lower()
2036
format = describe_format(a_bzrdir, repository, branch, tree)
2037
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2039
if repository.is_shared():
2040
#XXX: maybe this can be refactored into transport.path_or_url()
2041
url = repository.bzrdir.root_transport.external_url()
2043
url = urlutils.local_path_from_url(url)
2044
except errors.InvalidURL:
2046
self.outf.write(gettext("Using shared repository: %s\n") % url)
2049
class cmd_init_repository(Command):
2050
__doc__ = """Create a shared repository for branches to share storage space.
2052
New branches created under the repository directory will store their
2053
revisions in the repository, not in the branch directory. For branches
2054
with shared history, this reduces the amount of storage needed and
2055
speeds up the creation of new branches.
2057
If the --no-trees option is given then the branches in the repository
2058
will not have working trees by default. They will still exist as
2059
directories on disk, but they will not have separate copies of the
2060
files at a certain revision. This can be useful for repositories that
2061
store branches which are interacted with through checkouts or remote
2062
branches, such as on a server.
2065
Create a shared repository holding just branches::
2067
bzr init-repo --no-trees repo
2070
Make a lightweight checkout elsewhere::
2072
bzr checkout --lightweight repo/trunk trunk-checkout
2077
_see_also = ['init', 'branch', 'checkout', 'repositories']
2078
takes_args = ["location"]
2079
takes_options = [RegistryOption('format',
2080
help='Specify a format for this repository. See'
2081
' "bzr help formats" for details.',
2082
lazy_registry=('bzrlib.controldir', 'format_registry'),
2083
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2084
value_switches=True, title='Repository format'),
2086
help='Branches in the repository will default to'
2087
' not having a working tree.'),
2089
aliases = ["init-repo"]
2091
def run(self, location, format=None, no_trees=False):
2093
format = controldir.format_registry.make_bzrdir('default')
2095
if location is None:
2098
to_transport = transport.get_transport(location)
2100
(repo, newdir, require_stacking, repository_policy) = (
2101
format.initialize_on_transport_ex(to_transport,
2102
create_prefix=True, make_working_trees=not no_trees,
2103
shared_repo=True, force_new_repo=True,
2104
use_existing_dir=True,
2105
repo_format_name=format.repository_format.get_format_string()))
2107
from bzrlib.info import show_bzrdir_info
2108
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2111
class cmd_diff(Command):
2112
__doc__ = """Show differences in the working tree, between revisions or branches.
2114
If no arguments are given, all changes for the current tree are listed.
2115
If files are given, only the changes in those files are listed.
2116
Remote and multiple branches can be compared by using the --old and
2117
--new options. If not provided, the default for both is derived from
2118
the first argument, if any, or the current tree if no arguments are
2121
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
2122
produces patches suitable for "patch -p1".
2124
Note that when using the -r argument with a range of revisions, the
2125
differences are computed between the two specified revisions. That
2126
is, the command does not show the changes introduced by the first
2127
revision in the range. This differs from the interpretation of
2128
revision ranges used by "bzr log" which includes the first revision
2133
2 - unrepresentable changes
2138
Shows the difference in the working tree versus the last commit::
2142
Difference between the working tree and revision 1::
2146
Difference between revision 3 and revision 1::
2150
Difference between revision 3 and revision 1 for branch xxx::
2154
The changes introduced by revision 2 (equivalent to -r1..2)::
2158
To see the changes introduced by revision X::
2162
Note that in the case of a merge, the -c option shows the changes
2163
compared to the left hand parent. To see the changes against
2164
another parent, use::
2166
bzr diff -r<chosen_parent>..X
2168
The changes between the current revision and the previous revision
2169
(equivalent to -c-1 and -r-2..-1)
2173
Show just the differences for file NEWS::
2177
Show the differences in working tree xxx for file NEWS::
2181
Show the differences from branch xxx to this working tree:
2185
Show the differences between two branches for file NEWS::
2187
bzr diff --old xxx --new yyy NEWS
2189
Same as 'bzr diff' but prefix paths with old/ and new/::
2191
bzr diff --prefix old/:new/
2193
Show the differences using a custom diff program with options::
2195
bzr diff --using /usr/bin/diff --diff-options -wu
2197
_see_also = ['status']
2198
takes_args = ['file*']
2200
Option('diff-options', type=str,
2201
help='Pass these options to the external diff program.'),
2202
Option('prefix', type=str,
2204
help='Set prefixes added to old and new filenames, as '
2205
'two values separated by a colon. (eg "old/:new/").'),
2207
help='Branch/tree to compare from.',
2211
help='Branch/tree to compare to.',
2217
help='Use this command to compare files.',
2220
RegistryOption('format',
2222
help='Diff format to use.',
2223
lazy_registry=('bzrlib.diff', 'format_registry'),
2224
title='Diff format'),
2226
aliases = ['di', 'dif']
2227
encoding_type = 'exact'
2230
def run(self, revision=None, file_list=None, diff_options=None,
2231
prefix=None, old=None, new=None, using=None, format=None):
2232
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2235
if (prefix is None) or (prefix == '0'):
2243
old_label, new_label = prefix.split(":")
2245
raise errors.BzrCommandError(gettext(
2246
'--prefix expects two values separated by a colon'
2247
' (eg "old/:new/")'))
2249
if revision and len(revision) > 2:
2250
raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
2251
' one or two revision specifiers'))
2253
if using is not None and format is not None:
2254
raise errors.BzrCommandError(gettext(
2255
'{0} and {1} are mutually exclusive').format(
2256
'--using', '--format'))
2258
(old_tree, new_tree,
2259
old_branch, new_branch,
2260
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2261
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2262
# GNU diff on Windows uses ANSI encoding for filenames
2263
path_encoding = osutils.get_diff_header_encoding()
2264
return show_diff_trees(old_tree, new_tree, sys.stdout,
2265
specific_files=specific_files,
2266
external_diff_options=diff_options,
2267
old_label=old_label, new_label=new_label,
2268
extra_trees=extra_trees,
2269
path_encoding=path_encoding,
2274
class cmd_deleted(Command):
2275
__doc__ = """List files deleted in the working tree.
2277
# TODO: Show files deleted since a previous revision, or
2278
# between two revisions.
2279
# TODO: Much more efficient way to do this: read in new
2280
# directories with readdir, rather than stating each one. Same
2281
# level of effort but possibly much less IO. (Or possibly not,
2282
# if the directories are very large...)
2283
_see_also = ['status', 'ls']
2284
takes_options = ['directory', 'show-ids']
2287
def run(self, show_ids=False, directory=u'.'):
2288
tree = WorkingTree.open_containing(directory)[0]
2289
self.add_cleanup(tree.lock_read().unlock)
2290
old = tree.basis_tree()
2291
self.add_cleanup(old.lock_read().unlock)
2292
for path, ie in old.inventory.iter_entries():
2293
if not tree.has_id(ie.file_id):
2294
self.outf.write(path)
2296
self.outf.write(' ')
2297
self.outf.write(ie.file_id)
2298
self.outf.write('\n')
2301
class cmd_modified(Command):
2302
__doc__ = """List files modified in working tree.
2306
_see_also = ['status', 'ls']
2307
takes_options = ['directory', 'null']
2310
def run(self, null=False, directory=u'.'):
2311
tree = WorkingTree.open_containing(directory)[0]
2312
self.add_cleanup(tree.lock_read().unlock)
2313
td = tree.changes_from(tree.basis_tree())
2315
for path, id, kind, text_modified, meta_modified in td.modified:
2317
self.outf.write(path + '\0')
2319
self.outf.write(osutils.quotefn(path) + '\n')
2322
class cmd_added(Command):
2323
__doc__ = """List files added in working tree.
2327
_see_also = ['status', 'ls']
2328
takes_options = ['directory', 'null']
2331
def run(self, null=False, directory=u'.'):
2332
wt = WorkingTree.open_containing(directory)[0]
2333
self.add_cleanup(wt.lock_read().unlock)
2334
basis = wt.basis_tree()
2335
self.add_cleanup(basis.lock_read().unlock)
2336
basis_inv = basis.inventory
2339
if basis_inv.has_id(file_id):
2341
if inv.is_root(file_id) and len(basis_inv) == 0:
2343
path = inv.id2path(file_id)
2344
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2347
self.outf.write(path + '\0')
2349
self.outf.write(osutils.quotefn(path) + '\n')
2352
class cmd_root(Command):
2353
__doc__ = """Show the tree root directory.
2355
The root is the nearest enclosing directory with a .bzr control
2358
takes_args = ['filename?']
2360
def run(self, filename=None):
2361
"""Print the branch root."""
2362
tree = WorkingTree.open_containing(filename)[0]
2363
self.outf.write(tree.basedir + '\n')
2366
def _parse_limit(limitstring):
2368
return int(limitstring)
2370
msg = gettext("The limit argument must be an integer.")
2371
raise errors.BzrCommandError(msg)
2374
def _parse_levels(s):
2378
msg = gettext("The levels argument must be an integer.")
2379
raise errors.BzrCommandError(msg)
2382
class cmd_log(Command):
2383
__doc__ = """Show historical log for a branch or subset of a branch.
2385
log is bzr's default tool for exploring the history of a branch.
2386
The branch to use is taken from the first parameter. If no parameters
2387
are given, the branch containing the working directory is logged.
2388
Here are some simple examples::
2390
bzr log log the current branch
2391
bzr log foo.py log a file in its branch
2392
bzr log http://server/branch log a branch on a server
2394
The filtering, ordering and information shown for each revision can
2395
be controlled as explained below. By default, all revisions are
2396
shown sorted (topologically) so that newer revisions appear before
2397
older ones and descendants always appear before ancestors. If displayed,
2398
merged revisions are shown indented under the revision in which they
2403
The log format controls how information about each revision is
2404
displayed. The standard log formats are called ``long``, ``short``
2405
and ``line``. The default is long. See ``bzr help log-formats``
2406
for more details on log formats.
2408
The following options can be used to control what information is
2411
-l N display a maximum of N revisions
2412
-n N display N levels of revisions (0 for all, 1 for collapsed)
2413
-v display a status summary (delta) for each revision
2414
-p display a diff (patch) for each revision
2415
--show-ids display revision-ids (and file-ids), not just revnos
2417
Note that the default number of levels to display is a function of the
2418
log format. If the -n option is not used, the standard log formats show
2419
just the top level (mainline).
2421
Status summaries are shown using status flags like A, M, etc. To see
2422
the changes explained using words like ``added`` and ``modified``
2423
instead, use the -vv option.
2427
To display revisions from oldest to newest, use the --forward option.
2428
In most cases, using this option will have little impact on the total
2429
time taken to produce a log, though --forward does not incrementally
2430
display revisions like --reverse does when it can.
2432
:Revision filtering:
2434
The -r option can be used to specify what revision or range of revisions
2435
to filter against. The various forms are shown below::
2437
-rX display revision X
2438
-rX.. display revision X and later
2439
-r..Y display up to and including revision Y
2440
-rX..Y display from X to Y inclusive
2442
See ``bzr help revisionspec`` for details on how to specify X and Y.
2443
Some common examples are given below::
2445
-r-1 show just the tip
2446
-r-10.. show the last 10 mainline revisions
2447
-rsubmit:.. show what's new on this branch
2448
-rancestor:path.. show changes since the common ancestor of this
2449
branch and the one at location path
2450
-rdate:yesterday.. show changes since yesterday
2452
When logging a range of revisions using -rX..Y, log starts at
2453
revision Y and searches back in history through the primary
2454
("left-hand") parents until it finds X. When logging just the
2455
top level (using -n1), an error is reported if X is not found
2456
along the way. If multi-level logging is used (-n0), X may be
2457
a nested merge revision and the log will be truncated accordingly.
2461
If parameters are given and the first one is not a branch, the log
2462
will be filtered to show only those revisions that changed the
2463
nominated files or directories.
2465
Filenames are interpreted within their historical context. To log a
2466
deleted file, specify a revision range so that the file existed at
2467
the end or start of the range.
2469
Historical context is also important when interpreting pathnames of
2470
renamed files/directories. Consider the following example:
2472
* revision 1: add tutorial.txt
2473
* revision 2: modify tutorial.txt
2474
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2478
* ``bzr log guide.txt`` will log the file added in revision 1
2480
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2482
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2483
the original file in revision 2.
2485
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2486
was no file called guide.txt in revision 2.
2488
Renames are always followed by log. By design, there is no need to
2489
explicitly ask for this (and no way to stop logging a file back
2490
until it was last renamed).
2494
The --match option can be used for finding revisions that match a
2495
regular expression in a commit message, committer, author or bug.
2496
Specifying the option several times will match any of the supplied
2497
expressions. --match-author, --match-bugs, --match-committer and
2498
--match-message can be used to only match a specific field.
2502
GUI tools and IDEs are often better at exploring history than command
2503
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2504
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2505
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2506
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2508
You may find it useful to add the aliases below to ``bazaar.conf``::
2512
top = log -l10 --line
2515
``bzr tip`` will then show the latest revision while ``bzr top``
2516
will show the last 10 mainline revisions. To see the details of a
2517
particular revision X, ``bzr show -rX``.
2519
If you are interested in looking deeper into a particular merge X,
2520
use ``bzr log -n0 -rX``.
2522
``bzr log -v`` on a branch with lots of history is currently
2523
very slow. A fix for this issue is currently under development.
2524
With or without that fix, it is recommended that a revision range
2525
be given when using the -v option.
2527
bzr has a generic full-text matching plugin, bzr-search, that can be
2528
used to find revisions matching user names, commit messages, etc.
2529
Among other features, this plugin can find all revisions containing
2530
a list of words but not others.
2532
When exploring non-mainline history on large projects with deep
2533
history, the performance of log can be greatly improved by installing
2534
the historycache plugin. This plugin buffers historical information
2535
trading disk space for faster speed.
2537
takes_args = ['file*']
2538
_see_also = ['log-formats', 'revisionspec']
2541
help='Show from oldest to newest.'),
2543
custom_help('verbose',
2544
help='Show files changed in each revision.'),
2548
type=bzrlib.option._parse_revision_str,
2550
help='Show just the specified revision.'
2551
' See also "help revisionspec".'),
2553
RegistryOption('authors',
2554
'What names to list as authors - first, all or committer.',
2556
lazy_registry=('bzrlib.log', 'author_list_registry'),
2560
help='Number of levels to display - 0 for all, 1 for flat.',
2562
type=_parse_levels),
2564
help='Show revisions whose message matches this '
2565
'regular expression.',
2570
help='Limit the output to the first N revisions.',
2575
help='Show changes made in each revision as a patch.'),
2576
Option('include-merged',
2577
help='Show merged revisions like --levels 0 does.'),
2578
Option('include-merges', hidden=True,
2579
help='Historical alias for --include-merged.'),
2580
Option('omit-merges',
2581
help='Do not report commits with more than one parent.'),
2582
Option('exclude-common-ancestry',
2583
help='Display only the revisions that are not part'
2584
' of both ancestries (require -rX..Y).'
2586
Option('signatures',
2587
help='Show digital signature validity.'),
2590
help='Show revisions whose properties match this '
2593
ListOption('match-message',
2594
help='Show revisions whose message matches this '
2597
ListOption('match-committer',
2598
help='Show revisions whose committer matches this '
2601
ListOption('match-author',
2602
help='Show revisions whose authors match this '
2605
ListOption('match-bugs',
2606
help='Show revisions whose bugs match this '
2610
encoding_type = 'replace'
2613
def run(self, file_list=None, timezone='original',
2624
include_merged=None,
2626
exclude_common_ancestry=False,
2630
match_committer=None,
2634
include_merges=symbol_versioning.DEPRECATED_PARAMETER,
2636
from bzrlib.log import (
2638
make_log_request_dict,
2639
_get_info_for_log_files,
2641
direction = (forward and 'forward') or 'reverse'
2642
if symbol_versioning.deprecated_passed(include_merges):
2643
ui.ui_factory.show_user_warning(
2644
'deprecated_command_option',
2645
deprecated_name='--include-merges',
2646
recommended_name='--include-merged',
2647
deprecated_in_version='2.5',
2648
command=self.invoked_as)
2649
if include_merged is None:
2650
include_merged = include_merges
2652
raise errors.BzrCommandError(gettext(
2653
'{0} and {1} are mutually exclusive').format(
2654
'--include-merges', '--include-merged'))
2655
if include_merged is None:
2656
include_merged = False
2657
if (exclude_common_ancestry
2658
and (revision is None or len(revision) != 2)):
2659
raise errors.BzrCommandError(gettext(
2660
'--exclude-common-ancestry requires -r with two revisions'))
2665
raise errors.BzrCommandError(gettext(
2666
'{0} and {1} are mutually exclusive').format(
2667
'--levels', '--include-merged'))
2669
if change is not None:
2671
raise errors.RangeInChangeOption()
2672
if revision is not None:
2673
raise errors.BzrCommandError(gettext(
2674
'{0} and {1} are mutually exclusive').format(
2675
'--revision', '--change'))
2680
filter_by_dir = False
2682
# find the file ids to log and check for directory filtering
2683
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2684
revision, file_list, self.add_cleanup)
2685
for relpath, file_id, kind in file_info_list:
2687
raise errors.BzrCommandError(gettext(
2688
"Path unknown at end or start of revision range: %s") %
2690
# If the relpath is the top of the tree, we log everything
2695
file_ids.append(file_id)
2696
filter_by_dir = filter_by_dir or (
2697
kind in ['directory', 'tree-reference'])
2700
# FIXME ? log the current subdir only RBC 20060203
2701
if revision is not None \
2702
and len(revision) > 0 and revision[0].get_branch():
2703
location = revision[0].get_branch()
2706
dir, relpath = controldir.ControlDir.open_containing(location)
2707
b = dir.open_branch()
2708
self.add_cleanup(b.lock_read().unlock)
2709
rev1, rev2 = _get_revision_range(revision, b, self.name())
2711
if b.get_config().validate_signatures_in_log():
2715
if not gpg.GPGStrategy.verify_signatures_available():
2716
raise errors.GpgmeNotInstalled(None)
2718
# Decide on the type of delta & diff filtering to use
2719
# TODO: add an --all-files option to make this configurable & consistent
2727
diff_type = 'partial'
2731
# Build the log formatter
2732
if log_format is None:
2733
log_format = log.log_formatter_registry.get_default(b)
2734
# Make a non-encoding output to include the diffs - bug 328007
2735
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2736
lf = log_format(show_ids=show_ids, to_file=self.outf,
2737
to_exact_file=unencoded_output,
2738
show_timezone=timezone,
2739
delta_format=get_verbosity_level(),
2741
show_advice=levels is None,
2742
author_list_handler=authors)
2744
# Choose the algorithm for doing the logging. It's annoying
2745
# having multiple code paths like this but necessary until
2746
# the underlying repository format is faster at generating
2747
# deltas or can provide everything we need from the indices.
2748
# The default algorithm - match-using-deltas - works for
2749
# multiple files and directories and is faster for small
2750
# amounts of history (200 revisions say). However, it's too
2751
# slow for logging a single file in a repository with deep
2752
# history, i.e. > 10K revisions. In the spirit of "do no
2753
# evil when adding features", we continue to use the
2754
# original algorithm - per-file-graph - for the "single
2755
# file that isn't a directory without showing a delta" case.
2756
partial_history = revision and b.repository._format.supports_chks
2757
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2758
or delta_type or partial_history)
2762
match_dict[''] = match
2764
match_dict['message'] = match_message
2766
match_dict['committer'] = match_committer
2768
match_dict['author'] = match_author
2770
match_dict['bugs'] = match_bugs
2772
# Build the LogRequest and execute it
2773
if len(file_ids) == 0:
2775
rqst = make_log_request_dict(
2776
direction=direction, specific_fileids=file_ids,
2777
start_revision=rev1, end_revision=rev2, limit=limit,
2778
message_search=message, delta_type=delta_type,
2779
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2780
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2781
signature=signatures, omit_merges=omit_merges,
2783
Logger(b, rqst).show(lf)
2786
def _get_revision_range(revisionspec_list, branch, command_name):
2787
"""Take the input of a revision option and turn it into a revision range.
2789
It returns RevisionInfo objects which can be used to obtain the rev_id's
2790
of the desired revisions. It does some user input validations.
2792
if revisionspec_list is None:
2795
elif len(revisionspec_list) == 1:
2796
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2797
elif len(revisionspec_list) == 2:
2798
start_spec = revisionspec_list[0]
2799
end_spec = revisionspec_list[1]
2800
if end_spec.get_branch() != start_spec.get_branch():
2801
# b is taken from revision[0].get_branch(), and
2802
# show_log will use its revision_history. Having
2803
# different branches will lead to weird behaviors.
2804
raise errors.BzrCommandError(gettext(
2805
"bzr %s doesn't accept two revisions in different"
2806
" branches.") % command_name)
2807
if start_spec.spec is None:
2808
# Avoid loading all the history.
2809
rev1 = RevisionInfo(branch, None, None)
2811
rev1 = start_spec.in_history(branch)
2812
# Avoid loading all of history when we know a missing
2813
# end of range means the last revision ...
2814
if end_spec.spec is None:
2815
last_revno, last_revision_id = branch.last_revision_info()
2816
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2818
rev2 = end_spec.in_history(branch)
2820
raise errors.BzrCommandError(gettext(
2821
'bzr %s --revision takes one or two values.') % command_name)
2825
def _revision_range_to_revid_range(revision_range):
2828
if revision_range[0] is not None:
2829
rev_id1 = revision_range[0].rev_id
2830
if revision_range[1] is not None:
2831
rev_id2 = revision_range[1].rev_id
2832
return rev_id1, rev_id2
2834
def get_log_format(long=False, short=False, line=False, default='long'):
2835
log_format = default
2839
log_format = 'short'
2845
class cmd_touching_revisions(Command):
2846
__doc__ = """Return revision-ids which affected a particular file.
2848
A more user-friendly interface is "bzr log FILE".
2852
takes_args = ["filename"]
2855
def run(self, filename):
2856
tree, relpath = WorkingTree.open_containing(filename)
2857
file_id = tree.path2id(relpath)
2859
self.add_cleanup(b.lock_read().unlock)
2860
touching_revs = log.find_touching_revisions(b, file_id)
2861
for revno, revision_id, what in touching_revs:
2862
self.outf.write("%6d %s\n" % (revno, what))
2865
class cmd_ls(Command):
2866
__doc__ = """List files in a tree.
2869
_see_also = ['status', 'cat']
2870
takes_args = ['path?']
2874
Option('recursive', short_name='R',
2875
help='Recurse into subdirectories.'),
2877
help='Print paths relative to the root of the branch.'),
2878
Option('unknown', short_name='u',
2879
help='Print unknown files.'),
2880
Option('versioned', help='Print versioned files.',
2882
Option('ignored', short_name='i',
2883
help='Print ignored files.'),
2884
Option('kind', short_name='k',
2885
help='List entries of a particular kind: file, directory, symlink.',
2892
def run(self, revision=None, verbose=False,
2893
recursive=False, from_root=False,
2894
unknown=False, versioned=False, ignored=False,
2895
null=False, kind=None, show_ids=False, path=None, directory=None):
2897
if kind and kind not in ('file', 'directory', 'symlink'):
2898
raise errors.BzrCommandError(gettext('invalid kind specified'))
2900
if verbose and null:
2901
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
2902
all = not (unknown or versioned or ignored)
2904
selection = {'I':ignored, '?':unknown, 'V':versioned}
2910
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
2913
tree, branch, relpath = \
2914
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2916
# Calculate the prefix to use
2920
prefix = relpath + '/'
2921
elif fs_path != '.' and not fs_path.endswith('/'):
2922
prefix = fs_path + '/'
2924
if revision is not None or tree is None:
2925
tree = _get_one_revision_tree('ls', revision, branch=branch)
2928
if isinstance(tree, WorkingTree) and tree.supports_views():
2929
view_files = tree.views.lookup_view()
2932
view_str = views.view_display_str(view_files)
2933
note(gettext("Ignoring files outside view. View is %s") % view_str)
2935
self.add_cleanup(tree.lock_read().unlock)
2936
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2937
from_dir=relpath, recursive=recursive):
2938
# Apply additional masking
2939
if not all and not selection[fc]:
2941
if kind is not None and fkind != kind:
2946
fullpath = osutils.pathjoin(relpath, fp)
2949
views.check_path_in_view(tree, fullpath)
2950
except errors.FileOutsideView:
2955
fp = osutils.pathjoin(prefix, fp)
2956
kindch = entry.kind_character()
2957
outstring = fp + kindch
2958
ui.ui_factory.clear_term()
2960
outstring = '%-8s %s' % (fc, outstring)
2961
if show_ids and fid is not None:
2962
outstring = "%-50s %s" % (outstring, fid)
2963
self.outf.write(outstring + '\n')
2965
self.outf.write(fp + '\0')
2968
self.outf.write(fid)
2969
self.outf.write('\0')
2977
self.outf.write('%-50s %s\n' % (outstring, my_id))
2979
self.outf.write(outstring + '\n')
2982
class cmd_unknowns(Command):
2983
__doc__ = """List unknown files.
2988
takes_options = ['directory']
2991
def run(self, directory=u'.'):
2992
for f in WorkingTree.open_containing(directory)[0].unknowns():
2993
self.outf.write(osutils.quotefn(f) + '\n')
2996
class cmd_ignore(Command):
2997
__doc__ = """Ignore specified files or patterns.
2999
See ``bzr help patterns`` for details on the syntax of patterns.
3001
If a .bzrignore file does not exist, the ignore command
3002
will create one and add the specified files or patterns to the newly
3003
created file. The ignore command will also automatically add the
3004
.bzrignore file to be versioned. Creating a .bzrignore file without
3005
the use of the ignore command will require an explicit add command.
3007
To remove patterns from the ignore list, edit the .bzrignore file.
3008
After adding, editing or deleting that file either indirectly by
3009
using this command or directly by using an editor, be sure to commit
3012
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3013
the global ignore file can be found in the application data directory as
3014
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3015
Global ignores are not touched by this command. The global ignore file
3016
can be edited directly using an editor.
3018
Patterns prefixed with '!' are exceptions to ignore patterns and take
3019
precedence over regular ignores. Such exceptions are used to specify
3020
files that should be versioned which would otherwise be ignored.
3022
Patterns prefixed with '!!' act as regular ignore patterns, but have
3023
precedence over the '!' exception patterns.
3027
* Ignore patterns containing shell wildcards must be quoted from
3030
* Ignore patterns starting with "#" act as comments in the ignore file.
3031
To ignore patterns that begin with that character, use the "RE:" prefix.
3034
Ignore the top level Makefile::
3036
bzr ignore ./Makefile
3038
Ignore .class files in all directories...::
3040
bzr ignore "*.class"
3042
...but do not ignore "special.class"::
3044
bzr ignore "!special.class"
3046
Ignore files whose name begins with the "#" character::
3050
Ignore .o files under the lib directory::
3052
bzr ignore "lib/**/*.o"
3054
Ignore .o files under the lib directory::
3056
bzr ignore "RE:lib/.*\.o"
3058
Ignore everything but the "debian" toplevel directory::
3060
bzr ignore "RE:(?!debian/).*"
3062
Ignore everything except the "local" toplevel directory,
3063
but always ignore autosave files ending in ~, even under local/::
3066
bzr ignore "!./local"
3070
_see_also = ['status', 'ignored', 'patterns']
3071
takes_args = ['name_pattern*']
3072
takes_options = ['directory',
3073
Option('default-rules',
3074
help='Display the default ignore rules that bzr uses.')
3077
def run(self, name_pattern_list=None, default_rules=None,
3079
from bzrlib import ignores
3080
if default_rules is not None:
3081
# dump the default rules and exit
3082
for pattern in ignores.USER_DEFAULTS:
3083
self.outf.write("%s\n" % pattern)
3085
if not name_pattern_list:
3086
raise errors.BzrCommandError(gettext("ignore requires at least one "
3087
"NAME_PATTERN or --default-rules."))
3088
name_pattern_list = [globbing.normalize_pattern(p)
3089
for p in name_pattern_list]
3091
bad_patterns_count = 0
3092
for p in name_pattern_list:
3093
if not globbing.Globster.is_pattern_valid(p):
3094
bad_patterns_count += 1
3095
bad_patterns += ('\n %s' % p)
3097
msg = (ngettext('Invalid ignore pattern found. %s',
3098
'Invalid ignore patterns found. %s',
3099
bad_patterns_count) % bad_patterns)
3100
ui.ui_factory.show_error(msg)
3101
raise errors.InvalidPattern('')
3102
for name_pattern in name_pattern_list:
3103
if (name_pattern[0] == '/' or
3104
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3105
raise errors.BzrCommandError(gettext(
3106
"NAME_PATTERN should not be an absolute path"))
3107
tree, relpath = WorkingTree.open_containing(directory)
3108
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3109
ignored = globbing.Globster(name_pattern_list)
3111
self.add_cleanup(tree.lock_read().unlock)
3112
for entry in tree.list_files():
3116
if ignored.match(filename):
3117
matches.append(filename)
3118
if len(matches) > 0:
3119
self.outf.write(gettext("Warning: the following files are version "
3120
"controlled and match your ignore pattern:\n%s"
3121
"\nThese files will continue to be version controlled"
3122
" unless you 'bzr remove' them.\n") % ("\n".join(matches),))
3125
class cmd_ignored(Command):
3126
__doc__ = """List ignored files and the patterns that matched them.
3128
List all the ignored files and the ignore pattern that caused the file to
3131
Alternatively, to list just the files::
3136
encoding_type = 'replace'
3137
_see_also = ['ignore', 'ls']
3138
takes_options = ['directory']
3141
def run(self, directory=u'.'):
3142
tree = WorkingTree.open_containing(directory)[0]
3143
self.add_cleanup(tree.lock_read().unlock)
3144
for path, file_class, kind, file_id, entry in tree.list_files():
3145
if file_class != 'I':
3147
## XXX: Slightly inefficient since this was already calculated
3148
pat = tree.is_ignored(path)
3149
self.outf.write('%-50s %s\n' % (path, pat))
3152
class cmd_lookup_revision(Command):
3153
__doc__ = """Lookup the revision-id from a revision-number
3156
bzr lookup-revision 33
3159
takes_args = ['revno']
3160
takes_options = ['directory']
3163
def run(self, revno, directory=u'.'):
3167
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3169
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3170
self.outf.write("%s\n" % revid)
3173
class cmd_export(Command):
3174
__doc__ = """Export current or past revision to a destination directory or archive.
3176
If no revision is specified this exports the last committed revision.
3178
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3179
given, try to find the format with the extension. If no extension
3180
is found exports to a directory (equivalent to --format=dir).
3182
If root is supplied, it will be used as the root directory inside
3183
container formats (tar, zip, etc). If it is not supplied it will default
3184
to the exported filename. The root option has no effect for 'dir' format.
3186
If branch is omitted then the branch containing the current working
3187
directory will be used.
3189
Note: Export of tree with non-ASCII filenames to zip is not supported.
3191
================= =========================
3192
Supported formats Autodetected by extension
3193
================= =========================
3196
tbz2 .tar.bz2, .tbz2
3199
================= =========================
3202
takes_args = ['dest', 'branch_or_subdir?']
3203
takes_options = ['directory',
3205
help="Type of file to export to.",
3208
Option('filters', help='Apply content filters to export the '
3209
'convenient form.'),
3212
help="Name of the root directory inside the exported file."),
3213
Option('per-file-timestamps',
3214
help='Set modification time of files to that of the last '
3215
'revision in which it was changed.'),
3216
Option('uncommitted',
3217
help='Export the working tree contents rather than that of the '
3220
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3221
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3223
from bzrlib.export import export
3225
if branch_or_subdir is None:
3226
branch_or_subdir = directory
3228
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3230
if tree is not None:
3231
self.add_cleanup(tree.lock_read().unlock)
3235
raise errors.BzrCommandError(
3236
gettext("--uncommitted requires a working tree"))
3239
export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3241
export(export_tree, dest, format, root, subdir, filtered=filters,
3242
per_file_timestamps=per_file_timestamps)
3243
except errors.NoSuchExportFormat, e:
3244
raise errors.BzrCommandError(
3245
gettext('Unsupported export format: %s') % e.format)
3248
class cmd_cat(Command):
3249
__doc__ = """Write the contents of a file as of a given revision to standard output.
3251
If no revision is nominated, the last revision is used.
3253
Note: Take care to redirect standard output when using this command on a
3258
takes_options = ['directory',
3259
Option('name-from-revision', help='The path name in the old tree.'),
3260
Option('filters', help='Apply content filters to display the '
3261
'convenience form.'),
3264
takes_args = ['filename']
3265
encoding_type = 'exact'
3268
def run(self, filename, revision=None, name_from_revision=False,
3269
filters=False, directory=None):
3270
if revision is not None and len(revision) != 1:
3271
raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
3272
" one revision specifier"))
3273
tree, branch, relpath = \
3274
_open_directory_or_containing_tree_or_branch(filename, directory)
3275
self.add_cleanup(branch.lock_read().unlock)
3276
return self._run(tree, branch, relpath, filename, revision,
3277
name_from_revision, filters)
3279
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3282
tree = b.basis_tree()
3283
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3284
self.add_cleanup(rev_tree.lock_read().unlock)
3286
old_file_id = rev_tree.path2id(relpath)
3288
# TODO: Split out this code to something that generically finds the
3289
# best id for a path across one or more trees; it's like
3290
# find_ids_across_trees but restricted to find just one. -- mbp
3292
if name_from_revision:
3293
# Try in revision if requested
3294
if old_file_id is None:
3295
raise errors.BzrCommandError(gettext(
3296
"{0!r} is not present in revision {1}").format(
3297
filename, rev_tree.get_revision_id()))
3299
actual_file_id = old_file_id
3301
cur_file_id = tree.path2id(relpath)
3302
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3303
actual_file_id = cur_file_id
3304
elif old_file_id is not None:
3305
actual_file_id = old_file_id
3307
raise errors.BzrCommandError(gettext(
3308
"{0!r} is not present in revision {1}").format(
3309
filename, rev_tree.get_revision_id()))
3311
from bzrlib.filter_tree import ContentFilterTree
3312
filter_tree = ContentFilterTree(rev_tree,
3313
rev_tree._content_filter_stack)
3314
content = filter_tree.get_file_text(actual_file_id)
3316
content = rev_tree.get_file_text(actual_file_id)
3318
self.outf.write(content)
3321
class cmd_local_time_offset(Command):
3322
__doc__ = """Show the offset in seconds from GMT to local time."""
3326
self.outf.write("%s\n" % osutils.local_time_offset())
3330
class cmd_commit(Command):
3331
__doc__ = """Commit changes into a new revision.
3333
An explanatory message needs to be given for each commit. This is
3334
often done by using the --message option (getting the message from the
3335
command line) or by using the --file option (getting the message from
3336
a file). If neither of these options is given, an editor is opened for
3337
the user to enter the message. To see the changed files in the
3338
boilerplate text loaded into the editor, use the --show-diff option.
3340
By default, the entire tree is committed and the person doing the
3341
commit is assumed to be the author. These defaults can be overridden
3346
If selected files are specified, only changes to those files are
3347
committed. If a directory is specified then the directory and
3348
everything within it is committed.
3350
When excludes are given, they take precedence over selected files.
3351
For example, to commit only changes within foo, but not changes
3354
bzr commit foo -x foo/bar
3356
A selective commit after a merge is not yet supported.
3360
If the author of the change is not the same person as the committer,
3361
you can specify the author's name using the --author option. The
3362
name should be in the same format as a committer-id, e.g.
3363
"John Doe <jdoe@example.com>". If there is more than one author of
3364
the change you can specify the option multiple times, once for each
3369
A common mistake is to forget to add a new file or directory before
3370
running the commit command. The --strict option checks for unknown
3371
files and aborts the commit if any are found. More advanced pre-commit
3372
checks can be implemented by defining hooks. See ``bzr help hooks``
3377
If you accidentially commit the wrong changes or make a spelling
3378
mistake in the commit message say, you can use the uncommit command
3379
to undo it. See ``bzr help uncommit`` for details.
3381
Hooks can also be configured to run after a commit. This allows you
3382
to trigger updates to external systems like bug trackers. The --fixes
3383
option can be used to record the association between a revision and
3384
one or more bugs. See ``bzr help bugs`` for details.
3387
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3388
takes_args = ['selected*']
3390
ListOption('exclude', type=str, short_name='x',
3391
help="Do not consider changes made to a given path."),
3392
Option('message', type=unicode,
3394
help="Description of the new revision."),
3397
help='Commit even if nothing has changed.'),
3398
Option('file', type=str,
3401
help='Take commit message from this file.'),
3403
help="Refuse to commit if there are unknown "
3404
"files in the working tree."),
3405
Option('commit-time', type=str,
3406
help="Manually set a commit time using commit date "
3407
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3408
ListOption('fixes', type=str,
3409
help="Mark a bug as being fixed by this revision "
3410
"(see \"bzr help bugs\")."),
3411
ListOption('author', type=unicode,
3412
help="Set the author's name, if it's different "
3413
"from the committer."),
3415
help="Perform a local commit in a bound "
3416
"branch. Local commits are not pushed to "
3417
"the master branch until a normal commit "
3420
Option('show-diff', short_name='p',
3421
help='When no message is supplied, show the diff along'
3422
' with the status summary in the message editor.'),
3424
help='When committing to a foreign version control '
3425
'system do not push data that can not be natively '
3428
aliases = ['ci', 'checkin']
3430
def _iter_bug_fix_urls(self, fixes, branch):
3431
default_bugtracker = None
3432
# Configure the properties for bug fixing attributes.
3433
for fixed_bug in fixes:
3434
tokens = fixed_bug.split(':')
3435
if len(tokens) == 1:
3436
if default_bugtracker is None:
3437
branch_config = branch.get_config()
3438
default_bugtracker = branch_config.get_user_option(
3440
if default_bugtracker is None:
3441
raise errors.BzrCommandError(gettext(
3442
"No tracker specified for bug %s. Use the form "
3443
"'tracker:id' or specify a default bug tracker "
3444
"using the `bugtracker` option.\nSee "
3445
"\"bzr help bugs\" for more information on this "
3446
"feature. Commit refused.") % fixed_bug)
3447
tag = default_bugtracker
3449
elif len(tokens) != 2:
3450
raise errors.BzrCommandError(gettext(
3451
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3452
"See \"bzr help bugs\" for more information on this "
3453
"feature.\nCommit refused.") % fixed_bug)
3455
tag, bug_id = tokens
3457
yield bugtracker.get_bug_url(tag, branch, bug_id)
3458
except errors.UnknownBugTrackerAbbreviation:
3459
raise errors.BzrCommandError(gettext(
3460
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3461
except errors.MalformedBugIdentifier, e:
3462
raise errors.BzrCommandError(gettext(
3463
"%s\nCommit refused.") % (str(e),))
3465
def run(self, message=None, file=None, verbose=False, selected_list=None,
3466
unchanged=False, strict=False, local=False, fixes=None,
3467
author=None, show_diff=False, exclude=None, commit_time=None,
3469
from bzrlib.errors import (
3474
from bzrlib.msgeditor import (
3475
edit_commit_message_encoded,
3476
generate_commit_message_template,
3477
make_commit_message_template_encoded,
3481
commit_stamp = offset = None
3482
if commit_time is not None:
3484
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3485
except ValueError, e:
3486
raise errors.BzrCommandError(gettext(
3487
"Could not parse --commit-time: " + str(e)))
3491
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3492
if selected_list == ['']:
3493
# workaround - commit of root of tree should be exactly the same
3494
# as just default commit in that tree, and succeed even though
3495
# selected-file merge commit is not done yet
3500
bug_property = bugtracker.encode_fixes_bug_urls(
3501
self._iter_bug_fix_urls(fixes, tree.branch))
3503
properties['bugs'] = bug_property
3505
if local and not tree.branch.get_bound_location():
3506
raise errors.LocalRequiresBoundBranch()
3508
if message is not None:
3510
file_exists = osutils.lexists(message)
3511
except UnicodeError:
3512
# The commit message contains unicode characters that can't be
3513
# represented in the filesystem encoding, so that can't be a
3518
'The commit message is a file name: "%(f)s".\n'
3519
'(use --file "%(f)s" to take commit message from that file)'
3521
ui.ui_factory.show_warning(warning_msg)
3523
message = message.replace('\r\n', '\n')
3524
message = message.replace('\r', '\n')
3526
raise errors.BzrCommandError(gettext(
3527
"please specify either --message or --file"))
3529
def get_message(commit_obj):
3530
"""Callback to get commit message"""
3534
my_message = f.read().decode(osutils.get_user_encoding())
3537
elif message is not None:
3538
my_message = message
3540
# No message supplied: make one up.
3541
# text is the status of the tree
3542
text = make_commit_message_template_encoded(tree,
3543
selected_list, diff=show_diff,
3544
output_encoding=osutils.get_user_encoding())
3545
# start_message is the template generated from hooks
3546
# XXX: Warning - looks like hooks return unicode,
3547
# make_commit_message_template_encoded returns user encoding.
3548
# We probably want to be using edit_commit_message instead to
3550
my_message = set_commit_message(commit_obj)
3551
if my_message is None:
3552
start_message = generate_commit_message_template(commit_obj)
3553
my_message = edit_commit_message_encoded(text,
3554
start_message=start_message)
3555
if my_message is None:
3556
raise errors.BzrCommandError(gettext("please specify a commit"
3557
" message with either --message or --file"))
3558
if my_message == "":
3559
raise errors.BzrCommandError(gettext("Empty commit message specified."
3560
" Please specify a commit message with either"
3561
" --message or --file or leave a blank message"
3562
" with --message \"\"."))
3565
# The API permits a commit with a filter of [] to mean 'select nothing'
3566
# but the command line should not do that.
3567
if not selected_list:
3568
selected_list = None
3570
tree.commit(message_callback=get_message,
3571
specific_files=selected_list,
3572
allow_pointless=unchanged, strict=strict, local=local,
3573
reporter=None, verbose=verbose, revprops=properties,
3574
authors=author, timestamp=commit_stamp,
3576
exclude=tree.safe_relpath_files(exclude),
3578
except PointlessCommit:
3579
raise errors.BzrCommandError(gettext("No changes to commit."
3580
" Please 'bzr add' the files you want to commit, or use"
3581
" --unchanged to force an empty commit."))
3582
except ConflictsInTree:
3583
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3584
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3586
except StrictCommitFailed:
3587
raise errors.BzrCommandError(gettext("Commit refused because there are"
3588
" unknown files in the working tree."))
3589
except errors.BoundBranchOutOfDate, e:
3590
e.extra_help = (gettext("\n"
3591
'To commit to master branch, run update and then commit.\n'
3592
'You can also pass --local to commit to continue working '
3597
class cmd_check(Command):
3598
__doc__ = """Validate working tree structure, branch consistency and repository history.
3600
This command checks various invariants about branch and repository storage
3601
to detect data corruption or bzr bugs.
3603
The working tree and branch checks will only give output if a problem is
3604
detected. The output fields of the repository check are:
3607
This is just the number of revisions checked. It doesn't
3611
This is just the number of versionedfiles checked. It
3612
doesn't indicate a problem.
3614
unreferenced ancestors
3615
Texts that are ancestors of other texts, but
3616
are not properly referenced by the revision ancestry. This is a
3617
subtle problem that Bazaar can work around.
3620
This is the total number of unique file contents
3621
seen in the checked revisions. It does not indicate a problem.
3624
This is the total number of repeated texts seen
3625
in the checked revisions. Texts can be repeated when their file
3626
entries are modified, but the file contents are not. It does not
3629
If no restrictions are specified, all Bazaar data that is found at the given
3630
location will be checked.
3634
Check the tree and branch at 'foo'::
3636
bzr check --tree --branch foo
3638
Check only the repository at 'bar'::
3640
bzr check --repo bar
3642
Check everything at 'baz'::
3647
_see_also = ['reconcile']
3648
takes_args = ['path?']
3649
takes_options = ['verbose',
3650
Option('branch', help="Check the branch related to the"
3651
" current directory."),
3652
Option('repo', help="Check the repository related to the"
3653
" current directory."),
3654
Option('tree', help="Check the working tree related to"
3655
" the current directory.")]
3657
def run(self, path=None, verbose=False, branch=False, repo=False,
3659
from bzrlib.check import check_dwim
3662
if not branch and not repo and not tree:
3663
branch = repo = tree = True
3664
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3667
class cmd_upgrade(Command):
3668
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3670
When the default format has changed after a major new release of
3671
Bazaar, you may be informed during certain operations that you
3672
should upgrade. Upgrading to a newer format may improve performance
3673
or make new features available. It may however limit interoperability
3674
with older repositories or with older versions of Bazaar.
3676
If you wish to upgrade to a particular format rather than the
3677
current default, that can be specified using the --format option.
3678
As a consequence, you can use the upgrade command this way to
3679
"downgrade" to an earlier format, though some conversions are
3680
a one way process (e.g. changing from the 1.x default to the
3681
2.x default) so downgrading is not always possible.
3683
A backup.bzr.~#~ directory is created at the start of the conversion
3684
process (where # is a number). By default, this is left there on
3685
completion. If the conversion fails, delete the new .bzr directory
3686
and rename this one back in its place. Use the --clean option to ask
3687
for the backup.bzr directory to be removed on successful conversion.
3688
Alternatively, you can delete it by hand if everything looks good
3691
If the location given is a shared repository, dependent branches
3692
are also converted provided the repository converts successfully.
3693
If the conversion of a branch fails, remaining branches are still
3696
For more information on upgrades, see the Bazaar Upgrade Guide,
3697
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3700
_see_also = ['check', 'reconcile', 'formats']
3701
takes_args = ['url?']
3703
RegistryOption('format',
3704
help='Upgrade to a specific format. See "bzr help'
3705
' formats" for details.',
3706
lazy_registry=('bzrlib.controldir', 'format_registry'),
3707
converter=lambda name: controldir.format_registry.make_bzrdir(name),
3708
value_switches=True, title='Branch format'),
3710
help='Remove the backup.bzr directory if successful.'),
3712
help="Show what would be done, but don't actually do anything."),
3715
def run(self, url='.', format=None, clean=False, dry_run=False):
3716
from bzrlib.upgrade import upgrade
3717
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3719
if len(exceptions) == 1:
3720
# Compatibility with historical behavior
3726
class cmd_whoami(Command):
3727
__doc__ = """Show or set bzr user id.
3730
Show the email of the current user::
3734
Set the current user::
3736
bzr whoami "Frank Chu <fchu@example.com>"
3738
takes_options = [ 'directory',
3740
help='Display email address only.'),
3742
help='Set identity for the current branch instead of '
3745
takes_args = ['name?']
3746
encoding_type = 'replace'
3749
def run(self, email=False, branch=False, name=None, directory=None):
3751
if directory is None:
3752
# use branch if we're inside one; otherwise global config
3754
c = Branch.open_containing(u'.')[0].get_config_stack()
3755
except errors.NotBranchError:
3756
c = _mod_config.GlobalStack()
3758
c = Branch.open(directory).get_config_stack()
3759
identity = c.get('email')
3761
self.outf.write(_mod_config.extract_email_address(identity)
3764
self.outf.write(identity + '\n')
3768
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3771
# display a warning if an email address isn't included in the given name.
3773
_mod_config.extract_email_address(name)
3774
except errors.NoEmailInUsername, e:
3775
warning('"%s" does not seem to contain an email address. '
3776
'This is allowed, but not recommended.', name)
3778
# use global config unless --branch given
3780
if directory is None:
3781
c = Branch.open_containing(u'.')[0].get_config_stack()
3783
b = Branch.open(directory)
3784
self.add_cleanup(b.lock_write().unlock)
3785
c = b.get_config_stack()
3787
c = _mod_config.GlobalStack()
3788
c.set('email', name)
3791
class cmd_nick(Command):
3792
__doc__ = """Print or set the branch nickname.
3794
If unset, the tree root directory name is used as the nickname.
3795
To print the current nickname, execute with no argument.
3797
Bound branches use the nickname of its master branch unless it is set
3801
_see_also = ['info']
3802
takes_args = ['nickname?']
3803
takes_options = ['directory']
3804
def run(self, nickname=None, directory=u'.'):
3805
branch = Branch.open_containing(directory)[0]
3806
if nickname is None:
3807
self.printme(branch)
3809
branch.nick = nickname
3812
def printme(self, branch):
3813
self.outf.write('%s\n' % branch.nick)
3816
class cmd_alias(Command):
3817
__doc__ = """Set/unset and display aliases.
3820
Show the current aliases::
3824
Show the alias specified for 'll'::
3828
Set an alias for 'll'::
3830
bzr alias ll="log --line -r-10..-1"
3832
To remove an alias for 'll'::
3834
bzr alias --remove ll
3837
takes_args = ['name?']
3839
Option('remove', help='Remove the alias.'),
3842
def run(self, name=None, remove=False):
3844
self.remove_alias(name)
3846
self.print_aliases()
3848
equal_pos = name.find('=')
3850
self.print_alias(name)
3852
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3854
def remove_alias(self, alias_name):
3855
if alias_name is None:
3856
raise errors.BzrCommandError(gettext(
3857
'bzr alias --remove expects an alias to remove.'))
3858
# If alias is not found, print something like:
3859
# unalias: foo: not found
3860
c = _mod_config.GlobalConfig()
3861
c.unset_alias(alias_name)
3864
def print_aliases(self):
3865
"""Print out the defined aliases in a similar format to bash."""
3866
aliases = _mod_config.GlobalConfig().get_aliases()
3867
for key, value in sorted(aliases.iteritems()):
3868
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3871
def print_alias(self, alias_name):
3872
from bzrlib.commands import get_alias
3873
alias = get_alias(alias_name)
3875
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3878
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3880
def set_alias(self, alias_name, alias_command):
3881
"""Save the alias in the global config."""
3882
c = _mod_config.GlobalConfig()
3883
c.set_alias(alias_name, alias_command)
3886
class cmd_selftest(Command):
3887
__doc__ = """Run internal test suite.
3889
If arguments are given, they are regular expressions that say which tests
3890
should run. Tests matching any expression are run, and other tests are
3893
Alternatively if --first is given, matching tests are run first and then
3894
all other tests are run. This is useful if you have been working in a
3895
particular area, but want to make sure nothing else was broken.
3897
If --exclude is given, tests that match that regular expression are
3898
excluded, regardless of whether they match --first or not.
3900
To help catch accidential dependencies between tests, the --randomize
3901
option is useful. In most cases, the argument used is the word 'now'.
3902
Note that the seed used for the random number generator is displayed
3903
when this option is used. The seed can be explicitly passed as the
3904
argument to this option if required. This enables reproduction of the
3905
actual ordering used if and when an order sensitive problem is encountered.
3907
If --list-only is given, the tests that would be run are listed. This is
3908
useful when combined with --first, --exclude and/or --randomize to
3909
understand their impact. The test harness reports "Listed nn tests in ..."
3910
instead of "Ran nn tests in ..." when list mode is enabled.
3912
If the global option '--no-plugins' is given, plugins are not loaded
3913
before running the selftests. This has two effects: features provided or
3914
modified by plugins will not be tested, and tests provided by plugins will
3917
Tests that need working space on disk use a common temporary directory,
3918
typically inside $TMPDIR or /tmp.
3920
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3921
into a pdb postmortem session.
3923
The --coverage=DIRNAME global option produces a report with covered code
3927
Run only tests relating to 'ignore'::
3931
Disable plugins and list tests as they're run::
3933
bzr --no-plugins selftest -v
3935
# NB: this is used from the class without creating an instance, which is
3936
# why it does not have a self parameter.
3937
def get_transport_type(typestring):
3938
"""Parse and return a transport specifier."""
3939
if typestring == "sftp":
3940
from bzrlib.tests import stub_sftp
3941
return stub_sftp.SFTPAbsoluteServer
3942
elif typestring == "memory":
3943
from bzrlib.tests import test_server
3944
return memory.MemoryServer
3945
elif typestring == "fakenfs":
3946
from bzrlib.tests import test_server
3947
return test_server.FakeNFSServer
3948
msg = "No known transport type %s. Supported types are: sftp\n" %\
3950
raise errors.BzrCommandError(msg)
3953
takes_args = ['testspecs*']
3954
takes_options = ['verbose',
3956
help='Stop when one test fails.',
3960
help='Use a different transport by default '
3961
'throughout the test suite.',
3962
type=get_transport_type),
3964
help='Run the benchmarks rather than selftests.',
3966
Option('lsprof-timed',
3967
help='Generate lsprof output for benchmarked'
3968
' sections of code.'),
3969
Option('lsprof-tests',
3970
help='Generate lsprof output for each test.'),
3972
help='Run all tests, but run specified tests first.',
3976
help='List the tests instead of running them.'),
3977
RegistryOption('parallel',
3978
help="Run the test suite in parallel.",
3979
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3980
value_switches=False,
3982
Option('randomize', type=str, argname="SEED",
3983
help='Randomize the order of tests using the given'
3984
' seed or "now" for the current time.'),
3985
ListOption('exclude', type=str, argname="PATTERN",
3987
help='Exclude tests that match this regular'
3990
help='Output test progress via subunit.'),
3991
Option('strict', help='Fail on missing dependencies or '
3993
Option('load-list', type=str, argname='TESTLISTFILE',
3994
help='Load a test id list from a text file.'),
3995
ListOption('debugflag', type=str, short_name='E',
3996
help='Turn on a selftest debug flag.'),
3997
ListOption('starting-with', type=str, argname='TESTID',
3998
param_name='starting_with', short_name='s',
4000
'Load only the tests starting with TESTID.'),
4002
help="By default we disable fsync and fdatasync"
4003
" while running the test suite.")
4005
encoding_type = 'replace'
4008
Command.__init__(self)
4009
self.additional_selftest_args = {}
4011
def run(self, testspecs_list=None, verbose=False, one=False,
4012
transport=None, benchmark=None,
4014
first=False, list_only=False,
4015
randomize=None, exclude=None, strict=False,
4016
load_list=None, debugflag=None, starting_with=None, subunit=False,
4017
parallel=None, lsprof_tests=False,
4020
# During selftest, disallow proxying, as it can cause severe
4021
# performance penalties and is only needed for thread
4022
# safety. The selftest command is assumed to not use threads
4023
# too heavily. The call should be as early as possible, as
4024
# error reporting for past duplicate imports won't have useful
4026
lazy_import.disallow_proxying()
4028
from bzrlib import tests
4030
if testspecs_list is not None:
4031
pattern = '|'.join(testspecs_list)
4036
from bzrlib.tests import SubUnitBzrRunner
4038
raise errors.BzrCommandError(gettext("subunit not available. subunit "
4039
"needs to be installed to use --subunit."))
4040
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
4041
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4042
# stdout, which would corrupt the subunit stream.
4043
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4044
# following code can be deleted when it's sufficiently deployed
4045
# -- vila/mgz 20100514
4046
if (sys.platform == "win32"
4047
and getattr(sys.stdout, 'fileno', None) is not None):
4049
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4051
self.additional_selftest_args.setdefault(
4052
'suite_decorators', []).append(parallel)
4054
raise errors.BzrCommandError(gettext(
4055
"--benchmark is no longer supported from bzr 2.2; "
4056
"use bzr-usertest instead"))
4057
test_suite_factory = None
4059
exclude_pattern = None
4061
exclude_pattern = '(' + '|'.join(exclude) + ')'
4063
self._disable_fsync()
4064
selftest_kwargs = {"verbose": verbose,
4066
"stop_on_failure": one,
4067
"transport": transport,
4068
"test_suite_factory": test_suite_factory,
4069
"lsprof_timed": lsprof_timed,
4070
"lsprof_tests": lsprof_tests,
4071
"matching_tests_first": first,
4072
"list_only": list_only,
4073
"random_seed": randomize,
4074
"exclude_pattern": exclude_pattern,
4076
"load_list": load_list,
4077
"debug_flags": debugflag,
4078
"starting_with": starting_with
4080
selftest_kwargs.update(self.additional_selftest_args)
4082
# Make deprecation warnings visible, unless -Werror is set
4083
cleanup = symbol_versioning.activate_deprecation_warnings(
4086
result = tests.selftest(**selftest_kwargs)
4089
return int(not result)
4091
def _disable_fsync(self):
4092
"""Change the 'os' functionality to not synchronize."""
4093
self._orig_fsync = getattr(os, 'fsync', None)
4094
if self._orig_fsync is not None:
4095
os.fsync = lambda filedes: None
4096
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4097
if self._orig_fdatasync is not None:
4098
os.fdatasync = lambda filedes: None
4101
class cmd_version(Command):
4102
__doc__ = """Show version of bzr."""
4104
encoding_type = 'replace'
4106
Option("short", help="Print just the version number."),
4110
def run(self, short=False):
4111
from bzrlib.version import show_version
4113
self.outf.write(bzrlib.version_string + '\n')
4115
show_version(to_file=self.outf)
4118
class cmd_rocks(Command):
4119
__doc__ = """Statement of optimism."""
4125
self.outf.write(gettext("It sure does!\n"))
4128
class cmd_find_merge_base(Command):
4129
__doc__ = """Find and print a base revision for merging two branches."""
4130
# TODO: Options to specify revisions on either side, as if
4131
# merging only part of the history.
4132
takes_args = ['branch', 'other']
4136
def run(self, branch, other):
4137
from bzrlib.revision import ensure_null
4139
branch1 = Branch.open_containing(branch)[0]
4140
branch2 = Branch.open_containing(other)[0]
4141
self.add_cleanup(branch1.lock_read().unlock)
4142
self.add_cleanup(branch2.lock_read().unlock)
4143
last1 = ensure_null(branch1.last_revision())
4144
last2 = ensure_null(branch2.last_revision())
4146
graph = branch1.repository.get_graph(branch2.repository)
4147
base_rev_id = graph.find_unique_lca(last1, last2)
4149
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4152
class cmd_merge(Command):
4153
__doc__ = """Perform a three-way merge.
4155
The source of the merge can be specified either in the form of a branch,
4156
or in the form of a path to a file containing a merge directive generated
4157
with bzr send. If neither is specified, the default is the upstream branch
4158
or the branch most recently merged using --remember. The source of the
4159
merge may also be specified in the form of a path to a file in another
4160
branch: in this case, only the modifications to that file are merged into
4161
the current working tree.
4163
When merging from a branch, by default bzr will try to merge in all new
4164
work from the other branch, automatically determining an appropriate base
4165
revision. If this fails, you may need to give an explicit base.
4167
To pick a different ending revision, pass "--revision OTHER". bzr will
4168
try to merge in all new work up to and including revision OTHER.
4170
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4171
through OTHER, excluding BASE but including OTHER, will be merged. If this
4172
causes some revisions to be skipped, i.e. if the destination branch does
4173
not already contain revision BASE, such a merge is commonly referred to as
4174
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4175
cherrypicks. The changes look like a normal commit, and the history of the
4176
changes from the other branch is not stored in the commit.
4178
Revision numbers are always relative to the source branch.
4180
Merge will do its best to combine the changes in two branches, but there
4181
are some kinds of problems only a human can fix. When it encounters those,
4182
it will mark a conflict. A conflict means that you need to fix something,
4183
before you should commit.
4185
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
4187
If there is no default branch set, the first merge will set it (use
4188
--no-remember to avoid setting it). After that, you can omit the branch
4189
to use the default. To change the default, use --remember. The value will
4190
only be saved if the remote location can be accessed.
4192
The results of the merge are placed into the destination working
4193
directory, where they can be reviewed (with bzr diff), tested, and then
4194
committed to record the result of the merge.
4196
merge refuses to run if there are any uncommitted changes, unless
4197
--force is given. If --force is given, then the changes from the source
4198
will be merged with the current working tree, including any uncommitted
4199
changes in the tree. The --force option can also be used to create a
4200
merge revision which has more than two parents.
4202
If one would like to merge changes from the working tree of the other
4203
branch without merging any committed revisions, the --uncommitted option
4206
To select only some changes to merge, use "merge -i", which will prompt
4207
you to apply each diff hunk and file change, similar to "shelve".
4210
To merge all new revisions from bzr.dev::
4212
bzr merge ../bzr.dev
4214
To merge changes up to and including revision 82 from bzr.dev::
4216
bzr merge -r 82 ../bzr.dev
4218
To merge the changes introduced by 82, without previous changes::
4220
bzr merge -r 81..82 ../bzr.dev
4222
To apply a merge directive contained in /tmp/merge::
4224
bzr merge /tmp/merge
4226
To create a merge revision with three parents from two branches
4227
feature1a and feature1b:
4229
bzr merge ../feature1a
4230
bzr merge ../feature1b --force
4231
bzr commit -m 'revision with three parents'
4234
encoding_type = 'exact'
4235
_see_also = ['update', 'remerge', 'status-flags', 'send']
4236
takes_args = ['location?']
4241
help='Merge even if the destination tree has uncommitted changes.'),
4245
Option('show-base', help="Show base revision text in "
4247
Option('uncommitted', help='Apply uncommitted changes'
4248
' from a working copy, instead of branch changes.'),
4249
Option('pull', help='If the destination is already'
4250
' completely merged into the source, pull from the'
4251
' source rather than merging. When this happens,'
4252
' you do not need to commit the result.'),
4253
custom_help('directory',
4254
help='Branch to merge into, '
4255
'rather than the one containing the working directory.'),
4256
Option('preview', help='Instead of merging, show a diff of the'
4258
Option('interactive', help='Select changes interactively.',
4262
def run(self, location=None, revision=None, force=False,
4263
merge_type=None, show_base=False, reprocess=None, remember=None,
4264
uncommitted=False, pull=False,
4269
if merge_type is None:
4270
merge_type = _mod_merge.Merge3Merger
4272
if directory is None: directory = u'.'
4273
possible_transports = []
4275
allow_pending = True
4276
verified = 'inapplicable'
4278
tree = WorkingTree.open_containing(directory)[0]
4279
if tree.branch.revno() == 0:
4280
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4281
'https://bugs.launchpad.net/bzr/+bug/308562'))
4284
basis_tree = tree.revision_tree(tree.last_revision())
4285
except errors.NoSuchRevision:
4286
basis_tree = tree.basis_tree()
4288
# die as quickly as possible if there are uncommitted changes
4290
if tree.has_changes():
4291
raise errors.UncommittedChanges(tree)
4293
view_info = _get_view_info_for_change_reporter(tree)
4294
change_reporter = delta._ChangeReporter(
4295
unversioned_filter=tree.is_ignored, view_info=view_info)
4296
pb = ui.ui_factory.nested_progress_bar()
4297
self.add_cleanup(pb.finished)
4298
self.add_cleanup(tree.lock_write().unlock)
4299
if location is not None:
4301
mergeable = bundle.read_mergeable_from_url(location,
4302
possible_transports=possible_transports)
4303
except errors.NotABundle:
4307
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4308
' with bundles or merge directives.'))
4310
if revision is not None:
4311
raise errors.BzrCommandError(gettext(
4312
'Cannot use -r with merge directives or bundles'))
4313
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4316
if merger is None and uncommitted:
4317
if revision is not None and len(revision) > 0:
4318
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4319
' --revision at the same time.'))
4320
merger = self.get_merger_from_uncommitted(tree, location, None)
4321
allow_pending = False
4324
merger, allow_pending = self._get_merger_from_branch(tree,
4325
location, revision, remember, possible_transports, None)
4327
merger.merge_type = merge_type
4328
merger.reprocess = reprocess
4329
merger.show_base = show_base
4330
self.sanity_check_merger(merger)
4331
if (merger.base_rev_id == merger.other_rev_id and
4332
merger.other_rev_id is not None):
4333
# check if location is a nonexistent file (and not a branch) to
4334
# disambiguate the 'Nothing to do'
4335
if merger.interesting_files:
4336
if not merger.other_tree.has_filename(
4337
merger.interesting_files[0]):
4338
note(gettext("merger: ") + str(merger))
4339
raise errors.PathsDoNotExist([location])
4340
note(gettext('Nothing to do.'))
4342
if pull and not preview:
4343
if merger.interesting_files is not None:
4344
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4345
if (merger.base_rev_id == tree.last_revision()):
4346
result = tree.pull(merger.other_branch, False,
4347
merger.other_rev_id)
4348
result.report(self.outf)
4350
if merger.this_basis is None:
4351
raise errors.BzrCommandError(gettext(
4352
"This branch has no commits."
4353
" (perhaps you would prefer 'bzr pull')"))
4355
return self._do_preview(merger)
4357
return self._do_interactive(merger)
4359
return self._do_merge(merger, change_reporter, allow_pending,
4362
def _get_preview(self, merger):
4363
tree_merger = merger.make_merger()
4364
tt = tree_merger.make_preview_transform()
4365
self.add_cleanup(tt.finalize)
4366
result_tree = tt.get_preview_tree()
4369
def _do_preview(self, merger):
4370
from bzrlib.diff import show_diff_trees
4371
result_tree = self._get_preview(merger)
4372
path_encoding = osutils.get_diff_header_encoding()
4373
show_diff_trees(merger.this_tree, result_tree, self.outf,
4374
old_label='', new_label='',
4375
path_encoding=path_encoding)
4377
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4378
merger.change_reporter = change_reporter
4379
conflict_count = merger.do_merge()
4381
merger.set_pending()
4382
if verified == 'failed':
4383
warning('Preview patch does not match changes')
4384
if conflict_count != 0:
4389
def _do_interactive(self, merger):
4390
"""Perform an interactive merge.
4392
This works by generating a preview tree of the merge, then using
4393
Shelver to selectively remove the differences between the working tree
4394
and the preview tree.
4396
from bzrlib import shelf_ui
4397
result_tree = self._get_preview(merger)
4398
writer = bzrlib.option.diff_writer_registry.get()
4399
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4400
reporter=shelf_ui.ApplyReporter(),
4401
diff_writer=writer(sys.stdout))
4407
def sanity_check_merger(self, merger):
4408
if (merger.show_base and
4409
not merger.merge_type is _mod_merge.Merge3Merger):
4410
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4411
" merge type. %s") % merger.merge_type)
4412
if merger.reprocess is None:
4413
if merger.show_base:
4414
merger.reprocess = False
4416
# Use reprocess if the merger supports it
4417
merger.reprocess = merger.merge_type.supports_reprocess
4418
if merger.reprocess and not merger.merge_type.supports_reprocess:
4419
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4420
" for merge type %s.") %
4422
if merger.reprocess and merger.show_base:
4423
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4426
def _get_merger_from_branch(self, tree, location, revision, remember,
4427
possible_transports, pb):
4428
"""Produce a merger from a location, assuming it refers to a branch."""
4429
from bzrlib.tag import _merge_tags_if_possible
4430
# find the branch locations
4431
other_loc, user_location = self._select_branch_location(tree, location,
4433
if revision is not None and len(revision) == 2:
4434
base_loc, _unused = self._select_branch_location(tree,
4435
location, revision, 0)
4437
base_loc = other_loc
4439
other_branch, other_path = Branch.open_containing(other_loc,
4440
possible_transports)
4441
if base_loc == other_loc:
4442
base_branch = other_branch
4444
base_branch, base_path = Branch.open_containing(base_loc,
4445
possible_transports)
4446
# Find the revision ids
4447
other_revision_id = None
4448
base_revision_id = None
4449
if revision is not None:
4450
if len(revision) >= 1:
4451
other_revision_id = revision[-1].as_revision_id(other_branch)
4452
if len(revision) == 2:
4453
base_revision_id = revision[0].as_revision_id(base_branch)
4454
if other_revision_id is None:
4455
other_revision_id = _mod_revision.ensure_null(
4456
other_branch.last_revision())
4457
# Remember where we merge from. We need to remember if:
4458
# - user specify a location (and we don't merge from the parent
4460
# - user ask to remember or there is no previous location set to merge
4461
# from and user didn't ask to *not* remember
4462
if (user_location is not None
4464
or (remember is None
4465
and tree.branch.get_submit_branch() is None)))):
4466
tree.branch.set_submit_branch(other_branch.base)
4467
# Merge tags (but don't set them in the master branch yet, the user
4468
# might revert this merge). Commit will propagate them.
4469
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4470
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4471
other_revision_id, base_revision_id, other_branch, base_branch)
4472
if other_path != '':
4473
allow_pending = False
4474
merger.interesting_files = [other_path]
4476
allow_pending = True
4477
return merger, allow_pending
4479
def get_merger_from_uncommitted(self, tree, location, pb):
4480
"""Get a merger for uncommitted changes.
4482
:param tree: The tree the merger should apply to.
4483
:param location: The location containing uncommitted changes.
4484
:param pb: The progress bar to use for showing progress.
4486
location = self._select_branch_location(tree, location)[0]
4487
other_tree, other_path = WorkingTree.open_containing(location)
4488
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4489
if other_path != '':
4490
merger.interesting_files = [other_path]
4493
def _select_branch_location(self, tree, user_location, revision=None,
4495
"""Select a branch location, according to possible inputs.
4497
If provided, branches from ``revision`` are preferred. (Both
4498
``revision`` and ``index`` must be supplied.)
4500
Otherwise, the ``location`` parameter is used. If it is None, then the
4501
``submit`` or ``parent`` location is used, and a note is printed.
4503
:param tree: The working tree to select a branch for merging into
4504
:param location: The location entered by the user
4505
:param revision: The revision parameter to the command
4506
:param index: The index to use for the revision parameter. Negative
4507
indices are permitted.
4508
:return: (selected_location, user_location). The default location
4509
will be the user-entered location.
4511
if (revision is not None and index is not None
4512
and revision[index] is not None):
4513
branch = revision[index].get_branch()
4514
if branch is not None:
4515
return branch, branch
4516
if user_location is None:
4517
location = self._get_remembered(tree, 'Merging from')
4519
location = user_location
4520
return location, user_location
4522
def _get_remembered(self, tree, verb_string):
4523
"""Use tree.branch's parent if none was supplied.
4525
Report if the remembered location was used.
4527
stored_location = tree.branch.get_submit_branch()
4528
stored_location_type = "submit"
4529
if stored_location is None:
4530
stored_location = tree.branch.get_parent()
4531
stored_location_type = "parent"
4532
mutter("%s", stored_location)
4533
if stored_location is None:
4534
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4535
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4536
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4537
stored_location_type, display_url))
4538
return stored_location
4541
class cmd_remerge(Command):
4542
__doc__ = """Redo a merge.
4544
Use this if you want to try a different merge technique while resolving
4545
conflicts. Some merge techniques are better than others, and remerge
4546
lets you try different ones on different files.
4548
The options for remerge have the same meaning and defaults as the ones for
4549
merge. The difference is that remerge can (only) be run when there is a
4550
pending merge, and it lets you specify particular files.
4553
Re-do the merge of all conflicted files, and show the base text in
4554
conflict regions, in addition to the usual THIS and OTHER texts::
4556
bzr remerge --show-base
4558
Re-do the merge of "foobar", using the weave merge algorithm, with
4559
additional processing to reduce the size of conflict regions::
4561
bzr remerge --merge-type weave --reprocess foobar
4563
takes_args = ['file*']
4568
help="Show base revision text in conflicts."),
4571
def run(self, file_list=None, merge_type=None, show_base=False,
4573
from bzrlib.conflicts import restore
4574
if merge_type is None:
4575
merge_type = _mod_merge.Merge3Merger
4576
tree, file_list = WorkingTree.open_containing_paths(file_list)
4577
self.add_cleanup(tree.lock_write().unlock)
4578
parents = tree.get_parent_ids()
4579
if len(parents) != 2:
4580
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4581
" merges. Not cherrypicking or"
4583
repository = tree.branch.repository
4584
interesting_ids = None
4586
conflicts = tree.conflicts()
4587
if file_list is not None:
4588
interesting_ids = set()
4589
for filename in file_list:
4590
file_id = tree.path2id(filename)
4592
raise errors.NotVersionedError(filename)
4593
interesting_ids.add(file_id)
4594
if tree.kind(file_id) != "directory":
4597
for name, ie in tree.inventory.iter_entries(file_id):
4598
interesting_ids.add(ie.file_id)
4599
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4601
# Remerge only supports resolving contents conflicts
4602
allowed_conflicts = ('text conflict', 'contents conflict')
4603
restore_files = [c.path for c in conflicts
4604
if c.typestring in allowed_conflicts]
4605
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4606
tree.set_conflicts(ConflictList(new_conflicts))
4607
if file_list is not None:
4608
restore_files = file_list
4609
for filename in restore_files:
4611
restore(tree.abspath(filename))
4612
except errors.NotConflicted:
4614
# Disable pending merges, because the file texts we are remerging
4615
# have not had those merges performed. If we use the wrong parents
4616
# list, we imply that the working tree text has seen and rejected
4617
# all the changes from the other tree, when in fact those changes
4618
# have not yet been seen.
4619
tree.set_parent_ids(parents[:1])
4621
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4622
merger.interesting_ids = interesting_ids
4623
merger.merge_type = merge_type
4624
merger.show_base = show_base
4625
merger.reprocess = reprocess
4626
conflicts = merger.do_merge()
4628
tree.set_parent_ids(parents)
4635
class cmd_revert(Command):
4636
__doc__ = """Revert files to a previous revision.
4638
Giving a list of files will revert only those files. Otherwise, all files
4639
will be reverted. If the revision is not specified with '--revision', the
4640
last committed revision is used.
4642
To remove only some changes, without reverting to a prior version, use
4643
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4644
will remove the changes introduced by the second last commit (-2), without
4645
affecting the changes introduced by the last commit (-1). To remove
4646
certain changes on a hunk-by-hunk basis, see the shelve command.
4648
By default, any files that have been manually changed will be backed up
4649
first. (Files changed only by merge are not backed up.) Backup files have
4650
'.~#~' appended to their name, where # is a number.
4652
When you provide files, you can use their current pathname or the pathname
4653
from the target revision. So you can use revert to "undelete" a file by
4654
name. If you name a directory, all the contents of that directory will be
4657
If you have newly added files since the target revision, they will be
4658
removed. If the files to be removed have been changed, backups will be
4659
created as above. Directories containing unknown files will not be
4662
The working tree contains a list of revisions that have been merged but
4663
not yet committed. These revisions will be included as additional parents
4664
of the next commit. Normally, using revert clears that list as well as
4665
reverting the files. If any files are specified, revert leaves the list
4666
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4667
.`` in the tree root to revert all files but keep the recorded merges,
4668
and ``bzr revert --forget-merges`` to clear the pending merge list without
4669
reverting any files.
4671
Using "bzr revert --forget-merges", it is possible to apply all of the
4672
changes from a branch in a single revision. To do this, perform the merge
4673
as desired. Then doing revert with the "--forget-merges" option will keep
4674
the content of the tree as it was, but it will clear the list of pending
4675
merges. The next commit will then contain all of the changes that are
4676
present in the other branch, but without any other parent revisions.
4677
Because this technique forgets where these changes originated, it may
4678
cause additional conflicts on later merges involving the same source and
4682
_see_also = ['cat', 'export', 'merge', 'shelve']
4685
Option('no-backup', "Do not save backups of reverted files."),
4686
Option('forget-merges',
4687
'Remove pending merge marker, without changing any files.'),
4689
takes_args = ['file*']
4691
def run(self, revision=None, no_backup=False, file_list=None,
4692
forget_merges=None):
4693
tree, file_list = WorkingTree.open_containing_paths(file_list)
4694
self.add_cleanup(tree.lock_tree_write().unlock)
4696
tree.set_parent_ids(tree.get_parent_ids()[:1])
4698
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4701
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4702
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4703
tree.revert(file_list, rev_tree, not no_backup, None,
4704
report_changes=True)
4707
class cmd_assert_fail(Command):
4708
__doc__ = """Test reporting of assertion failures"""
4709
# intended just for use in testing
4714
raise AssertionError("always fails")
4717
class cmd_help(Command):
4718
__doc__ = """Show help on a command or other topic.
4721
_see_also = ['topics']
4723
Option('long', 'Show help on all commands.'),
4725
takes_args = ['topic?']
4726
aliases = ['?', '--help', '-?', '-h']
4729
def run(self, topic=None, long=False):
4731
if topic is None and long:
4733
bzrlib.help.help(topic)
4736
class cmd_shell_complete(Command):
4737
__doc__ = """Show appropriate completions for context.
4739
For a list of all available commands, say 'bzr shell-complete'.
4741
takes_args = ['context?']
4746
def run(self, context=None):
4747
from bzrlib import shellcomplete
4748
shellcomplete.shellcomplete(context)
4751
class cmd_missing(Command):
4752
__doc__ = """Show unmerged/unpulled revisions between two branches.
4754
OTHER_BRANCH may be local or remote.
4756
To filter on a range of revisions, you can use the command -r begin..end
4757
-r revision requests a specific revision, -r ..end or -r begin.. are
4761
1 - some missing revisions
4762
0 - no missing revisions
4766
Determine the missing revisions between this and the branch at the
4767
remembered pull location::
4771
Determine the missing revisions between this and another branch::
4773
bzr missing http://server/branch
4775
Determine the missing revisions up to a specific revision on the other
4778
bzr missing -r ..-10
4780
Determine the missing revisions up to a specific revision on this
4783
bzr missing --my-revision ..-10
4786
_see_also = ['merge', 'pull']
4787
takes_args = ['other_branch?']
4790
Option('reverse', 'Reverse the order of revisions.'),
4792
'Display changes in the local branch only.'),
4793
Option('this' , 'Same as --mine-only.'),
4794
Option('theirs-only',
4795
'Display changes in the remote branch only.'),
4796
Option('other', 'Same as --theirs-only.'),
4800
custom_help('revision',
4801
help='Filter on other branch revisions (inclusive). '
4802
'See "help revisionspec" for details.'),
4803
Option('my-revision',
4804
type=_parse_revision_str,
4805
help='Filter on local branch revisions (inclusive). '
4806
'See "help revisionspec" for details.'),
4807
Option('include-merged',
4808
'Show all revisions in addition to the mainline ones.'),
4809
Option('include-merges', hidden=True,
4810
help='Historical alias for --include-merged.'),
4812
encoding_type = 'replace'
4815
def run(self, other_branch=None, reverse=False, mine_only=False,
4817
log_format=None, long=False, short=False, line=False,
4818
show_ids=False, verbose=False, this=False, other=False,
4819
include_merged=None, revision=None, my_revision=None,
4821
include_merges=symbol_versioning.DEPRECATED_PARAMETER):
4822
from bzrlib.missing import find_unmerged, iter_log_revisions
4827
if symbol_versioning.deprecated_passed(include_merges):
4828
ui.ui_factory.show_user_warning(
4829
'deprecated_command_option',
4830
deprecated_name='--include-merges',
4831
recommended_name='--include-merged',
4832
deprecated_in_version='2.5',
4833
command=self.invoked_as)
4834
if include_merged is None:
4835
include_merged = include_merges
4837
raise errors.BzrCommandError(gettext(
4838
'{0} and {1} are mutually exclusive').format(
4839
'--include-merges', '--include-merged'))
4840
if include_merged is None:
4841
include_merged = False
4846
# TODO: We should probably check that we don't have mine-only and
4847
# theirs-only set, but it gets complicated because we also have
4848
# this and other which could be used.
4855
local_branch = Branch.open_containing(directory)[0]
4856
self.add_cleanup(local_branch.lock_read().unlock)
4858
parent = local_branch.get_parent()
4859
if other_branch is None:
4860
other_branch = parent
4861
if other_branch is None:
4862
raise errors.BzrCommandError(gettext("No peer location known"
4864
display_url = urlutils.unescape_for_display(parent,
4866
message(gettext("Using saved parent location: {0}\n").format(
4869
remote_branch = Branch.open(other_branch)
4870
if remote_branch.base == local_branch.base:
4871
remote_branch = local_branch
4873
self.add_cleanup(remote_branch.lock_read().unlock)
4875
local_revid_range = _revision_range_to_revid_range(
4876
_get_revision_range(my_revision, local_branch,
4879
remote_revid_range = _revision_range_to_revid_range(
4880
_get_revision_range(revision,
4881
remote_branch, self.name()))
4883
local_extra, remote_extra = find_unmerged(
4884
local_branch, remote_branch, restrict,
4885
backward=not reverse,
4886
include_merged=include_merged,
4887
local_revid_range=local_revid_range,
4888
remote_revid_range=remote_revid_range)
4890
if log_format is None:
4891
registry = log.log_formatter_registry
4892
log_format = registry.get_default(local_branch)
4893
lf = log_format(to_file=self.outf,
4895
show_timezone='original')
4898
if local_extra and not theirs_only:
4899
message(ngettext("You have %d extra revision:\n",
4900
"You have %d extra revisions:\n",
4903
for revision in iter_log_revisions(local_extra,
4904
local_branch.repository,
4906
lf.log_revision(revision)
4907
printed_local = True
4910
printed_local = False
4912
if remote_extra and not mine_only:
4913
if printed_local is True:
4915
message(ngettext("You are missing %d revision:\n",
4916
"You are missing %d revisions:\n",
4917
len(remote_extra)) %
4919
for revision in iter_log_revisions(remote_extra,
4920
remote_branch.repository,
4922
lf.log_revision(revision)
4925
if mine_only and not local_extra:
4926
# We checked local, and found nothing extra
4927
message(gettext('This branch has no new revisions.\n'))
4928
elif theirs_only and not remote_extra:
4929
# We checked remote, and found nothing extra
4930
message(gettext('Other branch has no new revisions.\n'))
4931
elif not (mine_only or theirs_only or local_extra or
4933
# We checked both branches, and neither one had extra
4935
message(gettext("Branches are up to date.\n"))
4937
if not status_code and parent is None and other_branch is not None:
4938
self.add_cleanup(local_branch.lock_write().unlock)
4939
# handle race conditions - a parent might be set while we run.
4940
if local_branch.get_parent() is None:
4941
local_branch.set_parent(remote_branch.base)
4945
class cmd_pack(Command):
4946
__doc__ = """Compress the data within a repository.
4948
This operation compresses the data within a bazaar repository. As
4949
bazaar supports automatic packing of repository, this operation is
4950
normally not required to be done manually.
4952
During the pack operation, bazaar takes a backup of existing repository
4953
data, i.e. pack files. This backup is eventually removed by bazaar
4954
automatically when it is safe to do so. To save disk space by removing
4955
the backed up pack files, the --clean-obsolete-packs option may be
4958
Warning: If you use --clean-obsolete-packs and your machine crashes
4959
during or immediately after repacking, you may be left with a state
4960
where the deletion has been written to disk but the new packs have not
4961
been. In this case the repository may be unusable.
4964
_see_also = ['repositories']
4965
takes_args = ['branch_or_repo?']
4967
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4970
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4971
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
4973
branch = dir.open_branch()
4974
repository = branch.repository
4975
except errors.NotBranchError:
4976
repository = dir.open_repository()
4977
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4980
class cmd_plugins(Command):
4981
__doc__ = """List the installed plugins.
4983
This command displays the list of installed plugins including
4984
version of plugin and a short description of each.
4986
--verbose shows the path where each plugin is located.
4988
A plugin is an external component for Bazaar that extends the
4989
revision control system, by adding or replacing code in Bazaar.
4990
Plugins can do a variety of things, including overriding commands,
4991
adding new commands, providing additional network transports and
4992
customizing log output.
4994
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4995
for further information on plugins including where to find them and how to
4996
install them. Instructions are also provided there on how to write new
4997
plugins using the Python programming language.
4999
takes_options = ['verbose']
5002
def run(self, verbose=False):
5003
from bzrlib import plugin
5004
# Don't give writelines a generator as some codecs don't like that
5005
self.outf.writelines(
5006
list(plugin.describe_plugins(show_paths=verbose)))
5009
class cmd_testament(Command):
5010
__doc__ = """Show testament (signing-form) of a revision."""
5013
Option('long', help='Produce long-format testament.'),
5015
help='Produce a strict-format testament.')]
5016
takes_args = ['branch?']
5018
def run(self, branch=u'.', revision=None, long=False, strict=False):
5019
from bzrlib.testament import Testament, StrictTestament
5021
testament_class = StrictTestament
5023
testament_class = Testament
5025
b = Branch.open_containing(branch)[0]
5027
b = Branch.open(branch)
5028
self.add_cleanup(b.lock_read().unlock)
5029
if revision is None:
5030
rev_id = b.last_revision()
5032
rev_id = revision[0].as_revision_id(b)
5033
t = testament_class.from_revision(b.repository, rev_id)
5035
sys.stdout.writelines(t.as_text_lines())
5037
sys.stdout.write(t.as_short_text())
5040
class cmd_annotate(Command):
5041
__doc__ = """Show the origin of each line in a file.
5043
This prints out the given file with an annotation on the left side
5044
indicating which revision, author and date introduced the change.
5046
If the origin is the same for a run of consecutive lines, it is
5047
shown only at the top, unless the --all option is given.
5049
# TODO: annotate directories; showing when each file was last changed
5050
# TODO: if the working copy is modified, show annotations on that
5051
# with new uncommitted lines marked
5052
aliases = ['ann', 'blame', 'praise']
5053
takes_args = ['filename']
5054
takes_options = [Option('all', help='Show annotations on all lines.'),
5055
Option('long', help='Show commit date in annotations.'),
5060
encoding_type = 'exact'
5063
def run(self, filename, all=False, long=False, revision=None,
5064
show_ids=False, directory=None):
5065
from bzrlib.annotate import (
5068
wt, branch, relpath = \
5069
_open_directory_or_containing_tree_or_branch(filename, directory)
5071
self.add_cleanup(wt.lock_read().unlock)
5073
self.add_cleanup(branch.lock_read().unlock)
5074
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5075
self.add_cleanup(tree.lock_read().unlock)
5076
if wt is not None and revision is None:
5077
file_id = wt.path2id(relpath)
5079
file_id = tree.path2id(relpath)
5081
raise errors.NotVersionedError(filename)
5082
if wt is not None and revision is None:
5083
# If there is a tree and we're not annotating historical
5084
# versions, annotate the working tree's content.
5085
annotate_file_tree(wt, file_id, self.outf, long, all,
5088
annotate_file_tree(tree, file_id, self.outf, long, all,
5089
show_ids=show_ids, branch=branch)
5092
class cmd_re_sign(Command):
5093
__doc__ = """Create a digital signature for an existing revision."""
5094
# TODO be able to replace existing ones.
5096
hidden = True # is this right ?
5097
takes_args = ['revision_id*']
5098
takes_options = ['directory', 'revision']
5100
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5101
if revision_id_list is not None and revision is not None:
5102
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5103
if revision_id_list is None and revision is None:
5104
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5105
b = WorkingTree.open_containing(directory)[0].branch
5106
self.add_cleanup(b.lock_write().unlock)
5107
return self._run(b, revision_id_list, revision)
5109
def _run(self, b, revision_id_list, revision):
5110
import bzrlib.gpg as gpg
5111
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5112
if revision_id_list is not None:
5113
b.repository.start_write_group()
5115
for revision_id in revision_id_list:
5116
b.repository.sign_revision(revision_id, gpg_strategy)
5118
b.repository.abort_write_group()
5121
b.repository.commit_write_group()
5122
elif revision is not None:
5123
if len(revision) == 1:
5124
revno, rev_id = revision[0].in_history(b)
5125
b.repository.start_write_group()
5127
b.repository.sign_revision(rev_id, gpg_strategy)
5129
b.repository.abort_write_group()
5132
b.repository.commit_write_group()
5133
elif len(revision) == 2:
5134
# are they both on rh- if so we can walk between them
5135
# might be nice to have a range helper for arbitrary
5136
# revision paths. hmm.
5137
from_revno, from_revid = revision[0].in_history(b)
5138
to_revno, to_revid = revision[1].in_history(b)
5139
if to_revid is None:
5140
to_revno = b.revno()
5141
if from_revno is None or to_revno is None:
5142
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5143
b.repository.start_write_group()
5145
for revno in range(from_revno, to_revno + 1):
5146
b.repository.sign_revision(b.get_rev_id(revno),
5149
b.repository.abort_write_group()
5152
b.repository.commit_write_group()
5154
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5157
class cmd_bind(Command):
5158
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5159
If no branch is supplied, rebind to the last bound location.
5161
Once converted into a checkout, commits must succeed on the master branch
5162
before they will be applied to the local branch.
5164
Bound branches use the nickname of its master branch unless it is set
5165
locally, in which case binding will update the local nickname to be
5169
_see_also = ['checkouts', 'unbind']
5170
takes_args = ['location?']
5171
takes_options = ['directory']
5173
def run(self, location=None, directory=u'.'):
5174
b, relpath = Branch.open_containing(directory)
5175
if location is None:
5177
location = b.get_old_bound_location()
5178
except errors.UpgradeRequired:
5179
raise errors.BzrCommandError(gettext('No location supplied. '
5180
'This format does not remember old locations.'))
5182
if location is None:
5183
if b.get_bound_location() is not None:
5184
raise errors.BzrCommandError(
5185
gettext('Branch is already bound'))
5187
raise errors.BzrCommandError(
5188
gettext('No location supplied'
5189
' and no previous location known'))
5190
b_other = Branch.open(location)
5193
except errors.DivergedBranches:
5194
raise errors.BzrCommandError(gettext('These branches have diverged.'
5195
' Try merging, and then bind again.'))
5196
if b.get_config().has_explicit_nickname():
5197
b.nick = b_other.nick
5200
class cmd_unbind(Command):
5201
__doc__ = """Convert the current checkout into a regular branch.
5203
After unbinding, the local branch is considered independent and subsequent
5204
commits will be local only.
5207
_see_also = ['checkouts', 'bind']
5209
takes_options = ['directory']
5211
def run(self, directory=u'.'):
5212
b, relpath = Branch.open_containing(directory)
5214
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5217
class cmd_uncommit(Command):
5218
__doc__ = """Remove the last committed revision.
5220
--verbose will print out what is being removed.
5221
--dry-run will go through all the motions, but not actually
5224
If --revision is specified, uncommit revisions to leave the branch at the
5225
specified revision. For example, "bzr uncommit -r 15" will leave the
5226
branch at revision 15.
5228
Uncommit leaves the working tree ready for a new commit. The only change
5229
it may make is to restore any pending merges that were present before
5233
# TODO: jam 20060108 Add an option to allow uncommit to remove
5234
# unreferenced information in 'branch-as-repository' branches.
5235
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5236
# information in shared branches as well.
5237
_see_also = ['commit']
5238
takes_options = ['verbose', 'revision',
5239
Option('dry-run', help='Don\'t actually make changes.'),
5240
Option('force', help='Say yes to all questions.'),
5242
help='Keep tags that point to removed revisions.'),
5244
help="Only remove the commits from the local branch"
5245
" when in a checkout."
5248
takes_args = ['location?']
5250
encoding_type = 'replace'
5252
def run(self, location=None, dry_run=False, verbose=False,
5253
revision=None, force=False, local=False, keep_tags=False):
5254
if location is None:
5256
control, relpath = controldir.ControlDir.open_containing(location)
5258
tree = control.open_workingtree()
5260
except (errors.NoWorkingTree, errors.NotLocalUrl):
5262
b = control.open_branch()
5264
if tree is not None:
5265
self.add_cleanup(tree.lock_write().unlock)
5267
self.add_cleanup(b.lock_write().unlock)
5268
return self._run(b, tree, dry_run, verbose, revision, force,
5271
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5273
from bzrlib.log import log_formatter, show_log
5274
from bzrlib.uncommit import uncommit
5276
last_revno, last_rev_id = b.last_revision_info()
5279
if revision is None:
5281
rev_id = last_rev_id
5283
# 'bzr uncommit -r 10' actually means uncommit
5284
# so that the final tree is at revno 10.
5285
# but bzrlib.uncommit.uncommit() actually uncommits
5286
# the revisions that are supplied.
5287
# So we need to offset it by one
5288
revno = revision[0].in_history(b).revno + 1
5289
if revno <= last_revno:
5290
rev_id = b.get_rev_id(revno)
5292
if rev_id is None or _mod_revision.is_null(rev_id):
5293
self.outf.write(gettext('No revisions to uncommit.\n'))
5296
lf = log_formatter('short',
5298
show_timezone='original')
5303
direction='forward',
5304
start_revision=revno,
5305
end_revision=last_revno)
5308
self.outf.write(gettext('Dry-run, pretending to remove'
5309
' the above revisions.\n'))
5311
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5314
if not ui.ui_factory.confirm_action(
5315
gettext(u'Uncommit these revisions'),
5316
'bzrlib.builtins.uncommit',
5318
self.outf.write(gettext('Canceled\n'))
5321
mutter('Uncommitting from {%s} to {%s}',
5322
last_rev_id, rev_id)
5323
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5324
revno=revno, local=local, keep_tags=keep_tags)
5325
self.outf.write(gettext('You can restore the old tip by running:\n'
5326
' bzr pull . -r revid:%s\n') % last_rev_id)
5329
class cmd_break_lock(Command):
5330
__doc__ = """Break a dead lock.
5332
This command breaks a lock on a repository, branch, working directory or
5335
CAUTION: Locks should only be broken when you are sure that the process
5336
holding the lock has been stopped.
5338
You can get information on what locks are open via the 'bzr info
5339
[location]' command.
5343
bzr break-lock bzr+ssh://example.com/bzr/foo
5344
bzr break-lock --conf ~/.bazaar
5347
takes_args = ['location?']
5350
help='LOCATION is the directory where the config lock is.'),
5352
help='Do not ask for confirmation before breaking the lock.'),
5355
def run(self, location=None, config=False, force=False):
5356
if location is None:
5359
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5361
{'bzrlib.lockdir.break': True})
5363
conf = _mod_config.LockableConfig(file_name=location)
5366
control, relpath = controldir.ControlDir.open_containing(location)
5368
control.break_lock()
5369
except NotImplementedError:
5373
class cmd_wait_until_signalled(Command):
5374
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5376
This just prints a line to signal when it is ready, then blocks on stdin.
5382
sys.stdout.write("running\n")
5384
sys.stdin.readline()
5387
class cmd_serve(Command):
5388
__doc__ = """Run the bzr server."""
5390
aliases = ['server']
5394
help='Serve on stdin/out for use from inetd or sshd.'),
5395
RegistryOption('protocol',
5396
help="Protocol to serve.",
5397
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5398
value_switches=True),
5400
help='Listen for connections on nominated port of the form '
5401
'[hostname:]portnumber. Passing 0 as the port number will '
5402
'result in a dynamically allocated port. The default port '
5403
'depends on the protocol.',
5405
custom_help('directory',
5406
help='Serve contents of this directory.'),
5407
Option('allow-writes',
5408
help='By default the server is a readonly server. Supplying '
5409
'--allow-writes enables write access to the contents of '
5410
'the served directory and below. Note that ``bzr serve`` '
5411
'does not perform authentication, so unless some form of '
5412
'external authentication is arranged supplying this '
5413
'option leads to global uncontrolled write access to your '
5416
Option('client-timeout', type=float,
5417
help='Override the default idle client timeout (5min).'),
5420
def get_host_and_port(self, port):
5421
"""Return the host and port to run the smart server on.
5423
If 'port' is None, None will be returned for the host and port.
5425
If 'port' has a colon in it, the string before the colon will be
5426
interpreted as the host.
5428
:param port: A string of the port to run the server on.
5429
:return: A tuple of (host, port), where 'host' is a host name or IP,
5430
and port is an integer TCP/IP port.
5433
if port is not None:
5435
host, port = port.split(':')
5439
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5440
protocol=None, client_timeout=None):
5441
from bzrlib import transport
5442
if directory is None:
5443
directory = os.getcwd()
5444
if protocol is None:
5445
protocol = transport.transport_server_registry.get()
5446
host, port = self.get_host_and_port(port)
5447
url = transport.location_to_url(directory)
5448
if not allow_writes:
5449
url = 'readonly+' + url
5450
t = transport.get_transport_from_url(url)
5452
protocol(t, host, port, inet, client_timeout)
5453
except TypeError, e:
5454
# We use symbol_versioning.deprecated_in just so that people
5455
# grepping can find it here.
5456
# symbol_versioning.deprecated_in((2, 5, 0))
5457
symbol_versioning.warn(
5458
'Got TypeError(%s)\ntrying to call protocol: %s.%s\n'
5459
'Most likely it needs to be updated to support a'
5460
' "timeout" parameter (added in bzr 2.5.0)'
5461
% (e, protocol.__module__, protocol),
5463
protocol(t, host, port, inet)
5466
class cmd_join(Command):
5467
__doc__ = """Combine a tree into its containing tree.
5469
This command requires the target tree to be in a rich-root format.
5471
The TREE argument should be an independent tree, inside another tree, but
5472
not part of it. (Such trees can be produced by "bzr split", but also by
5473
running "bzr branch" with the target inside a tree.)
5475
The result is a combined tree, with the subtree no longer an independent
5476
part. This is marked as a merge of the subtree into the containing tree,
5477
and all history is preserved.
5480
_see_also = ['split']
5481
takes_args = ['tree']
5483
Option('reference', help='Join by reference.', hidden=True),
5486
def run(self, tree, reference=False):
5487
sub_tree = WorkingTree.open(tree)
5488
parent_dir = osutils.dirname(sub_tree.basedir)
5489
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5490
repo = containing_tree.branch.repository
5491
if not repo.supports_rich_root():
5492
raise errors.BzrCommandError(gettext(
5493
"Can't join trees because %s doesn't support rich root data.\n"
5494
"You can use bzr upgrade on the repository.")
5498
containing_tree.add_reference(sub_tree)
5499
except errors.BadReferenceTarget, e:
5500
# XXX: Would be better to just raise a nicely printable
5501
# exception from the real origin. Also below. mbp 20070306
5502
raise errors.BzrCommandError(
5503
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5506
containing_tree.subsume(sub_tree)
5507
except errors.BadSubsumeSource, e:
5508
raise errors.BzrCommandError(
5509
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5512
class cmd_split(Command):
5513
__doc__ = """Split a subdirectory of a tree into a separate tree.
5515
This command will produce a target tree in a format that supports
5516
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5517
converted into earlier formats like 'dirstate-tags'.
5519
The TREE argument should be a subdirectory of a working tree. That
5520
subdirectory will be converted into an independent tree, with its own
5521
branch. Commits in the top-level tree will not apply to the new subtree.
5524
_see_also = ['join']
5525
takes_args = ['tree']
5527
def run(self, tree):
5528
containing_tree, subdir = WorkingTree.open_containing(tree)
5529
sub_id = containing_tree.path2id(subdir)
5531
raise errors.NotVersionedError(subdir)
5533
containing_tree.extract(sub_id)
5534
except errors.RootNotRich:
5535
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5538
class cmd_merge_directive(Command):
5539
__doc__ = """Generate a merge directive for auto-merge tools.
5541
A directive requests a merge to be performed, and also provides all the
5542
information necessary to do so. This means it must either include a
5543
revision bundle, or the location of a branch containing the desired
5546
A submit branch (the location to merge into) must be supplied the first
5547
time the command is issued. After it has been supplied once, it will
5548
be remembered as the default.
5550
A public branch is optional if a revision bundle is supplied, but required
5551
if --diff or --plain is specified. It will be remembered as the default
5552
after the first use.
5555
takes_args = ['submit_branch?', 'public_branch?']
5559
_see_also = ['send']
5563
RegistryOption.from_kwargs('patch-type',
5564
'The type of patch to include in the directive.',
5566
value_switches=True,
5568
bundle='Bazaar revision bundle (default).',
5569
diff='Normal unified diff.',
5570
plain='No patch, just directive.'),
5571
Option('sign', help='GPG-sign the directive.'), 'revision',
5572
Option('mail-to', type=str,
5573
help='Instead of printing the directive, email to this address.'),
5574
Option('message', type=str, short_name='m',
5575
help='Message to use when committing this merge.')
5578
encoding_type = 'exact'
5580
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5581
sign=False, revision=None, mail_to=None, message=None,
5583
from bzrlib.revision import ensure_null, NULL_REVISION
5584
include_patch, include_bundle = {
5585
'plain': (False, False),
5586
'diff': (True, False),
5587
'bundle': (True, True),
5589
branch = Branch.open(directory)
5590
stored_submit_branch = branch.get_submit_branch()
5591
if submit_branch is None:
5592
submit_branch = stored_submit_branch
5594
if stored_submit_branch is None:
5595
branch.set_submit_branch(submit_branch)
5596
if submit_branch is None:
5597
submit_branch = branch.get_parent()
5598
if submit_branch is None:
5599
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5601
stored_public_branch = branch.get_public_branch()
5602
if public_branch is None:
5603
public_branch = stored_public_branch
5604
elif stored_public_branch is None:
5605
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5608
branch.set_public_branch(public_branch)
5611
if not include_bundle and public_branch is None:
5612
raise errors.BzrCommandError(gettext('No public branch specified or'
5614
base_revision_id = None
5615
if revision is not None:
5616
if len(revision) > 2:
5617
raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5618
'at most two one revision identifiers'))
5619
revision_id = revision[-1].as_revision_id(branch)
5620
if len(revision) == 2:
5621
base_revision_id = revision[0].as_revision_id(branch)
5623
revision_id = branch.last_revision()
5624
revision_id = ensure_null(revision_id)
5625
if revision_id == NULL_REVISION:
5626
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5627
directive = merge_directive.MergeDirective2.from_objects(
5628
branch.repository, revision_id, time.time(),
5629
osutils.local_time_offset(), submit_branch,
5630
public_branch=public_branch, include_patch=include_patch,
5631
include_bundle=include_bundle, message=message,
5632
base_revision_id=base_revision_id)
5635
self.outf.write(directive.to_signed(branch))
5637
self.outf.writelines(directive.to_lines())
5639
message = directive.to_email(mail_to, branch, sign)
5640
s = SMTPConnection(branch.get_config_stack())
5641
s.send_email(message)
5644
class cmd_send(Command):
5645
__doc__ = """Mail or create a merge-directive for submitting changes.
5647
A merge directive provides many things needed for requesting merges:
5649
* A machine-readable description of the merge to perform
5651
* An optional patch that is a preview of the changes requested
5653
* An optional bundle of revision data, so that the changes can be applied
5654
directly from the merge directive, without retrieving data from a
5657
`bzr send` creates a compact data set that, when applied using bzr
5658
merge, has the same effect as merging from the source branch.
5660
By default the merge directive is self-contained and can be applied to any
5661
branch containing submit_branch in its ancestory without needing access to
5664
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5665
revisions, but only a structured request to merge from the
5666
public_location. In that case the public_branch is needed and it must be
5667
up-to-date and accessible to the recipient. The public_branch is always
5668
included if known, so that people can check it later.
5670
The submit branch defaults to the parent of the source branch, but can be
5671
overridden. Both submit branch and public branch will be remembered in
5672
branch.conf the first time they are used for a particular branch. The
5673
source branch defaults to that containing the working directory, but can
5674
be changed using --from.
5676
Both the submit branch and the public branch follow the usual behavior with
5677
respect to --remember: If there is no default location set, the first send
5678
will set it (use --no-remember to avoid setting it). After that, you can
5679
omit the location to use the default. To change the default, use
5680
--remember. The value will only be saved if the location can be accessed.
5682
In order to calculate those changes, bzr must analyse the submit branch.
5683
Therefore it is most efficient for the submit branch to be a local mirror.
5684
If a public location is known for the submit_branch, that location is used
5685
in the merge directive.
5687
The default behaviour is to send the merge directive by mail, unless -o is
5688
given, in which case it is sent to a file.
5690
Mail is sent using your preferred mail program. This should be transparent
5691
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5692
If the preferred client can't be found (or used), your editor will be used.
5694
To use a specific mail program, set the mail_client configuration option.
5695
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5696
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5697
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5698
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5701
If mail is being sent, a to address is required. This can be supplied
5702
either on the commandline, by setting the submit_to configuration
5703
option in the branch itself or the child_submit_to configuration option
5704
in the submit branch.
5706
Two formats are currently supported: "4" uses revision bundle format 4 and
5707
merge directive format 2. It is significantly faster and smaller than
5708
older formats. It is compatible with Bazaar 0.19 and later. It is the
5709
default. "0.9" uses revision bundle format 0.9 and merge directive
5710
format 1. It is compatible with Bazaar 0.12 - 0.18.
5712
The merge directives created by bzr send may be applied using bzr merge or
5713
bzr pull by specifying a file containing a merge directive as the location.
5715
bzr send makes extensive use of public locations to map local locations into
5716
URLs that can be used by other people. See `bzr help configuration` to
5717
set them, and use `bzr info` to display them.
5720
encoding_type = 'exact'
5722
_see_also = ['merge', 'pull']
5724
takes_args = ['submit_branch?', 'public_branch?']
5728
help='Do not include a bundle in the merge directive.'),
5729
Option('no-patch', help='Do not include a preview patch in the merge'
5732
help='Remember submit and public branch.'),
5734
help='Branch to generate the submission from, '
5735
'rather than the one containing the working directory.',
5738
Option('output', short_name='o',
5739
help='Write merge directive to this file or directory; '
5740
'use - for stdout.',
5743
help='Refuse to send if there are uncommitted changes in'
5744
' the working tree, --no-strict disables the check.'),
5745
Option('mail-to', help='Mail the request to this address.',
5749
Option('body', help='Body for the email.', type=unicode),
5750
RegistryOption('format',
5751
help='Use the specified output format.',
5752
lazy_registry=('bzrlib.send', 'format_registry')),
5755
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5756
no_patch=False, revision=None, remember=None, output=None,
5757
format=None, mail_to=None, message=None, body=None,
5758
strict=None, **kwargs):
5759
from bzrlib.send import send
5760
return send(submit_branch, revision, public_branch, remember,
5761
format, no_bundle, no_patch, output,
5762
kwargs.get('from', '.'), mail_to, message, body,
5767
class cmd_bundle_revisions(cmd_send):
5768
__doc__ = """Create a merge-directive for submitting changes.
5770
A merge directive provides many things needed for requesting merges:
5772
* A machine-readable description of the merge to perform
5774
* An optional patch that is a preview of the changes requested
5776
* An optional bundle of revision data, so that the changes can be applied
5777
directly from the merge directive, without retrieving data from a
5780
If --no-bundle is specified, then public_branch is needed (and must be
5781
up-to-date), so that the receiver can perform the merge using the
5782
public_branch. The public_branch is always included if known, so that
5783
people can check it later.
5785
The submit branch defaults to the parent, but can be overridden. Both
5786
submit branch and public branch will be remembered if supplied.
5788
If a public_branch is known for the submit_branch, that public submit
5789
branch is used in the merge instructions. This means that a local mirror
5790
can be used as your actual submit branch, once you have set public_branch
5793
Two formats are currently supported: "4" uses revision bundle format 4 and
5794
merge directive format 2. It is significantly faster and smaller than
5795
older formats. It is compatible with Bazaar 0.19 and later. It is the
5796
default. "0.9" uses revision bundle format 0.9 and merge directive
5797
format 1. It is compatible with Bazaar 0.12 - 0.18.
5802
help='Do not include a bundle in the merge directive.'),
5803
Option('no-patch', help='Do not include a preview patch in the merge'
5806
help='Remember submit and public branch.'),
5808
help='Branch to generate the submission from, '
5809
'rather than the one containing the working directory.',
5812
Option('output', short_name='o', help='Write directive to this file.',
5815
help='Refuse to bundle revisions if there are uncommitted'
5816
' changes in the working tree, --no-strict disables the check.'),
5818
RegistryOption('format',
5819
help='Use the specified output format.',
5820
lazy_registry=('bzrlib.send', 'format_registry')),
5822
aliases = ['bundle']
5824
_see_also = ['send', 'merge']
5828
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5829
no_patch=False, revision=None, remember=False, output=None,
5830
format=None, strict=None, **kwargs):
5833
from bzrlib.send import send
5834
return send(submit_branch, revision, public_branch, remember,
5835
format, no_bundle, no_patch, output,
5836
kwargs.get('from', '.'), None, None, None,
5837
self.outf, strict=strict)
5840
class cmd_tag(Command):
5841
__doc__ = """Create, remove or modify a tag naming a revision.
5843
Tags give human-meaningful names to revisions. Commands that take a -r
5844
(--revision) option can be given -rtag:X, where X is any previously
5847
Tags are stored in the branch. Tags are copied from one branch to another
5848
along when you branch, push, pull or merge.
5850
It is an error to give a tag name that already exists unless you pass
5851
--force, in which case the tag is moved to point to the new revision.
5853
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5854
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5856
If no tag name is specified it will be determined through the
5857
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5858
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5862
_see_also = ['commit', 'tags']
5863
takes_args = ['tag_name?']
5866
help='Delete this tag rather than placing it.',
5868
custom_help('directory',
5869
help='Branch in which to place the tag.'),
5871
help='Replace existing tags.',
5876
def run(self, tag_name=None,
5882
branch, relpath = Branch.open_containing(directory)
5883
self.add_cleanup(branch.lock_write().unlock)
5885
if tag_name is None:
5886
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5887
branch.tags.delete_tag(tag_name)
5888
note(gettext('Deleted tag %s.') % tag_name)
5891
if len(revision) != 1:
5892
raise errors.BzrCommandError(gettext(
5893
"Tags can only be placed on a single revision, "
5895
revision_id = revision[0].as_revision_id(branch)
5897
revision_id = branch.last_revision()
5898
if tag_name is None:
5899
tag_name = branch.automatic_tag_name(revision_id)
5900
if tag_name is None:
5901
raise errors.BzrCommandError(gettext(
5902
"Please specify a tag name."))
5904
existing_target = branch.tags.lookup_tag(tag_name)
5905
except errors.NoSuchTag:
5906
existing_target = None
5907
if not force and existing_target not in (None, revision_id):
5908
raise errors.TagAlreadyExists(tag_name)
5909
if existing_target == revision_id:
5910
note(gettext('Tag %s already exists for that revision.') % tag_name)
5912
branch.tags.set_tag(tag_name, revision_id)
5913
if existing_target is None:
5914
note(gettext('Created tag %s.') % tag_name)
5916
note(gettext('Updated tag %s.') % tag_name)
5919
class cmd_tags(Command):
5920
__doc__ = """List tags.
5922
This command shows a table of tag names and the revisions they reference.
5927
custom_help('directory',
5928
help='Branch whose tags should be displayed.'),
5929
RegistryOption('sort',
5930
'Sort tags by different criteria.', title='Sorting',
5931
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5938
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5939
from bzrlib.tag import tag_sort_methods
5940
branch, relpath = Branch.open_containing(directory)
5942
tags = branch.tags.get_tag_dict().items()
5946
self.add_cleanup(branch.lock_read().unlock)
5948
# Restrict to the specified range
5949
tags = self._tags_for_range(branch, revision)
5951
sort = tag_sort_methods.get()
5954
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5955
for index, (tag, revid) in enumerate(tags):
5957
revno = branch.revision_id_to_dotted_revno(revid)
5958
if isinstance(revno, tuple):
5959
revno = '.'.join(map(str, revno))
5960
except (errors.NoSuchRevision,
5961
errors.GhostRevisionsHaveNoRevno,
5962
errors.UnsupportedOperation):
5963
# Bad tag data/merges can lead to tagged revisions
5964
# which are not in this branch. Fail gracefully ...
5966
tags[index] = (tag, revno)
5968
for tag, revspec in tags:
5969
self.outf.write('%-20s %s\n' % (tag, revspec))
5971
def _tags_for_range(self, branch, revision):
5973
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5974
revid1, revid2 = rev1.rev_id, rev2.rev_id
5975
# _get_revision_range will always set revid2 if it's not specified.
5976
# If revid1 is None, it means we want to start from the branch
5977
# origin which is always a valid ancestor. If revid1 == revid2, the
5978
# ancestry check is useless.
5979
if revid1 and revid1 != revid2:
5980
# FIXME: We really want to use the same graph than
5981
# branch.iter_merge_sorted_revisions below, but this is not
5982
# easily available -- vila 2011-09-23
5983
if branch.repository.get_graph().is_ancestor(revid2, revid1):
5984
# We don't want to output anything in this case...
5986
# only show revisions between revid1 and revid2 (inclusive)
5987
tagged_revids = branch.tags.get_reverse_tag_dict()
5989
for r in branch.iter_merge_sorted_revisions(
5990
start_revision_id=revid2, stop_revision_id=revid1,
5991
stop_rule='include'):
5992
revid_tags = tagged_revids.get(r[0], None)
5994
found.extend([(tag, r[0]) for tag in revid_tags])
5998
class cmd_reconfigure(Command):
5999
__doc__ = """Reconfigure the type of a bzr directory.
6001
A target configuration must be specified.
6003
For checkouts, the bind-to location will be auto-detected if not specified.
6004
The order of preference is
6005
1. For a lightweight checkout, the current bound location.
6006
2. For branches that used to be checkouts, the previously-bound location.
6007
3. The push location.
6008
4. The parent location.
6009
If none of these is available, --bind-to must be specified.
6012
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6013
takes_args = ['location?']
6015
RegistryOption.from_kwargs(
6018
help='The relation between branch and tree.',
6019
value_switches=True, enum_switch=False,
6020
branch='Reconfigure to be an unbound branch with no working tree.',
6021
tree='Reconfigure to be an unbound branch with a working tree.',
6022
checkout='Reconfigure to be a bound branch with a working tree.',
6023
lightweight_checkout='Reconfigure to be a lightweight'
6024
' checkout (with no local history).',
6026
RegistryOption.from_kwargs(
6028
title='Repository type',
6029
help='Location fo the repository.',
6030
value_switches=True, enum_switch=False,
6031
standalone='Reconfigure to be a standalone branch '
6032
'(i.e. stop using shared repository).',
6033
use_shared='Reconfigure to use a shared repository.',
6035
RegistryOption.from_kwargs(
6037
title='Trees in Repository',
6038
help='Whether new branches in the repository have trees.',
6039
value_switches=True, enum_switch=False,
6040
with_trees='Reconfigure repository to create '
6041
'working trees on branches by default.',
6042
with_no_trees='Reconfigure repository to not create '
6043
'working trees on branches by default.'
6045
Option('bind-to', help='Branch to bind checkout to.', type=str),
6047
help='Perform reconfiguration even if local changes'
6049
Option('stacked-on',
6050
help='Reconfigure a branch to be stacked on another branch.',
6054
help='Reconfigure a branch to be unstacked. This '
6055
'may require copying substantial data into it.',
6059
def run(self, location=None, bind_to=None, force=False,
6060
tree_type=None, repository_type=None, repository_trees=None,
6061
stacked_on=None, unstacked=None):
6062
directory = controldir.ControlDir.open(location)
6063
if stacked_on and unstacked:
6064
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6065
elif stacked_on is not None:
6066
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6068
reconfigure.ReconfigureUnstacked().apply(directory)
6069
# At the moment you can use --stacked-on and a different
6070
# reconfiguration shape at the same time; there seems no good reason
6072
if (tree_type is None and
6073
repository_type is None and
6074
repository_trees is None):
6075
if stacked_on or unstacked:
6078
raise errors.BzrCommandError(gettext('No target configuration '
6080
reconfiguration = None
6081
if tree_type == 'branch':
6082
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6083
elif tree_type == 'tree':
6084
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6085
elif tree_type == 'checkout':
6086
reconfiguration = reconfigure.Reconfigure.to_checkout(
6088
elif tree_type == 'lightweight-checkout':
6089
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6092
reconfiguration.apply(force)
6093
reconfiguration = None
6094
if repository_type == 'use-shared':
6095
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6096
elif repository_type == 'standalone':
6097
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6099
reconfiguration.apply(force)
6100
reconfiguration = None
6101
if repository_trees == 'with-trees':
6102
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6104
elif repository_trees == 'with-no-trees':
6105
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6108
reconfiguration.apply(force)
6109
reconfiguration = None
6112
class cmd_switch(Command):
6113
__doc__ = """Set the branch of a checkout and update.
6115
For lightweight checkouts, this changes the branch being referenced.
6116
For heavyweight checkouts, this checks that there are no local commits
6117
versus the current bound branch, then it makes the local branch a mirror
6118
of the new location and binds to it.
6120
In both cases, the working tree is updated and uncommitted changes
6121
are merged. The user can commit or revert these as they desire.
6123
Pending merges need to be committed or reverted before using switch.
6125
The path to the branch to switch to can be specified relative to the parent
6126
directory of the current branch. For example, if you are currently in a
6127
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6130
Bound branches use the nickname of its master branch unless it is set
6131
locally, in which case switching will update the local nickname to be
6135
takes_args = ['to_location?']
6136
takes_options = ['directory',
6138
help='Switch even if local commits will be lost.'),
6140
Option('create-branch', short_name='b',
6141
help='Create the target branch from this one before'
6142
' switching to it.'),
6145
def run(self, to_location=None, force=False, create_branch=False,
6146
revision=None, directory=u'.'):
6147
from bzrlib import switch
6148
tree_location = directory
6149
revision = _get_one_revision('switch', revision)
6150
control_dir = controldir.ControlDir.open_containing(tree_location)[0]
6151
if to_location is None:
6152
if revision is None:
6153
raise errors.BzrCommandError(gettext('You must supply either a'
6154
' revision or a location'))
6155
to_location = tree_location
6157
branch = control_dir.open_branch()
6158
had_explicit_nick = branch.get_config().has_explicit_nickname()
6159
except errors.NotBranchError:
6161
had_explicit_nick = False
6164
raise errors.BzrCommandError(gettext('cannot create branch without'
6166
to_location = directory_service.directories.dereference(
6168
if '/' not in to_location and '\\' not in to_location:
6169
# This path is meant to be relative to the existing branch
6170
this_url = self._get_branch_location(control_dir)
6171
# Perhaps the target control dir supports colocated branches?
6173
root = controldir.ControlDir.open(this_url,
6174
possible_transports=[control_dir.user_transport])
6175
except errors.NotBranchError:
6178
colocated = root._format.colocated_branches
6180
to_location = urlutils.join_segment_parameters(this_url,
6181
{"branch": urlutils.escape(to_location)})
6183
to_location = urlutils.join(
6184
this_url, '..', urlutils.escape(to_location))
6185
to_branch = branch.bzrdir.sprout(to_location,
6186
possible_transports=[branch.bzrdir.root_transport],
6187
source_branch=branch).open_branch()
6189
# Perhaps it's a colocated branch?
6191
to_branch = control_dir.open_branch(to_location)
6192
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
6194
to_branch = Branch.open(to_location)
6195
except errors.NotBranchError:
6196
this_url = self._get_branch_location(control_dir)
6197
to_branch = Branch.open(
6199
this_url, '..', urlutils.escape(to_location)))
6200
if revision is not None:
6201
revision = revision.as_revision_id(to_branch)
6202
switch.switch(control_dir, to_branch, force, revision_id=revision)
6203
if had_explicit_nick:
6204
branch = control_dir.open_branch() #get the new branch!
6205
branch.nick = to_branch.nick
6206
note(gettext('Switched to branch: %s'),
6207
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6209
def _get_branch_location(self, control_dir):
6210
"""Return location of branch for this control dir."""
6212
this_branch = control_dir.open_branch()
6213
# This may be a heavy checkout, where we want the master branch
6214
master_location = this_branch.get_bound_location()
6215
if master_location is not None:
6216
return master_location
6217
# If not, use a local sibling
6218
return this_branch.base
6219
except errors.NotBranchError:
6220
format = control_dir.find_branch_format()
6221
if getattr(format, 'get_reference', None) is not None:
6222
return format.get_reference(control_dir)
6224
return control_dir.root_transport.base
6227
class cmd_view(Command):
6228
__doc__ = """Manage filtered views.
6230
Views provide a mask over the tree so that users can focus on
6231
a subset of a tree when doing their work. After creating a view,
6232
commands that support a list of files - status, diff, commit, etc -
6233
effectively have that list of files implicitly given each time.
6234
An explicit list of files can still be given but those files
6235
must be within the current view.
6237
In most cases, a view has a short life-span: it is created to make
6238
a selected change and is deleted once that change is committed.
6239
At other times, you may wish to create one or more named views
6240
and switch between them.
6242
To disable the current view without deleting it, you can switch to
6243
the pseudo view called ``off``. This can be useful when you need
6244
to see the whole tree for an operation or two (e.g. merge) but
6245
want to switch back to your view after that.
6248
To define the current view::
6250
bzr view file1 dir1 ...
6252
To list the current view::
6256
To delete the current view::
6260
To disable the current view without deleting it::
6262
bzr view --switch off
6264
To define a named view and switch to it::
6266
bzr view --name view-name file1 dir1 ...
6268
To list a named view::
6270
bzr view --name view-name
6272
To delete a named view::
6274
bzr view --name view-name --delete
6276
To switch to a named view::
6278
bzr view --switch view-name
6280
To list all views defined::
6284
To delete all views::
6286
bzr view --delete --all
6290
takes_args = ['file*']
6293
help='Apply list or delete action to all views.',
6296
help='Delete the view.',
6299
help='Name of the view to define, list or delete.',
6303
help='Name of the view to switch to.',
6308
def run(self, file_list,
6314
tree, file_list = WorkingTree.open_containing_paths(file_list,
6316
current_view, view_dict = tree.views.get_view_info()
6321
raise errors.BzrCommandError(gettext(
6322
"Both --delete and a file list specified"))
6324
raise errors.BzrCommandError(gettext(
6325
"Both --delete and --switch specified"))
6327
tree.views.set_view_info(None, {})
6328
self.outf.write(gettext("Deleted all views.\n"))
6330
raise errors.BzrCommandError(gettext("No current view to delete"))
6332
tree.views.delete_view(name)
6333
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6336
raise errors.BzrCommandError(gettext(
6337
"Both --switch and a file list specified"))
6339
raise errors.BzrCommandError(gettext(
6340
"Both --switch and --all specified"))
6341
elif switch == 'off':
6342
if current_view is None:
6343
raise errors.BzrCommandError(gettext("No current view to disable"))
6344
tree.views.set_view_info(None, view_dict)
6345
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6347
tree.views.set_view_info(switch, view_dict)
6348
view_str = views.view_display_str(tree.views.lookup_view())
6349
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6352
self.outf.write(gettext('Views defined:\n'))
6353
for view in sorted(view_dict):
6354
if view == current_view:
6358
view_str = views.view_display_str(view_dict[view])
6359
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6361
self.outf.write(gettext('No views defined.\n'))
6364
# No name given and no current view set
6367
raise errors.BzrCommandError(gettext(
6368
"Cannot change the 'off' pseudo view"))
6369
tree.views.set_view(name, sorted(file_list))
6370
view_str = views.view_display_str(tree.views.lookup_view())
6371
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6375
# No name given and no current view set
6376
self.outf.write(gettext('No current view.\n'))
6378
view_str = views.view_display_str(tree.views.lookup_view(name))
6379
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6382
class cmd_hooks(Command):
6383
__doc__ = """Show hooks."""
6388
for hook_key in sorted(hooks.known_hooks.keys()):
6389
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6390
self.outf.write("%s:\n" % type(some_hooks).__name__)
6391
for hook_name, hook_point in sorted(some_hooks.items()):
6392
self.outf.write(" %s:\n" % (hook_name,))
6393
found_hooks = list(hook_point)
6395
for hook in found_hooks:
6396
self.outf.write(" %s\n" %
6397
(some_hooks.get_hook_name(hook),))
6399
self.outf.write(gettext(" <no hooks installed>\n"))
6402
class cmd_remove_branch(Command):
6403
__doc__ = """Remove a branch.
6405
This will remove the branch from the specified location but
6406
will keep any working tree or repository in place.
6410
Remove the branch at repo/trunk::
6412
bzr remove-branch repo/trunk
6416
takes_args = ["location?"]
6418
aliases = ["rmbranch"]
6420
def run(self, location=None):
6421
if location is None:
6423
branch = Branch.open_containing(location)[0]
6424
branch.bzrdir.destroy_branch()
6427
class cmd_shelve(Command):
6428
__doc__ = """Temporarily set aside some changes from the current tree.
6430
Shelve allows you to temporarily put changes you've made "on the shelf",
6431
ie. out of the way, until a later time when you can bring them back from
6432
the shelf with the 'unshelve' command. The changes are stored alongside
6433
your working tree, and so they aren't propagated along with your branch nor
6434
will they survive its deletion.
6436
If shelve --list is specified, previously-shelved changes are listed.
6438
Shelve is intended to help separate several sets of changes that have
6439
been inappropriately mingled. If you just want to get rid of all changes
6440
and you don't need to restore them later, use revert. If you want to
6441
shelve all text changes at once, use shelve --all.
6443
If filenames are specified, only the changes to those files will be
6444
shelved. Other files will be left untouched.
6446
If a revision is specified, changes since that revision will be shelved.
6448
You can put multiple items on the shelf, and by default, 'unshelve' will
6449
restore the most recently shelved changes.
6451
For complicated changes, it is possible to edit the changes in a separate
6452
editor program to decide what the file remaining in the working copy
6453
should look like. To do this, add the configuration option
6455
change_editor = PROGRAM @new_path @old_path
6457
where @new_path is replaced with the path of the new version of the
6458
file and @old_path is replaced with the path of the old version of
6459
the file. The PROGRAM should save the new file with the desired
6460
contents of the file in the working tree.
6464
takes_args = ['file*']
6469
Option('all', help='Shelve all changes.'),
6471
RegistryOption('writer', 'Method to use for writing diffs.',
6472
bzrlib.option.diff_writer_registry,
6473
value_switches=True, enum_switch=False),
6475
Option('list', help='List shelved changes.'),
6477
help='Destroy removed changes instead of shelving them.'),
6479
_see_also = ['unshelve', 'configuration']
6481
def run(self, revision=None, all=False, file_list=None, message=None,
6482
writer=None, list=False, destroy=False, directory=None):
6484
return self.run_for_list(directory=directory)
6485
from bzrlib.shelf_ui import Shelver
6487
writer = bzrlib.option.diff_writer_registry.get()
6489
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6490
file_list, message, destroy=destroy, directory=directory)
6495
except errors.UserAbort:
6498
def run_for_list(self, directory=None):
6499
if directory is None:
6501
tree = WorkingTree.open_containing(directory)[0]
6502
self.add_cleanup(tree.lock_read().unlock)
6503
manager = tree.get_shelf_manager()
6504
shelves = manager.active_shelves()
6505
if len(shelves) == 0:
6506
note(gettext('No shelved changes.'))
6508
for shelf_id in reversed(shelves):
6509
message = manager.get_metadata(shelf_id).get('message')
6511
message = '<no message>'
6512
self.outf.write('%3d: %s\n' % (shelf_id, message))
6516
class cmd_unshelve(Command):
6517
__doc__ = """Restore shelved changes.
6519
By default, the most recently shelved changes are restored. However if you
6520
specify a shelf by id those changes will be restored instead. This works
6521
best when the changes don't depend on each other.
6524
takes_args = ['shelf_id?']
6527
RegistryOption.from_kwargs(
6528
'action', help="The action to perform.",
6529
enum_switch=False, value_switches=True,
6530
apply="Apply changes and remove from the shelf.",
6531
dry_run="Show changes, but do not apply or remove them.",
6532
preview="Instead of unshelving the changes, show the diff that "
6533
"would result from unshelving.",
6534
delete_only="Delete changes without applying them.",
6535
keep="Apply changes but don't delete them.",
6538
_see_also = ['shelve']
6540
def run(self, shelf_id=None, action='apply', directory=u'.'):
6541
from bzrlib.shelf_ui import Unshelver
6542
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6546
unshelver.tree.unlock()
6549
class cmd_clean_tree(Command):
6550
__doc__ = """Remove unwanted files from working tree.
6552
By default, only unknown files, not ignored files, are deleted. Versioned
6553
files are never deleted.
6555
Another class is 'detritus', which includes files emitted by bzr during
6556
normal operations and selftests. (The value of these files decreases with
6559
If no options are specified, unknown files are deleted. Otherwise, option
6560
flags are respected, and may be combined.
6562
To check what clean-tree will do, use --dry-run.
6564
takes_options = ['directory',
6565
Option('ignored', help='Delete all ignored files.'),
6566
Option('detritus', help='Delete conflict files, merge and revert'
6567
' backups, and failed selftest dirs.'),
6569
help='Delete files unknown to bzr (default).'),
6570
Option('dry-run', help='Show files to delete instead of'
6572
Option('force', help='Do not prompt before deleting.')]
6573
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6574
force=False, directory=u'.'):
6575
from bzrlib.clean_tree import clean_tree
6576
if not (unknown or ignored or detritus):
6580
clean_tree(directory, unknown=unknown, ignored=ignored,
6581
detritus=detritus, dry_run=dry_run, no_prompt=force)
6584
class cmd_reference(Command):
6585
__doc__ = """list, view and set branch locations for nested trees.
6587
If no arguments are provided, lists the branch locations for nested trees.
6588
If one argument is provided, display the branch location for that tree.
6589
If two arguments are provided, set the branch location for that tree.
6594
takes_args = ['path?', 'location?']
6596
def run(self, path=None, location=None):
6598
if path is not None:
6600
tree, branch, relpath =(
6601
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6602
if path is not None:
6605
tree = branch.basis_tree()
6607
info = branch._get_all_reference_info().iteritems()
6608
self._display_reference_info(tree, branch, info)
6610
file_id = tree.path2id(path)
6612
raise errors.NotVersionedError(path)
6613
if location is None:
6614
info = [(file_id, branch.get_reference_info(file_id))]
6615
self._display_reference_info(tree, branch, info)
6617
branch.set_reference_info(file_id, path, location)
6619
def _display_reference_info(self, tree, branch, info):
6621
for file_id, (path, location) in info:
6623
path = tree.id2path(file_id)
6624
except errors.NoSuchId:
6626
ref_list.append((path, location))
6627
for path, location in sorted(ref_list):
6628
self.outf.write('%s %s\n' % (path, location))
6631
class cmd_export_pot(Command):
6632
__doc__ = """Export command helps and error messages in po format."""
6635
takes_options = [Option('plugin',
6636
help='Export help text from named command '\
6637
'(defaults to all built in commands).',
6639
Option('include-duplicates',
6640
help='Output multiple copies of the same msgid '
6641
'string if it appears more than once.'),
6644
def run(self, plugin=None, include_duplicates=False):
6645
from bzrlib.export_pot import export_pot
6646
export_pot(self.outf, plugin, include_duplicates)
6649
def _register_lazy_builtins():
6650
# register lazy builtins from other modules; called at startup and should
6651
# be only called once.
6652
for (name, aliases, module_name) in [
6653
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6654
('cmd_config', [], 'bzrlib.config'),
6655
('cmd_dpush', [], 'bzrlib.foreign'),
6656
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6657
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6658
('cmd_conflicts', [], 'bzrlib.conflicts'),
6659
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6660
('cmd_verify_signatures', [],
6661
'bzrlib.commit_signature_commands'),
6662
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6664
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
