1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
45
revision as _mod_revision,
52
from bzrlib.branch import Branch
53
from bzrlib.conflicts import ConflictList
54
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
55
from bzrlib.smtp_connection import SMTPConnection
56
from bzrlib.workingtree import WorkingTree
59
from bzrlib.commands import Command, display_command
60
from bzrlib.option import (
67
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
70
def tree_files(file_list, default_branch=u'.', canonicalize=True,
73
return internal_tree_files(file_list, default_branch, canonicalize,
75
except errors.FileInWrongBranch, e:
76
raise errors.BzrCommandError("%s is not in the same branch as %s" %
77
(e.path, file_list[0]))
80
def tree_files_for_add(file_list):
82
Return a tree and list of absolute paths from a file list.
84
Similar to tree_files, but add handles files a bit differently, so it a
85
custom implementation. In particular, MutableTreeTree.smart_add expects
86
absolute paths, which it immediately converts to relative paths.
88
# FIXME Would be nice to just return the relative paths like
89
# internal_tree_files does, but there are a large number of unit tests
90
# that assume the current interface to mutabletree.smart_add
92
tree, relpath = WorkingTree.open_containing(file_list[0])
93
if tree.supports_views():
94
view_files = tree.views.lookup_view()
96
for filename in file_list:
97
if not osutils.is_inside_any(view_files, filename):
98
raise errors.FileOutsideView(filename, view_files)
99
file_list = file_list[:]
100
file_list[0] = tree.abspath(relpath)
102
tree = WorkingTree.open_containing(u'.')[0]
103
if tree.supports_views():
104
view_files = tree.views.lookup_view()
106
file_list = view_files
107
view_str = views.view_display_str(view_files)
108
note("Ignoring files outside view. View is %s" % view_str)
109
return tree, file_list
112
def _get_one_revision(command_name, revisions):
113
if revisions is None:
115
if len(revisions) != 1:
116
raise errors.BzrCommandError(
117
'bzr %s --revision takes exactly one revision identifier' % (
122
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
123
"""Get a revision tree. Not suitable for commands that change the tree.
125
Specifically, the basis tree in dirstate trees is coupled to the dirstate
126
and doing a commit/uncommit/pull will at best fail due to changing the
129
If tree is passed in, it should be already locked, for lifetime management
130
of the trees internal cached state.
134
if revisions is None:
136
rev_tree = tree.basis_tree()
138
rev_tree = branch.basis_tree()
140
revision = _get_one_revision(command_name, revisions)
141
rev_tree = revision.as_tree(branch)
145
# XXX: Bad function name; should possibly also be a class method of
146
# WorkingTree rather than a function.
147
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
149
"""Convert command-line paths to a WorkingTree and relative paths.
151
This is typically used for command-line processors that take one or
152
more filenames, and infer the workingtree that contains them.
154
The filenames given are not required to exist.
156
:param file_list: Filenames to convert.
158
:param default_branch: Fallback tree path to use if file_list is empty or
161
:param apply_view: if True and a view is set, apply it or check that
162
specified files are within it
164
:return: workingtree, [relative_paths]
166
if file_list is None or len(file_list) == 0:
167
tree = WorkingTree.open_containing(default_branch)[0]
168
if tree.supports_views() and apply_view:
169
view_files = tree.views.lookup_view()
171
file_list = view_files
172
view_str = views.view_display_str(view_files)
173
note("Ignoring files outside view. View is %s" % view_str)
174
return tree, file_list
175
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
176
return tree, safe_relpath_files(tree, file_list, canonicalize,
177
apply_view=apply_view)
180
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
181
"""Convert file_list into a list of relpaths in tree.
183
:param tree: A tree to operate on.
184
:param file_list: A list of user provided paths or None.
185
:param apply_view: if True and a view is set, apply it or check that
186
specified files are within it
187
:return: A list of relative paths.
188
:raises errors.PathNotChild: When a provided path is in a different tree
191
if file_list is None:
193
if tree.supports_views() and apply_view:
194
view_files = tree.views.lookup_view()
198
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
199
# doesn't - fix that up here before we enter the loop.
201
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
204
for filename in file_list:
206
relpath = fixer(osutils.dereference_path(filename))
207
if view_files and not osutils.is_inside_any(view_files, relpath):
208
raise errors.FileOutsideView(filename, view_files)
209
new_list.append(relpath)
210
except errors.PathNotChild:
211
raise errors.FileInWrongBranch(tree.branch, filename)
215
def _get_view_info_for_change_reporter(tree):
216
"""Get the view information from a tree for change reporting."""
219
current_view = tree.views.get_view_info()[0]
220
if current_view is not None:
221
view_info = (current_view, tree.views.lookup_view())
222
except errors.ViewsNotSupported:
227
# TODO: Make sure no commands unconditionally use the working directory as a
228
# branch. If a filename argument is used, the first of them should be used to
229
# specify the branch. (Perhaps this can be factored out into some kind of
230
# Argument class, representing a file in a branch, where the first occurrence
233
class cmd_status(Command):
234
"""Display status summary.
236
This reports on versioned and unknown files, reporting them
237
grouped by state. Possible states are:
240
Versioned in the working copy but not in the previous revision.
243
Versioned in the previous revision but removed or deleted
247
Path of this file changed from the previous revision;
248
the text may also have changed. This includes files whose
249
parent directory was renamed.
252
Text has changed since the previous revision.
255
File kind has been changed (e.g. from file to directory).
258
Not versioned and not matching an ignore pattern.
260
To see ignored files use 'bzr ignored'. For details on the
261
changes to file texts, use 'bzr diff'.
263
Note that --short or -S gives status flags for each item, similar
264
to Subversion's status command. To get output similar to svn -q,
265
use bzr status -SV. Additionally for directories, symlinks and
266
files with executable bit changes, Bazaar indicates this with a
267
trailing '/', '@ or '*' respectively.
269
If no arguments are specified, the status of the entire working
270
directory is shown. Otherwise, only the status of the specified
271
files or directories is reported. If a directory is given, status
272
is reported for everything inside that directory.
274
Before merges are committed, the pending merge tip revisions are
275
shown. To see all pending merge revisions, use the -v option.
276
To skip the display of pending merge information altogether, use
277
the no-pending option or specify a file/directory.
279
If a revision argument is given, the status is calculated against
280
that revision, or between two revisions if two are provided.
283
# TODO: --no-recurse, --recurse options
285
takes_args = ['file*']
286
takes_options = ['show-ids', 'revision', 'change', 'verbose',
287
Option('short', help='Use short status indicators.',
289
Option('versioned', help='Only show versioned files.',
291
Option('no-pending', help='Don\'t show pending merges.',
294
aliases = ['st', 'stat']
296
encoding_type = 'replace'
297
_see_also = ['diff', 'revert', 'status-flags']
300
def run(self, show_ids=False, file_list=None, revision=None, short=False,
301
versioned=False, no_pending=False, verbose=False):
302
from bzrlib.status import show_tree_status
304
if revision and len(revision) > 2:
305
raise errors.BzrCommandError('bzr status --revision takes exactly'
306
' one or two revision specifiers')
308
tree, relfile_list = tree_files(file_list)
309
# Avoid asking for specific files when that is not needed.
310
if relfile_list == ['']:
312
# Don't disable pending merges for full trees other than '.'.
313
if file_list == ['.']:
315
# A specific path within a tree was given.
316
elif relfile_list is not None:
318
show_tree_status(tree, show_ids=show_ids,
319
specific_files=relfile_list, revision=revision,
320
to_file=self.outf, short=short, versioned=versioned,
321
show_pending=(not no_pending), verbose=verbose)
324
class cmd_cat_revision(Command):
325
"""Write out metadata for a revision.
327
The revision to print can either be specified by a specific
328
revision identifier, or you can use --revision.
332
takes_args = ['revision_id?']
333
takes_options = ['revision']
334
# cat-revision is more for frontends so should be exact
338
def run(self, revision_id=None, revision=None):
339
if revision_id is not None and revision is not None:
340
raise errors.BzrCommandError('You can only supply one of'
341
' revision_id or --revision')
342
if revision_id is None and revision is None:
343
raise errors.BzrCommandError('You must supply either'
344
' --revision or a revision_id')
345
b = WorkingTree.open_containing(u'.')[0].branch
347
# TODO: jam 20060112 should cat-revision always output utf-8?
348
if revision_id is not None:
349
revision_id = osutils.safe_revision_id(revision_id, warn=False)
351
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
352
except errors.NoSuchRevision:
353
msg = "The repository %s contains no revision %s." % (b.repository.base,
355
raise errors.BzrCommandError(msg)
356
elif revision is not None:
359
raise errors.BzrCommandError('You cannot specify a NULL'
361
rev_id = rev.as_revision_id(b)
362
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
365
class cmd_dump_btree(Command):
366
"""Dump the contents of a btree index file to stdout.
368
PATH is a btree index file, it can be any URL. This includes things like
369
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
371
By default, the tuples stored in the index file will be displayed. With
372
--raw, we will uncompress the pages, but otherwise display the raw bytes
376
# TODO: Do we want to dump the internal nodes as well?
377
# TODO: It would be nice to be able to dump the un-parsed information,
378
# rather than only going through iter_all_entries. However, this is
379
# good enough for a start
381
encoding_type = 'exact'
382
takes_args = ['path']
383
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
384
' rather than the parsed tuples.'),
387
def run(self, path, raw=False):
388
dirname, basename = osutils.split(path)
389
t = transport.get_transport(dirname)
391
self._dump_raw_bytes(t, basename)
393
self._dump_entries(t, basename)
395
def _get_index_and_bytes(self, trans, basename):
396
"""Create a BTreeGraphIndex and raw bytes."""
397
bt = btree_index.BTreeGraphIndex(trans, basename, None)
398
bytes = trans.get_bytes(basename)
399
bt._file = cStringIO.StringIO(bytes)
400
bt._size = len(bytes)
403
def _dump_raw_bytes(self, trans, basename):
406
# We need to parse at least the root node.
407
# This is because the first page of every row starts with an
408
# uncompressed header.
409
bt, bytes = self._get_index_and_bytes(trans, basename)
410
for page_idx, page_start in enumerate(xrange(0, len(bytes),
411
btree_index._PAGE_SIZE)):
412
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
413
page_bytes = bytes[page_start:page_end]
415
self.outf.write('Root node:\n')
416
header_end, data = bt._parse_header_from_bytes(page_bytes)
417
self.outf.write(page_bytes[:header_end])
419
self.outf.write('\nPage %d\n' % (page_idx,))
420
decomp_bytes = zlib.decompress(page_bytes)
421
self.outf.write(decomp_bytes)
422
self.outf.write('\n')
424
def _dump_entries(self, trans, basename):
426
st = trans.stat(basename)
427
except errors.TransportNotPossible:
428
# We can't stat, so we'll fake it because we have to do the 'get()'
430
bt, _ = self._get_index_and_bytes(trans, basename)
432
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
433
for node in bt.iter_all_entries():
434
# Node is made up of:
435
# (index, key, value, [references])
436
refs_as_tuples = tuple([tuple([tuple(ref) for ref in ref_list])
437
for ref_list in node[3]])
438
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
439
self.outf.write('%s\n' % (as_tuple,))
442
class cmd_remove_tree(Command):
443
"""Remove the working tree from a given branch/checkout.
445
Since a lightweight checkout is little more than a working tree
446
this will refuse to run against one.
448
To re-create the working tree, use "bzr checkout".
450
_see_also = ['checkout', 'working-trees']
451
takes_args = ['location?']
454
help='Remove the working tree even if it has '
455
'uncommitted changes.'),
458
def run(self, location='.', force=False):
459
d = bzrdir.BzrDir.open(location)
462
working = d.open_workingtree()
463
except errors.NoWorkingTree:
464
raise errors.BzrCommandError("No working tree to remove")
465
except errors.NotLocalUrl:
466
raise errors.BzrCommandError("You cannot remove the working tree"
469
if (working.has_changes()):
470
raise errors.UncommittedChanges(working)
472
working_path = working.bzrdir.root_transport.base
473
branch_path = working.branch.bzrdir.root_transport.base
474
if working_path != branch_path:
475
raise errors.BzrCommandError("You cannot remove the working tree"
476
" from a lightweight checkout")
478
d.destroy_workingtree()
481
class cmd_revno(Command):
482
"""Show current revision number.
484
This is equal to the number of revisions on this branch.
488
takes_args = ['location?']
490
Option('tree', help='Show revno of working tree'),
494
def run(self, tree=False, location=u'.'):
497
wt = WorkingTree.open_containing(location)[0]
499
except (errors.NoWorkingTree, errors.NotLocalUrl):
500
raise errors.NoWorkingTree(location)
502
revid = wt.last_revision()
504
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
505
except errors.NoSuchRevision:
507
revno = ".".join(str(n) for n in revno_t)
511
b = Branch.open_containing(location)[0]
518
self.outf.write(str(revno) + '\n')
521
class cmd_revision_info(Command):
522
"""Show revision number and revision id for a given revision identifier.
525
takes_args = ['revision_info*']
529
help='Branch to examine, '
530
'rather than the one containing the working directory.',
534
Option('tree', help='Show revno of working tree'),
538
def run(self, revision=None, directory=u'.', tree=False,
539
revision_info_list=[]):
542
wt = WorkingTree.open_containing(directory)[0]
545
except (errors.NoWorkingTree, errors.NotLocalUrl):
547
b = Branch.open_containing(directory)[0]
551
if revision is not None:
552
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
553
if revision_info_list is not None:
554
for rev_str in revision_info_list:
555
rev_spec = RevisionSpec.from_string(rev_str)
556
revision_ids.append(rev_spec.as_revision_id(b))
557
# No arguments supplied, default to the last revision
558
if len(revision_ids) == 0:
561
raise errors.NoWorkingTree(directory)
562
revision_ids.append(wt.last_revision())
564
revision_ids.append(b.last_revision())
568
for revision_id in revision_ids:
570
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
571
revno = '.'.join(str(i) for i in dotted_revno)
572
except errors.NoSuchRevision:
574
maxlen = max(maxlen, len(revno))
575
revinfos.append([revno, revision_id])
583
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
586
class cmd_add(Command):
587
"""Add specified files or directories.
589
In non-recursive mode, all the named items are added, regardless
590
of whether they were previously ignored. A warning is given if
591
any of the named files are already versioned.
593
In recursive mode (the default), files are treated the same way
594
but the behaviour for directories is different. Directories that
595
are already versioned do not give a warning. All directories,
596
whether already versioned or not, are searched for files or
597
subdirectories that are neither versioned or ignored, and these
598
are added. This search proceeds recursively into versioned
599
directories. If no names are given '.' is assumed.
601
Therefore simply saying 'bzr add' will version all files that
602
are currently unknown.
604
Adding a file whose parent directory is not versioned will
605
implicitly add the parent, and so on up to the root. This means
606
you should never need to explicitly add a directory, they'll just
607
get added when you add a file in the directory.
609
--dry-run will show which files would be added, but not actually
612
--file-ids-from will try to use the file ids from the supplied path.
613
It looks up ids trying to find a matching parent directory with the
614
same filename, and then by pure path. This option is rarely needed
615
but can be useful when adding the same logical file into two
616
branches that will be merged later (without showing the two different
617
adds as a conflict). It is also useful when merging another project
618
into a subdirectory of this one.
620
Any files matching patterns in the ignore list will not be added
621
unless they are explicitly mentioned.
623
takes_args = ['file*']
626
help="Don't recursively add the contents of directories."),
628
help="Show what would be done, but don't actually do anything."),
630
Option('file-ids-from',
632
help='Lookup file ids from this tree.'),
634
encoding_type = 'replace'
635
_see_also = ['remove', 'ignore']
637
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
642
if file_ids_from is not None:
644
base_tree, base_path = WorkingTree.open_containing(
646
except errors.NoWorkingTree:
647
base_branch, base_path = Branch.open_containing(
649
base_tree = base_branch.basis_tree()
651
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
652
to_file=self.outf, should_print=(not is_quiet()))
654
action = bzrlib.add.AddAction(to_file=self.outf,
655
should_print=(not is_quiet()))
658
base_tree.lock_read()
660
tree, file_list = tree_files_for_add(file_list)
661
added, ignored = tree.smart_add(file_list, not
662
no_recurse, action=action, save=not dry_run)
664
if base_tree is not None:
668
for glob in sorted(ignored.keys()):
669
for path in ignored[glob]:
670
self.outf.write("ignored %s matching \"%s\"\n"
674
class cmd_mkdir(Command):
675
"""Create a new versioned directory.
677
This is equivalent to creating the directory and then adding it.
680
takes_args = ['dir+']
681
encoding_type = 'replace'
683
def run(self, dir_list):
686
wt, dd = WorkingTree.open_containing(d)
688
self.outf.write('added %s\n' % d)
691
class cmd_relpath(Command):
692
"""Show path of a file relative to root"""
694
takes_args = ['filename']
698
def run(self, filename):
699
# TODO: jam 20050106 Can relpath return a munged path if
700
# sys.stdout encoding cannot represent it?
701
tree, relpath = WorkingTree.open_containing(filename)
702
self.outf.write(relpath)
703
self.outf.write('\n')
706
class cmd_inventory(Command):
707
"""Show inventory of the current working copy or a revision.
709
It is possible to limit the output to a particular entry
710
type using the --kind option. For example: --kind file.
712
It is also possible to restrict the list of files to a specific
713
set. For example: bzr inventory --show-ids this/file
722
help='List entries of a particular kind: file, directory, symlink.',
725
takes_args = ['file*']
728
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
729
if kind and kind not in ['file', 'directory', 'symlink']:
730
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
732
revision = _get_one_revision('inventory', revision)
733
work_tree, file_list = tree_files(file_list)
734
work_tree.lock_read()
736
if revision is not None:
737
tree = revision.as_tree(work_tree.branch)
739
extra_trees = [work_tree]
745
if file_list is not None:
746
file_ids = tree.paths2ids(file_list, trees=extra_trees,
747
require_versioned=True)
748
# find_ids_across_trees may include some paths that don't
750
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
751
for file_id in file_ids if file_id in tree)
753
entries = tree.inventory.entries()
756
if tree is not work_tree:
759
for path, entry in entries:
760
if kind and kind != entry.kind:
763
self.outf.write('%-50s %s\n' % (path, entry.file_id))
765
self.outf.write(path)
766
self.outf.write('\n')
769
class cmd_mv(Command):
770
"""Move or rename a file.
773
bzr mv OLDNAME NEWNAME
775
bzr mv SOURCE... DESTINATION
777
If the last argument is a versioned directory, all the other names
778
are moved into it. Otherwise, there must be exactly two arguments
779
and the file is changed to a new name.
781
If OLDNAME does not exist on the filesystem but is versioned and
782
NEWNAME does exist on the filesystem but is not versioned, mv
783
assumes that the file has been manually moved and only updates
784
its internal inventory to reflect that change.
785
The same is valid when moving many SOURCE files to a DESTINATION.
787
Files cannot be moved between branches.
790
takes_args = ['names*']
791
takes_options = [Option("after", help="Move only the bzr identifier"
792
" of the file, because the file has already been moved."),
793
Option('auto', help='Automatically guess renames.'),
794
Option('dry-run', help='Avoid making changes when guessing renames.'),
796
aliases = ['move', 'rename']
797
encoding_type = 'replace'
799
def run(self, names_list, after=False, auto=False, dry_run=False):
801
return self.run_auto(names_list, after, dry_run)
803
raise errors.BzrCommandError('--dry-run requires --auto.')
804
if names_list is None:
806
if len(names_list) < 2:
807
raise errors.BzrCommandError("missing file argument")
808
tree, rel_names = tree_files(names_list, canonicalize=False)
809
tree.lock_tree_write()
811
self._run(tree, names_list, rel_names, after)
815
def run_auto(self, names_list, after, dry_run):
816
if names_list is not None and len(names_list) > 1:
817
raise errors.BzrCommandError('Only one path may be specified to'
820
raise errors.BzrCommandError('--after cannot be specified with'
822
work_tree, file_list = tree_files(names_list, default_branch='.')
823
work_tree.lock_tree_write()
825
rename_map.RenameMap.guess_renames(work_tree, dry_run)
829
def _run(self, tree, names_list, rel_names, after):
830
into_existing = osutils.isdir(names_list[-1])
831
if into_existing and len(names_list) == 2:
833
# a. case-insensitive filesystem and change case of dir
834
# b. move directory after the fact (if the source used to be
835
# a directory, but now doesn't exist in the working tree
836
# and the target is an existing directory, just rename it)
837
if (not tree.case_sensitive
838
and rel_names[0].lower() == rel_names[1].lower()):
839
into_existing = False
842
# 'fix' the case of a potential 'from'
843
from_id = tree.path2id(
844
tree.get_canonical_inventory_path(rel_names[0]))
845
if (not osutils.lexists(names_list[0]) and
846
from_id and inv.get_file_kind(from_id) == "directory"):
847
into_existing = False
850
# move into existing directory
851
# All entries reference existing inventory items, so fix them up
852
# for cicp file-systems.
853
rel_names = tree.get_canonical_inventory_paths(rel_names)
854
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
855
self.outf.write("%s => %s\n" % pair)
857
if len(names_list) != 2:
858
raise errors.BzrCommandError('to mv multiple files the'
859
' destination must be a versioned'
862
# for cicp file-systems: the src references an existing inventory
864
src = tree.get_canonical_inventory_path(rel_names[0])
865
# Find the canonical version of the destination: In all cases, the
866
# parent of the target must be in the inventory, so we fetch the
867
# canonical version from there (we do not always *use* the
868
# canonicalized tail portion - we may be attempting to rename the
870
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
871
dest_parent = osutils.dirname(canon_dest)
872
spec_tail = osutils.basename(rel_names[1])
873
# For a CICP file-system, we need to avoid creating 2 inventory
874
# entries that differ only by case. So regardless of the case
875
# we *want* to use (ie, specified by the user or the file-system),
876
# we must always choose to use the case of any existing inventory
877
# items. The only exception to this is when we are attempting a
878
# case-only rename (ie, canonical versions of src and dest are
880
dest_id = tree.path2id(canon_dest)
881
if dest_id is None or tree.path2id(src) == dest_id:
882
# No existing item we care about, so work out what case we
883
# are actually going to use.
885
# If 'after' is specified, the tail must refer to a file on disk.
887
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
889
# pathjoin with an empty tail adds a slash, which breaks
891
dest_parent_fq = tree.basedir
893
dest_tail = osutils.canonical_relpath(
895
osutils.pathjoin(dest_parent_fq, spec_tail))
897
# not 'after', so case as specified is used
898
dest_tail = spec_tail
900
# Use the existing item so 'mv' fails with AlreadyVersioned.
901
dest_tail = os.path.basename(canon_dest)
902
dest = osutils.pathjoin(dest_parent, dest_tail)
903
mutter("attempting to move %s => %s", src, dest)
904
tree.rename_one(src, dest, after=after)
905
self.outf.write("%s => %s\n" % (src, dest))
908
class cmd_pull(Command):
909
"""Turn this branch into a mirror of another branch.
911
This command only works on branches that have not diverged. Branches are
912
considered diverged if the destination branch's most recent commit is one
913
that has not been merged (directly or indirectly) into the parent.
915
If branches have diverged, you can use 'bzr merge' to integrate the changes
916
from one into the other. Once one branch has merged, the other should
917
be able to pull it again.
919
If you want to forget your local changes and just update your branch to
920
match the remote one, use pull --overwrite.
922
If there is no default location set, the first pull will set it. After
923
that, you can omit the location to use the default. To change the
924
default, use --remember. The value will only be saved if the remote
925
location can be accessed.
927
Note: The location can be specified either in the form of a branch,
928
or in the form of a path to a file containing a merge directive generated
932
_see_also = ['push', 'update', 'status-flags', 'send']
933
takes_options = ['remember', 'overwrite', 'revision',
934
custom_help('verbose',
935
help='Show logs of pulled revisions.'),
937
help='Branch to pull into, '
938
'rather than the one containing the working directory.',
943
help="Perform a local pull in a bound "
944
"branch. Local pulls are not applied to "
948
takes_args = ['location?']
949
encoding_type = 'replace'
951
def run(self, location=None, remember=False, overwrite=False,
952
revision=None, verbose=False,
953
directory=None, local=False):
954
# FIXME: too much stuff is in the command class
957
if directory is None:
960
tree_to = WorkingTree.open_containing(directory)[0]
961
branch_to = tree_to.branch
962
except errors.NoWorkingTree:
964
branch_to = Branch.open_containing(directory)[0]
966
if local and not branch_to.get_bound_location():
967
raise errors.LocalRequiresBoundBranch()
969
possible_transports = []
970
if location is not None:
972
mergeable = bundle.read_mergeable_from_url(location,
973
possible_transports=possible_transports)
974
except errors.NotABundle:
977
stored_loc = branch_to.get_parent()
979
if stored_loc is None:
980
raise errors.BzrCommandError("No pull location known or"
983
display_url = urlutils.unescape_for_display(stored_loc,
986
self.outf.write("Using saved parent location: %s\n" % display_url)
987
location = stored_loc
989
revision = _get_one_revision('pull', revision)
990
if mergeable is not None:
991
if revision is not None:
992
raise errors.BzrCommandError(
993
'Cannot use -r with merge directives or bundles')
994
mergeable.install_revisions(branch_to.repository)
995
base_revision_id, revision_id, verified = \
996
mergeable.get_merge_request(branch_to.repository)
997
branch_from = branch_to
999
branch_from = Branch.open(location,
1000
possible_transports=possible_transports)
1002
if branch_to.get_parent() is None or remember:
1003
branch_to.set_parent(branch_from.base)
1005
if branch_from is not branch_to:
1006
branch_from.lock_read()
1008
if revision is not None:
1009
revision_id = revision.as_revision_id(branch_from)
1011
branch_to.lock_write()
1013
if tree_to is not None:
1014
view_info = _get_view_info_for_change_reporter(tree_to)
1015
change_reporter = delta._ChangeReporter(
1016
unversioned_filter=tree_to.is_ignored,
1017
view_info=view_info)
1018
result = tree_to.pull(
1019
branch_from, overwrite, revision_id, change_reporter,
1020
possible_transports=possible_transports, local=local)
1022
result = branch_to.pull(
1023
branch_from, overwrite, revision_id, local=local)
1025
result.report(self.outf)
1026
if verbose and result.old_revid != result.new_revid:
1027
log.show_branch_change(
1028
branch_to, self.outf, result.old_revno,
1033
if branch_from is not branch_to:
1034
branch_from.unlock()
1037
class cmd_push(Command):
1038
"""Update a mirror of this branch.
1040
The target branch will not have its working tree populated because this
1041
is both expensive, and is not supported on remote file systems.
1043
Some smart servers or protocols *may* put the working tree in place in
1046
This command only works on branches that have not diverged. Branches are
1047
considered diverged if the destination branch's most recent commit is one
1048
that has not been merged (directly or indirectly) by the source branch.
1050
If branches have diverged, you can use 'bzr push --overwrite' to replace
1051
the other branch completely, discarding its unmerged changes.
1053
If you want to ensure you have the different changes in the other branch,
1054
do a merge (see bzr help merge) from the other branch, and commit that.
1055
After that you will be able to do a push without '--overwrite'.
1057
If there is no default push location set, the first push will set it.
1058
After that, you can omit the location to use the default. To change the
1059
default, use --remember. The value will only be saved if the remote
1060
location can be accessed.
1063
_see_also = ['pull', 'update', 'working-trees']
1064
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1065
Option('create-prefix',
1066
help='Create the path leading up to the branch '
1067
'if it does not already exist.'),
1069
help='Branch to push from, '
1070
'rather than the one containing the working directory.',
1074
Option('use-existing-dir',
1075
help='By default push will fail if the target'
1076
' directory exists, but does not already'
1077
' have a control directory. This flag will'
1078
' allow push to proceed.'),
1080
help='Create a stacked branch that references the public location '
1081
'of the parent branch.'),
1082
Option('stacked-on',
1083
help='Create a stacked branch that refers to another branch '
1084
'for the commit history. Only the work not present in the '
1085
'referenced branch is included in the branch created.',
1088
help='Refuse to push if there are uncommitted changes in'
1089
' the working tree, --no-strict disables the check.'),
1091
takes_args = ['location?']
1092
encoding_type = 'replace'
1094
def run(self, location=None, remember=False, overwrite=False,
1095
create_prefix=False, verbose=False, revision=None,
1096
use_existing_dir=False, directory=None, stacked_on=None,
1097
stacked=False, strict=None):
1098
from bzrlib.push import _show_push_branch
1100
if directory is None:
1102
# Get the source branch
1104
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1106
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1107
if strict is None: strict = True # default value
1108
# Get the tip's revision_id
1109
revision = _get_one_revision('push', revision)
1110
if revision is not None:
1111
revision_id = revision.in_history(br_from).rev_id
1114
if strict and tree is not None and revision_id is None:
1115
if (tree.has_changes()):
1116
raise errors.UncommittedChanges(
1117
tree, more='Use --no-strict to force the push.')
1118
if tree.last_revision() != tree.branch.last_revision():
1119
# The tree has lost sync with its branch, there is little
1120
# chance that the user is aware of it but he can still force
1121
# the push with --no-strict
1122
raise errors.OutOfDateTree(
1123
tree, more='Use --no-strict to force the push.')
1125
# Get the stacked_on branch, if any
1126
if stacked_on is not None:
1127
stacked_on = urlutils.normalize_url(stacked_on)
1129
parent_url = br_from.get_parent()
1131
parent = Branch.open(parent_url)
1132
stacked_on = parent.get_public_branch()
1134
# I considered excluding non-http url's here, thus forcing
1135
# 'public' branches only, but that only works for some
1136
# users, so it's best to just depend on the user spotting an
1137
# error by the feedback given to them. RBC 20080227.
1138
stacked_on = parent_url
1140
raise errors.BzrCommandError(
1141
"Could not determine branch to refer to.")
1143
# Get the destination location
1144
if location is None:
1145
stored_loc = br_from.get_push_location()
1146
if stored_loc is None:
1147
raise errors.BzrCommandError(
1148
"No push location known or specified.")
1150
display_url = urlutils.unescape_for_display(stored_loc,
1152
self.outf.write("Using saved push location: %s\n" % display_url)
1153
location = stored_loc
1155
_show_push_branch(br_from, revision_id, location, self.outf,
1156
verbose=verbose, overwrite=overwrite, remember=remember,
1157
stacked_on=stacked_on, create_prefix=create_prefix,
1158
use_existing_dir=use_existing_dir)
1161
class cmd_branch(Command):
1162
"""Create a new branch that is a copy of an existing branch.
1164
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1165
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1166
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1167
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1168
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1171
To retrieve the branch as of a particular revision, supply the --revision
1172
parameter, as in "branch foo/bar -r 5".
1175
_see_also = ['checkout']
1176
takes_args = ['from_location', 'to_location?']
1177
takes_options = ['revision', Option('hardlink',
1178
help='Hard-link working tree files where possible.'),
1180
help="Create a branch without a working-tree."),
1182
help="Switch the checkout in the current directory "
1183
"to the new branch."),
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, switch=False):
1201
from bzrlib import switch as _mod_switch
1202
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())
1263
# Switch to the new branch
1264
wt, _ = WorkingTree.open_containing('.')
1265
_mod_switch.switch(wt.bzrdir, branch)
1266
note('Switched to branch: %s',
1267
urlutils.unescape_for_display(branch.base, 'utf-8'))
1272
class cmd_checkout(Command):
1273
"""Create a new checkout of an existing branch.
1275
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1276
the branch found in '.'. This is useful if you have removed the working tree
1277
or if it was never created - i.e. if you pushed the branch to its current
1278
location using SFTP.
1280
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1281
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1282
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1283
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1284
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1287
To retrieve the branch as of a particular revision, supply the --revision
1288
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1289
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1293
_see_also = ['checkouts', 'branch']
1294
takes_args = ['branch_location?', 'to_location?']
1295
takes_options = ['revision',
1296
Option('lightweight',
1297
help="Perform a lightweight checkout. Lightweight "
1298
"checkouts depend on access to the branch for "
1299
"every operation. Normal checkouts can perform "
1300
"common operations like diff and status without "
1301
"such access, and also support local commits."
1303
Option('files-from', type=str,
1304
help="Get file contents from this tree."),
1306
help='Hard-link working tree files where possible.'
1311
def run(self, branch_location=None, to_location=None, revision=None,
1312
lightweight=False, files_from=None, hardlink=False):
1313
if branch_location is None:
1314
branch_location = osutils.getcwd()
1315
to_location = branch_location
1316
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1318
revision = _get_one_revision('checkout', revision)
1319
if files_from is not None:
1320
accelerator_tree = WorkingTree.open(files_from)
1321
if revision is not None:
1322
revision_id = revision.as_revision_id(source)
1325
if to_location is None:
1326
to_location = urlutils.derive_to_location(branch_location)
1327
# if the source and to_location are the same,
1328
# and there is no working tree,
1329
# then reconstitute a branch
1330
if (osutils.abspath(to_location) ==
1331
osutils.abspath(branch_location)):
1333
source.bzrdir.open_workingtree()
1334
except errors.NoWorkingTree:
1335
source.bzrdir.create_workingtree(revision_id)
1337
source.create_checkout(to_location, revision_id, lightweight,
1338
accelerator_tree, hardlink)
1341
class cmd_renames(Command):
1342
"""Show list of renamed files.
1344
# TODO: Option to show renames between two historical versions.
1346
# TODO: Only show renames under dir, rather than in the whole branch.
1347
_see_also = ['status']
1348
takes_args = ['dir?']
1351
def run(self, dir=u'.'):
1352
tree = WorkingTree.open_containing(dir)[0]
1355
new_inv = tree.inventory
1356
old_tree = tree.basis_tree()
1357
old_tree.lock_read()
1359
old_inv = old_tree.inventory
1361
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1362
for f, paths, c, v, p, n, k, e in iterator:
1363
if paths[0] == paths[1]:
1367
renames.append(paths)
1369
for old_name, new_name in renames:
1370
self.outf.write("%s => %s\n" % (old_name, new_name))
1377
class cmd_update(Command):
1378
"""Update a tree to have the latest code committed to its branch.
1380
This will perform a merge into the working tree, and may generate
1381
conflicts. If you have any local changes, you will still
1382
need to commit them after the update for the update to be complete.
1384
If you want to discard your local changes, you can just do a
1385
'bzr revert' instead of 'bzr commit' after the update.
1388
_see_also = ['pull', 'working-trees', 'status-flags']
1389
takes_args = ['dir?']
1392
def run(self, dir='.'):
1393
tree = WorkingTree.open_containing(dir)[0]
1394
possible_transports = []
1395
master = tree.branch.get_master_branch(
1396
possible_transports=possible_transports)
1397
if master is not None:
1400
tree.lock_tree_write()
1402
existing_pending_merges = tree.get_parent_ids()[1:]
1403
last_rev = _mod_revision.ensure_null(tree.last_revision())
1404
if last_rev == _mod_revision.ensure_null(
1405
tree.branch.last_revision()):
1406
# may be up to date, check master too.
1407
if master is None or last_rev == _mod_revision.ensure_null(
1408
master.last_revision()):
1409
revno = tree.branch.revision_id_to_revno(last_rev)
1410
note("Tree is up to date at revision %d." % (revno,))
1412
view_info = _get_view_info_for_change_reporter(tree)
1413
conflicts = tree.update(
1414
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1415
view_info=view_info), possible_transports=possible_transports)
1416
revno = tree.branch.revision_id_to_revno(
1417
_mod_revision.ensure_null(tree.last_revision()))
1418
note('Updated to revision %d.' % (revno,))
1419
if tree.get_parent_ids()[1:] != existing_pending_merges:
1420
note('Your local commits will now show as pending merges with '
1421
"'bzr status', and can be committed with 'bzr commit'.")
1430
class cmd_info(Command):
1431
"""Show information about a working tree, branch or repository.
1433
This command will show all known locations and formats associated to the
1434
tree, branch or repository.
1436
In verbose mode, statistical information is included with each report.
1437
To see extended statistic information, use a verbosity level of 2 or
1438
higher by specifying the verbose option multiple times, e.g. -vv.
1440
Branches and working trees will also report any missing revisions.
1444
Display information on the format and related locations:
1448
Display the above together with extended format information and
1449
basic statistics (like the number of files in the working tree and
1450
number of revisions in the branch and repository):
1454
Display the above together with number of committers to the branch:
1458
_see_also = ['revno', 'working-trees', 'repositories']
1459
takes_args = ['location?']
1460
takes_options = ['verbose']
1461
encoding_type = 'replace'
1464
def run(self, location=None, verbose=False):
1466
noise_level = get_verbosity_level()
1469
from bzrlib.info import show_bzrdir_info
1470
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1471
verbose=noise_level, outfile=self.outf)
1474
class cmd_remove(Command):
1475
"""Remove files or directories.
1477
This makes bzr stop tracking changes to the specified files. bzr will delete
1478
them if they can easily be recovered using revert. If no options or
1479
parameters are given bzr will scan for files that are being tracked by bzr
1480
but missing in your tree and stop tracking them for you.
1482
takes_args = ['file*']
1483
takes_options = ['verbose',
1484
Option('new', help='Only remove files that have never been committed.'),
1485
RegistryOption.from_kwargs('file-deletion-strategy',
1486
'The file deletion mode to be used.',
1487
title='Deletion Strategy', value_switches=True, enum_switch=False,
1488
safe='Only delete files if they can be'
1489
' safely recovered (default).',
1490
keep='Delete from bzr but leave the working copy.',
1491
force='Delete all the specified files, even if they can not be '
1492
'recovered and even if they are non-empty directories.')]
1493
aliases = ['rm', 'del']
1494
encoding_type = 'replace'
1496
def run(self, file_list, verbose=False, new=False,
1497
file_deletion_strategy='safe'):
1498
tree, file_list = tree_files(file_list)
1500
if file_list is not None:
1501
file_list = [f for f in file_list]
1505
# Heuristics should probably all move into tree.remove_smart or
1508
added = tree.changes_from(tree.basis_tree(),
1509
specific_files=file_list).added
1510
file_list = sorted([f[0] for f in added], reverse=True)
1511
if len(file_list) == 0:
1512
raise errors.BzrCommandError('No matching files.')
1513
elif file_list is None:
1514
# missing files show up in iter_changes(basis) as
1515
# versioned-with-no-kind.
1517
for change in tree.iter_changes(tree.basis_tree()):
1518
# Find paths in the working tree that have no kind:
1519
if change[1][1] is not None and change[6][1] is None:
1520
missing.append(change[1][1])
1521
file_list = sorted(missing, reverse=True)
1522
file_deletion_strategy = 'keep'
1523
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1524
keep_files=file_deletion_strategy=='keep',
1525
force=file_deletion_strategy=='force')
1530
class cmd_file_id(Command):
1531
"""Print file_id of a particular file or directory.
1533
The file_id is assigned when the file is first added and remains the
1534
same through all revisions where the file exists, even when it is
1539
_see_also = ['inventory', 'ls']
1540
takes_args = ['filename']
1543
def run(self, filename):
1544
tree, relpath = WorkingTree.open_containing(filename)
1545
i = tree.path2id(relpath)
1547
raise errors.NotVersionedError(filename)
1549
self.outf.write(i + '\n')
1552
class cmd_file_path(Command):
1553
"""Print path of file_ids to a file or directory.
1555
This prints one line for each directory down to the target,
1556
starting at the branch root.
1560
takes_args = ['filename']
1563
def run(self, filename):
1564
tree, relpath = WorkingTree.open_containing(filename)
1565
fid = tree.path2id(relpath)
1567
raise errors.NotVersionedError(filename)
1568
segments = osutils.splitpath(relpath)
1569
for pos in range(1, len(segments) + 1):
1570
path = osutils.joinpath(segments[:pos])
1571
self.outf.write("%s\n" % tree.path2id(path))
1574
class cmd_reconcile(Command):
1575
"""Reconcile bzr metadata in a branch.
1577
This can correct data mismatches that may have been caused by
1578
previous ghost operations or bzr upgrades. You should only
1579
need to run this command if 'bzr check' or a bzr developer
1580
advises you to run it.
1582
If a second branch is provided, cross-branch reconciliation is
1583
also attempted, which will check that data like the tree root
1584
id which was not present in very early bzr versions is represented
1585
correctly in both branches.
1587
At the same time it is run it may recompress data resulting in
1588
a potential saving in disk space or performance gain.
1590
The branch *MUST* be on a listable system such as local disk or sftp.
1593
_see_also = ['check']
1594
takes_args = ['branch?']
1596
def run(self, branch="."):
1597
from bzrlib.reconcile import reconcile
1598
dir = bzrdir.BzrDir.open(branch)
1602
class cmd_revision_history(Command):
1603
"""Display the list of revision ids on a branch."""
1606
takes_args = ['location?']
1611
def run(self, location="."):
1612
branch = Branch.open_containing(location)[0]
1613
for revid in branch.revision_history():
1614
self.outf.write(revid)
1615
self.outf.write('\n')
1618
class cmd_ancestry(Command):
1619
"""List all revisions merged into this branch."""
1621
_see_also = ['log', 'revision-history']
1622
takes_args = ['location?']
1627
def run(self, location="."):
1629
wt = WorkingTree.open_containing(location)[0]
1630
except errors.NoWorkingTree:
1631
b = Branch.open(location)
1632
last_revision = b.last_revision()
1635
last_revision = wt.last_revision()
1637
revision_ids = b.repository.get_ancestry(last_revision)
1639
for revision_id in revision_ids:
1640
self.outf.write(revision_id + '\n')
1643
class cmd_init(Command):
1644
"""Make a directory into a versioned branch.
1646
Use this to create an empty branch, or before importing an
1649
If there is a repository in a parent directory of the location, then
1650
the history of the branch will be stored in the repository. Otherwise
1651
init creates a standalone branch which carries its own history
1652
in the .bzr directory.
1654
If there is already a branch at the location but it has no working tree,
1655
the tree can be populated with 'bzr checkout'.
1657
Recipe for importing a tree of files::
1663
bzr commit -m "imported project"
1666
_see_also = ['init-repository', 'branch', 'checkout']
1667
takes_args = ['location?']
1669
Option('create-prefix',
1670
help='Create the path leading up to the branch '
1671
'if it does not already exist.'),
1672
RegistryOption('format',
1673
help='Specify a format for this branch. '
1674
'See "help formats".',
1675
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1676
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1677
value_switches=True,
1678
title="Branch format",
1680
Option('append-revisions-only',
1681
help='Never change revnos or the existing log.'
1682
' Append revisions to it only.')
1684
def run(self, location=None, format=None, append_revisions_only=False,
1685
create_prefix=False):
1687
format = bzrdir.format_registry.make_bzrdir('default')
1688
if location is None:
1691
to_transport = transport.get_transport(location)
1693
# The path has to exist to initialize a
1694
# branch inside of it.
1695
# Just using os.mkdir, since I don't
1696
# believe that we want to create a bunch of
1697
# locations if the user supplies an extended path
1699
to_transport.ensure_base()
1700
except errors.NoSuchFile:
1701
if not create_prefix:
1702
raise errors.BzrCommandError("Parent directory of %s"
1704
"\nYou may supply --create-prefix to create all"
1705
" leading parent directories."
1707
to_transport.create_prefix()
1710
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1711
except errors.NotBranchError:
1712
# really a NotBzrDir error...
1713
create_branch = bzrdir.BzrDir.create_branch_convenience
1714
branch = create_branch(to_transport.base, format=format,
1715
possible_transports=[to_transport])
1716
a_bzrdir = branch.bzrdir
1718
from bzrlib.transport.local import LocalTransport
1719
if a_bzrdir.has_branch():
1720
if (isinstance(to_transport, LocalTransport)
1721
and not a_bzrdir.has_workingtree()):
1722
raise errors.BranchExistsWithoutWorkingTree(location)
1723
raise errors.AlreadyBranchError(location)
1724
branch = a_bzrdir.create_branch()
1725
a_bzrdir.create_workingtree()
1726
if append_revisions_only:
1728
branch.set_append_revisions_only(True)
1729
except errors.UpgradeRequired:
1730
raise errors.BzrCommandError('This branch format cannot be set'
1731
' to append-revisions-only. Try --default.')
1733
from bzrlib.info import describe_layout, describe_format
1735
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1736
except (errors.NoWorkingTree, errors.NotLocalUrl):
1738
repository = branch.repository
1739
layout = describe_layout(repository, branch, tree).lower()
1740
format = describe_format(a_bzrdir, repository, branch, tree)
1741
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1742
if repository.is_shared():
1743
#XXX: maybe this can be refactored into transport.path_or_url()
1744
url = repository.bzrdir.root_transport.external_url()
1746
url = urlutils.local_path_from_url(url)
1747
except errors.InvalidURL:
1749
self.outf.write("Using shared repository: %s\n" % url)
1752
class cmd_init_repository(Command):
1753
"""Create a shared repository to hold branches.
1755
New branches created under the repository directory will store their
1756
revisions in the repository, not in the branch directory.
1758
If the --no-trees option is used then the branches in the repository
1759
will not have working trees by default.
1762
Create a shared repositories holding just branches::
1764
bzr init-repo --no-trees repo
1767
Make a lightweight checkout elsewhere::
1769
bzr checkout --lightweight repo/trunk trunk-checkout
1774
_see_also = ['init', 'branch', 'checkout', 'repositories']
1775
takes_args = ["location"]
1776
takes_options = [RegistryOption('format',
1777
help='Specify a format for this repository. See'
1778
' "bzr help formats" for details.',
1779
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1780
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1781
value_switches=True, title='Repository format'),
1783
help='Branches in the repository will default to'
1784
' not having a working tree.'),
1786
aliases = ["init-repo"]
1788
def run(self, location, format=None, no_trees=False):
1790
format = bzrdir.format_registry.make_bzrdir('default')
1792
if location is None:
1795
to_transport = transport.get_transport(location)
1796
to_transport.ensure_base()
1798
newdir = format.initialize_on_transport(to_transport)
1799
repo = newdir.create_repository(shared=True)
1800
repo.set_make_working_trees(not no_trees)
1802
from bzrlib.info import show_bzrdir_info
1803
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1806
class cmd_diff(Command):
1807
"""Show differences in the working tree, between revisions or branches.
1809
If no arguments are given, all changes for the current tree are listed.
1810
If files are given, only the changes in those files are listed.
1811
Remote and multiple branches can be compared by using the --old and
1812
--new options. If not provided, the default for both is derived from
1813
the first argument, if any, or the current tree if no arguments are
1816
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1817
produces patches suitable for "patch -p1".
1821
2 - unrepresentable changes
1826
Shows the difference in the working tree versus the last commit::
1830
Difference between the working tree and revision 1::
1834
Difference between revision 2 and revision 1::
1838
Difference between revision 2 and revision 1 for branch xxx::
1842
Show just the differences for file NEWS::
1846
Show the differences in working tree xxx for file NEWS::
1850
Show the differences from branch xxx to this working tree:
1854
Show the differences between two branches for file NEWS::
1856
bzr diff --old xxx --new yyy NEWS
1858
Same as 'bzr diff' but prefix paths with old/ and new/::
1860
bzr diff --prefix old/:new/
1862
_see_also = ['status']
1863
takes_args = ['file*']
1865
Option('diff-options', type=str,
1866
help='Pass these options to the external diff program.'),
1867
Option('prefix', type=str,
1869
help='Set prefixes added to old and new filenames, as '
1870
'two values separated by a colon. (eg "old/:new/").'),
1872
help='Branch/tree to compare from.',
1876
help='Branch/tree to compare to.',
1882
help='Use this command to compare files.',
1886
aliases = ['di', 'dif']
1887
encoding_type = 'exact'
1890
def run(self, revision=None, file_list=None, diff_options=None,
1891
prefix=None, old=None, new=None, using=None):
1892
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1894
if (prefix is None) or (prefix == '0'):
1902
old_label, new_label = prefix.split(":")
1904
raise errors.BzrCommandError(
1905
'--prefix expects two values separated by a colon'
1906
' (eg "old/:new/")')
1908
if revision and len(revision) > 2:
1909
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1910
' one or two revision specifiers')
1912
(old_tree, new_tree,
1913
old_branch, new_branch,
1914
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1915
file_list, revision, old, new, apply_view=True)
1916
return show_diff_trees(old_tree, new_tree, sys.stdout,
1917
specific_files=specific_files,
1918
external_diff_options=diff_options,
1919
old_label=old_label, new_label=new_label,
1920
extra_trees=extra_trees, using=using)
1923
class cmd_deleted(Command):
1924
"""List files deleted in the working tree.
1926
# TODO: Show files deleted since a previous revision, or
1927
# between two revisions.
1928
# TODO: Much more efficient way to do this: read in new
1929
# directories with readdir, rather than stating each one. Same
1930
# level of effort but possibly much less IO. (Or possibly not,
1931
# if the directories are very large...)
1932
_see_also = ['status', 'ls']
1933
takes_options = ['show-ids']
1936
def run(self, show_ids=False):
1937
tree = WorkingTree.open_containing(u'.')[0]
1940
old = tree.basis_tree()
1943
for path, ie in old.inventory.iter_entries():
1944
if not tree.has_id(ie.file_id):
1945
self.outf.write(path)
1947
self.outf.write(' ')
1948
self.outf.write(ie.file_id)
1949
self.outf.write('\n')
1956
class cmd_modified(Command):
1957
"""List files modified in working tree.
1961
_see_also = ['status', 'ls']
1964
help='Write an ascii NUL (\\0) separator '
1965
'between files rather than a newline.')
1969
def run(self, null=False):
1970
tree = WorkingTree.open_containing(u'.')[0]
1971
td = tree.changes_from(tree.basis_tree())
1972
for path, id, kind, text_modified, meta_modified in td.modified:
1974
self.outf.write(path + '\0')
1976
self.outf.write(osutils.quotefn(path) + '\n')
1979
class cmd_added(Command):
1980
"""List files added in working tree.
1984
_see_also = ['status', 'ls']
1987
help='Write an ascii NUL (\\0) separator '
1988
'between files rather than a newline.')
1992
def run(self, null=False):
1993
wt = WorkingTree.open_containing(u'.')[0]
1996
basis = wt.basis_tree()
1999
basis_inv = basis.inventory
2002
if file_id in basis_inv:
2004
if inv.is_root(file_id) and len(basis_inv) == 0:
2006
path = inv.id2path(file_id)
2007
if not os.access(osutils.abspath(path), os.F_OK):
2010
self.outf.write(path + '\0')
2012
self.outf.write(osutils.quotefn(path) + '\n')
2019
class cmd_root(Command):
2020
"""Show the tree root directory.
2022
The root is the nearest enclosing directory with a .bzr control
2025
takes_args = ['filename?']
2027
def run(self, filename=None):
2028
"""Print the branch root."""
2029
tree = WorkingTree.open_containing(filename)[0]
2030
self.outf.write(tree.basedir + '\n')
2033
def _parse_limit(limitstring):
2035
return int(limitstring)
2037
msg = "The limit argument must be an integer."
2038
raise errors.BzrCommandError(msg)
2041
def _parse_levels(s):
2045
msg = "The levels argument must be an integer."
2046
raise errors.BzrCommandError(msg)
2049
class cmd_log(Command):
2050
"""Show historical log for a branch or subset of a branch.
2052
log is bzr's default tool for exploring the history of a branch.
2053
The branch to use is taken from the first parameter. If no parameters
2054
are given, the branch containing the working directory is logged.
2055
Here are some simple examples::
2057
bzr log log the current branch
2058
bzr log foo.py log a file in its branch
2059
bzr log http://server/branch log a branch on a server
2061
The filtering, ordering and information shown for each revision can
2062
be controlled as explained below. By default, all revisions are
2063
shown sorted (topologically) so that newer revisions appear before
2064
older ones and descendants always appear before ancestors. If displayed,
2065
merged revisions are shown indented under the revision in which they
2070
The log format controls how information about each revision is
2071
displayed. The standard log formats are called ``long``, ``short``
2072
and ``line``. The default is long. See ``bzr help log-formats``
2073
for more details on log formats.
2075
The following options can be used to control what information is
2078
-l N display a maximum of N revisions
2079
-n N display N levels of revisions (0 for all, 1 for collapsed)
2080
-v display a status summary (delta) for each revision
2081
-p display a diff (patch) for each revision
2082
--show-ids display revision-ids (and file-ids), not just revnos
2084
Note that the default number of levels to display is a function of the
2085
log format. If the -n option is not used, the standard log formats show
2086
just the top level (mainline).
2088
Status summaries are shown using status flags like A, M, etc. To see
2089
the changes explained using words like ``added`` and ``modified``
2090
instead, use the -vv option.
2094
To display revisions from oldest to newest, use the --forward option.
2095
In most cases, using this option will have little impact on the total
2096
time taken to produce a log, though --forward does not incrementally
2097
display revisions like --reverse does when it can.
2099
:Revision filtering:
2101
The -r option can be used to specify what revision or range of revisions
2102
to filter against. The various forms are shown below::
2104
-rX display revision X
2105
-rX.. display revision X and later
2106
-r..Y display up to and including revision Y
2107
-rX..Y display from X to Y inclusive
2109
See ``bzr help revisionspec`` for details on how to specify X and Y.
2110
Some common examples are given below::
2112
-r-1 show just the tip
2113
-r-10.. show the last 10 mainline revisions
2114
-rsubmit:.. show what's new on this branch
2115
-rancestor:path.. show changes since the common ancestor of this
2116
branch and the one at location path
2117
-rdate:yesterday.. show changes since yesterday
2119
When logging a range of revisions using -rX..Y, log starts at
2120
revision Y and searches back in history through the primary
2121
("left-hand") parents until it finds X. When logging just the
2122
top level (using -n1), an error is reported if X is not found
2123
along the way. If multi-level logging is used (-n0), X may be
2124
a nested merge revision and the log will be truncated accordingly.
2128
If parameters are given and the first one is not a branch, the log
2129
will be filtered to show only those revisions that changed the
2130
nominated files or directories.
2132
Filenames are interpreted within their historical context. To log a
2133
deleted file, specify a revision range so that the file existed at
2134
the end or start of the range.
2136
Historical context is also important when interpreting pathnames of
2137
renamed files/directories. Consider the following example:
2139
* revision 1: add tutorial.txt
2140
* revision 2: modify tutorial.txt
2141
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2145
* ``bzr log guide.txt`` will log the file added in revision 1
2147
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2149
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2150
the original file in revision 2.
2152
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2153
was no file called guide.txt in revision 2.
2155
Renames are always followed by log. By design, there is no need to
2156
explicitly ask for this (and no way to stop logging a file back
2157
until it was last renamed).
2161
The --message option can be used for finding revisions that match a
2162
regular expression in a commit message.
2166
GUI tools and IDEs are often better at exploring history than command
2167
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2168
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2169
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2171
Web interfaces are often better at exploring history than command line
2172
tools, particularly for branches on servers. You may prefer Loggerhead
2173
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2175
You may find it useful to add the aliases below to ``bazaar.conf``::
2179
top = log -l10 --line
2182
``bzr tip`` will then show the latest revision while ``bzr top``
2183
will show the last 10 mainline revisions. To see the details of a
2184
particular revision X, ``bzr show -rX``.
2186
If you are interested in looking deeper into a particular merge X,
2187
use ``bzr log -n0 -rX``.
2189
``bzr log -v`` on a branch with lots of history is currently
2190
very slow. A fix for this issue is currently under development.
2191
With or without that fix, it is recommended that a revision range
2192
be given when using the -v option.
2194
bzr has a generic full-text matching plugin, bzr-search, that can be
2195
used to find revisions matching user names, commit messages, etc.
2196
Among other features, this plugin can find all revisions containing
2197
a list of words but not others.
2199
When exploring non-mainline history on large projects with deep
2200
history, the performance of log can be greatly improved by installing
2201
the historycache plugin. This plugin buffers historical information
2202
trading disk space for faster speed.
2204
takes_args = ['file*']
2205
_see_also = ['log-formats', 'revisionspec']
2208
help='Show from oldest to newest.'),
2210
custom_help('verbose',
2211
help='Show files changed in each revision.'),
2215
type=bzrlib.option._parse_revision_str,
2217
help='Show just the specified revision.'
2218
' See also "help revisionspec".'),
2222
help='Number of levels to display - 0 for all, 1 for flat.',
2224
type=_parse_levels),
2227
help='Show revisions whose message matches this '
2228
'regular expression.',
2232
help='Limit the output to the first N revisions.',
2237
help='Show changes made in each revision as a patch.'),
2238
Option('include-merges',
2239
help='Show merged revisions like --levels 0 does.'),
2241
encoding_type = 'replace'
2244
def run(self, file_list=None, timezone='original',
2255
include_merges=False):
2256
from bzrlib.log import (
2258
make_log_request_dict,
2259
_get_info_for_log_files,
2261
direction = (forward and 'forward') or 'reverse'
2266
raise errors.BzrCommandError(
2267
'--levels and --include-merges are mutually exclusive')
2269
if change is not None:
2271
raise errors.RangeInChangeOption()
2272
if revision is not None:
2273
raise errors.BzrCommandError(
2274
'--revision and --change are mutually exclusive')
2279
filter_by_dir = False
2283
# find the file ids to log and check for directory filtering
2284
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2285
revision, file_list)
2286
for relpath, file_id, kind in file_info_list:
2288
raise errors.BzrCommandError(
2289
"Path unknown at end or start of revision range: %s" %
2291
# If the relpath is the top of the tree, we log everything
2296
file_ids.append(file_id)
2297
filter_by_dir = filter_by_dir or (
2298
kind in ['directory', 'tree-reference'])
2301
# FIXME ? log the current subdir only RBC 20060203
2302
if revision is not None \
2303
and len(revision) > 0 and revision[0].get_branch():
2304
location = revision[0].get_branch()
2307
dir, relpath = bzrdir.BzrDir.open_containing(location)
2308
b = dir.open_branch()
2310
rev1, rev2 = _get_revision_range(revision, b, self.name())
2312
# Decide on the type of delta & diff filtering to use
2313
# TODO: add an --all-files option to make this configurable & consistent
2321
diff_type = 'partial'
2325
# Build the log formatter
2326
if log_format is None:
2327
log_format = log.log_formatter_registry.get_default(b)
2328
lf = log_format(show_ids=show_ids, to_file=self.outf,
2329
show_timezone=timezone,
2330
delta_format=get_verbosity_level(),
2332
show_advice=levels is None)
2334
# Choose the algorithm for doing the logging. It's annoying
2335
# having multiple code paths like this but necessary until
2336
# the underlying repository format is faster at generating
2337
# deltas or can provide everything we need from the indices.
2338
# The default algorithm - match-using-deltas - works for
2339
# multiple files and directories and is faster for small
2340
# amounts of history (200 revisions say). However, it's too
2341
# slow for logging a single file in a repository with deep
2342
# history, i.e. > 10K revisions. In the spirit of "do no
2343
# evil when adding features", we continue to use the
2344
# original algorithm - per-file-graph - for the "single
2345
# file that isn't a directory without showing a delta" case.
2346
partial_history = revision and b.repository._format.supports_chks
2347
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2348
or delta_type or partial_history)
2350
# Build the LogRequest and execute it
2351
if len(file_ids) == 0:
2353
rqst = make_log_request_dict(
2354
direction=direction, specific_fileids=file_ids,
2355
start_revision=rev1, end_revision=rev2, limit=limit,
2356
message_search=message, delta_type=delta_type,
2357
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2358
Logger(b, rqst).show(lf)
2364
def _get_revision_range(revisionspec_list, branch, command_name):
2365
"""Take the input of a revision option and turn it into a revision range.
2367
It returns RevisionInfo objects which can be used to obtain the rev_id's
2368
of the desired revisions. It does some user input validations.
2370
if revisionspec_list is None:
2373
elif len(revisionspec_list) == 1:
2374
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2375
elif len(revisionspec_list) == 2:
2376
start_spec = revisionspec_list[0]
2377
end_spec = revisionspec_list[1]
2378
if end_spec.get_branch() != start_spec.get_branch():
2379
# b is taken from revision[0].get_branch(), and
2380
# show_log will use its revision_history. Having
2381
# different branches will lead to weird behaviors.
2382
raise errors.BzrCommandError(
2383
"bzr %s doesn't accept two revisions in different"
2384
" branches." % command_name)
2385
rev1 = start_spec.in_history(branch)
2386
# Avoid loading all of history when we know a missing
2387
# end of range means the last revision ...
2388
if end_spec.spec is None:
2389
last_revno, last_revision_id = branch.last_revision_info()
2390
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2392
rev2 = end_spec.in_history(branch)
2394
raise errors.BzrCommandError(
2395
'bzr %s --revision takes one or two values.' % command_name)
2399
def _revision_range_to_revid_range(revision_range):
2402
if revision_range[0] is not None:
2403
rev_id1 = revision_range[0].rev_id
2404
if revision_range[1] is not None:
2405
rev_id2 = revision_range[1].rev_id
2406
return rev_id1, rev_id2
2408
def get_log_format(long=False, short=False, line=False, default='long'):
2409
log_format = default
2413
log_format = 'short'
2419
class cmd_touching_revisions(Command):
2420
"""Return revision-ids which affected a particular file.
2422
A more user-friendly interface is "bzr log FILE".
2426
takes_args = ["filename"]
2429
def run(self, filename):
2430
tree, relpath = WorkingTree.open_containing(filename)
2431
file_id = tree.path2id(relpath)
2435
touching_revs = log.find_touching_revisions(b, file_id)
2436
for revno, revision_id, what in touching_revs:
2437
self.outf.write("%6d %s\n" % (revno, what))
2442
class cmd_ls(Command):
2443
"""List files in a tree.
2446
_see_also = ['status', 'cat']
2447
takes_args = ['path?']
2451
Option('recursive', short_name='R',
2452
help='Recurse into subdirectories.'),
2454
help='Print paths relative to the root of the branch.'),
2455
Option('unknown', help='Print unknown files.'),
2456
Option('versioned', help='Print versioned files.',
2458
Option('ignored', help='Print ignored files.'),
2460
help='Write an ascii NUL (\\0) separator '
2461
'between files rather than a newline.'),
2463
help='List entries of a particular kind: file, directory, symlink.',
2468
def run(self, revision=None, verbose=False,
2469
recursive=False, from_root=False,
2470
unknown=False, versioned=False, ignored=False,
2471
null=False, kind=None, show_ids=False, path=None):
2473
if kind and kind not in ('file', 'directory', 'symlink'):
2474
raise errors.BzrCommandError('invalid kind specified')
2476
if verbose and null:
2477
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2478
all = not (unknown or versioned or ignored)
2480
selection = {'I':ignored, '?':unknown, 'V':versioned}
2486
raise errors.BzrCommandError('cannot specify both --from-root'
2489
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2492
# Calculate the prefix to use
2496
prefix = relpath + '/'
2497
elif fs_path != '.':
2498
prefix = fs_path + '/'
2500
if revision is not None or tree is None:
2501
tree = _get_one_revision_tree('ls', revision, branch=branch)
2504
if isinstance(tree, WorkingTree) and tree.supports_views():
2505
view_files = tree.views.lookup_view()
2508
view_str = views.view_display_str(view_files)
2509
note("Ignoring files outside view. View is %s" % view_str)
2513
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2514
from_dir=relpath, recursive=recursive):
2515
# Apply additional masking
2516
if not all and not selection[fc]:
2518
if kind is not None and fkind != kind:
2523
fullpath = osutils.pathjoin(relpath, fp)
2526
views.check_path_in_view(tree, fullpath)
2527
except errors.FileOutsideView:
2532
fp = osutils.pathjoin(prefix, fp)
2533
kindch = entry.kind_character()
2534
outstring = fp + kindch
2535
ui.ui_factory.clear_term()
2537
outstring = '%-8s %s' % (fc, outstring)
2538
if show_ids and fid is not None:
2539
outstring = "%-50s %s" % (outstring, fid)
2540
self.outf.write(outstring + '\n')
2542
self.outf.write(fp + '\0')
2545
self.outf.write(fid)
2546
self.outf.write('\0')
2554
self.outf.write('%-50s %s\n' % (outstring, my_id))
2556
self.outf.write(outstring + '\n')
2561
class cmd_unknowns(Command):
2562
"""List unknown files.
2570
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2571
self.outf.write(osutils.quotefn(f) + '\n')
2574
class cmd_ignore(Command):
2575
"""Ignore specified files or patterns.
2577
See ``bzr help patterns`` for details on the syntax of patterns.
2579
To remove patterns from the ignore list, edit the .bzrignore file.
2580
After adding, editing or deleting that file either indirectly by
2581
using this command or directly by using an editor, be sure to commit
2584
Note: ignore patterns containing shell wildcards must be quoted from
2588
Ignore the top level Makefile::
2590
bzr ignore ./Makefile
2592
Ignore class files in all directories::
2594
bzr ignore "*.class"
2596
Ignore .o files under the lib directory::
2598
bzr ignore "lib/**/*.o"
2600
Ignore .o files under the lib directory::
2602
bzr ignore "RE:lib/.*\.o"
2604
Ignore everything but the "debian" toplevel directory::
2606
bzr ignore "RE:(?!debian/).*"
2609
_see_also = ['status', 'ignored', 'patterns']
2610
takes_args = ['name_pattern*']
2612
Option('old-default-rules',
2613
help='Write out the ignore rules bzr < 0.9 always used.')
2616
def run(self, name_pattern_list=None, old_default_rules=None):
2617
from bzrlib import ignores
2618
if old_default_rules is not None:
2619
# dump the rules and exit
2620
for pattern in ignores.OLD_DEFAULTS:
2623
if not name_pattern_list:
2624
raise errors.BzrCommandError("ignore requires at least one "
2625
"NAME_PATTERN or --old-default-rules")
2626
name_pattern_list = [globbing.normalize_pattern(p)
2627
for p in name_pattern_list]
2628
for name_pattern in name_pattern_list:
2629
if (name_pattern[0] == '/' or
2630
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2631
raise errors.BzrCommandError(
2632
"NAME_PATTERN should not be an absolute path")
2633
tree, relpath = WorkingTree.open_containing(u'.')
2634
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2635
ignored = globbing.Globster(name_pattern_list)
2638
for entry in tree.list_files():
2642
if ignored.match(filename):
2643
matches.append(filename.encode('utf-8'))
2645
if len(matches) > 0:
2646
print "Warning: the following files are version controlled and" \
2647
" match your ignore pattern:\n%s" \
2648
"\nThese files will continue to be version controlled" \
2649
" unless you 'bzr remove' them." % ("\n".join(matches),)
2652
class cmd_ignored(Command):
2653
"""List ignored files and the patterns that matched them.
2655
List all the ignored files and the ignore pattern that caused the file to
2658
Alternatively, to list just the files::
2663
encoding_type = 'replace'
2664
_see_also = ['ignore', 'ls']
2668
tree = WorkingTree.open_containing(u'.')[0]
2671
for path, file_class, kind, file_id, entry in tree.list_files():
2672
if file_class != 'I':
2674
## XXX: Slightly inefficient since this was already calculated
2675
pat = tree.is_ignored(path)
2676
self.outf.write('%-50s %s\n' % (path, pat))
2681
class cmd_lookup_revision(Command):
2682
"""Lookup the revision-id from a revision-number
2685
bzr lookup-revision 33
2688
takes_args = ['revno']
2691
def run(self, revno):
2695
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2697
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2700
class cmd_export(Command):
2701
"""Export current or past revision to a destination directory or archive.
2703
If no revision is specified this exports the last committed revision.
2705
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2706
given, try to find the format with the extension. If no extension
2707
is found exports to a directory (equivalent to --format=dir).
2709
If root is supplied, it will be used as the root directory inside
2710
container formats (tar, zip, etc). If it is not supplied it will default
2711
to the exported filename. The root option has no effect for 'dir' format.
2713
If branch is omitted then the branch containing the current working
2714
directory will be used.
2716
Note: Export of tree with non-ASCII filenames to zip is not supported.
2718
================= =========================
2719
Supported formats Autodetected by extension
2720
================= =========================
2723
tbz2 .tar.bz2, .tbz2
2726
================= =========================
2728
takes_args = ['dest', 'branch_or_subdir?']
2731
help="Type of file to export to.",
2734
Option('filters', help='Apply content filters to export the '
2735
'convenient form.'),
2738
help="Name of the root directory inside the exported file."),
2740
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2741
root=None, filters=False):
2742
from bzrlib.export import export
2744
if branch_or_subdir is None:
2745
tree = WorkingTree.open_containing(u'.')[0]
2749
b, subdir = Branch.open_containing(branch_or_subdir)
2752
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2754
export(rev_tree, dest, format, root, subdir, filtered=filters)
2755
except errors.NoSuchExportFormat, e:
2756
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2759
class cmd_cat(Command):
2760
"""Write the contents of a file as of a given revision to standard output.
2762
If no revision is nominated, the last revision is used.
2764
Note: Take care to redirect standard output when using this command on a
2770
Option('name-from-revision', help='The path name in the old tree.'),
2771
Option('filters', help='Apply content filters to display the '
2772
'convenience form.'),
2775
takes_args = ['filename']
2776
encoding_type = 'exact'
2779
def run(self, filename, revision=None, name_from_revision=False,
2781
if revision is not None and len(revision) != 1:
2782
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2783
" one revision specifier")
2784
tree, branch, relpath = \
2785
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2788
return self._run(tree, branch, relpath, filename, revision,
2789
name_from_revision, filters)
2793
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2796
tree = b.basis_tree()
2797
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2799
old_file_id = rev_tree.path2id(relpath)
2801
if name_from_revision:
2802
# Try in revision if requested
2803
if old_file_id is None:
2804
raise errors.BzrCommandError(
2805
"%r is not present in revision %s" % (
2806
filename, rev_tree.get_revision_id()))
2808
content = rev_tree.get_file_text(old_file_id)
2810
cur_file_id = tree.path2id(relpath)
2812
if cur_file_id is not None:
2813
# Then try with the actual file id
2815
content = rev_tree.get_file_text(cur_file_id)
2817
except errors.NoSuchId:
2818
# The actual file id didn't exist at that time
2820
if not found and old_file_id is not None:
2821
# Finally try with the old file id
2822
content = rev_tree.get_file_text(old_file_id)
2825
# Can't be found anywhere
2826
raise errors.BzrCommandError(
2827
"%r is not present in revision %s" % (
2828
filename, rev_tree.get_revision_id()))
2830
from bzrlib.filters import (
2831
ContentFilterContext,
2832
filtered_output_bytes,
2834
filters = rev_tree._content_filter_stack(relpath)
2835
chunks = content.splitlines(True)
2836
content = filtered_output_bytes(chunks, filters,
2837
ContentFilterContext(relpath, rev_tree))
2838
self.outf.writelines(content)
2840
self.outf.write(content)
2843
class cmd_local_time_offset(Command):
2844
"""Show the offset in seconds from GMT to local time."""
2848
print osutils.local_time_offset()
2852
class cmd_commit(Command):
2853
"""Commit changes into a new revision.
2855
An explanatory message needs to be given for each commit. This is
2856
often done by using the --message option (getting the message from the
2857
command line) or by using the --file option (getting the message from
2858
a file). If neither of these options is given, an editor is opened for
2859
the user to enter the message. To see the changed files in the
2860
boilerplate text loaded into the editor, use the --show-diff option.
2862
By default, the entire tree is committed and the person doing the
2863
commit is assumed to be the author. These defaults can be overridden
2868
If selected files are specified, only changes to those files are
2869
committed. If a directory is specified then the directory and
2870
everything within it is committed.
2872
When excludes are given, they take precedence over selected files.
2873
For example, to commit only changes within foo, but not changes
2876
bzr commit foo -x foo/bar
2878
A selective commit after a merge is not yet supported.
2882
If the author of the change is not the same person as the committer,
2883
you can specify the author's name using the --author option. The
2884
name should be in the same format as a committer-id, e.g.
2885
"John Doe <jdoe@example.com>". If there is more than one author of
2886
the change you can specify the option multiple times, once for each
2891
A common mistake is to forget to add a new file or directory before
2892
running the commit command. The --strict option checks for unknown
2893
files and aborts the commit if any are found. More advanced pre-commit
2894
checks can be implemented by defining hooks. See ``bzr help hooks``
2899
If you accidentially commit the wrong changes or make a spelling
2900
mistake in the commit message say, you can use the uncommit command
2901
to undo it. See ``bzr help uncommit`` for details.
2903
Hooks can also be configured to run after a commit. This allows you
2904
to trigger updates to external systems like bug trackers. The --fixes
2905
option can be used to record the association between a revision and
2906
one or more bugs. See ``bzr help bugs`` for details.
2908
A selective commit may fail in some cases where the committed
2909
tree would be invalid. Consider::
2914
bzr commit foo -m "committing foo"
2915
bzr mv foo/bar foo/baz
2918
bzr commit foo/bar -m "committing bar but not baz"
2920
In the example above, the last commit will fail by design. This gives
2921
the user the opportunity to decide whether they want to commit the
2922
rename at the same time, separately first, or not at all. (As a general
2923
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2925
# TODO: Run hooks on tree to-be-committed, and after commit.
2927
# TODO: Strict commit that fails if there are deleted files.
2928
# (what does "deleted files" mean ??)
2930
# TODO: Give better message for -s, --summary, used by tla people
2932
# XXX: verbose currently does nothing
2934
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2935
takes_args = ['selected*']
2937
ListOption('exclude', type=str, short_name='x',
2938
help="Do not consider changes made to a given path."),
2939
Option('message', type=unicode,
2941
help="Description of the new revision."),
2944
help='Commit even if nothing has changed.'),
2945
Option('file', type=str,
2948
help='Take commit message from this file.'),
2950
help="Refuse to commit if there are unknown "
2951
"files in the working tree."),
2952
ListOption('fixes', type=str,
2953
help="Mark a bug as being fixed by this revision "
2954
"(see \"bzr help bugs\")."),
2955
ListOption('author', type=unicode,
2956
help="Set the author's name, if it's different "
2957
"from the committer."),
2959
help="Perform a local commit in a bound "
2960
"branch. Local commits are not pushed to "
2961
"the master branch until a normal commit "
2965
help='When no message is supplied, show the diff along'
2966
' with the status summary in the message editor.'),
2968
aliases = ['ci', 'checkin']
2970
def _iter_bug_fix_urls(self, fixes, branch):
2971
# Configure the properties for bug fixing attributes.
2972
for fixed_bug in fixes:
2973
tokens = fixed_bug.split(':')
2974
if len(tokens) != 2:
2975
raise errors.BzrCommandError(
2976
"Invalid bug %s. Must be in the form of 'tracker:id'. "
2977
"See \"bzr help bugs\" for more information on this "
2978
"feature.\nCommit refused." % fixed_bug)
2979
tag, bug_id = tokens
2981
yield bugtracker.get_bug_url(tag, branch, bug_id)
2982
except errors.UnknownBugTrackerAbbreviation:
2983
raise errors.BzrCommandError(
2984
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2985
except errors.MalformedBugIdentifier, e:
2986
raise errors.BzrCommandError(
2987
"%s\nCommit refused." % (str(e),))
2989
def run(self, message=None, file=None, verbose=False, selected_list=None,
2990
unchanged=False, strict=False, local=False, fixes=None,
2991
author=None, show_diff=False, exclude=None):
2992
from bzrlib.errors import (
2997
from bzrlib.msgeditor import (
2998
edit_commit_message_encoded,
2999
generate_commit_message_template,
3000
make_commit_message_template_encoded
3003
# TODO: Need a blackbox test for invoking the external editor; may be
3004
# slightly problematic to run this cross-platform.
3006
# TODO: do more checks that the commit will succeed before
3007
# spending the user's valuable time typing a commit message.
3011
tree, selected_list = tree_files(selected_list)
3012
if selected_list == ['']:
3013
# workaround - commit of root of tree should be exactly the same
3014
# as just default commit in that tree, and succeed even though
3015
# selected-file merge commit is not done yet
3020
bug_property = bugtracker.encode_fixes_bug_urls(
3021
self._iter_bug_fix_urls(fixes, tree.branch))
3023
properties['bugs'] = bug_property
3025
if local and not tree.branch.get_bound_location():
3026
raise errors.LocalRequiresBoundBranch()
3028
def get_message(commit_obj):
3029
"""Callback to get commit message"""
3030
my_message = message
3031
if my_message is not None and '\r' in my_message:
3032
my_message = my_message.replace('\r\n', '\n')
3033
my_message = my_message.replace('\r', '\n')
3034
if my_message is None and not file:
3035
t = make_commit_message_template_encoded(tree,
3036
selected_list, diff=show_diff,
3037
output_encoding=osutils.get_user_encoding())
3038
start_message = generate_commit_message_template(commit_obj)
3039
my_message = edit_commit_message_encoded(t,
3040
start_message=start_message)
3041
if my_message is None:
3042
raise errors.BzrCommandError("please specify a commit"
3043
" message with either --message or --file")
3044
elif my_message and file:
3045
raise errors.BzrCommandError(
3046
"please specify either --message or --file")
3048
my_message = codecs.open(file, 'rt',
3049
osutils.get_user_encoding()).read()
3050
if my_message == "":
3051
raise errors.BzrCommandError("empty commit message specified")
3054
# The API permits a commit with a filter of [] to mean 'select nothing'
3055
# but the command line should not do that.
3056
if not selected_list:
3057
selected_list = None
3059
tree.commit(message_callback=get_message,
3060
specific_files=selected_list,
3061
allow_pointless=unchanged, strict=strict, local=local,
3062
reporter=None, verbose=verbose, revprops=properties,
3064
exclude=safe_relpath_files(tree, exclude))
3065
except PointlessCommit:
3066
# FIXME: This should really happen before the file is read in;
3067
# perhaps prepare the commit; get the message; then actually commit
3068
raise errors.BzrCommandError("No changes to commit."
3069
" Use --unchanged to commit anyhow.")
3070
except ConflictsInTree:
3071
raise errors.BzrCommandError('Conflicts detected in working '
3072
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3074
except StrictCommitFailed:
3075
raise errors.BzrCommandError("Commit refused because there are"
3076
" unknown files in the working tree.")
3077
except errors.BoundBranchOutOfDate, e:
3078
raise errors.BzrCommandError(str(e) + "\n"
3079
'To commit to master branch, run update and then commit.\n'
3080
'You can also pass --local to commit to continue working '
3084
class cmd_check(Command):
3085
"""Validate working tree structure, branch consistency and repository history.
3087
This command checks various invariants about branch and repository storage
3088
to detect data corruption or bzr bugs.
3090
The working tree and branch checks will only give output if a problem is
3091
detected. The output fields of the repository check are:
3094
This is just the number of revisions checked. It doesn't
3098
This is just the number of versionedfiles checked. It
3099
doesn't indicate a problem.
3101
unreferenced ancestors
3102
Texts that are ancestors of other texts, but
3103
are not properly referenced by the revision ancestry. This is a
3104
subtle problem that Bazaar can work around.
3107
This is the total number of unique file contents
3108
seen in the checked revisions. It does not indicate a problem.
3111
This is the total number of repeated texts seen
3112
in the checked revisions. Texts can be repeated when their file
3113
entries are modified, but the file contents are not. It does not
3116
If no restrictions are specified, all Bazaar data that is found at the given
3117
location will be checked.
3121
Check the tree and branch at 'foo'::
3123
bzr check --tree --branch foo
3125
Check only the repository at 'bar'::
3127
bzr check --repo bar
3129
Check everything at 'baz'::
3134
_see_also = ['reconcile']
3135
takes_args = ['path?']
3136
takes_options = ['verbose',
3137
Option('branch', help="Check the branch related to the"
3138
" current directory."),
3139
Option('repo', help="Check the repository related to the"
3140
" current directory."),
3141
Option('tree', help="Check the working tree related to"
3142
" the current directory.")]
3144
def run(self, path=None, verbose=False, branch=False, repo=False,
3146
from bzrlib.check import check_dwim
3149
if not branch and not repo and not tree:
3150
branch = repo = tree = True
3151
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3154
class cmd_upgrade(Command):
3155
"""Upgrade branch storage to current format.
3157
The check command or bzr developers may sometimes advise you to run
3158
this command. When the default format has changed you may also be warned
3159
during other operations to upgrade.
3162
_see_also = ['check']
3163
takes_args = ['url?']
3165
RegistryOption('format',
3166
help='Upgrade to a specific format. See "bzr help'
3167
' formats" for details.',
3168
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3169
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3170
value_switches=True, title='Branch format'),
3173
def run(self, url='.', format=None):
3174
from bzrlib.upgrade import upgrade
3175
upgrade(url, format)
3178
class cmd_whoami(Command):
3179
"""Show or set bzr user id.
3182
Show the email of the current user::
3186
Set the current user::
3188
bzr whoami "Frank Chu <fchu@example.com>"
3190
takes_options = [ Option('email',
3191
help='Display email address only.'),
3193
help='Set identity for the current branch instead of '
3196
takes_args = ['name?']
3197
encoding_type = 'replace'
3200
def run(self, email=False, branch=False, name=None):
3202
# use branch if we're inside one; otherwise global config
3204
c = Branch.open_containing('.')[0].get_config()
3205
except errors.NotBranchError:
3206
c = config.GlobalConfig()
3208
self.outf.write(c.user_email() + '\n')
3210
self.outf.write(c.username() + '\n')
3213
# display a warning if an email address isn't included in the given name.
3215
config.extract_email_address(name)
3216
except errors.NoEmailInUsername, e:
3217
warning('"%s" does not seem to contain an email address. '
3218
'This is allowed, but not recommended.', name)
3220
# use global config unless --branch given
3222
c = Branch.open_containing('.')[0].get_config()
3224
c = config.GlobalConfig()
3225
c.set_user_option('email', name)
3228
class cmd_nick(Command):
3229
"""Print or set the branch nickname.
3231
If unset, the tree root directory name is used as the nickname.
3232
To print the current nickname, execute with no argument.
3234
Bound branches use the nickname of its master branch unless it is set
3238
_see_also = ['info']
3239
takes_args = ['nickname?']
3240
def run(self, nickname=None):
3241
branch = Branch.open_containing(u'.')[0]
3242
if nickname is None:
3243
self.printme(branch)
3245
branch.nick = nickname
3248
def printme(self, branch):
3252
class cmd_alias(Command):
3253
"""Set/unset and display aliases.
3256
Show the current aliases::
3260
Show the alias specified for 'll'::
3264
Set an alias for 'll'::
3266
bzr alias ll="log --line -r-10..-1"
3268
To remove an alias for 'll'::
3270
bzr alias --remove ll
3273
takes_args = ['name?']
3275
Option('remove', help='Remove the alias.'),
3278
def run(self, name=None, remove=False):
3280
self.remove_alias(name)
3282
self.print_aliases()
3284
equal_pos = name.find('=')
3286
self.print_alias(name)
3288
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3290
def remove_alias(self, alias_name):
3291
if alias_name is None:
3292
raise errors.BzrCommandError(
3293
'bzr alias --remove expects an alias to remove.')
3294
# If alias is not found, print something like:
3295
# unalias: foo: not found
3296
c = config.GlobalConfig()
3297
c.unset_alias(alias_name)
3300
def print_aliases(self):
3301
"""Print out the defined aliases in a similar format to bash."""
3302
aliases = config.GlobalConfig().get_aliases()
3303
for key, value in sorted(aliases.iteritems()):
3304
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3307
def print_alias(self, alias_name):
3308
from bzrlib.commands import get_alias
3309
alias = get_alias(alias_name)
3311
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3314
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3316
def set_alias(self, alias_name, alias_command):
3317
"""Save the alias in the global config."""
3318
c = config.GlobalConfig()
3319
c.set_alias(alias_name, alias_command)
3322
class cmd_selftest(Command):
3323
"""Run internal test suite.
3325
If arguments are given, they are regular expressions that say which tests
3326
should run. Tests matching any expression are run, and other tests are
3329
Alternatively if --first is given, matching tests are run first and then
3330
all other tests are run. This is useful if you have been working in a
3331
particular area, but want to make sure nothing else was broken.
3333
If --exclude is given, tests that match that regular expression are
3334
excluded, regardless of whether they match --first or not.
3336
To help catch accidential dependencies between tests, the --randomize
3337
option is useful. In most cases, the argument used is the word 'now'.
3338
Note that the seed used for the random number generator is displayed
3339
when this option is used. The seed can be explicitly passed as the
3340
argument to this option if required. This enables reproduction of the
3341
actual ordering used if and when an order sensitive problem is encountered.
3343
If --list-only is given, the tests that would be run are listed. This is
3344
useful when combined with --first, --exclude and/or --randomize to
3345
understand their impact. The test harness reports "Listed nn tests in ..."
3346
instead of "Ran nn tests in ..." when list mode is enabled.
3348
If the global option '--no-plugins' is given, plugins are not loaded
3349
before running the selftests. This has two effects: features provided or
3350
modified by plugins will not be tested, and tests provided by plugins will
3353
Tests that need working space on disk use a common temporary directory,
3354
typically inside $TMPDIR or /tmp.
3356
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3357
into a pdb postmortem session.
3360
Run only tests relating to 'ignore'::
3364
Disable plugins and list tests as they're run::
3366
bzr --no-plugins selftest -v
3368
# NB: this is used from the class without creating an instance, which is
3369
# why it does not have a self parameter.
3370
def get_transport_type(typestring):
3371
"""Parse and return a transport specifier."""
3372
if typestring == "sftp":
3373
from bzrlib.transport.sftp import SFTPAbsoluteServer
3374
return SFTPAbsoluteServer
3375
if typestring == "memory":
3376
from bzrlib.transport.memory import MemoryServer
3378
if typestring == "fakenfs":
3379
from bzrlib.transport.fakenfs import FakeNFSServer
3380
return FakeNFSServer
3381
msg = "No known transport type %s. Supported types are: sftp\n" %\
3383
raise errors.BzrCommandError(msg)
3386
takes_args = ['testspecs*']
3387
takes_options = ['verbose',
3389
help='Stop when one test fails.',
3393
help='Use a different transport by default '
3394
'throughout the test suite.',
3395
type=get_transport_type),
3397
help='Run the benchmarks rather than selftests.'),
3398
Option('lsprof-timed',
3399
help='Generate lsprof output for benchmarked'
3400
' sections of code.'),
3401
Option('lsprof-tests',
3402
help='Generate lsprof output for each test.'),
3403
Option('cache-dir', type=str,
3404
help='Cache intermediate benchmark output in this '
3407
help='Run all tests, but run specified tests first.',
3411
help='List the tests instead of running them.'),
3412
RegistryOption('parallel',
3413
help="Run the test suite in parallel.",
3414
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3415
value_switches=False,
3417
Option('randomize', type=str, argname="SEED",
3418
help='Randomize the order of tests using the given'
3419
' seed or "now" for the current time.'),
3420
Option('exclude', type=str, argname="PATTERN",
3422
help='Exclude tests that match this regular'
3425
help='Output test progress via subunit.'),
3426
Option('strict', help='Fail on missing dependencies or '
3428
Option('load-list', type=str, argname='TESTLISTFILE',
3429
help='Load a test id list from a text file.'),
3430
ListOption('debugflag', type=str, short_name='E',
3431
help='Turn on a selftest debug flag.'),
3432
ListOption('starting-with', type=str, argname='TESTID',
3433
param_name='starting_with', short_name='s',
3435
'Load only the tests starting with TESTID.'),
3437
encoding_type = 'replace'
3440
Command.__init__(self)
3441
self.additional_selftest_args = {}
3443
def run(self, testspecs_list=None, verbose=False, one=False,
3444
transport=None, benchmark=None,
3445
lsprof_timed=None, cache_dir=None,
3446
first=False, list_only=False,
3447
randomize=None, exclude=None, strict=False,
3448
load_list=None, debugflag=None, starting_with=None, subunit=False,
3449
parallel=None, lsprof_tests=False):
3450
from bzrlib.tests import selftest
3451
import bzrlib.benchmarks as benchmarks
3452
from bzrlib.benchmarks import tree_creator
3454
# Make deprecation warnings visible, unless -Werror is set
3455
symbol_versioning.activate_deprecation_warnings(override=False)
3457
if cache_dir is not None:
3458
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3459
if testspecs_list is not None:
3460
pattern = '|'.join(testspecs_list)
3465
from bzrlib.tests import SubUnitBzrRunner
3467
raise errors.BzrCommandError("subunit not available. subunit "
3468
"needs to be installed to use --subunit.")
3469
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3471
self.additional_selftest_args.setdefault(
3472
'suite_decorators', []).append(parallel)
3474
test_suite_factory = benchmarks.test_suite
3475
# Unless user explicitly asks for quiet, be verbose in benchmarks
3476
verbose = not is_quiet()
3477
# TODO: should possibly lock the history file...
3478
benchfile = open(".perf_history", "at", buffering=1)
3480
test_suite_factory = None
3483
selftest_kwargs = {"verbose": verbose,
3485
"stop_on_failure": one,
3486
"transport": transport,
3487
"test_suite_factory": test_suite_factory,
3488
"lsprof_timed": lsprof_timed,
3489
"lsprof_tests": lsprof_tests,
3490
"bench_history": benchfile,
3491
"matching_tests_first": first,
3492
"list_only": list_only,
3493
"random_seed": randomize,
3494
"exclude_pattern": exclude,
3496
"load_list": load_list,
3497
"debug_flags": debugflag,
3498
"starting_with": starting_with
3500
selftest_kwargs.update(self.additional_selftest_args)
3501
result = selftest(**selftest_kwargs)
3503
if benchfile is not None:
3505
return int(not result)
3508
class cmd_version(Command):
3509
"""Show version of bzr."""
3511
encoding_type = 'replace'
3513
Option("short", help="Print just the version number."),
3517
def run(self, short=False):
3518
from bzrlib.version import show_version
3520
self.outf.write(bzrlib.version_string + '\n')
3522
show_version(to_file=self.outf)
3525
class cmd_rocks(Command):
3526
"""Statement of optimism."""
3532
print "It sure does!"
3535
class cmd_find_merge_base(Command):
3536
"""Find and print a base revision for merging two branches."""
3537
# TODO: Options to specify revisions on either side, as if
3538
# merging only part of the history.
3539
takes_args = ['branch', 'other']
3543
def run(self, branch, other):
3544
from bzrlib.revision import ensure_null
3546
branch1 = Branch.open_containing(branch)[0]
3547
branch2 = Branch.open_containing(other)[0]
3552
last1 = ensure_null(branch1.last_revision())
3553
last2 = ensure_null(branch2.last_revision())
3555
graph = branch1.repository.get_graph(branch2.repository)
3556
base_rev_id = graph.find_unique_lca(last1, last2)
3558
print 'merge base is revision %s' % base_rev_id
3565
class cmd_merge(Command):
3566
"""Perform a three-way merge.
3568
The source of the merge can be specified either in the form of a branch,
3569
or in the form of a path to a file containing a merge directive generated
3570
with bzr send. If neither is specified, the default is the upstream branch
3571
or the branch most recently merged using --remember.
3573
When merging a branch, by default the tip will be merged. To pick a different
3574
revision, pass --revision. If you specify two values, the first will be used as
3575
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3576
available revisions, like this is commonly referred to as "cherrypicking".
3578
Revision numbers are always relative to the branch being merged.
3580
By default, bzr will try to merge in all new work from the other
3581
branch, automatically determining an appropriate base. If this
3582
fails, you may need to give an explicit base.
3584
Merge will do its best to combine the changes in two branches, but there
3585
are some kinds of problems only a human can fix. When it encounters those,
3586
it will mark a conflict. A conflict means that you need to fix something,
3587
before you should commit.
3589
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3591
If there is no default branch set, the first merge will set it. After
3592
that, you can omit the branch to use the default. To change the
3593
default, use --remember. The value will only be saved if the remote
3594
location can be accessed.
3596
The results of the merge are placed into the destination working
3597
directory, where they can be reviewed (with bzr diff), tested, and then
3598
committed to record the result of the merge.
3600
merge refuses to run if there are any uncommitted changes, unless
3603
To select only some changes to merge, use "merge -i", which will prompt
3604
you to apply each diff hunk and file change, similar to "shelve".
3607
To merge the latest revision from bzr.dev::
3609
bzr merge ../bzr.dev
3611
To merge changes up to and including revision 82 from bzr.dev::
3613
bzr merge -r 82 ../bzr.dev
3615
To merge the changes introduced by 82, without previous changes::
3617
bzr merge -r 81..82 ../bzr.dev
3619
To apply a merge directive contained in /tmp/merge:
3621
bzr merge /tmp/merge
3624
encoding_type = 'exact'
3625
_see_also = ['update', 'remerge', 'status-flags', 'send']
3626
takes_args = ['location?']
3631
help='Merge even if the destination tree has uncommitted changes.'),
3635
Option('show-base', help="Show base revision text in "
3637
Option('uncommitted', help='Apply uncommitted changes'
3638
' from a working copy, instead of branch changes.'),
3639
Option('pull', help='If the destination is already'
3640
' completely merged into the source, pull from the'
3641
' source rather than merging. When this happens,'
3642
' you do not need to commit the result.'),
3644
help='Branch to merge into, '
3645
'rather than the one containing the working directory.',
3649
Option('preview', help='Instead of merging, show a diff of the'
3651
Option('interactive', help='Select changes interactively.',
3655
def run(self, location=None, revision=None, force=False,
3656
merge_type=None, show_base=False, reprocess=None, remember=False,
3657
uncommitted=False, pull=False,
3662
if merge_type is None:
3663
merge_type = _mod_merge.Merge3Merger
3665
if directory is None: directory = u'.'
3666
possible_transports = []
3668
allow_pending = True
3669
verified = 'inapplicable'
3670
tree = WorkingTree.open_containing(directory)[0]
3673
basis_tree = tree.revision_tree(tree.last_revision())
3674
except errors.NoSuchRevision:
3675
basis_tree = tree.basis_tree()
3677
# die as quickly as possible if there are uncommitted changes
3679
if tree.has_changes():
3680
raise errors.UncommittedChanges(tree)
3682
view_info = _get_view_info_for_change_reporter(tree)
3683
change_reporter = delta._ChangeReporter(
3684
unversioned_filter=tree.is_ignored, view_info=view_info)
3687
pb = ui.ui_factory.nested_progress_bar()
3688
cleanups.append(pb.finished)
3690
cleanups.append(tree.unlock)
3691
if location is not None:
3693
mergeable = bundle.read_mergeable_from_url(location,
3694
possible_transports=possible_transports)
3695
except errors.NotABundle:
3699
raise errors.BzrCommandError('Cannot use --uncommitted'
3700
' with bundles or merge directives.')
3702
if revision is not None:
3703
raise errors.BzrCommandError(
3704
'Cannot use -r with merge directives or bundles')
3705
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3708
if merger is None and uncommitted:
3709
if revision is not None and len(revision) > 0:
3710
raise errors.BzrCommandError('Cannot use --uncommitted and'
3711
' --revision at the same time.')
3712
merger = self.get_merger_from_uncommitted(tree, location, pb,
3714
allow_pending = False
3717
merger, allow_pending = self._get_merger_from_branch(tree,
3718
location, revision, remember, possible_transports, pb)
3720
merger.merge_type = merge_type
3721
merger.reprocess = reprocess
3722
merger.show_base = show_base
3723
self.sanity_check_merger(merger)
3724
if (merger.base_rev_id == merger.other_rev_id and
3725
merger.other_rev_id is not None):
3726
note('Nothing to do.')
3729
if merger.interesting_files is not None:
3730
raise errors.BzrCommandError('Cannot pull individual files')
3731
if (merger.base_rev_id == tree.last_revision()):
3732
result = tree.pull(merger.other_branch, False,
3733
merger.other_rev_id)
3734
result.report(self.outf)
3736
if merger.this_basis is None:
3737
raise errors.BzrCommandError(
3738
"This branch has no commits."
3739
" (perhaps you would prefer 'bzr pull')")
3741
return self._do_preview(merger, cleanups)
3743
return self._do_interactive(merger, cleanups)
3745
return self._do_merge(merger, change_reporter, allow_pending,
3748
for cleanup in reversed(cleanups):
3751
def _get_preview(self, merger, cleanups):
3752
tree_merger = merger.make_merger()
3753
tt = tree_merger.make_preview_transform()
3754
cleanups.append(tt.finalize)
3755
result_tree = tt.get_preview_tree()
3758
def _do_preview(self, merger, cleanups):
3759
from bzrlib.diff import show_diff_trees
3760
result_tree = self._get_preview(merger, cleanups)
3761
show_diff_trees(merger.this_tree, result_tree, self.outf,
3762
old_label='', new_label='')
3764
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3765
merger.change_reporter = change_reporter
3766
conflict_count = merger.do_merge()
3768
merger.set_pending()
3769
if verified == 'failed':
3770
warning('Preview patch does not match changes')
3771
if conflict_count != 0:
3776
def _do_interactive(self, merger, cleanups):
3777
"""Perform an interactive merge.
3779
This works by generating a preview tree of the merge, then using
3780
Shelver to selectively remove the differences between the working tree
3781
and the preview tree.
3783
from bzrlib import shelf_ui
3784
result_tree = self._get_preview(merger, cleanups)
3785
writer = bzrlib.option.diff_writer_registry.get()
3786
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3787
reporter=shelf_ui.ApplyReporter(),
3788
diff_writer=writer(sys.stdout))
3791
def sanity_check_merger(self, merger):
3792
if (merger.show_base and
3793
not merger.merge_type is _mod_merge.Merge3Merger):
3794
raise errors.BzrCommandError("Show-base is not supported for this"
3795
" merge type. %s" % merger.merge_type)
3796
if merger.reprocess is None:
3797
if merger.show_base:
3798
merger.reprocess = False
3800
# Use reprocess if the merger supports it
3801
merger.reprocess = merger.merge_type.supports_reprocess
3802
if merger.reprocess and not merger.merge_type.supports_reprocess:
3803
raise errors.BzrCommandError("Conflict reduction is not supported"
3804
" for merge type %s." %
3806
if merger.reprocess and merger.show_base:
3807
raise errors.BzrCommandError("Cannot do conflict reduction and"
3810
def _get_merger_from_branch(self, tree, location, revision, remember,
3811
possible_transports, pb):
3812
"""Produce a merger from a location, assuming it refers to a branch."""
3813
from bzrlib.tag import _merge_tags_if_possible
3814
# find the branch locations
3815
other_loc, user_location = self._select_branch_location(tree, location,
3817
if revision is not None and len(revision) == 2:
3818
base_loc, _unused = self._select_branch_location(tree,
3819
location, revision, 0)
3821
base_loc = other_loc
3823
other_branch, other_path = Branch.open_containing(other_loc,
3824
possible_transports)
3825
if base_loc == other_loc:
3826
base_branch = other_branch
3828
base_branch, base_path = Branch.open_containing(base_loc,
3829
possible_transports)
3830
# Find the revision ids
3831
other_revision_id = None
3832
base_revision_id = None
3833
if revision is not None:
3834
if len(revision) >= 1:
3835
other_revision_id = revision[-1].as_revision_id(other_branch)
3836
if len(revision) == 2:
3837
base_revision_id = revision[0].as_revision_id(base_branch)
3838
if other_revision_id is None:
3839
other_revision_id = _mod_revision.ensure_null(
3840
other_branch.last_revision())
3841
# Remember where we merge from
3842
if ((remember or tree.branch.get_submit_branch() is None) and
3843
user_location is not None):
3844
tree.branch.set_submit_branch(other_branch.base)
3845
_merge_tags_if_possible(other_branch, tree.branch)
3846
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3847
other_revision_id, base_revision_id, other_branch, base_branch)
3848
if other_path != '':
3849
allow_pending = False
3850
merger.interesting_files = [other_path]
3852
allow_pending = True
3853
return merger, allow_pending
3855
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3856
"""Get a merger for uncommitted changes.
3858
:param tree: The tree the merger should apply to.
3859
:param location: The location containing uncommitted changes.
3860
:param pb: The progress bar to use for showing progress.
3861
:param cleanups: A list of operations to perform to clean up the
3862
temporary directories, unfinalized objects, etc.
3864
location = self._select_branch_location(tree, location)[0]
3865
other_tree, other_path = WorkingTree.open_containing(location)
3866
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3867
if other_path != '':
3868
merger.interesting_files = [other_path]
3871
def _select_branch_location(self, tree, user_location, revision=None,
3873
"""Select a branch location, according to possible inputs.
3875
If provided, branches from ``revision`` are preferred. (Both
3876
``revision`` and ``index`` must be supplied.)
3878
Otherwise, the ``location`` parameter is used. If it is None, then the
3879
``submit`` or ``parent`` location is used, and a note is printed.
3881
:param tree: The working tree to select a branch for merging into
3882
:param location: The location entered by the user
3883
:param revision: The revision parameter to the command
3884
:param index: The index to use for the revision parameter. Negative
3885
indices are permitted.
3886
:return: (selected_location, user_location). The default location
3887
will be the user-entered location.
3889
if (revision is not None and index is not None
3890
and revision[index] is not None):
3891
branch = revision[index].get_branch()
3892
if branch is not None:
3893
return branch, branch
3894
if user_location is None:
3895
location = self._get_remembered(tree, 'Merging from')
3897
location = user_location
3898
return location, user_location
3900
def _get_remembered(self, tree, verb_string):
3901
"""Use tree.branch's parent if none was supplied.
3903
Report if the remembered location was used.
3905
stored_location = tree.branch.get_submit_branch()
3906
stored_location_type = "submit"
3907
if stored_location is None:
3908
stored_location = tree.branch.get_parent()
3909
stored_location_type = "parent"
3910
mutter("%s", stored_location)
3911
if stored_location is None:
3912
raise errors.BzrCommandError("No location specified or remembered")
3913
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3914
note(u"%s remembered %s location %s", verb_string,
3915
stored_location_type, display_url)
3916
return stored_location
3919
class cmd_remerge(Command):
3922
Use this if you want to try a different merge technique while resolving
3923
conflicts. Some merge techniques are better than others, and remerge
3924
lets you try different ones on different files.
3926
The options for remerge have the same meaning and defaults as the ones for
3927
merge. The difference is that remerge can (only) be run when there is a
3928
pending merge, and it lets you specify particular files.
3931
Re-do the merge of all conflicted files, and show the base text in
3932
conflict regions, in addition to the usual THIS and OTHER texts::
3934
bzr remerge --show-base
3936
Re-do the merge of "foobar", using the weave merge algorithm, with
3937
additional processing to reduce the size of conflict regions::
3939
bzr remerge --merge-type weave --reprocess foobar
3941
takes_args = ['file*']
3946
help="Show base revision text in conflicts."),
3949
def run(self, file_list=None, merge_type=None, show_base=False,
3951
if merge_type is None:
3952
merge_type = _mod_merge.Merge3Merger
3953
tree, file_list = tree_files(file_list)
3956
parents = tree.get_parent_ids()
3957
if len(parents) != 2:
3958
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3959
" merges. Not cherrypicking or"
3961
repository = tree.branch.repository
3962
interesting_ids = None
3964
conflicts = tree.conflicts()
3965
if file_list is not None:
3966
interesting_ids = set()
3967
for filename in file_list:
3968
file_id = tree.path2id(filename)
3970
raise errors.NotVersionedError(filename)
3971
interesting_ids.add(file_id)
3972
if tree.kind(file_id) != "directory":
3975
for name, ie in tree.inventory.iter_entries(file_id):
3976
interesting_ids.add(ie.file_id)
3977
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3979
# Remerge only supports resolving contents conflicts
3980
allowed_conflicts = ('text conflict', 'contents conflict')
3981
restore_files = [c.path for c in conflicts
3982
if c.typestring in allowed_conflicts]
3983
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3984
tree.set_conflicts(ConflictList(new_conflicts))
3985
if file_list is not None:
3986
restore_files = file_list
3987
for filename in restore_files:
3989
restore(tree.abspath(filename))
3990
except errors.NotConflicted:
3992
# Disable pending merges, because the file texts we are remerging
3993
# have not had those merges performed. If we use the wrong parents
3994
# list, we imply that the working tree text has seen and rejected
3995
# all the changes from the other tree, when in fact those changes
3996
# have not yet been seen.
3997
pb = ui.ui_factory.nested_progress_bar()
3998
tree.set_parent_ids(parents[:1])
4000
merger = _mod_merge.Merger.from_revision_ids(pb,
4002
merger.interesting_ids = interesting_ids
4003
merger.merge_type = merge_type
4004
merger.show_base = show_base
4005
merger.reprocess = reprocess
4006
conflicts = merger.do_merge()
4008
tree.set_parent_ids(parents)
4018
class cmd_revert(Command):
4019
"""Revert files to a previous revision.
4021
Giving a list of files will revert only those files. Otherwise, all files
4022
will be reverted. If the revision is not specified with '--revision', the
4023
last committed revision is used.
4025
To remove only some changes, without reverting to a prior version, use
4026
merge instead. For example, "merge . --revision -2..-3" will remove the
4027
changes introduced by -2, without affecting the changes introduced by -1.
4028
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4030
By default, any files that have been manually changed will be backed up
4031
first. (Files changed only by merge are not backed up.) Backup files have
4032
'.~#~' appended to their name, where # is a number.
4034
When you provide files, you can use their current pathname or the pathname
4035
from the target revision. So you can use revert to "undelete" a file by
4036
name. If you name a directory, all the contents of that directory will be
4039
Any files that have been newly added since that revision will be deleted,
4040
with a backup kept if appropriate. Directories containing unknown files
4041
will not be deleted.
4043
The working tree contains a list of pending merged revisions, which will
4044
be included as parents in the next commit. Normally, revert clears that
4045
list as well as reverting the files. If any files are specified, revert
4046
leaves the pending merge list alone and reverts only the files. Use "bzr
4047
revert ." in the tree root to revert all files but keep the merge record,
4048
and "bzr revert --forget-merges" to clear the pending merge list without
4049
reverting any files.
4051
Using "bzr revert --forget-merges", it is possible to apply the changes
4052
from an arbitrary merge as a single revision. To do this, perform the
4053
merge as desired. Then doing revert with the "--forget-merges" option will
4054
keep the content of the tree as it was, but it will clear the list of
4055
pending merges. The next commit will then contain all of the changes that
4056
would have been in the merge, but without any mention of the other parent
4057
revisions. Because this technique forgets where these changes originated,
4058
it may cause additional conflicts on later merges involving the source and
4062
_see_also = ['cat', 'export']
4065
Option('no-backup', "Do not save backups of reverted files."),
4066
Option('forget-merges',
4067
'Remove pending merge marker, without changing any files.'),
4069
takes_args = ['file*']
4071
def run(self, revision=None, no_backup=False, file_list=None,
4072
forget_merges=None):
4073
tree, file_list = tree_files(file_list)
4077
tree.set_parent_ids(tree.get_parent_ids()[:1])
4079
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4084
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4085
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4086
pb = ui.ui_factory.nested_progress_bar()
4088
tree.revert(file_list, rev_tree, not no_backup, pb,
4089
report_changes=True)
4094
class cmd_assert_fail(Command):
4095
"""Test reporting of assertion failures"""
4096
# intended just for use in testing
4101
raise AssertionError("always fails")
4104
class cmd_help(Command):
4105
"""Show help on a command or other topic.
4108
_see_also = ['topics']
4110
Option('long', 'Show help on all commands.'),
4112
takes_args = ['topic?']
4113
aliases = ['?', '--help', '-?', '-h']
4116
def run(self, topic=None, long=False):
4118
if topic is None and long:
4120
bzrlib.help.help(topic)
4123
class cmd_shell_complete(Command):
4124
"""Show appropriate completions for context.
4126
For a list of all available commands, say 'bzr shell-complete'.
4128
takes_args = ['context?']
4133
def run(self, context=None):
4134
import shellcomplete
4135
shellcomplete.shellcomplete(context)
4138
class cmd_missing(Command):
4139
"""Show unmerged/unpulled revisions between two branches.
4141
OTHER_BRANCH may be local or remote.
4143
To filter on a range of revisions, you can use the command -r begin..end
4144
-r revision requests a specific revision, -r ..end or -r begin.. are
4149
Determine the missing revisions between this and the branch at the
4150
remembered pull location::
4154
Determine the missing revisions between this and another branch::
4156
bzr missing http://server/branch
4158
Determine the missing revisions up to a specific revision on the other
4161
bzr missing -r ..-10
4163
Determine the missing revisions up to a specific revision on this
4166
bzr missing --my-revision ..-10
4169
_see_also = ['merge', 'pull']
4170
takes_args = ['other_branch?']
4172
Option('reverse', 'Reverse the order of revisions.'),
4174
'Display changes in the local branch only.'),
4175
Option('this' , 'Same as --mine-only.'),
4176
Option('theirs-only',
4177
'Display changes in the remote branch only.'),
4178
Option('other', 'Same as --theirs-only.'),
4182
custom_help('revision',
4183
help='Filter on other branch revisions (inclusive). '
4184
'See "help revisionspec" for details.'),
4185
Option('my-revision',
4186
type=_parse_revision_str,
4187
help='Filter on local branch revisions (inclusive). '
4188
'See "help revisionspec" for details.'),
4189
Option('include-merges',
4190
'Show all revisions in addition to the mainline ones.'),
4192
encoding_type = 'replace'
4195
def run(self, other_branch=None, reverse=False, mine_only=False,
4197
log_format=None, long=False, short=False, line=False,
4198
show_ids=False, verbose=False, this=False, other=False,
4199
include_merges=False, revision=None, my_revision=None):
4200
from bzrlib.missing import find_unmerged, iter_log_revisions
4209
# TODO: We should probably check that we don't have mine-only and
4210
# theirs-only set, but it gets complicated because we also have
4211
# this and other which could be used.
4218
local_branch = Branch.open_containing(u".")[0]
4219
parent = local_branch.get_parent()
4220
if other_branch is None:
4221
other_branch = parent
4222
if other_branch is None:
4223
raise errors.BzrCommandError("No peer location known"
4225
display_url = urlutils.unescape_for_display(parent,
4227
message("Using saved parent location: "
4228
+ display_url + "\n")
4230
remote_branch = Branch.open(other_branch)
4231
if remote_branch.base == local_branch.base:
4232
remote_branch = local_branch
4234
local_revid_range = _revision_range_to_revid_range(
4235
_get_revision_range(my_revision, local_branch,
4238
remote_revid_range = _revision_range_to_revid_range(
4239
_get_revision_range(revision,
4240
remote_branch, self.name()))
4242
local_branch.lock_read()
4244
remote_branch.lock_read()
4246
local_extra, remote_extra = find_unmerged(
4247
local_branch, remote_branch, restrict,
4248
backward=not reverse,
4249
include_merges=include_merges,
4250
local_revid_range=local_revid_range,
4251
remote_revid_range=remote_revid_range)
4253
if log_format is None:
4254
registry = log.log_formatter_registry
4255
log_format = registry.get_default(local_branch)
4256
lf = log_format(to_file=self.outf,
4258
show_timezone='original')
4261
if local_extra and not theirs_only:
4262
message("You have %d extra revision(s):\n" %
4264
for revision in iter_log_revisions(local_extra,
4265
local_branch.repository,
4267
lf.log_revision(revision)
4268
printed_local = True
4271
printed_local = False
4273
if remote_extra and not mine_only:
4274
if printed_local is True:
4276
message("You are missing %d revision(s):\n" %
4278
for revision in iter_log_revisions(remote_extra,
4279
remote_branch.repository,
4281
lf.log_revision(revision)
4284
if mine_only and not local_extra:
4285
# We checked local, and found nothing extra
4286
message('This branch is up to date.\n')
4287
elif theirs_only and not remote_extra:
4288
# We checked remote, and found nothing extra
4289
message('Other branch is up to date.\n')
4290
elif not (mine_only or theirs_only or local_extra or
4292
# We checked both branches, and neither one had extra
4294
message("Branches are up to date.\n")
4296
remote_branch.unlock()
4298
local_branch.unlock()
4299
if not status_code and parent is None and other_branch is not None:
4300
local_branch.lock_write()
4302
# handle race conditions - a parent might be set while we run.
4303
if local_branch.get_parent() is None:
4304
local_branch.set_parent(remote_branch.base)
4306
local_branch.unlock()
4310
class cmd_pack(Command):
4311
"""Compress the data within a repository."""
4313
_see_also = ['repositories']
4314
takes_args = ['branch_or_repo?']
4316
def run(self, branch_or_repo='.'):
4317
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4319
branch = dir.open_branch()
4320
repository = branch.repository
4321
except errors.NotBranchError:
4322
repository = dir.open_repository()
4326
class cmd_plugins(Command):
4327
"""List the installed plugins.
4329
This command displays the list of installed plugins including
4330
version of plugin and a short description of each.
4332
--verbose shows the path where each plugin is located.
4334
A plugin is an external component for Bazaar that extends the
4335
revision control system, by adding or replacing code in Bazaar.
4336
Plugins can do a variety of things, including overriding commands,
4337
adding new commands, providing additional network transports and
4338
customizing log output.
4340
See the Bazaar web site, http://bazaar-vcs.org, for further
4341
information on plugins including where to find them and how to
4342
install them. Instructions are also provided there on how to
4343
write new plugins using the Python programming language.
4345
takes_options = ['verbose']
4348
def run(self, verbose=False):
4349
import bzrlib.plugin
4350
from inspect import getdoc
4352
for name, plugin in bzrlib.plugin.plugins().items():
4353
version = plugin.__version__
4354
if version == 'unknown':
4356
name_ver = '%s %s' % (name, version)
4357
d = getdoc(plugin.module)
4359
doc = d.split('\n')[0]
4361
doc = '(no description)'
4362
result.append((name_ver, doc, plugin.path()))
4363
for name_ver, doc, path in sorted(result):
4371
class cmd_testament(Command):
4372
"""Show testament (signing-form) of a revision."""
4375
Option('long', help='Produce long-format testament.'),
4377
help='Produce a strict-format testament.')]
4378
takes_args = ['branch?']
4380
def run(self, branch=u'.', revision=None, long=False, strict=False):
4381
from bzrlib.testament import Testament, StrictTestament
4383
testament_class = StrictTestament
4385
testament_class = Testament
4387
b = Branch.open_containing(branch)[0]
4389
b = Branch.open(branch)
4392
if revision is None:
4393
rev_id = b.last_revision()
4395
rev_id = revision[0].as_revision_id(b)
4396
t = testament_class.from_revision(b.repository, rev_id)
4398
sys.stdout.writelines(t.as_text_lines())
4400
sys.stdout.write(t.as_short_text())
4405
class cmd_annotate(Command):
4406
"""Show the origin of each line in a file.
4408
This prints out the given file with an annotation on the left side
4409
indicating which revision, author and date introduced the change.
4411
If the origin is the same for a run of consecutive lines, it is
4412
shown only at the top, unless the --all option is given.
4414
# TODO: annotate directories; showing when each file was last changed
4415
# TODO: if the working copy is modified, show annotations on that
4416
# with new uncommitted lines marked
4417
aliases = ['ann', 'blame', 'praise']
4418
takes_args = ['filename']
4419
takes_options = [Option('all', help='Show annotations on all lines.'),
4420
Option('long', help='Show commit date in annotations.'),
4424
encoding_type = 'exact'
4427
def run(self, filename, all=False, long=False, revision=None,
4429
from bzrlib.annotate import annotate_file, annotate_file_tree
4430
wt, branch, relpath = \
4431
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4437
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4439
file_id = wt.path2id(relpath)
4441
file_id = tree.path2id(relpath)
4443
raise errors.NotVersionedError(filename)
4444
file_version = tree.inventory[file_id].revision
4445
if wt is not None and revision is None:
4446
# If there is a tree and we're not annotating historical
4447
# versions, annotate the working tree's content.
4448
annotate_file_tree(wt, file_id, self.outf, long, all,
4451
annotate_file(branch, file_version, file_id, long, all, self.outf,
4460
class cmd_re_sign(Command):
4461
"""Create a digital signature for an existing revision."""
4462
# TODO be able to replace existing ones.
4464
hidden = True # is this right ?
4465
takes_args = ['revision_id*']
4466
takes_options = ['revision']
4468
def run(self, revision_id_list=None, revision=None):
4469
if revision_id_list is not None and revision is not None:
4470
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4471
if revision_id_list is None and revision is None:
4472
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4473
b = WorkingTree.open_containing(u'.')[0].branch
4476
return self._run(b, revision_id_list, revision)
4480
def _run(self, b, revision_id_list, revision):
4481
import bzrlib.gpg as gpg
4482
gpg_strategy = gpg.GPGStrategy(b.get_config())
4483
if revision_id_list is not None:
4484
b.repository.start_write_group()
4486
for revision_id in revision_id_list:
4487
b.repository.sign_revision(revision_id, gpg_strategy)
4489
b.repository.abort_write_group()
4492
b.repository.commit_write_group()
4493
elif revision is not None:
4494
if len(revision) == 1:
4495
revno, rev_id = revision[0].in_history(b)
4496
b.repository.start_write_group()
4498
b.repository.sign_revision(rev_id, gpg_strategy)
4500
b.repository.abort_write_group()
4503
b.repository.commit_write_group()
4504
elif len(revision) == 2:
4505
# are they both on rh- if so we can walk between them
4506
# might be nice to have a range helper for arbitrary
4507
# revision paths. hmm.
4508
from_revno, from_revid = revision[0].in_history(b)
4509
to_revno, to_revid = revision[1].in_history(b)
4510
if to_revid is None:
4511
to_revno = b.revno()
4512
if from_revno is None or to_revno is None:
4513
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4514
b.repository.start_write_group()
4516
for revno in range(from_revno, to_revno + 1):
4517
b.repository.sign_revision(b.get_rev_id(revno),
4520
b.repository.abort_write_group()
4523
b.repository.commit_write_group()
4525
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4528
class cmd_bind(Command):
4529
"""Convert the current branch into a checkout of the supplied branch.
4531
Once converted into a checkout, commits must succeed on the master branch
4532
before they will be applied to the local branch.
4534
Bound branches use the nickname of its master branch unless it is set
4535
locally, in which case binding will update the local nickname to be
4539
_see_also = ['checkouts', 'unbind']
4540
takes_args = ['location?']
4543
def run(self, location=None):
4544
b, relpath = Branch.open_containing(u'.')
4545
if location is None:
4547
location = b.get_old_bound_location()
4548
except errors.UpgradeRequired:
4549
raise errors.BzrCommandError('No location supplied. '
4550
'This format does not remember old locations.')
4552
if location is None:
4553
raise errors.BzrCommandError('No location supplied and no '
4554
'previous location known')
4555
b_other = Branch.open(location)
4558
except errors.DivergedBranches:
4559
raise errors.BzrCommandError('These branches have diverged.'
4560
' Try merging, and then bind again.')
4561
if b.get_config().has_explicit_nickname():
4562
b.nick = b_other.nick
4565
class cmd_unbind(Command):
4566
"""Convert the current checkout into a regular branch.
4568
After unbinding, the local branch is considered independent and subsequent
4569
commits will be local only.
4572
_see_also = ['checkouts', 'bind']
4577
b, relpath = Branch.open_containing(u'.')
4579
raise errors.BzrCommandError('Local branch is not bound')
4582
class cmd_uncommit(Command):
4583
"""Remove the last committed revision.
4585
--verbose will print out what is being removed.
4586
--dry-run will go through all the motions, but not actually
4589
If --revision is specified, uncommit revisions to leave the branch at the
4590
specified revision. For example, "bzr uncommit -r 15" will leave the
4591
branch at revision 15.
4593
Uncommit leaves the working tree ready for a new commit. The only change
4594
it may make is to restore any pending merges that were present before
4598
# TODO: jam 20060108 Add an option to allow uncommit to remove
4599
# unreferenced information in 'branch-as-repository' branches.
4600
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4601
# information in shared branches as well.
4602
_see_also = ['commit']
4603
takes_options = ['verbose', 'revision',
4604
Option('dry-run', help='Don\'t actually make changes.'),
4605
Option('force', help='Say yes to all questions.'),
4607
help="Only remove the commits from the local branch"
4608
" when in a checkout."
4611
takes_args = ['location?']
4613
encoding_type = 'replace'
4615
def run(self, location=None,
4616
dry_run=False, verbose=False,
4617
revision=None, force=False, local=False):
4618
if location is None:
4620
control, relpath = bzrdir.BzrDir.open_containing(location)
4622
tree = control.open_workingtree()
4624
except (errors.NoWorkingTree, errors.NotLocalUrl):
4626
b = control.open_branch()
4628
if tree is not None:
4633
return self._run(b, tree, dry_run, verbose, revision, force,
4636
if tree is not None:
4641
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4642
from bzrlib.log import log_formatter, show_log
4643
from bzrlib.uncommit import uncommit
4645
last_revno, last_rev_id = b.last_revision_info()
4648
if revision is None:
4650
rev_id = last_rev_id
4652
# 'bzr uncommit -r 10' actually means uncommit
4653
# so that the final tree is at revno 10.
4654
# but bzrlib.uncommit.uncommit() actually uncommits
4655
# the revisions that are supplied.
4656
# So we need to offset it by one
4657
revno = revision[0].in_history(b).revno + 1
4658
if revno <= last_revno:
4659
rev_id = b.get_rev_id(revno)
4661
if rev_id is None or _mod_revision.is_null(rev_id):
4662
self.outf.write('No revisions to uncommit.\n')
4665
lf = log_formatter('short',
4667
show_timezone='original')
4672
direction='forward',
4673
start_revision=revno,
4674
end_revision=last_revno)
4677
print 'Dry-run, pretending to remove the above revisions.'
4679
val = raw_input('Press <enter> to continue')
4681
print 'The above revision(s) will be removed.'
4683
val = raw_input('Are you sure [y/N]? ')
4684
if val.lower() not in ('y', 'yes'):
4688
mutter('Uncommitting from {%s} to {%s}',
4689
last_rev_id, rev_id)
4690
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4691
revno=revno, local=local)
4692
note('You can restore the old tip by running:\n'
4693
' bzr pull . -r revid:%s', last_rev_id)
4696
class cmd_break_lock(Command):
4697
"""Break a dead lock on a repository, branch or working directory.
4699
CAUTION: Locks should only be broken when you are sure that the process
4700
holding the lock has been stopped.
4702
You can get information on what locks are open via the 'bzr info' command.
4707
takes_args = ['location?']
4709
def run(self, location=None, show=False):
4710
if location is None:
4712
control, relpath = bzrdir.BzrDir.open_containing(location)
4714
control.break_lock()
4715
except NotImplementedError:
4719
class cmd_wait_until_signalled(Command):
4720
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4722
This just prints a line to signal when it is ready, then blocks on stdin.
4728
sys.stdout.write("running\n")
4730
sys.stdin.readline()
4733
class cmd_serve(Command):
4734
"""Run the bzr server."""
4736
aliases = ['server']
4740
help='Serve on stdin/out for use from inetd or sshd.'),
4741
RegistryOption('protocol',
4742
help="Protocol to serve.",
4743
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4744
value_switches=True),
4746
help='Listen for connections on nominated port of the form '
4747
'[hostname:]portnumber. Passing 0 as the port number will '
4748
'result in a dynamically allocated port. The default port '
4749
'depends on the protocol.',
4752
help='Serve contents of this directory.',
4754
Option('allow-writes',
4755
help='By default the server is a readonly server. Supplying '
4756
'--allow-writes enables write access to the contents of '
4757
'the served directory and below.'
4761
def get_host_and_port(self, port):
4762
"""Return the host and port to run the smart server on.
4764
If 'port' is None, None will be returned for the host and port.
4766
If 'port' has a colon in it, the string before the colon will be
4767
interpreted as the host.
4769
:param port: A string of the port to run the server on.
4770
:return: A tuple of (host, port), where 'host' is a host name or IP,
4771
and port is an integer TCP/IP port.
4774
if port is not None:
4776
host, port = port.split(':')
4780
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4782
from bzrlib.transport import get_transport, transport_server_registry
4783
if directory is None:
4784
directory = os.getcwd()
4785
if protocol is None:
4786
protocol = transport_server_registry.get()
4787
host, port = self.get_host_and_port(port)
4788
url = urlutils.local_path_to_url(directory)
4789
if not allow_writes:
4790
url = 'readonly+' + url
4791
transport = get_transport(url)
4792
protocol(transport, host, port, inet)
4795
class cmd_join(Command):
4796
"""Combine a tree into its containing tree.
4798
This command requires the target tree to be in a rich-root format.
4800
The TREE argument should be an independent tree, inside another tree, but
4801
not part of it. (Such trees can be produced by "bzr split", but also by
4802
running "bzr branch" with the target inside a tree.)
4804
The result is a combined tree, with the subtree no longer an independant
4805
part. This is marked as a merge of the subtree into the containing tree,
4806
and all history is preserved.
4809
_see_also = ['split']
4810
takes_args = ['tree']
4812
Option('reference', help='Join by reference.', hidden=True),
4815
def run(self, tree, reference=False):
4816
sub_tree = WorkingTree.open(tree)
4817
parent_dir = osutils.dirname(sub_tree.basedir)
4818
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4819
repo = containing_tree.branch.repository
4820
if not repo.supports_rich_root():
4821
raise errors.BzrCommandError(
4822
"Can't join trees because %s doesn't support rich root data.\n"
4823
"You can use bzr upgrade on the repository."
4827
containing_tree.add_reference(sub_tree)
4828
except errors.BadReferenceTarget, e:
4829
# XXX: Would be better to just raise a nicely printable
4830
# exception from the real origin. Also below. mbp 20070306
4831
raise errors.BzrCommandError("Cannot join %s. %s" %
4835
containing_tree.subsume(sub_tree)
4836
except errors.BadSubsumeSource, e:
4837
raise errors.BzrCommandError("Cannot join %s. %s" %
4841
class cmd_split(Command):
4842
"""Split a subdirectory of a tree into a separate tree.
4844
This command will produce a target tree in a format that supports
4845
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4846
converted into earlier formats like 'dirstate-tags'.
4848
The TREE argument should be a subdirectory of a working tree. That
4849
subdirectory will be converted into an independent tree, with its own
4850
branch. Commits in the top-level tree will not apply to the new subtree.
4853
_see_also = ['join']
4854
takes_args = ['tree']
4856
def run(self, tree):
4857
containing_tree, subdir = WorkingTree.open_containing(tree)
4858
sub_id = containing_tree.path2id(subdir)
4860
raise errors.NotVersionedError(subdir)
4862
containing_tree.extract(sub_id)
4863
except errors.RootNotRich:
4864
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4867
class cmd_merge_directive(Command):
4868
"""Generate a merge directive for auto-merge tools.
4870
A directive requests a merge to be performed, and also provides all the
4871
information necessary to do so. This means it must either include a
4872
revision bundle, or the location of a branch containing the desired
4875
A submit branch (the location to merge into) must be supplied the first
4876
time the command is issued. After it has been supplied once, it will
4877
be remembered as the default.
4879
A public branch is optional if a revision bundle is supplied, but required
4880
if --diff or --plain is specified. It will be remembered as the default
4881
after the first use.
4884
takes_args = ['submit_branch?', 'public_branch?']
4888
_see_also = ['send']
4891
RegistryOption.from_kwargs('patch-type',
4892
'The type of patch to include in the directive.',
4894
value_switches=True,
4896
bundle='Bazaar revision bundle (default).',
4897
diff='Normal unified diff.',
4898
plain='No patch, just directive.'),
4899
Option('sign', help='GPG-sign the directive.'), 'revision',
4900
Option('mail-to', type=str,
4901
help='Instead of printing the directive, email to this address.'),
4902
Option('message', type=str, short_name='m',
4903
help='Message to use when committing this merge.')
4906
encoding_type = 'exact'
4908
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4909
sign=False, revision=None, mail_to=None, message=None):
4910
from bzrlib.revision import ensure_null, NULL_REVISION
4911
include_patch, include_bundle = {
4912
'plain': (False, False),
4913
'diff': (True, False),
4914
'bundle': (True, True),
4916
branch = Branch.open('.')
4917
stored_submit_branch = branch.get_submit_branch()
4918
if submit_branch is None:
4919
submit_branch = stored_submit_branch
4921
if stored_submit_branch is None:
4922
branch.set_submit_branch(submit_branch)
4923
if submit_branch is None:
4924
submit_branch = branch.get_parent()
4925
if submit_branch is None:
4926
raise errors.BzrCommandError('No submit branch specified or known')
4928
stored_public_branch = branch.get_public_branch()
4929
if public_branch is None:
4930
public_branch = stored_public_branch
4931
elif stored_public_branch is None:
4932
branch.set_public_branch(public_branch)
4933
if not include_bundle and public_branch is None:
4934
raise errors.BzrCommandError('No public branch specified or'
4936
base_revision_id = None
4937
if revision is not None:
4938
if len(revision) > 2:
4939
raise errors.BzrCommandError('bzr merge-directive takes '
4940
'at most two one revision identifiers')
4941
revision_id = revision[-1].as_revision_id(branch)
4942
if len(revision) == 2:
4943
base_revision_id = revision[0].as_revision_id(branch)
4945
revision_id = branch.last_revision()
4946
revision_id = ensure_null(revision_id)
4947
if revision_id == NULL_REVISION:
4948
raise errors.BzrCommandError('No revisions to bundle.')
4949
directive = merge_directive.MergeDirective2.from_objects(
4950
branch.repository, revision_id, time.time(),
4951
osutils.local_time_offset(), submit_branch,
4952
public_branch=public_branch, include_patch=include_patch,
4953
include_bundle=include_bundle, message=message,
4954
base_revision_id=base_revision_id)
4957
self.outf.write(directive.to_signed(branch))
4959
self.outf.writelines(directive.to_lines())
4961
message = directive.to_email(mail_to, branch, sign)
4962
s = SMTPConnection(branch.get_config())
4963
s.send_email(message)
4966
class cmd_send(Command):
4967
"""Mail or create a merge-directive for submitting changes.
4969
A merge directive provides many things needed for requesting merges:
4971
* A machine-readable description of the merge to perform
4973
* An optional patch that is a preview of the changes requested
4975
* An optional bundle of revision data, so that the changes can be applied
4976
directly from the merge directive, without retrieving data from a
4979
If --no-bundle is specified, then public_branch is needed (and must be
4980
up-to-date), so that the receiver can perform the merge using the
4981
public_branch. The public_branch is always included if known, so that
4982
people can check it later.
4984
The submit branch defaults to the parent, but can be overridden. Both
4985
submit branch and public branch will be remembered if supplied.
4987
If a public_branch is known for the submit_branch, that public submit
4988
branch is used in the merge instructions. This means that a local mirror
4989
can be used as your actual submit branch, once you have set public_branch
4992
Mail is sent using your preferred mail program. This should be transparent
4993
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4994
If the preferred client can't be found (or used), your editor will be used.
4996
To use a specific mail program, set the mail_client configuration option.
4997
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4998
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
4999
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5000
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5003
If mail is being sent, a to address is required. This can be supplied
5004
either on the commandline, by setting the submit_to configuration
5005
option in the branch itself or the child_submit_to configuration option
5006
in the submit branch.
5008
Two formats are currently supported: "4" uses revision bundle format 4 and
5009
merge directive format 2. It is significantly faster and smaller than
5010
older formats. It is compatible with Bazaar 0.19 and later. It is the
5011
default. "0.9" uses revision bundle format 0.9 and merge directive
5012
format 1. It is compatible with Bazaar 0.12 - 0.18.
5014
The merge directives created by bzr send may be applied using bzr merge or
5015
bzr pull by specifying a file containing a merge directive as the location.
5018
encoding_type = 'exact'
5020
_see_also = ['merge', 'pull']
5022
takes_args = ['submit_branch?', 'public_branch?']
5026
help='Do not include a bundle in the merge directive.'),
5027
Option('no-patch', help='Do not include a preview patch in the merge'
5030
help='Remember submit and public branch.'),
5032
help='Branch to generate the submission from, '
5033
'rather than the one containing the working directory.',
5036
Option('output', short_name='o',
5037
help='Write merge directive to this file; '
5038
'use - for stdout.',
5041
help='Refuse to send if there are uncommitted changes in'
5042
' the working tree, --no-strict disables the check.'),
5043
Option('mail-to', help='Mail the request to this address.',
5047
Option('body', help='Body for the email.', type=unicode),
5048
RegistryOption('format',
5049
help='Use the specified output format.',
5050
lazy_registry=('bzrlib.send', 'format_registry')),
5053
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5054
no_patch=False, revision=None, remember=False, output=None,
5055
format=None, mail_to=None, message=None, body=None,
5056
strict=None, **kwargs):
5057
from bzrlib.send import send
5058
return send(submit_branch, revision, public_branch, remember,
5059
format, no_bundle, no_patch, output,
5060
kwargs.get('from', '.'), mail_to, message, body,
5065
class cmd_bundle_revisions(cmd_send):
5066
"""Create a merge-directive for submitting changes.
5068
A merge directive provides many things needed for requesting merges:
5070
* A machine-readable description of the merge to perform
5072
* An optional patch that is a preview of the changes requested
5074
* An optional bundle of revision data, so that the changes can be applied
5075
directly from the merge directive, without retrieving data from a
5078
If --no-bundle is specified, then public_branch is needed (and must be
5079
up-to-date), so that the receiver can perform the merge using the
5080
public_branch. The public_branch is always included if known, so that
5081
people can check it later.
5083
The submit branch defaults to the parent, but can be overridden. Both
5084
submit branch and public branch will be remembered if supplied.
5086
If a public_branch is known for the submit_branch, that public submit
5087
branch is used in the merge instructions. This means that a local mirror
5088
can be used as your actual submit branch, once you have set public_branch
5091
Two formats are currently supported: "4" uses revision bundle format 4 and
5092
merge directive format 2. It is significantly faster and smaller than
5093
older formats. It is compatible with Bazaar 0.19 and later. It is the
5094
default. "0.9" uses revision bundle format 0.9 and merge directive
5095
format 1. It is compatible with Bazaar 0.12 - 0.18.
5100
help='Do not include a bundle in the merge directive.'),
5101
Option('no-patch', help='Do not include a preview patch in the merge'
5104
help='Remember submit and public branch.'),
5106
help='Branch to generate the submission from, '
5107
'rather than the one containing the working directory.',
5110
Option('output', short_name='o', help='Write directive to this file.',
5113
help='Refuse to bundle revisions if there are uncommitted'
5114
' changes in the working tree, --no-strict disables the check.'),
5116
RegistryOption('format',
5117
help='Use the specified output format.',
5118
lazy_registry=('bzrlib.send', 'format_registry')),
5120
aliases = ['bundle']
5122
_see_also = ['send', 'merge']
5126
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5127
no_patch=False, revision=None, remember=False, output=None,
5128
format=None, strict=None, **kwargs):
5131
from bzrlib.send import send
5132
return send(submit_branch, revision, public_branch, remember,
5133
format, no_bundle, no_patch, output,
5134
kwargs.get('from', '.'), None, None, None,
5135
self.outf, strict=strict)
5138
class cmd_tag(Command):
5139
"""Create, remove or modify a tag naming a revision.
5141
Tags give human-meaningful names to revisions. Commands that take a -r
5142
(--revision) option can be given -rtag:X, where X is any previously
5145
Tags are stored in the branch. Tags are copied from one branch to another
5146
along when you branch, push, pull or merge.
5148
It is an error to give a tag name that already exists unless you pass
5149
--force, in which case the tag is moved to point to the new revision.
5151
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5152
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5155
_see_also = ['commit', 'tags']
5156
takes_args = ['tag_name']
5159
help='Delete this tag rather than placing it.',
5162
help='Branch in which to place the tag.',
5167
help='Replace existing tags.',
5172
def run(self, tag_name,
5178
branch, relpath = Branch.open_containing(directory)
5182
branch.tags.delete_tag(tag_name)
5183
self.outf.write('Deleted tag %s.\n' % tag_name)
5186
if len(revision) != 1:
5187
raise errors.BzrCommandError(
5188
"Tags can only be placed on a single revision, "
5190
revision_id = revision[0].as_revision_id(branch)
5192
revision_id = branch.last_revision()
5193
if (not force) and branch.tags.has_tag(tag_name):
5194
raise errors.TagAlreadyExists(tag_name)
5195
branch.tags.set_tag(tag_name, revision_id)
5196
self.outf.write('Created tag %s.\n' % tag_name)
5201
class cmd_tags(Command):
5204
This command shows a table of tag names and the revisions they reference.
5210
help='Branch whose tags should be displayed.',
5214
RegistryOption.from_kwargs('sort',
5215
'Sort tags by different criteria.', title='Sorting',
5216
alpha='Sort tags lexicographically (default).',
5217
time='Sort tags chronologically.',
5230
branch, relpath = Branch.open_containing(directory)
5232
tags = branch.tags.get_tag_dict().items()
5239
graph = branch.repository.get_graph()
5240
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5241
revid1, revid2 = rev1.rev_id, rev2.rev_id
5242
# only show revisions between revid1 and revid2 (inclusive)
5243
tags = [(tag, revid) for tag, revid in tags if
5244
graph.is_between(revid, revid1, revid2)]
5247
elif sort == 'time':
5249
for tag, revid in tags:
5251
revobj = branch.repository.get_revision(revid)
5252
except errors.NoSuchRevision:
5253
timestamp = sys.maxint # place them at the end
5255
timestamp = revobj.timestamp
5256
timestamps[revid] = timestamp
5257
tags.sort(key=lambda x: timestamps[x[1]])
5259
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5260
for index, (tag, revid) in enumerate(tags):
5262
revno = branch.revision_id_to_dotted_revno(revid)
5263
if isinstance(revno, tuple):
5264
revno = '.'.join(map(str, revno))
5265
except errors.NoSuchRevision:
5266
# Bad tag data/merges can lead to tagged revisions
5267
# which are not in this branch. Fail gracefully ...
5269
tags[index] = (tag, revno)
5272
for tag, revspec in tags:
5273
self.outf.write('%-20s %s\n' % (tag, revspec))
5276
class cmd_reconfigure(Command):
5277
"""Reconfigure the type of a bzr directory.
5279
A target configuration must be specified.
5281
For checkouts, the bind-to location will be auto-detected if not specified.
5282
The order of preference is
5283
1. For a lightweight checkout, the current bound location.
5284
2. For branches that used to be checkouts, the previously-bound location.
5285
3. The push location.
5286
4. The parent location.
5287
If none of these is available, --bind-to must be specified.
5290
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5291
takes_args = ['location?']
5293
RegistryOption.from_kwargs(
5295
title='Target type',
5296
help='The type to reconfigure the directory to.',
5297
value_switches=True, enum_switch=False,
5298
branch='Reconfigure to be an unbound branch with no working tree.',
5299
tree='Reconfigure to be an unbound branch with a working tree.',
5300
checkout='Reconfigure to be a bound branch with a working tree.',
5301
lightweight_checkout='Reconfigure to be a lightweight'
5302
' checkout (with no local history).',
5303
standalone='Reconfigure to be a standalone branch '
5304
'(i.e. stop using shared repository).',
5305
use_shared='Reconfigure to use a shared repository.',
5306
with_trees='Reconfigure repository to create '
5307
'working trees on branches by default.',
5308
with_no_trees='Reconfigure repository to not create '
5309
'working trees on branches by default.'
5311
Option('bind-to', help='Branch to bind checkout to.', type=str),
5313
help='Perform reconfiguration even if local changes'
5315
Option('stacked-on',
5316
help='Reconfigure a branch to be stacked on another branch.',
5320
help='Reconfigure a branch to be unstacked. This '
5321
'may require copying substantial data into it.',
5325
def run(self, location=None, target_type=None, bind_to=None, force=False,
5328
directory = bzrdir.BzrDir.open(location)
5329
if stacked_on and unstacked:
5330
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5331
elif stacked_on is not None:
5332
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5334
reconfigure.ReconfigureUnstacked().apply(directory)
5335
# At the moment you can use --stacked-on and a different
5336
# reconfiguration shape at the same time; there seems no good reason
5338
if target_type is None:
5339
if stacked_on or unstacked:
5342
raise errors.BzrCommandError('No target configuration '
5344
elif target_type == 'branch':
5345
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5346
elif target_type == 'tree':
5347
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5348
elif target_type == 'checkout':
5349
reconfiguration = reconfigure.Reconfigure.to_checkout(
5351
elif target_type == 'lightweight-checkout':
5352
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5354
elif target_type == 'use-shared':
5355
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5356
elif target_type == 'standalone':
5357
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5358
elif target_type == 'with-trees':
5359
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5361
elif target_type == 'with-no-trees':
5362
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5364
reconfiguration.apply(force)
5367
class cmd_switch(Command):
5368
"""Set the branch of a checkout and update.
5370
For lightweight checkouts, this changes the branch being referenced.
5371
For heavyweight checkouts, this checks that there are no local commits
5372
versus the current bound branch, then it makes the local branch a mirror
5373
of the new location and binds to it.
5375
In both cases, the working tree is updated and uncommitted changes
5376
are merged. The user can commit or revert these as they desire.
5378
Pending merges need to be committed or reverted before using switch.
5380
The path to the branch to switch to can be specified relative to the parent
5381
directory of the current branch. For example, if you are currently in a
5382
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5385
Bound branches use the nickname of its master branch unless it is set
5386
locally, in which case switching will update the local nickname to be
5390
takes_args = ['to_location']
5391
takes_options = [Option('force',
5392
help='Switch even if local commits will be lost.'),
5393
Option('create-branch', short_name='b',
5394
help='Create the target branch from this one before'
5395
' switching to it.'),
5398
def run(self, to_location, force=False, create_branch=False):
5399
from bzrlib import switch
5401
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5403
branch = control_dir.open_branch()
5404
had_explicit_nick = branch.get_config().has_explicit_nickname()
5405
except errors.NotBranchError:
5407
had_explicit_nick = False
5410
raise errors.BzrCommandError('cannot create branch without'
5412
if '/' not in to_location and '\\' not in to_location:
5413
# This path is meant to be relative to the existing branch
5414
this_url = self._get_branch_location(control_dir)
5415
to_location = urlutils.join(this_url, '..', to_location)
5416
to_branch = branch.bzrdir.sprout(to_location,
5417
possible_transports=[branch.bzrdir.root_transport],
5418
source_branch=branch).open_branch()
5420
# from_branch = control_dir.open_branch()
5421
# except errors.NotBranchError:
5422
# raise BzrCommandError('Cannot create a branch from this'
5423
# ' location when we cannot open this branch')
5424
# from_branch.bzrdir.sprout(
5428
to_branch = Branch.open(to_location)
5429
except errors.NotBranchError:
5430
this_url = self._get_branch_location(control_dir)
5431
to_branch = Branch.open(
5432
urlutils.join(this_url, '..', to_location))
5433
switch.switch(control_dir, to_branch, force)
5434
if had_explicit_nick:
5435
branch = control_dir.open_branch() #get the new branch!
5436
branch.nick = to_branch.nick
5437
note('Switched to branch: %s',
5438
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5440
def _get_branch_location(self, control_dir):
5441
"""Return location of branch for this control dir."""
5443
this_branch = control_dir.open_branch()
5444
# This may be a heavy checkout, where we want the master branch
5445
master_location = this_branch.get_bound_location()
5446
if master_location is not None:
5447
return master_location
5448
# If not, use a local sibling
5449
return this_branch.base
5450
except errors.NotBranchError:
5451
format = control_dir.find_branch_format()
5452
if getattr(format, 'get_reference', None) is not None:
5453
return format.get_reference(control_dir)
5455
return control_dir.root_transport.base
5458
class cmd_view(Command):
5459
"""Manage filtered views.
5461
Views provide a mask over the tree so that users can focus on
5462
a subset of a tree when doing their work. After creating a view,
5463
commands that support a list of files - status, diff, commit, etc -
5464
effectively have that list of files implicitly given each time.
5465
An explicit list of files can still be given but those files
5466
must be within the current view.
5468
In most cases, a view has a short life-span: it is created to make
5469
a selected change and is deleted once that change is committed.
5470
At other times, you may wish to create one or more named views
5471
and switch between them.
5473
To disable the current view without deleting it, you can switch to
5474
the pseudo view called ``off``. This can be useful when you need
5475
to see the whole tree for an operation or two (e.g. merge) but
5476
want to switch back to your view after that.
5479
To define the current view::
5481
bzr view file1 dir1 ...
5483
To list the current view::
5487
To delete the current view::
5491
To disable the current view without deleting it::
5493
bzr view --switch off
5495
To define a named view and switch to it::
5497
bzr view --name view-name file1 dir1 ...
5499
To list a named view::
5501
bzr view --name view-name
5503
To delete a named view::
5505
bzr view --name view-name --delete
5507
To switch to a named view::
5509
bzr view --switch view-name
5511
To list all views defined::
5515
To delete all views::
5517
bzr view --delete --all
5521
takes_args = ['file*']
5524
help='Apply list or delete action to all views.',
5527
help='Delete the view.',
5530
help='Name of the view to define, list or delete.',
5534
help='Name of the view to switch to.',
5539
def run(self, file_list,
5545
tree, file_list = tree_files(file_list, apply_view=False)
5546
current_view, view_dict = tree.views.get_view_info()
5551
raise errors.BzrCommandError(
5552
"Both --delete and a file list specified")
5554
raise errors.BzrCommandError(
5555
"Both --delete and --switch specified")
5557
tree.views.set_view_info(None, {})
5558
self.outf.write("Deleted all views.\n")
5560
raise errors.BzrCommandError("No current view to delete")
5562
tree.views.delete_view(name)
5563
self.outf.write("Deleted '%s' view.\n" % name)
5566
raise errors.BzrCommandError(
5567
"Both --switch and a file list specified")
5569
raise errors.BzrCommandError(
5570
"Both --switch and --all specified")
5571
elif switch == 'off':
5572
if current_view is None:
5573
raise errors.BzrCommandError("No current view to disable")
5574
tree.views.set_view_info(None, view_dict)
5575
self.outf.write("Disabled '%s' view.\n" % (current_view))
5577
tree.views.set_view_info(switch, view_dict)
5578
view_str = views.view_display_str(tree.views.lookup_view())
5579
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5582
self.outf.write('Views defined:\n')
5583
for view in sorted(view_dict):
5584
if view == current_view:
5588
view_str = views.view_display_str(view_dict[view])
5589
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5591
self.outf.write('No views defined.\n')
5594
# No name given and no current view set
5597
raise errors.BzrCommandError(
5598
"Cannot change the 'off' pseudo view")
5599
tree.views.set_view(name, sorted(file_list))
5600
view_str = views.view_display_str(tree.views.lookup_view())
5601
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5605
# No name given and no current view set
5606
self.outf.write('No current view.\n')
5608
view_str = views.view_display_str(tree.views.lookup_view(name))
5609
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5612
class cmd_hooks(Command):
5618
for hook_key in sorted(hooks.known_hooks.keys()):
5619
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5620
self.outf.write("%s:\n" % type(some_hooks).__name__)
5621
for hook_name, hook_point in sorted(some_hooks.items()):
5622
self.outf.write(" %s:\n" % (hook_name,))
5623
found_hooks = list(hook_point)
5625
for hook in found_hooks:
5626
self.outf.write(" %s\n" %
5627
(some_hooks.get_hook_name(hook),))
5629
self.outf.write(" <no hooks installed>\n")
5632
class cmd_shelve(Command):
5633
"""Temporarily set aside some changes from the current tree.
5635
Shelve allows you to temporarily put changes you've made "on the shelf",
5636
ie. out of the way, until a later time when you can bring them back from
5637
the shelf with the 'unshelve' command. The changes are stored alongside
5638
your working tree, and so they aren't propagated along with your branch nor
5639
will they survive its deletion.
5641
If shelve --list is specified, previously-shelved changes are listed.
5643
Shelve is intended to help separate several sets of changes that have
5644
been inappropriately mingled. If you just want to get rid of all changes
5645
and you don't need to restore them later, use revert. If you want to
5646
shelve all text changes at once, use shelve --all.
5648
If filenames are specified, only the changes to those files will be
5649
shelved. Other files will be left untouched.
5651
If a revision is specified, changes since that revision will be shelved.
5653
You can put multiple items on the shelf, and by default, 'unshelve' will
5654
restore the most recently shelved changes.
5657
takes_args = ['file*']
5661
Option('all', help='Shelve all changes.'),
5663
RegistryOption('writer', 'Method to use for writing diffs.',
5664
bzrlib.option.diff_writer_registry,
5665
value_switches=True, enum_switch=False),
5667
Option('list', help='List shelved changes.'),
5669
help='Destroy removed changes instead of shelving them.'),
5671
_see_also = ['unshelve']
5673
def run(self, revision=None, all=False, file_list=None, message=None,
5674
writer=None, list=False, destroy=False):
5676
return self.run_for_list()
5677
from bzrlib.shelf_ui import Shelver
5679
writer = bzrlib.option.diff_writer_registry.get()
5681
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5682
file_list, message, destroy=destroy)
5687
except errors.UserAbort:
5690
def run_for_list(self):
5691
tree = WorkingTree.open_containing('.')[0]
5694
manager = tree.get_shelf_manager()
5695
shelves = manager.active_shelves()
5696
if len(shelves) == 0:
5697
note('No shelved changes.')
5699
for shelf_id in reversed(shelves):
5700
message = manager.get_metadata(shelf_id).get('message')
5702
message = '<no message>'
5703
self.outf.write('%3d: %s\n' % (shelf_id, message))
5709
class cmd_unshelve(Command):
5710
"""Restore shelved changes.
5712
By default, the most recently shelved changes are restored. However if you
5713
specify a shelf by id those changes will be restored instead. This works
5714
best when the changes don't depend on each other.
5717
takes_args = ['shelf_id?']
5719
RegistryOption.from_kwargs(
5720
'action', help="The action to perform.",
5721
enum_switch=False, value_switches=True,
5722
apply="Apply changes and remove from the shelf.",
5723
dry_run="Show changes, but do not apply or remove them.",
5724
delete_only="Delete changes without applying them."
5727
_see_also = ['shelve']
5729
def run(self, shelf_id=None, action='apply'):
5730
from bzrlib.shelf_ui import Unshelver
5731
unshelver = Unshelver.from_args(shelf_id, action)
5735
unshelver.tree.unlock()
5738
class cmd_clean_tree(Command):
5739
"""Remove unwanted files from working tree.
5741
By default, only unknown files, not ignored files, are deleted. Versioned
5742
files are never deleted.
5744
Another class is 'detritus', which includes files emitted by bzr during
5745
normal operations and selftests. (The value of these files decreases with
5748
If no options are specified, unknown files are deleted. Otherwise, option
5749
flags are respected, and may be combined.
5751
To check what clean-tree will do, use --dry-run.
5753
takes_options = [Option('ignored', help='Delete all ignored files.'),
5754
Option('detritus', help='Delete conflict files, merge'
5755
' backups, and failed selftest dirs.'),
5757
help='Delete files unknown to bzr (default).'),
5758
Option('dry-run', help='Show files to delete instead of'
5760
Option('force', help='Do not prompt before deleting.')]
5761
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5763
from bzrlib.clean_tree import clean_tree
5764
if not (unknown or ignored or detritus):
5768
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5769
dry_run=dry_run, no_prompt=force)
5772
class cmd_reference(Command):
5773
"""list, view and set branch locations for nested trees.
5775
If no arguments are provided, lists the branch locations for nested trees.
5776
If one argument is provided, display the branch location for that tree.
5777
If two arguments are provided, set the branch location for that tree.
5782
takes_args = ['path?', 'location?']
5784
def run(self, path=None, location=None):
5786
if path is not None:
5788
tree, branch, relpath =(
5789
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5790
if path is not None:
5793
tree = branch.basis_tree()
5795
info = branch._get_all_reference_info().iteritems()
5796
self._display_reference_info(tree, branch, info)
5798
file_id = tree.path2id(path)
5800
raise errors.NotVersionedError(path)
5801
if location is None:
5802
info = [(file_id, branch.get_reference_info(file_id))]
5803
self._display_reference_info(tree, branch, info)
5805
branch.set_reference_info(file_id, path, location)
5807
def _display_reference_info(self, tree, branch, info):
5809
for file_id, (path, location) in info:
5811
path = tree.id2path(file_id)
5812
except errors.NoSuchId:
5814
ref_list.append((path, location))
5815
for path, location in sorted(ref_list):
5816
self.outf.write('%s %s\n' % (path, location))
5819
# these get imported and then picked up by the scan for cmd_*
5820
# TODO: Some more consistent way to split command definitions across files;
5821
# we do need to load at least some information about them to know of
5822
# aliases. ideally we would avoid loading the implementation until the
5823
# details were needed.
5824
from bzrlib.cmd_version_info import cmd_version_info
5825
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5826
from bzrlib.bundle.commands import (
5829
from bzrlib.foreign import cmd_dpush
5830
from bzrlib.sign_my_commits import cmd_sign_my_commits
5831
from bzrlib.weave_commands import cmd_versionedfile_list, \
5832
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
