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,
54
from bzrlib.branch import Branch
55
from bzrlib.conflicts import ConflictList
56
from bzrlib.transport import memory
57
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
from bzrlib.smtp_connection import SMTPConnection
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import (
64
builtin_command_registry,
67
from bzrlib.option import (
74
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
77
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
80
return internal_tree_files(file_list, default_branch, canonicalize,
84
def tree_files_for_add(file_list):
86
Return a tree and list of absolute paths from a file list.
88
Similar to tree_files, but add handles files a bit differently, so it a
89
custom implementation. In particular, MutableTreeTree.smart_add expects
90
absolute paths, which it immediately converts to relative paths.
92
# FIXME Would be nice to just return the relative paths like
93
# internal_tree_files does, but there are a large number of unit tests
94
# that assume the current interface to mutabletree.smart_add
96
tree, relpath = WorkingTree.open_containing(file_list[0])
97
if tree.supports_views():
98
view_files = tree.views.lookup_view()
100
for filename in file_list:
101
if not osutils.is_inside_any(view_files, filename):
102
raise errors.FileOutsideView(filename, view_files)
103
file_list = file_list[:]
104
file_list[0] = tree.abspath(relpath)
106
tree = WorkingTree.open_containing(u'.')[0]
107
if tree.supports_views():
108
view_files = tree.views.lookup_view()
110
file_list = view_files
111
view_str = views.view_display_str(view_files)
112
note("Ignoring files outside view. View is %s" % view_str)
113
return tree, file_list
116
def _get_one_revision(command_name, revisions):
117
if revisions is None:
119
if len(revisions) != 1:
120
raise errors.BzrCommandError(
121
'bzr %s --revision takes exactly one revision identifier' % (
126
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
127
"""Get a revision tree. Not suitable for commands that change the tree.
129
Specifically, the basis tree in dirstate trees is coupled to the dirstate
130
and doing a commit/uncommit/pull will at best fail due to changing the
133
If tree is passed in, it should be already locked, for lifetime management
134
of the trees internal cached state.
138
if revisions is None:
140
rev_tree = tree.basis_tree()
142
rev_tree = branch.basis_tree()
144
revision = _get_one_revision(command_name, revisions)
145
rev_tree = revision.as_tree(branch)
149
# XXX: Bad function name; should possibly also be a class method of
150
# WorkingTree rather than a function.
151
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
152
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
154
"""Convert command-line paths to a WorkingTree and relative paths.
156
Deprecated: use WorkingTree.open_containing_paths instead.
158
This is typically used for command-line processors that take one or
159
more filenames, and infer the workingtree that contains them.
161
The filenames given are not required to exist.
163
:param file_list: Filenames to convert.
165
:param default_branch: Fallback tree path to use if file_list is empty or
168
:param apply_view: if True and a view is set, apply it or check that
169
specified files are within it
171
:return: workingtree, [relative_paths]
173
return WorkingTree.open_containing_paths(
174
file_list, default_directory='.',
179
def _get_view_info_for_change_reporter(tree):
180
"""Get the view information from a tree for change reporting."""
183
current_view = tree.views.get_view_info()[0]
184
if current_view is not None:
185
view_info = (current_view, tree.views.lookup_view())
186
except errors.ViewsNotSupported:
191
def _open_directory_or_containing_tree_or_branch(filename, directory):
192
"""Open the tree or branch containing the specified file, unless
193
the --directory option is used to specify a different branch."""
194
if directory is not None:
195
return (None, Branch.open(directory), filename)
196
return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
199
# TODO: Make sure no commands unconditionally use the working directory as a
200
# branch. If a filename argument is used, the first of them should be used to
201
# specify the branch. (Perhaps this can be factored out into some kind of
202
# Argument class, representing a file in a branch, where the first occurrence
205
class cmd_status(Command):
206
__doc__ = """Display status summary.
208
This reports on versioned and unknown files, reporting them
209
grouped by state. Possible states are:
212
Versioned in the working copy but not in the previous revision.
215
Versioned in the previous revision but removed or deleted
219
Path of this file changed from the previous revision;
220
the text may also have changed. This includes files whose
221
parent directory was renamed.
224
Text has changed since the previous revision.
227
File kind has been changed (e.g. from file to directory).
230
Not versioned and not matching an ignore pattern.
232
Additionally for directories, symlinks and files with an executable
233
bit, Bazaar indicates their type using a trailing character: '/', '@'
236
To see ignored files use 'bzr ignored'. For details on the
237
changes to file texts, use 'bzr diff'.
239
Note that --short or -S gives status flags for each item, similar
240
to Subversion's status command. To get output similar to svn -q,
243
If no arguments are specified, the status of the entire working
244
directory is shown. Otherwise, only the status of the specified
245
files or directories is reported. If a directory is given, status
246
is reported for everything inside that directory.
248
Before merges are committed, the pending merge tip revisions are
249
shown. To see all pending merge revisions, use the -v option.
250
To skip the display of pending merge information altogether, use
251
the no-pending option or specify a file/directory.
253
To compare the working directory to a specific revision, pass a
254
single revision to the revision argument.
256
To see which files have changed in a specific revision, or between
257
two revisions, pass a revision range to the revision argument.
258
This will produce the same results as calling 'bzr diff --summarize'.
261
# TODO: --no-recurse, --recurse options
263
takes_args = ['file*']
264
takes_options = ['show-ids', 'revision', 'change', 'verbose',
265
Option('short', help='Use short status indicators.',
267
Option('versioned', help='Only show versioned files.',
269
Option('no-pending', help='Don\'t show pending merges.',
272
aliases = ['st', 'stat']
274
encoding_type = 'replace'
275
_see_also = ['diff', 'revert', 'status-flags']
278
def run(self, show_ids=False, file_list=None, revision=None, short=False,
279
versioned=False, no_pending=False, verbose=False):
280
from bzrlib.status import show_tree_status
282
if revision and len(revision) > 2:
283
raise errors.BzrCommandError('bzr status --revision takes exactly'
284
' one or two revision specifiers')
286
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
287
# Avoid asking for specific files when that is not needed.
288
if relfile_list == ['']:
290
# Don't disable pending merges for full trees other than '.'.
291
if file_list == ['.']:
293
# A specific path within a tree was given.
294
elif relfile_list is not None:
296
show_tree_status(tree, show_ids=show_ids,
297
specific_files=relfile_list, revision=revision,
298
to_file=self.outf, short=short, versioned=versioned,
299
show_pending=(not no_pending), verbose=verbose)
302
class cmd_cat_revision(Command):
303
__doc__ = """Write out metadata for a revision.
305
The revision to print can either be specified by a specific
306
revision identifier, or you can use --revision.
310
takes_args = ['revision_id?']
311
takes_options = ['directory', 'revision']
312
# cat-revision is more for frontends so should be exact
315
def print_revision(self, revisions, revid):
316
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
317
record = stream.next()
318
if record.storage_kind == 'absent':
319
raise errors.NoSuchRevision(revisions, revid)
320
revtext = record.get_bytes_as('fulltext')
321
self.outf.write(revtext.decode('utf-8'))
324
def run(self, revision_id=None, revision=None, directory=u'.'):
325
if revision_id is not None and revision is not None:
326
raise errors.BzrCommandError('You can only supply one of'
327
' revision_id or --revision')
328
if revision_id is None and revision is None:
329
raise errors.BzrCommandError('You must supply either'
330
' --revision or a revision_id')
332
b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
334
revisions = b.repository.revisions
335
if revisions is None:
336
raise errors.BzrCommandError('Repository %r does not support '
337
'access to raw revision texts')
339
b.repository.lock_read()
341
# TODO: jam 20060112 should cat-revision always output utf-8?
342
if revision_id is not None:
343
revision_id = osutils.safe_revision_id(revision_id, warn=False)
345
self.print_revision(revisions, revision_id)
346
except errors.NoSuchRevision:
347
msg = "The repository %s contains no revision %s." % (
348
b.repository.base, revision_id)
349
raise errors.BzrCommandError(msg)
350
elif revision is not None:
353
raise errors.BzrCommandError(
354
'You cannot specify a NULL revision.')
355
rev_id = rev.as_revision_id(b)
356
self.print_revision(revisions, rev_id)
358
b.repository.unlock()
361
class cmd_dump_btree(Command):
362
__doc__ = """Dump the contents of a btree index file to stdout.
364
PATH is a btree index file, it can be any URL. This includes things like
365
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
367
By default, the tuples stored in the index file will be displayed. With
368
--raw, we will uncompress the pages, but otherwise display the raw bytes
372
# TODO: Do we want to dump the internal nodes as well?
373
# TODO: It would be nice to be able to dump the un-parsed information,
374
# rather than only going through iter_all_entries. However, this is
375
# good enough for a start
377
encoding_type = 'exact'
378
takes_args = ['path']
379
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
380
' rather than the parsed tuples.'),
383
def run(self, path, raw=False):
384
dirname, basename = osutils.split(path)
385
t = transport.get_transport(dirname)
387
self._dump_raw_bytes(t, basename)
389
self._dump_entries(t, basename)
391
def _get_index_and_bytes(self, trans, basename):
392
"""Create a BTreeGraphIndex and raw bytes."""
393
bt = btree_index.BTreeGraphIndex(trans, basename, None)
394
bytes = trans.get_bytes(basename)
395
bt._file = cStringIO.StringIO(bytes)
396
bt._size = len(bytes)
399
def _dump_raw_bytes(self, trans, basename):
402
# We need to parse at least the root node.
403
# This is because the first page of every row starts with an
404
# uncompressed header.
405
bt, bytes = self._get_index_and_bytes(trans, basename)
406
for page_idx, page_start in enumerate(xrange(0, len(bytes),
407
btree_index._PAGE_SIZE)):
408
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
409
page_bytes = bytes[page_start:page_end]
411
self.outf.write('Root node:\n')
412
header_end, data = bt._parse_header_from_bytes(page_bytes)
413
self.outf.write(page_bytes[:header_end])
415
self.outf.write('\nPage %d\n' % (page_idx,))
416
if len(page_bytes) == 0:
417
self.outf.write('(empty)\n');
419
decomp_bytes = zlib.decompress(page_bytes)
420
self.outf.write(decomp_bytes)
421
self.outf.write('\n')
423
def _dump_entries(self, trans, basename):
425
st = trans.stat(basename)
426
except errors.TransportNotPossible:
427
# We can't stat, so we'll fake it because we have to do the 'get()'
429
bt, _ = self._get_index_and_bytes(trans, basename)
431
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
432
for node in bt.iter_all_entries():
433
# Node is made up of:
434
# (index, key, value, [references])
438
refs_as_tuples = None
440
refs_as_tuples = static_tuple.as_tuples(refs)
441
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
442
self.outf.write('%s\n' % (as_tuple,))
445
class cmd_remove_tree(Command):
446
__doc__ = """Remove the working tree from a given branch/checkout.
448
Since a lightweight checkout is little more than a working tree
449
this will refuse to run against one.
451
To re-create the working tree, use "bzr checkout".
453
_see_also = ['checkout', 'working-trees']
454
takes_args = ['location*']
457
help='Remove the working tree even if it has '
458
'uncommitted or shelved changes.'),
461
def run(self, location_list, force=False):
462
if not location_list:
465
for location in location_list:
466
d = bzrdir.BzrDir.open(location)
469
working = d.open_workingtree()
470
except errors.NoWorkingTree:
471
raise errors.BzrCommandError("No working tree to remove")
472
except errors.NotLocalUrl:
473
raise errors.BzrCommandError("You cannot remove the working tree"
476
if (working.has_changes()):
477
raise errors.UncommittedChanges(working)
478
if working.get_shelf_manager().last_shelf() is not None:
479
raise errors.ShelvedChanges(working)
481
if working.user_url != working.branch.user_url:
482
raise errors.BzrCommandError("You cannot remove the working tree"
483
" from a lightweight checkout")
485
d.destroy_workingtree()
488
class cmd_repair_workingtree(Command):
489
__doc__ = """Reset the working tree state file.
491
This is not meant to be used normally, but more as a way to recover from
492
filesystem corruption, etc. This rebuilds the working inventory back to a
493
'known good' state. Any new modifications (adding a file, renaming, etc)
494
will be lost, though modified files will still be detected as such.
496
Most users will want something more like "bzr revert" or "bzr update"
497
unless the state file has become corrupted.
499
By default this attempts to recover the current state by looking at the
500
headers of the state file. If the state file is too corrupted to even do
501
that, you can supply --revision to force the state of the tree.
504
takes_options = ['revision', 'directory',
506
help='Reset the tree even if it doesn\'t appear to be'
511
def run(self, revision=None, directory='.', force=False):
512
tree, _ = WorkingTree.open_containing(directory)
513
self.add_cleanup(tree.lock_tree_write().unlock)
517
except errors.BzrError:
518
pass # There seems to be a real error here, so we'll reset
521
raise errors.BzrCommandError(
522
'The tree does not appear to be corrupt. You probably'
523
' want "bzr revert" instead. Use "--force" if you are'
524
' sure you want to reset the working tree.')
528
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
530
tree.reset_state(revision_ids)
531
except errors.BzrError, e:
532
if revision_ids is None:
533
extra = (', the header appears corrupt, try passing -r -1'
534
' to set the state to the last commit')
537
raise errors.BzrCommandError('failed to reset the tree state'
541
class cmd_revno(Command):
542
__doc__ = """Show current revision number.
544
This is equal to the number of revisions on this branch.
548
takes_args = ['location?']
550
Option('tree', help='Show revno of working tree'),
554
def run(self, tree=False, location=u'.'):
557
wt = WorkingTree.open_containing(location)[0]
558
self.add_cleanup(wt.lock_read().unlock)
559
except (errors.NoWorkingTree, errors.NotLocalUrl):
560
raise errors.NoWorkingTree(location)
561
revid = wt.last_revision()
563
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
564
except errors.NoSuchRevision:
566
revno = ".".join(str(n) for n in revno_t)
568
b = Branch.open_containing(location)[0]
569
self.add_cleanup(b.lock_read().unlock)
572
self.outf.write(str(revno) + '\n')
575
class cmd_revision_info(Command):
576
__doc__ = """Show revision number and revision id for a given revision identifier.
579
takes_args = ['revision_info*']
582
custom_help('directory',
583
help='Branch to examine, '
584
'rather than the one containing the working directory.'),
585
Option('tree', help='Show revno of working tree'),
589
def run(self, revision=None, directory=u'.', tree=False,
590
revision_info_list=[]):
593
wt = WorkingTree.open_containing(directory)[0]
595
self.add_cleanup(wt.lock_read().unlock)
596
except (errors.NoWorkingTree, errors.NotLocalUrl):
598
b = Branch.open_containing(directory)[0]
599
self.add_cleanup(b.lock_read().unlock)
601
if revision is not None:
602
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
603
if revision_info_list is not None:
604
for rev_str in revision_info_list:
605
rev_spec = RevisionSpec.from_string(rev_str)
606
revision_ids.append(rev_spec.as_revision_id(b))
607
# No arguments supplied, default to the last revision
608
if len(revision_ids) == 0:
611
raise errors.NoWorkingTree(directory)
612
revision_ids.append(wt.last_revision())
614
revision_ids.append(b.last_revision())
618
for revision_id in revision_ids:
620
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
621
revno = '.'.join(str(i) for i in dotted_revno)
622
except errors.NoSuchRevision:
624
maxlen = max(maxlen, len(revno))
625
revinfos.append([revno, revision_id])
629
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
632
class cmd_add(Command):
633
__doc__ = """Add specified files or directories.
635
In non-recursive mode, all the named items are added, regardless
636
of whether they were previously ignored. A warning is given if
637
any of the named files are already versioned.
639
In recursive mode (the default), files are treated the same way
640
but the behaviour for directories is different. Directories that
641
are already versioned do not give a warning. All directories,
642
whether already versioned or not, are searched for files or
643
subdirectories that are neither versioned or ignored, and these
644
are added. This search proceeds recursively into versioned
645
directories. If no names are given '.' is assumed.
647
Therefore simply saying 'bzr add' will version all files that
648
are currently unknown.
650
Adding a file whose parent directory is not versioned will
651
implicitly add the parent, and so on up to the root. This means
652
you should never need to explicitly add a directory, they'll just
653
get added when you add a file in the directory.
655
--dry-run will show which files would be added, but not actually
658
--file-ids-from will try to use the file ids from the supplied path.
659
It looks up ids trying to find a matching parent directory with the
660
same filename, and then by pure path. This option is rarely needed
661
but can be useful when adding the same logical file into two
662
branches that will be merged later (without showing the two different
663
adds as a conflict). It is also useful when merging another project
664
into a subdirectory of this one.
666
Any files matching patterns in the ignore list will not be added
667
unless they are explicitly mentioned.
669
takes_args = ['file*']
672
help="Don't recursively add the contents of directories."),
674
help="Show what would be done, but don't actually do anything."),
676
Option('file-ids-from',
678
help='Lookup file ids from this tree.'),
680
encoding_type = 'replace'
681
_see_also = ['remove', 'ignore']
683
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
688
if file_ids_from is not None:
690
base_tree, base_path = WorkingTree.open_containing(
692
except errors.NoWorkingTree:
693
base_branch, base_path = Branch.open_containing(
695
base_tree = base_branch.basis_tree()
697
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
698
to_file=self.outf, should_print=(not is_quiet()))
700
action = bzrlib.add.AddAction(to_file=self.outf,
701
should_print=(not is_quiet()))
704
self.add_cleanup(base_tree.lock_read().unlock)
705
tree, file_list = tree_files_for_add(file_list)
706
added, ignored = tree.smart_add(file_list, not
707
no_recurse, action=action, save=not dry_run)
711
for glob in sorted(ignored.keys()):
712
for path in ignored[glob]:
713
self.outf.write("ignored %s matching \"%s\"\n"
717
class cmd_mkdir(Command):
718
__doc__ = """Create a new versioned directory.
720
This is equivalent to creating the directory and then adding it.
723
takes_args = ['dir+']
724
encoding_type = 'replace'
726
def run(self, dir_list):
728
wt, dd = WorkingTree.open_containing(d)
729
base = os.path.dirname(dd)
730
id = wt.path2id(base)
734
self.outf.write('added %s\n' % d)
736
raise errors.NotVersionedError(path=base)
739
class cmd_relpath(Command):
740
__doc__ = """Show path of a file relative to root"""
742
takes_args = ['filename']
746
def run(self, filename):
747
# TODO: jam 20050106 Can relpath return a munged path if
748
# sys.stdout encoding cannot represent it?
749
tree, relpath = WorkingTree.open_containing(filename)
750
self.outf.write(relpath)
751
self.outf.write('\n')
754
class cmd_inventory(Command):
755
__doc__ = """Show inventory of the current working copy or a revision.
757
It is possible to limit the output to a particular entry
758
type using the --kind option. For example: --kind file.
760
It is also possible to restrict the list of files to a specific
761
set. For example: bzr inventory --show-ids this/file
770
help='List entries of a particular kind: file, directory, symlink.',
773
takes_args = ['file*']
776
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
777
if kind and kind not in ['file', 'directory', 'symlink']:
778
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
780
revision = _get_one_revision('inventory', revision)
781
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
782
self.add_cleanup(work_tree.lock_read().unlock)
783
if revision is not None:
784
tree = revision.as_tree(work_tree.branch)
786
extra_trees = [work_tree]
787
self.add_cleanup(tree.lock_read().unlock)
792
if file_list is not None:
793
file_ids = tree.paths2ids(file_list, trees=extra_trees,
794
require_versioned=True)
795
# find_ids_across_trees may include some paths that don't
797
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
798
for file_id in file_ids if file_id in tree)
800
entries = tree.inventory.entries()
803
for path, entry in entries:
804
if kind and kind != entry.kind:
807
self.outf.write('%-50s %s\n' % (path, entry.file_id))
809
self.outf.write(path)
810
self.outf.write('\n')
813
class cmd_mv(Command):
814
__doc__ = """Move or rename a file.
817
bzr mv OLDNAME NEWNAME
819
bzr mv SOURCE... DESTINATION
821
If the last argument is a versioned directory, all the other names
822
are moved into it. Otherwise, there must be exactly two arguments
823
and the file is changed to a new name.
825
If OLDNAME does not exist on the filesystem but is versioned and
826
NEWNAME does exist on the filesystem but is not versioned, mv
827
assumes that the file has been manually moved and only updates
828
its internal inventory to reflect that change.
829
The same is valid when moving many SOURCE files to a DESTINATION.
831
Files cannot be moved between branches.
834
takes_args = ['names*']
835
takes_options = [Option("after", help="Move only the bzr identifier"
836
" of the file, because the file has already been moved."),
837
Option('auto', help='Automatically guess renames.'),
838
Option('dry-run', help='Avoid making changes when guessing renames.'),
840
aliases = ['move', 'rename']
841
encoding_type = 'replace'
843
def run(self, names_list, after=False, auto=False, dry_run=False):
845
return self.run_auto(names_list, after, dry_run)
847
raise errors.BzrCommandError('--dry-run requires --auto.')
848
if names_list is None:
850
if len(names_list) < 2:
851
raise errors.BzrCommandError("missing file argument")
852
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
853
self.add_cleanup(tree.lock_tree_write().unlock)
854
self._run(tree, names_list, rel_names, after)
856
def run_auto(self, names_list, after, dry_run):
857
if names_list is not None and len(names_list) > 1:
858
raise errors.BzrCommandError('Only one path may be specified to'
861
raise errors.BzrCommandError('--after cannot be specified with'
863
work_tree, file_list = WorkingTree.open_containing_paths(
864
names_list, default_directory='.')
865
self.add_cleanup(work_tree.lock_tree_write().unlock)
866
rename_map.RenameMap.guess_renames(work_tree, dry_run)
868
def _run(self, tree, names_list, rel_names, after):
869
into_existing = osutils.isdir(names_list[-1])
870
if into_existing and len(names_list) == 2:
872
# a. case-insensitive filesystem and change case of dir
873
# b. move directory after the fact (if the source used to be
874
# a directory, but now doesn't exist in the working tree
875
# and the target is an existing directory, just rename it)
876
if (not tree.case_sensitive
877
and rel_names[0].lower() == rel_names[1].lower()):
878
into_existing = False
881
# 'fix' the case of a potential 'from'
882
from_id = tree.path2id(
883
tree.get_canonical_inventory_path(rel_names[0]))
884
if (not osutils.lexists(names_list[0]) and
885
from_id and inv.get_file_kind(from_id) == "directory"):
886
into_existing = False
889
# move into existing directory
890
# All entries reference existing inventory items, so fix them up
891
# for cicp file-systems.
892
rel_names = tree.get_canonical_inventory_paths(rel_names)
893
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
895
self.outf.write("%s => %s\n" % (src, dest))
897
if len(names_list) != 2:
898
raise errors.BzrCommandError('to mv multiple files the'
899
' destination must be a versioned'
902
# for cicp file-systems: the src references an existing inventory
904
src = tree.get_canonical_inventory_path(rel_names[0])
905
# Find the canonical version of the destination: In all cases, the
906
# parent of the target must be in the inventory, so we fetch the
907
# canonical version from there (we do not always *use* the
908
# canonicalized tail portion - we may be attempting to rename the
910
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
911
dest_parent = osutils.dirname(canon_dest)
912
spec_tail = osutils.basename(rel_names[1])
913
# For a CICP file-system, we need to avoid creating 2 inventory
914
# entries that differ only by case. So regardless of the case
915
# we *want* to use (ie, specified by the user or the file-system),
916
# we must always choose to use the case of any existing inventory
917
# items. The only exception to this is when we are attempting a
918
# case-only rename (ie, canonical versions of src and dest are
920
dest_id = tree.path2id(canon_dest)
921
if dest_id is None or tree.path2id(src) == dest_id:
922
# No existing item we care about, so work out what case we
923
# are actually going to use.
925
# If 'after' is specified, the tail must refer to a file on disk.
927
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
929
# pathjoin with an empty tail adds a slash, which breaks
931
dest_parent_fq = tree.basedir
933
dest_tail = osutils.canonical_relpath(
935
osutils.pathjoin(dest_parent_fq, spec_tail))
937
# not 'after', so case as specified is used
938
dest_tail = spec_tail
940
# Use the existing item so 'mv' fails with AlreadyVersioned.
941
dest_tail = os.path.basename(canon_dest)
942
dest = osutils.pathjoin(dest_parent, dest_tail)
943
mutter("attempting to move %s => %s", src, dest)
944
tree.rename_one(src, dest, after=after)
946
self.outf.write("%s => %s\n" % (src, dest))
949
class cmd_pull(Command):
950
__doc__ = """Turn this branch into a mirror of another branch.
952
By default, this command only works on branches that have not diverged.
953
Branches are considered diverged if the destination branch's most recent
954
commit is one that has not been merged (directly or indirectly) into the
957
If branches have diverged, you can use 'bzr merge' to integrate the changes
958
from one into the other. Once one branch has merged, the other should
959
be able to pull it again.
961
If you want to replace your local changes and just want your branch to
962
match the remote one, use pull --overwrite. This will work even if the two
963
branches have diverged.
965
If there is no default location set, the first pull will set it (use
966
--no-remember to avoid settting it). After that, you can omit the
967
location to use the default. To change the default, use --remember. The
968
value will only be saved if the remote location can be accessed.
970
Note: The location can be specified either in the form of a branch,
971
or in the form of a path to a file containing a merge directive generated
975
_see_also = ['push', 'update', 'status-flags', 'send']
976
takes_options = ['remember', 'overwrite', 'revision',
977
custom_help('verbose',
978
help='Show logs of pulled revisions.'),
979
custom_help('directory',
980
help='Branch to pull into, '
981
'rather than the one containing the working directory.'),
983
help="Perform a local pull in a bound "
984
"branch. Local pulls are not applied to "
988
help="Show base revision text in conflicts.")
990
takes_args = ['location?']
991
encoding_type = 'replace'
993
def run(self, location=None, remember=None, overwrite=False,
994
revision=None, verbose=False,
995
directory=None, local=False,
997
# FIXME: too much stuff is in the command class
1000
if directory is None:
1003
tree_to = WorkingTree.open_containing(directory)[0]
1004
branch_to = tree_to.branch
1005
self.add_cleanup(tree_to.lock_write().unlock)
1006
except errors.NoWorkingTree:
1008
branch_to = Branch.open_containing(directory)[0]
1009
self.add_cleanup(branch_to.lock_write().unlock)
1011
if tree_to is None and show_base:
1012
raise errors.BzrCommandError("Need working tree for --show-base.")
1014
if local and not branch_to.get_bound_location():
1015
raise errors.LocalRequiresBoundBranch()
1017
possible_transports = []
1018
if location is not None:
1020
mergeable = bundle.read_mergeable_from_url(location,
1021
possible_transports=possible_transports)
1022
except errors.NotABundle:
1025
stored_loc = branch_to.get_parent()
1026
if location is None:
1027
if stored_loc is None:
1028
raise errors.BzrCommandError("No pull location known or"
1031
display_url = urlutils.unescape_for_display(stored_loc,
1034
self.outf.write("Using saved parent location: %s\n" % display_url)
1035
location = stored_loc
1037
revision = _get_one_revision('pull', revision)
1038
if mergeable is not None:
1039
if revision is not None:
1040
raise errors.BzrCommandError(
1041
'Cannot use -r with merge directives or bundles')
1042
mergeable.install_revisions(branch_to.repository)
1043
base_revision_id, revision_id, verified = \
1044
mergeable.get_merge_request(branch_to.repository)
1045
branch_from = branch_to
1047
branch_from = Branch.open(location,
1048
possible_transports=possible_transports)
1049
self.add_cleanup(branch_from.lock_read().unlock)
1050
# Remembers if asked explicitly or no previous location is set
1052
or (remember is None and branch_to.get_parent() is None)):
1053
branch_to.set_parent(branch_from.base)
1055
if revision is not None:
1056
revision_id = revision.as_revision_id(branch_from)
1058
if tree_to is not None:
1059
view_info = _get_view_info_for_change_reporter(tree_to)
1060
change_reporter = delta._ChangeReporter(
1061
unversioned_filter=tree_to.is_ignored,
1062
view_info=view_info)
1063
result = tree_to.pull(
1064
branch_from, overwrite, revision_id, change_reporter,
1065
possible_transports=possible_transports, local=local,
1066
show_base=show_base)
1068
result = branch_to.pull(
1069
branch_from, overwrite, revision_id, local=local)
1071
result.report(self.outf)
1072
if verbose and result.old_revid != result.new_revid:
1073
log.show_branch_change(
1074
branch_to, self.outf, result.old_revno,
1076
if getattr(result, 'tag_conflicts', None):
1082
class cmd_push(Command):
1083
__doc__ = """Update a mirror of this branch.
1085
The target branch will not have its working tree populated because this
1086
is both expensive, and is not supported on remote file systems.
1088
Some smart servers or protocols *may* put the working tree in place in
1091
This command only works on branches that have not diverged. Branches are
1092
considered diverged if the destination branch's most recent commit is one
1093
that has not been merged (directly or indirectly) by the source branch.
1095
If branches have diverged, you can use 'bzr push --overwrite' to replace
1096
the other branch completely, discarding its unmerged changes.
1098
If you want to ensure you have the different changes in the other branch,
1099
do a merge (see bzr help merge) from the other branch, and commit that.
1100
After that you will be able to do a push without '--overwrite'.
1102
If there is no default push location set, the first push will set it (use
1103
--no-remember to avoid settting it). After that, you can omit the
1104
location to use the default. To change the default, use --remember. The
1105
value will only be saved if the remote location can be accessed.
1108
_see_also = ['pull', 'update', 'working-trees']
1109
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1110
Option('create-prefix',
1111
help='Create the path leading up to the branch '
1112
'if it does not already exist.'),
1113
custom_help('directory',
1114
help='Branch to push from, '
1115
'rather than the one containing the working directory.'),
1116
Option('use-existing-dir',
1117
help='By default push will fail if the target'
1118
' directory exists, but does not already'
1119
' have a control directory. This flag will'
1120
' allow push to proceed.'),
1122
help='Create a stacked branch that references the public location '
1123
'of the parent branch.'),
1124
Option('stacked-on',
1125
help='Create a stacked branch that refers to another branch '
1126
'for the commit history. Only the work not present in the '
1127
'referenced branch is included in the branch created.',
1130
help='Refuse to push if there are uncommitted changes in'
1131
' the working tree, --no-strict disables the check.'),
1133
help="Don't populate the working tree, even for protocols"
1134
" that support it."),
1136
takes_args = ['location?']
1137
encoding_type = 'replace'
1139
def run(self, location=None, remember=None, overwrite=False,
1140
create_prefix=False, verbose=False, revision=None,
1141
use_existing_dir=False, directory=None, stacked_on=None,
1142
stacked=False, strict=None, no_tree=False):
1143
from bzrlib.push import _show_push_branch
1145
if directory is None:
1147
# Get the source branch
1149
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1150
# Get the tip's revision_id
1151
revision = _get_one_revision('push', revision)
1152
if revision is not None:
1153
revision_id = revision.in_history(br_from).rev_id
1156
if tree is not None and revision_id is None:
1157
tree.check_changed_or_out_of_date(
1158
strict, 'push_strict',
1159
more_error='Use --no-strict to force the push.',
1160
more_warning='Uncommitted changes will not be pushed.')
1161
# Get the stacked_on branch, if any
1162
if stacked_on is not None:
1163
stacked_on = urlutils.normalize_url(stacked_on)
1165
parent_url = br_from.get_parent()
1167
parent = Branch.open(parent_url)
1168
stacked_on = parent.get_public_branch()
1170
# I considered excluding non-http url's here, thus forcing
1171
# 'public' branches only, but that only works for some
1172
# users, so it's best to just depend on the user spotting an
1173
# error by the feedback given to them. RBC 20080227.
1174
stacked_on = parent_url
1176
raise errors.BzrCommandError(
1177
"Could not determine branch to refer to.")
1179
# Get the destination location
1180
if location is None:
1181
stored_loc = br_from.get_push_location()
1182
if stored_loc is None:
1183
raise errors.BzrCommandError(
1184
"No push location known or specified.")
1186
display_url = urlutils.unescape_for_display(stored_loc,
1188
self.outf.write("Using saved push location: %s\n" % display_url)
1189
location = stored_loc
1191
_show_push_branch(br_from, revision_id, location, self.outf,
1192
verbose=verbose, overwrite=overwrite, remember=remember,
1193
stacked_on=stacked_on, create_prefix=create_prefix,
1194
use_existing_dir=use_existing_dir, no_tree=no_tree)
1197
class cmd_branch(Command):
1198
__doc__ = """Create a new branch that is a copy of an existing branch.
1200
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1201
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1202
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1203
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1204
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1207
To retrieve the branch as of a particular revision, supply the --revision
1208
parameter, as in "branch foo/bar -r 5".
1210
The synonyms 'clone' and 'get' for this command are deprecated.
1213
_see_also = ['checkout']
1214
takes_args = ['from_location', 'to_location?']
1215
takes_options = ['revision',
1216
Option('hardlink', help='Hard-link working tree files where possible.'),
1217
Option('files-from', type=str,
1218
help="Get file contents from this tree."),
1220
help="Create a branch without a working-tree."),
1222
help="Switch the checkout in the current directory "
1223
"to the new branch."),
1225
help='Create a stacked branch referring to the source branch. '
1226
'The new branch will depend on the availability of the source '
1227
'branch for all operations.'),
1228
Option('standalone',
1229
help='Do not use a shared repository, even if available.'),
1230
Option('use-existing-dir',
1231
help='By default branch will fail if the target'
1232
' directory exists, but does not already'
1233
' have a control directory. This flag will'
1234
' allow branch to proceed.'),
1236
help="Bind new branch to from location."),
1238
aliases = ['get', 'clone']
1240
def run(self, from_location, to_location=None, revision=None,
1241
hardlink=False, stacked=False, standalone=False, no_tree=False,
1242
use_existing_dir=False, switch=False, bind=False,
1244
from bzrlib import switch as _mod_switch
1245
from bzrlib.tag import _merge_tags_if_possible
1246
if self.invoked_as in ['get', 'clone']:
1247
ui.ui_factory.show_user_warning(
1248
'deprecated_command',
1249
deprecated_name=self.invoked_as,
1250
recommended_name='branch',
1251
deprecated_in_version='2.4')
1252
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1254
if not (hardlink or files_from):
1255
# accelerator_tree is usually slower because you have to read N
1256
# files (no readahead, lots of seeks, etc), but allow the user to
1257
# explicitly request it
1258
accelerator_tree = None
1259
if files_from is not None and files_from != from_location:
1260
accelerator_tree = WorkingTree.open(files_from)
1261
revision = _get_one_revision('branch', revision)
1262
self.add_cleanup(br_from.lock_read().unlock)
1263
if revision is not None:
1264
revision_id = revision.as_revision_id(br_from)
1266
# FIXME - wt.last_revision, fallback to branch, fall back to
1267
# None or perhaps NULL_REVISION to mean copy nothing
1269
revision_id = br_from.last_revision()
1270
if to_location is None:
1271
to_location = urlutils.derive_to_location(from_location)
1272
to_transport = transport.get_transport(to_location)
1274
to_transport.mkdir('.')
1275
except errors.FileExists:
1276
if not use_existing_dir:
1277
raise errors.BzrCommandError('Target directory "%s" '
1278
'already exists.' % to_location)
1281
bzrdir.BzrDir.open_from_transport(to_transport)
1282
except errors.NotBranchError:
1285
raise errors.AlreadyBranchError(to_location)
1286
except errors.NoSuchFile:
1287
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1290
# preserve whatever source format we have.
1291
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1292
possible_transports=[to_transport],
1293
accelerator_tree=accelerator_tree,
1294
hardlink=hardlink, stacked=stacked,
1295
force_new_repo=standalone,
1296
create_tree_if_local=not no_tree,
1297
source_branch=br_from)
1298
branch = dir.open_branch()
1299
except errors.NoSuchRevision:
1300
to_transport.delete_tree('.')
1301
msg = "The branch %s has no revision %s." % (from_location,
1303
raise errors.BzrCommandError(msg)
1304
_merge_tags_if_possible(br_from, branch)
1305
# If the source branch is stacked, the new branch may
1306
# be stacked whether we asked for that explicitly or not.
1307
# We therefore need a try/except here and not just 'if stacked:'
1309
note('Created new stacked branch referring to %s.' %
1310
branch.get_stacked_on_url())
1311
except (errors.NotStacked, errors.UnstackableBranchFormat,
1312
errors.UnstackableRepositoryFormat), e:
1313
note('Branched %d revision(s).' % branch.revno())
1315
# Bind to the parent
1316
parent_branch = Branch.open(from_location)
1317
branch.bind(parent_branch)
1318
note('New branch bound to %s' % from_location)
1320
# Switch to the new branch
1321
wt, _ = WorkingTree.open_containing('.')
1322
_mod_switch.switch(wt.bzrdir, branch)
1323
note('Switched to branch: %s',
1324
urlutils.unescape_for_display(branch.base, 'utf-8'))
1327
class cmd_checkout(Command):
1328
__doc__ = """Create a new checkout of an existing branch.
1330
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1331
the branch found in '.'. This is useful if you have removed the working tree
1332
or if it was never created - i.e. if you pushed the branch to its current
1333
location using SFTP.
1335
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1336
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1337
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1338
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1339
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1342
To retrieve the branch as of a particular revision, supply the --revision
1343
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1344
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1348
_see_also = ['checkouts', 'branch']
1349
takes_args = ['branch_location?', 'to_location?']
1350
takes_options = ['revision',
1351
Option('lightweight',
1352
help="Perform a lightweight checkout. Lightweight "
1353
"checkouts depend on access to the branch for "
1354
"every operation. Normal checkouts can perform "
1355
"common operations like diff and status without "
1356
"such access, and also support local commits."
1358
Option('files-from', type=str,
1359
help="Get file contents from this tree."),
1361
help='Hard-link working tree files where possible.'
1366
def run(self, branch_location=None, to_location=None, revision=None,
1367
lightweight=False, files_from=None, hardlink=False):
1368
if branch_location is None:
1369
branch_location = osutils.getcwd()
1370
to_location = branch_location
1371
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1373
if not (hardlink or files_from):
1374
# accelerator_tree is usually slower because you have to read N
1375
# files (no readahead, lots of seeks, etc), but allow the user to
1376
# explicitly request it
1377
accelerator_tree = None
1378
revision = _get_one_revision('checkout', revision)
1379
if files_from is not None and files_from != branch_location:
1380
accelerator_tree = WorkingTree.open(files_from)
1381
if revision is not None:
1382
revision_id = revision.as_revision_id(source)
1385
if to_location is None:
1386
to_location = urlutils.derive_to_location(branch_location)
1387
# if the source and to_location are the same,
1388
# and there is no working tree,
1389
# then reconstitute a branch
1390
if (osutils.abspath(to_location) ==
1391
osutils.abspath(branch_location)):
1393
source.bzrdir.open_workingtree()
1394
except errors.NoWorkingTree:
1395
source.bzrdir.create_workingtree(revision_id)
1397
source.create_checkout(to_location, revision_id, lightweight,
1398
accelerator_tree, hardlink)
1401
class cmd_renames(Command):
1402
__doc__ = """Show list of renamed files.
1404
# TODO: Option to show renames between two historical versions.
1406
# TODO: Only show renames under dir, rather than in the whole branch.
1407
_see_also = ['status']
1408
takes_args = ['dir?']
1411
def run(self, dir=u'.'):
1412
tree = WorkingTree.open_containing(dir)[0]
1413
self.add_cleanup(tree.lock_read().unlock)
1414
new_inv = tree.inventory
1415
old_tree = tree.basis_tree()
1416
self.add_cleanup(old_tree.lock_read().unlock)
1417
old_inv = old_tree.inventory
1419
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1420
for f, paths, c, v, p, n, k, e in iterator:
1421
if paths[0] == paths[1]:
1425
renames.append(paths)
1427
for old_name, new_name in renames:
1428
self.outf.write("%s => %s\n" % (old_name, new_name))
1431
class cmd_update(Command):
1432
__doc__ = """Update a tree to have the latest code committed to its branch.
1434
This will perform a merge into the working tree, and may generate
1435
conflicts. If you have any local changes, you will still
1436
need to commit them after the update for the update to be complete.
1438
If you want to discard your local changes, you can just do a
1439
'bzr revert' instead of 'bzr commit' after the update.
1441
If you want to restore a file that has been removed locally, use
1442
'bzr revert' instead of 'bzr update'.
1444
If the tree's branch is bound to a master branch, it will also update
1445
the branch from the master.
1448
_see_also = ['pull', 'working-trees', 'status-flags']
1449
takes_args = ['dir?']
1450
takes_options = ['revision',
1452
help="Show base revision text in conflicts."),
1456
def run(self, dir='.', revision=None, show_base=None):
1457
if revision is not None and len(revision) != 1:
1458
raise errors.BzrCommandError(
1459
"bzr update --revision takes exactly one revision")
1460
tree = WorkingTree.open_containing(dir)[0]
1461
branch = tree.branch
1462
possible_transports = []
1463
master = branch.get_master_branch(
1464
possible_transports=possible_transports)
1465
if master is not None:
1466
branch_location = master.base
1469
branch_location = tree.branch.base
1470
tree.lock_tree_write()
1471
self.add_cleanup(tree.unlock)
1472
# get rid of the final '/' and be ready for display
1473
branch_location = urlutils.unescape_for_display(
1474
branch_location.rstrip('/'),
1476
existing_pending_merges = tree.get_parent_ids()[1:]
1480
# may need to fetch data into a heavyweight checkout
1481
# XXX: this may take some time, maybe we should display a
1483
old_tip = branch.update(possible_transports)
1484
if revision is not None:
1485
revision_id = revision[0].as_revision_id(branch)
1487
revision_id = branch.last_revision()
1488
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1489
revno = branch.revision_id_to_dotted_revno(revision_id)
1490
note("Tree is up to date at revision %s of branch %s" %
1491
('.'.join(map(str, revno)), branch_location))
1493
view_info = _get_view_info_for_change_reporter(tree)
1494
change_reporter = delta._ChangeReporter(
1495
unversioned_filter=tree.is_ignored,
1496
view_info=view_info)
1498
conflicts = tree.update(
1500
possible_transports=possible_transports,
1501
revision=revision_id,
1503
show_base=show_base)
1504
except errors.NoSuchRevision, e:
1505
raise errors.BzrCommandError(
1506
"branch has no revision %s\n"
1507
"bzr update --revision only works"
1508
" for a revision in the branch history"
1510
revno = tree.branch.revision_id_to_dotted_revno(
1511
_mod_revision.ensure_null(tree.last_revision()))
1512
note('Updated to revision %s of branch %s' %
1513
('.'.join(map(str, revno)), branch_location))
1514
parent_ids = tree.get_parent_ids()
1515
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1516
note('Your local commits will now show as pending merges with '
1517
"'bzr status', and can be committed with 'bzr commit'.")
1524
class cmd_info(Command):
1525
__doc__ = """Show information about a working tree, branch or repository.
1527
This command will show all known locations and formats associated to the
1528
tree, branch or repository.
1530
In verbose mode, statistical information is included with each report.
1531
To see extended statistic information, use a verbosity level of 2 or
1532
higher by specifying the verbose option multiple times, e.g. -vv.
1534
Branches and working trees will also report any missing revisions.
1538
Display information on the format and related locations:
1542
Display the above together with extended format information and
1543
basic statistics (like the number of files in the working tree and
1544
number of revisions in the branch and repository):
1548
Display the above together with number of committers to the branch:
1552
_see_also = ['revno', 'working-trees', 'repositories']
1553
takes_args = ['location?']
1554
takes_options = ['verbose']
1555
encoding_type = 'replace'
1558
def run(self, location=None, verbose=False):
1560
noise_level = get_verbosity_level()
1563
from bzrlib.info import show_bzrdir_info
1564
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1565
verbose=noise_level, outfile=self.outf)
1568
class cmd_remove(Command):
1569
__doc__ = """Remove files or directories.
1571
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1572
delete them if they can easily be recovered using revert otherwise they
1573
will be backed up (adding an extention of the form .~#~). If no options or
1574
parameters are given Bazaar will scan for files that are being tracked by
1575
Bazaar but missing in your tree and stop tracking them for you.
1577
takes_args = ['file*']
1578
takes_options = ['verbose',
1579
Option('new', help='Only remove files that have never been committed.'),
1580
RegistryOption.from_kwargs('file-deletion-strategy',
1581
'The file deletion mode to be used.',
1582
title='Deletion Strategy', value_switches=True, enum_switch=False,
1583
safe='Backup changed files (default).',
1584
keep='Delete from bzr but leave the working copy.',
1585
no_backup='Don\'t backup changed files.',
1586
force='Delete all the specified files, even if they can not be '
1587
'recovered and even if they are non-empty directories. '
1588
'(deprecated, use no-backup)')]
1589
aliases = ['rm', 'del']
1590
encoding_type = 'replace'
1592
def run(self, file_list, verbose=False, new=False,
1593
file_deletion_strategy='safe'):
1594
if file_deletion_strategy == 'force':
1595
note("(The --force option is deprecated, rather use --no-backup "
1597
file_deletion_strategy = 'no-backup'
1599
tree, file_list = WorkingTree.open_containing_paths(file_list)
1601
if file_list is not None:
1602
file_list = [f for f in file_list]
1604
self.add_cleanup(tree.lock_write().unlock)
1605
# Heuristics should probably all move into tree.remove_smart or
1608
added = tree.changes_from(tree.basis_tree(),
1609
specific_files=file_list).added
1610
file_list = sorted([f[0] for f in added], reverse=True)
1611
if len(file_list) == 0:
1612
raise errors.BzrCommandError('No matching files.')
1613
elif file_list is None:
1614
# missing files show up in iter_changes(basis) as
1615
# versioned-with-no-kind.
1617
for change in tree.iter_changes(tree.basis_tree()):
1618
# Find paths in the working tree that have no kind:
1619
if change[1][1] is not None and change[6][1] is None:
1620
missing.append(change[1][1])
1621
file_list = sorted(missing, reverse=True)
1622
file_deletion_strategy = 'keep'
1623
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1624
keep_files=file_deletion_strategy=='keep',
1625
force=(file_deletion_strategy=='no-backup'))
1628
class cmd_file_id(Command):
1629
__doc__ = """Print file_id of a particular file or directory.
1631
The file_id is assigned when the file is first added and remains the
1632
same through all revisions where the file exists, even when it is
1637
_see_also = ['inventory', 'ls']
1638
takes_args = ['filename']
1641
def run(self, filename):
1642
tree, relpath = WorkingTree.open_containing(filename)
1643
i = tree.path2id(relpath)
1645
raise errors.NotVersionedError(filename)
1647
self.outf.write(i + '\n')
1650
class cmd_file_path(Command):
1651
__doc__ = """Print path of file_ids to a file or directory.
1653
This prints one line for each directory down to the target,
1654
starting at the branch root.
1658
takes_args = ['filename']
1661
def run(self, filename):
1662
tree, relpath = WorkingTree.open_containing(filename)
1663
fid = tree.path2id(relpath)
1665
raise errors.NotVersionedError(filename)
1666
segments = osutils.splitpath(relpath)
1667
for pos in range(1, len(segments) + 1):
1668
path = osutils.joinpath(segments[:pos])
1669
self.outf.write("%s\n" % tree.path2id(path))
1672
class cmd_reconcile(Command):
1673
__doc__ = """Reconcile bzr metadata in a branch.
1675
This can correct data mismatches that may have been caused by
1676
previous ghost operations or bzr upgrades. You should only
1677
need to run this command if 'bzr check' or a bzr developer
1678
advises you to run it.
1680
If a second branch is provided, cross-branch reconciliation is
1681
also attempted, which will check that data like the tree root
1682
id which was not present in very early bzr versions is represented
1683
correctly in both branches.
1685
At the same time it is run it may recompress data resulting in
1686
a potential saving in disk space or performance gain.
1688
The branch *MUST* be on a listable system such as local disk or sftp.
1691
_see_also = ['check']
1692
takes_args = ['branch?']
1694
Option('canonicalize-chks',
1695
help='Make sure CHKs are in canonical form (repairs '
1700
def run(self, branch=".", canonicalize_chks=False):
1701
from bzrlib.reconcile import reconcile
1702
dir = bzrdir.BzrDir.open(branch)
1703
reconcile(dir, canonicalize_chks=canonicalize_chks)
1706
class cmd_revision_history(Command):
1707
__doc__ = """Display the list of revision ids on a branch."""
1710
takes_args = ['location?']
1715
def run(self, location="."):
1716
branch = Branch.open_containing(location)[0]
1717
for revid in branch.revision_history():
1718
self.outf.write(revid)
1719
self.outf.write('\n')
1722
class cmd_ancestry(Command):
1723
__doc__ = """List all revisions merged into this branch."""
1725
_see_also = ['log', 'revision-history']
1726
takes_args = ['location?']
1731
def run(self, location="."):
1733
wt = WorkingTree.open_containing(location)[0]
1734
except errors.NoWorkingTree:
1735
b = Branch.open(location)
1736
last_revision = b.last_revision()
1739
last_revision = wt.last_revision()
1741
revision_ids = b.repository.get_ancestry(last_revision)
1743
for revision_id in revision_ids:
1744
self.outf.write(revision_id + '\n')
1747
class cmd_init(Command):
1748
__doc__ = """Make a directory into a versioned branch.
1750
Use this to create an empty branch, or before importing an
1753
If there is a repository in a parent directory of the location, then
1754
the history of the branch will be stored in the repository. Otherwise
1755
init creates a standalone branch which carries its own history
1756
in the .bzr directory.
1758
If there is already a branch at the location but it has no working tree,
1759
the tree can be populated with 'bzr checkout'.
1761
Recipe for importing a tree of files::
1767
bzr commit -m "imported project"
1770
_see_also = ['init-repository', 'branch', 'checkout']
1771
takes_args = ['location?']
1773
Option('create-prefix',
1774
help='Create the path leading up to the branch '
1775
'if it does not already exist.'),
1776
RegistryOption('format',
1777
help='Specify a format for this branch. '
1778
'See "help formats".',
1779
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1780
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1781
value_switches=True,
1782
title="Branch format",
1784
Option('append-revisions-only',
1785
help='Never change revnos or the existing log.'
1786
' Append revisions to it only.'),
1788
'Create a branch without a working tree.')
1790
def run(self, location=None, format=None, append_revisions_only=False,
1791
create_prefix=False, no_tree=False):
1793
format = bzrdir.format_registry.make_bzrdir('default')
1794
if location is None:
1797
to_transport = transport.get_transport(location)
1799
# The path has to exist to initialize a
1800
# branch inside of it.
1801
# Just using os.mkdir, since I don't
1802
# believe that we want to create a bunch of
1803
# locations if the user supplies an extended path
1805
to_transport.ensure_base()
1806
except errors.NoSuchFile:
1807
if not create_prefix:
1808
raise errors.BzrCommandError("Parent directory of %s"
1810
"\nYou may supply --create-prefix to create all"
1811
" leading parent directories."
1813
to_transport.create_prefix()
1816
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1817
except errors.NotBranchError:
1818
# really a NotBzrDir error...
1819
create_branch = bzrdir.BzrDir.create_branch_convenience
1821
force_new_tree = False
1823
force_new_tree = None
1824
branch = create_branch(to_transport.base, format=format,
1825
possible_transports=[to_transport],
1826
force_new_tree=force_new_tree)
1827
a_bzrdir = branch.bzrdir
1829
from bzrlib.transport.local import LocalTransport
1830
if a_bzrdir.has_branch():
1831
if (isinstance(to_transport, LocalTransport)
1832
and not a_bzrdir.has_workingtree()):
1833
raise errors.BranchExistsWithoutWorkingTree(location)
1834
raise errors.AlreadyBranchError(location)
1835
branch = a_bzrdir.create_branch()
1837
a_bzrdir.create_workingtree()
1838
if append_revisions_only:
1840
branch.set_append_revisions_only(True)
1841
except errors.UpgradeRequired:
1842
raise errors.BzrCommandError('This branch format cannot be set'
1843
' to append-revisions-only. Try --default.')
1845
from bzrlib.info import describe_layout, describe_format
1847
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1848
except (errors.NoWorkingTree, errors.NotLocalUrl):
1850
repository = branch.repository
1851
layout = describe_layout(repository, branch, tree).lower()
1852
format = describe_format(a_bzrdir, repository, branch, tree)
1853
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1854
if repository.is_shared():
1855
#XXX: maybe this can be refactored into transport.path_or_url()
1856
url = repository.bzrdir.root_transport.external_url()
1858
url = urlutils.local_path_from_url(url)
1859
except errors.InvalidURL:
1861
self.outf.write("Using shared repository: %s\n" % url)
1864
class cmd_init_repository(Command):
1865
__doc__ = """Create a shared repository for branches to share storage space.
1867
New branches created under the repository directory will store their
1868
revisions in the repository, not in the branch directory. For branches
1869
with shared history, this reduces the amount of storage needed and
1870
speeds up the creation of new branches.
1872
If the --no-trees option is given then the branches in the repository
1873
will not have working trees by default. They will still exist as
1874
directories on disk, but they will not have separate copies of the
1875
files at a certain revision. This can be useful for repositories that
1876
store branches which are interacted with through checkouts or remote
1877
branches, such as on a server.
1880
Create a shared repository holding just branches::
1882
bzr init-repo --no-trees repo
1885
Make a lightweight checkout elsewhere::
1887
bzr checkout --lightweight repo/trunk trunk-checkout
1892
_see_also = ['init', 'branch', 'checkout', 'repositories']
1893
takes_args = ["location"]
1894
takes_options = [RegistryOption('format',
1895
help='Specify a format for this repository. See'
1896
' "bzr help formats" for details.',
1897
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1898
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1899
value_switches=True, title='Repository format'),
1901
help='Branches in the repository will default to'
1902
' not having a working tree.'),
1904
aliases = ["init-repo"]
1906
def run(self, location, format=None, no_trees=False):
1908
format = bzrdir.format_registry.make_bzrdir('default')
1910
if location is None:
1913
to_transport = transport.get_transport(location)
1914
to_transport.ensure_base()
1916
newdir = format.initialize_on_transport(to_transport)
1917
repo = newdir.create_repository(shared=True)
1918
repo.set_make_working_trees(not no_trees)
1920
from bzrlib.info import show_bzrdir_info
1921
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1924
class cmd_diff(Command):
1925
__doc__ = """Show differences in the working tree, between revisions or branches.
1927
If no arguments are given, all changes for the current tree are listed.
1928
If files are given, only the changes in those files are listed.
1929
Remote and multiple branches can be compared by using the --old and
1930
--new options. If not provided, the default for both is derived from
1931
the first argument, if any, or the current tree if no arguments are
1934
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1935
produces patches suitable for "patch -p1".
1937
Note that when using the -r argument with a range of revisions, the
1938
differences are computed between the two specified revisions. That
1939
is, the command does not show the changes introduced by the first
1940
revision in the range. This differs from the interpretation of
1941
revision ranges used by "bzr log" which includes the first revision
1946
2 - unrepresentable changes
1951
Shows the difference in the working tree versus the last commit::
1955
Difference between the working tree and revision 1::
1959
Difference between revision 3 and revision 1::
1963
Difference between revision 3 and revision 1 for branch xxx::
1967
The changes introduced by revision 2 (equivalent to -r1..2)::
1971
To see the changes introduced by revision X::
1975
Note that in the case of a merge, the -c option shows the changes
1976
compared to the left hand parent. To see the changes against
1977
another parent, use::
1979
bzr diff -r<chosen_parent>..X
1981
The changes between the current revision and the previous revision
1982
(equivalent to -c-1 and -r-2..-1)
1986
Show just the differences for file NEWS::
1990
Show the differences in working tree xxx for file NEWS::
1994
Show the differences from branch xxx to this working tree:
1998
Show the differences between two branches for file NEWS::
2000
bzr diff --old xxx --new yyy NEWS
2002
Same as 'bzr diff' but prefix paths with old/ and new/::
2004
bzr diff --prefix old/:new/
2006
Show the differences using a custom diff program with options::
2008
bzr diff --using /usr/bin/diff --diff-options -wu
2010
_see_also = ['status']
2011
takes_args = ['file*']
2013
Option('diff-options', type=str,
2014
help='Pass these options to the external diff program.'),
2015
Option('prefix', type=str,
2017
help='Set prefixes added to old and new filenames, as '
2018
'two values separated by a colon. (eg "old/:new/").'),
2020
help='Branch/tree to compare from.',
2024
help='Branch/tree to compare to.',
2030
help='Use this command to compare files.',
2033
RegistryOption('format',
2035
help='Diff format to use.',
2036
lazy_registry=('bzrlib.diff', 'format_registry'),
2037
title='Diff format'),
2039
aliases = ['di', 'dif']
2040
encoding_type = 'exact'
2043
def run(self, revision=None, file_list=None, diff_options=None,
2044
prefix=None, old=None, new=None, using=None, format=None):
2045
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2048
if (prefix is None) or (prefix == '0'):
2056
old_label, new_label = prefix.split(":")
2058
raise errors.BzrCommandError(
2059
'--prefix expects two values separated by a colon'
2060
' (eg "old/:new/")')
2062
if revision and len(revision) > 2:
2063
raise errors.BzrCommandError('bzr diff --revision takes exactly'
2064
' one or two revision specifiers')
2066
if using is not None and format is not None:
2067
raise errors.BzrCommandError('--using and --format are mutually '
2070
(old_tree, new_tree,
2071
old_branch, new_branch,
2072
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2073
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2074
# GNU diff on Windows uses ANSI encoding for filenames
2075
path_encoding = osutils.get_diff_header_encoding()
2076
return show_diff_trees(old_tree, new_tree, sys.stdout,
2077
specific_files=specific_files,
2078
external_diff_options=diff_options,
2079
old_label=old_label, new_label=new_label,
2080
extra_trees=extra_trees,
2081
path_encoding=path_encoding,
2086
class cmd_deleted(Command):
2087
__doc__ = """List files deleted in the working tree.
2089
# TODO: Show files deleted since a previous revision, or
2090
# between two revisions.
2091
# TODO: Much more efficient way to do this: read in new
2092
# directories with readdir, rather than stating each one. Same
2093
# level of effort but possibly much less IO. (Or possibly not,
2094
# if the directories are very large...)
2095
_see_also = ['status', 'ls']
2096
takes_options = ['directory', 'show-ids']
2099
def run(self, show_ids=False, directory=u'.'):
2100
tree = WorkingTree.open_containing(directory)[0]
2101
self.add_cleanup(tree.lock_read().unlock)
2102
old = tree.basis_tree()
2103
self.add_cleanup(old.lock_read().unlock)
2104
for path, ie in old.inventory.iter_entries():
2105
if not tree.has_id(ie.file_id):
2106
self.outf.write(path)
2108
self.outf.write(' ')
2109
self.outf.write(ie.file_id)
2110
self.outf.write('\n')
2113
class cmd_modified(Command):
2114
__doc__ = """List files modified in working tree.
2118
_see_also = ['status', 'ls']
2119
takes_options = ['directory', 'null']
2122
def run(self, null=False, directory=u'.'):
2123
tree = WorkingTree.open_containing(directory)[0]
2124
self.add_cleanup(tree.lock_read().unlock)
2125
td = tree.changes_from(tree.basis_tree())
2127
for path, id, kind, text_modified, meta_modified in td.modified:
2129
self.outf.write(path + '\0')
2131
self.outf.write(osutils.quotefn(path) + '\n')
2134
class cmd_added(Command):
2135
__doc__ = """List files added in working tree.
2139
_see_also = ['status', 'ls']
2140
takes_options = ['directory', 'null']
2143
def run(self, null=False, directory=u'.'):
2144
wt = WorkingTree.open_containing(directory)[0]
2145
self.add_cleanup(wt.lock_read().unlock)
2146
basis = wt.basis_tree()
2147
self.add_cleanup(basis.lock_read().unlock)
2148
basis_inv = basis.inventory
2151
if file_id in basis_inv:
2153
if inv.is_root(file_id) and len(basis_inv) == 0:
2155
path = inv.id2path(file_id)
2156
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2159
self.outf.write(path + '\0')
2161
self.outf.write(osutils.quotefn(path) + '\n')
2164
class cmd_root(Command):
2165
__doc__ = """Show the tree root directory.
2167
The root is the nearest enclosing directory with a .bzr control
2170
takes_args = ['filename?']
2172
def run(self, filename=None):
2173
"""Print the branch root."""
2174
tree = WorkingTree.open_containing(filename)[0]
2175
self.outf.write(tree.basedir + '\n')
2178
def _parse_limit(limitstring):
2180
return int(limitstring)
2182
msg = "The limit argument must be an integer."
2183
raise errors.BzrCommandError(msg)
2186
def _parse_levels(s):
2190
msg = "The levels argument must be an integer."
2191
raise errors.BzrCommandError(msg)
2194
class cmd_log(Command):
2195
__doc__ = """Show historical log for a branch or subset of a branch.
2197
log is bzr's default tool for exploring the history of a branch.
2198
The branch to use is taken from the first parameter. If no parameters
2199
are given, the branch containing the working directory is logged.
2200
Here are some simple examples::
2202
bzr log log the current branch
2203
bzr log foo.py log a file in its branch
2204
bzr log http://server/branch log a branch on a server
2206
The filtering, ordering and information shown for each revision can
2207
be controlled as explained below. By default, all revisions are
2208
shown sorted (topologically) so that newer revisions appear before
2209
older ones and descendants always appear before ancestors. If displayed,
2210
merged revisions are shown indented under the revision in which they
2215
The log format controls how information about each revision is
2216
displayed. The standard log formats are called ``long``, ``short``
2217
and ``line``. The default is long. See ``bzr help log-formats``
2218
for more details on log formats.
2220
The following options can be used to control what information is
2223
-l N display a maximum of N revisions
2224
-n N display N levels of revisions (0 for all, 1 for collapsed)
2225
-v display a status summary (delta) for each revision
2226
-p display a diff (patch) for each revision
2227
--show-ids display revision-ids (and file-ids), not just revnos
2229
Note that the default number of levels to display is a function of the
2230
log format. If the -n option is not used, the standard log formats show
2231
just the top level (mainline).
2233
Status summaries are shown using status flags like A, M, etc. To see
2234
the changes explained using words like ``added`` and ``modified``
2235
instead, use the -vv option.
2239
To display revisions from oldest to newest, use the --forward option.
2240
In most cases, using this option will have little impact on the total
2241
time taken to produce a log, though --forward does not incrementally
2242
display revisions like --reverse does when it can.
2244
:Revision filtering:
2246
The -r option can be used to specify what revision or range of revisions
2247
to filter against. The various forms are shown below::
2249
-rX display revision X
2250
-rX.. display revision X and later
2251
-r..Y display up to and including revision Y
2252
-rX..Y display from X to Y inclusive
2254
See ``bzr help revisionspec`` for details on how to specify X and Y.
2255
Some common examples are given below::
2257
-r-1 show just the tip
2258
-r-10.. show the last 10 mainline revisions
2259
-rsubmit:.. show what's new on this branch
2260
-rancestor:path.. show changes since the common ancestor of this
2261
branch and the one at location path
2262
-rdate:yesterday.. show changes since yesterday
2264
When logging a range of revisions using -rX..Y, log starts at
2265
revision Y and searches back in history through the primary
2266
("left-hand") parents until it finds X. When logging just the
2267
top level (using -n1), an error is reported if X is not found
2268
along the way. If multi-level logging is used (-n0), X may be
2269
a nested merge revision and the log will be truncated accordingly.
2273
If parameters are given and the first one is not a branch, the log
2274
will be filtered to show only those revisions that changed the
2275
nominated files or directories.
2277
Filenames are interpreted within their historical context. To log a
2278
deleted file, specify a revision range so that the file existed at
2279
the end or start of the range.
2281
Historical context is also important when interpreting pathnames of
2282
renamed files/directories. Consider the following example:
2284
* revision 1: add tutorial.txt
2285
* revision 2: modify tutorial.txt
2286
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2290
* ``bzr log guide.txt`` will log the file added in revision 1
2292
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2294
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2295
the original file in revision 2.
2297
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2298
was no file called guide.txt in revision 2.
2300
Renames are always followed by log. By design, there is no need to
2301
explicitly ask for this (and no way to stop logging a file back
2302
until it was last renamed).
2306
The --message option can be used for finding revisions that match a
2307
regular expression in a commit message.
2311
GUI tools and IDEs are often better at exploring history than command
2312
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2313
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2314
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2315
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2317
You may find it useful to add the aliases below to ``bazaar.conf``::
2321
top = log -l10 --line
2324
``bzr tip`` will then show the latest revision while ``bzr top``
2325
will show the last 10 mainline revisions. To see the details of a
2326
particular revision X, ``bzr show -rX``.
2328
If you are interested in looking deeper into a particular merge X,
2329
use ``bzr log -n0 -rX``.
2331
``bzr log -v`` on a branch with lots of history is currently
2332
very slow. A fix for this issue is currently under development.
2333
With or without that fix, it is recommended that a revision range
2334
be given when using the -v option.
2336
bzr has a generic full-text matching plugin, bzr-search, that can be
2337
used to find revisions matching user names, commit messages, etc.
2338
Among other features, this plugin can find all revisions containing
2339
a list of words but not others.
2341
When exploring non-mainline history on large projects with deep
2342
history, the performance of log can be greatly improved by installing
2343
the historycache plugin. This plugin buffers historical information
2344
trading disk space for faster speed.
2346
takes_args = ['file*']
2347
_see_also = ['log-formats', 'revisionspec']
2350
help='Show from oldest to newest.'),
2352
custom_help('verbose',
2353
help='Show files changed in each revision.'),
2357
type=bzrlib.option._parse_revision_str,
2359
help='Show just the specified revision.'
2360
' See also "help revisionspec".'),
2362
RegistryOption('authors',
2363
'What names to list as authors - first, all or committer.',
2365
lazy_registry=('bzrlib.log', 'author_list_registry'),
2369
help='Number of levels to display - 0 for all, 1 for flat.',
2371
type=_parse_levels),
2374
help='Show revisions whose message matches this '
2375
'regular expression.',
2379
help='Limit the output to the first N revisions.',
2384
help='Show changes made in each revision as a patch.'),
2385
Option('include-merges',
2386
help='Show merged revisions like --levels 0 does.'),
2387
Option('exclude-common-ancestry',
2388
help='Display only the revisions that are not part'
2389
' of both ancestries (require -rX..Y)'
2392
encoding_type = 'replace'
2395
def run(self, file_list=None, timezone='original',
2406
include_merges=False,
2408
exclude_common_ancestry=False,
2410
from bzrlib.log import (
2412
make_log_request_dict,
2413
_get_info_for_log_files,
2415
direction = (forward and 'forward') or 'reverse'
2416
if (exclude_common_ancestry
2417
and (revision is None or len(revision) != 2)):
2418
raise errors.BzrCommandError(
2419
'--exclude-common-ancestry requires -r with two revisions')
2424
raise errors.BzrCommandError(
2425
'--levels and --include-merges are mutually exclusive')
2427
if change is not None:
2429
raise errors.RangeInChangeOption()
2430
if revision is not None:
2431
raise errors.BzrCommandError(
2432
'--revision and --change are mutually exclusive')
2437
filter_by_dir = False
2439
# find the file ids to log and check for directory filtering
2440
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2441
revision, file_list, self.add_cleanup)
2442
for relpath, file_id, kind in file_info_list:
2444
raise errors.BzrCommandError(
2445
"Path unknown at end or start of revision range: %s" %
2447
# If the relpath is the top of the tree, we log everything
2452
file_ids.append(file_id)
2453
filter_by_dir = filter_by_dir or (
2454
kind in ['directory', 'tree-reference'])
2457
# FIXME ? log the current subdir only RBC 20060203
2458
if revision is not None \
2459
and len(revision) > 0 and revision[0].get_branch():
2460
location = revision[0].get_branch()
2463
dir, relpath = bzrdir.BzrDir.open_containing(location)
2464
b = dir.open_branch()
2465
self.add_cleanup(b.lock_read().unlock)
2466
rev1, rev2 = _get_revision_range(revision, b, self.name())
2468
# Decide on the type of delta & diff filtering to use
2469
# TODO: add an --all-files option to make this configurable & consistent
2477
diff_type = 'partial'
2481
# Build the log formatter
2482
if log_format is None:
2483
log_format = log.log_formatter_registry.get_default(b)
2484
# Make a non-encoding output to include the diffs - bug 328007
2485
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2486
lf = log_format(show_ids=show_ids, to_file=self.outf,
2487
to_exact_file=unencoded_output,
2488
show_timezone=timezone,
2489
delta_format=get_verbosity_level(),
2491
show_advice=levels is None,
2492
author_list_handler=authors)
2494
# Choose the algorithm for doing the logging. It's annoying
2495
# having multiple code paths like this but necessary until
2496
# the underlying repository format is faster at generating
2497
# deltas or can provide everything we need from the indices.
2498
# The default algorithm - match-using-deltas - works for
2499
# multiple files and directories and is faster for small
2500
# amounts of history (200 revisions say). However, it's too
2501
# slow for logging a single file in a repository with deep
2502
# history, i.e. > 10K revisions. In the spirit of "do no
2503
# evil when adding features", we continue to use the
2504
# original algorithm - per-file-graph - for the "single
2505
# file that isn't a directory without showing a delta" case.
2506
partial_history = revision and b.repository._format.supports_chks
2507
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2508
or delta_type or partial_history)
2510
# Build the LogRequest and execute it
2511
if len(file_ids) == 0:
2513
rqst = make_log_request_dict(
2514
direction=direction, specific_fileids=file_ids,
2515
start_revision=rev1, end_revision=rev2, limit=limit,
2516
message_search=message, delta_type=delta_type,
2517
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2518
exclude_common_ancestry=exclude_common_ancestry,
2520
Logger(b, rqst).show(lf)
2523
def _get_revision_range(revisionspec_list, branch, command_name):
2524
"""Take the input of a revision option and turn it into a revision range.
2526
It returns RevisionInfo objects which can be used to obtain the rev_id's
2527
of the desired revisions. It does some user input validations.
2529
if revisionspec_list is None:
2532
elif len(revisionspec_list) == 1:
2533
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2534
elif len(revisionspec_list) == 2:
2535
start_spec = revisionspec_list[0]
2536
end_spec = revisionspec_list[1]
2537
if end_spec.get_branch() != start_spec.get_branch():
2538
# b is taken from revision[0].get_branch(), and
2539
# show_log will use its revision_history. Having
2540
# different branches will lead to weird behaviors.
2541
raise errors.BzrCommandError(
2542
"bzr %s doesn't accept two revisions in different"
2543
" branches." % command_name)
2544
if start_spec.spec is None:
2545
# Avoid loading all the history.
2546
rev1 = RevisionInfo(branch, None, None)
2548
rev1 = start_spec.in_history(branch)
2549
# Avoid loading all of history when we know a missing
2550
# end of range means the last revision ...
2551
if end_spec.spec is None:
2552
last_revno, last_revision_id = branch.last_revision_info()
2553
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2555
rev2 = end_spec.in_history(branch)
2557
raise errors.BzrCommandError(
2558
'bzr %s --revision takes one or two values.' % command_name)
2562
def _revision_range_to_revid_range(revision_range):
2565
if revision_range[0] is not None:
2566
rev_id1 = revision_range[0].rev_id
2567
if revision_range[1] is not None:
2568
rev_id2 = revision_range[1].rev_id
2569
return rev_id1, rev_id2
2571
def get_log_format(long=False, short=False, line=False, default='long'):
2572
log_format = default
2576
log_format = 'short'
2582
class cmd_touching_revisions(Command):
2583
__doc__ = """Return revision-ids which affected a particular file.
2585
A more user-friendly interface is "bzr log FILE".
2589
takes_args = ["filename"]
2592
def run(self, filename):
2593
tree, relpath = WorkingTree.open_containing(filename)
2594
file_id = tree.path2id(relpath)
2596
self.add_cleanup(b.lock_read().unlock)
2597
touching_revs = log.find_touching_revisions(b, file_id)
2598
for revno, revision_id, what in touching_revs:
2599
self.outf.write("%6d %s\n" % (revno, what))
2602
class cmd_ls(Command):
2603
__doc__ = """List files in a tree.
2606
_see_also = ['status', 'cat']
2607
takes_args = ['path?']
2611
Option('recursive', short_name='R',
2612
help='Recurse into subdirectories.'),
2614
help='Print paths relative to the root of the branch.'),
2615
Option('unknown', short_name='u',
2616
help='Print unknown files.'),
2617
Option('versioned', help='Print versioned files.',
2619
Option('ignored', short_name='i',
2620
help='Print ignored files.'),
2621
Option('kind', short_name='k',
2622
help='List entries of a particular kind: file, directory, symlink.',
2629
def run(self, revision=None, verbose=False,
2630
recursive=False, from_root=False,
2631
unknown=False, versioned=False, ignored=False,
2632
null=False, kind=None, show_ids=False, path=None, directory=None):
2634
if kind and kind not in ('file', 'directory', 'symlink'):
2635
raise errors.BzrCommandError('invalid kind specified')
2637
if verbose and null:
2638
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2639
all = not (unknown or versioned or ignored)
2641
selection = {'I':ignored, '?':unknown, 'V':versioned}
2647
raise errors.BzrCommandError('cannot specify both --from-root'
2650
tree, branch, relpath = \
2651
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2653
# Calculate the prefix to use
2657
prefix = relpath + '/'
2658
elif fs_path != '.' and not fs_path.endswith('/'):
2659
prefix = fs_path + '/'
2661
if revision is not None or tree is None:
2662
tree = _get_one_revision_tree('ls', revision, branch=branch)
2665
if isinstance(tree, WorkingTree) and tree.supports_views():
2666
view_files = tree.views.lookup_view()
2669
view_str = views.view_display_str(view_files)
2670
note("Ignoring files outside view. View is %s" % view_str)
2672
self.add_cleanup(tree.lock_read().unlock)
2673
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2674
from_dir=relpath, recursive=recursive):
2675
# Apply additional masking
2676
if not all and not selection[fc]:
2678
if kind is not None and fkind != kind:
2683
fullpath = osutils.pathjoin(relpath, fp)
2686
views.check_path_in_view(tree, fullpath)
2687
except errors.FileOutsideView:
2692
fp = osutils.pathjoin(prefix, fp)
2693
kindch = entry.kind_character()
2694
outstring = fp + kindch
2695
ui.ui_factory.clear_term()
2697
outstring = '%-8s %s' % (fc, outstring)
2698
if show_ids and fid is not None:
2699
outstring = "%-50s %s" % (outstring, fid)
2700
self.outf.write(outstring + '\n')
2702
self.outf.write(fp + '\0')
2705
self.outf.write(fid)
2706
self.outf.write('\0')
2714
self.outf.write('%-50s %s\n' % (outstring, my_id))
2716
self.outf.write(outstring + '\n')
2719
class cmd_unknowns(Command):
2720
__doc__ = """List unknown files.
2725
takes_options = ['directory']
2728
def run(self, directory=u'.'):
2729
for f in WorkingTree.open_containing(directory)[0].unknowns():
2730
self.outf.write(osutils.quotefn(f) + '\n')
2733
class cmd_ignore(Command):
2734
__doc__ = """Ignore specified files or patterns.
2736
See ``bzr help patterns`` for details on the syntax of patterns.
2738
If a .bzrignore file does not exist, the ignore command
2739
will create one and add the specified files or patterns to the newly
2740
created file. The ignore command will also automatically add the
2741
.bzrignore file to be versioned. Creating a .bzrignore file without
2742
the use of the ignore command will require an explicit add command.
2744
To remove patterns from the ignore list, edit the .bzrignore file.
2745
After adding, editing or deleting that file either indirectly by
2746
using this command or directly by using an editor, be sure to commit
2749
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2750
the global ignore file can be found in the application data directory as
2751
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2752
Global ignores are not touched by this command. The global ignore file
2753
can be edited directly using an editor.
2755
Patterns prefixed with '!' are exceptions to ignore patterns and take
2756
precedence over regular ignores. Such exceptions are used to specify
2757
files that should be versioned which would otherwise be ignored.
2759
Patterns prefixed with '!!' act as regular ignore patterns, but have
2760
precedence over the '!' exception patterns.
2764
* Ignore patterns containing shell wildcards must be quoted from
2767
* Ignore patterns starting with "#" act as comments in the ignore file.
2768
To ignore patterns that begin with that character, use the "RE:" prefix.
2771
Ignore the top level Makefile::
2773
bzr ignore ./Makefile
2775
Ignore .class files in all directories...::
2777
bzr ignore "*.class"
2779
...but do not ignore "special.class"::
2781
bzr ignore "!special.class"
2783
Ignore files whose name begins with the "#" character::
2787
Ignore .o files under the lib directory::
2789
bzr ignore "lib/**/*.o"
2791
Ignore .o files under the lib directory::
2793
bzr ignore "RE:lib/.*\.o"
2795
Ignore everything but the "debian" toplevel directory::
2797
bzr ignore "RE:(?!debian/).*"
2799
Ignore everything except the "local" toplevel directory,
2800
but always ignore autosave files ending in ~, even under local/::
2803
bzr ignore "!./local"
2807
_see_also = ['status', 'ignored', 'patterns']
2808
takes_args = ['name_pattern*']
2809
takes_options = ['directory',
2810
Option('default-rules',
2811
help='Display the default ignore rules that bzr uses.')
2814
def run(self, name_pattern_list=None, default_rules=None,
2816
from bzrlib import ignores
2817
if default_rules is not None:
2818
# dump the default rules and exit
2819
for pattern in ignores.USER_DEFAULTS:
2820
self.outf.write("%s\n" % pattern)
2822
if not name_pattern_list:
2823
raise errors.BzrCommandError("ignore requires at least one "
2824
"NAME_PATTERN or --default-rules.")
2825
name_pattern_list = [globbing.normalize_pattern(p)
2826
for p in name_pattern_list]
2828
for p in name_pattern_list:
2829
if not globbing.Globster.is_pattern_valid(p):
2830
bad_patterns += ('\n %s' % p)
2832
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2833
ui.ui_factory.show_error(msg)
2834
raise errors.InvalidPattern('')
2835
for name_pattern in name_pattern_list:
2836
if (name_pattern[0] == '/' or
2837
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2838
raise errors.BzrCommandError(
2839
"NAME_PATTERN should not be an absolute path")
2840
tree, relpath = WorkingTree.open_containing(directory)
2841
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2842
ignored = globbing.Globster(name_pattern_list)
2844
self.add_cleanup(tree.lock_read().unlock)
2845
for entry in tree.list_files():
2849
if ignored.match(filename):
2850
matches.append(filename)
2851
if len(matches) > 0:
2852
self.outf.write("Warning: the following files are version controlled and"
2853
" match your ignore pattern:\n%s"
2854
"\nThese files will continue to be version controlled"
2855
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2858
class cmd_ignored(Command):
2859
__doc__ = """List ignored files and the patterns that matched them.
2861
List all the ignored files and the ignore pattern that caused the file to
2864
Alternatively, to list just the files::
2869
encoding_type = 'replace'
2870
_see_also = ['ignore', 'ls']
2871
takes_options = ['directory']
2874
def run(self, directory=u'.'):
2875
tree = WorkingTree.open_containing(directory)[0]
2876
self.add_cleanup(tree.lock_read().unlock)
2877
for path, file_class, kind, file_id, entry in tree.list_files():
2878
if file_class != 'I':
2880
## XXX: Slightly inefficient since this was already calculated
2881
pat = tree.is_ignored(path)
2882
self.outf.write('%-50s %s\n' % (path, pat))
2885
class cmd_lookup_revision(Command):
2886
__doc__ = """Lookup the revision-id from a revision-number
2889
bzr lookup-revision 33
2892
takes_args = ['revno']
2893
takes_options = ['directory']
2896
def run(self, revno, directory=u'.'):
2900
raise errors.BzrCommandError("not a valid revision-number: %r"
2902
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2903
self.outf.write("%s\n" % revid)
2906
class cmd_export(Command):
2907
__doc__ = """Export current or past revision to a destination directory or archive.
2909
If no revision is specified this exports the last committed revision.
2911
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2912
given, try to find the format with the extension. If no extension
2913
is found exports to a directory (equivalent to --format=dir).
2915
If root is supplied, it will be used as the root directory inside
2916
container formats (tar, zip, etc). If it is not supplied it will default
2917
to the exported filename. The root option has no effect for 'dir' format.
2919
If branch is omitted then the branch containing the current working
2920
directory will be used.
2922
Note: Export of tree with non-ASCII filenames to zip is not supported.
2924
================= =========================
2925
Supported formats Autodetected by extension
2926
================= =========================
2929
tbz2 .tar.bz2, .tbz2
2932
================= =========================
2935
takes_args = ['dest', 'branch_or_subdir?']
2936
takes_options = ['directory',
2938
help="Type of file to export to.",
2941
Option('filters', help='Apply content filters to export the '
2942
'convenient form.'),
2945
help="Name of the root directory inside the exported file."),
2946
Option('per-file-timestamps',
2947
help='Set modification time of files to that of the last '
2948
'revision in which it was changed.'),
2950
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2951
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2952
from bzrlib.export import export
2954
if branch_or_subdir is None:
2955
tree = WorkingTree.open_containing(directory)[0]
2959
b, subdir = Branch.open_containing(branch_or_subdir)
2962
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2964
export(rev_tree, dest, format, root, subdir, filtered=filters,
2965
per_file_timestamps=per_file_timestamps)
2966
except errors.NoSuchExportFormat, e:
2967
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2970
class cmd_cat(Command):
2971
__doc__ = """Write the contents of a file as of a given revision to standard output.
2973
If no revision is nominated, the last revision is used.
2975
Note: Take care to redirect standard output when using this command on a
2980
takes_options = ['directory',
2981
Option('name-from-revision', help='The path name in the old tree.'),
2982
Option('filters', help='Apply content filters to display the '
2983
'convenience form.'),
2986
takes_args = ['filename']
2987
encoding_type = 'exact'
2990
def run(self, filename, revision=None, name_from_revision=False,
2991
filters=False, directory=None):
2992
if revision is not None and len(revision) != 1:
2993
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2994
" one revision specifier")
2995
tree, branch, relpath = \
2996
_open_directory_or_containing_tree_or_branch(filename, directory)
2997
self.add_cleanup(branch.lock_read().unlock)
2998
return self._run(tree, branch, relpath, filename, revision,
2999
name_from_revision, filters)
3001
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3004
tree = b.basis_tree()
3005
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3006
self.add_cleanup(rev_tree.lock_read().unlock)
3008
old_file_id = rev_tree.path2id(relpath)
3010
if name_from_revision:
3011
# Try in revision if requested
3012
if old_file_id is None:
3013
raise errors.BzrCommandError(
3014
"%r is not present in revision %s" % (
3015
filename, rev_tree.get_revision_id()))
3017
content = rev_tree.get_file_text(old_file_id)
3019
cur_file_id = tree.path2id(relpath)
3021
if cur_file_id is not None:
3022
# Then try with the actual file id
3024
content = rev_tree.get_file_text(cur_file_id)
3026
except errors.NoSuchId:
3027
# The actual file id didn't exist at that time
3029
if not found and old_file_id is not None:
3030
# Finally try with the old file id
3031
content = rev_tree.get_file_text(old_file_id)
3034
# Can't be found anywhere
3035
raise errors.BzrCommandError(
3036
"%r is not present in revision %s" % (
3037
filename, rev_tree.get_revision_id()))
3039
from bzrlib.filters import (
3040
ContentFilterContext,
3041
filtered_output_bytes,
3043
filters = rev_tree._content_filter_stack(relpath)
3044
chunks = content.splitlines(True)
3045
content = filtered_output_bytes(chunks, filters,
3046
ContentFilterContext(relpath, rev_tree))
3048
self.outf.writelines(content)
3051
self.outf.write(content)
3054
class cmd_local_time_offset(Command):
3055
__doc__ = """Show the offset in seconds from GMT to local time."""
3059
self.outf.write("%s\n" % osutils.local_time_offset())
3063
class cmd_commit(Command):
3064
__doc__ = """Commit changes into a new revision.
3066
An explanatory message needs to be given for each commit. This is
3067
often done by using the --message option (getting the message from the
3068
command line) or by using the --file option (getting the message from
3069
a file). If neither of these options is given, an editor is opened for
3070
the user to enter the message. To see the changed files in the
3071
boilerplate text loaded into the editor, use the --show-diff option.
3073
By default, the entire tree is committed and the person doing the
3074
commit is assumed to be the author. These defaults can be overridden
3079
If selected files are specified, only changes to those files are
3080
committed. If a directory is specified then the directory and
3081
everything within it is committed.
3083
When excludes are given, they take precedence over selected files.
3084
For example, to commit only changes within foo, but not changes
3087
bzr commit foo -x foo/bar
3089
A selective commit after a merge is not yet supported.
3093
If the author of the change is not the same person as the committer,
3094
you can specify the author's name using the --author option. The
3095
name should be in the same format as a committer-id, e.g.
3096
"John Doe <jdoe@example.com>". If there is more than one author of
3097
the change you can specify the option multiple times, once for each
3102
A common mistake is to forget to add a new file or directory before
3103
running the commit command. The --strict option checks for unknown
3104
files and aborts the commit if any are found. More advanced pre-commit
3105
checks can be implemented by defining hooks. See ``bzr help hooks``
3110
If you accidentially commit the wrong changes or make a spelling
3111
mistake in the commit message say, you can use the uncommit command
3112
to undo it. See ``bzr help uncommit`` for details.
3114
Hooks can also be configured to run after a commit. This allows you
3115
to trigger updates to external systems like bug trackers. The --fixes
3116
option can be used to record the association between a revision and
3117
one or more bugs. See ``bzr help bugs`` for details.
3120
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3121
takes_args = ['selected*']
3123
ListOption('exclude', type=str, short_name='x',
3124
help="Do not consider changes made to a given path."),
3125
Option('message', type=unicode,
3127
help="Description of the new revision."),
3130
help='Commit even if nothing has changed.'),
3131
Option('file', type=str,
3134
help='Take commit message from this file.'),
3136
help="Refuse to commit if there are unknown "
3137
"files in the working tree."),
3138
Option('commit-time', type=str,
3139
help="Manually set a commit time using commit date "
3140
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3141
ListOption('fixes', type=str,
3142
help="Mark a bug as being fixed by this revision "
3143
"(see \"bzr help bugs\")."),
3144
ListOption('author', type=unicode,
3145
help="Set the author's name, if it's different "
3146
"from the committer."),
3148
help="Perform a local commit in a bound "
3149
"branch. Local commits are not pushed to "
3150
"the master branch until a normal commit "
3153
Option('show-diff', short_name='p',
3154
help='When no message is supplied, show the diff along'
3155
' with the status summary in the message editor.'),
3157
help='When committing to a foreign version control '
3158
'system do not push data that can not be natively '
3161
aliases = ['ci', 'checkin']
3163
def _iter_bug_fix_urls(self, fixes, branch):
3164
# Configure the properties for bug fixing attributes.
3165
for fixed_bug in fixes:
3166
tokens = fixed_bug.split(':')
3167
if len(tokens) != 2:
3168
raise errors.BzrCommandError(
3169
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3170
"See \"bzr help bugs\" for more information on this "
3171
"feature.\nCommit refused." % fixed_bug)
3172
tag, bug_id = tokens
3174
yield bugtracker.get_bug_url(tag, branch, bug_id)
3175
except errors.UnknownBugTrackerAbbreviation:
3176
raise errors.BzrCommandError(
3177
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3178
except errors.MalformedBugIdentifier, e:
3179
raise errors.BzrCommandError(
3180
"%s\nCommit refused." % (str(e),))
3182
def run(self, message=None, file=None, verbose=False, selected_list=None,
3183
unchanged=False, strict=False, local=False, fixes=None,
3184
author=None, show_diff=False, exclude=None, commit_time=None,
3186
from bzrlib.errors import (
3191
from bzrlib.msgeditor import (
3192
edit_commit_message_encoded,
3193
generate_commit_message_template,
3194
make_commit_message_template_encoded
3197
commit_stamp = offset = None
3198
if commit_time is not None:
3200
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3201
except ValueError, e:
3202
raise errors.BzrCommandError(
3203
"Could not parse --commit-time: " + str(e))
3207
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3208
if selected_list == ['']:
3209
# workaround - commit of root of tree should be exactly the same
3210
# as just default commit in that tree, and succeed even though
3211
# selected-file merge commit is not done yet
3216
bug_property = bugtracker.encode_fixes_bug_urls(
3217
self._iter_bug_fix_urls(fixes, tree.branch))
3219
properties['bugs'] = bug_property
3221
if local and not tree.branch.get_bound_location():
3222
raise errors.LocalRequiresBoundBranch()
3224
if message is not None:
3226
file_exists = osutils.lexists(message)
3227
except UnicodeError:
3228
# The commit message contains unicode characters that can't be
3229
# represented in the filesystem encoding, so that can't be a
3234
'The commit message is a file name: "%(f)s".\n'
3235
'(use --file "%(f)s" to take commit message from that file)'
3237
ui.ui_factory.show_warning(warning_msg)
3239
message = message.replace('\r\n', '\n')
3240
message = message.replace('\r', '\n')
3242
raise errors.BzrCommandError(
3243
"please specify either --message or --file")
3245
def get_message(commit_obj):
3246
"""Callback to get commit message"""
3250
my_message = f.read().decode(osutils.get_user_encoding())
3253
elif message is not None:
3254
my_message = message
3256
# No message supplied: make one up.
3257
# text is the status of the tree
3258
text = make_commit_message_template_encoded(tree,
3259
selected_list, diff=show_diff,
3260
output_encoding=osutils.get_user_encoding())
3261
# start_message is the template generated from hooks
3262
# XXX: Warning - looks like hooks return unicode,
3263
# make_commit_message_template_encoded returns user encoding.
3264
# We probably want to be using edit_commit_message instead to
3266
start_message = generate_commit_message_template(commit_obj)
3267
my_message = edit_commit_message_encoded(text,
3268
start_message=start_message)
3269
if my_message is None:
3270
raise errors.BzrCommandError("please specify a commit"
3271
" message with either --message or --file")
3272
if my_message == "":
3273
raise errors.BzrCommandError("empty commit message specified")
3276
# The API permits a commit with a filter of [] to mean 'select nothing'
3277
# but the command line should not do that.
3278
if not selected_list:
3279
selected_list = None
3281
tree.commit(message_callback=get_message,
3282
specific_files=selected_list,
3283
allow_pointless=unchanged, strict=strict, local=local,
3284
reporter=None, verbose=verbose, revprops=properties,
3285
authors=author, timestamp=commit_stamp,
3287
exclude=tree.safe_relpath_files(exclude),
3289
except PointlessCommit:
3290
raise errors.BzrCommandError("No changes to commit."
3291
" Please 'bzr add' the files you want to commit, or use"
3292
" --unchanged to force an empty commit.")
3293
except ConflictsInTree:
3294
raise errors.BzrCommandError('Conflicts detected in working '
3295
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3297
except StrictCommitFailed:
3298
raise errors.BzrCommandError("Commit refused because there are"
3299
" unknown files in the working tree.")
3300
except errors.BoundBranchOutOfDate, e:
3301
e.extra_help = ("\n"
3302
'To commit to master branch, run update and then commit.\n'
3303
'You can also pass --local to commit to continue working '
3308
class cmd_check(Command):
3309
__doc__ = """Validate working tree structure, branch consistency and repository history.
3311
This command checks various invariants about branch and repository storage
3312
to detect data corruption or bzr bugs.
3314
The working tree and branch checks will only give output if a problem is
3315
detected. The output fields of the repository check are:
3318
This is just the number of revisions checked. It doesn't
3322
This is just the number of versionedfiles checked. It
3323
doesn't indicate a problem.
3325
unreferenced ancestors
3326
Texts that are ancestors of other texts, but
3327
are not properly referenced by the revision ancestry. This is a
3328
subtle problem that Bazaar can work around.
3331
This is the total number of unique file contents
3332
seen in the checked revisions. It does not indicate a problem.
3335
This is the total number of repeated texts seen
3336
in the checked revisions. Texts can be repeated when their file
3337
entries are modified, but the file contents are not. It does not
3340
If no restrictions are specified, all Bazaar data that is found at the given
3341
location will be checked.
3345
Check the tree and branch at 'foo'::
3347
bzr check --tree --branch foo
3349
Check only the repository at 'bar'::
3351
bzr check --repo bar
3353
Check everything at 'baz'::
3358
_see_also = ['reconcile']
3359
takes_args = ['path?']
3360
takes_options = ['verbose',
3361
Option('branch', help="Check the branch related to the"
3362
" current directory."),
3363
Option('repo', help="Check the repository related to the"
3364
" current directory."),
3365
Option('tree', help="Check the working tree related to"
3366
" the current directory.")]
3368
def run(self, path=None, verbose=False, branch=False, repo=False,
3370
from bzrlib.check import check_dwim
3373
if not branch and not repo and not tree:
3374
branch = repo = tree = True
3375
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3378
class cmd_upgrade(Command):
3379
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3381
When the default format has changed after a major new release of
3382
Bazaar, you may be informed during certain operations that you
3383
should upgrade. Upgrading to a newer format may improve performance
3384
or make new features available. It may however limit interoperability
3385
with older repositories or with older versions of Bazaar.
3387
If you wish to upgrade to a particular format rather than the
3388
current default, that can be specified using the --format option.
3389
As a consequence, you can use the upgrade command this way to
3390
"downgrade" to an earlier format, though some conversions are
3391
a one way process (e.g. changing from the 1.x default to the
3392
2.x default) so downgrading is not always possible.
3394
A backup.bzr.~#~ directory is created at the start of the conversion
3395
process (where # is a number). By default, this is left there on
3396
completion. If the conversion fails, delete the new .bzr directory
3397
and rename this one back in its place. Use the --clean option to ask
3398
for the backup.bzr directory to be removed on successful conversion.
3399
Alternatively, you can delete it by hand if everything looks good
3402
If the location given is a shared repository, dependent branches
3403
are also converted provided the repository converts successfully.
3404
If the conversion of a branch fails, remaining branches are still
3407
For more information on upgrades, see the Bazaar Upgrade Guide,
3408
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3411
_see_also = ['check', 'reconcile', 'formats']
3412
takes_args = ['url?']
3414
RegistryOption('format',
3415
help='Upgrade to a specific format. See "bzr help'
3416
' formats" for details.',
3417
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3418
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3419
value_switches=True, title='Branch format'),
3421
help='Remove the backup.bzr directory if successful.'),
3423
help="Show what would be done, but don't actually do anything."),
3426
def run(self, url='.', format=None, clean=False, dry_run=False):
3427
from bzrlib.upgrade import upgrade
3428
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3430
if len(exceptions) == 1:
3431
# Compatibility with historical behavior
3437
class cmd_whoami(Command):
3438
__doc__ = """Show or set bzr user id.
3441
Show the email of the current user::
3445
Set the current user::
3447
bzr whoami "Frank Chu <fchu@example.com>"
3449
takes_options = [ 'directory',
3451
help='Display email address only.'),
3453
help='Set identity for the current branch instead of '
3456
takes_args = ['name?']
3457
encoding_type = 'replace'
3460
def run(self, email=False, branch=False, name=None, directory=None):
3462
if directory is None:
3463
# use branch if we're inside one; otherwise global config
3465
c = Branch.open_containing(u'.')[0].get_config()
3466
except errors.NotBranchError:
3467
c = _mod_config.GlobalConfig()
3469
c = Branch.open(directory).get_config()
3471
self.outf.write(c.user_email() + '\n')
3473
self.outf.write(c.username() + '\n')
3477
raise errors.BzrCommandError("--email can only be used to display existing "
3480
# display a warning if an email address isn't included in the given name.
3482
_mod_config.extract_email_address(name)
3483
except errors.NoEmailInUsername, e:
3484
warning('"%s" does not seem to contain an email address. '
3485
'This is allowed, but not recommended.', name)
3487
# use global config unless --branch given
3489
if directory is None:
3490
c = Branch.open_containing(u'.')[0].get_config()
3492
c = Branch.open(directory).get_config()
3494
c = _mod_config.GlobalConfig()
3495
c.set_user_option('email', name)
3498
class cmd_nick(Command):
3499
__doc__ = """Print or set the branch nickname.
3501
If unset, the tree root directory name is used as the nickname.
3502
To print the current nickname, execute with no argument.
3504
Bound branches use the nickname of its master branch unless it is set
3508
_see_also = ['info']
3509
takes_args = ['nickname?']
3510
takes_options = ['directory']
3511
def run(self, nickname=None, directory=u'.'):
3512
branch = Branch.open_containing(directory)[0]
3513
if nickname is None:
3514
self.printme(branch)
3516
branch.nick = nickname
3519
def printme(self, branch):
3520
self.outf.write('%s\n' % branch.nick)
3523
class cmd_alias(Command):
3524
__doc__ = """Set/unset and display aliases.
3527
Show the current aliases::
3531
Show the alias specified for 'll'::
3535
Set an alias for 'll'::
3537
bzr alias ll="log --line -r-10..-1"
3539
To remove an alias for 'll'::
3541
bzr alias --remove ll
3544
takes_args = ['name?']
3546
Option('remove', help='Remove the alias.'),
3549
def run(self, name=None, remove=False):
3551
self.remove_alias(name)
3553
self.print_aliases()
3555
equal_pos = name.find('=')
3557
self.print_alias(name)
3559
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3561
def remove_alias(self, alias_name):
3562
if alias_name is None:
3563
raise errors.BzrCommandError(
3564
'bzr alias --remove expects an alias to remove.')
3565
# If alias is not found, print something like:
3566
# unalias: foo: not found
3567
c = _mod_config.GlobalConfig()
3568
c.unset_alias(alias_name)
3571
def print_aliases(self):
3572
"""Print out the defined aliases in a similar format to bash."""
3573
aliases = _mod_config.GlobalConfig().get_aliases()
3574
for key, value in sorted(aliases.iteritems()):
3575
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3578
def print_alias(self, alias_name):
3579
from bzrlib.commands import get_alias
3580
alias = get_alias(alias_name)
3582
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3585
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3587
def set_alias(self, alias_name, alias_command):
3588
"""Save the alias in the global config."""
3589
c = _mod_config.GlobalConfig()
3590
c.set_alias(alias_name, alias_command)
3593
class cmd_selftest(Command):
3594
__doc__ = """Run internal test suite.
3596
If arguments are given, they are regular expressions that say which tests
3597
should run. Tests matching any expression are run, and other tests are
3600
Alternatively if --first is given, matching tests are run first and then
3601
all other tests are run. This is useful if you have been working in a
3602
particular area, but want to make sure nothing else was broken.
3604
If --exclude is given, tests that match that regular expression are
3605
excluded, regardless of whether they match --first or not.
3607
To help catch accidential dependencies between tests, the --randomize
3608
option is useful. In most cases, the argument used is the word 'now'.
3609
Note that the seed used for the random number generator is displayed
3610
when this option is used. The seed can be explicitly passed as the
3611
argument to this option if required. This enables reproduction of the
3612
actual ordering used if and when an order sensitive problem is encountered.
3614
If --list-only is given, the tests that would be run are listed. This is
3615
useful when combined with --first, --exclude and/or --randomize to
3616
understand their impact. The test harness reports "Listed nn tests in ..."
3617
instead of "Ran nn tests in ..." when list mode is enabled.
3619
If the global option '--no-plugins' is given, plugins are not loaded
3620
before running the selftests. This has two effects: features provided or
3621
modified by plugins will not be tested, and tests provided by plugins will
3624
Tests that need working space on disk use a common temporary directory,
3625
typically inside $TMPDIR or /tmp.
3627
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3628
into a pdb postmortem session.
3630
The --coverage=DIRNAME global option produces a report with covered code
3634
Run only tests relating to 'ignore'::
3638
Disable plugins and list tests as they're run::
3640
bzr --no-plugins selftest -v
3642
# NB: this is used from the class without creating an instance, which is
3643
# why it does not have a self parameter.
3644
def get_transport_type(typestring):
3645
"""Parse and return a transport specifier."""
3646
if typestring == "sftp":
3647
from bzrlib.tests import stub_sftp
3648
return stub_sftp.SFTPAbsoluteServer
3649
if typestring == "memory":
3650
from bzrlib.tests import test_server
3651
return memory.MemoryServer
3652
if typestring == "fakenfs":
3653
from bzrlib.tests import test_server
3654
return test_server.FakeNFSServer
3655
msg = "No known transport type %s. Supported types are: sftp\n" %\
3657
raise errors.BzrCommandError(msg)
3660
takes_args = ['testspecs*']
3661
takes_options = ['verbose',
3663
help='Stop when one test fails.',
3667
help='Use a different transport by default '
3668
'throughout the test suite.',
3669
type=get_transport_type),
3671
help='Run the benchmarks rather than selftests.',
3673
Option('lsprof-timed',
3674
help='Generate lsprof output for benchmarked'
3675
' sections of code.'),
3676
Option('lsprof-tests',
3677
help='Generate lsprof output for each test.'),
3679
help='Run all tests, but run specified tests first.',
3683
help='List the tests instead of running them.'),
3684
RegistryOption('parallel',
3685
help="Run the test suite in parallel.",
3686
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3687
value_switches=False,
3689
Option('randomize', type=str, argname="SEED",
3690
help='Randomize the order of tests using the given'
3691
' seed or "now" for the current time.'),
3692
Option('exclude', type=str, argname="PATTERN",
3694
help='Exclude tests that match this regular'
3697
help='Output test progress via subunit.'),
3698
Option('strict', help='Fail on missing dependencies or '
3700
Option('load-list', type=str, argname='TESTLISTFILE',
3701
help='Load a test id list from a text file.'),
3702
ListOption('debugflag', type=str, short_name='E',
3703
help='Turn on a selftest debug flag.'),
3704
ListOption('starting-with', type=str, argname='TESTID',
3705
param_name='starting_with', short_name='s',
3707
'Load only the tests starting with TESTID.'),
3709
encoding_type = 'replace'
3712
Command.__init__(self)
3713
self.additional_selftest_args = {}
3715
def run(self, testspecs_list=None, verbose=False, one=False,
3716
transport=None, benchmark=None,
3718
first=False, list_only=False,
3719
randomize=None, exclude=None, strict=False,
3720
load_list=None, debugflag=None, starting_with=None, subunit=False,
3721
parallel=None, lsprof_tests=False):
3722
from bzrlib import tests
3724
if testspecs_list is not None:
3725
pattern = '|'.join(testspecs_list)
3730
from bzrlib.tests import SubUnitBzrRunner
3732
raise errors.BzrCommandError("subunit not available. subunit "
3733
"needs to be installed to use --subunit.")
3734
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3735
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3736
# stdout, which would corrupt the subunit stream.
3737
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3738
# following code can be deleted when it's sufficiently deployed
3739
# -- vila/mgz 20100514
3740
if (sys.platform == "win32"
3741
and getattr(sys.stdout, 'fileno', None) is not None):
3743
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3745
self.additional_selftest_args.setdefault(
3746
'suite_decorators', []).append(parallel)
3748
raise errors.BzrCommandError(
3749
"--benchmark is no longer supported from bzr 2.2; "
3750
"use bzr-usertest instead")
3751
test_suite_factory = None
3752
selftest_kwargs = {"verbose": verbose,
3754
"stop_on_failure": one,
3755
"transport": transport,
3756
"test_suite_factory": test_suite_factory,
3757
"lsprof_timed": lsprof_timed,
3758
"lsprof_tests": lsprof_tests,
3759
"matching_tests_first": first,
3760
"list_only": list_only,
3761
"random_seed": randomize,
3762
"exclude_pattern": exclude,
3764
"load_list": load_list,
3765
"debug_flags": debugflag,
3766
"starting_with": starting_with
3768
selftest_kwargs.update(self.additional_selftest_args)
3770
# Make deprecation warnings visible, unless -Werror is set
3771
cleanup = symbol_versioning.activate_deprecation_warnings(
3774
result = tests.selftest(**selftest_kwargs)
3777
return int(not result)
3780
class cmd_version(Command):
3781
__doc__ = """Show version of bzr."""
3783
encoding_type = 'replace'
3785
Option("short", help="Print just the version number."),
3789
def run(self, short=False):
3790
from bzrlib.version import show_version
3792
self.outf.write(bzrlib.version_string + '\n')
3794
show_version(to_file=self.outf)
3797
class cmd_rocks(Command):
3798
__doc__ = """Statement of optimism."""
3804
self.outf.write("It sure does!\n")
3807
class cmd_find_merge_base(Command):
3808
__doc__ = """Find and print a base revision for merging two branches."""
3809
# TODO: Options to specify revisions on either side, as if
3810
# merging only part of the history.
3811
takes_args = ['branch', 'other']
3815
def run(self, branch, other):
3816
from bzrlib.revision import ensure_null
3818
branch1 = Branch.open_containing(branch)[0]
3819
branch2 = Branch.open_containing(other)[0]
3820
self.add_cleanup(branch1.lock_read().unlock)
3821
self.add_cleanup(branch2.lock_read().unlock)
3822
last1 = ensure_null(branch1.last_revision())
3823
last2 = ensure_null(branch2.last_revision())
3825
graph = branch1.repository.get_graph(branch2.repository)
3826
base_rev_id = graph.find_unique_lca(last1, last2)
3828
self.outf.write('merge base is revision %s\n' % base_rev_id)
3831
class cmd_merge(Command):
3832
__doc__ = """Perform a three-way merge.
3834
The source of the merge can be specified either in the form of a branch,
3835
or in the form of a path to a file containing a merge directive generated
3836
with bzr send. If neither is specified, the default is the upstream branch
3837
or the branch most recently merged using --remember.
3839
When merging from a branch, by default bzr will try to merge in all new
3840
work from the other branch, automatically determining an appropriate base
3841
revision. If this fails, you may need to give an explicit base.
3843
To pick a different ending revision, pass "--revision OTHER". bzr will
3844
try to merge in all new work up to and including revision OTHER.
3846
If you specify two values, "--revision BASE..OTHER", only revisions BASE
3847
through OTHER, excluding BASE but including OTHER, will be merged. If this
3848
causes some revisions to be skipped, i.e. if the destination branch does
3849
not already contain revision BASE, such a merge is commonly referred to as
3850
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
3851
cherrypicks. The changes look like a normal commit, and the history of the
3852
changes from the other branch is not stored in the commit.
3854
Revision numbers are always relative to the source branch.
3856
Merge will do its best to combine the changes in two branches, but there
3857
are some kinds of problems only a human can fix. When it encounters those,
3858
it will mark a conflict. A conflict means that you need to fix something,
3859
before you should commit.
3861
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3863
If there is no default branch set, the first merge will set it (use
3864
--no-remember to avoid settting it). After that, you can omit the branch
3865
to use the default. To change the default, use --remember. The value will
3866
only be saved if the remote location can be accessed.
3868
The results of the merge are placed into the destination working
3869
directory, where they can be reviewed (with bzr diff), tested, and then
3870
committed to record the result of the merge.
3872
merge refuses to run if there are any uncommitted changes, unless
3873
--force is given. The --force option can also be used to create a
3874
merge revision which has more than two parents.
3876
If one would like to merge changes from the working tree of the other
3877
branch without merging any committed revisions, the --uncommitted option
3880
To select only some changes to merge, use "merge -i", which will prompt
3881
you to apply each diff hunk and file change, similar to "shelve".
3884
To merge all new revisions from bzr.dev::
3886
bzr merge ../bzr.dev
3888
To merge changes up to and including revision 82 from bzr.dev::
3890
bzr merge -r 82 ../bzr.dev
3892
To merge the changes introduced by 82, without previous changes::
3894
bzr merge -r 81..82 ../bzr.dev
3896
To apply a merge directive contained in /tmp/merge::
3898
bzr merge /tmp/merge
3900
To create a merge revision with three parents from two branches
3901
feature1a and feature1b:
3903
bzr merge ../feature1a
3904
bzr merge ../feature1b --force
3905
bzr commit -m 'revision with three parents'
3908
encoding_type = 'exact'
3909
_see_also = ['update', 'remerge', 'status-flags', 'send']
3910
takes_args = ['location?']
3915
help='Merge even if the destination tree has uncommitted changes.'),
3919
Option('show-base', help="Show base revision text in "
3921
Option('uncommitted', help='Apply uncommitted changes'
3922
' from a working copy, instead of branch changes.'),
3923
Option('pull', help='If the destination is already'
3924
' completely merged into the source, pull from the'
3925
' source rather than merging. When this happens,'
3926
' you do not need to commit the result.'),
3927
custom_help('directory',
3928
help='Branch to merge into, '
3929
'rather than the one containing the working directory.'),
3930
Option('preview', help='Instead of merging, show a diff of the'
3932
Option('interactive', help='Select changes interactively.',
3936
def run(self, location=None, revision=None, force=False,
3937
merge_type=None, show_base=False, reprocess=None, remember=None,
3938
uncommitted=False, pull=False,
3943
if merge_type is None:
3944
merge_type = _mod_merge.Merge3Merger
3946
if directory is None: directory = u'.'
3947
possible_transports = []
3949
allow_pending = True
3950
verified = 'inapplicable'
3952
tree = WorkingTree.open_containing(directory)[0]
3953
if tree.branch.revno() == 0:
3954
raise errors.BzrCommandError('Merging into empty branches not currently supported, '
3955
'https://bugs.launchpad.net/bzr/+bug/308562')
3958
basis_tree = tree.revision_tree(tree.last_revision())
3959
except errors.NoSuchRevision:
3960
basis_tree = tree.basis_tree()
3962
# die as quickly as possible if there are uncommitted changes
3964
if tree.has_changes():
3965
raise errors.UncommittedChanges(tree)
3967
view_info = _get_view_info_for_change_reporter(tree)
3968
change_reporter = delta._ChangeReporter(
3969
unversioned_filter=tree.is_ignored, view_info=view_info)
3970
pb = ui.ui_factory.nested_progress_bar()
3971
self.add_cleanup(pb.finished)
3972
self.add_cleanup(tree.lock_write().unlock)
3973
if location is not None:
3975
mergeable = bundle.read_mergeable_from_url(location,
3976
possible_transports=possible_transports)
3977
except errors.NotABundle:
3981
raise errors.BzrCommandError('Cannot use --uncommitted'
3982
' with bundles or merge directives.')
3984
if revision is not None:
3985
raise errors.BzrCommandError(
3986
'Cannot use -r with merge directives or bundles')
3987
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3990
if merger is None and uncommitted:
3991
if revision is not None and len(revision) > 0:
3992
raise errors.BzrCommandError('Cannot use --uncommitted and'
3993
' --revision at the same time.')
3994
merger = self.get_merger_from_uncommitted(tree, location, None)
3995
allow_pending = False
3998
merger, allow_pending = self._get_merger_from_branch(tree,
3999
location, revision, remember, possible_transports, None)
4001
merger.merge_type = merge_type
4002
merger.reprocess = reprocess
4003
merger.show_base = show_base
4004
self.sanity_check_merger(merger)
4005
if (merger.base_rev_id == merger.other_rev_id and
4006
merger.other_rev_id is not None):
4007
note('Nothing to do.')
4009
if pull and not preview:
4010
if merger.interesting_files is not None:
4011
raise errors.BzrCommandError('Cannot pull individual files')
4012
if (merger.base_rev_id == tree.last_revision()):
4013
result = tree.pull(merger.other_branch, False,
4014
merger.other_rev_id)
4015
result.report(self.outf)
4017
if merger.this_basis is None:
4018
raise errors.BzrCommandError(
4019
"This branch has no commits."
4020
" (perhaps you would prefer 'bzr pull')")
4022
return self._do_preview(merger)
4024
return self._do_interactive(merger)
4026
return self._do_merge(merger, change_reporter, allow_pending,
4029
def _get_preview(self, merger):
4030
tree_merger = merger.make_merger()
4031
tt = tree_merger.make_preview_transform()
4032
self.add_cleanup(tt.finalize)
4033
result_tree = tt.get_preview_tree()
4036
def _do_preview(self, merger):
4037
from bzrlib.diff import show_diff_trees
4038
result_tree = self._get_preview(merger)
4039
path_encoding = osutils.get_diff_header_encoding()
4040
show_diff_trees(merger.this_tree, result_tree, self.outf,
4041
old_label='', new_label='',
4042
path_encoding=path_encoding)
4044
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4045
merger.change_reporter = change_reporter
4046
conflict_count = merger.do_merge()
4048
merger.set_pending()
4049
if verified == 'failed':
4050
warning('Preview patch does not match changes')
4051
if conflict_count != 0:
4056
def _do_interactive(self, merger):
4057
"""Perform an interactive merge.
4059
This works by generating a preview tree of the merge, then using
4060
Shelver to selectively remove the differences between the working tree
4061
and the preview tree.
4063
from bzrlib import shelf_ui
4064
result_tree = self._get_preview(merger)
4065
writer = bzrlib.option.diff_writer_registry.get()
4066
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4067
reporter=shelf_ui.ApplyReporter(),
4068
diff_writer=writer(sys.stdout))
4074
def sanity_check_merger(self, merger):
4075
if (merger.show_base and
4076
not merger.merge_type is _mod_merge.Merge3Merger):
4077
raise errors.BzrCommandError("Show-base is not supported for this"
4078
" merge type. %s" % merger.merge_type)
4079
if merger.reprocess is None:
4080
if merger.show_base:
4081
merger.reprocess = False
4083
# Use reprocess if the merger supports it
4084
merger.reprocess = merger.merge_type.supports_reprocess
4085
if merger.reprocess and not merger.merge_type.supports_reprocess:
4086
raise errors.BzrCommandError("Conflict reduction is not supported"
4087
" for merge type %s." %
4089
if merger.reprocess and merger.show_base:
4090
raise errors.BzrCommandError("Cannot do conflict reduction and"
4093
def _get_merger_from_branch(self, tree, location, revision, remember,
4094
possible_transports, pb):
4095
"""Produce a merger from a location, assuming it refers to a branch."""
4096
from bzrlib.tag import _merge_tags_if_possible
4097
# find the branch locations
4098
other_loc, user_location = self._select_branch_location(tree, location,
4100
if revision is not None and len(revision) == 2:
4101
base_loc, _unused = self._select_branch_location(tree,
4102
location, revision, 0)
4104
base_loc = other_loc
4106
other_branch, other_path = Branch.open_containing(other_loc,
4107
possible_transports)
4108
if base_loc == other_loc:
4109
base_branch = other_branch
4111
base_branch, base_path = Branch.open_containing(base_loc,
4112
possible_transports)
4113
# Find the revision ids
4114
other_revision_id = None
4115
base_revision_id = None
4116
if revision is not None:
4117
if len(revision) >= 1:
4118
other_revision_id = revision[-1].as_revision_id(other_branch)
4119
if len(revision) == 2:
4120
base_revision_id = revision[0].as_revision_id(base_branch)
4121
if other_revision_id is None:
4122
other_revision_id = _mod_revision.ensure_null(
4123
other_branch.last_revision())
4124
# Remember where we merge from. We need to remember if:
4125
# - user specify a location (and we don't merge from the parent
4127
# - user ask to remember or there is no previous location set to merge
4128
# from and user didn't ask to *not* remember
4129
if (user_location is not None
4131
or (remember is None
4132
and tree.branch.get_submit_branch() is None)))):
4133
tree.branch.set_submit_branch(other_branch.base)
4134
# Merge tags (but don't set them in the master branch yet, the user
4135
# might revert this merge). Commit will propagate them.
4136
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4137
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4138
other_revision_id, base_revision_id, other_branch, base_branch)
4139
if other_path != '':
4140
allow_pending = False
4141
merger.interesting_files = [other_path]
4143
allow_pending = True
4144
return merger, allow_pending
4146
def get_merger_from_uncommitted(self, tree, location, pb):
4147
"""Get a merger for uncommitted changes.
4149
:param tree: The tree the merger should apply to.
4150
:param location: The location containing uncommitted changes.
4151
:param pb: The progress bar to use for showing progress.
4153
location = self._select_branch_location(tree, location)[0]
4154
other_tree, other_path = WorkingTree.open_containing(location)
4155
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4156
if other_path != '':
4157
merger.interesting_files = [other_path]
4160
def _select_branch_location(self, tree, user_location, revision=None,
4162
"""Select a branch location, according to possible inputs.
4164
If provided, branches from ``revision`` are preferred. (Both
4165
``revision`` and ``index`` must be supplied.)
4167
Otherwise, the ``location`` parameter is used. If it is None, then the
4168
``submit`` or ``parent`` location is used, and a note is printed.
4170
:param tree: The working tree to select a branch for merging into
4171
:param location: The location entered by the user
4172
:param revision: The revision parameter to the command
4173
:param index: The index to use for the revision parameter. Negative
4174
indices are permitted.
4175
:return: (selected_location, user_location). The default location
4176
will be the user-entered location.
4178
if (revision is not None and index is not None
4179
and revision[index] is not None):
4180
branch = revision[index].get_branch()
4181
if branch is not None:
4182
return branch, branch
4183
if user_location is None:
4184
location = self._get_remembered(tree, 'Merging from')
4186
location = user_location
4187
return location, user_location
4189
def _get_remembered(self, tree, verb_string):
4190
"""Use tree.branch's parent if none was supplied.
4192
Report if the remembered location was used.
4194
stored_location = tree.branch.get_submit_branch()
4195
stored_location_type = "submit"
4196
if stored_location is None:
4197
stored_location = tree.branch.get_parent()
4198
stored_location_type = "parent"
4199
mutter("%s", stored_location)
4200
if stored_location is None:
4201
raise errors.BzrCommandError("No location specified or remembered")
4202
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4203
note(u"%s remembered %s location %s", verb_string,
4204
stored_location_type, display_url)
4205
return stored_location
4208
class cmd_remerge(Command):
4209
__doc__ = """Redo a merge.
4211
Use this if you want to try a different merge technique while resolving
4212
conflicts. Some merge techniques are better than others, and remerge
4213
lets you try different ones on different files.
4215
The options for remerge have the same meaning and defaults as the ones for
4216
merge. The difference is that remerge can (only) be run when there is a
4217
pending merge, and it lets you specify particular files.
4220
Re-do the merge of all conflicted files, and show the base text in
4221
conflict regions, in addition to the usual THIS and OTHER texts::
4223
bzr remerge --show-base
4225
Re-do the merge of "foobar", using the weave merge algorithm, with
4226
additional processing to reduce the size of conflict regions::
4228
bzr remerge --merge-type weave --reprocess foobar
4230
takes_args = ['file*']
4235
help="Show base revision text in conflicts."),
4238
def run(self, file_list=None, merge_type=None, show_base=False,
4240
from bzrlib.conflicts import restore
4241
if merge_type is None:
4242
merge_type = _mod_merge.Merge3Merger
4243
tree, file_list = WorkingTree.open_containing_paths(file_list)
4244
self.add_cleanup(tree.lock_write().unlock)
4245
parents = tree.get_parent_ids()
4246
if len(parents) != 2:
4247
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4248
" merges. Not cherrypicking or"
4250
repository = tree.branch.repository
4251
interesting_ids = None
4253
conflicts = tree.conflicts()
4254
if file_list is not None:
4255
interesting_ids = set()
4256
for filename in file_list:
4257
file_id = tree.path2id(filename)
4259
raise errors.NotVersionedError(filename)
4260
interesting_ids.add(file_id)
4261
if tree.kind(file_id) != "directory":
4264
for name, ie in tree.inventory.iter_entries(file_id):
4265
interesting_ids.add(ie.file_id)
4266
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4268
# Remerge only supports resolving contents conflicts
4269
allowed_conflicts = ('text conflict', 'contents conflict')
4270
restore_files = [c.path for c in conflicts
4271
if c.typestring in allowed_conflicts]
4272
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4273
tree.set_conflicts(ConflictList(new_conflicts))
4274
if file_list is not None:
4275
restore_files = file_list
4276
for filename in restore_files:
4278
restore(tree.abspath(filename))
4279
except errors.NotConflicted:
4281
# Disable pending merges, because the file texts we are remerging
4282
# have not had those merges performed. If we use the wrong parents
4283
# list, we imply that the working tree text has seen and rejected
4284
# all the changes from the other tree, when in fact those changes
4285
# have not yet been seen.
4286
tree.set_parent_ids(parents[:1])
4288
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4289
merger.interesting_ids = interesting_ids
4290
merger.merge_type = merge_type
4291
merger.show_base = show_base
4292
merger.reprocess = reprocess
4293
conflicts = merger.do_merge()
4295
tree.set_parent_ids(parents)
4302
class cmd_revert(Command):
4303
__doc__ = """Revert files to a previous revision.
4305
Giving a list of files will revert only those files. Otherwise, all files
4306
will be reverted. If the revision is not specified with '--revision', the
4307
last committed revision is used.
4309
To remove only some changes, without reverting to a prior version, use
4310
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4311
will remove the changes introduced by the second last commit (-2), without
4312
affecting the changes introduced by the last commit (-1). To remove
4313
certain changes on a hunk-by-hunk basis, see the shelve command.
4315
By default, any files that have been manually changed will be backed up
4316
first. (Files changed only by merge are not backed up.) Backup files have
4317
'.~#~' appended to their name, where # is a number.
4319
When you provide files, you can use their current pathname or the pathname
4320
from the target revision. So you can use revert to "undelete" a file by
4321
name. If you name a directory, all the contents of that directory will be
4324
If you have newly added files since the target revision, they will be
4325
removed. If the files to be removed have been changed, backups will be
4326
created as above. Directories containing unknown files will not be
4329
The working tree contains a list of revisions that have been merged but
4330
not yet committed. These revisions will be included as additional parents
4331
of the next commit. Normally, using revert clears that list as well as
4332
reverting the files. If any files are specified, revert leaves the list
4333
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4334
.`` in the tree root to revert all files but keep the recorded merges,
4335
and ``bzr revert --forget-merges`` to clear the pending merge list without
4336
reverting any files.
4338
Using "bzr revert --forget-merges", it is possible to apply all of the
4339
changes from a branch in a single revision. To do this, perform the merge
4340
as desired. Then doing revert with the "--forget-merges" option will keep
4341
the content of the tree as it was, but it will clear the list of pending
4342
merges. The next commit will then contain all of the changes that are
4343
present in the other branch, but without any other parent revisions.
4344
Because this technique forgets where these changes originated, it may
4345
cause additional conflicts on later merges involving the same source and
4349
_see_also = ['cat', 'export', 'merge', 'shelve']
4352
Option('no-backup', "Do not save backups of reverted files."),
4353
Option('forget-merges',
4354
'Remove pending merge marker, without changing any files.'),
4356
takes_args = ['file*']
4358
def run(self, revision=None, no_backup=False, file_list=None,
4359
forget_merges=None):
4360
tree, file_list = WorkingTree.open_containing_paths(file_list)
4361
self.add_cleanup(tree.lock_tree_write().unlock)
4363
tree.set_parent_ids(tree.get_parent_ids()[:1])
4365
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4368
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4369
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4370
tree.revert(file_list, rev_tree, not no_backup, None,
4371
report_changes=True)
4374
class cmd_assert_fail(Command):
4375
__doc__ = """Test reporting of assertion failures"""
4376
# intended just for use in testing
4381
raise AssertionError("always fails")
4384
class cmd_help(Command):
4385
__doc__ = """Show help on a command or other topic.
4388
_see_also = ['topics']
4390
Option('long', 'Show help on all commands.'),
4392
takes_args = ['topic?']
4393
aliases = ['?', '--help', '-?', '-h']
4396
def run(self, topic=None, long=False):
4398
if topic is None and long:
4400
bzrlib.help.help(topic)
4403
class cmd_shell_complete(Command):
4404
__doc__ = """Show appropriate completions for context.
4406
For a list of all available commands, say 'bzr shell-complete'.
4408
takes_args = ['context?']
4413
def run(self, context=None):
4414
import shellcomplete
4415
shellcomplete.shellcomplete(context)
4418
class cmd_missing(Command):
4419
__doc__ = """Show unmerged/unpulled revisions between two branches.
4421
OTHER_BRANCH may be local or remote.
4423
To filter on a range of revisions, you can use the command -r begin..end
4424
-r revision requests a specific revision, -r ..end or -r begin.. are
4428
1 - some missing revisions
4429
0 - no missing revisions
4433
Determine the missing revisions between this and the branch at the
4434
remembered pull location::
4438
Determine the missing revisions between this and another branch::
4440
bzr missing http://server/branch
4442
Determine the missing revisions up to a specific revision on the other
4445
bzr missing -r ..-10
4447
Determine the missing revisions up to a specific revision on this
4450
bzr missing --my-revision ..-10
4453
_see_also = ['merge', 'pull']
4454
takes_args = ['other_branch?']
4457
Option('reverse', 'Reverse the order of revisions.'),
4459
'Display changes in the local branch only.'),
4460
Option('this' , 'Same as --mine-only.'),
4461
Option('theirs-only',
4462
'Display changes in the remote branch only.'),
4463
Option('other', 'Same as --theirs-only.'),
4467
custom_help('revision',
4468
help='Filter on other branch revisions (inclusive). '
4469
'See "help revisionspec" for details.'),
4470
Option('my-revision',
4471
type=_parse_revision_str,
4472
help='Filter on local branch revisions (inclusive). '
4473
'See "help revisionspec" for details.'),
4474
Option('include-merges',
4475
'Show all revisions in addition to the mainline ones.'),
4477
encoding_type = 'replace'
4480
def run(self, other_branch=None, reverse=False, mine_only=False,
4482
log_format=None, long=False, short=False, line=False,
4483
show_ids=False, verbose=False, this=False, other=False,
4484
include_merges=False, revision=None, my_revision=None,
4486
from bzrlib.missing import find_unmerged, iter_log_revisions
4495
# TODO: We should probably check that we don't have mine-only and
4496
# theirs-only set, but it gets complicated because we also have
4497
# this and other which could be used.
4504
local_branch = Branch.open_containing(directory)[0]
4505
self.add_cleanup(local_branch.lock_read().unlock)
4507
parent = local_branch.get_parent()
4508
if other_branch is None:
4509
other_branch = parent
4510
if other_branch is None:
4511
raise errors.BzrCommandError("No peer location known"
4513
display_url = urlutils.unescape_for_display(parent,
4515
message("Using saved parent location: "
4516
+ display_url + "\n")
4518
remote_branch = Branch.open(other_branch)
4519
if remote_branch.base == local_branch.base:
4520
remote_branch = local_branch
4522
self.add_cleanup(remote_branch.lock_read().unlock)
4524
local_revid_range = _revision_range_to_revid_range(
4525
_get_revision_range(my_revision, local_branch,
4528
remote_revid_range = _revision_range_to_revid_range(
4529
_get_revision_range(revision,
4530
remote_branch, self.name()))
4532
local_extra, remote_extra = find_unmerged(
4533
local_branch, remote_branch, restrict,
4534
backward=not reverse,
4535
include_merges=include_merges,
4536
local_revid_range=local_revid_range,
4537
remote_revid_range=remote_revid_range)
4539
if log_format is None:
4540
registry = log.log_formatter_registry
4541
log_format = registry.get_default(local_branch)
4542
lf = log_format(to_file=self.outf,
4544
show_timezone='original')
4547
if local_extra and not theirs_only:
4548
message("You have %d extra revision(s):\n" %
4550
for revision in iter_log_revisions(local_extra,
4551
local_branch.repository,
4553
lf.log_revision(revision)
4554
printed_local = True
4557
printed_local = False
4559
if remote_extra and not mine_only:
4560
if printed_local is True:
4562
message("You are missing %d revision(s):\n" %
4564
for revision in iter_log_revisions(remote_extra,
4565
remote_branch.repository,
4567
lf.log_revision(revision)
4570
if mine_only and not local_extra:
4571
# We checked local, and found nothing extra
4572
message('This branch is up to date.\n')
4573
elif theirs_only and not remote_extra:
4574
# We checked remote, and found nothing extra
4575
message('Other branch is up to date.\n')
4576
elif not (mine_only or theirs_only or local_extra or
4578
# We checked both branches, and neither one had extra
4580
message("Branches are up to date.\n")
4582
if not status_code and parent is None and other_branch is not None:
4583
self.add_cleanup(local_branch.lock_write().unlock)
4584
# handle race conditions - a parent might be set while we run.
4585
if local_branch.get_parent() is None:
4586
local_branch.set_parent(remote_branch.base)
4590
class cmd_pack(Command):
4591
__doc__ = """Compress the data within a repository.
4593
This operation compresses the data within a bazaar repository. As
4594
bazaar supports automatic packing of repository, this operation is
4595
normally not required to be done manually.
4597
During the pack operation, bazaar takes a backup of existing repository
4598
data, i.e. pack files. This backup is eventually removed by bazaar
4599
automatically when it is safe to do so. To save disk space by removing
4600
the backed up pack files, the --clean-obsolete-packs option may be
4603
Warning: If you use --clean-obsolete-packs and your machine crashes
4604
during or immediately after repacking, you may be left with a state
4605
where the deletion has been written to disk but the new packs have not
4606
been. In this case the repository may be unusable.
4609
_see_also = ['repositories']
4610
takes_args = ['branch_or_repo?']
4612
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4615
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4616
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4618
branch = dir.open_branch()
4619
repository = branch.repository
4620
except errors.NotBranchError:
4621
repository = dir.open_repository()
4622
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4625
class cmd_plugins(Command):
4626
__doc__ = """List the installed plugins.
4628
This command displays the list of installed plugins including
4629
version of plugin and a short description of each.
4631
--verbose shows the path where each plugin is located.
4633
A plugin is an external component for Bazaar that extends the
4634
revision control system, by adding or replacing code in Bazaar.
4635
Plugins can do a variety of things, including overriding commands,
4636
adding new commands, providing additional network transports and
4637
customizing log output.
4639
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4640
for further information on plugins including where to find them and how to
4641
install them. Instructions are also provided there on how to write new
4642
plugins using the Python programming language.
4644
takes_options = ['verbose']
4647
def run(self, verbose=False):
4648
from bzrlib import plugin
4649
# Don't give writelines a generator as some codecs don't like that
4650
self.outf.writelines(
4651
list(plugin.describe_plugins(show_paths=verbose)))
4654
class cmd_testament(Command):
4655
__doc__ = """Show testament (signing-form) of a revision."""
4658
Option('long', help='Produce long-format testament.'),
4660
help='Produce a strict-format testament.')]
4661
takes_args = ['branch?']
4663
def run(self, branch=u'.', revision=None, long=False, strict=False):
4664
from bzrlib.testament import Testament, StrictTestament
4666
testament_class = StrictTestament
4668
testament_class = Testament
4670
b = Branch.open_containing(branch)[0]
4672
b = Branch.open(branch)
4673
self.add_cleanup(b.lock_read().unlock)
4674
if revision is None:
4675
rev_id = b.last_revision()
4677
rev_id = revision[0].as_revision_id(b)
4678
t = testament_class.from_revision(b.repository, rev_id)
4680
sys.stdout.writelines(t.as_text_lines())
4682
sys.stdout.write(t.as_short_text())
4685
class cmd_annotate(Command):
4686
__doc__ = """Show the origin of each line in a file.
4688
This prints out the given file with an annotation on the left side
4689
indicating which revision, author and date introduced the change.
4691
If the origin is the same for a run of consecutive lines, it is
4692
shown only at the top, unless the --all option is given.
4694
# TODO: annotate directories; showing when each file was last changed
4695
# TODO: if the working copy is modified, show annotations on that
4696
# with new uncommitted lines marked
4697
aliases = ['ann', 'blame', 'praise']
4698
takes_args = ['filename']
4699
takes_options = [Option('all', help='Show annotations on all lines.'),
4700
Option('long', help='Show commit date in annotations.'),
4705
encoding_type = 'exact'
4708
def run(self, filename, all=False, long=False, revision=None,
4709
show_ids=False, directory=None):
4710
from bzrlib.annotate import (
4713
wt, branch, relpath = \
4714
_open_directory_or_containing_tree_or_branch(filename, directory)
4716
self.add_cleanup(wt.lock_read().unlock)
4718
self.add_cleanup(branch.lock_read().unlock)
4719
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4720
self.add_cleanup(tree.lock_read().unlock)
4721
if wt is not None and revision is None:
4722
file_id = wt.path2id(relpath)
4724
file_id = tree.path2id(relpath)
4726
raise errors.NotVersionedError(filename)
4727
if wt is not None and revision is None:
4728
# If there is a tree and we're not annotating historical
4729
# versions, annotate the working tree's content.
4730
annotate_file_tree(wt, file_id, self.outf, long, all,
4733
annotate_file_tree(tree, file_id, self.outf, long, all,
4734
show_ids=show_ids, branch=branch)
4737
class cmd_re_sign(Command):
4738
__doc__ = """Create a digital signature for an existing revision."""
4739
# TODO be able to replace existing ones.
4741
hidden = True # is this right ?
4742
takes_args = ['revision_id*']
4743
takes_options = ['directory', 'revision']
4745
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4746
if revision_id_list is not None and revision is not None:
4747
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4748
if revision_id_list is None and revision is None:
4749
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4750
b = WorkingTree.open_containing(directory)[0].branch
4751
self.add_cleanup(b.lock_write().unlock)
4752
return self._run(b, revision_id_list, revision)
4754
def _run(self, b, revision_id_list, revision):
4755
import bzrlib.gpg as gpg
4756
gpg_strategy = gpg.GPGStrategy(b.get_config())
4757
if revision_id_list is not None:
4758
b.repository.start_write_group()
4760
for revision_id in revision_id_list:
4761
b.repository.sign_revision(revision_id, gpg_strategy)
4763
b.repository.abort_write_group()
4766
b.repository.commit_write_group()
4767
elif revision is not None:
4768
if len(revision) == 1:
4769
revno, rev_id = revision[0].in_history(b)
4770
b.repository.start_write_group()
4772
b.repository.sign_revision(rev_id, gpg_strategy)
4774
b.repository.abort_write_group()
4777
b.repository.commit_write_group()
4778
elif len(revision) == 2:
4779
# are they both on rh- if so we can walk between them
4780
# might be nice to have a range helper for arbitrary
4781
# revision paths. hmm.
4782
from_revno, from_revid = revision[0].in_history(b)
4783
to_revno, to_revid = revision[1].in_history(b)
4784
if to_revid is None:
4785
to_revno = b.revno()
4786
if from_revno is None or to_revno is None:
4787
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4788
b.repository.start_write_group()
4790
for revno in range(from_revno, to_revno + 1):
4791
b.repository.sign_revision(b.get_rev_id(revno),
4794
b.repository.abort_write_group()
4797
b.repository.commit_write_group()
4799
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4802
class cmd_bind(Command):
4803
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4804
If no branch is supplied, rebind to the last bound location.
4806
Once converted into a checkout, commits must succeed on the master branch
4807
before they will be applied to the local branch.
4809
Bound branches use the nickname of its master branch unless it is set
4810
locally, in which case binding will update the local nickname to be
4814
_see_also = ['checkouts', 'unbind']
4815
takes_args = ['location?']
4816
takes_options = ['directory']
4818
def run(self, location=None, directory=u'.'):
4819
b, relpath = Branch.open_containing(directory)
4820
if location is None:
4822
location = b.get_old_bound_location()
4823
except errors.UpgradeRequired:
4824
raise errors.BzrCommandError('No location supplied. '
4825
'This format does not remember old locations.')
4827
if location is None:
4828
if b.get_bound_location() is not None:
4829
raise errors.BzrCommandError('Branch is already bound')
4831
raise errors.BzrCommandError('No location supplied '
4832
'and no previous location known')
4833
b_other = Branch.open(location)
4836
except errors.DivergedBranches:
4837
raise errors.BzrCommandError('These branches have diverged.'
4838
' Try merging, and then bind again.')
4839
if b.get_config().has_explicit_nickname():
4840
b.nick = b_other.nick
4843
class cmd_unbind(Command):
4844
__doc__ = """Convert the current checkout into a regular branch.
4846
After unbinding, the local branch is considered independent and subsequent
4847
commits will be local only.
4850
_see_also = ['checkouts', 'bind']
4852
takes_options = ['directory']
4854
def run(self, directory=u'.'):
4855
b, relpath = Branch.open_containing(directory)
4857
raise errors.BzrCommandError('Local branch is not bound')
4860
class cmd_uncommit(Command):
4861
__doc__ = """Remove the last committed revision.
4863
--verbose will print out what is being removed.
4864
--dry-run will go through all the motions, but not actually
4867
If --revision is specified, uncommit revisions to leave the branch at the
4868
specified revision. For example, "bzr uncommit -r 15" will leave the
4869
branch at revision 15.
4871
Uncommit leaves the working tree ready for a new commit. The only change
4872
it may make is to restore any pending merges that were present before
4876
# TODO: jam 20060108 Add an option to allow uncommit to remove
4877
# unreferenced information in 'branch-as-repository' branches.
4878
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4879
# information in shared branches as well.
4880
_see_also = ['commit']
4881
takes_options = ['verbose', 'revision',
4882
Option('dry-run', help='Don\'t actually make changes.'),
4883
Option('force', help='Say yes to all questions.'),
4885
help="Only remove the commits from the local branch"
4886
" when in a checkout."
4889
takes_args = ['location?']
4891
encoding_type = 'replace'
4893
def run(self, location=None,
4894
dry_run=False, verbose=False,
4895
revision=None, force=False, local=False):
4896
if location is None:
4898
control, relpath = bzrdir.BzrDir.open_containing(location)
4900
tree = control.open_workingtree()
4902
except (errors.NoWorkingTree, errors.NotLocalUrl):
4904
b = control.open_branch()
4906
if tree is not None:
4907
self.add_cleanup(tree.lock_write().unlock)
4909
self.add_cleanup(b.lock_write().unlock)
4910
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4912
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4913
from bzrlib.log import log_formatter, show_log
4914
from bzrlib.uncommit import uncommit
4916
last_revno, last_rev_id = b.last_revision_info()
4919
if revision is None:
4921
rev_id = last_rev_id
4923
# 'bzr uncommit -r 10' actually means uncommit
4924
# so that the final tree is at revno 10.
4925
# but bzrlib.uncommit.uncommit() actually uncommits
4926
# the revisions that are supplied.
4927
# So we need to offset it by one
4928
revno = revision[0].in_history(b).revno + 1
4929
if revno <= last_revno:
4930
rev_id = b.get_rev_id(revno)
4932
if rev_id is None or _mod_revision.is_null(rev_id):
4933
self.outf.write('No revisions to uncommit.\n')
4936
lf = log_formatter('short',
4938
show_timezone='original')
4943
direction='forward',
4944
start_revision=revno,
4945
end_revision=last_revno)
4948
self.outf.write('Dry-run, pretending to remove'
4949
' the above revisions.\n')
4951
self.outf.write('The above revision(s) will be removed.\n')
4954
if not ui.ui_factory.confirm_action(
4955
'Uncommit these revisions',
4956
'bzrlib.builtins.uncommit',
4958
self.outf.write('Canceled\n')
4961
mutter('Uncommitting from {%s} to {%s}',
4962
last_rev_id, rev_id)
4963
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4964
revno=revno, local=local)
4965
self.outf.write('You can restore the old tip by running:\n'
4966
' bzr pull . -r revid:%s\n' % last_rev_id)
4969
class cmd_break_lock(Command):
4970
__doc__ = """Break a dead lock.
4972
This command breaks a lock on a repository, branch, working directory or
4975
CAUTION: Locks should only be broken when you are sure that the process
4976
holding the lock has been stopped.
4978
You can get information on what locks are open via the 'bzr info
4979
[location]' command.
4983
bzr break-lock bzr+ssh://example.com/bzr/foo
4984
bzr break-lock --conf ~/.bazaar
4987
takes_args = ['location?']
4990
help='LOCATION is the directory where the config lock is.'),
4992
help='Do not ask for confirmation before breaking the lock.'),
4995
def run(self, location=None, config=False, force=False):
4996
if location is None:
4999
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5001
{'bzrlib.lockdir.break': True})
5003
conf = _mod_config.LockableConfig(file_name=location)
5006
control, relpath = bzrdir.BzrDir.open_containing(location)
5008
control.break_lock()
5009
except NotImplementedError:
5013
class cmd_wait_until_signalled(Command):
5014
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5016
This just prints a line to signal when it is ready, then blocks on stdin.
5022
sys.stdout.write("running\n")
5024
sys.stdin.readline()
5027
class cmd_serve(Command):
5028
__doc__ = """Run the bzr server."""
5030
aliases = ['server']
5034
help='Serve on stdin/out for use from inetd or sshd.'),
5035
RegistryOption('protocol',
5036
help="Protocol to serve.",
5037
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5038
value_switches=True),
5040
help='Listen for connections on nominated port of the form '
5041
'[hostname:]portnumber. Passing 0 as the port number will '
5042
'result in a dynamically allocated port. The default port '
5043
'depends on the protocol.',
5045
custom_help('directory',
5046
help='Serve contents of this directory.'),
5047
Option('allow-writes',
5048
help='By default the server is a readonly server. Supplying '
5049
'--allow-writes enables write access to the contents of '
5050
'the served directory and below. Note that ``bzr serve`` '
5051
'does not perform authentication, so unless some form of '
5052
'external authentication is arranged supplying this '
5053
'option leads to global uncontrolled write access to your '
5058
def get_host_and_port(self, port):
5059
"""Return the host and port to run the smart server on.
5061
If 'port' is None, None will be returned for the host and port.
5063
If 'port' has a colon in it, the string before the colon will be
5064
interpreted as the host.
5066
:param port: A string of the port to run the server on.
5067
:return: A tuple of (host, port), where 'host' is a host name or IP,
5068
and port is an integer TCP/IP port.
5071
if port is not None:
5073
host, port = port.split(':')
5077
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5079
from bzrlib import transport
5080
if directory is None:
5081
directory = os.getcwd()
5082
if protocol is None:
5083
protocol = transport.transport_server_registry.get()
5084
host, port = self.get_host_and_port(port)
5085
url = urlutils.local_path_to_url(directory)
5086
if not allow_writes:
5087
url = 'readonly+' + url
5088
t = transport.get_transport(url)
5089
protocol(t, host, port, inet)
5092
class cmd_join(Command):
5093
__doc__ = """Combine a tree into its containing tree.
5095
This command requires the target tree to be in a rich-root format.
5097
The TREE argument should be an independent tree, inside another tree, but
5098
not part of it. (Such trees can be produced by "bzr split", but also by
5099
running "bzr branch" with the target inside a tree.)
5101
The result is a combined tree, with the subtree no longer an independent
5102
part. This is marked as a merge of the subtree into the containing tree,
5103
and all history is preserved.
5106
_see_also = ['split']
5107
takes_args = ['tree']
5109
Option('reference', help='Join by reference.', hidden=True),
5112
def run(self, tree, reference=False):
5113
sub_tree = WorkingTree.open(tree)
5114
parent_dir = osutils.dirname(sub_tree.basedir)
5115
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5116
repo = containing_tree.branch.repository
5117
if not repo.supports_rich_root():
5118
raise errors.BzrCommandError(
5119
"Can't join trees because %s doesn't support rich root data.\n"
5120
"You can use bzr upgrade on the repository."
5124
containing_tree.add_reference(sub_tree)
5125
except errors.BadReferenceTarget, e:
5126
# XXX: Would be better to just raise a nicely printable
5127
# exception from the real origin. Also below. mbp 20070306
5128
raise errors.BzrCommandError("Cannot join %s. %s" %
5132
containing_tree.subsume(sub_tree)
5133
except errors.BadSubsumeSource, e:
5134
raise errors.BzrCommandError("Cannot join %s. %s" %
5138
class cmd_split(Command):
5139
__doc__ = """Split a subdirectory of a tree into a separate tree.
5141
This command will produce a target tree in a format that supports
5142
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5143
converted into earlier formats like 'dirstate-tags'.
5145
The TREE argument should be a subdirectory of a working tree. That
5146
subdirectory will be converted into an independent tree, with its own
5147
branch. Commits in the top-level tree will not apply to the new subtree.
5150
_see_also = ['join']
5151
takes_args = ['tree']
5153
def run(self, tree):
5154
containing_tree, subdir = WorkingTree.open_containing(tree)
5155
sub_id = containing_tree.path2id(subdir)
5157
raise errors.NotVersionedError(subdir)
5159
containing_tree.extract(sub_id)
5160
except errors.RootNotRich:
5161
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5164
class cmd_merge_directive(Command):
5165
__doc__ = """Generate a merge directive for auto-merge tools.
5167
A directive requests a merge to be performed, and also provides all the
5168
information necessary to do so. This means it must either include a
5169
revision bundle, or the location of a branch containing the desired
5172
A submit branch (the location to merge into) must be supplied the first
5173
time the command is issued. After it has been supplied once, it will
5174
be remembered as the default.
5176
A public branch is optional if a revision bundle is supplied, but required
5177
if --diff or --plain is specified. It will be remembered as the default
5178
after the first use.
5181
takes_args = ['submit_branch?', 'public_branch?']
5185
_see_also = ['send']
5189
RegistryOption.from_kwargs('patch-type',
5190
'The type of patch to include in the directive.',
5192
value_switches=True,
5194
bundle='Bazaar revision bundle (default).',
5195
diff='Normal unified diff.',
5196
plain='No patch, just directive.'),
5197
Option('sign', help='GPG-sign the directive.'), 'revision',
5198
Option('mail-to', type=str,
5199
help='Instead of printing the directive, email to this address.'),
5200
Option('message', type=str, short_name='m',
5201
help='Message to use when committing this merge.')
5204
encoding_type = 'exact'
5206
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5207
sign=False, revision=None, mail_to=None, message=None,
5209
from bzrlib.revision import ensure_null, NULL_REVISION
5210
include_patch, include_bundle = {
5211
'plain': (False, False),
5212
'diff': (True, False),
5213
'bundle': (True, True),
5215
branch = Branch.open(directory)
5216
stored_submit_branch = branch.get_submit_branch()
5217
if submit_branch is None:
5218
submit_branch = stored_submit_branch
5220
if stored_submit_branch is None:
5221
branch.set_submit_branch(submit_branch)
5222
if submit_branch is None:
5223
submit_branch = branch.get_parent()
5224
if submit_branch is None:
5225
raise errors.BzrCommandError('No submit branch specified or known')
5227
stored_public_branch = branch.get_public_branch()
5228
if public_branch is None:
5229
public_branch = stored_public_branch
5230
elif stored_public_branch is None:
5231
branch.set_public_branch(public_branch)
5232
if not include_bundle and public_branch is None:
5233
raise errors.BzrCommandError('No public branch specified or'
5235
base_revision_id = None
5236
if revision is not None:
5237
if len(revision) > 2:
5238
raise errors.BzrCommandError('bzr merge-directive takes '
5239
'at most two one revision identifiers')
5240
revision_id = revision[-1].as_revision_id(branch)
5241
if len(revision) == 2:
5242
base_revision_id = revision[0].as_revision_id(branch)
5244
revision_id = branch.last_revision()
5245
revision_id = ensure_null(revision_id)
5246
if revision_id == NULL_REVISION:
5247
raise errors.BzrCommandError('No revisions to bundle.')
5248
directive = merge_directive.MergeDirective2.from_objects(
5249
branch.repository, revision_id, time.time(),
5250
osutils.local_time_offset(), submit_branch,
5251
public_branch=public_branch, include_patch=include_patch,
5252
include_bundle=include_bundle, message=message,
5253
base_revision_id=base_revision_id)
5256
self.outf.write(directive.to_signed(branch))
5258
self.outf.writelines(directive.to_lines())
5260
message = directive.to_email(mail_to, branch, sign)
5261
s = SMTPConnection(branch.get_config())
5262
s.send_email(message)
5265
class cmd_send(Command):
5266
__doc__ = """Mail or create a merge-directive for submitting changes.
5268
A merge directive provides many things needed for requesting merges:
5270
* A machine-readable description of the merge to perform
5272
* An optional patch that is a preview of the changes requested
5274
* An optional bundle of revision data, so that the changes can be applied
5275
directly from the merge directive, without retrieving data from a
5278
`bzr send` creates a compact data set that, when applied using bzr
5279
merge, has the same effect as merging from the source branch.
5281
By default the merge directive is self-contained and can be applied to any
5282
branch containing submit_branch in its ancestory without needing access to
5285
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5286
revisions, but only a structured request to merge from the
5287
public_location. In that case the public_branch is needed and it must be
5288
up-to-date and accessible to the recipient. The public_branch is always
5289
included if known, so that people can check it later.
5291
The submit branch defaults to the parent of the source branch, but can be
5292
overridden. Both submit branch and public branch will be remembered in
5293
branch.conf the first time they are used for a particular branch. The
5294
source branch defaults to that containing the working directory, but can
5295
be changed using --from.
5297
Both the submit branch and the public branch follow the usual behavior with
5298
respect to --remember: If there is no default location set, the first send
5299
will set it (use --no-remember to avoid settting it). After that, you can
5300
omit the location to use the default. To change the default, use
5301
--remember. The value will only be saved if the location can be accessed.
5303
In order to calculate those changes, bzr must analyse the submit branch.
5304
Therefore it is most efficient for the submit branch to be a local mirror.
5305
If a public location is known for the submit_branch, that location is used
5306
in the merge directive.
5308
The default behaviour is to send the merge directive by mail, unless -o is
5309
given, in which case it is sent to a file.
5311
Mail is sent using your preferred mail program. This should be transparent
5312
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5313
If the preferred client can't be found (or used), your editor will be used.
5315
To use a specific mail program, set the mail_client configuration option.
5316
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5317
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5318
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5319
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5322
If mail is being sent, a to address is required. This can be supplied
5323
either on the commandline, by setting the submit_to configuration
5324
option in the branch itself or the child_submit_to configuration option
5325
in the submit branch.
5327
Two formats are currently supported: "4" uses revision bundle format 4 and
5328
merge directive format 2. It is significantly faster and smaller than
5329
older formats. It is compatible with Bazaar 0.19 and later. It is the
5330
default. "0.9" uses revision bundle format 0.9 and merge directive
5331
format 1. It is compatible with Bazaar 0.12 - 0.18.
5333
The merge directives created by bzr send may be applied using bzr merge or
5334
bzr pull by specifying a file containing a merge directive as the location.
5336
bzr send makes extensive use of public locations to map local locations into
5337
URLs that can be used by other people. See `bzr help configuration` to
5338
set them, and use `bzr info` to display them.
5341
encoding_type = 'exact'
5343
_see_also = ['merge', 'pull']
5345
takes_args = ['submit_branch?', 'public_branch?']
5349
help='Do not include a bundle in the merge directive.'),
5350
Option('no-patch', help='Do not include a preview patch in the merge'
5353
help='Remember submit and public branch.'),
5355
help='Branch to generate the submission from, '
5356
'rather than the one containing the working directory.',
5359
Option('output', short_name='o',
5360
help='Write merge directive to this file or directory; '
5361
'use - for stdout.',
5364
help='Refuse to send if there are uncommitted changes in'
5365
' the working tree, --no-strict disables the check.'),
5366
Option('mail-to', help='Mail the request to this address.',
5370
Option('body', help='Body for the email.', type=unicode),
5371
RegistryOption('format',
5372
help='Use the specified output format.',
5373
lazy_registry=('bzrlib.send', 'format_registry')),
5376
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5377
no_patch=False, revision=None, remember=None, output=None,
5378
format=None, mail_to=None, message=None, body=None,
5379
strict=None, **kwargs):
5380
from bzrlib.send import send
5381
return send(submit_branch, revision, public_branch, remember,
5382
format, no_bundle, no_patch, output,
5383
kwargs.get('from', '.'), mail_to, message, body,
5388
class cmd_bundle_revisions(cmd_send):
5389
__doc__ = """Create a merge-directive for submitting changes.
5391
A merge directive provides many things needed for requesting merges:
5393
* A machine-readable description of the merge to perform
5395
* An optional patch that is a preview of the changes requested
5397
* An optional bundle of revision data, so that the changes can be applied
5398
directly from the merge directive, without retrieving data from a
5401
If --no-bundle is specified, then public_branch is needed (and must be
5402
up-to-date), so that the receiver can perform the merge using the
5403
public_branch. The public_branch is always included if known, so that
5404
people can check it later.
5406
The submit branch defaults to the parent, but can be overridden. Both
5407
submit branch and public branch will be remembered if supplied.
5409
If a public_branch is known for the submit_branch, that public submit
5410
branch is used in the merge instructions. This means that a local mirror
5411
can be used as your actual submit branch, once you have set public_branch
5414
Two formats are currently supported: "4" uses revision bundle format 4 and
5415
merge directive format 2. It is significantly faster and smaller than
5416
older formats. It is compatible with Bazaar 0.19 and later. It is the
5417
default. "0.9" uses revision bundle format 0.9 and merge directive
5418
format 1. It is compatible with Bazaar 0.12 - 0.18.
5423
help='Do not include a bundle in the merge directive.'),
5424
Option('no-patch', help='Do not include a preview patch in the merge'
5427
help='Remember submit and public branch.'),
5429
help='Branch to generate the submission from, '
5430
'rather than the one containing the working directory.',
5433
Option('output', short_name='o', help='Write directive to this file.',
5436
help='Refuse to bundle revisions if there are uncommitted'
5437
' changes in the working tree, --no-strict disables the check.'),
5439
RegistryOption('format',
5440
help='Use the specified output format.',
5441
lazy_registry=('bzrlib.send', 'format_registry')),
5443
aliases = ['bundle']
5445
_see_also = ['send', 'merge']
5449
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5450
no_patch=False, revision=None, remember=False, output=None,
5451
format=None, strict=None, **kwargs):
5454
from bzrlib.send import send
5455
return send(submit_branch, revision, public_branch, remember,
5456
format, no_bundle, no_patch, output,
5457
kwargs.get('from', '.'), None, None, None,
5458
self.outf, strict=strict)
5461
class cmd_tag(Command):
5462
__doc__ = """Create, remove or modify a tag naming a revision.
5464
Tags give human-meaningful names to revisions. Commands that take a -r
5465
(--revision) option can be given -rtag:X, where X is any previously
5468
Tags are stored in the branch. Tags are copied from one branch to another
5469
along when you branch, push, pull or merge.
5471
It is an error to give a tag name that already exists unless you pass
5472
--force, in which case the tag is moved to point to the new revision.
5474
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5475
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5477
If no tag name is specified it will be determined through the
5478
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5479
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5483
_see_also = ['commit', 'tags']
5484
takes_args = ['tag_name?']
5487
help='Delete this tag rather than placing it.',
5489
custom_help('directory',
5490
help='Branch in which to place the tag.'),
5492
help='Replace existing tags.',
5497
def run(self, tag_name=None,
5503
branch, relpath = Branch.open_containing(directory)
5504
self.add_cleanup(branch.lock_write().unlock)
5506
if tag_name is None:
5507
raise errors.BzrCommandError("No tag specified to delete.")
5508
branch.tags.delete_tag(tag_name)
5509
note('Deleted tag %s.' % tag_name)
5512
if len(revision) != 1:
5513
raise errors.BzrCommandError(
5514
"Tags can only be placed on a single revision, "
5516
revision_id = revision[0].as_revision_id(branch)
5518
revision_id = branch.last_revision()
5519
if tag_name is None:
5520
tag_name = branch.automatic_tag_name(revision_id)
5521
if tag_name is None:
5522
raise errors.BzrCommandError(
5523
"Please specify a tag name.")
5524
if (not force) and branch.tags.has_tag(tag_name):
5525
raise errors.TagAlreadyExists(tag_name)
5526
branch.tags.set_tag(tag_name, revision_id)
5527
note('Created tag %s.' % tag_name)
5530
class cmd_tags(Command):
5531
__doc__ = """List tags.
5533
This command shows a table of tag names and the revisions they reference.
5538
custom_help('directory',
5539
help='Branch whose tags should be displayed.'),
5540
RegistryOption('sort',
5541
'Sort tags by different criteria.', title='Sorting',
5542
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5549
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5550
from bzrlib.tag import tag_sort_methods
5551
branch, relpath = Branch.open_containing(directory)
5553
tags = branch.tags.get_tag_dict().items()
5557
self.add_cleanup(branch.lock_read().unlock)
5559
graph = branch.repository.get_graph()
5560
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5561
revid1, revid2 = rev1.rev_id, rev2.rev_id
5562
# only show revisions between revid1 and revid2 (inclusive)
5563
tags = [(tag, revid) for tag, revid in tags if
5564
graph.is_between(revid, revid1, revid2)]
5566
sort = tag_sort_methods.get()
5569
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5570
for index, (tag, revid) in enumerate(tags):
5572
revno = branch.revision_id_to_dotted_revno(revid)
5573
if isinstance(revno, tuple):
5574
revno = '.'.join(map(str, revno))
5575
except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
5576
# Bad tag data/merges can lead to tagged revisions
5577
# which are not in this branch. Fail gracefully ...
5579
tags[index] = (tag, revno)
5581
for tag, revspec in tags:
5582
self.outf.write('%-20s %s\n' % (tag, revspec))
5585
class cmd_reconfigure(Command):
5586
__doc__ = """Reconfigure the type of a bzr directory.
5588
A target configuration must be specified.
5590
For checkouts, the bind-to location will be auto-detected if not specified.
5591
The order of preference is
5592
1. For a lightweight checkout, the current bound location.
5593
2. For branches that used to be checkouts, the previously-bound location.
5594
3. The push location.
5595
4. The parent location.
5596
If none of these is available, --bind-to must be specified.
5599
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5600
takes_args = ['location?']
5602
RegistryOption.from_kwargs(
5604
title='Target type',
5605
help='The type to reconfigure the directory to.',
5606
value_switches=True, enum_switch=False,
5607
branch='Reconfigure to be an unbound branch with no working tree.',
5608
tree='Reconfigure to be an unbound branch with a working tree.',
5609
checkout='Reconfigure to be a bound branch with a working tree.',
5610
lightweight_checkout='Reconfigure to be a lightweight'
5611
' checkout (with no local history).',
5612
standalone='Reconfigure to be a standalone branch '
5613
'(i.e. stop using shared repository).',
5614
use_shared='Reconfigure to use a shared repository.',
5615
with_trees='Reconfigure repository to create '
5616
'working trees on branches by default.',
5617
with_no_trees='Reconfigure repository to not create '
5618
'working trees on branches by default.'
5620
Option('bind-to', help='Branch to bind checkout to.', type=str),
5622
help='Perform reconfiguration even if local changes'
5624
Option('stacked-on',
5625
help='Reconfigure a branch to be stacked on another branch.',
5629
help='Reconfigure a branch to be unstacked. This '
5630
'may require copying substantial data into it.',
5634
def run(self, location=None, target_type=None, bind_to=None, force=False,
5637
directory = bzrdir.BzrDir.open(location)
5638
if stacked_on and unstacked:
5639
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5640
elif stacked_on is not None:
5641
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5643
reconfigure.ReconfigureUnstacked().apply(directory)
5644
# At the moment you can use --stacked-on and a different
5645
# reconfiguration shape at the same time; there seems no good reason
5647
if target_type is None:
5648
if stacked_on or unstacked:
5651
raise errors.BzrCommandError('No target configuration '
5653
elif target_type == 'branch':
5654
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5655
elif target_type == 'tree':
5656
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5657
elif target_type == 'checkout':
5658
reconfiguration = reconfigure.Reconfigure.to_checkout(
5660
elif target_type == 'lightweight-checkout':
5661
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5663
elif target_type == 'use-shared':
5664
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5665
elif target_type == 'standalone':
5666
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5667
elif target_type == 'with-trees':
5668
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5670
elif target_type == 'with-no-trees':
5671
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5673
reconfiguration.apply(force)
5676
class cmd_switch(Command):
5677
__doc__ = """Set the branch of a checkout and update.
5679
For lightweight checkouts, this changes the branch being referenced.
5680
For heavyweight checkouts, this checks that there are no local commits
5681
versus the current bound branch, then it makes the local branch a mirror
5682
of the new location and binds to it.
5684
In both cases, the working tree is updated and uncommitted changes
5685
are merged. The user can commit or revert these as they desire.
5687
Pending merges need to be committed or reverted before using switch.
5689
The path to the branch to switch to can be specified relative to the parent
5690
directory of the current branch. For example, if you are currently in a
5691
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5694
Bound branches use the nickname of its master branch unless it is set
5695
locally, in which case switching will update the local nickname to be
5699
takes_args = ['to_location?']
5700
takes_options = ['directory',
5702
help='Switch even if local commits will be lost.'),
5704
Option('create-branch', short_name='b',
5705
help='Create the target branch from this one before'
5706
' switching to it.'),
5709
def run(self, to_location=None, force=False, create_branch=False,
5710
revision=None, directory=u'.'):
5711
from bzrlib import switch
5712
tree_location = directory
5713
revision = _get_one_revision('switch', revision)
5714
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5715
if to_location is None:
5716
if revision is None:
5717
raise errors.BzrCommandError('You must supply either a'
5718
' revision or a location')
5719
to_location = tree_location
5721
branch = control_dir.open_branch()
5722
had_explicit_nick = branch.get_config().has_explicit_nickname()
5723
except errors.NotBranchError:
5725
had_explicit_nick = False
5728
raise errors.BzrCommandError('cannot create branch without'
5730
to_location = directory_service.directories.dereference(
5732
if '/' not in to_location and '\\' not in to_location:
5733
# This path is meant to be relative to the existing branch
5734
this_url = self._get_branch_location(control_dir)
5735
to_location = urlutils.join(this_url, '..', to_location)
5736
to_branch = branch.bzrdir.sprout(to_location,
5737
possible_transports=[branch.bzrdir.root_transport],
5738
source_branch=branch).open_branch()
5741
to_branch = Branch.open(to_location)
5742
except errors.NotBranchError:
5743
this_url = self._get_branch_location(control_dir)
5744
to_branch = Branch.open(
5745
urlutils.join(this_url, '..', to_location))
5746
if revision is not None:
5747
revision = revision.as_revision_id(to_branch)
5748
switch.switch(control_dir, to_branch, force, revision_id=revision)
5749
if had_explicit_nick:
5750
branch = control_dir.open_branch() #get the new branch!
5751
branch.nick = to_branch.nick
5752
note('Switched to branch: %s',
5753
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5755
def _get_branch_location(self, control_dir):
5756
"""Return location of branch for this control dir."""
5758
this_branch = control_dir.open_branch()
5759
# This may be a heavy checkout, where we want the master branch
5760
master_location = this_branch.get_bound_location()
5761
if master_location is not None:
5762
return master_location
5763
# If not, use a local sibling
5764
return this_branch.base
5765
except errors.NotBranchError:
5766
format = control_dir.find_branch_format()
5767
if getattr(format, 'get_reference', None) is not None:
5768
return format.get_reference(control_dir)
5770
return control_dir.root_transport.base
5773
class cmd_view(Command):
5774
__doc__ = """Manage filtered views.
5776
Views provide a mask over the tree so that users can focus on
5777
a subset of a tree when doing their work. After creating a view,
5778
commands that support a list of files - status, diff, commit, etc -
5779
effectively have that list of files implicitly given each time.
5780
An explicit list of files can still be given but those files
5781
must be within the current view.
5783
In most cases, a view has a short life-span: it is created to make
5784
a selected change and is deleted once that change is committed.
5785
At other times, you may wish to create one or more named views
5786
and switch between them.
5788
To disable the current view without deleting it, you can switch to
5789
the pseudo view called ``off``. This can be useful when you need
5790
to see the whole tree for an operation or two (e.g. merge) but
5791
want to switch back to your view after that.
5794
To define the current view::
5796
bzr view file1 dir1 ...
5798
To list the current view::
5802
To delete the current view::
5806
To disable the current view without deleting it::
5808
bzr view --switch off
5810
To define a named view and switch to it::
5812
bzr view --name view-name file1 dir1 ...
5814
To list a named view::
5816
bzr view --name view-name
5818
To delete a named view::
5820
bzr view --name view-name --delete
5822
To switch to a named view::
5824
bzr view --switch view-name
5826
To list all views defined::
5830
To delete all views::
5832
bzr view --delete --all
5836
takes_args = ['file*']
5839
help='Apply list or delete action to all views.',
5842
help='Delete the view.',
5845
help='Name of the view to define, list or delete.',
5849
help='Name of the view to switch to.',
5854
def run(self, file_list,
5860
tree, file_list = WorkingTree.open_containing_paths(file_list,
5862
current_view, view_dict = tree.views.get_view_info()
5867
raise errors.BzrCommandError(
5868
"Both --delete and a file list specified")
5870
raise errors.BzrCommandError(
5871
"Both --delete and --switch specified")
5873
tree.views.set_view_info(None, {})
5874
self.outf.write("Deleted all views.\n")
5876
raise errors.BzrCommandError("No current view to delete")
5878
tree.views.delete_view(name)
5879
self.outf.write("Deleted '%s' view.\n" % name)
5882
raise errors.BzrCommandError(
5883
"Both --switch and a file list specified")
5885
raise errors.BzrCommandError(
5886
"Both --switch and --all specified")
5887
elif switch == 'off':
5888
if current_view is None:
5889
raise errors.BzrCommandError("No current view to disable")
5890
tree.views.set_view_info(None, view_dict)
5891
self.outf.write("Disabled '%s' view.\n" % (current_view))
5893
tree.views.set_view_info(switch, view_dict)
5894
view_str = views.view_display_str(tree.views.lookup_view())
5895
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5898
self.outf.write('Views defined:\n')
5899
for view in sorted(view_dict):
5900
if view == current_view:
5904
view_str = views.view_display_str(view_dict[view])
5905
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5907
self.outf.write('No views defined.\n')
5910
# No name given and no current view set
5913
raise errors.BzrCommandError(
5914
"Cannot change the 'off' pseudo view")
5915
tree.views.set_view(name, sorted(file_list))
5916
view_str = views.view_display_str(tree.views.lookup_view())
5917
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5921
# No name given and no current view set
5922
self.outf.write('No current view.\n')
5924
view_str = views.view_display_str(tree.views.lookup_view(name))
5925
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5928
class cmd_hooks(Command):
5929
__doc__ = """Show hooks."""
5934
for hook_key in sorted(hooks.known_hooks.keys()):
5935
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5936
self.outf.write("%s:\n" % type(some_hooks).__name__)
5937
for hook_name, hook_point in sorted(some_hooks.items()):
5938
self.outf.write(" %s:\n" % (hook_name,))
5939
found_hooks = list(hook_point)
5941
for hook in found_hooks:
5942
self.outf.write(" %s\n" %
5943
(some_hooks.get_hook_name(hook),))
5945
self.outf.write(" <no hooks installed>\n")
5948
class cmd_remove_branch(Command):
5949
__doc__ = """Remove a branch.
5951
This will remove the branch from the specified location but
5952
will keep any working tree or repository in place.
5956
Remove the branch at repo/trunk::
5958
bzr remove-branch repo/trunk
5962
takes_args = ["location?"]
5964
aliases = ["rmbranch"]
5966
def run(self, location=None):
5967
if location is None:
5969
branch = Branch.open_containing(location)[0]
5970
branch.bzrdir.destroy_branch()
5973
class cmd_shelve(Command):
5974
__doc__ = """Temporarily set aside some changes from the current tree.
5976
Shelve allows you to temporarily put changes you've made "on the shelf",
5977
ie. out of the way, until a later time when you can bring them back from
5978
the shelf with the 'unshelve' command. The changes are stored alongside
5979
your working tree, and so they aren't propagated along with your branch nor
5980
will they survive its deletion.
5982
If shelve --list is specified, previously-shelved changes are listed.
5984
Shelve is intended to help separate several sets of changes that have
5985
been inappropriately mingled. If you just want to get rid of all changes
5986
and you don't need to restore them later, use revert. If you want to
5987
shelve all text changes at once, use shelve --all.
5989
If filenames are specified, only the changes to those files will be
5990
shelved. Other files will be left untouched.
5992
If a revision is specified, changes since that revision will be shelved.
5994
You can put multiple items on the shelf, and by default, 'unshelve' will
5995
restore the most recently shelved changes.
5997
For complicated changes, it is possible to edit the changes in a separate
5998
editor program to decide what the file remaining in the working copy
5999
should look like. To do this, add the configuration option
6001
change_editor = PROGRAM @new_path @old_path
6003
where @new_path is replaced with the path of the new version of the
6004
file and @old_path is replaced with the path of the old version of
6005
the file. The PROGRAM should save the new file with the desired
6006
contents of the file in the working tree.
6010
takes_args = ['file*']
6015
Option('all', help='Shelve all changes.'),
6017
RegistryOption('writer', 'Method to use for writing diffs.',
6018
bzrlib.option.diff_writer_registry,
6019
value_switches=True, enum_switch=False),
6021
Option('list', help='List shelved changes.'),
6023
help='Destroy removed changes instead of shelving them.'),
6025
_see_also = ['unshelve', 'configuration']
6027
def run(self, revision=None, all=False, file_list=None, message=None,
6028
writer=None, list=False, destroy=False, directory=None):
6030
return self.run_for_list(directory=directory)
6031
from bzrlib.shelf_ui import Shelver
6033
writer = bzrlib.option.diff_writer_registry.get()
6035
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6036
file_list, message, destroy=destroy, directory=directory)
6041
except errors.UserAbort:
6044
def run_for_list(self, directory=None):
6045
if directory is None:
6047
tree = WorkingTree.open_containing(directory)[0]
6048
self.add_cleanup(tree.lock_read().unlock)
6049
manager = tree.get_shelf_manager()
6050
shelves = manager.active_shelves()
6051
if len(shelves) == 0:
6052
note('No shelved changes.')
6054
for shelf_id in reversed(shelves):
6055
message = manager.get_metadata(shelf_id).get('message')
6057
message = '<no message>'
6058
self.outf.write('%3d: %s\n' % (shelf_id, message))
6062
class cmd_unshelve(Command):
6063
__doc__ = """Restore shelved changes.
6065
By default, the most recently shelved changes are restored. However if you
6066
specify a shelf by id those changes will be restored instead. This works
6067
best when the changes don't depend on each other.
6070
takes_args = ['shelf_id?']
6073
RegistryOption.from_kwargs(
6074
'action', help="The action to perform.",
6075
enum_switch=False, value_switches=True,
6076
apply="Apply changes and remove from the shelf.",
6077
dry_run="Show changes, but do not apply or remove them.",
6078
preview="Instead of unshelving the changes, show the diff that "
6079
"would result from unshelving.",
6080
delete_only="Delete changes without applying them.",
6081
keep="Apply changes but don't delete them.",
6084
_see_also = ['shelve']
6086
def run(self, shelf_id=None, action='apply', directory=u'.'):
6087
from bzrlib.shelf_ui import Unshelver
6088
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6092
unshelver.tree.unlock()
6095
class cmd_clean_tree(Command):
6096
__doc__ = """Remove unwanted files from working tree.
6098
By default, only unknown files, not ignored files, are deleted. Versioned
6099
files are never deleted.
6101
Another class is 'detritus', which includes files emitted by bzr during
6102
normal operations and selftests. (The value of these files decreases with
6105
If no options are specified, unknown files are deleted. Otherwise, option
6106
flags are respected, and may be combined.
6108
To check what clean-tree will do, use --dry-run.
6110
takes_options = ['directory',
6111
Option('ignored', help='Delete all ignored files.'),
6112
Option('detritus', help='Delete conflict files, merge and revert'
6113
' backups, and failed selftest dirs.'),
6115
help='Delete files unknown to bzr (default).'),
6116
Option('dry-run', help='Show files to delete instead of'
6118
Option('force', help='Do not prompt before deleting.')]
6119
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6120
force=False, directory=u'.'):
6121
from bzrlib.clean_tree import clean_tree
6122
if not (unknown or ignored or detritus):
6126
clean_tree(directory, unknown=unknown, ignored=ignored,
6127
detritus=detritus, dry_run=dry_run, no_prompt=force)
6130
class cmd_reference(Command):
6131
__doc__ = """list, view and set branch locations for nested trees.
6133
If no arguments are provided, lists the branch locations for nested trees.
6134
If one argument is provided, display the branch location for that tree.
6135
If two arguments are provided, set the branch location for that tree.
6140
takes_args = ['path?', 'location?']
6142
def run(self, path=None, location=None):
6144
if path is not None:
6146
tree, branch, relpath =(
6147
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
6148
if path is not None:
6151
tree = branch.basis_tree()
6153
info = branch._get_all_reference_info().iteritems()
6154
self._display_reference_info(tree, branch, info)
6156
file_id = tree.path2id(path)
6158
raise errors.NotVersionedError(path)
6159
if location is None:
6160
info = [(file_id, branch.get_reference_info(file_id))]
6161
self._display_reference_info(tree, branch, info)
6163
branch.set_reference_info(file_id, path, location)
6165
def _display_reference_info(self, tree, branch, info):
6167
for file_id, (path, location) in info:
6169
path = tree.id2path(file_id)
6170
except errors.NoSuchId:
6172
ref_list.append((path, location))
6173
for path, location in sorted(ref_list):
6174
self.outf.write('%s %s\n' % (path, location))
6177
class cmd_export_pot(Command):
6178
__doc__ = """Export command helps and error messages in po format."""
6183
from bzrlib.export_pot import export_pot
6184
export_pot(self.outf)
6187
def _register_lazy_builtins():
6188
# register lazy builtins from other modules; called at startup and should
6189
# be only called once.
6190
for (name, aliases, module_name) in [
6191
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6192
('cmd_config', [], 'bzrlib.config'),
6193
('cmd_dpush', [], 'bzrlib.foreign'),
6194
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6195
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6196
('cmd_conflicts', [], 'bzrlib.conflicts'),
6197
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6198
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6200
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
