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
This command only works on branches that have not diverged. Branches are
917
considered diverged if the destination branch's most recent commit is one
918
that has not been merged (directly or indirectly) into the parent.
920
If branches have diverged, you can use 'bzr merge' to integrate the changes
921
from one into the other. Once one branch has merged, the other should
922
be able to pull it again.
924
If you want to forget your local changes and just update your branch to
925
match the remote one, use pull --overwrite.
927
If there is no default location set, the first pull will set it. After
928
that, you can omit the location to use the default. To change the
929
default, use --remember. The value will only be saved if the remote
930
location can be accessed.
932
Note: The location can be specified either in the form of a branch,
933
or in the form of a path to a file containing a merge directive generated
937
_see_also = ['push', 'update', 'status-flags', 'send']
938
takes_options = ['remember', 'overwrite', 'revision',
939
custom_help('verbose',
940
help='Show logs of pulled revisions.'),
942
help='Branch to pull into, '
943
'rather than the one containing the working directory.',
948
help="Perform a local pull in a bound "
949
"branch. Local pulls are not applied to "
953
takes_args = ['location?']
954
encoding_type = 'replace'
956
def run(self, location=None, remember=False, overwrite=False,
957
revision=None, verbose=False,
958
directory=None, local=False):
959
# FIXME: too much stuff is in the command class
962
if directory is None:
965
tree_to = WorkingTree.open_containing(directory)[0]
966
branch_to = tree_to.branch
967
except errors.NoWorkingTree:
969
branch_to = Branch.open_containing(directory)[0]
971
if local and not branch_to.get_bound_location():
972
raise errors.LocalRequiresBoundBranch()
974
possible_transports = []
975
if location is not None:
977
mergeable = bundle.read_mergeable_from_url(location,
978
possible_transports=possible_transports)
979
except errors.NotABundle:
982
stored_loc = branch_to.get_parent()
984
if stored_loc is None:
985
raise errors.BzrCommandError("No pull location known or"
988
display_url = urlutils.unescape_for_display(stored_loc,
991
self.outf.write("Using saved parent location: %s\n" % display_url)
992
location = stored_loc
994
revision = _get_one_revision('pull', revision)
995
if mergeable is not None:
996
if revision is not None:
997
raise errors.BzrCommandError(
998
'Cannot use -r with merge directives or bundles')
999
mergeable.install_revisions(branch_to.repository)
1000
base_revision_id, revision_id, verified = \
1001
mergeable.get_merge_request(branch_to.repository)
1002
branch_from = branch_to
1004
branch_from = Branch.open(location,
1005
possible_transports=possible_transports)
1007
if branch_to.get_parent() is None or remember:
1008
branch_to.set_parent(branch_from.base)
1010
if branch_from is not branch_to:
1011
branch_from.lock_read()
1013
if revision is not None:
1014
revision_id = revision.as_revision_id(branch_from)
1016
branch_to.lock_write()
1018
if tree_to is not None:
1019
view_info = _get_view_info_for_change_reporter(tree_to)
1020
change_reporter = delta._ChangeReporter(
1021
unversioned_filter=tree_to.is_ignored,
1022
view_info=view_info)
1023
result = tree_to.pull(
1024
branch_from, overwrite, revision_id, change_reporter,
1025
possible_transports=possible_transports, local=local)
1027
result = branch_to.pull(
1028
branch_from, overwrite, revision_id, local=local)
1030
result.report(self.outf)
1031
if verbose and result.old_revid != result.new_revid:
1032
log.show_branch_change(
1033
branch_to, self.outf, result.old_revno,
1038
if branch_from is not branch_to:
1039
branch_from.unlock()
1042
class cmd_push(Command):
1043
"""Update a mirror of this branch.
1045
The target branch will not have its working tree populated because this
1046
is both expensive, and is not supported on remote file systems.
1048
Some smart servers or protocols *may* put the working tree in place in
1051
This command only works on branches that have not diverged. Branches are
1052
considered diverged if the destination branch's most recent commit is one
1053
that has not been merged (directly or indirectly) by the source branch.
1055
If branches have diverged, you can use 'bzr push --overwrite' to replace
1056
the other branch completely, discarding its unmerged changes.
1058
If you want to ensure you have the different changes in the other branch,
1059
do a merge (see bzr help merge) from the other branch, and commit that.
1060
After that you will be able to do a push without '--overwrite'.
1062
If there is no default push location set, the first push will set it.
1063
After that, you can omit the location to use the default. To change the
1064
default, use --remember. The value will only be saved if the remote
1065
location can be accessed.
1068
_see_also = ['pull', 'update', 'working-trees']
1069
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1070
Option('create-prefix',
1071
help='Create the path leading up to the branch '
1072
'if it does not already exist.'),
1074
help='Branch to push from, '
1075
'rather than the one containing the working directory.',
1079
Option('use-existing-dir',
1080
help='By default push will fail if the target'
1081
' directory exists, but does not already'
1082
' have a control directory. This flag will'
1083
' allow push to proceed.'),
1085
help='Create a stacked branch that references the public location '
1086
'of the parent branch.'),
1087
Option('stacked-on',
1088
help='Create a stacked branch that refers to another branch '
1089
'for the commit history. Only the work not present in the '
1090
'referenced branch is included in the branch created.',
1093
help='Refuse to push if there are uncommitted changes in'
1094
' the working tree, --no-strict disables the check.'),
1096
takes_args = ['location?']
1097
encoding_type = 'replace'
1099
def run(self, location=None, remember=False, overwrite=False,
1100
create_prefix=False, verbose=False, revision=None,
1101
use_existing_dir=False, directory=None, stacked_on=None,
1102
stacked=False, strict=None):
1103
from bzrlib.push import _show_push_branch
1105
if directory is None:
1107
# Get the source branch
1109
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1111
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1112
if strict is None: strict = True # default value
1113
# Get the tip's revision_id
1114
revision = _get_one_revision('push', revision)
1115
if revision is not None:
1116
revision_id = revision.in_history(br_from).rev_id
1119
if strict and tree is not None and revision_id is None:
1120
if (tree.has_changes()):
1121
raise errors.UncommittedChanges(
1122
tree, more='Use --no-strict to force the push.')
1123
if tree.last_revision() != tree.branch.last_revision():
1124
# The tree has lost sync with its branch, there is little
1125
# chance that the user is aware of it but he can still force
1126
# the push with --no-strict
1127
raise errors.OutOfDateTree(
1128
tree, more='Use --no-strict to force the push.')
1130
# Get the stacked_on branch, if any
1131
if stacked_on is not None:
1132
stacked_on = urlutils.normalize_url(stacked_on)
1134
parent_url = br_from.get_parent()
1136
parent = Branch.open(parent_url)
1137
stacked_on = parent.get_public_branch()
1139
# I considered excluding non-http url's here, thus forcing
1140
# 'public' branches only, but that only works for some
1141
# users, so it's best to just depend on the user spotting an
1142
# error by the feedback given to them. RBC 20080227.
1143
stacked_on = parent_url
1145
raise errors.BzrCommandError(
1146
"Could not determine branch to refer to.")
1148
# Get the destination location
1149
if location is None:
1150
stored_loc = br_from.get_push_location()
1151
if stored_loc is None:
1152
raise errors.BzrCommandError(
1153
"No push location known or specified.")
1155
display_url = urlutils.unescape_for_display(stored_loc,
1157
self.outf.write("Using saved push location: %s\n" % display_url)
1158
location = stored_loc
1160
_show_push_branch(br_from, revision_id, location, self.outf,
1161
verbose=verbose, overwrite=overwrite, remember=remember,
1162
stacked_on=stacked_on, create_prefix=create_prefix,
1163
use_existing_dir=use_existing_dir)
1166
class cmd_branch(Command):
1167
"""Create a new branch that is a copy of an existing branch.
1169
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1170
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1171
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1172
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1173
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1176
To retrieve the branch as of a particular revision, supply the --revision
1177
parameter, as in "branch foo/bar -r 5".
1180
_see_also = ['checkout']
1181
takes_args = ['from_location', 'to_location?']
1182
takes_options = ['revision', Option('hardlink',
1183
help='Hard-link working tree files where possible.'),
1185
help="Create a branch without a working-tree."),
1187
help="Switch the checkout in the current directory "
1188
"to the new branch."),
1190
help='Create a stacked branch referring to the source branch. '
1191
'The new branch will depend on the availability of the source '
1192
'branch for all operations.'),
1193
Option('standalone',
1194
help='Do not use a shared repository, even if available.'),
1195
Option('use-existing-dir',
1196
help='By default branch will fail if the target'
1197
' directory exists, but does not already'
1198
' have a control directory. This flag will'
1199
' allow branch to proceed.'),
1201
aliases = ['get', 'clone']
1203
def run(self, from_location, to_location=None, revision=None,
1204
hardlink=False, stacked=False, standalone=False, no_tree=False,
1205
use_existing_dir=False, switch=False):
1206
from bzrlib import switch as _mod_switch
1207
from bzrlib.tag import _merge_tags_if_possible
1208
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1210
if (accelerator_tree is not None and
1211
accelerator_tree.supports_content_filtering()):
1212
accelerator_tree = None
1213
revision = _get_one_revision('branch', revision)
1216
if revision is not None:
1217
revision_id = revision.as_revision_id(br_from)
1219
# FIXME - wt.last_revision, fallback to branch, fall back to
1220
# None or perhaps NULL_REVISION to mean copy nothing
1222
revision_id = br_from.last_revision()
1223
if to_location is None:
1224
to_location = urlutils.derive_to_location(from_location)
1225
to_transport = transport.get_transport(to_location)
1227
to_transport.mkdir('.')
1228
except errors.FileExists:
1229
if not use_existing_dir:
1230
raise errors.BzrCommandError('Target directory "%s" '
1231
'already exists.' % to_location)
1234
bzrdir.BzrDir.open_from_transport(to_transport)
1235
except errors.NotBranchError:
1238
raise errors.AlreadyBranchError(to_location)
1239
except errors.NoSuchFile:
1240
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1243
# preserve whatever source format we have.
1244
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1245
possible_transports=[to_transport],
1246
accelerator_tree=accelerator_tree,
1247
hardlink=hardlink, stacked=stacked,
1248
force_new_repo=standalone,
1249
create_tree_if_local=not no_tree,
1250
source_branch=br_from)
1251
branch = dir.open_branch()
1252
except errors.NoSuchRevision:
1253
to_transport.delete_tree('.')
1254
msg = "The branch %s has no revision %s." % (from_location,
1256
raise errors.BzrCommandError(msg)
1257
_merge_tags_if_possible(br_from, branch)
1258
# If the source branch is stacked, the new branch may
1259
# be stacked whether we asked for that explicitly or not.
1260
# We therefore need a try/except here and not just 'if stacked:'
1262
note('Created new stacked branch referring to %s.' %
1263
branch.get_stacked_on_url())
1264
except (errors.NotStacked, errors.UnstackableBranchFormat,
1265
errors.UnstackableRepositoryFormat), e:
1266
note('Branched %d revision(s).' % branch.revno())
1268
# Switch to the new branch
1269
wt, _ = WorkingTree.open_containing('.')
1270
_mod_switch.switch(wt.bzrdir, branch)
1271
note('Switched to branch: %s',
1272
urlutils.unescape_for_display(branch.base, 'utf-8'))
1277
class cmd_checkout(Command):
1278
"""Create a new checkout of an existing branch.
1280
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1281
the branch found in '.'. This is useful if you have removed the working tree
1282
or if it was never created - i.e. if you pushed the branch to its current
1283
location using SFTP.
1285
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1286
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1287
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1288
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1289
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1292
To retrieve the branch as of a particular revision, supply the --revision
1293
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1294
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1298
_see_also = ['checkouts', 'branch']
1299
takes_args = ['branch_location?', 'to_location?']
1300
takes_options = ['revision',
1301
Option('lightweight',
1302
help="Perform a lightweight checkout. Lightweight "
1303
"checkouts depend on access to the branch for "
1304
"every operation. Normal checkouts can perform "
1305
"common operations like diff and status without "
1306
"such access, and also support local commits."
1308
Option('files-from', type=str,
1309
help="Get file contents from this tree."),
1311
help='Hard-link working tree files where possible.'
1316
def run(self, branch_location=None, to_location=None, revision=None,
1317
lightweight=False, files_from=None, hardlink=False):
1318
if branch_location is None:
1319
branch_location = osutils.getcwd()
1320
to_location = branch_location
1321
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1323
revision = _get_one_revision('checkout', revision)
1324
if files_from is not None:
1325
accelerator_tree = WorkingTree.open(files_from)
1326
if revision is not None:
1327
revision_id = revision.as_revision_id(source)
1330
if to_location is None:
1331
to_location = urlutils.derive_to_location(branch_location)
1332
# if the source and to_location are the same,
1333
# and there is no working tree,
1334
# then reconstitute a branch
1335
if (osutils.abspath(to_location) ==
1336
osutils.abspath(branch_location)):
1338
source.bzrdir.open_workingtree()
1339
except errors.NoWorkingTree:
1340
source.bzrdir.create_workingtree(revision_id)
1342
source.create_checkout(to_location, revision_id, lightweight,
1343
accelerator_tree, hardlink)
1346
class cmd_renames(Command):
1347
"""Show list of renamed files.
1349
# TODO: Option to show renames between two historical versions.
1351
# TODO: Only show renames under dir, rather than in the whole branch.
1352
_see_also = ['status']
1353
takes_args = ['dir?']
1356
def run(self, dir=u'.'):
1357
tree = WorkingTree.open_containing(dir)[0]
1360
new_inv = tree.inventory
1361
old_tree = tree.basis_tree()
1362
old_tree.lock_read()
1364
old_inv = old_tree.inventory
1366
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1367
for f, paths, c, v, p, n, k, e in iterator:
1368
if paths[0] == paths[1]:
1372
renames.append(paths)
1374
for old_name, new_name in renames:
1375
self.outf.write("%s => %s\n" % (old_name, new_name))
1382
class cmd_update(Command):
1383
"""Update a tree to have the latest code committed to its branch.
1385
This will perform a merge into the working tree, and may generate
1386
conflicts. If you have any local changes, you will still
1387
need to commit them after the update for the update to be complete.
1389
If you want to discard your local changes, you can just do a
1390
'bzr revert' instead of 'bzr commit' after the update.
1393
_see_also = ['pull', 'working-trees', 'status-flags']
1394
takes_args = ['dir?']
1397
def run(self, dir='.'):
1398
tree = WorkingTree.open_containing(dir)[0]
1399
possible_transports = []
1400
master = tree.branch.get_master_branch(
1401
possible_transports=possible_transports)
1402
if master is not None:
1405
tree.lock_tree_write()
1407
existing_pending_merges = tree.get_parent_ids()[1:]
1408
last_rev = _mod_revision.ensure_null(tree.last_revision())
1409
if last_rev == _mod_revision.ensure_null(
1410
tree.branch.last_revision()):
1411
# may be up to date, check master too.
1412
if master is None or last_rev == _mod_revision.ensure_null(
1413
master.last_revision()):
1414
revno = tree.branch.revision_id_to_revno(last_rev)
1415
note("Tree is up to date at revision %d." % (revno,))
1417
view_info = _get_view_info_for_change_reporter(tree)
1418
conflicts = tree.update(
1419
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1420
view_info=view_info), possible_transports=possible_transports)
1421
revno = tree.branch.revision_id_to_revno(
1422
_mod_revision.ensure_null(tree.last_revision()))
1423
note('Updated to revision %d.' % (revno,))
1424
if tree.get_parent_ids()[1:] != existing_pending_merges:
1425
note('Your local commits will now show as pending merges with '
1426
"'bzr status', and can be committed with 'bzr commit'.")
1435
class cmd_info(Command):
1436
"""Show information about a working tree, branch or repository.
1438
This command will show all known locations and formats associated to the
1439
tree, branch or repository.
1441
In verbose mode, statistical information is included with each report.
1442
To see extended statistic information, use a verbosity level of 2 or
1443
higher by specifying the verbose option multiple times, e.g. -vv.
1445
Branches and working trees will also report any missing revisions.
1449
Display information on the format and related locations:
1453
Display the above together with extended format information and
1454
basic statistics (like the number of files in the working tree and
1455
number of revisions in the branch and repository):
1459
Display the above together with number of committers to the branch:
1463
_see_also = ['revno', 'working-trees', 'repositories']
1464
takes_args = ['location?']
1465
takes_options = ['verbose']
1466
encoding_type = 'replace'
1469
def run(self, location=None, verbose=False):
1471
noise_level = get_verbosity_level()
1474
from bzrlib.info import show_bzrdir_info
1475
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1476
verbose=noise_level, outfile=self.outf)
1479
class cmd_remove(Command):
1480
"""Remove files or directories.
1482
This makes bzr stop tracking changes to the specified files. bzr will delete
1483
them if they can easily be recovered using revert. If no options or
1484
parameters are given bzr will scan for files that are being tracked by bzr
1485
but missing in your tree and stop tracking them for you.
1487
takes_args = ['file*']
1488
takes_options = ['verbose',
1489
Option('new', help='Only remove files that have never been committed.'),
1490
RegistryOption.from_kwargs('file-deletion-strategy',
1491
'The file deletion mode to be used.',
1492
title='Deletion Strategy', value_switches=True, enum_switch=False,
1493
safe='Only delete files if they can be'
1494
' safely recovered (default).',
1495
keep='Delete from bzr but leave the working copy.',
1496
force='Delete all the specified files, even if they can not be '
1497
'recovered and even if they are non-empty directories.')]
1498
aliases = ['rm', 'del']
1499
encoding_type = 'replace'
1501
def run(self, file_list, verbose=False, new=False,
1502
file_deletion_strategy='safe'):
1503
tree, file_list = tree_files(file_list)
1505
if file_list is not None:
1506
file_list = [f for f in file_list]
1510
# Heuristics should probably all move into tree.remove_smart or
1513
added = tree.changes_from(tree.basis_tree(),
1514
specific_files=file_list).added
1515
file_list = sorted([f[0] for f in added], reverse=True)
1516
if len(file_list) == 0:
1517
raise errors.BzrCommandError('No matching files.')
1518
elif file_list is None:
1519
# missing files show up in iter_changes(basis) as
1520
# versioned-with-no-kind.
1522
for change in tree.iter_changes(tree.basis_tree()):
1523
# Find paths in the working tree that have no kind:
1524
if change[1][1] is not None and change[6][1] is None:
1525
missing.append(change[1][1])
1526
file_list = sorted(missing, reverse=True)
1527
file_deletion_strategy = 'keep'
1528
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1529
keep_files=file_deletion_strategy=='keep',
1530
force=file_deletion_strategy=='force')
1535
class cmd_file_id(Command):
1536
"""Print file_id of a particular file or directory.
1538
The file_id is assigned when the file is first added and remains the
1539
same through all revisions where the file exists, even when it is
1544
_see_also = ['inventory', 'ls']
1545
takes_args = ['filename']
1548
def run(self, filename):
1549
tree, relpath = WorkingTree.open_containing(filename)
1550
i = tree.path2id(relpath)
1552
raise errors.NotVersionedError(filename)
1554
self.outf.write(i + '\n')
1557
class cmd_file_path(Command):
1558
"""Print path of file_ids to a file or directory.
1560
This prints one line for each directory down to the target,
1561
starting at the branch root.
1565
takes_args = ['filename']
1568
def run(self, filename):
1569
tree, relpath = WorkingTree.open_containing(filename)
1570
fid = tree.path2id(relpath)
1572
raise errors.NotVersionedError(filename)
1573
segments = osutils.splitpath(relpath)
1574
for pos in range(1, len(segments) + 1):
1575
path = osutils.joinpath(segments[:pos])
1576
self.outf.write("%s\n" % tree.path2id(path))
1579
class cmd_reconcile(Command):
1580
"""Reconcile bzr metadata in a branch.
1582
This can correct data mismatches that may have been caused by
1583
previous ghost operations or bzr upgrades. You should only
1584
need to run this command if 'bzr check' or a bzr developer
1585
advises you to run it.
1587
If a second branch is provided, cross-branch reconciliation is
1588
also attempted, which will check that data like the tree root
1589
id which was not present in very early bzr versions is represented
1590
correctly in both branches.
1592
At the same time it is run it may recompress data resulting in
1593
a potential saving in disk space or performance gain.
1595
The branch *MUST* be on a listable system such as local disk or sftp.
1598
_see_also = ['check']
1599
takes_args = ['branch?']
1601
def run(self, branch="."):
1602
from bzrlib.reconcile import reconcile
1603
dir = bzrdir.BzrDir.open(branch)
1607
class cmd_revision_history(Command):
1608
"""Display the list of revision ids on a branch."""
1611
takes_args = ['location?']
1616
def run(self, location="."):
1617
branch = Branch.open_containing(location)[0]
1618
for revid in branch.revision_history():
1619
self.outf.write(revid)
1620
self.outf.write('\n')
1623
class cmd_ancestry(Command):
1624
"""List all revisions merged into this branch."""
1626
_see_also = ['log', 'revision-history']
1627
takes_args = ['location?']
1632
def run(self, location="."):
1634
wt = WorkingTree.open_containing(location)[0]
1635
except errors.NoWorkingTree:
1636
b = Branch.open(location)
1637
last_revision = b.last_revision()
1640
last_revision = wt.last_revision()
1642
revision_ids = b.repository.get_ancestry(last_revision)
1644
for revision_id in revision_ids:
1645
self.outf.write(revision_id + '\n')
1648
class cmd_init(Command):
1649
"""Make a directory into a versioned branch.
1651
Use this to create an empty branch, or before importing an
1654
If there is a repository in a parent directory of the location, then
1655
the history of the branch will be stored in the repository. Otherwise
1656
init creates a standalone branch which carries its own history
1657
in the .bzr directory.
1659
If there is already a branch at the location but it has no working tree,
1660
the tree can be populated with 'bzr checkout'.
1662
Recipe for importing a tree of files::
1668
bzr commit -m "imported project"
1671
_see_also = ['init-repository', 'branch', 'checkout']
1672
takes_args = ['location?']
1674
Option('create-prefix',
1675
help='Create the path leading up to the branch '
1676
'if it does not already exist.'),
1677
RegistryOption('format',
1678
help='Specify a format for this branch. '
1679
'See "help formats".',
1680
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1681
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1682
value_switches=True,
1683
title="Branch format",
1685
Option('append-revisions-only',
1686
help='Never change revnos or the existing log.'
1687
' Append revisions to it only.')
1689
def run(self, location=None, format=None, append_revisions_only=False,
1690
create_prefix=False):
1692
format = bzrdir.format_registry.make_bzrdir('default')
1693
if location is None:
1696
to_transport = transport.get_transport(location)
1698
# The path has to exist to initialize a
1699
# branch inside of it.
1700
# Just using os.mkdir, since I don't
1701
# believe that we want to create a bunch of
1702
# locations if the user supplies an extended path
1704
to_transport.ensure_base()
1705
except errors.NoSuchFile:
1706
if not create_prefix:
1707
raise errors.BzrCommandError("Parent directory of %s"
1709
"\nYou may supply --create-prefix to create all"
1710
" leading parent directories."
1712
to_transport.create_prefix()
1715
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1716
except errors.NotBranchError:
1717
# really a NotBzrDir error...
1718
create_branch = bzrdir.BzrDir.create_branch_convenience
1719
branch = create_branch(to_transport.base, format=format,
1720
possible_transports=[to_transport])
1721
a_bzrdir = branch.bzrdir
1723
from bzrlib.transport.local import LocalTransport
1724
if a_bzrdir.has_branch():
1725
if (isinstance(to_transport, LocalTransport)
1726
and not a_bzrdir.has_workingtree()):
1727
raise errors.BranchExistsWithoutWorkingTree(location)
1728
raise errors.AlreadyBranchError(location)
1729
branch = a_bzrdir.create_branch()
1730
a_bzrdir.create_workingtree()
1731
if append_revisions_only:
1733
branch.set_append_revisions_only(True)
1734
except errors.UpgradeRequired:
1735
raise errors.BzrCommandError('This branch format cannot be set'
1736
' to append-revisions-only. Try --default.')
1738
from bzrlib.info import describe_layout, describe_format
1740
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1741
except (errors.NoWorkingTree, errors.NotLocalUrl):
1743
repository = branch.repository
1744
layout = describe_layout(repository, branch, tree).lower()
1745
format = describe_format(a_bzrdir, repository, branch, tree)
1746
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1747
if repository.is_shared():
1748
#XXX: maybe this can be refactored into transport.path_or_url()
1749
url = repository.bzrdir.root_transport.external_url()
1751
url = urlutils.local_path_from_url(url)
1752
except errors.InvalidURL:
1754
self.outf.write("Using shared repository: %s\n" % url)
1757
class cmd_init_repository(Command):
1758
"""Create a shared repository for branches to share storage space.
1760
New branches created under the repository directory will store their
1761
revisions in the repository, not in the branch directory. For branches
1762
with shared history, this reduces the amount of storage needed and
1763
speeds up the creation of new branches.
1765
If the --no-trees option is given then the branches in the repository
1766
will not have working trees by default. They will still exist as
1767
directories on disk, but they will not have separate copies of the
1768
files at a certain revision. This can be useful for repositories that
1769
store branches which are interacted with through checkouts or remote
1770
branches, such as on a server.
1773
Create a shared repository holding just branches::
1775
bzr init-repo --no-trees repo
1778
Make a lightweight checkout elsewhere::
1780
bzr checkout --lightweight repo/trunk trunk-checkout
1785
_see_also = ['init', 'branch', 'checkout', 'repositories']
1786
takes_args = ["location"]
1787
takes_options = [RegistryOption('format',
1788
help='Specify a format for this repository. See'
1789
' "bzr help formats" for details.',
1790
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1791
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1792
value_switches=True, title='Repository format'),
1794
help='Branches in the repository will default to'
1795
' not having a working tree.'),
1797
aliases = ["init-repo"]
1799
def run(self, location, format=None, no_trees=False):
1801
format = bzrdir.format_registry.make_bzrdir('default')
1803
if location is None:
1806
to_transport = transport.get_transport(location)
1807
to_transport.ensure_base()
1809
newdir = format.initialize_on_transport(to_transport)
1810
repo = newdir.create_repository(shared=True)
1811
repo.set_make_working_trees(not no_trees)
1813
from bzrlib.info import show_bzrdir_info
1814
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1817
class cmd_diff(Command):
1818
"""Show differences in the working tree, between revisions or branches.
1820
If no arguments are given, all changes for the current tree are listed.
1821
If files are given, only the changes in those files are listed.
1822
Remote and multiple branches can be compared by using the --old and
1823
--new options. If not provided, the default for both is derived from
1824
the first argument, if any, or the current tree if no arguments are
1827
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1828
produces patches suitable for "patch -p1".
1832
2 - unrepresentable changes
1837
Shows the difference in the working tree versus the last commit::
1841
Difference between the working tree and revision 1::
1845
Difference between revision 3 and revision 1::
1849
Difference between revision 3 and revision 1 for branch xxx::
1853
To see the changes introduced in revision X::
1857
Note that in the case of a merge, the -c option shows the changes
1858
compared to the left hand parent. To see the changes against
1859
another parent, use::
1861
bzr diff -r<chosen_parent>..X
1863
The changes introduced by revision 2 (equivalent to -r1..2)::
1867
Show just the differences for file NEWS::
1871
Show the differences in working tree xxx for file NEWS::
1875
Show the differences from branch xxx to this working tree:
1879
Show the differences between two branches for file NEWS::
1881
bzr diff --old xxx --new yyy NEWS
1883
Same as 'bzr diff' but prefix paths with old/ and new/::
1885
bzr diff --prefix old/:new/
1887
_see_also = ['status']
1888
takes_args = ['file*']
1890
Option('diff-options', type=str,
1891
help='Pass these options to the external diff program.'),
1892
Option('prefix', type=str,
1894
help='Set prefixes added to old and new filenames, as '
1895
'two values separated by a colon. (eg "old/:new/").'),
1897
help='Branch/tree to compare from.',
1901
help='Branch/tree to compare to.',
1907
help='Use this command to compare files.',
1911
aliases = ['di', 'dif']
1912
encoding_type = 'exact'
1915
def run(self, revision=None, file_list=None, diff_options=None,
1916
prefix=None, old=None, new=None, using=None):
1917
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1919
if (prefix is None) or (prefix == '0'):
1927
old_label, new_label = prefix.split(":")
1929
raise errors.BzrCommandError(
1930
'--prefix expects two values separated by a colon'
1931
' (eg "old/:new/")')
1933
if revision and len(revision) > 2:
1934
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1935
' one or two revision specifiers')
1937
(old_tree, new_tree,
1938
old_branch, new_branch,
1939
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1940
file_list, revision, old, new, apply_view=True)
1941
return show_diff_trees(old_tree, new_tree, sys.stdout,
1942
specific_files=specific_files,
1943
external_diff_options=diff_options,
1944
old_label=old_label, new_label=new_label,
1945
extra_trees=extra_trees, using=using)
1948
class cmd_deleted(Command):
1949
"""List files deleted in the working tree.
1951
# TODO: Show files deleted since a previous revision, or
1952
# between two revisions.
1953
# TODO: Much more efficient way to do this: read in new
1954
# directories with readdir, rather than stating each one. Same
1955
# level of effort but possibly much less IO. (Or possibly not,
1956
# if the directories are very large...)
1957
_see_also = ['status', 'ls']
1958
takes_options = ['show-ids']
1961
def run(self, show_ids=False):
1962
tree = WorkingTree.open_containing(u'.')[0]
1965
old = tree.basis_tree()
1968
for path, ie in old.inventory.iter_entries():
1969
if not tree.has_id(ie.file_id):
1970
self.outf.write(path)
1972
self.outf.write(' ')
1973
self.outf.write(ie.file_id)
1974
self.outf.write('\n')
1981
class cmd_modified(Command):
1982
"""List files modified in working tree.
1986
_see_also = ['status', 'ls']
1989
help='Write an ascii NUL (\\0) separator '
1990
'between files rather than a newline.')
1994
def run(self, null=False):
1995
tree = WorkingTree.open_containing(u'.')[0]
1996
td = tree.changes_from(tree.basis_tree())
1997
for path, id, kind, text_modified, meta_modified in td.modified:
1999
self.outf.write(path + '\0')
2001
self.outf.write(osutils.quotefn(path) + '\n')
2004
class cmd_added(Command):
2005
"""List files added in working tree.
2009
_see_also = ['status', 'ls']
2012
help='Write an ascii NUL (\\0) separator '
2013
'between files rather than a newline.')
2017
def run(self, null=False):
2018
wt = WorkingTree.open_containing(u'.')[0]
2021
basis = wt.basis_tree()
2024
basis_inv = basis.inventory
2027
if file_id in basis_inv:
2029
if inv.is_root(file_id) and len(basis_inv) == 0:
2031
path = inv.id2path(file_id)
2032
if not os.access(osutils.abspath(path), os.F_OK):
2035
self.outf.write(path + '\0')
2037
self.outf.write(osutils.quotefn(path) + '\n')
2044
class cmd_root(Command):
2045
"""Show the tree root directory.
2047
The root is the nearest enclosing directory with a .bzr control
2050
takes_args = ['filename?']
2052
def run(self, filename=None):
2053
"""Print the branch root."""
2054
tree = WorkingTree.open_containing(filename)[0]
2055
self.outf.write(tree.basedir + '\n')
2058
def _parse_limit(limitstring):
2060
return int(limitstring)
2062
msg = "The limit argument must be an integer."
2063
raise errors.BzrCommandError(msg)
2066
def _parse_levels(s):
2070
msg = "The levels argument must be an integer."
2071
raise errors.BzrCommandError(msg)
2074
class cmd_log(Command):
2075
"""Show historical log for a branch or subset of a branch.
2077
log is bzr's default tool for exploring the history of a branch.
2078
The branch to use is taken from the first parameter. If no parameters
2079
are given, the branch containing the working directory is logged.
2080
Here are some simple examples::
2082
bzr log log the current branch
2083
bzr log foo.py log a file in its branch
2084
bzr log http://server/branch log a branch on a server
2086
The filtering, ordering and information shown for each revision can
2087
be controlled as explained below. By default, all revisions are
2088
shown sorted (topologically) so that newer revisions appear before
2089
older ones and descendants always appear before ancestors. If displayed,
2090
merged revisions are shown indented under the revision in which they
2095
The log format controls how information about each revision is
2096
displayed. The standard log formats are called ``long``, ``short``
2097
and ``line``. The default is long. See ``bzr help log-formats``
2098
for more details on log formats.
2100
The following options can be used to control what information is
2103
-l N display a maximum of N revisions
2104
-n N display N levels of revisions (0 for all, 1 for collapsed)
2105
-v display a status summary (delta) for each revision
2106
-p display a diff (patch) for each revision
2107
--show-ids display revision-ids (and file-ids), not just revnos
2109
Note that the default number of levels to display is a function of the
2110
log format. If the -n option is not used, the standard log formats show
2111
just the top level (mainline).
2113
Status summaries are shown using status flags like A, M, etc. To see
2114
the changes explained using words like ``added`` and ``modified``
2115
instead, use the -vv option.
2119
To display revisions from oldest to newest, use the --forward option.
2120
In most cases, using this option will have little impact on the total
2121
time taken to produce a log, though --forward does not incrementally
2122
display revisions like --reverse does when it can.
2124
:Revision filtering:
2126
The -r option can be used to specify what revision or range of revisions
2127
to filter against. The various forms are shown below::
2129
-rX display revision X
2130
-rX.. display revision X and later
2131
-r..Y display up to and including revision Y
2132
-rX..Y display from X to Y inclusive
2134
See ``bzr help revisionspec`` for details on how to specify X and Y.
2135
Some common examples are given below::
2137
-r-1 show just the tip
2138
-r-10.. show the last 10 mainline revisions
2139
-rsubmit:.. show what's new on this branch
2140
-rancestor:path.. show changes since the common ancestor of this
2141
branch and the one at location path
2142
-rdate:yesterday.. show changes since yesterday
2144
When logging a range of revisions using -rX..Y, log starts at
2145
revision Y and searches back in history through the primary
2146
("left-hand") parents until it finds X. When logging just the
2147
top level (using -n1), an error is reported if X is not found
2148
along the way. If multi-level logging is used (-n0), X may be
2149
a nested merge revision and the log will be truncated accordingly.
2153
If parameters are given and the first one is not a branch, the log
2154
will be filtered to show only those revisions that changed the
2155
nominated files or directories.
2157
Filenames are interpreted within their historical context. To log a
2158
deleted file, specify a revision range so that the file existed at
2159
the end or start of the range.
2161
Historical context is also important when interpreting pathnames of
2162
renamed files/directories. Consider the following example:
2164
* revision 1: add tutorial.txt
2165
* revision 2: modify tutorial.txt
2166
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2170
* ``bzr log guide.txt`` will log the file added in revision 1
2172
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2174
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2175
the original file in revision 2.
2177
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2178
was no file called guide.txt in revision 2.
2180
Renames are always followed by log. By design, there is no need to
2181
explicitly ask for this (and no way to stop logging a file back
2182
until it was last renamed).
2186
The --message option can be used for finding revisions that match a
2187
regular expression in a commit message.
2191
GUI tools and IDEs are often better at exploring history than command
2192
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2193
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2194
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2196
Web interfaces are often better at exploring history than command line
2197
tools, particularly for branches on servers. You may prefer Loggerhead
2198
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2200
You may find it useful to add the aliases below to ``bazaar.conf``::
2204
top = log -l10 --line
2207
``bzr tip`` will then show the latest revision while ``bzr top``
2208
will show the last 10 mainline revisions. To see the details of a
2209
particular revision X, ``bzr show -rX``.
2211
If you are interested in looking deeper into a particular merge X,
2212
use ``bzr log -n0 -rX``.
2214
``bzr log -v`` on a branch with lots of history is currently
2215
very slow. A fix for this issue is currently under development.
2216
With or without that fix, it is recommended that a revision range
2217
be given when using the -v option.
2219
bzr has a generic full-text matching plugin, bzr-search, that can be
2220
used to find revisions matching user names, commit messages, etc.
2221
Among other features, this plugin can find all revisions containing
2222
a list of words but not others.
2224
When exploring non-mainline history on large projects with deep
2225
history, the performance of log can be greatly improved by installing
2226
the historycache plugin. This plugin buffers historical information
2227
trading disk space for faster speed.
2229
takes_args = ['file*']
2230
_see_also = ['log-formats', 'revisionspec']
2233
help='Show from oldest to newest.'),
2235
custom_help('verbose',
2236
help='Show files changed in each revision.'),
2240
type=bzrlib.option._parse_revision_str,
2242
help='Show just the specified revision.'
2243
' See also "help revisionspec".'),
2247
help='Number of levels to display - 0 for all, 1 for flat.',
2249
type=_parse_levels),
2252
help='Show revisions whose message matches this '
2253
'regular expression.',
2257
help='Limit the output to the first N revisions.',
2262
help='Show changes made in each revision as a patch.'),
2263
Option('include-merges',
2264
help='Show merged revisions like --levels 0 does.'),
2266
encoding_type = 'replace'
2269
def run(self, file_list=None, timezone='original',
2280
include_merges=False):
2281
from bzrlib.log import (
2283
make_log_request_dict,
2284
_get_info_for_log_files,
2286
direction = (forward and 'forward') or 'reverse'
2291
raise errors.BzrCommandError(
2292
'--levels and --include-merges are mutually exclusive')
2294
if change is not None:
2296
raise errors.RangeInChangeOption()
2297
if revision is not None:
2298
raise errors.BzrCommandError(
2299
'--revision and --change are mutually exclusive')
2304
filter_by_dir = False
2308
# find the file ids to log and check for directory filtering
2309
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2310
revision, file_list)
2311
for relpath, file_id, kind in file_info_list:
2313
raise errors.BzrCommandError(
2314
"Path unknown at end or start of revision range: %s" %
2316
# If the relpath is the top of the tree, we log everything
2321
file_ids.append(file_id)
2322
filter_by_dir = filter_by_dir or (
2323
kind in ['directory', 'tree-reference'])
2326
# FIXME ? log the current subdir only RBC 20060203
2327
if revision is not None \
2328
and len(revision) > 0 and revision[0].get_branch():
2329
location = revision[0].get_branch()
2332
dir, relpath = bzrdir.BzrDir.open_containing(location)
2333
b = dir.open_branch()
2335
rev1, rev2 = _get_revision_range(revision, b, self.name())
2337
# Decide on the type of delta & diff filtering to use
2338
# TODO: add an --all-files option to make this configurable & consistent
2346
diff_type = 'partial'
2350
# Build the log formatter
2351
if log_format is None:
2352
log_format = log.log_formatter_registry.get_default(b)
2353
lf = log_format(show_ids=show_ids, to_file=self.outf,
2354
show_timezone=timezone,
2355
delta_format=get_verbosity_level(),
2357
show_advice=levels is None)
2359
# Choose the algorithm for doing the logging. It's annoying
2360
# having multiple code paths like this but necessary until
2361
# the underlying repository format is faster at generating
2362
# deltas or can provide everything we need from the indices.
2363
# The default algorithm - match-using-deltas - works for
2364
# multiple files and directories and is faster for small
2365
# amounts of history (200 revisions say). However, it's too
2366
# slow for logging a single file in a repository with deep
2367
# history, i.e. > 10K revisions. In the spirit of "do no
2368
# evil when adding features", we continue to use the
2369
# original algorithm - per-file-graph - for the "single
2370
# file that isn't a directory without showing a delta" case.
2371
partial_history = revision and b.repository._format.supports_chks
2372
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2373
or delta_type or partial_history)
2375
# Build the LogRequest and execute it
2376
if len(file_ids) == 0:
2378
rqst = make_log_request_dict(
2379
direction=direction, specific_fileids=file_ids,
2380
start_revision=rev1, end_revision=rev2, limit=limit,
2381
message_search=message, delta_type=delta_type,
2382
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2383
Logger(b, rqst).show(lf)
2389
def _get_revision_range(revisionspec_list, branch, command_name):
2390
"""Take the input of a revision option and turn it into a revision range.
2392
It returns RevisionInfo objects which can be used to obtain the rev_id's
2393
of the desired revisions. It does some user input validations.
2395
if revisionspec_list is None:
2398
elif len(revisionspec_list) == 1:
2399
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2400
elif len(revisionspec_list) == 2:
2401
start_spec = revisionspec_list[0]
2402
end_spec = revisionspec_list[1]
2403
if end_spec.get_branch() != start_spec.get_branch():
2404
# b is taken from revision[0].get_branch(), and
2405
# show_log will use its revision_history. Having
2406
# different branches will lead to weird behaviors.
2407
raise errors.BzrCommandError(
2408
"bzr %s doesn't accept two revisions in different"
2409
" branches." % command_name)
2410
rev1 = start_spec.in_history(branch)
2411
# Avoid loading all of history when we know a missing
2412
# end of range means the last revision ...
2413
if end_spec.spec is None:
2414
last_revno, last_revision_id = branch.last_revision_info()
2415
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2417
rev2 = end_spec.in_history(branch)
2419
raise errors.BzrCommandError(
2420
'bzr %s --revision takes one or two values.' % command_name)
2424
def _revision_range_to_revid_range(revision_range):
2427
if revision_range[0] is not None:
2428
rev_id1 = revision_range[0].rev_id
2429
if revision_range[1] is not None:
2430
rev_id2 = revision_range[1].rev_id
2431
return rev_id1, rev_id2
2433
def get_log_format(long=False, short=False, line=False, default='long'):
2434
log_format = default
2438
log_format = 'short'
2444
class cmd_touching_revisions(Command):
2445
"""Return revision-ids which affected a particular file.
2447
A more user-friendly interface is "bzr log FILE".
2451
takes_args = ["filename"]
2454
def run(self, filename):
2455
tree, relpath = WorkingTree.open_containing(filename)
2456
file_id = tree.path2id(relpath)
2460
touching_revs = log.find_touching_revisions(b, file_id)
2461
for revno, revision_id, what in touching_revs:
2462
self.outf.write("%6d %s\n" % (revno, what))
2467
class cmd_ls(Command):
2468
"""List files in a tree.
2471
_see_also = ['status', 'cat']
2472
takes_args = ['path?']
2476
Option('recursive', short_name='R',
2477
help='Recurse into subdirectories.'),
2479
help='Print paths relative to the root of the branch.'),
2480
Option('unknown', help='Print unknown files.'),
2481
Option('versioned', help='Print versioned files.',
2483
Option('ignored', help='Print ignored files.'),
2485
help='Write an ascii NUL (\\0) separator '
2486
'between files rather than a newline.'),
2488
help='List entries of a particular kind: file, directory, symlink.',
2493
def run(self, revision=None, verbose=False,
2494
recursive=False, from_root=False,
2495
unknown=False, versioned=False, ignored=False,
2496
null=False, kind=None, show_ids=False, path=None):
2498
if kind and kind not in ('file', 'directory', 'symlink'):
2499
raise errors.BzrCommandError('invalid kind specified')
2501
if verbose and null:
2502
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2503
all = not (unknown or versioned or ignored)
2505
selection = {'I':ignored, '?':unknown, 'V':versioned}
2511
raise errors.BzrCommandError('cannot specify both --from-root'
2514
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2517
# Calculate the prefix to use
2521
prefix = relpath + '/'
2522
elif fs_path != '.' and not fs_path.endswith('/'):
2523
prefix = fs_path + '/'
2525
if revision is not None or tree is None:
2526
tree = _get_one_revision_tree('ls', revision, branch=branch)
2529
if isinstance(tree, WorkingTree) and tree.supports_views():
2530
view_files = tree.views.lookup_view()
2533
view_str = views.view_display_str(view_files)
2534
note("Ignoring files outside view. View is %s" % view_str)
2538
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2539
from_dir=relpath, recursive=recursive):
2540
# Apply additional masking
2541
if not all and not selection[fc]:
2543
if kind is not None and fkind != kind:
2548
fullpath = osutils.pathjoin(relpath, fp)
2551
views.check_path_in_view(tree, fullpath)
2552
except errors.FileOutsideView:
2557
fp = osutils.pathjoin(prefix, fp)
2558
kindch = entry.kind_character()
2559
outstring = fp + kindch
2560
ui.ui_factory.clear_term()
2562
outstring = '%-8s %s' % (fc, outstring)
2563
if show_ids and fid is not None:
2564
outstring = "%-50s %s" % (outstring, fid)
2565
self.outf.write(outstring + '\n')
2567
self.outf.write(fp + '\0')
2570
self.outf.write(fid)
2571
self.outf.write('\0')
2579
self.outf.write('%-50s %s\n' % (outstring, my_id))
2581
self.outf.write(outstring + '\n')
2586
class cmd_unknowns(Command):
2587
"""List unknown files.
2595
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2596
self.outf.write(osutils.quotefn(f) + '\n')
2599
class cmd_ignore(Command):
2600
"""Ignore specified files or patterns.
2602
See ``bzr help patterns`` for details on the syntax of patterns.
2604
If a .bzrignore file does not exist, the ignore command
2605
will create one and add the specified files or patterns to the newly
2606
created file. The ignore command will also automatically add the
2607
.bzrignore file to be versioned. Creating a .bzrignore file without
2608
the use of the ignore command will require an explicit add command.
2610
To remove patterns from the ignore list, edit the .bzrignore file.
2611
After adding, editing or deleting that file either indirectly by
2612
using this command or directly by using an editor, be sure to commit
2615
Note: ignore patterns containing shell wildcards must be quoted from
2619
Ignore the top level Makefile::
2621
bzr ignore ./Makefile
2623
Ignore class files in all directories::
2625
bzr ignore "*.class"
2627
Ignore .o files under the lib directory::
2629
bzr ignore "lib/**/*.o"
2631
Ignore .o files under the lib directory::
2633
bzr ignore "RE:lib/.*\.o"
2635
Ignore everything but the "debian" toplevel directory::
2637
bzr ignore "RE:(?!debian/).*"
2640
_see_also = ['status', 'ignored', 'patterns']
2641
takes_args = ['name_pattern*']
2643
Option('old-default-rules',
2644
help='Write out the ignore rules bzr < 0.9 always used.')
2647
def run(self, name_pattern_list=None, old_default_rules=None):
2648
from bzrlib import ignores
2649
if old_default_rules is not None:
2650
# dump the rules and exit
2651
for pattern in ignores.OLD_DEFAULTS:
2654
if not name_pattern_list:
2655
raise errors.BzrCommandError("ignore requires at least one "
2656
"NAME_PATTERN or --old-default-rules")
2657
name_pattern_list = [globbing.normalize_pattern(p)
2658
for p in name_pattern_list]
2659
for name_pattern in name_pattern_list:
2660
if (name_pattern[0] == '/' or
2661
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2662
raise errors.BzrCommandError(
2663
"NAME_PATTERN should not be an absolute path")
2664
tree, relpath = WorkingTree.open_containing(u'.')
2665
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2666
ignored = globbing.Globster(name_pattern_list)
2669
for entry in tree.list_files():
2673
if ignored.match(filename):
2674
matches.append(filename.encode('utf-8'))
2676
if len(matches) > 0:
2677
print "Warning: the following files are version controlled and" \
2678
" match your ignore pattern:\n%s" \
2679
"\nThese files will continue to be version controlled" \
2680
" unless you 'bzr remove' them." % ("\n".join(matches),)
2683
class cmd_ignored(Command):
2684
"""List ignored files and the patterns that matched them.
2686
List all the ignored files and the ignore pattern that caused the file to
2689
Alternatively, to list just the files::
2694
encoding_type = 'replace'
2695
_see_also = ['ignore', 'ls']
2699
tree = WorkingTree.open_containing(u'.')[0]
2702
for path, file_class, kind, file_id, entry in tree.list_files():
2703
if file_class != 'I':
2705
## XXX: Slightly inefficient since this was already calculated
2706
pat = tree.is_ignored(path)
2707
self.outf.write('%-50s %s\n' % (path, pat))
2712
class cmd_lookup_revision(Command):
2713
"""Lookup the revision-id from a revision-number
2716
bzr lookup-revision 33
2719
takes_args = ['revno']
2722
def run(self, revno):
2726
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2728
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2731
class cmd_export(Command):
2732
"""Export current or past revision to a destination directory or archive.
2734
If no revision is specified this exports the last committed revision.
2736
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2737
given, try to find the format with the extension. If no extension
2738
is found exports to a directory (equivalent to --format=dir).
2740
If root is supplied, it will be used as the root directory inside
2741
container formats (tar, zip, etc). If it is not supplied it will default
2742
to the exported filename. The root option has no effect for 'dir' format.
2744
If branch is omitted then the branch containing the current working
2745
directory will be used.
2747
Note: Export of tree with non-ASCII filenames to zip is not supported.
2749
================= =========================
2750
Supported formats Autodetected by extension
2751
================= =========================
2754
tbz2 .tar.bz2, .tbz2
2757
================= =========================
2759
takes_args = ['dest', 'branch_or_subdir?']
2762
help="Type of file to export to.",
2765
Option('filters', help='Apply content filters to export the '
2766
'convenient form.'),
2769
help="Name of the root directory inside the exported file."),
2771
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2772
root=None, filters=False):
2773
from bzrlib.export import export
2775
if branch_or_subdir is None:
2776
tree = WorkingTree.open_containing(u'.')[0]
2780
b, subdir = Branch.open_containing(branch_or_subdir)
2783
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2785
export(rev_tree, dest, format, root, subdir, filtered=filters)
2786
except errors.NoSuchExportFormat, e:
2787
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2790
class cmd_cat(Command):
2791
"""Write the contents of a file as of a given revision to standard output.
2793
If no revision is nominated, the last revision is used.
2795
Note: Take care to redirect standard output when using this command on a
2801
Option('name-from-revision', help='The path name in the old tree.'),
2802
Option('filters', help='Apply content filters to display the '
2803
'convenience form.'),
2806
takes_args = ['filename']
2807
encoding_type = 'exact'
2810
def run(self, filename, revision=None, name_from_revision=False,
2812
if revision is not None and len(revision) != 1:
2813
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2814
" one revision specifier")
2815
tree, branch, relpath = \
2816
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2819
return self._run(tree, branch, relpath, filename, revision,
2820
name_from_revision, filters)
2824
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2827
tree = b.basis_tree()
2828
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2830
old_file_id = rev_tree.path2id(relpath)
2832
if name_from_revision:
2833
# Try in revision if requested
2834
if old_file_id is None:
2835
raise errors.BzrCommandError(
2836
"%r is not present in revision %s" % (
2837
filename, rev_tree.get_revision_id()))
2839
content = rev_tree.get_file_text(old_file_id)
2841
cur_file_id = tree.path2id(relpath)
2843
if cur_file_id is not None:
2844
# Then try with the actual file id
2846
content = rev_tree.get_file_text(cur_file_id)
2848
except errors.NoSuchId:
2849
# The actual file id didn't exist at that time
2851
if not found and old_file_id is not None:
2852
# Finally try with the old file id
2853
content = rev_tree.get_file_text(old_file_id)
2856
# Can't be found anywhere
2857
raise errors.BzrCommandError(
2858
"%r is not present in revision %s" % (
2859
filename, rev_tree.get_revision_id()))
2861
from bzrlib.filters import (
2862
ContentFilterContext,
2863
filtered_output_bytes,
2865
filters = rev_tree._content_filter_stack(relpath)
2866
chunks = content.splitlines(True)
2867
content = filtered_output_bytes(chunks, filters,
2868
ContentFilterContext(relpath, rev_tree))
2869
self.outf.writelines(content)
2871
self.outf.write(content)
2874
class cmd_local_time_offset(Command):
2875
"""Show the offset in seconds from GMT to local time."""
2879
print osutils.local_time_offset()
2883
class cmd_commit(Command):
2884
"""Commit changes into a new revision.
2886
An explanatory message needs to be given for each commit. This is
2887
often done by using the --message option (getting the message from the
2888
command line) or by using the --file option (getting the message from
2889
a file). If neither of these options is given, an editor is opened for
2890
the user to enter the message. To see the changed files in the
2891
boilerplate text loaded into the editor, use the --show-diff option.
2893
By default, the entire tree is committed and the person doing the
2894
commit is assumed to be the author. These defaults can be overridden
2899
If selected files are specified, only changes to those files are
2900
committed. If a directory is specified then the directory and
2901
everything within it is committed.
2903
When excludes are given, they take precedence over selected files.
2904
For example, to commit only changes within foo, but not changes
2907
bzr commit foo -x foo/bar
2909
A selective commit after a merge is not yet supported.
2913
If the author of the change is not the same person as the committer,
2914
you can specify the author's name using the --author option. The
2915
name should be in the same format as a committer-id, e.g.
2916
"John Doe <jdoe@example.com>". If there is more than one author of
2917
the change you can specify the option multiple times, once for each
2922
A common mistake is to forget to add a new file or directory before
2923
running the commit command. The --strict option checks for unknown
2924
files and aborts the commit if any are found. More advanced pre-commit
2925
checks can be implemented by defining hooks. See ``bzr help hooks``
2930
If you accidentially commit the wrong changes or make a spelling
2931
mistake in the commit message say, you can use the uncommit command
2932
to undo it. See ``bzr help uncommit`` for details.
2934
Hooks can also be configured to run after a commit. This allows you
2935
to trigger updates to external systems like bug trackers. The --fixes
2936
option can be used to record the association between a revision and
2937
one or more bugs. See ``bzr help bugs`` for details.
2939
A selective commit may fail in some cases where the committed
2940
tree would be invalid. Consider::
2945
bzr commit foo -m "committing foo"
2946
bzr mv foo/bar foo/baz
2949
bzr commit foo/bar -m "committing bar but not baz"
2951
In the example above, the last commit will fail by design. This gives
2952
the user the opportunity to decide whether they want to commit the
2953
rename at the same time, separately first, or not at all. (As a general
2954
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2956
# TODO: Run hooks on tree to-be-committed, and after commit.
2958
# TODO: Strict commit that fails if there are deleted files.
2959
# (what does "deleted files" mean ??)
2961
# TODO: Give better message for -s, --summary, used by tla people
2963
# XXX: verbose currently does nothing
2965
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2966
takes_args = ['selected*']
2968
ListOption('exclude', type=str, short_name='x',
2969
help="Do not consider changes made to a given path."),
2970
Option('message', type=unicode,
2972
help="Description of the new revision."),
2975
help='Commit even if nothing has changed.'),
2976
Option('file', type=str,
2979
help='Take commit message from this file.'),
2981
help="Refuse to commit if there are unknown "
2982
"files in the working tree."),
2983
Option('commit-time', type=str,
2984
help="Manually set a commit time using commit date "
2985
"format, e.g. '2009-10-10 08:00:00 +0100'."),
2986
ListOption('fixes', type=str,
2987
help="Mark a bug as being fixed by this revision "
2988
"(see \"bzr help bugs\")."),
2989
ListOption('author', type=unicode,
2990
help="Set the author's name, if it's different "
2991
"from the committer."),
2993
help="Perform a local commit in a bound "
2994
"branch. Local commits are not pushed to "
2995
"the master branch until a normal commit "
2999
help='When no message is supplied, show the diff along'
3000
' with the status summary in the message editor.'),
3002
aliases = ['ci', 'checkin']
3004
def _iter_bug_fix_urls(self, fixes, branch):
3005
# Configure the properties for bug fixing attributes.
3006
for fixed_bug in fixes:
3007
tokens = fixed_bug.split(':')
3008
if len(tokens) != 2:
3009
raise errors.BzrCommandError(
3010
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3011
"See \"bzr help bugs\" for more information on this "
3012
"feature.\nCommit refused." % fixed_bug)
3013
tag, bug_id = tokens
3015
yield bugtracker.get_bug_url(tag, branch, bug_id)
3016
except errors.UnknownBugTrackerAbbreviation:
3017
raise errors.BzrCommandError(
3018
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3019
except errors.MalformedBugIdentifier, e:
3020
raise errors.BzrCommandError(
3021
"%s\nCommit refused." % (str(e),))
3023
def run(self, message=None, file=None, verbose=False, selected_list=None,
3024
unchanged=False, strict=False, local=False, fixes=None,
3025
author=None, show_diff=False, exclude=None, commit_time=None):
3026
from bzrlib.errors import (
3031
from bzrlib.msgeditor import (
3032
edit_commit_message_encoded,
3033
generate_commit_message_template,
3034
make_commit_message_template_encoded
3037
commit_stamp = offset = None
3038
if commit_time is not None:
3040
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3041
except ValueError, e:
3042
raise errors.BzrCommandError(
3043
"Could not parse --commit-time: " + str(e))
3045
# TODO: Need a blackbox test for invoking the external editor; may be
3046
# slightly problematic to run this cross-platform.
3048
# TODO: do more checks that the commit will succeed before
3049
# spending the user's valuable time typing a commit message.
3053
tree, selected_list = tree_files(selected_list)
3054
if selected_list == ['']:
3055
# workaround - commit of root of tree should be exactly the same
3056
# as just default commit in that tree, and succeed even though
3057
# selected-file merge commit is not done yet
3062
bug_property = bugtracker.encode_fixes_bug_urls(
3063
self._iter_bug_fix_urls(fixes, tree.branch))
3065
properties['bugs'] = bug_property
3067
if local and not tree.branch.get_bound_location():
3068
raise errors.LocalRequiresBoundBranch()
3070
def get_message(commit_obj):
3071
"""Callback to get commit message"""
3072
my_message = message
3073
if my_message is not None and '\r' in my_message:
3074
my_message = my_message.replace('\r\n', '\n')
3075
my_message = my_message.replace('\r', '\n')
3076
if my_message is None and not file:
3077
t = make_commit_message_template_encoded(tree,
3078
selected_list, diff=show_diff,
3079
output_encoding=osutils.get_user_encoding())
3080
start_message = generate_commit_message_template(commit_obj)
3081
my_message = edit_commit_message_encoded(t,
3082
start_message=start_message)
3083
if my_message is None:
3084
raise errors.BzrCommandError("please specify a commit"
3085
" message with either --message or --file")
3086
elif my_message and file:
3087
raise errors.BzrCommandError(
3088
"please specify either --message or --file")
3090
my_message = codecs.open(file, 'rt',
3091
osutils.get_user_encoding()).read()
3092
if my_message == "":
3093
raise errors.BzrCommandError("empty commit message specified")
3096
# The API permits a commit with a filter of [] to mean 'select nothing'
3097
# but the command line should not do that.
3098
if not selected_list:
3099
selected_list = None
3101
tree.commit(message_callback=get_message,
3102
specific_files=selected_list,
3103
allow_pointless=unchanged, strict=strict, local=local,
3104
reporter=None, verbose=verbose, revprops=properties,
3105
authors=author, timestamp=commit_stamp,
3107
exclude=safe_relpath_files(tree, exclude))
3108
except PointlessCommit:
3109
# FIXME: This should really happen before the file is read in;
3110
# perhaps prepare the commit; get the message; then actually commit
3111
raise errors.BzrCommandError("No changes to commit."
3112
" Use --unchanged to commit anyhow.")
3113
except ConflictsInTree:
3114
raise errors.BzrCommandError('Conflicts detected in working '
3115
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3117
except StrictCommitFailed:
3118
raise errors.BzrCommandError("Commit refused because there are"
3119
" unknown files in the working tree.")
3120
except errors.BoundBranchOutOfDate, e:
3121
raise errors.BzrCommandError(str(e) + "\n"
3122
'To commit to master branch, run update and then commit.\n'
3123
'You can also pass --local to commit to continue working '
3127
class cmd_check(Command):
3128
"""Validate working tree structure, branch consistency and repository history.
3130
This command checks various invariants about branch and repository storage
3131
to detect data corruption or bzr bugs.
3133
The working tree and branch checks will only give output if a problem is
3134
detected. The output fields of the repository check are:
3137
This is just the number of revisions checked. It doesn't
3141
This is just the number of versionedfiles checked. It
3142
doesn't indicate a problem.
3144
unreferenced ancestors
3145
Texts that are ancestors of other texts, but
3146
are not properly referenced by the revision ancestry. This is a
3147
subtle problem that Bazaar can work around.
3150
This is the total number of unique file contents
3151
seen in the checked revisions. It does not indicate a problem.
3154
This is the total number of repeated texts seen
3155
in the checked revisions. Texts can be repeated when their file
3156
entries are modified, but the file contents are not. It does not
3159
If no restrictions are specified, all Bazaar data that is found at the given
3160
location will be checked.
3164
Check the tree and branch at 'foo'::
3166
bzr check --tree --branch foo
3168
Check only the repository at 'bar'::
3170
bzr check --repo bar
3172
Check everything at 'baz'::
3177
_see_also = ['reconcile']
3178
takes_args = ['path?']
3179
takes_options = ['verbose',
3180
Option('branch', help="Check the branch related to the"
3181
" current directory."),
3182
Option('repo', help="Check the repository related to the"
3183
" current directory."),
3184
Option('tree', help="Check the working tree related to"
3185
" the current directory.")]
3187
def run(self, path=None, verbose=False, branch=False, repo=False,
3189
from bzrlib.check import check_dwim
3192
if not branch and not repo and not tree:
3193
branch = repo = tree = True
3194
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3197
class cmd_upgrade(Command):
3198
"""Upgrade branch storage to current format.
3200
The check command or bzr developers may sometimes advise you to run
3201
this command. When the default format has changed you may also be warned
3202
during other operations to upgrade.
3205
_see_also = ['check']
3206
takes_args = ['url?']
3208
RegistryOption('format',
3209
help='Upgrade to a specific format. See "bzr help'
3210
' formats" for details.',
3211
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3212
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3213
value_switches=True, title='Branch format'),
3216
def run(self, url='.', format=None):
3217
from bzrlib.upgrade import upgrade
3218
upgrade(url, format)
3221
class cmd_whoami(Command):
3222
"""Show or set bzr user id.
3225
Show the email of the current user::
3229
Set the current user::
3231
bzr whoami "Frank Chu <fchu@example.com>"
3233
takes_options = [ Option('email',
3234
help='Display email address only.'),
3236
help='Set identity for the current branch instead of '
3239
takes_args = ['name?']
3240
encoding_type = 'replace'
3243
def run(self, email=False, branch=False, name=None):
3245
# use branch if we're inside one; otherwise global config
3247
c = Branch.open_containing('.')[0].get_config()
3248
except errors.NotBranchError:
3249
c = config.GlobalConfig()
3251
self.outf.write(c.user_email() + '\n')
3253
self.outf.write(c.username() + '\n')
3256
# display a warning if an email address isn't included in the given name.
3258
config.extract_email_address(name)
3259
except errors.NoEmailInUsername, e:
3260
warning('"%s" does not seem to contain an email address. '
3261
'This is allowed, but not recommended.', name)
3263
# use global config unless --branch given
3265
c = Branch.open_containing('.')[0].get_config()
3267
c = config.GlobalConfig()
3268
c.set_user_option('email', name)
3271
class cmd_nick(Command):
3272
"""Print or set the branch nickname.
3274
If unset, the tree root directory name is used as the nickname.
3275
To print the current nickname, execute with no argument.
3277
Bound branches use the nickname of its master branch unless it is set
3281
_see_also = ['info']
3282
takes_args = ['nickname?']
3283
def run(self, nickname=None):
3284
branch = Branch.open_containing(u'.')[0]
3285
if nickname is None:
3286
self.printme(branch)
3288
branch.nick = nickname
3291
def printme(self, branch):
3295
class cmd_alias(Command):
3296
"""Set/unset and display aliases.
3299
Show the current aliases::
3303
Show the alias specified for 'll'::
3307
Set an alias for 'll'::
3309
bzr alias ll="log --line -r-10..-1"
3311
To remove an alias for 'll'::
3313
bzr alias --remove ll
3316
takes_args = ['name?']
3318
Option('remove', help='Remove the alias.'),
3321
def run(self, name=None, remove=False):
3323
self.remove_alias(name)
3325
self.print_aliases()
3327
equal_pos = name.find('=')
3329
self.print_alias(name)
3331
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3333
def remove_alias(self, alias_name):
3334
if alias_name is None:
3335
raise errors.BzrCommandError(
3336
'bzr alias --remove expects an alias to remove.')
3337
# If alias is not found, print something like:
3338
# unalias: foo: not found
3339
c = config.GlobalConfig()
3340
c.unset_alias(alias_name)
3343
def print_aliases(self):
3344
"""Print out the defined aliases in a similar format to bash."""
3345
aliases = config.GlobalConfig().get_aliases()
3346
for key, value in sorted(aliases.iteritems()):
3347
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3350
def print_alias(self, alias_name):
3351
from bzrlib.commands import get_alias
3352
alias = get_alias(alias_name)
3354
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3357
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3359
def set_alias(self, alias_name, alias_command):
3360
"""Save the alias in the global config."""
3361
c = config.GlobalConfig()
3362
c.set_alias(alias_name, alias_command)
3365
class cmd_selftest(Command):
3366
"""Run internal test suite.
3368
If arguments are given, they are regular expressions that say which tests
3369
should run. Tests matching any expression are run, and other tests are
3372
Alternatively if --first is given, matching tests are run first and then
3373
all other tests are run. This is useful if you have been working in a
3374
particular area, but want to make sure nothing else was broken.
3376
If --exclude is given, tests that match that regular expression are
3377
excluded, regardless of whether they match --first or not.
3379
To help catch accidential dependencies between tests, the --randomize
3380
option is useful. In most cases, the argument used is the word 'now'.
3381
Note that the seed used for the random number generator is displayed
3382
when this option is used. The seed can be explicitly passed as the
3383
argument to this option if required. This enables reproduction of the
3384
actual ordering used if and when an order sensitive problem is encountered.
3386
If --list-only is given, the tests that would be run are listed. This is
3387
useful when combined with --first, --exclude and/or --randomize to
3388
understand their impact. The test harness reports "Listed nn tests in ..."
3389
instead of "Ran nn tests in ..." when list mode is enabled.
3391
If the global option '--no-plugins' is given, plugins are not loaded
3392
before running the selftests. This has two effects: features provided or
3393
modified by plugins will not be tested, and tests provided by plugins will
3396
Tests that need working space on disk use a common temporary directory,
3397
typically inside $TMPDIR or /tmp.
3399
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3400
into a pdb postmortem session.
3403
Run only tests relating to 'ignore'::
3407
Disable plugins and list tests as they're run::
3409
bzr --no-plugins selftest -v
3411
# NB: this is used from the class without creating an instance, which is
3412
# why it does not have a self parameter.
3413
def get_transport_type(typestring):
3414
"""Parse and return a transport specifier."""
3415
if typestring == "sftp":
3416
from bzrlib.transport.sftp import SFTPAbsoluteServer
3417
return SFTPAbsoluteServer
3418
if typestring == "memory":
3419
from bzrlib.transport.memory import MemoryServer
3421
if typestring == "fakenfs":
3422
from bzrlib.transport.fakenfs import FakeNFSServer
3423
return FakeNFSServer
3424
msg = "No known transport type %s. Supported types are: sftp\n" %\
3426
raise errors.BzrCommandError(msg)
3429
takes_args = ['testspecs*']
3430
takes_options = ['verbose',
3432
help='Stop when one test fails.',
3436
help='Use a different transport by default '
3437
'throughout the test suite.',
3438
type=get_transport_type),
3440
help='Run the benchmarks rather than selftests.'),
3441
Option('lsprof-timed',
3442
help='Generate lsprof output for benchmarked'
3443
' sections of code.'),
3444
Option('lsprof-tests',
3445
help='Generate lsprof output for each test.'),
3446
Option('cache-dir', type=str,
3447
help='Cache intermediate benchmark output in this '
3450
help='Run all tests, but run specified tests first.',
3454
help='List the tests instead of running them.'),
3455
RegistryOption('parallel',
3456
help="Run the test suite in parallel.",
3457
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3458
value_switches=False,
3460
Option('randomize', type=str, argname="SEED",
3461
help='Randomize the order of tests using the given'
3462
' seed or "now" for the current time.'),
3463
Option('exclude', type=str, argname="PATTERN",
3465
help='Exclude tests that match this regular'
3468
help='Output test progress via subunit.'),
3469
Option('strict', help='Fail on missing dependencies or '
3471
Option('load-list', type=str, argname='TESTLISTFILE',
3472
help='Load a test id list from a text file.'),
3473
ListOption('debugflag', type=str, short_name='E',
3474
help='Turn on a selftest debug flag.'),
3475
ListOption('starting-with', type=str, argname='TESTID',
3476
param_name='starting_with', short_name='s',
3478
'Load only the tests starting with TESTID.'),
3480
encoding_type = 'replace'
3483
Command.__init__(self)
3484
self.additional_selftest_args = {}
3486
def run(self, testspecs_list=None, verbose=False, one=False,
3487
transport=None, benchmark=None,
3488
lsprof_timed=None, cache_dir=None,
3489
first=False, list_only=False,
3490
randomize=None, exclude=None, strict=False,
3491
load_list=None, debugflag=None, starting_with=None, subunit=False,
3492
parallel=None, lsprof_tests=False):
3493
from bzrlib.tests import selftest
3494
import bzrlib.benchmarks as benchmarks
3495
from bzrlib.benchmarks import tree_creator
3497
# Make deprecation warnings visible, unless -Werror is set
3498
symbol_versioning.activate_deprecation_warnings(override=False)
3500
if cache_dir is not None:
3501
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3502
if testspecs_list is not None:
3503
pattern = '|'.join(testspecs_list)
3508
from bzrlib.tests import SubUnitBzrRunner
3510
raise errors.BzrCommandError("subunit not available. subunit "
3511
"needs to be installed to use --subunit.")
3512
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3514
self.additional_selftest_args.setdefault(
3515
'suite_decorators', []).append(parallel)
3517
test_suite_factory = benchmarks.test_suite
3518
# Unless user explicitly asks for quiet, be verbose in benchmarks
3519
verbose = not is_quiet()
3520
# TODO: should possibly lock the history file...
3521
benchfile = open(".perf_history", "at", buffering=1)
3523
test_suite_factory = None
3526
selftest_kwargs = {"verbose": verbose,
3528
"stop_on_failure": one,
3529
"transport": transport,
3530
"test_suite_factory": test_suite_factory,
3531
"lsprof_timed": lsprof_timed,
3532
"lsprof_tests": lsprof_tests,
3533
"bench_history": benchfile,
3534
"matching_tests_first": first,
3535
"list_only": list_only,
3536
"random_seed": randomize,
3537
"exclude_pattern": exclude,
3539
"load_list": load_list,
3540
"debug_flags": debugflag,
3541
"starting_with": starting_with
3543
selftest_kwargs.update(self.additional_selftest_args)
3544
result = selftest(**selftest_kwargs)
3546
if benchfile is not None:
3548
return int(not result)
3551
class cmd_version(Command):
3552
"""Show version of bzr."""
3554
encoding_type = 'replace'
3556
Option("short", help="Print just the version number."),
3560
def run(self, short=False):
3561
from bzrlib.version import show_version
3563
self.outf.write(bzrlib.version_string + '\n')
3565
show_version(to_file=self.outf)
3568
class cmd_rocks(Command):
3569
"""Statement of optimism."""
3575
print "It sure does!"
3578
class cmd_find_merge_base(Command):
3579
"""Find and print a base revision for merging two branches."""
3580
# TODO: Options to specify revisions on either side, as if
3581
# merging only part of the history.
3582
takes_args = ['branch', 'other']
3586
def run(self, branch, other):
3587
from bzrlib.revision import ensure_null
3589
branch1 = Branch.open_containing(branch)[0]
3590
branch2 = Branch.open_containing(other)[0]
3595
last1 = ensure_null(branch1.last_revision())
3596
last2 = ensure_null(branch2.last_revision())
3598
graph = branch1.repository.get_graph(branch2.repository)
3599
base_rev_id = graph.find_unique_lca(last1, last2)
3601
print 'merge base is revision %s' % base_rev_id
3608
class cmd_merge(Command):
3609
"""Perform a three-way merge.
3611
The source of the merge can be specified either in the form of a branch,
3612
or in the form of a path to a file containing a merge directive generated
3613
with bzr send. If neither is specified, the default is the upstream branch
3614
or the branch most recently merged using --remember.
3616
When merging a branch, by default the tip will be merged. To pick a different
3617
revision, pass --revision. If you specify two values, the first will be used as
3618
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3619
available revisions, like this is commonly referred to as "cherrypicking".
3621
Revision numbers are always relative to the branch being merged.
3623
By default, bzr will try to merge in all new work from the other
3624
branch, automatically determining an appropriate base. If this
3625
fails, you may need to give an explicit base.
3627
Merge will do its best to combine the changes in two branches, but there
3628
are some kinds of problems only a human can fix. When it encounters those,
3629
it will mark a conflict. A conflict means that you need to fix something,
3630
before you should commit.
3632
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3634
If there is no default branch set, the first merge will set it. After
3635
that, you can omit the branch to use the default. To change the
3636
default, use --remember. The value will only be saved if the remote
3637
location can be accessed.
3639
The results of the merge are placed into the destination working
3640
directory, where they can be reviewed (with bzr diff), tested, and then
3641
committed to record the result of the merge.
3643
merge refuses to run if there are any uncommitted changes, unless
3646
To select only some changes to merge, use "merge -i", which will prompt
3647
you to apply each diff hunk and file change, similar to "shelve".
3650
To merge the latest revision from bzr.dev::
3652
bzr merge ../bzr.dev
3654
To merge changes up to and including revision 82 from bzr.dev::
3656
bzr merge -r 82 ../bzr.dev
3658
To merge the changes introduced by 82, without previous changes::
3660
bzr merge -r 81..82 ../bzr.dev
3662
To apply a merge directive contained in /tmp/merge::
3664
bzr merge /tmp/merge
3667
encoding_type = 'exact'
3668
_see_also = ['update', 'remerge', 'status-flags', 'send']
3669
takes_args = ['location?']
3674
help='Merge even if the destination tree has uncommitted changes.'),
3678
Option('show-base', help="Show base revision text in "
3680
Option('uncommitted', help='Apply uncommitted changes'
3681
' from a working copy, instead of branch changes.'),
3682
Option('pull', help='If the destination is already'
3683
' completely merged into the source, pull from the'
3684
' source rather than merging. When this happens,'
3685
' you do not need to commit the result.'),
3687
help='Branch to merge into, '
3688
'rather than the one containing the working directory.',
3692
Option('preview', help='Instead of merging, show a diff of the'
3694
Option('interactive', help='Select changes interactively.',
3698
def run(self, location=None, revision=None, force=False,
3699
merge_type=None, show_base=False, reprocess=None, remember=False,
3700
uncommitted=False, pull=False,
3705
if merge_type is None:
3706
merge_type = _mod_merge.Merge3Merger
3708
if directory is None: directory = u'.'
3709
possible_transports = []
3711
allow_pending = True
3712
verified = 'inapplicable'
3713
tree = WorkingTree.open_containing(directory)[0]
3716
basis_tree = tree.revision_tree(tree.last_revision())
3717
except errors.NoSuchRevision:
3718
basis_tree = tree.basis_tree()
3720
# die as quickly as possible if there are uncommitted changes
3722
if tree.has_changes():
3723
raise errors.UncommittedChanges(tree)
3725
view_info = _get_view_info_for_change_reporter(tree)
3726
change_reporter = delta._ChangeReporter(
3727
unversioned_filter=tree.is_ignored, view_info=view_info)
3730
pb = ui.ui_factory.nested_progress_bar()
3731
cleanups.append(pb.finished)
3733
cleanups.append(tree.unlock)
3734
if location is not None:
3736
mergeable = bundle.read_mergeable_from_url(location,
3737
possible_transports=possible_transports)
3738
except errors.NotABundle:
3742
raise errors.BzrCommandError('Cannot use --uncommitted'
3743
' with bundles or merge directives.')
3745
if revision is not None:
3746
raise errors.BzrCommandError(
3747
'Cannot use -r with merge directives or bundles')
3748
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3751
if merger is None and uncommitted:
3752
if revision is not None and len(revision) > 0:
3753
raise errors.BzrCommandError('Cannot use --uncommitted and'
3754
' --revision at the same time.')
3755
merger = self.get_merger_from_uncommitted(tree, location, pb,
3757
allow_pending = False
3760
merger, allow_pending = self._get_merger_from_branch(tree,
3761
location, revision, remember, possible_transports, pb)
3763
merger.merge_type = merge_type
3764
merger.reprocess = reprocess
3765
merger.show_base = show_base
3766
self.sanity_check_merger(merger)
3767
if (merger.base_rev_id == merger.other_rev_id and
3768
merger.other_rev_id is not None):
3769
note('Nothing to do.')
3772
if merger.interesting_files is not None:
3773
raise errors.BzrCommandError('Cannot pull individual files')
3774
if (merger.base_rev_id == tree.last_revision()):
3775
result = tree.pull(merger.other_branch, False,
3776
merger.other_rev_id)
3777
result.report(self.outf)
3779
if merger.this_basis is None:
3780
raise errors.BzrCommandError(
3781
"This branch has no commits."
3782
" (perhaps you would prefer 'bzr pull')")
3784
return self._do_preview(merger, cleanups)
3786
return self._do_interactive(merger, cleanups)
3788
return self._do_merge(merger, change_reporter, allow_pending,
3791
for cleanup in reversed(cleanups):
3794
def _get_preview(self, merger, cleanups):
3795
tree_merger = merger.make_merger()
3796
tt = tree_merger.make_preview_transform()
3797
cleanups.append(tt.finalize)
3798
result_tree = tt.get_preview_tree()
3801
def _do_preview(self, merger, cleanups):
3802
from bzrlib.diff import show_diff_trees
3803
result_tree = self._get_preview(merger, cleanups)
3804
show_diff_trees(merger.this_tree, result_tree, self.outf,
3805
old_label='', new_label='')
3807
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3808
merger.change_reporter = change_reporter
3809
conflict_count = merger.do_merge()
3811
merger.set_pending()
3812
if verified == 'failed':
3813
warning('Preview patch does not match changes')
3814
if conflict_count != 0:
3819
def _do_interactive(self, merger, cleanups):
3820
"""Perform an interactive merge.
3822
This works by generating a preview tree of the merge, then using
3823
Shelver to selectively remove the differences between the working tree
3824
and the preview tree.
3826
from bzrlib import shelf_ui
3827
result_tree = self._get_preview(merger, cleanups)
3828
writer = bzrlib.option.diff_writer_registry.get()
3829
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3830
reporter=shelf_ui.ApplyReporter(),
3831
diff_writer=writer(sys.stdout))
3834
def sanity_check_merger(self, merger):
3835
if (merger.show_base and
3836
not merger.merge_type is _mod_merge.Merge3Merger):
3837
raise errors.BzrCommandError("Show-base is not supported for this"
3838
" merge type. %s" % merger.merge_type)
3839
if merger.reprocess is None:
3840
if merger.show_base:
3841
merger.reprocess = False
3843
# Use reprocess if the merger supports it
3844
merger.reprocess = merger.merge_type.supports_reprocess
3845
if merger.reprocess and not merger.merge_type.supports_reprocess:
3846
raise errors.BzrCommandError("Conflict reduction is not supported"
3847
" for merge type %s." %
3849
if merger.reprocess and merger.show_base:
3850
raise errors.BzrCommandError("Cannot do conflict reduction and"
3853
def _get_merger_from_branch(self, tree, location, revision, remember,
3854
possible_transports, pb):
3855
"""Produce a merger from a location, assuming it refers to a branch."""
3856
from bzrlib.tag import _merge_tags_if_possible
3857
# find the branch locations
3858
other_loc, user_location = self._select_branch_location(tree, location,
3860
if revision is not None and len(revision) == 2:
3861
base_loc, _unused = self._select_branch_location(tree,
3862
location, revision, 0)
3864
base_loc = other_loc
3866
other_branch, other_path = Branch.open_containing(other_loc,
3867
possible_transports)
3868
if base_loc == other_loc:
3869
base_branch = other_branch
3871
base_branch, base_path = Branch.open_containing(base_loc,
3872
possible_transports)
3873
# Find the revision ids
3874
other_revision_id = None
3875
base_revision_id = None
3876
if revision is not None:
3877
if len(revision) >= 1:
3878
other_revision_id = revision[-1].as_revision_id(other_branch)
3879
if len(revision) == 2:
3880
base_revision_id = revision[0].as_revision_id(base_branch)
3881
if other_revision_id is None:
3882
other_revision_id = _mod_revision.ensure_null(
3883
other_branch.last_revision())
3884
# Remember where we merge from
3885
if ((remember or tree.branch.get_submit_branch() is None) and
3886
user_location is not None):
3887
tree.branch.set_submit_branch(other_branch.base)
3888
_merge_tags_if_possible(other_branch, tree.branch)
3889
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3890
other_revision_id, base_revision_id, other_branch, base_branch)
3891
if other_path != '':
3892
allow_pending = False
3893
merger.interesting_files = [other_path]
3895
allow_pending = True
3896
return merger, allow_pending
3898
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3899
"""Get a merger for uncommitted changes.
3901
:param tree: The tree the merger should apply to.
3902
:param location: The location containing uncommitted changes.
3903
:param pb: The progress bar to use for showing progress.
3904
:param cleanups: A list of operations to perform to clean up the
3905
temporary directories, unfinalized objects, etc.
3907
location = self._select_branch_location(tree, location)[0]
3908
other_tree, other_path = WorkingTree.open_containing(location)
3909
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3910
if other_path != '':
3911
merger.interesting_files = [other_path]
3914
def _select_branch_location(self, tree, user_location, revision=None,
3916
"""Select a branch location, according to possible inputs.
3918
If provided, branches from ``revision`` are preferred. (Both
3919
``revision`` and ``index`` must be supplied.)
3921
Otherwise, the ``location`` parameter is used. If it is None, then the
3922
``submit`` or ``parent`` location is used, and a note is printed.
3924
:param tree: The working tree to select a branch for merging into
3925
:param location: The location entered by the user
3926
:param revision: The revision parameter to the command
3927
:param index: The index to use for the revision parameter. Negative
3928
indices are permitted.
3929
:return: (selected_location, user_location). The default location
3930
will be the user-entered location.
3932
if (revision is not None and index is not None
3933
and revision[index] is not None):
3934
branch = revision[index].get_branch()
3935
if branch is not None:
3936
return branch, branch
3937
if user_location is None:
3938
location = self._get_remembered(tree, 'Merging from')
3940
location = user_location
3941
return location, user_location
3943
def _get_remembered(self, tree, verb_string):
3944
"""Use tree.branch's parent if none was supplied.
3946
Report if the remembered location was used.
3948
stored_location = tree.branch.get_submit_branch()
3949
stored_location_type = "submit"
3950
if stored_location is None:
3951
stored_location = tree.branch.get_parent()
3952
stored_location_type = "parent"
3953
mutter("%s", stored_location)
3954
if stored_location is None:
3955
raise errors.BzrCommandError("No location specified or remembered")
3956
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3957
note(u"%s remembered %s location %s", verb_string,
3958
stored_location_type, display_url)
3959
return stored_location
3962
class cmd_remerge(Command):
3965
Use this if you want to try a different merge technique while resolving
3966
conflicts. Some merge techniques are better than others, and remerge
3967
lets you try different ones on different files.
3969
The options for remerge have the same meaning and defaults as the ones for
3970
merge. The difference is that remerge can (only) be run when there is a
3971
pending merge, and it lets you specify particular files.
3974
Re-do the merge of all conflicted files, and show the base text in
3975
conflict regions, in addition to the usual THIS and OTHER texts::
3977
bzr remerge --show-base
3979
Re-do the merge of "foobar", using the weave merge algorithm, with
3980
additional processing to reduce the size of conflict regions::
3982
bzr remerge --merge-type weave --reprocess foobar
3984
takes_args = ['file*']
3989
help="Show base revision text in conflicts."),
3992
def run(self, file_list=None, merge_type=None, show_base=False,
3994
if merge_type is None:
3995
merge_type = _mod_merge.Merge3Merger
3996
tree, file_list = tree_files(file_list)
3999
parents = tree.get_parent_ids()
4000
if len(parents) != 2:
4001
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4002
" merges. Not cherrypicking or"
4004
repository = tree.branch.repository
4005
interesting_ids = None
4007
conflicts = tree.conflicts()
4008
if file_list is not None:
4009
interesting_ids = set()
4010
for filename in file_list:
4011
file_id = tree.path2id(filename)
4013
raise errors.NotVersionedError(filename)
4014
interesting_ids.add(file_id)
4015
if tree.kind(file_id) != "directory":
4018
for name, ie in tree.inventory.iter_entries(file_id):
4019
interesting_ids.add(ie.file_id)
4020
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4022
# Remerge only supports resolving contents conflicts
4023
allowed_conflicts = ('text conflict', 'contents conflict')
4024
restore_files = [c.path for c in conflicts
4025
if c.typestring in allowed_conflicts]
4026
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4027
tree.set_conflicts(ConflictList(new_conflicts))
4028
if file_list is not None:
4029
restore_files = file_list
4030
for filename in restore_files:
4032
restore(tree.abspath(filename))
4033
except errors.NotConflicted:
4035
# Disable pending merges, because the file texts we are remerging
4036
# have not had those merges performed. If we use the wrong parents
4037
# list, we imply that the working tree text has seen and rejected
4038
# all the changes from the other tree, when in fact those changes
4039
# have not yet been seen.
4040
pb = ui.ui_factory.nested_progress_bar()
4041
tree.set_parent_ids(parents[:1])
4043
merger = _mod_merge.Merger.from_revision_ids(pb,
4045
merger.interesting_ids = interesting_ids
4046
merger.merge_type = merge_type
4047
merger.show_base = show_base
4048
merger.reprocess = reprocess
4049
conflicts = merger.do_merge()
4051
tree.set_parent_ids(parents)
4061
class cmd_revert(Command):
4062
"""Revert files to a previous revision.
4064
Giving a list of files will revert only those files. Otherwise, all files
4065
will be reverted. If the revision is not specified with '--revision', the
4066
last committed revision is used.
4068
To remove only some changes, without reverting to a prior version, use
4069
merge instead. For example, "merge . --revision -2..-3" will remove the
4070
changes introduced by -2, without affecting the changes introduced by -1.
4071
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4073
By default, any files that have been manually changed will be backed up
4074
first. (Files changed only by merge are not backed up.) Backup files have
4075
'.~#~' appended to their name, where # is a number.
4077
When you provide files, you can use their current pathname or the pathname
4078
from the target revision. So you can use revert to "undelete" a file by
4079
name. If you name a directory, all the contents of that directory will be
4082
If you have newly added files since the target revision, they will be
4083
removed. If the files to be removed have been changed, backups will be
4084
created as above. Directories containing unknown files will not be
4087
The working tree contains a list of pending merged revisions, which will
4088
be included as parents in the next commit. Normally, revert clears that
4089
list as well as reverting the files. If any files are specified, revert
4090
leaves the pending merge list alone and reverts only the files. Use "bzr
4091
revert ." in the tree root to revert all files but keep the merge record,
4092
and "bzr revert --forget-merges" to clear the pending merge list without
4093
reverting any files.
4095
Using "bzr revert --forget-merges", it is possible to apply the changes
4096
from an arbitrary merge as a single revision. To do this, perform the
4097
merge as desired. Then doing revert with the "--forget-merges" option will
4098
keep the content of the tree as it was, but it will clear the list of
4099
pending merges. The next commit will then contain all of the changes that
4100
would have been in the merge, but without any mention of the other parent
4101
revisions. Because this technique forgets where these changes originated,
4102
it may cause additional conflicts on later merges involving the source and
4106
_see_also = ['cat', 'export']
4109
Option('no-backup', "Do not save backups of reverted files."),
4110
Option('forget-merges',
4111
'Remove pending merge marker, without changing any files.'),
4113
takes_args = ['file*']
4115
def run(self, revision=None, no_backup=False, file_list=None,
4116
forget_merges=None):
4117
tree, file_list = tree_files(file_list)
4121
tree.set_parent_ids(tree.get_parent_ids()[:1])
4123
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4128
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4129
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4130
pb = ui.ui_factory.nested_progress_bar()
4132
tree.revert(file_list, rev_tree, not no_backup, pb,
4133
report_changes=True)
4138
class cmd_assert_fail(Command):
4139
"""Test reporting of assertion failures"""
4140
# intended just for use in testing
4145
raise AssertionError("always fails")
4148
class cmd_help(Command):
4149
"""Show help on a command or other topic.
4152
_see_also = ['topics']
4154
Option('long', 'Show help on all commands.'),
4156
takes_args = ['topic?']
4157
aliases = ['?', '--help', '-?', '-h']
4160
def run(self, topic=None, long=False):
4162
if topic is None and long:
4164
bzrlib.help.help(topic)
4167
class cmd_shell_complete(Command):
4168
"""Show appropriate completions for context.
4170
For a list of all available commands, say 'bzr shell-complete'.
4172
takes_args = ['context?']
4177
def run(self, context=None):
4178
import shellcomplete
4179
shellcomplete.shellcomplete(context)
4182
class cmd_missing(Command):
4183
"""Show unmerged/unpulled revisions between two branches.
4185
OTHER_BRANCH may be local or remote.
4187
To filter on a range of revisions, you can use the command -r begin..end
4188
-r revision requests a specific revision, -r ..end or -r begin.. are
4192
1 - some missing revisions
4193
0 - no missing revisions
4197
Determine the missing revisions between this and the branch at the
4198
remembered pull location::
4202
Determine the missing revisions between this and another branch::
4204
bzr missing http://server/branch
4206
Determine the missing revisions up to a specific revision on the other
4209
bzr missing -r ..-10
4211
Determine the missing revisions up to a specific revision on this
4214
bzr missing --my-revision ..-10
4217
_see_also = ['merge', 'pull']
4218
takes_args = ['other_branch?']
4220
Option('reverse', 'Reverse the order of revisions.'),
4222
'Display changes in the local branch only.'),
4223
Option('this' , 'Same as --mine-only.'),
4224
Option('theirs-only',
4225
'Display changes in the remote branch only.'),
4226
Option('other', 'Same as --theirs-only.'),
4230
custom_help('revision',
4231
help='Filter on other branch revisions (inclusive). '
4232
'See "help revisionspec" for details.'),
4233
Option('my-revision',
4234
type=_parse_revision_str,
4235
help='Filter on local branch revisions (inclusive). '
4236
'See "help revisionspec" for details.'),
4237
Option('include-merges',
4238
'Show all revisions in addition to the mainline ones.'),
4240
encoding_type = 'replace'
4243
def run(self, other_branch=None, reverse=False, mine_only=False,
4245
log_format=None, long=False, short=False, line=False,
4246
show_ids=False, verbose=False, this=False, other=False,
4247
include_merges=False, revision=None, my_revision=None):
4248
from bzrlib.missing import find_unmerged, iter_log_revisions
4257
# TODO: We should probably check that we don't have mine-only and
4258
# theirs-only set, but it gets complicated because we also have
4259
# this and other which could be used.
4266
local_branch = Branch.open_containing(u".")[0]
4267
parent = local_branch.get_parent()
4268
if other_branch is None:
4269
other_branch = parent
4270
if other_branch is None:
4271
raise errors.BzrCommandError("No peer location known"
4273
display_url = urlutils.unescape_for_display(parent,
4275
message("Using saved parent location: "
4276
+ display_url + "\n")
4278
remote_branch = Branch.open(other_branch)
4279
if remote_branch.base == local_branch.base:
4280
remote_branch = local_branch
4282
local_revid_range = _revision_range_to_revid_range(
4283
_get_revision_range(my_revision, local_branch,
4286
remote_revid_range = _revision_range_to_revid_range(
4287
_get_revision_range(revision,
4288
remote_branch, self.name()))
4290
local_branch.lock_read()
4292
remote_branch.lock_read()
4294
local_extra, remote_extra = find_unmerged(
4295
local_branch, remote_branch, restrict,
4296
backward=not reverse,
4297
include_merges=include_merges,
4298
local_revid_range=local_revid_range,
4299
remote_revid_range=remote_revid_range)
4301
if log_format is None:
4302
registry = log.log_formatter_registry
4303
log_format = registry.get_default(local_branch)
4304
lf = log_format(to_file=self.outf,
4306
show_timezone='original')
4309
if local_extra and not theirs_only:
4310
message("You have %d extra revision(s):\n" %
4312
for revision in iter_log_revisions(local_extra,
4313
local_branch.repository,
4315
lf.log_revision(revision)
4316
printed_local = True
4319
printed_local = False
4321
if remote_extra and not mine_only:
4322
if printed_local is True:
4324
message("You are missing %d revision(s):\n" %
4326
for revision in iter_log_revisions(remote_extra,
4327
remote_branch.repository,
4329
lf.log_revision(revision)
4332
if mine_only and not local_extra:
4333
# We checked local, and found nothing extra
4334
message('This branch is up to date.\n')
4335
elif theirs_only and not remote_extra:
4336
# We checked remote, and found nothing extra
4337
message('Other branch is up to date.\n')
4338
elif not (mine_only or theirs_only or local_extra or
4340
# We checked both branches, and neither one had extra
4342
message("Branches are up to date.\n")
4344
remote_branch.unlock()
4346
local_branch.unlock()
4347
if not status_code and parent is None and other_branch is not None:
4348
local_branch.lock_write()
4350
# handle race conditions - a parent might be set while we run.
4351
if local_branch.get_parent() is None:
4352
local_branch.set_parent(remote_branch.base)
4354
local_branch.unlock()
4358
class cmd_pack(Command):
4359
"""Compress the data within a repository."""
4361
_see_also = ['repositories']
4362
takes_args = ['branch_or_repo?']
4364
def run(self, branch_or_repo='.'):
4365
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4367
branch = dir.open_branch()
4368
repository = branch.repository
4369
except errors.NotBranchError:
4370
repository = dir.open_repository()
4374
class cmd_plugins(Command):
4375
"""List the installed plugins.
4377
This command displays the list of installed plugins including
4378
version of plugin and a short description of each.
4380
--verbose shows the path where each plugin is located.
4382
A plugin is an external component for Bazaar that extends the
4383
revision control system, by adding or replacing code in Bazaar.
4384
Plugins can do a variety of things, including overriding commands,
4385
adding new commands, providing additional network transports and
4386
customizing log output.
4388
See the Bazaar web site, http://bazaar-vcs.org, for further
4389
information on plugins including where to find them and how to
4390
install them. Instructions are also provided there on how to
4391
write new plugins using the Python programming language.
4393
takes_options = ['verbose']
4396
def run(self, verbose=False):
4397
import bzrlib.plugin
4398
from inspect import getdoc
4400
for name, plugin in bzrlib.plugin.plugins().items():
4401
version = plugin.__version__
4402
if version == 'unknown':
4404
name_ver = '%s %s' % (name, version)
4405
d = getdoc(plugin.module)
4407
doc = d.split('\n')[0]
4409
doc = '(no description)'
4410
result.append((name_ver, doc, plugin.path()))
4411
for name_ver, doc, path in sorted(result):
4419
class cmd_testament(Command):
4420
"""Show testament (signing-form) of a revision."""
4423
Option('long', help='Produce long-format testament.'),
4425
help='Produce a strict-format testament.')]
4426
takes_args = ['branch?']
4428
def run(self, branch=u'.', revision=None, long=False, strict=False):
4429
from bzrlib.testament import Testament, StrictTestament
4431
testament_class = StrictTestament
4433
testament_class = Testament
4435
b = Branch.open_containing(branch)[0]
4437
b = Branch.open(branch)
4440
if revision is None:
4441
rev_id = b.last_revision()
4443
rev_id = revision[0].as_revision_id(b)
4444
t = testament_class.from_revision(b.repository, rev_id)
4446
sys.stdout.writelines(t.as_text_lines())
4448
sys.stdout.write(t.as_short_text())
4453
class cmd_annotate(Command):
4454
"""Show the origin of each line in a file.
4456
This prints out the given file with an annotation on the left side
4457
indicating which revision, author and date introduced the change.
4459
If the origin is the same for a run of consecutive lines, it is
4460
shown only at the top, unless the --all option is given.
4462
# TODO: annotate directories; showing when each file was last changed
4463
# TODO: if the working copy is modified, show annotations on that
4464
# with new uncommitted lines marked
4465
aliases = ['ann', 'blame', 'praise']
4466
takes_args = ['filename']
4467
takes_options = [Option('all', help='Show annotations on all lines.'),
4468
Option('long', help='Show commit date in annotations.'),
4472
encoding_type = 'exact'
4475
def run(self, filename, all=False, long=False, revision=None,
4477
from bzrlib.annotate import annotate_file, annotate_file_tree
4478
wt, branch, relpath = \
4479
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4485
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4487
file_id = wt.path2id(relpath)
4489
file_id = tree.path2id(relpath)
4491
raise errors.NotVersionedError(filename)
4492
file_version = tree.inventory[file_id].revision
4493
if wt is not None and revision is None:
4494
# If there is a tree and we're not annotating historical
4495
# versions, annotate the working tree's content.
4496
annotate_file_tree(wt, file_id, self.outf, long, all,
4499
annotate_file(branch, file_version, file_id, long, all, self.outf,
4508
class cmd_re_sign(Command):
4509
"""Create a digital signature for an existing revision."""
4510
# TODO be able to replace existing ones.
4512
hidden = True # is this right ?
4513
takes_args = ['revision_id*']
4514
takes_options = ['revision']
4516
def run(self, revision_id_list=None, revision=None):
4517
if revision_id_list is not None and revision is not None:
4518
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4519
if revision_id_list is None and revision is None:
4520
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4521
b = WorkingTree.open_containing(u'.')[0].branch
4524
return self._run(b, revision_id_list, revision)
4528
def _run(self, b, revision_id_list, revision):
4529
import bzrlib.gpg as gpg
4530
gpg_strategy = gpg.GPGStrategy(b.get_config())
4531
if revision_id_list is not None:
4532
b.repository.start_write_group()
4534
for revision_id in revision_id_list:
4535
b.repository.sign_revision(revision_id, gpg_strategy)
4537
b.repository.abort_write_group()
4540
b.repository.commit_write_group()
4541
elif revision is not None:
4542
if len(revision) == 1:
4543
revno, rev_id = revision[0].in_history(b)
4544
b.repository.start_write_group()
4546
b.repository.sign_revision(rev_id, gpg_strategy)
4548
b.repository.abort_write_group()
4551
b.repository.commit_write_group()
4552
elif len(revision) == 2:
4553
# are they both on rh- if so we can walk between them
4554
# might be nice to have a range helper for arbitrary
4555
# revision paths. hmm.
4556
from_revno, from_revid = revision[0].in_history(b)
4557
to_revno, to_revid = revision[1].in_history(b)
4558
if to_revid is None:
4559
to_revno = b.revno()
4560
if from_revno is None or to_revno is None:
4561
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4562
b.repository.start_write_group()
4564
for revno in range(from_revno, to_revno + 1):
4565
b.repository.sign_revision(b.get_rev_id(revno),
4568
b.repository.abort_write_group()
4571
b.repository.commit_write_group()
4573
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4576
class cmd_bind(Command):
4577
"""Convert the current branch into a checkout of the supplied branch.
4579
Once converted into a checkout, commits must succeed on the master branch
4580
before they will be applied to the local branch.
4582
Bound branches use the nickname of its master branch unless it is set
4583
locally, in which case binding will update the local nickname to be
4587
_see_also = ['checkouts', 'unbind']
4588
takes_args = ['location?']
4591
def run(self, location=None):
4592
b, relpath = Branch.open_containing(u'.')
4593
if location is None:
4595
location = b.get_old_bound_location()
4596
except errors.UpgradeRequired:
4597
raise errors.BzrCommandError('No location supplied. '
4598
'This format does not remember old locations.')
4600
if location is None:
4601
raise errors.BzrCommandError('No location supplied and no '
4602
'previous location known')
4603
b_other = Branch.open(location)
4606
except errors.DivergedBranches:
4607
raise errors.BzrCommandError('These branches have diverged.'
4608
' Try merging, and then bind again.')
4609
if b.get_config().has_explicit_nickname():
4610
b.nick = b_other.nick
4613
class cmd_unbind(Command):
4614
"""Convert the current checkout into a regular branch.
4616
After unbinding, the local branch is considered independent and subsequent
4617
commits will be local only.
4620
_see_also = ['checkouts', 'bind']
4625
b, relpath = Branch.open_containing(u'.')
4627
raise errors.BzrCommandError('Local branch is not bound')
4630
class cmd_uncommit(Command):
4631
"""Remove the last committed revision.
4633
--verbose will print out what is being removed.
4634
--dry-run will go through all the motions, but not actually
4637
If --revision is specified, uncommit revisions to leave the branch at the
4638
specified revision. For example, "bzr uncommit -r 15" will leave the
4639
branch at revision 15.
4641
Uncommit leaves the working tree ready for a new commit. The only change
4642
it may make is to restore any pending merges that were present before
4646
# TODO: jam 20060108 Add an option to allow uncommit to remove
4647
# unreferenced information in 'branch-as-repository' branches.
4648
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4649
# information in shared branches as well.
4650
_see_also = ['commit']
4651
takes_options = ['verbose', 'revision',
4652
Option('dry-run', help='Don\'t actually make changes.'),
4653
Option('force', help='Say yes to all questions.'),
4655
help="Only remove the commits from the local branch"
4656
" when in a checkout."
4659
takes_args = ['location?']
4661
encoding_type = 'replace'
4663
def run(self, location=None,
4664
dry_run=False, verbose=False,
4665
revision=None, force=False, local=False):
4666
if location is None:
4668
control, relpath = bzrdir.BzrDir.open_containing(location)
4670
tree = control.open_workingtree()
4672
except (errors.NoWorkingTree, errors.NotLocalUrl):
4674
b = control.open_branch()
4676
if tree is not None:
4681
return self._run(b, tree, dry_run, verbose, revision, force,
4684
if tree is not None:
4689
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4690
from bzrlib.log import log_formatter, show_log
4691
from bzrlib.uncommit import uncommit
4693
last_revno, last_rev_id = b.last_revision_info()
4696
if revision is None:
4698
rev_id = last_rev_id
4700
# 'bzr uncommit -r 10' actually means uncommit
4701
# so that the final tree is at revno 10.
4702
# but bzrlib.uncommit.uncommit() actually uncommits
4703
# the revisions that are supplied.
4704
# So we need to offset it by one
4705
revno = revision[0].in_history(b).revno + 1
4706
if revno <= last_revno:
4707
rev_id = b.get_rev_id(revno)
4709
if rev_id is None or _mod_revision.is_null(rev_id):
4710
self.outf.write('No revisions to uncommit.\n')
4713
lf = log_formatter('short',
4715
show_timezone='original')
4720
direction='forward',
4721
start_revision=revno,
4722
end_revision=last_revno)
4725
print 'Dry-run, pretending to remove the above revisions.'
4727
val = raw_input('Press <enter> to continue')
4729
print 'The above revision(s) will be removed.'
4731
val = raw_input('Are you sure [y/N]? ')
4732
if val.lower() not in ('y', 'yes'):
4736
mutter('Uncommitting from {%s} to {%s}',
4737
last_rev_id, rev_id)
4738
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4739
revno=revno, local=local)
4740
note('You can restore the old tip by running:\n'
4741
' bzr pull . -r revid:%s', last_rev_id)
4744
class cmd_break_lock(Command):
4745
"""Break a dead lock on a repository, branch or working directory.
4747
CAUTION: Locks should only be broken when you are sure that the process
4748
holding the lock has been stopped.
4750
You can get information on what locks are open via the 'bzr info' command.
4755
takes_args = ['location?']
4757
def run(self, location=None, show=False):
4758
if location is None:
4760
control, relpath = bzrdir.BzrDir.open_containing(location)
4762
control.break_lock()
4763
except NotImplementedError:
4767
class cmd_wait_until_signalled(Command):
4768
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4770
This just prints a line to signal when it is ready, then blocks on stdin.
4776
sys.stdout.write("running\n")
4778
sys.stdin.readline()
4781
class cmd_serve(Command):
4782
"""Run the bzr server."""
4784
aliases = ['server']
4788
help='Serve on stdin/out for use from inetd or sshd.'),
4789
RegistryOption('protocol',
4790
help="Protocol to serve.",
4791
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4792
value_switches=True),
4794
help='Listen for connections on nominated port of the form '
4795
'[hostname:]portnumber. Passing 0 as the port number will '
4796
'result in a dynamically allocated port. The default port '
4797
'depends on the protocol.',
4800
help='Serve contents of this directory.',
4802
Option('allow-writes',
4803
help='By default the server is a readonly server. Supplying '
4804
'--allow-writes enables write access to the contents of '
4805
'the served directory and below. Note that ``bzr serve`` '
4806
'does not perform authentication, so unless some form of '
4807
'external authentication is arranged supplying this '
4808
'option leads to global uncontrolled write access to your '
4813
def get_host_and_port(self, port):
4814
"""Return the host and port to run the smart server on.
4816
If 'port' is None, None will be returned for the host and port.
4818
If 'port' has a colon in it, the string before the colon will be
4819
interpreted as the host.
4821
:param port: A string of the port to run the server on.
4822
:return: A tuple of (host, port), where 'host' is a host name or IP,
4823
and port is an integer TCP/IP port.
4826
if port is not None:
4828
host, port = port.split(':')
4832
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4834
from bzrlib.transport import get_transport, transport_server_registry
4835
if directory is None:
4836
directory = os.getcwd()
4837
if protocol is None:
4838
protocol = transport_server_registry.get()
4839
host, port = self.get_host_and_port(port)
4840
url = urlutils.local_path_to_url(directory)
4841
if not allow_writes:
4842
url = 'readonly+' + url
4843
transport = get_transport(url)
4844
protocol(transport, host, port, inet)
4847
class cmd_join(Command):
4848
"""Combine a tree into its containing tree.
4850
This command requires the target tree to be in a rich-root format.
4852
The TREE argument should be an independent tree, inside another tree, but
4853
not part of it. (Such trees can be produced by "bzr split", but also by
4854
running "bzr branch" with the target inside a tree.)
4856
The result is a combined tree, with the subtree no longer an independant
4857
part. This is marked as a merge of the subtree into the containing tree,
4858
and all history is preserved.
4861
_see_also = ['split']
4862
takes_args = ['tree']
4864
Option('reference', help='Join by reference.', hidden=True),
4867
def run(self, tree, reference=False):
4868
sub_tree = WorkingTree.open(tree)
4869
parent_dir = osutils.dirname(sub_tree.basedir)
4870
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4871
repo = containing_tree.branch.repository
4872
if not repo.supports_rich_root():
4873
raise errors.BzrCommandError(
4874
"Can't join trees because %s doesn't support rich root data.\n"
4875
"You can use bzr upgrade on the repository."
4879
containing_tree.add_reference(sub_tree)
4880
except errors.BadReferenceTarget, e:
4881
# XXX: Would be better to just raise a nicely printable
4882
# exception from the real origin. Also below. mbp 20070306
4883
raise errors.BzrCommandError("Cannot join %s. %s" %
4887
containing_tree.subsume(sub_tree)
4888
except errors.BadSubsumeSource, e:
4889
raise errors.BzrCommandError("Cannot join %s. %s" %
4893
class cmd_split(Command):
4894
"""Split a subdirectory of a tree into a separate tree.
4896
This command will produce a target tree in a format that supports
4897
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4898
converted into earlier formats like 'dirstate-tags'.
4900
The TREE argument should be a subdirectory of a working tree. That
4901
subdirectory will be converted into an independent tree, with its own
4902
branch. Commits in the top-level tree will not apply to the new subtree.
4905
_see_also = ['join']
4906
takes_args = ['tree']
4908
def run(self, tree):
4909
containing_tree, subdir = WorkingTree.open_containing(tree)
4910
sub_id = containing_tree.path2id(subdir)
4912
raise errors.NotVersionedError(subdir)
4914
containing_tree.extract(sub_id)
4915
except errors.RootNotRich:
4916
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4919
class cmd_merge_directive(Command):
4920
"""Generate a merge directive for auto-merge tools.
4922
A directive requests a merge to be performed, and also provides all the
4923
information necessary to do so. This means it must either include a
4924
revision bundle, or the location of a branch containing the desired
4927
A submit branch (the location to merge into) must be supplied the first
4928
time the command is issued. After it has been supplied once, it will
4929
be remembered as the default.
4931
A public branch is optional if a revision bundle is supplied, but required
4932
if --diff or --plain is specified. It will be remembered as the default
4933
after the first use.
4936
takes_args = ['submit_branch?', 'public_branch?']
4940
_see_also = ['send']
4943
RegistryOption.from_kwargs('patch-type',
4944
'The type of patch to include in the directive.',
4946
value_switches=True,
4948
bundle='Bazaar revision bundle (default).',
4949
diff='Normal unified diff.',
4950
plain='No patch, just directive.'),
4951
Option('sign', help='GPG-sign the directive.'), 'revision',
4952
Option('mail-to', type=str,
4953
help='Instead of printing the directive, email to this address.'),
4954
Option('message', type=str, short_name='m',
4955
help='Message to use when committing this merge.')
4958
encoding_type = 'exact'
4960
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4961
sign=False, revision=None, mail_to=None, message=None):
4962
from bzrlib.revision import ensure_null, NULL_REVISION
4963
include_patch, include_bundle = {
4964
'plain': (False, False),
4965
'diff': (True, False),
4966
'bundle': (True, True),
4968
branch = Branch.open('.')
4969
stored_submit_branch = branch.get_submit_branch()
4970
if submit_branch is None:
4971
submit_branch = stored_submit_branch
4973
if stored_submit_branch is None:
4974
branch.set_submit_branch(submit_branch)
4975
if submit_branch is None:
4976
submit_branch = branch.get_parent()
4977
if submit_branch is None:
4978
raise errors.BzrCommandError('No submit branch specified or known')
4980
stored_public_branch = branch.get_public_branch()
4981
if public_branch is None:
4982
public_branch = stored_public_branch
4983
elif stored_public_branch is None:
4984
branch.set_public_branch(public_branch)
4985
if not include_bundle and public_branch is None:
4986
raise errors.BzrCommandError('No public branch specified or'
4988
base_revision_id = None
4989
if revision is not None:
4990
if len(revision) > 2:
4991
raise errors.BzrCommandError('bzr merge-directive takes '
4992
'at most two one revision identifiers')
4993
revision_id = revision[-1].as_revision_id(branch)
4994
if len(revision) == 2:
4995
base_revision_id = revision[0].as_revision_id(branch)
4997
revision_id = branch.last_revision()
4998
revision_id = ensure_null(revision_id)
4999
if revision_id == NULL_REVISION:
5000
raise errors.BzrCommandError('No revisions to bundle.')
5001
directive = merge_directive.MergeDirective2.from_objects(
5002
branch.repository, revision_id, time.time(),
5003
osutils.local_time_offset(), submit_branch,
5004
public_branch=public_branch, include_patch=include_patch,
5005
include_bundle=include_bundle, message=message,
5006
base_revision_id=base_revision_id)
5009
self.outf.write(directive.to_signed(branch))
5011
self.outf.writelines(directive.to_lines())
5013
message = directive.to_email(mail_to, branch, sign)
5014
s = SMTPConnection(branch.get_config())
5015
s.send_email(message)
5018
class cmd_send(Command):
5019
"""Mail or create a merge-directive for submitting changes.
5021
A merge directive provides many things needed for requesting merges:
5023
* A machine-readable description of the merge to perform
5025
* An optional patch that is a preview of the changes requested
5027
* An optional bundle of revision data, so that the changes can be applied
5028
directly from the merge directive, without retrieving data from a
5031
If --no-bundle is specified, then public_branch is needed (and must be
5032
up-to-date), so that the receiver can perform the merge using the
5033
public_branch. The public_branch is always included if known, so that
5034
people can check it later.
5036
The submit branch defaults to the parent, but can be overridden. Both
5037
submit branch and public branch will be remembered if supplied.
5039
If a public_branch is known for the submit_branch, that public submit
5040
branch is used in the merge instructions. This means that a local mirror
5041
can be used as your actual submit branch, once you have set public_branch
5044
Mail is sent using your preferred mail program. This should be transparent
5045
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5046
If the preferred client can't be found (or used), your editor will be used.
5048
To use a specific mail program, set the mail_client configuration option.
5049
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5050
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5051
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5052
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5055
If mail is being sent, a to address is required. This can be supplied
5056
either on the commandline, by setting the submit_to configuration
5057
option in the branch itself or the child_submit_to configuration option
5058
in the submit branch.
5060
Two formats are currently supported: "4" uses revision bundle format 4 and
5061
merge directive format 2. It is significantly faster and smaller than
5062
older formats. It is compatible with Bazaar 0.19 and later. It is the
5063
default. "0.9" uses revision bundle format 0.9 and merge directive
5064
format 1. It is compatible with Bazaar 0.12 - 0.18.
5066
The merge directives created by bzr send may be applied using bzr merge or
5067
bzr pull by specifying a file containing a merge directive as the location.
5070
encoding_type = 'exact'
5072
_see_also = ['merge', 'pull']
5074
takes_args = ['submit_branch?', 'public_branch?']
5078
help='Do not include a bundle in the merge directive.'),
5079
Option('no-patch', help='Do not include a preview patch in the merge'
5082
help='Remember submit and public branch.'),
5084
help='Branch to generate the submission from, '
5085
'rather than the one containing the working directory.',
5088
Option('output', short_name='o',
5089
help='Write merge directive to this file; '
5090
'use - for stdout.',
5093
help='Refuse to send if there are uncommitted changes in'
5094
' the working tree, --no-strict disables the check.'),
5095
Option('mail-to', help='Mail the request to this address.',
5099
Option('body', help='Body for the email.', type=unicode),
5100
RegistryOption('format',
5101
help='Use the specified output format.',
5102
lazy_registry=('bzrlib.send', 'format_registry')),
5105
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5106
no_patch=False, revision=None, remember=False, output=None,
5107
format=None, mail_to=None, message=None, body=None,
5108
strict=None, **kwargs):
5109
from bzrlib.send import send
5110
return send(submit_branch, revision, public_branch, remember,
5111
format, no_bundle, no_patch, output,
5112
kwargs.get('from', '.'), mail_to, message, body,
5117
class cmd_bundle_revisions(cmd_send):
5118
"""Create a merge-directive for submitting changes.
5120
A merge directive provides many things needed for requesting merges:
5122
* A machine-readable description of the merge to perform
5124
* An optional patch that is a preview of the changes requested
5126
* An optional bundle of revision data, so that the changes can be applied
5127
directly from the merge directive, without retrieving data from a
5130
If --no-bundle is specified, then public_branch is needed (and must be
5131
up-to-date), so that the receiver can perform the merge using the
5132
public_branch. The public_branch is always included if known, so that
5133
people can check it later.
5135
The submit branch defaults to the parent, but can be overridden. Both
5136
submit branch and public branch will be remembered if supplied.
5138
If a public_branch is known for the submit_branch, that public submit
5139
branch is used in the merge instructions. This means that a local mirror
5140
can be used as your actual submit branch, once you have set public_branch
5143
Two formats are currently supported: "4" uses revision bundle format 4 and
5144
merge directive format 2. It is significantly faster and smaller than
5145
older formats. It is compatible with Bazaar 0.19 and later. It is the
5146
default. "0.9" uses revision bundle format 0.9 and merge directive
5147
format 1. It is compatible with Bazaar 0.12 - 0.18.
5152
help='Do not include a bundle in the merge directive.'),
5153
Option('no-patch', help='Do not include a preview patch in the merge'
5156
help='Remember submit and public branch.'),
5158
help='Branch to generate the submission from, '
5159
'rather than the one containing the working directory.',
5162
Option('output', short_name='o', help='Write directive to this file.',
5165
help='Refuse to bundle revisions if there are uncommitted'
5166
' changes in the working tree, --no-strict disables the check.'),
5168
RegistryOption('format',
5169
help='Use the specified output format.',
5170
lazy_registry=('bzrlib.send', 'format_registry')),
5172
aliases = ['bundle']
5174
_see_also = ['send', 'merge']
5178
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5179
no_patch=False, revision=None, remember=False, output=None,
5180
format=None, strict=None, **kwargs):
5183
from bzrlib.send import send
5184
return send(submit_branch, revision, public_branch, remember,
5185
format, no_bundle, no_patch, output,
5186
kwargs.get('from', '.'), None, None, None,
5187
self.outf, strict=strict)
5190
class cmd_tag(Command):
5191
"""Create, remove or modify a tag naming a revision.
5193
Tags give human-meaningful names to revisions. Commands that take a -r
5194
(--revision) option can be given -rtag:X, where X is any previously
5197
Tags are stored in the branch. Tags are copied from one branch to another
5198
along when you branch, push, pull or merge.
5200
It is an error to give a tag name that already exists unless you pass
5201
--force, in which case the tag is moved to point to the new revision.
5203
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5204
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5207
_see_also = ['commit', 'tags']
5208
takes_args = ['tag_name']
5211
help='Delete this tag rather than placing it.',
5214
help='Branch in which to place the tag.',
5219
help='Replace existing tags.',
5224
def run(self, tag_name,
5230
branch, relpath = Branch.open_containing(directory)
5234
branch.tags.delete_tag(tag_name)
5235
self.outf.write('Deleted tag %s.\n' % tag_name)
5238
if len(revision) != 1:
5239
raise errors.BzrCommandError(
5240
"Tags can only be placed on a single revision, "
5242
revision_id = revision[0].as_revision_id(branch)
5244
revision_id = branch.last_revision()
5245
if (not force) and branch.tags.has_tag(tag_name):
5246
raise errors.TagAlreadyExists(tag_name)
5247
branch.tags.set_tag(tag_name, revision_id)
5248
self.outf.write('Created tag %s.\n' % tag_name)
5253
class cmd_tags(Command):
5256
This command shows a table of tag names and the revisions they reference.
5262
help='Branch whose tags should be displayed.',
5266
RegistryOption.from_kwargs('sort',
5267
'Sort tags by different criteria.', title='Sorting',
5268
alpha='Sort tags lexicographically (default).',
5269
time='Sort tags chronologically.',
5282
branch, relpath = Branch.open_containing(directory)
5284
tags = branch.tags.get_tag_dict().items()
5291
graph = branch.repository.get_graph()
5292
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5293
revid1, revid2 = rev1.rev_id, rev2.rev_id
5294
# only show revisions between revid1 and revid2 (inclusive)
5295
tags = [(tag, revid) for tag, revid in tags if
5296
graph.is_between(revid, revid1, revid2)]
5299
elif sort == 'time':
5301
for tag, revid in tags:
5303
revobj = branch.repository.get_revision(revid)
5304
except errors.NoSuchRevision:
5305
timestamp = sys.maxint # place them at the end
5307
timestamp = revobj.timestamp
5308
timestamps[revid] = timestamp
5309
tags.sort(key=lambda x: timestamps[x[1]])
5311
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5312
for index, (tag, revid) in enumerate(tags):
5314
revno = branch.revision_id_to_dotted_revno(revid)
5315
if isinstance(revno, tuple):
5316
revno = '.'.join(map(str, revno))
5317
except errors.NoSuchRevision:
5318
# Bad tag data/merges can lead to tagged revisions
5319
# which are not in this branch. Fail gracefully ...
5321
tags[index] = (tag, revno)
5324
for tag, revspec in tags:
5325
self.outf.write('%-20s %s\n' % (tag, revspec))
5328
class cmd_reconfigure(Command):
5329
"""Reconfigure the type of a bzr directory.
5331
A target configuration must be specified.
5333
For checkouts, the bind-to location will be auto-detected if not specified.
5334
The order of preference is
5335
1. For a lightweight checkout, the current bound location.
5336
2. For branches that used to be checkouts, the previously-bound location.
5337
3. The push location.
5338
4. The parent location.
5339
If none of these is available, --bind-to must be specified.
5342
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5343
takes_args = ['location?']
5345
RegistryOption.from_kwargs(
5347
title='Target type',
5348
help='The type to reconfigure the directory to.',
5349
value_switches=True, enum_switch=False,
5350
branch='Reconfigure to be an unbound branch with no working tree.',
5351
tree='Reconfigure to be an unbound branch with a working tree.',
5352
checkout='Reconfigure to be a bound branch with a working tree.',
5353
lightweight_checkout='Reconfigure to be a lightweight'
5354
' checkout (with no local history).',
5355
standalone='Reconfigure to be a standalone branch '
5356
'(i.e. stop using shared repository).',
5357
use_shared='Reconfigure to use a shared repository.',
5358
with_trees='Reconfigure repository to create '
5359
'working trees on branches by default.',
5360
with_no_trees='Reconfigure repository to not create '
5361
'working trees on branches by default.'
5363
Option('bind-to', help='Branch to bind checkout to.', type=str),
5365
help='Perform reconfiguration even if local changes'
5367
Option('stacked-on',
5368
help='Reconfigure a branch to be stacked on another branch.',
5372
help='Reconfigure a branch to be unstacked. This '
5373
'may require copying substantial data into it.',
5377
def run(self, location=None, target_type=None, bind_to=None, force=False,
5380
directory = bzrdir.BzrDir.open(location)
5381
if stacked_on and unstacked:
5382
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5383
elif stacked_on is not None:
5384
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5386
reconfigure.ReconfigureUnstacked().apply(directory)
5387
# At the moment you can use --stacked-on and a different
5388
# reconfiguration shape at the same time; there seems no good reason
5390
if target_type is None:
5391
if stacked_on or unstacked:
5394
raise errors.BzrCommandError('No target configuration '
5396
elif target_type == 'branch':
5397
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5398
elif target_type == 'tree':
5399
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5400
elif target_type == 'checkout':
5401
reconfiguration = reconfigure.Reconfigure.to_checkout(
5403
elif target_type == 'lightweight-checkout':
5404
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5406
elif target_type == 'use-shared':
5407
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5408
elif target_type == 'standalone':
5409
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5410
elif target_type == 'with-trees':
5411
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5413
elif target_type == 'with-no-trees':
5414
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5416
reconfiguration.apply(force)
5419
class cmd_switch(Command):
5420
"""Set the branch of a checkout and update.
5422
For lightweight checkouts, this changes the branch being referenced.
5423
For heavyweight checkouts, this checks that there are no local commits
5424
versus the current bound branch, then it makes the local branch a mirror
5425
of the new location and binds to it.
5427
In both cases, the working tree is updated and uncommitted changes
5428
are merged. The user can commit or revert these as they desire.
5430
Pending merges need to be committed or reverted before using switch.
5432
The path to the branch to switch to can be specified relative to the parent
5433
directory of the current branch. For example, if you are currently in a
5434
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5437
Bound branches use the nickname of its master branch unless it is set
5438
locally, in which case switching will update the local nickname to be
5442
takes_args = ['to_location']
5443
takes_options = [Option('force',
5444
help='Switch even if local commits will be lost.'),
5445
Option('create-branch', short_name='b',
5446
help='Create the target branch from this one before'
5447
' switching to it.'),
5450
def run(self, to_location, force=False, create_branch=False):
5451
from bzrlib import switch
5453
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5455
branch = control_dir.open_branch()
5456
had_explicit_nick = branch.get_config().has_explicit_nickname()
5457
except errors.NotBranchError:
5459
had_explicit_nick = False
5462
raise errors.BzrCommandError('cannot create branch without'
5464
if '/' not in to_location and '\\' not in to_location:
5465
# This path is meant to be relative to the existing branch
5466
this_url = self._get_branch_location(control_dir)
5467
to_location = urlutils.join(this_url, '..', to_location)
5468
to_branch = branch.bzrdir.sprout(to_location,
5469
possible_transports=[branch.bzrdir.root_transport],
5470
source_branch=branch).open_branch()
5472
# from_branch = control_dir.open_branch()
5473
# except errors.NotBranchError:
5474
# raise BzrCommandError('Cannot create a branch from this'
5475
# ' location when we cannot open this branch')
5476
# from_branch.bzrdir.sprout(
5480
to_branch = Branch.open(to_location)
5481
except errors.NotBranchError:
5482
this_url = self._get_branch_location(control_dir)
5483
to_branch = Branch.open(
5484
urlutils.join(this_url, '..', to_location))
5485
switch.switch(control_dir, to_branch, force)
5486
if had_explicit_nick:
5487
branch = control_dir.open_branch() #get the new branch!
5488
branch.nick = to_branch.nick
5489
note('Switched to branch: %s',
5490
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5492
def _get_branch_location(self, control_dir):
5493
"""Return location of branch for this control dir."""
5495
this_branch = control_dir.open_branch()
5496
# This may be a heavy checkout, where we want the master branch
5497
master_location = this_branch.get_bound_location()
5498
if master_location is not None:
5499
return master_location
5500
# If not, use a local sibling
5501
return this_branch.base
5502
except errors.NotBranchError:
5503
format = control_dir.find_branch_format()
5504
if getattr(format, 'get_reference', None) is not None:
5505
return format.get_reference(control_dir)
5507
return control_dir.root_transport.base
5510
class cmd_view(Command):
5511
"""Manage filtered views.
5513
Views provide a mask over the tree so that users can focus on
5514
a subset of a tree when doing their work. After creating a view,
5515
commands that support a list of files - status, diff, commit, etc -
5516
effectively have that list of files implicitly given each time.
5517
An explicit list of files can still be given but those files
5518
must be within the current view.
5520
In most cases, a view has a short life-span: it is created to make
5521
a selected change and is deleted once that change is committed.
5522
At other times, you may wish to create one or more named views
5523
and switch between them.
5525
To disable the current view without deleting it, you can switch to
5526
the pseudo view called ``off``. This can be useful when you need
5527
to see the whole tree for an operation or two (e.g. merge) but
5528
want to switch back to your view after that.
5531
To define the current view::
5533
bzr view file1 dir1 ...
5535
To list the current view::
5539
To delete the current view::
5543
To disable the current view without deleting it::
5545
bzr view --switch off
5547
To define a named view and switch to it::
5549
bzr view --name view-name file1 dir1 ...
5551
To list a named view::
5553
bzr view --name view-name
5555
To delete a named view::
5557
bzr view --name view-name --delete
5559
To switch to a named view::
5561
bzr view --switch view-name
5563
To list all views defined::
5567
To delete all views::
5569
bzr view --delete --all
5573
takes_args = ['file*']
5576
help='Apply list or delete action to all views.',
5579
help='Delete the view.',
5582
help='Name of the view to define, list or delete.',
5586
help='Name of the view to switch to.',
5591
def run(self, file_list,
5597
tree, file_list = tree_files(file_list, apply_view=False)
5598
current_view, view_dict = tree.views.get_view_info()
5603
raise errors.BzrCommandError(
5604
"Both --delete and a file list specified")
5606
raise errors.BzrCommandError(
5607
"Both --delete and --switch specified")
5609
tree.views.set_view_info(None, {})
5610
self.outf.write("Deleted all views.\n")
5612
raise errors.BzrCommandError("No current view to delete")
5614
tree.views.delete_view(name)
5615
self.outf.write("Deleted '%s' view.\n" % name)
5618
raise errors.BzrCommandError(
5619
"Both --switch and a file list specified")
5621
raise errors.BzrCommandError(
5622
"Both --switch and --all specified")
5623
elif switch == 'off':
5624
if current_view is None:
5625
raise errors.BzrCommandError("No current view to disable")
5626
tree.views.set_view_info(None, view_dict)
5627
self.outf.write("Disabled '%s' view.\n" % (current_view))
5629
tree.views.set_view_info(switch, view_dict)
5630
view_str = views.view_display_str(tree.views.lookup_view())
5631
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5634
self.outf.write('Views defined:\n')
5635
for view in sorted(view_dict):
5636
if view == current_view:
5640
view_str = views.view_display_str(view_dict[view])
5641
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5643
self.outf.write('No views defined.\n')
5646
# No name given and no current view set
5649
raise errors.BzrCommandError(
5650
"Cannot change the 'off' pseudo view")
5651
tree.views.set_view(name, sorted(file_list))
5652
view_str = views.view_display_str(tree.views.lookup_view())
5653
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5657
# No name given and no current view set
5658
self.outf.write('No current view.\n')
5660
view_str = views.view_display_str(tree.views.lookup_view(name))
5661
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5664
class cmd_hooks(Command):
5670
for hook_key in sorted(hooks.known_hooks.keys()):
5671
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5672
self.outf.write("%s:\n" % type(some_hooks).__name__)
5673
for hook_name, hook_point in sorted(some_hooks.items()):
5674
self.outf.write(" %s:\n" % (hook_name,))
5675
found_hooks = list(hook_point)
5677
for hook in found_hooks:
5678
self.outf.write(" %s\n" %
5679
(some_hooks.get_hook_name(hook),))
5681
self.outf.write(" <no hooks installed>\n")
5684
class cmd_shelve(Command):
5685
"""Temporarily set aside some changes from the current tree.
5687
Shelve allows you to temporarily put changes you've made "on the shelf",
5688
ie. out of the way, until a later time when you can bring them back from
5689
the shelf with the 'unshelve' command. The changes are stored alongside
5690
your working tree, and so they aren't propagated along with your branch nor
5691
will they survive its deletion.
5693
If shelve --list is specified, previously-shelved changes are listed.
5695
Shelve is intended to help separate several sets of changes that have
5696
been inappropriately mingled. If you just want to get rid of all changes
5697
and you don't need to restore them later, use revert. If you want to
5698
shelve all text changes at once, use shelve --all.
5700
If filenames are specified, only the changes to those files will be
5701
shelved. Other files will be left untouched.
5703
If a revision is specified, changes since that revision will be shelved.
5705
You can put multiple items on the shelf, and by default, 'unshelve' will
5706
restore the most recently shelved changes.
5709
takes_args = ['file*']
5713
Option('all', help='Shelve all changes.'),
5715
RegistryOption('writer', 'Method to use for writing diffs.',
5716
bzrlib.option.diff_writer_registry,
5717
value_switches=True, enum_switch=False),
5719
Option('list', help='List shelved changes.'),
5721
help='Destroy removed changes instead of shelving them.'),
5723
_see_also = ['unshelve']
5725
def run(self, revision=None, all=False, file_list=None, message=None,
5726
writer=None, list=False, destroy=False):
5728
return self.run_for_list()
5729
from bzrlib.shelf_ui import Shelver
5731
writer = bzrlib.option.diff_writer_registry.get()
5733
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5734
file_list, message, destroy=destroy)
5739
except errors.UserAbort:
5742
def run_for_list(self):
5743
tree = WorkingTree.open_containing('.')[0]
5746
manager = tree.get_shelf_manager()
5747
shelves = manager.active_shelves()
5748
if len(shelves) == 0:
5749
note('No shelved changes.')
5751
for shelf_id in reversed(shelves):
5752
message = manager.get_metadata(shelf_id).get('message')
5754
message = '<no message>'
5755
self.outf.write('%3d: %s\n' % (shelf_id, message))
5761
class cmd_unshelve(Command):
5762
"""Restore shelved changes.
5764
By default, the most recently shelved changes are restored. However if you
5765
specify a shelf by id those changes will be restored instead. This works
5766
best when the changes don't depend on each other.
5769
takes_args = ['shelf_id?']
5771
RegistryOption.from_kwargs(
5772
'action', help="The action to perform.",
5773
enum_switch=False, value_switches=True,
5774
apply="Apply changes and remove from the shelf.",
5775
dry_run="Show changes, but do not apply or remove them.",
5776
delete_only="Delete changes without applying them."
5779
_see_also = ['shelve']
5781
def run(self, shelf_id=None, action='apply'):
5782
from bzrlib.shelf_ui import Unshelver
5783
unshelver = Unshelver.from_args(shelf_id, action)
5787
unshelver.tree.unlock()
5790
class cmd_clean_tree(Command):
5791
"""Remove unwanted files from working tree.
5793
By default, only unknown files, not ignored files, are deleted. Versioned
5794
files are never deleted.
5796
Another class is 'detritus', which includes files emitted by bzr during
5797
normal operations and selftests. (The value of these files decreases with
5800
If no options are specified, unknown files are deleted. Otherwise, option
5801
flags are respected, and may be combined.
5803
To check what clean-tree will do, use --dry-run.
5805
takes_options = [Option('ignored', help='Delete all ignored files.'),
5806
Option('detritus', help='Delete conflict files, merge'
5807
' backups, and failed selftest dirs.'),
5809
help='Delete files unknown to bzr (default).'),
5810
Option('dry-run', help='Show files to delete instead of'
5812
Option('force', help='Do not prompt before deleting.')]
5813
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5815
from bzrlib.clean_tree import clean_tree
5816
if not (unknown or ignored or detritus):
5820
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5821
dry_run=dry_run, no_prompt=force)
5824
class cmd_reference(Command):
5825
"""list, view and set branch locations for nested trees.
5827
If no arguments are provided, lists the branch locations for nested trees.
5828
If one argument is provided, display the branch location for that tree.
5829
If two arguments are provided, set the branch location for that tree.
5834
takes_args = ['path?', 'location?']
5836
def run(self, path=None, location=None):
5838
if path is not None:
5840
tree, branch, relpath =(
5841
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5842
if path is not None:
5845
tree = branch.basis_tree()
5847
info = branch._get_all_reference_info().iteritems()
5848
self._display_reference_info(tree, branch, info)
5850
file_id = tree.path2id(path)
5852
raise errors.NotVersionedError(path)
5853
if location is None:
5854
info = [(file_id, branch.get_reference_info(file_id))]
5855
self._display_reference_info(tree, branch, info)
5857
branch.set_reference_info(file_id, path, location)
5859
def _display_reference_info(self, tree, branch, info):
5861
for file_id, (path, location) in info:
5863
path = tree.id2path(file_id)
5864
except errors.NoSuchId:
5866
ref_list.append((path, location))
5867
for path, location in sorted(ref_list):
5868
self.outf.write('%s %s\n' % (path, location))
5871
# these get imported and then picked up by the scan for cmd_*
5872
# TODO: Some more consistent way to split command definitions across files;
5873
# we do need to load at least some information about them to know of
5874
# aliases. ideally we would avoid loading the implementation until the
5875
# details were needed.
5876
from bzrlib.cmd_version_info import cmd_version_info
5877
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5878
from bzrlib.bundle.commands import (
5881
from bzrlib.foreign import cmd_dpush
5882
from bzrlib.sign_my_commits import cmd_sign_my_commits
5883
from bzrlib.weave_commands import cmd_versionedfile_list, \
5884
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
