1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
19
from __future__ import absolute_import
25
from bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
40
config as _mod_config,
50
revision as _mod_revision,
59
from bzrlib.branch import Branch
60
from bzrlib.conflicts import ConflictList
61
from bzrlib.transport import memory
62
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
63
from bzrlib.smtp_connection import SMTPConnection
64
from bzrlib.workingtree import WorkingTree
65
from bzrlib.i18n import gettext, ngettext
68
from bzrlib.commands import (
70
builtin_command_registry,
73
from bzrlib.option import (
80
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
86
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
87
def tree_files(file_list, default_branch=u'.', canonicalize=True,
89
return internal_tree_files(file_list, default_branch, canonicalize,
93
def tree_files_for_add(file_list):
95
Return a tree and list of absolute paths from a file list.
97
Similar to tree_files, but add handles files a bit differently, so it a
98
custom implementation. In particular, MutableTreeTree.smart_add expects
99
absolute paths, which it immediately converts to relative paths.
101
# FIXME Would be nice to just return the relative paths like
102
# internal_tree_files does, but there are a large number of unit tests
103
# that assume the current interface to mutabletree.smart_add
105
tree, relpath = WorkingTree.open_containing(file_list[0])
106
if tree.supports_views():
107
view_files = tree.views.lookup_view()
109
for filename in file_list:
110
if not osutils.is_inside_any(view_files, filename):
111
raise errors.FileOutsideView(filename, view_files)
112
file_list = file_list[:]
113
file_list[0] = tree.abspath(relpath)
115
tree = WorkingTree.open_containing(u'.')[0]
116
if tree.supports_views():
117
view_files = tree.views.lookup_view()
119
file_list = view_files
120
view_str = views.view_display_str(view_files)
121
note(gettext("Ignoring files outside view. View is %s") % view_str)
122
return tree, file_list
125
def _get_one_revision(command_name, revisions):
126
if revisions is None:
128
if len(revisions) != 1:
129
raise errors.BzrCommandError(gettext(
130
'bzr %s --revision takes exactly one revision identifier') % (
135
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
136
"""Get a revision tree. Not suitable for commands that change the tree.
138
Specifically, the basis tree in dirstate trees is coupled to the dirstate
139
and doing a commit/uncommit/pull will at best fail due to changing the
142
If tree is passed in, it should be already locked, for lifetime management
143
of the trees internal cached state.
147
if revisions is None:
149
rev_tree = tree.basis_tree()
151
rev_tree = branch.basis_tree()
153
revision = _get_one_revision(command_name, revisions)
154
rev_tree = revision.as_tree(branch)
158
# XXX: Bad function name; should possibly also be a class method of
159
# WorkingTree rather than a function.
160
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
161
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
163
"""Convert command-line paths to a WorkingTree and relative paths.
165
Deprecated: use WorkingTree.open_containing_paths instead.
167
This is typically used for command-line processors that take one or
168
more filenames, and infer the workingtree that contains them.
170
The filenames given are not required to exist.
172
:param file_list: Filenames to convert.
174
:param default_branch: Fallback tree path to use if file_list is empty or
177
:param apply_view: if True and a view is set, apply it or check that
178
specified files are within it
180
:return: workingtree, [relative_paths]
182
return WorkingTree.open_containing_paths(
183
file_list, default_directory='.',
188
def _get_view_info_for_change_reporter(tree):
189
"""Get the view information from a tree for change reporting."""
192
current_view = tree.views.get_view_info()[0]
193
if current_view is not None:
194
view_info = (current_view, tree.views.lookup_view())
195
except errors.ViewsNotSupported:
200
def _open_directory_or_containing_tree_or_branch(filename, directory):
201
"""Open the tree or branch containing the specified file, unless
202
the --directory option is used to specify a different branch."""
203
if directory is not None:
204
return (None, Branch.open(directory), filename)
205
return controldir.ControlDir.open_containing_tree_or_branch(filename)
208
# TODO: Make sure no commands unconditionally use the working directory as a
209
# branch. If a filename argument is used, the first of them should be used to
210
# specify the branch. (Perhaps this can be factored out into some kind of
211
# Argument class, representing a file in a branch, where the first occurrence
214
class cmd_status(Command):
215
__doc__ = """Display status summary.
217
This reports on versioned and unknown files, reporting them
218
grouped by state. Possible states are:
221
Versioned in the working copy but not in the previous revision.
224
Versioned in the previous revision but removed or deleted
228
Path of this file changed from the previous revision;
229
the text may also have changed. This includes files whose
230
parent directory was renamed.
233
Text has changed since the previous revision.
236
File kind has been changed (e.g. from file to directory).
239
Not versioned and not matching an ignore pattern.
241
Additionally for directories, symlinks and files with a changed
242
executable bit, Bazaar indicates their type using a trailing
243
character: '/', '@' or '*' respectively. These decorations can be
244
disabled using the '--no-classify' option.
246
To see ignored files use 'bzr ignored'. For details on the
247
changes to file texts, use 'bzr diff'.
249
Note that --short or -S gives status flags for each item, similar
250
to Subversion's status command. To get output similar to svn -q,
253
If no arguments are specified, the status of the entire working
254
directory is shown. Otherwise, only the status of the specified
255
files or directories is reported. If a directory is given, status
256
is reported for everything inside that directory.
258
Before merges are committed, the pending merge tip revisions are
259
shown. To see all pending merge revisions, use the -v option.
260
To skip the display of pending merge information altogether, use
261
the no-pending option or specify a file/directory.
263
To compare the working directory to a specific revision, pass a
264
single revision to the revision argument.
266
To see which files have changed in a specific revision, or between
267
two revisions, pass a revision range to the revision argument.
268
This will produce the same results as calling 'bzr diff --summarize'.
271
# TODO: --no-recurse, --recurse options
273
takes_args = ['file*']
274
takes_options = ['show-ids', 'revision', 'change', 'verbose',
275
Option('short', help='Use short status indicators.',
277
Option('versioned', help='Only show versioned files.',
279
Option('no-pending', help='Don\'t show pending merges.',
281
Option('no-classify',
282
help='Do not mark object type using indicator.',
285
aliases = ['st', 'stat']
287
encoding_type = 'replace'
288
_see_also = ['diff', 'revert', 'status-flags']
291
def run(self, show_ids=False, file_list=None, revision=None, short=False,
292
versioned=False, no_pending=False, verbose=False,
294
from bzrlib.status import show_tree_status
296
if revision and len(revision) > 2:
297
raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
298
' one or two revision specifiers'))
300
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
301
# Avoid asking for specific files when that is not needed.
302
if relfile_list == ['']:
304
# Don't disable pending merges for full trees other than '.'.
305
if file_list == ['.']:
307
# A specific path within a tree was given.
308
elif relfile_list is not None:
310
show_tree_status(tree, show_ids=show_ids,
311
specific_files=relfile_list, revision=revision,
312
to_file=self.outf, short=short, versioned=versioned,
313
show_pending=(not no_pending), verbose=verbose,
314
classify=not no_classify)
317
class cmd_cat_revision(Command):
318
__doc__ = """Write out metadata for a revision.
320
The revision to print can either be specified by a specific
321
revision identifier, or you can use --revision.
325
takes_args = ['revision_id?']
326
takes_options = ['directory', 'revision']
327
# cat-revision is more for frontends so should be exact
330
def print_revision(self, revisions, revid):
331
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
332
record = stream.next()
333
if record.storage_kind == 'absent':
334
raise errors.NoSuchRevision(revisions, revid)
335
revtext = record.get_bytes_as('fulltext')
336
self.outf.write(revtext.decode('utf-8'))
339
def run(self, revision_id=None, revision=None, directory=u'.'):
340
if revision_id is not None and revision is not None:
341
raise errors.BzrCommandError(gettext('You can only supply one of'
342
' revision_id or --revision'))
343
if revision_id is None and revision is None:
344
raise errors.BzrCommandError(gettext('You must supply either'
345
' --revision or a revision_id'))
347
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
349
revisions = b.repository.revisions
350
if revisions is None:
351
raise errors.BzrCommandError(gettext('Repository %r does not support '
352
'access to raw revision texts'))
354
b.repository.lock_read()
356
# TODO: jam 20060112 should cat-revision always output utf-8?
357
if revision_id is not None:
358
revision_id = osutils.safe_revision_id(revision_id, warn=False)
360
self.print_revision(revisions, revision_id)
361
except errors.NoSuchRevision:
362
msg = gettext("The repository {0} contains no revision {1}.").format(
363
b.repository.base, revision_id)
364
raise errors.BzrCommandError(msg)
365
elif revision is not None:
368
raise errors.BzrCommandError(
369
gettext('You cannot specify a NULL revision.'))
370
rev_id = rev.as_revision_id(b)
371
self.print_revision(revisions, rev_id)
373
b.repository.unlock()
376
class cmd_dump_btree(Command):
377
__doc__ = """Dump the contents of a btree index file to stdout.
379
PATH is a btree index file, it can be any URL. This includes things like
380
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
382
By default, the tuples stored in the index file will be displayed. With
383
--raw, we will uncompress the pages, but otherwise display the raw bytes
387
# TODO: Do we want to dump the internal nodes as well?
388
# TODO: It would be nice to be able to dump the un-parsed information,
389
# rather than only going through iter_all_entries. However, this is
390
# good enough for a start
392
encoding_type = 'exact'
393
takes_args = ['path']
394
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
395
' rather than the parsed tuples.'),
398
def run(self, path, raw=False):
399
dirname, basename = osutils.split(path)
400
t = transport.get_transport(dirname)
402
self._dump_raw_bytes(t, basename)
404
self._dump_entries(t, basename)
406
def _get_index_and_bytes(self, trans, basename):
407
"""Create a BTreeGraphIndex and raw bytes."""
408
bt = btree_index.BTreeGraphIndex(trans, basename, None)
409
bytes = trans.get_bytes(basename)
410
bt._file = cStringIO.StringIO(bytes)
411
bt._size = len(bytes)
414
def _dump_raw_bytes(self, trans, basename):
417
# We need to parse at least the root node.
418
# This is because the first page of every row starts with an
419
# uncompressed header.
420
bt, bytes = self._get_index_and_bytes(trans, basename)
421
for page_idx, page_start in enumerate(xrange(0, len(bytes),
422
btree_index._PAGE_SIZE)):
423
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
424
page_bytes = bytes[page_start:page_end]
426
self.outf.write('Root node:\n')
427
header_end, data = bt._parse_header_from_bytes(page_bytes)
428
self.outf.write(page_bytes[:header_end])
430
self.outf.write('\nPage %d\n' % (page_idx,))
431
if len(page_bytes) == 0:
432
self.outf.write('(empty)\n');
434
decomp_bytes = zlib.decompress(page_bytes)
435
self.outf.write(decomp_bytes)
436
self.outf.write('\n')
438
def _dump_entries(self, trans, basename):
440
st = trans.stat(basename)
441
except errors.TransportNotPossible:
442
# We can't stat, so we'll fake it because we have to do the 'get()'
444
bt, _ = self._get_index_and_bytes(trans, basename)
446
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
447
for node in bt.iter_all_entries():
448
# Node is made up of:
449
# (index, key, value, [references])
453
refs_as_tuples = None
455
refs_as_tuples = static_tuple.as_tuples(refs)
456
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
457
self.outf.write('%s\n' % (as_tuple,))
460
class cmd_remove_tree(Command):
461
__doc__ = """Remove the working tree from a given branch/checkout.
463
Since a lightweight checkout is little more than a working tree
464
this will refuse to run against one.
466
To re-create the working tree, use "bzr checkout".
468
_see_also = ['checkout', 'working-trees']
469
takes_args = ['location*']
472
help='Remove the working tree even if it has '
473
'uncommitted or shelved changes.'),
476
def run(self, location_list, force=False):
477
if not location_list:
480
for location in location_list:
481
d = controldir.ControlDir.open(location)
484
working = d.open_workingtree()
485
except errors.NoWorkingTree:
486
raise errors.BzrCommandError(gettext("No working tree to remove"))
487
except errors.NotLocalUrl:
488
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
489
" of a remote path"))
491
if (working.has_changes()):
492
raise errors.UncommittedChanges(working)
493
if working.get_shelf_manager().last_shelf() is not None:
494
raise errors.ShelvedChanges(working)
496
if working.user_url != working.branch.user_url:
497
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
498
" from a lightweight checkout"))
500
d.destroy_workingtree()
503
class cmd_repair_workingtree(Command):
504
__doc__ = """Reset the working tree state file.
506
This is not meant to be used normally, but more as a way to recover from
507
filesystem corruption, etc. This rebuilds the working inventory back to a
508
'known good' state. Any new modifications (adding a file, renaming, etc)
509
will be lost, though modified files will still be detected as such.
511
Most users will want something more like "bzr revert" or "bzr update"
512
unless the state file has become corrupted.
514
By default this attempts to recover the current state by looking at the
515
headers of the state file. If the state file is too corrupted to even do
516
that, you can supply --revision to force the state of the tree.
519
takes_options = ['revision', 'directory',
521
help='Reset the tree even if it doesn\'t appear to be'
526
def run(self, revision=None, directory='.', force=False):
527
tree, _ = WorkingTree.open_containing(directory)
528
self.add_cleanup(tree.lock_tree_write().unlock)
532
except errors.BzrError:
533
pass # There seems to be a real error here, so we'll reset
536
raise errors.BzrCommandError(gettext(
537
'The tree does not appear to be corrupt. You probably'
538
' want "bzr revert" instead. Use "--force" if you are'
539
' sure you want to reset the working tree.'))
543
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
545
tree.reset_state(revision_ids)
546
except errors.BzrError, e:
547
if revision_ids is None:
548
extra = (gettext(', the header appears corrupt, try passing -r -1'
549
' to set the state to the last commit'))
552
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
555
class cmd_revno(Command):
556
__doc__ = """Show current revision number.
558
This is equal to the number of revisions on this branch.
562
takes_args = ['location?']
564
Option('tree', help='Show revno of working tree.'),
569
def run(self, tree=False, location=u'.', revision=None):
570
if revision is not None and tree:
571
raise errors.BzrCommandError(gettext("--tree and --revision can "
572
"not be used together"))
576
wt = WorkingTree.open_containing(location)[0]
577
self.add_cleanup(wt.lock_read().unlock)
578
except (errors.NoWorkingTree, errors.NotLocalUrl):
579
raise errors.NoWorkingTree(location)
581
revid = wt.last_revision()
583
b = Branch.open_containing(location)[0]
584
self.add_cleanup(b.lock_read().unlock)
586
if len(revision) != 1:
587
raise errors.BzrCommandError(gettext(
588
"Tags can only be placed on a single revision, "
590
revid = revision[0].as_revision_id(b)
592
revid = b.last_revision()
594
revno_t = b.revision_id_to_dotted_revno(revid)
595
except errors.NoSuchRevision:
597
revno = ".".join(str(n) for n in revno_t)
599
self.outf.write(revno + '\n')
602
class cmd_revision_info(Command):
603
__doc__ = """Show revision number and revision id for a given revision identifier.
606
takes_args = ['revision_info*']
609
custom_help('directory',
610
help='Branch to examine, '
611
'rather than the one containing the working directory.'),
612
Option('tree', help='Show revno of working tree.'),
616
def run(self, revision=None, directory=u'.', tree=False,
617
revision_info_list=[]):
620
wt = WorkingTree.open_containing(directory)[0]
622
self.add_cleanup(wt.lock_read().unlock)
623
except (errors.NoWorkingTree, errors.NotLocalUrl):
625
b = Branch.open_containing(directory)[0]
626
self.add_cleanup(b.lock_read().unlock)
628
if revision is not None:
629
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
630
if revision_info_list is not None:
631
for rev_str in revision_info_list:
632
rev_spec = RevisionSpec.from_string(rev_str)
633
revision_ids.append(rev_spec.as_revision_id(b))
634
# No arguments supplied, default to the last revision
635
if len(revision_ids) == 0:
638
raise errors.NoWorkingTree(directory)
639
revision_ids.append(wt.last_revision())
641
revision_ids.append(b.last_revision())
645
for revision_id in revision_ids:
647
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
648
revno = '.'.join(str(i) for i in dotted_revno)
649
except errors.NoSuchRevision:
651
maxlen = max(maxlen, len(revno))
652
revinfos.append([revno, revision_id])
656
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
659
class cmd_add(Command):
660
__doc__ = """Add specified files or directories.
662
In non-recursive mode, all the named items are added, regardless
663
of whether they were previously ignored. A warning is given if
664
any of the named files are already versioned.
666
In recursive mode (the default), files are treated the same way
667
but the behaviour for directories is different. Directories that
668
are already versioned do not give a warning. All directories,
669
whether already versioned or not, are searched for files or
670
subdirectories that are neither versioned or ignored, and these
671
are added. This search proceeds recursively into versioned
672
directories. If no names are given '.' is assumed.
674
A warning will be printed when nested trees are encountered,
675
unless they are explicitly ignored.
677
Therefore simply saying 'bzr add' will version all files that
678
are currently unknown.
680
Adding a file whose parent directory is not versioned will
681
implicitly add the parent, and so on up to the root. This means
682
you should never need to explicitly add a directory, they'll just
683
get added when you add a file in the directory.
685
--dry-run will show which files would be added, but not actually
688
--file-ids-from will try to use the file ids from the supplied path.
689
It looks up ids trying to find a matching parent directory with the
690
same filename, and then by pure path. This option is rarely needed
691
but can be useful when adding the same logical file into two
692
branches that will be merged later (without showing the two different
693
adds as a conflict). It is also useful when merging another project
694
into a subdirectory of this one.
696
Any files matching patterns in the ignore list will not be added
697
unless they are explicitly mentioned.
699
In recursive mode, files larger than the configuration option
700
add.maximum_file_size will be skipped. Named items are never skipped due
703
takes_args = ['file*']
706
help="Don't recursively add the contents of directories."),
708
help="Show what would be done, but don't actually do anything."),
710
Option('file-ids-from',
712
help='Lookup file ids from this tree.'),
714
encoding_type = 'replace'
715
_see_also = ['remove', 'ignore']
717
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
722
if file_ids_from is not None:
724
base_tree, base_path = WorkingTree.open_containing(
726
except errors.NoWorkingTree:
727
base_branch, base_path = Branch.open_containing(
729
base_tree = base_branch.basis_tree()
731
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
732
to_file=self.outf, should_print=(not is_quiet()))
734
action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
735
should_print=(not is_quiet()))
738
self.add_cleanup(base_tree.lock_read().unlock)
739
tree, file_list = tree_files_for_add(file_list)
740
added, ignored = tree.smart_add(file_list, not
741
no_recurse, action=action, save=not dry_run)
745
for glob in sorted(ignored.keys()):
746
for path in ignored[glob]:
748
gettext("ignored {0} matching \"{1}\"\n").format(
752
class cmd_mkdir(Command):
753
__doc__ = """Create a new versioned directory.
755
This is equivalent to creating the directory and then adding it.
758
takes_args = ['dir+']
762
help='No error if existing, make parent directories as needed.',
766
encoding_type = 'replace'
769
def add_file_with_parents(cls, wt, relpath):
770
if wt.path2id(relpath) is not None:
772
cls.add_file_with_parents(wt, osutils.dirname(relpath))
776
def add_file_single(cls, wt, relpath):
779
def run(self, dir_list, parents=False):
781
add_file = self.add_file_with_parents
783
add_file = self.add_file_single
785
wt, relpath = WorkingTree.open_containing(dir)
790
if e.errno != errno.EEXIST:
794
add_file(wt, relpath)
796
self.outf.write(gettext('added %s\n') % dir)
799
class cmd_relpath(Command):
800
__doc__ = """Show path of a file relative to root"""
802
takes_args = ['filename']
806
def run(self, filename):
807
# TODO: jam 20050106 Can relpath return a munged path if
808
# sys.stdout encoding cannot represent it?
809
tree, relpath = WorkingTree.open_containing(filename)
810
self.outf.write(relpath)
811
self.outf.write('\n')
814
class cmd_inventory(Command):
815
__doc__ = """Show inventory of the current working copy or a revision.
817
It is possible to limit the output to a particular entry
818
type using the --kind option. For example: --kind file.
820
It is also possible to restrict the list of files to a specific
821
set. For example: bzr inventory --show-ids this/file
830
help='List entries of a particular kind: file, directory, symlink.',
833
takes_args = ['file*']
836
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
837
if kind and kind not in ['file', 'directory', 'symlink']:
838
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
840
revision = _get_one_revision('inventory', revision)
841
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
842
self.add_cleanup(work_tree.lock_read().unlock)
843
if revision is not None:
844
tree = revision.as_tree(work_tree.branch)
846
extra_trees = [work_tree]
847
self.add_cleanup(tree.lock_read().unlock)
852
if file_list is not None:
853
file_ids = tree.paths2ids(file_list, trees=extra_trees,
854
require_versioned=True)
855
# find_ids_across_trees may include some paths that don't
858
(tree.id2path(file_id), tree.inventory[file_id])
859
for file_id in file_ids if tree.has_id(file_id))
861
entries = tree.inventory.entries()
864
for path, entry in entries:
865
if kind and kind != entry.kind:
868
self.outf.write('%-50s %s\n' % (path, entry.file_id))
870
self.outf.write(path)
871
self.outf.write('\n')
874
class cmd_mv(Command):
875
__doc__ = """Move or rename a file.
878
bzr mv OLDNAME NEWNAME
880
bzr mv SOURCE... DESTINATION
882
If the last argument is a versioned directory, all the other names
883
are moved into it. Otherwise, there must be exactly two arguments
884
and the file is changed to a new name.
886
If OLDNAME does not exist on the filesystem but is versioned and
887
NEWNAME does exist on the filesystem but is not versioned, mv
888
assumes that the file has been manually moved and only updates
889
its internal inventory to reflect that change.
890
The same is valid when moving many SOURCE files to a DESTINATION.
892
Files cannot be moved between branches.
895
takes_args = ['names*']
896
takes_options = [Option("after", help="Move only the bzr identifier"
897
" of the file, because the file has already been moved."),
898
Option('auto', help='Automatically guess renames.'),
899
Option('dry-run', help='Avoid making changes when guessing renames.'),
901
aliases = ['move', 'rename']
902
encoding_type = 'replace'
904
def run(self, names_list, after=False, auto=False, dry_run=False):
906
return self.run_auto(names_list, after, dry_run)
908
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
909
if names_list is None:
911
if len(names_list) < 2:
912
raise errors.BzrCommandError(gettext("missing file argument"))
913
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
914
for file_name in rel_names[0:-1]:
916
raise errors.BzrCommandError(gettext("can not move root of branch"))
917
self.add_cleanup(tree.lock_tree_write().unlock)
918
self._run(tree, names_list, rel_names, after)
920
def run_auto(self, names_list, after, dry_run):
921
if names_list is not None and len(names_list) > 1:
922
raise errors.BzrCommandError(gettext('Only one path may be specified to'
925
raise errors.BzrCommandError(gettext('--after cannot be specified with'
927
work_tree, file_list = WorkingTree.open_containing_paths(
928
names_list, default_directory='.')
929
self.add_cleanup(work_tree.lock_tree_write().unlock)
930
rename_map.RenameMap.guess_renames(work_tree, dry_run)
932
def _run(self, tree, names_list, rel_names, after):
933
into_existing = osutils.isdir(names_list[-1])
934
if into_existing and len(names_list) == 2:
936
# a. case-insensitive filesystem and change case of dir
937
# b. move directory after the fact (if the source used to be
938
# a directory, but now doesn't exist in the working tree
939
# and the target is an existing directory, just rename it)
940
if (not tree.case_sensitive
941
and rel_names[0].lower() == rel_names[1].lower()):
942
into_existing = False
945
# 'fix' the case of a potential 'from'
946
from_id = tree.path2id(
947
tree.get_canonical_inventory_path(rel_names[0]))
948
if (not osutils.lexists(names_list[0]) and
949
from_id and inv.get_file_kind(from_id) == "directory"):
950
into_existing = False
953
# move into existing directory
954
# All entries reference existing inventory items, so fix them up
955
# for cicp file-systems.
956
rel_names = tree.get_canonical_inventory_paths(rel_names)
957
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
959
self.outf.write("%s => %s\n" % (src, dest))
961
if len(names_list) != 2:
962
raise errors.BzrCommandError(gettext('to mv multiple files the'
963
' destination must be a versioned'
966
# for cicp file-systems: the src references an existing inventory
968
src = tree.get_canonical_inventory_path(rel_names[0])
969
# Find the canonical version of the destination: In all cases, the
970
# parent of the target must be in the inventory, so we fetch the
971
# canonical version from there (we do not always *use* the
972
# canonicalized tail portion - we may be attempting to rename the
974
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
975
dest_parent = osutils.dirname(canon_dest)
976
spec_tail = osutils.basename(rel_names[1])
977
# For a CICP file-system, we need to avoid creating 2 inventory
978
# entries that differ only by case. So regardless of the case
979
# we *want* to use (ie, specified by the user or the file-system),
980
# we must always choose to use the case of any existing inventory
981
# items. The only exception to this is when we are attempting a
982
# case-only rename (ie, canonical versions of src and dest are
984
dest_id = tree.path2id(canon_dest)
985
if dest_id is None or tree.path2id(src) == dest_id:
986
# No existing item we care about, so work out what case we
987
# are actually going to use.
989
# If 'after' is specified, the tail must refer to a file on disk.
991
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
993
# pathjoin with an empty tail adds a slash, which breaks
995
dest_parent_fq = tree.basedir
997
dest_tail = osutils.canonical_relpath(
999
osutils.pathjoin(dest_parent_fq, spec_tail))
1001
# not 'after', so case as specified is used
1002
dest_tail = spec_tail
1004
# Use the existing item so 'mv' fails with AlreadyVersioned.
1005
dest_tail = os.path.basename(canon_dest)
1006
dest = osutils.pathjoin(dest_parent, dest_tail)
1007
mutter("attempting to move %s => %s", src, dest)
1008
tree.rename_one(src, dest, after=after)
1010
self.outf.write("%s => %s\n" % (src, dest))
1013
class cmd_pull(Command):
1014
__doc__ = """Turn this branch into a mirror of another branch.
1016
By default, this command only works on branches that have not diverged.
1017
Branches are considered diverged if the destination branch's most recent
1018
commit is one that has not been merged (directly or indirectly) into the
1021
If branches have diverged, you can use 'bzr merge' to integrate the changes
1022
from one into the other. Once one branch has merged, the other should
1023
be able to pull it again.
1025
If you want to replace your local changes and just want your branch to
1026
match the remote one, use pull --overwrite. This will work even if the two
1027
branches have diverged.
1029
If there is no default location set, the first pull will set it (use
1030
--no-remember to avoid setting it). After that, you can omit the
1031
location to use the default. To change the default, use --remember. The
1032
value will only be saved if the remote location can be accessed.
1034
The --verbose option will display the revisions pulled using the log_format
1035
configuration option. You can use a different format by overriding it with
1036
-Olog_format=<other_format>.
1038
Note: The location can be specified either in the form of a branch,
1039
or in the form of a path to a file containing a merge directive generated
1043
_see_also = ['push', 'update', 'status-flags', 'send']
1044
takes_options = ['remember', 'overwrite', 'revision',
1045
custom_help('verbose',
1046
help='Show logs of pulled revisions.'),
1047
custom_help('directory',
1048
help='Branch to pull into, '
1049
'rather than the one containing the working directory.'),
1051
help="Perform a local pull in a bound "
1052
"branch. Local pulls are not applied to "
1053
"the master branch."
1056
help="Show base revision text in conflicts.")
1058
takes_args = ['location?']
1059
encoding_type = 'replace'
1061
def run(self, location=None, remember=None, overwrite=False,
1062
revision=None, verbose=False,
1063
directory=None, local=False,
1065
# FIXME: too much stuff is in the command class
1068
if directory is None:
1071
tree_to = WorkingTree.open_containing(directory)[0]
1072
branch_to = tree_to.branch
1073
self.add_cleanup(tree_to.lock_write().unlock)
1074
except errors.NoWorkingTree:
1076
branch_to = Branch.open_containing(directory)[0]
1077
self.add_cleanup(branch_to.lock_write().unlock)
1079
if tree_to is None and show_base:
1080
raise errors.BzrCommandError(gettext("Need working tree for --show-base."))
1082
if local and not branch_to.get_bound_location():
1083
raise errors.LocalRequiresBoundBranch()
1085
possible_transports = []
1086
if location is not None:
1088
mergeable = bundle.read_mergeable_from_url(location,
1089
possible_transports=possible_transports)
1090
except errors.NotABundle:
1093
stored_loc = branch_to.get_parent()
1094
if location is None:
1095
if stored_loc is None:
1096
raise errors.BzrCommandError(gettext("No pull location known or"
1099
display_url = urlutils.unescape_for_display(stored_loc,
1102
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1103
location = stored_loc
1105
revision = _get_one_revision('pull', revision)
1106
if mergeable is not None:
1107
if revision is not None:
1108
raise errors.BzrCommandError(gettext(
1109
'Cannot use -r with merge directives or bundles'))
1110
mergeable.install_revisions(branch_to.repository)
1111
base_revision_id, revision_id, verified = \
1112
mergeable.get_merge_request(branch_to.repository)
1113
branch_from = branch_to
1115
branch_from = Branch.open(location,
1116
possible_transports=possible_transports)
1117
self.add_cleanup(branch_from.lock_read().unlock)
1118
# Remembers if asked explicitly or no previous location is set
1120
or (remember is None and branch_to.get_parent() is None)):
1121
branch_to.set_parent(branch_from.base)
1123
if revision is not None:
1124
revision_id = revision.as_revision_id(branch_from)
1126
if tree_to is not None:
1127
view_info = _get_view_info_for_change_reporter(tree_to)
1128
change_reporter = delta._ChangeReporter(
1129
unversioned_filter=tree_to.is_ignored,
1130
view_info=view_info)
1131
result = tree_to.pull(
1132
branch_from, overwrite, revision_id, change_reporter,
1133
local=local, show_base=show_base)
1135
result = branch_to.pull(
1136
branch_from, overwrite, revision_id, local=local)
1138
result.report(self.outf)
1139
if verbose and result.old_revid != result.new_revid:
1140
log.show_branch_change(
1141
branch_to, self.outf, result.old_revno,
1143
if getattr(result, 'tag_conflicts', None):
1149
class cmd_push(Command):
1150
__doc__ = """Update a mirror of this branch.
1152
The target branch will not have its working tree populated because this
1153
is both expensive, and is not supported on remote file systems.
1155
Some smart servers or protocols *may* put the working tree in place in
1158
This command only works on branches that have not diverged. Branches are
1159
considered diverged if the destination branch's most recent commit is one
1160
that has not been merged (directly or indirectly) by the source branch.
1162
If branches have diverged, you can use 'bzr push --overwrite' to replace
1163
the other branch completely, discarding its unmerged changes.
1165
If you want to ensure you have the different changes in the other branch,
1166
do a merge (see bzr help merge) from the other branch, and commit that.
1167
After that you will be able to do a push without '--overwrite'.
1169
If there is no default push location set, the first push will set it (use
1170
--no-remember to avoid setting it). After that, you can omit the
1171
location to use the default. To change the default, use --remember. The
1172
value will only be saved if the remote location can be accessed.
1174
The --verbose option will display the revisions pushed using the log_format
1175
configuration option. You can use a different format by overriding it with
1176
-Olog_format=<other_format>.
1179
_see_also = ['pull', 'update', 'working-trees']
1180
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1181
Option('create-prefix',
1182
help='Create the path leading up to the branch '
1183
'if it does not already exist.'),
1184
custom_help('directory',
1185
help='Branch to push from, '
1186
'rather than the one containing the working directory.'),
1187
Option('use-existing-dir',
1188
help='By default push will fail if the target'
1189
' directory exists, but does not already'
1190
' have a control directory. This flag will'
1191
' allow push to proceed.'),
1193
help='Create a stacked branch that references the public location '
1194
'of the parent branch.'),
1195
Option('stacked-on',
1196
help='Create a stacked branch that refers to another branch '
1197
'for the commit history. Only the work not present in the '
1198
'referenced branch is included in the branch created.',
1201
help='Refuse to push if there are uncommitted changes in'
1202
' the working tree, --no-strict disables the check.'),
1204
help="Don't populate the working tree, even for protocols"
1205
" that support it."),
1207
takes_args = ['location?']
1208
encoding_type = 'replace'
1210
def run(self, location=None, remember=None, overwrite=False,
1211
create_prefix=False, verbose=False, revision=None,
1212
use_existing_dir=False, directory=None, stacked_on=None,
1213
stacked=False, strict=None, no_tree=False):
1214
from bzrlib.push import _show_push_branch
1216
if directory is None:
1218
# Get the source branch
1220
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1221
# Get the tip's revision_id
1222
revision = _get_one_revision('push', revision)
1223
if revision is not None:
1224
revision_id = revision.in_history(br_from).rev_id
1227
if tree is not None and revision_id is None:
1228
tree.check_changed_or_out_of_date(
1229
strict, 'push_strict',
1230
more_error='Use --no-strict to force the push.',
1231
more_warning='Uncommitted changes will not be pushed.')
1232
# Get the stacked_on branch, if any
1233
if stacked_on is not None:
1234
stacked_on = urlutils.normalize_url(stacked_on)
1236
parent_url = br_from.get_parent()
1238
parent = Branch.open(parent_url)
1239
stacked_on = parent.get_public_branch()
1241
# I considered excluding non-http url's here, thus forcing
1242
# 'public' branches only, but that only works for some
1243
# users, so it's best to just depend on the user spotting an
1244
# error by the feedback given to them. RBC 20080227.
1245
stacked_on = parent_url
1247
raise errors.BzrCommandError(gettext(
1248
"Could not determine branch to refer to."))
1250
# Get the destination location
1251
if location is None:
1252
stored_loc = br_from.get_push_location()
1253
if stored_loc is None:
1254
parent_loc = br_from.get_parent()
1256
raise errors.BzrCommandError(gettext(
1257
"No push location known or specified. To push to the "
1258
"parent branch (at %s), use 'bzr push :parent'." %
1259
urlutils.unescape_for_display(parent_loc,
1260
self.outf.encoding)))
1262
raise errors.BzrCommandError(gettext(
1263
"No push location known or specified."))
1265
display_url = urlutils.unescape_for_display(stored_loc,
1267
note(gettext("Using saved push location: %s") % display_url)
1268
location = stored_loc
1270
_show_push_branch(br_from, revision_id, location, self.outf,
1271
verbose=verbose, overwrite=overwrite, remember=remember,
1272
stacked_on=stacked_on, create_prefix=create_prefix,
1273
use_existing_dir=use_existing_dir, no_tree=no_tree)
1276
class cmd_branch(Command):
1277
__doc__ = """Create a new branch that is a copy of an existing branch.
1279
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1280
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1281
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1282
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1283
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1286
To retrieve the branch as of a particular revision, supply the --revision
1287
parameter, as in "branch foo/bar -r 5".
1289
The synonyms 'clone' and 'get' for this command are deprecated.
1292
_see_also = ['checkout']
1293
takes_args = ['from_location', 'to_location?']
1294
takes_options = ['revision',
1295
Option('hardlink', help='Hard-link working tree files where possible.'),
1296
Option('files-from', type=str,
1297
help="Get file contents from this tree."),
1299
help="Create a branch without a working-tree."),
1301
help="Switch the checkout in the current directory "
1302
"to the new branch."),
1304
help='Create a stacked branch referring to the source branch. '
1305
'The new branch will depend on the availability of the source '
1306
'branch for all operations.'),
1307
Option('standalone',
1308
help='Do not use a shared repository, even if available.'),
1309
Option('use-existing-dir',
1310
help='By default branch will fail if the target'
1311
' directory exists, but does not already'
1312
' have a control directory. This flag will'
1313
' allow branch to proceed.'),
1315
help="Bind new branch to from location."),
1317
aliases = ['get', 'clone']
1319
def run(self, from_location, to_location=None, revision=None,
1320
hardlink=False, stacked=False, standalone=False, no_tree=False,
1321
use_existing_dir=False, switch=False, bind=False,
1323
from bzrlib import switch as _mod_switch
1324
from bzrlib.tag import _merge_tags_if_possible
1325
if self.invoked_as in ['get', 'clone']:
1326
ui.ui_factory.show_user_warning(
1327
'deprecated_command',
1328
deprecated_name=self.invoked_as,
1329
recommended_name='branch',
1330
deprecated_in_version='2.4')
1331
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1333
if not (hardlink or files_from):
1334
# accelerator_tree is usually slower because you have to read N
1335
# files (no readahead, lots of seeks, etc), but allow the user to
1336
# explicitly request it
1337
accelerator_tree = None
1338
if files_from is not None and files_from != from_location:
1339
accelerator_tree = WorkingTree.open(files_from)
1340
revision = _get_one_revision('branch', revision)
1341
self.add_cleanup(br_from.lock_read().unlock)
1342
if revision is not None:
1343
revision_id = revision.as_revision_id(br_from)
1345
# FIXME - wt.last_revision, fallback to branch, fall back to
1346
# None or perhaps NULL_REVISION to mean copy nothing
1348
revision_id = br_from.last_revision()
1349
if to_location is None:
1350
to_location = getattr(br_from, "name", None)
1351
if to_location is None:
1352
to_location = urlutils.derive_to_location(from_location)
1353
to_transport = transport.get_transport(to_location)
1355
to_transport.mkdir('.')
1356
except errors.FileExists:
1358
to_dir = controldir.ControlDir.open_from_transport(
1360
except errors.NotBranchError:
1361
if not use_existing_dir:
1362
raise errors.BzrCommandError(gettext('Target directory "%s" '
1363
'already exists.') % to_location)
1368
to_dir.open_branch()
1369
except errors.NotBranchError:
1372
raise errors.AlreadyBranchError(to_location)
1373
except errors.NoSuchFile:
1374
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1380
# preserve whatever source format we have.
1381
to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1382
possible_transports=[to_transport],
1383
accelerator_tree=accelerator_tree,
1384
hardlink=hardlink, stacked=stacked,
1385
force_new_repo=standalone,
1386
create_tree_if_local=not no_tree,
1387
source_branch=br_from)
1388
branch = to_dir.open_branch(
1389
possible_transports=[
1390
br_from.bzrdir.root_transport, to_transport])
1391
except errors.NoSuchRevision:
1392
to_transport.delete_tree('.')
1393
msg = gettext("The branch {0} has no revision {1}.").format(
1394
from_location, revision)
1395
raise errors.BzrCommandError(msg)
1397
branch = br_from.sprout(to_dir, revision_id=revision_id)
1398
_merge_tags_if_possible(br_from, branch)
1399
# If the source branch is stacked, the new branch may
1400
# be stacked whether we asked for that explicitly or not.
1401
# We therefore need a try/except here and not just 'if stacked:'
1403
note(gettext('Created new stacked branch referring to %s.') %
1404
branch.get_stacked_on_url())
1405
except (errors.NotStacked, errors.UnstackableBranchFormat,
1406
errors.UnstackableRepositoryFormat), e:
1407
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1409
# Bind to the parent
1410
parent_branch = Branch.open(from_location)
1411
branch.bind(parent_branch)
1412
note(gettext('New branch bound to %s') % from_location)
1414
# Switch to the new branch
1415
wt, _ = WorkingTree.open_containing('.')
1416
_mod_switch.switch(wt.bzrdir, branch)
1417
note(gettext('Switched to branch: %s'),
1418
urlutils.unescape_for_display(branch.base, 'utf-8'))
1421
class cmd_branches(Command):
1422
__doc__ = """List the branches available at the current location.
1424
This command will print the names of all the branches at the current
1428
takes_args = ['location?']
1430
Option('recursive', short_name='R',
1431
help='Recursively scan for branches rather than '
1432
'just looking in the specified location.')]
1434
def run(self, location=".", recursive=False):
1436
t = transport.get_transport(location)
1437
if not t.listable():
1438
raise errors.BzrCommandError(
1439
"Can't scan this type of location.")
1440
for b in controldir.ControlDir.find_branches(t):
1441
self.outf.write("%s\n" % urlutils.unescape_for_display(
1442
urlutils.relative_url(t.base, b.base),
1443
self.outf.encoding).rstrip("/"))
1445
dir = controldir.ControlDir.open_containing(location)[0]
1447
active_branch = dir.open_branch(name=None)
1448
except errors.NotBranchError:
1449
active_branch = None
1450
branches = dir.get_branches()
1452
for name, branch in branches.iteritems():
1455
active = (active_branch is not None and
1456
active_branch.base == branch.base)
1457
names[name] = active
1458
# Only mention the current branch explicitly if it's not
1459
# one of the colocated branches
1460
if not any(names.values()) and active_branch is not None:
1461
self.outf.write("* %s\n" % gettext("(default)"))
1462
for name in sorted(names.keys()):
1463
active = names[name]
1468
self.outf.write("%s %s\n" % (
1469
prefix, name.encode(self.outf.encoding)))
1472
class cmd_checkout(Command):
1473
__doc__ = """Create a new checkout of an existing branch.
1475
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1476
the branch found in '.'. This is useful if you have removed the working tree
1477
or if it was never created - i.e. if you pushed the branch to its current
1478
location using SFTP.
1480
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1481
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1482
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1483
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1484
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1487
To retrieve the branch as of a particular revision, supply the --revision
1488
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1489
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1493
_see_also = ['checkouts', 'branch']
1494
takes_args = ['branch_location?', 'to_location?']
1495
takes_options = ['revision',
1496
Option('lightweight',
1497
help="Perform a lightweight checkout. Lightweight "
1498
"checkouts depend on access to the branch for "
1499
"every operation. Normal checkouts can perform "
1500
"common operations like diff and status without "
1501
"such access, and also support local commits."
1503
Option('files-from', type=str,
1504
help="Get file contents from this tree."),
1506
help='Hard-link working tree files where possible.'
1511
def run(self, branch_location=None, to_location=None, revision=None,
1512
lightweight=False, files_from=None, hardlink=False):
1513
if branch_location is None:
1514
branch_location = osutils.getcwd()
1515
to_location = branch_location
1516
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1518
if not (hardlink or files_from):
1519
# accelerator_tree is usually slower because you have to read N
1520
# files (no readahead, lots of seeks, etc), but allow the user to
1521
# explicitly request it
1522
accelerator_tree = None
1523
revision = _get_one_revision('checkout', revision)
1524
if files_from is not None and files_from != branch_location:
1525
accelerator_tree = WorkingTree.open(files_from)
1526
if revision is not None:
1527
revision_id = revision.as_revision_id(source)
1530
if to_location is None:
1531
to_location = urlutils.derive_to_location(branch_location)
1532
# if the source and to_location are the same,
1533
# and there is no working tree,
1534
# then reconstitute a branch
1535
if (osutils.abspath(to_location) ==
1536
osutils.abspath(branch_location)):
1538
source.bzrdir.open_workingtree()
1539
except errors.NoWorkingTree:
1540
source.bzrdir.create_workingtree(revision_id)
1542
source.create_checkout(to_location, revision_id, lightweight,
1543
accelerator_tree, hardlink)
1546
class cmd_renames(Command):
1547
__doc__ = """Show list of renamed files.
1549
# TODO: Option to show renames between two historical versions.
1551
# TODO: Only show renames under dir, rather than in the whole branch.
1552
_see_also = ['status']
1553
takes_args = ['dir?']
1556
def run(self, dir=u'.'):
1557
tree = WorkingTree.open_containing(dir)[0]
1558
self.add_cleanup(tree.lock_read().unlock)
1559
new_inv = tree.inventory
1560
old_tree = tree.basis_tree()
1561
self.add_cleanup(old_tree.lock_read().unlock)
1562
old_inv = old_tree.inventory
1564
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1565
for f, paths, c, v, p, n, k, e in iterator:
1566
if paths[0] == paths[1]:
1570
renames.append(paths)
1572
for old_name, new_name in renames:
1573
self.outf.write("%s => %s\n" % (old_name, new_name))
1576
class cmd_update(Command):
1577
__doc__ = """Update a working tree to a new revision.
1579
This will perform a merge of the destination revision (the tip of the
1580
branch, or the specified revision) into the working tree, and then make
1581
that revision the basis revision for the working tree.
1583
You can use this to visit an older revision, or to update a working tree
1584
that is out of date from its branch.
1586
If there are any uncommitted changes in the tree, they will be carried
1587
across and remain as uncommitted changes after the update. To discard
1588
these changes, use 'bzr revert'. The uncommitted changes may conflict
1589
with the changes brought in by the change in basis revision.
1591
If the tree's branch is bound to a master branch, bzr will also update
1592
the branch from the master.
1594
You cannot update just a single file or directory, because each Bazaar
1595
working tree has just a single basis revision. If you want to restore a
1596
file that has been removed locally, use 'bzr revert' instead of 'bzr
1597
update'. If you want to restore a file to its state in a previous
1598
revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
1599
out the old content of that file to a new location.
1601
The 'dir' argument, if given, must be the location of the root of a
1602
working tree to update. By default, the working tree that contains the
1603
current working directory is used.
1606
_see_also = ['pull', 'working-trees', 'status-flags']
1607
takes_args = ['dir?']
1608
takes_options = ['revision',
1610
help="Show base revision text in conflicts."),
1614
def run(self, dir=None, revision=None, show_base=None):
1615
if revision is not None and len(revision) != 1:
1616
raise errors.BzrCommandError(gettext(
1617
"bzr update --revision takes exactly one revision"))
1619
tree = WorkingTree.open_containing('.')[0]
1621
tree, relpath = WorkingTree.open_containing(dir)
1624
raise errors.BzrCommandError(gettext(
1625
"bzr update can only update a whole tree, "
1626
"not a file or subdirectory"))
1627
branch = tree.branch
1628
possible_transports = []
1629
master = branch.get_master_branch(
1630
possible_transports=possible_transports)
1631
if master is not None:
1632
branch_location = master.base
1635
branch_location = tree.branch.base
1636
tree.lock_tree_write()
1637
self.add_cleanup(tree.unlock)
1638
# get rid of the final '/' and be ready for display
1639
branch_location = urlutils.unescape_for_display(
1640
branch_location.rstrip('/'),
1642
existing_pending_merges = tree.get_parent_ids()[1:]
1646
# may need to fetch data into a heavyweight checkout
1647
# XXX: this may take some time, maybe we should display a
1649
old_tip = branch.update(possible_transports)
1650
if revision is not None:
1651
revision_id = revision[0].as_revision_id(branch)
1653
revision_id = branch.last_revision()
1654
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1655
revno = branch.revision_id_to_dotted_revno(revision_id)
1656
note(gettext("Tree is up to date at revision {0} of branch {1}"
1657
).format('.'.join(map(str, revno)), branch_location))
1659
view_info = _get_view_info_for_change_reporter(tree)
1660
change_reporter = delta._ChangeReporter(
1661
unversioned_filter=tree.is_ignored,
1662
view_info=view_info)
1664
conflicts = tree.update(
1666
possible_transports=possible_transports,
1667
revision=revision_id,
1669
show_base=show_base)
1670
except errors.NoSuchRevision, e:
1671
raise errors.BzrCommandError(gettext(
1672
"branch has no revision %s\n"
1673
"bzr update --revision only works"
1674
" for a revision in the branch history")
1676
revno = tree.branch.revision_id_to_dotted_revno(
1677
_mod_revision.ensure_null(tree.last_revision()))
1678
note(gettext('Updated to revision {0} of branch {1}').format(
1679
'.'.join(map(str, revno)), branch_location))
1680
parent_ids = tree.get_parent_ids()
1681
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1682
note(gettext('Your local commits will now show as pending merges with '
1683
"'bzr status', and can be committed with 'bzr commit'."))
1690
class cmd_info(Command):
1691
__doc__ = """Show information about a working tree, branch or repository.
1693
This command will show all known locations and formats associated to the
1694
tree, branch or repository.
1696
In verbose mode, statistical information is included with each report.
1697
To see extended statistic information, use a verbosity level of 2 or
1698
higher by specifying the verbose option multiple times, e.g. -vv.
1700
Branches and working trees will also report any missing revisions.
1704
Display information on the format and related locations:
1708
Display the above together with extended format information and
1709
basic statistics (like the number of files in the working tree and
1710
number of revisions in the branch and repository):
1714
Display the above together with number of committers to the branch:
1718
_see_also = ['revno', 'working-trees', 'repositories']
1719
takes_args = ['location?']
1720
takes_options = ['verbose']
1721
encoding_type = 'replace'
1724
def run(self, location=None, verbose=False):
1726
noise_level = get_verbosity_level()
1729
from bzrlib.info import show_bzrdir_info
1730
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1731
verbose=noise_level, outfile=self.outf)
1734
class cmd_remove(Command):
1735
__doc__ = """Remove files or directories.
1737
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1738
delete them if they can easily be recovered using revert otherwise they
1739
will be backed up (adding an extention of the form .~#~). If no options or
1740
parameters are given Bazaar will scan for files that are being tracked by
1741
Bazaar but missing in your tree and stop tracking them for you.
1743
takes_args = ['file*']
1744
takes_options = ['verbose',
1745
Option('new', help='Only remove files that have never been committed.'),
1746
RegistryOption.from_kwargs('file-deletion-strategy',
1747
'The file deletion mode to be used.',
1748
title='Deletion Strategy', value_switches=True, enum_switch=False,
1749
safe='Backup changed files (default).',
1750
keep='Delete from bzr but leave the working copy.',
1751
no_backup='Don\'t backup changed files.',
1752
force='Delete all the specified files, even if they can not be '
1753
'recovered and even if they are non-empty directories. '
1754
'(deprecated, use no-backup)')]
1755
aliases = ['rm', 'del']
1756
encoding_type = 'replace'
1758
def run(self, file_list, verbose=False, new=False,
1759
file_deletion_strategy='safe'):
1760
if file_deletion_strategy == 'force':
1761
note(gettext("(The --force option is deprecated, rather use --no-backup "
1763
file_deletion_strategy = 'no-backup'
1765
tree, file_list = WorkingTree.open_containing_paths(file_list)
1767
if file_list is not None:
1768
file_list = [f for f in file_list]
1770
self.add_cleanup(tree.lock_write().unlock)
1771
# Heuristics should probably all move into tree.remove_smart or
1774
added = tree.changes_from(tree.basis_tree(),
1775
specific_files=file_list).added
1776
file_list = sorted([f[0] for f in added], reverse=True)
1777
if len(file_list) == 0:
1778
raise errors.BzrCommandError(gettext('No matching files.'))
1779
elif file_list is None:
1780
# missing files show up in iter_changes(basis) as
1781
# versioned-with-no-kind.
1783
for change in tree.iter_changes(tree.basis_tree()):
1784
# Find paths in the working tree that have no kind:
1785
if change[1][1] is not None and change[6][1] is None:
1786
missing.append(change[1][1])
1787
file_list = sorted(missing, reverse=True)
1788
file_deletion_strategy = 'keep'
1789
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1790
keep_files=file_deletion_strategy=='keep',
1791
force=(file_deletion_strategy=='no-backup'))
1794
class cmd_file_id(Command):
1795
__doc__ = """Print file_id of a particular file or directory.
1797
The file_id is assigned when the file is first added and remains the
1798
same through all revisions where the file exists, even when it is
1803
_see_also = ['inventory', 'ls']
1804
takes_args = ['filename']
1807
def run(self, filename):
1808
tree, relpath = WorkingTree.open_containing(filename)
1809
i = tree.path2id(relpath)
1811
raise errors.NotVersionedError(filename)
1813
self.outf.write(i + '\n')
1816
class cmd_file_path(Command):
1817
__doc__ = """Print path of file_ids to a file or directory.
1819
This prints one line for each directory down to the target,
1820
starting at the branch root.
1824
takes_args = ['filename']
1827
def run(self, filename):
1828
tree, relpath = WorkingTree.open_containing(filename)
1829
fid = tree.path2id(relpath)
1831
raise errors.NotVersionedError(filename)
1832
segments = osutils.splitpath(relpath)
1833
for pos in range(1, len(segments) + 1):
1834
path = osutils.joinpath(segments[:pos])
1835
self.outf.write("%s\n" % tree.path2id(path))
1838
class cmd_reconcile(Command):
1839
__doc__ = """Reconcile bzr metadata in a branch.
1841
This can correct data mismatches that may have been caused by
1842
previous ghost operations or bzr upgrades. You should only
1843
need to run this command if 'bzr check' or a bzr developer
1844
advises you to run it.
1846
If a second branch is provided, cross-branch reconciliation is
1847
also attempted, which will check that data like the tree root
1848
id which was not present in very early bzr versions is represented
1849
correctly in both branches.
1851
At the same time it is run it may recompress data resulting in
1852
a potential saving in disk space or performance gain.
1854
The branch *MUST* be on a listable system such as local disk or sftp.
1857
_see_also = ['check']
1858
takes_args = ['branch?']
1860
Option('canonicalize-chks',
1861
help='Make sure CHKs are in canonical form (repairs '
1866
def run(self, branch=".", canonicalize_chks=False):
1867
from bzrlib.reconcile import reconcile
1868
dir = controldir.ControlDir.open(branch)
1869
reconcile(dir, canonicalize_chks=canonicalize_chks)
1872
class cmd_revision_history(Command):
1873
__doc__ = """Display the list of revision ids on a branch."""
1876
takes_args = ['location?']
1881
def run(self, location="."):
1882
branch = Branch.open_containing(location)[0]
1883
self.add_cleanup(branch.lock_read().unlock)
1884
graph = branch.repository.get_graph()
1885
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1886
[_mod_revision.NULL_REVISION]))
1887
for revid in reversed(history):
1888
self.outf.write(revid)
1889
self.outf.write('\n')
1892
class cmd_ancestry(Command):
1893
__doc__ = """List all revisions merged into this branch."""
1895
_see_also = ['log', 'revision-history']
1896
takes_args = ['location?']
1901
def run(self, location="."):
1903
wt = WorkingTree.open_containing(location)[0]
1904
except errors.NoWorkingTree:
1905
b = Branch.open(location)
1906
last_revision = b.last_revision()
1909
last_revision = wt.last_revision()
1911
self.add_cleanup(b.repository.lock_read().unlock)
1912
graph = b.repository.get_graph()
1913
revisions = [revid for revid, parents in
1914
graph.iter_ancestry([last_revision])]
1915
for revision_id in reversed(revisions):
1916
if _mod_revision.is_null(revision_id):
1918
self.outf.write(revision_id + '\n')
1921
class cmd_init(Command):
1922
__doc__ = """Make a directory into a versioned branch.
1924
Use this to create an empty branch, or before importing an
1927
If there is a repository in a parent directory of the location, then
1928
the history of the branch will be stored in the repository. Otherwise
1929
init creates a standalone branch which carries its own history
1930
in the .bzr directory.
1932
If there is already a branch at the location but it has no working tree,
1933
the tree can be populated with 'bzr checkout'.
1935
Recipe for importing a tree of files::
1941
bzr commit -m "imported project"
1944
_see_also = ['init-repository', 'branch', 'checkout']
1945
takes_args = ['location?']
1947
Option('create-prefix',
1948
help='Create the path leading up to the branch '
1949
'if it does not already exist.'),
1950
RegistryOption('format',
1951
help='Specify a format for this branch. '
1952
'See "help formats".',
1953
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1954
converter=lambda name: controldir.format_registry.make_bzrdir(name),
1955
value_switches=True,
1956
title="Branch format",
1958
Option('append-revisions-only',
1959
help='Never change revnos or the existing log.'
1960
' Append revisions to it only.'),
1962
'Create a branch without a working tree.')
1964
def run(self, location=None, format=None, append_revisions_only=False,
1965
create_prefix=False, no_tree=False):
1967
format = controldir.format_registry.make_bzrdir('default')
1968
if location is None:
1971
to_transport = transport.get_transport(location)
1973
# The path has to exist to initialize a
1974
# branch inside of it.
1975
# Just using os.mkdir, since I don't
1976
# believe that we want to create a bunch of
1977
# locations if the user supplies an extended path
1979
to_transport.ensure_base()
1980
except errors.NoSuchFile:
1981
if not create_prefix:
1982
raise errors.BzrCommandError(gettext("Parent directory of %s"
1984
"\nYou may supply --create-prefix to create all"
1985
" leading parent directories.")
1987
to_transport.create_prefix()
1990
a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
1991
except errors.NotBranchError:
1992
# really a NotBzrDir error...
1993
create_branch = controldir.ControlDir.create_branch_convenience
1995
force_new_tree = False
1997
force_new_tree = None
1998
branch = create_branch(to_transport.base, format=format,
1999
possible_transports=[to_transport],
2000
force_new_tree=force_new_tree)
2001
a_bzrdir = branch.bzrdir
2003
from bzrlib.transport.local import LocalTransport
2004
if a_bzrdir.has_branch():
2005
if (isinstance(to_transport, LocalTransport)
2006
and not a_bzrdir.has_workingtree()):
2007
raise errors.BranchExistsWithoutWorkingTree(location)
2008
raise errors.AlreadyBranchError(location)
2009
branch = a_bzrdir.create_branch()
2010
if not no_tree and not a_bzrdir.has_workingtree():
2011
a_bzrdir.create_workingtree()
2012
if append_revisions_only:
2014
branch.set_append_revisions_only(True)
2015
except errors.UpgradeRequired:
2016
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2017
' to append-revisions-only. Try --default.'))
2019
from bzrlib.info import describe_layout, describe_format
2021
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
2022
except (errors.NoWorkingTree, errors.NotLocalUrl):
2024
repository = branch.repository
2025
layout = describe_layout(repository, branch, tree).lower()
2026
format = describe_format(a_bzrdir, repository, branch, tree)
2027
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2029
if repository.is_shared():
2030
#XXX: maybe this can be refactored into transport.path_or_url()
2031
url = repository.bzrdir.root_transport.external_url()
2033
url = urlutils.local_path_from_url(url)
2034
except errors.InvalidURL:
2036
self.outf.write(gettext("Using shared repository: %s\n") % url)
2039
class cmd_init_repository(Command):
2040
__doc__ = """Create a shared repository for branches to share storage space.
2042
New branches created under the repository directory will store their
2043
revisions in the repository, not in the branch directory. For branches
2044
with shared history, this reduces the amount of storage needed and
2045
speeds up the creation of new branches.
2047
If the --no-trees option is given then the branches in the repository
2048
will not have working trees by default. They will still exist as
2049
directories on disk, but they will not have separate copies of the
2050
files at a certain revision. This can be useful for repositories that
2051
store branches which are interacted with through checkouts or remote
2052
branches, such as on a server.
2055
Create a shared repository holding just branches::
2057
bzr init-repo --no-trees repo
2060
Make a lightweight checkout elsewhere::
2062
bzr checkout --lightweight repo/trunk trunk-checkout
2067
_see_also = ['init', 'branch', 'checkout', 'repositories']
2068
takes_args = ["location"]
2069
takes_options = [RegistryOption('format',
2070
help='Specify a format for this repository. See'
2071
' "bzr help formats" for details.',
2072
lazy_registry=('bzrlib.controldir', 'format_registry'),
2073
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2074
value_switches=True, title='Repository format'),
2076
help='Branches in the repository will default to'
2077
' not having a working tree.'),
2079
aliases = ["init-repo"]
2081
def run(self, location, format=None, no_trees=False):
2083
format = controldir.format_registry.make_bzrdir('default')
2085
if location is None:
2088
to_transport = transport.get_transport(location)
2090
(repo, newdir, require_stacking, repository_policy) = (
2091
format.initialize_on_transport_ex(to_transport,
2092
create_prefix=True, make_working_trees=not no_trees,
2093
shared_repo=True, force_new_repo=True,
2094
use_existing_dir=True,
2095
repo_format_name=format.repository_format.get_format_string()))
2097
from bzrlib.info import show_bzrdir_info
2098
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2101
class cmd_diff(Command):
2102
__doc__ = """Show differences in the working tree, between revisions or branches.
2104
If no arguments are given, all changes for the current tree are listed.
2105
If files are given, only the changes in those files are listed.
2106
Remote and multiple branches can be compared by using the --old and
2107
--new options. If not provided, the default for both is derived from
2108
the first argument, if any, or the current tree if no arguments are
2111
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
2112
produces patches suitable for "patch -p1".
2114
Note that when using the -r argument with a range of revisions, the
2115
differences are computed between the two specified revisions. That
2116
is, the command does not show the changes introduced by the first
2117
revision in the range. This differs from the interpretation of
2118
revision ranges used by "bzr log" which includes the first revision
2123
2 - unrepresentable changes
2128
Shows the difference in the working tree versus the last commit::
2132
Difference between the working tree and revision 1::
2136
Difference between revision 3 and revision 1::
2140
Difference between revision 3 and revision 1 for branch xxx::
2144
The changes introduced by revision 2 (equivalent to -r1..2)::
2148
To see the changes introduced by revision X::
2152
Note that in the case of a merge, the -c option shows the changes
2153
compared to the left hand parent. To see the changes against
2154
another parent, use::
2156
bzr diff -r<chosen_parent>..X
2158
The changes between the current revision and the previous revision
2159
(equivalent to -c-1 and -r-2..-1)
2163
Show just the differences for file NEWS::
2167
Show the differences in working tree xxx for file NEWS::
2171
Show the differences from branch xxx to this working tree:
2175
Show the differences between two branches for file NEWS::
2177
bzr diff --old xxx --new yyy NEWS
2179
Same as 'bzr diff' but prefix paths with old/ and new/::
2181
bzr diff --prefix old/:new/
2183
Show the differences using a custom diff program with options::
2185
bzr diff --using /usr/bin/diff --diff-options -wu
2187
_see_also = ['status']
2188
takes_args = ['file*']
2190
Option('diff-options', type=str,
2191
help='Pass these options to the external diff program.'),
2192
Option('prefix', type=str,
2194
help='Set prefixes added to old and new filenames, as '
2195
'two values separated by a colon. (eg "old/:new/").'),
2197
help='Branch/tree to compare from.',
2201
help='Branch/tree to compare to.',
2207
help='Use this command to compare files.',
2210
RegistryOption('format',
2212
help='Diff format to use.',
2213
lazy_registry=('bzrlib.diff', 'format_registry'),
2214
title='Diff format'),
2216
aliases = ['di', 'dif']
2217
encoding_type = 'exact'
2220
def run(self, revision=None, file_list=None, diff_options=None,
2221
prefix=None, old=None, new=None, using=None, format=None):
2222
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2225
if (prefix is None) or (prefix == '0'):
2233
old_label, new_label = prefix.split(":")
2235
raise errors.BzrCommandError(gettext(
2236
'--prefix expects two values separated by a colon'
2237
' (eg "old/:new/")'))
2239
if revision and len(revision) > 2:
2240
raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
2241
' one or two revision specifiers'))
2243
if using is not None and format is not None:
2244
raise errors.BzrCommandError(gettext(
2245
'{0} and {1} are mutually exclusive').format(
2246
'--using', '--format'))
2248
(old_tree, new_tree,
2249
old_branch, new_branch,
2250
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2251
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2252
# GNU diff on Windows uses ANSI encoding for filenames
2253
path_encoding = osutils.get_diff_header_encoding()
2254
return show_diff_trees(old_tree, new_tree, sys.stdout,
2255
specific_files=specific_files,
2256
external_diff_options=diff_options,
2257
old_label=old_label, new_label=new_label,
2258
extra_trees=extra_trees,
2259
path_encoding=path_encoding,
2264
class cmd_deleted(Command):
2265
__doc__ = """List files deleted in the working tree.
2267
# TODO: Show files deleted since a previous revision, or
2268
# between two revisions.
2269
# TODO: Much more efficient way to do this: read in new
2270
# directories with readdir, rather than stating each one. Same
2271
# level of effort but possibly much less IO. (Or possibly not,
2272
# if the directories are very large...)
2273
_see_also = ['status', 'ls']
2274
takes_options = ['directory', 'show-ids']
2277
def run(self, show_ids=False, directory=u'.'):
2278
tree = WorkingTree.open_containing(directory)[0]
2279
self.add_cleanup(tree.lock_read().unlock)
2280
old = tree.basis_tree()
2281
self.add_cleanup(old.lock_read().unlock)
2282
for path, ie in old.inventory.iter_entries():
2283
if not tree.has_id(ie.file_id):
2284
self.outf.write(path)
2286
self.outf.write(' ')
2287
self.outf.write(ie.file_id)
2288
self.outf.write('\n')
2291
class cmd_modified(Command):
2292
__doc__ = """List files modified in working tree.
2296
_see_also = ['status', 'ls']
2297
takes_options = ['directory', 'null']
2300
def run(self, null=False, directory=u'.'):
2301
tree = WorkingTree.open_containing(directory)[0]
2302
self.add_cleanup(tree.lock_read().unlock)
2303
td = tree.changes_from(tree.basis_tree())
2305
for path, id, kind, text_modified, meta_modified in td.modified:
2307
self.outf.write(path + '\0')
2309
self.outf.write(osutils.quotefn(path) + '\n')
2312
class cmd_added(Command):
2313
__doc__ = """List files added in working tree.
2317
_see_also = ['status', 'ls']
2318
takes_options = ['directory', 'null']
2321
def run(self, null=False, directory=u'.'):
2322
wt = WorkingTree.open_containing(directory)[0]
2323
self.add_cleanup(wt.lock_read().unlock)
2324
basis = wt.basis_tree()
2325
self.add_cleanup(basis.lock_read().unlock)
2326
basis_inv = basis.inventory
2329
if basis_inv.has_id(file_id):
2331
if inv.is_root(file_id) and len(basis_inv) == 0:
2333
path = inv.id2path(file_id)
2334
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2337
self.outf.write(path + '\0')
2339
self.outf.write(osutils.quotefn(path) + '\n')
2342
class cmd_root(Command):
2343
__doc__ = """Show the tree root directory.
2345
The root is the nearest enclosing directory with a .bzr control
2348
takes_args = ['filename?']
2350
def run(self, filename=None):
2351
"""Print the branch root."""
2352
tree = WorkingTree.open_containing(filename)[0]
2353
self.outf.write(tree.basedir + '\n')
2356
def _parse_limit(limitstring):
2358
return int(limitstring)
2360
msg = gettext("The limit argument must be an integer.")
2361
raise errors.BzrCommandError(msg)
2364
def _parse_levels(s):
2368
msg = gettext("The levels argument must be an integer.")
2369
raise errors.BzrCommandError(msg)
2372
class cmd_log(Command):
2373
__doc__ = """Show historical log for a branch or subset of a branch.
2375
log is bzr's default tool for exploring the history of a branch.
2376
The branch to use is taken from the first parameter. If no parameters
2377
are given, the branch containing the working directory is logged.
2378
Here are some simple examples::
2380
bzr log log the current branch
2381
bzr log foo.py log a file in its branch
2382
bzr log http://server/branch log a branch on a server
2384
The filtering, ordering and information shown for each revision can
2385
be controlled as explained below. By default, all revisions are
2386
shown sorted (topologically) so that newer revisions appear before
2387
older ones and descendants always appear before ancestors. If displayed,
2388
merged revisions are shown indented under the revision in which they
2393
The log format controls how information about each revision is
2394
displayed. The standard log formats are called ``long``, ``short``
2395
and ``line``. The default is long. See ``bzr help log-formats``
2396
for more details on log formats.
2398
The following options can be used to control what information is
2401
-l N display a maximum of N revisions
2402
-n N display N levels of revisions (0 for all, 1 for collapsed)
2403
-v display a status summary (delta) for each revision
2404
-p display a diff (patch) for each revision
2405
--show-ids display revision-ids (and file-ids), not just revnos
2407
Note that the default number of levels to display is a function of the
2408
log format. If the -n option is not used, the standard log formats show
2409
just the top level (mainline).
2411
Status summaries are shown using status flags like A, M, etc. To see
2412
the changes explained using words like ``added`` and ``modified``
2413
instead, use the -vv option.
2417
To display revisions from oldest to newest, use the --forward option.
2418
In most cases, using this option will have little impact on the total
2419
time taken to produce a log, though --forward does not incrementally
2420
display revisions like --reverse does when it can.
2422
:Revision filtering:
2424
The -r option can be used to specify what revision or range of revisions
2425
to filter against. The various forms are shown below::
2427
-rX display revision X
2428
-rX.. display revision X and later
2429
-r..Y display up to and including revision Y
2430
-rX..Y display from X to Y inclusive
2432
See ``bzr help revisionspec`` for details on how to specify X and Y.
2433
Some common examples are given below::
2435
-r-1 show just the tip
2436
-r-10.. show the last 10 mainline revisions
2437
-rsubmit:.. show what's new on this branch
2438
-rancestor:path.. show changes since the common ancestor of this
2439
branch and the one at location path
2440
-rdate:yesterday.. show changes since yesterday
2442
When logging a range of revisions using -rX..Y, log starts at
2443
revision Y and searches back in history through the primary
2444
("left-hand") parents until it finds X. When logging just the
2445
top level (using -n1), an error is reported if X is not found
2446
along the way. If multi-level logging is used (-n0), X may be
2447
a nested merge revision and the log will be truncated accordingly.
2451
If parameters are given and the first one is not a branch, the log
2452
will be filtered to show only those revisions that changed the
2453
nominated files or directories.
2455
Filenames are interpreted within their historical context. To log a
2456
deleted file, specify a revision range so that the file existed at
2457
the end or start of the range.
2459
Historical context is also important when interpreting pathnames of
2460
renamed files/directories. Consider the following example:
2462
* revision 1: add tutorial.txt
2463
* revision 2: modify tutorial.txt
2464
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2468
* ``bzr log guide.txt`` will log the file added in revision 1
2470
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2472
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2473
the original file in revision 2.
2475
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2476
was no file called guide.txt in revision 2.
2478
Renames are always followed by log. By design, there is no need to
2479
explicitly ask for this (and no way to stop logging a file back
2480
until it was last renamed).
2484
The --match option can be used for finding revisions that match a
2485
regular expression in a commit message, committer, author or bug.
2486
Specifying the option several times will match any of the supplied
2487
expressions. --match-author, --match-bugs, --match-committer and
2488
--match-message can be used to only match a specific field.
2492
GUI tools and IDEs are often better at exploring history than command
2493
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2494
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2495
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2496
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2498
You may find it useful to add the aliases below to ``bazaar.conf``::
2502
top = log -l10 --line
2505
``bzr tip`` will then show the latest revision while ``bzr top``
2506
will show the last 10 mainline revisions. To see the details of a
2507
particular revision X, ``bzr show -rX``.
2509
If you are interested in looking deeper into a particular merge X,
2510
use ``bzr log -n0 -rX``.
2512
``bzr log -v`` on a branch with lots of history is currently
2513
very slow. A fix for this issue is currently under development.
2514
With or without that fix, it is recommended that a revision range
2515
be given when using the -v option.
2517
bzr has a generic full-text matching plugin, bzr-search, that can be
2518
used to find revisions matching user names, commit messages, etc.
2519
Among other features, this plugin can find all revisions containing
2520
a list of words but not others.
2522
When exploring non-mainline history on large projects with deep
2523
history, the performance of log can be greatly improved by installing
2524
the historycache plugin. This plugin buffers historical information
2525
trading disk space for faster speed.
2527
takes_args = ['file*']
2528
_see_also = ['log-formats', 'revisionspec']
2531
help='Show from oldest to newest.'),
2533
custom_help('verbose',
2534
help='Show files changed in each revision.'),
2538
type=bzrlib.option._parse_revision_str,
2540
help='Show just the specified revision.'
2541
' See also "help revisionspec".'),
2543
RegistryOption('authors',
2544
'What names to list as authors - first, all or committer.',
2546
lazy_registry=('bzrlib.log', 'author_list_registry'),
2550
help='Number of levels to display - 0 for all, 1 for flat.',
2552
type=_parse_levels),
2554
help='Show revisions whose message matches this '
2555
'regular expression.',
2560
help='Limit the output to the first N revisions.',
2565
help='Show changes made in each revision as a patch.'),
2566
Option('include-merged',
2567
help='Show merged revisions like --levels 0 does.'),
2568
Option('include-merges', hidden=True,
2569
help='Historical alias for --include-merged.'),
2570
Option('omit-merges',
2571
help='Do not report commits with more than one parent.'),
2572
Option('exclude-common-ancestry',
2573
help='Display only the revisions that are not part'
2574
' of both ancestries (require -rX..Y).'
2576
Option('signatures',
2577
help='Show digital signature validity.'),
2580
help='Show revisions whose properties match this '
2583
ListOption('match-message',
2584
help='Show revisions whose message matches this '
2587
ListOption('match-committer',
2588
help='Show revisions whose committer matches this '
2591
ListOption('match-author',
2592
help='Show revisions whose authors match this '
2595
ListOption('match-bugs',
2596
help='Show revisions whose bugs match this '
2600
encoding_type = 'replace'
2603
def run(self, file_list=None, timezone='original',
2614
include_merged=None,
2616
exclude_common_ancestry=False,
2620
match_committer=None,
2624
include_merges=symbol_versioning.DEPRECATED_PARAMETER,
2626
from bzrlib.log import (
2628
make_log_request_dict,
2629
_get_info_for_log_files,
2631
direction = (forward and 'forward') or 'reverse'
2632
if symbol_versioning.deprecated_passed(include_merges):
2633
ui.ui_factory.show_user_warning(
2634
'deprecated_command_option',
2635
deprecated_name='--include-merges',
2636
recommended_name='--include-merged',
2637
deprecated_in_version='2.5',
2638
command=self.invoked_as)
2639
if include_merged is None:
2640
include_merged = include_merges
2642
raise errors.BzrCommandError(gettext(
2643
'{0} and {1} are mutually exclusive').format(
2644
'--include-merges', '--include-merged'))
2645
if include_merged is None:
2646
include_merged = False
2647
if (exclude_common_ancestry
2648
and (revision is None or len(revision) != 2)):
2649
raise errors.BzrCommandError(gettext(
2650
'--exclude-common-ancestry requires -r with two revisions'))
2655
raise errors.BzrCommandError(gettext(
2656
'{0} and {1} are mutually exclusive').format(
2657
'--levels', '--include-merged'))
2659
if change is not None:
2661
raise errors.RangeInChangeOption()
2662
if revision is not None:
2663
raise errors.BzrCommandError(gettext(
2664
'{0} and {1} are mutually exclusive').format(
2665
'--revision', '--change'))
2670
filter_by_dir = False
2672
# find the file ids to log and check for directory filtering
2673
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2674
revision, file_list, self.add_cleanup)
2675
for relpath, file_id, kind in file_info_list:
2677
raise errors.BzrCommandError(gettext(
2678
"Path unknown at end or start of revision range: %s") %
2680
# If the relpath is the top of the tree, we log everything
2685
file_ids.append(file_id)
2686
filter_by_dir = filter_by_dir or (
2687
kind in ['directory', 'tree-reference'])
2690
# FIXME ? log the current subdir only RBC 20060203
2691
if revision is not None \
2692
and len(revision) > 0 and revision[0].get_branch():
2693
location = revision[0].get_branch()
2696
dir, relpath = controldir.ControlDir.open_containing(location)
2697
b = dir.open_branch()
2698
self.add_cleanup(b.lock_read().unlock)
2699
rev1, rev2 = _get_revision_range(revision, b, self.name())
2701
if b.get_config().validate_signatures_in_log():
2705
if not gpg.GPGStrategy.verify_signatures_available():
2706
raise errors.GpgmeNotInstalled(None)
2708
# Decide on the type of delta & diff filtering to use
2709
# TODO: add an --all-files option to make this configurable & consistent
2717
diff_type = 'partial'
2721
# Build the log formatter
2722
if log_format is None:
2723
log_format = log.log_formatter_registry.get_default(b)
2724
# Make a non-encoding output to include the diffs - bug 328007
2725
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2726
lf = log_format(show_ids=show_ids, to_file=self.outf,
2727
to_exact_file=unencoded_output,
2728
show_timezone=timezone,
2729
delta_format=get_verbosity_level(),
2731
show_advice=levels is None,
2732
author_list_handler=authors)
2734
# Choose the algorithm for doing the logging. It's annoying
2735
# having multiple code paths like this but necessary until
2736
# the underlying repository format is faster at generating
2737
# deltas or can provide everything we need from the indices.
2738
# The default algorithm - match-using-deltas - works for
2739
# multiple files and directories and is faster for small
2740
# amounts of history (200 revisions say). However, it's too
2741
# slow for logging a single file in a repository with deep
2742
# history, i.e. > 10K revisions. In the spirit of "do no
2743
# evil when adding features", we continue to use the
2744
# original algorithm - per-file-graph - for the "single
2745
# file that isn't a directory without showing a delta" case.
2746
partial_history = revision and b.repository._format.supports_chks
2747
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2748
or delta_type or partial_history)
2752
match_dict[''] = match
2754
match_dict['message'] = match_message
2756
match_dict['committer'] = match_committer
2758
match_dict['author'] = match_author
2760
match_dict['bugs'] = match_bugs
2762
# Build the LogRequest and execute it
2763
if len(file_ids) == 0:
2765
rqst = make_log_request_dict(
2766
direction=direction, specific_fileids=file_ids,
2767
start_revision=rev1, end_revision=rev2, limit=limit,
2768
message_search=message, delta_type=delta_type,
2769
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2770
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2771
signature=signatures, omit_merges=omit_merges,
2773
Logger(b, rqst).show(lf)
2776
def _get_revision_range(revisionspec_list, branch, command_name):
2777
"""Take the input of a revision option and turn it into a revision range.
2779
It returns RevisionInfo objects which can be used to obtain the rev_id's
2780
of the desired revisions. It does some user input validations.
2782
if revisionspec_list is None:
2785
elif len(revisionspec_list) == 1:
2786
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2787
elif len(revisionspec_list) == 2:
2788
start_spec = revisionspec_list[0]
2789
end_spec = revisionspec_list[1]
2790
if end_spec.get_branch() != start_spec.get_branch():
2791
# b is taken from revision[0].get_branch(), and
2792
# show_log will use its revision_history. Having
2793
# different branches will lead to weird behaviors.
2794
raise errors.BzrCommandError(gettext(
2795
"bzr %s doesn't accept two revisions in different"
2796
" branches.") % command_name)
2797
if start_spec.spec is None:
2798
# Avoid loading all the history.
2799
rev1 = RevisionInfo(branch, None, None)
2801
rev1 = start_spec.in_history(branch)
2802
# Avoid loading all of history when we know a missing
2803
# end of range means the last revision ...
2804
if end_spec.spec is None:
2805
last_revno, last_revision_id = branch.last_revision_info()
2806
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2808
rev2 = end_spec.in_history(branch)
2810
raise errors.BzrCommandError(gettext(
2811
'bzr %s --revision takes one or two values.') % command_name)
2815
def _revision_range_to_revid_range(revision_range):
2818
if revision_range[0] is not None:
2819
rev_id1 = revision_range[0].rev_id
2820
if revision_range[1] is not None:
2821
rev_id2 = revision_range[1].rev_id
2822
return rev_id1, rev_id2
2824
def get_log_format(long=False, short=False, line=False, default='long'):
2825
log_format = default
2829
log_format = 'short'
2835
class cmd_touching_revisions(Command):
2836
__doc__ = """Return revision-ids which affected a particular file.
2838
A more user-friendly interface is "bzr log FILE".
2842
takes_args = ["filename"]
2845
def run(self, filename):
2846
tree, relpath = WorkingTree.open_containing(filename)
2847
file_id = tree.path2id(relpath)
2849
self.add_cleanup(b.lock_read().unlock)
2850
touching_revs = log.find_touching_revisions(b, file_id)
2851
for revno, revision_id, what in touching_revs:
2852
self.outf.write("%6d %s\n" % (revno, what))
2855
class cmd_ls(Command):
2856
__doc__ = """List files in a tree.
2859
_see_also = ['status', 'cat']
2860
takes_args = ['path?']
2864
Option('recursive', short_name='R',
2865
help='Recurse into subdirectories.'),
2867
help='Print paths relative to the root of the branch.'),
2868
Option('unknown', short_name='u',
2869
help='Print unknown files.'),
2870
Option('versioned', help='Print versioned files.',
2872
Option('ignored', short_name='i',
2873
help='Print ignored files.'),
2874
Option('kind', short_name='k',
2875
help='List entries of a particular kind: file, directory, symlink.',
2882
def run(self, revision=None, verbose=False,
2883
recursive=False, from_root=False,
2884
unknown=False, versioned=False, ignored=False,
2885
null=False, kind=None, show_ids=False, path=None, directory=None):
2887
if kind and kind not in ('file', 'directory', 'symlink'):
2888
raise errors.BzrCommandError(gettext('invalid kind specified'))
2890
if verbose and null:
2891
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
2892
all = not (unknown or versioned or ignored)
2894
selection = {'I':ignored, '?':unknown, 'V':versioned}
2900
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
2903
tree, branch, relpath = \
2904
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2906
# Calculate the prefix to use
2910
prefix = relpath + '/'
2911
elif fs_path != '.' and not fs_path.endswith('/'):
2912
prefix = fs_path + '/'
2914
if revision is not None or tree is None:
2915
tree = _get_one_revision_tree('ls', revision, branch=branch)
2918
if isinstance(tree, WorkingTree) and tree.supports_views():
2919
view_files = tree.views.lookup_view()
2922
view_str = views.view_display_str(view_files)
2923
note(gettext("Ignoring files outside view. View is %s") % view_str)
2925
self.add_cleanup(tree.lock_read().unlock)
2926
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2927
from_dir=relpath, recursive=recursive):
2928
# Apply additional masking
2929
if not all and not selection[fc]:
2931
if kind is not None and fkind != kind:
2936
fullpath = osutils.pathjoin(relpath, fp)
2939
views.check_path_in_view(tree, fullpath)
2940
except errors.FileOutsideView:
2945
fp = osutils.pathjoin(prefix, fp)
2946
kindch = entry.kind_character()
2947
outstring = fp + kindch
2948
ui.ui_factory.clear_term()
2950
outstring = '%-8s %s' % (fc, outstring)
2951
if show_ids and fid is not None:
2952
outstring = "%-50s %s" % (outstring, fid)
2953
self.outf.write(outstring + '\n')
2955
self.outf.write(fp + '\0')
2958
self.outf.write(fid)
2959
self.outf.write('\0')
2967
self.outf.write('%-50s %s\n' % (outstring, my_id))
2969
self.outf.write(outstring + '\n')
2972
class cmd_unknowns(Command):
2973
__doc__ = """List unknown files.
2978
takes_options = ['directory']
2981
def run(self, directory=u'.'):
2982
for f in WorkingTree.open_containing(directory)[0].unknowns():
2983
self.outf.write(osutils.quotefn(f) + '\n')
2986
class cmd_ignore(Command):
2987
__doc__ = """Ignore specified files or patterns.
2989
See ``bzr help patterns`` for details on the syntax of patterns.
2991
If a .bzrignore file does not exist, the ignore command
2992
will create one and add the specified files or patterns to the newly
2993
created file. The ignore command will also automatically add the
2994
.bzrignore file to be versioned. Creating a .bzrignore file without
2995
the use of the ignore command will require an explicit add command.
2997
To remove patterns from the ignore list, edit the .bzrignore file.
2998
After adding, editing or deleting that file either indirectly by
2999
using this command or directly by using an editor, be sure to commit
3002
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3003
the global ignore file can be found in the application data directory as
3004
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3005
Global ignores are not touched by this command. The global ignore file
3006
can be edited directly using an editor.
3008
Patterns prefixed with '!' are exceptions to ignore patterns and take
3009
precedence over regular ignores. Such exceptions are used to specify
3010
files that should be versioned which would otherwise be ignored.
3012
Patterns prefixed with '!!' act as regular ignore patterns, but have
3013
precedence over the '!' exception patterns.
3017
* Ignore patterns containing shell wildcards must be quoted from
3020
* Ignore patterns starting with "#" act as comments in the ignore file.
3021
To ignore patterns that begin with that character, use the "RE:" prefix.
3024
Ignore the top level Makefile::
3026
bzr ignore ./Makefile
3028
Ignore .class files in all directories...::
3030
bzr ignore "*.class"
3032
...but do not ignore "special.class"::
3034
bzr ignore "!special.class"
3036
Ignore files whose name begins with the "#" character::
3040
Ignore .o files under the lib directory::
3042
bzr ignore "lib/**/*.o"
3044
Ignore .o files under the lib directory::
3046
bzr ignore "RE:lib/.*\.o"
3048
Ignore everything but the "debian" toplevel directory::
3050
bzr ignore "RE:(?!debian/).*"
3052
Ignore everything except the "local" toplevel directory,
3053
but always ignore autosave files ending in ~, even under local/::
3056
bzr ignore "!./local"
3060
_see_also = ['status', 'ignored', 'patterns']
3061
takes_args = ['name_pattern*']
3062
takes_options = ['directory',
3063
Option('default-rules',
3064
help='Display the default ignore rules that bzr uses.')
3067
def run(self, name_pattern_list=None, default_rules=None,
3069
from bzrlib import ignores
3070
if default_rules is not None:
3071
# dump the default rules and exit
3072
for pattern in ignores.USER_DEFAULTS:
3073
self.outf.write("%s\n" % pattern)
3075
if not name_pattern_list:
3076
raise errors.BzrCommandError(gettext("ignore requires at least one "
3077
"NAME_PATTERN or --default-rules."))
3078
name_pattern_list = [globbing.normalize_pattern(p)
3079
for p in name_pattern_list]
3081
bad_patterns_count = 0
3082
for p in name_pattern_list:
3083
if not globbing.Globster.is_pattern_valid(p):
3084
bad_patterns_count += 1
3085
bad_patterns += ('\n %s' % p)
3087
msg = (ngettext('Invalid ignore pattern found. %s',
3088
'Invalid ignore patterns found. %s',
3089
bad_patterns_count) % bad_patterns)
3090
ui.ui_factory.show_error(msg)
3091
raise errors.InvalidPattern('')
3092
for name_pattern in name_pattern_list:
3093
if (name_pattern[0] == '/' or
3094
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3095
raise errors.BzrCommandError(gettext(
3096
"NAME_PATTERN should not be an absolute path"))
3097
tree, relpath = WorkingTree.open_containing(directory)
3098
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3099
ignored = globbing.Globster(name_pattern_list)
3101
self.add_cleanup(tree.lock_read().unlock)
3102
for entry in tree.list_files():
3106
if ignored.match(filename):
3107
matches.append(filename)
3108
if len(matches) > 0:
3109
self.outf.write(gettext("Warning: the following files are version "
3110
"controlled and match your ignore pattern:\n%s"
3111
"\nThese files will continue to be version controlled"
3112
" unless you 'bzr remove' them.\n") % ("\n".join(matches),))
3115
class cmd_ignored(Command):
3116
__doc__ = """List ignored files and the patterns that matched them.
3118
List all the ignored files and the ignore pattern that caused the file to
3121
Alternatively, to list just the files::
3126
encoding_type = 'replace'
3127
_see_also = ['ignore', 'ls']
3128
takes_options = ['directory']
3131
def run(self, directory=u'.'):
3132
tree = WorkingTree.open_containing(directory)[0]
3133
self.add_cleanup(tree.lock_read().unlock)
3134
for path, file_class, kind, file_id, entry in tree.list_files():
3135
if file_class != 'I':
3137
## XXX: Slightly inefficient since this was already calculated
3138
pat = tree.is_ignored(path)
3139
self.outf.write('%-50s %s\n' % (path, pat))
3142
class cmd_lookup_revision(Command):
3143
__doc__ = """Lookup the revision-id from a revision-number
3146
bzr lookup-revision 33
3149
takes_args = ['revno']
3150
takes_options = ['directory']
3153
def run(self, revno, directory=u'.'):
3157
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3159
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3160
self.outf.write("%s\n" % revid)
3163
class cmd_export(Command):
3164
__doc__ = """Export current or past revision to a destination directory or archive.
3166
If no revision is specified this exports the last committed revision.
3168
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3169
given, try to find the format with the extension. If no extension
3170
is found exports to a directory (equivalent to --format=dir).
3172
If root is supplied, it will be used as the root directory inside
3173
container formats (tar, zip, etc). If it is not supplied it will default
3174
to the exported filename. The root option has no effect for 'dir' format.
3176
If branch is omitted then the branch containing the current working
3177
directory will be used.
3179
Note: Export of tree with non-ASCII filenames to zip is not supported.
3181
================= =========================
3182
Supported formats Autodetected by extension
3183
================= =========================
3186
tbz2 .tar.bz2, .tbz2
3189
================= =========================
3192
takes_args = ['dest', 'branch_or_subdir?']
3193
takes_options = ['directory',
3195
help="Type of file to export to.",
3198
Option('filters', help='Apply content filters to export the '
3199
'convenient form.'),
3202
help="Name of the root directory inside the exported file."),
3203
Option('per-file-timestamps',
3204
help='Set modification time of files to that of the last '
3205
'revision in which it was changed.'),
3206
Option('uncommitted',
3207
help='Export the working tree contents rather than that of the '
3210
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3211
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3213
from bzrlib.export import export
3215
if branch_or_subdir is None:
3216
branch_or_subdir = directory
3218
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3220
if tree is not None:
3221
self.add_cleanup(tree.lock_read().unlock)
3225
raise errors.BzrCommandError(
3226
gettext("--uncommitted requires a working tree"))
3229
export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3231
export(export_tree, dest, format, root, subdir, filtered=filters,
3232
per_file_timestamps=per_file_timestamps)
3233
except errors.NoSuchExportFormat, e:
3234
raise errors.BzrCommandError(
3235
gettext('Unsupported export format: %s') % e.format)
3238
class cmd_cat(Command):
3239
__doc__ = """Write the contents of a file as of a given revision to standard output.
3241
If no revision is nominated, the last revision is used.
3243
Note: Take care to redirect standard output when using this command on a
3248
takes_options = ['directory',
3249
Option('name-from-revision', help='The path name in the old tree.'),
3250
Option('filters', help='Apply content filters to display the '
3251
'convenience form.'),
3254
takes_args = ['filename']
3255
encoding_type = 'exact'
3258
def run(self, filename, revision=None, name_from_revision=False,
3259
filters=False, directory=None):
3260
if revision is not None and len(revision) != 1:
3261
raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
3262
" one revision specifier"))
3263
tree, branch, relpath = \
3264
_open_directory_or_containing_tree_or_branch(filename, directory)
3265
self.add_cleanup(branch.lock_read().unlock)
3266
return self._run(tree, branch, relpath, filename, revision,
3267
name_from_revision, filters)
3269
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3272
tree = b.basis_tree()
3273
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3274
self.add_cleanup(rev_tree.lock_read().unlock)
3276
old_file_id = rev_tree.path2id(relpath)
3278
# TODO: Split out this code to something that generically finds the
3279
# best id for a path across one or more trees; it's like
3280
# find_ids_across_trees but restricted to find just one. -- mbp
3282
if name_from_revision:
3283
# Try in revision if requested
3284
if old_file_id is None:
3285
raise errors.BzrCommandError(gettext(
3286
"{0!r} is not present in revision {1}").format(
3287
filename, rev_tree.get_revision_id()))
3289
actual_file_id = old_file_id
3291
cur_file_id = tree.path2id(relpath)
3292
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3293
actual_file_id = cur_file_id
3294
elif old_file_id is not None:
3295
actual_file_id = old_file_id
3297
raise errors.BzrCommandError(gettext(
3298
"{0!r} is not present in revision {1}").format(
3299
filename, rev_tree.get_revision_id()))
3301
from bzrlib.filter_tree import ContentFilterTree
3302
filter_tree = ContentFilterTree(rev_tree,
3303
rev_tree._content_filter_stack)
3304
content = filter_tree.get_file_text(actual_file_id)
3306
content = rev_tree.get_file_text(actual_file_id)
3308
self.outf.write(content)
3311
class cmd_local_time_offset(Command):
3312
__doc__ = """Show the offset in seconds from GMT to local time."""
3316
self.outf.write("%s\n" % osutils.local_time_offset())
3320
class cmd_commit(Command):
3321
__doc__ = """Commit changes into a new revision.
3323
An explanatory message needs to be given for each commit. This is
3324
often done by using the --message option (getting the message from the
3325
command line) or by using the --file option (getting the message from
3326
a file). If neither of these options is given, an editor is opened for
3327
the user to enter the message. To see the changed files in the
3328
boilerplate text loaded into the editor, use the --show-diff option.
3330
By default, the entire tree is committed and the person doing the
3331
commit is assumed to be the author. These defaults can be overridden
3336
If selected files are specified, only changes to those files are
3337
committed. If a directory is specified then the directory and
3338
everything within it is committed.
3340
When excludes are given, they take precedence over selected files.
3341
For example, to commit only changes within foo, but not changes
3344
bzr commit foo -x foo/bar
3346
A selective commit after a merge is not yet supported.
3350
If the author of the change is not the same person as the committer,
3351
you can specify the author's name using the --author option. The
3352
name should be in the same format as a committer-id, e.g.
3353
"John Doe <jdoe@example.com>". If there is more than one author of
3354
the change you can specify the option multiple times, once for each
3359
A common mistake is to forget to add a new file or directory before
3360
running the commit command. The --strict option checks for unknown
3361
files and aborts the commit if any are found. More advanced pre-commit
3362
checks can be implemented by defining hooks. See ``bzr help hooks``
3367
If you accidentially commit the wrong changes or make a spelling
3368
mistake in the commit message say, you can use the uncommit command
3369
to undo it. See ``bzr help uncommit`` for details.
3371
Hooks can also be configured to run after a commit. This allows you
3372
to trigger updates to external systems like bug trackers. The --fixes
3373
option can be used to record the association between a revision and
3374
one or more bugs. See ``bzr help bugs`` for details.
3377
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3378
takes_args = ['selected*']
3380
ListOption('exclude', type=str, short_name='x',
3381
help="Do not consider changes made to a given path."),
3382
Option('message', type=unicode,
3384
help="Description of the new revision."),
3387
help='Commit even if nothing has changed.'),
3388
Option('file', type=str,
3391
help='Take commit message from this file.'),
3393
help="Refuse to commit if there are unknown "
3394
"files in the working tree."),
3395
Option('commit-time', type=str,
3396
help="Manually set a commit time using commit date "
3397
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3398
ListOption('fixes', type=str,
3399
help="Mark a bug as being fixed by this revision "
3400
"(see \"bzr help bugs\")."),
3401
ListOption('author', type=unicode,
3402
help="Set the author's name, if it's different "
3403
"from the committer."),
3405
help="Perform a local commit in a bound "
3406
"branch. Local commits are not pushed to "
3407
"the master branch until a normal commit "
3410
Option('show-diff', short_name='p',
3411
help='When no message is supplied, show the diff along'
3412
' with the status summary in the message editor.'),
3414
help='When committing to a foreign version control '
3415
'system do not push data that can not be natively '
3418
aliases = ['ci', 'checkin']
3420
def _iter_bug_fix_urls(self, fixes, branch):
3421
default_bugtracker = None
3422
# Configure the properties for bug fixing attributes.
3423
for fixed_bug in fixes:
3424
tokens = fixed_bug.split(':')
3425
if len(tokens) == 1:
3426
if default_bugtracker is None:
3427
branch_config = branch.get_config()
3428
default_bugtracker = branch_config.get_user_option(
3430
if default_bugtracker is None:
3431
raise errors.BzrCommandError(gettext(
3432
"No tracker specified for bug %s. Use the form "
3433
"'tracker:id' or specify a default bug tracker "
3434
"using the `bugtracker` option.\nSee "
3435
"\"bzr help bugs\" for more information on this "
3436
"feature. Commit refused.") % fixed_bug)
3437
tag = default_bugtracker
3439
elif len(tokens) != 2:
3440
raise errors.BzrCommandError(gettext(
3441
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3442
"See \"bzr help bugs\" for more information on this "
3443
"feature.\nCommit refused.") % fixed_bug)
3445
tag, bug_id = tokens
3447
yield bugtracker.get_bug_url(tag, branch, bug_id)
3448
except errors.UnknownBugTrackerAbbreviation:
3449
raise errors.BzrCommandError(gettext(
3450
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3451
except errors.MalformedBugIdentifier, e:
3452
raise errors.BzrCommandError(gettext(
3453
"%s\nCommit refused.") % (str(e),))
3455
def run(self, message=None, file=None, verbose=False, selected_list=None,
3456
unchanged=False, strict=False, local=False, fixes=None,
3457
author=None, show_diff=False, exclude=None, commit_time=None,
3459
from bzrlib.errors import (
3464
from bzrlib.msgeditor import (
3465
edit_commit_message_encoded,
3466
generate_commit_message_template,
3467
make_commit_message_template_encoded,
3471
commit_stamp = offset = None
3472
if commit_time is not None:
3474
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3475
except ValueError, e:
3476
raise errors.BzrCommandError(gettext(
3477
"Could not parse --commit-time: " + str(e)))
3481
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3482
if selected_list == ['']:
3483
# workaround - commit of root of tree should be exactly the same
3484
# as just default commit in that tree, and succeed even though
3485
# selected-file merge commit is not done yet
3490
bug_property = bugtracker.encode_fixes_bug_urls(
3491
self._iter_bug_fix_urls(fixes, tree.branch))
3493
properties['bugs'] = bug_property
3495
if local and not tree.branch.get_bound_location():
3496
raise errors.LocalRequiresBoundBranch()
3498
if message is not None:
3500
file_exists = osutils.lexists(message)
3501
except UnicodeError:
3502
# The commit message contains unicode characters that can't be
3503
# represented in the filesystem encoding, so that can't be a
3508
'The commit message is a file name: "%(f)s".\n'
3509
'(use --file "%(f)s" to take commit message from that file)'
3511
ui.ui_factory.show_warning(warning_msg)
3513
message = message.replace('\r\n', '\n')
3514
message = message.replace('\r', '\n')
3516
raise errors.BzrCommandError(gettext(
3517
"please specify either --message or --file"))
3519
def get_message(commit_obj):
3520
"""Callback to get commit message"""
3524
my_message = f.read().decode(osutils.get_user_encoding())
3527
elif message is not None:
3528
my_message = message
3530
# No message supplied: make one up.
3531
# text is the status of the tree
3532
text = make_commit_message_template_encoded(tree,
3533
selected_list, diff=show_diff,
3534
output_encoding=osutils.get_user_encoding())
3535
# start_message is the template generated from hooks
3536
# XXX: Warning - looks like hooks return unicode,
3537
# make_commit_message_template_encoded returns user encoding.
3538
# We probably want to be using edit_commit_message instead to
3540
my_message = set_commit_message(commit_obj)
3541
if my_message is None:
3542
start_message = generate_commit_message_template(commit_obj)
3543
my_message = edit_commit_message_encoded(text,
3544
start_message=start_message)
3545
if my_message is None:
3546
raise errors.BzrCommandError(gettext("please specify a commit"
3547
" message with either --message or --file"))
3548
if my_message == "":
3549
raise errors.BzrCommandError(gettext("Empty commit message specified."
3550
" Please specify a commit message with either"
3551
" --message or --file or leave a blank message"
3552
" with --message \"\"."))
3555
# The API permits a commit with a filter of [] to mean 'select nothing'
3556
# but the command line should not do that.
3557
if not selected_list:
3558
selected_list = None
3560
tree.commit(message_callback=get_message,
3561
specific_files=selected_list,
3562
allow_pointless=unchanged, strict=strict, local=local,
3563
reporter=None, verbose=verbose, revprops=properties,
3564
authors=author, timestamp=commit_stamp,
3566
exclude=tree.safe_relpath_files(exclude),
3568
except PointlessCommit:
3569
raise errors.BzrCommandError(gettext("No changes to commit."
3570
" Please 'bzr add' the files you want to commit, or use"
3571
" --unchanged to force an empty commit."))
3572
except ConflictsInTree:
3573
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3574
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3576
except StrictCommitFailed:
3577
raise errors.BzrCommandError(gettext("Commit refused because there are"
3578
" unknown files in the working tree."))
3579
except errors.BoundBranchOutOfDate, e:
3580
e.extra_help = (gettext("\n"
3581
'To commit to master branch, run update and then commit.\n'
3582
'You can also pass --local to commit to continue working '
3587
class cmd_check(Command):
3588
__doc__ = """Validate working tree structure, branch consistency and repository history.
3590
This command checks various invariants about branch and repository storage
3591
to detect data corruption or bzr bugs.
3593
The working tree and branch checks will only give output if a problem is
3594
detected. The output fields of the repository check are:
3597
This is just the number of revisions checked. It doesn't
3601
This is just the number of versionedfiles checked. It
3602
doesn't indicate a problem.
3604
unreferenced ancestors
3605
Texts that are ancestors of other texts, but
3606
are not properly referenced by the revision ancestry. This is a
3607
subtle problem that Bazaar can work around.
3610
This is the total number of unique file contents
3611
seen in the checked revisions. It does not indicate a problem.
3614
This is the total number of repeated texts seen
3615
in the checked revisions. Texts can be repeated when their file
3616
entries are modified, but the file contents are not. It does not
3619
If no restrictions are specified, all Bazaar data that is found at the given
3620
location will be checked.
3624
Check the tree and branch at 'foo'::
3626
bzr check --tree --branch foo
3628
Check only the repository at 'bar'::
3630
bzr check --repo bar
3632
Check everything at 'baz'::
3637
_see_also = ['reconcile']
3638
takes_args = ['path?']
3639
takes_options = ['verbose',
3640
Option('branch', help="Check the branch related to the"
3641
" current directory."),
3642
Option('repo', help="Check the repository related to the"
3643
" current directory."),
3644
Option('tree', help="Check the working tree related to"
3645
" the current directory.")]
3647
def run(self, path=None, verbose=False, branch=False, repo=False,
3649
from bzrlib.check import check_dwim
3652
if not branch and not repo and not tree:
3653
branch = repo = tree = True
3654
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3657
class cmd_upgrade(Command):
3658
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3660
When the default format has changed after a major new release of
3661
Bazaar, you may be informed during certain operations that you
3662
should upgrade. Upgrading to a newer format may improve performance
3663
or make new features available. It may however limit interoperability
3664
with older repositories or with older versions of Bazaar.
3666
If you wish to upgrade to a particular format rather than the
3667
current default, that can be specified using the --format option.
3668
As a consequence, you can use the upgrade command this way to
3669
"downgrade" to an earlier format, though some conversions are
3670
a one way process (e.g. changing from the 1.x default to the
3671
2.x default) so downgrading is not always possible.
3673
A backup.bzr.~#~ directory is created at the start of the conversion
3674
process (where # is a number). By default, this is left there on
3675
completion. If the conversion fails, delete the new .bzr directory
3676
and rename this one back in its place. Use the --clean option to ask
3677
for the backup.bzr directory to be removed on successful conversion.
3678
Alternatively, you can delete it by hand if everything looks good
3681
If the location given is a shared repository, dependent branches
3682
are also converted provided the repository converts successfully.
3683
If the conversion of a branch fails, remaining branches are still
3686
For more information on upgrades, see the Bazaar Upgrade Guide,
3687
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3690
_see_also = ['check', 'reconcile', 'formats']
3691
takes_args = ['url?']
3693
RegistryOption('format',
3694
help='Upgrade to a specific format. See "bzr help'
3695
' formats" for details.',
3696
lazy_registry=('bzrlib.controldir', 'format_registry'),
3697
converter=lambda name: controldir.format_registry.make_bzrdir(name),
3698
value_switches=True, title='Branch format'),
3700
help='Remove the backup.bzr directory if successful.'),
3702
help="Show what would be done, but don't actually do anything."),
3705
def run(self, url='.', format=None, clean=False, dry_run=False):
3706
from bzrlib.upgrade import upgrade
3707
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3709
if len(exceptions) == 1:
3710
# Compatibility with historical behavior
3716
class cmd_whoami(Command):
3717
__doc__ = """Show or set bzr user id.
3720
Show the email of the current user::
3724
Set the current user::
3726
bzr whoami "Frank Chu <fchu@example.com>"
3728
takes_options = [ 'directory',
3730
help='Display email address only.'),
3732
help='Set identity for the current branch instead of '
3735
takes_args = ['name?']
3736
encoding_type = 'replace'
3739
def run(self, email=False, branch=False, name=None, directory=None):
3741
if directory is None:
3742
# use branch if we're inside one; otherwise global config
3744
c = Branch.open_containing(u'.')[0].get_config_stack()
3745
except errors.NotBranchError:
3746
c = _mod_config.GlobalStack()
3748
c = Branch.open(directory).get_config_stack()
3749
identity = c.get('email')
3751
self.outf.write(_mod_config.extract_email_address(identity)
3754
self.outf.write(identity + '\n')
3758
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3761
# display a warning if an email address isn't included in the given name.
3763
_mod_config.extract_email_address(name)
3764
except errors.NoEmailInUsername, e:
3765
warning('"%s" does not seem to contain an email address. '
3766
'This is allowed, but not recommended.', name)
3768
# use global config unless --branch given
3770
if directory is None:
3771
c = Branch.open_containing(u'.')[0].get_config_stack()
3773
c = Branch.open(directory).get_config_stack()
3775
c = _mod_config.GlobalStack()
3776
c.set('email', name)
3779
class cmd_nick(Command):
3780
__doc__ = """Print or set the branch nickname.
3782
If unset, the tree root directory name is used as the nickname.
3783
To print the current nickname, execute with no argument.
3785
Bound branches use the nickname of its master branch unless it is set
3789
_see_also = ['info']
3790
takes_args = ['nickname?']
3791
takes_options = ['directory']
3792
def run(self, nickname=None, directory=u'.'):
3793
branch = Branch.open_containing(directory)[0]
3794
if nickname is None:
3795
self.printme(branch)
3797
branch.nick = nickname
3800
def printme(self, branch):
3801
self.outf.write('%s\n' % branch.nick)
3804
class cmd_alias(Command):
3805
__doc__ = """Set/unset and display aliases.
3808
Show the current aliases::
3812
Show the alias specified for 'll'::
3816
Set an alias for 'll'::
3818
bzr alias ll="log --line -r-10..-1"
3820
To remove an alias for 'll'::
3822
bzr alias --remove ll
3825
takes_args = ['name?']
3827
Option('remove', help='Remove the alias.'),
3830
def run(self, name=None, remove=False):
3832
self.remove_alias(name)
3834
self.print_aliases()
3836
equal_pos = name.find('=')
3838
self.print_alias(name)
3840
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3842
def remove_alias(self, alias_name):
3843
if alias_name is None:
3844
raise errors.BzrCommandError(gettext(
3845
'bzr alias --remove expects an alias to remove.'))
3846
# If alias is not found, print something like:
3847
# unalias: foo: not found
3848
c = _mod_config.GlobalConfig()
3849
c.unset_alias(alias_name)
3852
def print_aliases(self):
3853
"""Print out the defined aliases in a similar format to bash."""
3854
aliases = _mod_config.GlobalConfig().get_aliases()
3855
for key, value in sorted(aliases.iteritems()):
3856
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3859
def print_alias(self, alias_name):
3860
from bzrlib.commands import get_alias
3861
alias = get_alias(alias_name)
3863
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3866
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3868
def set_alias(self, alias_name, alias_command):
3869
"""Save the alias in the global config."""
3870
c = _mod_config.GlobalConfig()
3871
c.set_alias(alias_name, alias_command)
3874
class cmd_selftest(Command):
3875
__doc__ = """Run internal test suite.
3877
If arguments are given, they are regular expressions that say which tests
3878
should run. Tests matching any expression are run, and other tests are
3881
Alternatively if --first is given, matching tests are run first and then
3882
all other tests are run. This is useful if you have been working in a
3883
particular area, but want to make sure nothing else was broken.
3885
If --exclude is given, tests that match that regular expression are
3886
excluded, regardless of whether they match --first or not.
3888
To help catch accidential dependencies between tests, the --randomize
3889
option is useful. In most cases, the argument used is the word 'now'.
3890
Note that the seed used for the random number generator is displayed
3891
when this option is used. The seed can be explicitly passed as the
3892
argument to this option if required. This enables reproduction of the
3893
actual ordering used if and when an order sensitive problem is encountered.
3895
If --list-only is given, the tests that would be run are listed. This is
3896
useful when combined with --first, --exclude and/or --randomize to
3897
understand their impact. The test harness reports "Listed nn tests in ..."
3898
instead of "Ran nn tests in ..." when list mode is enabled.
3900
If the global option '--no-plugins' is given, plugins are not loaded
3901
before running the selftests. This has two effects: features provided or
3902
modified by plugins will not be tested, and tests provided by plugins will
3905
Tests that need working space on disk use a common temporary directory,
3906
typically inside $TMPDIR or /tmp.
3908
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3909
into a pdb postmortem session.
3911
The --coverage=DIRNAME global option produces a report with covered code
3915
Run only tests relating to 'ignore'::
3919
Disable plugins and list tests as they're run::
3921
bzr --no-plugins selftest -v
3923
# NB: this is used from the class without creating an instance, which is
3924
# why it does not have a self parameter.
3925
def get_transport_type(typestring):
3926
"""Parse and return a transport specifier."""
3927
if typestring == "sftp":
3928
from bzrlib.tests import stub_sftp
3929
return stub_sftp.SFTPAbsoluteServer
3930
elif typestring == "memory":
3931
from bzrlib.tests import test_server
3932
return memory.MemoryServer
3933
elif typestring == "fakenfs":
3934
from bzrlib.tests import test_server
3935
return test_server.FakeNFSServer
3936
msg = "No known transport type %s. Supported types are: sftp\n" %\
3938
raise errors.BzrCommandError(msg)
3941
takes_args = ['testspecs*']
3942
takes_options = ['verbose',
3944
help='Stop when one test fails.',
3948
help='Use a different transport by default '
3949
'throughout the test suite.',
3950
type=get_transport_type),
3952
help='Run the benchmarks rather than selftests.',
3954
Option('lsprof-timed',
3955
help='Generate lsprof output for benchmarked'
3956
' sections of code.'),
3957
Option('lsprof-tests',
3958
help='Generate lsprof output for each test.'),
3960
help='Run all tests, but run specified tests first.',
3964
help='List the tests instead of running them.'),
3965
RegistryOption('parallel',
3966
help="Run the test suite in parallel.",
3967
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3968
value_switches=False,
3970
Option('randomize', type=str, argname="SEED",
3971
help='Randomize the order of tests using the given'
3972
' seed or "now" for the current time.'),
3973
ListOption('exclude', type=str, argname="PATTERN",
3975
help='Exclude tests that match this regular'
3978
help='Output test progress via subunit.'),
3979
Option('strict', help='Fail on missing dependencies or '
3981
Option('load-list', type=str, argname='TESTLISTFILE',
3982
help='Load a test id list from a text file.'),
3983
ListOption('debugflag', type=str, short_name='E',
3984
help='Turn on a selftest debug flag.'),
3985
ListOption('starting-with', type=str, argname='TESTID',
3986
param_name='starting_with', short_name='s',
3988
'Load only the tests starting with TESTID.'),
3990
help="By default we disable fsync and fdatasync"
3991
" while running the test suite.")
3993
encoding_type = 'replace'
3996
Command.__init__(self)
3997
self.additional_selftest_args = {}
3999
def run(self, testspecs_list=None, verbose=False, one=False,
4000
transport=None, benchmark=None,
4002
first=False, list_only=False,
4003
randomize=None, exclude=None, strict=False,
4004
load_list=None, debugflag=None, starting_with=None, subunit=False,
4005
parallel=None, lsprof_tests=False,
4007
from bzrlib import tests
4009
if testspecs_list is not None:
4010
pattern = '|'.join(testspecs_list)
4015
from bzrlib.tests import SubUnitBzrRunner
4017
raise errors.BzrCommandError(gettext("subunit not available. subunit "
4018
"needs to be installed to use --subunit."))
4019
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
4020
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4021
# stdout, which would corrupt the subunit stream.
4022
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4023
# following code can be deleted when it's sufficiently deployed
4024
# -- vila/mgz 20100514
4025
if (sys.platform == "win32"
4026
and getattr(sys.stdout, 'fileno', None) is not None):
4028
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4030
self.additional_selftest_args.setdefault(
4031
'suite_decorators', []).append(parallel)
4033
raise errors.BzrCommandError(gettext(
4034
"--benchmark is no longer supported from bzr 2.2; "
4035
"use bzr-usertest instead"))
4036
test_suite_factory = None
4038
exclude_pattern = None
4040
exclude_pattern = '(' + '|'.join(exclude) + ')'
4042
self._disable_fsync()
4043
selftest_kwargs = {"verbose": verbose,
4045
"stop_on_failure": one,
4046
"transport": transport,
4047
"test_suite_factory": test_suite_factory,
4048
"lsprof_timed": lsprof_timed,
4049
"lsprof_tests": lsprof_tests,
4050
"matching_tests_first": first,
4051
"list_only": list_only,
4052
"random_seed": randomize,
4053
"exclude_pattern": exclude_pattern,
4055
"load_list": load_list,
4056
"debug_flags": debugflag,
4057
"starting_with": starting_with
4059
selftest_kwargs.update(self.additional_selftest_args)
4061
# Make deprecation warnings visible, unless -Werror is set
4062
cleanup = symbol_versioning.activate_deprecation_warnings(
4065
result = tests.selftest(**selftest_kwargs)
4068
return int(not result)
4070
def _disable_fsync(self):
4071
"""Change the 'os' functionality to not synchronize."""
4072
self._orig_fsync = getattr(os, 'fsync', None)
4073
if self._orig_fsync is not None:
4074
os.fsync = lambda filedes: None
4075
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4076
if self._orig_fdatasync is not None:
4077
os.fdatasync = lambda filedes: None
4080
class cmd_version(Command):
4081
__doc__ = """Show version of bzr."""
4083
encoding_type = 'replace'
4085
Option("short", help="Print just the version number."),
4089
def run(self, short=False):
4090
from bzrlib.version import show_version
4092
self.outf.write(bzrlib.version_string + '\n')
4094
show_version(to_file=self.outf)
4097
class cmd_rocks(Command):
4098
__doc__ = """Statement of optimism."""
4104
self.outf.write(gettext("It sure does!\n"))
4107
class cmd_find_merge_base(Command):
4108
__doc__ = """Find and print a base revision for merging two branches."""
4109
# TODO: Options to specify revisions on either side, as if
4110
# merging only part of the history.
4111
takes_args = ['branch', 'other']
4115
def run(self, branch, other):
4116
from bzrlib.revision import ensure_null
4118
branch1 = Branch.open_containing(branch)[0]
4119
branch2 = Branch.open_containing(other)[0]
4120
self.add_cleanup(branch1.lock_read().unlock)
4121
self.add_cleanup(branch2.lock_read().unlock)
4122
last1 = ensure_null(branch1.last_revision())
4123
last2 = ensure_null(branch2.last_revision())
4125
graph = branch1.repository.get_graph(branch2.repository)
4126
base_rev_id = graph.find_unique_lca(last1, last2)
4128
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4131
class cmd_merge(Command):
4132
__doc__ = """Perform a three-way merge.
4134
The source of the merge can be specified either in the form of a branch,
4135
or in the form of a path to a file containing a merge directive generated
4136
with bzr send. If neither is specified, the default is the upstream branch
4137
or the branch most recently merged using --remember. The source of the
4138
merge may also be specified in the form of a path to a file in another
4139
branch: in this case, only the modifications to that file are merged into
4140
the current working tree.
4142
When merging from a branch, by default bzr will try to merge in all new
4143
work from the other branch, automatically determining an appropriate base
4144
revision. If this fails, you may need to give an explicit base.
4146
To pick a different ending revision, pass "--revision OTHER". bzr will
4147
try to merge in all new work up to and including revision OTHER.
4149
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4150
through OTHER, excluding BASE but including OTHER, will be merged. If this
4151
causes some revisions to be skipped, i.e. if the destination branch does
4152
not already contain revision BASE, such a merge is commonly referred to as
4153
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4154
cherrypicks. The changes look like a normal commit, and the history of the
4155
changes from the other branch is not stored in the commit.
4157
Revision numbers are always relative to the source branch.
4159
Merge will do its best to combine the changes in two branches, but there
4160
are some kinds of problems only a human can fix. When it encounters those,
4161
it will mark a conflict. A conflict means that you need to fix something,
4162
before you should commit.
4164
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
4166
If there is no default branch set, the first merge will set it (use
4167
--no-remember to avoid setting it). After that, you can omit the branch
4168
to use the default. To change the default, use --remember. The value will
4169
only be saved if the remote location can be accessed.
4171
The results of the merge are placed into the destination working
4172
directory, where they can be reviewed (with bzr diff), tested, and then
4173
committed to record the result of the merge.
4175
merge refuses to run if there are any uncommitted changes, unless
4176
--force is given. If --force is given, then the changes from the source
4177
will be merged with the current working tree, including any uncommitted
4178
changes in the tree. The --force option can also be used to create a
4179
merge revision which has more than two parents.
4181
If one would like to merge changes from the working tree of the other
4182
branch without merging any committed revisions, the --uncommitted option
4185
To select only some changes to merge, use "merge -i", which will prompt
4186
you to apply each diff hunk and file change, similar to "shelve".
4189
To merge all new revisions from bzr.dev::
4191
bzr merge ../bzr.dev
4193
To merge changes up to and including revision 82 from bzr.dev::
4195
bzr merge -r 82 ../bzr.dev
4197
To merge the changes introduced by 82, without previous changes::
4199
bzr merge -r 81..82 ../bzr.dev
4201
To apply a merge directive contained in /tmp/merge::
4203
bzr merge /tmp/merge
4205
To create a merge revision with three parents from two branches
4206
feature1a and feature1b:
4208
bzr merge ../feature1a
4209
bzr merge ../feature1b --force
4210
bzr commit -m 'revision with three parents'
4213
encoding_type = 'exact'
4214
_see_also = ['update', 'remerge', 'status-flags', 'send']
4215
takes_args = ['location?']
4220
help='Merge even if the destination tree has uncommitted changes.'),
4224
Option('show-base', help="Show base revision text in "
4226
Option('uncommitted', help='Apply uncommitted changes'
4227
' from a working copy, instead of branch changes.'),
4228
Option('pull', help='If the destination is already'
4229
' completely merged into the source, pull from the'
4230
' source rather than merging. When this happens,'
4231
' you do not need to commit the result.'),
4232
custom_help('directory',
4233
help='Branch to merge into, '
4234
'rather than the one containing the working directory.'),
4235
Option('preview', help='Instead of merging, show a diff of the'
4237
Option('interactive', help='Select changes interactively.',
4241
def run(self, location=None, revision=None, force=False,
4242
merge_type=None, show_base=False, reprocess=None, remember=None,
4243
uncommitted=False, pull=False,
4248
if merge_type is None:
4249
merge_type = _mod_merge.Merge3Merger
4251
if directory is None: directory = u'.'
4252
possible_transports = []
4254
allow_pending = True
4255
verified = 'inapplicable'
4257
tree = WorkingTree.open_containing(directory)[0]
4258
if tree.branch.revno() == 0:
4259
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4260
'https://bugs.launchpad.net/bzr/+bug/308562'))
4263
basis_tree = tree.revision_tree(tree.last_revision())
4264
except errors.NoSuchRevision:
4265
basis_tree = tree.basis_tree()
4267
# die as quickly as possible if there are uncommitted changes
4269
if tree.has_changes():
4270
raise errors.UncommittedChanges(tree)
4272
view_info = _get_view_info_for_change_reporter(tree)
4273
change_reporter = delta._ChangeReporter(
4274
unversioned_filter=tree.is_ignored, view_info=view_info)
4275
pb = ui.ui_factory.nested_progress_bar()
4276
self.add_cleanup(pb.finished)
4277
self.add_cleanup(tree.lock_write().unlock)
4278
if location is not None:
4280
mergeable = bundle.read_mergeable_from_url(location,
4281
possible_transports=possible_transports)
4282
except errors.NotABundle:
4286
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4287
' with bundles or merge directives.'))
4289
if revision is not None:
4290
raise errors.BzrCommandError(gettext(
4291
'Cannot use -r with merge directives or bundles'))
4292
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4295
if merger is None and uncommitted:
4296
if revision is not None and len(revision) > 0:
4297
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4298
' --revision at the same time.'))
4299
merger = self.get_merger_from_uncommitted(tree, location, None)
4300
allow_pending = False
4303
merger, allow_pending = self._get_merger_from_branch(tree,
4304
location, revision, remember, possible_transports, None)
4306
merger.merge_type = merge_type
4307
merger.reprocess = reprocess
4308
merger.show_base = show_base
4309
self.sanity_check_merger(merger)
4310
if (merger.base_rev_id == merger.other_rev_id and
4311
merger.other_rev_id is not None):
4312
# check if location is a nonexistent file (and not a branch) to
4313
# disambiguate the 'Nothing to do'
4314
if merger.interesting_files:
4315
if not merger.other_tree.has_filename(
4316
merger.interesting_files[0]):
4317
note(gettext("merger: ") + str(merger))
4318
raise errors.PathsDoNotExist([location])
4319
note(gettext('Nothing to do.'))
4321
if pull and not preview:
4322
if merger.interesting_files is not None:
4323
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4324
if (merger.base_rev_id == tree.last_revision()):
4325
result = tree.pull(merger.other_branch, False,
4326
merger.other_rev_id)
4327
result.report(self.outf)
4329
if merger.this_basis is None:
4330
raise errors.BzrCommandError(gettext(
4331
"This branch has no commits."
4332
" (perhaps you would prefer 'bzr pull')"))
4334
return self._do_preview(merger)
4336
return self._do_interactive(merger)
4338
return self._do_merge(merger, change_reporter, allow_pending,
4341
def _get_preview(self, merger):
4342
tree_merger = merger.make_merger()
4343
tt = tree_merger.make_preview_transform()
4344
self.add_cleanup(tt.finalize)
4345
result_tree = tt.get_preview_tree()
4348
def _do_preview(self, merger):
4349
from bzrlib.diff import show_diff_trees
4350
result_tree = self._get_preview(merger)
4351
path_encoding = osutils.get_diff_header_encoding()
4352
show_diff_trees(merger.this_tree, result_tree, self.outf,
4353
old_label='', new_label='',
4354
path_encoding=path_encoding)
4356
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4357
merger.change_reporter = change_reporter
4358
conflict_count = merger.do_merge()
4360
merger.set_pending()
4361
if verified == 'failed':
4362
warning('Preview patch does not match changes')
4363
if conflict_count != 0:
4368
def _do_interactive(self, merger):
4369
"""Perform an interactive merge.
4371
This works by generating a preview tree of the merge, then using
4372
Shelver to selectively remove the differences between the working tree
4373
and the preview tree.
4375
from bzrlib import shelf_ui
4376
result_tree = self._get_preview(merger)
4377
writer = bzrlib.option.diff_writer_registry.get()
4378
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4379
reporter=shelf_ui.ApplyReporter(),
4380
diff_writer=writer(sys.stdout))
4386
def sanity_check_merger(self, merger):
4387
if (merger.show_base and
4388
not merger.merge_type is _mod_merge.Merge3Merger):
4389
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4390
" merge type. %s") % merger.merge_type)
4391
if merger.reprocess is None:
4392
if merger.show_base:
4393
merger.reprocess = False
4395
# Use reprocess if the merger supports it
4396
merger.reprocess = merger.merge_type.supports_reprocess
4397
if merger.reprocess and not merger.merge_type.supports_reprocess:
4398
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4399
" for merge type %s.") %
4401
if merger.reprocess and merger.show_base:
4402
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4405
def _get_merger_from_branch(self, tree, location, revision, remember,
4406
possible_transports, pb):
4407
"""Produce a merger from a location, assuming it refers to a branch."""
4408
from bzrlib.tag import _merge_tags_if_possible
4409
# find the branch locations
4410
other_loc, user_location = self._select_branch_location(tree, location,
4412
if revision is not None and len(revision) == 2:
4413
base_loc, _unused = self._select_branch_location(tree,
4414
location, revision, 0)
4416
base_loc = other_loc
4418
other_branch, other_path = Branch.open_containing(other_loc,
4419
possible_transports)
4420
if base_loc == other_loc:
4421
base_branch = other_branch
4423
base_branch, base_path = Branch.open_containing(base_loc,
4424
possible_transports)
4425
# Find the revision ids
4426
other_revision_id = None
4427
base_revision_id = None
4428
if revision is not None:
4429
if len(revision) >= 1:
4430
other_revision_id = revision[-1].as_revision_id(other_branch)
4431
if len(revision) == 2:
4432
base_revision_id = revision[0].as_revision_id(base_branch)
4433
if other_revision_id is None:
4434
other_revision_id = _mod_revision.ensure_null(
4435
other_branch.last_revision())
4436
# Remember where we merge from. We need to remember if:
4437
# - user specify a location (and we don't merge from the parent
4439
# - user ask to remember or there is no previous location set to merge
4440
# from and user didn't ask to *not* remember
4441
if (user_location is not None
4443
or (remember is None
4444
and tree.branch.get_submit_branch() is None)))):
4445
tree.branch.set_submit_branch(other_branch.base)
4446
# Merge tags (but don't set them in the master branch yet, the user
4447
# might revert this merge). Commit will propagate them.
4448
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4449
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4450
other_revision_id, base_revision_id, other_branch, base_branch)
4451
if other_path != '':
4452
allow_pending = False
4453
merger.interesting_files = [other_path]
4455
allow_pending = True
4456
return merger, allow_pending
4458
def get_merger_from_uncommitted(self, tree, location, pb):
4459
"""Get a merger for uncommitted changes.
4461
:param tree: The tree the merger should apply to.
4462
:param location: The location containing uncommitted changes.
4463
:param pb: The progress bar to use for showing progress.
4465
location = self._select_branch_location(tree, location)[0]
4466
other_tree, other_path = WorkingTree.open_containing(location)
4467
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4468
if other_path != '':
4469
merger.interesting_files = [other_path]
4472
def _select_branch_location(self, tree, user_location, revision=None,
4474
"""Select a branch location, according to possible inputs.
4476
If provided, branches from ``revision`` are preferred. (Both
4477
``revision`` and ``index`` must be supplied.)
4479
Otherwise, the ``location`` parameter is used. If it is None, then the
4480
``submit`` or ``parent`` location is used, and a note is printed.
4482
:param tree: The working tree to select a branch for merging into
4483
:param location: The location entered by the user
4484
:param revision: The revision parameter to the command
4485
:param index: The index to use for the revision parameter. Negative
4486
indices are permitted.
4487
:return: (selected_location, user_location). The default location
4488
will be the user-entered location.
4490
if (revision is not None and index is not None
4491
and revision[index] is not None):
4492
branch = revision[index].get_branch()
4493
if branch is not None:
4494
return branch, branch
4495
if user_location is None:
4496
location = self._get_remembered(tree, 'Merging from')
4498
location = user_location
4499
return location, user_location
4501
def _get_remembered(self, tree, verb_string):
4502
"""Use tree.branch's parent if none was supplied.
4504
Report if the remembered location was used.
4506
stored_location = tree.branch.get_submit_branch()
4507
stored_location_type = "submit"
4508
if stored_location is None:
4509
stored_location = tree.branch.get_parent()
4510
stored_location_type = "parent"
4511
mutter("%s", stored_location)
4512
if stored_location is None:
4513
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4514
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4515
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4516
stored_location_type, display_url))
4517
return stored_location
4520
class cmd_remerge(Command):
4521
__doc__ = """Redo a merge.
4523
Use this if you want to try a different merge technique while resolving
4524
conflicts. Some merge techniques are better than others, and remerge
4525
lets you try different ones on different files.
4527
The options for remerge have the same meaning and defaults as the ones for
4528
merge. The difference is that remerge can (only) be run when there is a
4529
pending merge, and it lets you specify particular files.
4532
Re-do the merge of all conflicted files, and show the base text in
4533
conflict regions, in addition to the usual THIS and OTHER texts::
4535
bzr remerge --show-base
4537
Re-do the merge of "foobar", using the weave merge algorithm, with
4538
additional processing to reduce the size of conflict regions::
4540
bzr remerge --merge-type weave --reprocess foobar
4542
takes_args = ['file*']
4547
help="Show base revision text in conflicts."),
4550
def run(self, file_list=None, merge_type=None, show_base=False,
4552
from bzrlib.conflicts import restore
4553
if merge_type is None:
4554
merge_type = _mod_merge.Merge3Merger
4555
tree, file_list = WorkingTree.open_containing_paths(file_list)
4556
self.add_cleanup(tree.lock_write().unlock)
4557
parents = tree.get_parent_ids()
4558
if len(parents) != 2:
4559
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4560
" merges. Not cherrypicking or"
4562
repository = tree.branch.repository
4563
interesting_ids = None
4565
conflicts = tree.conflicts()
4566
if file_list is not None:
4567
interesting_ids = set()
4568
for filename in file_list:
4569
file_id = tree.path2id(filename)
4571
raise errors.NotVersionedError(filename)
4572
interesting_ids.add(file_id)
4573
if tree.kind(file_id) != "directory":
4576
for name, ie in tree.inventory.iter_entries(file_id):
4577
interesting_ids.add(ie.file_id)
4578
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4580
# Remerge only supports resolving contents conflicts
4581
allowed_conflicts = ('text conflict', 'contents conflict')
4582
restore_files = [c.path for c in conflicts
4583
if c.typestring in allowed_conflicts]
4584
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4585
tree.set_conflicts(ConflictList(new_conflicts))
4586
if file_list is not None:
4587
restore_files = file_list
4588
for filename in restore_files:
4590
restore(tree.abspath(filename))
4591
except errors.NotConflicted:
4593
# Disable pending merges, because the file texts we are remerging
4594
# have not had those merges performed. If we use the wrong parents
4595
# list, we imply that the working tree text has seen and rejected
4596
# all the changes from the other tree, when in fact those changes
4597
# have not yet been seen.
4598
tree.set_parent_ids(parents[:1])
4600
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4601
merger.interesting_ids = interesting_ids
4602
merger.merge_type = merge_type
4603
merger.show_base = show_base
4604
merger.reprocess = reprocess
4605
conflicts = merger.do_merge()
4607
tree.set_parent_ids(parents)
4614
class cmd_revert(Command):
4615
__doc__ = """Revert files to a previous revision.
4617
Giving a list of files will revert only those files. Otherwise, all files
4618
will be reverted. If the revision is not specified with '--revision', the
4619
last committed revision is used.
4621
To remove only some changes, without reverting to a prior version, use
4622
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4623
will remove the changes introduced by the second last commit (-2), without
4624
affecting the changes introduced by the last commit (-1). To remove
4625
certain changes on a hunk-by-hunk basis, see the shelve command.
4627
By default, any files that have been manually changed will be backed up
4628
first. (Files changed only by merge are not backed up.) Backup files have
4629
'.~#~' appended to their name, where # is a number.
4631
When you provide files, you can use their current pathname or the pathname
4632
from the target revision. So you can use revert to "undelete" a file by
4633
name. If you name a directory, all the contents of that directory will be
4636
If you have newly added files since the target revision, they will be
4637
removed. If the files to be removed have been changed, backups will be
4638
created as above. Directories containing unknown files will not be
4641
The working tree contains a list of revisions that have been merged but
4642
not yet committed. These revisions will be included as additional parents
4643
of the next commit. Normally, using revert clears that list as well as
4644
reverting the files. If any files are specified, revert leaves the list
4645
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4646
.`` in the tree root to revert all files but keep the recorded merges,
4647
and ``bzr revert --forget-merges`` to clear the pending merge list without
4648
reverting any files.
4650
Using "bzr revert --forget-merges", it is possible to apply all of the
4651
changes from a branch in a single revision. To do this, perform the merge
4652
as desired. Then doing revert with the "--forget-merges" option will keep
4653
the content of the tree as it was, but it will clear the list of pending
4654
merges. The next commit will then contain all of the changes that are
4655
present in the other branch, but without any other parent revisions.
4656
Because this technique forgets where these changes originated, it may
4657
cause additional conflicts on later merges involving the same source and
4661
_see_also = ['cat', 'export', 'merge', 'shelve']
4664
Option('no-backup', "Do not save backups of reverted files."),
4665
Option('forget-merges',
4666
'Remove pending merge marker, without changing any files.'),
4668
takes_args = ['file*']
4670
def run(self, revision=None, no_backup=False, file_list=None,
4671
forget_merges=None):
4672
tree, file_list = WorkingTree.open_containing_paths(file_list)
4673
self.add_cleanup(tree.lock_tree_write().unlock)
4675
tree.set_parent_ids(tree.get_parent_ids()[:1])
4677
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4680
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4681
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4682
tree.revert(file_list, rev_tree, not no_backup, None,
4683
report_changes=True)
4686
class cmd_assert_fail(Command):
4687
__doc__ = """Test reporting of assertion failures"""
4688
# intended just for use in testing
4693
raise AssertionError("always fails")
4696
class cmd_help(Command):
4697
__doc__ = """Show help on a command or other topic.
4700
_see_also = ['topics']
4702
Option('long', 'Show help on all commands.'),
4704
takes_args = ['topic?']
4705
aliases = ['?', '--help', '-?', '-h']
4708
def run(self, topic=None, long=False):
4710
if topic is None and long:
4712
bzrlib.help.help(topic)
4715
class cmd_shell_complete(Command):
4716
__doc__ = """Show appropriate completions for context.
4718
For a list of all available commands, say 'bzr shell-complete'.
4720
takes_args = ['context?']
4725
def run(self, context=None):
4726
from bzrlib import shellcomplete
4727
shellcomplete.shellcomplete(context)
4730
class cmd_missing(Command):
4731
__doc__ = """Show unmerged/unpulled revisions between two branches.
4733
OTHER_BRANCH may be local or remote.
4735
To filter on a range of revisions, you can use the command -r begin..end
4736
-r revision requests a specific revision, -r ..end or -r begin.. are
4740
1 - some missing revisions
4741
0 - no missing revisions
4745
Determine the missing revisions between this and the branch at the
4746
remembered pull location::
4750
Determine the missing revisions between this and another branch::
4752
bzr missing http://server/branch
4754
Determine the missing revisions up to a specific revision on the other
4757
bzr missing -r ..-10
4759
Determine the missing revisions up to a specific revision on this
4762
bzr missing --my-revision ..-10
4765
_see_also = ['merge', 'pull']
4766
takes_args = ['other_branch?']
4769
Option('reverse', 'Reverse the order of revisions.'),
4771
'Display changes in the local branch only.'),
4772
Option('this' , 'Same as --mine-only.'),
4773
Option('theirs-only',
4774
'Display changes in the remote branch only.'),
4775
Option('other', 'Same as --theirs-only.'),
4779
custom_help('revision',
4780
help='Filter on other branch revisions (inclusive). '
4781
'See "help revisionspec" for details.'),
4782
Option('my-revision',
4783
type=_parse_revision_str,
4784
help='Filter on local branch revisions (inclusive). '
4785
'See "help revisionspec" for details.'),
4786
Option('include-merged',
4787
'Show all revisions in addition to the mainline ones.'),
4788
Option('include-merges', hidden=True,
4789
help='Historical alias for --include-merged.'),
4791
encoding_type = 'replace'
4794
def run(self, other_branch=None, reverse=False, mine_only=False,
4796
log_format=None, long=False, short=False, line=False,
4797
show_ids=False, verbose=False, this=False, other=False,
4798
include_merged=None, revision=None, my_revision=None,
4800
include_merges=symbol_versioning.DEPRECATED_PARAMETER):
4801
from bzrlib.missing import find_unmerged, iter_log_revisions
4806
if symbol_versioning.deprecated_passed(include_merges):
4807
ui.ui_factory.show_user_warning(
4808
'deprecated_command_option',
4809
deprecated_name='--include-merges',
4810
recommended_name='--include-merged',
4811
deprecated_in_version='2.5',
4812
command=self.invoked_as)
4813
if include_merged is None:
4814
include_merged = include_merges
4816
raise errors.BzrCommandError(gettext(
4817
'{0} and {1} are mutually exclusive').format(
4818
'--include-merges', '--include-merged'))
4819
if include_merged is None:
4820
include_merged = False
4825
# TODO: We should probably check that we don't have mine-only and
4826
# theirs-only set, but it gets complicated because we also have
4827
# this and other which could be used.
4834
local_branch = Branch.open_containing(directory)[0]
4835
self.add_cleanup(local_branch.lock_read().unlock)
4837
parent = local_branch.get_parent()
4838
if other_branch is None:
4839
other_branch = parent
4840
if other_branch is None:
4841
raise errors.BzrCommandError(gettext("No peer location known"
4843
display_url = urlutils.unescape_for_display(parent,
4845
message(gettext("Using saved parent location: {0}\n").format(
4848
remote_branch = Branch.open(other_branch)
4849
if remote_branch.base == local_branch.base:
4850
remote_branch = local_branch
4852
self.add_cleanup(remote_branch.lock_read().unlock)
4854
local_revid_range = _revision_range_to_revid_range(
4855
_get_revision_range(my_revision, local_branch,
4858
remote_revid_range = _revision_range_to_revid_range(
4859
_get_revision_range(revision,
4860
remote_branch, self.name()))
4862
local_extra, remote_extra = find_unmerged(
4863
local_branch, remote_branch, restrict,
4864
backward=not reverse,
4865
include_merged=include_merged,
4866
local_revid_range=local_revid_range,
4867
remote_revid_range=remote_revid_range)
4869
if log_format is None:
4870
registry = log.log_formatter_registry
4871
log_format = registry.get_default(local_branch)
4872
lf = log_format(to_file=self.outf,
4874
show_timezone='original')
4877
if local_extra and not theirs_only:
4878
message(ngettext("You have %d extra revision:\n",
4879
"You have %d extra revisions:\n",
4882
for revision in iter_log_revisions(local_extra,
4883
local_branch.repository,
4885
lf.log_revision(revision)
4886
printed_local = True
4889
printed_local = False
4891
if remote_extra and not mine_only:
4892
if printed_local is True:
4894
message(ngettext("You are missing %d revision:\n",
4895
"You are missing %d revisions:\n",
4896
len(remote_extra)) %
4898
for revision in iter_log_revisions(remote_extra,
4899
remote_branch.repository,
4901
lf.log_revision(revision)
4904
if mine_only and not local_extra:
4905
# We checked local, and found nothing extra
4906
message(gettext('This branch has no new revisions.\n'))
4907
elif theirs_only and not remote_extra:
4908
# We checked remote, and found nothing extra
4909
message(gettext('Other branch has no new revisions.\n'))
4910
elif not (mine_only or theirs_only or local_extra or
4912
# We checked both branches, and neither one had extra
4914
message(gettext("Branches are up to date.\n"))
4916
if not status_code and parent is None and other_branch is not None:
4917
self.add_cleanup(local_branch.lock_write().unlock)
4918
# handle race conditions - a parent might be set while we run.
4919
if local_branch.get_parent() is None:
4920
local_branch.set_parent(remote_branch.base)
4924
class cmd_pack(Command):
4925
__doc__ = """Compress the data within a repository.
4927
This operation compresses the data within a bazaar repository. As
4928
bazaar supports automatic packing of repository, this operation is
4929
normally not required to be done manually.
4931
During the pack operation, bazaar takes a backup of existing repository
4932
data, i.e. pack files. This backup is eventually removed by bazaar
4933
automatically when it is safe to do so. To save disk space by removing
4934
the backed up pack files, the --clean-obsolete-packs option may be
4937
Warning: If you use --clean-obsolete-packs and your machine crashes
4938
during or immediately after repacking, you may be left with a state
4939
where the deletion has been written to disk but the new packs have not
4940
been. In this case the repository may be unusable.
4943
_see_also = ['repositories']
4944
takes_args = ['branch_or_repo?']
4946
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4949
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4950
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
4952
branch = dir.open_branch()
4953
repository = branch.repository
4954
except errors.NotBranchError:
4955
repository = dir.open_repository()
4956
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4959
class cmd_plugins(Command):
4960
__doc__ = """List the installed plugins.
4962
This command displays the list of installed plugins including
4963
version of plugin and a short description of each.
4965
--verbose shows the path where each plugin is located.
4967
A plugin is an external component for Bazaar that extends the
4968
revision control system, by adding or replacing code in Bazaar.
4969
Plugins can do a variety of things, including overriding commands,
4970
adding new commands, providing additional network transports and
4971
customizing log output.
4973
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4974
for further information on plugins including where to find them and how to
4975
install them. Instructions are also provided there on how to write new
4976
plugins using the Python programming language.
4978
takes_options = ['verbose']
4981
def run(self, verbose=False):
4982
from bzrlib import plugin
4983
# Don't give writelines a generator as some codecs don't like that
4984
self.outf.writelines(
4985
list(plugin.describe_plugins(show_paths=verbose)))
4988
class cmd_testament(Command):
4989
__doc__ = """Show testament (signing-form) of a revision."""
4992
Option('long', help='Produce long-format testament.'),
4994
help='Produce a strict-format testament.')]
4995
takes_args = ['branch?']
4997
def run(self, branch=u'.', revision=None, long=False, strict=False):
4998
from bzrlib.testament import Testament, StrictTestament
5000
testament_class = StrictTestament
5002
testament_class = Testament
5004
b = Branch.open_containing(branch)[0]
5006
b = Branch.open(branch)
5007
self.add_cleanup(b.lock_read().unlock)
5008
if revision is None:
5009
rev_id = b.last_revision()
5011
rev_id = revision[0].as_revision_id(b)
5012
t = testament_class.from_revision(b.repository, rev_id)
5014
sys.stdout.writelines(t.as_text_lines())
5016
sys.stdout.write(t.as_short_text())
5019
class cmd_annotate(Command):
5020
__doc__ = """Show the origin of each line in a file.
5022
This prints out the given file with an annotation on the left side
5023
indicating which revision, author and date introduced the change.
5025
If the origin is the same for a run of consecutive lines, it is
5026
shown only at the top, unless the --all option is given.
5028
# TODO: annotate directories; showing when each file was last changed
5029
# TODO: if the working copy is modified, show annotations on that
5030
# with new uncommitted lines marked
5031
aliases = ['ann', 'blame', 'praise']
5032
takes_args = ['filename']
5033
takes_options = [Option('all', help='Show annotations on all lines.'),
5034
Option('long', help='Show commit date in annotations.'),
5039
encoding_type = 'exact'
5042
def run(self, filename, all=False, long=False, revision=None,
5043
show_ids=False, directory=None):
5044
from bzrlib.annotate import (
5047
wt, branch, relpath = \
5048
_open_directory_or_containing_tree_or_branch(filename, directory)
5050
self.add_cleanup(wt.lock_read().unlock)
5052
self.add_cleanup(branch.lock_read().unlock)
5053
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5054
self.add_cleanup(tree.lock_read().unlock)
5055
if wt is not None and revision is None:
5056
file_id = wt.path2id(relpath)
5058
file_id = tree.path2id(relpath)
5060
raise errors.NotVersionedError(filename)
5061
if wt is not None and revision is None:
5062
# If there is a tree and we're not annotating historical
5063
# versions, annotate the working tree's content.
5064
annotate_file_tree(wt, file_id, self.outf, long, all,
5067
annotate_file_tree(tree, file_id, self.outf, long, all,
5068
show_ids=show_ids, branch=branch)
5071
class cmd_re_sign(Command):
5072
__doc__ = """Create a digital signature for an existing revision."""
5073
# TODO be able to replace existing ones.
5075
hidden = True # is this right ?
5076
takes_args = ['revision_id*']
5077
takes_options = ['directory', 'revision']
5079
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5080
if revision_id_list is not None and revision is not None:
5081
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5082
if revision_id_list is None and revision is None:
5083
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5084
b = WorkingTree.open_containing(directory)[0].branch
5085
self.add_cleanup(b.lock_write().unlock)
5086
return self._run(b, revision_id_list, revision)
5088
def _run(self, b, revision_id_list, revision):
5089
import bzrlib.gpg as gpg
5090
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5091
if revision_id_list is not None:
5092
b.repository.start_write_group()
5094
for revision_id in revision_id_list:
5095
b.repository.sign_revision(revision_id, gpg_strategy)
5097
b.repository.abort_write_group()
5100
b.repository.commit_write_group()
5101
elif revision is not None:
5102
if len(revision) == 1:
5103
revno, rev_id = revision[0].in_history(b)
5104
b.repository.start_write_group()
5106
b.repository.sign_revision(rev_id, gpg_strategy)
5108
b.repository.abort_write_group()
5111
b.repository.commit_write_group()
5112
elif len(revision) == 2:
5113
# are they both on rh- if so we can walk between them
5114
# might be nice to have a range helper for arbitrary
5115
# revision paths. hmm.
5116
from_revno, from_revid = revision[0].in_history(b)
5117
to_revno, to_revid = revision[1].in_history(b)
5118
if to_revid is None:
5119
to_revno = b.revno()
5120
if from_revno is None or to_revno is None:
5121
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5122
b.repository.start_write_group()
5124
for revno in range(from_revno, to_revno + 1):
5125
b.repository.sign_revision(b.get_rev_id(revno),
5128
b.repository.abort_write_group()
5131
b.repository.commit_write_group()
5133
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5136
class cmd_bind(Command):
5137
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5138
If no branch is supplied, rebind to the last bound location.
5140
Once converted into a checkout, commits must succeed on the master branch
5141
before they will be applied to the local branch.
5143
Bound branches use the nickname of its master branch unless it is set
5144
locally, in which case binding will update the local nickname to be
5148
_see_also = ['checkouts', 'unbind']
5149
takes_args = ['location?']
5150
takes_options = ['directory']
5152
def run(self, location=None, directory=u'.'):
5153
b, relpath = Branch.open_containing(directory)
5154
if location is None:
5156
location = b.get_old_bound_location()
5157
except errors.UpgradeRequired:
5158
raise errors.BzrCommandError(gettext('No location supplied. '
5159
'This format does not remember old locations.'))
5161
if location is None:
5162
if b.get_bound_location() is not None:
5163
raise errors.BzrCommandError(gettext('Branch is already bound'))
5165
raise errors.BzrCommandError(gettext('No location supplied '
5166
'and no previous location known'))
5167
b_other = Branch.open(location)
5170
except errors.DivergedBranches:
5171
raise errors.BzrCommandError(gettext('These branches have diverged.'
5172
' Try merging, and then bind again.'))
5173
if b.get_config().has_explicit_nickname():
5174
b.nick = b_other.nick
5177
class cmd_unbind(Command):
5178
__doc__ = """Convert the current checkout into a regular branch.
5180
After unbinding, the local branch is considered independent and subsequent
5181
commits will be local only.
5184
_see_also = ['checkouts', 'bind']
5186
takes_options = ['directory']
5188
def run(self, directory=u'.'):
5189
b, relpath = Branch.open_containing(directory)
5191
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5194
class cmd_uncommit(Command):
5195
__doc__ = """Remove the last committed revision.
5197
--verbose will print out what is being removed.
5198
--dry-run will go through all the motions, but not actually
5201
If --revision is specified, uncommit revisions to leave the branch at the
5202
specified revision. For example, "bzr uncommit -r 15" will leave the
5203
branch at revision 15.
5205
Uncommit leaves the working tree ready for a new commit. The only change
5206
it may make is to restore any pending merges that were present before
5210
# TODO: jam 20060108 Add an option to allow uncommit to remove
5211
# unreferenced information in 'branch-as-repository' branches.
5212
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5213
# information in shared branches as well.
5214
_see_also = ['commit']
5215
takes_options = ['verbose', 'revision',
5216
Option('dry-run', help='Don\'t actually make changes.'),
5217
Option('force', help='Say yes to all questions.'),
5219
help='Keep tags that point to removed revisions.'),
5221
help="Only remove the commits from the local branch"
5222
" when in a checkout."
5225
takes_args = ['location?']
5227
encoding_type = 'replace'
5229
def run(self, location=None, dry_run=False, verbose=False,
5230
revision=None, force=False, local=False, keep_tags=False):
5231
if location is None:
5233
control, relpath = controldir.ControlDir.open_containing(location)
5235
tree = control.open_workingtree()
5237
except (errors.NoWorkingTree, errors.NotLocalUrl):
5239
b = control.open_branch()
5241
if tree is not None:
5242
self.add_cleanup(tree.lock_write().unlock)
5244
self.add_cleanup(b.lock_write().unlock)
5245
return self._run(b, tree, dry_run, verbose, revision, force,
5248
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5250
from bzrlib.log import log_formatter, show_log
5251
from bzrlib.uncommit import uncommit
5253
last_revno, last_rev_id = b.last_revision_info()
5256
if revision is None:
5258
rev_id = last_rev_id
5260
# 'bzr uncommit -r 10' actually means uncommit
5261
# so that the final tree is at revno 10.
5262
# but bzrlib.uncommit.uncommit() actually uncommits
5263
# the revisions that are supplied.
5264
# So we need to offset it by one
5265
revno = revision[0].in_history(b).revno + 1
5266
if revno <= last_revno:
5267
rev_id = b.get_rev_id(revno)
5269
if rev_id is None or _mod_revision.is_null(rev_id):
5270
self.outf.write(gettext('No revisions to uncommit.\n'))
5273
lf = log_formatter('short',
5275
show_timezone='original')
5280
direction='forward',
5281
start_revision=revno,
5282
end_revision=last_revno)
5285
self.outf.write(gettext('Dry-run, pretending to remove'
5286
' the above revisions.\n'))
5288
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5291
if not ui.ui_factory.confirm_action(
5292
gettext(u'Uncommit these revisions'),
5293
'bzrlib.builtins.uncommit',
5295
self.outf.write(gettext('Canceled\n'))
5298
mutter('Uncommitting from {%s} to {%s}',
5299
last_rev_id, rev_id)
5300
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5301
revno=revno, local=local, keep_tags=keep_tags)
5302
self.outf.write(gettext('You can restore the old tip by running:\n'
5303
' bzr pull . -r revid:%s\n') % last_rev_id)
5306
class cmd_break_lock(Command):
5307
__doc__ = """Break a dead lock.
5309
This command breaks a lock on a repository, branch, working directory or
5312
CAUTION: Locks should only be broken when you are sure that the process
5313
holding the lock has been stopped.
5315
You can get information on what locks are open via the 'bzr info
5316
[location]' command.
5320
bzr break-lock bzr+ssh://example.com/bzr/foo
5321
bzr break-lock --conf ~/.bazaar
5324
takes_args = ['location?']
5327
help='LOCATION is the directory where the config lock is.'),
5329
help='Do not ask for confirmation before breaking the lock.'),
5332
def run(self, location=None, config=False, force=False):
5333
if location is None:
5336
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5338
{'bzrlib.lockdir.break': True})
5340
conf = _mod_config.LockableConfig(file_name=location)
5343
control, relpath = controldir.ControlDir.open_containing(location)
5345
control.break_lock()
5346
except NotImplementedError:
5350
class cmd_wait_until_signalled(Command):
5351
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5353
This just prints a line to signal when it is ready, then blocks on stdin.
5359
sys.stdout.write("running\n")
5361
sys.stdin.readline()
5364
class cmd_serve(Command):
5365
__doc__ = """Run the bzr server."""
5367
aliases = ['server']
5371
help='Serve on stdin/out for use from inetd or sshd.'),
5372
RegistryOption('protocol',
5373
help="Protocol to serve.",
5374
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5375
value_switches=True),
5377
help='Listen for connections on nominated port of the form '
5378
'[hostname:]portnumber. Passing 0 as the port number will '
5379
'result in a dynamically allocated port. The default port '
5380
'depends on the protocol.',
5382
custom_help('directory',
5383
help='Serve contents of this directory.'),
5384
Option('allow-writes',
5385
help='By default the server is a readonly server. Supplying '
5386
'--allow-writes enables write access to the contents of '
5387
'the served directory and below. Note that ``bzr serve`` '
5388
'does not perform authentication, so unless some form of '
5389
'external authentication is arranged supplying this '
5390
'option leads to global uncontrolled write access to your '
5393
Option('client-timeout', type=float,
5394
help='Override the default idle client timeout (5min).'),
5397
def get_host_and_port(self, port):
5398
"""Return the host and port to run the smart server on.
5400
If 'port' is None, None will be returned for the host and port.
5402
If 'port' has a colon in it, the string before the colon will be
5403
interpreted as the host.
5405
:param port: A string of the port to run the server on.
5406
:return: A tuple of (host, port), where 'host' is a host name or IP,
5407
and port is an integer TCP/IP port.
5410
if port is not None:
5412
host, port = port.split(':')
5416
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5417
protocol=None, client_timeout=None):
5418
from bzrlib import transport
5419
if directory is None:
5420
directory = os.getcwd()
5421
if protocol is None:
5422
protocol = transport.transport_server_registry.get()
5423
host, port = self.get_host_and_port(port)
5424
url = transport.location_to_url(directory)
5425
if not allow_writes:
5426
url = 'readonly+' + url
5427
t = transport.get_transport_from_url(url)
5429
protocol(t, host, port, inet, client_timeout)
5430
except TypeError, e:
5431
# We use symbol_versioning.deprecated_in just so that people
5432
# grepping can find it here.
5433
# symbol_versioning.deprecated_in((2, 5, 0))
5434
symbol_versioning.warn(
5435
'Got TypeError(%s)\ntrying to call protocol: %s.%s\n'
5436
'Most likely it needs to be updated to support a'
5437
' "timeout" parameter (added in bzr 2.5.0)'
5438
% (e, protocol.__module__, protocol),
5440
protocol(t, host, port, inet)
5443
class cmd_join(Command):
5444
__doc__ = """Combine a tree into its containing tree.
5446
This command requires the target tree to be in a rich-root format.
5448
The TREE argument should be an independent tree, inside another tree, but
5449
not part of it. (Such trees can be produced by "bzr split", but also by
5450
running "bzr branch" with the target inside a tree.)
5452
The result is a combined tree, with the subtree no longer an independent
5453
part. This is marked as a merge of the subtree into the containing tree,
5454
and all history is preserved.
5457
_see_also = ['split']
5458
takes_args = ['tree']
5460
Option('reference', help='Join by reference.', hidden=True),
5463
def run(self, tree, reference=False):
5464
sub_tree = WorkingTree.open(tree)
5465
parent_dir = osutils.dirname(sub_tree.basedir)
5466
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5467
repo = containing_tree.branch.repository
5468
if not repo.supports_rich_root():
5469
raise errors.BzrCommandError(gettext(
5470
"Can't join trees because %s doesn't support rich root data.\n"
5471
"You can use bzr upgrade on the repository.")
5475
containing_tree.add_reference(sub_tree)
5476
except errors.BadReferenceTarget, e:
5477
# XXX: Would be better to just raise a nicely printable
5478
# exception from the real origin. Also below. mbp 20070306
5479
raise errors.BzrCommandError(
5480
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5483
containing_tree.subsume(sub_tree)
5484
except errors.BadSubsumeSource, e:
5485
raise errors.BzrCommandError(
5486
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5489
class cmd_split(Command):
5490
__doc__ = """Split a subdirectory of a tree into a separate tree.
5492
This command will produce a target tree in a format that supports
5493
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5494
converted into earlier formats like 'dirstate-tags'.
5496
The TREE argument should be a subdirectory of a working tree. That
5497
subdirectory will be converted into an independent tree, with its own
5498
branch. Commits in the top-level tree will not apply to the new subtree.
5501
_see_also = ['join']
5502
takes_args = ['tree']
5504
def run(self, tree):
5505
containing_tree, subdir = WorkingTree.open_containing(tree)
5506
sub_id = containing_tree.path2id(subdir)
5508
raise errors.NotVersionedError(subdir)
5510
containing_tree.extract(sub_id)
5511
except errors.RootNotRich:
5512
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5515
class cmd_merge_directive(Command):
5516
__doc__ = """Generate a merge directive for auto-merge tools.
5518
A directive requests a merge to be performed, and also provides all the
5519
information necessary to do so. This means it must either include a
5520
revision bundle, or the location of a branch containing the desired
5523
A submit branch (the location to merge into) must be supplied the first
5524
time the command is issued. After it has been supplied once, it will
5525
be remembered as the default.
5527
A public branch is optional if a revision bundle is supplied, but required
5528
if --diff or --plain is specified. It will be remembered as the default
5529
after the first use.
5532
takes_args = ['submit_branch?', 'public_branch?']
5536
_see_also = ['send']
5540
RegistryOption.from_kwargs('patch-type',
5541
'The type of patch to include in the directive.',
5543
value_switches=True,
5545
bundle='Bazaar revision bundle (default).',
5546
diff='Normal unified diff.',
5547
plain='No patch, just directive.'),
5548
Option('sign', help='GPG-sign the directive.'), 'revision',
5549
Option('mail-to', type=str,
5550
help='Instead of printing the directive, email to this address.'),
5551
Option('message', type=str, short_name='m',
5552
help='Message to use when committing this merge.')
5555
encoding_type = 'exact'
5557
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5558
sign=False, revision=None, mail_to=None, message=None,
5560
from bzrlib.revision import ensure_null, NULL_REVISION
5561
include_patch, include_bundle = {
5562
'plain': (False, False),
5563
'diff': (True, False),
5564
'bundle': (True, True),
5566
branch = Branch.open(directory)
5567
stored_submit_branch = branch.get_submit_branch()
5568
if submit_branch is None:
5569
submit_branch = stored_submit_branch
5571
if stored_submit_branch is None:
5572
branch.set_submit_branch(submit_branch)
5573
if submit_branch is None:
5574
submit_branch = branch.get_parent()
5575
if submit_branch is None:
5576
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5578
stored_public_branch = branch.get_public_branch()
5579
if public_branch is None:
5580
public_branch = stored_public_branch
5581
elif stored_public_branch is None:
5582
branch.set_public_branch(public_branch)
5583
if not include_bundle and public_branch is None:
5584
raise errors.BzrCommandError(gettext('No public branch specified or'
5586
base_revision_id = None
5587
if revision is not None:
5588
if len(revision) > 2:
5589
raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5590
'at most two one revision identifiers'))
5591
revision_id = revision[-1].as_revision_id(branch)
5592
if len(revision) == 2:
5593
base_revision_id = revision[0].as_revision_id(branch)
5595
revision_id = branch.last_revision()
5596
revision_id = ensure_null(revision_id)
5597
if revision_id == NULL_REVISION:
5598
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5599
directive = merge_directive.MergeDirective2.from_objects(
5600
branch.repository, revision_id, time.time(),
5601
osutils.local_time_offset(), submit_branch,
5602
public_branch=public_branch, include_patch=include_patch,
5603
include_bundle=include_bundle, message=message,
5604
base_revision_id=base_revision_id)
5607
self.outf.write(directive.to_signed(branch))
5609
self.outf.writelines(directive.to_lines())
5611
message = directive.to_email(mail_to, branch, sign)
5612
s = SMTPConnection(branch.get_config_stack())
5613
s.send_email(message)
5616
class cmd_send(Command):
5617
__doc__ = """Mail or create a merge-directive for submitting changes.
5619
A merge directive provides many things needed for requesting merges:
5621
* A machine-readable description of the merge to perform
5623
* An optional patch that is a preview of the changes requested
5625
* An optional bundle of revision data, so that the changes can be applied
5626
directly from the merge directive, without retrieving data from a
5629
`bzr send` creates a compact data set that, when applied using bzr
5630
merge, has the same effect as merging from the source branch.
5632
By default the merge directive is self-contained and can be applied to any
5633
branch containing submit_branch in its ancestory without needing access to
5636
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5637
revisions, but only a structured request to merge from the
5638
public_location. In that case the public_branch is needed and it must be
5639
up-to-date and accessible to the recipient. The public_branch is always
5640
included if known, so that people can check it later.
5642
The submit branch defaults to the parent of the source branch, but can be
5643
overridden. Both submit branch and public branch will be remembered in
5644
branch.conf the first time they are used for a particular branch. The
5645
source branch defaults to that containing the working directory, but can
5646
be changed using --from.
5648
Both the submit branch and the public branch follow the usual behavior with
5649
respect to --remember: If there is no default location set, the first send
5650
will set it (use --no-remember to avoid setting it). After that, you can
5651
omit the location to use the default. To change the default, use
5652
--remember. The value will only be saved if the location can be accessed.
5654
In order to calculate those changes, bzr must analyse the submit branch.
5655
Therefore it is most efficient for the submit branch to be a local mirror.
5656
If a public location is known for the submit_branch, that location is used
5657
in the merge directive.
5659
The default behaviour is to send the merge directive by mail, unless -o is
5660
given, in which case it is sent to a file.
5662
Mail is sent using your preferred mail program. This should be transparent
5663
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5664
If the preferred client can't be found (or used), your editor will be used.
5666
To use a specific mail program, set the mail_client configuration option.
5667
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5668
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5669
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5670
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5673
If mail is being sent, a to address is required. This can be supplied
5674
either on the commandline, by setting the submit_to configuration
5675
option in the branch itself or the child_submit_to configuration option
5676
in the submit branch.
5678
Two formats are currently supported: "4" uses revision bundle format 4 and
5679
merge directive format 2. It is significantly faster and smaller than
5680
older formats. It is compatible with Bazaar 0.19 and later. It is the
5681
default. "0.9" uses revision bundle format 0.9 and merge directive
5682
format 1. It is compatible with Bazaar 0.12 - 0.18.
5684
The merge directives created by bzr send may be applied using bzr merge or
5685
bzr pull by specifying a file containing a merge directive as the location.
5687
bzr send makes extensive use of public locations to map local locations into
5688
URLs that can be used by other people. See `bzr help configuration` to
5689
set them, and use `bzr info` to display them.
5692
encoding_type = 'exact'
5694
_see_also = ['merge', 'pull']
5696
takes_args = ['submit_branch?', 'public_branch?']
5700
help='Do not include a bundle in the merge directive.'),
5701
Option('no-patch', help='Do not include a preview patch in the merge'
5704
help='Remember submit and public branch.'),
5706
help='Branch to generate the submission from, '
5707
'rather than the one containing the working directory.',
5710
Option('output', short_name='o',
5711
help='Write merge directive to this file or directory; '
5712
'use - for stdout.',
5715
help='Refuse to send if there are uncommitted changes in'
5716
' the working tree, --no-strict disables the check.'),
5717
Option('mail-to', help='Mail the request to this address.',
5721
Option('body', help='Body for the email.', type=unicode),
5722
RegistryOption('format',
5723
help='Use the specified output format.',
5724
lazy_registry=('bzrlib.send', 'format_registry')),
5727
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5728
no_patch=False, revision=None, remember=None, output=None,
5729
format=None, mail_to=None, message=None, body=None,
5730
strict=None, **kwargs):
5731
from bzrlib.send import send
5732
return send(submit_branch, revision, public_branch, remember,
5733
format, no_bundle, no_patch, output,
5734
kwargs.get('from', '.'), mail_to, message, body,
5739
class cmd_bundle_revisions(cmd_send):
5740
__doc__ = """Create a merge-directive for submitting changes.
5742
A merge directive provides many things needed for requesting merges:
5744
* A machine-readable description of the merge to perform
5746
* An optional patch that is a preview of the changes requested
5748
* An optional bundle of revision data, so that the changes can be applied
5749
directly from the merge directive, without retrieving data from a
5752
If --no-bundle is specified, then public_branch is needed (and must be
5753
up-to-date), so that the receiver can perform the merge using the
5754
public_branch. The public_branch is always included if known, so that
5755
people can check it later.
5757
The submit branch defaults to the parent, but can be overridden. Both
5758
submit branch and public branch will be remembered if supplied.
5760
If a public_branch is known for the submit_branch, that public submit
5761
branch is used in the merge instructions. This means that a local mirror
5762
can be used as your actual submit branch, once you have set public_branch
5765
Two formats are currently supported: "4" uses revision bundle format 4 and
5766
merge directive format 2. It is significantly faster and smaller than
5767
older formats. It is compatible with Bazaar 0.19 and later. It is the
5768
default. "0.9" uses revision bundle format 0.9 and merge directive
5769
format 1. It is compatible with Bazaar 0.12 - 0.18.
5774
help='Do not include a bundle in the merge directive.'),
5775
Option('no-patch', help='Do not include a preview patch in the merge'
5778
help='Remember submit and public branch.'),
5780
help='Branch to generate the submission from, '
5781
'rather than the one containing the working directory.',
5784
Option('output', short_name='o', help='Write directive to this file.',
5787
help='Refuse to bundle revisions if there are uncommitted'
5788
' changes in the working tree, --no-strict disables the check.'),
5790
RegistryOption('format',
5791
help='Use the specified output format.',
5792
lazy_registry=('bzrlib.send', 'format_registry')),
5794
aliases = ['bundle']
5796
_see_also = ['send', 'merge']
5800
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5801
no_patch=False, revision=None, remember=False, output=None,
5802
format=None, strict=None, **kwargs):
5805
from bzrlib.send import send
5806
return send(submit_branch, revision, public_branch, remember,
5807
format, no_bundle, no_patch, output,
5808
kwargs.get('from', '.'), None, None, None,
5809
self.outf, strict=strict)
5812
class cmd_tag(Command):
5813
__doc__ = """Create, remove or modify a tag naming a revision.
5815
Tags give human-meaningful names to revisions. Commands that take a -r
5816
(--revision) option can be given -rtag:X, where X is any previously
5819
Tags are stored in the branch. Tags are copied from one branch to another
5820
along when you branch, push, pull or merge.
5822
It is an error to give a tag name that already exists unless you pass
5823
--force, in which case the tag is moved to point to the new revision.
5825
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5826
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5828
If no tag name is specified it will be determined through the
5829
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5830
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5834
_see_also = ['commit', 'tags']
5835
takes_args = ['tag_name?']
5838
help='Delete this tag rather than placing it.',
5840
custom_help('directory',
5841
help='Branch in which to place the tag.'),
5843
help='Replace existing tags.',
5848
def run(self, tag_name=None,
5854
branch, relpath = Branch.open_containing(directory)
5855
self.add_cleanup(branch.lock_write().unlock)
5857
if tag_name is None:
5858
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5859
branch.tags.delete_tag(tag_name)
5860
note(gettext('Deleted tag %s.') % tag_name)
5863
if len(revision) != 1:
5864
raise errors.BzrCommandError(gettext(
5865
"Tags can only be placed on a single revision, "
5867
revision_id = revision[0].as_revision_id(branch)
5869
revision_id = branch.last_revision()
5870
if tag_name is None:
5871
tag_name = branch.automatic_tag_name(revision_id)
5872
if tag_name is None:
5873
raise errors.BzrCommandError(gettext(
5874
"Please specify a tag name."))
5876
existing_target = branch.tags.lookup_tag(tag_name)
5877
except errors.NoSuchTag:
5878
existing_target = None
5879
if not force and existing_target not in (None, revision_id):
5880
raise errors.TagAlreadyExists(tag_name)
5881
if existing_target == revision_id:
5882
note(gettext('Tag %s already exists for that revision.') % tag_name)
5884
branch.tags.set_tag(tag_name, revision_id)
5885
if existing_target is None:
5886
note(gettext('Created tag %s.') % tag_name)
5888
note(gettext('Updated tag %s.') % tag_name)
5891
class cmd_tags(Command):
5892
__doc__ = """List tags.
5894
This command shows a table of tag names and the revisions they reference.
5899
custom_help('directory',
5900
help='Branch whose tags should be displayed.'),
5901
RegistryOption('sort',
5902
'Sort tags by different criteria.', title='Sorting',
5903
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5910
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5911
from bzrlib.tag import tag_sort_methods
5912
branch, relpath = Branch.open_containing(directory)
5914
tags = branch.tags.get_tag_dict().items()
5918
self.add_cleanup(branch.lock_read().unlock)
5920
# Restrict to the specified range
5921
tags = self._tags_for_range(branch, revision)
5923
sort = tag_sort_methods.get()
5926
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5927
for index, (tag, revid) in enumerate(tags):
5929
revno = branch.revision_id_to_dotted_revno(revid)
5930
if isinstance(revno, tuple):
5931
revno = '.'.join(map(str, revno))
5932
except (errors.NoSuchRevision,
5933
errors.GhostRevisionsHaveNoRevno,
5934
errors.UnsupportedOperation):
5935
# Bad tag data/merges can lead to tagged revisions
5936
# which are not in this branch. Fail gracefully ...
5938
tags[index] = (tag, revno)
5940
for tag, revspec in tags:
5941
self.outf.write('%-20s %s\n' % (tag, revspec))
5943
def _tags_for_range(self, branch, revision):
5945
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5946
revid1, revid2 = rev1.rev_id, rev2.rev_id
5947
# _get_revision_range will always set revid2 if it's not specified.
5948
# If revid1 is None, it means we want to start from the branch
5949
# origin which is always a valid ancestor. If revid1 == revid2, the
5950
# ancestry check is useless.
5951
if revid1 and revid1 != revid2:
5952
# FIXME: We really want to use the same graph than
5953
# branch.iter_merge_sorted_revisions below, but this is not
5954
# easily available -- vila 2011-09-23
5955
if branch.repository.get_graph().is_ancestor(revid2, revid1):
5956
# We don't want to output anything in this case...
5958
# only show revisions between revid1 and revid2 (inclusive)
5959
tagged_revids = branch.tags.get_reverse_tag_dict()
5961
for r in branch.iter_merge_sorted_revisions(
5962
start_revision_id=revid2, stop_revision_id=revid1,
5963
stop_rule='include'):
5964
revid_tags = tagged_revids.get(r[0], None)
5966
found.extend([(tag, r[0]) for tag in revid_tags])
5970
class cmd_reconfigure(Command):
5971
__doc__ = """Reconfigure the type of a bzr directory.
5973
A target configuration must be specified.
5975
For checkouts, the bind-to location will be auto-detected if not specified.
5976
The order of preference is
5977
1. For a lightweight checkout, the current bound location.
5978
2. For branches that used to be checkouts, the previously-bound location.
5979
3. The push location.
5980
4. The parent location.
5981
If none of these is available, --bind-to must be specified.
5984
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5985
takes_args = ['location?']
5987
RegistryOption.from_kwargs(
5990
help='The relation between branch and tree.',
5991
value_switches=True, enum_switch=False,
5992
branch='Reconfigure to be an unbound branch with no working tree.',
5993
tree='Reconfigure to be an unbound branch with a working tree.',
5994
checkout='Reconfigure to be a bound branch with a working tree.',
5995
lightweight_checkout='Reconfigure to be a lightweight'
5996
' checkout (with no local history).',
5998
RegistryOption.from_kwargs(
6000
title='Repository type',
6001
help='Location fo the repository.',
6002
value_switches=True, enum_switch=False,
6003
standalone='Reconfigure to be a standalone branch '
6004
'(i.e. stop using shared repository).',
6005
use_shared='Reconfigure to use a shared repository.',
6007
RegistryOption.from_kwargs(
6009
title='Trees in Repository',
6010
help='Whether new branches in the repository have trees.',
6011
value_switches=True, enum_switch=False,
6012
with_trees='Reconfigure repository to create '
6013
'working trees on branches by default.',
6014
with_no_trees='Reconfigure repository to not create '
6015
'working trees on branches by default.'
6017
Option('bind-to', help='Branch to bind checkout to.', type=str),
6019
help='Perform reconfiguration even if local changes'
6021
Option('stacked-on',
6022
help='Reconfigure a branch to be stacked on another branch.',
6026
help='Reconfigure a branch to be unstacked. This '
6027
'may require copying substantial data into it.',
6031
def run(self, location=None, bind_to=None, force=False,
6032
tree_type=None, repository_type=None, repository_trees=None,
6033
stacked_on=None, unstacked=None):
6034
directory = controldir.ControlDir.open(location)
6035
if stacked_on and unstacked:
6036
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6037
elif stacked_on is not None:
6038
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6040
reconfigure.ReconfigureUnstacked().apply(directory)
6041
# At the moment you can use --stacked-on and a different
6042
# reconfiguration shape at the same time; there seems no good reason
6044
if (tree_type is None and
6045
repository_type is None and
6046
repository_trees is None):
6047
if stacked_on or unstacked:
6050
raise errors.BzrCommandError(gettext('No target configuration '
6052
reconfiguration = None
6053
if tree_type == 'branch':
6054
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6055
elif tree_type == 'tree':
6056
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6057
elif tree_type == 'checkout':
6058
reconfiguration = reconfigure.Reconfigure.to_checkout(
6060
elif tree_type == 'lightweight-checkout':
6061
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6064
reconfiguration.apply(force)
6065
reconfiguration = None
6066
if repository_type == 'use-shared':
6067
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6068
elif repository_type == 'standalone':
6069
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6071
reconfiguration.apply(force)
6072
reconfiguration = None
6073
if repository_trees == 'with-trees':
6074
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6076
elif repository_trees == 'with-no-trees':
6077
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6080
reconfiguration.apply(force)
6081
reconfiguration = None
6084
class cmd_switch(Command):
6085
__doc__ = """Set the branch of a checkout and update.
6087
For lightweight checkouts, this changes the branch being referenced.
6088
For heavyweight checkouts, this checks that there are no local commits
6089
versus the current bound branch, then it makes the local branch a mirror
6090
of the new location and binds to it.
6092
In both cases, the working tree is updated and uncommitted changes
6093
are merged. The user can commit or revert these as they desire.
6095
Pending merges need to be committed or reverted before using switch.
6097
The path to the branch to switch to can be specified relative to the parent
6098
directory of the current branch. For example, if you are currently in a
6099
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6102
Bound branches use the nickname of its master branch unless it is set
6103
locally, in which case switching will update the local nickname to be
6107
takes_args = ['to_location?']
6108
takes_options = ['directory',
6110
help='Switch even if local commits will be lost.'),
6112
Option('create-branch', short_name='b',
6113
help='Create the target branch from this one before'
6114
' switching to it.'),
6117
def run(self, to_location=None, force=False, create_branch=False,
6118
revision=None, directory=u'.'):
6119
from bzrlib import switch
6120
tree_location = directory
6121
revision = _get_one_revision('switch', revision)
6122
control_dir = controldir.ControlDir.open_containing(tree_location)[0]
6123
if to_location is None:
6124
if revision is None:
6125
raise errors.BzrCommandError(gettext('You must supply either a'
6126
' revision or a location'))
6127
to_location = tree_location
6129
branch = control_dir.open_branch()
6130
had_explicit_nick = branch.get_config().has_explicit_nickname()
6131
except errors.NotBranchError:
6133
had_explicit_nick = False
6136
raise errors.BzrCommandError(gettext('cannot create branch without'
6138
to_location = directory_service.directories.dereference(
6140
if '/' not in to_location and '\\' not in to_location:
6141
# This path is meant to be relative to the existing branch
6142
this_url = self._get_branch_location(control_dir)
6143
# Perhaps the target control dir supports colocated branches?
6145
root = controldir.ControlDir.open(this_url,
6146
possible_transports=[control_dir.user_transport])
6147
except errors.NotBranchError:
6150
colocated = root._format.colocated_branches
6152
to_location = urlutils.join_segment_parameters(this_url,
6153
{"branch": urlutils.escape(to_location)})
6155
to_location = urlutils.join(
6156
this_url, '..', urlutils.escape(to_location))
6157
to_branch = branch.bzrdir.sprout(to_location,
6158
possible_transports=[branch.bzrdir.root_transport],
6159
source_branch=branch).open_branch()
6161
# Perhaps it's a colocated branch?
6163
to_branch = control_dir.open_branch(to_location)
6164
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
6166
to_branch = Branch.open(to_location)
6167
except errors.NotBranchError:
6168
this_url = self._get_branch_location(control_dir)
6169
to_branch = Branch.open(
6171
this_url, '..', urlutils.escape(to_location)))
6172
if revision is not None:
6173
revision = revision.as_revision_id(to_branch)
6174
switch.switch(control_dir, to_branch, force, revision_id=revision)
6175
if had_explicit_nick:
6176
branch = control_dir.open_branch() #get the new branch!
6177
branch.nick = to_branch.nick
6178
note(gettext('Switched to branch: %s'),
6179
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6181
def _get_branch_location(self, control_dir):
6182
"""Return location of branch for this control dir."""
6184
this_branch = control_dir.open_branch()
6185
# This may be a heavy checkout, where we want the master branch
6186
master_location = this_branch.get_bound_location()
6187
if master_location is not None:
6188
return master_location
6189
# If not, use a local sibling
6190
return this_branch.base
6191
except errors.NotBranchError:
6192
format = control_dir.find_branch_format()
6193
if getattr(format, 'get_reference', None) is not None:
6194
return format.get_reference(control_dir)
6196
return control_dir.root_transport.base
6199
class cmd_view(Command):
6200
__doc__ = """Manage filtered views.
6202
Views provide a mask over the tree so that users can focus on
6203
a subset of a tree when doing their work. After creating a view,
6204
commands that support a list of files - status, diff, commit, etc -
6205
effectively have that list of files implicitly given each time.
6206
An explicit list of files can still be given but those files
6207
must be within the current view.
6209
In most cases, a view has a short life-span: it is created to make
6210
a selected change and is deleted once that change is committed.
6211
At other times, you may wish to create one or more named views
6212
and switch between them.
6214
To disable the current view without deleting it, you can switch to
6215
the pseudo view called ``off``. This can be useful when you need
6216
to see the whole tree for an operation or two (e.g. merge) but
6217
want to switch back to your view after that.
6220
To define the current view::
6222
bzr view file1 dir1 ...
6224
To list the current view::
6228
To delete the current view::
6232
To disable the current view without deleting it::
6234
bzr view --switch off
6236
To define a named view and switch to it::
6238
bzr view --name view-name file1 dir1 ...
6240
To list a named view::
6242
bzr view --name view-name
6244
To delete a named view::
6246
bzr view --name view-name --delete
6248
To switch to a named view::
6250
bzr view --switch view-name
6252
To list all views defined::
6256
To delete all views::
6258
bzr view --delete --all
6262
takes_args = ['file*']
6265
help='Apply list or delete action to all views.',
6268
help='Delete the view.',
6271
help='Name of the view to define, list or delete.',
6275
help='Name of the view to switch to.',
6280
def run(self, file_list,
6286
tree, file_list = WorkingTree.open_containing_paths(file_list,
6288
current_view, view_dict = tree.views.get_view_info()
6293
raise errors.BzrCommandError(gettext(
6294
"Both --delete and a file list specified"))
6296
raise errors.BzrCommandError(gettext(
6297
"Both --delete and --switch specified"))
6299
tree.views.set_view_info(None, {})
6300
self.outf.write(gettext("Deleted all views.\n"))
6302
raise errors.BzrCommandError(gettext("No current view to delete"))
6304
tree.views.delete_view(name)
6305
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6308
raise errors.BzrCommandError(gettext(
6309
"Both --switch and a file list specified"))
6311
raise errors.BzrCommandError(gettext(
6312
"Both --switch and --all specified"))
6313
elif switch == 'off':
6314
if current_view is None:
6315
raise errors.BzrCommandError(gettext("No current view to disable"))
6316
tree.views.set_view_info(None, view_dict)
6317
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6319
tree.views.set_view_info(switch, view_dict)
6320
view_str = views.view_display_str(tree.views.lookup_view())
6321
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6324
self.outf.write(gettext('Views defined:\n'))
6325
for view in sorted(view_dict):
6326
if view == current_view:
6330
view_str = views.view_display_str(view_dict[view])
6331
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6333
self.outf.write(gettext('No views defined.\n'))
6336
# No name given and no current view set
6339
raise errors.BzrCommandError(gettext(
6340
"Cannot change the 'off' pseudo view"))
6341
tree.views.set_view(name, sorted(file_list))
6342
view_str = views.view_display_str(tree.views.lookup_view())
6343
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6347
# No name given and no current view set
6348
self.outf.write(gettext('No current view.\n'))
6350
view_str = views.view_display_str(tree.views.lookup_view(name))
6351
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6354
class cmd_hooks(Command):
6355
__doc__ = """Show hooks."""
6360
for hook_key in sorted(hooks.known_hooks.keys()):
6361
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6362
self.outf.write("%s:\n" % type(some_hooks).__name__)
6363
for hook_name, hook_point in sorted(some_hooks.items()):
6364
self.outf.write(" %s:\n" % (hook_name,))
6365
found_hooks = list(hook_point)
6367
for hook in found_hooks:
6368
self.outf.write(" %s\n" %
6369
(some_hooks.get_hook_name(hook),))
6371
self.outf.write(gettext(" <no hooks installed>\n"))
6374
class cmd_remove_branch(Command):
6375
__doc__ = """Remove a branch.
6377
This will remove the branch from the specified location but
6378
will keep any working tree or repository in place.
6382
Remove the branch at repo/trunk::
6384
bzr remove-branch repo/trunk
6388
takes_args = ["location?"]
6390
aliases = ["rmbranch"]
6392
def run(self, location=None):
6393
if location is None:
6395
branch = Branch.open_containing(location)[0]
6396
branch.bzrdir.destroy_branch()
6399
class cmd_shelve(Command):
6400
__doc__ = """Temporarily set aside some changes from the current tree.
6402
Shelve allows you to temporarily put changes you've made "on the shelf",
6403
ie. out of the way, until a later time when you can bring them back from
6404
the shelf with the 'unshelve' command. The changes are stored alongside
6405
your working tree, and so they aren't propagated along with your branch nor
6406
will they survive its deletion.
6408
If shelve --list is specified, previously-shelved changes are listed.
6410
Shelve is intended to help separate several sets of changes that have
6411
been inappropriately mingled. If you just want to get rid of all changes
6412
and you don't need to restore them later, use revert. If you want to
6413
shelve all text changes at once, use shelve --all.
6415
If filenames are specified, only the changes to those files will be
6416
shelved. Other files will be left untouched.
6418
If a revision is specified, changes since that revision will be shelved.
6420
You can put multiple items on the shelf, and by default, 'unshelve' will
6421
restore the most recently shelved changes.
6423
For complicated changes, it is possible to edit the changes in a separate
6424
editor program to decide what the file remaining in the working copy
6425
should look like. To do this, add the configuration option
6427
change_editor = PROGRAM @new_path @old_path
6429
where @new_path is replaced with the path of the new version of the
6430
file and @old_path is replaced with the path of the old version of
6431
the file. The PROGRAM should save the new file with the desired
6432
contents of the file in the working tree.
6436
takes_args = ['file*']
6441
Option('all', help='Shelve all changes.'),
6443
RegistryOption('writer', 'Method to use for writing diffs.',
6444
bzrlib.option.diff_writer_registry,
6445
value_switches=True, enum_switch=False),
6447
Option('list', help='List shelved changes.'),
6449
help='Destroy removed changes instead of shelving them.'),
6451
_see_also = ['unshelve', 'configuration']
6453
def run(self, revision=None, all=False, file_list=None, message=None,
6454
writer=None, list=False, destroy=False, directory=None):
6456
return self.run_for_list(directory=directory)
6457
from bzrlib.shelf_ui import Shelver
6459
writer = bzrlib.option.diff_writer_registry.get()
6461
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6462
file_list, message, destroy=destroy, directory=directory)
6467
except errors.UserAbort:
6470
def run_for_list(self, directory=None):
6471
if directory is None:
6473
tree = WorkingTree.open_containing(directory)[0]
6474
self.add_cleanup(tree.lock_read().unlock)
6475
manager = tree.get_shelf_manager()
6476
shelves = manager.active_shelves()
6477
if len(shelves) == 0:
6478
note(gettext('No shelved changes.'))
6480
for shelf_id in reversed(shelves):
6481
message = manager.get_metadata(shelf_id).get('message')
6483
message = '<no message>'
6484
self.outf.write('%3d: %s\n' % (shelf_id, message))
6488
class cmd_unshelve(Command):
6489
__doc__ = """Restore shelved changes.
6491
By default, the most recently shelved changes are restored. However if you
6492
specify a shelf by id those changes will be restored instead. This works
6493
best when the changes don't depend on each other.
6496
takes_args = ['shelf_id?']
6499
RegistryOption.from_kwargs(
6500
'action', help="The action to perform.",
6501
enum_switch=False, value_switches=True,
6502
apply="Apply changes and remove from the shelf.",
6503
dry_run="Show changes, but do not apply or remove them.",
6504
preview="Instead of unshelving the changes, show the diff that "
6505
"would result from unshelving.",
6506
delete_only="Delete changes without applying them.",
6507
keep="Apply changes but don't delete them.",
6510
_see_also = ['shelve']
6512
def run(self, shelf_id=None, action='apply', directory=u'.'):
6513
from bzrlib.shelf_ui import Unshelver
6514
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6518
unshelver.tree.unlock()
6521
class cmd_clean_tree(Command):
6522
__doc__ = """Remove unwanted files from working tree.
6524
By default, only unknown files, not ignored files, are deleted. Versioned
6525
files are never deleted.
6527
Another class is 'detritus', which includes files emitted by bzr during
6528
normal operations and selftests. (The value of these files decreases with
6531
If no options are specified, unknown files are deleted. Otherwise, option
6532
flags are respected, and may be combined.
6534
To check what clean-tree will do, use --dry-run.
6536
takes_options = ['directory',
6537
Option('ignored', help='Delete all ignored files.'),
6538
Option('detritus', help='Delete conflict files, merge and revert'
6539
' backups, and failed selftest dirs.'),
6541
help='Delete files unknown to bzr (default).'),
6542
Option('dry-run', help='Show files to delete instead of'
6544
Option('force', help='Do not prompt before deleting.')]
6545
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6546
force=False, directory=u'.'):
6547
from bzrlib.clean_tree import clean_tree
6548
if not (unknown or ignored or detritus):
6552
clean_tree(directory, unknown=unknown, ignored=ignored,
6553
detritus=detritus, dry_run=dry_run, no_prompt=force)
6556
class cmd_reference(Command):
6557
__doc__ = """list, view and set branch locations for nested trees.
6559
If no arguments are provided, lists the branch locations for nested trees.
6560
If one argument is provided, display the branch location for that tree.
6561
If two arguments are provided, set the branch location for that tree.
6566
takes_args = ['path?', 'location?']
6568
def run(self, path=None, location=None):
6570
if path is not None:
6572
tree, branch, relpath =(
6573
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6574
if path is not None:
6577
tree = branch.basis_tree()
6579
info = branch._get_all_reference_info().iteritems()
6580
self._display_reference_info(tree, branch, info)
6582
file_id = tree.path2id(path)
6584
raise errors.NotVersionedError(path)
6585
if location is None:
6586
info = [(file_id, branch.get_reference_info(file_id))]
6587
self._display_reference_info(tree, branch, info)
6589
branch.set_reference_info(file_id, path, location)
6591
def _display_reference_info(self, tree, branch, info):
6593
for file_id, (path, location) in info:
6595
path = tree.id2path(file_id)
6596
except errors.NoSuchId:
6598
ref_list.append((path, location))
6599
for path, location in sorted(ref_list):
6600
self.outf.write('%s %s\n' % (path, location))
6603
class cmd_export_pot(Command):
6604
__doc__ = """Export command helps and error messages in po format."""
6607
takes_options = [Option('plugin',
6608
help='Export help text from named command '\
6609
'(defaults to all built in commands).',
6611
Option('include-duplicates',
6612
help='Output multiple copies of the same msgid '
6613
'string if it appears more than once.'),
6616
def run(self, plugin=None, include_duplicates=False):
6617
from bzrlib.export_pot import export_pot
6618
export_pot(self.outf, plugin, include_duplicates)
6621
def _register_lazy_builtins():
6622
# register lazy builtins from other modules; called at startup and should
6623
# be only called once.
6624
for (name, aliases, module_name) in [
6625
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6626
('cmd_config', [], 'bzrlib.config'),
6627
('cmd_dpush', [], 'bzrlib.foreign'),
6628
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6629
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6630
('cmd_conflicts', [], 'bzrlib.conflicts'),
6631
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6632
('cmd_verify_signatures', [],
6633
'bzrlib.commit_signature_commands'),
6634
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6636
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
