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
# FIXME: This shouldn't be done before the pull
1122
# succeeds... -- vila 2012-01-02
1123
branch_to.set_parent(branch_from.base)
1125
if revision is not None:
1126
revision_id = revision.as_revision_id(branch_from)
1128
if tree_to is not None:
1129
view_info = _get_view_info_for_change_reporter(tree_to)
1130
change_reporter = delta._ChangeReporter(
1131
unversioned_filter=tree_to.is_ignored,
1132
view_info=view_info)
1133
result = tree_to.pull(
1134
branch_from, overwrite, revision_id, change_reporter,
1135
local=local, show_base=show_base)
1137
result = branch_to.pull(
1138
branch_from, overwrite, revision_id, local=local)
1140
result.report(self.outf)
1141
if verbose and result.old_revid != result.new_revid:
1142
log.show_branch_change(
1143
branch_to, self.outf, result.old_revno,
1145
if getattr(result, 'tag_conflicts', None):
1151
class cmd_push(Command):
1152
__doc__ = """Update a mirror of this branch.
1154
The target branch will not have its working tree populated because this
1155
is both expensive, and is not supported on remote file systems.
1157
Some smart servers or protocols *may* put the working tree in place in
1160
This command only works on branches that have not diverged. Branches are
1161
considered diverged if the destination branch's most recent commit is one
1162
that has not been merged (directly or indirectly) by the source branch.
1164
If branches have diverged, you can use 'bzr push --overwrite' to replace
1165
the other branch completely, discarding its unmerged changes.
1167
If you want to ensure you have the different changes in the other branch,
1168
do a merge (see bzr help merge) from the other branch, and commit that.
1169
After that you will be able to do a push without '--overwrite'.
1171
If there is no default push location set, the first push will set it (use
1172
--no-remember to avoid setting it). After that, you can omit the
1173
location to use the default. To change the default, use --remember. The
1174
value will only be saved if the remote location can be accessed.
1176
The --verbose option will display the revisions pushed using the log_format
1177
configuration option. You can use a different format by overriding it with
1178
-Olog_format=<other_format>.
1181
_see_also = ['pull', 'update', 'working-trees']
1182
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1183
Option('create-prefix',
1184
help='Create the path leading up to the branch '
1185
'if it does not already exist.'),
1186
custom_help('directory',
1187
help='Branch to push from, '
1188
'rather than the one containing the working directory.'),
1189
Option('use-existing-dir',
1190
help='By default push will fail if the target'
1191
' directory exists, but does not already'
1192
' have a control directory. This flag will'
1193
' allow push to proceed.'),
1195
help='Create a stacked branch that references the public location '
1196
'of the parent branch.'),
1197
Option('stacked-on',
1198
help='Create a stacked branch that refers to another branch '
1199
'for the commit history. Only the work not present in the '
1200
'referenced branch is included in the branch created.',
1203
help='Refuse to push if there are uncommitted changes in'
1204
' the working tree, --no-strict disables the check.'),
1206
help="Don't populate the working tree, even for protocols"
1207
" that support it."),
1209
takes_args = ['location?']
1210
encoding_type = 'replace'
1212
def run(self, location=None, remember=None, overwrite=False,
1213
create_prefix=False, verbose=False, revision=None,
1214
use_existing_dir=False, directory=None, stacked_on=None,
1215
stacked=False, strict=None, no_tree=False):
1216
from bzrlib.push import _show_push_branch
1218
if directory is None:
1220
# Get the source branch
1222
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1223
# Get the tip's revision_id
1224
revision = _get_one_revision('push', revision)
1225
if revision is not None:
1226
revision_id = revision.in_history(br_from).rev_id
1229
if tree is not None and revision_id is None:
1230
tree.check_changed_or_out_of_date(
1231
strict, 'push_strict',
1232
more_error='Use --no-strict to force the push.',
1233
more_warning='Uncommitted changes will not be pushed.')
1234
# Get the stacked_on branch, if any
1235
if stacked_on is not None:
1236
stacked_on = urlutils.normalize_url(stacked_on)
1238
parent_url = br_from.get_parent()
1240
parent = Branch.open(parent_url)
1241
stacked_on = parent.get_public_branch()
1243
# I considered excluding non-http url's here, thus forcing
1244
# 'public' branches only, but that only works for some
1245
# users, so it's best to just depend on the user spotting an
1246
# error by the feedback given to them. RBC 20080227.
1247
stacked_on = parent_url
1249
raise errors.BzrCommandError(gettext(
1250
"Could not determine branch to refer to."))
1252
# Get the destination location
1253
if location is None:
1254
stored_loc = br_from.get_push_location()
1255
if stored_loc is None:
1256
parent_loc = br_from.get_parent()
1258
raise errors.BzrCommandError(gettext(
1259
"No push location known or specified. To push to the "
1260
"parent branch (at %s), use 'bzr push :parent'." %
1261
urlutils.unescape_for_display(parent_loc,
1262
self.outf.encoding)))
1264
raise errors.BzrCommandError(gettext(
1265
"No push location known or specified."))
1267
display_url = urlutils.unescape_for_display(stored_loc,
1269
note(gettext("Using saved push location: %s") % display_url)
1270
location = stored_loc
1272
_show_push_branch(br_from, revision_id, location, self.outf,
1273
verbose=verbose, overwrite=overwrite, remember=remember,
1274
stacked_on=stacked_on, create_prefix=create_prefix,
1275
use_existing_dir=use_existing_dir, no_tree=no_tree)
1278
class cmd_branch(Command):
1279
__doc__ = """Create a new branch that is a copy of an existing branch.
1281
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1282
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1283
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1284
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1285
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1288
To retrieve the branch as of a particular revision, supply the --revision
1289
parameter, as in "branch foo/bar -r 5".
1291
The synonyms 'clone' and 'get' for this command are deprecated.
1294
_see_also = ['checkout']
1295
takes_args = ['from_location', 'to_location?']
1296
takes_options = ['revision',
1297
Option('hardlink', help='Hard-link working tree files where possible.'),
1298
Option('files-from', type=str,
1299
help="Get file contents from this tree."),
1301
help="Create a branch without a working-tree."),
1303
help="Switch the checkout in the current directory "
1304
"to the new branch."),
1306
help='Create a stacked branch referring to the source branch. '
1307
'The new branch will depend on the availability of the source '
1308
'branch for all operations.'),
1309
Option('standalone',
1310
help='Do not use a shared repository, even if available.'),
1311
Option('use-existing-dir',
1312
help='By default branch will fail if the target'
1313
' directory exists, but does not already'
1314
' have a control directory. This flag will'
1315
' allow branch to proceed.'),
1317
help="Bind new branch to from location."),
1319
aliases = ['get', 'clone']
1321
def run(self, from_location, to_location=None, revision=None,
1322
hardlink=False, stacked=False, standalone=False, no_tree=False,
1323
use_existing_dir=False, switch=False, bind=False,
1325
from bzrlib import switch as _mod_switch
1326
from bzrlib.tag import _merge_tags_if_possible
1327
if self.invoked_as in ['get', 'clone']:
1328
ui.ui_factory.show_user_warning(
1329
'deprecated_command',
1330
deprecated_name=self.invoked_as,
1331
recommended_name='branch',
1332
deprecated_in_version='2.4')
1333
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1335
if not (hardlink or files_from):
1336
# accelerator_tree is usually slower because you have to read N
1337
# files (no readahead, lots of seeks, etc), but allow the user to
1338
# explicitly request it
1339
accelerator_tree = None
1340
if files_from is not None and files_from != from_location:
1341
accelerator_tree = WorkingTree.open(files_from)
1342
revision = _get_one_revision('branch', revision)
1343
self.add_cleanup(br_from.lock_read().unlock)
1344
if revision is not None:
1345
revision_id = revision.as_revision_id(br_from)
1347
# FIXME - wt.last_revision, fallback to branch, fall back to
1348
# None or perhaps NULL_REVISION to mean copy nothing
1350
revision_id = br_from.last_revision()
1351
if to_location is None:
1352
to_location = getattr(br_from, "name", None)
1353
if to_location is None:
1354
to_location = urlutils.derive_to_location(from_location)
1355
to_transport = transport.get_transport(to_location)
1357
to_transport.mkdir('.')
1358
except errors.FileExists:
1360
to_dir = controldir.ControlDir.open_from_transport(
1362
except errors.NotBranchError:
1363
if not use_existing_dir:
1364
raise errors.BzrCommandError(gettext('Target directory "%s" '
1365
'already exists.') % to_location)
1370
to_dir.open_branch()
1371
except errors.NotBranchError:
1374
raise errors.AlreadyBranchError(to_location)
1375
except errors.NoSuchFile:
1376
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1382
# preserve whatever source format we have.
1383
to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1384
possible_transports=[to_transport],
1385
accelerator_tree=accelerator_tree,
1386
hardlink=hardlink, stacked=stacked,
1387
force_new_repo=standalone,
1388
create_tree_if_local=not no_tree,
1389
source_branch=br_from)
1390
branch = to_dir.open_branch(
1391
possible_transports=[
1392
br_from.bzrdir.root_transport, to_transport])
1393
except errors.NoSuchRevision:
1394
to_transport.delete_tree('.')
1395
msg = gettext("The branch {0} has no revision {1}.").format(
1396
from_location, revision)
1397
raise errors.BzrCommandError(msg)
1399
branch = br_from.sprout(to_dir, revision_id=revision_id)
1400
_merge_tags_if_possible(br_from, branch)
1401
# If the source branch is stacked, the new branch may
1402
# be stacked whether we asked for that explicitly or not.
1403
# We therefore need a try/except here and not just 'if stacked:'
1405
note(gettext('Created new stacked branch referring to %s.') %
1406
branch.get_stacked_on_url())
1407
except (errors.NotStacked, errors.UnstackableBranchFormat,
1408
errors.UnstackableRepositoryFormat), e:
1409
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1411
# Bind to the parent
1412
parent_branch = Branch.open(from_location)
1413
branch.bind(parent_branch)
1414
note(gettext('New branch bound to %s') % from_location)
1416
# Switch to the new branch
1417
wt, _ = WorkingTree.open_containing('.')
1418
_mod_switch.switch(wt.bzrdir, branch)
1419
note(gettext('Switched to branch: %s'),
1420
urlutils.unescape_for_display(branch.base, 'utf-8'))
1423
class cmd_branches(Command):
1424
__doc__ = """List the branches available at the current location.
1426
This command will print the names of all the branches at the current
1430
takes_args = ['location?']
1432
Option('recursive', short_name='R',
1433
help='Recursively scan for branches rather than '
1434
'just looking in the specified location.')]
1436
def run(self, location=".", recursive=False):
1438
t = transport.get_transport(location)
1439
if not t.listable():
1440
raise errors.BzrCommandError(
1441
"Can't scan this type of location.")
1442
for b in controldir.ControlDir.find_branches(t):
1443
self.outf.write("%s\n" % urlutils.unescape_for_display(
1444
urlutils.relative_url(t.base, b.base),
1445
self.outf.encoding).rstrip("/"))
1447
dir = controldir.ControlDir.open_containing(location)[0]
1449
active_branch = dir.open_branch(name=None)
1450
except errors.NotBranchError:
1451
active_branch = None
1452
branches = dir.get_branches()
1454
for name, branch in branches.iteritems():
1457
active = (active_branch is not None and
1458
active_branch.base == branch.base)
1459
names[name] = active
1460
# Only mention the current branch explicitly if it's not
1461
# one of the colocated branches
1462
if not any(names.values()) and active_branch is not None:
1463
self.outf.write("* %s\n" % gettext("(default)"))
1464
for name in sorted(names.keys()):
1465
active = names[name]
1470
self.outf.write("%s %s\n" % (
1471
prefix, name.encode(self.outf.encoding)))
1474
class cmd_checkout(Command):
1475
__doc__ = """Create a new checkout of an existing branch.
1477
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1478
the branch found in '.'. This is useful if you have removed the working tree
1479
or if it was never created - i.e. if you pushed the branch to its current
1480
location using SFTP.
1482
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1483
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1484
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1485
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1486
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1489
To retrieve the branch as of a particular revision, supply the --revision
1490
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1491
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1495
_see_also = ['checkouts', 'branch']
1496
takes_args = ['branch_location?', 'to_location?']
1497
takes_options = ['revision',
1498
Option('lightweight',
1499
help="Perform a lightweight checkout. Lightweight "
1500
"checkouts depend on access to the branch for "
1501
"every operation. Normal checkouts can perform "
1502
"common operations like diff and status without "
1503
"such access, and also support local commits."
1505
Option('files-from', type=str,
1506
help="Get file contents from this tree."),
1508
help='Hard-link working tree files where possible.'
1513
def run(self, branch_location=None, to_location=None, revision=None,
1514
lightweight=False, files_from=None, hardlink=False):
1515
if branch_location is None:
1516
branch_location = osutils.getcwd()
1517
to_location = branch_location
1518
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1520
if not (hardlink or files_from):
1521
# accelerator_tree is usually slower because you have to read N
1522
# files (no readahead, lots of seeks, etc), but allow the user to
1523
# explicitly request it
1524
accelerator_tree = None
1525
revision = _get_one_revision('checkout', revision)
1526
if files_from is not None and files_from != branch_location:
1527
accelerator_tree = WorkingTree.open(files_from)
1528
if revision is not None:
1529
revision_id = revision.as_revision_id(source)
1532
if to_location is None:
1533
to_location = urlutils.derive_to_location(branch_location)
1534
# if the source and to_location are the same,
1535
# and there is no working tree,
1536
# then reconstitute a branch
1537
if (osutils.abspath(to_location) ==
1538
osutils.abspath(branch_location)):
1540
source.bzrdir.open_workingtree()
1541
except errors.NoWorkingTree:
1542
source.bzrdir.create_workingtree(revision_id)
1544
source.create_checkout(to_location, revision_id, lightweight,
1545
accelerator_tree, hardlink)
1548
class cmd_renames(Command):
1549
__doc__ = """Show list of renamed files.
1551
# TODO: Option to show renames between two historical versions.
1553
# TODO: Only show renames under dir, rather than in the whole branch.
1554
_see_also = ['status']
1555
takes_args = ['dir?']
1558
def run(self, dir=u'.'):
1559
tree = WorkingTree.open_containing(dir)[0]
1560
self.add_cleanup(tree.lock_read().unlock)
1561
new_inv = tree.inventory
1562
old_tree = tree.basis_tree()
1563
self.add_cleanup(old_tree.lock_read().unlock)
1564
old_inv = old_tree.inventory
1566
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1567
for f, paths, c, v, p, n, k, e in iterator:
1568
if paths[0] == paths[1]:
1572
renames.append(paths)
1574
for old_name, new_name in renames:
1575
self.outf.write("%s => %s\n" % (old_name, new_name))
1578
class cmd_update(Command):
1579
__doc__ = """Update a working tree to a new revision.
1581
This will perform a merge of the destination revision (the tip of the
1582
branch, or the specified revision) into the working tree, and then make
1583
that revision the basis revision for the working tree.
1585
You can use this to visit an older revision, or to update a working tree
1586
that is out of date from its branch.
1588
If there are any uncommitted changes in the tree, they will be carried
1589
across and remain as uncommitted changes after the update. To discard
1590
these changes, use 'bzr revert'. The uncommitted changes may conflict
1591
with the changes brought in by the change in basis revision.
1593
If the tree's branch is bound to a master branch, bzr will also update
1594
the branch from the master.
1596
You cannot update just a single file or directory, because each Bazaar
1597
working tree has just a single basis revision. If you want to restore a
1598
file that has been removed locally, use 'bzr revert' instead of 'bzr
1599
update'. If you want to restore a file to its state in a previous
1600
revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
1601
out the old content of that file to a new location.
1603
The 'dir' argument, if given, must be the location of the root of a
1604
working tree to update. By default, the working tree that contains the
1605
current working directory is used.
1608
_see_also = ['pull', 'working-trees', 'status-flags']
1609
takes_args = ['dir?']
1610
takes_options = ['revision',
1612
help="Show base revision text in conflicts."),
1616
def run(self, dir=None, revision=None, show_base=None):
1617
if revision is not None and len(revision) != 1:
1618
raise errors.BzrCommandError(gettext(
1619
"bzr update --revision takes exactly one revision"))
1621
tree = WorkingTree.open_containing('.')[0]
1623
tree, relpath = WorkingTree.open_containing(dir)
1626
raise errors.BzrCommandError(gettext(
1627
"bzr update can only update a whole tree, "
1628
"not a file or subdirectory"))
1629
branch = tree.branch
1630
possible_transports = []
1631
master = branch.get_master_branch(
1632
possible_transports=possible_transports)
1633
if master is not None:
1634
branch_location = master.base
1637
branch_location = tree.branch.base
1638
tree.lock_tree_write()
1639
self.add_cleanup(tree.unlock)
1640
# get rid of the final '/' and be ready for display
1641
branch_location = urlutils.unescape_for_display(
1642
branch_location.rstrip('/'),
1644
existing_pending_merges = tree.get_parent_ids()[1:]
1648
# may need to fetch data into a heavyweight checkout
1649
# XXX: this may take some time, maybe we should display a
1651
old_tip = branch.update(possible_transports)
1652
if revision is not None:
1653
revision_id = revision[0].as_revision_id(branch)
1655
revision_id = branch.last_revision()
1656
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1657
revno = branch.revision_id_to_dotted_revno(revision_id)
1658
note(gettext("Tree is up to date at revision {0} of branch {1}"
1659
).format('.'.join(map(str, revno)), branch_location))
1661
view_info = _get_view_info_for_change_reporter(tree)
1662
change_reporter = delta._ChangeReporter(
1663
unversioned_filter=tree.is_ignored,
1664
view_info=view_info)
1666
conflicts = tree.update(
1668
possible_transports=possible_transports,
1669
revision=revision_id,
1671
show_base=show_base)
1672
except errors.NoSuchRevision, e:
1673
raise errors.BzrCommandError(gettext(
1674
"branch has no revision %s\n"
1675
"bzr update --revision only works"
1676
" for a revision in the branch history")
1678
revno = tree.branch.revision_id_to_dotted_revno(
1679
_mod_revision.ensure_null(tree.last_revision()))
1680
note(gettext('Updated to revision {0} of branch {1}').format(
1681
'.'.join(map(str, revno)), branch_location))
1682
parent_ids = tree.get_parent_ids()
1683
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1684
note(gettext('Your local commits will now show as pending merges with '
1685
"'bzr status', and can be committed with 'bzr commit'."))
1692
class cmd_info(Command):
1693
__doc__ = """Show information about a working tree, branch or repository.
1695
This command will show all known locations and formats associated to the
1696
tree, branch or repository.
1698
In verbose mode, statistical information is included with each report.
1699
To see extended statistic information, use a verbosity level of 2 or
1700
higher by specifying the verbose option multiple times, e.g. -vv.
1702
Branches and working trees will also report any missing revisions.
1706
Display information on the format and related locations:
1710
Display the above together with extended format information and
1711
basic statistics (like the number of files in the working tree and
1712
number of revisions in the branch and repository):
1716
Display the above together with number of committers to the branch:
1720
_see_also = ['revno', 'working-trees', 'repositories']
1721
takes_args = ['location?']
1722
takes_options = ['verbose']
1723
encoding_type = 'replace'
1726
def run(self, location=None, verbose=False):
1728
noise_level = get_verbosity_level()
1731
from bzrlib.info import show_bzrdir_info
1732
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1733
verbose=noise_level, outfile=self.outf)
1736
class cmd_remove(Command):
1737
__doc__ = """Remove files or directories.
1739
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1740
delete them if they can easily be recovered using revert otherwise they
1741
will be backed up (adding an extention of the form .~#~). If no options or
1742
parameters are given Bazaar will scan for files that are being tracked by
1743
Bazaar but missing in your tree and stop tracking them for you.
1745
takes_args = ['file*']
1746
takes_options = ['verbose',
1747
Option('new', help='Only remove files that have never been committed.'),
1748
RegistryOption.from_kwargs('file-deletion-strategy',
1749
'The file deletion mode to be used.',
1750
title='Deletion Strategy', value_switches=True, enum_switch=False,
1751
safe='Backup changed files (default).',
1752
keep='Delete from bzr but leave the working copy.',
1753
no_backup='Don\'t backup changed files.',
1754
force='Delete all the specified files, even if they can not be '
1755
'recovered and even if they are non-empty directories. '
1756
'(deprecated, use no-backup)')]
1757
aliases = ['rm', 'del']
1758
encoding_type = 'replace'
1760
def run(self, file_list, verbose=False, new=False,
1761
file_deletion_strategy='safe'):
1762
if file_deletion_strategy == 'force':
1763
note(gettext("(The --force option is deprecated, rather use --no-backup "
1765
file_deletion_strategy = 'no-backup'
1767
tree, file_list = WorkingTree.open_containing_paths(file_list)
1769
if file_list is not None:
1770
file_list = [f for f in file_list]
1772
self.add_cleanup(tree.lock_write().unlock)
1773
# Heuristics should probably all move into tree.remove_smart or
1776
added = tree.changes_from(tree.basis_tree(),
1777
specific_files=file_list).added
1778
file_list = sorted([f[0] for f in added], reverse=True)
1779
if len(file_list) == 0:
1780
raise errors.BzrCommandError(gettext('No matching files.'))
1781
elif file_list is None:
1782
# missing files show up in iter_changes(basis) as
1783
# versioned-with-no-kind.
1785
for change in tree.iter_changes(tree.basis_tree()):
1786
# Find paths in the working tree that have no kind:
1787
if change[1][1] is not None and change[6][1] is None:
1788
missing.append(change[1][1])
1789
file_list = sorted(missing, reverse=True)
1790
file_deletion_strategy = 'keep'
1791
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1792
keep_files=file_deletion_strategy=='keep',
1793
force=(file_deletion_strategy=='no-backup'))
1796
class cmd_file_id(Command):
1797
__doc__ = """Print file_id of a particular file or directory.
1799
The file_id is assigned when the file is first added and remains the
1800
same through all revisions where the file exists, even when it is
1805
_see_also = ['inventory', 'ls']
1806
takes_args = ['filename']
1809
def run(self, filename):
1810
tree, relpath = WorkingTree.open_containing(filename)
1811
i = tree.path2id(relpath)
1813
raise errors.NotVersionedError(filename)
1815
self.outf.write(i + '\n')
1818
class cmd_file_path(Command):
1819
__doc__ = """Print path of file_ids to a file or directory.
1821
This prints one line for each directory down to the target,
1822
starting at the branch root.
1826
takes_args = ['filename']
1829
def run(self, filename):
1830
tree, relpath = WorkingTree.open_containing(filename)
1831
fid = tree.path2id(relpath)
1833
raise errors.NotVersionedError(filename)
1834
segments = osutils.splitpath(relpath)
1835
for pos in range(1, len(segments) + 1):
1836
path = osutils.joinpath(segments[:pos])
1837
self.outf.write("%s\n" % tree.path2id(path))
1840
class cmd_reconcile(Command):
1841
__doc__ = """Reconcile bzr metadata in a branch.
1843
This can correct data mismatches that may have been caused by
1844
previous ghost operations or bzr upgrades. You should only
1845
need to run this command if 'bzr check' or a bzr developer
1846
advises you to run it.
1848
If a second branch is provided, cross-branch reconciliation is
1849
also attempted, which will check that data like the tree root
1850
id which was not present in very early bzr versions is represented
1851
correctly in both branches.
1853
At the same time it is run it may recompress data resulting in
1854
a potential saving in disk space or performance gain.
1856
The branch *MUST* be on a listable system such as local disk or sftp.
1859
_see_also = ['check']
1860
takes_args = ['branch?']
1862
Option('canonicalize-chks',
1863
help='Make sure CHKs are in canonical form (repairs '
1868
def run(self, branch=".", canonicalize_chks=False):
1869
from bzrlib.reconcile import reconcile
1870
dir = controldir.ControlDir.open(branch)
1871
reconcile(dir, canonicalize_chks=canonicalize_chks)
1874
class cmd_revision_history(Command):
1875
__doc__ = """Display the list of revision ids on a branch."""
1878
takes_args = ['location?']
1883
def run(self, location="."):
1884
branch = Branch.open_containing(location)[0]
1885
self.add_cleanup(branch.lock_read().unlock)
1886
graph = branch.repository.get_graph()
1887
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1888
[_mod_revision.NULL_REVISION]))
1889
for revid in reversed(history):
1890
self.outf.write(revid)
1891
self.outf.write('\n')
1894
class cmd_ancestry(Command):
1895
__doc__ = """List all revisions merged into this branch."""
1897
_see_also = ['log', 'revision-history']
1898
takes_args = ['location?']
1903
def run(self, location="."):
1905
wt = WorkingTree.open_containing(location)[0]
1906
except errors.NoWorkingTree:
1907
b = Branch.open(location)
1908
last_revision = b.last_revision()
1911
last_revision = wt.last_revision()
1913
self.add_cleanup(b.repository.lock_read().unlock)
1914
graph = b.repository.get_graph()
1915
revisions = [revid for revid, parents in
1916
graph.iter_ancestry([last_revision])]
1917
for revision_id in reversed(revisions):
1918
if _mod_revision.is_null(revision_id):
1920
self.outf.write(revision_id + '\n')
1923
class cmd_init(Command):
1924
__doc__ = """Make a directory into a versioned branch.
1926
Use this to create an empty branch, or before importing an
1929
If there is a repository in a parent directory of the location, then
1930
the history of the branch will be stored in the repository. Otherwise
1931
init creates a standalone branch which carries its own history
1932
in the .bzr directory.
1934
If there is already a branch at the location but it has no working tree,
1935
the tree can be populated with 'bzr checkout'.
1937
Recipe for importing a tree of files::
1943
bzr commit -m "imported project"
1946
_see_also = ['init-repository', 'branch', 'checkout']
1947
takes_args = ['location?']
1949
Option('create-prefix',
1950
help='Create the path leading up to the branch '
1951
'if it does not already exist.'),
1952
RegistryOption('format',
1953
help='Specify a format for this branch. '
1954
'See "help formats".',
1955
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1956
converter=lambda name: controldir.format_registry.make_bzrdir(name),
1957
value_switches=True,
1958
title="Branch format",
1960
Option('append-revisions-only',
1961
help='Never change revnos or the existing log.'
1962
' Append revisions to it only.'),
1964
'Create a branch without a working tree.')
1966
def run(self, location=None, format=None, append_revisions_only=False,
1967
create_prefix=False, no_tree=False):
1969
format = controldir.format_registry.make_bzrdir('default')
1970
if location is None:
1973
to_transport = transport.get_transport(location)
1975
# The path has to exist to initialize a
1976
# branch inside of it.
1977
# Just using os.mkdir, since I don't
1978
# believe that we want to create a bunch of
1979
# locations if the user supplies an extended path
1981
to_transport.ensure_base()
1982
except errors.NoSuchFile:
1983
if not create_prefix:
1984
raise errors.BzrCommandError(gettext("Parent directory of %s"
1986
"\nYou may supply --create-prefix to create all"
1987
" leading parent directories.")
1989
to_transport.create_prefix()
1992
a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
1993
except errors.NotBranchError:
1994
# really a NotBzrDir error...
1995
create_branch = controldir.ControlDir.create_branch_convenience
1997
force_new_tree = False
1999
force_new_tree = None
2000
branch = create_branch(to_transport.base, format=format,
2001
possible_transports=[to_transport],
2002
force_new_tree=force_new_tree)
2003
a_bzrdir = branch.bzrdir
2005
from bzrlib.transport.local import LocalTransport
2006
if a_bzrdir.has_branch():
2007
if (isinstance(to_transport, LocalTransport)
2008
and not a_bzrdir.has_workingtree()):
2009
raise errors.BranchExistsWithoutWorkingTree(location)
2010
raise errors.AlreadyBranchError(location)
2011
branch = a_bzrdir.create_branch()
2012
if not no_tree and not a_bzrdir.has_workingtree():
2013
a_bzrdir.create_workingtree()
2014
if append_revisions_only:
2016
branch.set_append_revisions_only(True)
2017
except errors.UpgradeRequired:
2018
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2019
' to append-revisions-only. Try --default.'))
2021
from bzrlib.info import describe_layout, describe_format
2023
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
2024
except (errors.NoWorkingTree, errors.NotLocalUrl):
2026
repository = branch.repository
2027
layout = describe_layout(repository, branch, tree).lower()
2028
format = describe_format(a_bzrdir, repository, branch, tree)
2029
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2031
if repository.is_shared():
2032
#XXX: maybe this can be refactored into transport.path_or_url()
2033
url = repository.bzrdir.root_transport.external_url()
2035
url = urlutils.local_path_from_url(url)
2036
except errors.InvalidURL:
2038
self.outf.write(gettext("Using shared repository: %s\n") % url)
2041
class cmd_init_repository(Command):
2042
__doc__ = """Create a shared repository for branches to share storage space.
2044
New branches created under the repository directory will store their
2045
revisions in the repository, not in the branch directory. For branches
2046
with shared history, this reduces the amount of storage needed and
2047
speeds up the creation of new branches.
2049
If the --no-trees option is given then the branches in the repository
2050
will not have working trees by default. They will still exist as
2051
directories on disk, but they will not have separate copies of the
2052
files at a certain revision. This can be useful for repositories that
2053
store branches which are interacted with through checkouts or remote
2054
branches, such as on a server.
2057
Create a shared repository holding just branches::
2059
bzr init-repo --no-trees repo
2062
Make a lightweight checkout elsewhere::
2064
bzr checkout --lightweight repo/trunk trunk-checkout
2069
_see_also = ['init', 'branch', 'checkout', 'repositories']
2070
takes_args = ["location"]
2071
takes_options = [RegistryOption('format',
2072
help='Specify a format for this repository. See'
2073
' "bzr help formats" for details.',
2074
lazy_registry=('bzrlib.controldir', 'format_registry'),
2075
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2076
value_switches=True, title='Repository format'),
2078
help='Branches in the repository will default to'
2079
' not having a working tree.'),
2081
aliases = ["init-repo"]
2083
def run(self, location, format=None, no_trees=False):
2085
format = controldir.format_registry.make_bzrdir('default')
2087
if location is None:
2090
to_transport = transport.get_transport(location)
2092
(repo, newdir, require_stacking, repository_policy) = (
2093
format.initialize_on_transport_ex(to_transport,
2094
create_prefix=True, make_working_trees=not no_trees,
2095
shared_repo=True, force_new_repo=True,
2096
use_existing_dir=True,
2097
repo_format_name=format.repository_format.get_format_string()))
2099
from bzrlib.info import show_bzrdir_info
2100
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2103
class cmd_diff(Command):
2104
__doc__ = """Show differences in the working tree, between revisions or branches.
2106
If no arguments are given, all changes for the current tree are listed.
2107
If files are given, only the changes in those files are listed.
2108
Remote and multiple branches can be compared by using the --old and
2109
--new options. If not provided, the default for both is derived from
2110
the first argument, if any, or the current tree if no arguments are
2113
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
2114
produces patches suitable for "patch -p1".
2116
Note that when using the -r argument with a range of revisions, the
2117
differences are computed between the two specified revisions. That
2118
is, the command does not show the changes introduced by the first
2119
revision in the range. This differs from the interpretation of
2120
revision ranges used by "bzr log" which includes the first revision
2125
2 - unrepresentable changes
2130
Shows the difference in the working tree versus the last commit::
2134
Difference between the working tree and revision 1::
2138
Difference between revision 3 and revision 1::
2142
Difference between revision 3 and revision 1 for branch xxx::
2146
The changes introduced by revision 2 (equivalent to -r1..2)::
2150
To see the changes introduced by revision X::
2154
Note that in the case of a merge, the -c option shows the changes
2155
compared to the left hand parent. To see the changes against
2156
another parent, use::
2158
bzr diff -r<chosen_parent>..X
2160
The changes between the current revision and the previous revision
2161
(equivalent to -c-1 and -r-2..-1)
2165
Show just the differences for file NEWS::
2169
Show the differences in working tree xxx for file NEWS::
2173
Show the differences from branch xxx to this working tree:
2177
Show the differences between two branches for file NEWS::
2179
bzr diff --old xxx --new yyy NEWS
2181
Same as 'bzr diff' but prefix paths with old/ and new/::
2183
bzr diff --prefix old/:new/
2185
Show the differences using a custom diff program with options::
2187
bzr diff --using /usr/bin/diff --diff-options -wu
2189
_see_also = ['status']
2190
takes_args = ['file*']
2192
Option('diff-options', type=str,
2193
help='Pass these options to the external diff program.'),
2194
Option('prefix', type=str,
2196
help='Set prefixes added to old and new filenames, as '
2197
'two values separated by a colon. (eg "old/:new/").'),
2199
help='Branch/tree to compare from.',
2203
help='Branch/tree to compare to.',
2209
help='Use this command to compare files.',
2212
RegistryOption('format',
2214
help='Diff format to use.',
2215
lazy_registry=('bzrlib.diff', 'format_registry'),
2216
title='Diff format'),
2218
aliases = ['di', 'dif']
2219
encoding_type = 'exact'
2222
def run(self, revision=None, file_list=None, diff_options=None,
2223
prefix=None, old=None, new=None, using=None, format=None):
2224
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2227
if (prefix is None) or (prefix == '0'):
2235
old_label, new_label = prefix.split(":")
2237
raise errors.BzrCommandError(gettext(
2238
'--prefix expects two values separated by a colon'
2239
' (eg "old/:new/")'))
2241
if revision and len(revision) > 2:
2242
raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
2243
' one or two revision specifiers'))
2245
if using is not None and format is not None:
2246
raise errors.BzrCommandError(gettext(
2247
'{0} and {1} are mutually exclusive').format(
2248
'--using', '--format'))
2250
(old_tree, new_tree,
2251
old_branch, new_branch,
2252
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2253
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2254
# GNU diff on Windows uses ANSI encoding for filenames
2255
path_encoding = osutils.get_diff_header_encoding()
2256
return show_diff_trees(old_tree, new_tree, sys.stdout,
2257
specific_files=specific_files,
2258
external_diff_options=diff_options,
2259
old_label=old_label, new_label=new_label,
2260
extra_trees=extra_trees,
2261
path_encoding=path_encoding,
2266
class cmd_deleted(Command):
2267
__doc__ = """List files deleted in the working tree.
2269
# TODO: Show files deleted since a previous revision, or
2270
# between two revisions.
2271
# TODO: Much more efficient way to do this: read in new
2272
# directories with readdir, rather than stating each one. Same
2273
# level of effort but possibly much less IO. (Or possibly not,
2274
# if the directories are very large...)
2275
_see_also = ['status', 'ls']
2276
takes_options = ['directory', 'show-ids']
2279
def run(self, show_ids=False, directory=u'.'):
2280
tree = WorkingTree.open_containing(directory)[0]
2281
self.add_cleanup(tree.lock_read().unlock)
2282
old = tree.basis_tree()
2283
self.add_cleanup(old.lock_read().unlock)
2284
for path, ie in old.inventory.iter_entries():
2285
if not tree.has_id(ie.file_id):
2286
self.outf.write(path)
2288
self.outf.write(' ')
2289
self.outf.write(ie.file_id)
2290
self.outf.write('\n')
2293
class cmd_modified(Command):
2294
__doc__ = """List files modified in working tree.
2298
_see_also = ['status', 'ls']
2299
takes_options = ['directory', 'null']
2302
def run(self, null=False, directory=u'.'):
2303
tree = WorkingTree.open_containing(directory)[0]
2304
self.add_cleanup(tree.lock_read().unlock)
2305
td = tree.changes_from(tree.basis_tree())
2307
for path, id, kind, text_modified, meta_modified in td.modified:
2309
self.outf.write(path + '\0')
2311
self.outf.write(osutils.quotefn(path) + '\n')
2314
class cmd_added(Command):
2315
__doc__ = """List files added in working tree.
2319
_see_also = ['status', 'ls']
2320
takes_options = ['directory', 'null']
2323
def run(self, null=False, directory=u'.'):
2324
wt = WorkingTree.open_containing(directory)[0]
2325
self.add_cleanup(wt.lock_read().unlock)
2326
basis = wt.basis_tree()
2327
self.add_cleanup(basis.lock_read().unlock)
2328
basis_inv = basis.inventory
2331
if basis_inv.has_id(file_id):
2333
if inv.is_root(file_id) and len(basis_inv) == 0:
2335
path = inv.id2path(file_id)
2336
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2339
self.outf.write(path + '\0')
2341
self.outf.write(osutils.quotefn(path) + '\n')
2344
class cmd_root(Command):
2345
__doc__ = """Show the tree root directory.
2347
The root is the nearest enclosing directory with a .bzr control
2350
takes_args = ['filename?']
2352
def run(self, filename=None):
2353
"""Print the branch root."""
2354
tree = WorkingTree.open_containing(filename)[0]
2355
self.outf.write(tree.basedir + '\n')
2358
def _parse_limit(limitstring):
2360
return int(limitstring)
2362
msg = gettext("The limit argument must be an integer.")
2363
raise errors.BzrCommandError(msg)
2366
def _parse_levels(s):
2370
msg = gettext("The levels argument must be an integer.")
2371
raise errors.BzrCommandError(msg)
2374
class cmd_log(Command):
2375
__doc__ = """Show historical log for a branch or subset of a branch.
2377
log is bzr's default tool for exploring the history of a branch.
2378
The branch to use is taken from the first parameter. If no parameters
2379
are given, the branch containing the working directory is logged.
2380
Here are some simple examples::
2382
bzr log log the current branch
2383
bzr log foo.py log a file in its branch
2384
bzr log http://server/branch log a branch on a server
2386
The filtering, ordering and information shown for each revision can
2387
be controlled as explained below. By default, all revisions are
2388
shown sorted (topologically) so that newer revisions appear before
2389
older ones and descendants always appear before ancestors. If displayed,
2390
merged revisions are shown indented under the revision in which they
2395
The log format controls how information about each revision is
2396
displayed. The standard log formats are called ``long``, ``short``
2397
and ``line``. The default is long. See ``bzr help log-formats``
2398
for more details on log formats.
2400
The following options can be used to control what information is
2403
-l N display a maximum of N revisions
2404
-n N display N levels of revisions (0 for all, 1 for collapsed)
2405
-v display a status summary (delta) for each revision
2406
-p display a diff (patch) for each revision
2407
--show-ids display revision-ids (and file-ids), not just revnos
2409
Note that the default number of levels to display is a function of the
2410
log format. If the -n option is not used, the standard log formats show
2411
just the top level (mainline).
2413
Status summaries are shown using status flags like A, M, etc. To see
2414
the changes explained using words like ``added`` and ``modified``
2415
instead, use the -vv option.
2419
To display revisions from oldest to newest, use the --forward option.
2420
In most cases, using this option will have little impact on the total
2421
time taken to produce a log, though --forward does not incrementally
2422
display revisions like --reverse does when it can.
2424
:Revision filtering:
2426
The -r option can be used to specify what revision or range of revisions
2427
to filter against. The various forms are shown below::
2429
-rX display revision X
2430
-rX.. display revision X and later
2431
-r..Y display up to and including revision Y
2432
-rX..Y display from X to Y inclusive
2434
See ``bzr help revisionspec`` for details on how to specify X and Y.
2435
Some common examples are given below::
2437
-r-1 show just the tip
2438
-r-10.. show the last 10 mainline revisions
2439
-rsubmit:.. show what's new on this branch
2440
-rancestor:path.. show changes since the common ancestor of this
2441
branch and the one at location path
2442
-rdate:yesterday.. show changes since yesterday
2444
When logging a range of revisions using -rX..Y, log starts at
2445
revision Y and searches back in history through the primary
2446
("left-hand") parents until it finds X. When logging just the
2447
top level (using -n1), an error is reported if X is not found
2448
along the way. If multi-level logging is used (-n0), X may be
2449
a nested merge revision and the log will be truncated accordingly.
2453
If parameters are given and the first one is not a branch, the log
2454
will be filtered to show only those revisions that changed the
2455
nominated files or directories.
2457
Filenames are interpreted within their historical context. To log a
2458
deleted file, specify a revision range so that the file existed at
2459
the end or start of the range.
2461
Historical context is also important when interpreting pathnames of
2462
renamed files/directories. Consider the following example:
2464
* revision 1: add tutorial.txt
2465
* revision 2: modify tutorial.txt
2466
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2470
* ``bzr log guide.txt`` will log the file added in revision 1
2472
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2474
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2475
the original file in revision 2.
2477
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2478
was no file called guide.txt in revision 2.
2480
Renames are always followed by log. By design, there is no need to
2481
explicitly ask for this (and no way to stop logging a file back
2482
until it was last renamed).
2486
The --match option can be used for finding revisions that match a
2487
regular expression in a commit message, committer, author or bug.
2488
Specifying the option several times will match any of the supplied
2489
expressions. --match-author, --match-bugs, --match-committer and
2490
--match-message can be used to only match a specific field.
2494
GUI tools and IDEs are often better at exploring history than command
2495
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2496
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2497
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2498
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2500
You may find it useful to add the aliases below to ``bazaar.conf``::
2504
top = log -l10 --line
2507
``bzr tip`` will then show the latest revision while ``bzr top``
2508
will show the last 10 mainline revisions. To see the details of a
2509
particular revision X, ``bzr show -rX``.
2511
If you are interested in looking deeper into a particular merge X,
2512
use ``bzr log -n0 -rX``.
2514
``bzr log -v`` on a branch with lots of history is currently
2515
very slow. A fix for this issue is currently under development.
2516
With or without that fix, it is recommended that a revision range
2517
be given when using the -v option.
2519
bzr has a generic full-text matching plugin, bzr-search, that can be
2520
used to find revisions matching user names, commit messages, etc.
2521
Among other features, this plugin can find all revisions containing
2522
a list of words but not others.
2524
When exploring non-mainline history on large projects with deep
2525
history, the performance of log can be greatly improved by installing
2526
the historycache plugin. This plugin buffers historical information
2527
trading disk space for faster speed.
2529
takes_args = ['file*']
2530
_see_also = ['log-formats', 'revisionspec']
2533
help='Show from oldest to newest.'),
2535
custom_help('verbose',
2536
help='Show files changed in each revision.'),
2540
type=bzrlib.option._parse_revision_str,
2542
help='Show just the specified revision.'
2543
' See also "help revisionspec".'),
2545
RegistryOption('authors',
2546
'What names to list as authors - first, all or committer.',
2548
lazy_registry=('bzrlib.log', 'author_list_registry'),
2552
help='Number of levels to display - 0 for all, 1 for flat.',
2554
type=_parse_levels),
2556
help='Show revisions whose message matches this '
2557
'regular expression.',
2562
help='Limit the output to the first N revisions.',
2567
help='Show changes made in each revision as a patch.'),
2568
Option('include-merged',
2569
help='Show merged revisions like --levels 0 does.'),
2570
Option('include-merges', hidden=True,
2571
help='Historical alias for --include-merged.'),
2572
Option('omit-merges',
2573
help='Do not report commits with more than one parent.'),
2574
Option('exclude-common-ancestry',
2575
help='Display only the revisions that are not part'
2576
' of both ancestries (require -rX..Y).'
2578
Option('signatures',
2579
help='Show digital signature validity.'),
2582
help='Show revisions whose properties match this '
2585
ListOption('match-message',
2586
help='Show revisions whose message matches this '
2589
ListOption('match-committer',
2590
help='Show revisions whose committer matches this '
2593
ListOption('match-author',
2594
help='Show revisions whose authors match this '
2597
ListOption('match-bugs',
2598
help='Show revisions whose bugs match this '
2602
encoding_type = 'replace'
2605
def run(self, file_list=None, timezone='original',
2616
include_merged=None,
2618
exclude_common_ancestry=False,
2622
match_committer=None,
2626
include_merges=symbol_versioning.DEPRECATED_PARAMETER,
2628
from bzrlib.log import (
2630
make_log_request_dict,
2631
_get_info_for_log_files,
2633
direction = (forward and 'forward') or 'reverse'
2634
if symbol_versioning.deprecated_passed(include_merges):
2635
ui.ui_factory.show_user_warning(
2636
'deprecated_command_option',
2637
deprecated_name='--include-merges',
2638
recommended_name='--include-merged',
2639
deprecated_in_version='2.5',
2640
command=self.invoked_as)
2641
if include_merged is None:
2642
include_merged = include_merges
2644
raise errors.BzrCommandError(gettext(
2645
'{0} and {1} are mutually exclusive').format(
2646
'--include-merges', '--include-merged'))
2647
if include_merged is None:
2648
include_merged = False
2649
if (exclude_common_ancestry
2650
and (revision is None or len(revision) != 2)):
2651
raise errors.BzrCommandError(gettext(
2652
'--exclude-common-ancestry requires -r with two revisions'))
2657
raise errors.BzrCommandError(gettext(
2658
'{0} and {1} are mutually exclusive').format(
2659
'--levels', '--include-merged'))
2661
if change is not None:
2663
raise errors.RangeInChangeOption()
2664
if revision is not None:
2665
raise errors.BzrCommandError(gettext(
2666
'{0} and {1} are mutually exclusive').format(
2667
'--revision', '--change'))
2672
filter_by_dir = False
2674
# find the file ids to log and check for directory filtering
2675
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2676
revision, file_list, self.add_cleanup)
2677
for relpath, file_id, kind in file_info_list:
2679
raise errors.BzrCommandError(gettext(
2680
"Path unknown at end or start of revision range: %s") %
2682
# If the relpath is the top of the tree, we log everything
2687
file_ids.append(file_id)
2688
filter_by_dir = filter_by_dir or (
2689
kind in ['directory', 'tree-reference'])
2692
# FIXME ? log the current subdir only RBC 20060203
2693
if revision is not None \
2694
and len(revision) > 0 and revision[0].get_branch():
2695
location = revision[0].get_branch()
2698
dir, relpath = controldir.ControlDir.open_containing(location)
2699
b = dir.open_branch()
2700
self.add_cleanup(b.lock_read().unlock)
2701
rev1, rev2 = _get_revision_range(revision, b, self.name())
2703
if b.get_config().validate_signatures_in_log():
2707
if not gpg.GPGStrategy.verify_signatures_available():
2708
raise errors.GpgmeNotInstalled(None)
2710
# Decide on the type of delta & diff filtering to use
2711
# TODO: add an --all-files option to make this configurable & consistent
2719
diff_type = 'partial'
2723
# Build the log formatter
2724
if log_format is None:
2725
log_format = log.log_formatter_registry.get_default(b)
2726
# Make a non-encoding output to include the diffs - bug 328007
2727
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2728
lf = log_format(show_ids=show_ids, to_file=self.outf,
2729
to_exact_file=unencoded_output,
2730
show_timezone=timezone,
2731
delta_format=get_verbosity_level(),
2733
show_advice=levels is None,
2734
author_list_handler=authors)
2736
# Choose the algorithm for doing the logging. It's annoying
2737
# having multiple code paths like this but necessary until
2738
# the underlying repository format is faster at generating
2739
# deltas or can provide everything we need from the indices.
2740
# The default algorithm - match-using-deltas - works for
2741
# multiple files and directories and is faster for small
2742
# amounts of history (200 revisions say). However, it's too
2743
# slow for logging a single file in a repository with deep
2744
# history, i.e. > 10K revisions. In the spirit of "do no
2745
# evil when adding features", we continue to use the
2746
# original algorithm - per-file-graph - for the "single
2747
# file that isn't a directory without showing a delta" case.
2748
partial_history = revision and b.repository._format.supports_chks
2749
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2750
or delta_type or partial_history)
2754
match_dict[''] = match
2756
match_dict['message'] = match_message
2758
match_dict['committer'] = match_committer
2760
match_dict['author'] = match_author
2762
match_dict['bugs'] = match_bugs
2764
# Build the LogRequest and execute it
2765
if len(file_ids) == 0:
2767
rqst = make_log_request_dict(
2768
direction=direction, specific_fileids=file_ids,
2769
start_revision=rev1, end_revision=rev2, limit=limit,
2770
message_search=message, delta_type=delta_type,
2771
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2772
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2773
signature=signatures, omit_merges=omit_merges,
2775
Logger(b, rqst).show(lf)
2778
def _get_revision_range(revisionspec_list, branch, command_name):
2779
"""Take the input of a revision option and turn it into a revision range.
2781
It returns RevisionInfo objects which can be used to obtain the rev_id's
2782
of the desired revisions. It does some user input validations.
2784
if revisionspec_list is None:
2787
elif len(revisionspec_list) == 1:
2788
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2789
elif len(revisionspec_list) == 2:
2790
start_spec = revisionspec_list[0]
2791
end_spec = revisionspec_list[1]
2792
if end_spec.get_branch() != start_spec.get_branch():
2793
# b is taken from revision[0].get_branch(), and
2794
# show_log will use its revision_history. Having
2795
# different branches will lead to weird behaviors.
2796
raise errors.BzrCommandError(gettext(
2797
"bzr %s doesn't accept two revisions in different"
2798
" branches.") % command_name)
2799
if start_spec.spec is None:
2800
# Avoid loading all the history.
2801
rev1 = RevisionInfo(branch, None, None)
2803
rev1 = start_spec.in_history(branch)
2804
# Avoid loading all of history when we know a missing
2805
# end of range means the last revision ...
2806
if end_spec.spec is None:
2807
last_revno, last_revision_id = branch.last_revision_info()
2808
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2810
rev2 = end_spec.in_history(branch)
2812
raise errors.BzrCommandError(gettext(
2813
'bzr %s --revision takes one or two values.') % command_name)
2817
def _revision_range_to_revid_range(revision_range):
2820
if revision_range[0] is not None:
2821
rev_id1 = revision_range[0].rev_id
2822
if revision_range[1] is not None:
2823
rev_id2 = revision_range[1].rev_id
2824
return rev_id1, rev_id2
2826
def get_log_format(long=False, short=False, line=False, default='long'):
2827
log_format = default
2831
log_format = 'short'
2837
class cmd_touching_revisions(Command):
2838
__doc__ = """Return revision-ids which affected a particular file.
2840
A more user-friendly interface is "bzr log FILE".
2844
takes_args = ["filename"]
2847
def run(self, filename):
2848
tree, relpath = WorkingTree.open_containing(filename)
2849
file_id = tree.path2id(relpath)
2851
self.add_cleanup(b.lock_read().unlock)
2852
touching_revs = log.find_touching_revisions(b, file_id)
2853
for revno, revision_id, what in touching_revs:
2854
self.outf.write("%6d %s\n" % (revno, what))
2857
class cmd_ls(Command):
2858
__doc__ = """List files in a tree.
2861
_see_also = ['status', 'cat']
2862
takes_args = ['path?']
2866
Option('recursive', short_name='R',
2867
help='Recurse into subdirectories.'),
2869
help='Print paths relative to the root of the branch.'),
2870
Option('unknown', short_name='u',
2871
help='Print unknown files.'),
2872
Option('versioned', help='Print versioned files.',
2874
Option('ignored', short_name='i',
2875
help='Print ignored files.'),
2876
Option('kind', short_name='k',
2877
help='List entries of a particular kind: file, directory, symlink.',
2884
def run(self, revision=None, verbose=False,
2885
recursive=False, from_root=False,
2886
unknown=False, versioned=False, ignored=False,
2887
null=False, kind=None, show_ids=False, path=None, directory=None):
2889
if kind and kind not in ('file', 'directory', 'symlink'):
2890
raise errors.BzrCommandError(gettext('invalid kind specified'))
2892
if verbose and null:
2893
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
2894
all = not (unknown or versioned or ignored)
2896
selection = {'I':ignored, '?':unknown, 'V':versioned}
2902
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
2905
tree, branch, relpath = \
2906
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2908
# Calculate the prefix to use
2912
prefix = relpath + '/'
2913
elif fs_path != '.' and not fs_path.endswith('/'):
2914
prefix = fs_path + '/'
2916
if revision is not None or tree is None:
2917
tree = _get_one_revision_tree('ls', revision, branch=branch)
2920
if isinstance(tree, WorkingTree) and tree.supports_views():
2921
view_files = tree.views.lookup_view()
2924
view_str = views.view_display_str(view_files)
2925
note(gettext("Ignoring files outside view. View is %s") % view_str)
2927
self.add_cleanup(tree.lock_read().unlock)
2928
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2929
from_dir=relpath, recursive=recursive):
2930
# Apply additional masking
2931
if not all and not selection[fc]:
2933
if kind is not None and fkind != kind:
2938
fullpath = osutils.pathjoin(relpath, fp)
2941
views.check_path_in_view(tree, fullpath)
2942
except errors.FileOutsideView:
2947
fp = osutils.pathjoin(prefix, fp)
2948
kindch = entry.kind_character()
2949
outstring = fp + kindch
2950
ui.ui_factory.clear_term()
2952
outstring = '%-8s %s' % (fc, outstring)
2953
if show_ids and fid is not None:
2954
outstring = "%-50s %s" % (outstring, fid)
2955
self.outf.write(outstring + '\n')
2957
self.outf.write(fp + '\0')
2960
self.outf.write(fid)
2961
self.outf.write('\0')
2969
self.outf.write('%-50s %s\n' % (outstring, my_id))
2971
self.outf.write(outstring + '\n')
2974
class cmd_unknowns(Command):
2975
__doc__ = """List unknown files.
2980
takes_options = ['directory']
2983
def run(self, directory=u'.'):
2984
for f in WorkingTree.open_containing(directory)[0].unknowns():
2985
self.outf.write(osutils.quotefn(f) + '\n')
2988
class cmd_ignore(Command):
2989
__doc__ = """Ignore specified files or patterns.
2991
See ``bzr help patterns`` for details on the syntax of patterns.
2993
If a .bzrignore file does not exist, the ignore command
2994
will create one and add the specified files or patterns to the newly
2995
created file. The ignore command will also automatically add the
2996
.bzrignore file to be versioned. Creating a .bzrignore file without
2997
the use of the ignore command will require an explicit add command.
2999
To remove patterns from the ignore list, edit the .bzrignore file.
3000
After adding, editing or deleting that file either indirectly by
3001
using this command or directly by using an editor, be sure to commit
3004
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3005
the global ignore file can be found in the application data directory as
3006
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3007
Global ignores are not touched by this command. The global ignore file
3008
can be edited directly using an editor.
3010
Patterns prefixed with '!' are exceptions to ignore patterns and take
3011
precedence over regular ignores. Such exceptions are used to specify
3012
files that should be versioned which would otherwise be ignored.
3014
Patterns prefixed with '!!' act as regular ignore patterns, but have
3015
precedence over the '!' exception patterns.
3019
* Ignore patterns containing shell wildcards must be quoted from
3022
* Ignore patterns starting with "#" act as comments in the ignore file.
3023
To ignore patterns that begin with that character, use the "RE:" prefix.
3026
Ignore the top level Makefile::
3028
bzr ignore ./Makefile
3030
Ignore .class files in all directories...::
3032
bzr ignore "*.class"
3034
...but do not ignore "special.class"::
3036
bzr ignore "!special.class"
3038
Ignore files whose name begins with the "#" character::
3042
Ignore .o files under the lib directory::
3044
bzr ignore "lib/**/*.o"
3046
Ignore .o files under the lib directory::
3048
bzr ignore "RE:lib/.*\.o"
3050
Ignore everything but the "debian" toplevel directory::
3052
bzr ignore "RE:(?!debian/).*"
3054
Ignore everything except the "local" toplevel directory,
3055
but always ignore autosave files ending in ~, even under local/::
3058
bzr ignore "!./local"
3062
_see_also = ['status', 'ignored', 'patterns']
3063
takes_args = ['name_pattern*']
3064
takes_options = ['directory',
3065
Option('default-rules',
3066
help='Display the default ignore rules that bzr uses.')
3069
def run(self, name_pattern_list=None, default_rules=None,
3071
from bzrlib import ignores
3072
if default_rules is not None:
3073
# dump the default rules and exit
3074
for pattern in ignores.USER_DEFAULTS:
3075
self.outf.write("%s\n" % pattern)
3077
if not name_pattern_list:
3078
raise errors.BzrCommandError(gettext("ignore requires at least one "
3079
"NAME_PATTERN or --default-rules."))
3080
name_pattern_list = [globbing.normalize_pattern(p)
3081
for p in name_pattern_list]
3083
bad_patterns_count = 0
3084
for p in name_pattern_list:
3085
if not globbing.Globster.is_pattern_valid(p):
3086
bad_patterns_count += 1
3087
bad_patterns += ('\n %s' % p)
3089
msg = (ngettext('Invalid ignore pattern found. %s',
3090
'Invalid ignore patterns found. %s',
3091
bad_patterns_count) % bad_patterns)
3092
ui.ui_factory.show_error(msg)
3093
raise errors.InvalidPattern('')
3094
for name_pattern in name_pattern_list:
3095
if (name_pattern[0] == '/' or
3096
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3097
raise errors.BzrCommandError(gettext(
3098
"NAME_PATTERN should not be an absolute path"))
3099
tree, relpath = WorkingTree.open_containing(directory)
3100
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3101
ignored = globbing.Globster(name_pattern_list)
3103
self.add_cleanup(tree.lock_read().unlock)
3104
for entry in tree.list_files():
3108
if ignored.match(filename):
3109
matches.append(filename)
3110
if len(matches) > 0:
3111
self.outf.write(gettext("Warning: the following files are version "
3112
"controlled and match your ignore pattern:\n%s"
3113
"\nThese files will continue to be version controlled"
3114
" unless you 'bzr remove' them.\n") % ("\n".join(matches),))
3117
class cmd_ignored(Command):
3118
__doc__ = """List ignored files and the patterns that matched them.
3120
List all the ignored files and the ignore pattern that caused the file to
3123
Alternatively, to list just the files::
3128
encoding_type = 'replace'
3129
_see_also = ['ignore', 'ls']
3130
takes_options = ['directory']
3133
def run(self, directory=u'.'):
3134
tree = WorkingTree.open_containing(directory)[0]
3135
self.add_cleanup(tree.lock_read().unlock)
3136
for path, file_class, kind, file_id, entry in tree.list_files():
3137
if file_class != 'I':
3139
## XXX: Slightly inefficient since this was already calculated
3140
pat = tree.is_ignored(path)
3141
self.outf.write('%-50s %s\n' % (path, pat))
3144
class cmd_lookup_revision(Command):
3145
__doc__ = """Lookup the revision-id from a revision-number
3148
bzr lookup-revision 33
3151
takes_args = ['revno']
3152
takes_options = ['directory']
3155
def run(self, revno, directory=u'.'):
3159
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3161
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3162
self.outf.write("%s\n" % revid)
3165
class cmd_export(Command):
3166
__doc__ = """Export current or past revision to a destination directory or archive.
3168
If no revision is specified this exports the last committed revision.
3170
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3171
given, try to find the format with the extension. If no extension
3172
is found exports to a directory (equivalent to --format=dir).
3174
If root is supplied, it will be used as the root directory inside
3175
container formats (tar, zip, etc). If it is not supplied it will default
3176
to the exported filename. The root option has no effect for 'dir' format.
3178
If branch is omitted then the branch containing the current working
3179
directory will be used.
3181
Note: Export of tree with non-ASCII filenames to zip is not supported.
3183
================= =========================
3184
Supported formats Autodetected by extension
3185
================= =========================
3188
tbz2 .tar.bz2, .tbz2
3191
================= =========================
3194
takes_args = ['dest', 'branch_or_subdir?']
3195
takes_options = ['directory',
3197
help="Type of file to export to.",
3200
Option('filters', help='Apply content filters to export the '
3201
'convenient form.'),
3204
help="Name of the root directory inside the exported file."),
3205
Option('per-file-timestamps',
3206
help='Set modification time of files to that of the last '
3207
'revision in which it was changed.'),
3208
Option('uncommitted',
3209
help='Export the working tree contents rather than that of the '
3212
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3213
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3215
from bzrlib.export import export
3217
if branch_or_subdir is None:
3218
branch_or_subdir = directory
3220
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3222
if tree is not None:
3223
self.add_cleanup(tree.lock_read().unlock)
3227
raise errors.BzrCommandError(
3228
gettext("--uncommitted requires a working tree"))
3231
export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3233
export(export_tree, dest, format, root, subdir, filtered=filters,
3234
per_file_timestamps=per_file_timestamps)
3235
except errors.NoSuchExportFormat, e:
3236
raise errors.BzrCommandError(
3237
gettext('Unsupported export format: %s') % e.format)
3240
class cmd_cat(Command):
3241
__doc__ = """Write the contents of a file as of a given revision to standard output.
3243
If no revision is nominated, the last revision is used.
3245
Note: Take care to redirect standard output when using this command on a
3250
takes_options = ['directory',
3251
Option('name-from-revision', help='The path name in the old tree.'),
3252
Option('filters', help='Apply content filters to display the '
3253
'convenience form.'),
3256
takes_args = ['filename']
3257
encoding_type = 'exact'
3260
def run(self, filename, revision=None, name_from_revision=False,
3261
filters=False, directory=None):
3262
if revision is not None and len(revision) != 1:
3263
raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
3264
" one revision specifier"))
3265
tree, branch, relpath = \
3266
_open_directory_or_containing_tree_or_branch(filename, directory)
3267
self.add_cleanup(branch.lock_read().unlock)
3268
return self._run(tree, branch, relpath, filename, revision,
3269
name_from_revision, filters)
3271
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3274
tree = b.basis_tree()
3275
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3276
self.add_cleanup(rev_tree.lock_read().unlock)
3278
old_file_id = rev_tree.path2id(relpath)
3280
# TODO: Split out this code to something that generically finds the
3281
# best id for a path across one or more trees; it's like
3282
# find_ids_across_trees but restricted to find just one. -- mbp
3284
if name_from_revision:
3285
# Try in revision if requested
3286
if old_file_id is None:
3287
raise errors.BzrCommandError(gettext(
3288
"{0!r} is not present in revision {1}").format(
3289
filename, rev_tree.get_revision_id()))
3291
actual_file_id = old_file_id
3293
cur_file_id = tree.path2id(relpath)
3294
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3295
actual_file_id = cur_file_id
3296
elif old_file_id is not None:
3297
actual_file_id = old_file_id
3299
raise errors.BzrCommandError(gettext(
3300
"{0!r} is not present in revision {1}").format(
3301
filename, rev_tree.get_revision_id()))
3303
from bzrlib.filter_tree import ContentFilterTree
3304
filter_tree = ContentFilterTree(rev_tree,
3305
rev_tree._content_filter_stack)
3306
content = filter_tree.get_file_text(actual_file_id)
3308
content = rev_tree.get_file_text(actual_file_id)
3310
self.outf.write(content)
3313
class cmd_local_time_offset(Command):
3314
__doc__ = """Show the offset in seconds from GMT to local time."""
3318
self.outf.write("%s\n" % osutils.local_time_offset())
3322
class cmd_commit(Command):
3323
__doc__ = """Commit changes into a new revision.
3325
An explanatory message needs to be given for each commit. This is
3326
often done by using the --message option (getting the message from the
3327
command line) or by using the --file option (getting the message from
3328
a file). If neither of these options is given, an editor is opened for
3329
the user to enter the message. To see the changed files in the
3330
boilerplate text loaded into the editor, use the --show-diff option.
3332
By default, the entire tree is committed and the person doing the
3333
commit is assumed to be the author. These defaults can be overridden
3338
If selected files are specified, only changes to those files are
3339
committed. If a directory is specified then the directory and
3340
everything within it is committed.
3342
When excludes are given, they take precedence over selected files.
3343
For example, to commit only changes within foo, but not changes
3346
bzr commit foo -x foo/bar
3348
A selective commit after a merge is not yet supported.
3352
If the author of the change is not the same person as the committer,
3353
you can specify the author's name using the --author option. The
3354
name should be in the same format as a committer-id, e.g.
3355
"John Doe <jdoe@example.com>". If there is more than one author of
3356
the change you can specify the option multiple times, once for each
3361
A common mistake is to forget to add a new file or directory before
3362
running the commit command. The --strict option checks for unknown
3363
files and aborts the commit if any are found. More advanced pre-commit
3364
checks can be implemented by defining hooks. See ``bzr help hooks``
3369
If you accidentially commit the wrong changes or make a spelling
3370
mistake in the commit message say, you can use the uncommit command
3371
to undo it. See ``bzr help uncommit`` for details.
3373
Hooks can also be configured to run after a commit. This allows you
3374
to trigger updates to external systems like bug trackers. The --fixes
3375
option can be used to record the association between a revision and
3376
one or more bugs. See ``bzr help bugs`` for details.
3379
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3380
takes_args = ['selected*']
3382
ListOption('exclude', type=str, short_name='x',
3383
help="Do not consider changes made to a given path."),
3384
Option('message', type=unicode,
3386
help="Description of the new revision."),
3389
help='Commit even if nothing has changed.'),
3390
Option('file', type=str,
3393
help='Take commit message from this file.'),
3395
help="Refuse to commit if there are unknown "
3396
"files in the working tree."),
3397
Option('commit-time', type=str,
3398
help="Manually set a commit time using commit date "
3399
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3400
ListOption('fixes', type=str,
3401
help="Mark a bug as being fixed by this revision "
3402
"(see \"bzr help bugs\")."),
3403
ListOption('author', type=unicode,
3404
help="Set the author's name, if it's different "
3405
"from the committer."),
3407
help="Perform a local commit in a bound "
3408
"branch. Local commits are not pushed to "
3409
"the master branch until a normal commit "
3412
Option('show-diff', short_name='p',
3413
help='When no message is supplied, show the diff along'
3414
' with the status summary in the message editor.'),
3416
help='When committing to a foreign version control '
3417
'system do not push data that can not be natively '
3420
aliases = ['ci', 'checkin']
3422
def _iter_bug_fix_urls(self, fixes, branch):
3423
default_bugtracker = None
3424
# Configure the properties for bug fixing attributes.
3425
for fixed_bug in fixes:
3426
tokens = fixed_bug.split(':')
3427
if len(tokens) == 1:
3428
if default_bugtracker is None:
3429
branch_config = branch.get_config()
3430
default_bugtracker = branch_config.get_user_option(
3432
if default_bugtracker is None:
3433
raise errors.BzrCommandError(gettext(
3434
"No tracker specified for bug %s. Use the form "
3435
"'tracker:id' or specify a default bug tracker "
3436
"using the `bugtracker` option.\nSee "
3437
"\"bzr help bugs\" for more information on this "
3438
"feature. Commit refused.") % fixed_bug)
3439
tag = default_bugtracker
3441
elif len(tokens) != 2:
3442
raise errors.BzrCommandError(gettext(
3443
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3444
"See \"bzr help bugs\" for more information on this "
3445
"feature.\nCommit refused.") % fixed_bug)
3447
tag, bug_id = tokens
3449
yield bugtracker.get_bug_url(tag, branch, bug_id)
3450
except errors.UnknownBugTrackerAbbreviation:
3451
raise errors.BzrCommandError(gettext(
3452
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3453
except errors.MalformedBugIdentifier, e:
3454
raise errors.BzrCommandError(gettext(
3455
"%s\nCommit refused.") % (str(e),))
3457
def run(self, message=None, file=None, verbose=False, selected_list=None,
3458
unchanged=False, strict=False, local=False, fixes=None,
3459
author=None, show_diff=False, exclude=None, commit_time=None,
3461
from bzrlib.errors import (
3466
from bzrlib.msgeditor import (
3467
edit_commit_message_encoded,
3468
generate_commit_message_template,
3469
make_commit_message_template_encoded,
3473
commit_stamp = offset = None
3474
if commit_time is not None:
3476
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3477
except ValueError, e:
3478
raise errors.BzrCommandError(gettext(
3479
"Could not parse --commit-time: " + str(e)))
3483
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3484
if selected_list == ['']:
3485
# workaround - commit of root of tree should be exactly the same
3486
# as just default commit in that tree, and succeed even though
3487
# selected-file merge commit is not done yet
3492
bug_property = bugtracker.encode_fixes_bug_urls(
3493
self._iter_bug_fix_urls(fixes, tree.branch))
3495
properties['bugs'] = bug_property
3497
if local and not tree.branch.get_bound_location():
3498
raise errors.LocalRequiresBoundBranch()
3500
if message is not None:
3502
file_exists = osutils.lexists(message)
3503
except UnicodeError:
3504
# The commit message contains unicode characters that can't be
3505
# represented in the filesystem encoding, so that can't be a
3510
'The commit message is a file name: "%(f)s".\n'
3511
'(use --file "%(f)s" to take commit message from that file)'
3513
ui.ui_factory.show_warning(warning_msg)
3515
message = message.replace('\r\n', '\n')
3516
message = message.replace('\r', '\n')
3518
raise errors.BzrCommandError(gettext(
3519
"please specify either --message or --file"))
3521
def get_message(commit_obj):
3522
"""Callback to get commit message"""
3526
my_message = f.read().decode(osutils.get_user_encoding())
3529
elif message is not None:
3530
my_message = message
3532
# No message supplied: make one up.
3533
# text is the status of the tree
3534
text = make_commit_message_template_encoded(tree,
3535
selected_list, diff=show_diff,
3536
output_encoding=osutils.get_user_encoding())
3537
# start_message is the template generated from hooks
3538
# XXX: Warning - looks like hooks return unicode,
3539
# make_commit_message_template_encoded returns user encoding.
3540
# We probably want to be using edit_commit_message instead to
3542
my_message = set_commit_message(commit_obj)
3543
if my_message is None:
3544
start_message = generate_commit_message_template(commit_obj)
3545
my_message = edit_commit_message_encoded(text,
3546
start_message=start_message)
3547
if my_message is None:
3548
raise errors.BzrCommandError(gettext("please specify a commit"
3549
" message with either --message or --file"))
3550
if my_message == "":
3551
raise errors.BzrCommandError(gettext("Empty commit message specified."
3552
" Please specify a commit message with either"
3553
" --message or --file or leave a blank message"
3554
" with --message \"\"."))
3557
# The API permits a commit with a filter of [] to mean 'select nothing'
3558
# but the command line should not do that.
3559
if not selected_list:
3560
selected_list = None
3562
tree.commit(message_callback=get_message,
3563
specific_files=selected_list,
3564
allow_pointless=unchanged, strict=strict, local=local,
3565
reporter=None, verbose=verbose, revprops=properties,
3566
authors=author, timestamp=commit_stamp,
3568
exclude=tree.safe_relpath_files(exclude),
3570
except PointlessCommit:
3571
raise errors.BzrCommandError(gettext("No changes to commit."
3572
" Please 'bzr add' the files you want to commit, or use"
3573
" --unchanged to force an empty commit."))
3574
except ConflictsInTree:
3575
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3576
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3578
except StrictCommitFailed:
3579
raise errors.BzrCommandError(gettext("Commit refused because there are"
3580
" unknown files in the working tree."))
3581
except errors.BoundBranchOutOfDate, e:
3582
e.extra_help = (gettext("\n"
3583
'To commit to master branch, run update and then commit.\n'
3584
'You can also pass --local to commit to continue working '
3589
class cmd_check(Command):
3590
__doc__ = """Validate working tree structure, branch consistency and repository history.
3592
This command checks various invariants about branch and repository storage
3593
to detect data corruption or bzr bugs.
3595
The working tree and branch checks will only give output if a problem is
3596
detected. The output fields of the repository check are:
3599
This is just the number of revisions checked. It doesn't
3603
This is just the number of versionedfiles checked. It
3604
doesn't indicate a problem.
3606
unreferenced ancestors
3607
Texts that are ancestors of other texts, but
3608
are not properly referenced by the revision ancestry. This is a
3609
subtle problem that Bazaar can work around.
3612
This is the total number of unique file contents
3613
seen in the checked revisions. It does not indicate a problem.
3616
This is the total number of repeated texts seen
3617
in the checked revisions. Texts can be repeated when their file
3618
entries are modified, but the file contents are not. It does not
3621
If no restrictions are specified, all Bazaar data that is found at the given
3622
location will be checked.
3626
Check the tree and branch at 'foo'::
3628
bzr check --tree --branch foo
3630
Check only the repository at 'bar'::
3632
bzr check --repo bar
3634
Check everything at 'baz'::
3639
_see_also = ['reconcile']
3640
takes_args = ['path?']
3641
takes_options = ['verbose',
3642
Option('branch', help="Check the branch related to the"
3643
" current directory."),
3644
Option('repo', help="Check the repository related to the"
3645
" current directory."),
3646
Option('tree', help="Check the working tree related to"
3647
" the current directory.")]
3649
def run(self, path=None, verbose=False, branch=False, repo=False,
3651
from bzrlib.check import check_dwim
3654
if not branch and not repo and not tree:
3655
branch = repo = tree = True
3656
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3659
class cmd_upgrade(Command):
3660
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3662
When the default format has changed after a major new release of
3663
Bazaar, you may be informed during certain operations that you
3664
should upgrade. Upgrading to a newer format may improve performance
3665
or make new features available. It may however limit interoperability
3666
with older repositories or with older versions of Bazaar.
3668
If you wish to upgrade to a particular format rather than the
3669
current default, that can be specified using the --format option.
3670
As a consequence, you can use the upgrade command this way to
3671
"downgrade" to an earlier format, though some conversions are
3672
a one way process (e.g. changing from the 1.x default to the
3673
2.x default) so downgrading is not always possible.
3675
A backup.bzr.~#~ directory is created at the start of the conversion
3676
process (where # is a number). By default, this is left there on
3677
completion. If the conversion fails, delete the new .bzr directory
3678
and rename this one back in its place. Use the --clean option to ask
3679
for the backup.bzr directory to be removed on successful conversion.
3680
Alternatively, you can delete it by hand if everything looks good
3683
If the location given is a shared repository, dependent branches
3684
are also converted provided the repository converts successfully.
3685
If the conversion of a branch fails, remaining branches are still
3688
For more information on upgrades, see the Bazaar Upgrade Guide,
3689
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3692
_see_also = ['check', 'reconcile', 'formats']
3693
takes_args = ['url?']
3695
RegistryOption('format',
3696
help='Upgrade to a specific format. See "bzr help'
3697
' formats" for details.',
3698
lazy_registry=('bzrlib.controldir', 'format_registry'),
3699
converter=lambda name: controldir.format_registry.make_bzrdir(name),
3700
value_switches=True, title='Branch format'),
3702
help='Remove the backup.bzr directory if successful.'),
3704
help="Show what would be done, but don't actually do anything."),
3707
def run(self, url='.', format=None, clean=False, dry_run=False):
3708
from bzrlib.upgrade import upgrade
3709
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3711
if len(exceptions) == 1:
3712
# Compatibility with historical behavior
3718
class cmd_whoami(Command):
3719
__doc__ = """Show or set bzr user id.
3722
Show the email of the current user::
3726
Set the current user::
3728
bzr whoami "Frank Chu <fchu@example.com>"
3730
takes_options = [ 'directory',
3732
help='Display email address only.'),
3734
help='Set identity for the current branch instead of '
3737
takes_args = ['name?']
3738
encoding_type = 'replace'
3741
def run(self, email=False, branch=False, name=None, directory=None):
3743
if directory is None:
3744
# use branch if we're inside one; otherwise global config
3746
c = Branch.open_containing(u'.')[0].get_config_stack()
3747
except errors.NotBranchError:
3748
c = _mod_config.GlobalStack()
3750
c = Branch.open(directory).get_config_stack()
3751
identity = c.get('email')
3753
self.outf.write(_mod_config.extract_email_address(identity)
3756
self.outf.write(identity + '\n')
3760
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3763
# display a warning if an email address isn't included in the given name.
3765
_mod_config.extract_email_address(name)
3766
except errors.NoEmailInUsername, e:
3767
warning('"%s" does not seem to contain an email address. '
3768
'This is allowed, but not recommended.', name)
3770
# use global config unless --branch given
3772
if directory is None:
3773
c = Branch.open_containing(u'.')[0].get_config_stack()
3775
b = Branch.open(directory)
3776
self.add_cleanup(b.lock_write().unlock)
3777
c = b.get_config_stack()
3779
c = _mod_config.GlobalStack()
3780
c.set('email', name)
3783
class cmd_nick(Command):
3784
__doc__ = """Print or set the branch nickname.
3786
If unset, the tree root directory name is used as the nickname.
3787
To print the current nickname, execute with no argument.
3789
Bound branches use the nickname of its master branch unless it is set
3793
_see_also = ['info']
3794
takes_args = ['nickname?']
3795
takes_options = ['directory']
3796
def run(self, nickname=None, directory=u'.'):
3797
branch = Branch.open_containing(directory)[0]
3798
if nickname is None:
3799
self.printme(branch)
3801
branch.nick = nickname
3804
def printme(self, branch):
3805
self.outf.write('%s\n' % branch.nick)
3808
class cmd_alias(Command):
3809
__doc__ = """Set/unset and display aliases.
3812
Show the current aliases::
3816
Show the alias specified for 'll'::
3820
Set an alias for 'll'::
3822
bzr alias ll="log --line -r-10..-1"
3824
To remove an alias for 'll'::
3826
bzr alias --remove ll
3829
takes_args = ['name?']
3831
Option('remove', help='Remove the alias.'),
3834
def run(self, name=None, remove=False):
3836
self.remove_alias(name)
3838
self.print_aliases()
3840
equal_pos = name.find('=')
3842
self.print_alias(name)
3844
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3846
def remove_alias(self, alias_name):
3847
if alias_name is None:
3848
raise errors.BzrCommandError(gettext(
3849
'bzr alias --remove expects an alias to remove.'))
3850
# If alias is not found, print something like:
3851
# unalias: foo: not found
3852
c = _mod_config.GlobalConfig()
3853
c.unset_alias(alias_name)
3856
def print_aliases(self):
3857
"""Print out the defined aliases in a similar format to bash."""
3858
aliases = _mod_config.GlobalConfig().get_aliases()
3859
for key, value in sorted(aliases.iteritems()):
3860
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3863
def print_alias(self, alias_name):
3864
from bzrlib.commands import get_alias
3865
alias = get_alias(alias_name)
3867
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3870
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3872
def set_alias(self, alias_name, alias_command):
3873
"""Save the alias in the global config."""
3874
c = _mod_config.GlobalConfig()
3875
c.set_alias(alias_name, alias_command)
3878
class cmd_selftest(Command):
3879
__doc__ = """Run internal test suite.
3881
If arguments are given, they are regular expressions that say which tests
3882
should run. Tests matching any expression are run, and other tests are
3885
Alternatively if --first is given, matching tests are run first and then
3886
all other tests are run. This is useful if you have been working in a
3887
particular area, but want to make sure nothing else was broken.
3889
If --exclude is given, tests that match that regular expression are
3890
excluded, regardless of whether they match --first or not.
3892
To help catch accidential dependencies between tests, the --randomize
3893
option is useful. In most cases, the argument used is the word 'now'.
3894
Note that the seed used for the random number generator is displayed
3895
when this option is used. The seed can be explicitly passed as the
3896
argument to this option if required. This enables reproduction of the
3897
actual ordering used if and when an order sensitive problem is encountered.
3899
If --list-only is given, the tests that would be run are listed. This is
3900
useful when combined with --first, --exclude and/or --randomize to
3901
understand their impact. The test harness reports "Listed nn tests in ..."
3902
instead of "Ran nn tests in ..." when list mode is enabled.
3904
If the global option '--no-plugins' is given, plugins are not loaded
3905
before running the selftests. This has two effects: features provided or
3906
modified by plugins will not be tested, and tests provided by plugins will
3909
Tests that need working space on disk use a common temporary directory,
3910
typically inside $TMPDIR or /tmp.
3912
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3913
into a pdb postmortem session.
3915
The --coverage=DIRNAME global option produces a report with covered code
3919
Run only tests relating to 'ignore'::
3923
Disable plugins and list tests as they're run::
3925
bzr --no-plugins selftest -v
3927
# NB: this is used from the class without creating an instance, which is
3928
# why it does not have a self parameter.
3929
def get_transport_type(typestring):
3930
"""Parse and return a transport specifier."""
3931
if typestring == "sftp":
3932
from bzrlib.tests import stub_sftp
3933
return stub_sftp.SFTPAbsoluteServer
3934
elif typestring == "memory":
3935
from bzrlib.tests import test_server
3936
return memory.MemoryServer
3937
elif typestring == "fakenfs":
3938
from bzrlib.tests import test_server
3939
return test_server.FakeNFSServer
3940
msg = "No known transport type %s. Supported types are: sftp\n" %\
3942
raise errors.BzrCommandError(msg)
3945
takes_args = ['testspecs*']
3946
takes_options = ['verbose',
3948
help='Stop when one test fails.',
3952
help='Use a different transport by default '
3953
'throughout the test suite.',
3954
type=get_transport_type),
3956
help='Run the benchmarks rather than selftests.',
3958
Option('lsprof-timed',
3959
help='Generate lsprof output for benchmarked'
3960
' sections of code.'),
3961
Option('lsprof-tests',
3962
help='Generate lsprof output for each test.'),
3964
help='Run all tests, but run specified tests first.',
3968
help='List the tests instead of running them.'),
3969
RegistryOption('parallel',
3970
help="Run the test suite in parallel.",
3971
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3972
value_switches=False,
3974
Option('randomize', type=str, argname="SEED",
3975
help='Randomize the order of tests using the given'
3976
' seed or "now" for the current time.'),
3977
ListOption('exclude', type=str, argname="PATTERN",
3979
help='Exclude tests that match this regular'
3982
help='Output test progress via subunit.'),
3983
Option('strict', help='Fail on missing dependencies or '
3985
Option('load-list', type=str, argname='TESTLISTFILE',
3986
help='Load a test id list from a text file.'),
3987
ListOption('debugflag', type=str, short_name='E',
3988
help='Turn on a selftest debug flag.'),
3989
ListOption('starting-with', type=str, argname='TESTID',
3990
param_name='starting_with', short_name='s',
3992
'Load only the tests starting with TESTID.'),
3994
help="By default we disable fsync and fdatasync"
3995
" while running the test suite.")
3997
encoding_type = 'replace'
4000
Command.__init__(self)
4001
self.additional_selftest_args = {}
4003
def run(self, testspecs_list=None, verbose=False, one=False,
4004
transport=None, benchmark=None,
4006
first=False, list_only=False,
4007
randomize=None, exclude=None, strict=False,
4008
load_list=None, debugflag=None, starting_with=None, subunit=False,
4009
parallel=None, lsprof_tests=False,
4012
# During selftest, disallow proxying, as it can cause severe
4013
# performance penalties and is only needed for thread
4014
# safety. The selftest command is assumed to not use threads
4015
# too heavily. The call should be as early as possible, as
4016
# error reporting for past duplicate imports won't have useful
4018
lazy_import.disallow_proxying()
4020
from bzrlib import tests
4022
if testspecs_list is not None:
4023
pattern = '|'.join(testspecs_list)
4028
from bzrlib.tests import SubUnitBzrRunner
4030
raise errors.BzrCommandError(gettext("subunit not available. subunit "
4031
"needs to be installed to use --subunit."))
4032
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
4033
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4034
# stdout, which would corrupt the subunit stream.
4035
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4036
# following code can be deleted when it's sufficiently deployed
4037
# -- vila/mgz 20100514
4038
if (sys.platform == "win32"
4039
and getattr(sys.stdout, 'fileno', None) is not None):
4041
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4043
self.additional_selftest_args.setdefault(
4044
'suite_decorators', []).append(parallel)
4046
raise errors.BzrCommandError(gettext(
4047
"--benchmark is no longer supported from bzr 2.2; "
4048
"use bzr-usertest instead"))
4049
test_suite_factory = None
4051
exclude_pattern = None
4053
exclude_pattern = '(' + '|'.join(exclude) + ')'
4055
self._disable_fsync()
4056
selftest_kwargs = {"verbose": verbose,
4058
"stop_on_failure": one,
4059
"transport": transport,
4060
"test_suite_factory": test_suite_factory,
4061
"lsprof_timed": lsprof_timed,
4062
"lsprof_tests": lsprof_tests,
4063
"matching_tests_first": first,
4064
"list_only": list_only,
4065
"random_seed": randomize,
4066
"exclude_pattern": exclude_pattern,
4068
"load_list": load_list,
4069
"debug_flags": debugflag,
4070
"starting_with": starting_with
4072
selftest_kwargs.update(self.additional_selftest_args)
4074
# Make deprecation warnings visible, unless -Werror is set
4075
cleanup = symbol_versioning.activate_deprecation_warnings(
4078
result = tests.selftest(**selftest_kwargs)
4081
return int(not result)
4083
def _disable_fsync(self):
4084
"""Change the 'os' functionality to not synchronize."""
4085
self._orig_fsync = getattr(os, 'fsync', None)
4086
if self._orig_fsync is not None:
4087
os.fsync = lambda filedes: None
4088
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4089
if self._orig_fdatasync is not None:
4090
os.fdatasync = lambda filedes: None
4093
class cmd_version(Command):
4094
__doc__ = """Show version of bzr."""
4096
encoding_type = 'replace'
4098
Option("short", help="Print just the version number."),
4102
def run(self, short=False):
4103
from bzrlib.version import show_version
4105
self.outf.write(bzrlib.version_string + '\n')
4107
show_version(to_file=self.outf)
4110
class cmd_rocks(Command):
4111
__doc__ = """Statement of optimism."""
4117
self.outf.write(gettext("It sure does!\n"))
4120
class cmd_find_merge_base(Command):
4121
__doc__ = """Find and print a base revision for merging two branches."""
4122
# TODO: Options to specify revisions on either side, as if
4123
# merging only part of the history.
4124
takes_args = ['branch', 'other']
4128
def run(self, branch, other):
4129
from bzrlib.revision import ensure_null
4131
branch1 = Branch.open_containing(branch)[0]
4132
branch2 = Branch.open_containing(other)[0]
4133
self.add_cleanup(branch1.lock_read().unlock)
4134
self.add_cleanup(branch2.lock_read().unlock)
4135
last1 = ensure_null(branch1.last_revision())
4136
last2 = ensure_null(branch2.last_revision())
4138
graph = branch1.repository.get_graph(branch2.repository)
4139
base_rev_id = graph.find_unique_lca(last1, last2)
4141
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4144
class cmd_merge(Command):
4145
__doc__ = """Perform a three-way merge.
4147
The source of the merge can be specified either in the form of a branch,
4148
or in the form of a path to a file containing a merge directive generated
4149
with bzr send. If neither is specified, the default is the upstream branch
4150
or the branch most recently merged using --remember. The source of the
4151
merge may also be specified in the form of a path to a file in another
4152
branch: in this case, only the modifications to that file are merged into
4153
the current working tree.
4155
When merging from a branch, by default bzr will try to merge in all new
4156
work from the other branch, automatically determining an appropriate base
4157
revision. If this fails, you may need to give an explicit base.
4159
To pick a different ending revision, pass "--revision OTHER". bzr will
4160
try to merge in all new work up to and including revision OTHER.
4162
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4163
through OTHER, excluding BASE but including OTHER, will be merged. If this
4164
causes some revisions to be skipped, i.e. if the destination branch does
4165
not already contain revision BASE, such a merge is commonly referred to as
4166
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4167
cherrypicks. The changes look like a normal commit, and the history of the
4168
changes from the other branch is not stored in the commit.
4170
Revision numbers are always relative to the source branch.
4172
Merge will do its best to combine the changes in two branches, but there
4173
are some kinds of problems only a human can fix. When it encounters those,
4174
it will mark a conflict. A conflict means that you need to fix something,
4175
before you should commit.
4177
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
4179
If there is no default branch set, the first merge will set it (use
4180
--no-remember to avoid setting it). After that, you can omit the branch
4181
to use the default. To change the default, use --remember. The value will
4182
only be saved if the remote location can be accessed.
4184
The results of the merge are placed into the destination working
4185
directory, where they can be reviewed (with bzr diff), tested, and then
4186
committed to record the result of the merge.
4188
merge refuses to run if there are any uncommitted changes, unless
4189
--force is given. If --force is given, then the changes from the source
4190
will be merged with the current working tree, including any uncommitted
4191
changes in the tree. The --force option can also be used to create a
4192
merge revision which has more than two parents.
4194
If one would like to merge changes from the working tree of the other
4195
branch without merging any committed revisions, the --uncommitted option
4198
To select only some changes to merge, use "merge -i", which will prompt
4199
you to apply each diff hunk and file change, similar to "shelve".
4202
To merge all new revisions from bzr.dev::
4204
bzr merge ../bzr.dev
4206
To merge changes up to and including revision 82 from bzr.dev::
4208
bzr merge -r 82 ../bzr.dev
4210
To merge the changes introduced by 82, without previous changes::
4212
bzr merge -r 81..82 ../bzr.dev
4214
To apply a merge directive contained in /tmp/merge::
4216
bzr merge /tmp/merge
4218
To create a merge revision with three parents from two branches
4219
feature1a and feature1b:
4221
bzr merge ../feature1a
4222
bzr merge ../feature1b --force
4223
bzr commit -m 'revision with three parents'
4226
encoding_type = 'exact'
4227
_see_also = ['update', 'remerge', 'status-flags', 'send']
4228
takes_args = ['location?']
4233
help='Merge even if the destination tree has uncommitted changes.'),
4237
Option('show-base', help="Show base revision text in "
4239
Option('uncommitted', help='Apply uncommitted changes'
4240
' from a working copy, instead of branch changes.'),
4241
Option('pull', help='If the destination is already'
4242
' completely merged into the source, pull from the'
4243
' source rather than merging. When this happens,'
4244
' you do not need to commit the result.'),
4245
custom_help('directory',
4246
help='Branch to merge into, '
4247
'rather than the one containing the working directory.'),
4248
Option('preview', help='Instead of merging, show a diff of the'
4250
Option('interactive', help='Select changes interactively.',
4254
def run(self, location=None, revision=None, force=False,
4255
merge_type=None, show_base=False, reprocess=None, remember=None,
4256
uncommitted=False, pull=False,
4261
if merge_type is None:
4262
merge_type = _mod_merge.Merge3Merger
4264
if directory is None: directory = u'.'
4265
possible_transports = []
4267
allow_pending = True
4268
verified = 'inapplicable'
4270
tree = WorkingTree.open_containing(directory)[0]
4271
if tree.branch.revno() == 0:
4272
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4273
'https://bugs.launchpad.net/bzr/+bug/308562'))
4276
basis_tree = tree.revision_tree(tree.last_revision())
4277
except errors.NoSuchRevision:
4278
basis_tree = tree.basis_tree()
4280
# die as quickly as possible if there are uncommitted changes
4282
if tree.has_changes():
4283
raise errors.UncommittedChanges(tree)
4285
view_info = _get_view_info_for_change_reporter(tree)
4286
change_reporter = delta._ChangeReporter(
4287
unversioned_filter=tree.is_ignored, view_info=view_info)
4288
pb = ui.ui_factory.nested_progress_bar()
4289
self.add_cleanup(pb.finished)
4290
self.add_cleanup(tree.lock_write().unlock)
4291
if location is not None:
4293
mergeable = bundle.read_mergeable_from_url(location,
4294
possible_transports=possible_transports)
4295
except errors.NotABundle:
4299
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4300
' with bundles or merge directives.'))
4302
if revision is not None:
4303
raise errors.BzrCommandError(gettext(
4304
'Cannot use -r with merge directives or bundles'))
4305
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4308
if merger is None and uncommitted:
4309
if revision is not None and len(revision) > 0:
4310
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4311
' --revision at the same time.'))
4312
merger = self.get_merger_from_uncommitted(tree, location, None)
4313
allow_pending = False
4316
merger, allow_pending = self._get_merger_from_branch(tree,
4317
location, revision, remember, possible_transports, None)
4319
merger.merge_type = merge_type
4320
merger.reprocess = reprocess
4321
merger.show_base = show_base
4322
self.sanity_check_merger(merger)
4323
if (merger.base_rev_id == merger.other_rev_id and
4324
merger.other_rev_id is not None):
4325
# check if location is a nonexistent file (and not a branch) to
4326
# disambiguate the 'Nothing to do'
4327
if merger.interesting_files:
4328
if not merger.other_tree.has_filename(
4329
merger.interesting_files[0]):
4330
note(gettext("merger: ") + str(merger))
4331
raise errors.PathsDoNotExist([location])
4332
note(gettext('Nothing to do.'))
4334
if pull and not preview:
4335
if merger.interesting_files is not None:
4336
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4337
if (merger.base_rev_id == tree.last_revision()):
4338
result = tree.pull(merger.other_branch, False,
4339
merger.other_rev_id)
4340
result.report(self.outf)
4342
if merger.this_basis is None:
4343
raise errors.BzrCommandError(gettext(
4344
"This branch has no commits."
4345
" (perhaps you would prefer 'bzr pull')"))
4347
return self._do_preview(merger)
4349
return self._do_interactive(merger)
4351
return self._do_merge(merger, change_reporter, allow_pending,
4354
def _get_preview(self, merger):
4355
tree_merger = merger.make_merger()
4356
tt = tree_merger.make_preview_transform()
4357
self.add_cleanup(tt.finalize)
4358
result_tree = tt.get_preview_tree()
4361
def _do_preview(self, merger):
4362
from bzrlib.diff import show_diff_trees
4363
result_tree = self._get_preview(merger)
4364
path_encoding = osutils.get_diff_header_encoding()
4365
show_diff_trees(merger.this_tree, result_tree, self.outf,
4366
old_label='', new_label='',
4367
path_encoding=path_encoding)
4369
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4370
merger.change_reporter = change_reporter
4371
conflict_count = merger.do_merge()
4373
merger.set_pending()
4374
if verified == 'failed':
4375
warning('Preview patch does not match changes')
4376
if conflict_count != 0:
4381
def _do_interactive(self, merger):
4382
"""Perform an interactive merge.
4384
This works by generating a preview tree of the merge, then using
4385
Shelver to selectively remove the differences between the working tree
4386
and the preview tree.
4388
from bzrlib import shelf_ui
4389
result_tree = self._get_preview(merger)
4390
writer = bzrlib.option.diff_writer_registry.get()
4391
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4392
reporter=shelf_ui.ApplyReporter(),
4393
diff_writer=writer(sys.stdout))
4399
def sanity_check_merger(self, merger):
4400
if (merger.show_base and
4401
not merger.merge_type is _mod_merge.Merge3Merger):
4402
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4403
" merge type. %s") % merger.merge_type)
4404
if merger.reprocess is None:
4405
if merger.show_base:
4406
merger.reprocess = False
4408
# Use reprocess if the merger supports it
4409
merger.reprocess = merger.merge_type.supports_reprocess
4410
if merger.reprocess and not merger.merge_type.supports_reprocess:
4411
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4412
" for merge type %s.") %
4414
if merger.reprocess and merger.show_base:
4415
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4418
def _get_merger_from_branch(self, tree, location, revision, remember,
4419
possible_transports, pb):
4420
"""Produce a merger from a location, assuming it refers to a branch."""
4421
from bzrlib.tag import _merge_tags_if_possible
4422
# find the branch locations
4423
other_loc, user_location = self._select_branch_location(tree, location,
4425
if revision is not None and len(revision) == 2:
4426
base_loc, _unused = self._select_branch_location(tree,
4427
location, revision, 0)
4429
base_loc = other_loc
4431
other_branch, other_path = Branch.open_containing(other_loc,
4432
possible_transports)
4433
if base_loc == other_loc:
4434
base_branch = other_branch
4436
base_branch, base_path = Branch.open_containing(base_loc,
4437
possible_transports)
4438
# Find the revision ids
4439
other_revision_id = None
4440
base_revision_id = None
4441
if revision is not None:
4442
if len(revision) >= 1:
4443
other_revision_id = revision[-1].as_revision_id(other_branch)
4444
if len(revision) == 2:
4445
base_revision_id = revision[0].as_revision_id(base_branch)
4446
if other_revision_id is None:
4447
other_revision_id = _mod_revision.ensure_null(
4448
other_branch.last_revision())
4449
# Remember where we merge from. We need to remember if:
4450
# - user specify a location (and we don't merge from the parent
4452
# - user ask to remember or there is no previous location set to merge
4453
# from and user didn't ask to *not* remember
4454
if (user_location is not None
4456
or (remember is None
4457
and tree.branch.get_submit_branch() is None)))):
4458
tree.branch.set_submit_branch(other_branch.base)
4459
# Merge tags (but don't set them in the master branch yet, the user
4460
# might revert this merge). Commit will propagate them.
4461
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4462
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4463
other_revision_id, base_revision_id, other_branch, base_branch)
4464
if other_path != '':
4465
allow_pending = False
4466
merger.interesting_files = [other_path]
4468
allow_pending = True
4469
return merger, allow_pending
4471
def get_merger_from_uncommitted(self, tree, location, pb):
4472
"""Get a merger for uncommitted changes.
4474
:param tree: The tree the merger should apply to.
4475
:param location: The location containing uncommitted changes.
4476
:param pb: The progress bar to use for showing progress.
4478
location = self._select_branch_location(tree, location)[0]
4479
other_tree, other_path = WorkingTree.open_containing(location)
4480
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4481
if other_path != '':
4482
merger.interesting_files = [other_path]
4485
def _select_branch_location(self, tree, user_location, revision=None,
4487
"""Select a branch location, according to possible inputs.
4489
If provided, branches from ``revision`` are preferred. (Both
4490
``revision`` and ``index`` must be supplied.)
4492
Otherwise, the ``location`` parameter is used. If it is None, then the
4493
``submit`` or ``parent`` location is used, and a note is printed.
4495
:param tree: The working tree to select a branch for merging into
4496
:param location: The location entered by the user
4497
:param revision: The revision parameter to the command
4498
:param index: The index to use for the revision parameter. Negative
4499
indices are permitted.
4500
:return: (selected_location, user_location). The default location
4501
will be the user-entered location.
4503
if (revision is not None and index is not None
4504
and revision[index] is not None):
4505
branch = revision[index].get_branch()
4506
if branch is not None:
4507
return branch, branch
4508
if user_location is None:
4509
location = self._get_remembered(tree, 'Merging from')
4511
location = user_location
4512
return location, user_location
4514
def _get_remembered(self, tree, verb_string):
4515
"""Use tree.branch's parent if none was supplied.
4517
Report if the remembered location was used.
4519
stored_location = tree.branch.get_submit_branch()
4520
stored_location_type = "submit"
4521
if stored_location is None:
4522
stored_location = tree.branch.get_parent()
4523
stored_location_type = "parent"
4524
mutter("%s", stored_location)
4525
if stored_location is None:
4526
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4527
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4528
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4529
stored_location_type, display_url))
4530
return stored_location
4533
class cmd_remerge(Command):
4534
__doc__ = """Redo a merge.
4536
Use this if you want to try a different merge technique while resolving
4537
conflicts. Some merge techniques are better than others, and remerge
4538
lets you try different ones on different files.
4540
The options for remerge have the same meaning and defaults as the ones for
4541
merge. The difference is that remerge can (only) be run when there is a
4542
pending merge, and it lets you specify particular files.
4545
Re-do the merge of all conflicted files, and show the base text in
4546
conflict regions, in addition to the usual THIS and OTHER texts::
4548
bzr remerge --show-base
4550
Re-do the merge of "foobar", using the weave merge algorithm, with
4551
additional processing to reduce the size of conflict regions::
4553
bzr remerge --merge-type weave --reprocess foobar
4555
takes_args = ['file*']
4560
help="Show base revision text in conflicts."),
4563
def run(self, file_list=None, merge_type=None, show_base=False,
4565
from bzrlib.conflicts import restore
4566
if merge_type is None:
4567
merge_type = _mod_merge.Merge3Merger
4568
tree, file_list = WorkingTree.open_containing_paths(file_list)
4569
self.add_cleanup(tree.lock_write().unlock)
4570
parents = tree.get_parent_ids()
4571
if len(parents) != 2:
4572
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4573
" merges. Not cherrypicking or"
4575
repository = tree.branch.repository
4576
interesting_ids = None
4578
conflicts = tree.conflicts()
4579
if file_list is not None:
4580
interesting_ids = set()
4581
for filename in file_list:
4582
file_id = tree.path2id(filename)
4584
raise errors.NotVersionedError(filename)
4585
interesting_ids.add(file_id)
4586
if tree.kind(file_id) != "directory":
4589
for name, ie in tree.inventory.iter_entries(file_id):
4590
interesting_ids.add(ie.file_id)
4591
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4593
# Remerge only supports resolving contents conflicts
4594
allowed_conflicts = ('text conflict', 'contents conflict')
4595
restore_files = [c.path for c in conflicts
4596
if c.typestring in allowed_conflicts]
4597
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4598
tree.set_conflicts(ConflictList(new_conflicts))
4599
if file_list is not None:
4600
restore_files = file_list
4601
for filename in restore_files:
4603
restore(tree.abspath(filename))
4604
except errors.NotConflicted:
4606
# Disable pending merges, because the file texts we are remerging
4607
# have not had those merges performed. If we use the wrong parents
4608
# list, we imply that the working tree text has seen and rejected
4609
# all the changes from the other tree, when in fact those changes
4610
# have not yet been seen.
4611
tree.set_parent_ids(parents[:1])
4613
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4614
merger.interesting_ids = interesting_ids
4615
merger.merge_type = merge_type
4616
merger.show_base = show_base
4617
merger.reprocess = reprocess
4618
conflicts = merger.do_merge()
4620
tree.set_parent_ids(parents)
4627
class cmd_revert(Command):
4628
__doc__ = """Revert files to a previous revision.
4630
Giving a list of files will revert only those files. Otherwise, all files
4631
will be reverted. If the revision is not specified with '--revision', the
4632
last committed revision is used.
4634
To remove only some changes, without reverting to a prior version, use
4635
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4636
will remove the changes introduced by the second last commit (-2), without
4637
affecting the changes introduced by the last commit (-1). To remove
4638
certain changes on a hunk-by-hunk basis, see the shelve command.
4640
By default, any files that have been manually changed will be backed up
4641
first. (Files changed only by merge are not backed up.) Backup files have
4642
'.~#~' appended to their name, where # is a number.
4644
When you provide files, you can use their current pathname or the pathname
4645
from the target revision. So you can use revert to "undelete" a file by
4646
name. If you name a directory, all the contents of that directory will be
4649
If you have newly added files since the target revision, they will be
4650
removed. If the files to be removed have been changed, backups will be
4651
created as above. Directories containing unknown files will not be
4654
The working tree contains a list of revisions that have been merged but
4655
not yet committed. These revisions will be included as additional parents
4656
of the next commit. Normally, using revert clears that list as well as
4657
reverting the files. If any files are specified, revert leaves the list
4658
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4659
.`` in the tree root to revert all files but keep the recorded merges,
4660
and ``bzr revert --forget-merges`` to clear the pending merge list without
4661
reverting any files.
4663
Using "bzr revert --forget-merges", it is possible to apply all of the
4664
changes from a branch in a single revision. To do this, perform the merge
4665
as desired. Then doing revert with the "--forget-merges" option will keep
4666
the content of the tree as it was, but it will clear the list of pending
4667
merges. The next commit will then contain all of the changes that are
4668
present in the other branch, but without any other parent revisions.
4669
Because this technique forgets where these changes originated, it may
4670
cause additional conflicts on later merges involving the same source and
4674
_see_also = ['cat', 'export', 'merge', 'shelve']
4677
Option('no-backup', "Do not save backups of reverted files."),
4678
Option('forget-merges',
4679
'Remove pending merge marker, without changing any files.'),
4681
takes_args = ['file*']
4683
def run(self, revision=None, no_backup=False, file_list=None,
4684
forget_merges=None):
4685
tree, file_list = WorkingTree.open_containing_paths(file_list)
4686
self.add_cleanup(tree.lock_tree_write().unlock)
4688
tree.set_parent_ids(tree.get_parent_ids()[:1])
4690
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4693
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4694
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4695
tree.revert(file_list, rev_tree, not no_backup, None,
4696
report_changes=True)
4699
class cmd_assert_fail(Command):
4700
__doc__ = """Test reporting of assertion failures"""
4701
# intended just for use in testing
4706
raise AssertionError("always fails")
4709
class cmd_help(Command):
4710
__doc__ = """Show help on a command or other topic.
4713
_see_also = ['topics']
4715
Option('long', 'Show help on all commands.'),
4717
takes_args = ['topic?']
4718
aliases = ['?', '--help', '-?', '-h']
4721
def run(self, topic=None, long=False):
4723
if topic is None and long:
4725
bzrlib.help.help(topic)
4728
class cmd_shell_complete(Command):
4729
__doc__ = """Show appropriate completions for context.
4731
For a list of all available commands, say 'bzr shell-complete'.
4733
takes_args = ['context?']
4738
def run(self, context=None):
4739
from bzrlib import shellcomplete
4740
shellcomplete.shellcomplete(context)
4743
class cmd_missing(Command):
4744
__doc__ = """Show unmerged/unpulled revisions between two branches.
4746
OTHER_BRANCH may be local or remote.
4748
To filter on a range of revisions, you can use the command -r begin..end
4749
-r revision requests a specific revision, -r ..end or -r begin.. are
4753
1 - some missing revisions
4754
0 - no missing revisions
4758
Determine the missing revisions between this and the branch at the
4759
remembered pull location::
4763
Determine the missing revisions between this and another branch::
4765
bzr missing http://server/branch
4767
Determine the missing revisions up to a specific revision on the other
4770
bzr missing -r ..-10
4772
Determine the missing revisions up to a specific revision on this
4775
bzr missing --my-revision ..-10
4778
_see_also = ['merge', 'pull']
4779
takes_args = ['other_branch?']
4782
Option('reverse', 'Reverse the order of revisions.'),
4784
'Display changes in the local branch only.'),
4785
Option('this' , 'Same as --mine-only.'),
4786
Option('theirs-only',
4787
'Display changes in the remote branch only.'),
4788
Option('other', 'Same as --theirs-only.'),
4792
custom_help('revision',
4793
help='Filter on other branch revisions (inclusive). '
4794
'See "help revisionspec" for details.'),
4795
Option('my-revision',
4796
type=_parse_revision_str,
4797
help='Filter on local branch revisions (inclusive). '
4798
'See "help revisionspec" for details.'),
4799
Option('include-merged',
4800
'Show all revisions in addition to the mainline ones.'),
4801
Option('include-merges', hidden=True,
4802
help='Historical alias for --include-merged.'),
4804
encoding_type = 'replace'
4807
def run(self, other_branch=None, reverse=False, mine_only=False,
4809
log_format=None, long=False, short=False, line=False,
4810
show_ids=False, verbose=False, this=False, other=False,
4811
include_merged=None, revision=None, my_revision=None,
4813
include_merges=symbol_versioning.DEPRECATED_PARAMETER):
4814
from bzrlib.missing import find_unmerged, iter_log_revisions
4819
if symbol_versioning.deprecated_passed(include_merges):
4820
ui.ui_factory.show_user_warning(
4821
'deprecated_command_option',
4822
deprecated_name='--include-merges',
4823
recommended_name='--include-merged',
4824
deprecated_in_version='2.5',
4825
command=self.invoked_as)
4826
if include_merged is None:
4827
include_merged = include_merges
4829
raise errors.BzrCommandError(gettext(
4830
'{0} and {1} are mutually exclusive').format(
4831
'--include-merges', '--include-merged'))
4832
if include_merged is None:
4833
include_merged = False
4838
# TODO: We should probably check that we don't have mine-only and
4839
# theirs-only set, but it gets complicated because we also have
4840
# this and other which could be used.
4847
local_branch = Branch.open_containing(directory)[0]
4848
self.add_cleanup(local_branch.lock_read().unlock)
4850
parent = local_branch.get_parent()
4851
if other_branch is None:
4852
other_branch = parent
4853
if other_branch is None:
4854
raise errors.BzrCommandError(gettext("No peer location known"
4856
display_url = urlutils.unescape_for_display(parent,
4858
message(gettext("Using saved parent location: {0}\n").format(
4861
remote_branch = Branch.open(other_branch)
4862
if remote_branch.base == local_branch.base:
4863
remote_branch = local_branch
4865
self.add_cleanup(remote_branch.lock_read().unlock)
4867
local_revid_range = _revision_range_to_revid_range(
4868
_get_revision_range(my_revision, local_branch,
4871
remote_revid_range = _revision_range_to_revid_range(
4872
_get_revision_range(revision,
4873
remote_branch, self.name()))
4875
local_extra, remote_extra = find_unmerged(
4876
local_branch, remote_branch, restrict,
4877
backward=not reverse,
4878
include_merged=include_merged,
4879
local_revid_range=local_revid_range,
4880
remote_revid_range=remote_revid_range)
4882
if log_format is None:
4883
registry = log.log_formatter_registry
4884
log_format = registry.get_default(local_branch)
4885
lf = log_format(to_file=self.outf,
4887
show_timezone='original')
4890
if local_extra and not theirs_only:
4891
message(ngettext("You have %d extra revision:\n",
4892
"You have %d extra revisions:\n",
4895
for revision in iter_log_revisions(local_extra,
4896
local_branch.repository,
4898
lf.log_revision(revision)
4899
printed_local = True
4902
printed_local = False
4904
if remote_extra and not mine_only:
4905
if printed_local is True:
4907
message(ngettext("You are missing %d revision:\n",
4908
"You are missing %d revisions:\n",
4909
len(remote_extra)) %
4911
for revision in iter_log_revisions(remote_extra,
4912
remote_branch.repository,
4914
lf.log_revision(revision)
4917
if mine_only and not local_extra:
4918
# We checked local, and found nothing extra
4919
message(gettext('This branch has no new revisions.\n'))
4920
elif theirs_only and not remote_extra:
4921
# We checked remote, and found nothing extra
4922
message(gettext('Other branch has no new revisions.\n'))
4923
elif not (mine_only or theirs_only or local_extra or
4925
# We checked both branches, and neither one had extra
4927
message(gettext("Branches are up to date.\n"))
4929
if not status_code and parent is None and other_branch is not None:
4930
self.add_cleanup(local_branch.lock_write().unlock)
4931
# handle race conditions - a parent might be set while we run.
4932
if local_branch.get_parent() is None:
4933
local_branch.set_parent(remote_branch.base)
4937
class cmd_pack(Command):
4938
__doc__ = """Compress the data within a repository.
4940
This operation compresses the data within a bazaar repository. As
4941
bazaar supports automatic packing of repository, this operation is
4942
normally not required to be done manually.
4944
During the pack operation, bazaar takes a backup of existing repository
4945
data, i.e. pack files. This backup is eventually removed by bazaar
4946
automatically when it is safe to do so. To save disk space by removing
4947
the backed up pack files, the --clean-obsolete-packs option may be
4950
Warning: If you use --clean-obsolete-packs and your machine crashes
4951
during or immediately after repacking, you may be left with a state
4952
where the deletion has been written to disk but the new packs have not
4953
been. In this case the repository may be unusable.
4956
_see_also = ['repositories']
4957
takes_args = ['branch_or_repo?']
4959
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4962
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4963
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
4965
branch = dir.open_branch()
4966
repository = branch.repository
4967
except errors.NotBranchError:
4968
repository = dir.open_repository()
4969
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4972
class cmd_plugins(Command):
4973
__doc__ = """List the installed plugins.
4975
This command displays the list of installed plugins including
4976
version of plugin and a short description of each.
4978
--verbose shows the path where each plugin is located.
4980
A plugin is an external component for Bazaar that extends the
4981
revision control system, by adding or replacing code in Bazaar.
4982
Plugins can do a variety of things, including overriding commands,
4983
adding new commands, providing additional network transports and
4984
customizing log output.
4986
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4987
for further information on plugins including where to find them and how to
4988
install them. Instructions are also provided there on how to write new
4989
plugins using the Python programming language.
4991
takes_options = ['verbose']
4994
def run(self, verbose=False):
4995
from bzrlib import plugin
4996
# Don't give writelines a generator as some codecs don't like that
4997
self.outf.writelines(
4998
list(plugin.describe_plugins(show_paths=verbose)))
5001
class cmd_testament(Command):
5002
__doc__ = """Show testament (signing-form) of a revision."""
5005
Option('long', help='Produce long-format testament.'),
5007
help='Produce a strict-format testament.')]
5008
takes_args = ['branch?']
5010
def run(self, branch=u'.', revision=None, long=False, strict=False):
5011
from bzrlib.testament import Testament, StrictTestament
5013
testament_class = StrictTestament
5015
testament_class = Testament
5017
b = Branch.open_containing(branch)[0]
5019
b = Branch.open(branch)
5020
self.add_cleanup(b.lock_read().unlock)
5021
if revision is None:
5022
rev_id = b.last_revision()
5024
rev_id = revision[0].as_revision_id(b)
5025
t = testament_class.from_revision(b.repository, rev_id)
5027
sys.stdout.writelines(t.as_text_lines())
5029
sys.stdout.write(t.as_short_text())
5032
class cmd_annotate(Command):
5033
__doc__ = """Show the origin of each line in a file.
5035
This prints out the given file with an annotation on the left side
5036
indicating which revision, author and date introduced the change.
5038
If the origin is the same for a run of consecutive lines, it is
5039
shown only at the top, unless the --all option is given.
5041
# TODO: annotate directories; showing when each file was last changed
5042
# TODO: if the working copy is modified, show annotations on that
5043
# with new uncommitted lines marked
5044
aliases = ['ann', 'blame', 'praise']
5045
takes_args = ['filename']
5046
takes_options = [Option('all', help='Show annotations on all lines.'),
5047
Option('long', help='Show commit date in annotations.'),
5052
encoding_type = 'exact'
5055
def run(self, filename, all=False, long=False, revision=None,
5056
show_ids=False, directory=None):
5057
from bzrlib.annotate import (
5060
wt, branch, relpath = \
5061
_open_directory_or_containing_tree_or_branch(filename, directory)
5063
self.add_cleanup(wt.lock_read().unlock)
5065
self.add_cleanup(branch.lock_read().unlock)
5066
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5067
self.add_cleanup(tree.lock_read().unlock)
5068
if wt is not None and revision is None:
5069
file_id = wt.path2id(relpath)
5071
file_id = tree.path2id(relpath)
5073
raise errors.NotVersionedError(filename)
5074
if wt is not None and revision is None:
5075
# If there is a tree and we're not annotating historical
5076
# versions, annotate the working tree's content.
5077
annotate_file_tree(wt, file_id, self.outf, long, all,
5080
annotate_file_tree(tree, file_id, self.outf, long, all,
5081
show_ids=show_ids, branch=branch)
5084
class cmd_re_sign(Command):
5085
__doc__ = """Create a digital signature for an existing revision."""
5086
# TODO be able to replace existing ones.
5088
hidden = True # is this right ?
5089
takes_args = ['revision_id*']
5090
takes_options = ['directory', 'revision']
5092
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5093
if revision_id_list is not None and revision is not None:
5094
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5095
if revision_id_list is None and revision is None:
5096
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5097
b = WorkingTree.open_containing(directory)[0].branch
5098
self.add_cleanup(b.lock_write().unlock)
5099
return self._run(b, revision_id_list, revision)
5101
def _run(self, b, revision_id_list, revision):
5102
import bzrlib.gpg as gpg
5103
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5104
if revision_id_list is not None:
5105
b.repository.start_write_group()
5107
for revision_id in revision_id_list:
5108
b.repository.sign_revision(revision_id, gpg_strategy)
5110
b.repository.abort_write_group()
5113
b.repository.commit_write_group()
5114
elif revision is not None:
5115
if len(revision) == 1:
5116
revno, rev_id = revision[0].in_history(b)
5117
b.repository.start_write_group()
5119
b.repository.sign_revision(rev_id, gpg_strategy)
5121
b.repository.abort_write_group()
5124
b.repository.commit_write_group()
5125
elif len(revision) == 2:
5126
# are they both on rh- if so we can walk between them
5127
# might be nice to have a range helper for arbitrary
5128
# revision paths. hmm.
5129
from_revno, from_revid = revision[0].in_history(b)
5130
to_revno, to_revid = revision[1].in_history(b)
5131
if to_revid is None:
5132
to_revno = b.revno()
5133
if from_revno is None or to_revno is None:
5134
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5135
b.repository.start_write_group()
5137
for revno in range(from_revno, to_revno + 1):
5138
b.repository.sign_revision(b.get_rev_id(revno),
5141
b.repository.abort_write_group()
5144
b.repository.commit_write_group()
5146
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5149
class cmd_bind(Command):
5150
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5151
If no branch is supplied, rebind to the last bound location.
5153
Once converted into a checkout, commits must succeed on the master branch
5154
before they will be applied to the local branch.
5156
Bound branches use the nickname of its master branch unless it is set
5157
locally, in which case binding will update the local nickname to be
5161
_see_also = ['checkouts', 'unbind']
5162
takes_args = ['location?']
5163
takes_options = ['directory']
5165
def run(self, location=None, directory=u'.'):
5166
b, relpath = Branch.open_containing(directory)
5167
if location is None:
5169
location = b.get_old_bound_location()
5170
except errors.UpgradeRequired:
5171
raise errors.BzrCommandError(gettext('No location supplied. '
5172
'This format does not remember old locations.'))
5174
if location is None:
5175
if b.get_bound_location() is not None:
5176
raise errors.BzrCommandError(
5177
gettext('Branch is already bound'))
5179
raise errors.BzrCommandError(
5180
gettext('No location supplied'
5181
' and no previous location known'))
5182
b_other = Branch.open(location)
5185
except errors.DivergedBranches:
5186
raise errors.BzrCommandError(gettext('These branches have diverged.'
5187
' Try merging, and then bind again.'))
5188
if b.get_config().has_explicit_nickname():
5189
b.nick = b_other.nick
5192
class cmd_unbind(Command):
5193
__doc__ = """Convert the current checkout into a regular branch.
5195
After unbinding, the local branch is considered independent and subsequent
5196
commits will be local only.
5199
_see_also = ['checkouts', 'bind']
5201
takes_options = ['directory']
5203
def run(self, directory=u'.'):
5204
b, relpath = Branch.open_containing(directory)
5206
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5209
class cmd_uncommit(Command):
5210
__doc__ = """Remove the last committed revision.
5212
--verbose will print out what is being removed.
5213
--dry-run will go through all the motions, but not actually
5216
If --revision is specified, uncommit revisions to leave the branch at the
5217
specified revision. For example, "bzr uncommit -r 15" will leave the
5218
branch at revision 15.
5220
Uncommit leaves the working tree ready for a new commit. The only change
5221
it may make is to restore any pending merges that were present before
5225
# TODO: jam 20060108 Add an option to allow uncommit to remove
5226
# unreferenced information in 'branch-as-repository' branches.
5227
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5228
# information in shared branches as well.
5229
_see_also = ['commit']
5230
takes_options = ['verbose', 'revision',
5231
Option('dry-run', help='Don\'t actually make changes.'),
5232
Option('force', help='Say yes to all questions.'),
5234
help='Keep tags that point to removed revisions.'),
5236
help="Only remove the commits from the local branch"
5237
" when in a checkout."
5240
takes_args = ['location?']
5242
encoding_type = 'replace'
5244
def run(self, location=None, dry_run=False, verbose=False,
5245
revision=None, force=False, local=False, keep_tags=False):
5246
if location is None:
5248
control, relpath = controldir.ControlDir.open_containing(location)
5250
tree = control.open_workingtree()
5252
except (errors.NoWorkingTree, errors.NotLocalUrl):
5254
b = control.open_branch()
5256
if tree is not None:
5257
self.add_cleanup(tree.lock_write().unlock)
5259
self.add_cleanup(b.lock_write().unlock)
5260
return self._run(b, tree, dry_run, verbose, revision, force,
5263
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5265
from bzrlib.log import log_formatter, show_log
5266
from bzrlib.uncommit import uncommit
5268
last_revno, last_rev_id = b.last_revision_info()
5271
if revision is None:
5273
rev_id = last_rev_id
5275
# 'bzr uncommit -r 10' actually means uncommit
5276
# so that the final tree is at revno 10.
5277
# but bzrlib.uncommit.uncommit() actually uncommits
5278
# the revisions that are supplied.
5279
# So we need to offset it by one
5280
revno = revision[0].in_history(b).revno + 1
5281
if revno <= last_revno:
5282
rev_id = b.get_rev_id(revno)
5284
if rev_id is None or _mod_revision.is_null(rev_id):
5285
self.outf.write(gettext('No revisions to uncommit.\n'))
5288
lf = log_formatter('short',
5290
show_timezone='original')
5295
direction='forward',
5296
start_revision=revno,
5297
end_revision=last_revno)
5300
self.outf.write(gettext('Dry-run, pretending to remove'
5301
' the above revisions.\n'))
5303
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5306
if not ui.ui_factory.confirm_action(
5307
gettext(u'Uncommit these revisions'),
5308
'bzrlib.builtins.uncommit',
5310
self.outf.write(gettext('Canceled\n'))
5313
mutter('Uncommitting from {%s} to {%s}',
5314
last_rev_id, rev_id)
5315
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5316
revno=revno, local=local, keep_tags=keep_tags)
5317
self.outf.write(gettext('You can restore the old tip by running:\n'
5318
' bzr pull . -r revid:%s\n') % last_rev_id)
5321
class cmd_break_lock(Command):
5322
__doc__ = """Break a dead lock.
5324
This command breaks a lock on a repository, branch, working directory or
5327
CAUTION: Locks should only be broken when you are sure that the process
5328
holding the lock has been stopped.
5330
You can get information on what locks are open via the 'bzr info
5331
[location]' command.
5335
bzr break-lock bzr+ssh://example.com/bzr/foo
5336
bzr break-lock --conf ~/.bazaar
5339
takes_args = ['location?']
5342
help='LOCATION is the directory where the config lock is.'),
5344
help='Do not ask for confirmation before breaking the lock.'),
5347
def run(self, location=None, config=False, force=False):
5348
if location is None:
5351
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5353
{'bzrlib.lockdir.break': True})
5355
conf = _mod_config.LockableConfig(file_name=location)
5358
control, relpath = controldir.ControlDir.open_containing(location)
5360
control.break_lock()
5361
except NotImplementedError:
5365
class cmd_wait_until_signalled(Command):
5366
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5368
This just prints a line to signal when it is ready, then blocks on stdin.
5374
sys.stdout.write("running\n")
5376
sys.stdin.readline()
5379
class cmd_serve(Command):
5380
__doc__ = """Run the bzr server."""
5382
aliases = ['server']
5386
help='Serve on stdin/out for use from inetd or sshd.'),
5387
RegistryOption('protocol',
5388
help="Protocol to serve.",
5389
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5390
value_switches=True),
5392
help='Listen for connections on nominated port of the form '
5393
'[hostname:]portnumber. Passing 0 as the port number will '
5394
'result in a dynamically allocated port. The default port '
5395
'depends on the protocol.',
5397
custom_help('directory',
5398
help='Serve contents of this directory.'),
5399
Option('allow-writes',
5400
help='By default the server is a readonly server. Supplying '
5401
'--allow-writes enables write access to the contents of '
5402
'the served directory and below. Note that ``bzr serve`` '
5403
'does not perform authentication, so unless some form of '
5404
'external authentication is arranged supplying this '
5405
'option leads to global uncontrolled write access to your '
5408
Option('client-timeout', type=float,
5409
help='Override the default idle client timeout (5min).'),
5412
def get_host_and_port(self, port):
5413
"""Return the host and port to run the smart server on.
5415
If 'port' is None, None will be returned for the host and port.
5417
If 'port' has a colon in it, the string before the colon will be
5418
interpreted as the host.
5420
:param port: A string of the port to run the server on.
5421
:return: A tuple of (host, port), where 'host' is a host name or IP,
5422
and port is an integer TCP/IP port.
5425
if port is not None:
5427
host, port = port.split(':')
5431
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5432
protocol=None, client_timeout=None):
5433
from bzrlib import transport
5434
if directory is None:
5435
directory = os.getcwd()
5436
if protocol is None:
5437
protocol = transport.transport_server_registry.get()
5438
host, port = self.get_host_and_port(port)
5439
url = transport.location_to_url(directory)
5440
if not allow_writes:
5441
url = 'readonly+' + url
5442
t = transport.get_transport_from_url(url)
5444
protocol(t, host, port, inet, client_timeout)
5445
except TypeError, e:
5446
# We use symbol_versioning.deprecated_in just so that people
5447
# grepping can find it here.
5448
# symbol_versioning.deprecated_in((2, 5, 0))
5449
symbol_versioning.warn(
5450
'Got TypeError(%s)\ntrying to call protocol: %s.%s\n'
5451
'Most likely it needs to be updated to support a'
5452
' "timeout" parameter (added in bzr 2.5.0)'
5453
% (e, protocol.__module__, protocol),
5455
protocol(t, host, port, inet)
5458
class cmd_join(Command):
5459
__doc__ = """Combine a tree into its containing tree.
5461
This command requires the target tree to be in a rich-root format.
5463
The TREE argument should be an independent tree, inside another tree, but
5464
not part of it. (Such trees can be produced by "bzr split", but also by
5465
running "bzr branch" with the target inside a tree.)
5467
The result is a combined tree, with the subtree no longer an independent
5468
part. This is marked as a merge of the subtree into the containing tree,
5469
and all history is preserved.
5472
_see_also = ['split']
5473
takes_args = ['tree']
5475
Option('reference', help='Join by reference.', hidden=True),
5478
def run(self, tree, reference=False):
5479
sub_tree = WorkingTree.open(tree)
5480
parent_dir = osutils.dirname(sub_tree.basedir)
5481
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5482
repo = containing_tree.branch.repository
5483
if not repo.supports_rich_root():
5484
raise errors.BzrCommandError(gettext(
5485
"Can't join trees because %s doesn't support rich root data.\n"
5486
"You can use bzr upgrade on the repository.")
5490
containing_tree.add_reference(sub_tree)
5491
except errors.BadReferenceTarget, e:
5492
# XXX: Would be better to just raise a nicely printable
5493
# exception from the real origin. Also below. mbp 20070306
5494
raise errors.BzrCommandError(
5495
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5498
containing_tree.subsume(sub_tree)
5499
except errors.BadSubsumeSource, e:
5500
raise errors.BzrCommandError(
5501
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5504
class cmd_split(Command):
5505
__doc__ = """Split a subdirectory of a tree into a separate tree.
5507
This command will produce a target tree in a format that supports
5508
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5509
converted into earlier formats like 'dirstate-tags'.
5511
The TREE argument should be a subdirectory of a working tree. That
5512
subdirectory will be converted into an independent tree, with its own
5513
branch. Commits in the top-level tree will not apply to the new subtree.
5516
_see_also = ['join']
5517
takes_args = ['tree']
5519
def run(self, tree):
5520
containing_tree, subdir = WorkingTree.open_containing(tree)
5521
sub_id = containing_tree.path2id(subdir)
5523
raise errors.NotVersionedError(subdir)
5525
containing_tree.extract(sub_id)
5526
except errors.RootNotRich:
5527
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5530
class cmd_merge_directive(Command):
5531
__doc__ = """Generate a merge directive for auto-merge tools.
5533
A directive requests a merge to be performed, and also provides all the
5534
information necessary to do so. This means it must either include a
5535
revision bundle, or the location of a branch containing the desired
5538
A submit branch (the location to merge into) must be supplied the first
5539
time the command is issued. After it has been supplied once, it will
5540
be remembered as the default.
5542
A public branch is optional if a revision bundle is supplied, but required
5543
if --diff or --plain is specified. It will be remembered as the default
5544
after the first use.
5547
takes_args = ['submit_branch?', 'public_branch?']
5551
_see_also = ['send']
5555
RegistryOption.from_kwargs('patch-type',
5556
'The type of patch to include in the directive.',
5558
value_switches=True,
5560
bundle='Bazaar revision bundle (default).',
5561
diff='Normal unified diff.',
5562
plain='No patch, just directive.'),
5563
Option('sign', help='GPG-sign the directive.'), 'revision',
5564
Option('mail-to', type=str,
5565
help='Instead of printing the directive, email to this address.'),
5566
Option('message', type=str, short_name='m',
5567
help='Message to use when committing this merge.')
5570
encoding_type = 'exact'
5572
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5573
sign=False, revision=None, mail_to=None, message=None,
5575
from bzrlib.revision import ensure_null, NULL_REVISION
5576
include_patch, include_bundle = {
5577
'plain': (False, False),
5578
'diff': (True, False),
5579
'bundle': (True, True),
5581
branch = Branch.open(directory)
5582
stored_submit_branch = branch.get_submit_branch()
5583
if submit_branch is None:
5584
submit_branch = stored_submit_branch
5586
if stored_submit_branch is None:
5587
branch.set_submit_branch(submit_branch)
5588
if submit_branch is None:
5589
submit_branch = branch.get_parent()
5590
if submit_branch is None:
5591
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5593
stored_public_branch = branch.get_public_branch()
5594
if public_branch is None:
5595
public_branch = stored_public_branch
5596
elif stored_public_branch is None:
5597
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5598
branch.set_public_branch(public_branch)
5599
if not include_bundle and public_branch is None:
5600
raise errors.BzrCommandError(gettext('No public branch specified or'
5602
base_revision_id = None
5603
if revision is not None:
5604
if len(revision) > 2:
5605
raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5606
'at most two one revision identifiers'))
5607
revision_id = revision[-1].as_revision_id(branch)
5608
if len(revision) == 2:
5609
base_revision_id = revision[0].as_revision_id(branch)
5611
revision_id = branch.last_revision()
5612
revision_id = ensure_null(revision_id)
5613
if revision_id == NULL_REVISION:
5614
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5615
directive = merge_directive.MergeDirective2.from_objects(
5616
branch.repository, revision_id, time.time(),
5617
osutils.local_time_offset(), submit_branch,
5618
public_branch=public_branch, include_patch=include_patch,
5619
include_bundle=include_bundle, message=message,
5620
base_revision_id=base_revision_id)
5623
self.outf.write(directive.to_signed(branch))
5625
self.outf.writelines(directive.to_lines())
5627
message = directive.to_email(mail_to, branch, sign)
5628
s = SMTPConnection(branch.get_config_stack())
5629
s.send_email(message)
5632
class cmd_send(Command):
5633
__doc__ = """Mail or create a merge-directive for submitting changes.
5635
A merge directive provides many things needed for requesting merges:
5637
* A machine-readable description of the merge to perform
5639
* An optional patch that is a preview of the changes requested
5641
* An optional bundle of revision data, so that the changes can be applied
5642
directly from the merge directive, without retrieving data from a
5645
`bzr send` creates a compact data set that, when applied using bzr
5646
merge, has the same effect as merging from the source branch.
5648
By default the merge directive is self-contained and can be applied to any
5649
branch containing submit_branch in its ancestory without needing access to
5652
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5653
revisions, but only a structured request to merge from the
5654
public_location. In that case the public_branch is needed and it must be
5655
up-to-date and accessible to the recipient. The public_branch is always
5656
included if known, so that people can check it later.
5658
The submit branch defaults to the parent of the source branch, but can be
5659
overridden. Both submit branch and public branch will be remembered in
5660
branch.conf the first time they are used for a particular branch. The
5661
source branch defaults to that containing the working directory, but can
5662
be changed using --from.
5664
Both the submit branch and the public branch follow the usual behavior with
5665
respect to --remember: If there is no default location set, the first send
5666
will set it (use --no-remember to avoid setting it). After that, you can
5667
omit the location to use the default. To change the default, use
5668
--remember. The value will only be saved if the location can be accessed.
5670
In order to calculate those changes, bzr must analyse the submit branch.
5671
Therefore it is most efficient for the submit branch to be a local mirror.
5672
If a public location is known for the submit_branch, that location is used
5673
in the merge directive.
5675
The default behaviour is to send the merge directive by mail, unless -o is
5676
given, in which case it is sent to a file.
5678
Mail is sent using your preferred mail program. This should be transparent
5679
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5680
If the preferred client can't be found (or used), your editor will be used.
5682
To use a specific mail program, set the mail_client configuration option.
5683
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5684
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5685
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5686
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5689
If mail is being sent, a to address is required. This can be supplied
5690
either on the commandline, by setting the submit_to configuration
5691
option in the branch itself or the child_submit_to configuration option
5692
in the submit branch.
5694
Two formats are currently supported: "4" uses revision bundle format 4 and
5695
merge directive format 2. It is significantly faster and smaller than
5696
older formats. It is compatible with Bazaar 0.19 and later. It is the
5697
default. "0.9" uses revision bundle format 0.9 and merge directive
5698
format 1. It is compatible with Bazaar 0.12 - 0.18.
5700
The merge directives created by bzr send may be applied using bzr merge or
5701
bzr pull by specifying a file containing a merge directive as the location.
5703
bzr send makes extensive use of public locations to map local locations into
5704
URLs that can be used by other people. See `bzr help configuration` to
5705
set them, and use `bzr info` to display them.
5708
encoding_type = 'exact'
5710
_see_also = ['merge', 'pull']
5712
takes_args = ['submit_branch?', 'public_branch?']
5716
help='Do not include a bundle in the merge directive.'),
5717
Option('no-patch', help='Do not include a preview patch in the merge'
5720
help='Remember submit and public branch.'),
5722
help='Branch to generate the submission from, '
5723
'rather than the one containing the working directory.',
5726
Option('output', short_name='o',
5727
help='Write merge directive to this file or directory; '
5728
'use - for stdout.',
5731
help='Refuse to send if there are uncommitted changes in'
5732
' the working tree, --no-strict disables the check.'),
5733
Option('mail-to', help='Mail the request to this address.',
5737
Option('body', help='Body for the email.', type=unicode),
5738
RegistryOption('format',
5739
help='Use the specified output format.',
5740
lazy_registry=('bzrlib.send', 'format_registry')),
5743
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5744
no_patch=False, revision=None, remember=None, output=None,
5745
format=None, mail_to=None, message=None, body=None,
5746
strict=None, **kwargs):
5747
from bzrlib.send import send
5748
return send(submit_branch, revision, public_branch, remember,
5749
format, no_bundle, no_patch, output,
5750
kwargs.get('from', '.'), mail_to, message, body,
5755
class cmd_bundle_revisions(cmd_send):
5756
__doc__ = """Create a merge-directive for submitting changes.
5758
A merge directive provides many things needed for requesting merges:
5760
* A machine-readable description of the merge to perform
5762
* An optional patch that is a preview of the changes requested
5764
* An optional bundle of revision data, so that the changes can be applied
5765
directly from the merge directive, without retrieving data from a
5768
If --no-bundle is specified, then public_branch is needed (and must be
5769
up-to-date), so that the receiver can perform the merge using the
5770
public_branch. The public_branch is always included if known, so that
5771
people can check it later.
5773
The submit branch defaults to the parent, but can be overridden. Both
5774
submit branch and public branch will be remembered if supplied.
5776
If a public_branch is known for the submit_branch, that public submit
5777
branch is used in the merge instructions. This means that a local mirror
5778
can be used as your actual submit branch, once you have set public_branch
5781
Two formats are currently supported: "4" uses revision bundle format 4 and
5782
merge directive format 2. It is significantly faster and smaller than
5783
older formats. It is compatible with Bazaar 0.19 and later. It is the
5784
default. "0.9" uses revision bundle format 0.9 and merge directive
5785
format 1. It is compatible with Bazaar 0.12 - 0.18.
5790
help='Do not include a bundle in the merge directive.'),
5791
Option('no-patch', help='Do not include a preview patch in the merge'
5794
help='Remember submit and public branch.'),
5796
help='Branch to generate the submission from, '
5797
'rather than the one containing the working directory.',
5800
Option('output', short_name='o', help='Write directive to this file.',
5803
help='Refuse to bundle revisions if there are uncommitted'
5804
' changes in the working tree, --no-strict disables the check.'),
5806
RegistryOption('format',
5807
help='Use the specified output format.',
5808
lazy_registry=('bzrlib.send', 'format_registry')),
5810
aliases = ['bundle']
5812
_see_also = ['send', 'merge']
5816
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5817
no_patch=False, revision=None, remember=False, output=None,
5818
format=None, strict=None, **kwargs):
5821
from bzrlib.send import send
5822
return send(submit_branch, revision, public_branch, remember,
5823
format, no_bundle, no_patch, output,
5824
kwargs.get('from', '.'), None, None, None,
5825
self.outf, strict=strict)
5828
class cmd_tag(Command):
5829
__doc__ = """Create, remove or modify a tag naming a revision.
5831
Tags give human-meaningful names to revisions. Commands that take a -r
5832
(--revision) option can be given -rtag:X, where X is any previously
5835
Tags are stored in the branch. Tags are copied from one branch to another
5836
along when you branch, push, pull or merge.
5838
It is an error to give a tag name that already exists unless you pass
5839
--force, in which case the tag is moved to point to the new revision.
5841
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5842
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5844
If no tag name is specified it will be determined through the
5845
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5846
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5850
_see_also = ['commit', 'tags']
5851
takes_args = ['tag_name?']
5854
help='Delete this tag rather than placing it.',
5856
custom_help('directory',
5857
help='Branch in which to place the tag.'),
5859
help='Replace existing tags.',
5864
def run(self, tag_name=None,
5870
branch, relpath = Branch.open_containing(directory)
5871
self.add_cleanup(branch.lock_write().unlock)
5873
if tag_name is None:
5874
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5875
branch.tags.delete_tag(tag_name)
5876
note(gettext('Deleted tag %s.') % tag_name)
5879
if len(revision) != 1:
5880
raise errors.BzrCommandError(gettext(
5881
"Tags can only be placed on a single revision, "
5883
revision_id = revision[0].as_revision_id(branch)
5885
revision_id = branch.last_revision()
5886
if tag_name is None:
5887
tag_name = branch.automatic_tag_name(revision_id)
5888
if tag_name is None:
5889
raise errors.BzrCommandError(gettext(
5890
"Please specify a tag name."))
5892
existing_target = branch.tags.lookup_tag(tag_name)
5893
except errors.NoSuchTag:
5894
existing_target = None
5895
if not force and existing_target not in (None, revision_id):
5896
raise errors.TagAlreadyExists(tag_name)
5897
if existing_target == revision_id:
5898
note(gettext('Tag %s already exists for that revision.') % tag_name)
5900
branch.tags.set_tag(tag_name, revision_id)
5901
if existing_target is None:
5902
note(gettext('Created tag %s.') % tag_name)
5904
note(gettext('Updated tag %s.') % tag_name)
5907
class cmd_tags(Command):
5908
__doc__ = """List tags.
5910
This command shows a table of tag names and the revisions they reference.
5915
custom_help('directory',
5916
help='Branch whose tags should be displayed.'),
5917
RegistryOption('sort',
5918
'Sort tags by different criteria.', title='Sorting',
5919
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5926
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5927
from bzrlib.tag import tag_sort_methods
5928
branch, relpath = Branch.open_containing(directory)
5930
tags = branch.tags.get_tag_dict().items()
5934
self.add_cleanup(branch.lock_read().unlock)
5936
# Restrict to the specified range
5937
tags = self._tags_for_range(branch, revision)
5939
sort = tag_sort_methods.get()
5942
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5943
for index, (tag, revid) in enumerate(tags):
5945
revno = branch.revision_id_to_dotted_revno(revid)
5946
if isinstance(revno, tuple):
5947
revno = '.'.join(map(str, revno))
5948
except (errors.NoSuchRevision,
5949
errors.GhostRevisionsHaveNoRevno,
5950
errors.UnsupportedOperation):
5951
# Bad tag data/merges can lead to tagged revisions
5952
# which are not in this branch. Fail gracefully ...
5954
tags[index] = (tag, revno)
5956
for tag, revspec in tags:
5957
self.outf.write('%-20s %s\n' % (tag, revspec))
5959
def _tags_for_range(self, branch, revision):
5961
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5962
revid1, revid2 = rev1.rev_id, rev2.rev_id
5963
# _get_revision_range will always set revid2 if it's not specified.
5964
# If revid1 is None, it means we want to start from the branch
5965
# origin which is always a valid ancestor. If revid1 == revid2, the
5966
# ancestry check is useless.
5967
if revid1 and revid1 != revid2:
5968
# FIXME: We really want to use the same graph than
5969
# branch.iter_merge_sorted_revisions below, but this is not
5970
# easily available -- vila 2011-09-23
5971
if branch.repository.get_graph().is_ancestor(revid2, revid1):
5972
# We don't want to output anything in this case...
5974
# only show revisions between revid1 and revid2 (inclusive)
5975
tagged_revids = branch.tags.get_reverse_tag_dict()
5977
for r in branch.iter_merge_sorted_revisions(
5978
start_revision_id=revid2, stop_revision_id=revid1,
5979
stop_rule='include'):
5980
revid_tags = tagged_revids.get(r[0], None)
5982
found.extend([(tag, r[0]) for tag in revid_tags])
5986
class cmd_reconfigure(Command):
5987
__doc__ = """Reconfigure the type of a bzr directory.
5989
A target configuration must be specified.
5991
For checkouts, the bind-to location will be auto-detected if not specified.
5992
The order of preference is
5993
1. For a lightweight checkout, the current bound location.
5994
2. For branches that used to be checkouts, the previously-bound location.
5995
3. The push location.
5996
4. The parent location.
5997
If none of these is available, --bind-to must be specified.
6000
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6001
takes_args = ['location?']
6003
RegistryOption.from_kwargs(
6006
help='The relation between branch and tree.',
6007
value_switches=True, enum_switch=False,
6008
branch='Reconfigure to be an unbound branch with no working tree.',
6009
tree='Reconfigure to be an unbound branch with a working tree.',
6010
checkout='Reconfigure to be a bound branch with a working tree.',
6011
lightweight_checkout='Reconfigure to be a lightweight'
6012
' checkout (with no local history).',
6014
RegistryOption.from_kwargs(
6016
title='Repository type',
6017
help='Location fo the repository.',
6018
value_switches=True, enum_switch=False,
6019
standalone='Reconfigure to be a standalone branch '
6020
'(i.e. stop using shared repository).',
6021
use_shared='Reconfigure to use a shared repository.',
6023
RegistryOption.from_kwargs(
6025
title='Trees in Repository',
6026
help='Whether new branches in the repository have trees.',
6027
value_switches=True, enum_switch=False,
6028
with_trees='Reconfigure repository to create '
6029
'working trees on branches by default.',
6030
with_no_trees='Reconfigure repository to not create '
6031
'working trees on branches by default.'
6033
Option('bind-to', help='Branch to bind checkout to.', type=str),
6035
help='Perform reconfiguration even if local changes'
6037
Option('stacked-on',
6038
help='Reconfigure a branch to be stacked on another branch.',
6042
help='Reconfigure a branch to be unstacked. This '
6043
'may require copying substantial data into it.',
6047
def run(self, location=None, bind_to=None, force=False,
6048
tree_type=None, repository_type=None, repository_trees=None,
6049
stacked_on=None, unstacked=None):
6050
directory = controldir.ControlDir.open(location)
6051
if stacked_on and unstacked:
6052
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6053
elif stacked_on is not None:
6054
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6056
reconfigure.ReconfigureUnstacked().apply(directory)
6057
# At the moment you can use --stacked-on and a different
6058
# reconfiguration shape at the same time; there seems no good reason
6060
if (tree_type is None and
6061
repository_type is None and
6062
repository_trees is None):
6063
if stacked_on or unstacked:
6066
raise errors.BzrCommandError(gettext('No target configuration '
6068
reconfiguration = None
6069
if tree_type == 'branch':
6070
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6071
elif tree_type == 'tree':
6072
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6073
elif tree_type == 'checkout':
6074
reconfiguration = reconfigure.Reconfigure.to_checkout(
6076
elif tree_type == 'lightweight-checkout':
6077
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6080
reconfiguration.apply(force)
6081
reconfiguration = None
6082
if repository_type == 'use-shared':
6083
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6084
elif repository_type == 'standalone':
6085
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6087
reconfiguration.apply(force)
6088
reconfiguration = None
6089
if repository_trees == 'with-trees':
6090
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6092
elif repository_trees == 'with-no-trees':
6093
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6096
reconfiguration.apply(force)
6097
reconfiguration = None
6100
class cmd_switch(Command):
6101
__doc__ = """Set the branch of a checkout and update.
6103
For lightweight checkouts, this changes the branch being referenced.
6104
For heavyweight checkouts, this checks that there are no local commits
6105
versus the current bound branch, then it makes the local branch a mirror
6106
of the new location and binds to it.
6108
In both cases, the working tree is updated and uncommitted changes
6109
are merged. The user can commit or revert these as they desire.
6111
Pending merges need to be committed or reverted before using switch.
6113
The path to the branch to switch to can be specified relative to the parent
6114
directory of the current branch. For example, if you are currently in a
6115
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6118
Bound branches use the nickname of its master branch unless it is set
6119
locally, in which case switching will update the local nickname to be
6123
takes_args = ['to_location?']
6124
takes_options = ['directory',
6126
help='Switch even if local commits will be lost.'),
6128
Option('create-branch', short_name='b',
6129
help='Create the target branch from this one before'
6130
' switching to it.'),
6133
def run(self, to_location=None, force=False, create_branch=False,
6134
revision=None, directory=u'.'):
6135
from bzrlib import switch
6136
tree_location = directory
6137
revision = _get_one_revision('switch', revision)
6138
control_dir = controldir.ControlDir.open_containing(tree_location)[0]
6139
if to_location is None:
6140
if revision is None:
6141
raise errors.BzrCommandError(gettext('You must supply either a'
6142
' revision or a location'))
6143
to_location = tree_location
6145
branch = control_dir.open_branch()
6146
had_explicit_nick = branch.get_config().has_explicit_nickname()
6147
except errors.NotBranchError:
6149
had_explicit_nick = False
6152
raise errors.BzrCommandError(gettext('cannot create branch without'
6154
to_location = directory_service.directories.dereference(
6156
if '/' not in to_location and '\\' not in to_location:
6157
# This path is meant to be relative to the existing branch
6158
this_url = self._get_branch_location(control_dir)
6159
# Perhaps the target control dir supports colocated branches?
6161
root = controldir.ControlDir.open(this_url,
6162
possible_transports=[control_dir.user_transport])
6163
except errors.NotBranchError:
6166
colocated = root._format.colocated_branches
6168
to_location = urlutils.join_segment_parameters(this_url,
6169
{"branch": urlutils.escape(to_location)})
6171
to_location = urlutils.join(
6172
this_url, '..', urlutils.escape(to_location))
6173
to_branch = branch.bzrdir.sprout(to_location,
6174
possible_transports=[branch.bzrdir.root_transport],
6175
source_branch=branch).open_branch()
6177
# Perhaps it's a colocated branch?
6179
to_branch = control_dir.open_branch(to_location)
6180
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
6182
to_branch = Branch.open(to_location)
6183
except errors.NotBranchError:
6184
this_url = self._get_branch_location(control_dir)
6185
to_branch = Branch.open(
6187
this_url, '..', urlutils.escape(to_location)))
6188
if revision is not None:
6189
revision = revision.as_revision_id(to_branch)
6190
switch.switch(control_dir, to_branch, force, revision_id=revision)
6191
if had_explicit_nick:
6192
branch = control_dir.open_branch() #get the new branch!
6193
branch.nick = to_branch.nick
6194
note(gettext('Switched to branch: %s'),
6195
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6197
def _get_branch_location(self, control_dir):
6198
"""Return location of branch for this control dir."""
6200
this_branch = control_dir.open_branch()
6201
# This may be a heavy checkout, where we want the master branch
6202
master_location = this_branch.get_bound_location()
6203
if master_location is not None:
6204
return master_location
6205
# If not, use a local sibling
6206
return this_branch.base
6207
except errors.NotBranchError:
6208
format = control_dir.find_branch_format()
6209
if getattr(format, 'get_reference', None) is not None:
6210
return format.get_reference(control_dir)
6212
return control_dir.root_transport.base
6215
class cmd_view(Command):
6216
__doc__ = """Manage filtered views.
6218
Views provide a mask over the tree so that users can focus on
6219
a subset of a tree when doing their work. After creating a view,
6220
commands that support a list of files - status, diff, commit, etc -
6221
effectively have that list of files implicitly given each time.
6222
An explicit list of files can still be given but those files
6223
must be within the current view.
6225
In most cases, a view has a short life-span: it is created to make
6226
a selected change and is deleted once that change is committed.
6227
At other times, you may wish to create one or more named views
6228
and switch between them.
6230
To disable the current view without deleting it, you can switch to
6231
the pseudo view called ``off``. This can be useful when you need
6232
to see the whole tree for an operation or two (e.g. merge) but
6233
want to switch back to your view after that.
6236
To define the current view::
6238
bzr view file1 dir1 ...
6240
To list the current view::
6244
To delete the current view::
6248
To disable the current view without deleting it::
6250
bzr view --switch off
6252
To define a named view and switch to it::
6254
bzr view --name view-name file1 dir1 ...
6256
To list a named view::
6258
bzr view --name view-name
6260
To delete a named view::
6262
bzr view --name view-name --delete
6264
To switch to a named view::
6266
bzr view --switch view-name
6268
To list all views defined::
6272
To delete all views::
6274
bzr view --delete --all
6278
takes_args = ['file*']
6281
help='Apply list or delete action to all views.',
6284
help='Delete the view.',
6287
help='Name of the view to define, list or delete.',
6291
help='Name of the view to switch to.',
6296
def run(self, file_list,
6302
tree, file_list = WorkingTree.open_containing_paths(file_list,
6304
current_view, view_dict = tree.views.get_view_info()
6309
raise errors.BzrCommandError(gettext(
6310
"Both --delete and a file list specified"))
6312
raise errors.BzrCommandError(gettext(
6313
"Both --delete and --switch specified"))
6315
tree.views.set_view_info(None, {})
6316
self.outf.write(gettext("Deleted all views.\n"))
6318
raise errors.BzrCommandError(gettext("No current view to delete"))
6320
tree.views.delete_view(name)
6321
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6324
raise errors.BzrCommandError(gettext(
6325
"Both --switch and a file list specified"))
6327
raise errors.BzrCommandError(gettext(
6328
"Both --switch and --all specified"))
6329
elif switch == 'off':
6330
if current_view is None:
6331
raise errors.BzrCommandError(gettext("No current view to disable"))
6332
tree.views.set_view_info(None, view_dict)
6333
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6335
tree.views.set_view_info(switch, view_dict)
6336
view_str = views.view_display_str(tree.views.lookup_view())
6337
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6340
self.outf.write(gettext('Views defined:\n'))
6341
for view in sorted(view_dict):
6342
if view == current_view:
6346
view_str = views.view_display_str(view_dict[view])
6347
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6349
self.outf.write(gettext('No views defined.\n'))
6352
# No name given and no current view set
6355
raise errors.BzrCommandError(gettext(
6356
"Cannot change the 'off' pseudo view"))
6357
tree.views.set_view(name, sorted(file_list))
6358
view_str = views.view_display_str(tree.views.lookup_view())
6359
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6363
# No name given and no current view set
6364
self.outf.write(gettext('No current view.\n'))
6366
view_str = views.view_display_str(tree.views.lookup_view(name))
6367
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6370
class cmd_hooks(Command):
6371
__doc__ = """Show hooks."""
6376
for hook_key in sorted(hooks.known_hooks.keys()):
6377
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6378
self.outf.write("%s:\n" % type(some_hooks).__name__)
6379
for hook_name, hook_point in sorted(some_hooks.items()):
6380
self.outf.write(" %s:\n" % (hook_name,))
6381
found_hooks = list(hook_point)
6383
for hook in found_hooks:
6384
self.outf.write(" %s\n" %
6385
(some_hooks.get_hook_name(hook),))
6387
self.outf.write(gettext(" <no hooks installed>\n"))
6390
class cmd_remove_branch(Command):
6391
__doc__ = """Remove a branch.
6393
This will remove the branch from the specified location but
6394
will keep any working tree or repository in place.
6398
Remove the branch at repo/trunk::
6400
bzr remove-branch repo/trunk
6404
takes_args = ["location?"]
6406
aliases = ["rmbranch"]
6408
def run(self, location=None):
6409
if location is None:
6411
branch = Branch.open_containing(location)[0]
6412
branch.bzrdir.destroy_branch()
6415
class cmd_shelve(Command):
6416
__doc__ = """Temporarily set aside some changes from the current tree.
6418
Shelve allows you to temporarily put changes you've made "on the shelf",
6419
ie. out of the way, until a later time when you can bring them back from
6420
the shelf with the 'unshelve' command. The changes are stored alongside
6421
your working tree, and so they aren't propagated along with your branch nor
6422
will they survive its deletion.
6424
If shelve --list is specified, previously-shelved changes are listed.
6426
Shelve is intended to help separate several sets of changes that have
6427
been inappropriately mingled. If you just want to get rid of all changes
6428
and you don't need to restore them later, use revert. If you want to
6429
shelve all text changes at once, use shelve --all.
6431
If filenames are specified, only the changes to those files will be
6432
shelved. Other files will be left untouched.
6434
If a revision is specified, changes since that revision will be shelved.
6436
You can put multiple items on the shelf, and by default, 'unshelve' will
6437
restore the most recently shelved changes.
6439
For complicated changes, it is possible to edit the changes in a separate
6440
editor program to decide what the file remaining in the working copy
6441
should look like. To do this, add the configuration option
6443
change_editor = PROGRAM @new_path @old_path
6445
where @new_path is replaced with the path of the new version of the
6446
file and @old_path is replaced with the path of the old version of
6447
the file. The PROGRAM should save the new file with the desired
6448
contents of the file in the working tree.
6452
takes_args = ['file*']
6457
Option('all', help='Shelve all changes.'),
6459
RegistryOption('writer', 'Method to use for writing diffs.',
6460
bzrlib.option.diff_writer_registry,
6461
value_switches=True, enum_switch=False),
6463
Option('list', help='List shelved changes.'),
6465
help='Destroy removed changes instead of shelving them.'),
6467
_see_also = ['unshelve', 'configuration']
6469
def run(self, revision=None, all=False, file_list=None, message=None,
6470
writer=None, list=False, destroy=False, directory=None):
6472
return self.run_for_list(directory=directory)
6473
from bzrlib.shelf_ui import Shelver
6475
writer = bzrlib.option.diff_writer_registry.get()
6477
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6478
file_list, message, destroy=destroy, directory=directory)
6483
except errors.UserAbort:
6486
def run_for_list(self, directory=None):
6487
if directory is None:
6489
tree = WorkingTree.open_containing(directory)[0]
6490
self.add_cleanup(tree.lock_read().unlock)
6491
manager = tree.get_shelf_manager()
6492
shelves = manager.active_shelves()
6493
if len(shelves) == 0:
6494
note(gettext('No shelved changes.'))
6496
for shelf_id in reversed(shelves):
6497
message = manager.get_metadata(shelf_id).get('message')
6499
message = '<no message>'
6500
self.outf.write('%3d: %s\n' % (shelf_id, message))
6504
class cmd_unshelve(Command):
6505
__doc__ = """Restore shelved changes.
6507
By default, the most recently shelved changes are restored. However if you
6508
specify a shelf by id those changes will be restored instead. This works
6509
best when the changes don't depend on each other.
6512
takes_args = ['shelf_id?']
6515
RegistryOption.from_kwargs(
6516
'action', help="The action to perform.",
6517
enum_switch=False, value_switches=True,
6518
apply="Apply changes and remove from the shelf.",
6519
dry_run="Show changes, but do not apply or remove them.",
6520
preview="Instead of unshelving the changes, show the diff that "
6521
"would result from unshelving.",
6522
delete_only="Delete changes without applying them.",
6523
keep="Apply changes but don't delete them.",
6526
_see_also = ['shelve']
6528
def run(self, shelf_id=None, action='apply', directory=u'.'):
6529
from bzrlib.shelf_ui import Unshelver
6530
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6534
unshelver.tree.unlock()
6537
class cmd_clean_tree(Command):
6538
__doc__ = """Remove unwanted files from working tree.
6540
By default, only unknown files, not ignored files, are deleted. Versioned
6541
files are never deleted.
6543
Another class is 'detritus', which includes files emitted by bzr during
6544
normal operations and selftests. (The value of these files decreases with
6547
If no options are specified, unknown files are deleted. Otherwise, option
6548
flags are respected, and may be combined.
6550
To check what clean-tree will do, use --dry-run.
6552
takes_options = ['directory',
6553
Option('ignored', help='Delete all ignored files.'),
6554
Option('detritus', help='Delete conflict files, merge and revert'
6555
' backups, and failed selftest dirs.'),
6557
help='Delete files unknown to bzr (default).'),
6558
Option('dry-run', help='Show files to delete instead of'
6560
Option('force', help='Do not prompt before deleting.')]
6561
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6562
force=False, directory=u'.'):
6563
from bzrlib.clean_tree import clean_tree
6564
if not (unknown or ignored or detritus):
6568
clean_tree(directory, unknown=unknown, ignored=ignored,
6569
detritus=detritus, dry_run=dry_run, no_prompt=force)
6572
class cmd_reference(Command):
6573
__doc__ = """list, view and set branch locations for nested trees.
6575
If no arguments are provided, lists the branch locations for nested trees.
6576
If one argument is provided, display the branch location for that tree.
6577
If two arguments are provided, set the branch location for that tree.
6582
takes_args = ['path?', 'location?']
6584
def run(self, path=None, location=None):
6586
if path is not None:
6588
tree, branch, relpath =(
6589
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6590
if path is not None:
6593
tree = branch.basis_tree()
6595
info = branch._get_all_reference_info().iteritems()
6596
self._display_reference_info(tree, branch, info)
6598
file_id = tree.path2id(path)
6600
raise errors.NotVersionedError(path)
6601
if location is None:
6602
info = [(file_id, branch.get_reference_info(file_id))]
6603
self._display_reference_info(tree, branch, info)
6605
branch.set_reference_info(file_id, path, location)
6607
def _display_reference_info(self, tree, branch, info):
6609
for file_id, (path, location) in info:
6611
path = tree.id2path(file_id)
6612
except errors.NoSuchId:
6614
ref_list.append((path, location))
6615
for path, location in sorted(ref_list):
6616
self.outf.write('%s %s\n' % (path, location))
6619
class cmd_export_pot(Command):
6620
__doc__ = """Export command helps and error messages in po format."""
6623
takes_options = [Option('plugin',
6624
help='Export help text from named command '\
6625
'(defaults to all built in commands).',
6627
Option('include-duplicates',
6628
help='Output multiple copies of the same msgid '
6629
'string if it appears more than once.'),
6632
def run(self, plugin=None, include_duplicates=False):
6633
from bzrlib.export_pot import export_pot
6634
export_pot(self.outf, plugin, include_duplicates)
6637
def _register_lazy_builtins():
6638
# register lazy builtins from other modules; called at startup and should
6639
# be only called once.
6640
for (name, aliases, module_name) in [
6641
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6642
('cmd_config', [], 'bzrlib.config'),
6643
('cmd_dpush', [], 'bzrlib.foreign'),
6644
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6645
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6646
('cmd_conflicts', [], 'bzrlib.conflicts'),
6647
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6648
('cmd_verify_signatures', [],
6649
'bzrlib.commit_signature_commands'),
6650
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6652
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
