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
help="Show base revision text in conflicts.")
929
takes_args = ['location?']
930
encoding_type = 'replace'
932
def run(self, location=None, remember=False, overwrite=False,
933
revision=None, verbose=False,
934
directory=None, local=False,
936
# FIXME: too much stuff is in the command class
939
if directory is None:
942
tree_to = WorkingTree.open_containing(directory)[0]
943
branch_to = tree_to.branch
944
self.add_cleanup(tree_to.lock_write().unlock)
945
except errors.NoWorkingTree:
947
branch_to = Branch.open_containing(directory)[0]
948
self.add_cleanup(branch_to.lock_write().unlock)
950
if tree_to is None and show_base:
951
raise errors.BzrCommandError("Need working tree for --show-base.")
953
if local and not branch_to.get_bound_location():
954
raise errors.LocalRequiresBoundBranch()
956
possible_transports = []
957
if location is not None:
959
mergeable = bundle.read_mergeable_from_url(location,
960
possible_transports=possible_transports)
961
except errors.NotABundle:
964
stored_loc = branch_to.get_parent()
966
if stored_loc is None:
967
raise errors.BzrCommandError("No pull location known or"
970
display_url = urlutils.unescape_for_display(stored_loc,
973
self.outf.write("Using saved parent location: %s\n" % display_url)
974
location = stored_loc
976
revision = _get_one_revision('pull', revision)
977
if mergeable is not None:
978
if revision is not None:
979
raise errors.BzrCommandError(
980
'Cannot use -r with merge directives or bundles')
981
mergeable.install_revisions(branch_to.repository)
982
base_revision_id, revision_id, verified = \
983
mergeable.get_merge_request(branch_to.repository)
984
branch_from = branch_to
986
branch_from = Branch.open(location,
987
possible_transports=possible_transports)
988
self.add_cleanup(branch_from.lock_read().unlock)
990
if branch_to.get_parent() is None or remember:
991
branch_to.set_parent(branch_from.base)
993
if revision is not None:
994
revision_id = revision.as_revision_id(branch_from)
996
if tree_to is not None:
997
view_info = _get_view_info_for_change_reporter(tree_to)
998
change_reporter = delta._ChangeReporter(
999
unversioned_filter=tree_to.is_ignored,
1000
view_info=view_info)
1001
result = tree_to.pull(
1002
branch_from, overwrite, revision_id, change_reporter,
1003
possible_transports=possible_transports, local=local,
1004
show_base=show_base)
1006
result = branch_to.pull(
1007
branch_from, overwrite, revision_id, local=local)
1009
result.report(self.outf)
1010
if verbose and result.old_revid != result.new_revid:
1011
log.show_branch_change(
1012
branch_to, self.outf, result.old_revno,
1016
class cmd_push(Command):
1017
__doc__ = """Update a mirror of this branch.
1019
The target branch will not have its working tree populated because this
1020
is both expensive, and is not supported on remote file systems.
1022
Some smart servers or protocols *may* put the working tree in place in
1025
This command only works on branches that have not diverged. Branches are
1026
considered diverged if the destination branch's most recent commit is one
1027
that has not been merged (directly or indirectly) by the source branch.
1029
If branches have diverged, you can use 'bzr push --overwrite' to replace
1030
the other branch completely, discarding its unmerged changes.
1032
If you want to ensure you have the different changes in the other branch,
1033
do a merge (see bzr help merge) from the other branch, and commit that.
1034
After that you will be able to do a push without '--overwrite'.
1036
If there is no default push location set, the first push will set it.
1037
After that, you can omit the location to use the default. To change the
1038
default, use --remember. The value will only be saved if the remote
1039
location can be accessed.
1042
_see_also = ['pull', 'update', 'working-trees']
1043
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1044
Option('create-prefix',
1045
help='Create the path leading up to the branch '
1046
'if it does not already exist.'),
1047
custom_help('directory',
1048
help='Branch to push from, '
1049
'rather than the one containing the working directory.'),
1050
Option('use-existing-dir',
1051
help='By default push will fail if the target'
1052
' directory exists, but does not already'
1053
' have a control directory. This flag will'
1054
' allow push to proceed.'),
1056
help='Create a stacked branch that references the public location '
1057
'of the parent branch.'),
1058
Option('stacked-on',
1059
help='Create a stacked branch that refers to another branch '
1060
'for the commit history. Only the work not present in the '
1061
'referenced branch is included in the branch created.',
1064
help='Refuse to push if there are uncommitted changes in'
1065
' the working tree, --no-strict disables the check.'),
1067
takes_args = ['location?']
1068
encoding_type = 'replace'
1070
def run(self, location=None, remember=False, overwrite=False,
1071
create_prefix=False, verbose=False, revision=None,
1072
use_existing_dir=False, directory=None, stacked_on=None,
1073
stacked=False, strict=None):
1074
from bzrlib.push import _show_push_branch
1076
if directory is None:
1078
# Get the source branch
1080
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1081
# Get the tip's revision_id
1082
revision = _get_one_revision('push', revision)
1083
if revision is not None:
1084
revision_id = revision.in_history(br_from).rev_id
1087
if tree is not None and revision_id is None:
1088
tree.check_changed_or_out_of_date(
1089
strict, 'push_strict',
1090
more_error='Use --no-strict to force the push.',
1091
more_warning='Uncommitted changes will not be pushed.')
1092
# Get the stacked_on branch, if any
1093
if stacked_on is not None:
1094
stacked_on = urlutils.normalize_url(stacked_on)
1096
parent_url = br_from.get_parent()
1098
parent = Branch.open(parent_url)
1099
stacked_on = parent.get_public_branch()
1101
# I considered excluding non-http url's here, thus forcing
1102
# 'public' branches only, but that only works for some
1103
# users, so it's best to just depend on the user spotting an
1104
# error by the feedback given to them. RBC 20080227.
1105
stacked_on = parent_url
1107
raise errors.BzrCommandError(
1108
"Could not determine branch to refer to.")
1110
# Get the destination location
1111
if location is None:
1112
stored_loc = br_from.get_push_location()
1113
if stored_loc is None:
1114
raise errors.BzrCommandError(
1115
"No push location known or specified.")
1117
display_url = urlutils.unescape_for_display(stored_loc,
1119
self.outf.write("Using saved push location: %s\n" % display_url)
1120
location = stored_loc
1122
_show_push_branch(br_from, revision_id, location, self.outf,
1123
verbose=verbose, overwrite=overwrite, remember=remember,
1124
stacked_on=stacked_on, create_prefix=create_prefix,
1125
use_existing_dir=use_existing_dir)
1128
class cmd_branch(Command):
1129
__doc__ = """Create a new branch that is a copy of an existing branch.
1131
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1132
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1133
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1134
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1135
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1138
To retrieve the branch as of a particular revision, supply the --revision
1139
parameter, as in "branch foo/bar -r 5".
1142
_see_also = ['checkout']
1143
takes_args = ['from_location', 'to_location?']
1144
takes_options = ['revision',
1145
Option('hardlink', help='Hard-link working tree files where possible.'),
1146
Option('files-from', type=str,
1147
help="Get file contents from this tree."),
1149
help="Create a branch without a working-tree."),
1151
help="Switch the checkout in the current directory "
1152
"to the new branch."),
1154
help='Create a stacked branch referring to the source branch. '
1155
'The new branch will depend on the availability of the source '
1156
'branch for all operations.'),
1157
Option('standalone',
1158
help='Do not use a shared repository, even if available.'),
1159
Option('use-existing-dir',
1160
help='By default branch will fail if the target'
1161
' directory exists, but does not already'
1162
' have a control directory. This flag will'
1163
' allow branch to proceed.'),
1165
help="Bind new branch to from location."),
1167
aliases = ['get', 'clone']
1169
def run(self, from_location, to_location=None, revision=None,
1170
hardlink=False, stacked=False, standalone=False, no_tree=False,
1171
use_existing_dir=False, switch=False, bind=False,
1173
from bzrlib import switch as _mod_switch
1174
from bzrlib.tag import _merge_tags_if_possible
1175
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1177
if not (hardlink or files_from):
1178
# accelerator_tree is usually slower because you have to read N
1179
# files (no readahead, lots of seeks, etc), but allow the user to
1180
# explicitly request it
1181
accelerator_tree = None
1182
if files_from is not None and files_from != from_location:
1183
accelerator_tree = WorkingTree.open(files_from)
1184
revision = _get_one_revision('branch', revision)
1185
self.add_cleanup(br_from.lock_read().unlock)
1186
if revision is not None:
1187
revision_id = revision.as_revision_id(br_from)
1189
# FIXME - wt.last_revision, fallback to branch, fall back to
1190
# None or perhaps NULL_REVISION to mean copy nothing
1192
revision_id = br_from.last_revision()
1193
if to_location is None:
1194
to_location = urlutils.derive_to_location(from_location)
1195
to_transport = transport.get_transport(to_location)
1197
to_transport.mkdir('.')
1198
except errors.FileExists:
1199
if not use_existing_dir:
1200
raise errors.BzrCommandError('Target directory "%s" '
1201
'already exists.' % to_location)
1204
bzrdir.BzrDir.open_from_transport(to_transport)
1205
except errors.NotBranchError:
1208
raise errors.AlreadyBranchError(to_location)
1209
except errors.NoSuchFile:
1210
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1213
# preserve whatever source format we have.
1214
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1215
possible_transports=[to_transport],
1216
accelerator_tree=accelerator_tree,
1217
hardlink=hardlink, stacked=stacked,
1218
force_new_repo=standalone,
1219
create_tree_if_local=not no_tree,
1220
source_branch=br_from)
1221
branch = dir.open_branch()
1222
except errors.NoSuchRevision:
1223
to_transport.delete_tree('.')
1224
msg = "The branch %s has no revision %s." % (from_location,
1226
raise errors.BzrCommandError(msg)
1227
_merge_tags_if_possible(br_from, branch)
1228
# If the source branch is stacked, the new branch may
1229
# be stacked whether we asked for that explicitly or not.
1230
# We therefore need a try/except here and not just 'if stacked:'
1232
note('Created new stacked branch referring to %s.' %
1233
branch.get_stacked_on_url())
1234
except (errors.NotStacked, errors.UnstackableBranchFormat,
1235
errors.UnstackableRepositoryFormat), e:
1236
note('Branched %d revision(s).' % branch.revno())
1238
# Bind to the parent
1239
parent_branch = Branch.open(from_location)
1240
branch.bind(parent_branch)
1241
note('New branch bound to %s' % from_location)
1243
# Switch to the new branch
1244
wt, _ = WorkingTree.open_containing('.')
1245
_mod_switch.switch(wt.bzrdir, branch)
1246
note('Switched to branch: %s',
1247
urlutils.unescape_for_display(branch.base, 'utf-8'))
1250
class cmd_checkout(Command):
1251
__doc__ = """Create a new checkout of an existing branch.
1253
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1254
the branch found in '.'. This is useful if you have removed the working tree
1255
or if it was never created - i.e. if you pushed the branch to its current
1256
location using SFTP.
1258
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1259
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1260
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1261
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1262
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1265
To retrieve the branch as of a particular revision, supply the --revision
1266
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1267
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1271
_see_also = ['checkouts', 'branch']
1272
takes_args = ['branch_location?', 'to_location?']
1273
takes_options = ['revision',
1274
Option('lightweight',
1275
help="Perform a lightweight checkout. Lightweight "
1276
"checkouts depend on access to the branch for "
1277
"every operation. Normal checkouts can perform "
1278
"common operations like diff and status without "
1279
"such access, and also support local commits."
1281
Option('files-from', type=str,
1282
help="Get file contents from this tree."),
1284
help='Hard-link working tree files where possible.'
1289
def run(self, branch_location=None, to_location=None, revision=None,
1290
lightweight=False, files_from=None, hardlink=False):
1291
if branch_location is None:
1292
branch_location = osutils.getcwd()
1293
to_location = branch_location
1294
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1296
if not (hardlink or files_from):
1297
# accelerator_tree is usually slower because you have to read N
1298
# files (no readahead, lots of seeks, etc), but allow the user to
1299
# explicitly request it
1300
accelerator_tree = None
1301
revision = _get_one_revision('checkout', revision)
1302
if files_from is not None and files_from != branch_location:
1303
accelerator_tree = WorkingTree.open(files_from)
1304
if revision is not None:
1305
revision_id = revision.as_revision_id(source)
1308
if to_location is None:
1309
to_location = urlutils.derive_to_location(branch_location)
1310
# if the source and to_location are the same,
1311
# and there is no working tree,
1312
# then reconstitute a branch
1313
if (osutils.abspath(to_location) ==
1314
osutils.abspath(branch_location)):
1316
source.bzrdir.open_workingtree()
1317
except errors.NoWorkingTree:
1318
source.bzrdir.create_workingtree(revision_id)
1320
source.create_checkout(to_location, revision_id, lightweight,
1321
accelerator_tree, hardlink)
1324
class cmd_renames(Command):
1325
__doc__ = """Show list of renamed files.
1327
# TODO: Option to show renames between two historical versions.
1329
# TODO: Only show renames under dir, rather than in the whole branch.
1330
_see_also = ['status']
1331
takes_args = ['dir?']
1334
def run(self, dir=u'.'):
1335
tree = WorkingTree.open_containing(dir)[0]
1336
self.add_cleanup(tree.lock_read().unlock)
1337
new_inv = tree.inventory
1338
old_tree = tree.basis_tree()
1339
self.add_cleanup(old_tree.lock_read().unlock)
1340
old_inv = old_tree.inventory
1342
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1343
for f, paths, c, v, p, n, k, e in iterator:
1344
if paths[0] == paths[1]:
1348
renames.append(paths)
1350
for old_name, new_name in renames:
1351
self.outf.write("%s => %s\n" % (old_name, new_name))
1354
class cmd_update(Command):
1355
__doc__ = """Update a tree to have the latest code committed to its branch.
1357
This will perform a merge into the working tree, and may generate
1358
conflicts. If you have any local changes, you will still
1359
need to commit them after the update for the update to be complete.
1361
If you want to discard your local changes, you can just do a
1362
'bzr revert' instead of 'bzr commit' after the update.
1364
If you want to restore a file that has been removed locally, use
1365
'bzr revert' instead of 'bzr update'.
1367
If the tree's branch is bound to a master branch, it will also update
1368
the branch from the master.
1371
_see_also = ['pull', 'working-trees', 'status-flags']
1372
takes_args = ['dir?']
1373
takes_options = ['revision',
1375
help="Show base revision text in conflicts."),
1379
def run(self, dir='.', revision=None, show_base=None):
1380
if revision is not None and len(revision) != 1:
1381
raise errors.BzrCommandError(
1382
"bzr update --revision takes exactly one revision")
1383
tree = WorkingTree.open_containing(dir)[0]
1384
branch = tree.branch
1385
possible_transports = []
1386
master = branch.get_master_branch(
1387
possible_transports=possible_transports)
1388
if master is not None:
1389
branch_location = master.base
1392
branch_location = tree.branch.base
1393
tree.lock_tree_write()
1394
self.add_cleanup(tree.unlock)
1395
# get rid of the final '/' and be ready for display
1396
branch_location = urlutils.unescape_for_display(
1397
branch_location.rstrip('/'),
1399
existing_pending_merges = tree.get_parent_ids()[1:]
1403
# may need to fetch data into a heavyweight checkout
1404
# XXX: this may take some time, maybe we should display a
1406
old_tip = branch.update(possible_transports)
1407
if revision is not None:
1408
revision_id = revision[0].as_revision_id(branch)
1410
revision_id = branch.last_revision()
1411
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1412
revno = branch.revision_id_to_dotted_revno(revision_id)
1413
note("Tree is up to date at revision %s of branch %s" %
1414
('.'.join(map(str, revno)), branch_location))
1416
view_info = _get_view_info_for_change_reporter(tree)
1417
change_reporter = delta._ChangeReporter(
1418
unversioned_filter=tree.is_ignored,
1419
view_info=view_info)
1421
conflicts = tree.update(
1423
possible_transports=possible_transports,
1424
revision=revision_id,
1426
show_base=show_base)
1427
except errors.NoSuchRevision, e:
1428
raise errors.BzrCommandError(
1429
"branch has no revision %s\n"
1430
"bzr update --revision only works"
1431
" for a revision in the branch history"
1433
revno = tree.branch.revision_id_to_dotted_revno(
1434
_mod_revision.ensure_null(tree.last_revision()))
1435
note('Updated to revision %s of branch %s' %
1436
('.'.join(map(str, revno)), branch_location))
1437
parent_ids = tree.get_parent_ids()
1438
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1439
note('Your local commits will now show as pending merges with '
1440
"'bzr status', and can be committed with 'bzr commit'.")
1447
class cmd_info(Command):
1448
__doc__ = """Show information about a working tree, branch or repository.
1450
This command will show all known locations and formats associated to the
1451
tree, branch or repository.
1453
In verbose mode, statistical information is included with each report.
1454
To see extended statistic information, use a verbosity level of 2 or
1455
higher by specifying the verbose option multiple times, e.g. -vv.
1457
Branches and working trees will also report any missing revisions.
1461
Display information on the format and related locations:
1465
Display the above together with extended format information and
1466
basic statistics (like the number of files in the working tree and
1467
number of revisions in the branch and repository):
1471
Display the above together with number of committers to the branch:
1475
_see_also = ['revno', 'working-trees', 'repositories']
1476
takes_args = ['location?']
1477
takes_options = ['verbose']
1478
encoding_type = 'replace'
1481
def run(self, location=None, verbose=False):
1483
noise_level = get_verbosity_level()
1486
from bzrlib.info import show_bzrdir_info
1487
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1488
verbose=noise_level, outfile=self.outf)
1491
class cmd_remove(Command):
1492
__doc__ = """Remove files or directories.
1494
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1495
delete them if they can easily be recovered using revert otherwise they
1496
will be backed up (adding an extention of the form .~#~). If no options or
1497
parameters are given Bazaar will scan for files that are being tracked by
1498
Bazaar but missing in your tree and stop tracking them for you.
1500
takes_args = ['file*']
1501
takes_options = ['verbose',
1502
Option('new', help='Only remove files that have never been committed.'),
1503
RegistryOption.from_kwargs('file-deletion-strategy',
1504
'The file deletion mode to be used.',
1505
title='Deletion Strategy', value_switches=True, enum_switch=False,
1506
safe='Backup changed files (default).',
1507
keep='Delete from bzr but leave the working copy.',
1508
force='Delete all the specified files, even if they can not be '
1509
'recovered and even if they are non-empty directories.')]
1510
aliases = ['rm', 'del']
1511
encoding_type = 'replace'
1513
def run(self, file_list, verbose=False, new=False,
1514
file_deletion_strategy='safe'):
1515
tree, file_list = WorkingTree.open_containing_paths(file_list)
1517
if file_list is not None:
1518
file_list = [f for f in file_list]
1520
self.add_cleanup(tree.lock_write().unlock)
1521
# Heuristics should probably all move into tree.remove_smart or
1524
added = tree.changes_from(tree.basis_tree(),
1525
specific_files=file_list).added
1526
file_list = sorted([f[0] for f in added], reverse=True)
1527
if len(file_list) == 0:
1528
raise errors.BzrCommandError('No matching files.')
1529
elif file_list is None:
1530
# missing files show up in iter_changes(basis) as
1531
# versioned-with-no-kind.
1533
for change in tree.iter_changes(tree.basis_tree()):
1534
# Find paths in the working tree that have no kind:
1535
if change[1][1] is not None and change[6][1] is None:
1536
missing.append(change[1][1])
1537
file_list = sorted(missing, reverse=True)
1538
file_deletion_strategy = 'keep'
1539
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1540
keep_files=file_deletion_strategy=='keep',
1541
force=file_deletion_strategy=='force')
1544
class cmd_file_id(Command):
1545
__doc__ = """Print file_id of a particular file or directory.
1547
The file_id is assigned when the file is first added and remains the
1548
same through all revisions where the file exists, even when it is
1553
_see_also = ['inventory', 'ls']
1554
takes_args = ['filename']
1557
def run(self, filename):
1558
tree, relpath = WorkingTree.open_containing(filename)
1559
i = tree.path2id(relpath)
1561
raise errors.NotVersionedError(filename)
1563
self.outf.write(i + '\n')
1566
class cmd_file_path(Command):
1567
__doc__ = """Print path of file_ids to a file or directory.
1569
This prints one line for each directory down to the target,
1570
starting at the branch root.
1574
takes_args = ['filename']
1577
def run(self, filename):
1578
tree, relpath = WorkingTree.open_containing(filename)
1579
fid = tree.path2id(relpath)
1581
raise errors.NotVersionedError(filename)
1582
segments = osutils.splitpath(relpath)
1583
for pos in range(1, len(segments) + 1):
1584
path = osutils.joinpath(segments[:pos])
1585
self.outf.write("%s\n" % tree.path2id(path))
1588
class cmd_reconcile(Command):
1589
__doc__ = """Reconcile bzr metadata in a branch.
1591
This can correct data mismatches that may have been caused by
1592
previous ghost operations or bzr upgrades. You should only
1593
need to run this command if 'bzr check' or a bzr developer
1594
advises you to run it.
1596
If a second branch is provided, cross-branch reconciliation is
1597
also attempted, which will check that data like the tree root
1598
id which was not present in very early bzr versions is represented
1599
correctly in both branches.
1601
At the same time it is run it may recompress data resulting in
1602
a potential saving in disk space or performance gain.
1604
The branch *MUST* be on a listable system such as local disk or sftp.
1607
_see_also = ['check']
1608
takes_args = ['branch?']
1610
Option('canonicalize-chks',
1611
help='Make sure CHKs are in canonical form (repairs '
1616
def run(self, branch=".", canonicalize_chks=False):
1617
from bzrlib.reconcile import reconcile
1618
dir = bzrdir.BzrDir.open(branch)
1619
reconcile(dir, canonicalize_chks=canonicalize_chks)
1622
class cmd_revision_history(Command):
1623
__doc__ = """Display the list of revision ids on a branch."""
1626
takes_args = ['location?']
1631
def run(self, location="."):
1632
branch = Branch.open_containing(location)[0]
1633
for revid in branch.revision_history():
1634
self.outf.write(revid)
1635
self.outf.write('\n')
1638
class cmd_ancestry(Command):
1639
__doc__ = """List all revisions merged into this branch."""
1641
_see_also = ['log', 'revision-history']
1642
takes_args = ['location?']
1647
def run(self, location="."):
1649
wt = WorkingTree.open_containing(location)[0]
1650
except errors.NoWorkingTree:
1651
b = Branch.open(location)
1652
last_revision = b.last_revision()
1655
last_revision = wt.last_revision()
1657
revision_ids = b.repository.get_ancestry(last_revision)
1659
for revision_id in revision_ids:
1660
self.outf.write(revision_id + '\n')
1663
class cmd_init(Command):
1664
__doc__ = """Make a directory into a versioned branch.
1666
Use this to create an empty branch, or before importing an
1669
If there is a repository in a parent directory of the location, then
1670
the history of the branch will be stored in the repository. Otherwise
1671
init creates a standalone branch which carries its own history
1672
in the .bzr directory.
1674
If there is already a branch at the location but it has no working tree,
1675
the tree can be populated with 'bzr checkout'.
1677
Recipe for importing a tree of files::
1683
bzr commit -m "imported project"
1686
_see_also = ['init-repository', 'branch', 'checkout']
1687
takes_args = ['location?']
1689
Option('create-prefix',
1690
help='Create the path leading up to the branch '
1691
'if it does not already exist.'),
1692
RegistryOption('format',
1693
help='Specify a format for this branch. '
1694
'See "help formats".',
1695
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1696
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1697
value_switches=True,
1698
title="Branch format",
1700
Option('append-revisions-only',
1701
help='Never change revnos or the existing log.'
1702
' Append revisions to it only.')
1704
def run(self, location=None, format=None, append_revisions_only=False,
1705
create_prefix=False):
1707
format = bzrdir.format_registry.make_bzrdir('default')
1708
if location is None:
1711
to_transport = transport.get_transport(location)
1713
# The path has to exist to initialize a
1714
# branch inside of it.
1715
# Just using os.mkdir, since I don't
1716
# believe that we want to create a bunch of
1717
# locations if the user supplies an extended path
1719
to_transport.ensure_base()
1720
except errors.NoSuchFile:
1721
if not create_prefix:
1722
raise errors.BzrCommandError("Parent directory of %s"
1724
"\nYou may supply --create-prefix to create all"
1725
" leading parent directories."
1727
to_transport.create_prefix()
1730
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1731
except errors.NotBranchError:
1732
# really a NotBzrDir error...
1733
create_branch = bzrdir.BzrDir.create_branch_convenience
1734
branch = create_branch(to_transport.base, format=format,
1735
possible_transports=[to_transport])
1736
a_bzrdir = branch.bzrdir
1738
from bzrlib.transport.local import LocalTransport
1739
if a_bzrdir.has_branch():
1740
if (isinstance(to_transport, LocalTransport)
1741
and not a_bzrdir.has_workingtree()):
1742
raise errors.BranchExistsWithoutWorkingTree(location)
1743
raise errors.AlreadyBranchError(location)
1744
branch = a_bzrdir.create_branch()
1745
a_bzrdir.create_workingtree()
1746
if append_revisions_only:
1748
branch.set_append_revisions_only(True)
1749
except errors.UpgradeRequired:
1750
raise errors.BzrCommandError('This branch format cannot be set'
1751
' to append-revisions-only. Try --default.')
1753
from bzrlib.info import describe_layout, describe_format
1755
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1756
except (errors.NoWorkingTree, errors.NotLocalUrl):
1758
repository = branch.repository
1759
layout = describe_layout(repository, branch, tree).lower()
1760
format = describe_format(a_bzrdir, repository, branch, tree)
1761
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1762
if repository.is_shared():
1763
#XXX: maybe this can be refactored into transport.path_or_url()
1764
url = repository.bzrdir.root_transport.external_url()
1766
url = urlutils.local_path_from_url(url)
1767
except errors.InvalidURL:
1769
self.outf.write("Using shared repository: %s\n" % url)
1772
class cmd_init_repository(Command):
1773
__doc__ = """Create a shared repository for branches to share storage space.
1775
New branches created under the repository directory will store their
1776
revisions in the repository, not in the branch directory. For branches
1777
with shared history, this reduces the amount of storage needed and
1778
speeds up the creation of new branches.
1780
If the --no-trees option is given then the branches in the repository
1781
will not have working trees by default. They will still exist as
1782
directories on disk, but they will not have separate copies of the
1783
files at a certain revision. This can be useful for repositories that
1784
store branches which are interacted with through checkouts or remote
1785
branches, such as on a server.
1788
Create a shared repository holding just branches::
1790
bzr init-repo --no-trees repo
1793
Make a lightweight checkout elsewhere::
1795
bzr checkout --lightweight repo/trunk trunk-checkout
1800
_see_also = ['init', 'branch', 'checkout', 'repositories']
1801
takes_args = ["location"]
1802
takes_options = [RegistryOption('format',
1803
help='Specify a format for this repository. See'
1804
' "bzr help formats" for details.',
1805
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1806
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1807
value_switches=True, title='Repository format'),
1809
help='Branches in the repository will default to'
1810
' not having a working tree.'),
1812
aliases = ["init-repo"]
1814
def run(self, location, format=None, no_trees=False):
1816
format = bzrdir.format_registry.make_bzrdir('default')
1818
if location is None:
1821
to_transport = transport.get_transport(location)
1822
to_transport.ensure_base()
1824
newdir = format.initialize_on_transport(to_transport)
1825
repo = newdir.create_repository(shared=True)
1826
repo.set_make_working_trees(not no_trees)
1828
from bzrlib.info import show_bzrdir_info
1829
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1832
class cmd_diff(Command):
1833
__doc__ = """Show differences in the working tree, between revisions or branches.
1835
If no arguments are given, all changes for the current tree are listed.
1836
If files are given, only the changes in those files are listed.
1837
Remote and multiple branches can be compared by using the --old and
1838
--new options. If not provided, the default for both is derived from
1839
the first argument, if any, or the current tree if no arguments are
1842
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1843
produces patches suitable for "patch -p1".
1847
2 - unrepresentable changes
1852
Shows the difference in the working tree versus the last commit::
1856
Difference between the working tree and revision 1::
1860
Difference between revision 3 and revision 1::
1864
Difference between revision 3 and revision 1 for branch xxx::
1868
To see the changes introduced in revision X::
1872
Note that in the case of a merge, the -c option shows the changes
1873
compared to the left hand parent. To see the changes against
1874
another parent, use::
1876
bzr diff -r<chosen_parent>..X
1878
The changes introduced by revision 2 (equivalent to -r1..2)::
1882
Show just the differences for file NEWS::
1886
Show the differences in working tree xxx for file NEWS::
1890
Show the differences from branch xxx to this working tree:
1894
Show the differences between two branches for file NEWS::
1896
bzr diff --old xxx --new yyy NEWS
1898
Same as 'bzr diff' but prefix paths with old/ and new/::
1900
bzr diff --prefix old/:new/
1902
Show the differences using a custom diff program with options::
1904
bzr diff --using /usr/bin/diff --diff-options -wu
1906
_see_also = ['status']
1907
takes_args = ['file*']
1909
Option('diff-options', type=str,
1910
help='Pass these options to the external diff program.'),
1911
Option('prefix', type=str,
1913
help='Set prefixes added to old and new filenames, as '
1914
'two values separated by a colon. (eg "old/:new/").'),
1916
help='Branch/tree to compare from.',
1920
help='Branch/tree to compare to.',
1926
help='Use this command to compare files.',
1929
RegistryOption('format',
1930
help='Diff format to use.',
1931
lazy_registry=('bzrlib.diff', 'format_registry'),
1932
value_switches=False, title='Diff format'),
1934
aliases = ['di', 'dif']
1935
encoding_type = 'exact'
1938
def run(self, revision=None, file_list=None, diff_options=None,
1939
prefix=None, old=None, new=None, using=None, format=None):
1940
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1943
if (prefix is None) or (prefix == '0'):
1951
old_label, new_label = prefix.split(":")
1953
raise errors.BzrCommandError(
1954
'--prefix expects two values separated by a colon'
1955
' (eg "old/:new/")')
1957
if revision and len(revision) > 2:
1958
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1959
' one or two revision specifiers')
1961
if using is not None and format is not None:
1962
raise errors.BzrCommandError('--using and --format are mutually '
1965
(old_tree, new_tree,
1966
old_branch, new_branch,
1967
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1968
file_list, revision, old, new, self.add_cleanup, apply_view=True)
1969
# GNU diff on Windows uses ANSI encoding for filenames
1970
path_encoding = osutils.get_diff_header_encoding()
1971
return show_diff_trees(old_tree, new_tree, sys.stdout,
1972
specific_files=specific_files,
1973
external_diff_options=diff_options,
1974
old_label=old_label, new_label=new_label,
1975
extra_trees=extra_trees,
1976
path_encoding=path_encoding,
1981
class cmd_deleted(Command):
1982
__doc__ = """List files deleted in the working tree.
1984
# TODO: Show files deleted since a previous revision, or
1985
# between two revisions.
1986
# TODO: Much more efficient way to do this: read in new
1987
# directories with readdir, rather than stating each one. Same
1988
# level of effort but possibly much less IO. (Or possibly not,
1989
# if the directories are very large...)
1990
_see_also = ['status', 'ls']
1991
takes_options = ['directory', 'show-ids']
1994
def run(self, show_ids=False, directory=u'.'):
1995
tree = WorkingTree.open_containing(directory)[0]
1996
self.add_cleanup(tree.lock_read().unlock)
1997
old = tree.basis_tree()
1998
self.add_cleanup(old.lock_read().unlock)
1999
for path, ie in old.inventory.iter_entries():
2000
if not tree.has_id(ie.file_id):
2001
self.outf.write(path)
2003
self.outf.write(' ')
2004
self.outf.write(ie.file_id)
2005
self.outf.write('\n')
2008
class cmd_modified(Command):
2009
__doc__ = """List files modified in working tree.
2013
_see_also = ['status', 'ls']
2014
takes_options = ['directory', 'null']
2017
def run(self, null=False, directory=u'.'):
2018
tree = WorkingTree.open_containing(directory)[0]
2019
td = tree.changes_from(tree.basis_tree())
2020
for path, id, kind, text_modified, meta_modified in td.modified:
2022
self.outf.write(path + '\0')
2024
self.outf.write(osutils.quotefn(path) + '\n')
2027
class cmd_added(Command):
2028
__doc__ = """List files added in working tree.
2032
_see_also = ['status', 'ls']
2033
takes_options = ['directory', 'null']
2036
def run(self, null=False, directory=u'.'):
2037
wt = WorkingTree.open_containing(directory)[0]
2038
self.add_cleanup(wt.lock_read().unlock)
2039
basis = wt.basis_tree()
2040
self.add_cleanup(basis.lock_read().unlock)
2041
basis_inv = basis.inventory
2044
if file_id in basis_inv:
2046
if inv.is_root(file_id) and len(basis_inv) == 0:
2048
path = inv.id2path(file_id)
2049
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2052
self.outf.write(path + '\0')
2054
self.outf.write(osutils.quotefn(path) + '\n')
2057
class cmd_root(Command):
2058
__doc__ = """Show the tree root directory.
2060
The root is the nearest enclosing directory with a .bzr control
2063
takes_args = ['filename?']
2065
def run(self, filename=None):
2066
"""Print the branch root."""
2067
tree = WorkingTree.open_containing(filename)[0]
2068
self.outf.write(tree.basedir + '\n')
2071
def _parse_limit(limitstring):
2073
return int(limitstring)
2075
msg = "The limit argument must be an integer."
2076
raise errors.BzrCommandError(msg)
2079
def _parse_levels(s):
2083
msg = "The levels argument must be an integer."
2084
raise errors.BzrCommandError(msg)
2087
class cmd_log(Command):
2088
__doc__ = """Show historical log for a branch or subset of a branch.
2090
log is bzr's default tool for exploring the history of a branch.
2091
The branch to use is taken from the first parameter. If no parameters
2092
are given, the branch containing the working directory is logged.
2093
Here are some simple examples::
2095
bzr log log the current branch
2096
bzr log foo.py log a file in its branch
2097
bzr log http://server/branch log a branch on a server
2099
The filtering, ordering and information shown for each revision can
2100
be controlled as explained below. By default, all revisions are
2101
shown sorted (topologically) so that newer revisions appear before
2102
older ones and descendants always appear before ancestors. If displayed,
2103
merged revisions are shown indented under the revision in which they
2108
The log format controls how information about each revision is
2109
displayed. The standard log formats are called ``long``, ``short``
2110
and ``line``. The default is long. See ``bzr help log-formats``
2111
for more details on log formats.
2113
The following options can be used to control what information is
2116
-l N display a maximum of N revisions
2117
-n N display N levels of revisions (0 for all, 1 for collapsed)
2118
-v display a status summary (delta) for each revision
2119
-p display a diff (patch) for each revision
2120
--show-ids display revision-ids (and file-ids), not just revnos
2122
Note that the default number of levels to display is a function of the
2123
log format. If the -n option is not used, the standard log formats show
2124
just the top level (mainline).
2126
Status summaries are shown using status flags like A, M, etc. To see
2127
the changes explained using words like ``added`` and ``modified``
2128
instead, use the -vv option.
2132
To display revisions from oldest to newest, use the --forward option.
2133
In most cases, using this option will have little impact on the total
2134
time taken to produce a log, though --forward does not incrementally
2135
display revisions like --reverse does when it can.
2137
:Revision filtering:
2139
The -r option can be used to specify what revision or range of revisions
2140
to filter against. The various forms are shown below::
2142
-rX display revision X
2143
-rX.. display revision X and later
2144
-r..Y display up to and including revision Y
2145
-rX..Y display from X to Y inclusive
2147
See ``bzr help revisionspec`` for details on how to specify X and Y.
2148
Some common examples are given below::
2150
-r-1 show just the tip
2151
-r-10.. show the last 10 mainline revisions
2152
-rsubmit:.. show what's new on this branch
2153
-rancestor:path.. show changes since the common ancestor of this
2154
branch and the one at location path
2155
-rdate:yesterday.. show changes since yesterday
2157
When logging a range of revisions using -rX..Y, log starts at
2158
revision Y and searches back in history through the primary
2159
("left-hand") parents until it finds X. When logging just the
2160
top level (using -n1), an error is reported if X is not found
2161
along the way. If multi-level logging is used (-n0), X may be
2162
a nested merge revision and the log will be truncated accordingly.
2166
If parameters are given and the first one is not a branch, the log
2167
will be filtered to show only those revisions that changed the
2168
nominated files or directories.
2170
Filenames are interpreted within their historical context. To log a
2171
deleted file, specify a revision range so that the file existed at
2172
the end or start of the range.
2174
Historical context is also important when interpreting pathnames of
2175
renamed files/directories. Consider the following example:
2177
* revision 1: add tutorial.txt
2178
* revision 2: modify tutorial.txt
2179
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2183
* ``bzr log guide.txt`` will log the file added in revision 1
2185
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2187
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2188
the original file in revision 2.
2190
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2191
was no file called guide.txt in revision 2.
2193
Renames are always followed by log. By design, there is no need to
2194
explicitly ask for this (and no way to stop logging a file back
2195
until it was last renamed).
2199
The --message option can be used for finding revisions that match a
2200
regular expression in a commit message.
2204
GUI tools and IDEs are often better at exploring history than command
2205
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2206
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2207
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2208
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2210
You may find it useful to add the aliases below to ``bazaar.conf``::
2214
top = log -l10 --line
2217
``bzr tip`` will then show the latest revision while ``bzr top``
2218
will show the last 10 mainline revisions. To see the details of a
2219
particular revision X, ``bzr show -rX``.
2221
If you are interested in looking deeper into a particular merge X,
2222
use ``bzr log -n0 -rX``.
2224
``bzr log -v`` on a branch with lots of history is currently
2225
very slow. A fix for this issue is currently under development.
2226
With or without that fix, it is recommended that a revision range
2227
be given when using the -v option.
2229
bzr has a generic full-text matching plugin, bzr-search, that can be
2230
used to find revisions matching user names, commit messages, etc.
2231
Among other features, this plugin can find all revisions containing
2232
a list of words but not others.
2234
When exploring non-mainline history on large projects with deep
2235
history, the performance of log can be greatly improved by installing
2236
the historycache plugin. This plugin buffers historical information
2237
trading disk space for faster speed.
2239
takes_args = ['file*']
2240
_see_also = ['log-formats', 'revisionspec']
2243
help='Show from oldest to newest.'),
2245
custom_help('verbose',
2246
help='Show files changed in each revision.'),
2250
type=bzrlib.option._parse_revision_str,
2252
help='Show just the specified revision.'
2253
' See also "help revisionspec".'),
2255
RegistryOption('authors',
2256
'What names to list as authors - first, all or committer.',
2258
lazy_registry=('bzrlib.log', 'author_list_registry'),
2262
help='Number of levels to display - 0 for all, 1 for flat.',
2264
type=_parse_levels),
2267
help='Show revisions whose message matches this '
2268
'regular expression.',
2272
help='Limit the output to the first N revisions.',
2277
help='Show changes made in each revision as a patch.'),
2278
Option('include-merges',
2279
help='Show merged revisions like --levels 0 does.'),
2280
Option('exclude-common-ancestry',
2281
help='Display only the revisions that are not part'
2282
' of both ancestries (require -rX..Y)'
2285
encoding_type = 'replace'
2288
def run(self, file_list=None, timezone='original',
2299
include_merges=False,
2301
exclude_common_ancestry=False,
2303
from bzrlib.log import (
2305
make_log_request_dict,
2306
_get_info_for_log_files,
2308
direction = (forward and 'forward') or 'reverse'
2309
if (exclude_common_ancestry
2310
and (revision is None or len(revision) != 2)):
2311
raise errors.BzrCommandError(
2312
'--exclude-common-ancestry requires -r with two revisions')
2317
raise errors.BzrCommandError(
2318
'--levels and --include-merges are mutually exclusive')
2320
if change is not None:
2322
raise errors.RangeInChangeOption()
2323
if revision is not None:
2324
raise errors.BzrCommandError(
2325
'--revision and --change are mutually exclusive')
2330
filter_by_dir = False
2332
# find the file ids to log and check for directory filtering
2333
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2334
revision, file_list, self.add_cleanup)
2335
for relpath, file_id, kind in file_info_list:
2337
raise errors.BzrCommandError(
2338
"Path unknown at end or start of revision range: %s" %
2340
# If the relpath is the top of the tree, we log everything
2345
file_ids.append(file_id)
2346
filter_by_dir = filter_by_dir or (
2347
kind in ['directory', 'tree-reference'])
2350
# FIXME ? log the current subdir only RBC 20060203
2351
if revision is not None \
2352
and len(revision) > 0 and revision[0].get_branch():
2353
location = revision[0].get_branch()
2356
dir, relpath = bzrdir.BzrDir.open_containing(location)
2357
b = dir.open_branch()
2358
self.add_cleanup(b.lock_read().unlock)
2359
rev1, rev2 = _get_revision_range(revision, b, self.name())
2361
# Decide on the type of delta & diff filtering to use
2362
# TODO: add an --all-files option to make this configurable & consistent
2370
diff_type = 'partial'
2374
# Build the log formatter
2375
if log_format is None:
2376
log_format = log.log_formatter_registry.get_default(b)
2377
# Make a non-encoding output to include the diffs - bug 328007
2378
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2379
lf = log_format(show_ids=show_ids, to_file=self.outf,
2380
to_exact_file=unencoded_output,
2381
show_timezone=timezone,
2382
delta_format=get_verbosity_level(),
2384
show_advice=levels is None,
2385
author_list_handler=authors)
2387
# Choose the algorithm for doing the logging. It's annoying
2388
# having multiple code paths like this but necessary until
2389
# the underlying repository format is faster at generating
2390
# deltas or can provide everything we need from the indices.
2391
# The default algorithm - match-using-deltas - works for
2392
# multiple files and directories and is faster for small
2393
# amounts of history (200 revisions say). However, it's too
2394
# slow for logging a single file in a repository with deep
2395
# history, i.e. > 10K revisions. In the spirit of "do no
2396
# evil when adding features", we continue to use the
2397
# original algorithm - per-file-graph - for the "single
2398
# file that isn't a directory without showing a delta" case.
2399
partial_history = revision and b.repository._format.supports_chks
2400
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2401
or delta_type or partial_history)
2403
# Build the LogRequest and execute it
2404
if len(file_ids) == 0:
2406
rqst = make_log_request_dict(
2407
direction=direction, specific_fileids=file_ids,
2408
start_revision=rev1, end_revision=rev2, limit=limit,
2409
message_search=message, delta_type=delta_type,
2410
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2411
exclude_common_ancestry=exclude_common_ancestry,
2413
Logger(b, rqst).show(lf)
2416
def _get_revision_range(revisionspec_list, branch, command_name):
2417
"""Take the input of a revision option and turn it into a revision range.
2419
It returns RevisionInfo objects which can be used to obtain the rev_id's
2420
of the desired revisions. It does some user input validations.
2422
if revisionspec_list is None:
2425
elif len(revisionspec_list) == 1:
2426
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2427
elif len(revisionspec_list) == 2:
2428
start_spec = revisionspec_list[0]
2429
end_spec = revisionspec_list[1]
2430
if end_spec.get_branch() != start_spec.get_branch():
2431
# b is taken from revision[0].get_branch(), and
2432
# show_log will use its revision_history. Having
2433
# different branches will lead to weird behaviors.
2434
raise errors.BzrCommandError(
2435
"bzr %s doesn't accept two revisions in different"
2436
" branches." % command_name)
2437
if start_spec.spec is None:
2438
# Avoid loading all the history.
2439
rev1 = RevisionInfo(branch, None, None)
2441
rev1 = start_spec.in_history(branch)
2442
# Avoid loading all of history when we know a missing
2443
# end of range means the last revision ...
2444
if end_spec.spec is None:
2445
last_revno, last_revision_id = branch.last_revision_info()
2446
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2448
rev2 = end_spec.in_history(branch)
2450
raise errors.BzrCommandError(
2451
'bzr %s --revision takes one or two values.' % command_name)
2455
def _revision_range_to_revid_range(revision_range):
2458
if revision_range[0] is not None:
2459
rev_id1 = revision_range[0].rev_id
2460
if revision_range[1] is not None:
2461
rev_id2 = revision_range[1].rev_id
2462
return rev_id1, rev_id2
2464
def get_log_format(long=False, short=False, line=False, default='long'):
2465
log_format = default
2469
log_format = 'short'
2475
class cmd_touching_revisions(Command):
2476
__doc__ = """Return revision-ids which affected a particular file.
2478
A more user-friendly interface is "bzr log FILE".
2482
takes_args = ["filename"]
2485
def run(self, filename):
2486
tree, relpath = WorkingTree.open_containing(filename)
2487
file_id = tree.path2id(relpath)
2489
self.add_cleanup(b.lock_read().unlock)
2490
touching_revs = log.find_touching_revisions(b, file_id)
2491
for revno, revision_id, what in touching_revs:
2492
self.outf.write("%6d %s\n" % (revno, what))
2495
class cmd_ls(Command):
2496
__doc__ = """List files in a tree.
2499
_see_also = ['status', 'cat']
2500
takes_args = ['path?']
2504
Option('recursive', short_name='R',
2505
help='Recurse into subdirectories.'),
2507
help='Print paths relative to the root of the branch.'),
2508
Option('unknown', short_name='u',
2509
help='Print unknown files.'),
2510
Option('versioned', help='Print versioned files.',
2512
Option('ignored', short_name='i',
2513
help='Print ignored files.'),
2514
Option('kind', short_name='k',
2515
help='List entries of a particular kind: file, directory, symlink.',
2522
def run(self, revision=None, verbose=False,
2523
recursive=False, from_root=False,
2524
unknown=False, versioned=False, ignored=False,
2525
null=False, kind=None, show_ids=False, path=None, directory=None):
2527
if kind and kind not in ('file', 'directory', 'symlink'):
2528
raise errors.BzrCommandError('invalid kind specified')
2530
if verbose and null:
2531
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2532
all = not (unknown or versioned or ignored)
2534
selection = {'I':ignored, '?':unknown, 'V':versioned}
2540
raise errors.BzrCommandError('cannot specify both --from-root'
2543
tree, branch, relpath = \
2544
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2546
# Calculate the prefix to use
2550
prefix = relpath + '/'
2551
elif fs_path != '.' and not fs_path.endswith('/'):
2552
prefix = fs_path + '/'
2554
if revision is not None or tree is None:
2555
tree = _get_one_revision_tree('ls', revision, branch=branch)
2558
if isinstance(tree, WorkingTree) and tree.supports_views():
2559
view_files = tree.views.lookup_view()
2562
view_str = views.view_display_str(view_files)
2563
note("Ignoring files outside view. View is %s" % view_str)
2565
self.add_cleanup(tree.lock_read().unlock)
2566
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2567
from_dir=relpath, recursive=recursive):
2568
# Apply additional masking
2569
if not all and not selection[fc]:
2571
if kind is not None and fkind != kind:
2576
fullpath = osutils.pathjoin(relpath, fp)
2579
views.check_path_in_view(tree, fullpath)
2580
except errors.FileOutsideView:
2585
fp = osutils.pathjoin(prefix, fp)
2586
kindch = entry.kind_character()
2587
outstring = fp + kindch
2588
ui.ui_factory.clear_term()
2590
outstring = '%-8s %s' % (fc, outstring)
2591
if show_ids and fid is not None:
2592
outstring = "%-50s %s" % (outstring, fid)
2593
self.outf.write(outstring + '\n')
2595
self.outf.write(fp + '\0')
2598
self.outf.write(fid)
2599
self.outf.write('\0')
2607
self.outf.write('%-50s %s\n' % (outstring, my_id))
2609
self.outf.write(outstring + '\n')
2612
class cmd_unknowns(Command):
2613
__doc__ = """List unknown files.
2618
takes_options = ['directory']
2621
def run(self, directory=u'.'):
2622
for f in WorkingTree.open_containing(directory)[0].unknowns():
2623
self.outf.write(osutils.quotefn(f) + '\n')
2626
class cmd_ignore(Command):
2627
__doc__ = """Ignore specified files or patterns.
2629
See ``bzr help patterns`` for details on the syntax of patterns.
2631
If a .bzrignore file does not exist, the ignore command
2632
will create one and add the specified files or patterns to the newly
2633
created file. The ignore command will also automatically add the
2634
.bzrignore file to be versioned. Creating a .bzrignore file without
2635
the use of the ignore command will require an explicit add command.
2637
To remove patterns from the ignore list, edit the .bzrignore file.
2638
After adding, editing or deleting that file either indirectly by
2639
using this command or directly by using an editor, be sure to commit
2642
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2643
the global ignore file can be found in the application data directory as
2644
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2645
Global ignores are not touched by this command. The global ignore file
2646
can be edited directly using an editor.
2648
Patterns prefixed with '!' are exceptions to ignore patterns and take
2649
precedence over regular ignores. Such exceptions are used to specify
2650
files that should be versioned which would otherwise be ignored.
2652
Patterns prefixed with '!!' act as regular ignore patterns, but have
2653
precedence over the '!' exception patterns.
2655
Note: ignore patterns containing shell wildcards must be quoted from
2659
Ignore the top level Makefile::
2661
bzr ignore ./Makefile
2663
Ignore .class files in all directories...::
2665
bzr ignore "*.class"
2667
...but do not ignore "special.class"::
2669
bzr ignore "!special.class"
2671
Ignore .o files under the lib directory::
2673
bzr ignore "lib/**/*.o"
2675
Ignore .o files under the lib directory::
2677
bzr ignore "RE:lib/.*\.o"
2679
Ignore everything but the "debian" toplevel directory::
2681
bzr ignore "RE:(?!debian/).*"
2683
Ignore everything except the "local" toplevel directory,
2684
but always ignore "*~" autosave files, even under local/::
2687
bzr ignore "!./local"
2691
_see_also = ['status', 'ignored', 'patterns']
2692
takes_args = ['name_pattern*']
2693
takes_options = ['directory',
2694
Option('default-rules',
2695
help='Display the default ignore rules that bzr uses.')
2698
def run(self, name_pattern_list=None, default_rules=None,
2700
from bzrlib import ignores
2701
if default_rules is not None:
2702
# dump the default rules and exit
2703
for pattern in ignores.USER_DEFAULTS:
2704
self.outf.write("%s\n" % pattern)
2706
if not name_pattern_list:
2707
raise errors.BzrCommandError("ignore requires at least one "
2708
"NAME_PATTERN or --default-rules.")
2709
name_pattern_list = [globbing.normalize_pattern(p)
2710
for p in name_pattern_list]
2712
for p in name_pattern_list:
2713
if not globbing.Globster.is_pattern_valid(p):
2714
bad_patterns += ('\n %s' % p)
2716
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2717
ui.ui_factory.show_error(msg)
2718
raise errors.InvalidPattern('')
2719
for name_pattern in name_pattern_list:
2720
if (name_pattern[0] == '/' or
2721
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2722
raise errors.BzrCommandError(
2723
"NAME_PATTERN should not be an absolute path")
2724
tree, relpath = WorkingTree.open_containing(directory)
2725
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2726
ignored = globbing.Globster(name_pattern_list)
2728
self.add_cleanup(tree.lock_read().unlock)
2729
for entry in tree.list_files():
2733
if ignored.match(filename):
2734
matches.append(filename)
2735
if len(matches) > 0:
2736
self.outf.write("Warning: the following files are version controlled and"
2737
" match your ignore pattern:\n%s"
2738
"\nThese files will continue to be version controlled"
2739
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2742
class cmd_ignored(Command):
2743
__doc__ = """List ignored files and the patterns that matched them.
2745
List all the ignored files and the ignore pattern that caused the file to
2748
Alternatively, to list just the files::
2753
encoding_type = 'replace'
2754
_see_also = ['ignore', 'ls']
2755
takes_options = ['directory']
2758
def run(self, directory=u'.'):
2759
tree = WorkingTree.open_containing(directory)[0]
2760
self.add_cleanup(tree.lock_read().unlock)
2761
for path, file_class, kind, file_id, entry in tree.list_files():
2762
if file_class != 'I':
2764
## XXX: Slightly inefficient since this was already calculated
2765
pat = tree.is_ignored(path)
2766
self.outf.write('%-50s %s\n' % (path, pat))
2769
class cmd_lookup_revision(Command):
2770
__doc__ = """Lookup the revision-id from a revision-number
2773
bzr lookup-revision 33
2776
takes_args = ['revno']
2777
takes_options = ['directory']
2780
def run(self, revno, directory=u'.'):
2784
raise errors.BzrCommandError("not a valid revision-number: %r"
2786
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2787
self.outf.write("%s\n" % revid)
2790
class cmd_export(Command):
2791
__doc__ = """Export current or past revision to a destination directory or archive.
2793
If no revision is specified this exports the last committed revision.
2795
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2796
given, try to find the format with the extension. If no extension
2797
is found exports to a directory (equivalent to --format=dir).
2799
If root is supplied, it will be used as the root directory inside
2800
container formats (tar, zip, etc). If it is not supplied it will default
2801
to the exported filename. The root option has no effect for 'dir' format.
2803
If branch is omitted then the branch containing the current working
2804
directory will be used.
2806
Note: Export of tree with non-ASCII filenames to zip is not supported.
2808
================= =========================
2809
Supported formats Autodetected by extension
2810
================= =========================
2813
tbz2 .tar.bz2, .tbz2
2816
================= =========================
2818
takes_args = ['dest', 'branch_or_subdir?']
2819
takes_options = ['directory',
2821
help="Type of file to export to.",
2824
Option('filters', help='Apply content filters to export the '
2825
'convenient form.'),
2828
help="Name of the root directory inside the exported file."),
2829
Option('per-file-timestamps',
2830
help='Set modification time of files to that of the last '
2831
'revision in which it was changed.'),
2833
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2834
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2835
from bzrlib.export import export
2837
if branch_or_subdir is None:
2838
tree = WorkingTree.open_containing(directory)[0]
2842
b, subdir = Branch.open_containing(branch_or_subdir)
2845
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2847
export(rev_tree, dest, format, root, subdir, filtered=filters,
2848
per_file_timestamps=per_file_timestamps)
2849
except errors.NoSuchExportFormat, e:
2850
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2853
class cmd_cat(Command):
2854
__doc__ = """Write the contents of a file as of a given revision to standard output.
2856
If no revision is nominated, the last revision is used.
2858
Note: Take care to redirect standard output when using this command on a
2863
takes_options = ['directory',
2864
Option('name-from-revision', help='The path name in the old tree.'),
2865
Option('filters', help='Apply content filters to display the '
2866
'convenience form.'),
2869
takes_args = ['filename']
2870
encoding_type = 'exact'
2873
def run(self, filename, revision=None, name_from_revision=False,
2874
filters=False, directory=None):
2875
if revision is not None and len(revision) != 1:
2876
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2877
" one revision specifier")
2878
tree, branch, relpath = \
2879
_open_directory_or_containing_tree_or_branch(filename, directory)
2880
self.add_cleanup(branch.lock_read().unlock)
2881
return self._run(tree, branch, relpath, filename, revision,
2882
name_from_revision, filters)
2884
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2887
tree = b.basis_tree()
2888
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2889
self.add_cleanup(rev_tree.lock_read().unlock)
2891
old_file_id = rev_tree.path2id(relpath)
2893
if name_from_revision:
2894
# Try in revision if requested
2895
if old_file_id is None:
2896
raise errors.BzrCommandError(
2897
"%r is not present in revision %s" % (
2898
filename, rev_tree.get_revision_id()))
2900
content = rev_tree.get_file_text(old_file_id)
2902
cur_file_id = tree.path2id(relpath)
2904
if cur_file_id is not None:
2905
# Then try with the actual file id
2907
content = rev_tree.get_file_text(cur_file_id)
2909
except errors.NoSuchId:
2910
# The actual file id didn't exist at that time
2912
if not found and old_file_id is not None:
2913
# Finally try with the old file id
2914
content = rev_tree.get_file_text(old_file_id)
2917
# Can't be found anywhere
2918
raise errors.BzrCommandError(
2919
"%r is not present in revision %s" % (
2920
filename, rev_tree.get_revision_id()))
2922
from bzrlib.filters import (
2923
ContentFilterContext,
2924
filtered_output_bytes,
2926
filters = rev_tree._content_filter_stack(relpath)
2927
chunks = content.splitlines(True)
2928
content = filtered_output_bytes(chunks, filters,
2929
ContentFilterContext(relpath, rev_tree))
2931
self.outf.writelines(content)
2934
self.outf.write(content)
2937
class cmd_local_time_offset(Command):
2938
__doc__ = """Show the offset in seconds from GMT to local time."""
2942
self.outf.write("%s\n" % osutils.local_time_offset())
2946
class cmd_commit(Command):
2947
__doc__ = """Commit changes into a new revision.
2949
An explanatory message needs to be given for each commit. This is
2950
often done by using the --message option (getting the message from the
2951
command line) or by using the --file option (getting the message from
2952
a file). If neither of these options is given, an editor is opened for
2953
the user to enter the message. To see the changed files in the
2954
boilerplate text loaded into the editor, use the --show-diff option.
2956
By default, the entire tree is committed and the person doing the
2957
commit is assumed to be the author. These defaults can be overridden
2962
If selected files are specified, only changes to those files are
2963
committed. If a directory is specified then the directory and
2964
everything within it is committed.
2966
When excludes are given, they take precedence over selected files.
2967
For example, to commit only changes within foo, but not changes
2970
bzr commit foo -x foo/bar
2972
A selective commit after a merge is not yet supported.
2976
If the author of the change is not the same person as the committer,
2977
you can specify the author's name using the --author option. The
2978
name should be in the same format as a committer-id, e.g.
2979
"John Doe <jdoe@example.com>". If there is more than one author of
2980
the change you can specify the option multiple times, once for each
2985
A common mistake is to forget to add a new file or directory before
2986
running the commit command. The --strict option checks for unknown
2987
files and aborts the commit if any are found. More advanced pre-commit
2988
checks can be implemented by defining hooks. See ``bzr help hooks``
2993
If you accidentially commit the wrong changes or make a spelling
2994
mistake in the commit message say, you can use the uncommit command
2995
to undo it. See ``bzr help uncommit`` for details.
2997
Hooks can also be configured to run after a commit. This allows you
2998
to trigger updates to external systems like bug trackers. The --fixes
2999
option can be used to record the association between a revision and
3000
one or more bugs. See ``bzr help bugs`` for details.
3002
A selective commit may fail in some cases where the committed
3003
tree would be invalid. Consider::
3008
bzr commit foo -m "committing foo"
3009
bzr mv foo/bar foo/baz
3012
bzr commit foo/bar -m "committing bar but not baz"
3014
In the example above, the last commit will fail by design. This gives
3015
the user the opportunity to decide whether they want to commit the
3016
rename at the same time, separately first, or not at all. (As a general
3017
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3019
# TODO: Run hooks on tree to-be-committed, and after commit.
3021
# TODO: Strict commit that fails if there are deleted files.
3022
# (what does "deleted files" mean ??)
3024
# TODO: Give better message for -s, --summary, used by tla people
3026
# XXX: verbose currently does nothing
3028
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3029
takes_args = ['selected*']
3031
ListOption('exclude', type=str, short_name='x',
3032
help="Do not consider changes made to a given path."),
3033
Option('message', type=unicode,
3035
help="Description of the new revision."),
3038
help='Commit even if nothing has changed.'),
3039
Option('file', type=str,
3042
help='Take commit message from this file.'),
3044
help="Refuse to commit if there are unknown "
3045
"files in the working tree."),
3046
Option('commit-time', type=str,
3047
help="Manually set a commit time using commit date "
3048
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3049
ListOption('fixes', type=str,
3050
help="Mark a bug as being fixed by this revision "
3051
"(see \"bzr help bugs\")."),
3052
ListOption('author', type=unicode,
3053
help="Set the author's name, if it's different "
3054
"from the committer."),
3056
help="Perform a local commit in a bound "
3057
"branch. Local commits are not pushed to "
3058
"the master branch until a normal commit "
3061
Option('show-diff', short_name='p',
3062
help='When no message is supplied, show the diff along'
3063
' with the status summary in the message editor.'),
3065
aliases = ['ci', 'checkin']
3067
def _iter_bug_fix_urls(self, fixes, branch):
3068
# Configure the properties for bug fixing attributes.
3069
for fixed_bug in fixes:
3070
tokens = fixed_bug.split(':')
3071
if len(tokens) != 2:
3072
raise errors.BzrCommandError(
3073
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3074
"See \"bzr help bugs\" for more information on this "
3075
"feature.\nCommit refused." % fixed_bug)
3076
tag, bug_id = tokens
3078
yield bugtracker.get_bug_url(tag, branch, bug_id)
3079
except errors.UnknownBugTrackerAbbreviation:
3080
raise errors.BzrCommandError(
3081
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3082
except errors.MalformedBugIdentifier, e:
3083
raise errors.BzrCommandError(
3084
"%s\nCommit refused." % (str(e),))
3086
def run(self, message=None, file=None, verbose=False, selected_list=None,
3087
unchanged=False, strict=False, local=False, fixes=None,
3088
author=None, show_diff=False, exclude=None, commit_time=None):
3089
from bzrlib.errors import (
3094
from bzrlib.msgeditor import (
3095
edit_commit_message_encoded,
3096
generate_commit_message_template,
3097
make_commit_message_template_encoded
3100
commit_stamp = offset = None
3101
if commit_time is not None:
3103
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3104
except ValueError, e:
3105
raise errors.BzrCommandError(
3106
"Could not parse --commit-time: " + str(e))
3108
# TODO: Need a blackbox test for invoking the external editor; may be
3109
# slightly problematic to run this cross-platform.
3111
# TODO: do more checks that the commit will succeed before
3112
# spending the user's valuable time typing a commit message.
3116
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3117
if selected_list == ['']:
3118
# workaround - commit of root of tree should be exactly the same
3119
# as just default commit in that tree, and succeed even though
3120
# selected-file merge commit is not done yet
3125
bug_property = bugtracker.encode_fixes_bug_urls(
3126
self._iter_bug_fix_urls(fixes, tree.branch))
3128
properties['bugs'] = bug_property
3130
if local and not tree.branch.get_bound_location():
3131
raise errors.LocalRequiresBoundBranch()
3133
if message is not None:
3135
file_exists = osutils.lexists(message)
3136
except UnicodeError:
3137
# The commit message contains unicode characters that can't be
3138
# represented in the filesystem encoding, so that can't be a
3143
'The commit message is a file name: "%(f)s".\n'
3144
'(use --file "%(f)s" to take commit message from that file)'
3146
ui.ui_factory.show_warning(warning_msg)
3148
message = message.replace('\r\n', '\n')
3149
message = message.replace('\r', '\n')
3151
raise errors.BzrCommandError(
3152
"please specify either --message or --file")
3154
def get_message(commit_obj):
3155
"""Callback to get commit message"""
3159
my_message = f.read().decode(osutils.get_user_encoding())
3162
elif message is not None:
3163
my_message = message
3165
# No message supplied: make one up.
3166
# text is the status of the tree
3167
text = make_commit_message_template_encoded(tree,
3168
selected_list, diff=show_diff,
3169
output_encoding=osutils.get_user_encoding())
3170
# start_message is the template generated from hooks
3171
# XXX: Warning - looks like hooks return unicode,
3172
# make_commit_message_template_encoded returns user encoding.
3173
# We probably want to be using edit_commit_message instead to
3175
start_message = generate_commit_message_template(commit_obj)
3176
my_message = edit_commit_message_encoded(text,
3177
start_message=start_message)
3178
if my_message is None:
3179
raise errors.BzrCommandError("please specify a commit"
3180
" message with either --message or --file")
3181
if my_message == "":
3182
raise errors.BzrCommandError("empty commit message specified")
3185
# The API permits a commit with a filter of [] to mean 'select nothing'
3186
# but the command line should not do that.
3187
if not selected_list:
3188
selected_list = None
3190
tree.commit(message_callback=get_message,
3191
specific_files=selected_list,
3192
allow_pointless=unchanged, strict=strict, local=local,
3193
reporter=None, verbose=verbose, revprops=properties,
3194
authors=author, timestamp=commit_stamp,
3196
exclude=tree.safe_relpath_files(exclude))
3197
except PointlessCommit:
3198
raise errors.BzrCommandError("No changes to commit."
3199
" Use --unchanged to commit anyhow.")
3200
except ConflictsInTree:
3201
raise errors.BzrCommandError('Conflicts detected in working '
3202
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3204
except StrictCommitFailed:
3205
raise errors.BzrCommandError("Commit refused because there are"
3206
" unknown files in the working tree.")
3207
except errors.BoundBranchOutOfDate, e:
3208
e.extra_help = ("\n"
3209
'To commit to master branch, run update and then commit.\n'
3210
'You can also pass --local to commit to continue working '
3215
class cmd_check(Command):
3216
__doc__ = """Validate working tree structure, branch consistency and repository history.
3218
This command checks various invariants about branch and repository storage
3219
to detect data corruption or bzr bugs.
3221
The working tree and branch checks will only give output if a problem is
3222
detected. The output fields of the repository check are:
3225
This is just the number of revisions checked. It doesn't
3229
This is just the number of versionedfiles checked. It
3230
doesn't indicate a problem.
3232
unreferenced ancestors
3233
Texts that are ancestors of other texts, but
3234
are not properly referenced by the revision ancestry. This is a
3235
subtle problem that Bazaar can work around.
3238
This is the total number of unique file contents
3239
seen in the checked revisions. It does not indicate a problem.
3242
This is the total number of repeated texts seen
3243
in the checked revisions. Texts can be repeated when their file
3244
entries are modified, but the file contents are not. It does not
3247
If no restrictions are specified, all Bazaar data that is found at the given
3248
location will be checked.
3252
Check the tree and branch at 'foo'::
3254
bzr check --tree --branch foo
3256
Check only the repository at 'bar'::
3258
bzr check --repo bar
3260
Check everything at 'baz'::
3265
_see_also = ['reconcile']
3266
takes_args = ['path?']
3267
takes_options = ['verbose',
3268
Option('branch', help="Check the branch related to the"
3269
" current directory."),
3270
Option('repo', help="Check the repository related to the"
3271
" current directory."),
3272
Option('tree', help="Check the working tree related to"
3273
" the current directory.")]
3275
def run(self, path=None, verbose=False, branch=False, repo=False,
3277
from bzrlib.check import check_dwim
3280
if not branch and not repo and not tree:
3281
branch = repo = tree = True
3282
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3285
class cmd_upgrade(Command):
3286
__doc__ = """Upgrade branch storage to current format.
3288
The check command or bzr developers may sometimes advise you to run
3289
this command. When the default format has changed you may also be warned
3290
during other operations to upgrade.
3293
_see_also = ['check']
3294
takes_args = ['url?']
3296
RegistryOption('format',
3297
help='Upgrade to a specific format. See "bzr help'
3298
' formats" for details.',
3299
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3300
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3301
value_switches=True, title='Branch format'),
3304
def run(self, url='.', format=None):
3305
from bzrlib.upgrade import upgrade
3306
upgrade(url, format)
3309
class cmd_whoami(Command):
3310
__doc__ = """Show or set bzr user id.
3313
Show the email of the current user::
3317
Set the current user::
3319
bzr whoami "Frank Chu <fchu@example.com>"
3321
takes_options = [ 'directory',
3323
help='Display email address only.'),
3325
help='Set identity for the current branch instead of '
3328
takes_args = ['name?']
3329
encoding_type = 'replace'
3332
def run(self, email=False, branch=False, name=None, directory=None):
3334
if directory is None:
3335
# use branch if we're inside one; otherwise global config
3337
c = Branch.open_containing(u'.')[0].get_config()
3338
except errors.NotBranchError:
3339
c = _mod_config.GlobalConfig()
3341
c = Branch.open(directory).get_config()
3343
self.outf.write(c.user_email() + '\n')
3345
self.outf.write(c.username() + '\n')
3348
# display a warning if an email address isn't included in the given name.
3350
_mod_config.extract_email_address(name)
3351
except errors.NoEmailInUsername, e:
3352
warning('"%s" does not seem to contain an email address. '
3353
'This is allowed, but not recommended.', name)
3355
# use global config unless --branch given
3357
if directory is None:
3358
c = Branch.open_containing(u'.')[0].get_config()
3360
c = Branch.open(directory).get_config()
3362
c = _mod_config.GlobalConfig()
3363
c.set_user_option('email', name)
3366
class cmd_nick(Command):
3367
__doc__ = """Print or set the branch nickname.
3369
If unset, the tree root directory name is used as the nickname.
3370
To print the current nickname, execute with no argument.
3372
Bound branches use the nickname of its master branch unless it is set
3376
_see_also = ['info']
3377
takes_args = ['nickname?']
3378
takes_options = ['directory']
3379
def run(self, nickname=None, directory=u'.'):
3380
branch = Branch.open_containing(directory)[0]
3381
if nickname is None:
3382
self.printme(branch)
3384
branch.nick = nickname
3387
def printme(self, branch):
3388
self.outf.write('%s\n' % branch.nick)
3391
class cmd_alias(Command):
3392
__doc__ = """Set/unset and display aliases.
3395
Show the current aliases::
3399
Show the alias specified for 'll'::
3403
Set an alias for 'll'::
3405
bzr alias ll="log --line -r-10..-1"
3407
To remove an alias for 'll'::
3409
bzr alias --remove ll
3412
takes_args = ['name?']
3414
Option('remove', help='Remove the alias.'),
3417
def run(self, name=None, remove=False):
3419
self.remove_alias(name)
3421
self.print_aliases()
3423
equal_pos = name.find('=')
3425
self.print_alias(name)
3427
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3429
def remove_alias(self, alias_name):
3430
if alias_name is None:
3431
raise errors.BzrCommandError(
3432
'bzr alias --remove expects an alias to remove.')
3433
# If alias is not found, print something like:
3434
# unalias: foo: not found
3435
c = _mod_config.GlobalConfig()
3436
c.unset_alias(alias_name)
3439
def print_aliases(self):
3440
"""Print out the defined aliases in a similar format to bash."""
3441
aliases = _mod_config.GlobalConfig().get_aliases()
3442
for key, value in sorted(aliases.iteritems()):
3443
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3446
def print_alias(self, alias_name):
3447
from bzrlib.commands import get_alias
3448
alias = get_alias(alias_name)
3450
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3453
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3455
def set_alias(self, alias_name, alias_command):
3456
"""Save the alias in the global config."""
3457
c = _mod_config.GlobalConfig()
3458
c.set_alias(alias_name, alias_command)
3461
class cmd_selftest(Command):
3462
__doc__ = """Run internal test suite.
3464
If arguments are given, they are regular expressions that say which tests
3465
should run. Tests matching any expression are run, and other tests are
3468
Alternatively if --first is given, matching tests are run first and then
3469
all other tests are run. This is useful if you have been working in a
3470
particular area, but want to make sure nothing else was broken.
3472
If --exclude is given, tests that match that regular expression are
3473
excluded, regardless of whether they match --first or not.
3475
To help catch accidential dependencies between tests, the --randomize
3476
option is useful. In most cases, the argument used is the word 'now'.
3477
Note that the seed used for the random number generator is displayed
3478
when this option is used. The seed can be explicitly passed as the
3479
argument to this option if required. This enables reproduction of the
3480
actual ordering used if and when an order sensitive problem is encountered.
3482
If --list-only is given, the tests that would be run are listed. This is
3483
useful when combined with --first, --exclude and/or --randomize to
3484
understand their impact. The test harness reports "Listed nn tests in ..."
3485
instead of "Ran nn tests in ..." when list mode is enabled.
3487
If the global option '--no-plugins' is given, plugins are not loaded
3488
before running the selftests. This has two effects: features provided or
3489
modified by plugins will not be tested, and tests provided by plugins will
3492
Tests that need working space on disk use a common temporary directory,
3493
typically inside $TMPDIR or /tmp.
3495
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3496
into a pdb postmortem session.
3498
The --coverage=DIRNAME global option produces a report with covered code
3502
Run only tests relating to 'ignore'::
3506
Disable plugins and list tests as they're run::
3508
bzr --no-plugins selftest -v
3510
# NB: this is used from the class without creating an instance, which is
3511
# why it does not have a self parameter.
3512
def get_transport_type(typestring):
3513
"""Parse and return a transport specifier."""
3514
if typestring == "sftp":
3515
from bzrlib.tests import stub_sftp
3516
return stub_sftp.SFTPAbsoluteServer
3517
if typestring == "memory":
3518
from bzrlib.tests import test_server
3519
return memory.MemoryServer
3520
if typestring == "fakenfs":
3521
from bzrlib.tests import test_server
3522
return test_server.FakeNFSServer
3523
msg = "No known transport type %s. Supported types are: sftp\n" %\
3525
raise errors.BzrCommandError(msg)
3528
takes_args = ['testspecs*']
3529
takes_options = ['verbose',
3531
help='Stop when one test fails.',
3535
help='Use a different transport by default '
3536
'throughout the test suite.',
3537
type=get_transport_type),
3539
help='Run the benchmarks rather than selftests.',
3541
Option('lsprof-timed',
3542
help='Generate lsprof output for benchmarked'
3543
' sections of code.'),
3544
Option('lsprof-tests',
3545
help='Generate lsprof output for each test.'),
3547
help='Run all tests, but run specified tests first.',
3551
help='List the tests instead of running them.'),
3552
RegistryOption('parallel',
3553
help="Run the test suite in parallel.",
3554
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3555
value_switches=False,
3557
Option('randomize', type=str, argname="SEED",
3558
help='Randomize the order of tests using the given'
3559
' seed or "now" for the current time.'),
3560
Option('exclude', type=str, argname="PATTERN",
3562
help='Exclude tests that match this regular'
3565
help='Output test progress via subunit.'),
3566
Option('strict', help='Fail on missing dependencies or '
3568
Option('load-list', type=str, argname='TESTLISTFILE',
3569
help='Load a test id list from a text file.'),
3570
ListOption('debugflag', type=str, short_name='E',
3571
help='Turn on a selftest debug flag.'),
3572
ListOption('starting-with', type=str, argname='TESTID',
3573
param_name='starting_with', short_name='s',
3575
'Load only the tests starting with TESTID.'),
3577
encoding_type = 'replace'
3580
Command.__init__(self)
3581
self.additional_selftest_args = {}
3583
def run(self, testspecs_list=None, verbose=False, one=False,
3584
transport=None, benchmark=None,
3586
first=False, list_only=False,
3587
randomize=None, exclude=None, strict=False,
3588
load_list=None, debugflag=None, starting_with=None, subunit=False,
3589
parallel=None, lsprof_tests=False):
3590
from bzrlib import tests
3592
if testspecs_list is not None:
3593
pattern = '|'.join(testspecs_list)
3598
from bzrlib.tests import SubUnitBzrRunner
3600
raise errors.BzrCommandError("subunit not available. subunit "
3601
"needs to be installed to use --subunit.")
3602
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3603
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3604
# stdout, which would corrupt the subunit stream.
3605
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3606
# following code can be deleted when it's sufficiently deployed
3607
# -- vila/mgz 20100514
3608
if (sys.platform == "win32"
3609
and getattr(sys.stdout, 'fileno', None) is not None):
3611
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3613
self.additional_selftest_args.setdefault(
3614
'suite_decorators', []).append(parallel)
3616
raise errors.BzrCommandError(
3617
"--benchmark is no longer supported from bzr 2.2; "
3618
"use bzr-usertest instead")
3619
test_suite_factory = None
3620
selftest_kwargs = {"verbose": verbose,
3622
"stop_on_failure": one,
3623
"transport": transport,
3624
"test_suite_factory": test_suite_factory,
3625
"lsprof_timed": lsprof_timed,
3626
"lsprof_tests": lsprof_tests,
3627
"matching_tests_first": first,
3628
"list_only": list_only,
3629
"random_seed": randomize,
3630
"exclude_pattern": exclude,
3632
"load_list": load_list,
3633
"debug_flags": debugflag,
3634
"starting_with": starting_with
3636
selftest_kwargs.update(self.additional_selftest_args)
3638
# Make deprecation warnings visible, unless -Werror is set
3639
cleanup = symbol_versioning.activate_deprecation_warnings(
3642
result = tests.selftest(**selftest_kwargs)
3645
return int(not result)
3648
class cmd_version(Command):
3649
__doc__ = """Show version of bzr."""
3651
encoding_type = 'replace'
3653
Option("short", help="Print just the version number."),
3657
def run(self, short=False):
3658
from bzrlib.version import show_version
3660
self.outf.write(bzrlib.version_string + '\n')
3662
show_version(to_file=self.outf)
3665
class cmd_rocks(Command):
3666
__doc__ = """Statement of optimism."""
3672
self.outf.write("It sure does!\n")
3675
class cmd_find_merge_base(Command):
3676
__doc__ = """Find and print a base revision for merging two branches."""
3677
# TODO: Options to specify revisions on either side, as if
3678
# merging only part of the history.
3679
takes_args = ['branch', 'other']
3683
def run(self, branch, other):
3684
from bzrlib.revision import ensure_null
3686
branch1 = Branch.open_containing(branch)[0]
3687
branch2 = Branch.open_containing(other)[0]
3688
self.add_cleanup(branch1.lock_read().unlock)
3689
self.add_cleanup(branch2.lock_read().unlock)
3690
last1 = ensure_null(branch1.last_revision())
3691
last2 = ensure_null(branch2.last_revision())
3693
graph = branch1.repository.get_graph(branch2.repository)
3694
base_rev_id = graph.find_unique_lca(last1, last2)
3696
self.outf.write('merge base is revision %s\n' % base_rev_id)
3699
class cmd_merge(Command):
3700
__doc__ = """Perform a three-way merge.
3702
The source of the merge can be specified either in the form of a branch,
3703
or in the form of a path to a file containing a merge directive generated
3704
with bzr send. If neither is specified, the default is the upstream branch
3705
or the branch most recently merged using --remember.
3707
When merging a branch, by default the tip will be merged. To pick a different
3708
revision, pass --revision. If you specify two values, the first will be used as
3709
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3710
available revisions, like this is commonly referred to as "cherrypicking".
3712
Revision numbers are always relative to the branch being merged.
3714
By default, bzr will try to merge in all new work from the other
3715
branch, automatically determining an appropriate base. If this
3716
fails, you may need to give an explicit base.
3718
Merge will do its best to combine the changes in two branches, but there
3719
are some kinds of problems only a human can fix. When it encounters those,
3720
it will mark a conflict. A conflict means that you need to fix something,
3721
before you should commit.
3723
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3725
If there is no default branch set, the first merge will set it. After
3726
that, you can omit the branch to use the default. To change the
3727
default, use --remember. The value will only be saved if the remote
3728
location can be accessed.
3730
The results of the merge are placed into the destination working
3731
directory, where they can be reviewed (with bzr diff), tested, and then
3732
committed to record the result of the merge.
3734
merge refuses to run if there are any uncommitted changes, unless
3735
--force is given. The --force option can also be used to create a
3736
merge revision which has more than two parents.
3738
If one would like to merge changes from the working tree of the other
3739
branch without merging any committed revisions, the --uncommitted option
3742
To select only some changes to merge, use "merge -i", which will prompt
3743
you to apply each diff hunk and file change, similar to "shelve".
3746
To merge the latest revision from bzr.dev::
3748
bzr merge ../bzr.dev
3750
To merge changes up to and including revision 82 from bzr.dev::
3752
bzr merge -r 82 ../bzr.dev
3754
To merge the changes introduced by 82, without previous changes::
3756
bzr merge -r 81..82 ../bzr.dev
3758
To apply a merge directive contained in /tmp/merge::
3760
bzr merge /tmp/merge
3762
To create a merge revision with three parents from two branches
3763
feature1a and feature1b:
3765
bzr merge ../feature1a
3766
bzr merge ../feature1b --force
3767
bzr commit -m 'revision with three parents'
3770
encoding_type = 'exact'
3771
_see_also = ['update', 'remerge', 'status-flags', 'send']
3772
takes_args = ['location?']
3777
help='Merge even if the destination tree has uncommitted changes.'),
3781
Option('show-base', help="Show base revision text in "
3783
Option('uncommitted', help='Apply uncommitted changes'
3784
' from a working copy, instead of branch changes.'),
3785
Option('pull', help='If the destination is already'
3786
' completely merged into the source, pull from the'
3787
' source rather than merging. When this happens,'
3788
' you do not need to commit the result.'),
3789
custom_help('directory',
3790
help='Branch to merge into, '
3791
'rather than the one containing the working directory.'),
3792
Option('preview', help='Instead of merging, show a diff of the'
3794
Option('interactive', help='Select changes interactively.',
3798
def run(self, location=None, revision=None, force=False,
3799
merge_type=None, show_base=False, reprocess=None, remember=False,
3800
uncommitted=False, pull=False,
3805
if merge_type is None:
3806
merge_type = _mod_merge.Merge3Merger
3808
if directory is None: directory = u'.'
3809
possible_transports = []
3811
allow_pending = True
3812
verified = 'inapplicable'
3813
tree = WorkingTree.open_containing(directory)[0]
3816
basis_tree = tree.revision_tree(tree.last_revision())
3817
except errors.NoSuchRevision:
3818
basis_tree = tree.basis_tree()
3820
# die as quickly as possible if there are uncommitted changes
3822
if tree.has_changes():
3823
raise errors.UncommittedChanges(tree)
3825
view_info = _get_view_info_for_change_reporter(tree)
3826
change_reporter = delta._ChangeReporter(
3827
unversioned_filter=tree.is_ignored, view_info=view_info)
3828
pb = ui.ui_factory.nested_progress_bar()
3829
self.add_cleanup(pb.finished)
3830
self.add_cleanup(tree.lock_write().unlock)
3831
if location is not None:
3833
mergeable = bundle.read_mergeable_from_url(location,
3834
possible_transports=possible_transports)
3835
except errors.NotABundle:
3839
raise errors.BzrCommandError('Cannot use --uncommitted'
3840
' with bundles or merge directives.')
3842
if revision is not None:
3843
raise errors.BzrCommandError(
3844
'Cannot use -r with merge directives or bundles')
3845
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3848
if merger is None and uncommitted:
3849
if revision is not None and len(revision) > 0:
3850
raise errors.BzrCommandError('Cannot use --uncommitted and'
3851
' --revision at the same time.')
3852
merger = self.get_merger_from_uncommitted(tree, location, None)
3853
allow_pending = False
3856
merger, allow_pending = self._get_merger_from_branch(tree,
3857
location, revision, remember, possible_transports, None)
3859
merger.merge_type = merge_type
3860
merger.reprocess = reprocess
3861
merger.show_base = show_base
3862
self.sanity_check_merger(merger)
3863
if (merger.base_rev_id == merger.other_rev_id and
3864
merger.other_rev_id is not None):
3865
note('Nothing to do.')
3868
if merger.interesting_files is not None:
3869
raise errors.BzrCommandError('Cannot pull individual files')
3870
if (merger.base_rev_id == tree.last_revision()):
3871
result = tree.pull(merger.other_branch, False,
3872
merger.other_rev_id)
3873
result.report(self.outf)
3875
if merger.this_basis is None:
3876
raise errors.BzrCommandError(
3877
"This branch has no commits."
3878
" (perhaps you would prefer 'bzr pull')")
3880
return self._do_preview(merger)
3882
return self._do_interactive(merger)
3884
return self._do_merge(merger, change_reporter, allow_pending,
3887
def _get_preview(self, merger):
3888
tree_merger = merger.make_merger()
3889
tt = tree_merger.make_preview_transform()
3890
self.add_cleanup(tt.finalize)
3891
result_tree = tt.get_preview_tree()
3894
def _do_preview(self, merger):
3895
from bzrlib.diff import show_diff_trees
3896
result_tree = self._get_preview(merger)
3897
path_encoding = osutils.get_diff_header_encoding()
3898
show_diff_trees(merger.this_tree, result_tree, self.outf,
3899
old_label='', new_label='',
3900
path_encoding=path_encoding)
3902
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3903
merger.change_reporter = change_reporter
3904
conflict_count = merger.do_merge()
3906
merger.set_pending()
3907
if verified == 'failed':
3908
warning('Preview patch does not match changes')
3909
if conflict_count != 0:
3914
def _do_interactive(self, merger):
3915
"""Perform an interactive merge.
3917
This works by generating a preview tree of the merge, then using
3918
Shelver to selectively remove the differences between the working tree
3919
and the preview tree.
3921
from bzrlib import shelf_ui
3922
result_tree = self._get_preview(merger)
3923
writer = bzrlib.option.diff_writer_registry.get()
3924
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3925
reporter=shelf_ui.ApplyReporter(),
3926
diff_writer=writer(sys.stdout))
3932
def sanity_check_merger(self, merger):
3933
if (merger.show_base and
3934
not merger.merge_type is _mod_merge.Merge3Merger):
3935
raise errors.BzrCommandError("Show-base is not supported for this"
3936
" merge type. %s" % merger.merge_type)
3937
if merger.reprocess is None:
3938
if merger.show_base:
3939
merger.reprocess = False
3941
# Use reprocess if the merger supports it
3942
merger.reprocess = merger.merge_type.supports_reprocess
3943
if merger.reprocess and not merger.merge_type.supports_reprocess:
3944
raise errors.BzrCommandError("Conflict reduction is not supported"
3945
" for merge type %s." %
3947
if merger.reprocess and merger.show_base:
3948
raise errors.BzrCommandError("Cannot do conflict reduction and"
3951
def _get_merger_from_branch(self, tree, location, revision, remember,
3952
possible_transports, pb):
3953
"""Produce a merger from a location, assuming it refers to a branch."""
3954
from bzrlib.tag import _merge_tags_if_possible
3955
# find the branch locations
3956
other_loc, user_location = self._select_branch_location(tree, location,
3958
if revision is not None and len(revision) == 2:
3959
base_loc, _unused = self._select_branch_location(tree,
3960
location, revision, 0)
3962
base_loc = other_loc
3964
other_branch, other_path = Branch.open_containing(other_loc,
3965
possible_transports)
3966
if base_loc == other_loc:
3967
base_branch = other_branch
3969
base_branch, base_path = Branch.open_containing(base_loc,
3970
possible_transports)
3971
# Find the revision ids
3972
other_revision_id = None
3973
base_revision_id = None
3974
if revision is not None:
3975
if len(revision) >= 1:
3976
other_revision_id = revision[-1].as_revision_id(other_branch)
3977
if len(revision) == 2:
3978
base_revision_id = revision[0].as_revision_id(base_branch)
3979
if other_revision_id is None:
3980
other_revision_id = _mod_revision.ensure_null(
3981
other_branch.last_revision())
3982
# Remember where we merge from
3983
if ((remember or tree.branch.get_submit_branch() is None) and
3984
user_location is not None):
3985
tree.branch.set_submit_branch(other_branch.base)
3986
_merge_tags_if_possible(other_branch, tree.branch)
3987
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3988
other_revision_id, base_revision_id, other_branch, base_branch)
3989
if other_path != '':
3990
allow_pending = False
3991
merger.interesting_files = [other_path]
3993
allow_pending = True
3994
return merger, allow_pending
3996
def get_merger_from_uncommitted(self, tree, location, pb):
3997
"""Get a merger for uncommitted changes.
3999
:param tree: The tree the merger should apply to.
4000
:param location: The location containing uncommitted changes.
4001
:param pb: The progress bar to use for showing progress.
4003
location = self._select_branch_location(tree, location)[0]
4004
other_tree, other_path = WorkingTree.open_containing(location)
4005
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4006
if other_path != '':
4007
merger.interesting_files = [other_path]
4010
def _select_branch_location(self, tree, user_location, revision=None,
4012
"""Select a branch location, according to possible inputs.
4014
If provided, branches from ``revision`` are preferred. (Both
4015
``revision`` and ``index`` must be supplied.)
4017
Otherwise, the ``location`` parameter is used. If it is None, then the
4018
``submit`` or ``parent`` location is used, and a note is printed.
4020
:param tree: The working tree to select a branch for merging into
4021
:param location: The location entered by the user
4022
:param revision: The revision parameter to the command
4023
:param index: The index to use for the revision parameter. Negative
4024
indices are permitted.
4025
:return: (selected_location, user_location). The default location
4026
will be the user-entered location.
4028
if (revision is not None and index is not None
4029
and revision[index] is not None):
4030
branch = revision[index].get_branch()
4031
if branch is not None:
4032
return branch, branch
4033
if user_location is None:
4034
location = self._get_remembered(tree, 'Merging from')
4036
location = user_location
4037
return location, user_location
4039
def _get_remembered(self, tree, verb_string):
4040
"""Use tree.branch's parent if none was supplied.
4042
Report if the remembered location was used.
4044
stored_location = tree.branch.get_submit_branch()
4045
stored_location_type = "submit"
4046
if stored_location is None:
4047
stored_location = tree.branch.get_parent()
4048
stored_location_type = "parent"
4049
mutter("%s", stored_location)
4050
if stored_location is None:
4051
raise errors.BzrCommandError("No location specified or remembered")
4052
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4053
note(u"%s remembered %s location %s", verb_string,
4054
stored_location_type, display_url)
4055
return stored_location
4058
class cmd_remerge(Command):
4059
__doc__ = """Redo a merge.
4061
Use this if you want to try a different merge technique while resolving
4062
conflicts. Some merge techniques are better than others, and remerge
4063
lets you try different ones on different files.
4065
The options for remerge have the same meaning and defaults as the ones for
4066
merge. The difference is that remerge can (only) be run when there is a
4067
pending merge, and it lets you specify particular files.
4070
Re-do the merge of all conflicted files, and show the base text in
4071
conflict regions, in addition to the usual THIS and OTHER texts::
4073
bzr remerge --show-base
4075
Re-do the merge of "foobar", using the weave merge algorithm, with
4076
additional processing to reduce the size of conflict regions::
4078
bzr remerge --merge-type weave --reprocess foobar
4080
takes_args = ['file*']
4085
help="Show base revision text in conflicts."),
4088
def run(self, file_list=None, merge_type=None, show_base=False,
4090
from bzrlib.conflicts import restore
4091
if merge_type is None:
4092
merge_type = _mod_merge.Merge3Merger
4093
tree, file_list = WorkingTree.open_containing_paths(file_list)
4094
self.add_cleanup(tree.lock_write().unlock)
4095
parents = tree.get_parent_ids()
4096
if len(parents) != 2:
4097
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4098
" merges. Not cherrypicking or"
4100
repository = tree.branch.repository
4101
interesting_ids = None
4103
conflicts = tree.conflicts()
4104
if file_list is not None:
4105
interesting_ids = set()
4106
for filename in file_list:
4107
file_id = tree.path2id(filename)
4109
raise errors.NotVersionedError(filename)
4110
interesting_ids.add(file_id)
4111
if tree.kind(file_id) != "directory":
4114
for name, ie in tree.inventory.iter_entries(file_id):
4115
interesting_ids.add(ie.file_id)
4116
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4118
# Remerge only supports resolving contents conflicts
4119
allowed_conflicts = ('text conflict', 'contents conflict')
4120
restore_files = [c.path for c in conflicts
4121
if c.typestring in allowed_conflicts]
4122
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4123
tree.set_conflicts(ConflictList(new_conflicts))
4124
if file_list is not None:
4125
restore_files = file_list
4126
for filename in restore_files:
4128
restore(tree.abspath(filename))
4129
except errors.NotConflicted:
4131
# Disable pending merges, because the file texts we are remerging
4132
# have not had those merges performed. If we use the wrong parents
4133
# list, we imply that the working tree text has seen and rejected
4134
# all the changes from the other tree, when in fact those changes
4135
# have not yet been seen.
4136
tree.set_parent_ids(parents[:1])
4138
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4139
merger.interesting_ids = interesting_ids
4140
merger.merge_type = merge_type
4141
merger.show_base = show_base
4142
merger.reprocess = reprocess
4143
conflicts = merger.do_merge()
4145
tree.set_parent_ids(parents)
4152
class cmd_revert(Command):
4153
__doc__ = """Revert files to a previous revision.
4155
Giving a list of files will revert only those files. Otherwise, all files
4156
will be reverted. If the revision is not specified with '--revision', the
4157
last committed revision is used.
4159
To remove only some changes, without reverting to a prior version, use
4160
merge instead. For example, "merge . --revision -2..-3" will remove the
4161
changes introduced by -2, without affecting the changes introduced by -1.
4162
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4164
By default, any files that have been manually changed will be backed up
4165
first. (Files changed only by merge are not backed up.) Backup files have
4166
'.~#~' appended to their name, where # is a number.
4168
When you provide files, you can use their current pathname or the pathname
4169
from the target revision. So you can use revert to "undelete" a file by
4170
name. If you name a directory, all the contents of that directory will be
4173
If you have newly added files since the target revision, they will be
4174
removed. If the files to be removed have been changed, backups will be
4175
created as above. Directories containing unknown files will not be
4178
The working tree contains a list of revisions that have been merged but
4179
not yet committed. These revisions will be included as additional parents
4180
of the next commit. Normally, using revert clears that list as well as
4181
reverting the files. If any files are specified, revert leaves the list
4182
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4183
.`` in the tree root to revert all files but keep the recorded merges,
4184
and ``bzr revert --forget-merges`` to clear the pending merge list without
4185
reverting any files.
4187
Using "bzr revert --forget-merges", it is possible to apply all of the
4188
changes from a branch in a single revision. To do this, perform the merge
4189
as desired. Then doing revert with the "--forget-merges" option will keep
4190
the content of the tree as it was, but it will clear the list of pending
4191
merges. The next commit will then contain all of the changes that are
4192
present in the other branch, but without any other parent revisions.
4193
Because this technique forgets where these changes originated, it may
4194
cause additional conflicts on later merges involving the same source and
4198
_see_also = ['cat', 'export']
4201
Option('no-backup', "Do not save backups of reverted files."),
4202
Option('forget-merges',
4203
'Remove pending merge marker, without changing any files.'),
4205
takes_args = ['file*']
4207
def run(self, revision=None, no_backup=False, file_list=None,
4208
forget_merges=None):
4209
tree, file_list = WorkingTree.open_containing_paths(file_list)
4210
self.add_cleanup(tree.lock_tree_write().unlock)
4212
tree.set_parent_ids(tree.get_parent_ids()[:1])
4214
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4217
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4218
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4219
tree.revert(file_list, rev_tree, not no_backup, None,
4220
report_changes=True)
4223
class cmd_assert_fail(Command):
4224
__doc__ = """Test reporting of assertion failures"""
4225
# intended just for use in testing
4230
raise AssertionError("always fails")
4233
class cmd_help(Command):
4234
__doc__ = """Show help on a command or other topic.
4237
_see_also = ['topics']
4239
Option('long', 'Show help on all commands.'),
4241
takes_args = ['topic?']
4242
aliases = ['?', '--help', '-?', '-h']
4245
def run(self, topic=None, long=False):
4247
if topic is None and long:
4249
bzrlib.help.help(topic)
4252
class cmd_shell_complete(Command):
4253
__doc__ = """Show appropriate completions for context.
4255
For a list of all available commands, say 'bzr shell-complete'.
4257
takes_args = ['context?']
4262
def run(self, context=None):
4263
import shellcomplete
4264
shellcomplete.shellcomplete(context)
4267
class cmd_missing(Command):
4268
__doc__ = """Show unmerged/unpulled revisions between two branches.
4270
OTHER_BRANCH may be local or remote.
4272
To filter on a range of revisions, you can use the command -r begin..end
4273
-r revision requests a specific revision, -r ..end or -r begin.. are
4277
1 - some missing revisions
4278
0 - no missing revisions
4282
Determine the missing revisions between this and the branch at the
4283
remembered pull location::
4287
Determine the missing revisions between this and another branch::
4289
bzr missing http://server/branch
4291
Determine the missing revisions up to a specific revision on the other
4294
bzr missing -r ..-10
4296
Determine the missing revisions up to a specific revision on this
4299
bzr missing --my-revision ..-10
4302
_see_also = ['merge', 'pull']
4303
takes_args = ['other_branch?']
4306
Option('reverse', 'Reverse the order of revisions.'),
4308
'Display changes in the local branch only.'),
4309
Option('this' , 'Same as --mine-only.'),
4310
Option('theirs-only',
4311
'Display changes in the remote branch only.'),
4312
Option('other', 'Same as --theirs-only.'),
4316
custom_help('revision',
4317
help='Filter on other branch revisions (inclusive). '
4318
'See "help revisionspec" for details.'),
4319
Option('my-revision',
4320
type=_parse_revision_str,
4321
help='Filter on local branch revisions (inclusive). '
4322
'See "help revisionspec" for details.'),
4323
Option('include-merges',
4324
'Show all revisions in addition to the mainline ones.'),
4326
encoding_type = 'replace'
4329
def run(self, other_branch=None, reverse=False, mine_only=False,
4331
log_format=None, long=False, short=False, line=False,
4332
show_ids=False, verbose=False, this=False, other=False,
4333
include_merges=False, revision=None, my_revision=None,
4335
from bzrlib.missing import find_unmerged, iter_log_revisions
4344
# TODO: We should probably check that we don't have mine-only and
4345
# theirs-only set, but it gets complicated because we also have
4346
# this and other which could be used.
4353
local_branch = Branch.open_containing(directory)[0]
4354
self.add_cleanup(local_branch.lock_read().unlock)
4356
parent = local_branch.get_parent()
4357
if other_branch is None:
4358
other_branch = parent
4359
if other_branch is None:
4360
raise errors.BzrCommandError("No peer location known"
4362
display_url = urlutils.unescape_for_display(parent,
4364
message("Using saved parent location: "
4365
+ display_url + "\n")
4367
remote_branch = Branch.open(other_branch)
4368
if remote_branch.base == local_branch.base:
4369
remote_branch = local_branch
4371
self.add_cleanup(remote_branch.lock_read().unlock)
4373
local_revid_range = _revision_range_to_revid_range(
4374
_get_revision_range(my_revision, local_branch,
4377
remote_revid_range = _revision_range_to_revid_range(
4378
_get_revision_range(revision,
4379
remote_branch, self.name()))
4381
local_extra, remote_extra = find_unmerged(
4382
local_branch, remote_branch, restrict,
4383
backward=not reverse,
4384
include_merges=include_merges,
4385
local_revid_range=local_revid_range,
4386
remote_revid_range=remote_revid_range)
4388
if log_format is None:
4389
registry = log.log_formatter_registry
4390
log_format = registry.get_default(local_branch)
4391
lf = log_format(to_file=self.outf,
4393
show_timezone='original')
4396
if local_extra and not theirs_only:
4397
message("You have %d extra revision(s):\n" %
4399
for revision in iter_log_revisions(local_extra,
4400
local_branch.repository,
4402
lf.log_revision(revision)
4403
printed_local = True
4406
printed_local = False
4408
if remote_extra and not mine_only:
4409
if printed_local is True:
4411
message("You are missing %d revision(s):\n" %
4413
for revision in iter_log_revisions(remote_extra,
4414
remote_branch.repository,
4416
lf.log_revision(revision)
4419
if mine_only and not local_extra:
4420
# We checked local, and found nothing extra
4421
message('This branch is up to date.\n')
4422
elif theirs_only and not remote_extra:
4423
# We checked remote, and found nothing extra
4424
message('Other branch is up to date.\n')
4425
elif not (mine_only or theirs_only or local_extra or
4427
# We checked both branches, and neither one had extra
4429
message("Branches are up to date.\n")
4431
if not status_code and parent is None and other_branch is not None:
4432
self.add_cleanup(local_branch.lock_write().unlock)
4433
# handle race conditions - a parent might be set while we run.
4434
if local_branch.get_parent() is None:
4435
local_branch.set_parent(remote_branch.base)
4439
class cmd_pack(Command):
4440
__doc__ = """Compress the data within a repository.
4442
This operation compresses the data within a bazaar repository. As
4443
bazaar supports automatic packing of repository, this operation is
4444
normally not required to be done manually.
4446
During the pack operation, bazaar takes a backup of existing repository
4447
data, i.e. pack files. This backup is eventually removed by bazaar
4448
automatically when it is safe to do so. To save disk space by removing
4449
the backed up pack files, the --clean-obsolete-packs option may be
4452
Warning: If you use --clean-obsolete-packs and your machine crashes
4453
during or immediately after repacking, you may be left with a state
4454
where the deletion has been written to disk but the new packs have not
4455
been. In this case the repository may be unusable.
4458
_see_also = ['repositories']
4459
takes_args = ['branch_or_repo?']
4461
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4464
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4465
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4467
branch = dir.open_branch()
4468
repository = branch.repository
4469
except errors.NotBranchError:
4470
repository = dir.open_repository()
4471
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4474
class cmd_plugins(Command):
4475
__doc__ = """List the installed plugins.
4477
This command displays the list of installed plugins including
4478
version of plugin and a short description of each.
4480
--verbose shows the path where each plugin is located.
4482
A plugin is an external component for Bazaar that extends the
4483
revision control system, by adding or replacing code in Bazaar.
4484
Plugins can do a variety of things, including overriding commands,
4485
adding new commands, providing additional network transports and
4486
customizing log output.
4488
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4489
for further information on plugins including where to find them and how to
4490
install them. Instructions are also provided there on how to write new
4491
plugins using the Python programming language.
4493
takes_options = ['verbose']
4496
def run(self, verbose=False):
4497
import bzrlib.plugin
4498
from inspect import getdoc
4500
for name, plugin in bzrlib.plugin.plugins().items():
4501
version = plugin.__version__
4502
if version == 'unknown':
4504
name_ver = '%s %s' % (name, version)
4505
d = getdoc(plugin.module)
4507
doc = d.split('\n')[0]
4509
doc = '(no description)'
4510
result.append((name_ver, doc, plugin.path()))
4511
for name_ver, doc, path in sorted(result):
4512
self.outf.write("%s\n" % name_ver)
4513
self.outf.write(" %s\n" % doc)
4515
self.outf.write(" %s\n" % path)
4516
self.outf.write("\n")
4519
class cmd_testament(Command):
4520
__doc__ = """Show testament (signing-form) of a revision."""
4523
Option('long', help='Produce long-format testament.'),
4525
help='Produce a strict-format testament.')]
4526
takes_args = ['branch?']
4528
def run(self, branch=u'.', revision=None, long=False, strict=False):
4529
from bzrlib.testament import Testament, StrictTestament
4531
testament_class = StrictTestament
4533
testament_class = Testament
4535
b = Branch.open_containing(branch)[0]
4537
b = Branch.open(branch)
4538
self.add_cleanup(b.lock_read().unlock)
4539
if revision is None:
4540
rev_id = b.last_revision()
4542
rev_id = revision[0].as_revision_id(b)
4543
t = testament_class.from_revision(b.repository, rev_id)
4545
sys.stdout.writelines(t.as_text_lines())
4547
sys.stdout.write(t.as_short_text())
4550
class cmd_annotate(Command):
4551
__doc__ = """Show the origin of each line in a file.
4553
This prints out the given file with an annotation on the left side
4554
indicating which revision, author and date introduced the change.
4556
If the origin is the same for a run of consecutive lines, it is
4557
shown only at the top, unless the --all option is given.
4559
# TODO: annotate directories; showing when each file was last changed
4560
# TODO: if the working copy is modified, show annotations on that
4561
# with new uncommitted lines marked
4562
aliases = ['ann', 'blame', 'praise']
4563
takes_args = ['filename']
4564
takes_options = [Option('all', help='Show annotations on all lines.'),
4565
Option('long', help='Show commit date in annotations.'),
4570
encoding_type = 'exact'
4573
def run(self, filename, all=False, long=False, revision=None,
4574
show_ids=False, directory=None):
4575
from bzrlib.annotate import annotate_file, annotate_file_tree
4576
wt, branch, relpath = \
4577
_open_directory_or_containing_tree_or_branch(filename, directory)
4579
self.add_cleanup(wt.lock_read().unlock)
4581
self.add_cleanup(branch.lock_read().unlock)
4582
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4583
self.add_cleanup(tree.lock_read().unlock)
4585
file_id = wt.path2id(relpath)
4587
file_id = tree.path2id(relpath)
4589
raise errors.NotVersionedError(filename)
4590
file_version = tree.inventory[file_id].revision
4591
if wt is not None and revision is None:
4592
# If there is a tree and we're not annotating historical
4593
# versions, annotate the working tree's content.
4594
annotate_file_tree(wt, file_id, self.outf, long, all,
4597
annotate_file(branch, file_version, file_id, long, all, self.outf,
4601
class cmd_re_sign(Command):
4602
__doc__ = """Create a digital signature for an existing revision."""
4603
# TODO be able to replace existing ones.
4605
hidden = True # is this right ?
4606
takes_args = ['revision_id*']
4607
takes_options = ['directory', 'revision']
4609
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4610
if revision_id_list is not None and revision is not None:
4611
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4612
if revision_id_list is None and revision is None:
4613
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4614
b = WorkingTree.open_containing(directory)[0].branch
4615
self.add_cleanup(b.lock_write().unlock)
4616
return self._run(b, revision_id_list, revision)
4618
def _run(self, b, revision_id_list, revision):
4619
import bzrlib.gpg as gpg
4620
gpg_strategy = gpg.GPGStrategy(b.get_config())
4621
if revision_id_list is not None:
4622
b.repository.start_write_group()
4624
for revision_id in revision_id_list:
4625
b.repository.sign_revision(revision_id, gpg_strategy)
4627
b.repository.abort_write_group()
4630
b.repository.commit_write_group()
4631
elif revision is not None:
4632
if len(revision) == 1:
4633
revno, rev_id = revision[0].in_history(b)
4634
b.repository.start_write_group()
4636
b.repository.sign_revision(rev_id, gpg_strategy)
4638
b.repository.abort_write_group()
4641
b.repository.commit_write_group()
4642
elif len(revision) == 2:
4643
# are they both on rh- if so we can walk between them
4644
# might be nice to have a range helper for arbitrary
4645
# revision paths. hmm.
4646
from_revno, from_revid = revision[0].in_history(b)
4647
to_revno, to_revid = revision[1].in_history(b)
4648
if to_revid is None:
4649
to_revno = b.revno()
4650
if from_revno is None or to_revno is None:
4651
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4652
b.repository.start_write_group()
4654
for revno in range(from_revno, to_revno + 1):
4655
b.repository.sign_revision(b.get_rev_id(revno),
4658
b.repository.abort_write_group()
4661
b.repository.commit_write_group()
4663
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4666
class cmd_bind(Command):
4667
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4668
If no branch is supplied, rebind to the last bound location.
4670
Once converted into a checkout, commits must succeed on the master branch
4671
before they will be applied to the local branch.
4673
Bound branches use the nickname of its master branch unless it is set
4674
locally, in which case binding will update the local nickname to be
4678
_see_also = ['checkouts', 'unbind']
4679
takes_args = ['location?']
4680
takes_options = ['directory']
4682
def run(self, location=None, directory=u'.'):
4683
b, relpath = Branch.open_containing(directory)
4684
if location is None:
4686
location = b.get_old_bound_location()
4687
except errors.UpgradeRequired:
4688
raise errors.BzrCommandError('No location supplied. '
4689
'This format does not remember old locations.')
4691
if location is None:
4692
if b.get_bound_location() is not None:
4693
raise errors.BzrCommandError('Branch is already bound')
4695
raise errors.BzrCommandError('No location supplied '
4696
'and no previous location known')
4697
b_other = Branch.open(location)
4700
except errors.DivergedBranches:
4701
raise errors.BzrCommandError('These branches have diverged.'
4702
' Try merging, and then bind again.')
4703
if b.get_config().has_explicit_nickname():
4704
b.nick = b_other.nick
4707
class cmd_unbind(Command):
4708
__doc__ = """Convert the current checkout into a regular branch.
4710
After unbinding, the local branch is considered independent and subsequent
4711
commits will be local only.
4714
_see_also = ['checkouts', 'bind']
4716
takes_options = ['directory']
4718
def run(self, directory=u'.'):
4719
b, relpath = Branch.open_containing(directory)
4721
raise errors.BzrCommandError('Local branch is not bound')
4724
class cmd_uncommit(Command):
4725
__doc__ = """Remove the last committed revision.
4727
--verbose will print out what is being removed.
4728
--dry-run will go through all the motions, but not actually
4731
If --revision is specified, uncommit revisions to leave the branch at the
4732
specified revision. For example, "bzr uncommit -r 15" will leave the
4733
branch at revision 15.
4735
Uncommit leaves the working tree ready for a new commit. The only change
4736
it may make is to restore any pending merges that were present before
4740
# TODO: jam 20060108 Add an option to allow uncommit to remove
4741
# unreferenced information in 'branch-as-repository' branches.
4742
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4743
# information in shared branches as well.
4744
_see_also = ['commit']
4745
takes_options = ['verbose', 'revision',
4746
Option('dry-run', help='Don\'t actually make changes.'),
4747
Option('force', help='Say yes to all questions.'),
4749
help="Only remove the commits from the local branch"
4750
" when in a checkout."
4753
takes_args = ['location?']
4755
encoding_type = 'replace'
4757
def run(self, location=None,
4758
dry_run=False, verbose=False,
4759
revision=None, force=False, local=False):
4760
if location is None:
4762
control, relpath = bzrdir.BzrDir.open_containing(location)
4764
tree = control.open_workingtree()
4766
except (errors.NoWorkingTree, errors.NotLocalUrl):
4768
b = control.open_branch()
4770
if tree is not None:
4771
self.add_cleanup(tree.lock_write().unlock)
4773
self.add_cleanup(b.lock_write().unlock)
4774
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4776
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4777
from bzrlib.log import log_formatter, show_log
4778
from bzrlib.uncommit import uncommit
4780
last_revno, last_rev_id = b.last_revision_info()
4783
if revision is None:
4785
rev_id = last_rev_id
4787
# 'bzr uncommit -r 10' actually means uncommit
4788
# so that the final tree is at revno 10.
4789
# but bzrlib.uncommit.uncommit() actually uncommits
4790
# the revisions that are supplied.
4791
# So we need to offset it by one
4792
revno = revision[0].in_history(b).revno + 1
4793
if revno <= last_revno:
4794
rev_id = b.get_rev_id(revno)
4796
if rev_id is None or _mod_revision.is_null(rev_id):
4797
self.outf.write('No revisions to uncommit.\n')
4800
lf = log_formatter('short',
4802
show_timezone='original')
4807
direction='forward',
4808
start_revision=revno,
4809
end_revision=last_revno)
4812
self.outf.write('Dry-run, pretending to remove'
4813
' the above revisions.\n')
4815
self.outf.write('The above revision(s) will be removed.\n')
4818
if not ui.ui_factory.confirm_action(
4819
'Uncommit these revisions',
4820
'bzrlib.builtins.uncommit',
4822
self.outf.write('Canceled\n')
4825
mutter('Uncommitting from {%s} to {%s}',
4826
last_rev_id, rev_id)
4827
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4828
revno=revno, local=local)
4829
self.outf.write('You can restore the old tip by running:\n'
4830
' bzr pull . -r revid:%s\n' % last_rev_id)
4833
class cmd_break_lock(Command):
4834
__doc__ = """Break a dead lock.
4836
This command breaks a lock on a repository, branch, working directory or
4839
CAUTION: Locks should only be broken when you are sure that the process
4840
holding the lock has been stopped.
4842
You can get information on what locks are open via the 'bzr info
4843
[location]' command.
4847
bzr break-lock bzr+ssh://example.com/bzr/foo
4848
bzr break-lock --conf ~/.bazaar
4851
takes_args = ['location?']
4854
help='LOCATION is the directory where the config lock is.'),
4856
help='Do not ask for confirmation before breaking the lock.'),
4859
def run(self, location=None, config=False, force=False):
4860
if location is None:
4863
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
4865
{'bzrlib.lockdir.break': True})
4867
conf = _mod_config.LockableConfig(file_name=location)
4870
control, relpath = bzrdir.BzrDir.open_containing(location)
4872
control.break_lock()
4873
except NotImplementedError:
4877
class cmd_wait_until_signalled(Command):
4878
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4880
This just prints a line to signal when it is ready, then blocks on stdin.
4886
sys.stdout.write("running\n")
4888
sys.stdin.readline()
4891
class cmd_serve(Command):
4892
__doc__ = """Run the bzr server."""
4894
aliases = ['server']
4898
help='Serve on stdin/out for use from inetd or sshd.'),
4899
RegistryOption('protocol',
4900
help="Protocol to serve.",
4901
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4902
value_switches=True),
4904
help='Listen for connections on nominated port of the form '
4905
'[hostname:]portnumber. Passing 0 as the port number will '
4906
'result in a dynamically allocated port. The default port '
4907
'depends on the protocol.',
4909
custom_help('directory',
4910
help='Serve contents of this directory.'),
4911
Option('allow-writes',
4912
help='By default the server is a readonly server. Supplying '
4913
'--allow-writes enables write access to the contents of '
4914
'the served directory and below. Note that ``bzr serve`` '
4915
'does not perform authentication, so unless some form of '
4916
'external authentication is arranged supplying this '
4917
'option leads to global uncontrolled write access to your '
4922
def get_host_and_port(self, port):
4923
"""Return the host and port to run the smart server on.
4925
If 'port' is None, None will be returned for the host and port.
4927
If 'port' has a colon in it, the string before the colon will be
4928
interpreted as the host.
4930
:param port: A string of the port to run the server on.
4931
:return: A tuple of (host, port), where 'host' is a host name or IP,
4932
and port is an integer TCP/IP port.
4935
if port is not None:
4937
host, port = port.split(':')
4941
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4943
from bzrlib import transport
4944
if directory is None:
4945
directory = os.getcwd()
4946
if protocol is None:
4947
protocol = transport.transport_server_registry.get()
4948
host, port = self.get_host_and_port(port)
4949
url = urlutils.local_path_to_url(directory)
4950
if not allow_writes:
4951
url = 'readonly+' + url
4952
t = transport.get_transport(url)
4953
protocol(t, host, port, inet)
4956
class cmd_join(Command):
4957
__doc__ = """Combine a tree into its containing tree.
4959
This command requires the target tree to be in a rich-root format.
4961
The TREE argument should be an independent tree, inside another tree, but
4962
not part of it. (Such trees can be produced by "bzr split", but also by
4963
running "bzr branch" with the target inside a tree.)
4965
The result is a combined tree, with the subtree no longer an independent
4966
part. This is marked as a merge of the subtree into the containing tree,
4967
and all history is preserved.
4970
_see_also = ['split']
4971
takes_args = ['tree']
4973
Option('reference', help='Join by reference.', hidden=True),
4976
def run(self, tree, reference=False):
4977
sub_tree = WorkingTree.open(tree)
4978
parent_dir = osutils.dirname(sub_tree.basedir)
4979
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4980
repo = containing_tree.branch.repository
4981
if not repo.supports_rich_root():
4982
raise errors.BzrCommandError(
4983
"Can't join trees because %s doesn't support rich root data.\n"
4984
"You can use bzr upgrade on the repository."
4988
containing_tree.add_reference(sub_tree)
4989
except errors.BadReferenceTarget, e:
4990
# XXX: Would be better to just raise a nicely printable
4991
# exception from the real origin. Also below. mbp 20070306
4992
raise errors.BzrCommandError("Cannot join %s. %s" %
4996
containing_tree.subsume(sub_tree)
4997
except errors.BadSubsumeSource, e:
4998
raise errors.BzrCommandError("Cannot join %s. %s" %
5002
class cmd_split(Command):
5003
__doc__ = """Split a subdirectory of a tree into a separate tree.
5005
This command will produce a target tree in a format that supports
5006
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5007
converted into earlier formats like 'dirstate-tags'.
5009
The TREE argument should be a subdirectory of a working tree. That
5010
subdirectory will be converted into an independent tree, with its own
5011
branch. Commits in the top-level tree will not apply to the new subtree.
5014
_see_also = ['join']
5015
takes_args = ['tree']
5017
def run(self, tree):
5018
containing_tree, subdir = WorkingTree.open_containing(tree)
5019
sub_id = containing_tree.path2id(subdir)
5021
raise errors.NotVersionedError(subdir)
5023
containing_tree.extract(sub_id)
5024
except errors.RootNotRich:
5025
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5028
class cmd_merge_directive(Command):
5029
__doc__ = """Generate a merge directive for auto-merge tools.
5031
A directive requests a merge to be performed, and also provides all the
5032
information necessary to do so. This means it must either include a
5033
revision bundle, or the location of a branch containing the desired
5036
A submit branch (the location to merge into) must be supplied the first
5037
time the command is issued. After it has been supplied once, it will
5038
be remembered as the default.
5040
A public branch is optional if a revision bundle is supplied, but required
5041
if --diff or --plain is specified. It will be remembered as the default
5042
after the first use.
5045
takes_args = ['submit_branch?', 'public_branch?']
5049
_see_also = ['send']
5053
RegistryOption.from_kwargs('patch-type',
5054
'The type of patch to include in the directive.',
5056
value_switches=True,
5058
bundle='Bazaar revision bundle (default).',
5059
diff='Normal unified diff.',
5060
plain='No patch, just directive.'),
5061
Option('sign', help='GPG-sign the directive.'), 'revision',
5062
Option('mail-to', type=str,
5063
help='Instead of printing the directive, email to this address.'),
5064
Option('message', type=str, short_name='m',
5065
help='Message to use when committing this merge.')
5068
encoding_type = 'exact'
5070
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5071
sign=False, revision=None, mail_to=None, message=None,
5073
from bzrlib.revision import ensure_null, NULL_REVISION
5074
include_patch, include_bundle = {
5075
'plain': (False, False),
5076
'diff': (True, False),
5077
'bundle': (True, True),
5079
branch = Branch.open(directory)
5080
stored_submit_branch = branch.get_submit_branch()
5081
if submit_branch is None:
5082
submit_branch = stored_submit_branch
5084
if stored_submit_branch is None:
5085
branch.set_submit_branch(submit_branch)
5086
if submit_branch is None:
5087
submit_branch = branch.get_parent()
5088
if submit_branch is None:
5089
raise errors.BzrCommandError('No submit branch specified or known')
5091
stored_public_branch = branch.get_public_branch()
5092
if public_branch is None:
5093
public_branch = stored_public_branch
5094
elif stored_public_branch is None:
5095
branch.set_public_branch(public_branch)
5096
if not include_bundle and public_branch is None:
5097
raise errors.BzrCommandError('No public branch specified or'
5099
base_revision_id = None
5100
if revision is not None:
5101
if len(revision) > 2:
5102
raise errors.BzrCommandError('bzr merge-directive takes '
5103
'at most two one revision identifiers')
5104
revision_id = revision[-1].as_revision_id(branch)
5105
if len(revision) == 2:
5106
base_revision_id = revision[0].as_revision_id(branch)
5108
revision_id = branch.last_revision()
5109
revision_id = ensure_null(revision_id)
5110
if revision_id == NULL_REVISION:
5111
raise errors.BzrCommandError('No revisions to bundle.')
5112
directive = merge_directive.MergeDirective2.from_objects(
5113
branch.repository, revision_id, time.time(),
5114
osutils.local_time_offset(), submit_branch,
5115
public_branch=public_branch, include_patch=include_patch,
5116
include_bundle=include_bundle, message=message,
5117
base_revision_id=base_revision_id)
5120
self.outf.write(directive.to_signed(branch))
5122
self.outf.writelines(directive.to_lines())
5124
message = directive.to_email(mail_to, branch, sign)
5125
s = SMTPConnection(branch.get_config())
5126
s.send_email(message)
5129
class cmd_send(Command):
5130
__doc__ = """Mail or create a merge-directive for submitting changes.
5132
A merge directive provides many things needed for requesting merges:
5134
* A machine-readable description of the merge to perform
5136
* An optional patch that is a preview of the changes requested
5138
* An optional bundle of revision data, so that the changes can be applied
5139
directly from the merge directive, without retrieving data from a
5142
`bzr send` creates a compact data set that, when applied using bzr
5143
merge, has the same effect as merging from the source branch.
5145
By default the merge directive is self-contained and can be applied to any
5146
branch containing submit_branch in its ancestory without needing access to
5149
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5150
revisions, but only a structured request to merge from the
5151
public_location. In that case the public_branch is needed and it must be
5152
up-to-date and accessible to the recipient. The public_branch is always
5153
included if known, so that people can check it later.
5155
The submit branch defaults to the parent of the source branch, but can be
5156
overridden. Both submit branch and public branch will be remembered in
5157
branch.conf the first time they are used for a particular branch. The
5158
source branch defaults to that containing the working directory, but can
5159
be changed using --from.
5161
In order to calculate those changes, bzr must analyse the submit branch.
5162
Therefore it is most efficient for the submit branch to be a local mirror.
5163
If a public location is known for the submit_branch, that location is used
5164
in the merge directive.
5166
The default behaviour is to send the merge directive by mail, unless -o is
5167
given, in which case it is sent to a file.
5169
Mail is sent using your preferred mail program. This should be transparent
5170
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5171
If the preferred client can't be found (or used), your editor will be used.
5173
To use a specific mail program, set the mail_client configuration option.
5174
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5175
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5176
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5177
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5180
If mail is being sent, a to address is required. This can be supplied
5181
either on the commandline, by setting the submit_to configuration
5182
option in the branch itself or the child_submit_to configuration option
5183
in the submit branch.
5185
Two formats are currently supported: "4" uses revision bundle format 4 and
5186
merge directive format 2. It is significantly faster and smaller than
5187
older formats. It is compatible with Bazaar 0.19 and later. It is the
5188
default. "0.9" uses revision bundle format 0.9 and merge directive
5189
format 1. It is compatible with Bazaar 0.12 - 0.18.
5191
The merge directives created by bzr send may be applied using bzr merge or
5192
bzr pull by specifying a file containing a merge directive as the location.
5194
bzr send makes extensive use of public locations to map local locations into
5195
URLs that can be used by other people. See `bzr help configuration` to
5196
set them, and use `bzr info` to display them.
5199
encoding_type = 'exact'
5201
_see_also = ['merge', 'pull']
5203
takes_args = ['submit_branch?', 'public_branch?']
5207
help='Do not include a bundle in the merge directive.'),
5208
Option('no-patch', help='Do not include a preview patch in the merge'
5211
help='Remember submit and public branch.'),
5213
help='Branch to generate the submission from, '
5214
'rather than the one containing the working directory.',
5217
Option('output', short_name='o',
5218
help='Write merge directive to this file or directory; '
5219
'use - for stdout.',
5222
help='Refuse to send if there are uncommitted changes in'
5223
' the working tree, --no-strict disables the check.'),
5224
Option('mail-to', help='Mail the request to this address.',
5228
Option('body', help='Body for the email.', type=unicode),
5229
RegistryOption('format',
5230
help='Use the specified output format.',
5231
lazy_registry=('bzrlib.send', 'format_registry')),
5234
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5235
no_patch=False, revision=None, remember=False, output=None,
5236
format=None, mail_to=None, message=None, body=None,
5237
strict=None, **kwargs):
5238
from bzrlib.send import send
5239
return send(submit_branch, revision, public_branch, remember,
5240
format, no_bundle, no_patch, output,
5241
kwargs.get('from', '.'), mail_to, message, body,
5246
class cmd_bundle_revisions(cmd_send):
5247
__doc__ = """Create a merge-directive for submitting changes.
5249
A merge directive provides many things needed for requesting merges:
5251
* A machine-readable description of the merge to perform
5253
* An optional patch that is a preview of the changes requested
5255
* An optional bundle of revision data, so that the changes can be applied
5256
directly from the merge directive, without retrieving data from a
5259
If --no-bundle is specified, then public_branch is needed (and must be
5260
up-to-date), so that the receiver can perform the merge using the
5261
public_branch. The public_branch is always included if known, so that
5262
people can check it later.
5264
The submit branch defaults to the parent, but can be overridden. Both
5265
submit branch and public branch will be remembered if supplied.
5267
If a public_branch is known for the submit_branch, that public submit
5268
branch is used in the merge instructions. This means that a local mirror
5269
can be used as your actual submit branch, once you have set public_branch
5272
Two formats are currently supported: "4" uses revision bundle format 4 and
5273
merge directive format 2. It is significantly faster and smaller than
5274
older formats. It is compatible with Bazaar 0.19 and later. It is the
5275
default. "0.9" uses revision bundle format 0.9 and merge directive
5276
format 1. It is compatible with Bazaar 0.12 - 0.18.
5281
help='Do not include a bundle in the merge directive.'),
5282
Option('no-patch', help='Do not include a preview patch in the merge'
5285
help='Remember submit and public branch.'),
5287
help='Branch to generate the submission from, '
5288
'rather than the one containing the working directory.',
5291
Option('output', short_name='o', help='Write directive to this file.',
5294
help='Refuse to bundle revisions if there are uncommitted'
5295
' changes in the working tree, --no-strict disables the check.'),
5297
RegistryOption('format',
5298
help='Use the specified output format.',
5299
lazy_registry=('bzrlib.send', 'format_registry')),
5301
aliases = ['bundle']
5303
_see_also = ['send', 'merge']
5307
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5308
no_patch=False, revision=None, remember=False, output=None,
5309
format=None, strict=None, **kwargs):
5312
from bzrlib.send import send
5313
return send(submit_branch, revision, public_branch, remember,
5314
format, no_bundle, no_patch, output,
5315
kwargs.get('from', '.'), None, None, None,
5316
self.outf, strict=strict)
5319
class cmd_tag(Command):
5320
__doc__ = """Create, remove or modify a tag naming a revision.
5322
Tags give human-meaningful names to revisions. Commands that take a -r
5323
(--revision) option can be given -rtag:X, where X is any previously
5326
Tags are stored in the branch. Tags are copied from one branch to another
5327
along when you branch, push, pull or merge.
5329
It is an error to give a tag name that already exists unless you pass
5330
--force, in which case the tag is moved to point to the new revision.
5332
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5333
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5335
If no tag name is specified it will be determined through the
5336
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5337
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5341
_see_also = ['commit', 'tags']
5342
takes_args = ['tag_name?']
5345
help='Delete this tag rather than placing it.',
5347
custom_help('directory',
5348
help='Branch in which to place the tag.'),
5350
help='Replace existing tags.',
5355
def run(self, tag_name=None,
5361
branch, relpath = Branch.open_containing(directory)
5362
self.add_cleanup(branch.lock_write().unlock)
5364
if tag_name is None:
5365
raise errors.BzrCommandError("No tag specified to delete.")
5366
branch.tags.delete_tag(tag_name)
5367
self.outf.write('Deleted tag %s.\n' % tag_name)
5370
if len(revision) != 1:
5371
raise errors.BzrCommandError(
5372
"Tags can only be placed on a single revision, "
5374
revision_id = revision[0].as_revision_id(branch)
5376
revision_id = branch.last_revision()
5377
if tag_name is None:
5378
tag_name = branch.automatic_tag_name(revision_id)
5379
if tag_name is None:
5380
raise errors.BzrCommandError(
5381
"Please specify a tag name.")
5382
if (not force) and branch.tags.has_tag(tag_name):
5383
raise errors.TagAlreadyExists(tag_name)
5384
branch.tags.set_tag(tag_name, revision_id)
5385
self.outf.write('Created tag %s.\n' % tag_name)
5388
class cmd_tags(Command):
5389
__doc__ = """List tags.
5391
This command shows a table of tag names and the revisions they reference.
5396
custom_help('directory',
5397
help='Branch whose tags should be displayed.'),
5398
RegistryOption.from_kwargs('sort',
5399
'Sort tags by different criteria.', title='Sorting',
5400
alpha='Sort tags lexicographically (default).',
5401
time='Sort tags chronologically.',
5414
branch, relpath = Branch.open_containing(directory)
5416
tags = branch.tags.get_tag_dict().items()
5420
self.add_cleanup(branch.lock_read().unlock)
5422
graph = branch.repository.get_graph()
5423
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5424
revid1, revid2 = rev1.rev_id, rev2.rev_id
5425
# only show revisions between revid1 and revid2 (inclusive)
5426
tags = [(tag, revid) for tag, revid in tags if
5427
graph.is_between(revid, revid1, revid2)]
5430
elif sort == 'time':
5432
for tag, revid in tags:
5434
revobj = branch.repository.get_revision(revid)
5435
except errors.NoSuchRevision:
5436
timestamp = sys.maxint # place them at the end
5438
timestamp = revobj.timestamp
5439
timestamps[revid] = timestamp
5440
tags.sort(key=lambda x: timestamps[x[1]])
5442
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5443
for index, (tag, revid) in enumerate(tags):
5445
revno = branch.revision_id_to_dotted_revno(revid)
5446
if isinstance(revno, tuple):
5447
revno = '.'.join(map(str, revno))
5448
except errors.NoSuchRevision:
5449
# Bad tag data/merges can lead to tagged revisions
5450
# which are not in this branch. Fail gracefully ...
5452
tags[index] = (tag, revno)
5454
for tag, revspec in tags:
5455
self.outf.write('%-20s %s\n' % (tag, revspec))
5458
class cmd_reconfigure(Command):
5459
__doc__ = """Reconfigure the type of a bzr directory.
5461
A target configuration must be specified.
5463
For checkouts, the bind-to location will be auto-detected if not specified.
5464
The order of preference is
5465
1. For a lightweight checkout, the current bound location.
5466
2. For branches that used to be checkouts, the previously-bound location.
5467
3. The push location.
5468
4. The parent location.
5469
If none of these is available, --bind-to must be specified.
5472
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5473
takes_args = ['location?']
5475
RegistryOption.from_kwargs(
5477
title='Target type',
5478
help='The type to reconfigure the directory to.',
5479
value_switches=True, enum_switch=False,
5480
branch='Reconfigure to be an unbound branch with no working tree.',
5481
tree='Reconfigure to be an unbound branch with a working tree.',
5482
checkout='Reconfigure to be a bound branch with a working tree.',
5483
lightweight_checkout='Reconfigure to be a lightweight'
5484
' checkout (with no local history).',
5485
standalone='Reconfigure to be a standalone branch '
5486
'(i.e. stop using shared repository).',
5487
use_shared='Reconfigure to use a shared repository.',
5488
with_trees='Reconfigure repository to create '
5489
'working trees on branches by default.',
5490
with_no_trees='Reconfigure repository to not create '
5491
'working trees on branches by default.'
5493
Option('bind-to', help='Branch to bind checkout to.', type=str),
5495
help='Perform reconfiguration even if local changes'
5497
Option('stacked-on',
5498
help='Reconfigure a branch to be stacked on another branch.',
5502
help='Reconfigure a branch to be unstacked. This '
5503
'may require copying substantial data into it.',
5507
def run(self, location=None, target_type=None, bind_to=None, force=False,
5510
directory = bzrdir.BzrDir.open(location)
5511
if stacked_on and unstacked:
5512
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5513
elif stacked_on is not None:
5514
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5516
reconfigure.ReconfigureUnstacked().apply(directory)
5517
# At the moment you can use --stacked-on and a different
5518
# reconfiguration shape at the same time; there seems no good reason
5520
if target_type is None:
5521
if stacked_on or unstacked:
5524
raise errors.BzrCommandError('No target configuration '
5526
elif target_type == 'branch':
5527
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5528
elif target_type == 'tree':
5529
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5530
elif target_type == 'checkout':
5531
reconfiguration = reconfigure.Reconfigure.to_checkout(
5533
elif target_type == 'lightweight-checkout':
5534
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5536
elif target_type == 'use-shared':
5537
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5538
elif target_type == 'standalone':
5539
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5540
elif target_type == 'with-trees':
5541
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5543
elif target_type == 'with-no-trees':
5544
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5546
reconfiguration.apply(force)
5549
class cmd_switch(Command):
5550
__doc__ = """Set the branch of a checkout and update.
5552
For lightweight checkouts, this changes the branch being referenced.
5553
For heavyweight checkouts, this checks that there are no local commits
5554
versus the current bound branch, then it makes the local branch a mirror
5555
of the new location and binds to it.
5557
In both cases, the working tree is updated and uncommitted changes
5558
are merged. The user can commit or revert these as they desire.
5560
Pending merges need to be committed or reverted before using switch.
5562
The path to the branch to switch to can be specified relative to the parent
5563
directory of the current branch. For example, if you are currently in a
5564
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5567
Bound branches use the nickname of its master branch unless it is set
5568
locally, in which case switching will update the local nickname to be
5572
takes_args = ['to_location?']
5573
takes_options = ['directory',
5575
help='Switch even if local commits will be lost.'),
5577
Option('create-branch', short_name='b',
5578
help='Create the target branch from this one before'
5579
' switching to it.'),
5582
def run(self, to_location=None, force=False, create_branch=False,
5583
revision=None, directory=u'.'):
5584
from bzrlib import switch
5585
tree_location = directory
5586
revision = _get_one_revision('switch', revision)
5587
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5588
if to_location is None:
5589
if revision is None:
5590
raise errors.BzrCommandError('You must supply either a'
5591
' revision or a location')
5592
to_location = tree_location
5594
branch = control_dir.open_branch()
5595
had_explicit_nick = branch.get_config().has_explicit_nickname()
5596
except errors.NotBranchError:
5598
had_explicit_nick = False
5601
raise errors.BzrCommandError('cannot create branch without'
5603
to_location = directory_service.directories.dereference(
5605
if '/' not in to_location and '\\' not in to_location:
5606
# This path is meant to be relative to the existing branch
5607
this_url = self._get_branch_location(control_dir)
5608
to_location = urlutils.join(this_url, '..', to_location)
5609
to_branch = branch.bzrdir.sprout(to_location,
5610
possible_transports=[branch.bzrdir.root_transport],
5611
source_branch=branch).open_branch()
5614
to_branch = Branch.open(to_location)
5615
except errors.NotBranchError:
5616
this_url = self._get_branch_location(control_dir)
5617
to_branch = Branch.open(
5618
urlutils.join(this_url, '..', to_location))
5619
if revision is not None:
5620
revision = revision.as_revision_id(to_branch)
5621
switch.switch(control_dir, to_branch, force, revision_id=revision)
5622
if had_explicit_nick:
5623
branch = control_dir.open_branch() #get the new branch!
5624
branch.nick = to_branch.nick
5625
note('Switched to branch: %s',
5626
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5628
def _get_branch_location(self, control_dir):
5629
"""Return location of branch for this control dir."""
5631
this_branch = control_dir.open_branch()
5632
# This may be a heavy checkout, where we want the master branch
5633
master_location = this_branch.get_bound_location()
5634
if master_location is not None:
5635
return master_location
5636
# If not, use a local sibling
5637
return this_branch.base
5638
except errors.NotBranchError:
5639
format = control_dir.find_branch_format()
5640
if getattr(format, 'get_reference', None) is not None:
5641
return format.get_reference(control_dir)
5643
return control_dir.root_transport.base
5646
class cmd_view(Command):
5647
__doc__ = """Manage filtered views.
5649
Views provide a mask over the tree so that users can focus on
5650
a subset of a tree when doing their work. After creating a view,
5651
commands that support a list of files - status, diff, commit, etc -
5652
effectively have that list of files implicitly given each time.
5653
An explicit list of files can still be given but those files
5654
must be within the current view.
5656
In most cases, a view has a short life-span: it is created to make
5657
a selected change and is deleted once that change is committed.
5658
At other times, you may wish to create one or more named views
5659
and switch between them.
5661
To disable the current view without deleting it, you can switch to
5662
the pseudo view called ``off``. This can be useful when you need
5663
to see the whole tree for an operation or two (e.g. merge) but
5664
want to switch back to your view after that.
5667
To define the current view::
5669
bzr view file1 dir1 ...
5671
To list the current view::
5675
To delete the current view::
5679
To disable the current view without deleting it::
5681
bzr view --switch off
5683
To define a named view and switch to it::
5685
bzr view --name view-name file1 dir1 ...
5687
To list a named view::
5689
bzr view --name view-name
5691
To delete a named view::
5693
bzr view --name view-name --delete
5695
To switch to a named view::
5697
bzr view --switch view-name
5699
To list all views defined::
5703
To delete all views::
5705
bzr view --delete --all
5709
takes_args = ['file*']
5712
help='Apply list or delete action to all views.',
5715
help='Delete the view.',
5718
help='Name of the view to define, list or delete.',
5722
help='Name of the view to switch to.',
5727
def run(self, file_list,
5733
tree, file_list = WorkingTree.open_containing_paths(file_list,
5735
current_view, view_dict = tree.views.get_view_info()
5740
raise errors.BzrCommandError(
5741
"Both --delete and a file list specified")
5743
raise errors.BzrCommandError(
5744
"Both --delete and --switch specified")
5746
tree.views.set_view_info(None, {})
5747
self.outf.write("Deleted all views.\n")
5749
raise errors.BzrCommandError("No current view to delete")
5751
tree.views.delete_view(name)
5752
self.outf.write("Deleted '%s' view.\n" % name)
5755
raise errors.BzrCommandError(
5756
"Both --switch and a file list specified")
5758
raise errors.BzrCommandError(
5759
"Both --switch and --all specified")
5760
elif switch == 'off':
5761
if current_view is None:
5762
raise errors.BzrCommandError("No current view to disable")
5763
tree.views.set_view_info(None, view_dict)
5764
self.outf.write("Disabled '%s' view.\n" % (current_view))
5766
tree.views.set_view_info(switch, view_dict)
5767
view_str = views.view_display_str(tree.views.lookup_view())
5768
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5771
self.outf.write('Views defined:\n')
5772
for view in sorted(view_dict):
5773
if view == current_view:
5777
view_str = views.view_display_str(view_dict[view])
5778
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5780
self.outf.write('No views defined.\n')
5783
# No name given and no current view set
5786
raise errors.BzrCommandError(
5787
"Cannot change the 'off' pseudo view")
5788
tree.views.set_view(name, sorted(file_list))
5789
view_str = views.view_display_str(tree.views.lookup_view())
5790
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5794
# No name given and no current view set
5795
self.outf.write('No current view.\n')
5797
view_str = views.view_display_str(tree.views.lookup_view(name))
5798
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5801
class cmd_hooks(Command):
5802
__doc__ = """Show hooks."""
5807
for hook_key in sorted(hooks.known_hooks.keys()):
5808
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5809
self.outf.write("%s:\n" % type(some_hooks).__name__)
5810
for hook_name, hook_point in sorted(some_hooks.items()):
5811
self.outf.write(" %s:\n" % (hook_name,))
5812
found_hooks = list(hook_point)
5814
for hook in found_hooks:
5815
self.outf.write(" %s\n" %
5816
(some_hooks.get_hook_name(hook),))
5818
self.outf.write(" <no hooks installed>\n")
5821
class cmd_remove_branch(Command):
5822
__doc__ = """Remove a branch.
5824
This will remove the branch from the specified location but
5825
will keep any working tree or repository in place.
5829
Remove the branch at repo/trunk::
5831
bzr remove-branch repo/trunk
5835
takes_args = ["location?"]
5837
aliases = ["rmbranch"]
5839
def run(self, location=None):
5840
if location is None:
5842
branch = Branch.open_containing(location)[0]
5843
branch.bzrdir.destroy_branch()
5846
class cmd_shelve(Command):
5847
__doc__ = """Temporarily set aside some changes from the current tree.
5849
Shelve allows you to temporarily put changes you've made "on the shelf",
5850
ie. out of the way, until a later time when you can bring them back from
5851
the shelf with the 'unshelve' command. The changes are stored alongside
5852
your working tree, and so they aren't propagated along with your branch nor
5853
will they survive its deletion.
5855
If shelve --list is specified, previously-shelved changes are listed.
5857
Shelve is intended to help separate several sets of changes that have
5858
been inappropriately mingled. If you just want to get rid of all changes
5859
and you don't need to restore them later, use revert. If you want to
5860
shelve all text changes at once, use shelve --all.
5862
If filenames are specified, only the changes to those files will be
5863
shelved. Other files will be left untouched.
5865
If a revision is specified, changes since that revision will be shelved.
5867
You can put multiple items on the shelf, and by default, 'unshelve' will
5868
restore the most recently shelved changes.
5871
takes_args = ['file*']
5876
Option('all', help='Shelve all changes.'),
5878
RegistryOption('writer', 'Method to use for writing diffs.',
5879
bzrlib.option.diff_writer_registry,
5880
value_switches=True, enum_switch=False),
5882
Option('list', help='List shelved changes.'),
5884
help='Destroy removed changes instead of shelving them.'),
5886
_see_also = ['unshelve']
5888
def run(self, revision=None, all=False, file_list=None, message=None,
5889
writer=None, list=False, destroy=False, directory=u'.'):
5891
return self.run_for_list()
5892
from bzrlib.shelf_ui import Shelver
5894
writer = bzrlib.option.diff_writer_registry.get()
5896
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5897
file_list, message, destroy=destroy, directory=directory)
5902
except errors.UserAbort:
5905
def run_for_list(self):
5906
tree = WorkingTree.open_containing('.')[0]
5907
self.add_cleanup(tree.lock_read().unlock)
5908
manager = tree.get_shelf_manager()
5909
shelves = manager.active_shelves()
5910
if len(shelves) == 0:
5911
note('No shelved changes.')
5913
for shelf_id in reversed(shelves):
5914
message = manager.get_metadata(shelf_id).get('message')
5916
message = '<no message>'
5917
self.outf.write('%3d: %s\n' % (shelf_id, message))
5921
class cmd_unshelve(Command):
5922
__doc__ = """Restore shelved changes.
5924
By default, the most recently shelved changes are restored. However if you
5925
specify a shelf by id those changes will be restored instead. This works
5926
best when the changes don't depend on each other.
5929
takes_args = ['shelf_id?']
5932
RegistryOption.from_kwargs(
5933
'action', help="The action to perform.",
5934
enum_switch=False, value_switches=True,
5935
apply="Apply changes and remove from the shelf.",
5936
dry_run="Show changes, but do not apply or remove them.",
5937
preview="Instead of unshelving the changes, show the diff that "
5938
"would result from unshelving.",
5939
delete_only="Delete changes without applying them.",
5940
keep="Apply changes but don't delete them.",
5943
_see_also = ['shelve']
5945
def run(self, shelf_id=None, action='apply', directory=u'.'):
5946
from bzrlib.shelf_ui import Unshelver
5947
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5951
unshelver.tree.unlock()
5954
class cmd_clean_tree(Command):
5955
__doc__ = """Remove unwanted files from working tree.
5957
By default, only unknown files, not ignored files, are deleted. Versioned
5958
files are never deleted.
5960
Another class is 'detritus', which includes files emitted by bzr during
5961
normal operations and selftests. (The value of these files decreases with
5964
If no options are specified, unknown files are deleted. Otherwise, option
5965
flags are respected, and may be combined.
5967
To check what clean-tree will do, use --dry-run.
5969
takes_options = ['directory',
5970
Option('ignored', help='Delete all ignored files.'),
5971
Option('detritus', help='Delete conflict files, merge'
5972
' backups, and failed selftest dirs.'),
5974
help='Delete files unknown to bzr (default).'),
5975
Option('dry-run', help='Show files to delete instead of'
5977
Option('force', help='Do not prompt before deleting.')]
5978
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5979
force=False, directory=u'.'):
5980
from bzrlib.clean_tree import clean_tree
5981
if not (unknown or ignored or detritus):
5985
clean_tree(directory, unknown=unknown, ignored=ignored,
5986
detritus=detritus, dry_run=dry_run, no_prompt=force)
5989
class cmd_reference(Command):
5990
__doc__ = """list, view and set branch locations for nested trees.
5992
If no arguments are provided, lists the branch locations for nested trees.
5993
If one argument is provided, display the branch location for that tree.
5994
If two arguments are provided, set the branch location for that tree.
5999
takes_args = ['path?', 'location?']
6001
def run(self, path=None, location=None):
6003
if path is not None:
6005
tree, branch, relpath =(
6006
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
6007
if path is not None:
6010
tree = branch.basis_tree()
6012
info = branch._get_all_reference_info().iteritems()
6013
self._display_reference_info(tree, branch, info)
6015
file_id = tree.path2id(path)
6017
raise errors.NotVersionedError(path)
6018
if location is None:
6019
info = [(file_id, branch.get_reference_info(file_id))]
6020
self._display_reference_info(tree, branch, info)
6022
branch.set_reference_info(file_id, path, location)
6024
def _display_reference_info(self, tree, branch, info):
6026
for file_id, (path, location) in info:
6028
path = tree.id2path(file_id)
6029
except errors.NoSuchId:
6031
ref_list.append((path, location))
6032
for path, location in sorted(ref_list):
6033
self.outf.write('%s %s\n' % (path, location))
6036
def _register_lazy_builtins():
6037
# register lazy builtins from other modules; called at startup and should
6038
# be only called once.
6039
for (name, aliases, module_name) in [
6040
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6041
('cmd_dpush', [], 'bzrlib.foreign'),
6042
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6043
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6044
('cmd_conflicts', [], 'bzrlib.conflicts'),
6045
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6047
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
