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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
43
revision as _mod_revision,
50
from bzrlib.branch import Branch
51
from bzrlib.conflicts import ConflictList
52
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
53
from bzrlib.smtp_connection import SMTPConnection
54
from bzrlib.workingtree import WorkingTree
57
from bzrlib.commands import Command, display_command
58
from bzrlib.option import (
65
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
68
def tree_files(file_list, default_branch=u'.', canonicalize=True):
70
return internal_tree_files(file_list, default_branch, canonicalize)
71
except errors.FileInWrongBranch, e:
72
raise errors.BzrCommandError("%s is not in the same branch as %s" %
73
(e.path, file_list[0]))
76
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
81
rev_tree = tree.basis_tree()
83
rev_tree = branch.basis_tree()
85
if len(revisions) != 1:
86
raise errors.BzrCommandError(
87
'bzr %s --revision takes exactly one revision identifier' % (
89
rev_tree = revisions[0].as_tree(branch)
93
# XXX: Bad function name; should possibly also be a class method of
94
# WorkingTree rather than a function.
95
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True):
96
"""Convert command-line paths to a WorkingTree and relative paths.
98
This is typically used for command-line processors that take one or
99
more filenames, and infer the workingtree that contains them.
101
The filenames given are not required to exist.
103
:param file_list: Filenames to convert.
105
:param default_branch: Fallback tree path to use if file_list is empty or
108
:return: workingtree, [relative_paths]
110
if file_list is None or len(file_list) == 0:
111
return WorkingTree.open_containing(default_branch)[0], file_list
112
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
113
return tree, safe_relpath_files(tree, file_list, canonicalize)
116
def safe_relpath_files(tree, file_list, canonicalize=True):
117
"""Convert file_list into a list of relpaths in tree.
119
:param tree: A tree to operate on.
120
:param file_list: A list of user provided paths or None.
121
:return: A list of relative paths.
122
:raises errors.PathNotChild: When a provided path is in a different tree
125
if file_list is None:
128
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
129
# doesn't - fix that up here before we enter the loop.
131
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
134
for filename in file_list:
136
new_list.append(fixer(osutils.dereference_path(filename)))
137
except errors.PathNotChild:
138
raise errors.FileInWrongBranch(tree.branch, filename)
142
# TODO: Make sure no commands unconditionally use the working directory as a
143
# branch. If a filename argument is used, the first of them should be used to
144
# specify the branch. (Perhaps this can be factored out into some kind of
145
# Argument class, representing a file in a branch, where the first occurrence
148
class cmd_status(Command):
149
"""Display status summary.
151
This reports on versioned and unknown files, reporting them
152
grouped by state. Possible states are:
155
Versioned in the working copy but not in the previous revision.
158
Versioned in the previous revision but removed or deleted
162
Path of this file changed from the previous revision;
163
the text may also have changed. This includes files whose
164
parent directory was renamed.
167
Text has changed since the previous revision.
170
File kind has been changed (e.g. from file to directory).
173
Not versioned and not matching an ignore pattern.
175
To see ignored files use 'bzr ignored'. For details on the
176
changes to file texts, use 'bzr diff'.
178
Note that --short or -S gives status flags for each item, similar
179
to Subversion's status command. To get output similar to svn -q,
182
If no arguments are specified, the status of the entire working
183
directory is shown. Otherwise, only the status of the specified
184
files or directories is reported. If a directory is given, status
185
is reported for everything inside that directory.
187
Before merges are committed, the pending merge tip revisions are
188
shown. To see all pending merge revisions, use the -v option.
189
To skip the display of pending merge information altogether, use
190
the no-pending option or specify a file/directory.
192
If a revision argument is given, the status is calculated against
193
that revision, or between two revisions if two are provided.
196
# TODO: --no-recurse, --recurse options
198
takes_args = ['file*']
199
takes_options = ['show-ids', 'revision', 'change', 'verbose',
200
Option('short', help='Use short status indicators.',
202
Option('versioned', help='Only show versioned files.',
204
Option('no-pending', help='Don\'t show pending merges.',
207
aliases = ['st', 'stat']
209
encoding_type = 'replace'
210
_see_also = ['diff', 'revert', 'status-flags']
213
def run(self, show_ids=False, file_list=None, revision=None, short=False,
214
versioned=False, no_pending=False, verbose=False):
215
from bzrlib.status import show_tree_status
217
if revision and len(revision) > 2:
218
raise errors.BzrCommandError('bzr status --revision takes exactly'
219
' one or two revision specifiers')
221
tree, relfile_list = tree_files(file_list)
222
# Avoid asking for specific files when that is not needed.
223
if relfile_list == ['']:
225
# Don't disable pending merges for full trees other than '.'.
226
if file_list == ['.']:
228
# A specific path within a tree was given.
229
elif relfile_list is not None:
231
show_tree_status(tree, show_ids=show_ids,
232
specific_files=relfile_list, revision=revision,
233
to_file=self.outf, short=short, versioned=versioned,
234
show_pending=(not no_pending), verbose=verbose)
237
class cmd_cat_revision(Command):
238
"""Write out metadata for a revision.
240
The revision to print can either be specified by a specific
241
revision identifier, or you can use --revision.
245
takes_args = ['revision_id?']
246
takes_options = ['revision']
247
# cat-revision is more for frontends so should be exact
251
def run(self, revision_id=None, revision=None):
252
if revision_id is not None and revision is not None:
253
raise errors.BzrCommandError('You can only supply one of'
254
' revision_id or --revision')
255
if revision_id is None and revision is None:
256
raise errors.BzrCommandError('You must supply either'
257
' --revision or a revision_id')
258
b = WorkingTree.open_containing(u'.')[0].branch
260
# TODO: jam 20060112 should cat-revision always output utf-8?
261
if revision_id is not None:
262
revision_id = osutils.safe_revision_id(revision_id, warn=False)
264
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
265
except errors.NoSuchRevision:
266
msg = "The repository %s contains no revision %s." % (b.repository.base,
268
raise errors.BzrCommandError(msg)
269
elif revision is not None:
272
raise errors.BzrCommandError('You cannot specify a NULL'
274
rev_id = rev.as_revision_id(b)
275
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
278
class cmd_dump_btree(Command):
279
"""Dump the contents of a btree index file to stdout.
281
PATH is a btree index file, it can be any URL. This includes things like
282
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
284
By default, the tuples stored in the index file will be displayed. With
285
--raw, we will uncompress the pages, but otherwise display the raw bytes
289
# TODO: Do we want to dump the internal nodes as well?
290
# TODO: It would be nice to be able to dump the un-parsed information,
291
# rather than only going through iter_all_entries. However, this is
292
# good enough for a start
294
encoding_type = 'exact'
295
takes_args = ['path']
296
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
297
' rather than the parsed tuples.'),
300
def run(self, path, raw=False):
301
dirname, basename = osutils.split(path)
302
t = transport.get_transport(dirname)
304
self._dump_raw_bytes(t, basename)
306
self._dump_entries(t, basename)
308
def _get_index_and_bytes(self, trans, basename):
309
"""Create a BTreeGraphIndex and raw bytes."""
310
bt = btree_index.BTreeGraphIndex(trans, basename, None)
311
bytes = trans.get_bytes(basename)
312
bt._file = cStringIO.StringIO(bytes)
313
bt._size = len(bytes)
316
def _dump_raw_bytes(self, trans, basename):
319
# We need to parse at least the root node.
320
# This is because the first page of every row starts with an
321
# uncompressed header.
322
bt, bytes = self._get_index_and_bytes(trans, basename)
323
for page_idx, page_start in enumerate(xrange(0, len(bytes),
324
btree_index._PAGE_SIZE)):
325
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
326
page_bytes = bytes[page_start:page_end]
328
self.outf.write('Root node:\n')
329
header_end, data = bt._parse_header_from_bytes(page_bytes)
330
self.outf.write(page_bytes[:header_end])
332
self.outf.write('\nPage %d\n' % (page_idx,))
333
decomp_bytes = zlib.decompress(page_bytes)
334
self.outf.write(decomp_bytes)
335
self.outf.write('\n')
337
def _dump_entries(self, trans, basename):
339
st = trans.stat(basename)
340
except errors.TransportNotPossible:
341
# We can't stat, so we'll fake it because we have to do the 'get()'
343
bt, _ = self._get_index_and_bytes(trans, basename)
345
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
346
for node in bt.iter_all_entries():
347
# Node is made up of:
348
# (index, key, value, [references])
349
self.outf.write('%s\n' % (node[1:],))
352
class cmd_remove_tree(Command):
353
"""Remove the working tree from a given branch/checkout.
355
Since a lightweight checkout is little more than a working tree
356
this will refuse to run against one.
358
To re-create the working tree, use "bzr checkout".
360
_see_also = ['checkout', 'working-trees']
361
takes_args = ['location?']
364
help='Remove the working tree even if it has '
365
'uncommitted changes.'),
368
def run(self, location='.', force=False):
369
d = bzrdir.BzrDir.open(location)
372
working = d.open_workingtree()
373
except errors.NoWorkingTree:
374
raise errors.BzrCommandError("No working tree to remove")
375
except errors.NotLocalUrl:
376
raise errors.BzrCommandError("You cannot remove the working tree of a "
379
changes = working.changes_from(working.basis_tree())
380
if changes.has_changed():
381
raise errors.UncommittedChanges(working)
383
working_path = working.bzrdir.root_transport.base
384
branch_path = working.branch.bzrdir.root_transport.base
385
if working_path != branch_path:
386
raise errors.BzrCommandError("You cannot remove the working tree from "
387
"a lightweight checkout")
389
d.destroy_workingtree()
392
class cmd_revno(Command):
393
"""Show current revision number.
395
This is equal to the number of revisions on this branch.
399
takes_args = ['location?']
402
def run(self, location=u'.'):
403
self.outf.write(str(Branch.open_containing(location)[0].revno()))
404
self.outf.write('\n')
407
class cmd_revision_info(Command):
408
"""Show revision number and revision id for a given revision identifier.
411
takes_args = ['revision_info*']
415
help='Branch to examine, '
416
'rather than the one containing the working directory.',
423
def run(self, revision=None, directory=u'.', revision_info_list=[]):
426
if revision is not None:
427
revs.extend(revision)
428
if revision_info_list is not None:
429
for rev in revision_info_list:
430
revs.append(RevisionSpec.from_string(rev))
432
b = Branch.open_containing(directory)[0]
435
revs.append(RevisionSpec.from_string('-1'))
438
revision_id = rev.as_revision_id(b)
440
revno = '%4d' % (b.revision_id_to_revno(revision_id))
441
except errors.NoSuchRevision:
442
dotted_map = b.get_revision_id_to_revno_map()
443
revno = '.'.join(str(i) for i in dotted_map[revision_id])
444
print '%s %s' % (revno, revision_id)
447
class cmd_add(Command):
448
"""Add specified files or directories.
450
In non-recursive mode, all the named items are added, regardless
451
of whether they were previously ignored. A warning is given if
452
any of the named files are already versioned.
454
In recursive mode (the default), files are treated the same way
455
but the behaviour for directories is different. Directories that
456
are already versioned do not give a warning. All directories,
457
whether already versioned or not, are searched for files or
458
subdirectories that are neither versioned or ignored, and these
459
are added. This search proceeds recursively into versioned
460
directories. If no names are given '.' is assumed.
462
Therefore simply saying 'bzr add' will version all files that
463
are currently unknown.
465
Adding a file whose parent directory is not versioned will
466
implicitly add the parent, and so on up to the root. This means
467
you should never need to explicitly add a directory, they'll just
468
get added when you add a file in the directory.
470
--dry-run will show which files would be added, but not actually
473
--file-ids-from will try to use the file ids from the supplied path.
474
It looks up ids trying to find a matching parent directory with the
475
same filename, and then by pure path. This option is rarely needed
476
but can be useful when adding the same logical file into two
477
branches that will be merged later (without showing the two different
478
adds as a conflict). It is also useful when merging another project
479
into a subdirectory of this one.
481
takes_args = ['file*']
484
help="Don't recursively add the contents of directories."),
486
help="Show what would be done, but don't actually do anything."),
488
Option('file-ids-from',
490
help='Lookup file ids from this tree.'),
492
encoding_type = 'replace'
493
_see_also = ['remove']
495
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
500
if file_ids_from is not None:
502
base_tree, base_path = WorkingTree.open_containing(
504
except errors.NoWorkingTree:
505
base_branch, base_path = Branch.open_containing(
507
base_tree = base_branch.basis_tree()
509
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
510
to_file=self.outf, should_print=(not is_quiet()))
512
action = bzrlib.add.AddAction(to_file=self.outf,
513
should_print=(not is_quiet()))
516
base_tree.lock_read()
518
file_list = self._maybe_expand_globs(file_list)
520
tree = WorkingTree.open_containing(file_list[0])[0]
522
tree = WorkingTree.open_containing(u'.')[0]
523
added, ignored = tree.smart_add(file_list, not
524
no_recurse, action=action, save=not dry_run)
526
if base_tree is not None:
530
for glob in sorted(ignored.keys()):
531
for path in ignored[glob]:
532
self.outf.write("ignored %s matching \"%s\"\n"
536
for glob, paths in ignored.items():
537
match_len += len(paths)
538
self.outf.write("ignored %d file(s).\n" % match_len)
539
self.outf.write("If you wish to add some of these files,"
540
" please add them by name.\n")
543
class cmd_mkdir(Command):
544
"""Create a new versioned directory.
546
This is equivalent to creating the directory and then adding it.
549
takes_args = ['dir+']
550
encoding_type = 'replace'
552
def run(self, dir_list):
555
wt, dd = WorkingTree.open_containing(d)
557
self.outf.write('added %s\n' % d)
560
class cmd_relpath(Command):
561
"""Show path of a file relative to root"""
563
takes_args = ['filename']
567
def run(self, filename):
568
# TODO: jam 20050106 Can relpath return a munged path if
569
# sys.stdout encoding cannot represent it?
570
tree, relpath = WorkingTree.open_containing(filename)
571
self.outf.write(relpath)
572
self.outf.write('\n')
575
class cmd_inventory(Command):
576
"""Show inventory of the current working copy or a revision.
578
It is possible to limit the output to a particular entry
579
type using the --kind option. For example: --kind file.
581
It is also possible to restrict the list of files to a specific
582
set. For example: bzr inventory --show-ids this/file
591
help='List entries of a particular kind: file, directory, symlink.',
594
takes_args = ['file*']
597
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
598
if kind and kind not in ['file', 'directory', 'symlink']:
599
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
601
work_tree, file_list = tree_files(file_list)
602
work_tree.lock_read()
604
if revision is not None:
605
if len(revision) > 1:
606
raise errors.BzrCommandError(
607
'bzr inventory --revision takes exactly one revision'
609
tree = revision[0].as_tree(work_tree.branch)
611
extra_trees = [work_tree]
617
if file_list is not None:
618
file_ids = tree.paths2ids(file_list, trees=extra_trees,
619
require_versioned=True)
620
# find_ids_across_trees may include some paths that don't
622
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
623
for file_id in file_ids if file_id in tree)
625
entries = tree.inventory.entries()
628
if tree is not work_tree:
631
for path, entry in entries:
632
if kind and kind != entry.kind:
635
self.outf.write('%-50s %s\n' % (path, entry.file_id))
637
self.outf.write(path)
638
self.outf.write('\n')
641
class cmd_mv(Command):
642
"""Move or rename a file.
645
bzr mv OLDNAME NEWNAME
647
bzr mv SOURCE... DESTINATION
649
If the last argument is a versioned directory, all the other names
650
are moved into it. Otherwise, there must be exactly two arguments
651
and the file is changed to a new name.
653
If OLDNAME does not exist on the filesystem but is versioned and
654
NEWNAME does exist on the filesystem but is not versioned, mv
655
assumes that the file has been manually moved and only updates
656
its internal inventory to reflect that change.
657
The same is valid when moving many SOURCE files to a DESTINATION.
659
Files cannot be moved between branches.
662
takes_args = ['names*']
663
takes_options = [Option("after", help="Move only the bzr identifier"
664
" of the file, because the file has already been moved."),
666
aliases = ['move', 'rename']
667
encoding_type = 'replace'
669
def run(self, names_list, after=False):
670
if names_list is None:
673
if len(names_list) < 2:
674
raise errors.BzrCommandError("missing file argument")
675
tree, rel_names = tree_files(names_list, canonicalize=False)
678
self._run(tree, names_list, rel_names, after)
682
def _run(self, tree, names_list, rel_names, after):
683
into_existing = osutils.isdir(names_list[-1])
684
if into_existing and len(names_list) == 2:
686
# a. case-insensitive filesystem and change case of dir
687
# b. move directory after the fact (if the source used to be
688
# a directory, but now doesn't exist in the working tree
689
# and the target is an existing directory, just rename it)
690
if (not tree.case_sensitive
691
and rel_names[0].lower() == rel_names[1].lower()):
692
into_existing = False
695
# 'fix' the case of a potential 'from'
696
from_id = tree.path2id(
697
tree.get_canonical_inventory_path(rel_names[0]))
698
if (not osutils.lexists(names_list[0]) and
699
from_id and inv.get_file_kind(from_id) == "directory"):
700
into_existing = False
703
# move into existing directory
704
# All entries reference existing inventory items, so fix them up
705
# for cicp file-systems.
706
rel_names = tree.get_canonical_inventory_paths(rel_names)
707
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
708
self.outf.write("%s => %s\n" % pair)
710
if len(names_list) != 2:
711
raise errors.BzrCommandError('to mv multiple files the'
712
' destination must be a versioned'
715
# for cicp file-systems: the src references an existing inventory
717
src = tree.get_canonical_inventory_path(rel_names[0])
718
# Find the canonical version of the destination: In all cases, the
719
# parent of the target must be in the inventory, so we fetch the
720
# canonical version from there (we do not always *use* the
721
# canonicalized tail portion - we may be attempting to rename the
723
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
724
dest_parent = osutils.dirname(canon_dest)
725
spec_tail = osutils.basename(rel_names[1])
726
# For a CICP file-system, we need to avoid creating 2 inventory
727
# entries that differ only by case. So regardless of the case
728
# we *want* to use (ie, specified by the user or the file-system),
729
# we must always choose to use the case of any existing inventory
730
# items. The only exception to this is when we are attempting a
731
# case-only rename (ie, canonical versions of src and dest are
733
dest_id = tree.path2id(canon_dest)
734
if dest_id is None or tree.path2id(src) == dest_id:
735
# No existing item we care about, so work out what case we
736
# are actually going to use.
738
# If 'after' is specified, the tail must refer to a file on disk.
740
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
742
# pathjoin with an empty tail adds a slash, which breaks
744
dest_parent_fq = tree.basedir
746
dest_tail = osutils.canonical_relpath(
748
osutils.pathjoin(dest_parent_fq, spec_tail))
750
# not 'after', so case as specified is used
751
dest_tail = spec_tail
753
# Use the existing item so 'mv' fails with AlreadyVersioned.
754
dest_tail = os.path.basename(canon_dest)
755
dest = osutils.pathjoin(dest_parent, dest_tail)
756
mutter("attempting to move %s => %s", src, dest)
757
tree.rename_one(src, dest, after=after)
758
self.outf.write("%s => %s\n" % (src, dest))
761
class cmd_pull(Command):
762
"""Turn this branch into a mirror of another branch.
764
This command only works on branches that have not diverged. Branches are
765
considered diverged if the destination branch's most recent commit is one
766
that has not been merged (directly or indirectly) into the parent.
768
If branches have diverged, you can use 'bzr merge' to integrate the changes
769
from one into the other. Once one branch has merged, the other should
770
be able to pull it again.
772
If you want to forget your local changes and just update your branch to
773
match the remote one, use pull --overwrite.
775
If there is no default location set, the first pull will set it. After
776
that, you can omit the location to use the default. To change the
777
default, use --remember. The value will only be saved if the remote
778
location can be accessed.
780
Note: The location can be specified either in the form of a branch,
781
or in the form of a path to a file containing a merge directive generated
785
_see_also = ['push', 'update', 'status-flags']
786
takes_options = ['remember', 'overwrite', 'revision',
787
custom_help('verbose',
788
help='Show logs of pulled revisions.'),
790
help='Branch to pull into, '
791
'rather than the one containing the working directory.',
796
takes_args = ['location?']
797
encoding_type = 'replace'
799
def run(self, location=None, remember=False, overwrite=False,
800
revision=None, verbose=False,
802
# FIXME: too much stuff is in the command class
805
if directory is None:
808
tree_to = WorkingTree.open_containing(directory)[0]
809
branch_to = tree_to.branch
810
except errors.NoWorkingTree:
812
branch_to = Branch.open_containing(directory)[0]
814
possible_transports = []
815
if location is not None:
817
mergeable = bundle.read_mergeable_from_url(location,
818
possible_transports=possible_transports)
819
except errors.NotABundle:
822
stored_loc = branch_to.get_parent()
824
if stored_loc is None:
825
raise errors.BzrCommandError("No pull location known or"
828
display_url = urlutils.unescape_for_display(stored_loc,
831
self.outf.write("Using saved parent location: %s\n" % display_url)
832
location = stored_loc
834
if mergeable is not None:
835
if revision is not None:
836
raise errors.BzrCommandError(
837
'Cannot use -r with merge directives or bundles')
838
mergeable.install_revisions(branch_to.repository)
839
base_revision_id, revision_id, verified = \
840
mergeable.get_merge_request(branch_to.repository)
841
branch_from = branch_to
843
branch_from = Branch.open(location,
844
possible_transports=possible_transports)
846
if branch_to.get_parent() is None or remember:
847
branch_to.set_parent(branch_from.base)
849
if revision is not None:
850
if len(revision) == 1:
851
revision_id = revision[0].as_revision_id(branch_from)
853
raise errors.BzrCommandError(
854
'bzr pull --revision takes one value.')
856
branch_to.lock_write()
858
if tree_to is not None:
859
change_reporter = delta._ChangeReporter(
860
unversioned_filter=tree_to.is_ignored)
861
result = tree_to.pull(branch_from, overwrite, revision_id,
863
possible_transports=possible_transports)
865
result = branch_to.pull(branch_from, overwrite, revision_id)
867
result.report(self.outf)
868
if verbose and result.old_revid != result.new_revid:
869
log.show_branch_change(branch_to, self.outf, result.old_revno,
875
class cmd_push(Command):
876
"""Update a mirror of this branch.
878
The target branch will not have its working tree populated because this
879
is both expensive, and is not supported on remote file systems.
881
Some smart servers or protocols *may* put the working tree in place in
884
This command only works on branches that have not diverged. Branches are
885
considered diverged if the destination branch's most recent commit is one
886
that has not been merged (directly or indirectly) by the source branch.
888
If branches have diverged, you can use 'bzr push --overwrite' to replace
889
the other branch completely, discarding its unmerged changes.
891
If you want to ensure you have the different changes in the other branch,
892
do a merge (see bzr help merge) from the other branch, and commit that.
893
After that you will be able to do a push without '--overwrite'.
895
If there is no default push location set, the first push will set it.
896
After that, you can omit the location to use the default. To change the
897
default, use --remember. The value will only be saved if the remote
898
location can be accessed.
901
_see_also = ['pull', 'update', 'working-trees']
902
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
903
Option('create-prefix',
904
help='Create the path leading up to the branch '
905
'if it does not already exist.'),
907
help='Branch to push from, '
908
'rather than the one containing the working directory.',
912
Option('use-existing-dir',
913
help='By default push will fail if the target'
914
' directory exists, but does not already'
915
' have a control directory. This flag will'
916
' allow push to proceed.'),
918
help='Create a stacked branch that references the public location '
919
'of the parent branch.'),
921
help='Create a stacked branch that refers to another branch '
922
'for the commit history. Only the work not present in the '
923
'referenced branch is included in the branch created.',
926
takes_args = ['location?']
927
encoding_type = 'replace'
929
def run(self, location=None, remember=False, overwrite=False,
930
create_prefix=False, verbose=False, revision=None,
931
use_existing_dir=False, directory=None, stacked_on=None,
933
from bzrlib.push import _show_push_branch
935
# Get the source branch and revision_id
936
if directory is None:
938
br_from = Branch.open_containing(directory)[0]
939
if revision is not None:
940
if len(revision) == 1:
941
revision_id = revision[0].in_history(br_from).rev_id
943
raise errors.BzrCommandError(
944
'bzr push --revision takes one value.')
946
revision_id = br_from.last_revision()
948
# Get the stacked_on branch, if any
949
if stacked_on is not None:
950
stacked_on = urlutils.normalize_url(stacked_on)
952
parent_url = br_from.get_parent()
954
parent = Branch.open(parent_url)
955
stacked_on = parent.get_public_branch()
957
# I considered excluding non-http url's here, thus forcing
958
# 'public' branches only, but that only works for some
959
# users, so it's best to just depend on the user spotting an
960
# error by the feedback given to them. RBC 20080227.
961
stacked_on = parent_url
963
raise errors.BzrCommandError(
964
"Could not determine branch to refer to.")
966
# Get the destination location
968
stored_loc = br_from.get_push_location()
969
if stored_loc is None:
970
raise errors.BzrCommandError(
971
"No push location known or specified.")
973
display_url = urlutils.unescape_for_display(stored_loc,
975
self.outf.write("Using saved push location: %s\n" % display_url)
976
location = stored_loc
978
_show_push_branch(br_from, revision_id, location, self.outf,
979
verbose=verbose, overwrite=overwrite, remember=remember,
980
stacked_on=stacked_on, create_prefix=create_prefix,
981
use_existing_dir=use_existing_dir)
984
class cmd_branch(Command):
985
"""Create a new copy of a branch.
987
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
988
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
989
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
990
is derived from the FROM_LOCATION by stripping a leading scheme or drive
991
identifier, if any. For example, "branch lp:foo-bar" will attempt to
994
To retrieve the branch as of a particular revision, supply the --revision
995
parameter, as in "branch foo/bar -r 5".
998
_see_also = ['checkout']
999
takes_args = ['from_location', 'to_location?']
1000
takes_options = ['revision', Option('hardlink',
1001
help='Hard-link working tree files where possible.'),
1003
help='Create a stacked branch referring to the source branch. '
1004
'The new branch will depend on the availability of the source '
1005
'branch for all operations.'),
1006
Option('standalone',
1007
help='Do not use a shared repository, even if available.'),
1009
aliases = ['get', 'clone']
1011
def run(self, from_location, to_location=None, revision=None,
1012
hardlink=False, stacked=False, standalone=False):
1013
from bzrlib.tag import _merge_tags_if_possible
1014
if revision is None:
1016
elif len(revision) > 1:
1017
raise errors.BzrCommandError(
1018
'bzr branch --revision takes exactly 1 revision value')
1020
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1024
if len(revision) == 1 and revision[0] is not None:
1025
revision_id = revision[0].as_revision_id(br_from)
1027
# FIXME - wt.last_revision, fallback to branch, fall back to
1028
# None or perhaps NULL_REVISION to mean copy nothing
1030
revision_id = br_from.last_revision()
1031
if to_location is None:
1032
to_location = urlutils.derive_to_location(from_location)
1033
to_transport = transport.get_transport(to_location)
1035
to_transport.mkdir('.')
1036
except errors.FileExists:
1037
raise errors.BzrCommandError('Target directory "%s" already'
1038
' exists.' % to_location)
1039
except errors.NoSuchFile:
1040
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1043
# preserve whatever source format we have.
1044
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1045
possible_transports=[to_transport],
1046
accelerator_tree=accelerator_tree,
1047
hardlink=hardlink, stacked=stacked,
1048
force_new_repo=standalone,
1049
source_branch=br_from)
1050
branch = dir.open_branch()
1051
except errors.NoSuchRevision:
1052
to_transport.delete_tree('.')
1053
msg = "The branch %s has no revision %s." % (from_location,
1055
raise errors.BzrCommandError(msg)
1056
_merge_tags_if_possible(br_from, branch)
1057
# If the source branch is stacked, the new branch may
1058
# be stacked whether we asked for that explicitly or not.
1059
# We therefore need a try/except here and not just 'if stacked:'
1061
note('Created new stacked branch referring to %s.' %
1062
branch.get_stacked_on_url())
1063
except (errors.NotStacked, errors.UnstackableBranchFormat,
1064
errors.UnstackableRepositoryFormat), e:
1065
note('Branched %d revision(s).' % branch.revno())
1070
class cmd_checkout(Command):
1071
"""Create a new checkout of an existing branch.
1073
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1074
the branch found in '.'. This is useful if you have removed the working tree
1075
or if it was never created - i.e. if you pushed the branch to its current
1076
location using SFTP.
1078
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1079
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1080
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1081
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1082
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1085
To retrieve the branch as of a particular revision, supply the --revision
1086
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1087
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1091
_see_also = ['checkouts', 'branch']
1092
takes_args = ['branch_location?', 'to_location?']
1093
takes_options = ['revision',
1094
Option('lightweight',
1095
help="Perform a lightweight checkout. Lightweight "
1096
"checkouts depend on access to the branch for "
1097
"every operation. Normal checkouts can perform "
1098
"common operations like diff and status without "
1099
"such access, and also support local commits."
1101
Option('files-from', type=str,
1102
help="Get file contents from this tree."),
1104
help='Hard-link working tree files where possible.'
1109
def run(self, branch_location=None, to_location=None, revision=None,
1110
lightweight=False, files_from=None, hardlink=False):
1111
if revision is None:
1113
elif len(revision) > 1:
1114
raise errors.BzrCommandError(
1115
'bzr checkout --revision takes exactly 1 revision value')
1116
if branch_location is None:
1117
branch_location = osutils.getcwd()
1118
to_location = branch_location
1119
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1121
if files_from is not None:
1122
accelerator_tree = WorkingTree.open(files_from)
1123
if len(revision) == 1 and revision[0] is not None:
1124
revision_id = revision[0].as_revision_id(source)
1127
if to_location is None:
1128
to_location = urlutils.derive_to_location(branch_location)
1129
# if the source and to_location are the same,
1130
# and there is no working tree,
1131
# then reconstitute a branch
1132
if (osutils.abspath(to_location) ==
1133
osutils.abspath(branch_location)):
1135
source.bzrdir.open_workingtree()
1136
except errors.NoWorkingTree:
1137
source.bzrdir.create_workingtree(revision_id)
1139
source.create_checkout(to_location, revision_id, lightweight,
1140
accelerator_tree, hardlink)
1143
class cmd_renames(Command):
1144
"""Show list of renamed files.
1146
# TODO: Option to show renames between two historical versions.
1148
# TODO: Only show renames under dir, rather than in the whole branch.
1149
_see_also = ['status']
1150
takes_args = ['dir?']
1153
def run(self, dir=u'.'):
1154
tree = WorkingTree.open_containing(dir)[0]
1157
new_inv = tree.inventory
1158
old_tree = tree.basis_tree()
1159
old_tree.lock_read()
1161
old_inv = old_tree.inventory
1163
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1164
for f, paths, c, v, p, n, k, e in iterator:
1165
if paths[0] == paths[1]:
1169
renames.append(paths)
1171
for old_name, new_name in renames:
1172
self.outf.write("%s => %s\n" % (old_name, new_name))
1179
class cmd_update(Command):
1180
"""Update a tree to have the latest code committed to its branch.
1182
This will perform a merge into the working tree, and may generate
1183
conflicts. If you have any local changes, you will still
1184
need to commit them after the update for the update to be complete.
1186
If you want to discard your local changes, you can just do a
1187
'bzr revert' instead of 'bzr commit' after the update.
1190
_see_also = ['pull', 'working-trees', 'status-flags']
1191
takes_args = ['dir?']
1194
def run(self, dir='.'):
1195
tree = WorkingTree.open_containing(dir)[0]
1196
possible_transports = []
1197
master = tree.branch.get_master_branch(
1198
possible_transports=possible_transports)
1199
if master is not None:
1202
tree.lock_tree_write()
1204
existing_pending_merges = tree.get_parent_ids()[1:]
1205
last_rev = _mod_revision.ensure_null(tree.last_revision())
1206
if last_rev == _mod_revision.ensure_null(
1207
tree.branch.last_revision()):
1208
# may be up to date, check master too.
1209
if master is None or last_rev == _mod_revision.ensure_null(
1210
master.last_revision()):
1211
revno = tree.branch.revision_id_to_revno(last_rev)
1212
note("Tree is up to date at revision %d." % (revno,))
1214
conflicts = tree.update(
1215
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1216
possible_transports=possible_transports)
1217
revno = tree.branch.revision_id_to_revno(
1218
_mod_revision.ensure_null(tree.last_revision()))
1219
note('Updated to revision %d.' % (revno,))
1220
if tree.get_parent_ids()[1:] != existing_pending_merges:
1221
note('Your local commits will now show as pending merges with '
1222
"'bzr status', and can be committed with 'bzr commit'.")
1231
class cmd_info(Command):
1232
"""Show information about a working tree, branch or repository.
1234
This command will show all known locations and formats associated to the
1235
tree, branch or repository. Statistical information is included with
1238
Branches and working trees will also report any missing revisions.
1240
_see_also = ['revno', 'working-trees', 'repositories']
1241
takes_args = ['location?']
1242
takes_options = ['verbose']
1243
encoding_type = 'replace'
1246
def run(self, location=None, verbose=False):
1251
from bzrlib.info import show_bzrdir_info
1252
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1253
verbose=noise_level, outfile=self.outf)
1256
class cmd_remove(Command):
1257
"""Remove files or directories.
1259
This makes bzr stop tracking changes to the specified files. bzr will delete
1260
them if they can easily be recovered using revert. If no options or
1261
parameters are given bzr will scan for files that are being tracked by bzr
1262
but missing in your tree and stop tracking them for you.
1264
takes_args = ['file*']
1265
takes_options = ['verbose',
1266
Option('new', help='Only remove files that have never been committed.'),
1267
RegistryOption.from_kwargs('file-deletion-strategy',
1268
'The file deletion mode to be used.',
1269
title='Deletion Strategy', value_switches=True, enum_switch=False,
1270
safe='Only delete files if they can be'
1271
' safely recovered (default).',
1272
keep="Don't delete any files.",
1273
force='Delete all the specified files, even if they can not be '
1274
'recovered and even if they are non-empty directories.')]
1275
aliases = ['rm', 'del']
1276
encoding_type = 'replace'
1278
def run(self, file_list, verbose=False, new=False,
1279
file_deletion_strategy='safe'):
1280
tree, file_list = tree_files(file_list)
1282
if file_list is not None:
1283
file_list = [f for f in file_list]
1287
# Heuristics should probably all move into tree.remove_smart or
1290
added = tree.changes_from(tree.basis_tree(),
1291
specific_files=file_list).added
1292
file_list = sorted([f[0] for f in added], reverse=True)
1293
if len(file_list) == 0:
1294
raise errors.BzrCommandError('No matching files.')
1295
elif file_list is None:
1296
# missing files show up in iter_changes(basis) as
1297
# versioned-with-no-kind.
1299
for change in tree.iter_changes(tree.basis_tree()):
1300
# Find paths in the working tree that have no kind:
1301
if change[1][1] is not None and change[6][1] is None:
1302
missing.append(change[1][1])
1303
file_list = sorted(missing, reverse=True)
1304
file_deletion_strategy = 'keep'
1305
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1306
keep_files=file_deletion_strategy=='keep',
1307
force=file_deletion_strategy=='force')
1312
class cmd_file_id(Command):
1313
"""Print file_id of a particular file or directory.
1315
The file_id is assigned when the file is first added and remains the
1316
same through all revisions where the file exists, even when it is
1321
_see_also = ['inventory', 'ls']
1322
takes_args = ['filename']
1325
def run(self, filename):
1326
tree, relpath = WorkingTree.open_containing(filename)
1327
i = tree.path2id(relpath)
1329
raise errors.NotVersionedError(filename)
1331
self.outf.write(i + '\n')
1334
class cmd_file_path(Command):
1335
"""Print path of file_ids to a file or directory.
1337
This prints one line for each directory down to the target,
1338
starting at the branch root.
1342
takes_args = ['filename']
1345
def run(self, filename):
1346
tree, relpath = WorkingTree.open_containing(filename)
1347
fid = tree.path2id(relpath)
1349
raise errors.NotVersionedError(filename)
1350
segments = osutils.splitpath(relpath)
1351
for pos in range(1, len(segments) + 1):
1352
path = osutils.joinpath(segments[:pos])
1353
self.outf.write("%s\n" % tree.path2id(path))
1356
class cmd_reconcile(Command):
1357
"""Reconcile bzr metadata in a branch.
1359
This can correct data mismatches that may have been caused by
1360
previous ghost operations or bzr upgrades. You should only
1361
need to run this command if 'bzr check' or a bzr developer
1362
advises you to run it.
1364
If a second branch is provided, cross-branch reconciliation is
1365
also attempted, which will check that data like the tree root
1366
id which was not present in very early bzr versions is represented
1367
correctly in both branches.
1369
At the same time it is run it may recompress data resulting in
1370
a potential saving in disk space or performance gain.
1372
The branch *MUST* be on a listable system such as local disk or sftp.
1375
_see_also = ['check']
1376
takes_args = ['branch?']
1378
def run(self, branch="."):
1379
from bzrlib.reconcile import reconcile
1380
dir = bzrdir.BzrDir.open(branch)
1384
class cmd_revision_history(Command):
1385
"""Display the list of revision ids on a branch."""
1388
takes_args = ['location?']
1393
def run(self, location="."):
1394
branch = Branch.open_containing(location)[0]
1395
for revid in branch.revision_history():
1396
self.outf.write(revid)
1397
self.outf.write('\n')
1400
class cmd_ancestry(Command):
1401
"""List all revisions merged into this branch."""
1403
_see_also = ['log', 'revision-history']
1404
takes_args = ['location?']
1409
def run(self, location="."):
1411
wt = WorkingTree.open_containing(location)[0]
1412
except errors.NoWorkingTree:
1413
b = Branch.open(location)
1414
last_revision = b.last_revision()
1417
last_revision = wt.last_revision()
1419
revision_ids = b.repository.get_ancestry(last_revision)
1421
for revision_id in revision_ids:
1422
self.outf.write(revision_id + '\n')
1425
class cmd_init(Command):
1426
"""Make a directory into a versioned branch.
1428
Use this to create an empty branch, or before importing an
1431
If there is a repository in a parent directory of the location, then
1432
the history of the branch will be stored in the repository. Otherwise
1433
init creates a standalone branch which carries its own history
1434
in the .bzr directory.
1436
If there is already a branch at the location but it has no working tree,
1437
the tree can be populated with 'bzr checkout'.
1439
Recipe for importing a tree of files::
1445
bzr commit -m "imported project"
1448
_see_also = ['init-repository', 'branch', 'checkout']
1449
takes_args = ['location?']
1451
Option('create-prefix',
1452
help='Create the path leading up to the branch '
1453
'if it does not already exist.'),
1454
RegistryOption('format',
1455
help='Specify a format for this branch. '
1456
'See "help formats".',
1457
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1458
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1459
value_switches=True,
1460
title="Branch Format",
1462
Option('append-revisions-only',
1463
help='Never change revnos or the existing log.'
1464
' Append revisions to it only.')
1466
def run(self, location=None, format=None, append_revisions_only=False,
1467
create_prefix=False):
1469
format = bzrdir.format_registry.make_bzrdir('default')
1470
if location is None:
1473
to_transport = transport.get_transport(location)
1475
# The path has to exist to initialize a
1476
# branch inside of it.
1477
# Just using os.mkdir, since I don't
1478
# believe that we want to create a bunch of
1479
# locations if the user supplies an extended path
1481
to_transport.ensure_base()
1482
except errors.NoSuchFile:
1483
if not create_prefix:
1484
raise errors.BzrCommandError("Parent directory of %s"
1486
"\nYou may supply --create-prefix to create all"
1487
" leading parent directories."
1489
_create_prefix(to_transport)
1492
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1493
except errors.NotBranchError:
1494
# really a NotBzrDir error...
1495
create_branch = bzrdir.BzrDir.create_branch_convenience
1496
branch = create_branch(to_transport.base, format=format,
1497
possible_transports=[to_transport])
1498
a_bzrdir = branch.bzrdir
1500
from bzrlib.transport.local import LocalTransport
1501
if a_bzrdir.has_branch():
1502
if (isinstance(to_transport, LocalTransport)
1503
and not a_bzrdir.has_workingtree()):
1504
raise errors.BranchExistsWithoutWorkingTree(location)
1505
raise errors.AlreadyBranchError(location)
1506
branch = a_bzrdir.create_branch()
1507
a_bzrdir.create_workingtree()
1508
if append_revisions_only:
1510
branch.set_append_revisions_only(True)
1511
except errors.UpgradeRequired:
1512
raise errors.BzrCommandError('This branch format cannot be set'
1513
' to append-revisions-only. Try --experimental-branch6')
1515
from bzrlib.info import describe_layout, describe_format
1517
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1518
except (errors.NoWorkingTree, errors.NotLocalUrl):
1520
repository = branch.repository
1521
layout = describe_layout(repository, branch, tree).lower()
1522
format = describe_format(a_bzrdir, repository, branch, tree)
1523
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1524
if repository.is_shared():
1525
#XXX: maybe this can be refactored into transport.path_or_url()
1526
url = repository.bzrdir.root_transport.external_url()
1528
url = urlutils.local_path_from_url(url)
1529
except errors.InvalidURL:
1531
self.outf.write("Using shared repository: %s\n" % url)
1534
class cmd_init_repository(Command):
1535
"""Create a shared repository to hold branches.
1537
New branches created under the repository directory will store their
1538
revisions in the repository, not in the branch directory.
1540
If the --no-trees option is used then the branches in the repository
1541
will not have working trees by default.
1544
Create a shared repositories holding just branches::
1546
bzr init-repo --no-trees repo
1549
Make a lightweight checkout elsewhere::
1551
bzr checkout --lightweight repo/trunk trunk-checkout
1556
_see_also = ['init', 'branch', 'checkout', 'repositories']
1557
takes_args = ["location"]
1558
takes_options = [RegistryOption('format',
1559
help='Specify a format for this repository. See'
1560
' "bzr help formats" for details.',
1561
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1562
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1563
value_switches=True, title='Repository format'),
1565
help='Branches in the repository will default to'
1566
' not having a working tree.'),
1568
aliases = ["init-repo"]
1570
def run(self, location, format=None, no_trees=False):
1572
format = bzrdir.format_registry.make_bzrdir('default')
1574
if location is None:
1577
to_transport = transport.get_transport(location)
1578
to_transport.ensure_base()
1580
newdir = format.initialize_on_transport(to_transport)
1581
repo = newdir.create_repository(shared=True)
1582
repo.set_make_working_trees(not no_trees)
1584
from bzrlib.info import show_bzrdir_info
1585
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1588
class cmd_diff(Command):
1589
"""Show differences in the working tree, between revisions or branches.
1591
If no arguments are given, all changes for the current tree are listed.
1592
If files are given, only the changes in those files are listed.
1593
Remote and multiple branches can be compared by using the --old and
1594
--new options. If not provided, the default for both is derived from
1595
the first argument, if any, or the current tree if no arguments are
1598
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1599
produces patches suitable for "patch -p1".
1603
2 - unrepresentable changes
1608
Shows the difference in the working tree versus the last commit::
1612
Difference between the working tree and revision 1::
1616
Difference between revision 2 and revision 1::
1620
Difference between revision 2 and revision 1 for branch xxx::
1624
Show just the differences for file NEWS::
1628
Show the differences in working tree xxx for file NEWS::
1632
Show the differences from branch xxx to this working tree:
1636
Show the differences between two branches for file NEWS::
1638
bzr diff --old xxx --new yyy NEWS
1640
Same as 'bzr diff' but prefix paths with old/ and new/::
1642
bzr diff --prefix old/:new/
1644
_see_also = ['status']
1645
takes_args = ['file*']
1647
Option('diff-options', type=str,
1648
help='Pass these options to the external diff program.'),
1649
Option('prefix', type=str,
1651
help='Set prefixes added to old and new filenames, as '
1652
'two values separated by a colon. (eg "old/:new/").'),
1654
help='Branch/tree to compare from.',
1658
help='Branch/tree to compare to.',
1664
help='Use this command to compare files.',
1668
aliases = ['di', 'dif']
1669
encoding_type = 'exact'
1672
def run(self, revision=None, file_list=None, diff_options=None,
1673
prefix=None, old=None, new=None, using=None):
1674
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1676
if (prefix is None) or (prefix == '0'):
1684
old_label, new_label = prefix.split(":")
1686
raise errors.BzrCommandError(
1687
'--prefix expects two values separated by a colon'
1688
' (eg "old/:new/")')
1690
if revision and len(revision) > 2:
1691
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1692
' one or two revision specifiers')
1694
old_tree, new_tree, specific_files, extra_trees = \
1695
_get_trees_to_diff(file_list, revision, old, new)
1696
return show_diff_trees(old_tree, new_tree, sys.stdout,
1697
specific_files=specific_files,
1698
external_diff_options=diff_options,
1699
old_label=old_label, new_label=new_label,
1700
extra_trees=extra_trees, using=using)
1703
class cmd_deleted(Command):
1704
"""List files deleted in the working tree.
1706
# TODO: Show files deleted since a previous revision, or
1707
# between two revisions.
1708
# TODO: Much more efficient way to do this: read in new
1709
# directories with readdir, rather than stating each one. Same
1710
# level of effort but possibly much less IO. (Or possibly not,
1711
# if the directories are very large...)
1712
_see_also = ['status', 'ls']
1713
takes_options = ['show-ids']
1716
def run(self, show_ids=False):
1717
tree = WorkingTree.open_containing(u'.')[0]
1720
old = tree.basis_tree()
1723
for path, ie in old.inventory.iter_entries():
1724
if not tree.has_id(ie.file_id):
1725
self.outf.write(path)
1727
self.outf.write(' ')
1728
self.outf.write(ie.file_id)
1729
self.outf.write('\n')
1736
class cmd_modified(Command):
1737
"""List files modified in working tree.
1741
_see_also = ['status', 'ls']
1744
help='Write an ascii NUL (\\0) separator '
1745
'between files rather than a newline.')
1749
def run(self, null=False):
1750
tree = WorkingTree.open_containing(u'.')[0]
1751
td = tree.changes_from(tree.basis_tree())
1752
for path, id, kind, text_modified, meta_modified in td.modified:
1754
self.outf.write(path + '\0')
1756
self.outf.write(osutils.quotefn(path) + '\n')
1759
class cmd_added(Command):
1760
"""List files added in working tree.
1764
_see_also = ['status', 'ls']
1767
help='Write an ascii NUL (\\0) separator '
1768
'between files rather than a newline.')
1772
def run(self, null=False):
1773
wt = WorkingTree.open_containing(u'.')[0]
1776
basis = wt.basis_tree()
1779
basis_inv = basis.inventory
1782
if file_id in basis_inv:
1784
if inv.is_root(file_id) and len(basis_inv) == 0:
1786
path = inv.id2path(file_id)
1787
if not os.access(osutils.abspath(path), os.F_OK):
1790
self.outf.write(path + '\0')
1792
self.outf.write(osutils.quotefn(path) + '\n')
1799
class cmd_root(Command):
1800
"""Show the tree root directory.
1802
The root is the nearest enclosing directory with a .bzr control
1805
takes_args = ['filename?']
1807
def run(self, filename=None):
1808
"""Print the branch root."""
1809
tree = WorkingTree.open_containing(filename)[0]
1810
self.outf.write(tree.basedir + '\n')
1813
def _parse_limit(limitstring):
1815
return int(limitstring)
1817
msg = "The limit argument must be an integer."
1818
raise errors.BzrCommandError(msg)
1821
def _parse_levels(s):
1825
msg = "The levels argument must be an integer."
1826
raise errors.BzrCommandError(msg)
1829
class cmd_log(Command):
1830
"""Show log of a branch, file, or directory.
1832
By default show the log of the branch containing the working directory.
1834
To request a range of logs, you can use the command -r begin..end
1835
-r revision requests a specific revision, -r ..end or -r begin.. are
1839
Log the current branch::
1847
Log the last 10 revisions of a branch::
1849
bzr log -r -10.. http://server/branch
1852
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1854
takes_args = ['location?']
1857
help='Show from oldest to newest.'),
1859
custom_help('verbose',
1860
help='Show files changed in each revision.'),
1864
type=bzrlib.option._parse_revision_str,
1866
help='Show just the specified revision.'
1867
' See also "help revisionspec".'),
1871
help='Number of levels to display - 0 for all, 1 for flat.',
1873
type=_parse_levels),
1876
help='Show revisions whose message matches this '
1877
'regular expression.',
1881
help='Limit the output to the first N revisions.',
1886
help='Show changes made in each revision as a patch.'),
1888
encoding_type = 'replace'
1891
def run(self, location=None, timezone='original',
1902
from bzrlib.log import show_log, _get_fileid_to_log
1903
direction = (forward and 'forward') or 'reverse'
1905
if change is not None:
1907
raise errors.RangeInChangeOption()
1908
if revision is not None:
1909
raise errors.BzrCommandError(
1910
'--revision and --change are mutually exclusive')
1917
# find the file id to log:
1919
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1922
file_id = _get_fileid_to_log(revision, tree, b, fp)
1924
raise errors.BzrCommandError(
1925
"Path unknown at end or start of revision range: %s" %
1929
# FIXME ? log the current subdir only RBC 20060203
1930
if revision is not None \
1931
and len(revision) > 0 and revision[0].get_branch():
1932
location = revision[0].get_branch()
1935
dir, relpath = bzrdir.BzrDir.open_containing(location)
1936
b = dir.open_branch()
1940
rev1, rev2 = _get_revision_range(revision, b, self.name())
1941
if log_format is None:
1942
log_format = log.log_formatter_registry.get_default(b)
1944
lf = log_format(show_ids=show_ids, to_file=self.outf,
1945
show_timezone=timezone,
1946
delta_format=get_verbosity_level(),
1953
direction=direction,
1954
start_revision=rev1,
1958
show_diff=show_diff)
1963
def _get_revision_range(revisionspec_list, branch, command_name):
1964
"""Take the input of a revision option and turn it into a revision range.
1966
It returns RevisionInfo objects which can be used to obtain the rev_id's
1967
of the desired revisons. It does some user input validations.
1969
if revisionspec_list is None:
1972
elif len(revisionspec_list) == 1:
1973
rev1 = rev2 = revisionspec_list[0].in_history(branch)
1974
elif len(revisionspec_list) == 2:
1975
start_spec = revisionspec_list[0]
1976
end_spec = revisionspec_list[1]
1977
if end_spec.get_branch() != start_spec.get_branch():
1978
# b is taken from revision[0].get_branch(), and
1979
# show_log will use its revision_history. Having
1980
# different branches will lead to weird behaviors.
1981
raise errors.BzrCommandError(
1982
"bzr %s doesn't accept two revisions in different"
1983
" branches." % command_name)
1984
rev1 = start_spec.in_history(branch)
1985
# Avoid loading all of history when we know a missing
1986
# end of range means the last revision ...
1987
if end_spec.spec is None:
1988
last_revno, last_revision_id = branch.last_revision_info()
1989
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
1991
rev2 = end_spec.in_history(branch)
1993
raise errors.BzrCommandError(
1994
'bzr %s --revision takes one or two values.' % command_name)
1998
def _revision_range_to_revid_range(revision_range):
2001
if revision_range[0] is not None:
2002
rev_id1 = revision_range[0].rev_id
2003
if revision_range[1] is not None:
2004
rev_id2 = revision_range[1].rev_id
2005
return rev_id1, rev_id2
2007
def get_log_format(long=False, short=False, line=False, default='long'):
2008
log_format = default
2012
log_format = 'short'
2018
class cmd_touching_revisions(Command):
2019
"""Return revision-ids which affected a particular file.
2021
A more user-friendly interface is "bzr log FILE".
2025
takes_args = ["filename"]
2028
def run(self, filename):
2029
tree, relpath = WorkingTree.open_containing(filename)
2031
file_id = tree.path2id(relpath)
2032
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2033
self.outf.write("%6d %s\n" % (revno, what))
2036
class cmd_ls(Command):
2037
"""List files in a tree.
2040
_see_also = ['status', 'cat']
2041
takes_args = ['path?']
2042
# TODO: Take a revision or remote path and list that tree instead.
2046
Option('non-recursive',
2047
help='Don\'t recurse into subdirectories.'),
2049
help='Print paths relative to the root of the branch.'),
2050
Option('unknown', help='Print unknown files.'),
2051
Option('versioned', help='Print versioned files.',
2053
Option('ignored', help='Print ignored files.'),
2055
help='Write an ascii NUL (\\0) separator '
2056
'between files rather than a newline.'),
2058
help='List entries of a particular kind: file, directory, symlink.',
2063
def run(self, revision=None, verbose=False,
2064
non_recursive=False, from_root=False,
2065
unknown=False, versioned=False, ignored=False,
2066
null=False, kind=None, show_ids=False, path=None):
2068
if kind and kind not in ('file', 'directory', 'symlink'):
2069
raise errors.BzrCommandError('invalid kind specified')
2071
if verbose and null:
2072
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2073
all = not (unknown or versioned or ignored)
2075
selection = {'I':ignored, '?':unknown, 'V':versioned}
2082
raise errors.BzrCommandError('cannot specify both --from-root'
2086
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2092
if revision is not None or tree is None:
2093
tree = _get_one_revision_tree('ls', revision, branch=branch)
2097
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
2098
if fp.startswith(relpath):
2099
fp = osutils.pathjoin(prefix, fp[len(relpath):])
2100
if non_recursive and '/' in fp:
2102
if not all and not selection[fc]:
2104
if kind is not None and fkind != kind:
2106
kindch = entry.kind_character()
2107
outstring = fp + kindch
2109
outstring = '%-8s %s' % (fc, outstring)
2110
if show_ids and fid is not None:
2111
outstring = "%-50s %s" % (outstring, fid)
2112
self.outf.write(outstring + '\n')
2114
self.outf.write(fp + '\0')
2117
self.outf.write(fid)
2118
self.outf.write('\0')
2126
self.outf.write('%-50s %s\n' % (outstring, my_id))
2128
self.outf.write(outstring + '\n')
2133
class cmd_unknowns(Command):
2134
"""List unknown files.
2142
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2143
self.outf.write(osutils.quotefn(f) + '\n')
2146
class cmd_ignore(Command):
2147
"""Ignore specified files or patterns.
2149
See ``bzr help patterns`` for details on the syntax of patterns.
2151
To remove patterns from the ignore list, edit the .bzrignore file.
2152
After adding, editing or deleting that file either indirectly by
2153
using this command or directly by using an editor, be sure to commit
2156
Note: ignore patterns containing shell wildcards must be quoted from
2160
Ignore the top level Makefile::
2162
bzr ignore ./Makefile
2164
Ignore class files in all directories::
2166
bzr ignore "*.class"
2168
Ignore .o files under the lib directory::
2170
bzr ignore "lib/**/*.o"
2172
Ignore .o files under the lib directory::
2174
bzr ignore "RE:lib/.*\.o"
2176
Ignore everything but the "debian" toplevel directory::
2178
bzr ignore "RE:(?!debian/).*"
2181
_see_also = ['status', 'ignored', 'patterns']
2182
takes_args = ['name_pattern*']
2184
Option('old-default-rules',
2185
help='Write out the ignore rules bzr < 0.9 always used.')
2188
def run(self, name_pattern_list=None, old_default_rules=None):
2189
from bzrlib import ignores
2190
if old_default_rules is not None:
2191
# dump the rules and exit
2192
for pattern in ignores.OLD_DEFAULTS:
2195
if not name_pattern_list:
2196
raise errors.BzrCommandError("ignore requires at least one "
2197
"NAME_PATTERN or --old-default-rules")
2198
name_pattern_list = [globbing.normalize_pattern(p)
2199
for p in name_pattern_list]
2200
for name_pattern in name_pattern_list:
2201
if (name_pattern[0] == '/' or
2202
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2203
raise errors.BzrCommandError(
2204
"NAME_PATTERN should not be an absolute path")
2205
tree, relpath = WorkingTree.open_containing(u'.')
2206
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2207
ignored = globbing.Globster(name_pattern_list)
2210
for entry in tree.list_files():
2214
if ignored.match(filename):
2215
matches.append(filename.encode('utf-8'))
2217
if len(matches) > 0:
2218
print "Warning: the following files are version controlled and" \
2219
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2222
class cmd_ignored(Command):
2223
"""List ignored files and the patterns that matched them.
2225
List all the ignored files and the ignore pattern that caused the file to
2228
Alternatively, to list just the files::
2233
encoding_type = 'replace'
2234
_see_also = ['ignore', 'ls']
2238
tree = WorkingTree.open_containing(u'.')[0]
2241
for path, file_class, kind, file_id, entry in tree.list_files():
2242
if file_class != 'I':
2244
## XXX: Slightly inefficient since this was already calculated
2245
pat = tree.is_ignored(path)
2246
self.outf.write('%-50s %s\n' % (path, pat))
2251
class cmd_lookup_revision(Command):
2252
"""Lookup the revision-id from a revision-number
2255
bzr lookup-revision 33
2258
takes_args = ['revno']
2261
def run(self, revno):
2265
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2267
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2270
class cmd_export(Command):
2271
"""Export current or past revision to a destination directory or archive.
2273
If no revision is specified this exports the last committed revision.
2275
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2276
given, try to find the format with the extension. If no extension
2277
is found exports to a directory (equivalent to --format=dir).
2279
If root is supplied, it will be used as the root directory inside
2280
container formats (tar, zip, etc). If it is not supplied it will default
2281
to the exported filename. The root option has no effect for 'dir' format.
2283
If branch is omitted then the branch containing the current working
2284
directory will be used.
2286
Note: Export of tree with non-ASCII filenames to zip is not supported.
2288
================= =========================
2289
Supported formats Autodetected by extension
2290
================= =========================
2293
tbz2 .tar.bz2, .tbz2
2296
================= =========================
2298
takes_args = ['dest', 'branch_or_subdir?']
2301
help="Type of file to export to.",
2306
help="Name of the root directory inside the exported file."),
2308
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2310
from bzrlib.export import export
2312
if branch_or_subdir is None:
2313
tree = WorkingTree.open_containing(u'.')[0]
2317
b, subdir = Branch.open_containing(branch_or_subdir)
2320
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2322
export(rev_tree, dest, format, root, subdir)
2323
except errors.NoSuchExportFormat, e:
2324
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2327
class cmd_cat(Command):
2328
"""Write the contents of a file as of a given revision to standard output.
2330
If no revision is nominated, the last revision is used.
2332
Note: Take care to redirect standard output when using this command on a
2338
Option('name-from-revision', help='The path name in the old tree.'),
2341
takes_args = ['filename']
2342
encoding_type = 'exact'
2345
def run(self, filename, revision=None, name_from_revision=False):
2346
if revision is not None and len(revision) != 1:
2347
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2348
" one revision specifier")
2349
tree, branch, relpath = \
2350
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2353
return self._run(tree, branch, relpath, filename, revision,
2358
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2360
tree = b.basis_tree()
2361
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2363
cur_file_id = tree.path2id(relpath)
2364
old_file_id = rev_tree.path2id(relpath)
2366
if name_from_revision:
2367
if old_file_id is None:
2368
raise errors.BzrCommandError(
2369
"%r is not present in revision %s" % (
2370
filename, rev_tree.get_revision_id()))
2372
content = rev_tree.get_file_text(old_file_id)
2373
elif cur_file_id is not None:
2374
content = rev_tree.get_file_text(cur_file_id)
2375
elif old_file_id is not None:
2376
content = rev_tree.get_file_text(old_file_id)
2378
raise errors.BzrCommandError(
2379
"%r is not present in revision %s" % (
2380
filename, rev_tree.get_revision_id()))
2381
self.outf.write(content)
2384
class cmd_local_time_offset(Command):
2385
"""Show the offset in seconds from GMT to local time."""
2389
print osutils.local_time_offset()
2393
class cmd_commit(Command):
2394
"""Commit changes into a new revision.
2396
If no arguments are given, the entire tree is committed.
2398
If selected files are specified, only changes to those files are
2399
committed. If a directory is specified then the directory and everything
2400
within it is committed.
2402
When excludes are given, they take precedence over selected files.
2403
For example, too commit only changes within foo, but not changes within
2406
bzr commit foo -x foo/bar
2408
If author of the change is not the same person as the committer, you can
2409
specify the author's name using the --author option. The name should be
2410
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2412
A selected-file commit may fail in some cases where the committed
2413
tree would be invalid. Consider::
2418
bzr commit foo -m "committing foo"
2419
bzr mv foo/bar foo/baz
2422
bzr commit foo/bar -m "committing bar but not baz"
2424
In the example above, the last commit will fail by design. This gives
2425
the user the opportunity to decide whether they want to commit the
2426
rename at the same time, separately first, or not at all. (As a general
2427
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2429
Note: A selected-file commit after a merge is not yet supported.
2431
# TODO: Run hooks on tree to-be-committed, and after commit.
2433
# TODO: Strict commit that fails if there are deleted files.
2434
# (what does "deleted files" mean ??)
2436
# TODO: Give better message for -s, --summary, used by tla people
2438
# XXX: verbose currently does nothing
2440
_see_also = ['bugs', 'uncommit']
2441
takes_args = ['selected*']
2443
ListOption('exclude', type=str, short_name='x',
2444
help="Do not consider changes made to a given path."),
2445
Option('message', type=unicode,
2447
help="Description of the new revision."),
2450
help='Commit even if nothing has changed.'),
2451
Option('file', type=str,
2454
help='Take commit message from this file.'),
2456
help="Refuse to commit if there are unknown "
2457
"files in the working tree."),
2458
ListOption('fixes', type=str,
2459
help="Mark a bug as being fixed by this revision."),
2460
Option('author', type=unicode,
2461
help="Set the author's name, if it's different "
2462
"from the committer."),
2464
help="Perform a local commit in a bound "
2465
"branch. Local commits are not pushed to "
2466
"the master branch until a normal commit "
2470
help='When no message is supplied, show the diff along'
2471
' with the status summary in the message editor.'),
2473
aliases = ['ci', 'checkin']
2475
def _get_bug_fix_properties(self, fixes, branch):
2477
# Configure the properties for bug fixing attributes.
2478
for fixed_bug in fixes:
2479
tokens = fixed_bug.split(':')
2480
if len(tokens) != 2:
2481
raise errors.BzrCommandError(
2482
"Invalid bug %s. Must be in the form of 'tag:id'. "
2483
"Commit refused." % fixed_bug)
2484
tag, bug_id = tokens
2486
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2487
except errors.UnknownBugTrackerAbbreviation:
2488
raise errors.BzrCommandError(
2489
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2490
except errors.MalformedBugIdentifier:
2491
raise errors.BzrCommandError(
2492
"Invalid bug identifier for %s. Commit refused."
2494
properties.append('%s fixed' % bug_url)
2495
return '\n'.join(properties)
2497
def run(self, message=None, file=None, verbose=False, selected_list=None,
2498
unchanged=False, strict=False, local=False, fixes=None,
2499
author=None, show_diff=False, exclude=None):
2500
from bzrlib.errors import (
2505
from bzrlib.msgeditor import (
2506
edit_commit_message_encoded,
2507
generate_commit_message_template,
2508
make_commit_message_template_encoded
2511
# TODO: Need a blackbox test for invoking the external editor; may be
2512
# slightly problematic to run this cross-platform.
2514
# TODO: do more checks that the commit will succeed before
2515
# spending the user's valuable time typing a commit message.
2519
tree, selected_list = tree_files(selected_list)
2520
if selected_list == ['']:
2521
# workaround - commit of root of tree should be exactly the same
2522
# as just default commit in that tree, and succeed even though
2523
# selected-file merge commit is not done yet
2528
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2530
properties['bugs'] = bug_property
2532
if local and not tree.branch.get_bound_location():
2533
raise errors.LocalRequiresBoundBranch()
2535
def get_message(commit_obj):
2536
"""Callback to get commit message"""
2537
my_message = message
2538
if my_message is None and not file:
2539
t = make_commit_message_template_encoded(tree,
2540
selected_list, diff=show_diff,
2541
output_encoding=osutils.get_user_encoding())
2542
start_message = generate_commit_message_template(commit_obj)
2543
my_message = edit_commit_message_encoded(t,
2544
start_message=start_message)
2545
if my_message is None:
2546
raise errors.BzrCommandError("please specify a commit"
2547
" message with either --message or --file")
2548
elif my_message and file:
2549
raise errors.BzrCommandError(
2550
"please specify either --message or --file")
2552
my_message = codecs.open(file, 'rt',
2553
osutils.get_user_encoding()).read()
2554
if my_message == "":
2555
raise errors.BzrCommandError("empty commit message specified")
2559
tree.commit(message_callback=get_message,
2560
specific_files=selected_list,
2561
allow_pointless=unchanged, strict=strict, local=local,
2562
reporter=None, verbose=verbose, revprops=properties,
2564
exclude=safe_relpath_files(tree, exclude))
2565
except PointlessCommit:
2566
# FIXME: This should really happen before the file is read in;
2567
# perhaps prepare the commit; get the message; then actually commit
2568
raise errors.BzrCommandError("no changes to commit."
2569
" use --unchanged to commit anyhow")
2570
except ConflictsInTree:
2571
raise errors.BzrCommandError('Conflicts detected in working '
2572
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2574
except StrictCommitFailed:
2575
raise errors.BzrCommandError("Commit refused because there are"
2576
" unknown files in the working tree.")
2577
except errors.BoundBranchOutOfDate, e:
2578
raise errors.BzrCommandError(str(e) + "\n"
2579
'To commit to master branch, run update and then commit.\n'
2580
'You can also pass --local to commit to continue working '
2584
class cmd_check(Command):
2585
"""Validate working tree structure, branch consistency and repository history.
2587
This command checks various invariants about branch and repository storage
2588
to detect data corruption or bzr bugs.
2590
The working tree and branch checks will only give output if a problem is
2591
detected. The output fields of the repository check are:
2593
revisions: This is just the number of revisions checked. It doesn't
2595
versionedfiles: This is just the number of versionedfiles checked. It
2596
doesn't indicate a problem.
2597
unreferenced ancestors: Texts that are ancestors of other texts, but
2598
are not properly referenced by the revision ancestry. This is a
2599
subtle problem that Bazaar can work around.
2600
unique file texts: This is the total number of unique file contents
2601
seen in the checked revisions. It does not indicate a problem.
2602
repeated file texts: This is the total number of repeated texts seen
2603
in the checked revisions. Texts can be repeated when their file
2604
entries are modified, but the file contents are not. It does not
2607
If no restrictions are specified, all Bazaar data that is found at the given
2608
location will be checked.
2612
Check the tree and branch at 'foo'::
2614
bzr check --tree --branch foo
2616
Check only the repository at 'bar'::
2618
bzr check --repo bar
2620
Check everything at 'baz'::
2625
_see_also = ['reconcile']
2626
takes_args = ['path?']
2627
takes_options = ['verbose',
2628
Option('branch', help="Check the branch related to the"
2629
" current directory."),
2630
Option('repo', help="Check the repository related to the"
2631
" current directory."),
2632
Option('tree', help="Check the working tree related to"
2633
" the current directory.")]
2635
def run(self, path=None, verbose=False, branch=False, repo=False,
2637
from bzrlib.check import check_dwim
2640
if not branch and not repo and not tree:
2641
branch = repo = tree = True
2642
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2645
class cmd_upgrade(Command):
2646
"""Upgrade branch storage to current format.
2648
The check command or bzr developers may sometimes advise you to run
2649
this command. When the default format has changed you may also be warned
2650
during other operations to upgrade.
2653
_see_also = ['check']
2654
takes_args = ['url?']
2656
RegistryOption('format',
2657
help='Upgrade to a specific format. See "bzr help'
2658
' formats" for details.',
2659
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2660
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2661
value_switches=True, title='Branch format'),
2664
def run(self, url='.', format=None):
2665
from bzrlib.upgrade import upgrade
2667
format = bzrdir.format_registry.make_bzrdir('default')
2668
upgrade(url, format)
2671
class cmd_whoami(Command):
2672
"""Show or set bzr user id.
2675
Show the email of the current user::
2679
Set the current user::
2681
bzr whoami "Frank Chu <fchu@example.com>"
2683
takes_options = [ Option('email',
2684
help='Display email address only.'),
2686
help='Set identity for the current branch instead of '
2689
takes_args = ['name?']
2690
encoding_type = 'replace'
2693
def run(self, email=False, branch=False, name=None):
2695
# use branch if we're inside one; otherwise global config
2697
c = Branch.open_containing('.')[0].get_config()
2698
except errors.NotBranchError:
2699
c = config.GlobalConfig()
2701
self.outf.write(c.user_email() + '\n')
2703
self.outf.write(c.username() + '\n')
2706
# display a warning if an email address isn't included in the given name.
2708
config.extract_email_address(name)
2709
except errors.NoEmailInUsername, e:
2710
warning('"%s" does not seem to contain an email address. '
2711
'This is allowed, but not recommended.', name)
2713
# use global config unless --branch given
2715
c = Branch.open_containing('.')[0].get_config()
2717
c = config.GlobalConfig()
2718
c.set_user_option('email', name)
2721
class cmd_nick(Command):
2722
"""Print or set the branch nickname.
2724
If unset, the tree root directory name is used as the nickname.
2725
To print the current nickname, execute with no argument.
2727
Bound branches use the nickname of its master branch unless it is set
2731
_see_also = ['info']
2732
takes_args = ['nickname?']
2733
def run(self, nickname=None):
2734
branch = Branch.open_containing(u'.')[0]
2735
if nickname is None:
2736
self.printme(branch)
2738
branch.nick = nickname
2741
def printme(self, branch):
2745
class cmd_alias(Command):
2746
"""Set/unset and display aliases.
2749
Show the current aliases::
2753
Show the alias specified for 'll'::
2757
Set an alias for 'll'::
2759
bzr alias ll="log --line -r-10..-1"
2761
To remove an alias for 'll'::
2763
bzr alias --remove ll
2766
takes_args = ['name?']
2768
Option('remove', help='Remove the alias.'),
2771
def run(self, name=None, remove=False):
2773
self.remove_alias(name)
2775
self.print_aliases()
2777
equal_pos = name.find('=')
2779
self.print_alias(name)
2781
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2783
def remove_alias(self, alias_name):
2784
if alias_name is None:
2785
raise errors.BzrCommandError(
2786
'bzr alias --remove expects an alias to remove.')
2787
# If alias is not found, print something like:
2788
# unalias: foo: not found
2789
c = config.GlobalConfig()
2790
c.unset_alias(alias_name)
2793
def print_aliases(self):
2794
"""Print out the defined aliases in a similar format to bash."""
2795
aliases = config.GlobalConfig().get_aliases()
2796
for key, value in sorted(aliases.iteritems()):
2797
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2800
def print_alias(self, alias_name):
2801
from bzrlib.commands import get_alias
2802
alias = get_alias(alias_name)
2804
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2807
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2809
def set_alias(self, alias_name, alias_command):
2810
"""Save the alias in the global config."""
2811
c = config.GlobalConfig()
2812
c.set_alias(alias_name, alias_command)
2815
class cmd_selftest(Command):
2816
"""Run internal test suite.
2818
If arguments are given, they are regular expressions that say which tests
2819
should run. Tests matching any expression are run, and other tests are
2822
Alternatively if --first is given, matching tests are run first and then
2823
all other tests are run. This is useful if you have been working in a
2824
particular area, but want to make sure nothing else was broken.
2826
If --exclude is given, tests that match that regular expression are
2827
excluded, regardless of whether they match --first or not.
2829
To help catch accidential dependencies between tests, the --randomize
2830
option is useful. In most cases, the argument used is the word 'now'.
2831
Note that the seed used for the random number generator is displayed
2832
when this option is used. The seed can be explicitly passed as the
2833
argument to this option if required. This enables reproduction of the
2834
actual ordering used if and when an order sensitive problem is encountered.
2836
If --list-only is given, the tests that would be run are listed. This is
2837
useful when combined with --first, --exclude and/or --randomize to
2838
understand their impact. The test harness reports "Listed nn tests in ..."
2839
instead of "Ran nn tests in ..." when list mode is enabled.
2841
If the global option '--no-plugins' is given, plugins are not loaded
2842
before running the selftests. This has two effects: features provided or
2843
modified by plugins will not be tested, and tests provided by plugins will
2846
Tests that need working space on disk use a common temporary directory,
2847
typically inside $TMPDIR or /tmp.
2850
Run only tests relating to 'ignore'::
2854
Disable plugins and list tests as they're run::
2856
bzr --no-plugins selftest -v
2858
# NB: this is used from the class without creating an instance, which is
2859
# why it does not have a self parameter.
2860
def get_transport_type(typestring):
2861
"""Parse and return a transport specifier."""
2862
if typestring == "sftp":
2863
from bzrlib.transport.sftp import SFTPAbsoluteServer
2864
return SFTPAbsoluteServer
2865
if typestring == "memory":
2866
from bzrlib.transport.memory import MemoryServer
2868
if typestring == "fakenfs":
2869
from bzrlib.transport.fakenfs import FakeNFSServer
2870
return FakeNFSServer
2871
msg = "No known transport type %s. Supported types are: sftp\n" %\
2873
raise errors.BzrCommandError(msg)
2876
takes_args = ['testspecs*']
2877
takes_options = ['verbose',
2879
help='Stop when one test fails.',
2883
help='Use a different transport by default '
2884
'throughout the test suite.',
2885
type=get_transport_type),
2887
help='Run the benchmarks rather than selftests.'),
2888
Option('lsprof-timed',
2889
help='Generate lsprof output for benchmarked'
2890
' sections of code.'),
2891
Option('cache-dir', type=str,
2892
help='Cache intermediate benchmark output in this '
2895
help='Run all tests, but run specified tests first.',
2899
help='List the tests instead of running them.'),
2900
Option('randomize', type=str, argname="SEED",
2901
help='Randomize the order of tests using the given'
2902
' seed or "now" for the current time.'),
2903
Option('exclude', type=str, argname="PATTERN",
2905
help='Exclude tests that match this regular'
2907
Option('strict', help='Fail on missing dependencies or '
2909
Option('load-list', type=str, argname='TESTLISTFILE',
2910
help='Load a test id list from a text file.'),
2911
ListOption('debugflag', type=str, short_name='E',
2912
help='Turn on a selftest debug flag.'),
2913
ListOption('starting-with', type=str, argname='TESTID',
2914
param_name='starting_with', short_name='s',
2916
'Load only the tests starting with TESTID.'),
2918
encoding_type = 'replace'
2920
def run(self, testspecs_list=None, verbose=False, one=False,
2921
transport=None, benchmark=None,
2922
lsprof_timed=None, cache_dir=None,
2923
first=False, list_only=False,
2924
randomize=None, exclude=None, strict=False,
2925
load_list=None, debugflag=None, starting_with=None):
2926
from bzrlib.tests import selftest
2927
import bzrlib.benchmarks as benchmarks
2928
from bzrlib.benchmarks import tree_creator
2930
# Make deprecation warnings visible, unless -Werror is set
2931
symbol_versioning.activate_deprecation_warnings(override=False)
2933
if cache_dir is not None:
2934
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2936
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2937
print ' %s (%s python%s)' % (
2939
bzrlib.version_string,
2940
bzrlib._format_version_tuple(sys.version_info),
2943
if testspecs_list is not None:
2944
pattern = '|'.join(testspecs_list)
2948
test_suite_factory = benchmarks.test_suite
2949
# Unless user explicitly asks for quiet, be verbose in benchmarks
2950
verbose = not is_quiet()
2951
# TODO: should possibly lock the history file...
2952
benchfile = open(".perf_history", "at", buffering=1)
2954
test_suite_factory = None
2957
result = selftest(verbose=verbose,
2959
stop_on_failure=one,
2960
transport=transport,
2961
test_suite_factory=test_suite_factory,
2962
lsprof_timed=lsprof_timed,
2963
bench_history=benchfile,
2964
matching_tests_first=first,
2965
list_only=list_only,
2966
random_seed=randomize,
2967
exclude_pattern=exclude,
2969
load_list=load_list,
2970
debug_flags=debugflag,
2971
starting_with=starting_with,
2974
if benchfile is not None:
2977
note('tests passed')
2979
note('tests failed')
2980
return int(not result)
2983
class cmd_version(Command):
2984
"""Show version of bzr."""
2986
encoding_type = 'replace'
2988
Option("short", help="Print just the version number."),
2992
def run(self, short=False):
2993
from bzrlib.version import show_version
2995
self.outf.write(bzrlib.version_string + '\n')
2997
show_version(to_file=self.outf)
3000
class cmd_rocks(Command):
3001
"""Statement of optimism."""
3007
print "It sure does!"
3010
class cmd_find_merge_base(Command):
3011
"""Find and print a base revision for merging two branches."""
3012
# TODO: Options to specify revisions on either side, as if
3013
# merging only part of the history.
3014
takes_args = ['branch', 'other']
3018
def run(self, branch, other):
3019
from bzrlib.revision import ensure_null
3021
branch1 = Branch.open_containing(branch)[0]
3022
branch2 = Branch.open_containing(other)[0]
3027
last1 = ensure_null(branch1.last_revision())
3028
last2 = ensure_null(branch2.last_revision())
3030
graph = branch1.repository.get_graph(branch2.repository)
3031
base_rev_id = graph.find_unique_lca(last1, last2)
3033
print 'merge base is revision %s' % base_rev_id
3040
class cmd_merge(Command):
3041
"""Perform a three-way merge.
3043
The source of the merge can be specified either in the form of a branch,
3044
or in the form of a path to a file containing a merge directive generated
3045
with bzr send. If neither is specified, the default is the upstream branch
3046
or the branch most recently merged using --remember.
3048
When merging a branch, by default the tip will be merged. To pick a different
3049
revision, pass --revision. If you specify two values, the first will be used as
3050
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3051
available revisions, like this is commonly referred to as "cherrypicking".
3053
Revision numbers are always relative to the branch being merged.
3055
By default, bzr will try to merge in all new work from the other
3056
branch, automatically determining an appropriate base. If this
3057
fails, you may need to give an explicit base.
3059
Merge will do its best to combine the changes in two branches, but there
3060
are some kinds of problems only a human can fix. When it encounters those,
3061
it will mark a conflict. A conflict means that you need to fix something,
3062
before you should commit.
3064
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3066
If there is no default branch set, the first merge will set it. After
3067
that, you can omit the branch to use the default. To change the
3068
default, use --remember. The value will only be saved if the remote
3069
location can be accessed.
3071
The results of the merge are placed into the destination working
3072
directory, where they can be reviewed (with bzr diff), tested, and then
3073
committed to record the result of the merge.
3075
merge refuses to run if there are any uncommitted changes, unless
3079
To merge the latest revision from bzr.dev::
3081
bzr merge ../bzr.dev
3083
To merge changes up to and including revision 82 from bzr.dev::
3085
bzr merge -r 82 ../bzr.dev
3087
To merge the changes introduced by 82, without previous changes::
3089
bzr merge -r 81..82 ../bzr.dev
3091
To apply a merge directive contained in in /tmp/merge:
3093
bzr merge /tmp/merge
3096
encoding_type = 'exact'
3097
_see_also = ['update', 'remerge', 'status-flags']
3098
takes_args = ['location?']
3103
help='Merge even if the destination tree has uncommitted changes.'),
3107
Option('show-base', help="Show base revision text in "
3109
Option('uncommitted', help='Apply uncommitted changes'
3110
' from a working copy, instead of branch changes.'),
3111
Option('pull', help='If the destination is already'
3112
' completely merged into the source, pull from the'
3113
' source rather than merging. When this happens,'
3114
' you do not need to commit the result.'),
3116
help='Branch to merge into, '
3117
'rather than the one containing the working directory.',
3121
Option('preview', help='Instead of merging, show a diff of the merge.')
3124
def run(self, location=None, revision=None, force=False,
3125
merge_type=None, show_base=False, reprocess=None, remember=False,
3126
uncommitted=False, pull=False,
3130
if merge_type is None:
3131
merge_type = _mod_merge.Merge3Merger
3133
if directory is None: directory = u'.'
3134
possible_transports = []
3136
allow_pending = True
3137
verified = 'inapplicable'
3138
tree = WorkingTree.open_containing(directory)[0]
3139
change_reporter = delta._ChangeReporter(
3140
unversioned_filter=tree.is_ignored)
3143
pb = ui.ui_factory.nested_progress_bar()
3144
cleanups.append(pb.finished)
3146
cleanups.append(tree.unlock)
3147
if location is not None:
3149
mergeable = bundle.read_mergeable_from_url(location,
3150
possible_transports=possible_transports)
3151
except errors.NotABundle:
3155
raise errors.BzrCommandError('Cannot use --uncommitted'
3156
' with bundles or merge directives.')
3158
if revision is not None:
3159
raise errors.BzrCommandError(
3160
'Cannot use -r with merge directives or bundles')
3161
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3164
if merger is None and uncommitted:
3165
if revision is not None and len(revision) > 0:
3166
raise errors.BzrCommandError('Cannot use --uncommitted and'
3167
' --revision at the same time.')
3168
location = self._select_branch_location(tree, location)[0]
3169
other_tree, other_path = WorkingTree.open_containing(location)
3170
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3172
allow_pending = False
3173
if other_path != '':
3174
merger.interesting_files = [other_path]
3177
merger, allow_pending = self._get_merger_from_branch(tree,
3178
location, revision, remember, possible_transports, pb)
3180
merger.merge_type = merge_type
3181
merger.reprocess = reprocess
3182
merger.show_base = show_base
3183
self.sanity_check_merger(merger)
3184
if (merger.base_rev_id == merger.other_rev_id and
3185
merger.other_rev_id is not None):
3186
note('Nothing to do.')
3189
if merger.interesting_files is not None:
3190
raise errors.BzrCommandError('Cannot pull individual files')
3191
if (merger.base_rev_id == tree.last_revision()):
3192
result = tree.pull(merger.other_branch, False,
3193
merger.other_rev_id)
3194
result.report(self.outf)
3196
merger.check_basis(not force)
3198
return self._do_preview(merger)
3200
return self._do_merge(merger, change_reporter, allow_pending,
3203
for cleanup in reversed(cleanups):
3206
def _do_preview(self, merger):
3207
from bzrlib.diff import show_diff_trees
3208
tree_merger = merger.make_merger()
3209
tt = tree_merger.make_preview_transform()
3211
result_tree = tt.get_preview_tree()
3212
show_diff_trees(merger.this_tree, result_tree, self.outf,
3213
old_label='', new_label='')
3217
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3218
merger.change_reporter = change_reporter
3219
conflict_count = merger.do_merge()
3221
merger.set_pending()
3222
if verified == 'failed':
3223
warning('Preview patch does not match changes')
3224
if conflict_count != 0:
3229
def sanity_check_merger(self, merger):
3230
if (merger.show_base and
3231
not merger.merge_type is _mod_merge.Merge3Merger):
3232
raise errors.BzrCommandError("Show-base is not supported for this"
3233
" merge type. %s" % merger.merge_type)
3234
if merger.reprocess is None:
3235
if merger.show_base:
3236
merger.reprocess = False
3238
# Use reprocess if the merger supports it
3239
merger.reprocess = merger.merge_type.supports_reprocess
3240
if merger.reprocess and not merger.merge_type.supports_reprocess:
3241
raise errors.BzrCommandError("Conflict reduction is not supported"
3242
" for merge type %s." %
3244
if merger.reprocess and merger.show_base:
3245
raise errors.BzrCommandError("Cannot do conflict reduction and"
3248
def _get_merger_from_branch(self, tree, location, revision, remember,
3249
possible_transports, pb):
3250
"""Produce a merger from a location, assuming it refers to a branch."""
3251
from bzrlib.tag import _merge_tags_if_possible
3252
# find the branch locations
3253
other_loc, user_location = self._select_branch_location(tree, location,
3255
if revision is not None and len(revision) == 2:
3256
base_loc, _unused = self._select_branch_location(tree,
3257
location, revision, 0)
3259
base_loc = other_loc
3261
other_branch, other_path = Branch.open_containing(other_loc,
3262
possible_transports)
3263
if base_loc == other_loc:
3264
base_branch = other_branch
3266
base_branch, base_path = Branch.open_containing(base_loc,
3267
possible_transports)
3268
# Find the revision ids
3269
if revision is None or len(revision) < 1 or revision[-1] is None:
3270
other_revision_id = _mod_revision.ensure_null(
3271
other_branch.last_revision())
3273
other_revision_id = revision[-1].as_revision_id(other_branch)
3274
if (revision is not None and len(revision) == 2
3275
and revision[0] is not None):
3276
base_revision_id = revision[0].as_revision_id(base_branch)
3278
base_revision_id = None
3279
# Remember where we merge from
3280
if ((remember or tree.branch.get_submit_branch() is None) and
3281
user_location is not None):
3282
tree.branch.set_submit_branch(other_branch.base)
3283
_merge_tags_if_possible(other_branch, tree.branch)
3284
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3285
other_revision_id, base_revision_id, other_branch, base_branch)
3286
if other_path != '':
3287
allow_pending = False
3288
merger.interesting_files = [other_path]
3290
allow_pending = True
3291
return merger, allow_pending
3293
def _select_branch_location(self, tree, user_location, revision=None,
3295
"""Select a branch location, according to possible inputs.
3297
If provided, branches from ``revision`` are preferred. (Both
3298
``revision`` and ``index`` must be supplied.)
3300
Otherwise, the ``location`` parameter is used. If it is None, then the
3301
``submit`` or ``parent`` location is used, and a note is printed.
3303
:param tree: The working tree to select a branch for merging into
3304
:param location: The location entered by the user
3305
:param revision: The revision parameter to the command
3306
:param index: The index to use for the revision parameter. Negative
3307
indices are permitted.
3308
:return: (selected_location, user_location). The default location
3309
will be the user-entered location.
3311
if (revision is not None and index is not None
3312
and revision[index] is not None):
3313
branch = revision[index].get_branch()
3314
if branch is not None:
3315
return branch, branch
3316
if user_location is None:
3317
location = self._get_remembered(tree, 'Merging from')
3319
location = user_location
3320
return location, user_location
3322
def _get_remembered(self, tree, verb_string):
3323
"""Use tree.branch's parent if none was supplied.
3325
Report if the remembered location was used.
3327
stored_location = tree.branch.get_submit_branch()
3328
stored_location_type = "submit"
3329
if stored_location is None:
3330
stored_location = tree.branch.get_parent()
3331
stored_location_type = "parent"
3332
mutter("%s", stored_location)
3333
if stored_location is None:
3334
raise errors.BzrCommandError("No location specified or remembered")
3335
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3336
note(u"%s remembered %s location %s", verb_string,
3337
stored_location_type, display_url)
3338
return stored_location
3341
class cmd_remerge(Command):
3344
Use this if you want to try a different merge technique while resolving
3345
conflicts. Some merge techniques are better than others, and remerge
3346
lets you try different ones on different files.
3348
The options for remerge have the same meaning and defaults as the ones for
3349
merge. The difference is that remerge can (only) be run when there is a
3350
pending merge, and it lets you specify particular files.
3353
Re-do the merge of all conflicted files, and show the base text in
3354
conflict regions, in addition to the usual THIS and OTHER texts::
3356
bzr remerge --show-base
3358
Re-do the merge of "foobar", using the weave merge algorithm, with
3359
additional processing to reduce the size of conflict regions::
3361
bzr remerge --merge-type weave --reprocess foobar
3363
takes_args = ['file*']
3368
help="Show base revision text in conflicts."),
3371
def run(self, file_list=None, merge_type=None, show_base=False,
3373
if merge_type is None:
3374
merge_type = _mod_merge.Merge3Merger
3375
tree, file_list = tree_files(file_list)
3378
parents = tree.get_parent_ids()
3379
if len(parents) != 2:
3380
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3381
" merges. Not cherrypicking or"
3383
repository = tree.branch.repository
3384
interesting_ids = None
3386
conflicts = tree.conflicts()
3387
if file_list is not None:
3388
interesting_ids = set()
3389
for filename in file_list:
3390
file_id = tree.path2id(filename)
3392
raise errors.NotVersionedError(filename)
3393
interesting_ids.add(file_id)
3394
if tree.kind(file_id) != "directory":
3397
for name, ie in tree.inventory.iter_entries(file_id):
3398
interesting_ids.add(ie.file_id)
3399
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3401
# Remerge only supports resolving contents conflicts
3402
allowed_conflicts = ('text conflict', 'contents conflict')
3403
restore_files = [c.path for c in conflicts
3404
if c.typestring in allowed_conflicts]
3405
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3406
tree.set_conflicts(ConflictList(new_conflicts))
3407
if file_list is not None:
3408
restore_files = file_list
3409
for filename in restore_files:
3411
restore(tree.abspath(filename))
3412
except errors.NotConflicted:
3414
# Disable pending merges, because the file texts we are remerging
3415
# have not had those merges performed. If we use the wrong parents
3416
# list, we imply that the working tree text has seen and rejected
3417
# all the changes from the other tree, when in fact those changes
3418
# have not yet been seen.
3419
pb = ui.ui_factory.nested_progress_bar()
3420
tree.set_parent_ids(parents[:1])
3422
merger = _mod_merge.Merger.from_revision_ids(pb,
3424
merger.interesting_ids = interesting_ids
3425
merger.merge_type = merge_type
3426
merger.show_base = show_base
3427
merger.reprocess = reprocess
3428
conflicts = merger.do_merge()
3430
tree.set_parent_ids(parents)
3440
class cmd_revert(Command):
3441
"""Revert files to a previous revision.
3443
Giving a list of files will revert only those files. Otherwise, all files
3444
will be reverted. If the revision is not specified with '--revision', the
3445
last committed revision is used.
3447
To remove only some changes, without reverting to a prior version, use
3448
merge instead. For example, "merge . --revision -2..-3" will remove the
3449
changes introduced by -2, without affecting the changes introduced by -1.
3450
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3452
By default, any files that have been manually changed will be backed up
3453
first. (Files changed only by merge are not backed up.) Backup files have
3454
'.~#~' appended to their name, where # is a number.
3456
When you provide files, you can use their current pathname or the pathname
3457
from the target revision. So you can use revert to "undelete" a file by
3458
name. If you name a directory, all the contents of that directory will be
3461
Any files that have been newly added since that revision will be deleted,
3462
with a backup kept if appropriate. Directories containing unknown files
3463
will not be deleted.
3465
The working tree contains a list of pending merged revisions, which will
3466
be included as parents in the next commit. Normally, revert clears that
3467
list as well as reverting the files. If any files are specified, revert
3468
leaves the pending merge list alone and reverts only the files. Use "bzr
3469
revert ." in the tree root to revert all files but keep the merge record,
3470
and "bzr revert --forget-merges" to clear the pending merge list without
3471
reverting any files.
3474
_see_also = ['cat', 'export']
3477
Option('no-backup', "Do not save backups of reverted files."),
3478
Option('forget-merges',
3479
'Remove pending merge marker, without changing any files.'),
3481
takes_args = ['file*']
3483
def run(self, revision=None, no_backup=False, file_list=None,
3484
forget_merges=None):
3485
tree, file_list = tree_files(file_list)
3489
tree.set_parent_ids(tree.get_parent_ids()[:1])
3491
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3496
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3497
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3498
pb = ui.ui_factory.nested_progress_bar()
3500
tree.revert(file_list, rev_tree, not no_backup, pb,
3501
report_changes=True)
3506
class cmd_assert_fail(Command):
3507
"""Test reporting of assertion failures"""
3508
# intended just for use in testing
3513
raise AssertionError("always fails")
3516
class cmd_help(Command):
3517
"""Show help on a command or other topic.
3520
_see_also = ['topics']
3522
Option('long', 'Show help on all commands.'),
3524
takes_args = ['topic?']
3525
aliases = ['?', '--help', '-?', '-h']
3528
def run(self, topic=None, long=False):
3530
if topic is None and long:
3532
bzrlib.help.help(topic)
3535
class cmd_shell_complete(Command):
3536
"""Show appropriate completions for context.
3538
For a list of all available commands, say 'bzr shell-complete'.
3540
takes_args = ['context?']
3545
def run(self, context=None):
3546
import shellcomplete
3547
shellcomplete.shellcomplete(context)
3550
class cmd_missing(Command):
3551
"""Show unmerged/unpulled revisions between two branches.
3553
OTHER_BRANCH may be local or remote.
3555
To filter on a range of revirions, you can use the command -r begin..end
3556
-r revision requests a specific revision, -r ..end or -r begin.. are
3561
Determine the missing revisions between this and the branch at the
3562
remembered pull location::
3566
Determine the missing revisions between this and another branch::
3568
bzr missing http://server/branch
3570
Determine the missing revisions up to a specific revision on the other
3573
bzr missing -r ..-10
3575
Determine the missing revisions up to a specific revision on this
3578
bzr missing --my-revision ..-10
3581
_see_also = ['merge', 'pull']
3582
takes_args = ['other_branch?']
3584
Option('reverse', 'Reverse the order of revisions.'),
3586
'Display changes in the local branch only.'),
3587
Option('this' , 'Same as --mine-only.'),
3588
Option('theirs-only',
3589
'Display changes in the remote branch only.'),
3590
Option('other', 'Same as --theirs-only.'),
3594
custom_help('revision',
3595
help='Filter on other branch revisions (inclusive). '
3596
'See "help revisionspec" for details.'),
3597
Option('my-revision',
3598
type=_parse_revision_str,
3599
help='Filter on local branch revisions (inclusive). '
3600
'See "help revisionspec" for details.'),
3601
Option('include-merges', 'Show merged revisions.'),
3603
encoding_type = 'replace'
3606
def run(self, other_branch=None, reverse=False, mine_only=False,
3608
log_format=None, long=False, short=False, line=False,
3609
show_ids=False, verbose=False, this=False, other=False,
3610
include_merges=False, revision=None, my_revision=None):
3611
from bzrlib.missing import find_unmerged, iter_log_revisions
3620
# TODO: We should probably check that we don't have mine-only and
3621
# theirs-only set, but it gets complicated because we also have
3622
# this and other which could be used.
3629
local_branch = Branch.open_containing(u".")[0]
3630
parent = local_branch.get_parent()
3631
if other_branch is None:
3632
other_branch = parent
3633
if other_branch is None:
3634
raise errors.BzrCommandError("No peer location known"
3636
display_url = urlutils.unescape_for_display(parent,
3638
message("Using saved parent location: "
3639
+ display_url + "\n")
3641
remote_branch = Branch.open(other_branch)
3642
if remote_branch.base == local_branch.base:
3643
remote_branch = local_branch
3645
local_revid_range = _revision_range_to_revid_range(
3646
_get_revision_range(my_revision, local_branch,
3649
remote_revid_range = _revision_range_to_revid_range(
3650
_get_revision_range(revision,
3651
remote_branch, self.name()))
3653
local_branch.lock_read()
3655
remote_branch.lock_read()
3657
local_extra, remote_extra = find_unmerged(
3658
local_branch, remote_branch, restrict,
3659
backward=not reverse,
3660
include_merges=include_merges,
3661
local_revid_range=local_revid_range,
3662
remote_revid_range=remote_revid_range)
3664
if log_format is None:
3665
registry = log.log_formatter_registry
3666
log_format = registry.get_default(local_branch)
3667
lf = log_format(to_file=self.outf,
3669
show_timezone='original')
3672
if local_extra and not theirs_only:
3673
message("You have %d extra revision(s):\n" %
3675
for revision in iter_log_revisions(local_extra,
3676
local_branch.repository,
3678
lf.log_revision(revision)
3679
printed_local = True
3682
printed_local = False
3684
if remote_extra and not mine_only:
3685
if printed_local is True:
3687
message("You are missing %d revision(s):\n" %
3689
for revision in iter_log_revisions(remote_extra,
3690
remote_branch.repository,
3692
lf.log_revision(revision)
3695
if mine_only and not local_extra:
3696
# We checked local, and found nothing extra
3697
message('This branch is up to date.\n')
3698
elif theirs_only and not remote_extra:
3699
# We checked remote, and found nothing extra
3700
message('Other branch is up to date.\n')
3701
elif not (mine_only or theirs_only or local_extra or
3703
# We checked both branches, and neither one had extra
3705
message("Branches are up to date.\n")
3707
remote_branch.unlock()
3709
local_branch.unlock()
3710
if not status_code and parent is None and other_branch is not None:
3711
local_branch.lock_write()
3713
# handle race conditions - a parent might be set while we run.
3714
if local_branch.get_parent() is None:
3715
local_branch.set_parent(remote_branch.base)
3717
local_branch.unlock()
3721
class cmd_pack(Command):
3722
"""Compress the data within a repository."""
3724
_see_also = ['repositories']
3725
takes_args = ['branch_or_repo?']
3727
def run(self, branch_or_repo='.'):
3728
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3730
branch = dir.open_branch()
3731
repository = branch.repository
3732
except errors.NotBranchError:
3733
repository = dir.open_repository()
3737
class cmd_plugins(Command):
3738
"""List the installed plugins.
3740
This command displays the list of installed plugins including
3741
version of plugin and a short description of each.
3743
--verbose shows the path where each plugin is located.
3745
A plugin is an external component for Bazaar that extends the
3746
revision control system, by adding or replacing code in Bazaar.
3747
Plugins can do a variety of things, including overriding commands,
3748
adding new commands, providing additional network transports and
3749
customizing log output.
3751
See the Bazaar web site, http://bazaar-vcs.org, for further
3752
information on plugins including where to find them and how to
3753
install them. Instructions are also provided there on how to
3754
write new plugins using the Python programming language.
3756
takes_options = ['verbose']
3759
def run(self, verbose=False):
3760
import bzrlib.plugin
3761
from inspect import getdoc
3763
for name, plugin in bzrlib.plugin.plugins().items():
3764
version = plugin.__version__
3765
if version == 'unknown':
3767
name_ver = '%s %s' % (name, version)
3768
d = getdoc(plugin.module)
3770
doc = d.split('\n')[0]
3772
doc = '(no description)'
3773
result.append((name_ver, doc, plugin.path()))
3774
for name_ver, doc, path in sorted(result):
3782
class cmd_testament(Command):
3783
"""Show testament (signing-form) of a revision."""
3786
Option('long', help='Produce long-format testament.'),
3788
help='Produce a strict-format testament.')]
3789
takes_args = ['branch?']
3791
def run(self, branch=u'.', revision=None, long=False, strict=False):
3792
from bzrlib.testament import Testament, StrictTestament
3794
testament_class = StrictTestament
3796
testament_class = Testament
3798
b = Branch.open_containing(branch)[0]
3800
b = Branch.open(branch)
3803
if revision is None:
3804
rev_id = b.last_revision()
3806
rev_id = revision[0].as_revision_id(b)
3807
t = testament_class.from_revision(b.repository, rev_id)
3809
sys.stdout.writelines(t.as_text_lines())
3811
sys.stdout.write(t.as_short_text())
3816
class cmd_annotate(Command):
3817
"""Show the origin of each line in a file.
3819
This prints out the given file with an annotation on the left side
3820
indicating which revision, author and date introduced the change.
3822
If the origin is the same for a run of consecutive lines, it is
3823
shown only at the top, unless the --all option is given.
3825
# TODO: annotate directories; showing when each file was last changed
3826
# TODO: if the working copy is modified, show annotations on that
3827
# with new uncommitted lines marked
3828
aliases = ['ann', 'blame', 'praise']
3829
takes_args = ['filename']
3830
takes_options = [Option('all', help='Show annotations on all lines.'),
3831
Option('long', help='Show commit date in annotations.'),
3835
encoding_type = 'exact'
3838
def run(self, filename, all=False, long=False, revision=None,
3840
from bzrlib.annotate import annotate_file, annotate_file_tree
3841
wt, branch, relpath = \
3842
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3848
tree = _get_one_revision_tree('annotate', revision, branch=branch)
3850
file_id = wt.path2id(relpath)
3852
file_id = tree.path2id(relpath)
3854
raise errors.NotVersionedError(filename)
3855
file_version = tree.inventory[file_id].revision
3856
if wt is not None and revision is None:
3857
# If there is a tree and we're not annotating historical
3858
# versions, annotate the working tree's content.
3859
annotate_file_tree(wt, file_id, self.outf, long, all,
3862
annotate_file(branch, file_version, file_id, long, all, self.outf,
3871
class cmd_re_sign(Command):
3872
"""Create a digital signature for an existing revision."""
3873
# TODO be able to replace existing ones.
3875
hidden = True # is this right ?
3876
takes_args = ['revision_id*']
3877
takes_options = ['revision']
3879
def run(self, revision_id_list=None, revision=None):
3880
if revision_id_list is not None and revision is not None:
3881
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3882
if revision_id_list is None and revision is None:
3883
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3884
b = WorkingTree.open_containing(u'.')[0].branch
3887
return self._run(b, revision_id_list, revision)
3891
def _run(self, b, revision_id_list, revision):
3892
import bzrlib.gpg as gpg
3893
gpg_strategy = gpg.GPGStrategy(b.get_config())
3894
if revision_id_list is not None:
3895
b.repository.start_write_group()
3897
for revision_id in revision_id_list:
3898
b.repository.sign_revision(revision_id, gpg_strategy)
3900
b.repository.abort_write_group()
3903
b.repository.commit_write_group()
3904
elif revision is not None:
3905
if len(revision) == 1:
3906
revno, rev_id = revision[0].in_history(b)
3907
b.repository.start_write_group()
3909
b.repository.sign_revision(rev_id, gpg_strategy)
3911
b.repository.abort_write_group()
3914
b.repository.commit_write_group()
3915
elif len(revision) == 2:
3916
# are they both on rh- if so we can walk between them
3917
# might be nice to have a range helper for arbitrary
3918
# revision paths. hmm.
3919
from_revno, from_revid = revision[0].in_history(b)
3920
to_revno, to_revid = revision[1].in_history(b)
3921
if to_revid is None:
3922
to_revno = b.revno()
3923
if from_revno is None or to_revno is None:
3924
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3925
b.repository.start_write_group()
3927
for revno in range(from_revno, to_revno + 1):
3928
b.repository.sign_revision(b.get_rev_id(revno),
3931
b.repository.abort_write_group()
3934
b.repository.commit_write_group()
3936
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3939
class cmd_bind(Command):
3940
"""Convert the current branch into a checkout of the supplied branch.
3942
Once converted into a checkout, commits must succeed on the master branch
3943
before they will be applied to the local branch.
3945
Bound branches use the nickname of its master branch unless it is set
3946
locally, in which case binding will update the the local nickname to be
3950
_see_also = ['checkouts', 'unbind']
3951
takes_args = ['location?']
3954
def run(self, location=None):
3955
b, relpath = Branch.open_containing(u'.')
3956
if location is None:
3958
location = b.get_old_bound_location()
3959
except errors.UpgradeRequired:
3960
raise errors.BzrCommandError('No location supplied. '
3961
'This format does not remember old locations.')
3963
if location is None:
3964
raise errors.BzrCommandError('No location supplied and no '
3965
'previous location known')
3966
b_other = Branch.open(location)
3969
except errors.DivergedBranches:
3970
raise errors.BzrCommandError('These branches have diverged.'
3971
' Try merging, and then bind again.')
3972
if b.get_config().has_explicit_nickname():
3973
b.nick = b_other.nick
3976
class cmd_unbind(Command):
3977
"""Convert the current checkout into a regular branch.
3979
After unbinding, the local branch is considered independent and subsequent
3980
commits will be local only.
3983
_see_also = ['checkouts', 'bind']
3988
b, relpath = Branch.open_containing(u'.')
3990
raise errors.BzrCommandError('Local branch is not bound')
3993
class cmd_uncommit(Command):
3994
"""Remove the last committed revision.
3996
--verbose will print out what is being removed.
3997
--dry-run will go through all the motions, but not actually
4000
If --revision is specified, uncommit revisions to leave the branch at the
4001
specified revision. For example, "bzr uncommit -r 15" will leave the
4002
branch at revision 15.
4004
Uncommit leaves the working tree ready for a new commit. The only change
4005
it may make is to restore any pending merges that were present before
4009
# TODO: jam 20060108 Add an option to allow uncommit to remove
4010
# unreferenced information in 'branch-as-repository' branches.
4011
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4012
# information in shared branches as well.
4013
_see_also = ['commit']
4014
takes_options = ['verbose', 'revision',
4015
Option('dry-run', help='Don\'t actually make changes.'),
4016
Option('force', help='Say yes to all questions.'),
4018
help="Only remove the commits from the local branch"
4019
" when in a checkout."
4022
takes_args = ['location?']
4024
encoding_type = 'replace'
4026
def run(self, location=None,
4027
dry_run=False, verbose=False,
4028
revision=None, force=False, local=False):
4029
if location is None:
4031
control, relpath = bzrdir.BzrDir.open_containing(location)
4033
tree = control.open_workingtree()
4035
except (errors.NoWorkingTree, errors.NotLocalUrl):
4037
b = control.open_branch()
4039
if tree is not None:
4044
return self._run(b, tree, dry_run, verbose, revision, force,
4047
if tree is not None:
4052
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4053
from bzrlib.log import log_formatter, show_log
4054
from bzrlib.uncommit import uncommit
4056
last_revno, last_rev_id = b.last_revision_info()
4059
if revision is None:
4061
rev_id = last_rev_id
4063
# 'bzr uncommit -r 10' actually means uncommit
4064
# so that the final tree is at revno 10.
4065
# but bzrlib.uncommit.uncommit() actually uncommits
4066
# the revisions that are supplied.
4067
# So we need to offset it by one
4068
revno = revision[0].in_history(b).revno + 1
4069
if revno <= last_revno:
4070
rev_id = b.get_rev_id(revno)
4072
if rev_id is None or _mod_revision.is_null(rev_id):
4073
self.outf.write('No revisions to uncommit.\n')
4076
lf = log_formatter('short',
4078
show_timezone='original')
4083
direction='forward',
4084
start_revision=revno,
4085
end_revision=last_revno)
4088
print 'Dry-run, pretending to remove the above revisions.'
4090
val = raw_input('Press <enter> to continue')
4092
print 'The above revision(s) will be removed.'
4094
val = raw_input('Are you sure [y/N]? ')
4095
if val.lower() not in ('y', 'yes'):
4099
mutter('Uncommitting from {%s} to {%s}',
4100
last_rev_id, rev_id)
4101
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4102
revno=revno, local=local)
4103
note('You can restore the old tip by running:\n'
4104
' bzr pull . -r revid:%s', last_rev_id)
4107
class cmd_break_lock(Command):
4108
"""Break a dead lock on a repository, branch or working directory.
4110
CAUTION: Locks should only be broken when you are sure that the process
4111
holding the lock has been stopped.
4113
You can get information on what locks are open via the 'bzr info' command.
4118
takes_args = ['location?']
4120
def run(self, location=None, show=False):
4121
if location is None:
4123
control, relpath = bzrdir.BzrDir.open_containing(location)
4125
control.break_lock()
4126
except NotImplementedError:
4130
class cmd_wait_until_signalled(Command):
4131
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4133
This just prints a line to signal when it is ready, then blocks on stdin.
4139
sys.stdout.write("running\n")
4141
sys.stdin.readline()
4144
class cmd_serve(Command):
4145
"""Run the bzr server."""
4147
aliases = ['server']
4151
help='Serve on stdin/out for use from inetd or sshd.'),
4153
help='Listen for connections on nominated port of the form '
4154
'[hostname:]portnumber. Passing 0 as the port number will '
4155
'result in a dynamically allocated port. The default port is '
4159
help='Serve contents of this directory.',
4161
Option('allow-writes',
4162
help='By default the server is a readonly server. Supplying '
4163
'--allow-writes enables write access to the contents of '
4164
'the served directory and below.'
4168
def run_smart_server(self, smart_server):
4169
"""Run 'smart_server' forever, with no UI output at all."""
4170
# For the duration of this server, no UI output is permitted. note
4171
# that this may cause problems with blackbox tests. This should be
4172
# changed with care though, as we dont want to use bandwidth sending
4173
# progress over stderr to smart server clients!
4174
from bzrlib import lockdir
4175
old_factory = ui.ui_factory
4176
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4178
ui.ui_factory = ui.SilentUIFactory()
4179
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4180
smart_server.serve()
4182
ui.ui_factory = old_factory
4183
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4185
def get_host_and_port(self, port):
4186
"""Return the host and port to run the smart server on.
4188
If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
4189
and port (`medium.BZR_DEFAULT_PORT`) will be used.
4191
If 'port' has a colon in it, the string before the colon will be
4192
interpreted as the host.
4194
:param port: A string of the port to run the server on.
4195
:return: A tuple of (host, port), where 'host' is a host name or IP,
4196
and port is an integer TCP/IP port.
4198
from bzrlib.smart import medium
4199
host = medium.BZR_DEFAULT_INTERFACE
4201
port = medium.BZR_DEFAULT_PORT
4204
host, port = port.split(':')
4208
def get_smart_server(self, transport, inet, port):
4209
"""Construct a smart server.
4211
:param transport: The base transport from which branches will be
4213
:param inet: If True, serve over stdin and stdout. Used for running
4215
:param port: The port to listen on. By default, it's `
4216
medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
4218
:return: A smart server.
4220
from bzrlib.smart import medium, server
4222
smart_server = medium.SmartServerPipeStreamMedium(
4223
sys.stdin, sys.stdout, transport)
4225
host, port = self.get_host_and_port(port)
4226
smart_server = server.SmartTCPServer(
4227
transport, host=host, port=port)
4228
note('listening on port: %s' % smart_server.port)
4231
def run(self, port=None, inet=False, directory=None, allow_writes=False):
4232
from bzrlib.transport import get_transport
4233
from bzrlib.transport.chroot import ChrootServer
4234
if directory is None:
4235
directory = os.getcwd()
4236
url = urlutils.local_path_to_url(directory)
4237
if not allow_writes:
4238
url = 'readonly+' + url
4239
chroot_server = ChrootServer(get_transport(url))
4240
chroot_server.setUp()
4241
t = get_transport(chroot_server.get_url())
4242
smart_server = self.get_smart_server(t, inet, port)
4243
self.run_smart_server(smart_server)
4246
class cmd_join(Command):
4247
"""Combine a subtree into its containing tree.
4249
This command is for experimental use only. It requires the target tree
4250
to be in dirstate-with-subtree format, which cannot be converted into
4253
The TREE argument should be an independent tree, inside another tree, but
4254
not part of it. (Such trees can be produced by "bzr split", but also by
4255
running "bzr branch" with the target inside a tree.)
4257
The result is a combined tree, with the subtree no longer an independant
4258
part. This is marked as a merge of the subtree into the containing tree,
4259
and all history is preserved.
4261
If --reference is specified, the subtree retains its independence. It can
4262
be branched by itself, and can be part of multiple projects at the same
4263
time. But operations performed in the containing tree, such as commit
4264
and merge, will recurse into the subtree.
4267
_see_also = ['split']
4268
takes_args = ['tree']
4270
Option('reference', help='Join by reference.'),
4274
def run(self, tree, reference=False):
4275
sub_tree = WorkingTree.open(tree)
4276
parent_dir = osutils.dirname(sub_tree.basedir)
4277
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4278
repo = containing_tree.branch.repository
4279
if not repo.supports_rich_root():
4280
raise errors.BzrCommandError(
4281
"Can't join trees because %s doesn't support rich root data.\n"
4282
"You can use bzr upgrade on the repository."
4286
containing_tree.add_reference(sub_tree)
4287
except errors.BadReferenceTarget, e:
4288
# XXX: Would be better to just raise a nicely printable
4289
# exception from the real origin. Also below. mbp 20070306
4290
raise errors.BzrCommandError("Cannot join %s. %s" %
4294
containing_tree.subsume(sub_tree)
4295
except errors.BadSubsumeSource, e:
4296
raise errors.BzrCommandError("Cannot join %s. %s" %
4300
class cmd_split(Command):
4301
"""Split a subdirectory of a tree into a separate tree.
4303
This command will produce a target tree in a format that supports
4304
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4305
converted into earlier formats like 'dirstate-tags'.
4307
The TREE argument should be a subdirectory of a working tree. That
4308
subdirectory will be converted into an independent tree, with its own
4309
branch. Commits in the top-level tree will not apply to the new subtree.
4312
# join is not un-hidden yet
4313
#_see_also = ['join']
4314
takes_args = ['tree']
4316
def run(self, tree):
4317
containing_tree, subdir = WorkingTree.open_containing(tree)
4318
sub_id = containing_tree.path2id(subdir)
4320
raise errors.NotVersionedError(subdir)
4322
containing_tree.extract(sub_id)
4323
except errors.RootNotRich:
4324
raise errors.UpgradeRequired(containing_tree.branch.base)
4327
class cmd_merge_directive(Command):
4328
"""Generate a merge directive for auto-merge tools.
4330
A directive requests a merge to be performed, and also provides all the
4331
information necessary to do so. This means it must either include a
4332
revision bundle, or the location of a branch containing the desired
4335
A submit branch (the location to merge into) must be supplied the first
4336
time the command is issued. After it has been supplied once, it will
4337
be remembered as the default.
4339
A public branch is optional if a revision bundle is supplied, but required
4340
if --diff or --plain is specified. It will be remembered as the default
4341
after the first use.
4344
takes_args = ['submit_branch?', 'public_branch?']
4348
_see_also = ['send']
4351
RegistryOption.from_kwargs('patch-type',
4352
'The type of patch to include in the directive.',
4354
value_switches=True,
4356
bundle='Bazaar revision bundle (default).',
4357
diff='Normal unified diff.',
4358
plain='No patch, just directive.'),
4359
Option('sign', help='GPG-sign the directive.'), 'revision',
4360
Option('mail-to', type=str,
4361
help='Instead of printing the directive, email to this address.'),
4362
Option('message', type=str, short_name='m',
4363
help='Message to use when committing this merge.')
4366
encoding_type = 'exact'
4368
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4369
sign=False, revision=None, mail_to=None, message=None):
4370
from bzrlib.revision import ensure_null, NULL_REVISION
4371
include_patch, include_bundle = {
4372
'plain': (False, False),
4373
'diff': (True, False),
4374
'bundle': (True, True),
4376
branch = Branch.open('.')
4377
stored_submit_branch = branch.get_submit_branch()
4378
if submit_branch is None:
4379
submit_branch = stored_submit_branch
4381
if stored_submit_branch is None:
4382
branch.set_submit_branch(submit_branch)
4383
if submit_branch is None:
4384
submit_branch = branch.get_parent()
4385
if submit_branch is None:
4386
raise errors.BzrCommandError('No submit branch specified or known')
4388
stored_public_branch = branch.get_public_branch()
4389
if public_branch is None:
4390
public_branch = stored_public_branch
4391
elif stored_public_branch is None:
4392
branch.set_public_branch(public_branch)
4393
if not include_bundle and public_branch is None:
4394
raise errors.BzrCommandError('No public branch specified or'
4396
base_revision_id = None
4397
if revision is not None:
4398
if len(revision) > 2:
4399
raise errors.BzrCommandError('bzr merge-directive takes '
4400
'at most two one revision identifiers')
4401
revision_id = revision[-1].as_revision_id(branch)
4402
if len(revision) == 2:
4403
base_revision_id = revision[0].as_revision_id(branch)
4405
revision_id = branch.last_revision()
4406
revision_id = ensure_null(revision_id)
4407
if revision_id == NULL_REVISION:
4408
raise errors.BzrCommandError('No revisions to bundle.')
4409
directive = merge_directive.MergeDirective2.from_objects(
4410
branch.repository, revision_id, time.time(),
4411
osutils.local_time_offset(), submit_branch,
4412
public_branch=public_branch, include_patch=include_patch,
4413
include_bundle=include_bundle, message=message,
4414
base_revision_id=base_revision_id)
4417
self.outf.write(directive.to_signed(branch))
4419
self.outf.writelines(directive.to_lines())
4421
message = directive.to_email(mail_to, branch, sign)
4422
s = SMTPConnection(branch.get_config())
4423
s.send_email(message)
4426
class cmd_send(Command):
4427
"""Mail or create a merge-directive for submitting changes.
4429
A merge directive provides many things needed for requesting merges:
4431
* A machine-readable description of the merge to perform
4433
* An optional patch that is a preview of the changes requested
4435
* An optional bundle of revision data, so that the changes can be applied
4436
directly from the merge directive, without retrieving data from a
4439
If --no-bundle is specified, then public_branch is needed (and must be
4440
up-to-date), so that the receiver can perform the merge using the
4441
public_branch. The public_branch is always included if known, so that
4442
people can check it later.
4444
The submit branch defaults to the parent, but can be overridden. Both
4445
submit branch and public branch will be remembered if supplied.
4447
If a public_branch is known for the submit_branch, that public submit
4448
branch is used in the merge instructions. This means that a local mirror
4449
can be used as your actual submit branch, once you have set public_branch
4452
Mail is sent using your preferred mail program. This should be transparent
4453
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4454
If the preferred client can't be found (or used), your editor will be used.
4456
To use a specific mail program, set the mail_client configuration option.
4457
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4458
specific clients are "claws", "evolution", "kmail", "mutt", and
4459
"thunderbird"; generic options are "default", "editor", "emacsclient",
4460
"mapi", and "xdg-email". Plugins may also add supported clients.
4462
If mail is being sent, a to address is required. This can be supplied
4463
either on the commandline, by setting the submit_to configuration
4464
option in the branch itself or the child_submit_to configuration option
4465
in the submit branch.
4467
Two formats are currently supported: "4" uses revision bundle format 4 and
4468
merge directive format 2. It is significantly faster and smaller than
4469
older formats. It is compatible with Bazaar 0.19 and later. It is the
4470
default. "0.9" uses revision bundle format 0.9 and merge directive
4471
format 1. It is compatible with Bazaar 0.12 - 0.18.
4473
Merge directives are applied using the merge command or the pull command.
4476
encoding_type = 'exact'
4478
_see_also = ['merge', 'pull']
4480
takes_args = ['submit_branch?', 'public_branch?']
4484
help='Do not include a bundle in the merge directive.'),
4485
Option('no-patch', help='Do not include a preview patch in the merge'
4488
help='Remember submit and public branch.'),
4490
help='Branch to generate the submission from, '
4491
'rather than the one containing the working directory.',
4494
Option('output', short_name='o',
4495
help='Write merge directive to this file; '
4496
'use - for stdout.',
4498
Option('mail-to', help='Mail the request to this address.',
4502
RegistryOption.from_kwargs('format',
4503
'Use the specified output format.',
4504
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4505
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4508
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4509
no_patch=False, revision=None, remember=False, output=None,
4510
format='4', mail_to=None, message=None, **kwargs):
4511
return self._run(submit_branch, revision, public_branch, remember,
4512
format, no_bundle, no_patch, output,
4513
kwargs.get('from', '.'), mail_to, message)
4515
def _run(self, submit_branch, revision, public_branch, remember, format,
4516
no_bundle, no_patch, output, from_, mail_to, message):
4517
from bzrlib.revision import NULL_REVISION
4518
branch = Branch.open_containing(from_)[0]
4520
outfile = cStringIO.StringIO()
4524
outfile = open(output, 'wb')
4525
# we may need to write data into branch's repository to calculate
4530
config = branch.get_config()
4532
mail_to = config.get_user_option('submit_to')
4533
mail_client = config.get_mail_client()
4534
if remember and submit_branch is None:
4535
raise errors.BzrCommandError(
4536
'--remember requires a branch to be specified.')
4537
stored_submit_branch = branch.get_submit_branch()
4538
remembered_submit_branch = None
4539
if submit_branch is None:
4540
submit_branch = stored_submit_branch
4541
remembered_submit_branch = "submit"
4543
if stored_submit_branch is None or remember:
4544
branch.set_submit_branch(submit_branch)
4545
if submit_branch is None:
4546
submit_branch = branch.get_parent()
4547
remembered_submit_branch = "parent"
4548
if submit_branch is None:
4549
raise errors.BzrCommandError('No submit branch known or'
4551
if remembered_submit_branch is not None:
4552
note('Using saved %s location "%s" to determine what '
4553
'changes to submit.', remembered_submit_branch,
4557
submit_config = Branch.open(submit_branch).get_config()
4558
mail_to = submit_config.get_user_option("child_submit_to")
4560
stored_public_branch = branch.get_public_branch()
4561
if public_branch is None:
4562
public_branch = stored_public_branch
4563
elif stored_public_branch is None or remember:
4564
branch.set_public_branch(public_branch)
4565
if no_bundle and public_branch is None:
4566
raise errors.BzrCommandError('No public branch specified or'
4568
base_revision_id = None
4570
if revision is not None:
4571
if len(revision) > 2:
4572
raise errors.BzrCommandError('bzr send takes '
4573
'at most two one revision identifiers')
4574
revision_id = revision[-1].as_revision_id(branch)
4575
if len(revision) == 2:
4576
base_revision_id = revision[0].as_revision_id(branch)
4577
if revision_id is None:
4578
revision_id = branch.last_revision()
4579
if revision_id == NULL_REVISION:
4580
raise errors.BzrCommandError('No revisions to submit.')
4582
directive = merge_directive.MergeDirective2.from_objects(
4583
branch.repository, revision_id, time.time(),
4584
osutils.local_time_offset(), submit_branch,
4585
public_branch=public_branch, include_patch=not no_patch,
4586
include_bundle=not no_bundle, message=message,
4587
base_revision_id=base_revision_id)
4588
elif format == '0.9':
4591
patch_type = 'bundle'
4593
raise errors.BzrCommandError('Format 0.9 does not'
4594
' permit bundle with no patch')
4600
directive = merge_directive.MergeDirective.from_objects(
4601
branch.repository, revision_id, time.time(),
4602
osutils.local_time_offset(), submit_branch,
4603
public_branch=public_branch, patch_type=patch_type,
4606
outfile.writelines(directive.to_lines())
4608
subject = '[MERGE] '
4609
if message is not None:
4612
revision = branch.repository.get_revision(revision_id)
4613
subject += revision.get_summary()
4614
basename = directive.get_disk_name(branch)
4615
mail_client.compose_merge_request(mail_to, subject,
4616
outfile.getvalue(), basename)
4623
class cmd_bundle_revisions(cmd_send):
4625
"""Create a merge-directive for submitting changes.
4627
A merge directive provides many things needed for requesting merges:
4629
* A machine-readable description of the merge to perform
4631
* An optional patch that is a preview of the changes requested
4633
* An optional bundle of revision data, so that the changes can be applied
4634
directly from the merge directive, without retrieving data from a
4637
If --no-bundle is specified, then public_branch is needed (and must be
4638
up-to-date), so that the receiver can perform the merge using the
4639
public_branch. The public_branch is always included if known, so that
4640
people can check it later.
4642
The submit branch defaults to the parent, but can be overridden. Both
4643
submit branch and public branch will be remembered if supplied.
4645
If a public_branch is known for the submit_branch, that public submit
4646
branch is used in the merge instructions. This means that a local mirror
4647
can be used as your actual submit branch, once you have set public_branch
4650
Two formats are currently supported: "4" uses revision bundle format 4 and
4651
merge directive format 2. It is significantly faster and smaller than
4652
older formats. It is compatible with Bazaar 0.19 and later. It is the
4653
default. "0.9" uses revision bundle format 0.9 and merge directive
4654
format 1. It is compatible with Bazaar 0.12 - 0.18.
4659
help='Do not include a bundle in the merge directive.'),
4660
Option('no-patch', help='Do not include a preview patch in the merge'
4663
help='Remember submit and public branch.'),
4665
help='Branch to generate the submission from, '
4666
'rather than the one containing the working directory.',
4669
Option('output', short_name='o', help='Write directive to this file.',
4672
RegistryOption.from_kwargs('format',
4673
'Use the specified output format.',
4674
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4675
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4677
aliases = ['bundle']
4679
_see_also = ['send', 'merge']
4683
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4684
no_patch=False, revision=None, remember=False, output=None,
4685
format='4', **kwargs):
4688
return self._run(submit_branch, revision, public_branch, remember,
4689
format, no_bundle, no_patch, output,
4690
kwargs.get('from', '.'), None, None)
4693
class cmd_tag(Command):
4694
"""Create, remove or modify a tag naming a revision.
4696
Tags give human-meaningful names to revisions. Commands that take a -r
4697
(--revision) option can be given -rtag:X, where X is any previously
4700
Tags are stored in the branch. Tags are copied from one branch to another
4701
along when you branch, push, pull or merge.
4703
It is an error to give a tag name that already exists unless you pass
4704
--force, in which case the tag is moved to point to the new revision.
4706
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4707
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4710
_see_also = ['commit', 'tags']
4711
takes_args = ['tag_name']
4714
help='Delete this tag rather than placing it.',
4717
help='Branch in which to place the tag.',
4722
help='Replace existing tags.',
4727
def run(self, tag_name,
4733
branch, relpath = Branch.open_containing(directory)
4737
branch.tags.delete_tag(tag_name)
4738
self.outf.write('Deleted tag %s.\n' % tag_name)
4741
if len(revision) != 1:
4742
raise errors.BzrCommandError(
4743
"Tags can only be placed on a single revision, "
4745
revision_id = revision[0].as_revision_id(branch)
4747
revision_id = branch.last_revision()
4748
if (not force) and branch.tags.has_tag(tag_name):
4749
raise errors.TagAlreadyExists(tag_name)
4750
branch.tags.set_tag(tag_name, revision_id)
4751
self.outf.write('Created tag %s.\n' % tag_name)
4756
class cmd_tags(Command):
4759
This command shows a table of tag names and the revisions they reference.
4765
help='Branch whose tags should be displayed.',
4769
RegistryOption.from_kwargs('sort',
4770
'Sort tags by different criteria.', title='Sorting',
4771
alpha='Sort tags lexicographically (default).',
4772
time='Sort tags chronologically.',
4785
branch, relpath = Branch.open_containing(directory)
4787
tags = branch.tags.get_tag_dict().items()
4794
graph = branch.repository.get_graph()
4795
rev1, rev2 = _get_revision_range(revision, branch, self.name())
4796
revid1, revid2 = rev1.rev_id, rev2.rev_id
4797
# only show revisions between revid1 and revid2 (inclusive)
4798
tags = [(tag, revid) for tag, revid in tags if
4799
graph.is_between(revid, revid1, revid2)]
4804
elif sort == 'time':
4806
for tag, revid in tags:
4808
revobj = branch.repository.get_revision(revid)
4809
except errors.NoSuchRevision:
4810
timestamp = sys.maxint # place them at the end
4812
timestamp = revobj.timestamp
4813
timestamps[revid] = timestamp
4814
tags.sort(key=lambda x: timestamps[x[1]])
4816
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4817
revno_map = branch.get_revision_id_to_revno_map()
4818
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4819
for tag, revid in tags ]
4820
for tag, revspec in tags:
4821
self.outf.write('%-20s %s\n' % (tag, revspec))
4824
class cmd_reconfigure(Command):
4825
"""Reconfigure the type of a bzr directory.
4827
A target configuration must be specified.
4829
For checkouts, the bind-to location will be auto-detected if not specified.
4830
The order of preference is
4831
1. For a lightweight checkout, the current bound location.
4832
2. For branches that used to be checkouts, the previously-bound location.
4833
3. The push location.
4834
4. The parent location.
4835
If none of these is available, --bind-to must be specified.
4838
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4839
takes_args = ['location?']
4840
takes_options = [RegistryOption.from_kwargs('target_type',
4841
title='Target type',
4842
help='The type to reconfigure the directory to.',
4843
value_switches=True, enum_switch=False,
4844
branch='Reconfigure to be an unbound branch '
4845
'with no working tree.',
4846
tree='Reconfigure to be an unbound branch '
4847
'with a working tree.',
4848
checkout='Reconfigure to be a bound branch '
4849
'with a working tree.',
4850
lightweight_checkout='Reconfigure to be a lightweight'
4851
' checkout (with no local history).',
4852
standalone='Reconfigure to be a standalone branch '
4853
'(i.e. stop using shared repository).',
4854
use_shared='Reconfigure to use a shared repository.'),
4855
Option('bind-to', help='Branch to bind checkout to.',
4858
help='Perform reconfiguration even if local changes'
4862
def run(self, location=None, target_type=None, bind_to=None, force=False):
4863
directory = bzrdir.BzrDir.open(location)
4864
if target_type is None:
4865
raise errors.BzrCommandError('No target configuration specified')
4866
elif target_type == 'branch':
4867
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4868
elif target_type == 'tree':
4869
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4870
elif target_type == 'checkout':
4871
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4873
elif target_type == 'lightweight-checkout':
4874
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4876
elif target_type == 'use-shared':
4877
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4878
elif target_type == 'standalone':
4879
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4880
reconfiguration.apply(force)
4883
class cmd_switch(Command):
4884
"""Set the branch of a checkout and update.
4886
For lightweight checkouts, this changes the branch being referenced.
4887
For heavyweight checkouts, this checks that there are no local commits
4888
versus the current bound branch, then it makes the local branch a mirror
4889
of the new location and binds to it.
4891
In both cases, the working tree is updated and uncommitted changes
4892
are merged. The user can commit or revert these as they desire.
4894
Pending merges need to be committed or reverted before using switch.
4896
The path to the branch to switch to can be specified relative to the parent
4897
directory of the current branch. For example, if you are currently in a
4898
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4901
Bound branches use the nickname of its master branch unless it is set
4902
locally, in which case switching will update the the local nickname to be
4906
takes_args = ['to_location']
4907
takes_options = [Option('force',
4908
help='Switch even if local commits will be lost.')
4911
def run(self, to_location, force=False):
4912
from bzrlib import switch
4914
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4915
branch = control_dir.open_branch()
4917
to_branch = Branch.open(to_location)
4918
except errors.NotBranchError:
4919
this_branch = control_dir.open_branch()
4920
# This may be a heavy checkout, where we want the master branch
4921
this_url = this_branch.get_bound_location()
4922
# If not, use a local sibling
4923
if this_url is None:
4924
this_url = this_branch.base
4925
to_branch = Branch.open(
4926
urlutils.join(this_url, '..', to_location))
4927
switch.switch(control_dir, to_branch, force)
4928
if branch.get_config().has_explicit_nickname():
4929
branch = control_dir.open_branch() #get the new branch!
4930
branch.nick = to_branch.nick
4931
note('Switched to branch: %s',
4932
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4935
class cmd_hooks(Command):
4936
"""Show a branch's currently registered hooks.
4940
takes_args = ['path?']
4942
def run(self, path=None):
4945
branch_hooks = Branch.open(path).hooks
4946
for hook_type in branch_hooks:
4947
hooks = branch_hooks[hook_type]
4948
self.outf.write("%s:\n" % (hook_type,))
4951
self.outf.write(" %s\n" %
4952
(branch_hooks.get_hook_name(hook),))
4954
self.outf.write(" <no hooks installed>\n")
4957
class cmd_shelve(Command):
4958
"""Temporarily set aside some changes from the current tree.
4960
Shelve allows you to temporarily put changes you've made "on the shelf",
4961
ie. out of the way, until a later time when you can bring them back from
4962
the shelf with the 'unshelve' command.
4964
If shelve --list is specified, previously-shelved changes are listed.
4966
Shelve is intended to help separate several sets of changes that have
4967
been inappropriately mingled. If you just want to get rid of all changes
4968
and you don't need to restore them later, use revert. If you want to
4969
shelve all text changes at once, use shelve --all.
4971
If filenames are specified, only the changes to those files will be
4972
shelved. Other files will be left untouched.
4974
If a revision is specified, changes since that revision will be shelved.
4976
You can put multiple items on the shelf, and by default, 'unshelve' will
4977
restore the most recently shelved changes.
4980
takes_args = ['file*']
4984
Option('all', help='Shelve all changes.'),
4986
RegistryOption('writer', 'Method to use for writing diffs.',
4987
bzrlib.option.diff_writer_registry,
4988
value_switches=True, enum_switch=False),
4990
Option('list', help='List shelved changes.'),
4992
_see_also = ['unshelve']
4994
def run(self, revision=None, all=False, file_list=None, message=None,
4995
writer=None, list=False):
4997
return self.run_for_list()
4998
from bzrlib.shelf_ui import Shelver
5000
writer = bzrlib.option.diff_writer_registry.get()
5002
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5004
except errors.UserAbort:
5007
def run_for_list(self):
5008
tree = WorkingTree.open_containing('.')[0]
5011
manager = tree.get_shelf_manager()
5012
shelves = manager.active_shelves()
5013
if len(shelves) == 0:
5014
note('No shelved changes.')
5016
for shelf_id in reversed(shelves):
5017
message = manager.get_metadata(shelf_id).get('message')
5019
message = '<no message>'
5020
self.outf.write('%3d: %s\n' % (shelf_id, message))
5026
class cmd_unshelve(Command):
5027
"""Restore shelved changes.
5029
By default, the most recently shelved changes are restored. However if you
5030
specify a patch by name those changes will be restored instead. This
5031
works best when the changes don't depend on each other.
5034
takes_args = ['shelf_id?']
5036
RegistryOption.from_kwargs(
5037
'action', help="The action to perform.",
5038
enum_switch=False, value_switches=True,
5039
apply="Apply changes and remove from the shelf.",
5040
dry_run="Show changes, but do not apply or remove them.",
5041
delete_only="Delete changes without applying them."
5044
_see_also = ['shelve']
5046
def run(self, shelf_id=None, action='apply'):
5047
from bzrlib.shelf_ui import Unshelver
5048
Unshelver.from_args(shelf_id, action).run()
5051
def _create_prefix(cur_transport):
5052
needed = [cur_transport]
5053
# Recurse upwards until we can create a directory successfully
5055
new_transport = cur_transport.clone('..')
5056
if new_transport.base == cur_transport.base:
5057
raise errors.BzrCommandError(
5058
"Failed to create path prefix for %s."
5059
% cur_transport.base)
5061
new_transport.mkdir('.')
5062
except errors.NoSuchFile:
5063
needed.append(new_transport)
5064
cur_transport = new_transport
5067
# Now we only need to create child directories
5069
cur_transport = needed.pop()
5070
cur_transport.ensure_base()
5073
# these get imported and then picked up by the scan for cmd_*
5074
# TODO: Some more consistent way to split command definitions across files;
5075
# we do need to load at least some information about them to know of
5076
# aliases. ideally we would avoid loading the implementation until the
5077
# details were needed.
5078
from bzrlib.cmd_version_info import cmd_version_info
5079
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5080
from bzrlib.bundle.commands import (
5083
from bzrlib.sign_my_commits import cmd_sign_my_commits
5084
from bzrlib.weave_commands import cmd_versionedfile_list, \
5085
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
