1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 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"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
from bzrlib.smtp_connection import SMTPConnection
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import (
70
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
73
def tree_files(file_list, default_branch=u'.', canonicalize=True,
76
return internal_tree_files(file_list, default_branch, canonicalize,
78
except errors.FileInWrongBranch, e:
79
raise errors.BzrCommandError("%s is not in the same branch as %s" %
80
(e.path, file_list[0]))
83
def tree_files_for_add(file_list):
85
Return a tree and list of absolute paths from a file list.
87
Similar to tree_files, but add handles files a bit differently, so it a
88
custom implementation. In particular, MutableTreeTree.smart_add expects
89
absolute paths, which it immediately converts to relative paths.
91
# FIXME Would be nice to just return the relative paths like
92
# internal_tree_files does, but there are a large number of unit tests
93
# that assume the current interface to mutabletree.smart_add
95
tree, relpath = WorkingTree.open_containing(file_list[0])
96
if tree.supports_views():
97
view_files = tree.views.lookup_view()
99
for filename in file_list:
100
if not osutils.is_inside_any(view_files, filename):
101
raise errors.FileOutsideView(filename, view_files)
102
file_list = file_list[:]
103
file_list[0] = tree.abspath(relpath)
105
tree = WorkingTree.open_containing(u'.')[0]
106
if tree.supports_views():
107
view_files = tree.views.lookup_view()
109
file_list = view_files
110
view_str = views.view_display_str(view_files)
111
note("Ignoring files outside view. View is %s" % view_str)
112
return tree, file_list
115
def _get_one_revision(command_name, revisions):
116
if revisions is None:
118
if len(revisions) != 1:
119
raise errors.BzrCommandError(
120
'bzr %s --revision takes exactly one revision identifier' % (
125
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
126
"""Get a revision tree. Not suitable for commands that change the tree.
128
Specifically, the basis tree in dirstate trees is coupled to the dirstate
129
and doing a commit/uncommit/pull will at best fail due to changing the
132
If tree is passed in, it should be already locked, for lifetime management
133
of the trees internal cached state.
137
if revisions is None:
139
rev_tree = tree.basis_tree()
141
rev_tree = branch.basis_tree()
143
revision = _get_one_revision(command_name, revisions)
144
rev_tree = revision.as_tree(branch)
148
# XXX: Bad function name; should possibly also be a class method of
149
# WorkingTree rather than a function.
150
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
152
"""Convert command-line paths to a WorkingTree and relative paths.
154
This is typically used for command-line processors that take one or
155
more filenames, and infer the workingtree that contains them.
157
The filenames given are not required to exist.
159
:param file_list: Filenames to convert.
161
:param default_branch: Fallback tree path to use if file_list is empty or
164
:param apply_view: if True and a view is set, apply it or check that
165
specified files are within it
167
:return: workingtree, [relative_paths]
169
if file_list is None or len(file_list) == 0:
170
tree = WorkingTree.open_containing(default_branch)[0]
171
if tree.supports_views() and apply_view:
172
view_files = tree.views.lookup_view()
174
file_list = view_files
175
view_str = views.view_display_str(view_files)
176
note("Ignoring files outside view. View is %s" % view_str)
177
return tree, file_list
178
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
179
return tree, safe_relpath_files(tree, file_list, canonicalize,
180
apply_view=apply_view)
183
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
184
"""Convert file_list into a list of relpaths in tree.
186
:param tree: A tree to operate on.
187
:param file_list: A list of user provided paths or None.
188
:param apply_view: if True and a view is set, apply it or check that
189
specified files are within it
190
:return: A list of relative paths.
191
:raises errors.PathNotChild: When a provided path is in a different tree
194
if file_list is None:
196
if tree.supports_views() and apply_view:
197
view_files = tree.views.lookup_view()
201
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
202
# doesn't - fix that up here before we enter the loop.
204
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
207
for filename in file_list:
209
relpath = fixer(osutils.dereference_path(filename))
210
if view_files and not osutils.is_inside_any(view_files, relpath):
211
raise errors.FileOutsideView(filename, view_files)
212
new_list.append(relpath)
213
except errors.PathNotChild:
214
raise errors.FileInWrongBranch(tree.branch, filename)
218
def _get_view_info_for_change_reporter(tree):
219
"""Get the view information from a tree for change reporting."""
222
current_view = tree.views.get_view_info()[0]
223
if current_view is not None:
224
view_info = (current_view, tree.views.lookup_view())
225
except errors.ViewsNotSupported:
230
# TODO: Make sure no commands unconditionally use the working directory as a
231
# branch. If a filename argument is used, the first of them should be used to
232
# specify the branch. (Perhaps this can be factored out into some kind of
233
# Argument class, representing a file in a branch, where the first occurrence
236
class cmd_status(Command):
237
"""Display status summary.
239
This reports on versioned and unknown files, reporting them
240
grouped by state. Possible states are:
243
Versioned in the working copy but not in the previous revision.
246
Versioned in the previous revision but removed or deleted
250
Path of this file changed from the previous revision;
251
the text may also have changed. This includes files whose
252
parent directory was renamed.
255
Text has changed since the previous revision.
258
File kind has been changed (e.g. from file to directory).
261
Not versioned and not matching an ignore pattern.
263
Additionally for directories, symlinks and files with an executable
264
bit, Bazaar indicates their type using a trailing character: '/', '@'
267
To see ignored files use 'bzr ignored'. For details on the
268
changes to file texts, use 'bzr diff'.
270
Note that --short or -S gives status flags for each item, similar
271
to Subversion's status command. To get output similar to svn -q,
274
If no arguments are specified, the status of the entire working
275
directory is shown. Otherwise, only the status of the specified
276
files or directories is reported. If a directory is given, status
277
is reported for everything inside that directory.
279
Before merges are committed, the pending merge tip revisions are
280
shown. To see all pending merge revisions, use the -v option.
281
To skip the display of pending merge information altogether, use
282
the no-pending option or specify a file/directory.
284
If a revision argument is given, the status is calculated against
285
that revision, or between two revisions if two are provided.
288
# TODO: --no-recurse, --recurse options
290
takes_args = ['file*']
291
takes_options = ['show-ids', 'revision', 'change', 'verbose',
292
Option('short', help='Use short status indicators.',
294
Option('versioned', help='Only show versioned files.',
296
Option('no-pending', help='Don\'t show pending merges.',
299
aliases = ['st', 'stat']
301
encoding_type = 'replace'
302
_see_also = ['diff', 'revert', 'status-flags']
305
def run(self, show_ids=False, file_list=None, revision=None, short=False,
306
versioned=False, no_pending=False, verbose=False):
307
from bzrlib.status import show_tree_status
309
if revision and len(revision) > 2:
310
raise errors.BzrCommandError('bzr status --revision takes exactly'
311
' one or two revision specifiers')
313
tree, relfile_list = tree_files(file_list)
314
# Avoid asking for specific files when that is not needed.
315
if relfile_list == ['']:
317
# Don't disable pending merges for full trees other than '.'.
318
if file_list == ['.']:
320
# A specific path within a tree was given.
321
elif relfile_list is not None:
323
show_tree_status(tree, show_ids=show_ids,
324
specific_files=relfile_list, revision=revision,
325
to_file=self.outf, short=short, versioned=versioned,
326
show_pending=(not no_pending), verbose=verbose)
329
class cmd_cat_revision(Command):
330
"""Write out metadata for a revision.
332
The revision to print can either be specified by a specific
333
revision identifier, or you can use --revision.
337
takes_args = ['revision_id?']
338
takes_options = ['revision']
339
# cat-revision is more for frontends so should be exact
343
def run(self, revision_id=None, revision=None):
344
if revision_id is not None and revision is not None:
345
raise errors.BzrCommandError('You can only supply one of'
346
' revision_id or --revision')
347
if revision_id is None and revision is None:
348
raise errors.BzrCommandError('You must supply either'
349
' --revision or a revision_id')
350
b = WorkingTree.open_containing(u'.')[0].branch
352
# TODO: jam 20060112 should cat-revision always output utf-8?
353
if revision_id is not None:
354
revision_id = osutils.safe_revision_id(revision_id, warn=False)
356
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
357
except errors.NoSuchRevision:
358
msg = "The repository %s contains no revision %s." % (b.repository.base,
360
raise errors.BzrCommandError(msg)
361
elif revision is not None:
364
raise errors.BzrCommandError('You cannot specify a NULL'
366
rev_id = rev.as_revision_id(b)
367
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
370
class cmd_dump_btree(Command):
371
"""Dump the contents of a btree index file to stdout.
373
PATH is a btree index file, it can be any URL. This includes things like
374
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
376
By default, the tuples stored in the index file will be displayed. With
377
--raw, we will uncompress the pages, but otherwise display the raw bytes
381
# TODO: Do we want to dump the internal nodes as well?
382
# TODO: It would be nice to be able to dump the un-parsed information,
383
# rather than only going through iter_all_entries. However, this is
384
# good enough for a start
386
encoding_type = 'exact'
387
takes_args = ['path']
388
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
389
' rather than the parsed tuples.'),
392
def run(self, path, raw=False):
393
dirname, basename = osutils.split(path)
394
t = transport.get_transport(dirname)
396
self._dump_raw_bytes(t, basename)
398
self._dump_entries(t, basename)
400
def _get_index_and_bytes(self, trans, basename):
401
"""Create a BTreeGraphIndex and raw bytes."""
402
bt = btree_index.BTreeGraphIndex(trans, basename, None)
403
bytes = trans.get_bytes(basename)
404
bt._file = cStringIO.StringIO(bytes)
405
bt._size = len(bytes)
408
def _dump_raw_bytes(self, trans, basename):
411
# We need to parse at least the root node.
412
# This is because the first page of every row starts with an
413
# uncompressed header.
414
bt, bytes = self._get_index_and_bytes(trans, basename)
415
for page_idx, page_start in enumerate(xrange(0, len(bytes),
416
btree_index._PAGE_SIZE)):
417
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
418
page_bytes = bytes[page_start:page_end]
420
self.outf.write('Root node:\n')
421
header_end, data = bt._parse_header_from_bytes(page_bytes)
422
self.outf.write(page_bytes[:header_end])
424
self.outf.write('\nPage %d\n' % (page_idx,))
425
decomp_bytes = zlib.decompress(page_bytes)
426
self.outf.write(decomp_bytes)
427
self.outf.write('\n')
429
def _dump_entries(self, trans, basename):
431
st = trans.stat(basename)
432
except errors.TransportNotPossible:
433
# We can't stat, so we'll fake it because we have to do the 'get()'
435
bt, _ = self._get_index_and_bytes(trans, basename)
437
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
438
for node in bt.iter_all_entries():
439
# Node is made up of:
440
# (index, key, value, [references])
441
refs_as_tuples = static_tuple.as_tuples(node[3])
442
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
443
self.outf.write('%s\n' % (as_tuple,))
446
class cmd_remove_tree(Command):
447
"""Remove the working tree from a given branch/checkout.
449
Since a lightweight checkout is little more than a working tree
450
this will refuse to run against one.
452
To re-create the working tree, use "bzr checkout".
454
_see_also = ['checkout', 'working-trees']
455
takes_args = ['location?']
458
help='Remove the working tree even if it has '
459
'uncommitted changes.'),
462
def run(self, location='.', force=False):
463
d = bzrdir.BzrDir.open(location)
466
working = d.open_workingtree()
467
except errors.NoWorkingTree:
468
raise errors.BzrCommandError("No working tree to remove")
469
except errors.NotLocalUrl:
470
raise errors.BzrCommandError("You cannot remove the working tree"
473
if (working.has_changes()):
474
raise errors.UncommittedChanges(working)
476
working_path = working.bzrdir.root_transport.base
477
branch_path = working.branch.bzrdir.root_transport.base
478
if working_path != branch_path:
479
raise errors.BzrCommandError("You cannot remove the working tree"
480
" from a lightweight checkout")
482
d.destroy_workingtree()
485
class cmd_revno(Command):
486
"""Show current revision number.
488
This is equal to the number of revisions on this branch.
492
takes_args = ['location?']
494
Option('tree', help='Show revno of working tree'),
498
def run(self, tree=False, location=u'.'):
501
wt = WorkingTree.open_containing(location)[0]
503
except (errors.NoWorkingTree, errors.NotLocalUrl):
504
raise errors.NoWorkingTree(location)
505
self.add_cleanup(wt.unlock)
506
revid = wt.last_revision()
508
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
509
except errors.NoSuchRevision:
511
revno = ".".join(str(n) for n in revno_t)
513
b = Branch.open_containing(location)[0]
515
self.add_cleanup(b.unlock)
518
self.outf.write(str(revno) + '\n')
521
class cmd_revision_info(Command):
522
"""Show revision number and revision id for a given revision identifier.
525
takes_args = ['revision_info*']
529
help='Branch to examine, '
530
'rather than the one containing the working directory.',
534
Option('tree', help='Show revno of working tree'),
538
def run(self, revision=None, directory=u'.', tree=False,
539
revision_info_list=[]):
542
wt = WorkingTree.open_containing(directory)[0]
545
self.add_cleanup(wt.unlock)
546
except (errors.NoWorkingTree, errors.NotLocalUrl):
548
b = Branch.open_containing(directory)[0]
550
self.add_cleanup(b.unlock)
552
if revision is not None:
553
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
554
if revision_info_list is not None:
555
for rev_str in revision_info_list:
556
rev_spec = RevisionSpec.from_string(rev_str)
557
revision_ids.append(rev_spec.as_revision_id(b))
558
# No arguments supplied, default to the last revision
559
if len(revision_ids) == 0:
562
raise errors.NoWorkingTree(directory)
563
revision_ids.append(wt.last_revision())
565
revision_ids.append(b.last_revision())
569
for revision_id in revision_ids:
571
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
572
revno = '.'.join(str(i) for i in dotted_revno)
573
except errors.NoSuchRevision:
575
maxlen = max(maxlen, len(revno))
576
revinfos.append([revno, revision_id])
580
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
583
class cmd_add(Command):
584
"""Add specified files or directories.
586
In non-recursive mode, all the named items are added, regardless
587
of whether they were previously ignored. A warning is given if
588
any of the named files are already versioned.
590
In recursive mode (the default), files are treated the same way
591
but the behaviour for directories is different. Directories that
592
are already versioned do not give a warning. All directories,
593
whether already versioned or not, are searched for files or
594
subdirectories that are neither versioned or ignored, and these
595
are added. This search proceeds recursively into versioned
596
directories. If no names are given '.' is assumed.
598
Therefore simply saying 'bzr add' will version all files that
599
are currently unknown.
601
Adding a file whose parent directory is not versioned will
602
implicitly add the parent, and so on up to the root. This means
603
you should never need to explicitly add a directory, they'll just
604
get added when you add a file in the directory.
606
--dry-run will show which files would be added, but not actually
609
--file-ids-from will try to use the file ids from the supplied path.
610
It looks up ids trying to find a matching parent directory with the
611
same filename, and then by pure path. This option is rarely needed
612
but can be useful when adding the same logical file into two
613
branches that will be merged later (without showing the two different
614
adds as a conflict). It is also useful when merging another project
615
into a subdirectory of this one.
617
Any files matching patterns in the ignore list will not be added
618
unless they are explicitly mentioned.
620
takes_args = ['file*']
623
help="Don't recursively add the contents of directories."),
625
help="Show what would be done, but don't actually do anything."),
627
Option('file-ids-from',
629
help='Lookup file ids from this tree.'),
631
encoding_type = 'replace'
632
_see_also = ['remove', 'ignore']
634
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
639
if file_ids_from is not None:
641
base_tree, base_path = WorkingTree.open_containing(
643
except errors.NoWorkingTree:
644
base_branch, base_path = Branch.open_containing(
646
base_tree = base_branch.basis_tree()
648
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
649
to_file=self.outf, should_print=(not is_quiet()))
651
action = bzrlib.add.AddAction(to_file=self.outf,
652
should_print=(not is_quiet()))
655
base_tree.lock_read()
656
self.add_cleanup(base_tree.unlock)
657
tree, file_list = tree_files_for_add(file_list)
658
added, ignored = tree.smart_add(file_list, not
659
no_recurse, action=action, save=not dry_run)
663
for glob in sorted(ignored.keys()):
664
for path in ignored[glob]:
665
self.outf.write("ignored %s matching \"%s\"\n"
669
class cmd_mkdir(Command):
670
"""Create a new versioned directory.
672
This is equivalent to creating the directory and then adding it.
675
takes_args = ['dir+']
676
encoding_type = 'replace'
678
def run(self, dir_list):
681
wt, dd = WorkingTree.open_containing(d)
683
self.outf.write('added %s\n' % d)
686
class cmd_relpath(Command):
687
"""Show path of a file relative to root"""
689
takes_args = ['filename']
693
def run(self, filename):
694
# TODO: jam 20050106 Can relpath return a munged path if
695
# sys.stdout encoding cannot represent it?
696
tree, relpath = WorkingTree.open_containing(filename)
697
self.outf.write(relpath)
698
self.outf.write('\n')
701
class cmd_inventory(Command):
702
"""Show inventory of the current working copy or a revision.
704
It is possible to limit the output to a particular entry
705
type using the --kind option. For example: --kind file.
707
It is also possible to restrict the list of files to a specific
708
set. For example: bzr inventory --show-ids this/file
717
help='List entries of a particular kind: file, directory, symlink.',
720
takes_args = ['file*']
723
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
724
if kind and kind not in ['file', 'directory', 'symlink']:
725
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
727
revision = _get_one_revision('inventory', revision)
728
work_tree, file_list = tree_files(file_list)
729
work_tree.lock_read()
730
self.add_cleanup(work_tree.unlock)
731
if revision is not None:
732
tree = revision.as_tree(work_tree.branch)
734
extra_trees = [work_tree]
736
self.add_cleanup(tree.unlock)
741
if file_list is not None:
742
file_ids = tree.paths2ids(file_list, trees=extra_trees,
743
require_versioned=True)
744
# find_ids_across_trees may include some paths that don't
746
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
747
for file_id in file_ids if file_id in tree)
749
entries = tree.inventory.entries()
752
for path, entry in entries:
753
if kind and kind != entry.kind:
756
self.outf.write('%-50s %s\n' % (path, entry.file_id))
758
self.outf.write(path)
759
self.outf.write('\n')
762
class cmd_mv(Command):
763
"""Move or rename a file.
766
bzr mv OLDNAME NEWNAME
768
bzr mv SOURCE... DESTINATION
770
If the last argument is a versioned directory, all the other names
771
are moved into it. Otherwise, there must be exactly two arguments
772
and the file is changed to a new name.
774
If OLDNAME does not exist on the filesystem but is versioned and
775
NEWNAME does exist on the filesystem but is not versioned, mv
776
assumes that the file has been manually moved and only updates
777
its internal inventory to reflect that change.
778
The same is valid when moving many SOURCE files to a DESTINATION.
780
Files cannot be moved between branches.
783
takes_args = ['names*']
784
takes_options = [Option("after", help="Move only the bzr identifier"
785
" of the file, because the file has already been moved."),
786
Option('auto', help='Automatically guess renames.'),
787
Option('dry-run', help='Avoid making changes when guessing renames.'),
789
aliases = ['move', 'rename']
790
encoding_type = 'replace'
792
def run(self, names_list, after=False, auto=False, dry_run=False):
794
return self.run_auto(names_list, after, dry_run)
796
raise errors.BzrCommandError('--dry-run requires --auto.')
797
if names_list is None:
799
if len(names_list) < 2:
800
raise errors.BzrCommandError("missing file argument")
801
tree, rel_names = tree_files(names_list, canonicalize=False)
802
tree.lock_tree_write()
803
self.add_cleanup(tree.unlock)
804
self._run(tree, names_list, rel_names, after)
806
def run_auto(self, names_list, after, dry_run):
807
if names_list is not None and len(names_list) > 1:
808
raise errors.BzrCommandError('Only one path may be specified to'
811
raise errors.BzrCommandError('--after cannot be specified with'
813
work_tree, file_list = tree_files(names_list, default_branch='.')
814
work_tree.lock_tree_write()
815
self.add_cleanup(work_tree.unlock)
816
rename_map.RenameMap.guess_renames(work_tree, dry_run)
818
def _run(self, tree, names_list, rel_names, after):
819
into_existing = osutils.isdir(names_list[-1])
820
if into_existing and len(names_list) == 2:
822
# a. case-insensitive filesystem and change case of dir
823
# b. move directory after the fact (if the source used to be
824
# a directory, but now doesn't exist in the working tree
825
# and the target is an existing directory, just rename it)
826
if (not tree.case_sensitive
827
and rel_names[0].lower() == rel_names[1].lower()):
828
into_existing = False
831
# 'fix' the case of a potential 'from'
832
from_id = tree.path2id(
833
tree.get_canonical_inventory_path(rel_names[0]))
834
if (not osutils.lexists(names_list[0]) and
835
from_id and inv.get_file_kind(from_id) == "directory"):
836
into_existing = False
839
# move into existing directory
840
# All entries reference existing inventory items, so fix them up
841
# for cicp file-systems.
842
rel_names = tree.get_canonical_inventory_paths(rel_names)
843
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
845
self.outf.write("%s => %s\n" % (src, dest))
847
if len(names_list) != 2:
848
raise errors.BzrCommandError('to mv multiple files the'
849
' destination must be a versioned'
852
# for cicp file-systems: the src references an existing inventory
854
src = tree.get_canonical_inventory_path(rel_names[0])
855
# Find the canonical version of the destination: In all cases, the
856
# parent of the target must be in the inventory, so we fetch the
857
# canonical version from there (we do not always *use* the
858
# canonicalized tail portion - we may be attempting to rename the
860
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
861
dest_parent = osutils.dirname(canon_dest)
862
spec_tail = osutils.basename(rel_names[1])
863
# For a CICP file-system, we need to avoid creating 2 inventory
864
# entries that differ only by case. So regardless of the case
865
# we *want* to use (ie, specified by the user or the file-system),
866
# we must always choose to use the case of any existing inventory
867
# items. The only exception to this is when we are attempting a
868
# case-only rename (ie, canonical versions of src and dest are
870
dest_id = tree.path2id(canon_dest)
871
if dest_id is None or tree.path2id(src) == dest_id:
872
# No existing item we care about, so work out what case we
873
# are actually going to use.
875
# If 'after' is specified, the tail must refer to a file on disk.
877
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
879
# pathjoin with an empty tail adds a slash, which breaks
881
dest_parent_fq = tree.basedir
883
dest_tail = osutils.canonical_relpath(
885
osutils.pathjoin(dest_parent_fq, spec_tail))
887
# not 'after', so case as specified is used
888
dest_tail = spec_tail
890
# Use the existing item so 'mv' fails with AlreadyVersioned.
891
dest_tail = os.path.basename(canon_dest)
892
dest = osutils.pathjoin(dest_parent, dest_tail)
893
mutter("attempting to move %s => %s", src, dest)
894
tree.rename_one(src, dest, after=after)
896
self.outf.write("%s => %s\n" % (src, dest))
899
class cmd_pull(Command):
900
"""Turn this branch into a mirror of another branch.
902
By default, this command only works on branches that have not diverged.
903
Branches are considered diverged if the destination branch's most recent
904
commit is one that has not been merged (directly or indirectly) into the
907
If branches have diverged, you can use 'bzr merge' to integrate the changes
908
from one into the other. Once one branch has merged, the other should
909
be able to pull it again.
911
If you want to replace your local changes and just want your branch to
912
match the remote one, use pull --overwrite. This will work even if the two
913
branches have diverged.
915
If there is no default location set, the first pull will set it. After
916
that, you can omit the location to use the default. To change the
917
default, use --remember. The value will only be saved if the remote
918
location can be accessed.
920
Note: The location can be specified either in the form of a branch,
921
or in the form of a path to a file containing a merge directive generated
925
_see_also = ['push', 'update', 'status-flags', 'send']
926
takes_options = ['remember', 'overwrite', 'revision',
927
custom_help('verbose',
928
help='Show logs of pulled revisions.'),
930
help='Branch to pull into, '
931
'rather than the one containing the working directory.',
936
help="Perform a local pull in a bound "
937
"branch. Local pulls are not applied to "
941
takes_args = ['location?']
942
encoding_type = 'replace'
944
def run(self, location=None, remember=False, overwrite=False,
945
revision=None, verbose=False,
946
directory=None, local=False):
947
# FIXME: too much stuff is in the command class
950
if directory is None:
953
tree_to = WorkingTree.open_containing(directory)[0]
954
branch_to = tree_to.branch
955
except errors.NoWorkingTree:
957
branch_to = Branch.open_containing(directory)[0]
959
if local and not branch_to.get_bound_location():
960
raise errors.LocalRequiresBoundBranch()
962
possible_transports = []
963
if location is not None:
965
mergeable = bundle.read_mergeable_from_url(location,
966
possible_transports=possible_transports)
967
except errors.NotABundle:
970
stored_loc = branch_to.get_parent()
972
if stored_loc is None:
973
raise errors.BzrCommandError("No pull location known or"
976
display_url = urlutils.unescape_for_display(stored_loc,
979
self.outf.write("Using saved parent location: %s\n" % display_url)
980
location = stored_loc
982
revision = _get_one_revision('pull', revision)
983
if mergeable is not None:
984
if revision is not None:
985
raise errors.BzrCommandError(
986
'Cannot use -r with merge directives or bundles')
987
mergeable.install_revisions(branch_to.repository)
988
base_revision_id, revision_id, verified = \
989
mergeable.get_merge_request(branch_to.repository)
990
branch_from = branch_to
992
branch_from = Branch.open(location,
993
possible_transports=possible_transports)
995
if branch_to.get_parent() is None or remember:
996
branch_to.set_parent(branch_from.base)
998
if branch_from is not branch_to:
999
branch_from.lock_read()
1000
self.add_cleanup(branch_from.unlock)
1001
if revision is not None:
1002
revision_id = revision.as_revision_id(branch_from)
1004
branch_to.lock_write()
1005
self.add_cleanup(branch_to.unlock)
1006
if tree_to is not None:
1007
view_info = _get_view_info_for_change_reporter(tree_to)
1008
change_reporter = delta._ChangeReporter(
1009
unversioned_filter=tree_to.is_ignored,
1010
view_info=view_info)
1011
result = tree_to.pull(
1012
branch_from, overwrite, revision_id, change_reporter,
1013
possible_transports=possible_transports, local=local)
1015
result = branch_to.pull(
1016
branch_from, overwrite, revision_id, local=local)
1018
result.report(self.outf)
1019
if verbose and result.old_revid != result.new_revid:
1020
log.show_branch_change(
1021
branch_to, self.outf, result.old_revno,
1025
class cmd_push(Command):
1026
"""Update a mirror of this branch.
1028
The target branch will not have its working tree populated because this
1029
is both expensive, and is not supported on remote file systems.
1031
Some smart servers or protocols *may* put the working tree in place in
1034
This command only works on branches that have not diverged. Branches are
1035
considered diverged if the destination branch's most recent commit is one
1036
that has not been merged (directly or indirectly) by the source branch.
1038
If branches have diverged, you can use 'bzr push --overwrite' to replace
1039
the other branch completely, discarding its unmerged changes.
1041
If you want to ensure you have the different changes in the other branch,
1042
do a merge (see bzr help merge) from the other branch, and commit that.
1043
After that you will be able to do a push without '--overwrite'.
1045
If there is no default push location set, the first push will set it.
1046
After that, you can omit the location to use the default. To change the
1047
default, use --remember. The value will only be saved if the remote
1048
location can be accessed.
1051
_see_also = ['pull', 'update', 'working-trees']
1052
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1053
Option('create-prefix',
1054
help='Create the path leading up to the branch '
1055
'if it does not already exist.'),
1057
help='Branch to push from, '
1058
'rather than the one containing the working directory.',
1062
Option('use-existing-dir',
1063
help='By default push will fail if the target'
1064
' directory exists, but does not already'
1065
' have a control directory. This flag will'
1066
' allow push to proceed.'),
1068
help='Create a stacked branch that references the public location '
1069
'of the parent branch.'),
1070
Option('stacked-on',
1071
help='Create a stacked branch that refers to another branch '
1072
'for the commit history. Only the work not present in the '
1073
'referenced branch is included in the branch created.',
1076
help='Refuse to push if there are uncommitted changes in'
1077
' the working tree, --no-strict disables the check.'),
1079
takes_args = ['location?']
1080
encoding_type = 'replace'
1082
def run(self, location=None, remember=False, overwrite=False,
1083
create_prefix=False, verbose=False, revision=None,
1084
use_existing_dir=False, directory=None, stacked_on=None,
1085
stacked=False, strict=None):
1086
from bzrlib.push import _show_push_branch
1088
if directory is None:
1090
# Get the source branch
1092
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1094
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1095
if strict is None: strict = True # default value
1096
# Get the tip's revision_id
1097
revision = _get_one_revision('push', revision)
1098
if revision is not None:
1099
revision_id = revision.in_history(br_from).rev_id
1102
if strict and tree is not None and revision_id is None:
1103
if (tree.has_changes()):
1104
raise errors.UncommittedChanges(
1105
tree, more='Use --no-strict to force the push.')
1106
if tree.last_revision() != tree.branch.last_revision():
1107
# The tree has lost sync with its branch, there is little
1108
# chance that the user is aware of it but he can still force
1109
# the push with --no-strict
1110
raise errors.OutOfDateTree(
1111
tree, more='Use --no-strict to force the push.')
1113
# Get the stacked_on branch, if any
1114
if stacked_on is not None:
1115
stacked_on = urlutils.normalize_url(stacked_on)
1117
parent_url = br_from.get_parent()
1119
parent = Branch.open(parent_url)
1120
stacked_on = parent.get_public_branch()
1122
# I considered excluding non-http url's here, thus forcing
1123
# 'public' branches only, but that only works for some
1124
# users, so it's best to just depend on the user spotting an
1125
# error by the feedback given to them. RBC 20080227.
1126
stacked_on = parent_url
1128
raise errors.BzrCommandError(
1129
"Could not determine branch to refer to.")
1131
# Get the destination location
1132
if location is None:
1133
stored_loc = br_from.get_push_location()
1134
if stored_loc is None:
1135
raise errors.BzrCommandError(
1136
"No push location known or specified.")
1138
display_url = urlutils.unescape_for_display(stored_loc,
1140
self.outf.write("Using saved push location: %s\n" % display_url)
1141
location = stored_loc
1143
_show_push_branch(br_from, revision_id, location, self.outf,
1144
verbose=verbose, overwrite=overwrite, remember=remember,
1145
stacked_on=stacked_on, create_prefix=create_prefix,
1146
use_existing_dir=use_existing_dir)
1149
class cmd_branch(Command):
1150
"""Create a new branch that is a copy of an existing branch.
1152
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1153
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1154
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1155
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1156
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1159
To retrieve the branch as of a particular revision, supply the --revision
1160
parameter, as in "branch foo/bar -r 5".
1163
_see_also = ['checkout']
1164
takes_args = ['from_location', 'to_location?']
1165
takes_options = ['revision', Option('hardlink',
1166
help='Hard-link working tree files where possible.'),
1168
help="Create a branch without a working-tree."),
1170
help="Switch the checkout in the current directory "
1171
"to the new branch."),
1173
help='Create a stacked branch referring to the source branch. '
1174
'The new branch will depend on the availability of the source '
1175
'branch for all operations.'),
1176
Option('standalone',
1177
help='Do not use a shared repository, even if available.'),
1178
Option('use-existing-dir',
1179
help='By default branch will fail if the target'
1180
' directory exists, but does not already'
1181
' have a control directory. This flag will'
1182
' allow branch to proceed.'),
1184
aliases = ['get', 'clone']
1186
def run(self, from_location, to_location=None, revision=None,
1187
hardlink=False, stacked=False, standalone=False, no_tree=False,
1188
use_existing_dir=False, switch=False):
1189
from bzrlib import switch as _mod_switch
1190
from bzrlib.tag import _merge_tags_if_possible
1191
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1193
revision = _get_one_revision('branch', revision)
1195
self.add_cleanup(br_from.unlock)
1196
if revision is not None:
1197
revision_id = revision.as_revision_id(br_from)
1199
# FIXME - wt.last_revision, fallback to branch, fall back to
1200
# None or perhaps NULL_REVISION to mean copy nothing
1202
revision_id = br_from.last_revision()
1203
if to_location is None:
1204
to_location = urlutils.derive_to_location(from_location)
1205
to_transport = transport.get_transport(to_location)
1207
to_transport.mkdir('.')
1208
except errors.FileExists:
1209
if not use_existing_dir:
1210
raise errors.BzrCommandError('Target directory "%s" '
1211
'already exists.' % to_location)
1214
bzrdir.BzrDir.open_from_transport(to_transport)
1215
except errors.NotBranchError:
1218
raise errors.AlreadyBranchError(to_location)
1219
except errors.NoSuchFile:
1220
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1223
# preserve whatever source format we have.
1224
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1225
possible_transports=[to_transport],
1226
accelerator_tree=accelerator_tree,
1227
hardlink=hardlink, stacked=stacked,
1228
force_new_repo=standalone,
1229
create_tree_if_local=not no_tree,
1230
source_branch=br_from)
1231
branch = dir.open_branch()
1232
except errors.NoSuchRevision:
1233
to_transport.delete_tree('.')
1234
msg = "The branch %s has no revision %s." % (from_location,
1236
raise errors.BzrCommandError(msg)
1237
_merge_tags_if_possible(br_from, branch)
1238
# If the source branch is stacked, the new branch may
1239
# be stacked whether we asked for that explicitly or not.
1240
# We therefore need a try/except here and not just 'if stacked:'
1242
note('Created new stacked branch referring to %s.' %
1243
branch.get_stacked_on_url())
1244
except (errors.NotStacked, errors.UnstackableBranchFormat,
1245
errors.UnstackableRepositoryFormat), e:
1246
note('Branched %d revision(s).' % branch.revno())
1248
# Switch to the new branch
1249
wt, _ = WorkingTree.open_containing('.')
1250
_mod_switch.switch(wt.bzrdir, branch)
1251
note('Switched to branch: %s',
1252
urlutils.unescape_for_display(branch.base, 'utf-8'))
1255
class cmd_checkout(Command):
1256
"""Create a new checkout of an existing branch.
1258
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1259
the branch found in '.'. This is useful if you have removed the working tree
1260
or if it was never created - i.e. if you pushed the branch to its current
1261
location using SFTP.
1263
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1264
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1265
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1266
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1267
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1270
To retrieve the branch as of a particular revision, supply the --revision
1271
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1272
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1276
_see_also = ['checkouts', 'branch']
1277
takes_args = ['branch_location?', 'to_location?']
1278
takes_options = ['revision',
1279
Option('lightweight',
1280
help="Perform a lightweight checkout. Lightweight "
1281
"checkouts depend on access to the branch for "
1282
"every operation. Normal checkouts can perform "
1283
"common operations like diff and status without "
1284
"such access, and also support local commits."
1286
Option('files-from', type=str,
1287
help="Get file contents from this tree."),
1289
help='Hard-link working tree files where possible.'
1294
def run(self, branch_location=None, to_location=None, revision=None,
1295
lightweight=False, files_from=None, hardlink=False):
1296
if branch_location is None:
1297
branch_location = osutils.getcwd()
1298
to_location = branch_location
1299
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1301
revision = _get_one_revision('checkout', revision)
1302
if files_from is not None:
1303
accelerator_tree = WorkingTree.open(files_from)
1304
if revision is not None:
1305
revision_id = revision.as_revision_id(source)
1308
if to_location is None:
1309
to_location = urlutils.derive_to_location(branch_location)
1310
# if the source and to_location are the same,
1311
# and there is no working tree,
1312
# then reconstitute a branch
1313
if (osutils.abspath(to_location) ==
1314
osutils.abspath(branch_location)):
1316
source.bzrdir.open_workingtree()
1317
except errors.NoWorkingTree:
1318
source.bzrdir.create_workingtree(revision_id)
1320
source.create_checkout(to_location, revision_id, lightweight,
1321
accelerator_tree, hardlink)
1324
class cmd_renames(Command):
1325
"""Show list of renamed files.
1327
# TODO: Option to show renames between two historical versions.
1329
# TODO: Only show renames under dir, rather than in the whole branch.
1330
_see_also = ['status']
1331
takes_args = ['dir?']
1334
def run(self, dir=u'.'):
1335
tree = WorkingTree.open_containing(dir)[0]
1337
self.add_cleanup(tree.unlock)
1338
new_inv = tree.inventory
1339
old_tree = tree.basis_tree()
1340
old_tree.lock_read()
1341
self.add_cleanup(old_tree.unlock)
1342
old_inv = old_tree.inventory
1344
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1345
for f, paths, c, v, p, n, k, e in iterator:
1346
if paths[0] == paths[1]:
1350
renames.append(paths)
1352
for old_name, new_name in renames:
1353
self.outf.write("%s => %s\n" % (old_name, new_name))
1356
class cmd_update(Command):
1357
"""Update a tree to have the latest code committed to its branch.
1359
This will perform a merge into the working tree, and may generate
1360
conflicts. If you have any local changes, you will still
1361
need to commit them after the update for the update to be complete.
1363
If you want to discard your local changes, you can just do a
1364
'bzr revert' instead of 'bzr commit' after the update.
1366
If the tree's branch is bound to a master branch, it will also update
1367
the branch from the master.
1370
_see_also = ['pull', 'working-trees', 'status-flags']
1371
takes_args = ['dir?']
1372
takes_options = ['revision']
1375
def run(self, dir='.', revision=None):
1376
if revision is not None and len(revision) != 1:
1377
raise errors.BzrCommandError(
1378
"bzr update --revision takes exactly one revision")
1379
tree = WorkingTree.open_containing(dir)[0]
1380
branch = tree.branch
1381
possible_transports = []
1382
master = branch.get_master_branch(
1383
possible_transports=possible_transports)
1384
if master is not None:
1386
branch_location = master.base
1388
tree.lock_tree_write()
1389
branch_location = tree.branch.base
1390
self.add_cleanup(tree.unlock)
1391
# get rid of the final '/' and be ready for display
1392
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1394
existing_pending_merges = tree.get_parent_ids()[1:]
1398
# may need to fetch data into a heavyweight checkout
1399
# XXX: this may take some time, maybe we should display a
1401
old_tip = branch.update(possible_transports)
1402
if revision is not None:
1403
revision_id = revision[0].as_revision_id(branch)
1405
revision_id = branch.last_revision()
1406
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1407
revno = branch.revision_id_to_revno(revision_id)
1408
note("Tree is up to date at revision %d of branch %s" %
1409
(revno, branch_location))
1411
view_info = _get_view_info_for_change_reporter(tree)
1412
change_reporter = delta._ChangeReporter(
1413
unversioned_filter=tree.is_ignored,
1414
view_info=view_info)
1416
conflicts = tree.update(
1418
possible_transports=possible_transports,
1419
revision=revision_id,
1421
except errors.NoSuchRevision, e:
1422
raise errors.BzrCommandError(
1423
"branch has no revision %s\n"
1424
"bzr update --revision only works"
1425
" for a revision in the branch history"
1427
revno = tree.branch.revision_id_to_revno(
1428
_mod_revision.ensure_null(tree.last_revision()))
1429
note('Updated to revision %d of branch %s' %
1430
(revno, branch_location))
1431
if tree.get_parent_ids()[1:] != existing_pending_merges:
1432
note('Your local commits will now show as pending merges with '
1433
"'bzr status', and can be committed with 'bzr commit'.")
1440
class cmd_info(Command):
1441
"""Show information about a working tree, branch or repository.
1443
This command will show all known locations and formats associated to the
1444
tree, branch or repository.
1446
In verbose mode, statistical information is included with each report.
1447
To see extended statistic information, use a verbosity level of 2 or
1448
higher by specifying the verbose option multiple times, e.g. -vv.
1450
Branches and working trees will also report any missing revisions.
1454
Display information on the format and related locations:
1458
Display the above together with extended format information and
1459
basic statistics (like the number of files in the working tree and
1460
number of revisions in the branch and repository):
1464
Display the above together with number of committers to the branch:
1468
_see_also = ['revno', 'working-trees', 'repositories']
1469
takes_args = ['location?']
1470
takes_options = ['verbose']
1471
encoding_type = 'replace'
1474
def run(self, location=None, verbose=False):
1476
noise_level = get_verbosity_level()
1479
from bzrlib.info import show_bzrdir_info
1480
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1481
verbose=noise_level, outfile=self.outf)
1484
class cmd_remove(Command):
1485
"""Remove files or directories.
1487
This makes bzr stop tracking changes to the specified files. bzr will delete
1488
them if they can easily be recovered using revert. If no options or
1489
parameters are given bzr will scan for files that are being tracked by bzr
1490
but missing in your tree and stop tracking them for you.
1492
takes_args = ['file*']
1493
takes_options = ['verbose',
1494
Option('new', help='Only remove files that have never been committed.'),
1495
RegistryOption.from_kwargs('file-deletion-strategy',
1496
'The file deletion mode to be used.',
1497
title='Deletion Strategy', value_switches=True, enum_switch=False,
1498
safe='Only delete files if they can be'
1499
' safely recovered (default).',
1500
keep='Delete from bzr but leave the working copy.',
1501
force='Delete all the specified files, even if they can not be '
1502
'recovered and even if they are non-empty directories.')]
1503
aliases = ['rm', 'del']
1504
encoding_type = 'replace'
1506
def run(self, file_list, verbose=False, new=False,
1507
file_deletion_strategy='safe'):
1508
tree, file_list = tree_files(file_list)
1510
if file_list is not None:
1511
file_list = [f for f in file_list]
1514
self.add_cleanup(tree.unlock)
1515
# Heuristics should probably all move into tree.remove_smart or
1518
added = tree.changes_from(tree.basis_tree(),
1519
specific_files=file_list).added
1520
file_list = sorted([f[0] for f in added], reverse=True)
1521
if len(file_list) == 0:
1522
raise errors.BzrCommandError('No matching files.')
1523
elif file_list is None:
1524
# missing files show up in iter_changes(basis) as
1525
# versioned-with-no-kind.
1527
for change in tree.iter_changes(tree.basis_tree()):
1528
# Find paths in the working tree that have no kind:
1529
if change[1][1] is not None and change[6][1] is None:
1530
missing.append(change[1][1])
1531
file_list = sorted(missing, reverse=True)
1532
file_deletion_strategy = 'keep'
1533
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1534
keep_files=file_deletion_strategy=='keep',
1535
force=file_deletion_strategy=='force')
1538
class cmd_file_id(Command):
1539
"""Print file_id of a particular file or directory.
1541
The file_id is assigned when the file is first added and remains the
1542
same through all revisions where the file exists, even when it is
1547
_see_also = ['inventory', 'ls']
1548
takes_args = ['filename']
1551
def run(self, filename):
1552
tree, relpath = WorkingTree.open_containing(filename)
1553
i = tree.path2id(relpath)
1555
raise errors.NotVersionedError(filename)
1557
self.outf.write(i + '\n')
1560
class cmd_file_path(Command):
1561
"""Print path of file_ids to a file or directory.
1563
This prints one line for each directory down to the target,
1564
starting at the branch root.
1568
takes_args = ['filename']
1571
def run(self, filename):
1572
tree, relpath = WorkingTree.open_containing(filename)
1573
fid = tree.path2id(relpath)
1575
raise errors.NotVersionedError(filename)
1576
segments = osutils.splitpath(relpath)
1577
for pos in range(1, len(segments) + 1):
1578
path = osutils.joinpath(segments[:pos])
1579
self.outf.write("%s\n" % tree.path2id(path))
1582
class cmd_reconcile(Command):
1583
"""Reconcile bzr metadata in a branch.
1585
This can correct data mismatches that may have been caused by
1586
previous ghost operations or bzr upgrades. You should only
1587
need to run this command if 'bzr check' or a bzr developer
1588
advises you to run it.
1590
If a second branch is provided, cross-branch reconciliation is
1591
also attempted, which will check that data like the tree root
1592
id which was not present in very early bzr versions is represented
1593
correctly in both branches.
1595
At the same time it is run it may recompress data resulting in
1596
a potential saving in disk space or performance gain.
1598
The branch *MUST* be on a listable system such as local disk or sftp.
1601
_see_also = ['check']
1602
takes_args = ['branch?']
1604
def run(self, branch="."):
1605
from bzrlib.reconcile import reconcile
1606
dir = bzrdir.BzrDir.open(branch)
1610
class cmd_revision_history(Command):
1611
"""Display the list of revision ids on a branch."""
1614
takes_args = ['location?']
1619
def run(self, location="."):
1620
branch = Branch.open_containing(location)[0]
1621
for revid in branch.revision_history():
1622
self.outf.write(revid)
1623
self.outf.write('\n')
1626
class cmd_ancestry(Command):
1627
"""List all revisions merged into this branch."""
1629
_see_also = ['log', 'revision-history']
1630
takes_args = ['location?']
1635
def run(self, location="."):
1637
wt = WorkingTree.open_containing(location)[0]
1638
except errors.NoWorkingTree:
1639
b = Branch.open(location)
1640
last_revision = b.last_revision()
1643
last_revision = wt.last_revision()
1645
revision_ids = b.repository.get_ancestry(last_revision)
1647
for revision_id in revision_ids:
1648
self.outf.write(revision_id + '\n')
1651
class cmd_init(Command):
1652
"""Make a directory into a versioned branch.
1654
Use this to create an empty branch, or before importing an
1657
If there is a repository in a parent directory of the location, then
1658
the history of the branch will be stored in the repository. Otherwise
1659
init creates a standalone branch which carries its own history
1660
in the .bzr directory.
1662
If there is already a branch at the location but it has no working tree,
1663
the tree can be populated with 'bzr checkout'.
1665
Recipe for importing a tree of files::
1671
bzr commit -m "imported project"
1674
_see_also = ['init-repository', 'branch', 'checkout']
1675
takes_args = ['location?']
1677
Option('create-prefix',
1678
help='Create the path leading up to the branch '
1679
'if it does not already exist.'),
1680
RegistryOption('format',
1681
help='Specify a format for this branch. '
1682
'See "help formats".',
1683
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1684
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1685
value_switches=True,
1686
title="Branch format",
1688
Option('append-revisions-only',
1689
help='Never change revnos or the existing log.'
1690
' Append revisions to it only.')
1692
def run(self, location=None, format=None, append_revisions_only=False,
1693
create_prefix=False):
1695
format = bzrdir.format_registry.make_bzrdir('default')
1696
if location is None:
1699
to_transport = transport.get_transport(location)
1701
# The path has to exist to initialize a
1702
# branch inside of it.
1703
# Just using os.mkdir, since I don't
1704
# believe that we want to create a bunch of
1705
# locations if the user supplies an extended path
1707
to_transport.ensure_base()
1708
except errors.NoSuchFile:
1709
if not create_prefix:
1710
raise errors.BzrCommandError("Parent directory of %s"
1712
"\nYou may supply --create-prefix to create all"
1713
" leading parent directories."
1715
to_transport.create_prefix()
1718
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1719
except errors.NotBranchError:
1720
# really a NotBzrDir error...
1721
create_branch = bzrdir.BzrDir.create_branch_convenience
1722
branch = create_branch(to_transport.base, format=format,
1723
possible_transports=[to_transport])
1724
a_bzrdir = branch.bzrdir
1726
from bzrlib.transport.local import LocalTransport
1727
if a_bzrdir.has_branch():
1728
if (isinstance(to_transport, LocalTransport)
1729
and not a_bzrdir.has_workingtree()):
1730
raise errors.BranchExistsWithoutWorkingTree(location)
1731
raise errors.AlreadyBranchError(location)
1732
branch = a_bzrdir.create_branch()
1733
a_bzrdir.create_workingtree()
1734
if append_revisions_only:
1736
branch.set_append_revisions_only(True)
1737
except errors.UpgradeRequired:
1738
raise errors.BzrCommandError('This branch format cannot be set'
1739
' to append-revisions-only. Try --default.')
1741
from bzrlib.info import describe_layout, describe_format
1743
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1744
except (errors.NoWorkingTree, errors.NotLocalUrl):
1746
repository = branch.repository
1747
layout = describe_layout(repository, branch, tree).lower()
1748
format = describe_format(a_bzrdir, repository, branch, tree)
1749
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1750
if repository.is_shared():
1751
#XXX: maybe this can be refactored into transport.path_or_url()
1752
url = repository.bzrdir.root_transport.external_url()
1754
url = urlutils.local_path_from_url(url)
1755
except errors.InvalidURL:
1757
self.outf.write("Using shared repository: %s\n" % url)
1760
class cmd_init_repository(Command):
1761
"""Create a shared repository for branches to share storage space.
1763
New branches created under the repository directory will store their
1764
revisions in the repository, not in the branch directory. For branches
1765
with shared history, this reduces the amount of storage needed and
1766
speeds up the creation of new branches.
1768
If the --no-trees option is given then the branches in the repository
1769
will not have working trees by default. They will still exist as
1770
directories on disk, but they will not have separate copies of the
1771
files at a certain revision. This can be useful for repositories that
1772
store branches which are interacted with through checkouts or remote
1773
branches, such as on a server.
1776
Create a shared repository holding just branches::
1778
bzr init-repo --no-trees repo
1781
Make a lightweight checkout elsewhere::
1783
bzr checkout --lightweight repo/trunk trunk-checkout
1788
_see_also = ['init', 'branch', 'checkout', 'repositories']
1789
takes_args = ["location"]
1790
takes_options = [RegistryOption('format',
1791
help='Specify a format for this repository. See'
1792
' "bzr help formats" for details.',
1793
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1794
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1795
value_switches=True, title='Repository format'),
1797
help='Branches in the repository will default to'
1798
' not having a working tree.'),
1800
aliases = ["init-repo"]
1802
def run(self, location, format=None, no_trees=False):
1804
format = bzrdir.format_registry.make_bzrdir('default')
1806
if location is None:
1809
to_transport = transport.get_transport(location)
1810
to_transport.ensure_base()
1812
newdir = format.initialize_on_transport(to_transport)
1813
repo = newdir.create_repository(shared=True)
1814
repo.set_make_working_trees(not no_trees)
1816
from bzrlib.info import show_bzrdir_info
1817
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1820
class cmd_diff(Command):
1821
"""Show differences in the working tree, between revisions or branches.
1823
If no arguments are given, all changes for the current tree are listed.
1824
If files are given, only the changes in those files are listed.
1825
Remote and multiple branches can be compared by using the --old and
1826
--new options. If not provided, the default for both is derived from
1827
the first argument, if any, or the current tree if no arguments are
1830
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1831
produces patches suitable for "patch -p1".
1835
2 - unrepresentable changes
1840
Shows the difference in the working tree versus the last commit::
1844
Difference between the working tree and revision 1::
1848
Difference between revision 3 and revision 1::
1852
Difference between revision 3 and revision 1 for branch xxx::
1856
To see the changes introduced in revision X::
1860
Note that in the case of a merge, the -c option shows the changes
1861
compared to the left hand parent. To see the changes against
1862
another parent, use::
1864
bzr diff -r<chosen_parent>..X
1866
The changes introduced by revision 2 (equivalent to -r1..2)::
1870
Show just the differences for file NEWS::
1874
Show the differences in working tree xxx for file NEWS::
1878
Show the differences from branch xxx to this working tree:
1882
Show the differences between two branches for file NEWS::
1884
bzr diff --old xxx --new yyy NEWS
1886
Same as 'bzr diff' but prefix paths with old/ and new/::
1888
bzr diff --prefix old/:new/
1890
_see_also = ['status']
1891
takes_args = ['file*']
1893
Option('diff-options', type=str,
1894
help='Pass these options to the external diff program.'),
1895
Option('prefix', type=str,
1897
help='Set prefixes added to old and new filenames, as '
1898
'two values separated by a colon. (eg "old/:new/").'),
1900
help='Branch/tree to compare from.',
1904
help='Branch/tree to compare to.',
1910
help='Use this command to compare files.',
1914
aliases = ['di', 'dif']
1915
encoding_type = 'exact'
1918
def run(self, revision=None, file_list=None, diff_options=None,
1919
prefix=None, old=None, new=None, using=None):
1920
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1922
if (prefix is None) or (prefix == '0'):
1930
old_label, new_label = prefix.split(":")
1932
raise errors.BzrCommandError(
1933
'--prefix expects two values separated by a colon'
1934
' (eg "old/:new/")')
1936
if revision and len(revision) > 2:
1937
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1938
' one or two revision specifiers')
1940
(old_tree, new_tree,
1941
old_branch, new_branch,
1942
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1943
file_list, revision, old, new, apply_view=True)
1944
return show_diff_trees(old_tree, new_tree, sys.stdout,
1945
specific_files=specific_files,
1946
external_diff_options=diff_options,
1947
old_label=old_label, new_label=new_label,
1948
extra_trees=extra_trees, using=using)
1951
class cmd_deleted(Command):
1952
"""List files deleted in the working tree.
1954
# TODO: Show files deleted since a previous revision, or
1955
# between two revisions.
1956
# TODO: Much more efficient way to do this: read in new
1957
# directories with readdir, rather than stating each one. Same
1958
# level of effort but possibly much less IO. (Or possibly not,
1959
# if the directories are very large...)
1960
_see_also = ['status', 'ls']
1961
takes_options = ['show-ids']
1964
def run(self, show_ids=False):
1965
tree = WorkingTree.open_containing(u'.')[0]
1967
self.add_cleanup(tree.unlock)
1968
old = tree.basis_tree()
1970
self.add_cleanup(old.unlock)
1971
for path, ie in old.inventory.iter_entries():
1972
if not tree.has_id(ie.file_id):
1973
self.outf.write(path)
1975
self.outf.write(' ')
1976
self.outf.write(ie.file_id)
1977
self.outf.write('\n')
1980
class cmd_modified(Command):
1981
"""List files modified in working tree.
1985
_see_also = ['status', 'ls']
1988
help='Write an ascii NUL (\\0) separator '
1989
'between files rather than a newline.')
1993
def run(self, null=False):
1994
tree = WorkingTree.open_containing(u'.')[0]
1995
td = tree.changes_from(tree.basis_tree())
1996
for path, id, kind, text_modified, meta_modified in td.modified:
1998
self.outf.write(path + '\0')
2000
self.outf.write(osutils.quotefn(path) + '\n')
2003
class cmd_added(Command):
2004
"""List files added in working tree.
2008
_see_also = ['status', 'ls']
2011
help='Write an ascii NUL (\\0) separator '
2012
'between files rather than a newline.')
2016
def run(self, null=False):
2017
wt = WorkingTree.open_containing(u'.')[0]
2019
self.add_cleanup(wt.unlock)
2020
basis = wt.basis_tree()
2022
self.add_cleanup(basis.unlock)
2023
basis_inv = basis.inventory
2026
if file_id in basis_inv:
2028
if inv.is_root(file_id) and len(basis_inv) == 0:
2030
path = inv.id2path(file_id)
2031
if not os.access(osutils.abspath(path), os.F_OK):
2034
self.outf.write(path + '\0')
2036
self.outf.write(osutils.quotefn(path) + '\n')
2039
class cmd_root(Command):
2040
"""Show the tree root directory.
2042
The root is the nearest enclosing directory with a .bzr control
2045
takes_args = ['filename?']
2047
def run(self, filename=None):
2048
"""Print the branch root."""
2049
tree = WorkingTree.open_containing(filename)[0]
2050
self.outf.write(tree.basedir + '\n')
2053
def _parse_limit(limitstring):
2055
return int(limitstring)
2057
msg = "The limit argument must be an integer."
2058
raise errors.BzrCommandError(msg)
2061
def _parse_levels(s):
2065
msg = "The levels argument must be an integer."
2066
raise errors.BzrCommandError(msg)
2069
class cmd_log(Command):
2070
"""Show historical log for a branch or subset of a branch.
2072
log is bzr's default tool for exploring the history of a branch.
2073
The branch to use is taken from the first parameter. If no parameters
2074
are given, the branch containing the working directory is logged.
2075
Here are some simple examples::
2077
bzr log log the current branch
2078
bzr log foo.py log a file in its branch
2079
bzr log http://server/branch log a branch on a server
2081
The filtering, ordering and information shown for each revision can
2082
be controlled as explained below. By default, all revisions are
2083
shown sorted (topologically) so that newer revisions appear before
2084
older ones and descendants always appear before ancestors. If displayed,
2085
merged revisions are shown indented under the revision in which they
2090
The log format controls how information about each revision is
2091
displayed. The standard log formats are called ``long``, ``short``
2092
and ``line``. The default is long. See ``bzr help log-formats``
2093
for more details on log formats.
2095
The following options can be used to control what information is
2098
-l N display a maximum of N revisions
2099
-n N display N levels of revisions (0 for all, 1 for collapsed)
2100
-v display a status summary (delta) for each revision
2101
-p display a diff (patch) for each revision
2102
--show-ids display revision-ids (and file-ids), not just revnos
2104
Note that the default number of levels to display is a function of the
2105
log format. If the -n option is not used, the standard log formats show
2106
just the top level (mainline).
2108
Status summaries are shown using status flags like A, M, etc. To see
2109
the changes explained using words like ``added`` and ``modified``
2110
instead, use the -vv option.
2114
To display revisions from oldest to newest, use the --forward option.
2115
In most cases, using this option will have little impact on the total
2116
time taken to produce a log, though --forward does not incrementally
2117
display revisions like --reverse does when it can.
2119
:Revision filtering:
2121
The -r option can be used to specify what revision or range of revisions
2122
to filter against. The various forms are shown below::
2124
-rX display revision X
2125
-rX.. display revision X and later
2126
-r..Y display up to and including revision Y
2127
-rX..Y display from X to Y inclusive
2129
See ``bzr help revisionspec`` for details on how to specify X and Y.
2130
Some common examples are given below::
2132
-r-1 show just the tip
2133
-r-10.. show the last 10 mainline revisions
2134
-rsubmit:.. show what's new on this branch
2135
-rancestor:path.. show changes since the common ancestor of this
2136
branch and the one at location path
2137
-rdate:yesterday.. show changes since yesterday
2139
When logging a range of revisions using -rX..Y, log starts at
2140
revision Y and searches back in history through the primary
2141
("left-hand") parents until it finds X. When logging just the
2142
top level (using -n1), an error is reported if X is not found
2143
along the way. If multi-level logging is used (-n0), X may be
2144
a nested merge revision and the log will be truncated accordingly.
2148
If parameters are given and the first one is not a branch, the log
2149
will be filtered to show only those revisions that changed the
2150
nominated files or directories.
2152
Filenames are interpreted within their historical context. To log a
2153
deleted file, specify a revision range so that the file existed at
2154
the end or start of the range.
2156
Historical context is also important when interpreting pathnames of
2157
renamed files/directories. Consider the following example:
2159
* revision 1: add tutorial.txt
2160
* revision 2: modify tutorial.txt
2161
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2165
* ``bzr log guide.txt`` will log the file added in revision 1
2167
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2169
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2170
the original file in revision 2.
2172
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2173
was no file called guide.txt in revision 2.
2175
Renames are always followed by log. By design, there is no need to
2176
explicitly ask for this (and no way to stop logging a file back
2177
until it was last renamed).
2181
The --message option can be used for finding revisions that match a
2182
regular expression in a commit message.
2186
GUI tools and IDEs are often better at exploring history than command
2187
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2188
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2189
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2191
Web interfaces are often better at exploring history than command line
2192
tools, particularly for branches on servers. You may prefer Loggerhead
2193
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2195
You may find it useful to add the aliases below to ``bazaar.conf``::
2199
top = log -l10 --line
2202
``bzr tip`` will then show the latest revision while ``bzr top``
2203
will show the last 10 mainline revisions. To see the details of a
2204
particular revision X, ``bzr show -rX``.
2206
If you are interested in looking deeper into a particular merge X,
2207
use ``bzr log -n0 -rX``.
2209
``bzr log -v`` on a branch with lots of history is currently
2210
very slow. A fix for this issue is currently under development.
2211
With or without that fix, it is recommended that a revision range
2212
be given when using the -v option.
2214
bzr has a generic full-text matching plugin, bzr-search, that can be
2215
used to find revisions matching user names, commit messages, etc.
2216
Among other features, this plugin can find all revisions containing
2217
a list of words but not others.
2219
When exploring non-mainline history on large projects with deep
2220
history, the performance of log can be greatly improved by installing
2221
the historycache plugin. This plugin buffers historical information
2222
trading disk space for faster speed.
2224
takes_args = ['file*']
2225
_see_also = ['log-formats', 'revisionspec']
2228
help='Show from oldest to newest.'),
2230
custom_help('verbose',
2231
help='Show files changed in each revision.'),
2235
type=bzrlib.option._parse_revision_str,
2237
help='Show just the specified revision.'
2238
' See also "help revisionspec".'),
2242
help='Number of levels to display - 0 for all, 1 for flat.',
2244
type=_parse_levels),
2247
help='Show revisions whose message matches this '
2248
'regular expression.',
2252
help='Limit the output to the first N revisions.',
2257
help='Show changes made in each revision as a patch.'),
2258
Option('include-merges',
2259
help='Show merged revisions like --levels 0 does.'),
2261
encoding_type = 'replace'
2264
def run(self, file_list=None, timezone='original',
2275
include_merges=False):
2276
from bzrlib.log import (
2278
make_log_request_dict,
2279
_get_info_for_log_files,
2281
direction = (forward and 'forward') or 'reverse'
2286
raise errors.BzrCommandError(
2287
'--levels and --include-merges are mutually exclusive')
2289
if change is not None:
2291
raise errors.RangeInChangeOption()
2292
if revision is not None:
2293
raise errors.BzrCommandError(
2294
'--revision and --change are mutually exclusive')
2299
filter_by_dir = False
2301
# find the file ids to log and check for directory filtering
2302
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2303
revision, file_list)
2304
self.add_cleanup(b.unlock)
2305
for relpath, file_id, kind in file_info_list:
2307
raise errors.BzrCommandError(
2308
"Path unknown at end or start of revision range: %s" %
2310
# If the relpath is the top of the tree, we log everything
2315
file_ids.append(file_id)
2316
filter_by_dir = filter_by_dir or (
2317
kind in ['directory', 'tree-reference'])
2320
# FIXME ? log the current subdir only RBC 20060203
2321
if revision is not None \
2322
and len(revision) > 0 and revision[0].get_branch():
2323
location = revision[0].get_branch()
2326
dir, relpath = bzrdir.BzrDir.open_containing(location)
2327
b = dir.open_branch()
2329
self.add_cleanup(b.unlock)
2330
rev1, rev2 = _get_revision_range(revision, b, self.name())
2332
# Decide on the type of delta & diff filtering to use
2333
# TODO: add an --all-files option to make this configurable & consistent
2341
diff_type = 'partial'
2345
# Build the log formatter
2346
if log_format is None:
2347
log_format = log.log_formatter_registry.get_default(b)
2348
# Make a non-encoding output to include the diffs - bug 328007
2349
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2350
lf = log_format(show_ids=show_ids, to_file=self.outf,
2351
to_exact_file=unencoded_output,
2352
show_timezone=timezone,
2353
delta_format=get_verbosity_level(),
2355
show_advice=levels is None)
2357
# Choose the algorithm for doing the logging. It's annoying
2358
# having multiple code paths like this but necessary until
2359
# the underlying repository format is faster at generating
2360
# deltas or can provide everything we need from the indices.
2361
# The default algorithm - match-using-deltas - works for
2362
# multiple files and directories and is faster for small
2363
# amounts of history (200 revisions say). However, it's too
2364
# slow for logging a single file in a repository with deep
2365
# history, i.e. > 10K revisions. In the spirit of "do no
2366
# evil when adding features", we continue to use the
2367
# original algorithm - per-file-graph - for the "single
2368
# file that isn't a directory without showing a delta" case.
2369
partial_history = revision and b.repository._format.supports_chks
2370
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2371
or delta_type or partial_history)
2373
# Build the LogRequest and execute it
2374
if len(file_ids) == 0:
2376
rqst = make_log_request_dict(
2377
direction=direction, specific_fileids=file_ids,
2378
start_revision=rev1, end_revision=rev2, limit=limit,
2379
message_search=message, delta_type=delta_type,
2380
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2381
Logger(b, rqst).show(lf)
2384
def _get_revision_range(revisionspec_list, branch, command_name):
2385
"""Take the input of a revision option and turn it into a revision range.
2387
It returns RevisionInfo objects which can be used to obtain the rev_id's
2388
of the desired revisions. It does some user input validations.
2390
if revisionspec_list is None:
2393
elif len(revisionspec_list) == 1:
2394
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2395
elif len(revisionspec_list) == 2:
2396
start_spec = revisionspec_list[0]
2397
end_spec = revisionspec_list[1]
2398
if end_spec.get_branch() != start_spec.get_branch():
2399
# b is taken from revision[0].get_branch(), and
2400
# show_log will use its revision_history. Having
2401
# different branches will lead to weird behaviors.
2402
raise errors.BzrCommandError(
2403
"bzr %s doesn't accept two revisions in different"
2404
" branches." % command_name)
2405
rev1 = start_spec.in_history(branch)
2406
# Avoid loading all of history when we know a missing
2407
# end of range means the last revision ...
2408
if end_spec.spec is None:
2409
last_revno, last_revision_id = branch.last_revision_info()
2410
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2412
rev2 = end_spec.in_history(branch)
2414
raise errors.BzrCommandError(
2415
'bzr %s --revision takes one or two values.' % command_name)
2419
def _revision_range_to_revid_range(revision_range):
2422
if revision_range[0] is not None:
2423
rev_id1 = revision_range[0].rev_id
2424
if revision_range[1] is not None:
2425
rev_id2 = revision_range[1].rev_id
2426
return rev_id1, rev_id2
2428
def get_log_format(long=False, short=False, line=False, default='long'):
2429
log_format = default
2433
log_format = 'short'
2439
class cmd_touching_revisions(Command):
2440
"""Return revision-ids which affected a particular file.
2442
A more user-friendly interface is "bzr log FILE".
2446
takes_args = ["filename"]
2449
def run(self, filename):
2450
tree, relpath = WorkingTree.open_containing(filename)
2451
file_id = tree.path2id(relpath)
2454
self.add_cleanup(b.unlock)
2455
touching_revs = log.find_touching_revisions(b, file_id)
2456
for revno, revision_id, what in touching_revs:
2457
self.outf.write("%6d %s\n" % (revno, what))
2460
class cmd_ls(Command):
2461
"""List files in a tree.
2464
_see_also = ['status', 'cat']
2465
takes_args = ['path?']
2469
Option('recursive', short_name='R',
2470
help='Recurse into subdirectories.'),
2472
help='Print paths relative to the root of the branch.'),
2473
Option('unknown', help='Print unknown files.'),
2474
Option('versioned', help='Print versioned files.',
2476
Option('ignored', help='Print ignored files.'),
2478
help='Write an ascii NUL (\\0) separator '
2479
'between files rather than a newline.'),
2481
help='List entries of a particular kind: file, directory, symlink.',
2486
def run(self, revision=None, verbose=False,
2487
recursive=False, from_root=False,
2488
unknown=False, versioned=False, ignored=False,
2489
null=False, kind=None, show_ids=False, path=None):
2491
if kind and kind not in ('file', 'directory', 'symlink'):
2492
raise errors.BzrCommandError('invalid kind specified')
2494
if verbose and null:
2495
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2496
all = not (unknown or versioned or ignored)
2498
selection = {'I':ignored, '?':unknown, 'V':versioned}
2504
raise errors.BzrCommandError('cannot specify both --from-root'
2507
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2510
# Calculate the prefix to use
2514
prefix = relpath + '/'
2515
elif fs_path != '.' and not fs_path.endswith('/'):
2516
prefix = fs_path + '/'
2518
if revision is not None or tree is None:
2519
tree = _get_one_revision_tree('ls', revision, branch=branch)
2522
if isinstance(tree, WorkingTree) and tree.supports_views():
2523
view_files = tree.views.lookup_view()
2526
view_str = views.view_display_str(view_files)
2527
note("Ignoring files outside view. View is %s" % view_str)
2530
self.add_cleanup(tree.unlock)
2531
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2532
from_dir=relpath, recursive=recursive):
2533
# Apply additional masking
2534
if not all and not selection[fc]:
2536
if kind is not None and fkind != kind:
2541
fullpath = osutils.pathjoin(relpath, fp)
2544
views.check_path_in_view(tree, fullpath)
2545
except errors.FileOutsideView:
2550
fp = osutils.pathjoin(prefix, fp)
2551
kindch = entry.kind_character()
2552
outstring = fp + kindch
2553
ui.ui_factory.clear_term()
2555
outstring = '%-8s %s' % (fc, outstring)
2556
if show_ids and fid is not None:
2557
outstring = "%-50s %s" % (outstring, fid)
2558
self.outf.write(outstring + '\n')
2560
self.outf.write(fp + '\0')
2563
self.outf.write(fid)
2564
self.outf.write('\0')
2572
self.outf.write('%-50s %s\n' % (outstring, my_id))
2574
self.outf.write(outstring + '\n')
2577
class cmd_unknowns(Command):
2578
"""List unknown files.
2586
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2587
self.outf.write(osutils.quotefn(f) + '\n')
2590
class cmd_ignore(Command):
2591
"""Ignore specified files or patterns.
2593
See ``bzr help patterns`` for details on the syntax of patterns.
2595
If a .bzrignore file does not exist, the ignore command
2596
will create one and add the specified files or patterns to the newly
2597
created file. The ignore command will also automatically add the
2598
.bzrignore file to be versioned. Creating a .bzrignore file without
2599
the use of the ignore command will require an explicit add command.
2601
To remove patterns from the ignore list, edit the .bzrignore file.
2602
After adding, editing or deleting that file either indirectly by
2603
using this command or directly by using an editor, be sure to commit
2606
Patterns prefixed with '!' are exceptions to ignore patterns and take
2607
precedence over regular ignores. Such exceptions are used to specify
2608
files that should be versioned which would otherwise be ignored.
2610
Patterns prefixed with '!!' act as regular ignore patterns, but have
2611
precedence over the '!' exception patterns.
2613
Note: ignore patterns containing shell wildcards must be quoted from
2617
Ignore the top level Makefile::
2619
bzr ignore ./Makefile
2621
Ignore .class files in all directories...::
2623
bzr ignore "*.class"
2625
...but do not ignore "special.class"::
2627
bzr ignore "!special.class"
2629
Ignore .o files under the lib directory::
2631
bzr ignore "lib/**/*.o"
2633
Ignore .o files under the lib directory::
2635
bzr ignore "RE:lib/.*\.o"
2637
Ignore everything but the "debian" toplevel directory::
2639
bzr ignore "RE:(?!debian/).*"
2641
Ignore everything except the "local" toplevel directory,
2642
but always ignore "*~" autosave files, even under local/::
2645
bzr ignore "!./local"
2649
_see_also = ['status', 'ignored', 'patterns']
2650
takes_args = ['name_pattern*']
2652
Option('old-default-rules',
2653
help='Write out the ignore rules bzr < 0.9 always used.')
2656
def run(self, name_pattern_list=None, old_default_rules=None):
2657
from bzrlib import ignores
2658
if old_default_rules is not None:
2659
# dump the rules and exit
2660
for pattern in ignores.OLD_DEFAULTS:
2663
if not name_pattern_list:
2664
raise errors.BzrCommandError("ignore requires at least one "
2665
"NAME_PATTERN or --old-default-rules")
2666
name_pattern_list = [globbing.normalize_pattern(p)
2667
for p in name_pattern_list]
2668
for name_pattern in name_pattern_list:
2669
if (name_pattern[0] == '/' or
2670
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2671
raise errors.BzrCommandError(
2672
"NAME_PATTERN should not be an absolute path")
2673
tree, relpath = WorkingTree.open_containing(u'.')
2674
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2675
ignored = globbing.Globster(name_pattern_list)
2678
for entry in tree.list_files():
2682
if ignored.match(filename):
2683
matches.append(filename.encode('utf-8'))
2685
if len(matches) > 0:
2686
print "Warning: the following files are version controlled and" \
2687
" match your ignore pattern:\n%s" \
2688
"\nThese files will continue to be version controlled" \
2689
" unless you 'bzr remove' them." % ("\n".join(matches),)
2692
class cmd_ignored(Command):
2693
"""List ignored files and the patterns that matched them.
2695
List all the ignored files and the ignore pattern that caused the file to
2698
Alternatively, to list just the files::
2703
encoding_type = 'replace'
2704
_see_also = ['ignore', 'ls']
2708
tree = WorkingTree.open_containing(u'.')[0]
2710
self.add_cleanup(tree.unlock)
2711
for path, file_class, kind, file_id, entry in tree.list_files():
2712
if file_class != 'I':
2714
## XXX: Slightly inefficient since this was already calculated
2715
pat = tree.is_ignored(path)
2716
self.outf.write('%-50s %s\n' % (path, pat))
2719
class cmd_lookup_revision(Command):
2720
"""Lookup the revision-id from a revision-number
2723
bzr lookup-revision 33
2726
takes_args = ['revno']
2729
def run(self, revno):
2733
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2735
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2738
class cmd_export(Command):
2739
"""Export current or past revision to a destination directory or archive.
2741
If no revision is specified this exports the last committed revision.
2743
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2744
given, try to find the format with the extension. If no extension
2745
is found exports to a directory (equivalent to --format=dir).
2747
If root is supplied, it will be used as the root directory inside
2748
container formats (tar, zip, etc). If it is not supplied it will default
2749
to the exported filename. The root option has no effect for 'dir' format.
2751
If branch is omitted then the branch containing the current working
2752
directory will be used.
2754
Note: Export of tree with non-ASCII filenames to zip is not supported.
2756
================= =========================
2757
Supported formats Autodetected by extension
2758
================= =========================
2761
tbz2 .tar.bz2, .tbz2
2764
================= =========================
2766
takes_args = ['dest', 'branch_or_subdir?']
2769
help="Type of file to export to.",
2772
Option('filters', help='Apply content filters to export the '
2773
'convenient form.'),
2776
help="Name of the root directory inside the exported file."),
2778
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2779
root=None, filters=False):
2780
from bzrlib.export import export
2782
if branch_or_subdir is None:
2783
tree = WorkingTree.open_containing(u'.')[0]
2787
b, subdir = Branch.open_containing(branch_or_subdir)
2790
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2792
export(rev_tree, dest, format, root, subdir, filtered=filters)
2793
except errors.NoSuchExportFormat, e:
2794
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2797
class cmd_cat(Command):
2798
"""Write the contents of a file as of a given revision to standard output.
2800
If no revision is nominated, the last revision is used.
2802
Note: Take care to redirect standard output when using this command on a
2808
Option('name-from-revision', help='The path name in the old tree.'),
2809
Option('filters', help='Apply content filters to display the '
2810
'convenience form.'),
2813
takes_args = ['filename']
2814
encoding_type = 'exact'
2817
def run(self, filename, revision=None, name_from_revision=False,
2819
if revision is not None and len(revision) != 1:
2820
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2821
" one revision specifier")
2822
tree, branch, relpath = \
2823
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2825
self.add_cleanup(branch.unlock)
2826
return self._run(tree, branch, relpath, filename, revision,
2827
name_from_revision, filters)
2829
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2832
tree = b.basis_tree()
2833
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2835
old_file_id = rev_tree.path2id(relpath)
2837
if name_from_revision:
2838
# Try in revision if requested
2839
if old_file_id is None:
2840
raise errors.BzrCommandError(
2841
"%r is not present in revision %s" % (
2842
filename, rev_tree.get_revision_id()))
2844
content = rev_tree.get_file_text(old_file_id)
2846
cur_file_id = tree.path2id(relpath)
2848
if cur_file_id is not None:
2849
# Then try with the actual file id
2851
content = rev_tree.get_file_text(cur_file_id)
2853
except errors.NoSuchId:
2854
# The actual file id didn't exist at that time
2856
if not found and old_file_id is not None:
2857
# Finally try with the old file id
2858
content = rev_tree.get_file_text(old_file_id)
2861
# Can't be found anywhere
2862
raise errors.BzrCommandError(
2863
"%r is not present in revision %s" % (
2864
filename, rev_tree.get_revision_id()))
2866
from bzrlib.filters import (
2867
ContentFilterContext,
2868
filtered_output_bytes,
2870
filters = rev_tree._content_filter_stack(relpath)
2871
chunks = content.splitlines(True)
2872
content = filtered_output_bytes(chunks, filters,
2873
ContentFilterContext(relpath, rev_tree))
2874
self.outf.writelines(content)
2876
self.outf.write(content)
2879
class cmd_local_time_offset(Command):
2880
"""Show the offset in seconds from GMT to local time."""
2884
print osutils.local_time_offset()
2888
class cmd_commit(Command):
2889
"""Commit changes into a new revision.
2891
An explanatory message needs to be given for each commit. This is
2892
often done by using the --message option (getting the message from the
2893
command line) or by using the --file option (getting the message from
2894
a file). If neither of these options is given, an editor is opened for
2895
the user to enter the message. To see the changed files in the
2896
boilerplate text loaded into the editor, use the --show-diff option.
2898
By default, the entire tree is committed and the person doing the
2899
commit is assumed to be the author. These defaults can be overridden
2904
If selected files are specified, only changes to those files are
2905
committed. If a directory is specified then the directory and
2906
everything within it is committed.
2908
When excludes are given, they take precedence over selected files.
2909
For example, to commit only changes within foo, but not changes
2912
bzr commit foo -x foo/bar
2914
A selective commit after a merge is not yet supported.
2918
If the author of the change is not the same person as the committer,
2919
you can specify the author's name using the --author option. The
2920
name should be in the same format as a committer-id, e.g.
2921
"John Doe <jdoe@example.com>". If there is more than one author of
2922
the change you can specify the option multiple times, once for each
2927
A common mistake is to forget to add a new file or directory before
2928
running the commit command. The --strict option checks for unknown
2929
files and aborts the commit if any are found. More advanced pre-commit
2930
checks can be implemented by defining hooks. See ``bzr help hooks``
2935
If you accidentially commit the wrong changes or make a spelling
2936
mistake in the commit message say, you can use the uncommit command
2937
to undo it. See ``bzr help uncommit`` for details.
2939
Hooks can also be configured to run after a commit. This allows you
2940
to trigger updates to external systems like bug trackers. The --fixes
2941
option can be used to record the association between a revision and
2942
one or more bugs. See ``bzr help bugs`` for details.
2944
A selective commit may fail in some cases where the committed
2945
tree would be invalid. Consider::
2950
bzr commit foo -m "committing foo"
2951
bzr mv foo/bar foo/baz
2954
bzr commit foo/bar -m "committing bar but not baz"
2956
In the example above, the last commit will fail by design. This gives
2957
the user the opportunity to decide whether they want to commit the
2958
rename at the same time, separately first, or not at all. (As a general
2959
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2961
# TODO: Run hooks on tree to-be-committed, and after commit.
2963
# TODO: Strict commit that fails if there are deleted files.
2964
# (what does "deleted files" mean ??)
2966
# TODO: Give better message for -s, --summary, used by tla people
2968
# XXX: verbose currently does nothing
2970
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2971
takes_args = ['selected*']
2973
ListOption('exclude', type=str, short_name='x',
2974
help="Do not consider changes made to a given path."),
2975
Option('message', type=unicode,
2977
help="Description of the new revision."),
2980
help='Commit even if nothing has changed.'),
2981
Option('file', type=str,
2984
help='Take commit message from this file.'),
2986
help="Refuse to commit if there are unknown "
2987
"files in the working tree."),
2988
Option('commit-time', type=str,
2989
help="Manually set a commit time using commit date "
2990
"format, e.g. '2009-10-10 08:00:00 +0100'."),
2991
ListOption('fixes', type=str,
2992
help="Mark a bug as being fixed by this revision "
2993
"(see \"bzr help bugs\")."),
2994
ListOption('author', type=unicode,
2995
help="Set the author's name, if it's different "
2996
"from the committer."),
2998
help="Perform a local commit in a bound "
2999
"branch. Local commits are not pushed to "
3000
"the master branch until a normal commit "
3004
help='When no message is supplied, show the diff along'
3005
' with the status summary in the message editor.'),
3007
aliases = ['ci', 'checkin']
3009
def _iter_bug_fix_urls(self, fixes, branch):
3010
# Configure the properties for bug fixing attributes.
3011
for fixed_bug in fixes:
3012
tokens = fixed_bug.split(':')
3013
if len(tokens) != 2:
3014
raise errors.BzrCommandError(
3015
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3016
"See \"bzr help bugs\" for more information on this "
3017
"feature.\nCommit refused." % fixed_bug)
3018
tag, bug_id = tokens
3020
yield bugtracker.get_bug_url(tag, branch, bug_id)
3021
except errors.UnknownBugTrackerAbbreviation:
3022
raise errors.BzrCommandError(
3023
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3024
except errors.MalformedBugIdentifier, e:
3025
raise errors.BzrCommandError(
3026
"%s\nCommit refused." % (str(e),))
3028
def run(self, message=None, file=None, verbose=False, selected_list=None,
3029
unchanged=False, strict=False, local=False, fixes=None,
3030
author=None, show_diff=False, exclude=None, commit_time=None):
3031
from bzrlib.errors import (
3036
from bzrlib.msgeditor import (
3037
edit_commit_message_encoded,
3038
generate_commit_message_template,
3039
make_commit_message_template_encoded
3042
commit_stamp = offset = None
3043
if commit_time is not None:
3045
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3046
except ValueError, e:
3047
raise errors.BzrCommandError(
3048
"Could not parse --commit-time: " + str(e))
3050
# TODO: Need a blackbox test for invoking the external editor; may be
3051
# slightly problematic to run this cross-platform.
3053
# TODO: do more checks that the commit will succeed before
3054
# spending the user's valuable time typing a commit message.
3058
tree, selected_list = tree_files(selected_list)
3059
if selected_list == ['']:
3060
# workaround - commit of root of tree should be exactly the same
3061
# as just default commit in that tree, and succeed even though
3062
# selected-file merge commit is not done yet
3067
bug_property = bugtracker.encode_fixes_bug_urls(
3068
self._iter_bug_fix_urls(fixes, tree.branch))
3070
properties['bugs'] = bug_property
3072
if local and not tree.branch.get_bound_location():
3073
raise errors.LocalRequiresBoundBranch()
3075
if message is not None:
3077
file_exists = osutils.lexists(message)
3078
except UnicodeError:
3079
# The commit message contains unicode characters that can't be
3080
# represented in the filesystem encoding, so that can't be a
3085
'The commit message is a file name: "%(f)s".\n'
3086
'(use --file "%(f)s" to take commit message from that file)'
3088
ui.ui_factory.show_warning(warning_msg)
3090
def get_message(commit_obj):
3091
"""Callback to get commit message"""
3092
my_message = message
3093
if my_message is not None and '\r' in my_message:
3094
my_message = my_message.replace('\r\n', '\n')
3095
my_message = my_message.replace('\r', '\n')
3096
if my_message is None and not file:
3097
t = make_commit_message_template_encoded(tree,
3098
selected_list, diff=show_diff,
3099
output_encoding=osutils.get_user_encoding())
3100
start_message = generate_commit_message_template(commit_obj)
3101
my_message = edit_commit_message_encoded(t,
3102
start_message=start_message)
3103
if my_message is None:
3104
raise errors.BzrCommandError("please specify a commit"
3105
" message with either --message or --file")
3106
elif my_message and file:
3107
raise errors.BzrCommandError(
3108
"please specify either --message or --file")
3110
my_message = codecs.open(file, 'rt',
3111
osutils.get_user_encoding()).read()
3112
if my_message == "":
3113
raise errors.BzrCommandError("empty commit message specified")
3116
# The API permits a commit with a filter of [] to mean 'select nothing'
3117
# but the command line should not do that.
3118
if not selected_list:
3119
selected_list = None
3121
tree.commit(message_callback=get_message,
3122
specific_files=selected_list,
3123
allow_pointless=unchanged, strict=strict, local=local,
3124
reporter=None, verbose=verbose, revprops=properties,
3125
authors=author, timestamp=commit_stamp,
3127
exclude=safe_relpath_files(tree, exclude))
3128
except PointlessCommit:
3129
# FIXME: This should really happen before the file is read in;
3130
# perhaps prepare the commit; get the message; then actually commit
3131
raise errors.BzrCommandError("No changes to commit."
3132
" Use --unchanged to commit anyhow.")
3133
except ConflictsInTree:
3134
raise errors.BzrCommandError('Conflicts detected in working '
3135
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3137
except StrictCommitFailed:
3138
raise errors.BzrCommandError("Commit refused because there are"
3139
" unknown files in the working tree.")
3140
except errors.BoundBranchOutOfDate, e:
3141
raise errors.BzrCommandError(str(e) + "\n"
3142
'To commit to master branch, run update and then commit.\n'
3143
'You can also pass --local to commit to continue working '
3147
class cmd_check(Command):
3148
"""Validate working tree structure, branch consistency and repository history.
3150
This command checks various invariants about branch and repository storage
3151
to detect data corruption or bzr bugs.
3153
The working tree and branch checks will only give output if a problem is
3154
detected. The output fields of the repository check are:
3157
This is just the number of revisions checked. It doesn't
3161
This is just the number of versionedfiles checked. It
3162
doesn't indicate a problem.
3164
unreferenced ancestors
3165
Texts that are ancestors of other texts, but
3166
are not properly referenced by the revision ancestry. This is a
3167
subtle problem that Bazaar can work around.
3170
This is the total number of unique file contents
3171
seen in the checked revisions. It does not indicate a problem.
3174
This is the total number of repeated texts seen
3175
in the checked revisions. Texts can be repeated when their file
3176
entries are modified, but the file contents are not. It does not
3179
If no restrictions are specified, all Bazaar data that is found at the given
3180
location will be checked.
3184
Check the tree and branch at 'foo'::
3186
bzr check --tree --branch foo
3188
Check only the repository at 'bar'::
3190
bzr check --repo bar
3192
Check everything at 'baz'::
3197
_see_also = ['reconcile']
3198
takes_args = ['path?']
3199
takes_options = ['verbose',
3200
Option('branch', help="Check the branch related to the"
3201
" current directory."),
3202
Option('repo', help="Check the repository related to the"
3203
" current directory."),
3204
Option('tree', help="Check the working tree related to"
3205
" the current directory.")]
3207
def run(self, path=None, verbose=False, branch=False, repo=False,
3209
from bzrlib.check import check_dwim
3212
if not branch and not repo and not tree:
3213
branch = repo = tree = True
3214
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3217
class cmd_upgrade(Command):
3218
"""Upgrade branch storage to current format.
3220
The check command or bzr developers may sometimes advise you to run
3221
this command. When the default format has changed you may also be warned
3222
during other operations to upgrade.
3225
_see_also = ['check']
3226
takes_args = ['url?']
3228
RegistryOption('format',
3229
help='Upgrade to a specific format. See "bzr help'
3230
' formats" for details.',
3231
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3232
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3233
value_switches=True, title='Branch format'),
3236
def run(self, url='.', format=None):
3237
from bzrlib.upgrade import upgrade
3238
upgrade(url, format)
3241
class cmd_whoami(Command):
3242
"""Show or set bzr user id.
3245
Show the email of the current user::
3249
Set the current user::
3251
bzr whoami "Frank Chu <fchu@example.com>"
3253
takes_options = [ Option('email',
3254
help='Display email address only.'),
3256
help='Set identity for the current branch instead of '
3259
takes_args = ['name?']
3260
encoding_type = 'replace'
3263
def run(self, email=False, branch=False, name=None):
3265
# use branch if we're inside one; otherwise global config
3267
c = Branch.open_containing('.')[0].get_config()
3268
except errors.NotBranchError:
3269
c = config.GlobalConfig()
3271
self.outf.write(c.user_email() + '\n')
3273
self.outf.write(c.username() + '\n')
3276
# display a warning if an email address isn't included in the given name.
3278
config.extract_email_address(name)
3279
except errors.NoEmailInUsername, e:
3280
warning('"%s" does not seem to contain an email address. '
3281
'This is allowed, but not recommended.', name)
3283
# use global config unless --branch given
3285
c = Branch.open_containing('.')[0].get_config()
3287
c = config.GlobalConfig()
3288
c.set_user_option('email', name)
3291
class cmd_nick(Command):
3292
"""Print or set the branch nickname.
3294
If unset, the tree root directory name is used as the nickname.
3295
To print the current nickname, execute with no argument.
3297
Bound branches use the nickname of its master branch unless it is set
3301
_see_also = ['info']
3302
takes_args = ['nickname?']
3303
def run(self, nickname=None):
3304
branch = Branch.open_containing(u'.')[0]
3305
if nickname is None:
3306
self.printme(branch)
3308
branch.nick = nickname
3311
def printme(self, branch):
3315
class cmd_alias(Command):
3316
"""Set/unset and display aliases.
3319
Show the current aliases::
3323
Show the alias specified for 'll'::
3327
Set an alias for 'll'::
3329
bzr alias ll="log --line -r-10..-1"
3331
To remove an alias for 'll'::
3333
bzr alias --remove ll
3336
takes_args = ['name?']
3338
Option('remove', help='Remove the alias.'),
3341
def run(self, name=None, remove=False):
3343
self.remove_alias(name)
3345
self.print_aliases()
3347
equal_pos = name.find('=')
3349
self.print_alias(name)
3351
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3353
def remove_alias(self, alias_name):
3354
if alias_name is None:
3355
raise errors.BzrCommandError(
3356
'bzr alias --remove expects an alias to remove.')
3357
# If alias is not found, print something like:
3358
# unalias: foo: not found
3359
c = config.GlobalConfig()
3360
c.unset_alias(alias_name)
3363
def print_aliases(self):
3364
"""Print out the defined aliases in a similar format to bash."""
3365
aliases = config.GlobalConfig().get_aliases()
3366
for key, value in sorted(aliases.iteritems()):
3367
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3370
def print_alias(self, alias_name):
3371
from bzrlib.commands import get_alias
3372
alias = get_alias(alias_name)
3374
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3377
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3379
def set_alias(self, alias_name, alias_command):
3380
"""Save the alias in the global config."""
3381
c = config.GlobalConfig()
3382
c.set_alias(alias_name, alias_command)
3385
class cmd_selftest(Command):
3386
"""Run internal test suite.
3388
If arguments are given, they are regular expressions that say which tests
3389
should run. Tests matching any expression are run, and other tests are
3392
Alternatively if --first is given, matching tests are run first and then
3393
all other tests are run. This is useful if you have been working in a
3394
particular area, but want to make sure nothing else was broken.
3396
If --exclude is given, tests that match that regular expression are
3397
excluded, regardless of whether they match --first or not.
3399
To help catch accidential dependencies between tests, the --randomize
3400
option is useful. In most cases, the argument used is the word 'now'.
3401
Note that the seed used for the random number generator is displayed
3402
when this option is used. The seed can be explicitly passed as the
3403
argument to this option if required. This enables reproduction of the
3404
actual ordering used if and when an order sensitive problem is encountered.
3406
If --list-only is given, the tests that would be run are listed. This is
3407
useful when combined with --first, --exclude and/or --randomize to
3408
understand their impact. The test harness reports "Listed nn tests in ..."
3409
instead of "Ran nn tests in ..." when list mode is enabled.
3411
If the global option '--no-plugins' is given, plugins are not loaded
3412
before running the selftests. This has two effects: features provided or
3413
modified by plugins will not be tested, and tests provided by plugins will
3416
Tests that need working space on disk use a common temporary directory,
3417
typically inside $TMPDIR or /tmp.
3419
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3420
into a pdb postmortem session.
3423
Run only tests relating to 'ignore'::
3427
Disable plugins and list tests as they're run::
3429
bzr --no-plugins selftest -v
3431
# NB: this is used from the class without creating an instance, which is
3432
# why it does not have a self parameter.
3433
def get_transport_type(typestring):
3434
"""Parse and return a transport specifier."""
3435
if typestring == "sftp":
3436
from bzrlib.transport.sftp import SFTPAbsoluteServer
3437
return SFTPAbsoluteServer
3438
if typestring == "memory":
3439
from bzrlib.transport.memory import MemoryServer
3441
if typestring == "fakenfs":
3442
from bzrlib.transport.fakenfs import FakeNFSServer
3443
return FakeNFSServer
3444
msg = "No known transport type %s. Supported types are: sftp\n" %\
3446
raise errors.BzrCommandError(msg)
3449
takes_args = ['testspecs*']
3450
takes_options = ['verbose',
3452
help='Stop when one test fails.',
3456
help='Use a different transport by default '
3457
'throughout the test suite.',
3458
type=get_transport_type),
3460
help='Run the benchmarks rather than selftests.'),
3461
Option('lsprof-timed',
3462
help='Generate lsprof output for benchmarked'
3463
' sections of code.'),
3464
Option('lsprof-tests',
3465
help='Generate lsprof output for each test.'),
3466
Option('cache-dir', type=str,
3467
help='Cache intermediate benchmark output in this '
3470
help='Run all tests, but run specified tests first.',
3474
help='List the tests instead of running them.'),
3475
RegistryOption('parallel',
3476
help="Run the test suite in parallel.",
3477
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3478
value_switches=False,
3480
Option('randomize', type=str, argname="SEED",
3481
help='Randomize the order of tests using the given'
3482
' seed or "now" for the current time.'),
3483
Option('exclude', type=str, argname="PATTERN",
3485
help='Exclude tests that match this regular'
3488
help='Output test progress via subunit.'),
3489
Option('strict', help='Fail on missing dependencies or '
3491
Option('load-list', type=str, argname='TESTLISTFILE',
3492
help='Load a test id list from a text file.'),
3493
ListOption('debugflag', type=str, short_name='E',
3494
help='Turn on a selftest debug flag.'),
3495
ListOption('starting-with', type=str, argname='TESTID',
3496
param_name='starting_with', short_name='s',
3498
'Load only the tests starting with TESTID.'),
3500
encoding_type = 'replace'
3503
Command.__init__(self)
3504
self.additional_selftest_args = {}
3506
def run(self, testspecs_list=None, verbose=False, one=False,
3507
transport=None, benchmark=None,
3508
lsprof_timed=None, cache_dir=None,
3509
first=False, list_only=False,
3510
randomize=None, exclude=None, strict=False,
3511
load_list=None, debugflag=None, starting_with=None, subunit=False,
3512
parallel=None, lsprof_tests=False):
3513
from bzrlib.tests import selftest
3514
import bzrlib.benchmarks as benchmarks
3515
from bzrlib.benchmarks import tree_creator
3517
# Make deprecation warnings visible, unless -Werror is set
3518
symbol_versioning.activate_deprecation_warnings(override=False)
3520
if cache_dir is not None:
3521
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3522
if testspecs_list is not None:
3523
pattern = '|'.join(testspecs_list)
3528
from bzrlib.tests import SubUnitBzrRunner
3530
raise errors.BzrCommandError("subunit not available. subunit "
3531
"needs to be installed to use --subunit.")
3532
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3534
self.additional_selftest_args.setdefault(
3535
'suite_decorators', []).append(parallel)
3537
test_suite_factory = benchmarks.test_suite
3538
# Unless user explicitly asks for quiet, be verbose in benchmarks
3539
verbose = not is_quiet()
3540
# TODO: should possibly lock the history file...
3541
benchfile = open(".perf_history", "at", buffering=1)
3542
self.add_cleanup(benchfile.close)
3544
test_suite_factory = None
3546
selftest_kwargs = {"verbose": verbose,
3548
"stop_on_failure": one,
3549
"transport": transport,
3550
"test_suite_factory": test_suite_factory,
3551
"lsprof_timed": lsprof_timed,
3552
"lsprof_tests": lsprof_tests,
3553
"bench_history": benchfile,
3554
"matching_tests_first": first,
3555
"list_only": list_only,
3556
"random_seed": randomize,
3557
"exclude_pattern": exclude,
3559
"load_list": load_list,
3560
"debug_flags": debugflag,
3561
"starting_with": starting_with
3563
selftest_kwargs.update(self.additional_selftest_args)
3564
result = selftest(**selftest_kwargs)
3565
return int(not result)
3568
class cmd_version(Command):
3569
"""Show version of bzr."""
3571
encoding_type = 'replace'
3573
Option("short", help="Print just the version number."),
3577
def run(self, short=False):
3578
from bzrlib.version import show_version
3580
self.outf.write(bzrlib.version_string + '\n')
3582
show_version(to_file=self.outf)
3585
class cmd_rocks(Command):
3586
"""Statement of optimism."""
3592
print "It sure does!"
3595
class cmd_find_merge_base(Command):
3596
"""Find and print a base revision for merging two branches."""
3597
# TODO: Options to specify revisions on either side, as if
3598
# merging only part of the history.
3599
takes_args = ['branch', 'other']
3603
def run(self, branch, other):
3604
from bzrlib.revision import ensure_null
3606
branch1 = Branch.open_containing(branch)[0]
3607
branch2 = Branch.open_containing(other)[0]
3609
self.add_cleanup(branch1.unlock)
3611
self.add_cleanup(branch2.unlock)
3612
last1 = ensure_null(branch1.last_revision())
3613
last2 = ensure_null(branch2.last_revision())
3615
graph = branch1.repository.get_graph(branch2.repository)
3616
base_rev_id = graph.find_unique_lca(last1, last2)
3618
print 'merge base is revision %s' % base_rev_id
3621
class cmd_merge(Command):
3622
"""Perform a three-way merge.
3624
The source of the merge can be specified either in the form of a branch,
3625
or in the form of a path to a file containing a merge directive generated
3626
with bzr send. If neither is specified, the default is the upstream branch
3627
or the branch most recently merged using --remember.
3629
When merging a branch, by default the tip will be merged. To pick a different
3630
revision, pass --revision. If you specify two values, the first will be used as
3631
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3632
available revisions, like this is commonly referred to as "cherrypicking".
3634
Revision numbers are always relative to the branch being merged.
3636
By default, bzr will try to merge in all new work from the other
3637
branch, automatically determining an appropriate base. If this
3638
fails, you may need to give an explicit base.
3640
Merge will do its best to combine the changes in two branches, but there
3641
are some kinds of problems only a human can fix. When it encounters those,
3642
it will mark a conflict. A conflict means that you need to fix something,
3643
before you should commit.
3645
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3647
If there is no default branch set, the first merge will set it. After
3648
that, you can omit the branch to use the default. To change the
3649
default, use --remember. The value will only be saved if the remote
3650
location can be accessed.
3652
The results of the merge are placed into the destination working
3653
directory, where they can be reviewed (with bzr diff), tested, and then
3654
committed to record the result of the merge.
3656
merge refuses to run if there are any uncommitted changes, unless
3659
To select only some changes to merge, use "merge -i", which will prompt
3660
you to apply each diff hunk and file change, similar to "shelve".
3663
To merge the latest revision from bzr.dev::
3665
bzr merge ../bzr.dev
3667
To merge changes up to and including revision 82 from bzr.dev::
3669
bzr merge -r 82 ../bzr.dev
3671
To merge the changes introduced by 82, without previous changes::
3673
bzr merge -r 81..82 ../bzr.dev
3675
To apply a merge directive contained in /tmp/merge::
3677
bzr merge /tmp/merge
3680
encoding_type = 'exact'
3681
_see_also = ['update', 'remerge', 'status-flags', 'send']
3682
takes_args = ['location?']
3687
help='Merge even if the destination tree has uncommitted changes.'),
3691
Option('show-base', help="Show base revision text in "
3693
Option('uncommitted', help='Apply uncommitted changes'
3694
' from a working copy, instead of branch changes.'),
3695
Option('pull', help='If the destination is already'
3696
' completely merged into the source, pull from the'
3697
' source rather than merging. When this happens,'
3698
' you do not need to commit the result.'),
3700
help='Branch to merge into, '
3701
'rather than the one containing the working directory.',
3705
Option('preview', help='Instead of merging, show a diff of the'
3707
Option('interactive', help='Select changes interactively.',
3711
def run(self, location=None, revision=None, force=False,
3712
merge_type=None, show_base=False, reprocess=None, remember=False,
3713
uncommitted=False, pull=False,
3718
if merge_type is None:
3719
merge_type = _mod_merge.Merge3Merger
3721
if directory is None: directory = u'.'
3722
possible_transports = []
3724
allow_pending = True
3725
verified = 'inapplicable'
3726
tree = WorkingTree.open_containing(directory)[0]
3729
basis_tree = tree.revision_tree(tree.last_revision())
3730
except errors.NoSuchRevision:
3731
basis_tree = tree.basis_tree()
3733
# die as quickly as possible if there are uncommitted changes
3735
if tree.has_changes():
3736
raise errors.UncommittedChanges(tree)
3738
view_info = _get_view_info_for_change_reporter(tree)
3739
change_reporter = delta._ChangeReporter(
3740
unversioned_filter=tree.is_ignored, view_info=view_info)
3741
pb = ui.ui_factory.nested_progress_bar()
3742
self.add_cleanup(pb.finished)
3744
self.add_cleanup(tree.unlock)
3745
if location is not None:
3747
mergeable = bundle.read_mergeable_from_url(location,
3748
possible_transports=possible_transports)
3749
except errors.NotABundle:
3753
raise errors.BzrCommandError('Cannot use --uncommitted'
3754
' with bundles or merge directives.')
3756
if revision is not None:
3757
raise errors.BzrCommandError(
3758
'Cannot use -r with merge directives or bundles')
3759
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3762
if merger is None and uncommitted:
3763
if revision is not None and len(revision) > 0:
3764
raise errors.BzrCommandError('Cannot use --uncommitted and'
3765
' --revision at the same time.')
3766
merger = self.get_merger_from_uncommitted(tree, location, pb)
3767
allow_pending = False
3770
merger, allow_pending = self._get_merger_from_branch(tree,
3771
location, revision, remember, possible_transports, pb)
3773
merger.merge_type = merge_type
3774
merger.reprocess = reprocess
3775
merger.show_base = show_base
3776
self.sanity_check_merger(merger)
3777
if (merger.base_rev_id == merger.other_rev_id and
3778
merger.other_rev_id is not None):
3779
note('Nothing to do.')
3782
if merger.interesting_files is not None:
3783
raise errors.BzrCommandError('Cannot pull individual files')
3784
if (merger.base_rev_id == tree.last_revision()):
3785
result = tree.pull(merger.other_branch, False,
3786
merger.other_rev_id)
3787
result.report(self.outf)
3789
if merger.this_basis is None:
3790
raise errors.BzrCommandError(
3791
"This branch has no commits."
3792
" (perhaps you would prefer 'bzr pull')")
3794
return self._do_preview(merger)
3796
return self._do_interactive(merger)
3798
return self._do_merge(merger, change_reporter, allow_pending,
3801
def _get_preview(self, merger):
3802
tree_merger = merger.make_merger()
3803
tt = tree_merger.make_preview_transform()
3804
self.add_cleanup(tt.finalize)
3805
result_tree = tt.get_preview_tree()
3808
def _do_preview(self, merger):
3809
from bzrlib.diff import show_diff_trees
3810
result_tree = self._get_preview(merger)
3811
show_diff_trees(merger.this_tree, result_tree, self.outf,
3812
old_label='', new_label='')
3814
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3815
merger.change_reporter = change_reporter
3816
conflict_count = merger.do_merge()
3818
merger.set_pending()
3819
if verified == 'failed':
3820
warning('Preview patch does not match changes')
3821
if conflict_count != 0:
3826
def _do_interactive(self, merger):
3827
"""Perform an interactive merge.
3829
This works by generating a preview tree of the merge, then using
3830
Shelver to selectively remove the differences between the working tree
3831
and the preview tree.
3833
from bzrlib import shelf_ui
3834
result_tree = self._get_preview(merger)
3835
writer = bzrlib.option.diff_writer_registry.get()
3836
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3837
reporter=shelf_ui.ApplyReporter(),
3838
diff_writer=writer(sys.stdout))
3844
def sanity_check_merger(self, merger):
3845
if (merger.show_base and
3846
not merger.merge_type is _mod_merge.Merge3Merger):
3847
raise errors.BzrCommandError("Show-base is not supported for this"
3848
" merge type. %s" % merger.merge_type)
3849
if merger.reprocess is None:
3850
if merger.show_base:
3851
merger.reprocess = False
3853
# Use reprocess if the merger supports it
3854
merger.reprocess = merger.merge_type.supports_reprocess
3855
if merger.reprocess and not merger.merge_type.supports_reprocess:
3856
raise errors.BzrCommandError("Conflict reduction is not supported"
3857
" for merge type %s." %
3859
if merger.reprocess and merger.show_base:
3860
raise errors.BzrCommandError("Cannot do conflict reduction and"
3863
def _get_merger_from_branch(self, tree, location, revision, remember,
3864
possible_transports, pb):
3865
"""Produce a merger from a location, assuming it refers to a branch."""
3866
from bzrlib.tag import _merge_tags_if_possible
3867
# find the branch locations
3868
other_loc, user_location = self._select_branch_location(tree, location,
3870
if revision is not None and len(revision) == 2:
3871
base_loc, _unused = self._select_branch_location(tree,
3872
location, revision, 0)
3874
base_loc = other_loc
3876
other_branch, other_path = Branch.open_containing(other_loc,
3877
possible_transports)
3878
if base_loc == other_loc:
3879
base_branch = other_branch
3881
base_branch, base_path = Branch.open_containing(base_loc,
3882
possible_transports)
3883
# Find the revision ids
3884
other_revision_id = None
3885
base_revision_id = None
3886
if revision is not None:
3887
if len(revision) >= 1:
3888
other_revision_id = revision[-1].as_revision_id(other_branch)
3889
if len(revision) == 2:
3890
base_revision_id = revision[0].as_revision_id(base_branch)
3891
if other_revision_id is None:
3892
other_revision_id = _mod_revision.ensure_null(
3893
other_branch.last_revision())
3894
# Remember where we merge from
3895
if ((remember or tree.branch.get_submit_branch() is None) and
3896
user_location is not None):
3897
tree.branch.set_submit_branch(other_branch.base)
3898
_merge_tags_if_possible(other_branch, tree.branch)
3899
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3900
other_revision_id, base_revision_id, other_branch, base_branch)
3901
if other_path != '':
3902
allow_pending = False
3903
merger.interesting_files = [other_path]
3905
allow_pending = True
3906
return merger, allow_pending
3908
def get_merger_from_uncommitted(self, tree, location, pb):
3909
"""Get a merger for uncommitted changes.
3911
:param tree: The tree the merger should apply to.
3912
:param location: The location containing uncommitted changes.
3913
:param pb: The progress bar to use for showing progress.
3915
location = self._select_branch_location(tree, location)[0]
3916
other_tree, other_path = WorkingTree.open_containing(location)
3917
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3918
if other_path != '':
3919
merger.interesting_files = [other_path]
3922
def _select_branch_location(self, tree, user_location, revision=None,
3924
"""Select a branch location, according to possible inputs.
3926
If provided, branches from ``revision`` are preferred. (Both
3927
``revision`` and ``index`` must be supplied.)
3929
Otherwise, the ``location`` parameter is used. If it is None, then the
3930
``submit`` or ``parent`` location is used, and a note is printed.
3932
:param tree: The working tree to select a branch for merging into
3933
:param location: The location entered by the user
3934
:param revision: The revision parameter to the command
3935
:param index: The index to use for the revision parameter. Negative
3936
indices are permitted.
3937
:return: (selected_location, user_location). The default location
3938
will be the user-entered location.
3940
if (revision is not None and index is not None
3941
and revision[index] is not None):
3942
branch = revision[index].get_branch()
3943
if branch is not None:
3944
return branch, branch
3945
if user_location is None:
3946
location = self._get_remembered(tree, 'Merging from')
3948
location = user_location
3949
return location, user_location
3951
def _get_remembered(self, tree, verb_string):
3952
"""Use tree.branch's parent if none was supplied.
3954
Report if the remembered location was used.
3956
stored_location = tree.branch.get_submit_branch()
3957
stored_location_type = "submit"
3958
if stored_location is None:
3959
stored_location = tree.branch.get_parent()
3960
stored_location_type = "parent"
3961
mutter("%s", stored_location)
3962
if stored_location is None:
3963
raise errors.BzrCommandError("No location specified or remembered")
3964
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3965
note(u"%s remembered %s location %s", verb_string,
3966
stored_location_type, display_url)
3967
return stored_location
3970
class cmd_remerge(Command):
3973
Use this if you want to try a different merge technique while resolving
3974
conflicts. Some merge techniques are better than others, and remerge
3975
lets you try different ones on different files.
3977
The options for remerge have the same meaning and defaults as the ones for
3978
merge. The difference is that remerge can (only) be run when there is a
3979
pending merge, and it lets you specify particular files.
3982
Re-do the merge of all conflicted files, and show the base text in
3983
conflict regions, in addition to the usual THIS and OTHER texts::
3985
bzr remerge --show-base
3987
Re-do the merge of "foobar", using the weave merge algorithm, with
3988
additional processing to reduce the size of conflict regions::
3990
bzr remerge --merge-type weave --reprocess foobar
3992
takes_args = ['file*']
3997
help="Show base revision text in conflicts."),
4000
def run(self, file_list=None, merge_type=None, show_base=False,
4002
if merge_type is None:
4003
merge_type = _mod_merge.Merge3Merger
4004
tree, file_list = tree_files(file_list)
4006
self.add_cleanup(tree.unlock)
4007
parents = tree.get_parent_ids()
4008
if len(parents) != 2:
4009
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4010
" merges. Not cherrypicking or"
4012
repository = tree.branch.repository
4013
interesting_ids = None
4015
conflicts = tree.conflicts()
4016
if file_list is not None:
4017
interesting_ids = set()
4018
for filename in file_list:
4019
file_id = tree.path2id(filename)
4021
raise errors.NotVersionedError(filename)
4022
interesting_ids.add(file_id)
4023
if tree.kind(file_id) != "directory":
4026
for name, ie in tree.inventory.iter_entries(file_id):
4027
interesting_ids.add(ie.file_id)
4028
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4030
# Remerge only supports resolving contents conflicts
4031
allowed_conflicts = ('text conflict', 'contents conflict')
4032
restore_files = [c.path for c in conflicts
4033
if c.typestring in allowed_conflicts]
4034
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4035
tree.set_conflicts(ConflictList(new_conflicts))
4036
if file_list is not None:
4037
restore_files = file_list
4038
for filename in restore_files:
4040
restore(tree.abspath(filename))
4041
except errors.NotConflicted:
4043
# Disable pending merges, because the file texts we are remerging
4044
# have not had those merges performed. If we use the wrong parents
4045
# list, we imply that the working tree text has seen and rejected
4046
# all the changes from the other tree, when in fact those changes
4047
# have not yet been seen.
4048
pb = ui.ui_factory.nested_progress_bar()
4049
tree.set_parent_ids(parents[:1])
4051
merger = _mod_merge.Merger.from_revision_ids(pb,
4053
merger.interesting_ids = interesting_ids
4054
merger.merge_type = merge_type
4055
merger.show_base = show_base
4056
merger.reprocess = reprocess
4057
conflicts = merger.do_merge()
4059
tree.set_parent_ids(parents)
4067
class cmd_revert(Command):
4068
"""Revert files to a previous revision.
4070
Giving a list of files will revert only those files. Otherwise, all files
4071
will be reverted. If the revision is not specified with '--revision', the
4072
last committed revision is used.
4074
To remove only some changes, without reverting to a prior version, use
4075
merge instead. For example, "merge . --revision -2..-3" will remove the
4076
changes introduced by -2, without affecting the changes introduced by -1.
4077
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4079
By default, any files that have been manually changed will be backed up
4080
first. (Files changed only by merge are not backed up.) Backup files have
4081
'.~#~' appended to their name, where # is a number.
4083
When you provide files, you can use their current pathname or the pathname
4084
from the target revision. So you can use revert to "undelete" a file by
4085
name. If you name a directory, all the contents of that directory will be
4088
If you have newly added files since the target revision, they will be
4089
removed. If the files to be removed have been changed, backups will be
4090
created as above. Directories containing unknown files will not be
4093
The working tree contains a list of pending merged revisions, which will
4094
be included as parents in the next commit. Normally, revert clears that
4095
list as well as reverting the files. If any files are specified, revert
4096
leaves the pending merge list alone and reverts only the files. Use "bzr
4097
revert ." in the tree root to revert all files but keep the merge record,
4098
and "bzr revert --forget-merges" to clear the pending merge list without
4099
reverting any files.
4101
Using "bzr revert --forget-merges", it is possible to apply the changes
4102
from an arbitrary merge as a single revision. To do this, perform the
4103
merge as desired. Then doing revert with the "--forget-merges" option will
4104
keep the content of the tree as it was, but it will clear the list of
4105
pending merges. The next commit will then contain all of the changes that
4106
would have been in the merge, but without any mention of the other parent
4107
revisions. Because this technique forgets where these changes originated,
4108
it may cause additional conflicts on later merges involving the source and
4112
_see_also = ['cat', 'export']
4115
Option('no-backup', "Do not save backups of reverted files."),
4116
Option('forget-merges',
4117
'Remove pending merge marker, without changing any files.'),
4119
takes_args = ['file*']
4121
def run(self, revision=None, no_backup=False, file_list=None,
4122
forget_merges=None):
4123
tree, file_list = tree_files(file_list)
4125
self.add_cleanup(tree.unlock)
4127
tree.set_parent_ids(tree.get_parent_ids()[:1])
4129
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4132
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4133
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4134
pb = ui.ui_factory.nested_progress_bar()
4136
tree.revert(file_list, rev_tree, not no_backup, pb,
4137
report_changes=True)
4142
class cmd_assert_fail(Command):
4143
"""Test reporting of assertion failures"""
4144
# intended just for use in testing
4149
raise AssertionError("always fails")
4152
class cmd_help(Command):
4153
"""Show help on a command or other topic.
4156
_see_also = ['topics']
4158
Option('long', 'Show help on all commands.'),
4160
takes_args = ['topic?']
4161
aliases = ['?', '--help', '-?', '-h']
4164
def run(self, topic=None, long=False):
4166
if topic is None and long:
4168
bzrlib.help.help(topic)
4171
class cmd_shell_complete(Command):
4172
"""Show appropriate completions for context.
4174
For a list of all available commands, say 'bzr shell-complete'.
4176
takes_args = ['context?']
4181
def run(self, context=None):
4182
import shellcomplete
4183
shellcomplete.shellcomplete(context)
4186
class cmd_missing(Command):
4187
"""Show unmerged/unpulled revisions between two branches.
4189
OTHER_BRANCH may be local or remote.
4191
To filter on a range of revisions, you can use the command -r begin..end
4192
-r revision requests a specific revision, -r ..end or -r begin.. are
4196
1 - some missing revisions
4197
0 - no missing revisions
4201
Determine the missing revisions between this and the branch at the
4202
remembered pull location::
4206
Determine the missing revisions between this and another branch::
4208
bzr missing http://server/branch
4210
Determine the missing revisions up to a specific revision on the other
4213
bzr missing -r ..-10
4215
Determine the missing revisions up to a specific revision on this
4218
bzr missing --my-revision ..-10
4221
_see_also = ['merge', 'pull']
4222
takes_args = ['other_branch?']
4224
Option('reverse', 'Reverse the order of revisions.'),
4226
'Display changes in the local branch only.'),
4227
Option('this' , 'Same as --mine-only.'),
4228
Option('theirs-only',
4229
'Display changes in the remote branch only.'),
4230
Option('other', 'Same as --theirs-only.'),
4234
custom_help('revision',
4235
help='Filter on other branch revisions (inclusive). '
4236
'See "help revisionspec" for details.'),
4237
Option('my-revision',
4238
type=_parse_revision_str,
4239
help='Filter on local branch revisions (inclusive). '
4240
'See "help revisionspec" for details.'),
4241
Option('include-merges',
4242
'Show all revisions in addition to the mainline ones.'),
4244
encoding_type = 'replace'
4247
def run(self, other_branch=None, reverse=False, mine_only=False,
4249
log_format=None, long=False, short=False, line=False,
4250
show_ids=False, verbose=False, this=False, other=False,
4251
include_merges=False, revision=None, my_revision=None):
4252
from bzrlib.missing import find_unmerged, iter_log_revisions
4261
# TODO: We should probably check that we don't have mine-only and
4262
# theirs-only set, but it gets complicated because we also have
4263
# this and other which could be used.
4270
local_branch = Branch.open_containing(u".")[0]
4271
parent = local_branch.get_parent()
4272
if other_branch is None:
4273
other_branch = parent
4274
if other_branch is None:
4275
raise errors.BzrCommandError("No peer location known"
4277
display_url = urlutils.unescape_for_display(parent,
4279
message("Using saved parent location: "
4280
+ display_url + "\n")
4282
remote_branch = Branch.open(other_branch)
4283
if remote_branch.base == local_branch.base:
4284
remote_branch = local_branch
4286
local_branch.lock_read()
4287
self.add_cleanup(local_branch.unlock)
4288
local_revid_range = _revision_range_to_revid_range(
4289
_get_revision_range(my_revision, local_branch,
4292
remote_branch.lock_read()
4293
self.add_cleanup(remote_branch.unlock)
4294
remote_revid_range = _revision_range_to_revid_range(
4295
_get_revision_range(revision,
4296
remote_branch, self.name()))
4298
local_extra, remote_extra = find_unmerged(
4299
local_branch, remote_branch, restrict,
4300
backward=not reverse,
4301
include_merges=include_merges,
4302
local_revid_range=local_revid_range,
4303
remote_revid_range=remote_revid_range)
4305
if log_format is None:
4306
registry = log.log_formatter_registry
4307
log_format = registry.get_default(local_branch)
4308
lf = log_format(to_file=self.outf,
4310
show_timezone='original')
4313
if local_extra and not theirs_only:
4314
message("You have %d extra revision(s):\n" %
4316
for revision in iter_log_revisions(local_extra,
4317
local_branch.repository,
4319
lf.log_revision(revision)
4320
printed_local = True
4323
printed_local = False
4325
if remote_extra and not mine_only:
4326
if printed_local is True:
4328
message("You are missing %d revision(s):\n" %
4330
for revision in iter_log_revisions(remote_extra,
4331
remote_branch.repository,
4333
lf.log_revision(revision)
4336
if mine_only and not local_extra:
4337
# We checked local, and found nothing extra
4338
message('This branch is up to date.\n')
4339
elif theirs_only and not remote_extra:
4340
# We checked remote, and found nothing extra
4341
message('Other branch is up to date.\n')
4342
elif not (mine_only or theirs_only or local_extra or
4344
# We checked both branches, and neither one had extra
4346
message("Branches are up to date.\n")
4348
if not status_code and parent is None and other_branch is not None:
4349
local_branch.lock_write()
4350
self.add_cleanup(local_branch.unlock)
4351
# handle race conditions - a parent might be set while we run.
4352
if local_branch.get_parent() is None:
4353
local_branch.set_parent(remote_branch.base)
4357
class cmd_pack(Command):
4358
"""Compress the data within a repository."""
4360
_see_also = ['repositories']
4361
takes_args = ['branch_or_repo?']
4363
def run(self, branch_or_repo='.'):
4364
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4366
branch = dir.open_branch()
4367
repository = branch.repository
4368
except errors.NotBranchError:
4369
repository = dir.open_repository()
4373
class cmd_plugins(Command):
4374
"""List the installed plugins.
4376
This command displays the list of installed plugins including
4377
version of plugin and a short description of each.
4379
--verbose shows the path where each plugin is located.
4381
A plugin is an external component for Bazaar that extends the
4382
revision control system, by adding or replacing code in Bazaar.
4383
Plugins can do a variety of things, including overriding commands,
4384
adding new commands, providing additional network transports and
4385
customizing log output.
4387
See the Bazaar web site, http://bazaar-vcs.org, for further
4388
information on plugins including where to find them and how to
4389
install them. Instructions are also provided there on how to
4390
write new plugins using the Python programming language.
4392
takes_options = ['verbose']
4395
def run(self, verbose=False):
4396
import bzrlib.plugin
4397
from inspect import getdoc
4399
for name, plugin in bzrlib.plugin.plugins().items():
4400
version = plugin.__version__
4401
if version == 'unknown':
4403
name_ver = '%s %s' % (name, version)
4404
d = getdoc(plugin.module)
4406
doc = d.split('\n')[0]
4408
doc = '(no description)'
4409
result.append((name_ver, doc, plugin.path()))
4410
for name_ver, doc, path in sorted(result):
4418
class cmd_testament(Command):
4419
"""Show testament (signing-form) of a revision."""
4422
Option('long', help='Produce long-format testament.'),
4424
help='Produce a strict-format testament.')]
4425
takes_args = ['branch?']
4427
def run(self, branch=u'.', revision=None, long=False, strict=False):
4428
from bzrlib.testament import Testament, StrictTestament
4430
testament_class = StrictTestament
4432
testament_class = Testament
4434
b = Branch.open_containing(branch)[0]
4436
b = Branch.open(branch)
4438
self.add_cleanup(b.unlock)
4439
if revision is None:
4440
rev_id = b.last_revision()
4442
rev_id = revision[0].as_revision_id(b)
4443
t = testament_class.from_revision(b.repository, rev_id)
4445
sys.stdout.writelines(t.as_text_lines())
4447
sys.stdout.write(t.as_short_text())
4450
class cmd_annotate(Command):
4451
"""Show the origin of each line in a file.
4453
This prints out the given file with an annotation on the left side
4454
indicating which revision, author and date introduced the change.
4456
If the origin is the same for a run of consecutive lines, it is
4457
shown only at the top, unless the --all option is given.
4459
# TODO: annotate directories; showing when each file was last changed
4460
# TODO: if the working copy is modified, show annotations on that
4461
# with new uncommitted lines marked
4462
aliases = ['ann', 'blame', 'praise']
4463
takes_args = ['filename']
4464
takes_options = [Option('all', help='Show annotations on all lines.'),
4465
Option('long', help='Show commit date in annotations.'),
4469
encoding_type = 'exact'
4472
def run(self, filename, all=False, long=False, revision=None,
4474
from bzrlib.annotate import annotate_file, annotate_file_tree
4475
wt, branch, relpath = \
4476
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4479
self.add_cleanup(wt.unlock)
4482
self.add_cleanup(branch.unlock)
4483
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4485
self.add_cleanup(tree.unlock)
4487
file_id = wt.path2id(relpath)
4489
file_id = tree.path2id(relpath)
4491
raise errors.NotVersionedError(filename)
4492
file_version = tree.inventory[file_id].revision
4493
if wt is not None and revision is None:
4494
# If there is a tree and we're not annotating historical
4495
# versions, annotate the working tree's content.
4496
annotate_file_tree(wt, file_id, self.outf, long, all,
4499
annotate_file(branch, file_version, file_id, long, all, self.outf,
4503
class cmd_re_sign(Command):
4504
"""Create a digital signature for an existing revision."""
4505
# TODO be able to replace existing ones.
4507
hidden = True # is this right ?
4508
takes_args = ['revision_id*']
4509
takes_options = ['revision']
4511
def run(self, revision_id_list=None, revision=None):
4512
if revision_id_list is not None and revision is not None:
4513
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4514
if revision_id_list is None and revision is None:
4515
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4516
b = WorkingTree.open_containing(u'.')[0].branch
4518
self.add_cleanup(b.unlock)
4519
return self._run(b, revision_id_list, revision)
4521
def _run(self, b, revision_id_list, revision):
4522
import bzrlib.gpg as gpg
4523
gpg_strategy = gpg.GPGStrategy(b.get_config())
4524
if revision_id_list is not None:
4525
b.repository.start_write_group()
4527
for revision_id in revision_id_list:
4528
b.repository.sign_revision(revision_id, gpg_strategy)
4530
b.repository.abort_write_group()
4533
b.repository.commit_write_group()
4534
elif revision is not None:
4535
if len(revision) == 1:
4536
revno, rev_id = revision[0].in_history(b)
4537
b.repository.start_write_group()
4539
b.repository.sign_revision(rev_id, gpg_strategy)
4541
b.repository.abort_write_group()
4544
b.repository.commit_write_group()
4545
elif len(revision) == 2:
4546
# are they both on rh- if so we can walk between them
4547
# might be nice to have a range helper for arbitrary
4548
# revision paths. hmm.
4549
from_revno, from_revid = revision[0].in_history(b)
4550
to_revno, to_revid = revision[1].in_history(b)
4551
if to_revid is None:
4552
to_revno = b.revno()
4553
if from_revno is None or to_revno is None:
4554
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4555
b.repository.start_write_group()
4557
for revno in range(from_revno, to_revno + 1):
4558
b.repository.sign_revision(b.get_rev_id(revno),
4561
b.repository.abort_write_group()
4564
b.repository.commit_write_group()
4566
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4569
class cmd_bind(Command):
4570
"""Convert the current branch into a checkout of the supplied branch.
4572
Once converted into a checkout, commits must succeed on the master branch
4573
before they will be applied to the local branch.
4575
Bound branches use the nickname of its master branch unless it is set
4576
locally, in which case binding will update the local nickname to be
4580
_see_also = ['checkouts', 'unbind']
4581
takes_args = ['location?']
4584
def run(self, location=None):
4585
b, relpath = Branch.open_containing(u'.')
4586
if location is None:
4588
location = b.get_old_bound_location()
4589
except errors.UpgradeRequired:
4590
raise errors.BzrCommandError('No location supplied. '
4591
'This format does not remember old locations.')
4593
if location is None:
4594
raise errors.BzrCommandError('No location supplied and no '
4595
'previous location known')
4596
b_other = Branch.open(location)
4599
except errors.DivergedBranches:
4600
raise errors.BzrCommandError('These branches have diverged.'
4601
' Try merging, and then bind again.')
4602
if b.get_config().has_explicit_nickname():
4603
b.nick = b_other.nick
4606
class cmd_unbind(Command):
4607
"""Convert the current checkout into a regular branch.
4609
After unbinding, the local branch is considered independent and subsequent
4610
commits will be local only.
4613
_see_also = ['checkouts', 'bind']
4618
b, relpath = Branch.open_containing(u'.')
4620
raise errors.BzrCommandError('Local branch is not bound')
4623
class cmd_uncommit(Command):
4624
"""Remove the last committed revision.
4626
--verbose will print out what is being removed.
4627
--dry-run will go through all the motions, but not actually
4630
If --revision is specified, uncommit revisions to leave the branch at the
4631
specified revision. For example, "bzr uncommit -r 15" will leave the
4632
branch at revision 15.
4634
Uncommit leaves the working tree ready for a new commit. The only change
4635
it may make is to restore any pending merges that were present before
4639
# TODO: jam 20060108 Add an option to allow uncommit to remove
4640
# unreferenced information in 'branch-as-repository' branches.
4641
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4642
# information in shared branches as well.
4643
_see_also = ['commit']
4644
takes_options = ['verbose', 'revision',
4645
Option('dry-run', help='Don\'t actually make changes.'),
4646
Option('force', help='Say yes to all questions.'),
4648
help="Only remove the commits from the local branch"
4649
" when in a checkout."
4652
takes_args = ['location?']
4654
encoding_type = 'replace'
4656
def run(self, location=None,
4657
dry_run=False, verbose=False,
4658
revision=None, force=False, local=False):
4659
if location is None:
4661
control, relpath = bzrdir.BzrDir.open_containing(location)
4663
tree = control.open_workingtree()
4665
except (errors.NoWorkingTree, errors.NotLocalUrl):
4667
b = control.open_branch()
4669
if tree is not None:
4671
self.add_cleanup(tree.unlock)
4674
self.add_cleanup(b.unlock)
4675
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4677
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4678
from bzrlib.log import log_formatter, show_log
4679
from bzrlib.uncommit import uncommit
4681
last_revno, last_rev_id = b.last_revision_info()
4684
if revision is None:
4686
rev_id = last_rev_id
4688
# 'bzr uncommit -r 10' actually means uncommit
4689
# so that the final tree is at revno 10.
4690
# but bzrlib.uncommit.uncommit() actually uncommits
4691
# the revisions that are supplied.
4692
# So we need to offset it by one
4693
revno = revision[0].in_history(b).revno + 1
4694
if revno <= last_revno:
4695
rev_id = b.get_rev_id(revno)
4697
if rev_id is None or _mod_revision.is_null(rev_id):
4698
self.outf.write('No revisions to uncommit.\n')
4701
lf = log_formatter('short',
4703
show_timezone='original')
4708
direction='forward',
4709
start_revision=revno,
4710
end_revision=last_revno)
4713
print 'Dry-run, pretending to remove the above revisions.'
4715
val = raw_input('Press <enter> to continue')
4717
print 'The above revision(s) will be removed.'
4719
val = raw_input('Are you sure [y/N]? ')
4720
if val.lower() not in ('y', 'yes'):
4724
mutter('Uncommitting from {%s} to {%s}',
4725
last_rev_id, rev_id)
4726
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4727
revno=revno, local=local)
4728
note('You can restore the old tip by running:\n'
4729
' bzr pull . -r revid:%s', last_rev_id)
4732
class cmd_break_lock(Command):
4733
"""Break a dead lock on a repository, branch or working directory.
4735
CAUTION: Locks should only be broken when you are sure that the process
4736
holding the lock has been stopped.
4738
You can get information on what locks are open via the 'bzr info' command.
4743
takes_args = ['location?']
4745
def run(self, location=None, show=False):
4746
if location is None:
4748
control, relpath = bzrdir.BzrDir.open_containing(location)
4750
control.break_lock()
4751
except NotImplementedError:
4755
class cmd_wait_until_signalled(Command):
4756
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4758
This just prints a line to signal when it is ready, then blocks on stdin.
4764
sys.stdout.write("running\n")
4766
sys.stdin.readline()
4769
class cmd_serve(Command):
4770
"""Run the bzr server."""
4772
aliases = ['server']
4776
help='Serve on stdin/out for use from inetd or sshd.'),
4777
RegistryOption('protocol',
4778
help="Protocol to serve.",
4779
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4780
value_switches=True),
4782
help='Listen for connections on nominated port of the form '
4783
'[hostname:]portnumber. Passing 0 as the port number will '
4784
'result in a dynamically allocated port. The default port '
4785
'depends on the protocol.',
4788
help='Serve contents of this directory.',
4790
Option('allow-writes',
4791
help='By default the server is a readonly server. Supplying '
4792
'--allow-writes enables write access to the contents of '
4793
'the served directory and below. Note that ``bzr serve`` '
4794
'does not perform authentication, so unless some form of '
4795
'external authentication is arranged supplying this '
4796
'option leads to global uncontrolled write access to your '
4801
def get_host_and_port(self, port):
4802
"""Return the host and port to run the smart server on.
4804
If 'port' is None, None will be returned for the host and port.
4806
If 'port' has a colon in it, the string before the colon will be
4807
interpreted as the host.
4809
:param port: A string of the port to run the server on.
4810
:return: A tuple of (host, port), where 'host' is a host name or IP,
4811
and port is an integer TCP/IP port.
4814
if port is not None:
4816
host, port = port.split(':')
4820
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4822
from bzrlib.transport import get_transport, transport_server_registry
4823
if directory is None:
4824
directory = os.getcwd()
4825
if protocol is None:
4826
protocol = transport_server_registry.get()
4827
host, port = self.get_host_and_port(port)
4828
url = urlutils.local_path_to_url(directory)
4829
if not allow_writes:
4830
url = 'readonly+' + url
4831
transport = get_transport(url)
4832
protocol(transport, host, port, inet)
4835
class cmd_join(Command):
4836
"""Combine a tree into its containing tree.
4838
This command requires the target tree to be in a rich-root format.
4840
The TREE argument should be an independent tree, inside another tree, but
4841
not part of it. (Such trees can be produced by "bzr split", but also by
4842
running "bzr branch" with the target inside a tree.)
4844
The result is a combined tree, with the subtree no longer an independant
4845
part. This is marked as a merge of the subtree into the containing tree,
4846
and all history is preserved.
4849
_see_also = ['split']
4850
takes_args = ['tree']
4852
Option('reference', help='Join by reference.', hidden=True),
4855
def run(self, tree, reference=False):
4856
sub_tree = WorkingTree.open(tree)
4857
parent_dir = osutils.dirname(sub_tree.basedir)
4858
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4859
repo = containing_tree.branch.repository
4860
if not repo.supports_rich_root():
4861
raise errors.BzrCommandError(
4862
"Can't join trees because %s doesn't support rich root data.\n"
4863
"You can use bzr upgrade on the repository."
4867
containing_tree.add_reference(sub_tree)
4868
except errors.BadReferenceTarget, e:
4869
# XXX: Would be better to just raise a nicely printable
4870
# exception from the real origin. Also below. mbp 20070306
4871
raise errors.BzrCommandError("Cannot join %s. %s" %
4875
containing_tree.subsume(sub_tree)
4876
except errors.BadSubsumeSource, e:
4877
raise errors.BzrCommandError("Cannot join %s. %s" %
4881
class cmd_split(Command):
4882
"""Split a subdirectory of a tree into a separate tree.
4884
This command will produce a target tree in a format that supports
4885
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4886
converted into earlier formats like 'dirstate-tags'.
4888
The TREE argument should be a subdirectory of a working tree. That
4889
subdirectory will be converted into an independent tree, with its own
4890
branch. Commits in the top-level tree will not apply to the new subtree.
4893
_see_also = ['join']
4894
takes_args = ['tree']
4896
def run(self, tree):
4897
containing_tree, subdir = WorkingTree.open_containing(tree)
4898
sub_id = containing_tree.path2id(subdir)
4900
raise errors.NotVersionedError(subdir)
4902
containing_tree.extract(sub_id)
4903
except errors.RootNotRich:
4904
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4907
class cmd_merge_directive(Command):
4908
"""Generate a merge directive for auto-merge tools.
4910
A directive requests a merge to be performed, and also provides all the
4911
information necessary to do so. This means it must either include a
4912
revision bundle, or the location of a branch containing the desired
4915
A submit branch (the location to merge into) must be supplied the first
4916
time the command is issued. After it has been supplied once, it will
4917
be remembered as the default.
4919
A public branch is optional if a revision bundle is supplied, but required
4920
if --diff or --plain is specified. It will be remembered as the default
4921
after the first use.
4924
takes_args = ['submit_branch?', 'public_branch?']
4928
_see_also = ['send']
4931
RegistryOption.from_kwargs('patch-type',
4932
'The type of patch to include in the directive.',
4934
value_switches=True,
4936
bundle='Bazaar revision bundle (default).',
4937
diff='Normal unified diff.',
4938
plain='No patch, just directive.'),
4939
Option('sign', help='GPG-sign the directive.'), 'revision',
4940
Option('mail-to', type=str,
4941
help='Instead of printing the directive, email to this address.'),
4942
Option('message', type=str, short_name='m',
4943
help='Message to use when committing this merge.')
4946
encoding_type = 'exact'
4948
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4949
sign=False, revision=None, mail_to=None, message=None):
4950
from bzrlib.revision import ensure_null, NULL_REVISION
4951
include_patch, include_bundle = {
4952
'plain': (False, False),
4953
'diff': (True, False),
4954
'bundle': (True, True),
4956
branch = Branch.open('.')
4957
stored_submit_branch = branch.get_submit_branch()
4958
if submit_branch is None:
4959
submit_branch = stored_submit_branch
4961
if stored_submit_branch is None:
4962
branch.set_submit_branch(submit_branch)
4963
if submit_branch is None:
4964
submit_branch = branch.get_parent()
4965
if submit_branch is None:
4966
raise errors.BzrCommandError('No submit branch specified or known')
4968
stored_public_branch = branch.get_public_branch()
4969
if public_branch is None:
4970
public_branch = stored_public_branch
4971
elif stored_public_branch is None:
4972
branch.set_public_branch(public_branch)
4973
if not include_bundle and public_branch is None:
4974
raise errors.BzrCommandError('No public branch specified or'
4976
base_revision_id = None
4977
if revision is not None:
4978
if len(revision) > 2:
4979
raise errors.BzrCommandError('bzr merge-directive takes '
4980
'at most two one revision identifiers')
4981
revision_id = revision[-1].as_revision_id(branch)
4982
if len(revision) == 2:
4983
base_revision_id = revision[0].as_revision_id(branch)
4985
revision_id = branch.last_revision()
4986
revision_id = ensure_null(revision_id)
4987
if revision_id == NULL_REVISION:
4988
raise errors.BzrCommandError('No revisions to bundle.')
4989
directive = merge_directive.MergeDirective2.from_objects(
4990
branch.repository, revision_id, time.time(),
4991
osutils.local_time_offset(), submit_branch,
4992
public_branch=public_branch, include_patch=include_patch,
4993
include_bundle=include_bundle, message=message,
4994
base_revision_id=base_revision_id)
4997
self.outf.write(directive.to_signed(branch))
4999
self.outf.writelines(directive.to_lines())
5001
message = directive.to_email(mail_to, branch, sign)
5002
s = SMTPConnection(branch.get_config())
5003
s.send_email(message)
5006
class cmd_send(Command):
5007
"""Mail or create a merge-directive for submitting changes.
5009
A merge directive provides many things needed for requesting merges:
5011
* A machine-readable description of the merge to perform
5013
* An optional patch that is a preview of the changes requested
5015
* An optional bundle of revision data, so that the changes can be applied
5016
directly from the merge directive, without retrieving data from a
5019
If --no-bundle is specified, then public_branch is needed (and must be
5020
up-to-date), so that the receiver can perform the merge using the
5021
public_branch. The public_branch is always included if known, so that
5022
people can check it later.
5024
The submit branch defaults to the parent, but can be overridden. Both
5025
submit branch and public branch will be remembered if supplied.
5027
If a public_branch is known for the submit_branch, that public submit
5028
branch is used in the merge instructions. This means that a local mirror
5029
can be used as your actual submit branch, once you have set public_branch
5032
Mail is sent using your preferred mail program. This should be transparent
5033
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5034
If the preferred client can't be found (or used), your editor will be used.
5036
To use a specific mail program, set the mail_client configuration option.
5037
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5038
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5039
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5040
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5043
If mail is being sent, a to address is required. This can be supplied
5044
either on the commandline, by setting the submit_to configuration
5045
option in the branch itself or the child_submit_to configuration option
5046
in the submit branch.
5048
Two formats are currently supported: "4" uses revision bundle format 4 and
5049
merge directive format 2. It is significantly faster and smaller than
5050
older formats. It is compatible with Bazaar 0.19 and later. It is the
5051
default. "0.9" uses revision bundle format 0.9 and merge directive
5052
format 1. It is compatible with Bazaar 0.12 - 0.18.
5054
The merge directives created by bzr send may be applied using bzr merge or
5055
bzr pull by specifying a file containing a merge directive as the location.
5058
encoding_type = 'exact'
5060
_see_also = ['merge', 'pull']
5062
takes_args = ['submit_branch?', 'public_branch?']
5066
help='Do not include a bundle in the merge directive.'),
5067
Option('no-patch', help='Do not include a preview patch in the merge'
5070
help='Remember submit and public branch.'),
5072
help='Branch to generate the submission from, '
5073
'rather than the one containing the working directory.',
5076
Option('output', short_name='o',
5077
help='Write merge directive to this file; '
5078
'use - for stdout.',
5081
help='Refuse to send if there are uncommitted changes in'
5082
' the working tree, --no-strict disables the check.'),
5083
Option('mail-to', help='Mail the request to this address.',
5087
Option('body', help='Body for the email.', type=unicode),
5088
RegistryOption('format',
5089
help='Use the specified output format.',
5090
lazy_registry=('bzrlib.send', 'format_registry')),
5093
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5094
no_patch=False, revision=None, remember=False, output=None,
5095
format=None, mail_to=None, message=None, body=None,
5096
strict=None, **kwargs):
5097
from bzrlib.send import send
5098
return send(submit_branch, revision, public_branch, remember,
5099
format, no_bundle, no_patch, output,
5100
kwargs.get('from', '.'), mail_to, message, body,
5105
class cmd_bundle_revisions(cmd_send):
5106
"""Create a merge-directive for submitting changes.
5108
A merge directive provides many things needed for requesting merges:
5110
* A machine-readable description of the merge to perform
5112
* An optional patch that is a preview of the changes requested
5114
* An optional bundle of revision data, so that the changes can be applied
5115
directly from the merge directive, without retrieving data from a
5118
If --no-bundle is specified, then public_branch is needed (and must be
5119
up-to-date), so that the receiver can perform the merge using the
5120
public_branch. The public_branch is always included if known, so that
5121
people can check it later.
5123
The submit branch defaults to the parent, but can be overridden. Both
5124
submit branch and public branch will be remembered if supplied.
5126
If a public_branch is known for the submit_branch, that public submit
5127
branch is used in the merge instructions. This means that a local mirror
5128
can be used as your actual submit branch, once you have set public_branch
5131
Two formats are currently supported: "4" uses revision bundle format 4 and
5132
merge directive format 2. It is significantly faster and smaller than
5133
older formats. It is compatible with Bazaar 0.19 and later. It is the
5134
default. "0.9" uses revision bundle format 0.9 and merge directive
5135
format 1. It is compatible with Bazaar 0.12 - 0.18.
5140
help='Do not include a bundle in the merge directive.'),
5141
Option('no-patch', help='Do not include a preview patch in the merge'
5144
help='Remember submit and public branch.'),
5146
help='Branch to generate the submission from, '
5147
'rather than the one containing the working directory.',
5150
Option('output', short_name='o', help='Write directive to this file.',
5153
help='Refuse to bundle revisions if there are uncommitted'
5154
' changes in the working tree, --no-strict disables the check.'),
5156
RegistryOption('format',
5157
help='Use the specified output format.',
5158
lazy_registry=('bzrlib.send', 'format_registry')),
5160
aliases = ['bundle']
5162
_see_also = ['send', 'merge']
5166
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5167
no_patch=False, revision=None, remember=False, output=None,
5168
format=None, strict=None, **kwargs):
5171
from bzrlib.send import send
5172
return send(submit_branch, revision, public_branch, remember,
5173
format, no_bundle, no_patch, output,
5174
kwargs.get('from', '.'), None, None, None,
5175
self.outf, strict=strict)
5178
class cmd_tag(Command):
5179
"""Create, remove or modify a tag naming a revision.
5181
Tags give human-meaningful names to revisions. Commands that take a -r
5182
(--revision) option can be given -rtag:X, where X is any previously
5185
Tags are stored in the branch. Tags are copied from one branch to another
5186
along when you branch, push, pull or merge.
5188
It is an error to give a tag name that already exists unless you pass
5189
--force, in which case the tag is moved to point to the new revision.
5191
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5192
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5195
_see_also = ['commit', 'tags']
5196
takes_args = ['tag_name']
5199
help='Delete this tag rather than placing it.',
5202
help='Branch in which to place the tag.',
5207
help='Replace existing tags.',
5212
def run(self, tag_name,
5218
branch, relpath = Branch.open_containing(directory)
5220
self.add_cleanup(branch.unlock)
5222
branch.tags.delete_tag(tag_name)
5223
self.outf.write('Deleted tag %s.\n' % tag_name)
5226
if len(revision) != 1:
5227
raise errors.BzrCommandError(
5228
"Tags can only be placed on a single revision, "
5230
revision_id = revision[0].as_revision_id(branch)
5232
revision_id = branch.last_revision()
5233
if (not force) and branch.tags.has_tag(tag_name):
5234
raise errors.TagAlreadyExists(tag_name)
5235
branch.tags.set_tag(tag_name, revision_id)
5236
self.outf.write('Created tag %s.\n' % tag_name)
5239
class cmd_tags(Command):
5242
This command shows a table of tag names and the revisions they reference.
5248
help='Branch whose tags should be displayed.',
5252
RegistryOption.from_kwargs('sort',
5253
'Sort tags by different criteria.', title='Sorting',
5254
alpha='Sort tags lexicographically (default).',
5255
time='Sort tags chronologically.',
5268
branch, relpath = Branch.open_containing(directory)
5270
tags = branch.tags.get_tag_dict().items()
5275
self.add_cleanup(branch.unlock)
5277
graph = branch.repository.get_graph()
5278
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5279
revid1, revid2 = rev1.rev_id, rev2.rev_id
5280
# only show revisions between revid1 and revid2 (inclusive)
5281
tags = [(tag, revid) for tag, revid in tags if
5282
graph.is_between(revid, revid1, revid2)]
5285
elif sort == 'time':
5287
for tag, revid in tags:
5289
revobj = branch.repository.get_revision(revid)
5290
except errors.NoSuchRevision:
5291
timestamp = sys.maxint # place them at the end
5293
timestamp = revobj.timestamp
5294
timestamps[revid] = timestamp
5295
tags.sort(key=lambda x: timestamps[x[1]])
5297
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5298
for index, (tag, revid) in enumerate(tags):
5300
revno = branch.revision_id_to_dotted_revno(revid)
5301
if isinstance(revno, tuple):
5302
revno = '.'.join(map(str, revno))
5303
except errors.NoSuchRevision:
5304
# Bad tag data/merges can lead to tagged revisions
5305
# which are not in this branch. Fail gracefully ...
5307
tags[index] = (tag, revno)
5309
for tag, revspec in tags:
5310
self.outf.write('%-20s %s\n' % (tag, revspec))
5313
class cmd_reconfigure(Command):
5314
"""Reconfigure the type of a bzr directory.
5316
A target configuration must be specified.
5318
For checkouts, the bind-to location will be auto-detected if not specified.
5319
The order of preference is
5320
1. For a lightweight checkout, the current bound location.
5321
2. For branches that used to be checkouts, the previously-bound location.
5322
3. The push location.
5323
4. The parent location.
5324
If none of these is available, --bind-to must be specified.
5327
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5328
takes_args = ['location?']
5330
RegistryOption.from_kwargs(
5332
title='Target type',
5333
help='The type to reconfigure the directory to.',
5334
value_switches=True, enum_switch=False,
5335
branch='Reconfigure to be an unbound branch with no working tree.',
5336
tree='Reconfigure to be an unbound branch with a working tree.',
5337
checkout='Reconfigure to be a bound branch with a working tree.',
5338
lightweight_checkout='Reconfigure to be a lightweight'
5339
' checkout (with no local history).',
5340
standalone='Reconfigure to be a standalone branch '
5341
'(i.e. stop using shared repository).',
5342
use_shared='Reconfigure to use a shared repository.',
5343
with_trees='Reconfigure repository to create '
5344
'working trees on branches by default.',
5345
with_no_trees='Reconfigure repository to not create '
5346
'working trees on branches by default.'
5348
Option('bind-to', help='Branch to bind checkout to.', type=str),
5350
help='Perform reconfiguration even if local changes'
5352
Option('stacked-on',
5353
help='Reconfigure a branch to be stacked on another branch.',
5357
help='Reconfigure a branch to be unstacked. This '
5358
'may require copying substantial data into it.',
5362
def run(self, location=None, target_type=None, bind_to=None, force=False,
5365
directory = bzrdir.BzrDir.open(location)
5366
if stacked_on and unstacked:
5367
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5368
elif stacked_on is not None:
5369
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5371
reconfigure.ReconfigureUnstacked().apply(directory)
5372
# At the moment you can use --stacked-on and a different
5373
# reconfiguration shape at the same time; there seems no good reason
5375
if target_type is None:
5376
if stacked_on or unstacked:
5379
raise errors.BzrCommandError('No target configuration '
5381
elif target_type == 'branch':
5382
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5383
elif target_type == 'tree':
5384
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5385
elif target_type == 'checkout':
5386
reconfiguration = reconfigure.Reconfigure.to_checkout(
5388
elif target_type == 'lightweight-checkout':
5389
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5391
elif target_type == 'use-shared':
5392
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5393
elif target_type == 'standalone':
5394
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5395
elif target_type == 'with-trees':
5396
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5398
elif target_type == 'with-no-trees':
5399
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5401
reconfiguration.apply(force)
5404
class cmd_switch(Command):
5405
"""Set the branch of a checkout and update.
5407
For lightweight checkouts, this changes the branch being referenced.
5408
For heavyweight checkouts, this checks that there are no local commits
5409
versus the current bound branch, then it makes the local branch a mirror
5410
of the new location and binds to it.
5412
In both cases, the working tree is updated and uncommitted changes
5413
are merged. The user can commit or revert these as they desire.
5415
Pending merges need to be committed or reverted before using switch.
5417
The path to the branch to switch to can be specified relative to the parent
5418
directory of the current branch. For example, if you are currently in a
5419
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5422
Bound branches use the nickname of its master branch unless it is set
5423
locally, in which case switching will update the local nickname to be
5427
takes_args = ['to_location']
5428
takes_options = [Option('force',
5429
help='Switch even if local commits will be lost.'),
5430
Option('create-branch', short_name='b',
5431
help='Create the target branch from this one before'
5432
' switching to it.'),
5435
def run(self, to_location, force=False, create_branch=False):
5436
from bzrlib import switch
5438
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5440
branch = control_dir.open_branch()
5441
had_explicit_nick = branch.get_config().has_explicit_nickname()
5442
except errors.NotBranchError:
5444
had_explicit_nick = False
5447
raise errors.BzrCommandError('cannot create branch without'
5449
to_location = directory_service.directories.dereference(
5451
if '/' not in to_location and '\\' not in to_location:
5452
# This path is meant to be relative to the existing branch
5453
this_url = self._get_branch_location(control_dir)
5454
to_location = urlutils.join(this_url, '..', to_location)
5455
to_branch = branch.bzrdir.sprout(to_location,
5456
possible_transports=[branch.bzrdir.root_transport],
5457
source_branch=branch).open_branch()
5459
# from_branch = control_dir.open_branch()
5460
# except errors.NotBranchError:
5461
# raise BzrCommandError('Cannot create a branch from this'
5462
# ' location when we cannot open this branch')
5463
# from_branch.bzrdir.sprout(
5467
to_branch = Branch.open(to_location)
5468
except errors.NotBranchError:
5469
this_url = self._get_branch_location(control_dir)
5470
to_branch = Branch.open(
5471
urlutils.join(this_url, '..', to_location))
5472
switch.switch(control_dir, to_branch, force)
5473
if had_explicit_nick:
5474
branch = control_dir.open_branch() #get the new branch!
5475
branch.nick = to_branch.nick
5476
note('Switched to branch: %s',
5477
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5479
def _get_branch_location(self, control_dir):
5480
"""Return location of branch for this control dir."""
5482
this_branch = control_dir.open_branch()
5483
# This may be a heavy checkout, where we want the master branch
5484
master_location = this_branch.get_bound_location()
5485
if master_location is not None:
5486
return master_location
5487
# If not, use a local sibling
5488
return this_branch.base
5489
except errors.NotBranchError:
5490
format = control_dir.find_branch_format()
5491
if getattr(format, 'get_reference', None) is not None:
5492
return format.get_reference(control_dir)
5494
return control_dir.root_transport.base
5497
class cmd_view(Command):
5498
"""Manage filtered views.
5500
Views provide a mask over the tree so that users can focus on
5501
a subset of a tree when doing their work. After creating a view,
5502
commands that support a list of files - status, diff, commit, etc -
5503
effectively have that list of files implicitly given each time.
5504
An explicit list of files can still be given but those files
5505
must be within the current view.
5507
In most cases, a view has a short life-span: it is created to make
5508
a selected change and is deleted once that change is committed.
5509
At other times, you may wish to create one or more named views
5510
and switch between them.
5512
To disable the current view without deleting it, you can switch to
5513
the pseudo view called ``off``. This can be useful when you need
5514
to see the whole tree for an operation or two (e.g. merge) but
5515
want to switch back to your view after that.
5518
To define the current view::
5520
bzr view file1 dir1 ...
5522
To list the current view::
5526
To delete the current view::
5530
To disable the current view without deleting it::
5532
bzr view --switch off
5534
To define a named view and switch to it::
5536
bzr view --name view-name file1 dir1 ...
5538
To list a named view::
5540
bzr view --name view-name
5542
To delete a named view::
5544
bzr view --name view-name --delete
5546
To switch to a named view::
5548
bzr view --switch view-name
5550
To list all views defined::
5554
To delete all views::
5556
bzr view --delete --all
5560
takes_args = ['file*']
5563
help='Apply list or delete action to all views.',
5566
help='Delete the view.',
5569
help='Name of the view to define, list or delete.',
5573
help='Name of the view to switch to.',
5578
def run(self, file_list,
5584
tree, file_list = tree_files(file_list, apply_view=False)
5585
current_view, view_dict = tree.views.get_view_info()
5590
raise errors.BzrCommandError(
5591
"Both --delete and a file list specified")
5593
raise errors.BzrCommandError(
5594
"Both --delete and --switch specified")
5596
tree.views.set_view_info(None, {})
5597
self.outf.write("Deleted all views.\n")
5599
raise errors.BzrCommandError("No current view to delete")
5601
tree.views.delete_view(name)
5602
self.outf.write("Deleted '%s' view.\n" % name)
5605
raise errors.BzrCommandError(
5606
"Both --switch and a file list specified")
5608
raise errors.BzrCommandError(
5609
"Both --switch and --all specified")
5610
elif switch == 'off':
5611
if current_view is None:
5612
raise errors.BzrCommandError("No current view to disable")
5613
tree.views.set_view_info(None, view_dict)
5614
self.outf.write("Disabled '%s' view.\n" % (current_view))
5616
tree.views.set_view_info(switch, view_dict)
5617
view_str = views.view_display_str(tree.views.lookup_view())
5618
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5621
self.outf.write('Views defined:\n')
5622
for view in sorted(view_dict):
5623
if view == current_view:
5627
view_str = views.view_display_str(view_dict[view])
5628
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5630
self.outf.write('No views defined.\n')
5633
# No name given and no current view set
5636
raise errors.BzrCommandError(
5637
"Cannot change the 'off' pseudo view")
5638
tree.views.set_view(name, sorted(file_list))
5639
view_str = views.view_display_str(tree.views.lookup_view())
5640
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5644
# No name given and no current view set
5645
self.outf.write('No current view.\n')
5647
view_str = views.view_display_str(tree.views.lookup_view(name))
5648
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5651
class cmd_hooks(Command):
5657
for hook_key in sorted(hooks.known_hooks.keys()):
5658
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5659
self.outf.write("%s:\n" % type(some_hooks).__name__)
5660
for hook_name, hook_point in sorted(some_hooks.items()):
5661
self.outf.write(" %s:\n" % (hook_name,))
5662
found_hooks = list(hook_point)
5664
for hook in found_hooks:
5665
self.outf.write(" %s\n" %
5666
(some_hooks.get_hook_name(hook),))
5668
self.outf.write(" <no hooks installed>\n")
5671
class cmd_shelve(Command):
5672
"""Temporarily set aside some changes from the current tree.
5674
Shelve allows you to temporarily put changes you've made "on the shelf",
5675
ie. out of the way, until a later time when you can bring them back from
5676
the shelf with the 'unshelve' command. The changes are stored alongside
5677
your working tree, and so they aren't propagated along with your branch nor
5678
will they survive its deletion.
5680
If shelve --list is specified, previously-shelved changes are listed.
5682
Shelve is intended to help separate several sets of changes that have
5683
been inappropriately mingled. If you just want to get rid of all changes
5684
and you don't need to restore them later, use revert. If you want to
5685
shelve all text changes at once, use shelve --all.
5687
If filenames are specified, only the changes to those files will be
5688
shelved. Other files will be left untouched.
5690
If a revision is specified, changes since that revision will be shelved.
5692
You can put multiple items on the shelf, and by default, 'unshelve' will
5693
restore the most recently shelved changes.
5696
takes_args = ['file*']
5700
Option('all', help='Shelve all changes.'),
5702
RegistryOption('writer', 'Method to use for writing diffs.',
5703
bzrlib.option.diff_writer_registry,
5704
value_switches=True, enum_switch=False),
5706
Option('list', help='List shelved changes.'),
5708
help='Destroy removed changes instead of shelving them.'),
5710
_see_also = ['unshelve']
5712
def run(self, revision=None, all=False, file_list=None, message=None,
5713
writer=None, list=False, destroy=False):
5715
return self.run_for_list()
5716
from bzrlib.shelf_ui import Shelver
5718
writer = bzrlib.option.diff_writer_registry.get()
5720
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5721
file_list, message, destroy=destroy)
5726
except errors.UserAbort:
5729
def run_for_list(self):
5730
tree = WorkingTree.open_containing('.')[0]
5732
self.add_cleanup(tree.unlock)
5733
manager = tree.get_shelf_manager()
5734
shelves = manager.active_shelves()
5735
if len(shelves) == 0:
5736
note('No shelved changes.')
5738
for shelf_id in reversed(shelves):
5739
message = manager.get_metadata(shelf_id).get('message')
5741
message = '<no message>'
5742
self.outf.write('%3d: %s\n' % (shelf_id, message))
5746
class cmd_unshelve(Command):
5747
"""Restore shelved changes.
5749
By default, the most recently shelved changes are restored. However if you
5750
specify a shelf by id those changes will be restored instead. This works
5751
best when the changes don't depend on each other.
5754
takes_args = ['shelf_id?']
5756
RegistryOption.from_kwargs(
5757
'action', help="The action to perform.",
5758
enum_switch=False, value_switches=True,
5759
apply="Apply changes and remove from the shelf.",
5760
dry_run="Show changes, but do not apply or remove them.",
5761
delete_only="Delete changes without applying them.",
5762
keep="Apply changes but don't delete them.",
5765
_see_also = ['shelve']
5767
def run(self, shelf_id=None, action='apply'):
5768
from bzrlib.shelf_ui import Unshelver
5769
unshelver = Unshelver.from_args(shelf_id, action)
5773
unshelver.tree.unlock()
5776
class cmd_clean_tree(Command):
5777
"""Remove unwanted files from working tree.
5779
By default, only unknown files, not ignored files, are deleted. Versioned
5780
files are never deleted.
5782
Another class is 'detritus', which includes files emitted by bzr during
5783
normal operations and selftests. (The value of these files decreases with
5786
If no options are specified, unknown files are deleted. Otherwise, option
5787
flags are respected, and may be combined.
5789
To check what clean-tree will do, use --dry-run.
5791
takes_options = [Option('ignored', help='Delete all ignored files.'),
5792
Option('detritus', help='Delete conflict files, merge'
5793
' backups, and failed selftest dirs.'),
5795
help='Delete files unknown to bzr (default).'),
5796
Option('dry-run', help='Show files to delete instead of'
5798
Option('force', help='Do not prompt before deleting.')]
5799
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5801
from bzrlib.clean_tree import clean_tree
5802
if not (unknown or ignored or detritus):
5806
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5807
dry_run=dry_run, no_prompt=force)
5810
class cmd_reference(Command):
5811
"""list, view and set branch locations for nested trees.
5813
If no arguments are provided, lists the branch locations for nested trees.
5814
If one argument is provided, display the branch location for that tree.
5815
If two arguments are provided, set the branch location for that tree.
5820
takes_args = ['path?', 'location?']
5822
def run(self, path=None, location=None):
5824
if path is not None:
5826
tree, branch, relpath =(
5827
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5828
if path is not None:
5831
tree = branch.basis_tree()
5833
info = branch._get_all_reference_info().iteritems()
5834
self._display_reference_info(tree, branch, info)
5836
file_id = tree.path2id(path)
5838
raise errors.NotVersionedError(path)
5839
if location is None:
5840
info = [(file_id, branch.get_reference_info(file_id))]
5841
self._display_reference_info(tree, branch, info)
5843
branch.set_reference_info(file_id, path, location)
5845
def _display_reference_info(self, tree, branch, info):
5847
for file_id, (path, location) in info:
5849
path = tree.id2path(file_id)
5850
except errors.NoSuchId:
5852
ref_list.append((path, location))
5853
for path, location in sorted(ref_list):
5854
self.outf.write('%s %s\n' % (path, location))
5857
# these get imported and then picked up by the scan for cmd_*
5858
# TODO: Some more consistent way to split command definitions across files;
5859
# we do need to load at least some information about them to know of
5860
# aliases. ideally we would avoid loading the implementation until the
5861
# details were needed.
5862
from bzrlib.cmd_version_info import cmd_version_info
5863
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5864
from bzrlib.bundle.commands import (
5867
from bzrlib.foreign import cmd_dpush
5868
from bzrlib.sign_my_commits import cmd_sign_my_commits
5869
from bzrlib.weave_commands import cmd_versionedfile_list, \
5870
cmd_weave_plan_merge, cmd_weave_merge_text