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 import lazy_import
26
lazy_import.lazy_import(globals(), """
40
config as _mod_config,
50
revision as _mod_revision,
59
from bzrlib.branch import Branch
60
from bzrlib.conflicts import ConflictList
61
from bzrlib.transport import memory
62
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
63
from bzrlib.smtp_connection import SMTPConnection
64
from bzrlib.workingtree import WorkingTree
65
from bzrlib.i18n import gettext, ngettext
68
from bzrlib.commands import (
70
builtin_command_registry,
73
from bzrlib.option import (
80
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
86
def _get_branch_location(control_dir, possible_transports=None):
87
"""Return location of branch for this control dir."""
89
this_branch = control_dir.open_branch(
90
possible_transports=possible_transports)
91
# This may be a heavy checkout, where we want the master branch
92
master_location = this_branch.get_bound_location()
93
if master_location is not None:
94
return master_location
95
# If not, use a local sibling
96
return this_branch.base
97
except errors.NotBranchError:
98
format = control_dir.find_branch_format()
99
if getattr(format, 'get_reference', None) is not None:
100
return format.get_reference(control_dir)
102
return control_dir.root_transport.base
105
def _is_colocated(control_dir, possible_transports=None):
106
"""Check if the branch in control_dir is colocated.
108
:param control_dir: Control directory
109
:return: Boolean indicating whether
111
# This path is meant to be relative to the existing branch
112
this_url = _get_branch_location(control_dir,
113
possible_transports=possible_transports)
114
# Perhaps the target control dir supports colocated branches?
116
root = controldir.ControlDir.open(this_url,
117
possible_transports=possible_transports)
118
except errors.NotBranchError:
119
return (False, this_url)
122
wt = control_dir.open_workingtree()
123
except (errors.NoWorkingTree, errors.NotLocalUrl):
124
return (False, this_url)
127
root._format.colocated_branches and
128
control_dir.control_url == root.control_url,
132
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
133
"""Lookup the location for a new sibling branch.
135
:param control_dir: Control directory relative to which to look up
137
:param location: Name of the new branch
138
:return: Full location to the new branch
140
location = directory_service.directories.dereference(location)
141
if '/' not in location and '\\' not in location:
142
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
145
return urlutils.join_segment_parameters(this_url,
146
{"branch": urlutils.escape(location)})
148
return urlutils.join(this_url, '..', urlutils.escape(location))
152
def lookup_sibling_branch(control_dir, location, possible_transports=None):
153
"""Lookup sibling branch.
155
:param control_dir: Control directory relative to which to lookup the
157
:param location: Location to look up
158
:return: branch to open
161
# Perhaps it's a colocated branch?
162
return control_dir.open_branch(location,
163
possible_transports=possible_transports)
164
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
166
return Branch.open(location)
167
except errors.NotBranchError:
168
this_url = _get_branch_location(control_dir)
171
this_url, '..', urlutils.escape(location)))
174
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
175
def tree_files(file_list, default_branch=u'.', canonicalize=True,
177
return internal_tree_files(file_list, default_branch, canonicalize,
181
def tree_files_for_add(file_list):
183
Return a tree and list of absolute paths from a file list.
185
Similar to tree_files, but add handles files a bit differently, so it a
186
custom implementation. In particular, MutableTreeTree.smart_add expects
187
absolute paths, which it immediately converts to relative paths.
189
# FIXME Would be nice to just return the relative paths like
190
# internal_tree_files does, but there are a large number of unit tests
191
# that assume the current interface to mutabletree.smart_add
193
tree, relpath = WorkingTree.open_containing(file_list[0])
194
if tree.supports_views():
195
view_files = tree.views.lookup_view()
197
for filename in file_list:
198
if not osutils.is_inside_any(view_files, filename):
199
raise errors.FileOutsideView(filename, view_files)
200
file_list = file_list[:]
201
file_list[0] = tree.abspath(relpath)
203
tree = WorkingTree.open_containing(u'.')[0]
204
if tree.supports_views():
205
view_files = tree.views.lookup_view()
207
file_list = view_files
208
view_str = views.view_display_str(view_files)
209
note(gettext("Ignoring files outside view. View is %s") % view_str)
210
return tree, file_list
213
def _get_one_revision(command_name, revisions):
214
if revisions is None:
216
if len(revisions) != 1:
217
raise errors.BzrCommandError(gettext(
218
'bzr %s --revision takes exactly one revision identifier') % (
223
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
224
"""Get a revision tree. Not suitable for commands that change the tree.
226
Specifically, the basis tree in dirstate trees is coupled to the dirstate
227
and doing a commit/uncommit/pull will at best fail due to changing the
230
If tree is passed in, it should be already locked, for lifetime management
231
of the trees internal cached state.
235
if revisions is None:
237
rev_tree = tree.basis_tree()
239
rev_tree = branch.basis_tree()
241
revision = _get_one_revision(command_name, revisions)
242
rev_tree = revision.as_tree(branch)
246
# XXX: Bad function name; should possibly also be a class method of
247
# WorkingTree rather than a function.
248
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
249
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
251
"""Convert command-line paths to a WorkingTree and relative paths.
253
Deprecated: use WorkingTree.open_containing_paths instead.
255
This is typically used for command-line processors that take one or
256
more filenames, and infer the workingtree that contains them.
258
The filenames given are not required to exist.
260
:param file_list: Filenames to convert.
262
:param default_branch: Fallback tree path to use if file_list is empty or
265
:param apply_view: if True and a view is set, apply it or check that
266
specified files are within it
268
:return: workingtree, [relative_paths]
270
return WorkingTree.open_containing_paths(
271
file_list, default_directory='.',
276
def _get_view_info_for_change_reporter(tree):
277
"""Get the view information from a tree for change reporting."""
280
current_view = tree.views.get_view_info()[0]
281
if current_view is not None:
282
view_info = (current_view, tree.views.lookup_view())
283
except errors.ViewsNotSupported:
288
def _open_directory_or_containing_tree_or_branch(filename, directory):
289
"""Open the tree or branch containing the specified file, unless
290
the --directory option is used to specify a different branch."""
291
if directory is not None:
292
return (None, Branch.open(directory), filename)
293
return controldir.ControlDir.open_containing_tree_or_branch(filename)
296
# TODO: Make sure no commands unconditionally use the working directory as a
297
# branch. If a filename argument is used, the first of them should be used to
298
# specify the branch. (Perhaps this can be factored out into some kind of
299
# Argument class, representing a file in a branch, where the first occurrence
302
class cmd_status(Command):
303
__doc__ = """Display status summary.
305
This reports on versioned and unknown files, reporting them
306
grouped by state. Possible states are:
309
Versioned in the working copy but not in the previous revision.
312
Versioned in the previous revision but removed or deleted
316
Path of this file changed from the previous revision;
317
the text may also have changed. This includes files whose
318
parent directory was renamed.
321
Text has changed since the previous revision.
324
File kind has been changed (e.g. from file to directory).
327
Not versioned and not matching an ignore pattern.
329
Additionally for directories, symlinks and files with a changed
330
executable bit, Bazaar indicates their type using a trailing
331
character: '/', '@' or '*' respectively. These decorations can be
332
disabled using the '--no-classify' option.
334
To see ignored files use 'bzr ignored'. For details on the
335
changes to file texts, use 'bzr diff'.
337
Note that --short or -S gives status flags for each item, similar
338
to Subversion's status command. To get output similar to svn -q,
341
If no arguments are specified, the status of the entire working
342
directory is shown. Otherwise, only the status of the specified
343
files or directories is reported. If a directory is given, status
344
is reported for everything inside that directory.
346
Before merges are committed, the pending merge tip revisions are
347
shown. To see all pending merge revisions, use the -v option.
348
To skip the display of pending merge information altogether, use
349
the no-pending option or specify a file/directory.
351
To compare the working directory to a specific revision, pass a
352
single revision to the revision argument.
354
To see which files have changed in a specific revision, or between
355
two revisions, pass a revision range to the revision argument.
356
This will produce the same results as calling 'bzr diff --summarize'.
359
# TODO: --no-recurse, --recurse options
361
takes_args = ['file*']
362
takes_options = ['show-ids', 'revision', 'change', 'verbose',
363
Option('short', help='Use short status indicators.',
365
Option('versioned', help='Only show versioned files.',
367
Option('no-pending', help='Don\'t show pending merges.',
369
Option('no-classify',
370
help='Do not mark object type using indicator.',
373
aliases = ['st', 'stat']
375
encoding_type = 'replace'
376
_see_also = ['diff', 'revert', 'status-flags']
379
def run(self, show_ids=False, file_list=None, revision=None, short=False,
380
versioned=False, no_pending=False, verbose=False,
382
from bzrlib.status import show_tree_status
384
if revision and len(revision) > 2:
385
raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
386
' one or two revision specifiers'))
388
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
389
# Avoid asking for specific files when that is not needed.
390
if relfile_list == ['']:
392
# Don't disable pending merges for full trees other than '.'.
393
if file_list == ['.']:
395
# A specific path within a tree was given.
396
elif relfile_list is not None:
398
show_tree_status(tree, show_ids=show_ids,
399
specific_files=relfile_list, revision=revision,
400
to_file=self.outf, short=short, versioned=versioned,
401
show_pending=(not no_pending), verbose=verbose,
402
classify=not no_classify)
405
class cmd_cat_revision(Command):
406
__doc__ = """Write out metadata for a revision.
408
The revision to print can either be specified by a specific
409
revision identifier, or you can use --revision.
413
takes_args = ['revision_id?']
414
takes_options = ['directory', 'revision']
415
# cat-revision is more for frontends so should be exact
418
def print_revision(self, revisions, revid):
419
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
420
record = stream.next()
421
if record.storage_kind == 'absent':
422
raise errors.NoSuchRevision(revisions, revid)
423
revtext = record.get_bytes_as('fulltext')
424
self.outf.write(revtext.decode('utf-8'))
427
def run(self, revision_id=None, revision=None, directory=u'.'):
428
if revision_id is not None and revision is not None:
429
raise errors.BzrCommandError(gettext('You can only supply one of'
430
' revision_id or --revision'))
431
if revision_id is None and revision is None:
432
raise errors.BzrCommandError(gettext('You must supply either'
433
' --revision or a revision_id'))
435
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
437
revisions = b.repository.revisions
438
if revisions is None:
439
raise errors.BzrCommandError(gettext('Repository %r does not support '
440
'access to raw revision texts'))
442
b.repository.lock_read()
444
# TODO: jam 20060112 should cat-revision always output utf-8?
445
if revision_id is not None:
446
revision_id = osutils.safe_revision_id(revision_id, warn=False)
448
self.print_revision(revisions, revision_id)
449
except errors.NoSuchRevision:
450
msg = gettext("The repository {0} contains no revision {1}.").format(
451
b.repository.base, revision_id)
452
raise errors.BzrCommandError(msg)
453
elif revision is not None:
456
raise errors.BzrCommandError(
457
gettext('You cannot specify a NULL revision.'))
458
rev_id = rev.as_revision_id(b)
459
self.print_revision(revisions, rev_id)
461
b.repository.unlock()
464
class cmd_dump_btree(Command):
465
__doc__ = """Dump the contents of a btree index file to stdout.
467
PATH is a btree index file, it can be any URL. This includes things like
468
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
470
By default, the tuples stored in the index file will be displayed. With
471
--raw, we will uncompress the pages, but otherwise display the raw bytes
475
# TODO: Do we want to dump the internal nodes as well?
476
# TODO: It would be nice to be able to dump the un-parsed information,
477
# rather than only going through iter_all_entries. However, this is
478
# good enough for a start
480
encoding_type = 'exact'
481
takes_args = ['path']
482
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
483
' rather than the parsed tuples.'),
486
def run(self, path, raw=False):
487
dirname, basename = osutils.split(path)
488
t = transport.get_transport(dirname)
490
self._dump_raw_bytes(t, basename)
492
self._dump_entries(t, basename)
494
def _get_index_and_bytes(self, trans, basename):
495
"""Create a BTreeGraphIndex and raw bytes."""
496
bt = btree_index.BTreeGraphIndex(trans, basename, None)
497
bytes = trans.get_bytes(basename)
498
bt._file = cStringIO.StringIO(bytes)
499
bt._size = len(bytes)
502
def _dump_raw_bytes(self, trans, basename):
505
# We need to parse at least the root node.
506
# This is because the first page of every row starts with an
507
# uncompressed header.
508
bt, bytes = self._get_index_and_bytes(trans, basename)
509
for page_idx, page_start in enumerate(xrange(0, len(bytes),
510
btree_index._PAGE_SIZE)):
511
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
512
page_bytes = bytes[page_start:page_end]
514
self.outf.write('Root node:\n')
515
header_end, data = bt._parse_header_from_bytes(page_bytes)
516
self.outf.write(page_bytes[:header_end])
518
self.outf.write('\nPage %d\n' % (page_idx,))
519
if len(page_bytes) == 0:
520
self.outf.write('(empty)\n');
522
decomp_bytes = zlib.decompress(page_bytes)
523
self.outf.write(decomp_bytes)
524
self.outf.write('\n')
526
def _dump_entries(self, trans, basename):
528
st = trans.stat(basename)
529
except errors.TransportNotPossible:
530
# We can't stat, so we'll fake it because we have to do the 'get()'
532
bt, _ = self._get_index_and_bytes(trans, basename)
534
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
535
for node in bt.iter_all_entries():
536
# Node is made up of:
537
# (index, key, value, [references])
541
refs_as_tuples = None
543
refs_as_tuples = static_tuple.as_tuples(refs)
544
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
545
self.outf.write('%s\n' % (as_tuple,))
548
class cmd_remove_tree(Command):
549
__doc__ = """Remove the working tree from a given branch/checkout.
551
Since a lightweight checkout is little more than a working tree
552
this will refuse to run against one.
554
To re-create the working tree, use "bzr checkout".
556
_see_also = ['checkout', 'working-trees']
557
takes_args = ['location*']
560
help='Remove the working tree even if it has '
561
'uncommitted or shelved changes.'),
564
def run(self, location_list, force=False):
565
if not location_list:
568
for location in location_list:
569
d = controldir.ControlDir.open(location)
572
working = d.open_workingtree()
573
except errors.NoWorkingTree:
574
raise errors.BzrCommandError(gettext("No working tree to remove"))
575
except errors.NotLocalUrl:
576
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
577
" of a remote path"))
579
if (working.has_changes()):
580
raise errors.UncommittedChanges(working)
581
if working.get_shelf_manager().last_shelf() is not None:
582
raise errors.ShelvedChanges(working)
584
if working.user_url != working.branch.user_url:
585
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
586
" from a lightweight checkout"))
588
d.destroy_workingtree()
591
class cmd_repair_workingtree(Command):
592
__doc__ = """Reset the working tree state file.
594
This is not meant to be used normally, but more as a way to recover from
595
filesystem corruption, etc. This rebuilds the working inventory back to a
596
'known good' state. Any new modifications (adding a file, renaming, etc)
597
will be lost, though modified files will still be detected as such.
599
Most users will want something more like "bzr revert" or "bzr update"
600
unless the state file has become corrupted.
602
By default this attempts to recover the current state by looking at the
603
headers of the state file. If the state file is too corrupted to even do
604
that, you can supply --revision to force the state of the tree.
607
takes_options = ['revision', 'directory',
609
help='Reset the tree even if it doesn\'t appear to be'
614
def run(self, revision=None, directory='.', force=False):
615
tree, _ = WorkingTree.open_containing(directory)
616
self.add_cleanup(tree.lock_tree_write().unlock)
620
except errors.BzrError:
621
pass # There seems to be a real error here, so we'll reset
624
raise errors.BzrCommandError(gettext(
625
'The tree does not appear to be corrupt. You probably'
626
' want "bzr revert" instead. Use "--force" if you are'
627
' sure you want to reset the working tree.'))
631
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
633
tree.reset_state(revision_ids)
634
except errors.BzrError, e:
635
if revision_ids is None:
636
extra = (gettext(', the header appears corrupt, try passing -r -1'
637
' to set the state to the last commit'))
640
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
643
class cmd_revno(Command):
644
__doc__ = """Show current revision number.
646
This is equal to the number of revisions on this branch.
650
takes_args = ['location?']
652
Option('tree', help='Show revno of working tree.'),
657
def run(self, tree=False, location=u'.', revision=None):
658
if revision is not None and tree:
659
raise errors.BzrCommandError(gettext("--tree and --revision can "
660
"not be used together"))
664
wt = WorkingTree.open_containing(location)[0]
665
self.add_cleanup(wt.lock_read().unlock)
666
except (errors.NoWorkingTree, errors.NotLocalUrl):
667
raise errors.NoWorkingTree(location)
669
revid = wt.last_revision()
671
b = Branch.open_containing(location)[0]
672
self.add_cleanup(b.lock_read().unlock)
674
if len(revision) != 1:
675
raise errors.BzrCommandError(gettext(
676
"Tags can only be placed on a single revision, "
678
revid = revision[0].as_revision_id(b)
680
revid = b.last_revision()
682
revno_t = b.revision_id_to_dotted_revno(revid)
683
except errors.NoSuchRevision:
685
revno = ".".join(str(n) for n in revno_t)
687
self.outf.write(revno + '\n')
690
class cmd_revision_info(Command):
691
__doc__ = """Show revision number and revision id for a given revision identifier.
694
takes_args = ['revision_info*']
697
custom_help('directory',
698
help='Branch to examine, '
699
'rather than the one containing the working directory.'),
700
Option('tree', help='Show revno of working tree.'),
704
def run(self, revision=None, directory=u'.', tree=False,
705
revision_info_list=[]):
708
wt = WorkingTree.open_containing(directory)[0]
710
self.add_cleanup(wt.lock_read().unlock)
711
except (errors.NoWorkingTree, errors.NotLocalUrl):
713
b = Branch.open_containing(directory)[0]
714
self.add_cleanup(b.lock_read().unlock)
716
if revision is not None:
717
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
718
if revision_info_list is not None:
719
for rev_str in revision_info_list:
720
rev_spec = RevisionSpec.from_string(rev_str)
721
revision_ids.append(rev_spec.as_revision_id(b))
722
# No arguments supplied, default to the last revision
723
if len(revision_ids) == 0:
726
raise errors.NoWorkingTree(directory)
727
revision_ids.append(wt.last_revision())
729
revision_ids.append(b.last_revision())
733
for revision_id in revision_ids:
735
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
736
revno = '.'.join(str(i) for i in dotted_revno)
737
except errors.NoSuchRevision:
739
maxlen = max(maxlen, len(revno))
740
revinfos.append([revno, revision_id])
744
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
747
class cmd_add(Command):
748
__doc__ = """Add specified files or directories.
750
In non-recursive mode, all the named items are added, regardless
751
of whether they were previously ignored. A warning is given if
752
any of the named files are already versioned.
754
In recursive mode (the default), files are treated the same way
755
but the behaviour for directories is different. Directories that
756
are already versioned do not give a warning. All directories,
757
whether already versioned or not, are searched for files or
758
subdirectories that are neither versioned or ignored, and these
759
are added. This search proceeds recursively into versioned
760
directories. If no names are given '.' is assumed.
762
A warning will be printed when nested trees are encountered,
763
unless they are explicitly ignored.
765
Therefore simply saying 'bzr add' will version all files that
766
are currently unknown.
768
Adding a file whose parent directory is not versioned will
769
implicitly add the parent, and so on up to the root. This means
770
you should never need to explicitly add a directory, they'll just
771
get added when you add a file in the directory.
773
--dry-run will show which files would be added, but not actually
776
--file-ids-from will try to use the file ids from the supplied path.
777
It looks up ids trying to find a matching parent directory with the
778
same filename, and then by pure path. This option is rarely needed
779
but can be useful when adding the same logical file into two
780
branches that will be merged later (without showing the two different
781
adds as a conflict). It is also useful when merging another project
782
into a subdirectory of this one.
784
Any files matching patterns in the ignore list will not be added
785
unless they are explicitly mentioned.
787
In recursive mode, files larger than the configuration option
788
add.maximum_file_size will be skipped. Named items are never skipped due
791
takes_args = ['file*']
794
help="Don't recursively add the contents of directories."),
796
help="Show what would be done, but don't actually do anything."),
798
Option('file-ids-from',
800
help='Lookup file ids from this tree.'),
802
encoding_type = 'replace'
803
_see_also = ['remove', 'ignore']
805
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
810
if file_ids_from is not None:
812
base_tree, base_path = WorkingTree.open_containing(
814
except errors.NoWorkingTree:
815
base_branch, base_path = Branch.open_containing(
817
base_tree = base_branch.basis_tree()
819
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
820
to_file=self.outf, should_print=(not is_quiet()))
822
action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
823
should_print=(not is_quiet()))
826
self.add_cleanup(base_tree.lock_read().unlock)
827
tree, file_list = tree_files_for_add(file_list)
828
added, ignored = tree.smart_add(file_list, not
829
no_recurse, action=action, save=not dry_run)
833
for glob in sorted(ignored.keys()):
834
for path in ignored[glob]:
836
gettext("ignored {0} matching \"{1}\"\n").format(
840
class cmd_mkdir(Command):
841
__doc__ = """Create a new versioned directory.
843
This is equivalent to creating the directory and then adding it.
846
takes_args = ['dir+']
850
help='No error if existing, make parent directories as needed.',
854
encoding_type = 'replace'
857
def add_file_with_parents(cls, wt, relpath):
858
if wt.path2id(relpath) is not None:
860
cls.add_file_with_parents(wt, osutils.dirname(relpath))
864
def add_file_single(cls, wt, relpath):
867
def run(self, dir_list, parents=False):
869
add_file = self.add_file_with_parents
871
add_file = self.add_file_single
873
wt, relpath = WorkingTree.open_containing(dir)
878
if e.errno != errno.EEXIST:
882
add_file(wt, relpath)
884
self.outf.write(gettext('added %s\n') % dir)
887
class cmd_relpath(Command):
888
__doc__ = """Show path of a file relative to root"""
890
takes_args = ['filename']
894
def run(self, filename):
895
# TODO: jam 20050106 Can relpath return a munged path if
896
# sys.stdout encoding cannot represent it?
897
tree, relpath = WorkingTree.open_containing(filename)
898
self.outf.write(relpath)
899
self.outf.write('\n')
902
class cmd_inventory(Command):
903
__doc__ = """Show inventory of the current working copy or a revision.
905
It is possible to limit the output to a particular entry
906
type using the --kind option. For example: --kind file.
908
It is also possible to restrict the list of files to a specific
909
set. For example: bzr inventory --show-ids this/file
918
help='List entries of a particular kind: file, directory, symlink.',
921
takes_args = ['file*']
924
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
925
if kind and kind not in ['file', 'directory', 'symlink']:
926
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
928
revision = _get_one_revision('inventory', revision)
929
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
930
self.add_cleanup(work_tree.lock_read().unlock)
931
if revision is not None:
932
tree = revision.as_tree(work_tree.branch)
934
extra_trees = [work_tree]
935
self.add_cleanup(tree.lock_read().unlock)
940
if file_list is not None:
941
file_ids = tree.paths2ids(file_list, trees=extra_trees,
942
require_versioned=True)
943
# find_ids_across_trees may include some paths that don't
946
(tree.id2path(file_id), tree.inventory[file_id])
947
for file_id in file_ids if tree.has_id(file_id))
949
entries = tree.inventory.entries()
952
for path, entry in entries:
953
if kind and kind != entry.kind:
956
self.outf.write('%-50s %s\n' % (path, entry.file_id))
958
self.outf.write(path)
959
self.outf.write('\n')
962
class cmd_mv(Command):
963
__doc__ = """Move or rename a file.
966
bzr mv OLDNAME NEWNAME
968
bzr mv SOURCE... DESTINATION
970
If the last argument is a versioned directory, all the other names
971
are moved into it. Otherwise, there must be exactly two arguments
972
and the file is changed to a new name.
974
If OLDNAME does not exist on the filesystem but is versioned and
975
NEWNAME does exist on the filesystem but is not versioned, mv
976
assumes that the file has been manually moved and only updates
977
its internal inventory to reflect that change.
978
The same is valid when moving many SOURCE files to a DESTINATION.
980
Files cannot be moved between branches.
983
takes_args = ['names*']
984
takes_options = [Option("after", help="Move only the bzr identifier"
985
" of the file, because the file has already been moved."),
986
Option('auto', help='Automatically guess renames.'),
987
Option('dry-run', help='Avoid making changes when guessing renames.'),
989
aliases = ['move', 'rename']
990
encoding_type = 'replace'
992
def run(self, names_list, after=False, auto=False, dry_run=False):
994
return self.run_auto(names_list, after, dry_run)
996
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
997
if names_list is None:
999
if len(names_list) < 2:
1000
raise errors.BzrCommandError(gettext("missing file argument"))
1001
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
1002
for file_name in rel_names[0:-1]:
1004
raise errors.BzrCommandError(gettext("can not move root of branch"))
1005
self.add_cleanup(tree.lock_tree_write().unlock)
1006
self._run(tree, names_list, rel_names, after)
1008
def run_auto(self, names_list, after, dry_run):
1009
if names_list is not None and len(names_list) > 1:
1010
raise errors.BzrCommandError(gettext('Only one path may be specified to'
1013
raise errors.BzrCommandError(gettext('--after cannot be specified with'
1015
work_tree, file_list = WorkingTree.open_containing_paths(
1016
names_list, default_directory='.')
1017
self.add_cleanup(work_tree.lock_tree_write().unlock)
1018
rename_map.RenameMap.guess_renames(work_tree, dry_run)
1020
def _run(self, tree, names_list, rel_names, after):
1021
into_existing = osutils.isdir(names_list[-1])
1022
if into_existing and len(names_list) == 2:
1024
# a. case-insensitive filesystem and change case of dir
1025
# b. move directory after the fact (if the source used to be
1026
# a directory, but now doesn't exist in the working tree
1027
# and the target is an existing directory, just rename it)
1028
if (not tree.case_sensitive
1029
and rel_names[0].lower() == rel_names[1].lower()):
1030
into_existing = False
1032
inv = tree.inventory
1033
# 'fix' the case of a potential 'from'
1034
from_id = tree.path2id(
1035
tree.get_canonical_inventory_path(rel_names[0]))
1036
if (not osutils.lexists(names_list[0]) and
1037
from_id and inv.get_file_kind(from_id) == "directory"):
1038
into_existing = False
1041
# move into existing directory
1042
# All entries reference existing inventory items, so fix them up
1043
# for cicp file-systems.
1044
rel_names = tree.get_canonical_inventory_paths(rel_names)
1045
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1047
self.outf.write("%s => %s\n" % (src, dest))
1049
if len(names_list) != 2:
1050
raise errors.BzrCommandError(gettext('to mv multiple files the'
1051
' destination must be a versioned'
1054
# for cicp file-systems: the src references an existing inventory
1056
src = tree.get_canonical_inventory_path(rel_names[0])
1057
# Find the canonical version of the destination: In all cases, the
1058
# parent of the target must be in the inventory, so we fetch the
1059
# canonical version from there (we do not always *use* the
1060
# canonicalized tail portion - we may be attempting to rename the
1062
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
1063
dest_parent = osutils.dirname(canon_dest)
1064
spec_tail = osutils.basename(rel_names[1])
1065
# For a CICP file-system, we need to avoid creating 2 inventory
1066
# entries that differ only by case. So regardless of the case
1067
# we *want* to use (ie, specified by the user or the file-system),
1068
# we must always choose to use the case of any existing inventory
1069
# items. The only exception to this is when we are attempting a
1070
# case-only rename (ie, canonical versions of src and dest are
1072
dest_id = tree.path2id(canon_dest)
1073
if dest_id is None or tree.path2id(src) == dest_id:
1074
# No existing item we care about, so work out what case we
1075
# are actually going to use.
1077
# If 'after' is specified, the tail must refer to a file on disk.
1079
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
1081
# pathjoin with an empty tail adds a slash, which breaks
1083
dest_parent_fq = tree.basedir
1085
dest_tail = osutils.canonical_relpath(
1087
osutils.pathjoin(dest_parent_fq, spec_tail))
1089
# not 'after', so case as specified is used
1090
dest_tail = spec_tail
1092
# Use the existing item so 'mv' fails with AlreadyVersioned.
1093
dest_tail = os.path.basename(canon_dest)
1094
dest = osutils.pathjoin(dest_parent, dest_tail)
1095
mutter("attempting to move %s => %s", src, dest)
1096
tree.rename_one(src, dest, after=after)
1098
self.outf.write("%s => %s\n" % (src, dest))
1101
class cmd_pull(Command):
1102
__doc__ = """Turn this branch into a mirror of another branch.
1104
By default, this command only works on branches that have not diverged.
1105
Branches are considered diverged if the destination branch's most recent
1106
commit is one that has not been merged (directly or indirectly) into the
1109
If branches have diverged, you can use 'bzr merge' to integrate the changes
1110
from one into the other. Once one branch has merged, the other should
1111
be able to pull it again.
1113
If you want to replace your local changes and just want your branch to
1114
match the remote one, use pull --overwrite. This will work even if the two
1115
branches have diverged.
1117
If there is no default location set, the first pull will set it (use
1118
--no-remember to avoid setting it). After that, you can omit the
1119
location to use the default. To change the default, use --remember. The
1120
value will only be saved if the remote location can be accessed.
1122
The --verbose option will display the revisions pulled using the log_format
1123
configuration option. You can use a different format by overriding it with
1124
-Olog_format=<other_format>.
1126
Note: The location can be specified either in the form of a branch,
1127
or in the form of a path to a file containing a merge directive generated
1131
_see_also = ['push', 'update', 'status-flags', 'send']
1132
takes_options = ['remember', 'overwrite', 'revision',
1133
custom_help('verbose',
1134
help='Show logs of pulled revisions.'),
1135
custom_help('directory',
1136
help='Branch to pull into, '
1137
'rather than the one containing the working directory.'),
1139
help="Perform a local pull in a bound "
1140
"branch. Local pulls are not applied to "
1141
"the master branch."
1144
help="Show base revision text in conflicts."),
1145
Option('overwrite-tags',
1146
help="Overwrite tags only."),
1148
takes_args = ['location?']
1149
encoding_type = 'replace'
1151
def run(self, location=None, remember=None, overwrite=False,
1152
revision=None, verbose=False,
1153
directory=None, local=False,
1154
show_base=False, overwrite_tags=False):
1157
overwrite = ["history", "tags"]
1158
elif overwrite_tags:
1159
overwrite = ["tags"]
1162
# FIXME: too much stuff is in the command class
1165
if directory is None:
1168
tree_to = WorkingTree.open_containing(directory)[0]
1169
branch_to = tree_to.branch
1170
self.add_cleanup(tree_to.lock_write().unlock)
1171
except errors.NoWorkingTree:
1173
branch_to = Branch.open_containing(directory)[0]
1174
self.add_cleanup(branch_to.lock_write().unlock)
1176
if tree_to is None and show_base:
1177
raise errors.BzrCommandError(gettext("Need working tree for --show-base."))
1179
if local and not branch_to.get_bound_location():
1180
raise errors.LocalRequiresBoundBranch()
1182
possible_transports = []
1183
if location is not None:
1185
mergeable = bundle.read_mergeable_from_url(location,
1186
possible_transports=possible_transports)
1187
except errors.NotABundle:
1190
stored_loc = branch_to.get_parent()
1191
if location is None:
1192
if stored_loc is None:
1193
raise errors.BzrCommandError(gettext("No pull location known or"
1196
display_url = urlutils.unescape_for_display(stored_loc,
1199
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1200
location = stored_loc
1202
revision = _get_one_revision('pull', revision)
1203
if mergeable is not None:
1204
if revision is not None:
1205
raise errors.BzrCommandError(gettext(
1206
'Cannot use -r with merge directives or bundles'))
1207
mergeable.install_revisions(branch_to.repository)
1208
base_revision_id, revision_id, verified = \
1209
mergeable.get_merge_request(branch_to.repository)
1210
branch_from = branch_to
1212
branch_from = Branch.open(location,
1213
possible_transports=possible_transports)
1214
self.add_cleanup(branch_from.lock_read().unlock)
1215
# Remembers if asked explicitly or no previous location is set
1217
or (remember is None and branch_to.get_parent() is None)):
1218
branch_to.set_parent(branch_from.base)
1220
if revision is not None:
1221
revision_id = revision.as_revision_id(branch_from)
1223
if tree_to is not None:
1224
view_info = _get_view_info_for_change_reporter(tree_to)
1225
change_reporter = delta._ChangeReporter(
1226
unversioned_filter=tree_to.is_ignored,
1227
view_info=view_info)
1228
result = tree_to.pull(
1229
branch_from, overwrite, revision_id, change_reporter,
1230
local=local, show_base=show_base)
1232
result = branch_to.pull(
1233
branch_from, overwrite, revision_id, local=local)
1235
result.report(self.outf)
1236
if verbose and result.old_revid != result.new_revid:
1237
log.show_branch_change(
1238
branch_to, self.outf, result.old_revno,
1240
if getattr(result, 'tag_conflicts', None):
1246
class cmd_push(Command):
1247
__doc__ = """Update a mirror of this branch.
1249
The target branch will not have its working tree populated because this
1250
is both expensive, and is not supported on remote file systems.
1252
Some smart servers or protocols *may* put the working tree in place in
1255
This command only works on branches that have not diverged. Branches are
1256
considered diverged if the destination branch's most recent commit is one
1257
that has not been merged (directly or indirectly) by the source branch.
1259
If branches have diverged, you can use 'bzr push --overwrite' to replace
1260
the other branch completely, discarding its unmerged changes.
1262
If you want to ensure you have the different changes in the other branch,
1263
do a merge (see bzr help merge) from the other branch, and commit that.
1264
After that you will be able to do a push without '--overwrite'.
1266
If there is no default push location set, the first push will set it (use
1267
--no-remember to avoid setting it). After that, you can omit the
1268
location to use the default. To change the default, use --remember. The
1269
value will only be saved if the remote location can be accessed.
1271
The --verbose option will display the revisions pushed using the log_format
1272
configuration option. You can use a different format by overriding it with
1273
-Olog_format=<other_format>.
1276
_see_also = ['pull', 'update', 'working-trees']
1277
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1278
Option('create-prefix',
1279
help='Create the path leading up to the branch '
1280
'if it does not already exist.'),
1281
custom_help('directory',
1282
help='Branch to push from, '
1283
'rather than the one containing the working directory.'),
1284
Option('use-existing-dir',
1285
help='By default push will fail if the target'
1286
' directory exists, but does not already'
1287
' have a control directory. This flag will'
1288
' allow push to proceed.'),
1290
help='Create a stacked branch that references the public location '
1291
'of the parent branch.'),
1292
Option('stacked-on',
1293
help='Create a stacked branch that refers to another branch '
1294
'for the commit history. Only the work not present in the '
1295
'referenced branch is included in the branch created.',
1298
help='Refuse to push if there are uncommitted changes in'
1299
' the working tree, --no-strict disables the check.'),
1301
help="Don't populate the working tree, even for protocols"
1302
" that support it."),
1303
Option('overwrite-tags',
1304
help="Overwrite tags only."),
1306
takes_args = ['location?']
1307
encoding_type = 'replace'
1309
def run(self, location=None, remember=None, overwrite=False,
1310
create_prefix=False, verbose=False, revision=None,
1311
use_existing_dir=False, directory=None, stacked_on=None,
1312
stacked=False, strict=None, no_tree=False,
1313
overwrite_tags=False):
1314
from bzrlib.push import _show_push_branch
1317
overwrite = ["history", "tags"]
1318
elif overwrite_tags:
1319
overwrite = ["tags"]
1323
if directory is None:
1325
# Get the source branch
1327
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1328
# Get the tip's revision_id
1329
revision = _get_one_revision('push', revision)
1330
if revision is not None:
1331
revision_id = revision.in_history(br_from).rev_id
1334
if tree is not None and revision_id is None:
1335
tree.check_changed_or_out_of_date(
1336
strict, 'push_strict',
1337
more_error='Use --no-strict to force the push.',
1338
more_warning='Uncommitted changes will not be pushed.')
1339
# Get the stacked_on branch, if any
1340
if stacked_on is not None:
1341
stacked_on = urlutils.normalize_url(stacked_on)
1343
parent_url = br_from.get_parent()
1345
parent = Branch.open(parent_url)
1346
stacked_on = parent.get_public_branch()
1348
# I considered excluding non-http url's here, thus forcing
1349
# 'public' branches only, but that only works for some
1350
# users, so it's best to just depend on the user spotting an
1351
# error by the feedback given to them. RBC 20080227.
1352
stacked_on = parent_url
1354
raise errors.BzrCommandError(gettext(
1355
"Could not determine branch to refer to."))
1357
# Get the destination location
1358
if location is None:
1359
stored_loc = br_from.get_push_location()
1360
if stored_loc is None:
1361
parent_loc = br_from.get_parent()
1363
raise errors.BzrCommandError(gettext(
1364
"No push location known or specified. To push to the "
1365
"parent branch (at %s), use 'bzr push :parent'." %
1366
urlutils.unescape_for_display(parent_loc,
1367
self.outf.encoding)))
1369
raise errors.BzrCommandError(gettext(
1370
"No push location known or specified."))
1372
display_url = urlutils.unescape_for_display(stored_loc,
1374
note(gettext("Using saved push location: %s") % display_url)
1375
location = stored_loc
1377
_show_push_branch(br_from, revision_id, location, self.outf,
1378
verbose=verbose, overwrite=overwrite, remember=remember,
1379
stacked_on=stacked_on, create_prefix=create_prefix,
1380
use_existing_dir=use_existing_dir, no_tree=no_tree)
1383
class cmd_branch(Command):
1384
__doc__ = """Create a new branch that is a copy of an existing branch.
1386
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1387
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1388
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1389
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1390
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1393
To retrieve the branch as of a particular revision, supply the --revision
1394
parameter, as in "branch foo/bar -r 5".
1396
The synonyms 'clone' and 'get' for this command are deprecated.
1399
_see_also = ['checkout']
1400
takes_args = ['from_location', 'to_location?']
1401
takes_options = ['revision',
1402
Option('hardlink', help='Hard-link working tree files where possible.'),
1403
Option('files-from', type=str,
1404
help="Get file contents from this tree."),
1406
help="Create a branch without a working-tree."),
1408
help="Switch the checkout in the current directory "
1409
"to the new branch."),
1411
help='Create a stacked branch referring to the source branch. '
1412
'The new branch will depend on the availability of the source '
1413
'branch for all operations.'),
1414
Option('standalone',
1415
help='Do not use a shared repository, even if available.'),
1416
Option('use-existing-dir',
1417
help='By default branch will fail if the target'
1418
' directory exists, but does not already'
1419
' have a control directory. This flag will'
1420
' allow branch to proceed.'),
1422
help="Bind new branch to from location."),
1424
aliases = ['get', 'clone']
1426
def run(self, from_location, to_location=None, revision=None,
1427
hardlink=False, stacked=False, standalone=False, no_tree=False,
1428
use_existing_dir=False, switch=False, bind=False,
1430
from bzrlib import switch as _mod_switch
1431
from bzrlib.tag import _merge_tags_if_possible
1432
if self.invoked_as in ['get', 'clone']:
1433
ui.ui_factory.show_user_warning(
1434
'deprecated_command',
1435
deprecated_name=self.invoked_as,
1436
recommended_name='branch',
1437
deprecated_in_version='2.4')
1438
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1440
if not (hardlink or files_from):
1441
# accelerator_tree is usually slower because you have to read N
1442
# files (no readahead, lots of seeks, etc), but allow the user to
1443
# explicitly request it
1444
accelerator_tree = None
1445
if files_from is not None and files_from != from_location:
1446
accelerator_tree = WorkingTree.open(files_from)
1447
revision = _get_one_revision('branch', revision)
1448
self.add_cleanup(br_from.lock_read().unlock)
1449
if revision is not None:
1450
revision_id = revision.as_revision_id(br_from)
1452
# FIXME - wt.last_revision, fallback to branch, fall back to
1453
# None or perhaps NULL_REVISION to mean copy nothing
1455
revision_id = br_from.last_revision()
1456
if to_location is None:
1457
to_location = getattr(br_from, "name", None)
1459
to_location = urlutils.derive_to_location(from_location)
1460
to_transport = transport.get_transport(to_location)
1462
to_transport.mkdir('.')
1463
except errors.FileExists:
1465
to_dir = controldir.ControlDir.open_from_transport(
1467
except errors.NotBranchError:
1468
if not use_existing_dir:
1469
raise errors.BzrCommandError(gettext('Target directory "%s" '
1470
'already exists.') % to_location)
1475
to_dir.open_branch()
1476
except errors.NotBranchError:
1479
raise errors.AlreadyBranchError(to_location)
1480
except errors.NoSuchFile:
1481
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1487
# preserve whatever source format we have.
1488
to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1489
possible_transports=[to_transport],
1490
accelerator_tree=accelerator_tree,
1491
hardlink=hardlink, stacked=stacked,
1492
force_new_repo=standalone,
1493
create_tree_if_local=not no_tree,
1494
source_branch=br_from)
1495
branch = to_dir.open_branch(
1496
possible_transports=[
1497
br_from.bzrdir.root_transport, to_transport])
1498
except errors.NoSuchRevision:
1499
to_transport.delete_tree('.')
1500
msg = gettext("The branch {0} has no revision {1}.").format(
1501
from_location, revision)
1502
raise errors.BzrCommandError(msg)
1505
to_repo = to_dir.open_repository()
1506
except errors.NoRepositoryPresent:
1507
to_repo = to_dir.create_repository()
1508
to_repo.fetch(br_from.repository, revision_id=revision_id)
1509
branch = br_from.sprout(to_dir, revision_id=revision_id)
1510
_merge_tags_if_possible(br_from, branch)
1511
# If the source branch is stacked, the new branch may
1512
# be stacked whether we asked for that explicitly or not.
1513
# We therefore need a try/except here and not just 'if stacked:'
1515
note(gettext('Created new stacked branch referring to %s.') %
1516
branch.get_stacked_on_url())
1517
except (errors.NotStacked, errors.UnstackableBranchFormat,
1518
errors.UnstackableRepositoryFormat), e:
1519
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1521
# Bind to the parent
1522
parent_branch = Branch.open(from_location)
1523
branch.bind(parent_branch)
1524
note(gettext('New branch bound to %s') % from_location)
1526
# Switch to the new branch
1527
wt, _ = WorkingTree.open_containing('.')
1528
_mod_switch.switch(wt.bzrdir, branch)
1529
note(gettext('Switched to branch: %s'),
1530
urlutils.unescape_for_display(branch.base, 'utf-8'))
1533
class cmd_branches(Command):
1534
__doc__ = """List the branches available at the current location.
1536
This command will print the names of all the branches at the current
1540
takes_args = ['location?']
1542
Option('recursive', short_name='R',
1543
help='Recursively scan for branches rather than '
1544
'just looking in the specified location.')]
1546
def run(self, location=".", recursive=False):
1548
t = transport.get_transport(location)
1549
if not t.listable():
1550
raise errors.BzrCommandError(
1551
"Can't scan this type of location.")
1552
for b in controldir.ControlDir.find_branches(t):
1553
self.outf.write("%s\n" % urlutils.unescape_for_display(
1554
urlutils.relative_url(t.base, b.base),
1555
self.outf.encoding).rstrip("/"))
1557
dir = controldir.ControlDir.open_containing(location)[0]
1559
active_branch = dir.open_branch(name="")
1560
except errors.NotBranchError:
1561
active_branch = None
1562
branches = dir.get_branches()
1564
for name, branch in branches.iteritems():
1567
active = (active_branch is not None and
1568
active_branch.base == branch.base)
1569
names[name] = active
1570
# Only mention the current branch explicitly if it's not
1571
# one of the colocated branches
1572
if not any(names.values()) and active_branch is not None:
1573
self.outf.write("* %s\n" % gettext("(default)"))
1574
for name in sorted(names.keys()):
1575
active = names[name]
1580
self.outf.write("%s %s\n" % (
1581
prefix, name.encode(self.outf.encoding)))
1584
class cmd_checkout(Command):
1585
__doc__ = """Create a new checkout of an existing branch.
1587
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1588
the branch found in '.'. This is useful if you have removed the working tree
1589
or if it was never created - i.e. if you pushed the branch to its current
1590
location using SFTP.
1592
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1593
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1594
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1595
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1596
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1599
To retrieve the branch as of a particular revision, supply the --revision
1600
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1601
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1605
_see_also = ['checkouts', 'branch']
1606
takes_args = ['branch_location?', 'to_location?']
1607
takes_options = ['revision',
1608
Option('lightweight',
1609
help="Perform a lightweight checkout. Lightweight "
1610
"checkouts depend on access to the branch for "
1611
"every operation. Normal checkouts can perform "
1612
"common operations like diff and status without "
1613
"such access, and also support local commits."
1615
Option('files-from', type=str,
1616
help="Get file contents from this tree."),
1618
help='Hard-link working tree files where possible.'
1623
def run(self, branch_location=None, to_location=None, revision=None,
1624
lightweight=False, files_from=None, hardlink=False):
1625
if branch_location is None:
1626
branch_location = osutils.getcwd()
1627
to_location = branch_location
1628
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1630
if not (hardlink or files_from):
1631
# accelerator_tree is usually slower because you have to read N
1632
# files (no readahead, lots of seeks, etc), but allow the user to
1633
# explicitly request it
1634
accelerator_tree = None
1635
revision = _get_one_revision('checkout', revision)
1636
if files_from is not None and files_from != branch_location:
1637
accelerator_tree = WorkingTree.open(files_from)
1638
if revision is not None:
1639
revision_id = revision.as_revision_id(source)
1642
if to_location is None:
1643
to_location = urlutils.derive_to_location(branch_location)
1644
# if the source and to_location are the same,
1645
# and there is no working tree,
1646
# then reconstitute a branch
1647
if (osutils.abspath(to_location) ==
1648
osutils.abspath(branch_location)):
1650
source.bzrdir.open_workingtree()
1651
except errors.NoWorkingTree:
1652
source.bzrdir.create_workingtree(revision_id)
1654
source.create_checkout(to_location, revision_id, lightweight,
1655
accelerator_tree, hardlink)
1658
class cmd_renames(Command):
1659
__doc__ = """Show list of renamed files.
1661
# TODO: Option to show renames between two historical versions.
1663
# TODO: Only show renames under dir, rather than in the whole branch.
1664
_see_also = ['status']
1665
takes_args = ['dir?']
1668
def run(self, dir=u'.'):
1669
tree = WorkingTree.open_containing(dir)[0]
1670
self.add_cleanup(tree.lock_read().unlock)
1671
new_inv = tree.inventory
1672
old_tree = tree.basis_tree()
1673
self.add_cleanup(old_tree.lock_read().unlock)
1674
old_inv = old_tree.inventory
1676
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1677
for f, paths, c, v, p, n, k, e in iterator:
1678
if paths[0] == paths[1]:
1682
renames.append(paths)
1684
for old_name, new_name in renames:
1685
self.outf.write("%s => %s\n" % (old_name, new_name))
1688
class cmd_update(Command):
1689
__doc__ = """Update a working tree to a new revision.
1691
This will perform a merge of the destination revision (the tip of the
1692
branch, or the specified revision) into the working tree, and then make
1693
that revision the basis revision for the working tree.
1695
You can use this to visit an older revision, or to update a working tree
1696
that is out of date from its branch.
1698
If there are any uncommitted changes in the tree, they will be carried
1699
across and remain as uncommitted changes after the update. To discard
1700
these changes, use 'bzr revert'. The uncommitted changes may conflict
1701
with the changes brought in by the change in basis revision.
1703
If the tree's branch is bound to a master branch, bzr will also update
1704
the branch from the master.
1706
You cannot update just a single file or directory, because each Bazaar
1707
working tree has just a single basis revision. If you want to restore a
1708
file that has been removed locally, use 'bzr revert' instead of 'bzr
1709
update'. If you want to restore a file to its state in a previous
1710
revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
1711
out the old content of that file to a new location.
1713
The 'dir' argument, if given, must be the location of the root of a
1714
working tree to update. By default, the working tree that contains the
1715
current working directory is used.
1718
_see_also = ['pull', 'working-trees', 'status-flags']
1719
takes_args = ['dir?']
1720
takes_options = ['revision',
1722
help="Show base revision text in conflicts."),
1726
def run(self, dir=None, revision=None, show_base=None):
1727
if revision is not None and len(revision) != 1:
1728
raise errors.BzrCommandError(gettext(
1729
"bzr update --revision takes exactly one revision"))
1731
tree = WorkingTree.open_containing('.')[0]
1733
tree, relpath = WorkingTree.open_containing(dir)
1736
raise errors.BzrCommandError(gettext(
1737
"bzr update can only update a whole tree, "
1738
"not a file or subdirectory"))
1739
branch = tree.branch
1740
possible_transports = []
1741
master = branch.get_master_branch(
1742
possible_transports=possible_transports)
1743
if master is not None:
1744
branch_location = master.base
1747
branch_location = tree.branch.base
1748
tree.lock_tree_write()
1749
self.add_cleanup(tree.unlock)
1750
# get rid of the final '/' and be ready for display
1751
branch_location = urlutils.unescape_for_display(
1752
branch_location.rstrip('/'),
1754
existing_pending_merges = tree.get_parent_ids()[1:]
1758
# may need to fetch data into a heavyweight checkout
1759
# XXX: this may take some time, maybe we should display a
1761
old_tip = branch.update(possible_transports)
1762
if revision is not None:
1763
revision_id = revision[0].as_revision_id(branch)
1765
revision_id = branch.last_revision()
1766
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1767
revno = branch.revision_id_to_dotted_revno(revision_id)
1768
note(gettext("Tree is up to date at revision {0} of branch {1}"
1769
).format('.'.join(map(str, revno)), branch_location))
1771
view_info = _get_view_info_for_change_reporter(tree)
1772
change_reporter = delta._ChangeReporter(
1773
unversioned_filter=tree.is_ignored,
1774
view_info=view_info)
1776
conflicts = tree.update(
1778
possible_transports=possible_transports,
1779
revision=revision_id,
1781
show_base=show_base)
1782
except errors.NoSuchRevision, e:
1783
raise errors.BzrCommandError(gettext(
1784
"branch has no revision %s\n"
1785
"bzr update --revision only works"
1786
" for a revision in the branch history")
1788
revno = tree.branch.revision_id_to_dotted_revno(
1789
_mod_revision.ensure_null(tree.last_revision()))
1790
note(gettext('Updated to revision {0} of branch {1}').format(
1791
'.'.join(map(str, revno)), branch_location))
1792
parent_ids = tree.get_parent_ids()
1793
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1794
note(gettext('Your local commits will now show as pending merges with '
1795
"'bzr status', and can be committed with 'bzr commit'."))
1802
class cmd_info(Command):
1803
__doc__ = """Show information about a working tree, branch or repository.
1805
This command will show all known locations and formats associated to the
1806
tree, branch or repository.
1808
In verbose mode, statistical information is included with each report.
1809
To see extended statistic information, use a verbosity level of 2 or
1810
higher by specifying the verbose option multiple times, e.g. -vv.
1812
Branches and working trees will also report any missing revisions.
1816
Display information on the format and related locations:
1820
Display the above together with extended format information and
1821
basic statistics (like the number of files in the working tree and
1822
number of revisions in the branch and repository):
1826
Display the above together with number of committers to the branch:
1830
_see_also = ['revno', 'working-trees', 'repositories']
1831
takes_args = ['location?']
1832
takes_options = ['verbose']
1833
encoding_type = 'replace'
1836
def run(self, location=None, verbose=False):
1838
noise_level = get_verbosity_level()
1841
from bzrlib.info import show_bzrdir_info
1842
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1843
verbose=noise_level, outfile=self.outf)
1846
class cmd_remove(Command):
1847
__doc__ = """Remove files or directories.
1849
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1850
delete them if they can easily be recovered using revert otherwise they
1851
will be backed up (adding an extention of the form .~#~). If no options or
1852
parameters are given Bazaar will scan for files that are being tracked by
1853
Bazaar but missing in your tree and stop tracking them for you.
1855
takes_args = ['file*']
1856
takes_options = ['verbose',
1857
Option('new', help='Only remove files that have never been committed.'),
1858
RegistryOption.from_kwargs('file-deletion-strategy',
1859
'The file deletion mode to be used.',
1860
title='Deletion Strategy', value_switches=True, enum_switch=False,
1861
safe='Backup changed files (default).',
1862
keep='Delete from bzr but leave the working copy.',
1863
no_backup='Don\'t backup changed files.',
1864
force='Delete all the specified files, even if they can not be '
1865
'recovered and even if they are non-empty directories. '
1866
'(deprecated, use no-backup)')]
1867
aliases = ['rm', 'del']
1868
encoding_type = 'replace'
1870
def run(self, file_list, verbose=False, new=False,
1871
file_deletion_strategy='safe'):
1872
if file_deletion_strategy == 'force':
1873
note(gettext("(The --force option is deprecated, rather use --no-backup "
1875
file_deletion_strategy = 'no-backup'
1877
tree, file_list = WorkingTree.open_containing_paths(file_list)
1879
if file_list is not None:
1880
file_list = [f for f in file_list]
1882
self.add_cleanup(tree.lock_write().unlock)
1883
# Heuristics should probably all move into tree.remove_smart or
1886
added = tree.changes_from(tree.basis_tree(),
1887
specific_files=file_list).added
1888
file_list = sorted([f[0] for f in added], reverse=True)
1889
if len(file_list) == 0:
1890
raise errors.BzrCommandError(gettext('No matching files.'))
1891
elif file_list is None:
1892
# missing files show up in iter_changes(basis) as
1893
# versioned-with-no-kind.
1895
for change in tree.iter_changes(tree.basis_tree()):
1896
# Find paths in the working tree that have no kind:
1897
if change[1][1] is not None and change[6][1] is None:
1898
missing.append(change[1][1])
1899
file_list = sorted(missing, reverse=True)
1900
file_deletion_strategy = 'keep'
1901
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1902
keep_files=file_deletion_strategy=='keep',
1903
force=(file_deletion_strategy=='no-backup'))
1906
class cmd_file_id(Command):
1907
__doc__ = """Print file_id of a particular file or directory.
1909
The file_id is assigned when the file is first added and remains the
1910
same through all revisions where the file exists, even when it is
1915
_see_also = ['inventory', 'ls']
1916
takes_args = ['filename']
1919
def run(self, filename):
1920
tree, relpath = WorkingTree.open_containing(filename)
1921
i = tree.path2id(relpath)
1923
raise errors.NotVersionedError(filename)
1925
self.outf.write(i + '\n')
1928
class cmd_file_path(Command):
1929
__doc__ = """Print path of file_ids to a file or directory.
1931
This prints one line for each directory down to the target,
1932
starting at the branch root.
1936
takes_args = ['filename']
1939
def run(self, filename):
1940
tree, relpath = WorkingTree.open_containing(filename)
1941
fid = tree.path2id(relpath)
1943
raise errors.NotVersionedError(filename)
1944
segments = osutils.splitpath(relpath)
1945
for pos in range(1, len(segments) + 1):
1946
path = osutils.joinpath(segments[:pos])
1947
self.outf.write("%s\n" % tree.path2id(path))
1950
class cmd_reconcile(Command):
1951
__doc__ = """Reconcile bzr metadata in a branch.
1953
This can correct data mismatches that may have been caused by
1954
previous ghost operations or bzr upgrades. You should only
1955
need to run this command if 'bzr check' or a bzr developer
1956
advises you to run it.
1958
If a second branch is provided, cross-branch reconciliation is
1959
also attempted, which will check that data like the tree root
1960
id which was not present in very early bzr versions is represented
1961
correctly in both branches.
1963
At the same time it is run it may recompress data resulting in
1964
a potential saving in disk space or performance gain.
1966
The branch *MUST* be on a listable system such as local disk or sftp.
1969
_see_also = ['check']
1970
takes_args = ['branch?']
1972
Option('canonicalize-chks',
1973
help='Make sure CHKs are in canonical form (repairs '
1978
def run(self, branch=".", canonicalize_chks=False):
1979
from bzrlib.reconcile import reconcile
1980
dir = controldir.ControlDir.open(branch)
1981
reconcile(dir, canonicalize_chks=canonicalize_chks)
1984
class cmd_revision_history(Command):
1985
__doc__ = """Display the list of revision ids on a branch."""
1988
takes_args = ['location?']
1993
def run(self, location="."):
1994
branch = Branch.open_containing(location)[0]
1995
self.add_cleanup(branch.lock_read().unlock)
1996
graph = branch.repository.get_graph()
1997
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1998
[_mod_revision.NULL_REVISION]))
1999
for revid in reversed(history):
2000
self.outf.write(revid)
2001
self.outf.write('\n')
2004
class cmd_ancestry(Command):
2005
__doc__ = """List all revisions merged into this branch."""
2007
_see_also = ['log', 'revision-history']
2008
takes_args = ['location?']
2013
def run(self, location="."):
2015
wt = WorkingTree.open_containing(location)[0]
2016
except errors.NoWorkingTree:
2017
b = Branch.open(location)
2018
last_revision = b.last_revision()
2021
last_revision = wt.last_revision()
2023
self.add_cleanup(b.repository.lock_read().unlock)
2024
graph = b.repository.get_graph()
2025
revisions = [revid for revid, parents in
2026
graph.iter_ancestry([last_revision])]
2027
for revision_id in reversed(revisions):
2028
if _mod_revision.is_null(revision_id):
2030
self.outf.write(revision_id + '\n')
2033
class cmd_init(Command):
2034
__doc__ = """Make a directory into a versioned branch.
2036
Use this to create an empty branch, or before importing an
2039
If there is a repository in a parent directory of the location, then
2040
the history of the branch will be stored in the repository. Otherwise
2041
init creates a standalone branch which carries its own history
2042
in the .bzr directory.
2044
If there is already a branch at the location but it has no working tree,
2045
the tree can be populated with 'bzr checkout'.
2047
Recipe for importing a tree of files::
2053
bzr commit -m "imported project"
2056
_see_also = ['init-repository', 'branch', 'checkout']
2057
takes_args = ['location?']
2059
Option('create-prefix',
2060
help='Create the path leading up to the branch '
2061
'if it does not already exist.'),
2062
RegistryOption('format',
2063
help='Specify a format for this branch. '
2064
'See "help formats".',
2065
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2066
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2067
value_switches=True,
2068
title="Branch format",
2070
Option('append-revisions-only',
2071
help='Never change revnos or the existing log.'
2072
' Append revisions to it only.'),
2074
'Create a branch without a working tree.')
2076
def run(self, location=None, format=None, append_revisions_only=False,
2077
create_prefix=False, no_tree=False):
2079
format = controldir.format_registry.make_bzrdir('default')
2080
if location is None:
2083
to_transport = transport.get_transport(location)
2085
# The path has to exist to initialize a
2086
# branch inside of it.
2087
# Just using os.mkdir, since I don't
2088
# believe that we want to create a bunch of
2089
# locations if the user supplies an extended path
2091
to_transport.ensure_base()
2092
except errors.NoSuchFile:
2093
if not create_prefix:
2094
raise errors.BzrCommandError(gettext("Parent directory of %s"
2096
"\nYou may supply --create-prefix to create all"
2097
" leading parent directories.")
2099
to_transport.create_prefix()
2102
a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
2103
except errors.NotBranchError:
2104
# really a NotBzrDir error...
2105
create_branch = controldir.ControlDir.create_branch_convenience
2107
force_new_tree = False
2109
force_new_tree = None
2110
branch = create_branch(to_transport.base, format=format,
2111
possible_transports=[to_transport],
2112
force_new_tree=force_new_tree)
2113
a_bzrdir = branch.bzrdir
2115
from bzrlib.transport.local import LocalTransport
2116
if a_bzrdir.has_branch():
2117
if (isinstance(to_transport, LocalTransport)
2118
and not a_bzrdir.has_workingtree()):
2119
raise errors.BranchExistsWithoutWorkingTree(location)
2120
raise errors.AlreadyBranchError(location)
2121
branch = a_bzrdir.create_branch()
2122
if not no_tree and not a_bzrdir.has_workingtree():
2123
a_bzrdir.create_workingtree()
2124
if append_revisions_only:
2126
branch.set_append_revisions_only(True)
2127
except errors.UpgradeRequired:
2128
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2129
' to append-revisions-only. Try --default.'))
2131
from bzrlib.info import describe_layout, describe_format
2133
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
2134
except (errors.NoWorkingTree, errors.NotLocalUrl):
2136
repository = branch.repository
2137
layout = describe_layout(repository, branch, tree).lower()
2138
format = describe_format(a_bzrdir, repository, branch, tree)
2139
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2141
if repository.is_shared():
2142
#XXX: maybe this can be refactored into transport.path_or_url()
2143
url = repository.bzrdir.root_transport.external_url()
2145
url = urlutils.local_path_from_url(url)
2146
except errors.InvalidURL:
2148
self.outf.write(gettext("Using shared repository: %s\n") % url)
2151
class cmd_init_repository(Command):
2152
__doc__ = """Create a shared repository for branches to share storage space.
2154
New branches created under the repository directory will store their
2155
revisions in the repository, not in the branch directory. For branches
2156
with shared history, this reduces the amount of storage needed and
2157
speeds up the creation of new branches.
2159
If the --no-trees option is given then the branches in the repository
2160
will not have working trees by default. They will still exist as
2161
directories on disk, but they will not have separate copies of the
2162
files at a certain revision. This can be useful for repositories that
2163
store branches which are interacted with through checkouts or remote
2164
branches, such as on a server.
2167
Create a shared repository holding just branches::
2169
bzr init-repo --no-trees repo
2172
Make a lightweight checkout elsewhere::
2174
bzr checkout --lightweight repo/trunk trunk-checkout
2179
_see_also = ['init', 'branch', 'checkout', 'repositories']
2180
takes_args = ["location"]
2181
takes_options = [RegistryOption('format',
2182
help='Specify a format for this repository. See'
2183
' "bzr help formats" for details.',
2184
lazy_registry=('bzrlib.controldir', 'format_registry'),
2185
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2186
value_switches=True, title='Repository format'),
2188
help='Branches in the repository will default to'
2189
' not having a working tree.'),
2191
aliases = ["init-repo"]
2193
def run(self, location, format=None, no_trees=False):
2195
format = controldir.format_registry.make_bzrdir('default')
2197
if location is None:
2200
to_transport = transport.get_transport(location)
2202
(repo, newdir, require_stacking, repository_policy) = (
2203
format.initialize_on_transport_ex(to_transport,
2204
create_prefix=True, make_working_trees=not no_trees,
2205
shared_repo=True, force_new_repo=True,
2206
use_existing_dir=True,
2207
repo_format_name=format.repository_format.get_format_string()))
2209
from bzrlib.info import show_bzrdir_info
2210
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2213
class cmd_diff(Command):
2214
__doc__ = """Show differences in the working tree, between revisions or branches.
2216
If no arguments are given, all changes for the current tree are listed.
2217
If files are given, only the changes in those files are listed.
2218
Remote and multiple branches can be compared by using the --old and
2219
--new options. If not provided, the default for both is derived from
2220
the first argument, if any, or the current tree if no arguments are
2223
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
2224
produces patches suitable for "patch -p1".
2226
Note that when using the -r argument with a range of revisions, the
2227
differences are computed between the two specified revisions. That
2228
is, the command does not show the changes introduced by the first
2229
revision in the range. This differs from the interpretation of
2230
revision ranges used by "bzr log" which includes the first revision
2235
2 - unrepresentable changes
2240
Shows the difference in the working tree versus the last commit::
2244
Difference between the working tree and revision 1::
2248
Difference between revision 3 and revision 1::
2252
Difference between revision 3 and revision 1 for branch xxx::
2256
The changes introduced by revision 2 (equivalent to -r1..2)::
2260
To see the changes introduced by revision X::
2264
Note that in the case of a merge, the -c option shows the changes
2265
compared to the left hand parent. To see the changes against
2266
another parent, use::
2268
bzr diff -r<chosen_parent>..X
2270
The changes between the current revision and the previous revision
2271
(equivalent to -c-1 and -r-2..-1)
2275
Show just the differences for file NEWS::
2279
Show the differences in working tree xxx for file NEWS::
2283
Show the differences from branch xxx to this working tree:
2287
Show the differences between two branches for file NEWS::
2289
bzr diff --old xxx --new yyy NEWS
2291
Same as 'bzr diff' but prefix paths with old/ and new/::
2293
bzr diff --prefix old/:new/
2295
Show the differences using a custom diff program with options::
2297
bzr diff --using /usr/bin/diff --diff-options -wu
2299
_see_also = ['status']
2300
takes_args = ['file*']
2302
Option('diff-options', type=str,
2303
help='Pass these options to the external diff program.'),
2304
Option('prefix', type=str,
2306
help='Set prefixes added to old and new filenames, as '
2307
'two values separated by a colon. (eg "old/:new/").'),
2309
help='Branch/tree to compare from.',
2313
help='Branch/tree to compare to.',
2319
help='Use this command to compare files.',
2322
RegistryOption('format',
2324
help='Diff format to use.',
2325
lazy_registry=('bzrlib.diff', 'format_registry'),
2326
title='Diff format'),
2328
aliases = ['di', 'dif']
2329
encoding_type = 'exact'
2332
def run(self, revision=None, file_list=None, diff_options=None,
2333
prefix=None, old=None, new=None, using=None, format=None):
2334
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2337
if (prefix is None) or (prefix == '0'):
2345
old_label, new_label = prefix.split(":")
2347
raise errors.BzrCommandError(gettext(
2348
'--prefix expects two values separated by a colon'
2349
' (eg "old/:new/")'))
2351
if revision and len(revision) > 2:
2352
raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
2353
' one or two revision specifiers'))
2355
if using is not None and format is not None:
2356
raise errors.BzrCommandError(gettext(
2357
'{0} and {1} are mutually exclusive').format(
2358
'--using', '--format'))
2360
(old_tree, new_tree,
2361
old_branch, new_branch,
2362
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2363
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2364
# GNU diff on Windows uses ANSI encoding for filenames
2365
path_encoding = osutils.get_diff_header_encoding()
2366
return show_diff_trees(old_tree, new_tree, sys.stdout,
2367
specific_files=specific_files,
2368
external_diff_options=diff_options,
2369
old_label=old_label, new_label=new_label,
2370
extra_trees=extra_trees,
2371
path_encoding=path_encoding,
2376
class cmd_deleted(Command):
2377
__doc__ = """List files deleted in the working tree.
2379
# TODO: Show files deleted since a previous revision, or
2380
# between two revisions.
2381
# TODO: Much more efficient way to do this: read in new
2382
# directories with readdir, rather than stating each one. Same
2383
# level of effort but possibly much less IO. (Or possibly not,
2384
# if the directories are very large...)
2385
_see_also = ['status', 'ls']
2386
takes_options = ['directory', 'show-ids']
2389
def run(self, show_ids=False, directory=u'.'):
2390
tree = WorkingTree.open_containing(directory)[0]
2391
self.add_cleanup(tree.lock_read().unlock)
2392
old = tree.basis_tree()
2393
self.add_cleanup(old.lock_read().unlock)
2394
for path, ie in old.inventory.iter_entries():
2395
if not tree.has_id(ie.file_id):
2396
self.outf.write(path)
2398
self.outf.write(' ')
2399
self.outf.write(ie.file_id)
2400
self.outf.write('\n')
2403
class cmd_modified(Command):
2404
__doc__ = """List files modified in working tree.
2408
_see_also = ['status', 'ls']
2409
takes_options = ['directory', 'null']
2412
def run(self, null=False, directory=u'.'):
2413
tree = WorkingTree.open_containing(directory)[0]
2414
self.add_cleanup(tree.lock_read().unlock)
2415
td = tree.changes_from(tree.basis_tree())
2417
for path, id, kind, text_modified, meta_modified in td.modified:
2419
self.outf.write(path + '\0')
2421
self.outf.write(osutils.quotefn(path) + '\n')
2424
class cmd_added(Command):
2425
__doc__ = """List files added in working tree.
2429
_see_also = ['status', 'ls']
2430
takes_options = ['directory', 'null']
2433
def run(self, null=False, directory=u'.'):
2434
wt = WorkingTree.open_containing(directory)[0]
2435
self.add_cleanup(wt.lock_read().unlock)
2436
basis = wt.basis_tree()
2437
self.add_cleanup(basis.lock_read().unlock)
2438
basis_inv = basis.inventory
2441
if basis_inv.has_id(file_id):
2443
if inv.is_root(file_id) and len(basis_inv) == 0:
2445
path = inv.id2path(file_id)
2446
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2449
self.outf.write(path + '\0')
2451
self.outf.write(osutils.quotefn(path) + '\n')
2454
class cmd_root(Command):
2455
__doc__ = """Show the tree root directory.
2457
The root is the nearest enclosing directory with a .bzr control
2460
takes_args = ['filename?']
2462
def run(self, filename=None):
2463
"""Print the branch root."""
2464
tree = WorkingTree.open_containing(filename)[0]
2465
self.outf.write(tree.basedir + '\n')
2468
def _parse_limit(limitstring):
2470
return int(limitstring)
2472
msg = gettext("The limit argument must be an integer.")
2473
raise errors.BzrCommandError(msg)
2476
def _parse_levels(s):
2480
msg = gettext("The levels argument must be an integer.")
2481
raise errors.BzrCommandError(msg)
2484
class cmd_log(Command):
2485
__doc__ = """Show historical log for a branch or subset of a branch.
2487
log is bzr's default tool for exploring the history of a branch.
2488
The branch to use is taken from the first parameter. If no parameters
2489
are given, the branch containing the working directory is logged.
2490
Here are some simple examples::
2492
bzr log log the current branch
2493
bzr log foo.py log a file in its branch
2494
bzr log http://server/branch log a branch on a server
2496
The filtering, ordering and information shown for each revision can
2497
be controlled as explained below. By default, all revisions are
2498
shown sorted (topologically) so that newer revisions appear before
2499
older ones and descendants always appear before ancestors. If displayed,
2500
merged revisions are shown indented under the revision in which they
2505
The log format controls how information about each revision is
2506
displayed. The standard log formats are called ``long``, ``short``
2507
and ``line``. The default is long. See ``bzr help log-formats``
2508
for more details on log formats.
2510
The following options can be used to control what information is
2513
-l N display a maximum of N revisions
2514
-n N display N levels of revisions (0 for all, 1 for collapsed)
2515
-v display a status summary (delta) for each revision
2516
-p display a diff (patch) for each revision
2517
--show-ids display revision-ids (and file-ids), not just revnos
2519
Note that the default number of levels to display is a function of the
2520
log format. If the -n option is not used, the standard log formats show
2521
just the top level (mainline).
2523
Status summaries are shown using status flags like A, M, etc. To see
2524
the changes explained using words like ``added`` and ``modified``
2525
instead, use the -vv option.
2529
To display revisions from oldest to newest, use the --forward option.
2530
In most cases, using this option will have little impact on the total
2531
time taken to produce a log, though --forward does not incrementally
2532
display revisions like --reverse does when it can.
2534
:Revision filtering:
2536
The -r option can be used to specify what revision or range of revisions
2537
to filter against. The various forms are shown below::
2539
-rX display revision X
2540
-rX.. display revision X and later
2541
-r..Y display up to and including revision Y
2542
-rX..Y display from X to Y inclusive
2544
See ``bzr help revisionspec`` for details on how to specify X and Y.
2545
Some common examples are given below::
2547
-r-1 show just the tip
2548
-r-10.. show the last 10 mainline revisions
2549
-rsubmit:.. show what's new on this branch
2550
-rancestor:path.. show changes since the common ancestor of this
2551
branch and the one at location path
2552
-rdate:yesterday.. show changes since yesterday
2554
When logging a range of revisions using -rX..Y, log starts at
2555
revision Y and searches back in history through the primary
2556
("left-hand") parents until it finds X. When logging just the
2557
top level (using -n1), an error is reported if X is not found
2558
along the way. If multi-level logging is used (-n0), X may be
2559
a nested merge revision and the log will be truncated accordingly.
2563
If parameters are given and the first one is not a branch, the log
2564
will be filtered to show only those revisions that changed the
2565
nominated files or directories.
2567
Filenames are interpreted within their historical context. To log a
2568
deleted file, specify a revision range so that the file existed at
2569
the end or start of the range.
2571
Historical context is also important when interpreting pathnames of
2572
renamed files/directories. Consider the following example:
2574
* revision 1: add tutorial.txt
2575
* revision 2: modify tutorial.txt
2576
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2580
* ``bzr log guide.txt`` will log the file added in revision 1
2582
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2584
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2585
the original file in revision 2.
2587
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2588
was no file called guide.txt in revision 2.
2590
Renames are always followed by log. By design, there is no need to
2591
explicitly ask for this (and no way to stop logging a file back
2592
until it was last renamed).
2596
The --match option can be used for finding revisions that match a
2597
regular expression in a commit message, committer, author or bug.
2598
Specifying the option several times will match any of the supplied
2599
expressions. --match-author, --match-bugs, --match-committer and
2600
--match-message can be used to only match a specific field.
2604
GUI tools and IDEs are often better at exploring history than command
2605
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2606
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2607
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2608
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2610
You may find it useful to add the aliases below to ``bazaar.conf``::
2614
top = log -l10 --line
2617
``bzr tip`` will then show the latest revision while ``bzr top``
2618
will show the last 10 mainline revisions. To see the details of a
2619
particular revision X, ``bzr show -rX``.
2621
If you are interested in looking deeper into a particular merge X,
2622
use ``bzr log -n0 -rX``.
2624
``bzr log -v`` on a branch with lots of history is currently
2625
very slow. A fix for this issue is currently under development.
2626
With or without that fix, it is recommended that a revision range
2627
be given when using the -v option.
2629
bzr has a generic full-text matching plugin, bzr-search, that can be
2630
used to find revisions matching user names, commit messages, etc.
2631
Among other features, this plugin can find all revisions containing
2632
a list of words but not others.
2634
When exploring non-mainline history on large projects with deep
2635
history, the performance of log can be greatly improved by installing
2636
the historycache plugin. This plugin buffers historical information
2637
trading disk space for faster speed.
2639
takes_args = ['file*']
2640
_see_also = ['log-formats', 'revisionspec']
2643
help='Show from oldest to newest.'),
2645
custom_help('verbose',
2646
help='Show files changed in each revision.'),
2650
type=bzrlib.option._parse_revision_str,
2652
help='Show just the specified revision.'
2653
' See also "help revisionspec".'),
2655
RegistryOption('authors',
2656
'What names to list as authors - first, all or committer.',
2658
lazy_registry=('bzrlib.log', 'author_list_registry'),
2662
help='Number of levels to display - 0 for all, 1 for flat.',
2664
type=_parse_levels),
2666
help='Show revisions whose message matches this '
2667
'regular expression.',
2672
help='Limit the output to the first N revisions.',
2677
help='Show changes made in each revision as a patch.'),
2678
Option('include-merged',
2679
help='Show merged revisions like --levels 0 does.'),
2680
Option('include-merges', hidden=True,
2681
help='Historical alias for --include-merged.'),
2682
Option('omit-merges',
2683
help='Do not report commits with more than one parent.'),
2684
Option('exclude-common-ancestry',
2685
help='Display only the revisions that are not part'
2686
' of both ancestries (require -rX..Y).'
2688
Option('signatures',
2689
help='Show digital signature validity.'),
2692
help='Show revisions whose properties match this '
2695
ListOption('match-message',
2696
help='Show revisions whose message matches this '
2699
ListOption('match-committer',
2700
help='Show revisions whose committer matches this '
2703
ListOption('match-author',
2704
help='Show revisions whose authors match this '
2707
ListOption('match-bugs',
2708
help='Show revisions whose bugs match this '
2712
encoding_type = 'replace'
2715
def run(self, file_list=None, timezone='original',
2726
include_merged=None,
2728
exclude_common_ancestry=False,
2732
match_committer=None,
2736
include_merges=symbol_versioning.DEPRECATED_PARAMETER,
2738
from bzrlib.log import (
2740
make_log_request_dict,
2741
_get_info_for_log_files,
2743
direction = (forward and 'forward') or 'reverse'
2744
if symbol_versioning.deprecated_passed(include_merges):
2745
ui.ui_factory.show_user_warning(
2746
'deprecated_command_option',
2747
deprecated_name='--include-merges',
2748
recommended_name='--include-merged',
2749
deprecated_in_version='2.5',
2750
command=self.invoked_as)
2751
if include_merged is None:
2752
include_merged = include_merges
2754
raise errors.BzrCommandError(gettext(
2755
'{0} and {1} are mutually exclusive').format(
2756
'--include-merges', '--include-merged'))
2757
if include_merged is None:
2758
include_merged = False
2759
if (exclude_common_ancestry
2760
and (revision is None or len(revision) != 2)):
2761
raise errors.BzrCommandError(gettext(
2762
'--exclude-common-ancestry requires -r with two revisions'))
2767
raise errors.BzrCommandError(gettext(
2768
'{0} and {1} are mutually exclusive').format(
2769
'--levels', '--include-merged'))
2771
if change is not None:
2773
raise errors.RangeInChangeOption()
2774
if revision is not None:
2775
raise errors.BzrCommandError(gettext(
2776
'{0} and {1} are mutually exclusive').format(
2777
'--revision', '--change'))
2782
filter_by_dir = False
2784
# find the file ids to log and check for directory filtering
2785
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2786
revision, file_list, self.add_cleanup)
2787
for relpath, file_id, kind in file_info_list:
2789
raise errors.BzrCommandError(gettext(
2790
"Path unknown at end or start of revision range: %s") %
2792
# If the relpath is the top of the tree, we log everything
2797
file_ids.append(file_id)
2798
filter_by_dir = filter_by_dir or (
2799
kind in ['directory', 'tree-reference'])
2802
# FIXME ? log the current subdir only RBC 20060203
2803
if revision is not None \
2804
and len(revision) > 0 and revision[0].get_branch():
2805
location = revision[0].get_branch()
2808
dir, relpath = controldir.ControlDir.open_containing(location)
2809
b = dir.open_branch()
2810
self.add_cleanup(b.lock_read().unlock)
2811
rev1, rev2 = _get_revision_range(revision, b, self.name())
2813
if b.get_config().validate_signatures_in_log():
2817
if not gpg.GPGStrategy.verify_signatures_available():
2818
raise errors.GpgmeNotInstalled(None)
2820
# Decide on the type of delta & diff filtering to use
2821
# TODO: add an --all-files option to make this configurable & consistent
2829
diff_type = 'partial'
2833
# Build the log formatter
2834
if log_format is None:
2835
log_format = log.log_formatter_registry.get_default(b)
2836
# Make a non-encoding output to include the diffs - bug 328007
2837
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2838
lf = log_format(show_ids=show_ids, to_file=self.outf,
2839
to_exact_file=unencoded_output,
2840
show_timezone=timezone,
2841
delta_format=get_verbosity_level(),
2843
show_advice=levels is None,
2844
author_list_handler=authors)
2846
# Choose the algorithm for doing the logging. It's annoying
2847
# having multiple code paths like this but necessary until
2848
# the underlying repository format is faster at generating
2849
# deltas or can provide everything we need from the indices.
2850
# The default algorithm - match-using-deltas - works for
2851
# multiple files and directories and is faster for small
2852
# amounts of history (200 revisions say). However, it's too
2853
# slow for logging a single file in a repository with deep
2854
# history, i.e. > 10K revisions. In the spirit of "do no
2855
# evil when adding features", we continue to use the
2856
# original algorithm - per-file-graph - for the "single
2857
# file that isn't a directory without showing a delta" case.
2858
partial_history = revision and b.repository._format.supports_chks
2859
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2860
or delta_type or partial_history)
2864
match_dict[''] = match
2866
match_dict['message'] = match_message
2868
match_dict['committer'] = match_committer
2870
match_dict['author'] = match_author
2872
match_dict['bugs'] = match_bugs
2874
# Build the LogRequest and execute it
2875
if len(file_ids) == 0:
2877
rqst = make_log_request_dict(
2878
direction=direction, specific_fileids=file_ids,
2879
start_revision=rev1, end_revision=rev2, limit=limit,
2880
message_search=message, delta_type=delta_type,
2881
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2882
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2883
signature=signatures, omit_merges=omit_merges,
2885
Logger(b, rqst).show(lf)
2888
def _get_revision_range(revisionspec_list, branch, command_name):
2889
"""Take the input of a revision option and turn it into a revision range.
2891
It returns RevisionInfo objects which can be used to obtain the rev_id's
2892
of the desired revisions. It does some user input validations.
2894
if revisionspec_list is None:
2897
elif len(revisionspec_list) == 1:
2898
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2899
elif len(revisionspec_list) == 2:
2900
start_spec = revisionspec_list[0]
2901
end_spec = revisionspec_list[1]
2902
if end_spec.get_branch() != start_spec.get_branch():
2903
# b is taken from revision[0].get_branch(), and
2904
# show_log will use its revision_history. Having
2905
# different branches will lead to weird behaviors.
2906
raise errors.BzrCommandError(gettext(
2907
"bzr %s doesn't accept two revisions in different"
2908
" branches.") % command_name)
2909
if start_spec.spec is None:
2910
# Avoid loading all the history.
2911
rev1 = RevisionInfo(branch, None, None)
2913
rev1 = start_spec.in_history(branch)
2914
# Avoid loading all of history when we know a missing
2915
# end of range means the last revision ...
2916
if end_spec.spec is None:
2917
last_revno, last_revision_id = branch.last_revision_info()
2918
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2920
rev2 = end_spec.in_history(branch)
2922
raise errors.BzrCommandError(gettext(
2923
'bzr %s --revision takes one or two values.') % command_name)
2927
def _revision_range_to_revid_range(revision_range):
2930
if revision_range[0] is not None:
2931
rev_id1 = revision_range[0].rev_id
2932
if revision_range[1] is not None:
2933
rev_id2 = revision_range[1].rev_id
2934
return rev_id1, rev_id2
2936
def get_log_format(long=False, short=False, line=False, default='long'):
2937
log_format = default
2941
log_format = 'short'
2947
class cmd_touching_revisions(Command):
2948
__doc__ = """Return revision-ids which affected a particular file.
2950
A more user-friendly interface is "bzr log FILE".
2954
takes_args = ["filename"]
2957
def run(self, filename):
2958
tree, relpath = WorkingTree.open_containing(filename)
2959
file_id = tree.path2id(relpath)
2961
self.add_cleanup(b.lock_read().unlock)
2962
touching_revs = log.find_touching_revisions(b, file_id)
2963
for revno, revision_id, what in touching_revs:
2964
self.outf.write("%6d %s\n" % (revno, what))
2967
class cmd_ls(Command):
2968
__doc__ = """List files in a tree.
2971
_see_also = ['status', 'cat']
2972
takes_args = ['path?']
2976
Option('recursive', short_name='R',
2977
help='Recurse into subdirectories.'),
2979
help='Print paths relative to the root of the branch.'),
2980
Option('unknown', short_name='u',
2981
help='Print unknown files.'),
2982
Option('versioned', help='Print versioned files.',
2984
Option('ignored', short_name='i',
2985
help='Print ignored files.'),
2986
Option('kind', short_name='k',
2987
help='List entries of a particular kind: file, directory, symlink.',
2994
def run(self, revision=None, verbose=False,
2995
recursive=False, from_root=False,
2996
unknown=False, versioned=False, ignored=False,
2997
null=False, kind=None, show_ids=False, path=None, directory=None):
2999
if kind and kind not in ('file', 'directory', 'symlink'):
3000
raise errors.BzrCommandError(gettext('invalid kind specified'))
3002
if verbose and null:
3003
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
3004
all = not (unknown or versioned or ignored)
3006
selection = {'I':ignored, '?':unknown, 'V':versioned}
3012
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
3015
tree, branch, relpath = \
3016
_open_directory_or_containing_tree_or_branch(fs_path, directory)
3018
# Calculate the prefix to use
3022
prefix = relpath + '/'
3023
elif fs_path != '.' and not fs_path.endswith('/'):
3024
prefix = fs_path + '/'
3026
if revision is not None or tree is None:
3027
tree = _get_one_revision_tree('ls', revision, branch=branch)
3030
if isinstance(tree, WorkingTree) and tree.supports_views():
3031
view_files = tree.views.lookup_view()
3034
view_str = views.view_display_str(view_files)
3035
note(gettext("Ignoring files outside view. View is %s") % view_str)
3037
self.add_cleanup(tree.lock_read().unlock)
3038
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
3039
from_dir=relpath, recursive=recursive):
3040
# Apply additional masking
3041
if not all and not selection[fc]:
3043
if kind is not None and fkind != kind:
3048
fullpath = osutils.pathjoin(relpath, fp)
3051
views.check_path_in_view(tree, fullpath)
3052
except errors.FileOutsideView:
3057
fp = osutils.pathjoin(prefix, fp)
3058
kindch = entry.kind_character()
3059
outstring = fp + kindch
3060
ui.ui_factory.clear_term()
3062
outstring = '%-8s %s' % (fc, outstring)
3063
if show_ids and fid is not None:
3064
outstring = "%-50s %s" % (outstring, fid)
3065
self.outf.write(outstring + '\n')
3067
self.outf.write(fp + '\0')
3070
self.outf.write(fid)
3071
self.outf.write('\0')
3079
self.outf.write('%-50s %s\n' % (outstring, my_id))
3081
self.outf.write(outstring + '\n')
3084
class cmd_unknowns(Command):
3085
__doc__ = """List unknown files.
3090
takes_options = ['directory']
3093
def run(self, directory=u'.'):
3094
for f in WorkingTree.open_containing(directory)[0].unknowns():
3095
self.outf.write(osutils.quotefn(f) + '\n')
3098
class cmd_ignore(Command):
3099
__doc__ = """Ignore specified files or patterns.
3101
See ``bzr help patterns`` for details on the syntax of patterns.
3103
If a .bzrignore file does not exist, the ignore command
3104
will create one and add the specified files or patterns to the newly
3105
created file. The ignore command will also automatically add the
3106
.bzrignore file to be versioned. Creating a .bzrignore file without
3107
the use of the ignore command will require an explicit add command.
3109
To remove patterns from the ignore list, edit the .bzrignore file.
3110
After adding, editing or deleting that file either indirectly by
3111
using this command or directly by using an editor, be sure to commit
3114
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3115
the global ignore file can be found in the application data directory as
3116
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3117
Global ignores are not touched by this command. The global ignore file
3118
can be edited directly using an editor.
3120
Patterns prefixed with '!' are exceptions to ignore patterns and take
3121
precedence over regular ignores. Such exceptions are used to specify
3122
files that should be versioned which would otherwise be ignored.
3124
Patterns prefixed with '!!' act as regular ignore patterns, but have
3125
precedence over the '!' exception patterns.
3129
* Ignore patterns containing shell wildcards must be quoted from
3132
* Ignore patterns starting with "#" act as comments in the ignore file.
3133
To ignore patterns that begin with that character, use the "RE:" prefix.
3136
Ignore the top level Makefile::
3138
bzr ignore ./Makefile
3140
Ignore .class files in all directories...::
3142
bzr ignore "*.class"
3144
...but do not ignore "special.class"::
3146
bzr ignore "!special.class"
3148
Ignore files whose name begins with the "#" character::
3152
Ignore .o files under the lib directory::
3154
bzr ignore "lib/**/*.o"
3156
Ignore .o files under the lib directory::
3158
bzr ignore "RE:lib/.*\.o"
3160
Ignore everything but the "debian" toplevel directory::
3162
bzr ignore "RE:(?!debian/).*"
3164
Ignore everything except the "local" toplevel directory,
3165
but always ignore autosave files ending in ~, even under local/::
3168
bzr ignore "!./local"
3172
_see_also = ['status', 'ignored', 'patterns']
3173
takes_args = ['name_pattern*']
3174
takes_options = ['directory',
3175
Option('default-rules',
3176
help='Display the default ignore rules that bzr uses.')
3179
def run(self, name_pattern_list=None, default_rules=None,
3181
from bzrlib import ignores
3182
if default_rules is not None:
3183
# dump the default rules and exit
3184
for pattern in ignores.USER_DEFAULTS:
3185
self.outf.write("%s\n" % pattern)
3187
if not name_pattern_list:
3188
raise errors.BzrCommandError(gettext("ignore requires at least one "
3189
"NAME_PATTERN or --default-rules."))
3190
name_pattern_list = [globbing.normalize_pattern(p)
3191
for p in name_pattern_list]
3193
bad_patterns_count = 0
3194
for p in name_pattern_list:
3195
if not globbing.Globster.is_pattern_valid(p):
3196
bad_patterns_count += 1
3197
bad_patterns += ('\n %s' % p)
3199
msg = (ngettext('Invalid ignore pattern found. %s',
3200
'Invalid ignore patterns found. %s',
3201
bad_patterns_count) % bad_patterns)
3202
ui.ui_factory.show_error(msg)
3203
raise errors.InvalidPattern('')
3204
for name_pattern in name_pattern_list:
3205
if (name_pattern[0] == '/' or
3206
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3207
raise errors.BzrCommandError(gettext(
3208
"NAME_PATTERN should not be an absolute path"))
3209
tree, relpath = WorkingTree.open_containing(directory)
3210
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3211
ignored = globbing.Globster(name_pattern_list)
3213
self.add_cleanup(tree.lock_read().unlock)
3214
for entry in tree.list_files():
3218
if ignored.match(filename):
3219
matches.append(filename)
3220
if len(matches) > 0:
3221
self.outf.write(gettext("Warning: the following files are version "
3222
"controlled and match your ignore pattern:\n%s"
3223
"\nThese files will continue to be version controlled"
3224
" unless you 'bzr remove' them.\n") % ("\n".join(matches),))
3227
class cmd_ignored(Command):
3228
__doc__ = """List ignored files and the patterns that matched them.
3230
List all the ignored files and the ignore pattern that caused the file to
3233
Alternatively, to list just the files::
3238
encoding_type = 'replace'
3239
_see_also = ['ignore', 'ls']
3240
takes_options = ['directory']
3243
def run(self, directory=u'.'):
3244
tree = WorkingTree.open_containing(directory)[0]
3245
self.add_cleanup(tree.lock_read().unlock)
3246
for path, file_class, kind, file_id, entry in tree.list_files():
3247
if file_class != 'I':
3249
## XXX: Slightly inefficient since this was already calculated
3250
pat = tree.is_ignored(path)
3251
self.outf.write('%-50s %s\n' % (path, pat))
3254
class cmd_lookup_revision(Command):
3255
__doc__ = """Lookup the revision-id from a revision-number
3258
bzr lookup-revision 33
3261
takes_args = ['revno']
3262
takes_options = ['directory']
3265
def run(self, revno, directory=u'.'):
3269
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3271
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3272
self.outf.write("%s\n" % revid)
3275
class cmd_export(Command):
3276
__doc__ = """Export current or past revision to a destination directory or archive.
3278
If no revision is specified this exports the last committed revision.
3280
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3281
given, try to find the format with the extension. If no extension
3282
is found exports to a directory (equivalent to --format=dir).
3284
If root is supplied, it will be used as the root directory inside
3285
container formats (tar, zip, etc). If it is not supplied it will default
3286
to the exported filename. The root option has no effect for 'dir' format.
3288
If branch is omitted then the branch containing the current working
3289
directory will be used.
3291
Note: Export of tree with non-ASCII filenames to zip is not supported.
3293
================= =========================
3294
Supported formats Autodetected by extension
3295
================= =========================
3298
tbz2 .tar.bz2, .tbz2
3301
================= =========================
3304
takes_args = ['dest', 'branch_or_subdir?']
3305
takes_options = ['directory',
3307
help="Type of file to export to.",
3310
Option('filters', help='Apply content filters to export the '
3311
'convenient form.'),
3314
help="Name of the root directory inside the exported file."),
3315
Option('per-file-timestamps',
3316
help='Set modification time of files to that of the last '
3317
'revision in which it was changed.'),
3318
Option('uncommitted',
3319
help='Export the working tree contents rather than that of the '
3322
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3323
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3325
from bzrlib.export import export
3327
if branch_or_subdir is None:
3328
branch_or_subdir = directory
3330
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3332
if tree is not None:
3333
self.add_cleanup(tree.lock_read().unlock)
3337
raise errors.BzrCommandError(
3338
gettext("--uncommitted requires a working tree"))
3341
export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3343
export(export_tree, dest, format, root, subdir, filtered=filters,
3344
per_file_timestamps=per_file_timestamps)
3345
except errors.NoSuchExportFormat, e:
3346
raise errors.BzrCommandError(
3347
gettext('Unsupported export format: %s') % e.format)
3350
class cmd_cat(Command):
3351
__doc__ = """Write the contents of a file as of a given revision to standard output.
3353
If no revision is nominated, the last revision is used.
3355
Note: Take care to redirect standard output when using this command on a
3360
takes_options = ['directory',
3361
Option('name-from-revision', help='The path name in the old tree.'),
3362
Option('filters', help='Apply content filters to display the '
3363
'convenience form.'),
3366
takes_args = ['filename']
3367
encoding_type = 'exact'
3370
def run(self, filename, revision=None, name_from_revision=False,
3371
filters=False, directory=None):
3372
if revision is not None and len(revision) != 1:
3373
raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
3374
" one revision specifier"))
3375
tree, branch, relpath = \
3376
_open_directory_or_containing_tree_or_branch(filename, directory)
3377
self.add_cleanup(branch.lock_read().unlock)
3378
return self._run(tree, branch, relpath, filename, revision,
3379
name_from_revision, filters)
3381
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3384
tree = b.basis_tree()
3385
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3386
self.add_cleanup(rev_tree.lock_read().unlock)
3388
old_file_id = rev_tree.path2id(relpath)
3390
# TODO: Split out this code to something that generically finds the
3391
# best id for a path across one or more trees; it's like
3392
# find_ids_across_trees but restricted to find just one. -- mbp
3394
if name_from_revision:
3395
# Try in revision if requested
3396
if old_file_id is None:
3397
raise errors.BzrCommandError(gettext(
3398
"{0!r} is not present in revision {1}").format(
3399
filename, rev_tree.get_revision_id()))
3401
actual_file_id = old_file_id
3403
cur_file_id = tree.path2id(relpath)
3404
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3405
actual_file_id = cur_file_id
3406
elif old_file_id is not None:
3407
actual_file_id = old_file_id
3409
raise errors.BzrCommandError(gettext(
3410
"{0!r} is not present in revision {1}").format(
3411
filename, rev_tree.get_revision_id()))
3413
from bzrlib.filter_tree import ContentFilterTree
3414
filter_tree = ContentFilterTree(rev_tree,
3415
rev_tree._content_filter_stack)
3416
content = filter_tree.get_file_text(actual_file_id)
3418
content = rev_tree.get_file_text(actual_file_id)
3420
self.outf.write(content)
3423
class cmd_local_time_offset(Command):
3424
__doc__ = """Show the offset in seconds from GMT to local time."""
3428
self.outf.write("%s\n" % osutils.local_time_offset())
3432
class cmd_commit(Command):
3433
__doc__ = """Commit changes into a new revision.
3435
An explanatory message needs to be given for each commit. This is
3436
often done by using the --message option (getting the message from the
3437
command line) or by using the --file option (getting the message from
3438
a file). If neither of these options is given, an editor is opened for
3439
the user to enter the message. To see the changed files in the
3440
boilerplate text loaded into the editor, use the --show-diff option.
3442
By default, the entire tree is committed and the person doing the
3443
commit is assumed to be the author. These defaults can be overridden
3448
If selected files are specified, only changes to those files are
3449
committed. If a directory is specified then the directory and
3450
everything within it is committed.
3452
When excludes are given, they take precedence over selected files.
3453
For example, to commit only changes within foo, but not changes
3456
bzr commit foo -x foo/bar
3458
A selective commit after a merge is not yet supported.
3462
If the author of the change is not the same person as the committer,
3463
you can specify the author's name using the --author option. The
3464
name should be in the same format as a committer-id, e.g.
3465
"John Doe <jdoe@example.com>". If there is more than one author of
3466
the change you can specify the option multiple times, once for each
3471
A common mistake is to forget to add a new file or directory before
3472
running the commit command. The --strict option checks for unknown
3473
files and aborts the commit if any are found. More advanced pre-commit
3474
checks can be implemented by defining hooks. See ``bzr help hooks``
3479
If you accidentially commit the wrong changes or make a spelling
3480
mistake in the commit message say, you can use the uncommit command
3481
to undo it. See ``bzr help uncommit`` for details.
3483
Hooks can also be configured to run after a commit. This allows you
3484
to trigger updates to external systems like bug trackers. The --fixes
3485
option can be used to record the association between a revision and
3486
one or more bugs. See ``bzr help bugs`` for details.
3489
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3490
takes_args = ['selected*']
3492
ListOption('exclude', type=str, short_name='x',
3493
help="Do not consider changes made to a given path."),
3494
Option('message', type=unicode,
3496
help="Description of the new revision."),
3499
help='Commit even if nothing has changed.'),
3500
Option('file', type=str,
3503
help='Take commit message from this file.'),
3505
help="Refuse to commit if there are unknown "
3506
"files in the working tree."),
3507
Option('commit-time', type=str,
3508
help="Manually set a commit time using commit date "
3509
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3510
ListOption('fixes', type=str,
3511
help="Mark a bug as being fixed by this revision "
3512
"(see \"bzr help bugs\")."),
3513
ListOption('author', type=unicode,
3514
help="Set the author's name, if it's different "
3515
"from the committer."),
3517
help="Perform a local commit in a bound "
3518
"branch. Local commits are not pushed to "
3519
"the master branch until a normal commit "
3522
Option('show-diff', short_name='p',
3523
help='When no message is supplied, show the diff along'
3524
' with the status summary in the message editor.'),
3526
help='When committing to a foreign version control '
3527
'system do not push data that can not be natively '
3530
aliases = ['ci', 'checkin']
3532
def _iter_bug_fix_urls(self, fixes, branch):
3533
default_bugtracker = None
3534
# Configure the properties for bug fixing attributes.
3535
for fixed_bug in fixes:
3536
tokens = fixed_bug.split(':')
3537
if len(tokens) == 1:
3538
if default_bugtracker is None:
3539
branch_config = branch.get_config()
3540
default_bugtracker = branch_config.get_user_option(
3542
if default_bugtracker is None:
3543
raise errors.BzrCommandError(gettext(
3544
"No tracker specified for bug %s. Use the form "
3545
"'tracker:id' or specify a default bug tracker "
3546
"using the `bugtracker` option.\nSee "
3547
"\"bzr help bugs\" for more information on this "
3548
"feature. Commit refused.") % fixed_bug)
3549
tag = default_bugtracker
3551
elif len(tokens) != 2:
3552
raise errors.BzrCommandError(gettext(
3553
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3554
"See \"bzr help bugs\" for more information on this "
3555
"feature.\nCommit refused.") % fixed_bug)
3557
tag, bug_id = tokens
3559
yield bugtracker.get_bug_url(tag, branch, bug_id)
3560
except errors.UnknownBugTrackerAbbreviation:
3561
raise errors.BzrCommandError(gettext(
3562
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3563
except errors.MalformedBugIdentifier, e:
3564
raise errors.BzrCommandError(gettext(
3565
"%s\nCommit refused.") % (str(e),))
3567
def run(self, message=None, file=None, verbose=False, selected_list=None,
3568
unchanged=False, strict=False, local=False, fixes=None,
3569
author=None, show_diff=False, exclude=None, commit_time=None,
3571
from bzrlib.errors import (
3576
from bzrlib.msgeditor import (
3577
edit_commit_message_encoded,
3578
generate_commit_message_template,
3579
make_commit_message_template_encoded,
3583
commit_stamp = offset = None
3584
if commit_time is not None:
3586
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3587
except ValueError, e:
3588
raise errors.BzrCommandError(gettext(
3589
"Could not parse --commit-time: " + str(e)))
3593
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3594
if selected_list == ['']:
3595
# workaround - commit of root of tree should be exactly the same
3596
# as just default commit in that tree, and succeed even though
3597
# selected-file merge commit is not done yet
3602
bug_property = bugtracker.encode_fixes_bug_urls(
3603
self._iter_bug_fix_urls(fixes, tree.branch))
3605
properties['bugs'] = bug_property
3607
if local and not tree.branch.get_bound_location():
3608
raise errors.LocalRequiresBoundBranch()
3610
if message is not None:
3612
file_exists = osutils.lexists(message)
3613
except UnicodeError:
3614
# The commit message contains unicode characters that can't be
3615
# represented in the filesystem encoding, so that can't be a
3620
'The commit message is a file name: "%(f)s".\n'
3621
'(use --file "%(f)s" to take commit message from that file)'
3623
ui.ui_factory.show_warning(warning_msg)
3625
message = message.replace('\r\n', '\n')
3626
message = message.replace('\r', '\n')
3628
raise errors.BzrCommandError(gettext(
3629
"please specify either --message or --file"))
3631
def get_message(commit_obj):
3632
"""Callback to get commit message"""
3636
my_message = f.read().decode(osutils.get_user_encoding())
3639
elif message is not None:
3640
my_message = message
3642
# No message supplied: make one up.
3643
# text is the status of the tree
3644
text = make_commit_message_template_encoded(tree,
3645
selected_list, diff=show_diff,
3646
output_encoding=osutils.get_user_encoding())
3647
# start_message is the template generated from hooks
3648
# XXX: Warning - looks like hooks return unicode,
3649
# make_commit_message_template_encoded returns user encoding.
3650
# We probably want to be using edit_commit_message instead to
3652
my_message = set_commit_message(commit_obj)
3653
if my_message is None:
3654
start_message = generate_commit_message_template(commit_obj)
3655
my_message = edit_commit_message_encoded(text,
3656
start_message=start_message)
3657
if my_message is None:
3658
raise errors.BzrCommandError(gettext("please specify a commit"
3659
" message with either --message or --file"))
3660
if my_message == "":
3661
raise errors.BzrCommandError(gettext("Empty commit message specified."
3662
" Please specify a commit message with either"
3663
" --message or --file or leave a blank message"
3664
" with --message \"\"."))
3667
# The API permits a commit with a filter of [] to mean 'select nothing'
3668
# but the command line should not do that.
3669
if not selected_list:
3670
selected_list = None
3672
tree.commit(message_callback=get_message,
3673
specific_files=selected_list,
3674
allow_pointless=unchanged, strict=strict, local=local,
3675
reporter=None, verbose=verbose, revprops=properties,
3676
authors=author, timestamp=commit_stamp,
3678
exclude=tree.safe_relpath_files(exclude),
3680
except PointlessCommit:
3681
raise errors.BzrCommandError(gettext("No changes to commit."
3682
" Please 'bzr add' the files you want to commit, or use"
3683
" --unchanged to force an empty commit."))
3684
except ConflictsInTree:
3685
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3686
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3688
except StrictCommitFailed:
3689
raise errors.BzrCommandError(gettext("Commit refused because there are"
3690
" unknown files in the working tree."))
3691
except errors.BoundBranchOutOfDate, e:
3692
e.extra_help = (gettext("\n"
3693
'To commit to master branch, run update and then commit.\n'
3694
'You can also pass --local to commit to continue working '
3699
class cmd_check(Command):
3700
__doc__ = """Validate working tree structure, branch consistency and repository history.
3702
This command checks various invariants about branch and repository storage
3703
to detect data corruption or bzr bugs.
3705
The working tree and branch checks will only give output if a problem is
3706
detected. The output fields of the repository check are:
3709
This is just the number of revisions checked. It doesn't
3713
This is just the number of versionedfiles checked. It
3714
doesn't indicate a problem.
3716
unreferenced ancestors
3717
Texts that are ancestors of other texts, but
3718
are not properly referenced by the revision ancestry. This is a
3719
subtle problem that Bazaar can work around.
3722
This is the total number of unique file contents
3723
seen in the checked revisions. It does not indicate a problem.
3726
This is the total number of repeated texts seen
3727
in the checked revisions. Texts can be repeated when their file
3728
entries are modified, but the file contents are not. It does not
3731
If no restrictions are specified, all Bazaar data that is found at the given
3732
location will be checked.
3736
Check the tree and branch at 'foo'::
3738
bzr check --tree --branch foo
3740
Check only the repository at 'bar'::
3742
bzr check --repo bar
3744
Check everything at 'baz'::
3749
_see_also = ['reconcile']
3750
takes_args = ['path?']
3751
takes_options = ['verbose',
3752
Option('branch', help="Check the branch related to the"
3753
" current directory."),
3754
Option('repo', help="Check the repository related to the"
3755
" current directory."),
3756
Option('tree', help="Check the working tree related to"
3757
" the current directory.")]
3759
def run(self, path=None, verbose=False, branch=False, repo=False,
3761
from bzrlib.check import check_dwim
3764
if not branch and not repo and not tree:
3765
branch = repo = tree = True
3766
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3769
class cmd_upgrade(Command):
3770
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3772
When the default format has changed after a major new release of
3773
Bazaar, you may be informed during certain operations that you
3774
should upgrade. Upgrading to a newer format may improve performance
3775
or make new features available. It may however limit interoperability
3776
with older repositories or with older versions of Bazaar.
3778
If you wish to upgrade to a particular format rather than the
3779
current default, that can be specified using the --format option.
3780
As a consequence, you can use the upgrade command this way to
3781
"downgrade" to an earlier format, though some conversions are
3782
a one way process (e.g. changing from the 1.x default to the
3783
2.x default) so downgrading is not always possible.
3785
A backup.bzr.~#~ directory is created at the start of the conversion
3786
process (where # is a number). By default, this is left there on
3787
completion. If the conversion fails, delete the new .bzr directory
3788
and rename this one back in its place. Use the --clean option to ask
3789
for the backup.bzr directory to be removed on successful conversion.
3790
Alternatively, you can delete it by hand if everything looks good
3793
If the location given is a shared repository, dependent branches
3794
are also converted provided the repository converts successfully.
3795
If the conversion of a branch fails, remaining branches are still
3798
For more information on upgrades, see the Bazaar Upgrade Guide,
3799
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3802
_see_also = ['check', 'reconcile', 'formats']
3803
takes_args = ['url?']
3805
RegistryOption('format',
3806
help='Upgrade to a specific format. See "bzr help'
3807
' formats" for details.',
3808
lazy_registry=('bzrlib.controldir', 'format_registry'),
3809
converter=lambda name: controldir.format_registry.make_bzrdir(name),
3810
value_switches=True, title='Branch format'),
3812
help='Remove the backup.bzr directory if successful.'),
3814
help="Show what would be done, but don't actually do anything."),
3817
def run(self, url='.', format=None, clean=False, dry_run=False):
3818
from bzrlib.upgrade import upgrade
3819
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3821
if len(exceptions) == 1:
3822
# Compatibility with historical behavior
3828
class cmd_whoami(Command):
3829
__doc__ = """Show or set bzr user id.
3832
Show the email of the current user::
3836
Set the current user::
3838
bzr whoami "Frank Chu <fchu@example.com>"
3840
takes_options = [ 'directory',
3842
help='Display email address only.'),
3844
help='Set identity for the current branch instead of '
3847
takes_args = ['name?']
3848
encoding_type = 'replace'
3851
def run(self, email=False, branch=False, name=None, directory=None):
3853
if directory is None:
3854
# use branch if we're inside one; otherwise global config
3856
c = Branch.open_containing(u'.')[0].get_config_stack()
3857
except errors.NotBranchError:
3858
c = _mod_config.GlobalStack()
3860
c = Branch.open(directory).get_config_stack()
3861
identity = c.get('email')
3863
self.outf.write(_mod_config.extract_email_address(identity)
3866
self.outf.write(identity + '\n')
3870
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3873
# display a warning if an email address isn't included in the given name.
3875
_mod_config.extract_email_address(name)
3876
except errors.NoEmailInUsername, e:
3877
warning('"%s" does not seem to contain an email address. '
3878
'This is allowed, but not recommended.', name)
3880
# use global config unless --branch given
3882
if directory is None:
3883
c = Branch.open_containing(u'.')[0].get_config_stack()
3885
c = Branch.open(directory).get_config_stack()
3887
c = _mod_config.GlobalStack()
3888
c.set('email', name)
3891
class cmd_nick(Command):
3892
__doc__ = """Print or set the branch nickname.
3894
If unset, the tree root directory name is used as the nickname.
3895
To print the current nickname, execute with no argument.
3897
Bound branches use the nickname of its master branch unless it is set
3901
_see_also = ['info']
3902
takes_args = ['nickname?']
3903
takes_options = ['directory']
3904
def run(self, nickname=None, directory=u'.'):
3905
branch = Branch.open_containing(directory)[0]
3906
if nickname is None:
3907
self.printme(branch)
3909
branch.nick = nickname
3912
def printme(self, branch):
3913
self.outf.write('%s\n' % branch.nick)
3916
class cmd_alias(Command):
3917
__doc__ = """Set/unset and display aliases.
3920
Show the current aliases::
3924
Show the alias specified for 'll'::
3928
Set an alias for 'll'::
3930
bzr alias ll="log --line -r-10..-1"
3932
To remove an alias for 'll'::
3934
bzr alias --remove ll
3937
takes_args = ['name?']
3939
Option('remove', help='Remove the alias.'),
3942
def run(self, name=None, remove=False):
3944
self.remove_alias(name)
3946
self.print_aliases()
3948
equal_pos = name.find('=')
3950
self.print_alias(name)
3952
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3954
def remove_alias(self, alias_name):
3955
if alias_name is None:
3956
raise errors.BzrCommandError(gettext(
3957
'bzr alias --remove expects an alias to remove.'))
3958
# If alias is not found, print something like:
3959
# unalias: foo: not found
3960
c = _mod_config.GlobalConfig()
3961
c.unset_alias(alias_name)
3964
def print_aliases(self):
3965
"""Print out the defined aliases in a similar format to bash."""
3966
aliases = _mod_config.GlobalConfig().get_aliases()
3967
for key, value in sorted(aliases.iteritems()):
3968
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3971
def print_alias(self, alias_name):
3972
from bzrlib.commands import get_alias
3973
alias = get_alias(alias_name)
3975
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3978
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3980
def set_alias(self, alias_name, alias_command):
3981
"""Save the alias in the global config."""
3982
c = _mod_config.GlobalConfig()
3983
c.set_alias(alias_name, alias_command)
3986
class cmd_selftest(Command):
3987
__doc__ = """Run internal test suite.
3989
If arguments are given, they are regular expressions that say which tests
3990
should run. Tests matching any expression are run, and other tests are
3993
Alternatively if --first is given, matching tests are run first and then
3994
all other tests are run. This is useful if you have been working in a
3995
particular area, but want to make sure nothing else was broken.
3997
If --exclude is given, tests that match that regular expression are
3998
excluded, regardless of whether they match --first or not.
4000
To help catch accidential dependencies between tests, the --randomize
4001
option is useful. In most cases, the argument used is the word 'now'.
4002
Note that the seed used for the random number generator is displayed
4003
when this option is used. The seed can be explicitly passed as the
4004
argument to this option if required. This enables reproduction of the
4005
actual ordering used if and when an order sensitive problem is encountered.
4007
If --list-only is given, the tests that would be run are listed. This is
4008
useful when combined with --first, --exclude and/or --randomize to
4009
understand their impact. The test harness reports "Listed nn tests in ..."
4010
instead of "Ran nn tests in ..." when list mode is enabled.
4012
If the global option '--no-plugins' is given, plugins are not loaded
4013
before running the selftests. This has two effects: features provided or
4014
modified by plugins will not be tested, and tests provided by plugins will
4017
Tests that need working space on disk use a common temporary directory,
4018
typically inside $TMPDIR or /tmp.
4020
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
4021
into a pdb postmortem session.
4023
The --coverage=DIRNAME global option produces a report with covered code
4027
Run only tests relating to 'ignore'::
4031
Disable plugins and list tests as they're run::
4033
bzr --no-plugins selftest -v
4035
# NB: this is used from the class without creating an instance, which is
4036
# why it does not have a self parameter.
4037
def get_transport_type(typestring):
4038
"""Parse and return a transport specifier."""
4039
if typestring == "sftp":
4040
from bzrlib.tests import stub_sftp
4041
return stub_sftp.SFTPAbsoluteServer
4042
elif typestring == "memory":
4043
from bzrlib.tests import test_server
4044
return memory.MemoryServer
4045
elif typestring == "fakenfs":
4046
from bzrlib.tests import test_server
4047
return test_server.FakeNFSServer
4048
msg = "No known transport type %s. Supported types are: sftp\n" %\
4050
raise errors.BzrCommandError(msg)
4053
takes_args = ['testspecs*']
4054
takes_options = ['verbose',
4056
help='Stop when one test fails.',
4060
help='Use a different transport by default '
4061
'throughout the test suite.',
4062
type=get_transport_type),
4064
help='Run the benchmarks rather than selftests.',
4066
Option('lsprof-timed',
4067
help='Generate lsprof output for benchmarked'
4068
' sections of code.'),
4069
Option('lsprof-tests',
4070
help='Generate lsprof output for each test.'),
4072
help='Run all tests, but run specified tests first.',
4076
help='List the tests instead of running them.'),
4077
RegistryOption('parallel',
4078
help="Run the test suite in parallel.",
4079
lazy_registry=('bzrlib.tests', 'parallel_registry'),
4080
value_switches=False,
4082
Option('randomize', type=str, argname="SEED",
4083
help='Randomize the order of tests using the given'
4084
' seed or "now" for the current time.'),
4085
ListOption('exclude', type=str, argname="PATTERN",
4087
help='Exclude tests that match this regular'
4090
help='Output test progress via subunit.'),
4091
Option('strict', help='Fail on missing dependencies or '
4093
Option('load-list', type=str, argname='TESTLISTFILE',
4094
help='Load a test id list from a text file.'),
4095
ListOption('debugflag', type=str, short_name='E',
4096
help='Turn on a selftest debug flag.'),
4097
ListOption('starting-with', type=str, argname='TESTID',
4098
param_name='starting_with', short_name='s',
4100
'Load only the tests starting with TESTID.'),
4102
help="By default we disable fsync and fdatasync"
4103
" while running the test suite.")
4105
encoding_type = 'replace'
4108
Command.__init__(self)
4109
self.additional_selftest_args = {}
4111
def run(self, testspecs_list=None, verbose=False, one=False,
4112
transport=None, benchmark=None,
4114
first=False, list_only=False,
4115
randomize=None, exclude=None, strict=False,
4116
load_list=None, debugflag=None, starting_with=None, subunit=False,
4117
parallel=None, lsprof_tests=False,
4120
# During selftest, disallow proxying, as it can cause severe
4121
# performance penalties and is only needed for thread
4122
# safety. The selftest command is assumed to not use threads
4123
# too heavily. The call should be as early as possible, as
4124
# error reporting for past duplicate imports won't have useful
4126
lazy_import.disallow_proxying()
4128
from bzrlib import tests
4130
if testspecs_list is not None:
4131
pattern = '|'.join(testspecs_list)
4136
from bzrlib.tests import SubUnitBzrRunner
4138
raise errors.BzrCommandError(gettext("subunit not available. subunit "
4139
"needs to be installed to use --subunit."))
4140
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
4141
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4142
# stdout, which would corrupt the subunit stream.
4143
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4144
# following code can be deleted when it's sufficiently deployed
4145
# -- vila/mgz 20100514
4146
if (sys.platform == "win32"
4147
and getattr(sys.stdout, 'fileno', None) is not None):
4149
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4151
self.additional_selftest_args.setdefault(
4152
'suite_decorators', []).append(parallel)
4154
raise errors.BzrCommandError(gettext(
4155
"--benchmark is no longer supported from bzr 2.2; "
4156
"use bzr-usertest instead"))
4157
test_suite_factory = None
4159
exclude_pattern = None
4161
exclude_pattern = '(' + '|'.join(exclude) + ')'
4163
self._disable_fsync()
4164
selftest_kwargs = {"verbose": verbose,
4166
"stop_on_failure": one,
4167
"transport": transport,
4168
"test_suite_factory": test_suite_factory,
4169
"lsprof_timed": lsprof_timed,
4170
"lsprof_tests": lsprof_tests,
4171
"matching_tests_first": first,
4172
"list_only": list_only,
4173
"random_seed": randomize,
4174
"exclude_pattern": exclude_pattern,
4176
"load_list": load_list,
4177
"debug_flags": debugflag,
4178
"starting_with": starting_with
4180
selftest_kwargs.update(self.additional_selftest_args)
4182
# Make deprecation warnings visible, unless -Werror is set
4183
cleanup = symbol_versioning.activate_deprecation_warnings(
4186
result = tests.selftest(**selftest_kwargs)
4189
return int(not result)
4191
def _disable_fsync(self):
4192
"""Change the 'os' functionality to not synchronize."""
4193
self._orig_fsync = getattr(os, 'fsync', None)
4194
if self._orig_fsync is not None:
4195
os.fsync = lambda filedes: None
4196
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4197
if self._orig_fdatasync is not None:
4198
os.fdatasync = lambda filedes: None
4201
class cmd_version(Command):
4202
__doc__ = """Show version of bzr."""
4204
encoding_type = 'replace'
4206
Option("short", help="Print just the version number."),
4210
def run(self, short=False):
4211
from bzrlib.version import show_version
4213
self.outf.write(bzrlib.version_string + '\n')
4215
show_version(to_file=self.outf)
4218
class cmd_rocks(Command):
4219
__doc__ = """Statement of optimism."""
4225
self.outf.write(gettext("It sure does!\n"))
4228
class cmd_find_merge_base(Command):
4229
__doc__ = """Find and print a base revision for merging two branches."""
4230
# TODO: Options to specify revisions on either side, as if
4231
# merging only part of the history.
4232
takes_args = ['branch', 'other']
4236
def run(self, branch, other):
4237
from bzrlib.revision import ensure_null
4239
branch1 = Branch.open_containing(branch)[0]
4240
branch2 = Branch.open_containing(other)[0]
4241
self.add_cleanup(branch1.lock_read().unlock)
4242
self.add_cleanup(branch2.lock_read().unlock)
4243
last1 = ensure_null(branch1.last_revision())
4244
last2 = ensure_null(branch2.last_revision())
4246
graph = branch1.repository.get_graph(branch2.repository)
4247
base_rev_id = graph.find_unique_lca(last1, last2)
4249
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4252
class cmd_merge(Command):
4253
__doc__ = """Perform a three-way merge.
4255
The source of the merge can be specified either in the form of a branch,
4256
or in the form of a path to a file containing a merge directive generated
4257
with bzr send. If neither is specified, the default is the upstream branch
4258
or the branch most recently merged using --remember. The source of the
4259
merge may also be specified in the form of a path to a file in another
4260
branch: in this case, only the modifications to that file are merged into
4261
the current working tree.
4263
When merging from a branch, by default bzr will try to merge in all new
4264
work from the other branch, automatically determining an appropriate base
4265
revision. If this fails, you may need to give an explicit base.
4267
To pick a different ending revision, pass "--revision OTHER". bzr will
4268
try to merge in all new work up to and including revision OTHER.
4270
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4271
through OTHER, excluding BASE but including OTHER, will be merged. If this
4272
causes some revisions to be skipped, i.e. if the destination branch does
4273
not already contain revision BASE, such a merge is commonly referred to as
4274
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4275
cherrypicks. The changes look like a normal commit, and the history of the
4276
changes from the other branch is not stored in the commit.
4278
Revision numbers are always relative to the source branch.
4280
Merge will do its best to combine the changes in two branches, but there
4281
are some kinds of problems only a human can fix. When it encounters those,
4282
it will mark a conflict. A conflict means that you need to fix something,
4283
before you can commit.
4285
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
4287
If there is no default branch set, the first merge will set it (use
4288
--no-remember to avoid setting it). After that, you can omit the branch
4289
to use the default. To change the default, use --remember. The value will
4290
only be saved if the remote location can be accessed.
4292
The results of the merge are placed into the destination working
4293
directory, where they can be reviewed (with bzr diff), tested, and then
4294
committed to record the result of the merge.
4296
merge refuses to run if there are any uncommitted changes, unless
4297
--force is given. If --force is given, then the changes from the source
4298
will be merged with the current working tree, including any uncommitted
4299
changes in the tree. The --force option can also be used to create a
4300
merge revision which has more than two parents.
4302
If one would like to merge changes from the working tree of the other
4303
branch without merging any committed revisions, the --uncommitted option
4306
To select only some changes to merge, use "merge -i", which will prompt
4307
you to apply each diff hunk and file change, similar to "shelve".
4310
To merge all new revisions from bzr.dev::
4312
bzr merge ../bzr.dev
4314
To merge changes up to and including revision 82 from bzr.dev::
4316
bzr merge -r 82 ../bzr.dev
4318
To merge the changes introduced by 82, without previous changes::
4320
bzr merge -r 81..82 ../bzr.dev
4322
To apply a merge directive contained in /tmp/merge::
4324
bzr merge /tmp/merge
4326
To create a merge revision with three parents from two branches
4327
feature1a and feature1b:
4329
bzr merge ../feature1a
4330
bzr merge ../feature1b --force
4331
bzr commit -m 'revision with three parents'
4334
encoding_type = 'exact'
4335
_see_also = ['update', 'remerge', 'status-flags', 'send']
4336
takes_args = ['location?']
4341
help='Merge even if the destination tree has uncommitted changes.'),
4345
Option('show-base', help="Show base revision text in "
4347
Option('uncommitted', help='Apply uncommitted changes'
4348
' from a working copy, instead of branch changes.'),
4349
Option('pull', help='If the destination is already'
4350
' completely merged into the source, pull from the'
4351
' source rather than merging. When this happens,'
4352
' you do not need to commit the result.'),
4353
custom_help('directory',
4354
help='Branch to merge into, '
4355
'rather than the one containing the working directory.'),
4356
Option('preview', help='Instead of merging, show a diff of the'
4358
Option('interactive', help='Select changes interactively.',
4362
def run(self, location=None, revision=None, force=False,
4363
merge_type=None, show_base=False, reprocess=None, remember=None,
4364
uncommitted=False, pull=False,
4369
if merge_type is None:
4370
merge_type = _mod_merge.Merge3Merger
4372
if directory is None: directory = u'.'
4373
possible_transports = []
4375
allow_pending = True
4376
verified = 'inapplicable'
4378
tree = WorkingTree.open_containing(directory)[0]
4379
if tree.branch.revno() == 0:
4380
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4381
'https://bugs.launchpad.net/bzr/+bug/308562'))
4384
basis_tree = tree.revision_tree(tree.last_revision())
4385
except errors.NoSuchRevision:
4386
basis_tree = tree.basis_tree()
4388
# die as quickly as possible if there are uncommitted changes
4390
if tree.has_changes():
4391
raise errors.UncommittedChanges(tree)
4393
view_info = _get_view_info_for_change_reporter(tree)
4394
change_reporter = delta._ChangeReporter(
4395
unversioned_filter=tree.is_ignored, view_info=view_info)
4396
pb = ui.ui_factory.nested_progress_bar()
4397
self.add_cleanup(pb.finished)
4398
self.add_cleanup(tree.lock_write().unlock)
4399
if location is not None:
4401
mergeable = bundle.read_mergeable_from_url(location,
4402
possible_transports=possible_transports)
4403
except errors.NotABundle:
4407
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4408
' with bundles or merge directives.'))
4410
if revision is not None:
4411
raise errors.BzrCommandError(gettext(
4412
'Cannot use -r with merge directives or bundles'))
4413
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4416
if merger is None and uncommitted:
4417
if revision is not None and len(revision) > 0:
4418
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4419
' --revision at the same time.'))
4420
merger = self.get_merger_from_uncommitted(tree, location, None)
4421
allow_pending = False
4424
merger, allow_pending = self._get_merger_from_branch(tree,
4425
location, revision, remember, possible_transports, None)
4427
merger.merge_type = merge_type
4428
merger.reprocess = reprocess
4429
merger.show_base = show_base
4430
self.sanity_check_merger(merger)
4431
if (merger.base_rev_id == merger.other_rev_id and
4432
merger.other_rev_id is not None):
4433
# check if location is a nonexistent file (and not a branch) to
4434
# disambiguate the 'Nothing to do'
4435
if merger.interesting_files:
4436
if not merger.other_tree.has_filename(
4437
merger.interesting_files[0]):
4438
note(gettext("merger: ") + str(merger))
4439
raise errors.PathsDoNotExist([location])
4440
note(gettext('Nothing to do.'))
4442
if pull and not preview:
4443
if merger.interesting_files is not None:
4444
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4445
if (merger.base_rev_id == tree.last_revision()):
4446
result = tree.pull(merger.other_branch, False,
4447
merger.other_rev_id)
4448
result.report(self.outf)
4450
if merger.this_basis is None:
4451
raise errors.BzrCommandError(gettext(
4452
"This branch has no commits."
4453
" (perhaps you would prefer 'bzr pull')"))
4455
return self._do_preview(merger)
4457
return self._do_interactive(merger)
4459
return self._do_merge(merger, change_reporter, allow_pending,
4462
def _get_preview(self, merger):
4463
tree_merger = merger.make_merger()
4464
tt = tree_merger.make_preview_transform()
4465
self.add_cleanup(tt.finalize)
4466
result_tree = tt.get_preview_tree()
4469
def _do_preview(self, merger):
4470
from bzrlib.diff import show_diff_trees
4471
result_tree = self._get_preview(merger)
4472
path_encoding = osutils.get_diff_header_encoding()
4473
show_diff_trees(merger.this_tree, result_tree, self.outf,
4474
old_label='', new_label='',
4475
path_encoding=path_encoding)
4477
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4478
merger.change_reporter = change_reporter
4479
conflict_count = merger.do_merge()
4481
merger.set_pending()
4482
if verified == 'failed':
4483
warning('Preview patch does not match changes')
4484
if conflict_count != 0:
4489
def _do_interactive(self, merger):
4490
"""Perform an interactive merge.
4492
This works by generating a preview tree of the merge, then using
4493
Shelver to selectively remove the differences between the working tree
4494
and the preview tree.
4496
from bzrlib import shelf_ui
4497
result_tree = self._get_preview(merger)
4498
writer = bzrlib.option.diff_writer_registry.get()
4499
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4500
reporter=shelf_ui.ApplyReporter(),
4501
diff_writer=writer(sys.stdout))
4507
def sanity_check_merger(self, merger):
4508
if (merger.show_base and
4509
not merger.merge_type is _mod_merge.Merge3Merger):
4510
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4511
" merge type. %s") % merger.merge_type)
4512
if merger.reprocess is None:
4513
if merger.show_base:
4514
merger.reprocess = False
4516
# Use reprocess if the merger supports it
4517
merger.reprocess = merger.merge_type.supports_reprocess
4518
if merger.reprocess and not merger.merge_type.supports_reprocess:
4519
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4520
" for merge type %s.") %
4522
if merger.reprocess and merger.show_base:
4523
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4526
def _get_merger_from_branch(self, tree, location, revision, remember,
4527
possible_transports, pb):
4528
"""Produce a merger from a location, assuming it refers to a branch."""
4529
from bzrlib.tag import _merge_tags_if_possible
4530
# find the branch locations
4531
other_loc, user_location = self._select_branch_location(tree, location,
4533
if revision is not None and len(revision) == 2:
4534
base_loc, _unused = self._select_branch_location(tree,
4535
location, revision, 0)
4537
base_loc = other_loc
4539
other_branch, other_path = Branch.open_containing(other_loc,
4540
possible_transports)
4541
if base_loc == other_loc:
4542
base_branch = other_branch
4544
base_branch, base_path = Branch.open_containing(base_loc,
4545
possible_transports)
4546
# Find the revision ids
4547
other_revision_id = None
4548
base_revision_id = None
4549
if revision is not None:
4550
if len(revision) >= 1:
4551
other_revision_id = revision[-1].as_revision_id(other_branch)
4552
if len(revision) == 2:
4553
base_revision_id = revision[0].as_revision_id(base_branch)
4554
if other_revision_id is None:
4555
other_revision_id = _mod_revision.ensure_null(
4556
other_branch.last_revision())
4557
# Remember where we merge from. We need to remember if:
4558
# - user specify a location (and we don't merge from the parent
4560
# - user ask to remember or there is no previous location set to merge
4561
# from and user didn't ask to *not* remember
4562
if (user_location is not None
4564
or (remember is None
4565
and tree.branch.get_submit_branch() is None)))):
4566
tree.branch.set_submit_branch(other_branch.base)
4567
# Merge tags (but don't set them in the master branch yet, the user
4568
# might revert this merge). Commit will propagate them.
4569
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4570
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4571
other_revision_id, base_revision_id, other_branch, base_branch)
4572
if other_path != '':
4573
allow_pending = False
4574
merger.interesting_files = [other_path]
4576
allow_pending = True
4577
return merger, allow_pending
4579
def get_merger_from_uncommitted(self, tree, location, pb):
4580
"""Get a merger for uncommitted changes.
4582
:param tree: The tree the merger should apply to.
4583
:param location: The location containing uncommitted changes.
4584
:param pb: The progress bar to use for showing progress.
4586
location = self._select_branch_location(tree, location)[0]
4587
other_tree, other_path = WorkingTree.open_containing(location)
4588
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4589
if other_path != '':
4590
merger.interesting_files = [other_path]
4593
def _select_branch_location(self, tree, user_location, revision=None,
4595
"""Select a branch location, according to possible inputs.
4597
If provided, branches from ``revision`` are preferred. (Both
4598
``revision`` and ``index`` must be supplied.)
4600
Otherwise, the ``location`` parameter is used. If it is None, then the
4601
``submit`` or ``parent`` location is used, and a note is printed.
4603
:param tree: The working tree to select a branch for merging into
4604
:param location: The location entered by the user
4605
:param revision: The revision parameter to the command
4606
:param index: The index to use for the revision parameter. Negative
4607
indices are permitted.
4608
:return: (selected_location, user_location). The default location
4609
will be the user-entered location.
4611
if (revision is not None and index is not None
4612
and revision[index] is not None):
4613
branch = revision[index].get_branch()
4614
if branch is not None:
4615
return branch, branch
4616
if user_location is None:
4617
location = self._get_remembered(tree, 'Merging from')
4619
location = user_location
4620
return location, user_location
4622
def _get_remembered(self, tree, verb_string):
4623
"""Use tree.branch's parent if none was supplied.
4625
Report if the remembered location was used.
4627
stored_location = tree.branch.get_submit_branch()
4628
stored_location_type = "submit"
4629
if stored_location is None:
4630
stored_location = tree.branch.get_parent()
4631
stored_location_type = "parent"
4632
mutter("%s", stored_location)
4633
if stored_location is None:
4634
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4635
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4636
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4637
stored_location_type, display_url))
4638
return stored_location
4641
class cmd_remerge(Command):
4642
__doc__ = """Redo a merge.
4644
Use this if you want to try a different merge technique while resolving
4645
conflicts. Some merge techniques are better than others, and remerge
4646
lets you try different ones on different files.
4648
The options for remerge have the same meaning and defaults as the ones for
4649
merge. The difference is that remerge can (only) be run when there is a
4650
pending merge, and it lets you specify particular files.
4653
Re-do the merge of all conflicted files, and show the base text in
4654
conflict regions, in addition to the usual THIS and OTHER texts::
4656
bzr remerge --show-base
4658
Re-do the merge of "foobar", using the weave merge algorithm, with
4659
additional processing to reduce the size of conflict regions::
4661
bzr remerge --merge-type weave --reprocess foobar
4663
takes_args = ['file*']
4668
help="Show base revision text in conflicts."),
4671
def run(self, file_list=None, merge_type=None, show_base=False,
4673
from bzrlib.conflicts import restore
4674
if merge_type is None:
4675
merge_type = _mod_merge.Merge3Merger
4676
tree, file_list = WorkingTree.open_containing_paths(file_list)
4677
self.add_cleanup(tree.lock_write().unlock)
4678
parents = tree.get_parent_ids()
4679
if len(parents) != 2:
4680
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4681
" merges. Not cherrypicking or"
4683
repository = tree.branch.repository
4684
interesting_ids = None
4686
conflicts = tree.conflicts()
4687
if file_list is not None:
4688
interesting_ids = set()
4689
for filename in file_list:
4690
file_id = tree.path2id(filename)
4692
raise errors.NotVersionedError(filename)
4693
interesting_ids.add(file_id)
4694
if tree.kind(file_id) != "directory":
4697
for name, ie in tree.inventory.iter_entries(file_id):
4698
interesting_ids.add(ie.file_id)
4699
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4701
# Remerge only supports resolving contents conflicts
4702
allowed_conflicts = ('text conflict', 'contents conflict')
4703
restore_files = [c.path for c in conflicts
4704
if c.typestring in allowed_conflicts]
4705
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4706
tree.set_conflicts(ConflictList(new_conflicts))
4707
if file_list is not None:
4708
restore_files = file_list
4709
for filename in restore_files:
4711
restore(tree.abspath(filename))
4712
except errors.NotConflicted:
4714
# Disable pending merges, because the file texts we are remerging
4715
# have not had those merges performed. If we use the wrong parents
4716
# list, we imply that the working tree text has seen and rejected
4717
# all the changes from the other tree, when in fact those changes
4718
# have not yet been seen.
4719
tree.set_parent_ids(parents[:1])
4721
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4722
merger.interesting_ids = interesting_ids
4723
merger.merge_type = merge_type
4724
merger.show_base = show_base
4725
merger.reprocess = reprocess
4726
conflicts = merger.do_merge()
4728
tree.set_parent_ids(parents)
4735
class cmd_revert(Command):
4736
__doc__ = """Revert files to a previous revision.
4738
Giving a list of files will revert only those files. Otherwise, all files
4739
will be reverted. If the revision is not specified with '--revision', the
4740
last committed revision is used.
4742
To remove only some changes, without reverting to a prior version, use
4743
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4744
will remove the changes introduced by the second last commit (-2), without
4745
affecting the changes introduced by the last commit (-1). To remove
4746
certain changes on a hunk-by-hunk basis, see the shelve command.
4748
By default, any files that have been manually changed will be backed up
4749
first. (Files changed only by merge are not backed up.) Backup files have
4750
'.~#~' appended to their name, where # is a number.
4752
When you provide files, you can use their current pathname or the pathname
4753
from the target revision. So you can use revert to "undelete" a file by
4754
name. If you name a directory, all the contents of that directory will be
4757
If you have newly added files since the target revision, they will be
4758
removed. If the files to be removed have been changed, backups will be
4759
created as above. Directories containing unknown files will not be
4762
The working tree contains a list of revisions that have been merged but
4763
not yet committed. These revisions will be included as additional parents
4764
of the next commit. Normally, using revert clears that list as well as
4765
reverting the files. If any files are specified, revert leaves the list
4766
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4767
.`` in the tree root to revert all files but keep the recorded merges,
4768
and ``bzr revert --forget-merges`` to clear the pending merge list without
4769
reverting any files.
4771
Using "bzr revert --forget-merges", it is possible to apply all of the
4772
changes from a branch in a single revision. To do this, perform the merge
4773
as desired. Then doing revert with the "--forget-merges" option will keep
4774
the content of the tree as it was, but it will clear the list of pending
4775
merges. The next commit will then contain all of the changes that are
4776
present in the other branch, but without any other parent revisions.
4777
Because this technique forgets where these changes originated, it may
4778
cause additional conflicts on later merges involving the same source and
4782
_see_also = ['cat', 'export', 'merge', 'shelve']
4785
Option('no-backup', "Do not save backups of reverted files."),
4786
Option('forget-merges',
4787
'Remove pending merge marker, without changing any files.'),
4789
takes_args = ['file*']
4791
def run(self, revision=None, no_backup=False, file_list=None,
4792
forget_merges=None):
4793
tree, file_list = WorkingTree.open_containing_paths(file_list)
4794
self.add_cleanup(tree.lock_tree_write().unlock)
4796
tree.set_parent_ids(tree.get_parent_ids()[:1])
4798
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4801
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4802
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4803
tree.revert(file_list, rev_tree, not no_backup, None,
4804
report_changes=True)
4807
class cmd_assert_fail(Command):
4808
__doc__ = """Test reporting of assertion failures"""
4809
# intended just for use in testing
4814
raise AssertionError("always fails")
4817
class cmd_help(Command):
4818
__doc__ = """Show help on a command or other topic.
4821
_see_also = ['topics']
4823
Option('long', 'Show help on all commands.'),
4825
takes_args = ['topic?']
4826
aliases = ['?', '--help', '-?', '-h']
4829
def run(self, topic=None, long=False):
4831
if topic is None and long:
4833
bzrlib.help.help(topic)
4836
class cmd_shell_complete(Command):
4837
__doc__ = """Show appropriate completions for context.
4839
For a list of all available commands, say 'bzr shell-complete'.
4841
takes_args = ['context?']
4846
def run(self, context=None):
4847
from bzrlib import shellcomplete
4848
shellcomplete.shellcomplete(context)
4851
class cmd_missing(Command):
4852
__doc__ = """Show unmerged/unpulled revisions between two branches.
4854
OTHER_BRANCH may be local or remote.
4856
To filter on a range of revisions, you can use the command -r begin..end
4857
-r revision requests a specific revision, -r ..end or -r begin.. are
4861
1 - some missing revisions
4862
0 - no missing revisions
4866
Determine the missing revisions between this and the branch at the
4867
remembered pull location::
4871
Determine the missing revisions between this and another branch::
4873
bzr missing http://server/branch
4875
Determine the missing revisions up to a specific revision on the other
4878
bzr missing -r ..-10
4880
Determine the missing revisions up to a specific revision on this
4883
bzr missing --my-revision ..-10
4886
_see_also = ['merge', 'pull']
4887
takes_args = ['other_branch?']
4890
Option('reverse', 'Reverse the order of revisions.'),
4892
'Display changes in the local branch only.'),
4893
Option('this' , 'Same as --mine-only.'),
4894
Option('theirs-only',
4895
'Display changes in the remote branch only.'),
4896
Option('other', 'Same as --theirs-only.'),
4900
custom_help('revision',
4901
help='Filter on other branch revisions (inclusive). '
4902
'See "help revisionspec" for details.'),
4903
Option('my-revision',
4904
type=_parse_revision_str,
4905
help='Filter on local branch revisions (inclusive). '
4906
'See "help revisionspec" for details.'),
4907
Option('include-merged',
4908
'Show all revisions in addition to the mainline ones.'),
4909
Option('include-merges', hidden=True,
4910
help='Historical alias for --include-merged.'),
4912
encoding_type = 'replace'
4915
def run(self, other_branch=None, reverse=False, mine_only=False,
4917
log_format=None, long=False, short=False, line=False,
4918
show_ids=False, verbose=False, this=False, other=False,
4919
include_merged=None, revision=None, my_revision=None,
4921
include_merges=symbol_versioning.DEPRECATED_PARAMETER):
4922
from bzrlib.missing import find_unmerged, iter_log_revisions
4927
if symbol_versioning.deprecated_passed(include_merges):
4928
ui.ui_factory.show_user_warning(
4929
'deprecated_command_option',
4930
deprecated_name='--include-merges',
4931
recommended_name='--include-merged',
4932
deprecated_in_version='2.5',
4933
command=self.invoked_as)
4934
if include_merged is None:
4935
include_merged = include_merges
4937
raise errors.BzrCommandError(gettext(
4938
'{0} and {1} are mutually exclusive').format(
4939
'--include-merges', '--include-merged'))
4940
if include_merged is None:
4941
include_merged = False
4946
# TODO: We should probably check that we don't have mine-only and
4947
# theirs-only set, but it gets complicated because we also have
4948
# this and other which could be used.
4955
local_branch = Branch.open_containing(directory)[0]
4956
self.add_cleanup(local_branch.lock_read().unlock)
4958
parent = local_branch.get_parent()
4959
if other_branch is None:
4960
other_branch = parent
4961
if other_branch is None:
4962
raise errors.BzrCommandError(gettext("No peer location known"
4964
display_url = urlutils.unescape_for_display(parent,
4966
message(gettext("Using saved parent location: {0}\n").format(
4969
remote_branch = Branch.open(other_branch)
4970
if remote_branch.base == local_branch.base:
4971
remote_branch = local_branch
4973
self.add_cleanup(remote_branch.lock_read().unlock)
4975
local_revid_range = _revision_range_to_revid_range(
4976
_get_revision_range(my_revision, local_branch,
4979
remote_revid_range = _revision_range_to_revid_range(
4980
_get_revision_range(revision,
4981
remote_branch, self.name()))
4983
local_extra, remote_extra = find_unmerged(
4984
local_branch, remote_branch, restrict,
4985
backward=not reverse,
4986
include_merged=include_merged,
4987
local_revid_range=local_revid_range,
4988
remote_revid_range=remote_revid_range)
4990
if log_format is None:
4991
registry = log.log_formatter_registry
4992
log_format = registry.get_default(local_branch)
4993
lf = log_format(to_file=self.outf,
4995
show_timezone='original')
4998
if local_extra and not theirs_only:
4999
message(ngettext("You have %d extra revision:\n",
5000
"You have %d extra revisions:\n",
5003
for revision in iter_log_revisions(local_extra,
5004
local_branch.repository,
5006
lf.log_revision(revision)
5007
printed_local = True
5010
printed_local = False
5012
if remote_extra and not mine_only:
5013
if printed_local is True:
5015
message(ngettext("You are missing %d revision:\n",
5016
"You are missing %d revisions:\n",
5017
len(remote_extra)) %
5019
for revision in iter_log_revisions(remote_extra,
5020
remote_branch.repository,
5022
lf.log_revision(revision)
5025
if mine_only and not local_extra:
5026
# We checked local, and found nothing extra
5027
message(gettext('This branch has no new revisions.\n'))
5028
elif theirs_only and not remote_extra:
5029
# We checked remote, and found nothing extra
5030
message(gettext('Other branch has no new revisions.\n'))
5031
elif not (mine_only or theirs_only or local_extra or
5033
# We checked both branches, and neither one had extra
5035
message(gettext("Branches are up to date.\n"))
5037
if not status_code and parent is None and other_branch is not None:
5038
self.add_cleanup(local_branch.lock_write().unlock)
5039
# handle race conditions - a parent might be set while we run.
5040
if local_branch.get_parent() is None:
5041
local_branch.set_parent(remote_branch.base)
5045
class cmd_pack(Command):
5046
__doc__ = """Compress the data within a repository.
5048
This operation compresses the data within a bazaar repository. As
5049
bazaar supports automatic packing of repository, this operation is
5050
normally not required to be done manually.
5052
During the pack operation, bazaar takes a backup of existing repository
5053
data, i.e. pack files. This backup is eventually removed by bazaar
5054
automatically when it is safe to do so. To save disk space by removing
5055
the backed up pack files, the --clean-obsolete-packs option may be
5058
Warning: If you use --clean-obsolete-packs and your machine crashes
5059
during or immediately after repacking, you may be left with a state
5060
where the deletion has been written to disk but the new packs have not
5061
been. In this case the repository may be unusable.
5064
_see_also = ['repositories']
5065
takes_args = ['branch_or_repo?']
5067
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
5070
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5071
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5073
branch = dir.open_branch()
5074
repository = branch.repository
5075
except errors.NotBranchError:
5076
repository = dir.open_repository()
5077
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5080
class cmd_plugins(Command):
5081
__doc__ = """List the installed plugins.
5083
This command displays the list of installed plugins including
5084
version of plugin and a short description of each.
5086
--verbose shows the path where each plugin is located.
5088
A plugin is an external component for Bazaar that extends the
5089
revision control system, by adding or replacing code in Bazaar.
5090
Plugins can do a variety of things, including overriding commands,
5091
adding new commands, providing additional network transports and
5092
customizing log output.
5094
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5095
for further information on plugins including where to find them and how to
5096
install them. Instructions are also provided there on how to write new
5097
plugins using the Python programming language.
5099
takes_options = ['verbose']
5102
def run(self, verbose=False):
5103
from bzrlib import plugin
5104
# Don't give writelines a generator as some codecs don't like that
5105
self.outf.writelines(
5106
list(plugin.describe_plugins(show_paths=verbose)))
5109
class cmd_testament(Command):
5110
__doc__ = """Show testament (signing-form) of a revision."""
5113
Option('long', help='Produce long-format testament.'),
5115
help='Produce a strict-format testament.')]
5116
takes_args = ['branch?']
5118
def run(self, branch=u'.', revision=None, long=False, strict=False):
5119
from bzrlib.testament import Testament, StrictTestament
5121
testament_class = StrictTestament
5123
testament_class = Testament
5125
b = Branch.open_containing(branch)[0]
5127
b = Branch.open(branch)
5128
self.add_cleanup(b.lock_read().unlock)
5129
if revision is None:
5130
rev_id = b.last_revision()
5132
rev_id = revision[0].as_revision_id(b)
5133
t = testament_class.from_revision(b.repository, rev_id)
5135
sys.stdout.writelines(t.as_text_lines())
5137
sys.stdout.write(t.as_short_text())
5140
class cmd_annotate(Command):
5141
__doc__ = """Show the origin of each line in a file.
5143
This prints out the given file with an annotation on the left side
5144
indicating which revision, author and date introduced the change.
5146
If the origin is the same for a run of consecutive lines, it is
5147
shown only at the top, unless the --all option is given.
5149
# TODO: annotate directories; showing when each file was last changed
5150
# TODO: if the working copy is modified, show annotations on that
5151
# with new uncommitted lines marked
5152
aliases = ['ann', 'blame', 'praise']
5153
takes_args = ['filename']
5154
takes_options = [Option('all', help='Show annotations on all lines.'),
5155
Option('long', help='Show commit date in annotations.'),
5160
encoding_type = 'exact'
5163
def run(self, filename, all=False, long=False, revision=None,
5164
show_ids=False, directory=None):
5165
from bzrlib.annotate import (
5168
wt, branch, relpath = \
5169
_open_directory_or_containing_tree_or_branch(filename, directory)
5171
self.add_cleanup(wt.lock_read().unlock)
5173
self.add_cleanup(branch.lock_read().unlock)
5174
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5175
self.add_cleanup(tree.lock_read().unlock)
5176
if wt is not None and revision is None:
5177
file_id = wt.path2id(relpath)
5179
file_id = tree.path2id(relpath)
5181
raise errors.NotVersionedError(filename)
5182
if wt is not None and revision is None:
5183
# If there is a tree and we're not annotating historical
5184
# versions, annotate the working tree's content.
5185
annotate_file_tree(wt, file_id, self.outf, long, all,
5188
annotate_file_tree(tree, file_id, self.outf, long, all,
5189
show_ids=show_ids, branch=branch)
5192
class cmd_re_sign(Command):
5193
__doc__ = """Create a digital signature for an existing revision."""
5194
# TODO be able to replace existing ones.
5196
hidden = True # is this right ?
5197
takes_args = ['revision_id*']
5198
takes_options = ['directory', 'revision']
5200
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5201
if revision_id_list is not None and revision is not None:
5202
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5203
if revision_id_list is None and revision is None:
5204
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5205
b = WorkingTree.open_containing(directory)[0].branch
5206
self.add_cleanup(b.lock_write().unlock)
5207
return self._run(b, revision_id_list, revision)
5209
def _run(self, b, revision_id_list, revision):
5210
import bzrlib.gpg as gpg
5211
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5212
if revision_id_list is not None:
5213
b.repository.start_write_group()
5215
for revision_id in revision_id_list:
5216
b.repository.sign_revision(revision_id, gpg_strategy)
5218
b.repository.abort_write_group()
5221
b.repository.commit_write_group()
5222
elif revision is not None:
5223
if len(revision) == 1:
5224
revno, rev_id = revision[0].in_history(b)
5225
b.repository.start_write_group()
5227
b.repository.sign_revision(rev_id, gpg_strategy)
5229
b.repository.abort_write_group()
5232
b.repository.commit_write_group()
5233
elif len(revision) == 2:
5234
# are they both on rh- if so we can walk between them
5235
# might be nice to have a range helper for arbitrary
5236
# revision paths. hmm.
5237
from_revno, from_revid = revision[0].in_history(b)
5238
to_revno, to_revid = revision[1].in_history(b)
5239
if to_revid is None:
5240
to_revno = b.revno()
5241
if from_revno is None or to_revno is None:
5242
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5243
b.repository.start_write_group()
5245
for revno in range(from_revno, to_revno + 1):
5246
b.repository.sign_revision(b.get_rev_id(revno),
5249
b.repository.abort_write_group()
5252
b.repository.commit_write_group()
5254
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5257
class cmd_bind(Command):
5258
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5259
If no branch is supplied, rebind to the last bound location.
5261
Once converted into a checkout, commits must succeed on the master branch
5262
before they will be applied to the local branch.
5264
Bound branches use the nickname of its master branch unless it is set
5265
locally, in which case binding will update the local nickname to be
5269
_see_also = ['checkouts', 'unbind']
5270
takes_args = ['location?']
5271
takes_options = ['directory']
5273
def run(self, location=None, directory=u'.'):
5274
b, relpath = Branch.open_containing(directory)
5275
if location is None:
5277
location = b.get_old_bound_location()
5278
except errors.UpgradeRequired:
5279
raise errors.BzrCommandError(gettext('No location supplied. '
5280
'This format does not remember old locations.'))
5282
if location is None:
5283
if b.get_bound_location() is not None:
5284
raise errors.BzrCommandError(gettext('Branch is already bound'))
5286
raise errors.BzrCommandError(gettext('No location supplied '
5287
'and no previous location known'))
5288
b_other = Branch.open(location)
5291
except errors.DivergedBranches:
5292
raise errors.BzrCommandError(gettext('These branches have diverged.'
5293
' Try merging, and then bind again.'))
5294
if b.get_config().has_explicit_nickname():
5295
b.nick = b_other.nick
5298
class cmd_unbind(Command):
5299
__doc__ = """Convert the current checkout into a regular branch.
5301
After unbinding, the local branch is considered independent and subsequent
5302
commits will be local only.
5305
_see_also = ['checkouts', 'bind']
5307
takes_options = ['directory']
5309
def run(self, directory=u'.'):
5310
b, relpath = Branch.open_containing(directory)
5312
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5315
class cmd_uncommit(Command):
5316
__doc__ = """Remove the last committed revision.
5318
--verbose will print out what is being removed.
5319
--dry-run will go through all the motions, but not actually
5322
If --revision is specified, uncommit revisions to leave the branch at the
5323
specified revision. For example, "bzr uncommit -r 15" will leave the
5324
branch at revision 15.
5326
Uncommit leaves the working tree ready for a new commit. The only change
5327
it may make is to restore any pending merges that were present before
5331
# TODO: jam 20060108 Add an option to allow uncommit to remove
5332
# unreferenced information in 'branch-as-repository' branches.
5333
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5334
# information in shared branches as well.
5335
_see_also = ['commit']
5336
takes_options = ['verbose', 'revision',
5337
Option('dry-run', help='Don\'t actually make changes.'),
5338
Option('force', help='Say yes to all questions.'),
5340
help='Keep tags that point to removed revisions.'),
5342
help="Only remove the commits from the local branch"
5343
" when in a checkout."
5346
takes_args = ['location?']
5348
encoding_type = 'replace'
5350
def run(self, location=None, dry_run=False, verbose=False,
5351
revision=None, force=False, local=False, keep_tags=False):
5352
if location is None:
5354
control, relpath = controldir.ControlDir.open_containing(location)
5356
tree = control.open_workingtree()
5358
except (errors.NoWorkingTree, errors.NotLocalUrl):
5360
b = control.open_branch()
5362
if tree is not None:
5363
self.add_cleanup(tree.lock_write().unlock)
5365
self.add_cleanup(b.lock_write().unlock)
5366
return self._run(b, tree, dry_run, verbose, revision, force,
5369
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5371
from bzrlib.log import log_formatter, show_log
5372
from bzrlib.uncommit import uncommit
5374
last_revno, last_rev_id = b.last_revision_info()
5377
if revision is None:
5379
rev_id = last_rev_id
5381
# 'bzr uncommit -r 10' actually means uncommit
5382
# so that the final tree is at revno 10.
5383
# but bzrlib.uncommit.uncommit() actually uncommits
5384
# the revisions that are supplied.
5385
# So we need to offset it by one
5386
revno = revision[0].in_history(b).revno + 1
5387
if revno <= last_revno:
5388
rev_id = b.get_rev_id(revno)
5390
if rev_id is None or _mod_revision.is_null(rev_id):
5391
self.outf.write(gettext('No revisions to uncommit.\n'))
5394
lf = log_formatter('short',
5396
show_timezone='original')
5401
direction='forward',
5402
start_revision=revno,
5403
end_revision=last_revno)
5406
self.outf.write(gettext('Dry-run, pretending to remove'
5407
' the above revisions.\n'))
5409
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5412
if not ui.ui_factory.confirm_action(
5413
gettext(u'Uncommit these revisions'),
5414
'bzrlib.builtins.uncommit',
5416
self.outf.write(gettext('Canceled\n'))
5419
mutter('Uncommitting from {%s} to {%s}',
5420
last_rev_id, rev_id)
5421
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5422
revno=revno, local=local, keep_tags=keep_tags)
5423
self.outf.write(gettext('You can restore the old tip by running:\n'
5424
' bzr pull . -r revid:%s\n') % last_rev_id)
5427
class cmd_break_lock(Command):
5428
__doc__ = """Break a dead lock.
5430
This command breaks a lock on a repository, branch, working directory or
5433
CAUTION: Locks should only be broken when you are sure that the process
5434
holding the lock has been stopped.
5436
You can get information on what locks are open via the 'bzr info
5437
[location]' command.
5441
bzr break-lock bzr+ssh://example.com/bzr/foo
5442
bzr break-lock --conf ~/.bazaar
5445
takes_args = ['location?']
5448
help='LOCATION is the directory where the config lock is.'),
5450
help='Do not ask for confirmation before breaking the lock.'),
5453
def run(self, location=None, config=False, force=False):
5454
if location is None:
5457
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5459
{'bzrlib.lockdir.break': True})
5461
conf = _mod_config.LockableConfig(file_name=location)
5464
control, relpath = controldir.ControlDir.open_containing(location)
5466
control.break_lock()
5467
except NotImplementedError:
5471
class cmd_wait_until_signalled(Command):
5472
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5474
This just prints a line to signal when it is ready, then blocks on stdin.
5480
sys.stdout.write("running\n")
5482
sys.stdin.readline()
5485
class cmd_serve(Command):
5486
__doc__ = """Run the bzr server."""
5488
aliases = ['server']
5492
help='Serve on stdin/out for use from inetd or sshd.'),
5493
RegistryOption('protocol',
5494
help="Protocol to serve.",
5495
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5496
value_switches=True),
5498
help='Listen for connections on nominated port of the form '
5499
'[hostname:]portnumber. Passing 0 as the port number will '
5500
'result in a dynamically allocated port. The default port '
5501
'depends on the protocol.',
5503
custom_help('directory',
5504
help='Serve contents of this directory.'),
5505
Option('allow-writes',
5506
help='By default the server is a readonly server. Supplying '
5507
'--allow-writes enables write access to the contents of '
5508
'the served directory and below. Note that ``bzr serve`` '
5509
'does not perform authentication, so unless some form of '
5510
'external authentication is arranged supplying this '
5511
'option leads to global uncontrolled write access to your '
5514
Option('client-timeout', type=float,
5515
help='Override the default idle client timeout (5min).'),
5518
def get_host_and_port(self, port):
5519
"""Return the host and port to run the smart server on.
5521
If 'port' is None, None will be returned for the host and port.
5523
If 'port' has a colon in it, the string before the colon will be
5524
interpreted as the host.
5526
:param port: A string of the port to run the server on.
5527
:return: A tuple of (host, port), where 'host' is a host name or IP,
5528
and port is an integer TCP/IP port.
5531
if port is not None:
5533
host, port = port.split(':')
5537
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5538
protocol=None, client_timeout=None):
5539
from bzrlib import transport
5540
if directory is None:
5541
directory = os.getcwd()
5542
if protocol is None:
5543
protocol = transport.transport_server_registry.get()
5544
host, port = self.get_host_and_port(port)
5545
url = transport.location_to_url(directory)
5546
if not allow_writes:
5547
url = 'readonly+' + url
5548
t = transport.get_transport_from_url(url)
5550
protocol(t, host, port, inet, client_timeout)
5551
except TypeError, e:
5552
# We use symbol_versioning.deprecated_in just so that people
5553
# grepping can find it here.
5554
# symbol_versioning.deprecated_in((2, 5, 0))
5555
symbol_versioning.warn(
5556
'Got TypeError(%s)\ntrying to call protocol: %s.%s\n'
5557
'Most likely it needs to be updated to support a'
5558
' "timeout" parameter (added in bzr 2.5.0)'
5559
% (e, protocol.__module__, protocol),
5561
protocol(t, host, port, inet)
5564
class cmd_join(Command):
5565
__doc__ = """Combine a tree into its containing tree.
5567
This command requires the target tree to be in a rich-root format.
5569
The TREE argument should be an independent tree, inside another tree, but
5570
not part of it. (Such trees can be produced by "bzr split", but also by
5571
running "bzr branch" with the target inside a tree.)
5573
The result is a combined tree, with the subtree no longer an independent
5574
part. This is marked as a merge of the subtree into the containing tree,
5575
and all history is preserved.
5578
_see_also = ['split']
5579
takes_args = ['tree']
5581
Option('reference', help='Join by reference.', hidden=True),
5584
def run(self, tree, reference=False):
5585
sub_tree = WorkingTree.open(tree)
5586
parent_dir = osutils.dirname(sub_tree.basedir)
5587
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5588
repo = containing_tree.branch.repository
5589
if not repo.supports_rich_root():
5590
raise errors.BzrCommandError(gettext(
5591
"Can't join trees because %s doesn't support rich root data.\n"
5592
"You can use bzr upgrade on the repository.")
5596
containing_tree.add_reference(sub_tree)
5597
except errors.BadReferenceTarget, e:
5598
# XXX: Would be better to just raise a nicely printable
5599
# exception from the real origin. Also below. mbp 20070306
5600
raise errors.BzrCommandError(
5601
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5604
containing_tree.subsume(sub_tree)
5605
except errors.BadSubsumeSource, e:
5606
raise errors.BzrCommandError(
5607
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5610
class cmd_split(Command):
5611
__doc__ = """Split a subdirectory of a tree into a separate tree.
5613
This command will produce a target tree in a format that supports
5614
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5615
converted into earlier formats like 'dirstate-tags'.
5617
The TREE argument should be a subdirectory of a working tree. That
5618
subdirectory will be converted into an independent tree, with its own
5619
branch. Commits in the top-level tree will not apply to the new subtree.
5622
_see_also = ['join']
5623
takes_args = ['tree']
5625
def run(self, tree):
5626
containing_tree, subdir = WorkingTree.open_containing(tree)
5627
sub_id = containing_tree.path2id(subdir)
5629
raise errors.NotVersionedError(subdir)
5631
containing_tree.extract(sub_id)
5632
except errors.RootNotRich:
5633
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5636
class cmd_merge_directive(Command):
5637
__doc__ = """Generate a merge directive for auto-merge tools.
5639
A directive requests a merge to be performed, and also provides all the
5640
information necessary to do so. This means it must either include a
5641
revision bundle, or the location of a branch containing the desired
5644
A submit branch (the location to merge into) must be supplied the first
5645
time the command is issued. After it has been supplied once, it will
5646
be remembered as the default.
5648
A public branch is optional if a revision bundle is supplied, but required
5649
if --diff or --plain is specified. It will be remembered as the default
5650
after the first use.
5653
takes_args = ['submit_branch?', 'public_branch?']
5657
_see_also = ['send']
5661
RegistryOption.from_kwargs('patch-type',
5662
'The type of patch to include in the directive.',
5664
value_switches=True,
5666
bundle='Bazaar revision bundle (default).',
5667
diff='Normal unified diff.',
5668
plain='No patch, just directive.'),
5669
Option('sign', help='GPG-sign the directive.'), 'revision',
5670
Option('mail-to', type=str,
5671
help='Instead of printing the directive, email to this address.'),
5672
Option('message', type=str, short_name='m',
5673
help='Message to use when committing this merge.')
5676
encoding_type = 'exact'
5678
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5679
sign=False, revision=None, mail_to=None, message=None,
5681
from bzrlib.revision import ensure_null, NULL_REVISION
5682
include_patch, include_bundle = {
5683
'plain': (False, False),
5684
'diff': (True, False),
5685
'bundle': (True, True),
5687
branch = Branch.open(directory)
5688
stored_submit_branch = branch.get_submit_branch()
5689
if submit_branch is None:
5690
submit_branch = stored_submit_branch
5692
if stored_submit_branch is None:
5693
branch.set_submit_branch(submit_branch)
5694
if submit_branch is None:
5695
submit_branch = branch.get_parent()
5696
if submit_branch is None:
5697
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5699
stored_public_branch = branch.get_public_branch()
5700
if public_branch is None:
5701
public_branch = stored_public_branch
5702
elif stored_public_branch is None:
5703
branch.set_public_branch(public_branch)
5704
if not include_bundle and public_branch is None:
5705
raise errors.BzrCommandError(gettext('No public branch specified or'
5707
base_revision_id = None
5708
if revision is not None:
5709
if len(revision) > 2:
5710
raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5711
'at most two one revision identifiers'))
5712
revision_id = revision[-1].as_revision_id(branch)
5713
if len(revision) == 2:
5714
base_revision_id = revision[0].as_revision_id(branch)
5716
revision_id = branch.last_revision()
5717
revision_id = ensure_null(revision_id)
5718
if revision_id == NULL_REVISION:
5719
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5720
directive = merge_directive.MergeDirective2.from_objects(
5721
branch.repository, revision_id, time.time(),
5722
osutils.local_time_offset(), submit_branch,
5723
public_branch=public_branch, include_patch=include_patch,
5724
include_bundle=include_bundle, message=message,
5725
base_revision_id=base_revision_id)
5728
self.outf.write(directive.to_signed(branch))
5730
self.outf.writelines(directive.to_lines())
5732
message = directive.to_email(mail_to, branch, sign)
5733
s = SMTPConnection(branch.get_config_stack())
5734
s.send_email(message)
5737
class cmd_send(Command):
5738
__doc__ = """Mail or create a merge-directive for submitting changes.
5740
A merge directive provides many things needed for requesting merges:
5742
* A machine-readable description of the merge to perform
5744
* An optional patch that is a preview of the changes requested
5746
* An optional bundle of revision data, so that the changes can be applied
5747
directly from the merge directive, without retrieving data from a
5750
`bzr send` creates a compact data set that, when applied using bzr
5751
merge, has the same effect as merging from the source branch.
5753
By default the merge directive is self-contained and can be applied to any
5754
branch containing submit_branch in its ancestory without needing access to
5757
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5758
revisions, but only a structured request to merge from the
5759
public_location. In that case the public_branch is needed and it must be
5760
up-to-date and accessible to the recipient. The public_branch is always
5761
included if known, so that people can check it later.
5763
The submit branch defaults to the parent of the source branch, but can be
5764
overridden. Both submit branch and public branch will be remembered in
5765
branch.conf the first time they are used for a particular branch. The
5766
source branch defaults to that containing the working directory, but can
5767
be changed using --from.
5769
Both the submit branch and the public branch follow the usual behavior with
5770
respect to --remember: If there is no default location set, the first send
5771
will set it (use --no-remember to avoid setting it). After that, you can
5772
omit the location to use the default. To change the default, use
5773
--remember. The value will only be saved if the location can be accessed.
5775
In order to calculate those changes, bzr must analyse the submit branch.
5776
Therefore it is most efficient for the submit branch to be a local mirror.
5777
If a public location is known for the submit_branch, that location is used
5778
in the merge directive.
5780
The default behaviour is to send the merge directive by mail, unless -o is
5781
given, in which case it is sent to a file.
5783
Mail is sent using your preferred mail program. This should be transparent
5784
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5785
If the preferred client can't be found (or used), your editor will be used.
5787
To use a specific mail program, set the mail_client configuration option.
5788
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5789
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5790
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5791
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5794
If mail is being sent, a to address is required. This can be supplied
5795
either on the commandline, by setting the submit_to configuration
5796
option in the branch itself or the child_submit_to configuration option
5797
in the submit branch.
5799
Two formats are currently supported: "4" uses revision bundle format 4 and
5800
merge directive format 2. It is significantly faster and smaller than
5801
older formats. It is compatible with Bazaar 0.19 and later. It is the
5802
default. "0.9" uses revision bundle format 0.9 and merge directive
5803
format 1. It is compatible with Bazaar 0.12 - 0.18.
5805
The merge directives created by bzr send may be applied using bzr merge or
5806
bzr pull by specifying a file containing a merge directive as the location.
5808
bzr send makes extensive use of public locations to map local locations into
5809
URLs that can be used by other people. See `bzr help configuration` to
5810
set them, and use `bzr info` to display them.
5813
encoding_type = 'exact'
5815
_see_also = ['merge', 'pull']
5817
takes_args = ['submit_branch?', 'public_branch?']
5821
help='Do not include a bundle in the merge directive.'),
5822
Option('no-patch', help='Do not include a preview patch in the merge'
5825
help='Remember submit and public branch.'),
5827
help='Branch to generate the submission from, '
5828
'rather than the one containing the working directory.',
5831
Option('output', short_name='o',
5832
help='Write merge directive to this file or directory; '
5833
'use - for stdout.',
5836
help='Refuse to send if there are uncommitted changes in'
5837
' the working tree, --no-strict disables the check.'),
5838
Option('mail-to', help='Mail the request to this address.',
5842
Option('body', help='Body for the email.', type=unicode),
5843
RegistryOption('format',
5844
help='Use the specified output format.',
5845
lazy_registry=('bzrlib.send', 'format_registry')),
5848
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5849
no_patch=False, revision=None, remember=None, output=None,
5850
format=None, mail_to=None, message=None, body=None,
5851
strict=None, **kwargs):
5852
from bzrlib.send import send
5853
return send(submit_branch, revision, public_branch, remember,
5854
format, no_bundle, no_patch, output,
5855
kwargs.get('from', '.'), mail_to, message, body,
5860
class cmd_bundle_revisions(cmd_send):
5861
__doc__ = """Create a merge-directive for submitting changes.
5863
A merge directive provides many things needed for requesting merges:
5865
* A machine-readable description of the merge to perform
5867
* An optional patch that is a preview of the changes requested
5869
* An optional bundle of revision data, so that the changes can be applied
5870
directly from the merge directive, without retrieving data from a
5873
If --no-bundle is specified, then public_branch is needed (and must be
5874
up-to-date), so that the receiver can perform the merge using the
5875
public_branch. The public_branch is always included if known, so that
5876
people can check it later.
5878
The submit branch defaults to the parent, but can be overridden. Both
5879
submit branch and public branch will be remembered if supplied.
5881
If a public_branch is known for the submit_branch, that public submit
5882
branch is used in the merge instructions. This means that a local mirror
5883
can be used as your actual submit branch, once you have set public_branch
5886
Two formats are currently supported: "4" uses revision bundle format 4 and
5887
merge directive format 2. It is significantly faster and smaller than
5888
older formats. It is compatible with Bazaar 0.19 and later. It is the
5889
default. "0.9" uses revision bundle format 0.9 and merge directive
5890
format 1. It is compatible with Bazaar 0.12 - 0.18.
5895
help='Do not include a bundle in the merge directive.'),
5896
Option('no-patch', help='Do not include a preview patch in the merge'
5899
help='Remember submit and public branch.'),
5901
help='Branch to generate the submission from, '
5902
'rather than the one containing the working directory.',
5905
Option('output', short_name='o', help='Write directive to this file.',
5908
help='Refuse to bundle revisions if there are uncommitted'
5909
' changes in the working tree, --no-strict disables the check.'),
5911
RegistryOption('format',
5912
help='Use the specified output format.',
5913
lazy_registry=('bzrlib.send', 'format_registry')),
5915
aliases = ['bundle']
5917
_see_also = ['send', 'merge']
5921
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5922
no_patch=False, revision=None, remember=False, output=None,
5923
format=None, strict=None, **kwargs):
5926
from bzrlib.send import send
5927
return send(submit_branch, revision, public_branch, remember,
5928
format, no_bundle, no_patch, output,
5929
kwargs.get('from', '.'), None, None, None,
5930
self.outf, strict=strict)
5933
class cmd_tag(Command):
5934
__doc__ = """Create, remove or modify a tag naming a revision.
5936
Tags give human-meaningful names to revisions. Commands that take a -r
5937
(--revision) option can be given -rtag:X, where X is any previously
5940
Tags are stored in the branch. Tags are copied from one branch to another
5941
along when you branch, push, pull or merge.
5943
It is an error to give a tag name that already exists unless you pass
5944
--force, in which case the tag is moved to point to the new revision.
5946
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5947
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5949
If no tag name is specified it will be determined through the
5950
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5951
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5955
_see_also = ['commit', 'tags']
5956
takes_args = ['tag_name?']
5959
help='Delete this tag rather than placing it.',
5961
custom_help('directory',
5962
help='Branch in which to place the tag.'),
5964
help='Replace existing tags.',
5969
def run(self, tag_name=None,
5975
branch, relpath = Branch.open_containing(directory)
5976
self.add_cleanup(branch.lock_write().unlock)
5978
if tag_name is None:
5979
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5980
branch.tags.delete_tag(tag_name)
5981
note(gettext('Deleted tag %s.') % tag_name)
5984
if len(revision) != 1:
5985
raise errors.BzrCommandError(gettext(
5986
"Tags can only be placed on a single revision, "
5988
revision_id = revision[0].as_revision_id(branch)
5990
revision_id = branch.last_revision()
5991
if tag_name is None:
5992
tag_name = branch.automatic_tag_name(revision_id)
5993
if tag_name is None:
5994
raise errors.BzrCommandError(gettext(
5995
"Please specify a tag name."))
5997
existing_target = branch.tags.lookup_tag(tag_name)
5998
except errors.NoSuchTag:
5999
existing_target = None
6000
if not force and existing_target not in (None, revision_id):
6001
raise errors.TagAlreadyExists(tag_name)
6002
if existing_target == revision_id:
6003
note(gettext('Tag %s already exists for that revision.') % tag_name)
6005
branch.tags.set_tag(tag_name, revision_id)
6006
if existing_target is None:
6007
note(gettext('Created tag %s.') % tag_name)
6009
note(gettext('Updated tag %s.') % tag_name)
6012
class cmd_tags(Command):
6013
__doc__ = """List tags.
6015
This command shows a table of tag names and the revisions they reference.
6020
custom_help('directory',
6021
help='Branch whose tags should be displayed.'),
6022
RegistryOption('sort',
6023
'Sort tags by different criteria.', title='Sorting',
6024
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
6031
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6032
from bzrlib.tag import tag_sort_methods
6033
branch, relpath = Branch.open_containing(directory)
6035
tags = branch.tags.get_tag_dict().items()
6039
self.add_cleanup(branch.lock_read().unlock)
6041
# Restrict to the specified range
6042
tags = self._tags_for_range(branch, revision)
6044
sort = tag_sort_methods.get()
6047
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6048
for index, (tag, revid) in enumerate(tags):
6050
revno = branch.revision_id_to_dotted_revno(revid)
6051
if isinstance(revno, tuple):
6052
revno = '.'.join(map(str, revno))
6053
except (errors.NoSuchRevision,
6054
errors.GhostRevisionsHaveNoRevno,
6055
errors.UnsupportedOperation):
6056
# Bad tag data/merges can lead to tagged revisions
6057
# which are not in this branch. Fail gracefully ...
6059
tags[index] = (tag, revno)
6061
for tag, revspec in tags:
6062
self.outf.write('%-20s %s\n' % (tag, revspec))
6064
def _tags_for_range(self, branch, revision):
6066
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6067
revid1, revid2 = rev1.rev_id, rev2.rev_id
6068
# _get_revision_range will always set revid2 if it's not specified.
6069
# If revid1 is None, it means we want to start from the branch
6070
# origin which is always a valid ancestor. If revid1 == revid2, the
6071
# ancestry check is useless.
6072
if revid1 and revid1 != revid2:
6073
# FIXME: We really want to use the same graph than
6074
# branch.iter_merge_sorted_revisions below, but this is not
6075
# easily available -- vila 2011-09-23
6076
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6077
# We don't want to output anything in this case...
6079
# only show revisions between revid1 and revid2 (inclusive)
6080
tagged_revids = branch.tags.get_reverse_tag_dict()
6082
for r in branch.iter_merge_sorted_revisions(
6083
start_revision_id=revid2, stop_revision_id=revid1,
6084
stop_rule='include'):
6085
revid_tags = tagged_revids.get(r[0], None)
6087
found.extend([(tag, r[0]) for tag in revid_tags])
6091
class cmd_reconfigure(Command):
6092
__doc__ = """Reconfigure the type of a bzr directory.
6094
A target configuration must be specified.
6096
For checkouts, the bind-to location will be auto-detected if not specified.
6097
The order of preference is
6098
1. For a lightweight checkout, the current bound location.
6099
2. For branches that used to be checkouts, the previously-bound location.
6100
3. The push location.
6101
4. The parent location.
6102
If none of these is available, --bind-to must be specified.
6105
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6106
takes_args = ['location?']
6108
RegistryOption.from_kwargs(
6111
help='The relation between branch and tree.',
6112
value_switches=True, enum_switch=False,
6113
branch='Reconfigure to be an unbound branch with no working tree.',
6114
tree='Reconfigure to be an unbound branch with a working tree.',
6115
checkout='Reconfigure to be a bound branch with a working tree.',
6116
lightweight_checkout='Reconfigure to be a lightweight'
6117
' checkout (with no local history).',
6119
RegistryOption.from_kwargs(
6121
title='Repository type',
6122
help='Location fo the repository.',
6123
value_switches=True, enum_switch=False,
6124
standalone='Reconfigure to be a standalone branch '
6125
'(i.e. stop using shared repository).',
6126
use_shared='Reconfigure to use a shared repository.',
6128
RegistryOption.from_kwargs(
6130
title='Trees in Repository',
6131
help='Whether new branches in the repository have trees.',
6132
value_switches=True, enum_switch=False,
6133
with_trees='Reconfigure repository to create '
6134
'working trees on branches by default.',
6135
with_no_trees='Reconfigure repository to not create '
6136
'working trees on branches by default.'
6138
Option('bind-to', help='Branch to bind checkout to.', type=str),
6140
help='Perform reconfiguration even if local changes'
6142
Option('stacked-on',
6143
help='Reconfigure a branch to be stacked on another branch.',
6147
help='Reconfigure a branch to be unstacked. This '
6148
'may require copying substantial data into it.',
6152
def run(self, location=None, bind_to=None, force=False,
6153
tree_type=None, repository_type=None, repository_trees=None,
6154
stacked_on=None, unstacked=None):
6155
directory = controldir.ControlDir.open(location)
6156
if stacked_on and unstacked:
6157
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6158
elif stacked_on is not None:
6159
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6161
reconfigure.ReconfigureUnstacked().apply(directory)
6162
# At the moment you can use --stacked-on and a different
6163
# reconfiguration shape at the same time; there seems no good reason
6165
if (tree_type is None and
6166
repository_type is None and
6167
repository_trees is None):
6168
if stacked_on or unstacked:
6171
raise errors.BzrCommandError(gettext('No target configuration '
6173
reconfiguration = None
6174
if tree_type == 'branch':
6175
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6176
elif tree_type == 'tree':
6177
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6178
elif tree_type == 'checkout':
6179
reconfiguration = reconfigure.Reconfigure.to_checkout(
6181
elif tree_type == 'lightweight-checkout':
6182
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6185
reconfiguration.apply(force)
6186
reconfiguration = None
6187
if repository_type == 'use-shared':
6188
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6189
elif repository_type == 'standalone':
6190
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6192
reconfiguration.apply(force)
6193
reconfiguration = None
6194
if repository_trees == 'with-trees':
6195
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6197
elif repository_trees == 'with-no-trees':
6198
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6201
reconfiguration.apply(force)
6202
reconfiguration = None
6205
class cmd_switch(Command):
6206
__doc__ = """Set the branch of a checkout and update.
6208
For lightweight checkouts, this changes the branch being referenced.
6209
For heavyweight checkouts, this checks that there are no local commits
6210
versus the current bound branch, then it makes the local branch a mirror
6211
of the new location and binds to it.
6213
In both cases, the working tree is updated and uncommitted changes
6214
are merged. The user can commit or revert these as they desire.
6216
Pending merges need to be committed or reverted before using switch.
6218
The path to the branch to switch to can be specified relative to the parent
6219
directory of the current branch. For example, if you are currently in a
6220
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6223
Bound branches use the nickname of its master branch unless it is set
6224
locally, in which case switching will update the local nickname to be
6228
takes_args = ['to_location?']
6229
takes_options = ['directory',
6231
help='Switch even if local commits will be lost.'),
6233
Option('create-branch', short_name='b',
6234
help='Create the target branch from this one before'
6235
' switching to it.'),
6238
def run(self, to_location=None, force=False, create_branch=False,
6239
revision=None, directory=u'.'):
6240
from bzrlib import switch
6241
tree_location = directory
6242
revision = _get_one_revision('switch', revision)
6243
possible_transports = []
6244
control_dir = controldir.ControlDir.open_containing(tree_location,
6245
possible_transports=possible_transports)[0]
6246
if to_location is None:
6247
if revision is None:
6248
raise errors.BzrCommandError(gettext('You must supply either a'
6249
' revision or a location'))
6250
to_location = tree_location
6252
branch = control_dir.open_branch(
6253
possible_transports=possible_transports)
6254
had_explicit_nick = branch.get_config().has_explicit_nickname()
6255
except errors.NotBranchError:
6257
had_explicit_nick = False
6260
raise errors.BzrCommandError(
6261
gettext('cannot create branch without source branch'))
6262
to_location = lookup_new_sibling_branch(control_dir, to_location,
6263
possible_transports=possible_transports)
6264
to_branch = branch.bzrdir.sprout(to_location,
6265
possible_transports=possible_transports,
6266
source_branch=branch).open_branch()
6268
to_branch = lookup_sibling_branch(control_dir, to_location)
6269
if revision is not None:
6270
revision = revision.as_revision_id(to_branch)
6271
switch.switch(control_dir, to_branch, force, revision_id=revision)
6272
if had_explicit_nick:
6273
branch = control_dir.open_branch() #get the new branch!
6274
branch.nick = to_branch.nick
6275
note(gettext('Switched to branch: %s'),
6276
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6280
class cmd_view(Command):
6281
__doc__ = """Manage filtered views.
6283
Views provide a mask over the tree so that users can focus on
6284
a subset of a tree when doing their work. After creating a view,
6285
commands that support a list of files - status, diff, commit, etc -
6286
effectively have that list of files implicitly given each time.
6287
An explicit list of files can still be given but those files
6288
must be within the current view.
6290
In most cases, a view has a short life-span: it is created to make
6291
a selected change and is deleted once that change is committed.
6292
At other times, you may wish to create one or more named views
6293
and switch between them.
6295
To disable the current view without deleting it, you can switch to
6296
the pseudo view called ``off``. This can be useful when you need
6297
to see the whole tree for an operation or two (e.g. merge) but
6298
want to switch back to your view after that.
6301
To define the current view::
6303
bzr view file1 dir1 ...
6305
To list the current view::
6309
To delete the current view::
6313
To disable the current view without deleting it::
6315
bzr view --switch off
6317
To define a named view and switch to it::
6319
bzr view --name view-name file1 dir1 ...
6321
To list a named view::
6323
bzr view --name view-name
6325
To delete a named view::
6327
bzr view --name view-name --delete
6329
To switch to a named view::
6331
bzr view --switch view-name
6333
To list all views defined::
6337
To delete all views::
6339
bzr view --delete --all
6343
takes_args = ['file*']
6346
help='Apply list or delete action to all views.',
6349
help='Delete the view.',
6352
help='Name of the view to define, list or delete.',
6356
help='Name of the view to switch to.',
6361
def run(self, file_list,
6367
tree, file_list = WorkingTree.open_containing_paths(file_list,
6369
current_view, view_dict = tree.views.get_view_info()
6374
raise errors.BzrCommandError(gettext(
6375
"Both --delete and a file list specified"))
6377
raise errors.BzrCommandError(gettext(
6378
"Both --delete and --switch specified"))
6380
tree.views.set_view_info(None, {})
6381
self.outf.write(gettext("Deleted all views.\n"))
6383
raise errors.BzrCommandError(gettext("No current view to delete"))
6385
tree.views.delete_view(name)
6386
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6389
raise errors.BzrCommandError(gettext(
6390
"Both --switch and a file list specified"))
6392
raise errors.BzrCommandError(gettext(
6393
"Both --switch and --all specified"))
6394
elif switch == 'off':
6395
if current_view is None:
6396
raise errors.BzrCommandError(gettext("No current view to disable"))
6397
tree.views.set_view_info(None, view_dict)
6398
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6400
tree.views.set_view_info(switch, view_dict)
6401
view_str = views.view_display_str(tree.views.lookup_view())
6402
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6405
self.outf.write(gettext('Views defined:\n'))
6406
for view in sorted(view_dict):
6407
if view == current_view:
6411
view_str = views.view_display_str(view_dict[view])
6412
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6414
self.outf.write(gettext('No views defined.\n'))
6417
# No name given and no current view set
6420
raise errors.BzrCommandError(gettext(
6421
"Cannot change the 'off' pseudo view"))
6422
tree.views.set_view(name, sorted(file_list))
6423
view_str = views.view_display_str(tree.views.lookup_view())
6424
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6428
# No name given and no current view set
6429
self.outf.write(gettext('No current view.\n'))
6431
view_str = views.view_display_str(tree.views.lookup_view(name))
6432
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6435
class cmd_hooks(Command):
6436
__doc__ = """Show hooks."""
6441
for hook_key in sorted(hooks.known_hooks.keys()):
6442
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6443
self.outf.write("%s:\n" % type(some_hooks).__name__)
6444
for hook_name, hook_point in sorted(some_hooks.items()):
6445
self.outf.write(" %s:\n" % (hook_name,))
6446
found_hooks = list(hook_point)
6448
for hook in found_hooks:
6449
self.outf.write(" %s\n" %
6450
(some_hooks.get_hook_name(hook),))
6452
self.outf.write(gettext(" <no hooks installed>\n"))
6455
class cmd_remove_branch(Command):
6456
__doc__ = """Remove a branch.
6458
This will remove the branch from the specified location but
6459
will keep any working tree or repository in place.
6463
Remove the branch at repo/trunk::
6465
bzr remove-branch repo/trunk
6469
takes_args = ["location?"]
6471
aliases = ["rmbranch"]
6473
def run(self, location=None):
6474
if location is None:
6476
branch = Branch.open_containing(location)[0]
6477
branch.bzrdir.destroy_branch()
6480
class cmd_shelve(Command):
6481
__doc__ = """Temporarily set aside some changes from the current tree.
6483
Shelve allows you to temporarily put changes you've made "on the shelf",
6484
ie. out of the way, until a later time when you can bring them back from
6485
the shelf with the 'unshelve' command. The changes are stored alongside
6486
your working tree, and so they aren't propagated along with your branch nor
6487
will they survive its deletion.
6489
If shelve --list is specified, previously-shelved changes are listed.
6491
Shelve is intended to help separate several sets of changes that have
6492
been inappropriately mingled. If you just want to get rid of all changes
6493
and you don't need to restore them later, use revert. If you want to
6494
shelve all text changes at once, use shelve --all.
6496
If filenames are specified, only the changes to those files will be
6497
shelved. Other files will be left untouched.
6499
If a revision is specified, changes since that revision will be shelved.
6501
You can put multiple items on the shelf, and by default, 'unshelve' will
6502
restore the most recently shelved changes.
6504
For complicated changes, it is possible to edit the changes in a separate
6505
editor program to decide what the file remaining in the working copy
6506
should look like. To do this, add the configuration option
6508
change_editor = PROGRAM @new_path @old_path
6510
where @new_path is replaced with the path of the new version of the
6511
file and @old_path is replaced with the path of the old version of
6512
the file. The PROGRAM should save the new file with the desired
6513
contents of the file in the working tree.
6517
takes_args = ['file*']
6522
Option('all', help='Shelve all changes.'),
6524
RegistryOption('writer', 'Method to use for writing diffs.',
6525
bzrlib.option.diff_writer_registry,
6526
value_switches=True, enum_switch=False),
6528
Option('list', help='List shelved changes.'),
6530
help='Destroy removed changes instead of shelving them.'),
6532
_see_also = ['unshelve', 'configuration']
6534
def run(self, revision=None, all=False, file_list=None, message=None,
6535
writer=None, list=False, destroy=False, directory=None):
6537
return self.run_for_list(directory=directory)
6538
from bzrlib.shelf_ui import Shelver
6540
writer = bzrlib.option.diff_writer_registry.get()
6542
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6543
file_list, message, destroy=destroy, directory=directory)
6548
except errors.UserAbort:
6551
def run_for_list(self, directory=None):
6552
if directory is None:
6554
tree = WorkingTree.open_containing(directory)[0]
6555
self.add_cleanup(tree.lock_read().unlock)
6556
manager = tree.get_shelf_manager()
6557
shelves = manager.active_shelves()
6558
if len(shelves) == 0:
6559
note(gettext('No shelved changes.'))
6561
for shelf_id in reversed(shelves):
6562
message = manager.get_metadata(shelf_id).get('message')
6564
message = '<no message>'
6565
self.outf.write('%3d: %s\n' % (shelf_id, message))
6569
class cmd_unshelve(Command):
6570
__doc__ = """Restore shelved changes.
6572
By default, the most recently shelved changes are restored. However if you
6573
specify a shelf by id those changes will be restored instead. This works
6574
best when the changes don't depend on each other.
6577
takes_args = ['shelf_id?']
6580
RegistryOption.from_kwargs(
6581
'action', help="The action to perform.",
6582
enum_switch=False, value_switches=True,
6583
apply="Apply changes and remove from the shelf.",
6584
dry_run="Show changes, but do not apply or remove them.",
6585
preview="Instead of unshelving the changes, show the diff that "
6586
"would result from unshelving.",
6587
delete_only="Delete changes without applying them.",
6588
keep="Apply changes but don't delete them.",
6591
_see_also = ['shelve']
6593
def run(self, shelf_id=None, action='apply', directory=u'.'):
6594
from bzrlib.shelf_ui import Unshelver
6595
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6599
unshelver.tree.unlock()
6602
class cmd_clean_tree(Command):
6603
__doc__ = """Remove unwanted files from working tree.
6605
By default, only unknown files, not ignored files, are deleted. Versioned
6606
files are never deleted.
6608
Another class is 'detritus', which includes files emitted by bzr during
6609
normal operations and selftests. (The value of these files decreases with
6612
If no options are specified, unknown files are deleted. Otherwise, option
6613
flags are respected, and may be combined.
6615
To check what clean-tree will do, use --dry-run.
6617
takes_options = ['directory',
6618
Option('ignored', help='Delete all ignored files.'),
6619
Option('detritus', help='Delete conflict files, merge and revert'
6620
' backups, and failed selftest dirs.'),
6622
help='Delete files unknown to bzr (default).'),
6623
Option('dry-run', help='Show files to delete instead of'
6625
Option('force', help='Do not prompt before deleting.')]
6626
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6627
force=False, directory=u'.'):
6628
from bzrlib.clean_tree import clean_tree
6629
if not (unknown or ignored or detritus):
6633
clean_tree(directory, unknown=unknown, ignored=ignored,
6634
detritus=detritus, dry_run=dry_run, no_prompt=force)
6637
class cmd_reference(Command):
6638
__doc__ = """list, view and set branch locations for nested trees.
6640
If no arguments are provided, lists the branch locations for nested trees.
6641
If one argument is provided, display the branch location for that tree.
6642
If two arguments are provided, set the branch location for that tree.
6647
takes_args = ['path?', 'location?']
6649
def run(self, path=None, location=None):
6651
if path is not None:
6653
tree, branch, relpath =(
6654
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6655
if path is not None:
6658
tree = branch.basis_tree()
6660
info = branch._get_all_reference_info().iteritems()
6661
self._display_reference_info(tree, branch, info)
6663
file_id = tree.path2id(path)
6665
raise errors.NotVersionedError(path)
6666
if location is None:
6667
info = [(file_id, branch.get_reference_info(file_id))]
6668
self._display_reference_info(tree, branch, info)
6670
branch.set_reference_info(file_id, path, location)
6672
def _display_reference_info(self, tree, branch, info):
6674
for file_id, (path, location) in info:
6676
path = tree.id2path(file_id)
6677
except errors.NoSuchId:
6679
ref_list.append((path, location))
6680
for path, location in sorted(ref_list):
6681
self.outf.write('%s %s\n' % (path, location))
6684
class cmd_export_pot(Command):
6685
__doc__ = """Export command helps and error messages in po format."""
6688
takes_options = [Option('plugin',
6689
help='Export help text from named command '\
6690
'(defaults to all built in commands).',
6692
Option('include-duplicates',
6693
help='Output multiple copies of the same msgid '
6694
'string if it appears more than once.'),
6697
def run(self, plugin=None, include_duplicates=False):
6698
from bzrlib.export_pot import export_pot
6699
export_pot(self.outf, plugin, include_duplicates)
6702
def _register_lazy_builtins():
6703
# register lazy builtins from other modules; called at startup and should
6704
# be only called once.
6705
for (name, aliases, module_name) in [
6706
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6707
('cmd_config', [], 'bzrlib.config'),
6708
('cmd_dpush', [], 'bzrlib.foreign'),
6709
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6710
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6711
('cmd_conflicts', [], 'bzrlib.conflicts'),
6712
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6713
('cmd_verify_signatures', [],
6714
'bzrlib.commit_signature_commands'),
6715
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6717
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
