1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
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
If a revision argument is given, the status is calculated against
254
that revision, or between two revisions if two are provided.
257
# TODO: --no-recurse, --recurse options
259
takes_args = ['file*']
260
takes_options = ['show-ids', 'revision', 'change', 'verbose',
261
Option('short', help='Use short status indicators.',
263
Option('versioned', help='Only show versioned files.',
265
Option('no-pending', help='Don\'t show pending merges.',
268
aliases = ['st', 'stat']
270
encoding_type = 'replace'
271
_see_also = ['diff', 'revert', 'status-flags']
274
def run(self, show_ids=False, file_list=None, revision=None, short=False,
275
versioned=False, no_pending=False, verbose=False):
276
from bzrlib.status import show_tree_status
278
if revision and len(revision) > 2:
279
raise errors.BzrCommandError('bzr status --revision takes exactly'
280
' one or two revision specifiers')
282
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
283
# Avoid asking for specific files when that is not needed.
284
if relfile_list == ['']:
286
# Don't disable pending merges for full trees other than '.'.
287
if file_list == ['.']:
289
# A specific path within a tree was given.
290
elif relfile_list is not None:
292
show_tree_status(tree, show_ids=show_ids,
293
specific_files=relfile_list, revision=revision,
294
to_file=self.outf, short=short, versioned=versioned,
295
show_pending=(not no_pending), verbose=verbose)
298
class cmd_cat_revision(Command):
299
__doc__ = """Write out metadata for a revision.
301
The revision to print can either be specified by a specific
302
revision identifier, or you can use --revision.
306
takes_args = ['revision_id?']
307
takes_options = ['directory', 'revision']
308
# cat-revision is more for frontends so should be exact
311
def print_revision(self, revisions, revid):
312
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
313
record = stream.next()
314
if record.storage_kind == 'absent':
315
raise errors.NoSuchRevision(revisions, revid)
316
revtext = record.get_bytes_as('fulltext')
317
self.outf.write(revtext.decode('utf-8'))
320
def run(self, revision_id=None, revision=None, directory=u'.'):
321
if revision_id is not None and revision is not None:
322
raise errors.BzrCommandError('You can only supply one of'
323
' revision_id or --revision')
324
if revision_id is None and revision is None:
325
raise errors.BzrCommandError('You must supply either'
326
' --revision or a revision_id')
327
b = WorkingTree.open_containing(directory)[0].branch
329
revisions = b.repository.revisions
330
if revisions is None:
331
raise errors.BzrCommandError('Repository %r does not support '
332
'access to raw revision texts')
334
b.repository.lock_read()
336
# TODO: jam 20060112 should cat-revision always output utf-8?
337
if revision_id is not None:
338
revision_id = osutils.safe_revision_id(revision_id, warn=False)
340
self.print_revision(revisions, revision_id)
341
except errors.NoSuchRevision:
342
msg = "The repository %s contains no revision %s." % (
343
b.repository.base, revision_id)
344
raise errors.BzrCommandError(msg)
345
elif revision is not None:
348
raise errors.BzrCommandError(
349
'You cannot specify a NULL revision.')
350
rev_id = rev.as_revision_id(b)
351
self.print_revision(revisions, rev_id)
353
b.repository.unlock()
356
class cmd_dump_btree(Command):
357
__doc__ = """Dump the contents of a btree index file to stdout.
359
PATH is a btree index file, it can be any URL. This includes things like
360
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
362
By default, the tuples stored in the index file will be displayed. With
363
--raw, we will uncompress the pages, but otherwise display the raw bytes
367
# TODO: Do we want to dump the internal nodes as well?
368
# TODO: It would be nice to be able to dump the un-parsed information,
369
# rather than only going through iter_all_entries. However, this is
370
# good enough for a start
372
encoding_type = 'exact'
373
takes_args = ['path']
374
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
375
' rather than the parsed tuples.'),
378
def run(self, path, raw=False):
379
dirname, basename = osutils.split(path)
380
t = transport.get_transport(dirname)
382
self._dump_raw_bytes(t, basename)
384
self._dump_entries(t, basename)
386
def _get_index_and_bytes(self, trans, basename):
387
"""Create a BTreeGraphIndex and raw bytes."""
388
bt = btree_index.BTreeGraphIndex(trans, basename, None)
389
bytes = trans.get_bytes(basename)
390
bt._file = cStringIO.StringIO(bytes)
391
bt._size = len(bytes)
394
def _dump_raw_bytes(self, trans, basename):
397
# We need to parse at least the root node.
398
# This is because the first page of every row starts with an
399
# uncompressed header.
400
bt, bytes = self._get_index_and_bytes(trans, basename)
401
for page_idx, page_start in enumerate(xrange(0, len(bytes),
402
btree_index._PAGE_SIZE)):
403
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
404
page_bytes = bytes[page_start:page_end]
406
self.outf.write('Root node:\n')
407
header_end, data = bt._parse_header_from_bytes(page_bytes)
408
self.outf.write(page_bytes[:header_end])
410
self.outf.write('\nPage %d\n' % (page_idx,))
411
decomp_bytes = zlib.decompress(page_bytes)
412
self.outf.write(decomp_bytes)
413
self.outf.write('\n')
415
def _dump_entries(self, trans, basename):
417
st = trans.stat(basename)
418
except errors.TransportNotPossible:
419
# We can't stat, so we'll fake it because we have to do the 'get()'
421
bt, _ = self._get_index_and_bytes(trans, basename)
423
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
424
for node in bt.iter_all_entries():
425
# Node is made up of:
426
# (index, key, value, [references])
430
refs_as_tuples = None
432
refs_as_tuples = static_tuple.as_tuples(refs)
433
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
434
self.outf.write('%s\n' % (as_tuple,))
437
class cmd_remove_tree(Command):
438
__doc__ = """Remove the working tree from a given branch/checkout.
440
Since a lightweight checkout is little more than a working tree
441
this will refuse to run against one.
443
To re-create the working tree, use "bzr checkout".
445
_see_also = ['checkout', 'working-trees']
446
takes_args = ['location*']
449
help='Remove the working tree even if it has '
450
'uncommitted or shelved changes.'),
453
def run(self, location_list, force=False):
454
if not location_list:
457
for location in location_list:
458
d = bzrdir.BzrDir.open(location)
461
working = d.open_workingtree()
462
except errors.NoWorkingTree:
463
raise errors.BzrCommandError("No working tree to remove")
464
except errors.NotLocalUrl:
465
raise errors.BzrCommandError("You cannot remove the working tree"
468
if (working.has_changes()):
469
raise errors.UncommittedChanges(working)
470
if working.get_shelf_manager().last_shelf() is not None:
471
raise errors.ShelvedChanges(working)
473
if working.user_url != working.branch.user_url:
474
raise errors.BzrCommandError("You cannot remove the working tree"
475
" from a lightweight checkout")
477
d.destroy_workingtree()
480
class cmd_revno(Command):
481
__doc__ = """Show current revision number.
483
This is equal to the number of revisions on this branch.
487
takes_args = ['location?']
489
Option('tree', help='Show revno of working tree'),
493
def run(self, tree=False, location=u'.'):
496
wt = WorkingTree.open_containing(location)[0]
497
self.add_cleanup(wt.lock_read().unlock)
498
except (errors.NoWorkingTree, errors.NotLocalUrl):
499
raise errors.NoWorkingTree(location)
500
revid = wt.last_revision()
502
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
503
except errors.NoSuchRevision:
505
revno = ".".join(str(n) for n in revno_t)
507
b = Branch.open_containing(location)[0]
508
self.add_cleanup(b.lock_read().unlock)
511
self.outf.write(str(revno) + '\n')
514
class cmd_revision_info(Command):
515
__doc__ = """Show revision number and revision id for a given revision identifier.
518
takes_args = ['revision_info*']
521
custom_help('directory',
522
help='Branch to examine, '
523
'rather than the one containing the working directory.'),
524
Option('tree', help='Show revno of working tree'),
528
def run(self, revision=None, directory=u'.', tree=False,
529
revision_info_list=[]):
532
wt = WorkingTree.open_containing(directory)[0]
534
self.add_cleanup(wt.lock_read().unlock)
535
except (errors.NoWorkingTree, errors.NotLocalUrl):
537
b = Branch.open_containing(directory)[0]
538
self.add_cleanup(b.lock_read().unlock)
540
if revision is not None:
541
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
542
if revision_info_list is not None:
543
for rev_str in revision_info_list:
544
rev_spec = RevisionSpec.from_string(rev_str)
545
revision_ids.append(rev_spec.as_revision_id(b))
546
# No arguments supplied, default to the last revision
547
if len(revision_ids) == 0:
550
raise errors.NoWorkingTree(directory)
551
revision_ids.append(wt.last_revision())
553
revision_ids.append(b.last_revision())
557
for revision_id in revision_ids:
559
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
560
revno = '.'.join(str(i) for i in dotted_revno)
561
except errors.NoSuchRevision:
563
maxlen = max(maxlen, len(revno))
564
revinfos.append([revno, revision_id])
568
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
571
class cmd_add(Command):
572
__doc__ = """Add specified files or directories.
574
In non-recursive mode, all the named items are added, regardless
575
of whether they were previously ignored. A warning is given if
576
any of the named files are already versioned.
578
In recursive mode (the default), files are treated the same way
579
but the behaviour for directories is different. Directories that
580
are already versioned do not give a warning. All directories,
581
whether already versioned or not, are searched for files or
582
subdirectories that are neither versioned or ignored, and these
583
are added. This search proceeds recursively into versioned
584
directories. If no names are given '.' is assumed.
586
Therefore simply saying 'bzr add' will version all files that
587
are currently unknown.
589
Adding a file whose parent directory is not versioned will
590
implicitly add the parent, and so on up to the root. This means
591
you should never need to explicitly add a directory, they'll just
592
get added when you add a file in the directory.
594
--dry-run will show which files would be added, but not actually
597
--file-ids-from will try to use the file ids from the supplied path.
598
It looks up ids trying to find a matching parent directory with the
599
same filename, and then by pure path. This option is rarely needed
600
but can be useful when adding the same logical file into two
601
branches that will be merged later (without showing the two different
602
adds as a conflict). It is also useful when merging another project
603
into a subdirectory of this one.
605
Any files matching patterns in the ignore list will not be added
606
unless they are explicitly mentioned.
608
takes_args = ['file*']
611
help="Don't recursively add the contents of directories."),
613
help="Show what would be done, but don't actually do anything."),
615
Option('file-ids-from',
617
help='Lookup file ids from this tree.'),
619
encoding_type = 'replace'
620
_see_also = ['remove', 'ignore']
622
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
627
if file_ids_from is not None:
629
base_tree, base_path = WorkingTree.open_containing(
631
except errors.NoWorkingTree:
632
base_branch, base_path = Branch.open_containing(
634
base_tree = base_branch.basis_tree()
636
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
637
to_file=self.outf, should_print=(not is_quiet()))
639
action = bzrlib.add.AddAction(to_file=self.outf,
640
should_print=(not is_quiet()))
643
self.add_cleanup(base_tree.lock_read().unlock)
644
tree, file_list = tree_files_for_add(file_list)
645
added, ignored = tree.smart_add(file_list, not
646
no_recurse, action=action, save=not dry_run)
650
for glob in sorted(ignored.keys()):
651
for path in ignored[glob]:
652
self.outf.write("ignored %s matching \"%s\"\n"
656
class cmd_mkdir(Command):
657
__doc__ = """Create a new versioned directory.
659
This is equivalent to creating the directory and then adding it.
662
takes_args = ['dir+']
663
encoding_type = 'replace'
665
def run(self, dir_list):
667
wt, dd = WorkingTree.open_containing(d)
668
base = os.path.dirname(dd)
669
id = wt.path2id(base)
673
self.outf.write('added %s\n' % d)
675
raise errors.NotVersionedError(path=base)
678
class cmd_relpath(Command):
679
__doc__ = """Show path of a file relative to root"""
681
takes_args = ['filename']
685
def run(self, filename):
686
# TODO: jam 20050106 Can relpath return a munged path if
687
# sys.stdout encoding cannot represent it?
688
tree, relpath = WorkingTree.open_containing(filename)
689
self.outf.write(relpath)
690
self.outf.write('\n')
693
class cmd_inventory(Command):
694
__doc__ = """Show inventory of the current working copy or a revision.
696
It is possible to limit the output to a particular entry
697
type using the --kind option. For example: --kind file.
699
It is also possible to restrict the list of files to a specific
700
set. For example: bzr inventory --show-ids this/file
709
help='List entries of a particular kind: file, directory, symlink.',
712
takes_args = ['file*']
715
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
716
if kind and kind not in ['file', 'directory', 'symlink']:
717
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
719
revision = _get_one_revision('inventory', revision)
720
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
721
self.add_cleanup(work_tree.lock_read().unlock)
722
if revision is not None:
723
tree = revision.as_tree(work_tree.branch)
725
extra_trees = [work_tree]
726
self.add_cleanup(tree.lock_read().unlock)
731
if file_list is not None:
732
file_ids = tree.paths2ids(file_list, trees=extra_trees,
733
require_versioned=True)
734
# find_ids_across_trees may include some paths that don't
736
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
737
for file_id in file_ids if file_id in tree)
739
entries = tree.inventory.entries()
742
for path, entry in entries:
743
if kind and kind != entry.kind:
746
self.outf.write('%-50s %s\n' % (path, entry.file_id))
748
self.outf.write(path)
749
self.outf.write('\n')
752
class cmd_mv(Command):
753
__doc__ = """Move or rename a file.
756
bzr mv OLDNAME NEWNAME
758
bzr mv SOURCE... DESTINATION
760
If the last argument is a versioned directory, all the other names
761
are moved into it. Otherwise, there must be exactly two arguments
762
and the file is changed to a new name.
764
If OLDNAME does not exist on the filesystem but is versioned and
765
NEWNAME does exist on the filesystem but is not versioned, mv
766
assumes that the file has been manually moved and only updates
767
its internal inventory to reflect that change.
768
The same is valid when moving many SOURCE files to a DESTINATION.
770
Files cannot be moved between branches.
773
takes_args = ['names*']
774
takes_options = [Option("after", help="Move only the bzr identifier"
775
" of the file, because the file has already been moved."),
776
Option('auto', help='Automatically guess renames.'),
777
Option('dry-run', help='Avoid making changes when guessing renames.'),
779
aliases = ['move', 'rename']
780
encoding_type = 'replace'
782
def run(self, names_list, after=False, auto=False, dry_run=False):
784
return self.run_auto(names_list, after, dry_run)
786
raise errors.BzrCommandError('--dry-run requires --auto.')
787
if names_list is None:
789
if len(names_list) < 2:
790
raise errors.BzrCommandError("missing file argument")
791
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
792
self.add_cleanup(tree.lock_tree_write().unlock)
793
self._run(tree, names_list, rel_names, after)
795
def run_auto(self, names_list, after, dry_run):
796
if names_list is not None and len(names_list) > 1:
797
raise errors.BzrCommandError('Only one path may be specified to'
800
raise errors.BzrCommandError('--after cannot be specified with'
802
work_tree, file_list = WorkingTree.open_containing_paths(
803
names_list, default_directory='.')
804
self.add_cleanup(work_tree.lock_tree_write().unlock)
805
rename_map.RenameMap.guess_renames(work_tree, dry_run)
807
def _run(self, tree, names_list, rel_names, after):
808
into_existing = osutils.isdir(names_list[-1])
809
if into_existing and len(names_list) == 2:
811
# a. case-insensitive filesystem and change case of dir
812
# b. move directory after the fact (if the source used to be
813
# a directory, but now doesn't exist in the working tree
814
# and the target is an existing directory, just rename it)
815
if (not tree.case_sensitive
816
and rel_names[0].lower() == rel_names[1].lower()):
817
into_existing = False
820
# 'fix' the case of a potential 'from'
821
from_id = tree.path2id(
822
tree.get_canonical_inventory_path(rel_names[0]))
823
if (not osutils.lexists(names_list[0]) and
824
from_id and inv.get_file_kind(from_id) == "directory"):
825
into_existing = False
828
# move into existing directory
829
# All entries reference existing inventory items, so fix them up
830
# for cicp file-systems.
831
rel_names = tree.get_canonical_inventory_paths(rel_names)
832
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
834
self.outf.write("%s => %s\n" % (src, dest))
836
if len(names_list) != 2:
837
raise errors.BzrCommandError('to mv multiple files the'
838
' destination must be a versioned'
841
# for cicp file-systems: the src references an existing inventory
843
src = tree.get_canonical_inventory_path(rel_names[0])
844
# Find the canonical version of the destination: In all cases, the
845
# parent of the target must be in the inventory, so we fetch the
846
# canonical version from there (we do not always *use* the
847
# canonicalized tail portion - we may be attempting to rename the
849
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
850
dest_parent = osutils.dirname(canon_dest)
851
spec_tail = osutils.basename(rel_names[1])
852
# For a CICP file-system, we need to avoid creating 2 inventory
853
# entries that differ only by case. So regardless of the case
854
# we *want* to use (ie, specified by the user or the file-system),
855
# we must always choose to use the case of any existing inventory
856
# items. The only exception to this is when we are attempting a
857
# case-only rename (ie, canonical versions of src and dest are
859
dest_id = tree.path2id(canon_dest)
860
if dest_id is None or tree.path2id(src) == dest_id:
861
# No existing item we care about, so work out what case we
862
# are actually going to use.
864
# If 'after' is specified, the tail must refer to a file on disk.
866
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
868
# pathjoin with an empty tail adds a slash, which breaks
870
dest_parent_fq = tree.basedir
872
dest_tail = osutils.canonical_relpath(
874
osutils.pathjoin(dest_parent_fq, spec_tail))
876
# not 'after', so case as specified is used
877
dest_tail = spec_tail
879
# Use the existing item so 'mv' fails with AlreadyVersioned.
880
dest_tail = os.path.basename(canon_dest)
881
dest = osutils.pathjoin(dest_parent, dest_tail)
882
mutter("attempting to move %s => %s", src, dest)
883
tree.rename_one(src, dest, after=after)
885
self.outf.write("%s => %s\n" % (src, dest))
888
class cmd_pull(Command):
889
__doc__ = """Turn this branch into a mirror of another branch.
891
By default, this command only works on branches that have not diverged.
892
Branches are considered diverged if the destination branch's most recent
893
commit is one that has not been merged (directly or indirectly) into the
896
If branches have diverged, you can use 'bzr merge' to integrate the changes
897
from one into the other. Once one branch has merged, the other should
898
be able to pull it again.
900
If you want to replace your local changes and just want your branch to
901
match the remote one, use pull --overwrite. This will work even if the two
902
branches have diverged.
904
If there is no default location set, the first pull will set it. After
905
that, you can omit the location to use the default. To change the
906
default, use --remember. The value will only be saved if the remote
907
location can be accessed.
909
Note: The location can be specified either in the form of a branch,
910
or in the form of a path to a file containing a merge directive generated
914
_see_also = ['push', 'update', 'status-flags', 'send']
915
takes_options = ['remember', 'overwrite', 'revision',
916
custom_help('verbose',
917
help='Show logs of pulled revisions.'),
918
custom_help('directory',
919
help='Branch to pull into, '
920
'rather than the one containing the working directory.'),
922
help="Perform a local pull in a bound "
923
"branch. Local pulls are not applied to "
927
takes_args = ['location?']
928
encoding_type = 'replace'
930
def run(self, location=None, remember=False, overwrite=False,
931
revision=None, verbose=False,
932
directory=None, local=False):
933
# FIXME: too much stuff is in the command class
936
if directory is None:
939
tree_to = WorkingTree.open_containing(directory)[0]
940
branch_to = tree_to.branch
941
self.add_cleanup(tree_to.lock_write().unlock)
942
except errors.NoWorkingTree:
944
branch_to = Branch.open_containing(directory)[0]
945
self.add_cleanup(branch_to.lock_write().unlock)
947
if local and not branch_to.get_bound_location():
948
raise errors.LocalRequiresBoundBranch()
950
possible_transports = []
951
if location is not None:
953
mergeable = bundle.read_mergeable_from_url(location,
954
possible_transports=possible_transports)
955
except errors.NotABundle:
958
stored_loc = branch_to.get_parent()
960
if stored_loc is None:
961
raise errors.BzrCommandError("No pull location known or"
964
display_url = urlutils.unescape_for_display(stored_loc,
967
self.outf.write("Using saved parent location: %s\n" % display_url)
968
location = stored_loc
970
revision = _get_one_revision('pull', revision)
971
if mergeable is not None:
972
if revision is not None:
973
raise errors.BzrCommandError(
974
'Cannot use -r with merge directives or bundles')
975
mergeable.install_revisions(branch_to.repository)
976
base_revision_id, revision_id, verified = \
977
mergeable.get_merge_request(branch_to.repository)
978
branch_from = branch_to
980
branch_from = Branch.open(location,
981
possible_transports=possible_transports)
982
self.add_cleanup(branch_from.lock_read().unlock)
984
if branch_to.get_parent() is None or remember:
985
branch_to.set_parent(branch_from.base)
987
if revision is not None:
988
revision_id = revision.as_revision_id(branch_from)
990
if tree_to is not None:
991
view_info = _get_view_info_for_change_reporter(tree_to)
992
change_reporter = delta._ChangeReporter(
993
unversioned_filter=tree_to.is_ignored,
995
result = tree_to.pull(
996
branch_from, overwrite, revision_id, change_reporter,
997
possible_transports=possible_transports, local=local)
999
result = branch_to.pull(
1000
branch_from, overwrite, revision_id, local=local)
1002
result.report(self.outf)
1003
if verbose and result.old_revid != result.new_revid:
1004
log.show_branch_change(
1005
branch_to, self.outf, result.old_revno,
1009
class cmd_push(Command):
1010
__doc__ = """Update a mirror of this branch.
1012
The target branch will not have its working tree populated because this
1013
is both expensive, and is not supported on remote file systems.
1015
Some smart servers or protocols *may* put the working tree in place in
1018
This command only works on branches that have not diverged. Branches are
1019
considered diverged if the destination branch's most recent commit is one
1020
that has not been merged (directly or indirectly) by the source branch.
1022
If branches have diverged, you can use 'bzr push --overwrite' to replace
1023
the other branch completely, discarding its unmerged changes.
1025
If you want to ensure you have the different changes in the other branch,
1026
do a merge (see bzr help merge) from the other branch, and commit that.
1027
After that you will be able to do a push without '--overwrite'.
1029
If there is no default push location set, the first push will set it.
1030
After that, you can omit the location to use the default. To change the
1031
default, use --remember. The value will only be saved if the remote
1032
location can be accessed.
1035
_see_also = ['pull', 'update', 'working-trees']
1036
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1037
Option('create-prefix',
1038
help='Create the path leading up to the branch '
1039
'if it does not already exist.'),
1040
custom_help('directory',
1041
help='Branch to push from, '
1042
'rather than the one containing the working directory.'),
1043
Option('use-existing-dir',
1044
help='By default push will fail if the target'
1045
' directory exists, but does not already'
1046
' have a control directory. This flag will'
1047
' allow push to proceed.'),
1049
help='Create a stacked branch that references the public location '
1050
'of the parent branch.'),
1051
Option('stacked-on',
1052
help='Create a stacked branch that refers to another branch '
1053
'for the commit history. Only the work not present in the '
1054
'referenced branch is included in the branch created.',
1057
help='Refuse to push if there are uncommitted changes in'
1058
' the working tree, --no-strict disables the check.'),
1060
takes_args = ['location?']
1061
encoding_type = 'replace'
1063
def run(self, location=None, remember=False, overwrite=False,
1064
create_prefix=False, verbose=False, revision=None,
1065
use_existing_dir=False, directory=None, stacked_on=None,
1066
stacked=False, strict=None):
1067
from bzrlib.push import _show_push_branch
1069
if directory is None:
1071
# Get the source branch
1073
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1074
# Get the tip's revision_id
1075
revision = _get_one_revision('push', revision)
1076
if revision is not None:
1077
revision_id = revision.in_history(br_from).rev_id
1080
if tree is not None and revision_id is None:
1081
tree.check_changed_or_out_of_date(
1082
strict, 'push_strict',
1083
more_error='Use --no-strict to force the push.',
1084
more_warning='Uncommitted changes will not be pushed.')
1085
# Get the stacked_on branch, if any
1086
if stacked_on is not None:
1087
stacked_on = urlutils.normalize_url(stacked_on)
1089
parent_url = br_from.get_parent()
1091
parent = Branch.open(parent_url)
1092
stacked_on = parent.get_public_branch()
1094
# I considered excluding non-http url's here, thus forcing
1095
# 'public' branches only, but that only works for some
1096
# users, so it's best to just depend on the user spotting an
1097
# error by the feedback given to them. RBC 20080227.
1098
stacked_on = parent_url
1100
raise errors.BzrCommandError(
1101
"Could not determine branch to refer to.")
1103
# Get the destination location
1104
if location is None:
1105
stored_loc = br_from.get_push_location()
1106
if stored_loc is None:
1107
raise errors.BzrCommandError(
1108
"No push location known or specified.")
1110
display_url = urlutils.unescape_for_display(stored_loc,
1112
self.outf.write("Using saved push location: %s\n" % display_url)
1113
location = stored_loc
1115
_show_push_branch(br_from, revision_id, location, self.outf,
1116
verbose=verbose, overwrite=overwrite, remember=remember,
1117
stacked_on=stacked_on, create_prefix=create_prefix,
1118
use_existing_dir=use_existing_dir)
1121
class cmd_branch(Command):
1122
__doc__ = """Create a new branch that is a copy of an existing branch.
1124
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1125
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1126
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1127
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1128
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1131
To retrieve the branch as of a particular revision, supply the --revision
1132
parameter, as in "branch foo/bar -r 5".
1135
_see_also = ['checkout']
1136
takes_args = ['from_location', 'to_location?']
1137
takes_options = ['revision',
1138
Option('hardlink', help='Hard-link working tree files where possible.'),
1139
Option('files-from', type=str,
1140
help="Get file contents from this tree."),
1142
help="Create a branch without a working-tree."),
1144
help="Switch the checkout in the current directory "
1145
"to the new branch."),
1147
help='Create a stacked branch referring to the source branch. '
1148
'The new branch will depend on the availability of the source '
1149
'branch for all operations.'),
1150
Option('standalone',
1151
help='Do not use a shared repository, even if available.'),
1152
Option('use-existing-dir',
1153
help='By default branch will fail if the target'
1154
' directory exists, but does not already'
1155
' have a control directory. This flag will'
1156
' allow branch to proceed.'),
1158
help="Bind new branch to from location."),
1160
aliases = ['get', 'clone']
1162
def run(self, from_location, to_location=None, revision=None,
1163
hardlink=False, stacked=False, standalone=False, no_tree=False,
1164
use_existing_dir=False, switch=False, bind=False,
1166
from bzrlib import switch as _mod_switch
1167
from bzrlib.tag import _merge_tags_if_possible
1168
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1170
if not (hardlink or files_from):
1171
# accelerator_tree is usually slower because you have to read N
1172
# files (no readahead, lots of seeks, etc), but allow the user to
1173
# explicitly request it
1174
accelerator_tree = None
1175
if files_from is not None and files_from != from_location:
1176
accelerator_tree = WorkingTree.open(files_from)
1177
revision = _get_one_revision('branch', revision)
1178
self.add_cleanup(br_from.lock_read().unlock)
1179
if revision is not None:
1180
revision_id = revision.as_revision_id(br_from)
1182
# FIXME - wt.last_revision, fallback to branch, fall back to
1183
# None or perhaps NULL_REVISION to mean copy nothing
1185
revision_id = br_from.last_revision()
1186
if to_location is None:
1187
to_location = urlutils.derive_to_location(from_location)
1188
to_transport = transport.get_transport(to_location)
1190
to_transport.mkdir('.')
1191
except errors.FileExists:
1192
if not use_existing_dir:
1193
raise errors.BzrCommandError('Target directory "%s" '
1194
'already exists.' % to_location)
1197
bzrdir.BzrDir.open_from_transport(to_transport)
1198
except errors.NotBranchError:
1201
raise errors.AlreadyBranchError(to_location)
1202
except errors.NoSuchFile:
1203
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1206
# preserve whatever source format we have.
1207
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1208
possible_transports=[to_transport],
1209
accelerator_tree=accelerator_tree,
1210
hardlink=hardlink, stacked=stacked,
1211
force_new_repo=standalone,
1212
create_tree_if_local=not no_tree,
1213
source_branch=br_from)
1214
branch = dir.open_branch()
1215
except errors.NoSuchRevision:
1216
to_transport.delete_tree('.')
1217
msg = "The branch %s has no revision %s." % (from_location,
1219
raise errors.BzrCommandError(msg)
1220
_merge_tags_if_possible(br_from, branch)
1221
# If the source branch is stacked, the new branch may
1222
# be stacked whether we asked for that explicitly or not.
1223
# We therefore need a try/except here and not just 'if stacked:'
1225
note('Created new stacked branch referring to %s.' %
1226
branch.get_stacked_on_url())
1227
except (errors.NotStacked, errors.UnstackableBranchFormat,
1228
errors.UnstackableRepositoryFormat), e:
1229
note('Branched %d revision(s).' % branch.revno())
1231
# Bind to the parent
1232
parent_branch = Branch.open(from_location)
1233
branch.bind(parent_branch)
1234
note('New branch bound to %s' % from_location)
1236
# Switch to the new branch
1237
wt, _ = WorkingTree.open_containing('.')
1238
_mod_switch.switch(wt.bzrdir, branch)
1239
note('Switched to branch: %s',
1240
urlutils.unescape_for_display(branch.base, 'utf-8'))
1243
class cmd_checkout(Command):
1244
__doc__ = """Create a new checkout of an existing branch.
1246
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1247
the branch found in '.'. This is useful if you have removed the working tree
1248
or if it was never created - i.e. if you pushed the branch to its current
1249
location using SFTP.
1251
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1252
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1253
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1254
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1255
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1258
To retrieve the branch as of a particular revision, supply the --revision
1259
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1260
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1264
_see_also = ['checkouts', 'branch']
1265
takes_args = ['branch_location?', 'to_location?']
1266
takes_options = ['revision',
1267
Option('lightweight',
1268
help="Perform a lightweight checkout. Lightweight "
1269
"checkouts depend on access to the branch for "
1270
"every operation. Normal checkouts can perform "
1271
"common operations like diff and status without "
1272
"such access, and also support local commits."
1274
Option('files-from', type=str,
1275
help="Get file contents from this tree."),
1277
help='Hard-link working tree files where possible.'
1282
def run(self, branch_location=None, to_location=None, revision=None,
1283
lightweight=False, files_from=None, hardlink=False):
1284
if branch_location is None:
1285
branch_location = osutils.getcwd()
1286
to_location = branch_location
1287
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1289
if not (hardlink or files_from):
1290
# accelerator_tree is usually slower because you have to read N
1291
# files (no readahead, lots of seeks, etc), but allow the user to
1292
# explicitly request it
1293
accelerator_tree = None
1294
revision = _get_one_revision('checkout', revision)
1295
if files_from is not None and files_from != branch_location:
1296
accelerator_tree = WorkingTree.open(files_from)
1297
if revision is not None:
1298
revision_id = revision.as_revision_id(source)
1301
if to_location is None:
1302
to_location = urlutils.derive_to_location(branch_location)
1303
# if the source and to_location are the same,
1304
# and there is no working tree,
1305
# then reconstitute a branch
1306
if (osutils.abspath(to_location) ==
1307
osutils.abspath(branch_location)):
1309
source.bzrdir.open_workingtree()
1310
except errors.NoWorkingTree:
1311
source.bzrdir.create_workingtree(revision_id)
1313
source.create_checkout(to_location, revision_id, lightweight,
1314
accelerator_tree, hardlink)
1317
class cmd_renames(Command):
1318
__doc__ = """Show list of renamed files.
1320
# TODO: Option to show renames between two historical versions.
1322
# TODO: Only show renames under dir, rather than in the whole branch.
1323
_see_also = ['status']
1324
takes_args = ['dir?']
1327
def run(self, dir=u'.'):
1328
tree = WorkingTree.open_containing(dir)[0]
1329
self.add_cleanup(tree.lock_read().unlock)
1330
new_inv = tree.inventory
1331
old_tree = tree.basis_tree()
1332
self.add_cleanup(old_tree.lock_read().unlock)
1333
old_inv = old_tree.inventory
1335
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1336
for f, paths, c, v, p, n, k, e in iterator:
1337
if paths[0] == paths[1]:
1341
renames.append(paths)
1343
for old_name, new_name in renames:
1344
self.outf.write("%s => %s\n" % (old_name, new_name))
1347
class cmd_update(Command):
1348
__doc__ = """Update a tree to have the latest code committed to its branch.
1350
This will perform a merge into the working tree, and may generate
1351
conflicts. If you have any local changes, you will still
1352
need to commit them after the update for the update to be complete.
1354
If you want to discard your local changes, you can just do a
1355
'bzr revert' instead of 'bzr commit' after the update.
1357
If you want to restore a file that has been removed locally, use
1358
'bzr revert' instead of 'bzr update'.
1360
If the tree's branch is bound to a master branch, it will also update
1361
the branch from the master.
1364
_see_also = ['pull', 'working-trees', 'status-flags']
1365
takes_args = ['dir?']
1366
takes_options = ['revision']
1369
def run(self, dir='.', revision=None):
1370
if revision is not None and len(revision) != 1:
1371
raise errors.BzrCommandError(
1372
"bzr update --revision takes exactly one revision")
1373
tree = WorkingTree.open_containing(dir)[0]
1374
branch = tree.branch
1375
possible_transports = []
1376
master = branch.get_master_branch(
1377
possible_transports=possible_transports)
1378
if master is not None:
1379
branch_location = master.base
1382
branch_location = tree.branch.base
1383
tree.lock_tree_write()
1384
self.add_cleanup(tree.unlock)
1385
# get rid of the final '/' and be ready for display
1386
branch_location = urlutils.unescape_for_display(
1387
branch_location.rstrip('/'),
1389
existing_pending_merges = tree.get_parent_ids()[1:]
1393
# may need to fetch data into a heavyweight checkout
1394
# XXX: this may take some time, maybe we should display a
1396
old_tip = branch.update(possible_transports)
1397
if revision is not None:
1398
revision_id = revision[0].as_revision_id(branch)
1400
revision_id = branch.last_revision()
1401
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1402
revno = branch.revision_id_to_dotted_revno(revision_id)
1403
note("Tree is up to date at revision %s of branch %s" %
1404
('.'.join(map(str, revno)), branch_location))
1406
view_info = _get_view_info_for_change_reporter(tree)
1407
change_reporter = delta._ChangeReporter(
1408
unversioned_filter=tree.is_ignored,
1409
view_info=view_info)
1411
conflicts = tree.update(
1413
possible_transports=possible_transports,
1414
revision=revision_id,
1416
except errors.NoSuchRevision, e:
1417
raise errors.BzrCommandError(
1418
"branch has no revision %s\n"
1419
"bzr update --revision only works"
1420
" for a revision in the branch history"
1422
revno = tree.branch.revision_id_to_dotted_revno(
1423
_mod_revision.ensure_null(tree.last_revision()))
1424
note('Updated to revision %s of branch %s' %
1425
('.'.join(map(str, revno)), branch_location))
1426
parent_ids = tree.get_parent_ids()
1427
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1428
note('Your local commits will now show as pending merges with '
1429
"'bzr status', and can be committed with 'bzr commit'.")
1436
class cmd_info(Command):
1437
__doc__ = """Show information about a working tree, branch or repository.
1439
This command will show all known locations and formats associated to the
1440
tree, branch or repository.
1442
In verbose mode, statistical information is included with each report.
1443
To see extended statistic information, use a verbosity level of 2 or
1444
higher by specifying the verbose option multiple times, e.g. -vv.
1446
Branches and working trees will also report any missing revisions.
1450
Display information on the format and related locations:
1454
Display the above together with extended format information and
1455
basic statistics (like the number of files in the working tree and
1456
number of revisions in the branch and repository):
1460
Display the above together with number of committers to the branch:
1464
_see_also = ['revno', 'working-trees', 'repositories']
1465
takes_args = ['location?']
1466
takes_options = ['verbose']
1467
encoding_type = 'replace'
1470
def run(self, location=None, verbose=False):
1472
noise_level = get_verbosity_level()
1475
from bzrlib.info import show_bzrdir_info
1476
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1477
verbose=noise_level, outfile=self.outf)
1480
class cmd_remove(Command):
1481
__doc__ = """Remove files or directories.
1483
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1484
delete them if they can easily be recovered using revert otherwise they
1485
will be backed up (adding an extention of the form .~#~). If no options or
1486
parameters are given Bazaar will scan for files that are being tracked by
1487
Bazaar but missing in your tree and stop tracking them for you.
1489
takes_args = ['file*']
1490
takes_options = ['verbose',
1491
Option('new', help='Only remove files that have never been committed.'),
1492
RegistryOption.from_kwargs('file-deletion-strategy',
1493
'The file deletion mode to be used.',
1494
title='Deletion Strategy', value_switches=True, enum_switch=False,
1495
safe='Backup changed files (default).',
1496
keep='Delete from bzr but leave the working copy.',
1497
force='Delete all the specified files, even if they can not be '
1498
'recovered and even if they are non-empty directories.')]
1499
aliases = ['rm', 'del']
1500
encoding_type = 'replace'
1502
def run(self, file_list, verbose=False, new=False,
1503
file_deletion_strategy='safe'):
1504
tree, file_list = WorkingTree.open_containing_paths(file_list)
1506
if file_list is not None:
1507
file_list = [f for f in file_list]
1509
self.add_cleanup(tree.lock_write().unlock)
1510
# Heuristics should probably all move into tree.remove_smart or
1513
added = tree.changes_from(tree.basis_tree(),
1514
specific_files=file_list).added
1515
file_list = sorted([f[0] for f in added], reverse=True)
1516
if len(file_list) == 0:
1517
raise errors.BzrCommandError('No matching files.')
1518
elif file_list is None:
1519
# missing files show up in iter_changes(basis) as
1520
# versioned-with-no-kind.
1522
for change in tree.iter_changes(tree.basis_tree()):
1523
# Find paths in the working tree that have no kind:
1524
if change[1][1] is not None and change[6][1] is None:
1525
missing.append(change[1][1])
1526
file_list = sorted(missing, reverse=True)
1527
file_deletion_strategy = 'keep'
1528
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1529
keep_files=file_deletion_strategy=='keep',
1530
force=file_deletion_strategy=='force')
1533
class cmd_file_id(Command):
1534
__doc__ = """Print file_id of a particular file or directory.
1536
The file_id is assigned when the file is first added and remains the
1537
same through all revisions where the file exists, even when it is
1542
_see_also = ['inventory', 'ls']
1543
takes_args = ['filename']
1546
def run(self, filename):
1547
tree, relpath = WorkingTree.open_containing(filename)
1548
i = tree.path2id(relpath)
1550
raise errors.NotVersionedError(filename)
1552
self.outf.write(i + '\n')
1555
class cmd_file_path(Command):
1556
__doc__ = """Print path of file_ids to a file or directory.
1558
This prints one line for each directory down to the target,
1559
starting at the branch root.
1563
takes_args = ['filename']
1566
def run(self, filename):
1567
tree, relpath = WorkingTree.open_containing(filename)
1568
fid = tree.path2id(relpath)
1570
raise errors.NotVersionedError(filename)
1571
segments = osutils.splitpath(relpath)
1572
for pos in range(1, len(segments) + 1):
1573
path = osutils.joinpath(segments[:pos])
1574
self.outf.write("%s\n" % tree.path2id(path))
1577
class cmd_reconcile(Command):
1578
__doc__ = """Reconcile bzr metadata in a branch.
1580
This can correct data mismatches that may have been caused by
1581
previous ghost operations or bzr upgrades. You should only
1582
need to run this command if 'bzr check' or a bzr developer
1583
advises you to run it.
1585
If a second branch is provided, cross-branch reconciliation is
1586
also attempted, which will check that data like the tree root
1587
id which was not present in very early bzr versions is represented
1588
correctly in both branches.
1590
At the same time it is run it may recompress data resulting in
1591
a potential saving in disk space or performance gain.
1593
The branch *MUST* be on a listable system such as local disk or sftp.
1596
_see_also = ['check']
1597
takes_args = ['branch?']
1599
Option('canonicalize-chks',
1600
help='Make sure CHKs are in canonical form (repairs '
1605
def run(self, branch=".", canonicalize_chks=False):
1606
from bzrlib.reconcile import reconcile
1607
dir = bzrdir.BzrDir.open(branch)
1608
reconcile(dir, canonicalize_chks=canonicalize_chks)
1611
class cmd_revision_history(Command):
1612
__doc__ = """Display the list of revision ids on a branch."""
1615
takes_args = ['location?']
1620
def run(self, location="."):
1621
branch = Branch.open_containing(location)[0]
1622
for revid in branch.revision_history():
1623
self.outf.write(revid)
1624
self.outf.write('\n')
1627
class cmd_ancestry(Command):
1628
__doc__ = """List all revisions merged into this branch."""
1630
_see_also = ['log', 'revision-history']
1631
takes_args = ['location?']
1636
def run(self, location="."):
1638
wt = WorkingTree.open_containing(location)[0]
1639
except errors.NoWorkingTree:
1640
b = Branch.open(location)
1641
last_revision = b.last_revision()
1644
last_revision = wt.last_revision()
1646
revision_ids = b.repository.get_ancestry(last_revision)
1648
for revision_id in revision_ids:
1649
self.outf.write(revision_id + '\n')
1652
class cmd_init(Command):
1653
__doc__ = """Make a directory into a versioned branch.
1655
Use this to create an empty branch, or before importing an
1658
If there is a repository in a parent directory of the location, then
1659
the history of the branch will be stored in the repository. Otherwise
1660
init creates a standalone branch which carries its own history
1661
in the .bzr directory.
1663
If there is already a branch at the location but it has no working tree,
1664
the tree can be populated with 'bzr checkout'.
1666
Recipe for importing a tree of files::
1672
bzr commit -m "imported project"
1675
_see_also = ['init-repository', 'branch', 'checkout']
1676
takes_args = ['location?']
1678
Option('create-prefix',
1679
help='Create the path leading up to the branch '
1680
'if it does not already exist.'),
1681
RegistryOption('format',
1682
help='Specify a format for this branch. '
1683
'See "help formats".',
1684
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1685
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1686
value_switches=True,
1687
title="Branch format",
1689
Option('append-revisions-only',
1690
help='Never change revnos or the existing log.'
1691
' Append revisions to it only.')
1693
def run(self, location=None, format=None, append_revisions_only=False,
1694
create_prefix=False):
1696
format = bzrdir.format_registry.make_bzrdir('default')
1697
if location is None:
1700
to_transport = transport.get_transport(location)
1702
# The path has to exist to initialize a
1703
# branch inside of it.
1704
# Just using os.mkdir, since I don't
1705
# believe that we want to create a bunch of
1706
# locations if the user supplies an extended path
1708
to_transport.ensure_base()
1709
except errors.NoSuchFile:
1710
if not create_prefix:
1711
raise errors.BzrCommandError("Parent directory of %s"
1713
"\nYou may supply --create-prefix to create all"
1714
" leading parent directories."
1716
to_transport.create_prefix()
1719
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1720
except errors.NotBranchError:
1721
# really a NotBzrDir error...
1722
create_branch = bzrdir.BzrDir.create_branch_convenience
1723
branch = create_branch(to_transport.base, format=format,
1724
possible_transports=[to_transport])
1725
a_bzrdir = branch.bzrdir
1727
from bzrlib.transport.local import LocalTransport
1728
if a_bzrdir.has_branch():
1729
if (isinstance(to_transport, LocalTransport)
1730
and not a_bzrdir.has_workingtree()):
1731
raise errors.BranchExistsWithoutWorkingTree(location)
1732
raise errors.AlreadyBranchError(location)
1733
branch = a_bzrdir.create_branch()
1734
a_bzrdir.create_workingtree()
1735
if append_revisions_only:
1737
branch.set_append_revisions_only(True)
1738
except errors.UpgradeRequired:
1739
raise errors.BzrCommandError('This branch format cannot be set'
1740
' to append-revisions-only. Try --default.')
1742
from bzrlib.info import describe_layout, describe_format
1744
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1745
except (errors.NoWorkingTree, errors.NotLocalUrl):
1747
repository = branch.repository
1748
layout = describe_layout(repository, branch, tree).lower()
1749
format = describe_format(a_bzrdir, repository, branch, tree)
1750
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1751
if repository.is_shared():
1752
#XXX: maybe this can be refactored into transport.path_or_url()
1753
url = repository.bzrdir.root_transport.external_url()
1755
url = urlutils.local_path_from_url(url)
1756
except errors.InvalidURL:
1758
self.outf.write("Using shared repository: %s\n" % url)
1761
class cmd_init_repository(Command):
1762
__doc__ = """Create a shared repository for branches to share storage space.
1764
New branches created under the repository directory will store their
1765
revisions in the repository, not in the branch directory. For branches
1766
with shared history, this reduces the amount of storage needed and
1767
speeds up the creation of new branches.
1769
If the --no-trees option is given then the branches in the repository
1770
will not have working trees by default. They will still exist as
1771
directories on disk, but they will not have separate copies of the
1772
files at a certain revision. This can be useful for repositories that
1773
store branches which are interacted with through checkouts or remote
1774
branches, such as on a server.
1777
Create a shared repository holding just branches::
1779
bzr init-repo --no-trees repo
1782
Make a lightweight checkout elsewhere::
1784
bzr checkout --lightweight repo/trunk trunk-checkout
1789
_see_also = ['init', 'branch', 'checkout', 'repositories']
1790
takes_args = ["location"]
1791
takes_options = [RegistryOption('format',
1792
help='Specify a format for this repository. See'
1793
' "bzr help formats" for details.',
1794
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1795
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1796
value_switches=True, title='Repository format'),
1798
help='Branches in the repository will default to'
1799
' not having a working tree.'),
1801
aliases = ["init-repo"]
1803
def run(self, location, format=None, no_trees=False):
1805
format = bzrdir.format_registry.make_bzrdir('default')
1807
if location is None:
1810
to_transport = transport.get_transport(location)
1811
to_transport.ensure_base()
1813
newdir = format.initialize_on_transport(to_transport)
1814
repo = newdir.create_repository(shared=True)
1815
repo.set_make_working_trees(not no_trees)
1817
from bzrlib.info import show_bzrdir_info
1818
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1821
class cmd_diff(Command):
1822
__doc__ = """Show differences in the working tree, between revisions or branches.
1824
If no arguments are given, all changes for the current tree are listed.
1825
If files are given, only the changes in those files are listed.
1826
Remote and multiple branches can be compared by using the --old and
1827
--new options. If not provided, the default for both is derived from
1828
the first argument, if any, or the current tree if no arguments are
1831
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1832
produces patches suitable for "patch -p1".
1836
2 - unrepresentable changes
1841
Shows the difference in the working tree versus the last commit::
1845
Difference between the working tree and revision 1::
1849
Difference between revision 3 and revision 1::
1853
Difference between revision 3 and revision 1 for branch xxx::
1857
To see the changes introduced in revision X::
1861
Note that in the case of a merge, the -c option shows the changes
1862
compared to the left hand parent. To see the changes against
1863
another parent, use::
1865
bzr diff -r<chosen_parent>..X
1867
The changes introduced by revision 2 (equivalent to -r1..2)::
1871
Show just the differences for file NEWS::
1875
Show the differences in working tree xxx for file NEWS::
1879
Show the differences from branch xxx to this working tree:
1883
Show the differences between two branches for file NEWS::
1885
bzr diff --old xxx --new yyy NEWS
1887
Same as 'bzr diff' but prefix paths with old/ and new/::
1889
bzr diff --prefix old/:new/
1891
Show the differences using a custom diff program with options::
1893
bzr diff --using /usr/bin/diff --diff-options -wu
1895
_see_also = ['status']
1896
takes_args = ['file*']
1898
Option('diff-options', type=str,
1899
help='Pass these options to the external diff program.'),
1900
Option('prefix', type=str,
1902
help='Set prefixes added to old and new filenames, as '
1903
'two values separated by a colon. (eg "old/:new/").'),
1905
help='Branch/tree to compare from.',
1909
help='Branch/tree to compare to.',
1915
help='Use this command to compare files.',
1918
RegistryOption('format',
1919
help='Diff format to use.',
1920
lazy_registry=('bzrlib.diff', 'format_registry'),
1921
value_switches=False, title='Diff format'),
1923
aliases = ['di', 'dif']
1924
encoding_type = 'exact'
1927
def run(self, revision=None, file_list=None, diff_options=None,
1928
prefix=None, old=None, new=None, using=None, format=None):
1929
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1932
if (prefix is None) or (prefix == '0'):
1940
old_label, new_label = prefix.split(":")
1942
raise errors.BzrCommandError(
1943
'--prefix expects two values separated by a colon'
1944
' (eg "old/:new/")')
1946
if revision and len(revision) > 2:
1947
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1948
' one or two revision specifiers')
1950
if using is not None and format is not None:
1951
raise errors.BzrCommandError('--using and --format are mutually '
1954
(old_tree, new_tree,
1955
old_branch, new_branch,
1956
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1957
file_list, revision, old, new, self.add_cleanup, apply_view=True)
1958
# GNU diff on Windows uses ANSI encoding for filenames
1959
path_encoding = osutils.get_diff_header_encoding()
1960
return show_diff_trees(old_tree, new_tree, sys.stdout,
1961
specific_files=specific_files,
1962
external_diff_options=diff_options,
1963
old_label=old_label, new_label=new_label,
1964
extra_trees=extra_trees,
1965
path_encoding=path_encoding,
1970
class cmd_deleted(Command):
1971
__doc__ = """List files deleted in the working tree.
1973
# TODO: Show files deleted since a previous revision, or
1974
# between two revisions.
1975
# TODO: Much more efficient way to do this: read in new
1976
# directories with readdir, rather than stating each one. Same
1977
# level of effort but possibly much less IO. (Or possibly not,
1978
# if the directories are very large...)
1979
_see_also = ['status', 'ls']
1980
takes_options = ['directory', 'show-ids']
1983
def run(self, show_ids=False, directory=u'.'):
1984
tree = WorkingTree.open_containing(directory)[0]
1985
self.add_cleanup(tree.lock_read().unlock)
1986
old = tree.basis_tree()
1987
self.add_cleanup(old.lock_read().unlock)
1988
for path, ie in old.inventory.iter_entries():
1989
if not tree.has_id(ie.file_id):
1990
self.outf.write(path)
1992
self.outf.write(' ')
1993
self.outf.write(ie.file_id)
1994
self.outf.write('\n')
1997
class cmd_modified(Command):
1998
__doc__ = """List files modified in working tree.
2002
_see_also = ['status', 'ls']
2003
takes_options = ['directory', 'null']
2006
def run(self, null=False, directory=u'.'):
2007
tree = WorkingTree.open_containing(directory)[0]
2008
td = tree.changes_from(tree.basis_tree())
2009
for path, id, kind, text_modified, meta_modified in td.modified:
2011
self.outf.write(path + '\0')
2013
self.outf.write(osutils.quotefn(path) + '\n')
2016
class cmd_added(Command):
2017
__doc__ = """List files added in working tree.
2021
_see_also = ['status', 'ls']
2022
takes_options = ['directory', 'null']
2025
def run(self, null=False, directory=u'.'):
2026
wt = WorkingTree.open_containing(directory)[0]
2027
self.add_cleanup(wt.lock_read().unlock)
2028
basis = wt.basis_tree()
2029
self.add_cleanup(basis.lock_read().unlock)
2030
basis_inv = basis.inventory
2033
if file_id in basis_inv:
2035
if inv.is_root(file_id) and len(basis_inv) == 0:
2037
path = inv.id2path(file_id)
2038
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2041
self.outf.write(path + '\0')
2043
self.outf.write(osutils.quotefn(path) + '\n')
2046
class cmd_root(Command):
2047
__doc__ = """Show the tree root directory.
2049
The root is the nearest enclosing directory with a .bzr control
2052
takes_args = ['filename?']
2054
def run(self, filename=None):
2055
"""Print the branch root."""
2056
tree = WorkingTree.open_containing(filename)[0]
2057
self.outf.write(tree.basedir + '\n')
2060
def _parse_limit(limitstring):
2062
return int(limitstring)
2064
msg = "The limit argument must be an integer."
2065
raise errors.BzrCommandError(msg)
2068
def _parse_levels(s):
2072
msg = "The levels argument must be an integer."
2073
raise errors.BzrCommandError(msg)
2076
class cmd_log(Command):
2077
__doc__ = """Show historical log for a branch or subset of a branch.
2079
log is bzr's default tool for exploring the history of a branch.
2080
The branch to use is taken from the first parameter. If no parameters
2081
are given, the branch containing the working directory is logged.
2082
Here are some simple examples::
2084
bzr log log the current branch
2085
bzr log foo.py log a file in its branch
2086
bzr log http://server/branch log a branch on a server
2088
The filtering, ordering and information shown for each revision can
2089
be controlled as explained below. By default, all revisions are
2090
shown sorted (topologically) so that newer revisions appear before
2091
older ones and descendants always appear before ancestors. If displayed,
2092
merged revisions are shown indented under the revision in which they
2097
The log format controls how information about each revision is
2098
displayed. The standard log formats are called ``long``, ``short``
2099
and ``line``. The default is long. See ``bzr help log-formats``
2100
for more details on log formats.
2102
The following options can be used to control what information is
2105
-l N display a maximum of N revisions
2106
-n N display N levels of revisions (0 for all, 1 for collapsed)
2107
-v display a status summary (delta) for each revision
2108
-p display a diff (patch) for each revision
2109
--show-ids display revision-ids (and file-ids), not just revnos
2111
Note that the default number of levels to display is a function of the
2112
log format. If the -n option is not used, the standard log formats show
2113
just the top level (mainline).
2115
Status summaries are shown using status flags like A, M, etc. To see
2116
the changes explained using words like ``added`` and ``modified``
2117
instead, use the -vv option.
2121
To display revisions from oldest to newest, use the --forward option.
2122
In most cases, using this option will have little impact on the total
2123
time taken to produce a log, though --forward does not incrementally
2124
display revisions like --reverse does when it can.
2126
:Revision filtering:
2128
The -r option can be used to specify what revision or range of revisions
2129
to filter against. The various forms are shown below::
2131
-rX display revision X
2132
-rX.. display revision X and later
2133
-r..Y display up to and including revision Y
2134
-rX..Y display from X to Y inclusive
2136
See ``bzr help revisionspec`` for details on how to specify X and Y.
2137
Some common examples are given below::
2139
-r-1 show just the tip
2140
-r-10.. show the last 10 mainline revisions
2141
-rsubmit:.. show what's new on this branch
2142
-rancestor:path.. show changes since the common ancestor of this
2143
branch and the one at location path
2144
-rdate:yesterday.. show changes since yesterday
2146
When logging a range of revisions using -rX..Y, log starts at
2147
revision Y and searches back in history through the primary
2148
("left-hand") parents until it finds X. When logging just the
2149
top level (using -n1), an error is reported if X is not found
2150
along the way. If multi-level logging is used (-n0), X may be
2151
a nested merge revision and the log will be truncated accordingly.
2155
If parameters are given and the first one is not a branch, the log
2156
will be filtered to show only those revisions that changed the
2157
nominated files or directories.
2159
Filenames are interpreted within their historical context. To log a
2160
deleted file, specify a revision range so that the file existed at
2161
the end or start of the range.
2163
Historical context is also important when interpreting pathnames of
2164
renamed files/directories. Consider the following example:
2166
* revision 1: add tutorial.txt
2167
* revision 2: modify tutorial.txt
2168
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2172
* ``bzr log guide.txt`` will log the file added in revision 1
2174
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2176
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2177
the original file in revision 2.
2179
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2180
was no file called guide.txt in revision 2.
2182
Renames are always followed by log. By design, there is no need to
2183
explicitly ask for this (and no way to stop logging a file back
2184
until it was last renamed).
2188
The --message option can be used for finding revisions that match a
2189
regular expression in a commit message.
2193
GUI tools and IDEs are often better at exploring history than command
2194
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2195
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2196
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2197
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2199
You may find it useful to add the aliases below to ``bazaar.conf``::
2203
top = log -l10 --line
2206
``bzr tip`` will then show the latest revision while ``bzr top``
2207
will show the last 10 mainline revisions. To see the details of a
2208
particular revision X, ``bzr show -rX``.
2210
If you are interested in looking deeper into a particular merge X,
2211
use ``bzr log -n0 -rX``.
2213
``bzr log -v`` on a branch with lots of history is currently
2214
very slow. A fix for this issue is currently under development.
2215
With or without that fix, it is recommended that a revision range
2216
be given when using the -v option.
2218
bzr has a generic full-text matching plugin, bzr-search, that can be
2219
used to find revisions matching user names, commit messages, etc.
2220
Among other features, this plugin can find all revisions containing
2221
a list of words but not others.
2223
When exploring non-mainline history on large projects with deep
2224
history, the performance of log can be greatly improved by installing
2225
the historycache plugin. This plugin buffers historical information
2226
trading disk space for faster speed.
2228
takes_args = ['file*']
2229
_see_also = ['log-formats', 'revisionspec']
2232
help='Show from oldest to newest.'),
2234
custom_help('verbose',
2235
help='Show files changed in each revision.'),
2239
type=bzrlib.option._parse_revision_str,
2241
help='Show just the specified revision.'
2242
' See also "help revisionspec".'),
2244
RegistryOption('authors',
2245
'What names to list as authors - first, all or committer.',
2247
lazy_registry=('bzrlib.log', 'author_list_registry'),
2251
help='Number of levels to display - 0 for all, 1 for flat.',
2253
type=_parse_levels),
2256
help='Show revisions whose message matches this '
2257
'regular expression.',
2261
help='Limit the output to the first N revisions.',
2266
help='Show changes made in each revision as a patch.'),
2267
Option('include-merges',
2268
help='Show merged revisions like --levels 0 does.'),
2269
Option('exclude-common-ancestry',
2270
help='Display only the revisions that are not part'
2271
' of both ancestries (require -rX..Y)'
2274
encoding_type = 'replace'
2277
def run(self, file_list=None, timezone='original',
2288
include_merges=False,
2290
exclude_common_ancestry=False,
2292
from bzrlib.log import (
2294
make_log_request_dict,
2295
_get_info_for_log_files,
2297
direction = (forward and 'forward') or 'reverse'
2298
if (exclude_common_ancestry
2299
and (revision is None or len(revision) != 2)):
2300
raise errors.BzrCommandError(
2301
'--exclude-common-ancestry requires -r with two revisions')
2306
raise errors.BzrCommandError(
2307
'--levels and --include-merges are mutually exclusive')
2309
if change is not None:
2311
raise errors.RangeInChangeOption()
2312
if revision is not None:
2313
raise errors.BzrCommandError(
2314
'--revision and --change are mutually exclusive')
2319
filter_by_dir = False
2321
# find the file ids to log and check for directory filtering
2322
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2323
revision, file_list, self.add_cleanup)
2324
for relpath, file_id, kind in file_info_list:
2326
raise errors.BzrCommandError(
2327
"Path unknown at end or start of revision range: %s" %
2329
# If the relpath is the top of the tree, we log everything
2334
file_ids.append(file_id)
2335
filter_by_dir = filter_by_dir or (
2336
kind in ['directory', 'tree-reference'])
2339
# FIXME ? log the current subdir only RBC 20060203
2340
if revision is not None \
2341
and len(revision) > 0 and revision[0].get_branch():
2342
location = revision[0].get_branch()
2345
dir, relpath = bzrdir.BzrDir.open_containing(location)
2346
b = dir.open_branch()
2347
self.add_cleanup(b.lock_read().unlock)
2348
rev1, rev2 = _get_revision_range(revision, b, self.name())
2350
# Decide on the type of delta & diff filtering to use
2351
# TODO: add an --all-files option to make this configurable & consistent
2359
diff_type = 'partial'
2363
# Build the log formatter
2364
if log_format is None:
2365
log_format = log.log_formatter_registry.get_default(b)
2366
# Make a non-encoding output to include the diffs - bug 328007
2367
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2368
lf = log_format(show_ids=show_ids, to_file=self.outf,
2369
to_exact_file=unencoded_output,
2370
show_timezone=timezone,
2371
delta_format=get_verbosity_level(),
2373
show_advice=levels is None,
2374
author_list_handler=authors)
2376
# Choose the algorithm for doing the logging. It's annoying
2377
# having multiple code paths like this but necessary until
2378
# the underlying repository format is faster at generating
2379
# deltas or can provide everything we need from the indices.
2380
# The default algorithm - match-using-deltas - works for
2381
# multiple files and directories and is faster for small
2382
# amounts of history (200 revisions say). However, it's too
2383
# slow for logging a single file in a repository with deep
2384
# history, i.e. > 10K revisions. In the spirit of "do no
2385
# evil when adding features", we continue to use the
2386
# original algorithm - per-file-graph - for the "single
2387
# file that isn't a directory without showing a delta" case.
2388
partial_history = revision and b.repository._format.supports_chks
2389
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2390
or delta_type or partial_history)
2392
# Build the LogRequest and execute it
2393
if len(file_ids) == 0:
2395
rqst = make_log_request_dict(
2396
direction=direction, specific_fileids=file_ids,
2397
start_revision=rev1, end_revision=rev2, limit=limit,
2398
message_search=message, delta_type=delta_type,
2399
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2400
exclude_common_ancestry=exclude_common_ancestry,
2402
Logger(b, rqst).show(lf)
2405
def _get_revision_range(revisionspec_list, branch, command_name):
2406
"""Take the input of a revision option and turn it into a revision range.
2408
It returns RevisionInfo objects which can be used to obtain the rev_id's
2409
of the desired revisions. It does some user input validations.
2411
if revisionspec_list is None:
2414
elif len(revisionspec_list) == 1:
2415
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2416
elif len(revisionspec_list) == 2:
2417
start_spec = revisionspec_list[0]
2418
end_spec = revisionspec_list[1]
2419
if end_spec.get_branch() != start_spec.get_branch():
2420
# b is taken from revision[0].get_branch(), and
2421
# show_log will use its revision_history. Having
2422
# different branches will lead to weird behaviors.
2423
raise errors.BzrCommandError(
2424
"bzr %s doesn't accept two revisions in different"
2425
" branches." % command_name)
2426
if start_spec.spec is None:
2427
# Avoid loading all the history.
2428
rev1 = RevisionInfo(branch, None, None)
2430
rev1 = start_spec.in_history(branch)
2431
# Avoid loading all of history when we know a missing
2432
# end of range means the last revision ...
2433
if end_spec.spec is None:
2434
last_revno, last_revision_id = branch.last_revision_info()
2435
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2437
rev2 = end_spec.in_history(branch)
2439
raise errors.BzrCommandError(
2440
'bzr %s --revision takes one or two values.' % command_name)
2444
def _revision_range_to_revid_range(revision_range):
2447
if revision_range[0] is not None:
2448
rev_id1 = revision_range[0].rev_id
2449
if revision_range[1] is not None:
2450
rev_id2 = revision_range[1].rev_id
2451
return rev_id1, rev_id2
2453
def get_log_format(long=False, short=False, line=False, default='long'):
2454
log_format = default
2458
log_format = 'short'
2464
class cmd_touching_revisions(Command):
2465
__doc__ = """Return revision-ids which affected a particular file.
2467
A more user-friendly interface is "bzr log FILE".
2471
takes_args = ["filename"]
2474
def run(self, filename):
2475
tree, relpath = WorkingTree.open_containing(filename)
2476
file_id = tree.path2id(relpath)
2478
self.add_cleanup(b.lock_read().unlock)
2479
touching_revs = log.find_touching_revisions(b, file_id)
2480
for revno, revision_id, what in touching_revs:
2481
self.outf.write("%6d %s\n" % (revno, what))
2484
class cmd_ls(Command):
2485
__doc__ = """List files in a tree.
2488
_see_also = ['status', 'cat']
2489
takes_args = ['path?']
2493
Option('recursive', short_name='R',
2494
help='Recurse into subdirectories.'),
2496
help='Print paths relative to the root of the branch.'),
2497
Option('unknown', short_name='u',
2498
help='Print unknown files.'),
2499
Option('versioned', help='Print versioned files.',
2501
Option('ignored', short_name='i',
2502
help='Print ignored files.'),
2503
Option('kind', short_name='k',
2504
help='List entries of a particular kind: file, directory, symlink.',
2511
def run(self, revision=None, verbose=False,
2512
recursive=False, from_root=False,
2513
unknown=False, versioned=False, ignored=False,
2514
null=False, kind=None, show_ids=False, path=None, directory=None):
2516
if kind and kind not in ('file', 'directory', 'symlink'):
2517
raise errors.BzrCommandError('invalid kind specified')
2519
if verbose and null:
2520
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2521
all = not (unknown or versioned or ignored)
2523
selection = {'I':ignored, '?':unknown, 'V':versioned}
2529
raise errors.BzrCommandError('cannot specify both --from-root'
2532
tree, branch, relpath = \
2533
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2535
# Calculate the prefix to use
2539
prefix = relpath + '/'
2540
elif fs_path != '.' and not fs_path.endswith('/'):
2541
prefix = fs_path + '/'
2543
if revision is not None or tree is None:
2544
tree = _get_one_revision_tree('ls', revision, branch=branch)
2547
if isinstance(tree, WorkingTree) and tree.supports_views():
2548
view_files = tree.views.lookup_view()
2551
view_str = views.view_display_str(view_files)
2552
note("Ignoring files outside view. View is %s" % view_str)
2554
self.add_cleanup(tree.lock_read().unlock)
2555
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2556
from_dir=relpath, recursive=recursive):
2557
# Apply additional masking
2558
if not all and not selection[fc]:
2560
if kind is not None and fkind != kind:
2565
fullpath = osutils.pathjoin(relpath, fp)
2568
views.check_path_in_view(tree, fullpath)
2569
except errors.FileOutsideView:
2574
fp = osutils.pathjoin(prefix, fp)
2575
kindch = entry.kind_character()
2576
outstring = fp + kindch
2577
ui.ui_factory.clear_term()
2579
outstring = '%-8s %s' % (fc, outstring)
2580
if show_ids and fid is not None:
2581
outstring = "%-50s %s" % (outstring, fid)
2582
self.outf.write(outstring + '\n')
2584
self.outf.write(fp + '\0')
2587
self.outf.write(fid)
2588
self.outf.write('\0')
2596
self.outf.write('%-50s %s\n' % (outstring, my_id))
2598
self.outf.write(outstring + '\n')
2601
class cmd_unknowns(Command):
2602
__doc__ = """List unknown files.
2607
takes_options = ['directory']
2610
def run(self, directory=u'.'):
2611
for f in WorkingTree.open_containing(directory)[0].unknowns():
2612
self.outf.write(osutils.quotefn(f) + '\n')
2615
class cmd_ignore(Command):
2616
__doc__ = """Ignore specified files or patterns.
2618
See ``bzr help patterns`` for details on the syntax of patterns.
2620
If a .bzrignore file does not exist, the ignore command
2621
will create one and add the specified files or patterns to the newly
2622
created file. The ignore command will also automatically add the
2623
.bzrignore file to be versioned. Creating a .bzrignore file without
2624
the use of the ignore command will require an explicit add command.
2626
To remove patterns from the ignore list, edit the .bzrignore file.
2627
After adding, editing or deleting that file either indirectly by
2628
using this command or directly by using an editor, be sure to commit
2631
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2632
the global ignore file can be found in the application data directory as
2633
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2634
Global ignores are not touched by this command. The global ignore file
2635
can be edited directly using an editor.
2637
Patterns prefixed with '!' are exceptions to ignore patterns and take
2638
precedence over regular ignores. Such exceptions are used to specify
2639
files that should be versioned which would otherwise be ignored.
2641
Patterns prefixed with '!!' act as regular ignore patterns, but have
2642
precedence over the '!' exception patterns.
2644
Note: ignore patterns containing shell wildcards must be quoted from
2648
Ignore the top level Makefile::
2650
bzr ignore ./Makefile
2652
Ignore .class files in all directories...::
2654
bzr ignore "*.class"
2656
...but do not ignore "special.class"::
2658
bzr ignore "!special.class"
2660
Ignore .o files under the lib directory::
2662
bzr ignore "lib/**/*.o"
2664
Ignore .o files under the lib directory::
2666
bzr ignore "RE:lib/.*\.o"
2668
Ignore everything but the "debian" toplevel directory::
2670
bzr ignore "RE:(?!debian/).*"
2672
Ignore everything except the "local" toplevel directory,
2673
but always ignore "*~" autosave files, even under local/::
2676
bzr ignore "!./local"
2680
_see_also = ['status', 'ignored', 'patterns']
2681
takes_args = ['name_pattern*']
2682
takes_options = ['directory',
2683
Option('default-rules',
2684
help='Display the default ignore rules that bzr uses.')
2687
def run(self, name_pattern_list=None, default_rules=None,
2689
from bzrlib import ignores
2690
if default_rules is not None:
2691
# dump the default rules and exit
2692
for pattern in ignores.USER_DEFAULTS:
2693
self.outf.write("%s\n" % pattern)
2695
if not name_pattern_list:
2696
raise errors.BzrCommandError("ignore requires at least one "
2697
"NAME_PATTERN or --default-rules.")
2698
name_pattern_list = [globbing.normalize_pattern(p)
2699
for p in name_pattern_list]
2701
for p in name_pattern_list:
2702
if not globbing.Globster.is_pattern_valid(p):
2703
bad_patterns += ('\n %s' % p)
2705
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2706
ui.ui_factory.show_error(msg)
2707
raise errors.InvalidPattern('')
2708
for name_pattern in name_pattern_list:
2709
if (name_pattern[0] == '/' or
2710
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2711
raise errors.BzrCommandError(
2712
"NAME_PATTERN should not be an absolute path")
2713
tree, relpath = WorkingTree.open_containing(directory)
2714
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2715
ignored = globbing.Globster(name_pattern_list)
2717
self.add_cleanup(tree.lock_read().unlock)
2718
for entry in tree.list_files():
2722
if ignored.match(filename):
2723
matches.append(filename)
2724
if len(matches) > 0:
2725
self.outf.write("Warning: the following files are version controlled and"
2726
" match your ignore pattern:\n%s"
2727
"\nThese files will continue to be version controlled"
2728
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2731
class cmd_ignored(Command):
2732
__doc__ = """List ignored files and the patterns that matched them.
2734
List all the ignored files and the ignore pattern that caused the file to
2737
Alternatively, to list just the files::
2742
encoding_type = 'replace'
2743
_see_also = ['ignore', 'ls']
2744
takes_options = ['directory']
2747
def run(self, directory=u'.'):
2748
tree = WorkingTree.open_containing(directory)[0]
2749
self.add_cleanup(tree.lock_read().unlock)
2750
for path, file_class, kind, file_id, entry in tree.list_files():
2751
if file_class != 'I':
2753
## XXX: Slightly inefficient since this was already calculated
2754
pat = tree.is_ignored(path)
2755
self.outf.write('%-50s %s\n' % (path, pat))
2758
class cmd_lookup_revision(Command):
2759
__doc__ = """Lookup the revision-id from a revision-number
2762
bzr lookup-revision 33
2765
takes_args = ['revno']
2766
takes_options = ['directory']
2769
def run(self, revno, directory=u'.'):
2773
raise errors.BzrCommandError("not a valid revision-number: %r"
2775
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2776
self.outf.write("%s\n" % revid)
2779
class cmd_export(Command):
2780
__doc__ = """Export current or past revision to a destination directory or archive.
2782
If no revision is specified this exports the last committed revision.
2784
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2785
given, try to find the format with the extension. If no extension
2786
is found exports to a directory (equivalent to --format=dir).
2788
If root is supplied, it will be used as the root directory inside
2789
container formats (tar, zip, etc). If it is not supplied it will default
2790
to the exported filename. The root option has no effect for 'dir' format.
2792
If branch is omitted then the branch containing the current working
2793
directory will be used.
2795
Note: Export of tree with non-ASCII filenames to zip is not supported.
2797
================= =========================
2798
Supported formats Autodetected by extension
2799
================= =========================
2802
tbz2 .tar.bz2, .tbz2
2805
================= =========================
2807
takes_args = ['dest', 'branch_or_subdir?']
2808
takes_options = ['directory',
2810
help="Type of file to export to.",
2813
Option('filters', help='Apply content filters to export the '
2814
'convenient form.'),
2817
help="Name of the root directory inside the exported file."),
2818
Option('per-file-timestamps',
2819
help='Set modification time of files to that of the last '
2820
'revision in which it was changed.'),
2822
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2823
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2824
from bzrlib.export import export
2826
if branch_or_subdir is None:
2827
tree = WorkingTree.open_containing(directory)[0]
2831
b, subdir = Branch.open_containing(branch_or_subdir)
2834
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2836
export(rev_tree, dest, format, root, subdir, filtered=filters,
2837
per_file_timestamps=per_file_timestamps)
2838
except errors.NoSuchExportFormat, e:
2839
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2842
class cmd_cat(Command):
2843
__doc__ = """Write the contents of a file as of a given revision to standard output.
2845
If no revision is nominated, the last revision is used.
2847
Note: Take care to redirect standard output when using this command on a
2852
takes_options = ['directory',
2853
Option('name-from-revision', help='The path name in the old tree.'),
2854
Option('filters', help='Apply content filters to display the '
2855
'convenience form.'),
2858
takes_args = ['filename']
2859
encoding_type = 'exact'
2862
def run(self, filename, revision=None, name_from_revision=False,
2863
filters=False, directory=None):
2864
if revision is not None and len(revision) != 1:
2865
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2866
" one revision specifier")
2867
tree, branch, relpath = \
2868
_open_directory_or_containing_tree_or_branch(filename, directory)
2869
self.add_cleanup(branch.lock_read().unlock)
2870
return self._run(tree, branch, relpath, filename, revision,
2871
name_from_revision, filters)
2873
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2876
tree = b.basis_tree()
2877
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2878
self.add_cleanup(rev_tree.lock_read().unlock)
2880
old_file_id = rev_tree.path2id(relpath)
2882
if name_from_revision:
2883
# Try in revision if requested
2884
if old_file_id is None:
2885
raise errors.BzrCommandError(
2886
"%r is not present in revision %s" % (
2887
filename, rev_tree.get_revision_id()))
2889
content = rev_tree.get_file_text(old_file_id)
2891
cur_file_id = tree.path2id(relpath)
2893
if cur_file_id is not None:
2894
# Then try with the actual file id
2896
content = rev_tree.get_file_text(cur_file_id)
2898
except errors.NoSuchId:
2899
# The actual file id didn't exist at that time
2901
if not found and old_file_id is not None:
2902
# Finally try with the old file id
2903
content = rev_tree.get_file_text(old_file_id)
2906
# Can't be found anywhere
2907
raise errors.BzrCommandError(
2908
"%r is not present in revision %s" % (
2909
filename, rev_tree.get_revision_id()))
2911
from bzrlib.filters import (
2912
ContentFilterContext,
2913
filtered_output_bytes,
2915
filters = rev_tree._content_filter_stack(relpath)
2916
chunks = content.splitlines(True)
2917
content = filtered_output_bytes(chunks, filters,
2918
ContentFilterContext(relpath, rev_tree))
2920
self.outf.writelines(content)
2923
self.outf.write(content)
2926
class cmd_local_time_offset(Command):
2927
__doc__ = """Show the offset in seconds from GMT to local time."""
2931
self.outf.write("%s\n" % osutils.local_time_offset())
2935
class cmd_commit(Command):
2936
__doc__ = """Commit changes into a new revision.
2938
An explanatory message needs to be given for each commit. This is
2939
often done by using the --message option (getting the message from the
2940
command line) or by using the --file option (getting the message from
2941
a file). If neither of these options is given, an editor is opened for
2942
the user to enter the message. To see the changed files in the
2943
boilerplate text loaded into the editor, use the --show-diff option.
2945
By default, the entire tree is committed and the person doing the
2946
commit is assumed to be the author. These defaults can be overridden
2951
If selected files are specified, only changes to those files are
2952
committed. If a directory is specified then the directory and
2953
everything within it is committed.
2955
When excludes are given, they take precedence over selected files.
2956
For example, to commit only changes within foo, but not changes
2959
bzr commit foo -x foo/bar
2961
A selective commit after a merge is not yet supported.
2965
If the author of the change is not the same person as the committer,
2966
you can specify the author's name using the --author option. The
2967
name should be in the same format as a committer-id, e.g.
2968
"John Doe <jdoe@example.com>". If there is more than one author of
2969
the change you can specify the option multiple times, once for each
2974
A common mistake is to forget to add a new file or directory before
2975
running the commit command. The --strict option checks for unknown
2976
files and aborts the commit if any are found. More advanced pre-commit
2977
checks can be implemented by defining hooks. See ``bzr help hooks``
2982
If you accidentially commit the wrong changes or make a spelling
2983
mistake in the commit message say, you can use the uncommit command
2984
to undo it. See ``bzr help uncommit`` for details.
2986
Hooks can also be configured to run after a commit. This allows you
2987
to trigger updates to external systems like bug trackers. The --fixes
2988
option can be used to record the association between a revision and
2989
one or more bugs. See ``bzr help bugs`` for details.
2991
A selective commit may fail in some cases where the committed
2992
tree would be invalid. Consider::
2997
bzr commit foo -m "committing foo"
2998
bzr mv foo/bar foo/baz
3001
bzr commit foo/bar -m "committing bar but not baz"
3003
In the example above, the last commit will fail by design. This gives
3004
the user the opportunity to decide whether they want to commit the
3005
rename at the same time, separately first, or not at all. (As a general
3006
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3008
# TODO: Run hooks on tree to-be-committed, and after commit.
3010
# TODO: Strict commit that fails if there are deleted files.
3011
# (what does "deleted files" mean ??)
3013
# TODO: Give better message for -s, --summary, used by tla people
3015
# XXX: verbose currently does nothing
3017
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3018
takes_args = ['selected*']
3020
ListOption('exclude', type=str, short_name='x',
3021
help="Do not consider changes made to a given path."),
3022
Option('message', type=unicode,
3024
help="Description of the new revision."),
3027
help='Commit even if nothing has changed.'),
3028
Option('file', type=str,
3031
help='Take commit message from this file.'),
3033
help="Refuse to commit if there are unknown "
3034
"files in the working tree."),
3035
Option('commit-time', type=str,
3036
help="Manually set a commit time using commit date "
3037
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3038
ListOption('fixes', type=str,
3039
help="Mark a bug as being fixed by this revision "
3040
"(see \"bzr help bugs\")."),
3041
ListOption('author', type=unicode,
3042
help="Set the author's name, if it's different "
3043
"from the committer."),
3045
help="Perform a local commit in a bound "
3046
"branch. Local commits are not pushed to "
3047
"the master branch until a normal commit "
3050
Option('show-diff', short_name='p',
3051
help='When no message is supplied, show the diff along'
3052
' with the status summary in the message editor.'),
3054
aliases = ['ci', 'checkin']
3056
def _iter_bug_fix_urls(self, fixes, branch):
3057
# Configure the properties for bug fixing attributes.
3058
for fixed_bug in fixes:
3059
tokens = fixed_bug.split(':')
3060
if len(tokens) != 2:
3061
raise errors.BzrCommandError(
3062
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3063
"See \"bzr help bugs\" for more information on this "
3064
"feature.\nCommit refused." % fixed_bug)
3065
tag, bug_id = tokens
3067
yield bugtracker.get_bug_url(tag, branch, bug_id)
3068
except errors.UnknownBugTrackerAbbreviation:
3069
raise errors.BzrCommandError(
3070
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3071
except errors.MalformedBugIdentifier, e:
3072
raise errors.BzrCommandError(
3073
"%s\nCommit refused." % (str(e),))
3075
def run(self, message=None, file=None, verbose=False, selected_list=None,
3076
unchanged=False, strict=False, local=False, fixes=None,
3077
author=None, show_diff=False, exclude=None, commit_time=None):
3078
from bzrlib.errors import (
3083
from bzrlib.msgeditor import (
3084
edit_commit_message_encoded,
3085
generate_commit_message_template,
3086
make_commit_message_template_encoded
3089
commit_stamp = offset = None
3090
if commit_time is not None:
3092
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3093
except ValueError, e:
3094
raise errors.BzrCommandError(
3095
"Could not parse --commit-time: " + str(e))
3097
# TODO: Need a blackbox test for invoking the external editor; may be
3098
# slightly problematic to run this cross-platform.
3100
# TODO: do more checks that the commit will succeed before
3101
# spending the user's valuable time typing a commit message.
3105
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3106
if selected_list == ['']:
3107
# workaround - commit of root of tree should be exactly the same
3108
# as just default commit in that tree, and succeed even though
3109
# selected-file merge commit is not done yet
3114
bug_property = bugtracker.encode_fixes_bug_urls(
3115
self._iter_bug_fix_urls(fixes, tree.branch))
3117
properties['bugs'] = bug_property
3119
if local and not tree.branch.get_bound_location():
3120
raise errors.LocalRequiresBoundBranch()
3122
if message is not None:
3124
file_exists = osutils.lexists(message)
3125
except UnicodeError:
3126
# The commit message contains unicode characters that can't be
3127
# represented in the filesystem encoding, so that can't be a
3132
'The commit message is a file name: "%(f)s".\n'
3133
'(use --file "%(f)s" to take commit message from that file)'
3135
ui.ui_factory.show_warning(warning_msg)
3137
message = message.replace('\r\n', '\n')
3138
message = message.replace('\r', '\n')
3140
raise errors.BzrCommandError(
3141
"please specify either --message or --file")
3143
def get_message(commit_obj):
3144
"""Callback to get commit message"""
3148
my_message = f.read().decode(osutils.get_user_encoding())
3151
elif message is not None:
3152
my_message = message
3154
# No message supplied: make one up.
3155
# text is the status of the tree
3156
text = make_commit_message_template_encoded(tree,
3157
selected_list, diff=show_diff,
3158
output_encoding=osutils.get_user_encoding())
3159
# start_message is the template generated from hooks
3160
# XXX: Warning - looks like hooks return unicode,
3161
# make_commit_message_template_encoded returns user encoding.
3162
# We probably want to be using edit_commit_message instead to
3164
start_message = generate_commit_message_template(commit_obj)
3165
my_message = edit_commit_message_encoded(text,
3166
start_message=start_message)
3167
if my_message is None:
3168
raise errors.BzrCommandError("please specify a commit"
3169
" message with either --message or --file")
3170
if my_message == "":
3171
raise errors.BzrCommandError("empty commit message specified")
3174
# The API permits a commit with a filter of [] to mean 'select nothing'
3175
# but the command line should not do that.
3176
if not selected_list:
3177
selected_list = None
3179
tree.commit(message_callback=get_message,
3180
specific_files=selected_list,
3181
allow_pointless=unchanged, strict=strict, local=local,
3182
reporter=None, verbose=verbose, revprops=properties,
3183
authors=author, timestamp=commit_stamp,
3185
exclude=tree.safe_relpath_files(exclude))
3186
except PointlessCommit:
3187
raise errors.BzrCommandError("No changes to commit."
3188
" Use --unchanged to commit anyhow.")
3189
except ConflictsInTree:
3190
raise errors.BzrCommandError('Conflicts detected in working '
3191
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3193
except StrictCommitFailed:
3194
raise errors.BzrCommandError("Commit refused because there are"
3195
" unknown files in the working tree.")
3196
except errors.BoundBranchOutOfDate, e:
3197
e.extra_help = ("\n"
3198
'To commit to master branch, run update and then commit.\n'
3199
'You can also pass --local to commit to continue working '
3204
class cmd_check(Command):
3205
__doc__ = """Validate working tree structure, branch consistency and repository history.
3207
This command checks various invariants about branch and repository storage
3208
to detect data corruption or bzr bugs.
3210
The working tree and branch checks will only give output if a problem is
3211
detected. The output fields of the repository check are:
3214
This is just the number of revisions checked. It doesn't
3218
This is just the number of versionedfiles checked. It
3219
doesn't indicate a problem.
3221
unreferenced ancestors
3222
Texts that are ancestors of other texts, but
3223
are not properly referenced by the revision ancestry. This is a
3224
subtle problem that Bazaar can work around.
3227
This is the total number of unique file contents
3228
seen in the checked revisions. It does not indicate a problem.
3231
This is the total number of repeated texts seen
3232
in the checked revisions. Texts can be repeated when their file
3233
entries are modified, but the file contents are not. It does not
3236
If no restrictions are specified, all Bazaar data that is found at the given
3237
location will be checked.
3241
Check the tree and branch at 'foo'::
3243
bzr check --tree --branch foo
3245
Check only the repository at 'bar'::
3247
bzr check --repo bar
3249
Check everything at 'baz'::
3254
_see_also = ['reconcile']
3255
takes_args = ['path?']
3256
takes_options = ['verbose',
3257
Option('branch', help="Check the branch related to the"
3258
" current directory."),
3259
Option('repo', help="Check the repository related to the"
3260
" current directory."),
3261
Option('tree', help="Check the working tree related to"
3262
" the current directory.")]
3264
def run(self, path=None, verbose=False, branch=False, repo=False,
3266
from bzrlib.check import check_dwim
3269
if not branch and not repo and not tree:
3270
branch = repo = tree = True
3271
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3274
class cmd_upgrade(Command):
3275
__doc__ = """Upgrade branch storage to current format.
3277
The check command or bzr developers may sometimes advise you to run
3278
this command. When the default format has changed you may also be warned
3279
during other operations to upgrade.
3282
_see_also = ['check']
3283
takes_args = ['url?']
3285
RegistryOption('format',
3286
help='Upgrade to a specific format. See "bzr help'
3287
' formats" for details.',
3288
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3289
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3290
value_switches=True, title='Branch format'),
3293
def run(self, url='.', format=None):
3294
from bzrlib.upgrade import upgrade
3295
upgrade(url, format)
3298
class cmd_whoami(Command):
3299
__doc__ = """Show or set bzr user id.
3302
Show the email of the current user::
3306
Set the current user::
3308
bzr whoami "Frank Chu <fchu@example.com>"
3310
takes_options = [ 'directory',
3312
help='Display email address only.'),
3314
help='Set identity for the current branch instead of '
3317
takes_args = ['name?']
3318
encoding_type = 'replace'
3321
def run(self, email=False, branch=False, name=None, directory=None):
3323
if directory is None:
3324
# use branch if we're inside one; otherwise global config
3326
c = Branch.open_containing(u'.')[0].get_config()
3327
except errors.NotBranchError:
3328
c = _mod_config.GlobalConfig()
3330
c = Branch.open(directory).get_config()
3332
self.outf.write(c.user_email() + '\n')
3334
self.outf.write(c.username() + '\n')
3337
# display a warning if an email address isn't included in the given name.
3339
_mod_config.extract_email_address(name)
3340
except errors.NoEmailInUsername, e:
3341
warning('"%s" does not seem to contain an email address. '
3342
'This is allowed, but not recommended.', name)
3344
# use global config unless --branch given
3346
if directory is None:
3347
c = Branch.open_containing(u'.')[0].get_config()
3349
c = Branch.open(directory).get_config()
3351
c = _mod_config.GlobalConfig()
3352
c.set_user_option('email', name)
3355
class cmd_nick(Command):
3356
__doc__ = """Print or set the branch nickname.
3358
If unset, the tree root directory name is used as the nickname.
3359
To print the current nickname, execute with no argument.
3361
Bound branches use the nickname of its master branch unless it is set
3365
_see_also = ['info']
3366
takes_args = ['nickname?']
3367
takes_options = ['directory']
3368
def run(self, nickname=None, directory=u'.'):
3369
branch = Branch.open_containing(directory)[0]
3370
if nickname is None:
3371
self.printme(branch)
3373
branch.nick = nickname
3376
def printme(self, branch):
3377
self.outf.write('%s\n' % branch.nick)
3380
class cmd_alias(Command):
3381
__doc__ = """Set/unset and display aliases.
3384
Show the current aliases::
3388
Show the alias specified for 'll'::
3392
Set an alias for 'll'::
3394
bzr alias ll="log --line -r-10..-1"
3396
To remove an alias for 'll'::
3398
bzr alias --remove ll
3401
takes_args = ['name?']
3403
Option('remove', help='Remove the alias.'),
3406
def run(self, name=None, remove=False):
3408
self.remove_alias(name)
3410
self.print_aliases()
3412
equal_pos = name.find('=')
3414
self.print_alias(name)
3416
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3418
def remove_alias(self, alias_name):
3419
if alias_name is None:
3420
raise errors.BzrCommandError(
3421
'bzr alias --remove expects an alias to remove.')
3422
# If alias is not found, print something like:
3423
# unalias: foo: not found
3424
c = _mod_config.GlobalConfig()
3425
c.unset_alias(alias_name)
3428
def print_aliases(self):
3429
"""Print out the defined aliases in a similar format to bash."""
3430
aliases = _mod_config.GlobalConfig().get_aliases()
3431
for key, value in sorted(aliases.iteritems()):
3432
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3435
def print_alias(self, alias_name):
3436
from bzrlib.commands import get_alias
3437
alias = get_alias(alias_name)
3439
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3442
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3444
def set_alias(self, alias_name, alias_command):
3445
"""Save the alias in the global config."""
3446
c = _mod_config.GlobalConfig()
3447
c.set_alias(alias_name, alias_command)
3450
class cmd_selftest(Command):
3451
__doc__ = """Run internal test suite.
3453
If arguments are given, they are regular expressions that say which tests
3454
should run. Tests matching any expression are run, and other tests are
3457
Alternatively if --first is given, matching tests are run first and then
3458
all other tests are run. This is useful if you have been working in a
3459
particular area, but want to make sure nothing else was broken.
3461
If --exclude is given, tests that match that regular expression are
3462
excluded, regardless of whether they match --first or not.
3464
To help catch accidential dependencies between tests, the --randomize
3465
option is useful. In most cases, the argument used is the word 'now'.
3466
Note that the seed used for the random number generator is displayed
3467
when this option is used. The seed can be explicitly passed as the
3468
argument to this option if required. This enables reproduction of the
3469
actual ordering used if and when an order sensitive problem is encountered.
3471
If --list-only is given, the tests that would be run are listed. This is
3472
useful when combined with --first, --exclude and/or --randomize to
3473
understand their impact. The test harness reports "Listed nn tests in ..."
3474
instead of "Ran nn tests in ..." when list mode is enabled.
3476
If the global option '--no-plugins' is given, plugins are not loaded
3477
before running the selftests. This has two effects: features provided or
3478
modified by plugins will not be tested, and tests provided by plugins will
3481
Tests that need working space on disk use a common temporary directory,
3482
typically inside $TMPDIR or /tmp.
3484
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3485
into a pdb postmortem session.
3487
The --coverage=DIRNAME global option produces a report with covered code
3491
Run only tests relating to 'ignore'::
3495
Disable plugins and list tests as they're run::
3497
bzr --no-plugins selftest -v
3499
# NB: this is used from the class without creating an instance, which is
3500
# why it does not have a self parameter.
3501
def get_transport_type(typestring):
3502
"""Parse and return a transport specifier."""
3503
if typestring == "sftp":
3504
from bzrlib.tests import stub_sftp
3505
return stub_sftp.SFTPAbsoluteServer
3506
if typestring == "memory":
3507
from bzrlib.tests import test_server
3508
return memory.MemoryServer
3509
if typestring == "fakenfs":
3510
from bzrlib.tests import test_server
3511
return test_server.FakeNFSServer
3512
msg = "No known transport type %s. Supported types are: sftp\n" %\
3514
raise errors.BzrCommandError(msg)
3517
takes_args = ['testspecs*']
3518
takes_options = ['verbose',
3520
help='Stop when one test fails.',
3524
help='Use a different transport by default '
3525
'throughout the test suite.',
3526
type=get_transport_type),
3528
help='Run the benchmarks rather than selftests.',
3530
Option('lsprof-timed',
3531
help='Generate lsprof output for benchmarked'
3532
' sections of code.'),
3533
Option('lsprof-tests',
3534
help='Generate lsprof output for each test.'),
3536
help='Run all tests, but run specified tests first.',
3540
help='List the tests instead of running them.'),
3541
RegistryOption('parallel',
3542
help="Run the test suite in parallel.",
3543
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3544
value_switches=False,
3546
Option('randomize', type=str, argname="SEED",
3547
help='Randomize the order of tests using the given'
3548
' seed or "now" for the current time.'),
3549
Option('exclude', type=str, argname="PATTERN",
3551
help='Exclude tests that match this regular'
3554
help='Output test progress via subunit.'),
3555
Option('strict', help='Fail on missing dependencies or '
3557
Option('load-list', type=str, argname='TESTLISTFILE',
3558
help='Load a test id list from a text file.'),
3559
ListOption('debugflag', type=str, short_name='E',
3560
help='Turn on a selftest debug flag.'),
3561
ListOption('starting-with', type=str, argname='TESTID',
3562
param_name='starting_with', short_name='s',
3564
'Load only the tests starting with TESTID.'),
3566
encoding_type = 'replace'
3569
Command.__init__(self)
3570
self.additional_selftest_args = {}
3572
def run(self, testspecs_list=None, verbose=False, one=False,
3573
transport=None, benchmark=None,
3575
first=False, list_only=False,
3576
randomize=None, exclude=None, strict=False,
3577
load_list=None, debugflag=None, starting_with=None, subunit=False,
3578
parallel=None, lsprof_tests=False):
3579
from bzrlib import tests
3581
if testspecs_list is not None:
3582
pattern = '|'.join(testspecs_list)
3587
from bzrlib.tests import SubUnitBzrRunner
3589
raise errors.BzrCommandError("subunit not available. subunit "
3590
"needs to be installed to use --subunit.")
3591
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3592
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3593
# stdout, which would corrupt the subunit stream.
3594
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3595
# following code can be deleted when it's sufficiently deployed
3596
# -- vila/mgz 20100514
3597
if (sys.platform == "win32"
3598
and getattr(sys.stdout, 'fileno', None) is not None):
3600
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3602
self.additional_selftest_args.setdefault(
3603
'suite_decorators', []).append(parallel)
3605
raise errors.BzrCommandError(
3606
"--benchmark is no longer supported from bzr 2.2; "
3607
"use bzr-usertest instead")
3608
test_suite_factory = None
3609
selftest_kwargs = {"verbose": verbose,
3611
"stop_on_failure": one,
3612
"transport": transport,
3613
"test_suite_factory": test_suite_factory,
3614
"lsprof_timed": lsprof_timed,
3615
"lsprof_tests": lsprof_tests,
3616
"matching_tests_first": first,
3617
"list_only": list_only,
3618
"random_seed": randomize,
3619
"exclude_pattern": exclude,
3621
"load_list": load_list,
3622
"debug_flags": debugflag,
3623
"starting_with": starting_with
3625
selftest_kwargs.update(self.additional_selftest_args)
3627
# Make deprecation warnings visible, unless -Werror is set
3628
cleanup = symbol_versioning.activate_deprecation_warnings(
3631
result = tests.selftest(**selftest_kwargs)
3634
return int(not result)
3637
class cmd_version(Command):
3638
__doc__ = """Show version of bzr."""
3640
encoding_type = 'replace'
3642
Option("short", help="Print just the version number."),
3646
def run(self, short=False):
3647
from bzrlib.version import show_version
3649
self.outf.write(bzrlib.version_string + '\n')
3651
show_version(to_file=self.outf)
3654
class cmd_rocks(Command):
3655
__doc__ = """Statement of optimism."""
3661
self.outf.write("It sure does!\n")
3664
class cmd_find_merge_base(Command):
3665
__doc__ = """Find and print a base revision for merging two branches."""
3666
# TODO: Options to specify revisions on either side, as if
3667
# merging only part of the history.
3668
takes_args = ['branch', 'other']
3672
def run(self, branch, other):
3673
from bzrlib.revision import ensure_null
3675
branch1 = Branch.open_containing(branch)[0]
3676
branch2 = Branch.open_containing(other)[0]
3677
self.add_cleanup(branch1.lock_read().unlock)
3678
self.add_cleanup(branch2.lock_read().unlock)
3679
last1 = ensure_null(branch1.last_revision())
3680
last2 = ensure_null(branch2.last_revision())
3682
graph = branch1.repository.get_graph(branch2.repository)
3683
base_rev_id = graph.find_unique_lca(last1, last2)
3685
self.outf.write('merge base is revision %s\n' % base_rev_id)
3688
class cmd_merge(Command):
3689
__doc__ = """Perform a three-way merge.
3691
The source of the merge can be specified either in the form of a branch,
3692
or in the form of a path to a file containing a merge directive generated
3693
with bzr send. If neither is specified, the default is the upstream branch
3694
or the branch most recently merged using --remember.
3696
When merging a branch, by default the tip will be merged. To pick a different
3697
revision, pass --revision. If you specify two values, the first will be used as
3698
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3699
available revisions, like this is commonly referred to as "cherrypicking".
3701
Revision numbers are always relative to the branch being merged.
3703
By default, bzr will try to merge in all new work from the other
3704
branch, automatically determining an appropriate base. If this
3705
fails, you may need to give an explicit base.
3707
Merge will do its best to combine the changes in two branches, but there
3708
are some kinds of problems only a human can fix. When it encounters those,
3709
it will mark a conflict. A conflict means that you need to fix something,
3710
before you should commit.
3712
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3714
If there is no default branch set, the first merge will set it. After
3715
that, you can omit the branch to use the default. To change the
3716
default, use --remember. The value will only be saved if the remote
3717
location can be accessed.
3719
The results of the merge are placed into the destination working
3720
directory, where they can be reviewed (with bzr diff), tested, and then
3721
committed to record the result of the merge.
3723
merge refuses to run if there are any uncommitted changes, unless
3724
--force is given. The --force option can also be used to create a
3725
merge revision which has more than two parents.
3727
If one would like to merge changes from the working tree of the other
3728
branch without merging any committed revisions, the --uncommitted option
3731
To select only some changes to merge, use "merge -i", which will prompt
3732
you to apply each diff hunk and file change, similar to "shelve".
3735
To merge the latest revision from bzr.dev::
3737
bzr merge ../bzr.dev
3739
To merge changes up to and including revision 82 from bzr.dev::
3741
bzr merge -r 82 ../bzr.dev
3743
To merge the changes introduced by 82, without previous changes::
3745
bzr merge -r 81..82 ../bzr.dev
3747
To apply a merge directive contained in /tmp/merge::
3749
bzr merge /tmp/merge
3751
To create a merge revision with three parents from two branches
3752
feature1a and feature1b:
3754
bzr merge ../feature1a
3755
bzr merge ../feature1b --force
3756
bzr commit -m 'revision with three parents'
3759
encoding_type = 'exact'
3760
_see_also = ['update', 'remerge', 'status-flags', 'send']
3761
takes_args = ['location?']
3766
help='Merge even if the destination tree has uncommitted changes.'),
3770
Option('show-base', help="Show base revision text in "
3772
Option('uncommitted', help='Apply uncommitted changes'
3773
' from a working copy, instead of branch changes.'),
3774
Option('pull', help='If the destination is already'
3775
' completely merged into the source, pull from the'
3776
' source rather than merging. When this happens,'
3777
' you do not need to commit the result.'),
3778
custom_help('directory',
3779
help='Branch to merge into, '
3780
'rather than the one containing the working directory.'),
3781
Option('preview', help='Instead of merging, show a diff of the'
3783
Option('interactive', help='Select changes interactively.',
3787
def run(self, location=None, revision=None, force=False,
3788
merge_type=None, show_base=False, reprocess=None, remember=False,
3789
uncommitted=False, pull=False,
3794
if merge_type is None:
3795
merge_type = _mod_merge.Merge3Merger
3797
if directory is None: directory = u'.'
3798
possible_transports = []
3800
allow_pending = True
3801
verified = 'inapplicable'
3802
tree = WorkingTree.open_containing(directory)[0]
3805
basis_tree = tree.revision_tree(tree.last_revision())
3806
except errors.NoSuchRevision:
3807
basis_tree = tree.basis_tree()
3809
# die as quickly as possible if there are uncommitted changes
3811
if tree.has_changes():
3812
raise errors.UncommittedChanges(tree)
3814
view_info = _get_view_info_for_change_reporter(tree)
3815
change_reporter = delta._ChangeReporter(
3816
unversioned_filter=tree.is_ignored, view_info=view_info)
3817
pb = ui.ui_factory.nested_progress_bar()
3818
self.add_cleanup(pb.finished)
3819
self.add_cleanup(tree.lock_write().unlock)
3820
if location is not None:
3822
mergeable = bundle.read_mergeable_from_url(location,
3823
possible_transports=possible_transports)
3824
except errors.NotABundle:
3828
raise errors.BzrCommandError('Cannot use --uncommitted'
3829
' with bundles or merge directives.')
3831
if revision is not None:
3832
raise errors.BzrCommandError(
3833
'Cannot use -r with merge directives or bundles')
3834
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3837
if merger is None and uncommitted:
3838
if revision is not None and len(revision) > 0:
3839
raise errors.BzrCommandError('Cannot use --uncommitted and'
3840
' --revision at the same time.')
3841
merger = self.get_merger_from_uncommitted(tree, location, None)
3842
allow_pending = False
3845
merger, allow_pending = self._get_merger_from_branch(tree,
3846
location, revision, remember, possible_transports, None)
3848
merger.merge_type = merge_type
3849
merger.reprocess = reprocess
3850
merger.show_base = show_base
3851
self.sanity_check_merger(merger)
3852
if (merger.base_rev_id == merger.other_rev_id and
3853
merger.other_rev_id is not None):
3854
note('Nothing to do.')
3857
if merger.interesting_files is not None:
3858
raise errors.BzrCommandError('Cannot pull individual files')
3859
if (merger.base_rev_id == tree.last_revision()):
3860
result = tree.pull(merger.other_branch, False,
3861
merger.other_rev_id)
3862
result.report(self.outf)
3864
if merger.this_basis is None:
3865
raise errors.BzrCommandError(
3866
"This branch has no commits."
3867
" (perhaps you would prefer 'bzr pull')")
3869
return self._do_preview(merger)
3871
return self._do_interactive(merger)
3873
return self._do_merge(merger, change_reporter, allow_pending,
3876
def _get_preview(self, merger):
3877
tree_merger = merger.make_merger()
3878
tt = tree_merger.make_preview_transform()
3879
self.add_cleanup(tt.finalize)
3880
result_tree = tt.get_preview_tree()
3883
def _do_preview(self, merger):
3884
from bzrlib.diff import show_diff_trees
3885
result_tree = self._get_preview(merger)
3886
path_encoding = osutils.get_diff_header_encoding()
3887
show_diff_trees(merger.this_tree, result_tree, self.outf,
3888
old_label='', new_label='',
3889
path_encoding=path_encoding)
3891
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3892
merger.change_reporter = change_reporter
3893
conflict_count = merger.do_merge()
3895
merger.set_pending()
3896
if verified == 'failed':
3897
warning('Preview patch does not match changes')
3898
if conflict_count != 0:
3903
def _do_interactive(self, merger):
3904
"""Perform an interactive merge.
3906
This works by generating a preview tree of the merge, then using
3907
Shelver to selectively remove the differences between the working tree
3908
and the preview tree.
3910
from bzrlib import shelf_ui
3911
result_tree = self._get_preview(merger)
3912
writer = bzrlib.option.diff_writer_registry.get()
3913
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3914
reporter=shelf_ui.ApplyReporter(),
3915
diff_writer=writer(sys.stdout))
3921
def sanity_check_merger(self, merger):
3922
if (merger.show_base and
3923
not merger.merge_type is _mod_merge.Merge3Merger):
3924
raise errors.BzrCommandError("Show-base is not supported for this"
3925
" merge type. %s" % merger.merge_type)
3926
if merger.reprocess is None:
3927
if merger.show_base:
3928
merger.reprocess = False
3930
# Use reprocess if the merger supports it
3931
merger.reprocess = merger.merge_type.supports_reprocess
3932
if merger.reprocess and not merger.merge_type.supports_reprocess:
3933
raise errors.BzrCommandError("Conflict reduction is not supported"
3934
" for merge type %s." %
3936
if merger.reprocess and merger.show_base:
3937
raise errors.BzrCommandError("Cannot do conflict reduction and"
3940
def _get_merger_from_branch(self, tree, location, revision, remember,
3941
possible_transports, pb):
3942
"""Produce a merger from a location, assuming it refers to a branch."""
3943
from bzrlib.tag import _merge_tags_if_possible
3944
# find the branch locations
3945
other_loc, user_location = self._select_branch_location(tree, location,
3947
if revision is not None and len(revision) == 2:
3948
base_loc, _unused = self._select_branch_location(tree,
3949
location, revision, 0)
3951
base_loc = other_loc
3953
other_branch, other_path = Branch.open_containing(other_loc,
3954
possible_transports)
3955
if base_loc == other_loc:
3956
base_branch = other_branch
3958
base_branch, base_path = Branch.open_containing(base_loc,
3959
possible_transports)
3960
# Find the revision ids
3961
other_revision_id = None
3962
base_revision_id = None
3963
if revision is not None:
3964
if len(revision) >= 1:
3965
other_revision_id = revision[-1].as_revision_id(other_branch)
3966
if len(revision) == 2:
3967
base_revision_id = revision[0].as_revision_id(base_branch)
3968
if other_revision_id is None:
3969
other_revision_id = _mod_revision.ensure_null(
3970
other_branch.last_revision())
3971
# Remember where we merge from
3972
if ((remember or tree.branch.get_submit_branch() is None) and
3973
user_location is not None):
3974
tree.branch.set_submit_branch(other_branch.base)
3975
_merge_tags_if_possible(other_branch, tree.branch)
3976
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3977
other_revision_id, base_revision_id, other_branch, base_branch)
3978
if other_path != '':
3979
allow_pending = False
3980
merger.interesting_files = [other_path]
3982
allow_pending = True
3983
return merger, allow_pending
3985
def get_merger_from_uncommitted(self, tree, location, pb):
3986
"""Get a merger for uncommitted changes.
3988
:param tree: The tree the merger should apply to.
3989
:param location: The location containing uncommitted changes.
3990
:param pb: The progress bar to use for showing progress.
3992
location = self._select_branch_location(tree, location)[0]
3993
other_tree, other_path = WorkingTree.open_containing(location)
3994
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3995
if other_path != '':
3996
merger.interesting_files = [other_path]
3999
def _select_branch_location(self, tree, user_location, revision=None,
4001
"""Select a branch location, according to possible inputs.
4003
If provided, branches from ``revision`` are preferred. (Both
4004
``revision`` and ``index`` must be supplied.)
4006
Otherwise, the ``location`` parameter is used. If it is None, then the
4007
``submit`` or ``parent`` location is used, and a note is printed.
4009
:param tree: The working tree to select a branch for merging into
4010
:param location: The location entered by the user
4011
:param revision: The revision parameter to the command
4012
:param index: The index to use for the revision parameter. Negative
4013
indices are permitted.
4014
:return: (selected_location, user_location). The default location
4015
will be the user-entered location.
4017
if (revision is not None and index is not None
4018
and revision[index] is not None):
4019
branch = revision[index].get_branch()
4020
if branch is not None:
4021
return branch, branch
4022
if user_location is None:
4023
location = self._get_remembered(tree, 'Merging from')
4025
location = user_location
4026
return location, user_location
4028
def _get_remembered(self, tree, verb_string):
4029
"""Use tree.branch's parent if none was supplied.
4031
Report if the remembered location was used.
4033
stored_location = tree.branch.get_submit_branch()
4034
stored_location_type = "submit"
4035
if stored_location is None:
4036
stored_location = tree.branch.get_parent()
4037
stored_location_type = "parent"
4038
mutter("%s", stored_location)
4039
if stored_location is None:
4040
raise errors.BzrCommandError("No location specified or remembered")
4041
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4042
note(u"%s remembered %s location %s", verb_string,
4043
stored_location_type, display_url)
4044
return stored_location
4047
class cmd_remerge(Command):
4048
__doc__ = """Redo a merge.
4050
Use this if you want to try a different merge technique while resolving
4051
conflicts. Some merge techniques are better than others, and remerge
4052
lets you try different ones on different files.
4054
The options for remerge have the same meaning and defaults as the ones for
4055
merge. The difference is that remerge can (only) be run when there is a
4056
pending merge, and it lets you specify particular files.
4059
Re-do the merge of all conflicted files, and show the base text in
4060
conflict regions, in addition to the usual THIS and OTHER texts::
4062
bzr remerge --show-base
4064
Re-do the merge of "foobar", using the weave merge algorithm, with
4065
additional processing to reduce the size of conflict regions::
4067
bzr remerge --merge-type weave --reprocess foobar
4069
takes_args = ['file*']
4074
help="Show base revision text in conflicts."),
4077
def run(self, file_list=None, merge_type=None, show_base=False,
4079
from bzrlib.conflicts import restore
4080
if merge_type is None:
4081
merge_type = _mod_merge.Merge3Merger
4082
tree, file_list = WorkingTree.open_containing_paths(file_list)
4083
self.add_cleanup(tree.lock_write().unlock)
4084
parents = tree.get_parent_ids()
4085
if len(parents) != 2:
4086
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4087
" merges. Not cherrypicking or"
4089
repository = tree.branch.repository
4090
interesting_ids = None
4092
conflicts = tree.conflicts()
4093
if file_list is not None:
4094
interesting_ids = set()
4095
for filename in file_list:
4096
file_id = tree.path2id(filename)
4098
raise errors.NotVersionedError(filename)
4099
interesting_ids.add(file_id)
4100
if tree.kind(file_id) != "directory":
4103
for name, ie in tree.inventory.iter_entries(file_id):
4104
interesting_ids.add(ie.file_id)
4105
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4107
# Remerge only supports resolving contents conflicts
4108
allowed_conflicts = ('text conflict', 'contents conflict')
4109
restore_files = [c.path for c in conflicts
4110
if c.typestring in allowed_conflicts]
4111
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4112
tree.set_conflicts(ConflictList(new_conflicts))
4113
if file_list is not None:
4114
restore_files = file_list
4115
for filename in restore_files:
4117
restore(tree.abspath(filename))
4118
except errors.NotConflicted:
4120
# Disable pending merges, because the file texts we are remerging
4121
# have not had those merges performed. If we use the wrong parents
4122
# list, we imply that the working tree text has seen and rejected
4123
# all the changes from the other tree, when in fact those changes
4124
# have not yet been seen.
4125
tree.set_parent_ids(parents[:1])
4127
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4128
merger.interesting_ids = interesting_ids
4129
merger.merge_type = merge_type
4130
merger.show_base = show_base
4131
merger.reprocess = reprocess
4132
conflicts = merger.do_merge()
4134
tree.set_parent_ids(parents)
4141
class cmd_revert(Command):
4142
__doc__ = """Revert files to a previous revision.
4144
Giving a list of files will revert only those files. Otherwise, all files
4145
will be reverted. If the revision is not specified with '--revision', the
4146
last committed revision is used.
4148
To remove only some changes, without reverting to a prior version, use
4149
merge instead. For example, "merge . --revision -2..-3" will remove the
4150
changes introduced by -2, without affecting the changes introduced by -1.
4151
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4153
By default, any files that have been manually changed will be backed up
4154
first. (Files changed only by merge are not backed up.) Backup files have
4155
'.~#~' appended to their name, where # is a number.
4157
When you provide files, you can use their current pathname or the pathname
4158
from the target revision. So you can use revert to "undelete" a file by
4159
name. If you name a directory, all the contents of that directory will be
4162
If you have newly added files since the target revision, they will be
4163
removed. If the files to be removed have been changed, backups will be
4164
created as above. Directories containing unknown files will not be
4167
The working tree contains a list of revisions that have been merged but
4168
not yet committed. These revisions will be included as additional parents
4169
of the next commit. Normally, using revert clears that list as well as
4170
reverting the files. If any files are specified, revert leaves the list
4171
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4172
.`` in the tree root to revert all files but keep the recorded merges,
4173
and ``bzr revert --forget-merges`` to clear the pending merge list without
4174
reverting any files.
4176
Using "bzr revert --forget-merges", it is possible to apply all of the
4177
changes from a branch in a single revision. To do this, perform the merge
4178
as desired. Then doing revert with the "--forget-merges" option will keep
4179
the content of the tree as it was, but it will clear the list of pending
4180
merges. The next commit will then contain all of the changes that are
4181
present in the other branch, but without any other parent revisions.
4182
Because this technique forgets where these changes originated, it may
4183
cause additional conflicts on later merges involving the same source and
4187
_see_also = ['cat', 'export']
4190
Option('no-backup', "Do not save backups of reverted files."),
4191
Option('forget-merges',
4192
'Remove pending merge marker, without changing any files.'),
4194
takes_args = ['file*']
4196
def run(self, revision=None, no_backup=False, file_list=None,
4197
forget_merges=None):
4198
tree, file_list = WorkingTree.open_containing_paths(file_list)
4199
self.add_cleanup(tree.lock_tree_write().unlock)
4201
tree.set_parent_ids(tree.get_parent_ids()[:1])
4203
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4206
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4207
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4208
tree.revert(file_list, rev_tree, not no_backup, None,
4209
report_changes=True)
4212
class cmd_assert_fail(Command):
4213
__doc__ = """Test reporting of assertion failures"""
4214
# intended just for use in testing
4219
raise AssertionError("always fails")
4222
class cmd_help(Command):
4223
__doc__ = """Show help on a command or other topic.
4226
_see_also = ['topics']
4228
Option('long', 'Show help on all commands.'),
4230
takes_args = ['topic?']
4231
aliases = ['?', '--help', '-?', '-h']
4234
def run(self, topic=None, long=False):
4236
if topic is None and long:
4238
bzrlib.help.help(topic)
4241
class cmd_shell_complete(Command):
4242
__doc__ = """Show appropriate completions for context.
4244
For a list of all available commands, say 'bzr shell-complete'.
4246
takes_args = ['context?']
4251
def run(self, context=None):
4252
import shellcomplete
4253
shellcomplete.shellcomplete(context)
4256
class cmd_missing(Command):
4257
__doc__ = """Show unmerged/unpulled revisions between two branches.
4259
OTHER_BRANCH may be local or remote.
4261
To filter on a range of revisions, you can use the command -r begin..end
4262
-r revision requests a specific revision, -r ..end or -r begin.. are
4266
1 - some missing revisions
4267
0 - no missing revisions
4271
Determine the missing revisions between this and the branch at the
4272
remembered pull location::
4276
Determine the missing revisions between this and another branch::
4278
bzr missing http://server/branch
4280
Determine the missing revisions up to a specific revision on the other
4283
bzr missing -r ..-10
4285
Determine the missing revisions up to a specific revision on this
4288
bzr missing --my-revision ..-10
4291
_see_also = ['merge', 'pull']
4292
takes_args = ['other_branch?']
4295
Option('reverse', 'Reverse the order of revisions.'),
4297
'Display changes in the local branch only.'),
4298
Option('this' , 'Same as --mine-only.'),
4299
Option('theirs-only',
4300
'Display changes in the remote branch only.'),
4301
Option('other', 'Same as --theirs-only.'),
4305
custom_help('revision',
4306
help='Filter on other branch revisions (inclusive). '
4307
'See "help revisionspec" for details.'),
4308
Option('my-revision',
4309
type=_parse_revision_str,
4310
help='Filter on local branch revisions (inclusive). '
4311
'See "help revisionspec" for details.'),
4312
Option('include-merges',
4313
'Show all revisions in addition to the mainline ones.'),
4315
encoding_type = 'replace'
4318
def run(self, other_branch=None, reverse=False, mine_only=False,
4320
log_format=None, long=False, short=False, line=False,
4321
show_ids=False, verbose=False, this=False, other=False,
4322
include_merges=False, revision=None, my_revision=None,
4324
from bzrlib.missing import find_unmerged, iter_log_revisions
4333
# TODO: We should probably check that we don't have mine-only and
4334
# theirs-only set, but it gets complicated because we also have
4335
# this and other which could be used.
4342
local_branch = Branch.open_containing(directory)[0]
4343
self.add_cleanup(local_branch.lock_read().unlock)
4345
parent = local_branch.get_parent()
4346
if other_branch is None:
4347
other_branch = parent
4348
if other_branch is None:
4349
raise errors.BzrCommandError("No peer location known"
4351
display_url = urlutils.unescape_for_display(parent,
4353
message("Using saved parent location: "
4354
+ display_url + "\n")
4356
remote_branch = Branch.open(other_branch)
4357
if remote_branch.base == local_branch.base:
4358
remote_branch = local_branch
4360
self.add_cleanup(remote_branch.lock_read().unlock)
4362
local_revid_range = _revision_range_to_revid_range(
4363
_get_revision_range(my_revision, local_branch,
4366
remote_revid_range = _revision_range_to_revid_range(
4367
_get_revision_range(revision,
4368
remote_branch, self.name()))
4370
local_extra, remote_extra = find_unmerged(
4371
local_branch, remote_branch, restrict,
4372
backward=not reverse,
4373
include_merges=include_merges,
4374
local_revid_range=local_revid_range,
4375
remote_revid_range=remote_revid_range)
4377
if log_format is None:
4378
registry = log.log_formatter_registry
4379
log_format = registry.get_default(local_branch)
4380
lf = log_format(to_file=self.outf,
4382
show_timezone='original')
4385
if local_extra and not theirs_only:
4386
message("You have %d extra revision(s):\n" %
4388
for revision in iter_log_revisions(local_extra,
4389
local_branch.repository,
4391
lf.log_revision(revision)
4392
printed_local = True
4395
printed_local = False
4397
if remote_extra and not mine_only:
4398
if printed_local is True:
4400
message("You are missing %d revision(s):\n" %
4402
for revision in iter_log_revisions(remote_extra,
4403
remote_branch.repository,
4405
lf.log_revision(revision)
4408
if mine_only and not local_extra:
4409
# We checked local, and found nothing extra
4410
message('This branch is up to date.\n')
4411
elif theirs_only and not remote_extra:
4412
# We checked remote, and found nothing extra
4413
message('Other branch is up to date.\n')
4414
elif not (mine_only or theirs_only or local_extra or
4416
# We checked both branches, and neither one had extra
4418
message("Branches are up to date.\n")
4420
if not status_code and parent is None and other_branch is not None:
4421
self.add_cleanup(local_branch.lock_write().unlock)
4422
# handle race conditions - a parent might be set while we run.
4423
if local_branch.get_parent() is None:
4424
local_branch.set_parent(remote_branch.base)
4428
class cmd_pack(Command):
4429
__doc__ = """Compress the data within a repository.
4431
This operation compresses the data within a bazaar repository. As
4432
bazaar supports automatic packing of repository, this operation is
4433
normally not required to be done manually.
4435
During the pack operation, bazaar takes a backup of existing repository
4436
data, i.e. pack files. This backup is eventually removed by bazaar
4437
automatically when it is safe to do so. To save disk space by removing
4438
the backed up pack files, the --clean-obsolete-packs option may be
4441
Warning: If you use --clean-obsolete-packs and your machine crashes
4442
during or immediately after repacking, you may be left with a state
4443
where the deletion has been written to disk but the new packs have not
4444
been. In this case the repository may be unusable.
4447
_see_also = ['repositories']
4448
takes_args = ['branch_or_repo?']
4450
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4453
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4454
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4456
branch = dir.open_branch()
4457
repository = branch.repository
4458
except errors.NotBranchError:
4459
repository = dir.open_repository()
4460
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4463
class cmd_plugins(Command):
4464
__doc__ = """List the installed plugins.
4466
This command displays the list of installed plugins including
4467
version of plugin and a short description of each.
4469
--verbose shows the path where each plugin is located.
4471
A plugin is an external component for Bazaar that extends the
4472
revision control system, by adding or replacing code in Bazaar.
4473
Plugins can do a variety of things, including overriding commands,
4474
adding new commands, providing additional network transports and
4475
customizing log output.
4477
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4478
for further information on plugins including where to find them and how to
4479
install them. Instructions are also provided there on how to write new
4480
plugins using the Python programming language.
4482
takes_options = ['verbose']
4485
def run(self, verbose=False):
4486
import bzrlib.plugin
4487
from inspect import getdoc
4489
for name, plugin in bzrlib.plugin.plugins().items():
4490
version = plugin.__version__
4491
if version == 'unknown':
4493
name_ver = '%s %s' % (name, version)
4494
d = getdoc(plugin.module)
4496
doc = d.split('\n')[0]
4498
doc = '(no description)'
4499
result.append((name_ver, doc, plugin.path()))
4500
for name_ver, doc, path in sorted(result):
4501
self.outf.write("%s\n" % name_ver)
4502
self.outf.write(" %s\n" % doc)
4504
self.outf.write(" %s\n" % path)
4505
self.outf.write("\n")
4508
class cmd_testament(Command):
4509
__doc__ = """Show testament (signing-form) of a revision."""
4512
Option('long', help='Produce long-format testament.'),
4514
help='Produce a strict-format testament.')]
4515
takes_args = ['branch?']
4517
def run(self, branch=u'.', revision=None, long=False, strict=False):
4518
from bzrlib.testament import Testament, StrictTestament
4520
testament_class = StrictTestament
4522
testament_class = Testament
4524
b = Branch.open_containing(branch)[0]
4526
b = Branch.open(branch)
4527
self.add_cleanup(b.lock_read().unlock)
4528
if revision is None:
4529
rev_id = b.last_revision()
4531
rev_id = revision[0].as_revision_id(b)
4532
t = testament_class.from_revision(b.repository, rev_id)
4534
sys.stdout.writelines(t.as_text_lines())
4536
sys.stdout.write(t.as_short_text())
4539
class cmd_annotate(Command):
4540
__doc__ = """Show the origin of each line in a file.
4542
This prints out the given file with an annotation on the left side
4543
indicating which revision, author and date introduced the change.
4545
If the origin is the same for a run of consecutive lines, it is
4546
shown only at the top, unless the --all option is given.
4548
# TODO: annotate directories; showing when each file was last changed
4549
# TODO: if the working copy is modified, show annotations on that
4550
# with new uncommitted lines marked
4551
aliases = ['ann', 'blame', 'praise']
4552
takes_args = ['filename']
4553
takes_options = [Option('all', help='Show annotations on all lines.'),
4554
Option('long', help='Show commit date in annotations.'),
4559
encoding_type = 'exact'
4562
def run(self, filename, all=False, long=False, revision=None,
4563
show_ids=False, directory=None):
4564
from bzrlib.annotate import annotate_file, annotate_file_tree
4565
wt, branch, relpath = \
4566
_open_directory_or_containing_tree_or_branch(filename, directory)
4568
self.add_cleanup(wt.lock_read().unlock)
4570
self.add_cleanup(branch.lock_read().unlock)
4571
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4572
self.add_cleanup(tree.lock_read().unlock)
4574
file_id = wt.path2id(relpath)
4576
file_id = tree.path2id(relpath)
4578
raise errors.NotVersionedError(filename)
4579
file_version = tree.inventory[file_id].revision
4580
if wt is not None and revision is None:
4581
# If there is a tree and we're not annotating historical
4582
# versions, annotate the working tree's content.
4583
annotate_file_tree(wt, file_id, self.outf, long, all,
4586
annotate_file(branch, file_version, file_id, long, all, self.outf,
4590
class cmd_re_sign(Command):
4591
__doc__ = """Create a digital signature for an existing revision."""
4592
# TODO be able to replace existing ones.
4594
hidden = True # is this right ?
4595
takes_args = ['revision_id*']
4596
takes_options = ['directory', 'revision']
4598
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4599
if revision_id_list is not None and revision is not None:
4600
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4601
if revision_id_list is None and revision is None:
4602
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4603
b = WorkingTree.open_containing(directory)[0].branch
4604
self.add_cleanup(b.lock_write().unlock)
4605
return self._run(b, revision_id_list, revision)
4607
def _run(self, b, revision_id_list, revision):
4608
import bzrlib.gpg as gpg
4609
gpg_strategy = gpg.GPGStrategy(b.get_config())
4610
if revision_id_list is not None:
4611
b.repository.start_write_group()
4613
for revision_id in revision_id_list:
4614
b.repository.sign_revision(revision_id, gpg_strategy)
4616
b.repository.abort_write_group()
4619
b.repository.commit_write_group()
4620
elif revision is not None:
4621
if len(revision) == 1:
4622
revno, rev_id = revision[0].in_history(b)
4623
b.repository.start_write_group()
4625
b.repository.sign_revision(rev_id, gpg_strategy)
4627
b.repository.abort_write_group()
4630
b.repository.commit_write_group()
4631
elif len(revision) == 2:
4632
# are they both on rh- if so we can walk between them
4633
# might be nice to have a range helper for arbitrary
4634
# revision paths. hmm.
4635
from_revno, from_revid = revision[0].in_history(b)
4636
to_revno, to_revid = revision[1].in_history(b)
4637
if to_revid is None:
4638
to_revno = b.revno()
4639
if from_revno is None or to_revno is None:
4640
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4641
b.repository.start_write_group()
4643
for revno in range(from_revno, to_revno + 1):
4644
b.repository.sign_revision(b.get_rev_id(revno),
4647
b.repository.abort_write_group()
4650
b.repository.commit_write_group()
4652
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4655
class cmd_bind(Command):
4656
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4657
If no branch is supplied, rebind to the last bound location.
4659
Once converted into a checkout, commits must succeed on the master branch
4660
before they will be applied to the local branch.
4662
Bound branches use the nickname of its master branch unless it is set
4663
locally, in which case binding will update the local nickname to be
4667
_see_also = ['checkouts', 'unbind']
4668
takes_args = ['location?']
4669
takes_options = ['directory']
4671
def run(self, location=None, directory=u'.'):
4672
b, relpath = Branch.open_containing(directory)
4673
if location is None:
4675
location = b.get_old_bound_location()
4676
except errors.UpgradeRequired:
4677
raise errors.BzrCommandError('No location supplied. '
4678
'This format does not remember old locations.')
4680
if location is None:
4681
if b.get_bound_location() is not None:
4682
raise errors.BzrCommandError('Branch is already bound')
4684
raise errors.BzrCommandError('No location supplied '
4685
'and no previous location known')
4686
b_other = Branch.open(location)
4689
except errors.DivergedBranches:
4690
raise errors.BzrCommandError('These branches have diverged.'
4691
' Try merging, and then bind again.')
4692
if b.get_config().has_explicit_nickname():
4693
b.nick = b_other.nick
4696
class cmd_unbind(Command):
4697
__doc__ = """Convert the current checkout into a regular branch.
4699
After unbinding, the local branch is considered independent and subsequent
4700
commits will be local only.
4703
_see_also = ['checkouts', 'bind']
4705
takes_options = ['directory']
4707
def run(self, directory=u'.'):
4708
b, relpath = Branch.open_containing(directory)
4710
raise errors.BzrCommandError('Local branch is not bound')
4713
class cmd_uncommit(Command):
4714
__doc__ = """Remove the last committed revision.
4716
--verbose will print out what is being removed.
4717
--dry-run will go through all the motions, but not actually
4720
If --revision is specified, uncommit revisions to leave the branch at the
4721
specified revision. For example, "bzr uncommit -r 15" will leave the
4722
branch at revision 15.
4724
Uncommit leaves the working tree ready for a new commit. The only change
4725
it may make is to restore any pending merges that were present before
4729
# TODO: jam 20060108 Add an option to allow uncommit to remove
4730
# unreferenced information in 'branch-as-repository' branches.
4731
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4732
# information in shared branches as well.
4733
_see_also = ['commit']
4734
takes_options = ['verbose', 'revision',
4735
Option('dry-run', help='Don\'t actually make changes.'),
4736
Option('force', help='Say yes to all questions.'),
4738
help="Only remove the commits from the local branch"
4739
" when in a checkout."
4742
takes_args = ['location?']
4744
encoding_type = 'replace'
4746
def run(self, location=None,
4747
dry_run=False, verbose=False,
4748
revision=None, force=False, local=False):
4749
if location is None:
4751
control, relpath = bzrdir.BzrDir.open_containing(location)
4753
tree = control.open_workingtree()
4755
except (errors.NoWorkingTree, errors.NotLocalUrl):
4757
b = control.open_branch()
4759
if tree is not None:
4760
self.add_cleanup(tree.lock_write().unlock)
4762
self.add_cleanup(b.lock_write().unlock)
4763
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4765
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4766
from bzrlib.log import log_formatter, show_log
4767
from bzrlib.uncommit import uncommit
4769
last_revno, last_rev_id = b.last_revision_info()
4772
if revision is None:
4774
rev_id = last_rev_id
4776
# 'bzr uncommit -r 10' actually means uncommit
4777
# so that the final tree is at revno 10.
4778
# but bzrlib.uncommit.uncommit() actually uncommits
4779
# the revisions that are supplied.
4780
# So we need to offset it by one
4781
revno = revision[0].in_history(b).revno + 1
4782
if revno <= last_revno:
4783
rev_id = b.get_rev_id(revno)
4785
if rev_id is None or _mod_revision.is_null(rev_id):
4786
self.outf.write('No revisions to uncommit.\n')
4789
lf = log_formatter('short',
4791
show_timezone='original')
4796
direction='forward',
4797
start_revision=revno,
4798
end_revision=last_revno)
4801
self.outf.write('Dry-run, pretending to remove'
4802
' the above revisions.\n')
4804
self.outf.write('The above revision(s) will be removed.\n')
4807
if not ui.ui_factory.confirm_action(
4808
'Uncommit these revisions',
4809
'bzrlib.builtins.uncommit',
4811
self.outf.write('Canceled\n')
4814
mutter('Uncommitting from {%s} to {%s}',
4815
last_rev_id, rev_id)
4816
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4817
revno=revno, local=local)
4818
self.outf.write('You can restore the old tip by running:\n'
4819
' bzr pull . -r revid:%s\n' % last_rev_id)
4822
class cmd_break_lock(Command):
4823
__doc__ = """Break a dead lock.
4825
This command breaks a lock on a repository, branch, working directory or
4828
CAUTION: Locks should only be broken when you are sure that the process
4829
holding the lock has been stopped.
4831
You can get information on what locks are open via the 'bzr info
4832
[location]' command.
4836
bzr break-lock bzr+ssh://example.com/bzr/foo
4837
bzr break-lock --conf ~/.bazaar
4840
takes_args = ['location?']
4843
help='LOCATION is the directory where the config lock is.'),
4846
def run(self, location=None, config=False):
4847
if location is None:
4850
conf = _mod_config.LockableConfig(file_name=location)
4853
control, relpath = bzrdir.BzrDir.open_containing(location)
4855
control.break_lock()
4856
except NotImplementedError:
4860
class cmd_wait_until_signalled(Command):
4861
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4863
This just prints a line to signal when it is ready, then blocks on stdin.
4869
sys.stdout.write("running\n")
4871
sys.stdin.readline()
4874
class cmd_serve(Command):
4875
__doc__ = """Run the bzr server."""
4877
aliases = ['server']
4881
help='Serve on stdin/out for use from inetd or sshd.'),
4882
RegistryOption('protocol',
4883
help="Protocol to serve.",
4884
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4885
value_switches=True),
4887
help='Listen for connections on nominated port of the form '
4888
'[hostname:]portnumber. Passing 0 as the port number will '
4889
'result in a dynamically allocated port. The default port '
4890
'depends on the protocol.',
4892
custom_help('directory',
4893
help='Serve contents of this directory.'),
4894
Option('allow-writes',
4895
help='By default the server is a readonly server. Supplying '
4896
'--allow-writes enables write access to the contents of '
4897
'the served directory and below. Note that ``bzr serve`` '
4898
'does not perform authentication, so unless some form of '
4899
'external authentication is arranged supplying this '
4900
'option leads to global uncontrolled write access to your '
4905
def get_host_and_port(self, port):
4906
"""Return the host and port to run the smart server on.
4908
If 'port' is None, None will be returned for the host and port.
4910
If 'port' has a colon in it, the string before the colon will be
4911
interpreted as the host.
4913
:param port: A string of the port to run the server on.
4914
:return: A tuple of (host, port), where 'host' is a host name or IP,
4915
and port is an integer TCP/IP port.
4918
if port is not None:
4920
host, port = port.split(':')
4924
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4926
from bzrlib import transport
4927
if directory is None:
4928
directory = os.getcwd()
4929
if protocol is None:
4930
protocol = transport.transport_server_registry.get()
4931
host, port = self.get_host_and_port(port)
4932
url = urlutils.local_path_to_url(directory)
4933
if not allow_writes:
4934
url = 'readonly+' + url
4935
t = transport.get_transport(url)
4936
protocol(t, host, port, inet)
4939
class cmd_join(Command):
4940
__doc__ = """Combine a tree into its containing tree.
4942
This command requires the target tree to be in a rich-root format.
4944
The TREE argument should be an independent tree, inside another tree, but
4945
not part of it. (Such trees can be produced by "bzr split", but also by
4946
running "bzr branch" with the target inside a tree.)
4948
The result is a combined tree, with the subtree no longer an independent
4949
part. This is marked as a merge of the subtree into the containing tree,
4950
and all history is preserved.
4953
_see_also = ['split']
4954
takes_args = ['tree']
4956
Option('reference', help='Join by reference.', hidden=True),
4959
def run(self, tree, reference=False):
4960
sub_tree = WorkingTree.open(tree)
4961
parent_dir = osutils.dirname(sub_tree.basedir)
4962
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4963
repo = containing_tree.branch.repository
4964
if not repo.supports_rich_root():
4965
raise errors.BzrCommandError(
4966
"Can't join trees because %s doesn't support rich root data.\n"
4967
"You can use bzr upgrade on the repository."
4971
containing_tree.add_reference(sub_tree)
4972
except errors.BadReferenceTarget, e:
4973
# XXX: Would be better to just raise a nicely printable
4974
# exception from the real origin. Also below. mbp 20070306
4975
raise errors.BzrCommandError("Cannot join %s. %s" %
4979
containing_tree.subsume(sub_tree)
4980
except errors.BadSubsumeSource, e:
4981
raise errors.BzrCommandError("Cannot join %s. %s" %
4985
class cmd_split(Command):
4986
__doc__ = """Split a subdirectory of a tree into a separate tree.
4988
This command will produce a target tree in a format that supports
4989
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4990
converted into earlier formats like 'dirstate-tags'.
4992
The TREE argument should be a subdirectory of a working tree. That
4993
subdirectory will be converted into an independent tree, with its own
4994
branch. Commits in the top-level tree will not apply to the new subtree.
4997
_see_also = ['join']
4998
takes_args = ['tree']
5000
def run(self, tree):
5001
containing_tree, subdir = WorkingTree.open_containing(tree)
5002
sub_id = containing_tree.path2id(subdir)
5004
raise errors.NotVersionedError(subdir)
5006
containing_tree.extract(sub_id)
5007
except errors.RootNotRich:
5008
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5011
class cmd_merge_directive(Command):
5012
__doc__ = """Generate a merge directive for auto-merge tools.
5014
A directive requests a merge to be performed, and also provides all the
5015
information necessary to do so. This means it must either include a
5016
revision bundle, or the location of a branch containing the desired
5019
A submit branch (the location to merge into) must be supplied the first
5020
time the command is issued. After it has been supplied once, it will
5021
be remembered as the default.
5023
A public branch is optional if a revision bundle is supplied, but required
5024
if --diff or --plain is specified. It will be remembered as the default
5025
after the first use.
5028
takes_args = ['submit_branch?', 'public_branch?']
5032
_see_also = ['send']
5036
RegistryOption.from_kwargs('patch-type',
5037
'The type of patch to include in the directive.',
5039
value_switches=True,
5041
bundle='Bazaar revision bundle (default).',
5042
diff='Normal unified diff.',
5043
plain='No patch, just directive.'),
5044
Option('sign', help='GPG-sign the directive.'), 'revision',
5045
Option('mail-to', type=str,
5046
help='Instead of printing the directive, email to this address.'),
5047
Option('message', type=str, short_name='m',
5048
help='Message to use when committing this merge.')
5051
encoding_type = 'exact'
5053
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5054
sign=False, revision=None, mail_to=None, message=None,
5056
from bzrlib.revision import ensure_null, NULL_REVISION
5057
include_patch, include_bundle = {
5058
'plain': (False, False),
5059
'diff': (True, False),
5060
'bundle': (True, True),
5062
branch = Branch.open(directory)
5063
stored_submit_branch = branch.get_submit_branch()
5064
if submit_branch is None:
5065
submit_branch = stored_submit_branch
5067
if stored_submit_branch is None:
5068
branch.set_submit_branch(submit_branch)
5069
if submit_branch is None:
5070
submit_branch = branch.get_parent()
5071
if submit_branch is None:
5072
raise errors.BzrCommandError('No submit branch specified or known')
5074
stored_public_branch = branch.get_public_branch()
5075
if public_branch is None:
5076
public_branch = stored_public_branch
5077
elif stored_public_branch is None:
5078
branch.set_public_branch(public_branch)
5079
if not include_bundle and public_branch is None:
5080
raise errors.BzrCommandError('No public branch specified or'
5082
base_revision_id = None
5083
if revision is not None:
5084
if len(revision) > 2:
5085
raise errors.BzrCommandError('bzr merge-directive takes '
5086
'at most two one revision identifiers')
5087
revision_id = revision[-1].as_revision_id(branch)
5088
if len(revision) == 2:
5089
base_revision_id = revision[0].as_revision_id(branch)
5091
revision_id = branch.last_revision()
5092
revision_id = ensure_null(revision_id)
5093
if revision_id == NULL_REVISION:
5094
raise errors.BzrCommandError('No revisions to bundle.')
5095
directive = merge_directive.MergeDirective2.from_objects(
5096
branch.repository, revision_id, time.time(),
5097
osutils.local_time_offset(), submit_branch,
5098
public_branch=public_branch, include_patch=include_patch,
5099
include_bundle=include_bundle, message=message,
5100
base_revision_id=base_revision_id)
5103
self.outf.write(directive.to_signed(branch))
5105
self.outf.writelines(directive.to_lines())
5107
message = directive.to_email(mail_to, branch, sign)
5108
s = SMTPConnection(branch.get_config())
5109
s.send_email(message)
5112
class cmd_send(Command):
5113
__doc__ = """Mail or create a merge-directive for submitting changes.
5115
A merge directive provides many things needed for requesting merges:
5117
* A machine-readable description of the merge to perform
5119
* An optional patch that is a preview of the changes requested
5121
* An optional bundle of revision data, so that the changes can be applied
5122
directly from the merge directive, without retrieving data from a
5125
`bzr send` creates a compact data set that, when applied using bzr
5126
merge, has the same effect as merging from the source branch.
5128
By default the merge directive is self-contained and can be applied to any
5129
branch containing submit_branch in its ancestory without needing access to
5132
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5133
revisions, but only a structured request to merge from the
5134
public_location. In that case the public_branch is needed and it must be
5135
up-to-date and accessible to the recipient. The public_branch is always
5136
included if known, so that people can check it later.
5138
The submit branch defaults to the parent of the source branch, but can be
5139
overridden. Both submit branch and public branch will be remembered in
5140
branch.conf the first time they are used for a particular branch. The
5141
source branch defaults to that containing the working directory, but can
5142
be changed using --from.
5144
In order to calculate those changes, bzr must analyse the submit branch.
5145
Therefore it is most efficient for the submit branch to be a local mirror.
5146
If a public location is known for the submit_branch, that location is used
5147
in the merge directive.
5149
The default behaviour is to send the merge directive by mail, unless -o is
5150
given, in which case it is sent to a file.
5152
Mail is sent using your preferred mail program. This should be transparent
5153
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5154
If the preferred client can't be found (or used), your editor will be used.
5156
To use a specific mail program, set the mail_client configuration option.
5157
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5158
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5159
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5160
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5163
If mail is being sent, a to address is required. This can be supplied
5164
either on the commandline, by setting the submit_to configuration
5165
option in the branch itself or the child_submit_to configuration option
5166
in the submit branch.
5168
Two formats are currently supported: "4" uses revision bundle format 4 and
5169
merge directive format 2. It is significantly faster and smaller than
5170
older formats. It is compatible with Bazaar 0.19 and later. It is the
5171
default. "0.9" uses revision bundle format 0.9 and merge directive
5172
format 1. It is compatible with Bazaar 0.12 - 0.18.
5174
The merge directives created by bzr send may be applied using bzr merge or
5175
bzr pull by specifying a file containing a merge directive as the location.
5177
bzr send makes extensive use of public locations to map local locations into
5178
URLs that can be used by other people. See `bzr help configuration` to
5179
set them, and use `bzr info` to display them.
5182
encoding_type = 'exact'
5184
_see_also = ['merge', 'pull']
5186
takes_args = ['submit_branch?', 'public_branch?']
5190
help='Do not include a bundle in the merge directive.'),
5191
Option('no-patch', help='Do not include a preview patch in the merge'
5194
help='Remember submit and public branch.'),
5196
help='Branch to generate the submission from, '
5197
'rather than the one containing the working directory.',
5200
Option('output', short_name='o',
5201
help='Write merge directive to this file or directory; '
5202
'use - for stdout.',
5205
help='Refuse to send if there are uncommitted changes in'
5206
' the working tree, --no-strict disables the check.'),
5207
Option('mail-to', help='Mail the request to this address.',
5211
Option('body', help='Body for the email.', type=unicode),
5212
RegistryOption('format',
5213
help='Use the specified output format.',
5214
lazy_registry=('bzrlib.send', 'format_registry')),
5217
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5218
no_patch=False, revision=None, remember=False, output=None,
5219
format=None, mail_to=None, message=None, body=None,
5220
strict=None, **kwargs):
5221
from bzrlib.send import send
5222
return send(submit_branch, revision, public_branch, remember,
5223
format, no_bundle, no_patch, output,
5224
kwargs.get('from', '.'), mail_to, message, body,
5229
class cmd_bundle_revisions(cmd_send):
5230
__doc__ = """Create a merge-directive for submitting changes.
5232
A merge directive provides many things needed for requesting merges:
5234
* A machine-readable description of the merge to perform
5236
* An optional patch that is a preview of the changes requested
5238
* An optional bundle of revision data, so that the changes can be applied
5239
directly from the merge directive, without retrieving data from a
5242
If --no-bundle is specified, then public_branch is needed (and must be
5243
up-to-date), so that the receiver can perform the merge using the
5244
public_branch. The public_branch is always included if known, so that
5245
people can check it later.
5247
The submit branch defaults to the parent, but can be overridden. Both
5248
submit branch and public branch will be remembered if supplied.
5250
If a public_branch is known for the submit_branch, that public submit
5251
branch is used in the merge instructions. This means that a local mirror
5252
can be used as your actual submit branch, once you have set public_branch
5255
Two formats are currently supported: "4" uses revision bundle format 4 and
5256
merge directive format 2. It is significantly faster and smaller than
5257
older formats. It is compatible with Bazaar 0.19 and later. It is the
5258
default. "0.9" uses revision bundle format 0.9 and merge directive
5259
format 1. It is compatible with Bazaar 0.12 - 0.18.
5264
help='Do not include a bundle in the merge directive.'),
5265
Option('no-patch', help='Do not include a preview patch in the merge'
5268
help='Remember submit and public branch.'),
5270
help='Branch to generate the submission from, '
5271
'rather than the one containing the working directory.',
5274
Option('output', short_name='o', help='Write directive to this file.',
5277
help='Refuse to bundle revisions if there are uncommitted'
5278
' changes in the working tree, --no-strict disables the check.'),
5280
RegistryOption('format',
5281
help='Use the specified output format.',
5282
lazy_registry=('bzrlib.send', 'format_registry')),
5284
aliases = ['bundle']
5286
_see_also = ['send', 'merge']
5290
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5291
no_patch=False, revision=None, remember=False, output=None,
5292
format=None, strict=None, **kwargs):
5295
from bzrlib.send import send
5296
return send(submit_branch, revision, public_branch, remember,
5297
format, no_bundle, no_patch, output,
5298
kwargs.get('from', '.'), None, None, None,
5299
self.outf, strict=strict)
5302
class cmd_tag(Command):
5303
__doc__ = """Create, remove or modify a tag naming a revision.
5305
Tags give human-meaningful names to revisions. Commands that take a -r
5306
(--revision) option can be given -rtag:X, where X is any previously
5309
Tags are stored in the branch. Tags are copied from one branch to another
5310
along when you branch, push, pull or merge.
5312
It is an error to give a tag name that already exists unless you pass
5313
--force, in which case the tag is moved to point to the new revision.
5315
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5316
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5318
If no tag name is specified it will be determined through the
5319
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5320
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5324
_see_also = ['commit', 'tags']
5325
takes_args = ['tag_name?']
5328
help='Delete this tag rather than placing it.',
5330
custom_help('directory',
5331
help='Branch in which to place the tag.'),
5333
help='Replace existing tags.',
5338
def run(self, tag_name=None,
5344
branch, relpath = Branch.open_containing(directory)
5345
self.add_cleanup(branch.lock_write().unlock)
5347
if tag_name is None:
5348
raise errors.BzrCommandError("No tag specified to delete.")
5349
branch.tags.delete_tag(tag_name)
5350
self.outf.write('Deleted tag %s.\n' % tag_name)
5353
if len(revision) != 1:
5354
raise errors.BzrCommandError(
5355
"Tags can only be placed on a single revision, "
5357
revision_id = revision[0].as_revision_id(branch)
5359
revision_id = branch.last_revision()
5360
if tag_name is None:
5361
tag_name = branch.automatic_tag_name(revision_id)
5362
if tag_name is None:
5363
raise errors.BzrCommandError(
5364
"Please specify a tag name.")
5365
if (not force) and branch.tags.has_tag(tag_name):
5366
raise errors.TagAlreadyExists(tag_name)
5367
branch.tags.set_tag(tag_name, revision_id)
5368
self.outf.write('Created tag %s.\n' % tag_name)
5371
class cmd_tags(Command):
5372
__doc__ = """List tags.
5374
This command shows a table of tag names and the revisions they reference.
5379
custom_help('directory',
5380
help='Branch whose tags should be displayed.'),
5381
RegistryOption.from_kwargs('sort',
5382
'Sort tags by different criteria.', title='Sorting',
5383
alpha='Sort tags lexicographically (default).',
5384
time='Sort tags chronologically.',
5397
branch, relpath = Branch.open_containing(directory)
5399
tags = branch.tags.get_tag_dict().items()
5403
self.add_cleanup(branch.lock_read().unlock)
5405
graph = branch.repository.get_graph()
5406
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5407
revid1, revid2 = rev1.rev_id, rev2.rev_id
5408
# only show revisions between revid1 and revid2 (inclusive)
5409
tags = [(tag, revid) for tag, revid in tags if
5410
graph.is_between(revid, revid1, revid2)]
5413
elif sort == 'time':
5415
for tag, revid in tags:
5417
revobj = branch.repository.get_revision(revid)
5418
except errors.NoSuchRevision:
5419
timestamp = sys.maxint # place them at the end
5421
timestamp = revobj.timestamp
5422
timestamps[revid] = timestamp
5423
tags.sort(key=lambda x: timestamps[x[1]])
5425
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5426
for index, (tag, revid) in enumerate(tags):
5428
revno = branch.revision_id_to_dotted_revno(revid)
5429
if isinstance(revno, tuple):
5430
revno = '.'.join(map(str, revno))
5431
except errors.NoSuchRevision:
5432
# Bad tag data/merges can lead to tagged revisions
5433
# which are not in this branch. Fail gracefully ...
5435
tags[index] = (tag, revno)
5437
for tag, revspec in tags:
5438
self.outf.write('%-20s %s\n' % (tag, revspec))
5441
class cmd_reconfigure(Command):
5442
__doc__ = """Reconfigure the type of a bzr directory.
5444
A target configuration must be specified.
5446
For checkouts, the bind-to location will be auto-detected if not specified.
5447
The order of preference is
5448
1. For a lightweight checkout, the current bound location.
5449
2. For branches that used to be checkouts, the previously-bound location.
5450
3. The push location.
5451
4. The parent location.
5452
If none of these is available, --bind-to must be specified.
5455
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5456
takes_args = ['location?']
5458
RegistryOption.from_kwargs(
5460
title='Target type',
5461
help='The type to reconfigure the directory to.',
5462
value_switches=True, enum_switch=False,
5463
branch='Reconfigure to be an unbound branch with no working tree.',
5464
tree='Reconfigure to be an unbound branch with a working tree.',
5465
checkout='Reconfigure to be a bound branch with a working tree.',
5466
lightweight_checkout='Reconfigure to be a lightweight'
5467
' checkout (with no local history).',
5468
standalone='Reconfigure to be a standalone branch '
5469
'(i.e. stop using shared repository).',
5470
use_shared='Reconfigure to use a shared repository.',
5471
with_trees='Reconfigure repository to create '
5472
'working trees on branches by default.',
5473
with_no_trees='Reconfigure repository to not create '
5474
'working trees on branches by default.'
5476
Option('bind-to', help='Branch to bind checkout to.', type=str),
5478
help='Perform reconfiguration even if local changes'
5480
Option('stacked-on',
5481
help='Reconfigure a branch to be stacked on another branch.',
5485
help='Reconfigure a branch to be unstacked. This '
5486
'may require copying substantial data into it.',
5490
def run(self, location=None, target_type=None, bind_to=None, force=False,
5493
directory = bzrdir.BzrDir.open(location)
5494
if stacked_on and unstacked:
5495
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5496
elif stacked_on is not None:
5497
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5499
reconfigure.ReconfigureUnstacked().apply(directory)
5500
# At the moment you can use --stacked-on and a different
5501
# reconfiguration shape at the same time; there seems no good reason
5503
if target_type is None:
5504
if stacked_on or unstacked:
5507
raise errors.BzrCommandError('No target configuration '
5509
elif target_type == 'branch':
5510
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5511
elif target_type == 'tree':
5512
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5513
elif target_type == 'checkout':
5514
reconfiguration = reconfigure.Reconfigure.to_checkout(
5516
elif target_type == 'lightweight-checkout':
5517
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5519
elif target_type == 'use-shared':
5520
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5521
elif target_type == 'standalone':
5522
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5523
elif target_type == 'with-trees':
5524
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5526
elif target_type == 'with-no-trees':
5527
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5529
reconfiguration.apply(force)
5532
class cmd_switch(Command):
5533
__doc__ = """Set the branch of a checkout and update.
5535
For lightweight checkouts, this changes the branch being referenced.
5536
For heavyweight checkouts, this checks that there are no local commits
5537
versus the current bound branch, then it makes the local branch a mirror
5538
of the new location and binds to it.
5540
In both cases, the working tree is updated and uncommitted changes
5541
are merged. The user can commit or revert these as they desire.
5543
Pending merges need to be committed or reverted before using switch.
5545
The path to the branch to switch to can be specified relative to the parent
5546
directory of the current branch. For example, if you are currently in a
5547
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5550
Bound branches use the nickname of its master branch unless it is set
5551
locally, in which case switching will update the local nickname to be
5555
takes_args = ['to_location?']
5556
takes_options = ['directory',
5558
help='Switch even if local commits will be lost.'),
5560
Option('create-branch', short_name='b',
5561
help='Create the target branch from this one before'
5562
' switching to it.'),
5565
def run(self, to_location=None, force=False, create_branch=False,
5566
revision=None, directory=u'.'):
5567
from bzrlib import switch
5568
tree_location = directory
5569
revision = _get_one_revision('switch', revision)
5570
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5571
if to_location is None:
5572
if revision is None:
5573
raise errors.BzrCommandError('You must supply either a'
5574
' revision or a location')
5575
to_location = tree_location
5577
branch = control_dir.open_branch()
5578
had_explicit_nick = branch.get_config().has_explicit_nickname()
5579
except errors.NotBranchError:
5581
had_explicit_nick = False
5584
raise errors.BzrCommandError('cannot create branch without'
5586
to_location = directory_service.directories.dereference(
5588
if '/' not in to_location and '\\' not in to_location:
5589
# This path is meant to be relative to the existing branch
5590
this_url = self._get_branch_location(control_dir)
5591
to_location = urlutils.join(this_url, '..', to_location)
5592
to_branch = branch.bzrdir.sprout(to_location,
5593
possible_transports=[branch.bzrdir.root_transport],
5594
source_branch=branch).open_branch()
5597
to_branch = Branch.open(to_location)
5598
except errors.NotBranchError:
5599
this_url = self._get_branch_location(control_dir)
5600
to_branch = Branch.open(
5601
urlutils.join(this_url, '..', to_location))
5602
if revision is not None:
5603
revision = revision.as_revision_id(to_branch)
5604
switch.switch(control_dir, to_branch, force, revision_id=revision)
5605
if had_explicit_nick:
5606
branch = control_dir.open_branch() #get the new branch!
5607
branch.nick = to_branch.nick
5608
note('Switched to branch: %s',
5609
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5611
def _get_branch_location(self, control_dir):
5612
"""Return location of branch for this control dir."""
5614
this_branch = control_dir.open_branch()
5615
# This may be a heavy checkout, where we want the master branch
5616
master_location = this_branch.get_bound_location()
5617
if master_location is not None:
5618
return master_location
5619
# If not, use a local sibling
5620
return this_branch.base
5621
except errors.NotBranchError:
5622
format = control_dir.find_branch_format()
5623
if getattr(format, 'get_reference', None) is not None:
5624
return format.get_reference(control_dir)
5626
return control_dir.root_transport.base
5629
class cmd_view(Command):
5630
__doc__ = """Manage filtered views.
5632
Views provide a mask over the tree so that users can focus on
5633
a subset of a tree when doing their work. After creating a view,
5634
commands that support a list of files - status, diff, commit, etc -
5635
effectively have that list of files implicitly given each time.
5636
An explicit list of files can still be given but those files
5637
must be within the current view.
5639
In most cases, a view has a short life-span: it is created to make
5640
a selected change and is deleted once that change is committed.
5641
At other times, you may wish to create one or more named views
5642
and switch between them.
5644
To disable the current view without deleting it, you can switch to
5645
the pseudo view called ``off``. This can be useful when you need
5646
to see the whole tree for an operation or two (e.g. merge) but
5647
want to switch back to your view after that.
5650
To define the current view::
5652
bzr view file1 dir1 ...
5654
To list the current view::
5658
To delete the current view::
5662
To disable the current view without deleting it::
5664
bzr view --switch off
5666
To define a named view and switch to it::
5668
bzr view --name view-name file1 dir1 ...
5670
To list a named view::
5672
bzr view --name view-name
5674
To delete a named view::
5676
bzr view --name view-name --delete
5678
To switch to a named view::
5680
bzr view --switch view-name
5682
To list all views defined::
5686
To delete all views::
5688
bzr view --delete --all
5692
takes_args = ['file*']
5695
help='Apply list or delete action to all views.',
5698
help='Delete the view.',
5701
help='Name of the view to define, list or delete.',
5705
help='Name of the view to switch to.',
5710
def run(self, file_list,
5716
tree, file_list = WorkingTree.open_containing_paths(file_list,
5718
current_view, view_dict = tree.views.get_view_info()
5723
raise errors.BzrCommandError(
5724
"Both --delete and a file list specified")
5726
raise errors.BzrCommandError(
5727
"Both --delete and --switch specified")
5729
tree.views.set_view_info(None, {})
5730
self.outf.write("Deleted all views.\n")
5732
raise errors.BzrCommandError("No current view to delete")
5734
tree.views.delete_view(name)
5735
self.outf.write("Deleted '%s' view.\n" % name)
5738
raise errors.BzrCommandError(
5739
"Both --switch and a file list specified")
5741
raise errors.BzrCommandError(
5742
"Both --switch and --all specified")
5743
elif switch == 'off':
5744
if current_view is None:
5745
raise errors.BzrCommandError("No current view to disable")
5746
tree.views.set_view_info(None, view_dict)
5747
self.outf.write("Disabled '%s' view.\n" % (current_view))
5749
tree.views.set_view_info(switch, view_dict)
5750
view_str = views.view_display_str(tree.views.lookup_view())
5751
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5754
self.outf.write('Views defined:\n')
5755
for view in sorted(view_dict):
5756
if view == current_view:
5760
view_str = views.view_display_str(view_dict[view])
5761
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5763
self.outf.write('No views defined.\n')
5766
# No name given and no current view set
5769
raise errors.BzrCommandError(
5770
"Cannot change the 'off' pseudo view")
5771
tree.views.set_view(name, sorted(file_list))
5772
view_str = views.view_display_str(tree.views.lookup_view())
5773
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5777
# No name given and no current view set
5778
self.outf.write('No current view.\n')
5780
view_str = views.view_display_str(tree.views.lookup_view(name))
5781
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5784
class cmd_hooks(Command):
5785
__doc__ = """Show hooks."""
5790
for hook_key in sorted(hooks.known_hooks.keys()):
5791
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5792
self.outf.write("%s:\n" % type(some_hooks).__name__)
5793
for hook_name, hook_point in sorted(some_hooks.items()):
5794
self.outf.write(" %s:\n" % (hook_name,))
5795
found_hooks = list(hook_point)
5797
for hook in found_hooks:
5798
self.outf.write(" %s\n" %
5799
(some_hooks.get_hook_name(hook),))
5801
self.outf.write(" <no hooks installed>\n")
5804
class cmd_remove_branch(Command):
5805
__doc__ = """Remove a branch.
5807
This will remove the branch from the specified location but
5808
will keep any working tree or repository in place.
5812
Remove the branch at repo/trunk::
5814
bzr remove-branch repo/trunk
5818
takes_args = ["location?"]
5820
aliases = ["rmbranch"]
5822
def run(self, location=None):
5823
if location is None:
5825
branch = Branch.open_containing(location)[0]
5826
branch.bzrdir.destroy_branch()
5829
class cmd_shelve(Command):
5830
__doc__ = """Temporarily set aside some changes from the current tree.
5832
Shelve allows you to temporarily put changes you've made "on the shelf",
5833
ie. out of the way, until a later time when you can bring them back from
5834
the shelf with the 'unshelve' command. The changes are stored alongside
5835
your working tree, and so they aren't propagated along with your branch nor
5836
will they survive its deletion.
5838
If shelve --list is specified, previously-shelved changes are listed.
5840
Shelve is intended to help separate several sets of changes that have
5841
been inappropriately mingled. If you just want to get rid of all changes
5842
and you don't need to restore them later, use revert. If you want to
5843
shelve all text changes at once, use shelve --all.
5845
If filenames are specified, only the changes to those files will be
5846
shelved. Other files will be left untouched.
5848
If a revision is specified, changes since that revision will be shelved.
5850
You can put multiple items on the shelf, and by default, 'unshelve' will
5851
restore the most recently shelved changes.
5854
takes_args = ['file*']
5859
Option('all', help='Shelve all changes.'),
5861
RegistryOption('writer', 'Method to use for writing diffs.',
5862
bzrlib.option.diff_writer_registry,
5863
value_switches=True, enum_switch=False),
5865
Option('list', help='List shelved changes.'),
5867
help='Destroy removed changes instead of shelving them.'),
5869
_see_also = ['unshelve']
5871
def run(self, revision=None, all=False, file_list=None, message=None,
5872
writer=None, list=False, destroy=False, directory=u'.'):
5874
return self.run_for_list()
5875
from bzrlib.shelf_ui import Shelver
5877
writer = bzrlib.option.diff_writer_registry.get()
5879
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5880
file_list, message, destroy=destroy, directory=directory)
5885
except errors.UserAbort:
5888
def run_for_list(self):
5889
tree = WorkingTree.open_containing('.')[0]
5890
self.add_cleanup(tree.lock_read().unlock)
5891
manager = tree.get_shelf_manager()
5892
shelves = manager.active_shelves()
5893
if len(shelves) == 0:
5894
note('No shelved changes.')
5896
for shelf_id in reversed(shelves):
5897
message = manager.get_metadata(shelf_id).get('message')
5899
message = '<no message>'
5900
self.outf.write('%3d: %s\n' % (shelf_id, message))
5904
class cmd_unshelve(Command):
5905
__doc__ = """Restore shelved changes.
5907
By default, the most recently shelved changes are restored. However if you
5908
specify a shelf by id those changes will be restored instead. This works
5909
best when the changes don't depend on each other.
5912
takes_args = ['shelf_id?']
5915
RegistryOption.from_kwargs(
5916
'action', help="The action to perform.",
5917
enum_switch=False, value_switches=True,
5918
apply="Apply changes and remove from the shelf.",
5919
dry_run="Show changes, but do not apply or remove them.",
5920
preview="Instead of unshelving the changes, show the diff that "
5921
"would result from unshelving.",
5922
delete_only="Delete changes without applying them.",
5923
keep="Apply changes but don't delete them.",
5926
_see_also = ['shelve']
5928
def run(self, shelf_id=None, action='apply', directory=u'.'):
5929
from bzrlib.shelf_ui import Unshelver
5930
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5934
unshelver.tree.unlock()
5937
class cmd_clean_tree(Command):
5938
__doc__ = """Remove unwanted files from working tree.
5940
By default, only unknown files, not ignored files, are deleted. Versioned
5941
files are never deleted.
5943
Another class is 'detritus', which includes files emitted by bzr during
5944
normal operations and selftests. (The value of these files decreases with
5947
If no options are specified, unknown files are deleted. Otherwise, option
5948
flags are respected, and may be combined.
5950
To check what clean-tree will do, use --dry-run.
5952
takes_options = ['directory',
5953
Option('ignored', help='Delete all ignored files.'),
5954
Option('detritus', help='Delete conflict files, merge'
5955
' backups, and failed selftest dirs.'),
5957
help='Delete files unknown to bzr (default).'),
5958
Option('dry-run', help='Show files to delete instead of'
5960
Option('force', help='Do not prompt before deleting.')]
5961
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5962
force=False, directory=u'.'):
5963
from bzrlib.clean_tree import clean_tree
5964
if not (unknown or ignored or detritus):
5968
clean_tree(directory, unknown=unknown, ignored=ignored,
5969
detritus=detritus, dry_run=dry_run, no_prompt=force)
5972
class cmd_reference(Command):
5973
__doc__ = """list, view and set branch locations for nested trees.
5975
If no arguments are provided, lists the branch locations for nested trees.
5976
If one argument is provided, display the branch location for that tree.
5977
If two arguments are provided, set the branch location for that tree.
5982
takes_args = ['path?', 'location?']
5984
def run(self, path=None, location=None):
5986
if path is not None:
5988
tree, branch, relpath =(
5989
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5990
if path is not None:
5993
tree = branch.basis_tree()
5995
info = branch._get_all_reference_info().iteritems()
5996
self._display_reference_info(tree, branch, info)
5998
file_id = tree.path2id(path)
6000
raise errors.NotVersionedError(path)
6001
if location is None:
6002
info = [(file_id, branch.get_reference_info(file_id))]
6003
self._display_reference_info(tree, branch, info)
6005
branch.set_reference_info(file_id, path, location)
6007
def _display_reference_info(self, tree, branch, info):
6009
for file_id, (path, location) in info:
6011
path = tree.id2path(file_id)
6012
except errors.NoSuchId:
6014
ref_list.append((path, location))
6015
for path, location in sorted(ref_list):
6016
self.outf.write('%s %s\n' % (path, location))
6019
def _register_lazy_builtins():
6020
# register lazy builtins from other modules; called at startup and should
6021
# be only called once.
6022
for (name, aliases, module_name) in [
6023
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6024
('cmd_dpush', [], 'bzrlib.foreign'),
6025
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6026
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6027
('cmd_conflicts', [], 'bzrlib.conflicts'),
6028
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6030
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
