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".
1210
_see_also = ['checkout']
1211
takes_args = ['from_location', 'to_location?']
1212
takes_options = ['revision',
1213
Option('hardlink', help='Hard-link working tree files where possible.'),
1214
Option('files-from', type=str,
1215
help="Get file contents from this tree."),
1217
help="Create a branch without a working-tree."),
1219
help="Switch the checkout in the current directory "
1220
"to the new branch."),
1222
help='Create a stacked branch referring to the source branch. '
1223
'The new branch will depend on the availability of the source '
1224
'branch for all operations.'),
1225
Option('standalone',
1226
help='Do not use a shared repository, even if available.'),
1227
Option('use-existing-dir',
1228
help='By default branch will fail if the target'
1229
' directory exists, but does not already'
1230
' have a control directory. This flag will'
1231
' allow branch to proceed.'),
1233
help="Bind new branch to from location."),
1235
aliases = ['get', 'clone']
1237
def run(self, from_location, to_location=None, revision=None,
1238
hardlink=False, stacked=False, standalone=False, no_tree=False,
1239
use_existing_dir=False, switch=False, bind=False,
1241
from bzrlib import switch as _mod_switch
1242
from bzrlib.tag import _merge_tags_if_possible
1243
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1245
if not (hardlink or files_from):
1246
# accelerator_tree is usually slower because you have to read N
1247
# files (no readahead, lots of seeks, etc), but allow the user to
1248
# explicitly request it
1249
accelerator_tree = None
1250
if files_from is not None and files_from != from_location:
1251
accelerator_tree = WorkingTree.open(files_from)
1252
revision = _get_one_revision('branch', revision)
1253
self.add_cleanup(br_from.lock_read().unlock)
1254
if revision is not None:
1255
revision_id = revision.as_revision_id(br_from)
1257
# FIXME - wt.last_revision, fallback to branch, fall back to
1258
# None or perhaps NULL_REVISION to mean copy nothing
1260
revision_id = br_from.last_revision()
1261
if to_location is None:
1262
to_location = urlutils.derive_to_location(from_location)
1263
to_transport = transport.get_transport(to_location)
1265
to_transport.mkdir('.')
1266
except errors.FileExists:
1267
if not use_existing_dir:
1268
raise errors.BzrCommandError('Target directory "%s" '
1269
'already exists.' % to_location)
1272
bzrdir.BzrDir.open_from_transport(to_transport)
1273
except errors.NotBranchError:
1276
raise errors.AlreadyBranchError(to_location)
1277
except errors.NoSuchFile:
1278
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1281
# preserve whatever source format we have.
1282
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1283
possible_transports=[to_transport],
1284
accelerator_tree=accelerator_tree,
1285
hardlink=hardlink, stacked=stacked,
1286
force_new_repo=standalone,
1287
create_tree_if_local=not no_tree,
1288
source_branch=br_from)
1289
branch = dir.open_branch()
1290
except errors.NoSuchRevision:
1291
to_transport.delete_tree('.')
1292
msg = "The branch %s has no revision %s." % (from_location,
1294
raise errors.BzrCommandError(msg)
1295
_merge_tags_if_possible(br_from, branch)
1296
# If the source branch is stacked, the new branch may
1297
# be stacked whether we asked for that explicitly or not.
1298
# We therefore need a try/except here and not just 'if stacked:'
1300
note('Created new stacked branch referring to %s.' %
1301
branch.get_stacked_on_url())
1302
except (errors.NotStacked, errors.UnstackableBranchFormat,
1303
errors.UnstackableRepositoryFormat), e:
1304
note('Branched %d revision(s).' % branch.revno())
1306
# Bind to the parent
1307
parent_branch = Branch.open(from_location)
1308
branch.bind(parent_branch)
1309
note('New branch bound to %s' % from_location)
1311
# Switch to the new branch
1312
wt, _ = WorkingTree.open_containing('.')
1313
_mod_switch.switch(wt.bzrdir, branch)
1314
note('Switched to branch: %s',
1315
urlutils.unescape_for_display(branch.base, 'utf-8'))
1318
class cmd_checkout(Command):
1319
__doc__ = """Create a new checkout of an existing branch.
1321
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1322
the branch found in '.'. This is useful if you have removed the working tree
1323
or if it was never created - i.e. if you pushed the branch to its current
1324
location using SFTP.
1326
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1327
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1328
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1329
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1330
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1333
To retrieve the branch as of a particular revision, supply the --revision
1334
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1335
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1339
_see_also = ['checkouts', 'branch']
1340
takes_args = ['branch_location?', 'to_location?']
1341
takes_options = ['revision',
1342
Option('lightweight',
1343
help="Perform a lightweight checkout. Lightweight "
1344
"checkouts depend on access to the branch for "
1345
"every operation. Normal checkouts can perform "
1346
"common operations like diff and status without "
1347
"such access, and also support local commits."
1349
Option('files-from', type=str,
1350
help="Get file contents from this tree."),
1352
help='Hard-link working tree files where possible.'
1357
def run(self, branch_location=None, to_location=None, revision=None,
1358
lightweight=False, files_from=None, hardlink=False):
1359
if branch_location is None:
1360
branch_location = osutils.getcwd()
1361
to_location = branch_location
1362
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1364
if not (hardlink or files_from):
1365
# accelerator_tree is usually slower because you have to read N
1366
# files (no readahead, lots of seeks, etc), but allow the user to
1367
# explicitly request it
1368
accelerator_tree = None
1369
revision = _get_one_revision('checkout', revision)
1370
if files_from is not None and files_from != branch_location:
1371
accelerator_tree = WorkingTree.open(files_from)
1372
if revision is not None:
1373
revision_id = revision.as_revision_id(source)
1376
if to_location is None:
1377
to_location = urlutils.derive_to_location(branch_location)
1378
# if the source and to_location are the same,
1379
# and there is no working tree,
1380
# then reconstitute a branch
1381
if (osutils.abspath(to_location) ==
1382
osutils.abspath(branch_location)):
1384
source.bzrdir.open_workingtree()
1385
except errors.NoWorkingTree:
1386
source.bzrdir.create_workingtree(revision_id)
1388
source.create_checkout(to_location, revision_id, lightweight,
1389
accelerator_tree, hardlink)
1392
class cmd_renames(Command):
1393
__doc__ = """Show list of renamed files.
1395
# TODO: Option to show renames between two historical versions.
1397
# TODO: Only show renames under dir, rather than in the whole branch.
1398
_see_also = ['status']
1399
takes_args = ['dir?']
1402
def run(self, dir=u'.'):
1403
tree = WorkingTree.open_containing(dir)[0]
1404
self.add_cleanup(tree.lock_read().unlock)
1405
new_inv = tree.inventory
1406
old_tree = tree.basis_tree()
1407
self.add_cleanup(old_tree.lock_read().unlock)
1408
old_inv = old_tree.inventory
1410
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1411
for f, paths, c, v, p, n, k, e in iterator:
1412
if paths[0] == paths[1]:
1416
renames.append(paths)
1418
for old_name, new_name in renames:
1419
self.outf.write("%s => %s\n" % (old_name, new_name))
1422
class cmd_update(Command):
1423
__doc__ = """Update a tree to have the latest code committed to its branch.
1425
This will perform a merge into the working tree, and may generate
1426
conflicts. If you have any local changes, you will still
1427
need to commit them after the update for the update to be complete.
1429
If you want to discard your local changes, you can just do a
1430
'bzr revert' instead of 'bzr commit' after the update.
1432
If you want to restore a file that has been removed locally, use
1433
'bzr revert' instead of 'bzr update'.
1435
If the tree's branch is bound to a master branch, it will also update
1436
the branch from the master.
1439
_see_also = ['pull', 'working-trees', 'status-flags']
1440
takes_args = ['dir?']
1441
takes_options = ['revision',
1443
help="Show base revision text in conflicts."),
1447
def run(self, dir='.', revision=None, show_base=None):
1448
if revision is not None and len(revision) != 1:
1449
raise errors.BzrCommandError(
1450
"bzr update --revision takes exactly one revision")
1451
tree = WorkingTree.open_containing(dir)[0]
1452
branch = tree.branch
1453
possible_transports = []
1454
master = branch.get_master_branch(
1455
possible_transports=possible_transports)
1456
if master is not None:
1457
branch_location = master.base
1460
branch_location = tree.branch.base
1461
tree.lock_tree_write()
1462
self.add_cleanup(tree.unlock)
1463
# get rid of the final '/' and be ready for display
1464
branch_location = urlutils.unescape_for_display(
1465
branch_location.rstrip('/'),
1467
existing_pending_merges = tree.get_parent_ids()[1:]
1471
# may need to fetch data into a heavyweight checkout
1472
# XXX: this may take some time, maybe we should display a
1474
old_tip = branch.update(possible_transports)
1475
if revision is not None:
1476
revision_id = revision[0].as_revision_id(branch)
1478
revision_id = branch.last_revision()
1479
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1480
revno = branch.revision_id_to_dotted_revno(revision_id)
1481
note("Tree is up to date at revision %s of branch %s" %
1482
('.'.join(map(str, revno)), branch_location))
1484
view_info = _get_view_info_for_change_reporter(tree)
1485
change_reporter = delta._ChangeReporter(
1486
unversioned_filter=tree.is_ignored,
1487
view_info=view_info)
1489
conflicts = tree.update(
1491
possible_transports=possible_transports,
1492
revision=revision_id,
1494
show_base=show_base)
1495
except errors.NoSuchRevision, e:
1496
raise errors.BzrCommandError(
1497
"branch has no revision %s\n"
1498
"bzr update --revision only works"
1499
" for a revision in the branch history"
1501
revno = tree.branch.revision_id_to_dotted_revno(
1502
_mod_revision.ensure_null(tree.last_revision()))
1503
note('Updated to revision %s of branch %s' %
1504
('.'.join(map(str, revno)), branch_location))
1505
parent_ids = tree.get_parent_ids()
1506
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1507
note('Your local commits will now show as pending merges with '
1508
"'bzr status', and can be committed with 'bzr commit'.")
1515
class cmd_info(Command):
1516
__doc__ = """Show information about a working tree, branch or repository.
1518
This command will show all known locations and formats associated to the
1519
tree, branch or repository.
1521
In verbose mode, statistical information is included with each report.
1522
To see extended statistic information, use a verbosity level of 2 or
1523
higher by specifying the verbose option multiple times, e.g. -vv.
1525
Branches and working trees will also report any missing revisions.
1529
Display information on the format and related locations:
1533
Display the above together with extended format information and
1534
basic statistics (like the number of files in the working tree and
1535
number of revisions in the branch and repository):
1539
Display the above together with number of committers to the branch:
1543
_see_also = ['revno', 'working-trees', 'repositories']
1544
takes_args = ['location?']
1545
takes_options = ['verbose']
1546
encoding_type = 'replace'
1549
def run(self, location=None, verbose=False):
1551
noise_level = get_verbosity_level()
1554
from bzrlib.info import show_bzrdir_info
1555
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1556
verbose=noise_level, outfile=self.outf)
1559
class cmd_remove(Command):
1560
__doc__ = """Remove files or directories.
1562
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1563
delete them if they can easily be recovered using revert otherwise they
1564
will be backed up (adding an extention of the form .~#~). If no options or
1565
parameters are given Bazaar will scan for files that are being tracked by
1566
Bazaar but missing in your tree and stop tracking them for you.
1568
takes_args = ['file*']
1569
takes_options = ['verbose',
1570
Option('new', help='Only remove files that have never been committed.'),
1571
RegistryOption.from_kwargs('file-deletion-strategy',
1572
'The file deletion mode to be used.',
1573
title='Deletion Strategy', value_switches=True, enum_switch=False,
1574
safe='Backup changed files (default).',
1575
keep='Delete from bzr but leave the working copy.',
1576
no_backup='Don\'t backup changed files.',
1577
force='Delete all the specified files, even if they can not be '
1578
'recovered and even if they are non-empty directories. '
1579
'(deprecated, use no-backup)')]
1580
aliases = ['rm', 'del']
1581
encoding_type = 'replace'
1583
def run(self, file_list, verbose=False, new=False,
1584
file_deletion_strategy='safe'):
1585
if file_deletion_strategy == 'force':
1586
note("(The --force option is deprecated, rather use --no-backup "
1588
file_deletion_strategy = 'no-backup'
1590
tree, file_list = WorkingTree.open_containing_paths(file_list)
1592
if file_list is not None:
1593
file_list = [f for f in file_list]
1595
self.add_cleanup(tree.lock_write().unlock)
1596
# Heuristics should probably all move into tree.remove_smart or
1599
added = tree.changes_from(tree.basis_tree(),
1600
specific_files=file_list).added
1601
file_list = sorted([f[0] for f in added], reverse=True)
1602
if len(file_list) == 0:
1603
raise errors.BzrCommandError('No matching files.')
1604
elif file_list is None:
1605
# missing files show up in iter_changes(basis) as
1606
# versioned-with-no-kind.
1608
for change in tree.iter_changes(tree.basis_tree()):
1609
# Find paths in the working tree that have no kind:
1610
if change[1][1] is not None and change[6][1] is None:
1611
missing.append(change[1][1])
1612
file_list = sorted(missing, reverse=True)
1613
file_deletion_strategy = 'keep'
1614
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1615
keep_files=file_deletion_strategy=='keep',
1616
force=(file_deletion_strategy=='no-backup'))
1619
class cmd_file_id(Command):
1620
__doc__ = """Print file_id of a particular file or directory.
1622
The file_id is assigned when the file is first added and remains the
1623
same through all revisions where the file exists, even when it is
1628
_see_also = ['inventory', 'ls']
1629
takes_args = ['filename']
1632
def run(self, filename):
1633
tree, relpath = WorkingTree.open_containing(filename)
1634
i = tree.path2id(relpath)
1636
raise errors.NotVersionedError(filename)
1638
self.outf.write(i + '\n')
1641
class cmd_file_path(Command):
1642
__doc__ = """Print path of file_ids to a file or directory.
1644
This prints one line for each directory down to the target,
1645
starting at the branch root.
1649
takes_args = ['filename']
1652
def run(self, filename):
1653
tree, relpath = WorkingTree.open_containing(filename)
1654
fid = tree.path2id(relpath)
1656
raise errors.NotVersionedError(filename)
1657
segments = osutils.splitpath(relpath)
1658
for pos in range(1, len(segments) + 1):
1659
path = osutils.joinpath(segments[:pos])
1660
self.outf.write("%s\n" % tree.path2id(path))
1663
class cmd_reconcile(Command):
1664
__doc__ = """Reconcile bzr metadata in a branch.
1666
This can correct data mismatches that may have been caused by
1667
previous ghost operations or bzr upgrades. You should only
1668
need to run this command if 'bzr check' or a bzr developer
1669
advises you to run it.
1671
If a second branch is provided, cross-branch reconciliation is
1672
also attempted, which will check that data like the tree root
1673
id which was not present in very early bzr versions is represented
1674
correctly in both branches.
1676
At the same time it is run it may recompress data resulting in
1677
a potential saving in disk space or performance gain.
1679
The branch *MUST* be on a listable system such as local disk or sftp.
1682
_see_also = ['check']
1683
takes_args = ['branch?']
1685
Option('canonicalize-chks',
1686
help='Make sure CHKs are in canonical form (repairs '
1691
def run(self, branch=".", canonicalize_chks=False):
1692
from bzrlib.reconcile import reconcile
1693
dir = bzrdir.BzrDir.open(branch)
1694
reconcile(dir, canonicalize_chks=canonicalize_chks)
1697
class cmd_revision_history(Command):
1698
__doc__ = """Display the list of revision ids on a branch."""
1701
takes_args = ['location?']
1706
def run(self, location="."):
1707
branch = Branch.open_containing(location)[0]
1708
for revid in branch.revision_history():
1709
self.outf.write(revid)
1710
self.outf.write('\n')
1713
class cmd_ancestry(Command):
1714
__doc__ = """List all revisions merged into this branch."""
1716
_see_also = ['log', 'revision-history']
1717
takes_args = ['location?']
1722
def run(self, location="."):
1724
wt = WorkingTree.open_containing(location)[0]
1725
except errors.NoWorkingTree:
1726
b = Branch.open(location)
1727
last_revision = b.last_revision()
1730
last_revision = wt.last_revision()
1732
revision_ids = b.repository.get_ancestry(last_revision)
1734
for revision_id in revision_ids:
1735
self.outf.write(revision_id + '\n')
1738
class cmd_init(Command):
1739
__doc__ = """Make a directory into a versioned branch.
1741
Use this to create an empty branch, or before importing an
1744
If there is a repository in a parent directory of the location, then
1745
the history of the branch will be stored in the repository. Otherwise
1746
init creates a standalone branch which carries its own history
1747
in the .bzr directory.
1749
If there is already a branch at the location but it has no working tree,
1750
the tree can be populated with 'bzr checkout'.
1752
Recipe for importing a tree of files::
1758
bzr commit -m "imported project"
1761
_see_also = ['init-repository', 'branch', 'checkout']
1762
takes_args = ['location?']
1764
Option('create-prefix',
1765
help='Create the path leading up to the branch '
1766
'if it does not already exist.'),
1767
RegistryOption('format',
1768
help='Specify a format for this branch. '
1769
'See "help formats".',
1770
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1771
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1772
value_switches=True,
1773
title="Branch format",
1775
Option('append-revisions-only',
1776
help='Never change revnos or the existing log.'
1777
' Append revisions to it only.'),
1779
'Create a branch without a working tree.')
1781
def run(self, location=None, format=None, append_revisions_only=False,
1782
create_prefix=False, no_tree=False):
1784
format = bzrdir.format_registry.make_bzrdir('default')
1785
if location is None:
1788
to_transport = transport.get_transport(location)
1790
# The path has to exist to initialize a
1791
# branch inside of it.
1792
# Just using os.mkdir, since I don't
1793
# believe that we want to create a bunch of
1794
# locations if the user supplies an extended path
1796
to_transport.ensure_base()
1797
except errors.NoSuchFile:
1798
if not create_prefix:
1799
raise errors.BzrCommandError("Parent directory of %s"
1801
"\nYou may supply --create-prefix to create all"
1802
" leading parent directories."
1804
to_transport.create_prefix()
1807
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1808
except errors.NotBranchError:
1809
# really a NotBzrDir error...
1810
create_branch = bzrdir.BzrDir.create_branch_convenience
1812
force_new_tree = False
1814
force_new_tree = None
1815
branch = create_branch(to_transport.base, format=format,
1816
possible_transports=[to_transport],
1817
force_new_tree=force_new_tree)
1818
a_bzrdir = branch.bzrdir
1820
from bzrlib.transport.local import LocalTransport
1821
if a_bzrdir.has_branch():
1822
if (isinstance(to_transport, LocalTransport)
1823
and not a_bzrdir.has_workingtree()):
1824
raise errors.BranchExistsWithoutWorkingTree(location)
1825
raise errors.AlreadyBranchError(location)
1826
branch = a_bzrdir.create_branch()
1828
a_bzrdir.create_workingtree()
1829
if append_revisions_only:
1831
branch.set_append_revisions_only(True)
1832
except errors.UpgradeRequired:
1833
raise errors.BzrCommandError('This branch format cannot be set'
1834
' to append-revisions-only. Try --default.')
1836
from bzrlib.info import describe_layout, describe_format
1838
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1839
except (errors.NoWorkingTree, errors.NotLocalUrl):
1841
repository = branch.repository
1842
layout = describe_layout(repository, branch, tree).lower()
1843
format = describe_format(a_bzrdir, repository, branch, tree)
1844
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1845
if repository.is_shared():
1846
#XXX: maybe this can be refactored into transport.path_or_url()
1847
url = repository.bzrdir.root_transport.external_url()
1849
url = urlutils.local_path_from_url(url)
1850
except errors.InvalidURL:
1852
self.outf.write("Using shared repository: %s\n" % url)
1855
class cmd_init_repository(Command):
1856
__doc__ = """Create a shared repository for branches to share storage space.
1858
New branches created under the repository directory will store their
1859
revisions in the repository, not in the branch directory. For branches
1860
with shared history, this reduces the amount of storage needed and
1861
speeds up the creation of new branches.
1863
If the --no-trees option is given then the branches in the repository
1864
will not have working trees by default. They will still exist as
1865
directories on disk, but they will not have separate copies of the
1866
files at a certain revision. This can be useful for repositories that
1867
store branches which are interacted with through checkouts or remote
1868
branches, such as on a server.
1871
Create a shared repository holding just branches::
1873
bzr init-repo --no-trees repo
1876
Make a lightweight checkout elsewhere::
1878
bzr checkout --lightweight repo/trunk trunk-checkout
1883
_see_also = ['init', 'branch', 'checkout', 'repositories']
1884
takes_args = ["location"]
1885
takes_options = [RegistryOption('format',
1886
help='Specify a format for this repository. See'
1887
' "bzr help formats" for details.',
1888
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1889
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1890
value_switches=True, title='Repository format'),
1892
help='Branches in the repository will default to'
1893
' not having a working tree.'),
1895
aliases = ["init-repo"]
1897
def run(self, location, format=None, no_trees=False):
1899
format = bzrdir.format_registry.make_bzrdir('default')
1901
if location is None:
1904
to_transport = transport.get_transport(location)
1905
to_transport.ensure_base()
1907
newdir = format.initialize_on_transport(to_transport)
1908
repo = newdir.create_repository(shared=True)
1909
repo.set_make_working_trees(not no_trees)
1911
from bzrlib.info import show_bzrdir_info
1912
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1915
class cmd_diff(Command):
1916
__doc__ = """Show differences in the working tree, between revisions or branches.
1918
If no arguments are given, all changes for the current tree are listed.
1919
If files are given, only the changes in those files are listed.
1920
Remote and multiple branches can be compared by using the --old and
1921
--new options. If not provided, the default for both is derived from
1922
the first argument, if any, or the current tree if no arguments are
1925
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1926
produces patches suitable for "patch -p1".
1928
Note that when using the -r argument with a range of revisions, the
1929
differences are computed between the two specified revisions. That
1930
is, the command does not show the changes introduced by the first
1931
revision in the range. This differs from the interpretation of
1932
revision ranges used by "bzr log" which includes the first revision
1937
2 - unrepresentable changes
1942
Shows the difference in the working tree versus the last commit::
1946
Difference between the working tree and revision 1::
1950
Difference between revision 3 and revision 1::
1954
Difference between revision 3 and revision 1 for branch xxx::
1958
The changes introduced by revision 2 (equivalent to -r1..2)::
1962
To see the changes introduced by revision X::
1966
Note that in the case of a merge, the -c option shows the changes
1967
compared to the left hand parent. To see the changes against
1968
another parent, use::
1970
bzr diff -r<chosen_parent>..X
1972
The changes between the current revision and the previous revision
1973
(equivalent to -c-1 and -r-2..-1)
1977
Show just the differences for file NEWS::
1981
Show the differences in working tree xxx for file NEWS::
1985
Show the differences from branch xxx to this working tree:
1989
Show the differences between two branches for file NEWS::
1991
bzr diff --old xxx --new yyy NEWS
1993
Same as 'bzr diff' but prefix paths with old/ and new/::
1995
bzr diff --prefix old/:new/
1997
Show the differences using a custom diff program with options::
1999
bzr diff --using /usr/bin/diff --diff-options -wu
2001
_see_also = ['status']
2002
takes_args = ['file*']
2004
Option('diff-options', type=str,
2005
help='Pass these options to the external diff program.'),
2006
Option('prefix', type=str,
2008
help='Set prefixes added to old and new filenames, as '
2009
'two values separated by a colon. (eg "old/:new/").'),
2011
help='Branch/tree to compare from.',
2015
help='Branch/tree to compare to.',
2021
help='Use this command to compare files.',
2024
RegistryOption('format',
2026
help='Diff format to use.',
2027
lazy_registry=('bzrlib.diff', 'format_registry'),
2028
title='Diff format'),
2030
aliases = ['di', 'dif']
2031
encoding_type = 'exact'
2034
def run(self, revision=None, file_list=None, diff_options=None,
2035
prefix=None, old=None, new=None, using=None, format=None):
2036
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2039
if (prefix is None) or (prefix == '0'):
2047
old_label, new_label = prefix.split(":")
2049
raise errors.BzrCommandError(
2050
'--prefix expects two values separated by a colon'
2051
' (eg "old/:new/")')
2053
if revision and len(revision) > 2:
2054
raise errors.BzrCommandError('bzr diff --revision takes exactly'
2055
' one or two revision specifiers')
2057
if using is not None and format is not None:
2058
raise errors.BzrCommandError('--using and --format are mutually '
2061
(old_tree, new_tree,
2062
old_branch, new_branch,
2063
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2064
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2065
# GNU diff on Windows uses ANSI encoding for filenames
2066
path_encoding = osutils.get_diff_header_encoding()
2067
return show_diff_trees(old_tree, new_tree, sys.stdout,
2068
specific_files=specific_files,
2069
external_diff_options=diff_options,
2070
old_label=old_label, new_label=new_label,
2071
extra_trees=extra_trees,
2072
path_encoding=path_encoding,
2077
class cmd_deleted(Command):
2078
__doc__ = """List files deleted in the working tree.
2080
# TODO: Show files deleted since a previous revision, or
2081
# between two revisions.
2082
# TODO: Much more efficient way to do this: read in new
2083
# directories with readdir, rather than stating each one. Same
2084
# level of effort but possibly much less IO. (Or possibly not,
2085
# if the directories are very large...)
2086
_see_also = ['status', 'ls']
2087
takes_options = ['directory', 'show-ids']
2090
def run(self, show_ids=False, directory=u'.'):
2091
tree = WorkingTree.open_containing(directory)[0]
2092
self.add_cleanup(tree.lock_read().unlock)
2093
old = tree.basis_tree()
2094
self.add_cleanup(old.lock_read().unlock)
2095
for path, ie in old.inventory.iter_entries():
2096
if not tree.has_id(ie.file_id):
2097
self.outf.write(path)
2099
self.outf.write(' ')
2100
self.outf.write(ie.file_id)
2101
self.outf.write('\n')
2104
class cmd_modified(Command):
2105
__doc__ = """List files modified in working tree.
2109
_see_also = ['status', 'ls']
2110
takes_options = ['directory', 'null']
2113
def run(self, null=False, directory=u'.'):
2114
tree = WorkingTree.open_containing(directory)[0]
2115
self.add_cleanup(tree.lock_read().unlock)
2116
td = tree.changes_from(tree.basis_tree())
2118
for path, id, kind, text_modified, meta_modified in td.modified:
2120
self.outf.write(path + '\0')
2122
self.outf.write(osutils.quotefn(path) + '\n')
2125
class cmd_added(Command):
2126
__doc__ = """List files added in working tree.
2130
_see_also = ['status', 'ls']
2131
takes_options = ['directory', 'null']
2134
def run(self, null=False, directory=u'.'):
2135
wt = WorkingTree.open_containing(directory)[0]
2136
self.add_cleanup(wt.lock_read().unlock)
2137
basis = wt.basis_tree()
2138
self.add_cleanup(basis.lock_read().unlock)
2139
basis_inv = basis.inventory
2142
if file_id in basis_inv:
2144
if inv.is_root(file_id) and len(basis_inv) == 0:
2146
path = inv.id2path(file_id)
2147
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2150
self.outf.write(path + '\0')
2152
self.outf.write(osutils.quotefn(path) + '\n')
2155
class cmd_root(Command):
2156
__doc__ = """Show the tree root directory.
2158
The root is the nearest enclosing directory with a .bzr control
2161
takes_args = ['filename?']
2163
def run(self, filename=None):
2164
"""Print the branch root."""
2165
tree = WorkingTree.open_containing(filename)[0]
2166
self.outf.write(tree.basedir + '\n')
2169
def _parse_limit(limitstring):
2171
return int(limitstring)
2173
msg = "The limit argument must be an integer."
2174
raise errors.BzrCommandError(msg)
2177
def _parse_levels(s):
2181
msg = "The levels argument must be an integer."
2182
raise errors.BzrCommandError(msg)
2185
class cmd_log(Command):
2186
__doc__ = """Show historical log for a branch or subset of a branch.
2188
log is bzr's default tool for exploring the history of a branch.
2189
The branch to use is taken from the first parameter. If no parameters
2190
are given, the branch containing the working directory is logged.
2191
Here are some simple examples::
2193
bzr log log the current branch
2194
bzr log foo.py log a file in its branch
2195
bzr log http://server/branch log a branch on a server
2197
The filtering, ordering and information shown for each revision can
2198
be controlled as explained below. By default, all revisions are
2199
shown sorted (topologically) so that newer revisions appear before
2200
older ones and descendants always appear before ancestors. If displayed,
2201
merged revisions are shown indented under the revision in which they
2206
The log format controls how information about each revision is
2207
displayed. The standard log formats are called ``long``, ``short``
2208
and ``line``. The default is long. See ``bzr help log-formats``
2209
for more details on log formats.
2211
The following options can be used to control what information is
2214
-l N display a maximum of N revisions
2215
-n N display N levels of revisions (0 for all, 1 for collapsed)
2216
-v display a status summary (delta) for each revision
2217
-p display a diff (patch) for each revision
2218
--show-ids display revision-ids (and file-ids), not just revnos
2220
Note that the default number of levels to display is a function of the
2221
log format. If the -n option is not used, the standard log formats show
2222
just the top level (mainline).
2224
Status summaries are shown using status flags like A, M, etc. To see
2225
the changes explained using words like ``added`` and ``modified``
2226
instead, use the -vv option.
2230
To display revisions from oldest to newest, use the --forward option.
2231
In most cases, using this option will have little impact on the total
2232
time taken to produce a log, though --forward does not incrementally
2233
display revisions like --reverse does when it can.
2235
:Revision filtering:
2237
The -r option can be used to specify what revision or range of revisions
2238
to filter against. The various forms are shown below::
2240
-rX display revision X
2241
-rX.. display revision X and later
2242
-r..Y display up to and including revision Y
2243
-rX..Y display from X to Y inclusive
2245
See ``bzr help revisionspec`` for details on how to specify X and Y.
2246
Some common examples are given below::
2248
-r-1 show just the tip
2249
-r-10.. show the last 10 mainline revisions
2250
-rsubmit:.. show what's new on this branch
2251
-rancestor:path.. show changes since the common ancestor of this
2252
branch and the one at location path
2253
-rdate:yesterday.. show changes since yesterday
2255
When logging a range of revisions using -rX..Y, log starts at
2256
revision Y and searches back in history through the primary
2257
("left-hand") parents until it finds X. When logging just the
2258
top level (using -n1), an error is reported if X is not found
2259
along the way. If multi-level logging is used (-n0), X may be
2260
a nested merge revision and the log will be truncated accordingly.
2264
If parameters are given and the first one is not a branch, the log
2265
will be filtered to show only those revisions that changed the
2266
nominated files or directories.
2268
Filenames are interpreted within their historical context. To log a
2269
deleted file, specify a revision range so that the file existed at
2270
the end or start of the range.
2272
Historical context is also important when interpreting pathnames of
2273
renamed files/directories. Consider the following example:
2275
* revision 1: add tutorial.txt
2276
* revision 2: modify tutorial.txt
2277
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2281
* ``bzr log guide.txt`` will log the file added in revision 1
2283
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2285
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2286
the original file in revision 2.
2288
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2289
was no file called guide.txt in revision 2.
2291
Renames are always followed by log. By design, there is no need to
2292
explicitly ask for this (and no way to stop logging a file back
2293
until it was last renamed).
2297
The --message option can be used for finding revisions that match a
2298
regular expression in a commit message.
2302
GUI tools and IDEs are often better at exploring history than command
2303
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2304
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2305
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2306
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2308
You may find it useful to add the aliases below to ``bazaar.conf``::
2312
top = log -l10 --line
2315
``bzr tip`` will then show the latest revision while ``bzr top``
2316
will show the last 10 mainline revisions. To see the details of a
2317
particular revision X, ``bzr show -rX``.
2319
If you are interested in looking deeper into a particular merge X,
2320
use ``bzr log -n0 -rX``.
2322
``bzr log -v`` on a branch with lots of history is currently
2323
very slow. A fix for this issue is currently under development.
2324
With or without that fix, it is recommended that a revision range
2325
be given when using the -v option.
2327
bzr has a generic full-text matching plugin, bzr-search, that can be
2328
used to find revisions matching user names, commit messages, etc.
2329
Among other features, this plugin can find all revisions containing
2330
a list of words but not others.
2332
When exploring non-mainline history on large projects with deep
2333
history, the performance of log can be greatly improved by installing
2334
the historycache plugin. This plugin buffers historical information
2335
trading disk space for faster speed.
2337
takes_args = ['file*']
2338
_see_also = ['log-formats', 'revisionspec']
2341
help='Show from oldest to newest.'),
2343
custom_help('verbose',
2344
help='Show files changed in each revision.'),
2348
type=bzrlib.option._parse_revision_str,
2350
help='Show just the specified revision.'
2351
' See also "help revisionspec".'),
2353
RegistryOption('authors',
2354
'What names to list as authors - first, all or committer.',
2356
lazy_registry=('bzrlib.log', 'author_list_registry'),
2360
help='Number of levels to display - 0 for all, 1 for flat.',
2362
type=_parse_levels),
2365
help='Show revisions whose message matches this '
2366
'regular expression.',
2370
help='Limit the output to the first N revisions.',
2375
help='Show changes made in each revision as a patch.'),
2376
Option('include-merges',
2377
help='Show merged revisions like --levels 0 does.'),
2378
Option('exclude-common-ancestry',
2379
help='Display only the revisions that are not part'
2380
' of both ancestries (require -rX..Y)'
2383
encoding_type = 'replace'
2386
def run(self, file_list=None, timezone='original',
2397
include_merges=False,
2399
exclude_common_ancestry=False,
2401
from bzrlib.log import (
2403
make_log_request_dict,
2404
_get_info_for_log_files,
2406
direction = (forward and 'forward') or 'reverse'
2407
if (exclude_common_ancestry
2408
and (revision is None or len(revision) != 2)):
2409
raise errors.BzrCommandError(
2410
'--exclude-common-ancestry requires -r with two revisions')
2415
raise errors.BzrCommandError(
2416
'--levels and --include-merges are mutually exclusive')
2418
if change is not None:
2420
raise errors.RangeInChangeOption()
2421
if revision is not None:
2422
raise errors.BzrCommandError(
2423
'--revision and --change are mutually exclusive')
2428
filter_by_dir = False
2430
# find the file ids to log and check for directory filtering
2431
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2432
revision, file_list, self.add_cleanup)
2433
for relpath, file_id, kind in file_info_list:
2435
raise errors.BzrCommandError(
2436
"Path unknown at end or start of revision range: %s" %
2438
# If the relpath is the top of the tree, we log everything
2443
file_ids.append(file_id)
2444
filter_by_dir = filter_by_dir or (
2445
kind in ['directory', 'tree-reference'])
2448
# FIXME ? log the current subdir only RBC 20060203
2449
if revision is not None \
2450
and len(revision) > 0 and revision[0].get_branch():
2451
location = revision[0].get_branch()
2454
dir, relpath = bzrdir.BzrDir.open_containing(location)
2455
b = dir.open_branch()
2456
self.add_cleanup(b.lock_read().unlock)
2457
rev1, rev2 = _get_revision_range(revision, b, self.name())
2459
# Decide on the type of delta & diff filtering to use
2460
# TODO: add an --all-files option to make this configurable & consistent
2468
diff_type = 'partial'
2472
# Build the log formatter
2473
if log_format is None:
2474
log_format = log.log_formatter_registry.get_default(b)
2475
# Make a non-encoding output to include the diffs - bug 328007
2476
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2477
lf = log_format(show_ids=show_ids, to_file=self.outf,
2478
to_exact_file=unencoded_output,
2479
show_timezone=timezone,
2480
delta_format=get_verbosity_level(),
2482
show_advice=levels is None,
2483
author_list_handler=authors)
2485
# Choose the algorithm for doing the logging. It's annoying
2486
# having multiple code paths like this but necessary until
2487
# the underlying repository format is faster at generating
2488
# deltas or can provide everything we need from the indices.
2489
# The default algorithm - match-using-deltas - works for
2490
# multiple files and directories and is faster for small
2491
# amounts of history (200 revisions say). However, it's too
2492
# slow for logging a single file in a repository with deep
2493
# history, i.e. > 10K revisions. In the spirit of "do no
2494
# evil when adding features", we continue to use the
2495
# original algorithm - per-file-graph - for the "single
2496
# file that isn't a directory without showing a delta" case.
2497
partial_history = revision and b.repository._format.supports_chks
2498
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2499
or delta_type or partial_history)
2501
# Build the LogRequest and execute it
2502
if len(file_ids) == 0:
2504
rqst = make_log_request_dict(
2505
direction=direction, specific_fileids=file_ids,
2506
start_revision=rev1, end_revision=rev2, limit=limit,
2507
message_search=message, delta_type=delta_type,
2508
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2509
exclude_common_ancestry=exclude_common_ancestry,
2511
Logger(b, rqst).show(lf)
2514
def _get_revision_range(revisionspec_list, branch, command_name):
2515
"""Take the input of a revision option and turn it into a revision range.
2517
It returns RevisionInfo objects which can be used to obtain the rev_id's
2518
of the desired revisions. It does some user input validations.
2520
if revisionspec_list is None:
2523
elif len(revisionspec_list) == 1:
2524
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2525
elif len(revisionspec_list) == 2:
2526
start_spec = revisionspec_list[0]
2527
end_spec = revisionspec_list[1]
2528
if end_spec.get_branch() != start_spec.get_branch():
2529
# b is taken from revision[0].get_branch(), and
2530
# show_log will use its revision_history. Having
2531
# different branches will lead to weird behaviors.
2532
raise errors.BzrCommandError(
2533
"bzr %s doesn't accept two revisions in different"
2534
" branches." % command_name)
2535
if start_spec.spec is None:
2536
# Avoid loading all the history.
2537
rev1 = RevisionInfo(branch, None, None)
2539
rev1 = start_spec.in_history(branch)
2540
# Avoid loading all of history when we know a missing
2541
# end of range means the last revision ...
2542
if end_spec.spec is None:
2543
last_revno, last_revision_id = branch.last_revision_info()
2544
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2546
rev2 = end_spec.in_history(branch)
2548
raise errors.BzrCommandError(
2549
'bzr %s --revision takes one or two values.' % command_name)
2553
def _revision_range_to_revid_range(revision_range):
2556
if revision_range[0] is not None:
2557
rev_id1 = revision_range[0].rev_id
2558
if revision_range[1] is not None:
2559
rev_id2 = revision_range[1].rev_id
2560
return rev_id1, rev_id2
2562
def get_log_format(long=False, short=False, line=False, default='long'):
2563
log_format = default
2567
log_format = 'short'
2573
class cmd_touching_revisions(Command):
2574
__doc__ = """Return revision-ids which affected a particular file.
2576
A more user-friendly interface is "bzr log FILE".
2580
takes_args = ["filename"]
2583
def run(self, filename):
2584
tree, relpath = WorkingTree.open_containing(filename)
2585
file_id = tree.path2id(relpath)
2587
self.add_cleanup(b.lock_read().unlock)
2588
touching_revs = log.find_touching_revisions(b, file_id)
2589
for revno, revision_id, what in touching_revs:
2590
self.outf.write("%6d %s\n" % (revno, what))
2593
class cmd_ls(Command):
2594
__doc__ = """List files in a tree.
2597
_see_also = ['status', 'cat']
2598
takes_args = ['path?']
2602
Option('recursive', short_name='R',
2603
help='Recurse into subdirectories.'),
2605
help='Print paths relative to the root of the branch.'),
2606
Option('unknown', short_name='u',
2607
help='Print unknown files.'),
2608
Option('versioned', help='Print versioned files.',
2610
Option('ignored', short_name='i',
2611
help='Print ignored files.'),
2612
Option('kind', short_name='k',
2613
help='List entries of a particular kind: file, directory, symlink.',
2620
def run(self, revision=None, verbose=False,
2621
recursive=False, from_root=False,
2622
unknown=False, versioned=False, ignored=False,
2623
null=False, kind=None, show_ids=False, path=None, directory=None):
2625
if kind and kind not in ('file', 'directory', 'symlink'):
2626
raise errors.BzrCommandError('invalid kind specified')
2628
if verbose and null:
2629
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2630
all = not (unknown or versioned or ignored)
2632
selection = {'I':ignored, '?':unknown, 'V':versioned}
2638
raise errors.BzrCommandError('cannot specify both --from-root'
2641
tree, branch, relpath = \
2642
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2644
# Calculate the prefix to use
2648
prefix = relpath + '/'
2649
elif fs_path != '.' and not fs_path.endswith('/'):
2650
prefix = fs_path + '/'
2652
if revision is not None or tree is None:
2653
tree = _get_one_revision_tree('ls', revision, branch=branch)
2656
if isinstance(tree, WorkingTree) and tree.supports_views():
2657
view_files = tree.views.lookup_view()
2660
view_str = views.view_display_str(view_files)
2661
note("Ignoring files outside view. View is %s" % view_str)
2663
self.add_cleanup(tree.lock_read().unlock)
2664
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2665
from_dir=relpath, recursive=recursive):
2666
# Apply additional masking
2667
if not all and not selection[fc]:
2669
if kind is not None and fkind != kind:
2674
fullpath = osutils.pathjoin(relpath, fp)
2677
views.check_path_in_view(tree, fullpath)
2678
except errors.FileOutsideView:
2683
fp = osutils.pathjoin(prefix, fp)
2684
kindch = entry.kind_character()
2685
outstring = fp + kindch
2686
ui.ui_factory.clear_term()
2688
outstring = '%-8s %s' % (fc, outstring)
2689
if show_ids and fid is not None:
2690
outstring = "%-50s %s" % (outstring, fid)
2691
self.outf.write(outstring + '\n')
2693
self.outf.write(fp + '\0')
2696
self.outf.write(fid)
2697
self.outf.write('\0')
2705
self.outf.write('%-50s %s\n' % (outstring, my_id))
2707
self.outf.write(outstring + '\n')
2710
class cmd_unknowns(Command):
2711
__doc__ = """List unknown files.
2716
takes_options = ['directory']
2719
def run(self, directory=u'.'):
2720
for f in WorkingTree.open_containing(directory)[0].unknowns():
2721
self.outf.write(osutils.quotefn(f) + '\n')
2724
class cmd_ignore(Command):
2725
__doc__ = """Ignore specified files or patterns.
2727
See ``bzr help patterns`` for details on the syntax of patterns.
2729
If a .bzrignore file does not exist, the ignore command
2730
will create one and add the specified files or patterns to the newly
2731
created file. The ignore command will also automatically add the
2732
.bzrignore file to be versioned. Creating a .bzrignore file without
2733
the use of the ignore command will require an explicit add command.
2735
To remove patterns from the ignore list, edit the .bzrignore file.
2736
After adding, editing or deleting that file either indirectly by
2737
using this command or directly by using an editor, be sure to commit
2740
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2741
the global ignore file can be found in the application data directory as
2742
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2743
Global ignores are not touched by this command. The global ignore file
2744
can be edited directly using an editor.
2746
Patterns prefixed with '!' are exceptions to ignore patterns and take
2747
precedence over regular ignores. Such exceptions are used to specify
2748
files that should be versioned which would otherwise be ignored.
2750
Patterns prefixed with '!!' act as regular ignore patterns, but have
2751
precedence over the '!' exception patterns.
2755
* Ignore patterns containing shell wildcards must be quoted from
2758
* Ignore patterns starting with "#" act as comments in the ignore file.
2759
To ignore patterns that begin with that character, use the "RE:" prefix.
2762
Ignore the top level Makefile::
2764
bzr ignore ./Makefile
2766
Ignore .class files in all directories...::
2768
bzr ignore "*.class"
2770
...but do not ignore "special.class"::
2772
bzr ignore "!special.class"
2774
Ignore files whose name begins with the "#" character::
2778
Ignore .o files under the lib directory::
2780
bzr ignore "lib/**/*.o"
2782
Ignore .o files under the lib directory::
2784
bzr ignore "RE:lib/.*\.o"
2786
Ignore everything but the "debian" toplevel directory::
2788
bzr ignore "RE:(?!debian/).*"
2790
Ignore everything except the "local" toplevel directory,
2791
but always ignore autosave files ending in ~, even under local/::
2794
bzr ignore "!./local"
2798
_see_also = ['status', 'ignored', 'patterns']
2799
takes_args = ['name_pattern*']
2800
takes_options = ['directory',
2801
Option('default-rules',
2802
help='Display the default ignore rules that bzr uses.')
2805
def run(self, name_pattern_list=None, default_rules=None,
2807
from bzrlib import ignores
2808
if default_rules is not None:
2809
# dump the default rules and exit
2810
for pattern in ignores.USER_DEFAULTS:
2811
self.outf.write("%s\n" % pattern)
2813
if not name_pattern_list:
2814
raise errors.BzrCommandError("ignore requires at least one "
2815
"NAME_PATTERN or --default-rules.")
2816
name_pattern_list = [globbing.normalize_pattern(p)
2817
for p in name_pattern_list]
2819
for p in name_pattern_list:
2820
if not globbing.Globster.is_pattern_valid(p):
2821
bad_patterns += ('\n %s' % p)
2823
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2824
ui.ui_factory.show_error(msg)
2825
raise errors.InvalidPattern('')
2826
for name_pattern in name_pattern_list:
2827
if (name_pattern[0] == '/' or
2828
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2829
raise errors.BzrCommandError(
2830
"NAME_PATTERN should not be an absolute path")
2831
tree, relpath = WorkingTree.open_containing(directory)
2832
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2833
ignored = globbing.Globster(name_pattern_list)
2835
self.add_cleanup(tree.lock_read().unlock)
2836
for entry in tree.list_files():
2840
if ignored.match(filename):
2841
matches.append(filename)
2842
if len(matches) > 0:
2843
self.outf.write("Warning: the following files are version controlled and"
2844
" match your ignore pattern:\n%s"
2845
"\nThese files will continue to be version controlled"
2846
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2849
class cmd_ignored(Command):
2850
__doc__ = """List ignored files and the patterns that matched them.
2852
List all the ignored files and the ignore pattern that caused the file to
2855
Alternatively, to list just the files::
2860
encoding_type = 'replace'
2861
_see_also = ['ignore', 'ls']
2862
takes_options = ['directory']
2865
def run(self, directory=u'.'):
2866
tree = WorkingTree.open_containing(directory)[0]
2867
self.add_cleanup(tree.lock_read().unlock)
2868
for path, file_class, kind, file_id, entry in tree.list_files():
2869
if file_class != 'I':
2871
## XXX: Slightly inefficient since this was already calculated
2872
pat = tree.is_ignored(path)
2873
self.outf.write('%-50s %s\n' % (path, pat))
2876
class cmd_lookup_revision(Command):
2877
__doc__ = """Lookup the revision-id from a revision-number
2880
bzr lookup-revision 33
2883
takes_args = ['revno']
2884
takes_options = ['directory']
2887
def run(self, revno, directory=u'.'):
2891
raise errors.BzrCommandError("not a valid revision-number: %r"
2893
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2894
self.outf.write("%s\n" % revid)
2897
class cmd_export(Command):
2898
__doc__ = """Export current or past revision to a destination directory or archive.
2900
If no revision is specified this exports the last committed revision.
2902
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2903
given, try to find the format with the extension. If no extension
2904
is found exports to a directory (equivalent to --format=dir).
2906
If root is supplied, it will be used as the root directory inside
2907
container formats (tar, zip, etc). If it is not supplied it will default
2908
to the exported filename. The root option has no effect for 'dir' format.
2910
If branch is omitted then the branch containing the current working
2911
directory will be used.
2913
Note: Export of tree with non-ASCII filenames to zip is not supported.
2915
================= =========================
2916
Supported formats Autodetected by extension
2917
================= =========================
2920
tbz2 .tar.bz2, .tbz2
2923
================= =========================
2926
takes_args = ['dest', 'branch_or_subdir?']
2927
takes_options = ['directory',
2929
help="Type of file to export to.",
2932
Option('filters', help='Apply content filters to export the '
2933
'convenient form.'),
2936
help="Name of the root directory inside the exported file."),
2937
Option('per-file-timestamps',
2938
help='Set modification time of files to that of the last '
2939
'revision in which it was changed.'),
2941
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2942
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2943
from bzrlib.export import export
2945
if branch_or_subdir is None:
2946
tree = WorkingTree.open_containing(directory)[0]
2950
b, subdir = Branch.open_containing(branch_or_subdir)
2953
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2955
export(rev_tree, dest, format, root, subdir, filtered=filters,
2956
per_file_timestamps=per_file_timestamps)
2957
except errors.NoSuchExportFormat, e:
2958
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2961
class cmd_cat(Command):
2962
__doc__ = """Write the contents of a file as of a given revision to standard output.
2964
If no revision is nominated, the last revision is used.
2966
Note: Take care to redirect standard output when using this command on a
2971
takes_options = ['directory',
2972
Option('name-from-revision', help='The path name in the old tree.'),
2973
Option('filters', help='Apply content filters to display the '
2974
'convenience form.'),
2977
takes_args = ['filename']
2978
encoding_type = 'exact'
2981
def run(self, filename, revision=None, name_from_revision=False,
2982
filters=False, directory=None):
2983
if revision is not None and len(revision) != 1:
2984
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2985
" one revision specifier")
2986
tree, branch, relpath = \
2987
_open_directory_or_containing_tree_or_branch(filename, directory)
2988
self.add_cleanup(branch.lock_read().unlock)
2989
return self._run(tree, branch, relpath, filename, revision,
2990
name_from_revision, filters)
2992
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2995
tree = b.basis_tree()
2996
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2997
self.add_cleanup(rev_tree.lock_read().unlock)
2999
old_file_id = rev_tree.path2id(relpath)
3001
if name_from_revision:
3002
# Try in revision if requested
3003
if old_file_id is None:
3004
raise errors.BzrCommandError(
3005
"%r is not present in revision %s" % (
3006
filename, rev_tree.get_revision_id()))
3008
content = rev_tree.get_file_text(old_file_id)
3010
cur_file_id = tree.path2id(relpath)
3012
if cur_file_id is not None:
3013
# Then try with the actual file id
3015
content = rev_tree.get_file_text(cur_file_id)
3017
except errors.NoSuchId:
3018
# The actual file id didn't exist at that time
3020
if not found and old_file_id is not None:
3021
# Finally try with the old file id
3022
content = rev_tree.get_file_text(old_file_id)
3025
# Can't be found anywhere
3026
raise errors.BzrCommandError(
3027
"%r is not present in revision %s" % (
3028
filename, rev_tree.get_revision_id()))
3030
from bzrlib.filters import (
3031
ContentFilterContext,
3032
filtered_output_bytes,
3034
filters = rev_tree._content_filter_stack(relpath)
3035
chunks = content.splitlines(True)
3036
content = filtered_output_bytes(chunks, filters,
3037
ContentFilterContext(relpath, rev_tree))
3039
self.outf.writelines(content)
3042
self.outf.write(content)
3045
class cmd_local_time_offset(Command):
3046
__doc__ = """Show the offset in seconds from GMT to local time."""
3050
self.outf.write("%s\n" % osutils.local_time_offset())
3054
class cmd_commit(Command):
3055
__doc__ = """Commit changes into a new revision.
3057
An explanatory message needs to be given for each commit. This is
3058
often done by using the --message option (getting the message from the
3059
command line) or by using the --file option (getting the message from
3060
a file). If neither of these options is given, an editor is opened for
3061
the user to enter the message. To see the changed files in the
3062
boilerplate text loaded into the editor, use the --show-diff option.
3064
By default, the entire tree is committed and the person doing the
3065
commit is assumed to be the author. These defaults can be overridden
3070
If selected files are specified, only changes to those files are
3071
committed. If a directory is specified then the directory and
3072
everything within it is committed.
3074
When excludes are given, they take precedence over selected files.
3075
For example, to commit only changes within foo, but not changes
3078
bzr commit foo -x foo/bar
3080
A selective commit after a merge is not yet supported.
3084
If the author of the change is not the same person as the committer,
3085
you can specify the author's name using the --author option. The
3086
name should be in the same format as a committer-id, e.g.
3087
"John Doe <jdoe@example.com>". If there is more than one author of
3088
the change you can specify the option multiple times, once for each
3093
A common mistake is to forget to add a new file or directory before
3094
running the commit command. The --strict option checks for unknown
3095
files and aborts the commit if any are found. More advanced pre-commit
3096
checks can be implemented by defining hooks. See ``bzr help hooks``
3101
If you accidentially commit the wrong changes or make a spelling
3102
mistake in the commit message say, you can use the uncommit command
3103
to undo it. See ``bzr help uncommit`` for details.
3105
Hooks can also be configured to run after a commit. This allows you
3106
to trigger updates to external systems like bug trackers. The --fixes
3107
option can be used to record the association between a revision and
3108
one or more bugs. See ``bzr help bugs`` for details.
3111
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3112
takes_args = ['selected*']
3114
ListOption('exclude', type=str, short_name='x',
3115
help="Do not consider changes made to a given path."),
3116
Option('message', type=unicode,
3118
help="Description of the new revision."),
3121
help='Commit even if nothing has changed.'),
3122
Option('file', type=str,
3125
help='Take commit message from this file.'),
3127
help="Refuse to commit if there are unknown "
3128
"files in the working tree."),
3129
Option('commit-time', type=str,
3130
help="Manually set a commit time using commit date "
3131
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3132
ListOption('fixes', type=str,
3133
help="Mark a bug as being fixed by this revision "
3134
"(see \"bzr help bugs\")."),
3135
ListOption('author', type=unicode,
3136
help="Set the author's name, if it's different "
3137
"from the committer."),
3139
help="Perform a local commit in a bound "
3140
"branch. Local commits are not pushed to "
3141
"the master branch until a normal commit "
3144
Option('show-diff', short_name='p',
3145
help='When no message is supplied, show the diff along'
3146
' with the status summary in the message editor.'),
3148
aliases = ['ci', 'checkin']
3150
def _iter_bug_fix_urls(self, fixes, branch):
3151
# Configure the properties for bug fixing attributes.
3152
for fixed_bug in fixes:
3153
tokens = fixed_bug.split(':')
3154
if len(tokens) != 2:
3155
raise errors.BzrCommandError(
3156
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3157
"See \"bzr help bugs\" for more information on this "
3158
"feature.\nCommit refused." % fixed_bug)
3159
tag, bug_id = tokens
3161
yield bugtracker.get_bug_url(tag, branch, bug_id)
3162
except errors.UnknownBugTrackerAbbreviation:
3163
raise errors.BzrCommandError(
3164
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3165
except errors.MalformedBugIdentifier, e:
3166
raise errors.BzrCommandError(
3167
"%s\nCommit refused." % (str(e),))
3169
def run(self, message=None, file=None, verbose=False, selected_list=None,
3170
unchanged=False, strict=False, local=False, fixes=None,
3171
author=None, show_diff=False, exclude=None, commit_time=None):
3172
from bzrlib.errors import (
3177
from bzrlib.msgeditor import (
3178
edit_commit_message_encoded,
3179
generate_commit_message_template,
3180
make_commit_message_template_encoded
3183
commit_stamp = offset = None
3184
if commit_time is not None:
3186
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3187
except ValueError, e:
3188
raise errors.BzrCommandError(
3189
"Could not parse --commit-time: " + str(e))
3193
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3194
if selected_list == ['']:
3195
# workaround - commit of root of tree should be exactly the same
3196
# as just default commit in that tree, and succeed even though
3197
# selected-file merge commit is not done yet
3202
bug_property = bugtracker.encode_fixes_bug_urls(
3203
self._iter_bug_fix_urls(fixes, tree.branch))
3205
properties['bugs'] = bug_property
3207
if local and not tree.branch.get_bound_location():
3208
raise errors.LocalRequiresBoundBranch()
3210
if message is not None:
3212
file_exists = osutils.lexists(message)
3213
except UnicodeError:
3214
# The commit message contains unicode characters that can't be
3215
# represented in the filesystem encoding, so that can't be a
3220
'The commit message is a file name: "%(f)s".\n'
3221
'(use --file "%(f)s" to take commit message from that file)'
3223
ui.ui_factory.show_warning(warning_msg)
3225
message = message.replace('\r\n', '\n')
3226
message = message.replace('\r', '\n')
3228
raise errors.BzrCommandError(
3229
"please specify either --message or --file")
3231
def get_message(commit_obj):
3232
"""Callback to get commit message"""
3236
my_message = f.read().decode(osutils.get_user_encoding())
3239
elif message is not None:
3240
my_message = message
3242
# No message supplied: make one up.
3243
# text is the status of the tree
3244
text = make_commit_message_template_encoded(tree,
3245
selected_list, diff=show_diff,
3246
output_encoding=osutils.get_user_encoding())
3247
# start_message is the template generated from hooks
3248
# XXX: Warning - looks like hooks return unicode,
3249
# make_commit_message_template_encoded returns user encoding.
3250
# We probably want to be using edit_commit_message instead to
3252
start_message = generate_commit_message_template(commit_obj)
3253
my_message = edit_commit_message_encoded(text,
3254
start_message=start_message)
3255
if my_message is None:
3256
raise errors.BzrCommandError("please specify a commit"
3257
" message with either --message or --file")
3258
if my_message == "":
3259
raise errors.BzrCommandError("empty commit message specified")
3262
# The API permits a commit with a filter of [] to mean 'select nothing'
3263
# but the command line should not do that.
3264
if not selected_list:
3265
selected_list = None
3267
tree.commit(message_callback=get_message,
3268
specific_files=selected_list,
3269
allow_pointless=unchanged, strict=strict, local=local,
3270
reporter=None, verbose=verbose, revprops=properties,
3271
authors=author, timestamp=commit_stamp,
3273
exclude=tree.safe_relpath_files(exclude))
3274
except PointlessCommit:
3275
raise errors.BzrCommandError("No changes to commit."
3276
" Please 'bzr add' the files you want to commit, or use"
3277
" --unchanged to force an empty commit.")
3278
except ConflictsInTree:
3279
raise errors.BzrCommandError('Conflicts detected in working '
3280
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3282
except StrictCommitFailed:
3283
raise errors.BzrCommandError("Commit refused because there are"
3284
" unknown files in the working tree.")
3285
except errors.BoundBranchOutOfDate, e:
3286
e.extra_help = ("\n"
3287
'To commit to master branch, run update and then commit.\n'
3288
'You can also pass --local to commit to continue working '
3293
class cmd_check(Command):
3294
__doc__ = """Validate working tree structure, branch consistency and repository history.
3296
This command checks various invariants about branch and repository storage
3297
to detect data corruption or bzr bugs.
3299
The working tree and branch checks will only give output if a problem is
3300
detected. The output fields of the repository check are:
3303
This is just the number of revisions checked. It doesn't
3307
This is just the number of versionedfiles checked. It
3308
doesn't indicate a problem.
3310
unreferenced ancestors
3311
Texts that are ancestors of other texts, but
3312
are not properly referenced by the revision ancestry. This is a
3313
subtle problem that Bazaar can work around.
3316
This is the total number of unique file contents
3317
seen in the checked revisions. It does not indicate a problem.
3320
This is the total number of repeated texts seen
3321
in the checked revisions. Texts can be repeated when their file
3322
entries are modified, but the file contents are not. It does not
3325
If no restrictions are specified, all Bazaar data that is found at the given
3326
location will be checked.
3330
Check the tree and branch at 'foo'::
3332
bzr check --tree --branch foo
3334
Check only the repository at 'bar'::
3336
bzr check --repo bar
3338
Check everything at 'baz'::
3343
_see_also = ['reconcile']
3344
takes_args = ['path?']
3345
takes_options = ['verbose',
3346
Option('branch', help="Check the branch related to the"
3347
" current directory."),
3348
Option('repo', help="Check the repository related to the"
3349
" current directory."),
3350
Option('tree', help="Check the working tree related to"
3351
" the current directory.")]
3353
def run(self, path=None, verbose=False, branch=False, repo=False,
3355
from bzrlib.check import check_dwim
3358
if not branch and not repo and not tree:
3359
branch = repo = tree = True
3360
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3363
class cmd_upgrade(Command):
3364
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3366
When the default format has changed after a major new release of
3367
Bazaar, you may be informed during certain operations that you
3368
should upgrade. Upgrading to a newer format may improve performance
3369
or make new features available. It may however limit interoperability
3370
with older repositories or with older versions of Bazaar.
3372
If you wish to upgrade to a particular format rather than the
3373
current default, that can be specified using the --format option.
3374
As a consequence, you can use the upgrade command this way to
3375
"downgrade" to an earlier format, though some conversions are
3376
a one way process (e.g. changing from the 1.x default to the
3377
2.x default) so downgrading is not always possible.
3379
A backup.bzr.~#~ directory is created at the start of the conversion
3380
process (where # is a number). By default, this is left there on
3381
completion. If the conversion fails, delete the new .bzr directory
3382
and rename this one back in its place. Use the --clean option to ask
3383
for the backup.bzr directory to be removed on successful conversion.
3384
Alternatively, you can delete it by hand if everything looks good
3387
If the location given is a shared repository, dependent branches
3388
are also converted provided the repository converts successfully.
3389
If the conversion of a branch fails, remaining branches are still
3392
For more information on upgrades, see the Bazaar Upgrade Guide,
3393
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3396
_see_also = ['check', 'reconcile', 'formats']
3397
takes_args = ['url?']
3399
RegistryOption('format',
3400
help='Upgrade to a specific format. See "bzr help'
3401
' formats" for details.',
3402
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3403
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3404
value_switches=True, title='Branch format'),
3406
help='Remove the backup.bzr directory if successful.'),
3408
help="Show what would be done, but don't actually do anything."),
3411
def run(self, url='.', format=None, clean=False, dry_run=False):
3412
from bzrlib.upgrade import upgrade
3413
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3415
if len(exceptions) == 1:
3416
# Compatibility with historical behavior
3422
class cmd_whoami(Command):
3423
__doc__ = """Show or set bzr user id.
3426
Show the email of the current user::
3430
Set the current user::
3432
bzr whoami "Frank Chu <fchu@example.com>"
3434
takes_options = [ 'directory',
3436
help='Display email address only.'),
3438
help='Set identity for the current branch instead of '
3441
takes_args = ['name?']
3442
encoding_type = 'replace'
3445
def run(self, email=False, branch=False, name=None, directory=None):
3447
if directory is None:
3448
# use branch if we're inside one; otherwise global config
3450
c = Branch.open_containing(u'.')[0].get_config()
3451
except errors.NotBranchError:
3452
c = _mod_config.GlobalConfig()
3454
c = Branch.open(directory).get_config()
3456
self.outf.write(c.user_email() + '\n')
3458
self.outf.write(c.username() + '\n')
3462
raise errors.BzrCommandError("--email can only be used to display existing "
3465
# display a warning if an email address isn't included in the given name.
3467
_mod_config.extract_email_address(name)
3468
except errors.NoEmailInUsername, e:
3469
warning('"%s" does not seem to contain an email address. '
3470
'This is allowed, but not recommended.', name)
3472
# use global config unless --branch given
3474
if directory is None:
3475
c = Branch.open_containing(u'.')[0].get_config()
3477
c = Branch.open(directory).get_config()
3479
c = _mod_config.GlobalConfig()
3480
c.set_user_option('email', name)
3483
class cmd_nick(Command):
3484
__doc__ = """Print or set the branch nickname.
3486
If unset, the tree root directory name is used as the nickname.
3487
To print the current nickname, execute with no argument.
3489
Bound branches use the nickname of its master branch unless it is set
3493
_see_also = ['info']
3494
takes_args = ['nickname?']
3495
takes_options = ['directory']
3496
def run(self, nickname=None, directory=u'.'):
3497
branch = Branch.open_containing(directory)[0]
3498
if nickname is None:
3499
self.printme(branch)
3501
branch.nick = nickname
3504
def printme(self, branch):
3505
self.outf.write('%s\n' % branch.nick)
3508
class cmd_alias(Command):
3509
__doc__ = """Set/unset and display aliases.
3512
Show the current aliases::
3516
Show the alias specified for 'll'::
3520
Set an alias for 'll'::
3522
bzr alias ll="log --line -r-10..-1"
3524
To remove an alias for 'll'::
3526
bzr alias --remove ll
3529
takes_args = ['name?']
3531
Option('remove', help='Remove the alias.'),
3534
def run(self, name=None, remove=False):
3536
self.remove_alias(name)
3538
self.print_aliases()
3540
equal_pos = name.find('=')
3542
self.print_alias(name)
3544
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3546
def remove_alias(self, alias_name):
3547
if alias_name is None:
3548
raise errors.BzrCommandError(
3549
'bzr alias --remove expects an alias to remove.')
3550
# If alias is not found, print something like:
3551
# unalias: foo: not found
3552
c = _mod_config.GlobalConfig()
3553
c.unset_alias(alias_name)
3556
def print_aliases(self):
3557
"""Print out the defined aliases in a similar format to bash."""
3558
aliases = _mod_config.GlobalConfig().get_aliases()
3559
for key, value in sorted(aliases.iteritems()):
3560
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3563
def print_alias(self, alias_name):
3564
from bzrlib.commands import get_alias
3565
alias = get_alias(alias_name)
3567
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3570
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3572
def set_alias(self, alias_name, alias_command):
3573
"""Save the alias in the global config."""
3574
c = _mod_config.GlobalConfig()
3575
c.set_alias(alias_name, alias_command)
3578
class cmd_selftest(Command):
3579
__doc__ = """Run internal test suite.
3581
If arguments are given, they are regular expressions that say which tests
3582
should run. Tests matching any expression are run, and other tests are
3585
Alternatively if --first is given, matching tests are run first and then
3586
all other tests are run. This is useful if you have been working in a
3587
particular area, but want to make sure nothing else was broken.
3589
If --exclude is given, tests that match that regular expression are
3590
excluded, regardless of whether they match --first or not.
3592
To help catch accidential dependencies between tests, the --randomize
3593
option is useful. In most cases, the argument used is the word 'now'.
3594
Note that the seed used for the random number generator is displayed
3595
when this option is used. The seed can be explicitly passed as the
3596
argument to this option if required. This enables reproduction of the
3597
actual ordering used if and when an order sensitive problem is encountered.
3599
If --list-only is given, the tests that would be run are listed. This is
3600
useful when combined with --first, --exclude and/or --randomize to
3601
understand their impact. The test harness reports "Listed nn tests in ..."
3602
instead of "Ran nn tests in ..." when list mode is enabled.
3604
If the global option '--no-plugins' is given, plugins are not loaded
3605
before running the selftests. This has two effects: features provided or
3606
modified by plugins will not be tested, and tests provided by plugins will
3609
Tests that need working space on disk use a common temporary directory,
3610
typically inside $TMPDIR or /tmp.
3612
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3613
into a pdb postmortem session.
3615
The --coverage=DIRNAME global option produces a report with covered code
3619
Run only tests relating to 'ignore'::
3623
Disable plugins and list tests as they're run::
3625
bzr --no-plugins selftest -v
3627
# NB: this is used from the class without creating an instance, which is
3628
# why it does not have a self parameter.
3629
def get_transport_type(typestring):
3630
"""Parse and return a transport specifier."""
3631
if typestring == "sftp":
3632
from bzrlib.tests import stub_sftp
3633
return stub_sftp.SFTPAbsoluteServer
3634
if typestring == "memory":
3635
from bzrlib.tests import test_server
3636
return memory.MemoryServer
3637
if typestring == "fakenfs":
3638
from bzrlib.tests import test_server
3639
return test_server.FakeNFSServer
3640
msg = "No known transport type %s. Supported types are: sftp\n" %\
3642
raise errors.BzrCommandError(msg)
3645
takes_args = ['testspecs*']
3646
takes_options = ['verbose',
3648
help='Stop when one test fails.',
3652
help='Use a different transport by default '
3653
'throughout the test suite.',
3654
type=get_transport_type),
3656
help='Run the benchmarks rather than selftests.',
3658
Option('lsprof-timed',
3659
help='Generate lsprof output for benchmarked'
3660
' sections of code.'),
3661
Option('lsprof-tests',
3662
help='Generate lsprof output for each test.'),
3664
help='Run all tests, but run specified tests first.',
3668
help='List the tests instead of running them.'),
3669
RegistryOption('parallel',
3670
help="Run the test suite in parallel.",
3671
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3672
value_switches=False,
3674
Option('randomize', type=str, argname="SEED",
3675
help='Randomize the order of tests using the given'
3676
' seed or "now" for the current time.'),
3677
Option('exclude', type=str, argname="PATTERN",
3679
help='Exclude tests that match this regular'
3682
help='Output test progress via subunit.'),
3683
Option('strict', help='Fail on missing dependencies or '
3685
Option('load-list', type=str, argname='TESTLISTFILE',
3686
help='Load a test id list from a text file.'),
3687
ListOption('debugflag', type=str, short_name='E',
3688
help='Turn on a selftest debug flag.'),
3689
ListOption('starting-with', type=str, argname='TESTID',
3690
param_name='starting_with', short_name='s',
3692
'Load only the tests starting with TESTID.'),
3694
encoding_type = 'replace'
3697
Command.__init__(self)
3698
self.additional_selftest_args = {}
3700
def run(self, testspecs_list=None, verbose=False, one=False,
3701
transport=None, benchmark=None,
3703
first=False, list_only=False,
3704
randomize=None, exclude=None, strict=False,
3705
load_list=None, debugflag=None, starting_with=None, subunit=False,
3706
parallel=None, lsprof_tests=False):
3707
from bzrlib import tests
3709
if testspecs_list is not None:
3710
pattern = '|'.join(testspecs_list)
3715
from bzrlib.tests import SubUnitBzrRunner
3717
raise errors.BzrCommandError("subunit not available. subunit "
3718
"needs to be installed to use --subunit.")
3719
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3720
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3721
# stdout, which would corrupt the subunit stream.
3722
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3723
# following code can be deleted when it's sufficiently deployed
3724
# -- vila/mgz 20100514
3725
if (sys.platform == "win32"
3726
and getattr(sys.stdout, 'fileno', None) is not None):
3728
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3730
self.additional_selftest_args.setdefault(
3731
'suite_decorators', []).append(parallel)
3733
raise errors.BzrCommandError(
3734
"--benchmark is no longer supported from bzr 2.2; "
3735
"use bzr-usertest instead")
3736
test_suite_factory = None
3737
selftest_kwargs = {"verbose": verbose,
3739
"stop_on_failure": one,
3740
"transport": transport,
3741
"test_suite_factory": test_suite_factory,
3742
"lsprof_timed": lsprof_timed,
3743
"lsprof_tests": lsprof_tests,
3744
"matching_tests_first": first,
3745
"list_only": list_only,
3746
"random_seed": randomize,
3747
"exclude_pattern": exclude,
3749
"load_list": load_list,
3750
"debug_flags": debugflag,
3751
"starting_with": starting_with
3753
selftest_kwargs.update(self.additional_selftest_args)
3755
# Make deprecation warnings visible, unless -Werror is set
3756
cleanup = symbol_versioning.activate_deprecation_warnings(
3759
result = tests.selftest(**selftest_kwargs)
3762
return int(not result)
3765
class cmd_version(Command):
3766
__doc__ = """Show version of bzr."""
3768
encoding_type = 'replace'
3770
Option("short", help="Print just the version number."),
3774
def run(self, short=False):
3775
from bzrlib.version import show_version
3777
self.outf.write(bzrlib.version_string + '\n')
3779
show_version(to_file=self.outf)
3782
class cmd_rocks(Command):
3783
__doc__ = """Statement of optimism."""
3789
self.outf.write("It sure does!\n")
3792
class cmd_find_merge_base(Command):
3793
__doc__ = """Find and print a base revision for merging two branches."""
3794
# TODO: Options to specify revisions on either side, as if
3795
# merging only part of the history.
3796
takes_args = ['branch', 'other']
3800
def run(self, branch, other):
3801
from bzrlib.revision import ensure_null
3803
branch1 = Branch.open_containing(branch)[0]
3804
branch2 = Branch.open_containing(other)[0]
3805
self.add_cleanup(branch1.lock_read().unlock)
3806
self.add_cleanup(branch2.lock_read().unlock)
3807
last1 = ensure_null(branch1.last_revision())
3808
last2 = ensure_null(branch2.last_revision())
3810
graph = branch1.repository.get_graph(branch2.repository)
3811
base_rev_id = graph.find_unique_lca(last1, last2)
3813
self.outf.write('merge base is revision %s\n' % base_rev_id)
3816
class cmd_merge(Command):
3817
__doc__ = """Perform a three-way merge.
3819
The source of the merge can be specified either in the form of a branch,
3820
or in the form of a path to a file containing a merge directive generated
3821
with bzr send. If neither is specified, the default is the upstream branch
3822
or the branch most recently merged using --remember.
3824
When merging from a branch, by default bzr will try to merge in all new
3825
work from the other branch, automatically determining an appropriate base
3826
revision. If this fails, you may need to give an explicit base.
3828
To pick a different ending revision, pass "--revision OTHER". bzr will
3829
try to merge in all new work up to and including revision OTHER.
3831
If you specify two values, "--revision BASE..OTHER", only revisions BASE
3832
through OTHER, excluding BASE but including OTHER, will be merged. If this
3833
causes some revisions to be skipped, i.e. if the destination branch does
3834
not already contain revision BASE, such a merge is commonly referred to as
3837
Revision numbers are always relative to the source branch.
3839
Merge will do its best to combine the changes in two branches, but there
3840
are some kinds of problems only a human can fix. When it encounters those,
3841
it will mark a conflict. A conflict means that you need to fix something,
3842
before you should commit.
3844
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3846
If there is no default branch set, the first merge will set it. After
3847
that, you can omit the branch to use the default. To change the
3848
default, use --remember. The value will only be saved if the remote
3849
location can be accessed.
3851
The results of the merge are placed into the destination working
3852
directory, where they can be reviewed (with bzr diff), tested, and then
3853
committed to record the result of the merge.
3855
merge refuses to run if there are any uncommitted changes, unless
3856
--force is given. The --force option can also be used to create a
3857
merge revision which has more than two parents.
3859
If one would like to merge changes from the working tree of the other
3860
branch without merging any committed revisions, the --uncommitted option
3863
To select only some changes to merge, use "merge -i", which will prompt
3864
you to apply each diff hunk and file change, similar to "shelve".
3867
To merge all new revisions from bzr.dev::
3869
bzr merge ../bzr.dev
3871
To merge changes up to and including revision 82 from bzr.dev::
3873
bzr merge -r 82 ../bzr.dev
3875
To merge the changes introduced by 82, without previous changes::
3877
bzr merge -r 81..82 ../bzr.dev
3879
To apply a merge directive contained in /tmp/merge::
3881
bzr merge /tmp/merge
3883
To create a merge revision with three parents from two branches
3884
feature1a and feature1b:
3886
bzr merge ../feature1a
3887
bzr merge ../feature1b --force
3888
bzr commit -m 'revision with three parents'
3891
encoding_type = 'exact'
3892
_see_also = ['update', 'remerge', 'status-flags', 'send']
3893
takes_args = ['location?']
3898
help='Merge even if the destination tree has uncommitted changes.'),
3902
Option('show-base', help="Show base revision text in "
3904
Option('uncommitted', help='Apply uncommitted changes'
3905
' from a working copy, instead of branch changes.'),
3906
Option('pull', help='If the destination is already'
3907
' completely merged into the source, pull from the'
3908
' source rather than merging. When this happens,'
3909
' you do not need to commit the result.'),
3910
custom_help('directory',
3911
help='Branch to merge into, '
3912
'rather than the one containing the working directory.'),
3913
Option('preview', help='Instead of merging, show a diff of the'
3915
Option('interactive', help='Select changes interactively.',
3919
def run(self, location=None, revision=None, force=False,
3920
merge_type=None, show_base=False, reprocess=None, remember=False,
3921
uncommitted=False, pull=False,
3926
if merge_type is None:
3927
merge_type = _mod_merge.Merge3Merger
3929
if directory is None: directory = u'.'
3930
possible_transports = []
3932
allow_pending = True
3933
verified = 'inapplicable'
3934
tree = WorkingTree.open_containing(directory)[0]
3937
basis_tree = tree.revision_tree(tree.last_revision())
3938
except errors.NoSuchRevision:
3939
basis_tree = tree.basis_tree()
3941
# die as quickly as possible if there are uncommitted changes
3943
if tree.has_changes():
3944
raise errors.UncommittedChanges(tree)
3946
view_info = _get_view_info_for_change_reporter(tree)
3947
change_reporter = delta._ChangeReporter(
3948
unversioned_filter=tree.is_ignored, view_info=view_info)
3949
pb = ui.ui_factory.nested_progress_bar()
3950
self.add_cleanup(pb.finished)
3951
self.add_cleanup(tree.lock_write().unlock)
3952
if location is not None:
3954
mergeable = bundle.read_mergeable_from_url(location,
3955
possible_transports=possible_transports)
3956
except errors.NotABundle:
3960
raise errors.BzrCommandError('Cannot use --uncommitted'
3961
' with bundles or merge directives.')
3963
if revision is not None:
3964
raise errors.BzrCommandError(
3965
'Cannot use -r with merge directives or bundles')
3966
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3969
if merger is None and uncommitted:
3970
if revision is not None and len(revision) > 0:
3971
raise errors.BzrCommandError('Cannot use --uncommitted and'
3972
' --revision at the same time.')
3973
merger = self.get_merger_from_uncommitted(tree, location, None)
3974
allow_pending = False
3977
merger, allow_pending = self._get_merger_from_branch(tree,
3978
location, revision, remember, possible_transports, None)
3980
merger.merge_type = merge_type
3981
merger.reprocess = reprocess
3982
merger.show_base = show_base
3983
self.sanity_check_merger(merger)
3984
if (merger.base_rev_id == merger.other_rev_id and
3985
merger.other_rev_id is not None):
3986
note('Nothing to do.')
3989
if merger.interesting_files is not None:
3990
raise errors.BzrCommandError('Cannot pull individual files')
3991
if (merger.base_rev_id == tree.last_revision()):
3992
result = tree.pull(merger.other_branch, False,
3993
merger.other_rev_id)
3994
result.report(self.outf)
3996
if merger.this_basis is None:
3997
raise errors.BzrCommandError(
3998
"This branch has no commits."
3999
" (perhaps you would prefer 'bzr pull')")
4001
return self._do_preview(merger)
4003
return self._do_interactive(merger)
4005
return self._do_merge(merger, change_reporter, allow_pending,
4008
def _get_preview(self, merger):
4009
tree_merger = merger.make_merger()
4010
tt = tree_merger.make_preview_transform()
4011
self.add_cleanup(tt.finalize)
4012
result_tree = tt.get_preview_tree()
4015
def _do_preview(self, merger):
4016
from bzrlib.diff import show_diff_trees
4017
result_tree = self._get_preview(merger)
4018
path_encoding = osutils.get_diff_header_encoding()
4019
show_diff_trees(merger.this_tree, result_tree, self.outf,
4020
old_label='', new_label='',
4021
path_encoding=path_encoding)
4023
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4024
merger.change_reporter = change_reporter
4025
conflict_count = merger.do_merge()
4027
merger.set_pending()
4028
if verified == 'failed':
4029
warning('Preview patch does not match changes')
4030
if conflict_count != 0:
4035
def _do_interactive(self, merger):
4036
"""Perform an interactive merge.
4038
This works by generating a preview tree of the merge, then using
4039
Shelver to selectively remove the differences between the working tree
4040
and the preview tree.
4042
from bzrlib import shelf_ui
4043
result_tree = self._get_preview(merger)
4044
writer = bzrlib.option.diff_writer_registry.get()
4045
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4046
reporter=shelf_ui.ApplyReporter(),
4047
diff_writer=writer(sys.stdout))
4053
def sanity_check_merger(self, merger):
4054
if (merger.show_base and
4055
not merger.merge_type is _mod_merge.Merge3Merger):
4056
raise errors.BzrCommandError("Show-base is not supported for this"
4057
" merge type. %s" % merger.merge_type)
4058
if merger.reprocess is None:
4059
if merger.show_base:
4060
merger.reprocess = False
4062
# Use reprocess if the merger supports it
4063
merger.reprocess = merger.merge_type.supports_reprocess
4064
if merger.reprocess and not merger.merge_type.supports_reprocess:
4065
raise errors.BzrCommandError("Conflict reduction is not supported"
4066
" for merge type %s." %
4068
if merger.reprocess and merger.show_base:
4069
raise errors.BzrCommandError("Cannot do conflict reduction and"
4072
def _get_merger_from_branch(self, tree, location, revision, remember,
4073
possible_transports, pb):
4074
"""Produce a merger from a location, assuming it refers to a branch."""
4075
from bzrlib.tag import _merge_tags_if_possible
4076
# find the branch locations
4077
other_loc, user_location = self._select_branch_location(tree, location,
4079
if revision is not None and len(revision) == 2:
4080
base_loc, _unused = self._select_branch_location(tree,
4081
location, revision, 0)
4083
base_loc = other_loc
4085
other_branch, other_path = Branch.open_containing(other_loc,
4086
possible_transports)
4087
if base_loc == other_loc:
4088
base_branch = other_branch
4090
base_branch, base_path = Branch.open_containing(base_loc,
4091
possible_transports)
4092
# Find the revision ids
4093
other_revision_id = None
4094
base_revision_id = None
4095
if revision is not None:
4096
if len(revision) >= 1:
4097
other_revision_id = revision[-1].as_revision_id(other_branch)
4098
if len(revision) == 2:
4099
base_revision_id = revision[0].as_revision_id(base_branch)
4100
if other_revision_id is None:
4101
other_revision_id = _mod_revision.ensure_null(
4102
other_branch.last_revision())
4103
# Remember where we merge from
4104
if ((remember or tree.branch.get_submit_branch() is None) and
4105
user_location is not None):
4106
tree.branch.set_submit_branch(other_branch.base)
4107
# Merge tags (but don't set them in the master branch yet, the user
4108
# might revert this merge). Commit will propagate them.
4109
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4110
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4111
other_revision_id, base_revision_id, other_branch, base_branch)
4112
if other_path != '':
4113
allow_pending = False
4114
merger.interesting_files = [other_path]
4116
allow_pending = True
4117
return merger, allow_pending
4119
def get_merger_from_uncommitted(self, tree, location, pb):
4120
"""Get a merger for uncommitted changes.
4122
:param tree: The tree the merger should apply to.
4123
:param location: The location containing uncommitted changes.
4124
:param pb: The progress bar to use for showing progress.
4126
location = self._select_branch_location(tree, location)[0]
4127
other_tree, other_path = WorkingTree.open_containing(location)
4128
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4129
if other_path != '':
4130
merger.interesting_files = [other_path]
4133
def _select_branch_location(self, tree, user_location, revision=None,
4135
"""Select a branch location, according to possible inputs.
4137
If provided, branches from ``revision`` are preferred. (Both
4138
``revision`` and ``index`` must be supplied.)
4140
Otherwise, the ``location`` parameter is used. If it is None, then the
4141
``submit`` or ``parent`` location is used, and a note is printed.
4143
:param tree: The working tree to select a branch for merging into
4144
:param location: The location entered by the user
4145
:param revision: The revision parameter to the command
4146
:param index: The index to use for the revision parameter. Negative
4147
indices are permitted.
4148
:return: (selected_location, user_location). The default location
4149
will be the user-entered location.
4151
if (revision is not None and index is not None
4152
and revision[index] is not None):
4153
branch = revision[index].get_branch()
4154
if branch is not None:
4155
return branch, branch
4156
if user_location is None:
4157
location = self._get_remembered(tree, 'Merging from')
4159
location = user_location
4160
return location, user_location
4162
def _get_remembered(self, tree, verb_string):
4163
"""Use tree.branch's parent if none was supplied.
4165
Report if the remembered location was used.
4167
stored_location = tree.branch.get_submit_branch()
4168
stored_location_type = "submit"
4169
if stored_location is None:
4170
stored_location = tree.branch.get_parent()
4171
stored_location_type = "parent"
4172
mutter("%s", stored_location)
4173
if stored_location is None:
4174
raise errors.BzrCommandError("No location specified or remembered")
4175
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4176
note(u"%s remembered %s location %s", verb_string,
4177
stored_location_type, display_url)
4178
return stored_location
4181
class cmd_remerge(Command):
4182
__doc__ = """Redo a merge.
4184
Use this if you want to try a different merge technique while resolving
4185
conflicts. Some merge techniques are better than others, and remerge
4186
lets you try different ones on different files.
4188
The options for remerge have the same meaning and defaults as the ones for
4189
merge. The difference is that remerge can (only) be run when there is a
4190
pending merge, and it lets you specify particular files.
4193
Re-do the merge of all conflicted files, and show the base text in
4194
conflict regions, in addition to the usual THIS and OTHER texts::
4196
bzr remerge --show-base
4198
Re-do the merge of "foobar", using the weave merge algorithm, with
4199
additional processing to reduce the size of conflict regions::
4201
bzr remerge --merge-type weave --reprocess foobar
4203
takes_args = ['file*']
4208
help="Show base revision text in conflicts."),
4211
def run(self, file_list=None, merge_type=None, show_base=False,
4213
from bzrlib.conflicts import restore
4214
if merge_type is None:
4215
merge_type = _mod_merge.Merge3Merger
4216
tree, file_list = WorkingTree.open_containing_paths(file_list)
4217
self.add_cleanup(tree.lock_write().unlock)
4218
parents = tree.get_parent_ids()
4219
if len(parents) != 2:
4220
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4221
" merges. Not cherrypicking or"
4223
repository = tree.branch.repository
4224
interesting_ids = None
4226
conflicts = tree.conflicts()
4227
if file_list is not None:
4228
interesting_ids = set()
4229
for filename in file_list:
4230
file_id = tree.path2id(filename)
4232
raise errors.NotVersionedError(filename)
4233
interesting_ids.add(file_id)
4234
if tree.kind(file_id) != "directory":
4237
for name, ie in tree.inventory.iter_entries(file_id):
4238
interesting_ids.add(ie.file_id)
4239
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4241
# Remerge only supports resolving contents conflicts
4242
allowed_conflicts = ('text conflict', 'contents conflict')
4243
restore_files = [c.path for c in conflicts
4244
if c.typestring in allowed_conflicts]
4245
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4246
tree.set_conflicts(ConflictList(new_conflicts))
4247
if file_list is not None:
4248
restore_files = file_list
4249
for filename in restore_files:
4251
restore(tree.abspath(filename))
4252
except errors.NotConflicted:
4254
# Disable pending merges, because the file texts we are remerging
4255
# have not had those merges performed. If we use the wrong parents
4256
# list, we imply that the working tree text has seen and rejected
4257
# all the changes from the other tree, when in fact those changes
4258
# have not yet been seen.
4259
tree.set_parent_ids(parents[:1])
4261
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4262
merger.interesting_ids = interesting_ids
4263
merger.merge_type = merge_type
4264
merger.show_base = show_base
4265
merger.reprocess = reprocess
4266
conflicts = merger.do_merge()
4268
tree.set_parent_ids(parents)
4275
class cmd_revert(Command):
4276
__doc__ = """Revert files to a previous revision.
4278
Giving a list of files will revert only those files. Otherwise, all files
4279
will be reverted. If the revision is not specified with '--revision', the
4280
last committed revision is used.
4282
To remove only some changes, without reverting to a prior version, use
4283
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4284
will remove the changes introduced by the second last commit (-2), without
4285
affecting the changes introduced by the last commit (-1). To remove
4286
certain changes on a hunk-by-hunk basis, see the shelve command.
4288
By default, any files that have been manually changed will be backed up
4289
first. (Files changed only by merge are not backed up.) Backup files have
4290
'.~#~' appended to their name, where # is a number.
4292
When you provide files, you can use their current pathname or the pathname
4293
from the target revision. So you can use revert to "undelete" a file by
4294
name. If you name a directory, all the contents of that directory will be
4297
If you have newly added files since the target revision, they will be
4298
removed. If the files to be removed have been changed, backups will be
4299
created as above. Directories containing unknown files will not be
4302
The working tree contains a list of revisions that have been merged but
4303
not yet committed. These revisions will be included as additional parents
4304
of the next commit. Normally, using revert clears that list as well as
4305
reverting the files. If any files are specified, revert leaves the list
4306
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4307
.`` in the tree root to revert all files but keep the recorded merges,
4308
and ``bzr revert --forget-merges`` to clear the pending merge list without
4309
reverting any files.
4311
Using "bzr revert --forget-merges", it is possible to apply all of the
4312
changes from a branch in a single revision. To do this, perform the merge
4313
as desired. Then doing revert with the "--forget-merges" option will keep
4314
the content of the tree as it was, but it will clear the list of pending
4315
merges. The next commit will then contain all of the changes that are
4316
present in the other branch, but without any other parent revisions.
4317
Because this technique forgets where these changes originated, it may
4318
cause additional conflicts on later merges involving the same source and
4322
_see_also = ['cat', 'export', 'merge', 'shelve']
4325
Option('no-backup', "Do not save backups of reverted files."),
4326
Option('forget-merges',
4327
'Remove pending merge marker, without changing any files.'),
4329
takes_args = ['file*']
4331
def run(self, revision=None, no_backup=False, file_list=None,
4332
forget_merges=None):
4333
tree, file_list = WorkingTree.open_containing_paths(file_list)
4334
self.add_cleanup(tree.lock_tree_write().unlock)
4336
tree.set_parent_ids(tree.get_parent_ids()[:1])
4338
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4341
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4342
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4343
tree.revert(file_list, rev_tree, not no_backup, None,
4344
report_changes=True)
4347
class cmd_assert_fail(Command):
4348
__doc__ = """Test reporting of assertion failures"""
4349
# intended just for use in testing
4354
raise AssertionError("always fails")
4357
class cmd_help(Command):
4358
__doc__ = """Show help on a command or other topic.
4361
_see_also = ['topics']
4363
Option('long', 'Show help on all commands.'),
4365
takes_args = ['topic?']
4366
aliases = ['?', '--help', '-?', '-h']
4369
def run(self, topic=None, long=False):
4371
if topic is None and long:
4373
bzrlib.help.help(topic)
4376
class cmd_shell_complete(Command):
4377
__doc__ = """Show appropriate completions for context.
4379
For a list of all available commands, say 'bzr shell-complete'.
4381
takes_args = ['context?']
4386
def run(self, context=None):
4387
import shellcomplete
4388
shellcomplete.shellcomplete(context)
4391
class cmd_missing(Command):
4392
__doc__ = """Show unmerged/unpulled revisions between two branches.
4394
OTHER_BRANCH may be local or remote.
4396
To filter on a range of revisions, you can use the command -r begin..end
4397
-r revision requests a specific revision, -r ..end or -r begin.. are
4401
1 - some missing revisions
4402
0 - no missing revisions
4406
Determine the missing revisions between this and the branch at the
4407
remembered pull location::
4411
Determine the missing revisions between this and another branch::
4413
bzr missing http://server/branch
4415
Determine the missing revisions up to a specific revision on the other
4418
bzr missing -r ..-10
4420
Determine the missing revisions up to a specific revision on this
4423
bzr missing --my-revision ..-10
4426
_see_also = ['merge', 'pull']
4427
takes_args = ['other_branch?']
4430
Option('reverse', 'Reverse the order of revisions.'),
4432
'Display changes in the local branch only.'),
4433
Option('this' , 'Same as --mine-only.'),
4434
Option('theirs-only',
4435
'Display changes in the remote branch only.'),
4436
Option('other', 'Same as --theirs-only.'),
4440
custom_help('revision',
4441
help='Filter on other branch revisions (inclusive). '
4442
'See "help revisionspec" for details.'),
4443
Option('my-revision',
4444
type=_parse_revision_str,
4445
help='Filter on local branch revisions (inclusive). '
4446
'See "help revisionspec" for details.'),
4447
Option('include-merges',
4448
'Show all revisions in addition to the mainline ones.'),
4450
encoding_type = 'replace'
4453
def run(self, other_branch=None, reverse=False, mine_only=False,
4455
log_format=None, long=False, short=False, line=False,
4456
show_ids=False, verbose=False, this=False, other=False,
4457
include_merges=False, revision=None, my_revision=None,
4459
from bzrlib.missing import find_unmerged, iter_log_revisions
4468
# TODO: We should probably check that we don't have mine-only and
4469
# theirs-only set, but it gets complicated because we also have
4470
# this and other which could be used.
4477
local_branch = Branch.open_containing(directory)[0]
4478
self.add_cleanup(local_branch.lock_read().unlock)
4480
parent = local_branch.get_parent()
4481
if other_branch is None:
4482
other_branch = parent
4483
if other_branch is None:
4484
raise errors.BzrCommandError("No peer location known"
4486
display_url = urlutils.unescape_for_display(parent,
4488
message("Using saved parent location: "
4489
+ display_url + "\n")
4491
remote_branch = Branch.open(other_branch)
4492
if remote_branch.base == local_branch.base:
4493
remote_branch = local_branch
4495
self.add_cleanup(remote_branch.lock_read().unlock)
4497
local_revid_range = _revision_range_to_revid_range(
4498
_get_revision_range(my_revision, local_branch,
4501
remote_revid_range = _revision_range_to_revid_range(
4502
_get_revision_range(revision,
4503
remote_branch, self.name()))
4505
local_extra, remote_extra = find_unmerged(
4506
local_branch, remote_branch, restrict,
4507
backward=not reverse,
4508
include_merges=include_merges,
4509
local_revid_range=local_revid_range,
4510
remote_revid_range=remote_revid_range)
4512
if log_format is None:
4513
registry = log.log_formatter_registry
4514
log_format = registry.get_default(local_branch)
4515
lf = log_format(to_file=self.outf,
4517
show_timezone='original')
4520
if local_extra and not theirs_only:
4521
message("You have %d extra revision(s):\n" %
4523
for revision in iter_log_revisions(local_extra,
4524
local_branch.repository,
4526
lf.log_revision(revision)
4527
printed_local = True
4530
printed_local = False
4532
if remote_extra and not mine_only:
4533
if printed_local is True:
4535
message("You are missing %d revision(s):\n" %
4537
for revision in iter_log_revisions(remote_extra,
4538
remote_branch.repository,
4540
lf.log_revision(revision)
4543
if mine_only and not local_extra:
4544
# We checked local, and found nothing extra
4545
message('This branch is up to date.\n')
4546
elif theirs_only and not remote_extra:
4547
# We checked remote, and found nothing extra
4548
message('Other branch is up to date.\n')
4549
elif not (mine_only or theirs_only or local_extra or
4551
# We checked both branches, and neither one had extra
4553
message("Branches are up to date.\n")
4555
if not status_code and parent is None and other_branch is not None:
4556
self.add_cleanup(local_branch.lock_write().unlock)
4557
# handle race conditions - a parent might be set while we run.
4558
if local_branch.get_parent() is None:
4559
local_branch.set_parent(remote_branch.base)
4563
class cmd_pack(Command):
4564
__doc__ = """Compress the data within a repository.
4566
This operation compresses the data within a bazaar repository. As
4567
bazaar supports automatic packing of repository, this operation is
4568
normally not required to be done manually.
4570
During the pack operation, bazaar takes a backup of existing repository
4571
data, i.e. pack files. This backup is eventually removed by bazaar
4572
automatically when it is safe to do so. To save disk space by removing
4573
the backed up pack files, the --clean-obsolete-packs option may be
4576
Warning: If you use --clean-obsolete-packs and your machine crashes
4577
during or immediately after repacking, you may be left with a state
4578
where the deletion has been written to disk but the new packs have not
4579
been. In this case the repository may be unusable.
4582
_see_also = ['repositories']
4583
takes_args = ['branch_or_repo?']
4585
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4588
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4589
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4591
branch = dir.open_branch()
4592
repository = branch.repository
4593
except errors.NotBranchError:
4594
repository = dir.open_repository()
4595
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4598
class cmd_plugins(Command):
4599
__doc__ = """List the installed plugins.
4601
This command displays the list of installed plugins including
4602
version of plugin and a short description of each.
4604
--verbose shows the path where each plugin is located.
4606
A plugin is an external component for Bazaar that extends the
4607
revision control system, by adding or replacing code in Bazaar.
4608
Plugins can do a variety of things, including overriding commands,
4609
adding new commands, providing additional network transports and
4610
customizing log output.
4612
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4613
for further information on plugins including where to find them and how to
4614
install them. Instructions are also provided there on how to write new
4615
plugins using the Python programming language.
4617
takes_options = ['verbose']
4620
def run(self, verbose=False):
4621
from bzrlib import plugin
4622
self.outf.writelines(
4623
plugin.describe_plugins(show_paths=verbose))
4626
class cmd_testament(Command):
4627
__doc__ = """Show testament (signing-form) of a revision."""
4630
Option('long', help='Produce long-format testament.'),
4632
help='Produce a strict-format testament.')]
4633
takes_args = ['branch?']
4635
def run(self, branch=u'.', revision=None, long=False, strict=False):
4636
from bzrlib.testament import Testament, StrictTestament
4638
testament_class = StrictTestament
4640
testament_class = Testament
4642
b = Branch.open_containing(branch)[0]
4644
b = Branch.open(branch)
4645
self.add_cleanup(b.lock_read().unlock)
4646
if revision is None:
4647
rev_id = b.last_revision()
4649
rev_id = revision[0].as_revision_id(b)
4650
t = testament_class.from_revision(b.repository, rev_id)
4652
sys.stdout.writelines(t.as_text_lines())
4654
sys.stdout.write(t.as_short_text())
4657
class cmd_annotate(Command):
4658
__doc__ = """Show the origin of each line in a file.
4660
This prints out the given file with an annotation on the left side
4661
indicating which revision, author and date introduced the change.
4663
If the origin is the same for a run of consecutive lines, it is
4664
shown only at the top, unless the --all option is given.
4666
# TODO: annotate directories; showing when each file was last changed
4667
# TODO: if the working copy is modified, show annotations on that
4668
# with new uncommitted lines marked
4669
aliases = ['ann', 'blame', 'praise']
4670
takes_args = ['filename']
4671
takes_options = [Option('all', help='Show annotations on all lines.'),
4672
Option('long', help='Show commit date in annotations.'),
4677
encoding_type = 'exact'
4680
def run(self, filename, all=False, long=False, revision=None,
4681
show_ids=False, directory=None):
4682
from bzrlib.annotate import annotate_file, annotate_file_tree
4683
wt, branch, relpath = \
4684
_open_directory_or_containing_tree_or_branch(filename, directory)
4686
self.add_cleanup(wt.lock_read().unlock)
4688
self.add_cleanup(branch.lock_read().unlock)
4689
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4690
self.add_cleanup(tree.lock_read().unlock)
4691
if wt is not None and revision is None:
4692
file_id = wt.path2id(relpath)
4694
file_id = tree.path2id(relpath)
4696
raise errors.NotVersionedError(filename)
4697
if wt is not None and revision is None:
4698
# If there is a tree and we're not annotating historical
4699
# versions, annotate the working tree's content.
4700
annotate_file_tree(wt, file_id, self.outf, long, all,
4703
file_version = tree.inventory[file_id].revision
4704
annotate_file(branch, file_version, file_id, long, all, self.outf,
4708
class cmd_re_sign(Command):
4709
__doc__ = """Create a digital signature for an existing revision."""
4710
# TODO be able to replace existing ones.
4712
hidden = True # is this right ?
4713
takes_args = ['revision_id*']
4714
takes_options = ['directory', 'revision']
4716
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4717
if revision_id_list is not None and revision is not None:
4718
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4719
if revision_id_list is None and revision is None:
4720
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4721
b = WorkingTree.open_containing(directory)[0].branch
4722
self.add_cleanup(b.lock_write().unlock)
4723
return self._run(b, revision_id_list, revision)
4725
def _run(self, b, revision_id_list, revision):
4726
import bzrlib.gpg as gpg
4727
gpg_strategy = gpg.GPGStrategy(b.get_config())
4728
if revision_id_list is not None:
4729
b.repository.start_write_group()
4731
for revision_id in revision_id_list:
4732
b.repository.sign_revision(revision_id, gpg_strategy)
4734
b.repository.abort_write_group()
4737
b.repository.commit_write_group()
4738
elif revision is not None:
4739
if len(revision) == 1:
4740
revno, rev_id = revision[0].in_history(b)
4741
b.repository.start_write_group()
4743
b.repository.sign_revision(rev_id, gpg_strategy)
4745
b.repository.abort_write_group()
4748
b.repository.commit_write_group()
4749
elif len(revision) == 2:
4750
# are they both on rh- if so we can walk between them
4751
# might be nice to have a range helper for arbitrary
4752
# revision paths. hmm.
4753
from_revno, from_revid = revision[0].in_history(b)
4754
to_revno, to_revid = revision[1].in_history(b)
4755
if to_revid is None:
4756
to_revno = b.revno()
4757
if from_revno is None or to_revno is None:
4758
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4759
b.repository.start_write_group()
4761
for revno in range(from_revno, to_revno + 1):
4762
b.repository.sign_revision(b.get_rev_id(revno),
4765
b.repository.abort_write_group()
4768
b.repository.commit_write_group()
4770
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4773
class cmd_bind(Command):
4774
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4775
If no branch is supplied, rebind to the last bound location.
4777
Once converted into a checkout, commits must succeed on the master branch
4778
before they will be applied to the local branch.
4780
Bound branches use the nickname of its master branch unless it is set
4781
locally, in which case binding will update the local nickname to be
4785
_see_also = ['checkouts', 'unbind']
4786
takes_args = ['location?']
4787
takes_options = ['directory']
4789
def run(self, location=None, directory=u'.'):
4790
b, relpath = Branch.open_containing(directory)
4791
if location is None:
4793
location = b.get_old_bound_location()
4794
except errors.UpgradeRequired:
4795
raise errors.BzrCommandError('No location supplied. '
4796
'This format does not remember old locations.')
4798
if location is None:
4799
if b.get_bound_location() is not None:
4800
raise errors.BzrCommandError('Branch is already bound')
4802
raise errors.BzrCommandError('No location supplied '
4803
'and no previous location known')
4804
b_other = Branch.open(location)
4807
except errors.DivergedBranches:
4808
raise errors.BzrCommandError('These branches have diverged.'
4809
' Try merging, and then bind again.')
4810
if b.get_config().has_explicit_nickname():
4811
b.nick = b_other.nick
4814
class cmd_unbind(Command):
4815
__doc__ = """Convert the current checkout into a regular branch.
4817
After unbinding, the local branch is considered independent and subsequent
4818
commits will be local only.
4821
_see_also = ['checkouts', 'bind']
4823
takes_options = ['directory']
4825
def run(self, directory=u'.'):
4826
b, relpath = Branch.open_containing(directory)
4828
raise errors.BzrCommandError('Local branch is not bound')
4831
class cmd_uncommit(Command):
4832
__doc__ = """Remove the last committed revision.
4834
--verbose will print out what is being removed.
4835
--dry-run will go through all the motions, but not actually
4838
If --revision is specified, uncommit revisions to leave the branch at the
4839
specified revision. For example, "bzr uncommit -r 15" will leave the
4840
branch at revision 15.
4842
Uncommit leaves the working tree ready for a new commit. The only change
4843
it may make is to restore any pending merges that were present before
4847
# TODO: jam 20060108 Add an option to allow uncommit to remove
4848
# unreferenced information in 'branch-as-repository' branches.
4849
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4850
# information in shared branches as well.
4851
_see_also = ['commit']
4852
takes_options = ['verbose', 'revision',
4853
Option('dry-run', help='Don\'t actually make changes.'),
4854
Option('force', help='Say yes to all questions.'),
4856
help="Only remove the commits from the local branch"
4857
" when in a checkout."
4860
takes_args = ['location?']
4862
encoding_type = 'replace'
4864
def run(self, location=None,
4865
dry_run=False, verbose=False,
4866
revision=None, force=False, local=False):
4867
if location is None:
4869
control, relpath = bzrdir.BzrDir.open_containing(location)
4871
tree = control.open_workingtree()
4873
except (errors.NoWorkingTree, errors.NotLocalUrl):
4875
b = control.open_branch()
4877
if tree is not None:
4878
self.add_cleanup(tree.lock_write().unlock)
4880
self.add_cleanup(b.lock_write().unlock)
4881
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4883
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4884
from bzrlib.log import log_formatter, show_log
4885
from bzrlib.uncommit import uncommit
4887
last_revno, last_rev_id = b.last_revision_info()
4890
if revision is None:
4892
rev_id = last_rev_id
4894
# 'bzr uncommit -r 10' actually means uncommit
4895
# so that the final tree is at revno 10.
4896
# but bzrlib.uncommit.uncommit() actually uncommits
4897
# the revisions that are supplied.
4898
# So we need to offset it by one
4899
revno = revision[0].in_history(b).revno + 1
4900
if revno <= last_revno:
4901
rev_id = b.get_rev_id(revno)
4903
if rev_id is None or _mod_revision.is_null(rev_id):
4904
self.outf.write('No revisions to uncommit.\n')
4907
lf = log_formatter('short',
4909
show_timezone='original')
4914
direction='forward',
4915
start_revision=revno,
4916
end_revision=last_revno)
4919
self.outf.write('Dry-run, pretending to remove'
4920
' the above revisions.\n')
4922
self.outf.write('The above revision(s) will be removed.\n')
4925
if not ui.ui_factory.confirm_action(
4926
'Uncommit these revisions',
4927
'bzrlib.builtins.uncommit',
4929
self.outf.write('Canceled\n')
4932
mutter('Uncommitting from {%s} to {%s}',
4933
last_rev_id, rev_id)
4934
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4935
revno=revno, local=local)
4936
self.outf.write('You can restore the old tip by running:\n'
4937
' bzr pull . -r revid:%s\n' % last_rev_id)
4940
class cmd_break_lock(Command):
4941
__doc__ = """Break a dead lock.
4943
This command breaks a lock on a repository, branch, working directory or
4946
CAUTION: Locks should only be broken when you are sure that the process
4947
holding the lock has been stopped.
4949
You can get information on what locks are open via the 'bzr info
4950
[location]' command.
4954
bzr break-lock bzr+ssh://example.com/bzr/foo
4955
bzr break-lock --conf ~/.bazaar
4958
takes_args = ['location?']
4961
help='LOCATION is the directory where the config lock is.'),
4963
help='Do not ask for confirmation before breaking the lock.'),
4966
def run(self, location=None, config=False, force=False):
4967
if location is None:
4970
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
4972
{'bzrlib.lockdir.break': True})
4974
conf = _mod_config.LockableConfig(file_name=location)
4977
control, relpath = bzrdir.BzrDir.open_containing(location)
4979
control.break_lock()
4980
except NotImplementedError:
4984
class cmd_wait_until_signalled(Command):
4985
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4987
This just prints a line to signal when it is ready, then blocks on stdin.
4993
sys.stdout.write("running\n")
4995
sys.stdin.readline()
4998
class cmd_serve(Command):
4999
__doc__ = """Run the bzr server."""
5001
aliases = ['server']
5005
help='Serve on stdin/out for use from inetd or sshd.'),
5006
RegistryOption('protocol',
5007
help="Protocol to serve.",
5008
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5009
value_switches=True),
5011
help='Listen for connections on nominated port of the form '
5012
'[hostname:]portnumber. Passing 0 as the port number will '
5013
'result in a dynamically allocated port. The default port '
5014
'depends on the protocol.',
5016
custom_help('directory',
5017
help='Serve contents of this directory.'),
5018
Option('allow-writes',
5019
help='By default the server is a readonly server. Supplying '
5020
'--allow-writes enables write access to the contents of '
5021
'the served directory and below. Note that ``bzr serve`` '
5022
'does not perform authentication, so unless some form of '
5023
'external authentication is arranged supplying this '
5024
'option leads to global uncontrolled write access to your '
5029
def get_host_and_port(self, port):
5030
"""Return the host and port to run the smart server on.
5032
If 'port' is None, None will be returned for the host and port.
5034
If 'port' has a colon in it, the string before the colon will be
5035
interpreted as the host.
5037
:param port: A string of the port to run the server on.
5038
:return: A tuple of (host, port), where 'host' is a host name or IP,
5039
and port is an integer TCP/IP port.
5042
if port is not None:
5044
host, port = port.split(':')
5048
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5050
from bzrlib import transport
5051
if directory is None:
5052
directory = os.getcwd()
5053
if protocol is None:
5054
protocol = transport.transport_server_registry.get()
5055
host, port = self.get_host_and_port(port)
5056
url = urlutils.local_path_to_url(directory)
5057
if not allow_writes:
5058
url = 'readonly+' + url
5059
t = transport.get_transport(url)
5060
protocol(t, host, port, inet)
5063
class cmd_join(Command):
5064
__doc__ = """Combine a tree into its containing tree.
5066
This command requires the target tree to be in a rich-root format.
5068
The TREE argument should be an independent tree, inside another tree, but
5069
not part of it. (Such trees can be produced by "bzr split", but also by
5070
running "bzr branch" with the target inside a tree.)
5072
The result is a combined tree, with the subtree no longer an independent
5073
part. This is marked as a merge of the subtree into the containing tree,
5074
and all history is preserved.
5077
_see_also = ['split']
5078
takes_args = ['tree']
5080
Option('reference', help='Join by reference.', hidden=True),
5083
def run(self, tree, reference=False):
5084
sub_tree = WorkingTree.open(tree)
5085
parent_dir = osutils.dirname(sub_tree.basedir)
5086
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5087
repo = containing_tree.branch.repository
5088
if not repo.supports_rich_root():
5089
raise errors.BzrCommandError(
5090
"Can't join trees because %s doesn't support rich root data.\n"
5091
"You can use bzr upgrade on the repository."
5095
containing_tree.add_reference(sub_tree)
5096
except errors.BadReferenceTarget, e:
5097
# XXX: Would be better to just raise a nicely printable
5098
# exception from the real origin. Also below. mbp 20070306
5099
raise errors.BzrCommandError("Cannot join %s. %s" %
5103
containing_tree.subsume(sub_tree)
5104
except errors.BadSubsumeSource, e:
5105
raise errors.BzrCommandError("Cannot join %s. %s" %
5109
class cmd_split(Command):
5110
__doc__ = """Split a subdirectory of a tree into a separate tree.
5112
This command will produce a target tree in a format that supports
5113
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5114
converted into earlier formats like 'dirstate-tags'.
5116
The TREE argument should be a subdirectory of a working tree. That
5117
subdirectory will be converted into an independent tree, with its own
5118
branch. Commits in the top-level tree will not apply to the new subtree.
5121
_see_also = ['join']
5122
takes_args = ['tree']
5124
def run(self, tree):
5125
containing_tree, subdir = WorkingTree.open_containing(tree)
5126
sub_id = containing_tree.path2id(subdir)
5128
raise errors.NotVersionedError(subdir)
5130
containing_tree.extract(sub_id)
5131
except errors.RootNotRich:
5132
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5135
class cmd_merge_directive(Command):
5136
__doc__ = """Generate a merge directive for auto-merge tools.
5138
A directive requests a merge to be performed, and also provides all the
5139
information necessary to do so. This means it must either include a
5140
revision bundle, or the location of a branch containing the desired
5143
A submit branch (the location to merge into) must be supplied the first
5144
time the command is issued. After it has been supplied once, it will
5145
be remembered as the default.
5147
A public branch is optional if a revision bundle is supplied, but required
5148
if --diff or --plain is specified. It will be remembered as the default
5149
after the first use.
5152
takes_args = ['submit_branch?', 'public_branch?']
5156
_see_also = ['send']
5160
RegistryOption.from_kwargs('patch-type',
5161
'The type of patch to include in the directive.',
5163
value_switches=True,
5165
bundle='Bazaar revision bundle (default).',
5166
diff='Normal unified diff.',
5167
plain='No patch, just directive.'),
5168
Option('sign', help='GPG-sign the directive.'), 'revision',
5169
Option('mail-to', type=str,
5170
help='Instead of printing the directive, email to this address.'),
5171
Option('message', type=str, short_name='m',
5172
help='Message to use when committing this merge.')
5175
encoding_type = 'exact'
5177
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5178
sign=False, revision=None, mail_to=None, message=None,
5180
from bzrlib.revision import ensure_null, NULL_REVISION
5181
include_patch, include_bundle = {
5182
'plain': (False, False),
5183
'diff': (True, False),
5184
'bundle': (True, True),
5186
branch = Branch.open(directory)
5187
stored_submit_branch = branch.get_submit_branch()
5188
if submit_branch is None:
5189
submit_branch = stored_submit_branch
5191
if stored_submit_branch is None:
5192
branch.set_submit_branch(submit_branch)
5193
if submit_branch is None:
5194
submit_branch = branch.get_parent()
5195
if submit_branch is None:
5196
raise errors.BzrCommandError('No submit branch specified or known')
5198
stored_public_branch = branch.get_public_branch()
5199
if public_branch is None:
5200
public_branch = stored_public_branch
5201
elif stored_public_branch is None:
5202
branch.set_public_branch(public_branch)
5203
if not include_bundle and public_branch is None:
5204
raise errors.BzrCommandError('No public branch specified or'
5206
base_revision_id = None
5207
if revision is not None:
5208
if len(revision) > 2:
5209
raise errors.BzrCommandError('bzr merge-directive takes '
5210
'at most two one revision identifiers')
5211
revision_id = revision[-1].as_revision_id(branch)
5212
if len(revision) == 2:
5213
base_revision_id = revision[0].as_revision_id(branch)
5215
revision_id = branch.last_revision()
5216
revision_id = ensure_null(revision_id)
5217
if revision_id == NULL_REVISION:
5218
raise errors.BzrCommandError('No revisions to bundle.')
5219
directive = merge_directive.MergeDirective2.from_objects(
5220
branch.repository, revision_id, time.time(),
5221
osutils.local_time_offset(), submit_branch,
5222
public_branch=public_branch, include_patch=include_patch,
5223
include_bundle=include_bundle, message=message,
5224
base_revision_id=base_revision_id)
5227
self.outf.write(directive.to_signed(branch))
5229
self.outf.writelines(directive.to_lines())
5231
message = directive.to_email(mail_to, branch, sign)
5232
s = SMTPConnection(branch.get_config())
5233
s.send_email(message)
5236
class cmd_send(Command):
5237
__doc__ = """Mail or create a merge-directive for submitting changes.
5239
A merge directive provides many things needed for requesting merges:
5241
* A machine-readable description of the merge to perform
5243
* An optional patch that is a preview of the changes requested
5245
* An optional bundle of revision data, so that the changes can be applied
5246
directly from the merge directive, without retrieving data from a
5249
`bzr send` creates a compact data set that, when applied using bzr
5250
merge, has the same effect as merging from the source branch.
5252
By default the merge directive is self-contained and can be applied to any
5253
branch containing submit_branch in its ancestory without needing access to
5256
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5257
revisions, but only a structured request to merge from the
5258
public_location. In that case the public_branch is needed and it must be
5259
up-to-date and accessible to the recipient. The public_branch is always
5260
included if known, so that people can check it later.
5262
The submit branch defaults to the parent of the source branch, but can be
5263
overridden. Both submit branch and public branch will be remembered in
5264
branch.conf the first time they are used for a particular branch. The
5265
source branch defaults to that containing the working directory, but can
5266
be changed using --from.
5268
In order to calculate those changes, bzr must analyse the submit branch.
5269
Therefore it is most efficient for the submit branch to be a local mirror.
5270
If a public location is known for the submit_branch, that location is used
5271
in the merge directive.
5273
The default behaviour is to send the merge directive by mail, unless -o is
5274
given, in which case it is sent to a file.
5276
Mail is sent using your preferred mail program. This should be transparent
5277
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5278
If the preferred client can't be found (or used), your editor will be used.
5280
To use a specific mail program, set the mail_client configuration option.
5281
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5282
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5283
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5284
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5287
If mail is being sent, a to address is required. This can be supplied
5288
either on the commandline, by setting the submit_to configuration
5289
option in the branch itself or the child_submit_to configuration option
5290
in the submit branch.
5292
Two formats are currently supported: "4" uses revision bundle format 4 and
5293
merge directive format 2. It is significantly faster and smaller than
5294
older formats. It is compatible with Bazaar 0.19 and later. It is the
5295
default. "0.9" uses revision bundle format 0.9 and merge directive
5296
format 1. It is compatible with Bazaar 0.12 - 0.18.
5298
The merge directives created by bzr send may be applied using bzr merge or
5299
bzr pull by specifying a file containing a merge directive as the location.
5301
bzr send makes extensive use of public locations to map local locations into
5302
URLs that can be used by other people. See `bzr help configuration` to
5303
set them, and use `bzr info` to display them.
5306
encoding_type = 'exact'
5308
_see_also = ['merge', 'pull']
5310
takes_args = ['submit_branch?', 'public_branch?']
5314
help='Do not include a bundle in the merge directive.'),
5315
Option('no-patch', help='Do not include a preview patch in the merge'
5318
help='Remember submit and public branch.'),
5320
help='Branch to generate the submission from, '
5321
'rather than the one containing the working directory.',
5324
Option('output', short_name='o',
5325
help='Write merge directive to this file or directory; '
5326
'use - for stdout.',
5329
help='Refuse to send if there are uncommitted changes in'
5330
' the working tree, --no-strict disables the check.'),
5331
Option('mail-to', help='Mail the request to this address.',
5335
Option('body', help='Body for the email.', type=unicode),
5336
RegistryOption('format',
5337
help='Use the specified output format.',
5338
lazy_registry=('bzrlib.send', 'format_registry')),
5341
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5342
no_patch=False, revision=None, remember=False, output=None,
5343
format=None, mail_to=None, message=None, body=None,
5344
strict=None, **kwargs):
5345
from bzrlib.send import send
5346
return send(submit_branch, revision, public_branch, remember,
5347
format, no_bundle, no_patch, output,
5348
kwargs.get('from', '.'), mail_to, message, body,
5353
class cmd_bundle_revisions(cmd_send):
5354
__doc__ = """Create a merge-directive for submitting changes.
5356
A merge directive provides many things needed for requesting merges:
5358
* A machine-readable description of the merge to perform
5360
* An optional patch that is a preview of the changes requested
5362
* An optional bundle of revision data, so that the changes can be applied
5363
directly from the merge directive, without retrieving data from a
5366
If --no-bundle is specified, then public_branch is needed (and must be
5367
up-to-date), so that the receiver can perform the merge using the
5368
public_branch. The public_branch is always included if known, so that
5369
people can check it later.
5371
The submit branch defaults to the parent, but can be overridden. Both
5372
submit branch and public branch will be remembered if supplied.
5374
If a public_branch is known for the submit_branch, that public submit
5375
branch is used in the merge instructions. This means that a local mirror
5376
can be used as your actual submit branch, once you have set public_branch
5379
Two formats are currently supported: "4" uses revision bundle format 4 and
5380
merge directive format 2. It is significantly faster and smaller than
5381
older formats. It is compatible with Bazaar 0.19 and later. It is the
5382
default. "0.9" uses revision bundle format 0.9 and merge directive
5383
format 1. It is compatible with Bazaar 0.12 - 0.18.
5388
help='Do not include a bundle in the merge directive.'),
5389
Option('no-patch', help='Do not include a preview patch in the merge'
5392
help='Remember submit and public branch.'),
5394
help='Branch to generate the submission from, '
5395
'rather than the one containing the working directory.',
5398
Option('output', short_name='o', help='Write directive to this file.',
5401
help='Refuse to bundle revisions if there are uncommitted'
5402
' changes in the working tree, --no-strict disables the check.'),
5404
RegistryOption('format',
5405
help='Use the specified output format.',
5406
lazy_registry=('bzrlib.send', 'format_registry')),
5408
aliases = ['bundle']
5410
_see_also = ['send', 'merge']
5414
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5415
no_patch=False, revision=None, remember=False, output=None,
5416
format=None, strict=None, **kwargs):
5419
from bzrlib.send import send
5420
return send(submit_branch, revision, public_branch, remember,
5421
format, no_bundle, no_patch, output,
5422
kwargs.get('from', '.'), None, None, None,
5423
self.outf, strict=strict)
5426
class cmd_tag(Command):
5427
__doc__ = """Create, remove or modify a tag naming a revision.
5429
Tags give human-meaningful names to revisions. Commands that take a -r
5430
(--revision) option can be given -rtag:X, where X is any previously
5433
Tags are stored in the branch. Tags are copied from one branch to another
5434
along when you branch, push, pull or merge.
5436
It is an error to give a tag name that already exists unless you pass
5437
--force, in which case the tag is moved to point to the new revision.
5439
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5440
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5442
If no tag name is specified it will be determined through the
5443
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5444
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5448
_see_also = ['commit', 'tags']
5449
takes_args = ['tag_name?']
5452
help='Delete this tag rather than placing it.',
5454
custom_help('directory',
5455
help='Branch in which to place the tag.'),
5457
help='Replace existing tags.',
5462
def run(self, tag_name=None,
5468
branch, relpath = Branch.open_containing(directory)
5469
self.add_cleanup(branch.lock_write().unlock)
5471
if tag_name is None:
5472
raise errors.BzrCommandError("No tag specified to delete.")
5473
branch.tags.delete_tag(tag_name)
5474
note('Deleted tag %s.' % tag_name)
5477
if len(revision) != 1:
5478
raise errors.BzrCommandError(
5479
"Tags can only be placed on a single revision, "
5481
revision_id = revision[0].as_revision_id(branch)
5483
revision_id = branch.last_revision()
5484
if tag_name is None:
5485
tag_name = branch.automatic_tag_name(revision_id)
5486
if tag_name is None:
5487
raise errors.BzrCommandError(
5488
"Please specify a tag name.")
5489
if (not force) and branch.tags.has_tag(tag_name):
5490
raise errors.TagAlreadyExists(tag_name)
5491
branch.tags.set_tag(tag_name, revision_id)
5492
note('Created tag %s.' % tag_name)
5495
class cmd_tags(Command):
5496
__doc__ = """List tags.
5498
This command shows a table of tag names and the revisions they reference.
5503
custom_help('directory',
5504
help='Branch whose tags should be displayed.'),
5505
RegistryOption('sort',
5506
'Sort tags by different criteria.', title='Sorting',
5507
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5514
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5515
from bzrlib.tag import tag_sort_methods
5516
branch, relpath = Branch.open_containing(directory)
5518
tags = branch.tags.get_tag_dict().items()
5522
self.add_cleanup(branch.lock_read().unlock)
5524
graph = branch.repository.get_graph()
5525
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5526
revid1, revid2 = rev1.rev_id, rev2.rev_id
5527
# only show revisions between revid1 and revid2 (inclusive)
5528
tags = [(tag, revid) for tag, revid in tags if
5529
graph.is_between(revid, revid1, revid2)]
5531
sort = tag_sort_methods.get()
5534
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5535
for index, (tag, revid) in enumerate(tags):
5537
revno = branch.revision_id_to_dotted_revno(revid)
5538
if isinstance(revno, tuple):
5539
revno = '.'.join(map(str, revno))
5540
except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
5541
# Bad tag data/merges can lead to tagged revisions
5542
# which are not in this branch. Fail gracefully ...
5544
tags[index] = (tag, revno)
5546
for tag, revspec in tags:
5547
self.outf.write('%-20s %s\n' % (tag, revspec))
5550
class cmd_reconfigure(Command):
5551
__doc__ = """Reconfigure the type of a bzr directory.
5553
A target configuration must be specified.
5555
For checkouts, the bind-to location will be auto-detected if not specified.
5556
The order of preference is
5557
1. For a lightweight checkout, the current bound location.
5558
2. For branches that used to be checkouts, the previously-bound location.
5559
3. The push location.
5560
4. The parent location.
5561
If none of these is available, --bind-to must be specified.
5564
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5565
takes_args = ['location?']
5567
RegistryOption.from_kwargs(
5569
title='Target type',
5570
help='The type to reconfigure the directory to.',
5571
value_switches=True, enum_switch=False,
5572
branch='Reconfigure to be an unbound branch with no working tree.',
5573
tree='Reconfigure to be an unbound branch with a working tree.',
5574
checkout='Reconfigure to be a bound branch with a working tree.',
5575
lightweight_checkout='Reconfigure to be a lightweight'
5576
' checkout (with no local history).',
5577
standalone='Reconfigure to be a standalone branch '
5578
'(i.e. stop using shared repository).',
5579
use_shared='Reconfigure to use a shared repository.',
5580
with_trees='Reconfigure repository to create '
5581
'working trees on branches by default.',
5582
with_no_trees='Reconfigure repository to not create '
5583
'working trees on branches by default.'
5585
Option('bind-to', help='Branch to bind checkout to.', type=str),
5587
help='Perform reconfiguration even if local changes'
5589
Option('stacked-on',
5590
help='Reconfigure a branch to be stacked on another branch.',
5594
help='Reconfigure a branch to be unstacked. This '
5595
'may require copying substantial data into it.',
5599
def run(self, location=None, target_type=None, bind_to=None, force=False,
5602
directory = bzrdir.BzrDir.open(location)
5603
if stacked_on and unstacked:
5604
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5605
elif stacked_on is not None:
5606
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5608
reconfigure.ReconfigureUnstacked().apply(directory)
5609
# At the moment you can use --stacked-on and a different
5610
# reconfiguration shape at the same time; there seems no good reason
5612
if target_type is None:
5613
if stacked_on or unstacked:
5616
raise errors.BzrCommandError('No target configuration '
5618
elif target_type == 'branch':
5619
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5620
elif target_type == 'tree':
5621
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5622
elif target_type == 'checkout':
5623
reconfiguration = reconfigure.Reconfigure.to_checkout(
5625
elif target_type == 'lightweight-checkout':
5626
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5628
elif target_type == 'use-shared':
5629
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5630
elif target_type == 'standalone':
5631
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5632
elif target_type == 'with-trees':
5633
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5635
elif target_type == 'with-no-trees':
5636
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5638
reconfiguration.apply(force)
5641
class cmd_switch(Command):
5642
__doc__ = """Set the branch of a checkout and update.
5644
For lightweight checkouts, this changes the branch being referenced.
5645
For heavyweight checkouts, this checks that there are no local commits
5646
versus the current bound branch, then it makes the local branch a mirror
5647
of the new location and binds to it.
5649
In both cases, the working tree is updated and uncommitted changes
5650
are merged. The user can commit or revert these as they desire.
5652
Pending merges need to be committed or reverted before using switch.
5654
The path to the branch to switch to can be specified relative to the parent
5655
directory of the current branch. For example, if you are currently in a
5656
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5659
Bound branches use the nickname of its master branch unless it is set
5660
locally, in which case switching will update the local nickname to be
5664
takes_args = ['to_location?']
5665
takes_options = ['directory',
5667
help='Switch even if local commits will be lost.'),
5669
Option('create-branch', short_name='b',
5670
help='Create the target branch from this one before'
5671
' switching to it.'),
5674
def run(self, to_location=None, force=False, create_branch=False,
5675
revision=None, directory=u'.'):
5676
from bzrlib import switch
5677
tree_location = directory
5678
revision = _get_one_revision('switch', revision)
5679
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5680
if to_location is None:
5681
if revision is None:
5682
raise errors.BzrCommandError('You must supply either a'
5683
' revision or a location')
5684
to_location = tree_location
5686
branch = control_dir.open_branch()
5687
had_explicit_nick = branch.get_config().has_explicit_nickname()
5688
except errors.NotBranchError:
5690
had_explicit_nick = False
5693
raise errors.BzrCommandError('cannot create branch without'
5695
to_location = directory_service.directories.dereference(
5697
if '/' not in to_location and '\\' not in to_location:
5698
# This path is meant to be relative to the existing branch
5699
this_url = self._get_branch_location(control_dir)
5700
to_location = urlutils.join(this_url, '..', to_location)
5701
to_branch = branch.bzrdir.sprout(to_location,
5702
possible_transports=[branch.bzrdir.root_transport],
5703
source_branch=branch).open_branch()
5706
to_branch = Branch.open(to_location)
5707
except errors.NotBranchError:
5708
this_url = self._get_branch_location(control_dir)
5709
to_branch = Branch.open(
5710
urlutils.join(this_url, '..', to_location))
5711
if revision is not None:
5712
revision = revision.as_revision_id(to_branch)
5713
switch.switch(control_dir, to_branch, force, revision_id=revision)
5714
if had_explicit_nick:
5715
branch = control_dir.open_branch() #get the new branch!
5716
branch.nick = to_branch.nick
5717
note('Switched to branch: %s',
5718
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5720
def _get_branch_location(self, control_dir):
5721
"""Return location of branch for this control dir."""
5723
this_branch = control_dir.open_branch()
5724
# This may be a heavy checkout, where we want the master branch
5725
master_location = this_branch.get_bound_location()
5726
if master_location is not None:
5727
return master_location
5728
# If not, use a local sibling
5729
return this_branch.base
5730
except errors.NotBranchError:
5731
format = control_dir.find_branch_format()
5732
if getattr(format, 'get_reference', None) is not None:
5733
return format.get_reference(control_dir)
5735
return control_dir.root_transport.base
5738
class cmd_view(Command):
5739
__doc__ = """Manage filtered views.
5741
Views provide a mask over the tree so that users can focus on
5742
a subset of a tree when doing their work. After creating a view,
5743
commands that support a list of files - status, diff, commit, etc -
5744
effectively have that list of files implicitly given each time.
5745
An explicit list of files can still be given but those files
5746
must be within the current view.
5748
In most cases, a view has a short life-span: it is created to make
5749
a selected change and is deleted once that change is committed.
5750
At other times, you may wish to create one or more named views
5751
and switch between them.
5753
To disable the current view without deleting it, you can switch to
5754
the pseudo view called ``off``. This can be useful when you need
5755
to see the whole tree for an operation or two (e.g. merge) but
5756
want to switch back to your view after that.
5759
To define the current view::
5761
bzr view file1 dir1 ...
5763
To list the current view::
5767
To delete the current view::
5771
To disable the current view without deleting it::
5773
bzr view --switch off
5775
To define a named view and switch to it::
5777
bzr view --name view-name file1 dir1 ...
5779
To list a named view::
5781
bzr view --name view-name
5783
To delete a named view::
5785
bzr view --name view-name --delete
5787
To switch to a named view::
5789
bzr view --switch view-name
5791
To list all views defined::
5795
To delete all views::
5797
bzr view --delete --all
5801
takes_args = ['file*']
5804
help='Apply list or delete action to all views.',
5807
help='Delete the view.',
5810
help='Name of the view to define, list or delete.',
5814
help='Name of the view to switch to.',
5819
def run(self, file_list,
5825
tree, file_list = WorkingTree.open_containing_paths(file_list,
5827
current_view, view_dict = tree.views.get_view_info()
5832
raise errors.BzrCommandError(
5833
"Both --delete and a file list specified")
5835
raise errors.BzrCommandError(
5836
"Both --delete and --switch specified")
5838
tree.views.set_view_info(None, {})
5839
self.outf.write("Deleted all views.\n")
5841
raise errors.BzrCommandError("No current view to delete")
5843
tree.views.delete_view(name)
5844
self.outf.write("Deleted '%s' view.\n" % name)
5847
raise errors.BzrCommandError(
5848
"Both --switch and a file list specified")
5850
raise errors.BzrCommandError(
5851
"Both --switch and --all specified")
5852
elif switch == 'off':
5853
if current_view is None:
5854
raise errors.BzrCommandError("No current view to disable")
5855
tree.views.set_view_info(None, view_dict)
5856
self.outf.write("Disabled '%s' view.\n" % (current_view))
5858
tree.views.set_view_info(switch, view_dict)
5859
view_str = views.view_display_str(tree.views.lookup_view())
5860
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5863
self.outf.write('Views defined:\n')
5864
for view in sorted(view_dict):
5865
if view == current_view:
5869
view_str = views.view_display_str(view_dict[view])
5870
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5872
self.outf.write('No views defined.\n')
5875
# No name given and no current view set
5878
raise errors.BzrCommandError(
5879
"Cannot change the 'off' pseudo view")
5880
tree.views.set_view(name, sorted(file_list))
5881
view_str = views.view_display_str(tree.views.lookup_view())
5882
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5886
# No name given and no current view set
5887
self.outf.write('No current view.\n')
5889
view_str = views.view_display_str(tree.views.lookup_view(name))
5890
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5893
class cmd_hooks(Command):
5894
__doc__ = """Show hooks."""
5899
for hook_key in sorted(hooks.known_hooks.keys()):
5900
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5901
self.outf.write("%s:\n" % type(some_hooks).__name__)
5902
for hook_name, hook_point in sorted(some_hooks.items()):
5903
self.outf.write(" %s:\n" % (hook_name,))
5904
found_hooks = list(hook_point)
5906
for hook in found_hooks:
5907
self.outf.write(" %s\n" %
5908
(some_hooks.get_hook_name(hook),))
5910
self.outf.write(" <no hooks installed>\n")
5913
class cmd_remove_branch(Command):
5914
__doc__ = """Remove a branch.
5916
This will remove the branch from the specified location but
5917
will keep any working tree or repository in place.
5921
Remove the branch at repo/trunk::
5923
bzr remove-branch repo/trunk
5927
takes_args = ["location?"]
5929
aliases = ["rmbranch"]
5931
def run(self, location=None):
5932
if location is None:
5934
branch = Branch.open_containing(location)[0]
5935
branch.bzrdir.destroy_branch()
5938
class cmd_shelve(Command):
5939
__doc__ = """Temporarily set aside some changes from the current tree.
5941
Shelve allows you to temporarily put changes you've made "on the shelf",
5942
ie. out of the way, until a later time when you can bring them back from
5943
the shelf with the 'unshelve' command. The changes are stored alongside
5944
your working tree, and so they aren't propagated along with your branch nor
5945
will they survive its deletion.
5947
If shelve --list is specified, previously-shelved changes are listed.
5949
Shelve is intended to help separate several sets of changes that have
5950
been inappropriately mingled. If you just want to get rid of all changes
5951
and you don't need to restore them later, use revert. If you want to
5952
shelve all text changes at once, use shelve --all.
5954
If filenames are specified, only the changes to those files will be
5955
shelved. Other files will be left untouched.
5957
If a revision is specified, changes since that revision will be shelved.
5959
You can put multiple items on the shelf, and by default, 'unshelve' will
5960
restore the most recently shelved changes.
5962
For complicated changes, it is possible to edit the changes in a separate
5963
editor program to decide what the file remaining in the working copy
5964
should look like. To do this, add the configuration option
5966
change_editor = PROGRAM @new_path @old_path
5968
where @new_path is replaced with the path of the new version of the
5969
file and @old_path is replaced with the path of the old version of
5970
the file. The PROGRAM should save the new file with the desired
5971
contents of the file in the working tree.
5975
takes_args = ['file*']
5980
Option('all', help='Shelve all changes.'),
5982
RegistryOption('writer', 'Method to use for writing diffs.',
5983
bzrlib.option.diff_writer_registry,
5984
value_switches=True, enum_switch=False),
5986
Option('list', help='List shelved changes.'),
5988
help='Destroy removed changes instead of shelving them.'),
5990
_see_also = ['unshelve', 'configuration']
5992
def run(self, revision=None, all=False, file_list=None, message=None,
5993
writer=None, list=False, destroy=False, directory=None):
5995
return self.run_for_list(directory=directory)
5996
from bzrlib.shelf_ui import Shelver
5998
writer = bzrlib.option.diff_writer_registry.get()
6000
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6001
file_list, message, destroy=destroy, directory=directory)
6006
except errors.UserAbort:
6009
def run_for_list(self, directory=None):
6010
if directory is None:
6012
tree = WorkingTree.open_containing(directory)[0]
6013
self.add_cleanup(tree.lock_read().unlock)
6014
manager = tree.get_shelf_manager()
6015
shelves = manager.active_shelves()
6016
if len(shelves) == 0:
6017
note('No shelved changes.')
6019
for shelf_id in reversed(shelves):
6020
message = manager.get_metadata(shelf_id).get('message')
6022
message = '<no message>'
6023
self.outf.write('%3d: %s\n' % (shelf_id, message))
6027
class cmd_unshelve(Command):
6028
__doc__ = """Restore shelved changes.
6030
By default, the most recently shelved changes are restored. However if you
6031
specify a shelf by id those changes will be restored instead. This works
6032
best when the changes don't depend on each other.
6035
takes_args = ['shelf_id?']
6038
RegistryOption.from_kwargs(
6039
'action', help="The action to perform.",
6040
enum_switch=False, value_switches=True,
6041
apply="Apply changes and remove from the shelf.",
6042
dry_run="Show changes, but do not apply or remove them.",
6043
preview="Instead of unshelving the changes, show the diff that "
6044
"would result from unshelving.",
6045
delete_only="Delete changes without applying them.",
6046
keep="Apply changes but don't delete them.",
6049
_see_also = ['shelve']
6051
def run(self, shelf_id=None, action='apply', directory=u'.'):
6052
from bzrlib.shelf_ui import Unshelver
6053
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6057
unshelver.tree.unlock()
6060
class cmd_clean_tree(Command):
6061
__doc__ = """Remove unwanted files from working tree.
6063
By default, only unknown files, not ignored files, are deleted. Versioned
6064
files are never deleted.
6066
Another class is 'detritus', which includes files emitted by bzr during
6067
normal operations and selftests. (The value of these files decreases with
6070
If no options are specified, unknown files are deleted. Otherwise, option
6071
flags are respected, and may be combined.
6073
To check what clean-tree will do, use --dry-run.
6075
takes_options = ['directory',
6076
Option('ignored', help='Delete all ignored files.'),
6077
Option('detritus', help='Delete conflict files, merge and revert'
6078
' backups, and failed selftest dirs.'),
6080
help='Delete files unknown to bzr (default).'),
6081
Option('dry-run', help='Show files to delete instead of'
6083
Option('force', help='Do not prompt before deleting.')]
6084
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6085
force=False, directory=u'.'):
6086
from bzrlib.clean_tree import clean_tree
6087
if not (unknown or ignored or detritus):
6091
clean_tree(directory, unknown=unknown, ignored=ignored,
6092
detritus=detritus, dry_run=dry_run, no_prompt=force)
6095
class cmd_reference(Command):
6096
__doc__ = """list, view and set branch locations for nested trees.
6098
If no arguments are provided, lists the branch locations for nested trees.
6099
If one argument is provided, display the branch location for that tree.
6100
If two arguments are provided, set the branch location for that tree.
6105
takes_args = ['path?', 'location?']
6107
def run(self, path=None, location=None):
6109
if path is not None:
6111
tree, branch, relpath =(
6112
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
6113
if path is not None:
6116
tree = branch.basis_tree()
6118
info = branch._get_all_reference_info().iteritems()
6119
self._display_reference_info(tree, branch, info)
6121
file_id = tree.path2id(path)
6123
raise errors.NotVersionedError(path)
6124
if location is None:
6125
info = [(file_id, branch.get_reference_info(file_id))]
6126
self._display_reference_info(tree, branch, info)
6128
branch.set_reference_info(file_id, path, location)
6130
def _display_reference_info(self, tree, branch, info):
6132
for file_id, (path, location) in info:
6134
path = tree.id2path(file_id)
6135
except errors.NoSuchId:
6137
ref_list.append((path, location))
6138
for path, location in sorted(ref_list):
6139
self.outf.write('%s %s\n' % (path, location))
6142
def _register_lazy_builtins():
6143
# register lazy builtins from other modules; called at startup and should
6144
# be only called once.
6145
for (name, aliases, module_name) in [
6146
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6147
('cmd_config', [], 'bzrlib.config'),
6148
('cmd_dpush', [], 'bzrlib.foreign'),
6149
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6150
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6151
('cmd_conflicts', [], 'bzrlib.conflicts'),
6152
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6153
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6155
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
