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,
53
from bzrlib.branch import Branch
54
from bzrlib.conflicts import ConflictList
55
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
56
from bzrlib.smtp_connection import SMTPConnection
57
from bzrlib.workingtree import WorkingTree
60
from bzrlib.commands import Command, display_command
61
from bzrlib.option import (
68
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
71
def tree_files(file_list, default_branch=u'.', canonicalize=True,
74
return internal_tree_files(file_list, default_branch, canonicalize,
76
except errors.FileInWrongBranch, e:
77
raise errors.BzrCommandError("%s is not in the same branch as %s" %
78
(e.path, file_list[0]))
81
def tree_files_for_add(file_list):
83
Return a tree and list of absolute paths from a file list.
85
Similar to tree_files, but add handles files a bit differently, so it a
86
custom implementation. In particular, MutableTreeTree.smart_add expects
87
absolute paths, which it immediately converts to relative paths.
89
# FIXME Would be nice to just return the relative paths like
90
# internal_tree_files does, but there are a large number of unit tests
91
# that assume the current interface to mutabletree.smart_add
93
tree, relpath = WorkingTree.open_containing(file_list[0])
94
if tree.supports_views():
95
view_files = tree.views.lookup_view()
97
for filename in file_list:
98
if not osutils.is_inside_any(view_files, filename):
99
raise errors.FileOutsideView(filename, view_files)
100
file_list = file_list[:]
101
file_list[0] = tree.abspath(relpath)
103
tree = WorkingTree.open_containing(u'.')[0]
104
if tree.supports_views():
105
view_files = tree.views.lookup_view()
107
file_list = view_files
108
view_str = views.view_display_str(view_files)
109
note("Ignoring files outside view. View is %s" % view_str)
110
return tree, file_list
113
def _get_one_revision(command_name, revisions):
114
if revisions is None:
116
if len(revisions) != 1:
117
raise errors.BzrCommandError(
118
'bzr %s --revision takes exactly one revision identifier' % (
123
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
124
"""Get a revision tree. Not suitable for commands that change the tree.
126
Specifically, the basis tree in dirstate trees is coupled to the dirstate
127
and doing a commit/uncommit/pull will at best fail due to changing the
130
If tree is passed in, it should be already locked, for lifetime management
131
of the trees internal cached state.
135
if revisions is None:
137
rev_tree = tree.basis_tree()
139
rev_tree = branch.basis_tree()
141
revision = _get_one_revision(command_name, revisions)
142
rev_tree = revision.as_tree(branch)
146
# XXX: Bad function name; should possibly also be a class method of
147
# WorkingTree rather than a function.
148
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
150
"""Convert command-line paths to a WorkingTree and relative paths.
152
This is typically used for command-line processors that take one or
153
more filenames, and infer the workingtree that contains them.
155
The filenames given are not required to exist.
157
:param file_list: Filenames to convert.
159
:param default_branch: Fallback tree path to use if file_list is empty or
162
:param apply_view: if True and a view is set, apply it or check that
163
specified files are within it
165
:return: workingtree, [relative_paths]
167
if file_list is None or len(file_list) == 0:
168
tree = WorkingTree.open_containing(default_branch)[0]
169
if tree.supports_views() and apply_view:
170
view_files = tree.views.lookup_view()
172
file_list = view_files
173
view_str = views.view_display_str(view_files)
174
note("Ignoring files outside view. View is %s" % view_str)
175
return tree, file_list
176
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
177
return tree, safe_relpath_files(tree, file_list, canonicalize,
178
apply_view=apply_view)
181
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
182
"""Convert file_list into a list of relpaths in tree.
184
:param tree: A tree to operate on.
185
:param file_list: A list of user provided paths or None.
186
:param apply_view: if True and a view is set, apply it or check that
187
specified files are within it
188
:return: A list of relative paths.
189
:raises errors.PathNotChild: When a provided path is in a different tree
192
if file_list is None:
194
if tree.supports_views() and apply_view:
195
view_files = tree.views.lookup_view()
199
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
200
# doesn't - fix that up here before we enter the loop.
202
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
205
for filename in file_list:
207
relpath = fixer(osutils.dereference_path(filename))
208
if view_files and not osutils.is_inside_any(view_files, relpath):
209
raise errors.FileOutsideView(filename, view_files)
210
new_list.append(relpath)
211
except errors.PathNotChild:
212
raise errors.FileInWrongBranch(tree.branch, filename)
216
def _get_view_info_for_change_reporter(tree):
217
"""Get the view information from a tree for change reporting."""
220
current_view = tree.views.get_view_info()[0]
221
if current_view is not None:
222
view_info = (current_view, tree.views.lookup_view())
223
except errors.ViewsNotSupported:
228
# TODO: Make sure no commands unconditionally use the working directory as a
229
# branch. If a filename argument is used, the first of them should be used to
230
# specify the branch. (Perhaps this can be factored out into some kind of
231
# Argument class, representing a file in a branch, where the first occurrence
234
class cmd_status(Command):
235
"""Display status summary.
237
This reports on versioned and unknown files, reporting them
238
grouped by state. Possible states are:
241
Versioned in the working copy but not in the previous revision.
244
Versioned in the previous revision but removed or deleted
248
Path of this file changed from the previous revision;
249
the text may also have changed. This includes files whose
250
parent directory was renamed.
253
Text has changed since the previous revision.
256
File kind has been changed (e.g. from file to directory).
259
Not versioned and not matching an ignore pattern.
261
To see ignored files use 'bzr ignored'. For details on the
262
changes to file texts, use 'bzr diff'.
264
Note that --short or -S gives status flags for each item, similar
265
to Subversion's status command. To get output similar to svn -q,
268
If no arguments are specified, the status of the entire working
269
directory is shown. Otherwise, only the status of the specified
270
files or directories is reported. If a directory is given, status
271
is reported for everything inside that directory.
273
Before merges are committed, the pending merge tip revisions are
274
shown. To see all pending merge revisions, use the -v option.
275
To skip the display of pending merge information altogether, use
276
the no-pending option or specify a file/directory.
278
If a revision argument is given, the status is calculated against
279
that revision, or between two revisions if two are provided.
282
# TODO: --no-recurse, --recurse options
284
takes_args = ['file*']
285
takes_options = ['show-ids', 'revision', 'change', 'verbose',
286
Option('short', help='Use short status indicators.',
288
Option('versioned', help='Only show versioned files.',
290
Option('no-pending', help='Don\'t show pending merges.',
293
aliases = ['st', 'stat']
295
encoding_type = 'replace'
296
_see_also = ['diff', 'revert', 'status-flags']
299
def run(self, show_ids=False, file_list=None, revision=None, short=False,
300
versioned=False, no_pending=False, verbose=False):
301
from bzrlib.status import show_tree_status
303
if revision and len(revision) > 2:
304
raise errors.BzrCommandError('bzr status --revision takes exactly'
305
' one or two revision specifiers')
307
tree, relfile_list = tree_files(file_list)
308
# Avoid asking for specific files when that is not needed.
309
if relfile_list == ['']:
311
# Don't disable pending merges for full trees other than '.'.
312
if file_list == ['.']:
314
# A specific path within a tree was given.
315
elif relfile_list is not None:
317
show_tree_status(tree, show_ids=show_ids,
318
specific_files=relfile_list, revision=revision,
319
to_file=self.outf, short=short, versioned=versioned,
320
show_pending=(not no_pending), verbose=verbose)
323
class cmd_cat_revision(Command):
324
"""Write out metadata for a revision.
326
The revision to print can either be specified by a specific
327
revision identifier, or you can use --revision.
331
takes_args = ['revision_id?']
332
takes_options = ['revision']
333
# cat-revision is more for frontends so should be exact
337
def run(self, revision_id=None, revision=None):
338
if revision_id is not None and revision is not None:
339
raise errors.BzrCommandError('You can only supply one of'
340
' revision_id or --revision')
341
if revision_id is None and revision is None:
342
raise errors.BzrCommandError('You must supply either'
343
' --revision or a revision_id')
344
b = WorkingTree.open_containing(u'.')[0].branch
346
# TODO: jam 20060112 should cat-revision always output utf-8?
347
if revision_id is not None:
348
revision_id = osutils.safe_revision_id(revision_id, warn=False)
350
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
351
except errors.NoSuchRevision:
352
msg = "The repository %s contains no revision %s." % (b.repository.base,
354
raise errors.BzrCommandError(msg)
355
elif revision is not None:
358
raise errors.BzrCommandError('You cannot specify a NULL'
360
rev_id = rev.as_revision_id(b)
361
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
364
class cmd_dump_btree(Command):
365
"""Dump the contents of a btree index file to stdout.
367
PATH is a btree index file, it can be any URL. This includes things like
368
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
370
By default, the tuples stored in the index file will be displayed. With
371
--raw, we will uncompress the pages, but otherwise display the raw bytes
375
# TODO: Do we want to dump the internal nodes as well?
376
# TODO: It would be nice to be able to dump the un-parsed information,
377
# rather than only going through iter_all_entries. However, this is
378
# good enough for a start
380
encoding_type = 'exact'
381
takes_args = ['path']
382
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
383
' rather than the parsed tuples.'),
386
def run(self, path, raw=False):
387
dirname, basename = osutils.split(path)
388
t = transport.get_transport(dirname)
390
self._dump_raw_bytes(t, basename)
392
self._dump_entries(t, basename)
394
def _get_index_and_bytes(self, trans, basename):
395
"""Create a BTreeGraphIndex and raw bytes."""
396
bt = btree_index.BTreeGraphIndex(trans, basename, None)
397
bytes = trans.get_bytes(basename)
398
bt._file = cStringIO.StringIO(bytes)
399
bt._size = len(bytes)
402
def _dump_raw_bytes(self, trans, basename):
405
# We need to parse at least the root node.
406
# This is because the first page of every row starts with an
407
# uncompressed header.
408
bt, bytes = self._get_index_and_bytes(trans, basename)
409
for page_idx, page_start in enumerate(xrange(0, len(bytes),
410
btree_index._PAGE_SIZE)):
411
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
412
page_bytes = bytes[page_start:page_end]
414
self.outf.write('Root node:\n')
415
header_end, data = bt._parse_header_from_bytes(page_bytes)
416
self.outf.write(page_bytes[:header_end])
418
self.outf.write('\nPage %d\n' % (page_idx,))
419
decomp_bytes = zlib.decompress(page_bytes)
420
self.outf.write(decomp_bytes)
421
self.outf.write('\n')
423
def _dump_entries(self, trans, basename):
425
st = trans.stat(basename)
426
except errors.TransportNotPossible:
427
# We can't stat, so we'll fake it because we have to do the 'get()'
429
bt, _ = self._get_index_and_bytes(trans, basename)
431
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
432
for node in bt.iter_all_entries():
433
# Node is made up of:
434
# (index, key, value, [references])
435
refs_as_tuples = tuple([tuple([tuple(ref) for ref in ref_list])
436
for ref_list in node[3]])
437
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
438
self.outf.write('%s\n' % (as_tuple,))
441
class cmd_remove_tree(Command):
442
"""Remove the working tree from a given branch/checkout.
444
Since a lightweight checkout is little more than a working tree
445
this will refuse to run against one.
447
To re-create the working tree, use "bzr checkout".
449
_see_also = ['checkout', 'working-trees']
450
takes_args = ['location?']
453
help='Remove the working tree even if it has '
454
'uncommitted changes.'),
457
def run(self, location='.', force=False):
458
d = bzrdir.BzrDir.open(location)
461
working = d.open_workingtree()
462
except errors.NoWorkingTree:
463
raise errors.BzrCommandError("No working tree to remove")
464
except errors.NotLocalUrl:
465
raise errors.BzrCommandError("You cannot remove the working tree"
468
if (working.has_changes()):
469
raise errors.UncommittedChanges(working)
471
working_path = working.bzrdir.root_transport.base
472
branch_path = working.branch.bzrdir.root_transport.base
473
if working_path != branch_path:
474
raise errors.BzrCommandError("You cannot remove the working tree"
475
" from a lightweight checkout")
477
d.destroy_workingtree()
480
class cmd_revno(Command):
481
"""Show current revision number.
483
This is equal to the number of revisions on this branch.
487
takes_args = ['location?']
489
Option('tree', help='Show revno of working tree'),
493
def run(self, tree=False, location=u'.'):
496
wt = WorkingTree.open_containing(location)[0]
498
except (errors.NoWorkingTree, errors.NotLocalUrl):
499
raise errors.NoWorkingTree(location)
501
revid = wt.last_revision()
503
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
504
except errors.NoSuchRevision:
506
revno = ".".join(str(n) for n in revno_t)
510
b = Branch.open_containing(location)[0]
517
self.outf.write(str(revno) + '\n')
520
class cmd_revision_info(Command):
521
"""Show revision number and revision id for a given revision identifier.
524
takes_args = ['revision_info*']
528
help='Branch to examine, '
529
'rather than the one containing the working directory.',
533
Option('tree', help='Show revno of working tree'),
537
def run(self, revision=None, directory=u'.', tree=False,
538
revision_info_list=[]):
541
wt = WorkingTree.open_containing(directory)[0]
544
except (errors.NoWorkingTree, errors.NotLocalUrl):
546
b = Branch.open_containing(directory)[0]
550
if revision is not None:
551
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
552
if revision_info_list is not None:
553
for rev_str in revision_info_list:
554
rev_spec = RevisionSpec.from_string(rev_str)
555
revision_ids.append(rev_spec.as_revision_id(b))
556
# No arguments supplied, default to the last revision
557
if len(revision_ids) == 0:
560
raise errors.NoWorkingTree(directory)
561
revision_ids.append(wt.last_revision())
563
revision_ids.append(b.last_revision())
567
for revision_id in revision_ids:
569
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
570
revno = '.'.join(str(i) for i in dotted_revno)
571
except errors.NoSuchRevision:
573
maxlen = max(maxlen, len(revno))
574
revinfos.append([revno, revision_id])
582
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
585
class cmd_add(Command):
586
"""Add specified files or directories.
588
In non-recursive mode, all the named items are added, regardless
589
of whether they were previously ignored. A warning is given if
590
any of the named files are already versioned.
592
In recursive mode (the default), files are treated the same way
593
but the behaviour for directories is different. Directories that
594
are already versioned do not give a warning. All directories,
595
whether already versioned or not, are searched for files or
596
subdirectories that are neither versioned or ignored, and these
597
are added. This search proceeds recursively into versioned
598
directories. If no names are given '.' is assumed.
600
Therefore simply saying 'bzr add' will version all files that
601
are currently unknown.
603
Adding a file whose parent directory is not versioned will
604
implicitly add the parent, and so on up to the root. This means
605
you should never need to explicitly add a directory, they'll just
606
get added when you add a file in the directory.
608
--dry-run will show which files would be added, but not actually
611
--file-ids-from will try to use the file ids from the supplied path.
612
It looks up ids trying to find a matching parent directory with the
613
same filename, and then by pure path. This option is rarely needed
614
but can be useful when adding the same logical file into two
615
branches that will be merged later (without showing the two different
616
adds as a conflict). It is also useful when merging another project
617
into a subdirectory of this one.
619
Any files matching patterns in the ignore list will not be added
620
unless they are explicitly mentioned.
622
takes_args = ['file*']
625
help="Don't recursively add the contents of directories."),
627
help="Show what would be done, but don't actually do anything."),
629
Option('file-ids-from',
631
help='Lookup file ids from this tree.'),
633
encoding_type = 'replace'
634
_see_also = ['remove', 'ignore']
636
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
641
if file_ids_from is not None:
643
base_tree, base_path = WorkingTree.open_containing(
645
except errors.NoWorkingTree:
646
base_branch, base_path = Branch.open_containing(
648
base_tree = base_branch.basis_tree()
650
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
651
to_file=self.outf, should_print=(not is_quiet()))
653
action = bzrlib.add.AddAction(to_file=self.outf,
654
should_print=(not is_quiet()))
657
base_tree.lock_read()
659
tree, file_list = tree_files_for_add(file_list)
660
added, ignored = tree.smart_add(file_list, not
661
no_recurse, action=action, save=not dry_run)
663
if base_tree is not None:
667
for glob in sorted(ignored.keys()):
668
for path in ignored[glob]:
669
self.outf.write("ignored %s matching \"%s\"\n"
673
class cmd_mkdir(Command):
674
"""Create a new versioned directory.
676
This is equivalent to creating the directory and then adding it.
679
takes_args = ['dir+']
680
encoding_type = 'replace'
682
def run(self, dir_list):
685
wt, dd = WorkingTree.open_containing(d)
687
self.outf.write('added %s\n' % d)
690
class cmd_relpath(Command):
691
"""Show path of a file relative to root"""
693
takes_args = ['filename']
697
def run(self, filename):
698
# TODO: jam 20050106 Can relpath return a munged path if
699
# sys.stdout encoding cannot represent it?
700
tree, relpath = WorkingTree.open_containing(filename)
701
self.outf.write(relpath)
702
self.outf.write('\n')
705
class cmd_inventory(Command):
706
"""Show inventory of the current working copy or a revision.
708
It is possible to limit the output to a particular entry
709
type using the --kind option. For example: --kind file.
711
It is also possible to restrict the list of files to a specific
712
set. For example: bzr inventory --show-ids this/file
721
help='List entries of a particular kind: file, directory, symlink.',
724
takes_args = ['file*']
727
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
728
if kind and kind not in ['file', 'directory', 'symlink']:
729
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
731
revision = _get_one_revision('inventory', revision)
732
work_tree, file_list = tree_files(file_list)
733
work_tree.lock_read()
735
if revision is not None:
736
tree = revision.as_tree(work_tree.branch)
738
extra_trees = [work_tree]
744
if file_list is not None:
745
file_ids = tree.paths2ids(file_list, trees=extra_trees,
746
require_versioned=True)
747
# find_ids_across_trees may include some paths that don't
749
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
750
for file_id in file_ids if file_id in tree)
752
entries = tree.inventory.entries()
755
if tree is not work_tree:
758
for path, entry in entries:
759
if kind and kind != entry.kind:
762
self.outf.write('%-50s %s\n' % (path, entry.file_id))
764
self.outf.write(path)
765
self.outf.write('\n')
768
class cmd_mv(Command):
769
"""Move or rename a file.
772
bzr mv OLDNAME NEWNAME
774
bzr mv SOURCE... DESTINATION
776
If the last argument is a versioned directory, all the other names
777
are moved into it. Otherwise, there must be exactly two arguments
778
and the file is changed to a new name.
780
If OLDNAME does not exist on the filesystem but is versioned and
781
NEWNAME does exist on the filesystem but is not versioned, mv
782
assumes that the file has been manually moved and only updates
783
its internal inventory to reflect that change.
784
The same is valid when moving many SOURCE files to a DESTINATION.
786
Files cannot be moved between branches.
789
takes_args = ['names*']
790
takes_options = [Option("after", help="Move only the bzr identifier"
791
" of the file, because the file has already been moved."),
792
Option('auto', help='Automatically guess renames.'),
793
Option('dry-run', help='Avoid making changes when guessing renames.'),
795
aliases = ['move', 'rename']
796
encoding_type = 'replace'
798
def run(self, names_list, after=False, auto=False, dry_run=False):
800
return self.run_auto(names_list, after, dry_run)
802
raise errors.BzrCommandError('--dry-run requires --auto.')
803
if names_list is None:
805
if len(names_list) < 2:
806
raise errors.BzrCommandError("missing file argument")
807
tree, rel_names = tree_files(names_list, canonicalize=False)
808
tree.lock_tree_write()
810
self._run(tree, names_list, rel_names, after)
814
def run_auto(self, names_list, after, dry_run):
815
if names_list is not None and len(names_list) > 1:
816
raise errors.BzrCommandError('Only one path may be specified to'
819
raise errors.BzrCommandError('--after cannot be specified with'
821
work_tree, file_list = tree_files(names_list, default_branch='.')
822
work_tree.lock_tree_write()
824
rename_map.RenameMap.guess_renames(work_tree, dry_run)
828
def _run(self, tree, names_list, rel_names, after):
829
into_existing = osutils.isdir(names_list[-1])
830
if into_existing and len(names_list) == 2:
832
# a. case-insensitive filesystem and change case of dir
833
# b. move directory after the fact (if the source used to be
834
# a directory, but now doesn't exist in the working tree
835
# and the target is an existing directory, just rename it)
836
if (not tree.case_sensitive
837
and rel_names[0].lower() == rel_names[1].lower()):
838
into_existing = False
841
# 'fix' the case of a potential 'from'
842
from_id = tree.path2id(
843
tree.get_canonical_inventory_path(rel_names[0]))
844
if (not osutils.lexists(names_list[0]) and
845
from_id and inv.get_file_kind(from_id) == "directory"):
846
into_existing = False
849
# move into existing directory
850
# All entries reference existing inventory items, so fix them up
851
# for cicp file-systems.
852
rel_names = tree.get_canonical_inventory_paths(rel_names)
853
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
855
self.outf.write("%s => %s\n" % (src, dest))
857
if len(names_list) != 2:
858
raise errors.BzrCommandError('to mv multiple files the'
859
' destination must be a versioned'
862
# for cicp file-systems: the src references an existing inventory
864
src = tree.get_canonical_inventory_path(rel_names[0])
865
# Find the canonical version of the destination: In all cases, the
866
# parent of the target must be in the inventory, so we fetch the
867
# canonical version from there (we do not always *use* the
868
# canonicalized tail portion - we may be attempting to rename the
870
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
871
dest_parent = osutils.dirname(canon_dest)
872
spec_tail = osutils.basename(rel_names[1])
873
# For a CICP file-system, we need to avoid creating 2 inventory
874
# entries that differ only by case. So regardless of the case
875
# we *want* to use (ie, specified by the user or the file-system),
876
# we must always choose to use the case of any existing inventory
877
# items. The only exception to this is when we are attempting a
878
# case-only rename (ie, canonical versions of src and dest are
880
dest_id = tree.path2id(canon_dest)
881
if dest_id is None or tree.path2id(src) == dest_id:
882
# No existing item we care about, so work out what case we
883
# are actually going to use.
885
# If 'after' is specified, the tail must refer to a file on disk.
887
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
889
# pathjoin with an empty tail adds a slash, which breaks
891
dest_parent_fq = tree.basedir
893
dest_tail = osutils.canonical_relpath(
895
osutils.pathjoin(dest_parent_fq, spec_tail))
897
# not 'after', so case as specified is used
898
dest_tail = spec_tail
900
# Use the existing item so 'mv' fails with AlreadyVersioned.
901
dest_tail = os.path.basename(canon_dest)
902
dest = osutils.pathjoin(dest_parent, dest_tail)
903
mutter("attempting to move %s => %s", src, dest)
904
tree.rename_one(src, dest, after=after)
906
self.outf.write("%s => %s\n" % (src, dest))
909
class cmd_pull(Command):
910
"""Turn this branch into a mirror of another branch.
912
This command only works on branches that have not diverged. Branches are
913
considered diverged if the destination branch's most recent commit is one
914
that has not been merged (directly or indirectly) into the parent.
916
If branches have diverged, you can use 'bzr merge' to integrate the changes
917
from one into the other. Once one branch has merged, the other should
918
be able to pull it again.
920
If you want to forget your local changes and just update your branch to
921
match the remote one, use pull --overwrite.
923
If there is no default location set, the first pull will set it. After
924
that, you can omit the location to use the default. To change the
925
default, use --remember. The value will only be saved if the remote
926
location can be accessed.
928
Note: The location can be specified either in the form of a branch,
929
or in the form of a path to a file containing a merge directive generated
933
_see_also = ['push', 'update', 'status-flags', 'send']
934
takes_options = ['remember', 'overwrite', 'revision',
935
custom_help('verbose',
936
help='Show logs of pulled revisions.'),
938
help='Branch to pull into, '
939
'rather than the one containing the working directory.',
944
help="Perform a local pull in a bound "
945
"branch. Local pulls are not applied to "
949
takes_args = ['location?']
950
encoding_type = 'replace'
952
def run(self, location=None, remember=False, overwrite=False,
953
revision=None, verbose=False,
954
directory=None, local=False):
955
# FIXME: too much stuff is in the command class
958
if directory is None:
961
tree_to = WorkingTree.open_containing(directory)[0]
962
branch_to = tree_to.branch
963
except errors.NoWorkingTree:
965
branch_to = Branch.open_containing(directory)[0]
967
if local and not branch_to.get_bound_location():
968
raise errors.LocalRequiresBoundBranch()
970
possible_transports = []
971
if location is not None:
973
mergeable = bundle.read_mergeable_from_url(location,
974
possible_transports=possible_transports)
975
except errors.NotABundle:
978
stored_loc = branch_to.get_parent()
980
if stored_loc is None:
981
raise errors.BzrCommandError("No pull location known or"
984
display_url = urlutils.unescape_for_display(stored_loc,
987
self.outf.write("Using saved parent location: %s\n" % display_url)
988
location = stored_loc
990
revision = _get_one_revision('pull', revision)
991
if mergeable is not None:
992
if revision is not None:
993
raise errors.BzrCommandError(
994
'Cannot use -r with merge directives or bundles')
995
mergeable.install_revisions(branch_to.repository)
996
base_revision_id, revision_id, verified = \
997
mergeable.get_merge_request(branch_to.repository)
998
branch_from = branch_to
1000
branch_from = Branch.open(location,
1001
possible_transports=possible_transports)
1003
if branch_to.get_parent() is None or remember:
1004
branch_to.set_parent(branch_from.base)
1006
if branch_from is not branch_to:
1007
branch_from.lock_read()
1009
if revision is not None:
1010
revision_id = revision.as_revision_id(branch_from)
1012
branch_to.lock_write()
1014
if tree_to is not None:
1015
view_info = _get_view_info_for_change_reporter(tree_to)
1016
change_reporter = delta._ChangeReporter(
1017
unversioned_filter=tree_to.is_ignored,
1018
view_info=view_info)
1019
result = tree_to.pull(
1020
branch_from, overwrite, revision_id, change_reporter,
1021
possible_transports=possible_transports, local=local)
1023
result = branch_to.pull(
1024
branch_from, overwrite, revision_id, local=local)
1026
result.report(self.outf)
1027
if verbose and result.old_revid != result.new_revid:
1028
log.show_branch_change(
1029
branch_to, self.outf, result.old_revno,
1034
if branch_from is not branch_to:
1035
branch_from.unlock()
1038
class cmd_push(Command):
1039
"""Update a mirror of this branch.
1041
The target branch will not have its working tree populated because this
1042
is both expensive, and is not supported on remote file systems.
1044
Some smart servers or protocols *may* put the working tree in place in
1047
This command only works on branches that have not diverged. Branches are
1048
considered diverged if the destination branch's most recent commit is one
1049
that has not been merged (directly or indirectly) by the source branch.
1051
If branches have diverged, you can use 'bzr push --overwrite' to replace
1052
the other branch completely, discarding its unmerged changes.
1054
If you want to ensure you have the different changes in the other branch,
1055
do a merge (see bzr help merge) from the other branch, and commit that.
1056
After that you will be able to do a push without '--overwrite'.
1058
If there is no default push location set, the first push will set it.
1059
After that, you can omit the location to use the default. To change the
1060
default, use --remember. The value will only be saved if the remote
1061
location can be accessed.
1064
_see_also = ['pull', 'update', 'working-trees']
1065
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1066
Option('create-prefix',
1067
help='Create the path leading up to the branch '
1068
'if it does not already exist.'),
1070
help='Branch to push from, '
1071
'rather than the one containing the working directory.',
1075
Option('use-existing-dir',
1076
help='By default push will fail if the target'
1077
' directory exists, but does not already'
1078
' have a control directory. This flag will'
1079
' allow push to proceed.'),
1081
help='Create a stacked branch that references the public location '
1082
'of the parent branch.'),
1083
Option('stacked-on',
1084
help='Create a stacked branch that refers to another branch '
1085
'for the commit history. Only the work not present in the '
1086
'referenced branch is included in the branch created.',
1089
help='Refuse to push if there are uncommitted changes in'
1090
' the working tree, --no-strict disables the check.'),
1092
takes_args = ['location?']
1093
encoding_type = 'replace'
1095
def run(self, location=None, remember=False, overwrite=False,
1096
create_prefix=False, verbose=False, revision=None,
1097
use_existing_dir=False, directory=None, stacked_on=None,
1098
stacked=False, strict=None):
1099
from bzrlib.push import _show_push_branch
1101
if directory is None:
1103
# Get the source branch
1105
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1107
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1108
if strict is None: strict = True # default value
1109
# Get the tip's revision_id
1110
revision = _get_one_revision('push', revision)
1111
if revision is not None:
1112
revision_id = revision.in_history(br_from).rev_id
1115
if strict and tree is not None and revision_id is None:
1116
if (tree.has_changes()):
1117
raise errors.UncommittedChanges(
1118
tree, more='Use --no-strict to force the push.')
1119
if tree.last_revision() != tree.branch.last_revision():
1120
# The tree has lost sync with its branch, there is little
1121
# chance that the user is aware of it but he can still force
1122
# the push with --no-strict
1123
raise errors.OutOfDateTree(
1124
tree, more='Use --no-strict to force the push.')
1126
# Get the stacked_on branch, if any
1127
if stacked_on is not None:
1128
stacked_on = urlutils.normalize_url(stacked_on)
1130
parent_url = br_from.get_parent()
1132
parent = Branch.open(parent_url)
1133
stacked_on = parent.get_public_branch()
1135
# I considered excluding non-http url's here, thus forcing
1136
# 'public' branches only, but that only works for some
1137
# users, so it's best to just depend on the user spotting an
1138
# error by the feedback given to them. RBC 20080227.
1139
stacked_on = parent_url
1141
raise errors.BzrCommandError(
1142
"Could not determine branch to refer to.")
1144
# Get the destination location
1145
if location is None:
1146
stored_loc = br_from.get_push_location()
1147
if stored_loc is None:
1148
raise errors.BzrCommandError(
1149
"No push location known or specified.")
1151
display_url = urlutils.unescape_for_display(stored_loc,
1153
self.outf.write("Using saved push location: %s\n" % display_url)
1154
location = stored_loc
1156
_show_push_branch(br_from, revision_id, location, self.outf,
1157
verbose=verbose, overwrite=overwrite, remember=remember,
1158
stacked_on=stacked_on, create_prefix=create_prefix,
1159
use_existing_dir=use_existing_dir)
1162
class cmd_branch(Command):
1163
"""Create a new branch that is a copy of an existing branch.
1165
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1167
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1168
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1169
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1172
To retrieve the branch as of a particular revision, supply the --revision
1173
parameter, as in "branch foo/bar -r 5".
1176
_see_also = ['checkout']
1177
takes_args = ['from_location', 'to_location?']
1178
takes_options = ['revision', Option('hardlink',
1179
help='Hard-link working tree files where possible.'),
1181
help="Create a branch without a working-tree."),
1183
help="Switch the checkout in the current directory "
1184
"to the new branch."),
1186
help='Create a stacked branch referring to the source branch. '
1187
'The new branch will depend on the availability of the source '
1188
'branch for all operations.'),
1189
Option('standalone',
1190
help='Do not use a shared repository, even if available.'),
1191
Option('use-existing-dir',
1192
help='By default branch will fail if the target'
1193
' directory exists, but does not already'
1194
' have a control directory. This flag will'
1195
' allow branch to proceed.'),
1197
aliases = ['get', 'clone']
1199
def run(self, from_location, to_location=None, revision=None,
1200
hardlink=False, stacked=False, standalone=False, no_tree=False,
1201
use_existing_dir=False, switch=False):
1202
from bzrlib import switch as _mod_switch
1203
from bzrlib.tag import _merge_tags_if_possible
1204
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1206
if (accelerator_tree is not None and
1207
accelerator_tree.supports_content_filtering()):
1208
accelerator_tree = None
1209
revision = _get_one_revision('branch', revision)
1212
if revision is not None:
1213
revision_id = revision.as_revision_id(br_from)
1215
# FIXME - wt.last_revision, fallback to branch, fall back to
1216
# None or perhaps NULL_REVISION to mean copy nothing
1218
revision_id = br_from.last_revision()
1219
if to_location is None:
1220
to_location = urlutils.derive_to_location(from_location)
1221
to_transport = transport.get_transport(to_location)
1223
to_transport.mkdir('.')
1224
except errors.FileExists:
1225
if not use_existing_dir:
1226
raise errors.BzrCommandError('Target directory "%s" '
1227
'already exists.' % to_location)
1230
bzrdir.BzrDir.open_from_transport(to_transport)
1231
except errors.NotBranchError:
1234
raise errors.AlreadyBranchError(to_location)
1235
except errors.NoSuchFile:
1236
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1239
# preserve whatever source format we have.
1240
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1241
possible_transports=[to_transport],
1242
accelerator_tree=accelerator_tree,
1243
hardlink=hardlink, stacked=stacked,
1244
force_new_repo=standalone,
1245
create_tree_if_local=not no_tree,
1246
source_branch=br_from)
1247
branch = dir.open_branch()
1248
except errors.NoSuchRevision:
1249
to_transport.delete_tree('.')
1250
msg = "The branch %s has no revision %s." % (from_location,
1252
raise errors.BzrCommandError(msg)
1253
_merge_tags_if_possible(br_from, branch)
1254
# If the source branch is stacked, the new branch may
1255
# be stacked whether we asked for that explicitly or not.
1256
# We therefore need a try/except here and not just 'if stacked:'
1258
note('Created new stacked branch referring to %s.' %
1259
branch.get_stacked_on_url())
1260
except (errors.NotStacked, errors.UnstackableBranchFormat,
1261
errors.UnstackableRepositoryFormat), e:
1262
note('Branched %d revision(s).' % branch.revno())
1264
# Switch to the new branch
1265
wt, _ = WorkingTree.open_containing('.')
1266
_mod_switch.switch(wt.bzrdir, branch)
1267
note('Switched to branch: %s',
1268
urlutils.unescape_for_display(branch.base, 'utf-8'))
1273
class cmd_checkout(Command):
1274
"""Create a new checkout of an existing branch.
1276
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1277
the branch found in '.'. This is useful if you have removed the working tree
1278
or if it was never created - i.e. if you pushed the branch to its current
1279
location using SFTP.
1281
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1282
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1283
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1284
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1285
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1288
To retrieve the branch as of a particular revision, supply the --revision
1289
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1290
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1294
_see_also = ['checkouts', 'branch']
1295
takes_args = ['branch_location?', 'to_location?']
1296
takes_options = ['revision',
1297
Option('lightweight',
1298
help="Perform a lightweight checkout. Lightweight "
1299
"checkouts depend on access to the branch for "
1300
"every operation. Normal checkouts can perform "
1301
"common operations like diff and status without "
1302
"such access, and also support local commits."
1304
Option('files-from', type=str,
1305
help="Get file contents from this tree."),
1307
help='Hard-link working tree files where possible.'
1312
def run(self, branch_location=None, to_location=None, revision=None,
1313
lightweight=False, files_from=None, hardlink=False):
1314
if branch_location is None:
1315
branch_location = osutils.getcwd()
1316
to_location = branch_location
1317
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1319
revision = _get_one_revision('checkout', revision)
1320
if files_from is not None:
1321
accelerator_tree = WorkingTree.open(files_from)
1322
if revision is not None:
1323
revision_id = revision.as_revision_id(source)
1326
if to_location is None:
1327
to_location = urlutils.derive_to_location(branch_location)
1328
# if the source and to_location are the same,
1329
# and there is no working tree,
1330
# then reconstitute a branch
1331
if (osutils.abspath(to_location) ==
1332
osutils.abspath(branch_location)):
1334
source.bzrdir.open_workingtree()
1335
except errors.NoWorkingTree:
1336
source.bzrdir.create_workingtree(revision_id)
1338
source.create_checkout(to_location, revision_id, lightweight,
1339
accelerator_tree, hardlink)
1342
class cmd_renames(Command):
1343
"""Show list of renamed files.
1345
# TODO: Option to show renames between two historical versions.
1347
# TODO: Only show renames under dir, rather than in the whole branch.
1348
_see_also = ['status']
1349
takes_args = ['dir?']
1352
def run(self, dir=u'.'):
1353
tree = WorkingTree.open_containing(dir)[0]
1356
new_inv = tree.inventory
1357
old_tree = tree.basis_tree()
1358
old_tree.lock_read()
1360
old_inv = old_tree.inventory
1362
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1363
for f, paths, c, v, p, n, k, e in iterator:
1364
if paths[0] == paths[1]:
1368
renames.append(paths)
1370
for old_name, new_name in renames:
1371
self.outf.write("%s => %s\n" % (old_name, new_name))
1378
class cmd_update(Command):
1379
"""Update a tree to have the latest code committed to its branch.
1381
This will perform a merge into the working tree, and may generate
1382
conflicts. If you have any local changes, you will still
1383
need to commit them after the update for the update to be complete.
1385
If you want to discard your local changes, you can just do a
1386
'bzr revert' instead of 'bzr commit' after the update.
1389
_see_also = ['pull', 'working-trees', 'status-flags']
1390
takes_args = ['dir?']
1393
def run(self, dir='.'):
1394
tree = WorkingTree.open_containing(dir)[0]
1395
possible_transports = []
1396
master = tree.branch.get_master_branch(
1397
possible_transports=possible_transports)
1398
if master is not None:
1401
tree.lock_tree_write()
1403
existing_pending_merges = tree.get_parent_ids()[1:]
1404
last_rev = _mod_revision.ensure_null(tree.last_revision())
1405
if last_rev == _mod_revision.ensure_null(
1406
tree.branch.last_revision()):
1407
# may be up to date, check master too.
1408
if master is None or last_rev == _mod_revision.ensure_null(
1409
master.last_revision()):
1410
revno = tree.branch.revision_id_to_revno(last_rev)
1411
note("Tree is up to date at revision %d." % (revno,))
1413
view_info = _get_view_info_for_change_reporter(tree)
1414
conflicts = tree.update(
1415
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1416
view_info=view_info), possible_transports=possible_transports)
1417
revno = tree.branch.revision_id_to_revno(
1418
_mod_revision.ensure_null(tree.last_revision()))
1419
note('Updated to revision %d.' % (revno,))
1420
if tree.get_parent_ids()[1:] != existing_pending_merges:
1421
note('Your local commits will now show as pending merges with '
1422
"'bzr status', and can be committed with 'bzr commit'.")
1431
class cmd_info(Command):
1432
"""Show information about a working tree, branch or repository.
1434
This command will show all known locations and formats associated to the
1435
tree, branch or repository.
1437
In verbose mode, statistical information is included with each report.
1438
To see extended statistic information, use a verbosity level of 2 or
1439
higher by specifying the verbose option multiple times, e.g. -vv.
1441
Branches and working trees will also report any missing revisions.
1445
Display information on the format and related locations:
1449
Display the above together with extended format information and
1450
basic statistics (like the number of files in the working tree and
1451
number of revisions in the branch and repository):
1455
Display the above together with number of committers to the branch:
1459
_see_also = ['revno', 'working-trees', 'repositories']
1460
takes_args = ['location?']
1461
takes_options = ['verbose']
1462
encoding_type = 'replace'
1465
def run(self, location=None, verbose=False):
1467
noise_level = get_verbosity_level()
1470
from bzrlib.info import show_bzrdir_info
1471
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1472
verbose=noise_level, outfile=self.outf)
1475
class cmd_remove(Command):
1476
"""Remove files or directories.
1478
This makes bzr stop tracking changes to the specified files. bzr will delete
1479
them if they can easily be recovered using revert. If no options or
1480
parameters are given bzr will scan for files that are being tracked by bzr
1481
but missing in your tree and stop tracking them for you.
1483
takes_args = ['file*']
1484
takes_options = ['verbose',
1485
Option('new', help='Only remove files that have never been committed.'),
1486
RegistryOption.from_kwargs('file-deletion-strategy',
1487
'The file deletion mode to be used.',
1488
title='Deletion Strategy', value_switches=True, enum_switch=False,
1489
safe='Only delete files if they can be'
1490
' safely recovered (default).',
1491
keep='Delete from bzr but leave the working copy.',
1492
force='Delete all the specified files, even if they can not be '
1493
'recovered and even if they are non-empty directories.')]
1494
aliases = ['rm', 'del']
1495
encoding_type = 'replace'
1497
def run(self, file_list, verbose=False, new=False,
1498
file_deletion_strategy='safe'):
1499
tree, file_list = tree_files(file_list)
1501
if file_list is not None:
1502
file_list = [f for f in file_list]
1506
# Heuristics should probably all move into tree.remove_smart or
1509
added = tree.changes_from(tree.basis_tree(),
1510
specific_files=file_list).added
1511
file_list = sorted([f[0] for f in added], reverse=True)
1512
if len(file_list) == 0:
1513
raise errors.BzrCommandError('No matching files.')
1514
elif file_list is None:
1515
# missing files show up in iter_changes(basis) as
1516
# versioned-with-no-kind.
1518
for change in tree.iter_changes(tree.basis_tree()):
1519
# Find paths in the working tree that have no kind:
1520
if change[1][1] is not None and change[6][1] is None:
1521
missing.append(change[1][1])
1522
file_list = sorted(missing, reverse=True)
1523
file_deletion_strategy = 'keep'
1524
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1525
keep_files=file_deletion_strategy=='keep',
1526
force=file_deletion_strategy=='force')
1531
class cmd_file_id(Command):
1532
"""Print file_id of a particular file or directory.
1534
The file_id is assigned when the file is first added and remains the
1535
same through all revisions where the file exists, even when it is
1540
_see_also = ['inventory', 'ls']
1541
takes_args = ['filename']
1544
def run(self, filename):
1545
tree, relpath = WorkingTree.open_containing(filename)
1546
i = tree.path2id(relpath)
1548
raise errors.NotVersionedError(filename)
1550
self.outf.write(i + '\n')
1553
class cmd_file_path(Command):
1554
"""Print path of file_ids to a file or directory.
1556
This prints one line for each directory down to the target,
1557
starting at the branch root.
1561
takes_args = ['filename']
1564
def run(self, filename):
1565
tree, relpath = WorkingTree.open_containing(filename)
1566
fid = tree.path2id(relpath)
1568
raise errors.NotVersionedError(filename)
1569
segments = osutils.splitpath(relpath)
1570
for pos in range(1, len(segments) + 1):
1571
path = osutils.joinpath(segments[:pos])
1572
self.outf.write("%s\n" % tree.path2id(path))
1575
class cmd_reconcile(Command):
1576
"""Reconcile bzr metadata in a branch.
1578
This can correct data mismatches that may have been caused by
1579
previous ghost operations or bzr upgrades. You should only
1580
need to run this command if 'bzr check' or a bzr developer
1581
advises you to run it.
1583
If a second branch is provided, cross-branch reconciliation is
1584
also attempted, which will check that data like the tree root
1585
id which was not present in very early bzr versions is represented
1586
correctly in both branches.
1588
At the same time it is run it may recompress data resulting in
1589
a potential saving in disk space or performance gain.
1591
The branch *MUST* be on a listable system such as local disk or sftp.
1594
_see_also = ['check']
1595
takes_args = ['branch?']
1597
def run(self, branch="."):
1598
from bzrlib.reconcile import reconcile
1599
dir = bzrdir.BzrDir.open(branch)
1603
class cmd_revision_history(Command):
1604
"""Display the list of revision ids on a branch."""
1607
takes_args = ['location?']
1612
def run(self, location="."):
1613
branch = Branch.open_containing(location)[0]
1614
for revid in branch.revision_history():
1615
self.outf.write(revid)
1616
self.outf.write('\n')
1619
class cmd_ancestry(Command):
1620
"""List all revisions merged into this branch."""
1622
_see_also = ['log', 'revision-history']
1623
takes_args = ['location?']
1628
def run(self, location="."):
1630
wt = WorkingTree.open_containing(location)[0]
1631
except errors.NoWorkingTree:
1632
b = Branch.open(location)
1633
last_revision = b.last_revision()
1636
last_revision = wt.last_revision()
1638
revision_ids = b.repository.get_ancestry(last_revision)
1640
for revision_id in revision_ids:
1641
self.outf.write(revision_id + '\n')
1644
class cmd_init(Command):
1645
"""Make a directory into a versioned branch.
1647
Use this to create an empty branch, or before importing an
1650
If there is a repository in a parent directory of the location, then
1651
the history of the branch will be stored in the repository. Otherwise
1652
init creates a standalone branch which carries its own history
1653
in the .bzr directory.
1655
If there is already a branch at the location but it has no working tree,
1656
the tree can be populated with 'bzr checkout'.
1658
Recipe for importing a tree of files::
1664
bzr commit -m "imported project"
1667
_see_also = ['init-repository', 'branch', 'checkout']
1668
takes_args = ['location?']
1670
Option('create-prefix',
1671
help='Create the path leading up to the branch '
1672
'if it does not already exist.'),
1673
RegistryOption('format',
1674
help='Specify a format for this branch. '
1675
'See "help formats".',
1676
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1677
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1678
value_switches=True,
1679
title="Branch format",
1681
Option('append-revisions-only',
1682
help='Never change revnos or the existing log.'
1683
' Append revisions to it only.')
1685
def run(self, location=None, format=None, append_revisions_only=False,
1686
create_prefix=False):
1688
format = bzrdir.format_registry.make_bzrdir('default')
1689
if location is None:
1692
to_transport = transport.get_transport(location)
1694
# The path has to exist to initialize a
1695
# branch inside of it.
1696
# Just using os.mkdir, since I don't
1697
# believe that we want to create a bunch of
1698
# locations if the user supplies an extended path
1700
to_transport.ensure_base()
1701
except errors.NoSuchFile:
1702
if not create_prefix:
1703
raise errors.BzrCommandError("Parent directory of %s"
1705
"\nYou may supply --create-prefix to create all"
1706
" leading parent directories."
1708
to_transport.create_prefix()
1711
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1712
except errors.NotBranchError:
1713
# really a NotBzrDir error...
1714
create_branch = bzrdir.BzrDir.create_branch_convenience
1715
branch = create_branch(to_transport.base, format=format,
1716
possible_transports=[to_transport])
1717
a_bzrdir = branch.bzrdir
1719
from bzrlib.transport.local import LocalTransport
1720
if a_bzrdir.has_branch():
1721
if (isinstance(to_transport, LocalTransport)
1722
and not a_bzrdir.has_workingtree()):
1723
raise errors.BranchExistsWithoutWorkingTree(location)
1724
raise errors.AlreadyBranchError(location)
1725
branch = a_bzrdir.create_branch()
1726
a_bzrdir.create_workingtree()
1727
if append_revisions_only:
1729
branch.set_append_revisions_only(True)
1730
except errors.UpgradeRequired:
1731
raise errors.BzrCommandError('This branch format cannot be set'
1732
' to append-revisions-only. Try --default.')
1734
from bzrlib.info import describe_layout, describe_format
1736
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1737
except (errors.NoWorkingTree, errors.NotLocalUrl):
1739
repository = branch.repository
1740
layout = describe_layout(repository, branch, tree).lower()
1741
format = describe_format(a_bzrdir, repository, branch, tree)
1742
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1743
if repository.is_shared():
1744
#XXX: maybe this can be refactored into transport.path_or_url()
1745
url = repository.bzrdir.root_transport.external_url()
1747
url = urlutils.local_path_from_url(url)
1748
except errors.InvalidURL:
1750
self.outf.write("Using shared repository: %s\n" % url)
1753
class cmd_init_repository(Command):
1754
"""Create a shared repository to hold branches.
1756
New branches created under the repository directory will store their
1757
revisions in the repository, not in the branch directory.
1759
If the --no-trees option is used then the branches in the repository
1760
will not have working trees by default.
1763
Create a shared repositories holding just branches::
1765
bzr init-repo --no-trees repo
1768
Make a lightweight checkout elsewhere::
1770
bzr checkout --lightweight repo/trunk trunk-checkout
1775
_see_also = ['init', 'branch', 'checkout', 'repositories']
1776
takes_args = ["location"]
1777
takes_options = [RegistryOption('format',
1778
help='Specify a format for this repository. See'
1779
' "bzr help formats" for details.',
1780
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1781
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1782
value_switches=True, title='Repository format'),
1784
help='Branches in the repository will default to'
1785
' not having a working tree.'),
1787
aliases = ["init-repo"]
1789
def run(self, location, format=None, no_trees=False):
1791
format = bzrdir.format_registry.make_bzrdir('default')
1793
if location is None:
1796
to_transport = transport.get_transport(location)
1797
to_transport.ensure_base()
1799
newdir = format.initialize_on_transport(to_transport)
1800
repo = newdir.create_repository(shared=True)
1801
repo.set_make_working_trees(not no_trees)
1803
from bzrlib.info import show_bzrdir_info
1804
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1807
class cmd_diff(Command):
1808
"""Show differences in the working tree, between revisions or branches.
1810
If no arguments are given, all changes for the current tree are listed.
1811
If files are given, only the changes in those files are listed.
1812
Remote and multiple branches can be compared by using the --old and
1813
--new options. If not provided, the default for both is derived from
1814
the first argument, if any, or the current tree if no arguments are
1817
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1818
produces patches suitable for "patch -p1".
1822
2 - unrepresentable changes
1827
Shows the difference in the working tree versus the last commit::
1831
Difference between the working tree and revision 1::
1835
Difference between revision 2 and revision 1::
1839
Difference between revision 2 and revision 1 for branch xxx::
1843
Show just the differences for file NEWS::
1847
Show the differences in working tree xxx for file NEWS::
1851
Show the differences from branch xxx to this working tree:
1855
Show the differences between two branches for file NEWS::
1857
bzr diff --old xxx --new yyy NEWS
1859
Same as 'bzr diff' but prefix paths with old/ and new/::
1861
bzr diff --prefix old/:new/
1863
_see_also = ['status']
1864
takes_args = ['file*']
1866
Option('diff-options', type=str,
1867
help='Pass these options to the external diff program.'),
1868
Option('prefix', type=str,
1870
help='Set prefixes added to old and new filenames, as '
1871
'two values separated by a colon. (eg "old/:new/").'),
1873
help='Branch/tree to compare from.',
1877
help='Branch/tree to compare to.',
1883
help='Use this command to compare files.',
1887
aliases = ['di', 'dif']
1888
encoding_type = 'exact'
1891
def run(self, revision=None, file_list=None, diff_options=None,
1892
prefix=None, old=None, new=None, using=None):
1893
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1895
if (prefix is None) or (prefix == '0'):
1903
old_label, new_label = prefix.split(":")
1905
raise errors.BzrCommandError(
1906
'--prefix expects two values separated by a colon'
1907
' (eg "old/:new/")')
1909
if revision and len(revision) > 2:
1910
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1911
' one or two revision specifiers')
1913
(old_tree, new_tree,
1914
old_branch, new_branch,
1915
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1916
file_list, revision, old, new, apply_view=True)
1917
return show_diff_trees(old_tree, new_tree, sys.stdout,
1918
specific_files=specific_files,
1919
external_diff_options=diff_options,
1920
old_label=old_label, new_label=new_label,
1921
extra_trees=extra_trees, using=using)
1924
class cmd_deleted(Command):
1925
"""List files deleted in the working tree.
1927
# TODO: Show files deleted since a previous revision, or
1928
# between two revisions.
1929
# TODO: Much more efficient way to do this: read in new
1930
# directories with readdir, rather than stating each one. Same
1931
# level of effort but possibly much less IO. (Or possibly not,
1932
# if the directories are very large...)
1933
_see_also = ['status', 'ls']
1934
takes_options = ['show-ids']
1937
def run(self, show_ids=False):
1938
tree = WorkingTree.open_containing(u'.')[0]
1941
old = tree.basis_tree()
1944
for path, ie in old.inventory.iter_entries():
1945
if not tree.has_id(ie.file_id):
1946
self.outf.write(path)
1948
self.outf.write(' ')
1949
self.outf.write(ie.file_id)
1950
self.outf.write('\n')
1957
class cmd_modified(Command):
1958
"""List files modified in working tree.
1962
_see_also = ['status', 'ls']
1965
help='Write an ascii NUL (\\0) separator '
1966
'between files rather than a newline.')
1970
def run(self, null=False):
1971
tree = WorkingTree.open_containing(u'.')[0]
1972
td = tree.changes_from(tree.basis_tree())
1973
for path, id, kind, text_modified, meta_modified in td.modified:
1975
self.outf.write(path + '\0')
1977
self.outf.write(osutils.quotefn(path) + '\n')
1980
class cmd_added(Command):
1981
"""List files added in working tree.
1985
_see_also = ['status', 'ls']
1988
help='Write an ascii NUL (\\0) separator '
1989
'between files rather than a newline.')
1993
def run(self, null=False):
1994
wt = WorkingTree.open_containing(u'.')[0]
1997
basis = wt.basis_tree()
2000
basis_inv = basis.inventory
2003
if file_id in basis_inv:
2005
if inv.is_root(file_id) and len(basis_inv) == 0:
2007
path = inv.id2path(file_id)
2008
if not os.access(osutils.abspath(path), os.F_OK):
2011
self.outf.write(path + '\0')
2013
self.outf.write(osutils.quotefn(path) + '\n')
2020
class cmd_root(Command):
2021
"""Show the tree root directory.
2023
The root is the nearest enclosing directory with a .bzr control
2026
takes_args = ['filename?']
2028
def run(self, filename=None):
2029
"""Print the branch root."""
2030
tree = WorkingTree.open_containing(filename)[0]
2031
self.outf.write(tree.basedir + '\n')
2034
def _parse_limit(limitstring):
2036
return int(limitstring)
2038
msg = "The limit argument must be an integer."
2039
raise errors.BzrCommandError(msg)
2042
def _parse_levels(s):
2046
msg = "The levels argument must be an integer."
2047
raise errors.BzrCommandError(msg)
2050
class cmd_log(Command):
2051
"""Show historical log for a branch or subset of a branch.
2053
log is bzr's default tool for exploring the history of a branch.
2054
The branch to use is taken from the first parameter. If no parameters
2055
are given, the branch containing the working directory is logged.
2056
Here are some simple examples::
2058
bzr log log the current branch
2059
bzr log foo.py log a file in its branch
2060
bzr log http://server/branch log a branch on a server
2062
The filtering, ordering and information shown for each revision can
2063
be controlled as explained below. By default, all revisions are
2064
shown sorted (topologically) so that newer revisions appear before
2065
older ones and descendants always appear before ancestors. If displayed,
2066
merged revisions are shown indented under the revision in which they
2071
The log format controls how information about each revision is
2072
displayed. The standard log formats are called ``long``, ``short``
2073
and ``line``. The default is long. See ``bzr help log-formats``
2074
for more details on log formats.
2076
The following options can be used to control what information is
2079
-l N display a maximum of N revisions
2080
-n N display N levels of revisions (0 for all, 1 for collapsed)
2081
-v display a status summary (delta) for each revision
2082
-p display a diff (patch) for each revision
2083
--show-ids display revision-ids (and file-ids), not just revnos
2085
Note that the default number of levels to display is a function of the
2086
log format. If the -n option is not used, the standard log formats show
2087
just the top level (mainline).
2089
Status summaries are shown using status flags like A, M, etc. To see
2090
the changes explained using words like ``added`` and ``modified``
2091
instead, use the -vv option.
2095
To display revisions from oldest to newest, use the --forward option.
2096
In most cases, using this option will have little impact on the total
2097
time taken to produce a log, though --forward does not incrementally
2098
display revisions like --reverse does when it can.
2100
:Revision filtering:
2102
The -r option can be used to specify what revision or range of revisions
2103
to filter against. The various forms are shown below::
2105
-rX display revision X
2106
-rX.. display revision X and later
2107
-r..Y display up to and including revision Y
2108
-rX..Y display from X to Y inclusive
2110
See ``bzr help revisionspec`` for details on how to specify X and Y.
2111
Some common examples are given below::
2113
-r-1 show just the tip
2114
-r-10.. show the last 10 mainline revisions
2115
-rsubmit:.. show what's new on this branch
2116
-rancestor:path.. show changes since the common ancestor of this
2117
branch and the one at location path
2118
-rdate:yesterday.. show changes since yesterday
2120
When logging a range of revisions using -rX..Y, log starts at
2121
revision Y and searches back in history through the primary
2122
("left-hand") parents until it finds X. When logging just the
2123
top level (using -n1), an error is reported if X is not found
2124
along the way. If multi-level logging is used (-n0), X may be
2125
a nested merge revision and the log will be truncated accordingly.
2129
If parameters are given and the first one is not a branch, the log
2130
will be filtered to show only those revisions that changed the
2131
nominated files or directories.
2133
Filenames are interpreted within their historical context. To log a
2134
deleted file, specify a revision range so that the file existed at
2135
the end or start of the range.
2137
Historical context is also important when interpreting pathnames of
2138
renamed files/directories. Consider the following example:
2140
* revision 1: add tutorial.txt
2141
* revision 2: modify tutorial.txt
2142
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2146
* ``bzr log guide.txt`` will log the file added in revision 1
2148
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2150
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2151
the original file in revision 2.
2153
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2154
was no file called guide.txt in revision 2.
2156
Renames are always followed by log. By design, there is no need to
2157
explicitly ask for this (and no way to stop logging a file back
2158
until it was last renamed).
2162
The --message option can be used for finding revisions that match a
2163
regular expression in a commit message.
2167
GUI tools and IDEs are often better at exploring history than command
2168
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2169
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2170
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2172
Web interfaces are often better at exploring history than command line
2173
tools, particularly for branches on servers. You may prefer Loggerhead
2174
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2176
You may find it useful to add the aliases below to ``bazaar.conf``::
2180
top = log -l10 --line
2183
``bzr tip`` will then show the latest revision while ``bzr top``
2184
will show the last 10 mainline revisions. To see the details of a
2185
particular revision X, ``bzr show -rX``.
2187
If you are interested in looking deeper into a particular merge X,
2188
use ``bzr log -n0 -rX``.
2190
``bzr log -v`` on a branch with lots of history is currently
2191
very slow. A fix for this issue is currently under development.
2192
With or without that fix, it is recommended that a revision range
2193
be given when using the -v option.
2195
bzr has a generic full-text matching plugin, bzr-search, that can be
2196
used to find revisions matching user names, commit messages, etc.
2197
Among other features, this plugin can find all revisions containing
2198
a list of words but not others.
2200
When exploring non-mainline history on large projects with deep
2201
history, the performance of log can be greatly improved by installing
2202
the historycache plugin. This plugin buffers historical information
2203
trading disk space for faster speed.
2205
takes_args = ['file*']
2206
_see_also = ['log-formats', 'revisionspec']
2209
help='Show from oldest to newest.'),
2211
custom_help('verbose',
2212
help='Show files changed in each revision.'),
2216
type=bzrlib.option._parse_revision_str,
2218
help='Show just the specified revision.'
2219
' See also "help revisionspec".'),
2223
help='Number of levels to display - 0 for all, 1 for flat.',
2225
type=_parse_levels),
2228
help='Show revisions whose message matches this '
2229
'regular expression.',
2233
help='Limit the output to the first N revisions.',
2238
help='Show changes made in each revision as a patch.'),
2239
Option('include-merges',
2240
help='Show merged revisions like --levels 0 does.'),
2242
encoding_type = 'replace'
2245
def run(self, file_list=None, timezone='original',
2256
include_merges=False):
2257
from bzrlib.log import (
2259
make_log_request_dict,
2260
_get_info_for_log_files,
2262
direction = (forward and 'forward') or 'reverse'
2267
raise errors.BzrCommandError(
2268
'--levels and --include-merges are mutually exclusive')
2270
if change is not None:
2272
raise errors.RangeInChangeOption()
2273
if revision is not None:
2274
raise errors.BzrCommandError(
2275
'--revision and --change are mutually exclusive')
2280
filter_by_dir = False
2284
# find the file ids to log and check for directory filtering
2285
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2286
revision, file_list)
2287
for relpath, file_id, kind in file_info_list:
2289
raise errors.BzrCommandError(
2290
"Path unknown at end or start of revision range: %s" %
2292
# If the relpath is the top of the tree, we log everything
2297
file_ids.append(file_id)
2298
filter_by_dir = filter_by_dir or (
2299
kind in ['directory', 'tree-reference'])
2302
# FIXME ? log the current subdir only RBC 20060203
2303
if revision is not None \
2304
and len(revision) > 0 and revision[0].get_branch():
2305
location = revision[0].get_branch()
2308
dir, relpath = bzrdir.BzrDir.open_containing(location)
2309
b = dir.open_branch()
2311
rev1, rev2 = _get_revision_range(revision, b, self.name())
2313
# Decide on the type of delta & diff filtering to use
2314
# TODO: add an --all-files option to make this configurable & consistent
2322
diff_type = 'partial'
2326
# Build the log formatter
2327
if log_format is None:
2328
log_format = log.log_formatter_registry.get_default(b)
2329
lf = log_format(show_ids=show_ids, to_file=self.outf,
2330
show_timezone=timezone,
2331
delta_format=get_verbosity_level(),
2333
show_advice=levels is None)
2335
# Choose the algorithm for doing the logging. It's annoying
2336
# having multiple code paths like this but necessary until
2337
# the underlying repository format is faster at generating
2338
# deltas or can provide everything we need from the indices.
2339
# The default algorithm - match-using-deltas - works for
2340
# multiple files and directories and is faster for small
2341
# amounts of history (200 revisions say). However, it's too
2342
# slow for logging a single file in a repository with deep
2343
# history, i.e. > 10K revisions. In the spirit of "do no
2344
# evil when adding features", we continue to use the
2345
# original algorithm - per-file-graph - for the "single
2346
# file that isn't a directory without showing a delta" case.
2347
partial_history = revision and b.repository._format.supports_chks
2348
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2349
or delta_type or partial_history)
2351
# Build the LogRequest and execute it
2352
if len(file_ids) == 0:
2354
rqst = make_log_request_dict(
2355
direction=direction, specific_fileids=file_ids,
2356
start_revision=rev1, end_revision=rev2, limit=limit,
2357
message_search=message, delta_type=delta_type,
2358
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2359
Logger(b, rqst).show(lf)
2365
def _get_revision_range(revisionspec_list, branch, command_name):
2366
"""Take the input of a revision option and turn it into a revision range.
2368
It returns RevisionInfo objects which can be used to obtain the rev_id's
2369
of the desired revisions. It does some user input validations.
2371
if revisionspec_list is None:
2374
elif len(revisionspec_list) == 1:
2375
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2376
elif len(revisionspec_list) == 2:
2377
start_spec = revisionspec_list[0]
2378
end_spec = revisionspec_list[1]
2379
if end_spec.get_branch() != start_spec.get_branch():
2380
# b is taken from revision[0].get_branch(), and
2381
# show_log will use its revision_history. Having
2382
# different branches will lead to weird behaviors.
2383
raise errors.BzrCommandError(
2384
"bzr %s doesn't accept two revisions in different"
2385
" branches." % command_name)
2386
rev1 = start_spec.in_history(branch)
2387
# Avoid loading all of history when we know a missing
2388
# end of range means the last revision ...
2389
if end_spec.spec is None:
2390
last_revno, last_revision_id = branch.last_revision_info()
2391
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2393
rev2 = end_spec.in_history(branch)
2395
raise errors.BzrCommandError(
2396
'bzr %s --revision takes one or two values.' % command_name)
2400
def _revision_range_to_revid_range(revision_range):
2403
if revision_range[0] is not None:
2404
rev_id1 = revision_range[0].rev_id
2405
if revision_range[1] is not None:
2406
rev_id2 = revision_range[1].rev_id
2407
return rev_id1, rev_id2
2409
def get_log_format(long=False, short=False, line=False, default='long'):
2410
log_format = default
2414
log_format = 'short'
2420
class cmd_touching_revisions(Command):
2421
"""Return revision-ids which affected a particular file.
2423
A more user-friendly interface is "bzr log FILE".
2427
takes_args = ["filename"]
2430
def run(self, filename):
2431
tree, relpath = WorkingTree.open_containing(filename)
2432
file_id = tree.path2id(relpath)
2436
touching_revs = log.find_touching_revisions(b, file_id)
2437
for revno, revision_id, what in touching_revs:
2438
self.outf.write("%6d %s\n" % (revno, what))
2443
class cmd_ls(Command):
2444
"""List files in a tree.
2447
_see_also = ['status', 'cat']
2448
takes_args = ['path?']
2452
Option('recursive', short_name='R',
2453
help='Recurse into subdirectories.'),
2455
help='Print paths relative to the root of the branch.'),
2456
Option('unknown', help='Print unknown files.'),
2457
Option('versioned', help='Print versioned files.',
2459
Option('ignored', help='Print ignored files.'),
2461
help='Write an ascii NUL (\\0) separator '
2462
'between files rather than a newline.'),
2464
help='List entries of a particular kind: file, directory, symlink.',
2469
def run(self, revision=None, verbose=False,
2470
recursive=False, from_root=False,
2471
unknown=False, versioned=False, ignored=False,
2472
null=False, kind=None, show_ids=False, path=None):
2474
if kind and kind not in ('file', 'directory', 'symlink'):
2475
raise errors.BzrCommandError('invalid kind specified')
2477
if verbose and null:
2478
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2479
all = not (unknown or versioned or ignored)
2481
selection = {'I':ignored, '?':unknown, 'V':versioned}
2487
raise errors.BzrCommandError('cannot specify both --from-root'
2490
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2493
# Calculate the prefix to use
2497
prefix = relpath + '/'
2498
elif fs_path != '.':
2499
prefix = fs_path + '/'
2501
if revision is not None or tree is None:
2502
tree = _get_one_revision_tree('ls', revision, branch=branch)
2505
if isinstance(tree, WorkingTree) and tree.supports_views():
2506
view_files = tree.views.lookup_view()
2509
view_str = views.view_display_str(view_files)
2510
note("Ignoring files outside view. View is %s" % view_str)
2514
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2515
from_dir=relpath, recursive=recursive):
2516
# Apply additional masking
2517
if not all and not selection[fc]:
2519
if kind is not None and fkind != kind:
2524
fullpath = osutils.pathjoin(relpath, fp)
2527
views.check_path_in_view(tree, fullpath)
2528
except errors.FileOutsideView:
2533
fp = osutils.pathjoin(prefix, fp)
2534
kindch = entry.kind_character()
2535
outstring = fp + kindch
2536
ui.ui_factory.clear_term()
2538
outstring = '%-8s %s' % (fc, outstring)
2539
if show_ids and fid is not None:
2540
outstring = "%-50s %s" % (outstring, fid)
2541
self.outf.write(outstring + '\n')
2543
self.outf.write(fp + '\0')
2546
self.outf.write(fid)
2547
self.outf.write('\0')
2555
self.outf.write('%-50s %s\n' % (outstring, my_id))
2557
self.outf.write(outstring + '\n')
2562
class cmd_unknowns(Command):
2563
"""List unknown files.
2571
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2572
self.outf.write(osutils.quotefn(f) + '\n')
2575
class cmd_ignore(Command):
2576
"""Ignore specified files or patterns.
2578
See ``bzr help patterns`` for details on the syntax of patterns.
2580
To remove patterns from the ignore list, edit the .bzrignore file.
2581
After adding, editing or deleting that file either indirectly by
2582
using this command or directly by using an editor, be sure to commit
2585
Note: ignore patterns containing shell wildcards must be quoted from
2589
Ignore the top level Makefile::
2591
bzr ignore ./Makefile
2593
Ignore class files in all directories::
2595
bzr ignore "*.class"
2597
Ignore .o files under the lib directory::
2599
bzr ignore "lib/**/*.o"
2601
Ignore .o files under the lib directory::
2603
bzr ignore "RE:lib/.*\.o"
2605
Ignore everything but the "debian" toplevel directory::
2607
bzr ignore "RE:(?!debian/).*"
2610
_see_also = ['status', 'ignored', 'patterns']
2611
takes_args = ['name_pattern*']
2613
Option('old-default-rules',
2614
help='Write out the ignore rules bzr < 0.9 always used.')
2617
def run(self, name_pattern_list=None, old_default_rules=None):
2618
from bzrlib import ignores
2619
if old_default_rules is not None:
2620
# dump the rules and exit
2621
for pattern in ignores.OLD_DEFAULTS:
2624
if not name_pattern_list:
2625
raise errors.BzrCommandError("ignore requires at least one "
2626
"NAME_PATTERN or --old-default-rules")
2627
name_pattern_list = [globbing.normalize_pattern(p)
2628
for p in name_pattern_list]
2629
for name_pattern in name_pattern_list:
2630
if (name_pattern[0] == '/' or
2631
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2632
raise errors.BzrCommandError(
2633
"NAME_PATTERN should not be an absolute path")
2634
tree, relpath = WorkingTree.open_containing(u'.')
2635
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2636
ignored = globbing.Globster(name_pattern_list)
2639
for entry in tree.list_files():
2643
if ignored.match(filename):
2644
matches.append(filename.encode('utf-8'))
2646
if len(matches) > 0:
2647
print "Warning: the following files are version controlled and" \
2648
" match your ignore pattern:\n%s" \
2649
"\nThese files will continue to be version controlled" \
2650
" unless you 'bzr remove' them." % ("\n".join(matches),)
2653
class cmd_ignored(Command):
2654
"""List ignored files and the patterns that matched them.
2656
List all the ignored files and the ignore pattern that caused the file to
2659
Alternatively, to list just the files::
2664
encoding_type = 'replace'
2665
_see_also = ['ignore', 'ls']
2669
tree = WorkingTree.open_containing(u'.')[0]
2672
for path, file_class, kind, file_id, entry in tree.list_files():
2673
if file_class != 'I':
2675
## XXX: Slightly inefficient since this was already calculated
2676
pat = tree.is_ignored(path)
2677
self.outf.write('%-50s %s\n' % (path, pat))
2682
class cmd_lookup_revision(Command):
2683
"""Lookup the revision-id from a revision-number
2686
bzr lookup-revision 33
2689
takes_args = ['revno']
2692
def run(self, revno):
2696
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2698
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2701
class cmd_export(Command):
2702
"""Export current or past revision to a destination directory or archive.
2704
If no revision is specified this exports the last committed revision.
2706
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2707
given, try to find the format with the extension. If no extension
2708
is found exports to a directory (equivalent to --format=dir).
2710
If root is supplied, it will be used as the root directory inside
2711
container formats (tar, zip, etc). If it is not supplied it will default
2712
to the exported filename. The root option has no effect for 'dir' format.
2714
If branch is omitted then the branch containing the current working
2715
directory will be used.
2717
Note: Export of tree with non-ASCII filenames to zip is not supported.
2719
================= =========================
2720
Supported formats Autodetected by extension
2721
================= =========================
2724
tbz2 .tar.bz2, .tbz2
2727
================= =========================
2729
takes_args = ['dest', 'branch_or_subdir?']
2732
help="Type of file to export to.",
2735
Option('filters', help='Apply content filters to export the '
2736
'convenient form.'),
2739
help="Name of the root directory inside the exported file."),
2741
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2742
root=None, filters=False):
2743
from bzrlib.export import export
2745
if branch_or_subdir is None:
2746
tree = WorkingTree.open_containing(u'.')[0]
2750
b, subdir = Branch.open_containing(branch_or_subdir)
2753
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2755
export(rev_tree, dest, format, root, subdir, filtered=filters)
2756
except errors.NoSuchExportFormat, e:
2757
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2760
class cmd_cat(Command):
2761
"""Write the contents of a file as of a given revision to standard output.
2763
If no revision is nominated, the last revision is used.
2765
Note: Take care to redirect standard output when using this command on a
2771
Option('name-from-revision', help='The path name in the old tree.'),
2772
Option('filters', help='Apply content filters to display the '
2773
'convenience form.'),
2776
takes_args = ['filename']
2777
encoding_type = 'exact'
2780
def run(self, filename, revision=None, name_from_revision=False,
2782
if revision is not None and len(revision) != 1:
2783
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2784
" one revision specifier")
2785
tree, branch, relpath = \
2786
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2789
return self._run(tree, branch, relpath, filename, revision,
2790
name_from_revision, filters)
2794
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2797
tree = b.basis_tree()
2798
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2800
old_file_id = rev_tree.path2id(relpath)
2802
if name_from_revision:
2803
# Try in revision if requested
2804
if old_file_id is None:
2805
raise errors.BzrCommandError(
2806
"%r is not present in revision %s" % (
2807
filename, rev_tree.get_revision_id()))
2809
content = rev_tree.get_file_text(old_file_id)
2811
cur_file_id = tree.path2id(relpath)
2813
if cur_file_id is not None:
2814
# Then try with the actual file id
2816
content = rev_tree.get_file_text(cur_file_id)
2818
except errors.NoSuchId:
2819
# The actual file id didn't exist at that time
2821
if not found and old_file_id is not None:
2822
# Finally try with the old file id
2823
content = rev_tree.get_file_text(old_file_id)
2826
# Can't be found anywhere
2827
raise errors.BzrCommandError(
2828
"%r is not present in revision %s" % (
2829
filename, rev_tree.get_revision_id()))
2831
from bzrlib.filters import (
2832
ContentFilterContext,
2833
filtered_output_bytes,
2835
filters = rev_tree._content_filter_stack(relpath)
2836
chunks = content.splitlines(True)
2837
content = filtered_output_bytes(chunks, filters,
2838
ContentFilterContext(relpath, rev_tree))
2839
self.outf.writelines(content)
2841
self.outf.write(content)
2844
class cmd_local_time_offset(Command):
2845
"""Show the offset in seconds from GMT to local time."""
2849
print osutils.local_time_offset()
2853
class cmd_commit(Command):
2854
"""Commit changes into a new revision.
2856
An explanatory message needs to be given for each commit. This is
2857
often done by using the --message option (getting the message from the
2858
command line) or by using the --file option (getting the message from
2859
a file). If neither of these options is given, an editor is opened for
2860
the user to enter the message. To see the changed files in the
2861
boilerplate text loaded into the editor, use the --show-diff option.
2863
By default, the entire tree is committed and the person doing the
2864
commit is assumed to be the author. These defaults can be overridden
2869
If selected files are specified, only changes to those files are
2870
committed. If a directory is specified then the directory and
2871
everything within it is committed.
2873
When excludes are given, they take precedence over selected files.
2874
For example, to commit only changes within foo, but not changes
2877
bzr commit foo -x foo/bar
2879
A selective commit after a merge is not yet supported.
2883
If the author of the change is not the same person as the committer,
2884
you can specify the author's name using the --author option. The
2885
name should be in the same format as a committer-id, e.g.
2886
"John Doe <jdoe@example.com>". If there is more than one author of
2887
the change you can specify the option multiple times, once for each
2892
A common mistake is to forget to add a new file or directory before
2893
running the commit command. The --strict option checks for unknown
2894
files and aborts the commit if any are found. More advanced pre-commit
2895
checks can be implemented by defining hooks. See ``bzr help hooks``
2900
If you accidentially commit the wrong changes or make a spelling
2901
mistake in the commit message say, you can use the uncommit command
2902
to undo it. See ``bzr help uncommit`` for details.
2904
Hooks can also be configured to run after a commit. This allows you
2905
to trigger updates to external systems like bug trackers. The --fixes
2906
option can be used to record the association between a revision and
2907
one or more bugs. See ``bzr help bugs`` for details.
2909
A selective commit may fail in some cases where the committed
2910
tree would be invalid. Consider::
2915
bzr commit foo -m "committing foo"
2916
bzr mv foo/bar foo/baz
2919
bzr commit foo/bar -m "committing bar but not baz"
2921
In the example above, the last commit will fail by design. This gives
2922
the user the opportunity to decide whether they want to commit the
2923
rename at the same time, separately first, or not at all. (As a general
2924
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2926
# TODO: Run hooks on tree to-be-committed, and after commit.
2928
# TODO: Strict commit that fails if there are deleted files.
2929
# (what does "deleted files" mean ??)
2931
# TODO: Give better message for -s, --summary, used by tla people
2933
# XXX: verbose currently does nothing
2935
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2936
takes_args = ['selected*']
2938
ListOption('exclude', type=str, short_name='x',
2939
help="Do not consider changes made to a given path."),
2940
Option('message', type=unicode,
2942
help="Description of the new revision."),
2945
help='Commit even if nothing has changed.'),
2946
Option('file', type=str,
2949
help='Take commit message from this file.'),
2951
help="Refuse to commit if there are unknown "
2952
"files in the working tree."),
2953
Option('commit-time', type=str,
2954
help="Manually set a commit time using commit date "
2955
"format, e.g. '2009-10-10 08:00:00 +0100'."),
2956
ListOption('fixes', type=str,
2957
help="Mark a bug as being fixed by this revision "
2958
"(see \"bzr help bugs\")."),
2959
ListOption('author', type=unicode,
2960
help="Set the author's name, if it's different "
2961
"from the committer."),
2963
help="Perform a local commit in a bound "
2964
"branch. Local commits are not pushed to "
2965
"the master branch until a normal commit "
2969
help='When no message is supplied, show the diff along'
2970
' with the status summary in the message editor.'),
2972
aliases = ['ci', 'checkin']
2974
def _iter_bug_fix_urls(self, fixes, branch):
2975
# Configure the properties for bug fixing attributes.
2976
for fixed_bug in fixes:
2977
tokens = fixed_bug.split(':')
2978
if len(tokens) != 2:
2979
raise errors.BzrCommandError(
2980
"Invalid bug %s. Must be in the form of 'tracker:id'. "
2981
"See \"bzr help bugs\" for more information on this "
2982
"feature.\nCommit refused." % fixed_bug)
2983
tag, bug_id = tokens
2985
yield bugtracker.get_bug_url(tag, branch, bug_id)
2986
except errors.UnknownBugTrackerAbbreviation:
2987
raise errors.BzrCommandError(
2988
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2989
except errors.MalformedBugIdentifier, e:
2990
raise errors.BzrCommandError(
2991
"%s\nCommit refused." % (str(e),))
2993
def run(self, message=None, file=None, verbose=False, selected_list=None,
2994
unchanged=False, strict=False, local=False, fixes=None,
2995
author=None, show_diff=False, exclude=None, commit_time=None):
2996
from bzrlib.errors import (
3001
from bzrlib.msgeditor import (
3002
edit_commit_message_encoded,
3003
generate_commit_message_template,
3004
make_commit_message_template_encoded
3007
commit_stamp = offset = None
3008
if commit_time is not None:
3010
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3011
except ValueError, e:
3012
raise errors.BzrCommandError(
3013
"Could not parse --commit-time: " + str(e))
3015
# TODO: Need a blackbox test for invoking the external editor; may be
3016
# slightly problematic to run this cross-platform.
3018
# TODO: do more checks that the commit will succeed before
3019
# spending the user's valuable time typing a commit message.
3023
tree, selected_list = tree_files(selected_list)
3024
if selected_list == ['']:
3025
# workaround - commit of root of tree should be exactly the same
3026
# as just default commit in that tree, and succeed even though
3027
# selected-file merge commit is not done yet
3032
bug_property = bugtracker.encode_fixes_bug_urls(
3033
self._iter_bug_fix_urls(fixes, tree.branch))
3035
properties['bugs'] = bug_property
3037
if local and not tree.branch.get_bound_location():
3038
raise errors.LocalRequiresBoundBranch()
3040
def get_message(commit_obj):
3041
"""Callback to get commit message"""
3042
my_message = message
3043
if my_message is not None and '\r' in my_message:
3044
my_message = my_message.replace('\r\n', '\n')
3045
my_message = my_message.replace('\r', '\n')
3046
if my_message is None and not file:
3047
t = make_commit_message_template_encoded(tree,
3048
selected_list, diff=show_diff,
3049
output_encoding=osutils.get_user_encoding())
3050
start_message = generate_commit_message_template(commit_obj)
3051
my_message = edit_commit_message_encoded(t,
3052
start_message=start_message)
3053
if my_message is None:
3054
raise errors.BzrCommandError("please specify a commit"
3055
" message with either --message or --file")
3056
elif my_message and file:
3057
raise errors.BzrCommandError(
3058
"please specify either --message or --file")
3060
my_message = codecs.open(file, 'rt',
3061
osutils.get_user_encoding()).read()
3062
if my_message == "":
3063
raise errors.BzrCommandError("empty commit message specified")
3066
# The API permits a commit with a filter of [] to mean 'select nothing'
3067
# but the command line should not do that.
3068
if not selected_list:
3069
selected_list = None
3071
tree.commit(message_callback=get_message,
3072
specific_files=selected_list,
3073
allow_pointless=unchanged, strict=strict, local=local,
3074
reporter=None, verbose=verbose, revprops=properties,
3075
authors=author, timestamp=commit_stamp,
3077
exclude=safe_relpath_files(tree, exclude))
3078
except PointlessCommit:
3079
# FIXME: This should really happen before the file is read in;
3080
# perhaps prepare the commit; get the message; then actually commit
3081
raise errors.BzrCommandError("No changes to commit."
3082
" Use --unchanged to commit anyhow.")
3083
except ConflictsInTree:
3084
raise errors.BzrCommandError('Conflicts detected in working '
3085
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3087
except StrictCommitFailed:
3088
raise errors.BzrCommandError("Commit refused because there are"
3089
" unknown files in the working tree.")
3090
except errors.BoundBranchOutOfDate, e:
3091
raise errors.BzrCommandError(str(e) + "\n"
3092
'To commit to master branch, run update and then commit.\n'
3093
'You can also pass --local to commit to continue working '
3097
class cmd_check(Command):
3098
"""Validate working tree structure, branch consistency and repository history.
3100
This command checks various invariants about branch and repository storage
3101
to detect data corruption or bzr bugs.
3103
The working tree and branch checks will only give output if a problem is
3104
detected. The output fields of the repository check are:
3107
This is just the number of revisions checked. It doesn't
3111
This is just the number of versionedfiles checked. It
3112
doesn't indicate a problem.
3114
unreferenced ancestors
3115
Texts that are ancestors of other texts, but
3116
are not properly referenced by the revision ancestry. This is a
3117
subtle problem that Bazaar can work around.
3120
This is the total number of unique file contents
3121
seen in the checked revisions. It does not indicate a problem.
3124
This is the total number of repeated texts seen
3125
in the checked revisions. Texts can be repeated when their file
3126
entries are modified, but the file contents are not. It does not
3129
If no restrictions are specified, all Bazaar data that is found at the given
3130
location will be checked.
3134
Check the tree and branch at 'foo'::
3136
bzr check --tree --branch foo
3138
Check only the repository at 'bar'::
3140
bzr check --repo bar
3142
Check everything at 'baz'::
3147
_see_also = ['reconcile']
3148
takes_args = ['path?']
3149
takes_options = ['verbose',
3150
Option('branch', help="Check the branch related to the"
3151
" current directory."),
3152
Option('repo', help="Check the repository related to the"
3153
" current directory."),
3154
Option('tree', help="Check the working tree related to"
3155
" the current directory.")]
3157
def run(self, path=None, verbose=False, branch=False, repo=False,
3159
from bzrlib.check import check_dwim
3162
if not branch and not repo and not tree:
3163
branch = repo = tree = True
3164
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3167
class cmd_upgrade(Command):
3168
"""Upgrade branch storage to current format.
3170
The check command or bzr developers may sometimes advise you to run
3171
this command. When the default format has changed you may also be warned
3172
during other operations to upgrade.
3175
_see_also = ['check']
3176
takes_args = ['url?']
3178
RegistryOption('format',
3179
help='Upgrade to a specific format. See "bzr help'
3180
' formats" for details.',
3181
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3182
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3183
value_switches=True, title='Branch format'),
3186
def run(self, url='.', format=None):
3187
from bzrlib.upgrade import upgrade
3188
upgrade(url, format)
3191
class cmd_whoami(Command):
3192
"""Show or set bzr user id.
3195
Show the email of the current user::
3199
Set the current user::
3201
bzr whoami "Frank Chu <fchu@example.com>"
3203
takes_options = [ Option('email',
3204
help='Display email address only.'),
3206
help='Set identity for the current branch instead of '
3209
takes_args = ['name?']
3210
encoding_type = 'replace'
3213
def run(self, email=False, branch=False, name=None):
3215
# use branch if we're inside one; otherwise global config
3217
c = Branch.open_containing('.')[0].get_config()
3218
except errors.NotBranchError:
3219
c = config.GlobalConfig()
3221
self.outf.write(c.user_email() + '\n')
3223
self.outf.write(c.username() + '\n')
3226
# display a warning if an email address isn't included in the given name.
3228
config.extract_email_address(name)
3229
except errors.NoEmailInUsername, e:
3230
warning('"%s" does not seem to contain an email address. '
3231
'This is allowed, but not recommended.', name)
3233
# use global config unless --branch given
3235
c = Branch.open_containing('.')[0].get_config()
3237
c = config.GlobalConfig()
3238
c.set_user_option('email', name)
3241
class cmd_nick(Command):
3242
"""Print or set the branch nickname.
3244
If unset, the tree root directory name is used as the nickname.
3245
To print the current nickname, execute with no argument.
3247
Bound branches use the nickname of its master branch unless it is set
3251
_see_also = ['info']
3252
takes_args = ['nickname?']
3253
def run(self, nickname=None):
3254
branch = Branch.open_containing(u'.')[0]
3255
if nickname is None:
3256
self.printme(branch)
3258
branch.nick = nickname
3261
def printme(self, branch):
3265
class cmd_alias(Command):
3266
"""Set/unset and display aliases.
3269
Show the current aliases::
3273
Show the alias specified for 'll'::
3277
Set an alias for 'll'::
3279
bzr alias ll="log --line -r-10..-1"
3281
To remove an alias for 'll'::
3283
bzr alias --remove ll
3286
takes_args = ['name?']
3288
Option('remove', help='Remove the alias.'),
3291
def run(self, name=None, remove=False):
3293
self.remove_alias(name)
3295
self.print_aliases()
3297
equal_pos = name.find('=')
3299
self.print_alias(name)
3301
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3303
def remove_alias(self, alias_name):
3304
if alias_name is None:
3305
raise errors.BzrCommandError(
3306
'bzr alias --remove expects an alias to remove.')
3307
# If alias is not found, print something like:
3308
# unalias: foo: not found
3309
c = config.GlobalConfig()
3310
c.unset_alias(alias_name)
3313
def print_aliases(self):
3314
"""Print out the defined aliases in a similar format to bash."""
3315
aliases = config.GlobalConfig().get_aliases()
3316
for key, value in sorted(aliases.iteritems()):
3317
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3320
def print_alias(self, alias_name):
3321
from bzrlib.commands import get_alias
3322
alias = get_alias(alias_name)
3324
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3327
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3329
def set_alias(self, alias_name, alias_command):
3330
"""Save the alias in the global config."""
3331
c = config.GlobalConfig()
3332
c.set_alias(alias_name, alias_command)
3335
class cmd_selftest(Command):
3336
"""Run internal test suite.
3338
If arguments are given, they are regular expressions that say which tests
3339
should run. Tests matching any expression are run, and other tests are
3342
Alternatively if --first is given, matching tests are run first and then
3343
all other tests are run. This is useful if you have been working in a
3344
particular area, but want to make sure nothing else was broken.
3346
If --exclude is given, tests that match that regular expression are
3347
excluded, regardless of whether they match --first or not.
3349
To help catch accidential dependencies between tests, the --randomize
3350
option is useful. In most cases, the argument used is the word 'now'.
3351
Note that the seed used for the random number generator is displayed
3352
when this option is used. The seed can be explicitly passed as the
3353
argument to this option if required. This enables reproduction of the
3354
actual ordering used if and when an order sensitive problem is encountered.
3356
If --list-only is given, the tests that would be run are listed. This is
3357
useful when combined with --first, --exclude and/or --randomize to
3358
understand their impact. The test harness reports "Listed nn tests in ..."
3359
instead of "Ran nn tests in ..." when list mode is enabled.
3361
If the global option '--no-plugins' is given, plugins are not loaded
3362
before running the selftests. This has two effects: features provided or
3363
modified by plugins will not be tested, and tests provided by plugins will
3366
Tests that need working space on disk use a common temporary directory,
3367
typically inside $TMPDIR or /tmp.
3369
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3370
into a pdb postmortem session.
3373
Run only tests relating to 'ignore'::
3377
Disable plugins and list tests as they're run::
3379
bzr --no-plugins selftest -v
3381
# NB: this is used from the class without creating an instance, which is
3382
# why it does not have a self parameter.
3383
def get_transport_type(typestring):
3384
"""Parse and return a transport specifier."""
3385
if typestring == "sftp":
3386
from bzrlib.transport.sftp import SFTPAbsoluteServer
3387
return SFTPAbsoluteServer
3388
if typestring == "memory":
3389
from bzrlib.transport.memory import MemoryServer
3391
if typestring == "fakenfs":
3392
from bzrlib.transport.fakenfs import FakeNFSServer
3393
return FakeNFSServer
3394
msg = "No known transport type %s. Supported types are: sftp\n" %\
3396
raise errors.BzrCommandError(msg)
3399
takes_args = ['testspecs*']
3400
takes_options = ['verbose',
3402
help='Stop when one test fails.',
3406
help='Use a different transport by default '
3407
'throughout the test suite.',
3408
type=get_transport_type),
3410
help='Run the benchmarks rather than selftests.'),
3411
Option('lsprof-timed',
3412
help='Generate lsprof output for benchmarked'
3413
' sections of code.'),
3414
Option('lsprof-tests',
3415
help='Generate lsprof output for each test.'),
3416
Option('cache-dir', type=str,
3417
help='Cache intermediate benchmark output in this '
3420
help='Run all tests, but run specified tests first.',
3424
help='List the tests instead of running them.'),
3425
RegistryOption('parallel',
3426
help="Run the test suite in parallel.",
3427
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3428
value_switches=False,
3430
Option('randomize', type=str, argname="SEED",
3431
help='Randomize the order of tests using the given'
3432
' seed or "now" for the current time.'),
3433
Option('exclude', type=str, argname="PATTERN",
3435
help='Exclude tests that match this regular'
3438
help='Output test progress via subunit.'),
3439
Option('strict', help='Fail on missing dependencies or '
3441
Option('load-list', type=str, argname='TESTLISTFILE',
3442
help='Load a test id list from a text file.'),
3443
ListOption('debugflag', type=str, short_name='E',
3444
help='Turn on a selftest debug flag.'),
3445
ListOption('starting-with', type=str, argname='TESTID',
3446
param_name='starting_with', short_name='s',
3448
'Load only the tests starting with TESTID.'),
3450
encoding_type = 'replace'
3453
Command.__init__(self)
3454
self.additional_selftest_args = {}
3456
def run(self, testspecs_list=None, verbose=False, one=False,
3457
transport=None, benchmark=None,
3458
lsprof_timed=None, cache_dir=None,
3459
first=False, list_only=False,
3460
randomize=None, exclude=None, strict=False,
3461
load_list=None, debugflag=None, starting_with=None, subunit=False,
3462
parallel=None, lsprof_tests=False):
3463
from bzrlib.tests import selftest
3464
import bzrlib.benchmarks as benchmarks
3465
from bzrlib.benchmarks import tree_creator
3467
# Make deprecation warnings visible, unless -Werror is set
3468
symbol_versioning.activate_deprecation_warnings(override=False)
3470
if cache_dir is not None:
3471
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3472
if testspecs_list is not None:
3473
pattern = '|'.join(testspecs_list)
3478
from bzrlib.tests import SubUnitBzrRunner
3480
raise errors.BzrCommandError("subunit not available. subunit "
3481
"needs to be installed to use --subunit.")
3482
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3484
self.additional_selftest_args.setdefault(
3485
'suite_decorators', []).append(parallel)
3487
test_suite_factory = benchmarks.test_suite
3488
# Unless user explicitly asks for quiet, be verbose in benchmarks
3489
verbose = not is_quiet()
3490
# TODO: should possibly lock the history file...
3491
benchfile = open(".perf_history", "at", buffering=1)
3493
test_suite_factory = None
3496
selftest_kwargs = {"verbose": verbose,
3498
"stop_on_failure": one,
3499
"transport": transport,
3500
"test_suite_factory": test_suite_factory,
3501
"lsprof_timed": lsprof_timed,
3502
"lsprof_tests": lsprof_tests,
3503
"bench_history": benchfile,
3504
"matching_tests_first": first,
3505
"list_only": list_only,
3506
"random_seed": randomize,
3507
"exclude_pattern": exclude,
3509
"load_list": load_list,
3510
"debug_flags": debugflag,
3511
"starting_with": starting_with
3513
selftest_kwargs.update(self.additional_selftest_args)
3514
result = selftest(**selftest_kwargs)
3516
if benchfile is not None:
3518
return int(not result)
3521
class cmd_version(Command):
3522
"""Show version of bzr."""
3524
encoding_type = 'replace'
3526
Option("short", help="Print just the version number."),
3530
def run(self, short=False):
3531
from bzrlib.version import show_version
3533
self.outf.write(bzrlib.version_string + '\n')
3535
show_version(to_file=self.outf)
3538
class cmd_rocks(Command):
3539
"""Statement of optimism."""
3545
print "It sure does!"
3548
class cmd_find_merge_base(Command):
3549
"""Find and print a base revision for merging two branches."""
3550
# TODO: Options to specify revisions on either side, as if
3551
# merging only part of the history.
3552
takes_args = ['branch', 'other']
3556
def run(self, branch, other):
3557
from bzrlib.revision import ensure_null
3559
branch1 = Branch.open_containing(branch)[0]
3560
branch2 = Branch.open_containing(other)[0]
3565
last1 = ensure_null(branch1.last_revision())
3566
last2 = ensure_null(branch2.last_revision())
3568
graph = branch1.repository.get_graph(branch2.repository)
3569
base_rev_id = graph.find_unique_lca(last1, last2)
3571
print 'merge base is revision %s' % base_rev_id
3578
class cmd_merge(Command):
3579
"""Perform a three-way merge.
3581
The source of the merge can be specified either in the form of a branch,
3582
or in the form of a path to a file containing a merge directive generated
3583
with bzr send. If neither is specified, the default is the upstream branch
3584
or the branch most recently merged using --remember.
3586
When merging a branch, by default the tip will be merged. To pick a different
3587
revision, pass --revision. If you specify two values, the first will be used as
3588
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3589
available revisions, like this is commonly referred to as "cherrypicking".
3591
Revision numbers are always relative to the branch being merged.
3593
By default, bzr will try to merge in all new work from the other
3594
branch, automatically determining an appropriate base. If this
3595
fails, you may need to give an explicit base.
3597
Merge will do its best to combine the changes in two branches, but there
3598
are some kinds of problems only a human can fix. When it encounters those,
3599
it will mark a conflict. A conflict means that you need to fix something,
3600
before you should commit.
3602
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3604
If there is no default branch set, the first merge will set it. After
3605
that, you can omit the branch to use the default. To change the
3606
default, use --remember. The value will only be saved if the remote
3607
location can be accessed.
3609
The results of the merge are placed into the destination working
3610
directory, where they can be reviewed (with bzr diff), tested, and then
3611
committed to record the result of the merge.
3613
merge refuses to run if there are any uncommitted changes, unless
3616
To select only some changes to merge, use "merge -i", which will prompt
3617
you to apply each diff hunk and file change, similar to "shelve".
3620
To merge the latest revision from bzr.dev::
3622
bzr merge ../bzr.dev
3624
To merge changes up to and including revision 82 from bzr.dev::
3626
bzr merge -r 82 ../bzr.dev
3628
To merge the changes introduced by 82, without previous changes::
3630
bzr merge -r 81..82 ../bzr.dev
3632
To apply a merge directive contained in /tmp/merge:
3634
bzr merge /tmp/merge
3637
encoding_type = 'exact'
3638
_see_also = ['update', 'remerge', 'status-flags', 'send']
3639
takes_args = ['location?']
3644
help='Merge even if the destination tree has uncommitted changes.'),
3648
Option('show-base', help="Show base revision text in "
3650
Option('uncommitted', help='Apply uncommitted changes'
3651
' from a working copy, instead of branch changes.'),
3652
Option('pull', help='If the destination is already'
3653
' completely merged into the source, pull from the'
3654
' source rather than merging. When this happens,'
3655
' you do not need to commit the result.'),
3657
help='Branch to merge into, '
3658
'rather than the one containing the working directory.',
3662
Option('preview', help='Instead of merging, show a diff of the'
3664
Option('interactive', help='Select changes interactively.',
3668
def run(self, location=None, revision=None, force=False,
3669
merge_type=None, show_base=False, reprocess=None, remember=False,
3670
uncommitted=False, pull=False,
3675
if merge_type is None:
3676
merge_type = _mod_merge.Merge3Merger
3678
if directory is None: directory = u'.'
3679
possible_transports = []
3681
allow_pending = True
3682
verified = 'inapplicable'
3683
tree = WorkingTree.open_containing(directory)[0]
3686
basis_tree = tree.revision_tree(tree.last_revision())
3687
except errors.NoSuchRevision:
3688
basis_tree = tree.basis_tree()
3690
# die as quickly as possible if there are uncommitted changes
3692
if tree.has_changes():
3693
raise errors.UncommittedChanges(tree)
3695
view_info = _get_view_info_for_change_reporter(tree)
3696
change_reporter = delta._ChangeReporter(
3697
unversioned_filter=tree.is_ignored, view_info=view_info)
3700
pb = ui.ui_factory.nested_progress_bar()
3701
cleanups.append(pb.finished)
3703
cleanups.append(tree.unlock)
3704
if location is not None:
3706
mergeable = bundle.read_mergeable_from_url(location,
3707
possible_transports=possible_transports)
3708
except errors.NotABundle:
3712
raise errors.BzrCommandError('Cannot use --uncommitted'
3713
' with bundles or merge directives.')
3715
if revision is not None:
3716
raise errors.BzrCommandError(
3717
'Cannot use -r with merge directives or bundles')
3718
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3721
if merger is None and uncommitted:
3722
if revision is not None and len(revision) > 0:
3723
raise errors.BzrCommandError('Cannot use --uncommitted and'
3724
' --revision at the same time.')
3725
merger = self.get_merger_from_uncommitted(tree, location, pb,
3727
allow_pending = False
3730
merger, allow_pending = self._get_merger_from_branch(tree,
3731
location, revision, remember, possible_transports, pb)
3733
merger.merge_type = merge_type
3734
merger.reprocess = reprocess
3735
merger.show_base = show_base
3736
self.sanity_check_merger(merger)
3737
if (merger.base_rev_id == merger.other_rev_id and
3738
merger.other_rev_id is not None):
3739
note('Nothing to do.')
3742
if merger.interesting_files is not None:
3743
raise errors.BzrCommandError('Cannot pull individual files')
3744
if (merger.base_rev_id == tree.last_revision()):
3745
result = tree.pull(merger.other_branch, False,
3746
merger.other_rev_id)
3747
result.report(self.outf)
3749
if merger.this_basis is None:
3750
raise errors.BzrCommandError(
3751
"This branch has no commits."
3752
" (perhaps you would prefer 'bzr pull')")
3754
return self._do_preview(merger, cleanups)
3756
return self._do_interactive(merger, cleanups)
3758
return self._do_merge(merger, change_reporter, allow_pending,
3761
for cleanup in reversed(cleanups):
3764
def _get_preview(self, merger, cleanups):
3765
tree_merger = merger.make_merger()
3766
tt = tree_merger.make_preview_transform()
3767
cleanups.append(tt.finalize)
3768
result_tree = tt.get_preview_tree()
3771
def _do_preview(self, merger, cleanups):
3772
from bzrlib.diff import show_diff_trees
3773
result_tree = self._get_preview(merger, cleanups)
3774
show_diff_trees(merger.this_tree, result_tree, self.outf,
3775
old_label='', new_label='')
3777
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3778
merger.change_reporter = change_reporter
3779
conflict_count = merger.do_merge()
3781
merger.set_pending()
3782
if verified == 'failed':
3783
warning('Preview patch does not match changes')
3784
if conflict_count != 0:
3789
def _do_interactive(self, merger, cleanups):
3790
"""Perform an interactive merge.
3792
This works by generating a preview tree of the merge, then using
3793
Shelver to selectively remove the differences between the working tree
3794
and the preview tree.
3796
from bzrlib import shelf_ui
3797
result_tree = self._get_preview(merger, cleanups)
3798
writer = bzrlib.option.diff_writer_registry.get()
3799
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3800
reporter=shelf_ui.ApplyReporter(),
3801
diff_writer=writer(sys.stdout))
3804
def sanity_check_merger(self, merger):
3805
if (merger.show_base and
3806
not merger.merge_type is _mod_merge.Merge3Merger):
3807
raise errors.BzrCommandError("Show-base is not supported for this"
3808
" merge type. %s" % merger.merge_type)
3809
if merger.reprocess is None:
3810
if merger.show_base:
3811
merger.reprocess = False
3813
# Use reprocess if the merger supports it
3814
merger.reprocess = merger.merge_type.supports_reprocess
3815
if merger.reprocess and not merger.merge_type.supports_reprocess:
3816
raise errors.BzrCommandError("Conflict reduction is not supported"
3817
" for merge type %s." %
3819
if merger.reprocess and merger.show_base:
3820
raise errors.BzrCommandError("Cannot do conflict reduction and"
3823
def _get_merger_from_branch(self, tree, location, revision, remember,
3824
possible_transports, pb):
3825
"""Produce a merger from a location, assuming it refers to a branch."""
3826
from bzrlib.tag import _merge_tags_if_possible
3827
# find the branch locations
3828
other_loc, user_location = self._select_branch_location(tree, location,
3830
if revision is not None and len(revision) == 2:
3831
base_loc, _unused = self._select_branch_location(tree,
3832
location, revision, 0)
3834
base_loc = other_loc
3836
other_branch, other_path = Branch.open_containing(other_loc,
3837
possible_transports)
3838
if base_loc == other_loc:
3839
base_branch = other_branch
3841
base_branch, base_path = Branch.open_containing(base_loc,
3842
possible_transports)
3843
# Find the revision ids
3844
other_revision_id = None
3845
base_revision_id = None
3846
if revision is not None:
3847
if len(revision) >= 1:
3848
other_revision_id = revision[-1].as_revision_id(other_branch)
3849
if len(revision) == 2:
3850
base_revision_id = revision[0].as_revision_id(base_branch)
3851
if other_revision_id is None:
3852
other_revision_id = _mod_revision.ensure_null(
3853
other_branch.last_revision())
3854
# Remember where we merge from
3855
if ((remember or tree.branch.get_submit_branch() is None) and
3856
user_location is not None):
3857
tree.branch.set_submit_branch(other_branch.base)
3858
_merge_tags_if_possible(other_branch, tree.branch)
3859
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3860
other_revision_id, base_revision_id, other_branch, base_branch)
3861
if other_path != '':
3862
allow_pending = False
3863
merger.interesting_files = [other_path]
3865
allow_pending = True
3866
return merger, allow_pending
3868
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3869
"""Get a merger for uncommitted changes.
3871
:param tree: The tree the merger should apply to.
3872
:param location: The location containing uncommitted changes.
3873
:param pb: The progress bar to use for showing progress.
3874
:param cleanups: A list of operations to perform to clean up the
3875
temporary directories, unfinalized objects, etc.
3877
location = self._select_branch_location(tree, location)[0]
3878
other_tree, other_path = WorkingTree.open_containing(location)
3879
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3880
if other_path != '':
3881
merger.interesting_files = [other_path]
3884
def _select_branch_location(self, tree, user_location, revision=None,
3886
"""Select a branch location, according to possible inputs.
3888
If provided, branches from ``revision`` are preferred. (Both
3889
``revision`` and ``index`` must be supplied.)
3891
Otherwise, the ``location`` parameter is used. If it is None, then the
3892
``submit`` or ``parent`` location is used, and a note is printed.
3894
:param tree: The working tree to select a branch for merging into
3895
:param location: The location entered by the user
3896
:param revision: The revision parameter to the command
3897
:param index: The index to use for the revision parameter. Negative
3898
indices are permitted.
3899
:return: (selected_location, user_location). The default location
3900
will be the user-entered location.
3902
if (revision is not None and index is not None
3903
and revision[index] is not None):
3904
branch = revision[index].get_branch()
3905
if branch is not None:
3906
return branch, branch
3907
if user_location is None:
3908
location = self._get_remembered(tree, 'Merging from')
3910
location = user_location
3911
return location, user_location
3913
def _get_remembered(self, tree, verb_string):
3914
"""Use tree.branch's parent if none was supplied.
3916
Report if the remembered location was used.
3918
stored_location = tree.branch.get_submit_branch()
3919
stored_location_type = "submit"
3920
if stored_location is None:
3921
stored_location = tree.branch.get_parent()
3922
stored_location_type = "parent"
3923
mutter("%s", stored_location)
3924
if stored_location is None:
3925
raise errors.BzrCommandError("No location specified or remembered")
3926
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3927
note(u"%s remembered %s location %s", verb_string,
3928
stored_location_type, display_url)
3929
return stored_location
3932
class cmd_remerge(Command):
3935
Use this if you want to try a different merge technique while resolving
3936
conflicts. Some merge techniques are better than others, and remerge
3937
lets you try different ones on different files.
3939
The options for remerge have the same meaning and defaults as the ones for
3940
merge. The difference is that remerge can (only) be run when there is a
3941
pending merge, and it lets you specify particular files.
3944
Re-do the merge of all conflicted files, and show the base text in
3945
conflict regions, in addition to the usual THIS and OTHER texts::
3947
bzr remerge --show-base
3949
Re-do the merge of "foobar", using the weave merge algorithm, with
3950
additional processing to reduce the size of conflict regions::
3952
bzr remerge --merge-type weave --reprocess foobar
3954
takes_args = ['file*']
3959
help="Show base revision text in conflicts."),
3962
def run(self, file_list=None, merge_type=None, show_base=False,
3964
if merge_type is None:
3965
merge_type = _mod_merge.Merge3Merger
3966
tree, file_list = tree_files(file_list)
3969
parents = tree.get_parent_ids()
3970
if len(parents) != 2:
3971
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3972
" merges. Not cherrypicking or"
3974
repository = tree.branch.repository
3975
interesting_ids = None
3977
conflicts = tree.conflicts()
3978
if file_list is not None:
3979
interesting_ids = set()
3980
for filename in file_list:
3981
file_id = tree.path2id(filename)
3983
raise errors.NotVersionedError(filename)
3984
interesting_ids.add(file_id)
3985
if tree.kind(file_id) != "directory":
3988
for name, ie in tree.inventory.iter_entries(file_id):
3989
interesting_ids.add(ie.file_id)
3990
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3992
# Remerge only supports resolving contents conflicts
3993
allowed_conflicts = ('text conflict', 'contents conflict')
3994
restore_files = [c.path for c in conflicts
3995
if c.typestring in allowed_conflicts]
3996
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3997
tree.set_conflicts(ConflictList(new_conflicts))
3998
if file_list is not None:
3999
restore_files = file_list
4000
for filename in restore_files:
4002
restore(tree.abspath(filename))
4003
except errors.NotConflicted:
4005
# Disable pending merges, because the file texts we are remerging
4006
# have not had those merges performed. If we use the wrong parents
4007
# list, we imply that the working tree text has seen and rejected
4008
# all the changes from the other tree, when in fact those changes
4009
# have not yet been seen.
4010
pb = ui.ui_factory.nested_progress_bar()
4011
tree.set_parent_ids(parents[:1])
4013
merger = _mod_merge.Merger.from_revision_ids(pb,
4015
merger.interesting_ids = interesting_ids
4016
merger.merge_type = merge_type
4017
merger.show_base = show_base
4018
merger.reprocess = reprocess
4019
conflicts = merger.do_merge()
4021
tree.set_parent_ids(parents)
4031
class cmd_revert(Command):
4032
"""Revert files to a previous revision.
4034
Giving a list of files will revert only those files. Otherwise, all files
4035
will be reverted. If the revision is not specified with '--revision', the
4036
last committed revision is used.
4038
To remove only some changes, without reverting to a prior version, use
4039
merge instead. For example, "merge . --revision -2..-3" will remove the
4040
changes introduced by -2, without affecting the changes introduced by -1.
4041
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4043
By default, any files that have been manually changed will be backed up
4044
first. (Files changed only by merge are not backed up.) Backup files have
4045
'.~#~' appended to their name, where # is a number.
4047
When you provide files, you can use their current pathname or the pathname
4048
from the target revision. So you can use revert to "undelete" a file by
4049
name. If you name a directory, all the contents of that directory will be
4052
Any files that have been newly added since that revision will be deleted,
4053
with a backup kept if appropriate. Directories containing unknown files
4054
will not be deleted.
4056
The working tree contains a list of pending merged revisions, which will
4057
be included as parents in the next commit. Normally, revert clears that
4058
list as well as reverting the files. If any files are specified, revert
4059
leaves the pending merge list alone and reverts only the files. Use "bzr
4060
revert ." in the tree root to revert all files but keep the merge record,
4061
and "bzr revert --forget-merges" to clear the pending merge list without
4062
reverting any files.
4065
_see_also = ['cat', 'export']
4068
Option('no-backup', "Do not save backups of reverted files."),
4069
Option('forget-merges',
4070
'Remove pending merge marker, without changing any files.'),
4072
takes_args = ['file*']
4074
def run(self, revision=None, no_backup=False, file_list=None,
4075
forget_merges=None):
4076
tree, file_list = tree_files(file_list)
4080
tree.set_parent_ids(tree.get_parent_ids()[:1])
4082
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4087
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4088
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4089
pb = ui.ui_factory.nested_progress_bar()
4091
tree.revert(file_list, rev_tree, not no_backup, pb,
4092
report_changes=True)
4097
class cmd_assert_fail(Command):
4098
"""Test reporting of assertion failures"""
4099
# intended just for use in testing
4104
raise AssertionError("always fails")
4107
class cmd_help(Command):
4108
"""Show help on a command or other topic.
4111
_see_also = ['topics']
4113
Option('long', 'Show help on all commands.'),
4115
takes_args = ['topic?']
4116
aliases = ['?', '--help', '-?', '-h']
4119
def run(self, topic=None, long=False):
4121
if topic is None and long:
4123
bzrlib.help.help(topic)
4126
class cmd_shell_complete(Command):
4127
"""Show appropriate completions for context.
4129
For a list of all available commands, say 'bzr shell-complete'.
4131
takes_args = ['context?']
4136
def run(self, context=None):
4137
import shellcomplete
4138
shellcomplete.shellcomplete(context)
4141
class cmd_missing(Command):
4142
"""Show unmerged/unpulled revisions between two branches.
4144
OTHER_BRANCH may be local or remote.
4146
To filter on a range of revisions, you can use the command -r begin..end
4147
-r revision requests a specific revision, -r ..end or -r begin.. are
4152
Determine the missing revisions between this and the branch at the
4153
remembered pull location::
4157
Determine the missing revisions between this and another branch::
4159
bzr missing http://server/branch
4161
Determine the missing revisions up to a specific revision on the other
4164
bzr missing -r ..-10
4166
Determine the missing revisions up to a specific revision on this
4169
bzr missing --my-revision ..-10
4172
_see_also = ['merge', 'pull']
4173
takes_args = ['other_branch?']
4175
Option('reverse', 'Reverse the order of revisions.'),
4177
'Display changes in the local branch only.'),
4178
Option('this' , 'Same as --mine-only.'),
4179
Option('theirs-only',
4180
'Display changes in the remote branch only.'),
4181
Option('other', 'Same as --theirs-only.'),
4185
custom_help('revision',
4186
help='Filter on other branch revisions (inclusive). '
4187
'See "help revisionspec" for details.'),
4188
Option('my-revision',
4189
type=_parse_revision_str,
4190
help='Filter on local branch revisions (inclusive). '
4191
'See "help revisionspec" for details.'),
4192
Option('include-merges',
4193
'Show all revisions in addition to the mainline ones.'),
4195
encoding_type = 'replace'
4198
def run(self, other_branch=None, reverse=False, mine_only=False,
4200
log_format=None, long=False, short=False, line=False,
4201
show_ids=False, verbose=False, this=False, other=False,
4202
include_merges=False, revision=None, my_revision=None):
4203
from bzrlib.missing import find_unmerged, iter_log_revisions
4212
# TODO: We should probably check that we don't have mine-only and
4213
# theirs-only set, but it gets complicated because we also have
4214
# this and other which could be used.
4221
local_branch = Branch.open_containing(u".")[0]
4222
parent = local_branch.get_parent()
4223
if other_branch is None:
4224
other_branch = parent
4225
if other_branch is None:
4226
raise errors.BzrCommandError("No peer location known"
4228
display_url = urlutils.unescape_for_display(parent,
4230
message("Using saved parent location: "
4231
+ display_url + "\n")
4233
remote_branch = Branch.open(other_branch)
4234
if remote_branch.base == local_branch.base:
4235
remote_branch = local_branch
4237
local_revid_range = _revision_range_to_revid_range(
4238
_get_revision_range(my_revision, local_branch,
4241
remote_revid_range = _revision_range_to_revid_range(
4242
_get_revision_range(revision,
4243
remote_branch, self.name()))
4245
local_branch.lock_read()
4247
remote_branch.lock_read()
4249
local_extra, remote_extra = find_unmerged(
4250
local_branch, remote_branch, restrict,
4251
backward=not reverse,
4252
include_merges=include_merges,
4253
local_revid_range=local_revid_range,
4254
remote_revid_range=remote_revid_range)
4256
if log_format is None:
4257
registry = log.log_formatter_registry
4258
log_format = registry.get_default(local_branch)
4259
lf = log_format(to_file=self.outf,
4261
show_timezone='original')
4264
if local_extra and not theirs_only:
4265
message("You have %d extra revision(s):\n" %
4267
for revision in iter_log_revisions(local_extra,
4268
local_branch.repository,
4270
lf.log_revision(revision)
4271
printed_local = True
4274
printed_local = False
4276
if remote_extra and not mine_only:
4277
if printed_local is True:
4279
message("You are missing %d revision(s):\n" %
4281
for revision in iter_log_revisions(remote_extra,
4282
remote_branch.repository,
4284
lf.log_revision(revision)
4287
if mine_only and not local_extra:
4288
# We checked local, and found nothing extra
4289
message('This branch is up to date.\n')
4290
elif theirs_only and not remote_extra:
4291
# We checked remote, and found nothing extra
4292
message('Other branch is up to date.\n')
4293
elif not (mine_only or theirs_only or local_extra or
4295
# We checked both branches, and neither one had extra
4297
message("Branches are up to date.\n")
4299
remote_branch.unlock()
4301
local_branch.unlock()
4302
if not status_code and parent is None and other_branch is not None:
4303
local_branch.lock_write()
4305
# handle race conditions - a parent might be set while we run.
4306
if local_branch.get_parent() is None:
4307
local_branch.set_parent(remote_branch.base)
4309
local_branch.unlock()
4313
class cmd_pack(Command):
4314
"""Compress the data within a repository."""
4316
_see_also = ['repositories']
4317
takes_args = ['branch_or_repo?']
4319
def run(self, branch_or_repo='.'):
4320
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4322
branch = dir.open_branch()
4323
repository = branch.repository
4324
except errors.NotBranchError:
4325
repository = dir.open_repository()
4329
class cmd_plugins(Command):
4330
"""List the installed plugins.
4332
This command displays the list of installed plugins including
4333
version of plugin and a short description of each.
4335
--verbose shows the path where each plugin is located.
4337
A plugin is an external component for Bazaar that extends the
4338
revision control system, by adding or replacing code in Bazaar.
4339
Plugins can do a variety of things, including overriding commands,
4340
adding new commands, providing additional network transports and
4341
customizing log output.
4343
See the Bazaar web site, http://bazaar-vcs.org, for further
4344
information on plugins including where to find them and how to
4345
install them. Instructions are also provided there on how to
4346
write new plugins using the Python programming language.
4348
takes_options = ['verbose']
4351
def run(self, verbose=False):
4352
import bzrlib.plugin
4353
from inspect import getdoc
4355
for name, plugin in bzrlib.plugin.plugins().items():
4356
version = plugin.__version__
4357
if version == 'unknown':
4359
name_ver = '%s %s' % (name, version)
4360
d = getdoc(plugin.module)
4362
doc = d.split('\n')[0]
4364
doc = '(no description)'
4365
result.append((name_ver, doc, plugin.path()))
4366
for name_ver, doc, path in sorted(result):
4374
class cmd_testament(Command):
4375
"""Show testament (signing-form) of a revision."""
4378
Option('long', help='Produce long-format testament.'),
4380
help='Produce a strict-format testament.')]
4381
takes_args = ['branch?']
4383
def run(self, branch=u'.', revision=None, long=False, strict=False):
4384
from bzrlib.testament import Testament, StrictTestament
4386
testament_class = StrictTestament
4388
testament_class = Testament
4390
b = Branch.open_containing(branch)[0]
4392
b = Branch.open(branch)
4395
if revision is None:
4396
rev_id = b.last_revision()
4398
rev_id = revision[0].as_revision_id(b)
4399
t = testament_class.from_revision(b.repository, rev_id)
4401
sys.stdout.writelines(t.as_text_lines())
4403
sys.stdout.write(t.as_short_text())
4408
class cmd_annotate(Command):
4409
"""Show the origin of each line in a file.
4411
This prints out the given file with an annotation on the left side
4412
indicating which revision, author and date introduced the change.
4414
If the origin is the same for a run of consecutive lines, it is
4415
shown only at the top, unless the --all option is given.
4417
# TODO: annotate directories; showing when each file was last changed
4418
# TODO: if the working copy is modified, show annotations on that
4419
# with new uncommitted lines marked
4420
aliases = ['ann', 'blame', 'praise']
4421
takes_args = ['filename']
4422
takes_options = [Option('all', help='Show annotations on all lines.'),
4423
Option('long', help='Show commit date in annotations.'),
4427
encoding_type = 'exact'
4430
def run(self, filename, all=False, long=False, revision=None,
4432
from bzrlib.annotate import annotate_file, annotate_file_tree
4433
wt, branch, relpath = \
4434
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4440
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4442
file_id = wt.path2id(relpath)
4444
file_id = tree.path2id(relpath)
4446
raise errors.NotVersionedError(filename)
4447
file_version = tree.inventory[file_id].revision
4448
if wt is not None and revision is None:
4449
# If there is a tree and we're not annotating historical
4450
# versions, annotate the working tree's content.
4451
annotate_file_tree(wt, file_id, self.outf, long, all,
4454
annotate_file(branch, file_version, file_id, long, all, self.outf,
4463
class cmd_re_sign(Command):
4464
"""Create a digital signature for an existing revision."""
4465
# TODO be able to replace existing ones.
4467
hidden = True # is this right ?
4468
takes_args = ['revision_id*']
4469
takes_options = ['revision']
4471
def run(self, revision_id_list=None, revision=None):
4472
if revision_id_list is not None and revision is not None:
4473
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4474
if revision_id_list is None and revision is None:
4475
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4476
b = WorkingTree.open_containing(u'.')[0].branch
4479
return self._run(b, revision_id_list, revision)
4483
def _run(self, b, revision_id_list, revision):
4484
import bzrlib.gpg as gpg
4485
gpg_strategy = gpg.GPGStrategy(b.get_config())
4486
if revision_id_list is not None:
4487
b.repository.start_write_group()
4489
for revision_id in revision_id_list:
4490
b.repository.sign_revision(revision_id, gpg_strategy)
4492
b.repository.abort_write_group()
4495
b.repository.commit_write_group()
4496
elif revision is not None:
4497
if len(revision) == 1:
4498
revno, rev_id = revision[0].in_history(b)
4499
b.repository.start_write_group()
4501
b.repository.sign_revision(rev_id, gpg_strategy)
4503
b.repository.abort_write_group()
4506
b.repository.commit_write_group()
4507
elif len(revision) == 2:
4508
# are they both on rh- if so we can walk between them
4509
# might be nice to have a range helper for arbitrary
4510
# revision paths. hmm.
4511
from_revno, from_revid = revision[0].in_history(b)
4512
to_revno, to_revid = revision[1].in_history(b)
4513
if to_revid is None:
4514
to_revno = b.revno()
4515
if from_revno is None or to_revno is None:
4516
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4517
b.repository.start_write_group()
4519
for revno in range(from_revno, to_revno + 1):
4520
b.repository.sign_revision(b.get_rev_id(revno),
4523
b.repository.abort_write_group()
4526
b.repository.commit_write_group()
4528
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4531
class cmd_bind(Command):
4532
"""Convert the current branch into a checkout of the supplied branch.
4534
Once converted into a checkout, commits must succeed on the master branch
4535
before they will be applied to the local branch.
4537
Bound branches use the nickname of its master branch unless it is set
4538
locally, in which case binding will update the local nickname to be
4542
_see_also = ['checkouts', 'unbind']
4543
takes_args = ['location?']
4546
def run(self, location=None):
4547
b, relpath = Branch.open_containing(u'.')
4548
if location is None:
4550
location = b.get_old_bound_location()
4551
except errors.UpgradeRequired:
4552
raise errors.BzrCommandError('No location supplied. '
4553
'This format does not remember old locations.')
4555
if location is None:
4556
raise errors.BzrCommandError('No location supplied and no '
4557
'previous location known')
4558
b_other = Branch.open(location)
4561
except errors.DivergedBranches:
4562
raise errors.BzrCommandError('These branches have diverged.'
4563
' Try merging, and then bind again.')
4564
if b.get_config().has_explicit_nickname():
4565
b.nick = b_other.nick
4568
class cmd_unbind(Command):
4569
"""Convert the current checkout into a regular branch.
4571
After unbinding, the local branch is considered independent and subsequent
4572
commits will be local only.
4575
_see_also = ['checkouts', 'bind']
4580
b, relpath = Branch.open_containing(u'.')
4582
raise errors.BzrCommandError('Local branch is not bound')
4585
class cmd_uncommit(Command):
4586
"""Remove the last committed revision.
4588
--verbose will print out what is being removed.
4589
--dry-run will go through all the motions, but not actually
4592
If --revision is specified, uncommit revisions to leave the branch at the
4593
specified revision. For example, "bzr uncommit -r 15" will leave the
4594
branch at revision 15.
4596
Uncommit leaves the working tree ready for a new commit. The only change
4597
it may make is to restore any pending merges that were present before
4601
# TODO: jam 20060108 Add an option to allow uncommit to remove
4602
# unreferenced information in 'branch-as-repository' branches.
4603
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4604
# information in shared branches as well.
4605
_see_also = ['commit']
4606
takes_options = ['verbose', 'revision',
4607
Option('dry-run', help='Don\'t actually make changes.'),
4608
Option('force', help='Say yes to all questions.'),
4610
help="Only remove the commits from the local branch"
4611
" when in a checkout."
4614
takes_args = ['location?']
4616
encoding_type = 'replace'
4618
def run(self, location=None,
4619
dry_run=False, verbose=False,
4620
revision=None, force=False, local=False):
4621
if location is None:
4623
control, relpath = bzrdir.BzrDir.open_containing(location)
4625
tree = control.open_workingtree()
4627
except (errors.NoWorkingTree, errors.NotLocalUrl):
4629
b = control.open_branch()
4631
if tree is not None:
4636
return self._run(b, tree, dry_run, verbose, revision, force,
4639
if tree is not None:
4644
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4645
from bzrlib.log import log_formatter, show_log
4646
from bzrlib.uncommit import uncommit
4648
last_revno, last_rev_id = b.last_revision_info()
4651
if revision is None:
4653
rev_id = last_rev_id
4655
# 'bzr uncommit -r 10' actually means uncommit
4656
# so that the final tree is at revno 10.
4657
# but bzrlib.uncommit.uncommit() actually uncommits
4658
# the revisions that are supplied.
4659
# So we need to offset it by one
4660
revno = revision[0].in_history(b).revno + 1
4661
if revno <= last_revno:
4662
rev_id = b.get_rev_id(revno)
4664
if rev_id is None or _mod_revision.is_null(rev_id):
4665
self.outf.write('No revisions to uncommit.\n')
4668
lf = log_formatter('short',
4670
show_timezone='original')
4675
direction='forward',
4676
start_revision=revno,
4677
end_revision=last_revno)
4680
print 'Dry-run, pretending to remove the above revisions.'
4682
val = raw_input('Press <enter> to continue')
4684
print 'The above revision(s) will be removed.'
4686
val = raw_input('Are you sure [y/N]? ')
4687
if val.lower() not in ('y', 'yes'):
4691
mutter('Uncommitting from {%s} to {%s}',
4692
last_rev_id, rev_id)
4693
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4694
revno=revno, local=local)
4695
note('You can restore the old tip by running:\n'
4696
' bzr pull . -r revid:%s', last_rev_id)
4699
class cmd_break_lock(Command):
4700
"""Break a dead lock on a repository, branch or working directory.
4702
CAUTION: Locks should only be broken when you are sure that the process
4703
holding the lock has been stopped.
4705
You can get information on what locks are open via the 'bzr info' command.
4710
takes_args = ['location?']
4712
def run(self, location=None, show=False):
4713
if location is None:
4715
control, relpath = bzrdir.BzrDir.open_containing(location)
4717
control.break_lock()
4718
except NotImplementedError:
4722
class cmd_wait_until_signalled(Command):
4723
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4725
This just prints a line to signal when it is ready, then blocks on stdin.
4731
sys.stdout.write("running\n")
4733
sys.stdin.readline()
4736
class cmd_serve(Command):
4737
"""Run the bzr server."""
4739
aliases = ['server']
4743
help='Serve on stdin/out for use from inetd or sshd.'),
4744
RegistryOption('protocol',
4745
help="Protocol to serve.",
4746
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4747
value_switches=True),
4749
help='Listen for connections on nominated port of the form '
4750
'[hostname:]portnumber. Passing 0 as the port number will '
4751
'result in a dynamically allocated port. The default port '
4752
'depends on the protocol.',
4755
help='Serve contents of this directory.',
4757
Option('allow-writes',
4758
help='By default the server is a readonly server. Supplying '
4759
'--allow-writes enables write access to the contents of '
4760
'the served directory and below.'
4764
def get_host_and_port(self, port):
4765
"""Return the host and port to run the smart server on.
4767
If 'port' is None, None will be returned for the host and port.
4769
If 'port' has a colon in it, the string before the colon will be
4770
interpreted as the host.
4772
:param port: A string of the port to run the server on.
4773
:return: A tuple of (host, port), where 'host' is a host name or IP,
4774
and port is an integer TCP/IP port.
4777
if port is not None:
4779
host, port = port.split(':')
4783
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4785
from bzrlib.transport import get_transport, transport_server_registry
4786
if directory is None:
4787
directory = os.getcwd()
4788
if protocol is None:
4789
protocol = transport_server_registry.get()
4790
host, port = self.get_host_and_port(port)
4791
url = urlutils.local_path_to_url(directory)
4792
if not allow_writes:
4793
url = 'readonly+' + url
4794
transport = get_transport(url)
4795
protocol(transport, host, port, inet)
4798
class cmd_join(Command):
4799
"""Combine a tree into its containing tree.
4801
This command requires the target tree to be in a rich-root format.
4803
The TREE argument should be an independent tree, inside another tree, but
4804
not part of it. (Such trees can be produced by "bzr split", but also by
4805
running "bzr branch" with the target inside a tree.)
4807
The result is a combined tree, with the subtree no longer an independant
4808
part. This is marked as a merge of the subtree into the containing tree,
4809
and all history is preserved.
4812
_see_also = ['split']
4813
takes_args = ['tree']
4815
Option('reference', help='Join by reference.', hidden=True),
4818
def run(self, tree, reference=False):
4819
sub_tree = WorkingTree.open(tree)
4820
parent_dir = osutils.dirname(sub_tree.basedir)
4821
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4822
repo = containing_tree.branch.repository
4823
if not repo.supports_rich_root():
4824
raise errors.BzrCommandError(
4825
"Can't join trees because %s doesn't support rich root data.\n"
4826
"You can use bzr upgrade on the repository."
4830
containing_tree.add_reference(sub_tree)
4831
except errors.BadReferenceTarget, e:
4832
# XXX: Would be better to just raise a nicely printable
4833
# exception from the real origin. Also below. mbp 20070306
4834
raise errors.BzrCommandError("Cannot join %s. %s" %
4838
containing_tree.subsume(sub_tree)
4839
except errors.BadSubsumeSource, e:
4840
raise errors.BzrCommandError("Cannot join %s. %s" %
4844
class cmd_split(Command):
4845
"""Split a subdirectory of a tree into a separate tree.
4847
This command will produce a target tree in a format that supports
4848
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4849
converted into earlier formats like 'dirstate-tags'.
4851
The TREE argument should be a subdirectory of a working tree. That
4852
subdirectory will be converted into an independent tree, with its own
4853
branch. Commits in the top-level tree will not apply to the new subtree.
4856
_see_also = ['join']
4857
takes_args = ['tree']
4859
def run(self, tree):
4860
containing_tree, subdir = WorkingTree.open_containing(tree)
4861
sub_id = containing_tree.path2id(subdir)
4863
raise errors.NotVersionedError(subdir)
4865
containing_tree.extract(sub_id)
4866
except errors.RootNotRich:
4867
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4870
class cmd_merge_directive(Command):
4871
"""Generate a merge directive for auto-merge tools.
4873
A directive requests a merge to be performed, and also provides all the
4874
information necessary to do so. This means it must either include a
4875
revision bundle, or the location of a branch containing the desired
4878
A submit branch (the location to merge into) must be supplied the first
4879
time the command is issued. After it has been supplied once, it will
4880
be remembered as the default.
4882
A public branch is optional if a revision bundle is supplied, but required
4883
if --diff or --plain is specified. It will be remembered as the default
4884
after the first use.
4887
takes_args = ['submit_branch?', 'public_branch?']
4891
_see_also = ['send']
4894
RegistryOption.from_kwargs('patch-type',
4895
'The type of patch to include in the directive.',
4897
value_switches=True,
4899
bundle='Bazaar revision bundle (default).',
4900
diff='Normal unified diff.',
4901
plain='No patch, just directive.'),
4902
Option('sign', help='GPG-sign the directive.'), 'revision',
4903
Option('mail-to', type=str,
4904
help='Instead of printing the directive, email to this address.'),
4905
Option('message', type=str, short_name='m',
4906
help='Message to use when committing this merge.')
4909
encoding_type = 'exact'
4911
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4912
sign=False, revision=None, mail_to=None, message=None):
4913
from bzrlib.revision import ensure_null, NULL_REVISION
4914
include_patch, include_bundle = {
4915
'plain': (False, False),
4916
'diff': (True, False),
4917
'bundle': (True, True),
4919
branch = Branch.open('.')
4920
stored_submit_branch = branch.get_submit_branch()
4921
if submit_branch is None:
4922
submit_branch = stored_submit_branch
4924
if stored_submit_branch is None:
4925
branch.set_submit_branch(submit_branch)
4926
if submit_branch is None:
4927
submit_branch = branch.get_parent()
4928
if submit_branch is None:
4929
raise errors.BzrCommandError('No submit branch specified or known')
4931
stored_public_branch = branch.get_public_branch()
4932
if public_branch is None:
4933
public_branch = stored_public_branch
4934
elif stored_public_branch is None:
4935
branch.set_public_branch(public_branch)
4936
if not include_bundle and public_branch is None:
4937
raise errors.BzrCommandError('No public branch specified or'
4939
base_revision_id = None
4940
if revision is not None:
4941
if len(revision) > 2:
4942
raise errors.BzrCommandError('bzr merge-directive takes '
4943
'at most two one revision identifiers')
4944
revision_id = revision[-1].as_revision_id(branch)
4945
if len(revision) == 2:
4946
base_revision_id = revision[0].as_revision_id(branch)
4948
revision_id = branch.last_revision()
4949
revision_id = ensure_null(revision_id)
4950
if revision_id == NULL_REVISION:
4951
raise errors.BzrCommandError('No revisions to bundle.')
4952
directive = merge_directive.MergeDirective2.from_objects(
4953
branch.repository, revision_id, time.time(),
4954
osutils.local_time_offset(), submit_branch,
4955
public_branch=public_branch, include_patch=include_patch,
4956
include_bundle=include_bundle, message=message,
4957
base_revision_id=base_revision_id)
4960
self.outf.write(directive.to_signed(branch))
4962
self.outf.writelines(directive.to_lines())
4964
message = directive.to_email(mail_to, branch, sign)
4965
s = SMTPConnection(branch.get_config())
4966
s.send_email(message)
4969
class cmd_send(Command):
4970
"""Mail or create a merge-directive for submitting changes.
4972
A merge directive provides many things needed for requesting merges:
4974
* A machine-readable description of the merge to perform
4976
* An optional patch that is a preview of the changes requested
4978
* An optional bundle of revision data, so that the changes can be applied
4979
directly from the merge directive, without retrieving data from a
4982
If --no-bundle is specified, then public_branch is needed (and must be
4983
up-to-date), so that the receiver can perform the merge using the
4984
public_branch. The public_branch is always included if known, so that
4985
people can check it later.
4987
The submit branch defaults to the parent, but can be overridden. Both
4988
submit branch and public branch will be remembered if supplied.
4990
If a public_branch is known for the submit_branch, that public submit
4991
branch is used in the merge instructions. This means that a local mirror
4992
can be used as your actual submit branch, once you have set public_branch
4995
Mail is sent using your preferred mail program. This should be transparent
4996
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4997
If the preferred client can't be found (or used), your editor will be used.
4999
To use a specific mail program, set the mail_client configuration option.
5000
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5001
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5002
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5003
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5006
If mail is being sent, a to address is required. This can be supplied
5007
either on the commandline, by setting the submit_to configuration
5008
option in the branch itself or the child_submit_to configuration option
5009
in the submit branch.
5011
Two formats are currently supported: "4" uses revision bundle format 4 and
5012
merge directive format 2. It is significantly faster and smaller than
5013
older formats. It is compatible with Bazaar 0.19 and later. It is the
5014
default. "0.9" uses revision bundle format 0.9 and merge directive
5015
format 1. It is compatible with Bazaar 0.12 - 0.18.
5017
The merge directives created by bzr send may be applied using bzr merge or
5018
bzr pull by specifying a file containing a merge directive as the location.
5021
encoding_type = 'exact'
5023
_see_also = ['merge', 'pull']
5025
takes_args = ['submit_branch?', 'public_branch?']
5029
help='Do not include a bundle in the merge directive.'),
5030
Option('no-patch', help='Do not include a preview patch in the merge'
5033
help='Remember submit and public branch.'),
5035
help='Branch to generate the submission from, '
5036
'rather than the one containing the working directory.',
5039
Option('output', short_name='o',
5040
help='Write merge directive to this file; '
5041
'use - for stdout.',
5044
help='Refuse to send if there are uncommitted changes in'
5045
' the working tree, --no-strict disables the check.'),
5046
Option('mail-to', help='Mail the request to this address.',
5050
Option('body', help='Body for the email.', type=unicode),
5051
RegistryOption('format',
5052
help='Use the specified output format.',
5053
lazy_registry=('bzrlib.send', 'format_registry')),
5056
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5057
no_patch=False, revision=None, remember=False, output=None,
5058
format=None, mail_to=None, message=None, body=None,
5059
strict=None, **kwargs):
5060
from bzrlib.send import send
5061
return send(submit_branch, revision, public_branch, remember,
5062
format, no_bundle, no_patch, output,
5063
kwargs.get('from', '.'), mail_to, message, body,
5068
class cmd_bundle_revisions(cmd_send):
5069
"""Create a merge-directive for submitting changes.
5071
A merge directive provides many things needed for requesting merges:
5073
* A machine-readable description of the merge to perform
5075
* An optional patch that is a preview of the changes requested
5077
* An optional bundle of revision data, so that the changes can be applied
5078
directly from the merge directive, without retrieving data from a
5081
If --no-bundle is specified, then public_branch is needed (and must be
5082
up-to-date), so that the receiver can perform the merge using the
5083
public_branch. The public_branch is always included if known, so that
5084
people can check it later.
5086
The submit branch defaults to the parent, but can be overridden. Both
5087
submit branch and public branch will be remembered if supplied.
5089
If a public_branch is known for the submit_branch, that public submit
5090
branch is used in the merge instructions. This means that a local mirror
5091
can be used as your actual submit branch, once you have set public_branch
5094
Two formats are currently supported: "4" uses revision bundle format 4 and
5095
merge directive format 2. It is significantly faster and smaller than
5096
older formats. It is compatible with Bazaar 0.19 and later. It is the
5097
default. "0.9" uses revision bundle format 0.9 and merge directive
5098
format 1. It is compatible with Bazaar 0.12 - 0.18.
5103
help='Do not include a bundle in the merge directive.'),
5104
Option('no-patch', help='Do not include a preview patch in the merge'
5107
help='Remember submit and public branch.'),
5109
help='Branch to generate the submission from, '
5110
'rather than the one containing the working directory.',
5113
Option('output', short_name='o', help='Write directive to this file.',
5116
help='Refuse to bundle revisions if there are uncommitted'
5117
' changes in the working tree, --no-strict disables the check.'),
5119
RegistryOption('format',
5120
help='Use the specified output format.',
5121
lazy_registry=('bzrlib.send', 'format_registry')),
5123
aliases = ['bundle']
5125
_see_also = ['send', 'merge']
5129
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5130
no_patch=False, revision=None, remember=False, output=None,
5131
format=None, strict=None, **kwargs):
5134
from bzrlib.send import send
5135
return send(submit_branch, revision, public_branch, remember,
5136
format, no_bundle, no_patch, output,
5137
kwargs.get('from', '.'), None, None, None,
5138
self.outf, strict=strict)
5141
class cmd_tag(Command):
5142
"""Create, remove or modify a tag naming a revision.
5144
Tags give human-meaningful names to revisions. Commands that take a -r
5145
(--revision) option can be given -rtag:X, where X is any previously
5148
Tags are stored in the branch. Tags are copied from one branch to another
5149
along when you branch, push, pull or merge.
5151
It is an error to give a tag name that already exists unless you pass
5152
--force, in which case the tag is moved to point to the new revision.
5154
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5155
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5158
_see_also = ['commit', 'tags']
5159
takes_args = ['tag_name']
5162
help='Delete this tag rather than placing it.',
5165
help='Branch in which to place the tag.',
5170
help='Replace existing tags.',
5175
def run(self, tag_name,
5181
branch, relpath = Branch.open_containing(directory)
5185
branch.tags.delete_tag(tag_name)
5186
self.outf.write('Deleted tag %s.\n' % tag_name)
5189
if len(revision) != 1:
5190
raise errors.BzrCommandError(
5191
"Tags can only be placed on a single revision, "
5193
revision_id = revision[0].as_revision_id(branch)
5195
revision_id = branch.last_revision()
5196
if (not force) and branch.tags.has_tag(tag_name):
5197
raise errors.TagAlreadyExists(tag_name)
5198
branch.tags.set_tag(tag_name, revision_id)
5199
self.outf.write('Created tag %s.\n' % tag_name)
5204
class cmd_tags(Command):
5207
This command shows a table of tag names and the revisions they reference.
5213
help='Branch whose tags should be displayed.',
5217
RegistryOption.from_kwargs('sort',
5218
'Sort tags by different criteria.', title='Sorting',
5219
alpha='Sort tags lexicographically (default).',
5220
time='Sort tags chronologically.',
5233
branch, relpath = Branch.open_containing(directory)
5235
tags = branch.tags.get_tag_dict().items()
5242
graph = branch.repository.get_graph()
5243
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5244
revid1, revid2 = rev1.rev_id, rev2.rev_id
5245
# only show revisions between revid1 and revid2 (inclusive)
5246
tags = [(tag, revid) for tag, revid in tags if
5247
graph.is_between(revid, revid1, revid2)]
5250
elif sort == 'time':
5252
for tag, revid in tags:
5254
revobj = branch.repository.get_revision(revid)
5255
except errors.NoSuchRevision:
5256
timestamp = sys.maxint # place them at the end
5258
timestamp = revobj.timestamp
5259
timestamps[revid] = timestamp
5260
tags.sort(key=lambda x: timestamps[x[1]])
5262
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5263
for index, (tag, revid) in enumerate(tags):
5265
revno = branch.revision_id_to_dotted_revno(revid)
5266
if isinstance(revno, tuple):
5267
revno = '.'.join(map(str, revno))
5268
except errors.NoSuchRevision:
5269
# Bad tag data/merges can lead to tagged revisions
5270
# which are not in this branch. Fail gracefully ...
5272
tags[index] = (tag, revno)
5275
for tag, revspec in tags:
5276
self.outf.write('%-20s %s\n' % (tag, revspec))
5279
class cmd_reconfigure(Command):
5280
"""Reconfigure the type of a bzr directory.
5282
A target configuration must be specified.
5284
For checkouts, the bind-to location will be auto-detected if not specified.
5285
The order of preference is
5286
1. For a lightweight checkout, the current bound location.
5287
2. For branches that used to be checkouts, the previously-bound location.
5288
3. The push location.
5289
4. The parent location.
5290
If none of these is available, --bind-to must be specified.
5293
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5294
takes_args = ['location?']
5296
RegistryOption.from_kwargs(
5298
title='Target type',
5299
help='The type to reconfigure the directory to.',
5300
value_switches=True, enum_switch=False,
5301
branch='Reconfigure to be an unbound branch with no working tree.',
5302
tree='Reconfigure to be an unbound branch with a working tree.',
5303
checkout='Reconfigure to be a bound branch with a working tree.',
5304
lightweight_checkout='Reconfigure to be a lightweight'
5305
' checkout (with no local history).',
5306
standalone='Reconfigure to be a standalone branch '
5307
'(i.e. stop using shared repository).',
5308
use_shared='Reconfigure to use a shared repository.',
5309
with_trees='Reconfigure repository to create '
5310
'working trees on branches by default.',
5311
with_no_trees='Reconfigure repository to not create '
5312
'working trees on branches by default.'
5314
Option('bind-to', help='Branch to bind checkout to.', type=str),
5316
help='Perform reconfiguration even if local changes'
5318
Option('stacked-on',
5319
help='Reconfigure a branch to be stacked on another branch.',
5323
help='Reconfigure a branch to be unstacked. This '
5324
'may require copying substantial data into it.',
5328
def run(self, location=None, target_type=None, bind_to=None, force=False,
5331
directory = bzrdir.BzrDir.open(location)
5332
if stacked_on and unstacked:
5333
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5334
elif stacked_on is not None:
5335
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5337
reconfigure.ReconfigureUnstacked().apply(directory)
5338
# At the moment you can use --stacked-on and a different
5339
# reconfiguration shape at the same time; there seems no good reason
5341
if target_type is None:
5342
if stacked_on or unstacked:
5345
raise errors.BzrCommandError('No target configuration '
5347
elif target_type == 'branch':
5348
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5349
elif target_type == 'tree':
5350
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5351
elif target_type == 'checkout':
5352
reconfiguration = reconfigure.Reconfigure.to_checkout(
5354
elif target_type == 'lightweight-checkout':
5355
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5357
elif target_type == 'use-shared':
5358
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5359
elif target_type == 'standalone':
5360
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5361
elif target_type == 'with-trees':
5362
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5364
elif target_type == 'with-no-trees':
5365
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5367
reconfiguration.apply(force)
5370
class cmd_switch(Command):
5371
"""Set the branch of a checkout and update.
5373
For lightweight checkouts, this changes the branch being referenced.
5374
For heavyweight checkouts, this checks that there are no local commits
5375
versus the current bound branch, then it makes the local branch a mirror
5376
of the new location and binds to it.
5378
In both cases, the working tree is updated and uncommitted changes
5379
are merged. The user can commit or revert these as they desire.
5381
Pending merges need to be committed or reverted before using switch.
5383
The path to the branch to switch to can be specified relative to the parent
5384
directory of the current branch. For example, if you are currently in a
5385
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5388
Bound branches use the nickname of its master branch unless it is set
5389
locally, in which case switching will update the local nickname to be
5393
takes_args = ['to_location']
5394
takes_options = [Option('force',
5395
help='Switch even if local commits will be lost.'),
5396
Option('create-branch', short_name='b',
5397
help='Create the target branch from this one before'
5398
' switching to it.'),
5401
def run(self, to_location, force=False, create_branch=False):
5402
from bzrlib import switch
5404
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5406
branch = control_dir.open_branch()
5407
had_explicit_nick = branch.get_config().has_explicit_nickname()
5408
except errors.NotBranchError:
5410
had_explicit_nick = False
5413
raise errors.BzrCommandError('cannot create branch without'
5415
if '/' not in to_location and '\\' not in to_location:
5416
# This path is meant to be relative to the existing branch
5417
this_url = self._get_branch_location(control_dir)
5418
to_location = urlutils.join(this_url, '..', to_location)
5419
to_branch = branch.bzrdir.sprout(to_location,
5420
possible_transports=[branch.bzrdir.root_transport],
5421
source_branch=branch).open_branch()
5423
# from_branch = control_dir.open_branch()
5424
# except errors.NotBranchError:
5425
# raise BzrCommandError('Cannot create a branch from this'
5426
# ' location when we cannot open this branch')
5427
# from_branch.bzrdir.sprout(
5431
to_branch = Branch.open(to_location)
5432
except errors.NotBranchError:
5433
this_url = self._get_branch_location(control_dir)
5434
to_branch = Branch.open(
5435
urlutils.join(this_url, '..', to_location))
5436
switch.switch(control_dir, to_branch, force)
5437
if had_explicit_nick:
5438
branch = control_dir.open_branch() #get the new branch!
5439
branch.nick = to_branch.nick
5440
note('Switched to branch: %s',
5441
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5443
def _get_branch_location(self, control_dir):
5444
"""Return location of branch for this control dir."""
5446
this_branch = control_dir.open_branch()
5447
# This may be a heavy checkout, where we want the master branch
5448
master_location = this_branch.get_bound_location()
5449
if master_location is not None:
5450
return master_location
5451
# If not, use a local sibling
5452
return this_branch.base
5453
except errors.NotBranchError:
5454
format = control_dir.find_branch_format()
5455
if getattr(format, 'get_reference', None) is not None:
5456
return format.get_reference(control_dir)
5458
return control_dir.root_transport.base
5461
class cmd_view(Command):
5462
"""Manage filtered views.
5464
Views provide a mask over the tree so that users can focus on
5465
a subset of a tree when doing their work. After creating a view,
5466
commands that support a list of files - status, diff, commit, etc -
5467
effectively have that list of files implicitly given each time.
5468
An explicit list of files can still be given but those files
5469
must be within the current view.
5471
In most cases, a view has a short life-span: it is created to make
5472
a selected change and is deleted once that change is committed.
5473
At other times, you may wish to create one or more named views
5474
and switch between them.
5476
To disable the current view without deleting it, you can switch to
5477
the pseudo view called ``off``. This can be useful when you need
5478
to see the whole tree for an operation or two (e.g. merge) but
5479
want to switch back to your view after that.
5482
To define the current view::
5484
bzr view file1 dir1 ...
5486
To list the current view::
5490
To delete the current view::
5494
To disable the current view without deleting it::
5496
bzr view --switch off
5498
To define a named view and switch to it::
5500
bzr view --name view-name file1 dir1 ...
5502
To list a named view::
5504
bzr view --name view-name
5506
To delete a named view::
5508
bzr view --name view-name --delete
5510
To switch to a named view::
5512
bzr view --switch view-name
5514
To list all views defined::
5518
To delete all views::
5520
bzr view --delete --all
5524
takes_args = ['file*']
5527
help='Apply list or delete action to all views.',
5530
help='Delete the view.',
5533
help='Name of the view to define, list or delete.',
5537
help='Name of the view to switch to.',
5542
def run(self, file_list,
5548
tree, file_list = tree_files(file_list, apply_view=False)
5549
current_view, view_dict = tree.views.get_view_info()
5554
raise errors.BzrCommandError(
5555
"Both --delete and a file list specified")
5557
raise errors.BzrCommandError(
5558
"Both --delete and --switch specified")
5560
tree.views.set_view_info(None, {})
5561
self.outf.write("Deleted all views.\n")
5563
raise errors.BzrCommandError("No current view to delete")
5565
tree.views.delete_view(name)
5566
self.outf.write("Deleted '%s' view.\n" % name)
5569
raise errors.BzrCommandError(
5570
"Both --switch and a file list specified")
5572
raise errors.BzrCommandError(
5573
"Both --switch and --all specified")
5574
elif switch == 'off':
5575
if current_view is None:
5576
raise errors.BzrCommandError("No current view to disable")
5577
tree.views.set_view_info(None, view_dict)
5578
self.outf.write("Disabled '%s' view.\n" % (current_view))
5580
tree.views.set_view_info(switch, view_dict)
5581
view_str = views.view_display_str(tree.views.lookup_view())
5582
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5585
self.outf.write('Views defined:\n')
5586
for view in sorted(view_dict):
5587
if view == current_view:
5591
view_str = views.view_display_str(view_dict[view])
5592
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5594
self.outf.write('No views defined.\n')
5597
# No name given and no current view set
5600
raise errors.BzrCommandError(
5601
"Cannot change the 'off' pseudo view")
5602
tree.views.set_view(name, sorted(file_list))
5603
view_str = views.view_display_str(tree.views.lookup_view())
5604
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5608
# No name given and no current view set
5609
self.outf.write('No current view.\n')
5611
view_str = views.view_display_str(tree.views.lookup_view(name))
5612
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5615
class cmd_hooks(Command):
5621
for hook_key in sorted(hooks.known_hooks.keys()):
5622
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5623
self.outf.write("%s:\n" % type(some_hooks).__name__)
5624
for hook_name, hook_point in sorted(some_hooks.items()):
5625
self.outf.write(" %s:\n" % (hook_name,))
5626
found_hooks = list(hook_point)
5628
for hook in found_hooks:
5629
self.outf.write(" %s\n" %
5630
(some_hooks.get_hook_name(hook),))
5632
self.outf.write(" <no hooks installed>\n")
5635
class cmd_shelve(Command):
5636
"""Temporarily set aside some changes from the current tree.
5638
Shelve allows you to temporarily put changes you've made "on the shelf",
5639
ie. out of the way, until a later time when you can bring them back from
5640
the shelf with the 'unshelve' command. The changes are stored alongside
5641
your working tree, and so they aren't propagated along with your branch nor
5642
will they survive its deletion.
5644
If shelve --list is specified, previously-shelved changes are listed.
5646
Shelve is intended to help separate several sets of changes that have
5647
been inappropriately mingled. If you just want to get rid of all changes
5648
and you don't need to restore them later, use revert. If you want to
5649
shelve all text changes at once, use shelve --all.
5651
If filenames are specified, only the changes to those files will be
5652
shelved. Other files will be left untouched.
5654
If a revision is specified, changes since that revision will be shelved.
5656
You can put multiple items on the shelf, and by default, 'unshelve' will
5657
restore the most recently shelved changes.
5660
takes_args = ['file*']
5664
Option('all', help='Shelve all changes.'),
5666
RegistryOption('writer', 'Method to use for writing diffs.',
5667
bzrlib.option.diff_writer_registry,
5668
value_switches=True, enum_switch=False),
5670
Option('list', help='List shelved changes.'),
5672
help='Destroy removed changes instead of shelving them.'),
5674
_see_also = ['unshelve']
5676
def run(self, revision=None, all=False, file_list=None, message=None,
5677
writer=None, list=False, destroy=False):
5679
return self.run_for_list()
5680
from bzrlib.shelf_ui import Shelver
5682
writer = bzrlib.option.diff_writer_registry.get()
5684
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5685
file_list, message, destroy=destroy)
5690
except errors.UserAbort:
5693
def run_for_list(self):
5694
tree = WorkingTree.open_containing('.')[0]
5697
manager = tree.get_shelf_manager()
5698
shelves = manager.active_shelves()
5699
if len(shelves) == 0:
5700
note('No shelved changes.')
5702
for shelf_id in reversed(shelves):
5703
message = manager.get_metadata(shelf_id).get('message')
5705
message = '<no message>'
5706
self.outf.write('%3d: %s\n' % (shelf_id, message))
5712
class cmd_unshelve(Command):
5713
"""Restore shelved changes.
5715
By default, the most recently shelved changes are restored. However if you
5716
specify a shelf by id those changes will be restored instead. This works
5717
best when the changes don't depend on each other.
5720
takes_args = ['shelf_id?']
5722
RegistryOption.from_kwargs(
5723
'action', help="The action to perform.",
5724
enum_switch=False, value_switches=True,
5725
apply="Apply changes and remove from the shelf.",
5726
dry_run="Show changes, but do not apply or remove them.",
5727
delete_only="Delete changes without applying them."
5730
_see_also = ['shelve']
5732
def run(self, shelf_id=None, action='apply'):
5733
from bzrlib.shelf_ui import Unshelver
5734
unshelver = Unshelver.from_args(shelf_id, action)
5738
unshelver.tree.unlock()
5741
class cmd_clean_tree(Command):
5742
"""Remove unwanted files from working tree.
5744
By default, only unknown files, not ignored files, are deleted. Versioned
5745
files are never deleted.
5747
Another class is 'detritus', which includes files emitted by bzr during
5748
normal operations and selftests. (The value of these files decreases with
5751
If no options are specified, unknown files are deleted. Otherwise, option
5752
flags are respected, and may be combined.
5754
To check what clean-tree will do, use --dry-run.
5756
takes_options = [Option('ignored', help='Delete all ignored files.'),
5757
Option('detritus', help='Delete conflict files, merge'
5758
' backups, and failed selftest dirs.'),
5760
help='Delete files unknown to bzr (default).'),
5761
Option('dry-run', help='Show files to delete instead of'
5763
Option('force', help='Do not prompt before deleting.')]
5764
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5766
from bzrlib.clean_tree import clean_tree
5767
if not (unknown or ignored or detritus):
5771
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5772
dry_run=dry_run, no_prompt=force)
5775
class cmd_reference(Command):
5776
"""list, view and set branch locations for nested trees.
5778
If no arguments are provided, lists the branch locations for nested trees.
5779
If one argument is provided, display the branch location for that tree.
5780
If two arguments are provided, set the branch location for that tree.
5785
takes_args = ['path?', 'location?']
5787
def run(self, path=None, location=None):
5789
if path is not None:
5791
tree, branch, relpath =(
5792
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5793
if path is not None:
5796
tree = branch.basis_tree()
5798
info = branch._get_all_reference_info().iteritems()
5799
self._display_reference_info(tree, branch, info)
5801
file_id = tree.path2id(path)
5803
raise errors.NotVersionedError(path)
5804
if location is None:
5805
info = [(file_id, branch.get_reference_info(file_id))]
5806
self._display_reference_info(tree, branch, info)
5808
branch.set_reference_info(file_id, path, location)
5810
def _display_reference_info(self, tree, branch, info):
5812
for file_id, (path, location) in info:
5814
path = tree.id2path(file_id)
5815
except errors.NoSuchId:
5817
ref_list.append((path, location))
5818
for path, location in sorted(ref_list):
5819
self.outf.write('%s %s\n' % (path, location))
5822
# these get imported and then picked up by the scan for cmd_*
5823
# TODO: Some more consistent way to split command definitions across files;
5824
# we do need to load at least some information about them to know of
5825
# aliases. ideally we would avoid loading the implementation until the
5826
# details were needed.
5827
from bzrlib.cmd_version_info import cmd_version_info
5828
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5829
from bzrlib.bundle.commands import (
5832
from bzrlib.foreign import cmd_dpush
5833
from bzrlib.sign_my_commits import cmd_sign_my_commits
5834
from bzrlib.weave_commands import cmd_versionedfile_list, \
5835
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
