1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 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(), """
45
revision as _mod_revision,
52
from bzrlib.branch import Branch
53
from bzrlib.conflicts import ConflictList
54
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
55
from bzrlib.smtp_connection import SMTPConnection
56
from bzrlib.workingtree import WorkingTree
59
from bzrlib.commands import Command, display_command
60
from bzrlib.option import (
67
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
70
def tree_files(file_list, default_branch=u'.', canonicalize=True,
73
return internal_tree_files(file_list, default_branch, canonicalize,
75
except errors.FileInWrongBranch, e:
76
raise errors.BzrCommandError("%s is not in the same branch as %s" %
77
(e.path, file_list[0]))
80
def tree_files_for_add(file_list):
82
Return a tree and list of absolute paths from a file list.
84
Similar to tree_files, but add handles files a bit differently, so it a
85
custom implementation. In particular, MutableTreeTree.smart_add expects
86
absolute paths, which it immediately converts to relative paths.
88
# FIXME Would be nice to just return the relative paths like
89
# internal_tree_files does, but there are a large number of unit tests
90
# that assume the current interface to mutabletree.smart_add
92
tree, relpath = WorkingTree.open_containing(file_list[0])
93
if tree.supports_views():
94
view_files = tree.views.lookup_view()
96
for filename in file_list:
97
if not osutils.is_inside_any(view_files, filename):
98
raise errors.FileOutsideView(filename, view_files)
99
file_list = file_list[:]
100
file_list[0] = tree.abspath(relpath)
102
tree = WorkingTree.open_containing(u'.')[0]
103
if tree.supports_views():
104
view_files = tree.views.lookup_view()
106
file_list = view_files
107
view_str = views.view_display_str(view_files)
108
note("Ignoring files outside view. View is %s" % view_str)
109
return tree, file_list
112
def _get_one_revision(command_name, revisions):
113
if revisions is None:
115
if len(revisions) != 1:
116
raise errors.BzrCommandError(
117
'bzr %s --revision takes exactly one revision identifier' % (
122
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
123
"""Get a revision tree. Not suitable for commands that change the tree.
125
Specifically, the basis tree in dirstate trees is coupled to the dirstate
126
and doing a commit/uncommit/pull will at best fail due to changing the
129
If tree is passed in, it should be already locked, for lifetime management
130
of the trees internal cached state.
134
if revisions is None:
136
rev_tree = tree.basis_tree()
138
rev_tree = branch.basis_tree()
140
revision = _get_one_revision(command_name, revisions)
141
rev_tree = revision.as_tree(branch)
145
# XXX: Bad function name; should possibly also be a class method of
146
# WorkingTree rather than a function.
147
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
149
"""Convert command-line paths to a WorkingTree and relative paths.
151
This is typically used for command-line processors that take one or
152
more filenames, and infer the workingtree that contains them.
154
The filenames given are not required to exist.
156
:param file_list: Filenames to convert.
158
:param default_branch: Fallback tree path to use if file_list is empty or
161
:param apply_view: if True and a view is set, apply it or check that
162
specified files are within it
164
:return: workingtree, [relative_paths]
166
if file_list is None or len(file_list) == 0:
167
tree = WorkingTree.open_containing(default_branch)[0]
168
if tree.supports_views() and apply_view:
169
view_files = tree.views.lookup_view()
171
file_list = view_files
172
view_str = views.view_display_str(view_files)
173
note("Ignoring files outside view. View is %s" % view_str)
174
return tree, file_list
175
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
176
return tree, safe_relpath_files(tree, file_list, canonicalize,
177
apply_view=apply_view)
180
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
181
"""Convert file_list into a list of relpaths in tree.
183
:param tree: A tree to operate on.
184
:param file_list: A list of user provided paths or None.
185
:param apply_view: if True and a view is set, apply it or check that
186
specified files are within it
187
:return: A list of relative paths.
188
:raises errors.PathNotChild: When a provided path is in a different tree
191
if file_list is None:
193
if tree.supports_views() and apply_view:
194
view_files = tree.views.lookup_view()
198
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
199
# doesn't - fix that up here before we enter the loop.
201
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
204
for filename in file_list:
206
relpath = fixer(osutils.dereference_path(filename))
207
if view_files and not osutils.is_inside_any(view_files, relpath):
208
raise errors.FileOutsideView(filename, view_files)
209
new_list.append(relpath)
210
except errors.PathNotChild:
211
raise errors.FileInWrongBranch(tree.branch, filename)
215
def _get_view_info_for_change_reporter(tree):
216
"""Get the view information from a tree for change reporting."""
219
current_view = tree.views.get_view_info()[0]
220
if current_view is not None:
221
view_info = (current_view, tree.views.lookup_view())
222
except errors.ViewsNotSupported:
227
# TODO: Make sure no commands unconditionally use the working directory as a
228
# branch. If a filename argument is used, the first of them should be used to
229
# specify the branch. (Perhaps this can be factored out into some kind of
230
# Argument class, representing a file in a branch, where the first occurrence
233
class cmd_status(Command):
234
"""Display status summary.
236
This reports on versioned and unknown files, reporting them
237
grouped by state. Possible states are:
240
Versioned in the working copy but not in the previous revision.
243
Versioned in the previous revision but removed or deleted
247
Path of this file changed from the previous revision;
248
the text may also have changed. This includes files whose
249
parent directory was renamed.
252
Text has changed since the previous revision.
255
File kind has been changed (e.g. from file to directory).
258
Not versioned and not matching an ignore pattern.
260
To see ignored files use 'bzr ignored'. For details on the
261
changes to file texts, use 'bzr diff'.
263
Note that --short or -S gives status flags for each item, similar
264
to Subversion's status command. To get output similar to svn -q,
267
If no arguments are specified, the status of the entire working
268
directory is shown. Otherwise, only the status of the specified
269
files or directories is reported. If a directory is given, status
270
is reported for everything inside that directory.
272
Before merges are committed, the pending merge tip revisions are
273
shown. To see all pending merge revisions, use the -v option.
274
To skip the display of pending merge information altogether, use
275
the no-pending option or specify a file/directory.
277
If a revision argument is given, the status is calculated against
278
that revision, or between two revisions if two are provided.
281
# TODO: --no-recurse, --recurse options
283
takes_args = ['file*']
284
takes_options = ['show-ids', 'revision', 'change', 'verbose',
285
Option('short', help='Use short status indicators.',
287
Option('versioned', help='Only show versioned files.',
289
Option('no-pending', help='Don\'t show pending merges.',
292
aliases = ['st', 'stat']
294
encoding_type = 'replace'
295
_see_also = ['diff', 'revert', 'status-flags']
298
def run(self, show_ids=False, file_list=None, revision=None, short=False,
299
versioned=False, no_pending=False, verbose=False):
300
from bzrlib.status import show_tree_status
302
if revision and len(revision) > 2:
303
raise errors.BzrCommandError('bzr status --revision takes exactly'
304
' one or two revision specifiers')
306
tree, relfile_list = tree_files(file_list)
307
# Avoid asking for specific files when that is not needed.
308
if relfile_list == ['']:
310
# Don't disable pending merges for full trees other than '.'.
311
if file_list == ['.']:
313
# A specific path within a tree was given.
314
elif relfile_list is not None:
316
show_tree_status(tree, show_ids=show_ids,
317
specific_files=relfile_list, revision=revision,
318
to_file=self.outf, short=short, versioned=versioned,
319
show_pending=(not no_pending), verbose=verbose)
322
class cmd_cat_revision(Command):
323
"""Write out metadata for a revision.
325
The revision to print can either be specified by a specific
326
revision identifier, or you can use --revision.
330
takes_args = ['revision_id?']
331
takes_options = ['revision']
332
# cat-revision is more for frontends so should be exact
336
def run(self, revision_id=None, revision=None):
337
if revision_id is not None and revision is not None:
338
raise errors.BzrCommandError('You can only supply one of'
339
' revision_id or --revision')
340
if revision_id is None and revision is None:
341
raise errors.BzrCommandError('You must supply either'
342
' --revision or a revision_id')
343
b = WorkingTree.open_containing(u'.')[0].branch
345
# TODO: jam 20060112 should cat-revision always output utf-8?
346
if revision_id is not None:
347
revision_id = osutils.safe_revision_id(revision_id, warn=False)
349
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
350
except errors.NoSuchRevision:
351
msg = "The repository %s contains no revision %s." % (b.repository.base,
353
raise errors.BzrCommandError(msg)
354
elif revision is not None:
357
raise errors.BzrCommandError('You cannot specify a NULL'
359
rev_id = rev.as_revision_id(b)
360
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
363
class cmd_dump_btree(Command):
364
"""Dump the contents of a btree index file to stdout.
366
PATH is a btree index file, it can be any URL. This includes things like
367
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
369
By default, the tuples stored in the index file will be displayed. With
370
--raw, we will uncompress the pages, but otherwise display the raw bytes
374
# TODO: Do we want to dump the internal nodes as well?
375
# TODO: It would be nice to be able to dump the un-parsed information,
376
# rather than only going through iter_all_entries. However, this is
377
# good enough for a start
379
encoding_type = 'exact'
380
takes_args = ['path']
381
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
382
' rather than the parsed tuples.'),
385
def run(self, path, raw=False):
386
dirname, basename = osutils.split(path)
387
t = transport.get_transport(dirname)
389
self._dump_raw_bytes(t, basename)
391
self._dump_entries(t, basename)
393
def _get_index_and_bytes(self, trans, basename):
394
"""Create a BTreeGraphIndex and raw bytes."""
395
bt = btree_index.BTreeGraphIndex(trans, basename, None)
396
bytes = trans.get_bytes(basename)
397
bt._file = cStringIO.StringIO(bytes)
398
bt._size = len(bytes)
401
def _dump_raw_bytes(self, trans, basename):
404
# We need to parse at least the root node.
405
# This is because the first page of every row starts with an
406
# uncompressed header.
407
bt, bytes = self._get_index_and_bytes(trans, basename)
408
for page_idx, page_start in enumerate(xrange(0, len(bytes),
409
btree_index._PAGE_SIZE)):
410
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
411
page_bytes = bytes[page_start:page_end]
413
self.outf.write('Root node:\n')
414
header_end, data = bt._parse_header_from_bytes(page_bytes)
415
self.outf.write(page_bytes[:header_end])
417
self.outf.write('\nPage %d\n' % (page_idx,))
418
decomp_bytes = zlib.decompress(page_bytes)
419
self.outf.write(decomp_bytes)
420
self.outf.write('\n')
422
def _dump_entries(self, trans, basename):
424
st = trans.stat(basename)
425
except errors.TransportNotPossible:
426
# We can't stat, so we'll fake it because we have to do the 'get()'
428
bt, _ = self._get_index_and_bytes(trans, basename)
430
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
431
for node in bt.iter_all_entries():
432
# Node is made up of:
433
# (index, key, value, [references])
434
self.outf.write('%s\n' % (node[1:],))
437
class cmd_remove_tree(Command):
438
"""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 changes.'),
453
def run(self, location='.', force=False):
454
d = bzrdir.BzrDir.open(location)
457
working = d.open_workingtree()
458
except errors.NoWorkingTree:
459
raise errors.BzrCommandError("No working tree to remove")
460
except errors.NotLocalUrl:
461
raise errors.BzrCommandError("You cannot remove the working tree"
464
# XXX: What about pending merges ? -- vila 20090629
465
if working.has_changes(working.basis_tree()):
466
raise errors.UncommittedChanges(working)
468
working_path = working.bzrdir.root_transport.base
469
branch_path = working.branch.bzrdir.root_transport.base
470
if working_path != branch_path:
471
raise errors.BzrCommandError("You cannot remove the working tree"
472
" from a lightweight checkout")
474
d.destroy_workingtree()
477
class cmd_revno(Command):
478
"""Show current revision number.
480
This is equal to the number of revisions on this branch.
484
takes_args = ['location?']
486
Option('tree', help='Show revno of working tree'),
490
def run(self, tree=False, location=u'.'):
493
wt = WorkingTree.open_containing(location)[0]
495
except (errors.NoWorkingTree, errors.NotLocalUrl):
496
raise errors.NoWorkingTree(location)
498
revid = wt.last_revision()
500
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
501
except errors.NoSuchRevision:
503
revno = ".".join(str(n) for n in revno_t)
507
b = Branch.open_containing(location)[0]
514
self.outf.write(str(revno) + '\n')
517
class cmd_revision_info(Command):
518
"""Show revision number and revision id for a given revision identifier.
521
takes_args = ['revision_info*']
525
help='Branch to examine, '
526
'rather than the one containing the working directory.',
530
Option('tree', help='Show revno of working tree'),
534
def run(self, revision=None, directory=u'.', tree=False,
535
revision_info_list=[]):
538
wt = WorkingTree.open_containing(directory)[0]
541
except (errors.NoWorkingTree, errors.NotLocalUrl):
543
b = Branch.open_containing(directory)[0]
547
if revision is not None:
548
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
549
if revision_info_list is not None:
550
for rev_str in revision_info_list:
551
rev_spec = RevisionSpec.from_string(rev_str)
552
revision_ids.append(rev_spec.as_revision_id(b))
553
# No arguments supplied, default to the last revision
554
if len(revision_ids) == 0:
557
raise errors.NoWorkingTree(directory)
558
revision_ids.append(wt.last_revision())
560
revision_ids.append(b.last_revision())
564
for revision_id in revision_ids:
566
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
567
revno = '.'.join(str(i) for i in dotted_revno)
568
except errors.NoSuchRevision:
570
maxlen = max(maxlen, len(revno))
571
revinfos.append([revno, revision_id])
579
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
582
class cmd_add(Command):
583
"""Add specified files or directories.
585
In non-recursive mode, all the named items are added, regardless
586
of whether they were previously ignored. A warning is given if
587
any of the named files are already versioned.
589
In recursive mode (the default), files are treated the same way
590
but the behaviour for directories is different. Directories that
591
are already versioned do not give a warning. All directories,
592
whether already versioned or not, are searched for files or
593
subdirectories that are neither versioned or ignored, and these
594
are added. This search proceeds recursively into versioned
595
directories. If no names are given '.' is assumed.
597
Therefore simply saying 'bzr add' will version all files that
598
are currently unknown.
600
Adding a file whose parent directory is not versioned will
601
implicitly add the parent, and so on up to the root. This means
602
you should never need to explicitly add a directory, they'll just
603
get added when you add a file in the directory.
605
--dry-run will show which files would be added, but not actually
608
--file-ids-from will try to use the file ids from the supplied path.
609
It looks up ids trying to find a matching parent directory with the
610
same filename, and then by pure path. This option is rarely needed
611
but can be useful when adding the same logical file into two
612
branches that will be merged later (without showing the two different
613
adds as a conflict). It is also useful when merging another project
614
into a subdirectory of this one.
616
Any files matching patterns in the ignore list will not be added
617
unless they are explicitly mentioned.
619
takes_args = ['file*']
622
help="Don't recursively add the contents of directories."),
624
help="Show what would be done, but don't actually do anything."),
626
Option('file-ids-from',
628
help='Lookup file ids from this tree.'),
630
encoding_type = 'replace'
631
_see_also = ['remove', 'ignore']
633
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
638
if file_ids_from is not None:
640
base_tree, base_path = WorkingTree.open_containing(
642
except errors.NoWorkingTree:
643
base_branch, base_path = Branch.open_containing(
645
base_tree = base_branch.basis_tree()
647
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
648
to_file=self.outf, should_print=(not is_quiet()))
650
action = bzrlib.add.AddAction(to_file=self.outf,
651
should_print=(not is_quiet()))
654
base_tree.lock_read()
656
file_list = self._maybe_expand_globs(file_list)
657
tree, file_list = tree_files_for_add(file_list)
658
added, ignored = tree.smart_add(file_list, not
659
no_recurse, action=action, save=not dry_run)
661
if base_tree is not None:
665
for glob in sorted(ignored.keys()):
666
for path in ignored[glob]:
667
self.outf.write("ignored %s matching \"%s\"\n"
671
class cmd_mkdir(Command):
672
"""Create a new versioned directory.
674
This is equivalent to creating the directory and then adding it.
677
takes_args = ['dir+']
678
encoding_type = 'replace'
680
def run(self, dir_list):
683
wt, dd = WorkingTree.open_containing(d)
685
self.outf.write('added %s\n' % d)
688
class cmd_relpath(Command):
689
"""Show path of a file relative to root"""
691
takes_args = ['filename']
695
def run(self, filename):
696
# TODO: jam 20050106 Can relpath return a munged path if
697
# sys.stdout encoding cannot represent it?
698
tree, relpath = WorkingTree.open_containing(filename)
699
self.outf.write(relpath)
700
self.outf.write('\n')
703
class cmd_inventory(Command):
704
"""Show inventory of the current working copy or a revision.
706
It is possible to limit the output to a particular entry
707
type using the --kind option. For example: --kind file.
709
It is also possible to restrict the list of files to a specific
710
set. For example: bzr inventory --show-ids this/file
719
help='List entries of a particular kind: file, directory, symlink.',
722
takes_args = ['file*']
725
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
726
if kind and kind not in ['file', 'directory', 'symlink']:
727
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
729
revision = _get_one_revision('inventory', revision)
730
work_tree, file_list = tree_files(file_list)
731
work_tree.lock_read()
733
if revision is not None:
734
tree = revision.as_tree(work_tree.branch)
736
extra_trees = [work_tree]
742
if file_list is not None:
743
file_ids = tree.paths2ids(file_list, trees=extra_trees,
744
require_versioned=True)
745
# find_ids_across_trees may include some paths that don't
747
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
748
for file_id in file_ids if file_id in tree)
750
entries = tree.inventory.entries()
753
if tree is not work_tree:
756
for path, entry in entries:
757
if kind and kind != entry.kind:
760
self.outf.write('%-50s %s\n' % (path, entry.file_id))
762
self.outf.write(path)
763
self.outf.write('\n')
766
class cmd_mv(Command):
767
"""Move or rename a file.
770
bzr mv OLDNAME NEWNAME
772
bzr mv SOURCE... DESTINATION
774
If the last argument is a versioned directory, all the other names
775
are moved into it. Otherwise, there must be exactly two arguments
776
and the file is changed to a new name.
778
If OLDNAME does not exist on the filesystem but is versioned and
779
NEWNAME does exist on the filesystem but is not versioned, mv
780
assumes that the file has been manually moved and only updates
781
its internal inventory to reflect that change.
782
The same is valid when moving many SOURCE files to a DESTINATION.
784
Files cannot be moved between branches.
787
takes_args = ['names*']
788
takes_options = [Option("after", help="Move only the bzr identifier"
789
" of the file, because the file has already been moved."),
790
Option('auto', help='Automatically guess renames.'),
791
Option('dry-run', help='Avoid making changes when guessing renames.'),
793
aliases = ['move', 'rename']
794
encoding_type = 'replace'
796
def run(self, names_list, after=False, auto=False, dry_run=False):
798
return self.run_auto(names_list, after, dry_run)
800
raise errors.BzrCommandError('--dry-run requires --auto.')
801
if names_list is None:
803
if len(names_list) < 2:
804
raise errors.BzrCommandError("missing file argument")
805
tree, rel_names = tree_files(names_list, canonicalize=False)
806
tree.lock_tree_write()
808
self._run(tree, names_list, rel_names, after)
812
def run_auto(self, names_list, after, dry_run):
813
if names_list is not None and len(names_list) > 1:
814
raise errors.BzrCommandError('Only one path may be specified to'
817
raise errors.BzrCommandError('--after cannot be specified with'
819
work_tree, file_list = tree_files(names_list, default_branch='.')
820
work_tree.lock_tree_write()
822
rename_map.RenameMap.guess_renames(work_tree, dry_run)
826
def _run(self, tree, names_list, rel_names, after):
827
into_existing = osutils.isdir(names_list[-1])
828
if into_existing and len(names_list) == 2:
830
# a. case-insensitive filesystem and change case of dir
831
# b. move directory after the fact (if the source used to be
832
# a directory, but now doesn't exist in the working tree
833
# and the target is an existing directory, just rename it)
834
if (not tree.case_sensitive
835
and rel_names[0].lower() == rel_names[1].lower()):
836
into_existing = False
839
# 'fix' the case of a potential 'from'
840
from_id = tree.path2id(
841
tree.get_canonical_inventory_path(rel_names[0]))
842
if (not osutils.lexists(names_list[0]) and
843
from_id and inv.get_file_kind(from_id) == "directory"):
844
into_existing = False
847
# move into existing directory
848
# All entries reference existing inventory items, so fix them up
849
# for cicp file-systems.
850
rel_names = tree.get_canonical_inventory_paths(rel_names)
851
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
852
self.outf.write("%s => %s\n" % pair)
854
if len(names_list) != 2:
855
raise errors.BzrCommandError('to mv multiple files the'
856
' destination must be a versioned'
859
# for cicp file-systems: the src references an existing inventory
861
src = tree.get_canonical_inventory_path(rel_names[0])
862
# Find the canonical version of the destination: In all cases, the
863
# parent of the target must be in the inventory, so we fetch the
864
# canonical version from there (we do not always *use* the
865
# canonicalized tail portion - we may be attempting to rename the
867
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
868
dest_parent = osutils.dirname(canon_dest)
869
spec_tail = osutils.basename(rel_names[1])
870
# For a CICP file-system, we need to avoid creating 2 inventory
871
# entries that differ only by case. So regardless of the case
872
# we *want* to use (ie, specified by the user or the file-system),
873
# we must always choose to use the case of any existing inventory
874
# items. The only exception to this is when we are attempting a
875
# case-only rename (ie, canonical versions of src and dest are
877
dest_id = tree.path2id(canon_dest)
878
if dest_id is None or tree.path2id(src) == dest_id:
879
# No existing item we care about, so work out what case we
880
# are actually going to use.
882
# If 'after' is specified, the tail must refer to a file on disk.
884
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
886
# pathjoin with an empty tail adds a slash, which breaks
888
dest_parent_fq = tree.basedir
890
dest_tail = osutils.canonical_relpath(
892
osutils.pathjoin(dest_parent_fq, spec_tail))
894
# not 'after', so case as specified is used
895
dest_tail = spec_tail
897
# Use the existing item so 'mv' fails with AlreadyVersioned.
898
dest_tail = os.path.basename(canon_dest)
899
dest = osutils.pathjoin(dest_parent, dest_tail)
900
mutter("attempting to move %s => %s", src, dest)
901
tree.rename_one(src, dest, after=after)
902
self.outf.write("%s => %s\n" % (src, dest))
905
class cmd_pull(Command):
906
"""Turn this branch into a mirror of another branch.
908
This command only works on branches that have not diverged. Branches are
909
considered diverged if the destination branch's most recent commit is one
910
that has not been merged (directly or indirectly) into the parent.
912
If branches have diverged, you can use 'bzr merge' to integrate the changes
913
from one into the other. Once one branch has merged, the other should
914
be able to pull it again.
916
If you want to forget your local changes and just update your branch to
917
match the remote one, use pull --overwrite.
919
If there is no default location set, the first pull will set it. After
920
that, you can omit the location to use the default. To change the
921
default, use --remember. The value will only be saved if the remote
922
location can be accessed.
924
Note: The location can be specified either in the form of a branch,
925
or in the form of a path to a file containing a merge directive generated
929
_see_also = ['push', 'update', 'status-flags', 'send']
930
takes_options = ['remember', 'overwrite', 'revision',
931
custom_help('verbose',
932
help='Show logs of pulled revisions.'),
934
help='Branch to pull into, '
935
'rather than the one containing the working directory.',
940
help="Perform a local pull in a bound "
941
"branch. Local pulls are not applied to "
945
takes_args = ['location?']
946
encoding_type = 'replace'
948
def run(self, location=None, remember=False, overwrite=False,
949
revision=None, verbose=False,
950
directory=None, local=False):
951
# FIXME: too much stuff is in the command class
954
if directory is None:
957
tree_to = WorkingTree.open_containing(directory)[0]
958
branch_to = tree_to.branch
959
except errors.NoWorkingTree:
961
branch_to = Branch.open_containing(directory)[0]
963
if local and not branch_to.get_bound_location():
964
raise errors.LocalRequiresBoundBranch()
966
possible_transports = []
967
if location is not None:
969
mergeable = bundle.read_mergeable_from_url(location,
970
possible_transports=possible_transports)
971
except errors.NotABundle:
974
stored_loc = branch_to.get_parent()
976
if stored_loc is None:
977
raise errors.BzrCommandError("No pull location known or"
980
display_url = urlutils.unescape_for_display(stored_loc,
983
self.outf.write("Using saved parent location: %s\n" % display_url)
984
location = stored_loc
986
revision = _get_one_revision('pull', revision)
987
if mergeable is not None:
988
if revision is not None:
989
raise errors.BzrCommandError(
990
'Cannot use -r with merge directives or bundles')
991
mergeable.install_revisions(branch_to.repository)
992
base_revision_id, revision_id, verified = \
993
mergeable.get_merge_request(branch_to.repository)
994
branch_from = branch_to
996
branch_from = Branch.open(location,
997
possible_transports=possible_transports)
999
if branch_to.get_parent() is None or remember:
1000
branch_to.set_parent(branch_from.base)
1002
if branch_from is not branch_to:
1003
branch_from.lock_read()
1005
if revision is not None:
1006
revision_id = revision.as_revision_id(branch_from)
1008
branch_to.lock_write()
1010
if tree_to is not None:
1011
view_info = _get_view_info_for_change_reporter(tree_to)
1012
change_reporter = delta._ChangeReporter(
1013
unversioned_filter=tree_to.is_ignored,
1014
view_info=view_info)
1015
result = tree_to.pull(
1016
branch_from, overwrite, revision_id, change_reporter,
1017
possible_transports=possible_transports, local=local)
1019
result = branch_to.pull(
1020
branch_from, overwrite, revision_id, local=local)
1022
result.report(self.outf)
1023
if verbose and result.old_revid != result.new_revid:
1024
log.show_branch_change(
1025
branch_to, self.outf, result.old_revno,
1030
if branch_from is not branch_to:
1031
branch_from.unlock()
1034
class cmd_push(Command):
1035
"""Update a mirror of this branch.
1037
The target branch will not have its working tree populated because this
1038
is both expensive, and is not supported on remote file systems.
1040
Some smart servers or protocols *may* put the working tree in place in
1043
This command only works on branches that have not diverged. Branches are
1044
considered diverged if the destination branch's most recent commit is one
1045
that has not been merged (directly or indirectly) by the source branch.
1047
If branches have diverged, you can use 'bzr push --overwrite' to replace
1048
the other branch completely, discarding its unmerged changes.
1050
If you want to ensure you have the different changes in the other branch,
1051
do a merge (see bzr help merge) from the other branch, and commit that.
1052
After that you will be able to do a push without '--overwrite'.
1054
If there is no default push location set, the first push will set it.
1055
After that, you can omit the location to use the default. To change the
1056
default, use --remember. The value will only be saved if the remote
1057
location can be accessed.
1060
_see_also = ['pull', 'update', 'working-trees']
1061
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1062
Option('create-prefix',
1063
help='Create the path leading up to the branch '
1064
'if it does not already exist.'),
1066
help='Branch to push from, '
1067
'rather than the one containing the working directory.',
1071
Option('use-existing-dir',
1072
help='By default push will fail if the target'
1073
' directory exists, but does not already'
1074
' have a control directory. This flag will'
1075
' allow push to proceed.'),
1077
help='Create a stacked branch that references the public location '
1078
'of the parent branch.'),
1079
Option('stacked-on',
1080
help='Create a stacked branch that refers to another branch '
1081
'for the commit history. Only the work not present in the '
1082
'referenced branch is included in the branch created.',
1085
help='Refuse to push if there are uncommitted changes in'
1086
' the working tree, --no-strict disables the check.'),
1088
takes_args = ['location?']
1089
encoding_type = 'replace'
1091
def run(self, location=None, remember=False, overwrite=False,
1092
create_prefix=False, verbose=False, revision=None,
1093
use_existing_dir=False, directory=None, stacked_on=None,
1094
stacked=False, strict=None):
1095
from bzrlib.push import _show_push_branch
1097
if directory is None:
1099
# Get the source branch
1101
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1103
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1104
if strict is None: strict = True # default value
1105
# Get the tip's revision_id
1106
revision = _get_one_revision('push', revision)
1107
if revision is not None:
1108
revision_id = revision.in_history(br_from).rev_id
1111
if strict and tree is not None and revision_id is None:
1112
if (tree.has_changes(tree.basis_tree())
1113
or len(tree.get_parent_ids()) > 1):
1114
raise errors.UncommittedChanges(
1115
tree, more='Use --no-strict to force the push.')
1116
if tree.last_revision() != tree.branch.last_revision():
1117
# The tree has lost sync with its branch, there is little
1118
# chance that the user is aware of it but he can still force
1119
# the push with --no-strict
1120
raise errors.OutOfDateTree(
1121
tree, more='Use --no-strict to force the push.')
1123
# Get the stacked_on branch, if any
1124
if stacked_on is not None:
1125
stacked_on = urlutils.normalize_url(stacked_on)
1127
parent_url = br_from.get_parent()
1129
parent = Branch.open(parent_url)
1130
stacked_on = parent.get_public_branch()
1132
# I considered excluding non-http url's here, thus forcing
1133
# 'public' branches only, but that only works for some
1134
# users, so it's best to just depend on the user spotting an
1135
# error by the feedback given to them. RBC 20080227.
1136
stacked_on = parent_url
1138
raise errors.BzrCommandError(
1139
"Could not determine branch to refer to.")
1141
# Get the destination location
1142
if location is None:
1143
stored_loc = br_from.get_push_location()
1144
if stored_loc is None:
1145
raise errors.BzrCommandError(
1146
"No push location known or specified.")
1148
display_url = urlutils.unescape_for_display(stored_loc,
1150
self.outf.write("Using saved push location: %s\n" % display_url)
1151
location = stored_loc
1153
_show_push_branch(br_from, revision_id, location, self.outf,
1154
verbose=verbose, overwrite=overwrite, remember=remember,
1155
stacked_on=stacked_on, create_prefix=create_prefix,
1156
use_existing_dir=use_existing_dir)
1159
class cmd_branch(Command):
1160
"""Create a new branch that is a copy of an existing branch.
1162
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1163
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1164
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1165
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1166
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1169
To retrieve the branch as of a particular revision, supply the --revision
1170
parameter, as in "branch foo/bar -r 5".
1173
_see_also = ['checkout']
1174
takes_args = ['from_location', 'to_location?']
1175
takes_options = ['revision', Option('hardlink',
1176
help='Hard-link working tree files where possible.'),
1178
help="Create a branch without a working-tree."),
1180
help="Switch the checkout in the current directory "
1181
"to the new branch."),
1183
help='Create a stacked branch referring to the source branch. '
1184
'The new branch will depend on the availability of the source '
1185
'branch for all operations.'),
1186
Option('standalone',
1187
help='Do not use a shared repository, even if available.'),
1188
Option('use-existing-dir',
1189
help='By default branch will fail if the target'
1190
' directory exists, but does not already'
1191
' have a control directory. This flag will'
1192
' allow branch to proceed.'),
1194
aliases = ['get', 'clone']
1196
def run(self, from_location, to_location=None, revision=None,
1197
hardlink=False, stacked=False, standalone=False, no_tree=False,
1198
use_existing_dir=False, switch=False):
1199
from bzrlib import switch as _mod_switch
1200
from bzrlib.tag import _merge_tags_if_possible
1201
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1203
if (accelerator_tree is not None and
1204
accelerator_tree.supports_content_filtering()):
1205
accelerator_tree = None
1206
revision = _get_one_revision('branch', revision)
1209
if revision is not None:
1210
revision_id = revision.as_revision_id(br_from)
1212
# FIXME - wt.last_revision, fallback to branch, fall back to
1213
# None or perhaps NULL_REVISION to mean copy nothing
1215
revision_id = br_from.last_revision()
1216
if to_location is None:
1217
to_location = urlutils.derive_to_location(from_location)
1218
to_transport = transport.get_transport(to_location)
1220
to_transport.mkdir('.')
1221
except errors.FileExists:
1222
if not use_existing_dir:
1223
raise errors.BzrCommandError('Target directory "%s" '
1224
'already exists.' % to_location)
1227
bzrdir.BzrDir.open_from_transport(to_transport)
1228
except errors.NotBranchError:
1231
raise errors.AlreadyBranchError(to_location)
1232
except errors.NoSuchFile:
1233
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1236
# preserve whatever source format we have.
1237
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1238
possible_transports=[to_transport],
1239
accelerator_tree=accelerator_tree,
1240
hardlink=hardlink, stacked=stacked,
1241
force_new_repo=standalone,
1242
create_tree_if_local=not no_tree,
1243
source_branch=br_from)
1244
branch = dir.open_branch()
1245
except errors.NoSuchRevision:
1246
to_transport.delete_tree('.')
1247
msg = "The branch %s has no revision %s." % (from_location,
1249
raise errors.BzrCommandError(msg)
1250
_merge_tags_if_possible(br_from, branch)
1251
# If the source branch is stacked, the new branch may
1252
# be stacked whether we asked for that explicitly or not.
1253
# We therefore need a try/except here and not just 'if stacked:'
1255
note('Created new stacked branch referring to %s.' %
1256
branch.get_stacked_on_url())
1257
except (errors.NotStacked, errors.UnstackableBranchFormat,
1258
errors.UnstackableRepositoryFormat), e:
1259
note('Branched %d revision(s).' % branch.revno())
1261
# Switch to the new branch
1262
wt, _ = WorkingTree.open_containing('.')
1263
_mod_switch.switch(wt.bzrdir, branch)
1264
note('Switched to branch: %s',
1265
urlutils.unescape_for_display(branch.base, 'utf-8'))
1270
class cmd_checkout(Command):
1271
"""Create a new checkout of an existing branch.
1273
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1274
the branch found in '.'. This is useful if you have removed the working tree
1275
or if it was never created - i.e. if you pushed the branch to its current
1276
location using SFTP.
1278
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1279
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1280
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1281
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1282
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1285
To retrieve the branch as of a particular revision, supply the --revision
1286
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1287
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1291
_see_also = ['checkouts', 'branch']
1292
takes_args = ['branch_location?', 'to_location?']
1293
takes_options = ['revision',
1294
Option('lightweight',
1295
help="Perform a lightweight checkout. Lightweight "
1296
"checkouts depend on access to the branch for "
1297
"every operation. Normal checkouts can perform "
1298
"common operations like diff and status without "
1299
"such access, and also support local commits."
1301
Option('files-from', type=str,
1302
help="Get file contents from this tree."),
1304
help='Hard-link working tree files where possible.'
1309
def run(self, branch_location=None, to_location=None, revision=None,
1310
lightweight=False, files_from=None, hardlink=False):
1311
if branch_location is None:
1312
branch_location = osutils.getcwd()
1313
to_location = branch_location
1314
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1316
revision = _get_one_revision('checkout', revision)
1317
if files_from is not None:
1318
accelerator_tree = WorkingTree.open(files_from)
1319
if revision is not None:
1320
revision_id = revision.as_revision_id(source)
1323
if to_location is None:
1324
to_location = urlutils.derive_to_location(branch_location)
1325
# if the source and to_location are the same,
1326
# and there is no working tree,
1327
# then reconstitute a branch
1328
if (osutils.abspath(to_location) ==
1329
osutils.abspath(branch_location)):
1331
source.bzrdir.open_workingtree()
1332
except errors.NoWorkingTree:
1333
source.bzrdir.create_workingtree(revision_id)
1335
source.create_checkout(to_location, revision_id, lightweight,
1336
accelerator_tree, hardlink)
1339
class cmd_renames(Command):
1340
"""Show list of renamed files.
1342
# TODO: Option to show renames between two historical versions.
1344
# TODO: Only show renames under dir, rather than in the whole branch.
1345
_see_also = ['status']
1346
takes_args = ['dir?']
1349
def run(self, dir=u'.'):
1350
tree = WorkingTree.open_containing(dir)[0]
1353
new_inv = tree.inventory
1354
old_tree = tree.basis_tree()
1355
old_tree.lock_read()
1357
old_inv = old_tree.inventory
1359
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1360
for f, paths, c, v, p, n, k, e in iterator:
1361
if paths[0] == paths[1]:
1365
renames.append(paths)
1367
for old_name, new_name in renames:
1368
self.outf.write("%s => %s\n" % (old_name, new_name))
1375
class cmd_update(Command):
1376
"""Update a tree to have the latest code committed to its branch.
1378
This will perform a merge into the working tree, and may generate
1379
conflicts. If you have any local changes, you will still
1380
need to commit them after the update for the update to be complete.
1382
If you want to discard your local changes, you can just do a
1383
'bzr revert' instead of 'bzr commit' after the update.
1386
_see_also = ['pull', 'working-trees', 'status-flags']
1387
takes_args = ['dir?']
1390
def run(self, dir='.'):
1391
tree = WorkingTree.open_containing(dir)[0]
1392
possible_transports = []
1393
master = tree.branch.get_master_branch(
1394
possible_transports=possible_transports)
1395
if master is not None:
1398
tree.lock_tree_write()
1400
existing_pending_merges = tree.get_parent_ids()[1:]
1401
last_rev = _mod_revision.ensure_null(tree.last_revision())
1402
if last_rev == _mod_revision.ensure_null(
1403
tree.branch.last_revision()):
1404
# may be up to date, check master too.
1405
if master is None or last_rev == _mod_revision.ensure_null(
1406
master.last_revision()):
1407
revno = tree.branch.revision_id_to_revno(last_rev)
1408
note("Tree is up to date at revision %d." % (revno,))
1410
view_info = _get_view_info_for_change_reporter(tree)
1411
conflicts = tree.update(
1412
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1413
view_info=view_info), possible_transports=possible_transports)
1414
revno = tree.branch.revision_id_to_revno(
1415
_mod_revision.ensure_null(tree.last_revision()))
1416
note('Updated to revision %d.' % (revno,))
1417
if tree.get_parent_ids()[1:] != existing_pending_merges:
1418
note('Your local commits will now show as pending merges with '
1419
"'bzr status', and can be committed with 'bzr commit'.")
1428
class cmd_info(Command):
1429
"""Show information about a working tree, branch or repository.
1431
This command will show all known locations and formats associated to the
1432
tree, branch or repository.
1434
In verbose mode, statistical information is included with each report.
1435
To see extended statistic information, use a verbosity level of 2 or
1436
higher by specifying the verbose option multiple times, e.g. -vv.
1438
Branches and working trees will also report any missing revisions.
1442
Display information on the format and related locations:
1446
Display the above together with extended format information and
1447
basic statistics (like the number of files in the working tree and
1448
number of revisions in the branch and repository):
1452
Display the above together with number of committers to the branch:
1456
_see_also = ['revno', 'working-trees', 'repositories']
1457
takes_args = ['location?']
1458
takes_options = ['verbose']
1459
encoding_type = 'replace'
1462
def run(self, location=None, verbose=False):
1464
noise_level = get_verbosity_level()
1467
from bzrlib.info import show_bzrdir_info
1468
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1469
verbose=noise_level, outfile=self.outf)
1472
class cmd_remove(Command):
1473
"""Remove files or directories.
1475
This makes bzr stop tracking changes to the specified files. bzr will delete
1476
them if they can easily be recovered using revert. If no options or
1477
parameters are given bzr will scan for files that are being tracked by bzr
1478
but missing in your tree and stop tracking them for you.
1480
takes_args = ['file*']
1481
takes_options = ['verbose',
1482
Option('new', help='Only remove files that have never been committed.'),
1483
RegistryOption.from_kwargs('file-deletion-strategy',
1484
'The file deletion mode to be used.',
1485
title='Deletion Strategy', value_switches=True, enum_switch=False,
1486
safe='Only delete files if they can be'
1487
' safely recovered (default).',
1488
keep='Delete from bzr but leave the working copy.',
1489
force='Delete all the specified files, even if they can not be '
1490
'recovered and even if they are non-empty directories.')]
1491
aliases = ['rm', 'del']
1492
encoding_type = 'replace'
1494
def run(self, file_list, verbose=False, new=False,
1495
file_deletion_strategy='safe'):
1496
tree, file_list = tree_files(file_list)
1498
if file_list is not None:
1499
file_list = [f for f in file_list]
1503
# Heuristics should probably all move into tree.remove_smart or
1506
added = tree.changes_from(tree.basis_tree(),
1507
specific_files=file_list).added
1508
file_list = sorted([f[0] for f in added], reverse=True)
1509
if len(file_list) == 0:
1510
raise errors.BzrCommandError('No matching files.')
1511
elif file_list is None:
1512
# missing files show up in iter_changes(basis) as
1513
# versioned-with-no-kind.
1515
for change in tree.iter_changes(tree.basis_tree()):
1516
# Find paths in the working tree that have no kind:
1517
if change[1][1] is not None and change[6][1] is None:
1518
missing.append(change[1][1])
1519
file_list = sorted(missing, reverse=True)
1520
file_deletion_strategy = 'keep'
1521
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1522
keep_files=file_deletion_strategy=='keep',
1523
force=file_deletion_strategy=='force')
1528
class cmd_file_id(Command):
1529
"""Print file_id of a particular file or directory.
1531
The file_id is assigned when the file is first added and remains the
1532
same through all revisions where the file exists, even when it is
1537
_see_also = ['inventory', 'ls']
1538
takes_args = ['filename']
1541
def run(self, filename):
1542
tree, relpath = WorkingTree.open_containing(filename)
1543
i = tree.path2id(relpath)
1545
raise errors.NotVersionedError(filename)
1547
self.outf.write(i + '\n')
1550
class cmd_file_path(Command):
1551
"""Print path of file_ids to a file or directory.
1553
This prints one line for each directory down to the target,
1554
starting at the branch root.
1558
takes_args = ['filename']
1561
def run(self, filename):
1562
tree, relpath = WorkingTree.open_containing(filename)
1563
fid = tree.path2id(relpath)
1565
raise errors.NotVersionedError(filename)
1566
segments = osutils.splitpath(relpath)
1567
for pos in range(1, len(segments) + 1):
1568
path = osutils.joinpath(segments[:pos])
1569
self.outf.write("%s\n" % tree.path2id(path))
1572
class cmd_reconcile(Command):
1573
"""Reconcile bzr metadata in a branch.
1575
This can correct data mismatches that may have been caused by
1576
previous ghost operations or bzr upgrades. You should only
1577
need to run this command if 'bzr check' or a bzr developer
1578
advises you to run it.
1580
If a second branch is provided, cross-branch reconciliation is
1581
also attempted, which will check that data like the tree root
1582
id which was not present in very early bzr versions is represented
1583
correctly in both branches.
1585
At the same time it is run it may recompress data resulting in
1586
a potential saving in disk space or performance gain.
1588
The branch *MUST* be on a listable system such as local disk or sftp.
1591
_see_also = ['check']
1592
takes_args = ['branch?']
1594
def run(self, branch="."):
1595
from bzrlib.reconcile import reconcile
1596
dir = bzrdir.BzrDir.open(branch)
1600
class cmd_revision_history(Command):
1601
"""Display the list of revision ids on a branch."""
1604
takes_args = ['location?']
1609
def run(self, location="."):
1610
branch = Branch.open_containing(location)[0]
1611
for revid in branch.revision_history():
1612
self.outf.write(revid)
1613
self.outf.write('\n')
1616
class cmd_ancestry(Command):
1617
"""List all revisions merged into this branch."""
1619
_see_also = ['log', 'revision-history']
1620
takes_args = ['location?']
1625
def run(self, location="."):
1627
wt = WorkingTree.open_containing(location)[0]
1628
except errors.NoWorkingTree:
1629
b = Branch.open(location)
1630
last_revision = b.last_revision()
1633
last_revision = wt.last_revision()
1635
revision_ids = b.repository.get_ancestry(last_revision)
1637
for revision_id in revision_ids:
1638
self.outf.write(revision_id + '\n')
1641
class cmd_init(Command):
1642
"""Make a directory into a versioned branch.
1644
Use this to create an empty branch, or before importing an
1647
If there is a repository in a parent directory of the location, then
1648
the history of the branch will be stored in the repository. Otherwise
1649
init creates a standalone branch which carries its own history
1650
in the .bzr directory.
1652
If there is already a branch at the location but it has no working tree,
1653
the tree can be populated with 'bzr checkout'.
1655
Recipe for importing a tree of files::
1661
bzr commit -m "imported project"
1664
_see_also = ['init-repository', 'branch', 'checkout']
1665
takes_args = ['location?']
1667
Option('create-prefix',
1668
help='Create the path leading up to the branch '
1669
'if it does not already exist.'),
1670
RegistryOption('format',
1671
help='Specify a format for this branch. '
1672
'See "help formats".',
1673
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1674
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1675
value_switches=True,
1676
title="Branch format",
1678
Option('append-revisions-only',
1679
help='Never change revnos or the existing log.'
1680
' Append revisions to it only.')
1682
def run(self, location=None, format=None, append_revisions_only=False,
1683
create_prefix=False):
1685
format = bzrdir.format_registry.make_bzrdir('default')
1686
if location is None:
1689
to_transport = transport.get_transport(location)
1691
# The path has to exist to initialize a
1692
# branch inside of it.
1693
# Just using os.mkdir, since I don't
1694
# believe that we want to create a bunch of
1695
# locations if the user supplies an extended path
1697
to_transport.ensure_base()
1698
except errors.NoSuchFile:
1699
if not create_prefix:
1700
raise errors.BzrCommandError("Parent directory of %s"
1702
"\nYou may supply --create-prefix to create all"
1703
" leading parent directories."
1705
to_transport.create_prefix()
1708
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1709
except errors.NotBranchError:
1710
# really a NotBzrDir error...
1711
create_branch = bzrdir.BzrDir.create_branch_convenience
1712
branch = create_branch(to_transport.base, format=format,
1713
possible_transports=[to_transport])
1714
a_bzrdir = branch.bzrdir
1716
from bzrlib.transport.local import LocalTransport
1717
if a_bzrdir.has_branch():
1718
if (isinstance(to_transport, LocalTransport)
1719
and not a_bzrdir.has_workingtree()):
1720
raise errors.BranchExistsWithoutWorkingTree(location)
1721
raise errors.AlreadyBranchError(location)
1722
branch = a_bzrdir.create_branch()
1723
a_bzrdir.create_workingtree()
1724
if append_revisions_only:
1726
branch.set_append_revisions_only(True)
1727
except errors.UpgradeRequired:
1728
raise errors.BzrCommandError('This branch format cannot be set'
1729
' to append-revisions-only. Try --default.')
1731
from bzrlib.info import describe_layout, describe_format
1733
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1734
except (errors.NoWorkingTree, errors.NotLocalUrl):
1736
repository = branch.repository
1737
layout = describe_layout(repository, branch, tree).lower()
1738
format = describe_format(a_bzrdir, repository, branch, tree)
1739
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1740
if repository.is_shared():
1741
#XXX: maybe this can be refactored into transport.path_or_url()
1742
url = repository.bzrdir.root_transport.external_url()
1744
url = urlutils.local_path_from_url(url)
1745
except errors.InvalidURL:
1747
self.outf.write("Using shared repository: %s\n" % url)
1750
class cmd_init_repository(Command):
1751
"""Create a shared repository to hold branches.
1753
New branches created under the repository directory will store their
1754
revisions in the repository, not in the branch directory.
1756
If the --no-trees option is used then the branches in the repository
1757
will not have working trees by default.
1760
Create a shared repositories holding just branches::
1762
bzr init-repo --no-trees repo
1765
Make a lightweight checkout elsewhere::
1767
bzr checkout --lightweight repo/trunk trunk-checkout
1772
_see_also = ['init', 'branch', 'checkout', 'repositories']
1773
takes_args = ["location"]
1774
takes_options = [RegistryOption('format',
1775
help='Specify a format for this repository. See'
1776
' "bzr help formats" for details.',
1777
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1778
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1779
value_switches=True, title='Repository format'),
1781
help='Branches in the repository will default to'
1782
' not having a working tree.'),
1784
aliases = ["init-repo"]
1786
def run(self, location, format=None, no_trees=False):
1788
format = bzrdir.format_registry.make_bzrdir('default')
1790
if location is None:
1793
to_transport = transport.get_transport(location)
1794
to_transport.ensure_base()
1796
newdir = format.initialize_on_transport(to_transport)
1797
repo = newdir.create_repository(shared=True)
1798
repo.set_make_working_trees(not no_trees)
1800
from bzrlib.info import show_bzrdir_info
1801
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1804
class cmd_diff(Command):
1805
"""Show differences in the working tree, between revisions or branches.
1807
If no arguments are given, all changes for the current tree are listed.
1808
If files are given, only the changes in those files are listed.
1809
Remote and multiple branches can be compared by using the --old and
1810
--new options. If not provided, the default for both is derived from
1811
the first argument, if any, or the current tree if no arguments are
1814
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1815
produces patches suitable for "patch -p1".
1819
2 - unrepresentable changes
1824
Shows the difference in the working tree versus the last commit::
1828
Difference between the working tree and revision 1::
1832
Difference between revision 2 and revision 1::
1836
Difference between revision 2 and revision 1 for branch xxx::
1840
Show just the differences for file NEWS::
1844
Show the differences in working tree xxx for file NEWS::
1848
Show the differences from branch xxx to this working tree:
1852
Show the differences between two branches for file NEWS::
1854
bzr diff --old xxx --new yyy NEWS
1856
Same as 'bzr diff' but prefix paths with old/ and new/::
1858
bzr diff --prefix old/:new/
1860
_see_also = ['status']
1861
takes_args = ['file*']
1863
Option('diff-options', type=str,
1864
help='Pass these options to the external diff program.'),
1865
Option('prefix', type=str,
1867
help='Set prefixes added to old and new filenames, as '
1868
'two values separated by a colon. (eg "old/:new/").'),
1870
help='Branch/tree to compare from.',
1874
help='Branch/tree to compare to.',
1880
help='Use this command to compare files.',
1884
aliases = ['di', 'dif']
1885
encoding_type = 'exact'
1888
def run(self, revision=None, file_list=None, diff_options=None,
1889
prefix=None, old=None, new=None, using=None):
1890
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1892
if (prefix is None) or (prefix == '0'):
1900
old_label, new_label = prefix.split(":")
1902
raise errors.BzrCommandError(
1903
'--prefix expects two values separated by a colon'
1904
' (eg "old/:new/")')
1906
if revision and len(revision) > 2:
1907
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1908
' one or two revision specifiers')
1910
old_tree, new_tree, specific_files, extra_trees = \
1911
_get_trees_to_diff(file_list, revision, old, new,
1913
return show_diff_trees(old_tree, new_tree, sys.stdout,
1914
specific_files=specific_files,
1915
external_diff_options=diff_options,
1916
old_label=old_label, new_label=new_label,
1917
extra_trees=extra_trees, using=using)
1920
class cmd_deleted(Command):
1921
"""List files deleted in the working tree.
1923
# TODO: Show files deleted since a previous revision, or
1924
# between two revisions.
1925
# TODO: Much more efficient way to do this: read in new
1926
# directories with readdir, rather than stating each one. Same
1927
# level of effort but possibly much less IO. (Or possibly not,
1928
# if the directories are very large...)
1929
_see_also = ['status', 'ls']
1930
takes_options = ['show-ids']
1933
def run(self, show_ids=False):
1934
tree = WorkingTree.open_containing(u'.')[0]
1937
old = tree.basis_tree()
1940
for path, ie in old.inventory.iter_entries():
1941
if not tree.has_id(ie.file_id):
1942
self.outf.write(path)
1944
self.outf.write(' ')
1945
self.outf.write(ie.file_id)
1946
self.outf.write('\n')
1953
class cmd_modified(Command):
1954
"""List files modified in working tree.
1958
_see_also = ['status', 'ls']
1961
help='Write an ascii NUL (\\0) separator '
1962
'between files rather than a newline.')
1966
def run(self, null=False):
1967
tree = WorkingTree.open_containing(u'.')[0]
1968
td = tree.changes_from(tree.basis_tree())
1969
for path, id, kind, text_modified, meta_modified in td.modified:
1971
self.outf.write(path + '\0')
1973
self.outf.write(osutils.quotefn(path) + '\n')
1976
class cmd_added(Command):
1977
"""List files added in working tree.
1981
_see_also = ['status', 'ls']
1984
help='Write an ascii NUL (\\0) separator '
1985
'between files rather than a newline.')
1989
def run(self, null=False):
1990
wt = WorkingTree.open_containing(u'.')[0]
1993
basis = wt.basis_tree()
1996
basis_inv = basis.inventory
1999
if file_id in basis_inv:
2001
if inv.is_root(file_id) and len(basis_inv) == 0:
2003
path = inv.id2path(file_id)
2004
if not os.access(osutils.abspath(path), os.F_OK):
2007
self.outf.write(path + '\0')
2009
self.outf.write(osutils.quotefn(path) + '\n')
2016
class cmd_root(Command):
2017
"""Show the tree root directory.
2019
The root is the nearest enclosing directory with a .bzr control
2022
takes_args = ['filename?']
2024
def run(self, filename=None):
2025
"""Print the branch root."""
2026
tree = WorkingTree.open_containing(filename)[0]
2027
self.outf.write(tree.basedir + '\n')
2030
def _parse_limit(limitstring):
2032
return int(limitstring)
2034
msg = "The limit argument must be an integer."
2035
raise errors.BzrCommandError(msg)
2038
def _parse_levels(s):
2042
msg = "The levels argument must be an integer."
2043
raise errors.BzrCommandError(msg)
2046
class cmd_log(Command):
2047
"""Show historical log for a branch or subset of a branch.
2049
log is bzr's default tool for exploring the history of a branch.
2050
The branch to use is taken from the first parameter. If no parameters
2051
are given, the branch containing the working directory is logged.
2052
Here are some simple examples::
2054
bzr log log the current branch
2055
bzr log foo.py log a file in its branch
2056
bzr log http://server/branch log a branch on a server
2058
The filtering, ordering and information shown for each revision can
2059
be controlled as explained below. By default, all revisions are
2060
shown sorted (topologically) so that newer revisions appear before
2061
older ones and descendants always appear before ancestors. If displayed,
2062
merged revisions are shown indented under the revision in which they
2067
The log format controls how information about each revision is
2068
displayed. The standard log formats are called ``long``, ``short``
2069
and ``line``. The default is long. See ``bzr help log-formats``
2070
for more details on log formats.
2072
The following options can be used to control what information is
2075
-l N display a maximum of N revisions
2076
-n N display N levels of revisions (0 for all, 1 for collapsed)
2077
-v display a status summary (delta) for each revision
2078
-p display a diff (patch) for each revision
2079
--show-ids display revision-ids (and file-ids), not just revnos
2081
Note that the default number of levels to display is a function of the
2082
log format. If the -n option is not used, the standard log formats show
2083
just the top level (mainline).
2085
Status summaries are shown using status flags like A, M, etc. To see
2086
the changes explained using words like ``added`` and ``modified``
2087
instead, use the -vv option.
2091
To display revisions from oldest to newest, use the --forward option.
2092
In most cases, using this option will have little impact on the total
2093
time taken to produce a log, though --forward does not incrementally
2094
display revisions like --reverse does when it can.
2096
:Revision filtering:
2098
The -r option can be used to specify what revision or range of revisions
2099
to filter against. The various forms are shown below::
2101
-rX display revision X
2102
-rX.. display revision X and later
2103
-r..Y display up to and including revision Y
2104
-rX..Y display from X to Y inclusive
2106
See ``bzr help revisionspec`` for details on how to specify X and Y.
2107
Some common examples are given below::
2109
-r-1 show just the tip
2110
-r-10.. show the last 10 mainline revisions
2111
-rsubmit:.. show what's new on this branch
2112
-rancestor:path.. show changes since the common ancestor of this
2113
branch and the one at location path
2114
-rdate:yesterday.. show changes since yesterday
2116
When logging a range of revisions using -rX..Y, log starts at
2117
revision Y and searches back in history through the primary
2118
("left-hand") parents until it finds X. When logging just the
2119
top level (using -n1), an error is reported if X is not found
2120
along the way. If multi-level logging is used (-n0), X may be
2121
a nested merge revision and the log will be truncated accordingly.
2125
If parameters are given and the first one is not a branch, the log
2126
will be filtered to show only those revisions that changed the
2127
nominated files or directories.
2129
Filenames are interpreted within their historical context. To log a
2130
deleted file, specify a revision range so that the file existed at
2131
the end or start of the range.
2133
Historical context is also important when interpreting pathnames of
2134
renamed files/directories. Consider the following example:
2136
* revision 1: add tutorial.txt
2137
* revision 2: modify tutorial.txt
2138
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2142
* ``bzr log guide.txt`` will log the file added in revision 1
2144
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2146
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2147
the original file in revision 2.
2149
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2150
was no file called guide.txt in revision 2.
2152
Renames are always followed by log. By design, there is no need to
2153
explicitly ask for this (and no way to stop logging a file back
2154
until it was last renamed).
2158
The --message option can be used for finding revisions that match a
2159
regular expression in a commit message.
2163
GUI tools and IDEs are often better at exploring history than command
2164
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2165
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2166
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2168
Web interfaces are often better at exploring history than command line
2169
tools, particularly for branches on servers. You may prefer Loggerhead
2170
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2172
You may find it useful to add the aliases below to ``bazaar.conf``::
2176
top = log -l10 --line
2179
``bzr tip`` will then show the latest revision while ``bzr top``
2180
will show the last 10 mainline revisions. To see the details of a
2181
particular revision X, ``bzr show -rX``.
2183
If you are interested in looking deeper into a particular merge X,
2184
use ``bzr log -n0 -rX``.
2186
``bzr log -v`` on a branch with lots of history is currently
2187
very slow. A fix for this issue is currently under development.
2188
With or without that fix, it is recommended that a revision range
2189
be given when using the -v option.
2191
bzr has a generic full-text matching plugin, bzr-search, that can be
2192
used to find revisions matching user names, commit messages, etc.
2193
Among other features, this plugin can find all revisions containing
2194
a list of words but not others.
2196
When exploring non-mainline history on large projects with deep
2197
history, the performance of log can be greatly improved by installing
2198
the historycache plugin. This plugin buffers historical information
2199
trading disk space for faster speed.
2201
takes_args = ['file*']
2202
_see_also = ['log-formats', 'revisionspec']
2205
help='Show from oldest to newest.'),
2207
custom_help('verbose',
2208
help='Show files changed in each revision.'),
2212
type=bzrlib.option._parse_revision_str,
2214
help='Show just the specified revision.'
2215
' See also "help revisionspec".'),
2219
help='Number of levels to display - 0 for all, 1 for flat.',
2221
type=_parse_levels),
2224
help='Show revisions whose message matches this '
2225
'regular expression.',
2229
help='Limit the output to the first N revisions.',
2234
help='Show changes made in each revision as a patch.'),
2235
Option('include-merges',
2236
help='Show merged revisions like --levels 0 does.'),
2238
encoding_type = 'replace'
2241
def run(self, file_list=None, timezone='original',
2252
include_merges=False):
2253
from bzrlib.log import (
2255
make_log_request_dict,
2256
_get_info_for_log_files,
2258
direction = (forward and 'forward') or 'reverse'
2263
raise errors.BzrCommandError(
2264
'--levels and --include-merges are mutually exclusive')
2266
if change is not None:
2268
raise errors.RangeInChangeOption()
2269
if revision is not None:
2270
raise errors.BzrCommandError(
2271
'--revision and --change are mutually exclusive')
2276
filter_by_dir = False
2280
# find the file ids to log and check for directory filtering
2281
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2282
revision, file_list)
2283
for relpath, file_id, kind in file_info_list:
2285
raise errors.BzrCommandError(
2286
"Path unknown at end or start of revision range: %s" %
2288
# If the relpath is the top of the tree, we log everything
2293
file_ids.append(file_id)
2294
filter_by_dir = filter_by_dir or (
2295
kind in ['directory', 'tree-reference'])
2298
# FIXME ? log the current subdir only RBC 20060203
2299
if revision is not None \
2300
and len(revision) > 0 and revision[0].get_branch():
2301
location = revision[0].get_branch()
2304
dir, relpath = bzrdir.BzrDir.open_containing(location)
2305
b = dir.open_branch()
2307
rev1, rev2 = _get_revision_range(revision, b, self.name())
2309
# Decide on the type of delta & diff filtering to use
2310
# TODO: add an --all-files option to make this configurable & consistent
2318
diff_type = 'partial'
2322
# Build the log formatter
2323
if log_format is None:
2324
log_format = log.log_formatter_registry.get_default(b)
2325
lf = log_format(show_ids=show_ids, to_file=self.outf,
2326
show_timezone=timezone,
2327
delta_format=get_verbosity_level(),
2329
show_advice=levels is None)
2331
# Choose the algorithm for doing the logging. It's annoying
2332
# having multiple code paths like this but necessary until
2333
# the underlying repository format is faster at generating
2334
# deltas or can provide everything we need from the indices.
2335
# The default algorithm - match-using-deltas - works for
2336
# multiple files and directories and is faster for small
2337
# amounts of history (200 revisions say). However, it's too
2338
# slow for logging a single file in a repository with deep
2339
# history, i.e. > 10K revisions. In the spirit of "do no
2340
# evil when adding features", we continue to use the
2341
# original algorithm - per-file-graph - for the "single
2342
# file that isn't a directory without showing a delta" case.
2343
partial_history = revision and b.repository._format.supports_chks
2344
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2345
or delta_type or partial_history)
2347
# Build the LogRequest and execute it
2348
if len(file_ids) == 0:
2350
rqst = make_log_request_dict(
2351
direction=direction, specific_fileids=file_ids,
2352
start_revision=rev1, end_revision=rev2, limit=limit,
2353
message_search=message, delta_type=delta_type,
2354
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2355
Logger(b, rqst).show(lf)
2361
def _get_revision_range(revisionspec_list, branch, command_name):
2362
"""Take the input of a revision option and turn it into a revision range.
2364
It returns RevisionInfo objects which can be used to obtain the rev_id's
2365
of the desired revisions. It does some user input validations.
2367
if revisionspec_list is None:
2370
elif len(revisionspec_list) == 1:
2371
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2372
elif len(revisionspec_list) == 2:
2373
start_spec = revisionspec_list[0]
2374
end_spec = revisionspec_list[1]
2375
if end_spec.get_branch() != start_spec.get_branch():
2376
# b is taken from revision[0].get_branch(), and
2377
# show_log will use its revision_history. Having
2378
# different branches will lead to weird behaviors.
2379
raise errors.BzrCommandError(
2380
"bzr %s doesn't accept two revisions in different"
2381
" branches." % command_name)
2382
rev1 = start_spec.in_history(branch)
2383
# Avoid loading all of history when we know a missing
2384
# end of range means the last revision ...
2385
if end_spec.spec is None:
2386
last_revno, last_revision_id = branch.last_revision_info()
2387
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2389
rev2 = end_spec.in_history(branch)
2391
raise errors.BzrCommandError(
2392
'bzr %s --revision takes one or two values.' % command_name)
2396
def _revision_range_to_revid_range(revision_range):
2399
if revision_range[0] is not None:
2400
rev_id1 = revision_range[0].rev_id
2401
if revision_range[1] is not None:
2402
rev_id2 = revision_range[1].rev_id
2403
return rev_id1, rev_id2
2405
def get_log_format(long=False, short=False, line=False, default='long'):
2406
log_format = default
2410
log_format = 'short'
2416
class cmd_touching_revisions(Command):
2417
"""Return revision-ids which affected a particular file.
2419
A more user-friendly interface is "bzr log FILE".
2423
takes_args = ["filename"]
2426
def run(self, filename):
2427
tree, relpath = WorkingTree.open_containing(filename)
2428
file_id = tree.path2id(relpath)
2432
touching_revs = log.find_touching_revisions(b, file_id)
2433
for revno, revision_id, what in touching_revs:
2434
self.outf.write("%6d %s\n" % (revno, what))
2439
class cmd_ls(Command):
2440
"""List files in a tree.
2443
_see_also = ['status', 'cat']
2444
takes_args = ['path?']
2448
Option('recursive', short_name='R',
2449
help='Recurse into subdirectories.'),
2451
help='Print paths relative to the root of the branch.'),
2452
Option('unknown', help='Print unknown files.'),
2453
Option('versioned', help='Print versioned files.',
2455
Option('ignored', help='Print ignored files.'),
2457
help='Write an ascii NUL (\\0) separator '
2458
'between files rather than a newline.'),
2460
help='List entries of a particular kind: file, directory, symlink.',
2465
def run(self, revision=None, verbose=False,
2466
recursive=False, from_root=False,
2467
unknown=False, versioned=False, ignored=False,
2468
null=False, kind=None, show_ids=False, path=None):
2470
if kind and kind not in ('file', 'directory', 'symlink'):
2471
raise errors.BzrCommandError('invalid kind specified')
2473
if verbose and null:
2474
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2475
all = not (unknown or versioned or ignored)
2477
selection = {'I':ignored, '?':unknown, 'V':versioned}
2483
raise errors.BzrCommandError('cannot specify both --from-root'
2486
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2489
# Calculate the prefix to use
2493
prefix = relpath + '/'
2494
elif fs_path != '.':
2495
prefix = fs_path + '/'
2497
if revision is not None or tree is None:
2498
tree = _get_one_revision_tree('ls', revision, branch=branch)
2501
if isinstance(tree, WorkingTree) and tree.supports_views():
2502
view_files = tree.views.lookup_view()
2505
view_str = views.view_display_str(view_files)
2506
note("Ignoring files outside view. View is %s" % view_str)
2510
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2511
from_dir=relpath, recursive=recursive):
2512
# Apply additional masking
2513
if not all and not selection[fc]:
2515
if kind is not None and fkind != kind:
2520
fullpath = osutils.pathjoin(relpath, fp)
2523
views.check_path_in_view(tree, fullpath)
2524
except errors.FileOutsideView:
2529
fp = osutils.pathjoin(prefix, fp)
2530
kindch = entry.kind_character()
2531
outstring = fp + kindch
2532
ui.ui_factory.clear_term()
2534
outstring = '%-8s %s' % (fc, outstring)
2535
if show_ids and fid is not None:
2536
outstring = "%-50s %s" % (outstring, fid)
2537
self.outf.write(outstring + '\n')
2539
self.outf.write(fp + '\0')
2542
self.outf.write(fid)
2543
self.outf.write('\0')
2551
self.outf.write('%-50s %s\n' % (outstring, my_id))
2553
self.outf.write(outstring + '\n')
2558
class cmd_unknowns(Command):
2559
"""List unknown files.
2567
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2568
self.outf.write(osutils.quotefn(f) + '\n')
2571
class cmd_ignore(Command):
2572
"""Ignore specified files or patterns.
2574
See ``bzr help patterns`` for details on the syntax of patterns.
2576
To remove patterns from the ignore list, edit the .bzrignore file.
2577
After adding, editing or deleting that file either indirectly by
2578
using this command or directly by using an editor, be sure to commit
2581
Note: ignore patterns containing shell wildcards must be quoted from
2585
Ignore the top level Makefile::
2587
bzr ignore ./Makefile
2589
Ignore class files in all directories::
2591
bzr ignore "*.class"
2593
Ignore .o files under the lib directory::
2595
bzr ignore "lib/**/*.o"
2597
Ignore .o files under the lib directory::
2599
bzr ignore "RE:lib/.*\.o"
2601
Ignore everything but the "debian" toplevel directory::
2603
bzr ignore "RE:(?!debian/).*"
2606
_see_also = ['status', 'ignored', 'patterns']
2607
takes_args = ['name_pattern*']
2609
Option('old-default-rules',
2610
help='Write out the ignore rules bzr < 0.9 always used.')
2613
def run(self, name_pattern_list=None, old_default_rules=None):
2614
from bzrlib import ignores
2615
if old_default_rules is not None:
2616
# dump the rules and exit
2617
for pattern in ignores.OLD_DEFAULTS:
2620
if not name_pattern_list:
2621
raise errors.BzrCommandError("ignore requires at least one "
2622
"NAME_PATTERN or --old-default-rules")
2623
name_pattern_list = [globbing.normalize_pattern(p)
2624
for p in name_pattern_list]
2625
for name_pattern in name_pattern_list:
2626
if (name_pattern[0] == '/' or
2627
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2628
raise errors.BzrCommandError(
2629
"NAME_PATTERN should not be an absolute path")
2630
tree, relpath = WorkingTree.open_containing(u'.')
2631
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2632
ignored = globbing.Globster(name_pattern_list)
2635
for entry in tree.list_files():
2639
if ignored.match(filename):
2640
matches.append(filename.encode('utf-8'))
2642
if len(matches) > 0:
2643
print "Warning: the following files are version controlled and" \
2644
" match your ignore pattern:\n%s" \
2645
"\nThese files will continue to be version controlled" \
2646
" unless you 'bzr remove' them." % ("\n".join(matches),)
2649
class cmd_ignored(Command):
2650
"""List ignored files and the patterns that matched them.
2652
List all the ignored files and the ignore pattern that caused the file to
2655
Alternatively, to list just the files::
2660
encoding_type = 'replace'
2661
_see_also = ['ignore', 'ls']
2665
tree = WorkingTree.open_containing(u'.')[0]
2668
for path, file_class, kind, file_id, entry in tree.list_files():
2669
if file_class != 'I':
2671
## XXX: Slightly inefficient since this was already calculated
2672
pat = tree.is_ignored(path)
2673
self.outf.write('%-50s %s\n' % (path, pat))
2678
class cmd_lookup_revision(Command):
2679
"""Lookup the revision-id from a revision-number
2682
bzr lookup-revision 33
2685
takes_args = ['revno']
2688
def run(self, revno):
2692
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2694
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2697
class cmd_export(Command):
2698
"""Export current or past revision to a destination directory or archive.
2700
If no revision is specified this exports the last committed revision.
2702
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2703
given, try to find the format with the extension. If no extension
2704
is found exports to a directory (equivalent to --format=dir).
2706
If root is supplied, it will be used as the root directory inside
2707
container formats (tar, zip, etc). If it is not supplied it will default
2708
to the exported filename. The root option has no effect for 'dir' format.
2710
If branch is omitted then the branch containing the current working
2711
directory will be used.
2713
Note: Export of tree with non-ASCII filenames to zip is not supported.
2715
================= =========================
2716
Supported formats Autodetected by extension
2717
================= =========================
2720
tbz2 .tar.bz2, .tbz2
2723
================= =========================
2725
takes_args = ['dest', 'branch_or_subdir?']
2728
help="Type of file to export to.",
2731
Option('filters', help='Apply content filters to export the '
2732
'convenient form.'),
2735
help="Name of the root directory inside the exported file."),
2737
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2738
root=None, filters=False):
2739
from bzrlib.export import export
2741
if branch_or_subdir is None:
2742
tree = WorkingTree.open_containing(u'.')[0]
2746
b, subdir = Branch.open_containing(branch_or_subdir)
2749
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2751
export(rev_tree, dest, format, root, subdir, filtered=filters)
2752
except errors.NoSuchExportFormat, e:
2753
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2756
class cmd_cat(Command):
2757
"""Write the contents of a file as of a given revision to standard output.
2759
If no revision is nominated, the last revision is used.
2761
Note: Take care to redirect standard output when using this command on a
2767
Option('name-from-revision', help='The path name in the old tree.'),
2768
Option('filters', help='Apply content filters to display the '
2769
'convenience form.'),
2772
takes_args = ['filename']
2773
encoding_type = 'exact'
2776
def run(self, filename, revision=None, name_from_revision=False,
2778
if revision is not None and len(revision) != 1:
2779
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2780
" one revision specifier")
2781
tree, branch, relpath = \
2782
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2785
return self._run(tree, branch, relpath, filename, revision,
2786
name_from_revision, filters)
2790
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2793
tree = b.basis_tree()
2794
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2796
old_file_id = rev_tree.path2id(relpath)
2798
if name_from_revision:
2799
# Try in revision if requested
2800
if old_file_id is None:
2801
raise errors.BzrCommandError(
2802
"%r is not present in revision %s" % (
2803
filename, rev_tree.get_revision_id()))
2805
content = rev_tree.get_file_text(old_file_id)
2807
cur_file_id = tree.path2id(relpath)
2809
if cur_file_id is not None:
2810
# Then try with the actual file id
2812
content = rev_tree.get_file_text(cur_file_id)
2814
except errors.NoSuchId:
2815
# The actual file id didn't exist at that time
2817
if not found and old_file_id is not None:
2818
# Finally try with the old file id
2819
content = rev_tree.get_file_text(old_file_id)
2822
# Can't be found anywhere
2823
raise errors.BzrCommandError(
2824
"%r is not present in revision %s" % (
2825
filename, rev_tree.get_revision_id()))
2827
from bzrlib.filters import (
2828
ContentFilterContext,
2829
filtered_output_bytes,
2831
filters = rev_tree._content_filter_stack(relpath)
2832
chunks = content.splitlines(True)
2833
content = filtered_output_bytes(chunks, filters,
2834
ContentFilterContext(relpath, rev_tree))
2835
self.outf.writelines(content)
2837
self.outf.write(content)
2840
class cmd_local_time_offset(Command):
2841
"""Show the offset in seconds from GMT to local time."""
2845
print osutils.local_time_offset()
2849
class cmd_commit(Command):
2850
"""Commit changes into a new revision.
2852
An explanatory message needs to be given for each commit. This is
2853
often done by using the --message option (getting the message from the
2854
command line) or by using the --file option (getting the message from
2855
a file). If neither of these options is given, an editor is opened for
2856
the user to enter the message. To see the changed files in the
2857
boilerplate text loaded into the editor, use the --show-diff option.
2859
By default, the entire tree is committed and the person doing the
2860
commit is assumed to be the author. These defaults can be overridden
2865
If selected files are specified, only changes to those files are
2866
committed. If a directory is specified then the directory and
2867
everything within it is committed.
2869
When excludes are given, they take precedence over selected files.
2870
For example, to commit only changes within foo, but not changes
2873
bzr commit foo -x foo/bar
2875
A selective commit after a merge is not yet supported.
2879
If the author of the change is not the same person as the committer,
2880
you can specify the author's name using the --author option. The
2881
name should be in the same format as a committer-id, e.g.
2882
"John Doe <jdoe@example.com>". If there is more than one author of
2883
the change you can specify the option multiple times, once for each
2888
A common mistake is to forget to add a new file or directory before
2889
running the commit command. The --strict option checks for unknown
2890
files and aborts the commit if any are found. More advanced pre-commit
2891
checks can be implemented by defining hooks. See ``bzr help hooks``
2896
If you accidentially commit the wrong changes or make a spelling
2897
mistake in the commit message say, you can use the uncommit command
2898
to undo it. See ``bzr help uncommit`` for details.
2900
Hooks can also be configured to run after a commit. This allows you
2901
to trigger updates to external systems like bug trackers. The --fixes
2902
option can be used to record the association between a revision and
2903
one or more bugs. See ``bzr help bugs`` for details.
2905
A selective commit may fail in some cases where the committed
2906
tree would be invalid. Consider::
2911
bzr commit foo -m "committing foo"
2912
bzr mv foo/bar foo/baz
2915
bzr commit foo/bar -m "committing bar but not baz"
2917
In the example above, the last commit will fail by design. This gives
2918
the user the opportunity to decide whether they want to commit the
2919
rename at the same time, separately first, or not at all. (As a general
2920
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2922
# TODO: Run hooks on tree to-be-committed, and after commit.
2924
# TODO: Strict commit that fails if there are deleted files.
2925
# (what does "deleted files" mean ??)
2927
# TODO: Give better message for -s, --summary, used by tla people
2929
# XXX: verbose currently does nothing
2931
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2932
takes_args = ['selected*']
2934
ListOption('exclude', type=str, short_name='x',
2935
help="Do not consider changes made to a given path."),
2936
Option('message', type=unicode,
2938
help="Description of the new revision."),
2941
help='Commit even if nothing has changed.'),
2942
Option('file', type=str,
2945
help='Take commit message from this file.'),
2947
help="Refuse to commit if there are unknown "
2948
"files in the working tree."),
2949
ListOption('fixes', type=str,
2950
help="Mark a bug as being fixed by this revision "
2951
"(see \"bzr help bugs\")."),
2952
ListOption('author', type=unicode,
2953
help="Set the author's name, if it's different "
2954
"from the committer."),
2956
help="Perform a local commit in a bound "
2957
"branch. Local commits are not pushed to "
2958
"the master branch until a normal commit "
2962
help='When no message is supplied, show the diff along'
2963
' with the status summary in the message editor.'),
2965
aliases = ['ci', 'checkin']
2967
def _iter_bug_fix_urls(self, fixes, branch):
2968
# Configure the properties for bug fixing attributes.
2969
for fixed_bug in fixes:
2970
tokens = fixed_bug.split(':')
2971
if len(tokens) != 2:
2972
raise errors.BzrCommandError(
2973
"Invalid bug %s. Must be in the form of 'tracker:id'. "
2974
"See \"bzr help bugs\" for more information on this "
2975
"feature.\nCommit refused." % fixed_bug)
2976
tag, bug_id = tokens
2978
yield bugtracker.get_bug_url(tag, branch, bug_id)
2979
except errors.UnknownBugTrackerAbbreviation:
2980
raise errors.BzrCommandError(
2981
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2982
except errors.MalformedBugIdentifier, e:
2983
raise errors.BzrCommandError(
2984
"%s\nCommit refused." % (str(e),))
2986
def run(self, message=None, file=None, verbose=False, selected_list=None,
2987
unchanged=False, strict=False, local=False, fixes=None,
2988
author=None, show_diff=False, exclude=None):
2989
from bzrlib.errors import (
2994
from bzrlib.msgeditor import (
2995
edit_commit_message_encoded,
2996
generate_commit_message_template,
2997
make_commit_message_template_encoded
3000
# TODO: Need a blackbox test for invoking the external editor; may be
3001
# slightly problematic to run this cross-platform.
3003
# TODO: do more checks that the commit will succeed before
3004
# spending the user's valuable time typing a commit message.
3008
tree, selected_list = tree_files(selected_list)
3009
if selected_list == ['']:
3010
# workaround - commit of root of tree should be exactly the same
3011
# as just default commit in that tree, and succeed even though
3012
# selected-file merge commit is not done yet
3017
bug_property = bugtracker.encode_fixes_bug_urls(
3018
self._iter_bug_fix_urls(fixes, tree.branch))
3020
properties['bugs'] = bug_property
3022
if local and not tree.branch.get_bound_location():
3023
raise errors.LocalRequiresBoundBranch()
3025
def get_message(commit_obj):
3026
"""Callback to get commit message"""
3027
my_message = message
3028
if my_message is None and not file:
3029
t = make_commit_message_template_encoded(tree,
3030
selected_list, diff=show_diff,
3031
output_encoding=osutils.get_user_encoding())
3032
start_message = generate_commit_message_template(commit_obj)
3033
my_message = edit_commit_message_encoded(t,
3034
start_message=start_message)
3035
if my_message is None:
3036
raise errors.BzrCommandError("please specify a commit"
3037
" message with either --message or --file")
3038
elif my_message and file:
3039
raise errors.BzrCommandError(
3040
"please specify either --message or --file")
3042
my_message = codecs.open(file, 'rt',
3043
osutils.get_user_encoding()).read()
3044
if my_message == "":
3045
raise errors.BzrCommandError("empty commit message specified")
3048
# The API permits a commit with a filter of [] to mean 'select nothing'
3049
# but the command line should not do that.
3050
if not selected_list:
3051
selected_list = None
3053
tree.commit(message_callback=get_message,
3054
specific_files=selected_list,
3055
allow_pointless=unchanged, strict=strict, local=local,
3056
reporter=None, verbose=verbose, revprops=properties,
3058
exclude=safe_relpath_files(tree, exclude))
3059
except PointlessCommit:
3060
# FIXME: This should really happen before the file is read in;
3061
# perhaps prepare the commit; get the message; then actually commit
3062
raise errors.BzrCommandError("No changes to commit."
3063
" Use --unchanged to commit anyhow.")
3064
except ConflictsInTree:
3065
raise errors.BzrCommandError('Conflicts detected in working '
3066
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3068
except StrictCommitFailed:
3069
raise errors.BzrCommandError("Commit refused because there are"
3070
" unknown files in the working tree.")
3071
except errors.BoundBranchOutOfDate, e:
3072
raise errors.BzrCommandError(str(e) + "\n"
3073
'To commit to master branch, run update and then commit.\n'
3074
'You can also pass --local to commit to continue working '
3078
class cmd_check(Command):
3079
"""Validate working tree structure, branch consistency and repository history.
3081
This command checks various invariants about branch and repository storage
3082
to detect data corruption or bzr bugs.
3084
The working tree and branch checks will only give output if a problem is
3085
detected. The output fields of the repository check are:
3088
This is just the number of revisions checked. It doesn't
3092
This is just the number of versionedfiles checked. It
3093
doesn't indicate a problem.
3095
unreferenced ancestors
3096
Texts that are ancestors of other texts, but
3097
are not properly referenced by the revision ancestry. This is a
3098
subtle problem that Bazaar can work around.
3101
This is the total number of unique file contents
3102
seen in the checked revisions. It does not indicate a problem.
3105
This is the total number of repeated texts seen
3106
in the checked revisions. Texts can be repeated when their file
3107
entries are modified, but the file contents are not. It does not
3110
If no restrictions are specified, all Bazaar data that is found at the given
3111
location will be checked.
3115
Check the tree and branch at 'foo'::
3117
bzr check --tree --branch foo
3119
Check only the repository at 'bar'::
3121
bzr check --repo bar
3123
Check everything at 'baz'::
3128
_see_also = ['reconcile']
3129
takes_args = ['path?']
3130
takes_options = ['verbose',
3131
Option('branch', help="Check the branch related to the"
3132
" current directory."),
3133
Option('repo', help="Check the repository related to the"
3134
" current directory."),
3135
Option('tree', help="Check the working tree related to"
3136
" the current directory.")]
3138
def run(self, path=None, verbose=False, branch=False, repo=False,
3140
from bzrlib.check import check_dwim
3143
if not branch and not repo and not tree:
3144
branch = repo = tree = True
3145
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3148
class cmd_upgrade(Command):
3149
"""Upgrade branch storage to current format.
3151
The check command or bzr developers may sometimes advise you to run
3152
this command. When the default format has changed you may also be warned
3153
during other operations to upgrade.
3156
_see_also = ['check']
3157
takes_args = ['url?']
3159
RegistryOption('format',
3160
help='Upgrade to a specific format. See "bzr help'
3161
' formats" for details.',
3162
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3163
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3164
value_switches=True, title='Branch format'),
3167
def run(self, url='.', format=None):
3168
from bzrlib.upgrade import upgrade
3169
upgrade(url, format)
3172
class cmd_whoami(Command):
3173
"""Show or set bzr user id.
3176
Show the email of the current user::
3180
Set the current user::
3182
bzr whoami "Frank Chu <fchu@example.com>"
3184
takes_options = [ Option('email',
3185
help='Display email address only.'),
3187
help='Set identity for the current branch instead of '
3190
takes_args = ['name?']
3191
encoding_type = 'replace'
3194
def run(self, email=False, branch=False, name=None):
3196
# use branch if we're inside one; otherwise global config
3198
c = Branch.open_containing('.')[0].get_config()
3199
except errors.NotBranchError:
3200
c = config.GlobalConfig()
3202
self.outf.write(c.user_email() + '\n')
3204
self.outf.write(c.username() + '\n')
3207
# display a warning if an email address isn't included in the given name.
3209
config.extract_email_address(name)
3210
except errors.NoEmailInUsername, e:
3211
warning('"%s" does not seem to contain an email address. '
3212
'This is allowed, but not recommended.', name)
3214
# use global config unless --branch given
3216
c = Branch.open_containing('.')[0].get_config()
3218
c = config.GlobalConfig()
3219
c.set_user_option('email', name)
3222
class cmd_nick(Command):
3223
"""Print or set the branch nickname.
3225
If unset, the tree root directory name is used as the nickname.
3226
To print the current nickname, execute with no argument.
3228
Bound branches use the nickname of its master branch unless it is set
3232
_see_also = ['info']
3233
takes_args = ['nickname?']
3234
def run(self, nickname=None):
3235
branch = Branch.open_containing(u'.')[0]
3236
if nickname is None:
3237
self.printme(branch)
3239
branch.nick = nickname
3242
def printme(self, branch):
3246
class cmd_alias(Command):
3247
"""Set/unset and display aliases.
3250
Show the current aliases::
3254
Show the alias specified for 'll'::
3258
Set an alias for 'll'::
3260
bzr alias ll="log --line -r-10..-1"
3262
To remove an alias for 'll'::
3264
bzr alias --remove ll
3267
takes_args = ['name?']
3269
Option('remove', help='Remove the alias.'),
3272
def run(self, name=None, remove=False):
3274
self.remove_alias(name)
3276
self.print_aliases()
3278
equal_pos = name.find('=')
3280
self.print_alias(name)
3282
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3284
def remove_alias(self, alias_name):
3285
if alias_name is None:
3286
raise errors.BzrCommandError(
3287
'bzr alias --remove expects an alias to remove.')
3288
# If alias is not found, print something like:
3289
# unalias: foo: not found
3290
c = config.GlobalConfig()
3291
c.unset_alias(alias_name)
3294
def print_aliases(self):
3295
"""Print out the defined aliases in a similar format to bash."""
3296
aliases = config.GlobalConfig().get_aliases()
3297
for key, value in sorted(aliases.iteritems()):
3298
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3301
def print_alias(self, alias_name):
3302
from bzrlib.commands import get_alias
3303
alias = get_alias(alias_name)
3305
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3308
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3310
def set_alias(self, alias_name, alias_command):
3311
"""Save the alias in the global config."""
3312
c = config.GlobalConfig()
3313
c.set_alias(alias_name, alias_command)
3316
class cmd_selftest(Command):
3317
"""Run internal test suite.
3319
If arguments are given, they are regular expressions that say which tests
3320
should run. Tests matching any expression are run, and other tests are
3323
Alternatively if --first is given, matching tests are run first and then
3324
all other tests are run. This is useful if you have been working in a
3325
particular area, but want to make sure nothing else was broken.
3327
If --exclude is given, tests that match that regular expression are
3328
excluded, regardless of whether they match --first or not.
3330
To help catch accidential dependencies between tests, the --randomize
3331
option is useful. In most cases, the argument used is the word 'now'.
3332
Note that the seed used for the random number generator is displayed
3333
when this option is used. The seed can be explicitly passed as the
3334
argument to this option if required. This enables reproduction of the
3335
actual ordering used if and when an order sensitive problem is encountered.
3337
If --list-only is given, the tests that would be run are listed. This is
3338
useful when combined with --first, --exclude and/or --randomize to
3339
understand their impact. The test harness reports "Listed nn tests in ..."
3340
instead of "Ran nn tests in ..." when list mode is enabled.
3342
If the global option '--no-plugins' is given, plugins are not loaded
3343
before running the selftests. This has two effects: features provided or
3344
modified by plugins will not be tested, and tests provided by plugins will
3347
Tests that need working space on disk use a common temporary directory,
3348
typically inside $TMPDIR or /tmp.
3351
Run only tests relating to 'ignore'::
3355
Disable plugins and list tests as they're run::
3357
bzr --no-plugins selftest -v
3359
# NB: this is used from the class without creating an instance, which is
3360
# why it does not have a self parameter.
3361
def get_transport_type(typestring):
3362
"""Parse and return a transport specifier."""
3363
if typestring == "sftp":
3364
from bzrlib.transport.sftp import SFTPAbsoluteServer
3365
return SFTPAbsoluteServer
3366
if typestring == "memory":
3367
from bzrlib.transport.memory import MemoryServer
3369
if typestring == "fakenfs":
3370
from bzrlib.transport.fakenfs import FakeNFSServer
3371
return FakeNFSServer
3372
msg = "No known transport type %s. Supported types are: sftp\n" %\
3374
raise errors.BzrCommandError(msg)
3377
takes_args = ['testspecs*']
3378
takes_options = ['verbose',
3380
help='Stop when one test fails.',
3384
help='Use a different transport by default '
3385
'throughout the test suite.',
3386
type=get_transport_type),
3388
help='Run the benchmarks rather than selftests.'),
3389
Option('lsprof-timed',
3390
help='Generate lsprof output for benchmarked'
3391
' sections of code.'),
3392
Option('cache-dir', type=str,
3393
help='Cache intermediate benchmark output in this '
3396
help='Run all tests, but run specified tests first.',
3400
help='List the tests instead of running them.'),
3401
RegistryOption('parallel',
3402
help="Run the test suite in parallel.",
3403
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3404
value_switches=False,
3406
Option('randomize', type=str, argname="SEED",
3407
help='Randomize the order of tests using the given'
3408
' seed or "now" for the current time.'),
3409
Option('exclude', type=str, argname="PATTERN",
3411
help='Exclude tests that match this regular'
3414
help='Output test progress via subunit.'),
3415
Option('strict', help='Fail on missing dependencies or '
3417
Option('load-list', type=str, argname='TESTLISTFILE',
3418
help='Load a test id list from a text file.'),
3419
ListOption('debugflag', type=str, short_name='E',
3420
help='Turn on a selftest debug flag.'),
3421
ListOption('starting-with', type=str, argname='TESTID',
3422
param_name='starting_with', short_name='s',
3424
'Load only the tests starting with TESTID.'),
3426
encoding_type = 'replace'
3429
Command.__init__(self)
3430
self.additional_selftest_args = {}
3432
def run(self, testspecs_list=None, verbose=False, one=False,
3433
transport=None, benchmark=None,
3434
lsprof_timed=None, cache_dir=None,
3435
first=False, list_only=False,
3436
randomize=None, exclude=None, strict=False,
3437
load_list=None, debugflag=None, starting_with=None, subunit=False,
3439
from bzrlib.tests import selftest
3440
import bzrlib.benchmarks as benchmarks
3441
from bzrlib.benchmarks import tree_creator
3443
# Make deprecation warnings visible, unless -Werror is set
3444
symbol_versioning.activate_deprecation_warnings(override=False)
3446
if cache_dir is not None:
3447
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3448
if testspecs_list is not None:
3449
pattern = '|'.join(testspecs_list)
3454
from bzrlib.tests import SubUnitBzrRunner
3456
raise errors.BzrCommandError("subunit not available. subunit "
3457
"needs to be installed to use --subunit.")
3458
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3460
self.additional_selftest_args.setdefault(
3461
'suite_decorators', []).append(parallel)
3463
test_suite_factory = benchmarks.test_suite
3464
# Unless user explicitly asks for quiet, be verbose in benchmarks
3465
verbose = not is_quiet()
3466
# TODO: should possibly lock the history file...
3467
benchfile = open(".perf_history", "at", buffering=1)
3469
test_suite_factory = None
3472
selftest_kwargs = {"verbose": verbose,
3474
"stop_on_failure": one,
3475
"transport": transport,
3476
"test_suite_factory": test_suite_factory,
3477
"lsprof_timed": lsprof_timed,
3478
"bench_history": benchfile,
3479
"matching_tests_first": first,
3480
"list_only": list_only,
3481
"random_seed": randomize,
3482
"exclude_pattern": exclude,
3484
"load_list": load_list,
3485
"debug_flags": debugflag,
3486
"starting_with": starting_with
3488
selftest_kwargs.update(self.additional_selftest_args)
3489
result = selftest(**selftest_kwargs)
3491
if benchfile is not None:
3493
return int(not result)
3496
class cmd_version(Command):
3497
"""Show version of bzr."""
3499
encoding_type = 'replace'
3501
Option("short", help="Print just the version number."),
3505
def run(self, short=False):
3506
from bzrlib.version import show_version
3508
self.outf.write(bzrlib.version_string + '\n')
3510
show_version(to_file=self.outf)
3513
class cmd_rocks(Command):
3514
"""Statement of optimism."""
3520
print "It sure does!"
3523
class cmd_find_merge_base(Command):
3524
"""Find and print a base revision for merging two branches."""
3525
# TODO: Options to specify revisions on either side, as if
3526
# merging only part of the history.
3527
takes_args = ['branch', 'other']
3531
def run(self, branch, other):
3532
from bzrlib.revision import ensure_null
3534
branch1 = Branch.open_containing(branch)[0]
3535
branch2 = Branch.open_containing(other)[0]
3540
last1 = ensure_null(branch1.last_revision())
3541
last2 = ensure_null(branch2.last_revision())
3543
graph = branch1.repository.get_graph(branch2.repository)
3544
base_rev_id = graph.find_unique_lca(last1, last2)
3546
print 'merge base is revision %s' % base_rev_id
3553
class cmd_merge(Command):
3554
"""Perform a three-way merge.
3556
The source of the merge can be specified either in the form of a branch,
3557
or in the form of a path to a file containing a merge directive generated
3558
with bzr send. If neither is specified, the default is the upstream branch
3559
or the branch most recently merged using --remember.
3561
When merging a branch, by default the tip will be merged. To pick a different
3562
revision, pass --revision. If you specify two values, the first will be used as
3563
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3564
available revisions, like this is commonly referred to as "cherrypicking".
3566
Revision numbers are always relative to the branch being merged.
3568
By default, bzr will try to merge in all new work from the other
3569
branch, automatically determining an appropriate base. If this
3570
fails, you may need to give an explicit base.
3572
Merge will do its best to combine the changes in two branches, but there
3573
are some kinds of problems only a human can fix. When it encounters those,
3574
it will mark a conflict. A conflict means that you need to fix something,
3575
before you should commit.
3577
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3579
If there is no default branch set, the first merge will set it. After
3580
that, you can omit the branch to use the default. To change the
3581
default, use --remember. The value will only be saved if the remote
3582
location can be accessed.
3584
The results of the merge are placed into the destination working
3585
directory, where they can be reviewed (with bzr diff), tested, and then
3586
committed to record the result of the merge.
3588
merge refuses to run if there are any uncommitted changes, unless
3591
To select only some changes to merge, use "merge -i", which will prompt
3592
you to apply each diff hunk and file change, similar to "shelve".
3595
To merge the latest revision from bzr.dev::
3597
bzr merge ../bzr.dev
3599
To merge changes up to and including revision 82 from bzr.dev::
3601
bzr merge -r 82 ../bzr.dev
3603
To merge the changes introduced by 82, without previous changes::
3605
bzr merge -r 81..82 ../bzr.dev
3607
To apply a merge directive contained in /tmp/merge:
3609
bzr merge /tmp/merge
3612
encoding_type = 'exact'
3613
_see_also = ['update', 'remerge', 'status-flags', 'send']
3614
takes_args = ['location?']
3619
help='Merge even if the destination tree has uncommitted changes.'),
3623
Option('show-base', help="Show base revision text in "
3625
Option('uncommitted', help='Apply uncommitted changes'
3626
' from a working copy, instead of branch changes.'),
3627
Option('pull', help='If the destination is already'
3628
' completely merged into the source, pull from the'
3629
' source rather than merging. When this happens,'
3630
' you do not need to commit the result.'),
3632
help='Branch to merge into, '
3633
'rather than the one containing the working directory.',
3637
Option('preview', help='Instead of merging, show a diff of the'
3639
Option('interactive', help='Select changes interactively.',
3643
def run(self, location=None, revision=None, force=False,
3644
merge_type=None, show_base=False, reprocess=None, remember=False,
3645
uncommitted=False, pull=False,
3650
if merge_type is None:
3651
merge_type = _mod_merge.Merge3Merger
3653
if directory is None: directory = u'.'
3654
possible_transports = []
3656
allow_pending = True
3657
verified = 'inapplicable'
3658
tree = WorkingTree.open_containing(directory)[0]
3660
# die as quickly as possible if there are uncommitted changes
3662
basis_tree = tree.revision_tree(tree.last_revision())
3663
except errors.NoSuchRevision:
3664
basis_tree = tree.basis_tree()
3666
if tree.has_changes(basis_tree):
3667
raise errors.UncommittedChanges(tree)
3669
view_info = _get_view_info_for_change_reporter(tree)
3670
change_reporter = delta._ChangeReporter(
3671
unversioned_filter=tree.is_ignored, view_info=view_info)
3674
pb = ui.ui_factory.nested_progress_bar()
3675
cleanups.append(pb.finished)
3677
cleanups.append(tree.unlock)
3678
if location is not None:
3680
mergeable = bundle.read_mergeable_from_url(location,
3681
possible_transports=possible_transports)
3682
except errors.NotABundle:
3686
raise errors.BzrCommandError('Cannot use --uncommitted'
3687
' with bundles or merge directives.')
3689
if revision is not None:
3690
raise errors.BzrCommandError(
3691
'Cannot use -r with merge directives or bundles')
3692
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3695
if merger is None and uncommitted:
3696
if revision is not None and len(revision) > 0:
3697
raise errors.BzrCommandError('Cannot use --uncommitted and'
3698
' --revision at the same time.')
3699
merger = self.get_merger_from_uncommitted(tree, location, pb,
3701
allow_pending = False
3704
merger, allow_pending = self._get_merger_from_branch(tree,
3705
location, revision, remember, possible_transports, pb)
3707
merger.merge_type = merge_type
3708
merger.reprocess = reprocess
3709
merger.show_base = show_base
3710
self.sanity_check_merger(merger)
3711
if (merger.base_rev_id == merger.other_rev_id and
3712
merger.other_rev_id is not None):
3713
note('Nothing to do.')
3716
if merger.interesting_files is not None:
3717
raise errors.BzrCommandError('Cannot pull individual files')
3718
if (merger.base_rev_id == tree.last_revision()):
3719
result = tree.pull(merger.other_branch, False,
3720
merger.other_rev_id)
3721
result.report(self.outf)
3723
merger.check_basis(False)
3725
return self._do_preview(merger, cleanups)
3727
return self._do_interactive(merger, cleanups)
3729
return self._do_merge(merger, change_reporter, allow_pending,
3732
for cleanup in reversed(cleanups):
3735
def _get_preview(self, merger, cleanups):
3736
tree_merger = merger.make_merger()
3737
tt = tree_merger.make_preview_transform()
3738
cleanups.append(tt.finalize)
3739
result_tree = tt.get_preview_tree()
3742
def _do_preview(self, merger, cleanups):
3743
from bzrlib.diff import show_diff_trees
3744
result_tree = self._get_preview(merger, cleanups)
3745
show_diff_trees(merger.this_tree, result_tree, self.outf,
3746
old_label='', new_label='')
3748
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3749
merger.change_reporter = change_reporter
3750
conflict_count = merger.do_merge()
3752
merger.set_pending()
3753
if verified == 'failed':
3754
warning('Preview patch does not match changes')
3755
if conflict_count != 0:
3760
def _do_interactive(self, merger, cleanups):
3761
"""Perform an interactive merge.
3763
This works by generating a preview tree of the merge, then using
3764
Shelver to selectively remove the differences between the working tree
3765
and the preview tree.
3767
from bzrlib import shelf_ui
3768
result_tree = self._get_preview(merger, cleanups)
3769
writer = bzrlib.option.diff_writer_registry.get()
3770
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3771
reporter=shelf_ui.ApplyReporter(),
3772
diff_writer=writer(sys.stdout))
3775
def sanity_check_merger(self, merger):
3776
if (merger.show_base and
3777
not merger.merge_type is _mod_merge.Merge3Merger):
3778
raise errors.BzrCommandError("Show-base is not supported for this"
3779
" merge type. %s" % merger.merge_type)
3780
if merger.reprocess is None:
3781
if merger.show_base:
3782
merger.reprocess = False
3784
# Use reprocess if the merger supports it
3785
merger.reprocess = merger.merge_type.supports_reprocess
3786
if merger.reprocess and not merger.merge_type.supports_reprocess:
3787
raise errors.BzrCommandError("Conflict reduction is not supported"
3788
" for merge type %s." %
3790
if merger.reprocess and merger.show_base:
3791
raise errors.BzrCommandError("Cannot do conflict reduction and"
3794
def _get_merger_from_branch(self, tree, location, revision, remember,
3795
possible_transports, pb):
3796
"""Produce a merger from a location, assuming it refers to a branch."""
3797
from bzrlib.tag import _merge_tags_if_possible
3798
# find the branch locations
3799
other_loc, user_location = self._select_branch_location(tree, location,
3801
if revision is not None and len(revision) == 2:
3802
base_loc, _unused = self._select_branch_location(tree,
3803
location, revision, 0)
3805
base_loc = other_loc
3807
other_branch, other_path = Branch.open_containing(other_loc,
3808
possible_transports)
3809
if base_loc == other_loc:
3810
base_branch = other_branch
3812
base_branch, base_path = Branch.open_containing(base_loc,
3813
possible_transports)
3814
# Find the revision ids
3815
other_revision_id = None
3816
base_revision_id = None
3817
if revision is not None:
3818
if len(revision) >= 1:
3819
other_revision_id = revision[-1].as_revision_id(other_branch)
3820
if len(revision) == 2:
3821
base_revision_id = revision[0].as_revision_id(base_branch)
3822
if other_revision_id is None:
3823
other_revision_id = _mod_revision.ensure_null(
3824
other_branch.last_revision())
3825
# Remember where we merge from
3826
if ((remember or tree.branch.get_submit_branch() is None) and
3827
user_location is not None):
3828
tree.branch.set_submit_branch(other_branch.base)
3829
_merge_tags_if_possible(other_branch, tree.branch)
3830
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3831
other_revision_id, base_revision_id, other_branch, base_branch)
3832
if other_path != '':
3833
allow_pending = False
3834
merger.interesting_files = [other_path]
3836
allow_pending = True
3837
return merger, allow_pending
3839
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3840
"""Get a merger for uncommitted changes.
3842
:param tree: The tree the merger should apply to.
3843
:param location: The location containing uncommitted changes.
3844
:param pb: The progress bar to use for showing progress.
3845
:param cleanups: A list of operations to perform to clean up the
3846
temporary directories, unfinalized objects, etc.
3848
location = self._select_branch_location(tree, location)[0]
3849
other_tree, other_path = WorkingTree.open_containing(location)
3850
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3851
if other_path != '':
3852
merger.interesting_files = [other_path]
3855
def _select_branch_location(self, tree, user_location, revision=None,
3857
"""Select a branch location, according to possible inputs.
3859
If provided, branches from ``revision`` are preferred. (Both
3860
``revision`` and ``index`` must be supplied.)
3862
Otherwise, the ``location`` parameter is used. If it is None, then the
3863
``submit`` or ``parent`` location is used, and a note is printed.
3865
:param tree: The working tree to select a branch for merging into
3866
:param location: The location entered by the user
3867
:param revision: The revision parameter to the command
3868
:param index: The index to use for the revision parameter. Negative
3869
indices are permitted.
3870
:return: (selected_location, user_location). The default location
3871
will be the user-entered location.
3873
if (revision is not None and index is not None
3874
and revision[index] is not None):
3875
branch = revision[index].get_branch()
3876
if branch is not None:
3877
return branch, branch
3878
if user_location is None:
3879
location = self._get_remembered(tree, 'Merging from')
3881
location = user_location
3882
return location, user_location
3884
def _get_remembered(self, tree, verb_string):
3885
"""Use tree.branch's parent if none was supplied.
3887
Report if the remembered location was used.
3889
stored_location = tree.branch.get_submit_branch()
3890
stored_location_type = "submit"
3891
if stored_location is None:
3892
stored_location = tree.branch.get_parent()
3893
stored_location_type = "parent"
3894
mutter("%s", stored_location)
3895
if stored_location is None:
3896
raise errors.BzrCommandError("No location specified or remembered")
3897
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3898
note(u"%s remembered %s location %s", verb_string,
3899
stored_location_type, display_url)
3900
return stored_location
3903
class cmd_remerge(Command):
3906
Use this if you want to try a different merge technique while resolving
3907
conflicts. Some merge techniques are better than others, and remerge
3908
lets you try different ones on different files.
3910
The options for remerge have the same meaning and defaults as the ones for
3911
merge. The difference is that remerge can (only) be run when there is a
3912
pending merge, and it lets you specify particular files.
3915
Re-do the merge of all conflicted files, and show the base text in
3916
conflict regions, in addition to the usual THIS and OTHER texts::
3918
bzr remerge --show-base
3920
Re-do the merge of "foobar", using the weave merge algorithm, with
3921
additional processing to reduce the size of conflict regions::
3923
bzr remerge --merge-type weave --reprocess foobar
3925
takes_args = ['file*']
3930
help="Show base revision text in conflicts."),
3933
def run(self, file_list=None, merge_type=None, show_base=False,
3935
if merge_type is None:
3936
merge_type = _mod_merge.Merge3Merger
3937
tree, file_list = tree_files(file_list)
3940
parents = tree.get_parent_ids()
3941
if len(parents) != 2:
3942
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3943
" merges. Not cherrypicking or"
3945
repository = tree.branch.repository
3946
interesting_ids = None
3948
conflicts = tree.conflicts()
3949
if file_list is not None:
3950
interesting_ids = set()
3951
for filename in file_list:
3952
file_id = tree.path2id(filename)
3954
raise errors.NotVersionedError(filename)
3955
interesting_ids.add(file_id)
3956
if tree.kind(file_id) != "directory":
3959
for name, ie in tree.inventory.iter_entries(file_id):
3960
interesting_ids.add(ie.file_id)
3961
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3963
# Remerge only supports resolving contents conflicts
3964
allowed_conflicts = ('text conflict', 'contents conflict')
3965
restore_files = [c.path for c in conflicts
3966
if c.typestring in allowed_conflicts]
3967
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3968
tree.set_conflicts(ConflictList(new_conflicts))
3969
if file_list is not None:
3970
restore_files = file_list
3971
for filename in restore_files:
3973
restore(tree.abspath(filename))
3974
except errors.NotConflicted:
3976
# Disable pending merges, because the file texts we are remerging
3977
# have not had those merges performed. If we use the wrong parents
3978
# list, we imply that the working tree text has seen and rejected
3979
# all the changes from the other tree, when in fact those changes
3980
# have not yet been seen.
3981
pb = ui.ui_factory.nested_progress_bar()
3982
tree.set_parent_ids(parents[:1])
3984
merger = _mod_merge.Merger.from_revision_ids(pb,
3986
merger.interesting_ids = interesting_ids
3987
merger.merge_type = merge_type
3988
merger.show_base = show_base
3989
merger.reprocess = reprocess
3990
conflicts = merger.do_merge()
3992
tree.set_parent_ids(parents)
4002
class cmd_revert(Command):
4003
"""Revert files to a previous revision.
4005
Giving a list of files will revert only those files. Otherwise, all files
4006
will be reverted. If the revision is not specified with '--revision', the
4007
last committed revision is used.
4009
To remove only some changes, without reverting to a prior version, use
4010
merge instead. For example, "merge . --revision -2..-3" will remove the
4011
changes introduced by -2, without affecting the changes introduced by -1.
4012
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4014
By default, any files that have been manually changed will be backed up
4015
first. (Files changed only by merge are not backed up.) Backup files have
4016
'.~#~' appended to their name, where # is a number.
4018
When you provide files, you can use their current pathname or the pathname
4019
from the target revision. So you can use revert to "undelete" a file by
4020
name. If you name a directory, all the contents of that directory will be
4023
Any files that have been newly added since that revision will be deleted,
4024
with a backup kept if appropriate. Directories containing unknown files
4025
will not be deleted.
4027
The working tree contains a list of pending merged revisions, which will
4028
be included as parents in the next commit. Normally, revert clears that
4029
list as well as reverting the files. If any files are specified, revert
4030
leaves the pending merge list alone and reverts only the files. Use "bzr
4031
revert ." in the tree root to revert all files but keep the merge record,
4032
and "bzr revert --forget-merges" to clear the pending merge list without
4033
reverting any files.
4036
_see_also = ['cat', 'export']
4039
Option('no-backup', "Do not save backups of reverted files."),
4040
Option('forget-merges',
4041
'Remove pending merge marker, without changing any files.'),
4043
takes_args = ['file*']
4045
def run(self, revision=None, no_backup=False, file_list=None,
4046
forget_merges=None):
4047
tree, file_list = tree_files(file_list)
4051
tree.set_parent_ids(tree.get_parent_ids()[:1])
4053
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4058
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4059
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4060
pb = ui.ui_factory.nested_progress_bar()
4062
tree.revert(file_list, rev_tree, not no_backup, pb,
4063
report_changes=True)
4068
class cmd_assert_fail(Command):
4069
"""Test reporting of assertion failures"""
4070
# intended just for use in testing
4075
raise AssertionError("always fails")
4078
class cmd_help(Command):
4079
"""Show help on a command or other topic.
4082
_see_also = ['topics']
4084
Option('long', 'Show help on all commands.'),
4086
takes_args = ['topic?']
4087
aliases = ['?', '--help', '-?', '-h']
4090
def run(self, topic=None, long=False):
4092
if topic is None and long:
4094
bzrlib.help.help(topic)
4097
class cmd_shell_complete(Command):
4098
"""Show appropriate completions for context.
4100
For a list of all available commands, say 'bzr shell-complete'.
4102
takes_args = ['context?']
4107
def run(self, context=None):
4108
import shellcomplete
4109
shellcomplete.shellcomplete(context)
4112
class cmd_missing(Command):
4113
"""Show unmerged/unpulled revisions between two branches.
4115
OTHER_BRANCH may be local or remote.
4117
To filter on a range of revisions, you can use the command -r begin..end
4118
-r revision requests a specific revision, -r ..end or -r begin.. are
4123
Determine the missing revisions between this and the branch at the
4124
remembered pull location::
4128
Determine the missing revisions between this and another branch::
4130
bzr missing http://server/branch
4132
Determine the missing revisions up to a specific revision on the other
4135
bzr missing -r ..-10
4137
Determine the missing revisions up to a specific revision on this
4140
bzr missing --my-revision ..-10
4143
_see_also = ['merge', 'pull']
4144
takes_args = ['other_branch?']
4146
Option('reverse', 'Reverse the order of revisions.'),
4148
'Display changes in the local branch only.'),
4149
Option('this' , 'Same as --mine-only.'),
4150
Option('theirs-only',
4151
'Display changes in the remote branch only.'),
4152
Option('other', 'Same as --theirs-only.'),
4156
custom_help('revision',
4157
help='Filter on other branch revisions (inclusive). '
4158
'See "help revisionspec" for details.'),
4159
Option('my-revision',
4160
type=_parse_revision_str,
4161
help='Filter on local branch revisions (inclusive). '
4162
'See "help revisionspec" for details.'),
4163
Option('include-merges',
4164
'Show all revisions in addition to the mainline ones.'),
4166
encoding_type = 'replace'
4169
def run(self, other_branch=None, reverse=False, mine_only=False,
4171
log_format=None, long=False, short=False, line=False,
4172
show_ids=False, verbose=False, this=False, other=False,
4173
include_merges=False, revision=None, my_revision=None):
4174
from bzrlib.missing import find_unmerged, iter_log_revisions
4183
# TODO: We should probably check that we don't have mine-only and
4184
# theirs-only set, but it gets complicated because we also have
4185
# this and other which could be used.
4192
local_branch = Branch.open_containing(u".")[0]
4193
parent = local_branch.get_parent()
4194
if other_branch is None:
4195
other_branch = parent
4196
if other_branch is None:
4197
raise errors.BzrCommandError("No peer location known"
4199
display_url = urlutils.unescape_for_display(parent,
4201
message("Using saved parent location: "
4202
+ display_url + "\n")
4204
remote_branch = Branch.open(other_branch)
4205
if remote_branch.base == local_branch.base:
4206
remote_branch = local_branch
4208
local_revid_range = _revision_range_to_revid_range(
4209
_get_revision_range(my_revision, local_branch,
4212
remote_revid_range = _revision_range_to_revid_range(
4213
_get_revision_range(revision,
4214
remote_branch, self.name()))
4216
local_branch.lock_read()
4218
remote_branch.lock_read()
4220
local_extra, remote_extra = find_unmerged(
4221
local_branch, remote_branch, restrict,
4222
backward=not reverse,
4223
include_merges=include_merges,
4224
local_revid_range=local_revid_range,
4225
remote_revid_range=remote_revid_range)
4227
if log_format is None:
4228
registry = log.log_formatter_registry
4229
log_format = registry.get_default(local_branch)
4230
lf = log_format(to_file=self.outf,
4232
show_timezone='original')
4235
if local_extra and not theirs_only:
4236
message("You have %d extra revision(s):\n" %
4238
for revision in iter_log_revisions(local_extra,
4239
local_branch.repository,
4241
lf.log_revision(revision)
4242
printed_local = True
4245
printed_local = False
4247
if remote_extra and not mine_only:
4248
if printed_local is True:
4250
message("You are missing %d revision(s):\n" %
4252
for revision in iter_log_revisions(remote_extra,
4253
remote_branch.repository,
4255
lf.log_revision(revision)
4258
if mine_only and not local_extra:
4259
# We checked local, and found nothing extra
4260
message('This branch is up to date.\n')
4261
elif theirs_only and not remote_extra:
4262
# We checked remote, and found nothing extra
4263
message('Other branch is up to date.\n')
4264
elif not (mine_only or theirs_only or local_extra or
4266
# We checked both branches, and neither one had extra
4268
message("Branches are up to date.\n")
4270
remote_branch.unlock()
4272
local_branch.unlock()
4273
if not status_code and parent is None and other_branch is not None:
4274
local_branch.lock_write()
4276
# handle race conditions - a parent might be set while we run.
4277
if local_branch.get_parent() is None:
4278
local_branch.set_parent(remote_branch.base)
4280
local_branch.unlock()
4284
class cmd_pack(Command):
4285
"""Compress the data within a repository."""
4287
_see_also = ['repositories']
4288
takes_args = ['branch_or_repo?']
4290
def run(self, branch_or_repo='.'):
4291
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4293
branch = dir.open_branch()
4294
repository = branch.repository
4295
except errors.NotBranchError:
4296
repository = dir.open_repository()
4300
class cmd_plugins(Command):
4301
"""List the installed plugins.
4303
This command displays the list of installed plugins including
4304
version of plugin and a short description of each.
4306
--verbose shows the path where each plugin is located.
4308
A plugin is an external component for Bazaar that extends the
4309
revision control system, by adding or replacing code in Bazaar.
4310
Plugins can do a variety of things, including overriding commands,
4311
adding new commands, providing additional network transports and
4312
customizing log output.
4314
See the Bazaar web site, http://bazaar-vcs.org, for further
4315
information on plugins including where to find them and how to
4316
install them. Instructions are also provided there on how to
4317
write new plugins using the Python programming language.
4319
takes_options = ['verbose']
4322
def run(self, verbose=False):
4323
import bzrlib.plugin
4324
from inspect import getdoc
4326
for name, plugin in bzrlib.plugin.plugins().items():
4327
version = plugin.__version__
4328
if version == 'unknown':
4330
name_ver = '%s %s' % (name, version)
4331
d = getdoc(plugin.module)
4333
doc = d.split('\n')[0]
4335
doc = '(no description)'
4336
result.append((name_ver, doc, plugin.path()))
4337
for name_ver, doc, path in sorted(result):
4345
class cmd_testament(Command):
4346
"""Show testament (signing-form) of a revision."""
4349
Option('long', help='Produce long-format testament.'),
4351
help='Produce a strict-format testament.')]
4352
takes_args = ['branch?']
4354
def run(self, branch=u'.', revision=None, long=False, strict=False):
4355
from bzrlib.testament import Testament, StrictTestament
4357
testament_class = StrictTestament
4359
testament_class = Testament
4361
b = Branch.open_containing(branch)[0]
4363
b = Branch.open(branch)
4366
if revision is None:
4367
rev_id = b.last_revision()
4369
rev_id = revision[0].as_revision_id(b)
4370
t = testament_class.from_revision(b.repository, rev_id)
4372
sys.stdout.writelines(t.as_text_lines())
4374
sys.stdout.write(t.as_short_text())
4379
class cmd_annotate(Command):
4380
"""Show the origin of each line in a file.
4382
This prints out the given file with an annotation on the left side
4383
indicating which revision, author and date introduced the change.
4385
If the origin is the same for a run of consecutive lines, it is
4386
shown only at the top, unless the --all option is given.
4388
# TODO: annotate directories; showing when each file was last changed
4389
# TODO: if the working copy is modified, show annotations on that
4390
# with new uncommitted lines marked
4391
aliases = ['ann', 'blame', 'praise']
4392
takes_args = ['filename']
4393
takes_options = [Option('all', help='Show annotations on all lines.'),
4394
Option('long', help='Show commit date in annotations.'),
4398
encoding_type = 'exact'
4401
def run(self, filename, all=False, long=False, revision=None,
4403
from bzrlib.annotate import annotate_file, annotate_file_tree
4404
wt, branch, relpath = \
4405
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4411
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4415
file_id = wt.path2id(relpath)
4417
file_id = tree.path2id(relpath)
4419
raise errors.NotVersionedError(filename)
4420
file_version = tree.inventory[file_id].revision
4421
if wt is not None and revision is None:
4422
# If there is a tree and we're not annotating historical
4423
# versions, annotate the working tree's content.
4424
annotate_file_tree(wt, file_id, self.outf, long, all,
4427
annotate_file(branch, file_version, file_id, long, all,
4428
self.outf, show_ids=show_ids)
4438
class cmd_re_sign(Command):
4439
"""Create a digital signature for an existing revision."""
4440
# TODO be able to replace existing ones.
4442
hidden = True # is this right ?
4443
takes_args = ['revision_id*']
4444
takes_options = ['revision']
4446
def run(self, revision_id_list=None, revision=None):
4447
if revision_id_list is not None and revision is not None:
4448
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4449
if revision_id_list is None and revision is None:
4450
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4451
b = WorkingTree.open_containing(u'.')[0].branch
4454
return self._run(b, revision_id_list, revision)
4458
def _run(self, b, revision_id_list, revision):
4459
import bzrlib.gpg as gpg
4460
gpg_strategy = gpg.GPGStrategy(b.get_config())
4461
if revision_id_list is not None:
4462
b.repository.start_write_group()
4464
for revision_id in revision_id_list:
4465
b.repository.sign_revision(revision_id, gpg_strategy)
4467
b.repository.abort_write_group()
4470
b.repository.commit_write_group()
4471
elif revision is not None:
4472
if len(revision) == 1:
4473
revno, rev_id = revision[0].in_history(b)
4474
b.repository.start_write_group()
4476
b.repository.sign_revision(rev_id, gpg_strategy)
4478
b.repository.abort_write_group()
4481
b.repository.commit_write_group()
4482
elif len(revision) == 2:
4483
# are they both on rh- if so we can walk between them
4484
# might be nice to have a range helper for arbitrary
4485
# revision paths. hmm.
4486
from_revno, from_revid = revision[0].in_history(b)
4487
to_revno, to_revid = revision[1].in_history(b)
4488
if to_revid is None:
4489
to_revno = b.revno()
4490
if from_revno is None or to_revno is None:
4491
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4492
b.repository.start_write_group()
4494
for revno in range(from_revno, to_revno + 1):
4495
b.repository.sign_revision(b.get_rev_id(revno),
4498
b.repository.abort_write_group()
4501
b.repository.commit_write_group()
4503
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4506
class cmd_bind(Command):
4507
"""Convert the current branch into a checkout of the supplied branch.
4509
Once converted into a checkout, commits must succeed on the master branch
4510
before they will be applied to the local branch.
4512
Bound branches use the nickname of its master branch unless it is set
4513
locally, in which case binding will update the the local nickname to be
4517
_see_also = ['checkouts', 'unbind']
4518
takes_args = ['location?']
4521
def run(self, location=None):
4522
b, relpath = Branch.open_containing(u'.')
4523
if location is None:
4525
location = b.get_old_bound_location()
4526
except errors.UpgradeRequired:
4527
raise errors.BzrCommandError('No location supplied. '
4528
'This format does not remember old locations.')
4530
if location is None:
4531
raise errors.BzrCommandError('No location supplied and no '
4532
'previous location known')
4533
b_other = Branch.open(location)
4536
except errors.DivergedBranches:
4537
raise errors.BzrCommandError('These branches have diverged.'
4538
' Try merging, and then bind again.')
4539
if b.get_config().has_explicit_nickname():
4540
b.nick = b_other.nick
4543
class cmd_unbind(Command):
4544
"""Convert the current checkout into a regular branch.
4546
After unbinding, the local branch is considered independent and subsequent
4547
commits will be local only.
4550
_see_also = ['checkouts', 'bind']
4555
b, relpath = Branch.open_containing(u'.')
4557
raise errors.BzrCommandError('Local branch is not bound')
4560
class cmd_uncommit(Command):
4561
"""Remove the last committed revision.
4563
--verbose will print out what is being removed.
4564
--dry-run will go through all the motions, but not actually
4567
If --revision is specified, uncommit revisions to leave the branch at the
4568
specified revision. For example, "bzr uncommit -r 15" will leave the
4569
branch at revision 15.
4571
Uncommit leaves the working tree ready for a new commit. The only change
4572
it may make is to restore any pending merges that were present before
4576
# TODO: jam 20060108 Add an option to allow uncommit to remove
4577
# unreferenced information in 'branch-as-repository' branches.
4578
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4579
# information in shared branches as well.
4580
_see_also = ['commit']
4581
takes_options = ['verbose', 'revision',
4582
Option('dry-run', help='Don\'t actually make changes.'),
4583
Option('force', help='Say yes to all questions.'),
4585
help="Only remove the commits from the local branch"
4586
" when in a checkout."
4589
takes_args = ['location?']
4591
encoding_type = 'replace'
4593
def run(self, location=None,
4594
dry_run=False, verbose=False,
4595
revision=None, force=False, local=False):
4596
if location is None:
4598
control, relpath = bzrdir.BzrDir.open_containing(location)
4600
tree = control.open_workingtree()
4602
except (errors.NoWorkingTree, errors.NotLocalUrl):
4604
b = control.open_branch()
4606
if tree is not None:
4611
return self._run(b, tree, dry_run, verbose, revision, force,
4614
if tree is not None:
4619
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4620
from bzrlib.log import log_formatter, show_log
4621
from bzrlib.uncommit import uncommit
4623
last_revno, last_rev_id = b.last_revision_info()
4626
if revision is None:
4628
rev_id = last_rev_id
4630
# 'bzr uncommit -r 10' actually means uncommit
4631
# so that the final tree is at revno 10.
4632
# but bzrlib.uncommit.uncommit() actually uncommits
4633
# the revisions that are supplied.
4634
# So we need to offset it by one
4635
revno = revision[0].in_history(b).revno + 1
4636
if revno <= last_revno:
4637
rev_id = b.get_rev_id(revno)
4639
if rev_id is None or _mod_revision.is_null(rev_id):
4640
self.outf.write('No revisions to uncommit.\n')
4643
lf = log_formatter('short',
4645
show_timezone='original')
4650
direction='forward',
4651
start_revision=revno,
4652
end_revision=last_revno)
4655
print 'Dry-run, pretending to remove the above revisions.'
4657
val = raw_input('Press <enter> to continue')
4659
print 'The above revision(s) will be removed.'
4661
val = raw_input('Are you sure [y/N]? ')
4662
if val.lower() not in ('y', 'yes'):
4666
mutter('Uncommitting from {%s} to {%s}',
4667
last_rev_id, rev_id)
4668
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4669
revno=revno, local=local)
4670
note('You can restore the old tip by running:\n'
4671
' bzr pull . -r revid:%s', last_rev_id)
4674
class cmd_break_lock(Command):
4675
"""Break a dead lock on a repository, branch or working directory.
4677
CAUTION: Locks should only be broken when you are sure that the process
4678
holding the lock has been stopped.
4680
You can get information on what locks are open via the 'bzr info' command.
4685
takes_args = ['location?']
4687
def run(self, location=None, show=False):
4688
if location is None:
4690
control, relpath = bzrdir.BzrDir.open_containing(location)
4692
control.break_lock()
4693
except NotImplementedError:
4697
class cmd_wait_until_signalled(Command):
4698
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4700
This just prints a line to signal when it is ready, then blocks on stdin.
4706
sys.stdout.write("running\n")
4708
sys.stdin.readline()
4711
class cmd_serve(Command):
4712
"""Run the bzr server."""
4714
aliases = ['server']
4718
help='Serve on stdin/out for use from inetd or sshd.'),
4719
RegistryOption('protocol',
4720
help="Protocol to serve.",
4721
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4722
value_switches=True),
4724
help='Listen for connections on nominated port of the form '
4725
'[hostname:]portnumber. Passing 0 as the port number will '
4726
'result in a dynamically allocated port. The default port '
4727
'depends on the protocol.',
4730
help='Serve contents of this directory.',
4732
Option('allow-writes',
4733
help='By default the server is a readonly server. Supplying '
4734
'--allow-writes enables write access to the contents of '
4735
'the served directory and below.'
4739
def get_host_and_port(self, port):
4740
"""Return the host and port to run the smart server on.
4742
If 'port' is None, None will be returned for the host and port.
4744
If 'port' has a colon in it, the string before the colon will be
4745
interpreted as the host.
4747
:param port: A string of the port to run the server on.
4748
:return: A tuple of (host, port), where 'host' is a host name or IP,
4749
and port is an integer TCP/IP port.
4752
if port is not None:
4754
host, port = port.split(':')
4758
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4760
from bzrlib.transport import get_transport, transport_server_registry
4761
if directory is None:
4762
directory = os.getcwd()
4763
if protocol is None:
4764
protocol = transport_server_registry.get()
4765
host, port = self.get_host_and_port(port)
4766
url = urlutils.local_path_to_url(directory)
4767
if not allow_writes:
4768
url = 'readonly+' + url
4769
transport = get_transport(url)
4770
protocol(transport, host, port, inet)
4773
class cmd_join(Command):
4774
"""Combine a tree into its containing tree.
4776
This command requires the target tree to be in a rich-root format.
4778
The TREE argument should be an independent tree, inside another tree, but
4779
not part of it. (Such trees can be produced by "bzr split", but also by
4780
running "bzr branch" with the target inside a tree.)
4782
The result is a combined tree, with the subtree no longer an independant
4783
part. This is marked as a merge of the subtree into the containing tree,
4784
and all history is preserved.
4787
_see_also = ['split']
4788
takes_args = ['tree']
4790
Option('reference', help='Join by reference.', hidden=True),
4793
def run(self, tree, reference=False):
4794
sub_tree = WorkingTree.open(tree)
4795
parent_dir = osutils.dirname(sub_tree.basedir)
4796
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4797
repo = containing_tree.branch.repository
4798
if not repo.supports_rich_root():
4799
raise errors.BzrCommandError(
4800
"Can't join trees because %s doesn't support rich root data.\n"
4801
"You can use bzr upgrade on the repository."
4805
containing_tree.add_reference(sub_tree)
4806
except errors.BadReferenceTarget, e:
4807
# XXX: Would be better to just raise a nicely printable
4808
# exception from the real origin. Also below. mbp 20070306
4809
raise errors.BzrCommandError("Cannot join %s. %s" %
4813
containing_tree.subsume(sub_tree)
4814
except errors.BadSubsumeSource, e:
4815
raise errors.BzrCommandError("Cannot join %s. %s" %
4819
class cmd_split(Command):
4820
"""Split a subdirectory of a tree into a separate tree.
4822
This command will produce a target tree in a format that supports
4823
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4824
converted into earlier formats like 'dirstate-tags'.
4826
The TREE argument should be a subdirectory of a working tree. That
4827
subdirectory will be converted into an independent tree, with its own
4828
branch. Commits in the top-level tree will not apply to the new subtree.
4831
_see_also = ['join']
4832
takes_args = ['tree']
4834
def run(self, tree):
4835
containing_tree, subdir = WorkingTree.open_containing(tree)
4836
sub_id = containing_tree.path2id(subdir)
4838
raise errors.NotVersionedError(subdir)
4840
containing_tree.extract(sub_id)
4841
except errors.RootNotRich:
4842
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4845
class cmd_merge_directive(Command):
4846
"""Generate a merge directive for auto-merge tools.
4848
A directive requests a merge to be performed, and also provides all the
4849
information necessary to do so. This means it must either include a
4850
revision bundle, or the location of a branch containing the desired
4853
A submit branch (the location to merge into) must be supplied the first
4854
time the command is issued. After it has been supplied once, it will
4855
be remembered as the default.
4857
A public branch is optional if a revision bundle is supplied, but required
4858
if --diff or --plain is specified. It will be remembered as the default
4859
after the first use.
4862
takes_args = ['submit_branch?', 'public_branch?']
4866
_see_also = ['send']
4869
RegistryOption.from_kwargs('patch-type',
4870
'The type of patch to include in the directive.',
4872
value_switches=True,
4874
bundle='Bazaar revision bundle (default).',
4875
diff='Normal unified diff.',
4876
plain='No patch, just directive.'),
4877
Option('sign', help='GPG-sign the directive.'), 'revision',
4878
Option('mail-to', type=str,
4879
help='Instead of printing the directive, email to this address.'),
4880
Option('message', type=str, short_name='m',
4881
help='Message to use when committing this merge.')
4884
encoding_type = 'exact'
4886
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4887
sign=False, revision=None, mail_to=None, message=None):
4888
from bzrlib.revision import ensure_null, NULL_REVISION
4889
include_patch, include_bundle = {
4890
'plain': (False, False),
4891
'diff': (True, False),
4892
'bundle': (True, True),
4894
branch = Branch.open('.')
4895
stored_submit_branch = branch.get_submit_branch()
4896
if submit_branch is None:
4897
submit_branch = stored_submit_branch
4899
if stored_submit_branch is None:
4900
branch.set_submit_branch(submit_branch)
4901
if submit_branch is None:
4902
submit_branch = branch.get_parent()
4903
if submit_branch is None:
4904
raise errors.BzrCommandError('No submit branch specified or known')
4906
stored_public_branch = branch.get_public_branch()
4907
if public_branch is None:
4908
public_branch = stored_public_branch
4909
elif stored_public_branch is None:
4910
branch.set_public_branch(public_branch)
4911
if not include_bundle and public_branch is None:
4912
raise errors.BzrCommandError('No public branch specified or'
4914
base_revision_id = None
4915
if revision is not None:
4916
if len(revision) > 2:
4917
raise errors.BzrCommandError('bzr merge-directive takes '
4918
'at most two one revision identifiers')
4919
revision_id = revision[-1].as_revision_id(branch)
4920
if len(revision) == 2:
4921
base_revision_id = revision[0].as_revision_id(branch)
4923
revision_id = branch.last_revision()
4924
revision_id = ensure_null(revision_id)
4925
if revision_id == NULL_REVISION:
4926
raise errors.BzrCommandError('No revisions to bundle.')
4927
directive = merge_directive.MergeDirective2.from_objects(
4928
branch.repository, revision_id, time.time(),
4929
osutils.local_time_offset(), submit_branch,
4930
public_branch=public_branch, include_patch=include_patch,
4931
include_bundle=include_bundle, message=message,
4932
base_revision_id=base_revision_id)
4935
self.outf.write(directive.to_signed(branch))
4937
self.outf.writelines(directive.to_lines())
4939
message = directive.to_email(mail_to, branch, sign)
4940
s = SMTPConnection(branch.get_config())
4941
s.send_email(message)
4944
class cmd_send(Command):
4945
"""Mail or create a merge-directive for submitting changes.
4947
A merge directive provides many things needed for requesting merges:
4949
* A machine-readable description of the merge to perform
4951
* An optional patch that is a preview of the changes requested
4953
* An optional bundle of revision data, so that the changes can be applied
4954
directly from the merge directive, without retrieving data from a
4957
If --no-bundle is specified, then public_branch is needed (and must be
4958
up-to-date), so that the receiver can perform the merge using the
4959
public_branch. The public_branch is always included if known, so that
4960
people can check it later.
4962
The submit branch defaults to the parent, but can be overridden. Both
4963
submit branch and public branch will be remembered if supplied.
4965
If a public_branch is known for the submit_branch, that public submit
4966
branch is used in the merge instructions. This means that a local mirror
4967
can be used as your actual submit branch, once you have set public_branch
4970
Mail is sent using your preferred mail program. This should be transparent
4971
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4972
If the preferred client can't be found (or used), your editor will be used.
4974
To use a specific mail program, set the mail_client configuration option.
4975
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4976
specific clients are "claws", "evolution", "kmail", "mutt", and
4977
"thunderbird"; generic options are "default", "editor", "emacsclient",
4978
"mapi", and "xdg-email". Plugins may also add supported clients.
4980
If mail is being sent, a to address is required. This can be supplied
4981
either on the commandline, by setting the submit_to configuration
4982
option in the branch itself or the child_submit_to configuration option
4983
in the submit branch.
4985
Two formats are currently supported: "4" uses revision bundle format 4 and
4986
merge directive format 2. It is significantly faster and smaller than
4987
older formats. It is compatible with Bazaar 0.19 and later. It is the
4988
default. "0.9" uses revision bundle format 0.9 and merge directive
4989
format 1. It is compatible with Bazaar 0.12 - 0.18.
4991
The merge directives created by bzr send may be applied using bzr merge or
4992
bzr pull by specifying a file containing a merge directive as the location.
4995
encoding_type = 'exact'
4997
_see_also = ['merge', 'pull']
4999
takes_args = ['submit_branch?', 'public_branch?']
5003
help='Do not include a bundle in the merge directive.'),
5004
Option('no-patch', help='Do not include a preview patch in the merge'
5007
help='Remember submit and public branch.'),
5009
help='Branch to generate the submission from, '
5010
'rather than the one containing the working directory.',
5013
Option('output', short_name='o',
5014
help='Write merge directive to this file; '
5015
'use - for stdout.',
5018
help='Refuse to send if there are uncommitted changes in'
5019
' the working tree, --no-strict disables the check.'),
5020
Option('mail-to', help='Mail the request to this address.',
5024
Option('body', help='Body for the email.', type=unicode),
5025
RegistryOption('format',
5026
help='Use the specified output format.',
5027
lazy_registry=('bzrlib.send', 'format_registry')),
5030
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5031
no_patch=False, revision=None, remember=False, output=None,
5032
format=None, mail_to=None, message=None, body=None,
5033
strict=None, **kwargs):
5034
from bzrlib.send import send
5035
return send(submit_branch, revision, public_branch, remember,
5036
format, no_bundle, no_patch, output,
5037
kwargs.get('from', '.'), mail_to, message, body,
5042
class cmd_bundle_revisions(cmd_send):
5043
"""Create a merge-directive for submitting changes.
5045
A merge directive provides many things needed for requesting merges:
5047
* A machine-readable description of the merge to perform
5049
* An optional patch that is a preview of the changes requested
5051
* An optional bundle of revision data, so that the changes can be applied
5052
directly from the merge directive, without retrieving data from a
5055
If --no-bundle is specified, then public_branch is needed (and must be
5056
up-to-date), so that the receiver can perform the merge using the
5057
public_branch. The public_branch is always included if known, so that
5058
people can check it later.
5060
The submit branch defaults to the parent, but can be overridden. Both
5061
submit branch and public branch will be remembered if supplied.
5063
If a public_branch is known for the submit_branch, that public submit
5064
branch is used in the merge instructions. This means that a local mirror
5065
can be used as your actual submit branch, once you have set public_branch
5068
Two formats are currently supported: "4" uses revision bundle format 4 and
5069
merge directive format 2. It is significantly faster and smaller than
5070
older formats. It is compatible with Bazaar 0.19 and later. It is the
5071
default. "0.9" uses revision bundle format 0.9 and merge directive
5072
format 1. It is compatible with Bazaar 0.12 - 0.18.
5077
help='Do not include a bundle in the merge directive.'),
5078
Option('no-patch', help='Do not include a preview patch in the merge'
5081
help='Remember submit and public branch.'),
5083
help='Branch to generate the submission from, '
5084
'rather than the one containing the working directory.',
5087
Option('output', short_name='o', help='Write directive to this file.',
5090
help='Refuse to bundle revisions if there are uncommitted'
5091
' changes in the working tree, --no-strict disables the check.'),
5093
RegistryOption('format',
5094
help='Use the specified output format.',
5095
lazy_registry=('bzrlib.send', 'format_registry')),
5097
aliases = ['bundle']
5099
_see_also = ['send', 'merge']
5103
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5104
no_patch=False, revision=None, remember=False, output=None,
5105
format=None, strict=None, **kwargs):
5108
from bzrlib.send import send
5109
return send(submit_branch, revision, public_branch, remember,
5110
format, no_bundle, no_patch, output,
5111
kwargs.get('from', '.'), None, None, None,
5112
self.outf, strict=strict)
5115
class cmd_tag(Command):
5116
"""Create, remove or modify a tag naming a revision.
5118
Tags give human-meaningful names to revisions. Commands that take a -r
5119
(--revision) option can be given -rtag:X, where X is any previously
5122
Tags are stored in the branch. Tags are copied from one branch to another
5123
along when you branch, push, pull or merge.
5125
It is an error to give a tag name that already exists unless you pass
5126
--force, in which case the tag is moved to point to the new revision.
5128
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5129
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5132
_see_also = ['commit', 'tags']
5133
takes_args = ['tag_name']
5136
help='Delete this tag rather than placing it.',
5139
help='Branch in which to place the tag.',
5144
help='Replace existing tags.',
5149
def run(self, tag_name,
5155
branch, relpath = Branch.open_containing(directory)
5159
branch.tags.delete_tag(tag_name)
5160
self.outf.write('Deleted tag %s.\n' % tag_name)
5163
if len(revision) != 1:
5164
raise errors.BzrCommandError(
5165
"Tags can only be placed on a single revision, "
5167
revision_id = revision[0].as_revision_id(branch)
5169
revision_id = branch.last_revision()
5170
if (not force) and branch.tags.has_tag(tag_name):
5171
raise errors.TagAlreadyExists(tag_name)
5172
branch.tags.set_tag(tag_name, revision_id)
5173
self.outf.write('Created tag %s.\n' % tag_name)
5178
class cmd_tags(Command):
5181
This command shows a table of tag names and the revisions they reference.
5187
help='Branch whose tags should be displayed.',
5191
RegistryOption.from_kwargs('sort',
5192
'Sort tags by different criteria.', title='Sorting',
5193
alpha='Sort tags lexicographically (default).',
5194
time='Sort tags chronologically.',
5207
branch, relpath = Branch.open_containing(directory)
5209
tags = branch.tags.get_tag_dict().items()
5216
graph = branch.repository.get_graph()
5217
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5218
revid1, revid2 = rev1.rev_id, rev2.rev_id
5219
# only show revisions between revid1 and revid2 (inclusive)
5220
tags = [(tag, revid) for tag, revid in tags if
5221
graph.is_between(revid, revid1, revid2)]
5224
elif sort == 'time':
5226
for tag, revid in tags:
5228
revobj = branch.repository.get_revision(revid)
5229
except errors.NoSuchRevision:
5230
timestamp = sys.maxint # place them at the end
5232
timestamp = revobj.timestamp
5233
timestamps[revid] = timestamp
5234
tags.sort(key=lambda x: timestamps[x[1]])
5236
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5237
for index, (tag, revid) in enumerate(tags):
5239
revno = branch.revision_id_to_dotted_revno(revid)
5240
if isinstance(revno, tuple):
5241
revno = '.'.join(map(str, revno))
5242
except errors.NoSuchRevision:
5243
# Bad tag data/merges can lead to tagged revisions
5244
# which are not in this branch. Fail gracefully ...
5246
tags[index] = (tag, revno)
5249
for tag, revspec in tags:
5250
self.outf.write('%-20s %s\n' % (tag, revspec))
5253
class cmd_reconfigure(Command):
5254
"""Reconfigure the type of a bzr directory.
5256
A target configuration must be specified.
5258
For checkouts, the bind-to location will be auto-detected if not specified.
5259
The order of preference is
5260
1. For a lightweight checkout, the current bound location.
5261
2. For branches that used to be checkouts, the previously-bound location.
5262
3. The push location.
5263
4. The parent location.
5264
If none of these is available, --bind-to must be specified.
5267
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5268
takes_args = ['location?']
5270
RegistryOption.from_kwargs(
5272
title='Target type',
5273
help='The type to reconfigure the directory to.',
5274
value_switches=True, enum_switch=False,
5275
branch='Reconfigure to be an unbound branch with no working tree.',
5276
tree='Reconfigure to be an unbound branch with a working tree.',
5277
checkout='Reconfigure to be a bound branch with a working tree.',
5278
lightweight_checkout='Reconfigure to be a lightweight'
5279
' checkout (with no local history).',
5280
standalone='Reconfigure to be a standalone branch '
5281
'(i.e. stop using shared repository).',
5282
use_shared='Reconfigure to use a shared repository.',
5283
with_trees='Reconfigure repository to create '
5284
'working trees on branches by default.',
5285
with_no_trees='Reconfigure repository to not create '
5286
'working trees on branches by default.'
5288
Option('bind-to', help='Branch to bind checkout to.', type=str),
5290
help='Perform reconfiguration even if local changes'
5292
Option('stacked-on',
5293
help='Reconfigure a branch to be stacked on another branch.',
5297
help='Reconfigure a branch to be unstacked. This '
5298
'may require copying substantial data into it.',
5302
def run(self, location=None, target_type=None, bind_to=None, force=False,
5305
directory = bzrdir.BzrDir.open(location)
5306
if stacked_on and unstacked:
5307
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5308
elif stacked_on is not None:
5309
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5311
reconfigure.ReconfigureUnstacked().apply(directory)
5312
# At the moment you can use --stacked-on and a different
5313
# reconfiguration shape at the same time; there seems no good reason
5315
if target_type is None:
5316
if stacked_on or unstacked:
5319
raise errors.BzrCommandError('No target configuration '
5321
elif target_type == 'branch':
5322
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5323
elif target_type == 'tree':
5324
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5325
elif target_type == 'checkout':
5326
reconfiguration = reconfigure.Reconfigure.to_checkout(
5328
elif target_type == 'lightweight-checkout':
5329
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5331
elif target_type == 'use-shared':
5332
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5333
elif target_type == 'standalone':
5334
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5335
elif target_type == 'with-trees':
5336
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5338
elif target_type == 'with-no-trees':
5339
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5341
reconfiguration.apply(force)
5344
class cmd_switch(Command):
5345
"""Set the branch of a checkout and update.
5347
For lightweight checkouts, this changes the branch being referenced.
5348
For heavyweight checkouts, this checks that there are no local commits
5349
versus the current bound branch, then it makes the local branch a mirror
5350
of the new location and binds to it.
5352
In both cases, the working tree is updated and uncommitted changes
5353
are merged. The user can commit or revert these as they desire.
5355
Pending merges need to be committed or reverted before using switch.
5357
The path to the branch to switch to can be specified relative to the parent
5358
directory of the current branch. For example, if you are currently in a
5359
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5362
Bound branches use the nickname of its master branch unless it is set
5363
locally, in which case switching will update the the local nickname to be
5367
takes_args = ['to_location']
5368
takes_options = [Option('force',
5369
help='Switch even if local commits will be lost.'),
5370
Option('create-branch', short_name='b',
5371
help='Create the target branch from this one before'
5372
' switching to it.'),
5375
def run(self, to_location, force=False, create_branch=False):
5376
from bzrlib import switch
5378
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5380
branch = control_dir.open_branch()
5381
had_explicit_nick = branch.get_config().has_explicit_nickname()
5382
except errors.NotBranchError:
5384
had_explicit_nick = False
5387
raise errors.BzrCommandError('cannot create branch without'
5389
if '/' not in to_location and '\\' not in to_location:
5390
# This path is meant to be relative to the existing branch
5391
this_url = self._get_branch_location(control_dir)
5392
to_location = urlutils.join(this_url, '..', to_location)
5393
to_branch = branch.bzrdir.sprout(to_location,
5394
possible_transports=[branch.bzrdir.root_transport],
5395
source_branch=branch).open_branch()
5397
# from_branch = control_dir.open_branch()
5398
# except errors.NotBranchError:
5399
# raise BzrCommandError('Cannot create a branch from this'
5400
# ' location when we cannot open this branch')
5401
# from_branch.bzrdir.sprout(
5405
to_branch = Branch.open(to_location)
5406
except errors.NotBranchError:
5407
this_url = self._get_branch_location(control_dir)
5408
to_branch = Branch.open(
5409
urlutils.join(this_url, '..', to_location))
5410
switch.switch(control_dir, to_branch, force)
5411
if had_explicit_nick:
5412
branch = control_dir.open_branch() #get the new branch!
5413
branch.nick = to_branch.nick
5414
note('Switched to branch: %s',
5415
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5417
def _get_branch_location(self, control_dir):
5418
"""Return location of branch for this control dir."""
5420
this_branch = control_dir.open_branch()
5421
# This may be a heavy checkout, where we want the master branch
5422
master_location = this_branch.get_bound_location()
5423
if master_location is not None:
5424
return master_location
5425
# If not, use a local sibling
5426
return this_branch.base
5427
except errors.NotBranchError:
5428
format = control_dir.find_branch_format()
5429
if getattr(format, 'get_reference', None) is not None:
5430
return format.get_reference(control_dir)
5432
return control_dir.root_transport.base
5435
class cmd_view(Command):
5436
"""Manage filtered views.
5438
Views provide a mask over the tree so that users can focus on
5439
a subset of a tree when doing their work. After creating a view,
5440
commands that support a list of files - status, diff, commit, etc -
5441
effectively have that list of files implicitly given each time.
5442
An explicit list of files can still be given but those files
5443
must be within the current view.
5445
In most cases, a view has a short life-span: it is created to make
5446
a selected change and is deleted once that change is committed.
5447
At other times, you may wish to create one or more named views
5448
and switch between them.
5450
To disable the current view without deleting it, you can switch to
5451
the pseudo view called ``off``. This can be useful when you need
5452
to see the whole tree for an operation or two (e.g. merge) but
5453
want to switch back to your view after that.
5456
To define the current view::
5458
bzr view file1 dir1 ...
5460
To list the current view::
5464
To delete the current view::
5468
To disable the current view without deleting it::
5470
bzr view --switch off
5472
To define a named view and switch to it::
5474
bzr view --name view-name file1 dir1 ...
5476
To list a named view::
5478
bzr view --name view-name
5480
To delete a named view::
5482
bzr view --name view-name --delete
5484
To switch to a named view::
5486
bzr view --switch view-name
5488
To list all views defined::
5492
To delete all views::
5494
bzr view --delete --all
5498
takes_args = ['file*']
5501
help='Apply list or delete action to all views.',
5504
help='Delete the view.',
5507
help='Name of the view to define, list or delete.',
5511
help='Name of the view to switch to.',
5516
def run(self, file_list,
5522
tree, file_list = tree_files(file_list, apply_view=False)
5523
current_view, view_dict = tree.views.get_view_info()
5528
raise errors.BzrCommandError(
5529
"Both --delete and a file list specified")
5531
raise errors.BzrCommandError(
5532
"Both --delete and --switch specified")
5534
tree.views.set_view_info(None, {})
5535
self.outf.write("Deleted all views.\n")
5537
raise errors.BzrCommandError("No current view to delete")
5539
tree.views.delete_view(name)
5540
self.outf.write("Deleted '%s' view.\n" % name)
5543
raise errors.BzrCommandError(
5544
"Both --switch and a file list specified")
5546
raise errors.BzrCommandError(
5547
"Both --switch and --all specified")
5548
elif switch == 'off':
5549
if current_view is None:
5550
raise errors.BzrCommandError("No current view to disable")
5551
tree.views.set_view_info(None, view_dict)
5552
self.outf.write("Disabled '%s' view.\n" % (current_view))
5554
tree.views.set_view_info(switch, view_dict)
5555
view_str = views.view_display_str(tree.views.lookup_view())
5556
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5559
self.outf.write('Views defined:\n')
5560
for view in sorted(view_dict):
5561
if view == current_view:
5565
view_str = views.view_display_str(view_dict[view])
5566
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5568
self.outf.write('No views defined.\n')
5571
# No name given and no current view set
5574
raise errors.BzrCommandError(
5575
"Cannot change the 'off' pseudo view")
5576
tree.views.set_view(name, sorted(file_list))
5577
view_str = views.view_display_str(tree.views.lookup_view())
5578
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5582
# No name given and no current view set
5583
self.outf.write('No current view.\n')
5585
view_str = views.view_display_str(tree.views.lookup_view(name))
5586
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5589
class cmd_hooks(Command):
5595
for hook_key in sorted(hooks.known_hooks.keys()):
5596
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5597
self.outf.write("%s:\n" % type(some_hooks).__name__)
5598
for hook_name, hook_point in sorted(some_hooks.items()):
5599
self.outf.write(" %s:\n" % (hook_name,))
5600
found_hooks = list(hook_point)
5602
for hook in found_hooks:
5603
self.outf.write(" %s\n" %
5604
(some_hooks.get_hook_name(hook),))
5606
self.outf.write(" <no hooks installed>\n")
5609
class cmd_shelve(Command):
5610
"""Temporarily set aside some changes from the current tree.
5612
Shelve allows you to temporarily put changes you've made "on the shelf",
5613
ie. out of the way, until a later time when you can bring them back from
5614
the shelf with the 'unshelve' command. The changes are stored alongside
5615
your working tree, and so they aren't propagated along with your branch nor
5616
will they survive its deletion.
5618
If shelve --list is specified, previously-shelved changes are listed.
5620
Shelve is intended to help separate several sets of changes that have
5621
been inappropriately mingled. If you just want to get rid of all changes
5622
and you don't need to restore them later, use revert. If you want to
5623
shelve all text changes at once, use shelve --all.
5625
If filenames are specified, only the changes to those files will be
5626
shelved. Other files will be left untouched.
5628
If a revision is specified, changes since that revision will be shelved.
5630
You can put multiple items on the shelf, and by default, 'unshelve' will
5631
restore the most recently shelved changes.
5634
takes_args = ['file*']
5638
Option('all', help='Shelve all changes.'),
5640
RegistryOption('writer', 'Method to use for writing diffs.',
5641
bzrlib.option.diff_writer_registry,
5642
value_switches=True, enum_switch=False),
5644
Option('list', help='List shelved changes.'),
5646
help='Destroy removed changes instead of shelving them.'),
5648
_see_also = ['unshelve']
5650
def run(self, revision=None, all=False, file_list=None, message=None,
5651
writer=None, list=False, destroy=False):
5653
return self.run_for_list()
5654
from bzrlib.shelf_ui import Shelver
5656
writer = bzrlib.option.diff_writer_registry.get()
5658
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5659
file_list, message, destroy=destroy)
5663
shelver.work_tree.unlock()
5664
except errors.UserAbort:
5667
def run_for_list(self):
5668
tree = WorkingTree.open_containing('.')[0]
5671
manager = tree.get_shelf_manager()
5672
shelves = manager.active_shelves()
5673
if len(shelves) == 0:
5674
note('No shelved changes.')
5676
for shelf_id in reversed(shelves):
5677
message = manager.get_metadata(shelf_id).get('message')
5679
message = '<no message>'
5680
self.outf.write('%3d: %s\n' % (shelf_id, message))
5686
class cmd_unshelve(Command):
5687
"""Restore shelved changes.
5689
By default, the most recently shelved changes are restored. However if you
5690
specify a shelf by id those changes will be restored instead. This works
5691
best when the changes don't depend on each other.
5694
takes_args = ['shelf_id?']
5696
RegistryOption.from_kwargs(
5697
'action', help="The action to perform.",
5698
enum_switch=False, value_switches=True,
5699
apply="Apply changes and remove from the shelf.",
5700
dry_run="Show changes, but do not apply or remove them.",
5701
delete_only="Delete changes without applying them."
5704
_see_also = ['shelve']
5706
def run(self, shelf_id=None, action='apply'):
5707
from bzrlib.shelf_ui import Unshelver
5708
unshelver = Unshelver.from_args(shelf_id, action)
5712
unshelver.tree.unlock()
5715
class cmd_clean_tree(Command):
5716
"""Remove unwanted files from working tree.
5718
By default, only unknown files, not ignored files, are deleted. Versioned
5719
files are never deleted.
5721
Another class is 'detritus', which includes files emitted by bzr during
5722
normal operations and selftests. (The value of these files decreases with
5725
If no options are specified, unknown files are deleted. Otherwise, option
5726
flags are respected, and may be combined.
5728
To check what clean-tree will do, use --dry-run.
5730
takes_options = [Option('ignored', help='Delete all ignored files.'),
5731
Option('detritus', help='Delete conflict files, merge'
5732
' backups, and failed selftest dirs.'),
5734
help='Delete files unknown to bzr (default).'),
5735
Option('dry-run', help='Show files to delete instead of'
5737
Option('force', help='Do not prompt before deleting.')]
5738
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5740
from bzrlib.clean_tree import clean_tree
5741
if not (unknown or ignored or detritus):
5745
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5746
dry_run=dry_run, no_prompt=force)
5749
class cmd_reference(Command):
5750
"""list, view and set branch locations for nested trees.
5752
If no arguments are provided, lists the branch locations for nested trees.
5753
If one argument is provided, display the branch location for that tree.
5754
If two arguments are provided, set the branch location for that tree.
5759
takes_args = ['path?', 'location?']
5761
def run(self, path=None, location=None):
5763
if path is not None:
5765
tree, branch, relpath =(
5766
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5767
if path is not None:
5770
tree = branch.basis_tree()
5772
info = branch._get_all_reference_info().iteritems()
5773
self._display_reference_info(tree, branch, info)
5775
file_id = tree.path2id(path)
5777
raise errors.NotVersionedError(path)
5778
if location is None:
5779
info = [(file_id, branch.get_reference_info(file_id))]
5780
self._display_reference_info(tree, branch, info)
5782
branch.set_reference_info(file_id, path, location)
5784
def _display_reference_info(self, tree, branch, info):
5786
for file_id, (path, location) in info:
5788
path = tree.id2path(file_id)
5789
except errors.NoSuchId:
5791
ref_list.append((path, location))
5792
for path, location in sorted(ref_list):
5793
self.outf.write('%s %s\n' % (path, location))
5796
# these get imported and then picked up by the scan for cmd_*
5797
# TODO: Some more consistent way to split command definitions across files;
5798
# we do need to load at least some information about them to know of
5799
# aliases. ideally we would avoid loading the implementation until the
5800
# details were needed.
5801
from bzrlib.cmd_version_info import cmd_version_info
5802
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5803
from bzrlib.bundle.commands import (
5806
from bzrlib.foreign import cmd_dpush
5807
from bzrlib.sign_my_commits import cmd_sign_my_commits
5808
from bzrlib.weave_commands import cmd_versionedfile_list, \
5809
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
