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):
126
if revisions is None:
128
rev_tree = tree.basis_tree()
130
rev_tree = branch.basis_tree()
132
revision = _get_one_revision(command_name, revisions)
133
rev_tree = revision.as_tree(branch)
137
# XXX: Bad function name; should possibly also be a class method of
138
# WorkingTree rather than a function.
139
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
141
"""Convert command-line paths to a WorkingTree and relative paths.
143
This is typically used for command-line processors that take one or
144
more filenames, and infer the workingtree that contains them.
146
The filenames given are not required to exist.
148
:param file_list: Filenames to convert.
150
:param default_branch: Fallback tree path to use if file_list is empty or
153
:param apply_view: if True and a view is set, apply it or check that
154
specified files are within it
156
:return: workingtree, [relative_paths]
158
if file_list is None or len(file_list) == 0:
159
tree = WorkingTree.open_containing(default_branch)[0]
160
if tree.supports_views() and apply_view:
161
view_files = tree.views.lookup_view()
163
file_list = view_files
164
view_str = views.view_display_str(view_files)
165
note("Ignoring files outside view. View is %s" % view_str)
166
return tree, file_list
167
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
168
return tree, safe_relpath_files(tree, file_list, canonicalize,
169
apply_view=apply_view)
172
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
173
"""Convert file_list into a list of relpaths in tree.
175
:param tree: A tree to operate on.
176
:param file_list: A list of user provided paths or None.
177
:param apply_view: if True and a view is set, apply it or check that
178
specified files are within it
179
:return: A list of relative paths.
180
:raises errors.PathNotChild: When a provided path is in a different tree
183
if file_list is None:
185
if tree.supports_views() and apply_view:
186
view_files = tree.views.lookup_view()
190
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
191
# doesn't - fix that up here before we enter the loop.
193
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
196
for filename in file_list:
198
relpath = fixer(osutils.dereference_path(filename))
199
if view_files and not osutils.is_inside_any(view_files, relpath):
200
raise errors.FileOutsideView(filename, view_files)
201
new_list.append(relpath)
202
except errors.PathNotChild:
203
raise errors.FileInWrongBranch(tree.branch, filename)
207
def _get_view_info_for_change_reporter(tree):
208
"""Get the view information from a tree for change reporting."""
211
current_view = tree.views.get_view_info()[0]
212
if current_view is not None:
213
view_info = (current_view, tree.views.lookup_view())
214
except errors.ViewsNotSupported:
219
# TODO: Make sure no commands unconditionally use the working directory as a
220
# branch. If a filename argument is used, the first of them should be used to
221
# specify the branch. (Perhaps this can be factored out into some kind of
222
# Argument class, representing a file in a branch, where the first occurrence
225
class cmd_status(Command):
226
"""Display status summary.
228
This reports on versioned and unknown files, reporting them
229
grouped by state. Possible states are:
232
Versioned in the working copy but not in the previous revision.
235
Versioned in the previous revision but removed or deleted
239
Path of this file changed from the previous revision;
240
the text may also have changed. This includes files whose
241
parent directory was renamed.
244
Text has changed since the previous revision.
247
File kind has been changed (e.g. from file to directory).
250
Not versioned and not matching an ignore pattern.
252
To see ignored files use 'bzr ignored'. For details on the
253
changes to file texts, use 'bzr diff'.
255
Note that --short or -S gives status flags for each item, similar
256
to Subversion's status command. To get output similar to svn -q,
259
If no arguments are specified, the status of the entire working
260
directory is shown. Otherwise, only the status of the specified
261
files or directories is reported. If a directory is given, status
262
is reported for everything inside that directory.
264
Before merges are committed, the pending merge tip revisions are
265
shown. To see all pending merge revisions, use the -v option.
266
To skip the display of pending merge information altogether, use
267
the no-pending option or specify a file/directory.
269
If a revision argument is given, the status is calculated against
270
that revision, or between two revisions if two are provided.
273
# TODO: --no-recurse, --recurse options
275
takes_args = ['file*']
276
takes_options = ['show-ids', 'revision', 'change', 'verbose',
277
Option('short', help='Use short status indicators.',
279
Option('versioned', help='Only show versioned files.',
281
Option('no-pending', help='Don\'t show pending merges.',
284
aliases = ['st', 'stat']
286
encoding_type = 'replace'
287
_see_also = ['diff', 'revert', 'status-flags']
290
def run(self, show_ids=False, file_list=None, revision=None, short=False,
291
versioned=False, no_pending=False, verbose=False):
292
from bzrlib.status import show_tree_status
294
if revision and len(revision) > 2:
295
raise errors.BzrCommandError('bzr status --revision takes exactly'
296
' one or two revision specifiers')
298
tree, relfile_list = tree_files(file_list)
299
# Avoid asking for specific files when that is not needed.
300
if relfile_list == ['']:
302
# Don't disable pending merges for full trees other than '.'.
303
if file_list == ['.']:
305
# A specific path within a tree was given.
306
elif relfile_list is not None:
308
show_tree_status(tree, show_ids=show_ids,
309
specific_files=relfile_list, revision=revision,
310
to_file=self.outf, short=short, versioned=versioned,
311
show_pending=(not no_pending), verbose=verbose)
314
class cmd_cat_revision(Command):
315
"""Write out metadata for a revision.
317
The revision to print can either be specified by a specific
318
revision identifier, or you can use --revision.
322
takes_args = ['revision_id?']
323
takes_options = ['revision']
324
# cat-revision is more for frontends so should be exact
328
def run(self, revision_id=None, revision=None):
329
if revision_id is not None and revision is not None:
330
raise errors.BzrCommandError('You can only supply one of'
331
' revision_id or --revision')
332
if revision_id is None and revision is None:
333
raise errors.BzrCommandError('You must supply either'
334
' --revision or a revision_id')
335
b = WorkingTree.open_containing(u'.')[0].branch
337
# TODO: jam 20060112 should cat-revision always output utf-8?
338
if revision_id is not None:
339
revision_id = osutils.safe_revision_id(revision_id, warn=False)
341
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
342
except errors.NoSuchRevision:
343
msg = "The repository %s contains no revision %s." % (b.repository.base,
345
raise errors.BzrCommandError(msg)
346
elif revision is not None:
349
raise errors.BzrCommandError('You cannot specify a NULL'
351
rev_id = rev.as_revision_id(b)
352
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
355
class cmd_dump_btree(Command):
356
"""Dump the contents of a btree index file to stdout.
358
PATH is a btree index file, it can be any URL. This includes things like
359
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
361
By default, the tuples stored in the index file will be displayed. With
362
--raw, we will uncompress the pages, but otherwise display the raw bytes
366
# TODO: Do we want to dump the internal nodes as well?
367
# TODO: It would be nice to be able to dump the un-parsed information,
368
# rather than only going through iter_all_entries. However, this is
369
# good enough for a start
371
encoding_type = 'exact'
372
takes_args = ['path']
373
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
374
' rather than the parsed tuples.'),
377
def run(self, path, raw=False):
378
dirname, basename = osutils.split(path)
379
t = transport.get_transport(dirname)
381
self._dump_raw_bytes(t, basename)
383
self._dump_entries(t, basename)
385
def _get_index_and_bytes(self, trans, basename):
386
"""Create a BTreeGraphIndex and raw bytes."""
387
bt = btree_index.BTreeGraphIndex(trans, basename, None)
388
bytes = trans.get_bytes(basename)
389
bt._file = cStringIO.StringIO(bytes)
390
bt._size = len(bytes)
393
def _dump_raw_bytes(self, trans, basename):
396
# We need to parse at least the root node.
397
# This is because the first page of every row starts with an
398
# uncompressed header.
399
bt, bytes = self._get_index_and_bytes(trans, basename)
400
for page_idx, page_start in enumerate(xrange(0, len(bytes),
401
btree_index._PAGE_SIZE)):
402
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
403
page_bytes = bytes[page_start:page_end]
405
self.outf.write('Root node:\n')
406
header_end, data = bt._parse_header_from_bytes(page_bytes)
407
self.outf.write(page_bytes[:header_end])
409
self.outf.write('\nPage %d\n' % (page_idx,))
410
decomp_bytes = zlib.decompress(page_bytes)
411
self.outf.write(decomp_bytes)
412
self.outf.write('\n')
414
def _dump_entries(self, trans, basename):
416
st = trans.stat(basename)
417
except errors.TransportNotPossible:
418
# We can't stat, so we'll fake it because we have to do the 'get()'
420
bt, _ = self._get_index_and_bytes(trans, basename)
422
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
423
for node in bt.iter_all_entries():
424
# Node is made up of:
425
# (index, key, value, [references])
426
self.outf.write('%s\n' % (node[1:],))
429
class cmd_remove_tree(Command):
430
"""Remove the working tree from a given branch/checkout.
432
Since a lightweight checkout is little more than a working tree
433
this will refuse to run against one.
435
To re-create the working tree, use "bzr checkout".
437
_see_also = ['checkout', 'working-trees']
438
takes_args = ['location?']
441
help='Remove the working tree even if it has '
442
'uncommitted changes.'),
445
def run(self, location='.', force=False):
446
d = bzrdir.BzrDir.open(location)
449
working = d.open_workingtree()
450
except errors.NoWorkingTree:
451
raise errors.BzrCommandError("No working tree to remove")
452
except errors.NotLocalUrl:
453
raise errors.BzrCommandError("You cannot remove the working tree of a "
456
changes = working.changes_from(working.basis_tree())
457
if changes.has_changed():
458
raise errors.UncommittedChanges(working)
460
working_path = working.bzrdir.root_transport.base
461
branch_path = working.branch.bzrdir.root_transport.base
462
if working_path != branch_path:
463
raise errors.BzrCommandError("You cannot remove the working tree from "
464
"a lightweight checkout")
466
d.destroy_workingtree()
469
class cmd_revno(Command):
470
"""Show current revision number.
472
This is equal to the number of revisions on this branch.
476
takes_args = ['location?']
478
Option('tree', help='Show revno of working tree'),
482
def run(self, tree=False, location=u'.'):
485
wt = WorkingTree.open_containing(location)[0]
487
except (errors.NoWorkingTree, errors.NotLocalUrl):
488
raise errors.NoWorkingTree(location)
490
revid = wt.last_revision()
492
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
493
except errors.NoSuchRevision:
495
revno = ".".join(str(n) for n in revno_t)
499
b = Branch.open_containing(location)[0]
506
self.outf.write(str(revno) + '\n')
509
class cmd_revision_info(Command):
510
"""Show revision number and revision id for a given revision identifier.
513
takes_args = ['revision_info*']
517
help='Branch to examine, '
518
'rather than the one containing the working directory.',
522
Option('tree', help='Show revno of working tree'),
526
def run(self, revision=None, directory=u'.', tree=False,
527
revision_info_list=[]):
530
wt = WorkingTree.open_containing(directory)[0]
533
except (errors.NoWorkingTree, errors.NotLocalUrl):
535
b = Branch.open_containing(directory)[0]
539
if revision is not None:
540
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
541
if revision_info_list is not None:
542
for rev_str in revision_info_list:
543
rev_spec = RevisionSpec.from_string(rev_str)
544
revision_ids.append(rev_spec.as_revision_id(b))
545
# No arguments supplied, default to the last revision
546
if len(revision_ids) == 0:
549
raise errors.NoWorkingTree(directory)
550
revision_ids.append(wt.last_revision())
552
revision_ids.append(b.last_revision())
556
for revision_id in revision_ids:
558
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
559
revno = '.'.join(str(i) for i in dotted_revno)
560
except errors.NoSuchRevision:
562
maxlen = max(maxlen, len(revno))
563
revinfos.append([revno, revision_id])
571
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
574
class cmd_add(Command):
575
"""Add specified files or directories.
577
In non-recursive mode, all the named items are added, regardless
578
of whether they were previously ignored. A warning is given if
579
any of the named files are already versioned.
581
In recursive mode (the default), files are treated the same way
582
but the behaviour for directories is different. Directories that
583
are already versioned do not give a warning. All directories,
584
whether already versioned or not, are searched for files or
585
subdirectories that are neither versioned or ignored, and these
586
are added. This search proceeds recursively into versioned
587
directories. If no names are given '.' is assumed.
589
Therefore simply saying 'bzr add' will version all files that
590
are currently unknown.
592
Adding a file whose parent directory is not versioned will
593
implicitly add the parent, and so on up to the root. This means
594
you should never need to explicitly add a directory, they'll just
595
get added when you add a file in the directory.
597
--dry-run will show which files would be added, but not actually
600
--file-ids-from will try to use the file ids from the supplied path.
601
It looks up ids trying to find a matching parent directory with the
602
same filename, and then by pure path. This option is rarely needed
603
but can be useful when adding the same logical file into two
604
branches that will be merged later (without showing the two different
605
adds as a conflict). It is also useful when merging another project
606
into a subdirectory of this one.
608
takes_args = ['file*']
611
help="Don't recursively add the contents of directories."),
613
help="Show what would be done, but don't actually do anything."),
615
Option('file-ids-from',
617
help='Lookup file ids from this tree.'),
619
encoding_type = 'replace'
620
_see_also = ['remove']
622
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
627
if file_ids_from is not None:
629
base_tree, base_path = WorkingTree.open_containing(
631
except errors.NoWorkingTree:
632
base_branch, base_path = Branch.open_containing(
634
base_tree = base_branch.basis_tree()
636
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
637
to_file=self.outf, should_print=(not is_quiet()))
639
action = bzrlib.add.AddAction(to_file=self.outf,
640
should_print=(not is_quiet()))
643
base_tree.lock_read()
645
file_list = self._maybe_expand_globs(file_list)
646
tree, file_list = tree_files_for_add(file_list)
647
added, ignored = tree.smart_add(file_list, not
648
no_recurse, action=action, save=not dry_run)
650
if base_tree is not None:
654
for glob in sorted(ignored.keys()):
655
for path in ignored[glob]:
656
self.outf.write("ignored %s matching \"%s\"\n"
660
for glob, paths in ignored.items():
661
match_len += len(paths)
662
self.outf.write("ignored %d file(s).\n" % match_len)
663
self.outf.write("If you wish to add ignored files, "
664
"please add them explicitly by name. "
665
"(\"bzr ignored\" gives a list)\n")
668
class cmd_mkdir(Command):
669
"""Create a new versioned directory.
671
This is equivalent to creating the directory and then adding it.
674
takes_args = ['dir+']
675
encoding_type = 'replace'
677
def run(self, dir_list):
680
wt, dd = WorkingTree.open_containing(d)
682
self.outf.write('added %s\n' % d)
685
class cmd_relpath(Command):
686
"""Show path of a file relative to root"""
688
takes_args = ['filename']
692
def run(self, filename):
693
# TODO: jam 20050106 Can relpath return a munged path if
694
# sys.stdout encoding cannot represent it?
695
tree, relpath = WorkingTree.open_containing(filename)
696
self.outf.write(relpath)
697
self.outf.write('\n')
700
class cmd_inventory(Command):
701
"""Show inventory of the current working copy or a revision.
703
It is possible to limit the output to a particular entry
704
type using the --kind option. For example: --kind file.
706
It is also possible to restrict the list of files to a specific
707
set. For example: bzr inventory --show-ids this/file
716
help='List entries of a particular kind: file, directory, symlink.',
719
takes_args = ['file*']
722
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
723
if kind and kind not in ['file', 'directory', 'symlink']:
724
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
726
revision = _get_one_revision('inventory', revision)
727
work_tree, file_list = tree_files(file_list)
728
work_tree.lock_read()
730
if revision is not None:
731
tree = revision.as_tree(work_tree.branch)
733
extra_trees = [work_tree]
739
if file_list is not None:
740
file_ids = tree.paths2ids(file_list, trees=extra_trees,
741
require_versioned=True)
742
# find_ids_across_trees may include some paths that don't
744
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
745
for file_id in file_ids if file_id in tree)
747
entries = tree.inventory.entries()
750
if tree is not work_tree:
753
for path, entry in entries:
754
if kind and kind != entry.kind:
757
self.outf.write('%-50s %s\n' % (path, entry.file_id))
759
self.outf.write(path)
760
self.outf.write('\n')
763
class cmd_mv(Command):
764
"""Move or rename a file.
767
bzr mv OLDNAME NEWNAME
769
bzr mv SOURCE... DESTINATION
771
If the last argument is a versioned directory, all the other names
772
are moved into it. Otherwise, there must be exactly two arguments
773
and the file is changed to a new name.
775
If OLDNAME does not exist on the filesystem but is versioned and
776
NEWNAME does exist on the filesystem but is not versioned, mv
777
assumes that the file has been manually moved and only updates
778
its internal inventory to reflect that change.
779
The same is valid when moving many SOURCE files to a DESTINATION.
781
Files cannot be moved between branches.
784
takes_args = ['names*']
785
takes_options = [Option("after", help="Move only the bzr identifier"
786
" of the file, because the file has already been moved."),
787
Option('auto', help='Automatically guess renames.'),
788
Option('dry-run', help='Avoid making changes when guessing renames.'),
790
aliases = ['move', 'rename']
791
encoding_type = 'replace'
793
def run(self, names_list, after=False, auto=False, dry_run=False):
795
return self.run_auto(names_list, after, dry_run)
797
raise errors.BzrCommandError('--dry-run requires --auto.')
798
if names_list is None:
800
if len(names_list) < 2:
801
raise errors.BzrCommandError("missing file argument")
802
tree, rel_names = tree_files(names_list, canonicalize=False)
805
self._run(tree, names_list, rel_names, after)
809
def run_auto(self, names_list, after, dry_run):
810
if names_list is not None and len(names_list) > 1:
811
raise errors.BzrCommandError('Only one path may be specified to'
814
raise errors.BzrCommandError('--after cannot be specified with'
816
work_tree, file_list = tree_files(names_list, default_branch='.')
817
work_tree.lock_write()
819
rename_map.RenameMap.guess_renames(work_tree, dry_run)
823
def _run(self, tree, names_list, rel_names, after):
824
into_existing = osutils.isdir(names_list[-1])
825
if into_existing and len(names_list) == 2:
827
# a. case-insensitive filesystem and change case of dir
828
# b. move directory after the fact (if the source used to be
829
# a directory, but now doesn't exist in the working tree
830
# and the target is an existing directory, just rename it)
831
if (not tree.case_sensitive
832
and rel_names[0].lower() == rel_names[1].lower()):
833
into_existing = False
836
# 'fix' the case of a potential 'from'
837
from_id = tree.path2id(
838
tree.get_canonical_inventory_path(rel_names[0]))
839
if (not osutils.lexists(names_list[0]) and
840
from_id and inv.get_file_kind(from_id) == "directory"):
841
into_existing = False
844
# move into existing directory
845
# All entries reference existing inventory items, so fix them up
846
# for cicp file-systems.
847
rel_names = tree.get_canonical_inventory_paths(rel_names)
848
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
849
self.outf.write("%s => %s\n" % pair)
851
if len(names_list) != 2:
852
raise errors.BzrCommandError('to mv multiple files the'
853
' destination must be a versioned'
856
# for cicp file-systems: the src references an existing inventory
858
src = tree.get_canonical_inventory_path(rel_names[0])
859
# Find the canonical version of the destination: In all cases, the
860
# parent of the target must be in the inventory, so we fetch the
861
# canonical version from there (we do not always *use* the
862
# canonicalized tail portion - we may be attempting to rename the
864
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
865
dest_parent = osutils.dirname(canon_dest)
866
spec_tail = osutils.basename(rel_names[1])
867
# For a CICP file-system, we need to avoid creating 2 inventory
868
# entries that differ only by case. So regardless of the case
869
# we *want* to use (ie, specified by the user or the file-system),
870
# we must always choose to use the case of any existing inventory
871
# items. The only exception to this is when we are attempting a
872
# case-only rename (ie, canonical versions of src and dest are
874
dest_id = tree.path2id(canon_dest)
875
if dest_id is None or tree.path2id(src) == dest_id:
876
# No existing item we care about, so work out what case we
877
# are actually going to use.
879
# If 'after' is specified, the tail must refer to a file on disk.
881
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
883
# pathjoin with an empty tail adds a slash, which breaks
885
dest_parent_fq = tree.basedir
887
dest_tail = osutils.canonical_relpath(
889
osutils.pathjoin(dest_parent_fq, spec_tail))
891
# not 'after', so case as specified is used
892
dest_tail = spec_tail
894
# Use the existing item so 'mv' fails with AlreadyVersioned.
895
dest_tail = os.path.basename(canon_dest)
896
dest = osutils.pathjoin(dest_parent, dest_tail)
897
mutter("attempting to move %s => %s", src, dest)
898
tree.rename_one(src, dest, after=after)
899
self.outf.write("%s => %s\n" % (src, dest))
902
class cmd_pull(Command):
903
"""Turn this branch into a mirror of another branch.
905
This command only works on branches that have not diverged. Branches are
906
considered diverged if the destination branch's most recent commit is one
907
that has not been merged (directly or indirectly) into the parent.
909
If branches have diverged, you can use 'bzr merge' to integrate the changes
910
from one into the other. Once one branch has merged, the other should
911
be able to pull it again.
913
If you want to forget your local changes and just update your branch to
914
match the remote one, use pull --overwrite.
916
If there is no default location set, the first pull will set it. After
917
that, you can omit the location to use the default. To change the
918
default, use --remember. The value will only be saved if the remote
919
location can be accessed.
921
Note: The location can be specified either in the form of a branch,
922
or in the form of a path to a file containing a merge directive generated
926
_see_also = ['push', 'update', 'status-flags', 'send']
927
takes_options = ['remember', 'overwrite', 'revision',
928
custom_help('verbose',
929
help='Show logs of pulled revisions.'),
931
help='Branch to pull into, '
932
'rather than the one containing the working directory.',
937
help="Perform a local pull in a bound "
938
"branch. Local pulls are not applied to "
942
takes_args = ['location?']
943
encoding_type = 'replace'
945
def run(self, location=None, remember=False, overwrite=False,
946
revision=None, verbose=False,
947
directory=None, local=False):
948
# FIXME: too much stuff is in the command class
951
if directory is None:
954
tree_to = WorkingTree.open_containing(directory)[0]
955
branch_to = tree_to.branch
956
except errors.NoWorkingTree:
958
branch_to = Branch.open_containing(directory)[0]
960
if local and not branch_to.get_bound_location():
961
raise errors.LocalRequiresBoundBranch()
963
possible_transports = []
964
if location is not None:
966
mergeable = bundle.read_mergeable_from_url(location,
967
possible_transports=possible_transports)
968
except errors.NotABundle:
971
stored_loc = branch_to.get_parent()
973
if stored_loc is None:
974
raise errors.BzrCommandError("No pull location known or"
977
display_url = urlutils.unescape_for_display(stored_loc,
980
self.outf.write("Using saved parent location: %s\n" % display_url)
981
location = stored_loc
983
revision = _get_one_revision('pull', revision)
984
if mergeable is not None:
985
if revision is not None:
986
raise errors.BzrCommandError(
987
'Cannot use -r with merge directives or bundles')
988
mergeable.install_revisions(branch_to.repository)
989
base_revision_id, revision_id, verified = \
990
mergeable.get_merge_request(branch_to.repository)
991
branch_from = branch_to
993
branch_from = Branch.open(location,
994
possible_transports=possible_transports)
996
if branch_to.get_parent() is None or remember:
997
branch_to.set_parent(branch_from.base)
999
if branch_from is not branch_to:
1000
branch_from.lock_read()
1002
if revision is not None:
1003
revision_id = revision.as_revision_id(branch_from)
1005
branch_to.lock_write()
1007
if tree_to is not None:
1008
view_info = _get_view_info_for_change_reporter(tree_to)
1009
change_reporter = delta._ChangeReporter(
1010
unversioned_filter=tree_to.is_ignored,
1011
view_info=view_info)
1012
result = tree_to.pull(
1013
branch_from, overwrite, revision_id, change_reporter,
1014
possible_transports=possible_transports, local=local)
1016
result = branch_to.pull(
1017
branch_from, overwrite, revision_id, local=local)
1019
result.report(self.outf)
1020
if verbose and result.old_revid != result.new_revid:
1021
log.show_branch_change(
1022
branch_to, self.outf, result.old_revno,
1027
if branch_from is not branch_to:
1028
branch_from.unlock()
1031
class cmd_push(Command):
1032
"""Update a mirror of this branch.
1034
The target branch will not have its working tree populated because this
1035
is both expensive, and is not supported on remote file systems.
1037
Some smart servers or protocols *may* put the working tree in place in
1040
This command only works on branches that have not diverged. Branches are
1041
considered diverged if the destination branch's most recent commit is one
1042
that has not been merged (directly or indirectly) by the source branch.
1044
If branches have diverged, you can use 'bzr push --overwrite' to replace
1045
the other branch completely, discarding its unmerged changes.
1047
If you want to ensure you have the different changes in the other branch,
1048
do a merge (see bzr help merge) from the other branch, and commit that.
1049
After that you will be able to do a push without '--overwrite'.
1051
If there is no default push location set, the first push will set it.
1052
After that, you can omit the location to use the default. To change the
1053
default, use --remember. The value will only be saved if the remote
1054
location can be accessed.
1057
_see_also = ['pull', 'update', 'working-trees']
1058
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1059
Option('create-prefix',
1060
help='Create the path leading up to the branch '
1061
'if it does not already exist.'),
1063
help='Branch to push from, '
1064
'rather than the one containing the working directory.',
1068
Option('use-existing-dir',
1069
help='By default push will fail if the target'
1070
' directory exists, but does not already'
1071
' have a control directory. This flag will'
1072
' allow push to proceed.'),
1074
help='Create a stacked branch that references the public location '
1075
'of the parent branch.'),
1076
Option('stacked-on',
1077
help='Create a stacked branch that refers to another branch '
1078
'for the commit history. Only the work not present in the '
1079
'referenced branch is included in the branch created.',
1082
help='Refuse to push if there are uncommitted changes in'
1083
' the working tree, --no-strict disables the check.'),
1085
takes_args = ['location?']
1086
encoding_type = 'replace'
1088
def run(self, location=None, remember=False, overwrite=False,
1089
create_prefix=False, verbose=False, revision=None,
1090
use_existing_dir=False, directory=None, stacked_on=None,
1091
stacked=False, strict=None):
1092
from bzrlib.push import _show_push_branch
1094
if directory is None:
1096
# Get the source branch
1098
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1100
strict = br_from.get_config().get_user_option('push_strict')
1101
if strict is not None:
1102
# FIXME: This should be better supported by config
1104
bools = dict(yes=True, no=False, on=True, off=False,
1105
true=True, false=False)
1107
strict = bools[strict.lower()]
1110
# Get the tip's revision_id
1111
revision = _get_one_revision('push', revision)
1112
if revision is not None:
1113
revision_id = revision.in_history(br_from).rev_id
1116
if (tree is not None and revision_id is None
1117
and (strict is None or strict)): # Default to True:
1118
changes = tree.changes_from(tree.basis_tree())
1119
if changes.has_changed() or len(tree.get_parent_ids()) > 1:
1120
raise errors.UncommittedChanges(
1121
tree, more='Use --no-strict to force the push.')
1122
if tree.last_revision() != tree.branch.last_revision():
1123
# The tree has lost sync with its branch, there is little
1124
# chance that the user is aware of it but he can still force
1125
# the push with --no-strict
1126
raise errors.OutOfDateTree(
1127
tree, more='Use --no-strict to force the push.')
1129
# Get the stacked_on branch, if any
1130
if stacked_on is not None:
1131
stacked_on = urlutils.normalize_url(stacked_on)
1133
parent_url = br_from.get_parent()
1135
parent = Branch.open(parent_url)
1136
stacked_on = parent.get_public_branch()
1138
# I considered excluding non-http url's here, thus forcing
1139
# 'public' branches only, but that only works for some
1140
# users, so it's best to just depend on the user spotting an
1141
# error by the feedback given to them. RBC 20080227.
1142
stacked_on = parent_url
1144
raise errors.BzrCommandError(
1145
"Could not determine branch to refer to.")
1147
# Get the destination location
1148
if location is None:
1149
stored_loc = br_from.get_push_location()
1150
if stored_loc is None:
1151
raise errors.BzrCommandError(
1152
"No push location known or specified.")
1154
display_url = urlutils.unescape_for_display(stored_loc,
1156
self.outf.write("Using saved push location: %s\n" % display_url)
1157
location = stored_loc
1159
_show_push_branch(br_from, revision_id, location, self.outf,
1160
verbose=verbose, overwrite=overwrite, remember=remember,
1161
stacked_on=stacked_on, create_prefix=create_prefix,
1162
use_existing_dir=use_existing_dir)
1165
class cmd_branch(Command):
1166
"""Create a new branch that is a copy of an existing branch.
1168
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1169
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1170
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1171
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1172
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1175
To retrieve the branch as of a particular revision, supply the --revision
1176
parameter, as in "branch foo/bar -r 5".
1179
_see_also = ['checkout']
1180
takes_args = ['from_location', 'to_location?']
1181
takes_options = ['revision', Option('hardlink',
1182
help='Hard-link working tree files where possible.'),
1184
help="Create a branch without a working-tree."),
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):
1202
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())
1267
class cmd_checkout(Command):
1268
"""Create a new checkout of an existing branch.
1270
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1271
the branch found in '.'. This is useful if you have removed the working tree
1272
or if it was never created - i.e. if you pushed the branch to its current
1273
location using SFTP.
1275
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1276
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1277
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1278
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1279
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1282
To retrieve the branch as of a particular revision, supply the --revision
1283
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1284
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1288
_see_also = ['checkouts', 'branch']
1289
takes_args = ['branch_location?', 'to_location?']
1290
takes_options = ['revision',
1291
Option('lightweight',
1292
help="Perform a lightweight checkout. Lightweight "
1293
"checkouts depend on access to the branch for "
1294
"every operation. Normal checkouts can perform "
1295
"common operations like diff and status without "
1296
"such access, and also support local commits."
1298
Option('files-from', type=str,
1299
help="Get file contents from this tree."),
1301
help='Hard-link working tree files where possible.'
1306
def run(self, branch_location=None, to_location=None, revision=None,
1307
lightweight=False, files_from=None, hardlink=False):
1308
if branch_location is None:
1309
branch_location = osutils.getcwd()
1310
to_location = branch_location
1311
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1313
revision = _get_one_revision('checkout', revision)
1314
if files_from is not None:
1315
accelerator_tree = WorkingTree.open(files_from)
1316
if revision is not None:
1317
revision_id = revision.as_revision_id(source)
1320
if to_location is None:
1321
to_location = urlutils.derive_to_location(branch_location)
1322
# if the source and to_location are the same,
1323
# and there is no working tree,
1324
# then reconstitute a branch
1325
if (osutils.abspath(to_location) ==
1326
osutils.abspath(branch_location)):
1328
source.bzrdir.open_workingtree()
1329
except errors.NoWorkingTree:
1330
source.bzrdir.create_workingtree(revision_id)
1332
source.create_checkout(to_location, revision_id, lightweight,
1333
accelerator_tree, hardlink)
1336
class cmd_renames(Command):
1337
"""Show list of renamed files.
1339
# TODO: Option to show renames between two historical versions.
1341
# TODO: Only show renames under dir, rather than in the whole branch.
1342
_see_also = ['status']
1343
takes_args = ['dir?']
1346
def run(self, dir=u'.'):
1347
tree = WorkingTree.open_containing(dir)[0]
1350
new_inv = tree.inventory
1351
old_tree = tree.basis_tree()
1352
old_tree.lock_read()
1354
old_inv = old_tree.inventory
1356
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1357
for f, paths, c, v, p, n, k, e in iterator:
1358
if paths[0] == paths[1]:
1362
renames.append(paths)
1364
for old_name, new_name in renames:
1365
self.outf.write("%s => %s\n" % (old_name, new_name))
1372
class cmd_update(Command):
1373
"""Update a tree to have the latest code committed to its branch.
1375
This will perform a merge into the working tree, and may generate
1376
conflicts. If you have any local changes, you will still
1377
need to commit them after the update for the update to be complete.
1379
If you want to discard your local changes, you can just do a
1380
'bzr revert' instead of 'bzr commit' after the update.
1383
_see_also = ['pull', 'working-trees', 'status-flags']
1384
takes_args = ['dir?']
1387
def run(self, dir='.'):
1388
tree = WorkingTree.open_containing(dir)[0]
1389
possible_transports = []
1390
master = tree.branch.get_master_branch(
1391
possible_transports=possible_transports)
1392
if master is not None:
1395
tree.lock_tree_write()
1397
existing_pending_merges = tree.get_parent_ids()[1:]
1398
last_rev = _mod_revision.ensure_null(tree.last_revision())
1399
if last_rev == _mod_revision.ensure_null(
1400
tree.branch.last_revision()):
1401
# may be up to date, check master too.
1402
if master is None or last_rev == _mod_revision.ensure_null(
1403
master.last_revision()):
1404
revno = tree.branch.revision_id_to_revno(last_rev)
1405
note("Tree is up to date at revision %d." % (revno,))
1407
view_info = _get_view_info_for_change_reporter(tree)
1408
conflicts = tree.update(
1409
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1410
view_info=view_info), possible_transports=possible_transports)
1411
revno = tree.branch.revision_id_to_revno(
1412
_mod_revision.ensure_null(tree.last_revision()))
1413
note('Updated to revision %d.' % (revno,))
1414
if tree.get_parent_ids()[1:] != existing_pending_merges:
1415
note('Your local commits will now show as pending merges with '
1416
"'bzr status', and can be committed with 'bzr commit'.")
1425
class cmd_info(Command):
1426
"""Show information about a working tree, branch or repository.
1428
This command will show all known locations and formats associated to the
1429
tree, branch or repository.
1431
In verbose mode, statistical information is included with each report.
1432
To see extended statistic information, use a verbosity level of 2 or
1433
higher by specifying the verbose option multiple times, e.g. -vv.
1435
Branches and working trees will also report any missing revisions.
1439
Display information on the format and related locations:
1443
Display the above together with extended format information and
1444
basic statistics (like the number of files in the working tree and
1445
number of revisions in the branch and repository):
1449
Display the above together with number of committers to the branch:
1453
_see_also = ['revno', 'working-trees', 'repositories']
1454
takes_args = ['location?']
1455
takes_options = ['verbose']
1456
encoding_type = 'replace'
1459
def run(self, location=None, verbose=False):
1461
noise_level = get_verbosity_level()
1464
from bzrlib.info import show_bzrdir_info
1465
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1466
verbose=noise_level, outfile=self.outf)
1469
class cmd_remove(Command):
1470
"""Remove files or directories.
1472
This makes bzr stop tracking changes to the specified files. bzr will delete
1473
them if they can easily be recovered using revert. If no options or
1474
parameters are given bzr will scan for files that are being tracked by bzr
1475
but missing in your tree and stop tracking them for you.
1477
takes_args = ['file*']
1478
takes_options = ['verbose',
1479
Option('new', help='Only remove files that have never been committed.'),
1480
RegistryOption.from_kwargs('file-deletion-strategy',
1481
'The file deletion mode to be used.',
1482
title='Deletion Strategy', value_switches=True, enum_switch=False,
1483
safe='Only delete files if they can be'
1484
' safely recovered (default).',
1485
keep="Don't delete any files.",
1486
force='Delete all the specified files, even if they can not be '
1487
'recovered and even if they are non-empty directories.')]
1488
aliases = ['rm', 'del']
1489
encoding_type = 'replace'
1491
def run(self, file_list, verbose=False, new=False,
1492
file_deletion_strategy='safe'):
1493
tree, file_list = tree_files(file_list)
1495
if file_list is not None:
1496
file_list = [f for f in file_list]
1500
# Heuristics should probably all move into tree.remove_smart or
1503
added = tree.changes_from(tree.basis_tree(),
1504
specific_files=file_list).added
1505
file_list = sorted([f[0] for f in added], reverse=True)
1506
if len(file_list) == 0:
1507
raise errors.BzrCommandError('No matching files.')
1508
elif file_list is None:
1509
# missing files show up in iter_changes(basis) as
1510
# versioned-with-no-kind.
1512
for change in tree.iter_changes(tree.basis_tree()):
1513
# Find paths in the working tree that have no kind:
1514
if change[1][1] is not None and change[6][1] is None:
1515
missing.append(change[1][1])
1516
file_list = sorted(missing, reverse=True)
1517
file_deletion_strategy = 'keep'
1518
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1519
keep_files=file_deletion_strategy=='keep',
1520
force=file_deletion_strategy=='force')
1525
class cmd_file_id(Command):
1526
"""Print file_id of a particular file or directory.
1528
The file_id is assigned when the file is first added and remains the
1529
same through all revisions where the file exists, even when it is
1534
_see_also = ['inventory', 'ls']
1535
takes_args = ['filename']
1538
def run(self, filename):
1539
tree, relpath = WorkingTree.open_containing(filename)
1540
i = tree.path2id(relpath)
1542
raise errors.NotVersionedError(filename)
1544
self.outf.write(i + '\n')
1547
class cmd_file_path(Command):
1548
"""Print path of file_ids to a file or directory.
1550
This prints one line for each directory down to the target,
1551
starting at the branch root.
1555
takes_args = ['filename']
1558
def run(self, filename):
1559
tree, relpath = WorkingTree.open_containing(filename)
1560
fid = tree.path2id(relpath)
1562
raise errors.NotVersionedError(filename)
1563
segments = osutils.splitpath(relpath)
1564
for pos in range(1, len(segments) + 1):
1565
path = osutils.joinpath(segments[:pos])
1566
self.outf.write("%s\n" % tree.path2id(path))
1569
class cmd_reconcile(Command):
1570
"""Reconcile bzr metadata in a branch.
1572
This can correct data mismatches that may have been caused by
1573
previous ghost operations or bzr upgrades. You should only
1574
need to run this command if 'bzr check' or a bzr developer
1575
advises you to run it.
1577
If a second branch is provided, cross-branch reconciliation is
1578
also attempted, which will check that data like the tree root
1579
id which was not present in very early bzr versions is represented
1580
correctly in both branches.
1582
At the same time it is run it may recompress data resulting in
1583
a potential saving in disk space or performance gain.
1585
The branch *MUST* be on a listable system such as local disk or sftp.
1588
_see_also = ['check']
1589
takes_args = ['branch?']
1591
def run(self, branch="."):
1592
from bzrlib.reconcile import reconcile
1593
dir = bzrdir.BzrDir.open(branch)
1597
class cmd_revision_history(Command):
1598
"""Display the list of revision ids on a branch."""
1601
takes_args = ['location?']
1606
def run(self, location="."):
1607
branch = Branch.open_containing(location)[0]
1608
for revid in branch.revision_history():
1609
self.outf.write(revid)
1610
self.outf.write('\n')
1613
class cmd_ancestry(Command):
1614
"""List all revisions merged into this branch."""
1616
_see_also = ['log', 'revision-history']
1617
takes_args = ['location?']
1622
def run(self, location="."):
1624
wt = WorkingTree.open_containing(location)[0]
1625
except errors.NoWorkingTree:
1626
b = Branch.open(location)
1627
last_revision = b.last_revision()
1630
last_revision = wt.last_revision()
1632
revision_ids = b.repository.get_ancestry(last_revision)
1634
for revision_id in revision_ids:
1635
self.outf.write(revision_id + '\n')
1638
class cmd_init(Command):
1639
"""Make a directory into a versioned branch.
1641
Use this to create an empty branch, or before importing an
1644
If there is a repository in a parent directory of the location, then
1645
the history of the branch will be stored in the repository. Otherwise
1646
init creates a standalone branch which carries its own history
1647
in the .bzr directory.
1649
If there is already a branch at the location but it has no working tree,
1650
the tree can be populated with 'bzr checkout'.
1652
Recipe for importing a tree of files::
1658
bzr commit -m "imported project"
1661
_see_also = ['init-repository', 'branch', 'checkout']
1662
takes_args = ['location?']
1664
Option('create-prefix',
1665
help='Create the path leading up to the branch '
1666
'if it does not already exist.'),
1667
RegistryOption('format',
1668
help='Specify a format for this branch. '
1669
'See "help formats".',
1670
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1671
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1672
value_switches=True,
1673
title="Branch Format",
1675
Option('append-revisions-only',
1676
help='Never change revnos or the existing log.'
1677
' Append revisions to it only.')
1679
def run(self, location=None, format=None, append_revisions_only=False,
1680
create_prefix=False):
1682
format = bzrdir.format_registry.make_bzrdir('default')
1683
if location is None:
1686
to_transport = transport.get_transport(location)
1688
# The path has to exist to initialize a
1689
# branch inside of it.
1690
# Just using os.mkdir, since I don't
1691
# believe that we want to create a bunch of
1692
# locations if the user supplies an extended path
1694
to_transport.ensure_base()
1695
except errors.NoSuchFile:
1696
if not create_prefix:
1697
raise errors.BzrCommandError("Parent directory of %s"
1699
"\nYou may supply --create-prefix to create all"
1700
" leading parent directories."
1702
to_transport.create_prefix()
1705
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1706
except errors.NotBranchError:
1707
# really a NotBzrDir error...
1708
create_branch = bzrdir.BzrDir.create_branch_convenience
1709
branch = create_branch(to_transport.base, format=format,
1710
possible_transports=[to_transport])
1711
a_bzrdir = branch.bzrdir
1713
from bzrlib.transport.local import LocalTransport
1714
if a_bzrdir.has_branch():
1715
if (isinstance(to_transport, LocalTransport)
1716
and not a_bzrdir.has_workingtree()):
1717
raise errors.BranchExistsWithoutWorkingTree(location)
1718
raise errors.AlreadyBranchError(location)
1719
branch = a_bzrdir.create_branch()
1720
a_bzrdir.create_workingtree()
1721
if append_revisions_only:
1723
branch.set_append_revisions_only(True)
1724
except errors.UpgradeRequired:
1725
raise errors.BzrCommandError('This branch format cannot be set'
1726
' to append-revisions-only. Try --default.')
1728
from bzrlib.info import describe_layout, describe_format
1730
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1731
except (errors.NoWorkingTree, errors.NotLocalUrl):
1733
repository = branch.repository
1734
layout = describe_layout(repository, branch, tree).lower()
1735
format = describe_format(a_bzrdir, repository, branch, tree)
1736
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1737
if repository.is_shared():
1738
#XXX: maybe this can be refactored into transport.path_or_url()
1739
url = repository.bzrdir.root_transport.external_url()
1741
url = urlutils.local_path_from_url(url)
1742
except errors.InvalidURL:
1744
self.outf.write("Using shared repository: %s\n" % url)
1747
class cmd_init_repository(Command):
1748
"""Create a shared repository to hold branches.
1750
New branches created under the repository directory will store their
1751
revisions in the repository, not in the branch directory.
1753
If the --no-trees option is used then the branches in the repository
1754
will not have working trees by default.
1757
Create a shared repositories holding just branches::
1759
bzr init-repo --no-trees repo
1762
Make a lightweight checkout elsewhere::
1764
bzr checkout --lightweight repo/trunk trunk-checkout
1769
_see_also = ['init', 'branch', 'checkout', 'repositories']
1770
takes_args = ["location"]
1771
takes_options = [RegistryOption('format',
1772
help='Specify a format for this repository. See'
1773
' "bzr help formats" for details.',
1774
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1775
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1776
value_switches=True, title='Repository format'),
1778
help='Branches in the repository will default to'
1779
' not having a working tree.'),
1781
aliases = ["init-repo"]
1783
def run(self, location, format=None, no_trees=False):
1785
format = bzrdir.format_registry.make_bzrdir('default')
1787
if location is None:
1790
to_transport = transport.get_transport(location)
1791
to_transport.ensure_base()
1793
newdir = format.initialize_on_transport(to_transport)
1794
repo = newdir.create_repository(shared=True)
1795
repo.set_make_working_trees(not no_trees)
1797
from bzrlib.info import show_bzrdir_info
1798
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1801
class cmd_diff(Command):
1802
"""Show differences in the working tree, between revisions or branches.
1804
If no arguments are given, all changes for the current tree are listed.
1805
If files are given, only the changes in those files are listed.
1806
Remote and multiple branches can be compared by using the --old and
1807
--new options. If not provided, the default for both is derived from
1808
the first argument, if any, or the current tree if no arguments are
1811
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1812
produces patches suitable for "patch -p1".
1816
2 - unrepresentable changes
1821
Shows the difference in the working tree versus the last commit::
1825
Difference between the working tree and revision 1::
1829
Difference between revision 2 and revision 1::
1833
Difference between revision 2 and revision 1 for branch xxx::
1837
Show just the differences for file NEWS::
1841
Show the differences in working tree xxx for file NEWS::
1845
Show the differences from branch xxx to this working tree:
1849
Show the differences between two branches for file NEWS::
1851
bzr diff --old xxx --new yyy NEWS
1853
Same as 'bzr diff' but prefix paths with old/ and new/::
1855
bzr diff --prefix old/:new/
1857
_see_also = ['status']
1858
takes_args = ['file*']
1860
Option('diff-options', type=str,
1861
help='Pass these options to the external diff program.'),
1862
Option('prefix', type=str,
1864
help='Set prefixes added to old and new filenames, as '
1865
'two values separated by a colon. (eg "old/:new/").'),
1867
help='Branch/tree to compare from.',
1871
help='Branch/tree to compare to.',
1877
help='Use this command to compare files.',
1881
aliases = ['di', 'dif']
1882
encoding_type = 'exact'
1885
def run(self, revision=None, file_list=None, diff_options=None,
1886
prefix=None, old=None, new=None, using=None):
1887
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1889
if (prefix is None) or (prefix == '0'):
1897
old_label, new_label = prefix.split(":")
1899
raise errors.BzrCommandError(
1900
'--prefix expects two values separated by a colon'
1901
' (eg "old/:new/")')
1903
if revision and len(revision) > 2:
1904
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1905
' one or two revision specifiers')
1907
old_tree, new_tree, specific_files, extra_trees = \
1908
_get_trees_to_diff(file_list, revision, old, new,
1910
return show_diff_trees(old_tree, new_tree, sys.stdout,
1911
specific_files=specific_files,
1912
external_diff_options=diff_options,
1913
old_label=old_label, new_label=new_label,
1914
extra_trees=extra_trees, using=using)
1917
class cmd_deleted(Command):
1918
"""List files deleted in the working tree.
1920
# TODO: Show files deleted since a previous revision, or
1921
# between two revisions.
1922
# TODO: Much more efficient way to do this: read in new
1923
# directories with readdir, rather than stating each one. Same
1924
# level of effort but possibly much less IO. (Or possibly not,
1925
# if the directories are very large...)
1926
_see_also = ['status', 'ls']
1927
takes_options = ['show-ids']
1930
def run(self, show_ids=False):
1931
tree = WorkingTree.open_containing(u'.')[0]
1934
old = tree.basis_tree()
1937
for path, ie in old.inventory.iter_entries():
1938
if not tree.has_id(ie.file_id):
1939
self.outf.write(path)
1941
self.outf.write(' ')
1942
self.outf.write(ie.file_id)
1943
self.outf.write('\n')
1950
class cmd_modified(Command):
1951
"""List files modified in working tree.
1955
_see_also = ['status', 'ls']
1958
help='Write an ascii NUL (\\0) separator '
1959
'between files rather than a newline.')
1963
def run(self, null=False):
1964
tree = WorkingTree.open_containing(u'.')[0]
1965
td = tree.changes_from(tree.basis_tree())
1966
for path, id, kind, text_modified, meta_modified in td.modified:
1968
self.outf.write(path + '\0')
1970
self.outf.write(osutils.quotefn(path) + '\n')
1973
class cmd_added(Command):
1974
"""List files added in working tree.
1978
_see_also = ['status', 'ls']
1981
help='Write an ascii NUL (\\0) separator '
1982
'between files rather than a newline.')
1986
def run(self, null=False):
1987
wt = WorkingTree.open_containing(u'.')[0]
1990
basis = wt.basis_tree()
1993
basis_inv = basis.inventory
1996
if file_id in basis_inv:
1998
if inv.is_root(file_id) and len(basis_inv) == 0:
2000
path = inv.id2path(file_id)
2001
if not os.access(osutils.abspath(path), os.F_OK):
2004
self.outf.write(path + '\0')
2006
self.outf.write(osutils.quotefn(path) + '\n')
2013
class cmd_root(Command):
2014
"""Show the tree root directory.
2016
The root is the nearest enclosing directory with a .bzr control
2019
takes_args = ['filename?']
2021
def run(self, filename=None):
2022
"""Print the branch root."""
2023
tree = WorkingTree.open_containing(filename)[0]
2024
self.outf.write(tree.basedir + '\n')
2027
def _parse_limit(limitstring):
2029
return int(limitstring)
2031
msg = "The limit argument must be an integer."
2032
raise errors.BzrCommandError(msg)
2035
def _parse_levels(s):
2039
msg = "The levels argument must be an integer."
2040
raise errors.BzrCommandError(msg)
2043
class cmd_log(Command):
2044
"""Show historical log for a branch or subset of a branch.
2046
log is bzr's default tool for exploring the history of a branch.
2047
The branch to use is taken from the first parameter. If no parameters
2048
are given, the branch containing the working directory is logged.
2049
Here are some simple examples::
2051
bzr log log the current branch
2052
bzr log foo.py log a file in its branch
2053
bzr log http://server/branch log a branch on a server
2055
The filtering, ordering and information shown for each revision can
2056
be controlled as explained below. By default, all revisions are
2057
shown sorted (topologically) so that newer revisions appear before
2058
older ones and descendants always appear before ancestors. If displayed,
2059
merged revisions are shown indented under the revision in which they
2064
The log format controls how information about each revision is
2065
displayed. The standard log formats are called ``long``, ``short``
2066
and ``line``. The default is long. See ``bzr help log-formats``
2067
for more details on log formats.
2069
The following options can be used to control what information is
2072
-l N display a maximum of N revisions
2073
-n N display N levels of revisions (0 for all, 1 for collapsed)
2074
-v display a status summary (delta) for each revision
2075
-p display a diff (patch) for each revision
2076
--show-ids display revision-ids (and file-ids), not just revnos
2078
Note that the default number of levels to display is a function of the
2079
log format. If the -n option is not used, the standard log formats show
2080
just the top level (mainline).
2082
Status summaries are shown using status flags like A, M, etc. To see
2083
the changes explained using words like ``added`` and ``modified``
2084
instead, use the -vv option.
2088
To display revisions from oldest to newest, use the --forward option.
2089
In most cases, using this option will have little impact on the total
2090
time taken to produce a log, though --forward does not incrementally
2091
display revisions like --reverse does when it can.
2093
:Revision filtering:
2095
The -r option can be used to specify what revision or range of revisions
2096
to filter against. The various forms are shown below::
2098
-rX display revision X
2099
-rX.. display revision X and later
2100
-r..Y display up to and including revision Y
2101
-rX..Y display from X to Y inclusive
2103
See ``bzr help revisionspec`` for details on how to specify X and Y.
2104
Some common examples are given below::
2106
-r-1 show just the tip
2107
-r-10.. show the last 10 mainline revisions
2108
-rsubmit:.. show what's new on this branch
2109
-rancestor:path.. show changes since the common ancestor of this
2110
branch and the one at location path
2111
-rdate:yesterday.. show changes since yesterday
2113
When logging a range of revisions using -rX..Y, log starts at
2114
revision Y and searches back in history through the primary
2115
("left-hand") parents until it finds X. When logging just the
2116
top level (using -n1), an error is reported if X is not found
2117
along the way. If multi-level logging is used (-n0), X may be
2118
a nested merge revision and the log will be truncated accordingly.
2122
If parameters are given and the first one is not a branch, the log
2123
will be filtered to show only those revisions that changed the
2124
nominated files or directories.
2126
Filenames are interpreted within their historical context. To log a
2127
deleted file, specify a revision range so that the file existed at
2128
the end or start of the range.
2130
Historical context is also important when interpreting pathnames of
2131
renamed files/directories. Consider the following example:
2133
* revision 1: add tutorial.txt
2134
* revision 2: modify tutorial.txt
2135
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2139
* ``bzr log guide.txt`` will log the file added in revision 1
2141
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2143
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2144
the original file in revision 2.
2146
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2147
was no file called guide.txt in revision 2.
2149
Renames are always followed by log. By design, there is no need to
2150
explicitly ask for this (and no way to stop logging a file back
2151
until it was last renamed).
2155
The --message option can be used for finding revisions that match a
2156
regular expression in a commit message.
2160
GUI tools and IDEs are often better at exploring history than command
2161
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2162
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2163
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2165
Web interfaces are often better at exploring history than command line
2166
tools, particularly for branches on servers. You may prefer Loggerhead
2167
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2169
You may find it useful to add the aliases below to ``bazaar.conf``::
2173
top = log -l10 --line
2176
``bzr tip`` will then show the latest revision while ``bzr top``
2177
will show the last 10 mainline revisions. To see the details of a
2178
particular revision X, ``bzr show -rX``.
2180
If you are interested in looking deeper into a particular merge X,
2181
use ``bzr log -n0 -rX``.
2183
``bzr log -v`` on a branch with lots of history is currently
2184
very slow. A fix for this issue is currently under development.
2185
With or without that fix, it is recommended that a revision range
2186
be given when using the -v option.
2188
bzr has a generic full-text matching plugin, bzr-search, that can be
2189
used to find revisions matching user names, commit messages, etc.
2190
Among other features, this plugin can find all revisions containing
2191
a list of words but not others.
2193
When exploring non-mainline history on large projects with deep
2194
history, the performance of log can be greatly improved by installing
2195
the historycache plugin. This plugin buffers historical information
2196
trading disk space for faster speed.
2198
takes_args = ['file*']
2199
_see_also = ['log-formats', 'revisionspec']
2202
help='Show from oldest to newest.'),
2204
custom_help('verbose',
2205
help='Show files changed in each revision.'),
2209
type=bzrlib.option._parse_revision_str,
2211
help='Show just the specified revision.'
2212
' See also "help revisionspec".'),
2216
help='Number of levels to display - 0 for all, 1 for flat.',
2218
type=_parse_levels),
2221
help='Show revisions whose message matches this '
2222
'regular expression.',
2226
help='Limit the output to the first N revisions.',
2231
help='Show changes made in each revision as a patch.'),
2232
Option('include-merges',
2233
help='Show merged revisions like --levels 0 does.'),
2235
encoding_type = 'replace'
2238
def run(self, file_list=None, timezone='original',
2249
include_merges=False):
2250
from bzrlib.log import (
2252
make_log_request_dict,
2253
_get_info_for_log_files,
2255
direction = (forward and 'forward') or 'reverse'
2260
raise errors.BzrCommandError(
2261
'--levels and --include-merges are mutually exclusive')
2263
if change is not None:
2265
raise errors.RangeInChangeOption()
2266
if revision is not None:
2267
raise errors.BzrCommandError(
2268
'--revision and --change are mutually exclusive')
2273
filter_by_dir = False
2275
# find the file ids to log and check for directory filtering
2276
b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2278
for relpath, file_id, kind in file_info_list:
2280
raise errors.BzrCommandError(
2281
"Path unknown at end or start of revision range: %s" %
2283
# If the relpath is the top of the tree, we log everything
2288
file_ids.append(file_id)
2289
filter_by_dir = filter_by_dir or (
2290
kind in ['directory', 'tree-reference'])
2293
# FIXME ? log the current subdir only RBC 20060203
2294
if revision is not None \
2295
and len(revision) > 0 and revision[0].get_branch():
2296
location = revision[0].get_branch()
2299
dir, relpath = bzrdir.BzrDir.open_containing(location)
2300
b = dir.open_branch()
2301
rev1, rev2 = _get_revision_range(revision, b, self.name())
2303
# Decide on the type of delta & diff filtering to use
2304
# TODO: add an --all-files option to make this configurable & consistent
2312
diff_type = 'partial'
2318
# Build the log formatter
2319
if log_format is None:
2320
log_format = log.log_formatter_registry.get_default(b)
2321
lf = log_format(show_ids=show_ids, to_file=self.outf,
2322
show_timezone=timezone,
2323
delta_format=get_verbosity_level(),
2325
show_advice=levels is None)
2327
# Choose the algorithm for doing the logging. It's annoying
2328
# having multiple code paths like this but necessary until
2329
# the underlying repository format is faster at generating
2330
# deltas or can provide everything we need from the indices.
2331
# The default algorithm - match-using-deltas - works for
2332
# multiple files and directories and is faster for small
2333
# amounts of history (200 revisions say). However, it's too
2334
# slow for logging a single file in a repository with deep
2335
# history, i.e. > 10K revisions. In the spirit of "do no
2336
# evil when adding features", we continue to use the
2337
# original algorithm - per-file-graph - for the "single
2338
# file that isn't a directory without showing a delta" case.
2339
partial_history = revision and b.repository._format.supports_chks
2340
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2341
or delta_type or partial_history)
2343
# Build the LogRequest and execute it
2344
if len(file_ids) == 0:
2346
rqst = make_log_request_dict(
2347
direction=direction, specific_fileids=file_ids,
2348
start_revision=rev1, end_revision=rev2, limit=limit,
2349
message_search=message, delta_type=delta_type,
2350
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2351
Logger(b, rqst).show(lf)
2356
def _get_revision_range(revisionspec_list, branch, command_name):
2357
"""Take the input of a revision option and turn it into a revision range.
2359
It returns RevisionInfo objects which can be used to obtain the rev_id's
2360
of the desired revisions. It does some user input validations.
2362
if revisionspec_list is None:
2365
elif len(revisionspec_list) == 1:
2366
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2367
elif len(revisionspec_list) == 2:
2368
start_spec = revisionspec_list[0]
2369
end_spec = revisionspec_list[1]
2370
if end_spec.get_branch() != start_spec.get_branch():
2371
# b is taken from revision[0].get_branch(), and
2372
# show_log will use its revision_history. Having
2373
# different branches will lead to weird behaviors.
2374
raise errors.BzrCommandError(
2375
"bzr %s doesn't accept two revisions in different"
2376
" branches." % command_name)
2377
rev1 = start_spec.in_history(branch)
2378
# Avoid loading all of history when we know a missing
2379
# end of range means the last revision ...
2380
if end_spec.spec is None:
2381
last_revno, last_revision_id = branch.last_revision_info()
2382
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2384
rev2 = end_spec.in_history(branch)
2386
raise errors.BzrCommandError(
2387
'bzr %s --revision takes one or two values.' % command_name)
2391
def _revision_range_to_revid_range(revision_range):
2394
if revision_range[0] is not None:
2395
rev_id1 = revision_range[0].rev_id
2396
if revision_range[1] is not None:
2397
rev_id2 = revision_range[1].rev_id
2398
return rev_id1, rev_id2
2400
def get_log_format(long=False, short=False, line=False, default='long'):
2401
log_format = default
2405
log_format = 'short'
2411
class cmd_touching_revisions(Command):
2412
"""Return revision-ids which affected a particular file.
2414
A more user-friendly interface is "bzr log FILE".
2418
takes_args = ["filename"]
2421
def run(self, filename):
2422
tree, relpath = WorkingTree.open_containing(filename)
2424
file_id = tree.path2id(relpath)
2425
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2426
self.outf.write("%6d %s\n" % (revno, what))
2429
class cmd_ls(Command):
2430
"""List files in a tree.
2433
_see_also = ['status', 'cat']
2434
takes_args = ['path?']
2438
Option('recursive', short_name='R',
2439
help='Recurse into subdirectories.'),
2441
help='Print paths relative to the root of the branch.'),
2442
Option('unknown', help='Print unknown files.'),
2443
Option('versioned', help='Print versioned files.',
2445
Option('ignored', help='Print ignored files.'),
2447
help='Write an ascii NUL (\\0) separator '
2448
'between files rather than a newline.'),
2450
help='List entries of a particular kind: file, directory, symlink.',
2455
def run(self, revision=None, verbose=False,
2456
recursive=False, from_root=False,
2457
unknown=False, versioned=False, ignored=False,
2458
null=False, kind=None, show_ids=False, path=None):
2460
if kind and kind not in ('file', 'directory', 'symlink'):
2461
raise errors.BzrCommandError('invalid kind specified')
2463
if verbose and null:
2464
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2465
all = not (unknown or versioned or ignored)
2467
selection = {'I':ignored, '?':unknown, 'V':versioned}
2473
raise errors.BzrCommandError('cannot specify both --from-root'
2476
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2479
# Calculate the prefix to use
2483
prefix = relpath + '/'
2484
elif fs_path != '.':
2485
prefix = fs_path + '/'
2487
if revision is not None or tree is None:
2488
tree = _get_one_revision_tree('ls', revision, branch=branch)
2491
if isinstance(tree, WorkingTree) and tree.supports_views():
2492
view_files = tree.views.lookup_view()
2495
view_str = views.view_display_str(view_files)
2496
note("Ignoring files outside view. View is %s" % view_str)
2500
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2501
from_dir=relpath, recursive=recursive):
2502
# Apply additional masking
2503
if not all and not selection[fc]:
2505
if kind is not None and fkind != kind:
2510
fullpath = osutils.pathjoin(relpath, fp)
2513
views.check_path_in_view(tree, fullpath)
2514
except errors.FileOutsideView:
2519
fp = osutils.pathjoin(prefix, fp)
2520
kindch = entry.kind_character()
2521
outstring = fp + kindch
2522
ui.ui_factory.clear_term()
2524
outstring = '%-8s %s' % (fc, outstring)
2525
if show_ids and fid is not None:
2526
outstring = "%-50s %s" % (outstring, fid)
2527
self.outf.write(outstring + '\n')
2529
self.outf.write(fp + '\0')
2532
self.outf.write(fid)
2533
self.outf.write('\0')
2541
self.outf.write('%-50s %s\n' % (outstring, my_id))
2543
self.outf.write(outstring + '\n')
2548
class cmd_unknowns(Command):
2549
"""List unknown files.
2557
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2558
self.outf.write(osutils.quotefn(f) + '\n')
2561
class cmd_ignore(Command):
2562
"""Ignore specified files or patterns.
2564
See ``bzr help patterns`` for details on the syntax of patterns.
2566
To remove patterns from the ignore list, edit the .bzrignore file.
2567
After adding, editing or deleting that file either indirectly by
2568
using this command or directly by using an editor, be sure to commit
2571
Note: ignore patterns containing shell wildcards must be quoted from
2575
Ignore the top level Makefile::
2577
bzr ignore ./Makefile
2579
Ignore class files in all directories::
2581
bzr ignore "*.class"
2583
Ignore .o files under the lib directory::
2585
bzr ignore "lib/**/*.o"
2587
Ignore .o files under the lib directory::
2589
bzr ignore "RE:lib/.*\.o"
2591
Ignore everything but the "debian" toplevel directory::
2593
bzr ignore "RE:(?!debian/).*"
2596
_see_also = ['status', 'ignored', 'patterns']
2597
takes_args = ['name_pattern*']
2599
Option('old-default-rules',
2600
help='Write out the ignore rules bzr < 0.9 always used.')
2603
def run(self, name_pattern_list=None, old_default_rules=None):
2604
from bzrlib import ignores
2605
if old_default_rules is not None:
2606
# dump the rules and exit
2607
for pattern in ignores.OLD_DEFAULTS:
2610
if not name_pattern_list:
2611
raise errors.BzrCommandError("ignore requires at least one "
2612
"NAME_PATTERN or --old-default-rules")
2613
name_pattern_list = [globbing.normalize_pattern(p)
2614
for p in name_pattern_list]
2615
for name_pattern in name_pattern_list:
2616
if (name_pattern[0] == '/' or
2617
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2618
raise errors.BzrCommandError(
2619
"NAME_PATTERN should not be an absolute path")
2620
tree, relpath = WorkingTree.open_containing(u'.')
2621
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2622
ignored = globbing.Globster(name_pattern_list)
2625
for entry in tree.list_files():
2629
if ignored.match(filename):
2630
matches.append(filename.encode('utf-8'))
2632
if len(matches) > 0:
2633
print "Warning: the following files are version controlled and" \
2634
" match your ignore pattern:\n%s" \
2635
"\nThese files will continue to be version controlled" \
2636
" unless you 'bzr remove' them." % ("\n".join(matches),)
2639
class cmd_ignored(Command):
2640
"""List ignored files and the patterns that matched them.
2642
List all the ignored files and the ignore pattern that caused the file to
2645
Alternatively, to list just the files::
2650
encoding_type = 'replace'
2651
_see_also = ['ignore', 'ls']
2655
tree = WorkingTree.open_containing(u'.')[0]
2658
for path, file_class, kind, file_id, entry in tree.list_files():
2659
if file_class != 'I':
2661
## XXX: Slightly inefficient since this was already calculated
2662
pat = tree.is_ignored(path)
2663
self.outf.write('%-50s %s\n' % (path, pat))
2668
class cmd_lookup_revision(Command):
2669
"""Lookup the revision-id from a revision-number
2672
bzr lookup-revision 33
2675
takes_args = ['revno']
2678
def run(self, revno):
2682
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2684
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2687
class cmd_export(Command):
2688
"""Export current or past revision to a destination directory or archive.
2690
If no revision is specified this exports the last committed revision.
2692
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2693
given, try to find the format with the extension. If no extension
2694
is found exports to a directory (equivalent to --format=dir).
2696
If root is supplied, it will be used as the root directory inside
2697
container formats (tar, zip, etc). If it is not supplied it will default
2698
to the exported filename. The root option has no effect for 'dir' format.
2700
If branch is omitted then the branch containing the current working
2701
directory will be used.
2703
Note: Export of tree with non-ASCII filenames to zip is not supported.
2705
================= =========================
2706
Supported formats Autodetected by extension
2707
================= =========================
2710
tbz2 .tar.bz2, .tbz2
2713
================= =========================
2715
takes_args = ['dest', 'branch_or_subdir?']
2718
help="Type of file to export to.",
2721
Option('filters', help='Apply content filters to export the '
2722
'convenient form.'),
2725
help="Name of the root directory inside the exported file."),
2727
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2728
root=None, filters=False):
2729
from bzrlib.export import export
2731
if branch_or_subdir is None:
2732
tree = WorkingTree.open_containing(u'.')[0]
2736
b, subdir = Branch.open_containing(branch_or_subdir)
2739
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2741
export(rev_tree, dest, format, root, subdir, filtered=filters)
2742
except errors.NoSuchExportFormat, e:
2743
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2746
class cmd_cat(Command):
2747
"""Write the contents of a file as of a given revision to standard output.
2749
If no revision is nominated, the last revision is used.
2751
Note: Take care to redirect standard output when using this command on a
2757
Option('name-from-revision', help='The path name in the old tree.'),
2758
Option('filters', help='Apply content filters to display the '
2759
'convenience form.'),
2762
takes_args = ['filename']
2763
encoding_type = 'exact'
2766
def run(self, filename, revision=None, name_from_revision=False,
2768
if revision is not None and len(revision) != 1:
2769
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2770
" one revision specifier")
2771
tree, branch, relpath = \
2772
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2775
return self._run(tree, branch, relpath, filename, revision,
2776
name_from_revision, filters)
2780
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2783
tree = b.basis_tree()
2784
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2786
old_file_id = rev_tree.path2id(relpath)
2788
if name_from_revision:
2789
# Try in revision if requested
2790
if old_file_id is None:
2791
raise errors.BzrCommandError(
2792
"%r is not present in revision %s" % (
2793
filename, rev_tree.get_revision_id()))
2795
content = rev_tree.get_file_text(old_file_id)
2797
cur_file_id = tree.path2id(relpath)
2799
if cur_file_id is not None:
2800
# Then try with the actual file id
2802
content = rev_tree.get_file_text(cur_file_id)
2804
except errors.NoSuchId:
2805
# The actual file id didn't exist at that time
2807
if not found and old_file_id is not None:
2808
# Finally try with the old file id
2809
content = rev_tree.get_file_text(old_file_id)
2812
# Can't be found anywhere
2813
raise errors.BzrCommandError(
2814
"%r is not present in revision %s" % (
2815
filename, rev_tree.get_revision_id()))
2817
from bzrlib.filters import (
2818
ContentFilterContext,
2819
filtered_output_bytes,
2821
filters = rev_tree._content_filter_stack(relpath)
2822
chunks = content.splitlines(True)
2823
content = filtered_output_bytes(chunks, filters,
2824
ContentFilterContext(relpath, rev_tree))
2825
self.outf.writelines(content)
2827
self.outf.write(content)
2830
class cmd_local_time_offset(Command):
2831
"""Show the offset in seconds from GMT to local time."""
2835
print osutils.local_time_offset()
2839
class cmd_commit(Command):
2840
"""Commit changes into a new revision.
2842
An explanatory message needs to be given for each commit. This is
2843
often done by using the --message option (getting the message from the
2844
command line) or by using the --file option (getting the message from
2845
a file). If neither of these options is given, an editor is opened for
2846
the user to enter the message. To see the changed files in the
2847
boilerplate text loaded into the editor, use the --show-diff option.
2849
By default, the entire tree is committed and the person doing the
2850
commit is assumed to be the author. These defaults can be overridden
2855
If selected files are specified, only changes to those files are
2856
committed. If a directory is specified then the directory and
2857
everything within it is committed.
2859
When excludes are given, they take precedence over selected files.
2860
For example, to commit only changes within foo, but not changes
2863
bzr commit foo -x foo/bar
2865
A selective commit after a merge is not yet supported.
2869
If the author of the change is not the same person as the committer,
2870
you can specify the author's name using the --author option. The
2871
name should be in the same format as a committer-id, e.g.
2872
"John Doe <jdoe@example.com>". If there is more than one author of
2873
the change you can specify the option multiple times, once for each
2878
A common mistake is to forget to add a new file or directory before
2879
running the commit command. The --strict option checks for unknown
2880
files and aborts the commit if any are found. More advanced pre-commit
2881
checks can be implemented by defining hooks. See ``bzr help hooks``
2886
If you accidentially commit the wrong changes or make a spelling
2887
mistake in the commit message say, you can use the uncommit command
2888
to undo it. See ``bzr help uncommit`` for details.
2890
Hooks can also be configured to run after a commit. This allows you
2891
to trigger updates to external systems like bug trackers. The --fixes
2892
option can be used to record the association between a revision and
2893
one or more bugs. See ``bzr help bugs`` for details.
2895
A selective commit may fail in some cases where the committed
2896
tree would be invalid. Consider::
2901
bzr commit foo -m "committing foo"
2902
bzr mv foo/bar foo/baz
2905
bzr commit foo/bar -m "committing bar but not baz"
2907
In the example above, the last commit will fail by design. This gives
2908
the user the opportunity to decide whether they want to commit the
2909
rename at the same time, separately first, or not at all. (As a general
2910
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2912
# TODO: Run hooks on tree to-be-committed, and after commit.
2914
# TODO: Strict commit that fails if there are deleted files.
2915
# (what does "deleted files" mean ??)
2917
# TODO: Give better message for -s, --summary, used by tla people
2919
# XXX: verbose currently does nothing
2921
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2922
takes_args = ['selected*']
2924
ListOption('exclude', type=str, short_name='x',
2925
help="Do not consider changes made to a given path."),
2926
Option('message', type=unicode,
2928
help="Description of the new revision."),
2931
help='Commit even if nothing has changed.'),
2932
Option('file', type=str,
2935
help='Take commit message from this file.'),
2937
help="Refuse to commit if there are unknown "
2938
"files in the working tree."),
2939
ListOption('fixes', type=str,
2940
help="Mark a bug as being fixed by this revision "
2941
"(see \"bzr help bugs\")."),
2942
ListOption('author', type=unicode,
2943
help="Set the author's name, if it's different "
2944
"from the committer."),
2946
help="Perform a local commit in a bound "
2947
"branch. Local commits are not pushed to "
2948
"the master branch until a normal commit "
2952
help='When no message is supplied, show the diff along'
2953
' with the status summary in the message editor.'),
2955
aliases = ['ci', 'checkin']
2957
def _iter_bug_fix_urls(self, fixes, branch):
2958
# Configure the properties for bug fixing attributes.
2959
for fixed_bug in fixes:
2960
tokens = fixed_bug.split(':')
2961
if len(tokens) != 2:
2962
raise errors.BzrCommandError(
2963
"Invalid bug %s. Must be in the form of 'tracker:id'. "
2964
"See \"bzr help bugs\" for more information on this "
2965
"feature.\nCommit refused." % fixed_bug)
2966
tag, bug_id = tokens
2968
yield bugtracker.get_bug_url(tag, branch, bug_id)
2969
except errors.UnknownBugTrackerAbbreviation:
2970
raise errors.BzrCommandError(
2971
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2972
except errors.MalformedBugIdentifier, e:
2973
raise errors.BzrCommandError(
2974
"%s\nCommit refused." % (str(e),))
2976
def run(self, message=None, file=None, verbose=False, selected_list=None,
2977
unchanged=False, strict=False, local=False, fixes=None,
2978
author=None, show_diff=False, exclude=None):
2979
from bzrlib.errors import (
2984
from bzrlib.msgeditor import (
2985
edit_commit_message_encoded,
2986
generate_commit_message_template,
2987
make_commit_message_template_encoded
2990
# TODO: Need a blackbox test for invoking the external editor; may be
2991
# slightly problematic to run this cross-platform.
2993
# TODO: do more checks that the commit will succeed before
2994
# spending the user's valuable time typing a commit message.
2998
tree, selected_list = tree_files(selected_list)
2999
if selected_list == ['']:
3000
# workaround - commit of root of tree should be exactly the same
3001
# as just default commit in that tree, and succeed even though
3002
# selected-file merge commit is not done yet
3007
bug_property = bugtracker.encode_fixes_bug_urls(
3008
self._iter_bug_fix_urls(fixes, tree.branch))
3010
properties['bugs'] = bug_property
3012
if local and not tree.branch.get_bound_location():
3013
raise errors.LocalRequiresBoundBranch()
3015
def get_message(commit_obj):
3016
"""Callback to get commit message"""
3017
my_message = message
3018
if my_message is None and not file:
3019
t = make_commit_message_template_encoded(tree,
3020
selected_list, diff=show_diff,
3021
output_encoding=osutils.get_user_encoding())
3022
start_message = generate_commit_message_template(commit_obj)
3023
my_message = edit_commit_message_encoded(t,
3024
start_message=start_message)
3025
if my_message is None:
3026
raise errors.BzrCommandError("please specify a commit"
3027
" message with either --message or --file")
3028
elif my_message and file:
3029
raise errors.BzrCommandError(
3030
"please specify either --message or --file")
3032
my_message = codecs.open(file, 'rt',
3033
osutils.get_user_encoding()).read()
3034
if my_message == "":
3035
raise errors.BzrCommandError("empty commit message specified")
3039
tree.commit(message_callback=get_message,
3040
specific_files=selected_list,
3041
allow_pointless=unchanged, strict=strict, local=local,
3042
reporter=None, verbose=verbose, revprops=properties,
3044
exclude=safe_relpath_files(tree, exclude))
3045
except PointlessCommit:
3046
# FIXME: This should really happen before the file is read in;
3047
# perhaps prepare the commit; get the message; then actually commit
3048
raise errors.BzrCommandError("No changes to commit."
3049
" Use --unchanged to commit anyhow.")
3050
except ConflictsInTree:
3051
raise errors.BzrCommandError('Conflicts detected in working '
3052
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3054
except StrictCommitFailed:
3055
raise errors.BzrCommandError("Commit refused because there are"
3056
" unknown files in the working tree.")
3057
except errors.BoundBranchOutOfDate, e:
3058
raise errors.BzrCommandError(str(e) + "\n"
3059
'To commit to master branch, run update and then commit.\n'
3060
'You can also pass --local to commit to continue working '
3064
class cmd_check(Command):
3065
"""Validate working tree structure, branch consistency and repository history.
3067
This command checks various invariants about branch and repository storage
3068
to detect data corruption or bzr bugs.
3070
The working tree and branch checks will only give output if a problem is
3071
detected. The output fields of the repository check are:
3074
This is just the number of revisions checked. It doesn't
3078
This is just the number of versionedfiles checked. It
3079
doesn't indicate a problem.
3081
unreferenced ancestors
3082
Texts that are ancestors of other texts, but
3083
are not properly referenced by the revision ancestry. This is a
3084
subtle problem that Bazaar can work around.
3087
This is the total number of unique file contents
3088
seen in the checked revisions. It does not indicate a problem.
3091
This is the total number of repeated texts seen
3092
in the checked revisions. Texts can be repeated when their file
3093
entries are modified, but the file contents are not. It does not
3096
If no restrictions are specified, all Bazaar data that is found at the given
3097
location will be checked.
3101
Check the tree and branch at 'foo'::
3103
bzr check --tree --branch foo
3105
Check only the repository at 'bar'::
3107
bzr check --repo bar
3109
Check everything at 'baz'::
3114
_see_also = ['reconcile']
3115
takes_args = ['path?']
3116
takes_options = ['verbose',
3117
Option('branch', help="Check the branch related to the"
3118
" current directory."),
3119
Option('repo', help="Check the repository related to the"
3120
" current directory."),
3121
Option('tree', help="Check the working tree related to"
3122
" the current directory.")]
3124
def run(self, path=None, verbose=False, branch=False, repo=False,
3126
from bzrlib.check import check_dwim
3129
if not branch and not repo and not tree:
3130
branch = repo = tree = True
3131
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3134
class cmd_upgrade(Command):
3135
"""Upgrade branch storage to current format.
3137
The check command or bzr developers may sometimes advise you to run
3138
this command. When the default format has changed you may also be warned
3139
during other operations to upgrade.
3142
_see_also = ['check']
3143
takes_args = ['url?']
3145
RegistryOption('format',
3146
help='Upgrade to a specific format. See "bzr help'
3147
' formats" for details.',
3148
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3149
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3150
value_switches=True, title='Branch format'),
3153
def run(self, url='.', format=None):
3154
from bzrlib.upgrade import upgrade
3155
upgrade(url, format)
3158
class cmd_whoami(Command):
3159
"""Show or set bzr user id.
3162
Show the email of the current user::
3166
Set the current user::
3168
bzr whoami "Frank Chu <fchu@example.com>"
3170
takes_options = [ Option('email',
3171
help='Display email address only.'),
3173
help='Set identity for the current branch instead of '
3176
takes_args = ['name?']
3177
encoding_type = 'replace'
3180
def run(self, email=False, branch=False, name=None):
3182
# use branch if we're inside one; otherwise global config
3184
c = Branch.open_containing('.')[0].get_config()
3185
except errors.NotBranchError:
3186
c = config.GlobalConfig()
3188
self.outf.write(c.user_email() + '\n')
3190
self.outf.write(c.username() + '\n')
3193
# display a warning if an email address isn't included in the given name.
3195
config.extract_email_address(name)
3196
except errors.NoEmailInUsername, e:
3197
warning('"%s" does not seem to contain an email address. '
3198
'This is allowed, but not recommended.', name)
3200
# use global config unless --branch given
3202
c = Branch.open_containing('.')[0].get_config()
3204
c = config.GlobalConfig()
3205
c.set_user_option('email', name)
3208
class cmd_nick(Command):
3209
"""Print or set the branch nickname.
3211
If unset, the tree root directory name is used as the nickname.
3212
To print the current nickname, execute with no argument.
3214
Bound branches use the nickname of its master branch unless it is set
3218
_see_also = ['info']
3219
takes_args = ['nickname?']
3220
def run(self, nickname=None):
3221
branch = Branch.open_containing(u'.')[0]
3222
if nickname is None:
3223
self.printme(branch)
3225
branch.nick = nickname
3228
def printme(self, branch):
3232
class cmd_alias(Command):
3233
"""Set/unset and display aliases.
3236
Show the current aliases::
3240
Show the alias specified for 'll'::
3244
Set an alias for 'll'::
3246
bzr alias ll="log --line -r-10..-1"
3248
To remove an alias for 'll'::
3250
bzr alias --remove ll
3253
takes_args = ['name?']
3255
Option('remove', help='Remove the alias.'),
3258
def run(self, name=None, remove=False):
3260
self.remove_alias(name)
3262
self.print_aliases()
3264
equal_pos = name.find('=')
3266
self.print_alias(name)
3268
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3270
def remove_alias(self, alias_name):
3271
if alias_name is None:
3272
raise errors.BzrCommandError(
3273
'bzr alias --remove expects an alias to remove.')
3274
# If alias is not found, print something like:
3275
# unalias: foo: not found
3276
c = config.GlobalConfig()
3277
c.unset_alias(alias_name)
3280
def print_aliases(self):
3281
"""Print out the defined aliases in a similar format to bash."""
3282
aliases = config.GlobalConfig().get_aliases()
3283
for key, value in sorted(aliases.iteritems()):
3284
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3287
def print_alias(self, alias_name):
3288
from bzrlib.commands import get_alias
3289
alias = get_alias(alias_name)
3291
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3294
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3296
def set_alias(self, alias_name, alias_command):
3297
"""Save the alias in the global config."""
3298
c = config.GlobalConfig()
3299
c.set_alias(alias_name, alias_command)
3302
class cmd_selftest(Command):
3303
"""Run internal test suite.
3305
If arguments are given, they are regular expressions that say which tests
3306
should run. Tests matching any expression are run, and other tests are
3309
Alternatively if --first is given, matching tests are run first and then
3310
all other tests are run. This is useful if you have been working in a
3311
particular area, but want to make sure nothing else was broken.
3313
If --exclude is given, tests that match that regular expression are
3314
excluded, regardless of whether they match --first or not.
3316
To help catch accidential dependencies between tests, the --randomize
3317
option is useful. In most cases, the argument used is the word 'now'.
3318
Note that the seed used for the random number generator is displayed
3319
when this option is used. The seed can be explicitly passed as the
3320
argument to this option if required. This enables reproduction of the
3321
actual ordering used if and when an order sensitive problem is encountered.
3323
If --list-only is given, the tests that would be run are listed. This is
3324
useful when combined with --first, --exclude and/or --randomize to
3325
understand their impact. The test harness reports "Listed nn tests in ..."
3326
instead of "Ran nn tests in ..." when list mode is enabled.
3328
If the global option '--no-plugins' is given, plugins are not loaded
3329
before running the selftests. This has two effects: features provided or
3330
modified by plugins will not be tested, and tests provided by plugins will
3333
Tests that need working space on disk use a common temporary directory,
3334
typically inside $TMPDIR or /tmp.
3337
Run only tests relating to 'ignore'::
3341
Disable plugins and list tests as they're run::
3343
bzr --no-plugins selftest -v
3345
# NB: this is used from the class without creating an instance, which is
3346
# why it does not have a self parameter.
3347
def get_transport_type(typestring):
3348
"""Parse and return a transport specifier."""
3349
if typestring == "sftp":
3350
from bzrlib.transport.sftp import SFTPAbsoluteServer
3351
return SFTPAbsoluteServer
3352
if typestring == "memory":
3353
from bzrlib.transport.memory import MemoryServer
3355
if typestring == "fakenfs":
3356
from bzrlib.transport.fakenfs import FakeNFSServer
3357
return FakeNFSServer
3358
msg = "No known transport type %s. Supported types are: sftp\n" %\
3360
raise errors.BzrCommandError(msg)
3363
takes_args = ['testspecs*']
3364
takes_options = ['verbose',
3366
help='Stop when one test fails.',
3370
help='Use a different transport by default '
3371
'throughout the test suite.',
3372
type=get_transport_type),
3374
help='Run the benchmarks rather than selftests.'),
3375
Option('lsprof-timed',
3376
help='Generate lsprof output for benchmarked'
3377
' sections of code.'),
3378
Option('cache-dir', type=str,
3379
help='Cache intermediate benchmark output in this '
3382
help='Run all tests, but run specified tests first.',
3386
help='List the tests instead of running them.'),
3387
RegistryOption('parallel',
3388
help="Run the test suite in parallel.",
3389
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3390
value_switches=False,
3392
Option('randomize', type=str, argname="SEED",
3393
help='Randomize the order of tests using the given'
3394
' seed or "now" for the current time.'),
3395
Option('exclude', type=str, argname="PATTERN",
3397
help='Exclude tests that match this regular'
3400
help='Output test progress via subunit.'),
3401
Option('strict', help='Fail on missing dependencies or '
3403
Option('load-list', type=str, argname='TESTLISTFILE',
3404
help='Load a test id list from a text file.'),
3405
ListOption('debugflag', type=str, short_name='E',
3406
help='Turn on a selftest debug flag.'),
3407
ListOption('starting-with', type=str, argname='TESTID',
3408
param_name='starting_with', short_name='s',
3410
'Load only the tests starting with TESTID.'),
3412
encoding_type = 'replace'
3415
Command.__init__(self)
3416
self.additional_selftest_args = {}
3418
def run(self, testspecs_list=None, verbose=False, one=False,
3419
transport=None, benchmark=None,
3420
lsprof_timed=None, cache_dir=None,
3421
first=False, list_only=False,
3422
randomize=None, exclude=None, strict=False,
3423
load_list=None, debugflag=None, starting_with=None, subunit=False,
3425
from bzrlib.tests import selftest
3426
import bzrlib.benchmarks as benchmarks
3427
from bzrlib.benchmarks import tree_creator
3429
# Make deprecation warnings visible, unless -Werror is set
3430
symbol_versioning.activate_deprecation_warnings(override=False)
3432
if cache_dir is not None:
3433
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3434
if testspecs_list is not None:
3435
pattern = '|'.join(testspecs_list)
3440
from bzrlib.tests import SubUnitBzrRunner
3442
raise errors.BzrCommandError("subunit not available. subunit "
3443
"needs to be installed to use --subunit.")
3444
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3446
self.additional_selftest_args.setdefault(
3447
'suite_decorators', []).append(parallel)
3449
test_suite_factory = benchmarks.test_suite
3450
# Unless user explicitly asks for quiet, be verbose in benchmarks
3451
verbose = not is_quiet()
3452
# TODO: should possibly lock the history file...
3453
benchfile = open(".perf_history", "at", buffering=1)
3455
test_suite_factory = None
3458
selftest_kwargs = {"verbose": verbose,
3460
"stop_on_failure": one,
3461
"transport": transport,
3462
"test_suite_factory": test_suite_factory,
3463
"lsprof_timed": lsprof_timed,
3464
"bench_history": benchfile,
3465
"matching_tests_first": first,
3466
"list_only": list_only,
3467
"random_seed": randomize,
3468
"exclude_pattern": exclude,
3470
"load_list": load_list,
3471
"debug_flags": debugflag,
3472
"starting_with": starting_with
3474
selftest_kwargs.update(self.additional_selftest_args)
3475
result = selftest(**selftest_kwargs)
3477
if benchfile is not None:
3479
return int(not result)
3482
class cmd_version(Command):
3483
"""Show version of bzr."""
3485
encoding_type = 'replace'
3487
Option("short", help="Print just the version number."),
3491
def run(self, short=False):
3492
from bzrlib.version import show_version
3494
self.outf.write(bzrlib.version_string + '\n')
3496
show_version(to_file=self.outf)
3499
class cmd_rocks(Command):
3500
"""Statement of optimism."""
3506
print "It sure does!"
3509
class cmd_find_merge_base(Command):
3510
"""Find and print a base revision for merging two branches."""
3511
# TODO: Options to specify revisions on either side, as if
3512
# merging only part of the history.
3513
takes_args = ['branch', 'other']
3517
def run(self, branch, other):
3518
from bzrlib.revision import ensure_null
3520
branch1 = Branch.open_containing(branch)[0]
3521
branch2 = Branch.open_containing(other)[0]
3526
last1 = ensure_null(branch1.last_revision())
3527
last2 = ensure_null(branch2.last_revision())
3529
graph = branch1.repository.get_graph(branch2.repository)
3530
base_rev_id = graph.find_unique_lca(last1, last2)
3532
print 'merge base is revision %s' % base_rev_id
3539
class cmd_merge(Command):
3540
"""Perform a three-way merge.
3542
The source of the merge can be specified either in the form of a branch,
3543
or in the form of a path to a file containing a merge directive generated
3544
with bzr send. If neither is specified, the default is the upstream branch
3545
or the branch most recently merged using --remember.
3547
When merging a branch, by default the tip will be merged. To pick a different
3548
revision, pass --revision. If you specify two values, the first will be used as
3549
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3550
available revisions, like this is commonly referred to as "cherrypicking".
3552
Revision numbers are always relative to the branch being merged.
3554
By default, bzr will try to merge in all new work from the other
3555
branch, automatically determining an appropriate base. If this
3556
fails, you may need to give an explicit base.
3558
Merge will do its best to combine the changes in two branches, but there
3559
are some kinds of problems only a human can fix. When it encounters those,
3560
it will mark a conflict. A conflict means that you need to fix something,
3561
before you should commit.
3563
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3565
If there is no default branch set, the first merge will set it. After
3566
that, you can omit the branch to use the default. To change the
3567
default, use --remember. The value will only be saved if the remote
3568
location can be accessed.
3570
The results of the merge are placed into the destination working
3571
directory, where they can be reviewed (with bzr diff), tested, and then
3572
committed to record the result of the merge.
3574
merge refuses to run if there are any uncommitted changes, unless
3578
To merge the latest revision from bzr.dev::
3580
bzr merge ../bzr.dev
3582
To merge changes up to and including revision 82 from bzr.dev::
3584
bzr merge -r 82 ../bzr.dev
3586
To merge the changes introduced by 82, without previous changes::
3588
bzr merge -r 81..82 ../bzr.dev
3590
To apply a merge directive contained in /tmp/merge:
3592
bzr merge /tmp/merge
3595
encoding_type = 'exact'
3596
_see_also = ['update', 'remerge', 'status-flags', 'send']
3597
takes_args = ['location?']
3602
help='Merge even if the destination tree has uncommitted changes.'),
3606
Option('show-base', help="Show base revision text in "
3608
Option('uncommitted', help='Apply uncommitted changes'
3609
' from a working copy, instead of branch changes.'),
3610
Option('pull', help='If the destination is already'
3611
' completely merged into the source, pull from the'
3612
' source rather than merging. When this happens,'
3613
' you do not need to commit the result.'),
3615
help='Branch to merge into, '
3616
'rather than the one containing the working directory.',
3620
Option('preview', help='Instead of merging, show a diff of the merge.')
3623
def run(self, location=None, revision=None, force=False,
3624
merge_type=None, show_base=False, reprocess=None, remember=False,
3625
uncommitted=False, pull=False,
3629
if merge_type is None:
3630
merge_type = _mod_merge.Merge3Merger
3632
if directory is None: directory = u'.'
3633
possible_transports = []
3635
allow_pending = True
3636
verified = 'inapplicable'
3637
tree = WorkingTree.open_containing(directory)[0]
3639
# die as quickly as possible if there are uncommitted changes
3641
basis_tree = tree.revision_tree(tree.last_revision())
3642
except errors.NoSuchRevision:
3643
basis_tree = tree.basis_tree()
3645
changes = tree.changes_from(basis_tree)
3646
if changes.has_changed():
3647
raise errors.UncommittedChanges(tree)
3649
view_info = _get_view_info_for_change_reporter(tree)
3650
change_reporter = delta._ChangeReporter(
3651
unversioned_filter=tree.is_ignored, view_info=view_info)
3654
pb = ui.ui_factory.nested_progress_bar()
3655
cleanups.append(pb.finished)
3657
cleanups.append(tree.unlock)
3658
if location is not None:
3660
mergeable = bundle.read_mergeable_from_url(location,
3661
possible_transports=possible_transports)
3662
except errors.NotABundle:
3666
raise errors.BzrCommandError('Cannot use --uncommitted'
3667
' with bundles or merge directives.')
3669
if revision is not None:
3670
raise errors.BzrCommandError(
3671
'Cannot use -r with merge directives or bundles')
3672
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3675
if merger is None and uncommitted:
3676
if revision is not None and len(revision) > 0:
3677
raise errors.BzrCommandError('Cannot use --uncommitted and'
3678
' --revision at the same time.')
3679
merger = self.get_merger_from_uncommitted(tree, location, pb,
3681
allow_pending = False
3684
merger, allow_pending = self._get_merger_from_branch(tree,
3685
location, revision, remember, possible_transports, pb)
3687
merger.merge_type = merge_type
3688
merger.reprocess = reprocess
3689
merger.show_base = show_base
3690
self.sanity_check_merger(merger)
3691
if (merger.base_rev_id == merger.other_rev_id and
3692
merger.other_rev_id is not None):
3693
note('Nothing to do.')
3696
if merger.interesting_files is not None:
3697
raise errors.BzrCommandError('Cannot pull individual files')
3698
if (merger.base_rev_id == tree.last_revision()):
3699
result = tree.pull(merger.other_branch, False,
3700
merger.other_rev_id)
3701
result.report(self.outf)
3703
merger.check_basis(False)
3705
return self._do_preview(merger)
3707
return self._do_merge(merger, change_reporter, allow_pending,
3710
for cleanup in reversed(cleanups):
3713
def _do_preview(self, merger):
3714
from bzrlib.diff import show_diff_trees
3715
tree_merger = merger.make_merger()
3716
tt = tree_merger.make_preview_transform()
3718
result_tree = tt.get_preview_tree()
3719
show_diff_trees(merger.this_tree, result_tree, self.outf,
3720
old_label='', new_label='')
3724
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3725
merger.change_reporter = change_reporter
3726
conflict_count = merger.do_merge()
3728
merger.set_pending()
3729
if verified == 'failed':
3730
warning('Preview patch does not match changes')
3731
if conflict_count != 0:
3736
def sanity_check_merger(self, merger):
3737
if (merger.show_base and
3738
not merger.merge_type is _mod_merge.Merge3Merger):
3739
raise errors.BzrCommandError("Show-base is not supported for this"
3740
" merge type. %s" % merger.merge_type)
3741
if merger.reprocess is None:
3742
if merger.show_base:
3743
merger.reprocess = False
3745
# Use reprocess if the merger supports it
3746
merger.reprocess = merger.merge_type.supports_reprocess
3747
if merger.reprocess and not merger.merge_type.supports_reprocess:
3748
raise errors.BzrCommandError("Conflict reduction is not supported"
3749
" for merge type %s." %
3751
if merger.reprocess and merger.show_base:
3752
raise errors.BzrCommandError("Cannot do conflict reduction and"
3755
def _get_merger_from_branch(self, tree, location, revision, remember,
3756
possible_transports, pb):
3757
"""Produce a merger from a location, assuming it refers to a branch."""
3758
from bzrlib.tag import _merge_tags_if_possible
3759
# find the branch locations
3760
other_loc, user_location = self._select_branch_location(tree, location,
3762
if revision is not None and len(revision) == 2:
3763
base_loc, _unused = self._select_branch_location(tree,
3764
location, revision, 0)
3766
base_loc = other_loc
3768
other_branch, other_path = Branch.open_containing(other_loc,
3769
possible_transports)
3770
if base_loc == other_loc:
3771
base_branch = other_branch
3773
base_branch, base_path = Branch.open_containing(base_loc,
3774
possible_transports)
3775
# Find the revision ids
3776
if revision is None or len(revision) < 1 or revision[-1] is None:
3777
other_revision_id = _mod_revision.ensure_null(
3778
other_branch.last_revision())
3780
other_revision_id = revision[-1].as_revision_id(other_branch)
3781
if (revision is not None and len(revision) == 2
3782
and revision[0] is not None):
3783
base_revision_id = revision[0].as_revision_id(base_branch)
3785
base_revision_id = None
3786
# Remember where we merge from
3787
if ((remember or tree.branch.get_submit_branch() is None) and
3788
user_location is not None):
3789
tree.branch.set_submit_branch(other_branch.base)
3790
_merge_tags_if_possible(other_branch, tree.branch)
3791
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3792
other_revision_id, base_revision_id, other_branch, base_branch)
3793
if other_path != '':
3794
allow_pending = False
3795
merger.interesting_files = [other_path]
3797
allow_pending = True
3798
return merger, allow_pending
3800
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3801
"""Get a merger for uncommitted changes.
3803
:param tree: The tree the merger should apply to.
3804
:param location: The location containing uncommitted changes.
3805
:param pb: The progress bar to use for showing progress.
3806
:param cleanups: A list of operations to perform to clean up the
3807
temporary directories, unfinalized objects, etc.
3809
location = self._select_branch_location(tree, location)[0]
3810
other_tree, other_path = WorkingTree.open_containing(location)
3811
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3812
if other_path != '':
3813
merger.interesting_files = [other_path]
3816
def _select_branch_location(self, tree, user_location, revision=None,
3818
"""Select a branch location, according to possible inputs.
3820
If provided, branches from ``revision`` are preferred. (Both
3821
``revision`` and ``index`` must be supplied.)
3823
Otherwise, the ``location`` parameter is used. If it is None, then the
3824
``submit`` or ``parent`` location is used, and a note is printed.
3826
:param tree: The working tree to select a branch for merging into
3827
:param location: The location entered by the user
3828
:param revision: The revision parameter to the command
3829
:param index: The index to use for the revision parameter. Negative
3830
indices are permitted.
3831
:return: (selected_location, user_location). The default location
3832
will be the user-entered location.
3834
if (revision is not None and index is not None
3835
and revision[index] is not None):
3836
branch = revision[index].get_branch()
3837
if branch is not None:
3838
return branch, branch
3839
if user_location is None:
3840
location = self._get_remembered(tree, 'Merging from')
3842
location = user_location
3843
return location, user_location
3845
def _get_remembered(self, tree, verb_string):
3846
"""Use tree.branch's parent if none was supplied.
3848
Report if the remembered location was used.
3850
stored_location = tree.branch.get_submit_branch()
3851
stored_location_type = "submit"
3852
if stored_location is None:
3853
stored_location = tree.branch.get_parent()
3854
stored_location_type = "parent"
3855
mutter("%s", stored_location)
3856
if stored_location is None:
3857
raise errors.BzrCommandError("No location specified or remembered")
3858
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3859
note(u"%s remembered %s location %s", verb_string,
3860
stored_location_type, display_url)
3861
return stored_location
3864
class cmd_remerge(Command):
3867
Use this if you want to try a different merge technique while resolving
3868
conflicts. Some merge techniques are better than others, and remerge
3869
lets you try different ones on different files.
3871
The options for remerge have the same meaning and defaults as the ones for
3872
merge. The difference is that remerge can (only) be run when there is a
3873
pending merge, and it lets you specify particular files.
3876
Re-do the merge of all conflicted files, and show the base text in
3877
conflict regions, in addition to the usual THIS and OTHER texts::
3879
bzr remerge --show-base
3881
Re-do the merge of "foobar", using the weave merge algorithm, with
3882
additional processing to reduce the size of conflict regions::
3884
bzr remerge --merge-type weave --reprocess foobar
3886
takes_args = ['file*']
3891
help="Show base revision text in conflicts."),
3894
def run(self, file_list=None, merge_type=None, show_base=False,
3896
if merge_type is None:
3897
merge_type = _mod_merge.Merge3Merger
3898
tree, file_list = tree_files(file_list)
3901
parents = tree.get_parent_ids()
3902
if len(parents) != 2:
3903
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3904
" merges. Not cherrypicking or"
3906
repository = tree.branch.repository
3907
interesting_ids = None
3909
conflicts = tree.conflicts()
3910
if file_list is not None:
3911
interesting_ids = set()
3912
for filename in file_list:
3913
file_id = tree.path2id(filename)
3915
raise errors.NotVersionedError(filename)
3916
interesting_ids.add(file_id)
3917
if tree.kind(file_id) != "directory":
3920
for name, ie in tree.inventory.iter_entries(file_id):
3921
interesting_ids.add(ie.file_id)
3922
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3924
# Remerge only supports resolving contents conflicts
3925
allowed_conflicts = ('text conflict', 'contents conflict')
3926
restore_files = [c.path for c in conflicts
3927
if c.typestring in allowed_conflicts]
3928
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3929
tree.set_conflicts(ConflictList(new_conflicts))
3930
if file_list is not None:
3931
restore_files = file_list
3932
for filename in restore_files:
3934
restore(tree.abspath(filename))
3935
except errors.NotConflicted:
3937
# Disable pending merges, because the file texts we are remerging
3938
# have not had those merges performed. If we use the wrong parents
3939
# list, we imply that the working tree text has seen and rejected
3940
# all the changes from the other tree, when in fact those changes
3941
# have not yet been seen.
3942
pb = ui.ui_factory.nested_progress_bar()
3943
tree.set_parent_ids(parents[:1])
3945
merger = _mod_merge.Merger.from_revision_ids(pb,
3947
merger.interesting_ids = interesting_ids
3948
merger.merge_type = merge_type
3949
merger.show_base = show_base
3950
merger.reprocess = reprocess
3951
conflicts = merger.do_merge()
3953
tree.set_parent_ids(parents)
3963
class cmd_revert(Command):
3964
"""Revert files to a previous revision.
3966
Giving a list of files will revert only those files. Otherwise, all files
3967
will be reverted. If the revision is not specified with '--revision', the
3968
last committed revision is used.
3970
To remove only some changes, without reverting to a prior version, use
3971
merge instead. For example, "merge . --revision -2..-3" will remove the
3972
changes introduced by -2, without affecting the changes introduced by -1.
3973
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3975
By default, any files that have been manually changed will be backed up
3976
first. (Files changed only by merge are not backed up.) Backup files have
3977
'.~#~' appended to their name, where # is a number.
3979
When you provide files, you can use their current pathname or the pathname
3980
from the target revision. So you can use revert to "undelete" a file by
3981
name. If you name a directory, all the contents of that directory will be
3984
Any files that have been newly added since that revision will be deleted,
3985
with a backup kept if appropriate. Directories containing unknown files
3986
will not be deleted.
3988
The working tree contains a list of pending merged revisions, which will
3989
be included as parents in the next commit. Normally, revert clears that
3990
list as well as reverting the files. If any files are specified, revert
3991
leaves the pending merge list alone and reverts only the files. Use "bzr
3992
revert ." in the tree root to revert all files but keep the merge record,
3993
and "bzr revert --forget-merges" to clear the pending merge list without
3994
reverting any files.
3997
_see_also = ['cat', 'export']
4000
Option('no-backup', "Do not save backups of reverted files."),
4001
Option('forget-merges',
4002
'Remove pending merge marker, without changing any files.'),
4004
takes_args = ['file*']
4006
def run(self, revision=None, no_backup=False, file_list=None,
4007
forget_merges=None):
4008
tree, file_list = tree_files(file_list)
4012
tree.set_parent_ids(tree.get_parent_ids()[:1])
4014
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4019
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4020
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4021
pb = ui.ui_factory.nested_progress_bar()
4023
tree.revert(file_list, rev_tree, not no_backup, pb,
4024
report_changes=True)
4029
class cmd_assert_fail(Command):
4030
"""Test reporting of assertion failures"""
4031
# intended just for use in testing
4036
raise AssertionError("always fails")
4039
class cmd_help(Command):
4040
"""Show help on a command or other topic.
4043
_see_also = ['topics']
4045
Option('long', 'Show help on all commands.'),
4047
takes_args = ['topic?']
4048
aliases = ['?', '--help', '-?', '-h']
4051
def run(self, topic=None, long=False):
4053
if topic is None and long:
4055
bzrlib.help.help(topic)
4058
class cmd_shell_complete(Command):
4059
"""Show appropriate completions for context.
4061
For a list of all available commands, say 'bzr shell-complete'.
4063
takes_args = ['context?']
4068
def run(self, context=None):
4069
import shellcomplete
4070
shellcomplete.shellcomplete(context)
4073
class cmd_missing(Command):
4074
"""Show unmerged/unpulled revisions between two branches.
4076
OTHER_BRANCH may be local or remote.
4078
To filter on a range of revisions, you can use the command -r begin..end
4079
-r revision requests a specific revision, -r ..end or -r begin.. are
4084
Determine the missing revisions between this and the branch at the
4085
remembered pull location::
4089
Determine the missing revisions between this and another branch::
4091
bzr missing http://server/branch
4093
Determine the missing revisions up to a specific revision on the other
4096
bzr missing -r ..-10
4098
Determine the missing revisions up to a specific revision on this
4101
bzr missing --my-revision ..-10
4104
_see_also = ['merge', 'pull']
4105
takes_args = ['other_branch?']
4107
Option('reverse', 'Reverse the order of revisions.'),
4109
'Display changes in the local branch only.'),
4110
Option('this' , 'Same as --mine-only.'),
4111
Option('theirs-only',
4112
'Display changes in the remote branch only.'),
4113
Option('other', 'Same as --theirs-only.'),
4117
custom_help('revision',
4118
help='Filter on other branch revisions (inclusive). '
4119
'See "help revisionspec" for details.'),
4120
Option('my-revision',
4121
type=_parse_revision_str,
4122
help='Filter on local branch revisions (inclusive). '
4123
'See "help revisionspec" for details.'),
4124
Option('include-merges',
4125
'Show all revisions in addition to the mainline ones.'),
4127
encoding_type = 'replace'
4130
def run(self, other_branch=None, reverse=False, mine_only=False,
4132
log_format=None, long=False, short=False, line=False,
4133
show_ids=False, verbose=False, this=False, other=False,
4134
include_merges=False, revision=None, my_revision=None):
4135
from bzrlib.missing import find_unmerged, iter_log_revisions
4144
# TODO: We should probably check that we don't have mine-only and
4145
# theirs-only set, but it gets complicated because we also have
4146
# this and other which could be used.
4153
local_branch = Branch.open_containing(u".")[0]
4154
parent = local_branch.get_parent()
4155
if other_branch is None:
4156
other_branch = parent
4157
if other_branch is None:
4158
raise errors.BzrCommandError("No peer location known"
4160
display_url = urlutils.unescape_for_display(parent,
4162
message("Using saved parent location: "
4163
+ display_url + "\n")
4165
remote_branch = Branch.open(other_branch)
4166
if remote_branch.base == local_branch.base:
4167
remote_branch = local_branch
4169
local_revid_range = _revision_range_to_revid_range(
4170
_get_revision_range(my_revision, local_branch,
4173
remote_revid_range = _revision_range_to_revid_range(
4174
_get_revision_range(revision,
4175
remote_branch, self.name()))
4177
local_branch.lock_read()
4179
remote_branch.lock_read()
4181
local_extra, remote_extra = find_unmerged(
4182
local_branch, remote_branch, restrict,
4183
backward=not reverse,
4184
include_merges=include_merges,
4185
local_revid_range=local_revid_range,
4186
remote_revid_range=remote_revid_range)
4188
if log_format is None:
4189
registry = log.log_formatter_registry
4190
log_format = registry.get_default(local_branch)
4191
lf = log_format(to_file=self.outf,
4193
show_timezone='original')
4196
if local_extra and not theirs_only:
4197
message("You have %d extra revision(s):\n" %
4199
for revision in iter_log_revisions(local_extra,
4200
local_branch.repository,
4202
lf.log_revision(revision)
4203
printed_local = True
4206
printed_local = False
4208
if remote_extra and not mine_only:
4209
if printed_local is True:
4211
message("You are missing %d revision(s):\n" %
4213
for revision in iter_log_revisions(remote_extra,
4214
remote_branch.repository,
4216
lf.log_revision(revision)
4219
if mine_only and not local_extra:
4220
# We checked local, and found nothing extra
4221
message('This branch is up to date.\n')
4222
elif theirs_only and not remote_extra:
4223
# We checked remote, and found nothing extra
4224
message('Other branch is up to date.\n')
4225
elif not (mine_only or theirs_only or local_extra or
4227
# We checked both branches, and neither one had extra
4229
message("Branches are up to date.\n")
4231
remote_branch.unlock()
4233
local_branch.unlock()
4234
if not status_code and parent is None and other_branch is not None:
4235
local_branch.lock_write()
4237
# handle race conditions - a parent might be set while we run.
4238
if local_branch.get_parent() is None:
4239
local_branch.set_parent(remote_branch.base)
4241
local_branch.unlock()
4245
class cmd_pack(Command):
4246
"""Compress the data within a repository."""
4248
_see_also = ['repositories']
4249
takes_args = ['branch_or_repo?']
4251
def run(self, branch_or_repo='.'):
4252
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4254
branch = dir.open_branch()
4255
repository = branch.repository
4256
except errors.NotBranchError:
4257
repository = dir.open_repository()
4261
class cmd_plugins(Command):
4262
"""List the installed plugins.
4264
This command displays the list of installed plugins including
4265
version of plugin and a short description of each.
4267
--verbose shows the path where each plugin is located.
4269
A plugin is an external component for Bazaar that extends the
4270
revision control system, by adding or replacing code in Bazaar.
4271
Plugins can do a variety of things, including overriding commands,
4272
adding new commands, providing additional network transports and
4273
customizing log output.
4275
See the Bazaar web site, http://bazaar-vcs.org, for further
4276
information on plugins including where to find them and how to
4277
install them. Instructions are also provided there on how to
4278
write new plugins using the Python programming language.
4280
takes_options = ['verbose']
4283
def run(self, verbose=False):
4284
import bzrlib.plugin
4285
from inspect import getdoc
4287
for name, plugin in bzrlib.plugin.plugins().items():
4288
version = plugin.__version__
4289
if version == 'unknown':
4291
name_ver = '%s %s' % (name, version)
4292
d = getdoc(plugin.module)
4294
doc = d.split('\n')[0]
4296
doc = '(no description)'
4297
result.append((name_ver, doc, plugin.path()))
4298
for name_ver, doc, path in sorted(result):
4306
class cmd_testament(Command):
4307
"""Show testament (signing-form) of a revision."""
4310
Option('long', help='Produce long-format testament.'),
4312
help='Produce a strict-format testament.')]
4313
takes_args = ['branch?']
4315
def run(self, branch=u'.', revision=None, long=False, strict=False):
4316
from bzrlib.testament import Testament, StrictTestament
4318
testament_class = StrictTestament
4320
testament_class = Testament
4322
b = Branch.open_containing(branch)[0]
4324
b = Branch.open(branch)
4327
if revision is None:
4328
rev_id = b.last_revision()
4330
rev_id = revision[0].as_revision_id(b)
4331
t = testament_class.from_revision(b.repository, rev_id)
4333
sys.stdout.writelines(t.as_text_lines())
4335
sys.stdout.write(t.as_short_text())
4340
class cmd_annotate(Command):
4341
"""Show the origin of each line in a file.
4343
This prints out the given file with an annotation on the left side
4344
indicating which revision, author and date introduced the change.
4346
If the origin is the same for a run of consecutive lines, it is
4347
shown only at the top, unless the --all option is given.
4349
# TODO: annotate directories; showing when each file was last changed
4350
# TODO: if the working copy is modified, show annotations on that
4351
# with new uncommitted lines marked
4352
aliases = ['ann', 'blame', 'praise']
4353
takes_args = ['filename']
4354
takes_options = [Option('all', help='Show annotations on all lines.'),
4355
Option('long', help='Show commit date in annotations.'),
4359
encoding_type = 'exact'
4362
def run(self, filename, all=False, long=False, revision=None,
4364
from bzrlib.annotate import annotate_file, annotate_file_tree
4365
wt, branch, relpath = \
4366
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4372
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4374
file_id = wt.path2id(relpath)
4376
file_id = tree.path2id(relpath)
4378
raise errors.NotVersionedError(filename)
4379
file_version = tree.inventory[file_id].revision
4380
if wt is not None and revision is None:
4381
# If there is a tree and we're not annotating historical
4382
# versions, annotate the working tree's content.
4383
annotate_file_tree(wt, file_id, self.outf, long, all,
4386
annotate_file(branch, file_version, file_id, long, all, self.outf,
4395
class cmd_re_sign(Command):
4396
"""Create a digital signature for an existing revision."""
4397
# TODO be able to replace existing ones.
4399
hidden = True # is this right ?
4400
takes_args = ['revision_id*']
4401
takes_options = ['revision']
4403
def run(self, revision_id_list=None, revision=None):
4404
if revision_id_list is not None and revision is not None:
4405
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4406
if revision_id_list is None and revision is None:
4407
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4408
b = WorkingTree.open_containing(u'.')[0].branch
4411
return self._run(b, revision_id_list, revision)
4415
def _run(self, b, revision_id_list, revision):
4416
import bzrlib.gpg as gpg
4417
gpg_strategy = gpg.GPGStrategy(b.get_config())
4418
if revision_id_list is not None:
4419
b.repository.start_write_group()
4421
for revision_id in revision_id_list:
4422
b.repository.sign_revision(revision_id, gpg_strategy)
4424
b.repository.abort_write_group()
4427
b.repository.commit_write_group()
4428
elif revision is not None:
4429
if len(revision) == 1:
4430
revno, rev_id = revision[0].in_history(b)
4431
b.repository.start_write_group()
4433
b.repository.sign_revision(rev_id, gpg_strategy)
4435
b.repository.abort_write_group()
4438
b.repository.commit_write_group()
4439
elif len(revision) == 2:
4440
# are they both on rh- if so we can walk between them
4441
# might be nice to have a range helper for arbitrary
4442
# revision paths. hmm.
4443
from_revno, from_revid = revision[0].in_history(b)
4444
to_revno, to_revid = revision[1].in_history(b)
4445
if to_revid is None:
4446
to_revno = b.revno()
4447
if from_revno is None or to_revno is None:
4448
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4449
b.repository.start_write_group()
4451
for revno in range(from_revno, to_revno + 1):
4452
b.repository.sign_revision(b.get_rev_id(revno),
4455
b.repository.abort_write_group()
4458
b.repository.commit_write_group()
4460
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4463
class cmd_bind(Command):
4464
"""Convert the current branch into a checkout of the supplied branch.
4466
Once converted into a checkout, commits must succeed on the master branch
4467
before they will be applied to the local branch.
4469
Bound branches use the nickname of its master branch unless it is set
4470
locally, in which case binding will update the the local nickname to be
4474
_see_also = ['checkouts', 'unbind']
4475
takes_args = ['location?']
4478
def run(self, location=None):
4479
b, relpath = Branch.open_containing(u'.')
4480
if location is None:
4482
location = b.get_old_bound_location()
4483
except errors.UpgradeRequired:
4484
raise errors.BzrCommandError('No location supplied. '
4485
'This format does not remember old locations.')
4487
if location is None:
4488
raise errors.BzrCommandError('No location supplied and no '
4489
'previous location known')
4490
b_other = Branch.open(location)
4493
except errors.DivergedBranches:
4494
raise errors.BzrCommandError('These branches have diverged.'
4495
' Try merging, and then bind again.')
4496
if b.get_config().has_explicit_nickname():
4497
b.nick = b_other.nick
4500
class cmd_unbind(Command):
4501
"""Convert the current checkout into a regular branch.
4503
After unbinding, the local branch is considered independent and subsequent
4504
commits will be local only.
4507
_see_also = ['checkouts', 'bind']
4512
b, relpath = Branch.open_containing(u'.')
4514
raise errors.BzrCommandError('Local branch is not bound')
4517
class cmd_uncommit(Command):
4518
"""Remove the last committed revision.
4520
--verbose will print out what is being removed.
4521
--dry-run will go through all the motions, but not actually
4524
If --revision is specified, uncommit revisions to leave the branch at the
4525
specified revision. For example, "bzr uncommit -r 15" will leave the
4526
branch at revision 15.
4528
Uncommit leaves the working tree ready for a new commit. The only change
4529
it may make is to restore any pending merges that were present before
4533
# TODO: jam 20060108 Add an option to allow uncommit to remove
4534
# unreferenced information in 'branch-as-repository' branches.
4535
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4536
# information in shared branches as well.
4537
_see_also = ['commit']
4538
takes_options = ['verbose', 'revision',
4539
Option('dry-run', help='Don\'t actually make changes.'),
4540
Option('force', help='Say yes to all questions.'),
4542
help="Only remove the commits from the local branch"
4543
" when in a checkout."
4546
takes_args = ['location?']
4548
encoding_type = 'replace'
4550
def run(self, location=None,
4551
dry_run=False, verbose=False,
4552
revision=None, force=False, local=False):
4553
if location is None:
4555
control, relpath = bzrdir.BzrDir.open_containing(location)
4557
tree = control.open_workingtree()
4559
except (errors.NoWorkingTree, errors.NotLocalUrl):
4561
b = control.open_branch()
4563
if tree is not None:
4568
return self._run(b, tree, dry_run, verbose, revision, force,
4571
if tree is not None:
4576
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4577
from bzrlib.log import log_formatter, show_log
4578
from bzrlib.uncommit import uncommit
4580
last_revno, last_rev_id = b.last_revision_info()
4583
if revision is None:
4585
rev_id = last_rev_id
4587
# 'bzr uncommit -r 10' actually means uncommit
4588
# so that the final tree is at revno 10.
4589
# but bzrlib.uncommit.uncommit() actually uncommits
4590
# the revisions that are supplied.
4591
# So we need to offset it by one
4592
revno = revision[0].in_history(b).revno + 1
4593
if revno <= last_revno:
4594
rev_id = b.get_rev_id(revno)
4596
if rev_id is None or _mod_revision.is_null(rev_id):
4597
self.outf.write('No revisions to uncommit.\n')
4600
lf = log_formatter('short',
4602
show_timezone='original')
4607
direction='forward',
4608
start_revision=revno,
4609
end_revision=last_revno)
4612
print 'Dry-run, pretending to remove the above revisions.'
4614
val = raw_input('Press <enter> to continue')
4616
print 'The above revision(s) will be removed.'
4618
val = raw_input('Are you sure [y/N]? ')
4619
if val.lower() not in ('y', 'yes'):
4623
mutter('Uncommitting from {%s} to {%s}',
4624
last_rev_id, rev_id)
4625
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4626
revno=revno, local=local)
4627
note('You can restore the old tip by running:\n'
4628
' bzr pull . -r revid:%s', last_rev_id)
4631
class cmd_break_lock(Command):
4632
"""Break a dead lock on a repository, branch or working directory.
4634
CAUTION: Locks should only be broken when you are sure that the process
4635
holding the lock has been stopped.
4637
You can get information on what locks are open via the 'bzr info' command.
4642
takes_args = ['location?']
4644
def run(self, location=None, show=False):
4645
if location is None:
4647
control, relpath = bzrdir.BzrDir.open_containing(location)
4649
control.break_lock()
4650
except NotImplementedError:
4654
class cmd_wait_until_signalled(Command):
4655
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4657
This just prints a line to signal when it is ready, then blocks on stdin.
4663
sys.stdout.write("running\n")
4665
sys.stdin.readline()
4668
class cmd_serve(Command):
4669
"""Run the bzr server."""
4671
aliases = ['server']
4675
help='Serve on stdin/out for use from inetd or sshd.'),
4676
RegistryOption('protocol',
4677
help="Protocol to serve.",
4678
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4679
value_switches=True),
4681
help='Listen for connections on nominated port of the form '
4682
'[hostname:]portnumber. Passing 0 as the port number will '
4683
'result in a dynamically allocated port. The default port '
4684
'depends on the protocol.',
4687
help='Serve contents of this directory.',
4689
Option('allow-writes',
4690
help='By default the server is a readonly server. Supplying '
4691
'--allow-writes enables write access to the contents of '
4692
'the served directory and below.'
4696
def get_host_and_port(self, port):
4697
"""Return the host and port to run the smart server on.
4699
If 'port' is None, None will be returned for the host and port.
4701
If 'port' has a colon in it, the string before the colon will be
4702
interpreted as the host.
4704
:param port: A string of the port to run the server on.
4705
:return: A tuple of (host, port), where 'host' is a host name or IP,
4706
and port is an integer TCP/IP port.
4709
if port is not None:
4711
host, port = port.split(':')
4715
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4717
from bzrlib.transport import get_transport, transport_server_registry
4718
if directory is None:
4719
directory = os.getcwd()
4720
if protocol is None:
4721
protocol = transport_server_registry.get()
4722
host, port = self.get_host_and_port(port)
4723
url = urlutils.local_path_to_url(directory)
4724
if not allow_writes:
4725
url = 'readonly+' + url
4726
transport = get_transport(url)
4727
protocol(transport, host, port, inet)
4730
class cmd_join(Command):
4731
"""Combine a tree into its containing tree.
4733
This command requires the target tree to be in a rich-root format.
4735
The TREE argument should be an independent tree, inside another tree, but
4736
not part of it. (Such trees can be produced by "bzr split", but also by
4737
running "bzr branch" with the target inside a tree.)
4739
The result is a combined tree, with the subtree no longer an independant
4740
part. This is marked as a merge of the subtree into the containing tree,
4741
and all history is preserved.
4744
_see_also = ['split']
4745
takes_args = ['tree']
4747
Option('reference', help='Join by reference.', hidden=True),
4750
def run(self, tree, reference=False):
4751
sub_tree = WorkingTree.open(tree)
4752
parent_dir = osutils.dirname(sub_tree.basedir)
4753
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4754
repo = containing_tree.branch.repository
4755
if not repo.supports_rich_root():
4756
raise errors.BzrCommandError(
4757
"Can't join trees because %s doesn't support rich root data.\n"
4758
"You can use bzr upgrade on the repository."
4762
containing_tree.add_reference(sub_tree)
4763
except errors.BadReferenceTarget, e:
4764
# XXX: Would be better to just raise a nicely printable
4765
# exception from the real origin. Also below. mbp 20070306
4766
raise errors.BzrCommandError("Cannot join %s. %s" %
4770
containing_tree.subsume(sub_tree)
4771
except errors.BadSubsumeSource, e:
4772
raise errors.BzrCommandError("Cannot join %s. %s" %
4776
class cmd_split(Command):
4777
"""Split a subdirectory of a tree into a separate tree.
4779
This command will produce a target tree in a format that supports
4780
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4781
converted into earlier formats like 'dirstate-tags'.
4783
The TREE argument should be a subdirectory of a working tree. That
4784
subdirectory will be converted into an independent tree, with its own
4785
branch. Commits in the top-level tree will not apply to the new subtree.
4788
_see_also = ['join']
4789
takes_args = ['tree']
4791
def run(self, tree):
4792
containing_tree, subdir = WorkingTree.open_containing(tree)
4793
sub_id = containing_tree.path2id(subdir)
4795
raise errors.NotVersionedError(subdir)
4797
containing_tree.extract(sub_id)
4798
except errors.RootNotRich:
4799
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4802
class cmd_merge_directive(Command):
4803
"""Generate a merge directive for auto-merge tools.
4805
A directive requests a merge to be performed, and also provides all the
4806
information necessary to do so. This means it must either include a
4807
revision bundle, or the location of a branch containing the desired
4810
A submit branch (the location to merge into) must be supplied the first
4811
time the command is issued. After it has been supplied once, it will
4812
be remembered as the default.
4814
A public branch is optional if a revision bundle is supplied, but required
4815
if --diff or --plain is specified. It will be remembered as the default
4816
after the first use.
4819
takes_args = ['submit_branch?', 'public_branch?']
4823
_see_also = ['send']
4826
RegistryOption.from_kwargs('patch-type',
4827
'The type of patch to include in the directive.',
4829
value_switches=True,
4831
bundle='Bazaar revision bundle (default).',
4832
diff='Normal unified diff.',
4833
plain='No patch, just directive.'),
4834
Option('sign', help='GPG-sign the directive.'), 'revision',
4835
Option('mail-to', type=str,
4836
help='Instead of printing the directive, email to this address.'),
4837
Option('message', type=str, short_name='m',
4838
help='Message to use when committing this merge.')
4841
encoding_type = 'exact'
4843
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4844
sign=False, revision=None, mail_to=None, message=None):
4845
from bzrlib.revision import ensure_null, NULL_REVISION
4846
include_patch, include_bundle = {
4847
'plain': (False, False),
4848
'diff': (True, False),
4849
'bundle': (True, True),
4851
branch = Branch.open('.')
4852
stored_submit_branch = branch.get_submit_branch()
4853
if submit_branch is None:
4854
submit_branch = stored_submit_branch
4856
if stored_submit_branch is None:
4857
branch.set_submit_branch(submit_branch)
4858
if submit_branch is None:
4859
submit_branch = branch.get_parent()
4860
if submit_branch is None:
4861
raise errors.BzrCommandError('No submit branch specified or known')
4863
stored_public_branch = branch.get_public_branch()
4864
if public_branch is None:
4865
public_branch = stored_public_branch
4866
elif stored_public_branch is None:
4867
branch.set_public_branch(public_branch)
4868
if not include_bundle and public_branch is None:
4869
raise errors.BzrCommandError('No public branch specified or'
4871
base_revision_id = None
4872
if revision is not None:
4873
if len(revision) > 2:
4874
raise errors.BzrCommandError('bzr merge-directive takes '
4875
'at most two one revision identifiers')
4876
revision_id = revision[-1].as_revision_id(branch)
4877
if len(revision) == 2:
4878
base_revision_id = revision[0].as_revision_id(branch)
4880
revision_id = branch.last_revision()
4881
revision_id = ensure_null(revision_id)
4882
if revision_id == NULL_REVISION:
4883
raise errors.BzrCommandError('No revisions to bundle.')
4884
directive = merge_directive.MergeDirective2.from_objects(
4885
branch.repository, revision_id, time.time(),
4886
osutils.local_time_offset(), submit_branch,
4887
public_branch=public_branch, include_patch=include_patch,
4888
include_bundle=include_bundle, message=message,
4889
base_revision_id=base_revision_id)
4892
self.outf.write(directive.to_signed(branch))
4894
self.outf.writelines(directive.to_lines())
4896
message = directive.to_email(mail_to, branch, sign)
4897
s = SMTPConnection(branch.get_config())
4898
s.send_email(message)
4901
class cmd_send(Command):
4902
"""Mail or create a merge-directive for submitting changes.
4904
A merge directive provides many things needed for requesting merges:
4906
* A machine-readable description of the merge to perform
4908
* An optional patch that is a preview of the changes requested
4910
* An optional bundle of revision data, so that the changes can be applied
4911
directly from the merge directive, without retrieving data from a
4914
If --no-bundle is specified, then public_branch is needed (and must be
4915
up-to-date), so that the receiver can perform the merge using the
4916
public_branch. The public_branch is always included if known, so that
4917
people can check it later.
4919
The submit branch defaults to the parent, but can be overridden. Both
4920
submit branch and public branch will be remembered if supplied.
4922
If a public_branch is known for the submit_branch, that public submit
4923
branch is used in the merge instructions. This means that a local mirror
4924
can be used as your actual submit branch, once you have set public_branch
4927
Mail is sent using your preferred mail program. This should be transparent
4928
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4929
If the preferred client can't be found (or used), your editor will be used.
4931
To use a specific mail program, set the mail_client configuration option.
4932
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4933
specific clients are "claws", "evolution", "kmail", "mutt", and
4934
"thunderbird"; generic options are "default", "editor", "emacsclient",
4935
"mapi", and "xdg-email". Plugins may also add supported clients.
4937
If mail is being sent, a to address is required. This can be supplied
4938
either on the commandline, by setting the submit_to configuration
4939
option in the branch itself or the child_submit_to configuration option
4940
in the submit branch.
4942
Two formats are currently supported: "4" uses revision bundle format 4 and
4943
merge directive format 2. It is significantly faster and smaller than
4944
older formats. It is compatible with Bazaar 0.19 and later. It is the
4945
default. "0.9" uses revision bundle format 0.9 and merge directive
4946
format 1. It is compatible with Bazaar 0.12 - 0.18.
4948
The merge directives created by bzr send may be applied using bzr merge or
4949
bzr pull by specifying a file containing a merge directive as the location.
4952
encoding_type = 'exact'
4954
_see_also = ['merge', 'pull']
4956
takes_args = ['submit_branch?', 'public_branch?']
4960
help='Do not include a bundle in the merge directive.'),
4961
Option('no-patch', help='Do not include a preview patch in the merge'
4964
help='Remember submit and public branch.'),
4966
help='Branch to generate the submission from, '
4967
'rather than the one containing the working directory.',
4970
Option('output', short_name='o',
4971
help='Write merge directive to this file; '
4972
'use - for stdout.',
4975
help='Refuse to send if there are uncommitted changes in'
4976
' the working tree, --no-strict disables the check.'),
4977
Option('mail-to', help='Mail the request to this address.',
4981
Option('body', help='Body for the email.', type=unicode),
4982
RegistryOption('format',
4983
help='Use the specified output format.',
4984
lazy_registry=('bzrlib.send', 'format_registry')),
4987
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4988
no_patch=False, revision=None, remember=False, output=None,
4989
format=None, mail_to=None, message=None, body=None,
4990
strict=None, **kwargs):
4991
from bzrlib.send import send
4992
return send(submit_branch, revision, public_branch, remember,
4993
format, no_bundle, no_patch, output,
4994
kwargs.get('from', '.'), mail_to, message, body,
4999
class cmd_bundle_revisions(cmd_send):
5000
"""Create a merge-directive for submitting changes.
5002
A merge directive provides many things needed for requesting merges:
5004
* A machine-readable description of the merge to perform
5006
* An optional patch that is a preview of the changes requested
5008
* An optional bundle of revision data, so that the changes can be applied
5009
directly from the merge directive, without retrieving data from a
5012
If --no-bundle is specified, then public_branch is needed (and must be
5013
up-to-date), so that the receiver can perform the merge using the
5014
public_branch. The public_branch is always included if known, so that
5015
people can check it later.
5017
The submit branch defaults to the parent, but can be overridden. Both
5018
submit branch and public branch will be remembered if supplied.
5020
If a public_branch is known for the submit_branch, that public submit
5021
branch is used in the merge instructions. This means that a local mirror
5022
can be used as your actual submit branch, once you have set public_branch
5025
Two formats are currently supported: "4" uses revision bundle format 4 and
5026
merge directive format 2. It is significantly faster and smaller than
5027
older formats. It is compatible with Bazaar 0.19 and later. It is the
5028
default. "0.9" uses revision bundle format 0.9 and merge directive
5029
format 1. It is compatible with Bazaar 0.12 - 0.18.
5034
help='Do not include a bundle in the merge directive.'),
5035
Option('no-patch', help='Do not include a preview patch in the merge'
5038
help='Remember submit and public branch.'),
5040
help='Branch to generate the submission from, '
5041
'rather than the one containing the working directory.',
5044
Option('output', short_name='o', help='Write directive to this file.',
5047
help='Refuse to bundle revisions if there are uncommitted'
5048
' changes in the working tree, --no-strict disables the check.'),
5050
RegistryOption('format',
5051
help='Use the specified output format.',
5052
lazy_registry=('bzrlib.send', 'format_registry')),
5054
aliases = ['bundle']
5056
_see_also = ['send', 'merge']
5060
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5061
no_patch=False, revision=None, remember=False, output=None,
5062
format=None, strict=None, **kwargs):
5065
from bzrlib.send import send
5066
return send(submit_branch, revision, public_branch, remember,
5067
format, no_bundle, no_patch, output,
5068
kwargs.get('from', '.'), None, None, None,
5069
self.outf, strict=strict)
5072
class cmd_tag(Command):
5073
"""Create, remove or modify a tag naming a revision.
5075
Tags give human-meaningful names to revisions. Commands that take a -r
5076
(--revision) option can be given -rtag:X, where X is any previously
5079
Tags are stored in the branch. Tags are copied from one branch to another
5080
along when you branch, push, pull or merge.
5082
It is an error to give a tag name that already exists unless you pass
5083
--force, in which case the tag is moved to point to the new revision.
5085
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5086
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5089
_see_also = ['commit', 'tags']
5090
takes_args = ['tag_name']
5093
help='Delete this tag rather than placing it.',
5096
help='Branch in which to place the tag.',
5101
help='Replace existing tags.',
5106
def run(self, tag_name,
5112
branch, relpath = Branch.open_containing(directory)
5116
branch.tags.delete_tag(tag_name)
5117
self.outf.write('Deleted tag %s.\n' % tag_name)
5120
if len(revision) != 1:
5121
raise errors.BzrCommandError(
5122
"Tags can only be placed on a single revision, "
5124
revision_id = revision[0].as_revision_id(branch)
5126
revision_id = branch.last_revision()
5127
if (not force) and branch.tags.has_tag(tag_name):
5128
raise errors.TagAlreadyExists(tag_name)
5129
branch.tags.set_tag(tag_name, revision_id)
5130
self.outf.write('Created tag %s.\n' % tag_name)
5135
class cmd_tags(Command):
5138
This command shows a table of tag names and the revisions they reference.
5144
help='Branch whose tags should be displayed.',
5148
RegistryOption.from_kwargs('sort',
5149
'Sort tags by different criteria.', title='Sorting',
5150
alpha='Sort tags lexicographically (default).',
5151
time='Sort tags chronologically.',
5164
branch, relpath = Branch.open_containing(directory)
5166
tags = branch.tags.get_tag_dict().items()
5173
graph = branch.repository.get_graph()
5174
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5175
revid1, revid2 = rev1.rev_id, rev2.rev_id
5176
# only show revisions between revid1 and revid2 (inclusive)
5177
tags = [(tag, revid) for tag, revid in tags if
5178
graph.is_between(revid, revid1, revid2)]
5181
elif sort == 'time':
5183
for tag, revid in tags:
5185
revobj = branch.repository.get_revision(revid)
5186
except errors.NoSuchRevision:
5187
timestamp = sys.maxint # place them at the end
5189
timestamp = revobj.timestamp
5190
timestamps[revid] = timestamp
5191
tags.sort(key=lambda x: timestamps[x[1]])
5193
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5194
for index, (tag, revid) in enumerate(tags):
5196
revno = branch.revision_id_to_dotted_revno(revid)
5197
if isinstance(revno, tuple):
5198
revno = '.'.join(map(str, revno))
5199
except errors.NoSuchRevision:
5200
# Bad tag data/merges can lead to tagged revisions
5201
# which are not in this branch. Fail gracefully ...
5203
tags[index] = (tag, revno)
5206
for tag, revspec in tags:
5207
self.outf.write('%-20s %s\n' % (tag, revspec))
5210
class cmd_reconfigure(Command):
5211
"""Reconfigure the type of a bzr directory.
5213
A target configuration must be specified.
5215
For checkouts, the bind-to location will be auto-detected if not specified.
5216
The order of preference is
5217
1. For a lightweight checkout, the current bound location.
5218
2. For branches that used to be checkouts, the previously-bound location.
5219
3. The push location.
5220
4. The parent location.
5221
If none of these is available, --bind-to must be specified.
5224
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5225
takes_args = ['location?']
5227
RegistryOption.from_kwargs(
5229
title='Target type',
5230
help='The type to reconfigure the directory to.',
5231
value_switches=True, enum_switch=False,
5232
branch='Reconfigure to be an unbound branch with no working tree.',
5233
tree='Reconfigure to be an unbound branch with a working tree.',
5234
checkout='Reconfigure to be a bound branch with a working tree.',
5235
lightweight_checkout='Reconfigure to be a lightweight'
5236
' checkout (with no local history).',
5237
standalone='Reconfigure to be a standalone branch '
5238
'(i.e. stop using shared repository).',
5239
use_shared='Reconfigure to use a shared repository.',
5240
with_trees='Reconfigure repository to create '
5241
'working trees on branches by default.',
5242
with_no_trees='Reconfigure repository to not create '
5243
'working trees on branches by default.'
5245
Option('bind-to', help='Branch to bind checkout to.', type=str),
5247
help='Perform reconfiguration even if local changes'
5251
def run(self, location=None, target_type=None, bind_to=None, force=False):
5252
directory = bzrdir.BzrDir.open(location)
5253
if target_type is None:
5254
raise errors.BzrCommandError('No target configuration specified')
5255
elif target_type == 'branch':
5256
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5257
elif target_type == 'tree':
5258
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5259
elif target_type == 'checkout':
5260
reconfiguration = reconfigure.Reconfigure.to_checkout(
5262
elif target_type == 'lightweight-checkout':
5263
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5265
elif target_type == 'use-shared':
5266
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5267
elif target_type == 'standalone':
5268
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5269
elif target_type == 'with-trees':
5270
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5272
elif target_type == 'with-no-trees':
5273
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5275
reconfiguration.apply(force)
5278
class cmd_switch(Command):
5279
"""Set the branch of a checkout and update.
5281
For lightweight checkouts, this changes the branch being referenced.
5282
For heavyweight checkouts, this checks that there are no local commits
5283
versus the current bound branch, then it makes the local branch a mirror
5284
of the new location and binds to it.
5286
In both cases, the working tree is updated and uncommitted changes
5287
are merged. The user can commit or revert these as they desire.
5289
Pending merges need to be committed or reverted before using switch.
5291
The path to the branch to switch to can be specified relative to the parent
5292
directory of the current branch. For example, if you are currently in a
5293
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5296
Bound branches use the nickname of its master branch unless it is set
5297
locally, in which case switching will update the the local nickname to be
5301
takes_args = ['to_location']
5302
takes_options = [Option('force',
5303
help='Switch even if local commits will be lost.')
5306
def run(self, to_location, force=False):
5307
from bzrlib import switch
5309
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5311
branch = control_dir.open_branch()
5312
had_explicit_nick = branch.get_config().has_explicit_nickname()
5313
except errors.NotBranchError:
5314
had_explicit_nick = False
5316
to_branch = Branch.open(to_location)
5317
except errors.NotBranchError:
5318
this_url = self._get_branch_location(control_dir)
5319
to_branch = Branch.open(
5320
urlutils.join(this_url, '..', to_location))
5321
switch.switch(control_dir, to_branch, force)
5322
if had_explicit_nick:
5323
branch = control_dir.open_branch() #get the new branch!
5324
branch.nick = to_branch.nick
5325
note('Switched to branch: %s',
5326
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5328
def _get_branch_location(self, control_dir):
5329
"""Return location of branch for this control dir."""
5331
this_branch = control_dir.open_branch()
5332
# This may be a heavy checkout, where we want the master branch
5333
master_location = this_branch.get_bound_location()
5334
if master_location is not None:
5335
return master_location
5336
# If not, use a local sibling
5337
return this_branch.base
5338
except errors.NotBranchError:
5339
format = control_dir.find_branch_format()
5340
if getattr(format, 'get_reference', None) is not None:
5341
return format.get_reference(control_dir)
5343
return control_dir.root_transport.base
5346
class cmd_view(Command):
5347
"""Manage filtered views.
5349
Views provide a mask over the tree so that users can focus on
5350
a subset of a tree when doing their work. After creating a view,
5351
commands that support a list of files - status, diff, commit, etc -
5352
effectively have that list of files implicitly given each time.
5353
An explicit list of files can still be given but those files
5354
must be within the current view.
5356
In most cases, a view has a short life-span: it is created to make
5357
a selected change and is deleted once that change is committed.
5358
At other times, you may wish to create one or more named views
5359
and switch between them.
5361
To disable the current view without deleting it, you can switch to
5362
the pseudo view called ``off``. This can be useful when you need
5363
to see the whole tree for an operation or two (e.g. merge) but
5364
want to switch back to your view after that.
5367
To define the current view::
5369
bzr view file1 dir1 ...
5371
To list the current view::
5375
To delete the current view::
5379
To disable the current view without deleting it::
5381
bzr view --switch off
5383
To define a named view and switch to it::
5385
bzr view --name view-name file1 dir1 ...
5387
To list a named view::
5389
bzr view --name view-name
5391
To delete a named view::
5393
bzr view --name view-name --delete
5395
To switch to a named view::
5397
bzr view --switch view-name
5399
To list all views defined::
5403
To delete all views::
5405
bzr view --delete --all
5409
takes_args = ['file*']
5412
help='Apply list or delete action to all views.',
5415
help='Delete the view.',
5418
help='Name of the view to define, list or delete.',
5422
help='Name of the view to switch to.',
5427
def run(self, file_list,
5433
tree, file_list = tree_files(file_list, apply_view=False)
5434
current_view, view_dict = tree.views.get_view_info()
5439
raise errors.BzrCommandError(
5440
"Both --delete and a file list specified")
5442
raise errors.BzrCommandError(
5443
"Both --delete and --switch specified")
5445
tree.views.set_view_info(None, {})
5446
self.outf.write("Deleted all views.\n")
5448
raise errors.BzrCommandError("No current view to delete")
5450
tree.views.delete_view(name)
5451
self.outf.write("Deleted '%s' view.\n" % name)
5454
raise errors.BzrCommandError(
5455
"Both --switch and a file list specified")
5457
raise errors.BzrCommandError(
5458
"Both --switch and --all specified")
5459
elif switch == 'off':
5460
if current_view is None:
5461
raise errors.BzrCommandError("No current view to disable")
5462
tree.views.set_view_info(None, view_dict)
5463
self.outf.write("Disabled '%s' view.\n" % (current_view))
5465
tree.views.set_view_info(switch, view_dict)
5466
view_str = views.view_display_str(tree.views.lookup_view())
5467
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5470
self.outf.write('Views defined:\n')
5471
for view in sorted(view_dict):
5472
if view == current_view:
5476
view_str = views.view_display_str(view_dict[view])
5477
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5479
self.outf.write('No views defined.\n')
5482
# No name given and no current view set
5485
raise errors.BzrCommandError(
5486
"Cannot change the 'off' pseudo view")
5487
tree.views.set_view(name, sorted(file_list))
5488
view_str = views.view_display_str(tree.views.lookup_view())
5489
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5493
# No name given and no current view set
5494
self.outf.write('No current view.\n')
5496
view_str = views.view_display_str(tree.views.lookup_view(name))
5497
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5500
class cmd_hooks(Command):
5506
for hook_key in sorted(hooks.known_hooks.keys()):
5507
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5508
self.outf.write("%s:\n" % type(some_hooks).__name__)
5509
for hook_name, hook_point in sorted(some_hooks.items()):
5510
self.outf.write(" %s:\n" % (hook_name,))
5511
found_hooks = list(hook_point)
5513
for hook in found_hooks:
5514
self.outf.write(" %s\n" %
5515
(some_hooks.get_hook_name(hook),))
5517
self.outf.write(" <no hooks installed>\n")
5520
class cmd_shelve(Command):
5521
"""Temporarily set aside some changes from the current tree.
5523
Shelve allows you to temporarily put changes you've made "on the shelf",
5524
ie. out of the way, until a later time when you can bring them back from
5525
the shelf with the 'unshelve' command. The changes are stored alongside
5526
your working tree, and so they aren't propagated along with your branch nor
5527
will they survive its deletion.
5529
If shelve --list is specified, previously-shelved changes are listed.
5531
Shelve is intended to help separate several sets of changes that have
5532
been inappropriately mingled. If you just want to get rid of all changes
5533
and you don't need to restore them later, use revert. If you want to
5534
shelve all text changes at once, use shelve --all.
5536
If filenames are specified, only the changes to those files will be
5537
shelved. Other files will be left untouched.
5539
If a revision is specified, changes since that revision will be shelved.
5541
You can put multiple items on the shelf, and by default, 'unshelve' will
5542
restore the most recently shelved changes.
5545
takes_args = ['file*']
5549
Option('all', help='Shelve all changes.'),
5551
RegistryOption('writer', 'Method to use for writing diffs.',
5552
bzrlib.option.diff_writer_registry,
5553
value_switches=True, enum_switch=False),
5555
Option('list', help='List shelved changes.'),
5557
help='Destroy removed changes instead of shelving them.'),
5559
_see_also = ['unshelve']
5561
def run(self, revision=None, all=False, file_list=None, message=None,
5562
writer=None, list=False, destroy=False):
5564
return self.run_for_list()
5565
from bzrlib.shelf_ui import Shelver
5567
writer = bzrlib.option.diff_writer_registry.get()
5569
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5570
message, destroy=destroy).run()
5571
except errors.UserAbort:
5574
def run_for_list(self):
5575
tree = WorkingTree.open_containing('.')[0]
5578
manager = tree.get_shelf_manager()
5579
shelves = manager.active_shelves()
5580
if len(shelves) == 0:
5581
note('No shelved changes.')
5583
for shelf_id in reversed(shelves):
5584
message = manager.get_metadata(shelf_id).get('message')
5586
message = '<no message>'
5587
self.outf.write('%3d: %s\n' % (shelf_id, message))
5593
class cmd_unshelve(Command):
5594
"""Restore shelved changes.
5596
By default, the most recently shelved changes are restored. However if you
5597
specify a shelf by id those changes will be restored instead. This works
5598
best when the changes don't depend on each other.
5601
takes_args = ['shelf_id?']
5603
RegistryOption.from_kwargs(
5604
'action', help="The action to perform.",
5605
enum_switch=False, value_switches=True,
5606
apply="Apply changes and remove from the shelf.",
5607
dry_run="Show changes, but do not apply or remove them.",
5608
delete_only="Delete changes without applying them."
5611
_see_also = ['shelve']
5613
def run(self, shelf_id=None, action='apply'):
5614
from bzrlib.shelf_ui import Unshelver
5615
Unshelver.from_args(shelf_id, action).run()
5618
class cmd_clean_tree(Command):
5619
"""Remove unwanted files from working tree.
5621
By default, only unknown files, not ignored files, are deleted. Versioned
5622
files are never deleted.
5624
Another class is 'detritus', which includes files emitted by bzr during
5625
normal operations and selftests. (The value of these files decreases with
5628
If no options are specified, unknown files are deleted. Otherwise, option
5629
flags are respected, and may be combined.
5631
To check what clean-tree will do, use --dry-run.
5633
takes_options = [Option('ignored', help='Delete all ignored files.'),
5634
Option('detritus', help='Delete conflict files, merge'
5635
' backups, and failed selftest dirs.'),
5637
help='Delete files unknown to bzr (default).'),
5638
Option('dry-run', help='Show files to delete instead of'
5640
Option('force', help='Do not prompt before deleting.')]
5641
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5643
from bzrlib.clean_tree import clean_tree
5644
if not (unknown or ignored or detritus):
5648
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5649
dry_run=dry_run, no_prompt=force)
5652
class cmd_reference(Command):
5653
"""list, view and set branch locations for nested trees.
5655
If no arguments are provided, lists the branch locations for nested trees.
5656
If one argument is provided, display the branch location for that tree.
5657
If two arguments are provided, set the branch location for that tree.
5662
takes_args = ['path?', 'location?']
5664
def run(self, path=None, location=None):
5666
if path is not None:
5668
tree, branch, relpath =(
5669
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5670
if path is not None:
5673
tree = branch.basis_tree()
5675
info = branch._get_all_reference_info().iteritems()
5676
self._display_reference_info(tree, branch, info)
5678
file_id = tree.path2id(path)
5680
raise errors.NotVersionedError(path)
5681
if location is None:
5682
info = [(file_id, branch.get_reference_info(file_id))]
5683
self._display_reference_info(tree, branch, info)
5685
branch.set_reference_info(file_id, path, location)
5687
def _display_reference_info(self, tree, branch, info):
5689
for file_id, (path, location) in info:
5691
path = tree.id2path(file_id)
5692
except errors.NoSuchId:
5694
ref_list.append((path, location))
5695
for path, location in sorted(ref_list):
5696
self.outf.write('%s %s\n' % (path, location))
5699
# these get imported and then picked up by the scan for cmd_*
5700
# TODO: Some more consistent way to split command definitions across files;
5701
# we do need to load at least some information about them to know of
5702
# aliases. ideally we would avoid loading the implementation until the
5703
# details were needed.
5704
from bzrlib.cmd_version_info import cmd_version_info
5705
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5706
from bzrlib.bundle.commands import (
5709
from bzrlib.foreign import cmd_dpush
5710
from bzrlib.sign_my_commits import cmd_sign_my_commits
5711
from bzrlib.weave_commands import cmd_versionedfile_list, \
5712
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
