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 the tree's branch is bound to a master branch, it will also update
1358
the branch from the master.
1361
_see_also = ['pull', 'working-trees', 'status-flags']
1362
takes_args = ['dir?']
1363
takes_options = ['revision']
1366
def run(self, dir='.', revision=None):
1367
if revision is not None and len(revision) != 1:
1368
raise errors.BzrCommandError(
1369
"bzr update --revision takes exactly one revision")
1370
tree = WorkingTree.open_containing(dir)[0]
1371
branch = tree.branch
1372
possible_transports = []
1373
master = branch.get_master_branch(
1374
possible_transports=possible_transports)
1375
if master is not None:
1376
branch_location = master.base
1379
branch_location = tree.branch.base
1380
tree.lock_tree_write()
1381
self.add_cleanup(tree.unlock)
1382
# get rid of the final '/' and be ready for display
1383
branch_location = urlutils.unescape_for_display(
1384
branch_location.rstrip('/'),
1386
existing_pending_merges = tree.get_parent_ids()[1:]
1390
# may need to fetch data into a heavyweight checkout
1391
# XXX: this may take some time, maybe we should display a
1393
old_tip = branch.update(possible_transports)
1394
if revision is not None:
1395
revision_id = revision[0].as_revision_id(branch)
1397
revision_id = branch.last_revision()
1398
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1399
revno = branch.revision_id_to_dotted_revno(revision_id)
1400
note("Tree is up to date at revision %s of branch %s" %
1401
('.'.join(map(str, revno)), branch_location))
1403
view_info = _get_view_info_for_change_reporter(tree)
1404
change_reporter = delta._ChangeReporter(
1405
unversioned_filter=tree.is_ignored,
1406
view_info=view_info)
1408
conflicts = tree.update(
1410
possible_transports=possible_transports,
1411
revision=revision_id,
1413
except errors.NoSuchRevision, e:
1414
raise errors.BzrCommandError(
1415
"branch has no revision %s\n"
1416
"bzr update --revision only works"
1417
" for a revision in the branch history"
1419
revno = tree.branch.revision_id_to_dotted_revno(
1420
_mod_revision.ensure_null(tree.last_revision()))
1421
note('Updated to revision %s of branch %s' %
1422
('.'.join(map(str, revno)), branch_location))
1423
parent_ids = tree.get_parent_ids()
1424
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1425
note('Your local commits will now show as pending merges with '
1426
"'bzr status', and can be committed with 'bzr commit'.")
1433
class cmd_info(Command):
1434
__doc__ = """Show information about a working tree, branch or repository.
1436
This command will show all known locations and formats associated to the
1437
tree, branch or repository.
1439
In verbose mode, statistical information is included with each report.
1440
To see extended statistic information, use a verbosity level of 2 or
1441
higher by specifying the verbose option multiple times, e.g. -vv.
1443
Branches and working trees will also report any missing revisions.
1447
Display information on the format and related locations:
1451
Display the above together with extended format information and
1452
basic statistics (like the number of files in the working tree and
1453
number of revisions in the branch and repository):
1457
Display the above together with number of committers to the branch:
1461
_see_also = ['revno', 'working-trees', 'repositories']
1462
takes_args = ['location?']
1463
takes_options = ['verbose']
1464
encoding_type = 'replace'
1467
def run(self, location=None, verbose=False):
1469
noise_level = get_verbosity_level()
1472
from bzrlib.info import show_bzrdir_info
1473
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1474
verbose=noise_level, outfile=self.outf)
1477
class cmd_remove(Command):
1478
__doc__ = """Remove files or directories.
1480
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1481
delete them if they can easily be recovered using revert otherwise they
1482
will be backed up (adding an extention of the form .~#~). If no options or
1483
parameters are given Bazaar will scan for files that are being tracked by
1484
Bazaar but missing in your tree and stop tracking them for you.
1486
takes_args = ['file*']
1487
takes_options = ['verbose',
1488
Option('new', help='Only remove files that have never been committed.'),
1489
RegistryOption.from_kwargs('file-deletion-strategy',
1490
'The file deletion mode to be used.',
1491
title='Deletion Strategy', value_switches=True, enum_switch=False,
1492
safe='Backup changed files (default).',
1493
keep='Delete from bzr but leave the working copy.',
1494
force='Delete all the specified files, even if they can not be '
1495
'recovered and even if they are non-empty directories.')]
1496
aliases = ['rm', 'del']
1497
encoding_type = 'replace'
1499
def run(self, file_list, verbose=False, new=False,
1500
file_deletion_strategy='safe'):
1501
tree, file_list = WorkingTree.open_containing_paths(file_list)
1503
if file_list is not None:
1504
file_list = [f for f in file_list]
1506
self.add_cleanup(tree.lock_write().unlock)
1507
# Heuristics should probably all move into tree.remove_smart or
1510
added = tree.changes_from(tree.basis_tree(),
1511
specific_files=file_list).added
1512
file_list = sorted([f[0] for f in added], reverse=True)
1513
if len(file_list) == 0:
1514
raise errors.BzrCommandError('No matching files.')
1515
elif file_list is None:
1516
# missing files show up in iter_changes(basis) as
1517
# versioned-with-no-kind.
1519
for change in tree.iter_changes(tree.basis_tree()):
1520
# Find paths in the working tree that have no kind:
1521
if change[1][1] is not None and change[6][1] is None:
1522
missing.append(change[1][1])
1523
file_list = sorted(missing, reverse=True)
1524
file_deletion_strategy = 'keep'
1525
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1526
keep_files=file_deletion_strategy=='keep',
1527
force=file_deletion_strategy=='force')
1530
class cmd_file_id(Command):
1531
__doc__ = """Print file_id of a particular file or directory.
1533
The file_id is assigned when the file is first added and remains the
1534
same through all revisions where the file exists, even when it is
1539
_see_also = ['inventory', 'ls']
1540
takes_args = ['filename']
1543
def run(self, filename):
1544
tree, relpath = WorkingTree.open_containing(filename)
1545
i = tree.path2id(relpath)
1547
raise errors.NotVersionedError(filename)
1549
self.outf.write(i + '\n')
1552
class cmd_file_path(Command):
1553
__doc__ = """Print path of file_ids to a file or directory.
1555
This prints one line for each directory down to the target,
1556
starting at the branch root.
1560
takes_args = ['filename']
1563
def run(self, filename):
1564
tree, relpath = WorkingTree.open_containing(filename)
1565
fid = tree.path2id(relpath)
1567
raise errors.NotVersionedError(filename)
1568
segments = osutils.splitpath(relpath)
1569
for pos in range(1, len(segments) + 1):
1570
path = osutils.joinpath(segments[:pos])
1571
self.outf.write("%s\n" % tree.path2id(path))
1574
class cmd_reconcile(Command):
1575
__doc__ = """Reconcile bzr metadata in a branch.
1577
This can correct data mismatches that may have been caused by
1578
previous ghost operations or bzr upgrades. You should only
1579
need to run this command if 'bzr check' or a bzr developer
1580
advises you to run it.
1582
If a second branch is provided, cross-branch reconciliation is
1583
also attempted, which will check that data like the tree root
1584
id which was not present in very early bzr versions is represented
1585
correctly in both branches.
1587
At the same time it is run it may recompress data resulting in
1588
a potential saving in disk space or performance gain.
1590
The branch *MUST* be on a listable system such as local disk or sftp.
1593
_see_also = ['check']
1594
takes_args = ['branch?']
1596
Option('canonicalize-chks',
1597
help='Make sure CHKs are in canonical form (repairs '
1602
def run(self, branch=".", canonicalize_chks=False):
1603
from bzrlib.reconcile import reconcile
1604
dir = bzrdir.BzrDir.open(branch)
1605
reconcile(dir, canonicalize_chks=canonicalize_chks)
1608
class cmd_revision_history(Command):
1609
__doc__ = """Display the list of revision ids on a branch."""
1612
takes_args = ['location?']
1617
def run(self, location="."):
1618
branch = Branch.open_containing(location)[0]
1619
for revid in branch.revision_history():
1620
self.outf.write(revid)
1621
self.outf.write('\n')
1624
class cmd_ancestry(Command):
1625
__doc__ = """List all revisions merged into this branch."""
1627
_see_also = ['log', 'revision-history']
1628
takes_args = ['location?']
1633
def run(self, location="."):
1635
wt = WorkingTree.open_containing(location)[0]
1636
except errors.NoWorkingTree:
1637
b = Branch.open(location)
1638
last_revision = b.last_revision()
1641
last_revision = wt.last_revision()
1643
revision_ids = b.repository.get_ancestry(last_revision)
1645
for revision_id in revision_ids:
1646
self.outf.write(revision_id + '\n')
1649
class cmd_init(Command):
1650
__doc__ = """Make a directory into a versioned branch.
1652
Use this to create an empty branch, or before importing an
1655
If there is a repository in a parent directory of the location, then
1656
the history of the branch will be stored in the repository. Otherwise
1657
init creates a standalone branch which carries its own history
1658
in the .bzr directory.
1660
If there is already a branch at the location but it has no working tree,
1661
the tree can be populated with 'bzr checkout'.
1663
Recipe for importing a tree of files::
1669
bzr commit -m "imported project"
1672
_see_also = ['init-repository', 'branch', 'checkout']
1673
takes_args = ['location?']
1675
Option('create-prefix',
1676
help='Create the path leading up to the branch '
1677
'if it does not already exist.'),
1678
RegistryOption('format',
1679
help='Specify a format for this branch. '
1680
'See "help formats".',
1681
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1682
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1683
value_switches=True,
1684
title="Branch format",
1686
Option('append-revisions-only',
1687
help='Never change revnos or the existing log.'
1688
' Append revisions to it only.')
1690
def run(self, location=None, format=None, append_revisions_only=False,
1691
create_prefix=False):
1693
format = bzrdir.format_registry.make_bzrdir('default')
1694
if location is None:
1697
to_transport = transport.get_transport(location)
1699
# The path has to exist to initialize a
1700
# branch inside of it.
1701
# Just using os.mkdir, since I don't
1702
# believe that we want to create a bunch of
1703
# locations if the user supplies an extended path
1705
to_transport.ensure_base()
1706
except errors.NoSuchFile:
1707
if not create_prefix:
1708
raise errors.BzrCommandError("Parent directory of %s"
1710
"\nYou may supply --create-prefix to create all"
1711
" leading parent directories."
1713
to_transport.create_prefix()
1716
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1717
except errors.NotBranchError:
1718
# really a NotBzrDir error...
1719
create_branch = bzrdir.BzrDir.create_branch_convenience
1720
branch = create_branch(to_transport.base, format=format,
1721
possible_transports=[to_transport])
1722
a_bzrdir = branch.bzrdir
1724
from bzrlib.transport.local import LocalTransport
1725
if a_bzrdir.has_branch():
1726
if (isinstance(to_transport, LocalTransport)
1727
and not a_bzrdir.has_workingtree()):
1728
raise errors.BranchExistsWithoutWorkingTree(location)
1729
raise errors.AlreadyBranchError(location)
1730
branch = a_bzrdir.create_branch()
1731
a_bzrdir.create_workingtree()
1732
if append_revisions_only:
1734
branch.set_append_revisions_only(True)
1735
except errors.UpgradeRequired:
1736
raise errors.BzrCommandError('This branch format cannot be set'
1737
' to append-revisions-only. Try --default.')
1739
from bzrlib.info import describe_layout, describe_format
1741
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1742
except (errors.NoWorkingTree, errors.NotLocalUrl):
1744
repository = branch.repository
1745
layout = describe_layout(repository, branch, tree).lower()
1746
format = describe_format(a_bzrdir, repository, branch, tree)
1747
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1748
if repository.is_shared():
1749
#XXX: maybe this can be refactored into transport.path_or_url()
1750
url = repository.bzrdir.root_transport.external_url()
1752
url = urlutils.local_path_from_url(url)
1753
except errors.InvalidURL:
1755
self.outf.write("Using shared repository: %s\n" % url)
1758
class cmd_init_repository(Command):
1759
__doc__ = """Create a shared repository for branches to share storage space.
1761
New branches created under the repository directory will store their
1762
revisions in the repository, not in the branch directory. For branches
1763
with shared history, this reduces the amount of storage needed and
1764
speeds up the creation of new branches.
1766
If the --no-trees option is given then the branches in the repository
1767
will not have working trees by default. They will still exist as
1768
directories on disk, but they will not have separate copies of the
1769
files at a certain revision. This can be useful for repositories that
1770
store branches which are interacted with through checkouts or remote
1771
branches, such as on a server.
1774
Create a shared repository holding just branches::
1776
bzr init-repo --no-trees repo
1779
Make a lightweight checkout elsewhere::
1781
bzr checkout --lightweight repo/trunk trunk-checkout
1786
_see_also = ['init', 'branch', 'checkout', 'repositories']
1787
takes_args = ["location"]
1788
takes_options = [RegistryOption('format',
1789
help='Specify a format for this repository. See'
1790
' "bzr help formats" for details.',
1791
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1792
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1793
value_switches=True, title='Repository format'),
1795
help='Branches in the repository will default to'
1796
' not having a working tree.'),
1798
aliases = ["init-repo"]
1800
def run(self, location, format=None, no_trees=False):
1802
format = bzrdir.format_registry.make_bzrdir('default')
1804
if location is None:
1807
to_transport = transport.get_transport(location)
1808
to_transport.ensure_base()
1810
newdir = format.initialize_on_transport(to_transport)
1811
repo = newdir.create_repository(shared=True)
1812
repo.set_make_working_trees(not no_trees)
1814
from bzrlib.info import show_bzrdir_info
1815
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1818
class cmd_diff(Command):
1819
__doc__ = """Show differences in the working tree, between revisions or branches.
1821
If no arguments are given, all changes for the current tree are listed.
1822
If files are given, only the changes in those files are listed.
1823
Remote and multiple branches can be compared by using the --old and
1824
--new options. If not provided, the default for both is derived from
1825
the first argument, if any, or the current tree if no arguments are
1828
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1829
produces patches suitable for "patch -p1".
1833
2 - unrepresentable changes
1838
Shows the difference in the working tree versus the last commit::
1842
Difference between the working tree and revision 1::
1846
Difference between revision 3 and revision 1::
1850
Difference between revision 3 and revision 1 for branch xxx::
1854
To see the changes introduced in revision X::
1858
Note that in the case of a merge, the -c option shows the changes
1859
compared to the left hand parent. To see the changes against
1860
another parent, use::
1862
bzr diff -r<chosen_parent>..X
1864
The changes introduced by revision 2 (equivalent to -r1..2)::
1868
Show just the differences for file NEWS::
1872
Show the differences in working tree xxx for file NEWS::
1876
Show the differences from branch xxx to this working tree:
1880
Show the differences between two branches for file NEWS::
1882
bzr diff --old xxx --new yyy NEWS
1884
Same as 'bzr diff' but prefix paths with old/ and new/::
1886
bzr diff --prefix old/:new/
1888
Show the differences using a custom diff program with options::
1890
bzr diff --using /usr/bin/diff --diff-options -wu
1892
_see_also = ['status']
1893
takes_args = ['file*']
1895
Option('diff-options', type=str,
1896
help='Pass these options to the external diff program.'),
1897
Option('prefix', type=str,
1899
help='Set prefixes added to old and new filenames, as '
1900
'two values separated by a colon. (eg "old/:new/").'),
1902
help='Branch/tree to compare from.',
1906
help='Branch/tree to compare to.',
1912
help='Use this command to compare files.',
1915
RegistryOption('format',
1916
help='Diff format to use.',
1917
lazy_registry=('bzrlib.diff', 'format_registry'),
1918
value_switches=False, title='Diff format'),
1920
aliases = ['di', 'dif']
1921
encoding_type = 'exact'
1924
def run(self, revision=None, file_list=None, diff_options=None,
1925
prefix=None, old=None, new=None, using=None, format=None):
1926
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1929
if (prefix is None) or (prefix == '0'):
1937
old_label, new_label = prefix.split(":")
1939
raise errors.BzrCommandError(
1940
'--prefix expects two values separated by a colon'
1941
' (eg "old/:new/")')
1943
if revision and len(revision) > 2:
1944
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1945
' one or two revision specifiers')
1947
if using is not None and format is not None:
1948
raise errors.BzrCommandError('--using and --format are mutually '
1951
(old_tree, new_tree,
1952
old_branch, new_branch,
1953
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1954
file_list, revision, old, new, self.add_cleanup, apply_view=True)
1955
# GNU diff on Windows uses ANSI encoding for filenames
1956
path_encoding = osutils.get_diff_header_encoding()
1957
return show_diff_trees(old_tree, new_tree, sys.stdout,
1958
specific_files=specific_files,
1959
external_diff_options=diff_options,
1960
old_label=old_label, new_label=new_label,
1961
extra_trees=extra_trees,
1962
path_encoding=path_encoding,
1967
class cmd_deleted(Command):
1968
__doc__ = """List files deleted in the working tree.
1970
# TODO: Show files deleted since a previous revision, or
1971
# between two revisions.
1972
# TODO: Much more efficient way to do this: read in new
1973
# directories with readdir, rather than stating each one. Same
1974
# level of effort but possibly much less IO. (Or possibly not,
1975
# if the directories are very large...)
1976
_see_also = ['status', 'ls']
1977
takes_options = ['directory', 'show-ids']
1980
def run(self, show_ids=False, directory=u'.'):
1981
tree = WorkingTree.open_containing(directory)[0]
1982
self.add_cleanup(tree.lock_read().unlock)
1983
old = tree.basis_tree()
1984
self.add_cleanup(old.lock_read().unlock)
1985
for path, ie in old.inventory.iter_entries():
1986
if not tree.has_id(ie.file_id):
1987
self.outf.write(path)
1989
self.outf.write(' ')
1990
self.outf.write(ie.file_id)
1991
self.outf.write('\n')
1994
class cmd_modified(Command):
1995
__doc__ = """List files modified in working tree.
1999
_see_also = ['status', 'ls']
2000
takes_options = ['directory', 'null']
2003
def run(self, null=False, directory=u'.'):
2004
tree = WorkingTree.open_containing(directory)[0]
2005
td = tree.changes_from(tree.basis_tree())
2006
for path, id, kind, text_modified, meta_modified in td.modified:
2008
self.outf.write(path + '\0')
2010
self.outf.write(osutils.quotefn(path) + '\n')
2013
class cmd_added(Command):
2014
__doc__ = """List files added in working tree.
2018
_see_also = ['status', 'ls']
2019
takes_options = ['directory', 'null']
2022
def run(self, null=False, directory=u'.'):
2023
wt = WorkingTree.open_containing(directory)[0]
2024
self.add_cleanup(wt.lock_read().unlock)
2025
basis = wt.basis_tree()
2026
self.add_cleanup(basis.lock_read().unlock)
2027
basis_inv = basis.inventory
2030
if file_id in basis_inv:
2032
if inv.is_root(file_id) and len(basis_inv) == 0:
2034
path = inv.id2path(file_id)
2035
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2038
self.outf.write(path + '\0')
2040
self.outf.write(osutils.quotefn(path) + '\n')
2043
class cmd_root(Command):
2044
__doc__ = """Show the tree root directory.
2046
The root is the nearest enclosing directory with a .bzr control
2049
takes_args = ['filename?']
2051
def run(self, filename=None):
2052
"""Print the branch root."""
2053
tree = WorkingTree.open_containing(filename)[0]
2054
self.outf.write(tree.basedir + '\n')
2057
def _parse_limit(limitstring):
2059
return int(limitstring)
2061
msg = "The limit argument must be an integer."
2062
raise errors.BzrCommandError(msg)
2065
def _parse_levels(s):
2069
msg = "The levels argument must be an integer."
2070
raise errors.BzrCommandError(msg)
2073
class cmd_log(Command):
2074
__doc__ = """Show historical log for a branch or subset of a branch.
2076
log is bzr's default tool for exploring the history of a branch.
2077
The branch to use is taken from the first parameter. If no parameters
2078
are given, the branch containing the working directory is logged.
2079
Here are some simple examples::
2081
bzr log log the current branch
2082
bzr log foo.py log a file in its branch
2083
bzr log http://server/branch log a branch on a server
2085
The filtering, ordering and information shown for each revision can
2086
be controlled as explained below. By default, all revisions are
2087
shown sorted (topologically) so that newer revisions appear before
2088
older ones and descendants always appear before ancestors. If displayed,
2089
merged revisions are shown indented under the revision in which they
2094
The log format controls how information about each revision is
2095
displayed. The standard log formats are called ``long``, ``short``
2096
and ``line``. The default is long. See ``bzr help log-formats``
2097
for more details on log formats.
2099
The following options can be used to control what information is
2102
-l N display a maximum of N revisions
2103
-n N display N levels of revisions (0 for all, 1 for collapsed)
2104
-v display a status summary (delta) for each revision
2105
-p display a diff (patch) for each revision
2106
--show-ids display revision-ids (and file-ids), not just revnos
2108
Note that the default number of levels to display is a function of the
2109
log format. If the -n option is not used, the standard log formats show
2110
just the top level (mainline).
2112
Status summaries are shown using status flags like A, M, etc. To see
2113
the changes explained using words like ``added`` and ``modified``
2114
instead, use the -vv option.
2118
To display revisions from oldest to newest, use the --forward option.
2119
In most cases, using this option will have little impact on the total
2120
time taken to produce a log, though --forward does not incrementally
2121
display revisions like --reverse does when it can.
2123
:Revision filtering:
2125
The -r option can be used to specify what revision or range of revisions
2126
to filter against. The various forms are shown below::
2128
-rX display revision X
2129
-rX.. display revision X and later
2130
-r..Y display up to and including revision Y
2131
-rX..Y display from X to Y inclusive
2133
See ``bzr help revisionspec`` for details on how to specify X and Y.
2134
Some common examples are given below::
2136
-r-1 show just the tip
2137
-r-10.. show the last 10 mainline revisions
2138
-rsubmit:.. show what's new on this branch
2139
-rancestor:path.. show changes since the common ancestor of this
2140
branch and the one at location path
2141
-rdate:yesterday.. show changes since yesterday
2143
When logging a range of revisions using -rX..Y, log starts at
2144
revision Y and searches back in history through the primary
2145
("left-hand") parents until it finds X. When logging just the
2146
top level (using -n1), an error is reported if X is not found
2147
along the way. If multi-level logging is used (-n0), X may be
2148
a nested merge revision and the log will be truncated accordingly.
2152
If parameters are given and the first one is not a branch, the log
2153
will be filtered to show only those revisions that changed the
2154
nominated files or directories.
2156
Filenames are interpreted within their historical context. To log a
2157
deleted file, specify a revision range so that the file existed at
2158
the end or start of the range.
2160
Historical context is also important when interpreting pathnames of
2161
renamed files/directories. Consider the following example:
2163
* revision 1: add tutorial.txt
2164
* revision 2: modify tutorial.txt
2165
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2169
* ``bzr log guide.txt`` will log the file added in revision 1
2171
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2173
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2174
the original file in revision 2.
2176
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2177
was no file called guide.txt in revision 2.
2179
Renames are always followed by log. By design, there is no need to
2180
explicitly ask for this (and no way to stop logging a file back
2181
until it was last renamed).
2185
The --message option can be used for finding revisions that match a
2186
regular expression in a commit message.
2190
GUI tools and IDEs are often better at exploring history than command
2191
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2192
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2193
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2194
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2196
You may find it useful to add the aliases below to ``bazaar.conf``::
2200
top = log -l10 --line
2203
``bzr tip`` will then show the latest revision while ``bzr top``
2204
will show the last 10 mainline revisions. To see the details of a
2205
particular revision X, ``bzr show -rX``.
2207
If you are interested in looking deeper into a particular merge X,
2208
use ``bzr log -n0 -rX``.
2210
``bzr log -v`` on a branch with lots of history is currently
2211
very slow. A fix for this issue is currently under development.
2212
With or without that fix, it is recommended that a revision range
2213
be given when using the -v option.
2215
bzr has a generic full-text matching plugin, bzr-search, that can be
2216
used to find revisions matching user names, commit messages, etc.
2217
Among other features, this plugin can find all revisions containing
2218
a list of words but not others.
2220
When exploring non-mainline history on large projects with deep
2221
history, the performance of log can be greatly improved by installing
2222
the historycache plugin. This plugin buffers historical information
2223
trading disk space for faster speed.
2225
takes_args = ['file*']
2226
_see_also = ['log-formats', 'revisionspec']
2229
help='Show from oldest to newest.'),
2231
custom_help('verbose',
2232
help='Show files changed in each revision.'),
2236
type=bzrlib.option._parse_revision_str,
2238
help='Show just the specified revision.'
2239
' See also "help revisionspec".'),
2241
RegistryOption('authors',
2242
'What names to list as authors - first, all or committer.',
2244
lazy_registry=('bzrlib.log', 'author_list_registry'),
2248
help='Number of levels to display - 0 for all, 1 for flat.',
2250
type=_parse_levels),
2253
help='Show revisions whose message matches this '
2254
'regular expression.',
2258
help='Limit the output to the first N revisions.',
2263
help='Show changes made in each revision as a patch.'),
2264
Option('include-merges',
2265
help='Show merged revisions like --levels 0 does.'),
2266
Option('exclude-common-ancestry',
2267
help='Display only the revisions that are not part'
2268
' of both ancestries (require -rX..Y)'
2271
encoding_type = 'replace'
2274
def run(self, file_list=None, timezone='original',
2285
include_merges=False,
2287
exclude_common_ancestry=False,
2289
from bzrlib.log import (
2291
make_log_request_dict,
2292
_get_info_for_log_files,
2294
direction = (forward and 'forward') or 'reverse'
2295
if (exclude_common_ancestry
2296
and (revision is None or len(revision) != 2)):
2297
raise errors.BzrCommandError(
2298
'--exclude-common-ancestry requires -r with two revisions')
2303
raise errors.BzrCommandError(
2304
'--levels and --include-merges are mutually exclusive')
2306
if change is not None:
2308
raise errors.RangeInChangeOption()
2309
if revision is not None:
2310
raise errors.BzrCommandError(
2311
'--revision and --change are mutually exclusive')
2316
filter_by_dir = False
2318
# find the file ids to log and check for directory filtering
2319
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2320
revision, file_list, self.add_cleanup)
2321
for relpath, file_id, kind in file_info_list:
2323
raise errors.BzrCommandError(
2324
"Path unknown at end or start of revision range: %s" %
2326
# If the relpath is the top of the tree, we log everything
2331
file_ids.append(file_id)
2332
filter_by_dir = filter_by_dir or (
2333
kind in ['directory', 'tree-reference'])
2336
# FIXME ? log the current subdir only RBC 20060203
2337
if revision is not None \
2338
and len(revision) > 0 and revision[0].get_branch():
2339
location = revision[0].get_branch()
2342
dir, relpath = bzrdir.BzrDir.open_containing(location)
2343
b = dir.open_branch()
2344
self.add_cleanup(b.lock_read().unlock)
2345
rev1, rev2 = _get_revision_range(revision, b, self.name())
2347
# Decide on the type of delta & diff filtering to use
2348
# TODO: add an --all-files option to make this configurable & consistent
2356
diff_type = 'partial'
2360
# Build the log formatter
2361
if log_format is None:
2362
log_format = log.log_formatter_registry.get_default(b)
2363
# Make a non-encoding output to include the diffs - bug 328007
2364
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2365
lf = log_format(show_ids=show_ids, to_file=self.outf,
2366
to_exact_file=unencoded_output,
2367
show_timezone=timezone,
2368
delta_format=get_verbosity_level(),
2370
show_advice=levels is None,
2371
author_list_handler=authors)
2373
# Choose the algorithm for doing the logging. It's annoying
2374
# having multiple code paths like this but necessary until
2375
# the underlying repository format is faster at generating
2376
# deltas or can provide everything we need from the indices.
2377
# The default algorithm - match-using-deltas - works for
2378
# multiple files and directories and is faster for small
2379
# amounts of history (200 revisions say). However, it's too
2380
# slow for logging a single file in a repository with deep
2381
# history, i.e. > 10K revisions. In the spirit of "do no
2382
# evil when adding features", we continue to use the
2383
# original algorithm - per-file-graph - for the "single
2384
# file that isn't a directory without showing a delta" case.
2385
partial_history = revision and b.repository._format.supports_chks
2386
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2387
or delta_type or partial_history)
2389
# Build the LogRequest and execute it
2390
if len(file_ids) == 0:
2392
rqst = make_log_request_dict(
2393
direction=direction, specific_fileids=file_ids,
2394
start_revision=rev1, end_revision=rev2, limit=limit,
2395
message_search=message, delta_type=delta_type,
2396
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2397
exclude_common_ancestry=exclude_common_ancestry,
2399
Logger(b, rqst).show(lf)
2402
def _get_revision_range(revisionspec_list, branch, command_name):
2403
"""Take the input of a revision option and turn it into a revision range.
2405
It returns RevisionInfo objects which can be used to obtain the rev_id's
2406
of the desired revisions. It does some user input validations.
2408
if revisionspec_list is None:
2411
elif len(revisionspec_list) == 1:
2412
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2413
elif len(revisionspec_list) == 2:
2414
start_spec = revisionspec_list[0]
2415
end_spec = revisionspec_list[1]
2416
if end_spec.get_branch() != start_spec.get_branch():
2417
# b is taken from revision[0].get_branch(), and
2418
# show_log will use its revision_history. Having
2419
# different branches will lead to weird behaviors.
2420
raise errors.BzrCommandError(
2421
"bzr %s doesn't accept two revisions in different"
2422
" branches." % command_name)
2423
if start_spec.spec is None:
2424
# Avoid loading all the history.
2425
rev1 = RevisionInfo(branch, None, None)
2427
rev1 = start_spec.in_history(branch)
2428
# Avoid loading all of history when we know a missing
2429
# end of range means the last revision ...
2430
if end_spec.spec is None:
2431
last_revno, last_revision_id = branch.last_revision_info()
2432
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2434
rev2 = end_spec.in_history(branch)
2436
raise errors.BzrCommandError(
2437
'bzr %s --revision takes one or two values.' % command_name)
2441
def _revision_range_to_revid_range(revision_range):
2444
if revision_range[0] is not None:
2445
rev_id1 = revision_range[0].rev_id
2446
if revision_range[1] is not None:
2447
rev_id2 = revision_range[1].rev_id
2448
return rev_id1, rev_id2
2450
def get_log_format(long=False, short=False, line=False, default='long'):
2451
log_format = default
2455
log_format = 'short'
2461
class cmd_touching_revisions(Command):
2462
__doc__ = """Return revision-ids which affected a particular file.
2464
A more user-friendly interface is "bzr log FILE".
2468
takes_args = ["filename"]
2471
def run(self, filename):
2472
tree, relpath = WorkingTree.open_containing(filename)
2473
file_id = tree.path2id(relpath)
2475
self.add_cleanup(b.lock_read().unlock)
2476
touching_revs = log.find_touching_revisions(b, file_id)
2477
for revno, revision_id, what in touching_revs:
2478
self.outf.write("%6d %s\n" % (revno, what))
2481
class cmd_ls(Command):
2482
__doc__ = """List files in a tree.
2485
_see_also = ['status', 'cat']
2486
takes_args = ['path?']
2490
Option('recursive', short_name='R',
2491
help='Recurse into subdirectories.'),
2493
help='Print paths relative to the root of the branch.'),
2494
Option('unknown', short_name='u',
2495
help='Print unknown files.'),
2496
Option('versioned', help='Print versioned files.',
2498
Option('ignored', short_name='i',
2499
help='Print ignored files.'),
2500
Option('kind', short_name='k',
2501
help='List entries of a particular kind: file, directory, symlink.',
2508
def run(self, revision=None, verbose=False,
2509
recursive=False, from_root=False,
2510
unknown=False, versioned=False, ignored=False,
2511
null=False, kind=None, show_ids=False, path=None, directory=None):
2513
if kind and kind not in ('file', 'directory', 'symlink'):
2514
raise errors.BzrCommandError('invalid kind specified')
2516
if verbose and null:
2517
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2518
all = not (unknown or versioned or ignored)
2520
selection = {'I':ignored, '?':unknown, 'V':versioned}
2526
raise errors.BzrCommandError('cannot specify both --from-root'
2529
tree, branch, relpath = \
2530
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2532
# Calculate the prefix to use
2536
prefix = relpath + '/'
2537
elif fs_path != '.' and not fs_path.endswith('/'):
2538
prefix = fs_path + '/'
2540
if revision is not None or tree is None:
2541
tree = _get_one_revision_tree('ls', revision, branch=branch)
2544
if isinstance(tree, WorkingTree) and tree.supports_views():
2545
view_files = tree.views.lookup_view()
2548
view_str = views.view_display_str(view_files)
2549
note("Ignoring files outside view. View is %s" % view_str)
2551
self.add_cleanup(tree.lock_read().unlock)
2552
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2553
from_dir=relpath, recursive=recursive):
2554
# Apply additional masking
2555
if not all and not selection[fc]:
2557
if kind is not None and fkind != kind:
2562
fullpath = osutils.pathjoin(relpath, fp)
2565
views.check_path_in_view(tree, fullpath)
2566
except errors.FileOutsideView:
2571
fp = osutils.pathjoin(prefix, fp)
2572
kindch = entry.kind_character()
2573
outstring = fp + kindch
2574
ui.ui_factory.clear_term()
2576
outstring = '%-8s %s' % (fc, outstring)
2577
if show_ids and fid is not None:
2578
outstring = "%-50s %s" % (outstring, fid)
2579
self.outf.write(outstring + '\n')
2581
self.outf.write(fp + '\0')
2584
self.outf.write(fid)
2585
self.outf.write('\0')
2593
self.outf.write('%-50s %s\n' % (outstring, my_id))
2595
self.outf.write(outstring + '\n')
2598
class cmd_unknowns(Command):
2599
__doc__ = """List unknown files.
2604
takes_options = ['directory']
2607
def run(self, directory=u'.'):
2608
for f in WorkingTree.open_containing(directory)[0].unknowns():
2609
self.outf.write(osutils.quotefn(f) + '\n')
2612
class cmd_ignore(Command):
2613
__doc__ = """Ignore specified files or patterns.
2615
See ``bzr help patterns`` for details on the syntax of patterns.
2617
If a .bzrignore file does not exist, the ignore command
2618
will create one and add the specified files or patterns to the newly
2619
created file. The ignore command will also automatically add the
2620
.bzrignore file to be versioned. Creating a .bzrignore file without
2621
the use of the ignore command will require an explicit add command.
2623
To remove patterns from the ignore list, edit the .bzrignore file.
2624
After adding, editing or deleting that file either indirectly by
2625
using this command or directly by using an editor, be sure to commit
2628
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2629
the global ignore file can be found in the application data directory as
2630
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2631
Global ignores are not touched by this command. The global ignore file
2632
can be edited directly using an editor.
2634
Patterns prefixed with '!' are exceptions to ignore patterns and take
2635
precedence over regular ignores. Such exceptions are used to specify
2636
files that should be versioned which would otherwise be ignored.
2638
Patterns prefixed with '!!' act as regular ignore patterns, but have
2639
precedence over the '!' exception patterns.
2641
Note: ignore patterns containing shell wildcards must be quoted from
2645
Ignore the top level Makefile::
2647
bzr ignore ./Makefile
2649
Ignore .class files in all directories...::
2651
bzr ignore "*.class"
2653
...but do not ignore "special.class"::
2655
bzr ignore "!special.class"
2657
Ignore .o files under the lib directory::
2659
bzr ignore "lib/**/*.o"
2661
Ignore .o files under the lib directory::
2663
bzr ignore "RE:lib/.*\.o"
2665
Ignore everything but the "debian" toplevel directory::
2667
bzr ignore "RE:(?!debian/).*"
2669
Ignore everything except the "local" toplevel directory,
2670
but always ignore "*~" autosave files, even under local/::
2673
bzr ignore "!./local"
2677
_see_also = ['status', 'ignored', 'patterns']
2678
takes_args = ['name_pattern*']
2679
takes_options = ['directory',
2680
Option('default-rules',
2681
help='Display the default ignore rules that bzr uses.')
2684
def run(self, name_pattern_list=None, default_rules=None,
2686
from bzrlib import ignores
2687
if default_rules is not None:
2688
# dump the default rules and exit
2689
for pattern in ignores.USER_DEFAULTS:
2690
self.outf.write("%s\n" % pattern)
2692
if not name_pattern_list:
2693
raise errors.BzrCommandError("ignore requires at least one "
2694
"NAME_PATTERN or --default-rules.")
2695
name_pattern_list = [globbing.normalize_pattern(p)
2696
for p in name_pattern_list]
2698
for p in name_pattern_list:
2699
if not globbing.Globster.is_pattern_valid(p):
2700
bad_patterns += ('\n %s' % p)
2702
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2703
ui.ui_factory.show_error(msg)
2704
raise errors.InvalidPattern('')
2705
for name_pattern in name_pattern_list:
2706
if (name_pattern[0] == '/' or
2707
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2708
raise errors.BzrCommandError(
2709
"NAME_PATTERN should not be an absolute path")
2710
tree, relpath = WorkingTree.open_containing(directory)
2711
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2712
ignored = globbing.Globster(name_pattern_list)
2714
self.add_cleanup(tree.lock_read().unlock)
2715
for entry in tree.list_files():
2719
if ignored.match(filename):
2720
matches.append(filename)
2721
if len(matches) > 0:
2722
self.outf.write("Warning: the following files are version controlled and"
2723
" match your ignore pattern:\n%s"
2724
"\nThese files will continue to be version controlled"
2725
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2728
class cmd_ignored(Command):
2729
__doc__ = """List ignored files and the patterns that matched them.
2731
List all the ignored files and the ignore pattern that caused the file to
2734
Alternatively, to list just the files::
2739
encoding_type = 'replace'
2740
_see_also = ['ignore', 'ls']
2741
takes_options = ['directory']
2744
def run(self, directory=u'.'):
2745
tree = WorkingTree.open_containing(directory)[0]
2746
self.add_cleanup(tree.lock_read().unlock)
2747
for path, file_class, kind, file_id, entry in tree.list_files():
2748
if file_class != 'I':
2750
## XXX: Slightly inefficient since this was already calculated
2751
pat = tree.is_ignored(path)
2752
self.outf.write('%-50s %s\n' % (path, pat))
2755
class cmd_lookup_revision(Command):
2756
__doc__ = """Lookup the revision-id from a revision-number
2759
bzr lookup-revision 33
2762
takes_args = ['revno']
2763
takes_options = ['directory']
2766
def run(self, revno, directory=u'.'):
2770
raise errors.BzrCommandError("not a valid revision-number: %r"
2772
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2773
self.outf.write("%s\n" % revid)
2776
class cmd_export(Command):
2777
__doc__ = """Export current or past revision to a destination directory or archive.
2779
If no revision is specified this exports the last committed revision.
2781
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2782
given, try to find the format with the extension. If no extension
2783
is found exports to a directory (equivalent to --format=dir).
2785
If root is supplied, it will be used as the root directory inside
2786
container formats (tar, zip, etc). If it is not supplied it will default
2787
to the exported filename. The root option has no effect for 'dir' format.
2789
If branch is omitted then the branch containing the current working
2790
directory will be used.
2792
Note: Export of tree with non-ASCII filenames to zip is not supported.
2794
================= =========================
2795
Supported formats Autodetected by extension
2796
================= =========================
2799
tbz2 .tar.bz2, .tbz2
2802
================= =========================
2804
takes_args = ['dest', 'branch_or_subdir?']
2805
takes_options = ['directory',
2807
help="Type of file to export to.",
2810
Option('filters', help='Apply content filters to export the '
2811
'convenient form.'),
2814
help="Name of the root directory inside the exported file."),
2815
Option('per-file-timestamps',
2816
help='Set modification time of files to that of the last '
2817
'revision in which it was changed.'),
2819
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2820
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2821
from bzrlib.export import export
2823
if branch_or_subdir is None:
2824
tree = WorkingTree.open_containing(directory)[0]
2828
b, subdir = Branch.open_containing(branch_or_subdir)
2831
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2833
export(rev_tree, dest, format, root, subdir, filtered=filters,
2834
per_file_timestamps=per_file_timestamps)
2835
except errors.NoSuchExportFormat, e:
2836
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2839
class cmd_cat(Command):
2840
__doc__ = """Write the contents of a file as of a given revision to standard output.
2842
If no revision is nominated, the last revision is used.
2844
Note: Take care to redirect standard output when using this command on a
2849
takes_options = ['directory',
2850
Option('name-from-revision', help='The path name in the old tree.'),
2851
Option('filters', help='Apply content filters to display the '
2852
'convenience form.'),
2855
takes_args = ['filename']
2856
encoding_type = 'exact'
2859
def run(self, filename, revision=None, name_from_revision=False,
2860
filters=False, directory=None):
2861
if revision is not None and len(revision) != 1:
2862
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2863
" one revision specifier")
2864
tree, branch, relpath = \
2865
_open_directory_or_containing_tree_or_branch(filename, directory)
2866
self.add_cleanup(branch.lock_read().unlock)
2867
return self._run(tree, branch, relpath, filename, revision,
2868
name_from_revision, filters)
2870
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2873
tree = b.basis_tree()
2874
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2875
self.add_cleanup(rev_tree.lock_read().unlock)
2877
old_file_id = rev_tree.path2id(relpath)
2879
if name_from_revision:
2880
# Try in revision if requested
2881
if old_file_id is None:
2882
raise errors.BzrCommandError(
2883
"%r is not present in revision %s" % (
2884
filename, rev_tree.get_revision_id()))
2886
content = rev_tree.get_file_text(old_file_id)
2888
cur_file_id = tree.path2id(relpath)
2890
if cur_file_id is not None:
2891
# Then try with the actual file id
2893
content = rev_tree.get_file_text(cur_file_id)
2895
except errors.NoSuchId:
2896
# The actual file id didn't exist at that time
2898
if not found and old_file_id is not None:
2899
# Finally try with the old file id
2900
content = rev_tree.get_file_text(old_file_id)
2903
# Can't be found anywhere
2904
raise errors.BzrCommandError(
2905
"%r is not present in revision %s" % (
2906
filename, rev_tree.get_revision_id()))
2908
from bzrlib.filters import (
2909
ContentFilterContext,
2910
filtered_output_bytes,
2912
filters = rev_tree._content_filter_stack(relpath)
2913
chunks = content.splitlines(True)
2914
content = filtered_output_bytes(chunks, filters,
2915
ContentFilterContext(relpath, rev_tree))
2917
self.outf.writelines(content)
2920
self.outf.write(content)
2923
class cmd_local_time_offset(Command):
2924
__doc__ = """Show the offset in seconds from GMT to local time."""
2928
self.outf.write("%s\n" % osutils.local_time_offset())
2932
class cmd_commit(Command):
2933
__doc__ = """Commit changes into a new revision.
2935
An explanatory message needs to be given for each commit. This is
2936
often done by using the --message option (getting the message from the
2937
command line) or by using the --file option (getting the message from
2938
a file). If neither of these options is given, an editor is opened for
2939
the user to enter the message. To see the changed files in the
2940
boilerplate text loaded into the editor, use the --show-diff option.
2942
By default, the entire tree is committed and the person doing the
2943
commit is assumed to be the author. These defaults can be overridden
2948
If selected files are specified, only changes to those files are
2949
committed. If a directory is specified then the directory and
2950
everything within it is committed.
2952
When excludes are given, they take precedence over selected files.
2953
For example, to commit only changes within foo, but not changes
2956
bzr commit foo -x foo/bar
2958
A selective commit after a merge is not yet supported.
2962
If the author of the change is not the same person as the committer,
2963
you can specify the author's name using the --author option. The
2964
name should be in the same format as a committer-id, e.g.
2965
"John Doe <jdoe@example.com>". If there is more than one author of
2966
the change you can specify the option multiple times, once for each
2971
A common mistake is to forget to add a new file or directory before
2972
running the commit command. The --strict option checks for unknown
2973
files and aborts the commit if any are found. More advanced pre-commit
2974
checks can be implemented by defining hooks. See ``bzr help hooks``
2979
If you accidentially commit the wrong changes or make a spelling
2980
mistake in the commit message say, you can use the uncommit command
2981
to undo it. See ``bzr help uncommit`` for details.
2983
Hooks can also be configured to run after a commit. This allows you
2984
to trigger updates to external systems like bug trackers. The --fixes
2985
option can be used to record the association between a revision and
2986
one or more bugs. See ``bzr help bugs`` for details.
2988
A selective commit may fail in some cases where the committed
2989
tree would be invalid. Consider::
2994
bzr commit foo -m "committing foo"
2995
bzr mv foo/bar foo/baz
2998
bzr commit foo/bar -m "committing bar but not baz"
3000
In the example above, the last commit will fail by design. This gives
3001
the user the opportunity to decide whether they want to commit the
3002
rename at the same time, separately first, or not at all. (As a general
3003
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3005
# TODO: Run hooks on tree to-be-committed, and after commit.
3007
# TODO: Strict commit that fails if there are deleted files.
3008
# (what does "deleted files" mean ??)
3010
# TODO: Give better message for -s, --summary, used by tla people
3012
# XXX: verbose currently does nothing
3014
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3015
takes_args = ['selected*']
3017
ListOption('exclude', type=str, short_name='x',
3018
help="Do not consider changes made to a given path."),
3019
Option('message', type=unicode,
3021
help="Description of the new revision."),
3024
help='Commit even if nothing has changed.'),
3025
Option('file', type=str,
3028
help='Take commit message from this file.'),
3030
help="Refuse to commit if there are unknown "
3031
"files in the working tree."),
3032
Option('commit-time', type=str,
3033
help="Manually set a commit time using commit date "
3034
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3035
ListOption('fixes', type=str,
3036
help="Mark a bug as being fixed by this revision "
3037
"(see \"bzr help bugs\")."),
3038
ListOption('author', type=unicode,
3039
help="Set the author's name, if it's different "
3040
"from the committer."),
3042
help="Perform a local commit in a bound "
3043
"branch. Local commits are not pushed to "
3044
"the master branch until a normal commit "
3047
Option('show-diff', short_name='p',
3048
help='When no message is supplied, show the diff along'
3049
' with the status summary in the message editor.'),
3051
aliases = ['ci', 'checkin']
3053
def _iter_bug_fix_urls(self, fixes, branch):
3054
# Configure the properties for bug fixing attributes.
3055
for fixed_bug in fixes:
3056
tokens = fixed_bug.split(':')
3057
if len(tokens) != 2:
3058
raise errors.BzrCommandError(
3059
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3060
"See \"bzr help bugs\" for more information on this "
3061
"feature.\nCommit refused." % fixed_bug)
3062
tag, bug_id = tokens
3064
yield bugtracker.get_bug_url(tag, branch, bug_id)
3065
except errors.UnknownBugTrackerAbbreviation:
3066
raise errors.BzrCommandError(
3067
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3068
except errors.MalformedBugIdentifier, e:
3069
raise errors.BzrCommandError(
3070
"%s\nCommit refused." % (str(e),))
3072
def run(self, message=None, file=None, verbose=False, selected_list=None,
3073
unchanged=False, strict=False, local=False, fixes=None,
3074
author=None, show_diff=False, exclude=None, commit_time=None):
3075
from bzrlib.errors import (
3080
from bzrlib.msgeditor import (
3081
edit_commit_message_encoded,
3082
generate_commit_message_template,
3083
make_commit_message_template_encoded
3086
commit_stamp = offset = None
3087
if commit_time is not None:
3089
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3090
except ValueError, e:
3091
raise errors.BzrCommandError(
3092
"Could not parse --commit-time: " + str(e))
3094
# TODO: Need a blackbox test for invoking the external editor; may be
3095
# slightly problematic to run this cross-platform.
3097
# TODO: do more checks that the commit will succeed before
3098
# spending the user's valuable time typing a commit message.
3102
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3103
if selected_list == ['']:
3104
# workaround - commit of root of tree should be exactly the same
3105
# as just default commit in that tree, and succeed even though
3106
# selected-file merge commit is not done yet
3111
bug_property = bugtracker.encode_fixes_bug_urls(
3112
self._iter_bug_fix_urls(fixes, tree.branch))
3114
properties['bugs'] = bug_property
3116
if local and not tree.branch.get_bound_location():
3117
raise errors.LocalRequiresBoundBranch()
3119
if message is not None:
3121
file_exists = osutils.lexists(message)
3122
except UnicodeError:
3123
# The commit message contains unicode characters that can't be
3124
# represented in the filesystem encoding, so that can't be a
3129
'The commit message is a file name: "%(f)s".\n'
3130
'(use --file "%(f)s" to take commit message from that file)'
3132
ui.ui_factory.show_warning(warning_msg)
3134
message = message.replace('\r\n', '\n')
3135
message = message.replace('\r', '\n')
3137
raise errors.BzrCommandError(
3138
"please specify either --message or --file")
3140
def get_message(commit_obj):
3141
"""Callback to get commit message"""
3145
my_message = f.read().decode(osutils.get_user_encoding())
3148
elif message is not None:
3149
my_message = message
3151
# No message supplied: make one up.
3152
# text is the status of the tree
3153
text = make_commit_message_template_encoded(tree,
3154
selected_list, diff=show_diff,
3155
output_encoding=osutils.get_user_encoding())
3156
# start_message is the template generated from hooks
3157
# XXX: Warning - looks like hooks return unicode,
3158
# make_commit_message_template_encoded returns user encoding.
3159
# We probably want to be using edit_commit_message instead to
3161
start_message = generate_commit_message_template(commit_obj)
3162
my_message = edit_commit_message_encoded(text,
3163
start_message=start_message)
3164
if my_message is None:
3165
raise errors.BzrCommandError("please specify a commit"
3166
" message with either --message or --file")
3167
if my_message == "":
3168
raise errors.BzrCommandError("empty commit message specified")
3171
# The API permits a commit with a filter of [] to mean 'select nothing'
3172
# but the command line should not do that.
3173
if not selected_list:
3174
selected_list = None
3176
tree.commit(message_callback=get_message,
3177
specific_files=selected_list,
3178
allow_pointless=unchanged, strict=strict, local=local,
3179
reporter=None, verbose=verbose, revprops=properties,
3180
authors=author, timestamp=commit_stamp,
3182
exclude=tree.safe_relpath_files(exclude))
3183
except PointlessCommit:
3184
raise errors.BzrCommandError("No changes to commit."
3185
" Use --unchanged to commit anyhow.")
3186
except ConflictsInTree:
3187
raise errors.BzrCommandError('Conflicts detected in working '
3188
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3190
except StrictCommitFailed:
3191
raise errors.BzrCommandError("Commit refused because there are"
3192
" unknown files in the working tree.")
3193
except errors.BoundBranchOutOfDate, e:
3194
e.extra_help = ("\n"
3195
'To commit to master branch, run update and then commit.\n'
3196
'You can also pass --local to commit to continue working '
3201
class cmd_check(Command):
3202
__doc__ = """Validate working tree structure, branch consistency and repository history.
3204
This command checks various invariants about branch and repository storage
3205
to detect data corruption or bzr bugs.
3207
The working tree and branch checks will only give output if a problem is
3208
detected. The output fields of the repository check are:
3211
This is just the number of revisions checked. It doesn't
3215
This is just the number of versionedfiles checked. It
3216
doesn't indicate a problem.
3218
unreferenced ancestors
3219
Texts that are ancestors of other texts, but
3220
are not properly referenced by the revision ancestry. This is a
3221
subtle problem that Bazaar can work around.
3224
This is the total number of unique file contents
3225
seen in the checked revisions. It does not indicate a problem.
3228
This is the total number of repeated texts seen
3229
in the checked revisions. Texts can be repeated when their file
3230
entries are modified, but the file contents are not. It does not
3233
If no restrictions are specified, all Bazaar data that is found at the given
3234
location will be checked.
3238
Check the tree and branch at 'foo'::
3240
bzr check --tree --branch foo
3242
Check only the repository at 'bar'::
3244
bzr check --repo bar
3246
Check everything at 'baz'::
3251
_see_also = ['reconcile']
3252
takes_args = ['path?']
3253
takes_options = ['verbose',
3254
Option('branch', help="Check the branch related to the"
3255
" current directory."),
3256
Option('repo', help="Check the repository related to the"
3257
" current directory."),
3258
Option('tree', help="Check the working tree related to"
3259
" the current directory.")]
3261
def run(self, path=None, verbose=False, branch=False, repo=False,
3263
from bzrlib.check import check_dwim
3266
if not branch and not repo and not tree:
3267
branch = repo = tree = True
3268
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3271
class cmd_upgrade(Command):
3272
__doc__ = """Upgrade branch storage to current format.
3274
The check command or bzr developers may sometimes advise you to run
3275
this command. When the default format has changed you may also be warned
3276
during other operations to upgrade.
3279
_see_also = ['check']
3280
takes_args = ['url?']
3282
RegistryOption('format',
3283
help='Upgrade to a specific format. See "bzr help'
3284
' formats" for details.',
3285
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3286
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3287
value_switches=True, title='Branch format'),
3290
def run(self, url='.', format=None):
3291
from bzrlib.upgrade import upgrade
3292
upgrade(url, format)
3295
class cmd_whoami(Command):
3296
__doc__ = """Show or set bzr user id.
3299
Show the email of the current user::
3303
Set the current user::
3305
bzr whoami "Frank Chu <fchu@example.com>"
3307
takes_options = [ 'directory',
3309
help='Display email address only.'),
3311
help='Set identity for the current branch instead of '
3314
takes_args = ['name?']
3315
encoding_type = 'replace'
3318
def run(self, email=False, branch=False, name=None, directory=None):
3320
if directory is None:
3321
# use branch if we're inside one; otherwise global config
3323
c = Branch.open_containing(u'.')[0].get_config()
3324
except errors.NotBranchError:
3325
c = _mod_config.GlobalConfig()
3327
c = Branch.open(directory).get_config()
3329
self.outf.write(c.user_email() + '\n')
3331
self.outf.write(c.username() + '\n')
3334
# display a warning if an email address isn't included in the given name.
3336
_mod_config.extract_email_address(name)
3337
except errors.NoEmailInUsername, e:
3338
warning('"%s" does not seem to contain an email address. '
3339
'This is allowed, but not recommended.', name)
3341
# use global config unless --branch given
3343
if directory is None:
3344
c = Branch.open_containing(u'.')[0].get_config()
3346
c = Branch.open(directory).get_config()
3348
c = _mod_config.GlobalConfig()
3349
c.set_user_option('email', name)
3352
class cmd_nick(Command):
3353
__doc__ = """Print or set the branch nickname.
3355
If unset, the tree root directory name is used as the nickname.
3356
To print the current nickname, execute with no argument.
3358
Bound branches use the nickname of its master branch unless it is set
3362
_see_also = ['info']
3363
takes_args = ['nickname?']
3364
takes_options = ['directory']
3365
def run(self, nickname=None, directory=u'.'):
3366
branch = Branch.open_containing(directory)[0]
3367
if nickname is None:
3368
self.printme(branch)
3370
branch.nick = nickname
3373
def printme(self, branch):
3374
self.outf.write('%s\n' % branch.nick)
3377
class cmd_alias(Command):
3378
__doc__ = """Set/unset and display aliases.
3381
Show the current aliases::
3385
Show the alias specified for 'll'::
3389
Set an alias for 'll'::
3391
bzr alias ll="log --line -r-10..-1"
3393
To remove an alias for 'll'::
3395
bzr alias --remove ll
3398
takes_args = ['name?']
3400
Option('remove', help='Remove the alias.'),
3403
def run(self, name=None, remove=False):
3405
self.remove_alias(name)
3407
self.print_aliases()
3409
equal_pos = name.find('=')
3411
self.print_alias(name)
3413
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3415
def remove_alias(self, alias_name):
3416
if alias_name is None:
3417
raise errors.BzrCommandError(
3418
'bzr alias --remove expects an alias to remove.')
3419
# If alias is not found, print something like:
3420
# unalias: foo: not found
3421
c = _mod_config.GlobalConfig()
3422
c.unset_alias(alias_name)
3425
def print_aliases(self):
3426
"""Print out the defined aliases in a similar format to bash."""
3427
aliases = _mod_config.GlobalConfig().get_aliases()
3428
for key, value in sorted(aliases.iteritems()):
3429
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3432
def print_alias(self, alias_name):
3433
from bzrlib.commands import get_alias
3434
alias = get_alias(alias_name)
3436
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3439
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3441
def set_alias(self, alias_name, alias_command):
3442
"""Save the alias in the global config."""
3443
c = _mod_config.GlobalConfig()
3444
c.set_alias(alias_name, alias_command)
3447
class cmd_selftest(Command):
3448
__doc__ = """Run internal test suite.
3450
If arguments are given, they are regular expressions that say which tests
3451
should run. Tests matching any expression are run, and other tests are
3454
Alternatively if --first is given, matching tests are run first and then
3455
all other tests are run. This is useful if you have been working in a
3456
particular area, but want to make sure nothing else was broken.
3458
If --exclude is given, tests that match that regular expression are
3459
excluded, regardless of whether they match --first or not.
3461
To help catch accidential dependencies between tests, the --randomize
3462
option is useful. In most cases, the argument used is the word 'now'.
3463
Note that the seed used for the random number generator is displayed
3464
when this option is used. The seed can be explicitly passed as the
3465
argument to this option if required. This enables reproduction of the
3466
actual ordering used if and when an order sensitive problem is encountered.
3468
If --list-only is given, the tests that would be run are listed. This is
3469
useful when combined with --first, --exclude and/or --randomize to
3470
understand their impact. The test harness reports "Listed nn tests in ..."
3471
instead of "Ran nn tests in ..." when list mode is enabled.
3473
If the global option '--no-plugins' is given, plugins are not loaded
3474
before running the selftests. This has two effects: features provided or
3475
modified by plugins will not be tested, and tests provided by plugins will
3478
Tests that need working space on disk use a common temporary directory,
3479
typically inside $TMPDIR or /tmp.
3481
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3482
into a pdb postmortem session.
3485
Run only tests relating to 'ignore'::
3489
Disable plugins and list tests as they're run::
3491
bzr --no-plugins selftest -v
3493
# NB: this is used from the class without creating an instance, which is
3494
# why it does not have a self parameter.
3495
def get_transport_type(typestring):
3496
"""Parse and return a transport specifier."""
3497
if typestring == "sftp":
3498
from bzrlib.tests import stub_sftp
3499
return stub_sftp.SFTPAbsoluteServer
3500
if typestring == "memory":
3501
from bzrlib.tests import test_server
3502
return memory.MemoryServer
3503
if typestring == "fakenfs":
3504
from bzrlib.tests import test_server
3505
return test_server.FakeNFSServer
3506
msg = "No known transport type %s. Supported types are: sftp\n" %\
3508
raise errors.BzrCommandError(msg)
3511
takes_args = ['testspecs*']
3512
takes_options = ['verbose',
3514
help='Stop when one test fails.',
3518
help='Use a different transport by default '
3519
'throughout the test suite.',
3520
type=get_transport_type),
3522
help='Run the benchmarks rather than selftests.',
3524
Option('lsprof-timed',
3525
help='Generate lsprof output for benchmarked'
3526
' sections of code.'),
3527
Option('lsprof-tests',
3528
help='Generate lsprof output for each test.'),
3530
help='Run all tests, but run specified tests first.',
3534
help='List the tests instead of running them.'),
3535
RegistryOption('parallel',
3536
help="Run the test suite in parallel.",
3537
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3538
value_switches=False,
3540
Option('randomize', type=str, argname="SEED",
3541
help='Randomize the order of tests using the given'
3542
' seed or "now" for the current time.'),
3543
Option('exclude', type=str, argname="PATTERN",
3545
help='Exclude tests that match this regular'
3548
help='Output test progress via subunit.'),
3549
Option('strict', help='Fail on missing dependencies or '
3551
Option('load-list', type=str, argname='TESTLISTFILE',
3552
help='Load a test id list from a text file.'),
3553
ListOption('debugflag', type=str, short_name='E',
3554
help='Turn on a selftest debug flag.'),
3555
ListOption('starting-with', type=str, argname='TESTID',
3556
param_name='starting_with', short_name='s',
3558
'Load only the tests starting with TESTID.'),
3560
encoding_type = 'replace'
3563
Command.__init__(self)
3564
self.additional_selftest_args = {}
3566
def run(self, testspecs_list=None, verbose=False, one=False,
3567
transport=None, benchmark=None,
3569
first=False, list_only=False,
3570
randomize=None, exclude=None, strict=False,
3571
load_list=None, debugflag=None, starting_with=None, subunit=False,
3572
parallel=None, lsprof_tests=False):
3573
from bzrlib import tests
3575
if testspecs_list is not None:
3576
pattern = '|'.join(testspecs_list)
3581
from bzrlib.tests import SubUnitBzrRunner
3583
raise errors.BzrCommandError("subunit not available. subunit "
3584
"needs to be installed to use --subunit.")
3585
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3586
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3587
# stdout, which would corrupt the subunit stream.
3588
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3589
# following code can be deleted when it's sufficiently deployed
3590
# -- vila/mgz 20100514
3591
if (sys.platform == "win32"
3592
and getattr(sys.stdout, 'fileno', None) is not None):
3594
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3596
self.additional_selftest_args.setdefault(
3597
'suite_decorators', []).append(parallel)
3599
raise errors.BzrCommandError(
3600
"--benchmark is no longer supported from bzr 2.2; "
3601
"use bzr-usertest instead")
3602
test_suite_factory = None
3603
selftest_kwargs = {"verbose": verbose,
3605
"stop_on_failure": one,
3606
"transport": transport,
3607
"test_suite_factory": test_suite_factory,
3608
"lsprof_timed": lsprof_timed,
3609
"lsprof_tests": lsprof_tests,
3610
"matching_tests_first": first,
3611
"list_only": list_only,
3612
"random_seed": randomize,
3613
"exclude_pattern": exclude,
3615
"load_list": load_list,
3616
"debug_flags": debugflag,
3617
"starting_with": starting_with
3619
selftest_kwargs.update(self.additional_selftest_args)
3621
# Make deprecation warnings visible, unless -Werror is set
3622
cleanup = symbol_versioning.activate_deprecation_warnings(
3625
result = tests.selftest(**selftest_kwargs)
3628
return int(not result)
3631
class cmd_version(Command):
3632
__doc__ = """Show version of bzr."""
3634
encoding_type = 'replace'
3636
Option("short", help="Print just the version number."),
3640
def run(self, short=False):
3641
from bzrlib.version import show_version
3643
self.outf.write(bzrlib.version_string + '\n')
3645
show_version(to_file=self.outf)
3648
class cmd_rocks(Command):
3649
__doc__ = """Statement of optimism."""
3655
self.outf.write("It sure does!\n")
3658
class cmd_find_merge_base(Command):
3659
__doc__ = """Find and print a base revision for merging two branches."""
3660
# TODO: Options to specify revisions on either side, as if
3661
# merging only part of the history.
3662
takes_args = ['branch', 'other']
3666
def run(self, branch, other):
3667
from bzrlib.revision import ensure_null
3669
branch1 = Branch.open_containing(branch)[0]
3670
branch2 = Branch.open_containing(other)[0]
3671
self.add_cleanup(branch1.lock_read().unlock)
3672
self.add_cleanup(branch2.lock_read().unlock)
3673
last1 = ensure_null(branch1.last_revision())
3674
last2 = ensure_null(branch2.last_revision())
3676
graph = branch1.repository.get_graph(branch2.repository)
3677
base_rev_id = graph.find_unique_lca(last1, last2)
3679
self.outf.write('merge base is revision %s\n' % base_rev_id)
3682
class cmd_merge(Command):
3683
__doc__ = """Perform a three-way merge.
3685
The source of the merge can be specified either in the form of a branch,
3686
or in the form of a path to a file containing a merge directive generated
3687
with bzr send. If neither is specified, the default is the upstream branch
3688
or the branch most recently merged using --remember.
3690
When merging a branch, by default the tip will be merged. To pick a different
3691
revision, pass --revision. If you specify two values, the first will be used as
3692
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3693
available revisions, like this is commonly referred to as "cherrypicking".
3695
Revision numbers are always relative to the branch being merged.
3697
By default, bzr will try to merge in all new work from the other
3698
branch, automatically determining an appropriate base. If this
3699
fails, you may need to give an explicit base.
3701
Merge will do its best to combine the changes in two branches, but there
3702
are some kinds of problems only a human can fix. When it encounters those,
3703
it will mark a conflict. A conflict means that you need to fix something,
3704
before you should commit.
3706
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3708
If there is no default branch set, the first merge will set it. After
3709
that, you can omit the branch to use the default. To change the
3710
default, use --remember. The value will only be saved if the remote
3711
location can be accessed.
3713
The results of the merge are placed into the destination working
3714
directory, where they can be reviewed (with bzr diff), tested, and then
3715
committed to record the result of the merge.
3717
merge refuses to run if there are any uncommitted changes, unless
3718
--force is given. The --force option can also be used to create a
3719
merge revision which has more than two parents.
3721
If one would like to merge changes from the working tree of the other
3722
branch without merging any committed revisions, the --uncommitted option
3725
To select only some changes to merge, use "merge -i", which will prompt
3726
you to apply each diff hunk and file change, similar to "shelve".
3729
To merge the latest revision from bzr.dev::
3731
bzr merge ../bzr.dev
3733
To merge changes up to and including revision 82 from bzr.dev::
3735
bzr merge -r 82 ../bzr.dev
3737
To merge the changes introduced by 82, without previous changes::
3739
bzr merge -r 81..82 ../bzr.dev
3741
To apply a merge directive contained in /tmp/merge::
3743
bzr merge /tmp/merge
3745
To create a merge revision with three parents from two branches
3746
feature1a and feature1b:
3748
bzr merge ../feature1a
3749
bzr merge ../feature1b --force
3750
bzr commit -m 'revision with three parents'
3753
encoding_type = 'exact'
3754
_see_also = ['update', 'remerge', 'status-flags', 'send']
3755
takes_args = ['location?']
3760
help='Merge even if the destination tree has uncommitted changes.'),
3764
Option('show-base', help="Show base revision text in "
3766
Option('uncommitted', help='Apply uncommitted changes'
3767
' from a working copy, instead of branch changes.'),
3768
Option('pull', help='If the destination is already'
3769
' completely merged into the source, pull from the'
3770
' source rather than merging. When this happens,'
3771
' you do not need to commit the result.'),
3772
custom_help('directory',
3773
help='Branch to merge into, '
3774
'rather than the one containing the working directory.'),
3775
Option('preview', help='Instead of merging, show a diff of the'
3777
Option('interactive', help='Select changes interactively.',
3781
def run(self, location=None, revision=None, force=False,
3782
merge_type=None, show_base=False, reprocess=None, remember=False,
3783
uncommitted=False, pull=False,
3788
if merge_type is None:
3789
merge_type = _mod_merge.Merge3Merger
3791
if directory is None: directory = u'.'
3792
possible_transports = []
3794
allow_pending = True
3795
verified = 'inapplicable'
3796
tree = WorkingTree.open_containing(directory)[0]
3799
basis_tree = tree.revision_tree(tree.last_revision())
3800
except errors.NoSuchRevision:
3801
basis_tree = tree.basis_tree()
3803
# die as quickly as possible if there are uncommitted changes
3805
if tree.has_changes():
3806
raise errors.UncommittedChanges(tree)
3808
view_info = _get_view_info_for_change_reporter(tree)
3809
change_reporter = delta._ChangeReporter(
3810
unversioned_filter=tree.is_ignored, view_info=view_info)
3811
pb = ui.ui_factory.nested_progress_bar()
3812
self.add_cleanup(pb.finished)
3813
self.add_cleanup(tree.lock_write().unlock)
3814
if location is not None:
3816
mergeable = bundle.read_mergeable_from_url(location,
3817
possible_transports=possible_transports)
3818
except errors.NotABundle:
3822
raise errors.BzrCommandError('Cannot use --uncommitted'
3823
' with bundles or merge directives.')
3825
if revision is not None:
3826
raise errors.BzrCommandError(
3827
'Cannot use -r with merge directives or bundles')
3828
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3831
if merger is None and uncommitted:
3832
if revision is not None and len(revision) > 0:
3833
raise errors.BzrCommandError('Cannot use --uncommitted and'
3834
' --revision at the same time.')
3835
merger = self.get_merger_from_uncommitted(tree, location, None)
3836
allow_pending = False
3839
merger, allow_pending = self._get_merger_from_branch(tree,
3840
location, revision, remember, possible_transports, None)
3842
merger.merge_type = merge_type
3843
merger.reprocess = reprocess
3844
merger.show_base = show_base
3845
self.sanity_check_merger(merger)
3846
if (merger.base_rev_id == merger.other_rev_id and
3847
merger.other_rev_id is not None):
3848
note('Nothing to do.')
3851
if merger.interesting_files is not None:
3852
raise errors.BzrCommandError('Cannot pull individual files')
3853
if (merger.base_rev_id == tree.last_revision()):
3854
result = tree.pull(merger.other_branch, False,
3855
merger.other_rev_id)
3856
result.report(self.outf)
3858
if merger.this_basis is None:
3859
raise errors.BzrCommandError(
3860
"This branch has no commits."
3861
" (perhaps you would prefer 'bzr pull')")
3863
return self._do_preview(merger)
3865
return self._do_interactive(merger)
3867
return self._do_merge(merger, change_reporter, allow_pending,
3870
def _get_preview(self, merger):
3871
tree_merger = merger.make_merger()
3872
tt = tree_merger.make_preview_transform()
3873
self.add_cleanup(tt.finalize)
3874
result_tree = tt.get_preview_tree()
3877
def _do_preview(self, merger):
3878
from bzrlib.diff import show_diff_trees
3879
result_tree = self._get_preview(merger)
3880
path_encoding = osutils.get_diff_header_encoding()
3881
show_diff_trees(merger.this_tree, result_tree, self.outf,
3882
old_label='', new_label='',
3883
path_encoding=path_encoding)
3885
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3886
merger.change_reporter = change_reporter
3887
conflict_count = merger.do_merge()
3889
merger.set_pending()
3890
if verified == 'failed':
3891
warning('Preview patch does not match changes')
3892
if conflict_count != 0:
3897
def _do_interactive(self, merger):
3898
"""Perform an interactive merge.
3900
This works by generating a preview tree of the merge, then using
3901
Shelver to selectively remove the differences between the working tree
3902
and the preview tree.
3904
from bzrlib import shelf_ui
3905
result_tree = self._get_preview(merger)
3906
writer = bzrlib.option.diff_writer_registry.get()
3907
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3908
reporter=shelf_ui.ApplyReporter(),
3909
diff_writer=writer(sys.stdout))
3915
def sanity_check_merger(self, merger):
3916
if (merger.show_base and
3917
not merger.merge_type is _mod_merge.Merge3Merger):
3918
raise errors.BzrCommandError("Show-base is not supported for this"
3919
" merge type. %s" % merger.merge_type)
3920
if merger.reprocess is None:
3921
if merger.show_base:
3922
merger.reprocess = False
3924
# Use reprocess if the merger supports it
3925
merger.reprocess = merger.merge_type.supports_reprocess
3926
if merger.reprocess and not merger.merge_type.supports_reprocess:
3927
raise errors.BzrCommandError("Conflict reduction is not supported"
3928
" for merge type %s." %
3930
if merger.reprocess and merger.show_base:
3931
raise errors.BzrCommandError("Cannot do conflict reduction and"
3934
def _get_merger_from_branch(self, tree, location, revision, remember,
3935
possible_transports, pb):
3936
"""Produce a merger from a location, assuming it refers to a branch."""
3937
from bzrlib.tag import _merge_tags_if_possible
3938
# find the branch locations
3939
other_loc, user_location = self._select_branch_location(tree, location,
3941
if revision is not None and len(revision) == 2:
3942
base_loc, _unused = self._select_branch_location(tree,
3943
location, revision, 0)
3945
base_loc = other_loc
3947
other_branch, other_path = Branch.open_containing(other_loc,
3948
possible_transports)
3949
if base_loc == other_loc:
3950
base_branch = other_branch
3952
base_branch, base_path = Branch.open_containing(base_loc,
3953
possible_transports)
3954
# Find the revision ids
3955
other_revision_id = None
3956
base_revision_id = None
3957
if revision is not None:
3958
if len(revision) >= 1:
3959
other_revision_id = revision[-1].as_revision_id(other_branch)
3960
if len(revision) == 2:
3961
base_revision_id = revision[0].as_revision_id(base_branch)
3962
if other_revision_id is None:
3963
other_revision_id = _mod_revision.ensure_null(
3964
other_branch.last_revision())
3965
# Remember where we merge from
3966
if ((remember or tree.branch.get_submit_branch() is None) and
3967
user_location is not None):
3968
tree.branch.set_submit_branch(other_branch.base)
3969
_merge_tags_if_possible(other_branch, tree.branch)
3970
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3971
other_revision_id, base_revision_id, other_branch, base_branch)
3972
if other_path != '':
3973
allow_pending = False
3974
merger.interesting_files = [other_path]
3976
allow_pending = True
3977
return merger, allow_pending
3979
def get_merger_from_uncommitted(self, tree, location, pb):
3980
"""Get a merger for uncommitted changes.
3982
:param tree: The tree the merger should apply to.
3983
:param location: The location containing uncommitted changes.
3984
:param pb: The progress bar to use for showing progress.
3986
location = self._select_branch_location(tree, location)[0]
3987
other_tree, other_path = WorkingTree.open_containing(location)
3988
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3989
if other_path != '':
3990
merger.interesting_files = [other_path]
3993
def _select_branch_location(self, tree, user_location, revision=None,
3995
"""Select a branch location, according to possible inputs.
3997
If provided, branches from ``revision`` are preferred. (Both
3998
``revision`` and ``index`` must be supplied.)
4000
Otherwise, the ``location`` parameter is used. If it is None, then the
4001
``submit`` or ``parent`` location is used, and a note is printed.
4003
:param tree: The working tree to select a branch for merging into
4004
:param location: The location entered by the user
4005
:param revision: The revision parameter to the command
4006
:param index: The index to use for the revision parameter. Negative
4007
indices are permitted.
4008
:return: (selected_location, user_location). The default location
4009
will be the user-entered location.
4011
if (revision is not None and index is not None
4012
and revision[index] is not None):
4013
branch = revision[index].get_branch()
4014
if branch is not None:
4015
return branch, branch
4016
if user_location is None:
4017
location = self._get_remembered(tree, 'Merging from')
4019
location = user_location
4020
return location, user_location
4022
def _get_remembered(self, tree, verb_string):
4023
"""Use tree.branch's parent if none was supplied.
4025
Report if the remembered location was used.
4027
stored_location = tree.branch.get_submit_branch()
4028
stored_location_type = "submit"
4029
if stored_location is None:
4030
stored_location = tree.branch.get_parent()
4031
stored_location_type = "parent"
4032
mutter("%s", stored_location)
4033
if stored_location is None:
4034
raise errors.BzrCommandError("No location specified or remembered")
4035
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4036
note(u"%s remembered %s location %s", verb_string,
4037
stored_location_type, display_url)
4038
return stored_location
4041
class cmd_remerge(Command):
4042
__doc__ = """Redo a merge.
4044
Use this if you want to try a different merge technique while resolving
4045
conflicts. Some merge techniques are better than others, and remerge
4046
lets you try different ones on different files.
4048
The options for remerge have the same meaning and defaults as the ones for
4049
merge. The difference is that remerge can (only) be run when there is a
4050
pending merge, and it lets you specify particular files.
4053
Re-do the merge of all conflicted files, and show the base text in
4054
conflict regions, in addition to the usual THIS and OTHER texts::
4056
bzr remerge --show-base
4058
Re-do the merge of "foobar", using the weave merge algorithm, with
4059
additional processing to reduce the size of conflict regions::
4061
bzr remerge --merge-type weave --reprocess foobar
4063
takes_args = ['file*']
4068
help="Show base revision text in conflicts."),
4071
def run(self, file_list=None, merge_type=None, show_base=False,
4073
from bzrlib.conflicts import restore
4074
if merge_type is None:
4075
merge_type = _mod_merge.Merge3Merger
4076
tree, file_list = WorkingTree.open_containing_paths(file_list)
4077
self.add_cleanup(tree.lock_write().unlock)
4078
parents = tree.get_parent_ids()
4079
if len(parents) != 2:
4080
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4081
" merges. Not cherrypicking or"
4083
repository = tree.branch.repository
4084
interesting_ids = None
4086
conflicts = tree.conflicts()
4087
if file_list is not None:
4088
interesting_ids = set()
4089
for filename in file_list:
4090
file_id = tree.path2id(filename)
4092
raise errors.NotVersionedError(filename)
4093
interesting_ids.add(file_id)
4094
if tree.kind(file_id) != "directory":
4097
for name, ie in tree.inventory.iter_entries(file_id):
4098
interesting_ids.add(ie.file_id)
4099
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4101
# Remerge only supports resolving contents conflicts
4102
allowed_conflicts = ('text conflict', 'contents conflict')
4103
restore_files = [c.path for c in conflicts
4104
if c.typestring in allowed_conflicts]
4105
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4106
tree.set_conflicts(ConflictList(new_conflicts))
4107
if file_list is not None:
4108
restore_files = file_list
4109
for filename in restore_files:
4111
restore(tree.abspath(filename))
4112
except errors.NotConflicted:
4114
# Disable pending merges, because the file texts we are remerging
4115
# have not had those merges performed. If we use the wrong parents
4116
# list, we imply that the working tree text has seen and rejected
4117
# all the changes from the other tree, when in fact those changes
4118
# have not yet been seen.
4119
tree.set_parent_ids(parents[:1])
4121
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4122
merger.interesting_ids = interesting_ids
4123
merger.merge_type = merge_type
4124
merger.show_base = show_base
4125
merger.reprocess = reprocess
4126
conflicts = merger.do_merge()
4128
tree.set_parent_ids(parents)
4135
class cmd_revert(Command):
4136
__doc__ = """Revert files to a previous revision.
4138
Giving a list of files will revert only those files. Otherwise, all files
4139
will be reverted. If the revision is not specified with '--revision', the
4140
last committed revision is used.
4142
To remove only some changes, without reverting to a prior version, use
4143
merge instead. For example, "merge . --revision -2..-3" will remove the
4144
changes introduced by -2, without affecting the changes introduced by -1.
4145
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4147
By default, any files that have been manually changed will be backed up
4148
first. (Files changed only by merge are not backed up.) Backup files have
4149
'.~#~' appended to their name, where # is a number.
4151
When you provide files, you can use their current pathname or the pathname
4152
from the target revision. So you can use revert to "undelete" a file by
4153
name. If you name a directory, all the contents of that directory will be
4156
If you have newly added files since the target revision, they will be
4157
removed. If the files to be removed have been changed, backups will be
4158
created as above. Directories containing unknown files will not be
4161
The working tree contains a list of revisions that have been merged but
4162
not yet committed. These revisions will be included as additional parents
4163
of the next commit. Normally, using revert clears that list as well as
4164
reverting the files. If any files are specified, revert leaves the list
4165
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4166
.`` in the tree root to revert all files but keep the recorded merges,
4167
and ``bzr revert --forget-merges`` to clear the pending merge list without
4168
reverting any files.
4170
Using "bzr revert --forget-merges", it is possible to apply all of the
4171
changes from a branch in a single revision. To do this, perform the merge
4172
as desired. Then doing revert with the "--forget-merges" option will keep
4173
the content of the tree as it was, but it will clear the list of pending
4174
merges. The next commit will then contain all of the changes that are
4175
present in the other branch, but without any other parent revisions.
4176
Because this technique forgets where these changes originated, it may
4177
cause additional conflicts on later merges involving the same source and
4181
_see_also = ['cat', 'export']
4184
Option('no-backup', "Do not save backups of reverted files."),
4185
Option('forget-merges',
4186
'Remove pending merge marker, without changing any files.'),
4188
takes_args = ['file*']
4190
def run(self, revision=None, no_backup=False, file_list=None,
4191
forget_merges=None):
4192
tree, file_list = WorkingTree.open_containing_paths(file_list)
4193
self.add_cleanup(tree.lock_tree_write().unlock)
4195
tree.set_parent_ids(tree.get_parent_ids()[:1])
4197
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4200
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4201
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4202
tree.revert(file_list, rev_tree, not no_backup, None,
4203
report_changes=True)
4206
class cmd_assert_fail(Command):
4207
__doc__ = """Test reporting of assertion failures"""
4208
# intended just for use in testing
4213
raise AssertionError("always fails")
4216
class cmd_help(Command):
4217
__doc__ = """Show help on a command or other topic.
4220
_see_also = ['topics']
4222
Option('long', 'Show help on all commands.'),
4224
takes_args = ['topic?']
4225
aliases = ['?', '--help', '-?', '-h']
4228
def run(self, topic=None, long=False):
4230
if topic is None and long:
4232
bzrlib.help.help(topic)
4235
class cmd_shell_complete(Command):
4236
__doc__ = """Show appropriate completions for context.
4238
For a list of all available commands, say 'bzr shell-complete'.
4240
takes_args = ['context?']
4245
def run(self, context=None):
4246
import shellcomplete
4247
shellcomplete.shellcomplete(context)
4250
class cmd_missing(Command):
4251
__doc__ = """Show unmerged/unpulled revisions between two branches.
4253
OTHER_BRANCH may be local or remote.
4255
To filter on a range of revisions, you can use the command -r begin..end
4256
-r revision requests a specific revision, -r ..end or -r begin.. are
4260
1 - some missing revisions
4261
0 - no missing revisions
4265
Determine the missing revisions between this and the branch at the
4266
remembered pull location::
4270
Determine the missing revisions between this and another branch::
4272
bzr missing http://server/branch
4274
Determine the missing revisions up to a specific revision on the other
4277
bzr missing -r ..-10
4279
Determine the missing revisions up to a specific revision on this
4282
bzr missing --my-revision ..-10
4285
_see_also = ['merge', 'pull']
4286
takes_args = ['other_branch?']
4289
Option('reverse', 'Reverse the order of revisions.'),
4291
'Display changes in the local branch only.'),
4292
Option('this' , 'Same as --mine-only.'),
4293
Option('theirs-only',
4294
'Display changes in the remote branch only.'),
4295
Option('other', 'Same as --theirs-only.'),
4299
custom_help('revision',
4300
help='Filter on other branch revisions (inclusive). '
4301
'See "help revisionspec" for details.'),
4302
Option('my-revision',
4303
type=_parse_revision_str,
4304
help='Filter on local branch revisions (inclusive). '
4305
'See "help revisionspec" for details.'),
4306
Option('include-merges',
4307
'Show all revisions in addition to the mainline ones.'),
4309
encoding_type = 'replace'
4312
def run(self, other_branch=None, reverse=False, mine_only=False,
4314
log_format=None, long=False, short=False, line=False,
4315
show_ids=False, verbose=False, this=False, other=False,
4316
include_merges=False, revision=None, my_revision=None,
4318
from bzrlib.missing import find_unmerged, iter_log_revisions
4327
# TODO: We should probably check that we don't have mine-only and
4328
# theirs-only set, but it gets complicated because we also have
4329
# this and other which could be used.
4336
local_branch = Branch.open_containing(directory)[0]
4337
self.add_cleanup(local_branch.lock_read().unlock)
4339
parent = local_branch.get_parent()
4340
if other_branch is None:
4341
other_branch = parent
4342
if other_branch is None:
4343
raise errors.BzrCommandError("No peer location known"
4345
display_url = urlutils.unescape_for_display(parent,
4347
message("Using saved parent location: "
4348
+ display_url + "\n")
4350
remote_branch = Branch.open(other_branch)
4351
if remote_branch.base == local_branch.base:
4352
remote_branch = local_branch
4354
self.add_cleanup(remote_branch.lock_read().unlock)
4356
local_revid_range = _revision_range_to_revid_range(
4357
_get_revision_range(my_revision, local_branch,
4360
remote_revid_range = _revision_range_to_revid_range(
4361
_get_revision_range(revision,
4362
remote_branch, self.name()))
4364
local_extra, remote_extra = find_unmerged(
4365
local_branch, remote_branch, restrict,
4366
backward=not reverse,
4367
include_merges=include_merges,
4368
local_revid_range=local_revid_range,
4369
remote_revid_range=remote_revid_range)
4371
if log_format is None:
4372
registry = log.log_formatter_registry
4373
log_format = registry.get_default(local_branch)
4374
lf = log_format(to_file=self.outf,
4376
show_timezone='original')
4379
if local_extra and not theirs_only:
4380
message("You have %d extra revision(s):\n" %
4382
for revision in iter_log_revisions(local_extra,
4383
local_branch.repository,
4385
lf.log_revision(revision)
4386
printed_local = True
4389
printed_local = False
4391
if remote_extra and not mine_only:
4392
if printed_local is True:
4394
message("You are missing %d revision(s):\n" %
4396
for revision in iter_log_revisions(remote_extra,
4397
remote_branch.repository,
4399
lf.log_revision(revision)
4402
if mine_only and not local_extra:
4403
# We checked local, and found nothing extra
4404
message('This branch is up to date.\n')
4405
elif theirs_only and not remote_extra:
4406
# We checked remote, and found nothing extra
4407
message('Other branch is up to date.\n')
4408
elif not (mine_only or theirs_only or local_extra or
4410
# We checked both branches, and neither one had extra
4412
message("Branches are up to date.\n")
4414
if not status_code and parent is None and other_branch is not None:
4415
self.add_cleanup(local_branch.lock_write().unlock)
4416
# handle race conditions - a parent might be set while we run.
4417
if local_branch.get_parent() is None:
4418
local_branch.set_parent(remote_branch.base)
4422
class cmd_pack(Command):
4423
__doc__ = """Compress the data within a repository.
4425
This operation compresses the data within a bazaar repository. As
4426
bazaar supports automatic packing of repository, this operation is
4427
normally not required to be done manually.
4429
During the pack operation, bazaar takes a backup of existing repository
4430
data, i.e. pack files. This backup is eventually removed by bazaar
4431
automatically when it is safe to do so. To save disk space by removing
4432
the backed up pack files, the --clean-obsolete-packs option may be
4435
Warning: If you use --clean-obsolete-packs and your machine crashes
4436
during or immediately after repacking, you may be left with a state
4437
where the deletion has been written to disk but the new packs have not
4438
been. In this case the repository may be unusable.
4441
_see_also = ['repositories']
4442
takes_args = ['branch_or_repo?']
4444
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4447
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4448
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4450
branch = dir.open_branch()
4451
repository = branch.repository
4452
except errors.NotBranchError:
4453
repository = dir.open_repository()
4454
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4457
class cmd_plugins(Command):
4458
__doc__ = """List the installed plugins.
4460
This command displays the list of installed plugins including
4461
version of plugin and a short description of each.
4463
--verbose shows the path where each plugin is located.
4465
A plugin is an external component for Bazaar that extends the
4466
revision control system, by adding or replacing code in Bazaar.
4467
Plugins can do a variety of things, including overriding commands,
4468
adding new commands, providing additional network transports and
4469
customizing log output.
4471
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4472
for further information on plugins including where to find them and how to
4473
install them. Instructions are also provided there on how to write new
4474
plugins using the Python programming language.
4476
takes_options = ['verbose']
4479
def run(self, verbose=False):
4480
import bzrlib.plugin
4481
from inspect import getdoc
4483
for name, plugin in bzrlib.plugin.plugins().items():
4484
version = plugin.__version__
4485
if version == 'unknown':
4487
name_ver = '%s %s' % (name, version)
4488
d = getdoc(plugin.module)
4490
doc = d.split('\n')[0]
4492
doc = '(no description)'
4493
result.append((name_ver, doc, plugin.path()))
4494
for name_ver, doc, path in sorted(result):
4495
self.outf.write("%s\n" % name_ver)
4496
self.outf.write(" %s\n" % doc)
4498
self.outf.write(" %s\n" % path)
4499
self.outf.write("\n")
4502
class cmd_testament(Command):
4503
__doc__ = """Show testament (signing-form) of a revision."""
4506
Option('long', help='Produce long-format testament.'),
4508
help='Produce a strict-format testament.')]
4509
takes_args = ['branch?']
4511
def run(self, branch=u'.', revision=None, long=False, strict=False):
4512
from bzrlib.testament import Testament, StrictTestament
4514
testament_class = StrictTestament
4516
testament_class = Testament
4518
b = Branch.open_containing(branch)[0]
4520
b = Branch.open(branch)
4521
self.add_cleanup(b.lock_read().unlock)
4522
if revision is None:
4523
rev_id = b.last_revision()
4525
rev_id = revision[0].as_revision_id(b)
4526
t = testament_class.from_revision(b.repository, rev_id)
4528
sys.stdout.writelines(t.as_text_lines())
4530
sys.stdout.write(t.as_short_text())
4533
class cmd_annotate(Command):
4534
__doc__ = """Show the origin of each line in a file.
4536
This prints out the given file with an annotation on the left side
4537
indicating which revision, author and date introduced the change.
4539
If the origin is the same for a run of consecutive lines, it is
4540
shown only at the top, unless the --all option is given.
4542
# TODO: annotate directories; showing when each file was last changed
4543
# TODO: if the working copy is modified, show annotations on that
4544
# with new uncommitted lines marked
4545
aliases = ['ann', 'blame', 'praise']
4546
takes_args = ['filename']
4547
takes_options = [Option('all', help='Show annotations on all lines.'),
4548
Option('long', help='Show commit date in annotations.'),
4553
encoding_type = 'exact'
4556
def run(self, filename, all=False, long=False, revision=None,
4557
show_ids=False, directory=None):
4558
from bzrlib.annotate import annotate_file, annotate_file_tree
4559
wt, branch, relpath = \
4560
_open_directory_or_containing_tree_or_branch(filename, directory)
4562
self.add_cleanup(wt.lock_read().unlock)
4564
self.add_cleanup(branch.lock_read().unlock)
4565
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4566
self.add_cleanup(tree.lock_read().unlock)
4568
file_id = wt.path2id(relpath)
4570
file_id = tree.path2id(relpath)
4572
raise errors.NotVersionedError(filename)
4573
file_version = tree.inventory[file_id].revision
4574
if wt is not None and revision is None:
4575
# If there is a tree and we're not annotating historical
4576
# versions, annotate the working tree's content.
4577
annotate_file_tree(wt, file_id, self.outf, long, all,
4580
annotate_file(branch, file_version, file_id, long, all, self.outf,
4584
class cmd_re_sign(Command):
4585
__doc__ = """Create a digital signature for an existing revision."""
4586
# TODO be able to replace existing ones.
4588
hidden = True # is this right ?
4589
takes_args = ['revision_id*']
4590
takes_options = ['directory', 'revision']
4592
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4593
if revision_id_list is not None and revision is not None:
4594
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4595
if revision_id_list is None and revision is None:
4596
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4597
b = WorkingTree.open_containing(directory)[0].branch
4598
self.add_cleanup(b.lock_write().unlock)
4599
return self._run(b, revision_id_list, revision)
4601
def _run(self, b, revision_id_list, revision):
4602
import bzrlib.gpg as gpg
4603
gpg_strategy = gpg.GPGStrategy(b.get_config())
4604
if revision_id_list is not None:
4605
b.repository.start_write_group()
4607
for revision_id in revision_id_list:
4608
b.repository.sign_revision(revision_id, gpg_strategy)
4610
b.repository.abort_write_group()
4613
b.repository.commit_write_group()
4614
elif revision is not None:
4615
if len(revision) == 1:
4616
revno, rev_id = revision[0].in_history(b)
4617
b.repository.start_write_group()
4619
b.repository.sign_revision(rev_id, gpg_strategy)
4621
b.repository.abort_write_group()
4624
b.repository.commit_write_group()
4625
elif len(revision) == 2:
4626
# are they both on rh- if so we can walk between them
4627
# might be nice to have a range helper for arbitrary
4628
# revision paths. hmm.
4629
from_revno, from_revid = revision[0].in_history(b)
4630
to_revno, to_revid = revision[1].in_history(b)
4631
if to_revid is None:
4632
to_revno = b.revno()
4633
if from_revno is None or to_revno is None:
4634
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4635
b.repository.start_write_group()
4637
for revno in range(from_revno, to_revno + 1):
4638
b.repository.sign_revision(b.get_rev_id(revno),
4641
b.repository.abort_write_group()
4644
b.repository.commit_write_group()
4646
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4649
class cmd_bind(Command):
4650
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4651
If no branch is supplied, rebind to the last bound location.
4653
Once converted into a checkout, commits must succeed on the master branch
4654
before they will be applied to the local branch.
4656
Bound branches use the nickname of its master branch unless it is set
4657
locally, in which case binding will update the local nickname to be
4661
_see_also = ['checkouts', 'unbind']
4662
takes_args = ['location?']
4663
takes_options = ['directory']
4665
def run(self, location=None, directory=u'.'):
4666
b, relpath = Branch.open_containing(directory)
4667
if location is None:
4669
location = b.get_old_bound_location()
4670
except errors.UpgradeRequired:
4671
raise errors.BzrCommandError('No location supplied. '
4672
'This format does not remember old locations.')
4674
if location is None:
4675
if b.get_bound_location() is not None:
4676
raise errors.BzrCommandError('Branch is already bound')
4678
raise errors.BzrCommandError('No location supplied '
4679
'and no previous location known')
4680
b_other = Branch.open(location)
4683
except errors.DivergedBranches:
4684
raise errors.BzrCommandError('These branches have diverged.'
4685
' Try merging, and then bind again.')
4686
if b.get_config().has_explicit_nickname():
4687
b.nick = b_other.nick
4690
class cmd_unbind(Command):
4691
__doc__ = """Convert the current checkout into a regular branch.
4693
After unbinding, the local branch is considered independent and subsequent
4694
commits will be local only.
4697
_see_also = ['checkouts', 'bind']
4699
takes_options = ['directory']
4701
def run(self, directory=u'.'):
4702
b, relpath = Branch.open_containing(directory)
4704
raise errors.BzrCommandError('Local branch is not bound')
4707
class cmd_uncommit(Command):
4708
__doc__ = """Remove the last committed revision.
4710
--verbose will print out what is being removed.
4711
--dry-run will go through all the motions, but not actually
4714
If --revision is specified, uncommit revisions to leave the branch at the
4715
specified revision. For example, "bzr uncommit -r 15" will leave the
4716
branch at revision 15.
4718
Uncommit leaves the working tree ready for a new commit. The only change
4719
it may make is to restore any pending merges that were present before
4723
# TODO: jam 20060108 Add an option to allow uncommit to remove
4724
# unreferenced information in 'branch-as-repository' branches.
4725
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4726
# information in shared branches as well.
4727
_see_also = ['commit']
4728
takes_options = ['verbose', 'revision',
4729
Option('dry-run', help='Don\'t actually make changes.'),
4730
Option('force', help='Say yes to all questions.'),
4732
help="Only remove the commits from the local branch"
4733
" when in a checkout."
4736
takes_args = ['location?']
4738
encoding_type = 'replace'
4740
def run(self, location=None,
4741
dry_run=False, verbose=False,
4742
revision=None, force=False, local=False):
4743
if location is None:
4745
control, relpath = bzrdir.BzrDir.open_containing(location)
4747
tree = control.open_workingtree()
4749
except (errors.NoWorkingTree, errors.NotLocalUrl):
4751
b = control.open_branch()
4753
if tree is not None:
4754
self.add_cleanup(tree.lock_write().unlock)
4756
self.add_cleanup(b.lock_write().unlock)
4757
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4759
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4760
from bzrlib.log import log_formatter, show_log
4761
from bzrlib.uncommit import uncommit
4763
last_revno, last_rev_id = b.last_revision_info()
4766
if revision is None:
4768
rev_id = last_rev_id
4770
# 'bzr uncommit -r 10' actually means uncommit
4771
# so that the final tree is at revno 10.
4772
# but bzrlib.uncommit.uncommit() actually uncommits
4773
# the revisions that are supplied.
4774
# So we need to offset it by one
4775
revno = revision[0].in_history(b).revno + 1
4776
if revno <= last_revno:
4777
rev_id = b.get_rev_id(revno)
4779
if rev_id is None or _mod_revision.is_null(rev_id):
4780
self.outf.write('No revisions to uncommit.\n')
4783
lf = log_formatter('short',
4785
show_timezone='original')
4790
direction='forward',
4791
start_revision=revno,
4792
end_revision=last_revno)
4795
self.outf.write('Dry-run, pretending to remove'
4796
' the above revisions.\n')
4798
self.outf.write('The above revision(s) will be removed.\n')
4801
if not ui.ui_factory.get_boolean('Are you sure'):
4802
self.outf.write('Canceled')
4805
mutter('Uncommitting from {%s} to {%s}',
4806
last_rev_id, rev_id)
4807
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4808
revno=revno, local=local)
4809
self.outf.write('You can restore the old tip by running:\n'
4810
' bzr pull . -r revid:%s\n' % last_rev_id)
4813
class cmd_break_lock(Command):
4814
__doc__ = """Break a dead lock.
4816
This command breaks a lock on a repository, branch, working directory or
4819
CAUTION: Locks should only be broken when you are sure that the process
4820
holding the lock has been stopped.
4822
You can get information on what locks are open via the 'bzr info
4823
[location]' command.
4827
bzr break-lock bzr+ssh://example.com/bzr/foo
4828
bzr break-lock --conf ~/.bazaar
4831
takes_args = ['location?']
4834
help='LOCATION is the directory where the config lock is.'),
4837
def run(self, location=None, config=False):
4838
if location is None:
4841
conf = _mod_config.LockableConfig(file_name=location)
4844
control, relpath = bzrdir.BzrDir.open_containing(location)
4846
control.break_lock()
4847
except NotImplementedError:
4851
class cmd_wait_until_signalled(Command):
4852
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4854
This just prints a line to signal when it is ready, then blocks on stdin.
4860
sys.stdout.write("running\n")
4862
sys.stdin.readline()
4865
class cmd_serve(Command):
4866
__doc__ = """Run the bzr server."""
4868
aliases = ['server']
4872
help='Serve on stdin/out for use from inetd or sshd.'),
4873
RegistryOption('protocol',
4874
help="Protocol to serve.",
4875
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4876
value_switches=True),
4878
help='Listen for connections on nominated port of the form '
4879
'[hostname:]portnumber. Passing 0 as the port number will '
4880
'result in a dynamically allocated port. The default port '
4881
'depends on the protocol.',
4883
custom_help('directory',
4884
help='Serve contents of this directory.'),
4885
Option('allow-writes',
4886
help='By default the server is a readonly server. Supplying '
4887
'--allow-writes enables write access to the contents of '
4888
'the served directory and below. Note that ``bzr serve`` '
4889
'does not perform authentication, so unless some form of '
4890
'external authentication is arranged supplying this '
4891
'option leads to global uncontrolled write access to your '
4896
def get_host_and_port(self, port):
4897
"""Return the host and port to run the smart server on.
4899
If 'port' is None, None will be returned for the host and port.
4901
If 'port' has a colon in it, the string before the colon will be
4902
interpreted as the host.
4904
:param port: A string of the port to run the server on.
4905
:return: A tuple of (host, port), where 'host' is a host name or IP,
4906
and port is an integer TCP/IP port.
4909
if port is not None:
4911
host, port = port.split(':')
4915
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4917
from bzrlib import transport
4918
if directory is None:
4919
directory = os.getcwd()
4920
if protocol is None:
4921
protocol = transport.transport_server_registry.get()
4922
host, port = self.get_host_and_port(port)
4923
url = urlutils.local_path_to_url(directory)
4924
if not allow_writes:
4925
url = 'readonly+' + url
4926
t = transport.get_transport(url)
4927
protocol(t, host, port, inet)
4930
class cmd_join(Command):
4931
__doc__ = """Combine a tree into its containing tree.
4933
This command requires the target tree to be in a rich-root format.
4935
The TREE argument should be an independent tree, inside another tree, but
4936
not part of it. (Such trees can be produced by "bzr split", but also by
4937
running "bzr branch" with the target inside a tree.)
4939
The result is a combined tree, with the subtree no longer an independant
4940
part. This is marked as a merge of the subtree into the containing tree,
4941
and all history is preserved.
4944
_see_also = ['split']
4945
takes_args = ['tree']
4947
Option('reference', help='Join by reference.', hidden=True),
4950
def run(self, tree, reference=False):
4951
sub_tree = WorkingTree.open(tree)
4952
parent_dir = osutils.dirname(sub_tree.basedir)
4953
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4954
repo = containing_tree.branch.repository
4955
if not repo.supports_rich_root():
4956
raise errors.BzrCommandError(
4957
"Can't join trees because %s doesn't support rich root data.\n"
4958
"You can use bzr upgrade on the repository."
4962
containing_tree.add_reference(sub_tree)
4963
except errors.BadReferenceTarget, e:
4964
# XXX: Would be better to just raise a nicely printable
4965
# exception from the real origin. Also below. mbp 20070306
4966
raise errors.BzrCommandError("Cannot join %s. %s" %
4970
containing_tree.subsume(sub_tree)
4971
except errors.BadSubsumeSource, e:
4972
raise errors.BzrCommandError("Cannot join %s. %s" %
4976
class cmd_split(Command):
4977
__doc__ = """Split a subdirectory of a tree into a separate tree.
4979
This command will produce a target tree in a format that supports
4980
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4981
converted into earlier formats like 'dirstate-tags'.
4983
The TREE argument should be a subdirectory of a working tree. That
4984
subdirectory will be converted into an independent tree, with its own
4985
branch. Commits in the top-level tree will not apply to the new subtree.
4988
_see_also = ['join']
4989
takes_args = ['tree']
4991
def run(self, tree):
4992
containing_tree, subdir = WorkingTree.open_containing(tree)
4993
sub_id = containing_tree.path2id(subdir)
4995
raise errors.NotVersionedError(subdir)
4997
containing_tree.extract(sub_id)
4998
except errors.RootNotRich:
4999
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5002
class cmd_merge_directive(Command):
5003
__doc__ = """Generate a merge directive for auto-merge tools.
5005
A directive requests a merge to be performed, and also provides all the
5006
information necessary to do so. This means it must either include a
5007
revision bundle, or the location of a branch containing the desired
5010
A submit branch (the location to merge into) must be supplied the first
5011
time the command is issued. After it has been supplied once, it will
5012
be remembered as the default.
5014
A public branch is optional if a revision bundle is supplied, but required
5015
if --diff or --plain is specified. It will be remembered as the default
5016
after the first use.
5019
takes_args = ['submit_branch?', 'public_branch?']
5023
_see_also = ['send']
5027
RegistryOption.from_kwargs('patch-type',
5028
'The type of patch to include in the directive.',
5030
value_switches=True,
5032
bundle='Bazaar revision bundle (default).',
5033
diff='Normal unified diff.',
5034
plain='No patch, just directive.'),
5035
Option('sign', help='GPG-sign the directive.'), 'revision',
5036
Option('mail-to', type=str,
5037
help='Instead of printing the directive, email to this address.'),
5038
Option('message', type=str, short_name='m',
5039
help='Message to use when committing this merge.')
5042
encoding_type = 'exact'
5044
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5045
sign=False, revision=None, mail_to=None, message=None,
5047
from bzrlib.revision import ensure_null, NULL_REVISION
5048
include_patch, include_bundle = {
5049
'plain': (False, False),
5050
'diff': (True, False),
5051
'bundle': (True, True),
5053
branch = Branch.open(directory)
5054
stored_submit_branch = branch.get_submit_branch()
5055
if submit_branch is None:
5056
submit_branch = stored_submit_branch
5058
if stored_submit_branch is None:
5059
branch.set_submit_branch(submit_branch)
5060
if submit_branch is None:
5061
submit_branch = branch.get_parent()
5062
if submit_branch is None:
5063
raise errors.BzrCommandError('No submit branch specified or known')
5065
stored_public_branch = branch.get_public_branch()
5066
if public_branch is None:
5067
public_branch = stored_public_branch
5068
elif stored_public_branch is None:
5069
branch.set_public_branch(public_branch)
5070
if not include_bundle and public_branch is None:
5071
raise errors.BzrCommandError('No public branch specified or'
5073
base_revision_id = None
5074
if revision is not None:
5075
if len(revision) > 2:
5076
raise errors.BzrCommandError('bzr merge-directive takes '
5077
'at most two one revision identifiers')
5078
revision_id = revision[-1].as_revision_id(branch)
5079
if len(revision) == 2:
5080
base_revision_id = revision[0].as_revision_id(branch)
5082
revision_id = branch.last_revision()
5083
revision_id = ensure_null(revision_id)
5084
if revision_id == NULL_REVISION:
5085
raise errors.BzrCommandError('No revisions to bundle.')
5086
directive = merge_directive.MergeDirective2.from_objects(
5087
branch.repository, revision_id, time.time(),
5088
osutils.local_time_offset(), submit_branch,
5089
public_branch=public_branch, include_patch=include_patch,
5090
include_bundle=include_bundle, message=message,
5091
base_revision_id=base_revision_id)
5094
self.outf.write(directive.to_signed(branch))
5096
self.outf.writelines(directive.to_lines())
5098
message = directive.to_email(mail_to, branch, sign)
5099
s = SMTPConnection(branch.get_config())
5100
s.send_email(message)
5103
class cmd_send(Command):
5104
__doc__ = """Mail or create a merge-directive for submitting changes.
5106
A merge directive provides many things needed for requesting merges:
5108
* A machine-readable description of the merge to perform
5110
* An optional patch that is a preview of the changes requested
5112
* An optional bundle of revision data, so that the changes can be applied
5113
directly from the merge directive, without retrieving data from a
5116
`bzr send` creates a compact data set that, when applied using bzr
5117
merge, has the same effect as merging from the source branch.
5119
By default the merge directive is self-contained and can be applied to any
5120
branch containing submit_branch in its ancestory without needing access to
5123
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5124
revisions, but only a structured request to merge from the
5125
public_location. In that case the public_branch is needed and it must be
5126
up-to-date and accessible to the recipient. The public_branch is always
5127
included if known, so that people can check it later.
5129
The submit branch defaults to the parent of the source branch, but can be
5130
overridden. Both submit branch and public branch will be remembered in
5131
branch.conf the first time they are used for a particular branch. The
5132
source branch defaults to that containing the working directory, but can
5133
be changed using --from.
5135
In order to calculate those changes, bzr must analyse the submit branch.
5136
Therefore it is most efficient for the submit branch to be a local mirror.
5137
If a public location is known for the submit_branch, that location is used
5138
in the merge directive.
5140
The default behaviour is to send the merge directive by mail, unless -o is
5141
given, in which case it is sent to a file.
5143
Mail is sent using your preferred mail program. This should be transparent
5144
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5145
If the preferred client can't be found (or used), your editor will be used.
5147
To use a specific mail program, set the mail_client configuration option.
5148
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5149
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5150
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5151
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5154
If mail is being sent, a to address is required. This can be supplied
5155
either on the commandline, by setting the submit_to configuration
5156
option in the branch itself or the child_submit_to configuration option
5157
in the submit branch.
5159
Two formats are currently supported: "4" uses revision bundle format 4 and
5160
merge directive format 2. It is significantly faster and smaller than
5161
older formats. It is compatible with Bazaar 0.19 and later. It is the
5162
default. "0.9" uses revision bundle format 0.9 and merge directive
5163
format 1. It is compatible with Bazaar 0.12 - 0.18.
5165
The merge directives created by bzr send may be applied using bzr merge or
5166
bzr pull by specifying a file containing a merge directive as the location.
5168
bzr send makes extensive use of public locations to map local locations into
5169
URLs that can be used by other people. See `bzr help configuration` to
5170
set them, and use `bzr info` to display them.
5173
encoding_type = 'exact'
5175
_see_also = ['merge', 'pull']
5177
takes_args = ['submit_branch?', 'public_branch?']
5181
help='Do not include a bundle in the merge directive.'),
5182
Option('no-patch', help='Do not include a preview patch in the merge'
5185
help='Remember submit and public branch.'),
5187
help='Branch to generate the submission from, '
5188
'rather than the one containing the working directory.',
5191
Option('output', short_name='o',
5192
help='Write merge directive to this file or directory; '
5193
'use - for stdout.',
5196
help='Refuse to send if there are uncommitted changes in'
5197
' the working tree, --no-strict disables the check.'),
5198
Option('mail-to', help='Mail the request to this address.',
5202
Option('body', help='Body for the email.', type=unicode),
5203
RegistryOption('format',
5204
help='Use the specified output format.',
5205
lazy_registry=('bzrlib.send', 'format_registry')),
5208
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5209
no_patch=False, revision=None, remember=False, output=None,
5210
format=None, mail_to=None, message=None, body=None,
5211
strict=None, **kwargs):
5212
from bzrlib.send import send
5213
return send(submit_branch, revision, public_branch, remember,
5214
format, no_bundle, no_patch, output,
5215
kwargs.get('from', '.'), mail_to, message, body,
5220
class cmd_bundle_revisions(cmd_send):
5221
__doc__ = """Create a merge-directive for submitting changes.
5223
A merge directive provides many things needed for requesting merges:
5225
* A machine-readable description of the merge to perform
5227
* An optional patch that is a preview of the changes requested
5229
* An optional bundle of revision data, so that the changes can be applied
5230
directly from the merge directive, without retrieving data from a
5233
If --no-bundle is specified, then public_branch is needed (and must be
5234
up-to-date), so that the receiver can perform the merge using the
5235
public_branch. The public_branch is always included if known, so that
5236
people can check it later.
5238
The submit branch defaults to the parent, but can be overridden. Both
5239
submit branch and public branch will be remembered if supplied.
5241
If a public_branch is known for the submit_branch, that public submit
5242
branch is used in the merge instructions. This means that a local mirror
5243
can be used as your actual submit branch, once you have set public_branch
5246
Two formats are currently supported: "4" uses revision bundle format 4 and
5247
merge directive format 2. It is significantly faster and smaller than
5248
older formats. It is compatible with Bazaar 0.19 and later. It is the
5249
default. "0.9" uses revision bundle format 0.9 and merge directive
5250
format 1. It is compatible with Bazaar 0.12 - 0.18.
5255
help='Do not include a bundle in the merge directive.'),
5256
Option('no-patch', help='Do not include a preview patch in the merge'
5259
help='Remember submit and public branch.'),
5261
help='Branch to generate the submission from, '
5262
'rather than the one containing the working directory.',
5265
Option('output', short_name='o', help='Write directive to this file.',
5268
help='Refuse to bundle revisions if there are uncommitted'
5269
' changes in the working tree, --no-strict disables the check.'),
5271
RegistryOption('format',
5272
help='Use the specified output format.',
5273
lazy_registry=('bzrlib.send', 'format_registry')),
5275
aliases = ['bundle']
5277
_see_also = ['send', 'merge']
5281
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5282
no_patch=False, revision=None, remember=False, output=None,
5283
format=None, strict=None, **kwargs):
5286
from bzrlib.send import send
5287
return send(submit_branch, revision, public_branch, remember,
5288
format, no_bundle, no_patch, output,
5289
kwargs.get('from', '.'), None, None, None,
5290
self.outf, strict=strict)
5293
class cmd_tag(Command):
5294
__doc__ = """Create, remove or modify a tag naming a revision.
5296
Tags give human-meaningful names to revisions. Commands that take a -r
5297
(--revision) option can be given -rtag:X, where X is any previously
5300
Tags are stored in the branch. Tags are copied from one branch to another
5301
along when you branch, push, pull or merge.
5303
It is an error to give a tag name that already exists unless you pass
5304
--force, in which case the tag is moved to point to the new revision.
5306
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5307
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5309
If no tag name is specified it will be determined through the
5310
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5311
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5315
_see_also = ['commit', 'tags']
5316
takes_args = ['tag_name?']
5319
help='Delete this tag rather than placing it.',
5321
custom_help('directory',
5322
help='Branch in which to place the tag.'),
5324
help='Replace existing tags.',
5329
def run(self, tag_name=None,
5335
branch, relpath = Branch.open_containing(directory)
5336
self.add_cleanup(branch.lock_write().unlock)
5338
if tag_name is None:
5339
raise errors.BzrCommandError("No tag specified to delete.")
5340
branch.tags.delete_tag(tag_name)
5341
self.outf.write('Deleted tag %s.\n' % tag_name)
5344
if len(revision) != 1:
5345
raise errors.BzrCommandError(
5346
"Tags can only be placed on a single revision, "
5348
revision_id = revision[0].as_revision_id(branch)
5350
revision_id = branch.last_revision()
5351
if tag_name is None:
5352
tag_name = branch.automatic_tag_name(revision_id)
5353
if tag_name is None:
5354
raise errors.BzrCommandError(
5355
"Please specify a tag name.")
5356
if (not force) and branch.tags.has_tag(tag_name):
5357
raise errors.TagAlreadyExists(tag_name)
5358
branch.tags.set_tag(tag_name, revision_id)
5359
self.outf.write('Created tag %s.\n' % tag_name)
5362
class cmd_tags(Command):
5363
__doc__ = """List tags.
5365
This command shows a table of tag names and the revisions they reference.
5370
custom_help('directory',
5371
help='Branch whose tags should be displayed.'),
5372
RegistryOption.from_kwargs('sort',
5373
'Sort tags by different criteria.', title='Sorting',
5374
alpha='Sort tags lexicographically (default).',
5375
time='Sort tags chronologically.',
5388
branch, relpath = Branch.open_containing(directory)
5390
tags = branch.tags.get_tag_dict().items()
5394
self.add_cleanup(branch.lock_read().unlock)
5396
graph = branch.repository.get_graph()
5397
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5398
revid1, revid2 = rev1.rev_id, rev2.rev_id
5399
# only show revisions between revid1 and revid2 (inclusive)
5400
tags = [(tag, revid) for tag, revid in tags if
5401
graph.is_between(revid, revid1, revid2)]
5404
elif sort == 'time':
5406
for tag, revid in tags:
5408
revobj = branch.repository.get_revision(revid)
5409
except errors.NoSuchRevision:
5410
timestamp = sys.maxint # place them at the end
5412
timestamp = revobj.timestamp
5413
timestamps[revid] = timestamp
5414
tags.sort(key=lambda x: timestamps[x[1]])
5416
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5417
for index, (tag, revid) in enumerate(tags):
5419
revno = branch.revision_id_to_dotted_revno(revid)
5420
if isinstance(revno, tuple):
5421
revno = '.'.join(map(str, revno))
5422
except errors.NoSuchRevision:
5423
# Bad tag data/merges can lead to tagged revisions
5424
# which are not in this branch. Fail gracefully ...
5426
tags[index] = (tag, revno)
5428
for tag, revspec in tags:
5429
self.outf.write('%-20s %s\n' % (tag, revspec))
5432
class cmd_reconfigure(Command):
5433
__doc__ = """Reconfigure the type of a bzr directory.
5435
A target configuration must be specified.
5437
For checkouts, the bind-to location will be auto-detected if not specified.
5438
The order of preference is
5439
1. For a lightweight checkout, the current bound location.
5440
2. For branches that used to be checkouts, the previously-bound location.
5441
3. The push location.
5442
4. The parent location.
5443
If none of these is available, --bind-to must be specified.
5446
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5447
takes_args = ['location?']
5449
RegistryOption.from_kwargs(
5451
title='Target type',
5452
help='The type to reconfigure the directory to.',
5453
value_switches=True, enum_switch=False,
5454
branch='Reconfigure to be an unbound branch with no working tree.',
5455
tree='Reconfigure to be an unbound branch with a working tree.',
5456
checkout='Reconfigure to be a bound branch with a working tree.',
5457
lightweight_checkout='Reconfigure to be a lightweight'
5458
' checkout (with no local history).',
5459
standalone='Reconfigure to be a standalone branch '
5460
'(i.e. stop using shared repository).',
5461
use_shared='Reconfigure to use a shared repository.',
5462
with_trees='Reconfigure repository to create '
5463
'working trees on branches by default.',
5464
with_no_trees='Reconfigure repository to not create '
5465
'working trees on branches by default.'
5467
Option('bind-to', help='Branch to bind checkout to.', type=str),
5469
help='Perform reconfiguration even if local changes'
5471
Option('stacked-on',
5472
help='Reconfigure a branch to be stacked on another branch.',
5476
help='Reconfigure a branch to be unstacked. This '
5477
'may require copying substantial data into it.',
5481
def run(self, location=None, target_type=None, bind_to=None, force=False,
5484
directory = bzrdir.BzrDir.open(location)
5485
if stacked_on and unstacked:
5486
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5487
elif stacked_on is not None:
5488
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5490
reconfigure.ReconfigureUnstacked().apply(directory)
5491
# At the moment you can use --stacked-on and a different
5492
# reconfiguration shape at the same time; there seems no good reason
5494
if target_type is None:
5495
if stacked_on or unstacked:
5498
raise errors.BzrCommandError('No target configuration '
5500
elif target_type == 'branch':
5501
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5502
elif target_type == 'tree':
5503
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5504
elif target_type == 'checkout':
5505
reconfiguration = reconfigure.Reconfigure.to_checkout(
5507
elif target_type == 'lightweight-checkout':
5508
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5510
elif target_type == 'use-shared':
5511
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5512
elif target_type == 'standalone':
5513
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5514
elif target_type == 'with-trees':
5515
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5517
elif target_type == 'with-no-trees':
5518
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5520
reconfiguration.apply(force)
5523
class cmd_switch(Command):
5524
__doc__ = """Set the branch of a checkout and update.
5526
For lightweight checkouts, this changes the branch being referenced.
5527
For heavyweight checkouts, this checks that there are no local commits
5528
versus the current bound branch, then it makes the local branch a mirror
5529
of the new location and binds to it.
5531
In both cases, the working tree is updated and uncommitted changes
5532
are merged. The user can commit or revert these as they desire.
5534
Pending merges need to be committed or reverted before using switch.
5536
The path to the branch to switch to can be specified relative to the parent
5537
directory of the current branch. For example, if you are currently in a
5538
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5541
Bound branches use the nickname of its master branch unless it is set
5542
locally, in which case switching will update the local nickname to be
5546
takes_args = ['to_location?']
5547
takes_options = ['directory',
5549
help='Switch even if local commits will be lost.'),
5551
Option('create-branch', short_name='b',
5552
help='Create the target branch from this one before'
5553
' switching to it.'),
5556
def run(self, to_location=None, force=False, create_branch=False,
5557
revision=None, directory=u'.'):
5558
from bzrlib import switch
5559
tree_location = directory
5560
revision = _get_one_revision('switch', revision)
5561
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5562
if to_location is None:
5563
if revision is None:
5564
raise errors.BzrCommandError('You must supply either a'
5565
' revision or a location')
5566
to_location = tree_location
5568
branch = control_dir.open_branch()
5569
had_explicit_nick = branch.get_config().has_explicit_nickname()
5570
except errors.NotBranchError:
5572
had_explicit_nick = False
5575
raise errors.BzrCommandError('cannot create branch without'
5577
to_location = directory_service.directories.dereference(
5579
if '/' not in to_location and '\\' not in to_location:
5580
# This path is meant to be relative to the existing branch
5581
this_url = self._get_branch_location(control_dir)
5582
to_location = urlutils.join(this_url, '..', to_location)
5583
to_branch = branch.bzrdir.sprout(to_location,
5584
possible_transports=[branch.bzrdir.root_transport],
5585
source_branch=branch).open_branch()
5588
to_branch = Branch.open(to_location)
5589
except errors.NotBranchError:
5590
this_url = self._get_branch_location(control_dir)
5591
to_branch = Branch.open(
5592
urlutils.join(this_url, '..', to_location))
5593
if revision is not None:
5594
revision = revision.as_revision_id(to_branch)
5595
switch.switch(control_dir, to_branch, force, revision_id=revision)
5596
if had_explicit_nick:
5597
branch = control_dir.open_branch() #get the new branch!
5598
branch.nick = to_branch.nick
5599
note('Switched to branch: %s',
5600
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5602
def _get_branch_location(self, control_dir):
5603
"""Return location of branch for this control dir."""
5605
this_branch = control_dir.open_branch()
5606
# This may be a heavy checkout, where we want the master branch
5607
master_location = this_branch.get_bound_location()
5608
if master_location is not None:
5609
return master_location
5610
# If not, use a local sibling
5611
return this_branch.base
5612
except errors.NotBranchError:
5613
format = control_dir.find_branch_format()
5614
if getattr(format, 'get_reference', None) is not None:
5615
return format.get_reference(control_dir)
5617
return control_dir.root_transport.base
5620
class cmd_view(Command):
5621
__doc__ = """Manage filtered views.
5623
Views provide a mask over the tree so that users can focus on
5624
a subset of a tree when doing their work. After creating a view,
5625
commands that support a list of files - status, diff, commit, etc -
5626
effectively have that list of files implicitly given each time.
5627
An explicit list of files can still be given but those files
5628
must be within the current view.
5630
In most cases, a view has a short life-span: it is created to make
5631
a selected change and is deleted once that change is committed.
5632
At other times, you may wish to create one or more named views
5633
and switch between them.
5635
To disable the current view without deleting it, you can switch to
5636
the pseudo view called ``off``. This can be useful when you need
5637
to see the whole tree for an operation or two (e.g. merge) but
5638
want to switch back to your view after that.
5641
To define the current view::
5643
bzr view file1 dir1 ...
5645
To list the current view::
5649
To delete the current view::
5653
To disable the current view without deleting it::
5655
bzr view --switch off
5657
To define a named view and switch to it::
5659
bzr view --name view-name file1 dir1 ...
5661
To list a named view::
5663
bzr view --name view-name
5665
To delete a named view::
5667
bzr view --name view-name --delete
5669
To switch to a named view::
5671
bzr view --switch view-name
5673
To list all views defined::
5677
To delete all views::
5679
bzr view --delete --all
5683
takes_args = ['file*']
5686
help='Apply list or delete action to all views.',
5689
help='Delete the view.',
5692
help='Name of the view to define, list or delete.',
5696
help='Name of the view to switch to.',
5701
def run(self, file_list,
5707
tree, file_list = WorkingTree.open_containing_paths(file_list,
5709
current_view, view_dict = tree.views.get_view_info()
5714
raise errors.BzrCommandError(
5715
"Both --delete and a file list specified")
5717
raise errors.BzrCommandError(
5718
"Both --delete and --switch specified")
5720
tree.views.set_view_info(None, {})
5721
self.outf.write("Deleted all views.\n")
5723
raise errors.BzrCommandError("No current view to delete")
5725
tree.views.delete_view(name)
5726
self.outf.write("Deleted '%s' view.\n" % name)
5729
raise errors.BzrCommandError(
5730
"Both --switch and a file list specified")
5732
raise errors.BzrCommandError(
5733
"Both --switch and --all specified")
5734
elif switch == 'off':
5735
if current_view is None:
5736
raise errors.BzrCommandError("No current view to disable")
5737
tree.views.set_view_info(None, view_dict)
5738
self.outf.write("Disabled '%s' view.\n" % (current_view))
5740
tree.views.set_view_info(switch, view_dict)
5741
view_str = views.view_display_str(tree.views.lookup_view())
5742
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5745
self.outf.write('Views defined:\n')
5746
for view in sorted(view_dict):
5747
if view == current_view:
5751
view_str = views.view_display_str(view_dict[view])
5752
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5754
self.outf.write('No views defined.\n')
5757
# No name given and no current view set
5760
raise errors.BzrCommandError(
5761
"Cannot change the 'off' pseudo view")
5762
tree.views.set_view(name, sorted(file_list))
5763
view_str = views.view_display_str(tree.views.lookup_view())
5764
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5768
# No name given and no current view set
5769
self.outf.write('No current view.\n')
5771
view_str = views.view_display_str(tree.views.lookup_view(name))
5772
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5775
class cmd_hooks(Command):
5776
__doc__ = """Show hooks."""
5781
for hook_key in sorted(hooks.known_hooks.keys()):
5782
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5783
self.outf.write("%s:\n" % type(some_hooks).__name__)
5784
for hook_name, hook_point in sorted(some_hooks.items()):
5785
self.outf.write(" %s:\n" % (hook_name,))
5786
found_hooks = list(hook_point)
5788
for hook in found_hooks:
5789
self.outf.write(" %s\n" %
5790
(some_hooks.get_hook_name(hook),))
5792
self.outf.write(" <no hooks installed>\n")
5795
class cmd_remove_branch(Command):
5796
__doc__ = """Remove a branch.
5798
This will remove the branch from the specified location but
5799
will keep any working tree or repository in place.
5803
Remove the branch at repo/trunk::
5805
bzr remove-branch repo/trunk
5809
takes_args = ["location?"]
5811
aliases = ["rmbranch"]
5813
def run(self, location=None):
5814
if location is None:
5816
branch = Branch.open_containing(location)[0]
5817
branch.bzrdir.destroy_branch()
5820
class cmd_shelve(Command):
5821
__doc__ = """Temporarily set aside some changes from the current tree.
5823
Shelve allows you to temporarily put changes you've made "on the shelf",
5824
ie. out of the way, until a later time when you can bring them back from
5825
the shelf with the 'unshelve' command. The changes are stored alongside
5826
your working tree, and so they aren't propagated along with your branch nor
5827
will they survive its deletion.
5829
If shelve --list is specified, previously-shelved changes are listed.
5831
Shelve is intended to help separate several sets of changes that have
5832
been inappropriately mingled. If you just want to get rid of all changes
5833
and you don't need to restore them later, use revert. If you want to
5834
shelve all text changes at once, use shelve --all.
5836
If filenames are specified, only the changes to those files will be
5837
shelved. Other files will be left untouched.
5839
If a revision is specified, changes since that revision will be shelved.
5841
You can put multiple items on the shelf, and by default, 'unshelve' will
5842
restore the most recently shelved changes.
5845
takes_args = ['file*']
5850
Option('all', help='Shelve all changes.'),
5852
RegistryOption('writer', 'Method to use for writing diffs.',
5853
bzrlib.option.diff_writer_registry,
5854
value_switches=True, enum_switch=False),
5856
Option('list', help='List shelved changes.'),
5858
help='Destroy removed changes instead of shelving them.'),
5860
_see_also = ['unshelve']
5862
def run(self, revision=None, all=False, file_list=None, message=None,
5863
writer=None, list=False, destroy=False, directory=u'.'):
5865
return self.run_for_list()
5866
from bzrlib.shelf_ui import Shelver
5868
writer = bzrlib.option.diff_writer_registry.get()
5870
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5871
file_list, message, destroy=destroy, directory=directory)
5876
except errors.UserAbort:
5879
def run_for_list(self):
5880
tree = WorkingTree.open_containing('.')[0]
5881
self.add_cleanup(tree.lock_read().unlock)
5882
manager = tree.get_shelf_manager()
5883
shelves = manager.active_shelves()
5884
if len(shelves) == 0:
5885
note('No shelved changes.')
5887
for shelf_id in reversed(shelves):
5888
message = manager.get_metadata(shelf_id).get('message')
5890
message = '<no message>'
5891
self.outf.write('%3d: %s\n' % (shelf_id, message))
5895
class cmd_unshelve(Command):
5896
__doc__ = """Restore shelved changes.
5898
By default, the most recently shelved changes are restored. However if you
5899
specify a shelf by id those changes will be restored instead. This works
5900
best when the changes don't depend on each other.
5903
takes_args = ['shelf_id?']
5906
RegistryOption.from_kwargs(
5907
'action', help="The action to perform.",
5908
enum_switch=False, value_switches=True,
5909
apply="Apply changes and remove from the shelf.",
5910
dry_run="Show changes, but do not apply or remove them.",
5911
preview="Instead of unshelving the changes, show the diff that "
5912
"would result from unshelving.",
5913
delete_only="Delete changes without applying them.",
5914
keep="Apply changes but don't delete them.",
5917
_see_also = ['shelve']
5919
def run(self, shelf_id=None, action='apply', directory=u'.'):
5920
from bzrlib.shelf_ui import Unshelver
5921
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5925
unshelver.tree.unlock()
5928
class cmd_clean_tree(Command):
5929
__doc__ = """Remove unwanted files from working tree.
5931
By default, only unknown files, not ignored files, are deleted. Versioned
5932
files are never deleted.
5934
Another class is 'detritus', which includes files emitted by bzr during
5935
normal operations and selftests. (The value of these files decreases with
5938
If no options are specified, unknown files are deleted. Otherwise, option
5939
flags are respected, and may be combined.
5941
To check what clean-tree will do, use --dry-run.
5943
takes_options = ['directory',
5944
Option('ignored', help='Delete all ignored files.'),
5945
Option('detritus', help='Delete conflict files, merge'
5946
' backups, and failed selftest dirs.'),
5948
help='Delete files unknown to bzr (default).'),
5949
Option('dry-run', help='Show files to delete instead of'
5951
Option('force', help='Do not prompt before deleting.')]
5952
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5953
force=False, directory=u'.'):
5954
from bzrlib.clean_tree import clean_tree
5955
if not (unknown or ignored or detritus):
5959
clean_tree(directory, unknown=unknown, ignored=ignored,
5960
detritus=detritus, dry_run=dry_run, no_prompt=force)
5963
class cmd_reference(Command):
5964
__doc__ = """list, view and set branch locations for nested trees.
5966
If no arguments are provided, lists the branch locations for nested trees.
5967
If one argument is provided, display the branch location for that tree.
5968
If two arguments are provided, set the branch location for that tree.
5973
takes_args = ['path?', 'location?']
5975
def run(self, path=None, location=None):
5977
if path is not None:
5979
tree, branch, relpath =(
5980
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5981
if path is not None:
5984
tree = branch.basis_tree()
5986
info = branch._get_all_reference_info().iteritems()
5987
self._display_reference_info(tree, branch, info)
5989
file_id = tree.path2id(path)
5991
raise errors.NotVersionedError(path)
5992
if location is None:
5993
info = [(file_id, branch.get_reference_info(file_id))]
5994
self._display_reference_info(tree, branch, info)
5996
branch.set_reference_info(file_id, path, location)
5998
def _display_reference_info(self, tree, branch, info):
6000
for file_id, (path, location) in info:
6002
path = tree.id2path(file_id)
6003
except errors.NoSuchId:
6005
ref_list.append((path, location))
6006
for path, location in sorted(ref_list):
6007
self.outf.write('%s %s\n' % (path, location))
6010
def _register_lazy_builtins():
6011
# register lazy builtins from other modules; called at startup and should
6012
# be only called once.
6013
for (name, aliases, module_name) in [
6014
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6015
('cmd_dpush', [], 'bzrlib.foreign'),
6016
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6017
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6018
('cmd_conflicts', [], 'bzrlib.conflicts'),
6019
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6021
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
