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,
54
from bzrlib.branch import Branch
55
from bzrlib.conflicts import ConflictList
56
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
57
from bzrlib.smtp_connection import SMTPConnection
58
from bzrlib.workingtree import WorkingTree
61
from bzrlib.commands import Command, display_command
62
from bzrlib.option import (
69
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
72
def tree_files(file_list, default_branch=u'.', canonicalize=True,
75
return internal_tree_files(file_list, default_branch, canonicalize,
77
except errors.FileInWrongBranch, e:
78
raise errors.BzrCommandError("%s is not in the same branch as %s" %
79
(e.path, file_list[0]))
82
def tree_files_for_add(file_list):
84
Return a tree and list of absolute paths from a file list.
86
Similar to tree_files, but add handles files a bit differently, so it a
87
custom implementation. In particular, MutableTreeTree.smart_add expects
88
absolute paths, which it immediately converts to relative paths.
90
# FIXME Would be nice to just return the relative paths like
91
# internal_tree_files does, but there are a large number of unit tests
92
# that assume the current interface to mutabletree.smart_add
94
tree, relpath = WorkingTree.open_containing(file_list[0])
95
if tree.supports_views():
96
view_files = tree.views.lookup_view()
98
for filename in file_list:
99
if not osutils.is_inside_any(view_files, filename):
100
raise errors.FileOutsideView(filename, view_files)
101
file_list = file_list[:]
102
file_list[0] = tree.abspath(relpath)
104
tree = WorkingTree.open_containing(u'.')[0]
105
if tree.supports_views():
106
view_files = tree.views.lookup_view()
108
file_list = view_files
109
view_str = views.view_display_str(view_files)
110
note("Ignoring files outside view. View is %s" % view_str)
111
return tree, file_list
114
def _get_one_revision(command_name, revisions):
115
if revisions is None:
117
if len(revisions) != 1:
118
raise errors.BzrCommandError(
119
'bzr %s --revision takes exactly one revision identifier' % (
124
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
125
"""Get a revision tree. Not suitable for commands that change the tree.
127
Specifically, the basis tree in dirstate trees is coupled to the dirstate
128
and doing a commit/uncommit/pull will at best fail due to changing the
131
If tree is passed in, it should be already locked, for lifetime management
132
of the trees internal cached state.
136
if revisions is None:
138
rev_tree = tree.basis_tree()
140
rev_tree = branch.basis_tree()
142
revision = _get_one_revision(command_name, revisions)
143
rev_tree = revision.as_tree(branch)
147
# XXX: Bad function name; should possibly also be a class method of
148
# WorkingTree rather than a function.
149
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
151
"""Convert command-line paths to a WorkingTree and relative paths.
153
This is typically used for command-line processors that take one or
154
more filenames, and infer the workingtree that contains them.
156
The filenames given are not required to exist.
158
:param file_list: Filenames to convert.
160
:param default_branch: Fallback tree path to use if file_list is empty or
163
:param apply_view: if True and a view is set, apply it or check that
164
specified files are within it
166
:return: workingtree, [relative_paths]
168
if file_list is None or len(file_list) == 0:
169
tree = WorkingTree.open_containing(default_branch)[0]
170
if tree.supports_views() and apply_view:
171
view_files = tree.views.lookup_view()
173
file_list = view_files
174
view_str = views.view_display_str(view_files)
175
note("Ignoring files outside view. View is %s" % view_str)
176
return tree, file_list
177
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
178
return tree, safe_relpath_files(tree, file_list, canonicalize,
179
apply_view=apply_view)
182
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
183
"""Convert file_list into a list of relpaths in tree.
185
:param tree: A tree to operate on.
186
:param file_list: A list of user provided paths or None.
187
:param apply_view: if True and a view is set, apply it or check that
188
specified files are within it
189
:return: A list of relative paths.
190
:raises errors.PathNotChild: When a provided path is in a different tree
193
if file_list is None:
195
if tree.supports_views() and apply_view:
196
view_files = tree.views.lookup_view()
200
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
201
# doesn't - fix that up here before we enter the loop.
203
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
206
for filename in file_list:
208
relpath = fixer(osutils.dereference_path(filename))
209
if view_files and not osutils.is_inside_any(view_files, relpath):
210
raise errors.FileOutsideView(filename, view_files)
211
new_list.append(relpath)
212
except errors.PathNotChild:
213
raise errors.FileInWrongBranch(tree.branch, filename)
217
def _get_view_info_for_change_reporter(tree):
218
"""Get the view information from a tree for change reporting."""
221
current_view = tree.views.get_view_info()[0]
222
if current_view is not None:
223
view_info = (current_view, tree.views.lookup_view())
224
except errors.ViewsNotSupported:
229
# TODO: Make sure no commands unconditionally use the working directory as a
230
# branch. If a filename argument is used, the first of them should be used to
231
# specify the branch. (Perhaps this can be factored out into some kind of
232
# Argument class, representing a file in a branch, where the first occurrence
235
class cmd_status(Command):
236
"""Display status summary.
238
This reports on versioned and unknown files, reporting them
239
grouped by state. Possible states are:
242
Versioned in the working copy but not in the previous revision.
245
Versioned in the previous revision but removed or deleted
249
Path of this file changed from the previous revision;
250
the text may also have changed. This includes files whose
251
parent directory was renamed.
254
Text has changed since the previous revision.
257
File kind has been changed (e.g. from file to directory).
260
Not versioned and not matching an ignore pattern.
262
Additionally for directories, symlinks and files with an executable
263
bit, Bazaar indicates their type using a trailing character: '/', '@'
266
To see ignored files use 'bzr ignored'. For details on the
267
changes to file texts, use 'bzr diff'.
269
Note that --short or -S gives status flags for each item, similar
270
to Subversion's status command. To get output similar to svn -q,
273
If no arguments are specified, the status of the entire working
274
directory is shown. Otherwise, only the status of the specified
275
files or directories is reported. If a directory is given, status
276
is reported for everything inside that directory.
278
Before merges are committed, the pending merge tip revisions are
279
shown. To see all pending merge revisions, use the -v option.
280
To skip the display of pending merge information altogether, use
281
the no-pending option or specify a file/directory.
283
If a revision argument is given, the status is calculated against
284
that revision, or between two revisions if two are provided.
287
# TODO: --no-recurse, --recurse options
289
takes_args = ['file*']
290
takes_options = ['show-ids', 'revision', 'change', 'verbose',
291
Option('short', help='Use short status indicators.',
293
Option('versioned', help='Only show versioned files.',
295
Option('no-pending', help='Don\'t show pending merges.',
298
aliases = ['st', 'stat']
300
encoding_type = 'replace'
301
_see_also = ['diff', 'revert', 'status-flags']
304
def run(self, show_ids=False, file_list=None, revision=None, short=False,
305
versioned=False, no_pending=False, verbose=False):
306
from bzrlib.status import show_tree_status
308
if revision and len(revision) > 2:
309
raise errors.BzrCommandError('bzr status --revision takes exactly'
310
' one or two revision specifiers')
312
tree, relfile_list = tree_files(file_list)
313
# Avoid asking for specific files when that is not needed.
314
if relfile_list == ['']:
316
# Don't disable pending merges for full trees other than '.'.
317
if file_list == ['.']:
319
# A specific path within a tree was given.
320
elif relfile_list is not None:
322
show_tree_status(tree, show_ids=show_ids,
323
specific_files=relfile_list, revision=revision,
324
to_file=self.outf, short=short, versioned=versioned,
325
show_pending=(not no_pending), verbose=verbose)
328
class cmd_cat_revision(Command):
329
"""Write out metadata for a revision.
331
The revision to print can either be specified by a specific
332
revision identifier, or you can use --revision.
336
takes_args = ['revision_id?']
337
takes_options = ['revision']
338
# cat-revision is more for frontends so should be exact
342
def run(self, revision_id=None, revision=None):
343
if revision_id is not None and revision is not None:
344
raise errors.BzrCommandError('You can only supply one of'
345
' revision_id or --revision')
346
if revision_id is None and revision is None:
347
raise errors.BzrCommandError('You must supply either'
348
' --revision or a revision_id')
349
b = WorkingTree.open_containing(u'.')[0].branch
351
# TODO: jam 20060112 should cat-revision always output utf-8?
352
if revision_id is not None:
353
revision_id = osutils.safe_revision_id(revision_id, warn=False)
355
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
356
except errors.NoSuchRevision:
357
msg = "The repository %s contains no revision %s." % (b.repository.base,
359
raise errors.BzrCommandError(msg)
360
elif revision is not None:
363
raise errors.BzrCommandError('You cannot specify a NULL'
365
rev_id = rev.as_revision_id(b)
366
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
369
class cmd_dump_btree(Command):
370
"""Dump the contents of a btree index file to stdout.
372
PATH is a btree index file, it can be any URL. This includes things like
373
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
375
By default, the tuples stored in the index file will be displayed. With
376
--raw, we will uncompress the pages, but otherwise display the raw bytes
380
# TODO: Do we want to dump the internal nodes as well?
381
# TODO: It would be nice to be able to dump the un-parsed information,
382
# rather than only going through iter_all_entries. However, this is
383
# good enough for a start
385
encoding_type = 'exact'
386
takes_args = ['path']
387
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
388
' rather than the parsed tuples.'),
391
def run(self, path, raw=False):
392
dirname, basename = osutils.split(path)
393
t = transport.get_transport(dirname)
395
self._dump_raw_bytes(t, basename)
397
self._dump_entries(t, basename)
399
def _get_index_and_bytes(self, trans, basename):
400
"""Create a BTreeGraphIndex and raw bytes."""
401
bt = btree_index.BTreeGraphIndex(trans, basename, None)
402
bytes = trans.get_bytes(basename)
403
bt._file = cStringIO.StringIO(bytes)
404
bt._size = len(bytes)
407
def _dump_raw_bytes(self, trans, basename):
410
# We need to parse at least the root node.
411
# This is because the first page of every row starts with an
412
# uncompressed header.
413
bt, bytes = self._get_index_and_bytes(trans, basename)
414
for page_idx, page_start in enumerate(xrange(0, len(bytes),
415
btree_index._PAGE_SIZE)):
416
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
417
page_bytes = bytes[page_start:page_end]
419
self.outf.write('Root node:\n')
420
header_end, data = bt._parse_header_from_bytes(page_bytes)
421
self.outf.write(page_bytes[:header_end])
423
self.outf.write('\nPage %d\n' % (page_idx,))
424
decomp_bytes = zlib.decompress(page_bytes)
425
self.outf.write(decomp_bytes)
426
self.outf.write('\n')
428
def _dump_entries(self, trans, basename):
430
st = trans.stat(basename)
431
except errors.TransportNotPossible:
432
# We can't stat, so we'll fake it because we have to do the 'get()'
434
bt, _ = self._get_index_and_bytes(trans, basename)
436
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
437
for node in bt.iter_all_entries():
438
# Node is made up of:
439
# (index, key, value, [references])
440
refs_as_tuples = static_tuple.as_tuples(node[3])
441
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
442
self.outf.write('%s\n' % (as_tuple,))
445
class cmd_remove_tree(Command):
446
"""Remove the working tree from a given branch/checkout.
448
Since a lightweight checkout is little more than a working tree
449
this will refuse to run against one.
451
To re-create the working tree, use "bzr checkout".
453
_see_also = ['checkout', 'working-trees']
454
takes_args = ['location?']
457
help='Remove the working tree even if it has '
458
'uncommitted changes.'),
461
def run(self, location='.', force=False):
462
d = bzrdir.BzrDir.open(location)
465
working = d.open_workingtree()
466
except errors.NoWorkingTree:
467
raise errors.BzrCommandError("No working tree to remove")
468
except errors.NotLocalUrl:
469
raise errors.BzrCommandError("You cannot remove the working tree"
472
if (working.has_changes()):
473
raise errors.UncommittedChanges(working)
475
working_path = working.bzrdir.root_transport.base
476
branch_path = working.branch.bzrdir.root_transport.base
477
if working_path != branch_path:
478
raise errors.BzrCommandError("You cannot remove the working tree"
479
" from a lightweight checkout")
481
d.destroy_workingtree()
484
class cmd_revno(Command):
485
"""Show current revision number.
487
This is equal to the number of revisions on this branch.
491
takes_args = ['location?']
493
Option('tree', help='Show revno of working tree'),
497
def run(self, tree=False, location=u'.'):
500
wt = WorkingTree.open_containing(location)[0]
502
except (errors.NoWorkingTree, errors.NotLocalUrl):
503
raise errors.NoWorkingTree(location)
505
revid = wt.last_revision()
507
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
508
except errors.NoSuchRevision:
510
revno = ".".join(str(n) for n in revno_t)
514
b = Branch.open_containing(location)[0]
521
self.outf.write(str(revno) + '\n')
524
class cmd_revision_info(Command):
525
"""Show revision number and revision id for a given revision identifier.
528
takes_args = ['revision_info*']
532
help='Branch to examine, '
533
'rather than the one containing the working directory.',
537
Option('tree', help='Show revno of working tree'),
541
def run(self, revision=None, directory=u'.', tree=False,
542
revision_info_list=[]):
545
wt = WorkingTree.open_containing(directory)[0]
548
except (errors.NoWorkingTree, errors.NotLocalUrl):
550
b = Branch.open_containing(directory)[0]
554
if revision is not None:
555
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
556
if revision_info_list is not None:
557
for rev_str in revision_info_list:
558
rev_spec = RevisionSpec.from_string(rev_str)
559
revision_ids.append(rev_spec.as_revision_id(b))
560
# No arguments supplied, default to the last revision
561
if len(revision_ids) == 0:
564
raise errors.NoWorkingTree(directory)
565
revision_ids.append(wt.last_revision())
567
revision_ids.append(b.last_revision())
571
for revision_id in revision_ids:
573
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
574
revno = '.'.join(str(i) for i in dotted_revno)
575
except errors.NoSuchRevision:
577
maxlen = max(maxlen, len(revno))
578
revinfos.append([revno, revision_id])
586
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
589
class cmd_add(Command):
590
"""Add specified files or directories.
592
In non-recursive mode, all the named items are added, regardless
593
of whether they were previously ignored. A warning is given if
594
any of the named files are already versioned.
596
In recursive mode (the default), files are treated the same way
597
but the behaviour for directories is different. Directories that
598
are already versioned do not give a warning. All directories,
599
whether already versioned or not, are searched for files or
600
subdirectories that are neither versioned or ignored, and these
601
are added. This search proceeds recursively into versioned
602
directories. If no names are given '.' is assumed.
604
Therefore simply saying 'bzr add' will version all files that
605
are currently unknown.
607
Adding a file whose parent directory is not versioned will
608
implicitly add the parent, and so on up to the root. This means
609
you should never need to explicitly add a directory, they'll just
610
get added when you add a file in the directory.
612
--dry-run will show which files would be added, but not actually
615
--file-ids-from will try to use the file ids from the supplied path.
616
It looks up ids trying to find a matching parent directory with the
617
same filename, and then by pure path. This option is rarely needed
618
but can be useful when adding the same logical file into two
619
branches that will be merged later (without showing the two different
620
adds as a conflict). It is also useful when merging another project
621
into a subdirectory of this one.
623
Any files matching patterns in the ignore list will not be added
624
unless they are explicitly mentioned.
626
takes_args = ['file*']
629
help="Don't recursively add the contents of directories."),
631
help="Show what would be done, but don't actually do anything."),
633
Option('file-ids-from',
635
help='Lookup file ids from this tree.'),
637
encoding_type = 'replace'
638
_see_also = ['remove', 'ignore']
640
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
645
if file_ids_from is not None:
647
base_tree, base_path = WorkingTree.open_containing(
649
except errors.NoWorkingTree:
650
base_branch, base_path = Branch.open_containing(
652
base_tree = base_branch.basis_tree()
654
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
655
to_file=self.outf, should_print=(not is_quiet()))
657
action = bzrlib.add.AddAction(to_file=self.outf,
658
should_print=(not is_quiet()))
661
base_tree.lock_read()
663
tree, file_list = tree_files_for_add(file_list)
664
added, ignored = tree.smart_add(file_list, not
665
no_recurse, action=action, save=not dry_run)
667
if base_tree is not None:
671
for glob in sorted(ignored.keys()):
672
for path in ignored[glob]:
673
self.outf.write("ignored %s matching \"%s\"\n"
677
class cmd_mkdir(Command):
678
"""Create a new versioned directory.
680
This is equivalent to creating the directory and then adding it.
683
takes_args = ['dir+']
684
encoding_type = 'replace'
686
def run(self, dir_list):
689
wt, dd = WorkingTree.open_containing(d)
691
self.outf.write('added %s\n' % d)
694
class cmd_relpath(Command):
695
"""Show path of a file relative to root"""
697
takes_args = ['filename']
701
def run(self, filename):
702
# TODO: jam 20050106 Can relpath return a munged path if
703
# sys.stdout encoding cannot represent it?
704
tree, relpath = WorkingTree.open_containing(filename)
705
self.outf.write(relpath)
706
self.outf.write('\n')
709
class cmd_inventory(Command):
710
"""Show inventory of the current working copy or a revision.
712
It is possible to limit the output to a particular entry
713
type using the --kind option. For example: --kind file.
715
It is also possible to restrict the list of files to a specific
716
set. For example: bzr inventory --show-ids this/file
725
help='List entries of a particular kind: file, directory, symlink.',
728
takes_args = ['file*']
731
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
732
if kind and kind not in ['file', 'directory', 'symlink']:
733
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
735
revision = _get_one_revision('inventory', revision)
736
work_tree, file_list = tree_files(file_list)
737
work_tree.lock_read()
739
if revision is not None:
740
tree = revision.as_tree(work_tree.branch)
742
extra_trees = [work_tree]
748
if file_list is not None:
749
file_ids = tree.paths2ids(file_list, trees=extra_trees,
750
require_versioned=True)
751
# find_ids_across_trees may include some paths that don't
753
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
754
for file_id in file_ids if file_id in tree)
756
entries = tree.inventory.entries()
759
if tree is not work_tree:
762
for path, entry in entries:
763
if kind and kind != entry.kind:
766
self.outf.write('%-50s %s\n' % (path, entry.file_id))
768
self.outf.write(path)
769
self.outf.write('\n')
772
class cmd_mv(Command):
773
"""Move or rename a file.
776
bzr mv OLDNAME NEWNAME
778
bzr mv SOURCE... DESTINATION
780
If the last argument is a versioned directory, all the other names
781
are moved into it. Otherwise, there must be exactly two arguments
782
and the file is changed to a new name.
784
If OLDNAME does not exist on the filesystem but is versioned and
785
NEWNAME does exist on the filesystem but is not versioned, mv
786
assumes that the file has been manually moved and only updates
787
its internal inventory to reflect that change.
788
The same is valid when moving many SOURCE files to a DESTINATION.
790
Files cannot be moved between branches.
793
takes_args = ['names*']
794
takes_options = [Option("after", help="Move only the bzr identifier"
795
" of the file, because the file has already been moved."),
796
Option('auto', help='Automatically guess renames.'),
797
Option('dry-run', help='Avoid making changes when guessing renames.'),
799
aliases = ['move', 'rename']
800
encoding_type = 'replace'
802
def run(self, names_list, after=False, auto=False, dry_run=False):
804
return self.run_auto(names_list, after, dry_run)
806
raise errors.BzrCommandError('--dry-run requires --auto.')
807
if names_list is None:
809
if len(names_list) < 2:
810
raise errors.BzrCommandError("missing file argument")
811
tree, rel_names = tree_files(names_list, canonicalize=False)
812
tree.lock_tree_write()
814
self._run(tree, names_list, rel_names, after)
818
def run_auto(self, names_list, after, dry_run):
819
if names_list is not None and len(names_list) > 1:
820
raise errors.BzrCommandError('Only one path may be specified to'
823
raise errors.BzrCommandError('--after cannot be specified with'
825
work_tree, file_list = tree_files(names_list, default_branch='.')
826
work_tree.lock_tree_write()
828
rename_map.RenameMap.guess_renames(work_tree, dry_run)
832
def _run(self, tree, names_list, rel_names, after):
833
into_existing = osutils.isdir(names_list[-1])
834
if into_existing and len(names_list) == 2:
836
# a. case-insensitive filesystem and change case of dir
837
# b. move directory after the fact (if the source used to be
838
# a directory, but now doesn't exist in the working tree
839
# and the target is an existing directory, just rename it)
840
if (not tree.case_sensitive
841
and rel_names[0].lower() == rel_names[1].lower()):
842
into_existing = False
845
# 'fix' the case of a potential 'from'
846
from_id = tree.path2id(
847
tree.get_canonical_inventory_path(rel_names[0]))
848
if (not osutils.lexists(names_list[0]) and
849
from_id and inv.get_file_kind(from_id) == "directory"):
850
into_existing = False
853
# move into existing directory
854
# All entries reference existing inventory items, so fix them up
855
# for cicp file-systems.
856
rel_names = tree.get_canonical_inventory_paths(rel_names)
857
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
859
self.outf.write("%s => %s\n" % (src, dest))
861
if len(names_list) != 2:
862
raise errors.BzrCommandError('to mv multiple files the'
863
' destination must be a versioned'
866
# for cicp file-systems: the src references an existing inventory
868
src = tree.get_canonical_inventory_path(rel_names[0])
869
# Find the canonical version of the destination: In all cases, the
870
# parent of the target must be in the inventory, so we fetch the
871
# canonical version from there (we do not always *use* the
872
# canonicalized tail portion - we may be attempting to rename the
874
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
875
dest_parent = osutils.dirname(canon_dest)
876
spec_tail = osutils.basename(rel_names[1])
877
# For a CICP file-system, we need to avoid creating 2 inventory
878
# entries that differ only by case. So regardless of the case
879
# we *want* to use (ie, specified by the user or the file-system),
880
# we must always choose to use the case of any existing inventory
881
# items. The only exception to this is when we are attempting a
882
# case-only rename (ie, canonical versions of src and dest are
884
dest_id = tree.path2id(canon_dest)
885
if dest_id is None or tree.path2id(src) == dest_id:
886
# No existing item we care about, so work out what case we
887
# are actually going to use.
889
# If 'after' is specified, the tail must refer to a file on disk.
891
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
893
# pathjoin with an empty tail adds a slash, which breaks
895
dest_parent_fq = tree.basedir
897
dest_tail = osutils.canonical_relpath(
899
osutils.pathjoin(dest_parent_fq, spec_tail))
901
# not 'after', so case as specified is used
902
dest_tail = spec_tail
904
# Use the existing item so 'mv' fails with AlreadyVersioned.
905
dest_tail = os.path.basename(canon_dest)
906
dest = osutils.pathjoin(dest_parent, dest_tail)
907
mutter("attempting to move %s => %s", src, dest)
908
tree.rename_one(src, dest, after=after)
910
self.outf.write("%s => %s\n" % (src, dest))
913
class cmd_pull(Command):
914
"""Turn this branch into a mirror of another branch.
916
By default, this command only works on branches that have not diverged.
917
Branches are considered diverged if the destination branch's most recent
918
commit is one that has not been merged (directly or indirectly) into the
921
If branches have diverged, you can use 'bzr merge' to integrate the changes
922
from one into the other. Once one branch has merged, the other should
923
be able to pull it again.
925
If you want to replace your local changes and just want your branch to
926
match the remote one, use pull --overwrite. This will work even if the two
927
branches have diverged.
929
If there is no default location set, the first pull will set it. After
930
that, you can omit the location to use the default. To change the
931
default, use --remember. The value will only be saved if the remote
932
location can be accessed.
934
Note: The location can be specified either in the form of a branch,
935
or in the form of a path to a file containing a merge directive generated
939
_see_also = ['push', 'update', 'status-flags', 'send']
940
takes_options = ['remember', 'overwrite', 'revision',
941
custom_help('verbose',
942
help='Show logs of pulled revisions.'),
944
help='Branch to pull into, '
945
'rather than the one containing the working directory.',
950
help="Perform a local pull in a bound "
951
"branch. Local pulls are not applied to "
955
takes_args = ['location?']
956
encoding_type = 'replace'
958
def run(self, location=None, remember=False, overwrite=False,
959
revision=None, verbose=False,
960
directory=None, local=False):
961
# FIXME: too much stuff is in the command class
964
if directory is None:
967
tree_to = WorkingTree.open_containing(directory)[0]
968
branch_to = tree_to.branch
969
except errors.NoWorkingTree:
971
branch_to = Branch.open_containing(directory)[0]
973
if local and not branch_to.get_bound_location():
974
raise errors.LocalRequiresBoundBranch()
976
possible_transports = []
977
if location is not None:
979
mergeable = bundle.read_mergeable_from_url(location,
980
possible_transports=possible_transports)
981
except errors.NotABundle:
984
stored_loc = branch_to.get_parent()
986
if stored_loc is None:
987
raise errors.BzrCommandError("No pull location known or"
990
display_url = urlutils.unescape_for_display(stored_loc,
993
self.outf.write("Using saved parent location: %s\n" % display_url)
994
location = stored_loc
996
revision = _get_one_revision('pull', revision)
997
if mergeable is not None:
998
if revision is not None:
999
raise errors.BzrCommandError(
1000
'Cannot use -r with merge directives or bundles')
1001
mergeable.install_revisions(branch_to.repository)
1002
base_revision_id, revision_id, verified = \
1003
mergeable.get_merge_request(branch_to.repository)
1004
branch_from = branch_to
1006
branch_from = Branch.open(location,
1007
possible_transports=possible_transports)
1009
if branch_to.get_parent() is None or remember:
1010
branch_to.set_parent(branch_from.base)
1012
if branch_from is not branch_to:
1013
branch_from.lock_read()
1015
if revision is not None:
1016
revision_id = revision.as_revision_id(branch_from)
1018
branch_to.lock_write()
1020
if tree_to is not None:
1021
view_info = _get_view_info_for_change_reporter(tree_to)
1022
change_reporter = delta._ChangeReporter(
1023
unversioned_filter=tree_to.is_ignored,
1024
view_info=view_info)
1025
result = tree_to.pull(
1026
branch_from, overwrite, revision_id, change_reporter,
1027
possible_transports=possible_transports, local=local)
1029
result = branch_to.pull(
1030
branch_from, overwrite, revision_id, local=local)
1032
result.report(self.outf)
1033
if verbose and result.old_revid != result.new_revid:
1034
log.show_branch_change(
1035
branch_to, self.outf, result.old_revno,
1040
if branch_from is not branch_to:
1041
branch_from.unlock()
1044
class cmd_push(Command):
1045
"""Update a mirror of this branch.
1047
The target branch will not have its working tree populated because this
1048
is both expensive, and is not supported on remote file systems.
1050
Some smart servers or protocols *may* put the working tree in place in
1053
This command only works on branches that have not diverged. Branches are
1054
considered diverged if the destination branch's most recent commit is one
1055
that has not been merged (directly or indirectly) by the source branch.
1057
If branches have diverged, you can use 'bzr push --overwrite' to replace
1058
the other branch completely, discarding its unmerged changes.
1060
If you want to ensure you have the different changes in the other branch,
1061
do a merge (see bzr help merge) from the other branch, and commit that.
1062
After that you will be able to do a push without '--overwrite'.
1064
If there is no default push location set, the first push will set it.
1065
After that, you can omit the location to use the default. To change the
1066
default, use --remember. The value will only be saved if the remote
1067
location can be accessed.
1070
_see_also = ['pull', 'update', 'working-trees']
1071
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1072
Option('create-prefix',
1073
help='Create the path leading up to the branch '
1074
'if it does not already exist.'),
1076
help='Branch to push from, '
1077
'rather than the one containing the working directory.',
1081
Option('use-existing-dir',
1082
help='By default push will fail if the target'
1083
' directory exists, but does not already'
1084
' have a control directory. This flag will'
1085
' allow push to proceed.'),
1087
help='Create a stacked branch that references the public location '
1088
'of the parent branch.'),
1089
Option('stacked-on',
1090
help='Create a stacked branch that refers to another branch '
1091
'for the commit history. Only the work not present in the '
1092
'referenced branch is included in the branch created.',
1095
help='Refuse to push if there are uncommitted changes in'
1096
' the working tree, --no-strict disables the check.'),
1098
takes_args = ['location?']
1099
encoding_type = 'replace'
1101
def run(self, location=None, remember=False, overwrite=False,
1102
create_prefix=False, verbose=False, revision=None,
1103
use_existing_dir=False, directory=None, stacked_on=None,
1104
stacked=False, strict=None):
1105
from bzrlib.push import _show_push_branch
1107
if directory is None:
1109
# Get the source branch
1111
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1113
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1114
if strict is None: strict = True # default value
1115
# Get the tip's revision_id
1116
revision = _get_one_revision('push', revision)
1117
if revision is not None:
1118
revision_id = revision.in_history(br_from).rev_id
1121
if strict and tree is not None and revision_id is None:
1122
if (tree.has_changes()):
1123
raise errors.UncommittedChanges(
1124
tree, more='Use --no-strict to force the push.')
1125
if tree.last_revision() != tree.branch.last_revision():
1126
# The tree has lost sync with its branch, there is little
1127
# chance that the user is aware of it but he can still force
1128
# the push with --no-strict
1129
raise errors.OutOfDateTree(
1130
tree, more='Use --no-strict to force the push.')
1132
# Get the stacked_on branch, if any
1133
if stacked_on is not None:
1134
stacked_on = urlutils.normalize_url(stacked_on)
1136
parent_url = br_from.get_parent()
1138
parent = Branch.open(parent_url)
1139
stacked_on = parent.get_public_branch()
1141
# I considered excluding non-http url's here, thus forcing
1142
# 'public' branches only, but that only works for some
1143
# users, so it's best to just depend on the user spotting an
1144
# error by the feedback given to them. RBC 20080227.
1145
stacked_on = parent_url
1147
raise errors.BzrCommandError(
1148
"Could not determine branch to refer to.")
1150
# Get the destination location
1151
if location is None:
1152
stored_loc = br_from.get_push_location()
1153
if stored_loc is None:
1154
raise errors.BzrCommandError(
1155
"No push location known or specified.")
1157
display_url = urlutils.unescape_for_display(stored_loc,
1159
self.outf.write("Using saved push location: %s\n" % display_url)
1160
location = stored_loc
1162
_show_push_branch(br_from, revision_id, location, self.outf,
1163
verbose=verbose, overwrite=overwrite, remember=remember,
1164
stacked_on=stacked_on, create_prefix=create_prefix,
1165
use_existing_dir=use_existing_dir)
1168
class cmd_branch(Command):
1169
"""Create a new branch that is a copy of an existing branch.
1171
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1172
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1173
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1174
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1175
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1178
To retrieve the branch as of a particular revision, supply the --revision
1179
parameter, as in "branch foo/bar -r 5".
1182
_see_also = ['checkout']
1183
takes_args = ['from_location', 'to_location?']
1184
takes_options = ['revision', Option('hardlink',
1185
help='Hard-link working tree files where possible.'),
1187
help="Create a branch without a working-tree."),
1189
help="Switch the checkout in the current directory "
1190
"to the new branch."),
1192
help='Create a stacked branch referring to the source branch. '
1193
'The new branch will depend on the availability of the source '
1194
'branch for all operations.'),
1195
Option('standalone',
1196
help='Do not use a shared repository, even if available.'),
1197
Option('use-existing-dir',
1198
help='By default branch will fail if the target'
1199
' directory exists, but does not already'
1200
' have a control directory. This flag will'
1201
' allow branch to proceed.'),
1203
aliases = ['get', 'clone']
1205
def run(self, from_location, to_location=None, revision=None,
1206
hardlink=False, stacked=False, standalone=False, no_tree=False,
1207
use_existing_dir=False, switch=False):
1208
from bzrlib import switch as _mod_switch
1209
from bzrlib.tag import _merge_tags_if_possible
1210
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1212
if (accelerator_tree is not None and
1213
accelerator_tree.supports_content_filtering()):
1214
accelerator_tree = None
1215
revision = _get_one_revision('branch', revision)
1218
if revision is not None:
1219
revision_id = revision.as_revision_id(br_from)
1221
# FIXME - wt.last_revision, fallback to branch, fall back to
1222
# None or perhaps NULL_REVISION to mean copy nothing
1224
revision_id = br_from.last_revision()
1225
if to_location is None:
1226
to_location = urlutils.derive_to_location(from_location)
1227
to_transport = transport.get_transport(to_location)
1229
to_transport.mkdir('.')
1230
except errors.FileExists:
1231
if not use_existing_dir:
1232
raise errors.BzrCommandError('Target directory "%s" '
1233
'already exists.' % to_location)
1236
bzrdir.BzrDir.open_from_transport(to_transport)
1237
except errors.NotBranchError:
1240
raise errors.AlreadyBranchError(to_location)
1241
except errors.NoSuchFile:
1242
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1245
# preserve whatever source format we have.
1246
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1247
possible_transports=[to_transport],
1248
accelerator_tree=accelerator_tree,
1249
hardlink=hardlink, stacked=stacked,
1250
force_new_repo=standalone,
1251
create_tree_if_local=not no_tree,
1252
source_branch=br_from)
1253
branch = dir.open_branch()
1254
except errors.NoSuchRevision:
1255
to_transport.delete_tree('.')
1256
msg = "The branch %s has no revision %s." % (from_location,
1258
raise errors.BzrCommandError(msg)
1259
_merge_tags_if_possible(br_from, branch)
1260
# If the source branch is stacked, the new branch may
1261
# be stacked whether we asked for that explicitly or not.
1262
# We therefore need a try/except here and not just 'if stacked:'
1264
note('Created new stacked branch referring to %s.' %
1265
branch.get_stacked_on_url())
1266
except (errors.NotStacked, errors.UnstackableBranchFormat,
1267
errors.UnstackableRepositoryFormat), e:
1268
note('Branched %d revision(s).' % branch.revno())
1270
# Switch to the new branch
1271
wt, _ = WorkingTree.open_containing('.')
1272
_mod_switch.switch(wt.bzrdir, branch)
1273
note('Switched to branch: %s',
1274
urlutils.unescape_for_display(branch.base, 'utf-8'))
1279
class cmd_checkout(Command):
1280
"""Create a new checkout of an existing branch.
1282
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1283
the branch found in '.'. This is useful if you have removed the working tree
1284
or if it was never created - i.e. if you pushed the branch to its current
1285
location using SFTP.
1287
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1288
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1289
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1290
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1291
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1294
To retrieve the branch as of a particular revision, supply the --revision
1295
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1296
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1300
_see_also = ['checkouts', 'branch']
1301
takes_args = ['branch_location?', 'to_location?']
1302
takes_options = ['revision',
1303
Option('lightweight',
1304
help="Perform a lightweight checkout. Lightweight "
1305
"checkouts depend on access to the branch for "
1306
"every operation. Normal checkouts can perform "
1307
"common operations like diff and status without "
1308
"such access, and also support local commits."
1310
Option('files-from', type=str,
1311
help="Get file contents from this tree."),
1313
help='Hard-link working tree files where possible.'
1318
def run(self, branch_location=None, to_location=None, revision=None,
1319
lightweight=False, files_from=None, hardlink=False):
1320
if branch_location is None:
1321
branch_location = osutils.getcwd()
1322
to_location = branch_location
1323
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1325
revision = _get_one_revision('checkout', revision)
1326
if files_from is not None:
1327
accelerator_tree = WorkingTree.open(files_from)
1328
if revision is not None:
1329
revision_id = revision.as_revision_id(source)
1332
if to_location is None:
1333
to_location = urlutils.derive_to_location(branch_location)
1334
# if the source and to_location are the same,
1335
# and there is no working tree,
1336
# then reconstitute a branch
1337
if (osutils.abspath(to_location) ==
1338
osutils.abspath(branch_location)):
1340
source.bzrdir.open_workingtree()
1341
except errors.NoWorkingTree:
1342
source.bzrdir.create_workingtree(revision_id)
1344
source.create_checkout(to_location, revision_id, lightweight,
1345
accelerator_tree, hardlink)
1348
class cmd_renames(Command):
1349
"""Show list of renamed files.
1351
# TODO: Option to show renames between two historical versions.
1353
# TODO: Only show renames under dir, rather than in the whole branch.
1354
_see_also = ['status']
1355
takes_args = ['dir?']
1358
def run(self, dir=u'.'):
1359
tree = WorkingTree.open_containing(dir)[0]
1362
new_inv = tree.inventory
1363
old_tree = tree.basis_tree()
1364
old_tree.lock_read()
1366
old_inv = old_tree.inventory
1368
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1369
for f, paths, c, v, p, n, k, e in iterator:
1370
if paths[0] == paths[1]:
1374
renames.append(paths)
1376
for old_name, new_name in renames:
1377
self.outf.write("%s => %s\n" % (old_name, new_name))
1384
class cmd_update(Command):
1385
"""Update a tree to have the latest code committed to its branch.
1387
This will perform a merge into the working tree, and may generate
1388
conflicts. If you have any local changes, you will still
1389
need to commit them after the update for the update to be complete.
1391
If you want to discard your local changes, you can just do a
1392
'bzr revert' instead of 'bzr commit' after the update.
1395
_see_also = ['pull', 'working-trees', 'status-flags']
1396
takes_args = ['dir?']
1399
def run(self, dir='.'):
1400
tree = WorkingTree.open_containing(dir)[0]
1401
possible_transports = []
1402
master = tree.branch.get_master_branch(
1403
possible_transports=possible_transports)
1404
if master is not None:
1407
tree.lock_tree_write()
1409
existing_pending_merges = tree.get_parent_ids()[1:]
1410
last_rev = _mod_revision.ensure_null(tree.last_revision())
1411
if last_rev == _mod_revision.ensure_null(
1412
tree.branch.last_revision()):
1413
# may be up to date, check master too.
1414
if master is None or last_rev == _mod_revision.ensure_null(
1415
master.last_revision()):
1416
revno = tree.branch.revision_id_to_revno(last_rev)
1417
note("Tree is up to date at revision %d." % (revno,))
1419
view_info = _get_view_info_for_change_reporter(tree)
1420
conflicts = tree.update(
1421
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1422
view_info=view_info), possible_transports=possible_transports)
1423
revno = tree.branch.revision_id_to_revno(
1424
_mod_revision.ensure_null(tree.last_revision()))
1425
note('Updated to revision %d.' % (revno,))
1426
if tree.get_parent_ids()[1:] != existing_pending_merges:
1427
note('Your local commits will now show as pending merges with '
1428
"'bzr status', and can be committed with 'bzr commit'.")
1437
class cmd_info(Command):
1438
"""Show information about a working tree, branch or repository.
1440
This command will show all known locations and formats associated to the
1441
tree, branch or repository.
1443
In verbose mode, statistical information is included with each report.
1444
To see extended statistic information, use a verbosity level of 2 or
1445
higher by specifying the verbose option multiple times, e.g. -vv.
1447
Branches and working trees will also report any missing revisions.
1451
Display information on the format and related locations:
1455
Display the above together with extended format information and
1456
basic statistics (like the number of files in the working tree and
1457
number of revisions in the branch and repository):
1461
Display the above together with number of committers to the branch:
1465
_see_also = ['revno', 'working-trees', 'repositories']
1466
takes_args = ['location?']
1467
takes_options = ['verbose']
1468
encoding_type = 'replace'
1471
def run(self, location=None, verbose=False):
1473
noise_level = get_verbosity_level()
1476
from bzrlib.info import show_bzrdir_info
1477
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1478
verbose=noise_level, outfile=self.outf)
1481
class cmd_remove(Command):
1482
"""Remove files or directories.
1484
This makes bzr stop tracking changes to the specified files. bzr will delete
1485
them if they can easily be recovered using revert. If no options or
1486
parameters are given bzr will scan for files that are being tracked by bzr
1487
but missing in your tree and stop tracking them for you.
1489
takes_args = ['file*']
1490
takes_options = ['verbose',
1491
Option('new', help='Only remove files that have never been committed.'),
1492
RegistryOption.from_kwargs('file-deletion-strategy',
1493
'The file deletion mode to be used.',
1494
title='Deletion Strategy', value_switches=True, enum_switch=False,
1495
safe='Only delete files if they can be'
1496
' safely recovered (default).',
1497
keep='Delete from bzr but leave the working copy.',
1498
force='Delete all the specified files, even if they can not be '
1499
'recovered and even if they are non-empty directories.')]
1500
aliases = ['rm', 'del']
1501
encoding_type = 'replace'
1503
def run(self, file_list, verbose=False, new=False,
1504
file_deletion_strategy='safe'):
1505
tree, file_list = tree_files(file_list)
1507
if file_list is not None:
1508
file_list = [f for f in file_list]
1512
# Heuristics should probably all move into tree.remove_smart or
1515
added = tree.changes_from(tree.basis_tree(),
1516
specific_files=file_list).added
1517
file_list = sorted([f[0] for f in added], reverse=True)
1518
if len(file_list) == 0:
1519
raise errors.BzrCommandError('No matching files.')
1520
elif file_list is None:
1521
# missing files show up in iter_changes(basis) as
1522
# versioned-with-no-kind.
1524
for change in tree.iter_changes(tree.basis_tree()):
1525
# Find paths in the working tree that have no kind:
1526
if change[1][1] is not None and change[6][1] is None:
1527
missing.append(change[1][1])
1528
file_list = sorted(missing, reverse=True)
1529
file_deletion_strategy = 'keep'
1530
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1531
keep_files=file_deletion_strategy=='keep',
1532
force=file_deletion_strategy=='force')
1537
class cmd_file_id(Command):
1538
"""Print file_id of a particular file or directory.
1540
The file_id is assigned when the file is first added and remains the
1541
same through all revisions where the file exists, even when it is
1546
_see_also = ['inventory', 'ls']
1547
takes_args = ['filename']
1550
def run(self, filename):
1551
tree, relpath = WorkingTree.open_containing(filename)
1552
i = tree.path2id(relpath)
1554
raise errors.NotVersionedError(filename)
1556
self.outf.write(i + '\n')
1559
class cmd_file_path(Command):
1560
"""Print path of file_ids to a file or directory.
1562
This prints one line for each directory down to the target,
1563
starting at the branch root.
1567
takes_args = ['filename']
1570
def run(self, filename):
1571
tree, relpath = WorkingTree.open_containing(filename)
1572
fid = tree.path2id(relpath)
1574
raise errors.NotVersionedError(filename)
1575
segments = osutils.splitpath(relpath)
1576
for pos in range(1, len(segments) + 1):
1577
path = osutils.joinpath(segments[:pos])
1578
self.outf.write("%s\n" % tree.path2id(path))
1581
class cmd_reconcile(Command):
1582
"""Reconcile bzr metadata in a branch.
1584
This can correct data mismatches that may have been caused by
1585
previous ghost operations or bzr upgrades. You should only
1586
need to run this command if 'bzr check' or a bzr developer
1587
advises you to run it.
1589
If a second branch is provided, cross-branch reconciliation is
1590
also attempted, which will check that data like the tree root
1591
id which was not present in very early bzr versions is represented
1592
correctly in both branches.
1594
At the same time it is run it may recompress data resulting in
1595
a potential saving in disk space or performance gain.
1597
The branch *MUST* be on a listable system such as local disk or sftp.
1600
_see_also = ['check']
1601
takes_args = ['branch?']
1603
def run(self, branch="."):
1604
from bzrlib.reconcile import reconcile
1605
dir = bzrdir.BzrDir.open(branch)
1609
class cmd_revision_history(Command):
1610
"""Display the list of revision ids on a branch."""
1613
takes_args = ['location?']
1618
def run(self, location="."):
1619
branch = Branch.open_containing(location)[0]
1620
for revid in branch.revision_history():
1621
self.outf.write(revid)
1622
self.outf.write('\n')
1625
class cmd_ancestry(Command):
1626
"""List all revisions merged into this branch."""
1628
_see_also = ['log', 'revision-history']
1629
takes_args = ['location?']
1634
def run(self, location="."):
1636
wt = WorkingTree.open_containing(location)[0]
1637
except errors.NoWorkingTree:
1638
b = Branch.open(location)
1639
last_revision = b.last_revision()
1642
last_revision = wt.last_revision()
1644
revision_ids = b.repository.get_ancestry(last_revision)
1646
for revision_id in revision_ids:
1647
self.outf.write(revision_id + '\n')
1650
class cmd_init(Command):
1651
"""Make a directory into a versioned branch.
1653
Use this to create an empty branch, or before importing an
1656
If there is a repository in a parent directory of the location, then
1657
the history of the branch will be stored in the repository. Otherwise
1658
init creates a standalone branch which carries its own history
1659
in the .bzr directory.
1661
If there is already a branch at the location but it has no working tree,
1662
the tree can be populated with 'bzr checkout'.
1664
Recipe for importing a tree of files::
1670
bzr commit -m "imported project"
1673
_see_also = ['init-repository', 'branch', 'checkout']
1674
takes_args = ['location?']
1676
Option('create-prefix',
1677
help='Create the path leading up to the branch '
1678
'if it does not already exist.'),
1679
RegistryOption('format',
1680
help='Specify a format for this branch. '
1681
'See "help formats".',
1682
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1683
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1684
value_switches=True,
1685
title="Branch format",
1687
Option('append-revisions-only',
1688
help='Never change revnos or the existing log.'
1689
' Append revisions to it only.')
1691
def run(self, location=None, format=None, append_revisions_only=False,
1692
create_prefix=False):
1694
format = bzrdir.format_registry.make_bzrdir('default')
1695
if location is None:
1698
to_transport = transport.get_transport(location)
1700
# The path has to exist to initialize a
1701
# branch inside of it.
1702
# Just using os.mkdir, since I don't
1703
# believe that we want to create a bunch of
1704
# locations if the user supplies an extended path
1706
to_transport.ensure_base()
1707
except errors.NoSuchFile:
1708
if not create_prefix:
1709
raise errors.BzrCommandError("Parent directory of %s"
1711
"\nYou may supply --create-prefix to create all"
1712
" leading parent directories."
1714
to_transport.create_prefix()
1717
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1718
except errors.NotBranchError:
1719
# really a NotBzrDir error...
1720
create_branch = bzrdir.BzrDir.create_branch_convenience
1721
branch = create_branch(to_transport.base, format=format,
1722
possible_transports=[to_transport])
1723
a_bzrdir = branch.bzrdir
1725
from bzrlib.transport.local import LocalTransport
1726
if a_bzrdir.has_branch():
1727
if (isinstance(to_transport, LocalTransport)
1728
and not a_bzrdir.has_workingtree()):
1729
raise errors.BranchExistsWithoutWorkingTree(location)
1730
raise errors.AlreadyBranchError(location)
1731
branch = a_bzrdir.create_branch()
1732
a_bzrdir.create_workingtree()
1733
if append_revisions_only:
1735
branch.set_append_revisions_only(True)
1736
except errors.UpgradeRequired:
1737
raise errors.BzrCommandError('This branch format cannot be set'
1738
' to append-revisions-only. Try --default.')
1740
from bzrlib.info import describe_layout, describe_format
1742
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1743
except (errors.NoWorkingTree, errors.NotLocalUrl):
1745
repository = branch.repository
1746
layout = describe_layout(repository, branch, tree).lower()
1747
format = describe_format(a_bzrdir, repository, branch, tree)
1748
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1749
if repository.is_shared():
1750
#XXX: maybe this can be refactored into transport.path_or_url()
1751
url = repository.bzrdir.root_transport.external_url()
1753
url = urlutils.local_path_from_url(url)
1754
except errors.InvalidURL:
1756
self.outf.write("Using shared repository: %s\n" % url)
1759
class cmd_init_repository(Command):
1760
"""Create a shared repository for branches to share storage space.
1762
New branches created under the repository directory will store their
1763
revisions in the repository, not in the branch directory. For branches
1764
with shared history, this reduces the amount of storage needed and
1765
speeds up the creation of new branches.
1767
If the --no-trees option is given then the branches in the repository
1768
will not have working trees by default. They will still exist as
1769
directories on disk, but they will not have separate copies of the
1770
files at a certain revision. This can be useful for repositories that
1771
store branches which are interacted with through checkouts or remote
1772
branches, such as on a server.
1775
Create a shared repository holding just branches::
1777
bzr init-repo --no-trees repo
1780
Make a lightweight checkout elsewhere::
1782
bzr checkout --lightweight repo/trunk trunk-checkout
1787
_see_also = ['init', 'branch', 'checkout', 'repositories']
1788
takes_args = ["location"]
1789
takes_options = [RegistryOption('format',
1790
help='Specify a format for this repository. See'
1791
' "bzr help formats" for details.',
1792
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1793
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1794
value_switches=True, title='Repository format'),
1796
help='Branches in the repository will default to'
1797
' not having a working tree.'),
1799
aliases = ["init-repo"]
1801
def run(self, location, format=None, no_trees=False):
1803
format = bzrdir.format_registry.make_bzrdir('default')
1805
if location is None:
1808
to_transport = transport.get_transport(location)
1809
to_transport.ensure_base()
1811
newdir = format.initialize_on_transport(to_transport)
1812
repo = newdir.create_repository(shared=True)
1813
repo.set_make_working_trees(not no_trees)
1815
from bzrlib.info import show_bzrdir_info
1816
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1819
class cmd_diff(Command):
1820
"""Show differences in the working tree, between revisions or branches.
1822
If no arguments are given, all changes for the current tree are listed.
1823
If files are given, only the changes in those files are listed.
1824
Remote and multiple branches can be compared by using the --old and
1825
--new options. If not provided, the default for both is derived from
1826
the first argument, if any, or the current tree if no arguments are
1829
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1830
produces patches suitable for "patch -p1".
1834
2 - unrepresentable changes
1839
Shows the difference in the working tree versus the last commit::
1843
Difference between the working tree and revision 1::
1847
Difference between revision 3 and revision 1::
1851
Difference between revision 3 and revision 1 for branch xxx::
1855
To see the changes introduced in revision X::
1859
Note that in the case of a merge, the -c option shows the changes
1860
compared to the left hand parent. To see the changes against
1861
another parent, use::
1863
bzr diff -r<chosen_parent>..X
1865
The changes introduced by revision 2 (equivalent to -r1..2)::
1869
Show just the differences for file NEWS::
1873
Show the differences in working tree xxx for file NEWS::
1877
Show the differences from branch xxx to this working tree:
1881
Show the differences between two branches for file NEWS::
1883
bzr diff --old xxx --new yyy NEWS
1885
Same as 'bzr diff' but prefix paths with old/ and new/::
1887
bzr diff --prefix old/:new/
1889
_see_also = ['status']
1890
takes_args = ['file*']
1892
Option('diff-options', type=str,
1893
help='Pass these options to the external diff program.'),
1894
Option('prefix', type=str,
1896
help='Set prefixes added to old and new filenames, as '
1897
'two values separated by a colon. (eg "old/:new/").'),
1899
help='Branch/tree to compare from.',
1903
help='Branch/tree to compare to.',
1909
help='Use this command to compare files.',
1913
aliases = ['di', 'dif']
1914
encoding_type = 'exact'
1917
def run(self, revision=None, file_list=None, diff_options=None,
1918
prefix=None, old=None, new=None, using=None):
1919
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1921
if (prefix is None) or (prefix == '0'):
1929
old_label, new_label = prefix.split(":")
1931
raise errors.BzrCommandError(
1932
'--prefix expects two values separated by a colon'
1933
' (eg "old/:new/")')
1935
if revision and len(revision) > 2:
1936
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1937
' one or two revision specifiers')
1939
(old_tree, new_tree,
1940
old_branch, new_branch,
1941
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1942
file_list, revision, old, new, apply_view=True)
1943
return show_diff_trees(old_tree, new_tree, sys.stdout,
1944
specific_files=specific_files,
1945
external_diff_options=diff_options,
1946
old_label=old_label, new_label=new_label,
1947
extra_trees=extra_trees, using=using)
1950
class cmd_deleted(Command):
1951
"""List files deleted in the working tree.
1953
# TODO: Show files deleted since a previous revision, or
1954
# between two revisions.
1955
# TODO: Much more efficient way to do this: read in new
1956
# directories with readdir, rather than stating each one. Same
1957
# level of effort but possibly much less IO. (Or possibly not,
1958
# if the directories are very large...)
1959
_see_also = ['status', 'ls']
1960
takes_options = ['show-ids']
1963
def run(self, show_ids=False):
1964
tree = WorkingTree.open_containing(u'.')[0]
1967
old = tree.basis_tree()
1970
for path, ie in old.inventory.iter_entries():
1971
if not tree.has_id(ie.file_id):
1972
self.outf.write(path)
1974
self.outf.write(' ')
1975
self.outf.write(ie.file_id)
1976
self.outf.write('\n')
1983
class cmd_modified(Command):
1984
"""List files modified in working tree.
1988
_see_also = ['status', 'ls']
1991
help='Write an ascii NUL (\\0) separator '
1992
'between files rather than a newline.')
1996
def run(self, null=False):
1997
tree = WorkingTree.open_containing(u'.')[0]
1998
td = tree.changes_from(tree.basis_tree())
1999
for path, id, kind, text_modified, meta_modified in td.modified:
2001
self.outf.write(path + '\0')
2003
self.outf.write(osutils.quotefn(path) + '\n')
2006
class cmd_added(Command):
2007
"""List files added in working tree.
2011
_see_also = ['status', 'ls']
2014
help='Write an ascii NUL (\\0) separator '
2015
'between files rather than a newline.')
2019
def run(self, null=False):
2020
wt = WorkingTree.open_containing(u'.')[0]
2023
basis = wt.basis_tree()
2026
basis_inv = basis.inventory
2029
if file_id in basis_inv:
2031
if inv.is_root(file_id) and len(basis_inv) == 0:
2033
path = inv.id2path(file_id)
2034
if not os.access(osutils.abspath(path), os.F_OK):
2037
self.outf.write(path + '\0')
2039
self.outf.write(osutils.quotefn(path) + '\n')
2046
class cmd_root(Command):
2047
"""Show the tree root directory.
2049
The root is the nearest enclosing directory with a .bzr control
2052
takes_args = ['filename?']
2054
def run(self, filename=None):
2055
"""Print the branch root."""
2056
tree = WorkingTree.open_containing(filename)[0]
2057
self.outf.write(tree.basedir + '\n')
2060
def _parse_limit(limitstring):
2062
return int(limitstring)
2064
msg = "The limit argument must be an integer."
2065
raise errors.BzrCommandError(msg)
2068
def _parse_levels(s):
2072
msg = "The levels argument must be an integer."
2073
raise errors.BzrCommandError(msg)
2076
class cmd_log(Command):
2077
"""Show historical log for a branch or subset of a branch.
2079
log is bzr's default tool for exploring the history of a branch.
2080
The branch to use is taken from the first parameter. If no parameters
2081
are given, the branch containing the working directory is logged.
2082
Here are some simple examples::
2084
bzr log log the current branch
2085
bzr log foo.py log a file in its branch
2086
bzr log http://server/branch log a branch on a server
2088
The filtering, ordering and information shown for each revision can
2089
be controlled as explained below. By default, all revisions are
2090
shown sorted (topologically) so that newer revisions appear before
2091
older ones and descendants always appear before ancestors. If displayed,
2092
merged revisions are shown indented under the revision in which they
2097
The log format controls how information about each revision is
2098
displayed. The standard log formats are called ``long``, ``short``
2099
and ``line``. The default is long. See ``bzr help log-formats``
2100
for more details on log formats.
2102
The following options can be used to control what information is
2105
-l N display a maximum of N revisions
2106
-n N display N levels of revisions (0 for all, 1 for collapsed)
2107
-v display a status summary (delta) for each revision
2108
-p display a diff (patch) for each revision
2109
--show-ids display revision-ids (and file-ids), not just revnos
2111
Note that the default number of levels to display is a function of the
2112
log format. If the -n option is not used, the standard log formats show
2113
just the top level (mainline).
2115
Status summaries are shown using status flags like A, M, etc. To see
2116
the changes explained using words like ``added`` and ``modified``
2117
instead, use the -vv option.
2121
To display revisions from oldest to newest, use the --forward option.
2122
In most cases, using this option will have little impact on the total
2123
time taken to produce a log, though --forward does not incrementally
2124
display revisions like --reverse does when it can.
2126
:Revision filtering:
2128
The -r option can be used to specify what revision or range of revisions
2129
to filter against. The various forms are shown below::
2131
-rX display revision X
2132
-rX.. display revision X and later
2133
-r..Y display up to and including revision Y
2134
-rX..Y display from X to Y inclusive
2136
See ``bzr help revisionspec`` for details on how to specify X and Y.
2137
Some common examples are given below::
2139
-r-1 show just the tip
2140
-r-10.. show the last 10 mainline revisions
2141
-rsubmit:.. show what's new on this branch
2142
-rancestor:path.. show changes since the common ancestor of this
2143
branch and the one at location path
2144
-rdate:yesterday.. show changes since yesterday
2146
When logging a range of revisions using -rX..Y, log starts at
2147
revision Y and searches back in history through the primary
2148
("left-hand") parents until it finds X. When logging just the
2149
top level (using -n1), an error is reported if X is not found
2150
along the way. If multi-level logging is used (-n0), X may be
2151
a nested merge revision and the log will be truncated accordingly.
2155
If parameters are given and the first one is not a branch, the log
2156
will be filtered to show only those revisions that changed the
2157
nominated files or directories.
2159
Filenames are interpreted within their historical context. To log a
2160
deleted file, specify a revision range so that the file existed at
2161
the end or start of the range.
2163
Historical context is also important when interpreting pathnames of
2164
renamed files/directories. Consider the following example:
2166
* revision 1: add tutorial.txt
2167
* revision 2: modify tutorial.txt
2168
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2172
* ``bzr log guide.txt`` will log the file added in revision 1
2174
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2176
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2177
the original file in revision 2.
2179
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2180
was no file called guide.txt in revision 2.
2182
Renames are always followed by log. By design, there is no need to
2183
explicitly ask for this (and no way to stop logging a file back
2184
until it was last renamed).
2188
The --message option can be used for finding revisions that match a
2189
regular expression in a commit message.
2193
GUI tools and IDEs are often better at exploring history than command
2194
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2195
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2196
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2198
Web interfaces are often better at exploring history than command line
2199
tools, particularly for branches on servers. You may prefer Loggerhead
2200
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2202
You may find it useful to add the aliases below to ``bazaar.conf``::
2206
top = log -l10 --line
2209
``bzr tip`` will then show the latest revision while ``bzr top``
2210
will show the last 10 mainline revisions. To see the details of a
2211
particular revision X, ``bzr show -rX``.
2213
If you are interested in looking deeper into a particular merge X,
2214
use ``bzr log -n0 -rX``.
2216
``bzr log -v`` on a branch with lots of history is currently
2217
very slow. A fix for this issue is currently under development.
2218
With or without that fix, it is recommended that a revision range
2219
be given when using the -v option.
2221
bzr has a generic full-text matching plugin, bzr-search, that can be
2222
used to find revisions matching user names, commit messages, etc.
2223
Among other features, this plugin can find all revisions containing
2224
a list of words but not others.
2226
When exploring non-mainline history on large projects with deep
2227
history, the performance of log can be greatly improved by installing
2228
the historycache plugin. This plugin buffers historical information
2229
trading disk space for faster speed.
2231
takes_args = ['file*']
2232
_see_also = ['log-formats', 'revisionspec']
2235
help='Show from oldest to newest.'),
2237
custom_help('verbose',
2238
help='Show files changed in each revision.'),
2242
type=bzrlib.option._parse_revision_str,
2244
help='Show just the specified revision.'
2245
' See also "help revisionspec".'),
2249
help='Number of levels to display - 0 for all, 1 for flat.',
2251
type=_parse_levels),
2254
help='Show revisions whose message matches this '
2255
'regular expression.',
2259
help='Limit the output to the first N revisions.',
2264
help='Show changes made in each revision as a patch.'),
2265
Option('include-merges',
2266
help='Show merged revisions like --levels 0 does.'),
2268
encoding_type = 'replace'
2271
def run(self, file_list=None, timezone='original',
2282
include_merges=False):
2283
from bzrlib.log import (
2285
make_log_request_dict,
2286
_get_info_for_log_files,
2288
direction = (forward and 'forward') or 'reverse'
2293
raise errors.BzrCommandError(
2294
'--levels and --include-merges are mutually exclusive')
2296
if change is not None:
2298
raise errors.RangeInChangeOption()
2299
if revision is not None:
2300
raise errors.BzrCommandError(
2301
'--revision and --change are mutually exclusive')
2306
filter_by_dir = False
2310
# find the file ids to log and check for directory filtering
2311
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2312
revision, file_list)
2313
for relpath, file_id, kind in file_info_list:
2315
raise errors.BzrCommandError(
2316
"Path unknown at end or start of revision range: %s" %
2318
# If the relpath is the top of the tree, we log everything
2323
file_ids.append(file_id)
2324
filter_by_dir = filter_by_dir or (
2325
kind in ['directory', 'tree-reference'])
2328
# FIXME ? log the current subdir only RBC 20060203
2329
if revision is not None \
2330
and len(revision) > 0 and revision[0].get_branch():
2331
location = revision[0].get_branch()
2334
dir, relpath = bzrdir.BzrDir.open_containing(location)
2335
b = dir.open_branch()
2337
rev1, rev2 = _get_revision_range(revision, b, self.name())
2339
# Decide on the type of delta & diff filtering to use
2340
# TODO: add an --all-files option to make this configurable & consistent
2348
diff_type = 'partial'
2352
# Build the log formatter
2353
if log_format is None:
2354
log_format = log.log_formatter_registry.get_default(b)
2355
lf = log_format(show_ids=show_ids, to_file=self.outf,
2356
show_timezone=timezone,
2357
delta_format=get_verbosity_level(),
2359
show_advice=levels is None)
2361
# Choose the algorithm for doing the logging. It's annoying
2362
# having multiple code paths like this but necessary until
2363
# the underlying repository format is faster at generating
2364
# deltas or can provide everything we need from the indices.
2365
# The default algorithm - match-using-deltas - works for
2366
# multiple files and directories and is faster for small
2367
# amounts of history (200 revisions say). However, it's too
2368
# slow for logging a single file in a repository with deep
2369
# history, i.e. > 10K revisions. In the spirit of "do no
2370
# evil when adding features", we continue to use the
2371
# original algorithm - per-file-graph - for the "single
2372
# file that isn't a directory without showing a delta" case.
2373
partial_history = revision and b.repository._format.supports_chks
2374
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2375
or delta_type or partial_history)
2377
# Build the LogRequest and execute it
2378
if len(file_ids) == 0:
2380
rqst = make_log_request_dict(
2381
direction=direction, specific_fileids=file_ids,
2382
start_revision=rev1, end_revision=rev2, limit=limit,
2383
message_search=message, delta_type=delta_type,
2384
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2385
Logger(b, rqst).show(lf)
2391
def _get_revision_range(revisionspec_list, branch, command_name):
2392
"""Take the input of a revision option and turn it into a revision range.
2394
It returns RevisionInfo objects which can be used to obtain the rev_id's
2395
of the desired revisions. It does some user input validations.
2397
if revisionspec_list is None:
2400
elif len(revisionspec_list) == 1:
2401
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2402
elif len(revisionspec_list) == 2:
2403
start_spec = revisionspec_list[0]
2404
end_spec = revisionspec_list[1]
2405
if end_spec.get_branch() != start_spec.get_branch():
2406
# b is taken from revision[0].get_branch(), and
2407
# show_log will use its revision_history. Having
2408
# different branches will lead to weird behaviors.
2409
raise errors.BzrCommandError(
2410
"bzr %s doesn't accept two revisions in different"
2411
" branches." % command_name)
2412
rev1 = start_spec.in_history(branch)
2413
# Avoid loading all of history when we know a missing
2414
# end of range means the last revision ...
2415
if end_spec.spec is None:
2416
last_revno, last_revision_id = branch.last_revision_info()
2417
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2419
rev2 = end_spec.in_history(branch)
2421
raise errors.BzrCommandError(
2422
'bzr %s --revision takes one or two values.' % command_name)
2426
def _revision_range_to_revid_range(revision_range):
2429
if revision_range[0] is not None:
2430
rev_id1 = revision_range[0].rev_id
2431
if revision_range[1] is not None:
2432
rev_id2 = revision_range[1].rev_id
2433
return rev_id1, rev_id2
2435
def get_log_format(long=False, short=False, line=False, default='long'):
2436
log_format = default
2440
log_format = 'short'
2446
class cmd_touching_revisions(Command):
2447
"""Return revision-ids which affected a particular file.
2449
A more user-friendly interface is "bzr log FILE".
2453
takes_args = ["filename"]
2456
def run(self, filename):
2457
tree, relpath = WorkingTree.open_containing(filename)
2458
file_id = tree.path2id(relpath)
2462
touching_revs = log.find_touching_revisions(b, file_id)
2463
for revno, revision_id, what in touching_revs:
2464
self.outf.write("%6d %s\n" % (revno, what))
2469
class cmd_ls(Command):
2470
"""List files in a tree.
2473
_see_also = ['status', 'cat']
2474
takes_args = ['path?']
2478
Option('recursive', short_name='R',
2479
help='Recurse into subdirectories.'),
2481
help='Print paths relative to the root of the branch.'),
2482
Option('unknown', help='Print unknown files.'),
2483
Option('versioned', help='Print versioned files.',
2485
Option('ignored', help='Print ignored files.'),
2487
help='Write an ascii NUL (\\0) separator '
2488
'between files rather than a newline.'),
2490
help='List entries of a particular kind: file, directory, symlink.',
2495
def run(self, revision=None, verbose=False,
2496
recursive=False, from_root=False,
2497
unknown=False, versioned=False, ignored=False,
2498
null=False, kind=None, show_ids=False, path=None):
2500
if kind and kind not in ('file', 'directory', 'symlink'):
2501
raise errors.BzrCommandError('invalid kind specified')
2503
if verbose and null:
2504
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2505
all = not (unknown or versioned or ignored)
2507
selection = {'I':ignored, '?':unknown, 'V':versioned}
2513
raise errors.BzrCommandError('cannot specify both --from-root'
2516
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2519
# Calculate the prefix to use
2523
prefix = relpath + '/'
2524
elif fs_path != '.' and not fs_path.endswith('/'):
2525
prefix = fs_path + '/'
2527
if revision is not None or tree is None:
2528
tree = _get_one_revision_tree('ls', revision, branch=branch)
2531
if isinstance(tree, WorkingTree) and tree.supports_views():
2532
view_files = tree.views.lookup_view()
2535
view_str = views.view_display_str(view_files)
2536
note("Ignoring files outside view. View is %s" % view_str)
2540
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2541
from_dir=relpath, recursive=recursive):
2542
# Apply additional masking
2543
if not all and not selection[fc]:
2545
if kind is not None and fkind != kind:
2550
fullpath = osutils.pathjoin(relpath, fp)
2553
views.check_path_in_view(tree, fullpath)
2554
except errors.FileOutsideView:
2559
fp = osutils.pathjoin(prefix, fp)
2560
kindch = entry.kind_character()
2561
outstring = fp + kindch
2562
ui.ui_factory.clear_term()
2564
outstring = '%-8s %s' % (fc, outstring)
2565
if show_ids and fid is not None:
2566
outstring = "%-50s %s" % (outstring, fid)
2567
self.outf.write(outstring + '\n')
2569
self.outf.write(fp + '\0')
2572
self.outf.write(fid)
2573
self.outf.write('\0')
2581
self.outf.write('%-50s %s\n' % (outstring, my_id))
2583
self.outf.write(outstring + '\n')
2588
class cmd_unknowns(Command):
2589
"""List unknown files.
2597
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2598
self.outf.write(osutils.quotefn(f) + '\n')
2601
class cmd_ignore(Command):
2602
"""Ignore specified files or patterns.
2604
See ``bzr help patterns`` for details on the syntax of patterns.
2606
If a .bzrignore file does not exist, the ignore command
2607
will create one and add the specified files or patterns to the newly
2608
created file. The ignore command will also automatically add the
2609
.bzrignore file to be versioned. Creating a .bzrignore file without
2610
the use of the ignore command will require an explicit add command.
2612
To remove patterns from the ignore list, edit the .bzrignore file.
2613
After adding, editing or deleting that file either indirectly by
2614
using this command or directly by using an editor, be sure to commit
2617
Note: ignore patterns containing shell wildcards must be quoted from
2621
Ignore the top level Makefile::
2623
bzr ignore ./Makefile
2625
Ignore class files in all directories::
2627
bzr ignore "*.class"
2629
Ignore .o files under the lib directory::
2631
bzr ignore "lib/**/*.o"
2633
Ignore .o files under the lib directory::
2635
bzr ignore "RE:lib/.*\.o"
2637
Ignore everything but the "debian" toplevel directory::
2639
bzr ignore "RE:(?!debian/).*"
2642
_see_also = ['status', 'ignored', 'patterns']
2643
takes_args = ['name_pattern*']
2645
Option('old-default-rules',
2646
help='Write out the ignore rules bzr < 0.9 always used.')
2649
def run(self, name_pattern_list=None, old_default_rules=None):
2650
from bzrlib import ignores
2651
if old_default_rules is not None:
2652
# dump the rules and exit
2653
for pattern in ignores.OLD_DEFAULTS:
2656
if not name_pattern_list:
2657
raise errors.BzrCommandError("ignore requires at least one "
2658
"NAME_PATTERN or --old-default-rules")
2659
name_pattern_list = [globbing.normalize_pattern(p)
2660
for p in name_pattern_list]
2661
for name_pattern in name_pattern_list:
2662
if (name_pattern[0] == '/' or
2663
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2664
raise errors.BzrCommandError(
2665
"NAME_PATTERN should not be an absolute path")
2666
tree, relpath = WorkingTree.open_containing(u'.')
2667
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2668
ignored = globbing.Globster(name_pattern_list)
2671
for entry in tree.list_files():
2675
if ignored.match(filename):
2676
matches.append(filename.encode('utf-8'))
2678
if len(matches) > 0:
2679
print "Warning: the following files are version controlled and" \
2680
" match your ignore pattern:\n%s" \
2681
"\nThese files will continue to be version controlled" \
2682
" unless you 'bzr remove' them." % ("\n".join(matches),)
2685
class cmd_ignored(Command):
2686
"""List ignored files and the patterns that matched them.
2688
List all the ignored files and the ignore pattern that caused the file to
2691
Alternatively, to list just the files::
2696
encoding_type = 'replace'
2697
_see_also = ['ignore', 'ls']
2701
tree = WorkingTree.open_containing(u'.')[0]
2704
for path, file_class, kind, file_id, entry in tree.list_files():
2705
if file_class != 'I':
2707
## XXX: Slightly inefficient since this was already calculated
2708
pat = tree.is_ignored(path)
2709
self.outf.write('%-50s %s\n' % (path, pat))
2714
class cmd_lookup_revision(Command):
2715
"""Lookup the revision-id from a revision-number
2718
bzr lookup-revision 33
2721
takes_args = ['revno']
2724
def run(self, revno):
2728
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2730
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2733
class cmd_export(Command):
2734
"""Export current or past revision to a destination directory or archive.
2736
If no revision is specified this exports the last committed revision.
2738
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2739
given, try to find the format with the extension. If no extension
2740
is found exports to a directory (equivalent to --format=dir).
2742
If root is supplied, it will be used as the root directory inside
2743
container formats (tar, zip, etc). If it is not supplied it will default
2744
to the exported filename. The root option has no effect for 'dir' format.
2746
If branch is omitted then the branch containing the current working
2747
directory will be used.
2749
Note: Export of tree with non-ASCII filenames to zip is not supported.
2751
================= =========================
2752
Supported formats Autodetected by extension
2753
================= =========================
2756
tbz2 .tar.bz2, .tbz2
2759
================= =========================
2761
takes_args = ['dest', 'branch_or_subdir?']
2764
help="Type of file to export to.",
2767
Option('filters', help='Apply content filters to export the '
2768
'convenient form.'),
2771
help="Name of the root directory inside the exported file."),
2773
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2774
root=None, filters=False):
2775
from bzrlib.export import export
2777
if branch_or_subdir is None:
2778
tree = WorkingTree.open_containing(u'.')[0]
2782
b, subdir = Branch.open_containing(branch_or_subdir)
2785
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2787
export(rev_tree, dest, format, root, subdir, filtered=filters)
2788
except errors.NoSuchExportFormat, e:
2789
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2792
class cmd_cat(Command):
2793
"""Write the contents of a file as of a given revision to standard output.
2795
If no revision is nominated, the last revision is used.
2797
Note: Take care to redirect standard output when using this command on a
2803
Option('name-from-revision', help='The path name in the old tree.'),
2804
Option('filters', help='Apply content filters to display the '
2805
'convenience form.'),
2808
takes_args = ['filename']
2809
encoding_type = 'exact'
2812
def run(self, filename, revision=None, name_from_revision=False,
2814
if revision is not None and len(revision) != 1:
2815
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2816
" one revision specifier")
2817
tree, branch, relpath = \
2818
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2821
return self._run(tree, branch, relpath, filename, revision,
2822
name_from_revision, filters)
2826
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2829
tree = b.basis_tree()
2830
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2832
old_file_id = rev_tree.path2id(relpath)
2834
if name_from_revision:
2835
# Try in revision if requested
2836
if old_file_id is None:
2837
raise errors.BzrCommandError(
2838
"%r is not present in revision %s" % (
2839
filename, rev_tree.get_revision_id()))
2841
content = rev_tree.get_file_text(old_file_id)
2843
cur_file_id = tree.path2id(relpath)
2845
if cur_file_id is not None:
2846
# Then try with the actual file id
2848
content = rev_tree.get_file_text(cur_file_id)
2850
except errors.NoSuchId:
2851
# The actual file id didn't exist at that time
2853
if not found and old_file_id is not None:
2854
# Finally try with the old file id
2855
content = rev_tree.get_file_text(old_file_id)
2858
# Can't be found anywhere
2859
raise errors.BzrCommandError(
2860
"%r is not present in revision %s" % (
2861
filename, rev_tree.get_revision_id()))
2863
from bzrlib.filters import (
2864
ContentFilterContext,
2865
filtered_output_bytes,
2867
filters = rev_tree._content_filter_stack(relpath)
2868
chunks = content.splitlines(True)
2869
content = filtered_output_bytes(chunks, filters,
2870
ContentFilterContext(relpath, rev_tree))
2871
self.outf.writelines(content)
2873
self.outf.write(content)
2876
class cmd_local_time_offset(Command):
2877
"""Show the offset in seconds from GMT to local time."""
2881
print osutils.local_time_offset()
2885
class cmd_commit(Command):
2886
"""Commit changes into a new revision.
2888
An explanatory message needs to be given for each commit. This is
2889
often done by using the --message option (getting the message from the
2890
command line) or by using the --file option (getting the message from
2891
a file). If neither of these options is given, an editor is opened for
2892
the user to enter the message. To see the changed files in the
2893
boilerplate text loaded into the editor, use the --show-diff option.
2895
By default, the entire tree is committed and the person doing the
2896
commit is assumed to be the author. These defaults can be overridden
2901
If selected files are specified, only changes to those files are
2902
committed. If a directory is specified then the directory and
2903
everything within it is committed.
2905
When excludes are given, they take precedence over selected files.
2906
For example, to commit only changes within foo, but not changes
2909
bzr commit foo -x foo/bar
2911
A selective commit after a merge is not yet supported.
2915
If the author of the change is not the same person as the committer,
2916
you can specify the author's name using the --author option. The
2917
name should be in the same format as a committer-id, e.g.
2918
"John Doe <jdoe@example.com>". If there is more than one author of
2919
the change you can specify the option multiple times, once for each
2924
A common mistake is to forget to add a new file or directory before
2925
running the commit command. The --strict option checks for unknown
2926
files and aborts the commit if any are found. More advanced pre-commit
2927
checks can be implemented by defining hooks. See ``bzr help hooks``
2932
If you accidentially commit the wrong changes or make a spelling
2933
mistake in the commit message say, you can use the uncommit command
2934
to undo it. See ``bzr help uncommit`` for details.
2936
Hooks can also be configured to run after a commit. This allows you
2937
to trigger updates to external systems like bug trackers. The --fixes
2938
option can be used to record the association between a revision and
2939
one or more bugs. See ``bzr help bugs`` for details.
2941
A selective commit may fail in some cases where the committed
2942
tree would be invalid. Consider::
2947
bzr commit foo -m "committing foo"
2948
bzr mv foo/bar foo/baz
2951
bzr commit foo/bar -m "committing bar but not baz"
2953
In the example above, the last commit will fail by design. This gives
2954
the user the opportunity to decide whether they want to commit the
2955
rename at the same time, separately first, or not at all. (As a general
2956
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2958
# TODO: Run hooks on tree to-be-committed, and after commit.
2960
# TODO: Strict commit that fails if there are deleted files.
2961
# (what does "deleted files" mean ??)
2963
# TODO: Give better message for -s, --summary, used by tla people
2965
# XXX: verbose currently does nothing
2967
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2968
takes_args = ['selected*']
2970
ListOption('exclude', type=str, short_name='x',
2971
help="Do not consider changes made to a given path."),
2972
Option('message', type=unicode,
2974
help="Description of the new revision."),
2977
help='Commit even if nothing has changed.'),
2978
Option('file', type=str,
2981
help='Take commit message from this file.'),
2983
help="Refuse to commit if there are unknown "
2984
"files in the working tree."),
2985
Option('commit-time', type=str,
2986
help="Manually set a commit time using commit date "
2987
"format, e.g. '2009-10-10 08:00:00 +0100'."),
2988
ListOption('fixes', type=str,
2989
help="Mark a bug as being fixed by this revision "
2990
"(see \"bzr help bugs\")."),
2991
ListOption('author', type=unicode,
2992
help="Set the author's name, if it's different "
2993
"from the committer."),
2995
help="Perform a local commit in a bound "
2996
"branch. Local commits are not pushed to "
2997
"the master branch until a normal commit "
3001
help='When no message is supplied, show the diff along'
3002
' with the status summary in the message editor.'),
3004
aliases = ['ci', 'checkin']
3006
def _iter_bug_fix_urls(self, fixes, branch):
3007
# Configure the properties for bug fixing attributes.
3008
for fixed_bug in fixes:
3009
tokens = fixed_bug.split(':')
3010
if len(tokens) != 2:
3011
raise errors.BzrCommandError(
3012
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3013
"See \"bzr help bugs\" for more information on this "
3014
"feature.\nCommit refused." % fixed_bug)
3015
tag, bug_id = tokens
3017
yield bugtracker.get_bug_url(tag, branch, bug_id)
3018
except errors.UnknownBugTrackerAbbreviation:
3019
raise errors.BzrCommandError(
3020
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3021
except errors.MalformedBugIdentifier, e:
3022
raise errors.BzrCommandError(
3023
"%s\nCommit refused." % (str(e),))
3025
def run(self, message=None, file=None, verbose=False, selected_list=None,
3026
unchanged=False, strict=False, local=False, fixes=None,
3027
author=None, show_diff=False, exclude=None, commit_time=None):
3028
from bzrlib.errors import (
3033
from bzrlib.msgeditor import (
3034
edit_commit_message_encoded,
3035
generate_commit_message_template,
3036
make_commit_message_template_encoded
3039
commit_stamp = offset = None
3040
if commit_time is not None:
3042
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3043
except ValueError, e:
3044
raise errors.BzrCommandError(
3045
"Could not parse --commit-time: " + str(e))
3047
# TODO: Need a blackbox test for invoking the external editor; may be
3048
# slightly problematic to run this cross-platform.
3050
# TODO: do more checks that the commit will succeed before
3051
# spending the user's valuable time typing a commit message.
3055
tree, selected_list = tree_files(selected_list)
3056
if selected_list == ['']:
3057
# workaround - commit of root of tree should be exactly the same
3058
# as just default commit in that tree, and succeed even though
3059
# selected-file merge commit is not done yet
3064
bug_property = bugtracker.encode_fixes_bug_urls(
3065
self._iter_bug_fix_urls(fixes, tree.branch))
3067
properties['bugs'] = bug_property
3069
if local and not tree.branch.get_bound_location():
3070
raise errors.LocalRequiresBoundBranch()
3072
def get_message(commit_obj):
3073
"""Callback to get commit message"""
3074
my_message = message
3075
if my_message is not None and '\r' in my_message:
3076
my_message = my_message.replace('\r\n', '\n')
3077
my_message = my_message.replace('\r', '\n')
3078
if my_message is None and not file:
3079
t = make_commit_message_template_encoded(tree,
3080
selected_list, diff=show_diff,
3081
output_encoding=osutils.get_user_encoding())
3082
start_message = generate_commit_message_template(commit_obj)
3083
my_message = edit_commit_message_encoded(t,
3084
start_message=start_message)
3085
if my_message is None:
3086
raise errors.BzrCommandError("please specify a commit"
3087
" message with either --message or --file")
3088
elif my_message and file:
3089
raise errors.BzrCommandError(
3090
"please specify either --message or --file")
3092
my_message = codecs.open(file, 'rt',
3093
osutils.get_user_encoding()).read()
3094
if my_message == "":
3095
raise errors.BzrCommandError("empty commit message specified")
3098
# The API permits a commit with a filter of [] to mean 'select nothing'
3099
# but the command line should not do that.
3100
if not selected_list:
3101
selected_list = None
3103
tree.commit(message_callback=get_message,
3104
specific_files=selected_list,
3105
allow_pointless=unchanged, strict=strict, local=local,
3106
reporter=None, verbose=verbose, revprops=properties,
3107
authors=author, timestamp=commit_stamp,
3109
exclude=safe_relpath_files(tree, exclude))
3110
except PointlessCommit:
3111
# FIXME: This should really happen before the file is read in;
3112
# perhaps prepare the commit; get the message; then actually commit
3113
raise errors.BzrCommandError("No changes to commit."
3114
" Use --unchanged to commit anyhow.")
3115
except ConflictsInTree:
3116
raise errors.BzrCommandError('Conflicts detected in working '
3117
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3119
except StrictCommitFailed:
3120
raise errors.BzrCommandError("Commit refused because there are"
3121
" unknown files in the working tree.")
3122
except errors.BoundBranchOutOfDate, e:
3123
raise errors.BzrCommandError(str(e) + "\n"
3124
'To commit to master branch, run update and then commit.\n'
3125
'You can also pass --local to commit to continue working '
3129
class cmd_check(Command):
3130
"""Validate working tree structure, branch consistency and repository history.
3132
This command checks various invariants about branch and repository storage
3133
to detect data corruption or bzr bugs.
3135
The working tree and branch checks will only give output if a problem is
3136
detected. The output fields of the repository check are:
3139
This is just the number of revisions checked. It doesn't
3143
This is just the number of versionedfiles checked. It
3144
doesn't indicate a problem.
3146
unreferenced ancestors
3147
Texts that are ancestors of other texts, but
3148
are not properly referenced by the revision ancestry. This is a
3149
subtle problem that Bazaar can work around.
3152
This is the total number of unique file contents
3153
seen in the checked revisions. It does not indicate a problem.
3156
This is the total number of repeated texts seen
3157
in the checked revisions. Texts can be repeated when their file
3158
entries are modified, but the file contents are not. It does not
3161
If no restrictions are specified, all Bazaar data that is found at the given
3162
location will be checked.
3166
Check the tree and branch at 'foo'::
3168
bzr check --tree --branch foo
3170
Check only the repository at 'bar'::
3172
bzr check --repo bar
3174
Check everything at 'baz'::
3179
_see_also = ['reconcile']
3180
takes_args = ['path?']
3181
takes_options = ['verbose',
3182
Option('branch', help="Check the branch related to the"
3183
" current directory."),
3184
Option('repo', help="Check the repository related to the"
3185
" current directory."),
3186
Option('tree', help="Check the working tree related to"
3187
" the current directory.")]
3189
def run(self, path=None, verbose=False, branch=False, repo=False,
3191
from bzrlib.check import check_dwim
3194
if not branch and not repo and not tree:
3195
branch = repo = tree = True
3196
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3199
class cmd_upgrade(Command):
3200
"""Upgrade branch storage to current format.
3202
The check command or bzr developers may sometimes advise you to run
3203
this command. When the default format has changed you may also be warned
3204
during other operations to upgrade.
3207
_see_also = ['check']
3208
takes_args = ['url?']
3210
RegistryOption('format',
3211
help='Upgrade to a specific format. See "bzr help'
3212
' formats" for details.',
3213
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3214
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3215
value_switches=True, title='Branch format'),
3218
def run(self, url='.', format=None):
3219
from bzrlib.upgrade import upgrade
3220
upgrade(url, format)
3223
class cmd_whoami(Command):
3224
"""Show or set bzr user id.
3227
Show the email of the current user::
3231
Set the current user::
3233
bzr whoami "Frank Chu <fchu@example.com>"
3235
takes_options = [ Option('email',
3236
help='Display email address only.'),
3238
help='Set identity for the current branch instead of '
3241
takes_args = ['name?']
3242
encoding_type = 'replace'
3245
def run(self, email=False, branch=False, name=None):
3247
# use branch if we're inside one; otherwise global config
3249
c = Branch.open_containing('.')[0].get_config()
3250
except errors.NotBranchError:
3251
c = config.GlobalConfig()
3253
self.outf.write(c.user_email() + '\n')
3255
self.outf.write(c.username() + '\n')
3258
# display a warning if an email address isn't included in the given name.
3260
config.extract_email_address(name)
3261
except errors.NoEmailInUsername, e:
3262
warning('"%s" does not seem to contain an email address. '
3263
'This is allowed, but not recommended.', name)
3265
# use global config unless --branch given
3267
c = Branch.open_containing('.')[0].get_config()
3269
c = config.GlobalConfig()
3270
c.set_user_option('email', name)
3273
class cmd_nick(Command):
3274
"""Print or set the branch nickname.
3276
If unset, the tree root directory name is used as the nickname.
3277
To print the current nickname, execute with no argument.
3279
Bound branches use the nickname of its master branch unless it is set
3283
_see_also = ['info']
3284
takes_args = ['nickname?']
3285
def run(self, nickname=None):
3286
branch = Branch.open_containing(u'.')[0]
3287
if nickname is None:
3288
self.printme(branch)
3290
branch.nick = nickname
3293
def printme(self, branch):
3297
class cmd_alias(Command):
3298
"""Set/unset and display aliases.
3301
Show the current aliases::
3305
Show the alias specified for 'll'::
3309
Set an alias for 'll'::
3311
bzr alias ll="log --line -r-10..-1"
3313
To remove an alias for 'll'::
3315
bzr alias --remove ll
3318
takes_args = ['name?']
3320
Option('remove', help='Remove the alias.'),
3323
def run(self, name=None, remove=False):
3325
self.remove_alias(name)
3327
self.print_aliases()
3329
equal_pos = name.find('=')
3331
self.print_alias(name)
3333
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3335
def remove_alias(self, alias_name):
3336
if alias_name is None:
3337
raise errors.BzrCommandError(
3338
'bzr alias --remove expects an alias to remove.')
3339
# If alias is not found, print something like:
3340
# unalias: foo: not found
3341
c = config.GlobalConfig()
3342
c.unset_alias(alias_name)
3345
def print_aliases(self):
3346
"""Print out the defined aliases in a similar format to bash."""
3347
aliases = config.GlobalConfig().get_aliases()
3348
for key, value in sorted(aliases.iteritems()):
3349
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3352
def print_alias(self, alias_name):
3353
from bzrlib.commands import get_alias
3354
alias = get_alias(alias_name)
3356
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3359
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3361
def set_alias(self, alias_name, alias_command):
3362
"""Save the alias in the global config."""
3363
c = config.GlobalConfig()
3364
c.set_alias(alias_name, alias_command)
3367
class cmd_selftest(Command):
3368
"""Run internal test suite.
3370
If arguments are given, they are regular expressions that say which tests
3371
should run. Tests matching any expression are run, and other tests are
3374
Alternatively if --first is given, matching tests are run first and then
3375
all other tests are run. This is useful if you have been working in a
3376
particular area, but want to make sure nothing else was broken.
3378
If --exclude is given, tests that match that regular expression are
3379
excluded, regardless of whether they match --first or not.
3381
To help catch accidential dependencies between tests, the --randomize
3382
option is useful. In most cases, the argument used is the word 'now'.
3383
Note that the seed used for the random number generator is displayed
3384
when this option is used. The seed can be explicitly passed as the
3385
argument to this option if required. This enables reproduction of the
3386
actual ordering used if and when an order sensitive problem is encountered.
3388
If --list-only is given, the tests that would be run are listed. This is
3389
useful when combined with --first, --exclude and/or --randomize to
3390
understand their impact. The test harness reports "Listed nn tests in ..."
3391
instead of "Ran nn tests in ..." when list mode is enabled.
3393
If the global option '--no-plugins' is given, plugins are not loaded
3394
before running the selftests. This has two effects: features provided or
3395
modified by plugins will not be tested, and tests provided by plugins will
3398
Tests that need working space on disk use a common temporary directory,
3399
typically inside $TMPDIR or /tmp.
3401
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3402
into a pdb postmortem session.
3405
Run only tests relating to 'ignore'::
3409
Disable plugins and list tests as they're run::
3411
bzr --no-plugins selftest -v
3413
# NB: this is used from the class without creating an instance, which is
3414
# why it does not have a self parameter.
3415
def get_transport_type(typestring):
3416
"""Parse and return a transport specifier."""
3417
if typestring == "sftp":
3418
from bzrlib.transport.sftp import SFTPAbsoluteServer
3419
return SFTPAbsoluteServer
3420
if typestring == "memory":
3421
from bzrlib.transport.memory import MemoryServer
3423
if typestring == "fakenfs":
3424
from bzrlib.transport.fakenfs import FakeNFSServer
3425
return FakeNFSServer
3426
msg = "No known transport type %s. Supported types are: sftp\n" %\
3428
raise errors.BzrCommandError(msg)
3431
takes_args = ['testspecs*']
3432
takes_options = ['verbose',
3434
help='Stop when one test fails.',
3438
help='Use a different transport by default '
3439
'throughout the test suite.',
3440
type=get_transport_type),
3442
help='Run the benchmarks rather than selftests.'),
3443
Option('lsprof-timed',
3444
help='Generate lsprof output for benchmarked'
3445
' sections of code.'),
3446
Option('lsprof-tests',
3447
help='Generate lsprof output for each test.'),
3448
Option('cache-dir', type=str,
3449
help='Cache intermediate benchmark output in this '
3452
help='Run all tests, but run specified tests first.',
3456
help='List the tests instead of running them.'),
3457
RegistryOption('parallel',
3458
help="Run the test suite in parallel.",
3459
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3460
value_switches=False,
3462
Option('randomize', type=str, argname="SEED",
3463
help='Randomize the order of tests using the given'
3464
' seed or "now" for the current time.'),
3465
Option('exclude', type=str, argname="PATTERN",
3467
help='Exclude tests that match this regular'
3470
help='Output test progress via subunit.'),
3471
Option('strict', help='Fail on missing dependencies or '
3473
Option('load-list', type=str, argname='TESTLISTFILE',
3474
help='Load a test id list from a text file.'),
3475
ListOption('debugflag', type=str, short_name='E',
3476
help='Turn on a selftest debug flag.'),
3477
ListOption('starting-with', type=str, argname='TESTID',
3478
param_name='starting_with', short_name='s',
3480
'Load only the tests starting with TESTID.'),
3482
encoding_type = 'replace'
3485
Command.__init__(self)
3486
self.additional_selftest_args = {}
3488
def run(self, testspecs_list=None, verbose=False, one=False,
3489
transport=None, benchmark=None,
3490
lsprof_timed=None, cache_dir=None,
3491
first=False, list_only=False,
3492
randomize=None, exclude=None, strict=False,
3493
load_list=None, debugflag=None, starting_with=None, subunit=False,
3494
parallel=None, lsprof_tests=False):
3495
from bzrlib.tests import selftest
3496
import bzrlib.benchmarks as benchmarks
3497
from bzrlib.benchmarks import tree_creator
3499
# Make deprecation warnings visible, unless -Werror is set
3500
symbol_versioning.activate_deprecation_warnings(override=False)
3502
if cache_dir is not None:
3503
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3504
if testspecs_list is not None:
3505
pattern = '|'.join(testspecs_list)
3510
from bzrlib.tests import SubUnitBzrRunner
3512
raise errors.BzrCommandError("subunit not available. subunit "
3513
"needs to be installed to use --subunit.")
3514
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3516
self.additional_selftest_args.setdefault(
3517
'suite_decorators', []).append(parallel)
3519
test_suite_factory = benchmarks.test_suite
3520
# Unless user explicitly asks for quiet, be verbose in benchmarks
3521
verbose = not is_quiet()
3522
# TODO: should possibly lock the history file...
3523
benchfile = open(".perf_history", "at", buffering=1)
3525
test_suite_factory = None
3528
selftest_kwargs = {"verbose": verbose,
3530
"stop_on_failure": one,
3531
"transport": transport,
3532
"test_suite_factory": test_suite_factory,
3533
"lsprof_timed": lsprof_timed,
3534
"lsprof_tests": lsprof_tests,
3535
"bench_history": benchfile,
3536
"matching_tests_first": first,
3537
"list_only": list_only,
3538
"random_seed": randomize,
3539
"exclude_pattern": exclude,
3541
"load_list": load_list,
3542
"debug_flags": debugflag,
3543
"starting_with": starting_with
3545
selftest_kwargs.update(self.additional_selftest_args)
3546
result = selftest(**selftest_kwargs)
3548
if benchfile is not None:
3550
return int(not result)
3553
class cmd_version(Command):
3554
"""Show version of bzr."""
3556
encoding_type = 'replace'
3558
Option("short", help="Print just the version number."),
3562
def run(self, short=False):
3563
from bzrlib.version import show_version
3565
self.outf.write(bzrlib.version_string + '\n')
3567
show_version(to_file=self.outf)
3570
class cmd_rocks(Command):
3571
"""Statement of optimism."""
3577
print "It sure does!"
3580
class cmd_find_merge_base(Command):
3581
"""Find and print a base revision for merging two branches."""
3582
# TODO: Options to specify revisions on either side, as if
3583
# merging only part of the history.
3584
takes_args = ['branch', 'other']
3588
def run(self, branch, other):
3589
from bzrlib.revision import ensure_null
3591
branch1 = Branch.open_containing(branch)[0]
3592
branch2 = Branch.open_containing(other)[0]
3597
last1 = ensure_null(branch1.last_revision())
3598
last2 = ensure_null(branch2.last_revision())
3600
graph = branch1.repository.get_graph(branch2.repository)
3601
base_rev_id = graph.find_unique_lca(last1, last2)
3603
print 'merge base is revision %s' % base_rev_id
3610
class cmd_merge(Command):
3611
"""Perform a three-way merge.
3613
The source of the merge can be specified either in the form of a branch,
3614
or in the form of a path to a file containing a merge directive generated
3615
with bzr send. If neither is specified, the default is the upstream branch
3616
or the branch most recently merged using --remember.
3618
When merging a branch, by default the tip will be merged. To pick a different
3619
revision, pass --revision. If you specify two values, the first will be used as
3620
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3621
available revisions, like this is commonly referred to as "cherrypicking".
3623
Revision numbers are always relative to the branch being merged.
3625
By default, bzr will try to merge in all new work from the other
3626
branch, automatically determining an appropriate base. If this
3627
fails, you may need to give an explicit base.
3629
Merge will do its best to combine the changes in two branches, but there
3630
are some kinds of problems only a human can fix. When it encounters those,
3631
it will mark a conflict. A conflict means that you need to fix something,
3632
before you should commit.
3634
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3636
If there is no default branch set, the first merge will set it. After
3637
that, you can omit the branch to use the default. To change the
3638
default, use --remember. The value will only be saved if the remote
3639
location can be accessed.
3641
The results of the merge are placed into the destination working
3642
directory, where they can be reviewed (with bzr diff), tested, and then
3643
committed to record the result of the merge.
3645
merge refuses to run if there are any uncommitted changes, unless
3648
To select only some changes to merge, use "merge -i", which will prompt
3649
you to apply each diff hunk and file change, similar to "shelve".
3652
To merge the latest revision from bzr.dev::
3654
bzr merge ../bzr.dev
3656
To merge changes up to and including revision 82 from bzr.dev::
3658
bzr merge -r 82 ../bzr.dev
3660
To merge the changes introduced by 82, without previous changes::
3662
bzr merge -r 81..82 ../bzr.dev
3664
To apply a merge directive contained in /tmp/merge::
3666
bzr merge /tmp/merge
3669
encoding_type = 'exact'
3670
_see_also = ['update', 'remerge', 'status-flags', 'send']
3671
takes_args = ['location?']
3676
help='Merge even if the destination tree has uncommitted changes.'),
3680
Option('show-base', help="Show base revision text in "
3682
Option('uncommitted', help='Apply uncommitted changes'
3683
' from a working copy, instead of branch changes.'),
3684
Option('pull', help='If the destination is already'
3685
' completely merged into the source, pull from the'
3686
' source rather than merging. When this happens,'
3687
' you do not need to commit the result.'),
3689
help='Branch to merge into, '
3690
'rather than the one containing the working directory.',
3694
Option('preview', help='Instead of merging, show a diff of the'
3696
Option('interactive', help='Select changes interactively.',
3700
def run(self, location=None, revision=None, force=False,
3701
merge_type=None, show_base=False, reprocess=None, remember=False,
3702
uncommitted=False, pull=False,
3707
if merge_type is None:
3708
merge_type = _mod_merge.Merge3Merger
3710
if directory is None: directory = u'.'
3711
possible_transports = []
3713
allow_pending = True
3714
verified = 'inapplicable'
3715
tree = WorkingTree.open_containing(directory)[0]
3718
basis_tree = tree.revision_tree(tree.last_revision())
3719
except errors.NoSuchRevision:
3720
basis_tree = tree.basis_tree()
3722
# die as quickly as possible if there are uncommitted changes
3724
if tree.has_changes():
3725
raise errors.UncommittedChanges(tree)
3727
view_info = _get_view_info_for_change_reporter(tree)
3728
change_reporter = delta._ChangeReporter(
3729
unversioned_filter=tree.is_ignored, view_info=view_info)
3732
pb = ui.ui_factory.nested_progress_bar()
3733
cleanups.append(pb.finished)
3735
cleanups.append(tree.unlock)
3736
if location is not None:
3738
mergeable = bundle.read_mergeable_from_url(location,
3739
possible_transports=possible_transports)
3740
except errors.NotABundle:
3744
raise errors.BzrCommandError('Cannot use --uncommitted'
3745
' with bundles or merge directives.')
3747
if revision is not None:
3748
raise errors.BzrCommandError(
3749
'Cannot use -r with merge directives or bundles')
3750
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3753
if merger is None and uncommitted:
3754
if revision is not None and len(revision) > 0:
3755
raise errors.BzrCommandError('Cannot use --uncommitted and'
3756
' --revision at the same time.')
3757
merger = self.get_merger_from_uncommitted(tree, location, pb,
3759
allow_pending = False
3762
merger, allow_pending = self._get_merger_from_branch(tree,
3763
location, revision, remember, possible_transports, pb)
3765
merger.merge_type = merge_type
3766
merger.reprocess = reprocess
3767
merger.show_base = show_base
3768
self.sanity_check_merger(merger)
3769
if (merger.base_rev_id == merger.other_rev_id and
3770
merger.other_rev_id is not None):
3771
note('Nothing to do.')
3774
if merger.interesting_files is not None:
3775
raise errors.BzrCommandError('Cannot pull individual files')
3776
if (merger.base_rev_id == tree.last_revision()):
3777
result = tree.pull(merger.other_branch, False,
3778
merger.other_rev_id)
3779
result.report(self.outf)
3781
if merger.this_basis is None:
3782
raise errors.BzrCommandError(
3783
"This branch has no commits."
3784
" (perhaps you would prefer 'bzr pull')")
3786
return self._do_preview(merger, cleanups)
3788
return self._do_interactive(merger, cleanups)
3790
return self._do_merge(merger, change_reporter, allow_pending,
3793
for cleanup in reversed(cleanups):
3796
def _get_preview(self, merger, cleanups):
3797
tree_merger = merger.make_merger()
3798
tt = tree_merger.make_preview_transform()
3799
cleanups.append(tt.finalize)
3800
result_tree = tt.get_preview_tree()
3803
def _do_preview(self, merger, cleanups):
3804
from bzrlib.diff import show_diff_trees
3805
result_tree = self._get_preview(merger, cleanups)
3806
show_diff_trees(merger.this_tree, result_tree, self.outf,
3807
old_label='', new_label='')
3809
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3810
merger.change_reporter = change_reporter
3811
conflict_count = merger.do_merge()
3813
merger.set_pending()
3814
if verified == 'failed':
3815
warning('Preview patch does not match changes')
3816
if conflict_count != 0:
3821
def _do_interactive(self, merger, cleanups):
3822
"""Perform an interactive merge.
3824
This works by generating a preview tree of the merge, then using
3825
Shelver to selectively remove the differences between the working tree
3826
and the preview tree.
3828
from bzrlib import shelf_ui
3829
result_tree = self._get_preview(merger, cleanups)
3830
writer = bzrlib.option.diff_writer_registry.get()
3831
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3832
reporter=shelf_ui.ApplyReporter(),
3833
diff_writer=writer(sys.stdout))
3836
def sanity_check_merger(self, merger):
3837
if (merger.show_base and
3838
not merger.merge_type is _mod_merge.Merge3Merger):
3839
raise errors.BzrCommandError("Show-base is not supported for this"
3840
" merge type. %s" % merger.merge_type)
3841
if merger.reprocess is None:
3842
if merger.show_base:
3843
merger.reprocess = False
3845
# Use reprocess if the merger supports it
3846
merger.reprocess = merger.merge_type.supports_reprocess
3847
if merger.reprocess and not merger.merge_type.supports_reprocess:
3848
raise errors.BzrCommandError("Conflict reduction is not supported"
3849
" for merge type %s." %
3851
if merger.reprocess and merger.show_base:
3852
raise errors.BzrCommandError("Cannot do conflict reduction and"
3855
def _get_merger_from_branch(self, tree, location, revision, remember,
3856
possible_transports, pb):
3857
"""Produce a merger from a location, assuming it refers to a branch."""
3858
from bzrlib.tag import _merge_tags_if_possible
3859
# find the branch locations
3860
other_loc, user_location = self._select_branch_location(tree, location,
3862
if revision is not None and len(revision) == 2:
3863
base_loc, _unused = self._select_branch_location(tree,
3864
location, revision, 0)
3866
base_loc = other_loc
3868
other_branch, other_path = Branch.open_containing(other_loc,
3869
possible_transports)
3870
if base_loc == other_loc:
3871
base_branch = other_branch
3873
base_branch, base_path = Branch.open_containing(base_loc,
3874
possible_transports)
3875
# Find the revision ids
3876
other_revision_id = None
3877
base_revision_id = None
3878
if revision is not None:
3879
if len(revision) >= 1:
3880
other_revision_id = revision[-1].as_revision_id(other_branch)
3881
if len(revision) == 2:
3882
base_revision_id = revision[0].as_revision_id(base_branch)
3883
if other_revision_id is None:
3884
other_revision_id = _mod_revision.ensure_null(
3885
other_branch.last_revision())
3886
# Remember where we merge from
3887
if ((remember or tree.branch.get_submit_branch() is None) and
3888
user_location is not None):
3889
tree.branch.set_submit_branch(other_branch.base)
3890
_merge_tags_if_possible(other_branch, tree.branch)
3891
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3892
other_revision_id, base_revision_id, other_branch, base_branch)
3893
if other_path != '':
3894
allow_pending = False
3895
merger.interesting_files = [other_path]
3897
allow_pending = True
3898
return merger, allow_pending
3900
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3901
"""Get a merger for uncommitted changes.
3903
:param tree: The tree the merger should apply to.
3904
:param location: The location containing uncommitted changes.
3905
:param pb: The progress bar to use for showing progress.
3906
:param cleanups: A list of operations to perform to clean up the
3907
temporary directories, unfinalized objects, etc.
3909
location = self._select_branch_location(tree, location)[0]
3910
other_tree, other_path = WorkingTree.open_containing(location)
3911
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3912
if other_path != '':
3913
merger.interesting_files = [other_path]
3916
def _select_branch_location(self, tree, user_location, revision=None,
3918
"""Select a branch location, according to possible inputs.
3920
If provided, branches from ``revision`` are preferred. (Both
3921
``revision`` and ``index`` must be supplied.)
3923
Otherwise, the ``location`` parameter is used. If it is None, then the
3924
``submit`` or ``parent`` location is used, and a note is printed.
3926
:param tree: The working tree to select a branch for merging into
3927
:param location: The location entered by the user
3928
:param revision: The revision parameter to the command
3929
:param index: The index to use for the revision parameter. Negative
3930
indices are permitted.
3931
:return: (selected_location, user_location). The default location
3932
will be the user-entered location.
3934
if (revision is not None and index is not None
3935
and revision[index] is not None):
3936
branch = revision[index].get_branch()
3937
if branch is not None:
3938
return branch, branch
3939
if user_location is None:
3940
location = self._get_remembered(tree, 'Merging from')
3942
location = user_location
3943
return location, user_location
3945
def _get_remembered(self, tree, verb_string):
3946
"""Use tree.branch's parent if none was supplied.
3948
Report if the remembered location was used.
3950
stored_location = tree.branch.get_submit_branch()
3951
stored_location_type = "submit"
3952
if stored_location is None:
3953
stored_location = tree.branch.get_parent()
3954
stored_location_type = "parent"
3955
mutter("%s", stored_location)
3956
if stored_location is None:
3957
raise errors.BzrCommandError("No location specified or remembered")
3958
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3959
note(u"%s remembered %s location %s", verb_string,
3960
stored_location_type, display_url)
3961
return stored_location
3964
class cmd_remerge(Command):
3967
Use this if you want to try a different merge technique while resolving
3968
conflicts. Some merge techniques are better than others, and remerge
3969
lets you try different ones on different files.
3971
The options for remerge have the same meaning and defaults as the ones for
3972
merge. The difference is that remerge can (only) be run when there is a
3973
pending merge, and it lets you specify particular files.
3976
Re-do the merge of all conflicted files, and show the base text in
3977
conflict regions, in addition to the usual THIS and OTHER texts::
3979
bzr remerge --show-base
3981
Re-do the merge of "foobar", using the weave merge algorithm, with
3982
additional processing to reduce the size of conflict regions::
3984
bzr remerge --merge-type weave --reprocess foobar
3986
takes_args = ['file*']
3991
help="Show base revision text in conflicts."),
3994
def run(self, file_list=None, merge_type=None, show_base=False,
3996
if merge_type is None:
3997
merge_type = _mod_merge.Merge3Merger
3998
tree, file_list = tree_files(file_list)
4001
parents = tree.get_parent_ids()
4002
if len(parents) != 2:
4003
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4004
" merges. Not cherrypicking or"
4006
repository = tree.branch.repository
4007
interesting_ids = None
4009
conflicts = tree.conflicts()
4010
if file_list is not None:
4011
interesting_ids = set()
4012
for filename in file_list:
4013
file_id = tree.path2id(filename)
4015
raise errors.NotVersionedError(filename)
4016
interesting_ids.add(file_id)
4017
if tree.kind(file_id) != "directory":
4020
for name, ie in tree.inventory.iter_entries(file_id):
4021
interesting_ids.add(ie.file_id)
4022
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4024
# Remerge only supports resolving contents conflicts
4025
allowed_conflicts = ('text conflict', 'contents conflict')
4026
restore_files = [c.path for c in conflicts
4027
if c.typestring in allowed_conflicts]
4028
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4029
tree.set_conflicts(ConflictList(new_conflicts))
4030
if file_list is not None:
4031
restore_files = file_list
4032
for filename in restore_files:
4034
restore(tree.abspath(filename))
4035
except errors.NotConflicted:
4037
# Disable pending merges, because the file texts we are remerging
4038
# have not had those merges performed. If we use the wrong parents
4039
# list, we imply that the working tree text has seen and rejected
4040
# all the changes from the other tree, when in fact those changes
4041
# have not yet been seen.
4042
pb = ui.ui_factory.nested_progress_bar()
4043
tree.set_parent_ids(parents[:1])
4045
merger = _mod_merge.Merger.from_revision_ids(pb,
4047
merger.interesting_ids = interesting_ids
4048
merger.merge_type = merge_type
4049
merger.show_base = show_base
4050
merger.reprocess = reprocess
4051
conflicts = merger.do_merge()
4053
tree.set_parent_ids(parents)
4063
class cmd_revert(Command):
4064
"""Revert files to a previous revision.
4066
Giving a list of files will revert only those files. Otherwise, all files
4067
will be reverted. If the revision is not specified with '--revision', the
4068
last committed revision is used.
4070
To remove only some changes, without reverting to a prior version, use
4071
merge instead. For example, "merge . --revision -2..-3" will remove the
4072
changes introduced by -2, without affecting the changes introduced by -1.
4073
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4075
By default, any files that have been manually changed will be backed up
4076
first. (Files changed only by merge are not backed up.) Backup files have
4077
'.~#~' appended to their name, where # is a number.
4079
When you provide files, you can use their current pathname or the pathname
4080
from the target revision. So you can use revert to "undelete" a file by
4081
name. If you name a directory, all the contents of that directory will be
4084
If you have newly added files since the target revision, they will be
4085
removed. If the files to be removed have been changed, backups will be
4086
created as above. Directories containing unknown files will not be
4089
The working tree contains a list of pending merged revisions, which will
4090
be included as parents in the next commit. Normally, revert clears that
4091
list as well as reverting the files. If any files are specified, revert
4092
leaves the pending merge list alone and reverts only the files. Use "bzr
4093
revert ." in the tree root to revert all files but keep the merge record,
4094
and "bzr revert --forget-merges" to clear the pending merge list without
4095
reverting any files.
4097
Using "bzr revert --forget-merges", it is possible to apply the changes
4098
from an arbitrary merge as a single revision. To do this, perform the
4099
merge as desired. Then doing revert with the "--forget-merges" option will
4100
keep the content of the tree as it was, but it will clear the list of
4101
pending merges. The next commit will then contain all of the changes that
4102
would have been in the merge, but without any mention of the other parent
4103
revisions. Because this technique forgets where these changes originated,
4104
it may cause additional conflicts on later merges involving the source and
4108
_see_also = ['cat', 'export']
4111
Option('no-backup', "Do not save backups of reverted files."),
4112
Option('forget-merges',
4113
'Remove pending merge marker, without changing any files.'),
4115
takes_args = ['file*']
4117
def run(self, revision=None, no_backup=False, file_list=None,
4118
forget_merges=None):
4119
tree, file_list = tree_files(file_list)
4123
tree.set_parent_ids(tree.get_parent_ids()[:1])
4125
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4130
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4131
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4132
pb = ui.ui_factory.nested_progress_bar()
4134
tree.revert(file_list, rev_tree, not no_backup, pb,
4135
report_changes=True)
4140
class cmd_assert_fail(Command):
4141
"""Test reporting of assertion failures"""
4142
# intended just for use in testing
4147
raise AssertionError("always fails")
4150
class cmd_help(Command):
4151
"""Show help on a command or other topic.
4154
_see_also = ['topics']
4156
Option('long', 'Show help on all commands.'),
4158
takes_args = ['topic?']
4159
aliases = ['?', '--help', '-?', '-h']
4162
def run(self, topic=None, long=False):
4164
if topic is None and long:
4166
bzrlib.help.help(topic)
4169
class cmd_shell_complete(Command):
4170
"""Show appropriate completions for context.
4172
For a list of all available commands, say 'bzr shell-complete'.
4174
takes_args = ['context?']
4179
def run(self, context=None):
4180
import shellcomplete
4181
shellcomplete.shellcomplete(context)
4184
class cmd_missing(Command):
4185
"""Show unmerged/unpulled revisions between two branches.
4187
OTHER_BRANCH may be local or remote.
4189
To filter on a range of revisions, you can use the command -r begin..end
4190
-r revision requests a specific revision, -r ..end or -r begin.. are
4194
1 - some missing revisions
4195
0 - no missing revisions
4199
Determine the missing revisions between this and the branch at the
4200
remembered pull location::
4204
Determine the missing revisions between this and another branch::
4206
bzr missing http://server/branch
4208
Determine the missing revisions up to a specific revision on the other
4211
bzr missing -r ..-10
4213
Determine the missing revisions up to a specific revision on this
4216
bzr missing --my-revision ..-10
4219
_see_also = ['merge', 'pull']
4220
takes_args = ['other_branch?']
4222
Option('reverse', 'Reverse the order of revisions.'),
4224
'Display changes in the local branch only.'),
4225
Option('this' , 'Same as --mine-only.'),
4226
Option('theirs-only',
4227
'Display changes in the remote branch only.'),
4228
Option('other', 'Same as --theirs-only.'),
4232
custom_help('revision',
4233
help='Filter on other branch revisions (inclusive). '
4234
'See "help revisionspec" for details.'),
4235
Option('my-revision',
4236
type=_parse_revision_str,
4237
help='Filter on local branch revisions (inclusive). '
4238
'See "help revisionspec" for details.'),
4239
Option('include-merges',
4240
'Show all revisions in addition to the mainline ones.'),
4242
encoding_type = 'replace'
4245
def run(self, other_branch=None, reverse=False, mine_only=False,
4247
log_format=None, long=False, short=False, line=False,
4248
show_ids=False, verbose=False, this=False, other=False,
4249
include_merges=False, revision=None, my_revision=None):
4250
from bzrlib.missing import find_unmerged, iter_log_revisions
4259
# TODO: We should probably check that we don't have mine-only and
4260
# theirs-only set, but it gets complicated because we also have
4261
# this and other which could be used.
4268
local_branch = Branch.open_containing(u".")[0]
4269
parent = local_branch.get_parent()
4270
if other_branch is None:
4271
other_branch = parent
4272
if other_branch is None:
4273
raise errors.BzrCommandError("No peer location known"
4275
display_url = urlutils.unescape_for_display(parent,
4277
message("Using saved parent location: "
4278
+ display_url + "\n")
4280
remote_branch = Branch.open(other_branch)
4281
if remote_branch.base == local_branch.base:
4282
remote_branch = local_branch
4284
local_revid_range = _revision_range_to_revid_range(
4285
_get_revision_range(my_revision, local_branch,
4288
remote_revid_range = _revision_range_to_revid_range(
4289
_get_revision_range(revision,
4290
remote_branch, self.name()))
4292
local_branch.lock_read()
4294
remote_branch.lock_read()
4296
local_extra, remote_extra = find_unmerged(
4297
local_branch, remote_branch, restrict,
4298
backward=not reverse,
4299
include_merges=include_merges,
4300
local_revid_range=local_revid_range,
4301
remote_revid_range=remote_revid_range)
4303
if log_format is None:
4304
registry = log.log_formatter_registry
4305
log_format = registry.get_default(local_branch)
4306
lf = log_format(to_file=self.outf,
4308
show_timezone='original')
4311
if local_extra and not theirs_only:
4312
message("You have %d extra revision(s):\n" %
4314
for revision in iter_log_revisions(local_extra,
4315
local_branch.repository,
4317
lf.log_revision(revision)
4318
printed_local = True
4321
printed_local = False
4323
if remote_extra and not mine_only:
4324
if printed_local is True:
4326
message("You are missing %d revision(s):\n" %
4328
for revision in iter_log_revisions(remote_extra,
4329
remote_branch.repository,
4331
lf.log_revision(revision)
4334
if mine_only and not local_extra:
4335
# We checked local, and found nothing extra
4336
message('This branch is up to date.\n')
4337
elif theirs_only and not remote_extra:
4338
# We checked remote, and found nothing extra
4339
message('Other branch is up to date.\n')
4340
elif not (mine_only or theirs_only or local_extra or
4342
# We checked both branches, and neither one had extra
4344
message("Branches are up to date.\n")
4346
remote_branch.unlock()
4348
local_branch.unlock()
4349
if not status_code and parent is None and other_branch is not None:
4350
local_branch.lock_write()
4352
# handle race conditions - a parent might be set while we run.
4353
if local_branch.get_parent() is None:
4354
local_branch.set_parent(remote_branch.base)
4356
local_branch.unlock()
4360
class cmd_pack(Command):
4361
"""Compress the data within a repository."""
4363
_see_also = ['repositories']
4364
takes_args = ['branch_or_repo?']
4366
def run(self, branch_or_repo='.'):
4367
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4369
branch = dir.open_branch()
4370
repository = branch.repository
4371
except errors.NotBranchError:
4372
repository = dir.open_repository()
4376
class cmd_plugins(Command):
4377
"""List the installed plugins.
4379
This command displays the list of installed plugins including
4380
version of plugin and a short description of each.
4382
--verbose shows the path where each plugin is located.
4384
A plugin is an external component for Bazaar that extends the
4385
revision control system, by adding or replacing code in Bazaar.
4386
Plugins can do a variety of things, including overriding commands,
4387
adding new commands, providing additional network transports and
4388
customizing log output.
4390
See the Bazaar web site, http://bazaar-vcs.org, for further
4391
information on plugins including where to find them and how to
4392
install them. Instructions are also provided there on how to
4393
write new plugins using the Python programming language.
4395
takes_options = ['verbose']
4398
def run(self, verbose=False):
4399
import bzrlib.plugin
4400
from inspect import getdoc
4402
for name, plugin in bzrlib.plugin.plugins().items():
4403
version = plugin.__version__
4404
if version == 'unknown':
4406
name_ver = '%s %s' % (name, version)
4407
d = getdoc(plugin.module)
4409
doc = d.split('\n')[0]
4411
doc = '(no description)'
4412
result.append((name_ver, doc, plugin.path()))
4413
for name_ver, doc, path in sorted(result):
4421
class cmd_testament(Command):
4422
"""Show testament (signing-form) of a revision."""
4425
Option('long', help='Produce long-format testament.'),
4427
help='Produce a strict-format testament.')]
4428
takes_args = ['branch?']
4430
def run(self, branch=u'.', revision=None, long=False, strict=False):
4431
from bzrlib.testament import Testament, StrictTestament
4433
testament_class = StrictTestament
4435
testament_class = Testament
4437
b = Branch.open_containing(branch)[0]
4439
b = Branch.open(branch)
4442
if revision is None:
4443
rev_id = b.last_revision()
4445
rev_id = revision[0].as_revision_id(b)
4446
t = testament_class.from_revision(b.repository, rev_id)
4448
sys.stdout.writelines(t.as_text_lines())
4450
sys.stdout.write(t.as_short_text())
4455
class cmd_annotate(Command):
4456
"""Show the origin of each line in a file.
4458
This prints out the given file with an annotation on the left side
4459
indicating which revision, author and date introduced the change.
4461
If the origin is the same for a run of consecutive lines, it is
4462
shown only at the top, unless the --all option is given.
4464
# TODO: annotate directories; showing when each file was last changed
4465
# TODO: if the working copy is modified, show annotations on that
4466
# with new uncommitted lines marked
4467
aliases = ['ann', 'blame', 'praise']
4468
takes_args = ['filename']
4469
takes_options = [Option('all', help='Show annotations on all lines.'),
4470
Option('long', help='Show commit date in annotations.'),
4474
encoding_type = 'exact'
4477
def run(self, filename, all=False, long=False, revision=None,
4479
from bzrlib.annotate import annotate_file, annotate_file_tree
4480
wt, branch, relpath = \
4481
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4487
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4489
file_id = wt.path2id(relpath)
4491
file_id = tree.path2id(relpath)
4493
raise errors.NotVersionedError(filename)
4494
file_version = tree.inventory[file_id].revision
4495
if wt is not None and revision is None:
4496
# If there is a tree and we're not annotating historical
4497
# versions, annotate the working tree's content.
4498
annotate_file_tree(wt, file_id, self.outf, long, all,
4501
annotate_file(branch, file_version, file_id, long, all, self.outf,
4510
class cmd_re_sign(Command):
4511
"""Create a digital signature for an existing revision."""
4512
# TODO be able to replace existing ones.
4514
hidden = True # is this right ?
4515
takes_args = ['revision_id*']
4516
takes_options = ['revision']
4518
def run(self, revision_id_list=None, revision=None):
4519
if revision_id_list is not None and revision is not None:
4520
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4521
if revision_id_list is None and revision is None:
4522
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4523
b = WorkingTree.open_containing(u'.')[0].branch
4526
return self._run(b, revision_id_list, revision)
4530
def _run(self, b, revision_id_list, revision):
4531
import bzrlib.gpg as gpg
4532
gpg_strategy = gpg.GPGStrategy(b.get_config())
4533
if revision_id_list is not None:
4534
b.repository.start_write_group()
4536
for revision_id in revision_id_list:
4537
b.repository.sign_revision(revision_id, gpg_strategy)
4539
b.repository.abort_write_group()
4542
b.repository.commit_write_group()
4543
elif revision is not None:
4544
if len(revision) == 1:
4545
revno, rev_id = revision[0].in_history(b)
4546
b.repository.start_write_group()
4548
b.repository.sign_revision(rev_id, gpg_strategy)
4550
b.repository.abort_write_group()
4553
b.repository.commit_write_group()
4554
elif len(revision) == 2:
4555
# are they both on rh- if so we can walk between them
4556
# might be nice to have a range helper for arbitrary
4557
# revision paths. hmm.
4558
from_revno, from_revid = revision[0].in_history(b)
4559
to_revno, to_revid = revision[1].in_history(b)
4560
if to_revid is None:
4561
to_revno = b.revno()
4562
if from_revno is None or to_revno is None:
4563
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4564
b.repository.start_write_group()
4566
for revno in range(from_revno, to_revno + 1):
4567
b.repository.sign_revision(b.get_rev_id(revno),
4570
b.repository.abort_write_group()
4573
b.repository.commit_write_group()
4575
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4578
class cmd_bind(Command):
4579
"""Convert the current branch into a checkout of the supplied branch.
4581
Once converted into a checkout, commits must succeed on the master branch
4582
before they will be applied to the local branch.
4584
Bound branches use the nickname of its master branch unless it is set
4585
locally, in which case binding will update the local nickname to be
4589
_see_also = ['checkouts', 'unbind']
4590
takes_args = ['location?']
4593
def run(self, location=None):
4594
b, relpath = Branch.open_containing(u'.')
4595
if location is None:
4597
location = b.get_old_bound_location()
4598
except errors.UpgradeRequired:
4599
raise errors.BzrCommandError('No location supplied. '
4600
'This format does not remember old locations.')
4602
if location is None:
4603
raise errors.BzrCommandError('No location supplied and no '
4604
'previous location known')
4605
b_other = Branch.open(location)
4608
except errors.DivergedBranches:
4609
raise errors.BzrCommandError('These branches have diverged.'
4610
' Try merging, and then bind again.')
4611
if b.get_config().has_explicit_nickname():
4612
b.nick = b_other.nick
4615
class cmd_unbind(Command):
4616
"""Convert the current checkout into a regular branch.
4618
After unbinding, the local branch is considered independent and subsequent
4619
commits will be local only.
4622
_see_also = ['checkouts', 'bind']
4627
b, relpath = Branch.open_containing(u'.')
4629
raise errors.BzrCommandError('Local branch is not bound')
4632
class cmd_uncommit(Command):
4633
"""Remove the last committed revision.
4635
--verbose will print out what is being removed.
4636
--dry-run will go through all the motions, but not actually
4639
If --revision is specified, uncommit revisions to leave the branch at the
4640
specified revision. For example, "bzr uncommit -r 15" will leave the
4641
branch at revision 15.
4643
Uncommit leaves the working tree ready for a new commit. The only change
4644
it may make is to restore any pending merges that were present before
4648
# TODO: jam 20060108 Add an option to allow uncommit to remove
4649
# unreferenced information in 'branch-as-repository' branches.
4650
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4651
# information in shared branches as well.
4652
_see_also = ['commit']
4653
takes_options = ['verbose', 'revision',
4654
Option('dry-run', help='Don\'t actually make changes.'),
4655
Option('force', help='Say yes to all questions.'),
4657
help="Only remove the commits from the local branch"
4658
" when in a checkout."
4661
takes_args = ['location?']
4663
encoding_type = 'replace'
4665
def run(self, location=None,
4666
dry_run=False, verbose=False,
4667
revision=None, force=False, local=False):
4668
if location is None:
4670
control, relpath = bzrdir.BzrDir.open_containing(location)
4672
tree = control.open_workingtree()
4674
except (errors.NoWorkingTree, errors.NotLocalUrl):
4676
b = control.open_branch()
4678
if tree is not None:
4683
return self._run(b, tree, dry_run, verbose, revision, force,
4686
if tree is not None:
4691
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4692
from bzrlib.log import log_formatter, show_log
4693
from bzrlib.uncommit import uncommit
4695
last_revno, last_rev_id = b.last_revision_info()
4698
if revision is None:
4700
rev_id = last_rev_id
4702
# 'bzr uncommit -r 10' actually means uncommit
4703
# so that the final tree is at revno 10.
4704
# but bzrlib.uncommit.uncommit() actually uncommits
4705
# the revisions that are supplied.
4706
# So we need to offset it by one
4707
revno = revision[0].in_history(b).revno + 1
4708
if revno <= last_revno:
4709
rev_id = b.get_rev_id(revno)
4711
if rev_id is None or _mod_revision.is_null(rev_id):
4712
self.outf.write('No revisions to uncommit.\n')
4715
lf = log_formatter('short',
4717
show_timezone='original')
4722
direction='forward',
4723
start_revision=revno,
4724
end_revision=last_revno)
4727
print 'Dry-run, pretending to remove the above revisions.'
4729
val = raw_input('Press <enter> to continue')
4731
print 'The above revision(s) will be removed.'
4733
val = raw_input('Are you sure [y/N]? ')
4734
if val.lower() not in ('y', 'yes'):
4738
mutter('Uncommitting from {%s} to {%s}',
4739
last_rev_id, rev_id)
4740
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4741
revno=revno, local=local)
4742
note('You can restore the old tip by running:\n'
4743
' bzr pull . -r revid:%s', last_rev_id)
4746
class cmd_break_lock(Command):
4747
"""Break a dead lock on a repository, branch or working directory.
4749
CAUTION: Locks should only be broken when you are sure that the process
4750
holding the lock has been stopped.
4752
You can get information on what locks are open via the 'bzr info' command.
4757
takes_args = ['location?']
4759
def run(self, location=None, show=False):
4760
if location is None:
4762
control, relpath = bzrdir.BzrDir.open_containing(location)
4764
control.break_lock()
4765
except NotImplementedError:
4769
class cmd_wait_until_signalled(Command):
4770
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4772
This just prints a line to signal when it is ready, then blocks on stdin.
4778
sys.stdout.write("running\n")
4780
sys.stdin.readline()
4783
class cmd_serve(Command):
4784
"""Run the bzr server."""
4786
aliases = ['server']
4790
help='Serve on stdin/out for use from inetd or sshd.'),
4791
RegistryOption('protocol',
4792
help="Protocol to serve.",
4793
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4794
value_switches=True),
4796
help='Listen for connections on nominated port of the form '
4797
'[hostname:]portnumber. Passing 0 as the port number will '
4798
'result in a dynamically allocated port. The default port '
4799
'depends on the protocol.',
4802
help='Serve contents of this directory.',
4804
Option('allow-writes',
4805
help='By default the server is a readonly server. Supplying '
4806
'--allow-writes enables write access to the contents of '
4807
'the served directory and below. Note that ``bzr serve`` '
4808
'does not perform authentication, so unless some form of '
4809
'external authentication is arranged supplying this '
4810
'option leads to global uncontrolled write access to your '
4815
def get_host_and_port(self, port):
4816
"""Return the host and port to run the smart server on.
4818
If 'port' is None, None will be returned for the host and port.
4820
If 'port' has a colon in it, the string before the colon will be
4821
interpreted as the host.
4823
:param port: A string of the port to run the server on.
4824
:return: A tuple of (host, port), where 'host' is a host name or IP,
4825
and port is an integer TCP/IP port.
4828
if port is not None:
4830
host, port = port.split(':')
4834
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4836
from bzrlib.transport import get_transport, transport_server_registry
4837
if directory is None:
4838
directory = os.getcwd()
4839
if protocol is None:
4840
protocol = transport_server_registry.get()
4841
host, port = self.get_host_and_port(port)
4842
url = urlutils.local_path_to_url(directory)
4843
if not allow_writes:
4844
url = 'readonly+' + url
4845
transport = get_transport(url)
4846
protocol(transport, host, port, inet)
4849
class cmd_join(Command):
4850
"""Combine a tree into its containing tree.
4852
This command requires the target tree to be in a rich-root format.
4854
The TREE argument should be an independent tree, inside another tree, but
4855
not part of it. (Such trees can be produced by "bzr split", but also by
4856
running "bzr branch" with the target inside a tree.)
4858
The result is a combined tree, with the subtree no longer an independant
4859
part. This is marked as a merge of the subtree into the containing tree,
4860
and all history is preserved.
4863
_see_also = ['split']
4864
takes_args = ['tree']
4866
Option('reference', help='Join by reference.', hidden=True),
4869
def run(self, tree, reference=False):
4870
sub_tree = WorkingTree.open(tree)
4871
parent_dir = osutils.dirname(sub_tree.basedir)
4872
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4873
repo = containing_tree.branch.repository
4874
if not repo.supports_rich_root():
4875
raise errors.BzrCommandError(
4876
"Can't join trees because %s doesn't support rich root data.\n"
4877
"You can use bzr upgrade on the repository."
4881
containing_tree.add_reference(sub_tree)
4882
except errors.BadReferenceTarget, e:
4883
# XXX: Would be better to just raise a nicely printable
4884
# exception from the real origin. Also below. mbp 20070306
4885
raise errors.BzrCommandError("Cannot join %s. %s" %
4889
containing_tree.subsume(sub_tree)
4890
except errors.BadSubsumeSource, e:
4891
raise errors.BzrCommandError("Cannot join %s. %s" %
4895
class cmd_split(Command):
4896
"""Split a subdirectory of a tree into a separate tree.
4898
This command will produce a target tree in a format that supports
4899
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4900
converted into earlier formats like 'dirstate-tags'.
4902
The TREE argument should be a subdirectory of a working tree. That
4903
subdirectory will be converted into an independent tree, with its own
4904
branch. Commits in the top-level tree will not apply to the new subtree.
4907
_see_also = ['join']
4908
takes_args = ['tree']
4910
def run(self, tree):
4911
containing_tree, subdir = WorkingTree.open_containing(tree)
4912
sub_id = containing_tree.path2id(subdir)
4914
raise errors.NotVersionedError(subdir)
4916
containing_tree.extract(sub_id)
4917
except errors.RootNotRich:
4918
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4921
class cmd_merge_directive(Command):
4922
"""Generate a merge directive for auto-merge tools.
4924
A directive requests a merge to be performed, and also provides all the
4925
information necessary to do so. This means it must either include a
4926
revision bundle, or the location of a branch containing the desired
4929
A submit branch (the location to merge into) must be supplied the first
4930
time the command is issued. After it has been supplied once, it will
4931
be remembered as the default.
4933
A public branch is optional if a revision bundle is supplied, but required
4934
if --diff or --plain is specified. It will be remembered as the default
4935
after the first use.
4938
takes_args = ['submit_branch?', 'public_branch?']
4942
_see_also = ['send']
4945
RegistryOption.from_kwargs('patch-type',
4946
'The type of patch to include in the directive.',
4948
value_switches=True,
4950
bundle='Bazaar revision bundle (default).',
4951
diff='Normal unified diff.',
4952
plain='No patch, just directive.'),
4953
Option('sign', help='GPG-sign the directive.'), 'revision',
4954
Option('mail-to', type=str,
4955
help='Instead of printing the directive, email to this address.'),
4956
Option('message', type=str, short_name='m',
4957
help='Message to use when committing this merge.')
4960
encoding_type = 'exact'
4962
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4963
sign=False, revision=None, mail_to=None, message=None):
4964
from bzrlib.revision import ensure_null, NULL_REVISION
4965
include_patch, include_bundle = {
4966
'plain': (False, False),
4967
'diff': (True, False),
4968
'bundle': (True, True),
4970
branch = Branch.open('.')
4971
stored_submit_branch = branch.get_submit_branch()
4972
if submit_branch is None:
4973
submit_branch = stored_submit_branch
4975
if stored_submit_branch is None:
4976
branch.set_submit_branch(submit_branch)
4977
if submit_branch is None:
4978
submit_branch = branch.get_parent()
4979
if submit_branch is None:
4980
raise errors.BzrCommandError('No submit branch specified or known')
4982
stored_public_branch = branch.get_public_branch()
4983
if public_branch is None:
4984
public_branch = stored_public_branch
4985
elif stored_public_branch is None:
4986
branch.set_public_branch(public_branch)
4987
if not include_bundle and public_branch is None:
4988
raise errors.BzrCommandError('No public branch specified or'
4990
base_revision_id = None
4991
if revision is not None:
4992
if len(revision) > 2:
4993
raise errors.BzrCommandError('bzr merge-directive takes '
4994
'at most two one revision identifiers')
4995
revision_id = revision[-1].as_revision_id(branch)
4996
if len(revision) == 2:
4997
base_revision_id = revision[0].as_revision_id(branch)
4999
revision_id = branch.last_revision()
5000
revision_id = ensure_null(revision_id)
5001
if revision_id == NULL_REVISION:
5002
raise errors.BzrCommandError('No revisions to bundle.')
5003
directive = merge_directive.MergeDirective2.from_objects(
5004
branch.repository, revision_id, time.time(),
5005
osutils.local_time_offset(), submit_branch,
5006
public_branch=public_branch, include_patch=include_patch,
5007
include_bundle=include_bundle, message=message,
5008
base_revision_id=base_revision_id)
5011
self.outf.write(directive.to_signed(branch))
5013
self.outf.writelines(directive.to_lines())
5015
message = directive.to_email(mail_to, branch, sign)
5016
s = SMTPConnection(branch.get_config())
5017
s.send_email(message)
5020
class cmd_send(Command):
5021
"""Mail or create a merge-directive for submitting changes.
5023
A merge directive provides many things needed for requesting merges:
5025
* A machine-readable description of the merge to perform
5027
* An optional patch that is a preview of the changes requested
5029
* An optional bundle of revision data, so that the changes can be applied
5030
directly from the merge directive, without retrieving data from a
5033
If --no-bundle is specified, then public_branch is needed (and must be
5034
up-to-date), so that the receiver can perform the merge using the
5035
public_branch. The public_branch is always included if known, so that
5036
people can check it later.
5038
The submit branch defaults to the parent, but can be overridden. Both
5039
submit branch and public branch will be remembered if supplied.
5041
If a public_branch is known for the submit_branch, that public submit
5042
branch is used in the merge instructions. This means that a local mirror
5043
can be used as your actual submit branch, once you have set public_branch
5046
Mail is sent using your preferred mail program. This should be transparent
5047
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5048
If the preferred client can't be found (or used), your editor will be used.
5050
To use a specific mail program, set the mail_client configuration option.
5051
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5052
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5053
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5054
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5057
If mail is being sent, a to address is required. This can be supplied
5058
either on the commandline, by setting the submit_to configuration
5059
option in the branch itself or the child_submit_to configuration option
5060
in the submit branch.
5062
Two formats are currently supported: "4" uses revision bundle format 4 and
5063
merge directive format 2. It is significantly faster and smaller than
5064
older formats. It is compatible with Bazaar 0.19 and later. It is the
5065
default. "0.9" uses revision bundle format 0.9 and merge directive
5066
format 1. It is compatible with Bazaar 0.12 - 0.18.
5068
The merge directives created by bzr send may be applied using bzr merge or
5069
bzr pull by specifying a file containing a merge directive as the location.
5072
encoding_type = 'exact'
5074
_see_also = ['merge', 'pull']
5076
takes_args = ['submit_branch?', 'public_branch?']
5080
help='Do not include a bundle in the merge directive.'),
5081
Option('no-patch', help='Do not include a preview patch in the merge'
5084
help='Remember submit and public branch.'),
5086
help='Branch to generate the submission from, '
5087
'rather than the one containing the working directory.',
5090
Option('output', short_name='o',
5091
help='Write merge directive to this file; '
5092
'use - for stdout.',
5095
help='Refuse to send if there are uncommitted changes in'
5096
' the working tree, --no-strict disables the check.'),
5097
Option('mail-to', help='Mail the request to this address.',
5101
Option('body', help='Body for the email.', type=unicode),
5102
RegistryOption('format',
5103
help='Use the specified output format.',
5104
lazy_registry=('bzrlib.send', 'format_registry')),
5107
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5108
no_patch=False, revision=None, remember=False, output=None,
5109
format=None, mail_to=None, message=None, body=None,
5110
strict=None, **kwargs):
5111
from bzrlib.send import send
5112
return send(submit_branch, revision, public_branch, remember,
5113
format, no_bundle, no_patch, output,
5114
kwargs.get('from', '.'), mail_to, message, body,
5119
class cmd_bundle_revisions(cmd_send):
5120
"""Create a merge-directive for submitting changes.
5122
A merge directive provides many things needed for requesting merges:
5124
* A machine-readable description of the merge to perform
5126
* An optional patch that is a preview of the changes requested
5128
* An optional bundle of revision data, so that the changes can be applied
5129
directly from the merge directive, without retrieving data from a
5132
If --no-bundle is specified, then public_branch is needed (and must be
5133
up-to-date), so that the receiver can perform the merge using the
5134
public_branch. The public_branch is always included if known, so that
5135
people can check it later.
5137
The submit branch defaults to the parent, but can be overridden. Both
5138
submit branch and public branch will be remembered if supplied.
5140
If a public_branch is known for the submit_branch, that public submit
5141
branch is used in the merge instructions. This means that a local mirror
5142
can be used as your actual submit branch, once you have set public_branch
5145
Two formats are currently supported: "4" uses revision bundle format 4 and
5146
merge directive format 2. It is significantly faster and smaller than
5147
older formats. It is compatible with Bazaar 0.19 and later. It is the
5148
default. "0.9" uses revision bundle format 0.9 and merge directive
5149
format 1. It is compatible with Bazaar 0.12 - 0.18.
5154
help='Do not include a bundle in the merge directive.'),
5155
Option('no-patch', help='Do not include a preview patch in the merge'
5158
help='Remember submit and public branch.'),
5160
help='Branch to generate the submission from, '
5161
'rather than the one containing the working directory.',
5164
Option('output', short_name='o', help='Write directive to this file.',
5167
help='Refuse to bundle revisions if there are uncommitted'
5168
' changes in the working tree, --no-strict disables the check.'),
5170
RegistryOption('format',
5171
help='Use the specified output format.',
5172
lazy_registry=('bzrlib.send', 'format_registry')),
5174
aliases = ['bundle']
5176
_see_also = ['send', 'merge']
5180
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5181
no_patch=False, revision=None, remember=False, output=None,
5182
format=None, strict=None, **kwargs):
5185
from bzrlib.send import send
5186
return send(submit_branch, revision, public_branch, remember,
5187
format, no_bundle, no_patch, output,
5188
kwargs.get('from', '.'), None, None, None,
5189
self.outf, strict=strict)
5192
class cmd_tag(Command):
5193
"""Create, remove or modify a tag naming a revision.
5195
Tags give human-meaningful names to revisions. Commands that take a -r
5196
(--revision) option can be given -rtag:X, where X is any previously
5199
Tags are stored in the branch. Tags are copied from one branch to another
5200
along when you branch, push, pull or merge.
5202
It is an error to give a tag name that already exists unless you pass
5203
--force, in which case the tag is moved to point to the new revision.
5205
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5206
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5209
_see_also = ['commit', 'tags']
5210
takes_args = ['tag_name']
5213
help='Delete this tag rather than placing it.',
5216
help='Branch in which to place the tag.',
5221
help='Replace existing tags.',
5226
def run(self, tag_name,
5232
branch, relpath = Branch.open_containing(directory)
5236
branch.tags.delete_tag(tag_name)
5237
self.outf.write('Deleted tag %s.\n' % tag_name)
5240
if len(revision) != 1:
5241
raise errors.BzrCommandError(
5242
"Tags can only be placed on a single revision, "
5244
revision_id = revision[0].as_revision_id(branch)
5246
revision_id = branch.last_revision()
5247
if (not force) and branch.tags.has_tag(tag_name):
5248
raise errors.TagAlreadyExists(tag_name)
5249
branch.tags.set_tag(tag_name, revision_id)
5250
self.outf.write('Created tag %s.\n' % tag_name)
5255
class cmd_tags(Command):
5258
This command shows a table of tag names and the revisions they reference.
5264
help='Branch whose tags should be displayed.',
5268
RegistryOption.from_kwargs('sort',
5269
'Sort tags by different criteria.', title='Sorting',
5270
alpha='Sort tags lexicographically (default).',
5271
time='Sort tags chronologically.',
5284
branch, relpath = Branch.open_containing(directory)
5286
tags = branch.tags.get_tag_dict().items()
5293
graph = branch.repository.get_graph()
5294
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5295
revid1, revid2 = rev1.rev_id, rev2.rev_id
5296
# only show revisions between revid1 and revid2 (inclusive)
5297
tags = [(tag, revid) for tag, revid in tags if
5298
graph.is_between(revid, revid1, revid2)]
5301
elif sort == 'time':
5303
for tag, revid in tags:
5305
revobj = branch.repository.get_revision(revid)
5306
except errors.NoSuchRevision:
5307
timestamp = sys.maxint # place them at the end
5309
timestamp = revobj.timestamp
5310
timestamps[revid] = timestamp
5311
tags.sort(key=lambda x: timestamps[x[1]])
5313
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5314
for index, (tag, revid) in enumerate(tags):
5316
revno = branch.revision_id_to_dotted_revno(revid)
5317
if isinstance(revno, tuple):
5318
revno = '.'.join(map(str, revno))
5319
except errors.NoSuchRevision:
5320
# Bad tag data/merges can lead to tagged revisions
5321
# which are not in this branch. Fail gracefully ...
5323
tags[index] = (tag, revno)
5326
for tag, revspec in tags:
5327
self.outf.write('%-20s %s\n' % (tag, revspec))
5330
class cmd_reconfigure(Command):
5331
"""Reconfigure the type of a bzr directory.
5333
A target configuration must be specified.
5335
For checkouts, the bind-to location will be auto-detected if not specified.
5336
The order of preference is
5337
1. For a lightweight checkout, the current bound location.
5338
2. For branches that used to be checkouts, the previously-bound location.
5339
3. The push location.
5340
4. The parent location.
5341
If none of these is available, --bind-to must be specified.
5344
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5345
takes_args = ['location?']
5347
RegistryOption.from_kwargs(
5349
title='Target type',
5350
help='The type to reconfigure the directory to.',
5351
value_switches=True, enum_switch=False,
5352
branch='Reconfigure to be an unbound branch with no working tree.',
5353
tree='Reconfigure to be an unbound branch with a working tree.',
5354
checkout='Reconfigure to be a bound branch with a working tree.',
5355
lightweight_checkout='Reconfigure to be a lightweight'
5356
' checkout (with no local history).',
5357
standalone='Reconfigure to be a standalone branch '
5358
'(i.e. stop using shared repository).',
5359
use_shared='Reconfigure to use a shared repository.',
5360
with_trees='Reconfigure repository to create '
5361
'working trees on branches by default.',
5362
with_no_trees='Reconfigure repository to not create '
5363
'working trees on branches by default.'
5365
Option('bind-to', help='Branch to bind checkout to.', type=str),
5367
help='Perform reconfiguration even if local changes'
5369
Option('stacked-on',
5370
help='Reconfigure a branch to be stacked on another branch.',
5374
help='Reconfigure a branch to be unstacked. This '
5375
'may require copying substantial data into it.',
5379
def run(self, location=None, target_type=None, bind_to=None, force=False,
5382
directory = bzrdir.BzrDir.open(location)
5383
if stacked_on and unstacked:
5384
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5385
elif stacked_on is not None:
5386
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5388
reconfigure.ReconfigureUnstacked().apply(directory)
5389
# At the moment you can use --stacked-on and a different
5390
# reconfiguration shape at the same time; there seems no good reason
5392
if target_type is None:
5393
if stacked_on or unstacked:
5396
raise errors.BzrCommandError('No target configuration '
5398
elif target_type == 'branch':
5399
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5400
elif target_type == 'tree':
5401
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5402
elif target_type == 'checkout':
5403
reconfiguration = reconfigure.Reconfigure.to_checkout(
5405
elif target_type == 'lightweight-checkout':
5406
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5408
elif target_type == 'use-shared':
5409
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5410
elif target_type == 'standalone':
5411
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5412
elif target_type == 'with-trees':
5413
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5415
elif target_type == 'with-no-trees':
5416
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5418
reconfiguration.apply(force)
5421
class cmd_switch(Command):
5422
"""Set the branch of a checkout and update.
5424
For lightweight checkouts, this changes the branch being referenced.
5425
For heavyweight checkouts, this checks that there are no local commits
5426
versus the current bound branch, then it makes the local branch a mirror
5427
of the new location and binds to it.
5429
In both cases, the working tree is updated and uncommitted changes
5430
are merged. The user can commit or revert these as they desire.
5432
Pending merges need to be committed or reverted before using switch.
5434
The path to the branch to switch to can be specified relative to the parent
5435
directory of the current branch. For example, if you are currently in a
5436
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5439
Bound branches use the nickname of its master branch unless it is set
5440
locally, in which case switching will update the local nickname to be
5444
takes_args = ['to_location']
5445
takes_options = [Option('force',
5446
help='Switch even if local commits will be lost.'),
5447
Option('create-branch', short_name='b',
5448
help='Create the target branch from this one before'
5449
' switching to it.'),
5452
def run(self, to_location, force=False, create_branch=False):
5453
from bzrlib import switch
5455
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5457
branch = control_dir.open_branch()
5458
had_explicit_nick = branch.get_config().has_explicit_nickname()
5459
except errors.NotBranchError:
5461
had_explicit_nick = False
5464
raise errors.BzrCommandError('cannot create branch without'
5466
if '/' not in to_location and '\\' not in to_location:
5467
# This path is meant to be relative to the existing branch
5468
this_url = self._get_branch_location(control_dir)
5469
to_location = urlutils.join(this_url, '..', to_location)
5470
to_branch = branch.bzrdir.sprout(to_location,
5471
possible_transports=[branch.bzrdir.root_transport],
5472
source_branch=branch).open_branch()
5474
# from_branch = control_dir.open_branch()
5475
# except errors.NotBranchError:
5476
# raise BzrCommandError('Cannot create a branch from this'
5477
# ' location when we cannot open this branch')
5478
# from_branch.bzrdir.sprout(
5482
to_branch = Branch.open(to_location)
5483
except errors.NotBranchError:
5484
this_url = self._get_branch_location(control_dir)
5485
to_branch = Branch.open(
5486
urlutils.join(this_url, '..', to_location))
5487
switch.switch(control_dir, to_branch, force)
5488
if had_explicit_nick:
5489
branch = control_dir.open_branch() #get the new branch!
5490
branch.nick = to_branch.nick
5491
note('Switched to branch: %s',
5492
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5494
def _get_branch_location(self, control_dir):
5495
"""Return location of branch for this control dir."""
5497
this_branch = control_dir.open_branch()
5498
# This may be a heavy checkout, where we want the master branch
5499
master_location = this_branch.get_bound_location()
5500
if master_location is not None:
5501
return master_location
5502
# If not, use a local sibling
5503
return this_branch.base
5504
except errors.NotBranchError:
5505
format = control_dir.find_branch_format()
5506
if getattr(format, 'get_reference', None) is not None:
5507
return format.get_reference(control_dir)
5509
return control_dir.root_transport.base
5512
class cmd_view(Command):
5513
"""Manage filtered views.
5515
Views provide a mask over the tree so that users can focus on
5516
a subset of a tree when doing their work. After creating a view,
5517
commands that support a list of files - status, diff, commit, etc -
5518
effectively have that list of files implicitly given each time.
5519
An explicit list of files can still be given but those files
5520
must be within the current view.
5522
In most cases, a view has a short life-span: it is created to make
5523
a selected change and is deleted once that change is committed.
5524
At other times, you may wish to create one or more named views
5525
and switch between them.
5527
To disable the current view without deleting it, you can switch to
5528
the pseudo view called ``off``. This can be useful when you need
5529
to see the whole tree for an operation or two (e.g. merge) but
5530
want to switch back to your view after that.
5533
To define the current view::
5535
bzr view file1 dir1 ...
5537
To list the current view::
5541
To delete the current view::
5545
To disable the current view without deleting it::
5547
bzr view --switch off
5549
To define a named view and switch to it::
5551
bzr view --name view-name file1 dir1 ...
5553
To list a named view::
5555
bzr view --name view-name
5557
To delete a named view::
5559
bzr view --name view-name --delete
5561
To switch to a named view::
5563
bzr view --switch view-name
5565
To list all views defined::
5569
To delete all views::
5571
bzr view --delete --all
5575
takes_args = ['file*']
5578
help='Apply list or delete action to all views.',
5581
help='Delete the view.',
5584
help='Name of the view to define, list or delete.',
5588
help='Name of the view to switch to.',
5593
def run(self, file_list,
5599
tree, file_list = tree_files(file_list, apply_view=False)
5600
current_view, view_dict = tree.views.get_view_info()
5605
raise errors.BzrCommandError(
5606
"Both --delete and a file list specified")
5608
raise errors.BzrCommandError(
5609
"Both --delete and --switch specified")
5611
tree.views.set_view_info(None, {})
5612
self.outf.write("Deleted all views.\n")
5614
raise errors.BzrCommandError("No current view to delete")
5616
tree.views.delete_view(name)
5617
self.outf.write("Deleted '%s' view.\n" % name)
5620
raise errors.BzrCommandError(
5621
"Both --switch and a file list specified")
5623
raise errors.BzrCommandError(
5624
"Both --switch and --all specified")
5625
elif switch == 'off':
5626
if current_view is None:
5627
raise errors.BzrCommandError("No current view to disable")
5628
tree.views.set_view_info(None, view_dict)
5629
self.outf.write("Disabled '%s' view.\n" % (current_view))
5631
tree.views.set_view_info(switch, view_dict)
5632
view_str = views.view_display_str(tree.views.lookup_view())
5633
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5636
self.outf.write('Views defined:\n')
5637
for view in sorted(view_dict):
5638
if view == current_view:
5642
view_str = views.view_display_str(view_dict[view])
5643
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5645
self.outf.write('No views defined.\n')
5648
# No name given and no current view set
5651
raise errors.BzrCommandError(
5652
"Cannot change the 'off' pseudo view")
5653
tree.views.set_view(name, sorted(file_list))
5654
view_str = views.view_display_str(tree.views.lookup_view())
5655
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5659
# No name given and no current view set
5660
self.outf.write('No current view.\n')
5662
view_str = views.view_display_str(tree.views.lookup_view(name))
5663
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5666
class cmd_hooks(Command):
5672
for hook_key in sorted(hooks.known_hooks.keys()):
5673
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5674
self.outf.write("%s:\n" % type(some_hooks).__name__)
5675
for hook_name, hook_point in sorted(some_hooks.items()):
5676
self.outf.write(" %s:\n" % (hook_name,))
5677
found_hooks = list(hook_point)
5679
for hook in found_hooks:
5680
self.outf.write(" %s\n" %
5681
(some_hooks.get_hook_name(hook),))
5683
self.outf.write(" <no hooks installed>\n")
5686
class cmd_shelve(Command):
5687
"""Temporarily set aside some changes from the current tree.
5689
Shelve allows you to temporarily put changes you've made "on the shelf",
5690
ie. out of the way, until a later time when you can bring them back from
5691
the shelf with the 'unshelve' command. The changes are stored alongside
5692
your working tree, and so they aren't propagated along with your branch nor
5693
will they survive its deletion.
5695
If shelve --list is specified, previously-shelved changes are listed.
5697
Shelve is intended to help separate several sets of changes that have
5698
been inappropriately mingled. If you just want to get rid of all changes
5699
and you don't need to restore them later, use revert. If you want to
5700
shelve all text changes at once, use shelve --all.
5702
If filenames are specified, only the changes to those files will be
5703
shelved. Other files will be left untouched.
5705
If a revision is specified, changes since that revision will be shelved.
5707
You can put multiple items on the shelf, and by default, 'unshelve' will
5708
restore the most recently shelved changes.
5711
takes_args = ['file*']
5715
Option('all', help='Shelve all changes.'),
5717
RegistryOption('writer', 'Method to use for writing diffs.',
5718
bzrlib.option.diff_writer_registry,
5719
value_switches=True, enum_switch=False),
5721
Option('list', help='List shelved changes.'),
5723
help='Destroy removed changes instead of shelving them.'),
5725
_see_also = ['unshelve']
5727
def run(self, revision=None, all=False, file_list=None, message=None,
5728
writer=None, list=False, destroy=False):
5730
return self.run_for_list()
5731
from bzrlib.shelf_ui import Shelver
5733
writer = bzrlib.option.diff_writer_registry.get()
5735
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5736
file_list, message, destroy=destroy)
5741
except errors.UserAbort:
5744
def run_for_list(self):
5745
tree = WorkingTree.open_containing('.')[0]
5748
manager = tree.get_shelf_manager()
5749
shelves = manager.active_shelves()
5750
if len(shelves) == 0:
5751
note('No shelved changes.')
5753
for shelf_id in reversed(shelves):
5754
message = manager.get_metadata(shelf_id).get('message')
5756
message = '<no message>'
5757
self.outf.write('%3d: %s\n' % (shelf_id, message))
5763
class cmd_unshelve(Command):
5764
"""Restore shelved changes.
5766
By default, the most recently shelved changes are restored. However if you
5767
specify a shelf by id those changes will be restored instead. This works
5768
best when the changes don't depend on each other.
5771
takes_args = ['shelf_id?']
5773
RegistryOption.from_kwargs(
5774
'action', help="The action to perform.",
5775
enum_switch=False, value_switches=True,
5776
apply="Apply changes and remove from the shelf.",
5777
dry_run="Show changes, but do not apply or remove them.",
5778
delete_only="Delete changes without applying them."
5781
_see_also = ['shelve']
5783
def run(self, shelf_id=None, action='apply'):
5784
from bzrlib.shelf_ui import Unshelver
5785
unshelver = Unshelver.from_args(shelf_id, action)
5789
unshelver.tree.unlock()
5792
class cmd_clean_tree(Command):
5793
"""Remove unwanted files from working tree.
5795
By default, only unknown files, not ignored files, are deleted. Versioned
5796
files are never deleted.
5798
Another class is 'detritus', which includes files emitted by bzr during
5799
normal operations and selftests. (The value of these files decreases with
5802
If no options are specified, unknown files are deleted. Otherwise, option
5803
flags are respected, and may be combined.
5805
To check what clean-tree will do, use --dry-run.
5807
takes_options = [Option('ignored', help='Delete all ignored files.'),
5808
Option('detritus', help='Delete conflict files, merge'
5809
' backups, and failed selftest dirs.'),
5811
help='Delete files unknown to bzr (default).'),
5812
Option('dry-run', help='Show files to delete instead of'
5814
Option('force', help='Do not prompt before deleting.')]
5815
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5817
from bzrlib.clean_tree import clean_tree
5818
if not (unknown or ignored or detritus):
5822
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5823
dry_run=dry_run, no_prompt=force)
5826
class cmd_reference(Command):
5827
"""list, view and set branch locations for nested trees.
5829
If no arguments are provided, lists the branch locations for nested trees.
5830
If one argument is provided, display the branch location for that tree.
5831
If two arguments are provided, set the branch location for that tree.
5836
takes_args = ['path?', 'location?']
5838
def run(self, path=None, location=None):
5840
if path is not None:
5842
tree, branch, relpath =(
5843
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5844
if path is not None:
5847
tree = branch.basis_tree()
5849
info = branch._get_all_reference_info().iteritems()
5850
self._display_reference_info(tree, branch, info)
5852
file_id = tree.path2id(path)
5854
raise errors.NotVersionedError(path)
5855
if location is None:
5856
info = [(file_id, branch.get_reference_info(file_id))]
5857
self._display_reference_info(tree, branch, info)
5859
branch.set_reference_info(file_id, path, location)
5861
def _display_reference_info(self, tree, branch, info):
5863
for file_id, (path, location) in info:
5865
path = tree.id2path(file_id)
5866
except errors.NoSuchId:
5868
ref_list.append((path, location))
5869
for path, location in sorted(ref_list):
5870
self.outf.write('%s %s\n' % (path, location))
5873
# these get imported and then picked up by the scan for cmd_*
5874
# TODO: Some more consistent way to split command definitions across files;
5875
# we do need to load at least some information about them to know of
5876
# aliases. ideally we would avoid loading the implementation until the
5877
# details were needed.
5878
from bzrlib.cmd_version_info import cmd_version_info
5879
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5880
from bzrlib.bundle.commands import (
5883
from bzrlib.foreign import cmd_dpush
5884
from bzrlib.sign_my_commits import cmd_sign_my_commits
5885
from bzrlib.weave_commands import cmd_versionedfile_list, \
5886
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
