1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
45
revision as _mod_revision,
54
from bzrlib.branch import Branch
55
from bzrlib.conflicts import ConflictList
56
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
57
from bzrlib.smtp_connection import SMTPConnection
58
from bzrlib.workingtree import WorkingTree
61
from bzrlib.commands import Command, display_command
62
from bzrlib.option import (
69
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
72
def tree_files(file_list, default_branch=u'.', canonicalize=True,
75
return internal_tree_files(file_list, default_branch, canonicalize,
77
except errors.FileInWrongBranch, e:
78
raise errors.BzrCommandError("%s is not in the same branch as %s" %
79
(e.path, file_list[0]))
82
def tree_files_for_add(file_list):
84
Return a tree and list of absolute paths from a file list.
86
Similar to tree_files, but add handles files a bit differently, so it a
87
custom implementation. In particular, MutableTreeTree.smart_add expects
88
absolute paths, which it immediately converts to relative paths.
90
# FIXME Would be nice to just return the relative paths like
91
# internal_tree_files does, but there are a large number of unit tests
92
# that assume the current interface to mutabletree.smart_add
94
tree, relpath = WorkingTree.open_containing(file_list[0])
95
if tree.supports_views():
96
view_files = tree.views.lookup_view()
98
for filename in file_list:
99
if not osutils.is_inside_any(view_files, filename):
100
raise errors.FileOutsideView(filename, view_files)
101
file_list = file_list[:]
102
file_list[0] = tree.abspath(relpath)
104
tree = WorkingTree.open_containing(u'.')[0]
105
if tree.supports_views():
106
view_files = tree.views.lookup_view()
108
file_list = view_files
109
view_str = views.view_display_str(view_files)
110
note("Ignoring files outside view. View is %s" % view_str)
111
return tree, file_list
114
def _get_one_revision(command_name, revisions):
115
if revisions is None:
117
if len(revisions) != 1:
118
raise errors.BzrCommandError(
119
'bzr %s --revision takes exactly one revision identifier' % (
124
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
125
"""Get a revision tree. Not suitable for commands that change the tree.
127
Specifically, the basis tree in dirstate trees is coupled to the dirstate
128
and doing a commit/uncommit/pull will at best fail due to changing the
131
If tree is passed in, it should be already locked, for lifetime management
132
of the trees internal cached state.
136
if revisions is None:
138
rev_tree = tree.basis_tree()
140
rev_tree = branch.basis_tree()
142
revision = _get_one_revision(command_name, revisions)
143
rev_tree = revision.as_tree(branch)
147
# XXX: Bad function name; should possibly also be a class method of
148
# WorkingTree rather than a function.
149
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
151
"""Convert command-line paths to a WorkingTree and relative paths.
153
This is typically used for command-line processors that take one or
154
more filenames, and infer the workingtree that contains them.
156
The filenames given are not required to exist.
158
:param file_list: Filenames to convert.
160
:param default_branch: Fallback tree path to use if file_list is empty or
163
:param apply_view: if True and a view is set, apply it or check that
164
specified files are within it
166
:return: workingtree, [relative_paths]
168
if file_list is None or len(file_list) == 0:
169
tree = WorkingTree.open_containing(default_branch)[0]
170
if tree.supports_views() and apply_view:
171
view_files = tree.views.lookup_view()
173
file_list = view_files
174
view_str = views.view_display_str(view_files)
175
note("Ignoring files outside view. View is %s" % view_str)
176
return tree, file_list
177
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
178
return tree, safe_relpath_files(tree, file_list, canonicalize,
179
apply_view=apply_view)
182
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
183
"""Convert file_list into a list of relpaths in tree.
185
:param tree: A tree to operate on.
186
:param file_list: A list of user provided paths or None.
187
:param apply_view: if True and a view is set, apply it or check that
188
specified files are within it
189
:return: A list of relative paths.
190
:raises errors.PathNotChild: When a provided path is in a different tree
193
if file_list is None:
195
if tree.supports_views() and apply_view:
196
view_files = tree.views.lookup_view()
200
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
201
# doesn't - fix that up here before we enter the loop.
203
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
206
for filename in file_list:
208
relpath = fixer(osutils.dereference_path(filename))
209
if view_files and not osutils.is_inside_any(view_files, relpath):
210
raise errors.FileOutsideView(filename, view_files)
211
new_list.append(relpath)
212
except errors.PathNotChild:
213
raise errors.FileInWrongBranch(tree.branch, filename)
217
def _get_view_info_for_change_reporter(tree):
218
"""Get the view information from a tree for change reporting."""
221
current_view = tree.views.get_view_info()[0]
222
if current_view is not None:
223
view_info = (current_view, tree.views.lookup_view())
224
except errors.ViewsNotSupported:
229
# TODO: Make sure no commands unconditionally use the working directory as a
230
# branch. If a filename argument is used, the first of them should be used to
231
# specify the branch. (Perhaps this can be factored out into some kind of
232
# Argument class, representing a file in a branch, where the first occurrence
235
class cmd_status(Command):
236
"""Display status summary.
238
This reports on versioned and unknown files, reporting them
239
grouped by state. Possible states are:
242
Versioned in the working copy but not in the previous revision.
245
Versioned in the previous revision but removed or deleted
249
Path of this file changed from the previous revision;
250
the text may also have changed. This includes files whose
251
parent directory was renamed.
254
Text has changed since the previous revision.
257
File kind has been changed (e.g. from file to directory).
260
Not versioned and not matching an ignore pattern.
262
Additionally for directories, symlinks and files with an executable
263
bit, Bazaar indicates their type using a trailing character: '/', '@'
266
To see ignored files use 'bzr ignored'. For details on the
267
changes to file texts, use 'bzr diff'.
269
Note that --short or -S gives status flags for each item, similar
270
to Subversion's status command. To get output similar to svn -q,
273
If no arguments are specified, the status of the entire working
274
directory is shown. Otherwise, only the status of the specified
275
files or directories is reported. If a directory is given, status
276
is reported for everything inside that directory.
278
Before merges are committed, the pending merge tip revisions are
279
shown. To see all pending merge revisions, use the -v option.
280
To skip the display of pending merge information altogether, use
281
the no-pending option or specify a file/directory.
283
If a revision argument is given, the status is calculated against
284
that revision, or between two revisions if two are provided.
287
# TODO: --no-recurse, --recurse options
289
takes_args = ['file*']
290
takes_options = ['show-ids', 'revision', 'change', 'verbose',
291
Option('short', help='Use short status indicators.',
293
Option('versioned', help='Only show versioned files.',
295
Option('no-pending', help='Don\'t show pending merges.',
298
aliases = ['st', 'stat']
300
encoding_type = 'replace'
301
_see_also = ['diff', 'revert', 'status-flags']
304
def run(self, show_ids=False, file_list=None, revision=None, short=False,
305
versioned=False, no_pending=False, verbose=False):
306
from bzrlib.status import show_tree_status
308
if revision and len(revision) > 2:
309
raise errors.BzrCommandError('bzr status --revision takes exactly'
310
' one or two revision specifiers')
312
tree, relfile_list = tree_files(file_list)
313
# Avoid asking for specific files when that is not needed.
314
if relfile_list == ['']:
316
# Don't disable pending merges for full trees other than '.'.
317
if file_list == ['.']:
319
# A specific path within a tree was given.
320
elif relfile_list is not None:
322
show_tree_status(tree, show_ids=show_ids,
323
specific_files=relfile_list, revision=revision,
324
to_file=self.outf, short=short, versioned=versioned,
325
show_pending=(not no_pending), verbose=verbose)
328
class cmd_cat_revision(Command):
329
"""Write out metadata for a revision.
331
The revision to print can either be specified by a specific
332
revision identifier, or you can use --revision.
336
takes_args = ['revision_id?']
337
takes_options = ['revision']
338
# cat-revision is more for frontends so should be exact
342
def run(self, revision_id=None, revision=None):
343
if revision_id is not None and revision is not None:
344
raise errors.BzrCommandError('You can only supply one of'
345
' revision_id or --revision')
346
if revision_id is None and revision is None:
347
raise errors.BzrCommandError('You must supply either'
348
' --revision or a revision_id')
349
b = WorkingTree.open_containing(u'.')[0].branch
351
# TODO: jam 20060112 should cat-revision always output utf-8?
352
if revision_id is not None:
353
revision_id = osutils.safe_revision_id(revision_id, warn=False)
355
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
356
except errors.NoSuchRevision:
357
msg = "The repository %s contains no revision %s." % (b.repository.base,
359
raise errors.BzrCommandError(msg)
360
elif revision is not None:
363
raise errors.BzrCommandError('You cannot specify a NULL'
365
rev_id = rev.as_revision_id(b)
366
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
369
class cmd_dump_btree(Command):
370
"""Dump the contents of a btree index file to stdout.
372
PATH is a btree index file, it can be any URL. This includes things like
373
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
375
By default, the tuples stored in the index file will be displayed. With
376
--raw, we will uncompress the pages, but otherwise display the raw bytes
380
# TODO: Do we want to dump the internal nodes as well?
381
# TODO: It would be nice to be able to dump the un-parsed information,
382
# rather than only going through iter_all_entries. However, this is
383
# good enough for a start
385
encoding_type = 'exact'
386
takes_args = ['path']
387
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
388
' rather than the parsed tuples.'),
391
def run(self, path, raw=False):
392
dirname, basename = osutils.split(path)
393
t = transport.get_transport(dirname)
395
self._dump_raw_bytes(t, basename)
397
self._dump_entries(t, basename)
399
def _get_index_and_bytes(self, trans, basename):
400
"""Create a BTreeGraphIndex and raw bytes."""
401
bt = btree_index.BTreeGraphIndex(trans, basename, None)
402
bytes = trans.get_bytes(basename)
403
bt._file = cStringIO.StringIO(bytes)
404
bt._size = len(bytes)
407
def _dump_raw_bytes(self, trans, basename):
410
# We need to parse at least the root node.
411
# This is because the first page of every row starts with an
412
# uncompressed header.
413
bt, bytes = self._get_index_and_bytes(trans, basename)
414
for page_idx, page_start in enumerate(xrange(0, len(bytes),
415
btree_index._PAGE_SIZE)):
416
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
417
page_bytes = bytes[page_start:page_end]
419
self.outf.write('Root node:\n')
420
header_end, data = bt._parse_header_from_bytes(page_bytes)
421
self.outf.write(page_bytes[:header_end])
423
self.outf.write('\nPage %d\n' % (page_idx,))
424
decomp_bytes = zlib.decompress(page_bytes)
425
self.outf.write(decomp_bytes)
426
self.outf.write('\n')
428
def _dump_entries(self, trans, basename):
430
st = trans.stat(basename)
431
except errors.TransportNotPossible:
432
# We can't stat, so we'll fake it because we have to do the 'get()'
434
bt, _ = self._get_index_and_bytes(trans, basename)
436
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
437
for node in bt.iter_all_entries():
438
# Node is made up of:
439
# (index, key, value, [references])
440
refs_as_tuples = static_tuple.as_tuples(node[3])
441
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
442
self.outf.write('%s\n' % (as_tuple,))
445
class cmd_remove_tree(Command):
446
"""Remove the working tree from a given branch/checkout.
448
Since a lightweight checkout is little more than a working tree
449
this will refuse to run against one.
451
To re-create the working tree, use "bzr checkout".
453
_see_also = ['checkout', 'working-trees']
454
takes_args = ['location?']
457
help='Remove the working tree even if it has '
458
'uncommitted changes.'),
461
def run(self, location='.', force=False):
462
d = bzrdir.BzrDir.open(location)
465
working = d.open_workingtree()
466
except errors.NoWorkingTree:
467
raise errors.BzrCommandError("No working tree to remove")
468
except errors.NotLocalUrl:
469
raise errors.BzrCommandError("You cannot remove the working tree"
472
if (working.has_changes()):
473
raise errors.UncommittedChanges(working)
475
working_path = working.bzrdir.root_transport.base
476
branch_path = working.branch.bzrdir.root_transport.base
477
if working_path != branch_path:
478
raise errors.BzrCommandError("You cannot remove the working tree"
479
" from a lightweight checkout")
481
d.destroy_workingtree()
484
class cmd_revno(Command):
485
"""Show current revision number.
487
This is equal to the number of revisions on this branch.
491
takes_args = ['location?']
493
Option('tree', help='Show revno of working tree'),
497
def run(self, tree=False, location=u'.'):
500
wt = WorkingTree.open_containing(location)[0]
502
except (errors.NoWorkingTree, errors.NotLocalUrl):
503
raise errors.NoWorkingTree(location)
505
revid = wt.last_revision()
507
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
508
except errors.NoSuchRevision:
510
revno = ".".join(str(n) for n in revno_t)
514
b = Branch.open_containing(location)[0]
521
self.outf.write(str(revno) + '\n')
524
class cmd_revision_info(Command):
525
"""Show revision number and revision id for a given revision identifier.
528
takes_args = ['revision_info*']
532
help='Branch to examine, '
533
'rather than the one containing the working directory.',
537
Option('tree', help='Show revno of working tree'),
541
def run(self, revision=None, directory=u'.', tree=False,
542
revision_info_list=[]):
545
wt = WorkingTree.open_containing(directory)[0]
548
except (errors.NoWorkingTree, errors.NotLocalUrl):
550
b = Branch.open_containing(directory)[0]
554
if revision is not None:
555
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
556
if revision_info_list is not None:
557
for rev_str in revision_info_list:
558
rev_spec = RevisionSpec.from_string(rev_str)
559
revision_ids.append(rev_spec.as_revision_id(b))
560
# No arguments supplied, default to the last revision
561
if len(revision_ids) == 0:
564
raise errors.NoWorkingTree(directory)
565
revision_ids.append(wt.last_revision())
567
revision_ids.append(b.last_revision())
571
for revision_id in revision_ids:
573
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
574
revno = '.'.join(str(i) for i in dotted_revno)
575
except errors.NoSuchRevision:
577
maxlen = max(maxlen, len(revno))
578
revinfos.append([revno, revision_id])
586
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
589
class cmd_add(Command):
590
"""Add specified files or directories.
592
In non-recursive mode, all the named items are added, regardless
593
of whether they were previously ignored. A warning is given if
594
any of the named files are already versioned.
596
In recursive mode (the default), files are treated the same way
597
but the behaviour for directories is different. Directories that
598
are already versioned do not give a warning. All directories,
599
whether already versioned or not, are searched for files or
600
subdirectories that are neither versioned or ignored, and these
601
are added. This search proceeds recursively into versioned
602
directories. If no names are given '.' is assumed.
604
Therefore simply saying 'bzr add' will version all files that
605
are currently unknown.
607
Adding a file whose parent directory is not versioned will
608
implicitly add the parent, and so on up to the root. This means
609
you should never need to explicitly add a directory, they'll just
610
get added when you add a file in the directory.
612
--dry-run will show which files would be added, but not actually
615
--file-ids-from will try to use the file ids from the supplied path.
616
It looks up ids trying to find a matching parent directory with the
617
same filename, and then by pure path. This option is rarely needed
618
but can be useful when adding the same logical file into two
619
branches that will be merged later (without showing the two different
620
adds as a conflict). It is also useful when merging another project
621
into a subdirectory of this one.
623
Any files matching patterns in the ignore list will not be added
624
unless they are explicitly mentioned.
626
takes_args = ['file*']
629
help="Don't recursively add the contents of directories."),
631
help="Show what would be done, but don't actually do anything."),
633
Option('file-ids-from',
635
help='Lookup file ids from this tree.'),
637
encoding_type = 'replace'
638
_see_also = ['remove', 'ignore']
640
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
645
if file_ids_from is not None:
647
base_tree, base_path = WorkingTree.open_containing(
649
except errors.NoWorkingTree:
650
base_branch, base_path = Branch.open_containing(
652
base_tree = base_branch.basis_tree()
654
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
655
to_file=self.outf, should_print=(not is_quiet()))
657
action = bzrlib.add.AddAction(to_file=self.outf,
658
should_print=(not is_quiet()))
661
base_tree.lock_read()
663
tree, file_list = tree_files_for_add(file_list)
664
added, ignored = tree.smart_add(file_list, not
665
no_recurse, action=action, save=not dry_run)
667
if base_tree is not None:
671
for glob in sorted(ignored.keys()):
672
for path in ignored[glob]:
673
self.outf.write("ignored %s matching \"%s\"\n"
677
class cmd_mkdir(Command):
678
"""Create a new versioned directory.
680
This is equivalent to creating the directory and then adding it.
683
takes_args = ['dir+']
684
encoding_type = 'replace'
686
def run(self, dir_list):
689
wt, dd = WorkingTree.open_containing(d)
691
self.outf.write('added %s\n' % d)
694
class cmd_relpath(Command):
695
"""Show path of a file relative to root"""
697
takes_args = ['filename']
701
def run(self, filename):
702
# TODO: jam 20050106 Can relpath return a munged path if
703
# sys.stdout encoding cannot represent it?
704
tree, relpath = WorkingTree.open_containing(filename)
705
self.outf.write(relpath)
706
self.outf.write('\n')
709
class cmd_inventory(Command):
710
"""Show inventory of the current working copy or a revision.
712
It is possible to limit the output to a particular entry
713
type using the --kind option. For example: --kind file.
715
It is also possible to restrict the list of files to a specific
716
set. For example: bzr inventory --show-ids this/file
725
help='List entries of a particular kind: file, directory, symlink.',
728
takes_args = ['file*']
731
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
732
if kind and kind not in ['file', 'directory', 'symlink']:
733
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
735
revision = _get_one_revision('inventory', revision)
736
work_tree, file_list = tree_files(file_list)
737
work_tree.lock_read()
739
if revision is not None:
740
tree = revision.as_tree(work_tree.branch)
742
extra_trees = [work_tree]
748
if file_list is not None:
749
file_ids = tree.paths2ids(file_list, trees=extra_trees,
750
require_versioned=True)
751
# find_ids_across_trees may include some paths that don't
753
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
754
for file_id in file_ids if file_id in tree)
756
entries = tree.inventory.entries()
759
if tree is not work_tree:
762
for path, entry in entries:
763
if kind and kind != entry.kind:
766
self.outf.write('%-50s %s\n' % (path, entry.file_id))
768
self.outf.write(path)
769
self.outf.write('\n')
772
class cmd_mv(Command):
773
"""Move or rename a file.
776
bzr mv OLDNAME NEWNAME
778
bzr mv SOURCE... DESTINATION
780
If the last argument is a versioned directory, all the other names
781
are moved into it. Otherwise, there must be exactly two arguments
782
and the file is changed to a new name.
784
If OLDNAME does not exist on the filesystem but is versioned and
785
NEWNAME does exist on the filesystem but is not versioned, mv
786
assumes that the file has been manually moved and only updates
787
its internal inventory to reflect that change.
788
The same is valid when moving many SOURCE files to a DESTINATION.
790
Files cannot be moved between branches.
793
takes_args = ['names*']
794
takes_options = [Option("after", help="Move only the bzr identifier"
795
" of the file, because the file has already been moved."),
796
Option('auto', help='Automatically guess renames.'),
797
Option('dry-run', help='Avoid making changes when guessing renames.'),
799
aliases = ['move', 'rename']
800
encoding_type = 'replace'
802
def run(self, names_list, after=False, auto=False, dry_run=False):
804
return self.run_auto(names_list, after, dry_run)
806
raise errors.BzrCommandError('--dry-run requires --auto.')
807
if names_list is None:
809
if len(names_list) < 2:
810
raise errors.BzrCommandError("missing file argument")
811
tree, rel_names = tree_files(names_list, canonicalize=False)
812
tree.lock_tree_write()
814
self._run(tree, names_list, rel_names, after)
818
def run_auto(self, names_list, after, dry_run):
819
if names_list is not None and len(names_list) > 1:
820
raise errors.BzrCommandError('Only one path may be specified to'
823
raise errors.BzrCommandError('--after cannot be specified with'
825
work_tree, file_list = tree_files(names_list, default_branch='.')
826
work_tree.lock_tree_write()
828
rename_map.RenameMap.guess_renames(work_tree, dry_run)
832
def _run(self, tree, names_list, rel_names, after):
833
into_existing = osutils.isdir(names_list[-1])
834
if into_existing and len(names_list) == 2:
836
# a. case-insensitive filesystem and change case of dir
837
# b. move directory after the fact (if the source used to be
838
# a directory, but now doesn't exist in the working tree
839
# and the target is an existing directory, just rename it)
840
if (not tree.case_sensitive
841
and rel_names[0].lower() == rel_names[1].lower()):
842
into_existing = False
845
# 'fix' the case of a potential 'from'
846
from_id = tree.path2id(
847
tree.get_canonical_inventory_path(rel_names[0]))
848
if (not osutils.lexists(names_list[0]) and
849
from_id and inv.get_file_kind(from_id) == "directory"):
850
into_existing = False
853
# move into existing directory
854
# All entries reference existing inventory items, so fix them up
855
# for cicp file-systems.
856
rel_names = tree.get_canonical_inventory_paths(rel_names)
857
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
859
self.outf.write("%s => %s\n" % (src, dest))
861
if len(names_list) != 2:
862
raise errors.BzrCommandError('to mv multiple files the'
863
' destination must be a versioned'
866
# for cicp file-systems: the src references an existing inventory
868
src = tree.get_canonical_inventory_path(rel_names[0])
869
# Find the canonical version of the destination: In all cases, the
870
# parent of the target must be in the inventory, so we fetch the
871
# canonical version from there (we do not always *use* the
872
# canonicalized tail portion - we may be attempting to rename the
874
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
875
dest_parent = osutils.dirname(canon_dest)
876
spec_tail = osutils.basename(rel_names[1])
877
# For a CICP file-system, we need to avoid creating 2 inventory
878
# entries that differ only by case. So regardless of the case
879
# we *want* to use (ie, specified by the user or the file-system),
880
# we must always choose to use the case of any existing inventory
881
# items. The only exception to this is when we are attempting a
882
# case-only rename (ie, canonical versions of src and dest are
884
dest_id = tree.path2id(canon_dest)
885
if dest_id is None or tree.path2id(src) == dest_id:
886
# No existing item we care about, so work out what case we
887
# are actually going to use.
889
# If 'after' is specified, the tail must refer to a file on disk.
891
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
893
# pathjoin with an empty tail adds a slash, which breaks
895
dest_parent_fq = tree.basedir
897
dest_tail = osutils.canonical_relpath(
899
osutils.pathjoin(dest_parent_fq, spec_tail))
901
# not 'after', so case as specified is used
902
dest_tail = spec_tail
904
# Use the existing item so 'mv' fails with AlreadyVersioned.
905
dest_tail = os.path.basename(canon_dest)
906
dest = osutils.pathjoin(dest_parent, dest_tail)
907
mutter("attempting to move %s => %s", src, dest)
908
tree.rename_one(src, dest, after=after)
910
self.outf.write("%s => %s\n" % (src, dest))
913
class cmd_pull(Command):
914
"""Turn this branch into a mirror of another branch.
916
By default, this command only works on branches that have not diverged.
917
Branches are considered diverged if the destination branch's most recent
918
commit is one that has not been merged (directly or indirectly) into the
921
If branches have diverged, you can use 'bzr merge' to integrate the changes
922
from one into the other. Once one branch has merged, the other should
923
be able to pull it again.
925
If you want to replace your local changes and just want your branch to
926
match the remote one, use pull --overwrite. This will work even if the two
927
branches have diverged.
929
If there is no default location set, the first pull will set it. After
930
that, you can omit the location to use the default. To change the
931
default, use --remember. The value will only be saved if the remote
932
location can be accessed.
934
Note: The location can be specified either in the form of a branch,
935
or in the form of a path to a file containing a merge directive generated
939
_see_also = ['push', 'update', 'status-flags', 'send']
940
takes_options = ['remember', 'overwrite', 'revision',
941
custom_help('verbose',
942
help='Show logs of pulled revisions.'),
944
help='Branch to pull into, '
945
'rather than the one containing the working directory.',
950
help="Perform a local pull in a bound "
951
"branch. Local pulls are not applied to "
955
takes_args = ['location?']
956
encoding_type = 'replace'
958
def run(self, location=None, remember=False, overwrite=False,
959
revision=None, verbose=False,
960
directory=None, local=False):
961
# FIXME: too much stuff is in the command class
964
if directory is None:
967
tree_to = WorkingTree.open_containing(directory)[0]
968
branch_to = tree_to.branch
969
except errors.NoWorkingTree:
971
branch_to = Branch.open_containing(directory)[0]
973
if local and not branch_to.get_bound_location():
974
raise errors.LocalRequiresBoundBranch()
976
possible_transports = []
977
if location is not None:
979
mergeable = bundle.read_mergeable_from_url(location,
980
possible_transports=possible_transports)
981
except errors.NotABundle:
984
stored_loc = branch_to.get_parent()
986
if stored_loc is None:
987
raise errors.BzrCommandError("No pull location known or"
990
display_url = urlutils.unescape_for_display(stored_loc,
993
self.outf.write("Using saved parent location: %s\n" % display_url)
994
location = stored_loc
996
revision = _get_one_revision('pull', revision)
997
if mergeable is not None:
998
if revision is not None:
999
raise errors.BzrCommandError(
1000
'Cannot use -r with merge directives or bundles')
1001
mergeable.install_revisions(branch_to.repository)
1002
base_revision_id, revision_id, verified = \
1003
mergeable.get_merge_request(branch_to.repository)
1004
branch_from = branch_to
1006
branch_from = Branch.open(location,
1007
possible_transports=possible_transports)
1009
if branch_to.get_parent() is None or remember:
1010
branch_to.set_parent(branch_from.base)
1012
if branch_from is not branch_to:
1013
branch_from.lock_read()
1015
if revision is not None:
1016
revision_id = revision.as_revision_id(branch_from)
1018
branch_to.lock_write()
1020
if tree_to is not None:
1021
view_info = _get_view_info_for_change_reporter(tree_to)
1022
change_reporter = delta._ChangeReporter(
1023
unversioned_filter=tree_to.is_ignored,
1024
view_info=view_info)
1025
result = tree_to.pull(
1026
branch_from, overwrite, revision_id, change_reporter,
1027
possible_transports=possible_transports, local=local)
1029
result = branch_to.pull(
1030
branch_from, overwrite, revision_id, local=local)
1032
result.report(self.outf)
1033
if verbose and result.old_revid != result.new_revid:
1034
log.show_branch_change(
1035
branch_to, self.outf, result.old_revno,
1040
if branch_from is not branch_to:
1041
branch_from.unlock()
1044
class cmd_push(Command):
1045
"""Update a mirror of this branch.
1047
The target branch will not have its working tree populated because this
1048
is both expensive, and is not supported on remote file systems.
1050
Some smart servers or protocols *may* put the working tree in place in
1053
This command only works on branches that have not diverged. Branches are
1054
considered diverged if the destination branch's most recent commit is one
1055
that has not been merged (directly or indirectly) by the source branch.
1057
If branches have diverged, you can use 'bzr push --overwrite' to replace
1058
the other branch completely, discarding its unmerged changes.
1060
If you want to ensure you have the different changes in the other branch,
1061
do a merge (see bzr help merge) from the other branch, and commit that.
1062
After that you will be able to do a push without '--overwrite'.
1064
If there is no default push location set, the first push will set it.
1065
After that, you can omit the location to use the default. To change the
1066
default, use --remember. The value will only be saved if the remote
1067
location can be accessed.
1070
_see_also = ['pull', 'update', 'working-trees']
1071
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1072
Option('create-prefix',
1073
help='Create the path leading up to the branch '
1074
'if it does not already exist.'),
1076
help='Branch to push from, '
1077
'rather than the one containing the working directory.',
1081
Option('use-existing-dir',
1082
help='By default push will fail if the target'
1083
' directory exists, but does not already'
1084
' have a control directory. This flag will'
1085
' allow push to proceed.'),
1087
help='Create a stacked branch that references the public location '
1088
'of the parent branch.'),
1089
Option('stacked-on',
1090
help='Create a stacked branch that refers to another branch '
1091
'for the commit history. Only the work not present in the '
1092
'referenced branch is included in the branch created.',
1095
help='Refuse to push if there are uncommitted changes in'
1096
' the working tree, --no-strict disables the check.'),
1098
takes_args = ['location?']
1099
encoding_type = 'replace'
1101
def run(self, location=None, remember=False, overwrite=False,
1102
create_prefix=False, verbose=False, revision=None,
1103
use_existing_dir=False, directory=None, stacked_on=None,
1104
stacked=False, strict=None):
1105
from bzrlib.push import _show_push_branch
1107
if directory is None:
1109
# Get the source branch
1111
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1113
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1114
if strict is None: strict = True # default value
1115
# Get the tip's revision_id
1116
revision = _get_one_revision('push', revision)
1117
if revision is not None:
1118
revision_id = revision.in_history(br_from).rev_id
1121
if strict and tree is not None and revision_id is None:
1122
if (tree.has_changes()):
1123
raise errors.UncommittedChanges(
1124
tree, more='Use --no-strict to force the push.')
1125
if tree.last_revision() != tree.branch.last_revision():
1126
# The tree has lost sync with its branch, there is little
1127
# chance that the user is aware of it but he can still force
1128
# the push with --no-strict
1129
raise errors.OutOfDateTree(
1130
tree, more='Use --no-strict to force the push.')
1132
# Get the stacked_on branch, if any
1133
if stacked_on is not None:
1134
stacked_on = urlutils.normalize_url(stacked_on)
1136
parent_url = br_from.get_parent()
1138
parent = Branch.open(parent_url)
1139
stacked_on = parent.get_public_branch()
1141
# I considered excluding non-http url's here, thus forcing
1142
# 'public' branches only, but that only works for some
1143
# users, so it's best to just depend on the user spotting an
1144
# error by the feedback given to them. RBC 20080227.
1145
stacked_on = parent_url
1147
raise errors.BzrCommandError(
1148
"Could not determine branch to refer to.")
1150
# Get the destination location
1151
if location is None:
1152
stored_loc = br_from.get_push_location()
1153
if stored_loc is None:
1154
raise errors.BzrCommandError(
1155
"No push location known or specified.")
1157
display_url = urlutils.unescape_for_display(stored_loc,
1159
self.outf.write("Using saved push location: %s\n" % display_url)
1160
location = stored_loc
1162
_show_push_branch(br_from, revision_id, location, self.outf,
1163
verbose=verbose, overwrite=overwrite, remember=remember,
1164
stacked_on=stacked_on, create_prefix=create_prefix,
1165
use_existing_dir=use_existing_dir)
1168
class cmd_branch(Command):
1169
"""Create a new branch that is a copy of an existing branch.
1171
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1172
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1173
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1174
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1175
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1178
To retrieve the branch as of a particular revision, supply the --revision
1179
parameter, as in "branch foo/bar -r 5".
1182
_see_also = ['checkout']
1183
takes_args = ['from_location', 'to_location?']
1184
takes_options = ['revision', Option('hardlink',
1185
help='Hard-link working tree files where possible.'),
1187
help="Create a branch without a working-tree."),
1189
help="Switch the checkout in the current directory "
1190
"to the new branch."),
1192
help='Create a stacked branch referring to the source branch. '
1193
'The new branch will depend on the availability of the source '
1194
'branch for all operations.'),
1195
Option('standalone',
1196
help='Do not use a shared repository, even if available.'),
1197
Option('use-existing-dir',
1198
help='By default branch will fail if the target'
1199
' directory exists, but does not already'
1200
' have a control directory. This flag will'
1201
' allow branch to proceed.'),
1203
aliases = ['get', 'clone']
1205
def run(self, from_location, to_location=None, revision=None,
1206
hardlink=False, stacked=False, standalone=False, no_tree=False,
1207
use_existing_dir=False, switch=False):
1208
from bzrlib import switch as _mod_switch
1209
from bzrlib.tag import _merge_tags_if_possible
1210
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1212
revision = _get_one_revision('branch', revision)
1215
if revision is not None:
1216
revision_id = revision.as_revision_id(br_from)
1218
# FIXME - wt.last_revision, fallback to branch, fall back to
1219
# None or perhaps NULL_REVISION to mean copy nothing
1221
revision_id = br_from.last_revision()
1222
if to_location is None:
1223
to_location = urlutils.derive_to_location(from_location)
1224
to_transport = transport.get_transport(to_location)
1226
to_transport.mkdir('.')
1227
except errors.FileExists:
1228
if not use_existing_dir:
1229
raise errors.BzrCommandError('Target directory "%s" '
1230
'already exists.' % to_location)
1233
bzrdir.BzrDir.open_from_transport(to_transport)
1234
except errors.NotBranchError:
1237
raise errors.AlreadyBranchError(to_location)
1238
except errors.NoSuchFile:
1239
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1242
# preserve whatever source format we have.
1243
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1244
possible_transports=[to_transport],
1245
accelerator_tree=accelerator_tree,
1246
hardlink=hardlink, stacked=stacked,
1247
force_new_repo=standalone,
1248
create_tree_if_local=not no_tree,
1249
source_branch=br_from)
1250
branch = dir.open_branch()
1251
except errors.NoSuchRevision:
1252
to_transport.delete_tree('.')
1253
msg = "The branch %s has no revision %s." % (from_location,
1255
raise errors.BzrCommandError(msg)
1256
_merge_tags_if_possible(br_from, branch)
1257
# If the source branch is stacked, the new branch may
1258
# be stacked whether we asked for that explicitly or not.
1259
# We therefore need a try/except here and not just 'if stacked:'
1261
note('Created new stacked branch referring to %s.' %
1262
branch.get_stacked_on_url())
1263
except (errors.NotStacked, errors.UnstackableBranchFormat,
1264
errors.UnstackableRepositoryFormat), e:
1265
note('Branched %d revision(s).' % branch.revno())
1267
# Switch to the new branch
1268
wt, _ = WorkingTree.open_containing('.')
1269
_mod_switch.switch(wt.bzrdir, branch)
1270
note('Switched to branch: %s',
1271
urlutils.unescape_for_display(branch.base, 'utf-8'))
1276
class cmd_checkout(Command):
1277
"""Create a new checkout of an existing branch.
1279
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1280
the branch found in '.'. This is useful if you have removed the working tree
1281
or if it was never created - i.e. if you pushed the branch to its current
1282
location using SFTP.
1284
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1285
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1286
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1287
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1288
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1291
To retrieve the branch as of a particular revision, supply the --revision
1292
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1293
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1297
_see_also = ['checkouts', 'branch']
1298
takes_args = ['branch_location?', 'to_location?']
1299
takes_options = ['revision',
1300
Option('lightweight',
1301
help="Perform a lightweight checkout. Lightweight "
1302
"checkouts depend on access to the branch for "
1303
"every operation. Normal checkouts can perform "
1304
"common operations like diff and status without "
1305
"such access, and also support local commits."
1307
Option('files-from', type=str,
1308
help="Get file contents from this tree."),
1310
help='Hard-link working tree files where possible.'
1315
def run(self, branch_location=None, to_location=None, revision=None,
1316
lightweight=False, files_from=None, hardlink=False):
1317
if branch_location is None:
1318
branch_location = osutils.getcwd()
1319
to_location = branch_location
1320
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1322
revision = _get_one_revision('checkout', revision)
1323
if files_from is not None:
1324
accelerator_tree = WorkingTree.open(files_from)
1325
if revision is not None:
1326
revision_id = revision.as_revision_id(source)
1329
if to_location is None:
1330
to_location = urlutils.derive_to_location(branch_location)
1331
# if the source and to_location are the same,
1332
# and there is no working tree,
1333
# then reconstitute a branch
1334
if (osutils.abspath(to_location) ==
1335
osutils.abspath(branch_location)):
1337
source.bzrdir.open_workingtree()
1338
except errors.NoWorkingTree:
1339
source.bzrdir.create_workingtree(revision_id)
1341
source.create_checkout(to_location, revision_id, lightweight,
1342
accelerator_tree, hardlink)
1345
class cmd_renames(Command):
1346
"""Show list of renamed files.
1348
# TODO: Option to show renames between two historical versions.
1350
# TODO: Only show renames under dir, rather than in the whole branch.
1351
_see_also = ['status']
1352
takes_args = ['dir?']
1355
def run(self, dir=u'.'):
1356
tree = WorkingTree.open_containing(dir)[0]
1359
new_inv = tree.inventory
1360
old_tree = tree.basis_tree()
1361
old_tree.lock_read()
1363
old_inv = old_tree.inventory
1365
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1366
for f, paths, c, v, p, n, k, e in iterator:
1367
if paths[0] == paths[1]:
1371
renames.append(paths)
1373
for old_name, new_name in renames:
1374
self.outf.write("%s => %s\n" % (old_name, new_name))
1381
class cmd_update(Command):
1382
"""Update a tree to have the latest code committed to its branch.
1384
This will perform a merge into the working tree, and may generate
1385
conflicts. If you have any local changes, you will still
1386
need to commit them after the update for the update to be complete.
1388
If you want to discard your local changes, you can just do a
1389
'bzr revert' instead of 'bzr commit' after the update.
1392
_see_also = ['pull', 'working-trees', 'status-flags']
1393
takes_args = ['dir?']
1396
def run(self, dir='.'):
1397
tree = WorkingTree.open_containing(dir)[0]
1398
possible_transports = []
1399
master = tree.branch.get_master_branch(
1400
possible_transports=possible_transports)
1401
if master is not None:
1403
branch_location = master.base
1405
tree.lock_tree_write()
1406
branch_location = tree.branch.base
1407
# get rid of the final '/' and be ready for display
1408
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1411
existing_pending_merges = tree.get_parent_ids()[1:]
1412
last_rev = _mod_revision.ensure_null(tree.last_revision())
1413
if last_rev == _mod_revision.ensure_null(
1414
tree.branch.last_revision()):
1415
# may be up to date, check master too.
1416
if master is None or last_rev == _mod_revision.ensure_null(
1417
master.last_revision()):
1418
revno = tree.branch.revision_id_to_revno(last_rev)
1419
note('Tree is up to date at revision %d of branch %s'
1420
% (revno, branch_location))
1422
view_info = _get_view_info_for_change_reporter(tree)
1423
conflicts = tree.update(
1424
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1425
view_info=view_info), possible_transports=possible_transports)
1426
revno = tree.branch.revision_id_to_revno(
1427
_mod_revision.ensure_null(tree.last_revision()))
1428
note('Updated to revision %d of branch %s' %
1429
(revno, branch_location))
1430
if tree.get_parent_ids()[1:] != existing_pending_merges:
1431
note('Your local commits will now show as pending merges with '
1432
"'bzr status', and can be committed with 'bzr commit'.")
1441
class cmd_info(Command):
1442
"""Show information about a working tree, branch or repository.
1444
This command will show all known locations and formats associated to the
1445
tree, branch or repository.
1447
In verbose mode, statistical information is included with each report.
1448
To see extended statistic information, use a verbosity level of 2 or
1449
higher by specifying the verbose option multiple times, e.g. -vv.
1451
Branches and working trees will also report any missing revisions.
1455
Display information on the format and related locations:
1459
Display the above together with extended format information and
1460
basic statistics (like the number of files in the working tree and
1461
number of revisions in the branch and repository):
1465
Display the above together with number of committers to the branch:
1469
_see_also = ['revno', 'working-trees', 'repositories']
1470
takes_args = ['location?']
1471
takes_options = ['verbose']
1472
encoding_type = 'replace'
1475
def run(self, location=None, verbose=False):
1477
noise_level = get_verbosity_level()
1480
from bzrlib.info import show_bzrdir_info
1481
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1482
verbose=noise_level, outfile=self.outf)
1485
class cmd_remove(Command):
1486
"""Remove files or directories.
1488
This makes bzr stop tracking changes to the specified files. bzr will delete
1489
them if they can easily be recovered using revert. If no options or
1490
parameters are given bzr will scan for files that are being tracked by bzr
1491
but missing in your tree and stop tracking them for you.
1493
takes_args = ['file*']
1494
takes_options = ['verbose',
1495
Option('new', help='Only remove files that have never been committed.'),
1496
RegistryOption.from_kwargs('file-deletion-strategy',
1497
'The file deletion mode to be used.',
1498
title='Deletion Strategy', value_switches=True, enum_switch=False,
1499
safe='Only delete files if they can be'
1500
' safely recovered (default).',
1501
keep='Delete from bzr but leave the working copy.',
1502
force='Delete all the specified files, even if they can not be '
1503
'recovered and even if they are non-empty directories.')]
1504
aliases = ['rm', 'del']
1505
encoding_type = 'replace'
1507
def run(self, file_list, verbose=False, new=False,
1508
file_deletion_strategy='safe'):
1509
tree, file_list = tree_files(file_list)
1511
if file_list is not None:
1512
file_list = [f for f in file_list]
1516
# Heuristics should probably all move into tree.remove_smart or
1519
added = tree.changes_from(tree.basis_tree(),
1520
specific_files=file_list).added
1521
file_list = sorted([f[0] for f in added], reverse=True)
1522
if len(file_list) == 0:
1523
raise errors.BzrCommandError('No matching files.')
1524
elif file_list is None:
1525
# missing files show up in iter_changes(basis) as
1526
# versioned-with-no-kind.
1528
for change in tree.iter_changes(tree.basis_tree()):
1529
# Find paths in the working tree that have no kind:
1530
if change[1][1] is not None and change[6][1] is None:
1531
missing.append(change[1][1])
1532
file_list = sorted(missing, reverse=True)
1533
file_deletion_strategy = 'keep'
1534
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1535
keep_files=file_deletion_strategy=='keep',
1536
force=file_deletion_strategy=='force')
1541
class cmd_file_id(Command):
1542
"""Print file_id of a particular file or directory.
1544
The file_id is assigned when the file is first added and remains the
1545
same through all revisions where the file exists, even when it is
1550
_see_also = ['inventory', 'ls']
1551
takes_args = ['filename']
1554
def run(self, filename):
1555
tree, relpath = WorkingTree.open_containing(filename)
1556
i = tree.path2id(relpath)
1558
raise errors.NotVersionedError(filename)
1560
self.outf.write(i + '\n')
1563
class cmd_file_path(Command):
1564
"""Print path of file_ids to a file or directory.
1566
This prints one line for each directory down to the target,
1567
starting at the branch root.
1571
takes_args = ['filename']
1574
def run(self, filename):
1575
tree, relpath = WorkingTree.open_containing(filename)
1576
fid = tree.path2id(relpath)
1578
raise errors.NotVersionedError(filename)
1579
segments = osutils.splitpath(relpath)
1580
for pos in range(1, len(segments) + 1):
1581
path = osutils.joinpath(segments[:pos])
1582
self.outf.write("%s\n" % tree.path2id(path))
1585
class cmd_reconcile(Command):
1586
"""Reconcile bzr metadata in a branch.
1588
This can correct data mismatches that may have been caused by
1589
previous ghost operations or bzr upgrades. You should only
1590
need to run this command if 'bzr check' or a bzr developer
1591
advises you to run it.
1593
If a second branch is provided, cross-branch reconciliation is
1594
also attempted, which will check that data like the tree root
1595
id which was not present in very early bzr versions is represented
1596
correctly in both branches.
1598
At the same time it is run it may recompress data resulting in
1599
a potential saving in disk space or performance gain.
1601
The branch *MUST* be on a listable system such as local disk or sftp.
1604
_see_also = ['check']
1605
takes_args = ['branch?']
1607
def run(self, branch="."):
1608
from bzrlib.reconcile import reconcile
1609
dir = bzrdir.BzrDir.open(branch)
1613
class cmd_revision_history(Command):
1614
"""Display the list of revision ids on a branch."""
1617
takes_args = ['location?']
1622
def run(self, location="."):
1623
branch = Branch.open_containing(location)[0]
1624
for revid in branch.revision_history():
1625
self.outf.write(revid)
1626
self.outf.write('\n')
1629
class cmd_ancestry(Command):
1630
"""List all revisions merged into this branch."""
1632
_see_also = ['log', 'revision-history']
1633
takes_args = ['location?']
1638
def run(self, location="."):
1640
wt = WorkingTree.open_containing(location)[0]
1641
except errors.NoWorkingTree:
1642
b = Branch.open(location)
1643
last_revision = b.last_revision()
1646
last_revision = wt.last_revision()
1648
revision_ids = b.repository.get_ancestry(last_revision)
1650
for revision_id in revision_ids:
1651
self.outf.write(revision_id + '\n')
1654
class cmd_init(Command):
1655
"""Make a directory into a versioned branch.
1657
Use this to create an empty branch, or before importing an
1660
If there is a repository in a parent directory of the location, then
1661
the history of the branch will be stored in the repository. Otherwise
1662
init creates a standalone branch which carries its own history
1663
in the .bzr directory.
1665
If there is already a branch at the location but it has no working tree,
1666
the tree can be populated with 'bzr checkout'.
1668
Recipe for importing a tree of files::
1674
bzr commit -m "imported project"
1677
_see_also = ['init-repository', 'branch', 'checkout']
1678
takes_args = ['location?']
1680
Option('create-prefix',
1681
help='Create the path leading up to the branch '
1682
'if it does not already exist.'),
1683
RegistryOption('format',
1684
help='Specify a format for this branch. '
1685
'See "help formats".',
1686
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1687
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1688
value_switches=True,
1689
title="Branch format",
1691
Option('append-revisions-only',
1692
help='Never change revnos or the existing log.'
1693
' Append revisions to it only.')
1695
def run(self, location=None, format=None, append_revisions_only=False,
1696
create_prefix=False):
1698
format = bzrdir.format_registry.make_bzrdir('default')
1699
if location is None:
1702
to_transport = transport.get_transport(location)
1704
# The path has to exist to initialize a
1705
# branch inside of it.
1706
# Just using os.mkdir, since I don't
1707
# believe that we want to create a bunch of
1708
# locations if the user supplies an extended path
1710
to_transport.ensure_base()
1711
except errors.NoSuchFile:
1712
if not create_prefix:
1713
raise errors.BzrCommandError("Parent directory of %s"
1715
"\nYou may supply --create-prefix to create all"
1716
" leading parent directories."
1718
to_transport.create_prefix()
1721
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1722
except errors.NotBranchError:
1723
# really a NotBzrDir error...
1724
create_branch = bzrdir.BzrDir.create_branch_convenience
1725
branch = create_branch(to_transport.base, format=format,
1726
possible_transports=[to_transport])
1727
a_bzrdir = branch.bzrdir
1729
from bzrlib.transport.local import LocalTransport
1730
if a_bzrdir.has_branch():
1731
if (isinstance(to_transport, LocalTransport)
1732
and not a_bzrdir.has_workingtree()):
1733
raise errors.BranchExistsWithoutWorkingTree(location)
1734
raise errors.AlreadyBranchError(location)
1735
branch = a_bzrdir.create_branch()
1736
a_bzrdir.create_workingtree()
1737
if append_revisions_only:
1739
branch.set_append_revisions_only(True)
1740
except errors.UpgradeRequired:
1741
raise errors.BzrCommandError('This branch format cannot be set'
1742
' to append-revisions-only. Try --default.')
1744
from bzrlib.info import describe_layout, describe_format
1746
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1747
except (errors.NoWorkingTree, errors.NotLocalUrl):
1749
repository = branch.repository
1750
layout = describe_layout(repository, branch, tree).lower()
1751
format = describe_format(a_bzrdir, repository, branch, tree)
1752
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1753
if repository.is_shared():
1754
#XXX: maybe this can be refactored into transport.path_or_url()
1755
url = repository.bzrdir.root_transport.external_url()
1757
url = urlutils.local_path_from_url(url)
1758
except errors.InvalidURL:
1760
self.outf.write("Using shared repository: %s\n" % url)
1763
class cmd_init_repository(Command):
1764
"""Create a shared repository for branches to share storage space.
1766
New branches created under the repository directory will store their
1767
revisions in the repository, not in the branch directory. For branches
1768
with shared history, this reduces the amount of storage needed and
1769
speeds up the creation of new branches.
1771
If the --no-trees option is given then the branches in the repository
1772
will not have working trees by default. They will still exist as
1773
directories on disk, but they will not have separate copies of the
1774
files at a certain revision. This can be useful for repositories that
1775
store branches which are interacted with through checkouts or remote
1776
branches, such as on a server.
1779
Create a shared repository holding just branches::
1781
bzr init-repo --no-trees repo
1784
Make a lightweight checkout elsewhere::
1786
bzr checkout --lightweight repo/trunk trunk-checkout
1791
_see_also = ['init', 'branch', 'checkout', 'repositories']
1792
takes_args = ["location"]
1793
takes_options = [RegistryOption('format',
1794
help='Specify a format for this repository. See'
1795
' "bzr help formats" for details.',
1796
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1797
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1798
value_switches=True, title='Repository format'),
1800
help='Branches in the repository will default to'
1801
' not having a working tree.'),
1803
aliases = ["init-repo"]
1805
def run(self, location, format=None, no_trees=False):
1807
format = bzrdir.format_registry.make_bzrdir('default')
1809
if location is None:
1812
to_transport = transport.get_transport(location)
1813
to_transport.ensure_base()
1815
newdir = format.initialize_on_transport(to_transport)
1816
repo = newdir.create_repository(shared=True)
1817
repo.set_make_working_trees(not no_trees)
1819
from bzrlib.info import show_bzrdir_info
1820
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1823
class cmd_diff(Command):
1824
"""Show differences in the working tree, between revisions or branches.
1826
If no arguments are given, all changes for the current tree are listed.
1827
If files are given, only the changes in those files are listed.
1828
Remote and multiple branches can be compared by using the --old and
1829
--new options. If not provided, the default for both is derived from
1830
the first argument, if any, or the current tree if no arguments are
1833
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1834
produces patches suitable for "patch -p1".
1838
2 - unrepresentable changes
1843
Shows the difference in the working tree versus the last commit::
1847
Difference between the working tree and revision 1::
1851
Difference between revision 3 and revision 1::
1855
Difference between revision 3 and revision 1 for branch xxx::
1859
To see the changes introduced in revision X::
1863
Note that in the case of a merge, the -c option shows the changes
1864
compared to the left hand parent. To see the changes against
1865
another parent, use::
1867
bzr diff -r<chosen_parent>..X
1869
The changes introduced by revision 2 (equivalent to -r1..2)::
1873
Show just the differences for file NEWS::
1877
Show the differences in working tree xxx for file NEWS::
1881
Show the differences from branch xxx to this working tree:
1885
Show the differences between two branches for file NEWS::
1887
bzr diff --old xxx --new yyy NEWS
1889
Same as 'bzr diff' but prefix paths with old/ and new/::
1891
bzr diff --prefix old/:new/
1893
_see_also = ['status']
1894
takes_args = ['file*']
1896
Option('diff-options', type=str,
1897
help='Pass these options to the external diff program.'),
1898
Option('prefix', type=str,
1900
help='Set prefixes added to old and new filenames, as '
1901
'two values separated by a colon. (eg "old/:new/").'),
1903
help='Branch/tree to compare from.',
1907
help='Branch/tree to compare to.',
1913
help='Use this command to compare files.',
1917
aliases = ['di', 'dif']
1918
encoding_type = 'exact'
1921
def run(self, revision=None, file_list=None, diff_options=None,
1922
prefix=None, old=None, new=None, using=None):
1923
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1925
if (prefix is None) or (prefix == '0'):
1933
old_label, new_label = prefix.split(":")
1935
raise errors.BzrCommandError(
1936
'--prefix expects two values separated by a colon'
1937
' (eg "old/:new/")')
1939
if revision and len(revision) > 2:
1940
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1941
' one or two revision specifiers')
1943
(old_tree, new_tree,
1944
old_branch, new_branch,
1945
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1946
file_list, revision, old, new, apply_view=True)
1947
return show_diff_trees(old_tree, new_tree, sys.stdout,
1948
specific_files=specific_files,
1949
external_diff_options=diff_options,
1950
old_label=old_label, new_label=new_label,
1951
extra_trees=extra_trees, using=using)
1954
class cmd_deleted(Command):
1955
"""List files deleted in the working tree.
1957
# TODO: Show files deleted since a previous revision, or
1958
# between two revisions.
1959
# TODO: Much more efficient way to do this: read in new
1960
# directories with readdir, rather than stating each one. Same
1961
# level of effort but possibly much less IO. (Or possibly not,
1962
# if the directories are very large...)
1963
_see_also = ['status', 'ls']
1964
takes_options = ['show-ids']
1967
def run(self, show_ids=False):
1968
tree = WorkingTree.open_containing(u'.')[0]
1971
old = tree.basis_tree()
1974
for path, ie in old.inventory.iter_entries():
1975
if not tree.has_id(ie.file_id):
1976
self.outf.write(path)
1978
self.outf.write(' ')
1979
self.outf.write(ie.file_id)
1980
self.outf.write('\n')
1987
class cmd_modified(Command):
1988
"""List files modified in working tree.
1992
_see_also = ['status', 'ls']
1995
help='Write an ascii NUL (\\0) separator '
1996
'between files rather than a newline.')
2000
def run(self, null=False):
2001
tree = WorkingTree.open_containing(u'.')[0]
2002
td = tree.changes_from(tree.basis_tree())
2003
for path, id, kind, text_modified, meta_modified in td.modified:
2005
self.outf.write(path + '\0')
2007
self.outf.write(osutils.quotefn(path) + '\n')
2010
class cmd_added(Command):
2011
"""List files added in working tree.
2015
_see_also = ['status', 'ls']
2018
help='Write an ascii NUL (\\0) separator '
2019
'between files rather than a newline.')
2023
def run(self, null=False):
2024
wt = WorkingTree.open_containing(u'.')[0]
2027
basis = wt.basis_tree()
2030
basis_inv = basis.inventory
2033
if file_id in basis_inv:
2035
if inv.is_root(file_id) and len(basis_inv) == 0:
2037
path = inv.id2path(file_id)
2038
if not os.access(osutils.abspath(path), os.F_OK):
2041
self.outf.write(path + '\0')
2043
self.outf.write(osutils.quotefn(path) + '\n')
2050
class cmd_root(Command):
2051
"""Show the tree root directory.
2053
The root is the nearest enclosing directory with a .bzr control
2056
takes_args = ['filename?']
2058
def run(self, filename=None):
2059
"""Print the branch root."""
2060
tree = WorkingTree.open_containing(filename)[0]
2061
self.outf.write(tree.basedir + '\n')
2064
def _parse_limit(limitstring):
2066
return int(limitstring)
2068
msg = "The limit argument must be an integer."
2069
raise errors.BzrCommandError(msg)
2072
def _parse_levels(s):
2076
msg = "The levels argument must be an integer."
2077
raise errors.BzrCommandError(msg)
2080
class cmd_log(Command):
2081
"""Show historical log for a branch or subset of a branch.
2083
log is bzr's default tool for exploring the history of a branch.
2084
The branch to use is taken from the first parameter. If no parameters
2085
are given, the branch containing the working directory is logged.
2086
Here are some simple examples::
2088
bzr log log the current branch
2089
bzr log foo.py log a file in its branch
2090
bzr log http://server/branch log a branch on a server
2092
The filtering, ordering and information shown for each revision can
2093
be controlled as explained below. By default, all revisions are
2094
shown sorted (topologically) so that newer revisions appear before
2095
older ones and descendants always appear before ancestors. If displayed,
2096
merged revisions are shown indented under the revision in which they
2101
The log format controls how information about each revision is
2102
displayed. The standard log formats are called ``long``, ``short``
2103
and ``line``. The default is long. See ``bzr help log-formats``
2104
for more details on log formats.
2106
The following options can be used to control what information is
2109
-l N display a maximum of N revisions
2110
-n N display N levels of revisions (0 for all, 1 for collapsed)
2111
-v display a status summary (delta) for each revision
2112
-p display a diff (patch) for each revision
2113
--show-ids display revision-ids (and file-ids), not just revnos
2115
Note that the default number of levels to display is a function of the
2116
log format. If the -n option is not used, the standard log formats show
2117
just the top level (mainline).
2119
Status summaries are shown using status flags like A, M, etc. To see
2120
the changes explained using words like ``added`` and ``modified``
2121
instead, use the -vv option.
2125
To display revisions from oldest to newest, use the --forward option.
2126
In most cases, using this option will have little impact on the total
2127
time taken to produce a log, though --forward does not incrementally
2128
display revisions like --reverse does when it can.
2130
:Revision filtering:
2132
The -r option can be used to specify what revision or range of revisions
2133
to filter against. The various forms are shown below::
2135
-rX display revision X
2136
-rX.. display revision X and later
2137
-r..Y display up to and including revision Y
2138
-rX..Y display from X to Y inclusive
2140
See ``bzr help revisionspec`` for details on how to specify X and Y.
2141
Some common examples are given below::
2143
-r-1 show just the tip
2144
-r-10.. show the last 10 mainline revisions
2145
-rsubmit:.. show what's new on this branch
2146
-rancestor:path.. show changes since the common ancestor of this
2147
branch and the one at location path
2148
-rdate:yesterday.. show changes since yesterday
2150
When logging a range of revisions using -rX..Y, log starts at
2151
revision Y and searches back in history through the primary
2152
("left-hand") parents until it finds X. When logging just the
2153
top level (using -n1), an error is reported if X is not found
2154
along the way. If multi-level logging is used (-n0), X may be
2155
a nested merge revision and the log will be truncated accordingly.
2159
If parameters are given and the first one is not a branch, the log
2160
will be filtered to show only those revisions that changed the
2161
nominated files or directories.
2163
Filenames are interpreted within their historical context. To log a
2164
deleted file, specify a revision range so that the file existed at
2165
the end or start of the range.
2167
Historical context is also important when interpreting pathnames of
2168
renamed files/directories. Consider the following example:
2170
* revision 1: add tutorial.txt
2171
* revision 2: modify tutorial.txt
2172
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2176
* ``bzr log guide.txt`` will log the file added in revision 1
2178
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2180
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2181
the original file in revision 2.
2183
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2184
was no file called guide.txt in revision 2.
2186
Renames are always followed by log. By design, there is no need to
2187
explicitly ask for this (and no way to stop logging a file back
2188
until it was last renamed).
2192
The --message option can be used for finding revisions that match a
2193
regular expression in a commit message.
2197
GUI tools and IDEs are often better at exploring history than command
2198
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2199
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2200
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2202
Web interfaces are often better at exploring history than command line
2203
tools, particularly for branches on servers. You may prefer Loggerhead
2204
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2206
You may find it useful to add the aliases below to ``bazaar.conf``::
2210
top = log -l10 --line
2213
``bzr tip`` will then show the latest revision while ``bzr top``
2214
will show the last 10 mainline revisions. To see the details of a
2215
particular revision X, ``bzr show -rX``.
2217
If you are interested in looking deeper into a particular merge X,
2218
use ``bzr log -n0 -rX``.
2220
``bzr log -v`` on a branch with lots of history is currently
2221
very slow. A fix for this issue is currently under development.
2222
With or without that fix, it is recommended that a revision range
2223
be given when using the -v option.
2225
bzr has a generic full-text matching plugin, bzr-search, that can be
2226
used to find revisions matching user names, commit messages, etc.
2227
Among other features, this plugin can find all revisions containing
2228
a list of words but not others.
2230
When exploring non-mainline history on large projects with deep
2231
history, the performance of log can be greatly improved by installing
2232
the historycache plugin. This plugin buffers historical information
2233
trading disk space for faster speed.
2235
takes_args = ['file*']
2236
_see_also = ['log-formats', 'revisionspec']
2239
help='Show from oldest to newest.'),
2241
custom_help('verbose',
2242
help='Show files changed in each revision.'),
2246
type=bzrlib.option._parse_revision_str,
2248
help='Show just the specified revision.'
2249
' See also "help revisionspec".'),
2253
help='Number of levels to display - 0 for all, 1 for flat.',
2255
type=_parse_levels),
2258
help='Show revisions whose message matches this '
2259
'regular expression.',
2263
help='Limit the output to the first N revisions.',
2268
help='Show changes made in each revision as a patch.'),
2269
Option('include-merges',
2270
help='Show merged revisions like --levels 0 does.'),
2272
encoding_type = 'replace'
2275
def run(self, file_list=None, timezone='original',
2286
include_merges=False):
2287
from bzrlib.log import (
2289
make_log_request_dict,
2290
_get_info_for_log_files,
2292
direction = (forward and 'forward') or 'reverse'
2297
raise errors.BzrCommandError(
2298
'--levels and --include-merges are mutually exclusive')
2300
if change is not None:
2302
raise errors.RangeInChangeOption()
2303
if revision is not None:
2304
raise errors.BzrCommandError(
2305
'--revision and --change are mutually exclusive')
2310
filter_by_dir = False
2314
# find the file ids to log and check for directory filtering
2315
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2316
revision, file_list)
2317
for relpath, file_id, kind in file_info_list:
2319
raise errors.BzrCommandError(
2320
"Path unknown at end or start of revision range: %s" %
2322
# If the relpath is the top of the tree, we log everything
2327
file_ids.append(file_id)
2328
filter_by_dir = filter_by_dir or (
2329
kind in ['directory', 'tree-reference'])
2332
# FIXME ? log the current subdir only RBC 20060203
2333
if revision is not None \
2334
and len(revision) > 0 and revision[0].get_branch():
2335
location = revision[0].get_branch()
2338
dir, relpath = bzrdir.BzrDir.open_containing(location)
2339
b = dir.open_branch()
2341
rev1, rev2 = _get_revision_range(revision, b, self.name())
2343
# Decide on the type of delta & diff filtering to use
2344
# TODO: add an --all-files option to make this configurable & consistent
2352
diff_type = 'partial'
2356
# Build the log formatter
2357
if log_format is None:
2358
log_format = log.log_formatter_registry.get_default(b)
2359
# Make a non-encoding output to include the diffs - bug 328007
2360
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2361
lf = log_format(show_ids=show_ids, to_file=self.outf,
2362
to_exact_file=unencoded_output,
2363
show_timezone=timezone,
2364
delta_format=get_verbosity_level(),
2366
show_advice=levels is None)
2368
# Choose the algorithm for doing the logging. It's annoying
2369
# having multiple code paths like this but necessary until
2370
# the underlying repository format is faster at generating
2371
# deltas or can provide everything we need from the indices.
2372
# The default algorithm - match-using-deltas - works for
2373
# multiple files and directories and is faster for small
2374
# amounts of history (200 revisions say). However, it's too
2375
# slow for logging a single file in a repository with deep
2376
# history, i.e. > 10K revisions. In the spirit of "do no
2377
# evil when adding features", we continue to use the
2378
# original algorithm - per-file-graph - for the "single
2379
# file that isn't a directory without showing a delta" case.
2380
partial_history = revision and b.repository._format.supports_chks
2381
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2382
or delta_type or partial_history)
2384
# Build the LogRequest and execute it
2385
if len(file_ids) == 0:
2387
rqst = make_log_request_dict(
2388
direction=direction, specific_fileids=file_ids,
2389
start_revision=rev1, end_revision=rev2, limit=limit,
2390
message_search=message, delta_type=delta_type,
2391
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2392
Logger(b, rqst).show(lf)
2398
def _get_revision_range(revisionspec_list, branch, command_name):
2399
"""Take the input of a revision option and turn it into a revision range.
2401
It returns RevisionInfo objects which can be used to obtain the rev_id's
2402
of the desired revisions. It does some user input validations.
2404
if revisionspec_list is None:
2407
elif len(revisionspec_list) == 1:
2408
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2409
elif len(revisionspec_list) == 2:
2410
start_spec = revisionspec_list[0]
2411
end_spec = revisionspec_list[1]
2412
if end_spec.get_branch() != start_spec.get_branch():
2413
# b is taken from revision[0].get_branch(), and
2414
# show_log will use its revision_history. Having
2415
# different branches will lead to weird behaviors.
2416
raise errors.BzrCommandError(
2417
"bzr %s doesn't accept two revisions in different"
2418
" branches." % command_name)
2419
rev1 = start_spec.in_history(branch)
2420
# Avoid loading all of history when we know a missing
2421
# end of range means the last revision ...
2422
if end_spec.spec is None:
2423
last_revno, last_revision_id = branch.last_revision_info()
2424
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2426
rev2 = end_spec.in_history(branch)
2428
raise errors.BzrCommandError(
2429
'bzr %s --revision takes one or two values.' % command_name)
2433
def _revision_range_to_revid_range(revision_range):
2436
if revision_range[0] is not None:
2437
rev_id1 = revision_range[0].rev_id
2438
if revision_range[1] is not None:
2439
rev_id2 = revision_range[1].rev_id
2440
return rev_id1, rev_id2
2442
def get_log_format(long=False, short=False, line=False, default='long'):
2443
log_format = default
2447
log_format = 'short'
2453
class cmd_touching_revisions(Command):
2454
"""Return revision-ids which affected a particular file.
2456
A more user-friendly interface is "bzr log FILE".
2460
takes_args = ["filename"]
2463
def run(self, filename):
2464
tree, relpath = WorkingTree.open_containing(filename)
2465
file_id = tree.path2id(relpath)
2469
touching_revs = log.find_touching_revisions(b, file_id)
2470
for revno, revision_id, what in touching_revs:
2471
self.outf.write("%6d %s\n" % (revno, what))
2476
class cmd_ls(Command):
2477
"""List files in a tree.
2480
_see_also = ['status', 'cat']
2481
takes_args = ['path?']
2485
Option('recursive', short_name='R',
2486
help='Recurse into subdirectories.'),
2488
help='Print paths relative to the root of the branch.'),
2489
Option('unknown', help='Print unknown files.'),
2490
Option('versioned', help='Print versioned files.',
2492
Option('ignored', help='Print ignored files.'),
2494
help='Write an ascii NUL (\\0) separator '
2495
'between files rather than a newline.'),
2497
help='List entries of a particular kind: file, directory, symlink.',
2502
def run(self, revision=None, verbose=False,
2503
recursive=False, from_root=False,
2504
unknown=False, versioned=False, ignored=False,
2505
null=False, kind=None, show_ids=False, path=None):
2507
if kind and kind not in ('file', 'directory', 'symlink'):
2508
raise errors.BzrCommandError('invalid kind specified')
2510
if verbose and null:
2511
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2512
all = not (unknown or versioned or ignored)
2514
selection = {'I':ignored, '?':unknown, 'V':versioned}
2520
raise errors.BzrCommandError('cannot specify both --from-root'
2523
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2526
# Calculate the prefix to use
2530
prefix = relpath + '/'
2531
elif fs_path != '.' and not fs_path.endswith('/'):
2532
prefix = fs_path + '/'
2534
if revision is not None or tree is None:
2535
tree = _get_one_revision_tree('ls', revision, branch=branch)
2538
if isinstance(tree, WorkingTree) and tree.supports_views():
2539
view_files = tree.views.lookup_view()
2542
view_str = views.view_display_str(view_files)
2543
note("Ignoring files outside view. View is %s" % view_str)
2547
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2548
from_dir=relpath, recursive=recursive):
2549
# Apply additional masking
2550
if not all and not selection[fc]:
2552
if kind is not None and fkind != kind:
2557
fullpath = osutils.pathjoin(relpath, fp)
2560
views.check_path_in_view(tree, fullpath)
2561
except errors.FileOutsideView:
2566
fp = osutils.pathjoin(prefix, fp)
2567
kindch = entry.kind_character()
2568
outstring = fp + kindch
2569
ui.ui_factory.clear_term()
2571
outstring = '%-8s %s' % (fc, outstring)
2572
if show_ids and fid is not None:
2573
outstring = "%-50s %s" % (outstring, fid)
2574
self.outf.write(outstring + '\n')
2576
self.outf.write(fp + '\0')
2579
self.outf.write(fid)
2580
self.outf.write('\0')
2588
self.outf.write('%-50s %s\n' % (outstring, my_id))
2590
self.outf.write(outstring + '\n')
2595
class cmd_unknowns(Command):
2596
"""List unknown files.
2604
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2605
self.outf.write(osutils.quotefn(f) + '\n')
2608
class cmd_ignore(Command):
2609
"""Ignore specified files or patterns.
2611
See ``bzr help patterns`` for details on the syntax of patterns.
2613
If a .bzrignore file does not exist, the ignore command
2614
will create one and add the specified files or patterns to the newly
2615
created file. The ignore command will also automatically add the
2616
.bzrignore file to be versioned. Creating a .bzrignore file without
2617
the use of the ignore command will require an explicit add command.
2619
To remove patterns from the ignore list, edit the .bzrignore file.
2620
After adding, editing or deleting that file either indirectly by
2621
using this command or directly by using an editor, be sure to commit
2624
Note: ignore patterns containing shell wildcards must be quoted from
2628
Ignore the top level Makefile::
2630
bzr ignore ./Makefile
2632
Ignore class files in all directories::
2634
bzr ignore "*.class"
2636
Ignore .o files under the lib directory::
2638
bzr ignore "lib/**/*.o"
2640
Ignore .o files under the lib directory::
2642
bzr ignore "RE:lib/.*\.o"
2644
Ignore everything but the "debian" toplevel directory::
2646
bzr ignore "RE:(?!debian/).*"
2649
_see_also = ['status', 'ignored', 'patterns']
2650
takes_args = ['name_pattern*']
2652
Option('old-default-rules',
2653
help='Write out the ignore rules bzr < 0.9 always used.')
2656
def run(self, name_pattern_list=None, old_default_rules=None):
2657
from bzrlib import ignores
2658
if old_default_rules is not None:
2659
# dump the rules and exit
2660
for pattern in ignores.OLD_DEFAULTS:
2663
if not name_pattern_list:
2664
raise errors.BzrCommandError("ignore requires at least one "
2665
"NAME_PATTERN or --old-default-rules")
2666
name_pattern_list = [globbing.normalize_pattern(p)
2667
for p in name_pattern_list]
2668
for name_pattern in name_pattern_list:
2669
if (name_pattern[0] == '/' or
2670
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2671
raise errors.BzrCommandError(
2672
"NAME_PATTERN should not be an absolute path")
2673
tree, relpath = WorkingTree.open_containing(u'.')
2674
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2675
ignored = globbing.Globster(name_pattern_list)
2678
for entry in tree.list_files():
2682
if ignored.match(filename):
2683
matches.append(filename.encode('utf-8'))
2685
if len(matches) > 0:
2686
print "Warning: the following files are version controlled and" \
2687
" match your ignore pattern:\n%s" \
2688
"\nThese files will continue to be version controlled" \
2689
" unless you 'bzr remove' them." % ("\n".join(matches),)
2692
class cmd_ignored(Command):
2693
"""List ignored files and the patterns that matched them.
2695
List all the ignored files and the ignore pattern that caused the file to
2698
Alternatively, to list just the files::
2703
encoding_type = 'replace'
2704
_see_also = ['ignore', 'ls']
2708
tree = WorkingTree.open_containing(u'.')[0]
2711
for path, file_class, kind, file_id, entry in tree.list_files():
2712
if file_class != 'I':
2714
## XXX: Slightly inefficient since this was already calculated
2715
pat = tree.is_ignored(path)
2716
self.outf.write('%-50s %s\n' % (path, pat))
2721
class cmd_lookup_revision(Command):
2722
"""Lookup the revision-id from a revision-number
2725
bzr lookup-revision 33
2728
takes_args = ['revno']
2731
def run(self, revno):
2735
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2737
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2740
class cmd_export(Command):
2741
"""Export current or past revision to a destination directory or archive.
2743
If no revision is specified this exports the last committed revision.
2745
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2746
given, try to find the format with the extension. If no extension
2747
is found exports to a directory (equivalent to --format=dir).
2749
If root is supplied, it will be used as the root directory inside
2750
container formats (tar, zip, etc). If it is not supplied it will default
2751
to the exported filename. The root option has no effect for 'dir' format.
2753
If branch is omitted then the branch containing the current working
2754
directory will be used.
2756
Note: Export of tree with non-ASCII filenames to zip is not supported.
2758
================= =========================
2759
Supported formats Autodetected by extension
2760
================= =========================
2763
tbz2 .tar.bz2, .tbz2
2766
================= =========================
2768
takes_args = ['dest', 'branch_or_subdir?']
2771
help="Type of file to export to.",
2774
Option('filters', help='Apply content filters to export the '
2775
'convenient form.'),
2778
help="Name of the root directory inside the exported file."),
2780
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2781
root=None, filters=False):
2782
from bzrlib.export import export
2784
if branch_or_subdir is None:
2785
tree = WorkingTree.open_containing(u'.')[0]
2789
b, subdir = Branch.open_containing(branch_or_subdir)
2792
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2794
export(rev_tree, dest, format, root, subdir, filtered=filters)
2795
except errors.NoSuchExportFormat, e:
2796
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2799
class cmd_cat(Command):
2800
"""Write the contents of a file as of a given revision to standard output.
2802
If no revision is nominated, the last revision is used.
2804
Note: Take care to redirect standard output when using this command on a
2810
Option('name-from-revision', help='The path name in the old tree.'),
2811
Option('filters', help='Apply content filters to display the '
2812
'convenience form.'),
2815
takes_args = ['filename']
2816
encoding_type = 'exact'
2819
def run(self, filename, revision=None, name_from_revision=False,
2821
if revision is not None and len(revision) != 1:
2822
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2823
" one revision specifier")
2824
tree, branch, relpath = \
2825
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2828
return self._run(tree, branch, relpath, filename, revision,
2829
name_from_revision, filters)
2833
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2836
tree = b.basis_tree()
2837
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2839
old_file_id = rev_tree.path2id(relpath)
2841
if name_from_revision:
2842
# Try in revision if requested
2843
if old_file_id is None:
2844
raise errors.BzrCommandError(
2845
"%r is not present in revision %s" % (
2846
filename, rev_tree.get_revision_id()))
2848
content = rev_tree.get_file_text(old_file_id)
2850
cur_file_id = tree.path2id(relpath)
2852
if cur_file_id is not None:
2853
# Then try with the actual file id
2855
content = rev_tree.get_file_text(cur_file_id)
2857
except errors.NoSuchId:
2858
# The actual file id didn't exist at that time
2860
if not found and old_file_id is not None:
2861
# Finally try with the old file id
2862
content = rev_tree.get_file_text(old_file_id)
2865
# Can't be found anywhere
2866
raise errors.BzrCommandError(
2867
"%r is not present in revision %s" % (
2868
filename, rev_tree.get_revision_id()))
2870
from bzrlib.filters import (
2871
ContentFilterContext,
2872
filtered_output_bytes,
2874
filters = rev_tree._content_filter_stack(relpath)
2875
chunks = content.splitlines(True)
2876
content = filtered_output_bytes(chunks, filters,
2877
ContentFilterContext(relpath, rev_tree))
2878
self.outf.writelines(content)
2880
self.outf.write(content)
2883
class cmd_local_time_offset(Command):
2884
"""Show the offset in seconds from GMT to local time."""
2888
print osutils.local_time_offset()
2892
class cmd_commit(Command):
2893
"""Commit changes into a new revision.
2895
An explanatory message needs to be given for each commit. This is
2896
often done by using the --message option (getting the message from the
2897
command line) or by using the --file option (getting the message from
2898
a file). If neither of these options is given, an editor is opened for
2899
the user to enter the message. To see the changed files in the
2900
boilerplate text loaded into the editor, use the --show-diff option.
2902
By default, the entire tree is committed and the person doing the
2903
commit is assumed to be the author. These defaults can be overridden
2908
If selected files are specified, only changes to those files are
2909
committed. If a directory is specified then the directory and
2910
everything within it is committed.
2912
When excludes are given, they take precedence over selected files.
2913
For example, to commit only changes within foo, but not changes
2916
bzr commit foo -x foo/bar
2918
A selective commit after a merge is not yet supported.
2922
If the author of the change is not the same person as the committer,
2923
you can specify the author's name using the --author option. The
2924
name should be in the same format as a committer-id, e.g.
2925
"John Doe <jdoe@example.com>". If there is more than one author of
2926
the change you can specify the option multiple times, once for each
2931
A common mistake is to forget to add a new file or directory before
2932
running the commit command. The --strict option checks for unknown
2933
files and aborts the commit if any are found. More advanced pre-commit
2934
checks can be implemented by defining hooks. See ``bzr help hooks``
2939
If you accidentially commit the wrong changes or make a spelling
2940
mistake in the commit message say, you can use the uncommit command
2941
to undo it. See ``bzr help uncommit`` for details.
2943
Hooks can also be configured to run after a commit. This allows you
2944
to trigger updates to external systems like bug trackers. The --fixes
2945
option can be used to record the association between a revision and
2946
one or more bugs. See ``bzr help bugs`` for details.
2948
A selective commit may fail in some cases where the committed
2949
tree would be invalid. Consider::
2954
bzr commit foo -m "committing foo"
2955
bzr mv foo/bar foo/baz
2958
bzr commit foo/bar -m "committing bar but not baz"
2960
In the example above, the last commit will fail by design. This gives
2961
the user the opportunity to decide whether they want to commit the
2962
rename at the same time, separately first, or not at all. (As a general
2963
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2965
# TODO: Run hooks on tree to-be-committed, and after commit.
2967
# TODO: Strict commit that fails if there are deleted files.
2968
# (what does "deleted files" mean ??)
2970
# TODO: Give better message for -s, --summary, used by tla people
2972
# XXX: verbose currently does nothing
2974
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2975
takes_args = ['selected*']
2977
ListOption('exclude', type=str, short_name='x',
2978
help="Do not consider changes made to a given path."),
2979
Option('message', type=unicode,
2981
help="Description of the new revision."),
2984
help='Commit even if nothing has changed.'),
2985
Option('file', type=str,
2988
help='Take commit message from this file.'),
2990
help="Refuse to commit if there are unknown "
2991
"files in the working tree."),
2992
Option('commit-time', type=str,
2993
help="Manually set a commit time using commit date "
2994
"format, e.g. '2009-10-10 08:00:00 +0100'."),
2995
ListOption('fixes', type=str,
2996
help="Mark a bug as being fixed by this revision "
2997
"(see \"bzr help bugs\")."),
2998
ListOption('author', type=unicode,
2999
help="Set the author's name, if it's different "
3000
"from the committer."),
3002
help="Perform a local commit in a bound "
3003
"branch. Local commits are not pushed to "
3004
"the master branch until a normal commit "
3008
help='When no message is supplied, show the diff along'
3009
' with the status summary in the message editor.'),
3011
aliases = ['ci', 'checkin']
3013
def _iter_bug_fix_urls(self, fixes, branch):
3014
# Configure the properties for bug fixing attributes.
3015
for fixed_bug in fixes:
3016
tokens = fixed_bug.split(':')
3017
if len(tokens) != 2:
3018
raise errors.BzrCommandError(
3019
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3020
"See \"bzr help bugs\" for more information on this "
3021
"feature.\nCommit refused." % fixed_bug)
3022
tag, bug_id = tokens
3024
yield bugtracker.get_bug_url(tag, branch, bug_id)
3025
except errors.UnknownBugTrackerAbbreviation:
3026
raise errors.BzrCommandError(
3027
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3028
except errors.MalformedBugIdentifier, e:
3029
raise errors.BzrCommandError(
3030
"%s\nCommit refused." % (str(e),))
3032
def run(self, message=None, file=None, verbose=False, selected_list=None,
3033
unchanged=False, strict=False, local=False, fixes=None,
3034
author=None, show_diff=False, exclude=None, commit_time=None):
3035
from bzrlib.errors import (
3040
from bzrlib.msgeditor import (
3041
edit_commit_message_encoded,
3042
generate_commit_message_template,
3043
make_commit_message_template_encoded
3046
commit_stamp = offset = None
3047
if commit_time is not None:
3049
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3050
except ValueError, e:
3051
raise errors.BzrCommandError(
3052
"Could not parse --commit-time: " + str(e))
3054
# TODO: Need a blackbox test for invoking the external editor; may be
3055
# slightly problematic to run this cross-platform.
3057
# TODO: do more checks that the commit will succeed before
3058
# spending the user's valuable time typing a commit message.
3062
tree, selected_list = tree_files(selected_list)
3063
if selected_list == ['']:
3064
# workaround - commit of root of tree should be exactly the same
3065
# as just default commit in that tree, and succeed even though
3066
# selected-file merge commit is not done yet
3071
bug_property = bugtracker.encode_fixes_bug_urls(
3072
self._iter_bug_fix_urls(fixes, tree.branch))
3074
properties['bugs'] = bug_property
3076
if local and not tree.branch.get_bound_location():
3077
raise errors.LocalRequiresBoundBranch()
3079
if message is not None:
3081
file_exists = osutils.lexists(message)
3082
except UnicodeError:
3083
# The commit message contains unicode characters that can't be
3084
# represented in the filesystem encoding, so that can't be a
3089
'The commit message is a file name: "%(f)s".\n'
3090
'(use --file "%(f)s" to take commit message from that file)'
3092
ui.ui_factory.show_warning(warning_msg)
3094
def get_message(commit_obj):
3095
"""Callback to get commit message"""
3096
my_message = message
3097
if my_message is not None and '\r' in my_message:
3098
my_message = my_message.replace('\r\n', '\n')
3099
my_message = my_message.replace('\r', '\n')
3100
if my_message is None and not file:
3101
t = make_commit_message_template_encoded(tree,
3102
selected_list, diff=show_diff,
3103
output_encoding=osutils.get_user_encoding())
3104
start_message = generate_commit_message_template(commit_obj)
3105
my_message = edit_commit_message_encoded(t,
3106
start_message=start_message)
3107
if my_message is None:
3108
raise errors.BzrCommandError("please specify a commit"
3109
" message with either --message or --file")
3110
elif my_message and file:
3111
raise errors.BzrCommandError(
3112
"please specify either --message or --file")
3114
my_message = codecs.open(file, 'rt',
3115
osutils.get_user_encoding()).read()
3116
if my_message == "":
3117
raise errors.BzrCommandError("empty commit message specified")
3120
# The API permits a commit with a filter of [] to mean 'select nothing'
3121
# but the command line should not do that.
3122
if not selected_list:
3123
selected_list = None
3125
tree.commit(message_callback=get_message,
3126
specific_files=selected_list,
3127
allow_pointless=unchanged, strict=strict, local=local,
3128
reporter=None, verbose=verbose, revprops=properties,
3129
authors=author, timestamp=commit_stamp,
3131
exclude=safe_relpath_files(tree, exclude))
3132
except PointlessCommit:
3133
# FIXME: This should really happen before the file is read in;
3134
# perhaps prepare the commit; get the message; then actually commit
3135
raise errors.BzrCommandError("No changes to commit."
3136
" Use --unchanged to commit anyhow.")
3137
except ConflictsInTree:
3138
raise errors.BzrCommandError('Conflicts detected in working '
3139
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3141
except StrictCommitFailed:
3142
raise errors.BzrCommandError("Commit refused because there are"
3143
" unknown files in the working tree.")
3144
except errors.BoundBranchOutOfDate, e:
3145
raise errors.BzrCommandError(str(e) + "\n"
3146
'To commit to master branch, run update and then commit.\n'
3147
'You can also pass --local to commit to continue working '
3151
class cmd_check(Command):
3152
"""Validate working tree structure, branch consistency and repository history.
3154
This command checks various invariants about branch and repository storage
3155
to detect data corruption or bzr bugs.
3157
The working tree and branch checks will only give output if a problem is
3158
detected. The output fields of the repository check are:
3161
This is just the number of revisions checked. It doesn't
3165
This is just the number of versionedfiles checked. It
3166
doesn't indicate a problem.
3168
unreferenced ancestors
3169
Texts that are ancestors of other texts, but
3170
are not properly referenced by the revision ancestry. This is a
3171
subtle problem that Bazaar can work around.
3174
This is the total number of unique file contents
3175
seen in the checked revisions. It does not indicate a problem.
3178
This is the total number of repeated texts seen
3179
in the checked revisions. Texts can be repeated when their file
3180
entries are modified, but the file contents are not. It does not
3183
If no restrictions are specified, all Bazaar data that is found at the given
3184
location will be checked.
3188
Check the tree and branch at 'foo'::
3190
bzr check --tree --branch foo
3192
Check only the repository at 'bar'::
3194
bzr check --repo bar
3196
Check everything at 'baz'::
3201
_see_also = ['reconcile']
3202
takes_args = ['path?']
3203
takes_options = ['verbose',
3204
Option('branch', help="Check the branch related to the"
3205
" current directory."),
3206
Option('repo', help="Check the repository related to the"
3207
" current directory."),
3208
Option('tree', help="Check the working tree related to"
3209
" the current directory.")]
3211
def run(self, path=None, verbose=False, branch=False, repo=False,
3213
from bzrlib.check import check_dwim
3216
if not branch and not repo and not tree:
3217
branch = repo = tree = True
3218
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3221
class cmd_upgrade(Command):
3222
"""Upgrade branch storage to current format.
3224
The check command or bzr developers may sometimes advise you to run
3225
this command. When the default format has changed you may also be warned
3226
during other operations to upgrade.
3229
_see_also = ['check']
3230
takes_args = ['url?']
3232
RegistryOption('format',
3233
help='Upgrade to a specific format. See "bzr help'
3234
' formats" for details.',
3235
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3236
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3237
value_switches=True, title='Branch format'),
3240
def run(self, url='.', format=None):
3241
from bzrlib.upgrade import upgrade
3242
upgrade(url, format)
3245
class cmd_whoami(Command):
3246
"""Show or set bzr user id.
3249
Show the email of the current user::
3253
Set the current user::
3255
bzr whoami "Frank Chu <fchu@example.com>"
3257
takes_options = [ Option('email',
3258
help='Display email address only.'),
3260
help='Set identity for the current branch instead of '
3263
takes_args = ['name?']
3264
encoding_type = 'replace'
3267
def run(self, email=False, branch=False, name=None):
3269
# use branch if we're inside one; otherwise global config
3271
c = Branch.open_containing('.')[0].get_config()
3272
except errors.NotBranchError:
3273
c = config.GlobalConfig()
3275
self.outf.write(c.user_email() + '\n')
3277
self.outf.write(c.username() + '\n')
3280
# display a warning if an email address isn't included in the given name.
3282
config.extract_email_address(name)
3283
except errors.NoEmailInUsername, e:
3284
warning('"%s" does not seem to contain an email address. '
3285
'This is allowed, but not recommended.', name)
3287
# use global config unless --branch given
3289
c = Branch.open_containing('.')[0].get_config()
3291
c = config.GlobalConfig()
3292
c.set_user_option('email', name)
3295
class cmd_nick(Command):
3296
"""Print or set the branch nickname.
3298
If unset, the tree root directory name is used as the nickname.
3299
To print the current nickname, execute with no argument.
3301
Bound branches use the nickname of its master branch unless it is set
3305
_see_also = ['info']
3306
takes_args = ['nickname?']
3307
def run(self, nickname=None):
3308
branch = Branch.open_containing(u'.')[0]
3309
if nickname is None:
3310
self.printme(branch)
3312
branch.nick = nickname
3315
def printme(self, branch):
3319
class cmd_alias(Command):
3320
"""Set/unset and display aliases.
3323
Show the current aliases::
3327
Show the alias specified for 'll'::
3331
Set an alias for 'll'::
3333
bzr alias ll="log --line -r-10..-1"
3335
To remove an alias for 'll'::
3337
bzr alias --remove ll
3340
takes_args = ['name?']
3342
Option('remove', help='Remove the alias.'),
3345
def run(self, name=None, remove=False):
3347
self.remove_alias(name)
3349
self.print_aliases()
3351
equal_pos = name.find('=')
3353
self.print_alias(name)
3355
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3357
def remove_alias(self, alias_name):
3358
if alias_name is None:
3359
raise errors.BzrCommandError(
3360
'bzr alias --remove expects an alias to remove.')
3361
# If alias is not found, print something like:
3362
# unalias: foo: not found
3363
c = config.GlobalConfig()
3364
c.unset_alias(alias_name)
3367
def print_aliases(self):
3368
"""Print out the defined aliases in a similar format to bash."""
3369
aliases = config.GlobalConfig().get_aliases()
3370
for key, value in sorted(aliases.iteritems()):
3371
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3374
def print_alias(self, alias_name):
3375
from bzrlib.commands import get_alias
3376
alias = get_alias(alias_name)
3378
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3381
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3383
def set_alias(self, alias_name, alias_command):
3384
"""Save the alias in the global config."""
3385
c = config.GlobalConfig()
3386
c.set_alias(alias_name, alias_command)
3389
class cmd_selftest(Command):
3390
"""Run internal test suite.
3392
If arguments are given, they are regular expressions that say which tests
3393
should run. Tests matching any expression are run, and other tests are
3396
Alternatively if --first is given, matching tests are run first and then
3397
all other tests are run. This is useful if you have been working in a
3398
particular area, but want to make sure nothing else was broken.
3400
If --exclude is given, tests that match that regular expression are
3401
excluded, regardless of whether they match --first or not.
3403
To help catch accidential dependencies between tests, the --randomize
3404
option is useful. In most cases, the argument used is the word 'now'.
3405
Note that the seed used for the random number generator is displayed
3406
when this option is used. The seed can be explicitly passed as the
3407
argument to this option if required. This enables reproduction of the
3408
actual ordering used if and when an order sensitive problem is encountered.
3410
If --list-only is given, the tests that would be run are listed. This is
3411
useful when combined with --first, --exclude and/or --randomize to
3412
understand their impact. The test harness reports "Listed nn tests in ..."
3413
instead of "Ran nn tests in ..." when list mode is enabled.
3415
If the global option '--no-plugins' is given, plugins are not loaded
3416
before running the selftests. This has two effects: features provided or
3417
modified by plugins will not be tested, and tests provided by plugins will
3420
Tests that need working space on disk use a common temporary directory,
3421
typically inside $TMPDIR or /tmp.
3423
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3424
into a pdb postmortem session.
3427
Run only tests relating to 'ignore'::
3431
Disable plugins and list tests as they're run::
3433
bzr --no-plugins selftest -v
3435
# NB: this is used from the class without creating an instance, which is
3436
# why it does not have a self parameter.
3437
def get_transport_type(typestring):
3438
"""Parse and return a transport specifier."""
3439
if typestring == "sftp":
3440
from bzrlib.transport.sftp import SFTPAbsoluteServer
3441
return SFTPAbsoluteServer
3442
if typestring == "memory":
3443
from bzrlib.transport.memory import MemoryServer
3445
if typestring == "fakenfs":
3446
from bzrlib.transport.fakenfs import FakeNFSServer
3447
return FakeNFSServer
3448
msg = "No known transport type %s. Supported types are: sftp\n" %\
3450
raise errors.BzrCommandError(msg)
3453
takes_args = ['testspecs*']
3454
takes_options = ['verbose',
3456
help='Stop when one test fails.',
3460
help='Use a different transport by default '
3461
'throughout the test suite.',
3462
type=get_transport_type),
3464
help='Run the benchmarks rather than selftests.'),
3465
Option('lsprof-timed',
3466
help='Generate lsprof output for benchmarked'
3467
' sections of code.'),
3468
Option('lsprof-tests',
3469
help='Generate lsprof output for each test.'),
3470
Option('cache-dir', type=str,
3471
help='Cache intermediate benchmark output in this '
3474
help='Run all tests, but run specified tests first.',
3478
help='List the tests instead of running them.'),
3479
RegistryOption('parallel',
3480
help="Run the test suite in parallel.",
3481
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3482
value_switches=False,
3484
Option('randomize', type=str, argname="SEED",
3485
help='Randomize the order of tests using the given'
3486
' seed or "now" for the current time.'),
3487
Option('exclude', type=str, argname="PATTERN",
3489
help='Exclude tests that match this regular'
3492
help='Output test progress via subunit.'),
3493
Option('strict', help='Fail on missing dependencies or '
3495
Option('load-list', type=str, argname='TESTLISTFILE',
3496
help='Load a test id list from a text file.'),
3497
ListOption('debugflag', type=str, short_name='E',
3498
help='Turn on a selftest debug flag.'),
3499
ListOption('starting-with', type=str, argname='TESTID',
3500
param_name='starting_with', short_name='s',
3502
'Load only the tests starting with TESTID.'),
3504
encoding_type = 'replace'
3507
Command.__init__(self)
3508
self.additional_selftest_args = {}
3510
def run(self, testspecs_list=None, verbose=False, one=False,
3511
transport=None, benchmark=None,
3512
lsprof_timed=None, cache_dir=None,
3513
first=False, list_only=False,
3514
randomize=None, exclude=None, strict=False,
3515
load_list=None, debugflag=None, starting_with=None, subunit=False,
3516
parallel=None, lsprof_tests=False):
3517
from bzrlib.tests import selftest
3518
import bzrlib.benchmarks as benchmarks
3519
from bzrlib.benchmarks import tree_creator
3521
# Make deprecation warnings visible, unless -Werror is set
3522
symbol_versioning.activate_deprecation_warnings(override=False)
3524
if cache_dir is not None:
3525
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3526
if testspecs_list is not None:
3527
pattern = '|'.join(testspecs_list)
3532
from bzrlib.tests import SubUnitBzrRunner
3534
raise errors.BzrCommandError("subunit not available. subunit "
3535
"needs to be installed to use --subunit.")
3536
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3538
self.additional_selftest_args.setdefault(
3539
'suite_decorators', []).append(parallel)
3541
test_suite_factory = benchmarks.test_suite
3542
# Unless user explicitly asks for quiet, be verbose in benchmarks
3543
verbose = not is_quiet()
3544
# TODO: should possibly lock the history file...
3545
benchfile = open(".perf_history", "at", buffering=1)
3547
test_suite_factory = None
3550
selftest_kwargs = {"verbose": verbose,
3552
"stop_on_failure": one,
3553
"transport": transport,
3554
"test_suite_factory": test_suite_factory,
3555
"lsprof_timed": lsprof_timed,
3556
"lsprof_tests": lsprof_tests,
3557
"bench_history": benchfile,
3558
"matching_tests_first": first,
3559
"list_only": list_only,
3560
"random_seed": randomize,
3561
"exclude_pattern": exclude,
3563
"load_list": load_list,
3564
"debug_flags": debugflag,
3565
"starting_with": starting_with
3567
selftest_kwargs.update(self.additional_selftest_args)
3568
result = selftest(**selftest_kwargs)
3570
if benchfile is not None:
3572
return int(not result)
3575
class cmd_version(Command):
3576
"""Show version of bzr."""
3578
encoding_type = 'replace'
3580
Option("short", help="Print just the version number."),
3584
def run(self, short=False):
3585
from bzrlib.version import show_version
3587
self.outf.write(bzrlib.version_string + '\n')
3589
show_version(to_file=self.outf)
3592
class cmd_rocks(Command):
3593
"""Statement of optimism."""
3599
print "It sure does!"
3602
class cmd_find_merge_base(Command):
3603
"""Find and print a base revision for merging two branches."""
3604
# TODO: Options to specify revisions on either side, as if
3605
# merging only part of the history.
3606
takes_args = ['branch', 'other']
3610
def run(self, branch, other):
3611
from bzrlib.revision import ensure_null
3613
branch1 = Branch.open_containing(branch)[0]
3614
branch2 = Branch.open_containing(other)[0]
3619
last1 = ensure_null(branch1.last_revision())
3620
last2 = ensure_null(branch2.last_revision())
3622
graph = branch1.repository.get_graph(branch2.repository)
3623
base_rev_id = graph.find_unique_lca(last1, last2)
3625
print 'merge base is revision %s' % base_rev_id
3632
class cmd_merge(Command):
3633
"""Perform a three-way merge.
3635
The source of the merge can be specified either in the form of a branch,
3636
or in the form of a path to a file containing a merge directive generated
3637
with bzr send. If neither is specified, the default is the upstream branch
3638
or the branch most recently merged using --remember.
3640
When merging a branch, by default the tip will be merged. To pick a different
3641
revision, pass --revision. If you specify two values, the first will be used as
3642
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3643
available revisions, like this is commonly referred to as "cherrypicking".
3645
Revision numbers are always relative to the branch being merged.
3647
By default, bzr will try to merge in all new work from the other
3648
branch, automatically determining an appropriate base. If this
3649
fails, you may need to give an explicit base.
3651
Merge will do its best to combine the changes in two branches, but there
3652
are some kinds of problems only a human can fix. When it encounters those,
3653
it will mark a conflict. A conflict means that you need to fix something,
3654
before you should commit.
3656
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3658
If there is no default branch set, the first merge will set it. After
3659
that, you can omit the branch to use the default. To change the
3660
default, use --remember. The value will only be saved if the remote
3661
location can be accessed.
3663
The results of the merge are placed into the destination working
3664
directory, where they can be reviewed (with bzr diff), tested, and then
3665
committed to record the result of the merge.
3667
merge refuses to run if there are any uncommitted changes, unless
3670
To select only some changes to merge, use "merge -i", which will prompt
3671
you to apply each diff hunk and file change, similar to "shelve".
3674
To merge the latest revision from bzr.dev::
3676
bzr merge ../bzr.dev
3678
To merge changes up to and including revision 82 from bzr.dev::
3680
bzr merge -r 82 ../bzr.dev
3682
To merge the changes introduced by 82, without previous changes::
3684
bzr merge -r 81..82 ../bzr.dev
3686
To apply a merge directive contained in /tmp/merge::
3688
bzr merge /tmp/merge
3691
encoding_type = 'exact'
3692
_see_also = ['update', 'remerge', 'status-flags', 'send']
3693
takes_args = ['location?']
3698
help='Merge even if the destination tree has uncommitted changes.'),
3702
Option('show-base', help="Show base revision text in "
3704
Option('uncommitted', help='Apply uncommitted changes'
3705
' from a working copy, instead of branch changes.'),
3706
Option('pull', help='If the destination is already'
3707
' completely merged into the source, pull from the'
3708
' source rather than merging. When this happens,'
3709
' you do not need to commit the result.'),
3711
help='Branch to merge into, '
3712
'rather than the one containing the working directory.',
3716
Option('preview', help='Instead of merging, show a diff of the'
3718
Option('interactive', help='Select changes interactively.',
3722
def run(self, location=None, revision=None, force=False,
3723
merge_type=None, show_base=False, reprocess=None, remember=False,
3724
uncommitted=False, pull=False,
3729
if merge_type is None:
3730
merge_type = _mod_merge.Merge3Merger
3732
if directory is None: directory = u'.'
3733
possible_transports = []
3735
allow_pending = True
3736
verified = 'inapplicable'
3737
tree = WorkingTree.open_containing(directory)[0]
3740
basis_tree = tree.revision_tree(tree.last_revision())
3741
except errors.NoSuchRevision:
3742
basis_tree = tree.basis_tree()
3744
# die as quickly as possible if there are uncommitted changes
3746
if tree.has_changes():
3747
raise errors.UncommittedChanges(tree)
3749
view_info = _get_view_info_for_change_reporter(tree)
3750
change_reporter = delta._ChangeReporter(
3751
unversioned_filter=tree.is_ignored, view_info=view_info)
3754
pb = ui.ui_factory.nested_progress_bar()
3755
cleanups.append(pb.finished)
3757
cleanups.append(tree.unlock)
3758
if location is not None:
3760
mergeable = bundle.read_mergeable_from_url(location,
3761
possible_transports=possible_transports)
3762
except errors.NotABundle:
3766
raise errors.BzrCommandError('Cannot use --uncommitted'
3767
' with bundles or merge directives.')
3769
if revision is not None:
3770
raise errors.BzrCommandError(
3771
'Cannot use -r with merge directives or bundles')
3772
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3775
if merger is None and uncommitted:
3776
if revision is not None and len(revision) > 0:
3777
raise errors.BzrCommandError('Cannot use --uncommitted and'
3778
' --revision at the same time.')
3779
merger = self.get_merger_from_uncommitted(tree, location, pb,
3781
allow_pending = False
3784
merger, allow_pending = self._get_merger_from_branch(tree,
3785
location, revision, remember, possible_transports, pb)
3787
merger.merge_type = merge_type
3788
merger.reprocess = reprocess
3789
merger.show_base = show_base
3790
self.sanity_check_merger(merger)
3791
if (merger.base_rev_id == merger.other_rev_id and
3792
merger.other_rev_id is not None):
3793
note('Nothing to do.')
3796
if merger.interesting_files is not None:
3797
raise errors.BzrCommandError('Cannot pull individual files')
3798
if (merger.base_rev_id == tree.last_revision()):
3799
result = tree.pull(merger.other_branch, False,
3800
merger.other_rev_id)
3801
result.report(self.outf)
3803
if merger.this_basis is None:
3804
raise errors.BzrCommandError(
3805
"This branch has no commits."
3806
" (perhaps you would prefer 'bzr pull')")
3808
return self._do_preview(merger, cleanups)
3810
return self._do_interactive(merger, cleanups)
3812
return self._do_merge(merger, change_reporter, allow_pending,
3815
for cleanup in reversed(cleanups):
3818
def _get_preview(self, merger, cleanups):
3819
tree_merger = merger.make_merger()
3820
tt = tree_merger.make_preview_transform()
3821
cleanups.append(tt.finalize)
3822
result_tree = tt.get_preview_tree()
3825
def _do_preview(self, merger, cleanups):
3826
from bzrlib.diff import show_diff_trees
3827
result_tree = self._get_preview(merger, cleanups)
3828
show_diff_trees(merger.this_tree, result_tree, self.outf,
3829
old_label='', new_label='')
3831
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3832
merger.change_reporter = change_reporter
3833
conflict_count = merger.do_merge()
3835
merger.set_pending()
3836
if verified == 'failed':
3837
warning('Preview patch does not match changes')
3838
if conflict_count != 0:
3843
def _do_interactive(self, merger, cleanups):
3844
"""Perform an interactive merge.
3846
This works by generating a preview tree of the merge, then using
3847
Shelver to selectively remove the differences between the working tree
3848
and the preview tree.
3850
from bzrlib import shelf_ui
3851
result_tree = self._get_preview(merger, cleanups)
3852
writer = bzrlib.option.diff_writer_registry.get()
3853
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3854
reporter=shelf_ui.ApplyReporter(),
3855
diff_writer=writer(sys.stdout))
3861
def sanity_check_merger(self, merger):
3862
if (merger.show_base and
3863
not merger.merge_type is _mod_merge.Merge3Merger):
3864
raise errors.BzrCommandError("Show-base is not supported for this"
3865
" merge type. %s" % merger.merge_type)
3866
if merger.reprocess is None:
3867
if merger.show_base:
3868
merger.reprocess = False
3870
# Use reprocess if the merger supports it
3871
merger.reprocess = merger.merge_type.supports_reprocess
3872
if merger.reprocess and not merger.merge_type.supports_reprocess:
3873
raise errors.BzrCommandError("Conflict reduction is not supported"
3874
" for merge type %s." %
3876
if merger.reprocess and merger.show_base:
3877
raise errors.BzrCommandError("Cannot do conflict reduction and"
3880
def _get_merger_from_branch(self, tree, location, revision, remember,
3881
possible_transports, pb):
3882
"""Produce a merger from a location, assuming it refers to a branch."""
3883
from bzrlib.tag import _merge_tags_if_possible
3884
# find the branch locations
3885
other_loc, user_location = self._select_branch_location(tree, location,
3887
if revision is not None and len(revision) == 2:
3888
base_loc, _unused = self._select_branch_location(tree,
3889
location, revision, 0)
3891
base_loc = other_loc
3893
other_branch, other_path = Branch.open_containing(other_loc,
3894
possible_transports)
3895
if base_loc == other_loc:
3896
base_branch = other_branch
3898
base_branch, base_path = Branch.open_containing(base_loc,
3899
possible_transports)
3900
# Find the revision ids
3901
other_revision_id = None
3902
base_revision_id = None
3903
if revision is not None:
3904
if len(revision) >= 1:
3905
other_revision_id = revision[-1].as_revision_id(other_branch)
3906
if len(revision) == 2:
3907
base_revision_id = revision[0].as_revision_id(base_branch)
3908
if other_revision_id is None:
3909
other_revision_id = _mod_revision.ensure_null(
3910
other_branch.last_revision())
3911
# Remember where we merge from
3912
if ((remember or tree.branch.get_submit_branch() is None) and
3913
user_location is not None):
3914
tree.branch.set_submit_branch(other_branch.base)
3915
_merge_tags_if_possible(other_branch, tree.branch)
3916
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3917
other_revision_id, base_revision_id, other_branch, base_branch)
3918
if other_path != '':
3919
allow_pending = False
3920
merger.interesting_files = [other_path]
3922
allow_pending = True
3923
return merger, allow_pending
3925
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3926
"""Get a merger for uncommitted changes.
3928
:param tree: The tree the merger should apply to.
3929
:param location: The location containing uncommitted changes.
3930
:param pb: The progress bar to use for showing progress.
3931
:param cleanups: A list of operations to perform to clean up the
3932
temporary directories, unfinalized objects, etc.
3934
location = self._select_branch_location(tree, location)[0]
3935
other_tree, other_path = WorkingTree.open_containing(location)
3936
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3937
if other_path != '':
3938
merger.interesting_files = [other_path]
3941
def _select_branch_location(self, tree, user_location, revision=None,
3943
"""Select a branch location, according to possible inputs.
3945
If provided, branches from ``revision`` are preferred. (Both
3946
``revision`` and ``index`` must be supplied.)
3948
Otherwise, the ``location`` parameter is used. If it is None, then the
3949
``submit`` or ``parent`` location is used, and a note is printed.
3951
:param tree: The working tree to select a branch for merging into
3952
:param location: The location entered by the user
3953
:param revision: The revision parameter to the command
3954
:param index: The index to use for the revision parameter. Negative
3955
indices are permitted.
3956
:return: (selected_location, user_location). The default location
3957
will be the user-entered location.
3959
if (revision is not None and index is not None
3960
and revision[index] is not None):
3961
branch = revision[index].get_branch()
3962
if branch is not None:
3963
return branch, branch
3964
if user_location is None:
3965
location = self._get_remembered(tree, 'Merging from')
3967
location = user_location
3968
return location, user_location
3970
def _get_remembered(self, tree, verb_string):
3971
"""Use tree.branch's parent if none was supplied.
3973
Report if the remembered location was used.
3975
stored_location = tree.branch.get_submit_branch()
3976
stored_location_type = "submit"
3977
if stored_location is None:
3978
stored_location = tree.branch.get_parent()
3979
stored_location_type = "parent"
3980
mutter("%s", stored_location)
3981
if stored_location is None:
3982
raise errors.BzrCommandError("No location specified or remembered")
3983
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3984
note(u"%s remembered %s location %s", verb_string,
3985
stored_location_type, display_url)
3986
return stored_location
3989
class cmd_remerge(Command):
3992
Use this if you want to try a different merge technique while resolving
3993
conflicts. Some merge techniques are better than others, and remerge
3994
lets you try different ones on different files.
3996
The options for remerge have the same meaning and defaults as the ones for
3997
merge. The difference is that remerge can (only) be run when there is a
3998
pending merge, and it lets you specify particular files.
4001
Re-do the merge of all conflicted files, and show the base text in
4002
conflict regions, in addition to the usual THIS and OTHER texts::
4004
bzr remerge --show-base
4006
Re-do the merge of "foobar", using the weave merge algorithm, with
4007
additional processing to reduce the size of conflict regions::
4009
bzr remerge --merge-type weave --reprocess foobar
4011
takes_args = ['file*']
4016
help="Show base revision text in conflicts."),
4019
def run(self, file_list=None, merge_type=None, show_base=False,
4021
if merge_type is None:
4022
merge_type = _mod_merge.Merge3Merger
4023
tree, file_list = tree_files(file_list)
4026
parents = tree.get_parent_ids()
4027
if len(parents) != 2:
4028
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4029
" merges. Not cherrypicking or"
4031
repository = tree.branch.repository
4032
interesting_ids = None
4034
conflicts = tree.conflicts()
4035
if file_list is not None:
4036
interesting_ids = set()
4037
for filename in file_list:
4038
file_id = tree.path2id(filename)
4040
raise errors.NotVersionedError(filename)
4041
interesting_ids.add(file_id)
4042
if tree.kind(file_id) != "directory":
4045
for name, ie in tree.inventory.iter_entries(file_id):
4046
interesting_ids.add(ie.file_id)
4047
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4049
# Remerge only supports resolving contents conflicts
4050
allowed_conflicts = ('text conflict', 'contents conflict')
4051
restore_files = [c.path for c in conflicts
4052
if c.typestring in allowed_conflicts]
4053
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4054
tree.set_conflicts(ConflictList(new_conflicts))
4055
if file_list is not None:
4056
restore_files = file_list
4057
for filename in restore_files:
4059
restore(tree.abspath(filename))
4060
except errors.NotConflicted:
4062
# Disable pending merges, because the file texts we are remerging
4063
# have not had those merges performed. If we use the wrong parents
4064
# list, we imply that the working tree text has seen and rejected
4065
# all the changes from the other tree, when in fact those changes
4066
# have not yet been seen.
4067
pb = ui.ui_factory.nested_progress_bar()
4068
tree.set_parent_ids(parents[:1])
4070
merger = _mod_merge.Merger.from_revision_ids(pb,
4072
merger.interesting_ids = interesting_ids
4073
merger.merge_type = merge_type
4074
merger.show_base = show_base
4075
merger.reprocess = reprocess
4076
conflicts = merger.do_merge()
4078
tree.set_parent_ids(parents)
4088
class cmd_revert(Command):
4089
"""Revert files to a previous revision.
4091
Giving a list of files will revert only those files. Otherwise, all files
4092
will be reverted. If the revision is not specified with '--revision', the
4093
last committed revision is used.
4095
To remove only some changes, without reverting to a prior version, use
4096
merge instead. For example, "merge . --revision -2..-3" will remove the
4097
changes introduced by -2, without affecting the changes introduced by -1.
4098
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4100
By default, any files that have been manually changed will be backed up
4101
first. (Files changed only by merge are not backed up.) Backup files have
4102
'.~#~' appended to their name, where # is a number.
4104
When you provide files, you can use their current pathname or the pathname
4105
from the target revision. So you can use revert to "undelete" a file by
4106
name. If you name a directory, all the contents of that directory will be
4109
If you have newly added files since the target revision, they will be
4110
removed. If the files to be removed have been changed, backups will be
4111
created as above. Directories containing unknown files will not be
4114
The working tree contains a list of pending merged revisions, which will
4115
be included as parents in the next commit. Normally, revert clears that
4116
list as well as reverting the files. If any files are specified, revert
4117
leaves the pending merge list alone and reverts only the files. Use "bzr
4118
revert ." in the tree root to revert all files but keep the merge record,
4119
and "bzr revert --forget-merges" to clear the pending merge list without
4120
reverting any files.
4122
Using "bzr revert --forget-merges", it is possible to apply the changes
4123
from an arbitrary merge as a single revision. To do this, perform the
4124
merge as desired. Then doing revert with the "--forget-merges" option will
4125
keep the content of the tree as it was, but it will clear the list of
4126
pending merges. The next commit will then contain all of the changes that
4127
would have been in the merge, but without any mention of the other parent
4128
revisions. Because this technique forgets where these changes originated,
4129
it may cause additional conflicts on later merges involving the source and
4133
_see_also = ['cat', 'export']
4136
Option('no-backup', "Do not save backups of reverted files."),
4137
Option('forget-merges',
4138
'Remove pending merge marker, without changing any files.'),
4140
takes_args = ['file*']
4142
def run(self, revision=None, no_backup=False, file_list=None,
4143
forget_merges=None):
4144
tree, file_list = tree_files(file_list)
4148
tree.set_parent_ids(tree.get_parent_ids()[:1])
4150
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4155
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4156
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4157
pb = ui.ui_factory.nested_progress_bar()
4159
tree.revert(file_list, rev_tree, not no_backup, pb,
4160
report_changes=True)
4165
class cmd_assert_fail(Command):
4166
"""Test reporting of assertion failures"""
4167
# intended just for use in testing
4172
raise AssertionError("always fails")
4175
class cmd_help(Command):
4176
"""Show help on a command or other topic.
4179
_see_also = ['topics']
4181
Option('long', 'Show help on all commands.'),
4183
takes_args = ['topic?']
4184
aliases = ['?', '--help', '-?', '-h']
4187
def run(self, topic=None, long=False):
4189
if topic is None and long:
4191
bzrlib.help.help(topic)
4194
class cmd_shell_complete(Command):
4195
"""Show appropriate completions for context.
4197
For a list of all available commands, say 'bzr shell-complete'.
4199
takes_args = ['context?']
4204
def run(self, context=None):
4205
import shellcomplete
4206
shellcomplete.shellcomplete(context)
4209
class cmd_missing(Command):
4210
"""Show unmerged/unpulled revisions between two branches.
4212
OTHER_BRANCH may be local or remote.
4214
To filter on a range of revisions, you can use the command -r begin..end
4215
-r revision requests a specific revision, -r ..end or -r begin.. are
4219
1 - some missing revisions
4220
0 - no missing revisions
4224
Determine the missing revisions between this and the branch at the
4225
remembered pull location::
4229
Determine the missing revisions between this and another branch::
4231
bzr missing http://server/branch
4233
Determine the missing revisions up to a specific revision on the other
4236
bzr missing -r ..-10
4238
Determine the missing revisions up to a specific revision on this
4241
bzr missing --my-revision ..-10
4244
_see_also = ['merge', 'pull']
4245
takes_args = ['other_branch?']
4247
Option('reverse', 'Reverse the order of revisions.'),
4249
'Display changes in the local branch only.'),
4250
Option('this' , 'Same as --mine-only.'),
4251
Option('theirs-only',
4252
'Display changes in the remote branch only.'),
4253
Option('other', 'Same as --theirs-only.'),
4257
custom_help('revision',
4258
help='Filter on other branch revisions (inclusive). '
4259
'See "help revisionspec" for details.'),
4260
Option('my-revision',
4261
type=_parse_revision_str,
4262
help='Filter on local branch revisions (inclusive). '
4263
'See "help revisionspec" for details.'),
4264
Option('include-merges',
4265
'Show all revisions in addition to the mainline ones.'),
4267
encoding_type = 'replace'
4270
def run(self, other_branch=None, reverse=False, mine_only=False,
4272
log_format=None, long=False, short=False, line=False,
4273
show_ids=False, verbose=False, this=False, other=False,
4274
include_merges=False, revision=None, my_revision=None):
4275
from bzrlib.missing import find_unmerged, iter_log_revisions
4284
# TODO: We should probably check that we don't have mine-only and
4285
# theirs-only set, but it gets complicated because we also have
4286
# this and other which could be used.
4293
local_branch = Branch.open_containing(u".")[0]
4294
parent = local_branch.get_parent()
4295
if other_branch is None:
4296
other_branch = parent
4297
if other_branch is None:
4298
raise errors.BzrCommandError("No peer location known"
4300
display_url = urlutils.unescape_for_display(parent,
4302
message("Using saved parent location: "
4303
+ display_url + "\n")
4305
remote_branch = Branch.open(other_branch)
4306
if remote_branch.base == local_branch.base:
4307
remote_branch = local_branch
4309
local_revid_range = _revision_range_to_revid_range(
4310
_get_revision_range(my_revision, local_branch,
4313
remote_revid_range = _revision_range_to_revid_range(
4314
_get_revision_range(revision,
4315
remote_branch, self.name()))
4317
local_branch.lock_read()
4319
remote_branch.lock_read()
4321
local_extra, remote_extra = find_unmerged(
4322
local_branch, remote_branch, restrict,
4323
backward=not reverse,
4324
include_merges=include_merges,
4325
local_revid_range=local_revid_range,
4326
remote_revid_range=remote_revid_range)
4328
if log_format is None:
4329
registry = log.log_formatter_registry
4330
log_format = registry.get_default(local_branch)
4331
lf = log_format(to_file=self.outf,
4333
show_timezone='original')
4336
if local_extra and not theirs_only:
4337
message("You have %d extra revision(s):\n" %
4339
for revision in iter_log_revisions(local_extra,
4340
local_branch.repository,
4342
lf.log_revision(revision)
4343
printed_local = True
4346
printed_local = False
4348
if remote_extra and not mine_only:
4349
if printed_local is True:
4351
message("You are missing %d revision(s):\n" %
4353
for revision in iter_log_revisions(remote_extra,
4354
remote_branch.repository,
4356
lf.log_revision(revision)
4359
if mine_only and not local_extra:
4360
# We checked local, and found nothing extra
4361
message('This branch is up to date.\n')
4362
elif theirs_only and not remote_extra:
4363
# We checked remote, and found nothing extra
4364
message('Other branch is up to date.\n')
4365
elif not (mine_only or theirs_only or local_extra or
4367
# We checked both branches, and neither one had extra
4369
message("Branches are up to date.\n")
4371
remote_branch.unlock()
4373
local_branch.unlock()
4374
if not status_code and parent is None and other_branch is not None:
4375
local_branch.lock_write()
4377
# handle race conditions - a parent might be set while we run.
4378
if local_branch.get_parent() is None:
4379
local_branch.set_parent(remote_branch.base)
4381
local_branch.unlock()
4385
class cmd_pack(Command):
4386
"""Compress the data within a repository."""
4388
_see_also = ['repositories']
4389
takes_args = ['branch_or_repo?']
4391
def run(self, branch_or_repo='.'):
4392
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4394
branch = dir.open_branch()
4395
repository = branch.repository
4396
except errors.NotBranchError:
4397
repository = dir.open_repository()
4401
class cmd_plugins(Command):
4402
"""List the installed plugins.
4404
This command displays the list of installed plugins including
4405
version of plugin and a short description of each.
4407
--verbose shows the path where each plugin is located.
4409
A plugin is an external component for Bazaar that extends the
4410
revision control system, by adding or replacing code in Bazaar.
4411
Plugins can do a variety of things, including overriding commands,
4412
adding new commands, providing additional network transports and
4413
customizing log output.
4415
See the Bazaar web site, http://bazaar-vcs.org, for further
4416
information on plugins including where to find them and how to
4417
install them. Instructions are also provided there on how to
4418
write new plugins using the Python programming language.
4420
takes_options = ['verbose']
4423
def run(self, verbose=False):
4424
import bzrlib.plugin
4425
from inspect import getdoc
4427
for name, plugin in bzrlib.plugin.plugins().items():
4428
version = plugin.__version__
4429
if version == 'unknown':
4431
name_ver = '%s %s' % (name, version)
4432
d = getdoc(plugin.module)
4434
doc = d.split('\n')[0]
4436
doc = '(no description)'
4437
result.append((name_ver, doc, plugin.path()))
4438
for name_ver, doc, path in sorted(result):
4446
class cmd_testament(Command):
4447
"""Show testament (signing-form) of a revision."""
4450
Option('long', help='Produce long-format testament.'),
4452
help='Produce a strict-format testament.')]
4453
takes_args = ['branch?']
4455
def run(self, branch=u'.', revision=None, long=False, strict=False):
4456
from bzrlib.testament import Testament, StrictTestament
4458
testament_class = StrictTestament
4460
testament_class = Testament
4462
b = Branch.open_containing(branch)[0]
4464
b = Branch.open(branch)
4467
if revision is None:
4468
rev_id = b.last_revision()
4470
rev_id = revision[0].as_revision_id(b)
4471
t = testament_class.from_revision(b.repository, rev_id)
4473
sys.stdout.writelines(t.as_text_lines())
4475
sys.stdout.write(t.as_short_text())
4480
class cmd_annotate(Command):
4481
"""Show the origin of each line in a file.
4483
This prints out the given file with an annotation on the left side
4484
indicating which revision, author and date introduced the change.
4486
If the origin is the same for a run of consecutive lines, it is
4487
shown only at the top, unless the --all option is given.
4489
# TODO: annotate directories; showing when each file was last changed
4490
# TODO: if the working copy is modified, show annotations on that
4491
# with new uncommitted lines marked
4492
aliases = ['ann', 'blame', 'praise']
4493
takes_args = ['filename']
4494
takes_options = [Option('all', help='Show annotations on all lines.'),
4495
Option('long', help='Show commit date in annotations.'),
4499
encoding_type = 'exact'
4502
def run(self, filename, all=False, long=False, revision=None,
4504
from bzrlib.annotate import annotate_file, annotate_file_tree
4505
wt, branch, relpath = \
4506
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4512
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4514
file_id = wt.path2id(relpath)
4516
file_id = tree.path2id(relpath)
4518
raise errors.NotVersionedError(filename)
4519
file_version = tree.inventory[file_id].revision
4520
if wt is not None and revision is None:
4521
# If there is a tree and we're not annotating historical
4522
# versions, annotate the working tree's content.
4523
annotate_file_tree(wt, file_id, self.outf, long, all,
4526
annotate_file(branch, file_version, file_id, long, all, self.outf,
4535
class cmd_re_sign(Command):
4536
"""Create a digital signature for an existing revision."""
4537
# TODO be able to replace existing ones.
4539
hidden = True # is this right ?
4540
takes_args = ['revision_id*']
4541
takes_options = ['revision']
4543
def run(self, revision_id_list=None, revision=None):
4544
if revision_id_list is not None and revision is not None:
4545
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4546
if revision_id_list is None and revision is None:
4547
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4548
b = WorkingTree.open_containing(u'.')[0].branch
4551
return self._run(b, revision_id_list, revision)
4555
def _run(self, b, revision_id_list, revision):
4556
import bzrlib.gpg as gpg
4557
gpg_strategy = gpg.GPGStrategy(b.get_config())
4558
if revision_id_list is not None:
4559
b.repository.start_write_group()
4561
for revision_id in revision_id_list:
4562
b.repository.sign_revision(revision_id, gpg_strategy)
4564
b.repository.abort_write_group()
4567
b.repository.commit_write_group()
4568
elif revision is not None:
4569
if len(revision) == 1:
4570
revno, rev_id = revision[0].in_history(b)
4571
b.repository.start_write_group()
4573
b.repository.sign_revision(rev_id, gpg_strategy)
4575
b.repository.abort_write_group()
4578
b.repository.commit_write_group()
4579
elif len(revision) == 2:
4580
# are they both on rh- if so we can walk between them
4581
# might be nice to have a range helper for arbitrary
4582
# revision paths. hmm.
4583
from_revno, from_revid = revision[0].in_history(b)
4584
to_revno, to_revid = revision[1].in_history(b)
4585
if to_revid is None:
4586
to_revno = b.revno()
4587
if from_revno is None or to_revno is None:
4588
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4589
b.repository.start_write_group()
4591
for revno in range(from_revno, to_revno + 1):
4592
b.repository.sign_revision(b.get_rev_id(revno),
4595
b.repository.abort_write_group()
4598
b.repository.commit_write_group()
4600
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4603
class cmd_bind(Command):
4604
"""Convert the current branch into a checkout of the supplied branch.
4606
Once converted into a checkout, commits must succeed on the master branch
4607
before they will be applied to the local branch.
4609
Bound branches use the nickname of its master branch unless it is set
4610
locally, in which case binding will update the local nickname to be
4614
_see_also = ['checkouts', 'unbind']
4615
takes_args = ['location?']
4618
def run(self, location=None):
4619
b, relpath = Branch.open_containing(u'.')
4620
if location is None:
4622
location = b.get_old_bound_location()
4623
except errors.UpgradeRequired:
4624
raise errors.BzrCommandError('No location supplied. '
4625
'This format does not remember old locations.')
4627
if location is None:
4628
raise errors.BzrCommandError('No location supplied and no '
4629
'previous location known')
4630
b_other = Branch.open(location)
4633
except errors.DivergedBranches:
4634
raise errors.BzrCommandError('These branches have diverged.'
4635
' Try merging, and then bind again.')
4636
if b.get_config().has_explicit_nickname():
4637
b.nick = b_other.nick
4640
class cmd_unbind(Command):
4641
"""Convert the current checkout into a regular branch.
4643
After unbinding, the local branch is considered independent and subsequent
4644
commits will be local only.
4647
_see_also = ['checkouts', 'bind']
4652
b, relpath = Branch.open_containing(u'.')
4654
raise errors.BzrCommandError('Local branch is not bound')
4657
class cmd_uncommit(Command):
4658
"""Remove the last committed revision.
4660
--verbose will print out what is being removed.
4661
--dry-run will go through all the motions, but not actually
4664
If --revision is specified, uncommit revisions to leave the branch at the
4665
specified revision. For example, "bzr uncommit -r 15" will leave the
4666
branch at revision 15.
4668
Uncommit leaves the working tree ready for a new commit. The only change
4669
it may make is to restore any pending merges that were present before
4673
# TODO: jam 20060108 Add an option to allow uncommit to remove
4674
# unreferenced information in 'branch-as-repository' branches.
4675
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4676
# information in shared branches as well.
4677
_see_also = ['commit']
4678
takes_options = ['verbose', 'revision',
4679
Option('dry-run', help='Don\'t actually make changes.'),
4680
Option('force', help='Say yes to all questions.'),
4682
help="Only remove the commits from the local branch"
4683
" when in a checkout."
4686
takes_args = ['location?']
4688
encoding_type = 'replace'
4690
def run(self, location=None,
4691
dry_run=False, verbose=False,
4692
revision=None, force=False, local=False):
4693
if location is None:
4695
control, relpath = bzrdir.BzrDir.open_containing(location)
4697
tree = control.open_workingtree()
4699
except (errors.NoWorkingTree, errors.NotLocalUrl):
4701
b = control.open_branch()
4703
if tree is not None:
4708
return self._run(b, tree, dry_run, verbose, revision, force,
4711
if tree is not None:
4716
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4717
from bzrlib.log import log_formatter, show_log
4718
from bzrlib.uncommit import uncommit
4720
last_revno, last_rev_id = b.last_revision_info()
4723
if revision is None:
4725
rev_id = last_rev_id
4727
# 'bzr uncommit -r 10' actually means uncommit
4728
# so that the final tree is at revno 10.
4729
# but bzrlib.uncommit.uncommit() actually uncommits
4730
# the revisions that are supplied.
4731
# So we need to offset it by one
4732
revno = revision[0].in_history(b).revno + 1
4733
if revno <= last_revno:
4734
rev_id = b.get_rev_id(revno)
4736
if rev_id is None or _mod_revision.is_null(rev_id):
4737
self.outf.write('No revisions to uncommit.\n')
4740
lf = log_formatter('short',
4742
show_timezone='original')
4747
direction='forward',
4748
start_revision=revno,
4749
end_revision=last_revno)
4752
print 'Dry-run, pretending to remove the above revisions.'
4754
val = raw_input('Press <enter> to continue')
4756
print 'The above revision(s) will be removed.'
4758
val = raw_input('Are you sure [y/N]? ')
4759
if val.lower() not in ('y', 'yes'):
4763
mutter('Uncommitting from {%s} to {%s}',
4764
last_rev_id, rev_id)
4765
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4766
revno=revno, local=local)
4767
note('You can restore the old tip by running:\n'
4768
' bzr pull . -r revid:%s', last_rev_id)
4771
class cmd_break_lock(Command):
4772
"""Break a dead lock on a repository, branch or working directory.
4774
CAUTION: Locks should only be broken when you are sure that the process
4775
holding the lock has been stopped.
4777
You can get information on what locks are open via the 'bzr info' command.
4782
takes_args = ['location?']
4784
def run(self, location=None, show=False):
4785
if location is None:
4787
control, relpath = bzrdir.BzrDir.open_containing(location)
4789
control.break_lock()
4790
except NotImplementedError:
4794
class cmd_wait_until_signalled(Command):
4795
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4797
This just prints a line to signal when it is ready, then blocks on stdin.
4803
sys.stdout.write("running\n")
4805
sys.stdin.readline()
4808
class cmd_serve(Command):
4809
"""Run the bzr server."""
4811
aliases = ['server']
4815
help='Serve on stdin/out for use from inetd or sshd.'),
4816
RegistryOption('protocol',
4817
help="Protocol to serve.",
4818
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4819
value_switches=True),
4821
help='Listen for connections on nominated port of the form '
4822
'[hostname:]portnumber. Passing 0 as the port number will '
4823
'result in a dynamically allocated port. The default port '
4824
'depends on the protocol.',
4827
help='Serve contents of this directory.',
4829
Option('allow-writes',
4830
help='By default the server is a readonly server. Supplying '
4831
'--allow-writes enables write access to the contents of '
4832
'the served directory and below. Note that ``bzr serve`` '
4833
'does not perform authentication, so unless some form of '
4834
'external authentication is arranged supplying this '
4835
'option leads to global uncontrolled write access to your '
4840
def get_host_and_port(self, port):
4841
"""Return the host and port to run the smart server on.
4843
If 'port' is None, None will be returned for the host and port.
4845
If 'port' has a colon in it, the string before the colon will be
4846
interpreted as the host.
4848
:param port: A string of the port to run the server on.
4849
:return: A tuple of (host, port), where 'host' is a host name or IP,
4850
and port is an integer TCP/IP port.
4853
if port is not None:
4855
host, port = port.split(':')
4859
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4861
from bzrlib.transport import get_transport, transport_server_registry
4862
if directory is None:
4863
directory = os.getcwd()
4864
if protocol is None:
4865
protocol = transport_server_registry.get()
4866
host, port = self.get_host_and_port(port)
4867
url = urlutils.local_path_to_url(directory)
4868
if not allow_writes:
4869
url = 'readonly+' + url
4870
transport = get_transport(url)
4871
protocol(transport, host, port, inet)
4874
class cmd_join(Command):
4875
"""Combine a tree into its containing tree.
4877
This command requires the target tree to be in a rich-root format.
4879
The TREE argument should be an independent tree, inside another tree, but
4880
not part of it. (Such trees can be produced by "bzr split", but also by
4881
running "bzr branch" with the target inside a tree.)
4883
The result is a combined tree, with the subtree no longer an independant
4884
part. This is marked as a merge of the subtree into the containing tree,
4885
and all history is preserved.
4888
_see_also = ['split']
4889
takes_args = ['tree']
4891
Option('reference', help='Join by reference.', hidden=True),
4894
def run(self, tree, reference=False):
4895
sub_tree = WorkingTree.open(tree)
4896
parent_dir = osutils.dirname(sub_tree.basedir)
4897
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4898
repo = containing_tree.branch.repository
4899
if not repo.supports_rich_root():
4900
raise errors.BzrCommandError(
4901
"Can't join trees because %s doesn't support rich root data.\n"
4902
"You can use bzr upgrade on the repository."
4906
containing_tree.add_reference(sub_tree)
4907
except errors.BadReferenceTarget, e:
4908
# XXX: Would be better to just raise a nicely printable
4909
# exception from the real origin. Also below. mbp 20070306
4910
raise errors.BzrCommandError("Cannot join %s. %s" %
4914
containing_tree.subsume(sub_tree)
4915
except errors.BadSubsumeSource, e:
4916
raise errors.BzrCommandError("Cannot join %s. %s" %
4920
class cmd_split(Command):
4921
"""Split a subdirectory of a tree into a separate tree.
4923
This command will produce a target tree in a format that supports
4924
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4925
converted into earlier formats like 'dirstate-tags'.
4927
The TREE argument should be a subdirectory of a working tree. That
4928
subdirectory will be converted into an independent tree, with its own
4929
branch. Commits in the top-level tree will not apply to the new subtree.
4932
_see_also = ['join']
4933
takes_args = ['tree']
4935
def run(self, tree):
4936
containing_tree, subdir = WorkingTree.open_containing(tree)
4937
sub_id = containing_tree.path2id(subdir)
4939
raise errors.NotVersionedError(subdir)
4941
containing_tree.extract(sub_id)
4942
except errors.RootNotRich:
4943
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4946
class cmd_merge_directive(Command):
4947
"""Generate a merge directive for auto-merge tools.
4949
A directive requests a merge to be performed, and also provides all the
4950
information necessary to do so. This means it must either include a
4951
revision bundle, or the location of a branch containing the desired
4954
A submit branch (the location to merge into) must be supplied the first
4955
time the command is issued. After it has been supplied once, it will
4956
be remembered as the default.
4958
A public branch is optional if a revision bundle is supplied, but required
4959
if --diff or --plain is specified. It will be remembered as the default
4960
after the first use.
4963
takes_args = ['submit_branch?', 'public_branch?']
4967
_see_also = ['send']
4970
RegistryOption.from_kwargs('patch-type',
4971
'The type of patch to include in the directive.',
4973
value_switches=True,
4975
bundle='Bazaar revision bundle (default).',
4976
diff='Normal unified diff.',
4977
plain='No patch, just directive.'),
4978
Option('sign', help='GPG-sign the directive.'), 'revision',
4979
Option('mail-to', type=str,
4980
help='Instead of printing the directive, email to this address.'),
4981
Option('message', type=str, short_name='m',
4982
help='Message to use when committing this merge.')
4985
encoding_type = 'exact'
4987
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4988
sign=False, revision=None, mail_to=None, message=None):
4989
from bzrlib.revision import ensure_null, NULL_REVISION
4990
include_patch, include_bundle = {
4991
'plain': (False, False),
4992
'diff': (True, False),
4993
'bundle': (True, True),
4995
branch = Branch.open('.')
4996
stored_submit_branch = branch.get_submit_branch()
4997
if submit_branch is None:
4998
submit_branch = stored_submit_branch
5000
if stored_submit_branch is None:
5001
branch.set_submit_branch(submit_branch)
5002
if submit_branch is None:
5003
submit_branch = branch.get_parent()
5004
if submit_branch is None:
5005
raise errors.BzrCommandError('No submit branch specified or known')
5007
stored_public_branch = branch.get_public_branch()
5008
if public_branch is None:
5009
public_branch = stored_public_branch
5010
elif stored_public_branch is None:
5011
branch.set_public_branch(public_branch)
5012
if not include_bundle and public_branch is None:
5013
raise errors.BzrCommandError('No public branch specified or'
5015
base_revision_id = None
5016
if revision is not None:
5017
if len(revision) > 2:
5018
raise errors.BzrCommandError('bzr merge-directive takes '
5019
'at most two one revision identifiers')
5020
revision_id = revision[-1].as_revision_id(branch)
5021
if len(revision) == 2:
5022
base_revision_id = revision[0].as_revision_id(branch)
5024
revision_id = branch.last_revision()
5025
revision_id = ensure_null(revision_id)
5026
if revision_id == NULL_REVISION:
5027
raise errors.BzrCommandError('No revisions to bundle.')
5028
directive = merge_directive.MergeDirective2.from_objects(
5029
branch.repository, revision_id, time.time(),
5030
osutils.local_time_offset(), submit_branch,
5031
public_branch=public_branch, include_patch=include_patch,
5032
include_bundle=include_bundle, message=message,
5033
base_revision_id=base_revision_id)
5036
self.outf.write(directive.to_signed(branch))
5038
self.outf.writelines(directive.to_lines())
5040
message = directive.to_email(mail_to, branch, sign)
5041
s = SMTPConnection(branch.get_config())
5042
s.send_email(message)
5045
class cmd_send(Command):
5046
"""Mail or create a merge-directive for submitting changes.
5048
A merge directive provides many things needed for requesting merges:
5050
* A machine-readable description of the merge to perform
5052
* An optional patch that is a preview of the changes requested
5054
* An optional bundle of revision data, so that the changes can be applied
5055
directly from the merge directive, without retrieving data from a
5058
If --no-bundle is specified, then public_branch is needed (and must be
5059
up-to-date), so that the receiver can perform the merge using the
5060
public_branch. The public_branch is always included if known, so that
5061
people can check it later.
5063
The submit branch defaults to the parent, but can be overridden. Both
5064
submit branch and public branch will be remembered if supplied.
5066
If a public_branch is known for the submit_branch, that public submit
5067
branch is used in the merge instructions. This means that a local mirror
5068
can be used as your actual submit branch, once you have set public_branch
5071
Mail is sent using your preferred mail program. This should be transparent
5072
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5073
If the preferred client can't be found (or used), your editor will be used.
5075
To use a specific mail program, set the mail_client configuration option.
5076
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5077
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5078
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5079
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5082
If mail is being sent, a to address is required. This can be supplied
5083
either on the commandline, by setting the submit_to configuration
5084
option in the branch itself or the child_submit_to configuration option
5085
in the submit branch.
5087
Two formats are currently supported: "4" uses revision bundle format 4 and
5088
merge directive format 2. It is significantly faster and smaller than
5089
older formats. It is compatible with Bazaar 0.19 and later. It is the
5090
default. "0.9" uses revision bundle format 0.9 and merge directive
5091
format 1. It is compatible with Bazaar 0.12 - 0.18.
5093
The merge directives created by bzr send may be applied using bzr merge or
5094
bzr pull by specifying a file containing a merge directive as the location.
5097
encoding_type = 'exact'
5099
_see_also = ['merge', 'pull']
5101
takes_args = ['submit_branch?', 'public_branch?']
5105
help='Do not include a bundle in the merge directive.'),
5106
Option('no-patch', help='Do not include a preview patch in the merge'
5109
help='Remember submit and public branch.'),
5111
help='Branch to generate the submission from, '
5112
'rather than the one containing the working directory.',
5115
Option('output', short_name='o',
5116
help='Write merge directive to this file; '
5117
'use - for stdout.',
5120
help='Refuse to send if there are uncommitted changes in'
5121
' the working tree, --no-strict disables the check.'),
5122
Option('mail-to', help='Mail the request to this address.',
5126
Option('body', help='Body for the email.', type=unicode),
5127
RegistryOption('format',
5128
help='Use the specified output format.',
5129
lazy_registry=('bzrlib.send', 'format_registry')),
5132
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5133
no_patch=False, revision=None, remember=False, output=None,
5134
format=None, mail_to=None, message=None, body=None,
5135
strict=None, **kwargs):
5136
from bzrlib.send import send
5137
return send(submit_branch, revision, public_branch, remember,
5138
format, no_bundle, no_patch, output,
5139
kwargs.get('from', '.'), mail_to, message, body,
5144
class cmd_bundle_revisions(cmd_send):
5145
"""Create a merge-directive for submitting changes.
5147
A merge directive provides many things needed for requesting merges:
5149
* A machine-readable description of the merge to perform
5151
* An optional patch that is a preview of the changes requested
5153
* An optional bundle of revision data, so that the changes can be applied
5154
directly from the merge directive, without retrieving data from a
5157
If --no-bundle is specified, then public_branch is needed (and must be
5158
up-to-date), so that the receiver can perform the merge using the
5159
public_branch. The public_branch is always included if known, so that
5160
people can check it later.
5162
The submit branch defaults to the parent, but can be overridden. Both
5163
submit branch and public branch will be remembered if supplied.
5165
If a public_branch is known for the submit_branch, that public submit
5166
branch is used in the merge instructions. This means that a local mirror
5167
can be used as your actual submit branch, once you have set public_branch
5170
Two formats are currently supported: "4" uses revision bundle format 4 and
5171
merge directive format 2. It is significantly faster and smaller than
5172
older formats. It is compatible with Bazaar 0.19 and later. It is the
5173
default. "0.9" uses revision bundle format 0.9 and merge directive
5174
format 1. It is compatible with Bazaar 0.12 - 0.18.
5179
help='Do not include a bundle in the merge directive.'),
5180
Option('no-patch', help='Do not include a preview patch in the merge'
5183
help='Remember submit and public branch.'),
5185
help='Branch to generate the submission from, '
5186
'rather than the one containing the working directory.',
5189
Option('output', short_name='o', help='Write directive to this file.',
5192
help='Refuse to bundle revisions if there are uncommitted'
5193
' changes in the working tree, --no-strict disables the check.'),
5195
RegistryOption('format',
5196
help='Use the specified output format.',
5197
lazy_registry=('bzrlib.send', 'format_registry')),
5199
aliases = ['bundle']
5201
_see_also = ['send', 'merge']
5205
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5206
no_patch=False, revision=None, remember=False, output=None,
5207
format=None, strict=None, **kwargs):
5210
from bzrlib.send import send
5211
return send(submit_branch, revision, public_branch, remember,
5212
format, no_bundle, no_patch, output,
5213
kwargs.get('from', '.'), None, None, None,
5214
self.outf, strict=strict)
5217
class cmd_tag(Command):
5218
"""Create, remove or modify a tag naming a revision.
5220
Tags give human-meaningful names to revisions. Commands that take a -r
5221
(--revision) option can be given -rtag:X, where X is any previously
5224
Tags are stored in the branch. Tags are copied from one branch to another
5225
along when you branch, push, pull or merge.
5227
It is an error to give a tag name that already exists unless you pass
5228
--force, in which case the tag is moved to point to the new revision.
5230
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5231
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5234
_see_also = ['commit', 'tags']
5235
takes_args = ['tag_name']
5238
help='Delete this tag rather than placing it.',
5241
help='Branch in which to place the tag.',
5246
help='Replace existing tags.',
5251
def run(self, tag_name,
5257
branch, relpath = Branch.open_containing(directory)
5261
branch.tags.delete_tag(tag_name)
5262
self.outf.write('Deleted tag %s.\n' % tag_name)
5265
if len(revision) != 1:
5266
raise errors.BzrCommandError(
5267
"Tags can only be placed on a single revision, "
5269
revision_id = revision[0].as_revision_id(branch)
5271
revision_id = branch.last_revision()
5272
if (not force) and branch.tags.has_tag(tag_name):
5273
raise errors.TagAlreadyExists(tag_name)
5274
branch.tags.set_tag(tag_name, revision_id)
5275
self.outf.write('Created tag %s.\n' % tag_name)
5280
class cmd_tags(Command):
5283
This command shows a table of tag names and the revisions they reference.
5289
help='Branch whose tags should be displayed.',
5293
RegistryOption.from_kwargs('sort',
5294
'Sort tags by different criteria.', title='Sorting',
5295
alpha='Sort tags lexicographically (default).',
5296
time='Sort tags chronologically.',
5309
branch, relpath = Branch.open_containing(directory)
5311
tags = branch.tags.get_tag_dict().items()
5318
graph = branch.repository.get_graph()
5319
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5320
revid1, revid2 = rev1.rev_id, rev2.rev_id
5321
# only show revisions between revid1 and revid2 (inclusive)
5322
tags = [(tag, revid) for tag, revid in tags if
5323
graph.is_between(revid, revid1, revid2)]
5326
elif sort == 'time':
5328
for tag, revid in tags:
5330
revobj = branch.repository.get_revision(revid)
5331
except errors.NoSuchRevision:
5332
timestamp = sys.maxint # place them at the end
5334
timestamp = revobj.timestamp
5335
timestamps[revid] = timestamp
5336
tags.sort(key=lambda x: timestamps[x[1]])
5338
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5339
for index, (tag, revid) in enumerate(tags):
5341
revno = branch.revision_id_to_dotted_revno(revid)
5342
if isinstance(revno, tuple):
5343
revno = '.'.join(map(str, revno))
5344
except errors.NoSuchRevision:
5345
# Bad tag data/merges can lead to tagged revisions
5346
# which are not in this branch. Fail gracefully ...
5348
tags[index] = (tag, revno)
5351
for tag, revspec in tags:
5352
self.outf.write('%-20s %s\n' % (tag, revspec))
5355
class cmd_reconfigure(Command):
5356
"""Reconfigure the type of a bzr directory.
5358
A target configuration must be specified.
5360
For checkouts, the bind-to location will be auto-detected if not specified.
5361
The order of preference is
5362
1. For a lightweight checkout, the current bound location.
5363
2. For branches that used to be checkouts, the previously-bound location.
5364
3. The push location.
5365
4. The parent location.
5366
If none of these is available, --bind-to must be specified.
5369
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5370
takes_args = ['location?']
5372
RegistryOption.from_kwargs(
5374
title='Target type',
5375
help='The type to reconfigure the directory to.',
5376
value_switches=True, enum_switch=False,
5377
branch='Reconfigure to be an unbound branch with no working tree.',
5378
tree='Reconfigure to be an unbound branch with a working tree.',
5379
checkout='Reconfigure to be a bound branch with a working tree.',
5380
lightweight_checkout='Reconfigure to be a lightweight'
5381
' checkout (with no local history).',
5382
standalone='Reconfigure to be a standalone branch '
5383
'(i.e. stop using shared repository).',
5384
use_shared='Reconfigure to use a shared repository.',
5385
with_trees='Reconfigure repository to create '
5386
'working trees on branches by default.',
5387
with_no_trees='Reconfigure repository to not create '
5388
'working trees on branches by default.'
5390
Option('bind-to', help='Branch to bind checkout to.', type=str),
5392
help='Perform reconfiguration even if local changes'
5394
Option('stacked-on',
5395
help='Reconfigure a branch to be stacked on another branch.',
5399
help='Reconfigure a branch to be unstacked. This '
5400
'may require copying substantial data into it.',
5404
def run(self, location=None, target_type=None, bind_to=None, force=False,
5407
directory = bzrdir.BzrDir.open(location)
5408
if stacked_on and unstacked:
5409
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5410
elif stacked_on is not None:
5411
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5413
reconfigure.ReconfigureUnstacked().apply(directory)
5414
# At the moment you can use --stacked-on and a different
5415
# reconfiguration shape at the same time; there seems no good reason
5417
if target_type is None:
5418
if stacked_on or unstacked:
5421
raise errors.BzrCommandError('No target configuration '
5423
elif target_type == 'branch':
5424
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5425
elif target_type == 'tree':
5426
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5427
elif target_type == 'checkout':
5428
reconfiguration = reconfigure.Reconfigure.to_checkout(
5430
elif target_type == 'lightweight-checkout':
5431
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5433
elif target_type == 'use-shared':
5434
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5435
elif target_type == 'standalone':
5436
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5437
elif target_type == 'with-trees':
5438
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5440
elif target_type == 'with-no-trees':
5441
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5443
reconfiguration.apply(force)
5446
class cmd_switch(Command):
5447
"""Set the branch of a checkout and update.
5449
For lightweight checkouts, this changes the branch being referenced.
5450
For heavyweight checkouts, this checks that there are no local commits
5451
versus the current bound branch, then it makes the local branch a mirror
5452
of the new location and binds to it.
5454
In both cases, the working tree is updated and uncommitted changes
5455
are merged. The user can commit or revert these as they desire.
5457
Pending merges need to be committed or reverted before using switch.
5459
The path to the branch to switch to can be specified relative to the parent
5460
directory of the current branch. For example, if you are currently in a
5461
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5464
Bound branches use the nickname of its master branch unless it is set
5465
locally, in which case switching will update the local nickname to be
5469
takes_args = ['to_location']
5470
takes_options = [Option('force',
5471
help='Switch even if local commits will be lost.'),
5472
Option('create-branch', short_name='b',
5473
help='Create the target branch from this one before'
5474
' switching to it.'),
5477
def run(self, to_location, force=False, create_branch=False):
5478
from bzrlib import switch
5480
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5482
branch = control_dir.open_branch()
5483
had_explicit_nick = branch.get_config().has_explicit_nickname()
5484
except errors.NotBranchError:
5486
had_explicit_nick = False
5489
raise errors.BzrCommandError('cannot create branch without'
5491
if '/' not in to_location and '\\' not in to_location:
5492
# This path is meant to be relative to the existing branch
5493
this_url = self._get_branch_location(control_dir)
5494
to_location = urlutils.join(this_url, '..', to_location)
5495
to_branch = branch.bzrdir.sprout(to_location,
5496
possible_transports=[branch.bzrdir.root_transport],
5497
source_branch=branch).open_branch()
5499
# from_branch = control_dir.open_branch()
5500
# except errors.NotBranchError:
5501
# raise BzrCommandError('Cannot create a branch from this'
5502
# ' location when we cannot open this branch')
5503
# from_branch.bzrdir.sprout(
5507
to_branch = Branch.open(to_location)
5508
except errors.NotBranchError:
5509
this_url = self._get_branch_location(control_dir)
5510
to_branch = Branch.open(
5511
urlutils.join(this_url, '..', to_location))
5512
switch.switch(control_dir, to_branch, force)
5513
if had_explicit_nick:
5514
branch = control_dir.open_branch() #get the new branch!
5515
branch.nick = to_branch.nick
5516
note('Switched to branch: %s',
5517
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5519
def _get_branch_location(self, control_dir):
5520
"""Return location of branch for this control dir."""
5522
this_branch = control_dir.open_branch()
5523
# This may be a heavy checkout, where we want the master branch
5524
master_location = this_branch.get_bound_location()
5525
if master_location is not None:
5526
return master_location
5527
# If not, use a local sibling
5528
return this_branch.base
5529
except errors.NotBranchError:
5530
format = control_dir.find_branch_format()
5531
if getattr(format, 'get_reference', None) is not None:
5532
return format.get_reference(control_dir)
5534
return control_dir.root_transport.base
5537
class cmd_view(Command):
5538
"""Manage filtered views.
5540
Views provide a mask over the tree so that users can focus on
5541
a subset of a tree when doing their work. After creating a view,
5542
commands that support a list of files - status, diff, commit, etc -
5543
effectively have that list of files implicitly given each time.
5544
An explicit list of files can still be given but those files
5545
must be within the current view.
5547
In most cases, a view has a short life-span: it is created to make
5548
a selected change and is deleted once that change is committed.
5549
At other times, you may wish to create one or more named views
5550
and switch between them.
5552
To disable the current view without deleting it, you can switch to
5553
the pseudo view called ``off``. This can be useful when you need
5554
to see the whole tree for an operation or two (e.g. merge) but
5555
want to switch back to your view after that.
5558
To define the current view::
5560
bzr view file1 dir1 ...
5562
To list the current view::
5566
To delete the current view::
5570
To disable the current view without deleting it::
5572
bzr view --switch off
5574
To define a named view and switch to it::
5576
bzr view --name view-name file1 dir1 ...
5578
To list a named view::
5580
bzr view --name view-name
5582
To delete a named view::
5584
bzr view --name view-name --delete
5586
To switch to a named view::
5588
bzr view --switch view-name
5590
To list all views defined::
5594
To delete all views::
5596
bzr view --delete --all
5600
takes_args = ['file*']
5603
help='Apply list or delete action to all views.',
5606
help='Delete the view.',
5609
help='Name of the view to define, list or delete.',
5613
help='Name of the view to switch to.',
5618
def run(self, file_list,
5624
tree, file_list = tree_files(file_list, apply_view=False)
5625
current_view, view_dict = tree.views.get_view_info()
5630
raise errors.BzrCommandError(
5631
"Both --delete and a file list specified")
5633
raise errors.BzrCommandError(
5634
"Both --delete and --switch specified")
5636
tree.views.set_view_info(None, {})
5637
self.outf.write("Deleted all views.\n")
5639
raise errors.BzrCommandError("No current view to delete")
5641
tree.views.delete_view(name)
5642
self.outf.write("Deleted '%s' view.\n" % name)
5645
raise errors.BzrCommandError(
5646
"Both --switch and a file list specified")
5648
raise errors.BzrCommandError(
5649
"Both --switch and --all specified")
5650
elif switch == 'off':
5651
if current_view is None:
5652
raise errors.BzrCommandError("No current view to disable")
5653
tree.views.set_view_info(None, view_dict)
5654
self.outf.write("Disabled '%s' view.\n" % (current_view))
5656
tree.views.set_view_info(switch, view_dict)
5657
view_str = views.view_display_str(tree.views.lookup_view())
5658
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5661
self.outf.write('Views defined:\n')
5662
for view in sorted(view_dict):
5663
if view == current_view:
5667
view_str = views.view_display_str(view_dict[view])
5668
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5670
self.outf.write('No views defined.\n')
5673
# No name given and no current view set
5676
raise errors.BzrCommandError(
5677
"Cannot change the 'off' pseudo view")
5678
tree.views.set_view(name, sorted(file_list))
5679
view_str = views.view_display_str(tree.views.lookup_view())
5680
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5684
# No name given and no current view set
5685
self.outf.write('No current view.\n')
5687
view_str = views.view_display_str(tree.views.lookup_view(name))
5688
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5691
class cmd_hooks(Command):
5697
for hook_key in sorted(hooks.known_hooks.keys()):
5698
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5699
self.outf.write("%s:\n" % type(some_hooks).__name__)
5700
for hook_name, hook_point in sorted(some_hooks.items()):
5701
self.outf.write(" %s:\n" % (hook_name,))
5702
found_hooks = list(hook_point)
5704
for hook in found_hooks:
5705
self.outf.write(" %s\n" %
5706
(some_hooks.get_hook_name(hook),))
5708
self.outf.write(" <no hooks installed>\n")
5711
class cmd_shelve(Command):
5712
"""Temporarily set aside some changes from the current tree.
5714
Shelve allows you to temporarily put changes you've made "on the shelf",
5715
ie. out of the way, until a later time when you can bring them back from
5716
the shelf with the 'unshelve' command. The changes are stored alongside
5717
your working tree, and so they aren't propagated along with your branch nor
5718
will they survive its deletion.
5720
If shelve --list is specified, previously-shelved changes are listed.
5722
Shelve is intended to help separate several sets of changes that have
5723
been inappropriately mingled. If you just want to get rid of all changes
5724
and you don't need to restore them later, use revert. If you want to
5725
shelve all text changes at once, use shelve --all.
5727
If filenames are specified, only the changes to those files will be
5728
shelved. Other files will be left untouched.
5730
If a revision is specified, changes since that revision will be shelved.
5732
You can put multiple items on the shelf, and by default, 'unshelve' will
5733
restore the most recently shelved changes.
5736
takes_args = ['file*']
5740
Option('all', help='Shelve all changes.'),
5742
RegistryOption('writer', 'Method to use for writing diffs.',
5743
bzrlib.option.diff_writer_registry,
5744
value_switches=True, enum_switch=False),
5746
Option('list', help='List shelved changes.'),
5748
help='Destroy removed changes instead of shelving them.'),
5750
_see_also = ['unshelve']
5752
def run(self, revision=None, all=False, file_list=None, message=None,
5753
writer=None, list=False, destroy=False):
5755
return self.run_for_list()
5756
from bzrlib.shelf_ui import Shelver
5758
writer = bzrlib.option.diff_writer_registry.get()
5760
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5761
file_list, message, destroy=destroy)
5766
except errors.UserAbort:
5769
def run_for_list(self):
5770
tree = WorkingTree.open_containing('.')[0]
5773
manager = tree.get_shelf_manager()
5774
shelves = manager.active_shelves()
5775
if len(shelves) == 0:
5776
note('No shelved changes.')
5778
for shelf_id in reversed(shelves):
5779
message = manager.get_metadata(shelf_id).get('message')
5781
message = '<no message>'
5782
self.outf.write('%3d: %s\n' % (shelf_id, message))
5788
class cmd_unshelve(Command):
5789
"""Restore shelved changes.
5791
By default, the most recently shelved changes are restored. However if you
5792
specify a shelf by id those changes will be restored instead. This works
5793
best when the changes don't depend on each other.
5796
takes_args = ['shelf_id?']
5798
RegistryOption.from_kwargs(
5799
'action', help="The action to perform.",
5800
enum_switch=False, value_switches=True,
5801
apply="Apply changes and remove from the shelf.",
5802
dry_run="Show changes, but do not apply or remove them.",
5803
delete_only="Delete changes without applying them.",
5804
keep="Apply changes but don't delete them.",
5807
_see_also = ['shelve']
5809
def run(self, shelf_id=None, action='apply'):
5810
from bzrlib.shelf_ui import Unshelver
5811
unshelver = Unshelver.from_args(shelf_id, action)
5815
unshelver.tree.unlock()
5818
class cmd_clean_tree(Command):
5819
"""Remove unwanted files from working tree.
5821
By default, only unknown files, not ignored files, are deleted. Versioned
5822
files are never deleted.
5824
Another class is 'detritus', which includes files emitted by bzr during
5825
normal operations and selftests. (The value of these files decreases with
5828
If no options are specified, unknown files are deleted. Otherwise, option
5829
flags are respected, and may be combined.
5831
To check what clean-tree will do, use --dry-run.
5833
takes_options = [Option('ignored', help='Delete all ignored files.'),
5834
Option('detritus', help='Delete conflict files, merge'
5835
' backups, and failed selftest dirs.'),
5837
help='Delete files unknown to bzr (default).'),
5838
Option('dry-run', help='Show files to delete instead of'
5840
Option('force', help='Do not prompt before deleting.')]
5841
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5843
from bzrlib.clean_tree import clean_tree
5844
if not (unknown or ignored or detritus):
5848
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5849
dry_run=dry_run, no_prompt=force)
5852
class cmd_reference(Command):
5853
"""list, view and set branch locations for nested trees.
5855
If no arguments are provided, lists the branch locations for nested trees.
5856
If one argument is provided, display the branch location for that tree.
5857
If two arguments are provided, set the branch location for that tree.
5862
takes_args = ['path?', 'location?']
5864
def run(self, path=None, location=None):
5866
if path is not None:
5868
tree, branch, relpath =(
5869
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5870
if path is not None:
5873
tree = branch.basis_tree()
5875
info = branch._get_all_reference_info().iteritems()
5876
self._display_reference_info(tree, branch, info)
5878
file_id = tree.path2id(path)
5880
raise errors.NotVersionedError(path)
5881
if location is None:
5882
info = [(file_id, branch.get_reference_info(file_id))]
5883
self._display_reference_info(tree, branch, info)
5885
branch.set_reference_info(file_id, path, location)
5887
def _display_reference_info(self, tree, branch, info):
5889
for file_id, (path, location) in info:
5891
path = tree.id2path(file_id)
5892
except errors.NoSuchId:
5894
ref_list.append((path, location))
5895
for path, location in sorted(ref_list):
5896
self.outf.write('%s %s\n' % (path, location))
5899
# these get imported and then picked up by the scan for cmd_*
5900
# TODO: Some more consistent way to split command definitions across files;
5901
# we do need to load at least some information about them to know of
5902
# aliases. ideally we would avoid loading the implementation until the
5903
# details were needed.
5904
from bzrlib.cmd_version_info import cmd_version_info
5905
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5906
from bzrlib.bundle.commands import (
5909
from bzrlib.foreign import cmd_dpush
5910
from bzrlib.sign_my_commits import cmd_sign_my_commits
5911
from bzrlib.weave_commands import cmd_versionedfile_list, \
5912
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
