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
revision = _get_one_revision('branch', revision)
1213
if revision is not None:
1214
revision_id = revision.as_revision_id(br_from)
1216
# FIXME - wt.last_revision, fallback to branch, fall back to
1217
# None or perhaps NULL_REVISION to mean copy nothing
1219
revision_id = br_from.last_revision()
1220
if to_location is None:
1221
to_location = urlutils.derive_to_location(from_location)
1222
to_transport = transport.get_transport(to_location)
1224
to_transport.mkdir('.')
1225
except errors.FileExists:
1226
if not use_existing_dir:
1227
raise errors.BzrCommandError('Target directory "%s" '
1228
'already exists.' % to_location)
1231
bzrdir.BzrDir.open_from_transport(to_transport)
1232
except errors.NotBranchError:
1235
raise errors.AlreadyBranchError(to_location)
1236
except errors.NoSuchFile:
1237
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1240
# preserve whatever source format we have.
1241
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1242
possible_transports=[to_transport],
1243
accelerator_tree=accelerator_tree,
1244
hardlink=hardlink, stacked=stacked,
1245
force_new_repo=standalone,
1246
create_tree_if_local=not no_tree,
1247
source_branch=br_from)
1248
branch = dir.open_branch()
1249
except errors.NoSuchRevision:
1250
to_transport.delete_tree('.')
1251
msg = "The branch %s has no revision %s." % (from_location,
1253
raise errors.BzrCommandError(msg)
1254
_merge_tags_if_possible(br_from, branch)
1255
# If the source branch is stacked, the new branch may
1256
# be stacked whether we asked for that explicitly or not.
1257
# We therefore need a try/except here and not just 'if stacked:'
1259
note('Created new stacked branch referring to %s.' %
1260
branch.get_stacked_on_url())
1261
except (errors.NotStacked, errors.UnstackableBranchFormat,
1262
errors.UnstackableRepositoryFormat), e:
1263
note('Branched %d revision(s).' % branch.revno())
1265
# Switch to the new branch
1266
wt, _ = WorkingTree.open_containing('.')
1267
_mod_switch.switch(wt.bzrdir, branch)
1268
note('Switched to branch: %s',
1269
urlutils.unescape_for_display(branch.base, 'utf-8'))
1274
class cmd_checkout(Command):
1275
"""Create a new checkout of an existing branch.
1277
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1278
the branch found in '.'. This is useful if you have removed the working tree
1279
or if it was never created - i.e. if you pushed the branch to its current
1280
location using SFTP.
1282
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1283
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1284
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1285
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1286
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1289
To retrieve the branch as of a particular revision, supply the --revision
1290
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1291
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1295
_see_also = ['checkouts', 'branch']
1296
takes_args = ['branch_location?', 'to_location?']
1297
takes_options = ['revision',
1298
Option('lightweight',
1299
help="Perform a lightweight checkout. Lightweight "
1300
"checkouts depend on access to the branch for "
1301
"every operation. Normal checkouts can perform "
1302
"common operations like diff and status without "
1303
"such access, and also support local commits."
1305
Option('files-from', type=str,
1306
help="Get file contents from this tree."),
1308
help='Hard-link working tree files where possible.'
1313
def run(self, branch_location=None, to_location=None, revision=None,
1314
lightweight=False, files_from=None, hardlink=False):
1315
if branch_location is None:
1316
branch_location = osutils.getcwd()
1317
to_location = branch_location
1318
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1320
revision = _get_one_revision('checkout', revision)
1321
if files_from is not None:
1322
accelerator_tree = WorkingTree.open(files_from)
1323
if revision is not None:
1324
revision_id = revision.as_revision_id(source)
1327
if to_location is None:
1328
to_location = urlutils.derive_to_location(branch_location)
1329
# if the source and to_location are the same,
1330
# and there is no working tree,
1331
# then reconstitute a branch
1332
if (osutils.abspath(to_location) ==
1333
osutils.abspath(branch_location)):
1335
source.bzrdir.open_workingtree()
1336
except errors.NoWorkingTree:
1337
source.bzrdir.create_workingtree(revision_id)
1339
source.create_checkout(to_location, revision_id, lightweight,
1340
accelerator_tree, hardlink)
1343
class cmd_renames(Command):
1344
"""Show list of renamed files.
1346
# TODO: Option to show renames between two historical versions.
1348
# TODO: Only show renames under dir, rather than in the whole branch.
1349
_see_also = ['status']
1350
takes_args = ['dir?']
1353
def run(self, dir=u'.'):
1354
tree = WorkingTree.open_containing(dir)[0]
1357
new_inv = tree.inventory
1358
old_tree = tree.basis_tree()
1359
old_tree.lock_read()
1361
old_inv = old_tree.inventory
1363
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1364
for f, paths, c, v, p, n, k, e in iterator:
1365
if paths[0] == paths[1]:
1369
renames.append(paths)
1371
for old_name, new_name in renames:
1372
self.outf.write("%s => %s\n" % (old_name, new_name))
1379
class cmd_update(Command):
1380
"""Update a tree to have the latest code committed to its branch.
1382
This will perform a merge into the working tree, and may generate
1383
conflicts. If you have any local changes, you will still
1384
need to commit them after the update for the update to be complete.
1386
If you want to discard your local changes, you can just do a
1387
'bzr revert' instead of 'bzr commit' after the update.
1390
_see_also = ['pull', 'working-trees', 'status-flags']
1391
takes_args = ['dir?']
1394
def run(self, dir='.'):
1395
tree = WorkingTree.open_containing(dir)[0]
1396
possible_transports = []
1397
master = tree.branch.get_master_branch(
1398
possible_transports=possible_transports)
1399
if master is not None:
1402
tree.lock_tree_write()
1404
existing_pending_merges = tree.get_parent_ids()[1:]
1405
last_rev = _mod_revision.ensure_null(tree.last_revision())
1406
if last_rev == _mod_revision.ensure_null(
1407
tree.branch.last_revision()):
1408
# may be up to date, check master too.
1409
if master is None or last_rev == _mod_revision.ensure_null(
1410
master.last_revision()):
1411
revno = tree.branch.revision_id_to_revno(last_rev)
1412
note("Tree is up to date at revision %d." % (revno,))
1414
view_info = _get_view_info_for_change_reporter(tree)
1415
conflicts = tree.update(
1416
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1417
view_info=view_info), possible_transports=possible_transports)
1418
revno = tree.branch.revision_id_to_revno(
1419
_mod_revision.ensure_null(tree.last_revision()))
1420
note('Updated to revision %d.' % (revno,))
1421
if tree.get_parent_ids()[1:] != existing_pending_merges:
1422
note('Your local commits will now show as pending merges with '
1423
"'bzr status', and can be committed with 'bzr commit'.")
1432
class cmd_info(Command):
1433
"""Show information about a working tree, branch or repository.
1435
This command will show all known locations and formats associated to the
1436
tree, branch or repository.
1438
In verbose mode, statistical information is included with each report.
1439
To see extended statistic information, use a verbosity level of 2 or
1440
higher by specifying the verbose option multiple times, e.g. -vv.
1442
Branches and working trees will also report any missing revisions.
1446
Display information on the format and related locations:
1450
Display the above together with extended format information and
1451
basic statistics (like the number of files in the working tree and
1452
number of revisions in the branch and repository):
1456
Display the above together with number of committers to the branch:
1460
_see_also = ['revno', 'working-trees', 'repositories']
1461
takes_args = ['location?']
1462
takes_options = ['verbose']
1463
encoding_type = 'replace'
1466
def run(self, location=None, verbose=False):
1468
noise_level = get_verbosity_level()
1471
from bzrlib.info import show_bzrdir_info
1472
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1473
verbose=noise_level, outfile=self.outf)
1476
class cmd_remove(Command):
1477
"""Remove files or directories.
1479
This makes bzr stop tracking changes to the specified files. bzr will delete
1480
them if they can easily be recovered using revert. If no options or
1481
parameters are given bzr will scan for files that are being tracked by bzr
1482
but missing in your tree and stop tracking them for you.
1484
takes_args = ['file*']
1485
takes_options = ['verbose',
1486
Option('new', help='Only remove files that have never been committed.'),
1487
RegistryOption.from_kwargs('file-deletion-strategy',
1488
'The file deletion mode to be used.',
1489
title='Deletion Strategy', value_switches=True, enum_switch=False,
1490
safe='Only delete files if they can be'
1491
' safely recovered (default).',
1492
keep='Delete from bzr but leave the working copy.',
1493
force='Delete all the specified files, even if they can not be '
1494
'recovered and even if they are non-empty directories.')]
1495
aliases = ['rm', 'del']
1496
encoding_type = 'replace'
1498
def run(self, file_list, verbose=False, new=False,
1499
file_deletion_strategy='safe'):
1500
tree, file_list = tree_files(file_list)
1502
if file_list is not None:
1503
file_list = [f for f in file_list]
1507
# Heuristics should probably all move into tree.remove_smart or
1510
added = tree.changes_from(tree.basis_tree(),
1511
specific_files=file_list).added
1512
file_list = sorted([f[0] for f in added], reverse=True)
1513
if len(file_list) == 0:
1514
raise errors.BzrCommandError('No matching files.')
1515
elif file_list is None:
1516
# missing files show up in iter_changes(basis) as
1517
# versioned-with-no-kind.
1519
for change in tree.iter_changes(tree.basis_tree()):
1520
# Find paths in the working tree that have no kind:
1521
if change[1][1] is not None and change[6][1] is None:
1522
missing.append(change[1][1])
1523
file_list = sorted(missing, reverse=True)
1524
file_deletion_strategy = 'keep'
1525
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1526
keep_files=file_deletion_strategy=='keep',
1527
force=file_deletion_strategy=='force')
1532
class cmd_file_id(Command):
1533
"""Print file_id of a particular file or directory.
1535
The file_id is assigned when the file is first added and remains the
1536
same through all revisions where the file exists, even when it is
1541
_see_also = ['inventory', 'ls']
1542
takes_args = ['filename']
1545
def run(self, filename):
1546
tree, relpath = WorkingTree.open_containing(filename)
1547
i = tree.path2id(relpath)
1549
raise errors.NotVersionedError(filename)
1551
self.outf.write(i + '\n')
1554
class cmd_file_path(Command):
1555
"""Print path of file_ids to a file or directory.
1557
This prints one line for each directory down to the target,
1558
starting at the branch root.
1562
takes_args = ['filename']
1565
def run(self, filename):
1566
tree, relpath = WorkingTree.open_containing(filename)
1567
fid = tree.path2id(relpath)
1569
raise errors.NotVersionedError(filename)
1570
segments = osutils.splitpath(relpath)
1571
for pos in range(1, len(segments) + 1):
1572
path = osutils.joinpath(segments[:pos])
1573
self.outf.write("%s\n" % tree.path2id(path))
1576
class cmd_reconcile(Command):
1577
"""Reconcile bzr metadata in a branch.
1579
This can correct data mismatches that may have been caused by
1580
previous ghost operations or bzr upgrades. You should only
1581
need to run this command if 'bzr check' or a bzr developer
1582
advises you to run it.
1584
If a second branch is provided, cross-branch reconciliation is
1585
also attempted, which will check that data like the tree root
1586
id which was not present in very early bzr versions is represented
1587
correctly in both branches.
1589
At the same time it is run it may recompress data resulting in
1590
a potential saving in disk space or performance gain.
1592
The branch *MUST* be on a listable system such as local disk or sftp.
1595
_see_also = ['check']
1596
takes_args = ['branch?']
1598
def run(self, branch="."):
1599
from bzrlib.reconcile import reconcile
1600
dir = bzrdir.BzrDir.open(branch)
1604
class cmd_revision_history(Command):
1605
"""Display the list of revision ids on a branch."""
1608
takes_args = ['location?']
1613
def run(self, location="."):
1614
branch = Branch.open_containing(location)[0]
1615
for revid in branch.revision_history():
1616
self.outf.write(revid)
1617
self.outf.write('\n')
1620
class cmd_ancestry(Command):
1621
"""List all revisions merged into this branch."""
1623
_see_also = ['log', 'revision-history']
1624
takes_args = ['location?']
1629
def run(self, location="."):
1631
wt = WorkingTree.open_containing(location)[0]
1632
except errors.NoWorkingTree:
1633
b = Branch.open(location)
1634
last_revision = b.last_revision()
1637
last_revision = wt.last_revision()
1639
revision_ids = b.repository.get_ancestry(last_revision)
1641
for revision_id in revision_ids:
1642
self.outf.write(revision_id + '\n')
1645
class cmd_init(Command):
1646
"""Make a directory into a versioned branch.
1648
Use this to create an empty branch, or before importing an
1651
If there is a repository in a parent directory of the location, then
1652
the history of the branch will be stored in the repository. Otherwise
1653
init creates a standalone branch which carries its own history
1654
in the .bzr directory.
1656
If there is already a branch at the location but it has no working tree,
1657
the tree can be populated with 'bzr checkout'.
1659
Recipe for importing a tree of files::
1665
bzr commit -m "imported project"
1668
_see_also = ['init-repository', 'branch', 'checkout']
1669
takes_args = ['location?']
1671
Option('create-prefix',
1672
help='Create the path leading up to the branch '
1673
'if it does not already exist.'),
1674
RegistryOption('format',
1675
help='Specify a format for this branch. '
1676
'See "help formats".',
1677
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1678
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1679
value_switches=True,
1680
title="Branch format",
1682
Option('append-revisions-only',
1683
help='Never change revnos or the existing log.'
1684
' Append revisions to it only.')
1686
def run(self, location=None, format=None, append_revisions_only=False,
1687
create_prefix=False):
1689
format = bzrdir.format_registry.make_bzrdir('default')
1690
if location is None:
1693
to_transport = transport.get_transport(location)
1695
# The path has to exist to initialize a
1696
# branch inside of it.
1697
# Just using os.mkdir, since I don't
1698
# believe that we want to create a bunch of
1699
# locations if the user supplies an extended path
1701
to_transport.ensure_base()
1702
except errors.NoSuchFile:
1703
if not create_prefix:
1704
raise errors.BzrCommandError("Parent directory of %s"
1706
"\nYou may supply --create-prefix to create all"
1707
" leading parent directories."
1709
to_transport.create_prefix()
1712
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1713
except errors.NotBranchError:
1714
# really a NotBzrDir error...
1715
create_branch = bzrdir.BzrDir.create_branch_convenience
1716
branch = create_branch(to_transport.base, format=format,
1717
possible_transports=[to_transport])
1718
a_bzrdir = branch.bzrdir
1720
from bzrlib.transport.local import LocalTransport
1721
if a_bzrdir.has_branch():
1722
if (isinstance(to_transport, LocalTransport)
1723
and not a_bzrdir.has_workingtree()):
1724
raise errors.BranchExistsWithoutWorkingTree(location)
1725
raise errors.AlreadyBranchError(location)
1726
branch = a_bzrdir.create_branch()
1727
a_bzrdir.create_workingtree()
1728
if append_revisions_only:
1730
branch.set_append_revisions_only(True)
1731
except errors.UpgradeRequired:
1732
raise errors.BzrCommandError('This branch format cannot be set'
1733
' to append-revisions-only. Try --default.')
1735
from bzrlib.info import describe_layout, describe_format
1737
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1738
except (errors.NoWorkingTree, errors.NotLocalUrl):
1740
repository = branch.repository
1741
layout = describe_layout(repository, branch, tree).lower()
1742
format = describe_format(a_bzrdir, repository, branch, tree)
1743
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1744
if repository.is_shared():
1745
#XXX: maybe this can be refactored into transport.path_or_url()
1746
url = repository.bzrdir.root_transport.external_url()
1748
url = urlutils.local_path_from_url(url)
1749
except errors.InvalidURL:
1751
self.outf.write("Using shared repository: %s\n" % url)
1754
class cmd_init_repository(Command):
1755
"""Create a shared repository for branches to share storage space.
1757
New branches created under the repository directory will store their
1758
revisions in the repository, not in the branch directory. For branches
1759
with shared history, this reduces the amount of storage needed and
1760
speeds up the creation of new branches.
1762
If the --no-trees option is given then the branches in the repository
1763
will not have working trees by default. They will still exist as
1764
directories on disk, but they will not have separate copies of the
1765
files at a certain revision. This can be useful for repositories that
1766
store branches which are interacted with through checkouts or remote
1767
branches, such as on a server.
1770
Create a shared repository holding just branches::
1772
bzr init-repo --no-trees repo
1775
Make a lightweight checkout elsewhere::
1777
bzr checkout --lightweight repo/trunk trunk-checkout
1782
_see_also = ['init', 'branch', 'checkout', 'repositories']
1783
takes_args = ["location"]
1784
takes_options = [RegistryOption('format',
1785
help='Specify a format for this repository. See'
1786
' "bzr help formats" for details.',
1787
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1788
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1789
value_switches=True, title='Repository format'),
1791
help='Branches in the repository will default to'
1792
' not having a working tree.'),
1794
aliases = ["init-repo"]
1796
def run(self, location, format=None, no_trees=False):
1798
format = bzrdir.format_registry.make_bzrdir('default')
1800
if location is None:
1803
to_transport = transport.get_transport(location)
1804
to_transport.ensure_base()
1806
newdir = format.initialize_on_transport(to_transport)
1807
repo = newdir.create_repository(shared=True)
1808
repo.set_make_working_trees(not no_trees)
1810
from bzrlib.info import show_bzrdir_info
1811
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1814
class cmd_diff(Command):
1815
"""Show differences in the working tree, between revisions or branches.
1817
If no arguments are given, all changes for the current tree are listed.
1818
If files are given, only the changes in those files are listed.
1819
Remote and multiple branches can be compared by using the --old and
1820
--new options. If not provided, the default for both is derived from
1821
the first argument, if any, or the current tree if no arguments are
1824
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1825
produces patches suitable for "patch -p1".
1829
2 - unrepresentable changes
1834
Shows the difference in the working tree versus the last commit::
1838
Difference between the working tree and revision 1::
1842
Difference between revision 3 and revision 1::
1846
Difference between revision 3 and revision 1 for branch xxx::
1850
To see the changes introduced in revision X::
1854
Note that in the case of a merge, the -c option shows the changes
1855
compared to the left hand parent. To see the changes against
1856
another parent, use::
1858
bzr diff -r<chosen_parent>..X
1860
The changes introduced by revision 2 (equivalent to -r1..2)::
1864
Show just the differences for file NEWS::
1868
Show the differences in working tree xxx for file NEWS::
1872
Show the differences from branch xxx to this working tree:
1876
Show the differences between two branches for file NEWS::
1878
bzr diff --old xxx --new yyy NEWS
1880
Same as 'bzr diff' but prefix paths with old/ and new/::
1882
bzr diff --prefix old/:new/
1884
_see_also = ['status']
1885
takes_args = ['file*']
1887
Option('diff-options', type=str,
1888
help='Pass these options to the external diff program.'),
1889
Option('prefix', type=str,
1891
help='Set prefixes added to old and new filenames, as '
1892
'two values separated by a colon. (eg "old/:new/").'),
1894
help='Branch/tree to compare from.',
1898
help='Branch/tree to compare to.',
1904
help='Use this command to compare files.',
1908
aliases = ['di', 'dif']
1909
encoding_type = 'exact'
1912
def run(self, revision=None, file_list=None, diff_options=None,
1913
prefix=None, old=None, new=None, using=None):
1914
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1916
if (prefix is None) or (prefix == '0'):
1924
old_label, new_label = prefix.split(":")
1926
raise errors.BzrCommandError(
1927
'--prefix expects two values separated by a colon'
1928
' (eg "old/:new/")')
1930
if revision and len(revision) > 2:
1931
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1932
' one or two revision specifiers')
1934
(old_tree, new_tree,
1935
old_branch, new_branch,
1936
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1937
file_list, revision, old, new, apply_view=True)
1938
return show_diff_trees(old_tree, new_tree, sys.stdout,
1939
specific_files=specific_files,
1940
external_diff_options=diff_options,
1941
old_label=old_label, new_label=new_label,
1942
extra_trees=extra_trees, using=using)
1945
class cmd_deleted(Command):
1946
"""List files deleted in the working tree.
1948
# TODO: Show files deleted since a previous revision, or
1949
# between two revisions.
1950
# TODO: Much more efficient way to do this: read in new
1951
# directories with readdir, rather than stating each one. Same
1952
# level of effort but possibly much less IO. (Or possibly not,
1953
# if the directories are very large...)
1954
_see_also = ['status', 'ls']
1955
takes_options = ['show-ids']
1958
def run(self, show_ids=False):
1959
tree = WorkingTree.open_containing(u'.')[0]
1962
old = tree.basis_tree()
1965
for path, ie in old.inventory.iter_entries():
1966
if not tree.has_id(ie.file_id):
1967
self.outf.write(path)
1969
self.outf.write(' ')
1970
self.outf.write(ie.file_id)
1971
self.outf.write('\n')
1978
class cmd_modified(Command):
1979
"""List files modified in working tree.
1983
_see_also = ['status', 'ls']
1986
help='Write an ascii NUL (\\0) separator '
1987
'between files rather than a newline.')
1991
def run(self, null=False):
1992
tree = WorkingTree.open_containing(u'.')[0]
1993
td = tree.changes_from(tree.basis_tree())
1994
for path, id, kind, text_modified, meta_modified in td.modified:
1996
self.outf.write(path + '\0')
1998
self.outf.write(osutils.quotefn(path) + '\n')
2001
class cmd_added(Command):
2002
"""List files added in working tree.
2006
_see_also = ['status', 'ls']
2009
help='Write an ascii NUL (\\0) separator '
2010
'between files rather than a newline.')
2014
def run(self, null=False):
2015
wt = WorkingTree.open_containing(u'.')[0]
2018
basis = wt.basis_tree()
2021
basis_inv = basis.inventory
2024
if file_id in basis_inv:
2026
if inv.is_root(file_id) and len(basis_inv) == 0:
2028
path = inv.id2path(file_id)
2029
if not os.access(osutils.abspath(path), os.F_OK):
2032
self.outf.write(path + '\0')
2034
self.outf.write(osutils.quotefn(path) + '\n')
2041
class cmd_root(Command):
2042
"""Show the tree root directory.
2044
The root is the nearest enclosing directory with a .bzr control
2047
takes_args = ['filename?']
2049
def run(self, filename=None):
2050
"""Print the branch root."""
2051
tree = WorkingTree.open_containing(filename)[0]
2052
self.outf.write(tree.basedir + '\n')
2055
def _parse_limit(limitstring):
2057
return int(limitstring)
2059
msg = "The limit argument must be an integer."
2060
raise errors.BzrCommandError(msg)
2063
def _parse_levels(s):
2067
msg = "The levels argument must be an integer."
2068
raise errors.BzrCommandError(msg)
2071
class cmd_log(Command):
2072
"""Show historical log for a branch or subset of a branch.
2074
log is bzr's default tool for exploring the history of a branch.
2075
The branch to use is taken from the first parameter. If no parameters
2076
are given, the branch containing the working directory is logged.
2077
Here are some simple examples::
2079
bzr log log the current branch
2080
bzr log foo.py log a file in its branch
2081
bzr log http://server/branch log a branch on a server
2083
The filtering, ordering and information shown for each revision can
2084
be controlled as explained below. By default, all revisions are
2085
shown sorted (topologically) so that newer revisions appear before
2086
older ones and descendants always appear before ancestors. If displayed,
2087
merged revisions are shown indented under the revision in which they
2092
The log format controls how information about each revision is
2093
displayed. The standard log formats are called ``long``, ``short``
2094
and ``line``. The default is long. See ``bzr help log-formats``
2095
for more details on log formats.
2097
The following options can be used to control what information is
2100
-l N display a maximum of N revisions
2101
-n N display N levels of revisions (0 for all, 1 for collapsed)
2102
-v display a status summary (delta) for each revision
2103
-p display a diff (patch) for each revision
2104
--show-ids display revision-ids (and file-ids), not just revnos
2106
Note that the default number of levels to display is a function of the
2107
log format. If the -n option is not used, the standard log formats show
2108
just the top level (mainline).
2110
Status summaries are shown using status flags like A, M, etc. To see
2111
the changes explained using words like ``added`` and ``modified``
2112
instead, use the -vv option.
2116
To display revisions from oldest to newest, use the --forward option.
2117
In most cases, using this option will have little impact on the total
2118
time taken to produce a log, though --forward does not incrementally
2119
display revisions like --reverse does when it can.
2121
:Revision filtering:
2123
The -r option can be used to specify what revision or range of revisions
2124
to filter against. The various forms are shown below::
2126
-rX display revision X
2127
-rX.. display revision X and later
2128
-r..Y display up to and including revision Y
2129
-rX..Y display from X to Y inclusive
2131
See ``bzr help revisionspec`` for details on how to specify X and Y.
2132
Some common examples are given below::
2134
-r-1 show just the tip
2135
-r-10.. show the last 10 mainline revisions
2136
-rsubmit:.. show what's new on this branch
2137
-rancestor:path.. show changes since the common ancestor of this
2138
branch and the one at location path
2139
-rdate:yesterday.. show changes since yesterday
2141
When logging a range of revisions using -rX..Y, log starts at
2142
revision Y and searches back in history through the primary
2143
("left-hand") parents until it finds X. When logging just the
2144
top level (using -n1), an error is reported if X is not found
2145
along the way. If multi-level logging is used (-n0), X may be
2146
a nested merge revision and the log will be truncated accordingly.
2150
If parameters are given and the first one is not a branch, the log
2151
will be filtered to show only those revisions that changed the
2152
nominated files or directories.
2154
Filenames are interpreted within their historical context. To log a
2155
deleted file, specify a revision range so that the file existed at
2156
the end or start of the range.
2158
Historical context is also important when interpreting pathnames of
2159
renamed files/directories. Consider the following example:
2161
* revision 1: add tutorial.txt
2162
* revision 2: modify tutorial.txt
2163
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2167
* ``bzr log guide.txt`` will log the file added in revision 1
2169
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2171
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2172
the original file in revision 2.
2174
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2175
was no file called guide.txt in revision 2.
2177
Renames are always followed by log. By design, there is no need to
2178
explicitly ask for this (and no way to stop logging a file back
2179
until it was last renamed).
2183
The --message option can be used for finding revisions that match a
2184
regular expression in a commit message.
2188
GUI tools and IDEs are often better at exploring history than command
2189
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2190
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2191
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2193
Web interfaces are often better at exploring history than command line
2194
tools, particularly for branches on servers. You may prefer Loggerhead
2195
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2197
You may find it useful to add the aliases below to ``bazaar.conf``::
2201
top = log -l10 --line
2204
``bzr tip`` will then show the latest revision while ``bzr top``
2205
will show the last 10 mainline revisions. To see the details of a
2206
particular revision X, ``bzr show -rX``.
2208
If you are interested in looking deeper into a particular merge X,
2209
use ``bzr log -n0 -rX``.
2211
``bzr log -v`` on a branch with lots of history is currently
2212
very slow. A fix for this issue is currently under development.
2213
With or without that fix, it is recommended that a revision range
2214
be given when using the -v option.
2216
bzr has a generic full-text matching plugin, bzr-search, that can be
2217
used to find revisions matching user names, commit messages, etc.
2218
Among other features, this plugin can find all revisions containing
2219
a list of words but not others.
2221
When exploring non-mainline history on large projects with deep
2222
history, the performance of log can be greatly improved by installing
2223
the historycache plugin. This plugin buffers historical information
2224
trading disk space for faster speed.
2226
takes_args = ['file*']
2227
_see_also = ['log-formats', 'revisionspec']
2230
help='Show from oldest to newest.'),
2232
custom_help('verbose',
2233
help='Show files changed in each revision.'),
2237
type=bzrlib.option._parse_revision_str,
2239
help='Show just the specified revision.'
2240
' See also "help revisionspec".'),
2244
help='Number of levels to display - 0 for all, 1 for flat.',
2246
type=_parse_levels),
2249
help='Show revisions whose message matches this '
2250
'regular expression.',
2254
help='Limit the output to the first N revisions.',
2259
help='Show changes made in each revision as a patch.'),
2260
Option('include-merges',
2261
help='Show merged revisions like --levels 0 does.'),
2263
encoding_type = 'replace'
2266
def run(self, file_list=None, timezone='original',
2277
include_merges=False):
2278
from bzrlib.log import (
2280
make_log_request_dict,
2281
_get_info_for_log_files,
2283
direction = (forward and 'forward') or 'reverse'
2288
raise errors.BzrCommandError(
2289
'--levels and --include-merges are mutually exclusive')
2291
if change is not None:
2293
raise errors.RangeInChangeOption()
2294
if revision is not None:
2295
raise errors.BzrCommandError(
2296
'--revision and --change are mutually exclusive')
2301
filter_by_dir = False
2305
# find the file ids to log and check for directory filtering
2306
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2307
revision, file_list)
2308
for relpath, file_id, kind in file_info_list:
2310
raise errors.BzrCommandError(
2311
"Path unknown at end or start of revision range: %s" %
2313
# If the relpath is the top of the tree, we log everything
2318
file_ids.append(file_id)
2319
filter_by_dir = filter_by_dir or (
2320
kind in ['directory', 'tree-reference'])
2323
# FIXME ? log the current subdir only RBC 20060203
2324
if revision is not None \
2325
and len(revision) > 0 and revision[0].get_branch():
2326
location = revision[0].get_branch()
2329
dir, relpath = bzrdir.BzrDir.open_containing(location)
2330
b = dir.open_branch()
2332
rev1, rev2 = _get_revision_range(revision, b, self.name())
2334
# Decide on the type of delta & diff filtering to use
2335
# TODO: add an --all-files option to make this configurable & consistent
2343
diff_type = 'partial'
2347
# Build the log formatter
2348
if log_format is None:
2349
log_format = log.log_formatter_registry.get_default(b)
2350
lf = log_format(show_ids=show_ids, to_file=self.outf,
2351
show_timezone=timezone,
2352
delta_format=get_verbosity_level(),
2354
show_advice=levels is None)
2356
# Choose the algorithm for doing the logging. It's annoying
2357
# having multiple code paths like this but necessary until
2358
# the underlying repository format is faster at generating
2359
# deltas or can provide everything we need from the indices.
2360
# The default algorithm - match-using-deltas - works for
2361
# multiple files and directories and is faster for small
2362
# amounts of history (200 revisions say). However, it's too
2363
# slow for logging a single file in a repository with deep
2364
# history, i.e. > 10K revisions. In the spirit of "do no
2365
# evil when adding features", we continue to use the
2366
# original algorithm - per-file-graph - for the "single
2367
# file that isn't a directory without showing a delta" case.
2368
partial_history = revision and b.repository._format.supports_chks
2369
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2370
or delta_type or partial_history)
2372
# Build the LogRequest and execute it
2373
if len(file_ids) == 0:
2375
rqst = make_log_request_dict(
2376
direction=direction, specific_fileids=file_ids,
2377
start_revision=rev1, end_revision=rev2, limit=limit,
2378
message_search=message, delta_type=delta_type,
2379
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2380
Logger(b, rqst).show(lf)
2386
def _get_revision_range(revisionspec_list, branch, command_name):
2387
"""Take the input of a revision option and turn it into a revision range.
2389
It returns RevisionInfo objects which can be used to obtain the rev_id's
2390
of the desired revisions. It does some user input validations.
2392
if revisionspec_list is None:
2395
elif len(revisionspec_list) == 1:
2396
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2397
elif len(revisionspec_list) == 2:
2398
start_spec = revisionspec_list[0]
2399
end_spec = revisionspec_list[1]
2400
if end_spec.get_branch() != start_spec.get_branch():
2401
# b is taken from revision[0].get_branch(), and
2402
# show_log will use its revision_history. Having
2403
# different branches will lead to weird behaviors.
2404
raise errors.BzrCommandError(
2405
"bzr %s doesn't accept two revisions in different"
2406
" branches." % command_name)
2407
rev1 = start_spec.in_history(branch)
2408
# Avoid loading all of history when we know a missing
2409
# end of range means the last revision ...
2410
if end_spec.spec is None:
2411
last_revno, last_revision_id = branch.last_revision_info()
2412
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2414
rev2 = end_spec.in_history(branch)
2416
raise errors.BzrCommandError(
2417
'bzr %s --revision takes one or two values.' % command_name)
2421
def _revision_range_to_revid_range(revision_range):
2424
if revision_range[0] is not None:
2425
rev_id1 = revision_range[0].rev_id
2426
if revision_range[1] is not None:
2427
rev_id2 = revision_range[1].rev_id
2428
return rev_id1, rev_id2
2430
def get_log_format(long=False, short=False, line=False, default='long'):
2431
log_format = default
2435
log_format = 'short'
2441
class cmd_touching_revisions(Command):
2442
"""Return revision-ids which affected a particular file.
2444
A more user-friendly interface is "bzr log FILE".
2448
takes_args = ["filename"]
2451
def run(self, filename):
2452
tree, relpath = WorkingTree.open_containing(filename)
2453
file_id = tree.path2id(relpath)
2457
touching_revs = log.find_touching_revisions(b, file_id)
2458
for revno, revision_id, what in touching_revs:
2459
self.outf.write("%6d %s\n" % (revno, what))
2464
class cmd_ls(Command):
2465
"""List files in a tree.
2468
_see_also = ['status', 'cat']
2469
takes_args = ['path?']
2473
Option('recursive', short_name='R',
2474
help='Recurse into subdirectories.'),
2476
help='Print paths relative to the root of the branch.'),
2477
Option('unknown', help='Print unknown files.'),
2478
Option('versioned', help='Print versioned files.',
2480
Option('ignored', help='Print ignored files.'),
2482
help='Write an ascii NUL (\\0) separator '
2483
'between files rather than a newline.'),
2485
help='List entries of a particular kind: file, directory, symlink.',
2490
def run(self, revision=None, verbose=False,
2491
recursive=False, from_root=False,
2492
unknown=False, versioned=False, ignored=False,
2493
null=False, kind=None, show_ids=False, path=None):
2495
if kind and kind not in ('file', 'directory', 'symlink'):
2496
raise errors.BzrCommandError('invalid kind specified')
2498
if verbose and null:
2499
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2500
all = not (unknown or versioned or ignored)
2502
selection = {'I':ignored, '?':unknown, 'V':versioned}
2508
raise errors.BzrCommandError('cannot specify both --from-root'
2511
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2514
# Calculate the prefix to use
2518
prefix = relpath + '/'
2519
elif fs_path != '.' and not fs_path.endswith('/'):
2520
prefix = fs_path + '/'
2522
if revision is not None or tree is None:
2523
tree = _get_one_revision_tree('ls', revision, branch=branch)
2526
if isinstance(tree, WorkingTree) and tree.supports_views():
2527
view_files = tree.views.lookup_view()
2530
view_str = views.view_display_str(view_files)
2531
note("Ignoring files outside view. View is %s" % view_str)
2535
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2536
from_dir=relpath, recursive=recursive):
2537
# Apply additional masking
2538
if not all and not selection[fc]:
2540
if kind is not None and fkind != kind:
2545
fullpath = osutils.pathjoin(relpath, fp)
2548
views.check_path_in_view(tree, fullpath)
2549
except errors.FileOutsideView:
2554
fp = osutils.pathjoin(prefix, fp)
2555
kindch = entry.kind_character()
2556
outstring = fp + kindch
2557
ui.ui_factory.clear_term()
2559
outstring = '%-8s %s' % (fc, outstring)
2560
if show_ids and fid is not None:
2561
outstring = "%-50s %s" % (outstring, fid)
2562
self.outf.write(outstring + '\n')
2564
self.outf.write(fp + '\0')
2567
self.outf.write(fid)
2568
self.outf.write('\0')
2576
self.outf.write('%-50s %s\n' % (outstring, my_id))
2578
self.outf.write(outstring + '\n')
2583
class cmd_unknowns(Command):
2584
"""List unknown files.
2592
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2593
self.outf.write(osutils.quotefn(f) + '\n')
2596
class cmd_ignore(Command):
2597
"""Ignore specified files or patterns.
2599
See ``bzr help patterns`` for details on the syntax of patterns.
2601
If a .bzrignore file does not exist, the ignore command
2602
will create one and add the specified files or patterns to the newly
2603
created file. The ignore command will also automatically add the
2604
.bzrignore file to be versioned. Creating a .bzrignore file without
2605
the use of the ignore command will require an explicit add command.
2607
To remove patterns from the ignore list, edit the .bzrignore file.
2608
After adding, editing or deleting that file either indirectly by
2609
using this command or directly by using an editor, be sure to commit
2612
Note: ignore patterns containing shell wildcards must be quoted from
2616
Ignore the top level Makefile::
2618
bzr ignore ./Makefile
2620
Ignore class files in all directories::
2622
bzr ignore "*.class"
2624
Ignore .o files under the lib directory::
2626
bzr ignore "lib/**/*.o"
2628
Ignore .o files under the lib directory::
2630
bzr ignore "RE:lib/.*\.o"
2632
Ignore everything but the "debian" toplevel directory::
2634
bzr ignore "RE:(?!debian/).*"
2637
_see_also = ['status', 'ignored', 'patterns']
2638
takes_args = ['name_pattern*']
2640
Option('old-default-rules',
2641
help='Write out the ignore rules bzr < 0.9 always used.')
2644
def run(self, name_pattern_list=None, old_default_rules=None):
2645
from bzrlib import ignores
2646
if old_default_rules is not None:
2647
# dump the rules and exit
2648
for pattern in ignores.OLD_DEFAULTS:
2651
if not name_pattern_list:
2652
raise errors.BzrCommandError("ignore requires at least one "
2653
"NAME_PATTERN or --old-default-rules")
2654
name_pattern_list = [globbing.normalize_pattern(p)
2655
for p in name_pattern_list]
2656
for name_pattern in name_pattern_list:
2657
if (name_pattern[0] == '/' or
2658
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2659
raise errors.BzrCommandError(
2660
"NAME_PATTERN should not be an absolute path")
2661
tree, relpath = WorkingTree.open_containing(u'.')
2662
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2663
ignored = globbing.Globster(name_pattern_list)
2666
for entry in tree.list_files():
2670
if ignored.match(filename):
2671
matches.append(filename.encode('utf-8'))
2673
if len(matches) > 0:
2674
print "Warning: the following files are version controlled and" \
2675
" match your ignore pattern:\n%s" \
2676
"\nThese files will continue to be version controlled" \
2677
" unless you 'bzr remove' them." % ("\n".join(matches),)
2680
class cmd_ignored(Command):
2681
"""List ignored files and the patterns that matched them.
2683
List all the ignored files and the ignore pattern that caused the file to
2686
Alternatively, to list just the files::
2691
encoding_type = 'replace'
2692
_see_also = ['ignore', 'ls']
2696
tree = WorkingTree.open_containing(u'.')[0]
2699
for path, file_class, kind, file_id, entry in tree.list_files():
2700
if file_class != 'I':
2702
## XXX: Slightly inefficient since this was already calculated
2703
pat = tree.is_ignored(path)
2704
self.outf.write('%-50s %s\n' % (path, pat))
2709
class cmd_lookup_revision(Command):
2710
"""Lookup the revision-id from a revision-number
2713
bzr lookup-revision 33
2716
takes_args = ['revno']
2719
def run(self, revno):
2723
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2725
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2728
class cmd_export(Command):
2729
"""Export current or past revision to a destination directory or archive.
2731
If no revision is specified this exports the last committed revision.
2733
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2734
given, try to find the format with the extension. If no extension
2735
is found exports to a directory (equivalent to --format=dir).
2737
If root is supplied, it will be used as the root directory inside
2738
container formats (tar, zip, etc). If it is not supplied it will default
2739
to the exported filename. The root option has no effect for 'dir' format.
2741
If branch is omitted then the branch containing the current working
2742
directory will be used.
2744
Note: Export of tree with non-ASCII filenames to zip is not supported.
2746
================= =========================
2747
Supported formats Autodetected by extension
2748
================= =========================
2751
tbz2 .tar.bz2, .tbz2
2754
================= =========================
2756
takes_args = ['dest', 'branch_or_subdir?']
2759
help="Type of file to export to.",
2762
Option('filters', help='Apply content filters to export the '
2763
'convenient form.'),
2766
help="Name of the root directory inside the exported file."),
2768
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2769
root=None, filters=False):
2770
from bzrlib.export import export
2772
if branch_or_subdir is None:
2773
tree = WorkingTree.open_containing(u'.')[0]
2777
b, subdir = Branch.open_containing(branch_or_subdir)
2780
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2782
export(rev_tree, dest, format, root, subdir, filtered=filters)
2783
except errors.NoSuchExportFormat, e:
2784
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2787
class cmd_cat(Command):
2788
"""Write the contents of a file as of a given revision to standard output.
2790
If no revision is nominated, the last revision is used.
2792
Note: Take care to redirect standard output when using this command on a
2798
Option('name-from-revision', help='The path name in the old tree.'),
2799
Option('filters', help='Apply content filters to display the '
2800
'convenience form.'),
2803
takes_args = ['filename']
2804
encoding_type = 'exact'
2807
def run(self, filename, revision=None, name_from_revision=False,
2809
if revision is not None and len(revision) != 1:
2810
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2811
" one revision specifier")
2812
tree, branch, relpath = \
2813
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2816
return self._run(tree, branch, relpath, filename, revision,
2817
name_from_revision, filters)
2821
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2824
tree = b.basis_tree()
2825
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2827
old_file_id = rev_tree.path2id(relpath)
2829
if name_from_revision:
2830
# Try in revision if requested
2831
if old_file_id is None:
2832
raise errors.BzrCommandError(
2833
"%r is not present in revision %s" % (
2834
filename, rev_tree.get_revision_id()))
2836
content = rev_tree.get_file_text(old_file_id)
2838
cur_file_id = tree.path2id(relpath)
2840
if cur_file_id is not None:
2841
# Then try with the actual file id
2843
content = rev_tree.get_file_text(cur_file_id)
2845
except errors.NoSuchId:
2846
# The actual file id didn't exist at that time
2848
if not found and old_file_id is not None:
2849
# Finally try with the old file id
2850
content = rev_tree.get_file_text(old_file_id)
2853
# Can't be found anywhere
2854
raise errors.BzrCommandError(
2855
"%r is not present in revision %s" % (
2856
filename, rev_tree.get_revision_id()))
2858
from bzrlib.filters import (
2859
ContentFilterContext,
2860
filtered_output_bytes,
2862
filters = rev_tree._content_filter_stack(relpath)
2863
chunks = content.splitlines(True)
2864
content = filtered_output_bytes(chunks, filters,
2865
ContentFilterContext(relpath, rev_tree))
2866
self.outf.writelines(content)
2868
self.outf.write(content)
2871
class cmd_local_time_offset(Command):
2872
"""Show the offset in seconds from GMT to local time."""
2876
print osutils.local_time_offset()
2880
class cmd_commit(Command):
2881
"""Commit changes into a new revision.
2883
An explanatory message needs to be given for each commit. This is
2884
often done by using the --message option (getting the message from the
2885
command line) or by using the --file option (getting the message from
2886
a file). If neither of these options is given, an editor is opened for
2887
the user to enter the message. To see the changed files in the
2888
boilerplate text loaded into the editor, use the --show-diff option.
2890
By default, the entire tree is committed and the person doing the
2891
commit is assumed to be the author. These defaults can be overridden
2896
If selected files are specified, only changes to those files are
2897
committed. If a directory is specified then the directory and
2898
everything within it is committed.
2900
When excludes are given, they take precedence over selected files.
2901
For example, to commit only changes within foo, but not changes
2904
bzr commit foo -x foo/bar
2906
A selective commit after a merge is not yet supported.
2910
If the author of the change is not the same person as the committer,
2911
you can specify the author's name using the --author option. The
2912
name should be in the same format as a committer-id, e.g.
2913
"John Doe <jdoe@example.com>". If there is more than one author of
2914
the change you can specify the option multiple times, once for each
2919
A common mistake is to forget to add a new file or directory before
2920
running the commit command. The --strict option checks for unknown
2921
files and aborts the commit if any are found. More advanced pre-commit
2922
checks can be implemented by defining hooks. See ``bzr help hooks``
2927
If you accidentially commit the wrong changes or make a spelling
2928
mistake in the commit message say, you can use the uncommit command
2929
to undo it. See ``bzr help uncommit`` for details.
2931
Hooks can also be configured to run after a commit. This allows you
2932
to trigger updates to external systems like bug trackers. The --fixes
2933
option can be used to record the association between a revision and
2934
one or more bugs. See ``bzr help bugs`` for details.
2936
A selective commit may fail in some cases where the committed
2937
tree would be invalid. Consider::
2942
bzr commit foo -m "committing foo"
2943
bzr mv foo/bar foo/baz
2946
bzr commit foo/bar -m "committing bar but not baz"
2948
In the example above, the last commit will fail by design. This gives
2949
the user the opportunity to decide whether they want to commit the
2950
rename at the same time, separately first, or not at all. (As a general
2951
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2953
# TODO: Run hooks on tree to-be-committed, and after commit.
2955
# TODO: Strict commit that fails if there are deleted files.
2956
# (what does "deleted files" mean ??)
2958
# TODO: Give better message for -s, --summary, used by tla people
2960
# XXX: verbose currently does nothing
2962
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2963
takes_args = ['selected*']
2965
ListOption('exclude', type=str, short_name='x',
2966
help="Do not consider changes made to a given path."),
2967
Option('message', type=unicode,
2969
help="Description of the new revision."),
2972
help='Commit even if nothing has changed.'),
2973
Option('file', type=str,
2976
help='Take commit message from this file.'),
2978
help="Refuse to commit if there are unknown "
2979
"files in the working tree."),
2980
Option('commit-time', type=str,
2981
help="Manually set a commit time using commit date "
2982
"format, e.g. '2009-10-10 08:00:00 +0100'."),
2983
ListOption('fixes', type=str,
2984
help="Mark a bug as being fixed by this revision "
2985
"(see \"bzr help bugs\")."),
2986
ListOption('author', type=unicode,
2987
help="Set the author's name, if it's different "
2988
"from the committer."),
2990
help="Perform a local commit in a bound "
2991
"branch. Local commits are not pushed to "
2992
"the master branch until a normal commit "
2996
help='When no message is supplied, show the diff along'
2997
' with the status summary in the message editor.'),
2999
aliases = ['ci', 'checkin']
3001
def _iter_bug_fix_urls(self, fixes, branch):
3002
# Configure the properties for bug fixing attributes.
3003
for fixed_bug in fixes:
3004
tokens = fixed_bug.split(':')
3005
if len(tokens) != 2:
3006
raise errors.BzrCommandError(
3007
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3008
"See \"bzr help bugs\" for more information on this "
3009
"feature.\nCommit refused." % fixed_bug)
3010
tag, bug_id = tokens
3012
yield bugtracker.get_bug_url(tag, branch, bug_id)
3013
except errors.UnknownBugTrackerAbbreviation:
3014
raise errors.BzrCommandError(
3015
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3016
except errors.MalformedBugIdentifier, e:
3017
raise errors.BzrCommandError(
3018
"%s\nCommit refused." % (str(e),))
3020
def run(self, message=None, file=None, verbose=False, selected_list=None,
3021
unchanged=False, strict=False, local=False, fixes=None,
3022
author=None, show_diff=False, exclude=None, commit_time=None):
3023
from bzrlib.errors import (
3028
from bzrlib.msgeditor import (
3029
edit_commit_message_encoded,
3030
generate_commit_message_template,
3031
make_commit_message_template_encoded
3034
commit_stamp = offset = None
3035
if commit_time is not None:
3037
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3038
except ValueError, e:
3039
raise errors.BzrCommandError(
3040
"Could not parse --commit-time: " + str(e))
3042
# TODO: Need a blackbox test for invoking the external editor; may be
3043
# slightly problematic to run this cross-platform.
3045
# TODO: do more checks that the commit will succeed before
3046
# spending the user's valuable time typing a commit message.
3050
tree, selected_list = tree_files(selected_list)
3051
if selected_list == ['']:
3052
# workaround - commit of root of tree should be exactly the same
3053
# as just default commit in that tree, and succeed even though
3054
# selected-file merge commit is not done yet
3059
bug_property = bugtracker.encode_fixes_bug_urls(
3060
self._iter_bug_fix_urls(fixes, tree.branch))
3062
properties['bugs'] = bug_property
3064
if local and not tree.branch.get_bound_location():
3065
raise errors.LocalRequiresBoundBranch()
3067
def get_message(commit_obj):
3068
"""Callback to get commit message"""
3069
my_message = message
3070
if my_message is not None and '\r' in my_message:
3071
my_message = my_message.replace('\r\n', '\n')
3072
my_message = my_message.replace('\r', '\n')
3073
if my_message is None and not file:
3074
t = make_commit_message_template_encoded(tree,
3075
selected_list, diff=show_diff,
3076
output_encoding=osutils.get_user_encoding())
3077
start_message = generate_commit_message_template(commit_obj)
3078
my_message = edit_commit_message_encoded(t,
3079
start_message=start_message)
3080
if my_message is None:
3081
raise errors.BzrCommandError("please specify a commit"
3082
" message with either --message or --file")
3083
elif my_message and file:
3084
raise errors.BzrCommandError(
3085
"please specify either --message or --file")
3087
my_message = codecs.open(file, 'rt',
3088
osutils.get_user_encoding()).read()
3089
if my_message == "":
3090
raise errors.BzrCommandError("empty commit message specified")
3093
# The API permits a commit with a filter of [] to mean 'select nothing'
3094
# but the command line should not do that.
3095
if not selected_list:
3096
selected_list = None
3098
tree.commit(message_callback=get_message,
3099
specific_files=selected_list,
3100
allow_pointless=unchanged, strict=strict, local=local,
3101
reporter=None, verbose=verbose, revprops=properties,
3102
authors=author, timestamp=commit_stamp,
3104
exclude=safe_relpath_files(tree, exclude))
3105
except PointlessCommit:
3106
# FIXME: This should really happen before the file is read in;
3107
# perhaps prepare the commit; get the message; then actually commit
3108
raise errors.BzrCommandError("No changes to commit."
3109
" Use --unchanged to commit anyhow.")
3110
except ConflictsInTree:
3111
raise errors.BzrCommandError('Conflicts detected in working '
3112
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3114
except StrictCommitFailed:
3115
raise errors.BzrCommandError("Commit refused because there are"
3116
" unknown files in the working tree.")
3117
except errors.BoundBranchOutOfDate, e:
3118
raise errors.BzrCommandError(str(e) + "\n"
3119
'To commit to master branch, run update and then commit.\n'
3120
'You can also pass --local to commit to continue working '
3124
class cmd_check(Command):
3125
"""Validate working tree structure, branch consistency and repository history.
3127
This command checks various invariants about branch and repository storage
3128
to detect data corruption or bzr bugs.
3130
The working tree and branch checks will only give output if a problem is
3131
detected. The output fields of the repository check are:
3134
This is just the number of revisions checked. It doesn't
3138
This is just the number of versionedfiles checked. It
3139
doesn't indicate a problem.
3141
unreferenced ancestors
3142
Texts that are ancestors of other texts, but
3143
are not properly referenced by the revision ancestry. This is a
3144
subtle problem that Bazaar can work around.
3147
This is the total number of unique file contents
3148
seen in the checked revisions. It does not indicate a problem.
3151
This is the total number of repeated texts seen
3152
in the checked revisions. Texts can be repeated when their file
3153
entries are modified, but the file contents are not. It does not
3156
If no restrictions are specified, all Bazaar data that is found at the given
3157
location will be checked.
3161
Check the tree and branch at 'foo'::
3163
bzr check --tree --branch foo
3165
Check only the repository at 'bar'::
3167
bzr check --repo bar
3169
Check everything at 'baz'::
3174
_see_also = ['reconcile']
3175
takes_args = ['path?']
3176
takes_options = ['verbose',
3177
Option('branch', help="Check the branch related to the"
3178
" current directory."),
3179
Option('repo', help="Check the repository related to the"
3180
" current directory."),
3181
Option('tree', help="Check the working tree related to"
3182
" the current directory.")]
3184
def run(self, path=None, verbose=False, branch=False, repo=False,
3186
from bzrlib.check import check_dwim
3189
if not branch and not repo and not tree:
3190
branch = repo = tree = True
3191
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3194
class cmd_upgrade(Command):
3195
"""Upgrade branch storage to current format.
3197
The check command or bzr developers may sometimes advise you to run
3198
this command. When the default format has changed you may also be warned
3199
during other operations to upgrade.
3202
_see_also = ['check']
3203
takes_args = ['url?']
3205
RegistryOption('format',
3206
help='Upgrade to a specific format. See "bzr help'
3207
' formats" for details.',
3208
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3209
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3210
value_switches=True, title='Branch format'),
3213
def run(self, url='.', format=None):
3214
from bzrlib.upgrade import upgrade
3215
upgrade(url, format)
3218
class cmd_whoami(Command):
3219
"""Show or set bzr user id.
3222
Show the email of the current user::
3226
Set the current user::
3228
bzr whoami "Frank Chu <fchu@example.com>"
3230
takes_options = [ Option('email',
3231
help='Display email address only.'),
3233
help='Set identity for the current branch instead of '
3236
takes_args = ['name?']
3237
encoding_type = 'replace'
3240
def run(self, email=False, branch=False, name=None):
3242
# use branch if we're inside one; otherwise global config
3244
c = Branch.open_containing('.')[0].get_config()
3245
except errors.NotBranchError:
3246
c = config.GlobalConfig()
3248
self.outf.write(c.user_email() + '\n')
3250
self.outf.write(c.username() + '\n')
3253
# display a warning if an email address isn't included in the given name.
3255
config.extract_email_address(name)
3256
except errors.NoEmailInUsername, e:
3257
warning('"%s" does not seem to contain an email address. '
3258
'This is allowed, but not recommended.', name)
3260
# use global config unless --branch given
3262
c = Branch.open_containing('.')[0].get_config()
3264
c = config.GlobalConfig()
3265
c.set_user_option('email', name)
3268
class cmd_nick(Command):
3269
"""Print or set the branch nickname.
3271
If unset, the tree root directory name is used as the nickname.
3272
To print the current nickname, execute with no argument.
3274
Bound branches use the nickname of its master branch unless it is set
3278
_see_also = ['info']
3279
takes_args = ['nickname?']
3280
def run(self, nickname=None):
3281
branch = Branch.open_containing(u'.')[0]
3282
if nickname is None:
3283
self.printme(branch)
3285
branch.nick = nickname
3288
def printme(self, branch):
3292
class cmd_alias(Command):
3293
"""Set/unset and display aliases.
3296
Show the current aliases::
3300
Show the alias specified for 'll'::
3304
Set an alias for 'll'::
3306
bzr alias ll="log --line -r-10..-1"
3308
To remove an alias for 'll'::
3310
bzr alias --remove ll
3313
takes_args = ['name?']
3315
Option('remove', help='Remove the alias.'),
3318
def run(self, name=None, remove=False):
3320
self.remove_alias(name)
3322
self.print_aliases()
3324
equal_pos = name.find('=')
3326
self.print_alias(name)
3328
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3330
def remove_alias(self, alias_name):
3331
if alias_name is None:
3332
raise errors.BzrCommandError(
3333
'bzr alias --remove expects an alias to remove.')
3334
# If alias is not found, print something like:
3335
# unalias: foo: not found
3336
c = config.GlobalConfig()
3337
c.unset_alias(alias_name)
3340
def print_aliases(self):
3341
"""Print out the defined aliases in a similar format to bash."""
3342
aliases = config.GlobalConfig().get_aliases()
3343
for key, value in sorted(aliases.iteritems()):
3344
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3347
def print_alias(self, alias_name):
3348
from bzrlib.commands import get_alias
3349
alias = get_alias(alias_name)
3351
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3354
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3356
def set_alias(self, alias_name, alias_command):
3357
"""Save the alias in the global config."""
3358
c = config.GlobalConfig()
3359
c.set_alias(alias_name, alias_command)
3362
class cmd_selftest(Command):
3363
"""Run internal test suite.
3365
If arguments are given, they are regular expressions that say which tests
3366
should run. Tests matching any expression are run, and other tests are
3369
Alternatively if --first is given, matching tests are run first and then
3370
all other tests are run. This is useful if you have been working in a
3371
particular area, but want to make sure nothing else was broken.
3373
If --exclude is given, tests that match that regular expression are
3374
excluded, regardless of whether they match --first or not.
3376
To help catch accidential dependencies between tests, the --randomize
3377
option is useful. In most cases, the argument used is the word 'now'.
3378
Note that the seed used for the random number generator is displayed
3379
when this option is used. The seed can be explicitly passed as the
3380
argument to this option if required. This enables reproduction of the
3381
actual ordering used if and when an order sensitive problem is encountered.
3383
If --list-only is given, the tests that would be run are listed. This is
3384
useful when combined with --first, --exclude and/or --randomize to
3385
understand their impact. The test harness reports "Listed nn tests in ..."
3386
instead of "Ran nn tests in ..." when list mode is enabled.
3388
If the global option '--no-plugins' is given, plugins are not loaded
3389
before running the selftests. This has two effects: features provided or
3390
modified by plugins will not be tested, and tests provided by plugins will
3393
Tests that need working space on disk use a common temporary directory,
3394
typically inside $TMPDIR or /tmp.
3396
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3397
into a pdb postmortem session.
3400
Run only tests relating to 'ignore'::
3404
Disable plugins and list tests as they're run::
3406
bzr --no-plugins selftest -v
3408
# NB: this is used from the class without creating an instance, which is
3409
# why it does not have a self parameter.
3410
def get_transport_type(typestring):
3411
"""Parse and return a transport specifier."""
3412
if typestring == "sftp":
3413
from bzrlib.transport.sftp import SFTPAbsoluteServer
3414
return SFTPAbsoluteServer
3415
if typestring == "memory":
3416
from bzrlib.transport.memory import MemoryServer
3418
if typestring == "fakenfs":
3419
from bzrlib.transport.fakenfs import FakeNFSServer
3420
return FakeNFSServer
3421
msg = "No known transport type %s. Supported types are: sftp\n" %\
3423
raise errors.BzrCommandError(msg)
3426
takes_args = ['testspecs*']
3427
takes_options = ['verbose',
3429
help='Stop when one test fails.',
3433
help='Use a different transport by default '
3434
'throughout the test suite.',
3435
type=get_transport_type),
3437
help='Run the benchmarks rather than selftests.'),
3438
Option('lsprof-timed',
3439
help='Generate lsprof output for benchmarked'
3440
' sections of code.'),
3441
Option('lsprof-tests',
3442
help='Generate lsprof output for each test.'),
3443
Option('cache-dir', type=str,
3444
help='Cache intermediate benchmark output in this '
3447
help='Run all tests, but run specified tests first.',
3451
help='List the tests instead of running them.'),
3452
RegistryOption('parallel',
3453
help="Run the test suite in parallel.",
3454
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3455
value_switches=False,
3457
Option('randomize', type=str, argname="SEED",
3458
help='Randomize the order of tests using the given'
3459
' seed or "now" for the current time.'),
3460
Option('exclude', type=str, argname="PATTERN",
3462
help='Exclude tests that match this regular'
3465
help='Output test progress via subunit.'),
3466
Option('strict', help='Fail on missing dependencies or '
3468
Option('load-list', type=str, argname='TESTLISTFILE',
3469
help='Load a test id list from a text file.'),
3470
ListOption('debugflag', type=str, short_name='E',
3471
help='Turn on a selftest debug flag.'),
3472
ListOption('starting-with', type=str, argname='TESTID',
3473
param_name='starting_with', short_name='s',
3475
'Load only the tests starting with TESTID.'),
3477
encoding_type = 'replace'
3480
Command.__init__(self)
3481
self.additional_selftest_args = {}
3483
def run(self, testspecs_list=None, verbose=False, one=False,
3484
transport=None, benchmark=None,
3485
lsprof_timed=None, cache_dir=None,
3486
first=False, list_only=False,
3487
randomize=None, exclude=None, strict=False,
3488
load_list=None, debugflag=None, starting_with=None, subunit=False,
3489
parallel=None, lsprof_tests=False):
3490
from bzrlib.tests import selftest
3491
import bzrlib.benchmarks as benchmarks
3492
from bzrlib.benchmarks import tree_creator
3494
# Make deprecation warnings visible, unless -Werror is set
3495
symbol_versioning.activate_deprecation_warnings(override=False)
3497
if cache_dir is not None:
3498
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3499
if testspecs_list is not None:
3500
pattern = '|'.join(testspecs_list)
3505
from bzrlib.tests import SubUnitBzrRunner
3507
raise errors.BzrCommandError("subunit not available. subunit "
3508
"needs to be installed to use --subunit.")
3509
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3511
self.additional_selftest_args.setdefault(
3512
'suite_decorators', []).append(parallel)
3514
test_suite_factory = benchmarks.test_suite
3515
# Unless user explicitly asks for quiet, be verbose in benchmarks
3516
verbose = not is_quiet()
3517
# TODO: should possibly lock the history file...
3518
benchfile = open(".perf_history", "at", buffering=1)
3520
test_suite_factory = None
3523
selftest_kwargs = {"verbose": verbose,
3525
"stop_on_failure": one,
3526
"transport": transport,
3527
"test_suite_factory": test_suite_factory,
3528
"lsprof_timed": lsprof_timed,
3529
"lsprof_tests": lsprof_tests,
3530
"bench_history": benchfile,
3531
"matching_tests_first": first,
3532
"list_only": list_only,
3533
"random_seed": randomize,
3534
"exclude_pattern": exclude,
3536
"load_list": load_list,
3537
"debug_flags": debugflag,
3538
"starting_with": starting_with
3540
selftest_kwargs.update(self.additional_selftest_args)
3541
result = selftest(**selftest_kwargs)
3543
if benchfile is not None:
3545
return int(not result)
3548
class cmd_version(Command):
3549
"""Show version of bzr."""
3551
encoding_type = 'replace'
3553
Option("short", help="Print just the version number."),
3557
def run(self, short=False):
3558
from bzrlib.version import show_version
3560
self.outf.write(bzrlib.version_string + '\n')
3562
show_version(to_file=self.outf)
3565
class cmd_rocks(Command):
3566
"""Statement of optimism."""
3572
print "It sure does!"
3575
class cmd_find_merge_base(Command):
3576
"""Find and print a base revision for merging two branches."""
3577
# TODO: Options to specify revisions on either side, as if
3578
# merging only part of the history.
3579
takes_args = ['branch', 'other']
3583
def run(self, branch, other):
3584
from bzrlib.revision import ensure_null
3586
branch1 = Branch.open_containing(branch)[0]
3587
branch2 = Branch.open_containing(other)[0]
3592
last1 = ensure_null(branch1.last_revision())
3593
last2 = ensure_null(branch2.last_revision())
3595
graph = branch1.repository.get_graph(branch2.repository)
3596
base_rev_id = graph.find_unique_lca(last1, last2)
3598
print 'merge base is revision %s' % base_rev_id
3605
class cmd_merge(Command):
3606
"""Perform a three-way merge.
3608
The source of the merge can be specified either in the form of a branch,
3609
or in the form of a path to a file containing a merge directive generated
3610
with bzr send. If neither is specified, the default is the upstream branch
3611
or the branch most recently merged using --remember.
3613
When merging a branch, by default the tip will be merged. To pick a different
3614
revision, pass --revision. If you specify two values, the first will be used as
3615
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3616
available revisions, like this is commonly referred to as "cherrypicking".
3618
Revision numbers are always relative to the branch being merged.
3620
By default, bzr will try to merge in all new work from the other
3621
branch, automatically determining an appropriate base. If this
3622
fails, you may need to give an explicit base.
3624
Merge will do its best to combine the changes in two branches, but there
3625
are some kinds of problems only a human can fix. When it encounters those,
3626
it will mark a conflict. A conflict means that you need to fix something,
3627
before you should commit.
3629
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3631
If there is no default branch set, the first merge will set it. After
3632
that, you can omit the branch to use the default. To change the
3633
default, use --remember. The value will only be saved if the remote
3634
location can be accessed.
3636
The results of the merge are placed into the destination working
3637
directory, where they can be reviewed (with bzr diff), tested, and then
3638
committed to record the result of the merge.
3640
merge refuses to run if there are any uncommitted changes, unless
3643
To select only some changes to merge, use "merge -i", which will prompt
3644
you to apply each diff hunk and file change, similar to "shelve".
3647
To merge the latest revision from bzr.dev::
3649
bzr merge ../bzr.dev
3651
To merge changes up to and including revision 82 from bzr.dev::
3653
bzr merge -r 82 ../bzr.dev
3655
To merge the changes introduced by 82, without previous changes::
3657
bzr merge -r 81..82 ../bzr.dev
3659
To apply a merge directive contained in /tmp/merge::
3661
bzr merge /tmp/merge
3664
encoding_type = 'exact'
3665
_see_also = ['update', 'remerge', 'status-flags', 'send']
3666
takes_args = ['location?']
3671
help='Merge even if the destination tree has uncommitted changes.'),
3675
Option('show-base', help="Show base revision text in "
3677
Option('uncommitted', help='Apply uncommitted changes'
3678
' from a working copy, instead of branch changes.'),
3679
Option('pull', help='If the destination is already'
3680
' completely merged into the source, pull from the'
3681
' source rather than merging. When this happens,'
3682
' you do not need to commit the result.'),
3684
help='Branch to merge into, '
3685
'rather than the one containing the working directory.',
3689
Option('preview', help='Instead of merging, show a diff of the'
3691
Option('interactive', help='Select changes interactively.',
3695
def run(self, location=None, revision=None, force=False,
3696
merge_type=None, show_base=False, reprocess=None, remember=False,
3697
uncommitted=False, pull=False,
3702
if merge_type is None:
3703
merge_type = _mod_merge.Merge3Merger
3705
if directory is None: directory = u'.'
3706
possible_transports = []
3708
allow_pending = True
3709
verified = 'inapplicable'
3710
tree = WorkingTree.open_containing(directory)[0]
3713
basis_tree = tree.revision_tree(tree.last_revision())
3714
except errors.NoSuchRevision:
3715
basis_tree = tree.basis_tree()
3717
# die as quickly as possible if there are uncommitted changes
3719
if tree.has_changes():
3720
raise errors.UncommittedChanges(tree)
3722
view_info = _get_view_info_for_change_reporter(tree)
3723
change_reporter = delta._ChangeReporter(
3724
unversioned_filter=tree.is_ignored, view_info=view_info)
3727
pb = ui.ui_factory.nested_progress_bar()
3728
cleanups.append(pb.finished)
3730
cleanups.append(tree.unlock)
3731
if location is not None:
3733
mergeable = bundle.read_mergeable_from_url(location,
3734
possible_transports=possible_transports)
3735
except errors.NotABundle:
3739
raise errors.BzrCommandError('Cannot use --uncommitted'
3740
' with bundles or merge directives.')
3742
if revision is not None:
3743
raise errors.BzrCommandError(
3744
'Cannot use -r with merge directives or bundles')
3745
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3748
if merger is None and uncommitted:
3749
if revision is not None and len(revision) > 0:
3750
raise errors.BzrCommandError('Cannot use --uncommitted and'
3751
' --revision at the same time.')
3752
merger = self.get_merger_from_uncommitted(tree, location, pb,
3754
allow_pending = False
3757
merger, allow_pending = self._get_merger_from_branch(tree,
3758
location, revision, remember, possible_transports, pb)
3760
merger.merge_type = merge_type
3761
merger.reprocess = reprocess
3762
merger.show_base = show_base
3763
self.sanity_check_merger(merger)
3764
if (merger.base_rev_id == merger.other_rev_id and
3765
merger.other_rev_id is not None):
3766
note('Nothing to do.')
3769
if merger.interesting_files is not None:
3770
raise errors.BzrCommandError('Cannot pull individual files')
3771
if (merger.base_rev_id == tree.last_revision()):
3772
result = tree.pull(merger.other_branch, False,
3773
merger.other_rev_id)
3774
result.report(self.outf)
3776
if merger.this_basis is None:
3777
raise errors.BzrCommandError(
3778
"This branch has no commits."
3779
" (perhaps you would prefer 'bzr pull')")
3781
return self._do_preview(merger, cleanups)
3783
return self._do_interactive(merger, cleanups)
3785
return self._do_merge(merger, change_reporter, allow_pending,
3788
for cleanup in reversed(cleanups):
3791
def _get_preview(self, merger, cleanups):
3792
tree_merger = merger.make_merger()
3793
tt = tree_merger.make_preview_transform()
3794
cleanups.append(tt.finalize)
3795
result_tree = tt.get_preview_tree()
3798
def _do_preview(self, merger, cleanups):
3799
from bzrlib.diff import show_diff_trees
3800
result_tree = self._get_preview(merger, cleanups)
3801
show_diff_trees(merger.this_tree, result_tree, self.outf,
3802
old_label='', new_label='')
3804
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3805
merger.change_reporter = change_reporter
3806
conflict_count = merger.do_merge()
3808
merger.set_pending()
3809
if verified == 'failed':
3810
warning('Preview patch does not match changes')
3811
if conflict_count != 0:
3816
def _do_interactive(self, merger, cleanups):
3817
"""Perform an interactive merge.
3819
This works by generating a preview tree of the merge, then using
3820
Shelver to selectively remove the differences between the working tree
3821
and the preview tree.
3823
from bzrlib import shelf_ui
3824
result_tree = self._get_preview(merger, cleanups)
3825
writer = bzrlib.option.diff_writer_registry.get()
3826
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3827
reporter=shelf_ui.ApplyReporter(),
3828
diff_writer=writer(sys.stdout))
3831
def sanity_check_merger(self, merger):
3832
if (merger.show_base and
3833
not merger.merge_type is _mod_merge.Merge3Merger):
3834
raise errors.BzrCommandError("Show-base is not supported for this"
3835
" merge type. %s" % merger.merge_type)
3836
if merger.reprocess is None:
3837
if merger.show_base:
3838
merger.reprocess = False
3840
# Use reprocess if the merger supports it
3841
merger.reprocess = merger.merge_type.supports_reprocess
3842
if merger.reprocess and not merger.merge_type.supports_reprocess:
3843
raise errors.BzrCommandError("Conflict reduction is not supported"
3844
" for merge type %s." %
3846
if merger.reprocess and merger.show_base:
3847
raise errors.BzrCommandError("Cannot do conflict reduction and"
3850
def _get_merger_from_branch(self, tree, location, revision, remember,
3851
possible_transports, pb):
3852
"""Produce a merger from a location, assuming it refers to a branch."""
3853
from bzrlib.tag import _merge_tags_if_possible
3854
# find the branch locations
3855
other_loc, user_location = self._select_branch_location(tree, location,
3857
if revision is not None and len(revision) == 2:
3858
base_loc, _unused = self._select_branch_location(tree,
3859
location, revision, 0)
3861
base_loc = other_loc
3863
other_branch, other_path = Branch.open_containing(other_loc,
3864
possible_transports)
3865
if base_loc == other_loc:
3866
base_branch = other_branch
3868
base_branch, base_path = Branch.open_containing(base_loc,
3869
possible_transports)
3870
# Find the revision ids
3871
other_revision_id = None
3872
base_revision_id = None
3873
if revision is not None:
3874
if len(revision) >= 1:
3875
other_revision_id = revision[-1].as_revision_id(other_branch)
3876
if len(revision) == 2:
3877
base_revision_id = revision[0].as_revision_id(base_branch)
3878
if other_revision_id is None:
3879
other_revision_id = _mod_revision.ensure_null(
3880
other_branch.last_revision())
3881
# Remember where we merge from
3882
if ((remember or tree.branch.get_submit_branch() is None) and
3883
user_location is not None):
3884
tree.branch.set_submit_branch(other_branch.base)
3885
_merge_tags_if_possible(other_branch, tree.branch)
3886
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3887
other_revision_id, base_revision_id, other_branch, base_branch)
3888
if other_path != '':
3889
allow_pending = False
3890
merger.interesting_files = [other_path]
3892
allow_pending = True
3893
return merger, allow_pending
3895
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3896
"""Get a merger for uncommitted changes.
3898
:param tree: The tree the merger should apply to.
3899
:param location: The location containing uncommitted changes.
3900
:param pb: The progress bar to use for showing progress.
3901
:param cleanups: A list of operations to perform to clean up the
3902
temporary directories, unfinalized objects, etc.
3904
location = self._select_branch_location(tree, location)[0]
3905
other_tree, other_path = WorkingTree.open_containing(location)
3906
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3907
if other_path != '':
3908
merger.interesting_files = [other_path]
3911
def _select_branch_location(self, tree, user_location, revision=None,
3913
"""Select a branch location, according to possible inputs.
3915
If provided, branches from ``revision`` are preferred. (Both
3916
``revision`` and ``index`` must be supplied.)
3918
Otherwise, the ``location`` parameter is used. If it is None, then the
3919
``submit`` or ``parent`` location is used, and a note is printed.
3921
:param tree: The working tree to select a branch for merging into
3922
:param location: The location entered by the user
3923
:param revision: The revision parameter to the command
3924
:param index: The index to use for the revision parameter. Negative
3925
indices are permitted.
3926
:return: (selected_location, user_location). The default location
3927
will be the user-entered location.
3929
if (revision is not None and index is not None
3930
and revision[index] is not None):
3931
branch = revision[index].get_branch()
3932
if branch is not None:
3933
return branch, branch
3934
if user_location is None:
3935
location = self._get_remembered(tree, 'Merging from')
3937
location = user_location
3938
return location, user_location
3940
def _get_remembered(self, tree, verb_string):
3941
"""Use tree.branch's parent if none was supplied.
3943
Report if the remembered location was used.
3945
stored_location = tree.branch.get_submit_branch()
3946
stored_location_type = "submit"
3947
if stored_location is None:
3948
stored_location = tree.branch.get_parent()
3949
stored_location_type = "parent"
3950
mutter("%s", stored_location)
3951
if stored_location is None:
3952
raise errors.BzrCommandError("No location specified or remembered")
3953
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3954
note(u"%s remembered %s location %s", verb_string,
3955
stored_location_type, display_url)
3956
return stored_location
3959
class cmd_remerge(Command):
3962
Use this if you want to try a different merge technique while resolving
3963
conflicts. Some merge techniques are better than others, and remerge
3964
lets you try different ones on different files.
3966
The options for remerge have the same meaning and defaults as the ones for
3967
merge. The difference is that remerge can (only) be run when there is a
3968
pending merge, and it lets you specify particular files.
3971
Re-do the merge of all conflicted files, and show the base text in
3972
conflict regions, in addition to the usual THIS and OTHER texts::
3974
bzr remerge --show-base
3976
Re-do the merge of "foobar", using the weave merge algorithm, with
3977
additional processing to reduce the size of conflict regions::
3979
bzr remerge --merge-type weave --reprocess foobar
3981
takes_args = ['file*']
3986
help="Show base revision text in conflicts."),
3989
def run(self, file_list=None, merge_type=None, show_base=False,
3991
if merge_type is None:
3992
merge_type = _mod_merge.Merge3Merger
3993
tree, file_list = tree_files(file_list)
3996
parents = tree.get_parent_ids()
3997
if len(parents) != 2:
3998
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3999
" merges. Not cherrypicking or"
4001
repository = tree.branch.repository
4002
interesting_ids = None
4004
conflicts = tree.conflicts()
4005
if file_list is not None:
4006
interesting_ids = set()
4007
for filename in file_list:
4008
file_id = tree.path2id(filename)
4010
raise errors.NotVersionedError(filename)
4011
interesting_ids.add(file_id)
4012
if tree.kind(file_id) != "directory":
4015
for name, ie in tree.inventory.iter_entries(file_id):
4016
interesting_ids.add(ie.file_id)
4017
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4019
# Remerge only supports resolving contents conflicts
4020
allowed_conflicts = ('text conflict', 'contents conflict')
4021
restore_files = [c.path for c in conflicts
4022
if c.typestring in allowed_conflicts]
4023
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4024
tree.set_conflicts(ConflictList(new_conflicts))
4025
if file_list is not None:
4026
restore_files = file_list
4027
for filename in restore_files:
4029
restore(tree.abspath(filename))
4030
except errors.NotConflicted:
4032
# Disable pending merges, because the file texts we are remerging
4033
# have not had those merges performed. If we use the wrong parents
4034
# list, we imply that the working tree text has seen and rejected
4035
# all the changes from the other tree, when in fact those changes
4036
# have not yet been seen.
4037
pb = ui.ui_factory.nested_progress_bar()
4038
tree.set_parent_ids(parents[:1])
4040
merger = _mod_merge.Merger.from_revision_ids(pb,
4042
merger.interesting_ids = interesting_ids
4043
merger.merge_type = merge_type
4044
merger.show_base = show_base
4045
merger.reprocess = reprocess
4046
conflicts = merger.do_merge()
4048
tree.set_parent_ids(parents)
4058
class cmd_revert(Command):
4059
"""Revert files to a previous revision.
4061
Giving a list of files will revert only those files. Otherwise, all files
4062
will be reverted. If the revision is not specified with '--revision', the
4063
last committed revision is used.
4065
To remove only some changes, without reverting to a prior version, use
4066
merge instead. For example, "merge . --revision -2..-3" will remove the
4067
changes introduced by -2, without affecting the changes introduced by -1.
4068
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4070
By default, any files that have been manually changed will be backed up
4071
first. (Files changed only by merge are not backed up.) Backup files have
4072
'.~#~' appended to their name, where # is a number.
4074
When you provide files, you can use their current pathname or the pathname
4075
from the target revision. So you can use revert to "undelete" a file by
4076
name. If you name a directory, all the contents of that directory will be
4079
If you have newly added files since the target revision, they will be
4080
removed. If the files to be removed have been changed, backups will be
4081
created as above. Directories containing unknown files will not be
4084
The working tree contains a list of pending merged revisions, which will
4085
be included as parents in the next commit. Normally, revert clears that
4086
list as well as reverting the files. If any files are specified, revert
4087
leaves the pending merge list alone and reverts only the files. Use "bzr
4088
revert ." in the tree root to revert all files but keep the merge record,
4089
and "bzr revert --forget-merges" to clear the pending merge list without
4090
reverting any files.
4092
Using "bzr revert --forget-merges", it is possible to apply the changes
4093
from an arbitrary merge as a single revision. To do this, perform the
4094
merge as desired. Then doing revert with the "--forget-merges" option will
4095
keep the content of the tree as it was, but it will clear the list of
4096
pending merges. The next commit will then contain all of the changes that
4097
would have been in the merge, but without any mention of the other parent
4098
revisions. Because this technique forgets where these changes originated,
4099
it may cause additional conflicts on later merges involving the source and
4103
_see_also = ['cat', 'export']
4106
Option('no-backup', "Do not save backups of reverted files."),
4107
Option('forget-merges',
4108
'Remove pending merge marker, without changing any files.'),
4110
takes_args = ['file*']
4112
def run(self, revision=None, no_backup=False, file_list=None,
4113
forget_merges=None):
4114
tree, file_list = tree_files(file_list)
4118
tree.set_parent_ids(tree.get_parent_ids()[:1])
4120
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4125
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4126
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4127
pb = ui.ui_factory.nested_progress_bar()
4129
tree.revert(file_list, rev_tree, not no_backup, pb,
4130
report_changes=True)
4135
class cmd_assert_fail(Command):
4136
"""Test reporting of assertion failures"""
4137
# intended just for use in testing
4142
raise AssertionError("always fails")
4145
class cmd_help(Command):
4146
"""Show help on a command or other topic.
4149
_see_also = ['topics']
4151
Option('long', 'Show help on all commands.'),
4153
takes_args = ['topic?']
4154
aliases = ['?', '--help', '-?', '-h']
4157
def run(self, topic=None, long=False):
4159
if topic is None and long:
4161
bzrlib.help.help(topic)
4164
class cmd_shell_complete(Command):
4165
"""Show appropriate completions for context.
4167
For a list of all available commands, say 'bzr shell-complete'.
4169
takes_args = ['context?']
4174
def run(self, context=None):
4175
import shellcomplete
4176
shellcomplete.shellcomplete(context)
4179
class cmd_missing(Command):
4180
"""Show unmerged/unpulled revisions between two branches.
4182
OTHER_BRANCH may be local or remote.
4184
To filter on a range of revisions, you can use the command -r begin..end
4185
-r revision requests a specific revision, -r ..end or -r begin.. are
4189
1 - some missing revisions
4190
0 - no missing revisions
4194
Determine the missing revisions between this and the branch at the
4195
remembered pull location::
4199
Determine the missing revisions between this and another branch::
4201
bzr missing http://server/branch
4203
Determine the missing revisions up to a specific revision on the other
4206
bzr missing -r ..-10
4208
Determine the missing revisions up to a specific revision on this
4211
bzr missing --my-revision ..-10
4214
_see_also = ['merge', 'pull']
4215
takes_args = ['other_branch?']
4217
Option('reverse', 'Reverse the order of revisions.'),
4219
'Display changes in the local branch only.'),
4220
Option('this' , 'Same as --mine-only.'),
4221
Option('theirs-only',
4222
'Display changes in the remote branch only.'),
4223
Option('other', 'Same as --theirs-only.'),
4227
custom_help('revision',
4228
help='Filter on other branch revisions (inclusive). '
4229
'See "help revisionspec" for details.'),
4230
Option('my-revision',
4231
type=_parse_revision_str,
4232
help='Filter on local branch revisions (inclusive). '
4233
'See "help revisionspec" for details.'),
4234
Option('include-merges',
4235
'Show all revisions in addition to the mainline ones.'),
4237
encoding_type = 'replace'
4240
def run(self, other_branch=None, reverse=False, mine_only=False,
4242
log_format=None, long=False, short=False, line=False,
4243
show_ids=False, verbose=False, this=False, other=False,
4244
include_merges=False, revision=None, my_revision=None):
4245
from bzrlib.missing import find_unmerged, iter_log_revisions
4254
# TODO: We should probably check that we don't have mine-only and
4255
# theirs-only set, but it gets complicated because we also have
4256
# this and other which could be used.
4263
local_branch = Branch.open_containing(u".")[0]
4264
parent = local_branch.get_parent()
4265
if other_branch is None:
4266
other_branch = parent
4267
if other_branch is None:
4268
raise errors.BzrCommandError("No peer location known"
4270
display_url = urlutils.unescape_for_display(parent,
4272
message("Using saved parent location: "
4273
+ display_url + "\n")
4275
remote_branch = Branch.open(other_branch)
4276
if remote_branch.base == local_branch.base:
4277
remote_branch = local_branch
4279
local_revid_range = _revision_range_to_revid_range(
4280
_get_revision_range(my_revision, local_branch,
4283
remote_revid_range = _revision_range_to_revid_range(
4284
_get_revision_range(revision,
4285
remote_branch, self.name()))
4287
local_branch.lock_read()
4289
remote_branch.lock_read()
4291
local_extra, remote_extra = find_unmerged(
4292
local_branch, remote_branch, restrict,
4293
backward=not reverse,
4294
include_merges=include_merges,
4295
local_revid_range=local_revid_range,
4296
remote_revid_range=remote_revid_range)
4298
if log_format is None:
4299
registry = log.log_formatter_registry
4300
log_format = registry.get_default(local_branch)
4301
lf = log_format(to_file=self.outf,
4303
show_timezone='original')
4306
if local_extra and not theirs_only:
4307
message("You have %d extra revision(s):\n" %
4309
for revision in iter_log_revisions(local_extra,
4310
local_branch.repository,
4312
lf.log_revision(revision)
4313
printed_local = True
4316
printed_local = False
4318
if remote_extra and not mine_only:
4319
if printed_local is True:
4321
message("You are missing %d revision(s):\n" %
4323
for revision in iter_log_revisions(remote_extra,
4324
remote_branch.repository,
4326
lf.log_revision(revision)
4329
if mine_only and not local_extra:
4330
# We checked local, and found nothing extra
4331
message('This branch is up to date.\n')
4332
elif theirs_only and not remote_extra:
4333
# We checked remote, and found nothing extra
4334
message('Other branch is up to date.\n')
4335
elif not (mine_only or theirs_only or local_extra or
4337
# We checked both branches, and neither one had extra
4339
message("Branches are up to date.\n")
4341
remote_branch.unlock()
4343
local_branch.unlock()
4344
if not status_code and parent is None and other_branch is not None:
4345
local_branch.lock_write()
4347
# handle race conditions - a parent might be set while we run.
4348
if local_branch.get_parent() is None:
4349
local_branch.set_parent(remote_branch.base)
4351
local_branch.unlock()
4355
class cmd_pack(Command):
4356
"""Compress the data within a repository."""
4358
_see_also = ['repositories']
4359
takes_args = ['branch_or_repo?']
4361
def run(self, branch_or_repo='.'):
4362
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4364
branch = dir.open_branch()
4365
repository = branch.repository
4366
except errors.NotBranchError:
4367
repository = dir.open_repository()
4371
class cmd_plugins(Command):
4372
"""List the installed plugins.
4374
This command displays the list of installed plugins including
4375
version of plugin and a short description of each.
4377
--verbose shows the path where each plugin is located.
4379
A plugin is an external component for Bazaar that extends the
4380
revision control system, by adding or replacing code in Bazaar.
4381
Plugins can do a variety of things, including overriding commands,
4382
adding new commands, providing additional network transports and
4383
customizing log output.
4385
See the Bazaar web site, http://bazaar-vcs.org, for further
4386
information on plugins including where to find them and how to
4387
install them. Instructions are also provided there on how to
4388
write new plugins using the Python programming language.
4390
takes_options = ['verbose']
4393
def run(self, verbose=False):
4394
import bzrlib.plugin
4395
from inspect import getdoc
4397
for name, plugin in bzrlib.plugin.plugins().items():
4398
version = plugin.__version__
4399
if version == 'unknown':
4401
name_ver = '%s %s' % (name, version)
4402
d = getdoc(plugin.module)
4404
doc = d.split('\n')[0]
4406
doc = '(no description)'
4407
result.append((name_ver, doc, plugin.path()))
4408
for name_ver, doc, path in sorted(result):
4416
class cmd_testament(Command):
4417
"""Show testament (signing-form) of a revision."""
4420
Option('long', help='Produce long-format testament.'),
4422
help='Produce a strict-format testament.')]
4423
takes_args = ['branch?']
4425
def run(self, branch=u'.', revision=None, long=False, strict=False):
4426
from bzrlib.testament import Testament, StrictTestament
4428
testament_class = StrictTestament
4430
testament_class = Testament
4432
b = Branch.open_containing(branch)[0]
4434
b = Branch.open(branch)
4437
if revision is None:
4438
rev_id = b.last_revision()
4440
rev_id = revision[0].as_revision_id(b)
4441
t = testament_class.from_revision(b.repository, rev_id)
4443
sys.stdout.writelines(t.as_text_lines())
4445
sys.stdout.write(t.as_short_text())
4450
class cmd_annotate(Command):
4451
"""Show the origin of each line in a file.
4453
This prints out the given file with an annotation on the left side
4454
indicating which revision, author and date introduced the change.
4456
If the origin is the same for a run of consecutive lines, it is
4457
shown only at the top, unless the --all option is given.
4459
# TODO: annotate directories; showing when each file was last changed
4460
# TODO: if the working copy is modified, show annotations on that
4461
# with new uncommitted lines marked
4462
aliases = ['ann', 'blame', 'praise']
4463
takes_args = ['filename']
4464
takes_options = [Option('all', help='Show annotations on all lines.'),
4465
Option('long', help='Show commit date in annotations.'),
4469
encoding_type = 'exact'
4472
def run(self, filename, all=False, long=False, revision=None,
4474
from bzrlib.annotate import annotate_file, annotate_file_tree
4475
wt, branch, relpath = \
4476
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4482
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4484
file_id = wt.path2id(relpath)
4486
file_id = tree.path2id(relpath)
4488
raise errors.NotVersionedError(filename)
4489
file_version = tree.inventory[file_id].revision
4490
if wt is not None and revision is None:
4491
# If there is a tree and we're not annotating historical
4492
# versions, annotate the working tree's content.
4493
annotate_file_tree(wt, file_id, self.outf, long, all,
4496
annotate_file(branch, file_version, file_id, long, all, self.outf,
4505
class cmd_re_sign(Command):
4506
"""Create a digital signature for an existing revision."""
4507
# TODO be able to replace existing ones.
4509
hidden = True # is this right ?
4510
takes_args = ['revision_id*']
4511
takes_options = ['revision']
4513
def run(self, revision_id_list=None, revision=None):
4514
if revision_id_list is not None and revision is not None:
4515
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4516
if revision_id_list is None and revision is None:
4517
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4518
b = WorkingTree.open_containing(u'.')[0].branch
4521
return self._run(b, revision_id_list, revision)
4525
def _run(self, b, revision_id_list, revision):
4526
import bzrlib.gpg as gpg
4527
gpg_strategy = gpg.GPGStrategy(b.get_config())
4528
if revision_id_list is not None:
4529
b.repository.start_write_group()
4531
for revision_id in revision_id_list:
4532
b.repository.sign_revision(revision_id, gpg_strategy)
4534
b.repository.abort_write_group()
4537
b.repository.commit_write_group()
4538
elif revision is not None:
4539
if len(revision) == 1:
4540
revno, rev_id = revision[0].in_history(b)
4541
b.repository.start_write_group()
4543
b.repository.sign_revision(rev_id, gpg_strategy)
4545
b.repository.abort_write_group()
4548
b.repository.commit_write_group()
4549
elif len(revision) == 2:
4550
# are they both on rh- if so we can walk between them
4551
# might be nice to have a range helper for arbitrary
4552
# revision paths. hmm.
4553
from_revno, from_revid = revision[0].in_history(b)
4554
to_revno, to_revid = revision[1].in_history(b)
4555
if to_revid is None:
4556
to_revno = b.revno()
4557
if from_revno is None or to_revno is None:
4558
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4559
b.repository.start_write_group()
4561
for revno in range(from_revno, to_revno + 1):
4562
b.repository.sign_revision(b.get_rev_id(revno),
4565
b.repository.abort_write_group()
4568
b.repository.commit_write_group()
4570
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4573
class cmd_bind(Command):
4574
"""Convert the current branch into a checkout of the supplied branch.
4576
Once converted into a checkout, commits must succeed on the master branch
4577
before they will be applied to the local branch.
4579
Bound branches use the nickname of its master branch unless it is set
4580
locally, in which case binding will update the local nickname to be
4584
_see_also = ['checkouts', 'unbind']
4585
takes_args = ['location?']
4588
def run(self, location=None):
4589
b, relpath = Branch.open_containing(u'.')
4590
if location is None:
4592
location = b.get_old_bound_location()
4593
except errors.UpgradeRequired:
4594
raise errors.BzrCommandError('No location supplied. '
4595
'This format does not remember old locations.')
4597
if location is None:
4598
raise errors.BzrCommandError('No location supplied and no '
4599
'previous location known')
4600
b_other = Branch.open(location)
4603
except errors.DivergedBranches:
4604
raise errors.BzrCommandError('These branches have diverged.'
4605
' Try merging, and then bind again.')
4606
if b.get_config().has_explicit_nickname():
4607
b.nick = b_other.nick
4610
class cmd_unbind(Command):
4611
"""Convert the current checkout into a regular branch.
4613
After unbinding, the local branch is considered independent and subsequent
4614
commits will be local only.
4617
_see_also = ['checkouts', 'bind']
4622
b, relpath = Branch.open_containing(u'.')
4624
raise errors.BzrCommandError('Local branch is not bound')
4627
class cmd_uncommit(Command):
4628
"""Remove the last committed revision.
4630
--verbose will print out what is being removed.
4631
--dry-run will go through all the motions, but not actually
4634
If --revision is specified, uncommit revisions to leave the branch at the
4635
specified revision. For example, "bzr uncommit -r 15" will leave the
4636
branch at revision 15.
4638
Uncommit leaves the working tree ready for a new commit. The only change
4639
it may make is to restore any pending merges that were present before
4643
# TODO: jam 20060108 Add an option to allow uncommit to remove
4644
# unreferenced information in 'branch-as-repository' branches.
4645
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4646
# information in shared branches as well.
4647
_see_also = ['commit']
4648
takes_options = ['verbose', 'revision',
4649
Option('dry-run', help='Don\'t actually make changes.'),
4650
Option('force', help='Say yes to all questions.'),
4652
help="Only remove the commits from the local branch"
4653
" when in a checkout."
4656
takes_args = ['location?']
4658
encoding_type = 'replace'
4660
def run(self, location=None,
4661
dry_run=False, verbose=False,
4662
revision=None, force=False, local=False):
4663
if location is None:
4665
control, relpath = bzrdir.BzrDir.open_containing(location)
4667
tree = control.open_workingtree()
4669
except (errors.NoWorkingTree, errors.NotLocalUrl):
4671
b = control.open_branch()
4673
if tree is not None:
4678
return self._run(b, tree, dry_run, verbose, revision, force,
4681
if tree is not None:
4686
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4687
from bzrlib.log import log_formatter, show_log
4688
from bzrlib.uncommit import uncommit
4690
last_revno, last_rev_id = b.last_revision_info()
4693
if revision is None:
4695
rev_id = last_rev_id
4697
# 'bzr uncommit -r 10' actually means uncommit
4698
# so that the final tree is at revno 10.
4699
# but bzrlib.uncommit.uncommit() actually uncommits
4700
# the revisions that are supplied.
4701
# So we need to offset it by one
4702
revno = revision[0].in_history(b).revno + 1
4703
if revno <= last_revno:
4704
rev_id = b.get_rev_id(revno)
4706
if rev_id is None or _mod_revision.is_null(rev_id):
4707
self.outf.write('No revisions to uncommit.\n')
4710
lf = log_formatter('short',
4712
show_timezone='original')
4717
direction='forward',
4718
start_revision=revno,
4719
end_revision=last_revno)
4722
print 'Dry-run, pretending to remove the above revisions.'
4724
val = raw_input('Press <enter> to continue')
4726
print 'The above revision(s) will be removed.'
4728
val = raw_input('Are you sure [y/N]? ')
4729
if val.lower() not in ('y', 'yes'):
4733
mutter('Uncommitting from {%s} to {%s}',
4734
last_rev_id, rev_id)
4735
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4736
revno=revno, local=local)
4737
note('You can restore the old tip by running:\n'
4738
' bzr pull . -r revid:%s', last_rev_id)
4741
class cmd_break_lock(Command):
4742
"""Break a dead lock on a repository, branch or working directory.
4744
CAUTION: Locks should only be broken when you are sure that the process
4745
holding the lock has been stopped.
4747
You can get information on what locks are open via the 'bzr info' command.
4752
takes_args = ['location?']
4754
def run(self, location=None, show=False):
4755
if location is None:
4757
control, relpath = bzrdir.BzrDir.open_containing(location)
4759
control.break_lock()
4760
except NotImplementedError:
4764
class cmd_wait_until_signalled(Command):
4765
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4767
This just prints a line to signal when it is ready, then blocks on stdin.
4773
sys.stdout.write("running\n")
4775
sys.stdin.readline()
4778
class cmd_serve(Command):
4779
"""Run the bzr server."""
4781
aliases = ['server']
4785
help='Serve on stdin/out for use from inetd or sshd.'),
4786
RegistryOption('protocol',
4787
help="Protocol to serve.",
4788
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4789
value_switches=True),
4791
help='Listen for connections on nominated port of the form '
4792
'[hostname:]portnumber. Passing 0 as the port number will '
4793
'result in a dynamically allocated port. The default port '
4794
'depends on the protocol.',
4797
help='Serve contents of this directory.',
4799
Option('allow-writes',
4800
help='By default the server is a readonly server. Supplying '
4801
'--allow-writes enables write access to the contents of '
4802
'the served directory and below. Note that ``bzr serve`` '
4803
'does not perform authentication, so unless some form of '
4804
'external authentication is arranged supplying this '
4805
'option leads to global uncontrolled write access to your '
4810
def get_host_and_port(self, port):
4811
"""Return the host and port to run the smart server on.
4813
If 'port' is None, None will be returned for the host and port.
4815
If 'port' has a colon in it, the string before the colon will be
4816
interpreted as the host.
4818
:param port: A string of the port to run the server on.
4819
:return: A tuple of (host, port), where 'host' is a host name or IP,
4820
and port is an integer TCP/IP port.
4823
if port is not None:
4825
host, port = port.split(':')
4829
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4831
from bzrlib.transport import get_transport, transport_server_registry
4832
if directory is None:
4833
directory = os.getcwd()
4834
if protocol is None:
4835
protocol = transport_server_registry.get()
4836
host, port = self.get_host_and_port(port)
4837
url = urlutils.local_path_to_url(directory)
4838
if not allow_writes:
4839
url = 'readonly+' + url
4840
transport = get_transport(url)
4841
protocol(transport, host, port, inet)
4844
class cmd_join(Command):
4845
"""Combine a tree into its containing tree.
4847
This command requires the target tree to be in a rich-root format.
4849
The TREE argument should be an independent tree, inside another tree, but
4850
not part of it. (Such trees can be produced by "bzr split", but also by
4851
running "bzr branch" with the target inside a tree.)
4853
The result is a combined tree, with the subtree no longer an independant
4854
part. This is marked as a merge of the subtree into the containing tree,
4855
and all history is preserved.
4858
_see_also = ['split']
4859
takes_args = ['tree']
4861
Option('reference', help='Join by reference.', hidden=True),
4864
def run(self, tree, reference=False):
4865
sub_tree = WorkingTree.open(tree)
4866
parent_dir = osutils.dirname(sub_tree.basedir)
4867
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4868
repo = containing_tree.branch.repository
4869
if not repo.supports_rich_root():
4870
raise errors.BzrCommandError(
4871
"Can't join trees because %s doesn't support rich root data.\n"
4872
"You can use bzr upgrade on the repository."
4876
containing_tree.add_reference(sub_tree)
4877
except errors.BadReferenceTarget, e:
4878
# XXX: Would be better to just raise a nicely printable
4879
# exception from the real origin. Also below. mbp 20070306
4880
raise errors.BzrCommandError("Cannot join %s. %s" %
4884
containing_tree.subsume(sub_tree)
4885
except errors.BadSubsumeSource, e:
4886
raise errors.BzrCommandError("Cannot join %s. %s" %
4890
class cmd_split(Command):
4891
"""Split a subdirectory of a tree into a separate tree.
4893
This command will produce a target tree in a format that supports
4894
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4895
converted into earlier formats like 'dirstate-tags'.
4897
The TREE argument should be a subdirectory of a working tree. That
4898
subdirectory will be converted into an independent tree, with its own
4899
branch. Commits in the top-level tree will not apply to the new subtree.
4902
_see_also = ['join']
4903
takes_args = ['tree']
4905
def run(self, tree):
4906
containing_tree, subdir = WorkingTree.open_containing(tree)
4907
sub_id = containing_tree.path2id(subdir)
4909
raise errors.NotVersionedError(subdir)
4911
containing_tree.extract(sub_id)
4912
except errors.RootNotRich:
4913
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4916
class cmd_merge_directive(Command):
4917
"""Generate a merge directive for auto-merge tools.
4919
A directive requests a merge to be performed, and also provides all the
4920
information necessary to do so. This means it must either include a
4921
revision bundle, or the location of a branch containing the desired
4924
A submit branch (the location to merge into) must be supplied the first
4925
time the command is issued. After it has been supplied once, it will
4926
be remembered as the default.
4928
A public branch is optional if a revision bundle is supplied, but required
4929
if --diff or --plain is specified. It will be remembered as the default
4930
after the first use.
4933
takes_args = ['submit_branch?', 'public_branch?']
4937
_see_also = ['send']
4940
RegistryOption.from_kwargs('patch-type',
4941
'The type of patch to include in the directive.',
4943
value_switches=True,
4945
bundle='Bazaar revision bundle (default).',
4946
diff='Normal unified diff.',
4947
plain='No patch, just directive.'),
4948
Option('sign', help='GPG-sign the directive.'), 'revision',
4949
Option('mail-to', type=str,
4950
help='Instead of printing the directive, email to this address.'),
4951
Option('message', type=str, short_name='m',
4952
help='Message to use when committing this merge.')
4955
encoding_type = 'exact'
4957
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4958
sign=False, revision=None, mail_to=None, message=None):
4959
from bzrlib.revision import ensure_null, NULL_REVISION
4960
include_patch, include_bundle = {
4961
'plain': (False, False),
4962
'diff': (True, False),
4963
'bundle': (True, True),
4965
branch = Branch.open('.')
4966
stored_submit_branch = branch.get_submit_branch()
4967
if submit_branch is None:
4968
submit_branch = stored_submit_branch
4970
if stored_submit_branch is None:
4971
branch.set_submit_branch(submit_branch)
4972
if submit_branch is None:
4973
submit_branch = branch.get_parent()
4974
if submit_branch is None:
4975
raise errors.BzrCommandError('No submit branch specified or known')
4977
stored_public_branch = branch.get_public_branch()
4978
if public_branch is None:
4979
public_branch = stored_public_branch
4980
elif stored_public_branch is None:
4981
branch.set_public_branch(public_branch)
4982
if not include_bundle and public_branch is None:
4983
raise errors.BzrCommandError('No public branch specified or'
4985
base_revision_id = None
4986
if revision is not None:
4987
if len(revision) > 2:
4988
raise errors.BzrCommandError('bzr merge-directive takes '
4989
'at most two one revision identifiers')
4990
revision_id = revision[-1].as_revision_id(branch)
4991
if len(revision) == 2:
4992
base_revision_id = revision[0].as_revision_id(branch)
4994
revision_id = branch.last_revision()
4995
revision_id = ensure_null(revision_id)
4996
if revision_id == NULL_REVISION:
4997
raise errors.BzrCommandError('No revisions to bundle.')
4998
directive = merge_directive.MergeDirective2.from_objects(
4999
branch.repository, revision_id, time.time(),
5000
osutils.local_time_offset(), submit_branch,
5001
public_branch=public_branch, include_patch=include_patch,
5002
include_bundle=include_bundle, message=message,
5003
base_revision_id=base_revision_id)
5006
self.outf.write(directive.to_signed(branch))
5008
self.outf.writelines(directive.to_lines())
5010
message = directive.to_email(mail_to, branch, sign)
5011
s = SMTPConnection(branch.get_config())
5012
s.send_email(message)
5015
class cmd_send(Command):
5016
"""Mail or create a merge-directive for submitting changes.
5018
A merge directive provides many things needed for requesting merges:
5020
* A machine-readable description of the merge to perform
5022
* An optional patch that is a preview of the changes requested
5024
* An optional bundle of revision data, so that the changes can be applied
5025
directly from the merge directive, without retrieving data from a
5028
If --no-bundle is specified, then public_branch is needed (and must be
5029
up-to-date), so that the receiver can perform the merge using the
5030
public_branch. The public_branch is always included if known, so that
5031
people can check it later.
5033
The submit branch defaults to the parent, but can be overridden. Both
5034
submit branch and public branch will be remembered if supplied.
5036
If a public_branch is known for the submit_branch, that public submit
5037
branch is used in the merge instructions. This means that a local mirror
5038
can be used as your actual submit branch, once you have set public_branch
5041
Mail is sent using your preferred mail program. This should be transparent
5042
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5043
If the preferred client can't be found (or used), your editor will be used.
5045
To use a specific mail program, set the mail_client configuration option.
5046
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5047
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5048
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5049
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5052
If mail is being sent, a to address is required. This can be supplied
5053
either on the commandline, by setting the submit_to configuration
5054
option in the branch itself or the child_submit_to configuration option
5055
in the submit branch.
5057
Two formats are currently supported: "4" uses revision bundle format 4 and
5058
merge directive format 2. It is significantly faster and smaller than
5059
older formats. It is compatible with Bazaar 0.19 and later. It is the
5060
default. "0.9" uses revision bundle format 0.9 and merge directive
5061
format 1. It is compatible with Bazaar 0.12 - 0.18.
5063
The merge directives created by bzr send may be applied using bzr merge or
5064
bzr pull by specifying a file containing a merge directive as the location.
5067
encoding_type = 'exact'
5069
_see_also = ['merge', 'pull']
5071
takes_args = ['submit_branch?', 'public_branch?']
5075
help='Do not include a bundle in the merge directive.'),
5076
Option('no-patch', help='Do not include a preview patch in the merge'
5079
help='Remember submit and public branch.'),
5081
help='Branch to generate the submission from, '
5082
'rather than the one containing the working directory.',
5085
Option('output', short_name='o',
5086
help='Write merge directive to this file; '
5087
'use - for stdout.',
5090
help='Refuse to send if there are uncommitted changes in'
5091
' the working tree, --no-strict disables the check.'),
5092
Option('mail-to', help='Mail the request to this address.',
5096
Option('body', help='Body for the email.', type=unicode),
5097
RegistryOption('format',
5098
help='Use the specified output format.',
5099
lazy_registry=('bzrlib.send', 'format_registry')),
5102
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5103
no_patch=False, revision=None, remember=False, output=None,
5104
format=None, mail_to=None, message=None, body=None,
5105
strict=None, **kwargs):
5106
from bzrlib.send import send
5107
return send(submit_branch, revision, public_branch, remember,
5108
format, no_bundle, no_patch, output,
5109
kwargs.get('from', '.'), mail_to, message, body,
5114
class cmd_bundle_revisions(cmd_send):
5115
"""Create a merge-directive for submitting changes.
5117
A merge directive provides many things needed for requesting merges:
5119
* A machine-readable description of the merge to perform
5121
* An optional patch that is a preview of the changes requested
5123
* An optional bundle of revision data, so that the changes can be applied
5124
directly from the merge directive, without retrieving data from a
5127
If --no-bundle is specified, then public_branch is needed (and must be
5128
up-to-date), so that the receiver can perform the merge using the
5129
public_branch. The public_branch is always included if known, so that
5130
people can check it later.
5132
The submit branch defaults to the parent, but can be overridden. Both
5133
submit branch and public branch will be remembered if supplied.
5135
If a public_branch is known for the submit_branch, that public submit
5136
branch is used in the merge instructions. This means that a local mirror
5137
can be used as your actual submit branch, once you have set public_branch
5140
Two formats are currently supported: "4" uses revision bundle format 4 and
5141
merge directive format 2. It is significantly faster and smaller than
5142
older formats. It is compatible with Bazaar 0.19 and later. It is the
5143
default. "0.9" uses revision bundle format 0.9 and merge directive
5144
format 1. It is compatible with Bazaar 0.12 - 0.18.
5149
help='Do not include a bundle in the merge directive.'),
5150
Option('no-patch', help='Do not include a preview patch in the merge'
5153
help='Remember submit and public branch.'),
5155
help='Branch to generate the submission from, '
5156
'rather than the one containing the working directory.',
5159
Option('output', short_name='o', help='Write directive to this file.',
5162
help='Refuse to bundle revisions if there are uncommitted'
5163
' changes in the working tree, --no-strict disables the check.'),
5165
RegistryOption('format',
5166
help='Use the specified output format.',
5167
lazy_registry=('bzrlib.send', 'format_registry')),
5169
aliases = ['bundle']
5171
_see_also = ['send', 'merge']
5175
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5176
no_patch=False, revision=None, remember=False, output=None,
5177
format=None, strict=None, **kwargs):
5180
from bzrlib.send import send
5181
return send(submit_branch, revision, public_branch, remember,
5182
format, no_bundle, no_patch, output,
5183
kwargs.get('from', '.'), None, None, None,
5184
self.outf, strict=strict)
5187
class cmd_tag(Command):
5188
"""Create, remove or modify a tag naming a revision.
5190
Tags give human-meaningful names to revisions. Commands that take a -r
5191
(--revision) option can be given -rtag:X, where X is any previously
5194
Tags are stored in the branch. Tags are copied from one branch to another
5195
along when you branch, push, pull or merge.
5197
It is an error to give a tag name that already exists unless you pass
5198
--force, in which case the tag is moved to point to the new revision.
5200
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5201
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5204
_see_also = ['commit', 'tags']
5205
takes_args = ['tag_name']
5208
help='Delete this tag rather than placing it.',
5211
help='Branch in which to place the tag.',
5216
help='Replace existing tags.',
5221
def run(self, tag_name,
5227
branch, relpath = Branch.open_containing(directory)
5231
branch.tags.delete_tag(tag_name)
5232
self.outf.write('Deleted tag %s.\n' % tag_name)
5235
if len(revision) != 1:
5236
raise errors.BzrCommandError(
5237
"Tags can only be placed on a single revision, "
5239
revision_id = revision[0].as_revision_id(branch)
5241
revision_id = branch.last_revision()
5242
if (not force) and branch.tags.has_tag(tag_name):
5243
raise errors.TagAlreadyExists(tag_name)
5244
branch.tags.set_tag(tag_name, revision_id)
5245
self.outf.write('Created tag %s.\n' % tag_name)
5250
class cmd_tags(Command):
5253
This command shows a table of tag names and the revisions they reference.
5259
help='Branch whose tags should be displayed.',
5263
RegistryOption.from_kwargs('sort',
5264
'Sort tags by different criteria.', title='Sorting',
5265
alpha='Sort tags lexicographically (default).',
5266
time='Sort tags chronologically.',
5279
branch, relpath = Branch.open_containing(directory)
5281
tags = branch.tags.get_tag_dict().items()
5288
graph = branch.repository.get_graph()
5289
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5290
revid1, revid2 = rev1.rev_id, rev2.rev_id
5291
# only show revisions between revid1 and revid2 (inclusive)
5292
tags = [(tag, revid) for tag, revid in tags if
5293
graph.is_between(revid, revid1, revid2)]
5296
elif sort == 'time':
5298
for tag, revid in tags:
5300
revobj = branch.repository.get_revision(revid)
5301
except errors.NoSuchRevision:
5302
timestamp = sys.maxint # place them at the end
5304
timestamp = revobj.timestamp
5305
timestamps[revid] = timestamp
5306
tags.sort(key=lambda x: timestamps[x[1]])
5308
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5309
for index, (tag, revid) in enumerate(tags):
5311
revno = branch.revision_id_to_dotted_revno(revid)
5312
if isinstance(revno, tuple):
5313
revno = '.'.join(map(str, revno))
5314
except errors.NoSuchRevision:
5315
# Bad tag data/merges can lead to tagged revisions
5316
# which are not in this branch. Fail gracefully ...
5318
tags[index] = (tag, revno)
5321
for tag, revspec in tags:
5322
self.outf.write('%-20s %s\n' % (tag, revspec))
5325
class cmd_reconfigure(Command):
5326
"""Reconfigure the type of a bzr directory.
5328
A target configuration must be specified.
5330
For checkouts, the bind-to location will be auto-detected if not specified.
5331
The order of preference is
5332
1. For a lightweight checkout, the current bound location.
5333
2. For branches that used to be checkouts, the previously-bound location.
5334
3. The push location.
5335
4. The parent location.
5336
If none of these is available, --bind-to must be specified.
5339
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5340
takes_args = ['location?']
5342
RegistryOption.from_kwargs(
5344
title='Target type',
5345
help='The type to reconfigure the directory to.',
5346
value_switches=True, enum_switch=False,
5347
branch='Reconfigure to be an unbound branch with no working tree.',
5348
tree='Reconfigure to be an unbound branch with a working tree.',
5349
checkout='Reconfigure to be a bound branch with a working tree.',
5350
lightweight_checkout='Reconfigure to be a lightweight'
5351
' checkout (with no local history).',
5352
standalone='Reconfigure to be a standalone branch '
5353
'(i.e. stop using shared repository).',
5354
use_shared='Reconfigure to use a shared repository.',
5355
with_trees='Reconfigure repository to create '
5356
'working trees on branches by default.',
5357
with_no_trees='Reconfigure repository to not create '
5358
'working trees on branches by default.'
5360
Option('bind-to', help='Branch to bind checkout to.', type=str),
5362
help='Perform reconfiguration even if local changes'
5364
Option('stacked-on',
5365
help='Reconfigure a branch to be stacked on another branch.',
5369
help='Reconfigure a branch to be unstacked. This '
5370
'may require copying substantial data into it.',
5374
def run(self, location=None, target_type=None, bind_to=None, force=False,
5377
directory = bzrdir.BzrDir.open(location)
5378
if stacked_on and unstacked:
5379
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5380
elif stacked_on is not None:
5381
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5383
reconfigure.ReconfigureUnstacked().apply(directory)
5384
# At the moment you can use --stacked-on and a different
5385
# reconfiguration shape at the same time; there seems no good reason
5387
if target_type is None:
5388
if stacked_on or unstacked:
5391
raise errors.BzrCommandError('No target configuration '
5393
elif target_type == 'branch':
5394
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5395
elif target_type == 'tree':
5396
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5397
elif target_type == 'checkout':
5398
reconfiguration = reconfigure.Reconfigure.to_checkout(
5400
elif target_type == 'lightweight-checkout':
5401
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5403
elif target_type == 'use-shared':
5404
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5405
elif target_type == 'standalone':
5406
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5407
elif target_type == 'with-trees':
5408
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5410
elif target_type == 'with-no-trees':
5411
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5413
reconfiguration.apply(force)
5416
class cmd_switch(Command):
5417
"""Set the branch of a checkout and update.
5419
For lightweight checkouts, this changes the branch being referenced.
5420
For heavyweight checkouts, this checks that there are no local commits
5421
versus the current bound branch, then it makes the local branch a mirror
5422
of the new location and binds to it.
5424
In both cases, the working tree is updated and uncommitted changes
5425
are merged. The user can commit or revert these as they desire.
5427
Pending merges need to be committed or reverted before using switch.
5429
The path to the branch to switch to can be specified relative to the parent
5430
directory of the current branch. For example, if you are currently in a
5431
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5434
Bound branches use the nickname of its master branch unless it is set
5435
locally, in which case switching will update the local nickname to be
5439
takes_args = ['to_location']
5440
takes_options = [Option('force',
5441
help='Switch even if local commits will be lost.'),
5442
Option('create-branch', short_name='b',
5443
help='Create the target branch from this one before'
5444
' switching to it.'),
5447
def run(self, to_location, force=False, create_branch=False):
5448
from bzrlib import switch
5450
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5452
branch = control_dir.open_branch()
5453
had_explicit_nick = branch.get_config().has_explicit_nickname()
5454
except errors.NotBranchError:
5456
had_explicit_nick = False
5459
raise errors.BzrCommandError('cannot create branch without'
5461
if '/' not in to_location and '\\' not in to_location:
5462
# This path is meant to be relative to the existing branch
5463
this_url = self._get_branch_location(control_dir)
5464
to_location = urlutils.join(this_url, '..', to_location)
5465
to_branch = branch.bzrdir.sprout(to_location,
5466
possible_transports=[branch.bzrdir.root_transport],
5467
source_branch=branch).open_branch()
5469
# from_branch = control_dir.open_branch()
5470
# except errors.NotBranchError:
5471
# raise BzrCommandError('Cannot create a branch from this'
5472
# ' location when we cannot open this branch')
5473
# from_branch.bzrdir.sprout(
5477
to_branch = Branch.open(to_location)
5478
except errors.NotBranchError:
5479
this_url = self._get_branch_location(control_dir)
5480
to_branch = Branch.open(
5481
urlutils.join(this_url, '..', to_location))
5482
switch.switch(control_dir, to_branch, force)
5483
if had_explicit_nick:
5484
branch = control_dir.open_branch() #get the new branch!
5485
branch.nick = to_branch.nick
5486
note('Switched to branch: %s',
5487
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5489
def _get_branch_location(self, control_dir):
5490
"""Return location of branch for this control dir."""
5492
this_branch = control_dir.open_branch()
5493
# This may be a heavy checkout, where we want the master branch
5494
master_location = this_branch.get_bound_location()
5495
if master_location is not None:
5496
return master_location
5497
# If not, use a local sibling
5498
return this_branch.base
5499
except errors.NotBranchError:
5500
format = control_dir.find_branch_format()
5501
if getattr(format, 'get_reference', None) is not None:
5502
return format.get_reference(control_dir)
5504
return control_dir.root_transport.base
5507
class cmd_view(Command):
5508
"""Manage filtered views.
5510
Views provide a mask over the tree so that users can focus on
5511
a subset of a tree when doing their work. After creating a view,
5512
commands that support a list of files - status, diff, commit, etc -
5513
effectively have that list of files implicitly given each time.
5514
An explicit list of files can still be given but those files
5515
must be within the current view.
5517
In most cases, a view has a short life-span: it is created to make
5518
a selected change and is deleted once that change is committed.
5519
At other times, you may wish to create one or more named views
5520
and switch between them.
5522
To disable the current view without deleting it, you can switch to
5523
the pseudo view called ``off``. This can be useful when you need
5524
to see the whole tree for an operation or two (e.g. merge) but
5525
want to switch back to your view after that.
5528
To define the current view::
5530
bzr view file1 dir1 ...
5532
To list the current view::
5536
To delete the current view::
5540
To disable the current view without deleting it::
5542
bzr view --switch off
5544
To define a named view and switch to it::
5546
bzr view --name view-name file1 dir1 ...
5548
To list a named view::
5550
bzr view --name view-name
5552
To delete a named view::
5554
bzr view --name view-name --delete
5556
To switch to a named view::
5558
bzr view --switch view-name
5560
To list all views defined::
5564
To delete all views::
5566
bzr view --delete --all
5570
takes_args = ['file*']
5573
help='Apply list or delete action to all views.',
5576
help='Delete the view.',
5579
help='Name of the view to define, list or delete.',
5583
help='Name of the view to switch to.',
5588
def run(self, file_list,
5594
tree, file_list = tree_files(file_list, apply_view=False)
5595
current_view, view_dict = tree.views.get_view_info()
5600
raise errors.BzrCommandError(
5601
"Both --delete and a file list specified")
5603
raise errors.BzrCommandError(
5604
"Both --delete and --switch specified")
5606
tree.views.set_view_info(None, {})
5607
self.outf.write("Deleted all views.\n")
5609
raise errors.BzrCommandError("No current view to delete")
5611
tree.views.delete_view(name)
5612
self.outf.write("Deleted '%s' view.\n" % name)
5615
raise errors.BzrCommandError(
5616
"Both --switch and a file list specified")
5618
raise errors.BzrCommandError(
5619
"Both --switch and --all specified")
5620
elif switch == 'off':
5621
if current_view is None:
5622
raise errors.BzrCommandError("No current view to disable")
5623
tree.views.set_view_info(None, view_dict)
5624
self.outf.write("Disabled '%s' view.\n" % (current_view))
5626
tree.views.set_view_info(switch, view_dict)
5627
view_str = views.view_display_str(tree.views.lookup_view())
5628
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5631
self.outf.write('Views defined:\n')
5632
for view in sorted(view_dict):
5633
if view == current_view:
5637
view_str = views.view_display_str(view_dict[view])
5638
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5640
self.outf.write('No views defined.\n')
5643
# No name given and no current view set
5646
raise errors.BzrCommandError(
5647
"Cannot change the 'off' pseudo view")
5648
tree.views.set_view(name, sorted(file_list))
5649
view_str = views.view_display_str(tree.views.lookup_view())
5650
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5654
# No name given and no current view set
5655
self.outf.write('No current view.\n')
5657
view_str = views.view_display_str(tree.views.lookup_view(name))
5658
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5661
class cmd_hooks(Command):
5667
for hook_key in sorted(hooks.known_hooks.keys()):
5668
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5669
self.outf.write("%s:\n" % type(some_hooks).__name__)
5670
for hook_name, hook_point in sorted(some_hooks.items()):
5671
self.outf.write(" %s:\n" % (hook_name,))
5672
found_hooks = list(hook_point)
5674
for hook in found_hooks:
5675
self.outf.write(" %s\n" %
5676
(some_hooks.get_hook_name(hook),))
5678
self.outf.write(" <no hooks installed>\n")
5681
class cmd_shelve(Command):
5682
"""Temporarily set aside some changes from the current tree.
5684
Shelve allows you to temporarily put changes you've made "on the shelf",
5685
ie. out of the way, until a later time when you can bring them back from
5686
the shelf with the 'unshelve' command. The changes are stored alongside
5687
your working tree, and so they aren't propagated along with your branch nor
5688
will they survive its deletion.
5690
If shelve --list is specified, previously-shelved changes are listed.
5692
Shelve is intended to help separate several sets of changes that have
5693
been inappropriately mingled. If you just want to get rid of all changes
5694
and you don't need to restore them later, use revert. If you want to
5695
shelve all text changes at once, use shelve --all.
5697
If filenames are specified, only the changes to those files will be
5698
shelved. Other files will be left untouched.
5700
If a revision is specified, changes since that revision will be shelved.
5702
You can put multiple items on the shelf, and by default, 'unshelve' will
5703
restore the most recently shelved changes.
5706
takes_args = ['file*']
5710
Option('all', help='Shelve all changes.'),
5712
RegistryOption('writer', 'Method to use for writing diffs.',
5713
bzrlib.option.diff_writer_registry,
5714
value_switches=True, enum_switch=False),
5716
Option('list', help='List shelved changes.'),
5718
help='Destroy removed changes instead of shelving them.'),
5720
_see_also = ['unshelve']
5722
def run(self, revision=None, all=False, file_list=None, message=None,
5723
writer=None, list=False, destroy=False):
5725
return self.run_for_list()
5726
from bzrlib.shelf_ui import Shelver
5728
writer = bzrlib.option.diff_writer_registry.get()
5730
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5731
file_list, message, destroy=destroy)
5736
except errors.UserAbort:
5739
def run_for_list(self):
5740
tree = WorkingTree.open_containing('.')[0]
5743
manager = tree.get_shelf_manager()
5744
shelves = manager.active_shelves()
5745
if len(shelves) == 0:
5746
note('No shelved changes.')
5748
for shelf_id in reversed(shelves):
5749
message = manager.get_metadata(shelf_id).get('message')
5751
message = '<no message>'
5752
self.outf.write('%3d: %s\n' % (shelf_id, message))
5758
class cmd_unshelve(Command):
5759
"""Restore shelved changes.
5761
By default, the most recently shelved changes are restored. However if you
5762
specify a shelf by id those changes will be restored instead. This works
5763
best when the changes don't depend on each other.
5766
takes_args = ['shelf_id?']
5768
RegistryOption.from_kwargs(
5769
'action', help="The action to perform.",
5770
enum_switch=False, value_switches=True,
5771
apply="Apply changes and remove from the shelf.",
5772
dry_run="Show changes, but do not apply or remove them.",
5773
delete_only="Delete changes without applying them."
5776
_see_also = ['shelve']
5778
def run(self, shelf_id=None, action='apply'):
5779
from bzrlib.shelf_ui import Unshelver
5780
unshelver = Unshelver.from_args(shelf_id, action)
5784
unshelver.tree.unlock()
5787
class cmd_clean_tree(Command):
5788
"""Remove unwanted files from working tree.
5790
By default, only unknown files, not ignored files, are deleted. Versioned
5791
files are never deleted.
5793
Another class is 'detritus', which includes files emitted by bzr during
5794
normal operations and selftests. (The value of these files decreases with
5797
If no options are specified, unknown files are deleted. Otherwise, option
5798
flags are respected, and may be combined.
5800
To check what clean-tree will do, use --dry-run.
5802
takes_options = [Option('ignored', help='Delete all ignored files.'),
5803
Option('detritus', help='Delete conflict files, merge'
5804
' backups, and failed selftest dirs.'),
5806
help='Delete files unknown to bzr (default).'),
5807
Option('dry-run', help='Show files to delete instead of'
5809
Option('force', help='Do not prompt before deleting.')]
5810
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5812
from bzrlib.clean_tree import clean_tree
5813
if not (unknown or ignored or detritus):
5817
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5818
dry_run=dry_run, no_prompt=force)
5821
class cmd_reference(Command):
5822
"""list, view and set branch locations for nested trees.
5824
If no arguments are provided, lists the branch locations for nested trees.
5825
If one argument is provided, display the branch location for that tree.
5826
If two arguments are provided, set the branch location for that tree.
5831
takes_args = ['path?', 'location?']
5833
def run(self, path=None, location=None):
5835
if path is not None:
5837
tree, branch, relpath =(
5838
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5839
if path is not None:
5842
tree = branch.basis_tree()
5844
info = branch._get_all_reference_info().iteritems()
5845
self._display_reference_info(tree, branch, info)
5847
file_id = tree.path2id(path)
5849
raise errors.NotVersionedError(path)
5850
if location is None:
5851
info = [(file_id, branch.get_reference_info(file_id))]
5852
self._display_reference_info(tree, branch, info)
5854
branch.set_reference_info(file_id, path, location)
5856
def _display_reference_info(self, tree, branch, info):
5858
for file_id, (path, location) in info:
5860
path = tree.id2path(file_id)
5861
except errors.NoSuchId:
5863
ref_list.append((path, location))
5864
for path, location in sorted(ref_list):
5865
self.outf.write('%s %s\n' % (path, location))
5868
# these get imported and then picked up by the scan for cmd_*
5869
# TODO: Some more consistent way to split command definitions across files;
5870
# we do need to load at least some information about them to know of
5871
# aliases. ideally we would avoid loading the implementation until the
5872
# details were needed.
5873
from bzrlib.cmd_version_info import cmd_version_info
5874
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5875
from bzrlib.bundle.commands import (
5878
from bzrlib.foreign import cmd_dpush
5879
from bzrlib.sign_my_commits import cmd_sign_my_commits
5880
from bzrlib.weave_commands import cmd_versionedfile_list, \
5881
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
