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):
125
if revisions is None:
127
rev_tree = tree.basis_tree()
129
rev_tree = branch.basis_tree()
131
revision = _get_one_revision(command_name, revisions)
132
rev_tree = revision.as_tree(branch)
136
# XXX: Bad function name; should possibly also be a class method of
137
# WorkingTree rather than a function.
138
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
140
"""Convert command-line paths to a WorkingTree and relative paths.
142
This is typically used for command-line processors that take one or
143
more filenames, and infer the workingtree that contains them.
145
The filenames given are not required to exist.
147
:param file_list: Filenames to convert.
149
:param default_branch: Fallback tree path to use if file_list is empty or
152
:param apply_view: if True and a view is set, apply it or check that
153
specified files are within it
155
:return: workingtree, [relative_paths]
157
if file_list is None or len(file_list) == 0:
158
tree = WorkingTree.open_containing(default_branch)[0]
159
if tree.supports_views() and apply_view:
160
view_files = tree.views.lookup_view()
162
file_list = view_files
163
view_str = views.view_display_str(view_files)
164
note("Ignoring files outside view. View is %s" % view_str)
165
return tree, file_list
166
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
167
return tree, safe_relpath_files(tree, file_list, canonicalize,
168
apply_view=apply_view)
171
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
172
"""Convert file_list into a list of relpaths in tree.
174
:param tree: A tree to operate on.
175
:param file_list: A list of user provided paths or None.
176
:param apply_view: if True and a view is set, apply it or check that
177
specified files are within it
178
:return: A list of relative paths.
179
:raises errors.PathNotChild: When a provided path is in a different tree
182
if file_list is None:
184
if tree.supports_views() and apply_view:
185
view_files = tree.views.lookup_view()
189
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
190
# doesn't - fix that up here before we enter the loop.
192
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
195
for filename in file_list:
197
relpath = fixer(osutils.dereference_path(filename))
198
if view_files and not osutils.is_inside_any(view_files, relpath):
199
raise errors.FileOutsideView(filename, view_files)
200
new_list.append(relpath)
201
except errors.PathNotChild:
202
raise errors.FileInWrongBranch(tree.branch, filename)
206
def _get_view_info_for_change_reporter(tree):
207
"""Get the view information from a tree for change reporting."""
210
current_view = tree.views.get_view_info()[0]
211
if current_view is not None:
212
view_info = (current_view, tree.views.lookup_view())
213
except errors.ViewsNotSupported:
218
# TODO: Make sure no commands unconditionally use the working directory as a
219
# branch. If a filename argument is used, the first of them should be used to
220
# specify the branch. (Perhaps this can be factored out into some kind of
221
# Argument class, representing a file in a branch, where the first occurrence
224
class cmd_status(Command):
225
"""Display status summary.
227
This reports on versioned and unknown files, reporting them
228
grouped by state. Possible states are:
231
Versioned in the working copy but not in the previous revision.
234
Versioned in the previous revision but removed or deleted
238
Path of this file changed from the previous revision;
239
the text may also have changed. This includes files whose
240
parent directory was renamed.
243
Text has changed since the previous revision.
246
File kind has been changed (e.g. from file to directory).
249
Not versioned and not matching an ignore pattern.
251
To see ignored files use 'bzr ignored'. For details on the
252
changes to file texts, use 'bzr diff'.
254
Note that --short or -S gives status flags for each item, similar
255
to Subversion's status command. To get output similar to svn -q,
258
If no arguments are specified, the status of the entire working
259
directory is shown. Otherwise, only the status of the specified
260
files or directories is reported. If a directory is given, status
261
is reported for everything inside that directory.
263
Before merges are committed, the pending merge tip revisions are
264
shown. To see all pending merge revisions, use the -v option.
265
To skip the display of pending merge information altogether, use
266
the no-pending option or specify a file/directory.
268
If a revision argument is given, the status is calculated against
269
that revision, or between two revisions if two are provided.
272
# TODO: --no-recurse, --recurse options
274
takes_args = ['file*']
275
takes_options = ['show-ids', 'revision', 'change', 'verbose',
276
Option('short', help='Use short status indicators.',
278
Option('versioned', help='Only show versioned files.',
280
Option('no-pending', help='Don\'t show pending merges.',
283
aliases = ['st', 'stat']
285
encoding_type = 'replace'
286
_see_also = ['diff', 'revert', 'status-flags']
289
def run(self, show_ids=False, file_list=None, revision=None, short=False,
290
versioned=False, no_pending=False, verbose=False):
291
from bzrlib.status import show_tree_status
293
if revision and len(revision) > 2:
294
raise errors.BzrCommandError('bzr status --revision takes exactly'
295
' one or two revision specifiers')
297
tree, relfile_list = tree_files(file_list)
298
# Avoid asking for specific files when that is not needed.
299
if relfile_list == ['']:
301
# Don't disable pending merges for full trees other than '.'.
302
if file_list == ['.']:
304
# A specific path within a tree was given.
305
elif relfile_list is not None:
307
show_tree_status(tree, show_ids=show_ids,
308
specific_files=relfile_list, revision=revision,
309
to_file=self.outf, short=short, versioned=versioned,
310
show_pending=(not no_pending), verbose=verbose)
313
class cmd_cat_revision(Command):
314
"""Write out metadata for a revision.
316
The revision to print can either be specified by a specific
317
revision identifier, or you can use --revision.
321
takes_args = ['revision_id?']
322
takes_options = ['revision']
323
# cat-revision is more for frontends so should be exact
327
def run(self, revision_id=None, revision=None):
328
if revision_id is not None and revision is not None:
329
raise errors.BzrCommandError('You can only supply one of'
330
' revision_id or --revision')
331
if revision_id is None and revision is None:
332
raise errors.BzrCommandError('You must supply either'
333
' --revision or a revision_id')
334
b = WorkingTree.open_containing(u'.')[0].branch
336
# TODO: jam 20060112 should cat-revision always output utf-8?
337
if revision_id is not None:
338
revision_id = osutils.safe_revision_id(revision_id, warn=False)
340
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
341
except errors.NoSuchRevision:
342
msg = "The repository %s contains no revision %s." % (b.repository.base,
344
raise errors.BzrCommandError(msg)
345
elif revision is not None:
348
raise errors.BzrCommandError('You cannot specify a NULL'
350
rev_id = rev.as_revision_id(b)
351
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
354
class cmd_dump_btree(Command):
355
"""Dump the contents of a btree index file to stdout.
357
PATH is a btree index file, it can be any URL. This includes things like
358
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
360
By default, the tuples stored in the index file will be displayed. With
361
--raw, we will uncompress the pages, but otherwise display the raw bytes
365
# TODO: Do we want to dump the internal nodes as well?
366
# TODO: It would be nice to be able to dump the un-parsed information,
367
# rather than only going through iter_all_entries. However, this is
368
# good enough for a start
370
encoding_type = 'exact'
371
takes_args = ['path']
372
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
373
' rather than the parsed tuples.'),
376
def run(self, path, raw=False):
377
dirname, basename = osutils.split(path)
378
t = transport.get_transport(dirname)
380
self._dump_raw_bytes(t, basename)
382
self._dump_entries(t, basename)
384
def _get_index_and_bytes(self, trans, basename):
385
"""Create a BTreeGraphIndex and raw bytes."""
386
bt = btree_index.BTreeGraphIndex(trans, basename, None)
387
bytes = trans.get_bytes(basename)
388
bt._file = cStringIO.StringIO(bytes)
389
bt._size = len(bytes)
392
def _dump_raw_bytes(self, trans, basename):
395
# We need to parse at least the root node.
396
# This is because the first page of every row starts with an
397
# uncompressed header.
398
bt, bytes = self._get_index_and_bytes(trans, basename)
399
for page_idx, page_start in enumerate(xrange(0, len(bytes),
400
btree_index._PAGE_SIZE)):
401
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
402
page_bytes = bytes[page_start:page_end]
404
self.outf.write('Root node:\n')
405
header_end, data = bt._parse_header_from_bytes(page_bytes)
406
self.outf.write(page_bytes[:header_end])
408
self.outf.write('\nPage %d\n' % (page_idx,))
409
decomp_bytes = zlib.decompress(page_bytes)
410
self.outf.write(decomp_bytes)
411
self.outf.write('\n')
413
def _dump_entries(self, trans, basename):
415
st = trans.stat(basename)
416
except errors.TransportNotPossible:
417
# We can't stat, so we'll fake it because we have to do the 'get()'
419
bt, _ = self._get_index_and_bytes(trans, basename)
421
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
422
for node in bt.iter_all_entries():
423
# Node is made up of:
424
# (index, key, value, [references])
425
self.outf.write('%s\n' % (node[1:],))
428
class cmd_remove_tree(Command):
429
"""Remove the working tree from a given branch/checkout.
431
Since a lightweight checkout is little more than a working tree
432
this will refuse to run against one.
434
To re-create the working tree, use "bzr checkout".
436
_see_also = ['checkout', 'working-trees']
437
takes_args = ['location?']
440
help='Remove the working tree even if it has '
441
'uncommitted changes.'),
444
def run(self, location='.', force=False):
445
d = bzrdir.BzrDir.open(location)
448
working = d.open_workingtree()
449
except errors.NoWorkingTree:
450
raise errors.BzrCommandError("No working tree to remove")
451
except errors.NotLocalUrl:
452
raise errors.BzrCommandError("You cannot remove the working tree"
455
# XXX: What about pending merges ? -- vila 20090629
456
if working.has_changes(working.basis_tree()):
457
raise errors.UncommittedChanges(working)
459
working_path = working.bzrdir.root_transport.base
460
branch_path = working.branch.bzrdir.root_transport.base
461
if working_path != branch_path:
462
raise errors.BzrCommandError("You cannot remove the working tree"
463
" from a lightweight checkout")
465
d.destroy_workingtree()
468
class cmd_revno(Command):
469
"""Show current revision number.
471
This is equal to the number of revisions on this branch.
475
takes_args = ['location?']
477
Option('tree', help='Show revno of working tree'),
481
def run(self, tree=False, location=u'.'):
484
wt = WorkingTree.open_containing(location)[0]
486
except (errors.NoWorkingTree, errors.NotLocalUrl):
487
raise errors.NoWorkingTree(location)
489
revid = wt.last_revision()
491
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
492
except errors.NoSuchRevision:
494
revno = ".".join(str(n) for n in revno_t)
498
b = Branch.open_containing(location)[0]
505
self.outf.write(str(revno) + '\n')
508
class cmd_revision_info(Command):
509
"""Show revision number and revision id for a given revision identifier.
512
takes_args = ['revision_info*']
516
help='Branch to examine, '
517
'rather than the one containing the working directory.',
521
Option('tree', help='Show revno of working tree'),
525
def run(self, revision=None, directory=u'.', tree=False,
526
revision_info_list=[]):
529
wt = WorkingTree.open_containing(directory)[0]
532
except (errors.NoWorkingTree, errors.NotLocalUrl):
534
b = Branch.open_containing(directory)[0]
538
if revision is not None:
539
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
540
if revision_info_list is not None:
541
for rev_str in revision_info_list:
542
rev_spec = RevisionSpec.from_string(rev_str)
543
revision_ids.append(rev_spec.as_revision_id(b))
544
# No arguments supplied, default to the last revision
545
if len(revision_ids) == 0:
548
raise errors.NoWorkingTree(directory)
549
revision_ids.append(wt.last_revision())
551
revision_ids.append(b.last_revision())
555
for revision_id in revision_ids:
557
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
558
revno = '.'.join(str(i) for i in dotted_revno)
559
except errors.NoSuchRevision:
561
maxlen = max(maxlen, len(revno))
562
revinfos.append([revno, revision_id])
570
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
573
class cmd_add(Command):
574
"""Add specified files or directories.
576
In non-recursive mode, all the named items are added, regardless
577
of whether they were previously ignored. A warning is given if
578
any of the named files are already versioned.
580
In recursive mode (the default), files are treated the same way
581
but the behaviour for directories is different. Directories that
582
are already versioned do not give a warning. All directories,
583
whether already versioned or not, are searched for files or
584
subdirectories that are neither versioned or ignored, and these
585
are added. This search proceeds recursively into versioned
586
directories. If no names are given '.' is assumed.
588
Therefore simply saying 'bzr add' will version all files that
589
are currently unknown.
591
Adding a file whose parent directory is not versioned will
592
implicitly add the parent, and so on up to the root. This means
593
you should never need to explicitly add a directory, they'll just
594
get added when you add a file in the directory.
596
--dry-run will show which files would be added, but not actually
599
--file-ids-from will try to use the file ids from the supplied path.
600
It looks up ids trying to find a matching parent directory with the
601
same filename, and then by pure path. This option is rarely needed
602
but can be useful when adding the same logical file into two
603
branches that will be merged later (without showing the two different
604
adds as a conflict). It is also useful when merging another project
605
into a subdirectory of this one.
607
takes_args = ['file*']
610
help="Don't recursively add the contents of directories."),
612
help="Show what would be done, but don't actually do anything."),
614
Option('file-ids-from',
616
help='Lookup file ids from this tree.'),
618
encoding_type = 'replace'
619
_see_also = ['remove']
621
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
626
if file_ids_from is not None:
628
base_tree, base_path = WorkingTree.open_containing(
630
except errors.NoWorkingTree:
631
base_branch, base_path = Branch.open_containing(
633
base_tree = base_branch.basis_tree()
635
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
636
to_file=self.outf, should_print=(not is_quiet()))
638
action = bzrlib.add.AddAction(to_file=self.outf,
639
should_print=(not is_quiet()))
642
base_tree.lock_read()
644
file_list = self._maybe_expand_globs(file_list)
645
tree, file_list = tree_files_for_add(file_list)
646
added, ignored = tree.smart_add(file_list, not
647
no_recurse, action=action, save=not dry_run)
649
if base_tree is not None:
653
for glob in sorted(ignored.keys()):
654
for path in ignored[glob]:
655
self.outf.write("ignored %s matching \"%s\"\n"
659
for glob, paths in ignored.items():
660
match_len += len(paths)
661
self.outf.write("ignored %d file(s).\n" % match_len)
662
self.outf.write("If you wish to add ignored files, "
663
"please add them explicitly by name. "
664
"(\"bzr ignored\" gives a list)\n")
667
class cmd_mkdir(Command):
668
"""Create a new versioned directory.
670
This is equivalent to creating the directory and then adding it.
673
takes_args = ['dir+']
674
encoding_type = 'replace'
676
def run(self, dir_list):
679
wt, dd = WorkingTree.open_containing(d)
681
self.outf.write('added %s\n' % d)
684
class cmd_relpath(Command):
685
"""Show path of a file relative to root"""
687
takes_args = ['filename']
691
def run(self, filename):
692
# TODO: jam 20050106 Can relpath return a munged path if
693
# sys.stdout encoding cannot represent it?
694
tree, relpath = WorkingTree.open_containing(filename)
695
self.outf.write(relpath)
696
self.outf.write('\n')
699
class cmd_inventory(Command):
700
"""Show inventory of the current working copy or a revision.
702
It is possible to limit the output to a particular entry
703
type using the --kind option. For example: --kind file.
705
It is also possible to restrict the list of files to a specific
706
set. For example: bzr inventory --show-ids this/file
715
help='List entries of a particular kind: file, directory, symlink.',
718
takes_args = ['file*']
721
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
722
if kind and kind not in ['file', 'directory', 'symlink']:
723
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
725
revision = _get_one_revision('inventory', revision)
726
work_tree, file_list = tree_files(file_list)
727
work_tree.lock_read()
729
if revision is not None:
730
tree = revision.as_tree(work_tree.branch)
732
extra_trees = [work_tree]
738
if file_list is not None:
739
file_ids = tree.paths2ids(file_list, trees=extra_trees,
740
require_versioned=True)
741
# find_ids_across_trees may include some paths that don't
743
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
744
for file_id in file_ids if file_id in tree)
746
entries = tree.inventory.entries()
749
if tree is not work_tree:
752
for path, entry in entries:
753
if kind and kind != entry.kind:
756
self.outf.write('%-50s %s\n' % (path, entry.file_id))
758
self.outf.write(path)
759
self.outf.write('\n')
762
class cmd_mv(Command):
763
"""Move or rename a file.
766
bzr mv OLDNAME NEWNAME
768
bzr mv SOURCE... DESTINATION
770
If the last argument is a versioned directory, all the other names
771
are moved into it. Otherwise, there must be exactly two arguments
772
and the file is changed to a new name.
774
If OLDNAME does not exist on the filesystem but is versioned and
775
NEWNAME does exist on the filesystem but is not versioned, mv
776
assumes that the file has been manually moved and only updates
777
its internal inventory to reflect that change.
778
The same is valid when moving many SOURCE files to a DESTINATION.
780
Files cannot be moved between branches.
783
takes_args = ['names*']
784
takes_options = [Option("after", help="Move only the bzr identifier"
785
" of the file, because the file has already been moved."),
786
Option('auto', help='Automatically guess renames.'),
787
Option('dry-run', help='Avoid making changes when guessing renames.'),
789
aliases = ['move', 'rename']
790
encoding_type = 'replace'
792
def run(self, names_list, after=False, auto=False, dry_run=False):
794
return self.run_auto(names_list, after, dry_run)
796
raise errors.BzrCommandError('--dry-run requires --auto.')
797
if names_list is None:
799
if len(names_list) < 2:
800
raise errors.BzrCommandError("missing file argument")
801
tree, rel_names = tree_files(names_list, canonicalize=False)
804
self._run(tree, names_list, rel_names, after)
808
def run_auto(self, names_list, after, dry_run):
809
if names_list is not None and len(names_list) > 1:
810
raise errors.BzrCommandError('Only one path may be specified to'
813
raise errors.BzrCommandError('--after cannot be specified with'
815
work_tree, file_list = tree_files(names_list, default_branch='.')
816
work_tree.lock_write()
818
rename_map.RenameMap.guess_renames(work_tree, dry_run)
822
def _run(self, tree, names_list, rel_names, after):
823
into_existing = osutils.isdir(names_list[-1])
824
if into_existing and len(names_list) == 2:
826
# a. case-insensitive filesystem and change case of dir
827
# b. move directory after the fact (if the source used to be
828
# a directory, but now doesn't exist in the working tree
829
# and the target is an existing directory, just rename it)
830
if (not tree.case_sensitive
831
and rel_names[0].lower() == rel_names[1].lower()):
832
into_existing = False
835
# 'fix' the case of a potential 'from'
836
from_id = tree.path2id(
837
tree.get_canonical_inventory_path(rel_names[0]))
838
if (not osutils.lexists(names_list[0]) and
839
from_id and inv.get_file_kind(from_id) == "directory"):
840
into_existing = False
843
# move into existing directory
844
# All entries reference existing inventory items, so fix them up
845
# for cicp file-systems.
846
rel_names = tree.get_canonical_inventory_paths(rel_names)
847
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
848
self.outf.write("%s => %s\n" % pair)
850
if len(names_list) != 2:
851
raise errors.BzrCommandError('to mv multiple files the'
852
' destination must be a versioned'
855
# for cicp file-systems: the src references an existing inventory
857
src = tree.get_canonical_inventory_path(rel_names[0])
858
# Find the canonical version of the destination: In all cases, the
859
# parent of the target must be in the inventory, so we fetch the
860
# canonical version from there (we do not always *use* the
861
# canonicalized tail portion - we may be attempting to rename the
863
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
864
dest_parent = osutils.dirname(canon_dest)
865
spec_tail = osutils.basename(rel_names[1])
866
# For a CICP file-system, we need to avoid creating 2 inventory
867
# entries that differ only by case. So regardless of the case
868
# we *want* to use (ie, specified by the user or the file-system),
869
# we must always choose to use the case of any existing inventory
870
# items. The only exception to this is when we are attempting a
871
# case-only rename (ie, canonical versions of src and dest are
873
dest_id = tree.path2id(canon_dest)
874
if dest_id is None or tree.path2id(src) == dest_id:
875
# No existing item we care about, so work out what case we
876
# are actually going to use.
878
# If 'after' is specified, the tail must refer to a file on disk.
880
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
882
# pathjoin with an empty tail adds a slash, which breaks
884
dest_parent_fq = tree.basedir
886
dest_tail = osutils.canonical_relpath(
888
osutils.pathjoin(dest_parent_fq, spec_tail))
890
# not 'after', so case as specified is used
891
dest_tail = spec_tail
893
# Use the existing item so 'mv' fails with AlreadyVersioned.
894
dest_tail = os.path.basename(canon_dest)
895
dest = osutils.pathjoin(dest_parent, dest_tail)
896
mutter("attempting to move %s => %s", src, dest)
897
tree.rename_one(src, dest, after=after)
898
self.outf.write("%s => %s\n" % (src, dest))
901
class cmd_pull(Command):
902
"""Turn this branch into a mirror of another branch.
904
This command only works on branches that have not diverged. Branches are
905
considered diverged if the destination branch's most recent commit is one
906
that has not been merged (directly or indirectly) into the parent.
908
If branches have diverged, you can use 'bzr merge' to integrate the changes
909
from one into the other. Once one branch has merged, the other should
910
be able to pull it again.
912
If you want to forget your local changes and just update your branch to
913
match the remote one, use pull --overwrite.
915
If there is no default location set, the first pull will set it. After
916
that, you can omit the location to use the default. To change the
917
default, use --remember. The value will only be saved if the remote
918
location can be accessed.
920
Note: The location can be specified either in the form of a branch,
921
or in the form of a path to a file containing a merge directive generated
925
_see_also = ['push', 'update', 'status-flags', 'send']
926
takes_options = ['remember', 'overwrite', 'revision',
927
custom_help('verbose',
928
help='Show logs of pulled revisions.'),
930
help='Branch to pull into, '
931
'rather than the one containing the working directory.',
936
help="Perform a local pull in a bound "
937
"branch. Local pulls are not applied to "
941
takes_args = ['location?']
942
encoding_type = 'replace'
944
def run(self, location=None, remember=False, overwrite=False,
945
revision=None, verbose=False,
946
directory=None, local=False):
947
# FIXME: too much stuff is in the command class
950
if directory is None:
953
tree_to = WorkingTree.open_containing(directory)[0]
954
branch_to = tree_to.branch
955
except errors.NoWorkingTree:
957
branch_to = Branch.open_containing(directory)[0]
959
if local and not branch_to.get_bound_location():
960
raise errors.LocalRequiresBoundBranch()
962
possible_transports = []
963
if location is not None:
965
mergeable = bundle.read_mergeable_from_url(location,
966
possible_transports=possible_transports)
967
except errors.NotABundle:
970
stored_loc = branch_to.get_parent()
972
if stored_loc is None:
973
raise errors.BzrCommandError("No pull location known or"
976
display_url = urlutils.unescape_for_display(stored_loc,
979
self.outf.write("Using saved parent location: %s\n" % display_url)
980
location = stored_loc
982
revision = _get_one_revision('pull', revision)
983
if mergeable is not None:
984
if revision is not None:
985
raise errors.BzrCommandError(
986
'Cannot use -r with merge directives or bundles')
987
mergeable.install_revisions(branch_to.repository)
988
base_revision_id, revision_id, verified = \
989
mergeable.get_merge_request(branch_to.repository)
990
branch_from = branch_to
992
branch_from = Branch.open(location,
993
possible_transports=possible_transports)
995
if branch_to.get_parent() is None or remember:
996
branch_to.set_parent(branch_from.base)
998
if branch_from is not branch_to:
999
branch_from.lock_read()
1001
if revision is not None:
1002
revision_id = revision.as_revision_id(branch_from)
1004
branch_to.lock_write()
1006
if tree_to is not None:
1007
view_info = _get_view_info_for_change_reporter(tree_to)
1008
change_reporter = delta._ChangeReporter(
1009
unversioned_filter=tree_to.is_ignored,
1010
view_info=view_info)
1011
result = tree_to.pull(
1012
branch_from, overwrite, revision_id, change_reporter,
1013
possible_transports=possible_transports, local=local)
1015
result = branch_to.pull(
1016
branch_from, overwrite, revision_id, local=local)
1018
result.report(self.outf)
1019
if verbose and result.old_revid != result.new_revid:
1020
log.show_branch_change(
1021
branch_to, self.outf, result.old_revno,
1026
if branch_from is not branch_to:
1027
branch_from.unlock()
1030
class cmd_push(Command):
1031
"""Update a mirror of this branch.
1033
The target branch will not have its working tree populated because this
1034
is both expensive, and is not supported on remote file systems.
1036
Some smart servers or protocols *may* put the working tree in place in
1039
This command only works on branches that have not diverged. Branches are
1040
considered diverged if the destination branch's most recent commit is one
1041
that has not been merged (directly or indirectly) by the source branch.
1043
If branches have diverged, you can use 'bzr push --overwrite' to replace
1044
the other branch completely, discarding its unmerged changes.
1046
If you want to ensure you have the different changes in the other branch,
1047
do a merge (see bzr help merge) from the other branch, and commit that.
1048
After that you will be able to do a push without '--overwrite'.
1050
If there is no default push location set, the first push will set it.
1051
After that, you can omit the location to use the default. To change the
1052
default, use --remember. The value will only be saved if the remote
1053
location can be accessed.
1056
_see_also = ['pull', 'update', 'working-trees']
1057
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1058
Option('create-prefix',
1059
help='Create the path leading up to the branch '
1060
'if it does not already exist.'),
1062
help='Branch to push from, '
1063
'rather than the one containing the working directory.',
1067
Option('use-existing-dir',
1068
help='By default push will fail if the target'
1069
' directory exists, but does not already'
1070
' have a control directory. This flag will'
1071
' allow push to proceed.'),
1073
help='Create a stacked branch that references the public location '
1074
'of the parent branch.'),
1075
Option('stacked-on',
1076
help='Create a stacked branch that refers to another branch '
1077
'for the commit history. Only the work not present in the '
1078
'referenced branch is included in the branch created.',
1081
help='Refuse to push if there are uncommitted changes in'
1082
' the working tree, --no-strict disables the check.'),
1084
takes_args = ['location?']
1085
encoding_type = 'replace'
1087
def run(self, location=None, remember=False, overwrite=False,
1088
create_prefix=False, verbose=False, revision=None,
1089
use_existing_dir=False, directory=None, stacked_on=None,
1090
stacked=False, strict=None):
1091
from bzrlib.push import _show_push_branch
1093
if directory is None:
1095
# Get the source branch
1097
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1099
strict = br_from.get_config().get_user_option('push_strict')
1100
if strict is not None:
1101
# FIXME: This should be better supported by config
1103
bools = dict(yes=True, no=False, on=True, off=False,
1104
true=True, false=False)
1106
strict = bools[strict.lower()]
1109
# Get the tip's revision_id
1110
revision = _get_one_revision('push', revision)
1111
if revision is not None:
1112
revision_id = revision.in_history(br_from).rev_id
1115
if (tree is not None and revision_id is None
1116
and (strict is None or strict)): # Default to True:
1117
if (tree.has_changes(tree.basis_tree())
1118
or len(tree.get_parent_ids()) > 1):
1119
raise errors.UncommittedChanges(
1120
tree, more='Use --no-strict to force the push.')
1121
if tree.last_revision() != tree.branch.last_revision():
1122
# The tree has lost sync with its branch, there is little
1123
# chance that the user is aware of it but he can still force
1124
# the push with --no-strict
1125
raise errors.OutOfDateTree(
1126
tree, more='Use --no-strict to force the push.')
1128
# Get the stacked_on branch, if any
1129
if stacked_on is not None:
1130
stacked_on = urlutils.normalize_url(stacked_on)
1132
parent_url = br_from.get_parent()
1134
parent = Branch.open(parent_url)
1135
stacked_on = parent.get_public_branch()
1137
# I considered excluding non-http url's here, thus forcing
1138
# 'public' branches only, but that only works for some
1139
# users, so it's best to just depend on the user spotting an
1140
# error by the feedback given to them. RBC 20080227.
1141
stacked_on = parent_url
1143
raise errors.BzrCommandError(
1144
"Could not determine branch to refer to.")
1146
# Get the destination location
1147
if location is None:
1148
stored_loc = br_from.get_push_location()
1149
if stored_loc is None:
1150
raise errors.BzrCommandError(
1151
"No push location known or specified.")
1153
display_url = urlutils.unescape_for_display(stored_loc,
1155
self.outf.write("Using saved push location: %s\n" % display_url)
1156
location = stored_loc
1158
_show_push_branch(br_from, revision_id, location, self.outf,
1159
verbose=verbose, overwrite=overwrite, remember=remember,
1160
stacked_on=stacked_on, create_prefix=create_prefix,
1161
use_existing_dir=use_existing_dir)
1164
class cmd_branch(Command):
1165
"""Create a new branch that is a copy of an existing branch.
1167
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1168
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1169
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1170
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1171
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1174
To retrieve the branch as of a particular revision, supply the --revision
1175
parameter, as in "branch foo/bar -r 5".
1178
_see_also = ['checkout']
1179
takes_args = ['from_location', 'to_location?']
1180
takes_options = ['revision', Option('hardlink',
1181
help='Hard-link working tree files where possible.'),
1183
help="Create a branch without a working-tree."),
1185
help='Create a stacked branch referring to the source branch. '
1186
'The new branch will depend on the availability of the source '
1187
'branch for all operations.'),
1188
Option('standalone',
1189
help='Do not use a shared repository, even if available.'),
1190
Option('use-existing-dir',
1191
help='By default branch will fail if the target'
1192
' directory exists, but does not already'
1193
' have a control directory. This flag will'
1194
' allow branch to proceed.'),
1196
aliases = ['get', 'clone']
1198
def run(self, from_location, to_location=None, revision=None,
1199
hardlink=False, stacked=False, standalone=False, no_tree=False,
1200
use_existing_dir=False):
1201
from bzrlib.tag import _merge_tags_if_possible
1203
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1205
if (accelerator_tree is not None and
1206
accelerator_tree.supports_content_filtering()):
1207
accelerator_tree = None
1208
revision = _get_one_revision('branch', revision)
1211
if revision is not None:
1212
revision_id = revision.as_revision_id(br_from)
1214
# FIXME - wt.last_revision, fallback to branch, fall back to
1215
# None or perhaps NULL_REVISION to mean copy nothing
1217
revision_id = br_from.last_revision()
1218
if to_location is None:
1219
to_location = urlutils.derive_to_location(from_location)
1220
to_transport = transport.get_transport(to_location)
1222
to_transport.mkdir('.')
1223
except errors.FileExists:
1224
if not use_existing_dir:
1225
raise errors.BzrCommandError('Target directory "%s" '
1226
'already exists.' % to_location)
1229
bzrdir.BzrDir.open_from_transport(to_transport)
1230
except errors.NotBranchError:
1233
raise errors.AlreadyBranchError(to_location)
1234
except errors.NoSuchFile:
1235
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1238
# preserve whatever source format we have.
1239
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1240
possible_transports=[to_transport],
1241
accelerator_tree=accelerator_tree,
1242
hardlink=hardlink, stacked=stacked,
1243
force_new_repo=standalone,
1244
create_tree_if_local=not no_tree,
1245
source_branch=br_from)
1246
branch = dir.open_branch()
1247
except errors.NoSuchRevision:
1248
to_transport.delete_tree('.')
1249
msg = "The branch %s has no revision %s." % (from_location,
1251
raise errors.BzrCommandError(msg)
1252
_merge_tags_if_possible(br_from, branch)
1253
# If the source branch is stacked, the new branch may
1254
# be stacked whether we asked for that explicitly or not.
1255
# We therefore need a try/except here and not just 'if stacked:'
1257
note('Created new stacked branch referring to %s.' %
1258
branch.get_stacked_on_url())
1259
except (errors.NotStacked, errors.UnstackableBranchFormat,
1260
errors.UnstackableRepositoryFormat), e:
1261
note('Branched %d revision(s).' % branch.revno())
1266
class cmd_checkout(Command):
1267
"""Create a new checkout of an existing branch.
1269
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1270
the branch found in '.'. This is useful if you have removed the working tree
1271
or if it was never created - i.e. if you pushed the branch to its current
1272
location using SFTP.
1274
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1275
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1276
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1277
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1278
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1281
To retrieve the branch as of a particular revision, supply the --revision
1282
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1283
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1287
_see_also = ['checkouts', 'branch']
1288
takes_args = ['branch_location?', 'to_location?']
1289
takes_options = ['revision',
1290
Option('lightweight',
1291
help="Perform a lightweight checkout. Lightweight "
1292
"checkouts depend on access to the branch for "
1293
"every operation. Normal checkouts can perform "
1294
"common operations like diff and status without "
1295
"such access, and also support local commits."
1297
Option('files-from', type=str,
1298
help="Get file contents from this tree."),
1300
help='Hard-link working tree files where possible.'
1305
def run(self, branch_location=None, to_location=None, revision=None,
1306
lightweight=False, files_from=None, hardlink=False):
1307
if branch_location is None:
1308
branch_location = osutils.getcwd()
1309
to_location = branch_location
1310
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1312
revision = _get_one_revision('checkout', revision)
1313
if files_from is not None:
1314
accelerator_tree = WorkingTree.open(files_from)
1315
if revision is not None:
1316
revision_id = revision.as_revision_id(source)
1319
if to_location is None:
1320
to_location = urlutils.derive_to_location(branch_location)
1321
# if the source and to_location are the same,
1322
# and there is no working tree,
1323
# then reconstitute a branch
1324
if (osutils.abspath(to_location) ==
1325
osutils.abspath(branch_location)):
1327
source.bzrdir.open_workingtree()
1328
except errors.NoWorkingTree:
1329
source.bzrdir.create_workingtree(revision_id)
1331
source.create_checkout(to_location, revision_id, lightweight,
1332
accelerator_tree, hardlink)
1335
class cmd_renames(Command):
1336
"""Show list of renamed files.
1338
# TODO: Option to show renames between two historical versions.
1340
# TODO: Only show renames under dir, rather than in the whole branch.
1341
_see_also = ['status']
1342
takes_args = ['dir?']
1345
def run(self, dir=u'.'):
1346
tree = WorkingTree.open_containing(dir)[0]
1349
new_inv = tree.inventory
1350
old_tree = tree.basis_tree()
1351
old_tree.lock_read()
1353
old_inv = old_tree.inventory
1355
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1356
for f, paths, c, v, p, n, k, e in iterator:
1357
if paths[0] == paths[1]:
1361
renames.append(paths)
1363
for old_name, new_name in renames:
1364
self.outf.write("%s => %s\n" % (old_name, new_name))
1371
class cmd_update(Command):
1372
"""Update a tree to have the latest code committed to its branch.
1374
This will perform a merge into the working tree, and may generate
1375
conflicts. If you have any local changes, you will still
1376
need to commit them after the update for the update to be complete.
1378
If you want to discard your local changes, you can just do a
1379
'bzr revert' instead of 'bzr commit' after the update.
1382
_see_also = ['pull', 'working-trees', 'status-flags']
1383
takes_args = ['dir?']
1386
def run(self, dir='.'):
1387
tree = WorkingTree.open_containing(dir)[0]
1388
possible_transports = []
1389
master = tree.branch.get_master_branch(
1390
possible_transports=possible_transports)
1391
if master is not None:
1394
tree.lock_tree_write()
1396
existing_pending_merges = tree.get_parent_ids()[1:]
1397
last_rev = _mod_revision.ensure_null(tree.last_revision())
1398
if last_rev == _mod_revision.ensure_null(
1399
tree.branch.last_revision()):
1400
# may be up to date, check master too.
1401
if master is None or last_rev == _mod_revision.ensure_null(
1402
master.last_revision()):
1403
revno = tree.branch.revision_id_to_revno(last_rev)
1404
note("Tree is up to date at revision %d." % (revno,))
1406
view_info = _get_view_info_for_change_reporter(tree)
1407
conflicts = tree.update(
1408
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1409
view_info=view_info), possible_transports=possible_transports)
1410
revno = tree.branch.revision_id_to_revno(
1411
_mod_revision.ensure_null(tree.last_revision()))
1412
note('Updated to revision %d.' % (revno,))
1413
if tree.get_parent_ids()[1:] != existing_pending_merges:
1414
note('Your local commits will now show as pending merges with '
1415
"'bzr status', and can be committed with 'bzr commit'.")
1424
class cmd_info(Command):
1425
"""Show information about a working tree, branch or repository.
1427
This command will show all known locations and formats associated to the
1428
tree, branch or repository.
1430
In verbose mode, statistical information is included with each report.
1431
To see extended statistic information, use a verbosity level of 2 or
1432
higher by specifying the verbose option multiple times, e.g. -vv.
1434
Branches and working trees will also report any missing revisions.
1438
Display information on the format and related locations:
1442
Display the above together with extended format information and
1443
basic statistics (like the number of files in the working tree and
1444
number of revisions in the branch and repository):
1448
Display the above together with number of committers to the branch:
1452
_see_also = ['revno', 'working-trees', 'repositories']
1453
takes_args = ['location?']
1454
takes_options = ['verbose']
1455
encoding_type = 'replace'
1458
def run(self, location=None, verbose=False):
1460
noise_level = get_verbosity_level()
1463
from bzrlib.info import show_bzrdir_info
1464
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1465
verbose=noise_level, outfile=self.outf)
1468
class cmd_remove(Command):
1469
"""Remove files or directories.
1471
This makes bzr stop tracking changes to the specified files. bzr will delete
1472
them if they can easily be recovered using revert. If no options or
1473
parameters are given bzr will scan for files that are being tracked by bzr
1474
but missing in your tree and stop tracking them for you.
1476
takes_args = ['file*']
1477
takes_options = ['verbose',
1478
Option('new', help='Only remove files that have never been committed.'),
1479
RegistryOption.from_kwargs('file-deletion-strategy',
1480
'The file deletion mode to be used.',
1481
title='Deletion Strategy', value_switches=True, enum_switch=False,
1482
safe='Only delete files if they can be'
1483
' safely recovered (default).',
1484
keep="Don't delete any files.",
1485
force='Delete all the specified files, even if they can not be '
1486
'recovered and even if they are non-empty directories.')]
1487
aliases = ['rm', 'del']
1488
encoding_type = 'replace'
1490
def run(self, file_list, verbose=False, new=False,
1491
file_deletion_strategy='safe'):
1492
tree, file_list = tree_files(file_list)
1494
if file_list is not None:
1495
file_list = [f for f in file_list]
1499
# Heuristics should probably all move into tree.remove_smart or
1502
added = tree.changes_from(tree.basis_tree(),
1503
specific_files=file_list).added
1504
file_list = sorted([f[0] for f in added], reverse=True)
1505
if len(file_list) == 0:
1506
raise errors.BzrCommandError('No matching files.')
1507
elif file_list is None:
1508
# missing files show up in iter_changes(basis) as
1509
# versioned-with-no-kind.
1511
for change in tree.iter_changes(tree.basis_tree()):
1512
# Find paths in the working tree that have no kind:
1513
if change[1][1] is not None and change[6][1] is None:
1514
missing.append(change[1][1])
1515
file_list = sorted(missing, reverse=True)
1516
file_deletion_strategy = 'keep'
1517
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1518
keep_files=file_deletion_strategy=='keep',
1519
force=file_deletion_strategy=='force')
1524
class cmd_file_id(Command):
1525
"""Print file_id of a particular file or directory.
1527
The file_id is assigned when the file is first added and remains the
1528
same through all revisions where the file exists, even when it is
1533
_see_also = ['inventory', 'ls']
1534
takes_args = ['filename']
1537
def run(self, filename):
1538
tree, relpath = WorkingTree.open_containing(filename)
1539
i = tree.path2id(relpath)
1541
raise errors.NotVersionedError(filename)
1543
self.outf.write(i + '\n')
1546
class cmd_file_path(Command):
1547
"""Print path of file_ids to a file or directory.
1549
This prints one line for each directory down to the target,
1550
starting at the branch root.
1554
takes_args = ['filename']
1557
def run(self, filename):
1558
tree, relpath = WorkingTree.open_containing(filename)
1559
fid = tree.path2id(relpath)
1561
raise errors.NotVersionedError(filename)
1562
segments = osutils.splitpath(relpath)
1563
for pos in range(1, len(segments) + 1):
1564
path = osutils.joinpath(segments[:pos])
1565
self.outf.write("%s\n" % tree.path2id(path))
1568
class cmd_reconcile(Command):
1569
"""Reconcile bzr metadata in a branch.
1571
This can correct data mismatches that may have been caused by
1572
previous ghost operations or bzr upgrades. You should only
1573
need to run this command if 'bzr check' or a bzr developer
1574
advises you to run it.
1576
If a second branch is provided, cross-branch reconciliation is
1577
also attempted, which will check that data like the tree root
1578
id which was not present in very early bzr versions is represented
1579
correctly in both branches.
1581
At the same time it is run it may recompress data resulting in
1582
a potential saving in disk space or performance gain.
1584
The branch *MUST* be on a listable system such as local disk or sftp.
1587
_see_also = ['check']
1588
takes_args = ['branch?']
1590
def run(self, branch="."):
1591
from bzrlib.reconcile import reconcile
1592
dir = bzrdir.BzrDir.open(branch)
1596
class cmd_revision_history(Command):
1597
"""Display the list of revision ids on a branch."""
1600
takes_args = ['location?']
1605
def run(self, location="."):
1606
branch = Branch.open_containing(location)[0]
1607
for revid in branch.revision_history():
1608
self.outf.write(revid)
1609
self.outf.write('\n')
1612
class cmd_ancestry(Command):
1613
"""List all revisions merged into this branch."""
1615
_see_also = ['log', 'revision-history']
1616
takes_args = ['location?']
1621
def run(self, location="."):
1623
wt = WorkingTree.open_containing(location)[0]
1624
except errors.NoWorkingTree:
1625
b = Branch.open(location)
1626
last_revision = b.last_revision()
1629
last_revision = wt.last_revision()
1631
revision_ids = b.repository.get_ancestry(last_revision)
1633
for revision_id in revision_ids:
1634
self.outf.write(revision_id + '\n')
1637
class cmd_init(Command):
1638
"""Make a directory into a versioned branch.
1640
Use this to create an empty branch, or before importing an
1643
If there is a repository in a parent directory of the location, then
1644
the history of the branch will be stored in the repository. Otherwise
1645
init creates a standalone branch which carries its own history
1646
in the .bzr directory.
1648
If there is already a branch at the location but it has no working tree,
1649
the tree can be populated with 'bzr checkout'.
1651
Recipe for importing a tree of files::
1657
bzr commit -m "imported project"
1660
_see_also = ['init-repository', 'branch', 'checkout']
1661
takes_args = ['location?']
1663
Option('create-prefix',
1664
help='Create the path leading up to the branch '
1665
'if it does not already exist.'),
1666
RegistryOption('format',
1667
help='Specify a format for this branch. '
1668
'See "help formats".',
1669
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1670
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1671
value_switches=True,
1672
title="Branch Format",
1674
Option('append-revisions-only',
1675
help='Never change revnos or the existing log.'
1676
' Append revisions to it only.')
1678
def run(self, location=None, format=None, append_revisions_only=False,
1679
create_prefix=False):
1681
format = bzrdir.format_registry.make_bzrdir('default')
1682
if location is None:
1685
to_transport = transport.get_transport(location)
1687
# The path has to exist to initialize a
1688
# branch inside of it.
1689
# Just using os.mkdir, since I don't
1690
# believe that we want to create a bunch of
1691
# locations if the user supplies an extended path
1693
to_transport.ensure_base()
1694
except errors.NoSuchFile:
1695
if not create_prefix:
1696
raise errors.BzrCommandError("Parent directory of %s"
1698
"\nYou may supply --create-prefix to create all"
1699
" leading parent directories."
1701
to_transport.create_prefix()
1704
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1705
except errors.NotBranchError:
1706
# really a NotBzrDir error...
1707
create_branch = bzrdir.BzrDir.create_branch_convenience
1708
branch = create_branch(to_transport.base, format=format,
1709
possible_transports=[to_transport])
1710
a_bzrdir = branch.bzrdir
1712
from bzrlib.transport.local import LocalTransport
1713
if a_bzrdir.has_branch():
1714
if (isinstance(to_transport, LocalTransport)
1715
and not a_bzrdir.has_workingtree()):
1716
raise errors.BranchExistsWithoutWorkingTree(location)
1717
raise errors.AlreadyBranchError(location)
1718
branch = a_bzrdir.create_branch()
1719
a_bzrdir.create_workingtree()
1720
if append_revisions_only:
1722
branch.set_append_revisions_only(True)
1723
except errors.UpgradeRequired:
1724
raise errors.BzrCommandError('This branch format cannot be set'
1725
' to append-revisions-only. Try --default.')
1727
from bzrlib.info import describe_layout, describe_format
1729
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1730
except (errors.NoWorkingTree, errors.NotLocalUrl):
1732
repository = branch.repository
1733
layout = describe_layout(repository, branch, tree).lower()
1734
format = describe_format(a_bzrdir, repository, branch, tree)
1735
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1736
if repository.is_shared():
1737
#XXX: maybe this can be refactored into transport.path_or_url()
1738
url = repository.bzrdir.root_transport.external_url()
1740
url = urlutils.local_path_from_url(url)
1741
except errors.InvalidURL:
1743
self.outf.write("Using shared repository: %s\n" % url)
1746
class cmd_init_repository(Command):
1747
"""Create a shared repository to hold branches.
1749
New branches created under the repository directory will store their
1750
revisions in the repository, not in the branch directory.
1752
If the --no-trees option is used then the branches in the repository
1753
will not have working trees by default.
1756
Create a shared repositories holding just branches::
1758
bzr init-repo --no-trees repo
1761
Make a lightweight checkout elsewhere::
1763
bzr checkout --lightweight repo/trunk trunk-checkout
1768
_see_also = ['init', 'branch', 'checkout', 'repositories']
1769
takes_args = ["location"]
1770
takes_options = [RegistryOption('format',
1771
help='Specify a format for this repository. See'
1772
' "bzr help formats" for details.',
1773
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1774
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1775
value_switches=True, title='Repository format'),
1777
help='Branches in the repository will default to'
1778
' not having a working tree.'),
1780
aliases = ["init-repo"]
1782
def run(self, location, format=None, no_trees=False):
1784
format = bzrdir.format_registry.make_bzrdir('default')
1786
if location is None:
1789
to_transport = transport.get_transport(location)
1790
to_transport.ensure_base()
1792
newdir = format.initialize_on_transport(to_transport)
1793
repo = newdir.create_repository(shared=True)
1794
repo.set_make_working_trees(not no_trees)
1796
from bzrlib.info import show_bzrdir_info
1797
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1800
class cmd_diff(Command):
1801
"""Show differences in the working tree, between revisions or branches.
1803
If no arguments are given, all changes for the current tree are listed.
1804
If files are given, only the changes in those files are listed.
1805
Remote and multiple branches can be compared by using the --old and
1806
--new options. If not provided, the default for both is derived from
1807
the first argument, if any, or the current tree if no arguments are
1810
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1811
produces patches suitable for "patch -p1".
1815
2 - unrepresentable changes
1820
Shows the difference in the working tree versus the last commit::
1824
Difference between the working tree and revision 1::
1828
Difference between revision 2 and revision 1::
1832
Difference between revision 2 and revision 1 for branch xxx::
1836
Show just the differences for file NEWS::
1840
Show the differences in working tree xxx for file NEWS::
1844
Show the differences from branch xxx to this working tree:
1848
Show the differences between two branches for file NEWS::
1850
bzr diff --old xxx --new yyy NEWS
1852
Same as 'bzr diff' but prefix paths with old/ and new/::
1854
bzr diff --prefix old/:new/
1856
_see_also = ['status']
1857
takes_args = ['file*']
1859
Option('diff-options', type=str,
1860
help='Pass these options to the external diff program.'),
1861
Option('prefix', type=str,
1863
help='Set prefixes added to old and new filenames, as '
1864
'two values separated by a colon. (eg "old/:new/").'),
1866
help='Branch/tree to compare from.',
1870
help='Branch/tree to compare to.',
1876
help='Use this command to compare files.',
1880
aliases = ['di', 'dif']
1881
encoding_type = 'exact'
1884
def run(self, revision=None, file_list=None, diff_options=None,
1885
prefix=None, old=None, new=None, using=None):
1886
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1888
if (prefix is None) or (prefix == '0'):
1896
old_label, new_label = prefix.split(":")
1898
raise errors.BzrCommandError(
1899
'--prefix expects two values separated by a colon'
1900
' (eg "old/:new/")')
1902
if revision and len(revision) > 2:
1903
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1904
' one or two revision specifiers')
1906
old_tree, new_tree, specific_files, extra_trees = \
1907
_get_trees_to_diff(file_list, revision, old, new,
1909
return show_diff_trees(old_tree, new_tree, sys.stdout,
1910
specific_files=specific_files,
1911
external_diff_options=diff_options,
1912
old_label=old_label, new_label=new_label,
1913
extra_trees=extra_trees, using=using)
1916
class cmd_deleted(Command):
1917
"""List files deleted in the working tree.
1919
# TODO: Show files deleted since a previous revision, or
1920
# between two revisions.
1921
# TODO: Much more efficient way to do this: read in new
1922
# directories with readdir, rather than stating each one. Same
1923
# level of effort but possibly much less IO. (Or possibly not,
1924
# if the directories are very large...)
1925
_see_also = ['status', 'ls']
1926
takes_options = ['show-ids']
1929
def run(self, show_ids=False):
1930
tree = WorkingTree.open_containing(u'.')[0]
1933
old = tree.basis_tree()
1936
for path, ie in old.inventory.iter_entries():
1937
if not tree.has_id(ie.file_id):
1938
self.outf.write(path)
1940
self.outf.write(' ')
1941
self.outf.write(ie.file_id)
1942
self.outf.write('\n')
1949
class cmd_modified(Command):
1950
"""List files modified in working tree.
1954
_see_also = ['status', 'ls']
1957
help='Write an ascii NUL (\\0) separator '
1958
'between files rather than a newline.')
1962
def run(self, null=False):
1963
tree = WorkingTree.open_containing(u'.')[0]
1964
td = tree.changes_from(tree.basis_tree())
1965
for path, id, kind, text_modified, meta_modified in td.modified:
1967
self.outf.write(path + '\0')
1969
self.outf.write(osutils.quotefn(path) + '\n')
1972
class cmd_added(Command):
1973
"""List files added in working tree.
1977
_see_also = ['status', 'ls']
1980
help='Write an ascii NUL (\\0) separator '
1981
'between files rather than a newline.')
1985
def run(self, null=False):
1986
wt = WorkingTree.open_containing(u'.')[0]
1989
basis = wt.basis_tree()
1992
basis_inv = basis.inventory
1995
if file_id in basis_inv:
1997
if inv.is_root(file_id) and len(basis_inv) == 0:
1999
path = inv.id2path(file_id)
2000
if not os.access(osutils.abspath(path), os.F_OK):
2003
self.outf.write(path + '\0')
2005
self.outf.write(osutils.quotefn(path) + '\n')
2012
class cmd_root(Command):
2013
"""Show the tree root directory.
2015
The root is the nearest enclosing directory with a .bzr control
2018
takes_args = ['filename?']
2020
def run(self, filename=None):
2021
"""Print the branch root."""
2022
tree = WorkingTree.open_containing(filename)[0]
2023
self.outf.write(tree.basedir + '\n')
2026
def _parse_limit(limitstring):
2028
return int(limitstring)
2030
msg = "The limit argument must be an integer."
2031
raise errors.BzrCommandError(msg)
2034
def _parse_levels(s):
2038
msg = "The levels argument must be an integer."
2039
raise errors.BzrCommandError(msg)
2042
class cmd_log(Command):
2043
"""Show historical log for a branch or subset of a branch.
2045
log is bzr's default tool for exploring the history of a branch.
2046
The branch to use is taken from the first parameter. If no parameters
2047
are given, the branch containing the working directory is logged.
2048
Here are some simple examples::
2050
bzr log log the current branch
2051
bzr log foo.py log a file in its branch
2052
bzr log http://server/branch log a branch on a server
2054
The filtering, ordering and information shown for each revision can
2055
be controlled as explained below. By default, all revisions are
2056
shown sorted (topologically) so that newer revisions appear before
2057
older ones and descendants always appear before ancestors. If displayed,
2058
merged revisions are shown indented under the revision in which they
2063
The log format controls how information about each revision is
2064
displayed. The standard log formats are called ``long``, ``short``
2065
and ``line``. The default is long. See ``bzr help log-formats``
2066
for more details on log formats.
2068
The following options can be used to control what information is
2071
-l N display a maximum of N revisions
2072
-n N display N levels of revisions (0 for all, 1 for collapsed)
2073
-v display a status summary (delta) for each revision
2074
-p display a diff (patch) for each revision
2075
--show-ids display revision-ids (and file-ids), not just revnos
2077
Note that the default number of levels to display is a function of the
2078
log format. If the -n option is not used, the standard log formats show
2079
just the top level (mainline).
2081
Status summaries are shown using status flags like A, M, etc. To see
2082
the changes explained using words like ``added`` and ``modified``
2083
instead, use the -vv option.
2087
To display revisions from oldest to newest, use the --forward option.
2088
In most cases, using this option will have little impact on the total
2089
time taken to produce a log, though --forward does not incrementally
2090
display revisions like --reverse does when it can.
2092
:Revision filtering:
2094
The -r option can be used to specify what revision or range of revisions
2095
to filter against. The various forms are shown below::
2097
-rX display revision X
2098
-rX.. display revision X and later
2099
-r..Y display up to and including revision Y
2100
-rX..Y display from X to Y inclusive
2102
See ``bzr help revisionspec`` for details on how to specify X and Y.
2103
Some common examples are given below::
2105
-r-1 show just the tip
2106
-r-10.. show the last 10 mainline revisions
2107
-rsubmit:.. show what's new on this branch
2108
-rancestor:path.. show changes since the common ancestor of this
2109
branch and the one at location path
2110
-rdate:yesterday.. show changes since yesterday
2112
When logging a range of revisions using -rX..Y, log starts at
2113
revision Y and searches back in history through the primary
2114
("left-hand") parents until it finds X. When logging just the
2115
top level (using -n1), an error is reported if X is not found
2116
along the way. If multi-level logging is used (-n0), X may be
2117
a nested merge revision and the log will be truncated accordingly.
2121
If parameters are given and the first one is not a branch, the log
2122
will be filtered to show only those revisions that changed the
2123
nominated files or directories.
2125
Filenames are interpreted within their historical context. To log a
2126
deleted file, specify a revision range so that the file existed at
2127
the end or start of the range.
2129
Historical context is also important when interpreting pathnames of
2130
renamed files/directories. Consider the following example:
2132
* revision 1: add tutorial.txt
2133
* revision 2: modify tutorial.txt
2134
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2138
* ``bzr log guide.txt`` will log the file added in revision 1
2140
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2142
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2143
the original file in revision 2.
2145
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2146
was no file called guide.txt in revision 2.
2148
Renames are always followed by log. By design, there is no need to
2149
explicitly ask for this (and no way to stop logging a file back
2150
until it was last renamed).
2154
The --message option can be used for finding revisions that match a
2155
regular expression in a commit message.
2159
GUI tools and IDEs are often better at exploring history than command
2160
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2161
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2162
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2164
Web interfaces are often better at exploring history than command line
2165
tools, particularly for branches on servers. You may prefer Loggerhead
2166
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2168
You may find it useful to add the aliases below to ``bazaar.conf``::
2172
top = log -l10 --line
2175
``bzr tip`` will then show the latest revision while ``bzr top``
2176
will show the last 10 mainline revisions. To see the details of a
2177
particular revision X, ``bzr show -rX``.
2179
If you are interested in looking deeper into a particular merge X,
2180
use ``bzr log -n0 -rX``.
2182
``bzr log -v`` on a branch with lots of history is currently
2183
very slow. A fix for this issue is currently under development.
2184
With or without that fix, it is recommended that a revision range
2185
be given when using the -v option.
2187
bzr has a generic full-text matching plugin, bzr-search, that can be
2188
used to find revisions matching user names, commit messages, etc.
2189
Among other features, this plugin can find all revisions containing
2190
a list of words but not others.
2192
When exploring non-mainline history on large projects with deep
2193
history, the performance of log can be greatly improved by installing
2194
the historycache plugin. This plugin buffers historical information
2195
trading disk space for faster speed.
2197
takes_args = ['file*']
2198
_see_also = ['log-formats', 'revisionspec']
2201
help='Show from oldest to newest.'),
2203
custom_help('verbose',
2204
help='Show files changed in each revision.'),
2208
type=bzrlib.option._parse_revision_str,
2210
help='Show just the specified revision.'
2211
' See also "help revisionspec".'),
2215
help='Number of levels to display - 0 for all, 1 for flat.',
2217
type=_parse_levels),
2220
help='Show revisions whose message matches this '
2221
'regular expression.',
2225
help='Limit the output to the first N revisions.',
2230
help='Show changes made in each revision as a patch.'),
2231
Option('include-merges',
2232
help='Show merged revisions like --levels 0 does.'),
2234
encoding_type = 'replace'
2237
def run(self, file_list=None, timezone='original',
2248
include_merges=False):
2249
from bzrlib.log import (
2251
make_log_request_dict,
2252
_get_info_for_log_files,
2254
direction = (forward and 'forward') or 'reverse'
2259
raise errors.BzrCommandError(
2260
'--levels and --include-merges are mutually exclusive')
2262
if change is not None:
2264
raise errors.RangeInChangeOption()
2265
if revision is not None:
2266
raise errors.BzrCommandError(
2267
'--revision and --change are mutually exclusive')
2272
filter_by_dir = False
2274
# find the file ids to log and check for directory filtering
2275
b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2277
for relpath, file_id, kind in file_info_list:
2279
raise errors.BzrCommandError(
2280
"Path unknown at end or start of revision range: %s" %
2282
# If the relpath is the top of the tree, we log everything
2287
file_ids.append(file_id)
2288
filter_by_dir = filter_by_dir or (
2289
kind in ['directory', 'tree-reference'])
2292
# FIXME ? log the current subdir only RBC 20060203
2293
if revision is not None \
2294
and len(revision) > 0 and revision[0].get_branch():
2295
location = revision[0].get_branch()
2298
dir, relpath = bzrdir.BzrDir.open_containing(location)
2299
b = dir.open_branch()
2300
rev1, rev2 = _get_revision_range(revision, b, self.name())
2302
# Decide on the type of delta & diff filtering to use
2303
# TODO: add an --all-files option to make this configurable & consistent
2311
diff_type = 'partial'
2317
# Build the log formatter
2318
if log_format is None:
2319
log_format = log.log_formatter_registry.get_default(b)
2320
lf = log_format(show_ids=show_ids, to_file=self.outf,
2321
show_timezone=timezone,
2322
delta_format=get_verbosity_level(),
2324
show_advice=levels is None)
2326
# Choose the algorithm for doing the logging. It's annoying
2327
# having multiple code paths like this but necessary until
2328
# the underlying repository format is faster at generating
2329
# deltas or can provide everything we need from the indices.
2330
# The default algorithm - match-using-deltas - works for
2331
# multiple files and directories and is faster for small
2332
# amounts of history (200 revisions say). However, it's too
2333
# slow for logging a single file in a repository with deep
2334
# history, i.e. > 10K revisions. In the spirit of "do no
2335
# evil when adding features", we continue to use the
2336
# original algorithm - per-file-graph - for the "single
2337
# file that isn't a directory without showing a delta" case.
2338
partial_history = revision and b.repository._format.supports_chks
2339
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2340
or delta_type or partial_history)
2342
# Build the LogRequest and execute it
2343
if len(file_ids) == 0:
2345
rqst = make_log_request_dict(
2346
direction=direction, specific_fileids=file_ids,
2347
start_revision=rev1, end_revision=rev2, limit=limit,
2348
message_search=message, delta_type=delta_type,
2349
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2350
Logger(b, rqst).show(lf)
2355
def _get_revision_range(revisionspec_list, branch, command_name):
2356
"""Take the input of a revision option and turn it into a revision range.
2358
It returns RevisionInfo objects which can be used to obtain the rev_id's
2359
of the desired revisions. It does some user input validations.
2361
if revisionspec_list is None:
2364
elif len(revisionspec_list) == 1:
2365
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2366
elif len(revisionspec_list) == 2:
2367
start_spec = revisionspec_list[0]
2368
end_spec = revisionspec_list[1]
2369
if end_spec.get_branch() != start_spec.get_branch():
2370
# b is taken from revision[0].get_branch(), and
2371
# show_log will use its revision_history. Having
2372
# different branches will lead to weird behaviors.
2373
raise errors.BzrCommandError(
2374
"bzr %s doesn't accept two revisions in different"
2375
" branches." % command_name)
2376
rev1 = start_spec.in_history(branch)
2377
# Avoid loading all of history when we know a missing
2378
# end of range means the last revision ...
2379
if end_spec.spec is None:
2380
last_revno, last_revision_id = branch.last_revision_info()
2381
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2383
rev2 = end_spec.in_history(branch)
2385
raise errors.BzrCommandError(
2386
'bzr %s --revision takes one or two values.' % command_name)
2390
def _revision_range_to_revid_range(revision_range):
2393
if revision_range[0] is not None:
2394
rev_id1 = revision_range[0].rev_id
2395
if revision_range[1] is not None:
2396
rev_id2 = revision_range[1].rev_id
2397
return rev_id1, rev_id2
2399
def get_log_format(long=False, short=False, line=False, default='long'):
2400
log_format = default
2404
log_format = 'short'
2410
class cmd_touching_revisions(Command):
2411
"""Return revision-ids which affected a particular file.
2413
A more user-friendly interface is "bzr log FILE".
2417
takes_args = ["filename"]
2420
def run(self, filename):
2421
tree, relpath = WorkingTree.open_containing(filename)
2423
file_id = tree.path2id(relpath)
2424
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2425
self.outf.write("%6d %s\n" % (revno, what))
2428
class cmd_ls(Command):
2429
"""List files in a tree.
2432
_see_also = ['status', 'cat']
2433
takes_args = ['path?']
2437
Option('recursive', short_name='R',
2438
help='Recurse into subdirectories.'),
2440
help='Print paths relative to the root of the branch.'),
2441
Option('unknown', help='Print unknown files.'),
2442
Option('versioned', help='Print versioned files.',
2444
Option('ignored', help='Print ignored files.'),
2446
help='Write an ascii NUL (\\0) separator '
2447
'between files rather than a newline.'),
2449
help='List entries of a particular kind: file, directory, symlink.',
2454
def run(self, revision=None, verbose=False,
2455
recursive=False, from_root=False,
2456
unknown=False, versioned=False, ignored=False,
2457
null=False, kind=None, show_ids=False, path=None):
2459
if kind and kind not in ('file', 'directory', 'symlink'):
2460
raise errors.BzrCommandError('invalid kind specified')
2462
if verbose and null:
2463
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2464
all = not (unknown or versioned or ignored)
2466
selection = {'I':ignored, '?':unknown, 'V':versioned}
2472
raise errors.BzrCommandError('cannot specify both --from-root'
2475
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2478
# Calculate the prefix to use
2482
prefix = relpath + '/'
2483
elif fs_path != '.':
2484
prefix = fs_path + '/'
2486
if revision is not None or tree is None:
2487
tree = _get_one_revision_tree('ls', revision, branch=branch)
2490
if isinstance(tree, WorkingTree) and tree.supports_views():
2491
view_files = tree.views.lookup_view()
2494
view_str = views.view_display_str(view_files)
2495
note("Ignoring files outside view. View is %s" % view_str)
2499
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2500
from_dir=relpath, recursive=recursive):
2501
# Apply additional masking
2502
if not all and not selection[fc]:
2504
if kind is not None and fkind != kind:
2509
fullpath = osutils.pathjoin(relpath, fp)
2512
views.check_path_in_view(tree, fullpath)
2513
except errors.FileOutsideView:
2518
fp = osutils.pathjoin(prefix, fp)
2519
kindch = entry.kind_character()
2520
outstring = fp + kindch
2521
ui.ui_factory.clear_term()
2523
outstring = '%-8s %s' % (fc, outstring)
2524
if show_ids and fid is not None:
2525
outstring = "%-50s %s" % (outstring, fid)
2526
self.outf.write(outstring + '\n')
2528
self.outf.write(fp + '\0')
2531
self.outf.write(fid)
2532
self.outf.write('\0')
2540
self.outf.write('%-50s %s\n' % (outstring, my_id))
2542
self.outf.write(outstring + '\n')
2547
class cmd_unknowns(Command):
2548
"""List unknown files.
2556
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2557
self.outf.write(osutils.quotefn(f) + '\n')
2560
class cmd_ignore(Command):
2561
"""Ignore specified files or patterns.
2563
See ``bzr help patterns`` for details on the syntax of patterns.
2565
To remove patterns from the ignore list, edit the .bzrignore file.
2566
After adding, editing or deleting that file either indirectly by
2567
using this command or directly by using an editor, be sure to commit
2570
Note: ignore patterns containing shell wildcards must be quoted from
2574
Ignore the top level Makefile::
2576
bzr ignore ./Makefile
2578
Ignore class files in all directories::
2580
bzr ignore "*.class"
2582
Ignore .o files under the lib directory::
2584
bzr ignore "lib/**/*.o"
2586
Ignore .o files under the lib directory::
2588
bzr ignore "RE:lib/.*\.o"
2590
Ignore everything but the "debian" toplevel directory::
2592
bzr ignore "RE:(?!debian/).*"
2595
_see_also = ['status', 'ignored', 'patterns']
2596
takes_args = ['name_pattern*']
2598
Option('old-default-rules',
2599
help='Write out the ignore rules bzr < 0.9 always used.')
2602
def run(self, name_pattern_list=None, old_default_rules=None):
2603
from bzrlib import ignores
2604
if old_default_rules is not None:
2605
# dump the rules and exit
2606
for pattern in ignores.OLD_DEFAULTS:
2609
if not name_pattern_list:
2610
raise errors.BzrCommandError("ignore requires at least one "
2611
"NAME_PATTERN or --old-default-rules")
2612
name_pattern_list = [globbing.normalize_pattern(p)
2613
for p in name_pattern_list]
2614
for name_pattern in name_pattern_list:
2615
if (name_pattern[0] == '/' or
2616
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2617
raise errors.BzrCommandError(
2618
"NAME_PATTERN should not be an absolute path")
2619
tree, relpath = WorkingTree.open_containing(u'.')
2620
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2621
ignored = globbing.Globster(name_pattern_list)
2624
for entry in tree.list_files():
2628
if ignored.match(filename):
2629
matches.append(filename.encode('utf-8'))
2631
if len(matches) > 0:
2632
print "Warning: the following files are version controlled and" \
2633
" match your ignore pattern:\n%s" \
2634
"\nThese files will continue to be version controlled" \
2635
" unless you 'bzr remove' them." % ("\n".join(matches),)
2638
class cmd_ignored(Command):
2639
"""List ignored files and the patterns that matched them.
2641
List all the ignored files and the ignore pattern that caused the file to
2644
Alternatively, to list just the files::
2649
encoding_type = 'replace'
2650
_see_also = ['ignore', 'ls']
2654
tree = WorkingTree.open_containing(u'.')[0]
2657
for path, file_class, kind, file_id, entry in tree.list_files():
2658
if file_class != 'I':
2660
## XXX: Slightly inefficient since this was already calculated
2661
pat = tree.is_ignored(path)
2662
self.outf.write('%-50s %s\n' % (path, pat))
2667
class cmd_lookup_revision(Command):
2668
"""Lookup the revision-id from a revision-number
2671
bzr lookup-revision 33
2674
takes_args = ['revno']
2677
def run(self, revno):
2681
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2683
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2686
class cmd_export(Command):
2687
"""Export current or past revision to a destination directory or archive.
2689
If no revision is specified this exports the last committed revision.
2691
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2692
given, try to find the format with the extension. If no extension
2693
is found exports to a directory (equivalent to --format=dir).
2695
If root is supplied, it will be used as the root directory inside
2696
container formats (tar, zip, etc). If it is not supplied it will default
2697
to the exported filename. The root option has no effect for 'dir' format.
2699
If branch is omitted then the branch containing the current working
2700
directory will be used.
2702
Note: Export of tree with non-ASCII filenames to zip is not supported.
2704
================= =========================
2705
Supported formats Autodetected by extension
2706
================= =========================
2709
tbz2 .tar.bz2, .tbz2
2712
================= =========================
2714
takes_args = ['dest', 'branch_or_subdir?']
2717
help="Type of file to export to.",
2720
Option('filters', help='Apply content filters to export the '
2721
'convenient form.'),
2724
help="Name of the root directory inside the exported file."),
2726
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2727
root=None, filters=False):
2728
from bzrlib.export import export
2730
if branch_or_subdir is None:
2731
tree = WorkingTree.open_containing(u'.')[0]
2735
b, subdir = Branch.open_containing(branch_or_subdir)
2738
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2740
export(rev_tree, dest, format, root, subdir, filtered=filters)
2741
except errors.NoSuchExportFormat, e:
2742
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2745
class cmd_cat(Command):
2746
"""Write the contents of a file as of a given revision to standard output.
2748
If no revision is nominated, the last revision is used.
2750
Note: Take care to redirect standard output when using this command on a
2756
Option('name-from-revision', help='The path name in the old tree.'),
2757
Option('filters', help='Apply content filters to display the '
2758
'convenience form.'),
2761
takes_args = ['filename']
2762
encoding_type = 'exact'
2765
def run(self, filename, revision=None, name_from_revision=False,
2767
if revision is not None and len(revision) != 1:
2768
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2769
" one revision specifier")
2770
tree, branch, relpath = \
2771
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2774
return self._run(tree, branch, relpath, filename, revision,
2775
name_from_revision, filters)
2779
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2782
tree = b.basis_tree()
2783
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2785
old_file_id = rev_tree.path2id(relpath)
2787
if name_from_revision:
2788
# Try in revision if requested
2789
if old_file_id is None:
2790
raise errors.BzrCommandError(
2791
"%r is not present in revision %s" % (
2792
filename, rev_tree.get_revision_id()))
2794
content = rev_tree.get_file_text(old_file_id)
2796
cur_file_id = tree.path2id(relpath)
2798
if cur_file_id is not None:
2799
# Then try with the actual file id
2801
content = rev_tree.get_file_text(cur_file_id)
2803
except errors.NoSuchId:
2804
# The actual file id didn't exist at that time
2806
if not found and old_file_id is not None:
2807
# Finally try with the old file id
2808
content = rev_tree.get_file_text(old_file_id)
2811
# Can't be found anywhere
2812
raise errors.BzrCommandError(
2813
"%r is not present in revision %s" % (
2814
filename, rev_tree.get_revision_id()))
2816
from bzrlib.filters import (
2817
ContentFilterContext,
2818
filtered_output_bytes,
2820
filters = rev_tree._content_filter_stack(relpath)
2821
chunks = content.splitlines(True)
2822
content = filtered_output_bytes(chunks, filters,
2823
ContentFilterContext(relpath, rev_tree))
2824
self.outf.writelines(content)
2826
self.outf.write(content)
2829
class cmd_local_time_offset(Command):
2830
"""Show the offset in seconds from GMT to local time."""
2834
print osutils.local_time_offset()
2838
class cmd_commit(Command):
2839
"""Commit changes into a new revision.
2841
An explanatory message needs to be given for each commit. This is
2842
often done by using the --message option (getting the message from the
2843
command line) or by using the --file option (getting the message from
2844
a file). If neither of these options is given, an editor is opened for
2845
the user to enter the message. To see the changed files in the
2846
boilerplate text loaded into the editor, use the --show-diff option.
2848
By default, the entire tree is committed and the person doing the
2849
commit is assumed to be the author. These defaults can be overridden
2854
If selected files are specified, only changes to those files are
2855
committed. If a directory is specified then the directory and
2856
everything within it is committed.
2858
When excludes are given, they take precedence over selected files.
2859
For example, to commit only changes within foo, but not changes
2862
bzr commit foo -x foo/bar
2864
A selective commit after a merge is not yet supported.
2868
If the author of the change is not the same person as the committer,
2869
you can specify the author's name using the --author option. The
2870
name should be in the same format as a committer-id, e.g.
2871
"John Doe <jdoe@example.com>". If there is more than one author of
2872
the change you can specify the option multiple times, once for each
2877
A common mistake is to forget to add a new file or directory before
2878
running the commit command. The --strict option checks for unknown
2879
files and aborts the commit if any are found. More advanced pre-commit
2880
checks can be implemented by defining hooks. See ``bzr help hooks``
2885
If you accidentially commit the wrong changes or make a spelling
2886
mistake in the commit message say, you can use the uncommit command
2887
to undo it. See ``bzr help uncommit`` for details.
2889
Hooks can also be configured to run after a commit. This allows you
2890
to trigger updates to external systems like bug trackers. The --fixes
2891
option can be used to record the association between a revision and
2892
one or more bugs. See ``bzr help bugs`` for details.
2894
A selective commit may fail in some cases where the committed
2895
tree would be invalid. Consider::
2900
bzr commit foo -m "committing foo"
2901
bzr mv foo/bar foo/baz
2904
bzr commit foo/bar -m "committing bar but not baz"
2906
In the example above, the last commit will fail by design. This gives
2907
the user the opportunity to decide whether they want to commit the
2908
rename at the same time, separately first, or not at all. (As a general
2909
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2911
# TODO: Run hooks on tree to-be-committed, and after commit.
2913
# TODO: Strict commit that fails if there are deleted files.
2914
# (what does "deleted files" mean ??)
2916
# TODO: Give better message for -s, --summary, used by tla people
2918
# XXX: verbose currently does nothing
2920
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2921
takes_args = ['selected*']
2923
ListOption('exclude', type=str, short_name='x',
2924
help="Do not consider changes made to a given path."),
2925
Option('message', type=unicode,
2927
help="Description of the new revision."),
2930
help='Commit even if nothing has changed.'),
2931
Option('file', type=str,
2934
help='Take commit message from this file.'),
2936
help="Refuse to commit if there are unknown "
2937
"files in the working tree."),
2938
ListOption('fixes', type=str,
2939
help="Mark a bug as being fixed by this revision "
2940
"(see \"bzr help bugs\")."),
2941
ListOption('author', type=unicode,
2942
help="Set the author's name, if it's different "
2943
"from the committer."),
2945
help="Perform a local commit in a bound "
2946
"branch. Local commits are not pushed to "
2947
"the master branch until a normal commit "
2951
help='When no message is supplied, show the diff along'
2952
' with the status summary in the message editor.'),
2954
aliases = ['ci', 'checkin']
2956
def _iter_bug_fix_urls(self, fixes, branch):
2957
# Configure the properties for bug fixing attributes.
2958
for fixed_bug in fixes:
2959
tokens = fixed_bug.split(':')
2960
if len(tokens) != 2:
2961
raise errors.BzrCommandError(
2962
"Invalid bug %s. Must be in the form of 'tracker:id'. "
2963
"See \"bzr help bugs\" for more information on this "
2964
"feature.\nCommit refused." % fixed_bug)
2965
tag, bug_id = tokens
2967
yield bugtracker.get_bug_url(tag, branch, bug_id)
2968
except errors.UnknownBugTrackerAbbreviation:
2969
raise errors.BzrCommandError(
2970
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2971
except errors.MalformedBugIdentifier, e:
2972
raise errors.BzrCommandError(
2973
"%s\nCommit refused." % (str(e),))
2975
def run(self, message=None, file=None, verbose=False, selected_list=None,
2976
unchanged=False, strict=False, local=False, fixes=None,
2977
author=None, show_diff=False, exclude=None):
2978
from bzrlib.errors import (
2983
from bzrlib.msgeditor import (
2984
edit_commit_message_encoded,
2985
generate_commit_message_template,
2986
make_commit_message_template_encoded
2989
# TODO: Need a blackbox test for invoking the external editor; may be
2990
# slightly problematic to run this cross-platform.
2992
# TODO: do more checks that the commit will succeed before
2993
# spending the user's valuable time typing a commit message.
2997
tree, selected_list = tree_files(selected_list)
2998
if selected_list == ['']:
2999
# workaround - commit of root of tree should be exactly the same
3000
# as just default commit in that tree, and succeed even though
3001
# selected-file merge commit is not done yet
3006
bug_property = bugtracker.encode_fixes_bug_urls(
3007
self._iter_bug_fix_urls(fixes, tree.branch))
3009
properties['bugs'] = bug_property
3011
if local and not tree.branch.get_bound_location():
3012
raise errors.LocalRequiresBoundBranch()
3014
def get_message(commit_obj):
3015
"""Callback to get commit message"""
3016
my_message = message
3017
if my_message is None and not file:
3018
t = make_commit_message_template_encoded(tree,
3019
selected_list, diff=show_diff,
3020
output_encoding=osutils.get_user_encoding())
3021
start_message = generate_commit_message_template(commit_obj)
3022
my_message = edit_commit_message_encoded(t,
3023
start_message=start_message)
3024
if my_message is None:
3025
raise errors.BzrCommandError("please specify a commit"
3026
" message with either --message or --file")
3027
elif my_message and file:
3028
raise errors.BzrCommandError(
3029
"please specify either --message or --file")
3031
my_message = codecs.open(file, 'rt',
3032
osutils.get_user_encoding()).read()
3033
if my_message == "":
3034
raise errors.BzrCommandError("empty commit message specified")
3038
tree.commit(message_callback=get_message,
3039
specific_files=selected_list,
3040
allow_pointless=unchanged, strict=strict, local=local,
3041
reporter=None, verbose=verbose, revprops=properties,
3043
exclude=safe_relpath_files(tree, exclude))
3044
except PointlessCommit:
3045
# FIXME: This should really happen before the file is read in;
3046
# perhaps prepare the commit; get the message; then actually commit
3047
raise errors.BzrCommandError("No changes to commit."
3048
" Use --unchanged to commit anyhow.")
3049
except ConflictsInTree:
3050
raise errors.BzrCommandError('Conflicts detected in working '
3051
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3053
except StrictCommitFailed:
3054
raise errors.BzrCommandError("Commit refused because there are"
3055
" unknown files in the working tree.")
3056
except errors.BoundBranchOutOfDate, e:
3057
raise errors.BzrCommandError(str(e) + "\n"
3058
'To commit to master branch, run update and then commit.\n'
3059
'You can also pass --local to commit to continue working '
3063
class cmd_check(Command):
3064
"""Validate working tree structure, branch consistency and repository history.
3066
This command checks various invariants about branch and repository storage
3067
to detect data corruption or bzr bugs.
3069
The working tree and branch checks will only give output if a problem is
3070
detected. The output fields of the repository check are:
3073
This is just the number of revisions checked. It doesn't
3077
This is just the number of versionedfiles checked. It
3078
doesn't indicate a problem.
3080
unreferenced ancestors
3081
Texts that are ancestors of other texts, but
3082
are not properly referenced by the revision ancestry. This is a
3083
subtle problem that Bazaar can work around.
3086
This is the total number of unique file contents
3087
seen in the checked revisions. It does not indicate a problem.
3090
This is the total number of repeated texts seen
3091
in the checked revisions. Texts can be repeated when their file
3092
entries are modified, but the file contents are not. It does not
3095
If no restrictions are specified, all Bazaar data that is found at the given
3096
location will be checked.
3100
Check the tree and branch at 'foo'::
3102
bzr check --tree --branch foo
3104
Check only the repository at 'bar'::
3106
bzr check --repo bar
3108
Check everything at 'baz'::
3113
_see_also = ['reconcile']
3114
takes_args = ['path?']
3115
takes_options = ['verbose',
3116
Option('branch', help="Check the branch related to the"
3117
" current directory."),
3118
Option('repo', help="Check the repository related to the"
3119
" current directory."),
3120
Option('tree', help="Check the working tree related to"
3121
" the current directory.")]
3123
def run(self, path=None, verbose=False, branch=False, repo=False,
3125
from bzrlib.check import check_dwim
3128
if not branch and not repo and not tree:
3129
branch = repo = tree = True
3130
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3133
class cmd_upgrade(Command):
3134
"""Upgrade branch storage to current format.
3136
The check command or bzr developers may sometimes advise you to run
3137
this command. When the default format has changed you may also be warned
3138
during other operations to upgrade.
3141
_see_also = ['check']
3142
takes_args = ['url?']
3144
RegistryOption('format',
3145
help='Upgrade to a specific format. See "bzr help'
3146
' formats" for details.',
3147
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3148
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3149
value_switches=True, title='Branch format'),
3152
def run(self, url='.', format=None):
3153
from bzrlib.upgrade import upgrade
3154
upgrade(url, format)
3157
class cmd_whoami(Command):
3158
"""Show or set bzr user id.
3161
Show the email of the current user::
3165
Set the current user::
3167
bzr whoami "Frank Chu <fchu@example.com>"
3169
takes_options = [ Option('email',
3170
help='Display email address only.'),
3172
help='Set identity for the current branch instead of '
3175
takes_args = ['name?']
3176
encoding_type = 'replace'
3179
def run(self, email=False, branch=False, name=None):
3181
# use branch if we're inside one; otherwise global config
3183
c = Branch.open_containing('.')[0].get_config()
3184
except errors.NotBranchError:
3185
c = config.GlobalConfig()
3187
self.outf.write(c.user_email() + '\n')
3189
self.outf.write(c.username() + '\n')
3192
# display a warning if an email address isn't included in the given name.
3194
config.extract_email_address(name)
3195
except errors.NoEmailInUsername, e:
3196
warning('"%s" does not seem to contain an email address. '
3197
'This is allowed, but not recommended.', name)
3199
# use global config unless --branch given
3201
c = Branch.open_containing('.')[0].get_config()
3203
c = config.GlobalConfig()
3204
c.set_user_option('email', name)
3207
class cmd_nick(Command):
3208
"""Print or set the branch nickname.
3210
If unset, the tree root directory name is used as the nickname.
3211
To print the current nickname, execute with no argument.
3213
Bound branches use the nickname of its master branch unless it is set
3217
_see_also = ['info']
3218
takes_args = ['nickname?']
3219
def run(self, nickname=None):
3220
branch = Branch.open_containing(u'.')[0]
3221
if nickname is None:
3222
self.printme(branch)
3224
branch.nick = nickname
3227
def printme(self, branch):
3231
class cmd_alias(Command):
3232
"""Set/unset and display aliases.
3235
Show the current aliases::
3239
Show the alias specified for 'll'::
3243
Set an alias for 'll'::
3245
bzr alias ll="log --line -r-10..-1"
3247
To remove an alias for 'll'::
3249
bzr alias --remove ll
3252
takes_args = ['name?']
3254
Option('remove', help='Remove the alias.'),
3257
def run(self, name=None, remove=False):
3259
self.remove_alias(name)
3261
self.print_aliases()
3263
equal_pos = name.find('=')
3265
self.print_alias(name)
3267
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3269
def remove_alias(self, alias_name):
3270
if alias_name is None:
3271
raise errors.BzrCommandError(
3272
'bzr alias --remove expects an alias to remove.')
3273
# If alias is not found, print something like:
3274
# unalias: foo: not found
3275
c = config.GlobalConfig()
3276
c.unset_alias(alias_name)
3279
def print_aliases(self):
3280
"""Print out the defined aliases in a similar format to bash."""
3281
aliases = config.GlobalConfig().get_aliases()
3282
for key, value in sorted(aliases.iteritems()):
3283
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3286
def print_alias(self, alias_name):
3287
from bzrlib.commands import get_alias
3288
alias = get_alias(alias_name)
3290
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3293
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3295
def set_alias(self, alias_name, alias_command):
3296
"""Save the alias in the global config."""
3297
c = config.GlobalConfig()
3298
c.set_alias(alias_name, alias_command)
3301
class cmd_selftest(Command):
3302
"""Run internal test suite.
3304
If arguments are given, they are regular expressions that say which tests
3305
should run. Tests matching any expression are run, and other tests are
3308
Alternatively if --first is given, matching tests are run first and then
3309
all other tests are run. This is useful if you have been working in a
3310
particular area, but want to make sure nothing else was broken.
3312
If --exclude is given, tests that match that regular expression are
3313
excluded, regardless of whether they match --first or not.
3315
To help catch accidential dependencies between tests, the --randomize
3316
option is useful. In most cases, the argument used is the word 'now'.
3317
Note that the seed used for the random number generator is displayed
3318
when this option is used. The seed can be explicitly passed as the
3319
argument to this option if required. This enables reproduction of the
3320
actual ordering used if and when an order sensitive problem is encountered.
3322
If --list-only is given, the tests that would be run are listed. This is
3323
useful when combined with --first, --exclude and/or --randomize to
3324
understand their impact. The test harness reports "Listed nn tests in ..."
3325
instead of "Ran nn tests in ..." when list mode is enabled.
3327
If the global option '--no-plugins' is given, plugins are not loaded
3328
before running the selftests. This has two effects: features provided or
3329
modified by plugins will not be tested, and tests provided by plugins will
3332
Tests that need working space on disk use a common temporary directory,
3333
typically inside $TMPDIR or /tmp.
3336
Run only tests relating to 'ignore'::
3340
Disable plugins and list tests as they're run::
3342
bzr --no-plugins selftest -v
3344
# NB: this is used from the class without creating an instance, which is
3345
# why it does not have a self parameter.
3346
def get_transport_type(typestring):
3347
"""Parse and return a transport specifier."""
3348
if typestring == "sftp":
3349
from bzrlib.transport.sftp import SFTPAbsoluteServer
3350
return SFTPAbsoluteServer
3351
if typestring == "memory":
3352
from bzrlib.transport.memory import MemoryServer
3354
if typestring == "fakenfs":
3355
from bzrlib.transport.fakenfs import FakeNFSServer
3356
return FakeNFSServer
3357
msg = "No known transport type %s. Supported types are: sftp\n" %\
3359
raise errors.BzrCommandError(msg)
3362
takes_args = ['testspecs*']
3363
takes_options = ['verbose',
3365
help='Stop when one test fails.',
3369
help='Use a different transport by default '
3370
'throughout the test suite.',
3371
type=get_transport_type),
3373
help='Run the benchmarks rather than selftests.'),
3374
Option('lsprof-timed',
3375
help='Generate lsprof output for benchmarked'
3376
' sections of code.'),
3377
Option('cache-dir', type=str,
3378
help='Cache intermediate benchmark output in this '
3381
help='Run all tests, but run specified tests first.',
3385
help='List the tests instead of running them.'),
3386
RegistryOption('parallel',
3387
help="Run the test suite in parallel.",
3388
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3389
value_switches=False,
3391
Option('randomize', type=str, argname="SEED",
3392
help='Randomize the order of tests using the given'
3393
' seed or "now" for the current time.'),
3394
Option('exclude', type=str, argname="PATTERN",
3396
help='Exclude tests that match this regular'
3399
help='Output test progress via subunit.'),
3400
Option('strict', help='Fail on missing dependencies or '
3402
Option('load-list', type=str, argname='TESTLISTFILE',
3403
help='Load a test id list from a text file.'),
3404
ListOption('debugflag', type=str, short_name='E',
3405
help='Turn on a selftest debug flag.'),
3406
ListOption('starting-with', type=str, argname='TESTID',
3407
param_name='starting_with', short_name='s',
3409
'Load only the tests starting with TESTID.'),
3411
encoding_type = 'replace'
3414
Command.__init__(self)
3415
self.additional_selftest_args = {}
3417
def run(self, testspecs_list=None, verbose=False, one=False,
3418
transport=None, benchmark=None,
3419
lsprof_timed=None, cache_dir=None,
3420
first=False, list_only=False,
3421
randomize=None, exclude=None, strict=False,
3422
load_list=None, debugflag=None, starting_with=None, subunit=False,
3424
from bzrlib.tests import selftest
3425
import bzrlib.benchmarks as benchmarks
3426
from bzrlib.benchmarks import tree_creator
3428
# Make deprecation warnings visible, unless -Werror is set
3429
symbol_versioning.activate_deprecation_warnings(override=False)
3431
if cache_dir is not None:
3432
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3433
if testspecs_list is not None:
3434
pattern = '|'.join(testspecs_list)
3439
from bzrlib.tests import SubUnitBzrRunner
3441
raise errors.BzrCommandError("subunit not available. subunit "
3442
"needs to be installed to use --subunit.")
3443
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3445
self.additional_selftest_args.setdefault(
3446
'suite_decorators', []).append(parallel)
3448
test_suite_factory = benchmarks.test_suite
3449
# Unless user explicitly asks for quiet, be verbose in benchmarks
3450
verbose = not is_quiet()
3451
# TODO: should possibly lock the history file...
3452
benchfile = open(".perf_history", "at", buffering=1)
3454
test_suite_factory = None
3457
selftest_kwargs = {"verbose": verbose,
3459
"stop_on_failure": one,
3460
"transport": transport,
3461
"test_suite_factory": test_suite_factory,
3462
"lsprof_timed": lsprof_timed,
3463
"bench_history": benchfile,
3464
"matching_tests_first": first,
3465
"list_only": list_only,
3466
"random_seed": randomize,
3467
"exclude_pattern": exclude,
3469
"load_list": load_list,
3470
"debug_flags": debugflag,
3471
"starting_with": starting_with
3473
selftest_kwargs.update(self.additional_selftest_args)
3474
result = selftest(**selftest_kwargs)
3476
if benchfile is not None:
3478
return int(not result)
3481
class cmd_version(Command):
3482
"""Show version of bzr."""
3484
encoding_type = 'replace'
3486
Option("short", help="Print just the version number."),
3490
def run(self, short=False):
3491
from bzrlib.version import show_version
3493
self.outf.write(bzrlib.version_string + '\n')
3495
show_version(to_file=self.outf)
3498
class cmd_rocks(Command):
3499
"""Statement of optimism."""
3505
print "It sure does!"
3508
class cmd_find_merge_base(Command):
3509
"""Find and print a base revision for merging two branches."""
3510
# TODO: Options to specify revisions on either side, as if
3511
# merging only part of the history.
3512
takes_args = ['branch', 'other']
3516
def run(self, branch, other):
3517
from bzrlib.revision import ensure_null
3519
branch1 = Branch.open_containing(branch)[0]
3520
branch2 = Branch.open_containing(other)[0]
3525
last1 = ensure_null(branch1.last_revision())
3526
last2 = ensure_null(branch2.last_revision())
3528
graph = branch1.repository.get_graph(branch2.repository)
3529
base_rev_id = graph.find_unique_lca(last1, last2)
3531
print 'merge base is revision %s' % base_rev_id
3538
class cmd_merge(Command):
3539
"""Perform a three-way merge.
3541
The source of the merge can be specified either in the form of a branch,
3542
or in the form of a path to a file containing a merge directive generated
3543
with bzr send. If neither is specified, the default is the upstream branch
3544
or the branch most recently merged using --remember.
3546
When merging a branch, by default the tip will be merged. To pick a different
3547
revision, pass --revision. If you specify two values, the first will be used as
3548
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3549
available revisions, like this is commonly referred to as "cherrypicking".
3551
Revision numbers are always relative to the branch being merged.
3553
By default, bzr will try to merge in all new work from the other
3554
branch, automatically determining an appropriate base. If this
3555
fails, you may need to give an explicit base.
3557
Merge will do its best to combine the changes in two branches, but there
3558
are some kinds of problems only a human can fix. When it encounters those,
3559
it will mark a conflict. A conflict means that you need to fix something,
3560
before you should commit.
3562
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3564
If there is no default branch set, the first merge will set it. After
3565
that, you can omit the branch to use the default. To change the
3566
default, use --remember. The value will only be saved if the remote
3567
location can be accessed.
3569
The results of the merge are placed into the destination working
3570
directory, where they can be reviewed (with bzr diff), tested, and then
3571
committed to record the result of the merge.
3573
merge refuses to run if there are any uncommitted changes, unless
3576
To select only some changes to merge, use "merge -i", which will prompt
3577
you to apply each diff hunk and file change, similar to "shelve".
3580
To merge the latest revision from bzr.dev::
3582
bzr merge ../bzr.dev
3584
To merge changes up to and including revision 82 from bzr.dev::
3586
bzr merge -r 82 ../bzr.dev
3588
To merge the changes introduced by 82, without previous changes::
3590
bzr merge -r 81..82 ../bzr.dev
3592
To apply a merge directive contained in /tmp/merge:
3594
bzr merge /tmp/merge
3597
encoding_type = 'exact'
3598
_see_also = ['update', 'remerge', 'status-flags', 'send']
3599
takes_args = ['location?']
3604
help='Merge even if the destination tree has uncommitted changes.'),
3608
Option('show-base', help="Show base revision text in "
3610
Option('uncommitted', help='Apply uncommitted changes'
3611
' from a working copy, instead of branch changes.'),
3612
Option('pull', help='If the destination is already'
3613
' completely merged into the source, pull from the'
3614
' source rather than merging. When this happens,'
3615
' you do not need to commit the result.'),
3617
help='Branch to merge into, '
3618
'rather than the one containing the working directory.',
3622
Option('preview', help='Instead of merging, show a diff of the'
3624
Option('interactive', help='Select changes interactively.',
3628
def run(self, location=None, revision=None, force=False,
3629
merge_type=None, show_base=False, reprocess=None, remember=False,
3630
uncommitted=False, pull=False,
3635
if merge_type is None:
3636
merge_type = _mod_merge.Merge3Merger
3638
if directory is None: directory = u'.'
3639
possible_transports = []
3641
allow_pending = True
3642
verified = 'inapplicable'
3643
tree = WorkingTree.open_containing(directory)[0]
3645
# die as quickly as possible if there are uncommitted changes
3647
basis_tree = tree.revision_tree(tree.last_revision())
3648
except errors.NoSuchRevision:
3649
basis_tree = tree.basis_tree()
3651
if tree.has_changes(basis_tree):
3652
raise errors.UncommittedChanges(tree)
3654
view_info = _get_view_info_for_change_reporter(tree)
3655
change_reporter = delta._ChangeReporter(
3656
unversioned_filter=tree.is_ignored, view_info=view_info)
3659
pb = ui.ui_factory.nested_progress_bar()
3660
cleanups.append(pb.finished)
3662
cleanups.append(tree.unlock)
3663
if location is not None:
3665
mergeable = bundle.read_mergeable_from_url(location,
3666
possible_transports=possible_transports)
3667
except errors.NotABundle:
3671
raise errors.BzrCommandError('Cannot use --uncommitted'
3672
' with bundles or merge directives.')
3674
if revision is not None:
3675
raise errors.BzrCommandError(
3676
'Cannot use -r with merge directives or bundles')
3677
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3680
if merger is None and uncommitted:
3681
if revision is not None and len(revision) > 0:
3682
raise errors.BzrCommandError('Cannot use --uncommitted and'
3683
' --revision at the same time.')
3684
merger = self.get_merger_from_uncommitted(tree, location, pb,
3686
allow_pending = False
3689
merger, allow_pending = self._get_merger_from_branch(tree,
3690
location, revision, remember, possible_transports, pb)
3692
merger.merge_type = merge_type
3693
merger.reprocess = reprocess
3694
merger.show_base = show_base
3695
self.sanity_check_merger(merger)
3696
if (merger.base_rev_id == merger.other_rev_id and
3697
merger.other_rev_id is not None):
3698
note('Nothing to do.')
3701
if merger.interesting_files is not None:
3702
raise errors.BzrCommandError('Cannot pull individual files')
3703
if (merger.base_rev_id == tree.last_revision()):
3704
result = tree.pull(merger.other_branch, False,
3705
merger.other_rev_id)
3706
result.report(self.outf)
3708
merger.check_basis(False)
3710
return self._do_preview(merger, cleanups)
3712
return self._do_interactive(merger, cleanups)
3714
return self._do_merge(merger, change_reporter, allow_pending,
3717
for cleanup in reversed(cleanups):
3720
def _get_preview(self, merger, cleanups):
3721
tree_merger = merger.make_merger()
3722
tt = tree_merger.make_preview_transform()
3723
cleanups.append(tt.finalize)
3724
result_tree = tt.get_preview_tree()
3727
def _do_preview(self, merger, cleanups):
3728
from bzrlib.diff import show_diff_trees
3729
result_tree = self._get_preview(merger, cleanups)
3730
show_diff_trees(merger.this_tree, result_tree, self.outf,
3731
old_label='', new_label='')
3733
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3734
merger.change_reporter = change_reporter
3735
conflict_count = merger.do_merge()
3737
merger.set_pending()
3738
if verified == 'failed':
3739
warning('Preview patch does not match changes')
3740
if conflict_count != 0:
3745
def _do_interactive(self, merger, cleanups):
3746
"""Perform an interactive merge.
3748
This works by generating a preview tree of the merge, then using
3749
Shelver to selectively remove the differences between the working tree
3750
and the preview tree.
3752
from bzrlib import shelf_ui
3753
result_tree = self._get_preview(merger, cleanups)
3754
writer = bzrlib.option.diff_writer_registry.get()
3755
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3756
reporter=shelf_ui.ApplyReporter(),
3757
diff_writer=writer(sys.stdout))
3760
def sanity_check_merger(self, merger):
3761
if (merger.show_base and
3762
not merger.merge_type is _mod_merge.Merge3Merger):
3763
raise errors.BzrCommandError("Show-base is not supported for this"
3764
" merge type. %s" % merger.merge_type)
3765
if merger.reprocess is None:
3766
if merger.show_base:
3767
merger.reprocess = False
3769
# Use reprocess if the merger supports it
3770
merger.reprocess = merger.merge_type.supports_reprocess
3771
if merger.reprocess and not merger.merge_type.supports_reprocess:
3772
raise errors.BzrCommandError("Conflict reduction is not supported"
3773
" for merge type %s." %
3775
if merger.reprocess and merger.show_base:
3776
raise errors.BzrCommandError("Cannot do conflict reduction and"
3779
def _get_merger_from_branch(self, tree, location, revision, remember,
3780
possible_transports, pb):
3781
"""Produce a merger from a location, assuming it refers to a branch."""
3782
from bzrlib.tag import _merge_tags_if_possible
3783
# find the branch locations
3784
other_loc, user_location = self._select_branch_location(tree, location,
3786
if revision is not None and len(revision) == 2:
3787
base_loc, _unused = self._select_branch_location(tree,
3788
location, revision, 0)
3790
base_loc = other_loc
3792
other_branch, other_path = Branch.open_containing(other_loc,
3793
possible_transports)
3794
if base_loc == other_loc:
3795
base_branch = other_branch
3797
base_branch, base_path = Branch.open_containing(base_loc,
3798
possible_transports)
3799
# Find the revision ids
3800
if revision is None or len(revision) < 1 or revision[-1] is None:
3801
other_revision_id = _mod_revision.ensure_null(
3802
other_branch.last_revision())
3804
other_revision_id = revision[-1].as_revision_id(other_branch)
3805
if (revision is not None and len(revision) == 2
3806
and revision[0] is not None):
3807
base_revision_id = revision[0].as_revision_id(base_branch)
3809
base_revision_id = None
3810
# Remember where we merge from
3811
if ((remember or tree.branch.get_submit_branch() is None) and
3812
user_location is not None):
3813
tree.branch.set_submit_branch(other_branch.base)
3814
_merge_tags_if_possible(other_branch, tree.branch)
3815
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3816
other_revision_id, base_revision_id, other_branch, base_branch)
3817
if other_path != '':
3818
allow_pending = False
3819
merger.interesting_files = [other_path]
3821
allow_pending = True
3822
return merger, allow_pending
3824
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3825
"""Get a merger for uncommitted changes.
3827
:param tree: The tree the merger should apply to.
3828
:param location: The location containing uncommitted changes.
3829
:param pb: The progress bar to use for showing progress.
3830
:param cleanups: A list of operations to perform to clean up the
3831
temporary directories, unfinalized objects, etc.
3833
location = self._select_branch_location(tree, location)[0]
3834
other_tree, other_path = WorkingTree.open_containing(location)
3835
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3836
if other_path != '':
3837
merger.interesting_files = [other_path]
3840
def _select_branch_location(self, tree, user_location, revision=None,
3842
"""Select a branch location, according to possible inputs.
3844
If provided, branches from ``revision`` are preferred. (Both
3845
``revision`` and ``index`` must be supplied.)
3847
Otherwise, the ``location`` parameter is used. If it is None, then the
3848
``submit`` or ``parent`` location is used, and a note is printed.
3850
:param tree: The working tree to select a branch for merging into
3851
:param location: The location entered by the user
3852
:param revision: The revision parameter to the command
3853
:param index: The index to use for the revision parameter. Negative
3854
indices are permitted.
3855
:return: (selected_location, user_location). The default location
3856
will be the user-entered location.
3858
if (revision is not None and index is not None
3859
and revision[index] is not None):
3860
branch = revision[index].get_branch()
3861
if branch is not None:
3862
return branch, branch
3863
if user_location is None:
3864
location = self._get_remembered(tree, 'Merging from')
3866
location = user_location
3867
return location, user_location
3869
def _get_remembered(self, tree, verb_string):
3870
"""Use tree.branch's parent if none was supplied.
3872
Report if the remembered location was used.
3874
stored_location = tree.branch.get_submit_branch()
3875
stored_location_type = "submit"
3876
if stored_location is None:
3877
stored_location = tree.branch.get_parent()
3878
stored_location_type = "parent"
3879
mutter("%s", stored_location)
3880
if stored_location is None:
3881
raise errors.BzrCommandError("No location specified or remembered")
3882
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3883
note(u"%s remembered %s location %s", verb_string,
3884
stored_location_type, display_url)
3885
return stored_location
3888
class cmd_remerge(Command):
3891
Use this if you want to try a different merge technique while resolving
3892
conflicts. Some merge techniques are better than others, and remerge
3893
lets you try different ones on different files.
3895
The options for remerge have the same meaning and defaults as the ones for
3896
merge. The difference is that remerge can (only) be run when there is a
3897
pending merge, and it lets you specify particular files.
3900
Re-do the merge of all conflicted files, and show the base text in
3901
conflict regions, in addition to the usual THIS and OTHER texts::
3903
bzr remerge --show-base
3905
Re-do the merge of "foobar", using the weave merge algorithm, with
3906
additional processing to reduce the size of conflict regions::
3908
bzr remerge --merge-type weave --reprocess foobar
3910
takes_args = ['file*']
3915
help="Show base revision text in conflicts."),
3918
def run(self, file_list=None, merge_type=None, show_base=False,
3920
if merge_type is None:
3921
merge_type = _mod_merge.Merge3Merger
3922
tree, file_list = tree_files(file_list)
3925
parents = tree.get_parent_ids()
3926
if len(parents) != 2:
3927
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3928
" merges. Not cherrypicking or"
3930
repository = tree.branch.repository
3931
interesting_ids = None
3933
conflicts = tree.conflicts()
3934
if file_list is not None:
3935
interesting_ids = set()
3936
for filename in file_list:
3937
file_id = tree.path2id(filename)
3939
raise errors.NotVersionedError(filename)
3940
interesting_ids.add(file_id)
3941
if tree.kind(file_id) != "directory":
3944
for name, ie in tree.inventory.iter_entries(file_id):
3945
interesting_ids.add(ie.file_id)
3946
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3948
# Remerge only supports resolving contents conflicts
3949
allowed_conflicts = ('text conflict', 'contents conflict')
3950
restore_files = [c.path for c in conflicts
3951
if c.typestring in allowed_conflicts]
3952
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3953
tree.set_conflicts(ConflictList(new_conflicts))
3954
if file_list is not None:
3955
restore_files = file_list
3956
for filename in restore_files:
3958
restore(tree.abspath(filename))
3959
except errors.NotConflicted:
3961
# Disable pending merges, because the file texts we are remerging
3962
# have not had those merges performed. If we use the wrong parents
3963
# list, we imply that the working tree text has seen and rejected
3964
# all the changes from the other tree, when in fact those changes
3965
# have not yet been seen.
3966
pb = ui.ui_factory.nested_progress_bar()
3967
tree.set_parent_ids(parents[:1])
3969
merger = _mod_merge.Merger.from_revision_ids(pb,
3971
merger.interesting_ids = interesting_ids
3972
merger.merge_type = merge_type
3973
merger.show_base = show_base
3974
merger.reprocess = reprocess
3975
conflicts = merger.do_merge()
3977
tree.set_parent_ids(parents)
3987
class cmd_revert(Command):
3988
"""Revert files to a previous revision.
3990
Giving a list of files will revert only those files. Otherwise, all files
3991
will be reverted. If the revision is not specified with '--revision', the
3992
last committed revision is used.
3994
To remove only some changes, without reverting to a prior version, use
3995
merge instead. For example, "merge . --revision -2..-3" will remove the
3996
changes introduced by -2, without affecting the changes introduced by -1.
3997
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3999
By default, any files that have been manually changed will be backed up
4000
first. (Files changed only by merge are not backed up.) Backup files have
4001
'.~#~' appended to their name, where # is a number.
4003
When you provide files, you can use their current pathname or the pathname
4004
from the target revision. So you can use revert to "undelete" a file by
4005
name. If you name a directory, all the contents of that directory will be
4008
Any files that have been newly added since that revision will be deleted,
4009
with a backup kept if appropriate. Directories containing unknown files
4010
will not be deleted.
4012
The working tree contains a list of pending merged revisions, which will
4013
be included as parents in the next commit. Normally, revert clears that
4014
list as well as reverting the files. If any files are specified, revert
4015
leaves the pending merge list alone and reverts only the files. Use "bzr
4016
revert ." in the tree root to revert all files but keep the merge record,
4017
and "bzr revert --forget-merges" to clear the pending merge list without
4018
reverting any files.
4021
_see_also = ['cat', 'export']
4024
Option('no-backup', "Do not save backups of reverted files."),
4025
Option('forget-merges',
4026
'Remove pending merge marker, without changing any files.'),
4028
takes_args = ['file*']
4030
def run(self, revision=None, no_backup=False, file_list=None,
4031
forget_merges=None):
4032
tree, file_list = tree_files(file_list)
4036
tree.set_parent_ids(tree.get_parent_ids()[:1])
4038
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4043
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4044
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4045
pb = ui.ui_factory.nested_progress_bar()
4047
tree.revert(file_list, rev_tree, not no_backup, pb,
4048
report_changes=True)
4053
class cmd_assert_fail(Command):
4054
"""Test reporting of assertion failures"""
4055
# intended just for use in testing
4060
raise AssertionError("always fails")
4063
class cmd_help(Command):
4064
"""Show help on a command or other topic.
4067
_see_also = ['topics']
4069
Option('long', 'Show help on all commands.'),
4071
takes_args = ['topic?']
4072
aliases = ['?', '--help', '-?', '-h']
4075
def run(self, topic=None, long=False):
4077
if topic is None and long:
4079
bzrlib.help.help(topic)
4082
class cmd_shell_complete(Command):
4083
"""Show appropriate completions for context.
4085
For a list of all available commands, say 'bzr shell-complete'.
4087
takes_args = ['context?']
4092
def run(self, context=None):
4093
import shellcomplete
4094
shellcomplete.shellcomplete(context)
4097
class cmd_missing(Command):
4098
"""Show unmerged/unpulled revisions between two branches.
4100
OTHER_BRANCH may be local or remote.
4102
To filter on a range of revisions, you can use the command -r begin..end
4103
-r revision requests a specific revision, -r ..end or -r begin.. are
4108
Determine the missing revisions between this and the branch at the
4109
remembered pull location::
4113
Determine the missing revisions between this and another branch::
4115
bzr missing http://server/branch
4117
Determine the missing revisions up to a specific revision on the other
4120
bzr missing -r ..-10
4122
Determine the missing revisions up to a specific revision on this
4125
bzr missing --my-revision ..-10
4128
_see_also = ['merge', 'pull']
4129
takes_args = ['other_branch?']
4131
Option('reverse', 'Reverse the order of revisions.'),
4133
'Display changes in the local branch only.'),
4134
Option('this' , 'Same as --mine-only.'),
4135
Option('theirs-only',
4136
'Display changes in the remote branch only.'),
4137
Option('other', 'Same as --theirs-only.'),
4141
custom_help('revision',
4142
help='Filter on other branch revisions (inclusive). '
4143
'See "help revisionspec" for details.'),
4144
Option('my-revision',
4145
type=_parse_revision_str,
4146
help='Filter on local branch revisions (inclusive). '
4147
'See "help revisionspec" for details.'),
4148
Option('include-merges',
4149
'Show all revisions in addition to the mainline ones.'),
4151
encoding_type = 'replace'
4154
def run(self, other_branch=None, reverse=False, mine_only=False,
4156
log_format=None, long=False, short=False, line=False,
4157
show_ids=False, verbose=False, this=False, other=False,
4158
include_merges=False, revision=None, my_revision=None):
4159
from bzrlib.missing import find_unmerged, iter_log_revisions
4168
# TODO: We should probably check that we don't have mine-only and
4169
# theirs-only set, but it gets complicated because we also have
4170
# this and other which could be used.
4177
local_branch = Branch.open_containing(u".")[0]
4178
parent = local_branch.get_parent()
4179
if other_branch is None:
4180
other_branch = parent
4181
if other_branch is None:
4182
raise errors.BzrCommandError("No peer location known"
4184
display_url = urlutils.unescape_for_display(parent,
4186
message("Using saved parent location: "
4187
+ display_url + "\n")
4189
remote_branch = Branch.open(other_branch)
4190
if remote_branch.base == local_branch.base:
4191
remote_branch = local_branch
4193
local_revid_range = _revision_range_to_revid_range(
4194
_get_revision_range(my_revision, local_branch,
4197
remote_revid_range = _revision_range_to_revid_range(
4198
_get_revision_range(revision,
4199
remote_branch, self.name()))
4201
local_branch.lock_read()
4203
remote_branch.lock_read()
4205
local_extra, remote_extra = find_unmerged(
4206
local_branch, remote_branch, restrict,
4207
backward=not reverse,
4208
include_merges=include_merges,
4209
local_revid_range=local_revid_range,
4210
remote_revid_range=remote_revid_range)
4212
if log_format is None:
4213
registry = log.log_formatter_registry
4214
log_format = registry.get_default(local_branch)
4215
lf = log_format(to_file=self.outf,
4217
show_timezone='original')
4220
if local_extra and not theirs_only:
4221
message("You have %d extra revision(s):\n" %
4223
for revision in iter_log_revisions(local_extra,
4224
local_branch.repository,
4226
lf.log_revision(revision)
4227
printed_local = True
4230
printed_local = False
4232
if remote_extra and not mine_only:
4233
if printed_local is True:
4235
message("You are missing %d revision(s):\n" %
4237
for revision in iter_log_revisions(remote_extra,
4238
remote_branch.repository,
4240
lf.log_revision(revision)
4243
if mine_only and not local_extra:
4244
# We checked local, and found nothing extra
4245
message('This branch is up to date.\n')
4246
elif theirs_only and not remote_extra:
4247
# We checked remote, and found nothing extra
4248
message('Other branch is up to date.\n')
4249
elif not (mine_only or theirs_only or local_extra or
4251
# We checked both branches, and neither one had extra
4253
message("Branches are up to date.\n")
4255
remote_branch.unlock()
4257
local_branch.unlock()
4258
if not status_code and parent is None and other_branch is not None:
4259
local_branch.lock_write()
4261
# handle race conditions - a parent might be set while we run.
4262
if local_branch.get_parent() is None:
4263
local_branch.set_parent(remote_branch.base)
4265
local_branch.unlock()
4269
class cmd_pack(Command):
4270
"""Compress the data within a repository."""
4272
_see_also = ['repositories']
4273
takes_args = ['branch_or_repo?']
4275
def run(self, branch_or_repo='.'):
4276
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4278
branch = dir.open_branch()
4279
repository = branch.repository
4280
except errors.NotBranchError:
4281
repository = dir.open_repository()
4285
class cmd_plugins(Command):
4286
"""List the installed plugins.
4288
This command displays the list of installed plugins including
4289
version of plugin and a short description of each.
4291
--verbose shows the path where each plugin is located.
4293
A plugin is an external component for Bazaar that extends the
4294
revision control system, by adding or replacing code in Bazaar.
4295
Plugins can do a variety of things, including overriding commands,
4296
adding new commands, providing additional network transports and
4297
customizing log output.
4299
See the Bazaar web site, http://bazaar-vcs.org, for further
4300
information on plugins including where to find them and how to
4301
install them. Instructions are also provided there on how to
4302
write new plugins using the Python programming language.
4304
takes_options = ['verbose']
4307
def run(self, verbose=False):
4308
import bzrlib.plugin
4309
from inspect import getdoc
4311
for name, plugin in bzrlib.plugin.plugins().items():
4312
version = plugin.__version__
4313
if version == 'unknown':
4315
name_ver = '%s %s' % (name, version)
4316
d = getdoc(plugin.module)
4318
doc = d.split('\n')[0]
4320
doc = '(no description)'
4321
result.append((name_ver, doc, plugin.path()))
4322
for name_ver, doc, path in sorted(result):
4330
class cmd_testament(Command):
4331
"""Show testament (signing-form) of a revision."""
4334
Option('long', help='Produce long-format testament.'),
4336
help='Produce a strict-format testament.')]
4337
takes_args = ['branch?']
4339
def run(self, branch=u'.', revision=None, long=False, strict=False):
4340
from bzrlib.testament import Testament, StrictTestament
4342
testament_class = StrictTestament
4344
testament_class = Testament
4346
b = Branch.open_containing(branch)[0]
4348
b = Branch.open(branch)
4351
if revision is None:
4352
rev_id = b.last_revision()
4354
rev_id = revision[0].as_revision_id(b)
4355
t = testament_class.from_revision(b.repository, rev_id)
4357
sys.stdout.writelines(t.as_text_lines())
4359
sys.stdout.write(t.as_short_text())
4364
class cmd_annotate(Command):
4365
"""Show the origin of each line in a file.
4367
This prints out the given file with an annotation on the left side
4368
indicating which revision, author and date introduced the change.
4370
If the origin is the same for a run of consecutive lines, it is
4371
shown only at the top, unless the --all option is given.
4373
# TODO: annotate directories; showing when each file was last changed
4374
# TODO: if the working copy is modified, show annotations on that
4375
# with new uncommitted lines marked
4376
aliases = ['ann', 'blame', 'praise']
4377
takes_args = ['filename']
4378
takes_options = [Option('all', help='Show annotations on all lines.'),
4379
Option('long', help='Show commit date in annotations.'),
4383
encoding_type = 'exact'
4386
def run(self, filename, all=False, long=False, revision=None,
4388
from bzrlib.annotate import annotate_file, annotate_file_tree
4389
wt, branch, relpath = \
4390
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4396
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4398
file_id = wt.path2id(relpath)
4400
file_id = tree.path2id(relpath)
4402
raise errors.NotVersionedError(filename)
4403
file_version = tree.inventory[file_id].revision
4404
if wt is not None and revision is None:
4405
# If there is a tree and we're not annotating historical
4406
# versions, annotate the working tree's content.
4407
annotate_file_tree(wt, file_id, self.outf, long, all,
4410
annotate_file(branch, file_version, file_id, long, all, self.outf,
4419
class cmd_re_sign(Command):
4420
"""Create a digital signature for an existing revision."""
4421
# TODO be able to replace existing ones.
4423
hidden = True # is this right ?
4424
takes_args = ['revision_id*']
4425
takes_options = ['revision']
4427
def run(self, revision_id_list=None, revision=None):
4428
if revision_id_list is not None and revision is not None:
4429
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4430
if revision_id_list is None and revision is None:
4431
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4432
b = WorkingTree.open_containing(u'.')[0].branch
4435
return self._run(b, revision_id_list, revision)
4439
def _run(self, b, revision_id_list, revision):
4440
import bzrlib.gpg as gpg
4441
gpg_strategy = gpg.GPGStrategy(b.get_config())
4442
if revision_id_list is not None:
4443
b.repository.start_write_group()
4445
for revision_id in revision_id_list:
4446
b.repository.sign_revision(revision_id, gpg_strategy)
4448
b.repository.abort_write_group()
4451
b.repository.commit_write_group()
4452
elif revision is not None:
4453
if len(revision) == 1:
4454
revno, rev_id = revision[0].in_history(b)
4455
b.repository.start_write_group()
4457
b.repository.sign_revision(rev_id, gpg_strategy)
4459
b.repository.abort_write_group()
4462
b.repository.commit_write_group()
4463
elif len(revision) == 2:
4464
# are they both on rh- if so we can walk between them
4465
# might be nice to have a range helper for arbitrary
4466
# revision paths. hmm.
4467
from_revno, from_revid = revision[0].in_history(b)
4468
to_revno, to_revid = revision[1].in_history(b)
4469
if to_revid is None:
4470
to_revno = b.revno()
4471
if from_revno is None or to_revno is None:
4472
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4473
b.repository.start_write_group()
4475
for revno in range(from_revno, to_revno + 1):
4476
b.repository.sign_revision(b.get_rev_id(revno),
4479
b.repository.abort_write_group()
4482
b.repository.commit_write_group()
4484
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4487
class cmd_bind(Command):
4488
"""Convert the current branch into a checkout of the supplied branch.
4490
Once converted into a checkout, commits must succeed on the master branch
4491
before they will be applied to the local branch.
4493
Bound branches use the nickname of its master branch unless it is set
4494
locally, in which case binding will update the the local nickname to be
4498
_see_also = ['checkouts', 'unbind']
4499
takes_args = ['location?']
4502
def run(self, location=None):
4503
b, relpath = Branch.open_containing(u'.')
4504
if location is None:
4506
location = b.get_old_bound_location()
4507
except errors.UpgradeRequired:
4508
raise errors.BzrCommandError('No location supplied. '
4509
'This format does not remember old locations.')
4511
if location is None:
4512
raise errors.BzrCommandError('No location supplied and no '
4513
'previous location known')
4514
b_other = Branch.open(location)
4517
except errors.DivergedBranches:
4518
raise errors.BzrCommandError('These branches have diverged.'
4519
' Try merging, and then bind again.')
4520
if b.get_config().has_explicit_nickname():
4521
b.nick = b_other.nick
4524
class cmd_unbind(Command):
4525
"""Convert the current checkout into a regular branch.
4527
After unbinding, the local branch is considered independent and subsequent
4528
commits will be local only.
4531
_see_also = ['checkouts', 'bind']
4536
b, relpath = Branch.open_containing(u'.')
4538
raise errors.BzrCommandError('Local branch is not bound')
4541
class cmd_uncommit(Command):
4542
"""Remove the last committed revision.
4544
--verbose will print out what is being removed.
4545
--dry-run will go through all the motions, but not actually
4548
If --revision is specified, uncommit revisions to leave the branch at the
4549
specified revision. For example, "bzr uncommit -r 15" will leave the
4550
branch at revision 15.
4552
Uncommit leaves the working tree ready for a new commit. The only change
4553
it may make is to restore any pending merges that were present before
4557
# TODO: jam 20060108 Add an option to allow uncommit to remove
4558
# unreferenced information in 'branch-as-repository' branches.
4559
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4560
# information in shared branches as well.
4561
_see_also = ['commit']
4562
takes_options = ['verbose', 'revision',
4563
Option('dry-run', help='Don\'t actually make changes.'),
4564
Option('force', help='Say yes to all questions.'),
4566
help="Only remove the commits from the local branch"
4567
" when in a checkout."
4570
takes_args = ['location?']
4572
encoding_type = 'replace'
4574
def run(self, location=None,
4575
dry_run=False, verbose=False,
4576
revision=None, force=False, local=False):
4577
if location is None:
4579
control, relpath = bzrdir.BzrDir.open_containing(location)
4581
tree = control.open_workingtree()
4583
except (errors.NoWorkingTree, errors.NotLocalUrl):
4585
b = control.open_branch()
4587
if tree is not None:
4592
return self._run(b, tree, dry_run, verbose, revision, force,
4595
if tree is not None:
4600
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4601
from bzrlib.log import log_formatter, show_log
4602
from bzrlib.uncommit import uncommit
4604
last_revno, last_rev_id = b.last_revision_info()
4607
if revision is None:
4609
rev_id = last_rev_id
4611
# 'bzr uncommit -r 10' actually means uncommit
4612
# so that the final tree is at revno 10.
4613
# but bzrlib.uncommit.uncommit() actually uncommits
4614
# the revisions that are supplied.
4615
# So we need to offset it by one
4616
revno = revision[0].in_history(b).revno + 1
4617
if revno <= last_revno:
4618
rev_id = b.get_rev_id(revno)
4620
if rev_id is None or _mod_revision.is_null(rev_id):
4621
self.outf.write('No revisions to uncommit.\n')
4624
lf = log_formatter('short',
4626
show_timezone='original')
4631
direction='forward',
4632
start_revision=revno,
4633
end_revision=last_revno)
4636
print 'Dry-run, pretending to remove the above revisions.'
4638
val = raw_input('Press <enter> to continue')
4640
print 'The above revision(s) will be removed.'
4642
val = raw_input('Are you sure [y/N]? ')
4643
if val.lower() not in ('y', 'yes'):
4647
mutter('Uncommitting from {%s} to {%s}',
4648
last_rev_id, rev_id)
4649
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4650
revno=revno, local=local)
4651
note('You can restore the old tip by running:\n'
4652
' bzr pull . -r revid:%s', last_rev_id)
4655
class cmd_break_lock(Command):
4656
"""Break a dead lock on a repository, branch or working directory.
4658
CAUTION: Locks should only be broken when you are sure that the process
4659
holding the lock has been stopped.
4661
You can get information on what locks are open via the 'bzr info' command.
4666
takes_args = ['location?']
4668
def run(self, location=None, show=False):
4669
if location is None:
4671
control, relpath = bzrdir.BzrDir.open_containing(location)
4673
control.break_lock()
4674
except NotImplementedError:
4678
class cmd_wait_until_signalled(Command):
4679
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4681
This just prints a line to signal when it is ready, then blocks on stdin.
4687
sys.stdout.write("running\n")
4689
sys.stdin.readline()
4692
class cmd_serve(Command):
4693
"""Run the bzr server."""
4695
aliases = ['server']
4699
help='Serve on stdin/out for use from inetd or sshd.'),
4700
RegistryOption('protocol',
4701
help="Protocol to serve.",
4702
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4703
value_switches=True),
4705
help='Listen for connections on nominated port of the form '
4706
'[hostname:]portnumber. Passing 0 as the port number will '
4707
'result in a dynamically allocated port. The default port '
4708
'depends on the protocol.',
4711
help='Serve contents of this directory.',
4713
Option('allow-writes',
4714
help='By default the server is a readonly server. Supplying '
4715
'--allow-writes enables write access to the contents of '
4716
'the served directory and below.'
4720
def get_host_and_port(self, port):
4721
"""Return the host and port to run the smart server on.
4723
If 'port' is None, None will be returned for the host and port.
4725
If 'port' has a colon in it, the string before the colon will be
4726
interpreted as the host.
4728
:param port: A string of the port to run the server on.
4729
:return: A tuple of (host, port), where 'host' is a host name or IP,
4730
and port is an integer TCP/IP port.
4733
if port is not None:
4735
host, port = port.split(':')
4739
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4741
from bzrlib.transport import get_transport, transport_server_registry
4742
if directory is None:
4743
directory = os.getcwd()
4744
if protocol is None:
4745
protocol = transport_server_registry.get()
4746
host, port = self.get_host_and_port(port)
4747
url = urlutils.local_path_to_url(directory)
4748
if not allow_writes:
4749
url = 'readonly+' + url
4750
transport = get_transport(url)
4751
protocol(transport, host, port, inet)
4754
class cmd_join(Command):
4755
"""Combine a tree into its containing tree.
4757
This command requires the target tree to be in a rich-root format.
4759
The TREE argument should be an independent tree, inside another tree, but
4760
not part of it. (Such trees can be produced by "bzr split", but also by
4761
running "bzr branch" with the target inside a tree.)
4763
The result is a combined tree, with the subtree no longer an independant
4764
part. This is marked as a merge of the subtree into the containing tree,
4765
and all history is preserved.
4768
_see_also = ['split']
4769
takes_args = ['tree']
4771
Option('reference', help='Join by reference.', hidden=True),
4774
def run(self, tree, reference=False):
4775
sub_tree = WorkingTree.open(tree)
4776
parent_dir = osutils.dirname(sub_tree.basedir)
4777
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4778
repo = containing_tree.branch.repository
4779
if not repo.supports_rich_root():
4780
raise errors.BzrCommandError(
4781
"Can't join trees because %s doesn't support rich root data.\n"
4782
"You can use bzr upgrade on the repository."
4786
containing_tree.add_reference(sub_tree)
4787
except errors.BadReferenceTarget, e:
4788
# XXX: Would be better to just raise a nicely printable
4789
# exception from the real origin. Also below. mbp 20070306
4790
raise errors.BzrCommandError("Cannot join %s. %s" %
4794
containing_tree.subsume(sub_tree)
4795
except errors.BadSubsumeSource, e:
4796
raise errors.BzrCommandError("Cannot join %s. %s" %
4800
class cmd_split(Command):
4801
"""Split a subdirectory of a tree into a separate tree.
4803
This command will produce a target tree in a format that supports
4804
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4805
converted into earlier formats like 'dirstate-tags'.
4807
The TREE argument should be a subdirectory of a working tree. That
4808
subdirectory will be converted into an independent tree, with its own
4809
branch. Commits in the top-level tree will not apply to the new subtree.
4812
_see_also = ['join']
4813
takes_args = ['tree']
4815
def run(self, tree):
4816
containing_tree, subdir = WorkingTree.open_containing(tree)
4817
sub_id = containing_tree.path2id(subdir)
4819
raise errors.NotVersionedError(subdir)
4821
containing_tree.extract(sub_id)
4822
except errors.RootNotRich:
4823
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4826
class cmd_merge_directive(Command):
4827
"""Generate a merge directive for auto-merge tools.
4829
A directive requests a merge to be performed, and also provides all the
4830
information necessary to do so. This means it must either include a
4831
revision bundle, or the location of a branch containing the desired
4834
A submit branch (the location to merge into) must be supplied the first
4835
time the command is issued. After it has been supplied once, it will
4836
be remembered as the default.
4838
A public branch is optional if a revision bundle is supplied, but required
4839
if --diff or --plain is specified. It will be remembered as the default
4840
after the first use.
4843
takes_args = ['submit_branch?', 'public_branch?']
4847
_see_also = ['send']
4850
RegistryOption.from_kwargs('patch-type',
4851
'The type of patch to include in the directive.',
4853
value_switches=True,
4855
bundle='Bazaar revision bundle (default).',
4856
diff='Normal unified diff.',
4857
plain='No patch, just directive.'),
4858
Option('sign', help='GPG-sign the directive.'), 'revision',
4859
Option('mail-to', type=str,
4860
help='Instead of printing the directive, email to this address.'),
4861
Option('message', type=str, short_name='m',
4862
help='Message to use when committing this merge.')
4865
encoding_type = 'exact'
4867
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4868
sign=False, revision=None, mail_to=None, message=None):
4869
from bzrlib.revision import ensure_null, NULL_REVISION
4870
include_patch, include_bundle = {
4871
'plain': (False, False),
4872
'diff': (True, False),
4873
'bundle': (True, True),
4875
branch = Branch.open('.')
4876
stored_submit_branch = branch.get_submit_branch()
4877
if submit_branch is None:
4878
submit_branch = stored_submit_branch
4880
if stored_submit_branch is None:
4881
branch.set_submit_branch(submit_branch)
4882
if submit_branch is None:
4883
submit_branch = branch.get_parent()
4884
if submit_branch is None:
4885
raise errors.BzrCommandError('No submit branch specified or known')
4887
stored_public_branch = branch.get_public_branch()
4888
if public_branch is None:
4889
public_branch = stored_public_branch
4890
elif stored_public_branch is None:
4891
branch.set_public_branch(public_branch)
4892
if not include_bundle and public_branch is None:
4893
raise errors.BzrCommandError('No public branch specified or'
4895
base_revision_id = None
4896
if revision is not None:
4897
if len(revision) > 2:
4898
raise errors.BzrCommandError('bzr merge-directive takes '
4899
'at most two one revision identifiers')
4900
revision_id = revision[-1].as_revision_id(branch)
4901
if len(revision) == 2:
4902
base_revision_id = revision[0].as_revision_id(branch)
4904
revision_id = branch.last_revision()
4905
revision_id = ensure_null(revision_id)
4906
if revision_id == NULL_REVISION:
4907
raise errors.BzrCommandError('No revisions to bundle.')
4908
directive = merge_directive.MergeDirective2.from_objects(
4909
branch.repository, revision_id, time.time(),
4910
osutils.local_time_offset(), submit_branch,
4911
public_branch=public_branch, include_patch=include_patch,
4912
include_bundle=include_bundle, message=message,
4913
base_revision_id=base_revision_id)
4916
self.outf.write(directive.to_signed(branch))
4918
self.outf.writelines(directive.to_lines())
4920
message = directive.to_email(mail_to, branch, sign)
4921
s = SMTPConnection(branch.get_config())
4922
s.send_email(message)
4925
class cmd_send(Command):
4926
"""Mail or create a merge-directive for submitting changes.
4928
A merge directive provides many things needed for requesting merges:
4930
* A machine-readable description of the merge to perform
4932
* An optional patch that is a preview of the changes requested
4934
* An optional bundle of revision data, so that the changes can be applied
4935
directly from the merge directive, without retrieving data from a
4938
If --no-bundle is specified, then public_branch is needed (and must be
4939
up-to-date), so that the receiver can perform the merge using the
4940
public_branch. The public_branch is always included if known, so that
4941
people can check it later.
4943
The submit branch defaults to the parent, but can be overridden. Both
4944
submit branch and public branch will be remembered if supplied.
4946
If a public_branch is known for the submit_branch, that public submit
4947
branch is used in the merge instructions. This means that a local mirror
4948
can be used as your actual submit branch, once you have set public_branch
4951
Mail is sent using your preferred mail program. This should be transparent
4952
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4953
If the preferred client can't be found (or used), your editor will be used.
4955
To use a specific mail program, set the mail_client configuration option.
4956
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4957
specific clients are "claws", "evolution", "kmail", "mutt", and
4958
"thunderbird"; generic options are "default", "editor", "emacsclient",
4959
"mapi", and "xdg-email". Plugins may also add supported clients.
4961
If mail is being sent, a to address is required. This can be supplied
4962
either on the commandline, by setting the submit_to configuration
4963
option in the branch itself or the child_submit_to configuration option
4964
in the submit branch.
4966
Two formats are currently supported: "4" uses revision bundle format 4 and
4967
merge directive format 2. It is significantly faster and smaller than
4968
older formats. It is compatible with Bazaar 0.19 and later. It is the
4969
default. "0.9" uses revision bundle format 0.9 and merge directive
4970
format 1. It is compatible with Bazaar 0.12 - 0.18.
4972
The merge directives created by bzr send may be applied using bzr merge or
4973
bzr pull by specifying a file containing a merge directive as the location.
4976
encoding_type = 'exact'
4978
_see_also = ['merge', 'pull']
4980
takes_args = ['submit_branch?', 'public_branch?']
4984
help='Do not include a bundle in the merge directive.'),
4985
Option('no-patch', help='Do not include a preview patch in the merge'
4988
help='Remember submit and public branch.'),
4990
help='Branch to generate the submission from, '
4991
'rather than the one containing the working directory.',
4994
Option('output', short_name='o',
4995
help='Write merge directive to this file; '
4996
'use - for stdout.',
4999
help='Refuse to send if there are uncommitted changes in'
5000
' the working tree, --no-strict disables the check.'),
5001
Option('mail-to', help='Mail the request to this address.',
5005
Option('body', help='Body for the email.', type=unicode),
5006
RegistryOption('format',
5007
help='Use the specified output format.',
5008
lazy_registry=('bzrlib.send', 'format_registry')),
5011
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5012
no_patch=False, revision=None, remember=False, output=None,
5013
format=None, mail_to=None, message=None, body=None,
5014
strict=None, **kwargs):
5015
from bzrlib.send import send
5016
return send(submit_branch, revision, public_branch, remember,
5017
format, no_bundle, no_patch, output,
5018
kwargs.get('from', '.'), mail_to, message, body,
5023
class cmd_bundle_revisions(cmd_send):
5024
"""Create a merge-directive for submitting changes.
5026
A merge directive provides many things needed for requesting merges:
5028
* A machine-readable description of the merge to perform
5030
* An optional patch that is a preview of the changes requested
5032
* An optional bundle of revision data, so that the changes can be applied
5033
directly from the merge directive, without retrieving data from a
5036
If --no-bundle is specified, then public_branch is needed (and must be
5037
up-to-date), so that the receiver can perform the merge using the
5038
public_branch. The public_branch is always included if known, so that
5039
people can check it later.
5041
The submit branch defaults to the parent, but can be overridden. Both
5042
submit branch and public branch will be remembered if supplied.
5044
If a public_branch is known for the submit_branch, that public submit
5045
branch is used in the merge instructions. This means that a local mirror
5046
can be used as your actual submit branch, once you have set public_branch
5049
Two formats are currently supported: "4" uses revision bundle format 4 and
5050
merge directive format 2. It is significantly faster and smaller than
5051
older formats. It is compatible with Bazaar 0.19 and later. It is the
5052
default. "0.9" uses revision bundle format 0.9 and merge directive
5053
format 1. It is compatible with Bazaar 0.12 - 0.18.
5058
help='Do not include a bundle in the merge directive.'),
5059
Option('no-patch', help='Do not include a preview patch in the merge'
5062
help='Remember submit and public branch.'),
5064
help='Branch to generate the submission from, '
5065
'rather than the one containing the working directory.',
5068
Option('output', short_name='o', help='Write directive to this file.',
5071
help='Refuse to bundle revisions if there are uncommitted'
5072
' changes in the working tree, --no-strict disables the check.'),
5074
RegistryOption('format',
5075
help='Use the specified output format.',
5076
lazy_registry=('bzrlib.send', 'format_registry')),
5078
aliases = ['bundle']
5080
_see_also = ['send', 'merge']
5084
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5085
no_patch=False, revision=None, remember=False, output=None,
5086
format=None, strict=None, **kwargs):
5089
from bzrlib.send import send
5090
return send(submit_branch, revision, public_branch, remember,
5091
format, no_bundle, no_patch, output,
5092
kwargs.get('from', '.'), None, None, None,
5093
self.outf, strict=strict)
5096
class cmd_tag(Command):
5097
"""Create, remove or modify a tag naming a revision.
5099
Tags give human-meaningful names to revisions. Commands that take a -r
5100
(--revision) option can be given -rtag:X, where X is any previously
5103
Tags are stored in the branch. Tags are copied from one branch to another
5104
along when you branch, push, pull or merge.
5106
It is an error to give a tag name that already exists unless you pass
5107
--force, in which case the tag is moved to point to the new revision.
5109
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5110
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5113
_see_also = ['commit', 'tags']
5114
takes_args = ['tag_name']
5117
help='Delete this tag rather than placing it.',
5120
help='Branch in which to place the tag.',
5125
help='Replace existing tags.',
5130
def run(self, tag_name,
5136
branch, relpath = Branch.open_containing(directory)
5140
branch.tags.delete_tag(tag_name)
5141
self.outf.write('Deleted tag %s.\n' % tag_name)
5144
if len(revision) != 1:
5145
raise errors.BzrCommandError(
5146
"Tags can only be placed on a single revision, "
5148
revision_id = revision[0].as_revision_id(branch)
5150
revision_id = branch.last_revision()
5151
if (not force) and branch.tags.has_tag(tag_name):
5152
raise errors.TagAlreadyExists(tag_name)
5153
branch.tags.set_tag(tag_name, revision_id)
5154
self.outf.write('Created tag %s.\n' % tag_name)
5159
class cmd_tags(Command):
5162
This command shows a table of tag names and the revisions they reference.
5168
help='Branch whose tags should be displayed.',
5172
RegistryOption.from_kwargs('sort',
5173
'Sort tags by different criteria.', title='Sorting',
5174
alpha='Sort tags lexicographically (default).',
5175
time='Sort tags chronologically.',
5188
branch, relpath = Branch.open_containing(directory)
5190
tags = branch.tags.get_tag_dict().items()
5197
graph = branch.repository.get_graph()
5198
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5199
revid1, revid2 = rev1.rev_id, rev2.rev_id
5200
# only show revisions between revid1 and revid2 (inclusive)
5201
tags = [(tag, revid) for tag, revid in tags if
5202
graph.is_between(revid, revid1, revid2)]
5205
elif sort == 'time':
5207
for tag, revid in tags:
5209
revobj = branch.repository.get_revision(revid)
5210
except errors.NoSuchRevision:
5211
timestamp = sys.maxint # place them at the end
5213
timestamp = revobj.timestamp
5214
timestamps[revid] = timestamp
5215
tags.sort(key=lambda x: timestamps[x[1]])
5217
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5218
for index, (tag, revid) in enumerate(tags):
5220
revno = branch.revision_id_to_dotted_revno(revid)
5221
if isinstance(revno, tuple):
5222
revno = '.'.join(map(str, revno))
5223
except errors.NoSuchRevision:
5224
# Bad tag data/merges can lead to tagged revisions
5225
# which are not in this branch. Fail gracefully ...
5227
tags[index] = (tag, revno)
5230
for tag, revspec in tags:
5231
self.outf.write('%-20s %s\n' % (tag, revspec))
5234
class cmd_reconfigure(Command):
5235
"""Reconfigure the type of a bzr directory.
5237
A target configuration must be specified.
5239
For checkouts, the bind-to location will be auto-detected if not specified.
5240
The order of preference is
5241
1. For a lightweight checkout, the current bound location.
5242
2. For branches that used to be checkouts, the previously-bound location.
5243
3. The push location.
5244
4. The parent location.
5245
If none of these is available, --bind-to must be specified.
5248
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5249
takes_args = ['location?']
5251
RegistryOption.from_kwargs(
5253
title='Target type',
5254
help='The type to reconfigure the directory to.',
5255
value_switches=True, enum_switch=False,
5256
branch='Reconfigure to be an unbound branch with no working tree.',
5257
tree='Reconfigure to be an unbound branch with a working tree.',
5258
checkout='Reconfigure to be a bound branch with a working tree.',
5259
lightweight_checkout='Reconfigure to be a lightweight'
5260
' checkout (with no local history).',
5261
standalone='Reconfigure to be a standalone branch '
5262
'(i.e. stop using shared repository).',
5263
use_shared='Reconfigure to use a shared repository.',
5264
with_trees='Reconfigure repository to create '
5265
'working trees on branches by default.',
5266
with_no_trees='Reconfigure repository to not create '
5267
'working trees on branches by default.'
5269
Option('bind-to', help='Branch to bind checkout to.', type=str),
5271
help='Perform reconfiguration even if local changes'
5275
def run(self, location=None, target_type=None, bind_to=None, force=False):
5276
directory = bzrdir.BzrDir.open(location)
5277
if target_type is None:
5278
raise errors.BzrCommandError('No target configuration specified')
5279
elif target_type == 'branch':
5280
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5281
elif target_type == 'tree':
5282
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5283
elif target_type == 'checkout':
5284
reconfiguration = reconfigure.Reconfigure.to_checkout(
5286
elif target_type == 'lightweight-checkout':
5287
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5289
elif target_type == 'use-shared':
5290
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5291
elif target_type == 'standalone':
5292
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5293
elif target_type == 'with-trees':
5294
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5296
elif target_type == 'with-no-trees':
5297
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5299
reconfiguration.apply(force)
5302
class cmd_switch(Command):
5303
"""Set the branch of a checkout and update.
5305
For lightweight checkouts, this changes the branch being referenced.
5306
For heavyweight checkouts, this checks that there are no local commits
5307
versus the current bound branch, then it makes the local branch a mirror
5308
of the new location and binds to it.
5310
In both cases, the working tree is updated and uncommitted changes
5311
are merged. The user can commit or revert these as they desire.
5313
Pending merges need to be committed or reverted before using switch.
5315
The path to the branch to switch to can be specified relative to the parent
5316
directory of the current branch. For example, if you are currently in a
5317
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5320
Bound branches use the nickname of its master branch unless it is set
5321
locally, in which case switching will update the the local nickname to be
5325
takes_args = ['to_location']
5326
takes_options = [Option('force',
5327
help='Switch even if local commits will be lost.'),
5328
Option('create-branch', short_name='b',
5329
help='Create the target branch from this one before'
5330
' switching to it.'),
5333
def run(self, to_location, force=False, create_branch=False):
5334
from bzrlib import switch
5336
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5338
branch = control_dir.open_branch()
5339
had_explicit_nick = branch.get_config().has_explicit_nickname()
5340
except errors.NotBranchError:
5342
had_explicit_nick = False
5345
raise errors.BzrCommandError('cannot create branch without'
5347
if '/' not in to_location and '\\' not in to_location:
5348
# This path is meant to be relative to the existing branch
5349
this_url = self._get_branch_location(control_dir)
5350
to_location = urlutils.join(this_url, '..', to_location)
5351
to_branch = branch.bzrdir.sprout(to_location,
5352
possible_transports=[branch.bzrdir.root_transport],
5353
source_branch=branch).open_branch()
5355
# from_branch = control_dir.open_branch()
5356
# except errors.NotBranchError:
5357
# raise BzrCommandError('Cannot create a branch from this'
5358
# ' location when we cannot open this branch')
5359
# from_branch.bzrdir.sprout(
5363
to_branch = Branch.open(to_location)
5364
except errors.NotBranchError:
5365
this_url = self._get_branch_location(control_dir)
5366
to_branch = Branch.open(
5367
urlutils.join(this_url, '..', to_location))
5368
switch.switch(control_dir, to_branch, force)
5369
if had_explicit_nick:
5370
branch = control_dir.open_branch() #get the new branch!
5371
branch.nick = to_branch.nick
5372
note('Switched to branch: %s',
5373
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5375
def _get_branch_location(self, control_dir):
5376
"""Return location of branch for this control dir."""
5378
this_branch = control_dir.open_branch()
5379
# This may be a heavy checkout, where we want the master branch
5380
master_location = this_branch.get_bound_location()
5381
if master_location is not None:
5382
return master_location
5383
# If not, use a local sibling
5384
return this_branch.base
5385
except errors.NotBranchError:
5386
format = control_dir.find_branch_format()
5387
if getattr(format, 'get_reference', None) is not None:
5388
return format.get_reference(control_dir)
5390
return control_dir.root_transport.base
5393
class cmd_view(Command):
5394
"""Manage filtered views.
5396
Views provide a mask over the tree so that users can focus on
5397
a subset of a tree when doing their work. After creating a view,
5398
commands that support a list of files - status, diff, commit, etc -
5399
effectively have that list of files implicitly given each time.
5400
An explicit list of files can still be given but those files
5401
must be within the current view.
5403
In most cases, a view has a short life-span: it is created to make
5404
a selected change and is deleted once that change is committed.
5405
At other times, you may wish to create one or more named views
5406
and switch between them.
5408
To disable the current view without deleting it, you can switch to
5409
the pseudo view called ``off``. This can be useful when you need
5410
to see the whole tree for an operation or two (e.g. merge) but
5411
want to switch back to your view after that.
5414
To define the current view::
5416
bzr view file1 dir1 ...
5418
To list the current view::
5422
To delete the current view::
5426
To disable the current view without deleting it::
5428
bzr view --switch off
5430
To define a named view and switch to it::
5432
bzr view --name view-name file1 dir1 ...
5434
To list a named view::
5436
bzr view --name view-name
5438
To delete a named view::
5440
bzr view --name view-name --delete
5442
To switch to a named view::
5444
bzr view --switch view-name
5446
To list all views defined::
5450
To delete all views::
5452
bzr view --delete --all
5456
takes_args = ['file*']
5459
help='Apply list or delete action to all views.',
5462
help='Delete the view.',
5465
help='Name of the view to define, list or delete.',
5469
help='Name of the view to switch to.',
5474
def run(self, file_list,
5480
tree, file_list = tree_files(file_list, apply_view=False)
5481
current_view, view_dict = tree.views.get_view_info()
5486
raise errors.BzrCommandError(
5487
"Both --delete and a file list specified")
5489
raise errors.BzrCommandError(
5490
"Both --delete and --switch specified")
5492
tree.views.set_view_info(None, {})
5493
self.outf.write("Deleted all views.\n")
5495
raise errors.BzrCommandError("No current view to delete")
5497
tree.views.delete_view(name)
5498
self.outf.write("Deleted '%s' view.\n" % name)
5501
raise errors.BzrCommandError(
5502
"Both --switch and a file list specified")
5504
raise errors.BzrCommandError(
5505
"Both --switch and --all specified")
5506
elif switch == 'off':
5507
if current_view is None:
5508
raise errors.BzrCommandError("No current view to disable")
5509
tree.views.set_view_info(None, view_dict)
5510
self.outf.write("Disabled '%s' view.\n" % (current_view))
5512
tree.views.set_view_info(switch, view_dict)
5513
view_str = views.view_display_str(tree.views.lookup_view())
5514
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5517
self.outf.write('Views defined:\n')
5518
for view in sorted(view_dict):
5519
if view == current_view:
5523
view_str = views.view_display_str(view_dict[view])
5524
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5526
self.outf.write('No views defined.\n')
5529
# No name given and no current view set
5532
raise errors.BzrCommandError(
5533
"Cannot change the 'off' pseudo view")
5534
tree.views.set_view(name, sorted(file_list))
5535
view_str = views.view_display_str(tree.views.lookup_view())
5536
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5540
# No name given and no current view set
5541
self.outf.write('No current view.\n')
5543
view_str = views.view_display_str(tree.views.lookup_view(name))
5544
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5547
class cmd_hooks(Command):
5553
for hook_key in sorted(hooks.known_hooks.keys()):
5554
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5555
self.outf.write("%s:\n" % type(some_hooks).__name__)
5556
for hook_name, hook_point in sorted(some_hooks.items()):
5557
self.outf.write(" %s:\n" % (hook_name,))
5558
found_hooks = list(hook_point)
5560
for hook in found_hooks:
5561
self.outf.write(" %s\n" %
5562
(some_hooks.get_hook_name(hook),))
5564
self.outf.write(" <no hooks installed>\n")
5567
class cmd_shelve(Command):
5568
"""Temporarily set aside some changes from the current tree.
5570
Shelve allows you to temporarily put changes you've made "on the shelf",
5571
ie. out of the way, until a later time when you can bring them back from
5572
the shelf with the 'unshelve' command. The changes are stored alongside
5573
your working tree, and so they aren't propagated along with your branch nor
5574
will they survive its deletion.
5576
If shelve --list is specified, previously-shelved changes are listed.
5578
Shelve is intended to help separate several sets of changes that have
5579
been inappropriately mingled. If you just want to get rid of all changes
5580
and you don't need to restore them later, use revert. If you want to
5581
shelve all text changes at once, use shelve --all.
5583
If filenames are specified, only the changes to those files will be
5584
shelved. Other files will be left untouched.
5586
If a revision is specified, changes since that revision will be shelved.
5588
You can put multiple items on the shelf, and by default, 'unshelve' will
5589
restore the most recently shelved changes.
5592
takes_args = ['file*']
5596
Option('all', help='Shelve all changes.'),
5598
RegistryOption('writer', 'Method to use for writing diffs.',
5599
bzrlib.option.diff_writer_registry,
5600
value_switches=True, enum_switch=False),
5602
Option('list', help='List shelved changes.'),
5604
help='Destroy removed changes instead of shelving them.'),
5606
_see_also = ['unshelve']
5608
def run(self, revision=None, all=False, file_list=None, message=None,
5609
writer=None, list=False, destroy=False):
5611
return self.run_for_list()
5612
from bzrlib.shelf_ui import Shelver
5614
writer = bzrlib.option.diff_writer_registry.get()
5616
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5617
message, destroy=destroy).run()
5618
except errors.UserAbort:
5621
def run_for_list(self):
5622
tree = WorkingTree.open_containing('.')[0]
5625
manager = tree.get_shelf_manager()
5626
shelves = manager.active_shelves()
5627
if len(shelves) == 0:
5628
note('No shelved changes.')
5630
for shelf_id in reversed(shelves):
5631
message = manager.get_metadata(shelf_id).get('message')
5633
message = '<no message>'
5634
self.outf.write('%3d: %s\n' % (shelf_id, message))
5640
class cmd_unshelve(Command):
5641
"""Restore shelved changes.
5643
By default, the most recently shelved changes are restored. However if you
5644
specify a shelf by id those changes will be restored instead. This works
5645
best when the changes don't depend on each other.
5648
takes_args = ['shelf_id?']
5650
RegistryOption.from_kwargs(
5651
'action', help="The action to perform.",
5652
enum_switch=False, value_switches=True,
5653
apply="Apply changes and remove from the shelf.",
5654
dry_run="Show changes, but do not apply or remove them.",
5655
delete_only="Delete changes without applying them."
5658
_see_also = ['shelve']
5660
def run(self, shelf_id=None, action='apply'):
5661
from bzrlib.shelf_ui import Unshelver
5662
Unshelver.from_args(shelf_id, action).run()
5665
class cmd_clean_tree(Command):
5666
"""Remove unwanted files from working tree.
5668
By default, only unknown files, not ignored files, are deleted. Versioned
5669
files are never deleted.
5671
Another class is 'detritus', which includes files emitted by bzr during
5672
normal operations and selftests. (The value of these files decreases with
5675
If no options are specified, unknown files are deleted. Otherwise, option
5676
flags are respected, and may be combined.
5678
To check what clean-tree will do, use --dry-run.
5680
takes_options = [Option('ignored', help='Delete all ignored files.'),
5681
Option('detritus', help='Delete conflict files, merge'
5682
' backups, and failed selftest dirs.'),
5684
help='Delete files unknown to bzr (default).'),
5685
Option('dry-run', help='Show files to delete instead of'
5687
Option('force', help='Do not prompt before deleting.')]
5688
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5690
from bzrlib.clean_tree import clean_tree
5691
if not (unknown or ignored or detritus):
5695
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5696
dry_run=dry_run, no_prompt=force)
5699
class cmd_reference(Command):
5700
"""list, view and set branch locations for nested trees.
5702
If no arguments are provided, lists the branch locations for nested trees.
5703
If one argument is provided, display the branch location for that tree.
5704
If two arguments are provided, set the branch location for that tree.
5709
takes_args = ['path?', 'location?']
5711
def run(self, path=None, location=None):
5713
if path is not None:
5715
tree, branch, relpath =(
5716
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5717
if path is not None:
5720
tree = branch.basis_tree()
5722
info = branch._get_all_reference_info().iteritems()
5723
self._display_reference_info(tree, branch, info)
5725
file_id = tree.path2id(path)
5727
raise errors.NotVersionedError(path)
5728
if location is None:
5729
info = [(file_id, branch.get_reference_info(file_id))]
5730
self._display_reference_info(tree, branch, info)
5732
branch.set_reference_info(file_id, path, location)
5734
def _display_reference_info(self, tree, branch, info):
5736
for file_id, (path, location) in info:
5738
path = tree.id2path(file_id)
5739
except errors.NoSuchId:
5741
ref_list.append((path, location))
5742
for path, location in sorted(ref_list):
5743
self.outf.write('%s %s\n' % (path, location))
5746
# these get imported and then picked up by the scan for cmd_*
5747
# TODO: Some more consistent way to split command definitions across files;
5748
# we do need to load at least some information about them to know of
5749
# aliases. ideally we would avoid loading the implementation until the
5750
# details were needed.
5751
from bzrlib.cmd_version_info import cmd_version_info
5752
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5753
from bzrlib.bundle.commands import (
5756
from bzrlib.foreign import cmd_dpush
5757
from bzrlib.sign_my_commits import cmd_sign_my_commits
5758
from bzrlib.weave_commands import cmd_versionedfile_list, \
5759
cmd_weave_plan_merge, cmd_weave_merge_text