1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
35
config as _mod_config,
45
revision as _mod_revision,
53
from bzrlib.branch import Branch
54
from bzrlib.conflicts import ConflictList
55
from bzrlib.transport import memory
56
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
57
from bzrlib.smtp_connection import SMTPConnection
58
from bzrlib.workingtree import WorkingTree
61
from bzrlib.commands import (
63
builtin_command_registry,
66
from bzrlib.option import (
73
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
79
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
80
def tree_files(file_list, default_branch=u'.', canonicalize=True,
82
return internal_tree_files(file_list, default_branch, canonicalize,
86
def tree_files_for_add(file_list):
88
Return a tree and list of absolute paths from a file list.
90
Similar to tree_files, but add handles files a bit differently, so it a
91
custom implementation. In particular, MutableTreeTree.smart_add expects
92
absolute paths, which it immediately converts to relative paths.
94
# FIXME Would be nice to just return the relative paths like
95
# internal_tree_files does, but there are a large number of unit tests
96
# that assume the current interface to mutabletree.smart_add
98
tree, relpath = WorkingTree.open_containing(file_list[0])
99
if tree.supports_views():
100
view_files = tree.views.lookup_view()
102
for filename in file_list:
103
if not osutils.is_inside_any(view_files, filename):
104
raise errors.FileOutsideView(filename, view_files)
105
file_list = file_list[:]
106
file_list[0] = tree.abspath(relpath)
108
tree = WorkingTree.open_containing(u'.')[0]
109
if tree.supports_views():
110
view_files = tree.views.lookup_view()
112
file_list = view_files
113
view_str = views.view_display_str(view_files)
114
note("Ignoring files outside view. View is %s" % view_str)
115
return tree, file_list
118
def _get_one_revision(command_name, revisions):
119
if revisions is None:
121
if len(revisions) != 1:
122
raise errors.BzrCommandError(
123
'bzr %s --revision takes exactly one revision identifier' % (
128
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
129
"""Get a revision tree. Not suitable for commands that change the tree.
131
Specifically, the basis tree in dirstate trees is coupled to the dirstate
132
and doing a commit/uncommit/pull will at best fail due to changing the
135
If tree is passed in, it should be already locked, for lifetime management
136
of the trees internal cached state.
140
if revisions is None:
142
rev_tree = tree.basis_tree()
144
rev_tree = branch.basis_tree()
146
revision = _get_one_revision(command_name, revisions)
147
rev_tree = revision.as_tree(branch)
151
# XXX: Bad function name; should possibly also be a class method of
152
# WorkingTree rather than a function.
153
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
154
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
"""Convert command-line paths to a WorkingTree and relative paths.
158
Deprecated: use WorkingTree.open_containing_paths instead.
160
This is typically used for command-line processors that take one or
161
more filenames, and infer the workingtree that contains them.
163
The filenames given are not required to exist.
165
:param file_list: Filenames to convert.
167
:param default_branch: Fallback tree path to use if file_list is empty or
170
:param apply_view: if True and a view is set, apply it or check that
171
specified files are within it
173
:return: workingtree, [relative_paths]
175
return WorkingTree.open_containing_paths(
176
file_list, default_directory='.',
181
def _get_view_info_for_change_reporter(tree):
182
"""Get the view information from a tree for change reporting."""
185
current_view = tree.views.get_view_info()[0]
186
if current_view is not None:
187
view_info = (current_view, tree.views.lookup_view())
188
except errors.ViewsNotSupported:
193
def _open_directory_or_containing_tree_or_branch(filename, directory):
194
"""Open the tree or branch containing the specified file, unless
195
the --directory option is used to specify a different branch."""
196
if directory is not None:
197
return (None, Branch.open(directory), filename)
198
return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
201
# TODO: Make sure no commands unconditionally use the working directory as a
202
# branch. If a filename argument is used, the first of them should be used to
203
# specify the branch. (Perhaps this can be factored out into some kind of
204
# Argument class, representing a file in a branch, where the first occurrence
207
class cmd_status(Command):
208
__doc__ = """Display status summary.
210
This reports on versioned and unknown files, reporting them
211
grouped by state. Possible states are:
214
Versioned in the working copy but not in the previous revision.
217
Versioned in the previous revision but removed or deleted
221
Path of this file changed from the previous revision;
222
the text may also have changed. This includes files whose
223
parent directory was renamed.
226
Text has changed since the previous revision.
229
File kind has been changed (e.g. from file to directory).
232
Not versioned and not matching an ignore pattern.
234
Additionally for directories, symlinks and files with an executable
235
bit, Bazaar indicates their type using a trailing character: '/', '@'
238
To see ignored files use 'bzr ignored'. For details on the
239
changes to file texts, use 'bzr diff'.
241
Note that --short or -S gives status flags for each item, similar
242
to Subversion's status command. To get output similar to svn -q,
245
If no arguments are specified, the status of the entire working
246
directory is shown. Otherwise, only the status of the specified
247
files or directories is reported. If a directory is given, status
248
is reported for everything inside that directory.
250
Before merges are committed, the pending merge tip revisions are
251
shown. To see all pending merge revisions, use the -v option.
252
To skip the display of pending merge information altogether, use
253
the no-pending option or specify a file/directory.
255
To compare the working directory to a specific revision, pass a
256
single revision to the revision argument.
258
To see which files have changed in a specific revision, or between
259
two revisions, pass a revision range to the revision argument.
260
This will produce the same results as calling 'bzr diff --summarize'.
263
# TODO: --no-recurse, --recurse options
265
takes_args = ['file*']
266
takes_options = ['show-ids', 'revision', 'change', 'verbose',
267
Option('short', help='Use short status indicators.',
269
Option('versioned', help='Only show versioned files.',
271
Option('no-pending', help='Don\'t show pending merges.',
274
aliases = ['st', 'stat']
276
encoding_type = 'replace'
277
_see_also = ['diff', 'revert', 'status-flags']
280
def run(self, show_ids=False, file_list=None, revision=None, short=False,
281
versioned=False, no_pending=False, verbose=False):
282
from bzrlib.status import show_tree_status
284
if revision and len(revision) > 2:
285
raise errors.BzrCommandError('bzr status --revision takes exactly'
286
' one or two revision specifiers')
288
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
289
# Avoid asking for specific files when that is not needed.
290
if relfile_list == ['']:
292
# Don't disable pending merges for full trees other than '.'.
293
if file_list == ['.']:
295
# A specific path within a tree was given.
296
elif relfile_list is not None:
298
show_tree_status(tree, show_ids=show_ids,
299
specific_files=relfile_list, revision=revision,
300
to_file=self.outf, short=short, versioned=versioned,
301
show_pending=(not no_pending), verbose=verbose)
304
class cmd_cat_revision(Command):
305
__doc__ = """Write out metadata for a revision.
307
The revision to print can either be specified by a specific
308
revision identifier, or you can use --revision.
312
takes_args = ['revision_id?']
313
takes_options = ['directory', 'revision']
314
# cat-revision is more for frontends so should be exact
317
def print_revision(self, revisions, revid):
318
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
319
record = stream.next()
320
if record.storage_kind == 'absent':
321
raise errors.NoSuchRevision(revisions, revid)
322
revtext = record.get_bytes_as('fulltext')
323
self.outf.write(revtext.decode('utf-8'))
326
def run(self, revision_id=None, revision=None, directory=u'.'):
327
if revision_id is not None and revision is not None:
328
raise errors.BzrCommandError('You can only supply one of'
329
' revision_id or --revision')
330
if revision_id is None and revision is None:
331
raise errors.BzrCommandError('You must supply either'
332
' --revision or a revision_id')
334
b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
336
revisions = b.repository.revisions
337
if revisions is None:
338
raise errors.BzrCommandError('Repository %r does not support '
339
'access to raw revision texts')
341
b.repository.lock_read()
343
# TODO: jam 20060112 should cat-revision always output utf-8?
344
if revision_id is not None:
345
revision_id = osutils.safe_revision_id(revision_id, warn=False)
347
self.print_revision(revisions, revision_id)
348
except errors.NoSuchRevision:
349
msg = "The repository %s contains no revision %s." % (
350
b.repository.base, revision_id)
351
raise errors.BzrCommandError(msg)
352
elif revision is not None:
355
raise errors.BzrCommandError(
356
'You cannot specify a NULL revision.')
357
rev_id = rev.as_revision_id(b)
358
self.print_revision(revisions, rev_id)
360
b.repository.unlock()
363
class cmd_dump_btree(Command):
364
__doc__ = """Dump the contents of a btree index file to stdout.
366
PATH is a btree index file, it can be any URL. This includes things like
367
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
369
By default, the tuples stored in the index file will be displayed. With
370
--raw, we will uncompress the pages, but otherwise display the raw bytes
374
# TODO: Do we want to dump the internal nodes as well?
375
# TODO: It would be nice to be able to dump the un-parsed information,
376
# rather than only going through iter_all_entries. However, this is
377
# good enough for a start
379
encoding_type = 'exact'
380
takes_args = ['path']
381
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
382
' rather than the parsed tuples.'),
385
def run(self, path, raw=False):
386
dirname, basename = osutils.split(path)
387
t = transport.get_transport(dirname)
389
self._dump_raw_bytes(t, basename)
391
self._dump_entries(t, basename)
393
def _get_index_and_bytes(self, trans, basename):
394
"""Create a BTreeGraphIndex and raw bytes."""
395
bt = btree_index.BTreeGraphIndex(trans, basename, None)
396
bytes = trans.get_bytes(basename)
397
bt._file = cStringIO.StringIO(bytes)
398
bt._size = len(bytes)
401
def _dump_raw_bytes(self, trans, basename):
404
# We need to parse at least the root node.
405
# This is because the first page of every row starts with an
406
# uncompressed header.
407
bt, bytes = self._get_index_and_bytes(trans, basename)
408
for page_idx, page_start in enumerate(xrange(0, len(bytes),
409
btree_index._PAGE_SIZE)):
410
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
411
page_bytes = bytes[page_start:page_end]
413
self.outf.write('Root node:\n')
414
header_end, data = bt._parse_header_from_bytes(page_bytes)
415
self.outf.write(page_bytes[:header_end])
417
self.outf.write('\nPage %d\n' % (page_idx,))
418
if len(page_bytes) == 0:
419
self.outf.write('(empty)\n');
421
decomp_bytes = zlib.decompress(page_bytes)
422
self.outf.write(decomp_bytes)
423
self.outf.write('\n')
425
def _dump_entries(self, trans, basename):
427
st = trans.stat(basename)
428
except errors.TransportNotPossible:
429
# We can't stat, so we'll fake it because we have to do the 'get()'
431
bt, _ = self._get_index_and_bytes(trans, basename)
433
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
434
for node in bt.iter_all_entries():
435
# Node is made up of:
436
# (index, key, value, [references])
440
refs_as_tuples = None
442
refs_as_tuples = static_tuple.as_tuples(refs)
443
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
444
self.outf.write('%s\n' % (as_tuple,))
447
class cmd_remove_tree(Command):
448
__doc__ = """Remove the working tree from a given branch/checkout.
450
Since a lightweight checkout is little more than a working tree
451
this will refuse to run against one.
453
To re-create the working tree, use "bzr checkout".
455
_see_also = ['checkout', 'working-trees']
456
takes_args = ['location*']
459
help='Remove the working tree even if it has '
460
'uncommitted or shelved changes.'),
463
def run(self, location_list, force=False):
464
if not location_list:
467
for location in location_list:
468
d = bzrdir.BzrDir.open(location)
471
working = d.open_workingtree()
472
except errors.NoWorkingTree:
473
raise errors.BzrCommandError("No working tree to remove")
474
except errors.NotLocalUrl:
475
raise errors.BzrCommandError("You cannot remove the working tree"
478
if (working.has_changes()):
479
raise errors.UncommittedChanges(working)
480
if working.get_shelf_manager().last_shelf() is not None:
481
raise errors.ShelvedChanges(working)
483
if working.user_url != working.branch.user_url:
484
raise errors.BzrCommandError("You cannot remove the working tree"
485
" from a lightweight checkout")
487
d.destroy_workingtree()
490
class cmd_repair_workingtree(Command):
491
__doc__ = """Reset the working tree state file.
493
This is not meant to be used normally, but more as a way to recover from
494
filesystem corruption, etc. This rebuilds the working inventory back to a
495
'known good' state. Any new modifications (adding a file, renaming, etc)
496
will be lost, though modified files will still be detected as such.
498
Most users will want something more like "bzr revert" or "bzr update"
499
unless the state file has become corrupted.
501
By default this attempts to recover the current state by looking at the
502
headers of the state file. If the state file is too corrupted to even do
503
that, you can supply --revision to force the state of the tree.
506
takes_options = ['revision', 'directory',
508
help='Reset the tree even if it doesn\'t appear to be'
513
def run(self, revision=None, directory='.', force=False):
514
tree, _ = WorkingTree.open_containing(directory)
515
self.add_cleanup(tree.lock_tree_write().unlock)
519
except errors.BzrError:
520
pass # There seems to be a real error here, so we'll reset
523
raise errors.BzrCommandError(
524
'The tree does not appear to be corrupt. You probably'
525
' want "bzr revert" instead. Use "--force" if you are'
526
' sure you want to reset the working tree.')
530
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
532
tree.reset_state(revision_ids)
533
except errors.BzrError, e:
534
if revision_ids is None:
535
extra = (', the header appears corrupt, try passing -r -1'
536
' to set the state to the last commit')
539
raise errors.BzrCommandError('failed to reset the tree state'
543
class cmd_revno(Command):
544
__doc__ = """Show current revision number.
546
This is equal to the number of revisions on this branch.
550
takes_args = ['location?']
552
Option('tree', help='Show revno of working tree'),
556
def run(self, tree=False, location=u'.'):
559
wt = WorkingTree.open_containing(location)[0]
560
self.add_cleanup(wt.lock_read().unlock)
561
except (errors.NoWorkingTree, errors.NotLocalUrl):
562
raise errors.NoWorkingTree(location)
563
revid = wt.last_revision()
565
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
566
except errors.NoSuchRevision:
568
revno = ".".join(str(n) for n in revno_t)
570
b = Branch.open_containing(location)[0]
571
self.add_cleanup(b.lock_read().unlock)
574
self.outf.write(str(revno) + '\n')
577
class cmd_revision_info(Command):
578
__doc__ = """Show revision number and revision id for a given revision identifier.
581
takes_args = ['revision_info*']
584
custom_help('directory',
585
help='Branch to examine, '
586
'rather than the one containing the working directory.'),
587
Option('tree', help='Show revno of working tree'),
591
def run(self, revision=None, directory=u'.', tree=False,
592
revision_info_list=[]):
595
wt = WorkingTree.open_containing(directory)[0]
597
self.add_cleanup(wt.lock_read().unlock)
598
except (errors.NoWorkingTree, errors.NotLocalUrl):
600
b = Branch.open_containing(directory)[0]
601
self.add_cleanup(b.lock_read().unlock)
603
if revision is not None:
604
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
605
if revision_info_list is not None:
606
for rev_str in revision_info_list:
607
rev_spec = RevisionSpec.from_string(rev_str)
608
revision_ids.append(rev_spec.as_revision_id(b))
609
# No arguments supplied, default to the last revision
610
if len(revision_ids) == 0:
613
raise errors.NoWorkingTree(directory)
614
revision_ids.append(wt.last_revision())
616
revision_ids.append(b.last_revision())
620
for revision_id in revision_ids:
622
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
623
revno = '.'.join(str(i) for i in dotted_revno)
624
except errors.NoSuchRevision:
626
maxlen = max(maxlen, len(revno))
627
revinfos.append([revno, revision_id])
631
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
634
class cmd_add(Command):
635
__doc__ = """Add specified files or directories.
637
In non-recursive mode, all the named items are added, regardless
638
of whether they were previously ignored. A warning is given if
639
any of the named files are already versioned.
641
In recursive mode (the default), files are treated the same way
642
but the behaviour for directories is different. Directories that
643
are already versioned do not give a warning. All directories,
644
whether already versioned or not, are searched for files or
645
subdirectories that are neither versioned or ignored, and these
646
are added. This search proceeds recursively into versioned
647
directories. If no names are given '.' is assumed.
649
Therefore simply saying 'bzr add' will version all files that
650
are currently unknown.
652
Adding a file whose parent directory is not versioned will
653
implicitly add the parent, and so on up to the root. This means
654
you should never need to explicitly add a directory, they'll just
655
get added when you add a file in the directory.
657
--dry-run will show which files would be added, but not actually
660
--file-ids-from will try to use the file ids from the supplied path.
661
It looks up ids trying to find a matching parent directory with the
662
same filename, and then by pure path. This option is rarely needed
663
but can be useful when adding the same logical file into two
664
branches that will be merged later (without showing the two different
665
adds as a conflict). It is also useful when merging another project
666
into a subdirectory of this one.
668
Any files matching patterns in the ignore list will not be added
669
unless they are explicitly mentioned.
671
takes_args = ['file*']
674
help="Don't recursively add the contents of directories."),
676
help="Show what would be done, but don't actually do anything."),
678
Option('file-ids-from',
680
help='Lookup file ids from this tree.'),
682
encoding_type = 'replace'
683
_see_also = ['remove', 'ignore']
685
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
690
if file_ids_from is not None:
692
base_tree, base_path = WorkingTree.open_containing(
694
except errors.NoWorkingTree:
695
base_branch, base_path = Branch.open_containing(
697
base_tree = base_branch.basis_tree()
699
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
700
to_file=self.outf, should_print=(not is_quiet()))
702
action = bzrlib.add.AddAction(to_file=self.outf,
703
should_print=(not is_quiet()))
706
self.add_cleanup(base_tree.lock_read().unlock)
707
tree, file_list = tree_files_for_add(file_list)
708
added, ignored = tree.smart_add(file_list, not
709
no_recurse, action=action, save=not dry_run)
713
for glob in sorted(ignored.keys()):
714
for path in ignored[glob]:
715
self.outf.write("ignored %s matching \"%s\"\n"
719
class cmd_mkdir(Command):
720
__doc__ = """Create a new versioned directory.
722
This is equivalent to creating the directory and then adding it.
725
takes_args = ['dir+']
726
encoding_type = 'replace'
728
def run(self, dir_list):
730
wt, dd = WorkingTree.open_containing(d)
731
base = os.path.dirname(dd)
732
id = wt.path2id(base)
736
self.outf.write('added %s\n' % d)
738
raise errors.NotVersionedError(path=base)
741
class cmd_relpath(Command):
742
__doc__ = """Show path of a file relative to root"""
744
takes_args = ['filename']
748
def run(self, filename):
749
# TODO: jam 20050106 Can relpath return a munged path if
750
# sys.stdout encoding cannot represent it?
751
tree, relpath = WorkingTree.open_containing(filename)
752
self.outf.write(relpath)
753
self.outf.write('\n')
756
class cmd_inventory(Command):
757
__doc__ = """Show inventory of the current working copy or a revision.
759
It is possible to limit the output to a particular entry
760
type using the --kind option. For example: --kind file.
762
It is also possible to restrict the list of files to a specific
763
set. For example: bzr inventory --show-ids this/file
772
help='List entries of a particular kind: file, directory, symlink.',
775
takes_args = ['file*']
778
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
779
if kind and kind not in ['file', 'directory', 'symlink']:
780
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
782
revision = _get_one_revision('inventory', revision)
783
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
784
self.add_cleanup(work_tree.lock_read().unlock)
785
if revision is not None:
786
tree = revision.as_tree(work_tree.branch)
788
extra_trees = [work_tree]
789
self.add_cleanup(tree.lock_read().unlock)
794
if file_list is not None:
795
file_ids = tree.paths2ids(file_list, trees=extra_trees,
796
require_versioned=True)
797
# find_ids_across_trees may include some paths that don't
799
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
800
for file_id in file_ids if file_id in tree)
802
entries = tree.inventory.entries()
805
for path, entry in entries:
806
if kind and kind != entry.kind:
809
self.outf.write('%-50s %s\n' % (path, entry.file_id))
811
self.outf.write(path)
812
self.outf.write('\n')
815
class cmd_mv(Command):
816
__doc__ = """Move or rename a file.
819
bzr mv OLDNAME NEWNAME
821
bzr mv SOURCE... DESTINATION
823
If the last argument is a versioned directory, all the other names
824
are moved into it. Otherwise, there must be exactly two arguments
825
and the file is changed to a new name.
827
If OLDNAME does not exist on the filesystem but is versioned and
828
NEWNAME does exist on the filesystem but is not versioned, mv
829
assumes that the file has been manually moved and only updates
830
its internal inventory to reflect that change.
831
The same is valid when moving many SOURCE files to a DESTINATION.
833
Files cannot be moved between branches.
836
takes_args = ['names*']
837
takes_options = [Option("after", help="Move only the bzr identifier"
838
" of the file, because the file has already been moved."),
839
Option('auto', help='Automatically guess renames.'),
840
Option('dry-run', help='Avoid making changes when guessing renames.'),
842
aliases = ['move', 'rename']
843
encoding_type = 'replace'
845
def run(self, names_list, after=False, auto=False, dry_run=False):
847
return self.run_auto(names_list, after, dry_run)
849
raise errors.BzrCommandError('--dry-run requires --auto.')
850
if names_list is None:
852
if len(names_list) < 2:
853
raise errors.BzrCommandError("missing file argument")
854
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
855
self.add_cleanup(tree.lock_tree_write().unlock)
856
self._run(tree, names_list, rel_names, after)
858
def run_auto(self, names_list, after, dry_run):
859
if names_list is not None and len(names_list) > 1:
860
raise errors.BzrCommandError('Only one path may be specified to'
863
raise errors.BzrCommandError('--after cannot be specified with'
865
work_tree, file_list = WorkingTree.open_containing_paths(
866
names_list, default_directory='.')
867
self.add_cleanup(work_tree.lock_tree_write().unlock)
868
rename_map.RenameMap.guess_renames(work_tree, dry_run)
870
def _run(self, tree, names_list, rel_names, after):
871
into_existing = osutils.isdir(names_list[-1])
872
if into_existing and len(names_list) == 2:
874
# a. case-insensitive filesystem and change case of dir
875
# b. move directory after the fact (if the source used to be
876
# a directory, but now doesn't exist in the working tree
877
# and the target is an existing directory, just rename it)
878
if (not tree.case_sensitive
879
and rel_names[0].lower() == rel_names[1].lower()):
880
into_existing = False
883
# 'fix' the case of a potential 'from'
884
from_id = tree.path2id(
885
tree.get_canonical_inventory_path(rel_names[0]))
886
if (not osutils.lexists(names_list[0]) and
887
from_id and inv.get_file_kind(from_id) == "directory"):
888
into_existing = False
891
# move into existing directory
892
# All entries reference existing inventory items, so fix them up
893
# for cicp file-systems.
894
rel_names = tree.get_canonical_inventory_paths(rel_names)
895
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
897
self.outf.write("%s => %s\n" % (src, dest))
899
if len(names_list) != 2:
900
raise errors.BzrCommandError('to mv multiple files the'
901
' destination must be a versioned'
904
# for cicp file-systems: the src references an existing inventory
906
src = tree.get_canonical_inventory_path(rel_names[0])
907
# Find the canonical version of the destination: In all cases, the
908
# parent of the target must be in the inventory, so we fetch the
909
# canonical version from there (we do not always *use* the
910
# canonicalized tail portion - we may be attempting to rename the
912
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
913
dest_parent = osutils.dirname(canon_dest)
914
spec_tail = osutils.basename(rel_names[1])
915
# For a CICP file-system, we need to avoid creating 2 inventory
916
# entries that differ only by case. So regardless of the case
917
# we *want* to use (ie, specified by the user or the file-system),
918
# we must always choose to use the case of any existing inventory
919
# items. The only exception to this is when we are attempting a
920
# case-only rename (ie, canonical versions of src and dest are
922
dest_id = tree.path2id(canon_dest)
923
if dest_id is None or tree.path2id(src) == dest_id:
924
# No existing item we care about, so work out what case we
925
# are actually going to use.
927
# If 'after' is specified, the tail must refer to a file on disk.
929
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
931
# pathjoin with an empty tail adds a slash, which breaks
933
dest_parent_fq = tree.basedir
935
dest_tail = osutils.canonical_relpath(
937
osutils.pathjoin(dest_parent_fq, spec_tail))
939
# not 'after', so case as specified is used
940
dest_tail = spec_tail
942
# Use the existing item so 'mv' fails with AlreadyVersioned.
943
dest_tail = os.path.basename(canon_dest)
944
dest = osutils.pathjoin(dest_parent, dest_tail)
945
mutter("attempting to move %s => %s", src, dest)
946
tree.rename_one(src, dest, after=after)
948
self.outf.write("%s => %s\n" % (src, dest))
951
class cmd_pull(Command):
952
__doc__ = """Turn this branch into a mirror of another branch.
954
By default, this command only works on branches that have not diverged.
955
Branches are considered diverged if the destination branch's most recent
956
commit is one that has not been merged (directly or indirectly) into the
959
If branches have diverged, you can use 'bzr merge' to integrate the changes
960
from one into the other. Once one branch has merged, the other should
961
be able to pull it again.
963
If you want to replace your local changes and just want your branch to
964
match the remote one, use pull --overwrite. This will work even if the two
965
branches have diverged.
967
If there is no default location set, the first pull will set it (use
968
--no-remember to avoid settting it). After that, you can omit the
969
location to use the default. To change the default, use --remember. The
970
value will only be saved if the remote location can be accessed.
972
Note: The location can be specified either in the form of a branch,
973
or in the form of a path to a file containing a merge directive generated
977
_see_also = ['push', 'update', 'status-flags', 'send']
978
takes_options = ['remember', 'overwrite', 'revision',
979
custom_help('verbose',
980
help='Show logs of pulled revisions.'),
981
custom_help('directory',
982
help='Branch to pull into, '
983
'rather than the one containing the working directory.'),
985
help="Perform a local pull in a bound "
986
"branch. Local pulls are not applied to "
990
help="Show base revision text in conflicts.")
992
takes_args = ['location?']
993
encoding_type = 'replace'
995
def run(self, location=None, remember=None, overwrite=False,
996
revision=None, verbose=False,
997
directory=None, local=False,
999
# FIXME: too much stuff is in the command class
1002
if directory is None:
1005
tree_to = WorkingTree.open_containing(directory)[0]
1006
branch_to = tree_to.branch
1007
self.add_cleanup(tree_to.lock_write().unlock)
1008
except errors.NoWorkingTree:
1010
branch_to = Branch.open_containing(directory)[0]
1011
self.add_cleanup(branch_to.lock_write().unlock)
1013
if tree_to is None and show_base:
1014
raise errors.BzrCommandError("Need working tree for --show-base.")
1016
if local and not branch_to.get_bound_location():
1017
raise errors.LocalRequiresBoundBranch()
1019
possible_transports = []
1020
if location is not None:
1022
mergeable = bundle.read_mergeable_from_url(location,
1023
possible_transports=possible_transports)
1024
except errors.NotABundle:
1027
stored_loc = branch_to.get_parent()
1028
if location is None:
1029
if stored_loc is None:
1030
raise errors.BzrCommandError("No pull location known or"
1033
display_url = urlutils.unescape_for_display(stored_loc,
1036
self.outf.write("Using saved parent location: %s\n" % display_url)
1037
location = stored_loc
1039
revision = _get_one_revision('pull', revision)
1040
if mergeable is not None:
1041
if revision is not None:
1042
raise errors.BzrCommandError(
1043
'Cannot use -r with merge directives or bundles')
1044
mergeable.install_revisions(branch_to.repository)
1045
base_revision_id, revision_id, verified = \
1046
mergeable.get_merge_request(branch_to.repository)
1047
branch_from = branch_to
1049
branch_from = Branch.open(location,
1050
possible_transports=possible_transports)
1051
self.add_cleanup(branch_from.lock_read().unlock)
1052
# Remembers if asked explicitly or no previous location is set
1054
or (remember is None and branch_to.get_parent() is None)):
1055
branch_to.set_parent(branch_from.base)
1057
if revision is not None:
1058
revision_id = revision.as_revision_id(branch_from)
1060
if tree_to is not None:
1061
view_info = _get_view_info_for_change_reporter(tree_to)
1062
change_reporter = delta._ChangeReporter(
1063
unversioned_filter=tree_to.is_ignored,
1064
view_info=view_info)
1065
result = tree_to.pull(
1066
branch_from, overwrite, revision_id, change_reporter,
1067
possible_transports=possible_transports, local=local,
1068
show_base=show_base)
1070
result = branch_to.pull(
1071
branch_from, overwrite, revision_id, local=local)
1073
result.report(self.outf)
1074
if verbose and result.old_revid != result.new_revid:
1075
log.show_branch_change(
1076
branch_to, self.outf, result.old_revno,
1078
if getattr(result, 'tag_conflicts', None):
1084
class cmd_push(Command):
1085
__doc__ = """Update a mirror of this branch.
1087
The target branch will not have its working tree populated because this
1088
is both expensive, and is not supported on remote file systems.
1090
Some smart servers or protocols *may* put the working tree in place in
1093
This command only works on branches that have not diverged. Branches are
1094
considered diverged if the destination branch's most recent commit is one
1095
that has not been merged (directly or indirectly) by the source branch.
1097
If branches have diverged, you can use 'bzr push --overwrite' to replace
1098
the other branch completely, discarding its unmerged changes.
1100
If you want to ensure you have the different changes in the other branch,
1101
do a merge (see bzr help merge) from the other branch, and commit that.
1102
After that you will be able to do a push without '--overwrite'.
1104
If there is no default push location set, the first push will set it (use
1105
--no-remember to avoid settting it). After that, you can omit the
1106
location to use the default. To change the default, use --remember. The
1107
value will only be saved if the remote location can be accessed.
1110
_see_also = ['pull', 'update', 'working-trees']
1111
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1112
Option('create-prefix',
1113
help='Create the path leading up to the branch '
1114
'if it does not already exist.'),
1115
custom_help('directory',
1116
help='Branch to push from, '
1117
'rather than the one containing the working directory.'),
1118
Option('use-existing-dir',
1119
help='By default push will fail if the target'
1120
' directory exists, but does not already'
1121
' have a control directory. This flag will'
1122
' allow push to proceed.'),
1124
help='Create a stacked branch that references the public location '
1125
'of the parent branch.'),
1126
Option('stacked-on',
1127
help='Create a stacked branch that refers to another branch '
1128
'for the commit history. Only the work not present in the '
1129
'referenced branch is included in the branch created.',
1132
help='Refuse to push if there are uncommitted changes in'
1133
' the working tree, --no-strict disables the check.'),
1135
help="Don't populate the working tree, even for protocols"
1136
" that support it."),
1138
takes_args = ['location?']
1139
encoding_type = 'replace'
1141
def run(self, location=None, remember=None, overwrite=False,
1142
create_prefix=False, verbose=False, revision=None,
1143
use_existing_dir=False, directory=None, stacked_on=None,
1144
stacked=False, strict=None, no_tree=False):
1145
from bzrlib.push import _show_push_branch
1147
if directory is None:
1149
# Get the source branch
1151
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1152
# Get the tip's revision_id
1153
revision = _get_one_revision('push', revision)
1154
if revision is not None:
1155
revision_id = revision.in_history(br_from).rev_id
1158
if tree is not None and revision_id is None:
1159
tree.check_changed_or_out_of_date(
1160
strict, 'push_strict',
1161
more_error='Use --no-strict to force the push.',
1162
more_warning='Uncommitted changes will not be pushed.')
1163
# Get the stacked_on branch, if any
1164
if stacked_on is not None:
1165
stacked_on = urlutils.normalize_url(stacked_on)
1167
parent_url = br_from.get_parent()
1169
parent = Branch.open(parent_url)
1170
stacked_on = parent.get_public_branch()
1172
# I considered excluding non-http url's here, thus forcing
1173
# 'public' branches only, but that only works for some
1174
# users, so it's best to just depend on the user spotting an
1175
# error by the feedback given to them. RBC 20080227.
1176
stacked_on = parent_url
1178
raise errors.BzrCommandError(
1179
"Could not determine branch to refer to.")
1181
# Get the destination location
1182
if location is None:
1183
stored_loc = br_from.get_push_location()
1184
if stored_loc is None:
1185
raise errors.BzrCommandError(
1186
"No push location known or specified.")
1188
display_url = urlutils.unescape_for_display(stored_loc,
1190
self.outf.write("Using saved push location: %s\n" % display_url)
1191
location = stored_loc
1193
_show_push_branch(br_from, revision_id, location, self.outf,
1194
verbose=verbose, overwrite=overwrite, remember=remember,
1195
stacked_on=stacked_on, create_prefix=create_prefix,
1196
use_existing_dir=use_existing_dir, no_tree=no_tree)
1199
class cmd_branch(Command):
1200
__doc__ = """Create a new branch that is a copy of an existing branch.
1202
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1203
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1204
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1205
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1206
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1209
To retrieve the branch as of a particular revision, supply the --revision
1210
parameter, as in "branch foo/bar -r 5".
1212
The synonyms 'clone' and 'get' for this command are deprecated.
1215
_see_also = ['checkout']
1216
takes_args = ['from_location', 'to_location?']
1217
takes_options = ['revision',
1218
Option('hardlink', help='Hard-link working tree files where possible.'),
1219
Option('files-from', type=str,
1220
help="Get file contents from this tree."),
1222
help="Create a branch without a working-tree."),
1224
help="Switch the checkout in the current directory "
1225
"to the new branch."),
1227
help='Create a stacked branch referring to the source branch. '
1228
'The new branch will depend on the availability of the source '
1229
'branch for all operations.'),
1230
Option('standalone',
1231
help='Do not use a shared repository, even if available.'),
1232
Option('use-existing-dir',
1233
help='By default branch will fail if the target'
1234
' directory exists, but does not already'
1235
' have a control directory. This flag will'
1236
' allow branch to proceed.'),
1238
help="Bind new branch to from location."),
1240
aliases = ['get', 'clone']
1242
def run(self, from_location, to_location=None, revision=None,
1243
hardlink=False, stacked=False, standalone=False, no_tree=False,
1244
use_existing_dir=False, switch=False, bind=False,
1246
from bzrlib import switch as _mod_switch
1247
from bzrlib.tag import _merge_tags_if_possible
1248
if self.invoked_as in ['get', 'clone']:
1249
ui.ui_factory.show_user_warning(
1250
'deprecated_command',
1251
deprecated_name=self.invoked_as,
1252
recommended_name='branch',
1253
deprecated_in_version='2.4')
1254
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1256
if not (hardlink or files_from):
1257
# accelerator_tree is usually slower because you have to read N
1258
# files (no readahead, lots of seeks, etc), but allow the user to
1259
# explicitly request it
1260
accelerator_tree = None
1261
if files_from is not None and files_from != from_location:
1262
accelerator_tree = WorkingTree.open(files_from)
1263
revision = _get_one_revision('branch', revision)
1264
self.add_cleanup(br_from.lock_read().unlock)
1265
if revision is not None:
1266
revision_id = revision.as_revision_id(br_from)
1268
# FIXME - wt.last_revision, fallback to branch, fall back to
1269
# None or perhaps NULL_REVISION to mean copy nothing
1271
revision_id = br_from.last_revision()
1272
if to_location is None:
1273
to_location = urlutils.derive_to_location(from_location)
1274
to_transport = transport.get_transport(to_location)
1276
to_transport.mkdir('.')
1277
except errors.FileExists:
1278
if not use_existing_dir:
1279
raise errors.BzrCommandError('Target directory "%s" '
1280
'already exists.' % to_location)
1283
bzrdir.BzrDir.open_from_transport(to_transport)
1284
except errors.NotBranchError:
1287
raise errors.AlreadyBranchError(to_location)
1288
except errors.NoSuchFile:
1289
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1292
# preserve whatever source format we have.
1293
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1294
possible_transports=[to_transport],
1295
accelerator_tree=accelerator_tree,
1296
hardlink=hardlink, stacked=stacked,
1297
force_new_repo=standalone,
1298
create_tree_if_local=not no_tree,
1299
source_branch=br_from)
1300
branch = dir.open_branch()
1301
except errors.NoSuchRevision:
1302
to_transport.delete_tree('.')
1303
msg = "The branch %s has no revision %s." % (from_location,
1305
raise errors.BzrCommandError(msg)
1306
_merge_tags_if_possible(br_from, branch)
1307
# If the source branch is stacked, the new branch may
1308
# be stacked whether we asked for that explicitly or not.
1309
# We therefore need a try/except here and not just 'if stacked:'
1311
note('Created new stacked branch referring to %s.' %
1312
branch.get_stacked_on_url())
1313
except (errors.NotStacked, errors.UnstackableBranchFormat,
1314
errors.UnstackableRepositoryFormat), e:
1315
note('Branched %d revision(s).' % branch.revno())
1317
# Bind to the parent
1318
parent_branch = Branch.open(from_location)
1319
branch.bind(parent_branch)
1320
note('New branch bound to %s' % from_location)
1322
# Switch to the new branch
1323
wt, _ = WorkingTree.open_containing('.')
1324
_mod_switch.switch(wt.bzrdir, branch)
1325
note('Switched to branch: %s',
1326
urlutils.unescape_for_display(branch.base, 'utf-8'))
1329
class cmd_checkout(Command):
1330
__doc__ = """Create a new checkout of an existing branch.
1332
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1333
the branch found in '.'. This is useful if you have removed the working tree
1334
or if it was never created - i.e. if you pushed the branch to its current
1335
location using SFTP.
1337
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1338
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1339
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1340
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1341
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1344
To retrieve the branch as of a particular revision, supply the --revision
1345
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1346
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1350
_see_also = ['checkouts', 'branch']
1351
takes_args = ['branch_location?', 'to_location?']
1352
takes_options = ['revision',
1353
Option('lightweight',
1354
help="Perform a lightweight checkout. Lightweight "
1355
"checkouts depend on access to the branch for "
1356
"every operation. Normal checkouts can perform "
1357
"common operations like diff and status without "
1358
"such access, and also support local commits."
1360
Option('files-from', type=str,
1361
help="Get file contents from this tree."),
1363
help='Hard-link working tree files where possible.'
1368
def run(self, branch_location=None, to_location=None, revision=None,
1369
lightweight=False, files_from=None, hardlink=False):
1370
if branch_location is None:
1371
branch_location = osutils.getcwd()
1372
to_location = branch_location
1373
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1375
if not (hardlink or files_from):
1376
# accelerator_tree is usually slower because you have to read N
1377
# files (no readahead, lots of seeks, etc), but allow the user to
1378
# explicitly request it
1379
accelerator_tree = None
1380
revision = _get_one_revision('checkout', revision)
1381
if files_from is not None and files_from != branch_location:
1382
accelerator_tree = WorkingTree.open(files_from)
1383
if revision is not None:
1384
revision_id = revision.as_revision_id(source)
1387
if to_location is None:
1388
to_location = urlutils.derive_to_location(branch_location)
1389
# if the source and to_location are the same,
1390
# and there is no working tree,
1391
# then reconstitute a branch
1392
if (osutils.abspath(to_location) ==
1393
osutils.abspath(branch_location)):
1395
source.bzrdir.open_workingtree()
1396
except errors.NoWorkingTree:
1397
source.bzrdir.create_workingtree(revision_id)
1399
source.create_checkout(to_location, revision_id, lightweight,
1400
accelerator_tree, hardlink)
1403
class cmd_renames(Command):
1404
__doc__ = """Show list of renamed files.
1406
# TODO: Option to show renames between two historical versions.
1408
# TODO: Only show renames under dir, rather than in the whole branch.
1409
_see_also = ['status']
1410
takes_args = ['dir?']
1413
def run(self, dir=u'.'):
1414
tree = WorkingTree.open_containing(dir)[0]
1415
self.add_cleanup(tree.lock_read().unlock)
1416
new_inv = tree.inventory
1417
old_tree = tree.basis_tree()
1418
self.add_cleanup(old_tree.lock_read().unlock)
1419
old_inv = old_tree.inventory
1421
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1422
for f, paths, c, v, p, n, k, e in iterator:
1423
if paths[0] == paths[1]:
1427
renames.append(paths)
1429
for old_name, new_name in renames:
1430
self.outf.write("%s => %s\n" % (old_name, new_name))
1433
class cmd_update(Command):
1434
__doc__ = """Update a tree to have the latest code committed to its branch.
1436
This will perform a merge into the working tree, and may generate
1437
conflicts. If you have any local changes, you will still
1438
need to commit them after the update for the update to be complete.
1440
If you want to discard your local changes, you can just do a
1441
'bzr revert' instead of 'bzr commit' after the update.
1443
If you want to restore a file that has been removed locally, use
1444
'bzr revert' instead of 'bzr update'.
1446
If the tree's branch is bound to a master branch, it will also update
1447
the branch from the master.
1450
_see_also = ['pull', 'working-trees', 'status-flags']
1451
takes_args = ['dir?']
1452
takes_options = ['revision',
1454
help="Show base revision text in conflicts."),
1458
def run(self, dir='.', revision=None, show_base=None):
1459
if revision is not None and len(revision) != 1:
1460
raise errors.BzrCommandError(
1461
"bzr update --revision takes exactly one revision")
1462
tree = WorkingTree.open_containing(dir)[0]
1463
branch = tree.branch
1464
possible_transports = []
1465
master = branch.get_master_branch(
1466
possible_transports=possible_transports)
1467
if master is not None:
1468
branch_location = master.base
1471
branch_location = tree.branch.base
1472
tree.lock_tree_write()
1473
self.add_cleanup(tree.unlock)
1474
# get rid of the final '/' and be ready for display
1475
branch_location = urlutils.unescape_for_display(
1476
branch_location.rstrip('/'),
1478
existing_pending_merges = tree.get_parent_ids()[1:]
1482
# may need to fetch data into a heavyweight checkout
1483
# XXX: this may take some time, maybe we should display a
1485
old_tip = branch.update(possible_transports)
1486
if revision is not None:
1487
revision_id = revision[0].as_revision_id(branch)
1489
revision_id = branch.last_revision()
1490
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1491
revno = branch.revision_id_to_dotted_revno(revision_id)
1492
note("Tree is up to date at revision %s of branch %s" %
1493
('.'.join(map(str, revno)), branch_location))
1495
view_info = _get_view_info_for_change_reporter(tree)
1496
change_reporter = delta._ChangeReporter(
1497
unversioned_filter=tree.is_ignored,
1498
view_info=view_info)
1500
conflicts = tree.update(
1502
possible_transports=possible_transports,
1503
revision=revision_id,
1505
show_base=show_base)
1506
except errors.NoSuchRevision, e:
1507
raise errors.BzrCommandError(
1508
"branch has no revision %s\n"
1509
"bzr update --revision only works"
1510
" for a revision in the branch history"
1512
revno = tree.branch.revision_id_to_dotted_revno(
1513
_mod_revision.ensure_null(tree.last_revision()))
1514
note('Updated to revision %s of branch %s' %
1515
('.'.join(map(str, revno)), branch_location))
1516
parent_ids = tree.get_parent_ids()
1517
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1518
note('Your local commits will now show as pending merges with '
1519
"'bzr status', and can be committed with 'bzr commit'.")
1526
class cmd_info(Command):
1527
__doc__ = """Show information about a working tree, branch or repository.
1529
This command will show all known locations and formats associated to the
1530
tree, branch or repository.
1532
In verbose mode, statistical information is included with each report.
1533
To see extended statistic information, use a verbosity level of 2 or
1534
higher by specifying the verbose option multiple times, e.g. -vv.
1536
Branches and working trees will also report any missing revisions.
1540
Display information on the format and related locations:
1544
Display the above together with extended format information and
1545
basic statistics (like the number of files in the working tree and
1546
number of revisions in the branch and repository):
1550
Display the above together with number of committers to the branch:
1554
_see_also = ['revno', 'working-trees', 'repositories']
1555
takes_args = ['location?']
1556
takes_options = ['verbose']
1557
encoding_type = 'replace'
1560
def run(self, location=None, verbose=False):
1562
noise_level = get_verbosity_level()
1565
from bzrlib.info import show_bzrdir_info
1566
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1567
verbose=noise_level, outfile=self.outf)
1570
class cmd_remove(Command):
1571
__doc__ = """Remove files or directories.
1573
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1574
delete them if they can easily be recovered using revert otherwise they
1575
will be backed up (adding an extention of the form .~#~). If no options or
1576
parameters are given Bazaar will scan for files that are being tracked by
1577
Bazaar but missing in your tree and stop tracking them for you.
1579
takes_args = ['file*']
1580
takes_options = ['verbose',
1581
Option('new', help='Only remove files that have never been committed.'),
1582
RegistryOption.from_kwargs('file-deletion-strategy',
1583
'The file deletion mode to be used.',
1584
title='Deletion Strategy', value_switches=True, enum_switch=False,
1585
safe='Backup changed files (default).',
1586
keep='Delete from bzr but leave the working copy.',
1587
no_backup='Don\'t backup changed files.',
1588
force='Delete all the specified files, even if they can not be '
1589
'recovered and even if they are non-empty directories. '
1590
'(deprecated, use no-backup)')]
1591
aliases = ['rm', 'del']
1592
encoding_type = 'replace'
1594
def run(self, file_list, verbose=False, new=False,
1595
file_deletion_strategy='safe'):
1596
if file_deletion_strategy == 'force':
1597
note("(The --force option is deprecated, rather use --no-backup "
1599
file_deletion_strategy = 'no-backup'
1601
tree, file_list = WorkingTree.open_containing_paths(file_list)
1603
if file_list is not None:
1604
file_list = [f for f in file_list]
1606
self.add_cleanup(tree.lock_write().unlock)
1607
# Heuristics should probably all move into tree.remove_smart or
1610
added = tree.changes_from(tree.basis_tree(),
1611
specific_files=file_list).added
1612
file_list = sorted([f[0] for f in added], reverse=True)
1613
if len(file_list) == 0:
1614
raise errors.BzrCommandError('No matching files.')
1615
elif file_list is None:
1616
# missing files show up in iter_changes(basis) as
1617
# versioned-with-no-kind.
1619
for change in tree.iter_changes(tree.basis_tree()):
1620
# Find paths in the working tree that have no kind:
1621
if change[1][1] is not None and change[6][1] is None:
1622
missing.append(change[1][1])
1623
file_list = sorted(missing, reverse=True)
1624
file_deletion_strategy = 'keep'
1625
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1626
keep_files=file_deletion_strategy=='keep',
1627
force=(file_deletion_strategy=='no-backup'))
1630
class cmd_file_id(Command):
1631
__doc__ = """Print file_id of a particular file or directory.
1633
The file_id is assigned when the file is first added and remains the
1634
same through all revisions where the file exists, even when it is
1639
_see_also = ['inventory', 'ls']
1640
takes_args = ['filename']
1643
def run(self, filename):
1644
tree, relpath = WorkingTree.open_containing(filename)
1645
i = tree.path2id(relpath)
1647
raise errors.NotVersionedError(filename)
1649
self.outf.write(i + '\n')
1652
class cmd_file_path(Command):
1653
__doc__ = """Print path of file_ids to a file or directory.
1655
This prints one line for each directory down to the target,
1656
starting at the branch root.
1660
takes_args = ['filename']
1663
def run(self, filename):
1664
tree, relpath = WorkingTree.open_containing(filename)
1665
fid = tree.path2id(relpath)
1667
raise errors.NotVersionedError(filename)
1668
segments = osutils.splitpath(relpath)
1669
for pos in range(1, len(segments) + 1):
1670
path = osutils.joinpath(segments[:pos])
1671
self.outf.write("%s\n" % tree.path2id(path))
1674
class cmd_reconcile(Command):
1675
__doc__ = """Reconcile bzr metadata in a branch.
1677
This can correct data mismatches that may have been caused by
1678
previous ghost operations or bzr upgrades. You should only
1679
need to run this command if 'bzr check' or a bzr developer
1680
advises you to run it.
1682
If a second branch is provided, cross-branch reconciliation is
1683
also attempted, which will check that data like the tree root
1684
id which was not present in very early bzr versions is represented
1685
correctly in both branches.
1687
At the same time it is run it may recompress data resulting in
1688
a potential saving in disk space or performance gain.
1690
The branch *MUST* be on a listable system such as local disk or sftp.
1693
_see_also = ['check']
1694
takes_args = ['branch?']
1696
Option('canonicalize-chks',
1697
help='Make sure CHKs are in canonical form (repairs '
1702
def run(self, branch=".", canonicalize_chks=False):
1703
from bzrlib.reconcile import reconcile
1704
dir = bzrdir.BzrDir.open(branch)
1705
reconcile(dir, canonicalize_chks=canonicalize_chks)
1708
class cmd_revision_history(Command):
1709
__doc__ = """Display the list of revision ids on a branch."""
1712
takes_args = ['location?']
1717
def run(self, location="."):
1718
branch = Branch.open_containing(location)[0]
1719
for revid in branch.revision_history():
1720
self.outf.write(revid)
1721
self.outf.write('\n')
1724
class cmd_ancestry(Command):
1725
__doc__ = """List all revisions merged into this branch."""
1727
_see_also = ['log', 'revision-history']
1728
takes_args = ['location?']
1733
def run(self, location="."):
1735
wt = WorkingTree.open_containing(location)[0]
1736
except errors.NoWorkingTree:
1737
b = Branch.open(location)
1738
last_revision = b.last_revision()
1741
last_revision = wt.last_revision()
1743
revision_ids = b.repository.get_ancestry(last_revision)
1745
for revision_id in revision_ids:
1746
self.outf.write(revision_id + '\n')
1749
class cmd_init(Command):
1750
__doc__ = """Make a directory into a versioned branch.
1752
Use this to create an empty branch, or before importing an
1755
If there is a repository in a parent directory of the location, then
1756
the history of the branch will be stored in the repository. Otherwise
1757
init creates a standalone branch which carries its own history
1758
in the .bzr directory.
1760
If there is already a branch at the location but it has no working tree,
1761
the tree can be populated with 'bzr checkout'.
1763
Recipe for importing a tree of files::
1769
bzr commit -m "imported project"
1772
_see_also = ['init-repository', 'branch', 'checkout']
1773
takes_args = ['location?']
1775
Option('create-prefix',
1776
help='Create the path leading up to the branch '
1777
'if it does not already exist.'),
1778
RegistryOption('format',
1779
help='Specify a format for this branch. '
1780
'See "help formats".',
1781
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1782
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1783
value_switches=True,
1784
title="Branch format",
1786
Option('append-revisions-only',
1787
help='Never change revnos or the existing log.'
1788
' Append revisions to it only.'),
1790
'Create a branch without a working tree.')
1792
def run(self, location=None, format=None, append_revisions_only=False,
1793
create_prefix=False, no_tree=False):
1795
format = bzrdir.format_registry.make_bzrdir('default')
1796
if location is None:
1799
to_transport = transport.get_transport(location)
1801
# The path has to exist to initialize a
1802
# branch inside of it.
1803
# Just using os.mkdir, since I don't
1804
# believe that we want to create a bunch of
1805
# locations if the user supplies an extended path
1807
to_transport.ensure_base()
1808
except errors.NoSuchFile:
1809
if not create_prefix:
1810
raise errors.BzrCommandError("Parent directory of %s"
1812
"\nYou may supply --create-prefix to create all"
1813
" leading parent directories."
1815
to_transport.create_prefix()
1818
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1819
except errors.NotBranchError:
1820
# really a NotBzrDir error...
1821
create_branch = bzrdir.BzrDir.create_branch_convenience
1823
force_new_tree = False
1825
force_new_tree = None
1826
branch = create_branch(to_transport.base, format=format,
1827
possible_transports=[to_transport],
1828
force_new_tree=force_new_tree)
1829
a_bzrdir = branch.bzrdir
1831
from bzrlib.transport.local import LocalTransport
1832
if a_bzrdir.has_branch():
1833
if (isinstance(to_transport, LocalTransport)
1834
and not a_bzrdir.has_workingtree()):
1835
raise errors.BranchExistsWithoutWorkingTree(location)
1836
raise errors.AlreadyBranchError(location)
1837
branch = a_bzrdir.create_branch()
1839
a_bzrdir.create_workingtree()
1840
if append_revisions_only:
1842
branch.set_append_revisions_only(True)
1843
except errors.UpgradeRequired:
1844
raise errors.BzrCommandError('This branch format cannot be set'
1845
' to append-revisions-only. Try --default.')
1847
from bzrlib.info import describe_layout, describe_format
1849
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1850
except (errors.NoWorkingTree, errors.NotLocalUrl):
1852
repository = branch.repository
1853
layout = describe_layout(repository, branch, tree).lower()
1854
format = describe_format(a_bzrdir, repository, branch, tree)
1855
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1856
if repository.is_shared():
1857
#XXX: maybe this can be refactored into transport.path_or_url()
1858
url = repository.bzrdir.root_transport.external_url()
1860
url = urlutils.local_path_from_url(url)
1861
except errors.InvalidURL:
1863
self.outf.write("Using shared repository: %s\n" % url)
1866
class cmd_init_repository(Command):
1867
__doc__ = """Create a shared repository for branches to share storage space.
1869
New branches created under the repository directory will store their
1870
revisions in the repository, not in the branch directory. For branches
1871
with shared history, this reduces the amount of storage needed and
1872
speeds up the creation of new branches.
1874
If the --no-trees option is given then the branches in the repository
1875
will not have working trees by default. They will still exist as
1876
directories on disk, but they will not have separate copies of the
1877
files at a certain revision. This can be useful for repositories that
1878
store branches which are interacted with through checkouts or remote
1879
branches, such as on a server.
1882
Create a shared repository holding just branches::
1884
bzr init-repo --no-trees repo
1887
Make a lightweight checkout elsewhere::
1889
bzr checkout --lightweight repo/trunk trunk-checkout
1894
_see_also = ['init', 'branch', 'checkout', 'repositories']
1895
takes_args = ["location"]
1896
takes_options = [RegistryOption('format',
1897
help='Specify a format for this repository. See'
1898
' "bzr help formats" for details.',
1899
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1900
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1901
value_switches=True, title='Repository format'),
1903
help='Branches in the repository will default to'
1904
' not having a working tree.'),
1906
aliases = ["init-repo"]
1908
def run(self, location, format=None, no_trees=False):
1910
format = bzrdir.format_registry.make_bzrdir('default')
1912
if location is None:
1915
to_transport = transport.get_transport(location)
1916
to_transport.ensure_base()
1918
newdir = format.initialize_on_transport(to_transport)
1919
repo = newdir.create_repository(shared=True)
1920
repo.set_make_working_trees(not no_trees)
1922
from bzrlib.info import show_bzrdir_info
1923
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1926
class cmd_diff(Command):
1927
__doc__ = """Show differences in the working tree, between revisions or branches.
1929
If no arguments are given, all changes for the current tree are listed.
1930
If files are given, only the changes in those files are listed.
1931
Remote and multiple branches can be compared by using the --old and
1932
--new options. If not provided, the default for both is derived from
1933
the first argument, if any, or the current tree if no arguments are
1936
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1937
produces patches suitable for "patch -p1".
1939
Note that when using the -r argument with a range of revisions, the
1940
differences are computed between the two specified revisions. That
1941
is, the command does not show the changes introduced by the first
1942
revision in the range. This differs from the interpretation of
1943
revision ranges used by "bzr log" which includes the first revision
1948
2 - unrepresentable changes
1953
Shows the difference in the working tree versus the last commit::
1957
Difference between the working tree and revision 1::
1961
Difference between revision 3 and revision 1::
1965
Difference between revision 3 and revision 1 for branch xxx::
1969
The changes introduced by revision 2 (equivalent to -r1..2)::
1973
To see the changes introduced by revision X::
1977
Note that in the case of a merge, the -c option shows the changes
1978
compared to the left hand parent. To see the changes against
1979
another parent, use::
1981
bzr diff -r<chosen_parent>..X
1983
The changes between the current revision and the previous revision
1984
(equivalent to -c-1 and -r-2..-1)
1988
Show just the differences for file NEWS::
1992
Show the differences in working tree xxx for file NEWS::
1996
Show the differences from branch xxx to this working tree:
2000
Show the differences between two branches for file NEWS::
2002
bzr diff --old xxx --new yyy NEWS
2004
Same as 'bzr diff' but prefix paths with old/ and new/::
2006
bzr diff --prefix old/:new/
2008
Show the differences using a custom diff program with options::
2010
bzr diff --using /usr/bin/diff --diff-options -wu
2012
_see_also = ['status']
2013
takes_args = ['file*']
2015
Option('diff-options', type=str,
2016
help='Pass these options to the external diff program.'),
2017
Option('prefix', type=str,
2019
help='Set prefixes added to old and new filenames, as '
2020
'two values separated by a colon. (eg "old/:new/").'),
2022
help='Branch/tree to compare from.',
2026
help='Branch/tree to compare to.',
2032
help='Use this command to compare files.',
2035
RegistryOption('format',
2037
help='Diff format to use.',
2038
lazy_registry=('bzrlib.diff', 'format_registry'),
2039
title='Diff format'),
2041
aliases = ['di', 'dif']
2042
encoding_type = 'exact'
2045
def run(self, revision=None, file_list=None, diff_options=None,
2046
prefix=None, old=None, new=None, using=None, format=None):
2047
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2050
if (prefix is None) or (prefix == '0'):
2058
old_label, new_label = prefix.split(":")
2060
raise errors.BzrCommandError(
2061
'--prefix expects two values separated by a colon'
2062
' (eg "old/:new/")')
2064
if revision and len(revision) > 2:
2065
raise errors.BzrCommandError('bzr diff --revision takes exactly'
2066
' one or two revision specifiers')
2068
if using is not None and format is not None:
2069
raise errors.BzrCommandError('--using and --format are mutually '
2072
(old_tree, new_tree,
2073
old_branch, new_branch,
2074
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2075
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2076
# GNU diff on Windows uses ANSI encoding for filenames
2077
path_encoding = osutils.get_diff_header_encoding()
2078
return show_diff_trees(old_tree, new_tree, sys.stdout,
2079
specific_files=specific_files,
2080
external_diff_options=diff_options,
2081
old_label=old_label, new_label=new_label,
2082
extra_trees=extra_trees,
2083
path_encoding=path_encoding,
2088
class cmd_deleted(Command):
2089
__doc__ = """List files deleted in the working tree.
2091
# TODO: Show files deleted since a previous revision, or
2092
# between two revisions.
2093
# TODO: Much more efficient way to do this: read in new
2094
# directories with readdir, rather than stating each one. Same
2095
# level of effort but possibly much less IO. (Or possibly not,
2096
# if the directories are very large...)
2097
_see_also = ['status', 'ls']
2098
takes_options = ['directory', 'show-ids']
2101
def run(self, show_ids=False, directory=u'.'):
2102
tree = WorkingTree.open_containing(directory)[0]
2103
self.add_cleanup(tree.lock_read().unlock)
2104
old = tree.basis_tree()
2105
self.add_cleanup(old.lock_read().unlock)
2106
for path, ie in old.inventory.iter_entries():
2107
if not tree.has_id(ie.file_id):
2108
self.outf.write(path)
2110
self.outf.write(' ')
2111
self.outf.write(ie.file_id)
2112
self.outf.write('\n')
2115
class cmd_modified(Command):
2116
__doc__ = """List files modified in working tree.
2120
_see_also = ['status', 'ls']
2121
takes_options = ['directory', 'null']
2124
def run(self, null=False, directory=u'.'):
2125
tree = WorkingTree.open_containing(directory)[0]
2126
self.add_cleanup(tree.lock_read().unlock)
2127
td = tree.changes_from(tree.basis_tree())
2129
for path, id, kind, text_modified, meta_modified in td.modified:
2131
self.outf.write(path + '\0')
2133
self.outf.write(osutils.quotefn(path) + '\n')
2136
class cmd_added(Command):
2137
__doc__ = """List files added in working tree.
2141
_see_also = ['status', 'ls']
2142
takes_options = ['directory', 'null']
2145
def run(self, null=False, directory=u'.'):
2146
wt = WorkingTree.open_containing(directory)[0]
2147
self.add_cleanup(wt.lock_read().unlock)
2148
basis = wt.basis_tree()
2149
self.add_cleanup(basis.lock_read().unlock)
2150
basis_inv = basis.inventory
2153
if file_id in basis_inv:
2155
if inv.is_root(file_id) and len(basis_inv) == 0:
2157
path = inv.id2path(file_id)
2158
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2161
self.outf.write(path + '\0')
2163
self.outf.write(osutils.quotefn(path) + '\n')
2166
class cmd_root(Command):
2167
__doc__ = """Show the tree root directory.
2169
The root is the nearest enclosing directory with a .bzr control
2172
takes_args = ['filename?']
2174
def run(self, filename=None):
2175
"""Print the branch root."""
2176
tree = WorkingTree.open_containing(filename)[0]
2177
self.outf.write(tree.basedir + '\n')
2180
def _parse_limit(limitstring):
2182
return int(limitstring)
2184
msg = "The limit argument must be an integer."
2185
raise errors.BzrCommandError(msg)
2188
def _parse_levels(s):
2192
msg = "The levels argument must be an integer."
2193
raise errors.BzrCommandError(msg)
2196
class cmd_log(Command):
2197
__doc__ = """Show historical log for a branch or subset of a branch.
2199
log is bzr's default tool for exploring the history of a branch.
2200
The branch to use is taken from the first parameter. If no parameters
2201
are given, the branch containing the working directory is logged.
2202
Here are some simple examples::
2204
bzr log log the current branch
2205
bzr log foo.py log a file in its branch
2206
bzr log http://server/branch log a branch on a server
2208
The filtering, ordering and information shown for each revision can
2209
be controlled as explained below. By default, all revisions are
2210
shown sorted (topologically) so that newer revisions appear before
2211
older ones and descendants always appear before ancestors. If displayed,
2212
merged revisions are shown indented under the revision in which they
2217
The log format controls how information about each revision is
2218
displayed. The standard log formats are called ``long``, ``short``
2219
and ``line``. The default is long. See ``bzr help log-formats``
2220
for more details on log formats.
2222
The following options can be used to control what information is
2225
-l N display a maximum of N revisions
2226
-n N display N levels of revisions (0 for all, 1 for collapsed)
2227
-v display a status summary (delta) for each revision
2228
-p display a diff (patch) for each revision
2229
--show-ids display revision-ids (and file-ids), not just revnos
2231
Note that the default number of levels to display is a function of the
2232
log format. If the -n option is not used, the standard log formats show
2233
just the top level (mainline).
2235
Status summaries are shown using status flags like A, M, etc. To see
2236
the changes explained using words like ``added`` and ``modified``
2237
instead, use the -vv option.
2241
To display revisions from oldest to newest, use the --forward option.
2242
In most cases, using this option will have little impact on the total
2243
time taken to produce a log, though --forward does not incrementally
2244
display revisions like --reverse does when it can.
2246
:Revision filtering:
2248
The -r option can be used to specify what revision or range of revisions
2249
to filter against. The various forms are shown below::
2251
-rX display revision X
2252
-rX.. display revision X and later
2253
-r..Y display up to and including revision Y
2254
-rX..Y display from X to Y inclusive
2256
See ``bzr help revisionspec`` for details on how to specify X and Y.
2257
Some common examples are given below::
2259
-r-1 show just the tip
2260
-r-10.. show the last 10 mainline revisions
2261
-rsubmit:.. show what's new on this branch
2262
-rancestor:path.. show changes since the common ancestor of this
2263
branch and the one at location path
2264
-rdate:yesterday.. show changes since yesterday
2266
When logging a range of revisions using -rX..Y, log starts at
2267
revision Y and searches back in history through the primary
2268
("left-hand") parents until it finds X. When logging just the
2269
top level (using -n1), an error is reported if X is not found
2270
along the way. If multi-level logging is used (-n0), X may be
2271
a nested merge revision and the log will be truncated accordingly.
2275
If parameters are given and the first one is not a branch, the log
2276
will be filtered to show only those revisions that changed the
2277
nominated files or directories.
2279
Filenames are interpreted within their historical context. To log a
2280
deleted file, specify a revision range so that the file existed at
2281
the end or start of the range.
2283
Historical context is also important when interpreting pathnames of
2284
renamed files/directories. Consider the following example:
2286
* revision 1: add tutorial.txt
2287
* revision 2: modify tutorial.txt
2288
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2292
* ``bzr log guide.txt`` will log the file added in revision 1
2294
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2296
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2297
the original file in revision 2.
2299
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2300
was no file called guide.txt in revision 2.
2302
Renames are always followed by log. By design, there is no need to
2303
explicitly ask for this (and no way to stop logging a file back
2304
until it was last renamed).
2308
The --message option can be used for finding revisions that match a
2309
regular expression in a commit message.
2313
GUI tools and IDEs are often better at exploring history than command
2314
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2315
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2316
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2317
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2319
You may find it useful to add the aliases below to ``bazaar.conf``::
2323
top = log -l10 --line
2326
``bzr tip`` will then show the latest revision while ``bzr top``
2327
will show the last 10 mainline revisions. To see the details of a
2328
particular revision X, ``bzr show -rX``.
2330
If you are interested in looking deeper into a particular merge X,
2331
use ``bzr log -n0 -rX``.
2333
``bzr log -v`` on a branch with lots of history is currently
2334
very slow. A fix for this issue is currently under development.
2335
With or without that fix, it is recommended that a revision range
2336
be given when using the -v option.
2338
bzr has a generic full-text matching plugin, bzr-search, that can be
2339
used to find revisions matching user names, commit messages, etc.
2340
Among other features, this plugin can find all revisions containing
2341
a list of words but not others.
2343
When exploring non-mainline history on large projects with deep
2344
history, the performance of log can be greatly improved by installing
2345
the historycache plugin. This plugin buffers historical information
2346
trading disk space for faster speed.
2348
takes_args = ['file*']
2349
_see_also = ['log-formats', 'revisionspec']
2352
help='Show from oldest to newest.'),
2354
custom_help('verbose',
2355
help='Show files changed in each revision.'),
2359
type=bzrlib.option._parse_revision_str,
2361
help='Show just the specified revision.'
2362
' See also "help revisionspec".'),
2364
RegistryOption('authors',
2365
'What names to list as authors - first, all or committer.',
2367
lazy_registry=('bzrlib.log', 'author_list_registry'),
2371
help='Number of levels to display - 0 for all, 1 for flat.',
2373
type=_parse_levels),
2376
help='Show revisions whose message matches this '
2377
'regular expression.',
2381
help='Limit the output to the first N revisions.',
2386
help='Show changes made in each revision as a patch.'),
2387
Option('include-merges',
2388
help='Show merged revisions like --levels 0 does.'),
2389
Option('exclude-common-ancestry',
2390
help='Display only the revisions that are not part'
2391
' of both ancestries (require -rX..Y)'
2394
encoding_type = 'replace'
2397
def run(self, file_list=None, timezone='original',
2408
include_merges=False,
2410
exclude_common_ancestry=False,
2412
from bzrlib.log import (
2414
make_log_request_dict,
2415
_get_info_for_log_files,
2417
direction = (forward and 'forward') or 'reverse'
2418
if (exclude_common_ancestry
2419
and (revision is None or len(revision) != 2)):
2420
raise errors.BzrCommandError(
2421
'--exclude-common-ancestry requires -r with two revisions')
2426
raise errors.BzrCommandError(
2427
'--levels and --include-merges are mutually exclusive')
2429
if change is not None:
2431
raise errors.RangeInChangeOption()
2432
if revision is not None:
2433
raise errors.BzrCommandError(
2434
'--revision and --change are mutually exclusive')
2439
filter_by_dir = False
2441
# find the file ids to log and check for directory filtering
2442
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2443
revision, file_list, self.add_cleanup)
2444
for relpath, file_id, kind in file_info_list:
2446
raise errors.BzrCommandError(
2447
"Path unknown at end or start of revision range: %s" %
2449
# If the relpath is the top of the tree, we log everything
2454
file_ids.append(file_id)
2455
filter_by_dir = filter_by_dir or (
2456
kind in ['directory', 'tree-reference'])
2459
# FIXME ? log the current subdir only RBC 20060203
2460
if revision is not None \
2461
and len(revision) > 0 and revision[0].get_branch():
2462
location = revision[0].get_branch()
2465
dir, relpath = bzrdir.BzrDir.open_containing(location)
2466
b = dir.open_branch()
2467
self.add_cleanup(b.lock_read().unlock)
2468
rev1, rev2 = _get_revision_range(revision, b, self.name())
2470
# Decide on the type of delta & diff filtering to use
2471
# TODO: add an --all-files option to make this configurable & consistent
2479
diff_type = 'partial'
2483
# Build the log formatter
2484
if log_format is None:
2485
log_format = log.log_formatter_registry.get_default(b)
2486
# Make a non-encoding output to include the diffs - bug 328007
2487
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2488
lf = log_format(show_ids=show_ids, to_file=self.outf,
2489
to_exact_file=unencoded_output,
2490
show_timezone=timezone,
2491
delta_format=get_verbosity_level(),
2493
show_advice=levels is None,
2494
author_list_handler=authors)
2496
# Choose the algorithm for doing the logging. It's annoying
2497
# having multiple code paths like this but necessary until
2498
# the underlying repository format is faster at generating
2499
# deltas or can provide everything we need from the indices.
2500
# The default algorithm - match-using-deltas - works for
2501
# multiple files and directories and is faster for small
2502
# amounts of history (200 revisions say). However, it's too
2503
# slow for logging a single file in a repository with deep
2504
# history, i.e. > 10K revisions. In the spirit of "do no
2505
# evil when adding features", we continue to use the
2506
# original algorithm - per-file-graph - for the "single
2507
# file that isn't a directory without showing a delta" case.
2508
partial_history = revision and b.repository._format.supports_chks
2509
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2510
or delta_type or partial_history)
2512
# Build the LogRequest and execute it
2513
if len(file_ids) == 0:
2515
rqst = make_log_request_dict(
2516
direction=direction, specific_fileids=file_ids,
2517
start_revision=rev1, end_revision=rev2, limit=limit,
2518
message_search=message, delta_type=delta_type,
2519
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2520
exclude_common_ancestry=exclude_common_ancestry,
2522
Logger(b, rqst).show(lf)
2525
def _get_revision_range(revisionspec_list, branch, command_name):
2526
"""Take the input of a revision option and turn it into a revision range.
2528
It returns RevisionInfo objects which can be used to obtain the rev_id's
2529
of the desired revisions. It does some user input validations.
2531
if revisionspec_list is None:
2534
elif len(revisionspec_list) == 1:
2535
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2536
elif len(revisionspec_list) == 2:
2537
start_spec = revisionspec_list[0]
2538
end_spec = revisionspec_list[1]
2539
if end_spec.get_branch() != start_spec.get_branch():
2540
# b is taken from revision[0].get_branch(), and
2541
# show_log will use its revision_history. Having
2542
# different branches will lead to weird behaviors.
2543
raise errors.BzrCommandError(
2544
"bzr %s doesn't accept two revisions in different"
2545
" branches." % command_name)
2546
if start_spec.spec is None:
2547
# Avoid loading all the history.
2548
rev1 = RevisionInfo(branch, None, None)
2550
rev1 = start_spec.in_history(branch)
2551
# Avoid loading all of history when we know a missing
2552
# end of range means the last revision ...
2553
if end_spec.spec is None:
2554
last_revno, last_revision_id = branch.last_revision_info()
2555
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2557
rev2 = end_spec.in_history(branch)
2559
raise errors.BzrCommandError(
2560
'bzr %s --revision takes one or two values.' % command_name)
2564
def _revision_range_to_revid_range(revision_range):
2567
if revision_range[0] is not None:
2568
rev_id1 = revision_range[0].rev_id
2569
if revision_range[1] is not None:
2570
rev_id2 = revision_range[1].rev_id
2571
return rev_id1, rev_id2
2573
def get_log_format(long=False, short=False, line=False, default='long'):
2574
log_format = default
2578
log_format = 'short'
2584
class cmd_touching_revisions(Command):
2585
__doc__ = """Return revision-ids which affected a particular file.
2587
A more user-friendly interface is "bzr log FILE".
2591
takes_args = ["filename"]
2594
def run(self, filename):
2595
tree, relpath = WorkingTree.open_containing(filename)
2596
file_id = tree.path2id(relpath)
2598
self.add_cleanup(b.lock_read().unlock)
2599
touching_revs = log.find_touching_revisions(b, file_id)
2600
for revno, revision_id, what in touching_revs:
2601
self.outf.write("%6d %s\n" % (revno, what))
2604
class cmd_ls(Command):
2605
__doc__ = """List files in a tree.
2608
_see_also = ['status', 'cat']
2609
takes_args = ['path?']
2613
Option('recursive', short_name='R',
2614
help='Recurse into subdirectories.'),
2616
help='Print paths relative to the root of the branch.'),
2617
Option('unknown', short_name='u',
2618
help='Print unknown files.'),
2619
Option('versioned', help='Print versioned files.',
2621
Option('ignored', short_name='i',
2622
help='Print ignored files.'),
2623
Option('kind', short_name='k',
2624
help='List entries of a particular kind: file, directory, symlink.',
2631
def run(self, revision=None, verbose=False,
2632
recursive=False, from_root=False,
2633
unknown=False, versioned=False, ignored=False,
2634
null=False, kind=None, show_ids=False, path=None, directory=None):
2636
if kind and kind not in ('file', 'directory', 'symlink'):
2637
raise errors.BzrCommandError('invalid kind specified')
2639
if verbose and null:
2640
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2641
all = not (unknown or versioned or ignored)
2643
selection = {'I':ignored, '?':unknown, 'V':versioned}
2649
raise errors.BzrCommandError('cannot specify both --from-root'
2652
tree, branch, relpath = \
2653
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2655
# Calculate the prefix to use
2659
prefix = relpath + '/'
2660
elif fs_path != '.' and not fs_path.endswith('/'):
2661
prefix = fs_path + '/'
2663
if revision is not None or tree is None:
2664
tree = _get_one_revision_tree('ls', revision, branch=branch)
2667
if isinstance(tree, WorkingTree) and tree.supports_views():
2668
view_files = tree.views.lookup_view()
2671
view_str = views.view_display_str(view_files)
2672
note("Ignoring files outside view. View is %s" % view_str)
2674
self.add_cleanup(tree.lock_read().unlock)
2675
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2676
from_dir=relpath, recursive=recursive):
2677
# Apply additional masking
2678
if not all and not selection[fc]:
2680
if kind is not None and fkind != kind:
2685
fullpath = osutils.pathjoin(relpath, fp)
2688
views.check_path_in_view(tree, fullpath)
2689
except errors.FileOutsideView:
2694
fp = osutils.pathjoin(prefix, fp)
2695
kindch = entry.kind_character()
2696
outstring = fp + kindch
2697
ui.ui_factory.clear_term()
2699
outstring = '%-8s %s' % (fc, outstring)
2700
if show_ids and fid is not None:
2701
outstring = "%-50s %s" % (outstring, fid)
2702
self.outf.write(outstring + '\n')
2704
self.outf.write(fp + '\0')
2707
self.outf.write(fid)
2708
self.outf.write('\0')
2716
self.outf.write('%-50s %s\n' % (outstring, my_id))
2718
self.outf.write(outstring + '\n')
2721
class cmd_unknowns(Command):
2722
__doc__ = """List unknown files.
2727
takes_options = ['directory']
2730
def run(self, directory=u'.'):
2731
for f in WorkingTree.open_containing(directory)[0].unknowns():
2732
self.outf.write(osutils.quotefn(f) + '\n')
2735
class cmd_ignore(Command):
2736
__doc__ = """Ignore specified files or patterns.
2738
See ``bzr help patterns`` for details on the syntax of patterns.
2740
If a .bzrignore file does not exist, the ignore command
2741
will create one and add the specified files or patterns to the newly
2742
created file. The ignore command will also automatically add the
2743
.bzrignore file to be versioned. Creating a .bzrignore file without
2744
the use of the ignore command will require an explicit add command.
2746
To remove patterns from the ignore list, edit the .bzrignore file.
2747
After adding, editing or deleting that file either indirectly by
2748
using this command or directly by using an editor, be sure to commit
2751
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2752
the global ignore file can be found in the application data directory as
2753
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2754
Global ignores are not touched by this command. The global ignore file
2755
can be edited directly using an editor.
2757
Patterns prefixed with '!' are exceptions to ignore patterns and take
2758
precedence over regular ignores. Such exceptions are used to specify
2759
files that should be versioned which would otherwise be ignored.
2761
Patterns prefixed with '!!' act as regular ignore patterns, but have
2762
precedence over the '!' exception patterns.
2766
* Ignore patterns containing shell wildcards must be quoted from
2769
* Ignore patterns starting with "#" act as comments in the ignore file.
2770
To ignore patterns that begin with that character, use the "RE:" prefix.
2773
Ignore the top level Makefile::
2775
bzr ignore ./Makefile
2777
Ignore .class files in all directories...::
2779
bzr ignore "*.class"
2781
...but do not ignore "special.class"::
2783
bzr ignore "!special.class"
2785
Ignore files whose name begins with the "#" character::
2789
Ignore .o files under the lib directory::
2791
bzr ignore "lib/**/*.o"
2793
Ignore .o files under the lib directory::
2795
bzr ignore "RE:lib/.*\.o"
2797
Ignore everything but the "debian" toplevel directory::
2799
bzr ignore "RE:(?!debian/).*"
2801
Ignore everything except the "local" toplevel directory,
2802
but always ignore autosave files ending in ~, even under local/::
2805
bzr ignore "!./local"
2809
_see_also = ['status', 'ignored', 'patterns']
2810
takes_args = ['name_pattern*']
2811
takes_options = ['directory',
2812
Option('default-rules',
2813
help='Display the default ignore rules that bzr uses.')
2816
def run(self, name_pattern_list=None, default_rules=None,
2818
from bzrlib import ignores
2819
if default_rules is not None:
2820
# dump the default rules and exit
2821
for pattern in ignores.USER_DEFAULTS:
2822
self.outf.write("%s\n" % pattern)
2824
if not name_pattern_list:
2825
raise errors.BzrCommandError("ignore requires at least one "
2826
"NAME_PATTERN or --default-rules.")
2827
name_pattern_list = [globbing.normalize_pattern(p)
2828
for p in name_pattern_list]
2830
for p in name_pattern_list:
2831
if not globbing.Globster.is_pattern_valid(p):
2832
bad_patterns += ('\n %s' % p)
2834
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2835
ui.ui_factory.show_error(msg)
2836
raise errors.InvalidPattern('')
2837
for name_pattern in name_pattern_list:
2838
if (name_pattern[0] == '/' or
2839
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2840
raise errors.BzrCommandError(
2841
"NAME_PATTERN should not be an absolute path")
2842
tree, relpath = WorkingTree.open_containing(directory)
2843
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2844
ignored = globbing.Globster(name_pattern_list)
2846
self.add_cleanup(tree.lock_read().unlock)
2847
for entry in tree.list_files():
2851
if ignored.match(filename):
2852
matches.append(filename)
2853
if len(matches) > 0:
2854
self.outf.write("Warning: the following files are version controlled and"
2855
" match your ignore pattern:\n%s"
2856
"\nThese files will continue to be version controlled"
2857
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2860
class cmd_ignored(Command):
2861
__doc__ = """List ignored files and the patterns that matched them.
2863
List all the ignored files and the ignore pattern that caused the file to
2866
Alternatively, to list just the files::
2871
encoding_type = 'replace'
2872
_see_also = ['ignore', 'ls']
2873
takes_options = ['directory']
2876
def run(self, directory=u'.'):
2877
tree = WorkingTree.open_containing(directory)[0]
2878
self.add_cleanup(tree.lock_read().unlock)
2879
for path, file_class, kind, file_id, entry in tree.list_files():
2880
if file_class != 'I':
2882
## XXX: Slightly inefficient since this was already calculated
2883
pat = tree.is_ignored(path)
2884
self.outf.write('%-50s %s\n' % (path, pat))
2887
class cmd_lookup_revision(Command):
2888
__doc__ = """Lookup the revision-id from a revision-number
2891
bzr lookup-revision 33
2894
takes_args = ['revno']
2895
takes_options = ['directory']
2898
def run(self, revno, directory=u'.'):
2902
raise errors.BzrCommandError("not a valid revision-number: %r"
2904
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2905
self.outf.write("%s\n" % revid)
2908
class cmd_export(Command):
2909
__doc__ = """Export current or past revision to a destination directory or archive.
2911
If no revision is specified this exports the last committed revision.
2913
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2914
given, try to find the format with the extension. If no extension
2915
is found exports to a directory (equivalent to --format=dir).
2917
If root is supplied, it will be used as the root directory inside
2918
container formats (tar, zip, etc). If it is not supplied it will default
2919
to the exported filename. The root option has no effect for 'dir' format.
2921
If branch is omitted then the branch containing the current working
2922
directory will be used.
2924
Note: Export of tree with non-ASCII filenames to zip is not supported.
2926
================= =========================
2927
Supported formats Autodetected by extension
2928
================= =========================
2931
tbz2 .tar.bz2, .tbz2
2934
================= =========================
2937
takes_args = ['dest', 'branch_or_subdir?']
2938
takes_options = ['directory',
2940
help="Type of file to export to.",
2943
Option('filters', help='Apply content filters to export the '
2944
'convenient form.'),
2947
help="Name of the root directory inside the exported file."),
2948
Option('per-file-timestamps',
2949
help='Set modification time of files to that of the last '
2950
'revision in which it was changed.'),
2952
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2953
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2954
from bzrlib.export import export
2956
if branch_or_subdir is None:
2957
tree = WorkingTree.open_containing(directory)[0]
2961
b, subdir = Branch.open_containing(branch_or_subdir)
2964
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2966
export(rev_tree, dest, format, root, subdir, filtered=filters,
2967
per_file_timestamps=per_file_timestamps)
2968
except errors.NoSuchExportFormat, e:
2969
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2972
class cmd_cat(Command):
2973
__doc__ = """Write the contents of a file as of a given revision to standard output.
2975
If no revision is nominated, the last revision is used.
2977
Note: Take care to redirect standard output when using this command on a
2982
takes_options = ['directory',
2983
Option('name-from-revision', help='The path name in the old tree.'),
2984
Option('filters', help='Apply content filters to display the '
2985
'convenience form.'),
2988
takes_args = ['filename']
2989
encoding_type = 'exact'
2992
def run(self, filename, revision=None, name_from_revision=False,
2993
filters=False, directory=None):
2994
if revision is not None and len(revision) != 1:
2995
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2996
" one revision specifier")
2997
tree, branch, relpath = \
2998
_open_directory_or_containing_tree_or_branch(filename, directory)
2999
self.add_cleanup(branch.lock_read().unlock)
3000
return self._run(tree, branch, relpath, filename, revision,
3001
name_from_revision, filters)
3003
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3006
tree = b.basis_tree()
3007
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3008
self.add_cleanup(rev_tree.lock_read().unlock)
3010
old_file_id = rev_tree.path2id(relpath)
3012
if name_from_revision:
3013
# Try in revision if requested
3014
if old_file_id is None:
3015
raise errors.BzrCommandError(
3016
"%r is not present in revision %s" % (
3017
filename, rev_tree.get_revision_id()))
3019
content = rev_tree.get_file_text(old_file_id)
3021
cur_file_id = tree.path2id(relpath)
3023
if cur_file_id is not None:
3024
# Then try with the actual file id
3026
content = rev_tree.get_file_text(cur_file_id)
3028
except errors.NoSuchId:
3029
# The actual file id didn't exist at that time
3031
if not found and old_file_id is not None:
3032
# Finally try with the old file id
3033
content = rev_tree.get_file_text(old_file_id)
3036
# Can't be found anywhere
3037
raise errors.BzrCommandError(
3038
"%r is not present in revision %s" % (
3039
filename, rev_tree.get_revision_id()))
3041
from bzrlib.filters import (
3042
ContentFilterContext,
3043
filtered_output_bytes,
3045
filters = rev_tree._content_filter_stack(relpath)
3046
chunks = content.splitlines(True)
3047
content = filtered_output_bytes(chunks, filters,
3048
ContentFilterContext(relpath, rev_tree))
3050
self.outf.writelines(content)
3053
self.outf.write(content)
3056
class cmd_local_time_offset(Command):
3057
__doc__ = """Show the offset in seconds from GMT to local time."""
3061
self.outf.write("%s\n" % osutils.local_time_offset())
3065
class cmd_commit(Command):
3066
__doc__ = """Commit changes into a new revision.
3068
An explanatory message needs to be given for each commit. This is
3069
often done by using the --message option (getting the message from the
3070
command line) or by using the --file option (getting the message from
3071
a file). If neither of these options is given, an editor is opened for
3072
the user to enter the message. To see the changed files in the
3073
boilerplate text loaded into the editor, use the --show-diff option.
3075
By default, the entire tree is committed and the person doing the
3076
commit is assumed to be the author. These defaults can be overridden
3081
If selected files are specified, only changes to those files are
3082
committed. If a directory is specified then the directory and
3083
everything within it is committed.
3085
When excludes are given, they take precedence over selected files.
3086
For example, to commit only changes within foo, but not changes
3089
bzr commit foo -x foo/bar
3091
A selective commit after a merge is not yet supported.
3095
If the author of the change is not the same person as the committer,
3096
you can specify the author's name using the --author option. The
3097
name should be in the same format as a committer-id, e.g.
3098
"John Doe <jdoe@example.com>". If there is more than one author of
3099
the change you can specify the option multiple times, once for each
3104
A common mistake is to forget to add a new file or directory before
3105
running the commit command. The --strict option checks for unknown
3106
files and aborts the commit if any are found. More advanced pre-commit
3107
checks can be implemented by defining hooks. See ``bzr help hooks``
3112
If you accidentially commit the wrong changes or make a spelling
3113
mistake in the commit message say, you can use the uncommit command
3114
to undo it. See ``bzr help uncommit`` for details.
3116
Hooks can also be configured to run after a commit. This allows you
3117
to trigger updates to external systems like bug trackers. The --fixes
3118
option can be used to record the association between a revision and
3119
one or more bugs. See ``bzr help bugs`` for details.
3122
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3123
takes_args = ['selected*']
3125
ListOption('exclude', type=str, short_name='x',
3126
help="Do not consider changes made to a given path."),
3127
Option('message', type=unicode,
3129
help="Description of the new revision."),
3132
help='Commit even if nothing has changed.'),
3133
Option('file', type=str,
3136
help='Take commit message from this file.'),
3138
help="Refuse to commit if there are unknown "
3139
"files in the working tree."),
3140
Option('commit-time', type=str,
3141
help="Manually set a commit time using commit date "
3142
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3143
ListOption('fixes', type=str,
3144
help="Mark a bug as being fixed by this revision "
3145
"(see \"bzr help bugs\")."),
3146
ListOption('author', type=unicode,
3147
help="Set the author's name, if it's different "
3148
"from the committer."),
3150
help="Perform a local commit in a bound "
3151
"branch. Local commits are not pushed to "
3152
"the master branch until a normal commit "
3155
Option('show-diff', short_name='p',
3156
help='When no message is supplied, show the diff along'
3157
' with the status summary in the message editor.'),
3159
help='When committing to a foreign version control '
3160
'system do not push data that can not be natively '
3163
aliases = ['ci', 'checkin']
3165
def _iter_bug_fix_urls(self, fixes, branch):
3166
# Configure the properties for bug fixing attributes.
3167
for fixed_bug in fixes:
3168
tokens = fixed_bug.split(':')
3169
if len(tokens) != 2:
3170
raise errors.BzrCommandError(
3171
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3172
"See \"bzr help bugs\" for more information on this "
3173
"feature.\nCommit refused." % fixed_bug)
3174
tag, bug_id = tokens
3176
yield bugtracker.get_bug_url(tag, branch, bug_id)
3177
except errors.UnknownBugTrackerAbbreviation:
3178
raise errors.BzrCommandError(
3179
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3180
except errors.MalformedBugIdentifier, e:
3181
raise errors.BzrCommandError(
3182
"%s\nCommit refused." % (str(e),))
3184
def run(self, message=None, file=None, verbose=False, selected_list=None,
3185
unchanged=False, strict=False, local=False, fixes=None,
3186
author=None, show_diff=False, exclude=None, commit_time=None,
3188
from bzrlib.errors import (
3193
from bzrlib.msgeditor import (
3194
edit_commit_message_encoded,
3195
generate_commit_message_template,
3196
make_commit_message_template_encoded
3199
commit_stamp = offset = None
3200
if commit_time is not None:
3202
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3203
except ValueError, e:
3204
raise errors.BzrCommandError(
3205
"Could not parse --commit-time: " + str(e))
3209
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3210
if selected_list == ['']:
3211
# workaround - commit of root of tree should be exactly the same
3212
# as just default commit in that tree, and succeed even though
3213
# selected-file merge commit is not done yet
3218
bug_property = bugtracker.encode_fixes_bug_urls(
3219
self._iter_bug_fix_urls(fixes, tree.branch))
3221
properties['bugs'] = bug_property
3223
if local and not tree.branch.get_bound_location():
3224
raise errors.LocalRequiresBoundBranch()
3226
if message is not None:
3228
file_exists = osutils.lexists(message)
3229
except UnicodeError:
3230
# The commit message contains unicode characters that can't be
3231
# represented in the filesystem encoding, so that can't be a
3236
'The commit message is a file name: "%(f)s".\n'
3237
'(use --file "%(f)s" to take commit message from that file)'
3239
ui.ui_factory.show_warning(warning_msg)
3241
message = message.replace('\r\n', '\n')
3242
message = message.replace('\r', '\n')
3244
raise errors.BzrCommandError(
3245
"please specify either --message or --file")
3247
def get_message(commit_obj):
3248
"""Callback to get commit message"""
3252
my_message = f.read().decode(osutils.get_user_encoding())
3255
elif message is not None:
3256
my_message = message
3258
# No message supplied: make one up.
3259
# text is the status of the tree
3260
text = make_commit_message_template_encoded(tree,
3261
selected_list, diff=show_diff,
3262
output_encoding=osutils.get_user_encoding())
3263
# start_message is the template generated from hooks
3264
# XXX: Warning - looks like hooks return unicode,
3265
# make_commit_message_template_encoded returns user encoding.
3266
# We probably want to be using edit_commit_message instead to
3268
start_message = generate_commit_message_template(commit_obj)
3269
my_message = edit_commit_message_encoded(text,
3270
start_message=start_message)
3271
if my_message is None:
3272
raise errors.BzrCommandError("please specify a commit"
3273
" message with either --message or --file")
3274
if my_message == "":
3275
raise errors.BzrCommandError("empty commit message specified")
3278
# The API permits a commit with a filter of [] to mean 'select nothing'
3279
# but the command line should not do that.
3280
if not selected_list:
3281
selected_list = None
3283
tree.commit(message_callback=get_message,
3284
specific_files=selected_list,
3285
allow_pointless=unchanged, strict=strict, local=local,
3286
reporter=None, verbose=verbose, revprops=properties,
3287
authors=author, timestamp=commit_stamp,
3289
exclude=tree.safe_relpath_files(exclude),
3291
except PointlessCommit:
3292
raise errors.BzrCommandError("No changes to commit."
3293
" Please 'bzr add' the files you want to commit, or use"
3294
" --unchanged to force an empty commit.")
3295
except ConflictsInTree:
3296
raise errors.BzrCommandError('Conflicts detected in working '
3297
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3299
except StrictCommitFailed:
3300
raise errors.BzrCommandError("Commit refused because there are"
3301
" unknown files in the working tree.")
3302
except errors.BoundBranchOutOfDate, e:
3303
e.extra_help = ("\n"
3304
'To commit to master branch, run update and then commit.\n'
3305
'You can also pass --local to commit to continue working '
3310
class cmd_check(Command):
3311
__doc__ = """Validate working tree structure, branch consistency and repository history.
3313
This command checks various invariants about branch and repository storage
3314
to detect data corruption or bzr bugs.
3316
The working tree and branch checks will only give output if a problem is
3317
detected. The output fields of the repository check are:
3320
This is just the number of revisions checked. It doesn't
3324
This is just the number of versionedfiles checked. It
3325
doesn't indicate a problem.
3327
unreferenced ancestors
3328
Texts that are ancestors of other texts, but
3329
are not properly referenced by the revision ancestry. This is a
3330
subtle problem that Bazaar can work around.
3333
This is the total number of unique file contents
3334
seen in the checked revisions. It does not indicate a problem.
3337
This is the total number of repeated texts seen
3338
in the checked revisions. Texts can be repeated when their file
3339
entries are modified, but the file contents are not. It does not
3342
If no restrictions are specified, all Bazaar data that is found at the given
3343
location will be checked.
3347
Check the tree and branch at 'foo'::
3349
bzr check --tree --branch foo
3351
Check only the repository at 'bar'::
3353
bzr check --repo bar
3355
Check everything at 'baz'::
3360
_see_also = ['reconcile']
3361
takes_args = ['path?']
3362
takes_options = ['verbose',
3363
Option('branch', help="Check the branch related to the"
3364
" current directory."),
3365
Option('repo', help="Check the repository related to the"
3366
" current directory."),
3367
Option('tree', help="Check the working tree related to"
3368
" the current directory.")]
3370
def run(self, path=None, verbose=False, branch=False, repo=False,
3372
from bzrlib.check import check_dwim
3375
if not branch and not repo and not tree:
3376
branch = repo = tree = True
3377
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3380
class cmd_upgrade(Command):
3381
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3383
When the default format has changed after a major new release of
3384
Bazaar, you may be informed during certain operations that you
3385
should upgrade. Upgrading to a newer format may improve performance
3386
or make new features available. It may however limit interoperability
3387
with older repositories or with older versions of Bazaar.
3389
If you wish to upgrade to a particular format rather than the
3390
current default, that can be specified using the --format option.
3391
As a consequence, you can use the upgrade command this way to
3392
"downgrade" to an earlier format, though some conversions are
3393
a one way process (e.g. changing from the 1.x default to the
3394
2.x default) so downgrading is not always possible.
3396
A backup.bzr.~#~ directory is created at the start of the conversion
3397
process (where # is a number). By default, this is left there on
3398
completion. If the conversion fails, delete the new .bzr directory
3399
and rename this one back in its place. Use the --clean option to ask
3400
for the backup.bzr directory to be removed on successful conversion.
3401
Alternatively, you can delete it by hand if everything looks good
3404
If the location given is a shared repository, dependent branches
3405
are also converted provided the repository converts successfully.
3406
If the conversion of a branch fails, remaining branches are still
3409
For more information on upgrades, see the Bazaar Upgrade Guide,
3410
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3413
_see_also = ['check', 'reconcile', 'formats']
3414
takes_args = ['url?']
3416
RegistryOption('format',
3417
help='Upgrade to a specific format. See "bzr help'
3418
' formats" for details.',
3419
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3420
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3421
value_switches=True, title='Branch format'),
3423
help='Remove the backup.bzr directory if successful.'),
3425
help="Show what would be done, but don't actually do anything."),
3428
def run(self, url='.', format=None, clean=False, dry_run=False):
3429
from bzrlib.upgrade import upgrade
3430
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3432
if len(exceptions) == 1:
3433
# Compatibility with historical behavior
3439
class cmd_whoami(Command):
3440
__doc__ = """Show or set bzr user id.
3443
Show the email of the current user::
3447
Set the current user::
3449
bzr whoami "Frank Chu <fchu@example.com>"
3451
takes_options = [ 'directory',
3453
help='Display email address only.'),
3455
help='Set identity for the current branch instead of '
3458
takes_args = ['name?']
3459
encoding_type = 'replace'
3462
def run(self, email=False, branch=False, name=None, directory=None):
3464
if directory is None:
3465
# use branch if we're inside one; otherwise global config
3467
c = Branch.open_containing(u'.')[0].get_config()
3468
except errors.NotBranchError:
3469
c = _mod_config.GlobalConfig()
3471
c = Branch.open(directory).get_config()
3473
self.outf.write(c.user_email() + '\n')
3475
self.outf.write(c.username() + '\n')
3479
raise errors.BzrCommandError("--email can only be used to display existing "
3482
# display a warning if an email address isn't included in the given name.
3484
_mod_config.extract_email_address(name)
3485
except errors.NoEmailInUsername, e:
3486
warning('"%s" does not seem to contain an email address. '
3487
'This is allowed, but not recommended.', name)
3489
# use global config unless --branch given
3491
if directory is None:
3492
c = Branch.open_containing(u'.')[0].get_config()
3494
c = Branch.open(directory).get_config()
3496
c = _mod_config.GlobalConfig()
3497
c.set_user_option('email', name)
3500
class cmd_nick(Command):
3501
__doc__ = """Print or set the branch nickname.
3503
If unset, the tree root directory name is used as the nickname.
3504
To print the current nickname, execute with no argument.
3506
Bound branches use the nickname of its master branch unless it is set
3510
_see_also = ['info']
3511
takes_args = ['nickname?']
3512
takes_options = ['directory']
3513
def run(self, nickname=None, directory=u'.'):
3514
branch = Branch.open_containing(directory)[0]
3515
if nickname is None:
3516
self.printme(branch)
3518
branch.nick = nickname
3521
def printme(self, branch):
3522
self.outf.write('%s\n' % branch.nick)
3525
class cmd_alias(Command):
3526
__doc__ = """Set/unset and display aliases.
3529
Show the current aliases::
3533
Show the alias specified for 'll'::
3537
Set an alias for 'll'::
3539
bzr alias ll="log --line -r-10..-1"
3541
To remove an alias for 'll'::
3543
bzr alias --remove ll
3546
takes_args = ['name?']
3548
Option('remove', help='Remove the alias.'),
3551
def run(self, name=None, remove=False):
3553
self.remove_alias(name)
3555
self.print_aliases()
3557
equal_pos = name.find('=')
3559
self.print_alias(name)
3561
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3563
def remove_alias(self, alias_name):
3564
if alias_name is None:
3565
raise errors.BzrCommandError(
3566
'bzr alias --remove expects an alias to remove.')
3567
# If alias is not found, print something like:
3568
# unalias: foo: not found
3569
c = _mod_config.GlobalConfig()
3570
c.unset_alias(alias_name)
3573
def print_aliases(self):
3574
"""Print out the defined aliases in a similar format to bash."""
3575
aliases = _mod_config.GlobalConfig().get_aliases()
3576
for key, value in sorted(aliases.iteritems()):
3577
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3580
def print_alias(self, alias_name):
3581
from bzrlib.commands import get_alias
3582
alias = get_alias(alias_name)
3584
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3587
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3589
def set_alias(self, alias_name, alias_command):
3590
"""Save the alias in the global config."""
3591
c = _mod_config.GlobalConfig()
3592
c.set_alias(alias_name, alias_command)
3595
class cmd_selftest(Command):
3596
__doc__ = """Run internal test suite.
3598
If arguments are given, they are regular expressions that say which tests
3599
should run. Tests matching any expression are run, and other tests are
3602
Alternatively if --first is given, matching tests are run first and then
3603
all other tests are run. This is useful if you have been working in a
3604
particular area, but want to make sure nothing else was broken.
3606
If --exclude is given, tests that match that regular expression are
3607
excluded, regardless of whether they match --first or not.
3609
To help catch accidential dependencies between tests, the --randomize
3610
option is useful. In most cases, the argument used is the word 'now'.
3611
Note that the seed used for the random number generator is displayed
3612
when this option is used. The seed can be explicitly passed as the
3613
argument to this option if required. This enables reproduction of the
3614
actual ordering used if and when an order sensitive problem is encountered.
3616
If --list-only is given, the tests that would be run are listed. This is
3617
useful when combined with --first, --exclude and/or --randomize to
3618
understand their impact. The test harness reports "Listed nn tests in ..."
3619
instead of "Ran nn tests in ..." when list mode is enabled.
3621
If the global option '--no-plugins' is given, plugins are not loaded
3622
before running the selftests. This has two effects: features provided or
3623
modified by plugins will not be tested, and tests provided by plugins will
3626
Tests that need working space on disk use a common temporary directory,
3627
typically inside $TMPDIR or /tmp.
3629
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3630
into a pdb postmortem session.
3632
The --coverage=DIRNAME global option produces a report with covered code
3636
Run only tests relating to 'ignore'::
3640
Disable plugins and list tests as they're run::
3642
bzr --no-plugins selftest -v
3644
# NB: this is used from the class without creating an instance, which is
3645
# why it does not have a self parameter.
3646
def get_transport_type(typestring):
3647
"""Parse and return a transport specifier."""
3648
if typestring == "sftp":
3649
from bzrlib.tests import stub_sftp
3650
return stub_sftp.SFTPAbsoluteServer
3651
elif typestring == "memory":
3652
from bzrlib.tests import test_server
3653
return memory.MemoryServer
3654
elif typestring == "fakenfs":
3655
from bzrlib.tests import test_server
3656
return test_server.FakeNFSServer
3657
msg = "No known transport type %s. Supported types are: sftp\n" %\
3659
raise errors.BzrCommandError(msg)
3662
takes_args = ['testspecs*']
3663
takes_options = ['verbose',
3665
help='Stop when one test fails.',
3669
help='Use a different transport by default '
3670
'throughout the test suite.',
3671
type=get_transport_type),
3673
help='Run the benchmarks rather than selftests.',
3675
Option('lsprof-timed',
3676
help='Generate lsprof output for benchmarked'
3677
' sections of code.'),
3678
Option('lsprof-tests',
3679
help='Generate lsprof output for each test.'),
3681
help='Run all tests, but run specified tests first.',
3685
help='List the tests instead of running them.'),
3686
RegistryOption('parallel',
3687
help="Run the test suite in parallel.",
3688
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3689
value_switches=False,
3691
Option('randomize', type=str, argname="SEED",
3692
help='Randomize the order of tests using the given'
3693
' seed or "now" for the current time.'),
3694
ListOption('exclude', type=str, argname="PATTERN",
3696
help='Exclude tests that match this regular'
3699
help='Output test progress via subunit.'),
3700
Option('strict', help='Fail on missing dependencies or '
3702
Option('load-list', type=str, argname='TESTLISTFILE',
3703
help='Load a test id list from a text file.'),
3704
ListOption('debugflag', type=str, short_name='E',
3705
help='Turn on a selftest debug flag.'),
3706
ListOption('starting-with', type=str, argname='TESTID',
3707
param_name='starting_with', short_name='s',
3709
'Load only the tests starting with TESTID.'),
3711
encoding_type = 'replace'
3714
Command.__init__(self)
3715
self.additional_selftest_args = {}
3717
def run(self, testspecs_list=None, verbose=False, one=False,
3718
transport=None, benchmark=None,
3720
first=False, list_only=False,
3721
randomize=None, exclude=None, strict=False,
3722
load_list=None, debugflag=None, starting_with=None, subunit=False,
3723
parallel=None, lsprof_tests=False):
3724
from bzrlib import tests
3726
if testspecs_list is not None:
3727
pattern = '|'.join(testspecs_list)
3732
from bzrlib.tests import SubUnitBzrRunner
3734
raise errors.BzrCommandError("subunit not available. subunit "
3735
"needs to be installed to use --subunit.")
3736
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3737
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3738
# stdout, which would corrupt the subunit stream.
3739
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3740
# following code can be deleted when it's sufficiently deployed
3741
# -- vila/mgz 20100514
3742
if (sys.platform == "win32"
3743
and getattr(sys.stdout, 'fileno', None) is not None):
3745
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3747
self.additional_selftest_args.setdefault(
3748
'suite_decorators', []).append(parallel)
3750
raise errors.BzrCommandError(
3751
"--benchmark is no longer supported from bzr 2.2; "
3752
"use bzr-usertest instead")
3753
test_suite_factory = None
3755
exclude_pattern = None
3757
exclude_pattern = '(' + '|'.join(exclude) + ')'
3758
selftest_kwargs = {"verbose": verbose,
3760
"stop_on_failure": one,
3761
"transport": transport,
3762
"test_suite_factory": test_suite_factory,
3763
"lsprof_timed": lsprof_timed,
3764
"lsprof_tests": lsprof_tests,
3765
"matching_tests_first": first,
3766
"list_only": list_only,
3767
"random_seed": randomize,
3768
"exclude_pattern": exclude_pattern,
3770
"load_list": load_list,
3771
"debug_flags": debugflag,
3772
"starting_with": starting_with
3774
selftest_kwargs.update(self.additional_selftest_args)
3776
# Make deprecation warnings visible, unless -Werror is set
3777
cleanup = symbol_versioning.activate_deprecation_warnings(
3780
result = tests.selftest(**selftest_kwargs)
3783
return int(not result)
3786
class cmd_version(Command):
3787
__doc__ = """Show version of bzr."""
3789
encoding_type = 'replace'
3791
Option("short", help="Print just the version number."),
3795
def run(self, short=False):
3796
from bzrlib.version import show_version
3798
self.outf.write(bzrlib.version_string + '\n')
3800
show_version(to_file=self.outf)
3803
class cmd_rocks(Command):
3804
__doc__ = """Statement of optimism."""
3810
self.outf.write("It sure does!\n")
3813
class cmd_find_merge_base(Command):
3814
__doc__ = """Find and print a base revision for merging two branches."""
3815
# TODO: Options to specify revisions on either side, as if
3816
# merging only part of the history.
3817
takes_args = ['branch', 'other']
3821
def run(self, branch, other):
3822
from bzrlib.revision import ensure_null
3824
branch1 = Branch.open_containing(branch)[0]
3825
branch2 = Branch.open_containing(other)[0]
3826
self.add_cleanup(branch1.lock_read().unlock)
3827
self.add_cleanup(branch2.lock_read().unlock)
3828
last1 = ensure_null(branch1.last_revision())
3829
last2 = ensure_null(branch2.last_revision())
3831
graph = branch1.repository.get_graph(branch2.repository)
3832
base_rev_id = graph.find_unique_lca(last1, last2)
3834
self.outf.write('merge base is revision %s\n' % base_rev_id)
3837
class cmd_merge(Command):
3838
__doc__ = """Perform a three-way merge.
3840
The source of the merge can be specified either in the form of a branch,
3841
or in the form of a path to a file containing a merge directive generated
3842
with bzr send. If neither is specified, the default is the upstream branch
3843
or the branch most recently merged using --remember. The source of the
3844
merge may also be specified in the form of a path to a file in another
3845
branch: in this case, only the modifications to that file are merged into
3846
the current working tree.
3848
When merging from a branch, by default bzr will try to merge in all new
3849
work from the other branch, automatically determining an appropriate base
3850
revision. If this fails, you may need to give an explicit base.
3852
To pick a different ending revision, pass "--revision OTHER". bzr will
3853
try to merge in all new work up to and including revision OTHER.
3855
If you specify two values, "--revision BASE..OTHER", only revisions BASE
3856
through OTHER, excluding BASE but including OTHER, will be merged. If this
3857
causes some revisions to be skipped, i.e. if the destination branch does
3858
not already contain revision BASE, such a merge is commonly referred to as
3859
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
3860
cherrypicks. The changes look like a normal commit, and the history of the
3861
changes from the other branch is not stored in the commit.
3863
Revision numbers are always relative to the source branch.
3865
Merge will do its best to combine the changes in two branches, but there
3866
are some kinds of problems only a human can fix. When it encounters those,
3867
it will mark a conflict. A conflict means that you need to fix something,
3868
before you should commit.
3870
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3872
If there is no default branch set, the first merge will set it (use
3873
--no-remember to avoid settting it). After that, you can omit the branch
3874
to use the default. To change the default, use --remember. The value will
3875
only be saved if the remote location can be accessed.
3877
The results of the merge are placed into the destination working
3878
directory, where they can be reviewed (with bzr diff), tested, and then
3879
committed to record the result of the merge.
3881
merge refuses to run if there are any uncommitted changes, unless
3882
--force is given. If --force is given, then the changes from the source
3883
will be merged with the current working tree, including any uncommitted
3884
changes in the tree. The --force option can also be used to create a
3885
merge revision which has more than two parents.
3887
If one would like to merge changes from the working tree of the other
3888
branch without merging any committed revisions, the --uncommitted option
3891
To select only some changes to merge, use "merge -i", which will prompt
3892
you to apply each diff hunk and file change, similar to "shelve".
3895
To merge all new revisions from bzr.dev::
3897
bzr merge ../bzr.dev
3899
To merge changes up to and including revision 82 from bzr.dev::
3901
bzr merge -r 82 ../bzr.dev
3903
To merge the changes introduced by 82, without previous changes::
3905
bzr merge -r 81..82 ../bzr.dev
3907
To apply a merge directive contained in /tmp/merge::
3909
bzr merge /tmp/merge
3911
To create a merge revision with three parents from two branches
3912
feature1a and feature1b:
3914
bzr merge ../feature1a
3915
bzr merge ../feature1b --force
3916
bzr commit -m 'revision with three parents'
3919
encoding_type = 'exact'
3920
_see_also = ['update', 'remerge', 'status-flags', 'send']
3921
takes_args = ['location?']
3926
help='Merge even if the destination tree has uncommitted changes.'),
3930
Option('show-base', help="Show base revision text in "
3932
Option('uncommitted', help='Apply uncommitted changes'
3933
' from a working copy, instead of branch changes.'),
3934
Option('pull', help='If the destination is already'
3935
' completely merged into the source, pull from the'
3936
' source rather than merging. When this happens,'
3937
' you do not need to commit the result.'),
3938
custom_help('directory',
3939
help='Branch to merge into, '
3940
'rather than the one containing the working directory.'),
3941
Option('preview', help='Instead of merging, show a diff of the'
3943
Option('interactive', help='Select changes interactively.',
3947
def run(self, location=None, revision=None, force=False,
3948
merge_type=None, show_base=False, reprocess=None, remember=None,
3949
uncommitted=False, pull=False,
3954
if merge_type is None:
3955
merge_type = _mod_merge.Merge3Merger
3957
if directory is None: directory = u'.'
3958
possible_transports = []
3960
allow_pending = True
3961
verified = 'inapplicable'
3963
tree = WorkingTree.open_containing(directory)[0]
3964
if tree.branch.revno() == 0:
3965
raise errors.BzrCommandError('Merging into empty branches not currently supported, '
3966
'https://bugs.launchpad.net/bzr/+bug/308562')
3969
basis_tree = tree.revision_tree(tree.last_revision())
3970
except errors.NoSuchRevision:
3971
basis_tree = tree.basis_tree()
3973
# die as quickly as possible if there are uncommitted changes
3975
if tree.has_changes():
3976
raise errors.UncommittedChanges(tree)
3978
view_info = _get_view_info_for_change_reporter(tree)
3979
change_reporter = delta._ChangeReporter(
3980
unversioned_filter=tree.is_ignored, view_info=view_info)
3981
pb = ui.ui_factory.nested_progress_bar()
3982
self.add_cleanup(pb.finished)
3983
self.add_cleanup(tree.lock_write().unlock)
3984
if location is not None:
3986
mergeable = bundle.read_mergeable_from_url(location,
3987
possible_transports=possible_transports)
3988
except errors.NotABundle:
3992
raise errors.BzrCommandError('Cannot use --uncommitted'
3993
' with bundles or merge directives.')
3995
if revision is not None:
3996
raise errors.BzrCommandError(
3997
'Cannot use -r with merge directives or bundles')
3998
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4001
if merger is None and uncommitted:
4002
if revision is not None and len(revision) > 0:
4003
raise errors.BzrCommandError('Cannot use --uncommitted and'
4004
' --revision at the same time.')
4005
merger = self.get_merger_from_uncommitted(tree, location, None)
4006
allow_pending = False
4009
merger, allow_pending = self._get_merger_from_branch(tree,
4010
location, revision, remember, possible_transports, None)
4012
merger.merge_type = merge_type
4013
merger.reprocess = reprocess
4014
merger.show_base = show_base
4015
self.sanity_check_merger(merger)
4016
if (merger.base_rev_id == merger.other_rev_id and
4017
merger.other_rev_id is not None):
4018
# check if location is a nonexistent file (and not a branch) to
4019
# disambiguate the 'Nothing to do'
4020
if merger.interesting_files:
4021
if not merger.other_tree.has_filename(
4022
merger.interesting_files[0]):
4023
note("merger: " + str(merger))
4024
raise errors.PathsDoNotExist([location])
4025
note('Nothing to do.')
4027
if pull and not preview:
4028
if merger.interesting_files is not None:
4029
raise errors.BzrCommandError('Cannot pull individual files')
4030
if (merger.base_rev_id == tree.last_revision()):
4031
result = tree.pull(merger.other_branch, False,
4032
merger.other_rev_id)
4033
result.report(self.outf)
4035
if merger.this_basis is None:
4036
raise errors.BzrCommandError(
4037
"This branch has no commits."
4038
" (perhaps you would prefer 'bzr pull')")
4040
return self._do_preview(merger)
4042
return self._do_interactive(merger)
4044
return self._do_merge(merger, change_reporter, allow_pending,
4047
def _get_preview(self, merger):
4048
tree_merger = merger.make_merger()
4049
tt = tree_merger.make_preview_transform()
4050
self.add_cleanup(tt.finalize)
4051
result_tree = tt.get_preview_tree()
4054
def _do_preview(self, merger):
4055
from bzrlib.diff import show_diff_trees
4056
result_tree = self._get_preview(merger)
4057
path_encoding = osutils.get_diff_header_encoding()
4058
show_diff_trees(merger.this_tree, result_tree, self.outf,
4059
old_label='', new_label='',
4060
path_encoding=path_encoding)
4062
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4063
merger.change_reporter = change_reporter
4064
conflict_count = merger.do_merge()
4066
merger.set_pending()
4067
if verified == 'failed':
4068
warning('Preview patch does not match changes')
4069
if conflict_count != 0:
4074
def _do_interactive(self, merger):
4075
"""Perform an interactive merge.
4077
This works by generating a preview tree of the merge, then using
4078
Shelver to selectively remove the differences between the working tree
4079
and the preview tree.
4081
from bzrlib import shelf_ui
4082
result_tree = self._get_preview(merger)
4083
writer = bzrlib.option.diff_writer_registry.get()
4084
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4085
reporter=shelf_ui.ApplyReporter(),
4086
diff_writer=writer(sys.stdout))
4092
def sanity_check_merger(self, merger):
4093
if (merger.show_base and
4094
not merger.merge_type is _mod_merge.Merge3Merger):
4095
raise errors.BzrCommandError("Show-base is not supported for this"
4096
" merge type. %s" % merger.merge_type)
4097
if merger.reprocess is None:
4098
if merger.show_base:
4099
merger.reprocess = False
4101
# Use reprocess if the merger supports it
4102
merger.reprocess = merger.merge_type.supports_reprocess
4103
if merger.reprocess and not merger.merge_type.supports_reprocess:
4104
raise errors.BzrCommandError("Conflict reduction is not supported"
4105
" for merge type %s." %
4107
if merger.reprocess and merger.show_base:
4108
raise errors.BzrCommandError("Cannot do conflict reduction and"
4111
def _get_merger_from_branch(self, tree, location, revision, remember,
4112
possible_transports, pb):
4113
"""Produce a merger from a location, assuming it refers to a branch."""
4114
from bzrlib.tag import _merge_tags_if_possible
4115
# find the branch locations
4116
other_loc, user_location = self._select_branch_location(tree, location,
4118
if revision is not None and len(revision) == 2:
4119
base_loc, _unused = self._select_branch_location(tree,
4120
location, revision, 0)
4122
base_loc = other_loc
4124
other_branch, other_path = Branch.open_containing(other_loc,
4125
possible_transports)
4126
if base_loc == other_loc:
4127
base_branch = other_branch
4129
base_branch, base_path = Branch.open_containing(base_loc,
4130
possible_transports)
4131
# Find the revision ids
4132
other_revision_id = None
4133
base_revision_id = None
4134
if revision is not None:
4135
if len(revision) >= 1:
4136
other_revision_id = revision[-1].as_revision_id(other_branch)
4137
if len(revision) == 2:
4138
base_revision_id = revision[0].as_revision_id(base_branch)
4139
if other_revision_id is None:
4140
other_revision_id = _mod_revision.ensure_null(
4141
other_branch.last_revision())
4142
# Remember where we merge from. We need to remember if:
4143
# - user specify a location (and we don't merge from the parent
4145
# - user ask to remember or there is no previous location set to merge
4146
# from and user didn't ask to *not* remember
4147
if (user_location is not None
4149
or (remember is None
4150
and tree.branch.get_submit_branch() is None)))):
4151
tree.branch.set_submit_branch(other_branch.base)
4152
# Merge tags (but don't set them in the master branch yet, the user
4153
# might revert this merge). Commit will propagate them.
4154
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4155
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4156
other_revision_id, base_revision_id, other_branch, base_branch)
4157
if other_path != '':
4158
allow_pending = False
4159
merger.interesting_files = [other_path]
4161
allow_pending = True
4162
return merger, allow_pending
4164
def get_merger_from_uncommitted(self, tree, location, pb):
4165
"""Get a merger for uncommitted changes.
4167
:param tree: The tree the merger should apply to.
4168
:param location: The location containing uncommitted changes.
4169
:param pb: The progress bar to use for showing progress.
4171
location = self._select_branch_location(tree, location)[0]
4172
other_tree, other_path = WorkingTree.open_containing(location)
4173
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4174
if other_path != '':
4175
merger.interesting_files = [other_path]
4178
def _select_branch_location(self, tree, user_location, revision=None,
4180
"""Select a branch location, according to possible inputs.
4182
If provided, branches from ``revision`` are preferred. (Both
4183
``revision`` and ``index`` must be supplied.)
4185
Otherwise, the ``location`` parameter is used. If it is None, then the
4186
``submit`` or ``parent`` location is used, and a note is printed.
4188
:param tree: The working tree to select a branch for merging into
4189
:param location: The location entered by the user
4190
:param revision: The revision parameter to the command
4191
:param index: The index to use for the revision parameter. Negative
4192
indices are permitted.
4193
:return: (selected_location, user_location). The default location
4194
will be the user-entered location.
4196
if (revision is not None and index is not None
4197
and revision[index] is not None):
4198
branch = revision[index].get_branch()
4199
if branch is not None:
4200
return branch, branch
4201
if user_location is None:
4202
location = self._get_remembered(tree, 'Merging from')
4204
location = user_location
4205
return location, user_location
4207
def _get_remembered(self, tree, verb_string):
4208
"""Use tree.branch's parent if none was supplied.
4210
Report if the remembered location was used.
4212
stored_location = tree.branch.get_submit_branch()
4213
stored_location_type = "submit"
4214
if stored_location is None:
4215
stored_location = tree.branch.get_parent()
4216
stored_location_type = "parent"
4217
mutter("%s", stored_location)
4218
if stored_location is None:
4219
raise errors.BzrCommandError("No location specified or remembered")
4220
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4221
note(u"%s remembered %s location %s", verb_string,
4222
stored_location_type, display_url)
4223
return stored_location
4226
class cmd_remerge(Command):
4227
__doc__ = """Redo a merge.
4229
Use this if you want to try a different merge technique while resolving
4230
conflicts. Some merge techniques are better than others, and remerge
4231
lets you try different ones on different files.
4233
The options for remerge have the same meaning and defaults as the ones for
4234
merge. The difference is that remerge can (only) be run when there is a
4235
pending merge, and it lets you specify particular files.
4238
Re-do the merge of all conflicted files, and show the base text in
4239
conflict regions, in addition to the usual THIS and OTHER texts::
4241
bzr remerge --show-base
4243
Re-do the merge of "foobar", using the weave merge algorithm, with
4244
additional processing to reduce the size of conflict regions::
4246
bzr remerge --merge-type weave --reprocess foobar
4248
takes_args = ['file*']
4253
help="Show base revision text in conflicts."),
4256
def run(self, file_list=None, merge_type=None, show_base=False,
4258
from bzrlib.conflicts import restore
4259
if merge_type is None:
4260
merge_type = _mod_merge.Merge3Merger
4261
tree, file_list = WorkingTree.open_containing_paths(file_list)
4262
self.add_cleanup(tree.lock_write().unlock)
4263
parents = tree.get_parent_ids()
4264
if len(parents) != 2:
4265
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4266
" merges. Not cherrypicking or"
4268
repository = tree.branch.repository
4269
interesting_ids = None
4271
conflicts = tree.conflicts()
4272
if file_list is not None:
4273
interesting_ids = set()
4274
for filename in file_list:
4275
file_id = tree.path2id(filename)
4277
raise errors.NotVersionedError(filename)
4278
interesting_ids.add(file_id)
4279
if tree.kind(file_id) != "directory":
4282
for name, ie in tree.inventory.iter_entries(file_id):
4283
interesting_ids.add(ie.file_id)
4284
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4286
# Remerge only supports resolving contents conflicts
4287
allowed_conflicts = ('text conflict', 'contents conflict')
4288
restore_files = [c.path for c in conflicts
4289
if c.typestring in allowed_conflicts]
4290
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4291
tree.set_conflicts(ConflictList(new_conflicts))
4292
if file_list is not None:
4293
restore_files = file_list
4294
for filename in restore_files:
4296
restore(tree.abspath(filename))
4297
except errors.NotConflicted:
4299
# Disable pending merges, because the file texts we are remerging
4300
# have not had those merges performed. If we use the wrong parents
4301
# list, we imply that the working tree text has seen and rejected
4302
# all the changes from the other tree, when in fact those changes
4303
# have not yet been seen.
4304
tree.set_parent_ids(parents[:1])
4306
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4307
merger.interesting_ids = interesting_ids
4308
merger.merge_type = merge_type
4309
merger.show_base = show_base
4310
merger.reprocess = reprocess
4311
conflicts = merger.do_merge()
4313
tree.set_parent_ids(parents)
4320
class cmd_revert(Command):
4321
__doc__ = """Revert files to a previous revision.
4323
Giving a list of files will revert only those files. Otherwise, all files
4324
will be reverted. If the revision is not specified with '--revision', the
4325
last committed revision is used.
4327
To remove only some changes, without reverting to a prior version, use
4328
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4329
will remove the changes introduced by the second last commit (-2), without
4330
affecting the changes introduced by the last commit (-1). To remove
4331
certain changes on a hunk-by-hunk basis, see the shelve command.
4333
By default, any files that have been manually changed will be backed up
4334
first. (Files changed only by merge are not backed up.) Backup files have
4335
'.~#~' appended to their name, where # is a number.
4337
When you provide files, you can use their current pathname or the pathname
4338
from the target revision. So you can use revert to "undelete" a file by
4339
name. If you name a directory, all the contents of that directory will be
4342
If you have newly added files since the target revision, they will be
4343
removed. If the files to be removed have been changed, backups will be
4344
created as above. Directories containing unknown files will not be
4347
The working tree contains a list of revisions that have been merged but
4348
not yet committed. These revisions will be included as additional parents
4349
of the next commit. Normally, using revert clears that list as well as
4350
reverting the files. If any files are specified, revert leaves the list
4351
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4352
.`` in the tree root to revert all files but keep the recorded merges,
4353
and ``bzr revert --forget-merges`` to clear the pending merge list without
4354
reverting any files.
4356
Using "bzr revert --forget-merges", it is possible to apply all of the
4357
changes from a branch in a single revision. To do this, perform the merge
4358
as desired. Then doing revert with the "--forget-merges" option will keep
4359
the content of the tree as it was, but it will clear the list of pending
4360
merges. The next commit will then contain all of the changes that are
4361
present in the other branch, but without any other parent revisions.
4362
Because this technique forgets where these changes originated, it may
4363
cause additional conflicts on later merges involving the same source and
4367
_see_also = ['cat', 'export', 'merge', 'shelve']
4370
Option('no-backup', "Do not save backups of reverted files."),
4371
Option('forget-merges',
4372
'Remove pending merge marker, without changing any files.'),
4374
takes_args = ['file*']
4376
def run(self, revision=None, no_backup=False, file_list=None,
4377
forget_merges=None):
4378
tree, file_list = WorkingTree.open_containing_paths(file_list)
4379
self.add_cleanup(tree.lock_tree_write().unlock)
4381
tree.set_parent_ids(tree.get_parent_ids()[:1])
4383
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4386
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4387
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4388
tree.revert(file_list, rev_tree, not no_backup, None,
4389
report_changes=True)
4392
class cmd_assert_fail(Command):
4393
__doc__ = """Test reporting of assertion failures"""
4394
# intended just for use in testing
4399
raise AssertionError("always fails")
4402
class cmd_help(Command):
4403
__doc__ = """Show help on a command or other topic.
4406
_see_also = ['topics']
4408
Option('long', 'Show help on all commands.'),
4410
takes_args = ['topic?']
4411
aliases = ['?', '--help', '-?', '-h']
4414
def run(self, topic=None, long=False):
4416
if topic is None and long:
4418
bzrlib.help.help(topic)
4421
class cmd_shell_complete(Command):
4422
__doc__ = """Show appropriate completions for context.
4424
For a list of all available commands, say 'bzr shell-complete'.
4426
takes_args = ['context?']
4431
def run(self, context=None):
4432
import shellcomplete
4433
shellcomplete.shellcomplete(context)
4436
class cmd_missing(Command):
4437
__doc__ = """Show unmerged/unpulled revisions between two branches.
4439
OTHER_BRANCH may be local or remote.
4441
To filter on a range of revisions, you can use the command -r begin..end
4442
-r revision requests a specific revision, -r ..end or -r begin.. are
4446
1 - some missing revisions
4447
0 - no missing revisions
4451
Determine the missing revisions between this and the branch at the
4452
remembered pull location::
4456
Determine the missing revisions between this and another branch::
4458
bzr missing http://server/branch
4460
Determine the missing revisions up to a specific revision on the other
4463
bzr missing -r ..-10
4465
Determine the missing revisions up to a specific revision on this
4468
bzr missing --my-revision ..-10
4471
_see_also = ['merge', 'pull']
4472
takes_args = ['other_branch?']
4475
Option('reverse', 'Reverse the order of revisions.'),
4477
'Display changes in the local branch only.'),
4478
Option('this' , 'Same as --mine-only.'),
4479
Option('theirs-only',
4480
'Display changes in the remote branch only.'),
4481
Option('other', 'Same as --theirs-only.'),
4485
custom_help('revision',
4486
help='Filter on other branch revisions (inclusive). '
4487
'See "help revisionspec" for details.'),
4488
Option('my-revision',
4489
type=_parse_revision_str,
4490
help='Filter on local branch revisions (inclusive). '
4491
'See "help revisionspec" for details.'),
4492
Option('include-merges',
4493
'Show all revisions in addition to the mainline ones.'),
4495
encoding_type = 'replace'
4498
def run(self, other_branch=None, reverse=False, mine_only=False,
4500
log_format=None, long=False, short=False, line=False,
4501
show_ids=False, verbose=False, this=False, other=False,
4502
include_merges=False, revision=None, my_revision=None,
4504
from bzrlib.missing import find_unmerged, iter_log_revisions
4513
# TODO: We should probably check that we don't have mine-only and
4514
# theirs-only set, but it gets complicated because we also have
4515
# this and other which could be used.
4522
local_branch = Branch.open_containing(directory)[0]
4523
self.add_cleanup(local_branch.lock_read().unlock)
4525
parent = local_branch.get_parent()
4526
if other_branch is None:
4527
other_branch = parent
4528
if other_branch is None:
4529
raise errors.BzrCommandError("No peer location known"
4531
display_url = urlutils.unescape_for_display(parent,
4533
message("Using saved parent location: "
4534
+ display_url + "\n")
4536
remote_branch = Branch.open(other_branch)
4537
if remote_branch.base == local_branch.base:
4538
remote_branch = local_branch
4540
self.add_cleanup(remote_branch.lock_read().unlock)
4542
local_revid_range = _revision_range_to_revid_range(
4543
_get_revision_range(my_revision, local_branch,
4546
remote_revid_range = _revision_range_to_revid_range(
4547
_get_revision_range(revision,
4548
remote_branch, self.name()))
4550
local_extra, remote_extra = find_unmerged(
4551
local_branch, remote_branch, restrict,
4552
backward=not reverse,
4553
include_merges=include_merges,
4554
local_revid_range=local_revid_range,
4555
remote_revid_range=remote_revid_range)
4557
if log_format is None:
4558
registry = log.log_formatter_registry
4559
log_format = registry.get_default(local_branch)
4560
lf = log_format(to_file=self.outf,
4562
show_timezone='original')
4565
if local_extra and not theirs_only:
4566
message("You have %d extra revision(s):\n" %
4568
for revision in iter_log_revisions(local_extra,
4569
local_branch.repository,
4571
lf.log_revision(revision)
4572
printed_local = True
4575
printed_local = False
4577
if remote_extra and not mine_only:
4578
if printed_local is True:
4580
message("You are missing %d revision(s):\n" %
4582
for revision in iter_log_revisions(remote_extra,
4583
remote_branch.repository,
4585
lf.log_revision(revision)
4588
if mine_only and not local_extra:
4589
# We checked local, and found nothing extra
4590
message('This branch is up to date.\n')
4591
elif theirs_only and not remote_extra:
4592
# We checked remote, and found nothing extra
4593
message('Other branch is up to date.\n')
4594
elif not (mine_only or theirs_only or local_extra or
4596
# We checked both branches, and neither one had extra
4598
message("Branches are up to date.\n")
4600
if not status_code and parent is None and other_branch is not None:
4601
self.add_cleanup(local_branch.lock_write().unlock)
4602
# handle race conditions - a parent might be set while we run.
4603
if local_branch.get_parent() is None:
4604
local_branch.set_parent(remote_branch.base)
4608
class cmd_pack(Command):
4609
__doc__ = """Compress the data within a repository.
4611
This operation compresses the data within a bazaar repository. As
4612
bazaar supports automatic packing of repository, this operation is
4613
normally not required to be done manually.
4615
During the pack operation, bazaar takes a backup of existing repository
4616
data, i.e. pack files. This backup is eventually removed by bazaar
4617
automatically when it is safe to do so. To save disk space by removing
4618
the backed up pack files, the --clean-obsolete-packs option may be
4621
Warning: If you use --clean-obsolete-packs and your machine crashes
4622
during or immediately after repacking, you may be left with a state
4623
where the deletion has been written to disk but the new packs have not
4624
been. In this case the repository may be unusable.
4627
_see_also = ['repositories']
4628
takes_args = ['branch_or_repo?']
4630
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4633
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4634
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4636
branch = dir.open_branch()
4637
repository = branch.repository
4638
except errors.NotBranchError:
4639
repository = dir.open_repository()
4640
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4643
class cmd_plugins(Command):
4644
__doc__ = """List the installed plugins.
4646
This command displays the list of installed plugins including
4647
version of plugin and a short description of each.
4649
--verbose shows the path where each plugin is located.
4651
A plugin is an external component for Bazaar that extends the
4652
revision control system, by adding or replacing code in Bazaar.
4653
Plugins can do a variety of things, including overriding commands,
4654
adding new commands, providing additional network transports and
4655
customizing log output.
4657
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4658
for further information on plugins including where to find them and how to
4659
install them. Instructions are also provided there on how to write new
4660
plugins using the Python programming language.
4662
takes_options = ['verbose']
4665
def run(self, verbose=False):
4666
from bzrlib import plugin
4667
# Don't give writelines a generator as some codecs don't like that
4668
self.outf.writelines(
4669
list(plugin.describe_plugins(show_paths=verbose)))
4672
class cmd_testament(Command):
4673
__doc__ = """Show testament (signing-form) of a revision."""
4676
Option('long', help='Produce long-format testament.'),
4678
help='Produce a strict-format testament.')]
4679
takes_args = ['branch?']
4681
def run(self, branch=u'.', revision=None, long=False, strict=False):
4682
from bzrlib.testament import Testament, StrictTestament
4684
testament_class = StrictTestament
4686
testament_class = Testament
4688
b = Branch.open_containing(branch)[0]
4690
b = Branch.open(branch)
4691
self.add_cleanup(b.lock_read().unlock)
4692
if revision is None:
4693
rev_id = b.last_revision()
4695
rev_id = revision[0].as_revision_id(b)
4696
t = testament_class.from_revision(b.repository, rev_id)
4698
sys.stdout.writelines(t.as_text_lines())
4700
sys.stdout.write(t.as_short_text())
4703
class cmd_annotate(Command):
4704
__doc__ = """Show the origin of each line in a file.
4706
This prints out the given file with an annotation on the left side
4707
indicating which revision, author and date introduced the change.
4709
If the origin is the same for a run of consecutive lines, it is
4710
shown only at the top, unless the --all option is given.
4712
# TODO: annotate directories; showing when each file was last changed
4713
# TODO: if the working copy is modified, show annotations on that
4714
# with new uncommitted lines marked
4715
aliases = ['ann', 'blame', 'praise']
4716
takes_args = ['filename']
4717
takes_options = [Option('all', help='Show annotations on all lines.'),
4718
Option('long', help='Show commit date in annotations.'),
4723
encoding_type = 'exact'
4726
def run(self, filename, all=False, long=False, revision=None,
4727
show_ids=False, directory=None):
4728
from bzrlib.annotate import (
4731
wt, branch, relpath = \
4732
_open_directory_or_containing_tree_or_branch(filename, directory)
4734
self.add_cleanup(wt.lock_read().unlock)
4736
self.add_cleanup(branch.lock_read().unlock)
4737
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4738
self.add_cleanup(tree.lock_read().unlock)
4739
if wt is not None and revision is None:
4740
file_id = wt.path2id(relpath)
4742
file_id = tree.path2id(relpath)
4744
raise errors.NotVersionedError(filename)
4745
if wt is not None and revision is None:
4746
# If there is a tree and we're not annotating historical
4747
# versions, annotate the working tree's content.
4748
annotate_file_tree(wt, file_id, self.outf, long, all,
4751
annotate_file_tree(tree, file_id, self.outf, long, all,
4752
show_ids=show_ids, branch=branch)
4755
class cmd_re_sign(Command):
4756
__doc__ = """Create a digital signature for an existing revision."""
4757
# TODO be able to replace existing ones.
4759
hidden = True # is this right ?
4760
takes_args = ['revision_id*']
4761
takes_options = ['directory', 'revision']
4763
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4764
if revision_id_list is not None and revision is not None:
4765
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4766
if revision_id_list is None and revision is None:
4767
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4768
b = WorkingTree.open_containing(directory)[0].branch
4769
self.add_cleanup(b.lock_write().unlock)
4770
return self._run(b, revision_id_list, revision)
4772
def _run(self, b, revision_id_list, revision):
4773
import bzrlib.gpg as gpg
4774
gpg_strategy = gpg.GPGStrategy(b.get_config())
4775
if revision_id_list is not None:
4776
b.repository.start_write_group()
4778
for revision_id in revision_id_list:
4779
b.repository.sign_revision(revision_id, gpg_strategy)
4781
b.repository.abort_write_group()
4784
b.repository.commit_write_group()
4785
elif revision is not None:
4786
if len(revision) == 1:
4787
revno, rev_id = revision[0].in_history(b)
4788
b.repository.start_write_group()
4790
b.repository.sign_revision(rev_id, gpg_strategy)
4792
b.repository.abort_write_group()
4795
b.repository.commit_write_group()
4796
elif len(revision) == 2:
4797
# are they both on rh- if so we can walk between them
4798
# might be nice to have a range helper for arbitrary
4799
# revision paths. hmm.
4800
from_revno, from_revid = revision[0].in_history(b)
4801
to_revno, to_revid = revision[1].in_history(b)
4802
if to_revid is None:
4803
to_revno = b.revno()
4804
if from_revno is None or to_revno is None:
4805
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4806
b.repository.start_write_group()
4808
for revno in range(from_revno, to_revno + 1):
4809
b.repository.sign_revision(b.get_rev_id(revno),
4812
b.repository.abort_write_group()
4815
b.repository.commit_write_group()
4817
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4820
class cmd_bind(Command):
4821
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4822
If no branch is supplied, rebind to the last bound location.
4824
Once converted into a checkout, commits must succeed on the master branch
4825
before they will be applied to the local branch.
4827
Bound branches use the nickname of its master branch unless it is set
4828
locally, in which case binding will update the local nickname to be
4832
_see_also = ['checkouts', 'unbind']
4833
takes_args = ['location?']
4834
takes_options = ['directory']
4836
def run(self, location=None, directory=u'.'):
4837
b, relpath = Branch.open_containing(directory)
4838
if location is None:
4840
location = b.get_old_bound_location()
4841
except errors.UpgradeRequired:
4842
raise errors.BzrCommandError('No location supplied. '
4843
'This format does not remember old locations.')
4845
if location is None:
4846
if b.get_bound_location() is not None:
4847
raise errors.BzrCommandError('Branch is already bound')
4849
raise errors.BzrCommandError('No location supplied '
4850
'and no previous location known')
4851
b_other = Branch.open(location)
4854
except errors.DivergedBranches:
4855
raise errors.BzrCommandError('These branches have diverged.'
4856
' Try merging, and then bind again.')
4857
if b.get_config().has_explicit_nickname():
4858
b.nick = b_other.nick
4861
class cmd_unbind(Command):
4862
__doc__ = """Convert the current checkout into a regular branch.
4864
After unbinding, the local branch is considered independent and subsequent
4865
commits will be local only.
4868
_see_also = ['checkouts', 'bind']
4870
takes_options = ['directory']
4872
def run(self, directory=u'.'):
4873
b, relpath = Branch.open_containing(directory)
4875
raise errors.BzrCommandError('Local branch is not bound')
4878
class cmd_uncommit(Command):
4879
__doc__ = """Remove the last committed revision.
4881
--verbose will print out what is being removed.
4882
--dry-run will go through all the motions, but not actually
4885
If --revision is specified, uncommit revisions to leave the branch at the
4886
specified revision. For example, "bzr uncommit -r 15" will leave the
4887
branch at revision 15.
4889
Uncommit leaves the working tree ready for a new commit. The only change
4890
it may make is to restore any pending merges that were present before
4894
# TODO: jam 20060108 Add an option to allow uncommit to remove
4895
# unreferenced information in 'branch-as-repository' branches.
4896
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4897
# information in shared branches as well.
4898
_see_also = ['commit']
4899
takes_options = ['verbose', 'revision',
4900
Option('dry-run', help='Don\'t actually make changes.'),
4901
Option('force', help='Say yes to all questions.'),
4903
help="Only remove the commits from the local branch"
4904
" when in a checkout."
4907
takes_args = ['location?']
4909
encoding_type = 'replace'
4911
def run(self, location=None,
4912
dry_run=False, verbose=False,
4913
revision=None, force=False, local=False):
4914
if location is None:
4916
control, relpath = bzrdir.BzrDir.open_containing(location)
4918
tree = control.open_workingtree()
4920
except (errors.NoWorkingTree, errors.NotLocalUrl):
4922
b = control.open_branch()
4924
if tree is not None:
4925
self.add_cleanup(tree.lock_write().unlock)
4927
self.add_cleanup(b.lock_write().unlock)
4928
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4930
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4931
from bzrlib.log import log_formatter, show_log
4932
from bzrlib.uncommit import uncommit
4934
last_revno, last_rev_id = b.last_revision_info()
4937
if revision is None:
4939
rev_id = last_rev_id
4941
# 'bzr uncommit -r 10' actually means uncommit
4942
# so that the final tree is at revno 10.
4943
# but bzrlib.uncommit.uncommit() actually uncommits
4944
# the revisions that are supplied.
4945
# So we need to offset it by one
4946
revno = revision[0].in_history(b).revno + 1
4947
if revno <= last_revno:
4948
rev_id = b.get_rev_id(revno)
4950
if rev_id is None or _mod_revision.is_null(rev_id):
4951
self.outf.write('No revisions to uncommit.\n')
4954
lf = log_formatter('short',
4956
show_timezone='original')
4961
direction='forward',
4962
start_revision=revno,
4963
end_revision=last_revno)
4966
self.outf.write('Dry-run, pretending to remove'
4967
' the above revisions.\n')
4969
self.outf.write('The above revision(s) will be removed.\n')
4972
if not ui.ui_factory.confirm_action(
4973
u'Uncommit these revisions',
4974
'bzrlib.builtins.uncommit',
4976
self.outf.write('Canceled\n')
4979
mutter('Uncommitting from {%s} to {%s}',
4980
last_rev_id, rev_id)
4981
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4982
revno=revno, local=local)
4983
self.outf.write('You can restore the old tip by running:\n'
4984
' bzr pull . -r revid:%s\n' % last_rev_id)
4987
class cmd_break_lock(Command):
4988
__doc__ = """Break a dead lock.
4990
This command breaks a lock on a repository, branch, working directory or
4993
CAUTION: Locks should only be broken when you are sure that the process
4994
holding the lock has been stopped.
4996
You can get information on what locks are open via the 'bzr info
4997
[location]' command.
5001
bzr break-lock bzr+ssh://example.com/bzr/foo
5002
bzr break-lock --conf ~/.bazaar
5005
takes_args = ['location?']
5008
help='LOCATION is the directory where the config lock is.'),
5010
help='Do not ask for confirmation before breaking the lock.'),
5013
def run(self, location=None, config=False, force=False):
5014
if location is None:
5017
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5019
{'bzrlib.lockdir.break': True})
5021
conf = _mod_config.LockableConfig(file_name=location)
5024
control, relpath = bzrdir.BzrDir.open_containing(location)
5026
control.break_lock()
5027
except NotImplementedError:
5031
class cmd_wait_until_signalled(Command):
5032
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5034
This just prints a line to signal when it is ready, then blocks on stdin.
5040
sys.stdout.write("running\n")
5042
sys.stdin.readline()
5045
class cmd_serve(Command):
5046
__doc__ = """Run the bzr server."""
5048
aliases = ['server']
5052
help='Serve on stdin/out for use from inetd or sshd.'),
5053
RegistryOption('protocol',
5054
help="Protocol to serve.",
5055
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5056
value_switches=True),
5058
help='Listen for connections on nominated port of the form '
5059
'[hostname:]portnumber. Passing 0 as the port number will '
5060
'result in a dynamically allocated port. The default port '
5061
'depends on the protocol.',
5063
custom_help('directory',
5064
help='Serve contents of this directory.'),
5065
Option('allow-writes',
5066
help='By default the server is a readonly server. Supplying '
5067
'--allow-writes enables write access to the contents of '
5068
'the served directory and below. Note that ``bzr serve`` '
5069
'does not perform authentication, so unless some form of '
5070
'external authentication is arranged supplying this '
5071
'option leads to global uncontrolled write access to your '
5076
def get_host_and_port(self, port):
5077
"""Return the host and port to run the smart server on.
5079
If 'port' is None, None will be returned for the host and port.
5081
If 'port' has a colon in it, the string before the colon will be
5082
interpreted as the host.
5084
:param port: A string of the port to run the server on.
5085
:return: A tuple of (host, port), where 'host' is a host name or IP,
5086
and port is an integer TCP/IP port.
5089
if port is not None:
5091
host, port = port.split(':')
5095
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5097
from bzrlib import transport
5098
if directory is None:
5099
directory = os.getcwd()
5100
if protocol is None:
5101
protocol = transport.transport_server_registry.get()
5102
host, port = self.get_host_and_port(port)
5103
url = urlutils.local_path_to_url(directory)
5104
if not allow_writes:
5105
url = 'readonly+' + url
5106
t = transport.get_transport(url)
5107
protocol(t, host, port, inet)
5110
class cmd_join(Command):
5111
__doc__ = """Combine a tree into its containing tree.
5113
This command requires the target tree to be in a rich-root format.
5115
The TREE argument should be an independent tree, inside another tree, but
5116
not part of it. (Such trees can be produced by "bzr split", but also by
5117
running "bzr branch" with the target inside a tree.)
5119
The result is a combined tree, with the subtree no longer an independent
5120
part. This is marked as a merge of the subtree into the containing tree,
5121
and all history is preserved.
5124
_see_also = ['split']
5125
takes_args = ['tree']
5127
Option('reference', help='Join by reference.', hidden=True),
5130
def run(self, tree, reference=False):
5131
sub_tree = WorkingTree.open(tree)
5132
parent_dir = osutils.dirname(sub_tree.basedir)
5133
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5134
repo = containing_tree.branch.repository
5135
if not repo.supports_rich_root():
5136
raise errors.BzrCommandError(
5137
"Can't join trees because %s doesn't support rich root data.\n"
5138
"You can use bzr upgrade on the repository."
5142
containing_tree.add_reference(sub_tree)
5143
except errors.BadReferenceTarget, e:
5144
# XXX: Would be better to just raise a nicely printable
5145
# exception from the real origin. Also below. mbp 20070306
5146
raise errors.BzrCommandError("Cannot join %s. %s" %
5150
containing_tree.subsume(sub_tree)
5151
except errors.BadSubsumeSource, e:
5152
raise errors.BzrCommandError("Cannot join %s. %s" %
5156
class cmd_split(Command):
5157
__doc__ = """Split a subdirectory of a tree into a separate tree.
5159
This command will produce a target tree in a format that supports
5160
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5161
converted into earlier formats like 'dirstate-tags'.
5163
The TREE argument should be a subdirectory of a working tree. That
5164
subdirectory will be converted into an independent tree, with its own
5165
branch. Commits in the top-level tree will not apply to the new subtree.
5168
_see_also = ['join']
5169
takes_args = ['tree']
5171
def run(self, tree):
5172
containing_tree, subdir = WorkingTree.open_containing(tree)
5173
sub_id = containing_tree.path2id(subdir)
5175
raise errors.NotVersionedError(subdir)
5177
containing_tree.extract(sub_id)
5178
except errors.RootNotRich:
5179
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5182
class cmd_merge_directive(Command):
5183
__doc__ = """Generate a merge directive for auto-merge tools.
5185
A directive requests a merge to be performed, and also provides all the
5186
information necessary to do so. This means it must either include a
5187
revision bundle, or the location of a branch containing the desired
5190
A submit branch (the location to merge into) must be supplied the first
5191
time the command is issued. After it has been supplied once, it will
5192
be remembered as the default.
5194
A public branch is optional if a revision bundle is supplied, but required
5195
if --diff or --plain is specified. It will be remembered as the default
5196
after the first use.
5199
takes_args = ['submit_branch?', 'public_branch?']
5203
_see_also = ['send']
5207
RegistryOption.from_kwargs('patch-type',
5208
'The type of patch to include in the directive.',
5210
value_switches=True,
5212
bundle='Bazaar revision bundle (default).',
5213
diff='Normal unified diff.',
5214
plain='No patch, just directive.'),
5215
Option('sign', help='GPG-sign the directive.'), 'revision',
5216
Option('mail-to', type=str,
5217
help='Instead of printing the directive, email to this address.'),
5218
Option('message', type=str, short_name='m',
5219
help='Message to use when committing this merge.')
5222
encoding_type = 'exact'
5224
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5225
sign=False, revision=None, mail_to=None, message=None,
5227
from bzrlib.revision import ensure_null, NULL_REVISION
5228
include_patch, include_bundle = {
5229
'plain': (False, False),
5230
'diff': (True, False),
5231
'bundle': (True, True),
5233
branch = Branch.open(directory)
5234
stored_submit_branch = branch.get_submit_branch()
5235
if submit_branch is None:
5236
submit_branch = stored_submit_branch
5238
if stored_submit_branch is None:
5239
branch.set_submit_branch(submit_branch)
5240
if submit_branch is None:
5241
submit_branch = branch.get_parent()
5242
if submit_branch is None:
5243
raise errors.BzrCommandError('No submit branch specified or known')
5245
stored_public_branch = branch.get_public_branch()
5246
if public_branch is None:
5247
public_branch = stored_public_branch
5248
elif stored_public_branch is None:
5249
branch.set_public_branch(public_branch)
5250
if not include_bundle and public_branch is None:
5251
raise errors.BzrCommandError('No public branch specified or'
5253
base_revision_id = None
5254
if revision is not None:
5255
if len(revision) > 2:
5256
raise errors.BzrCommandError('bzr merge-directive takes '
5257
'at most two one revision identifiers')
5258
revision_id = revision[-1].as_revision_id(branch)
5259
if len(revision) == 2:
5260
base_revision_id = revision[0].as_revision_id(branch)
5262
revision_id = branch.last_revision()
5263
revision_id = ensure_null(revision_id)
5264
if revision_id == NULL_REVISION:
5265
raise errors.BzrCommandError('No revisions to bundle.')
5266
directive = merge_directive.MergeDirective2.from_objects(
5267
branch.repository, revision_id, time.time(),
5268
osutils.local_time_offset(), submit_branch,
5269
public_branch=public_branch, include_patch=include_patch,
5270
include_bundle=include_bundle, message=message,
5271
base_revision_id=base_revision_id)
5274
self.outf.write(directive.to_signed(branch))
5276
self.outf.writelines(directive.to_lines())
5278
message = directive.to_email(mail_to, branch, sign)
5279
s = SMTPConnection(branch.get_config())
5280
s.send_email(message)
5283
class cmd_send(Command):
5284
__doc__ = """Mail or create a merge-directive for submitting changes.
5286
A merge directive provides many things needed for requesting merges:
5288
* A machine-readable description of the merge to perform
5290
* An optional patch that is a preview of the changes requested
5292
* An optional bundle of revision data, so that the changes can be applied
5293
directly from the merge directive, without retrieving data from a
5296
`bzr send` creates a compact data set that, when applied using bzr
5297
merge, has the same effect as merging from the source branch.
5299
By default the merge directive is self-contained and can be applied to any
5300
branch containing submit_branch in its ancestory without needing access to
5303
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5304
revisions, but only a structured request to merge from the
5305
public_location. In that case the public_branch is needed and it must be
5306
up-to-date and accessible to the recipient. The public_branch is always
5307
included if known, so that people can check it later.
5309
The submit branch defaults to the parent of the source branch, but can be
5310
overridden. Both submit branch and public branch will be remembered in
5311
branch.conf the first time they are used for a particular branch. The
5312
source branch defaults to that containing the working directory, but can
5313
be changed using --from.
5315
Both the submit branch and the public branch follow the usual behavior with
5316
respect to --remember: If there is no default location set, the first send
5317
will set it (use --no-remember to avoid settting it). After that, you can
5318
omit the location to use the default. To change the default, use
5319
--remember. The value will only be saved if the location can be accessed.
5321
In order to calculate those changes, bzr must analyse the submit branch.
5322
Therefore it is most efficient for the submit branch to be a local mirror.
5323
If a public location is known for the submit_branch, that location is used
5324
in the merge directive.
5326
The default behaviour is to send the merge directive by mail, unless -o is
5327
given, in which case it is sent to a file.
5329
Mail is sent using your preferred mail program. This should be transparent
5330
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5331
If the preferred client can't be found (or used), your editor will be used.
5333
To use a specific mail program, set the mail_client configuration option.
5334
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5335
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5336
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5337
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5340
If mail is being sent, a to address is required. This can be supplied
5341
either on the commandline, by setting the submit_to configuration
5342
option in the branch itself or the child_submit_to configuration option
5343
in the submit branch.
5345
Two formats are currently supported: "4" uses revision bundle format 4 and
5346
merge directive format 2. It is significantly faster and smaller than
5347
older formats. It is compatible with Bazaar 0.19 and later. It is the
5348
default. "0.9" uses revision bundle format 0.9 and merge directive
5349
format 1. It is compatible with Bazaar 0.12 - 0.18.
5351
The merge directives created by bzr send may be applied using bzr merge or
5352
bzr pull by specifying a file containing a merge directive as the location.
5354
bzr send makes extensive use of public locations to map local locations into
5355
URLs that can be used by other people. See `bzr help configuration` to
5356
set them, and use `bzr info` to display them.
5359
encoding_type = 'exact'
5361
_see_also = ['merge', 'pull']
5363
takes_args = ['submit_branch?', 'public_branch?']
5367
help='Do not include a bundle in the merge directive.'),
5368
Option('no-patch', help='Do not include a preview patch in the merge'
5371
help='Remember submit and public branch.'),
5373
help='Branch to generate the submission from, '
5374
'rather than the one containing the working directory.',
5377
Option('output', short_name='o',
5378
help='Write merge directive to this file or directory; '
5379
'use - for stdout.',
5382
help='Refuse to send if there are uncommitted changes in'
5383
' the working tree, --no-strict disables the check.'),
5384
Option('mail-to', help='Mail the request to this address.',
5388
Option('body', help='Body for the email.', type=unicode),
5389
RegistryOption('format',
5390
help='Use the specified output format.',
5391
lazy_registry=('bzrlib.send', 'format_registry')),
5394
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5395
no_patch=False, revision=None, remember=None, output=None,
5396
format=None, mail_to=None, message=None, body=None,
5397
strict=None, **kwargs):
5398
from bzrlib.send import send
5399
return send(submit_branch, revision, public_branch, remember,
5400
format, no_bundle, no_patch, output,
5401
kwargs.get('from', '.'), mail_to, message, body,
5406
class cmd_bundle_revisions(cmd_send):
5407
__doc__ = """Create a merge-directive for submitting changes.
5409
A merge directive provides many things needed for requesting merges:
5411
* A machine-readable description of the merge to perform
5413
* An optional patch that is a preview of the changes requested
5415
* An optional bundle of revision data, so that the changes can be applied
5416
directly from the merge directive, without retrieving data from a
5419
If --no-bundle is specified, then public_branch is needed (and must be
5420
up-to-date), so that the receiver can perform the merge using the
5421
public_branch. The public_branch is always included if known, so that
5422
people can check it later.
5424
The submit branch defaults to the parent, but can be overridden. Both
5425
submit branch and public branch will be remembered if supplied.
5427
If a public_branch is known for the submit_branch, that public submit
5428
branch is used in the merge instructions. This means that a local mirror
5429
can be used as your actual submit branch, once you have set public_branch
5432
Two formats are currently supported: "4" uses revision bundle format 4 and
5433
merge directive format 2. It is significantly faster and smaller than
5434
older formats. It is compatible with Bazaar 0.19 and later. It is the
5435
default. "0.9" uses revision bundle format 0.9 and merge directive
5436
format 1. It is compatible with Bazaar 0.12 - 0.18.
5441
help='Do not include a bundle in the merge directive.'),
5442
Option('no-patch', help='Do not include a preview patch in the merge'
5445
help='Remember submit and public branch.'),
5447
help='Branch to generate the submission from, '
5448
'rather than the one containing the working directory.',
5451
Option('output', short_name='o', help='Write directive to this file.',
5454
help='Refuse to bundle revisions if there are uncommitted'
5455
' changes in the working tree, --no-strict disables the check.'),
5457
RegistryOption('format',
5458
help='Use the specified output format.',
5459
lazy_registry=('bzrlib.send', 'format_registry')),
5461
aliases = ['bundle']
5463
_see_also = ['send', 'merge']
5467
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5468
no_patch=False, revision=None, remember=False, output=None,
5469
format=None, strict=None, **kwargs):
5472
from bzrlib.send import send
5473
return send(submit_branch, revision, public_branch, remember,
5474
format, no_bundle, no_patch, output,
5475
kwargs.get('from', '.'), None, None, None,
5476
self.outf, strict=strict)
5479
class cmd_tag(Command):
5480
__doc__ = """Create, remove or modify a tag naming a revision.
5482
Tags give human-meaningful names to revisions. Commands that take a -r
5483
(--revision) option can be given -rtag:X, where X is any previously
5486
Tags are stored in the branch. Tags are copied from one branch to another
5487
along when you branch, push, pull or merge.
5489
It is an error to give a tag name that already exists unless you pass
5490
--force, in which case the tag is moved to point to the new revision.
5492
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5493
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5495
If no tag name is specified it will be determined through the
5496
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5497
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5501
_see_also = ['commit', 'tags']
5502
takes_args = ['tag_name?']
5505
help='Delete this tag rather than placing it.',
5507
custom_help('directory',
5508
help='Branch in which to place the tag.'),
5510
help='Replace existing tags.',
5515
def run(self, tag_name=None,
5521
branch, relpath = Branch.open_containing(directory)
5522
self.add_cleanup(branch.lock_write().unlock)
5524
if tag_name is None:
5525
raise errors.BzrCommandError("No tag specified to delete.")
5526
branch.tags.delete_tag(tag_name)
5527
note('Deleted tag %s.' % tag_name)
5530
if len(revision) != 1:
5531
raise errors.BzrCommandError(
5532
"Tags can only be placed on a single revision, "
5534
revision_id = revision[0].as_revision_id(branch)
5536
revision_id = branch.last_revision()
5537
if tag_name is None:
5538
tag_name = branch.automatic_tag_name(revision_id)
5539
if tag_name is None:
5540
raise errors.BzrCommandError(
5541
"Please specify a tag name.")
5542
if (not force) and branch.tags.has_tag(tag_name):
5543
raise errors.TagAlreadyExists(tag_name)
5544
branch.tags.set_tag(tag_name, revision_id)
5545
note('Created tag %s.' % tag_name)
5548
class cmd_tags(Command):
5549
__doc__ = """List tags.
5551
This command shows a table of tag names and the revisions they reference.
5556
custom_help('directory',
5557
help='Branch whose tags should be displayed.'),
5558
RegistryOption('sort',
5559
'Sort tags by different criteria.', title='Sorting',
5560
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5567
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5568
from bzrlib.tag import tag_sort_methods
5569
branch, relpath = Branch.open_containing(directory)
5571
tags = branch.tags.get_tag_dict().items()
5575
self.add_cleanup(branch.lock_read().unlock)
5577
graph = branch.repository.get_graph()
5578
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5579
revid1, revid2 = rev1.rev_id, rev2.rev_id
5580
# only show revisions between revid1 and revid2 (inclusive)
5581
tags = [(tag, revid) for tag, revid in tags if
5582
graph.is_between(revid, revid1, revid2)]
5584
sort = tag_sort_methods.get()
5587
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5588
for index, (tag, revid) in enumerate(tags):
5590
revno = branch.revision_id_to_dotted_revno(revid)
5591
if isinstance(revno, tuple):
5592
revno = '.'.join(map(str, revno))
5593
except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
5594
# Bad tag data/merges can lead to tagged revisions
5595
# which are not in this branch. Fail gracefully ...
5597
tags[index] = (tag, revno)
5599
for tag, revspec in tags:
5600
self.outf.write('%-20s %s\n' % (tag, revspec))
5603
class cmd_reconfigure(Command):
5604
__doc__ = """Reconfigure the type of a bzr directory.
5606
A target configuration must be specified.
5608
For checkouts, the bind-to location will be auto-detected if not specified.
5609
The order of preference is
5610
1. For a lightweight checkout, the current bound location.
5611
2. For branches that used to be checkouts, the previously-bound location.
5612
3. The push location.
5613
4. The parent location.
5614
If none of these is available, --bind-to must be specified.
5617
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5618
takes_args = ['location?']
5620
RegistryOption.from_kwargs(
5622
title='Target type',
5623
help='The type to reconfigure the directory to.',
5624
value_switches=True, enum_switch=False,
5625
branch='Reconfigure to be an unbound branch with no working tree.',
5626
tree='Reconfigure to be an unbound branch with a working tree.',
5627
checkout='Reconfigure to be a bound branch with a working tree.',
5628
lightweight_checkout='Reconfigure to be a lightweight'
5629
' checkout (with no local history).',
5630
standalone='Reconfigure to be a standalone branch '
5631
'(i.e. stop using shared repository).',
5632
use_shared='Reconfigure to use a shared repository.',
5633
with_trees='Reconfigure repository to create '
5634
'working trees on branches by default.',
5635
with_no_trees='Reconfigure repository to not create '
5636
'working trees on branches by default.'
5638
Option('bind-to', help='Branch to bind checkout to.', type=str),
5640
help='Perform reconfiguration even if local changes'
5642
Option('stacked-on',
5643
help='Reconfigure a branch to be stacked on another branch.',
5647
help='Reconfigure a branch to be unstacked. This '
5648
'may require copying substantial data into it.',
5652
def run(self, location=None, target_type=None, bind_to=None, force=False,
5655
directory = bzrdir.BzrDir.open(location)
5656
if stacked_on and unstacked:
5657
raise errors.BzrCommandError("Can't use both --stacked-on and --unstacked")
5658
elif stacked_on is not None:
5659
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5661
reconfigure.ReconfigureUnstacked().apply(directory)
5662
# At the moment you can use --stacked-on and a different
5663
# reconfiguration shape at the same time; there seems no good reason
5665
if target_type is None:
5666
if stacked_on or unstacked:
5669
raise errors.BzrCommandError('No target configuration '
5671
elif target_type == 'branch':
5672
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5673
elif target_type == 'tree':
5674
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5675
elif target_type == 'checkout':
5676
reconfiguration = reconfigure.Reconfigure.to_checkout(
5678
elif target_type == 'lightweight-checkout':
5679
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5681
elif target_type == 'use-shared':
5682
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5683
elif target_type == 'standalone':
5684
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5685
elif target_type == 'with-trees':
5686
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5688
elif target_type == 'with-no-trees':
5689
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5691
reconfiguration.apply(force)
5694
class cmd_switch(Command):
5695
__doc__ = """Set the branch of a checkout and update.
5697
For lightweight checkouts, this changes the branch being referenced.
5698
For heavyweight checkouts, this checks that there are no local commits
5699
versus the current bound branch, then it makes the local branch a mirror
5700
of the new location and binds to it.
5702
In both cases, the working tree is updated and uncommitted changes
5703
are merged. The user can commit or revert these as they desire.
5705
Pending merges need to be committed or reverted before using switch.
5707
The path to the branch to switch to can be specified relative to the parent
5708
directory of the current branch. For example, if you are currently in a
5709
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5712
Bound branches use the nickname of its master branch unless it is set
5713
locally, in which case switching will update the local nickname to be
5717
takes_args = ['to_location?']
5718
takes_options = ['directory',
5720
help='Switch even if local commits will be lost.'),
5722
Option('create-branch', short_name='b',
5723
help='Create the target branch from this one before'
5724
' switching to it.'),
5727
def run(self, to_location=None, force=False, create_branch=False,
5728
revision=None, directory=u'.'):
5729
from bzrlib import switch
5730
tree_location = directory
5731
revision = _get_one_revision('switch', revision)
5732
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5733
if to_location is None:
5734
if revision is None:
5735
raise errors.BzrCommandError('You must supply either a'
5736
' revision or a location')
5737
to_location = tree_location
5739
branch = control_dir.open_branch()
5740
had_explicit_nick = branch.get_config().has_explicit_nickname()
5741
except errors.NotBranchError:
5743
had_explicit_nick = False
5746
raise errors.BzrCommandError('cannot create branch without'
5748
to_location = directory_service.directories.dereference(
5750
if '/' not in to_location and '\\' not in to_location:
5751
# This path is meant to be relative to the existing branch
5752
this_url = self._get_branch_location(control_dir)
5753
to_location = urlutils.join(this_url, '..', to_location)
5754
to_branch = branch.bzrdir.sprout(to_location,
5755
possible_transports=[branch.bzrdir.root_transport],
5756
source_branch=branch).open_branch()
5759
to_branch = Branch.open(to_location)
5760
except errors.NotBranchError:
5761
this_url = self._get_branch_location(control_dir)
5762
to_branch = Branch.open(
5763
urlutils.join(this_url, '..', to_location))
5764
if revision is not None:
5765
revision = revision.as_revision_id(to_branch)
5766
switch.switch(control_dir, to_branch, force, revision_id=revision)
5767
if had_explicit_nick:
5768
branch = control_dir.open_branch() #get the new branch!
5769
branch.nick = to_branch.nick
5770
note('Switched to branch: %s',
5771
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5773
def _get_branch_location(self, control_dir):
5774
"""Return location of branch for this control dir."""
5776
this_branch = control_dir.open_branch()
5777
# This may be a heavy checkout, where we want the master branch
5778
master_location = this_branch.get_bound_location()
5779
if master_location is not None:
5780
return master_location
5781
# If not, use a local sibling
5782
return this_branch.base
5783
except errors.NotBranchError:
5784
format = control_dir.find_branch_format()
5785
if getattr(format, 'get_reference', None) is not None:
5786
return format.get_reference(control_dir)
5788
return control_dir.root_transport.base
5791
class cmd_view(Command):
5792
__doc__ = """Manage filtered views.
5794
Views provide a mask over the tree so that users can focus on
5795
a subset of a tree when doing their work. After creating a view,
5796
commands that support a list of files - status, diff, commit, etc -
5797
effectively have that list of files implicitly given each time.
5798
An explicit list of files can still be given but those files
5799
must be within the current view.
5801
In most cases, a view has a short life-span: it is created to make
5802
a selected change and is deleted once that change is committed.
5803
At other times, you may wish to create one or more named views
5804
and switch between them.
5806
To disable the current view without deleting it, you can switch to
5807
the pseudo view called ``off``. This can be useful when you need
5808
to see the whole tree for an operation or two (e.g. merge) but
5809
want to switch back to your view after that.
5812
To define the current view::
5814
bzr view file1 dir1 ...
5816
To list the current view::
5820
To delete the current view::
5824
To disable the current view without deleting it::
5826
bzr view --switch off
5828
To define a named view and switch to it::
5830
bzr view --name view-name file1 dir1 ...
5832
To list a named view::
5834
bzr view --name view-name
5836
To delete a named view::
5838
bzr view --name view-name --delete
5840
To switch to a named view::
5842
bzr view --switch view-name
5844
To list all views defined::
5848
To delete all views::
5850
bzr view --delete --all
5854
takes_args = ['file*']
5857
help='Apply list or delete action to all views.',
5860
help='Delete the view.',
5863
help='Name of the view to define, list or delete.',
5867
help='Name of the view to switch to.',
5872
def run(self, file_list,
5878
tree, file_list = WorkingTree.open_containing_paths(file_list,
5880
current_view, view_dict = tree.views.get_view_info()
5885
raise errors.BzrCommandError(
5886
"Both --delete and a file list specified")
5888
raise errors.BzrCommandError(
5889
"Both --delete and --switch specified")
5891
tree.views.set_view_info(None, {})
5892
self.outf.write("Deleted all views.\n")
5894
raise errors.BzrCommandError("No current view to delete")
5896
tree.views.delete_view(name)
5897
self.outf.write("Deleted '%s' view.\n" % name)
5900
raise errors.BzrCommandError(
5901
"Both --switch and a file list specified")
5903
raise errors.BzrCommandError(
5904
"Both --switch and --all specified")
5905
elif switch == 'off':
5906
if current_view is None:
5907
raise errors.BzrCommandError("No current view to disable")
5908
tree.views.set_view_info(None, view_dict)
5909
self.outf.write("Disabled '%s' view.\n" % (current_view))
5911
tree.views.set_view_info(switch, view_dict)
5912
view_str = views.view_display_str(tree.views.lookup_view())
5913
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5916
self.outf.write('Views defined:\n')
5917
for view in sorted(view_dict):
5918
if view == current_view:
5922
view_str = views.view_display_str(view_dict[view])
5923
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5925
self.outf.write('No views defined.\n')
5928
# No name given and no current view set
5931
raise errors.BzrCommandError(
5932
"Cannot change the 'off' pseudo view")
5933
tree.views.set_view(name, sorted(file_list))
5934
view_str = views.view_display_str(tree.views.lookup_view())
5935
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5939
# No name given and no current view set
5940
self.outf.write('No current view.\n')
5942
view_str = views.view_display_str(tree.views.lookup_view(name))
5943
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5946
class cmd_hooks(Command):
5947
__doc__ = """Show hooks."""
5952
for hook_key in sorted(hooks.known_hooks.keys()):
5953
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5954
self.outf.write("%s:\n" % type(some_hooks).__name__)
5955
for hook_name, hook_point in sorted(some_hooks.items()):
5956
self.outf.write(" %s:\n" % (hook_name,))
5957
found_hooks = list(hook_point)
5959
for hook in found_hooks:
5960
self.outf.write(" %s\n" %
5961
(some_hooks.get_hook_name(hook),))
5963
self.outf.write(" <no hooks installed>\n")
5966
class cmd_remove_branch(Command):
5967
__doc__ = """Remove a branch.
5969
This will remove the branch from the specified location but
5970
will keep any working tree or repository in place.
5974
Remove the branch at repo/trunk::
5976
bzr remove-branch repo/trunk
5980
takes_args = ["location?"]
5982
aliases = ["rmbranch"]
5984
def run(self, location=None):
5985
if location is None:
5987
branch = Branch.open_containing(location)[0]
5988
branch.bzrdir.destroy_branch()
5991
class cmd_shelve(Command):
5992
__doc__ = """Temporarily set aside some changes from the current tree.
5994
Shelve allows you to temporarily put changes you've made "on the shelf",
5995
ie. out of the way, until a later time when you can bring them back from
5996
the shelf with the 'unshelve' command. The changes are stored alongside
5997
your working tree, and so they aren't propagated along with your branch nor
5998
will they survive its deletion.
6000
If shelve --list is specified, previously-shelved changes are listed.
6002
Shelve is intended to help separate several sets of changes that have
6003
been inappropriately mingled. If you just want to get rid of all changes
6004
and you don't need to restore them later, use revert. If you want to
6005
shelve all text changes at once, use shelve --all.
6007
If filenames are specified, only the changes to those files will be
6008
shelved. Other files will be left untouched.
6010
If a revision is specified, changes since that revision will be shelved.
6012
You can put multiple items on the shelf, and by default, 'unshelve' will
6013
restore the most recently shelved changes.
6015
For complicated changes, it is possible to edit the changes in a separate
6016
editor program to decide what the file remaining in the working copy
6017
should look like. To do this, add the configuration option
6019
change_editor = PROGRAM @new_path @old_path
6021
where @new_path is replaced with the path of the new version of the
6022
file and @old_path is replaced with the path of the old version of
6023
the file. The PROGRAM should save the new file with the desired
6024
contents of the file in the working tree.
6028
takes_args = ['file*']
6033
Option('all', help='Shelve all changes.'),
6035
RegistryOption('writer', 'Method to use for writing diffs.',
6036
bzrlib.option.diff_writer_registry,
6037
value_switches=True, enum_switch=False),
6039
Option('list', help='List shelved changes.'),
6041
help='Destroy removed changes instead of shelving them.'),
6043
_see_also = ['unshelve', 'configuration']
6045
def run(self, revision=None, all=False, file_list=None, message=None,
6046
writer=None, list=False, destroy=False, directory=None):
6048
return self.run_for_list(directory=directory)
6049
from bzrlib.shelf_ui import Shelver
6051
writer = bzrlib.option.diff_writer_registry.get()
6053
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6054
file_list, message, destroy=destroy, directory=directory)
6059
except errors.UserAbort:
6062
def run_for_list(self, directory=None):
6063
if directory is None:
6065
tree = WorkingTree.open_containing(directory)[0]
6066
self.add_cleanup(tree.lock_read().unlock)
6067
manager = tree.get_shelf_manager()
6068
shelves = manager.active_shelves()
6069
if len(shelves) == 0:
6070
note('No shelved changes.')
6072
for shelf_id in reversed(shelves):
6073
message = manager.get_metadata(shelf_id).get('message')
6075
message = '<no message>'
6076
self.outf.write('%3d: %s\n' % (shelf_id, message))
6080
class cmd_unshelve(Command):
6081
__doc__ = """Restore shelved changes.
6083
By default, the most recently shelved changes are restored. However if you
6084
specify a shelf by id those changes will be restored instead. This works
6085
best when the changes don't depend on each other.
6088
takes_args = ['shelf_id?']
6091
RegistryOption.from_kwargs(
6092
'action', help="The action to perform.",
6093
enum_switch=False, value_switches=True,
6094
apply="Apply changes and remove from the shelf.",
6095
dry_run="Show changes, but do not apply or remove them.",
6096
preview="Instead of unshelving the changes, show the diff that "
6097
"would result from unshelving.",
6098
delete_only="Delete changes without applying them.",
6099
keep="Apply changes but don't delete them.",
6102
_see_also = ['shelve']
6104
def run(self, shelf_id=None, action='apply', directory=u'.'):
6105
from bzrlib.shelf_ui import Unshelver
6106
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6110
unshelver.tree.unlock()
6113
class cmd_clean_tree(Command):
6114
__doc__ = """Remove unwanted files from working tree.
6116
By default, only unknown files, not ignored files, are deleted. Versioned
6117
files are never deleted.
6119
Another class is 'detritus', which includes files emitted by bzr during
6120
normal operations and selftests. (The value of these files decreases with
6123
If no options are specified, unknown files are deleted. Otherwise, option
6124
flags are respected, and may be combined.
6126
To check what clean-tree will do, use --dry-run.
6128
takes_options = ['directory',
6129
Option('ignored', help='Delete all ignored files.'),
6130
Option('detritus', help='Delete conflict files, merge and revert'
6131
' backups, and failed selftest dirs.'),
6133
help='Delete files unknown to bzr (default).'),
6134
Option('dry-run', help='Show files to delete instead of'
6136
Option('force', help='Do not prompt before deleting.')]
6137
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6138
force=False, directory=u'.'):
6139
from bzrlib.clean_tree import clean_tree
6140
if not (unknown or ignored or detritus):
6144
clean_tree(directory, unknown=unknown, ignored=ignored,
6145
detritus=detritus, dry_run=dry_run, no_prompt=force)
6148
class cmd_reference(Command):
6149
__doc__ = """list, view and set branch locations for nested trees.
6151
If no arguments are provided, lists the branch locations for nested trees.
6152
If one argument is provided, display the branch location for that tree.
6153
If two arguments are provided, set the branch location for that tree.
6158
takes_args = ['path?', 'location?']
6160
def run(self, path=None, location=None):
6162
if path is not None:
6164
tree, branch, relpath =(
6165
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
6166
if path is not None:
6169
tree = branch.basis_tree()
6171
info = branch._get_all_reference_info().iteritems()
6172
self._display_reference_info(tree, branch, info)
6174
file_id = tree.path2id(path)
6176
raise errors.NotVersionedError(path)
6177
if location is None:
6178
info = [(file_id, branch.get_reference_info(file_id))]
6179
self._display_reference_info(tree, branch, info)
6181
branch.set_reference_info(file_id, path, location)
6183
def _display_reference_info(self, tree, branch, info):
6185
for file_id, (path, location) in info:
6187
path = tree.id2path(file_id)
6188
except errors.NoSuchId:
6190
ref_list.append((path, location))
6191
for path, location in sorted(ref_list):
6192
self.outf.write('%s %s\n' % (path, location))
6195
class cmd_export_pot(Command):
6196
__doc__ = """Export command helps and error messages in po format."""
6201
from bzrlib.export_pot import export_pot
6202
export_pot(self.outf)
6205
def _register_lazy_builtins():
6206
# register lazy builtins from other modules; called at startup and should
6207
# be only called once.
6208
for (name, aliases, module_name) in [
6209
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6210
('cmd_config', [], 'bzrlib.config'),
6211
('cmd_dpush', [], 'bzrlib.foreign'),
6212
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6213
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6214
('cmd_conflicts', [], 'bzrlib.conflicts'),
6215
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6216
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6218
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
