1
# Copyright (C) 2005-2010 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.transport import memory
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
from bzrlib.smtp_connection import SMTPConnection
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import (
65
builtin_command_registry,
68
from bzrlib.option import (
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
81
return internal_tree_files(file_list, default_branch, canonicalize,
83
except errors.FileInWrongBranch, e:
84
raise errors.BzrCommandError("%s is not in the same branch as %s" %
85
(e.path, file_list[0]))
88
def tree_files_for_add(file_list):
90
Return a tree and list of absolute paths from a file list.
92
Similar to tree_files, but add handles files a bit differently, so it a
93
custom implementation. In particular, MutableTreeTree.smart_add expects
94
absolute paths, which it immediately converts to relative paths.
96
# FIXME Would be nice to just return the relative paths like
97
# internal_tree_files does, but there are a large number of unit tests
98
# that assume the current interface to mutabletree.smart_add
100
tree, relpath = WorkingTree.open_containing(file_list[0])
101
if tree.supports_views():
102
view_files = tree.views.lookup_view()
104
for filename in file_list:
105
if not osutils.is_inside_any(view_files, filename):
106
raise errors.FileOutsideView(filename, view_files)
107
file_list = file_list[:]
108
file_list[0] = tree.abspath(relpath)
110
tree = WorkingTree.open_containing(u'.')[0]
111
if tree.supports_views():
112
view_files = tree.views.lookup_view()
114
file_list = view_files
115
view_str = views.view_display_str(view_files)
116
note("Ignoring files outside view. View is %s" % view_str)
117
return tree, file_list
120
def _get_one_revision(command_name, revisions):
121
if revisions is None:
123
if len(revisions) != 1:
124
raise errors.BzrCommandError(
125
'bzr %s --revision takes exactly one revision identifier' % (
130
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
131
"""Get a revision tree. Not suitable for commands that change the tree.
133
Specifically, the basis tree in dirstate trees is coupled to the dirstate
134
and doing a commit/uncommit/pull will at best fail due to changing the
137
If tree is passed in, it should be already locked, for lifetime management
138
of the trees internal cached state.
142
if revisions is None:
144
rev_tree = tree.basis_tree()
146
rev_tree = branch.basis_tree()
148
revision = _get_one_revision(command_name, revisions)
149
rev_tree = revision.as_tree(branch)
153
# XXX: Bad function name; should possibly also be a class method of
154
# WorkingTree rather than a function.
155
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
157
"""Convert command-line paths to a WorkingTree and relative paths.
159
This is typically used for command-line processors that take one or
160
more filenames, and infer the workingtree that contains them.
162
The filenames given are not required to exist.
164
:param file_list: Filenames to convert.
166
:param default_branch: Fallback tree path to use if file_list is empty or
169
:param apply_view: if True and a view is set, apply it or check that
170
specified files are within it
172
:return: workingtree, [relative_paths]
174
if file_list is None or len(file_list) == 0:
175
tree = WorkingTree.open_containing(default_branch)[0]
176
if tree.supports_views() and apply_view:
177
view_files = tree.views.lookup_view()
179
file_list = view_files
180
view_str = views.view_display_str(view_files)
181
note("Ignoring files outside view. View is %s" % view_str)
182
return tree, file_list
183
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
return tree, safe_relpath_files(tree, file_list, canonicalize,
185
apply_view=apply_view)
188
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
189
"""Convert file_list into a list of relpaths in tree.
191
:param tree: A tree to operate on.
192
:param file_list: A list of user provided paths or None.
193
:param apply_view: if True and a view is set, apply it or check that
194
specified files are within it
195
:return: A list of relative paths.
196
:raises errors.PathNotChild: When a provided path is in a different tree
199
if file_list is None:
201
if tree.supports_views() and apply_view:
202
view_files = tree.views.lookup_view()
206
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
207
# doesn't - fix that up here before we enter the loop.
209
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
212
for filename in file_list:
214
relpath = fixer(osutils.dereference_path(filename))
215
if view_files and not osutils.is_inside_any(view_files, relpath):
216
raise errors.FileOutsideView(filename, view_files)
217
new_list.append(relpath)
218
except errors.PathNotChild:
219
raise errors.FileInWrongBranch(tree.branch, filename)
223
def _get_view_info_for_change_reporter(tree):
224
"""Get the view information from a tree for change reporting."""
227
current_view = tree.views.get_view_info()[0]
228
if current_view is not None:
229
view_info = (current_view, tree.views.lookup_view())
230
except errors.ViewsNotSupported:
235
# TODO: Make sure no commands unconditionally use the working directory as a
236
# branch. If a filename argument is used, the first of them should be used to
237
# specify the branch. (Perhaps this can be factored out into some kind of
238
# Argument class, representing a file in a branch, where the first occurrence
241
class cmd_status(Command):
242
__doc__ = """Display status summary.
244
This reports on versioned and unknown files, reporting them
245
grouped by state. Possible states are:
248
Versioned in the working copy but not in the previous revision.
251
Versioned in the previous revision but removed or deleted
255
Path of this file changed from the previous revision;
256
the text may also have changed. This includes files whose
257
parent directory was renamed.
260
Text has changed since the previous revision.
263
File kind has been changed (e.g. from file to directory).
266
Not versioned and not matching an ignore pattern.
268
Additionally for directories, symlinks and files with an executable
269
bit, Bazaar indicates their type using a trailing character: '/', '@'
272
To see ignored files use 'bzr ignored'. For details on the
273
changes to file texts, use 'bzr diff'.
275
Note that --short or -S gives status flags for each item, similar
276
to Subversion's status command. To get output similar to svn -q,
279
If no arguments are specified, the status of the entire working
280
directory is shown. Otherwise, only the status of the specified
281
files or directories is reported. If a directory is given, status
282
is reported for everything inside that directory.
284
Before merges are committed, the pending merge tip revisions are
285
shown. To see all pending merge revisions, use the -v option.
286
To skip the display of pending merge information altogether, use
287
the no-pending option or specify a file/directory.
289
If a revision argument is given, the status is calculated against
290
that revision, or between two revisions if two are provided.
293
# TODO: --no-recurse, --recurse options
295
takes_args = ['file*']
296
takes_options = ['show-ids', 'revision', 'change', 'verbose',
297
Option('short', help='Use short status indicators.',
299
Option('versioned', help='Only show versioned files.',
301
Option('no-pending', help='Don\'t show pending merges.',
304
aliases = ['st', 'stat']
306
encoding_type = 'replace'
307
_see_also = ['diff', 'revert', 'status-flags']
310
def run(self, show_ids=False, file_list=None, revision=None, short=False,
311
versioned=False, no_pending=False, verbose=False):
312
from bzrlib.status import show_tree_status
314
if revision and len(revision) > 2:
315
raise errors.BzrCommandError('bzr status --revision takes exactly'
316
' one or two revision specifiers')
318
tree, relfile_list = tree_files(file_list)
319
# Avoid asking for specific files when that is not needed.
320
if relfile_list == ['']:
322
# Don't disable pending merges for full trees other than '.'.
323
if file_list == ['.']:
325
# A specific path within a tree was given.
326
elif relfile_list is not None:
328
show_tree_status(tree, show_ids=show_ids,
329
specific_files=relfile_list, revision=revision,
330
to_file=self.outf, short=short, versioned=versioned,
331
show_pending=(not no_pending), verbose=verbose)
334
class cmd_cat_revision(Command):
335
__doc__ = """Write out metadata for a revision.
337
The revision to print can either be specified by a specific
338
revision identifier, or you can use --revision.
342
takes_args = ['revision_id?']
343
takes_options = ['revision']
344
# cat-revision is more for frontends so should be exact
347
def print_revision(self, revisions, revid):
348
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
349
record = stream.next()
350
if record.storage_kind == 'absent':
351
raise errors.NoSuchRevision(revisions, revid)
352
revtext = record.get_bytes_as('fulltext')
353
self.outf.write(revtext.decode('utf-8'))
356
def run(self, revision_id=None, revision=None):
357
if revision_id is not None and revision is not None:
358
raise errors.BzrCommandError('You can only supply one of'
359
' revision_id or --revision')
360
if revision_id is None and revision is None:
361
raise errors.BzrCommandError('You must supply either'
362
' --revision or a revision_id')
363
b = WorkingTree.open_containing(u'.')[0].branch
365
revisions = b.repository.revisions
366
if revisions is None:
367
raise errors.BzrCommandError('Repository %r does not support '
368
'access to raw revision texts')
370
b.repository.lock_read()
372
# TODO: jam 20060112 should cat-revision always output utf-8?
373
if revision_id is not None:
374
revision_id = osutils.safe_revision_id(revision_id, warn=False)
376
self.print_revision(revisions, revision_id)
377
except errors.NoSuchRevision:
378
msg = "The repository %s contains no revision %s." % (
379
b.repository.base, revision_id)
380
raise errors.BzrCommandError(msg)
381
elif revision is not None:
384
raise errors.BzrCommandError(
385
'You cannot specify a NULL revision.')
386
rev_id = rev.as_revision_id(b)
387
self.print_revision(revisions, rev_id)
389
b.repository.unlock()
392
class cmd_dump_btree(Command):
393
__doc__ = """Dump the contents of a btree index file to stdout.
395
PATH is a btree index file, it can be any URL. This includes things like
396
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
398
By default, the tuples stored in the index file will be displayed. With
399
--raw, we will uncompress the pages, but otherwise display the raw bytes
403
# TODO: Do we want to dump the internal nodes as well?
404
# TODO: It would be nice to be able to dump the un-parsed information,
405
# rather than only going through iter_all_entries. However, this is
406
# good enough for a start
408
encoding_type = 'exact'
409
takes_args = ['path']
410
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
411
' rather than the parsed tuples.'),
414
def run(self, path, raw=False):
415
dirname, basename = osutils.split(path)
416
t = transport.get_transport(dirname)
418
self._dump_raw_bytes(t, basename)
420
self._dump_entries(t, basename)
422
def _get_index_and_bytes(self, trans, basename):
423
"""Create a BTreeGraphIndex and raw bytes."""
424
bt = btree_index.BTreeGraphIndex(trans, basename, None)
425
bytes = trans.get_bytes(basename)
426
bt._file = cStringIO.StringIO(bytes)
427
bt._size = len(bytes)
430
def _dump_raw_bytes(self, trans, basename):
433
# We need to parse at least the root node.
434
# This is because the first page of every row starts with an
435
# uncompressed header.
436
bt, bytes = self._get_index_and_bytes(trans, basename)
437
for page_idx, page_start in enumerate(xrange(0, len(bytes),
438
btree_index._PAGE_SIZE)):
439
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
440
page_bytes = bytes[page_start:page_end]
442
self.outf.write('Root node:\n')
443
header_end, data = bt._parse_header_from_bytes(page_bytes)
444
self.outf.write(page_bytes[:header_end])
446
self.outf.write('\nPage %d\n' % (page_idx,))
447
decomp_bytes = zlib.decompress(page_bytes)
448
self.outf.write(decomp_bytes)
449
self.outf.write('\n')
451
def _dump_entries(self, trans, basename):
453
st = trans.stat(basename)
454
except errors.TransportNotPossible:
455
# We can't stat, so we'll fake it because we have to do the 'get()'
457
bt, _ = self._get_index_and_bytes(trans, basename)
459
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
460
for node in bt.iter_all_entries():
461
# Node is made up of:
462
# (index, key, value, [references])
466
refs_as_tuples = None
468
refs_as_tuples = static_tuple.as_tuples(refs)
469
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
self.outf.write('%s\n' % (as_tuple,))
473
class cmd_remove_tree(Command):
474
__doc__ = """Remove the working tree from a given branch/checkout.
476
Since a lightweight checkout is little more than a working tree
477
this will refuse to run against one.
479
To re-create the working tree, use "bzr checkout".
481
_see_also = ['checkout', 'working-trees']
482
takes_args = ['location*']
485
help='Remove the working tree even if it has '
486
'uncommitted changes.'),
489
def run(self, location_list, force=False):
490
if not location_list:
493
for location in location_list:
494
d = bzrdir.BzrDir.open(location)
497
working = d.open_workingtree()
498
except errors.NoWorkingTree:
499
raise errors.BzrCommandError("No working tree to remove")
500
except errors.NotLocalUrl:
501
raise errors.BzrCommandError("You cannot remove the working tree"
504
if (working.has_changes()):
505
raise errors.UncommittedChanges(working)
507
if working.user_url != working.branch.user_url:
508
raise errors.BzrCommandError("You cannot remove the working tree"
509
" from a lightweight checkout")
511
d.destroy_workingtree()
514
class cmd_revno(Command):
515
__doc__ = """Show current revision number.
517
This is equal to the number of revisions on this branch.
521
takes_args = ['location?']
523
Option('tree', help='Show revno of working tree'),
527
def run(self, tree=False, location=u'.'):
530
wt = WorkingTree.open_containing(location)[0]
532
except (errors.NoWorkingTree, errors.NotLocalUrl):
533
raise errors.NoWorkingTree(location)
534
self.add_cleanup(wt.unlock)
535
revid = wt.last_revision()
537
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
538
except errors.NoSuchRevision:
540
revno = ".".join(str(n) for n in revno_t)
542
b = Branch.open_containing(location)[0]
544
self.add_cleanup(b.unlock)
547
self.outf.write(str(revno) + '\n')
550
class cmd_revision_info(Command):
551
__doc__ = """Show revision number and revision id for a given revision identifier.
554
takes_args = ['revision_info*']
558
help='Branch to examine, '
559
'rather than the one containing the working directory.',
563
Option('tree', help='Show revno of working tree'),
567
def run(self, revision=None, directory=u'.', tree=False,
568
revision_info_list=[]):
571
wt = WorkingTree.open_containing(directory)[0]
574
self.add_cleanup(wt.unlock)
575
except (errors.NoWorkingTree, errors.NotLocalUrl):
577
b = Branch.open_containing(directory)[0]
579
self.add_cleanup(b.unlock)
581
if revision is not None:
582
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
583
if revision_info_list is not None:
584
for rev_str in revision_info_list:
585
rev_spec = RevisionSpec.from_string(rev_str)
586
revision_ids.append(rev_spec.as_revision_id(b))
587
# No arguments supplied, default to the last revision
588
if len(revision_ids) == 0:
591
raise errors.NoWorkingTree(directory)
592
revision_ids.append(wt.last_revision())
594
revision_ids.append(b.last_revision())
598
for revision_id in revision_ids:
600
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
601
revno = '.'.join(str(i) for i in dotted_revno)
602
except errors.NoSuchRevision:
604
maxlen = max(maxlen, len(revno))
605
revinfos.append([revno, revision_id])
609
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
612
class cmd_add(Command):
613
__doc__ = """Add specified files or directories.
615
In non-recursive mode, all the named items are added, regardless
616
of whether they were previously ignored. A warning is given if
617
any of the named files are already versioned.
619
In recursive mode (the default), files are treated the same way
620
but the behaviour for directories is different. Directories that
621
are already versioned do not give a warning. All directories,
622
whether already versioned or not, are searched for files or
623
subdirectories that are neither versioned or ignored, and these
624
are added. This search proceeds recursively into versioned
625
directories. If no names are given '.' is assumed.
627
Therefore simply saying 'bzr add' will version all files that
628
are currently unknown.
630
Adding a file whose parent directory is not versioned will
631
implicitly add the parent, and so on up to the root. This means
632
you should never need to explicitly add a directory, they'll just
633
get added when you add a file in the directory.
635
--dry-run will show which files would be added, but not actually
638
--file-ids-from will try to use the file ids from the supplied path.
639
It looks up ids trying to find a matching parent directory with the
640
same filename, and then by pure path. This option is rarely needed
641
but can be useful when adding the same logical file into two
642
branches that will be merged later (without showing the two different
643
adds as a conflict). It is also useful when merging another project
644
into a subdirectory of this one.
646
Any files matching patterns in the ignore list will not be added
647
unless they are explicitly mentioned.
649
takes_args = ['file*']
652
help="Don't recursively add the contents of directories."),
654
help="Show what would be done, but don't actually do anything."),
656
Option('file-ids-from',
658
help='Lookup file ids from this tree.'),
660
encoding_type = 'replace'
661
_see_also = ['remove', 'ignore']
663
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
668
if file_ids_from is not None:
670
base_tree, base_path = WorkingTree.open_containing(
672
except errors.NoWorkingTree:
673
base_branch, base_path = Branch.open_containing(
675
base_tree = base_branch.basis_tree()
677
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
678
to_file=self.outf, should_print=(not is_quiet()))
680
action = bzrlib.add.AddAction(to_file=self.outf,
681
should_print=(not is_quiet()))
684
base_tree.lock_read()
685
self.add_cleanup(base_tree.unlock)
686
tree, file_list = tree_files_for_add(file_list)
687
added, ignored = tree.smart_add(file_list, not
688
no_recurse, action=action, save=not dry_run)
692
for glob in sorted(ignored.keys()):
693
for path in ignored[glob]:
694
self.outf.write("ignored %s matching \"%s\"\n"
698
class cmd_mkdir(Command):
699
__doc__ = """Create a new versioned directory.
701
This is equivalent to creating the directory and then adding it.
704
takes_args = ['dir+']
705
encoding_type = 'replace'
707
def run(self, dir_list):
709
wt, dd = WorkingTree.open_containing(d)
710
base = os.path.dirname(dd)
711
id = wt.path2id(base)
715
self.outf.write('added %s\n' % d)
717
raise errors.NotVersionedError(path=base)
720
class cmd_relpath(Command):
721
__doc__ = """Show path of a file relative to root"""
723
takes_args = ['filename']
727
def run(self, filename):
728
# TODO: jam 20050106 Can relpath return a munged path if
729
# sys.stdout encoding cannot represent it?
730
tree, relpath = WorkingTree.open_containing(filename)
731
self.outf.write(relpath)
732
self.outf.write('\n')
735
class cmd_inventory(Command):
736
__doc__ = """Show inventory of the current working copy or a revision.
738
It is possible to limit the output to a particular entry
739
type using the --kind option. For example: --kind file.
741
It is also possible to restrict the list of files to a specific
742
set. For example: bzr inventory --show-ids this/file
751
help='List entries of a particular kind: file, directory, symlink.',
754
takes_args = ['file*']
757
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
758
if kind and kind not in ['file', 'directory', 'symlink']:
759
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
761
revision = _get_one_revision('inventory', revision)
762
work_tree, file_list = tree_files(file_list)
763
work_tree.lock_read()
764
self.add_cleanup(work_tree.unlock)
765
if revision is not None:
766
tree = revision.as_tree(work_tree.branch)
768
extra_trees = [work_tree]
770
self.add_cleanup(tree.unlock)
775
if file_list is not None:
776
file_ids = tree.paths2ids(file_list, trees=extra_trees,
777
require_versioned=True)
778
# find_ids_across_trees may include some paths that don't
780
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
781
for file_id in file_ids if file_id in tree)
783
entries = tree.inventory.entries()
786
for path, entry in entries:
787
if kind and kind != entry.kind:
790
self.outf.write('%-50s %s\n' % (path, entry.file_id))
792
self.outf.write(path)
793
self.outf.write('\n')
796
class cmd_mv(Command):
797
__doc__ = """Move or rename a file.
800
bzr mv OLDNAME NEWNAME
802
bzr mv SOURCE... DESTINATION
804
If the last argument is a versioned directory, all the other names
805
are moved into it. Otherwise, there must be exactly two arguments
806
and the file is changed to a new name.
808
If OLDNAME does not exist on the filesystem but is versioned and
809
NEWNAME does exist on the filesystem but is not versioned, mv
810
assumes that the file has been manually moved and only updates
811
its internal inventory to reflect that change.
812
The same is valid when moving many SOURCE files to a DESTINATION.
814
Files cannot be moved between branches.
817
takes_args = ['names*']
818
takes_options = [Option("after", help="Move only the bzr identifier"
819
" of the file, because the file has already been moved."),
820
Option('auto', help='Automatically guess renames.'),
821
Option('dry-run', help='Avoid making changes when guessing renames.'),
823
aliases = ['move', 'rename']
824
encoding_type = 'replace'
826
def run(self, names_list, after=False, auto=False, dry_run=False):
828
return self.run_auto(names_list, after, dry_run)
830
raise errors.BzrCommandError('--dry-run requires --auto.')
831
if names_list is None:
833
if len(names_list) < 2:
834
raise errors.BzrCommandError("missing file argument")
835
tree, rel_names = tree_files(names_list, canonicalize=False)
836
tree.lock_tree_write()
837
self.add_cleanup(tree.unlock)
838
self._run(tree, names_list, rel_names, after)
840
def run_auto(self, names_list, after, dry_run):
841
if names_list is not None and len(names_list) > 1:
842
raise errors.BzrCommandError('Only one path may be specified to'
845
raise errors.BzrCommandError('--after cannot be specified with'
847
work_tree, file_list = tree_files(names_list, default_branch='.')
848
work_tree.lock_tree_write()
849
self.add_cleanup(work_tree.unlock)
850
rename_map.RenameMap.guess_renames(work_tree, dry_run)
852
def _run(self, tree, names_list, rel_names, after):
853
into_existing = osutils.isdir(names_list[-1])
854
if into_existing and len(names_list) == 2:
856
# a. case-insensitive filesystem and change case of dir
857
# b. move directory after the fact (if the source used to be
858
# a directory, but now doesn't exist in the working tree
859
# and the target is an existing directory, just rename it)
860
if (not tree.case_sensitive
861
and rel_names[0].lower() == rel_names[1].lower()):
862
into_existing = False
865
# 'fix' the case of a potential 'from'
866
from_id = tree.path2id(
867
tree.get_canonical_inventory_path(rel_names[0]))
868
if (not osutils.lexists(names_list[0]) and
869
from_id and inv.get_file_kind(from_id) == "directory"):
870
into_existing = False
873
# move into existing directory
874
# All entries reference existing inventory items, so fix them up
875
# for cicp file-systems.
876
rel_names = tree.get_canonical_inventory_paths(rel_names)
877
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
879
self.outf.write("%s => %s\n" % (src, dest))
881
if len(names_list) != 2:
882
raise errors.BzrCommandError('to mv multiple files the'
883
' destination must be a versioned'
886
# for cicp file-systems: the src references an existing inventory
888
src = tree.get_canonical_inventory_path(rel_names[0])
889
# Find the canonical version of the destination: In all cases, the
890
# parent of the target must be in the inventory, so we fetch the
891
# canonical version from there (we do not always *use* the
892
# canonicalized tail portion - we may be attempting to rename the
894
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
895
dest_parent = osutils.dirname(canon_dest)
896
spec_tail = osutils.basename(rel_names[1])
897
# For a CICP file-system, we need to avoid creating 2 inventory
898
# entries that differ only by case. So regardless of the case
899
# we *want* to use (ie, specified by the user or the file-system),
900
# we must always choose to use the case of any existing inventory
901
# items. The only exception to this is when we are attempting a
902
# case-only rename (ie, canonical versions of src and dest are
904
dest_id = tree.path2id(canon_dest)
905
if dest_id is None or tree.path2id(src) == dest_id:
906
# No existing item we care about, so work out what case we
907
# are actually going to use.
909
# If 'after' is specified, the tail must refer to a file on disk.
911
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
913
# pathjoin with an empty tail adds a slash, which breaks
915
dest_parent_fq = tree.basedir
917
dest_tail = osutils.canonical_relpath(
919
osutils.pathjoin(dest_parent_fq, spec_tail))
921
# not 'after', so case as specified is used
922
dest_tail = spec_tail
924
# Use the existing item so 'mv' fails with AlreadyVersioned.
925
dest_tail = os.path.basename(canon_dest)
926
dest = osutils.pathjoin(dest_parent, dest_tail)
927
mutter("attempting to move %s => %s", src, dest)
928
tree.rename_one(src, dest, after=after)
930
self.outf.write("%s => %s\n" % (src, dest))
933
class cmd_pull(Command):
934
__doc__ = """Turn this branch into a mirror of another branch.
936
By default, this command only works on branches that have not diverged.
937
Branches are considered diverged if the destination branch's most recent
938
commit is one that has not been merged (directly or indirectly) into the
941
If branches have diverged, you can use 'bzr merge' to integrate the changes
942
from one into the other. Once one branch has merged, the other should
943
be able to pull it again.
945
If you want to replace your local changes and just want your branch to
946
match the remote one, use pull --overwrite. This will work even if the two
947
branches have diverged.
949
If there is no default location set, the first pull will set it. After
950
that, you can omit the location to use the default. To change the
951
default, use --remember. The value will only be saved if the remote
952
location can be accessed.
954
Note: The location can be specified either in the form of a branch,
955
or in the form of a path to a file containing a merge directive generated
959
_see_also = ['push', 'update', 'status-flags', 'send']
960
takes_options = ['remember', 'overwrite', 'revision',
961
custom_help('verbose',
962
help='Show logs of pulled revisions.'),
964
help='Branch to pull into, '
965
'rather than the one containing the working directory.',
970
help="Perform a local pull in a bound "
971
"branch. Local pulls are not applied to "
975
takes_args = ['location?']
976
encoding_type = 'replace'
978
def run(self, location=None, remember=False, overwrite=False,
979
revision=None, verbose=False,
980
directory=None, local=False):
981
# FIXME: too much stuff is in the command class
984
if directory is None:
987
tree_to = WorkingTree.open_containing(directory)[0]
988
branch_to = tree_to.branch
990
self.add_cleanup(tree_to.unlock)
991
except errors.NoWorkingTree:
993
branch_to = Branch.open_containing(directory)[0]
994
branch_to.lock_write()
995
self.add_cleanup(branch_to.unlock)
997
if local and not branch_to.get_bound_location():
998
raise errors.LocalRequiresBoundBranch()
1000
possible_transports = []
1001
if location is not None:
1003
mergeable = bundle.read_mergeable_from_url(location,
1004
possible_transports=possible_transports)
1005
except errors.NotABundle:
1008
stored_loc = branch_to.get_parent()
1009
if location is None:
1010
if stored_loc is None:
1011
raise errors.BzrCommandError("No pull location known or"
1014
display_url = urlutils.unescape_for_display(stored_loc,
1017
self.outf.write("Using saved parent location: %s\n" % display_url)
1018
location = stored_loc
1020
revision = _get_one_revision('pull', revision)
1021
if mergeable is not None:
1022
if revision is not None:
1023
raise errors.BzrCommandError(
1024
'Cannot use -r with merge directives or bundles')
1025
mergeable.install_revisions(branch_to.repository)
1026
base_revision_id, revision_id, verified = \
1027
mergeable.get_merge_request(branch_to.repository)
1028
branch_from = branch_to
1030
branch_from = Branch.open(location,
1031
possible_transports=possible_transports)
1032
branch_from.lock_read()
1033
self.add_cleanup(branch_from.unlock)
1035
if branch_to.get_parent() is None or remember:
1036
branch_to.set_parent(branch_from.base)
1038
if revision is not None:
1039
revision_id = revision.as_revision_id(branch_from)
1041
if tree_to is not None:
1042
view_info = _get_view_info_for_change_reporter(tree_to)
1043
change_reporter = delta._ChangeReporter(
1044
unversioned_filter=tree_to.is_ignored,
1045
view_info=view_info)
1046
result = tree_to.pull(
1047
branch_from, overwrite, revision_id, change_reporter,
1048
possible_transports=possible_transports, local=local)
1050
result = branch_to.pull(
1051
branch_from, overwrite, revision_id, local=local)
1053
result.report(self.outf)
1054
if verbose and result.old_revid != result.new_revid:
1055
log.show_branch_change(
1056
branch_to, self.outf, result.old_revno,
1060
class cmd_push(Command):
1061
__doc__ = """Update a mirror of this branch.
1063
The target branch will not have its working tree populated because this
1064
is both expensive, and is not supported on remote file systems.
1066
Some smart servers or protocols *may* put the working tree in place in
1069
This command only works on branches that have not diverged. Branches are
1070
considered diverged if the destination branch's most recent commit is one
1071
that has not been merged (directly or indirectly) by the source branch.
1073
If branches have diverged, you can use 'bzr push --overwrite' to replace
1074
the other branch completely, discarding its unmerged changes.
1076
If you want to ensure you have the different changes in the other branch,
1077
do a merge (see bzr help merge) from the other branch, and commit that.
1078
After that you will be able to do a push without '--overwrite'.
1080
If there is no default push location set, the first push will set it.
1081
After that, you can omit the location to use the default. To change the
1082
default, use --remember. The value will only be saved if the remote
1083
location can be accessed.
1086
_see_also = ['pull', 'update', 'working-trees']
1087
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1088
Option('create-prefix',
1089
help='Create the path leading up to the branch '
1090
'if it does not already exist.'),
1092
help='Branch to push from, '
1093
'rather than the one containing the working directory.',
1097
Option('use-existing-dir',
1098
help='By default push will fail if the target'
1099
' directory exists, but does not already'
1100
' have a control directory. This flag will'
1101
' allow push to proceed.'),
1103
help='Create a stacked branch that references the public location '
1104
'of the parent branch.'),
1105
Option('stacked-on',
1106
help='Create a stacked branch that refers to another branch '
1107
'for the commit history. Only the work not present in the '
1108
'referenced branch is included in the branch created.',
1111
help='Refuse to push if there are uncommitted changes in'
1112
' the working tree, --no-strict disables the check.'),
1114
takes_args = ['location?']
1115
encoding_type = 'replace'
1117
def run(self, location=None, remember=False, overwrite=False,
1118
create_prefix=False, verbose=False, revision=None,
1119
use_existing_dir=False, directory=None, stacked_on=None,
1120
stacked=False, strict=None):
1121
from bzrlib.push import _show_push_branch
1123
if directory is None:
1125
# Get the source branch
1127
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1128
# Get the tip's revision_id
1129
revision = _get_one_revision('push', revision)
1130
if revision is not None:
1131
revision_id = revision.in_history(br_from).rev_id
1134
if tree is not None and revision_id is None:
1135
tree.warn_if_changed_or_out_of_date(
1136
strict, 'push_strict', 'Use --no-strict to force the push.')
1137
# Get the stacked_on branch, if any
1138
if stacked_on is not None:
1139
stacked_on = urlutils.normalize_url(stacked_on)
1141
parent_url = br_from.get_parent()
1143
parent = Branch.open(parent_url)
1144
stacked_on = parent.get_public_branch()
1146
# I considered excluding non-http url's here, thus forcing
1147
# 'public' branches only, but that only works for some
1148
# users, so it's best to just depend on the user spotting an
1149
# error by the feedback given to them. RBC 20080227.
1150
stacked_on = parent_url
1152
raise errors.BzrCommandError(
1153
"Could not determine branch to refer to.")
1155
# Get the destination location
1156
if location is None:
1157
stored_loc = br_from.get_push_location()
1158
if stored_loc is None:
1159
raise errors.BzrCommandError(
1160
"No push location known or specified.")
1162
display_url = urlutils.unescape_for_display(stored_loc,
1164
self.outf.write("Using saved push location: %s\n" % display_url)
1165
location = stored_loc
1167
_show_push_branch(br_from, revision_id, location, self.outf,
1168
verbose=verbose, overwrite=overwrite, remember=remember,
1169
stacked_on=stacked_on, create_prefix=create_prefix,
1170
use_existing_dir=use_existing_dir)
1173
class cmd_branch(Command):
1174
__doc__ = """Create a new branch that is a copy of an existing branch.
1176
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1177
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1178
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1179
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1180
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1183
To retrieve the branch as of a particular revision, supply the --revision
1184
parameter, as in "branch foo/bar -r 5".
1187
_see_also = ['checkout']
1188
takes_args = ['from_location', 'to_location?']
1189
takes_options = ['revision', Option('hardlink',
1190
help='Hard-link working tree files where possible.'),
1192
help="Create a branch without a working-tree."),
1194
help="Switch the checkout in the current directory "
1195
"to the new branch."),
1197
help='Create a stacked branch referring to the source branch. '
1198
'The new branch will depend on the availability of the source '
1199
'branch for all operations.'),
1200
Option('standalone',
1201
help='Do not use a shared repository, even if available.'),
1202
Option('use-existing-dir',
1203
help='By default branch will fail if the target'
1204
' directory exists, but does not already'
1205
' have a control directory. This flag will'
1206
' allow branch to proceed.'),
1208
help="Bind new branch to from location."),
1210
aliases = ['get', 'clone']
1212
def run(self, from_location, to_location=None, revision=None,
1213
hardlink=False, stacked=False, standalone=False, no_tree=False,
1214
use_existing_dir=False, switch=False, bind=False):
1215
from bzrlib import switch as _mod_switch
1216
from bzrlib.tag import _merge_tags_if_possible
1217
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1219
revision = _get_one_revision('branch', revision)
1221
self.add_cleanup(br_from.unlock)
1222
if revision is not None:
1223
revision_id = revision.as_revision_id(br_from)
1225
# FIXME - wt.last_revision, fallback to branch, fall back to
1226
# None or perhaps NULL_REVISION to mean copy nothing
1228
revision_id = br_from.last_revision()
1229
if to_location is None:
1230
to_location = urlutils.derive_to_location(from_location)
1231
to_transport = transport.get_transport(to_location)
1233
to_transport.mkdir('.')
1234
except errors.FileExists:
1235
if not use_existing_dir:
1236
raise errors.BzrCommandError('Target directory "%s" '
1237
'already exists.' % to_location)
1240
bzrdir.BzrDir.open_from_transport(to_transport)
1241
except errors.NotBranchError:
1244
raise errors.AlreadyBranchError(to_location)
1245
except errors.NoSuchFile:
1246
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1249
# preserve whatever source format we have.
1250
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1251
possible_transports=[to_transport],
1252
accelerator_tree=accelerator_tree,
1253
hardlink=hardlink, stacked=stacked,
1254
force_new_repo=standalone,
1255
create_tree_if_local=not no_tree,
1256
source_branch=br_from)
1257
branch = dir.open_branch()
1258
except errors.NoSuchRevision:
1259
to_transport.delete_tree('.')
1260
msg = "The branch %s has no revision %s." % (from_location,
1262
raise errors.BzrCommandError(msg)
1263
_merge_tags_if_possible(br_from, branch)
1264
# If the source branch is stacked, the new branch may
1265
# be stacked whether we asked for that explicitly or not.
1266
# We therefore need a try/except here and not just 'if stacked:'
1268
note('Created new stacked branch referring to %s.' %
1269
branch.get_stacked_on_url())
1270
except (errors.NotStacked, errors.UnstackableBranchFormat,
1271
errors.UnstackableRepositoryFormat), e:
1272
note('Branched %d revision(s).' % branch.revno())
1274
# Bind to the parent
1275
parent_branch = Branch.open(from_location)
1276
branch.bind(parent_branch)
1277
note('New branch bound to %s' % from_location)
1279
# Switch to the new branch
1280
wt, _ = WorkingTree.open_containing('.')
1281
_mod_switch.switch(wt.bzrdir, branch)
1282
note('Switched to branch: %s',
1283
urlutils.unescape_for_display(branch.base, 'utf-8'))
1286
class cmd_checkout(Command):
1287
__doc__ = """Create a new checkout of an existing branch.
1289
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1290
the branch found in '.'. This is useful if you have removed the working tree
1291
or if it was never created - i.e. if you pushed the branch to its current
1292
location using SFTP.
1294
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1295
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1296
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1297
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1298
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1301
To retrieve the branch as of a particular revision, supply the --revision
1302
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1303
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1307
_see_also = ['checkouts', 'branch']
1308
takes_args = ['branch_location?', 'to_location?']
1309
takes_options = ['revision',
1310
Option('lightweight',
1311
help="Perform a lightweight checkout. Lightweight "
1312
"checkouts depend on access to the branch for "
1313
"every operation. Normal checkouts can perform "
1314
"common operations like diff and status without "
1315
"such access, and also support local commits."
1317
Option('files-from', type=str,
1318
help="Get file contents from this tree."),
1320
help='Hard-link working tree files where possible.'
1325
def run(self, branch_location=None, to_location=None, revision=None,
1326
lightweight=False, files_from=None, hardlink=False):
1327
if branch_location is None:
1328
branch_location = osutils.getcwd()
1329
to_location = branch_location
1330
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1332
revision = _get_one_revision('checkout', revision)
1333
if files_from is not None:
1334
accelerator_tree = WorkingTree.open(files_from)
1335
if revision is not None:
1336
revision_id = revision.as_revision_id(source)
1339
if to_location is None:
1340
to_location = urlutils.derive_to_location(branch_location)
1341
# if the source and to_location are the same,
1342
# and there is no working tree,
1343
# then reconstitute a branch
1344
if (osutils.abspath(to_location) ==
1345
osutils.abspath(branch_location)):
1347
source.bzrdir.open_workingtree()
1348
except errors.NoWorkingTree:
1349
source.bzrdir.create_workingtree(revision_id)
1351
source.create_checkout(to_location, revision_id, lightweight,
1352
accelerator_tree, hardlink)
1355
class cmd_renames(Command):
1356
__doc__ = """Show list of renamed files.
1358
# TODO: Option to show renames between two historical versions.
1360
# TODO: Only show renames under dir, rather than in the whole branch.
1361
_see_also = ['status']
1362
takes_args = ['dir?']
1365
def run(self, dir=u'.'):
1366
tree = WorkingTree.open_containing(dir)[0]
1368
self.add_cleanup(tree.unlock)
1369
new_inv = tree.inventory
1370
old_tree = tree.basis_tree()
1371
old_tree.lock_read()
1372
self.add_cleanup(old_tree.unlock)
1373
old_inv = old_tree.inventory
1375
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1376
for f, paths, c, v, p, n, k, e in iterator:
1377
if paths[0] == paths[1]:
1381
renames.append(paths)
1383
for old_name, new_name in renames:
1384
self.outf.write("%s => %s\n" % (old_name, new_name))
1387
class cmd_update(Command):
1388
__doc__ = """Update a tree to have the latest code committed to its branch.
1390
This will perform a merge into the working tree, and may generate
1391
conflicts. If you have any local changes, you will still
1392
need to commit them after the update for the update to be complete.
1394
If you want to discard your local changes, you can just do a
1395
'bzr revert' instead of 'bzr commit' after the update.
1397
If the tree's branch is bound to a master branch, it will also update
1398
the branch from the master.
1401
_see_also = ['pull', 'working-trees', 'status-flags']
1402
takes_args = ['dir?']
1403
takes_options = ['revision']
1406
def run(self, dir='.', revision=None):
1407
if revision is not None and len(revision) != 1:
1408
raise errors.BzrCommandError(
1409
"bzr update --revision takes exactly one revision")
1410
tree = WorkingTree.open_containing(dir)[0]
1411
branch = tree.branch
1412
possible_transports = []
1413
master = branch.get_master_branch(
1414
possible_transports=possible_transports)
1415
if master is not None:
1417
branch_location = master.base
1419
tree.lock_tree_write()
1420
branch_location = tree.branch.base
1421
self.add_cleanup(tree.unlock)
1422
# get rid of the final '/' and be ready for display
1423
branch_location = urlutils.unescape_for_display(
1424
branch_location.rstrip('/'),
1426
existing_pending_merges = tree.get_parent_ids()[1:]
1430
# may need to fetch data into a heavyweight checkout
1431
# XXX: this may take some time, maybe we should display a
1433
old_tip = branch.update(possible_transports)
1434
if revision is not None:
1435
revision_id = revision[0].as_revision_id(branch)
1437
revision_id = branch.last_revision()
1438
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1439
revno = branch.revision_id_to_dotted_revno(revision_id)
1440
note("Tree is up to date at revision %s of branch %s" %
1441
('.'.join(map(str, revno)), branch_location))
1443
view_info = _get_view_info_for_change_reporter(tree)
1444
change_reporter = delta._ChangeReporter(
1445
unversioned_filter=tree.is_ignored,
1446
view_info=view_info)
1448
conflicts = tree.update(
1450
possible_transports=possible_transports,
1451
revision=revision_id,
1453
except errors.NoSuchRevision, e:
1454
raise errors.BzrCommandError(
1455
"branch has no revision %s\n"
1456
"bzr update --revision only works"
1457
" for a revision in the branch history"
1459
revno = tree.branch.revision_id_to_dotted_revno(
1460
_mod_revision.ensure_null(tree.last_revision()))
1461
note('Updated to revision %s of branch %s' %
1462
('.'.join(map(str, revno)), branch_location))
1463
parent_ids = tree.get_parent_ids()
1464
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1465
note('Your local commits will now show as pending merges with '
1466
"'bzr status', and can be committed with 'bzr commit'.")
1473
class cmd_info(Command):
1474
__doc__ = """Show information about a working tree, branch or repository.
1476
This command will show all known locations and formats associated to the
1477
tree, branch or repository.
1479
In verbose mode, statistical information is included with each report.
1480
To see extended statistic information, use a verbosity level of 2 or
1481
higher by specifying the verbose option multiple times, e.g. -vv.
1483
Branches and working trees will also report any missing revisions.
1487
Display information on the format and related locations:
1491
Display the above together with extended format information and
1492
basic statistics (like the number of files in the working tree and
1493
number of revisions in the branch and repository):
1497
Display the above together with number of committers to the branch:
1501
_see_also = ['revno', 'working-trees', 'repositories']
1502
takes_args = ['location?']
1503
takes_options = ['verbose']
1504
encoding_type = 'replace'
1507
def run(self, location=None, verbose=False):
1509
noise_level = get_verbosity_level()
1512
from bzrlib.info import show_bzrdir_info
1513
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1514
verbose=noise_level, outfile=self.outf)
1517
class cmd_remove(Command):
1518
__doc__ = """Remove files or directories.
1520
This makes bzr stop tracking changes to the specified files. bzr will delete
1521
them if they can easily be recovered using revert. If no options or
1522
parameters are given bzr will scan for files that are being tracked by bzr
1523
but missing in your tree and stop tracking them for you.
1525
takes_args = ['file*']
1526
takes_options = ['verbose',
1527
Option('new', help='Only remove files that have never been committed.'),
1528
RegistryOption.from_kwargs('file-deletion-strategy',
1529
'The file deletion mode to be used.',
1530
title='Deletion Strategy', value_switches=True, enum_switch=False,
1531
safe='Only delete files if they can be'
1532
' safely recovered (default).',
1533
keep='Delete from bzr but leave the working copy.',
1534
force='Delete all the specified files, even if they can not be '
1535
'recovered and even if they are non-empty directories.')]
1536
aliases = ['rm', 'del']
1537
encoding_type = 'replace'
1539
def run(self, file_list, verbose=False, new=False,
1540
file_deletion_strategy='safe'):
1541
tree, file_list = tree_files(file_list)
1543
if file_list is not None:
1544
file_list = [f for f in file_list]
1547
self.add_cleanup(tree.unlock)
1548
# Heuristics should probably all move into tree.remove_smart or
1551
added = tree.changes_from(tree.basis_tree(),
1552
specific_files=file_list).added
1553
file_list = sorted([f[0] for f in added], reverse=True)
1554
if len(file_list) == 0:
1555
raise errors.BzrCommandError('No matching files.')
1556
elif file_list is None:
1557
# missing files show up in iter_changes(basis) as
1558
# versioned-with-no-kind.
1560
for change in tree.iter_changes(tree.basis_tree()):
1561
# Find paths in the working tree that have no kind:
1562
if change[1][1] is not None and change[6][1] is None:
1563
missing.append(change[1][1])
1564
file_list = sorted(missing, reverse=True)
1565
file_deletion_strategy = 'keep'
1566
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1567
keep_files=file_deletion_strategy=='keep',
1568
force=file_deletion_strategy=='force')
1571
class cmd_file_id(Command):
1572
__doc__ = """Print file_id of a particular file or directory.
1574
The file_id is assigned when the file is first added and remains the
1575
same through all revisions where the file exists, even when it is
1580
_see_also = ['inventory', 'ls']
1581
takes_args = ['filename']
1584
def run(self, filename):
1585
tree, relpath = WorkingTree.open_containing(filename)
1586
i = tree.path2id(relpath)
1588
raise errors.NotVersionedError(filename)
1590
self.outf.write(i + '\n')
1593
class cmd_file_path(Command):
1594
__doc__ = """Print path of file_ids to a file or directory.
1596
This prints one line for each directory down to the target,
1597
starting at the branch root.
1601
takes_args = ['filename']
1604
def run(self, filename):
1605
tree, relpath = WorkingTree.open_containing(filename)
1606
fid = tree.path2id(relpath)
1608
raise errors.NotVersionedError(filename)
1609
segments = osutils.splitpath(relpath)
1610
for pos in range(1, len(segments) + 1):
1611
path = osutils.joinpath(segments[:pos])
1612
self.outf.write("%s\n" % tree.path2id(path))
1615
class cmd_reconcile(Command):
1616
__doc__ = """Reconcile bzr metadata in a branch.
1618
This can correct data mismatches that may have been caused by
1619
previous ghost operations or bzr upgrades. You should only
1620
need to run this command if 'bzr check' or a bzr developer
1621
advises you to run it.
1623
If a second branch is provided, cross-branch reconciliation is
1624
also attempted, which will check that data like the tree root
1625
id which was not present in very early bzr versions is represented
1626
correctly in both branches.
1628
At the same time it is run it may recompress data resulting in
1629
a potential saving in disk space or performance gain.
1631
The branch *MUST* be on a listable system such as local disk or sftp.
1634
_see_also = ['check']
1635
takes_args = ['branch?']
1637
def run(self, branch="."):
1638
from bzrlib.reconcile import reconcile
1639
dir = bzrdir.BzrDir.open(branch)
1643
class cmd_revision_history(Command):
1644
__doc__ = """Display the list of revision ids on a branch."""
1647
takes_args = ['location?']
1652
def run(self, location="."):
1653
branch = Branch.open_containing(location)[0]
1654
for revid in branch.revision_history():
1655
self.outf.write(revid)
1656
self.outf.write('\n')
1659
class cmd_ancestry(Command):
1660
__doc__ = """List all revisions merged into this branch."""
1662
_see_also = ['log', 'revision-history']
1663
takes_args = ['location?']
1668
def run(self, location="."):
1670
wt = WorkingTree.open_containing(location)[0]
1671
except errors.NoWorkingTree:
1672
b = Branch.open(location)
1673
last_revision = b.last_revision()
1676
last_revision = wt.last_revision()
1678
revision_ids = b.repository.get_ancestry(last_revision)
1680
for revision_id in revision_ids:
1681
self.outf.write(revision_id + '\n')
1684
class cmd_init(Command):
1685
__doc__ = """Make a directory into a versioned branch.
1687
Use this to create an empty branch, or before importing an
1690
If there is a repository in a parent directory of the location, then
1691
the history of the branch will be stored in the repository. Otherwise
1692
init creates a standalone branch which carries its own history
1693
in the .bzr directory.
1695
If there is already a branch at the location but it has no working tree,
1696
the tree can be populated with 'bzr checkout'.
1698
Recipe for importing a tree of files::
1704
bzr commit -m "imported project"
1707
_see_also = ['init-repository', 'branch', 'checkout']
1708
takes_args = ['location?']
1710
Option('create-prefix',
1711
help='Create the path leading up to the branch '
1712
'if it does not already exist.'),
1713
RegistryOption('format',
1714
help='Specify a format for this branch. '
1715
'See "help formats".',
1716
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1717
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1718
value_switches=True,
1719
title="Branch format",
1721
Option('append-revisions-only',
1722
help='Never change revnos or the existing log.'
1723
' Append revisions to it only.')
1725
def run(self, location=None, format=None, append_revisions_only=False,
1726
create_prefix=False):
1728
format = bzrdir.format_registry.make_bzrdir('default')
1729
if location is None:
1732
to_transport = transport.get_transport(location)
1734
# The path has to exist to initialize a
1735
# branch inside of it.
1736
# Just using os.mkdir, since I don't
1737
# believe that we want to create a bunch of
1738
# locations if the user supplies an extended path
1740
to_transport.ensure_base()
1741
except errors.NoSuchFile:
1742
if not create_prefix:
1743
raise errors.BzrCommandError("Parent directory of %s"
1745
"\nYou may supply --create-prefix to create all"
1746
" leading parent directories."
1748
to_transport.create_prefix()
1751
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1752
except errors.NotBranchError:
1753
# really a NotBzrDir error...
1754
create_branch = bzrdir.BzrDir.create_branch_convenience
1755
branch = create_branch(to_transport.base, format=format,
1756
possible_transports=[to_transport])
1757
a_bzrdir = branch.bzrdir
1759
from bzrlib.transport.local import LocalTransport
1760
if a_bzrdir.has_branch():
1761
if (isinstance(to_transport, LocalTransport)
1762
and not a_bzrdir.has_workingtree()):
1763
raise errors.BranchExistsWithoutWorkingTree(location)
1764
raise errors.AlreadyBranchError(location)
1765
branch = a_bzrdir.create_branch()
1766
a_bzrdir.create_workingtree()
1767
if append_revisions_only:
1769
branch.set_append_revisions_only(True)
1770
except errors.UpgradeRequired:
1771
raise errors.BzrCommandError('This branch format cannot be set'
1772
' to append-revisions-only. Try --default.')
1774
from bzrlib.info import describe_layout, describe_format
1776
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1777
except (errors.NoWorkingTree, errors.NotLocalUrl):
1779
repository = branch.repository
1780
layout = describe_layout(repository, branch, tree).lower()
1781
format = describe_format(a_bzrdir, repository, branch, tree)
1782
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1783
if repository.is_shared():
1784
#XXX: maybe this can be refactored into transport.path_or_url()
1785
url = repository.bzrdir.root_transport.external_url()
1787
url = urlutils.local_path_from_url(url)
1788
except errors.InvalidURL:
1790
self.outf.write("Using shared repository: %s\n" % url)
1793
class cmd_init_repository(Command):
1794
__doc__ = """Create a shared repository for branches to share storage space.
1796
New branches created under the repository directory will store their
1797
revisions in the repository, not in the branch directory. For branches
1798
with shared history, this reduces the amount of storage needed and
1799
speeds up the creation of new branches.
1801
If the --no-trees option is given then the branches in the repository
1802
will not have working trees by default. They will still exist as
1803
directories on disk, but they will not have separate copies of the
1804
files at a certain revision. This can be useful for repositories that
1805
store branches which are interacted with through checkouts or remote
1806
branches, such as on a server.
1809
Create a shared repository holding just branches::
1811
bzr init-repo --no-trees repo
1814
Make a lightweight checkout elsewhere::
1816
bzr checkout --lightweight repo/trunk trunk-checkout
1821
_see_also = ['init', 'branch', 'checkout', 'repositories']
1822
takes_args = ["location"]
1823
takes_options = [RegistryOption('format',
1824
help='Specify a format for this repository. See'
1825
' "bzr help formats" for details.',
1826
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1827
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1828
value_switches=True, title='Repository format'),
1830
help='Branches in the repository will default to'
1831
' not having a working tree.'),
1833
aliases = ["init-repo"]
1835
def run(self, location, format=None, no_trees=False):
1837
format = bzrdir.format_registry.make_bzrdir('default')
1839
if location is None:
1842
to_transport = transport.get_transport(location)
1843
to_transport.ensure_base()
1845
newdir = format.initialize_on_transport(to_transport)
1846
repo = newdir.create_repository(shared=True)
1847
repo.set_make_working_trees(not no_trees)
1849
from bzrlib.info import show_bzrdir_info
1850
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1853
class cmd_diff(Command):
1854
__doc__ = """Show differences in the working tree, between revisions or branches.
1856
If no arguments are given, all changes for the current tree are listed.
1857
If files are given, only the changes in those files are listed.
1858
Remote and multiple branches can be compared by using the --old and
1859
--new options. If not provided, the default for both is derived from
1860
the first argument, if any, or the current tree if no arguments are
1863
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1864
produces patches suitable for "patch -p1".
1868
2 - unrepresentable changes
1873
Shows the difference in the working tree versus the last commit::
1877
Difference between the working tree and revision 1::
1881
Difference between revision 3 and revision 1::
1885
Difference between revision 3 and revision 1 for branch xxx::
1889
To see the changes introduced in revision X::
1893
Note that in the case of a merge, the -c option shows the changes
1894
compared to the left hand parent. To see the changes against
1895
another parent, use::
1897
bzr diff -r<chosen_parent>..X
1899
The changes introduced by revision 2 (equivalent to -r1..2)::
1903
Show just the differences for file NEWS::
1907
Show the differences in working tree xxx for file NEWS::
1911
Show the differences from branch xxx to this working tree:
1915
Show the differences between two branches for file NEWS::
1917
bzr diff --old xxx --new yyy NEWS
1919
Same as 'bzr diff' but prefix paths with old/ and new/::
1921
bzr diff --prefix old/:new/
1923
_see_also = ['status']
1924
takes_args = ['file*']
1926
Option('diff-options', type=str,
1927
help='Pass these options to the external diff program.'),
1928
Option('prefix', type=str,
1930
help='Set prefixes added to old and new filenames, as '
1931
'two values separated by a colon. (eg "old/:new/").'),
1933
help='Branch/tree to compare from.',
1937
help='Branch/tree to compare to.',
1943
help='Use this command to compare files.',
1946
RegistryOption('format',
1947
help='Diff format to use.',
1948
lazy_registry=('bzrlib.diff', 'format_registry'),
1949
value_switches=False, title='Diff format'),
1951
aliases = ['di', 'dif']
1952
encoding_type = 'exact'
1955
def run(self, revision=None, file_list=None, diff_options=None,
1956
prefix=None, old=None, new=None, using=None, format=None):
1957
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1960
if (prefix is None) or (prefix == '0'):
1968
old_label, new_label = prefix.split(":")
1970
raise errors.BzrCommandError(
1971
'--prefix expects two values separated by a colon'
1972
' (eg "old/:new/")')
1974
if revision and len(revision) > 2:
1975
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1976
' one or two revision specifiers')
1978
if using is not None and format is not None:
1979
raise errors.BzrCommandError('--using and --format are mutually '
1982
(old_tree, new_tree,
1983
old_branch, new_branch,
1984
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1985
file_list, revision, old, new, self.add_cleanup, apply_view=True)
1986
return show_diff_trees(old_tree, new_tree, sys.stdout,
1987
specific_files=specific_files,
1988
external_diff_options=diff_options,
1989
old_label=old_label, new_label=new_label,
1990
extra_trees=extra_trees, using=using,
1994
class cmd_deleted(Command):
1995
__doc__ = """List files deleted in the working tree.
1997
# TODO: Show files deleted since a previous revision, or
1998
# between two revisions.
1999
# TODO: Much more efficient way to do this: read in new
2000
# directories with readdir, rather than stating each one. Same
2001
# level of effort but possibly much less IO. (Or possibly not,
2002
# if the directories are very large...)
2003
_see_also = ['status', 'ls']
2004
takes_options = ['show-ids']
2007
def run(self, show_ids=False):
2008
tree = WorkingTree.open_containing(u'.')[0]
2010
self.add_cleanup(tree.unlock)
2011
old = tree.basis_tree()
2013
self.add_cleanup(old.unlock)
2014
for path, ie in old.inventory.iter_entries():
2015
if not tree.has_id(ie.file_id):
2016
self.outf.write(path)
2018
self.outf.write(' ')
2019
self.outf.write(ie.file_id)
2020
self.outf.write('\n')
2023
class cmd_modified(Command):
2024
__doc__ = """List files modified in working tree.
2028
_see_also = ['status', 'ls']
2031
help='Write an ascii NUL (\\0) separator '
2032
'between files rather than a newline.')
2036
def run(self, null=False):
2037
tree = WorkingTree.open_containing(u'.')[0]
2038
td = tree.changes_from(tree.basis_tree())
2039
for path, id, kind, text_modified, meta_modified in td.modified:
2041
self.outf.write(path + '\0')
2043
self.outf.write(osutils.quotefn(path) + '\n')
2046
class cmd_added(Command):
2047
__doc__ = """List files added in working tree.
2051
_see_also = ['status', 'ls']
2054
help='Write an ascii NUL (\\0) separator '
2055
'between files rather than a newline.')
2059
def run(self, null=False):
2060
wt = WorkingTree.open_containing(u'.')[0]
2062
self.add_cleanup(wt.unlock)
2063
basis = wt.basis_tree()
2065
self.add_cleanup(basis.unlock)
2066
basis_inv = basis.inventory
2069
if file_id in basis_inv:
2071
if inv.is_root(file_id) and len(basis_inv) == 0:
2073
path = inv.id2path(file_id)
2074
if not os.access(osutils.abspath(path), os.F_OK):
2077
self.outf.write(path + '\0')
2079
self.outf.write(osutils.quotefn(path) + '\n')
2082
class cmd_root(Command):
2083
__doc__ = """Show the tree root directory.
2085
The root is the nearest enclosing directory with a .bzr control
2088
takes_args = ['filename?']
2090
def run(self, filename=None):
2091
"""Print the branch root."""
2092
tree = WorkingTree.open_containing(filename)[0]
2093
self.outf.write(tree.basedir + '\n')
2096
def _parse_limit(limitstring):
2098
return int(limitstring)
2100
msg = "The limit argument must be an integer."
2101
raise errors.BzrCommandError(msg)
2104
def _parse_levels(s):
2108
msg = "The levels argument must be an integer."
2109
raise errors.BzrCommandError(msg)
2112
class cmd_log(Command):
2113
__doc__ = """Show historical log for a branch or subset of a branch.
2115
log is bzr's default tool for exploring the history of a branch.
2116
The branch to use is taken from the first parameter. If no parameters
2117
are given, the branch containing the working directory is logged.
2118
Here are some simple examples::
2120
bzr log log the current branch
2121
bzr log foo.py log a file in its branch
2122
bzr log http://server/branch log a branch on a server
2124
The filtering, ordering and information shown for each revision can
2125
be controlled as explained below. By default, all revisions are
2126
shown sorted (topologically) so that newer revisions appear before
2127
older ones and descendants always appear before ancestors. If displayed,
2128
merged revisions are shown indented under the revision in which they
2133
The log format controls how information about each revision is
2134
displayed. The standard log formats are called ``long``, ``short``
2135
and ``line``. The default is long. See ``bzr help log-formats``
2136
for more details on log formats.
2138
The following options can be used to control what information is
2141
-l N display a maximum of N revisions
2142
-n N display N levels of revisions (0 for all, 1 for collapsed)
2143
-v display a status summary (delta) for each revision
2144
-p display a diff (patch) for each revision
2145
--show-ids display revision-ids (and file-ids), not just revnos
2147
Note that the default number of levels to display is a function of the
2148
log format. If the -n option is not used, the standard log formats show
2149
just the top level (mainline).
2151
Status summaries are shown using status flags like A, M, etc. To see
2152
the changes explained using words like ``added`` and ``modified``
2153
instead, use the -vv option.
2157
To display revisions from oldest to newest, use the --forward option.
2158
In most cases, using this option will have little impact on the total
2159
time taken to produce a log, though --forward does not incrementally
2160
display revisions like --reverse does when it can.
2162
:Revision filtering:
2164
The -r option can be used to specify what revision or range of revisions
2165
to filter against. The various forms are shown below::
2167
-rX display revision X
2168
-rX.. display revision X and later
2169
-r..Y display up to and including revision Y
2170
-rX..Y display from X to Y inclusive
2172
See ``bzr help revisionspec`` for details on how to specify X and Y.
2173
Some common examples are given below::
2175
-r-1 show just the tip
2176
-r-10.. show the last 10 mainline revisions
2177
-rsubmit:.. show what's new on this branch
2178
-rancestor:path.. show changes since the common ancestor of this
2179
branch and the one at location path
2180
-rdate:yesterday.. show changes since yesterday
2182
When logging a range of revisions using -rX..Y, log starts at
2183
revision Y and searches back in history through the primary
2184
("left-hand") parents until it finds X. When logging just the
2185
top level (using -n1), an error is reported if X is not found
2186
along the way. If multi-level logging is used (-n0), X may be
2187
a nested merge revision and the log will be truncated accordingly.
2191
If parameters are given and the first one is not a branch, the log
2192
will be filtered to show only those revisions that changed the
2193
nominated files or directories.
2195
Filenames are interpreted within their historical context. To log a
2196
deleted file, specify a revision range so that the file existed at
2197
the end or start of the range.
2199
Historical context is also important when interpreting pathnames of
2200
renamed files/directories. Consider the following example:
2202
* revision 1: add tutorial.txt
2203
* revision 2: modify tutorial.txt
2204
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2208
* ``bzr log guide.txt`` will log the file added in revision 1
2210
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2212
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2213
the original file in revision 2.
2215
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2216
was no file called guide.txt in revision 2.
2218
Renames are always followed by log. By design, there is no need to
2219
explicitly ask for this (and no way to stop logging a file back
2220
until it was last renamed).
2224
The --message option can be used for finding revisions that match a
2225
regular expression in a commit message.
2229
GUI tools and IDEs are often better at exploring history than command
2230
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2231
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2232
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2233
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2235
You may find it useful to add the aliases below to ``bazaar.conf``::
2239
top = log -l10 --line
2242
``bzr tip`` will then show the latest revision while ``bzr top``
2243
will show the last 10 mainline revisions. To see the details of a
2244
particular revision X, ``bzr show -rX``.
2246
If you are interested in looking deeper into a particular merge X,
2247
use ``bzr log -n0 -rX``.
2249
``bzr log -v`` on a branch with lots of history is currently
2250
very slow. A fix for this issue is currently under development.
2251
With or without that fix, it is recommended that a revision range
2252
be given when using the -v option.
2254
bzr has a generic full-text matching plugin, bzr-search, that can be
2255
used to find revisions matching user names, commit messages, etc.
2256
Among other features, this plugin can find all revisions containing
2257
a list of words but not others.
2259
When exploring non-mainline history on large projects with deep
2260
history, the performance of log can be greatly improved by installing
2261
the historycache plugin. This plugin buffers historical information
2262
trading disk space for faster speed.
2264
takes_args = ['file*']
2265
_see_also = ['log-formats', 'revisionspec']
2268
help='Show from oldest to newest.'),
2270
custom_help('verbose',
2271
help='Show files changed in each revision.'),
2275
type=bzrlib.option._parse_revision_str,
2277
help='Show just the specified revision.'
2278
' See also "help revisionspec".'),
2282
help='Number of levels to display - 0 for all, 1 for flat.',
2284
type=_parse_levels),
2287
help='Show revisions whose message matches this '
2288
'regular expression.',
2292
help='Limit the output to the first N revisions.',
2297
help='Show changes made in each revision as a patch.'),
2298
Option('include-merges',
2299
help='Show merged revisions like --levels 0 does.'),
2301
encoding_type = 'replace'
2304
def run(self, file_list=None, timezone='original',
2315
include_merges=False):
2316
from bzrlib.log import (
2318
make_log_request_dict,
2319
_get_info_for_log_files,
2321
direction = (forward and 'forward') or 'reverse'
2326
raise errors.BzrCommandError(
2327
'--levels and --include-merges are mutually exclusive')
2329
if change is not None:
2331
raise errors.RangeInChangeOption()
2332
if revision is not None:
2333
raise errors.BzrCommandError(
2334
'--revision and --change are mutually exclusive')
2339
filter_by_dir = False
2341
# find the file ids to log and check for directory filtering
2342
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2343
revision, file_list)
2344
self.add_cleanup(b.unlock)
2345
for relpath, file_id, kind in file_info_list:
2347
raise errors.BzrCommandError(
2348
"Path unknown at end or start of revision range: %s" %
2350
# If the relpath is the top of the tree, we log everything
2355
file_ids.append(file_id)
2356
filter_by_dir = filter_by_dir or (
2357
kind in ['directory', 'tree-reference'])
2360
# FIXME ? log the current subdir only RBC 20060203
2361
if revision is not None \
2362
and len(revision) > 0 and revision[0].get_branch():
2363
location = revision[0].get_branch()
2366
dir, relpath = bzrdir.BzrDir.open_containing(location)
2367
b = dir.open_branch()
2369
self.add_cleanup(b.unlock)
2370
rev1, rev2 = _get_revision_range(revision, b, self.name())
2372
# Decide on the type of delta & diff filtering to use
2373
# TODO: add an --all-files option to make this configurable & consistent
2381
diff_type = 'partial'
2385
# Build the log formatter
2386
if log_format is None:
2387
log_format = log.log_formatter_registry.get_default(b)
2388
# Make a non-encoding output to include the diffs - bug 328007
2389
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2390
lf = log_format(show_ids=show_ids, to_file=self.outf,
2391
to_exact_file=unencoded_output,
2392
show_timezone=timezone,
2393
delta_format=get_verbosity_level(),
2395
show_advice=levels is None)
2397
# Choose the algorithm for doing the logging. It's annoying
2398
# having multiple code paths like this but necessary until
2399
# the underlying repository format is faster at generating
2400
# deltas or can provide everything we need from the indices.
2401
# The default algorithm - match-using-deltas - works for
2402
# multiple files and directories and is faster for small
2403
# amounts of history (200 revisions say). However, it's too
2404
# slow for logging a single file in a repository with deep
2405
# history, i.e. > 10K revisions. In the spirit of "do no
2406
# evil when adding features", we continue to use the
2407
# original algorithm - per-file-graph - for the "single
2408
# file that isn't a directory without showing a delta" case.
2409
partial_history = revision and b.repository._format.supports_chks
2410
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2411
or delta_type or partial_history)
2413
# Build the LogRequest and execute it
2414
if len(file_ids) == 0:
2416
rqst = make_log_request_dict(
2417
direction=direction, specific_fileids=file_ids,
2418
start_revision=rev1, end_revision=rev2, limit=limit,
2419
message_search=message, delta_type=delta_type,
2420
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2421
Logger(b, rqst).show(lf)
2424
def _get_revision_range(revisionspec_list, branch, command_name):
2425
"""Take the input of a revision option and turn it into a revision range.
2427
It returns RevisionInfo objects which can be used to obtain the rev_id's
2428
of the desired revisions. It does some user input validations.
2430
if revisionspec_list is None:
2433
elif len(revisionspec_list) == 1:
2434
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2435
elif len(revisionspec_list) == 2:
2436
start_spec = revisionspec_list[0]
2437
end_spec = revisionspec_list[1]
2438
if end_spec.get_branch() != start_spec.get_branch():
2439
# b is taken from revision[0].get_branch(), and
2440
# show_log will use its revision_history. Having
2441
# different branches will lead to weird behaviors.
2442
raise errors.BzrCommandError(
2443
"bzr %s doesn't accept two revisions in different"
2444
" branches." % command_name)
2445
if start_spec.spec is None:
2446
# Avoid loading all the history.
2447
rev1 = RevisionInfo(branch, None, None)
2449
rev1 = start_spec.in_history(branch)
2450
# Avoid loading all of history when we know a missing
2451
# end of range means the last revision ...
2452
if end_spec.spec is None:
2453
last_revno, last_revision_id = branch.last_revision_info()
2454
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2456
rev2 = end_spec.in_history(branch)
2458
raise errors.BzrCommandError(
2459
'bzr %s --revision takes one or two values.' % command_name)
2463
def _revision_range_to_revid_range(revision_range):
2466
if revision_range[0] is not None:
2467
rev_id1 = revision_range[0].rev_id
2468
if revision_range[1] is not None:
2469
rev_id2 = revision_range[1].rev_id
2470
return rev_id1, rev_id2
2472
def get_log_format(long=False, short=False, line=False, default='long'):
2473
log_format = default
2477
log_format = 'short'
2483
class cmd_touching_revisions(Command):
2484
__doc__ = """Return revision-ids which affected a particular file.
2486
A more user-friendly interface is "bzr log FILE".
2490
takes_args = ["filename"]
2493
def run(self, filename):
2494
tree, relpath = WorkingTree.open_containing(filename)
2495
file_id = tree.path2id(relpath)
2498
self.add_cleanup(b.unlock)
2499
touching_revs = log.find_touching_revisions(b, file_id)
2500
for revno, revision_id, what in touching_revs:
2501
self.outf.write("%6d %s\n" % (revno, what))
2504
class cmd_ls(Command):
2505
__doc__ = """List files in a tree.
2508
_see_also = ['status', 'cat']
2509
takes_args = ['path?']
2513
Option('recursive', short_name='R',
2514
help='Recurse into subdirectories.'),
2516
help='Print paths relative to the root of the branch.'),
2517
Option('unknown', help='Print unknown files.'),
2518
Option('versioned', help='Print versioned files.',
2520
Option('ignored', help='Print ignored files.'),
2522
help='Write an ascii NUL (\\0) separator '
2523
'between files rather than a newline.'),
2525
help='List entries of a particular kind: file, directory, symlink.',
2530
def run(self, revision=None, verbose=False,
2531
recursive=False, from_root=False,
2532
unknown=False, versioned=False, ignored=False,
2533
null=False, kind=None, show_ids=False, path=None):
2535
if kind and kind not in ('file', 'directory', 'symlink'):
2536
raise errors.BzrCommandError('invalid kind specified')
2538
if verbose and null:
2539
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2540
all = not (unknown or versioned or ignored)
2542
selection = {'I':ignored, '?':unknown, 'V':versioned}
2548
raise errors.BzrCommandError('cannot specify both --from-root'
2551
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2554
# Calculate the prefix to use
2558
prefix = relpath + '/'
2559
elif fs_path != '.' and not fs_path.endswith('/'):
2560
prefix = fs_path + '/'
2562
if revision is not None or tree is None:
2563
tree = _get_one_revision_tree('ls', revision, branch=branch)
2566
if isinstance(tree, WorkingTree) and tree.supports_views():
2567
view_files = tree.views.lookup_view()
2570
view_str = views.view_display_str(view_files)
2571
note("Ignoring files outside view. View is %s" % view_str)
2574
self.add_cleanup(tree.unlock)
2575
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2576
from_dir=relpath, recursive=recursive):
2577
# Apply additional masking
2578
if not all and not selection[fc]:
2580
if kind is not None and fkind != kind:
2585
fullpath = osutils.pathjoin(relpath, fp)
2588
views.check_path_in_view(tree, fullpath)
2589
except errors.FileOutsideView:
2594
fp = osutils.pathjoin(prefix, fp)
2595
kindch = entry.kind_character()
2596
outstring = fp + kindch
2597
ui.ui_factory.clear_term()
2599
outstring = '%-8s %s' % (fc, outstring)
2600
if show_ids and fid is not None:
2601
outstring = "%-50s %s" % (outstring, fid)
2602
self.outf.write(outstring + '\n')
2604
self.outf.write(fp + '\0')
2607
self.outf.write(fid)
2608
self.outf.write('\0')
2616
self.outf.write('%-50s %s\n' % (outstring, my_id))
2618
self.outf.write(outstring + '\n')
2621
class cmd_unknowns(Command):
2622
__doc__ = """List unknown files.
2630
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2631
self.outf.write(osutils.quotefn(f) + '\n')
2634
class cmd_ignore(Command):
2635
__doc__ = """Ignore specified files or patterns.
2637
See ``bzr help patterns`` for details on the syntax of patterns.
2639
If a .bzrignore file does not exist, the ignore command
2640
will create one and add the specified files or patterns to the newly
2641
created file. The ignore command will also automatically add the
2642
.bzrignore file to be versioned. Creating a .bzrignore file without
2643
the use of the ignore command will require an explicit add command.
2645
To remove patterns from the ignore list, edit the .bzrignore file.
2646
After adding, editing or deleting that file either indirectly by
2647
using this command or directly by using an editor, be sure to commit
2650
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2651
the global ignore file can be found in the application data directory as
2652
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2653
Global ignores are not touched by this command. The global ignore file
2654
can be edited directly using an editor.
2656
Patterns prefixed with '!' are exceptions to ignore patterns and take
2657
precedence over regular ignores. Such exceptions are used to specify
2658
files that should be versioned which would otherwise be ignored.
2660
Patterns prefixed with '!!' act as regular ignore patterns, but have
2661
precedence over the '!' exception patterns.
2663
Note: ignore patterns containing shell wildcards must be quoted from
2667
Ignore the top level Makefile::
2669
bzr ignore ./Makefile
2671
Ignore .class files in all directories...::
2673
bzr ignore "*.class"
2675
...but do not ignore "special.class"::
2677
bzr ignore "!special.class"
2679
Ignore .o files under the lib directory::
2681
bzr ignore "lib/**/*.o"
2683
Ignore .o files under the lib directory::
2685
bzr ignore "RE:lib/.*\.o"
2687
Ignore everything but the "debian" toplevel directory::
2689
bzr ignore "RE:(?!debian/).*"
2691
Ignore everything except the "local" toplevel directory,
2692
but always ignore "*~" autosave files, even under local/::
2695
bzr ignore "!./local"
2699
_see_also = ['status', 'ignored', 'patterns']
2700
takes_args = ['name_pattern*']
2702
Option('default-rules',
2703
help='Display the default ignore rules that bzr uses.')
2706
def run(self, name_pattern_list=None, default_rules=None):
2707
from bzrlib import ignores
2708
if default_rules is not None:
2709
# dump the default rules and exit
2710
for pattern in ignores.USER_DEFAULTS:
2711
self.outf.write("%s\n" % pattern)
2713
if not name_pattern_list:
2714
raise errors.BzrCommandError("ignore requires at least one "
2715
"NAME_PATTERN or --default-rules.")
2716
name_pattern_list = [globbing.normalize_pattern(p)
2717
for p in name_pattern_list]
2718
for name_pattern in name_pattern_list:
2719
if (name_pattern[0] == '/' or
2720
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2721
raise errors.BzrCommandError(
2722
"NAME_PATTERN should not be an absolute path")
2723
tree, relpath = WorkingTree.open_containing(u'.')
2724
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2725
ignored = globbing.Globster(name_pattern_list)
2728
for entry in tree.list_files():
2732
if ignored.match(filename):
2733
matches.append(filename)
2735
if len(matches) > 0:
2736
self.outf.write("Warning: the following files are version controlled and"
2737
" match your ignore pattern:\n%s"
2738
"\nThese files will continue to be version controlled"
2739
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2742
class cmd_ignored(Command):
2743
__doc__ = """List ignored files and the patterns that matched them.
2745
List all the ignored files and the ignore pattern that caused the file to
2748
Alternatively, to list just the files::
2753
encoding_type = 'replace'
2754
_see_also = ['ignore', 'ls']
2758
tree = WorkingTree.open_containing(u'.')[0]
2760
self.add_cleanup(tree.unlock)
2761
for path, file_class, kind, file_id, entry in tree.list_files():
2762
if file_class != 'I':
2764
## XXX: Slightly inefficient since this was already calculated
2765
pat = tree.is_ignored(path)
2766
self.outf.write('%-50s %s\n' % (path, pat))
2769
class cmd_lookup_revision(Command):
2770
__doc__ = """Lookup the revision-id from a revision-number
2773
bzr lookup-revision 33
2776
takes_args = ['revno']
2779
def run(self, revno):
2783
raise errors.BzrCommandError("not a valid revision-number: %r"
2785
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2786
self.outf.write("%s\n" % revid)
2789
class cmd_export(Command):
2790
__doc__ = """Export current or past revision to a destination directory or archive.
2792
If no revision is specified this exports the last committed revision.
2794
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2795
given, try to find the format with the extension. If no extension
2796
is found exports to a directory (equivalent to --format=dir).
2798
If root is supplied, it will be used as the root directory inside
2799
container formats (tar, zip, etc). If it is not supplied it will default
2800
to the exported filename. The root option has no effect for 'dir' format.
2802
If branch is omitted then the branch containing the current working
2803
directory will be used.
2805
Note: Export of tree with non-ASCII filenames to zip is not supported.
2807
================= =========================
2808
Supported formats Autodetected by extension
2809
================= =========================
2812
tbz2 .tar.bz2, .tbz2
2815
================= =========================
2817
takes_args = ['dest', 'branch_or_subdir?']
2820
help="Type of file to export to.",
2823
Option('filters', help='Apply content filters to export the '
2824
'convenient form.'),
2827
help="Name of the root directory inside the exported file."),
2828
Option('per-file-timestamps',
2829
help='Set modification time of files to that of the last '
2830
'revision in which it was changed.'),
2832
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2833
root=None, filters=False, per_file_timestamps=False):
2834
from bzrlib.export import export
2836
if branch_or_subdir is None:
2837
tree = WorkingTree.open_containing(u'.')[0]
2841
b, subdir = Branch.open_containing(branch_or_subdir)
2844
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2846
export(rev_tree, dest, format, root, subdir, filtered=filters,
2847
per_file_timestamps=per_file_timestamps)
2848
except errors.NoSuchExportFormat, e:
2849
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2852
class cmd_cat(Command):
2853
__doc__ = """Write the contents of a file as of a given revision to standard output.
2855
If no revision is nominated, the last revision is used.
2857
Note: Take care to redirect standard output when using this command on a
2863
Option('name-from-revision', help='The path name in the old tree.'),
2864
Option('filters', help='Apply content filters to display the '
2865
'convenience form.'),
2868
takes_args = ['filename']
2869
encoding_type = 'exact'
2872
def run(self, filename, revision=None, name_from_revision=False,
2874
if revision is not None and len(revision) != 1:
2875
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2876
" one revision specifier")
2877
tree, branch, relpath = \
2878
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2880
self.add_cleanup(branch.unlock)
2881
return self._run(tree, branch, relpath, filename, revision,
2882
name_from_revision, filters)
2884
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2887
tree = b.basis_tree()
2888
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2889
rev_tree.lock_read()
2890
self.add_cleanup(rev_tree.unlock)
2892
old_file_id = rev_tree.path2id(relpath)
2894
if name_from_revision:
2895
# Try in revision if requested
2896
if old_file_id is None:
2897
raise errors.BzrCommandError(
2898
"%r is not present in revision %s" % (
2899
filename, rev_tree.get_revision_id()))
2901
content = rev_tree.get_file_text(old_file_id)
2903
cur_file_id = tree.path2id(relpath)
2905
if cur_file_id is not None:
2906
# Then try with the actual file id
2908
content = rev_tree.get_file_text(cur_file_id)
2910
except errors.NoSuchId:
2911
# The actual file id didn't exist at that time
2913
if not found and old_file_id is not None:
2914
# Finally try with the old file id
2915
content = rev_tree.get_file_text(old_file_id)
2918
# Can't be found anywhere
2919
raise errors.BzrCommandError(
2920
"%r is not present in revision %s" % (
2921
filename, rev_tree.get_revision_id()))
2923
from bzrlib.filters import (
2924
ContentFilterContext,
2925
filtered_output_bytes,
2927
filters = rev_tree._content_filter_stack(relpath)
2928
chunks = content.splitlines(True)
2929
content = filtered_output_bytes(chunks, filters,
2930
ContentFilterContext(relpath, rev_tree))
2932
self.outf.writelines(content)
2935
self.outf.write(content)
2938
class cmd_local_time_offset(Command):
2939
__doc__ = """Show the offset in seconds from GMT to local time."""
2943
self.outf.write("%s\n" % osutils.local_time_offset())
2947
class cmd_commit(Command):
2948
__doc__ = """Commit changes into a new revision.
2950
An explanatory message needs to be given for each commit. This is
2951
often done by using the --message option (getting the message from the
2952
command line) or by using the --file option (getting the message from
2953
a file). If neither of these options is given, an editor is opened for
2954
the user to enter the message. To see the changed files in the
2955
boilerplate text loaded into the editor, use the --show-diff option.
2957
By default, the entire tree is committed and the person doing the
2958
commit is assumed to be the author. These defaults can be overridden
2963
If selected files are specified, only changes to those files are
2964
committed. If a directory is specified then the directory and
2965
everything within it is committed.
2967
When excludes are given, they take precedence over selected files.
2968
For example, to commit only changes within foo, but not changes
2971
bzr commit foo -x foo/bar
2973
A selective commit after a merge is not yet supported.
2977
If the author of the change is not the same person as the committer,
2978
you can specify the author's name using the --author option. The
2979
name should be in the same format as a committer-id, e.g.
2980
"John Doe <jdoe@example.com>". If there is more than one author of
2981
the change you can specify the option multiple times, once for each
2986
A common mistake is to forget to add a new file or directory before
2987
running the commit command. The --strict option checks for unknown
2988
files and aborts the commit if any are found. More advanced pre-commit
2989
checks can be implemented by defining hooks. See ``bzr help hooks``
2994
If you accidentially commit the wrong changes or make a spelling
2995
mistake in the commit message say, you can use the uncommit command
2996
to undo it. See ``bzr help uncommit`` for details.
2998
Hooks can also be configured to run after a commit. This allows you
2999
to trigger updates to external systems like bug trackers. The --fixes
3000
option can be used to record the association between a revision and
3001
one or more bugs. See ``bzr help bugs`` for details.
3003
A selective commit may fail in some cases where the committed
3004
tree would be invalid. Consider::
3009
bzr commit foo -m "committing foo"
3010
bzr mv foo/bar foo/baz
3013
bzr commit foo/bar -m "committing bar but not baz"
3015
In the example above, the last commit will fail by design. This gives
3016
the user the opportunity to decide whether they want to commit the
3017
rename at the same time, separately first, or not at all. (As a general
3018
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3020
# TODO: Run hooks on tree to-be-committed, and after commit.
3022
# TODO: Strict commit that fails if there are deleted files.
3023
# (what does "deleted files" mean ??)
3025
# TODO: Give better message for -s, --summary, used by tla people
3027
# XXX: verbose currently does nothing
3029
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3030
takes_args = ['selected*']
3032
ListOption('exclude', type=str, short_name='x',
3033
help="Do not consider changes made to a given path."),
3034
Option('message', type=unicode,
3036
help="Description of the new revision."),
3039
help='Commit even if nothing has changed.'),
3040
Option('file', type=str,
3043
help='Take commit message from this file.'),
3045
help="Refuse to commit if there are unknown "
3046
"files in the working tree."),
3047
Option('commit-time', type=str,
3048
help="Manually set a commit time using commit date "
3049
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3050
ListOption('fixes', type=str,
3051
help="Mark a bug as being fixed by this revision "
3052
"(see \"bzr help bugs\")."),
3053
ListOption('author', type=unicode,
3054
help="Set the author's name, if it's different "
3055
"from the committer."),
3057
help="Perform a local commit in a bound "
3058
"branch. Local commits are not pushed to "
3059
"the master branch until a normal commit "
3063
help='When no message is supplied, show the diff along'
3064
' with the status summary in the message editor.'),
3066
aliases = ['ci', 'checkin']
3068
def _iter_bug_fix_urls(self, fixes, branch):
3069
# Configure the properties for bug fixing attributes.
3070
for fixed_bug in fixes:
3071
tokens = fixed_bug.split(':')
3072
if len(tokens) != 2:
3073
raise errors.BzrCommandError(
3074
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3075
"See \"bzr help bugs\" for more information on this "
3076
"feature.\nCommit refused." % fixed_bug)
3077
tag, bug_id = tokens
3079
yield bugtracker.get_bug_url(tag, branch, bug_id)
3080
except errors.UnknownBugTrackerAbbreviation:
3081
raise errors.BzrCommandError(
3082
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3083
except errors.MalformedBugIdentifier, e:
3084
raise errors.BzrCommandError(
3085
"%s\nCommit refused." % (str(e),))
3087
def run(self, message=None, file=None, verbose=False, selected_list=None,
3088
unchanged=False, strict=False, local=False, fixes=None,
3089
author=None, show_diff=False, exclude=None, commit_time=None):
3090
from bzrlib.errors import (
3095
from bzrlib.msgeditor import (
3096
edit_commit_message_encoded,
3097
generate_commit_message_template,
3098
make_commit_message_template_encoded
3101
commit_stamp = offset = None
3102
if commit_time is not None:
3104
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3105
except ValueError, e:
3106
raise errors.BzrCommandError(
3107
"Could not parse --commit-time: " + str(e))
3109
# TODO: Need a blackbox test for invoking the external editor; may be
3110
# slightly problematic to run this cross-platform.
3112
# TODO: do more checks that the commit will succeed before
3113
# spending the user's valuable time typing a commit message.
3117
tree, selected_list = tree_files(selected_list)
3118
if selected_list == ['']:
3119
# workaround - commit of root of tree should be exactly the same
3120
# as just default commit in that tree, and succeed even though
3121
# selected-file merge commit is not done yet
3126
bug_property = bugtracker.encode_fixes_bug_urls(
3127
self._iter_bug_fix_urls(fixes, tree.branch))
3129
properties['bugs'] = bug_property
3131
if local and not tree.branch.get_bound_location():
3132
raise errors.LocalRequiresBoundBranch()
3134
if message is not None:
3136
file_exists = osutils.lexists(message)
3137
except UnicodeError:
3138
# The commit message contains unicode characters that can't be
3139
# represented in the filesystem encoding, so that can't be a
3144
'The commit message is a file name: "%(f)s".\n'
3145
'(use --file "%(f)s" to take commit message from that file)'
3147
ui.ui_factory.show_warning(warning_msg)
3149
message = message.replace('\r\n', '\n')
3150
message = message.replace('\r', '\n')
3152
raise errors.BzrCommandError(
3153
"please specify either --message or --file")
3155
def get_message(commit_obj):
3156
"""Callback to get commit message"""
3158
my_message = codecs.open(
3159
file, 'rt', osutils.get_user_encoding()).read()
3160
elif message is not None:
3161
my_message = message
3163
# No message supplied: make one up.
3164
# text is the status of the tree
3165
text = make_commit_message_template_encoded(tree,
3166
selected_list, diff=show_diff,
3167
output_encoding=osutils.get_user_encoding())
3168
# start_message is the template generated from hooks
3169
# XXX: Warning - looks like hooks return unicode,
3170
# make_commit_message_template_encoded returns user encoding.
3171
# We probably want to be using edit_commit_message instead to
3173
start_message = generate_commit_message_template(commit_obj)
3174
my_message = edit_commit_message_encoded(text,
3175
start_message=start_message)
3176
if my_message is None:
3177
raise errors.BzrCommandError("please specify a commit"
3178
" message with either --message or --file")
3179
if my_message == "":
3180
raise errors.BzrCommandError("empty commit message specified")
3183
# The API permits a commit with a filter of [] to mean 'select nothing'
3184
# but the command line should not do that.
3185
if not selected_list:
3186
selected_list = None
3188
tree.commit(message_callback=get_message,
3189
specific_files=selected_list,
3190
allow_pointless=unchanged, strict=strict, local=local,
3191
reporter=None, verbose=verbose, revprops=properties,
3192
authors=author, timestamp=commit_stamp,
3194
exclude=safe_relpath_files(tree, exclude))
3195
except PointlessCommit:
3196
raise errors.BzrCommandError("No changes to commit."
3197
" Use --unchanged to commit anyhow.")
3198
except ConflictsInTree:
3199
raise errors.BzrCommandError('Conflicts detected in working '
3200
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3202
except StrictCommitFailed:
3203
raise errors.BzrCommandError("Commit refused because there are"
3204
" unknown files in the working tree.")
3205
except errors.BoundBranchOutOfDate, e:
3206
e.extra_help = ("\n"
3207
'To commit to master branch, run update and then commit.\n'
3208
'You can also pass --local to commit to continue working '
3213
class cmd_check(Command):
3214
__doc__ = """Validate working tree structure, branch consistency and repository history.
3216
This command checks various invariants about branch and repository storage
3217
to detect data corruption or bzr bugs.
3219
The working tree and branch checks will only give output if a problem is
3220
detected. The output fields of the repository check are:
3223
This is just the number of revisions checked. It doesn't
3227
This is just the number of versionedfiles checked. It
3228
doesn't indicate a problem.
3230
unreferenced ancestors
3231
Texts that are ancestors of other texts, but
3232
are not properly referenced by the revision ancestry. This is a
3233
subtle problem that Bazaar can work around.
3236
This is the total number of unique file contents
3237
seen in the checked revisions. It does not indicate a problem.
3240
This is the total number of repeated texts seen
3241
in the checked revisions. Texts can be repeated when their file
3242
entries are modified, but the file contents are not. It does not
3245
If no restrictions are specified, all Bazaar data that is found at the given
3246
location will be checked.
3250
Check the tree and branch at 'foo'::
3252
bzr check --tree --branch foo
3254
Check only the repository at 'bar'::
3256
bzr check --repo bar
3258
Check everything at 'baz'::
3263
_see_also = ['reconcile']
3264
takes_args = ['path?']
3265
takes_options = ['verbose',
3266
Option('branch', help="Check the branch related to the"
3267
" current directory."),
3268
Option('repo', help="Check the repository related to the"
3269
" current directory."),
3270
Option('tree', help="Check the working tree related to"
3271
" the current directory.")]
3273
def run(self, path=None, verbose=False, branch=False, repo=False,
3275
from bzrlib.check import check_dwim
3278
if not branch and not repo and not tree:
3279
branch = repo = tree = True
3280
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3283
class cmd_upgrade(Command):
3284
__doc__ = """Upgrade branch storage to current format.
3286
The check command or bzr developers may sometimes advise you to run
3287
this command. When the default format has changed you may also be warned
3288
during other operations to upgrade.
3291
_see_also = ['check']
3292
takes_args = ['url?']
3294
RegistryOption('format',
3295
help='Upgrade to a specific format. See "bzr help'
3296
' formats" for details.',
3297
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3298
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3299
value_switches=True, title='Branch format'),
3302
def run(self, url='.', format=None):
3303
from bzrlib.upgrade import upgrade
3304
upgrade(url, format)
3307
class cmd_whoami(Command):
3308
__doc__ = """Show or set bzr user id.
3311
Show the email of the current user::
3315
Set the current user::
3317
bzr whoami "Frank Chu <fchu@example.com>"
3319
takes_options = [ Option('email',
3320
help='Display email address only.'),
3322
help='Set identity for the current branch instead of '
3325
takes_args = ['name?']
3326
encoding_type = 'replace'
3329
def run(self, email=False, branch=False, name=None):
3331
# use branch if we're inside one; otherwise global config
3333
c = Branch.open_containing('.')[0].get_config()
3334
except errors.NotBranchError:
3335
c = config.GlobalConfig()
3337
self.outf.write(c.user_email() + '\n')
3339
self.outf.write(c.username() + '\n')
3342
# display a warning if an email address isn't included in the given name.
3344
config.extract_email_address(name)
3345
except errors.NoEmailInUsername, e:
3346
warning('"%s" does not seem to contain an email address. '
3347
'This is allowed, but not recommended.', name)
3349
# use global config unless --branch given
3351
c = Branch.open_containing('.')[0].get_config()
3353
c = config.GlobalConfig()
3354
c.set_user_option('email', name)
3357
class cmd_nick(Command):
3358
__doc__ = """Print or set the branch nickname.
3360
If unset, the tree root directory name is used as the nickname.
3361
To print the current nickname, execute with no argument.
3363
Bound branches use the nickname of its master branch unless it is set
3367
_see_also = ['info']
3368
takes_args = ['nickname?']
3369
def run(self, nickname=None):
3370
branch = Branch.open_containing(u'.')[0]
3371
if nickname is None:
3372
self.printme(branch)
3374
branch.nick = nickname
3377
def printme(self, branch):
3378
self.outf.write('%s\n' % branch.nick)
3381
class cmd_alias(Command):
3382
__doc__ = """Set/unset and display aliases.
3385
Show the current aliases::
3389
Show the alias specified for 'll'::
3393
Set an alias for 'll'::
3395
bzr alias ll="log --line -r-10..-1"
3397
To remove an alias for 'll'::
3399
bzr alias --remove ll
3402
takes_args = ['name?']
3404
Option('remove', help='Remove the alias.'),
3407
def run(self, name=None, remove=False):
3409
self.remove_alias(name)
3411
self.print_aliases()
3413
equal_pos = name.find('=')
3415
self.print_alias(name)
3417
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3419
def remove_alias(self, alias_name):
3420
if alias_name is None:
3421
raise errors.BzrCommandError(
3422
'bzr alias --remove expects an alias to remove.')
3423
# If alias is not found, print something like:
3424
# unalias: foo: not found
3425
c = config.GlobalConfig()
3426
c.unset_alias(alias_name)
3429
def print_aliases(self):
3430
"""Print out the defined aliases in a similar format to bash."""
3431
aliases = config.GlobalConfig().get_aliases()
3432
for key, value in sorted(aliases.iteritems()):
3433
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3436
def print_alias(self, alias_name):
3437
from bzrlib.commands import get_alias
3438
alias = get_alias(alias_name)
3440
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3443
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3445
def set_alias(self, alias_name, alias_command):
3446
"""Save the alias in the global config."""
3447
c = config.GlobalConfig()
3448
c.set_alias(alias_name, alias_command)
3451
class cmd_selftest(Command):
3452
__doc__ = """Run internal test suite.
3454
If arguments are given, they are regular expressions that say which tests
3455
should run. Tests matching any expression are run, and other tests are
3458
Alternatively if --first is given, matching tests are run first and then
3459
all other tests are run. This is useful if you have been working in a
3460
particular area, but want to make sure nothing else was broken.
3462
If --exclude is given, tests that match that regular expression are
3463
excluded, regardless of whether they match --first or not.
3465
To help catch accidential dependencies between tests, the --randomize
3466
option is useful. In most cases, the argument used is the word 'now'.
3467
Note that the seed used for the random number generator is displayed
3468
when this option is used. The seed can be explicitly passed as the
3469
argument to this option if required. This enables reproduction of the
3470
actual ordering used if and when an order sensitive problem is encountered.
3472
If --list-only is given, the tests that would be run are listed. This is
3473
useful when combined with --first, --exclude and/or --randomize to
3474
understand their impact. The test harness reports "Listed nn tests in ..."
3475
instead of "Ran nn tests in ..." when list mode is enabled.
3477
If the global option '--no-plugins' is given, plugins are not loaded
3478
before running the selftests. This has two effects: features provided or
3479
modified by plugins will not be tested, and tests provided by plugins will
3482
Tests that need working space on disk use a common temporary directory,
3483
typically inside $TMPDIR or /tmp.
3485
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3486
into a pdb postmortem session.
3489
Run only tests relating to 'ignore'::
3493
Disable plugins and list tests as they're run::
3495
bzr --no-plugins selftest -v
3497
# NB: this is used from the class without creating an instance, which is
3498
# why it does not have a self parameter.
3499
def get_transport_type(typestring):
3500
"""Parse and return a transport specifier."""
3501
if typestring == "sftp":
3502
from bzrlib.tests import stub_sftp
3503
return stub_sftp.SFTPAbsoluteServer
3504
if typestring == "memory":
3505
from bzrlib.tests import test_server
3506
return memory.MemoryServer
3507
if typestring == "fakenfs":
3508
from bzrlib.tests import test_server
3509
return test_server.FakeNFSServer
3510
msg = "No known transport type %s. Supported types are: sftp\n" %\
3512
raise errors.BzrCommandError(msg)
3515
takes_args = ['testspecs*']
3516
takes_options = ['verbose',
3518
help='Stop when one test fails.',
3522
help='Use a different transport by default '
3523
'throughout the test suite.',
3524
type=get_transport_type),
3526
help='Run the benchmarks rather than selftests.'),
3527
Option('lsprof-timed',
3528
help='Generate lsprof output for benchmarked'
3529
' sections of code.'),
3530
Option('lsprof-tests',
3531
help='Generate lsprof output for each test.'),
3532
Option('cache-dir', type=str,
3533
help='Cache intermediate benchmark output in this '
3536
help='Run all tests, but run specified tests first.',
3540
help='List the tests instead of running them.'),
3541
RegistryOption('parallel',
3542
help="Run the test suite in parallel.",
3543
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3544
value_switches=False,
3546
Option('randomize', type=str, argname="SEED",
3547
help='Randomize the order of tests using the given'
3548
' seed or "now" for the current time.'),
3549
Option('exclude', type=str, argname="PATTERN",
3551
help='Exclude tests that match this regular'
3554
help='Output test progress via subunit.'),
3555
Option('strict', help='Fail on missing dependencies or '
3557
Option('load-list', type=str, argname='TESTLISTFILE',
3558
help='Load a test id list from a text file.'),
3559
ListOption('debugflag', type=str, short_name='E',
3560
help='Turn on a selftest debug flag.'),
3561
ListOption('starting-with', type=str, argname='TESTID',
3562
param_name='starting_with', short_name='s',
3564
'Load only the tests starting with TESTID.'),
3566
encoding_type = 'replace'
3569
Command.__init__(self)
3570
self.additional_selftest_args = {}
3572
def run(self, testspecs_list=None, verbose=False, one=False,
3573
transport=None, benchmark=None,
3574
lsprof_timed=None, cache_dir=None,
3575
first=False, list_only=False,
3576
randomize=None, exclude=None, strict=False,
3577
load_list=None, debugflag=None, starting_with=None, subunit=False,
3578
parallel=None, lsprof_tests=False):
3579
from bzrlib.tests import selftest
3580
import bzrlib.benchmarks as benchmarks
3581
from bzrlib.benchmarks import tree_creator
3583
# Make deprecation warnings visible, unless -Werror is set
3584
symbol_versioning.activate_deprecation_warnings(override=False)
3586
if cache_dir is not None:
3587
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3588
if testspecs_list is not None:
3589
pattern = '|'.join(testspecs_list)
3594
from bzrlib.tests import SubUnitBzrRunner
3596
raise errors.BzrCommandError("subunit not available. subunit "
3597
"needs to be installed to use --subunit.")
3598
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3599
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3600
# stdout, which would corrupt the subunit stream.
3601
if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3603
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3605
self.additional_selftest_args.setdefault(
3606
'suite_decorators', []).append(parallel)
3608
test_suite_factory = benchmarks.test_suite
3609
# Unless user explicitly asks for quiet, be verbose in benchmarks
3610
verbose = not is_quiet()
3611
# TODO: should possibly lock the history file...
3612
benchfile = open(".perf_history", "at", buffering=1)
3613
self.add_cleanup(benchfile.close)
3615
test_suite_factory = None
3617
selftest_kwargs = {"verbose": verbose,
3619
"stop_on_failure": one,
3620
"transport": transport,
3621
"test_suite_factory": test_suite_factory,
3622
"lsprof_timed": lsprof_timed,
3623
"lsprof_tests": lsprof_tests,
3624
"bench_history": benchfile,
3625
"matching_tests_first": first,
3626
"list_only": list_only,
3627
"random_seed": randomize,
3628
"exclude_pattern": exclude,
3630
"load_list": load_list,
3631
"debug_flags": debugflag,
3632
"starting_with": starting_with
3634
selftest_kwargs.update(self.additional_selftest_args)
3635
result = selftest(**selftest_kwargs)
3636
return int(not result)
3639
class cmd_version(Command):
3640
__doc__ = """Show version of bzr."""
3642
encoding_type = 'replace'
3644
Option("short", help="Print just the version number."),
3648
def run(self, short=False):
3649
from bzrlib.version import show_version
3651
self.outf.write(bzrlib.version_string + '\n')
3653
show_version(to_file=self.outf)
3656
class cmd_rocks(Command):
3657
__doc__ = """Statement of optimism."""
3663
self.outf.write("It sure does!\n")
3666
class cmd_find_merge_base(Command):
3667
__doc__ = """Find and print a base revision for merging two branches."""
3668
# TODO: Options to specify revisions on either side, as if
3669
# merging only part of the history.
3670
takes_args = ['branch', 'other']
3674
def run(self, branch, other):
3675
from bzrlib.revision import ensure_null
3677
branch1 = Branch.open_containing(branch)[0]
3678
branch2 = Branch.open_containing(other)[0]
3680
self.add_cleanup(branch1.unlock)
3682
self.add_cleanup(branch2.unlock)
3683
last1 = ensure_null(branch1.last_revision())
3684
last2 = ensure_null(branch2.last_revision())
3686
graph = branch1.repository.get_graph(branch2.repository)
3687
base_rev_id = graph.find_unique_lca(last1, last2)
3689
self.outf.write('merge base is revision %s\n' % base_rev_id)
3692
class cmd_merge(Command):
3693
__doc__ = """Perform a three-way merge.
3695
The source of the merge can be specified either in the form of a branch,
3696
or in the form of a path to a file containing a merge directive generated
3697
with bzr send. If neither is specified, the default is the upstream branch
3698
or the branch most recently merged using --remember.
3700
When merging a branch, by default the tip will be merged. To pick a different
3701
revision, pass --revision. If you specify two values, the first will be used as
3702
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3703
available revisions, like this is commonly referred to as "cherrypicking".
3705
Revision numbers are always relative to the branch being merged.
3707
By default, bzr will try to merge in all new work from the other
3708
branch, automatically determining an appropriate base. If this
3709
fails, you may need to give an explicit base.
3711
Merge will do its best to combine the changes in two branches, but there
3712
are some kinds of problems only a human can fix. When it encounters those,
3713
it will mark a conflict. A conflict means that you need to fix something,
3714
before you should commit.
3716
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3718
If there is no default branch set, the first merge will set it. After
3719
that, you can omit the branch to use the default. To change the
3720
default, use --remember. The value will only be saved if the remote
3721
location can be accessed.
3723
The results of the merge are placed into the destination working
3724
directory, where they can be reviewed (with bzr diff), tested, and then
3725
committed to record the result of the merge.
3727
merge refuses to run if there are any uncommitted changes, unless
3728
--force is given. The --force option can also be used to create a
3729
merge revision which has more than two parents.
3731
If one would like to merge changes from the working tree of the other
3732
branch without merging any committed revisions, the --uncommitted option
3735
To select only some changes to merge, use "merge -i", which will prompt
3736
you to apply each diff hunk and file change, similar to "shelve".
3739
To merge the latest revision from bzr.dev::
3741
bzr merge ../bzr.dev
3743
To merge changes up to and including revision 82 from bzr.dev::
3745
bzr merge -r 82 ../bzr.dev
3747
To merge the changes introduced by 82, without previous changes::
3749
bzr merge -r 81..82 ../bzr.dev
3751
To apply a merge directive contained in /tmp/merge::
3753
bzr merge /tmp/merge
3755
To create a merge revision with three parents from two branches
3756
feature1a and feature1b:
3758
bzr merge ../feature1a
3759
bzr merge ../feature1b --force
3760
bzr commit -m 'revision with three parents'
3763
encoding_type = 'exact'
3764
_see_also = ['update', 'remerge', 'status-flags', 'send']
3765
takes_args = ['location?']
3770
help='Merge even if the destination tree has uncommitted changes.'),
3774
Option('show-base', help="Show base revision text in "
3776
Option('uncommitted', help='Apply uncommitted changes'
3777
' from a working copy, instead of branch changes.'),
3778
Option('pull', help='If the destination is already'
3779
' completely merged into the source, pull from the'
3780
' source rather than merging. When this happens,'
3781
' you do not need to commit the result.'),
3783
help='Branch to merge into, '
3784
'rather than the one containing the working directory.',
3788
Option('preview', help='Instead of merging, show a diff of the'
3790
Option('interactive', help='Select changes interactively.',
3794
def run(self, location=None, revision=None, force=False,
3795
merge_type=None, show_base=False, reprocess=None, remember=False,
3796
uncommitted=False, pull=False,
3801
if merge_type is None:
3802
merge_type = _mod_merge.Merge3Merger
3804
if directory is None: directory = u'.'
3805
possible_transports = []
3807
allow_pending = True
3808
verified = 'inapplicable'
3809
tree = WorkingTree.open_containing(directory)[0]
3812
basis_tree = tree.revision_tree(tree.last_revision())
3813
except errors.NoSuchRevision:
3814
basis_tree = tree.basis_tree()
3816
# die as quickly as possible if there are uncommitted changes
3818
if tree.has_changes():
3819
raise errors.UncommittedChanges(tree)
3821
view_info = _get_view_info_for_change_reporter(tree)
3822
change_reporter = delta._ChangeReporter(
3823
unversioned_filter=tree.is_ignored, view_info=view_info)
3824
pb = ui.ui_factory.nested_progress_bar()
3825
self.add_cleanup(pb.finished)
3827
self.add_cleanup(tree.unlock)
3828
if location is not None:
3830
mergeable = bundle.read_mergeable_from_url(location,
3831
possible_transports=possible_transports)
3832
except errors.NotABundle:
3836
raise errors.BzrCommandError('Cannot use --uncommitted'
3837
' with bundles or merge directives.')
3839
if revision is not None:
3840
raise errors.BzrCommandError(
3841
'Cannot use -r with merge directives or bundles')
3842
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3845
if merger is None and uncommitted:
3846
if revision is not None and len(revision) > 0:
3847
raise errors.BzrCommandError('Cannot use --uncommitted and'
3848
' --revision at the same time.')
3849
merger = self.get_merger_from_uncommitted(tree, location, None)
3850
allow_pending = False
3853
merger, allow_pending = self._get_merger_from_branch(tree,
3854
location, revision, remember, possible_transports, None)
3856
merger.merge_type = merge_type
3857
merger.reprocess = reprocess
3858
merger.show_base = show_base
3859
self.sanity_check_merger(merger)
3860
if (merger.base_rev_id == merger.other_rev_id and
3861
merger.other_rev_id is not None):
3862
note('Nothing to do.')
3865
if merger.interesting_files is not None:
3866
raise errors.BzrCommandError('Cannot pull individual files')
3867
if (merger.base_rev_id == tree.last_revision()):
3868
result = tree.pull(merger.other_branch, False,
3869
merger.other_rev_id)
3870
result.report(self.outf)
3872
if merger.this_basis is None:
3873
raise errors.BzrCommandError(
3874
"This branch has no commits."
3875
" (perhaps you would prefer 'bzr pull')")
3877
return self._do_preview(merger)
3879
return self._do_interactive(merger)
3881
return self._do_merge(merger, change_reporter, allow_pending,
3884
def _get_preview(self, merger):
3885
tree_merger = merger.make_merger()
3886
tt = tree_merger.make_preview_transform()
3887
self.add_cleanup(tt.finalize)
3888
result_tree = tt.get_preview_tree()
3891
def _do_preview(self, merger):
3892
from bzrlib.diff import show_diff_trees
3893
result_tree = self._get_preview(merger)
3894
show_diff_trees(merger.this_tree, result_tree, self.outf,
3895
old_label='', new_label='')
3897
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3898
merger.change_reporter = change_reporter
3899
conflict_count = merger.do_merge()
3901
merger.set_pending()
3902
if verified == 'failed':
3903
warning('Preview patch does not match changes')
3904
if conflict_count != 0:
3909
def _do_interactive(self, merger):
3910
"""Perform an interactive merge.
3912
This works by generating a preview tree of the merge, then using
3913
Shelver to selectively remove the differences between the working tree
3914
and the preview tree.
3916
from bzrlib import shelf_ui
3917
result_tree = self._get_preview(merger)
3918
writer = bzrlib.option.diff_writer_registry.get()
3919
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3920
reporter=shelf_ui.ApplyReporter(),
3921
diff_writer=writer(sys.stdout))
3927
def sanity_check_merger(self, merger):
3928
if (merger.show_base and
3929
not merger.merge_type is _mod_merge.Merge3Merger):
3930
raise errors.BzrCommandError("Show-base is not supported for this"
3931
" merge type. %s" % merger.merge_type)
3932
if merger.reprocess is None:
3933
if merger.show_base:
3934
merger.reprocess = False
3936
# Use reprocess if the merger supports it
3937
merger.reprocess = merger.merge_type.supports_reprocess
3938
if merger.reprocess and not merger.merge_type.supports_reprocess:
3939
raise errors.BzrCommandError("Conflict reduction is not supported"
3940
" for merge type %s." %
3942
if merger.reprocess and merger.show_base:
3943
raise errors.BzrCommandError("Cannot do conflict reduction and"
3946
def _get_merger_from_branch(self, tree, location, revision, remember,
3947
possible_transports, pb):
3948
"""Produce a merger from a location, assuming it refers to a branch."""
3949
from bzrlib.tag import _merge_tags_if_possible
3950
# find the branch locations
3951
other_loc, user_location = self._select_branch_location(tree, location,
3953
if revision is not None and len(revision) == 2:
3954
base_loc, _unused = self._select_branch_location(tree,
3955
location, revision, 0)
3957
base_loc = other_loc
3959
other_branch, other_path = Branch.open_containing(other_loc,
3960
possible_transports)
3961
if base_loc == other_loc:
3962
base_branch = other_branch
3964
base_branch, base_path = Branch.open_containing(base_loc,
3965
possible_transports)
3966
# Find the revision ids
3967
other_revision_id = None
3968
base_revision_id = None
3969
if revision is not None:
3970
if len(revision) >= 1:
3971
other_revision_id = revision[-1].as_revision_id(other_branch)
3972
if len(revision) == 2:
3973
base_revision_id = revision[0].as_revision_id(base_branch)
3974
if other_revision_id is None:
3975
other_revision_id = _mod_revision.ensure_null(
3976
other_branch.last_revision())
3977
# Remember where we merge from
3978
if ((remember or tree.branch.get_submit_branch() is None) and
3979
user_location is not None):
3980
tree.branch.set_submit_branch(other_branch.base)
3981
_merge_tags_if_possible(other_branch, tree.branch)
3982
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3983
other_revision_id, base_revision_id, other_branch, base_branch)
3984
if other_path != '':
3985
allow_pending = False
3986
merger.interesting_files = [other_path]
3988
allow_pending = True
3989
return merger, allow_pending
3991
def get_merger_from_uncommitted(self, tree, location, pb):
3992
"""Get a merger for uncommitted changes.
3994
:param tree: The tree the merger should apply to.
3995
:param location: The location containing uncommitted changes.
3996
:param pb: The progress bar to use for showing progress.
3998
location = self._select_branch_location(tree, location)[0]
3999
other_tree, other_path = WorkingTree.open_containing(location)
4000
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4001
if other_path != '':
4002
merger.interesting_files = [other_path]
4005
def _select_branch_location(self, tree, user_location, revision=None,
4007
"""Select a branch location, according to possible inputs.
4009
If provided, branches from ``revision`` are preferred. (Both
4010
``revision`` and ``index`` must be supplied.)
4012
Otherwise, the ``location`` parameter is used. If it is None, then the
4013
``submit`` or ``parent`` location is used, and a note is printed.
4015
:param tree: The working tree to select a branch for merging into
4016
:param location: The location entered by the user
4017
:param revision: The revision parameter to the command
4018
:param index: The index to use for the revision parameter. Negative
4019
indices are permitted.
4020
:return: (selected_location, user_location). The default location
4021
will be the user-entered location.
4023
if (revision is not None and index is not None
4024
and revision[index] is not None):
4025
branch = revision[index].get_branch()
4026
if branch is not None:
4027
return branch, branch
4028
if user_location is None:
4029
location = self._get_remembered(tree, 'Merging from')
4031
location = user_location
4032
return location, user_location
4034
def _get_remembered(self, tree, verb_string):
4035
"""Use tree.branch's parent if none was supplied.
4037
Report if the remembered location was used.
4039
stored_location = tree.branch.get_submit_branch()
4040
stored_location_type = "submit"
4041
if stored_location is None:
4042
stored_location = tree.branch.get_parent()
4043
stored_location_type = "parent"
4044
mutter("%s", stored_location)
4045
if stored_location is None:
4046
raise errors.BzrCommandError("No location specified or remembered")
4047
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4048
note(u"%s remembered %s location %s", verb_string,
4049
stored_location_type, display_url)
4050
return stored_location
4053
class cmd_remerge(Command):
4054
__doc__ = """Redo a merge.
4056
Use this if you want to try a different merge technique while resolving
4057
conflicts. Some merge techniques are better than others, and remerge
4058
lets you try different ones on different files.
4060
The options for remerge have the same meaning and defaults as the ones for
4061
merge. The difference is that remerge can (only) be run when there is a
4062
pending merge, and it lets you specify particular files.
4065
Re-do the merge of all conflicted files, and show the base text in
4066
conflict regions, in addition to the usual THIS and OTHER texts::
4068
bzr remerge --show-base
4070
Re-do the merge of "foobar", using the weave merge algorithm, with
4071
additional processing to reduce the size of conflict regions::
4073
bzr remerge --merge-type weave --reprocess foobar
4075
takes_args = ['file*']
4080
help="Show base revision text in conflicts."),
4083
def run(self, file_list=None, merge_type=None, show_base=False,
4085
from bzrlib.conflicts import restore
4086
if merge_type is None:
4087
merge_type = _mod_merge.Merge3Merger
4088
tree, file_list = tree_files(file_list)
4090
self.add_cleanup(tree.unlock)
4091
parents = tree.get_parent_ids()
4092
if len(parents) != 2:
4093
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4094
" merges. Not cherrypicking or"
4096
repository = tree.branch.repository
4097
interesting_ids = None
4099
conflicts = tree.conflicts()
4100
if file_list is not None:
4101
interesting_ids = set()
4102
for filename in file_list:
4103
file_id = tree.path2id(filename)
4105
raise errors.NotVersionedError(filename)
4106
interesting_ids.add(file_id)
4107
if tree.kind(file_id) != "directory":
4110
for name, ie in tree.inventory.iter_entries(file_id):
4111
interesting_ids.add(ie.file_id)
4112
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4114
# Remerge only supports resolving contents conflicts
4115
allowed_conflicts = ('text conflict', 'contents conflict')
4116
restore_files = [c.path for c in conflicts
4117
if c.typestring in allowed_conflicts]
4118
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4119
tree.set_conflicts(ConflictList(new_conflicts))
4120
if file_list is not None:
4121
restore_files = file_list
4122
for filename in restore_files:
4124
restore(tree.abspath(filename))
4125
except errors.NotConflicted:
4127
# Disable pending merges, because the file texts we are remerging
4128
# have not had those merges performed. If we use the wrong parents
4129
# list, we imply that the working tree text has seen and rejected
4130
# all the changes from the other tree, when in fact those changes
4131
# have not yet been seen.
4132
tree.set_parent_ids(parents[:1])
4134
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4135
merger.interesting_ids = interesting_ids
4136
merger.merge_type = merge_type
4137
merger.show_base = show_base
4138
merger.reprocess = reprocess
4139
conflicts = merger.do_merge()
4141
tree.set_parent_ids(parents)
4148
class cmd_revert(Command):
4149
__doc__ = """Revert files to a previous revision.
4151
Giving a list of files will revert only those files. Otherwise, all files
4152
will be reverted. If the revision is not specified with '--revision', the
4153
last committed revision is used.
4155
To remove only some changes, without reverting to a prior version, use
4156
merge instead. For example, "merge . --revision -2..-3" will remove the
4157
changes introduced by -2, without affecting the changes introduced by -1.
4158
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4160
By default, any files that have been manually changed will be backed up
4161
first. (Files changed only by merge are not backed up.) Backup files have
4162
'.~#~' appended to their name, where # is a number.
4164
When you provide files, you can use their current pathname or the pathname
4165
from the target revision. So you can use revert to "undelete" a file by
4166
name. If you name a directory, all the contents of that directory will be
4169
If you have newly added files since the target revision, they will be
4170
removed. If the files to be removed have been changed, backups will be
4171
created as above. Directories containing unknown files will not be
4174
The working tree contains a list of revisions that have been merged but
4175
not yet committed. These revisions will be included as additional parents
4176
of the next commit. Normally, using revert clears that list as well as
4177
reverting the files. If any files are specified, revert leaves the list
4178
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4179
.`` in the tree root to revert all files but keep the recorded merges,
4180
and ``bzr revert --forget-merges`` to clear the pending merge list without
4181
reverting any files.
4183
Using "bzr revert --forget-merges", it is possible to apply all of the
4184
changes from a branch in a single revision. To do this, perform the merge
4185
as desired. Then doing revert with the "--forget-merges" option will keep
4186
the content of the tree as it was, but it will clear the list of pending
4187
merges. The next commit will then contain all of the changes that are
4188
present in the other branch, but without any other parent revisions.
4189
Because this technique forgets where these changes originated, it may
4190
cause additional conflicts on later merges involving the same source and
4194
_see_also = ['cat', 'export']
4197
Option('no-backup', "Do not save backups of reverted files."),
4198
Option('forget-merges',
4199
'Remove pending merge marker, without changing any files.'),
4201
takes_args = ['file*']
4203
def run(self, revision=None, no_backup=False, file_list=None,
4204
forget_merges=None):
4205
tree, file_list = tree_files(file_list)
4206
tree.lock_tree_write()
4207
self.add_cleanup(tree.unlock)
4209
tree.set_parent_ids(tree.get_parent_ids()[:1])
4211
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4214
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4215
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4216
tree.revert(file_list, rev_tree, not no_backup, None,
4217
report_changes=True)
4220
class cmd_assert_fail(Command):
4221
__doc__ = """Test reporting of assertion failures"""
4222
# intended just for use in testing
4227
raise AssertionError("always fails")
4230
class cmd_help(Command):
4231
__doc__ = """Show help on a command or other topic.
4234
_see_also = ['topics']
4236
Option('long', 'Show help on all commands.'),
4238
takes_args = ['topic?']
4239
aliases = ['?', '--help', '-?', '-h']
4242
def run(self, topic=None, long=False):
4244
if topic is None and long:
4246
bzrlib.help.help(topic)
4249
class cmd_shell_complete(Command):
4250
__doc__ = """Show appropriate completions for context.
4252
For a list of all available commands, say 'bzr shell-complete'.
4254
takes_args = ['context?']
4259
def run(self, context=None):
4260
import shellcomplete
4261
shellcomplete.shellcomplete(context)
4264
class cmd_missing(Command):
4265
__doc__ = """Show unmerged/unpulled revisions between two branches.
4267
OTHER_BRANCH may be local or remote.
4269
To filter on a range of revisions, you can use the command -r begin..end
4270
-r revision requests a specific revision, -r ..end or -r begin.. are
4274
1 - some missing revisions
4275
0 - no missing revisions
4279
Determine the missing revisions between this and the branch at the
4280
remembered pull location::
4284
Determine the missing revisions between this and another branch::
4286
bzr missing http://server/branch
4288
Determine the missing revisions up to a specific revision on the other
4291
bzr missing -r ..-10
4293
Determine the missing revisions up to a specific revision on this
4296
bzr missing --my-revision ..-10
4299
_see_also = ['merge', 'pull']
4300
takes_args = ['other_branch?']
4302
Option('reverse', 'Reverse the order of revisions.'),
4304
'Display changes in the local branch only.'),
4305
Option('this' , 'Same as --mine-only.'),
4306
Option('theirs-only',
4307
'Display changes in the remote branch only.'),
4308
Option('other', 'Same as --theirs-only.'),
4312
custom_help('revision',
4313
help='Filter on other branch revisions (inclusive). '
4314
'See "help revisionspec" for details.'),
4315
Option('my-revision',
4316
type=_parse_revision_str,
4317
help='Filter on local branch revisions (inclusive). '
4318
'See "help revisionspec" for details.'),
4319
Option('include-merges',
4320
'Show all revisions in addition to the mainline ones.'),
4322
encoding_type = 'replace'
4325
def run(self, other_branch=None, reverse=False, mine_only=False,
4327
log_format=None, long=False, short=False, line=False,
4328
show_ids=False, verbose=False, this=False, other=False,
4329
include_merges=False, revision=None, my_revision=None):
4330
from bzrlib.missing import find_unmerged, iter_log_revisions
4339
# TODO: We should probably check that we don't have mine-only and
4340
# theirs-only set, but it gets complicated because we also have
4341
# this and other which could be used.
4348
local_branch = Branch.open_containing(u".")[0]
4349
local_branch.lock_read()
4350
self.add_cleanup(local_branch.unlock)
4352
parent = local_branch.get_parent()
4353
if other_branch is None:
4354
other_branch = parent
4355
if other_branch is None:
4356
raise errors.BzrCommandError("No peer location known"
4358
display_url = urlutils.unescape_for_display(parent,
4360
message("Using saved parent location: "
4361
+ display_url + "\n")
4363
remote_branch = Branch.open(other_branch)
4364
if remote_branch.base == local_branch.base:
4365
remote_branch = local_branch
4367
remote_branch.lock_read()
4368
self.add_cleanup(remote_branch.unlock)
4370
local_revid_range = _revision_range_to_revid_range(
4371
_get_revision_range(my_revision, local_branch,
4374
remote_revid_range = _revision_range_to_revid_range(
4375
_get_revision_range(revision,
4376
remote_branch, self.name()))
4378
local_extra, remote_extra = find_unmerged(
4379
local_branch, remote_branch, restrict,
4380
backward=not reverse,
4381
include_merges=include_merges,
4382
local_revid_range=local_revid_range,
4383
remote_revid_range=remote_revid_range)
4385
if log_format is None:
4386
registry = log.log_formatter_registry
4387
log_format = registry.get_default(local_branch)
4388
lf = log_format(to_file=self.outf,
4390
show_timezone='original')
4393
if local_extra and not theirs_only:
4394
message("You have %d extra revision(s):\n" %
4396
for revision in iter_log_revisions(local_extra,
4397
local_branch.repository,
4399
lf.log_revision(revision)
4400
printed_local = True
4403
printed_local = False
4405
if remote_extra and not mine_only:
4406
if printed_local is True:
4408
message("You are missing %d revision(s):\n" %
4410
for revision in iter_log_revisions(remote_extra,
4411
remote_branch.repository,
4413
lf.log_revision(revision)
4416
if mine_only and not local_extra:
4417
# We checked local, and found nothing extra
4418
message('This branch is up to date.\n')
4419
elif theirs_only and not remote_extra:
4420
# We checked remote, and found nothing extra
4421
message('Other branch is up to date.\n')
4422
elif not (mine_only or theirs_only or local_extra or
4424
# We checked both branches, and neither one had extra
4426
message("Branches are up to date.\n")
4428
if not status_code and parent is None and other_branch is not None:
4429
local_branch.lock_write()
4430
self.add_cleanup(local_branch.unlock)
4431
# handle race conditions - a parent might be set while we run.
4432
if local_branch.get_parent() is None:
4433
local_branch.set_parent(remote_branch.base)
4437
class cmd_pack(Command):
4438
__doc__ = """Compress the data within a repository.
4440
This operation compresses the data within a bazaar repository. As
4441
bazaar supports automatic packing of repository, this operation is
4442
normally not required to be done manually.
4444
During the pack operation, bazaar takes a backup of existing repository
4445
data, i.e. pack files. This backup is eventually removed by bazaar
4446
automatically when it is safe to do so. To save disk space by removing
4447
the backed up pack files, the --clean-obsolete-packs option may be
4450
Warning: If you use --clean-obsolete-packs and your machine crashes
4451
during or immediately after repacking, you may be left with a state
4452
where the deletion has been written to disk but the new packs have not
4453
been. In this case the repository may be unusable.
4456
_see_also = ['repositories']
4457
takes_args = ['branch_or_repo?']
4459
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4462
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4463
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4465
branch = dir.open_branch()
4466
repository = branch.repository
4467
except errors.NotBranchError:
4468
repository = dir.open_repository()
4469
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4472
class cmd_plugins(Command):
4473
__doc__ = """List the installed plugins.
4475
This command displays the list of installed plugins including
4476
version of plugin and a short description of each.
4478
--verbose shows the path where each plugin is located.
4480
A plugin is an external component for Bazaar that extends the
4481
revision control system, by adding or replacing code in Bazaar.
4482
Plugins can do a variety of things, including overriding commands,
4483
adding new commands, providing additional network transports and
4484
customizing log output.
4486
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4487
for further information on plugins including where to find them and how to
4488
install them. Instructions are also provided there on how to write new
4489
plugins using the Python programming language.
4491
takes_options = ['verbose']
4494
def run(self, verbose=False):
4495
import bzrlib.plugin
4496
from inspect import getdoc
4498
for name, plugin in bzrlib.plugin.plugins().items():
4499
version = plugin.__version__
4500
if version == 'unknown':
4502
name_ver = '%s %s' % (name, version)
4503
d = getdoc(plugin.module)
4505
doc = d.split('\n')[0]
4507
doc = '(no description)'
4508
result.append((name_ver, doc, plugin.path()))
4509
for name_ver, doc, path in sorted(result):
4510
self.outf.write("%s\n" % name_ver)
4511
self.outf.write(" %s\n" % doc)
4513
self.outf.write(" %s\n" % path)
4514
self.outf.write("\n")
4517
class cmd_testament(Command):
4518
__doc__ = """Show testament (signing-form) of a revision."""
4521
Option('long', help='Produce long-format testament.'),
4523
help='Produce a strict-format testament.')]
4524
takes_args = ['branch?']
4526
def run(self, branch=u'.', revision=None, long=False, strict=False):
4527
from bzrlib.testament import Testament, StrictTestament
4529
testament_class = StrictTestament
4531
testament_class = Testament
4533
b = Branch.open_containing(branch)[0]
4535
b = Branch.open(branch)
4537
self.add_cleanup(b.unlock)
4538
if revision is None:
4539
rev_id = b.last_revision()
4541
rev_id = revision[0].as_revision_id(b)
4542
t = testament_class.from_revision(b.repository, rev_id)
4544
sys.stdout.writelines(t.as_text_lines())
4546
sys.stdout.write(t.as_short_text())
4549
class cmd_annotate(Command):
4550
__doc__ = """Show the origin of each line in a file.
4552
This prints out the given file with an annotation on the left side
4553
indicating which revision, author and date introduced the change.
4555
If the origin is the same for a run of consecutive lines, it is
4556
shown only at the top, unless the --all option is given.
4558
# TODO: annotate directories; showing when each file was last changed
4559
# TODO: if the working copy is modified, show annotations on that
4560
# with new uncommitted lines marked
4561
aliases = ['ann', 'blame', 'praise']
4562
takes_args = ['filename']
4563
takes_options = [Option('all', help='Show annotations on all lines.'),
4564
Option('long', help='Show commit date in annotations.'),
4568
encoding_type = 'exact'
4571
def run(self, filename, all=False, long=False, revision=None,
4573
from bzrlib.annotate import annotate_file, annotate_file_tree
4574
wt, branch, relpath = \
4575
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4578
self.add_cleanup(wt.unlock)
4581
self.add_cleanup(branch.unlock)
4582
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4584
self.add_cleanup(tree.unlock)
4586
file_id = wt.path2id(relpath)
4588
file_id = tree.path2id(relpath)
4590
raise errors.NotVersionedError(filename)
4591
file_version = tree.inventory[file_id].revision
4592
if wt is not None and revision is None:
4593
# If there is a tree and we're not annotating historical
4594
# versions, annotate the working tree's content.
4595
annotate_file_tree(wt, file_id, self.outf, long, all,
4598
annotate_file(branch, file_version, file_id, long, all, self.outf,
4602
class cmd_re_sign(Command):
4603
__doc__ = """Create a digital signature for an existing revision."""
4604
# TODO be able to replace existing ones.
4606
hidden = True # is this right ?
4607
takes_args = ['revision_id*']
4608
takes_options = ['revision']
4610
def run(self, revision_id_list=None, revision=None):
4611
if revision_id_list is not None and revision is not None:
4612
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4613
if revision_id_list is None and revision is None:
4614
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4615
b = WorkingTree.open_containing(u'.')[0].branch
4617
self.add_cleanup(b.unlock)
4618
return self._run(b, revision_id_list, revision)
4620
def _run(self, b, revision_id_list, revision):
4621
import bzrlib.gpg as gpg
4622
gpg_strategy = gpg.GPGStrategy(b.get_config())
4623
if revision_id_list is not None:
4624
b.repository.start_write_group()
4626
for revision_id in revision_id_list:
4627
b.repository.sign_revision(revision_id, gpg_strategy)
4629
b.repository.abort_write_group()
4632
b.repository.commit_write_group()
4633
elif revision is not None:
4634
if len(revision) == 1:
4635
revno, rev_id = revision[0].in_history(b)
4636
b.repository.start_write_group()
4638
b.repository.sign_revision(rev_id, gpg_strategy)
4640
b.repository.abort_write_group()
4643
b.repository.commit_write_group()
4644
elif len(revision) == 2:
4645
# are they both on rh- if so we can walk between them
4646
# might be nice to have a range helper for arbitrary
4647
# revision paths. hmm.
4648
from_revno, from_revid = revision[0].in_history(b)
4649
to_revno, to_revid = revision[1].in_history(b)
4650
if to_revid is None:
4651
to_revno = b.revno()
4652
if from_revno is None or to_revno is None:
4653
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4654
b.repository.start_write_group()
4656
for revno in range(from_revno, to_revno + 1):
4657
b.repository.sign_revision(b.get_rev_id(revno),
4660
b.repository.abort_write_group()
4663
b.repository.commit_write_group()
4665
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4668
class cmd_bind(Command):
4669
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4671
Once converted into a checkout, commits must succeed on the master branch
4672
before they will be applied to the local branch.
4674
Bound branches use the nickname of its master branch unless it is set
4675
locally, in which case binding will update the local nickname to be
4679
_see_also = ['checkouts', 'unbind']
4680
takes_args = ['location?']
4683
def run(self, location=None):
4684
b, relpath = Branch.open_containing(u'.')
4685
if location is None:
4687
location = b.get_old_bound_location()
4688
except errors.UpgradeRequired:
4689
raise errors.BzrCommandError('No location supplied. '
4690
'This format does not remember old locations.')
4692
if location is None:
4693
if b.get_bound_location() is not None:
4694
raise errors.BzrCommandError('Branch is already bound')
4696
raise errors.BzrCommandError('No location supplied '
4697
'and no previous location known')
4698
b_other = Branch.open(location)
4701
except errors.DivergedBranches:
4702
raise errors.BzrCommandError('These branches have diverged.'
4703
' Try merging, and then bind again.')
4704
if b.get_config().has_explicit_nickname():
4705
b.nick = b_other.nick
4708
class cmd_unbind(Command):
4709
__doc__ = """Convert the current checkout into a regular branch.
4711
After unbinding, the local branch is considered independent and subsequent
4712
commits will be local only.
4715
_see_also = ['checkouts', 'bind']
4720
b, relpath = Branch.open_containing(u'.')
4722
raise errors.BzrCommandError('Local branch is not bound')
4725
class cmd_uncommit(Command):
4726
__doc__ = """Remove the last committed revision.
4728
--verbose will print out what is being removed.
4729
--dry-run will go through all the motions, but not actually
4732
If --revision is specified, uncommit revisions to leave the branch at the
4733
specified revision. For example, "bzr uncommit -r 15" will leave the
4734
branch at revision 15.
4736
Uncommit leaves the working tree ready for a new commit. The only change
4737
it may make is to restore any pending merges that were present before
4741
# TODO: jam 20060108 Add an option to allow uncommit to remove
4742
# unreferenced information in 'branch-as-repository' branches.
4743
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4744
# information in shared branches as well.
4745
_see_also = ['commit']
4746
takes_options = ['verbose', 'revision',
4747
Option('dry-run', help='Don\'t actually make changes.'),
4748
Option('force', help='Say yes to all questions.'),
4750
help="Only remove the commits from the local branch"
4751
" when in a checkout."
4754
takes_args = ['location?']
4756
encoding_type = 'replace'
4758
def run(self, location=None,
4759
dry_run=False, verbose=False,
4760
revision=None, force=False, local=False):
4761
if location is None:
4763
control, relpath = bzrdir.BzrDir.open_containing(location)
4765
tree = control.open_workingtree()
4767
except (errors.NoWorkingTree, errors.NotLocalUrl):
4769
b = control.open_branch()
4771
if tree is not None:
4773
self.add_cleanup(tree.unlock)
4776
self.add_cleanup(b.unlock)
4777
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4779
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4780
from bzrlib.log import log_formatter, show_log
4781
from bzrlib.uncommit import uncommit
4783
last_revno, last_rev_id = b.last_revision_info()
4786
if revision is None:
4788
rev_id = last_rev_id
4790
# 'bzr uncommit -r 10' actually means uncommit
4791
# so that the final tree is at revno 10.
4792
# but bzrlib.uncommit.uncommit() actually uncommits
4793
# the revisions that are supplied.
4794
# So we need to offset it by one
4795
revno = revision[0].in_history(b).revno + 1
4796
if revno <= last_revno:
4797
rev_id = b.get_rev_id(revno)
4799
if rev_id is None or _mod_revision.is_null(rev_id):
4800
self.outf.write('No revisions to uncommit.\n')
4803
lf = log_formatter('short',
4805
show_timezone='original')
4810
direction='forward',
4811
start_revision=revno,
4812
end_revision=last_revno)
4815
self.outf.write('Dry-run, pretending to remove'
4816
' the above revisions.\n')
4818
self.outf.write('The above revision(s) will be removed.\n')
4821
if not ui.ui_factory.get_boolean('Are you sure'):
4822
self.outf.write('Canceled')
4825
mutter('Uncommitting from {%s} to {%s}',
4826
last_rev_id, rev_id)
4827
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4828
revno=revno, local=local)
4829
self.outf.write('You can restore the old tip by running:\n'
4830
' bzr pull . -r revid:%s\n' % last_rev_id)
4833
class cmd_break_lock(Command):
4834
__doc__ = """Break a dead lock on a repository, branch or working directory.
4836
CAUTION: Locks should only be broken when you are sure that the process
4837
holding the lock has been stopped.
4839
You can get information on what locks are open via the 'bzr info
4840
[location]' command.
4844
bzr break-lock bzr+ssh://example.com/bzr/foo
4846
takes_args = ['location?']
4848
def run(self, location=None, show=False):
4849
if location is None:
4851
control, relpath = bzrdir.BzrDir.open_containing(location)
4853
control.break_lock()
4854
except NotImplementedError:
4858
class cmd_wait_until_signalled(Command):
4859
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4861
This just prints a line to signal when it is ready, then blocks on stdin.
4867
sys.stdout.write("running\n")
4869
sys.stdin.readline()
4872
class cmd_serve(Command):
4873
__doc__ = """Run the bzr server."""
4875
aliases = ['server']
4879
help='Serve on stdin/out for use from inetd or sshd.'),
4880
RegistryOption('protocol',
4881
help="Protocol to serve.",
4882
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4883
value_switches=True),
4885
help='Listen for connections on nominated port of the form '
4886
'[hostname:]portnumber. Passing 0 as the port number will '
4887
'result in a dynamically allocated port. The default port '
4888
'depends on the protocol.',
4891
help='Serve contents of this directory.',
4893
Option('allow-writes',
4894
help='By default the server is a readonly server. Supplying '
4895
'--allow-writes enables write access to the contents of '
4896
'the served directory and below. Note that ``bzr serve`` '
4897
'does not perform authentication, so unless some form of '
4898
'external authentication is arranged supplying this '
4899
'option leads to global uncontrolled write access to your '
4904
def get_host_and_port(self, port):
4905
"""Return the host and port to run the smart server on.
4907
If 'port' is None, None will be returned for the host and port.
4909
If 'port' has a colon in it, the string before the colon will be
4910
interpreted as the host.
4912
:param port: A string of the port to run the server on.
4913
:return: A tuple of (host, port), where 'host' is a host name or IP,
4914
and port is an integer TCP/IP port.
4917
if port is not None:
4919
host, port = port.split(':')
4923
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4925
from bzrlib.transport import get_transport, transport_server_registry
4926
if directory is None:
4927
directory = os.getcwd()
4928
if protocol is None:
4929
protocol = transport_server_registry.get()
4930
host, port = self.get_host_and_port(port)
4931
url = urlutils.local_path_to_url(directory)
4932
if not allow_writes:
4933
url = 'readonly+' + url
4934
transport = get_transport(url)
4935
protocol(transport, host, port, inet)
4938
class cmd_join(Command):
4939
__doc__ = """Combine a tree into its containing tree.
4941
This command requires the target tree to be in a rich-root format.
4943
The TREE argument should be an independent tree, inside another tree, but
4944
not part of it. (Such trees can be produced by "bzr split", but also by
4945
running "bzr branch" with the target inside a tree.)
4947
The result is a combined tree, with the subtree no longer an independant
4948
part. This is marked as a merge of the subtree into the containing tree,
4949
and all history is preserved.
4952
_see_also = ['split']
4953
takes_args = ['tree']
4955
Option('reference', help='Join by reference.', hidden=True),
4958
def run(self, tree, reference=False):
4959
sub_tree = WorkingTree.open(tree)
4960
parent_dir = osutils.dirname(sub_tree.basedir)
4961
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4962
repo = containing_tree.branch.repository
4963
if not repo.supports_rich_root():
4964
raise errors.BzrCommandError(
4965
"Can't join trees because %s doesn't support rich root data.\n"
4966
"You can use bzr upgrade on the repository."
4970
containing_tree.add_reference(sub_tree)
4971
except errors.BadReferenceTarget, e:
4972
# XXX: Would be better to just raise a nicely printable
4973
# exception from the real origin. Also below. mbp 20070306
4974
raise errors.BzrCommandError("Cannot join %s. %s" %
4978
containing_tree.subsume(sub_tree)
4979
except errors.BadSubsumeSource, e:
4980
raise errors.BzrCommandError("Cannot join %s. %s" %
4984
class cmd_split(Command):
4985
__doc__ = """Split a subdirectory of a tree into a separate tree.
4987
This command will produce a target tree in a format that supports
4988
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4989
converted into earlier formats like 'dirstate-tags'.
4991
The TREE argument should be a subdirectory of a working tree. That
4992
subdirectory will be converted into an independent tree, with its own
4993
branch. Commits in the top-level tree will not apply to the new subtree.
4996
_see_also = ['join']
4997
takes_args = ['tree']
4999
def run(self, tree):
5000
containing_tree, subdir = WorkingTree.open_containing(tree)
5001
sub_id = containing_tree.path2id(subdir)
5003
raise errors.NotVersionedError(subdir)
5005
containing_tree.extract(sub_id)
5006
except errors.RootNotRich:
5007
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5010
class cmd_merge_directive(Command):
5011
__doc__ = """Generate a merge directive for auto-merge tools.
5013
A directive requests a merge to be performed, and also provides all the
5014
information necessary to do so. This means it must either include a
5015
revision bundle, or the location of a branch containing the desired
5018
A submit branch (the location to merge into) must be supplied the first
5019
time the command is issued. After it has been supplied once, it will
5020
be remembered as the default.
5022
A public branch is optional if a revision bundle is supplied, but required
5023
if --diff or --plain is specified. It will be remembered as the default
5024
after the first use.
5027
takes_args = ['submit_branch?', 'public_branch?']
5031
_see_also = ['send']
5034
RegistryOption.from_kwargs('patch-type',
5035
'The type of patch to include in the directive.',
5037
value_switches=True,
5039
bundle='Bazaar revision bundle (default).',
5040
diff='Normal unified diff.',
5041
plain='No patch, just directive.'),
5042
Option('sign', help='GPG-sign the directive.'), 'revision',
5043
Option('mail-to', type=str,
5044
help='Instead of printing the directive, email to this address.'),
5045
Option('message', type=str, short_name='m',
5046
help='Message to use when committing this merge.')
5049
encoding_type = 'exact'
5051
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5052
sign=False, revision=None, mail_to=None, message=None):
5053
from bzrlib.revision import ensure_null, NULL_REVISION
5054
include_patch, include_bundle = {
5055
'plain': (False, False),
5056
'diff': (True, False),
5057
'bundle': (True, True),
5059
branch = Branch.open('.')
5060
stored_submit_branch = branch.get_submit_branch()
5061
if submit_branch is None:
5062
submit_branch = stored_submit_branch
5064
if stored_submit_branch is None:
5065
branch.set_submit_branch(submit_branch)
5066
if submit_branch is None:
5067
submit_branch = branch.get_parent()
5068
if submit_branch is None:
5069
raise errors.BzrCommandError('No submit branch specified or known')
5071
stored_public_branch = branch.get_public_branch()
5072
if public_branch is None:
5073
public_branch = stored_public_branch
5074
elif stored_public_branch is None:
5075
branch.set_public_branch(public_branch)
5076
if not include_bundle and public_branch is None:
5077
raise errors.BzrCommandError('No public branch specified or'
5079
base_revision_id = None
5080
if revision is not None:
5081
if len(revision) > 2:
5082
raise errors.BzrCommandError('bzr merge-directive takes '
5083
'at most two one revision identifiers')
5084
revision_id = revision[-1].as_revision_id(branch)
5085
if len(revision) == 2:
5086
base_revision_id = revision[0].as_revision_id(branch)
5088
revision_id = branch.last_revision()
5089
revision_id = ensure_null(revision_id)
5090
if revision_id == NULL_REVISION:
5091
raise errors.BzrCommandError('No revisions to bundle.')
5092
directive = merge_directive.MergeDirective2.from_objects(
5093
branch.repository, revision_id, time.time(),
5094
osutils.local_time_offset(), submit_branch,
5095
public_branch=public_branch, include_patch=include_patch,
5096
include_bundle=include_bundle, message=message,
5097
base_revision_id=base_revision_id)
5100
self.outf.write(directive.to_signed(branch))
5102
self.outf.writelines(directive.to_lines())
5104
message = directive.to_email(mail_to, branch, sign)
5105
s = SMTPConnection(branch.get_config())
5106
s.send_email(message)
5109
class cmd_send(Command):
5110
__doc__ = """Mail or create a merge-directive for submitting changes.
5112
A merge directive provides many things needed for requesting merges:
5114
* A machine-readable description of the merge to perform
5116
* An optional patch that is a preview of the changes requested
5118
* An optional bundle of revision data, so that the changes can be applied
5119
directly from the merge directive, without retrieving data from a
5122
`bzr send` creates a compact data set that, when applied using bzr
5123
merge, has the same effect as merging from the source branch.
5125
By default the merge directive is self-contained and can be applied to any
5126
branch containing submit_branch in its ancestory without needing access to
5129
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5130
revisions, but only a structured request to merge from the
5131
public_location. In that case the public_branch is needed and it must be
5132
up-to-date and accessible to the recipient. The public_branch is always
5133
included if known, so that people can check it later.
5135
The submit branch defaults to the parent of the source branch, but can be
5136
overridden. Both submit branch and public branch will be remembered in
5137
branch.conf the first time they are used for a particular branch. The
5138
source branch defaults to that containing the working directory, but can
5139
be changed using --from.
5141
In order to calculate those changes, bzr must analyse the submit branch.
5142
Therefore it is most efficient for the submit branch to be a local mirror.
5143
If a public location is known for the submit_branch, that location is used
5144
in the merge directive.
5146
The default behaviour is to send the merge directive by mail, unless -o is
5147
given, in which case it is sent to a file.
5149
Mail is sent using your preferred mail program. This should be transparent
5150
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5151
If the preferred client can't be found (or used), your editor will be used.
5153
To use a specific mail program, set the mail_client configuration option.
5154
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5155
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5156
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5157
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5160
If mail is being sent, a to address is required. This can be supplied
5161
either on the commandline, by setting the submit_to configuration
5162
option in the branch itself or the child_submit_to configuration option
5163
in the submit branch.
5165
Two formats are currently supported: "4" uses revision bundle format 4 and
5166
merge directive format 2. It is significantly faster and smaller than
5167
older formats. It is compatible with Bazaar 0.19 and later. It is the
5168
default. "0.9" uses revision bundle format 0.9 and merge directive
5169
format 1. It is compatible with Bazaar 0.12 - 0.18.
5171
The merge directives created by bzr send may be applied using bzr merge or
5172
bzr pull by specifying a file containing a merge directive as the location.
5174
bzr send makes extensive use of public locations to map local locations into
5175
URLs that can be used by other people. See `bzr help configuration` to
5176
set them, and use `bzr info` to display them.
5179
encoding_type = 'exact'
5181
_see_also = ['merge', 'pull']
5183
takes_args = ['submit_branch?', 'public_branch?']
5187
help='Do not include a bundle in the merge directive.'),
5188
Option('no-patch', help='Do not include a preview patch in the merge'
5191
help='Remember submit and public branch.'),
5193
help='Branch to generate the submission from, '
5194
'rather than the one containing the working directory.',
5197
Option('output', short_name='o',
5198
help='Write merge directive to this file or directory; '
5199
'use - for stdout.',
5202
help='Refuse to send if there are uncommitted changes in'
5203
' the working tree, --no-strict disables the check.'),
5204
Option('mail-to', help='Mail the request to this address.',
5208
Option('body', help='Body for the email.', type=unicode),
5209
RegistryOption('format',
5210
help='Use the specified output format.',
5211
lazy_registry=('bzrlib.send', 'format_registry')),
5214
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5215
no_patch=False, revision=None, remember=False, output=None,
5216
format=None, mail_to=None, message=None, body=None,
5217
strict=None, **kwargs):
5218
from bzrlib.send import send
5219
return send(submit_branch, revision, public_branch, remember,
5220
format, no_bundle, no_patch, output,
5221
kwargs.get('from', '.'), mail_to, message, body,
5226
class cmd_bundle_revisions(cmd_send):
5227
__doc__ = """Create a merge-directive for submitting changes.
5229
A merge directive provides many things needed for requesting merges:
5231
* A machine-readable description of the merge to perform
5233
* An optional patch that is a preview of the changes requested
5235
* An optional bundle of revision data, so that the changes can be applied
5236
directly from the merge directive, without retrieving data from a
5239
If --no-bundle is specified, then public_branch is needed (and must be
5240
up-to-date), so that the receiver can perform the merge using the
5241
public_branch. The public_branch is always included if known, so that
5242
people can check it later.
5244
The submit branch defaults to the parent, but can be overridden. Both
5245
submit branch and public branch will be remembered if supplied.
5247
If a public_branch is known for the submit_branch, that public submit
5248
branch is used in the merge instructions. This means that a local mirror
5249
can be used as your actual submit branch, once you have set public_branch
5252
Two formats are currently supported: "4" uses revision bundle format 4 and
5253
merge directive format 2. It is significantly faster and smaller than
5254
older formats. It is compatible with Bazaar 0.19 and later. It is the
5255
default. "0.9" uses revision bundle format 0.9 and merge directive
5256
format 1. It is compatible with Bazaar 0.12 - 0.18.
5261
help='Do not include a bundle in the merge directive.'),
5262
Option('no-patch', help='Do not include a preview patch in the merge'
5265
help='Remember submit and public branch.'),
5267
help='Branch to generate the submission from, '
5268
'rather than the one containing the working directory.',
5271
Option('output', short_name='o', help='Write directive to this file.',
5274
help='Refuse to bundle revisions if there are uncommitted'
5275
' changes in the working tree, --no-strict disables the check.'),
5277
RegistryOption('format',
5278
help='Use the specified output format.',
5279
lazy_registry=('bzrlib.send', 'format_registry')),
5281
aliases = ['bundle']
5283
_see_also = ['send', 'merge']
5287
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5288
no_patch=False, revision=None, remember=False, output=None,
5289
format=None, strict=None, **kwargs):
5292
from bzrlib.send import send
5293
return send(submit_branch, revision, public_branch, remember,
5294
format, no_bundle, no_patch, output,
5295
kwargs.get('from', '.'), None, None, None,
5296
self.outf, strict=strict)
5299
class cmd_tag(Command):
5300
__doc__ = """Create, remove or modify a tag naming a revision.
5302
Tags give human-meaningful names to revisions. Commands that take a -r
5303
(--revision) option can be given -rtag:X, where X is any previously
5306
Tags are stored in the branch. Tags are copied from one branch to another
5307
along when you branch, push, pull or merge.
5309
It is an error to give a tag name that already exists unless you pass
5310
--force, in which case the tag is moved to point to the new revision.
5312
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5313
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5315
If no tag name is specified it will be determined through the
5316
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5317
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5321
_see_also = ['commit', 'tags']
5322
takes_args = ['tag_name?']
5325
help='Delete this tag rather than placing it.',
5328
help='Branch in which to place the tag.',
5333
help='Replace existing tags.',
5338
def run(self, tag_name=None,
5344
branch, relpath = Branch.open_containing(directory)
5346
self.add_cleanup(branch.unlock)
5348
if tag_name is None:
5349
raise errors.BzrCommandError("No tag specified to delete.")
5350
branch.tags.delete_tag(tag_name)
5351
self.outf.write('Deleted tag %s.\n' % tag_name)
5354
if len(revision) != 1:
5355
raise errors.BzrCommandError(
5356
"Tags can only be placed on a single revision, "
5358
revision_id = revision[0].as_revision_id(branch)
5360
revision_id = branch.last_revision()
5361
if tag_name is None:
5362
tag_name = branch.automatic_tag_name(revision_id)
5363
if tag_name is None:
5364
raise errors.BzrCommandError(
5365
"Please specify a tag name.")
5366
if (not force) and branch.tags.has_tag(tag_name):
5367
raise errors.TagAlreadyExists(tag_name)
5368
branch.tags.set_tag(tag_name, revision_id)
5369
self.outf.write('Created tag %s.\n' % tag_name)
5372
class cmd_tags(Command):
5373
__doc__ = """List tags.
5375
This command shows a table of tag names and the revisions they reference.
5381
help='Branch whose tags should be displayed.',
5385
RegistryOption.from_kwargs('sort',
5386
'Sort tags by different criteria.', title='Sorting',
5387
alpha='Sort tags lexicographically (default).',
5388
time='Sort tags chronologically.',
5401
branch, relpath = Branch.open_containing(directory)
5403
tags = branch.tags.get_tag_dict().items()
5408
self.add_cleanup(branch.unlock)
5410
graph = branch.repository.get_graph()
5411
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5412
revid1, revid2 = rev1.rev_id, rev2.rev_id
5413
# only show revisions between revid1 and revid2 (inclusive)
5414
tags = [(tag, revid) for tag, revid in tags if
5415
graph.is_between(revid, revid1, revid2)]
5418
elif sort == 'time':
5420
for tag, revid in tags:
5422
revobj = branch.repository.get_revision(revid)
5423
except errors.NoSuchRevision:
5424
timestamp = sys.maxint # place them at the end
5426
timestamp = revobj.timestamp
5427
timestamps[revid] = timestamp
5428
tags.sort(key=lambda x: timestamps[x[1]])
5430
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5431
for index, (tag, revid) in enumerate(tags):
5433
revno = branch.revision_id_to_dotted_revno(revid)
5434
if isinstance(revno, tuple):
5435
revno = '.'.join(map(str, revno))
5436
except errors.NoSuchRevision:
5437
# Bad tag data/merges can lead to tagged revisions
5438
# which are not in this branch. Fail gracefully ...
5440
tags[index] = (tag, revno)
5442
for tag, revspec in tags:
5443
self.outf.write('%-20s %s\n' % (tag, revspec))
5446
class cmd_reconfigure(Command):
5447
__doc__ = """Reconfigure the type of a bzr directory.
5449
A target configuration must be specified.
5451
For checkouts, the bind-to location will be auto-detected if not specified.
5452
The order of preference is
5453
1. For a lightweight checkout, the current bound location.
5454
2. For branches that used to be checkouts, the previously-bound location.
5455
3. The push location.
5456
4. The parent location.
5457
If none of these is available, --bind-to must be specified.
5460
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5461
takes_args = ['location?']
5463
RegistryOption.from_kwargs(
5465
title='Target type',
5466
help='The type to reconfigure the directory to.',
5467
value_switches=True, enum_switch=False,
5468
branch='Reconfigure to be an unbound branch with no working tree.',
5469
tree='Reconfigure to be an unbound branch with a working tree.',
5470
checkout='Reconfigure to be a bound branch with a working tree.',
5471
lightweight_checkout='Reconfigure to be a lightweight'
5472
' checkout (with no local history).',
5473
standalone='Reconfigure to be a standalone branch '
5474
'(i.e. stop using shared repository).',
5475
use_shared='Reconfigure to use a shared repository.',
5476
with_trees='Reconfigure repository to create '
5477
'working trees on branches by default.',
5478
with_no_trees='Reconfigure repository to not create '
5479
'working trees on branches by default.'
5481
Option('bind-to', help='Branch to bind checkout to.', type=str),
5483
help='Perform reconfiguration even if local changes'
5485
Option('stacked-on',
5486
help='Reconfigure a branch to be stacked on another branch.',
5490
help='Reconfigure a branch to be unstacked. This '
5491
'may require copying substantial data into it.',
5495
def run(self, location=None, target_type=None, bind_to=None, force=False,
5498
directory = bzrdir.BzrDir.open(location)
5499
if stacked_on and unstacked:
5500
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5501
elif stacked_on is not None:
5502
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5504
reconfigure.ReconfigureUnstacked().apply(directory)
5505
# At the moment you can use --stacked-on and a different
5506
# reconfiguration shape at the same time; there seems no good reason
5508
if target_type is None:
5509
if stacked_on or unstacked:
5512
raise errors.BzrCommandError('No target configuration '
5514
elif target_type == 'branch':
5515
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5516
elif target_type == 'tree':
5517
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5518
elif target_type == 'checkout':
5519
reconfiguration = reconfigure.Reconfigure.to_checkout(
5521
elif target_type == 'lightweight-checkout':
5522
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5524
elif target_type == 'use-shared':
5525
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5526
elif target_type == 'standalone':
5527
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5528
elif target_type == 'with-trees':
5529
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5531
elif target_type == 'with-no-trees':
5532
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5534
reconfiguration.apply(force)
5537
class cmd_switch(Command):
5538
__doc__ = """Set the branch of a checkout and update.
5540
For lightweight checkouts, this changes the branch being referenced.
5541
For heavyweight checkouts, this checks that there are no local commits
5542
versus the current bound branch, then it makes the local branch a mirror
5543
of the new location and binds to it.
5545
In both cases, the working tree is updated and uncommitted changes
5546
are merged. The user can commit or revert these as they desire.
5548
Pending merges need to be committed or reverted before using switch.
5550
The path to the branch to switch to can be specified relative to the parent
5551
directory of the current branch. For example, if you are currently in a
5552
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5555
Bound branches use the nickname of its master branch unless it is set
5556
locally, in which case switching will update the local nickname to be
5560
takes_args = ['to_location?']
5561
takes_options = [Option('force',
5562
help='Switch even if local commits will be lost.'),
5564
Option('create-branch', short_name='b',
5565
help='Create the target branch from this one before'
5566
' switching to it.'),
5569
def run(self, to_location=None, force=False, create_branch=False,
5571
from bzrlib import switch
5573
revision = _get_one_revision('switch', revision)
5574
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5575
if to_location is None:
5576
if revision is None:
5577
raise errors.BzrCommandError('You must supply either a'
5578
' revision or a location')
5581
branch = control_dir.open_branch()
5582
had_explicit_nick = branch.get_config().has_explicit_nickname()
5583
except errors.NotBranchError:
5585
had_explicit_nick = False
5588
raise errors.BzrCommandError('cannot create branch without'
5590
to_location = directory_service.directories.dereference(
5592
if '/' not in to_location and '\\' not in to_location:
5593
# This path is meant to be relative to the existing branch
5594
this_url = self._get_branch_location(control_dir)
5595
to_location = urlutils.join(this_url, '..', to_location)
5596
to_branch = branch.bzrdir.sprout(to_location,
5597
possible_transports=[branch.bzrdir.root_transport],
5598
source_branch=branch).open_branch()
5601
to_branch = Branch.open(to_location)
5602
except errors.NotBranchError:
5603
this_url = self._get_branch_location(control_dir)
5604
to_branch = Branch.open(
5605
urlutils.join(this_url, '..', to_location))
5606
if revision is not None:
5607
revision = revision.as_revision_id(to_branch)
5608
switch.switch(control_dir, to_branch, force, revision_id=revision)
5609
if had_explicit_nick:
5610
branch = control_dir.open_branch() #get the new branch!
5611
branch.nick = to_branch.nick
5612
note('Switched to branch: %s',
5613
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5615
def _get_branch_location(self, control_dir):
5616
"""Return location of branch for this control dir."""
5618
this_branch = control_dir.open_branch()
5619
# This may be a heavy checkout, where we want the master branch
5620
master_location = this_branch.get_bound_location()
5621
if master_location is not None:
5622
return master_location
5623
# If not, use a local sibling
5624
return this_branch.base
5625
except errors.NotBranchError:
5626
format = control_dir.find_branch_format()
5627
if getattr(format, 'get_reference', None) is not None:
5628
return format.get_reference(control_dir)
5630
return control_dir.root_transport.base
5633
class cmd_view(Command):
5634
__doc__ = """Manage filtered views.
5636
Views provide a mask over the tree so that users can focus on
5637
a subset of a tree when doing their work. After creating a view,
5638
commands that support a list of files - status, diff, commit, etc -
5639
effectively have that list of files implicitly given each time.
5640
An explicit list of files can still be given but those files
5641
must be within the current view.
5643
In most cases, a view has a short life-span: it is created to make
5644
a selected change and is deleted once that change is committed.
5645
At other times, you may wish to create one or more named views
5646
and switch between them.
5648
To disable the current view without deleting it, you can switch to
5649
the pseudo view called ``off``. This can be useful when you need
5650
to see the whole tree for an operation or two (e.g. merge) but
5651
want to switch back to your view after that.
5654
To define the current view::
5656
bzr view file1 dir1 ...
5658
To list the current view::
5662
To delete the current view::
5666
To disable the current view without deleting it::
5668
bzr view --switch off
5670
To define a named view and switch to it::
5672
bzr view --name view-name file1 dir1 ...
5674
To list a named view::
5676
bzr view --name view-name
5678
To delete a named view::
5680
bzr view --name view-name --delete
5682
To switch to a named view::
5684
bzr view --switch view-name
5686
To list all views defined::
5690
To delete all views::
5692
bzr view --delete --all
5696
takes_args = ['file*']
5699
help='Apply list or delete action to all views.',
5702
help='Delete the view.',
5705
help='Name of the view to define, list or delete.',
5709
help='Name of the view to switch to.',
5714
def run(self, file_list,
5720
tree, file_list = tree_files(file_list, apply_view=False)
5721
current_view, view_dict = tree.views.get_view_info()
5726
raise errors.BzrCommandError(
5727
"Both --delete and a file list specified")
5729
raise errors.BzrCommandError(
5730
"Both --delete and --switch specified")
5732
tree.views.set_view_info(None, {})
5733
self.outf.write("Deleted all views.\n")
5735
raise errors.BzrCommandError("No current view to delete")
5737
tree.views.delete_view(name)
5738
self.outf.write("Deleted '%s' view.\n" % name)
5741
raise errors.BzrCommandError(
5742
"Both --switch and a file list specified")
5744
raise errors.BzrCommandError(
5745
"Both --switch and --all specified")
5746
elif switch == 'off':
5747
if current_view is None:
5748
raise errors.BzrCommandError("No current view to disable")
5749
tree.views.set_view_info(None, view_dict)
5750
self.outf.write("Disabled '%s' view.\n" % (current_view))
5752
tree.views.set_view_info(switch, view_dict)
5753
view_str = views.view_display_str(tree.views.lookup_view())
5754
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5757
self.outf.write('Views defined:\n')
5758
for view in sorted(view_dict):
5759
if view == current_view:
5763
view_str = views.view_display_str(view_dict[view])
5764
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5766
self.outf.write('No views defined.\n')
5769
# No name given and no current view set
5772
raise errors.BzrCommandError(
5773
"Cannot change the 'off' pseudo view")
5774
tree.views.set_view(name, sorted(file_list))
5775
view_str = views.view_display_str(tree.views.lookup_view())
5776
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5780
# No name given and no current view set
5781
self.outf.write('No current view.\n')
5783
view_str = views.view_display_str(tree.views.lookup_view(name))
5784
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5787
class cmd_hooks(Command):
5788
__doc__ = """Show hooks."""
5793
for hook_key in sorted(hooks.known_hooks.keys()):
5794
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5795
self.outf.write("%s:\n" % type(some_hooks).__name__)
5796
for hook_name, hook_point in sorted(some_hooks.items()):
5797
self.outf.write(" %s:\n" % (hook_name,))
5798
found_hooks = list(hook_point)
5800
for hook in found_hooks:
5801
self.outf.write(" %s\n" %
5802
(some_hooks.get_hook_name(hook),))
5804
self.outf.write(" <no hooks installed>\n")
5807
class cmd_remove_branch(Command):
5808
__doc__ = """Remove a branch.
5810
This will remove the branch from the specified location but
5811
will keep any working tree or repository in place.
5815
Remove the branch at repo/trunk::
5817
bzr remove-branch repo/trunk
5821
takes_args = ["location?"]
5823
aliases = ["rmbranch"]
5825
def run(self, location=None):
5826
if location is None:
5828
branch = Branch.open_containing(location)[0]
5829
branch.bzrdir.destroy_branch()
5832
class cmd_shelve(Command):
5833
__doc__ = """Temporarily set aside some changes from the current tree.
5835
Shelve allows you to temporarily put changes you've made "on the shelf",
5836
ie. out of the way, until a later time when you can bring them back from
5837
the shelf with the 'unshelve' command. The changes are stored alongside
5838
your working tree, and so they aren't propagated along with your branch nor
5839
will they survive its deletion.
5841
If shelve --list is specified, previously-shelved changes are listed.
5843
Shelve is intended to help separate several sets of changes that have
5844
been inappropriately mingled. If you just want to get rid of all changes
5845
and you don't need to restore them later, use revert. If you want to
5846
shelve all text changes at once, use shelve --all.
5848
If filenames are specified, only the changes to those files will be
5849
shelved. Other files will be left untouched.
5851
If a revision is specified, changes since that revision will be shelved.
5853
You can put multiple items on the shelf, and by default, 'unshelve' will
5854
restore the most recently shelved changes.
5857
takes_args = ['file*']
5861
Option('all', help='Shelve all changes.'),
5863
RegistryOption('writer', 'Method to use for writing diffs.',
5864
bzrlib.option.diff_writer_registry,
5865
value_switches=True, enum_switch=False),
5867
Option('list', help='List shelved changes.'),
5869
help='Destroy removed changes instead of shelving them.'),
5871
_see_also = ['unshelve']
5873
def run(self, revision=None, all=False, file_list=None, message=None,
5874
writer=None, list=False, destroy=False):
5876
return self.run_for_list()
5877
from bzrlib.shelf_ui import Shelver
5879
writer = bzrlib.option.diff_writer_registry.get()
5881
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5882
file_list, message, destroy=destroy)
5887
except errors.UserAbort:
5890
def run_for_list(self):
5891
tree = WorkingTree.open_containing('.')[0]
5893
self.add_cleanup(tree.unlock)
5894
manager = tree.get_shelf_manager()
5895
shelves = manager.active_shelves()
5896
if len(shelves) == 0:
5897
note('No shelved changes.')
5899
for shelf_id in reversed(shelves):
5900
message = manager.get_metadata(shelf_id).get('message')
5902
message = '<no message>'
5903
self.outf.write('%3d: %s\n' % (shelf_id, message))
5907
class cmd_unshelve(Command):
5908
__doc__ = """Restore shelved changes.
5910
By default, the most recently shelved changes are restored. However if you
5911
specify a shelf by id those changes will be restored instead. This works
5912
best when the changes don't depend on each other.
5915
takes_args = ['shelf_id?']
5917
RegistryOption.from_kwargs(
5918
'action', help="The action to perform.",
5919
enum_switch=False, value_switches=True,
5920
apply="Apply changes and remove from the shelf.",
5921
dry_run="Show changes, but do not apply or remove them.",
5922
preview="Instead of unshelving the changes, show the diff that "
5923
"would result from unshelving.",
5924
delete_only="Delete changes without applying them.",
5925
keep="Apply changes but don't delete them.",
5928
_see_also = ['shelve']
5930
def run(self, shelf_id=None, action='apply'):
5931
from bzrlib.shelf_ui import Unshelver
5932
unshelver = Unshelver.from_args(shelf_id, action)
5936
unshelver.tree.unlock()
5939
class cmd_clean_tree(Command):
5940
__doc__ = """Remove unwanted files from working tree.
5942
By default, only unknown files, not ignored files, are deleted. Versioned
5943
files are never deleted.
5945
Another class is 'detritus', which includes files emitted by bzr during
5946
normal operations and selftests. (The value of these files decreases with
5949
If no options are specified, unknown files are deleted. Otherwise, option
5950
flags are respected, and may be combined.
5952
To check what clean-tree will do, use --dry-run.
5954
takes_options = [Option('ignored', help='Delete all ignored files.'),
5955
Option('detritus', help='Delete conflict files, merge'
5956
' backups, and failed selftest dirs.'),
5958
help='Delete files unknown to bzr (default).'),
5959
Option('dry-run', help='Show files to delete instead of'
5961
Option('force', help='Do not prompt before deleting.')]
5962
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5964
from bzrlib.clean_tree import clean_tree
5965
if not (unknown or ignored or detritus):
5969
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5970
dry_run=dry_run, no_prompt=force)
5973
class cmd_reference(Command):
5974
__doc__ = """list, view and set branch locations for nested trees.
5976
If no arguments are provided, lists the branch locations for nested trees.
5977
If one argument is provided, display the branch location for that tree.
5978
If two arguments are provided, set the branch location for that tree.
5983
takes_args = ['path?', 'location?']
5985
def run(self, path=None, location=None):
5987
if path is not None:
5989
tree, branch, relpath =(
5990
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5991
if path is not None:
5994
tree = branch.basis_tree()
5996
info = branch._get_all_reference_info().iteritems()
5997
self._display_reference_info(tree, branch, info)
5999
file_id = tree.path2id(path)
6001
raise errors.NotVersionedError(path)
6002
if location is None:
6003
info = [(file_id, branch.get_reference_info(file_id))]
6004
self._display_reference_info(tree, branch, info)
6006
branch.set_reference_info(file_id, path, location)
6008
def _display_reference_info(self, tree, branch, info):
6010
for file_id, (path, location) in info:
6012
path = tree.id2path(file_id)
6013
except errors.NoSuchId:
6015
ref_list.append((path, location))
6016
for path, location in sorted(ref_list):
6017
self.outf.write('%s %s\n' % (path, location))
6020
def _register_lazy_builtins():
6021
# register lazy builtins from other modules; called at startup and should
6022
# be only called once.
6023
for (name, aliases, module_name) in [
6024
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6025
('cmd_dpush', [], 'bzrlib.foreign'),
6026
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6027
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6028
('cmd_conflicts', [], 'bzrlib.conflicts'),
6029
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6031
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
