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.'),
2300
Option('exclude-common-ancestry',
2301
help='Display only the revisions that are not part'
2302
' of both ancestries (require -rX..Y)'
2305
encoding_type = 'replace'
2308
def run(self, file_list=None, timezone='original',
2319
include_merges=False,
2320
exclude_common_ancestry=False,
2322
from bzrlib.log import (
2324
make_log_request_dict,
2325
_get_info_for_log_files,
2327
direction = (forward and 'forward') or 'reverse'
2328
if (exclude_common_ancestry
2329
and (revision is None or len(revision) != 2)):
2330
raise errors.BzrCommandError(
2331
'--exclude-common-ancestry requires -r with two revisions')
2336
raise errors.BzrCommandError(
2337
'--levels and --include-merges are mutually exclusive')
2339
if change is not None:
2341
raise errors.RangeInChangeOption()
2342
if revision is not None:
2343
raise errors.BzrCommandError(
2344
'--revision and --change are mutually exclusive')
2349
filter_by_dir = False
2351
# find the file ids to log and check for directory filtering
2352
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2353
revision, file_list)
2354
self.add_cleanup(b.unlock)
2355
for relpath, file_id, kind in file_info_list:
2357
raise errors.BzrCommandError(
2358
"Path unknown at end or start of revision range: %s" %
2360
# If the relpath is the top of the tree, we log everything
2365
file_ids.append(file_id)
2366
filter_by_dir = filter_by_dir or (
2367
kind in ['directory', 'tree-reference'])
2370
# FIXME ? log the current subdir only RBC 20060203
2371
if revision is not None \
2372
and len(revision) > 0 and revision[0].get_branch():
2373
location = revision[0].get_branch()
2376
dir, relpath = bzrdir.BzrDir.open_containing(location)
2377
b = dir.open_branch()
2379
self.add_cleanup(b.unlock)
2380
rev1, rev2 = _get_revision_range(revision, b, self.name())
2382
# Decide on the type of delta & diff filtering to use
2383
# TODO: add an --all-files option to make this configurable & consistent
2391
diff_type = 'partial'
2395
# Build the log formatter
2396
if log_format is None:
2397
log_format = log.log_formatter_registry.get_default(b)
2398
# Make a non-encoding output to include the diffs - bug 328007
2399
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2400
lf = log_format(show_ids=show_ids, to_file=self.outf,
2401
to_exact_file=unencoded_output,
2402
show_timezone=timezone,
2403
delta_format=get_verbosity_level(),
2405
show_advice=levels is None)
2407
# Choose the algorithm for doing the logging. It's annoying
2408
# having multiple code paths like this but necessary until
2409
# the underlying repository format is faster at generating
2410
# deltas or can provide everything we need from the indices.
2411
# The default algorithm - match-using-deltas - works for
2412
# multiple files and directories and is faster for small
2413
# amounts of history (200 revisions say). However, it's too
2414
# slow for logging a single file in a repository with deep
2415
# history, i.e. > 10K revisions. In the spirit of "do no
2416
# evil when adding features", we continue to use the
2417
# original algorithm - per-file-graph - for the "single
2418
# file that isn't a directory without showing a delta" case.
2419
partial_history = revision and b.repository._format.supports_chks
2420
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2421
or delta_type or partial_history)
2423
# Build the LogRequest and execute it
2424
if len(file_ids) == 0:
2426
rqst = make_log_request_dict(
2427
direction=direction, specific_fileids=file_ids,
2428
start_revision=rev1, end_revision=rev2, limit=limit,
2429
message_search=message, delta_type=delta_type,
2430
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2431
exclude_common_ancestry=exclude_common_ancestry,
2433
Logger(b, rqst).show(lf)
2436
def _get_revision_range(revisionspec_list, branch, command_name):
2437
"""Take the input of a revision option and turn it into a revision range.
2439
It returns RevisionInfo objects which can be used to obtain the rev_id's
2440
of the desired revisions. It does some user input validations.
2442
if revisionspec_list is None:
2445
elif len(revisionspec_list) == 1:
2446
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2447
elif len(revisionspec_list) == 2:
2448
start_spec = revisionspec_list[0]
2449
end_spec = revisionspec_list[1]
2450
if end_spec.get_branch() != start_spec.get_branch():
2451
# b is taken from revision[0].get_branch(), and
2452
# show_log will use its revision_history. Having
2453
# different branches will lead to weird behaviors.
2454
raise errors.BzrCommandError(
2455
"bzr %s doesn't accept two revisions in different"
2456
" branches." % command_name)
2457
if start_spec.spec is None:
2458
# Avoid loading all the history.
2459
rev1 = RevisionInfo(branch, None, None)
2461
rev1 = start_spec.in_history(branch)
2462
# Avoid loading all of history when we know a missing
2463
# end of range means the last revision ...
2464
if end_spec.spec is None:
2465
last_revno, last_revision_id = branch.last_revision_info()
2466
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2468
rev2 = end_spec.in_history(branch)
2470
raise errors.BzrCommandError(
2471
'bzr %s --revision takes one or two values.' % command_name)
2475
def _revision_range_to_revid_range(revision_range):
2478
if revision_range[0] is not None:
2479
rev_id1 = revision_range[0].rev_id
2480
if revision_range[1] is not None:
2481
rev_id2 = revision_range[1].rev_id
2482
return rev_id1, rev_id2
2484
def get_log_format(long=False, short=False, line=False, default='long'):
2485
log_format = default
2489
log_format = 'short'
2495
class cmd_touching_revisions(Command):
2496
__doc__ = """Return revision-ids which affected a particular file.
2498
A more user-friendly interface is "bzr log FILE".
2502
takes_args = ["filename"]
2505
def run(self, filename):
2506
tree, relpath = WorkingTree.open_containing(filename)
2507
file_id = tree.path2id(relpath)
2510
self.add_cleanup(b.unlock)
2511
touching_revs = log.find_touching_revisions(b, file_id)
2512
for revno, revision_id, what in touching_revs:
2513
self.outf.write("%6d %s\n" % (revno, what))
2516
class cmd_ls(Command):
2517
__doc__ = """List files in a tree.
2520
_see_also = ['status', 'cat']
2521
takes_args = ['path?']
2525
Option('recursive', short_name='R',
2526
help='Recurse into subdirectories.'),
2528
help='Print paths relative to the root of the branch.'),
2529
Option('unknown', help='Print unknown files.'),
2530
Option('versioned', help='Print versioned files.',
2532
Option('ignored', help='Print ignored files.'),
2534
help='Write an ascii NUL (\\0) separator '
2535
'between files rather than a newline.'),
2537
help='List entries of a particular kind: file, directory, symlink.',
2542
def run(self, revision=None, verbose=False,
2543
recursive=False, from_root=False,
2544
unknown=False, versioned=False, ignored=False,
2545
null=False, kind=None, show_ids=False, path=None):
2547
if kind and kind not in ('file', 'directory', 'symlink'):
2548
raise errors.BzrCommandError('invalid kind specified')
2550
if verbose and null:
2551
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2552
all = not (unknown or versioned or ignored)
2554
selection = {'I':ignored, '?':unknown, 'V':versioned}
2560
raise errors.BzrCommandError('cannot specify both --from-root'
2563
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2566
# Calculate the prefix to use
2570
prefix = relpath + '/'
2571
elif fs_path != '.' and not fs_path.endswith('/'):
2572
prefix = fs_path + '/'
2574
if revision is not None or tree is None:
2575
tree = _get_one_revision_tree('ls', revision, branch=branch)
2578
if isinstance(tree, WorkingTree) and tree.supports_views():
2579
view_files = tree.views.lookup_view()
2582
view_str = views.view_display_str(view_files)
2583
note("Ignoring files outside view. View is %s" % view_str)
2586
self.add_cleanup(tree.unlock)
2587
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2588
from_dir=relpath, recursive=recursive):
2589
# Apply additional masking
2590
if not all and not selection[fc]:
2592
if kind is not None and fkind != kind:
2597
fullpath = osutils.pathjoin(relpath, fp)
2600
views.check_path_in_view(tree, fullpath)
2601
except errors.FileOutsideView:
2606
fp = osutils.pathjoin(prefix, fp)
2607
kindch = entry.kind_character()
2608
outstring = fp + kindch
2609
ui.ui_factory.clear_term()
2611
outstring = '%-8s %s' % (fc, outstring)
2612
if show_ids and fid is not None:
2613
outstring = "%-50s %s" % (outstring, fid)
2614
self.outf.write(outstring + '\n')
2616
self.outf.write(fp + '\0')
2619
self.outf.write(fid)
2620
self.outf.write('\0')
2628
self.outf.write('%-50s %s\n' % (outstring, my_id))
2630
self.outf.write(outstring + '\n')
2633
class cmd_unknowns(Command):
2634
__doc__ = """List unknown files.
2642
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2643
self.outf.write(osutils.quotefn(f) + '\n')
2646
class cmd_ignore(Command):
2647
__doc__ = """Ignore specified files or patterns.
2649
See ``bzr help patterns`` for details on the syntax of patterns.
2651
If a .bzrignore file does not exist, the ignore command
2652
will create one and add the specified files or patterns to the newly
2653
created file. The ignore command will also automatically add the
2654
.bzrignore file to be versioned. Creating a .bzrignore file without
2655
the use of the ignore command will require an explicit add command.
2657
To remove patterns from the ignore list, edit the .bzrignore file.
2658
After adding, editing or deleting that file either indirectly by
2659
using this command or directly by using an editor, be sure to commit
2662
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2663
the global ignore file can be found in the application data directory as
2664
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2665
Global ignores are not touched by this command. The global ignore file
2666
can be edited directly using an editor.
2668
Patterns prefixed with '!' are exceptions to ignore patterns and take
2669
precedence over regular ignores. Such exceptions are used to specify
2670
files that should be versioned which would otherwise be ignored.
2672
Patterns prefixed with '!!' act as regular ignore patterns, but have
2673
precedence over the '!' exception patterns.
2675
Note: ignore patterns containing shell wildcards must be quoted from
2679
Ignore the top level Makefile::
2681
bzr ignore ./Makefile
2683
Ignore .class files in all directories...::
2685
bzr ignore "*.class"
2687
...but do not ignore "special.class"::
2689
bzr ignore "!special.class"
2691
Ignore .o files under the lib directory::
2693
bzr ignore "lib/**/*.o"
2695
Ignore .o files under the lib directory::
2697
bzr ignore "RE:lib/.*\.o"
2699
Ignore everything but the "debian" toplevel directory::
2701
bzr ignore "RE:(?!debian/).*"
2703
Ignore everything except the "local" toplevel directory,
2704
but always ignore "*~" autosave files, even under local/::
2707
bzr ignore "!./local"
2711
_see_also = ['status', 'ignored', 'patterns']
2712
takes_args = ['name_pattern*']
2714
Option('default-rules',
2715
help='Display the default ignore rules that bzr uses.')
2718
def run(self, name_pattern_list=None, default_rules=None):
2719
from bzrlib import ignores
2720
if default_rules is not None:
2721
# dump the default rules and exit
2722
for pattern in ignores.USER_DEFAULTS:
2723
self.outf.write("%s\n" % pattern)
2725
if not name_pattern_list:
2726
raise errors.BzrCommandError("ignore requires at least one "
2727
"NAME_PATTERN or --default-rules.")
2728
name_pattern_list = [globbing.normalize_pattern(p)
2729
for p in name_pattern_list]
2730
for name_pattern in name_pattern_list:
2731
if (name_pattern[0] == '/' or
2732
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2733
raise errors.BzrCommandError(
2734
"NAME_PATTERN should not be an absolute path")
2735
tree, relpath = WorkingTree.open_containing(u'.')
2736
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2737
ignored = globbing.Globster(name_pattern_list)
2740
for entry in tree.list_files():
2744
if ignored.match(filename):
2745
matches.append(filename)
2747
if len(matches) > 0:
2748
self.outf.write("Warning: the following files are version controlled and"
2749
" match your ignore pattern:\n%s"
2750
"\nThese files will continue to be version controlled"
2751
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2754
class cmd_ignored(Command):
2755
__doc__ = """List ignored files and the patterns that matched them.
2757
List all the ignored files and the ignore pattern that caused the file to
2760
Alternatively, to list just the files::
2765
encoding_type = 'replace'
2766
_see_also = ['ignore', 'ls']
2770
tree = WorkingTree.open_containing(u'.')[0]
2772
self.add_cleanup(tree.unlock)
2773
for path, file_class, kind, file_id, entry in tree.list_files():
2774
if file_class != 'I':
2776
## XXX: Slightly inefficient since this was already calculated
2777
pat = tree.is_ignored(path)
2778
self.outf.write('%-50s %s\n' % (path, pat))
2781
class cmd_lookup_revision(Command):
2782
__doc__ = """Lookup the revision-id from a revision-number
2785
bzr lookup-revision 33
2788
takes_args = ['revno']
2791
def run(self, revno):
2795
raise errors.BzrCommandError("not a valid revision-number: %r"
2797
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2798
self.outf.write("%s\n" % revid)
2801
class cmd_export(Command):
2802
__doc__ = """Export current or past revision to a destination directory or archive.
2804
If no revision is specified this exports the last committed revision.
2806
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2807
given, try to find the format with the extension. If no extension
2808
is found exports to a directory (equivalent to --format=dir).
2810
If root is supplied, it will be used as the root directory inside
2811
container formats (tar, zip, etc). If it is not supplied it will default
2812
to the exported filename. The root option has no effect for 'dir' format.
2814
If branch is omitted then the branch containing the current working
2815
directory will be used.
2817
Note: Export of tree with non-ASCII filenames to zip is not supported.
2819
================= =========================
2820
Supported formats Autodetected by extension
2821
================= =========================
2824
tbz2 .tar.bz2, .tbz2
2827
================= =========================
2829
takes_args = ['dest', 'branch_or_subdir?']
2832
help="Type of file to export to.",
2835
Option('filters', help='Apply content filters to export the '
2836
'convenient form.'),
2839
help="Name of the root directory inside the exported file."),
2840
Option('per-file-timestamps',
2841
help='Set modification time of files to that of the last '
2842
'revision in which it was changed.'),
2844
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2845
root=None, filters=False, per_file_timestamps=False):
2846
from bzrlib.export import export
2848
if branch_or_subdir is None:
2849
tree = WorkingTree.open_containing(u'.')[0]
2853
b, subdir = Branch.open_containing(branch_or_subdir)
2856
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2858
export(rev_tree, dest, format, root, subdir, filtered=filters,
2859
per_file_timestamps=per_file_timestamps)
2860
except errors.NoSuchExportFormat, e:
2861
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2864
class cmd_cat(Command):
2865
__doc__ = """Write the contents of a file as of a given revision to standard output.
2867
If no revision is nominated, the last revision is used.
2869
Note: Take care to redirect standard output when using this command on a
2875
Option('name-from-revision', help='The path name in the old tree.'),
2876
Option('filters', help='Apply content filters to display the '
2877
'convenience form.'),
2880
takes_args = ['filename']
2881
encoding_type = 'exact'
2884
def run(self, filename, revision=None, name_from_revision=False,
2886
if revision is not None and len(revision) != 1:
2887
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2888
" one revision specifier")
2889
tree, branch, relpath = \
2890
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2892
self.add_cleanup(branch.unlock)
2893
return self._run(tree, branch, relpath, filename, revision,
2894
name_from_revision, filters)
2896
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2899
tree = b.basis_tree()
2900
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2901
rev_tree.lock_read()
2902
self.add_cleanup(rev_tree.unlock)
2904
old_file_id = rev_tree.path2id(relpath)
2906
if name_from_revision:
2907
# Try in revision if requested
2908
if old_file_id is None:
2909
raise errors.BzrCommandError(
2910
"%r is not present in revision %s" % (
2911
filename, rev_tree.get_revision_id()))
2913
content = rev_tree.get_file_text(old_file_id)
2915
cur_file_id = tree.path2id(relpath)
2917
if cur_file_id is not None:
2918
# Then try with the actual file id
2920
content = rev_tree.get_file_text(cur_file_id)
2922
except errors.NoSuchId:
2923
# The actual file id didn't exist at that time
2925
if not found and old_file_id is not None:
2926
# Finally try with the old file id
2927
content = rev_tree.get_file_text(old_file_id)
2930
# Can't be found anywhere
2931
raise errors.BzrCommandError(
2932
"%r is not present in revision %s" % (
2933
filename, rev_tree.get_revision_id()))
2935
from bzrlib.filters import (
2936
ContentFilterContext,
2937
filtered_output_bytes,
2939
filters = rev_tree._content_filter_stack(relpath)
2940
chunks = content.splitlines(True)
2941
content = filtered_output_bytes(chunks, filters,
2942
ContentFilterContext(relpath, rev_tree))
2944
self.outf.writelines(content)
2947
self.outf.write(content)
2950
class cmd_local_time_offset(Command):
2951
__doc__ = """Show the offset in seconds from GMT to local time."""
2955
self.outf.write("%s\n" % osutils.local_time_offset())
2959
class cmd_commit(Command):
2960
__doc__ = """Commit changes into a new revision.
2962
An explanatory message needs to be given for each commit. This is
2963
often done by using the --message option (getting the message from the
2964
command line) or by using the --file option (getting the message from
2965
a file). If neither of these options is given, an editor is opened for
2966
the user to enter the message. To see the changed files in the
2967
boilerplate text loaded into the editor, use the --show-diff option.
2969
By default, the entire tree is committed and the person doing the
2970
commit is assumed to be the author. These defaults can be overridden
2975
If selected files are specified, only changes to those files are
2976
committed. If a directory is specified then the directory and
2977
everything within it is committed.
2979
When excludes are given, they take precedence over selected files.
2980
For example, to commit only changes within foo, but not changes
2983
bzr commit foo -x foo/bar
2985
A selective commit after a merge is not yet supported.
2989
If the author of the change is not the same person as the committer,
2990
you can specify the author's name using the --author option. The
2991
name should be in the same format as a committer-id, e.g.
2992
"John Doe <jdoe@example.com>". If there is more than one author of
2993
the change you can specify the option multiple times, once for each
2998
A common mistake is to forget to add a new file or directory before
2999
running the commit command. The --strict option checks for unknown
3000
files and aborts the commit if any are found. More advanced pre-commit
3001
checks can be implemented by defining hooks. See ``bzr help hooks``
3006
If you accidentially commit the wrong changes or make a spelling
3007
mistake in the commit message say, you can use the uncommit command
3008
to undo it. See ``bzr help uncommit`` for details.
3010
Hooks can also be configured to run after a commit. This allows you
3011
to trigger updates to external systems like bug trackers. The --fixes
3012
option can be used to record the association between a revision and
3013
one or more bugs. See ``bzr help bugs`` for details.
3015
A selective commit may fail in some cases where the committed
3016
tree would be invalid. Consider::
3021
bzr commit foo -m "committing foo"
3022
bzr mv foo/bar foo/baz
3025
bzr commit foo/bar -m "committing bar but not baz"
3027
In the example above, the last commit will fail by design. This gives
3028
the user the opportunity to decide whether they want to commit the
3029
rename at the same time, separately first, or not at all. (As a general
3030
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3032
# TODO: Run hooks on tree to-be-committed, and after commit.
3034
# TODO: Strict commit that fails if there are deleted files.
3035
# (what does "deleted files" mean ??)
3037
# TODO: Give better message for -s, --summary, used by tla people
3039
# XXX: verbose currently does nothing
3041
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3042
takes_args = ['selected*']
3044
ListOption('exclude', type=str, short_name='x',
3045
help="Do not consider changes made to a given path."),
3046
Option('message', type=unicode,
3048
help="Description of the new revision."),
3051
help='Commit even if nothing has changed.'),
3052
Option('file', type=str,
3055
help='Take commit message from this file.'),
3057
help="Refuse to commit if there are unknown "
3058
"files in the working tree."),
3059
Option('commit-time', type=str,
3060
help="Manually set a commit time using commit date "
3061
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3062
ListOption('fixes', type=str,
3063
help="Mark a bug as being fixed by this revision "
3064
"(see \"bzr help bugs\")."),
3065
ListOption('author', type=unicode,
3066
help="Set the author's name, if it's different "
3067
"from the committer."),
3069
help="Perform a local commit in a bound "
3070
"branch. Local commits are not pushed to "
3071
"the master branch until a normal commit "
3075
help='When no message is supplied, show the diff along'
3076
' with the status summary in the message editor.'),
3078
aliases = ['ci', 'checkin']
3080
def _iter_bug_fix_urls(self, fixes, branch):
3081
# Configure the properties for bug fixing attributes.
3082
for fixed_bug in fixes:
3083
tokens = fixed_bug.split(':')
3084
if len(tokens) != 2:
3085
raise errors.BzrCommandError(
3086
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3087
"See \"bzr help bugs\" for more information on this "
3088
"feature.\nCommit refused." % fixed_bug)
3089
tag, bug_id = tokens
3091
yield bugtracker.get_bug_url(tag, branch, bug_id)
3092
except errors.UnknownBugTrackerAbbreviation:
3093
raise errors.BzrCommandError(
3094
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3095
except errors.MalformedBugIdentifier, e:
3096
raise errors.BzrCommandError(
3097
"%s\nCommit refused." % (str(e),))
3099
def run(self, message=None, file=None, verbose=False, selected_list=None,
3100
unchanged=False, strict=False, local=False, fixes=None,
3101
author=None, show_diff=False, exclude=None, commit_time=None):
3102
from bzrlib.errors import (
3107
from bzrlib.msgeditor import (
3108
edit_commit_message_encoded,
3109
generate_commit_message_template,
3110
make_commit_message_template_encoded
3113
commit_stamp = offset = None
3114
if commit_time is not None:
3116
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3117
except ValueError, e:
3118
raise errors.BzrCommandError(
3119
"Could not parse --commit-time: " + str(e))
3121
# TODO: Need a blackbox test for invoking the external editor; may be
3122
# slightly problematic to run this cross-platform.
3124
# TODO: do more checks that the commit will succeed before
3125
# spending the user's valuable time typing a commit message.
3129
tree, selected_list = tree_files(selected_list)
3130
if selected_list == ['']:
3131
# workaround - commit of root of tree should be exactly the same
3132
# as just default commit in that tree, and succeed even though
3133
# selected-file merge commit is not done yet
3138
bug_property = bugtracker.encode_fixes_bug_urls(
3139
self._iter_bug_fix_urls(fixes, tree.branch))
3141
properties['bugs'] = bug_property
3143
if local and not tree.branch.get_bound_location():
3144
raise errors.LocalRequiresBoundBranch()
3146
if message is not None:
3148
file_exists = osutils.lexists(message)
3149
except UnicodeError:
3150
# The commit message contains unicode characters that can't be
3151
# represented in the filesystem encoding, so that can't be a
3156
'The commit message is a file name: "%(f)s".\n'
3157
'(use --file "%(f)s" to take commit message from that file)'
3159
ui.ui_factory.show_warning(warning_msg)
3161
message = message.replace('\r\n', '\n')
3162
message = message.replace('\r', '\n')
3164
raise errors.BzrCommandError(
3165
"please specify either --message or --file")
3167
def get_message(commit_obj):
3168
"""Callback to get commit message"""
3170
my_message = codecs.open(
3171
file, 'rt', osutils.get_user_encoding()).read()
3172
elif message is not None:
3173
my_message = message
3175
# No message supplied: make one up.
3176
# text is the status of the tree
3177
text = make_commit_message_template_encoded(tree,
3178
selected_list, diff=show_diff,
3179
output_encoding=osutils.get_user_encoding())
3180
# start_message is the template generated from hooks
3181
# XXX: Warning - looks like hooks return unicode,
3182
# make_commit_message_template_encoded returns user encoding.
3183
# We probably want to be using edit_commit_message instead to
3185
start_message = generate_commit_message_template(commit_obj)
3186
my_message = edit_commit_message_encoded(text,
3187
start_message=start_message)
3188
if my_message is None:
3189
raise errors.BzrCommandError("please specify a commit"
3190
" message with either --message or --file")
3191
if my_message == "":
3192
raise errors.BzrCommandError("empty commit message specified")
3195
# The API permits a commit with a filter of [] to mean 'select nothing'
3196
# but the command line should not do that.
3197
if not selected_list:
3198
selected_list = None
3200
tree.commit(message_callback=get_message,
3201
specific_files=selected_list,
3202
allow_pointless=unchanged, strict=strict, local=local,
3203
reporter=None, verbose=verbose, revprops=properties,
3204
authors=author, timestamp=commit_stamp,
3206
exclude=safe_relpath_files(tree, exclude))
3207
except PointlessCommit:
3208
raise errors.BzrCommandError("No changes to commit."
3209
" Use --unchanged to commit anyhow.")
3210
except ConflictsInTree:
3211
raise errors.BzrCommandError('Conflicts detected in working '
3212
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3214
except StrictCommitFailed:
3215
raise errors.BzrCommandError("Commit refused because there are"
3216
" unknown files in the working tree.")
3217
except errors.BoundBranchOutOfDate, e:
3218
e.extra_help = ("\n"
3219
'To commit to master branch, run update and then commit.\n'
3220
'You can also pass --local to commit to continue working '
3225
class cmd_check(Command):
3226
__doc__ = """Validate working tree structure, branch consistency and repository history.
3228
This command checks various invariants about branch and repository storage
3229
to detect data corruption or bzr bugs.
3231
The working tree and branch checks will only give output if a problem is
3232
detected. The output fields of the repository check are:
3235
This is just the number of revisions checked. It doesn't
3239
This is just the number of versionedfiles checked. It
3240
doesn't indicate a problem.
3242
unreferenced ancestors
3243
Texts that are ancestors of other texts, but
3244
are not properly referenced by the revision ancestry. This is a
3245
subtle problem that Bazaar can work around.
3248
This is the total number of unique file contents
3249
seen in the checked revisions. It does not indicate a problem.
3252
This is the total number of repeated texts seen
3253
in the checked revisions. Texts can be repeated when their file
3254
entries are modified, but the file contents are not. It does not
3257
If no restrictions are specified, all Bazaar data that is found at the given
3258
location will be checked.
3262
Check the tree and branch at 'foo'::
3264
bzr check --tree --branch foo
3266
Check only the repository at 'bar'::
3268
bzr check --repo bar
3270
Check everything at 'baz'::
3275
_see_also = ['reconcile']
3276
takes_args = ['path?']
3277
takes_options = ['verbose',
3278
Option('branch', help="Check the branch related to the"
3279
" current directory."),
3280
Option('repo', help="Check the repository related to the"
3281
" current directory."),
3282
Option('tree', help="Check the working tree related to"
3283
" the current directory.")]
3285
def run(self, path=None, verbose=False, branch=False, repo=False,
3287
from bzrlib.check import check_dwim
3290
if not branch and not repo and not tree:
3291
branch = repo = tree = True
3292
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3295
class cmd_upgrade(Command):
3296
__doc__ = """Upgrade branch storage to current format.
3298
The check command or bzr developers may sometimes advise you to run
3299
this command. When the default format has changed you may also be warned
3300
during other operations to upgrade.
3303
_see_also = ['check']
3304
takes_args = ['url?']
3306
RegistryOption('format',
3307
help='Upgrade to a specific format. See "bzr help'
3308
' formats" for details.',
3309
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3310
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3311
value_switches=True, title='Branch format'),
3314
def run(self, url='.', format=None):
3315
from bzrlib.upgrade import upgrade
3316
upgrade(url, format)
3319
class cmd_whoami(Command):
3320
__doc__ = """Show or set bzr user id.
3323
Show the email of the current user::
3327
Set the current user::
3329
bzr whoami "Frank Chu <fchu@example.com>"
3331
takes_options = [ Option('email',
3332
help='Display email address only.'),
3334
help='Set identity for the current branch instead of '
3337
takes_args = ['name?']
3338
encoding_type = 'replace'
3341
def run(self, email=False, branch=False, name=None):
3343
# use branch if we're inside one; otherwise global config
3345
c = Branch.open_containing('.')[0].get_config()
3346
except errors.NotBranchError:
3347
c = config.GlobalConfig()
3349
self.outf.write(c.user_email() + '\n')
3351
self.outf.write(c.username() + '\n')
3354
# display a warning if an email address isn't included in the given name.
3356
config.extract_email_address(name)
3357
except errors.NoEmailInUsername, e:
3358
warning('"%s" does not seem to contain an email address. '
3359
'This is allowed, but not recommended.', name)
3361
# use global config unless --branch given
3363
c = Branch.open_containing('.')[0].get_config()
3365
c = config.GlobalConfig()
3366
c.set_user_option('email', name)
3369
class cmd_nick(Command):
3370
__doc__ = """Print or set the branch nickname.
3372
If unset, the tree root directory name is used as the nickname.
3373
To print the current nickname, execute with no argument.
3375
Bound branches use the nickname of its master branch unless it is set
3379
_see_also = ['info']
3380
takes_args = ['nickname?']
3381
def run(self, nickname=None):
3382
branch = Branch.open_containing(u'.')[0]
3383
if nickname is None:
3384
self.printme(branch)
3386
branch.nick = nickname
3389
def printme(self, branch):
3390
self.outf.write('%s\n' % branch.nick)
3393
class cmd_alias(Command):
3394
__doc__ = """Set/unset and display aliases.
3397
Show the current aliases::
3401
Show the alias specified for 'll'::
3405
Set an alias for 'll'::
3407
bzr alias ll="log --line -r-10..-1"
3409
To remove an alias for 'll'::
3411
bzr alias --remove ll
3414
takes_args = ['name?']
3416
Option('remove', help='Remove the alias.'),
3419
def run(self, name=None, remove=False):
3421
self.remove_alias(name)
3423
self.print_aliases()
3425
equal_pos = name.find('=')
3427
self.print_alias(name)
3429
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3431
def remove_alias(self, alias_name):
3432
if alias_name is None:
3433
raise errors.BzrCommandError(
3434
'bzr alias --remove expects an alias to remove.')
3435
# If alias is not found, print something like:
3436
# unalias: foo: not found
3437
c = config.GlobalConfig()
3438
c.unset_alias(alias_name)
3441
def print_aliases(self):
3442
"""Print out the defined aliases in a similar format to bash."""
3443
aliases = config.GlobalConfig().get_aliases()
3444
for key, value in sorted(aliases.iteritems()):
3445
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3448
def print_alias(self, alias_name):
3449
from bzrlib.commands import get_alias
3450
alias = get_alias(alias_name)
3452
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3455
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3457
def set_alias(self, alias_name, alias_command):
3458
"""Save the alias in the global config."""
3459
c = config.GlobalConfig()
3460
c.set_alias(alias_name, alias_command)
3463
class cmd_selftest(Command):
3464
__doc__ = """Run internal test suite.
3466
If arguments are given, they are regular expressions that say which tests
3467
should run. Tests matching any expression are run, and other tests are
3470
Alternatively if --first is given, matching tests are run first and then
3471
all other tests are run. This is useful if you have been working in a
3472
particular area, but want to make sure nothing else was broken.
3474
If --exclude is given, tests that match that regular expression are
3475
excluded, regardless of whether they match --first or not.
3477
To help catch accidential dependencies between tests, the --randomize
3478
option is useful. In most cases, the argument used is the word 'now'.
3479
Note that the seed used for the random number generator is displayed
3480
when this option is used. The seed can be explicitly passed as the
3481
argument to this option if required. This enables reproduction of the
3482
actual ordering used if and when an order sensitive problem is encountered.
3484
If --list-only is given, the tests that would be run are listed. This is
3485
useful when combined with --first, --exclude and/or --randomize to
3486
understand their impact. The test harness reports "Listed nn tests in ..."
3487
instead of "Ran nn tests in ..." when list mode is enabled.
3489
If the global option '--no-plugins' is given, plugins are not loaded
3490
before running the selftests. This has two effects: features provided or
3491
modified by plugins will not be tested, and tests provided by plugins will
3494
Tests that need working space on disk use a common temporary directory,
3495
typically inside $TMPDIR or /tmp.
3497
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3498
into a pdb postmortem session.
3501
Run only tests relating to 'ignore'::
3505
Disable plugins and list tests as they're run::
3507
bzr --no-plugins selftest -v
3509
# NB: this is used from the class without creating an instance, which is
3510
# why it does not have a self parameter.
3511
def get_transport_type(typestring):
3512
"""Parse and return a transport specifier."""
3513
if typestring == "sftp":
3514
from bzrlib.tests import stub_sftp
3515
return stub_sftp.SFTPAbsoluteServer
3516
if typestring == "memory":
3517
from bzrlib.tests import test_server
3518
return memory.MemoryServer
3519
if typestring == "fakenfs":
3520
from bzrlib.tests import test_server
3521
return test_server.FakeNFSServer
3522
msg = "No known transport type %s. Supported types are: sftp\n" %\
3524
raise errors.BzrCommandError(msg)
3527
takes_args = ['testspecs*']
3528
takes_options = ['verbose',
3530
help='Stop when one test fails.',
3534
help='Use a different transport by default '
3535
'throughout the test suite.',
3536
type=get_transport_type),
3538
help='Run the benchmarks rather than selftests.'),
3539
Option('lsprof-timed',
3540
help='Generate lsprof output for benchmarked'
3541
' sections of code.'),
3542
Option('lsprof-tests',
3543
help='Generate lsprof output for each test.'),
3544
Option('cache-dir', type=str,
3545
help='Cache intermediate benchmark output in this '
3548
help='Run all tests, but run specified tests first.',
3552
help='List the tests instead of running them.'),
3553
RegistryOption('parallel',
3554
help="Run the test suite in parallel.",
3555
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3556
value_switches=False,
3558
Option('randomize', type=str, argname="SEED",
3559
help='Randomize the order of tests using the given'
3560
' seed or "now" for the current time.'),
3561
Option('exclude', type=str, argname="PATTERN",
3563
help='Exclude tests that match this regular'
3566
help='Output test progress via subunit.'),
3567
Option('strict', help='Fail on missing dependencies or '
3569
Option('load-list', type=str, argname='TESTLISTFILE',
3570
help='Load a test id list from a text file.'),
3571
ListOption('debugflag', type=str, short_name='E',
3572
help='Turn on a selftest debug flag.'),
3573
ListOption('starting-with', type=str, argname='TESTID',
3574
param_name='starting_with', short_name='s',
3576
'Load only the tests starting with TESTID.'),
3578
encoding_type = 'replace'
3581
Command.__init__(self)
3582
self.additional_selftest_args = {}
3584
def run(self, testspecs_list=None, verbose=False, one=False,
3585
transport=None, benchmark=None,
3586
lsprof_timed=None, cache_dir=None,
3587
first=False, list_only=False,
3588
randomize=None, exclude=None, strict=False,
3589
load_list=None, debugflag=None, starting_with=None, subunit=False,
3590
parallel=None, lsprof_tests=False):
3591
from bzrlib.tests import selftest
3592
import bzrlib.benchmarks as benchmarks
3593
from bzrlib.benchmarks import tree_creator
3595
# Make deprecation warnings visible, unless -Werror is set
3596
symbol_versioning.activate_deprecation_warnings(override=False)
3598
if cache_dir is not None:
3599
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3600
if testspecs_list is not None:
3601
pattern = '|'.join(testspecs_list)
3606
from bzrlib.tests import SubUnitBzrRunner
3608
raise errors.BzrCommandError("subunit not available. subunit "
3609
"needs to be installed to use --subunit.")
3610
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3611
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3612
# stdout, which would corrupt the subunit stream.
3613
if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3615
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3617
self.additional_selftest_args.setdefault(
3618
'suite_decorators', []).append(parallel)
3620
test_suite_factory = benchmarks.test_suite
3621
# Unless user explicitly asks for quiet, be verbose in benchmarks
3622
verbose = not is_quiet()
3623
# TODO: should possibly lock the history file...
3624
benchfile = open(".perf_history", "at", buffering=1)
3625
self.add_cleanup(benchfile.close)
3627
test_suite_factory = None
3629
selftest_kwargs = {"verbose": verbose,
3631
"stop_on_failure": one,
3632
"transport": transport,
3633
"test_suite_factory": test_suite_factory,
3634
"lsprof_timed": lsprof_timed,
3635
"lsprof_tests": lsprof_tests,
3636
"bench_history": benchfile,
3637
"matching_tests_first": first,
3638
"list_only": list_only,
3639
"random_seed": randomize,
3640
"exclude_pattern": exclude,
3642
"load_list": load_list,
3643
"debug_flags": debugflag,
3644
"starting_with": starting_with
3646
selftest_kwargs.update(self.additional_selftest_args)
3647
result = selftest(**selftest_kwargs)
3648
return int(not result)
3651
class cmd_version(Command):
3652
__doc__ = """Show version of bzr."""
3654
encoding_type = 'replace'
3656
Option("short", help="Print just the version number."),
3660
def run(self, short=False):
3661
from bzrlib.version import show_version
3663
self.outf.write(bzrlib.version_string + '\n')
3665
show_version(to_file=self.outf)
3668
class cmd_rocks(Command):
3669
__doc__ = """Statement of optimism."""
3675
self.outf.write("It sure does!\n")
3678
class cmd_find_merge_base(Command):
3679
__doc__ = """Find and print a base revision for merging two branches."""
3680
# TODO: Options to specify revisions on either side, as if
3681
# merging only part of the history.
3682
takes_args = ['branch', 'other']
3686
def run(self, branch, other):
3687
from bzrlib.revision import ensure_null
3689
branch1 = Branch.open_containing(branch)[0]
3690
branch2 = Branch.open_containing(other)[0]
3692
self.add_cleanup(branch1.unlock)
3694
self.add_cleanup(branch2.unlock)
3695
last1 = ensure_null(branch1.last_revision())
3696
last2 = ensure_null(branch2.last_revision())
3698
graph = branch1.repository.get_graph(branch2.repository)
3699
base_rev_id = graph.find_unique_lca(last1, last2)
3701
self.outf.write('merge base is revision %s\n' % base_rev_id)
3704
class cmd_merge(Command):
3705
__doc__ = """Perform a three-way merge.
3707
The source of the merge can be specified either in the form of a branch,
3708
or in the form of a path to a file containing a merge directive generated
3709
with bzr send. If neither is specified, the default is the upstream branch
3710
or the branch most recently merged using --remember.
3712
When merging a branch, by default the tip will be merged. To pick a different
3713
revision, pass --revision. If you specify two values, the first will be used as
3714
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3715
available revisions, like this is commonly referred to as "cherrypicking".
3717
Revision numbers are always relative to the branch being merged.
3719
By default, bzr will try to merge in all new work from the other
3720
branch, automatically determining an appropriate base. If this
3721
fails, you may need to give an explicit base.
3723
Merge will do its best to combine the changes in two branches, but there
3724
are some kinds of problems only a human can fix. When it encounters those,
3725
it will mark a conflict. A conflict means that you need to fix something,
3726
before you should commit.
3728
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3730
If there is no default branch set, the first merge will set it. After
3731
that, you can omit the branch to use the default. To change the
3732
default, use --remember. The value will only be saved if the remote
3733
location can be accessed.
3735
The results of the merge are placed into the destination working
3736
directory, where they can be reviewed (with bzr diff), tested, and then
3737
committed to record the result of the merge.
3739
merge refuses to run if there are any uncommitted changes, unless
3740
--force is given. The --force option can also be used to create a
3741
merge revision which has more than two parents.
3743
If one would like to merge changes from the working tree of the other
3744
branch without merging any committed revisions, the --uncommitted option
3747
To select only some changes to merge, use "merge -i", which will prompt
3748
you to apply each diff hunk and file change, similar to "shelve".
3751
To merge the latest revision from bzr.dev::
3753
bzr merge ../bzr.dev
3755
To merge changes up to and including revision 82 from bzr.dev::
3757
bzr merge -r 82 ../bzr.dev
3759
To merge the changes introduced by 82, without previous changes::
3761
bzr merge -r 81..82 ../bzr.dev
3763
To apply a merge directive contained in /tmp/merge::
3765
bzr merge /tmp/merge
3767
To create a merge revision with three parents from two branches
3768
feature1a and feature1b:
3770
bzr merge ../feature1a
3771
bzr merge ../feature1b --force
3772
bzr commit -m 'revision with three parents'
3775
encoding_type = 'exact'
3776
_see_also = ['update', 'remerge', 'status-flags', 'send']
3777
takes_args = ['location?']
3782
help='Merge even if the destination tree has uncommitted changes.'),
3786
Option('show-base', help="Show base revision text in "
3788
Option('uncommitted', help='Apply uncommitted changes'
3789
' from a working copy, instead of branch changes.'),
3790
Option('pull', help='If the destination is already'
3791
' completely merged into the source, pull from the'
3792
' source rather than merging. When this happens,'
3793
' you do not need to commit the result.'),
3795
help='Branch to merge into, '
3796
'rather than the one containing the working directory.',
3800
Option('preview', help='Instead of merging, show a diff of the'
3802
Option('interactive', help='Select changes interactively.',
3806
def run(self, location=None, revision=None, force=False,
3807
merge_type=None, show_base=False, reprocess=None, remember=False,
3808
uncommitted=False, pull=False,
3813
if merge_type is None:
3814
merge_type = _mod_merge.Merge3Merger
3816
if directory is None: directory = u'.'
3817
possible_transports = []
3819
allow_pending = True
3820
verified = 'inapplicable'
3821
tree = WorkingTree.open_containing(directory)[0]
3824
basis_tree = tree.revision_tree(tree.last_revision())
3825
except errors.NoSuchRevision:
3826
basis_tree = tree.basis_tree()
3828
# die as quickly as possible if there are uncommitted changes
3830
if tree.has_changes():
3831
raise errors.UncommittedChanges(tree)
3833
view_info = _get_view_info_for_change_reporter(tree)
3834
change_reporter = delta._ChangeReporter(
3835
unversioned_filter=tree.is_ignored, view_info=view_info)
3836
pb = ui.ui_factory.nested_progress_bar()
3837
self.add_cleanup(pb.finished)
3839
self.add_cleanup(tree.unlock)
3840
if location is not None:
3842
mergeable = bundle.read_mergeable_from_url(location,
3843
possible_transports=possible_transports)
3844
except errors.NotABundle:
3848
raise errors.BzrCommandError('Cannot use --uncommitted'
3849
' with bundles or merge directives.')
3851
if revision is not None:
3852
raise errors.BzrCommandError(
3853
'Cannot use -r with merge directives or bundles')
3854
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3857
if merger is None and uncommitted:
3858
if revision is not None and len(revision) > 0:
3859
raise errors.BzrCommandError('Cannot use --uncommitted and'
3860
' --revision at the same time.')
3861
merger = self.get_merger_from_uncommitted(tree, location, None)
3862
allow_pending = False
3865
merger, allow_pending = self._get_merger_from_branch(tree,
3866
location, revision, remember, possible_transports, None)
3868
merger.merge_type = merge_type
3869
merger.reprocess = reprocess
3870
merger.show_base = show_base
3871
self.sanity_check_merger(merger)
3872
if (merger.base_rev_id == merger.other_rev_id and
3873
merger.other_rev_id is not None):
3874
note('Nothing to do.')
3877
if merger.interesting_files is not None:
3878
raise errors.BzrCommandError('Cannot pull individual files')
3879
if (merger.base_rev_id == tree.last_revision()):
3880
result = tree.pull(merger.other_branch, False,
3881
merger.other_rev_id)
3882
result.report(self.outf)
3884
if merger.this_basis is None:
3885
raise errors.BzrCommandError(
3886
"This branch has no commits."
3887
" (perhaps you would prefer 'bzr pull')")
3889
return self._do_preview(merger)
3891
return self._do_interactive(merger)
3893
return self._do_merge(merger, change_reporter, allow_pending,
3896
def _get_preview(self, merger):
3897
tree_merger = merger.make_merger()
3898
tt = tree_merger.make_preview_transform()
3899
self.add_cleanup(tt.finalize)
3900
result_tree = tt.get_preview_tree()
3903
def _do_preview(self, merger):
3904
from bzrlib.diff import show_diff_trees
3905
result_tree = self._get_preview(merger)
3906
show_diff_trees(merger.this_tree, result_tree, self.outf,
3907
old_label='', new_label='')
3909
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3910
merger.change_reporter = change_reporter
3911
conflict_count = merger.do_merge()
3913
merger.set_pending()
3914
if verified == 'failed':
3915
warning('Preview patch does not match changes')
3916
if conflict_count != 0:
3921
def _do_interactive(self, merger):
3922
"""Perform an interactive merge.
3924
This works by generating a preview tree of the merge, then using
3925
Shelver to selectively remove the differences between the working tree
3926
and the preview tree.
3928
from bzrlib import shelf_ui
3929
result_tree = self._get_preview(merger)
3930
writer = bzrlib.option.diff_writer_registry.get()
3931
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3932
reporter=shelf_ui.ApplyReporter(),
3933
diff_writer=writer(sys.stdout))
3939
def sanity_check_merger(self, merger):
3940
if (merger.show_base and
3941
not merger.merge_type is _mod_merge.Merge3Merger):
3942
raise errors.BzrCommandError("Show-base is not supported for this"
3943
" merge type. %s" % merger.merge_type)
3944
if merger.reprocess is None:
3945
if merger.show_base:
3946
merger.reprocess = False
3948
# Use reprocess if the merger supports it
3949
merger.reprocess = merger.merge_type.supports_reprocess
3950
if merger.reprocess and not merger.merge_type.supports_reprocess:
3951
raise errors.BzrCommandError("Conflict reduction is not supported"
3952
" for merge type %s." %
3954
if merger.reprocess and merger.show_base:
3955
raise errors.BzrCommandError("Cannot do conflict reduction and"
3958
def _get_merger_from_branch(self, tree, location, revision, remember,
3959
possible_transports, pb):
3960
"""Produce a merger from a location, assuming it refers to a branch."""
3961
from bzrlib.tag import _merge_tags_if_possible
3962
# find the branch locations
3963
other_loc, user_location = self._select_branch_location(tree, location,
3965
if revision is not None and len(revision) == 2:
3966
base_loc, _unused = self._select_branch_location(tree,
3967
location, revision, 0)
3969
base_loc = other_loc
3971
other_branch, other_path = Branch.open_containing(other_loc,
3972
possible_transports)
3973
if base_loc == other_loc:
3974
base_branch = other_branch
3976
base_branch, base_path = Branch.open_containing(base_loc,
3977
possible_transports)
3978
# Find the revision ids
3979
other_revision_id = None
3980
base_revision_id = None
3981
if revision is not None:
3982
if len(revision) >= 1:
3983
other_revision_id = revision[-1].as_revision_id(other_branch)
3984
if len(revision) == 2:
3985
base_revision_id = revision[0].as_revision_id(base_branch)
3986
if other_revision_id is None:
3987
other_revision_id = _mod_revision.ensure_null(
3988
other_branch.last_revision())
3989
# Remember where we merge from
3990
if ((remember or tree.branch.get_submit_branch() is None) and
3991
user_location is not None):
3992
tree.branch.set_submit_branch(other_branch.base)
3993
_merge_tags_if_possible(other_branch, tree.branch)
3994
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3995
other_revision_id, base_revision_id, other_branch, base_branch)
3996
if other_path != '':
3997
allow_pending = False
3998
merger.interesting_files = [other_path]
4000
allow_pending = True
4001
return merger, allow_pending
4003
def get_merger_from_uncommitted(self, tree, location, pb):
4004
"""Get a merger for uncommitted changes.
4006
:param tree: The tree the merger should apply to.
4007
:param location: The location containing uncommitted changes.
4008
:param pb: The progress bar to use for showing progress.
4010
location = self._select_branch_location(tree, location)[0]
4011
other_tree, other_path = WorkingTree.open_containing(location)
4012
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4013
if other_path != '':
4014
merger.interesting_files = [other_path]
4017
def _select_branch_location(self, tree, user_location, revision=None,
4019
"""Select a branch location, according to possible inputs.
4021
If provided, branches from ``revision`` are preferred. (Both
4022
``revision`` and ``index`` must be supplied.)
4024
Otherwise, the ``location`` parameter is used. If it is None, then the
4025
``submit`` or ``parent`` location is used, and a note is printed.
4027
:param tree: The working tree to select a branch for merging into
4028
:param location: The location entered by the user
4029
:param revision: The revision parameter to the command
4030
:param index: The index to use for the revision parameter. Negative
4031
indices are permitted.
4032
:return: (selected_location, user_location). The default location
4033
will be the user-entered location.
4035
if (revision is not None and index is not None
4036
and revision[index] is not None):
4037
branch = revision[index].get_branch()
4038
if branch is not None:
4039
return branch, branch
4040
if user_location is None:
4041
location = self._get_remembered(tree, 'Merging from')
4043
location = user_location
4044
return location, user_location
4046
def _get_remembered(self, tree, verb_string):
4047
"""Use tree.branch's parent if none was supplied.
4049
Report if the remembered location was used.
4051
stored_location = tree.branch.get_submit_branch()
4052
stored_location_type = "submit"
4053
if stored_location is None:
4054
stored_location = tree.branch.get_parent()
4055
stored_location_type = "parent"
4056
mutter("%s", stored_location)
4057
if stored_location is None:
4058
raise errors.BzrCommandError("No location specified or remembered")
4059
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4060
note(u"%s remembered %s location %s", verb_string,
4061
stored_location_type, display_url)
4062
return stored_location
4065
class cmd_remerge(Command):
4066
__doc__ = """Redo a merge.
4068
Use this if you want to try a different merge technique while resolving
4069
conflicts. Some merge techniques are better than others, and remerge
4070
lets you try different ones on different files.
4072
The options for remerge have the same meaning and defaults as the ones for
4073
merge. The difference is that remerge can (only) be run when there is a
4074
pending merge, and it lets you specify particular files.
4077
Re-do the merge of all conflicted files, and show the base text in
4078
conflict regions, in addition to the usual THIS and OTHER texts::
4080
bzr remerge --show-base
4082
Re-do the merge of "foobar", using the weave merge algorithm, with
4083
additional processing to reduce the size of conflict regions::
4085
bzr remerge --merge-type weave --reprocess foobar
4087
takes_args = ['file*']
4092
help="Show base revision text in conflicts."),
4095
def run(self, file_list=None, merge_type=None, show_base=False,
4097
from bzrlib.conflicts import restore
4098
if merge_type is None:
4099
merge_type = _mod_merge.Merge3Merger
4100
tree, file_list = tree_files(file_list)
4102
self.add_cleanup(tree.unlock)
4103
parents = tree.get_parent_ids()
4104
if len(parents) != 2:
4105
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4106
" merges. Not cherrypicking or"
4108
repository = tree.branch.repository
4109
interesting_ids = None
4111
conflicts = tree.conflicts()
4112
if file_list is not None:
4113
interesting_ids = set()
4114
for filename in file_list:
4115
file_id = tree.path2id(filename)
4117
raise errors.NotVersionedError(filename)
4118
interesting_ids.add(file_id)
4119
if tree.kind(file_id) != "directory":
4122
for name, ie in tree.inventory.iter_entries(file_id):
4123
interesting_ids.add(ie.file_id)
4124
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4126
# Remerge only supports resolving contents conflicts
4127
allowed_conflicts = ('text conflict', 'contents conflict')
4128
restore_files = [c.path for c in conflicts
4129
if c.typestring in allowed_conflicts]
4130
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4131
tree.set_conflicts(ConflictList(new_conflicts))
4132
if file_list is not None:
4133
restore_files = file_list
4134
for filename in restore_files:
4136
restore(tree.abspath(filename))
4137
except errors.NotConflicted:
4139
# Disable pending merges, because the file texts we are remerging
4140
# have not had those merges performed. If we use the wrong parents
4141
# list, we imply that the working tree text has seen and rejected
4142
# all the changes from the other tree, when in fact those changes
4143
# have not yet been seen.
4144
tree.set_parent_ids(parents[:1])
4146
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4147
merger.interesting_ids = interesting_ids
4148
merger.merge_type = merge_type
4149
merger.show_base = show_base
4150
merger.reprocess = reprocess
4151
conflicts = merger.do_merge()
4153
tree.set_parent_ids(parents)
4160
class cmd_revert(Command):
4161
__doc__ = """Revert files to a previous revision.
4163
Giving a list of files will revert only those files. Otherwise, all files
4164
will be reverted. If the revision is not specified with '--revision', the
4165
last committed revision is used.
4167
To remove only some changes, without reverting to a prior version, use
4168
merge instead. For example, "merge . --revision -2..-3" will remove the
4169
changes introduced by -2, without affecting the changes introduced by -1.
4170
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4172
By default, any files that have been manually changed will be backed up
4173
first. (Files changed only by merge are not backed up.) Backup files have
4174
'.~#~' appended to their name, where # is a number.
4176
When you provide files, you can use their current pathname or the pathname
4177
from the target revision. So you can use revert to "undelete" a file by
4178
name. If you name a directory, all the contents of that directory will be
4181
If you have newly added files since the target revision, they will be
4182
removed. If the files to be removed have been changed, backups will be
4183
created as above. Directories containing unknown files will not be
4186
The working tree contains a list of revisions that have been merged but
4187
not yet committed. These revisions will be included as additional parents
4188
of the next commit. Normally, using revert clears that list as well as
4189
reverting the files. If any files are specified, revert leaves the list
4190
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4191
.`` in the tree root to revert all files but keep the recorded merges,
4192
and ``bzr revert --forget-merges`` to clear the pending merge list without
4193
reverting any files.
4195
Using "bzr revert --forget-merges", it is possible to apply all of the
4196
changes from a branch in a single revision. To do this, perform the merge
4197
as desired. Then doing revert with the "--forget-merges" option will keep
4198
the content of the tree as it was, but it will clear the list of pending
4199
merges. The next commit will then contain all of the changes that are
4200
present in the other branch, but without any other parent revisions.
4201
Because this technique forgets where these changes originated, it may
4202
cause additional conflicts on later merges involving the same source and
4206
_see_also = ['cat', 'export']
4209
Option('no-backup', "Do not save backups of reverted files."),
4210
Option('forget-merges',
4211
'Remove pending merge marker, without changing any files.'),
4213
takes_args = ['file*']
4215
def run(self, revision=None, no_backup=False, file_list=None,
4216
forget_merges=None):
4217
tree, file_list = tree_files(file_list)
4218
tree.lock_tree_write()
4219
self.add_cleanup(tree.unlock)
4221
tree.set_parent_ids(tree.get_parent_ids()[:1])
4223
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4226
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4227
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4228
tree.revert(file_list, rev_tree, not no_backup, None,
4229
report_changes=True)
4232
class cmd_assert_fail(Command):
4233
__doc__ = """Test reporting of assertion failures"""
4234
# intended just for use in testing
4239
raise AssertionError("always fails")
4242
class cmd_help(Command):
4243
__doc__ = """Show help on a command or other topic.
4246
_see_also = ['topics']
4248
Option('long', 'Show help on all commands.'),
4250
takes_args = ['topic?']
4251
aliases = ['?', '--help', '-?', '-h']
4254
def run(self, topic=None, long=False):
4256
if topic is None and long:
4258
bzrlib.help.help(topic)
4261
class cmd_shell_complete(Command):
4262
__doc__ = """Show appropriate completions for context.
4264
For a list of all available commands, say 'bzr shell-complete'.
4266
takes_args = ['context?']
4271
def run(self, context=None):
4272
import shellcomplete
4273
shellcomplete.shellcomplete(context)
4276
class cmd_missing(Command):
4277
__doc__ = """Show unmerged/unpulled revisions between two branches.
4279
OTHER_BRANCH may be local or remote.
4281
To filter on a range of revisions, you can use the command -r begin..end
4282
-r revision requests a specific revision, -r ..end or -r begin.. are
4286
1 - some missing revisions
4287
0 - no missing revisions
4291
Determine the missing revisions between this and the branch at the
4292
remembered pull location::
4296
Determine the missing revisions between this and another branch::
4298
bzr missing http://server/branch
4300
Determine the missing revisions up to a specific revision on the other
4303
bzr missing -r ..-10
4305
Determine the missing revisions up to a specific revision on this
4308
bzr missing --my-revision ..-10
4311
_see_also = ['merge', 'pull']
4312
takes_args = ['other_branch?']
4314
Option('reverse', 'Reverse the order of revisions.'),
4316
'Display changes in the local branch only.'),
4317
Option('this' , 'Same as --mine-only.'),
4318
Option('theirs-only',
4319
'Display changes in the remote branch only.'),
4320
Option('other', 'Same as --theirs-only.'),
4324
custom_help('revision',
4325
help='Filter on other branch revisions (inclusive). '
4326
'See "help revisionspec" for details.'),
4327
Option('my-revision',
4328
type=_parse_revision_str,
4329
help='Filter on local branch revisions (inclusive). '
4330
'See "help revisionspec" for details.'),
4331
Option('include-merges',
4332
'Show all revisions in addition to the mainline ones.'),
4334
encoding_type = 'replace'
4337
def run(self, other_branch=None, reverse=False, mine_only=False,
4339
log_format=None, long=False, short=False, line=False,
4340
show_ids=False, verbose=False, this=False, other=False,
4341
include_merges=False, revision=None, my_revision=None):
4342
from bzrlib.missing import find_unmerged, iter_log_revisions
4351
# TODO: We should probably check that we don't have mine-only and
4352
# theirs-only set, but it gets complicated because we also have
4353
# this and other which could be used.
4360
local_branch = Branch.open_containing(u".")[0]
4361
local_branch.lock_read()
4362
self.add_cleanup(local_branch.unlock)
4364
parent = local_branch.get_parent()
4365
if other_branch is None:
4366
other_branch = parent
4367
if other_branch is None:
4368
raise errors.BzrCommandError("No peer location known"
4370
display_url = urlutils.unescape_for_display(parent,
4372
message("Using saved parent location: "
4373
+ display_url + "\n")
4375
remote_branch = Branch.open(other_branch)
4376
if remote_branch.base == local_branch.base:
4377
remote_branch = local_branch
4379
remote_branch.lock_read()
4380
self.add_cleanup(remote_branch.unlock)
4382
local_revid_range = _revision_range_to_revid_range(
4383
_get_revision_range(my_revision, local_branch,
4386
remote_revid_range = _revision_range_to_revid_range(
4387
_get_revision_range(revision,
4388
remote_branch, self.name()))
4390
local_extra, remote_extra = find_unmerged(
4391
local_branch, remote_branch, restrict,
4392
backward=not reverse,
4393
include_merges=include_merges,
4394
local_revid_range=local_revid_range,
4395
remote_revid_range=remote_revid_range)
4397
if log_format is None:
4398
registry = log.log_formatter_registry
4399
log_format = registry.get_default(local_branch)
4400
lf = log_format(to_file=self.outf,
4402
show_timezone='original')
4405
if local_extra and not theirs_only:
4406
message("You have %d extra revision(s):\n" %
4408
for revision in iter_log_revisions(local_extra,
4409
local_branch.repository,
4411
lf.log_revision(revision)
4412
printed_local = True
4415
printed_local = False
4417
if remote_extra and not mine_only:
4418
if printed_local is True:
4420
message("You are missing %d revision(s):\n" %
4422
for revision in iter_log_revisions(remote_extra,
4423
remote_branch.repository,
4425
lf.log_revision(revision)
4428
if mine_only and not local_extra:
4429
# We checked local, and found nothing extra
4430
message('This branch is up to date.\n')
4431
elif theirs_only and not remote_extra:
4432
# We checked remote, and found nothing extra
4433
message('Other branch is up to date.\n')
4434
elif not (mine_only or theirs_only or local_extra or
4436
# We checked both branches, and neither one had extra
4438
message("Branches are up to date.\n")
4440
if not status_code and parent is None and other_branch is not None:
4441
local_branch.lock_write()
4442
self.add_cleanup(local_branch.unlock)
4443
# handle race conditions - a parent might be set while we run.
4444
if local_branch.get_parent() is None:
4445
local_branch.set_parent(remote_branch.base)
4449
class cmd_pack(Command):
4450
__doc__ = """Compress the data within a repository.
4452
This operation compresses the data within a bazaar repository. As
4453
bazaar supports automatic packing of repository, this operation is
4454
normally not required to be done manually.
4456
During the pack operation, bazaar takes a backup of existing repository
4457
data, i.e. pack files. This backup is eventually removed by bazaar
4458
automatically when it is safe to do so. To save disk space by removing
4459
the backed up pack files, the --clean-obsolete-packs option may be
4462
Warning: If you use --clean-obsolete-packs and your machine crashes
4463
during or immediately after repacking, you may be left with a state
4464
where the deletion has been written to disk but the new packs have not
4465
been. In this case the repository may be unusable.
4468
_see_also = ['repositories']
4469
takes_args = ['branch_or_repo?']
4471
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4474
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4475
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4477
branch = dir.open_branch()
4478
repository = branch.repository
4479
except errors.NotBranchError:
4480
repository = dir.open_repository()
4481
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4484
class cmd_plugins(Command):
4485
__doc__ = """List the installed plugins.
4487
This command displays the list of installed plugins including
4488
version of plugin and a short description of each.
4490
--verbose shows the path where each plugin is located.
4492
A plugin is an external component for Bazaar that extends the
4493
revision control system, by adding or replacing code in Bazaar.
4494
Plugins can do a variety of things, including overriding commands,
4495
adding new commands, providing additional network transports and
4496
customizing log output.
4498
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4499
for further information on plugins including where to find them and how to
4500
install them. Instructions are also provided there on how to write new
4501
plugins using the Python programming language.
4503
takes_options = ['verbose']
4506
def run(self, verbose=False):
4507
import bzrlib.plugin
4508
from inspect import getdoc
4510
for name, plugin in bzrlib.plugin.plugins().items():
4511
version = plugin.__version__
4512
if version == 'unknown':
4514
name_ver = '%s %s' % (name, version)
4515
d = getdoc(plugin.module)
4517
doc = d.split('\n')[0]
4519
doc = '(no description)'
4520
result.append((name_ver, doc, plugin.path()))
4521
for name_ver, doc, path in sorted(result):
4522
self.outf.write("%s\n" % name_ver)
4523
self.outf.write(" %s\n" % doc)
4525
self.outf.write(" %s\n" % path)
4526
self.outf.write("\n")
4529
class cmd_testament(Command):
4530
__doc__ = """Show testament (signing-form) of a revision."""
4533
Option('long', help='Produce long-format testament.'),
4535
help='Produce a strict-format testament.')]
4536
takes_args = ['branch?']
4538
def run(self, branch=u'.', revision=None, long=False, strict=False):
4539
from bzrlib.testament import Testament, StrictTestament
4541
testament_class = StrictTestament
4543
testament_class = Testament
4545
b = Branch.open_containing(branch)[0]
4547
b = Branch.open(branch)
4549
self.add_cleanup(b.unlock)
4550
if revision is None:
4551
rev_id = b.last_revision()
4553
rev_id = revision[0].as_revision_id(b)
4554
t = testament_class.from_revision(b.repository, rev_id)
4556
sys.stdout.writelines(t.as_text_lines())
4558
sys.stdout.write(t.as_short_text())
4561
class cmd_annotate(Command):
4562
__doc__ = """Show the origin of each line in a file.
4564
This prints out the given file with an annotation on the left side
4565
indicating which revision, author and date introduced the change.
4567
If the origin is the same for a run of consecutive lines, it is
4568
shown only at the top, unless the --all option is given.
4570
# TODO: annotate directories; showing when each file was last changed
4571
# TODO: if the working copy is modified, show annotations on that
4572
# with new uncommitted lines marked
4573
aliases = ['ann', 'blame', 'praise']
4574
takes_args = ['filename']
4575
takes_options = [Option('all', help='Show annotations on all lines.'),
4576
Option('long', help='Show commit date in annotations.'),
4580
encoding_type = 'exact'
4583
def run(self, filename, all=False, long=False, revision=None,
4585
from bzrlib.annotate import annotate_file, annotate_file_tree
4586
wt, branch, relpath = \
4587
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4590
self.add_cleanup(wt.unlock)
4593
self.add_cleanup(branch.unlock)
4594
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4596
self.add_cleanup(tree.unlock)
4598
file_id = wt.path2id(relpath)
4600
file_id = tree.path2id(relpath)
4602
raise errors.NotVersionedError(filename)
4603
file_version = tree.inventory[file_id].revision
4604
if wt is not None and revision is None:
4605
# If there is a tree and we're not annotating historical
4606
# versions, annotate the working tree's content.
4607
annotate_file_tree(wt, file_id, self.outf, long, all,
4610
annotate_file(branch, file_version, file_id, long, all, self.outf,
4614
class cmd_re_sign(Command):
4615
__doc__ = """Create a digital signature for an existing revision."""
4616
# TODO be able to replace existing ones.
4618
hidden = True # is this right ?
4619
takes_args = ['revision_id*']
4620
takes_options = ['revision']
4622
def run(self, revision_id_list=None, revision=None):
4623
if revision_id_list is not None and revision is not None:
4624
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4625
if revision_id_list is None and revision is None:
4626
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4627
b = WorkingTree.open_containing(u'.')[0].branch
4629
self.add_cleanup(b.unlock)
4630
return self._run(b, revision_id_list, revision)
4632
def _run(self, b, revision_id_list, revision):
4633
import bzrlib.gpg as gpg
4634
gpg_strategy = gpg.GPGStrategy(b.get_config())
4635
if revision_id_list is not None:
4636
b.repository.start_write_group()
4638
for revision_id in revision_id_list:
4639
b.repository.sign_revision(revision_id, gpg_strategy)
4641
b.repository.abort_write_group()
4644
b.repository.commit_write_group()
4645
elif revision is not None:
4646
if len(revision) == 1:
4647
revno, rev_id = revision[0].in_history(b)
4648
b.repository.start_write_group()
4650
b.repository.sign_revision(rev_id, gpg_strategy)
4652
b.repository.abort_write_group()
4655
b.repository.commit_write_group()
4656
elif len(revision) == 2:
4657
# are they both on rh- if so we can walk between them
4658
# might be nice to have a range helper for arbitrary
4659
# revision paths. hmm.
4660
from_revno, from_revid = revision[0].in_history(b)
4661
to_revno, to_revid = revision[1].in_history(b)
4662
if to_revid is None:
4663
to_revno = b.revno()
4664
if from_revno is None or to_revno is None:
4665
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4666
b.repository.start_write_group()
4668
for revno in range(from_revno, to_revno + 1):
4669
b.repository.sign_revision(b.get_rev_id(revno),
4672
b.repository.abort_write_group()
4675
b.repository.commit_write_group()
4677
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4680
class cmd_bind(Command):
4681
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4683
Once converted into a checkout, commits must succeed on the master branch
4684
before they will be applied to the local branch.
4686
Bound branches use the nickname of its master branch unless it is set
4687
locally, in which case binding will update the local nickname to be
4691
_see_also = ['checkouts', 'unbind']
4692
takes_args = ['location?']
4695
def run(self, location=None):
4696
b, relpath = Branch.open_containing(u'.')
4697
if location is None:
4699
location = b.get_old_bound_location()
4700
except errors.UpgradeRequired:
4701
raise errors.BzrCommandError('No location supplied. '
4702
'This format does not remember old locations.')
4704
if location is None:
4705
if b.get_bound_location() is not None:
4706
raise errors.BzrCommandError('Branch is already bound')
4708
raise errors.BzrCommandError('No location supplied '
4709
'and no previous location known')
4710
b_other = Branch.open(location)
4713
except errors.DivergedBranches:
4714
raise errors.BzrCommandError('These branches have diverged.'
4715
' Try merging, and then bind again.')
4716
if b.get_config().has_explicit_nickname():
4717
b.nick = b_other.nick
4720
class cmd_unbind(Command):
4721
__doc__ = """Convert the current checkout into a regular branch.
4723
After unbinding, the local branch is considered independent and subsequent
4724
commits will be local only.
4727
_see_also = ['checkouts', 'bind']
4732
b, relpath = Branch.open_containing(u'.')
4734
raise errors.BzrCommandError('Local branch is not bound')
4737
class cmd_uncommit(Command):
4738
__doc__ = """Remove the last committed revision.
4740
--verbose will print out what is being removed.
4741
--dry-run will go through all the motions, but not actually
4744
If --revision is specified, uncommit revisions to leave the branch at the
4745
specified revision. For example, "bzr uncommit -r 15" will leave the
4746
branch at revision 15.
4748
Uncommit leaves the working tree ready for a new commit. The only change
4749
it may make is to restore any pending merges that were present before
4753
# TODO: jam 20060108 Add an option to allow uncommit to remove
4754
# unreferenced information in 'branch-as-repository' branches.
4755
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4756
# information in shared branches as well.
4757
_see_also = ['commit']
4758
takes_options = ['verbose', 'revision',
4759
Option('dry-run', help='Don\'t actually make changes.'),
4760
Option('force', help='Say yes to all questions.'),
4762
help="Only remove the commits from the local branch"
4763
" when in a checkout."
4766
takes_args = ['location?']
4768
encoding_type = 'replace'
4770
def run(self, location=None,
4771
dry_run=False, verbose=False,
4772
revision=None, force=False, local=False):
4773
if location is None:
4775
control, relpath = bzrdir.BzrDir.open_containing(location)
4777
tree = control.open_workingtree()
4779
except (errors.NoWorkingTree, errors.NotLocalUrl):
4781
b = control.open_branch()
4783
if tree is not None:
4785
self.add_cleanup(tree.unlock)
4788
self.add_cleanup(b.unlock)
4789
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4791
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4792
from bzrlib.log import log_formatter, show_log
4793
from bzrlib.uncommit import uncommit
4795
last_revno, last_rev_id = b.last_revision_info()
4798
if revision is None:
4800
rev_id = last_rev_id
4802
# 'bzr uncommit -r 10' actually means uncommit
4803
# so that the final tree is at revno 10.
4804
# but bzrlib.uncommit.uncommit() actually uncommits
4805
# the revisions that are supplied.
4806
# So we need to offset it by one
4807
revno = revision[0].in_history(b).revno + 1
4808
if revno <= last_revno:
4809
rev_id = b.get_rev_id(revno)
4811
if rev_id is None or _mod_revision.is_null(rev_id):
4812
self.outf.write('No revisions to uncommit.\n')
4815
lf = log_formatter('short',
4817
show_timezone='original')
4822
direction='forward',
4823
start_revision=revno,
4824
end_revision=last_revno)
4827
self.outf.write('Dry-run, pretending to remove'
4828
' the above revisions.\n')
4830
self.outf.write('The above revision(s) will be removed.\n')
4833
if not ui.ui_factory.get_boolean('Are you sure'):
4834
self.outf.write('Canceled')
4837
mutter('Uncommitting from {%s} to {%s}',
4838
last_rev_id, rev_id)
4839
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4840
revno=revno, local=local)
4841
self.outf.write('You can restore the old tip by running:\n'
4842
' bzr pull . -r revid:%s\n' % last_rev_id)
4845
class cmd_break_lock(Command):
4846
__doc__ = """Break a dead lock on a repository, branch or working directory.
4848
CAUTION: Locks should only be broken when you are sure that the process
4849
holding the lock has been stopped.
4851
You can get information on what locks are open via the 'bzr info
4852
[location]' command.
4856
bzr break-lock bzr+ssh://example.com/bzr/foo
4858
takes_args = ['location?']
4860
def run(self, location=None, show=False):
4861
if location is None:
4863
control, relpath = bzrdir.BzrDir.open_containing(location)
4865
control.break_lock()
4866
except NotImplementedError:
4870
class cmd_wait_until_signalled(Command):
4871
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4873
This just prints a line to signal when it is ready, then blocks on stdin.
4879
sys.stdout.write("running\n")
4881
sys.stdin.readline()
4884
class cmd_serve(Command):
4885
__doc__ = """Run the bzr server."""
4887
aliases = ['server']
4891
help='Serve on stdin/out for use from inetd or sshd.'),
4892
RegistryOption('protocol',
4893
help="Protocol to serve.",
4894
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4895
value_switches=True),
4897
help='Listen for connections on nominated port of the form '
4898
'[hostname:]portnumber. Passing 0 as the port number will '
4899
'result in a dynamically allocated port. The default port '
4900
'depends on the protocol.',
4903
help='Serve contents of this directory.',
4905
Option('allow-writes',
4906
help='By default the server is a readonly server. Supplying '
4907
'--allow-writes enables write access to the contents of '
4908
'the served directory and below. Note that ``bzr serve`` '
4909
'does not perform authentication, so unless some form of '
4910
'external authentication is arranged supplying this '
4911
'option leads to global uncontrolled write access to your '
4916
def get_host_and_port(self, port):
4917
"""Return the host and port to run the smart server on.
4919
If 'port' is None, None will be returned for the host and port.
4921
If 'port' has a colon in it, the string before the colon will be
4922
interpreted as the host.
4924
:param port: A string of the port to run the server on.
4925
:return: A tuple of (host, port), where 'host' is a host name or IP,
4926
and port is an integer TCP/IP port.
4929
if port is not None:
4931
host, port = port.split(':')
4935
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4937
from bzrlib.transport import get_transport, transport_server_registry
4938
if directory is None:
4939
directory = os.getcwd()
4940
if protocol is None:
4941
protocol = transport_server_registry.get()
4942
host, port = self.get_host_and_port(port)
4943
url = urlutils.local_path_to_url(directory)
4944
if not allow_writes:
4945
url = 'readonly+' + url
4946
transport = get_transport(url)
4947
protocol(transport, host, port, inet)
4950
class cmd_join(Command):
4951
__doc__ = """Combine a tree into its containing tree.
4953
This command requires the target tree to be in a rich-root format.
4955
The TREE argument should be an independent tree, inside another tree, but
4956
not part of it. (Such trees can be produced by "bzr split", but also by
4957
running "bzr branch" with the target inside a tree.)
4959
The result is a combined tree, with the subtree no longer an independant
4960
part. This is marked as a merge of the subtree into the containing tree,
4961
and all history is preserved.
4964
_see_also = ['split']
4965
takes_args = ['tree']
4967
Option('reference', help='Join by reference.', hidden=True),
4970
def run(self, tree, reference=False):
4971
sub_tree = WorkingTree.open(tree)
4972
parent_dir = osutils.dirname(sub_tree.basedir)
4973
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4974
repo = containing_tree.branch.repository
4975
if not repo.supports_rich_root():
4976
raise errors.BzrCommandError(
4977
"Can't join trees because %s doesn't support rich root data.\n"
4978
"You can use bzr upgrade on the repository."
4982
containing_tree.add_reference(sub_tree)
4983
except errors.BadReferenceTarget, e:
4984
# XXX: Would be better to just raise a nicely printable
4985
# exception from the real origin. Also below. mbp 20070306
4986
raise errors.BzrCommandError("Cannot join %s. %s" %
4990
containing_tree.subsume(sub_tree)
4991
except errors.BadSubsumeSource, e:
4992
raise errors.BzrCommandError("Cannot join %s. %s" %
4996
class cmd_split(Command):
4997
__doc__ = """Split a subdirectory of a tree into a separate tree.
4999
This command will produce a target tree in a format that supports
5000
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5001
converted into earlier formats like 'dirstate-tags'.
5003
The TREE argument should be a subdirectory of a working tree. That
5004
subdirectory will be converted into an independent tree, with its own
5005
branch. Commits in the top-level tree will not apply to the new subtree.
5008
_see_also = ['join']
5009
takes_args = ['tree']
5011
def run(self, tree):
5012
containing_tree, subdir = WorkingTree.open_containing(tree)
5013
sub_id = containing_tree.path2id(subdir)
5015
raise errors.NotVersionedError(subdir)
5017
containing_tree.extract(sub_id)
5018
except errors.RootNotRich:
5019
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5022
class cmd_merge_directive(Command):
5023
__doc__ = """Generate a merge directive for auto-merge tools.
5025
A directive requests a merge to be performed, and also provides all the
5026
information necessary to do so. This means it must either include a
5027
revision bundle, or the location of a branch containing the desired
5030
A submit branch (the location to merge into) must be supplied the first
5031
time the command is issued. After it has been supplied once, it will
5032
be remembered as the default.
5034
A public branch is optional if a revision bundle is supplied, but required
5035
if --diff or --plain is specified. It will be remembered as the default
5036
after the first use.
5039
takes_args = ['submit_branch?', 'public_branch?']
5043
_see_also = ['send']
5046
RegistryOption.from_kwargs('patch-type',
5047
'The type of patch to include in the directive.',
5049
value_switches=True,
5051
bundle='Bazaar revision bundle (default).',
5052
diff='Normal unified diff.',
5053
plain='No patch, just directive.'),
5054
Option('sign', help='GPG-sign the directive.'), 'revision',
5055
Option('mail-to', type=str,
5056
help='Instead of printing the directive, email to this address.'),
5057
Option('message', type=str, short_name='m',
5058
help='Message to use when committing this merge.')
5061
encoding_type = 'exact'
5063
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5064
sign=False, revision=None, mail_to=None, message=None):
5065
from bzrlib.revision import ensure_null, NULL_REVISION
5066
include_patch, include_bundle = {
5067
'plain': (False, False),
5068
'diff': (True, False),
5069
'bundle': (True, True),
5071
branch = Branch.open('.')
5072
stored_submit_branch = branch.get_submit_branch()
5073
if submit_branch is None:
5074
submit_branch = stored_submit_branch
5076
if stored_submit_branch is None:
5077
branch.set_submit_branch(submit_branch)
5078
if submit_branch is None:
5079
submit_branch = branch.get_parent()
5080
if submit_branch is None:
5081
raise errors.BzrCommandError('No submit branch specified or known')
5083
stored_public_branch = branch.get_public_branch()
5084
if public_branch is None:
5085
public_branch = stored_public_branch
5086
elif stored_public_branch is None:
5087
branch.set_public_branch(public_branch)
5088
if not include_bundle and public_branch is None:
5089
raise errors.BzrCommandError('No public branch specified or'
5091
base_revision_id = None
5092
if revision is not None:
5093
if len(revision) > 2:
5094
raise errors.BzrCommandError('bzr merge-directive takes '
5095
'at most two one revision identifiers')
5096
revision_id = revision[-1].as_revision_id(branch)
5097
if len(revision) == 2:
5098
base_revision_id = revision[0].as_revision_id(branch)
5100
revision_id = branch.last_revision()
5101
revision_id = ensure_null(revision_id)
5102
if revision_id == NULL_REVISION:
5103
raise errors.BzrCommandError('No revisions to bundle.')
5104
directive = merge_directive.MergeDirective2.from_objects(
5105
branch.repository, revision_id, time.time(),
5106
osutils.local_time_offset(), submit_branch,
5107
public_branch=public_branch, include_patch=include_patch,
5108
include_bundle=include_bundle, message=message,
5109
base_revision_id=base_revision_id)
5112
self.outf.write(directive.to_signed(branch))
5114
self.outf.writelines(directive.to_lines())
5116
message = directive.to_email(mail_to, branch, sign)
5117
s = SMTPConnection(branch.get_config())
5118
s.send_email(message)
5121
class cmd_send(Command):
5122
__doc__ = """Mail or create a merge-directive for submitting changes.
5124
A merge directive provides many things needed for requesting merges:
5126
* A machine-readable description of the merge to perform
5128
* An optional patch that is a preview of the changes requested
5130
* An optional bundle of revision data, so that the changes can be applied
5131
directly from the merge directive, without retrieving data from a
5134
`bzr send` creates a compact data set that, when applied using bzr
5135
merge, has the same effect as merging from the source branch.
5137
By default the merge directive is self-contained and can be applied to any
5138
branch containing submit_branch in its ancestory without needing access to
5141
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5142
revisions, but only a structured request to merge from the
5143
public_location. In that case the public_branch is needed and it must be
5144
up-to-date and accessible to the recipient. The public_branch is always
5145
included if known, so that people can check it later.
5147
The submit branch defaults to the parent of the source branch, but can be
5148
overridden. Both submit branch and public branch will be remembered in
5149
branch.conf the first time they are used for a particular branch. The
5150
source branch defaults to that containing the working directory, but can
5151
be changed using --from.
5153
In order to calculate those changes, bzr must analyse the submit branch.
5154
Therefore it is most efficient for the submit branch to be a local mirror.
5155
If a public location is known for the submit_branch, that location is used
5156
in the merge directive.
5158
The default behaviour is to send the merge directive by mail, unless -o is
5159
given, in which case it is sent to a file.
5161
Mail is sent using your preferred mail program. This should be transparent
5162
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5163
If the preferred client can't be found (or used), your editor will be used.
5165
To use a specific mail program, set the mail_client configuration option.
5166
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5167
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5168
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5169
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5172
If mail is being sent, a to address is required. This can be supplied
5173
either on the commandline, by setting the submit_to configuration
5174
option in the branch itself or the child_submit_to configuration option
5175
in the submit branch.
5177
Two formats are currently supported: "4" uses revision bundle format 4 and
5178
merge directive format 2. It is significantly faster and smaller than
5179
older formats. It is compatible with Bazaar 0.19 and later. It is the
5180
default. "0.9" uses revision bundle format 0.9 and merge directive
5181
format 1. It is compatible with Bazaar 0.12 - 0.18.
5183
The merge directives created by bzr send may be applied using bzr merge or
5184
bzr pull by specifying a file containing a merge directive as the location.
5186
bzr send makes extensive use of public locations to map local locations into
5187
URLs that can be used by other people. See `bzr help configuration` to
5188
set them, and use `bzr info` to display them.
5191
encoding_type = 'exact'
5193
_see_also = ['merge', 'pull']
5195
takes_args = ['submit_branch?', 'public_branch?']
5199
help='Do not include a bundle in the merge directive.'),
5200
Option('no-patch', help='Do not include a preview patch in the merge'
5203
help='Remember submit and public branch.'),
5205
help='Branch to generate the submission from, '
5206
'rather than the one containing the working directory.',
5209
Option('output', short_name='o',
5210
help='Write merge directive to this file or directory; '
5211
'use - for stdout.',
5214
help='Refuse to send if there are uncommitted changes in'
5215
' the working tree, --no-strict disables the check.'),
5216
Option('mail-to', help='Mail the request to this address.',
5220
Option('body', help='Body for the email.', type=unicode),
5221
RegistryOption('format',
5222
help='Use the specified output format.',
5223
lazy_registry=('bzrlib.send', 'format_registry')),
5226
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5227
no_patch=False, revision=None, remember=False, output=None,
5228
format=None, mail_to=None, message=None, body=None,
5229
strict=None, **kwargs):
5230
from bzrlib.send import send
5231
return send(submit_branch, revision, public_branch, remember,
5232
format, no_bundle, no_patch, output,
5233
kwargs.get('from', '.'), mail_to, message, body,
5238
class cmd_bundle_revisions(cmd_send):
5239
__doc__ = """Create a merge-directive for submitting changes.
5241
A merge directive provides many things needed for requesting merges:
5243
* A machine-readable description of the merge to perform
5245
* An optional patch that is a preview of the changes requested
5247
* An optional bundle of revision data, so that the changes can be applied
5248
directly from the merge directive, without retrieving data from a
5251
If --no-bundle is specified, then public_branch is needed (and must be
5252
up-to-date), so that the receiver can perform the merge using the
5253
public_branch. The public_branch is always included if known, so that
5254
people can check it later.
5256
The submit branch defaults to the parent, but can be overridden. Both
5257
submit branch and public branch will be remembered if supplied.
5259
If a public_branch is known for the submit_branch, that public submit
5260
branch is used in the merge instructions. This means that a local mirror
5261
can be used as your actual submit branch, once you have set public_branch
5264
Two formats are currently supported: "4" uses revision bundle format 4 and
5265
merge directive format 2. It is significantly faster and smaller than
5266
older formats. It is compatible with Bazaar 0.19 and later. It is the
5267
default. "0.9" uses revision bundle format 0.9 and merge directive
5268
format 1. It is compatible with Bazaar 0.12 - 0.18.
5273
help='Do not include a bundle in the merge directive.'),
5274
Option('no-patch', help='Do not include a preview patch in the merge'
5277
help='Remember submit and public branch.'),
5279
help='Branch to generate the submission from, '
5280
'rather than the one containing the working directory.',
5283
Option('output', short_name='o', help='Write directive to this file.',
5286
help='Refuse to bundle revisions if there are uncommitted'
5287
' changes in the working tree, --no-strict disables the check.'),
5289
RegistryOption('format',
5290
help='Use the specified output format.',
5291
lazy_registry=('bzrlib.send', 'format_registry')),
5293
aliases = ['bundle']
5295
_see_also = ['send', 'merge']
5299
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5300
no_patch=False, revision=None, remember=False, output=None,
5301
format=None, strict=None, **kwargs):
5304
from bzrlib.send import send
5305
return send(submit_branch, revision, public_branch, remember,
5306
format, no_bundle, no_patch, output,
5307
kwargs.get('from', '.'), None, None, None,
5308
self.outf, strict=strict)
5311
class cmd_tag(Command):
5312
__doc__ = """Create, remove or modify a tag naming a revision.
5314
Tags give human-meaningful names to revisions. Commands that take a -r
5315
(--revision) option can be given -rtag:X, where X is any previously
5318
Tags are stored in the branch. Tags are copied from one branch to another
5319
along when you branch, push, pull or merge.
5321
It is an error to give a tag name that already exists unless you pass
5322
--force, in which case the tag is moved to point to the new revision.
5324
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5325
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5327
If no tag name is specified it will be determined through the
5328
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5329
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5333
_see_also = ['commit', 'tags']
5334
takes_args = ['tag_name?']
5337
help='Delete this tag rather than placing it.',
5340
help='Branch in which to place the tag.',
5345
help='Replace existing tags.',
5350
def run(self, tag_name=None,
5356
branch, relpath = Branch.open_containing(directory)
5358
self.add_cleanup(branch.unlock)
5360
if tag_name is None:
5361
raise errors.BzrCommandError("No tag specified to delete.")
5362
branch.tags.delete_tag(tag_name)
5363
self.outf.write('Deleted tag %s.\n' % tag_name)
5366
if len(revision) != 1:
5367
raise errors.BzrCommandError(
5368
"Tags can only be placed on a single revision, "
5370
revision_id = revision[0].as_revision_id(branch)
5372
revision_id = branch.last_revision()
5373
if tag_name is None:
5374
tag_name = branch.automatic_tag_name(revision_id)
5375
if tag_name is None:
5376
raise errors.BzrCommandError(
5377
"Please specify a tag name.")
5378
if (not force) and branch.tags.has_tag(tag_name):
5379
raise errors.TagAlreadyExists(tag_name)
5380
branch.tags.set_tag(tag_name, revision_id)
5381
self.outf.write('Created tag %s.\n' % tag_name)
5384
class cmd_tags(Command):
5385
__doc__ = """List tags.
5387
This command shows a table of tag names and the revisions they reference.
5393
help='Branch whose tags should be displayed.',
5397
RegistryOption.from_kwargs('sort',
5398
'Sort tags by different criteria.', title='Sorting',
5399
alpha='Sort tags lexicographically (default).',
5400
time='Sort tags chronologically.',
5413
branch, relpath = Branch.open_containing(directory)
5415
tags = branch.tags.get_tag_dict().items()
5420
self.add_cleanup(branch.unlock)
5422
graph = branch.repository.get_graph()
5423
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5424
revid1, revid2 = rev1.rev_id, rev2.rev_id
5425
# only show revisions between revid1 and revid2 (inclusive)
5426
tags = [(tag, revid) for tag, revid in tags if
5427
graph.is_between(revid, revid1, revid2)]
5430
elif sort == 'time':
5432
for tag, revid in tags:
5434
revobj = branch.repository.get_revision(revid)
5435
except errors.NoSuchRevision:
5436
timestamp = sys.maxint # place them at the end
5438
timestamp = revobj.timestamp
5439
timestamps[revid] = timestamp
5440
tags.sort(key=lambda x: timestamps[x[1]])
5442
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5443
for index, (tag, revid) in enumerate(tags):
5445
revno = branch.revision_id_to_dotted_revno(revid)
5446
if isinstance(revno, tuple):
5447
revno = '.'.join(map(str, revno))
5448
except errors.NoSuchRevision:
5449
# Bad tag data/merges can lead to tagged revisions
5450
# which are not in this branch. Fail gracefully ...
5452
tags[index] = (tag, revno)
5454
for tag, revspec in tags:
5455
self.outf.write('%-20s %s\n' % (tag, revspec))
5458
class cmd_reconfigure(Command):
5459
__doc__ = """Reconfigure the type of a bzr directory.
5461
A target configuration must be specified.
5463
For checkouts, the bind-to location will be auto-detected if not specified.
5464
The order of preference is
5465
1. For a lightweight checkout, the current bound location.
5466
2. For branches that used to be checkouts, the previously-bound location.
5467
3. The push location.
5468
4. The parent location.
5469
If none of these is available, --bind-to must be specified.
5472
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5473
takes_args = ['location?']
5475
RegistryOption.from_kwargs(
5477
title='Target type',
5478
help='The type to reconfigure the directory to.',
5479
value_switches=True, enum_switch=False,
5480
branch='Reconfigure to be an unbound branch with no working tree.',
5481
tree='Reconfigure to be an unbound branch with a working tree.',
5482
checkout='Reconfigure to be a bound branch with a working tree.',
5483
lightweight_checkout='Reconfigure to be a lightweight'
5484
' checkout (with no local history).',
5485
standalone='Reconfigure to be a standalone branch '
5486
'(i.e. stop using shared repository).',
5487
use_shared='Reconfigure to use a shared repository.',
5488
with_trees='Reconfigure repository to create '
5489
'working trees on branches by default.',
5490
with_no_trees='Reconfigure repository to not create '
5491
'working trees on branches by default.'
5493
Option('bind-to', help='Branch to bind checkout to.', type=str),
5495
help='Perform reconfiguration even if local changes'
5497
Option('stacked-on',
5498
help='Reconfigure a branch to be stacked on another branch.',
5502
help='Reconfigure a branch to be unstacked. This '
5503
'may require copying substantial data into it.',
5507
def run(self, location=None, target_type=None, bind_to=None, force=False,
5510
directory = bzrdir.BzrDir.open(location)
5511
if stacked_on and unstacked:
5512
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5513
elif stacked_on is not None:
5514
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5516
reconfigure.ReconfigureUnstacked().apply(directory)
5517
# At the moment you can use --stacked-on and a different
5518
# reconfiguration shape at the same time; there seems no good reason
5520
if target_type is None:
5521
if stacked_on or unstacked:
5524
raise errors.BzrCommandError('No target configuration '
5526
elif target_type == 'branch':
5527
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5528
elif target_type == 'tree':
5529
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5530
elif target_type == 'checkout':
5531
reconfiguration = reconfigure.Reconfigure.to_checkout(
5533
elif target_type == 'lightweight-checkout':
5534
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5536
elif target_type == 'use-shared':
5537
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5538
elif target_type == 'standalone':
5539
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5540
elif target_type == 'with-trees':
5541
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5543
elif target_type == 'with-no-trees':
5544
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5546
reconfiguration.apply(force)
5549
class cmd_switch(Command):
5550
__doc__ = """Set the branch of a checkout and update.
5552
For lightweight checkouts, this changes the branch being referenced.
5553
For heavyweight checkouts, this checks that there are no local commits
5554
versus the current bound branch, then it makes the local branch a mirror
5555
of the new location and binds to it.
5557
In both cases, the working tree is updated and uncommitted changes
5558
are merged. The user can commit or revert these as they desire.
5560
Pending merges need to be committed or reverted before using switch.
5562
The path to the branch to switch to can be specified relative to the parent
5563
directory of the current branch. For example, if you are currently in a
5564
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5567
Bound branches use the nickname of its master branch unless it is set
5568
locally, in which case switching will update the local nickname to be
5572
takes_args = ['to_location?']
5573
takes_options = [Option('force',
5574
help='Switch even if local commits will be lost.'),
5576
Option('create-branch', short_name='b',
5577
help='Create the target branch from this one before'
5578
' switching to it.'),
5581
def run(self, to_location=None, force=False, create_branch=False,
5583
from bzrlib import switch
5585
revision = _get_one_revision('switch', revision)
5586
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5587
if to_location is None:
5588
if revision is None:
5589
raise errors.BzrCommandError('You must supply either a'
5590
' revision or a location')
5593
branch = control_dir.open_branch()
5594
had_explicit_nick = branch.get_config().has_explicit_nickname()
5595
except errors.NotBranchError:
5597
had_explicit_nick = False
5600
raise errors.BzrCommandError('cannot create branch without'
5602
to_location = directory_service.directories.dereference(
5604
if '/' not in to_location and '\\' not in to_location:
5605
# This path is meant to be relative to the existing branch
5606
this_url = self._get_branch_location(control_dir)
5607
to_location = urlutils.join(this_url, '..', to_location)
5608
to_branch = branch.bzrdir.sprout(to_location,
5609
possible_transports=[branch.bzrdir.root_transport],
5610
source_branch=branch).open_branch()
5613
to_branch = Branch.open(to_location)
5614
except errors.NotBranchError:
5615
this_url = self._get_branch_location(control_dir)
5616
to_branch = Branch.open(
5617
urlutils.join(this_url, '..', to_location))
5618
if revision is not None:
5619
revision = revision.as_revision_id(to_branch)
5620
switch.switch(control_dir, to_branch, force, revision_id=revision)
5621
if had_explicit_nick:
5622
branch = control_dir.open_branch() #get the new branch!
5623
branch.nick = to_branch.nick
5624
note('Switched to branch: %s',
5625
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5627
def _get_branch_location(self, control_dir):
5628
"""Return location of branch for this control dir."""
5630
this_branch = control_dir.open_branch()
5631
# This may be a heavy checkout, where we want the master branch
5632
master_location = this_branch.get_bound_location()
5633
if master_location is not None:
5634
return master_location
5635
# If not, use a local sibling
5636
return this_branch.base
5637
except errors.NotBranchError:
5638
format = control_dir.find_branch_format()
5639
if getattr(format, 'get_reference', None) is not None:
5640
return format.get_reference(control_dir)
5642
return control_dir.root_transport.base
5645
class cmd_view(Command):
5646
__doc__ = """Manage filtered views.
5648
Views provide a mask over the tree so that users can focus on
5649
a subset of a tree when doing their work. After creating a view,
5650
commands that support a list of files - status, diff, commit, etc -
5651
effectively have that list of files implicitly given each time.
5652
An explicit list of files can still be given but those files
5653
must be within the current view.
5655
In most cases, a view has a short life-span: it is created to make
5656
a selected change and is deleted once that change is committed.
5657
At other times, you may wish to create one or more named views
5658
and switch between them.
5660
To disable the current view without deleting it, you can switch to
5661
the pseudo view called ``off``. This can be useful when you need
5662
to see the whole tree for an operation or two (e.g. merge) but
5663
want to switch back to your view after that.
5666
To define the current view::
5668
bzr view file1 dir1 ...
5670
To list the current view::
5674
To delete the current view::
5678
To disable the current view without deleting it::
5680
bzr view --switch off
5682
To define a named view and switch to it::
5684
bzr view --name view-name file1 dir1 ...
5686
To list a named view::
5688
bzr view --name view-name
5690
To delete a named view::
5692
bzr view --name view-name --delete
5694
To switch to a named view::
5696
bzr view --switch view-name
5698
To list all views defined::
5702
To delete all views::
5704
bzr view --delete --all
5708
takes_args = ['file*']
5711
help='Apply list or delete action to all views.',
5714
help='Delete the view.',
5717
help='Name of the view to define, list or delete.',
5721
help='Name of the view to switch to.',
5726
def run(self, file_list,
5732
tree, file_list = tree_files(file_list, apply_view=False)
5733
current_view, view_dict = tree.views.get_view_info()
5738
raise errors.BzrCommandError(
5739
"Both --delete and a file list specified")
5741
raise errors.BzrCommandError(
5742
"Both --delete and --switch specified")
5744
tree.views.set_view_info(None, {})
5745
self.outf.write("Deleted all views.\n")
5747
raise errors.BzrCommandError("No current view to delete")
5749
tree.views.delete_view(name)
5750
self.outf.write("Deleted '%s' view.\n" % name)
5753
raise errors.BzrCommandError(
5754
"Both --switch and a file list specified")
5756
raise errors.BzrCommandError(
5757
"Both --switch and --all specified")
5758
elif switch == 'off':
5759
if current_view is None:
5760
raise errors.BzrCommandError("No current view to disable")
5761
tree.views.set_view_info(None, view_dict)
5762
self.outf.write("Disabled '%s' view.\n" % (current_view))
5764
tree.views.set_view_info(switch, view_dict)
5765
view_str = views.view_display_str(tree.views.lookup_view())
5766
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5769
self.outf.write('Views defined:\n')
5770
for view in sorted(view_dict):
5771
if view == current_view:
5775
view_str = views.view_display_str(view_dict[view])
5776
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5778
self.outf.write('No views defined.\n')
5781
# No name given and no current view set
5784
raise errors.BzrCommandError(
5785
"Cannot change the 'off' pseudo view")
5786
tree.views.set_view(name, sorted(file_list))
5787
view_str = views.view_display_str(tree.views.lookup_view())
5788
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5792
# No name given and no current view set
5793
self.outf.write('No current view.\n')
5795
view_str = views.view_display_str(tree.views.lookup_view(name))
5796
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5799
class cmd_hooks(Command):
5800
__doc__ = """Show hooks."""
5805
for hook_key in sorted(hooks.known_hooks.keys()):
5806
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5807
self.outf.write("%s:\n" % type(some_hooks).__name__)
5808
for hook_name, hook_point in sorted(some_hooks.items()):
5809
self.outf.write(" %s:\n" % (hook_name,))
5810
found_hooks = list(hook_point)
5812
for hook in found_hooks:
5813
self.outf.write(" %s\n" %
5814
(some_hooks.get_hook_name(hook),))
5816
self.outf.write(" <no hooks installed>\n")
5819
class cmd_remove_branch(Command):
5820
__doc__ = """Remove a branch.
5822
This will remove the branch from the specified location but
5823
will keep any working tree or repository in place.
5827
Remove the branch at repo/trunk::
5829
bzr remove-branch repo/trunk
5833
takes_args = ["location?"]
5835
aliases = ["rmbranch"]
5837
def run(self, location=None):
5838
if location is None:
5840
branch = Branch.open_containing(location)[0]
5841
branch.bzrdir.destroy_branch()
5844
class cmd_shelve(Command):
5845
__doc__ = """Temporarily set aside some changes from the current tree.
5847
Shelve allows you to temporarily put changes you've made "on the shelf",
5848
ie. out of the way, until a later time when you can bring them back from
5849
the shelf with the 'unshelve' command. The changes are stored alongside
5850
your working tree, and so they aren't propagated along with your branch nor
5851
will they survive its deletion.
5853
If shelve --list is specified, previously-shelved changes are listed.
5855
Shelve is intended to help separate several sets of changes that have
5856
been inappropriately mingled. If you just want to get rid of all changes
5857
and you don't need to restore them later, use revert. If you want to
5858
shelve all text changes at once, use shelve --all.
5860
If filenames are specified, only the changes to those files will be
5861
shelved. Other files will be left untouched.
5863
If a revision is specified, changes since that revision will be shelved.
5865
You can put multiple items on the shelf, and by default, 'unshelve' will
5866
restore the most recently shelved changes.
5869
takes_args = ['file*']
5873
Option('all', help='Shelve all changes.'),
5875
RegistryOption('writer', 'Method to use for writing diffs.',
5876
bzrlib.option.diff_writer_registry,
5877
value_switches=True, enum_switch=False),
5879
Option('list', help='List shelved changes.'),
5881
help='Destroy removed changes instead of shelving them.'),
5883
_see_also = ['unshelve']
5885
def run(self, revision=None, all=False, file_list=None, message=None,
5886
writer=None, list=False, destroy=False):
5888
return self.run_for_list()
5889
from bzrlib.shelf_ui import Shelver
5891
writer = bzrlib.option.diff_writer_registry.get()
5893
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5894
file_list, message, destroy=destroy)
5899
except errors.UserAbort:
5902
def run_for_list(self):
5903
tree = WorkingTree.open_containing('.')[0]
5905
self.add_cleanup(tree.unlock)
5906
manager = tree.get_shelf_manager()
5907
shelves = manager.active_shelves()
5908
if len(shelves) == 0:
5909
note('No shelved changes.')
5911
for shelf_id in reversed(shelves):
5912
message = manager.get_metadata(shelf_id).get('message')
5914
message = '<no message>'
5915
self.outf.write('%3d: %s\n' % (shelf_id, message))
5919
class cmd_unshelve(Command):
5920
__doc__ = """Restore shelved changes.
5922
By default, the most recently shelved changes are restored. However if you
5923
specify a shelf by id those changes will be restored instead. This works
5924
best when the changes don't depend on each other.
5927
takes_args = ['shelf_id?']
5929
RegistryOption.from_kwargs(
5930
'action', help="The action to perform.",
5931
enum_switch=False, value_switches=True,
5932
apply="Apply changes and remove from the shelf.",
5933
dry_run="Show changes, but do not apply or remove them.",
5934
preview="Instead of unshelving the changes, show the diff that "
5935
"would result from unshelving.",
5936
delete_only="Delete changes without applying them.",
5937
keep="Apply changes but don't delete them.",
5940
_see_also = ['shelve']
5942
def run(self, shelf_id=None, action='apply'):
5943
from bzrlib.shelf_ui import Unshelver
5944
unshelver = Unshelver.from_args(shelf_id, action)
5948
unshelver.tree.unlock()
5951
class cmd_clean_tree(Command):
5952
__doc__ = """Remove unwanted files from working tree.
5954
By default, only unknown files, not ignored files, are deleted. Versioned
5955
files are never deleted.
5957
Another class is 'detritus', which includes files emitted by bzr during
5958
normal operations and selftests. (The value of these files decreases with
5961
If no options are specified, unknown files are deleted. Otherwise, option
5962
flags are respected, and may be combined.
5964
To check what clean-tree will do, use --dry-run.
5966
takes_options = [Option('ignored', help='Delete all ignored files.'),
5967
Option('detritus', help='Delete conflict files, merge'
5968
' backups, and failed selftest dirs.'),
5970
help='Delete files unknown to bzr (default).'),
5971
Option('dry-run', help='Show files to delete instead of'
5973
Option('force', help='Do not prompt before deleting.')]
5974
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5976
from bzrlib.clean_tree import clean_tree
5977
if not (unknown or ignored or detritus):
5981
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5982
dry_run=dry_run, no_prompt=force)
5985
class cmd_reference(Command):
5986
__doc__ = """list, view and set branch locations for nested trees.
5988
If no arguments are provided, lists the branch locations for nested trees.
5989
If one argument is provided, display the branch location for that tree.
5990
If two arguments are provided, set the branch location for that tree.
5995
takes_args = ['path?', 'location?']
5997
def run(self, path=None, location=None):
5999
if path is not None:
6001
tree, branch, relpath =(
6002
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
6003
if path is not None:
6006
tree = branch.basis_tree()
6008
info = branch._get_all_reference_info().iteritems()
6009
self._display_reference_info(tree, branch, info)
6011
file_id = tree.path2id(path)
6013
raise errors.NotVersionedError(path)
6014
if location is None:
6015
info = [(file_id, branch.get_reference_info(file_id))]
6016
self._display_reference_info(tree, branch, info)
6018
branch.set_reference_info(file_id, path, location)
6020
def _display_reference_info(self, tree, branch, info):
6022
for file_id, (path, location) in info:
6024
path = tree.id2path(file_id)
6025
except errors.NoSuchId:
6027
ref_list.append((path, location))
6028
for path, location in sorted(ref_list):
6029
self.outf.write('%s %s\n' % (path, location))
6032
def _register_lazy_builtins():
6033
# register lazy builtins from other modules; called at startup and should
6034
# be only called once.
6035
for (name, aliases, module_name) in [
6036
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6037
('cmd_dpush', [], 'bzrlib.foreign'),
6038
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6039
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6040
('cmd_conflicts', [], 'bzrlib.conflicts'),
6041
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6043
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
