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. After
966
that, you can omit the location to use the default. To change the
967
default, use --remember. The value will only be saved if the remote
968
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=False, 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)
1051
if branch_to.get_parent() is None or remember:
1052
branch_to.set_parent(branch_from.base)
1054
if revision is not None:
1055
revision_id = revision.as_revision_id(branch_from)
1057
if tree_to is not None:
1058
view_info = _get_view_info_for_change_reporter(tree_to)
1059
change_reporter = delta._ChangeReporter(
1060
unversioned_filter=tree_to.is_ignored,
1061
view_info=view_info)
1062
result = tree_to.pull(
1063
branch_from, overwrite, revision_id, change_reporter,
1064
possible_transports=possible_transports, local=local,
1065
show_base=show_base)
1067
result = branch_to.pull(
1068
branch_from, overwrite, revision_id, local=local)
1070
result.report(self.outf)
1071
if verbose and result.old_revid != result.new_revid:
1072
log.show_branch_change(
1073
branch_to, self.outf, result.old_revno,
1075
if getattr(result, 'tag_conflicts', None):
1081
class cmd_push(Command):
1082
__doc__ = """Update a mirror of this branch.
1084
The target branch will not have its working tree populated because this
1085
is both expensive, and is not supported on remote file systems.
1087
Some smart servers or protocols *may* put the working tree in place in
1090
This command only works on branches that have not diverged. Branches are
1091
considered diverged if the destination branch's most recent commit is one
1092
that has not been merged (directly or indirectly) by the source branch.
1094
If branches have diverged, you can use 'bzr push --overwrite' to replace
1095
the other branch completely, discarding its unmerged changes.
1097
If you want to ensure you have the different changes in the other branch,
1098
do a merge (see bzr help merge) from the other branch, and commit that.
1099
After that you will be able to do a push without '--overwrite'.
1101
If there is no default push location set, the first push will set it.
1102
After that, you can omit the location to use the default. To change the
1103
default, use --remember. The value will only be saved if the remote
1104
location can be accessed.
1107
_see_also = ['pull', 'update', 'working-trees']
1108
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1109
Option('create-prefix',
1110
help='Create the path leading up to the branch '
1111
'if it does not already exist.'),
1112
custom_help('directory',
1113
help='Branch to push from, '
1114
'rather than the one containing the working directory.'),
1115
Option('use-existing-dir',
1116
help='By default push will fail if the target'
1117
' directory exists, but does not already'
1118
' have a control directory. This flag will'
1119
' allow push to proceed.'),
1121
help='Create a stacked branch that references the public location '
1122
'of the parent branch.'),
1123
Option('stacked-on',
1124
help='Create a stacked branch that refers to another branch '
1125
'for the commit history. Only the work not present in the '
1126
'referenced branch is included in the branch created.',
1129
help='Refuse to push if there are uncommitted changes in'
1130
' the working tree, --no-strict disables the check.'),
1132
help="Don't populate the working tree, even for protocols"
1133
" that support it."),
1135
takes_args = ['location?']
1136
encoding_type = 'replace'
1138
def run(self, location=None, remember=False, overwrite=False,
1139
create_prefix=False, verbose=False, revision=None,
1140
use_existing_dir=False, directory=None, stacked_on=None,
1141
stacked=False, strict=None, no_tree=False):
1142
from bzrlib.push import _show_push_branch
1144
if directory is None:
1146
# Get the source branch
1148
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1149
# Get the tip's revision_id
1150
revision = _get_one_revision('push', revision)
1151
if revision is not None:
1152
revision_id = revision.in_history(br_from).rev_id
1155
if tree is not None and revision_id is None:
1156
tree.check_changed_or_out_of_date(
1157
strict, 'push_strict',
1158
more_error='Use --no-strict to force the push.',
1159
more_warning='Uncommitted changes will not be pushed.')
1160
# Get the stacked_on branch, if any
1161
if stacked_on is not None:
1162
stacked_on = urlutils.normalize_url(stacked_on)
1164
parent_url = br_from.get_parent()
1166
parent = Branch.open(parent_url)
1167
stacked_on = parent.get_public_branch()
1169
# I considered excluding non-http url's here, thus forcing
1170
# 'public' branches only, but that only works for some
1171
# users, so it's best to just depend on the user spotting an
1172
# error by the feedback given to them. RBC 20080227.
1173
stacked_on = parent_url
1175
raise errors.BzrCommandError(
1176
"Could not determine branch to refer to.")
1178
# Get the destination location
1179
if location is None:
1180
stored_loc = br_from.get_push_location()
1181
if stored_loc is None:
1182
raise errors.BzrCommandError(
1183
"No push location known or specified.")
1185
display_url = urlutils.unescape_for_display(stored_loc,
1187
self.outf.write("Using saved push location: %s\n" % display_url)
1188
location = stored_loc
1190
_show_push_branch(br_from, revision_id, location, self.outf,
1191
verbose=verbose, overwrite=overwrite, remember=remember,
1192
stacked_on=stacked_on, create_prefix=create_prefix,
1193
use_existing_dir=use_existing_dir, no_tree=no_tree)
1196
class cmd_branch(Command):
1197
__doc__ = """Create a new branch that is a copy of an existing branch.
1199
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1200
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1201
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1202
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1203
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1206
To retrieve the branch as of a particular revision, supply the --revision
1207
parameter, as in "branch foo/bar -r 5".
1209
The synonyms 'clone' and 'get' for this command are deprecated.
1212
_see_also = ['checkout']
1213
takes_args = ['from_location', 'to_location?']
1214
takes_options = ['revision',
1215
Option('hardlink', help='Hard-link working tree files where possible.'),
1216
Option('files-from', type=str,
1217
help="Get file contents from this tree."),
1219
help="Create a branch without a working-tree."),
1221
help="Switch the checkout in the current directory "
1222
"to the new branch."),
1224
help='Create a stacked branch referring to the source branch. '
1225
'The new branch will depend on the availability of the source '
1226
'branch for all operations.'),
1227
Option('standalone',
1228
help='Do not use a shared repository, even if available.'),
1229
Option('use-existing-dir',
1230
help='By default branch will fail if the target'
1231
' directory exists, but does not already'
1232
' have a control directory. This flag will'
1233
' allow branch to proceed.'),
1235
help="Bind new branch to from location."),
1237
aliases = ['get', 'clone']
1239
def run(self, from_location, to_location=None, revision=None,
1240
hardlink=False, stacked=False, standalone=False, no_tree=False,
1241
use_existing_dir=False, switch=False, bind=False,
1243
from bzrlib import switch as _mod_switch
1244
from bzrlib.tag import _merge_tags_if_possible
1245
if self.invoked_as in ['get', 'clone']:
1246
ui.ui_factory.show_user_warning(
1247
'deprecated_command',
1248
deprecated_name=self.invoked_as,
1249
recommended_name='branch',
1250
deprecated_in_version='2.4')
1251
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1253
if not (hardlink or files_from):
1254
# accelerator_tree is usually slower because you have to read N
1255
# files (no readahead, lots of seeks, etc), but allow the user to
1256
# explicitly request it
1257
accelerator_tree = None
1258
if files_from is not None and files_from != from_location:
1259
accelerator_tree = WorkingTree.open(files_from)
1260
revision = _get_one_revision('branch', revision)
1261
self.add_cleanup(br_from.lock_read().unlock)
1262
if revision is not None:
1263
revision_id = revision.as_revision_id(br_from)
1265
# FIXME - wt.last_revision, fallback to branch, fall back to
1266
# None or perhaps NULL_REVISION to mean copy nothing
1268
revision_id = br_from.last_revision()
1269
if to_location is None:
1270
to_location = urlutils.derive_to_location(from_location)
1271
to_transport = transport.get_transport(to_location)
1273
to_transport.mkdir('.')
1274
except errors.FileExists:
1275
if not use_existing_dir:
1276
raise errors.BzrCommandError('Target directory "%s" '
1277
'already exists.' % to_location)
1280
bzrdir.BzrDir.open_from_transport(to_transport)
1281
except errors.NotBranchError:
1284
raise errors.AlreadyBranchError(to_location)
1285
except errors.NoSuchFile:
1286
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1289
# preserve whatever source format we have.
1290
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1291
possible_transports=[to_transport],
1292
accelerator_tree=accelerator_tree,
1293
hardlink=hardlink, stacked=stacked,
1294
force_new_repo=standalone,
1295
create_tree_if_local=not no_tree,
1296
source_branch=br_from)
1297
branch = dir.open_branch()
1298
except errors.NoSuchRevision:
1299
to_transport.delete_tree('.')
1300
msg = "The branch %s has no revision %s." % (from_location,
1302
raise errors.BzrCommandError(msg)
1303
_merge_tags_if_possible(br_from, branch)
1304
# If the source branch is stacked, the new branch may
1305
# be stacked whether we asked for that explicitly or not.
1306
# We therefore need a try/except here and not just 'if stacked:'
1308
note('Created new stacked branch referring to %s.' %
1309
branch.get_stacked_on_url())
1310
except (errors.NotStacked, errors.UnstackableBranchFormat,
1311
errors.UnstackableRepositoryFormat), e:
1312
note('Branched %d revision(s).' % branch.revno())
1314
# Bind to the parent
1315
parent_branch = Branch.open(from_location)
1316
branch.bind(parent_branch)
1317
note('New branch bound to %s' % from_location)
1319
# Switch to the new branch
1320
wt, _ = WorkingTree.open_containing('.')
1321
_mod_switch.switch(wt.bzrdir, branch)
1322
note('Switched to branch: %s',
1323
urlutils.unescape_for_display(branch.base, 'utf-8'))
1326
class cmd_checkout(Command):
1327
__doc__ = """Create a new checkout of an existing branch.
1329
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1330
the branch found in '.'. This is useful if you have removed the working tree
1331
or if it was never created - i.e. if you pushed the branch to its current
1332
location using SFTP.
1334
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1335
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1336
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1337
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1338
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1341
To retrieve the branch as of a particular revision, supply the --revision
1342
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1343
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1347
_see_also = ['checkouts', 'branch']
1348
takes_args = ['branch_location?', 'to_location?']
1349
takes_options = ['revision',
1350
Option('lightweight',
1351
help="Perform a lightweight checkout. Lightweight "
1352
"checkouts depend on access to the branch for "
1353
"every operation. Normal checkouts can perform "
1354
"common operations like diff and status without "
1355
"such access, and also support local commits."
1357
Option('files-from', type=str,
1358
help="Get file contents from this tree."),
1360
help='Hard-link working tree files where possible.'
1365
def run(self, branch_location=None, to_location=None, revision=None,
1366
lightweight=False, files_from=None, hardlink=False):
1367
if branch_location is None:
1368
branch_location = osutils.getcwd()
1369
to_location = branch_location
1370
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1372
if not (hardlink or files_from):
1373
# accelerator_tree is usually slower because you have to read N
1374
# files (no readahead, lots of seeks, etc), but allow the user to
1375
# explicitly request it
1376
accelerator_tree = None
1377
revision = _get_one_revision('checkout', revision)
1378
if files_from is not None and files_from != branch_location:
1379
accelerator_tree = WorkingTree.open(files_from)
1380
if revision is not None:
1381
revision_id = revision.as_revision_id(source)
1384
if to_location is None:
1385
to_location = urlutils.derive_to_location(branch_location)
1386
# if the source and to_location are the same,
1387
# and there is no working tree,
1388
# then reconstitute a branch
1389
if (osutils.abspath(to_location) ==
1390
osutils.abspath(branch_location)):
1392
source.bzrdir.open_workingtree()
1393
except errors.NoWorkingTree:
1394
source.bzrdir.create_workingtree(revision_id)
1396
source.create_checkout(to_location, revision_id, lightweight,
1397
accelerator_tree, hardlink)
1400
class cmd_renames(Command):
1401
__doc__ = """Show list of renamed files.
1403
# TODO: Option to show renames between two historical versions.
1405
# TODO: Only show renames under dir, rather than in the whole branch.
1406
_see_also = ['status']
1407
takes_args = ['dir?']
1410
def run(self, dir=u'.'):
1411
tree = WorkingTree.open_containing(dir)[0]
1412
self.add_cleanup(tree.lock_read().unlock)
1413
new_inv = tree.inventory
1414
old_tree = tree.basis_tree()
1415
self.add_cleanup(old_tree.lock_read().unlock)
1416
old_inv = old_tree.inventory
1418
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1419
for f, paths, c, v, p, n, k, e in iterator:
1420
if paths[0] == paths[1]:
1424
renames.append(paths)
1426
for old_name, new_name in renames:
1427
self.outf.write("%s => %s\n" % (old_name, new_name))
1430
class cmd_update(Command):
1431
__doc__ = """Update a tree to have the latest code committed to its branch.
1433
This will perform a merge into the working tree, and may generate
1434
conflicts. If you have any local changes, you will still
1435
need to commit them after the update for the update to be complete.
1437
If you want to discard your local changes, you can just do a
1438
'bzr revert' instead of 'bzr commit' after the update.
1440
If you want to restore a file that has been removed locally, use
1441
'bzr revert' instead of 'bzr update'.
1443
If the tree's branch is bound to a master branch, it will also update
1444
the branch from the master.
1447
_see_also = ['pull', 'working-trees', 'status-flags']
1448
takes_args = ['dir?']
1449
takes_options = ['revision',
1451
help="Show base revision text in conflicts."),
1455
def run(self, dir='.', revision=None, show_base=None):
1456
if revision is not None and len(revision) != 1:
1457
raise errors.BzrCommandError(
1458
"bzr update --revision takes exactly one revision")
1459
tree = WorkingTree.open_containing(dir)[0]
1460
branch = tree.branch
1461
possible_transports = []
1462
master = branch.get_master_branch(
1463
possible_transports=possible_transports)
1464
if master is not None:
1465
branch_location = master.base
1468
branch_location = tree.branch.base
1469
tree.lock_tree_write()
1470
self.add_cleanup(tree.unlock)
1471
# get rid of the final '/' and be ready for display
1472
branch_location = urlutils.unescape_for_display(
1473
branch_location.rstrip('/'),
1475
existing_pending_merges = tree.get_parent_ids()[1:]
1479
# may need to fetch data into a heavyweight checkout
1480
# XXX: this may take some time, maybe we should display a
1482
old_tip = branch.update(possible_transports)
1483
if revision is not None:
1484
revision_id = revision[0].as_revision_id(branch)
1486
revision_id = branch.last_revision()
1487
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1488
revno = branch.revision_id_to_dotted_revno(revision_id)
1489
note("Tree is up to date at revision %s of branch %s" %
1490
('.'.join(map(str, revno)), branch_location))
1492
view_info = _get_view_info_for_change_reporter(tree)
1493
change_reporter = delta._ChangeReporter(
1494
unversioned_filter=tree.is_ignored,
1495
view_info=view_info)
1497
conflicts = tree.update(
1499
possible_transports=possible_transports,
1500
revision=revision_id,
1502
show_base=show_base)
1503
except errors.NoSuchRevision, e:
1504
raise errors.BzrCommandError(
1505
"branch has no revision %s\n"
1506
"bzr update --revision only works"
1507
" for a revision in the branch history"
1509
revno = tree.branch.revision_id_to_dotted_revno(
1510
_mod_revision.ensure_null(tree.last_revision()))
1511
note('Updated to revision %s of branch %s' %
1512
('.'.join(map(str, revno)), branch_location))
1513
parent_ids = tree.get_parent_ids()
1514
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1515
note('Your local commits will now show as pending merges with '
1516
"'bzr status', and can be committed with 'bzr commit'.")
1523
class cmd_info(Command):
1524
__doc__ = """Show information about a working tree, branch or repository.
1526
This command will show all known locations and formats associated to the
1527
tree, branch or repository.
1529
In verbose mode, statistical information is included with each report.
1530
To see extended statistic information, use a verbosity level of 2 or
1531
higher by specifying the verbose option multiple times, e.g. -vv.
1533
Branches and working trees will also report any missing revisions.
1537
Display information on the format and related locations:
1541
Display the above together with extended format information and
1542
basic statistics (like the number of files in the working tree and
1543
number of revisions in the branch and repository):
1547
Display the above together with number of committers to the branch:
1551
_see_also = ['revno', 'working-trees', 'repositories']
1552
takes_args = ['location?']
1553
takes_options = ['verbose']
1554
encoding_type = 'replace'
1557
def run(self, location=None, verbose=False):
1559
noise_level = get_verbosity_level()
1562
from bzrlib.info import show_bzrdir_info
1563
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1564
verbose=noise_level, outfile=self.outf)
1567
class cmd_remove(Command):
1568
__doc__ = """Remove files or directories.
1570
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1571
delete them if they can easily be recovered using revert otherwise they
1572
will be backed up (adding an extention of the form .~#~). If no options or
1573
parameters are given Bazaar will scan for files that are being tracked by
1574
Bazaar but missing in your tree and stop tracking them for you.
1576
takes_args = ['file*']
1577
takes_options = ['verbose',
1578
Option('new', help='Only remove files that have never been committed.'),
1579
RegistryOption.from_kwargs('file-deletion-strategy',
1580
'The file deletion mode to be used.',
1581
title='Deletion Strategy', value_switches=True, enum_switch=False,
1582
safe='Backup changed files (default).',
1583
keep='Delete from bzr but leave the working copy.',
1584
no_backup='Don\'t backup changed files.',
1585
force='Delete all the specified files, even if they can not be '
1586
'recovered and even if they are non-empty directories. '
1587
'(deprecated, use no-backup)')]
1588
aliases = ['rm', 'del']
1589
encoding_type = 'replace'
1591
def run(self, file_list, verbose=False, new=False,
1592
file_deletion_strategy='safe'):
1593
if file_deletion_strategy == 'force':
1594
note("(The --force option is deprecated, rather use --no-backup "
1596
file_deletion_strategy = 'no-backup'
1598
tree, file_list = WorkingTree.open_containing_paths(file_list)
1600
if file_list is not None:
1601
file_list = [f for f in file_list]
1603
self.add_cleanup(tree.lock_write().unlock)
1604
# Heuristics should probably all move into tree.remove_smart or
1607
added = tree.changes_from(tree.basis_tree(),
1608
specific_files=file_list).added
1609
file_list = sorted([f[0] for f in added], reverse=True)
1610
if len(file_list) == 0:
1611
raise errors.BzrCommandError('No matching files.')
1612
elif file_list is None:
1613
# missing files show up in iter_changes(basis) as
1614
# versioned-with-no-kind.
1616
for change in tree.iter_changes(tree.basis_tree()):
1617
# Find paths in the working tree that have no kind:
1618
if change[1][1] is not None and change[6][1] is None:
1619
missing.append(change[1][1])
1620
file_list = sorted(missing, reverse=True)
1621
file_deletion_strategy = 'keep'
1622
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1623
keep_files=file_deletion_strategy=='keep',
1624
force=(file_deletion_strategy=='no-backup'))
1627
class cmd_file_id(Command):
1628
__doc__ = """Print file_id of a particular file or directory.
1630
The file_id is assigned when the file is first added and remains the
1631
same through all revisions where the file exists, even when it is
1636
_see_also = ['inventory', 'ls']
1637
takes_args = ['filename']
1640
def run(self, filename):
1641
tree, relpath = WorkingTree.open_containing(filename)
1642
i = tree.path2id(relpath)
1644
raise errors.NotVersionedError(filename)
1646
self.outf.write(i + '\n')
1649
class cmd_file_path(Command):
1650
__doc__ = """Print path of file_ids to a file or directory.
1652
This prints one line for each directory down to the target,
1653
starting at the branch root.
1657
takes_args = ['filename']
1660
def run(self, filename):
1661
tree, relpath = WorkingTree.open_containing(filename)
1662
fid = tree.path2id(relpath)
1664
raise errors.NotVersionedError(filename)
1665
segments = osutils.splitpath(relpath)
1666
for pos in range(1, len(segments) + 1):
1667
path = osutils.joinpath(segments[:pos])
1668
self.outf.write("%s\n" % tree.path2id(path))
1671
class cmd_reconcile(Command):
1672
__doc__ = """Reconcile bzr metadata in a branch.
1674
This can correct data mismatches that may have been caused by
1675
previous ghost operations or bzr upgrades. You should only
1676
need to run this command if 'bzr check' or a bzr developer
1677
advises you to run it.
1679
If a second branch is provided, cross-branch reconciliation is
1680
also attempted, which will check that data like the tree root
1681
id which was not present in very early bzr versions is represented
1682
correctly in both branches.
1684
At the same time it is run it may recompress data resulting in
1685
a potential saving in disk space or performance gain.
1687
The branch *MUST* be on a listable system such as local disk or sftp.
1690
_see_also = ['check']
1691
takes_args = ['branch?']
1693
Option('canonicalize-chks',
1694
help='Make sure CHKs are in canonical form (repairs '
1699
def run(self, branch=".", canonicalize_chks=False):
1700
from bzrlib.reconcile import reconcile
1701
dir = bzrdir.BzrDir.open(branch)
1702
reconcile(dir, canonicalize_chks=canonicalize_chks)
1705
class cmd_revision_history(Command):
1706
__doc__ = """Display the list of revision ids on a branch."""
1709
takes_args = ['location?']
1714
def run(self, location="."):
1715
branch = Branch.open_containing(location)[0]
1716
for revid in branch.revision_history():
1717
self.outf.write(revid)
1718
self.outf.write('\n')
1721
class cmd_ancestry(Command):
1722
__doc__ = """List all revisions merged into this branch."""
1724
_see_also = ['log', 'revision-history']
1725
takes_args = ['location?']
1730
def run(self, location="."):
1732
wt = WorkingTree.open_containing(location)[0]
1733
except errors.NoWorkingTree:
1734
b = Branch.open(location)
1735
last_revision = b.last_revision()
1738
last_revision = wt.last_revision()
1740
revision_ids = b.repository.get_ancestry(last_revision)
1742
for revision_id in revision_ids:
1743
self.outf.write(revision_id + '\n')
1746
class cmd_init(Command):
1747
__doc__ = """Make a directory into a versioned branch.
1749
Use this to create an empty branch, or before importing an
1752
If there is a repository in a parent directory of the location, then
1753
the history of the branch will be stored in the repository. Otherwise
1754
init creates a standalone branch which carries its own history
1755
in the .bzr directory.
1757
If there is already a branch at the location but it has no working tree,
1758
the tree can be populated with 'bzr checkout'.
1760
Recipe for importing a tree of files::
1766
bzr commit -m "imported project"
1769
_see_also = ['init-repository', 'branch', 'checkout']
1770
takes_args = ['location?']
1772
Option('create-prefix',
1773
help='Create the path leading up to the branch '
1774
'if it does not already exist.'),
1775
RegistryOption('format',
1776
help='Specify a format for this branch. '
1777
'See "help formats".',
1778
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1779
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1780
value_switches=True,
1781
title="Branch format",
1783
Option('append-revisions-only',
1784
help='Never change revnos or the existing log.'
1785
' Append revisions to it only.'),
1787
'Create a branch without a working tree.')
1789
def run(self, location=None, format=None, append_revisions_only=False,
1790
create_prefix=False, no_tree=False):
1792
format = bzrdir.format_registry.make_bzrdir('default')
1793
if location is None:
1796
to_transport = transport.get_transport(location)
1798
# The path has to exist to initialize a
1799
# branch inside of it.
1800
# Just using os.mkdir, since I don't
1801
# believe that we want to create a bunch of
1802
# locations if the user supplies an extended path
1804
to_transport.ensure_base()
1805
except errors.NoSuchFile:
1806
if not create_prefix:
1807
raise errors.BzrCommandError("Parent directory of %s"
1809
"\nYou may supply --create-prefix to create all"
1810
" leading parent directories."
1812
to_transport.create_prefix()
1815
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1816
except errors.NotBranchError:
1817
# really a NotBzrDir error...
1818
create_branch = bzrdir.BzrDir.create_branch_convenience
1820
force_new_tree = False
1822
force_new_tree = None
1823
branch = create_branch(to_transport.base, format=format,
1824
possible_transports=[to_transport],
1825
force_new_tree=force_new_tree)
1826
a_bzrdir = branch.bzrdir
1828
from bzrlib.transport.local import LocalTransport
1829
if a_bzrdir.has_branch():
1830
if (isinstance(to_transport, LocalTransport)
1831
and not a_bzrdir.has_workingtree()):
1832
raise errors.BranchExistsWithoutWorkingTree(location)
1833
raise errors.AlreadyBranchError(location)
1834
branch = a_bzrdir.create_branch()
1836
a_bzrdir.create_workingtree()
1837
if append_revisions_only:
1839
branch.set_append_revisions_only(True)
1840
except errors.UpgradeRequired:
1841
raise errors.BzrCommandError('This branch format cannot be set'
1842
' to append-revisions-only. Try --default.')
1844
from bzrlib.info import describe_layout, describe_format
1846
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1847
except (errors.NoWorkingTree, errors.NotLocalUrl):
1849
repository = branch.repository
1850
layout = describe_layout(repository, branch, tree).lower()
1851
format = describe_format(a_bzrdir, repository, branch, tree)
1852
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1853
if repository.is_shared():
1854
#XXX: maybe this can be refactored into transport.path_or_url()
1855
url = repository.bzrdir.root_transport.external_url()
1857
url = urlutils.local_path_from_url(url)
1858
except errors.InvalidURL:
1860
self.outf.write("Using shared repository: %s\n" % url)
1863
class cmd_init_repository(Command):
1864
__doc__ = """Create a shared repository for branches to share storage space.
1866
New branches created under the repository directory will store their
1867
revisions in the repository, not in the branch directory. For branches
1868
with shared history, this reduces the amount of storage needed and
1869
speeds up the creation of new branches.
1871
If the --no-trees option is given then the branches in the repository
1872
will not have working trees by default. They will still exist as
1873
directories on disk, but they will not have separate copies of the
1874
files at a certain revision. This can be useful for repositories that
1875
store branches which are interacted with through checkouts or remote
1876
branches, such as on a server.
1879
Create a shared repository holding just branches::
1881
bzr init-repo --no-trees repo
1884
Make a lightweight checkout elsewhere::
1886
bzr checkout --lightweight repo/trunk trunk-checkout
1891
_see_also = ['init', 'branch', 'checkout', 'repositories']
1892
takes_args = ["location"]
1893
takes_options = [RegistryOption('format',
1894
help='Specify a format for this repository. See'
1895
' "bzr help formats" for details.',
1896
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1897
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1898
value_switches=True, title='Repository format'),
1900
help='Branches in the repository will default to'
1901
' not having a working tree.'),
1903
aliases = ["init-repo"]
1905
def run(self, location, format=None, no_trees=False):
1907
format = bzrdir.format_registry.make_bzrdir('default')
1909
if location is None:
1912
to_transport = transport.get_transport(location)
1913
to_transport.ensure_base()
1915
newdir = format.initialize_on_transport(to_transport)
1916
repo = newdir.create_repository(shared=True)
1917
repo.set_make_working_trees(not no_trees)
1919
from bzrlib.info import show_bzrdir_info
1920
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1923
class cmd_diff(Command):
1924
__doc__ = """Show differences in the working tree, between revisions or branches.
1926
If no arguments are given, all changes for the current tree are listed.
1927
If files are given, only the changes in those files are listed.
1928
Remote and multiple branches can be compared by using the --old and
1929
--new options. If not provided, the default for both is derived from
1930
the first argument, if any, or the current tree if no arguments are
1933
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1934
produces patches suitable for "patch -p1".
1936
Note that when using the -r argument with a range of revisions, the
1937
differences are computed between the two specified revisions. That
1938
is, the command does not show the changes introduced by the first
1939
revision in the range. This differs from the interpretation of
1940
revision ranges used by "bzr log" which includes the first revision
1945
2 - unrepresentable changes
1950
Shows the difference in the working tree versus the last commit::
1954
Difference between the working tree and revision 1::
1958
Difference between revision 3 and revision 1::
1962
Difference between revision 3 and revision 1 for branch xxx::
1966
The changes introduced by revision 2 (equivalent to -r1..2)::
1970
To see the changes introduced by revision X::
1974
Note that in the case of a merge, the -c option shows the changes
1975
compared to the left hand parent. To see the changes against
1976
another parent, use::
1978
bzr diff -r<chosen_parent>..X
1980
The changes between the current revision and the previous revision
1981
(equivalent to -c-1 and -r-2..-1)
1985
Show just the differences for file NEWS::
1989
Show the differences in working tree xxx for file NEWS::
1993
Show the differences from branch xxx to this working tree:
1997
Show the differences between two branches for file NEWS::
1999
bzr diff --old xxx --new yyy NEWS
2001
Same as 'bzr diff' but prefix paths with old/ and new/::
2003
bzr diff --prefix old/:new/
2005
Show the differences using a custom diff program with options::
2007
bzr diff --using /usr/bin/diff --diff-options -wu
2009
_see_also = ['status']
2010
takes_args = ['file*']
2012
Option('diff-options', type=str,
2013
help='Pass these options to the external diff program.'),
2014
Option('prefix', type=str,
2016
help='Set prefixes added to old and new filenames, as '
2017
'two values separated by a colon. (eg "old/:new/").'),
2019
help='Branch/tree to compare from.',
2023
help='Branch/tree to compare to.',
2029
help='Use this command to compare files.',
2032
RegistryOption('format',
2034
help='Diff format to use.',
2035
lazy_registry=('bzrlib.diff', 'format_registry'),
2036
title='Diff format'),
2038
aliases = ['di', 'dif']
2039
encoding_type = 'exact'
2042
def run(self, revision=None, file_list=None, diff_options=None,
2043
prefix=None, old=None, new=None, using=None, format=None):
2044
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2047
if (prefix is None) or (prefix == '0'):
2055
old_label, new_label = prefix.split(":")
2057
raise errors.BzrCommandError(
2058
'--prefix expects two values separated by a colon'
2059
' (eg "old/:new/")')
2061
if revision and len(revision) > 2:
2062
raise errors.BzrCommandError('bzr diff --revision takes exactly'
2063
' one or two revision specifiers')
2065
if using is not None and format is not None:
2066
raise errors.BzrCommandError('--using and --format are mutually '
2069
(old_tree, new_tree,
2070
old_branch, new_branch,
2071
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2072
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2073
# GNU diff on Windows uses ANSI encoding for filenames
2074
path_encoding = osutils.get_diff_header_encoding()
2075
return show_diff_trees(old_tree, new_tree, sys.stdout,
2076
specific_files=specific_files,
2077
external_diff_options=diff_options,
2078
old_label=old_label, new_label=new_label,
2079
extra_trees=extra_trees,
2080
path_encoding=path_encoding,
2085
class cmd_deleted(Command):
2086
__doc__ = """List files deleted in the working tree.
2088
# TODO: Show files deleted since a previous revision, or
2089
# between two revisions.
2090
# TODO: Much more efficient way to do this: read in new
2091
# directories with readdir, rather than stating each one. Same
2092
# level of effort but possibly much less IO. (Or possibly not,
2093
# if the directories are very large...)
2094
_see_also = ['status', 'ls']
2095
takes_options = ['directory', 'show-ids']
2098
def run(self, show_ids=False, directory=u'.'):
2099
tree = WorkingTree.open_containing(directory)[0]
2100
self.add_cleanup(tree.lock_read().unlock)
2101
old = tree.basis_tree()
2102
self.add_cleanup(old.lock_read().unlock)
2103
for path, ie in old.inventory.iter_entries():
2104
if not tree.has_id(ie.file_id):
2105
self.outf.write(path)
2107
self.outf.write(' ')
2108
self.outf.write(ie.file_id)
2109
self.outf.write('\n')
2112
class cmd_modified(Command):
2113
__doc__ = """List files modified in working tree.
2117
_see_also = ['status', 'ls']
2118
takes_options = ['directory', 'null']
2121
def run(self, null=False, directory=u'.'):
2122
tree = WorkingTree.open_containing(directory)[0]
2123
self.add_cleanup(tree.lock_read().unlock)
2124
td = tree.changes_from(tree.basis_tree())
2126
for path, id, kind, text_modified, meta_modified in td.modified:
2128
self.outf.write(path + '\0')
2130
self.outf.write(osutils.quotefn(path) + '\n')
2133
class cmd_added(Command):
2134
__doc__ = """List files added in working tree.
2138
_see_also = ['status', 'ls']
2139
takes_options = ['directory', 'null']
2142
def run(self, null=False, directory=u'.'):
2143
wt = WorkingTree.open_containing(directory)[0]
2144
self.add_cleanup(wt.lock_read().unlock)
2145
basis = wt.basis_tree()
2146
self.add_cleanup(basis.lock_read().unlock)
2147
basis_inv = basis.inventory
2150
if file_id in basis_inv:
2152
if inv.is_root(file_id) and len(basis_inv) == 0:
2154
path = inv.id2path(file_id)
2155
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2158
self.outf.write(path + '\0')
2160
self.outf.write(osutils.quotefn(path) + '\n')
2163
class cmd_root(Command):
2164
__doc__ = """Show the tree root directory.
2166
The root is the nearest enclosing directory with a .bzr control
2169
takes_args = ['filename?']
2171
def run(self, filename=None):
2172
"""Print the branch root."""
2173
tree = WorkingTree.open_containing(filename)[0]
2174
self.outf.write(tree.basedir + '\n')
2177
def _parse_limit(limitstring):
2179
return int(limitstring)
2181
msg = "The limit argument must be an integer."
2182
raise errors.BzrCommandError(msg)
2185
def _parse_levels(s):
2189
msg = "The levels argument must be an integer."
2190
raise errors.BzrCommandError(msg)
2193
class cmd_log(Command):
2194
__doc__ = """Show historical log for a branch or subset of a branch.
2196
log is bzr's default tool for exploring the history of a branch.
2197
The branch to use is taken from the first parameter. If no parameters
2198
are given, the branch containing the working directory is logged.
2199
Here are some simple examples::
2201
bzr log log the current branch
2202
bzr log foo.py log a file in its branch
2203
bzr log http://server/branch log a branch on a server
2205
The filtering, ordering and information shown for each revision can
2206
be controlled as explained below. By default, all revisions are
2207
shown sorted (topologically) so that newer revisions appear before
2208
older ones and descendants always appear before ancestors. If displayed,
2209
merged revisions are shown indented under the revision in which they
2214
The log format controls how information about each revision is
2215
displayed. The standard log formats are called ``long``, ``short``
2216
and ``line``. The default is long. See ``bzr help log-formats``
2217
for more details on log formats.
2219
The following options can be used to control what information is
2222
-l N display a maximum of N revisions
2223
-n N display N levels of revisions (0 for all, 1 for collapsed)
2224
-v display a status summary (delta) for each revision
2225
-p display a diff (patch) for each revision
2226
--show-ids display revision-ids (and file-ids), not just revnos
2228
Note that the default number of levels to display is a function of the
2229
log format. If the -n option is not used, the standard log formats show
2230
just the top level (mainline).
2232
Status summaries are shown using status flags like A, M, etc. To see
2233
the changes explained using words like ``added`` and ``modified``
2234
instead, use the -vv option.
2238
To display revisions from oldest to newest, use the --forward option.
2239
In most cases, using this option will have little impact on the total
2240
time taken to produce a log, though --forward does not incrementally
2241
display revisions like --reverse does when it can.
2243
:Revision filtering:
2245
The -r option can be used to specify what revision or range of revisions
2246
to filter against. The various forms are shown below::
2248
-rX display revision X
2249
-rX.. display revision X and later
2250
-r..Y display up to and including revision Y
2251
-rX..Y display from X to Y inclusive
2253
See ``bzr help revisionspec`` for details on how to specify X and Y.
2254
Some common examples are given below::
2256
-r-1 show just the tip
2257
-r-10.. show the last 10 mainline revisions
2258
-rsubmit:.. show what's new on this branch
2259
-rancestor:path.. show changes since the common ancestor of this
2260
branch and the one at location path
2261
-rdate:yesterday.. show changes since yesterday
2263
When logging a range of revisions using -rX..Y, log starts at
2264
revision Y and searches back in history through the primary
2265
("left-hand") parents until it finds X. When logging just the
2266
top level (using -n1), an error is reported if X is not found
2267
along the way. If multi-level logging is used (-n0), X may be
2268
a nested merge revision and the log will be truncated accordingly.
2272
If parameters are given and the first one is not a branch, the log
2273
will be filtered to show only those revisions that changed the
2274
nominated files or directories.
2276
Filenames are interpreted within their historical context. To log a
2277
deleted file, specify a revision range so that the file existed at
2278
the end or start of the range.
2280
Historical context is also important when interpreting pathnames of
2281
renamed files/directories. Consider the following example:
2283
* revision 1: add tutorial.txt
2284
* revision 2: modify tutorial.txt
2285
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2289
* ``bzr log guide.txt`` will log the file added in revision 1
2291
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2293
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2294
the original file in revision 2.
2296
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2297
was no file called guide.txt in revision 2.
2299
Renames are always followed by log. By design, there is no need to
2300
explicitly ask for this (and no way to stop logging a file back
2301
until it was last renamed).
2305
The --message option can be used for finding revisions that match a
2306
regular expression in a commit message.
2310
GUI tools and IDEs are often better at exploring history than command
2311
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2312
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2313
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2314
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2316
You may find it useful to add the aliases below to ``bazaar.conf``::
2320
top = log -l10 --line
2323
``bzr tip`` will then show the latest revision while ``bzr top``
2324
will show the last 10 mainline revisions. To see the details of a
2325
particular revision X, ``bzr show -rX``.
2327
If you are interested in looking deeper into a particular merge X,
2328
use ``bzr log -n0 -rX``.
2330
``bzr log -v`` on a branch with lots of history is currently
2331
very slow. A fix for this issue is currently under development.
2332
With or without that fix, it is recommended that a revision range
2333
be given when using the -v option.
2335
bzr has a generic full-text matching plugin, bzr-search, that can be
2336
used to find revisions matching user names, commit messages, etc.
2337
Among other features, this plugin can find all revisions containing
2338
a list of words but not others.
2340
When exploring non-mainline history on large projects with deep
2341
history, the performance of log can be greatly improved by installing
2342
the historycache plugin. This plugin buffers historical information
2343
trading disk space for faster speed.
2345
takes_args = ['file*']
2346
_see_also = ['log-formats', 'revisionspec']
2349
help='Show from oldest to newest.'),
2351
custom_help('verbose',
2352
help='Show files changed in each revision.'),
2356
type=bzrlib.option._parse_revision_str,
2358
help='Show just the specified revision.'
2359
' See also "help revisionspec".'),
2361
RegistryOption('authors',
2362
'What names to list as authors - first, all or committer.',
2364
lazy_registry=('bzrlib.log', 'author_list_registry'),
2368
help='Number of levels to display - 0 for all, 1 for flat.',
2370
type=_parse_levels),
2373
help='Show revisions whose message matches this '
2374
'regular expression.',
2378
help='Limit the output to the first N revisions.',
2383
help='Show changes made in each revision as a patch.'),
2384
Option('include-merges',
2385
help='Show merged revisions like --levels 0 does.'),
2386
Option('exclude-common-ancestry',
2387
help='Display only the revisions that are not part'
2388
' of both ancestries (require -rX..Y)'
2391
encoding_type = 'replace'
2394
def run(self, file_list=None, timezone='original',
2405
include_merges=False,
2407
exclude_common_ancestry=False,
2409
from bzrlib.log import (
2411
make_log_request_dict,
2412
_get_info_for_log_files,
2414
direction = (forward and 'forward') or 'reverse'
2415
if (exclude_common_ancestry
2416
and (revision is None or len(revision) != 2)):
2417
raise errors.BzrCommandError(
2418
'--exclude-common-ancestry requires -r with two revisions')
2423
raise errors.BzrCommandError(
2424
'--levels and --include-merges are mutually exclusive')
2426
if change is not None:
2428
raise errors.RangeInChangeOption()
2429
if revision is not None:
2430
raise errors.BzrCommandError(
2431
'--revision and --change are mutually exclusive')
2436
filter_by_dir = False
2438
# find the file ids to log and check for directory filtering
2439
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2440
revision, file_list, self.add_cleanup)
2441
for relpath, file_id, kind in file_info_list:
2443
raise errors.BzrCommandError(
2444
"Path unknown at end or start of revision range: %s" %
2446
# If the relpath is the top of the tree, we log everything
2451
file_ids.append(file_id)
2452
filter_by_dir = filter_by_dir or (
2453
kind in ['directory', 'tree-reference'])
2456
# FIXME ? log the current subdir only RBC 20060203
2457
if revision is not None \
2458
and len(revision) > 0 and revision[0].get_branch():
2459
location = revision[0].get_branch()
2462
dir, relpath = bzrdir.BzrDir.open_containing(location)
2463
b = dir.open_branch()
2464
self.add_cleanup(b.lock_read().unlock)
2465
rev1, rev2 = _get_revision_range(revision, b, self.name())
2467
# Decide on the type of delta & diff filtering to use
2468
# TODO: add an --all-files option to make this configurable & consistent
2476
diff_type = 'partial'
2480
# Build the log formatter
2481
if log_format is None:
2482
log_format = log.log_formatter_registry.get_default(b)
2483
# Make a non-encoding output to include the diffs - bug 328007
2484
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2485
lf = log_format(show_ids=show_ids, to_file=self.outf,
2486
to_exact_file=unencoded_output,
2487
show_timezone=timezone,
2488
delta_format=get_verbosity_level(),
2490
show_advice=levels is None,
2491
author_list_handler=authors)
2493
# Choose the algorithm for doing the logging. It's annoying
2494
# having multiple code paths like this but necessary until
2495
# the underlying repository format is faster at generating
2496
# deltas or can provide everything we need from the indices.
2497
# The default algorithm - match-using-deltas - works for
2498
# multiple files and directories and is faster for small
2499
# amounts of history (200 revisions say). However, it's too
2500
# slow for logging a single file in a repository with deep
2501
# history, i.e. > 10K revisions. In the spirit of "do no
2502
# evil when adding features", we continue to use the
2503
# original algorithm - per-file-graph - for the "single
2504
# file that isn't a directory without showing a delta" case.
2505
partial_history = revision and b.repository._format.supports_chks
2506
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2507
or delta_type or partial_history)
2509
# Build the LogRequest and execute it
2510
if len(file_ids) == 0:
2512
rqst = make_log_request_dict(
2513
direction=direction, specific_fileids=file_ids,
2514
start_revision=rev1, end_revision=rev2, limit=limit,
2515
message_search=message, delta_type=delta_type,
2516
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2517
exclude_common_ancestry=exclude_common_ancestry,
2519
Logger(b, rqst).show(lf)
2522
def _get_revision_range(revisionspec_list, branch, command_name):
2523
"""Take the input of a revision option and turn it into a revision range.
2525
It returns RevisionInfo objects which can be used to obtain the rev_id's
2526
of the desired revisions. It does some user input validations.
2528
if revisionspec_list is None:
2531
elif len(revisionspec_list) == 1:
2532
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2533
elif len(revisionspec_list) == 2:
2534
start_spec = revisionspec_list[0]
2535
end_spec = revisionspec_list[1]
2536
if end_spec.get_branch() != start_spec.get_branch():
2537
# b is taken from revision[0].get_branch(), and
2538
# show_log will use its revision_history. Having
2539
# different branches will lead to weird behaviors.
2540
raise errors.BzrCommandError(
2541
"bzr %s doesn't accept two revisions in different"
2542
" branches." % command_name)
2543
if start_spec.spec is None:
2544
# Avoid loading all the history.
2545
rev1 = RevisionInfo(branch, None, None)
2547
rev1 = start_spec.in_history(branch)
2548
# Avoid loading all of history when we know a missing
2549
# end of range means the last revision ...
2550
if end_spec.spec is None:
2551
last_revno, last_revision_id = branch.last_revision_info()
2552
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2554
rev2 = end_spec.in_history(branch)
2556
raise errors.BzrCommandError(
2557
'bzr %s --revision takes one or two values.' % command_name)
2561
def _revision_range_to_revid_range(revision_range):
2564
if revision_range[0] is not None:
2565
rev_id1 = revision_range[0].rev_id
2566
if revision_range[1] is not None:
2567
rev_id2 = revision_range[1].rev_id
2568
return rev_id1, rev_id2
2570
def get_log_format(long=False, short=False, line=False, default='long'):
2571
log_format = default
2575
log_format = 'short'
2581
class cmd_touching_revisions(Command):
2582
__doc__ = """Return revision-ids which affected a particular file.
2584
A more user-friendly interface is "bzr log FILE".
2588
takes_args = ["filename"]
2591
def run(self, filename):
2592
tree, relpath = WorkingTree.open_containing(filename)
2593
file_id = tree.path2id(relpath)
2595
self.add_cleanup(b.lock_read().unlock)
2596
touching_revs = log.find_touching_revisions(b, file_id)
2597
for revno, revision_id, what in touching_revs:
2598
self.outf.write("%6d %s\n" % (revno, what))
2601
class cmd_ls(Command):
2602
__doc__ = """List files in a tree.
2605
_see_also = ['status', 'cat']
2606
takes_args = ['path?']
2610
Option('recursive', short_name='R',
2611
help='Recurse into subdirectories.'),
2613
help='Print paths relative to the root of the branch.'),
2614
Option('unknown', short_name='u',
2615
help='Print unknown files.'),
2616
Option('versioned', help='Print versioned files.',
2618
Option('ignored', short_name='i',
2619
help='Print ignored files.'),
2620
Option('kind', short_name='k',
2621
help='List entries of a particular kind: file, directory, symlink.',
2628
def run(self, revision=None, verbose=False,
2629
recursive=False, from_root=False,
2630
unknown=False, versioned=False, ignored=False,
2631
null=False, kind=None, show_ids=False, path=None, directory=None):
2633
if kind and kind not in ('file', 'directory', 'symlink'):
2634
raise errors.BzrCommandError('invalid kind specified')
2636
if verbose and null:
2637
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2638
all = not (unknown or versioned or ignored)
2640
selection = {'I':ignored, '?':unknown, 'V':versioned}
2646
raise errors.BzrCommandError('cannot specify both --from-root'
2649
tree, branch, relpath = \
2650
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2652
# Calculate the prefix to use
2656
prefix = relpath + '/'
2657
elif fs_path != '.' and not fs_path.endswith('/'):
2658
prefix = fs_path + '/'
2660
if revision is not None or tree is None:
2661
tree = _get_one_revision_tree('ls', revision, branch=branch)
2664
if isinstance(tree, WorkingTree) and tree.supports_views():
2665
view_files = tree.views.lookup_view()
2668
view_str = views.view_display_str(view_files)
2669
note("Ignoring files outside view. View is %s" % view_str)
2671
self.add_cleanup(tree.lock_read().unlock)
2672
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2673
from_dir=relpath, recursive=recursive):
2674
# Apply additional masking
2675
if not all and not selection[fc]:
2677
if kind is not None and fkind != kind:
2682
fullpath = osutils.pathjoin(relpath, fp)
2685
views.check_path_in_view(tree, fullpath)
2686
except errors.FileOutsideView:
2691
fp = osutils.pathjoin(prefix, fp)
2692
kindch = entry.kind_character()
2693
outstring = fp + kindch
2694
ui.ui_factory.clear_term()
2696
outstring = '%-8s %s' % (fc, outstring)
2697
if show_ids and fid is not None:
2698
outstring = "%-50s %s" % (outstring, fid)
2699
self.outf.write(outstring + '\n')
2701
self.outf.write(fp + '\0')
2704
self.outf.write(fid)
2705
self.outf.write('\0')
2713
self.outf.write('%-50s %s\n' % (outstring, my_id))
2715
self.outf.write(outstring + '\n')
2718
class cmd_unknowns(Command):
2719
__doc__ = """List unknown files.
2724
takes_options = ['directory']
2727
def run(self, directory=u'.'):
2728
for f in WorkingTree.open_containing(directory)[0].unknowns():
2729
self.outf.write(osutils.quotefn(f) + '\n')
2732
class cmd_ignore(Command):
2733
__doc__ = """Ignore specified files or patterns.
2735
See ``bzr help patterns`` for details on the syntax of patterns.
2737
If a .bzrignore file does not exist, the ignore command
2738
will create one and add the specified files or patterns to the newly
2739
created file. The ignore command will also automatically add the
2740
.bzrignore file to be versioned. Creating a .bzrignore file without
2741
the use of the ignore command will require an explicit add command.
2743
To remove patterns from the ignore list, edit the .bzrignore file.
2744
After adding, editing or deleting that file either indirectly by
2745
using this command or directly by using an editor, be sure to commit
2748
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2749
the global ignore file can be found in the application data directory as
2750
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2751
Global ignores are not touched by this command. The global ignore file
2752
can be edited directly using an editor.
2754
Patterns prefixed with '!' are exceptions to ignore patterns and take
2755
precedence over regular ignores. Such exceptions are used to specify
2756
files that should be versioned which would otherwise be ignored.
2758
Patterns prefixed with '!!' act as regular ignore patterns, but have
2759
precedence over the '!' exception patterns.
2763
* Ignore patterns containing shell wildcards must be quoted from
2766
* Ignore patterns starting with "#" act as comments in the ignore file.
2767
To ignore patterns that begin with that character, use the "RE:" prefix.
2770
Ignore the top level Makefile::
2772
bzr ignore ./Makefile
2774
Ignore .class files in all directories...::
2776
bzr ignore "*.class"
2778
...but do not ignore "special.class"::
2780
bzr ignore "!special.class"
2782
Ignore files whose name begins with the "#" character::
2786
Ignore .o files under the lib directory::
2788
bzr ignore "lib/**/*.o"
2790
Ignore .o files under the lib directory::
2792
bzr ignore "RE:lib/.*\.o"
2794
Ignore everything but the "debian" toplevel directory::
2796
bzr ignore "RE:(?!debian/).*"
2798
Ignore everything except the "local" toplevel directory,
2799
but always ignore autosave files ending in ~, even under local/::
2802
bzr ignore "!./local"
2806
_see_also = ['status', 'ignored', 'patterns']
2807
takes_args = ['name_pattern*']
2808
takes_options = ['directory',
2809
Option('default-rules',
2810
help='Display the default ignore rules that bzr uses.')
2813
def run(self, name_pattern_list=None, default_rules=None,
2815
from bzrlib import ignores
2816
if default_rules is not None:
2817
# dump the default rules and exit
2818
for pattern in ignores.USER_DEFAULTS:
2819
self.outf.write("%s\n" % pattern)
2821
if not name_pattern_list:
2822
raise errors.BzrCommandError("ignore requires at least one "
2823
"NAME_PATTERN or --default-rules.")
2824
name_pattern_list = [globbing.normalize_pattern(p)
2825
for p in name_pattern_list]
2827
for p in name_pattern_list:
2828
if not globbing.Globster.is_pattern_valid(p):
2829
bad_patterns += ('\n %s' % p)
2831
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2832
ui.ui_factory.show_error(msg)
2833
raise errors.InvalidPattern('')
2834
for name_pattern in name_pattern_list:
2835
if (name_pattern[0] == '/' or
2836
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2837
raise errors.BzrCommandError(
2838
"NAME_PATTERN should not be an absolute path")
2839
tree, relpath = WorkingTree.open_containing(directory)
2840
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2841
ignored = globbing.Globster(name_pattern_list)
2843
self.add_cleanup(tree.lock_read().unlock)
2844
for entry in tree.list_files():
2848
if ignored.match(filename):
2849
matches.append(filename)
2850
if len(matches) > 0:
2851
self.outf.write("Warning: the following files are version controlled and"
2852
" match your ignore pattern:\n%s"
2853
"\nThese files will continue to be version controlled"
2854
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2857
class cmd_ignored(Command):
2858
__doc__ = """List ignored files and the patterns that matched them.
2860
List all the ignored files and the ignore pattern that caused the file to
2863
Alternatively, to list just the files::
2868
encoding_type = 'replace'
2869
_see_also = ['ignore', 'ls']
2870
takes_options = ['directory']
2873
def run(self, directory=u'.'):
2874
tree = WorkingTree.open_containing(directory)[0]
2875
self.add_cleanup(tree.lock_read().unlock)
2876
for path, file_class, kind, file_id, entry in tree.list_files():
2877
if file_class != 'I':
2879
## XXX: Slightly inefficient since this was already calculated
2880
pat = tree.is_ignored(path)
2881
self.outf.write('%-50s %s\n' % (path, pat))
2884
class cmd_lookup_revision(Command):
2885
__doc__ = """Lookup the revision-id from a revision-number
2888
bzr lookup-revision 33
2891
takes_args = ['revno']
2892
takes_options = ['directory']
2895
def run(self, revno, directory=u'.'):
2899
raise errors.BzrCommandError("not a valid revision-number: %r"
2901
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2902
self.outf.write("%s\n" % revid)
2905
class cmd_export(Command):
2906
__doc__ = """Export current or past revision to a destination directory or archive.
2908
If no revision is specified this exports the last committed revision.
2910
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2911
given, try to find the format with the extension. If no extension
2912
is found exports to a directory (equivalent to --format=dir).
2914
If root is supplied, it will be used as the root directory inside
2915
container formats (tar, zip, etc). If it is not supplied it will default
2916
to the exported filename. The root option has no effect for 'dir' format.
2918
If branch is omitted then the branch containing the current working
2919
directory will be used.
2921
Note: Export of tree with non-ASCII filenames to zip is not supported.
2923
================= =========================
2924
Supported formats Autodetected by extension
2925
================= =========================
2928
tbz2 .tar.bz2, .tbz2
2931
================= =========================
2934
takes_args = ['dest', 'branch_or_subdir?']
2935
takes_options = ['directory',
2937
help="Type of file to export to.",
2940
Option('filters', help='Apply content filters to export the '
2941
'convenient form.'),
2944
help="Name of the root directory inside the exported file."),
2945
Option('per-file-timestamps',
2946
help='Set modification time of files to that of the last '
2947
'revision in which it was changed.'),
2949
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2950
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2951
from bzrlib.export import export
2953
if branch_or_subdir is None:
2954
tree = WorkingTree.open_containing(directory)[0]
2958
b, subdir = Branch.open_containing(branch_or_subdir)
2961
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2963
export(rev_tree, dest, format, root, subdir, filtered=filters,
2964
per_file_timestamps=per_file_timestamps)
2965
except errors.NoSuchExportFormat, e:
2966
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2969
class cmd_cat(Command):
2970
__doc__ = """Write the contents of a file as of a given revision to standard output.
2972
If no revision is nominated, the last revision is used.
2974
Note: Take care to redirect standard output when using this command on a
2979
takes_options = ['directory',
2980
Option('name-from-revision', help='The path name in the old tree.'),
2981
Option('filters', help='Apply content filters to display the '
2982
'convenience form.'),
2985
takes_args = ['filename']
2986
encoding_type = 'exact'
2989
def run(self, filename, revision=None, name_from_revision=False,
2990
filters=False, directory=None):
2991
if revision is not None and len(revision) != 1:
2992
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2993
" one revision specifier")
2994
tree, branch, relpath = \
2995
_open_directory_or_containing_tree_or_branch(filename, directory)
2996
self.add_cleanup(branch.lock_read().unlock)
2997
return self._run(tree, branch, relpath, filename, revision,
2998
name_from_revision, filters)
3000
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3003
tree = b.basis_tree()
3004
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3005
self.add_cleanup(rev_tree.lock_read().unlock)
3007
old_file_id = rev_tree.path2id(relpath)
3009
if name_from_revision:
3010
# Try in revision if requested
3011
if old_file_id is None:
3012
raise errors.BzrCommandError(
3013
"%r is not present in revision %s" % (
3014
filename, rev_tree.get_revision_id()))
3016
content = rev_tree.get_file_text(old_file_id)
3018
cur_file_id = tree.path2id(relpath)
3020
if cur_file_id is not None:
3021
# Then try with the actual file id
3023
content = rev_tree.get_file_text(cur_file_id)
3025
except errors.NoSuchId:
3026
# The actual file id didn't exist at that time
3028
if not found and old_file_id is not None:
3029
# Finally try with the old file id
3030
content = rev_tree.get_file_text(old_file_id)
3033
# Can't be found anywhere
3034
raise errors.BzrCommandError(
3035
"%r is not present in revision %s" % (
3036
filename, rev_tree.get_revision_id()))
3038
from bzrlib.filters import (
3039
ContentFilterContext,
3040
filtered_output_bytes,
3042
filters = rev_tree._content_filter_stack(relpath)
3043
chunks = content.splitlines(True)
3044
content = filtered_output_bytes(chunks, filters,
3045
ContentFilterContext(relpath, rev_tree))
3047
self.outf.writelines(content)
3050
self.outf.write(content)
3053
class cmd_local_time_offset(Command):
3054
__doc__ = """Show the offset in seconds from GMT to local time."""
3058
self.outf.write("%s\n" % osutils.local_time_offset())
3062
class cmd_commit(Command):
3063
__doc__ = """Commit changes into a new revision.
3065
An explanatory message needs to be given for each commit. This is
3066
often done by using the --message option (getting the message from the
3067
command line) or by using the --file option (getting the message from
3068
a file). If neither of these options is given, an editor is opened for
3069
the user to enter the message. To see the changed files in the
3070
boilerplate text loaded into the editor, use the --show-diff option.
3072
By default, the entire tree is committed and the person doing the
3073
commit is assumed to be the author. These defaults can be overridden
3078
If selected files are specified, only changes to those files are
3079
committed. If a directory is specified then the directory and
3080
everything within it is committed.
3082
When excludes are given, they take precedence over selected files.
3083
For example, to commit only changes within foo, but not changes
3086
bzr commit foo -x foo/bar
3088
A selective commit after a merge is not yet supported.
3092
If the author of the change is not the same person as the committer,
3093
you can specify the author's name using the --author option. The
3094
name should be in the same format as a committer-id, e.g.
3095
"John Doe <jdoe@example.com>". If there is more than one author of
3096
the change you can specify the option multiple times, once for each
3101
A common mistake is to forget to add a new file or directory before
3102
running the commit command. The --strict option checks for unknown
3103
files and aborts the commit if any are found. More advanced pre-commit
3104
checks can be implemented by defining hooks. See ``bzr help hooks``
3109
If you accidentially commit the wrong changes or make a spelling
3110
mistake in the commit message say, you can use the uncommit command
3111
to undo it. See ``bzr help uncommit`` for details.
3113
Hooks can also be configured to run after a commit. This allows you
3114
to trigger updates to external systems like bug trackers. The --fixes
3115
option can be used to record the association between a revision and
3116
one or more bugs. See ``bzr help bugs`` for details.
3119
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3120
takes_args = ['selected*']
3122
ListOption('exclude', type=str, short_name='x',
3123
help="Do not consider changes made to a given path."),
3124
Option('message', type=unicode,
3126
help="Description of the new revision."),
3129
help='Commit even if nothing has changed.'),
3130
Option('file', type=str,
3133
help='Take commit message from this file.'),
3135
help="Refuse to commit if there are unknown "
3136
"files in the working tree."),
3137
Option('commit-time', type=str,
3138
help="Manually set a commit time using commit date "
3139
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3140
ListOption('fixes', type=str,
3141
help="Mark a bug as being fixed by this revision "
3142
"(see \"bzr help bugs\")."),
3143
ListOption('author', type=unicode,
3144
help="Set the author's name, if it's different "
3145
"from the committer."),
3147
help="Perform a local commit in a bound "
3148
"branch. Local commits are not pushed to "
3149
"the master branch until a normal commit "
3152
Option('show-diff', short_name='p',
3153
help='When no message is supplied, show the diff along'
3154
' with the status summary in the message editor.'),
3156
help='When committing to a foreign version control '
3157
'system do not push data that can not be natively '
3160
aliases = ['ci', 'checkin']
3162
def _iter_bug_fix_urls(self, fixes, branch):
3163
# Configure the properties for bug fixing attributes.
3164
for fixed_bug in fixes:
3165
tokens = fixed_bug.split(':')
3166
if len(tokens) != 2:
3167
raise errors.BzrCommandError(
3168
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3169
"See \"bzr help bugs\" for more information on this "
3170
"feature.\nCommit refused." % fixed_bug)
3171
tag, bug_id = tokens
3173
yield bugtracker.get_bug_url(tag, branch, bug_id)
3174
except errors.UnknownBugTrackerAbbreviation:
3175
raise errors.BzrCommandError(
3176
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3177
except errors.MalformedBugIdentifier, e:
3178
raise errors.BzrCommandError(
3179
"%s\nCommit refused." % (str(e),))
3181
def run(self, message=None, file=None, verbose=False, selected_list=None,
3182
unchanged=False, strict=False, local=False, fixes=None,
3183
author=None, show_diff=False, exclude=None, commit_time=None,
3185
from bzrlib.errors import (
3190
from bzrlib.msgeditor import (
3191
edit_commit_message_encoded,
3192
generate_commit_message_template,
3193
make_commit_message_template_encoded
3196
commit_stamp = offset = None
3197
if commit_time is not None:
3199
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3200
except ValueError, e:
3201
raise errors.BzrCommandError(
3202
"Could not parse --commit-time: " + str(e))
3206
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3207
if selected_list == ['']:
3208
# workaround - commit of root of tree should be exactly the same
3209
# as just default commit in that tree, and succeed even though
3210
# selected-file merge commit is not done yet
3215
bug_property = bugtracker.encode_fixes_bug_urls(
3216
self._iter_bug_fix_urls(fixes, tree.branch))
3218
properties['bugs'] = bug_property
3220
if local and not tree.branch.get_bound_location():
3221
raise errors.LocalRequiresBoundBranch()
3223
if message is not None:
3225
file_exists = osutils.lexists(message)
3226
except UnicodeError:
3227
# The commit message contains unicode characters that can't be
3228
# represented in the filesystem encoding, so that can't be a
3233
'The commit message is a file name: "%(f)s".\n'
3234
'(use --file "%(f)s" to take commit message from that file)'
3236
ui.ui_factory.show_warning(warning_msg)
3238
message = message.replace('\r\n', '\n')
3239
message = message.replace('\r', '\n')
3241
raise errors.BzrCommandError(
3242
"please specify either --message or --file")
3244
def get_message(commit_obj):
3245
"""Callback to get commit message"""
3249
my_message = f.read().decode(osutils.get_user_encoding())
3252
elif message is not None:
3253
my_message = message
3255
# No message supplied: make one up.
3256
# text is the status of the tree
3257
text = make_commit_message_template_encoded(tree,
3258
selected_list, diff=show_diff,
3259
output_encoding=osutils.get_user_encoding())
3260
# start_message is the template generated from hooks
3261
# XXX: Warning - looks like hooks return unicode,
3262
# make_commit_message_template_encoded returns user encoding.
3263
# We probably want to be using edit_commit_message instead to
3265
start_message = generate_commit_message_template(commit_obj)
3266
my_message = edit_commit_message_encoded(text,
3267
start_message=start_message)
3268
if my_message is None:
3269
raise errors.BzrCommandError("please specify a commit"
3270
" message with either --message or --file")
3271
if my_message == "":
3272
raise errors.BzrCommandError("empty commit message specified")
3275
# The API permits a commit with a filter of [] to mean 'select nothing'
3276
# but the command line should not do that.
3277
if not selected_list:
3278
selected_list = None
3280
tree.commit(message_callback=get_message,
3281
specific_files=selected_list,
3282
allow_pointless=unchanged, strict=strict, local=local,
3283
reporter=None, verbose=verbose, revprops=properties,
3284
authors=author, timestamp=commit_stamp,
3286
exclude=tree.safe_relpath_files(exclude),
3288
except PointlessCommit:
3289
raise errors.BzrCommandError("No changes to commit."
3290
" Please 'bzr add' the files you want to commit, or use"
3291
" --unchanged to force an empty commit.")
3292
except ConflictsInTree:
3293
raise errors.BzrCommandError('Conflicts detected in working '
3294
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3296
except StrictCommitFailed:
3297
raise errors.BzrCommandError("Commit refused because there are"
3298
" unknown files in the working tree.")
3299
except errors.BoundBranchOutOfDate, e:
3300
e.extra_help = ("\n"
3301
'To commit to master branch, run update and then commit.\n'
3302
'You can also pass --local to commit to continue working '
3307
class cmd_check(Command):
3308
__doc__ = """Validate working tree structure, branch consistency and repository history.
3310
This command checks various invariants about branch and repository storage
3311
to detect data corruption or bzr bugs.
3313
The working tree and branch checks will only give output if a problem is
3314
detected. The output fields of the repository check are:
3317
This is just the number of revisions checked. It doesn't
3321
This is just the number of versionedfiles checked. It
3322
doesn't indicate a problem.
3324
unreferenced ancestors
3325
Texts that are ancestors of other texts, but
3326
are not properly referenced by the revision ancestry. This is a
3327
subtle problem that Bazaar can work around.
3330
This is the total number of unique file contents
3331
seen in the checked revisions. It does not indicate a problem.
3334
This is the total number of repeated texts seen
3335
in the checked revisions. Texts can be repeated when their file
3336
entries are modified, but the file contents are not. It does not
3339
If no restrictions are specified, all Bazaar data that is found at the given
3340
location will be checked.
3344
Check the tree and branch at 'foo'::
3346
bzr check --tree --branch foo
3348
Check only the repository at 'bar'::
3350
bzr check --repo bar
3352
Check everything at 'baz'::
3357
_see_also = ['reconcile']
3358
takes_args = ['path?']
3359
takes_options = ['verbose',
3360
Option('branch', help="Check the branch related to the"
3361
" current directory."),
3362
Option('repo', help="Check the repository related to the"
3363
" current directory."),
3364
Option('tree', help="Check the working tree related to"
3365
" the current directory.")]
3367
def run(self, path=None, verbose=False, branch=False, repo=False,
3369
from bzrlib.check import check_dwim
3372
if not branch and not repo and not tree:
3373
branch = repo = tree = True
3374
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3377
class cmd_upgrade(Command):
3378
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3380
When the default format has changed after a major new release of
3381
Bazaar, you may be informed during certain operations that you
3382
should upgrade. Upgrading to a newer format may improve performance
3383
or make new features available. It may however limit interoperability
3384
with older repositories or with older versions of Bazaar.
3386
If you wish to upgrade to a particular format rather than the
3387
current default, that can be specified using the --format option.
3388
As a consequence, you can use the upgrade command this way to
3389
"downgrade" to an earlier format, though some conversions are
3390
a one way process (e.g. changing from the 1.x default to the
3391
2.x default) so downgrading is not always possible.
3393
A backup.bzr.~#~ directory is created at the start of the conversion
3394
process (where # is a number). By default, this is left there on
3395
completion. If the conversion fails, delete the new .bzr directory
3396
and rename this one back in its place. Use the --clean option to ask
3397
for the backup.bzr directory to be removed on successful conversion.
3398
Alternatively, you can delete it by hand if everything looks good
3401
If the location given is a shared repository, dependent branches
3402
are also converted provided the repository converts successfully.
3403
If the conversion of a branch fails, remaining branches are still
3406
For more information on upgrades, see the Bazaar Upgrade Guide,
3407
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3410
_see_also = ['check', 'reconcile', 'formats']
3411
takes_args = ['url?']
3413
RegistryOption('format',
3414
help='Upgrade to a specific format. See "bzr help'
3415
' formats" for details.',
3416
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3417
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3418
value_switches=True, title='Branch format'),
3420
help='Remove the backup.bzr directory if successful.'),
3422
help="Show what would be done, but don't actually do anything."),
3425
def run(self, url='.', format=None, clean=False, dry_run=False):
3426
from bzrlib.upgrade import upgrade
3427
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3429
if len(exceptions) == 1:
3430
# Compatibility with historical behavior
3436
class cmd_whoami(Command):
3437
__doc__ = """Show or set bzr user id.
3440
Show the email of the current user::
3444
Set the current user::
3446
bzr whoami "Frank Chu <fchu@example.com>"
3448
takes_options = [ 'directory',
3450
help='Display email address only.'),
3452
help='Set identity for the current branch instead of '
3455
takes_args = ['name?']
3456
encoding_type = 'replace'
3459
def run(self, email=False, branch=False, name=None, directory=None):
3461
if directory is None:
3462
# use branch if we're inside one; otherwise global config
3464
c = Branch.open_containing(u'.')[0].get_config()
3465
except errors.NotBranchError:
3466
c = _mod_config.GlobalConfig()
3468
c = Branch.open(directory).get_config()
3470
self.outf.write(c.user_email() + '\n')
3472
self.outf.write(c.username() + '\n')
3476
raise errors.BzrCommandError("--email can only be used to display existing "
3479
# display a warning if an email address isn't included in the given name.
3481
_mod_config.extract_email_address(name)
3482
except errors.NoEmailInUsername, e:
3483
warning('"%s" does not seem to contain an email address. '
3484
'This is allowed, but not recommended.', name)
3486
# use global config unless --branch given
3488
if directory is None:
3489
c = Branch.open_containing(u'.')[0].get_config()
3491
c = Branch.open(directory).get_config()
3493
c = _mod_config.GlobalConfig()
3494
c.set_user_option('email', name)
3497
class cmd_nick(Command):
3498
__doc__ = """Print or set the branch nickname.
3500
If unset, the tree root directory name is used as the nickname.
3501
To print the current nickname, execute with no argument.
3503
Bound branches use the nickname of its master branch unless it is set
3507
_see_also = ['info']
3508
takes_args = ['nickname?']
3509
takes_options = ['directory']
3510
def run(self, nickname=None, directory=u'.'):
3511
branch = Branch.open_containing(directory)[0]
3512
if nickname is None:
3513
self.printme(branch)
3515
branch.nick = nickname
3518
def printme(self, branch):
3519
self.outf.write('%s\n' % branch.nick)
3522
class cmd_alias(Command):
3523
__doc__ = """Set/unset and display aliases.
3526
Show the current aliases::
3530
Show the alias specified for 'll'::
3534
Set an alias for 'll'::
3536
bzr alias ll="log --line -r-10..-1"
3538
To remove an alias for 'll'::
3540
bzr alias --remove ll
3543
takes_args = ['name?']
3545
Option('remove', help='Remove the alias.'),
3548
def run(self, name=None, remove=False):
3550
self.remove_alias(name)
3552
self.print_aliases()
3554
equal_pos = name.find('=')
3556
self.print_alias(name)
3558
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3560
def remove_alias(self, alias_name):
3561
if alias_name is None:
3562
raise errors.BzrCommandError(
3563
'bzr alias --remove expects an alias to remove.')
3564
# If alias is not found, print something like:
3565
# unalias: foo: not found
3566
c = _mod_config.GlobalConfig()
3567
c.unset_alias(alias_name)
3570
def print_aliases(self):
3571
"""Print out the defined aliases in a similar format to bash."""
3572
aliases = _mod_config.GlobalConfig().get_aliases()
3573
for key, value in sorted(aliases.iteritems()):
3574
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3577
def print_alias(self, alias_name):
3578
from bzrlib.commands import get_alias
3579
alias = get_alias(alias_name)
3581
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3584
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3586
def set_alias(self, alias_name, alias_command):
3587
"""Save the alias in the global config."""
3588
c = _mod_config.GlobalConfig()
3589
c.set_alias(alias_name, alias_command)
3592
class cmd_selftest(Command):
3593
__doc__ = """Run internal test suite.
3595
If arguments are given, they are regular expressions that say which tests
3596
should run. Tests matching any expression are run, and other tests are
3599
Alternatively if --first is given, matching tests are run first and then
3600
all other tests are run. This is useful if you have been working in a
3601
particular area, but want to make sure nothing else was broken.
3603
If --exclude is given, tests that match that regular expression are
3604
excluded, regardless of whether they match --first or not.
3606
To help catch accidential dependencies between tests, the --randomize
3607
option is useful. In most cases, the argument used is the word 'now'.
3608
Note that the seed used for the random number generator is displayed
3609
when this option is used. The seed can be explicitly passed as the
3610
argument to this option if required. This enables reproduction of the
3611
actual ordering used if and when an order sensitive problem is encountered.
3613
If --list-only is given, the tests that would be run are listed. This is
3614
useful when combined with --first, --exclude and/or --randomize to
3615
understand their impact. The test harness reports "Listed nn tests in ..."
3616
instead of "Ran nn tests in ..." when list mode is enabled.
3618
If the global option '--no-plugins' is given, plugins are not loaded
3619
before running the selftests. This has two effects: features provided or
3620
modified by plugins will not be tested, and tests provided by plugins will
3623
Tests that need working space on disk use a common temporary directory,
3624
typically inside $TMPDIR or /tmp.
3626
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3627
into a pdb postmortem session.
3629
The --coverage=DIRNAME global option produces a report with covered code
3633
Run only tests relating to 'ignore'::
3637
Disable plugins and list tests as they're run::
3639
bzr --no-plugins selftest -v
3641
# NB: this is used from the class without creating an instance, which is
3642
# why it does not have a self parameter.
3643
def get_transport_type(typestring):
3644
"""Parse and return a transport specifier."""
3645
if typestring == "sftp":
3646
from bzrlib.tests import stub_sftp
3647
return stub_sftp.SFTPAbsoluteServer
3648
if typestring == "memory":
3649
from bzrlib.tests import test_server
3650
return memory.MemoryServer
3651
if typestring == "fakenfs":
3652
from bzrlib.tests import test_server
3653
return test_server.FakeNFSServer
3654
msg = "No known transport type %s. Supported types are: sftp\n" %\
3656
raise errors.BzrCommandError(msg)
3659
takes_args = ['testspecs*']
3660
takes_options = ['verbose',
3662
help='Stop when one test fails.',
3666
help='Use a different transport by default '
3667
'throughout the test suite.',
3668
type=get_transport_type),
3670
help='Run the benchmarks rather than selftests.',
3672
Option('lsprof-timed',
3673
help='Generate lsprof output for benchmarked'
3674
' sections of code.'),
3675
Option('lsprof-tests',
3676
help='Generate lsprof output for each test.'),
3678
help='Run all tests, but run specified tests first.',
3682
help='List the tests instead of running them.'),
3683
RegistryOption('parallel',
3684
help="Run the test suite in parallel.",
3685
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3686
value_switches=False,
3688
Option('randomize', type=str, argname="SEED",
3689
help='Randomize the order of tests using the given'
3690
' seed or "now" for the current time.'),
3691
Option('exclude', type=str, argname="PATTERN",
3693
help='Exclude tests that match this regular'
3696
help='Output test progress via subunit.'),
3697
Option('strict', help='Fail on missing dependencies or '
3699
Option('load-list', type=str, argname='TESTLISTFILE',
3700
help='Load a test id list from a text file.'),
3701
ListOption('debugflag', type=str, short_name='E',
3702
help='Turn on a selftest debug flag.'),
3703
ListOption('starting-with', type=str, argname='TESTID',
3704
param_name='starting_with', short_name='s',
3706
'Load only the tests starting with TESTID.'),
3708
encoding_type = 'replace'
3711
Command.__init__(self)
3712
self.additional_selftest_args = {}
3714
def run(self, testspecs_list=None, verbose=False, one=False,
3715
transport=None, benchmark=None,
3717
first=False, list_only=False,
3718
randomize=None, exclude=None, strict=False,
3719
load_list=None, debugflag=None, starting_with=None, subunit=False,
3720
parallel=None, lsprof_tests=False):
3721
from bzrlib import tests
3723
if testspecs_list is not None:
3724
pattern = '|'.join(testspecs_list)
3729
from bzrlib.tests import SubUnitBzrRunner
3731
raise errors.BzrCommandError("subunit not available. subunit "
3732
"needs to be installed to use --subunit.")
3733
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3734
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3735
# stdout, which would corrupt the subunit stream.
3736
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3737
# following code can be deleted when it's sufficiently deployed
3738
# -- vila/mgz 20100514
3739
if (sys.platform == "win32"
3740
and getattr(sys.stdout, 'fileno', None) is not None):
3742
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3744
self.additional_selftest_args.setdefault(
3745
'suite_decorators', []).append(parallel)
3747
raise errors.BzrCommandError(
3748
"--benchmark is no longer supported from bzr 2.2; "
3749
"use bzr-usertest instead")
3750
test_suite_factory = None
3751
selftest_kwargs = {"verbose": verbose,
3753
"stop_on_failure": one,
3754
"transport": transport,
3755
"test_suite_factory": test_suite_factory,
3756
"lsprof_timed": lsprof_timed,
3757
"lsprof_tests": lsprof_tests,
3758
"matching_tests_first": first,
3759
"list_only": list_only,
3760
"random_seed": randomize,
3761
"exclude_pattern": exclude,
3763
"load_list": load_list,
3764
"debug_flags": debugflag,
3765
"starting_with": starting_with
3767
selftest_kwargs.update(self.additional_selftest_args)
3769
# Make deprecation warnings visible, unless -Werror is set
3770
cleanup = symbol_versioning.activate_deprecation_warnings(
3773
result = tests.selftest(**selftest_kwargs)
3776
return int(not result)
3779
class cmd_version(Command):
3780
__doc__ = """Show version of bzr."""
3782
encoding_type = 'replace'
3784
Option("short", help="Print just the version number."),
3788
def run(self, short=False):
3789
from bzrlib.version import show_version
3791
self.outf.write(bzrlib.version_string + '\n')
3793
show_version(to_file=self.outf)
3796
class cmd_rocks(Command):
3797
__doc__ = """Statement of optimism."""
3803
self.outf.write("It sure does!\n")
3806
class cmd_find_merge_base(Command):
3807
__doc__ = """Find and print a base revision for merging two branches."""
3808
# TODO: Options to specify revisions on either side, as if
3809
# merging only part of the history.
3810
takes_args = ['branch', 'other']
3814
def run(self, branch, other):
3815
from bzrlib.revision import ensure_null
3817
branch1 = Branch.open_containing(branch)[0]
3818
branch2 = Branch.open_containing(other)[0]
3819
self.add_cleanup(branch1.lock_read().unlock)
3820
self.add_cleanup(branch2.lock_read().unlock)
3821
last1 = ensure_null(branch1.last_revision())
3822
last2 = ensure_null(branch2.last_revision())
3824
graph = branch1.repository.get_graph(branch2.repository)
3825
base_rev_id = graph.find_unique_lca(last1, last2)
3827
self.outf.write('merge base is revision %s\n' % base_rev_id)
3830
class cmd_merge(Command):
3831
__doc__ = """Perform a three-way merge.
3833
The source of the merge can be specified either in the form of a branch,
3834
or in the form of a path to a file containing a merge directive generated
3835
with bzr send. If neither is specified, the default is the upstream branch
3836
or the branch most recently merged using --remember.
3838
When merging from a branch, by default bzr will try to merge in all new
3839
work from the other branch, automatically determining an appropriate base
3840
revision. If this fails, you may need to give an explicit base.
3842
To pick a different ending revision, pass "--revision OTHER". bzr will
3843
try to merge in all new work up to and including revision OTHER.
3845
If you specify two values, "--revision BASE..OTHER", only revisions BASE
3846
through OTHER, excluding BASE but including OTHER, will be merged. If this
3847
causes some revisions to be skipped, i.e. if the destination branch does
3848
not already contain revision BASE, such a merge is commonly referred to as
3851
Revision numbers are always relative to the source branch.
3853
Merge will do its best to combine the changes in two branches, but there
3854
are some kinds of problems only a human can fix. When it encounters those,
3855
it will mark a conflict. A conflict means that you need to fix something,
3856
before you should commit.
3858
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3860
If there is no default branch set, the first merge will set it. After
3861
that, you can omit the branch to use the default. To change the
3862
default, use --remember. The value will only be saved if the remote
3863
location can be accessed.
3865
The results of the merge are placed into the destination working
3866
directory, where they can be reviewed (with bzr diff), tested, and then
3867
committed to record the result of the merge.
3869
merge refuses to run if there are any uncommitted changes, unless
3870
--force is given. The --force option can also be used to create a
3871
merge revision which has more than two parents.
3873
If one would like to merge changes from the working tree of the other
3874
branch without merging any committed revisions, the --uncommitted option
3877
To select only some changes to merge, use "merge -i", which will prompt
3878
you to apply each diff hunk and file change, similar to "shelve".
3881
To merge all new revisions from bzr.dev::
3883
bzr merge ../bzr.dev
3885
To merge changes up to and including revision 82 from bzr.dev::
3887
bzr merge -r 82 ../bzr.dev
3889
To merge the changes introduced by 82, without previous changes::
3891
bzr merge -r 81..82 ../bzr.dev
3893
To apply a merge directive contained in /tmp/merge::
3895
bzr merge /tmp/merge
3897
To create a merge revision with three parents from two branches
3898
feature1a and feature1b:
3900
bzr merge ../feature1a
3901
bzr merge ../feature1b --force
3902
bzr commit -m 'revision with three parents'
3905
encoding_type = 'exact'
3906
_see_also = ['update', 'remerge', 'status-flags', 'send']
3907
takes_args = ['location?']
3912
help='Merge even if the destination tree has uncommitted changes.'),
3916
Option('show-base', help="Show base revision text in "
3918
Option('uncommitted', help='Apply uncommitted changes'
3919
' from a working copy, instead of branch changes.'),
3920
Option('pull', help='If the destination is already'
3921
' completely merged into the source, pull from the'
3922
' source rather than merging. When this happens,'
3923
' you do not need to commit the result.'),
3924
custom_help('directory',
3925
help='Branch to merge into, '
3926
'rather than the one containing the working directory.'),
3927
Option('preview', help='Instead of merging, show a diff of the'
3929
Option('interactive', help='Select changes interactively.',
3933
def run(self, location=None, revision=None, force=False,
3934
merge_type=None, show_base=False, reprocess=None, remember=False,
3935
uncommitted=False, pull=False,
3940
if merge_type is None:
3941
merge_type = _mod_merge.Merge3Merger
3943
if directory is None: directory = u'.'
3944
possible_transports = []
3946
allow_pending = True
3947
verified = 'inapplicable'
3948
tree = WorkingTree.open_containing(directory)[0]
3951
basis_tree = tree.revision_tree(tree.last_revision())
3952
except errors.NoSuchRevision:
3953
basis_tree = tree.basis_tree()
3955
# die as quickly as possible if there are uncommitted changes
3957
if tree.has_changes():
3958
raise errors.UncommittedChanges(tree)
3960
view_info = _get_view_info_for_change_reporter(tree)
3961
change_reporter = delta._ChangeReporter(
3962
unversioned_filter=tree.is_ignored, view_info=view_info)
3963
pb = ui.ui_factory.nested_progress_bar()
3964
self.add_cleanup(pb.finished)
3965
self.add_cleanup(tree.lock_write().unlock)
3966
if location is not None:
3968
mergeable = bundle.read_mergeable_from_url(location,
3969
possible_transports=possible_transports)
3970
except errors.NotABundle:
3974
raise errors.BzrCommandError('Cannot use --uncommitted'
3975
' with bundles or merge directives.')
3977
if revision is not None:
3978
raise errors.BzrCommandError(
3979
'Cannot use -r with merge directives or bundles')
3980
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3983
if merger is None and uncommitted:
3984
if revision is not None and len(revision) > 0:
3985
raise errors.BzrCommandError('Cannot use --uncommitted and'
3986
' --revision at the same time.')
3987
merger = self.get_merger_from_uncommitted(tree, location, None)
3988
allow_pending = False
3991
merger, allow_pending = self._get_merger_from_branch(tree,
3992
location, revision, remember, possible_transports, None)
3994
merger.merge_type = merge_type
3995
merger.reprocess = reprocess
3996
merger.show_base = show_base
3997
self.sanity_check_merger(merger)
3998
if (merger.base_rev_id == merger.other_rev_id and
3999
merger.other_rev_id is not None):
4000
note('Nothing to do.')
4002
if pull and not preview:
4003
if merger.interesting_files is not None:
4004
raise errors.BzrCommandError('Cannot pull individual files')
4005
if (merger.base_rev_id == tree.last_revision()):
4006
result = tree.pull(merger.other_branch, False,
4007
merger.other_rev_id)
4008
result.report(self.outf)
4010
if merger.this_basis is None:
4011
raise errors.BzrCommandError(
4012
"This branch has no commits."
4013
" (perhaps you would prefer 'bzr pull')")
4015
return self._do_preview(merger)
4017
return self._do_interactive(merger)
4019
return self._do_merge(merger, change_reporter, allow_pending,
4022
def _get_preview(self, merger):
4023
tree_merger = merger.make_merger()
4024
tt = tree_merger.make_preview_transform()
4025
self.add_cleanup(tt.finalize)
4026
result_tree = tt.get_preview_tree()
4029
def _do_preview(self, merger):
4030
from bzrlib.diff import show_diff_trees
4031
result_tree = self._get_preview(merger)
4032
path_encoding = osutils.get_diff_header_encoding()
4033
show_diff_trees(merger.this_tree, result_tree, self.outf,
4034
old_label='', new_label='',
4035
path_encoding=path_encoding)
4037
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4038
merger.change_reporter = change_reporter
4039
conflict_count = merger.do_merge()
4041
merger.set_pending()
4042
if verified == 'failed':
4043
warning('Preview patch does not match changes')
4044
if conflict_count != 0:
4049
def _do_interactive(self, merger):
4050
"""Perform an interactive merge.
4052
This works by generating a preview tree of the merge, then using
4053
Shelver to selectively remove the differences between the working tree
4054
and the preview tree.
4056
from bzrlib import shelf_ui
4057
result_tree = self._get_preview(merger)
4058
writer = bzrlib.option.diff_writer_registry.get()
4059
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4060
reporter=shelf_ui.ApplyReporter(),
4061
diff_writer=writer(sys.stdout))
4067
def sanity_check_merger(self, merger):
4068
if (merger.show_base and
4069
not merger.merge_type is _mod_merge.Merge3Merger):
4070
raise errors.BzrCommandError("Show-base is not supported for this"
4071
" merge type. %s" % merger.merge_type)
4072
if merger.reprocess is None:
4073
if merger.show_base:
4074
merger.reprocess = False
4076
# Use reprocess if the merger supports it
4077
merger.reprocess = merger.merge_type.supports_reprocess
4078
if merger.reprocess and not merger.merge_type.supports_reprocess:
4079
raise errors.BzrCommandError("Conflict reduction is not supported"
4080
" for merge type %s." %
4082
if merger.reprocess and merger.show_base:
4083
raise errors.BzrCommandError("Cannot do conflict reduction and"
4086
def _get_merger_from_branch(self, tree, location, revision, remember,
4087
possible_transports, pb):
4088
"""Produce a merger from a location, assuming it refers to a branch."""
4089
from bzrlib.tag import _merge_tags_if_possible
4090
# find the branch locations
4091
other_loc, user_location = self._select_branch_location(tree, location,
4093
if revision is not None and len(revision) == 2:
4094
base_loc, _unused = self._select_branch_location(tree,
4095
location, revision, 0)
4097
base_loc = other_loc
4099
other_branch, other_path = Branch.open_containing(other_loc,
4100
possible_transports)
4101
if base_loc == other_loc:
4102
base_branch = other_branch
4104
base_branch, base_path = Branch.open_containing(base_loc,
4105
possible_transports)
4106
# Find the revision ids
4107
other_revision_id = None
4108
base_revision_id = None
4109
if revision is not None:
4110
if len(revision) >= 1:
4111
other_revision_id = revision[-1].as_revision_id(other_branch)
4112
if len(revision) == 2:
4113
base_revision_id = revision[0].as_revision_id(base_branch)
4114
if other_revision_id is None:
4115
other_revision_id = _mod_revision.ensure_null(
4116
other_branch.last_revision())
4117
# Remember where we merge from
4118
if ((remember or tree.branch.get_submit_branch() is None) and
4119
user_location is not None):
4120
tree.branch.set_submit_branch(other_branch.base)
4121
# Merge tags (but don't set them in the master branch yet, the user
4122
# might revert this merge). Commit will propagate them.
4123
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4124
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4125
other_revision_id, base_revision_id, other_branch, base_branch)
4126
if other_path != '':
4127
allow_pending = False
4128
merger.interesting_files = [other_path]
4130
allow_pending = True
4131
return merger, allow_pending
4133
def get_merger_from_uncommitted(self, tree, location, pb):
4134
"""Get a merger for uncommitted changes.
4136
:param tree: The tree the merger should apply to.
4137
:param location: The location containing uncommitted changes.
4138
:param pb: The progress bar to use for showing progress.
4140
location = self._select_branch_location(tree, location)[0]
4141
other_tree, other_path = WorkingTree.open_containing(location)
4142
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4143
if other_path != '':
4144
merger.interesting_files = [other_path]
4147
def _select_branch_location(self, tree, user_location, revision=None,
4149
"""Select a branch location, according to possible inputs.
4151
If provided, branches from ``revision`` are preferred. (Both
4152
``revision`` and ``index`` must be supplied.)
4154
Otherwise, the ``location`` parameter is used. If it is None, then the
4155
``submit`` or ``parent`` location is used, and a note is printed.
4157
:param tree: The working tree to select a branch for merging into
4158
:param location: The location entered by the user
4159
:param revision: The revision parameter to the command
4160
:param index: The index to use for the revision parameter. Negative
4161
indices are permitted.
4162
:return: (selected_location, user_location). The default location
4163
will be the user-entered location.
4165
if (revision is not None and index is not None
4166
and revision[index] is not None):
4167
branch = revision[index].get_branch()
4168
if branch is not None:
4169
return branch, branch
4170
if user_location is None:
4171
location = self._get_remembered(tree, 'Merging from')
4173
location = user_location
4174
return location, user_location
4176
def _get_remembered(self, tree, verb_string):
4177
"""Use tree.branch's parent if none was supplied.
4179
Report if the remembered location was used.
4181
stored_location = tree.branch.get_submit_branch()
4182
stored_location_type = "submit"
4183
if stored_location is None:
4184
stored_location = tree.branch.get_parent()
4185
stored_location_type = "parent"
4186
mutter("%s", stored_location)
4187
if stored_location is None:
4188
raise errors.BzrCommandError("No location specified or remembered")
4189
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4190
note(u"%s remembered %s location %s", verb_string,
4191
stored_location_type, display_url)
4192
return stored_location
4195
class cmd_remerge(Command):
4196
__doc__ = """Redo a merge.
4198
Use this if you want to try a different merge technique while resolving
4199
conflicts. Some merge techniques are better than others, and remerge
4200
lets you try different ones on different files.
4202
The options for remerge have the same meaning and defaults as the ones for
4203
merge. The difference is that remerge can (only) be run when there is a
4204
pending merge, and it lets you specify particular files.
4207
Re-do the merge of all conflicted files, and show the base text in
4208
conflict regions, in addition to the usual THIS and OTHER texts::
4210
bzr remerge --show-base
4212
Re-do the merge of "foobar", using the weave merge algorithm, with
4213
additional processing to reduce the size of conflict regions::
4215
bzr remerge --merge-type weave --reprocess foobar
4217
takes_args = ['file*']
4222
help="Show base revision text in conflicts."),
4225
def run(self, file_list=None, merge_type=None, show_base=False,
4227
from bzrlib.conflicts import restore
4228
if merge_type is None:
4229
merge_type = _mod_merge.Merge3Merger
4230
tree, file_list = WorkingTree.open_containing_paths(file_list)
4231
self.add_cleanup(tree.lock_write().unlock)
4232
parents = tree.get_parent_ids()
4233
if len(parents) != 2:
4234
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4235
" merges. Not cherrypicking or"
4237
repository = tree.branch.repository
4238
interesting_ids = None
4240
conflicts = tree.conflicts()
4241
if file_list is not None:
4242
interesting_ids = set()
4243
for filename in file_list:
4244
file_id = tree.path2id(filename)
4246
raise errors.NotVersionedError(filename)
4247
interesting_ids.add(file_id)
4248
if tree.kind(file_id) != "directory":
4251
for name, ie in tree.inventory.iter_entries(file_id):
4252
interesting_ids.add(ie.file_id)
4253
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4255
# Remerge only supports resolving contents conflicts
4256
allowed_conflicts = ('text conflict', 'contents conflict')
4257
restore_files = [c.path for c in conflicts
4258
if c.typestring in allowed_conflicts]
4259
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4260
tree.set_conflicts(ConflictList(new_conflicts))
4261
if file_list is not None:
4262
restore_files = file_list
4263
for filename in restore_files:
4265
restore(tree.abspath(filename))
4266
except errors.NotConflicted:
4268
# Disable pending merges, because the file texts we are remerging
4269
# have not had those merges performed. If we use the wrong parents
4270
# list, we imply that the working tree text has seen and rejected
4271
# all the changes from the other tree, when in fact those changes
4272
# have not yet been seen.
4273
tree.set_parent_ids(parents[:1])
4275
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4276
merger.interesting_ids = interesting_ids
4277
merger.merge_type = merge_type
4278
merger.show_base = show_base
4279
merger.reprocess = reprocess
4280
conflicts = merger.do_merge()
4282
tree.set_parent_ids(parents)
4289
class cmd_revert(Command):
4290
__doc__ = """Revert files to a previous revision.
4292
Giving a list of files will revert only those files. Otherwise, all files
4293
will be reverted. If the revision is not specified with '--revision', the
4294
last committed revision is used.
4296
To remove only some changes, without reverting to a prior version, use
4297
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4298
will remove the changes introduced by the second last commit (-2), without
4299
affecting the changes introduced by the last commit (-1). To remove
4300
certain changes on a hunk-by-hunk basis, see the shelve command.
4302
By default, any files that have been manually changed will be backed up
4303
first. (Files changed only by merge are not backed up.) Backup files have
4304
'.~#~' appended to their name, where # is a number.
4306
When you provide files, you can use their current pathname or the pathname
4307
from the target revision. So you can use revert to "undelete" a file by
4308
name. If you name a directory, all the contents of that directory will be
4311
If you have newly added files since the target revision, they will be
4312
removed. If the files to be removed have been changed, backups will be
4313
created as above. Directories containing unknown files will not be
4316
The working tree contains a list of revisions that have been merged but
4317
not yet committed. These revisions will be included as additional parents
4318
of the next commit. Normally, using revert clears that list as well as
4319
reverting the files. If any files are specified, revert leaves the list
4320
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4321
.`` in the tree root to revert all files but keep the recorded merges,
4322
and ``bzr revert --forget-merges`` to clear the pending merge list without
4323
reverting any files.
4325
Using "bzr revert --forget-merges", it is possible to apply all of the
4326
changes from a branch in a single revision. To do this, perform the merge
4327
as desired. Then doing revert with the "--forget-merges" option will keep
4328
the content of the tree as it was, but it will clear the list of pending
4329
merges. The next commit will then contain all of the changes that are
4330
present in the other branch, but without any other parent revisions.
4331
Because this technique forgets where these changes originated, it may
4332
cause additional conflicts on later merges involving the same source and
4336
_see_also = ['cat', 'export', 'merge', 'shelve']
4339
Option('no-backup', "Do not save backups of reverted files."),
4340
Option('forget-merges',
4341
'Remove pending merge marker, without changing any files.'),
4343
takes_args = ['file*']
4345
def run(self, revision=None, no_backup=False, file_list=None,
4346
forget_merges=None):
4347
tree, file_list = WorkingTree.open_containing_paths(file_list)
4348
self.add_cleanup(tree.lock_tree_write().unlock)
4350
tree.set_parent_ids(tree.get_parent_ids()[:1])
4352
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4355
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4356
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4357
tree.revert(file_list, rev_tree, not no_backup, None,
4358
report_changes=True)
4361
class cmd_assert_fail(Command):
4362
__doc__ = """Test reporting of assertion failures"""
4363
# intended just for use in testing
4368
raise AssertionError("always fails")
4371
class cmd_help(Command):
4372
__doc__ = """Show help on a command or other topic.
4375
_see_also = ['topics']
4377
Option('long', 'Show help on all commands.'),
4379
takes_args = ['topic?']
4380
aliases = ['?', '--help', '-?', '-h']
4383
def run(self, topic=None, long=False):
4385
if topic is None and long:
4387
bzrlib.help.help(topic)
4390
class cmd_shell_complete(Command):
4391
__doc__ = """Show appropriate completions for context.
4393
For a list of all available commands, say 'bzr shell-complete'.
4395
takes_args = ['context?']
4400
def run(self, context=None):
4401
import shellcomplete
4402
shellcomplete.shellcomplete(context)
4405
class cmd_missing(Command):
4406
__doc__ = """Show unmerged/unpulled revisions between two branches.
4408
OTHER_BRANCH may be local or remote.
4410
To filter on a range of revisions, you can use the command -r begin..end
4411
-r revision requests a specific revision, -r ..end or -r begin.. are
4415
1 - some missing revisions
4416
0 - no missing revisions
4420
Determine the missing revisions between this and the branch at the
4421
remembered pull location::
4425
Determine the missing revisions between this and another branch::
4427
bzr missing http://server/branch
4429
Determine the missing revisions up to a specific revision on the other
4432
bzr missing -r ..-10
4434
Determine the missing revisions up to a specific revision on this
4437
bzr missing --my-revision ..-10
4440
_see_also = ['merge', 'pull']
4441
takes_args = ['other_branch?']
4444
Option('reverse', 'Reverse the order of revisions.'),
4446
'Display changes in the local branch only.'),
4447
Option('this' , 'Same as --mine-only.'),
4448
Option('theirs-only',
4449
'Display changes in the remote branch only.'),
4450
Option('other', 'Same as --theirs-only.'),
4454
custom_help('revision',
4455
help='Filter on other branch revisions (inclusive). '
4456
'See "help revisionspec" for details.'),
4457
Option('my-revision',
4458
type=_parse_revision_str,
4459
help='Filter on local branch revisions (inclusive). '
4460
'See "help revisionspec" for details.'),
4461
Option('include-merges',
4462
'Show all revisions in addition to the mainline ones.'),
4464
encoding_type = 'replace'
4467
def run(self, other_branch=None, reverse=False, mine_only=False,
4469
log_format=None, long=False, short=False, line=False,
4470
show_ids=False, verbose=False, this=False, other=False,
4471
include_merges=False, revision=None, my_revision=None,
4473
from bzrlib.missing import find_unmerged, iter_log_revisions
4482
# TODO: We should probably check that we don't have mine-only and
4483
# theirs-only set, but it gets complicated because we also have
4484
# this and other which could be used.
4491
local_branch = Branch.open_containing(directory)[0]
4492
self.add_cleanup(local_branch.lock_read().unlock)
4494
parent = local_branch.get_parent()
4495
if other_branch is None:
4496
other_branch = parent
4497
if other_branch is None:
4498
raise errors.BzrCommandError("No peer location known"
4500
display_url = urlutils.unescape_for_display(parent,
4502
message("Using saved parent location: "
4503
+ display_url + "\n")
4505
remote_branch = Branch.open(other_branch)
4506
if remote_branch.base == local_branch.base:
4507
remote_branch = local_branch
4509
self.add_cleanup(remote_branch.lock_read().unlock)
4511
local_revid_range = _revision_range_to_revid_range(
4512
_get_revision_range(my_revision, local_branch,
4515
remote_revid_range = _revision_range_to_revid_range(
4516
_get_revision_range(revision,
4517
remote_branch, self.name()))
4519
local_extra, remote_extra = find_unmerged(
4520
local_branch, remote_branch, restrict,
4521
backward=not reverse,
4522
include_merges=include_merges,
4523
local_revid_range=local_revid_range,
4524
remote_revid_range=remote_revid_range)
4526
if log_format is None:
4527
registry = log.log_formatter_registry
4528
log_format = registry.get_default(local_branch)
4529
lf = log_format(to_file=self.outf,
4531
show_timezone='original')
4534
if local_extra and not theirs_only:
4535
message("You have %d extra revision(s):\n" %
4537
for revision in iter_log_revisions(local_extra,
4538
local_branch.repository,
4540
lf.log_revision(revision)
4541
printed_local = True
4544
printed_local = False
4546
if remote_extra and not mine_only:
4547
if printed_local is True:
4549
message("You are missing %d revision(s):\n" %
4551
for revision in iter_log_revisions(remote_extra,
4552
remote_branch.repository,
4554
lf.log_revision(revision)
4557
if mine_only and not local_extra:
4558
# We checked local, and found nothing extra
4559
message('This branch is up to date.\n')
4560
elif theirs_only and not remote_extra:
4561
# We checked remote, and found nothing extra
4562
message('Other branch is up to date.\n')
4563
elif not (mine_only or theirs_only or local_extra or
4565
# We checked both branches, and neither one had extra
4567
message("Branches are up to date.\n")
4569
if not status_code and parent is None and other_branch is not None:
4570
self.add_cleanup(local_branch.lock_write().unlock)
4571
# handle race conditions - a parent might be set while we run.
4572
if local_branch.get_parent() is None:
4573
local_branch.set_parent(remote_branch.base)
4577
class cmd_pack(Command):
4578
__doc__ = """Compress the data within a repository.
4580
This operation compresses the data within a bazaar repository. As
4581
bazaar supports automatic packing of repository, this operation is
4582
normally not required to be done manually.
4584
During the pack operation, bazaar takes a backup of existing repository
4585
data, i.e. pack files. This backup is eventually removed by bazaar
4586
automatically when it is safe to do so. To save disk space by removing
4587
the backed up pack files, the --clean-obsolete-packs option may be
4590
Warning: If you use --clean-obsolete-packs and your machine crashes
4591
during or immediately after repacking, you may be left with a state
4592
where the deletion has been written to disk but the new packs have not
4593
been. In this case the repository may be unusable.
4596
_see_also = ['repositories']
4597
takes_args = ['branch_or_repo?']
4599
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4602
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4603
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4605
branch = dir.open_branch()
4606
repository = branch.repository
4607
except errors.NotBranchError:
4608
repository = dir.open_repository()
4609
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4612
class cmd_plugins(Command):
4613
__doc__ = """List the installed plugins.
4615
This command displays the list of installed plugins including
4616
version of plugin and a short description of each.
4618
--verbose shows the path where each plugin is located.
4620
A plugin is an external component for Bazaar that extends the
4621
revision control system, by adding or replacing code in Bazaar.
4622
Plugins can do a variety of things, including overriding commands,
4623
adding new commands, providing additional network transports and
4624
customizing log output.
4626
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4627
for further information on plugins including where to find them and how to
4628
install them. Instructions are also provided there on how to write new
4629
plugins using the Python programming language.
4631
takes_options = ['verbose']
4634
def run(self, verbose=False):
4635
from bzrlib import plugin
4636
self.outf.writelines(
4637
plugin.describe_plugins(show_paths=verbose))
4640
class cmd_testament(Command):
4641
__doc__ = """Show testament (signing-form) of a revision."""
4644
Option('long', help='Produce long-format testament.'),
4646
help='Produce a strict-format testament.')]
4647
takes_args = ['branch?']
4649
def run(self, branch=u'.', revision=None, long=False, strict=False):
4650
from bzrlib.testament import Testament, StrictTestament
4652
testament_class = StrictTestament
4654
testament_class = Testament
4656
b = Branch.open_containing(branch)[0]
4658
b = Branch.open(branch)
4659
self.add_cleanup(b.lock_read().unlock)
4660
if revision is None:
4661
rev_id = b.last_revision()
4663
rev_id = revision[0].as_revision_id(b)
4664
t = testament_class.from_revision(b.repository, rev_id)
4666
sys.stdout.writelines(t.as_text_lines())
4668
sys.stdout.write(t.as_short_text())
4671
class cmd_annotate(Command):
4672
__doc__ = """Show the origin of each line in a file.
4674
This prints out the given file with an annotation on the left side
4675
indicating which revision, author and date introduced the change.
4677
If the origin is the same for a run of consecutive lines, it is
4678
shown only at the top, unless the --all option is given.
4680
# TODO: annotate directories; showing when each file was last changed
4681
# TODO: if the working copy is modified, show annotations on that
4682
# with new uncommitted lines marked
4683
aliases = ['ann', 'blame', 'praise']
4684
takes_args = ['filename']
4685
takes_options = [Option('all', help='Show annotations on all lines.'),
4686
Option('long', help='Show commit date in annotations.'),
4691
encoding_type = 'exact'
4694
def run(self, filename, all=False, long=False, revision=None,
4695
show_ids=False, directory=None):
4696
from bzrlib.annotate import annotate_file, annotate_file_tree
4697
wt, branch, relpath = \
4698
_open_directory_or_containing_tree_or_branch(filename, directory)
4700
self.add_cleanup(wt.lock_read().unlock)
4702
self.add_cleanup(branch.lock_read().unlock)
4703
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4704
self.add_cleanup(tree.lock_read().unlock)
4705
if wt is not None and revision is None:
4706
file_id = wt.path2id(relpath)
4708
file_id = tree.path2id(relpath)
4710
raise errors.NotVersionedError(filename)
4711
if wt is not None and revision is None:
4712
# If there is a tree and we're not annotating historical
4713
# versions, annotate the working tree's content.
4714
annotate_file_tree(wt, file_id, self.outf, long, all,
4717
file_version = tree.get_file_revision(file_id)
4718
annotate_file(branch, file_version, file_id, long, all, self.outf,
4722
class cmd_re_sign(Command):
4723
__doc__ = """Create a digital signature for an existing revision."""
4724
# TODO be able to replace existing ones.
4726
hidden = True # is this right ?
4727
takes_args = ['revision_id*']
4728
takes_options = ['directory', 'revision']
4730
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4731
if revision_id_list is not None and revision is not None:
4732
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4733
if revision_id_list is None and revision is None:
4734
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4735
b = WorkingTree.open_containing(directory)[0].branch
4736
self.add_cleanup(b.lock_write().unlock)
4737
return self._run(b, revision_id_list, revision)
4739
def _run(self, b, revision_id_list, revision):
4740
import bzrlib.gpg as gpg
4741
gpg_strategy = gpg.GPGStrategy(b.get_config())
4742
if revision_id_list is not None:
4743
b.repository.start_write_group()
4745
for revision_id in revision_id_list:
4746
b.repository.sign_revision(revision_id, gpg_strategy)
4748
b.repository.abort_write_group()
4751
b.repository.commit_write_group()
4752
elif revision is not None:
4753
if len(revision) == 1:
4754
revno, rev_id = revision[0].in_history(b)
4755
b.repository.start_write_group()
4757
b.repository.sign_revision(rev_id, gpg_strategy)
4759
b.repository.abort_write_group()
4762
b.repository.commit_write_group()
4763
elif len(revision) == 2:
4764
# are they both on rh- if so we can walk between them
4765
# might be nice to have a range helper for arbitrary
4766
# revision paths. hmm.
4767
from_revno, from_revid = revision[0].in_history(b)
4768
to_revno, to_revid = revision[1].in_history(b)
4769
if to_revid is None:
4770
to_revno = b.revno()
4771
if from_revno is None or to_revno is None:
4772
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4773
b.repository.start_write_group()
4775
for revno in range(from_revno, to_revno + 1):
4776
b.repository.sign_revision(b.get_rev_id(revno),
4779
b.repository.abort_write_group()
4782
b.repository.commit_write_group()
4784
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4787
class cmd_bind(Command):
4788
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4789
If no branch is supplied, rebind to the last bound location.
4791
Once converted into a checkout, commits must succeed on the master branch
4792
before they will be applied to the local branch.
4794
Bound branches use the nickname of its master branch unless it is set
4795
locally, in which case binding will update the local nickname to be
4799
_see_also = ['checkouts', 'unbind']
4800
takes_args = ['location?']
4801
takes_options = ['directory']
4803
def run(self, location=None, directory=u'.'):
4804
b, relpath = Branch.open_containing(directory)
4805
if location is None:
4807
location = b.get_old_bound_location()
4808
except errors.UpgradeRequired:
4809
raise errors.BzrCommandError('No location supplied. '
4810
'This format does not remember old locations.')
4812
if location is None:
4813
if b.get_bound_location() is not None:
4814
raise errors.BzrCommandError('Branch is already bound')
4816
raise errors.BzrCommandError('No location supplied '
4817
'and no previous location known')
4818
b_other = Branch.open(location)
4821
except errors.DivergedBranches:
4822
raise errors.BzrCommandError('These branches have diverged.'
4823
' Try merging, and then bind again.')
4824
if b.get_config().has_explicit_nickname():
4825
b.nick = b_other.nick
4828
class cmd_unbind(Command):
4829
__doc__ = """Convert the current checkout into a regular branch.
4831
After unbinding, the local branch is considered independent and subsequent
4832
commits will be local only.
4835
_see_also = ['checkouts', 'bind']
4837
takes_options = ['directory']
4839
def run(self, directory=u'.'):
4840
b, relpath = Branch.open_containing(directory)
4842
raise errors.BzrCommandError('Local branch is not bound')
4845
class cmd_uncommit(Command):
4846
__doc__ = """Remove the last committed revision.
4848
--verbose will print out what is being removed.
4849
--dry-run will go through all the motions, but not actually
4852
If --revision is specified, uncommit revisions to leave the branch at the
4853
specified revision. For example, "bzr uncommit -r 15" will leave the
4854
branch at revision 15.
4856
Uncommit leaves the working tree ready for a new commit. The only change
4857
it may make is to restore any pending merges that were present before
4861
# TODO: jam 20060108 Add an option to allow uncommit to remove
4862
# unreferenced information in 'branch-as-repository' branches.
4863
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4864
# information in shared branches as well.
4865
_see_also = ['commit']
4866
takes_options = ['verbose', 'revision',
4867
Option('dry-run', help='Don\'t actually make changes.'),
4868
Option('force', help='Say yes to all questions.'),
4870
help="Only remove the commits from the local branch"
4871
" when in a checkout."
4874
takes_args = ['location?']
4876
encoding_type = 'replace'
4878
def run(self, location=None,
4879
dry_run=False, verbose=False,
4880
revision=None, force=False, local=False):
4881
if location is None:
4883
control, relpath = bzrdir.BzrDir.open_containing(location)
4885
tree = control.open_workingtree()
4887
except (errors.NoWorkingTree, errors.NotLocalUrl):
4889
b = control.open_branch()
4891
if tree is not None:
4892
self.add_cleanup(tree.lock_write().unlock)
4894
self.add_cleanup(b.lock_write().unlock)
4895
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4897
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4898
from bzrlib.log import log_formatter, show_log
4899
from bzrlib.uncommit import uncommit
4901
last_revno, last_rev_id = b.last_revision_info()
4904
if revision is None:
4906
rev_id = last_rev_id
4908
# 'bzr uncommit -r 10' actually means uncommit
4909
# so that the final tree is at revno 10.
4910
# but bzrlib.uncommit.uncommit() actually uncommits
4911
# the revisions that are supplied.
4912
# So we need to offset it by one
4913
revno = revision[0].in_history(b).revno + 1
4914
if revno <= last_revno:
4915
rev_id = b.get_rev_id(revno)
4917
if rev_id is None or _mod_revision.is_null(rev_id):
4918
self.outf.write('No revisions to uncommit.\n')
4921
lf = log_formatter('short',
4923
show_timezone='original')
4928
direction='forward',
4929
start_revision=revno,
4930
end_revision=last_revno)
4933
self.outf.write('Dry-run, pretending to remove'
4934
' the above revisions.\n')
4936
self.outf.write('The above revision(s) will be removed.\n')
4939
if not ui.ui_factory.confirm_action(
4940
'Uncommit these revisions',
4941
'bzrlib.builtins.uncommit',
4943
self.outf.write('Canceled\n')
4946
mutter('Uncommitting from {%s} to {%s}',
4947
last_rev_id, rev_id)
4948
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4949
revno=revno, local=local)
4950
self.outf.write('You can restore the old tip by running:\n'
4951
' bzr pull . -r revid:%s\n' % last_rev_id)
4954
class cmd_break_lock(Command):
4955
__doc__ = """Break a dead lock.
4957
This command breaks a lock on a repository, branch, working directory or
4960
CAUTION: Locks should only be broken when you are sure that the process
4961
holding the lock has been stopped.
4963
You can get information on what locks are open via the 'bzr info
4964
[location]' command.
4968
bzr break-lock bzr+ssh://example.com/bzr/foo
4969
bzr break-lock --conf ~/.bazaar
4972
takes_args = ['location?']
4975
help='LOCATION is the directory where the config lock is.'),
4977
help='Do not ask for confirmation before breaking the lock.'),
4980
def run(self, location=None, config=False, force=False):
4981
if location is None:
4984
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
4986
{'bzrlib.lockdir.break': True})
4988
conf = _mod_config.LockableConfig(file_name=location)
4991
control, relpath = bzrdir.BzrDir.open_containing(location)
4993
control.break_lock()
4994
except NotImplementedError:
4998
class cmd_wait_until_signalled(Command):
4999
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5001
This just prints a line to signal when it is ready, then blocks on stdin.
5007
sys.stdout.write("running\n")
5009
sys.stdin.readline()
5012
class cmd_serve(Command):
5013
__doc__ = """Run the bzr server."""
5015
aliases = ['server']
5019
help='Serve on stdin/out for use from inetd or sshd.'),
5020
RegistryOption('protocol',
5021
help="Protocol to serve.",
5022
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5023
value_switches=True),
5025
help='Listen for connections on nominated port of the form '
5026
'[hostname:]portnumber. Passing 0 as the port number will '
5027
'result in a dynamically allocated port. The default port '
5028
'depends on the protocol.',
5030
custom_help('directory',
5031
help='Serve contents of this directory.'),
5032
Option('allow-writes',
5033
help='By default the server is a readonly server. Supplying '
5034
'--allow-writes enables write access to the contents of '
5035
'the served directory and below. Note that ``bzr serve`` '
5036
'does not perform authentication, so unless some form of '
5037
'external authentication is arranged supplying this '
5038
'option leads to global uncontrolled write access to your '
5043
def get_host_and_port(self, port):
5044
"""Return the host and port to run the smart server on.
5046
If 'port' is None, None will be returned for the host and port.
5048
If 'port' has a colon in it, the string before the colon will be
5049
interpreted as the host.
5051
:param port: A string of the port to run the server on.
5052
:return: A tuple of (host, port), where 'host' is a host name or IP,
5053
and port is an integer TCP/IP port.
5056
if port is not None:
5058
host, port = port.split(':')
5062
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5064
from bzrlib import transport
5065
if directory is None:
5066
directory = os.getcwd()
5067
if protocol is None:
5068
protocol = transport.transport_server_registry.get()
5069
host, port = self.get_host_and_port(port)
5070
url = urlutils.local_path_to_url(directory)
5071
if not allow_writes:
5072
url = 'readonly+' + url
5073
t = transport.get_transport(url)
5074
protocol(t, host, port, inet)
5077
class cmd_join(Command):
5078
__doc__ = """Combine a tree into its containing tree.
5080
This command requires the target tree to be in a rich-root format.
5082
The TREE argument should be an independent tree, inside another tree, but
5083
not part of it. (Such trees can be produced by "bzr split", but also by
5084
running "bzr branch" with the target inside a tree.)
5086
The result is a combined tree, with the subtree no longer an independent
5087
part. This is marked as a merge of the subtree into the containing tree,
5088
and all history is preserved.
5091
_see_also = ['split']
5092
takes_args = ['tree']
5094
Option('reference', help='Join by reference.', hidden=True),
5097
def run(self, tree, reference=False):
5098
sub_tree = WorkingTree.open(tree)
5099
parent_dir = osutils.dirname(sub_tree.basedir)
5100
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5101
repo = containing_tree.branch.repository
5102
if not repo.supports_rich_root():
5103
raise errors.BzrCommandError(
5104
"Can't join trees because %s doesn't support rich root data.\n"
5105
"You can use bzr upgrade on the repository."
5109
containing_tree.add_reference(sub_tree)
5110
except errors.BadReferenceTarget, e:
5111
# XXX: Would be better to just raise a nicely printable
5112
# exception from the real origin. Also below. mbp 20070306
5113
raise errors.BzrCommandError("Cannot join %s. %s" %
5117
containing_tree.subsume(sub_tree)
5118
except errors.BadSubsumeSource, e:
5119
raise errors.BzrCommandError("Cannot join %s. %s" %
5123
class cmd_split(Command):
5124
__doc__ = """Split a subdirectory of a tree into a separate tree.
5126
This command will produce a target tree in a format that supports
5127
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5128
converted into earlier formats like 'dirstate-tags'.
5130
The TREE argument should be a subdirectory of a working tree. That
5131
subdirectory will be converted into an independent tree, with its own
5132
branch. Commits in the top-level tree will not apply to the new subtree.
5135
_see_also = ['join']
5136
takes_args = ['tree']
5138
def run(self, tree):
5139
containing_tree, subdir = WorkingTree.open_containing(tree)
5140
sub_id = containing_tree.path2id(subdir)
5142
raise errors.NotVersionedError(subdir)
5144
containing_tree.extract(sub_id)
5145
except errors.RootNotRich:
5146
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5149
class cmd_merge_directive(Command):
5150
__doc__ = """Generate a merge directive for auto-merge tools.
5152
A directive requests a merge to be performed, and also provides all the
5153
information necessary to do so. This means it must either include a
5154
revision bundle, or the location of a branch containing the desired
5157
A submit branch (the location to merge into) must be supplied the first
5158
time the command is issued. After it has been supplied once, it will
5159
be remembered as the default.
5161
A public branch is optional if a revision bundle is supplied, but required
5162
if --diff or --plain is specified. It will be remembered as the default
5163
after the first use.
5166
takes_args = ['submit_branch?', 'public_branch?']
5170
_see_also = ['send']
5174
RegistryOption.from_kwargs('patch-type',
5175
'The type of patch to include in the directive.',
5177
value_switches=True,
5179
bundle='Bazaar revision bundle (default).',
5180
diff='Normal unified diff.',
5181
plain='No patch, just directive.'),
5182
Option('sign', help='GPG-sign the directive.'), 'revision',
5183
Option('mail-to', type=str,
5184
help='Instead of printing the directive, email to this address.'),
5185
Option('message', type=str, short_name='m',
5186
help='Message to use when committing this merge.')
5189
encoding_type = 'exact'
5191
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5192
sign=False, revision=None, mail_to=None, message=None,
5194
from bzrlib.revision import ensure_null, NULL_REVISION
5195
include_patch, include_bundle = {
5196
'plain': (False, False),
5197
'diff': (True, False),
5198
'bundle': (True, True),
5200
branch = Branch.open(directory)
5201
stored_submit_branch = branch.get_submit_branch()
5202
if submit_branch is None:
5203
submit_branch = stored_submit_branch
5205
if stored_submit_branch is None:
5206
branch.set_submit_branch(submit_branch)
5207
if submit_branch is None:
5208
submit_branch = branch.get_parent()
5209
if submit_branch is None:
5210
raise errors.BzrCommandError('No submit branch specified or known')
5212
stored_public_branch = branch.get_public_branch()
5213
if public_branch is None:
5214
public_branch = stored_public_branch
5215
elif stored_public_branch is None:
5216
branch.set_public_branch(public_branch)
5217
if not include_bundle and public_branch is None:
5218
raise errors.BzrCommandError('No public branch specified or'
5220
base_revision_id = None
5221
if revision is not None:
5222
if len(revision) > 2:
5223
raise errors.BzrCommandError('bzr merge-directive takes '
5224
'at most two one revision identifiers')
5225
revision_id = revision[-1].as_revision_id(branch)
5226
if len(revision) == 2:
5227
base_revision_id = revision[0].as_revision_id(branch)
5229
revision_id = branch.last_revision()
5230
revision_id = ensure_null(revision_id)
5231
if revision_id == NULL_REVISION:
5232
raise errors.BzrCommandError('No revisions to bundle.')
5233
directive = merge_directive.MergeDirective2.from_objects(
5234
branch.repository, revision_id, time.time(),
5235
osutils.local_time_offset(), submit_branch,
5236
public_branch=public_branch, include_patch=include_patch,
5237
include_bundle=include_bundle, message=message,
5238
base_revision_id=base_revision_id)
5241
self.outf.write(directive.to_signed(branch))
5243
self.outf.writelines(directive.to_lines())
5245
message = directive.to_email(mail_to, branch, sign)
5246
s = SMTPConnection(branch.get_config())
5247
s.send_email(message)
5250
class cmd_send(Command):
5251
__doc__ = """Mail or create a merge-directive for submitting changes.
5253
A merge directive provides many things needed for requesting merges:
5255
* A machine-readable description of the merge to perform
5257
* An optional patch that is a preview of the changes requested
5259
* An optional bundle of revision data, so that the changes can be applied
5260
directly from the merge directive, without retrieving data from a
5263
`bzr send` creates a compact data set that, when applied using bzr
5264
merge, has the same effect as merging from the source branch.
5266
By default the merge directive is self-contained and can be applied to any
5267
branch containing submit_branch in its ancestory without needing access to
5270
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5271
revisions, but only a structured request to merge from the
5272
public_location. In that case the public_branch is needed and it must be
5273
up-to-date and accessible to the recipient. The public_branch is always
5274
included if known, so that people can check it later.
5276
The submit branch defaults to the parent of the source branch, but can be
5277
overridden. Both submit branch and public branch will be remembered in
5278
branch.conf the first time they are used for a particular branch. The
5279
source branch defaults to that containing the working directory, but can
5280
be changed using --from.
5282
In order to calculate those changes, bzr must analyse the submit branch.
5283
Therefore it is most efficient for the submit branch to be a local mirror.
5284
If a public location is known for the submit_branch, that location is used
5285
in the merge directive.
5287
The default behaviour is to send the merge directive by mail, unless -o is
5288
given, in which case it is sent to a file.
5290
Mail is sent using your preferred mail program. This should be transparent
5291
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5292
If the preferred client can't be found (or used), your editor will be used.
5294
To use a specific mail program, set the mail_client configuration option.
5295
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5296
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5297
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5298
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5301
If mail is being sent, a to address is required. This can be supplied
5302
either on the commandline, by setting the submit_to configuration
5303
option in the branch itself or the child_submit_to configuration option
5304
in the submit branch.
5306
Two formats are currently supported: "4" uses revision bundle format 4 and
5307
merge directive format 2. It is significantly faster and smaller than
5308
older formats. It is compatible with Bazaar 0.19 and later. It is the
5309
default. "0.9" uses revision bundle format 0.9 and merge directive
5310
format 1. It is compatible with Bazaar 0.12 - 0.18.
5312
The merge directives created by bzr send may be applied using bzr merge or
5313
bzr pull by specifying a file containing a merge directive as the location.
5315
bzr send makes extensive use of public locations to map local locations into
5316
URLs that can be used by other people. See `bzr help configuration` to
5317
set them, and use `bzr info` to display them.
5320
encoding_type = 'exact'
5322
_see_also = ['merge', 'pull']
5324
takes_args = ['submit_branch?', 'public_branch?']
5328
help='Do not include a bundle in the merge directive.'),
5329
Option('no-patch', help='Do not include a preview patch in the merge'
5332
help='Remember submit and public branch.'),
5334
help='Branch to generate the submission from, '
5335
'rather than the one containing the working directory.',
5338
Option('output', short_name='o',
5339
help='Write merge directive to this file or directory; '
5340
'use - for stdout.',
5343
help='Refuse to send if there are uncommitted changes in'
5344
' the working tree, --no-strict disables the check.'),
5345
Option('mail-to', help='Mail the request to this address.',
5349
Option('body', help='Body for the email.', type=unicode),
5350
RegistryOption('format',
5351
help='Use the specified output format.',
5352
lazy_registry=('bzrlib.send', 'format_registry')),
5355
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5356
no_patch=False, revision=None, remember=False, output=None,
5357
format=None, mail_to=None, message=None, body=None,
5358
strict=None, **kwargs):
5359
from bzrlib.send import send
5360
return send(submit_branch, revision, public_branch, remember,
5361
format, no_bundle, no_patch, output,
5362
kwargs.get('from', '.'), mail_to, message, body,
5367
class cmd_bundle_revisions(cmd_send):
5368
__doc__ = """Create a merge-directive for submitting changes.
5370
A merge directive provides many things needed for requesting merges:
5372
* A machine-readable description of the merge to perform
5374
* An optional patch that is a preview of the changes requested
5376
* An optional bundle of revision data, so that the changes can be applied
5377
directly from the merge directive, without retrieving data from a
5380
If --no-bundle is specified, then public_branch is needed (and must be
5381
up-to-date), so that the receiver can perform the merge using the
5382
public_branch. The public_branch is always included if known, so that
5383
people can check it later.
5385
The submit branch defaults to the parent, but can be overridden. Both
5386
submit branch and public branch will be remembered if supplied.
5388
If a public_branch is known for the submit_branch, that public submit
5389
branch is used in the merge instructions. This means that a local mirror
5390
can be used as your actual submit branch, once you have set public_branch
5393
Two formats are currently supported: "4" uses revision bundle format 4 and
5394
merge directive format 2. It is significantly faster and smaller than
5395
older formats. It is compatible with Bazaar 0.19 and later. It is the
5396
default. "0.9" uses revision bundle format 0.9 and merge directive
5397
format 1. It is compatible with Bazaar 0.12 - 0.18.
5402
help='Do not include a bundle in the merge directive.'),
5403
Option('no-patch', help='Do not include a preview patch in the merge'
5406
help='Remember submit and public branch.'),
5408
help='Branch to generate the submission from, '
5409
'rather than the one containing the working directory.',
5412
Option('output', short_name='o', help='Write directive to this file.',
5415
help='Refuse to bundle revisions if there are uncommitted'
5416
' changes in the working tree, --no-strict disables the check.'),
5418
RegistryOption('format',
5419
help='Use the specified output format.',
5420
lazy_registry=('bzrlib.send', 'format_registry')),
5422
aliases = ['bundle']
5424
_see_also = ['send', 'merge']
5428
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5429
no_patch=False, revision=None, remember=False, output=None,
5430
format=None, strict=None, **kwargs):
5433
from bzrlib.send import send
5434
return send(submit_branch, revision, public_branch, remember,
5435
format, no_bundle, no_patch, output,
5436
kwargs.get('from', '.'), None, None, None,
5437
self.outf, strict=strict)
5440
class cmd_tag(Command):
5441
__doc__ = """Create, remove or modify a tag naming a revision.
5443
Tags give human-meaningful names to revisions. Commands that take a -r
5444
(--revision) option can be given -rtag:X, where X is any previously
5447
Tags are stored in the branch. Tags are copied from one branch to another
5448
along when you branch, push, pull or merge.
5450
It is an error to give a tag name that already exists unless you pass
5451
--force, in which case the tag is moved to point to the new revision.
5453
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5454
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5456
If no tag name is specified it will be determined through the
5457
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5458
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5462
_see_also = ['commit', 'tags']
5463
takes_args = ['tag_name?']
5466
help='Delete this tag rather than placing it.',
5468
custom_help('directory',
5469
help='Branch in which to place the tag.'),
5471
help='Replace existing tags.',
5476
def run(self, tag_name=None,
5482
branch, relpath = Branch.open_containing(directory)
5483
self.add_cleanup(branch.lock_write().unlock)
5485
if tag_name is None:
5486
raise errors.BzrCommandError("No tag specified to delete.")
5487
branch.tags.delete_tag(tag_name)
5488
note('Deleted tag %s.' % tag_name)
5491
if len(revision) != 1:
5492
raise errors.BzrCommandError(
5493
"Tags can only be placed on a single revision, "
5495
revision_id = revision[0].as_revision_id(branch)
5497
revision_id = branch.last_revision()
5498
if tag_name is None:
5499
tag_name = branch.automatic_tag_name(revision_id)
5500
if tag_name is None:
5501
raise errors.BzrCommandError(
5502
"Please specify a tag name.")
5503
if (not force) and branch.tags.has_tag(tag_name):
5504
raise errors.TagAlreadyExists(tag_name)
5505
branch.tags.set_tag(tag_name, revision_id)
5506
note('Created tag %s.' % tag_name)
5509
class cmd_tags(Command):
5510
__doc__ = """List tags.
5512
This command shows a table of tag names and the revisions they reference.
5517
custom_help('directory',
5518
help='Branch whose tags should be displayed.'),
5519
RegistryOption('sort',
5520
'Sort tags by different criteria.', title='Sorting',
5521
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5528
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5529
from bzrlib.tag import tag_sort_methods
5530
branch, relpath = Branch.open_containing(directory)
5532
tags = branch.tags.get_tag_dict().items()
5536
self.add_cleanup(branch.lock_read().unlock)
5538
graph = branch.repository.get_graph()
5539
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5540
revid1, revid2 = rev1.rev_id, rev2.rev_id
5541
# only show revisions between revid1 and revid2 (inclusive)
5542
tags = [(tag, revid) for tag, revid in tags if
5543
graph.is_between(revid, revid1, revid2)]
5545
sort = tag_sort_methods.get()
5548
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5549
for index, (tag, revid) in enumerate(tags):
5551
revno = branch.revision_id_to_dotted_revno(revid)
5552
if isinstance(revno, tuple):
5553
revno = '.'.join(map(str, revno))
5554
except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
5555
# Bad tag data/merges can lead to tagged revisions
5556
# which are not in this branch. Fail gracefully ...
5558
tags[index] = (tag, revno)
5560
for tag, revspec in tags:
5561
self.outf.write('%-20s %s\n' % (tag, revspec))
5564
class cmd_reconfigure(Command):
5565
__doc__ = """Reconfigure the type of a bzr directory.
5567
A target configuration must be specified.
5569
For checkouts, the bind-to location will be auto-detected if not specified.
5570
The order of preference is
5571
1. For a lightweight checkout, the current bound location.
5572
2. For branches that used to be checkouts, the previously-bound location.
5573
3. The push location.
5574
4. The parent location.
5575
If none of these is available, --bind-to must be specified.
5578
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5579
takes_args = ['location?']
5581
RegistryOption.from_kwargs(
5583
title='Target type',
5584
help='The type to reconfigure the directory to.',
5585
value_switches=True, enum_switch=False,
5586
branch='Reconfigure to be an unbound branch with no working tree.',
5587
tree='Reconfigure to be an unbound branch with a working tree.',
5588
checkout='Reconfigure to be a bound branch with a working tree.',
5589
lightweight_checkout='Reconfigure to be a lightweight'
5590
' checkout (with no local history).',
5591
standalone='Reconfigure to be a standalone branch '
5592
'(i.e. stop using shared repository).',
5593
use_shared='Reconfigure to use a shared repository.',
5594
with_trees='Reconfigure repository to create '
5595
'working trees on branches by default.',
5596
with_no_trees='Reconfigure repository to not create '
5597
'working trees on branches by default.'
5599
Option('bind-to', help='Branch to bind checkout to.', type=str),
5601
help='Perform reconfiguration even if local changes'
5603
Option('stacked-on',
5604
help='Reconfigure a branch to be stacked on another branch.',
5608
help='Reconfigure a branch to be unstacked. This '
5609
'may require copying substantial data into it.',
5613
def run(self, location=None, target_type=None, bind_to=None, force=False,
5616
directory = bzrdir.BzrDir.open(location)
5617
if stacked_on and unstacked:
5618
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5619
elif stacked_on is not None:
5620
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5622
reconfigure.ReconfigureUnstacked().apply(directory)
5623
# At the moment you can use --stacked-on and a different
5624
# reconfiguration shape at the same time; there seems no good reason
5626
if target_type is None:
5627
if stacked_on or unstacked:
5630
raise errors.BzrCommandError('No target configuration '
5632
elif target_type == 'branch':
5633
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5634
elif target_type == 'tree':
5635
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5636
elif target_type == 'checkout':
5637
reconfiguration = reconfigure.Reconfigure.to_checkout(
5639
elif target_type == 'lightweight-checkout':
5640
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5642
elif target_type == 'use-shared':
5643
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5644
elif target_type == 'standalone':
5645
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5646
elif target_type == 'with-trees':
5647
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5649
elif target_type == 'with-no-trees':
5650
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5652
reconfiguration.apply(force)
5655
class cmd_switch(Command):
5656
__doc__ = """Set the branch of a checkout and update.
5658
For lightweight checkouts, this changes the branch being referenced.
5659
For heavyweight checkouts, this checks that there are no local commits
5660
versus the current bound branch, then it makes the local branch a mirror
5661
of the new location and binds to it.
5663
In both cases, the working tree is updated and uncommitted changes
5664
are merged. The user can commit or revert these as they desire.
5666
Pending merges need to be committed or reverted before using switch.
5668
The path to the branch to switch to can be specified relative to the parent
5669
directory of the current branch. For example, if you are currently in a
5670
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5673
Bound branches use the nickname of its master branch unless it is set
5674
locally, in which case switching will update the local nickname to be
5678
takes_args = ['to_location?']
5679
takes_options = ['directory',
5681
help='Switch even if local commits will be lost.'),
5683
Option('create-branch', short_name='b',
5684
help='Create the target branch from this one before'
5685
' switching to it.'),
5688
def run(self, to_location=None, force=False, create_branch=False,
5689
revision=None, directory=u'.'):
5690
from bzrlib import switch
5691
tree_location = directory
5692
revision = _get_one_revision('switch', revision)
5693
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5694
if to_location is None:
5695
if revision is None:
5696
raise errors.BzrCommandError('You must supply either a'
5697
' revision or a location')
5698
to_location = tree_location
5700
branch = control_dir.open_branch()
5701
had_explicit_nick = branch.get_config().has_explicit_nickname()
5702
except errors.NotBranchError:
5704
had_explicit_nick = False
5707
raise errors.BzrCommandError('cannot create branch without'
5709
to_location = directory_service.directories.dereference(
5711
if '/' not in to_location and '\\' not in to_location:
5712
# This path is meant to be relative to the existing branch
5713
this_url = self._get_branch_location(control_dir)
5714
to_location = urlutils.join(this_url, '..', to_location)
5715
to_branch = branch.bzrdir.sprout(to_location,
5716
possible_transports=[branch.bzrdir.root_transport],
5717
source_branch=branch).open_branch()
5720
to_branch = Branch.open(to_location)
5721
except errors.NotBranchError:
5722
this_url = self._get_branch_location(control_dir)
5723
to_branch = Branch.open(
5724
urlutils.join(this_url, '..', to_location))
5725
if revision is not None:
5726
revision = revision.as_revision_id(to_branch)
5727
switch.switch(control_dir, to_branch, force, revision_id=revision)
5728
if had_explicit_nick:
5729
branch = control_dir.open_branch() #get the new branch!
5730
branch.nick = to_branch.nick
5731
note('Switched to branch: %s',
5732
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5734
def _get_branch_location(self, control_dir):
5735
"""Return location of branch for this control dir."""
5737
this_branch = control_dir.open_branch()
5738
# This may be a heavy checkout, where we want the master branch
5739
master_location = this_branch.get_bound_location()
5740
if master_location is not None:
5741
return master_location
5742
# If not, use a local sibling
5743
return this_branch.base
5744
except errors.NotBranchError:
5745
format = control_dir.find_branch_format()
5746
if getattr(format, 'get_reference', None) is not None:
5747
return format.get_reference(control_dir)
5749
return control_dir.root_transport.base
5752
class cmd_view(Command):
5753
__doc__ = """Manage filtered views.
5755
Views provide a mask over the tree so that users can focus on
5756
a subset of a tree when doing their work. After creating a view,
5757
commands that support a list of files - status, diff, commit, etc -
5758
effectively have that list of files implicitly given each time.
5759
An explicit list of files can still be given but those files
5760
must be within the current view.
5762
In most cases, a view has a short life-span: it is created to make
5763
a selected change and is deleted once that change is committed.
5764
At other times, you may wish to create one or more named views
5765
and switch between them.
5767
To disable the current view without deleting it, you can switch to
5768
the pseudo view called ``off``. This can be useful when you need
5769
to see the whole tree for an operation or two (e.g. merge) but
5770
want to switch back to your view after that.
5773
To define the current view::
5775
bzr view file1 dir1 ...
5777
To list the current view::
5781
To delete the current view::
5785
To disable the current view without deleting it::
5787
bzr view --switch off
5789
To define a named view and switch to it::
5791
bzr view --name view-name file1 dir1 ...
5793
To list a named view::
5795
bzr view --name view-name
5797
To delete a named view::
5799
bzr view --name view-name --delete
5801
To switch to a named view::
5803
bzr view --switch view-name
5805
To list all views defined::
5809
To delete all views::
5811
bzr view --delete --all
5815
takes_args = ['file*']
5818
help='Apply list or delete action to all views.',
5821
help='Delete the view.',
5824
help='Name of the view to define, list or delete.',
5828
help='Name of the view to switch to.',
5833
def run(self, file_list,
5839
tree, file_list = WorkingTree.open_containing_paths(file_list,
5841
current_view, view_dict = tree.views.get_view_info()
5846
raise errors.BzrCommandError(
5847
"Both --delete and a file list specified")
5849
raise errors.BzrCommandError(
5850
"Both --delete and --switch specified")
5852
tree.views.set_view_info(None, {})
5853
self.outf.write("Deleted all views.\n")
5855
raise errors.BzrCommandError("No current view to delete")
5857
tree.views.delete_view(name)
5858
self.outf.write("Deleted '%s' view.\n" % name)
5861
raise errors.BzrCommandError(
5862
"Both --switch and a file list specified")
5864
raise errors.BzrCommandError(
5865
"Both --switch and --all specified")
5866
elif switch == 'off':
5867
if current_view is None:
5868
raise errors.BzrCommandError("No current view to disable")
5869
tree.views.set_view_info(None, view_dict)
5870
self.outf.write("Disabled '%s' view.\n" % (current_view))
5872
tree.views.set_view_info(switch, view_dict)
5873
view_str = views.view_display_str(tree.views.lookup_view())
5874
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5877
self.outf.write('Views defined:\n')
5878
for view in sorted(view_dict):
5879
if view == current_view:
5883
view_str = views.view_display_str(view_dict[view])
5884
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5886
self.outf.write('No views defined.\n')
5889
# No name given and no current view set
5892
raise errors.BzrCommandError(
5893
"Cannot change the 'off' pseudo view")
5894
tree.views.set_view(name, sorted(file_list))
5895
view_str = views.view_display_str(tree.views.lookup_view())
5896
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5900
# No name given and no current view set
5901
self.outf.write('No current view.\n')
5903
view_str = views.view_display_str(tree.views.lookup_view(name))
5904
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5907
class cmd_hooks(Command):
5908
__doc__ = """Show hooks."""
5913
for hook_key in sorted(hooks.known_hooks.keys()):
5914
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5915
self.outf.write("%s:\n" % type(some_hooks).__name__)
5916
for hook_name, hook_point in sorted(some_hooks.items()):
5917
self.outf.write(" %s:\n" % (hook_name,))
5918
found_hooks = list(hook_point)
5920
for hook in found_hooks:
5921
self.outf.write(" %s\n" %
5922
(some_hooks.get_hook_name(hook),))
5924
self.outf.write(" <no hooks installed>\n")
5927
class cmd_remove_branch(Command):
5928
__doc__ = """Remove a branch.
5930
This will remove the branch from the specified location but
5931
will keep any working tree or repository in place.
5935
Remove the branch at repo/trunk::
5937
bzr remove-branch repo/trunk
5941
takes_args = ["location?"]
5943
aliases = ["rmbranch"]
5945
def run(self, location=None):
5946
if location is None:
5948
branch = Branch.open_containing(location)[0]
5949
branch.bzrdir.destroy_branch()
5952
class cmd_shelve(Command):
5953
__doc__ = """Temporarily set aside some changes from the current tree.
5955
Shelve allows you to temporarily put changes you've made "on the shelf",
5956
ie. out of the way, until a later time when you can bring them back from
5957
the shelf with the 'unshelve' command. The changes are stored alongside
5958
your working tree, and so they aren't propagated along with your branch nor
5959
will they survive its deletion.
5961
If shelve --list is specified, previously-shelved changes are listed.
5963
Shelve is intended to help separate several sets of changes that have
5964
been inappropriately mingled. If you just want to get rid of all changes
5965
and you don't need to restore them later, use revert. If you want to
5966
shelve all text changes at once, use shelve --all.
5968
If filenames are specified, only the changes to those files will be
5969
shelved. Other files will be left untouched.
5971
If a revision is specified, changes since that revision will be shelved.
5973
You can put multiple items on the shelf, and by default, 'unshelve' will
5974
restore the most recently shelved changes.
5976
For complicated changes, it is possible to edit the changes in a separate
5977
editor program to decide what the file remaining in the working copy
5978
should look like. To do this, add the configuration option
5980
change_editor = PROGRAM @new_path @old_path
5982
where @new_path is replaced with the path of the new version of the
5983
file and @old_path is replaced with the path of the old version of
5984
the file. The PROGRAM should save the new file with the desired
5985
contents of the file in the working tree.
5989
takes_args = ['file*']
5994
Option('all', help='Shelve all changes.'),
5996
RegistryOption('writer', 'Method to use for writing diffs.',
5997
bzrlib.option.diff_writer_registry,
5998
value_switches=True, enum_switch=False),
6000
Option('list', help='List shelved changes.'),
6002
help='Destroy removed changes instead of shelving them.'),
6004
_see_also = ['unshelve', 'configuration']
6006
def run(self, revision=None, all=False, file_list=None, message=None,
6007
writer=None, list=False, destroy=False, directory=None):
6009
return self.run_for_list(directory=directory)
6010
from bzrlib.shelf_ui import Shelver
6012
writer = bzrlib.option.diff_writer_registry.get()
6014
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6015
file_list, message, destroy=destroy, directory=directory)
6020
except errors.UserAbort:
6023
def run_for_list(self, directory=None):
6024
if directory is None:
6026
tree = WorkingTree.open_containing(directory)[0]
6027
self.add_cleanup(tree.lock_read().unlock)
6028
manager = tree.get_shelf_manager()
6029
shelves = manager.active_shelves()
6030
if len(shelves) == 0:
6031
note('No shelved changes.')
6033
for shelf_id in reversed(shelves):
6034
message = manager.get_metadata(shelf_id).get('message')
6036
message = '<no message>'
6037
self.outf.write('%3d: %s\n' % (shelf_id, message))
6041
class cmd_unshelve(Command):
6042
__doc__ = """Restore shelved changes.
6044
By default, the most recently shelved changes are restored. However if you
6045
specify a shelf by id those changes will be restored instead. This works
6046
best when the changes don't depend on each other.
6049
takes_args = ['shelf_id?']
6052
RegistryOption.from_kwargs(
6053
'action', help="The action to perform.",
6054
enum_switch=False, value_switches=True,
6055
apply="Apply changes and remove from the shelf.",
6056
dry_run="Show changes, but do not apply or remove them.",
6057
preview="Instead of unshelving the changes, show the diff that "
6058
"would result from unshelving.",
6059
delete_only="Delete changes without applying them.",
6060
keep="Apply changes but don't delete them.",
6063
_see_also = ['shelve']
6065
def run(self, shelf_id=None, action='apply', directory=u'.'):
6066
from bzrlib.shelf_ui import Unshelver
6067
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6071
unshelver.tree.unlock()
6074
class cmd_clean_tree(Command):
6075
__doc__ = """Remove unwanted files from working tree.
6077
By default, only unknown files, not ignored files, are deleted. Versioned
6078
files are never deleted.
6080
Another class is 'detritus', which includes files emitted by bzr during
6081
normal operations and selftests. (The value of these files decreases with
6084
If no options are specified, unknown files are deleted. Otherwise, option
6085
flags are respected, and may be combined.
6087
To check what clean-tree will do, use --dry-run.
6089
takes_options = ['directory',
6090
Option('ignored', help='Delete all ignored files.'),
6091
Option('detritus', help='Delete conflict files, merge and revert'
6092
' backups, and failed selftest dirs.'),
6094
help='Delete files unknown to bzr (default).'),
6095
Option('dry-run', help='Show files to delete instead of'
6097
Option('force', help='Do not prompt before deleting.')]
6098
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6099
force=False, directory=u'.'):
6100
from bzrlib.clean_tree import clean_tree
6101
if not (unknown or ignored or detritus):
6105
clean_tree(directory, unknown=unknown, ignored=ignored,
6106
detritus=detritus, dry_run=dry_run, no_prompt=force)
6109
class cmd_reference(Command):
6110
__doc__ = """list, view and set branch locations for nested trees.
6112
If no arguments are provided, lists the branch locations for nested trees.
6113
If one argument is provided, display the branch location for that tree.
6114
If two arguments are provided, set the branch location for that tree.
6119
takes_args = ['path?', 'location?']
6121
def run(self, path=None, location=None):
6123
if path is not None:
6125
tree, branch, relpath =(
6126
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
6127
if path is not None:
6130
tree = branch.basis_tree()
6132
info = branch._get_all_reference_info().iteritems()
6133
self._display_reference_info(tree, branch, info)
6135
file_id = tree.path2id(path)
6137
raise errors.NotVersionedError(path)
6138
if location is None:
6139
info = [(file_id, branch.get_reference_info(file_id))]
6140
self._display_reference_info(tree, branch, info)
6142
branch.set_reference_info(file_id, path, location)
6144
def _display_reference_info(self, tree, branch, info):
6146
for file_id, (path, location) in info:
6148
path = tree.id2path(file_id)
6149
except errors.NoSuchId:
6151
ref_list.append((path, location))
6152
for path, location in sorted(ref_list):
6153
self.outf.write('%s %s\n' % (path, location))
6156
def _register_lazy_builtins():
6157
# register lazy builtins from other modules; called at startup and should
6158
# be only called once.
6159
for (name, aliases, module_name) in [
6160
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6161
('cmd_config', [], 'bzrlib.config'),
6162
('cmd_dpush', [], 'bzrlib.foreign'),
6163
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6164
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6165
('cmd_conflicts', [], 'bzrlib.conflicts'),
6166
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6167
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6169
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
