1
# Copyright (C) 2004, 2005, 2006, 2007, 2008 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
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 ListOption, Option, RegistryOption, custom_help
59
from bzrlib.trace import mutter, note, warning, is_quiet
62
def tree_files(file_list, default_branch=u'.'):
64
return internal_tree_files(file_list, default_branch)
65
except errors.FileInWrongBranch, e:
66
raise errors.BzrCommandError("%s is not in the same branch as %s" %
67
(e.path, file_list[0]))
70
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
75
rev_tree = tree.basis_tree()
77
rev_tree = branch.basis_tree()
79
if len(revisions) != 1:
80
raise errors.BzrCommandError(
81
'bzr %s --revision takes exactly one revision identifier' % (
83
rev_tree = revisions[0].as_tree(branch)
87
# XXX: Bad function name; should possibly also be a class method of
88
# WorkingTree rather than a function.
89
def internal_tree_files(file_list, default_branch=u'.'):
90
"""Convert command-line paths to a WorkingTree and relative paths.
92
This is typically used for command-line processors that take one or
93
more filenames, and infer the workingtree that contains them.
95
The filenames given are not required to exist.
97
:param file_list: Filenames to convert.
99
:param default_branch: Fallback tree path to use if file_list is empty or
102
:return: workingtree, [relative_paths]
104
if file_list is None or len(file_list) == 0:
105
return WorkingTree.open_containing(default_branch)[0], file_list
106
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
107
return tree, safe_relpath_files(tree, file_list)
110
def safe_relpath_files(tree, file_list):
111
"""Convert file_list into a list of relpaths in tree.
113
:param tree: A tree to operate on.
114
:param file_list: A list of user provided paths or None.
115
:return: A list of relative paths.
116
:raises errors.PathNotChild: When a provided path is in a different tree
119
if file_list is None:
122
for filename in file_list:
124
new_list.append(tree.relpath(osutils.dereference_path(filename)))
125
except errors.PathNotChild:
126
raise errors.FileInWrongBranch(tree.branch, filename)
130
# TODO: Make sure no commands unconditionally use the working directory as a
131
# branch. If a filename argument is used, the first of them should be used to
132
# specify the branch. (Perhaps this can be factored out into some kind of
133
# Argument class, representing a file in a branch, where the first occurrence
136
class cmd_status(Command):
137
"""Display status summary.
139
This reports on versioned and unknown files, reporting them
140
grouped by state. Possible states are:
143
Versioned in the working copy but not in the previous revision.
146
Versioned in the previous revision but removed or deleted
150
Path of this file changed from the previous revision;
151
the text may also have changed. This includes files whose
152
parent directory was renamed.
155
Text has changed since the previous revision.
158
File kind has been changed (e.g. from file to directory).
161
Not versioned and not matching an ignore pattern.
163
To see ignored files use 'bzr ignored'. For details on the
164
changes to file texts, use 'bzr diff'.
166
Note that --short or -S gives status flags for each item, similar
167
to Subversion's status command. To get output similar to svn -q,
170
If no arguments are specified, the status of the entire working
171
directory is shown. Otherwise, only the status of the specified
172
files or directories is reported. If a directory is given, status
173
is reported for everything inside that directory.
175
If a revision argument is given, the status is calculated against
176
that revision, or between two revisions if two are provided.
179
# TODO: --no-recurse, --recurse options
181
takes_args = ['file*']
182
takes_options = ['show-ids', 'revision', 'change',
183
Option('short', help='Use short status indicators.',
185
Option('versioned', help='Only show versioned files.',
187
Option('no-pending', help='Don\'t show pending merges.',
190
aliases = ['st', 'stat']
192
encoding_type = 'replace'
193
_see_also = ['diff', 'revert', 'status-flags']
196
def run(self, show_ids=False, file_list=None, revision=None, short=False,
197
versioned=False, no_pending=False):
198
from bzrlib.status import show_tree_status
200
if revision and len(revision) > 2:
201
raise errors.BzrCommandError('bzr status --revision takes exactly'
202
' one or two revision specifiers')
204
tree, relfile_list = tree_files(file_list)
205
# Avoid asking for specific files when that is not needed.
206
if relfile_list == ['']:
208
# Don't disable pending merges for full trees other than '.'.
209
if file_list == ['.']:
211
# A specific path within a tree was given.
212
elif relfile_list is not None:
214
show_tree_status(tree, show_ids=show_ids,
215
specific_files=relfile_list, revision=revision,
216
to_file=self.outf, short=short, versioned=versioned,
217
show_pending=(not no_pending))
220
class cmd_cat_revision(Command):
221
"""Write out metadata for a revision.
223
The revision to print can either be specified by a specific
224
revision identifier, or you can use --revision.
228
takes_args = ['revision_id?']
229
takes_options = ['revision']
230
# cat-revision is more for frontends so should be exact
234
def run(self, revision_id=None, revision=None):
235
if revision_id is not None and revision is not None:
236
raise errors.BzrCommandError('You can only supply one of'
237
' revision_id or --revision')
238
if revision_id is None and revision is None:
239
raise errors.BzrCommandError('You must supply either'
240
' --revision or a revision_id')
241
b = WorkingTree.open_containing(u'.')[0].branch
243
# TODO: jam 20060112 should cat-revision always output utf-8?
244
if revision_id is not None:
245
revision_id = osutils.safe_revision_id(revision_id, warn=False)
247
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
248
except errors.NoSuchRevision:
249
msg = "The repository %s contains no revision %s." % (b.repository.base,
251
raise errors.BzrCommandError(msg)
252
elif revision is not None:
255
raise errors.BzrCommandError('You cannot specify a NULL'
257
rev_id = rev.as_revision_id(b)
258
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
261
class cmd_dump_btree(Command):
262
"""Dump the contents of a btree index file to stdout.
264
PATH is a btree index file, it can be any URL. This includes things like
265
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
267
By default, the tuples stored in the index file will be displayed. With
268
--raw, we will uncompress the pages, but otherwise display the raw bytes
272
# TODO: Do we want to dump the internal nodes as well?
273
# TODO: It would be nice to be able to dump the un-parsed information,
274
# rather than only going through iter_all_entries. However, this is
275
# good enough for a start
277
encoding_type = 'exact'
278
takes_args = ['path']
279
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
280
' rather than the parsed tuples.'),
283
def run(self, path, raw=False):
284
dirname, basename = osutils.split(path)
285
t = transport.get_transport(dirname)
287
self._dump_raw_bytes(t, basename)
289
self._dump_entries(t, basename)
291
def _get_index_and_bytes(self, trans, basename):
292
"""Create a BTreeGraphIndex and raw bytes."""
293
bt = btree_index.BTreeGraphIndex(trans, basename, None)
294
bytes = trans.get_bytes(basename)
295
bt._file = cStringIO.StringIO(bytes)
296
bt._size = len(bytes)
299
def _dump_raw_bytes(self, trans, basename):
302
# We need to parse at least the root node.
303
# This is because the first page of every row starts with an
304
# uncompressed header.
305
bt, bytes = self._get_index_and_bytes(trans, basename)
306
for page_idx, page_start in enumerate(xrange(0, len(bytes),
307
btree_index._PAGE_SIZE)):
308
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
309
page_bytes = bytes[page_start:page_end]
311
self.outf.write('Root node:\n')
312
header_end, data = bt._parse_header_from_bytes(page_bytes)
313
self.outf.write(page_bytes[:header_end])
315
self.outf.write('\nPage %d\n' % (page_idx,))
316
decomp_bytes = zlib.decompress(page_bytes)
317
self.outf.write(decomp_bytes)
318
self.outf.write('\n')
320
def _dump_entries(self, trans, basename):
322
st = trans.stat(basename)
323
except errors.TransportNotPossible:
324
# We can't stat, so we'll fake it because we have to do the 'get()'
326
bt, _ = self._get_index_and_bytes(trans, basename)
328
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
329
for node in bt.iter_all_entries():
330
# Node is made up of:
331
# (index, key, value, [references])
332
self.outf.write('%s\n' % (node[1:],))
335
class cmd_remove_tree(Command):
336
"""Remove the working tree from a given branch/checkout.
338
Since a lightweight checkout is little more than a working tree
339
this will refuse to run against one.
341
To re-create the working tree, use "bzr checkout".
343
_see_also = ['checkout', 'working-trees']
344
takes_args = ['location?']
347
help='Remove the working tree even if it has '
348
'uncommitted changes.'),
351
def run(self, location='.', force=False):
352
d = bzrdir.BzrDir.open(location)
355
working = d.open_workingtree()
356
except errors.NoWorkingTree:
357
raise errors.BzrCommandError("No working tree to remove")
358
except errors.NotLocalUrl:
359
raise errors.BzrCommandError("You cannot remove the working tree of a "
362
changes = working.changes_from(working.basis_tree())
363
if changes.has_changed():
364
raise errors.UncommittedChanges(working)
366
working_path = working.bzrdir.root_transport.base
367
branch_path = working.branch.bzrdir.root_transport.base
368
if working_path != branch_path:
369
raise errors.BzrCommandError("You cannot remove the working tree from "
370
"a lightweight checkout")
372
d.destroy_workingtree()
375
class cmd_revno(Command):
376
"""Show current revision number.
378
This is equal to the number of revisions on this branch.
382
takes_args = ['location?']
385
def run(self, location=u'.'):
386
self.outf.write(str(Branch.open_containing(location)[0].revno()))
387
self.outf.write('\n')
390
class cmd_revision_info(Command):
391
"""Show revision number and revision id for a given revision identifier.
394
takes_args = ['revision_info*']
395
takes_options = ['revision']
398
def run(self, revision=None, revision_info_list=[]):
401
if revision is not None:
402
revs.extend(revision)
403
if revision_info_list is not None:
404
for rev in revision_info_list:
405
revs.append(RevisionSpec.from_string(rev))
407
b = Branch.open_containing(u'.')[0]
410
revs.append(RevisionSpec.from_string('-1'))
413
revision_id = rev.as_revision_id(b)
415
revno = '%4d' % (b.revision_id_to_revno(revision_id))
416
except errors.NoSuchRevision:
417
dotted_map = b.get_revision_id_to_revno_map()
418
revno = '.'.join(str(i) for i in dotted_map[revision_id])
419
print '%s %s' % (revno, revision_id)
422
class cmd_add(Command):
423
"""Add specified files or directories.
425
In non-recursive mode, all the named items are added, regardless
426
of whether they were previously ignored. A warning is given if
427
any of the named files are already versioned.
429
In recursive mode (the default), files are treated the same way
430
but the behaviour for directories is different. Directories that
431
are already versioned do not give a warning. All directories,
432
whether already versioned or not, are searched for files or
433
subdirectories that are neither versioned or ignored, and these
434
are added. This search proceeds recursively into versioned
435
directories. If no names are given '.' is assumed.
437
Therefore simply saying 'bzr add' will version all files that
438
are currently unknown.
440
Adding a file whose parent directory is not versioned will
441
implicitly add the parent, and so on up to the root. This means
442
you should never need to explicitly add a directory, they'll just
443
get added when you add a file in the directory.
445
--dry-run will show which files would be added, but not actually
448
--file-ids-from will try to use the file ids from the supplied path.
449
It looks up ids trying to find a matching parent directory with the
450
same filename, and then by pure path. This option is rarely needed
451
but can be useful when adding the same logical file into two
452
branches that will be merged later (without showing the two different
453
adds as a conflict). It is also useful when merging another project
454
into a subdirectory of this one.
456
takes_args = ['file*']
459
help="Don't recursively add the contents of directories."),
461
help="Show what would be done, but don't actually do anything."),
463
Option('file-ids-from',
465
help='Lookup file ids from this tree.'),
467
encoding_type = 'replace'
468
_see_also = ['remove']
470
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
475
if file_ids_from is not None:
477
base_tree, base_path = WorkingTree.open_containing(
479
except errors.NoWorkingTree:
480
base_branch, base_path = Branch.open_containing(
482
base_tree = base_branch.basis_tree()
484
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
485
to_file=self.outf, should_print=(not is_quiet()))
487
action = bzrlib.add.AddAction(to_file=self.outf,
488
should_print=(not is_quiet()))
491
base_tree.lock_read()
493
file_list = self._maybe_expand_globs(file_list)
495
tree = WorkingTree.open_containing(file_list[0])[0]
497
tree = WorkingTree.open_containing(u'.')[0]
498
added, ignored = tree.smart_add(file_list, not
499
no_recurse, action=action, save=not dry_run)
501
if base_tree is not None:
505
for glob in sorted(ignored.keys()):
506
for path in ignored[glob]:
507
self.outf.write("ignored %s matching \"%s\"\n"
511
for glob, paths in ignored.items():
512
match_len += len(paths)
513
self.outf.write("ignored %d file(s).\n" % match_len)
514
self.outf.write("If you wish to add some of these files,"
515
" please add them by name.\n")
518
class cmd_mkdir(Command):
519
"""Create a new versioned directory.
521
This is equivalent to creating the directory and then adding it.
524
takes_args = ['dir+']
525
encoding_type = 'replace'
527
def run(self, dir_list):
530
wt, dd = WorkingTree.open_containing(d)
532
self.outf.write('added %s\n' % d)
535
class cmd_relpath(Command):
536
"""Show path of a file relative to root"""
538
takes_args = ['filename']
542
def run(self, filename):
543
# TODO: jam 20050106 Can relpath return a munged path if
544
# sys.stdout encoding cannot represent it?
545
tree, relpath = WorkingTree.open_containing(filename)
546
self.outf.write(relpath)
547
self.outf.write('\n')
550
class cmd_inventory(Command):
551
"""Show inventory of the current working copy or a revision.
553
It is possible to limit the output to a particular entry
554
type using the --kind option. For example: --kind file.
556
It is also possible to restrict the list of files to a specific
557
set. For example: bzr inventory --show-ids this/file
566
help='List entries of a particular kind: file, directory, symlink.',
569
takes_args = ['file*']
572
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
573
if kind and kind not in ['file', 'directory', 'symlink']:
574
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
576
work_tree, file_list = tree_files(file_list)
577
work_tree.lock_read()
579
if revision is not None:
580
if len(revision) > 1:
581
raise errors.BzrCommandError(
582
'bzr inventory --revision takes exactly one revision'
584
tree = revision[0].as_tree(work_tree.branch)
586
extra_trees = [work_tree]
592
if file_list is not None:
593
file_ids = tree.paths2ids(file_list, trees=extra_trees,
594
require_versioned=True)
595
# find_ids_across_trees may include some paths that don't
597
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
598
for file_id in file_ids if file_id in tree)
600
entries = tree.inventory.entries()
603
if tree is not work_tree:
606
for path, entry in entries:
607
if kind and kind != entry.kind:
610
self.outf.write('%-50s %s\n' % (path, entry.file_id))
612
self.outf.write(path)
613
self.outf.write('\n')
616
class cmd_mv(Command):
617
"""Move or rename a file.
620
bzr mv OLDNAME NEWNAME
622
bzr mv SOURCE... DESTINATION
624
If the last argument is a versioned directory, all the other names
625
are moved into it. Otherwise, there must be exactly two arguments
626
and the file is changed to a new name.
628
If OLDNAME does not exist on the filesystem but is versioned and
629
NEWNAME does exist on the filesystem but is not versioned, mv
630
assumes that the file has been manually moved and only updates
631
its internal inventory to reflect that change.
632
The same is valid when moving many SOURCE files to a DESTINATION.
634
Files cannot be moved between branches.
637
takes_args = ['names*']
638
takes_options = [Option("after", help="Move only the bzr identifier"
639
" of the file, because the file has already been moved."),
641
aliases = ['move', 'rename']
642
encoding_type = 'replace'
644
def run(self, names_list, after=False):
645
if names_list is None:
648
if len(names_list) < 2:
649
raise errors.BzrCommandError("missing file argument")
650
tree, rel_names = tree_files(names_list)
653
self._run(tree, names_list, rel_names, after)
657
def _run(self, tree, names_list, rel_names, after):
658
into_existing = osutils.isdir(names_list[-1])
659
if into_existing and len(names_list) == 2:
661
# a. case-insensitive filesystem and change case of dir
662
# b. move directory after the fact (if the source used to be
663
# a directory, but now doesn't exist in the working tree
664
# and the target is an existing directory, just rename it)
665
if (not tree.case_sensitive
666
and rel_names[0].lower() == rel_names[1].lower()):
667
into_existing = False
670
from_id = tree.path2id(rel_names[0])
671
if (not osutils.lexists(names_list[0]) and
672
from_id and inv.get_file_kind(from_id) == "directory"):
673
into_existing = False
676
# move into existing directory
677
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
678
self.outf.write("%s => %s\n" % pair)
680
if len(names_list) != 2:
681
raise errors.BzrCommandError('to mv multiple files the'
682
' destination must be a versioned'
684
tree.rename_one(rel_names[0], rel_names[1], after=after)
685
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
688
class cmd_pull(Command):
689
"""Turn this branch into a mirror of another branch.
691
This command only works on branches that have not diverged. Branches are
692
considered diverged if the destination branch's most recent commit is one
693
that has not been merged (directly or indirectly) into the parent.
695
If branches have diverged, you can use 'bzr merge' to integrate the changes
696
from one into the other. Once one branch has merged, the other should
697
be able to pull it again.
699
If you want to forget your local changes and just update your branch to
700
match the remote one, use pull --overwrite.
702
If there is no default location set, the first pull will set it. After
703
that, you can omit the location to use the default. To change the
704
default, use --remember. The value will only be saved if the remote
705
location can be accessed.
707
Note: The location can be specified either in the form of a branch,
708
or in the form of a path to a file containing a merge directive generated
712
_see_also = ['push', 'update', 'status-flags']
713
takes_options = ['remember', 'overwrite', 'revision',
714
custom_help('verbose',
715
help='Show logs of pulled revisions.'),
717
help='Branch to pull into, '
718
'rather than the one containing the working directory.',
723
takes_args = ['location?']
724
encoding_type = 'replace'
726
def run(self, location=None, remember=False, overwrite=False,
727
revision=None, verbose=False,
729
# FIXME: too much stuff is in the command class
732
if directory is None:
735
tree_to = WorkingTree.open_containing(directory)[0]
736
branch_to = tree_to.branch
737
except errors.NoWorkingTree:
739
branch_to = Branch.open_containing(directory)[0]
741
possible_transports = []
742
if location is not None:
744
mergeable = bundle.read_mergeable_from_url(location,
745
possible_transports=possible_transports)
746
except errors.NotABundle:
749
stored_loc = branch_to.get_parent()
751
if stored_loc is None:
752
raise errors.BzrCommandError("No pull location known or"
755
display_url = urlutils.unescape_for_display(stored_loc,
758
self.outf.write("Using saved parent location: %s\n" % display_url)
759
location = stored_loc
761
if mergeable is not None:
762
if revision is not None:
763
raise errors.BzrCommandError(
764
'Cannot use -r with merge directives or bundles')
765
mergeable.install_revisions(branch_to.repository)
766
base_revision_id, revision_id, verified = \
767
mergeable.get_merge_request(branch_to.repository)
768
branch_from = branch_to
770
branch_from = Branch.open(location,
771
possible_transports=possible_transports)
773
if branch_to.get_parent() is None or remember:
774
branch_to.set_parent(branch_from.base)
776
if revision is not None:
777
if len(revision) == 1:
778
revision_id = revision[0].as_revision_id(branch_from)
780
raise errors.BzrCommandError(
781
'bzr pull --revision takes one value.')
783
branch_to.lock_write()
785
if tree_to is not None:
786
change_reporter = delta._ChangeReporter(
787
unversioned_filter=tree_to.is_ignored)
788
result = tree_to.pull(branch_from, overwrite, revision_id,
790
possible_transports=possible_transports)
792
result = branch_to.pull(branch_from, overwrite, revision_id)
794
result.report(self.outf)
795
if verbose and result.old_revid != result.new_revid:
797
branch_to.repository.iter_reverse_revision_history(
800
new_rh = branch_to.revision_history()
801
log.show_changed_revisions(branch_to, old_rh, new_rh,
807
class cmd_push(Command):
808
"""Update a mirror of this branch.
810
The target branch will not have its working tree populated because this
811
is both expensive, and is not supported on remote file systems.
813
Some smart servers or protocols *may* put the working tree in place in
816
This command only works on branches that have not diverged. Branches are
817
considered diverged if the destination branch's most recent commit is one
818
that has not been merged (directly or indirectly) by the source branch.
820
If branches have diverged, you can use 'bzr push --overwrite' to replace
821
the other branch completely, discarding its unmerged changes.
823
If you want to ensure you have the different changes in the other branch,
824
do a merge (see bzr help merge) from the other branch, and commit that.
825
After that you will be able to do a push without '--overwrite'.
827
If there is no default push location set, the first push will set it.
828
After that, you can omit the location to use the default. To change the
829
default, use --remember. The value will only be saved if the remote
830
location can be accessed.
833
_see_also = ['pull', 'update', 'working-trees']
834
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
835
Option('create-prefix',
836
help='Create the path leading up to the branch '
837
'if it does not already exist.'),
839
help='Branch to push from, '
840
'rather than the one containing the working directory.',
844
Option('use-existing-dir',
845
help='By default push will fail if the target'
846
' directory exists, but does not already'
847
' have a control directory. This flag will'
848
' allow push to proceed.'),
850
help='Create a stacked branch that references the public location '
851
'of the parent branch.'),
853
help='Create a stacked branch that refers to another branch '
854
'for the commit history. Only the work not present in the '
855
'referenced branch is included in the branch created.',
858
takes_args = ['location?']
859
encoding_type = 'replace'
861
def run(self, location=None, remember=False, overwrite=False,
862
create_prefix=False, verbose=False, revision=None,
863
use_existing_dir=False, directory=None, stacked_on=None,
865
from bzrlib.push import _show_push_branch
867
# Get the source branch and revision_id
868
if directory is None:
870
br_from = Branch.open_containing(directory)[0]
871
if revision is not None:
872
if len(revision) == 1:
873
revision_id = revision[0].in_history(br_from).rev_id
875
raise errors.BzrCommandError(
876
'bzr push --revision takes one value.')
878
revision_id = br_from.last_revision()
880
# Get the stacked_on branch, if any
881
if stacked_on is not None:
882
stacked_on = urlutils.normalize_url(stacked_on)
884
parent_url = br_from.get_parent()
886
parent = Branch.open(parent_url)
887
stacked_on = parent.get_public_branch()
889
# I considered excluding non-http url's here, thus forcing
890
# 'public' branches only, but that only works for some
891
# users, so it's best to just depend on the user spotting an
892
# error by the feedback given to them. RBC 20080227.
893
stacked_on = parent_url
895
raise errors.BzrCommandError(
896
"Could not determine branch to refer to.")
898
# Get the destination location
900
stored_loc = br_from.get_push_location()
901
if stored_loc is None:
902
raise errors.BzrCommandError(
903
"No push location known or specified.")
905
display_url = urlutils.unescape_for_display(stored_loc,
907
self.outf.write("Using saved push location: %s\n" % display_url)
908
location = stored_loc
910
_show_push_branch(br_from, revision_id, location, self.outf,
911
verbose=verbose, overwrite=overwrite, remember=remember,
912
stacked_on=stacked_on, create_prefix=create_prefix,
913
use_existing_dir=use_existing_dir)
916
class cmd_branch(Command):
917
"""Create a new copy of a branch.
919
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
920
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
921
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
922
is derived from the FROM_LOCATION by stripping a leading scheme or drive
923
identifier, if any. For example, "branch lp:foo-bar" will attempt to
926
To retrieve the branch as of a particular revision, supply the --revision
927
parameter, as in "branch foo/bar -r 5".
930
_see_also = ['checkout']
931
takes_args = ['from_location', 'to_location?']
932
takes_options = ['revision', Option('hardlink',
933
help='Hard-link working tree files where possible.'),
935
help='Create a stacked branch referring to the source branch. '
936
'The new branch will depend on the availability of the source '
937
'branch for all operations.'),
939
help='Do not use a shared repository, even if available.'),
941
aliases = ['get', 'clone']
943
def run(self, from_location, to_location=None, revision=None,
944
hardlink=False, stacked=False, standalone=False):
945
from bzrlib.tag import _merge_tags_if_possible
948
elif len(revision) > 1:
949
raise errors.BzrCommandError(
950
'bzr branch --revision takes exactly 1 revision value')
952
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
956
if len(revision) == 1 and revision[0] is not None:
957
revision_id = revision[0].as_revision_id(br_from)
959
# FIXME - wt.last_revision, fallback to branch, fall back to
960
# None or perhaps NULL_REVISION to mean copy nothing
962
revision_id = br_from.last_revision()
963
if to_location is None:
964
to_location = urlutils.derive_to_location(from_location)
965
to_transport = transport.get_transport(to_location)
967
to_transport.mkdir('.')
968
except errors.FileExists:
969
raise errors.BzrCommandError('Target directory "%s" already'
970
' exists.' % to_location)
971
except errors.NoSuchFile:
972
raise errors.BzrCommandError('Parent of "%s" does not exist.'
975
# preserve whatever source format we have.
976
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
977
possible_transports=[to_transport],
978
accelerator_tree=accelerator_tree,
979
hardlink=hardlink, stacked=stacked,
980
force_new_repo=standalone)
981
branch = dir.open_branch()
982
except errors.NoSuchRevision:
983
to_transport.delete_tree('.')
984
msg = "The branch %s has no revision %s." % (from_location,
986
raise errors.BzrCommandError(msg)
987
_merge_tags_if_possible(br_from, branch)
988
# If the source branch is stacked, the new branch may
989
# be stacked whether we asked for that explicitly or not.
990
# We therefore need a try/except here and not just 'if stacked:'
992
note('Created new stacked branch referring to %s.' %
993
branch.get_stacked_on_url())
994
except (errors.NotStacked, errors.UnstackableBranchFormat,
995
errors.UnstackableRepositoryFormat), e:
996
note('Branched %d revision(s).' % branch.revno())
1001
class cmd_checkout(Command):
1002
"""Create a new checkout of an existing branch.
1004
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1005
the branch found in '.'. This is useful if you have removed the working tree
1006
or if it was never created - i.e. if you pushed the branch to its current
1007
location using SFTP.
1009
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1010
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1011
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1012
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1013
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1016
To retrieve the branch as of a particular revision, supply the --revision
1017
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1018
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1022
_see_also = ['checkouts', 'branch']
1023
takes_args = ['branch_location?', 'to_location?']
1024
takes_options = ['revision',
1025
Option('lightweight',
1026
help="Perform a lightweight checkout. Lightweight "
1027
"checkouts depend on access to the branch for "
1028
"every operation. Normal checkouts can perform "
1029
"common operations like diff and status without "
1030
"such access, and also support local commits."
1032
Option('files-from', type=str,
1033
help="Get file contents from this tree."),
1035
help='Hard-link working tree files where possible.'
1040
def run(self, branch_location=None, to_location=None, revision=None,
1041
lightweight=False, files_from=None, hardlink=False):
1042
if revision is None:
1044
elif len(revision) > 1:
1045
raise errors.BzrCommandError(
1046
'bzr checkout --revision takes exactly 1 revision value')
1047
if branch_location is None:
1048
branch_location = osutils.getcwd()
1049
to_location = branch_location
1050
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1052
if files_from is not None:
1053
accelerator_tree = WorkingTree.open(files_from)
1054
if len(revision) == 1 and revision[0] is not None:
1055
revision_id = revision[0].as_revision_id(source)
1058
if to_location is None:
1059
to_location = urlutils.derive_to_location(branch_location)
1060
# if the source and to_location are the same,
1061
# and there is no working tree,
1062
# then reconstitute a branch
1063
if (osutils.abspath(to_location) ==
1064
osutils.abspath(branch_location)):
1066
source.bzrdir.open_workingtree()
1067
except errors.NoWorkingTree:
1068
source.bzrdir.create_workingtree(revision_id)
1070
source.create_checkout(to_location, revision_id, lightweight,
1071
accelerator_tree, hardlink)
1074
class cmd_renames(Command):
1075
"""Show list of renamed files.
1077
# TODO: Option to show renames between two historical versions.
1079
# TODO: Only show renames under dir, rather than in the whole branch.
1080
_see_also = ['status']
1081
takes_args = ['dir?']
1084
def run(self, dir=u'.'):
1085
tree = WorkingTree.open_containing(dir)[0]
1088
new_inv = tree.inventory
1089
old_tree = tree.basis_tree()
1090
old_tree.lock_read()
1092
old_inv = old_tree.inventory
1094
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1095
for f, paths, c, v, p, n, k, e in iterator:
1096
if paths[0] == paths[1]:
1100
renames.append(paths)
1102
for old_name, new_name in renames:
1103
self.outf.write("%s => %s\n" % (old_name, new_name))
1110
class cmd_update(Command):
1111
"""Update a tree to have the latest code committed to its branch.
1113
This will perform a merge into the working tree, and may generate
1114
conflicts. If you have any local changes, you will still
1115
need to commit them after the update for the update to be complete.
1117
If you want to discard your local changes, you can just do a
1118
'bzr revert' instead of 'bzr commit' after the update.
1121
_see_also = ['pull', 'working-trees', 'status-flags']
1122
takes_args = ['dir?']
1125
def run(self, dir='.'):
1126
tree = WorkingTree.open_containing(dir)[0]
1127
possible_transports = []
1128
master = tree.branch.get_master_branch(
1129
possible_transports=possible_transports)
1130
if master is not None:
1133
tree.lock_tree_write()
1135
existing_pending_merges = tree.get_parent_ids()[1:]
1136
last_rev = _mod_revision.ensure_null(tree.last_revision())
1137
if last_rev == _mod_revision.ensure_null(
1138
tree.branch.last_revision()):
1139
# may be up to date, check master too.
1140
if master is None or last_rev == _mod_revision.ensure_null(
1141
master.last_revision()):
1142
revno = tree.branch.revision_id_to_revno(last_rev)
1143
note("Tree is up to date at revision %d." % (revno,))
1145
conflicts = tree.update(
1146
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1147
possible_transports=possible_transports)
1148
revno = tree.branch.revision_id_to_revno(
1149
_mod_revision.ensure_null(tree.last_revision()))
1150
note('Updated to revision %d.' % (revno,))
1151
if tree.get_parent_ids()[1:] != existing_pending_merges:
1152
note('Your local commits will now show as pending merges with '
1153
"'bzr status', and can be committed with 'bzr commit'.")
1162
class cmd_info(Command):
1163
"""Show information about a working tree, branch or repository.
1165
This command will show all known locations and formats associated to the
1166
tree, branch or repository. Statistical information is included with
1169
Branches and working trees will also report any missing revisions.
1171
_see_also = ['revno', 'working-trees', 'repositories']
1172
takes_args = ['location?']
1173
takes_options = ['verbose']
1174
encoding_type = 'replace'
1177
def run(self, location=None, verbose=False):
1182
from bzrlib.info import show_bzrdir_info
1183
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1184
verbose=noise_level, outfile=self.outf)
1187
class cmd_remove(Command):
1188
"""Remove files or directories.
1190
This makes bzr stop tracking changes to the specified files. bzr will delete
1191
them if they can easily be recovered using revert. If no options or
1192
parameters are given bzr will scan for files that are being tracked by bzr
1193
but missing in your tree and stop tracking them for you.
1195
takes_args = ['file*']
1196
takes_options = ['verbose',
1197
Option('new', help='Only remove files that have never been committed.'),
1198
RegistryOption.from_kwargs('file-deletion-strategy',
1199
'The file deletion mode to be used.',
1200
title='Deletion Strategy', value_switches=True, enum_switch=False,
1201
safe='Only delete files if they can be'
1202
' safely recovered (default).',
1203
keep="Don't delete any files.",
1204
force='Delete all the specified files, even if they can not be '
1205
'recovered and even if they are non-empty directories.')]
1206
aliases = ['rm', 'del']
1207
encoding_type = 'replace'
1209
def run(self, file_list, verbose=False, new=False,
1210
file_deletion_strategy='safe'):
1211
tree, file_list = tree_files(file_list)
1213
if file_list is not None:
1214
file_list = [f for f in file_list]
1218
# Heuristics should probably all move into tree.remove_smart or
1221
added = tree.changes_from(tree.basis_tree(),
1222
specific_files=file_list).added
1223
file_list = sorted([f[0] for f in added], reverse=True)
1224
if len(file_list) == 0:
1225
raise errors.BzrCommandError('No matching files.')
1226
elif file_list is None:
1227
# missing files show up in iter_changes(basis) as
1228
# versioned-with-no-kind.
1230
for change in tree.iter_changes(tree.basis_tree()):
1231
# Find paths in the working tree that have no kind:
1232
if change[1][1] is not None and change[6][1] is None:
1233
missing.append(change[1][1])
1234
file_list = sorted(missing, reverse=True)
1235
file_deletion_strategy = 'keep'
1236
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1237
keep_files=file_deletion_strategy=='keep',
1238
force=file_deletion_strategy=='force')
1243
class cmd_file_id(Command):
1244
"""Print file_id of a particular file or directory.
1246
The file_id is assigned when the file is first added and remains the
1247
same through all revisions where the file exists, even when it is
1252
_see_also = ['inventory', 'ls']
1253
takes_args = ['filename']
1256
def run(self, filename):
1257
tree, relpath = WorkingTree.open_containing(filename)
1258
i = tree.path2id(relpath)
1260
raise errors.NotVersionedError(filename)
1262
self.outf.write(i + '\n')
1265
class cmd_file_path(Command):
1266
"""Print path of file_ids to a file or directory.
1268
This prints one line for each directory down to the target,
1269
starting at the branch root.
1273
takes_args = ['filename']
1276
def run(self, filename):
1277
tree, relpath = WorkingTree.open_containing(filename)
1278
fid = tree.path2id(relpath)
1280
raise errors.NotVersionedError(filename)
1281
segments = osutils.splitpath(relpath)
1282
for pos in range(1, len(segments) + 1):
1283
path = osutils.joinpath(segments[:pos])
1284
self.outf.write("%s\n" % tree.path2id(path))
1287
class cmd_reconcile(Command):
1288
"""Reconcile bzr metadata in a branch.
1290
This can correct data mismatches that may have been caused by
1291
previous ghost operations or bzr upgrades. You should only
1292
need to run this command if 'bzr check' or a bzr developer
1293
advises you to run it.
1295
If a second branch is provided, cross-branch reconciliation is
1296
also attempted, which will check that data like the tree root
1297
id which was not present in very early bzr versions is represented
1298
correctly in both branches.
1300
At the same time it is run it may recompress data resulting in
1301
a potential saving in disk space or performance gain.
1303
The branch *MUST* be on a listable system such as local disk or sftp.
1306
_see_also = ['check']
1307
takes_args = ['branch?']
1309
def run(self, branch="."):
1310
from bzrlib.reconcile import reconcile
1311
dir = bzrdir.BzrDir.open(branch)
1315
class cmd_revision_history(Command):
1316
"""Display the list of revision ids on a branch."""
1319
takes_args = ['location?']
1324
def run(self, location="."):
1325
branch = Branch.open_containing(location)[0]
1326
for revid in branch.revision_history():
1327
self.outf.write(revid)
1328
self.outf.write('\n')
1331
class cmd_ancestry(Command):
1332
"""List all revisions merged into this branch."""
1334
_see_also = ['log', 'revision-history']
1335
takes_args = ['location?']
1340
def run(self, location="."):
1342
wt = WorkingTree.open_containing(location)[0]
1343
except errors.NoWorkingTree:
1344
b = Branch.open(location)
1345
last_revision = b.last_revision()
1348
last_revision = wt.last_revision()
1350
revision_ids = b.repository.get_ancestry(last_revision)
1352
for revision_id in revision_ids:
1353
self.outf.write(revision_id + '\n')
1356
class cmd_init(Command):
1357
"""Make a directory into a versioned branch.
1359
Use this to create an empty branch, or before importing an
1362
If there is a repository in a parent directory of the location, then
1363
the history of the branch will be stored in the repository. Otherwise
1364
init creates a standalone branch which carries its own history
1365
in the .bzr directory.
1367
If there is already a branch at the location but it has no working tree,
1368
the tree can be populated with 'bzr checkout'.
1370
Recipe for importing a tree of files::
1376
bzr commit -m "imported project"
1379
_see_also = ['init-repository', 'branch', 'checkout']
1380
takes_args = ['location?']
1382
Option('create-prefix',
1383
help='Create the path leading up to the branch '
1384
'if it does not already exist.'),
1385
RegistryOption('format',
1386
help='Specify a format for this branch. '
1387
'See "help formats".',
1388
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1389
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1390
value_switches=True,
1391
title="Branch Format",
1393
Option('append-revisions-only',
1394
help='Never change revnos or the existing log.'
1395
' Append revisions to it only.')
1397
def run(self, location=None, format=None, append_revisions_only=False,
1398
create_prefix=False):
1400
format = bzrdir.format_registry.make_bzrdir('default')
1401
if location is None:
1404
to_transport = transport.get_transport(location)
1406
# The path has to exist to initialize a
1407
# branch inside of it.
1408
# Just using os.mkdir, since I don't
1409
# believe that we want to create a bunch of
1410
# locations if the user supplies an extended path
1412
to_transport.ensure_base()
1413
except errors.NoSuchFile:
1414
if not create_prefix:
1415
raise errors.BzrCommandError("Parent directory of %s"
1417
"\nYou may supply --create-prefix to create all"
1418
" leading parent directories."
1420
_create_prefix(to_transport)
1423
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1424
except errors.NotBranchError:
1425
# really a NotBzrDir error...
1426
create_branch = bzrdir.BzrDir.create_branch_convenience
1427
branch = create_branch(to_transport.base, format=format,
1428
possible_transports=[to_transport])
1429
a_bzrdir = branch.bzrdir
1431
from bzrlib.transport.local import LocalTransport
1432
if a_bzrdir.has_branch():
1433
if (isinstance(to_transport, LocalTransport)
1434
and not a_bzrdir.has_workingtree()):
1435
raise errors.BranchExistsWithoutWorkingTree(location)
1436
raise errors.AlreadyBranchError(location)
1437
branch = a_bzrdir.create_branch()
1438
a_bzrdir.create_workingtree()
1439
if append_revisions_only:
1441
branch.set_append_revisions_only(True)
1442
except errors.UpgradeRequired:
1443
raise errors.BzrCommandError('This branch format cannot be set'
1444
' to append-revisions-only. Try --experimental-branch6')
1446
from bzrlib.info import show_bzrdir_info
1447
show_bzrdir_info(a_bzrdir, verbose=0, outfile=self.outf)
1450
class cmd_init_repository(Command):
1451
"""Create a shared repository to hold branches.
1453
New branches created under the repository directory will store their
1454
revisions in the repository, not in the branch directory.
1456
If the --no-trees option is used then the branches in the repository
1457
will not have working trees by default.
1460
Create a shared repositories holding just branches::
1462
bzr init-repo --no-trees repo
1465
Make a lightweight checkout elsewhere::
1467
bzr checkout --lightweight repo/trunk trunk-checkout
1472
_see_also = ['init', 'branch', 'checkout', 'repositories']
1473
takes_args = ["location"]
1474
takes_options = [RegistryOption('format',
1475
help='Specify a format for this repository. See'
1476
' "bzr help formats" for details.',
1477
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1478
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1479
value_switches=True, title='Repository format'),
1481
help='Branches in the repository will default to'
1482
' not having a working tree.'),
1484
aliases = ["init-repo"]
1486
def run(self, location, format=None, no_trees=False):
1488
format = bzrdir.format_registry.make_bzrdir('default')
1490
if location is None:
1493
to_transport = transport.get_transport(location)
1494
to_transport.ensure_base()
1496
newdir = format.initialize_on_transport(to_transport)
1497
repo = newdir.create_repository(shared=True)
1498
repo.set_make_working_trees(not no_trees)
1500
from bzrlib.info import show_bzrdir_info
1501
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1504
class cmd_diff(Command):
1505
"""Show differences in the working tree, between revisions or branches.
1507
If no arguments are given, all changes for the current tree are listed.
1508
If files are given, only the changes in those files are listed.
1509
Remote and multiple branches can be compared by using the --old and
1510
--new options. If not provided, the default for both is derived from
1511
the first argument, if any, or the current tree if no arguments are
1514
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1515
produces patches suitable for "patch -p1".
1519
2 - unrepresentable changes
1524
Shows the difference in the working tree versus the last commit::
1528
Difference between the working tree and revision 1::
1532
Difference between revision 2 and revision 1::
1536
Difference between revision 2 and revision 1 for branch xxx::
1540
Show just the differences for file NEWS::
1544
Show the differences in working tree xxx for file NEWS::
1548
Show the differences from branch xxx to this working tree:
1552
Show the differences between two branches for file NEWS::
1554
bzr diff --old xxx --new yyy NEWS
1556
Same as 'bzr diff' but prefix paths with old/ and new/::
1558
bzr diff --prefix old/:new/
1560
_see_also = ['status']
1561
takes_args = ['file*']
1563
Option('diff-options', type=str,
1564
help='Pass these options to the external diff program.'),
1565
Option('prefix', type=str,
1567
help='Set prefixes added to old and new filenames, as '
1568
'two values separated by a colon. (eg "old/:new/").'),
1570
help='Branch/tree to compare from.',
1574
help='Branch/tree to compare to.',
1580
help='Use this command to compare files.',
1584
aliases = ['di', 'dif']
1585
encoding_type = 'exact'
1588
def run(self, revision=None, file_list=None, diff_options=None,
1589
prefix=None, old=None, new=None, using=None):
1590
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1592
if (prefix is None) or (prefix == '0'):
1600
old_label, new_label = prefix.split(":")
1602
raise errors.BzrCommandError(
1603
'--prefix expects two values separated by a colon'
1604
' (eg "old/:new/")')
1606
if revision and len(revision) > 2:
1607
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1608
' one or two revision specifiers')
1610
old_tree, new_tree, specific_files, extra_trees = \
1611
_get_trees_to_diff(file_list, revision, old, new)
1612
return show_diff_trees(old_tree, new_tree, sys.stdout,
1613
specific_files=specific_files,
1614
external_diff_options=diff_options,
1615
old_label=old_label, new_label=new_label,
1616
extra_trees=extra_trees, using=using)
1619
class cmd_deleted(Command):
1620
"""List files deleted in the working tree.
1622
# TODO: Show files deleted since a previous revision, or
1623
# between two revisions.
1624
# TODO: Much more efficient way to do this: read in new
1625
# directories with readdir, rather than stating each one. Same
1626
# level of effort but possibly much less IO. (Or possibly not,
1627
# if the directories are very large...)
1628
_see_also = ['status', 'ls']
1629
takes_options = ['show-ids']
1632
def run(self, show_ids=False):
1633
tree = WorkingTree.open_containing(u'.')[0]
1636
old = tree.basis_tree()
1639
for path, ie in old.inventory.iter_entries():
1640
if not tree.has_id(ie.file_id):
1641
self.outf.write(path)
1643
self.outf.write(' ')
1644
self.outf.write(ie.file_id)
1645
self.outf.write('\n')
1652
class cmd_modified(Command):
1653
"""List files modified in working tree.
1657
_see_also = ['status', 'ls']
1660
help='Write an ascii NUL (\\0) separator '
1661
'between files rather than a newline.')
1665
def run(self, null=False):
1666
tree = WorkingTree.open_containing(u'.')[0]
1667
td = tree.changes_from(tree.basis_tree())
1668
for path, id, kind, text_modified, meta_modified in td.modified:
1670
self.outf.write(path + '\0')
1672
self.outf.write(osutils.quotefn(path) + '\n')
1675
class cmd_added(Command):
1676
"""List files added in working tree.
1680
_see_also = ['status', 'ls']
1683
help='Write an ascii NUL (\\0) separator '
1684
'between files rather than a newline.')
1688
def run(self, null=False):
1689
wt = WorkingTree.open_containing(u'.')[0]
1692
basis = wt.basis_tree()
1695
basis_inv = basis.inventory
1698
if file_id in basis_inv:
1700
if inv.is_root(file_id) and len(basis_inv) == 0:
1702
path = inv.id2path(file_id)
1703
if not os.access(osutils.abspath(path), os.F_OK):
1706
self.outf.write(path + '\0')
1708
self.outf.write(osutils.quotefn(path) + '\n')
1715
class cmd_root(Command):
1716
"""Show the tree root directory.
1718
The root is the nearest enclosing directory with a .bzr control
1721
takes_args = ['filename?']
1723
def run(self, filename=None):
1724
"""Print the branch root."""
1725
tree = WorkingTree.open_containing(filename)[0]
1726
self.outf.write(tree.basedir + '\n')
1729
def _parse_limit(limitstring):
1731
return int(limitstring)
1733
msg = "The limit argument must be an integer."
1734
raise errors.BzrCommandError(msg)
1737
class cmd_log(Command):
1738
"""Show log of a branch, file, or directory.
1740
By default show the log of the branch containing the working directory.
1742
To request a range of logs, you can use the command -r begin..end
1743
-r revision requests a specific revision, -r ..end or -r begin.. are
1747
Log the current branch::
1755
Log the last 10 revisions of a branch::
1757
bzr log -r -10.. http://server/branch
1760
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1762
takes_args = ['location?']
1765
help='Show from oldest to newest.'),
1767
custom_help('verbose',
1768
help='Show files changed in each revision.'),
1772
type=bzrlib.option._parse_revision_str,
1774
help='Show just the specified revision.'
1775
' See also "help revisionspec".'),
1779
help='Show revisions whose message matches this '
1780
'regular expression.',
1784
help='Limit the output to the first N revisions.',
1788
encoding_type = 'replace'
1791
def run(self, location=None, timezone='original',
1800
from bzrlib.log import show_log
1801
direction = (forward and 'forward') or 'reverse'
1803
if change is not None:
1805
raise errors.RangeInChangeOption()
1806
if revision is not None:
1807
raise errors.BzrCommandError(
1808
'--revision and --change are mutually exclusive')
1815
# find the file id to log:
1817
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1821
tree = b.basis_tree()
1822
file_id = tree.path2id(fp)
1824
raise errors.BzrCommandError(
1825
"Path does not have any revision history: %s" %
1829
# FIXME ? log the current subdir only RBC 20060203
1830
if revision is not None \
1831
and len(revision) > 0 and revision[0].get_branch():
1832
location = revision[0].get_branch()
1835
dir, relpath = bzrdir.BzrDir.open_containing(location)
1836
b = dir.open_branch()
1840
if revision is None:
1843
elif len(revision) == 1:
1844
rev1 = rev2 = revision[0].in_history(b)
1845
elif len(revision) == 2:
1846
if revision[1].get_branch() != revision[0].get_branch():
1847
# b is taken from revision[0].get_branch(), and
1848
# show_log will use its revision_history. Having
1849
# different branches will lead to weird behaviors.
1850
raise errors.BzrCommandError(
1851
"Log doesn't accept two revisions in different"
1853
rev1 = revision[0].in_history(b)
1854
rev2 = revision[1].in_history(b)
1856
raise errors.BzrCommandError(
1857
'bzr log --revision takes one or two values.')
1859
if log_format is None:
1860
log_format = log.log_formatter_registry.get_default(b)
1862
lf = log_format(show_ids=show_ids, to_file=self.outf,
1863
show_timezone=timezone)
1869
direction=direction,
1870
start_revision=rev1,
1878
def get_log_format(long=False, short=False, line=False, default='long'):
1879
log_format = default
1883
log_format = 'short'
1889
class cmd_touching_revisions(Command):
1890
"""Return revision-ids which affected a particular file.
1892
A more user-friendly interface is "bzr log FILE".
1896
takes_args = ["filename"]
1899
def run(self, filename):
1900
tree, relpath = WorkingTree.open_containing(filename)
1902
file_id = tree.path2id(relpath)
1903
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1904
self.outf.write("%6d %s\n" % (revno, what))
1907
class cmd_ls(Command):
1908
"""List files in a tree.
1911
_see_also = ['status', 'cat']
1912
takes_args = ['path?']
1913
# TODO: Take a revision or remote path and list that tree instead.
1917
Option('non-recursive',
1918
help='Don\'t recurse into subdirectories.'),
1920
help='Print paths relative to the root of the branch.'),
1921
Option('unknown', help='Print unknown files.'),
1922
Option('versioned', help='Print versioned files.',
1924
Option('ignored', help='Print ignored files.'),
1926
help='Write an ascii NUL (\\0) separator '
1927
'between files rather than a newline.'),
1929
help='List entries of a particular kind: file, directory, symlink.',
1934
def run(self, revision=None, verbose=False,
1935
non_recursive=False, from_root=False,
1936
unknown=False, versioned=False, ignored=False,
1937
null=False, kind=None, show_ids=False, path=None):
1939
if kind and kind not in ('file', 'directory', 'symlink'):
1940
raise errors.BzrCommandError('invalid kind specified')
1942
if verbose and null:
1943
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1944
all = not (unknown or versioned or ignored)
1946
selection = {'I':ignored, '?':unknown, 'V':versioned}
1953
raise errors.BzrCommandError('cannot specify both --from-root'
1957
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1963
if revision is not None or tree is None:
1964
tree = _get_one_revision_tree('ls', revision, branch=branch)
1968
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1969
if fp.startswith(relpath):
1970
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1971
if non_recursive and '/' in fp:
1973
if not all and not selection[fc]:
1975
if kind is not None and fkind != kind:
1978
kindch = entry.kind_character()
1979
outstring = '%-8s %s%s' % (fc, fp, kindch)
1980
if show_ids and fid is not None:
1981
outstring = "%-50s %s" % (outstring, fid)
1982
self.outf.write(outstring + '\n')
1984
self.outf.write(fp + '\0')
1987
self.outf.write(fid)
1988
self.outf.write('\0')
1996
self.outf.write('%-50s %s\n' % (fp, my_id))
1998
self.outf.write(fp + '\n')
2003
class cmd_unknowns(Command):
2004
"""List unknown files.
2012
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2013
self.outf.write(osutils.quotefn(f) + '\n')
2016
class cmd_ignore(Command):
2017
"""Ignore specified files or patterns.
2019
See ``bzr help patterns`` for details on the syntax of patterns.
2021
To remove patterns from the ignore list, edit the .bzrignore file.
2022
After adding, editing or deleting that file either indirectly by
2023
using this command or directly by using an editor, be sure to commit
2026
Note: ignore patterns containing shell wildcards must be quoted from
2030
Ignore the top level Makefile::
2032
bzr ignore ./Makefile
2034
Ignore class files in all directories::
2036
bzr ignore "*.class"
2038
Ignore .o files under the lib directory::
2040
bzr ignore "lib/**/*.o"
2042
Ignore .o files under the lib directory::
2044
bzr ignore "RE:lib/.*\.o"
2046
Ignore everything but the "debian" toplevel directory::
2048
bzr ignore "RE:(?!debian/).*"
2051
_see_also = ['status', 'ignored', 'patterns']
2052
takes_args = ['name_pattern*']
2054
Option('old-default-rules',
2055
help='Write out the ignore rules bzr < 0.9 always used.')
2058
def run(self, name_pattern_list=None, old_default_rules=None):
2059
from bzrlib import ignores
2060
if old_default_rules is not None:
2061
# dump the rules and exit
2062
for pattern in ignores.OLD_DEFAULTS:
2065
if not name_pattern_list:
2066
raise errors.BzrCommandError("ignore requires at least one "
2067
"NAME_PATTERN or --old-default-rules")
2068
name_pattern_list = [globbing.normalize_pattern(p)
2069
for p in name_pattern_list]
2070
for name_pattern in name_pattern_list:
2071
if (name_pattern[0] == '/' or
2072
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2073
raise errors.BzrCommandError(
2074
"NAME_PATTERN should not be an absolute path")
2075
tree, relpath = WorkingTree.open_containing(u'.')
2076
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2077
ignored = globbing.Globster(name_pattern_list)
2080
for entry in tree.list_files():
2084
if ignored.match(filename):
2085
matches.append(filename.encode('utf-8'))
2087
if len(matches) > 0:
2088
print "Warning: the following files are version controlled and" \
2089
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2092
class cmd_ignored(Command):
2093
"""List ignored files and the patterns that matched them.
2095
List all the ignored files and the ignore pattern that caused the file to
2098
Alternatively, to list just the files::
2103
encoding_type = 'replace'
2104
_see_also = ['ignore', 'ls']
2108
tree = WorkingTree.open_containing(u'.')[0]
2111
for path, file_class, kind, file_id, entry in tree.list_files():
2112
if file_class != 'I':
2114
## XXX: Slightly inefficient since this was already calculated
2115
pat = tree.is_ignored(path)
2116
self.outf.write('%-50s %s\n' % (path, pat))
2121
class cmd_lookup_revision(Command):
2122
"""Lookup the revision-id from a revision-number
2125
bzr lookup-revision 33
2128
takes_args = ['revno']
2131
def run(self, revno):
2135
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2137
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2140
class cmd_export(Command):
2141
"""Export current or past revision to a destination directory or archive.
2143
If no revision is specified this exports the last committed revision.
2145
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2146
given, try to find the format with the extension. If no extension
2147
is found exports to a directory (equivalent to --format=dir).
2149
If root is supplied, it will be used as the root directory inside
2150
container formats (tar, zip, etc). If it is not supplied it will default
2151
to the exported filename. The root option has no effect for 'dir' format.
2153
If branch is omitted then the branch containing the current working
2154
directory will be used.
2156
Note: Export of tree with non-ASCII filenames to zip is not supported.
2158
================= =========================
2159
Supported formats Autodetected by extension
2160
================= =========================
2163
tbz2 .tar.bz2, .tbz2
2166
================= =========================
2168
takes_args = ['dest', 'branch_or_subdir?']
2171
help="Type of file to export to.",
2176
help="Name of the root directory inside the exported file."),
2178
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2180
from bzrlib.export import export
2182
if branch_or_subdir is None:
2183
tree = WorkingTree.open_containing(u'.')[0]
2187
b, subdir = Branch.open_containing(branch_or_subdir)
2190
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2192
export(rev_tree, dest, format, root, subdir)
2193
except errors.NoSuchExportFormat, e:
2194
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2197
class cmd_cat(Command):
2198
"""Write the contents of a file as of a given revision to standard output.
2200
If no revision is nominated, the last revision is used.
2202
Note: Take care to redirect standard output when using this command on a
2208
Option('name-from-revision', help='The path name in the old tree.'),
2211
takes_args = ['filename']
2212
encoding_type = 'exact'
2215
def run(self, filename, revision=None, name_from_revision=False):
2216
if revision is not None and len(revision) != 1:
2217
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2218
" one revision specifier")
2219
tree, branch, relpath = \
2220
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2223
return self._run(tree, branch, relpath, filename, revision,
2228
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2230
tree = b.basis_tree()
2231
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2233
cur_file_id = tree.path2id(relpath)
2234
old_file_id = rev_tree.path2id(relpath)
2236
if name_from_revision:
2237
if old_file_id is None:
2238
raise errors.BzrCommandError(
2239
"%r is not present in revision %s" % (
2240
filename, rev_tree.get_revision_id()))
2242
content = rev_tree.get_file_text(old_file_id)
2243
elif cur_file_id is not None:
2244
content = rev_tree.get_file_text(cur_file_id)
2245
elif old_file_id is not None:
2246
content = rev_tree.get_file_text(old_file_id)
2248
raise errors.BzrCommandError(
2249
"%r is not present in revision %s" % (
2250
filename, rev_tree.get_revision_id()))
2251
self.outf.write(content)
2254
class cmd_local_time_offset(Command):
2255
"""Show the offset in seconds from GMT to local time."""
2259
print osutils.local_time_offset()
2263
class cmd_commit(Command):
2264
"""Commit changes into a new revision.
2266
If no arguments are given, the entire tree is committed.
2268
If selected files are specified, only changes to those files are
2269
committed. If a directory is specified then the directory and everything
2270
within it is committed.
2272
When excludes are given, they take precedence over selected files.
2273
For example, too commit only changes within foo, but not changes within
2276
bzr commit foo -x foo/bar
2278
If author of the change is not the same person as the committer, you can
2279
specify the author's name using the --author option. The name should be
2280
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2282
A selected-file commit may fail in some cases where the committed
2283
tree would be invalid. Consider::
2288
bzr commit foo -m "committing foo"
2289
bzr mv foo/bar foo/baz
2292
bzr commit foo/bar -m "committing bar but not baz"
2294
In the example above, the last commit will fail by design. This gives
2295
the user the opportunity to decide whether they want to commit the
2296
rename at the same time, separately first, or not at all. (As a general
2297
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2299
Note: A selected-file commit after a merge is not yet supported.
2301
# TODO: Run hooks on tree to-be-committed, and after commit.
2303
# TODO: Strict commit that fails if there are deleted files.
2304
# (what does "deleted files" mean ??)
2306
# TODO: Give better message for -s, --summary, used by tla people
2308
# XXX: verbose currently does nothing
2310
_see_also = ['bugs', 'uncommit']
2311
takes_args = ['selected*']
2313
ListOption('exclude', type=str, short_name='x',
2314
help="Do not consider changes made to a given path."),
2315
Option('message', type=unicode,
2317
help="Description of the new revision."),
2320
help='Commit even if nothing has changed.'),
2321
Option('file', type=str,
2324
help='Take commit message from this file.'),
2326
help="Refuse to commit if there are unknown "
2327
"files in the working tree."),
2328
ListOption('fixes', type=str,
2329
help="Mark a bug as being fixed by this revision."),
2330
Option('author', type=unicode,
2331
help="Set the author's name, if it's different "
2332
"from the committer."),
2334
help="Perform a local commit in a bound "
2335
"branch. Local commits are not pushed to "
2336
"the master branch until a normal commit "
2340
help='When no message is supplied, show the diff along'
2341
' with the status summary in the message editor.'),
2343
aliases = ['ci', 'checkin']
2345
def _get_bug_fix_properties(self, fixes, branch):
2347
# Configure the properties for bug fixing attributes.
2348
for fixed_bug in fixes:
2349
tokens = fixed_bug.split(':')
2350
if len(tokens) != 2:
2351
raise errors.BzrCommandError(
2352
"Invalid bug %s. Must be in the form of 'tag:id'. "
2353
"Commit refused." % fixed_bug)
2354
tag, bug_id = tokens
2356
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2357
except errors.UnknownBugTrackerAbbreviation:
2358
raise errors.BzrCommandError(
2359
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2360
except errors.MalformedBugIdentifier:
2361
raise errors.BzrCommandError(
2362
"Invalid bug identifier for %s. Commit refused."
2364
properties.append('%s fixed' % bug_url)
2365
return '\n'.join(properties)
2367
def run(self, message=None, file=None, verbose=False, selected_list=None,
2368
unchanged=False, strict=False, local=False, fixes=None,
2369
author=None, show_diff=False, exclude=None):
2370
from bzrlib.errors import (
2375
from bzrlib.msgeditor import (
2376
edit_commit_message_encoded,
2377
generate_commit_message_template,
2378
make_commit_message_template_encoded
2381
# TODO: Need a blackbox test for invoking the external editor; may be
2382
# slightly problematic to run this cross-platform.
2384
# TODO: do more checks that the commit will succeed before
2385
# spending the user's valuable time typing a commit message.
2389
tree, selected_list = tree_files(selected_list)
2390
if selected_list == ['']:
2391
# workaround - commit of root of tree should be exactly the same
2392
# as just default commit in that tree, and succeed even though
2393
# selected-file merge commit is not done yet
2398
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2400
properties['bugs'] = bug_property
2402
if local and not tree.branch.get_bound_location():
2403
raise errors.LocalRequiresBoundBranch()
2405
def get_message(commit_obj):
2406
"""Callback to get commit message"""
2407
my_message = message
2408
if my_message is None and not file:
2409
t = make_commit_message_template_encoded(tree,
2410
selected_list, diff=show_diff,
2411
output_encoding=osutils.get_user_encoding())
2412
start_message = generate_commit_message_template(commit_obj)
2413
my_message = edit_commit_message_encoded(t,
2414
start_message=start_message)
2415
if my_message is None:
2416
raise errors.BzrCommandError("please specify a commit"
2417
" message with either --message or --file")
2418
elif my_message and file:
2419
raise errors.BzrCommandError(
2420
"please specify either --message or --file")
2422
my_message = codecs.open(file, 'rt',
2423
osutils.get_user_encoding()).read()
2424
if my_message == "":
2425
raise errors.BzrCommandError("empty commit message specified")
2429
tree.commit(message_callback=get_message,
2430
specific_files=selected_list,
2431
allow_pointless=unchanged, strict=strict, local=local,
2432
reporter=None, verbose=verbose, revprops=properties,
2434
exclude=safe_relpath_files(tree, exclude))
2435
except PointlessCommit:
2436
# FIXME: This should really happen before the file is read in;
2437
# perhaps prepare the commit; get the message; then actually commit
2438
raise errors.BzrCommandError("no changes to commit."
2439
" use --unchanged to commit anyhow")
2440
except ConflictsInTree:
2441
raise errors.BzrCommandError('Conflicts detected in working '
2442
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2444
except StrictCommitFailed:
2445
raise errors.BzrCommandError("Commit refused because there are"
2446
" unknown files in the working tree.")
2447
except errors.BoundBranchOutOfDate, e:
2448
raise errors.BzrCommandError(str(e) + "\n"
2449
'To commit to master branch, run update and then commit.\n'
2450
'You can also pass --local to commit to continue working '
2454
class cmd_check(Command):
2455
"""Validate working tree structure, branch consistency and repository history.
2457
This command checks various invariants about branch and repository storage
2458
to detect data corruption or bzr bugs.
2460
The working tree and branch checks will only give output if a problem is
2461
detected. The output fields of the repository check are:
2463
revisions: This is just the number of revisions checked. It doesn't
2465
versionedfiles: This is just the number of versionedfiles checked. It
2466
doesn't indicate a problem.
2467
unreferenced ancestors: Texts that are ancestors of other texts, but
2468
are not properly referenced by the revision ancestry. This is a
2469
subtle problem that Bazaar can work around.
2470
unique file texts: This is the total number of unique file contents
2471
seen in the checked revisions. It does not indicate a problem.
2472
repeated file texts: This is the total number of repeated texts seen
2473
in the checked revisions. Texts can be repeated when their file
2474
entries are modified, but the file contents are not. It does not
2477
If no restrictions are specified, all Bazaar data that is found at the given
2478
location will be checked.
2482
Check the tree and branch at 'foo'::
2484
bzr check --tree --branch foo
2486
Check only the repository at 'bar'::
2488
bzr check --repo bar
2490
Check everything at 'baz'::
2495
_see_also = ['reconcile']
2496
takes_args = ['path?']
2497
takes_options = ['verbose',
2498
Option('branch', help="Check the branch related to the"
2499
" current directory."),
2500
Option('repo', help="Check the repository related to the"
2501
" current directory."),
2502
Option('tree', help="Check the working tree related to"
2503
" the current directory.")]
2505
def run(self, path=None, verbose=False, branch=False, repo=False,
2507
from bzrlib.check import check_dwim
2510
if not branch and not repo and not tree:
2511
branch = repo = tree = True
2512
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2515
class cmd_upgrade(Command):
2516
"""Upgrade branch storage to current format.
2518
The check command or bzr developers may sometimes advise you to run
2519
this command. When the default format has changed you may also be warned
2520
during other operations to upgrade.
2523
_see_also = ['check']
2524
takes_args = ['url?']
2526
RegistryOption('format',
2527
help='Upgrade to a specific format. See "bzr help'
2528
' formats" for details.',
2529
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2530
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2531
value_switches=True, title='Branch format'),
2534
def run(self, url='.', format=None):
2535
from bzrlib.upgrade import upgrade
2537
format = bzrdir.format_registry.make_bzrdir('default')
2538
upgrade(url, format)
2541
class cmd_whoami(Command):
2542
"""Show or set bzr user id.
2545
Show the email of the current user::
2549
Set the current user::
2551
bzr whoami "Frank Chu <fchu@example.com>"
2553
takes_options = [ Option('email',
2554
help='Display email address only.'),
2556
help='Set identity for the current branch instead of '
2559
takes_args = ['name?']
2560
encoding_type = 'replace'
2563
def run(self, email=False, branch=False, name=None):
2565
# use branch if we're inside one; otherwise global config
2567
c = Branch.open_containing('.')[0].get_config()
2568
except errors.NotBranchError:
2569
c = config.GlobalConfig()
2571
self.outf.write(c.user_email() + '\n')
2573
self.outf.write(c.username() + '\n')
2576
# display a warning if an email address isn't included in the given name.
2578
config.extract_email_address(name)
2579
except errors.NoEmailInUsername, e:
2580
warning('"%s" does not seem to contain an email address. '
2581
'This is allowed, but not recommended.', name)
2583
# use global config unless --branch given
2585
c = Branch.open_containing('.')[0].get_config()
2587
c = config.GlobalConfig()
2588
c.set_user_option('email', name)
2591
class cmd_nick(Command):
2592
"""Print or set the branch nickname.
2594
If unset, the tree root directory name is used as the nickname.
2595
To print the current nickname, execute with no argument.
2597
Bound branches use the nickname of its master branch unless it is set
2601
_see_also = ['info']
2602
takes_args = ['nickname?']
2603
def run(self, nickname=None):
2604
branch = Branch.open_containing(u'.')[0]
2605
if nickname is None:
2606
self.printme(branch)
2608
branch.nick = nickname
2611
def printme(self, branch):
2615
class cmd_alias(Command):
2616
"""Set/unset and display aliases.
2619
Show the current aliases::
2623
Show the alias specified for 'll'::
2627
Set an alias for 'll'::
2629
bzr alias ll="log --line -r-10..-1"
2631
To remove an alias for 'll'::
2633
bzr alias --remove ll
2636
takes_args = ['name?']
2638
Option('remove', help='Remove the alias.'),
2641
def run(self, name=None, remove=False):
2643
self.remove_alias(name)
2645
self.print_aliases()
2647
equal_pos = name.find('=')
2649
self.print_alias(name)
2651
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2653
def remove_alias(self, alias_name):
2654
if alias_name is None:
2655
raise errors.BzrCommandError(
2656
'bzr alias --remove expects an alias to remove.')
2657
# If alias is not found, print something like:
2658
# unalias: foo: not found
2659
c = config.GlobalConfig()
2660
c.unset_alias(alias_name)
2663
def print_aliases(self):
2664
"""Print out the defined aliases in a similar format to bash."""
2665
aliases = config.GlobalConfig().get_aliases()
2666
for key, value in sorted(aliases.iteritems()):
2667
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2670
def print_alias(self, alias_name):
2671
from bzrlib.commands import get_alias
2672
alias = get_alias(alias_name)
2674
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2677
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2679
def set_alias(self, alias_name, alias_command):
2680
"""Save the alias in the global config."""
2681
c = config.GlobalConfig()
2682
c.set_alias(alias_name, alias_command)
2685
class cmd_selftest(Command):
2686
"""Run internal test suite.
2688
If arguments are given, they are regular expressions that say which tests
2689
should run. Tests matching any expression are run, and other tests are
2692
Alternatively if --first is given, matching tests are run first and then
2693
all other tests are run. This is useful if you have been working in a
2694
particular area, but want to make sure nothing else was broken.
2696
If --exclude is given, tests that match that regular expression are
2697
excluded, regardless of whether they match --first or not.
2699
To help catch accidential dependencies between tests, the --randomize
2700
option is useful. In most cases, the argument used is the word 'now'.
2701
Note that the seed used for the random number generator is displayed
2702
when this option is used. The seed can be explicitly passed as the
2703
argument to this option if required. This enables reproduction of the
2704
actual ordering used if and when an order sensitive problem is encountered.
2706
If --list-only is given, the tests that would be run are listed. This is
2707
useful when combined with --first, --exclude and/or --randomize to
2708
understand their impact. The test harness reports "Listed nn tests in ..."
2709
instead of "Ran nn tests in ..." when list mode is enabled.
2711
If the global option '--no-plugins' is given, plugins are not loaded
2712
before running the selftests. This has two effects: features provided or
2713
modified by plugins will not be tested, and tests provided by plugins will
2716
Tests that need working space on disk use a common temporary directory,
2717
typically inside $TMPDIR or /tmp.
2720
Run only tests relating to 'ignore'::
2724
Disable plugins and list tests as they're run::
2726
bzr --no-plugins selftest -v
2728
# NB: this is used from the class without creating an instance, which is
2729
# why it does not have a self parameter.
2730
def get_transport_type(typestring):
2731
"""Parse and return a transport specifier."""
2732
if typestring == "sftp":
2733
from bzrlib.transport.sftp import SFTPAbsoluteServer
2734
return SFTPAbsoluteServer
2735
if typestring == "memory":
2736
from bzrlib.transport.memory import MemoryServer
2738
if typestring == "fakenfs":
2739
from bzrlib.transport.fakenfs import FakeNFSServer
2740
return FakeNFSServer
2741
msg = "No known transport type %s. Supported types are: sftp\n" %\
2743
raise errors.BzrCommandError(msg)
2746
takes_args = ['testspecs*']
2747
takes_options = ['verbose',
2749
help='Stop when one test fails.',
2753
help='Use a different transport by default '
2754
'throughout the test suite.',
2755
type=get_transport_type),
2757
help='Run the benchmarks rather than selftests.'),
2758
Option('lsprof-timed',
2759
help='Generate lsprof output for benchmarked'
2760
' sections of code.'),
2761
Option('cache-dir', type=str,
2762
help='Cache intermediate benchmark output in this '
2765
help='Run all tests, but run specified tests first.',
2769
help='List the tests instead of running them.'),
2770
Option('randomize', type=str, argname="SEED",
2771
help='Randomize the order of tests using the given'
2772
' seed or "now" for the current time.'),
2773
Option('exclude', type=str, argname="PATTERN",
2775
help='Exclude tests that match this regular'
2777
Option('strict', help='Fail on missing dependencies or '
2779
Option('load-list', type=str, argname='TESTLISTFILE',
2780
help='Load a test id list from a text file.'),
2781
ListOption('debugflag', type=str, short_name='E',
2782
help='Turn on a selftest debug flag.'),
2783
ListOption('starting-with', type=str, argname='TESTID',
2784
param_name='starting_with', short_name='s',
2786
'Load only the tests starting with TESTID.'),
2788
encoding_type = 'replace'
2790
def run(self, testspecs_list=None, verbose=False, one=False,
2791
transport=None, benchmark=None,
2792
lsprof_timed=None, cache_dir=None,
2793
first=False, list_only=False,
2794
randomize=None, exclude=None, strict=False,
2795
load_list=None, debugflag=None, starting_with=None):
2796
from bzrlib.tests import selftest
2797
import bzrlib.benchmarks as benchmarks
2798
from bzrlib.benchmarks import tree_creator
2800
# Make deprecation warnings visible, unless -Werror is set
2801
symbol_versioning.activate_deprecation_warnings(override=False)
2803
if cache_dir is not None:
2804
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2806
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2807
print ' %s (%s python%s)' % (
2809
bzrlib.version_string,
2810
bzrlib._format_version_tuple(sys.version_info),
2813
if testspecs_list is not None:
2814
pattern = '|'.join(testspecs_list)
2818
test_suite_factory = benchmarks.test_suite
2819
# Unless user explicitly asks for quiet, be verbose in benchmarks
2820
verbose = not is_quiet()
2821
# TODO: should possibly lock the history file...
2822
benchfile = open(".perf_history", "at", buffering=1)
2824
test_suite_factory = None
2827
result = selftest(verbose=verbose,
2829
stop_on_failure=one,
2830
transport=transport,
2831
test_suite_factory=test_suite_factory,
2832
lsprof_timed=lsprof_timed,
2833
bench_history=benchfile,
2834
matching_tests_first=first,
2835
list_only=list_only,
2836
random_seed=randomize,
2837
exclude_pattern=exclude,
2839
load_list=load_list,
2840
debug_flags=debugflag,
2841
starting_with=starting_with,
2844
if benchfile is not None:
2847
note('tests passed')
2849
note('tests failed')
2850
return int(not result)
2853
class cmd_version(Command):
2854
"""Show version of bzr."""
2856
encoding_type = 'replace'
2858
Option("short", help="Print just the version number."),
2862
def run(self, short=False):
2863
from bzrlib.version import show_version
2865
self.outf.write(bzrlib.version_string + '\n')
2867
show_version(to_file=self.outf)
2870
class cmd_rocks(Command):
2871
"""Statement of optimism."""
2877
print "It sure does!"
2880
class cmd_find_merge_base(Command):
2881
"""Find and print a base revision for merging two branches."""
2882
# TODO: Options to specify revisions on either side, as if
2883
# merging only part of the history.
2884
takes_args = ['branch', 'other']
2888
def run(self, branch, other):
2889
from bzrlib.revision import ensure_null
2891
branch1 = Branch.open_containing(branch)[0]
2892
branch2 = Branch.open_containing(other)[0]
2897
last1 = ensure_null(branch1.last_revision())
2898
last2 = ensure_null(branch2.last_revision())
2900
graph = branch1.repository.get_graph(branch2.repository)
2901
base_rev_id = graph.find_unique_lca(last1, last2)
2903
print 'merge base is revision %s' % base_rev_id
2910
class cmd_merge(Command):
2911
"""Perform a three-way merge.
2913
The source of the merge can be specified either in the form of a branch,
2914
or in the form of a path to a file containing a merge directive generated
2915
with bzr send. If neither is specified, the default is the upstream branch
2916
or the branch most recently merged using --remember.
2918
When merging a branch, by default the tip will be merged. To pick a different
2919
revision, pass --revision. If you specify two values, the first will be used as
2920
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2921
available revisions, like this is commonly referred to as "cherrypicking".
2923
Revision numbers are always relative to the branch being merged.
2925
By default, bzr will try to merge in all new work from the other
2926
branch, automatically determining an appropriate base. If this
2927
fails, you may need to give an explicit base.
2929
Merge will do its best to combine the changes in two branches, but there
2930
are some kinds of problems only a human can fix. When it encounters those,
2931
it will mark a conflict. A conflict means that you need to fix something,
2932
before you should commit.
2934
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2936
If there is no default branch set, the first merge will set it. After
2937
that, you can omit the branch to use the default. To change the
2938
default, use --remember. The value will only be saved if the remote
2939
location can be accessed.
2941
The results of the merge are placed into the destination working
2942
directory, where they can be reviewed (with bzr diff), tested, and then
2943
committed to record the result of the merge.
2945
merge refuses to run if there are any uncommitted changes, unless
2949
To merge the latest revision from bzr.dev::
2951
bzr merge ../bzr.dev
2953
To merge changes up to and including revision 82 from bzr.dev::
2955
bzr merge -r 82 ../bzr.dev
2957
To merge the changes introduced by 82, without previous changes::
2959
bzr merge -r 81..82 ../bzr.dev
2961
To apply a merge directive contained in in /tmp/merge:
2963
bzr merge /tmp/merge
2966
encoding_type = 'exact'
2967
_see_also = ['update', 'remerge', 'status-flags']
2968
takes_args = ['location?']
2973
help='Merge even if the destination tree has uncommitted changes.'),
2977
Option('show-base', help="Show base revision text in "
2979
Option('uncommitted', help='Apply uncommitted changes'
2980
' from a working copy, instead of branch changes.'),
2981
Option('pull', help='If the destination is already'
2982
' completely merged into the source, pull from the'
2983
' source rather than merging. When this happens,'
2984
' you do not need to commit the result.'),
2986
help='Branch to merge into, '
2987
'rather than the one containing the working directory.',
2991
Option('preview', help='Instead of merging, show a diff of the merge.')
2994
def run(self, location=None, revision=None, force=False,
2995
merge_type=None, show_base=False, reprocess=None, remember=False,
2996
uncommitted=False, pull=False,
3000
if merge_type is None:
3001
merge_type = _mod_merge.Merge3Merger
3003
if directory is None: directory = u'.'
3004
possible_transports = []
3006
allow_pending = True
3007
verified = 'inapplicable'
3008
tree = WorkingTree.open_containing(directory)[0]
3009
change_reporter = delta._ChangeReporter(
3010
unversioned_filter=tree.is_ignored)
3013
pb = ui.ui_factory.nested_progress_bar()
3014
cleanups.append(pb.finished)
3016
cleanups.append(tree.unlock)
3017
if location is not None:
3019
mergeable = bundle.read_mergeable_from_url(location,
3020
possible_transports=possible_transports)
3021
except errors.NotABundle:
3025
raise errors.BzrCommandError('Cannot use --uncommitted'
3026
' with bundles or merge directives.')
3028
if revision is not None:
3029
raise errors.BzrCommandError(
3030
'Cannot use -r with merge directives or bundles')
3031
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3034
if merger is None and uncommitted:
3035
if revision is not None and len(revision) > 0:
3036
raise errors.BzrCommandError('Cannot use --uncommitted and'
3037
' --revision at the same time.')
3038
location = self._select_branch_location(tree, location)[0]
3039
other_tree, other_path = WorkingTree.open_containing(location)
3040
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3042
allow_pending = False
3043
if other_path != '':
3044
merger.interesting_files = [other_path]
3047
merger, allow_pending = self._get_merger_from_branch(tree,
3048
location, revision, remember, possible_transports, pb)
3050
merger.merge_type = merge_type
3051
merger.reprocess = reprocess
3052
merger.show_base = show_base
3053
self.sanity_check_merger(merger)
3054
if (merger.base_rev_id == merger.other_rev_id and
3055
merger.other_rev_id is not None):
3056
note('Nothing to do.')
3059
if merger.interesting_files is not None:
3060
raise errors.BzrCommandError('Cannot pull individual files')
3061
if (merger.base_rev_id == tree.last_revision()):
3062
result = tree.pull(merger.other_branch, False,
3063
merger.other_rev_id)
3064
result.report(self.outf)
3066
merger.check_basis(not force)
3068
return self._do_preview(merger)
3070
return self._do_merge(merger, change_reporter, allow_pending,
3073
for cleanup in reversed(cleanups):
3076
def _do_preview(self, merger):
3077
from bzrlib.diff import show_diff_trees
3078
tree_merger = merger.make_merger()
3079
tt = tree_merger.make_preview_transform()
3081
result_tree = tt.get_preview_tree()
3082
show_diff_trees(merger.this_tree, result_tree, self.outf,
3083
old_label='', new_label='')
3087
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3088
merger.change_reporter = change_reporter
3089
conflict_count = merger.do_merge()
3091
merger.set_pending()
3092
if verified == 'failed':
3093
warning('Preview patch does not match changes')
3094
if conflict_count != 0:
3099
def sanity_check_merger(self, merger):
3100
if (merger.show_base and
3101
not merger.merge_type is _mod_merge.Merge3Merger):
3102
raise errors.BzrCommandError("Show-base is not supported for this"
3103
" merge type. %s" % merger.merge_type)
3104
if merger.reprocess is None:
3105
if merger.show_base:
3106
merger.reprocess = False
3108
# Use reprocess if the merger supports it
3109
merger.reprocess = merger.merge_type.supports_reprocess
3110
if merger.reprocess and not merger.merge_type.supports_reprocess:
3111
raise errors.BzrCommandError("Conflict reduction is not supported"
3112
" for merge type %s." %
3114
if merger.reprocess and merger.show_base:
3115
raise errors.BzrCommandError("Cannot do conflict reduction and"
3118
def _get_merger_from_branch(self, tree, location, revision, remember,
3119
possible_transports, pb):
3120
"""Produce a merger from a location, assuming it refers to a branch."""
3121
from bzrlib.tag import _merge_tags_if_possible
3122
# find the branch locations
3123
other_loc, user_location = self._select_branch_location(tree, location,
3125
if revision is not None and len(revision) == 2:
3126
base_loc, _unused = self._select_branch_location(tree,
3127
location, revision, 0)
3129
base_loc = other_loc
3131
other_branch, other_path = Branch.open_containing(other_loc,
3132
possible_transports)
3133
if base_loc == other_loc:
3134
base_branch = other_branch
3136
base_branch, base_path = Branch.open_containing(base_loc,
3137
possible_transports)
3138
# Find the revision ids
3139
if revision is None or len(revision) < 1 or revision[-1] is None:
3140
other_revision_id = _mod_revision.ensure_null(
3141
other_branch.last_revision())
3143
other_revision_id = revision[-1].as_revision_id(other_branch)
3144
if (revision is not None and len(revision) == 2
3145
and revision[0] is not None):
3146
base_revision_id = revision[0].as_revision_id(base_branch)
3148
base_revision_id = None
3149
# Remember where we merge from
3150
if ((remember or tree.branch.get_submit_branch() is None) and
3151
user_location is not None):
3152
tree.branch.set_submit_branch(other_branch.base)
3153
_merge_tags_if_possible(other_branch, tree.branch)
3154
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3155
other_revision_id, base_revision_id, other_branch, base_branch)
3156
if other_path != '':
3157
allow_pending = False
3158
merger.interesting_files = [other_path]
3160
allow_pending = True
3161
return merger, allow_pending
3163
def _select_branch_location(self, tree, user_location, revision=None,
3165
"""Select a branch location, according to possible inputs.
3167
If provided, branches from ``revision`` are preferred. (Both
3168
``revision`` and ``index`` must be supplied.)
3170
Otherwise, the ``location`` parameter is used. If it is None, then the
3171
``submit`` or ``parent`` location is used, and a note is printed.
3173
:param tree: The working tree to select a branch for merging into
3174
:param location: The location entered by the user
3175
:param revision: The revision parameter to the command
3176
:param index: The index to use for the revision parameter. Negative
3177
indices are permitted.
3178
:return: (selected_location, user_location). The default location
3179
will be the user-entered location.
3181
if (revision is not None and index is not None
3182
and revision[index] is not None):
3183
branch = revision[index].get_branch()
3184
if branch is not None:
3185
return branch, branch
3186
if user_location is None:
3187
location = self._get_remembered(tree, 'Merging from')
3189
location = user_location
3190
return location, user_location
3192
def _get_remembered(self, tree, verb_string):
3193
"""Use tree.branch's parent if none was supplied.
3195
Report if the remembered location was used.
3197
stored_location = tree.branch.get_submit_branch()
3198
stored_location_type = "submit"
3199
if stored_location is None:
3200
stored_location = tree.branch.get_parent()
3201
stored_location_type = "parent"
3202
mutter("%s", stored_location)
3203
if stored_location is None:
3204
raise errors.BzrCommandError("No location specified or remembered")
3205
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3206
note(u"%s remembered %s location %s", verb_string,
3207
stored_location_type, display_url)
3208
return stored_location
3211
class cmd_remerge(Command):
3214
Use this if you want to try a different merge technique while resolving
3215
conflicts. Some merge techniques are better than others, and remerge
3216
lets you try different ones on different files.
3218
The options for remerge have the same meaning and defaults as the ones for
3219
merge. The difference is that remerge can (only) be run when there is a
3220
pending merge, and it lets you specify particular files.
3223
Re-do the merge of all conflicted files, and show the base text in
3224
conflict regions, in addition to the usual THIS and OTHER texts::
3226
bzr remerge --show-base
3228
Re-do the merge of "foobar", using the weave merge algorithm, with
3229
additional processing to reduce the size of conflict regions::
3231
bzr remerge --merge-type weave --reprocess foobar
3233
takes_args = ['file*']
3238
help="Show base revision text in conflicts."),
3241
def run(self, file_list=None, merge_type=None, show_base=False,
3243
if merge_type is None:
3244
merge_type = _mod_merge.Merge3Merger
3245
tree, file_list = tree_files(file_list)
3248
parents = tree.get_parent_ids()
3249
if len(parents) != 2:
3250
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3251
" merges. Not cherrypicking or"
3253
repository = tree.branch.repository
3254
interesting_ids = None
3256
conflicts = tree.conflicts()
3257
if file_list is not None:
3258
interesting_ids = set()
3259
for filename in file_list:
3260
file_id = tree.path2id(filename)
3262
raise errors.NotVersionedError(filename)
3263
interesting_ids.add(file_id)
3264
if tree.kind(file_id) != "directory":
3267
for name, ie in tree.inventory.iter_entries(file_id):
3268
interesting_ids.add(ie.file_id)
3269
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3271
# Remerge only supports resolving contents conflicts
3272
allowed_conflicts = ('text conflict', 'contents conflict')
3273
restore_files = [c.path for c in conflicts
3274
if c.typestring in allowed_conflicts]
3275
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3276
tree.set_conflicts(ConflictList(new_conflicts))
3277
if file_list is not None:
3278
restore_files = file_list
3279
for filename in restore_files:
3281
restore(tree.abspath(filename))
3282
except errors.NotConflicted:
3284
# Disable pending merges, because the file texts we are remerging
3285
# have not had those merges performed. If we use the wrong parents
3286
# list, we imply that the working tree text has seen and rejected
3287
# all the changes from the other tree, when in fact those changes
3288
# have not yet been seen.
3289
pb = ui.ui_factory.nested_progress_bar()
3290
tree.set_parent_ids(parents[:1])
3292
merger = _mod_merge.Merger.from_revision_ids(pb,
3294
merger.interesting_ids = interesting_ids
3295
merger.merge_type = merge_type
3296
merger.show_base = show_base
3297
merger.reprocess = reprocess
3298
conflicts = merger.do_merge()
3300
tree.set_parent_ids(parents)
3310
class cmd_revert(Command):
3311
"""Revert files to a previous revision.
3313
Giving a list of files will revert only those files. Otherwise, all files
3314
will be reverted. If the revision is not specified with '--revision', the
3315
last committed revision is used.
3317
To remove only some changes, without reverting to a prior version, use
3318
merge instead. For example, "merge . --revision -2..-3" will remove the
3319
changes introduced by -2, without affecting the changes introduced by -1.
3320
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3322
By default, any files that have been manually changed will be backed up
3323
first. (Files changed only by merge are not backed up.) Backup files have
3324
'.~#~' appended to their name, where # is a number.
3326
When you provide files, you can use their current pathname or the pathname
3327
from the target revision. So you can use revert to "undelete" a file by
3328
name. If you name a directory, all the contents of that directory will be
3331
Any files that have been newly added since that revision will be deleted,
3332
with a backup kept if appropriate. Directories containing unknown files
3333
will not be deleted.
3335
The working tree contains a list of pending merged revisions, which will
3336
be included as parents in the next commit. Normally, revert clears that
3337
list as well as reverting the files. If any files are specified, revert
3338
leaves the pending merge list alone and reverts only the files. Use "bzr
3339
revert ." in the tree root to revert all files but keep the merge record,
3340
and "bzr revert --forget-merges" to clear the pending merge list without
3341
reverting any files.
3344
_see_also = ['cat', 'export']
3347
Option('no-backup', "Do not save backups of reverted files."),
3348
Option('forget-merges',
3349
'Remove pending merge marker, without changing any files.'),
3351
takes_args = ['file*']
3353
def run(self, revision=None, no_backup=False, file_list=None,
3354
forget_merges=None):
3355
tree, file_list = tree_files(file_list)
3359
tree.set_parent_ids(tree.get_parent_ids()[:1])
3361
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3366
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3367
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3368
pb = ui.ui_factory.nested_progress_bar()
3370
tree.revert(file_list, rev_tree, not no_backup, pb,
3371
report_changes=True)
3376
class cmd_assert_fail(Command):
3377
"""Test reporting of assertion failures"""
3378
# intended just for use in testing
3383
raise AssertionError("always fails")
3386
class cmd_help(Command):
3387
"""Show help on a command or other topic.
3390
_see_also = ['topics']
3392
Option('long', 'Show help on all commands.'),
3394
takes_args = ['topic?']
3395
aliases = ['?', '--help', '-?', '-h']
3398
def run(self, topic=None, long=False):
3400
if topic is None and long:
3402
bzrlib.help.help(topic)
3405
class cmd_shell_complete(Command):
3406
"""Show appropriate completions for context.
3408
For a list of all available commands, say 'bzr shell-complete'.
3410
takes_args = ['context?']
3415
def run(self, context=None):
3416
import shellcomplete
3417
shellcomplete.shellcomplete(context)
3420
class cmd_missing(Command):
3421
"""Show unmerged/unpulled revisions between two branches.
3423
OTHER_BRANCH may be local or remote.
3426
_see_also = ['merge', 'pull']
3427
takes_args = ['other_branch?']
3429
Option('reverse', 'Reverse the order of revisions.'),
3431
'Display changes in the local branch only.'),
3432
Option('this' , 'Same as --mine-only.'),
3433
Option('theirs-only',
3434
'Display changes in the remote branch only.'),
3435
Option('other', 'Same as --theirs-only.'),
3439
Option('include-merges', 'Show merged revisions.'),
3441
encoding_type = 'replace'
3444
def run(self, other_branch=None, reverse=False, mine_only=False,
3446
log_format=None, long=False, short=False, line=False,
3447
show_ids=False, verbose=False, this=False, other=False,
3448
include_merges=False):
3449
from bzrlib.missing import find_unmerged, iter_log_revisions
3458
# TODO: We should probably check that we don't have mine-only and
3459
# theirs-only set, but it gets complicated because we also have
3460
# this and other which could be used.
3467
local_branch = Branch.open_containing(u".")[0]
3468
parent = local_branch.get_parent()
3469
if other_branch is None:
3470
other_branch = parent
3471
if other_branch is None:
3472
raise errors.BzrCommandError("No peer location known"
3474
display_url = urlutils.unescape_for_display(parent,
3476
message("Using saved parent location: "
3477
+ display_url + "\n")
3479
remote_branch = Branch.open(other_branch)
3480
if remote_branch.base == local_branch.base:
3481
remote_branch = local_branch
3482
local_branch.lock_read()
3484
remote_branch.lock_read()
3486
local_extra, remote_extra = find_unmerged(
3487
local_branch, remote_branch, restrict,
3488
backward=not reverse,
3489
include_merges=include_merges)
3491
if log_format is None:
3492
registry = log.log_formatter_registry
3493
log_format = registry.get_default(local_branch)
3494
lf = log_format(to_file=self.outf,
3496
show_timezone='original')
3499
if local_extra and not theirs_only:
3500
message("You have %d extra revision(s):\n" %
3502
for revision in iter_log_revisions(local_extra,
3503
local_branch.repository,
3505
lf.log_revision(revision)
3506
printed_local = True
3509
printed_local = False
3511
if remote_extra and not mine_only:
3512
if printed_local is True:
3514
message("You are missing %d revision(s):\n" %
3516
for revision in iter_log_revisions(remote_extra,
3517
remote_branch.repository,
3519
lf.log_revision(revision)
3522
if mine_only and not local_extra:
3523
# We checked local, and found nothing extra
3524
message('This branch is up to date.\n')
3525
elif theirs_only and not remote_extra:
3526
# We checked remote, and found nothing extra
3527
message('Other branch is up to date.\n')
3528
elif not (mine_only or theirs_only or local_extra or
3530
# We checked both branches, and neither one had extra
3532
message("Branches are up to date.\n")
3534
remote_branch.unlock()
3536
local_branch.unlock()
3537
if not status_code and parent is None and other_branch is not None:
3538
local_branch.lock_write()
3540
# handle race conditions - a parent might be set while we run.
3541
if local_branch.get_parent() is None:
3542
local_branch.set_parent(remote_branch.base)
3544
local_branch.unlock()
3548
class cmd_pack(Command):
3549
"""Compress the data within a repository."""
3551
_see_also = ['repositories']
3552
takes_args = ['branch_or_repo?']
3554
def run(self, branch_or_repo='.'):
3555
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3557
branch = dir.open_branch()
3558
repository = branch.repository
3559
except errors.NotBranchError:
3560
repository = dir.open_repository()
3564
class cmd_plugins(Command):
3565
"""List the installed plugins.
3567
This command displays the list of installed plugins including
3568
version of plugin and a short description of each.
3570
--verbose shows the path where each plugin is located.
3572
A plugin is an external component for Bazaar that extends the
3573
revision control system, by adding or replacing code in Bazaar.
3574
Plugins can do a variety of things, including overriding commands,
3575
adding new commands, providing additional network transports and
3576
customizing log output.
3578
See the Bazaar web site, http://bazaar-vcs.org, for further
3579
information on plugins including where to find them and how to
3580
install them. Instructions are also provided there on how to
3581
write new plugins using the Python programming language.
3583
takes_options = ['verbose']
3586
def run(self, verbose=False):
3587
import bzrlib.plugin
3588
from inspect import getdoc
3590
for name, plugin in bzrlib.plugin.plugins().items():
3591
version = plugin.__version__
3592
if version == 'unknown':
3594
name_ver = '%s %s' % (name, version)
3595
d = getdoc(plugin.module)
3597
doc = d.split('\n')[0]
3599
doc = '(no description)'
3600
result.append((name_ver, doc, plugin.path()))
3601
for name_ver, doc, path in sorted(result):
3609
class cmd_testament(Command):
3610
"""Show testament (signing-form) of a revision."""
3613
Option('long', help='Produce long-format testament.'),
3615
help='Produce a strict-format testament.')]
3616
takes_args = ['branch?']
3618
def run(self, branch=u'.', revision=None, long=False, strict=False):
3619
from bzrlib.testament import Testament, StrictTestament
3621
testament_class = StrictTestament
3623
testament_class = Testament
3625
b = Branch.open_containing(branch)[0]
3627
b = Branch.open(branch)
3630
if revision is None:
3631
rev_id = b.last_revision()
3633
rev_id = revision[0].as_revision_id(b)
3634
t = testament_class.from_revision(b.repository, rev_id)
3636
sys.stdout.writelines(t.as_text_lines())
3638
sys.stdout.write(t.as_short_text())
3643
class cmd_annotate(Command):
3644
"""Show the origin of each line in a file.
3646
This prints out the given file with an annotation on the left side
3647
indicating which revision, author and date introduced the change.
3649
If the origin is the same for a run of consecutive lines, it is
3650
shown only at the top, unless the --all option is given.
3652
# TODO: annotate directories; showing when each file was last changed
3653
# TODO: if the working copy is modified, show annotations on that
3654
# with new uncommitted lines marked
3655
aliases = ['ann', 'blame', 'praise']
3656
takes_args = ['filename']
3657
takes_options = [Option('all', help='Show annotations on all lines.'),
3658
Option('long', help='Show commit date in annotations.'),
3662
encoding_type = 'exact'
3665
def run(self, filename, all=False, long=False, revision=None,
3667
from bzrlib.annotate import annotate_file, annotate_file_tree
3668
wt, branch, relpath = \
3669
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3675
tree = _get_one_revision_tree('annotate', revision, branch=branch)
3677
file_id = wt.path2id(relpath)
3679
file_id = tree.path2id(relpath)
3681
raise errors.NotVersionedError(filename)
3682
file_version = tree.inventory[file_id].revision
3683
if wt is not None and revision is None:
3684
# If there is a tree and we're not annotating historical
3685
# versions, annotate the working tree's content.
3686
annotate_file_tree(wt, file_id, self.outf, long, all,
3689
annotate_file(branch, file_version, file_id, long, all, self.outf,
3698
class cmd_re_sign(Command):
3699
"""Create a digital signature for an existing revision."""
3700
# TODO be able to replace existing ones.
3702
hidden = True # is this right ?
3703
takes_args = ['revision_id*']
3704
takes_options = ['revision']
3706
def run(self, revision_id_list=None, revision=None):
3707
if revision_id_list is not None and revision is not None:
3708
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3709
if revision_id_list is None and revision is None:
3710
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3711
b = WorkingTree.open_containing(u'.')[0].branch
3714
return self._run(b, revision_id_list, revision)
3718
def _run(self, b, revision_id_list, revision):
3719
import bzrlib.gpg as gpg
3720
gpg_strategy = gpg.GPGStrategy(b.get_config())
3721
if revision_id_list is not None:
3722
b.repository.start_write_group()
3724
for revision_id in revision_id_list:
3725
b.repository.sign_revision(revision_id, gpg_strategy)
3727
b.repository.abort_write_group()
3730
b.repository.commit_write_group()
3731
elif revision is not None:
3732
if len(revision) == 1:
3733
revno, rev_id = revision[0].in_history(b)
3734
b.repository.start_write_group()
3736
b.repository.sign_revision(rev_id, gpg_strategy)
3738
b.repository.abort_write_group()
3741
b.repository.commit_write_group()
3742
elif len(revision) == 2:
3743
# are they both on rh- if so we can walk between them
3744
# might be nice to have a range helper for arbitrary
3745
# revision paths. hmm.
3746
from_revno, from_revid = revision[0].in_history(b)
3747
to_revno, to_revid = revision[1].in_history(b)
3748
if to_revid is None:
3749
to_revno = b.revno()
3750
if from_revno is None or to_revno is None:
3751
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3752
b.repository.start_write_group()
3754
for revno in range(from_revno, to_revno + 1):
3755
b.repository.sign_revision(b.get_rev_id(revno),
3758
b.repository.abort_write_group()
3761
b.repository.commit_write_group()
3763
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3766
class cmd_bind(Command):
3767
"""Convert the current branch into a checkout of the supplied branch.
3769
Once converted into a checkout, commits must succeed on the master branch
3770
before they will be applied to the local branch.
3772
Bound branches use the nickname of its master branch unless it is set
3773
locally, in which case binding will update the the local nickname to be
3777
_see_also = ['checkouts', 'unbind']
3778
takes_args = ['location?']
3781
def run(self, location=None):
3782
b, relpath = Branch.open_containing(u'.')
3783
if location is None:
3785
location = b.get_old_bound_location()
3786
except errors.UpgradeRequired:
3787
raise errors.BzrCommandError('No location supplied. '
3788
'This format does not remember old locations.')
3790
if location is None:
3791
raise errors.BzrCommandError('No location supplied and no '
3792
'previous location known')
3793
b_other = Branch.open(location)
3796
except errors.DivergedBranches:
3797
raise errors.BzrCommandError('These branches have diverged.'
3798
' Try merging, and then bind again.')
3799
if b.get_config().has_explicit_nickname():
3800
b.nick = b_other.nick
3803
class cmd_unbind(Command):
3804
"""Convert the current checkout into a regular branch.
3806
After unbinding, the local branch is considered independent and subsequent
3807
commits will be local only.
3810
_see_also = ['checkouts', 'bind']
3815
b, relpath = Branch.open_containing(u'.')
3817
raise errors.BzrCommandError('Local branch is not bound')
3820
class cmd_uncommit(Command):
3821
"""Remove the last committed revision.
3823
--verbose will print out what is being removed.
3824
--dry-run will go through all the motions, but not actually
3827
If --revision is specified, uncommit revisions to leave the branch at the
3828
specified revision. For example, "bzr uncommit -r 15" will leave the
3829
branch at revision 15.
3831
Uncommit leaves the working tree ready for a new commit. The only change
3832
it may make is to restore any pending merges that were present before
3836
# TODO: jam 20060108 Add an option to allow uncommit to remove
3837
# unreferenced information in 'branch-as-repository' branches.
3838
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3839
# information in shared branches as well.
3840
_see_also = ['commit']
3841
takes_options = ['verbose', 'revision',
3842
Option('dry-run', help='Don\'t actually make changes.'),
3843
Option('force', help='Say yes to all questions.'),
3845
help="Only remove the commits from the local branch"
3846
" when in a checkout."
3849
takes_args = ['location?']
3851
encoding_type = 'replace'
3853
def run(self, location=None,
3854
dry_run=False, verbose=False,
3855
revision=None, force=False, local=False):
3856
if location is None:
3858
control, relpath = bzrdir.BzrDir.open_containing(location)
3860
tree = control.open_workingtree()
3862
except (errors.NoWorkingTree, errors.NotLocalUrl):
3864
b = control.open_branch()
3866
if tree is not None:
3871
return self._run(b, tree, dry_run, verbose, revision, force,
3874
if tree is not None:
3879
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3880
from bzrlib.log import log_formatter, show_log
3881
from bzrlib.uncommit import uncommit
3883
last_revno, last_rev_id = b.last_revision_info()
3886
if revision is None:
3888
rev_id = last_rev_id
3890
# 'bzr uncommit -r 10' actually means uncommit
3891
# so that the final tree is at revno 10.
3892
# but bzrlib.uncommit.uncommit() actually uncommits
3893
# the revisions that are supplied.
3894
# So we need to offset it by one
3895
revno = revision[0].in_history(b).revno + 1
3896
if revno <= last_revno:
3897
rev_id = b.get_rev_id(revno)
3899
if rev_id is None or _mod_revision.is_null(rev_id):
3900
self.outf.write('No revisions to uncommit.\n')
3903
lf = log_formatter('short',
3905
show_timezone='original')
3910
direction='forward',
3911
start_revision=revno,
3912
end_revision=last_revno)
3915
print 'Dry-run, pretending to remove the above revisions.'
3917
val = raw_input('Press <enter> to continue')
3919
print 'The above revision(s) will be removed.'
3921
val = raw_input('Are you sure [y/N]? ')
3922
if val.lower() not in ('y', 'yes'):
3926
mutter('Uncommitting from {%s} to {%s}',
3927
last_rev_id, rev_id)
3928
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3929
revno=revno, local=local)
3930
note('You can restore the old tip by running:\n'
3931
' bzr pull . -r revid:%s', last_rev_id)
3934
class cmd_break_lock(Command):
3935
"""Break a dead lock on a repository, branch or working directory.
3937
CAUTION: Locks should only be broken when you are sure that the process
3938
holding the lock has been stopped.
3940
You can get information on what locks are open via the 'bzr info' command.
3945
takes_args = ['location?']
3947
def run(self, location=None, show=False):
3948
if location is None:
3950
control, relpath = bzrdir.BzrDir.open_containing(location)
3952
control.break_lock()
3953
except NotImplementedError:
3957
class cmd_wait_until_signalled(Command):
3958
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3960
This just prints a line to signal when it is ready, then blocks on stdin.
3966
sys.stdout.write("running\n")
3968
sys.stdin.readline()
3971
class cmd_serve(Command):
3972
"""Run the bzr server."""
3974
aliases = ['server']
3978
help='Serve on stdin/out for use from inetd or sshd.'),
3980
help='Listen for connections on nominated port of the form '
3981
'[hostname:]portnumber. Passing 0 as the port number will '
3982
'result in a dynamically allocated port. The default port is '
3986
help='Serve contents of this directory.',
3988
Option('allow-writes',
3989
help='By default the server is a readonly server. Supplying '
3990
'--allow-writes enables write access to the contents of '
3991
'the served directory and below.'
3995
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3996
from bzrlib import lockdir
3997
from bzrlib.smart import medium, server
3998
from bzrlib.transport import get_transport
3999
from bzrlib.transport.chroot import ChrootServer
4000
if directory is None:
4001
directory = os.getcwd()
4002
url = urlutils.local_path_to_url(directory)
4003
if not allow_writes:
4004
url = 'readonly+' + url
4005
chroot_server = ChrootServer(get_transport(url))
4006
chroot_server.setUp()
4007
t = get_transport(chroot_server.get_url())
4009
smart_server = medium.SmartServerPipeStreamMedium(
4010
sys.stdin, sys.stdout, t)
4012
host = medium.BZR_DEFAULT_INTERFACE
4014
port = medium.BZR_DEFAULT_PORT
4017
host, port = port.split(':')
4019
smart_server = server.SmartTCPServer(t, host=host, port=port)
4020
print 'listening on port: ', smart_server.port
4022
# for the duration of this server, no UI output is permitted.
4023
# note that this may cause problems with blackbox tests. This should
4024
# be changed with care though, as we dont want to use bandwidth sending
4025
# progress over stderr to smart server clients!
4026
old_factory = ui.ui_factory
4027
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4029
ui.ui_factory = ui.SilentUIFactory()
4030
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4031
smart_server.serve()
4033
ui.ui_factory = old_factory
4034
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4037
class cmd_join(Command):
4038
"""Combine a subtree into its containing tree.
4040
This command is for experimental use only. It requires the target tree
4041
to be in dirstate-with-subtree format, which cannot be converted into
4044
The TREE argument should be an independent tree, inside another tree, but
4045
not part of it. (Such trees can be produced by "bzr split", but also by
4046
running "bzr branch" with the target inside a tree.)
4048
The result is a combined tree, with the subtree no longer an independant
4049
part. This is marked as a merge of the subtree into the containing tree,
4050
and all history is preserved.
4052
If --reference is specified, the subtree retains its independence. It can
4053
be branched by itself, and can be part of multiple projects at the same
4054
time. But operations performed in the containing tree, such as commit
4055
and merge, will recurse into the subtree.
4058
_see_also = ['split']
4059
takes_args = ['tree']
4061
Option('reference', help='Join by reference.'),
4065
def run(self, tree, reference=False):
4066
sub_tree = WorkingTree.open(tree)
4067
parent_dir = osutils.dirname(sub_tree.basedir)
4068
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4069
repo = containing_tree.branch.repository
4070
if not repo.supports_rich_root():
4071
raise errors.BzrCommandError(
4072
"Can't join trees because %s doesn't support rich root data.\n"
4073
"You can use bzr upgrade on the repository."
4077
containing_tree.add_reference(sub_tree)
4078
except errors.BadReferenceTarget, e:
4079
# XXX: Would be better to just raise a nicely printable
4080
# exception from the real origin. Also below. mbp 20070306
4081
raise errors.BzrCommandError("Cannot join %s. %s" %
4085
containing_tree.subsume(sub_tree)
4086
except errors.BadSubsumeSource, e:
4087
raise errors.BzrCommandError("Cannot join %s. %s" %
4091
class cmd_split(Command):
4092
"""Split a subdirectory of a tree into a separate tree.
4094
This command will produce a target tree in a format that supports
4095
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4096
converted into earlier formats like 'dirstate-tags'.
4098
The TREE argument should be a subdirectory of a working tree. That
4099
subdirectory will be converted into an independent tree, with its own
4100
branch. Commits in the top-level tree will not apply to the new subtree.
4103
# join is not un-hidden yet
4104
#_see_also = ['join']
4105
takes_args = ['tree']
4107
def run(self, tree):
4108
containing_tree, subdir = WorkingTree.open_containing(tree)
4109
sub_id = containing_tree.path2id(subdir)
4111
raise errors.NotVersionedError(subdir)
4113
containing_tree.extract(sub_id)
4114
except errors.RootNotRich:
4115
raise errors.UpgradeRequired(containing_tree.branch.base)
4118
class cmd_merge_directive(Command):
4119
"""Generate a merge directive for auto-merge tools.
4121
A directive requests a merge to be performed, and also provides all the
4122
information necessary to do so. This means it must either include a
4123
revision bundle, or the location of a branch containing the desired
4126
A submit branch (the location to merge into) must be supplied the first
4127
time the command is issued. After it has been supplied once, it will
4128
be remembered as the default.
4130
A public branch is optional if a revision bundle is supplied, but required
4131
if --diff or --plain is specified. It will be remembered as the default
4132
after the first use.
4135
takes_args = ['submit_branch?', 'public_branch?']
4139
_see_also = ['send']
4142
RegistryOption.from_kwargs('patch-type',
4143
'The type of patch to include in the directive.',
4145
value_switches=True,
4147
bundle='Bazaar revision bundle (default).',
4148
diff='Normal unified diff.',
4149
plain='No patch, just directive.'),
4150
Option('sign', help='GPG-sign the directive.'), 'revision',
4151
Option('mail-to', type=str,
4152
help='Instead of printing the directive, email to this address.'),
4153
Option('message', type=str, short_name='m',
4154
help='Message to use when committing this merge.')
4157
encoding_type = 'exact'
4159
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4160
sign=False, revision=None, mail_to=None, message=None):
4161
from bzrlib.revision import ensure_null, NULL_REVISION
4162
include_patch, include_bundle = {
4163
'plain': (False, False),
4164
'diff': (True, False),
4165
'bundle': (True, True),
4167
branch = Branch.open('.')
4168
stored_submit_branch = branch.get_submit_branch()
4169
if submit_branch is None:
4170
submit_branch = stored_submit_branch
4172
if stored_submit_branch is None:
4173
branch.set_submit_branch(submit_branch)
4174
if submit_branch is None:
4175
submit_branch = branch.get_parent()
4176
if submit_branch is None:
4177
raise errors.BzrCommandError('No submit branch specified or known')
4179
stored_public_branch = branch.get_public_branch()
4180
if public_branch is None:
4181
public_branch = stored_public_branch
4182
elif stored_public_branch is None:
4183
branch.set_public_branch(public_branch)
4184
if not include_bundle and public_branch is None:
4185
raise errors.BzrCommandError('No public branch specified or'
4187
base_revision_id = None
4188
if revision is not None:
4189
if len(revision) > 2:
4190
raise errors.BzrCommandError('bzr merge-directive takes '
4191
'at most two one revision identifiers')
4192
revision_id = revision[-1].as_revision_id(branch)
4193
if len(revision) == 2:
4194
base_revision_id = revision[0].as_revision_id(branch)
4196
revision_id = branch.last_revision()
4197
revision_id = ensure_null(revision_id)
4198
if revision_id == NULL_REVISION:
4199
raise errors.BzrCommandError('No revisions to bundle.')
4200
directive = merge_directive.MergeDirective2.from_objects(
4201
branch.repository, revision_id, time.time(),
4202
osutils.local_time_offset(), submit_branch,
4203
public_branch=public_branch, include_patch=include_patch,
4204
include_bundle=include_bundle, message=message,
4205
base_revision_id=base_revision_id)
4208
self.outf.write(directive.to_signed(branch))
4210
self.outf.writelines(directive.to_lines())
4212
message = directive.to_email(mail_to, branch, sign)
4213
s = SMTPConnection(branch.get_config())
4214
s.send_email(message)
4217
class cmd_send(Command):
4218
"""Mail or create a merge-directive for submiting changes.
4220
A merge directive provides many things needed for requesting merges:
4222
* A machine-readable description of the merge to perform
4224
* An optional patch that is a preview of the changes requested
4226
* An optional bundle of revision data, so that the changes can be applied
4227
directly from the merge directive, without retrieving data from a
4230
If --no-bundle is specified, then public_branch is needed (and must be
4231
up-to-date), so that the receiver can perform the merge using the
4232
public_branch. The public_branch is always included if known, so that
4233
people can check it later.
4235
The submit branch defaults to the parent, but can be overridden. Both
4236
submit branch and public branch will be remembered if supplied.
4238
If a public_branch is known for the submit_branch, that public submit
4239
branch is used in the merge instructions. This means that a local mirror
4240
can be used as your actual submit branch, once you have set public_branch
4243
Mail is sent using your preferred mail program. This should be transparent
4244
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4245
If the preferred client can't be found (or used), your editor will be used.
4247
To use a specific mail program, set the mail_client configuration option.
4248
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4249
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4250
generic options are "default", "editor", "emacsclient", "mapi", and
4251
"xdg-email". Plugins may also add supported clients.
4253
If mail is being sent, a to address is required. This can be supplied
4254
either on the commandline, by setting the submit_to configuration
4255
option in the branch itself or the child_submit_to configuration option
4256
in the submit branch.
4258
Two formats are currently supported: "4" uses revision bundle format 4 and
4259
merge directive format 2. It is significantly faster and smaller than
4260
older formats. It is compatible with Bazaar 0.19 and later. It is the
4261
default. "0.9" uses revision bundle format 0.9 and merge directive
4262
format 1. It is compatible with Bazaar 0.12 - 0.18.
4264
Merge directives are applied using the merge command or the pull command.
4267
encoding_type = 'exact'
4269
_see_also = ['merge', 'pull']
4271
takes_args = ['submit_branch?', 'public_branch?']
4275
help='Do not include a bundle in the merge directive.'),
4276
Option('no-patch', help='Do not include a preview patch in the merge'
4279
help='Remember submit and public branch.'),
4281
help='Branch to generate the submission from, '
4282
'rather than the one containing the working directory.',
4285
Option('output', short_name='o',
4286
help='Write merge directive to this file; '
4287
'use - for stdout.',
4289
Option('mail-to', help='Mail the request to this address.',
4293
RegistryOption.from_kwargs('format',
4294
'Use the specified output format.',
4295
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4296
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4299
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4300
no_patch=False, revision=None, remember=False, output=None,
4301
format='4', mail_to=None, message=None, **kwargs):
4302
return self._run(submit_branch, revision, public_branch, remember,
4303
format, no_bundle, no_patch, output,
4304
kwargs.get('from', '.'), mail_to, message)
4306
def _run(self, submit_branch, revision, public_branch, remember, format,
4307
no_bundle, no_patch, output, from_, mail_to, message):
4308
from bzrlib.revision import NULL_REVISION
4309
branch = Branch.open_containing(from_)[0]
4311
outfile = cStringIO.StringIO()
4315
outfile = open(output, 'wb')
4316
# we may need to write data into branch's repository to calculate
4321
config = branch.get_config()
4323
mail_to = config.get_user_option('submit_to')
4324
mail_client = config.get_mail_client()
4325
if remember and submit_branch is None:
4326
raise errors.BzrCommandError(
4327
'--remember requires a branch to be specified.')
4328
stored_submit_branch = branch.get_submit_branch()
4329
remembered_submit_branch = None
4330
if submit_branch is None:
4331
submit_branch = stored_submit_branch
4332
remembered_submit_branch = "submit"
4334
if stored_submit_branch is None or remember:
4335
branch.set_submit_branch(submit_branch)
4336
if submit_branch is None:
4337
submit_branch = branch.get_parent()
4338
remembered_submit_branch = "parent"
4339
if submit_branch is None:
4340
raise errors.BzrCommandError('No submit branch known or'
4342
if remembered_submit_branch is not None:
4343
note('Using saved %s location "%s" to determine what '
4344
'changes to submit.', remembered_submit_branch,
4348
submit_config = Branch.open(submit_branch).get_config()
4349
mail_to = submit_config.get_user_option("child_submit_to")
4351
stored_public_branch = branch.get_public_branch()
4352
if public_branch is None:
4353
public_branch = stored_public_branch
4354
elif stored_public_branch is None or remember:
4355
branch.set_public_branch(public_branch)
4356
if no_bundle and public_branch is None:
4357
raise errors.BzrCommandError('No public branch specified or'
4359
base_revision_id = None
4361
if revision is not None:
4362
if len(revision) > 2:
4363
raise errors.BzrCommandError('bzr send takes '
4364
'at most two one revision identifiers')
4365
revision_id = revision[-1].as_revision_id(branch)
4366
if len(revision) == 2:
4367
base_revision_id = revision[0].as_revision_id(branch)
4368
if revision_id is None:
4369
revision_id = branch.last_revision()
4370
if revision_id == NULL_REVISION:
4371
raise errors.BzrCommandError('No revisions to submit.')
4373
directive = merge_directive.MergeDirective2.from_objects(
4374
branch.repository, revision_id, time.time(),
4375
osutils.local_time_offset(), submit_branch,
4376
public_branch=public_branch, include_patch=not no_patch,
4377
include_bundle=not no_bundle, message=message,
4378
base_revision_id=base_revision_id)
4379
elif format == '0.9':
4382
patch_type = 'bundle'
4384
raise errors.BzrCommandError('Format 0.9 does not'
4385
' permit bundle with no patch')
4391
directive = merge_directive.MergeDirective.from_objects(
4392
branch.repository, revision_id, time.time(),
4393
osutils.local_time_offset(), submit_branch,
4394
public_branch=public_branch, patch_type=patch_type,
4397
outfile.writelines(directive.to_lines())
4399
subject = '[MERGE] '
4400
if message is not None:
4403
revision = branch.repository.get_revision(revision_id)
4404
subject += revision.get_summary()
4405
basename = directive.get_disk_name(branch)
4406
mail_client.compose_merge_request(mail_to, subject,
4407
outfile.getvalue(), basename)
4414
class cmd_bundle_revisions(cmd_send):
4416
"""Create a merge-directive for submiting changes.
4418
A merge directive provides many things needed for requesting merges:
4420
* A machine-readable description of the merge to perform
4422
* An optional patch that is a preview of the changes requested
4424
* An optional bundle of revision data, so that the changes can be applied
4425
directly from the merge directive, without retrieving data from a
4428
If --no-bundle is specified, then public_branch is needed (and must be
4429
up-to-date), so that the receiver can perform the merge using the
4430
public_branch. The public_branch is always included if known, so that
4431
people can check it later.
4433
The submit branch defaults to the parent, but can be overridden. Both
4434
submit branch and public branch will be remembered if supplied.
4436
If a public_branch is known for the submit_branch, that public submit
4437
branch is used in the merge instructions. This means that a local mirror
4438
can be used as your actual submit branch, once you have set public_branch
4441
Two formats are currently supported: "4" uses revision bundle format 4 and
4442
merge directive format 2. It is significantly faster and smaller than
4443
older formats. It is compatible with Bazaar 0.19 and later. It is the
4444
default. "0.9" uses revision bundle format 0.9 and merge directive
4445
format 1. It is compatible with Bazaar 0.12 - 0.18.
4450
help='Do not include a bundle in the merge directive.'),
4451
Option('no-patch', help='Do not include a preview patch in the merge'
4454
help='Remember submit and public branch.'),
4456
help='Branch to generate the submission from, '
4457
'rather than the one containing the working directory.',
4460
Option('output', short_name='o', help='Write directive to this file.',
4463
RegistryOption.from_kwargs('format',
4464
'Use the specified output format.',
4465
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4466
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4468
aliases = ['bundle']
4470
_see_also = ['send', 'merge']
4474
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4475
no_patch=False, revision=None, remember=False, output=None,
4476
format='4', **kwargs):
4479
return self._run(submit_branch, revision, public_branch, remember,
4480
format, no_bundle, no_patch, output,
4481
kwargs.get('from', '.'), None, None)
4484
class cmd_tag(Command):
4485
"""Create, remove or modify a tag naming a revision.
4487
Tags give human-meaningful names to revisions. Commands that take a -r
4488
(--revision) option can be given -rtag:X, where X is any previously
4491
Tags are stored in the branch. Tags are copied from one branch to another
4492
along when you branch, push, pull or merge.
4494
It is an error to give a tag name that already exists unless you pass
4495
--force, in which case the tag is moved to point to the new revision.
4497
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4498
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4501
_see_also = ['commit', 'tags']
4502
takes_args = ['tag_name']
4505
help='Delete this tag rather than placing it.',
4508
help='Branch in which to place the tag.',
4513
help='Replace existing tags.',
4518
def run(self, tag_name,
4524
branch, relpath = Branch.open_containing(directory)
4528
branch.tags.delete_tag(tag_name)
4529
self.outf.write('Deleted tag %s.\n' % tag_name)
4532
if len(revision) != 1:
4533
raise errors.BzrCommandError(
4534
"Tags can only be placed on a single revision, "
4536
revision_id = revision[0].as_revision_id(branch)
4538
revision_id = branch.last_revision()
4539
if (not force) and branch.tags.has_tag(tag_name):
4540
raise errors.TagAlreadyExists(tag_name)
4541
branch.tags.set_tag(tag_name, revision_id)
4542
self.outf.write('Created tag %s.\n' % tag_name)
4547
class cmd_tags(Command):
4550
This command shows a table of tag names and the revisions they reference.
4556
help='Branch whose tags should be displayed.',
4560
RegistryOption.from_kwargs('sort',
4561
'Sort tags by different criteria.', title='Sorting',
4562
alpha='Sort tags lexicographically (default).',
4563
time='Sort tags chronologically.',
4574
branch, relpath = Branch.open_containing(directory)
4575
tags = branch.tags.get_tag_dict().items()
4580
elif sort == 'time':
4582
for tag, revid in tags:
4584
revobj = branch.repository.get_revision(revid)
4585
except errors.NoSuchRevision:
4586
timestamp = sys.maxint # place them at the end
4588
timestamp = revobj.timestamp
4589
timestamps[revid] = timestamp
4590
tags.sort(key=lambda x: timestamps[x[1]])
4592
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4593
revno_map = branch.get_revision_id_to_revno_map()
4594
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4595
for tag, revid in tags ]
4596
for tag, revspec in tags:
4597
self.outf.write('%-20s %s\n' % (tag, revspec))
4600
class cmd_reconfigure(Command):
4601
"""Reconfigure the type of a bzr directory.
4603
A target configuration must be specified.
4605
For checkouts, the bind-to location will be auto-detected if not specified.
4606
The order of preference is
4607
1. For a lightweight checkout, the current bound location.
4608
2. For branches that used to be checkouts, the previously-bound location.
4609
3. The push location.
4610
4. The parent location.
4611
If none of these is available, --bind-to must be specified.
4614
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4615
takes_args = ['location?']
4616
takes_options = [RegistryOption.from_kwargs('target_type',
4617
title='Target type',
4618
help='The type to reconfigure the directory to.',
4619
value_switches=True, enum_switch=False,
4620
branch='Reconfigure to be an unbound branch '
4621
'with no working tree.',
4622
tree='Reconfigure to be an unbound branch '
4623
'with a working tree.',
4624
checkout='Reconfigure to be a bound branch '
4625
'with a working tree.',
4626
lightweight_checkout='Reconfigure to be a lightweight'
4627
' checkout (with no local history).',
4628
standalone='Reconfigure to be a standalone branch '
4629
'(i.e. stop using shared repository).',
4630
use_shared='Reconfigure to use a shared repository.'),
4631
Option('bind-to', help='Branch to bind checkout to.',
4634
help='Perform reconfiguration even if local changes'
4638
def run(self, location=None, target_type=None, bind_to=None, force=False):
4639
directory = bzrdir.BzrDir.open(location)
4640
if target_type is None:
4641
raise errors.BzrCommandError('No target configuration specified')
4642
elif target_type == 'branch':
4643
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4644
elif target_type == 'tree':
4645
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4646
elif target_type == 'checkout':
4647
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4649
elif target_type == 'lightweight-checkout':
4650
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4652
elif target_type == 'use-shared':
4653
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4654
elif target_type == 'standalone':
4655
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4656
reconfiguration.apply(force)
4659
class cmd_switch(Command):
4660
"""Set the branch of a checkout and update.
4662
For lightweight checkouts, this changes the branch being referenced.
4663
For heavyweight checkouts, this checks that there are no local commits
4664
versus the current bound branch, then it makes the local branch a mirror
4665
of the new location and binds to it.
4667
In both cases, the working tree is updated and uncommitted changes
4668
are merged. The user can commit or revert these as they desire.
4670
Pending merges need to be committed or reverted before using switch.
4672
The path to the branch to switch to can be specified relative to the parent
4673
directory of the current branch. For example, if you are currently in a
4674
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4677
Bound branches use the nickname of its master branch unless it is set
4678
locally, in which case switching will update the the local nickname to be
4682
takes_args = ['to_location']
4683
takes_options = [Option('force',
4684
help='Switch even if local commits will be lost.')
4687
def run(self, to_location, force=False):
4688
from bzrlib import switch
4690
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4691
branch = control_dir.open_branch()
4693
to_branch = Branch.open(to_location)
4694
except errors.NotBranchError:
4695
this_branch = control_dir.open_branch()
4696
# This may be a heavy checkout, where we want the master branch
4697
this_url = this_branch.get_bound_location()
4698
# If not, use a local sibling
4699
if this_url is None:
4700
this_url = this_branch.base
4701
to_branch = Branch.open(
4702
urlutils.join(this_url, '..', to_location))
4703
switch.switch(control_dir, to_branch, force)
4704
if branch.get_config().has_explicit_nickname():
4705
branch = control_dir.open_branch() #get the new branch!
4706
branch.nick = to_branch.nick
4707
note('Switched to branch: %s',
4708
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4711
class cmd_hooks(Command):
4712
"""Show a branch's currently registered hooks.
4716
takes_args = ['path?']
4718
def run(self, path=None):
4721
branch_hooks = Branch.open(path).hooks
4722
for hook_type in branch_hooks:
4723
hooks = branch_hooks[hook_type]
4724
self.outf.write("%s:\n" % (hook_type,))
4727
self.outf.write(" %s\n" %
4728
(branch_hooks.get_hook_name(hook),))
4730
self.outf.write(" <no hooks installed>\n")
4733
class cmd_shelve(Command):
4734
"""Temporarily set aside some changes from the current tree.
4736
Shelve allows you to temporarily put changes you've made "on the shelf",
4737
ie. out of the way, until a later time when you can bring them back from
4738
the shelf with the 'unshelve' command.
4740
Shelve is intended to help separate several sets of changes that have
4741
been inappropriately mingled. If you just want to get rid of all changes
4742
and you don't need to restore them later, use revert. If you want to
4743
shelve all text changes at once, use shelve --all.
4745
If filenames are specified, only the changes to those files will be
4746
shelved. Other files will be left untouched.
4748
If a revision is specified, changes since that revision will be shelved.
4750
You can put multiple items on the shelf, and by default, 'unshelve' will
4751
restore the most recently shelved changes.
4754
takes_args = ['file*']
4758
Option('all', help='Shelve all changes.'),
4760
RegistryOption('writer', 'Method to use for writing diffs.',
4761
bzrlib.option.diff_writer_registry,
4762
value_switches=True, enum_switch=False)
4764
_see_also = ['unshelve']
4766
def run(self, revision=None, all=False, file_list=None, message=None,
4768
from bzrlib.shelf_ui import Shelver
4770
writer = bzrlib.option.diff_writer_registry.get()
4772
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
4774
except errors.UserAbort:
4778
class cmd_unshelve(Command):
4779
"""Restore shelved changes.
4781
By default, the most recently shelved changes are restored. However if you
4782
specify a patch by name those changes will be restored instead. This
4783
works best when the changes don't depend on each other.
4786
takes_args = ['shelf_id?']
4788
RegistryOption.from_kwargs(
4789
'action', help="The action to perform.",
4790
enum_switch=False, value_switches=True,
4791
apply="Apply changes and remove from the shelf.",
4792
dry_run="Show changes, but do not apply or remove them.",
4793
delete_only="Delete changes without applying them."
4796
_see_also = ['shelve']
4798
def run(self, shelf_id=None, action='apply'):
4799
from bzrlib.shelf_ui import Unshelver
4800
Unshelver.from_args(shelf_id, action).run()
4803
def _create_prefix(cur_transport):
4804
needed = [cur_transport]
4805
# Recurse upwards until we can create a directory successfully
4807
new_transport = cur_transport.clone('..')
4808
if new_transport.base == cur_transport.base:
4809
raise errors.BzrCommandError(
4810
"Failed to create path prefix for %s."
4811
% cur_transport.base)
4813
new_transport.mkdir('.')
4814
except errors.NoSuchFile:
4815
needed.append(new_transport)
4816
cur_transport = new_transport
4819
# Now we only need to create child directories
4821
cur_transport = needed.pop()
4822
cur_transport.ensure_base()
4825
# these get imported and then picked up by the scan for cmd_*
4826
# TODO: Some more consistent way to split command definitions across files;
4827
# we do need to load at least some information about them to know of
4828
# aliases. ideally we would avoid loading the implementation until the
4829
# details were needed.
4830
from bzrlib.cmd_version_info import cmd_version_info
4831
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4832
from bzrlib.bundle.commands import (
4835
from bzrlib.sign_my_commits import cmd_sign_my_commits
4836
from bzrlib.weave_commands import cmd_versionedfile_list, \
4837
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
