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, get_verbosity_level
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
source_branch=br_from)
982
branch = dir.open_branch()
983
except errors.NoSuchRevision:
984
to_transport.delete_tree('.')
985
msg = "The branch %s has no revision %s." % (from_location,
987
raise errors.BzrCommandError(msg)
988
_merge_tags_if_possible(br_from, branch)
989
# If the source branch is stacked, the new branch may
990
# be stacked whether we asked for that explicitly or not.
991
# We therefore need a try/except here and not just 'if stacked:'
993
note('Created new stacked branch referring to %s.' %
994
branch.get_stacked_on_url())
995
except (errors.NotStacked, errors.UnstackableBranchFormat,
996
errors.UnstackableRepositoryFormat), e:
997
note('Branched %d revision(s).' % branch.revno())
1002
class cmd_checkout(Command):
1003
"""Create a new checkout of an existing branch.
1005
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1006
the branch found in '.'. This is useful if you have removed the working tree
1007
or if it was never created - i.e. if you pushed the branch to its current
1008
location using SFTP.
1010
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1011
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1012
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1013
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1014
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1017
To retrieve the branch as of a particular revision, supply the --revision
1018
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1019
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1023
_see_also = ['checkouts', 'branch']
1024
takes_args = ['branch_location?', 'to_location?']
1025
takes_options = ['revision',
1026
Option('lightweight',
1027
help="Perform a lightweight checkout. Lightweight "
1028
"checkouts depend on access to the branch for "
1029
"every operation. Normal checkouts can perform "
1030
"common operations like diff and status without "
1031
"such access, and also support local commits."
1033
Option('files-from', type=str,
1034
help="Get file contents from this tree."),
1036
help='Hard-link working tree files where possible.'
1041
def run(self, branch_location=None, to_location=None, revision=None,
1042
lightweight=False, files_from=None, hardlink=False):
1043
if revision is None:
1045
elif len(revision) > 1:
1046
raise errors.BzrCommandError(
1047
'bzr checkout --revision takes exactly 1 revision value')
1048
if branch_location is None:
1049
branch_location = osutils.getcwd()
1050
to_location = branch_location
1051
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1053
if files_from is not None:
1054
accelerator_tree = WorkingTree.open(files_from)
1055
if len(revision) == 1 and revision[0] is not None:
1056
revision_id = revision[0].as_revision_id(source)
1059
if to_location is None:
1060
to_location = urlutils.derive_to_location(branch_location)
1061
# if the source and to_location are the same,
1062
# and there is no working tree,
1063
# then reconstitute a branch
1064
if (osutils.abspath(to_location) ==
1065
osutils.abspath(branch_location)):
1067
source.bzrdir.open_workingtree()
1068
except errors.NoWorkingTree:
1069
source.bzrdir.create_workingtree(revision_id)
1071
source.create_checkout(to_location, revision_id, lightweight,
1072
accelerator_tree, hardlink)
1075
class cmd_renames(Command):
1076
"""Show list of renamed files.
1078
# TODO: Option to show renames between two historical versions.
1080
# TODO: Only show renames under dir, rather than in the whole branch.
1081
_see_also = ['status']
1082
takes_args = ['dir?']
1085
def run(self, dir=u'.'):
1086
tree = WorkingTree.open_containing(dir)[0]
1089
new_inv = tree.inventory
1090
old_tree = tree.basis_tree()
1091
old_tree.lock_read()
1093
old_inv = old_tree.inventory
1095
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1096
for f, paths, c, v, p, n, k, e in iterator:
1097
if paths[0] == paths[1]:
1101
renames.append(paths)
1103
for old_name, new_name in renames:
1104
self.outf.write("%s => %s\n" % (old_name, new_name))
1111
class cmd_update(Command):
1112
"""Update a tree to have the latest code committed to its branch.
1114
This will perform a merge into the working tree, and may generate
1115
conflicts. If you have any local changes, you will still
1116
need to commit them after the update for the update to be complete.
1118
If you want to discard your local changes, you can just do a
1119
'bzr revert' instead of 'bzr commit' after the update.
1122
_see_also = ['pull', 'working-trees', 'status-flags']
1123
takes_args = ['dir?']
1126
def run(self, dir='.'):
1127
tree = WorkingTree.open_containing(dir)[0]
1128
possible_transports = []
1129
master = tree.branch.get_master_branch(
1130
possible_transports=possible_transports)
1131
if master is not None:
1134
tree.lock_tree_write()
1136
existing_pending_merges = tree.get_parent_ids()[1:]
1137
last_rev = _mod_revision.ensure_null(tree.last_revision())
1138
if last_rev == _mod_revision.ensure_null(
1139
tree.branch.last_revision()):
1140
# may be up to date, check master too.
1141
if master is None or last_rev == _mod_revision.ensure_null(
1142
master.last_revision()):
1143
revno = tree.branch.revision_id_to_revno(last_rev)
1144
note("Tree is up to date at revision %d." % (revno,))
1146
conflicts = tree.update(
1147
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1148
possible_transports=possible_transports)
1149
revno = tree.branch.revision_id_to_revno(
1150
_mod_revision.ensure_null(tree.last_revision()))
1151
note('Updated to revision %d.' % (revno,))
1152
if tree.get_parent_ids()[1:] != existing_pending_merges:
1153
note('Your local commits will now show as pending merges with '
1154
"'bzr status', and can be committed with 'bzr commit'.")
1163
class cmd_info(Command):
1164
"""Show information about a working tree, branch or repository.
1166
This command will show all known locations and formats associated to the
1167
tree, branch or repository. Statistical information is included with
1170
Branches and working trees will also report any missing revisions.
1172
_see_also = ['revno', 'working-trees', 'repositories']
1173
takes_args = ['location?']
1174
takes_options = ['verbose']
1175
encoding_type = 'replace'
1178
def run(self, location=None, verbose=False):
1183
from bzrlib.info import show_bzrdir_info
1184
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1185
verbose=noise_level, outfile=self.outf)
1188
class cmd_remove(Command):
1189
"""Remove files or directories.
1191
This makes bzr stop tracking changes to the specified files. bzr will delete
1192
them if they can easily be recovered using revert. If no options or
1193
parameters are given bzr will scan for files that are being tracked by bzr
1194
but missing in your tree and stop tracking them for you.
1196
takes_args = ['file*']
1197
takes_options = ['verbose',
1198
Option('new', help='Only remove files that have never been committed.'),
1199
RegistryOption.from_kwargs('file-deletion-strategy',
1200
'The file deletion mode to be used.',
1201
title='Deletion Strategy', value_switches=True, enum_switch=False,
1202
safe='Only delete files if they can be'
1203
' safely recovered (default).',
1204
keep="Don't delete any files.",
1205
force='Delete all the specified files, even if they can not be '
1206
'recovered and even if they are non-empty directories.')]
1207
aliases = ['rm', 'del']
1208
encoding_type = 'replace'
1210
def run(self, file_list, verbose=False, new=False,
1211
file_deletion_strategy='safe'):
1212
tree, file_list = tree_files(file_list)
1214
if file_list is not None:
1215
file_list = [f for f in file_list]
1219
# Heuristics should probably all move into tree.remove_smart or
1222
added = tree.changes_from(tree.basis_tree(),
1223
specific_files=file_list).added
1224
file_list = sorted([f[0] for f in added], reverse=True)
1225
if len(file_list) == 0:
1226
raise errors.BzrCommandError('No matching files.')
1227
elif file_list is None:
1228
# missing files show up in iter_changes(basis) as
1229
# versioned-with-no-kind.
1231
for change in tree.iter_changes(tree.basis_tree()):
1232
# Find paths in the working tree that have no kind:
1233
if change[1][1] is not None and change[6][1] is None:
1234
missing.append(change[1][1])
1235
file_list = sorted(missing, reverse=True)
1236
file_deletion_strategy = 'keep'
1237
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1238
keep_files=file_deletion_strategy=='keep',
1239
force=file_deletion_strategy=='force')
1244
class cmd_file_id(Command):
1245
"""Print file_id of a particular file or directory.
1247
The file_id is assigned when the file is first added and remains the
1248
same through all revisions where the file exists, even when it is
1253
_see_also = ['inventory', 'ls']
1254
takes_args = ['filename']
1257
def run(self, filename):
1258
tree, relpath = WorkingTree.open_containing(filename)
1259
i = tree.path2id(relpath)
1261
raise errors.NotVersionedError(filename)
1263
self.outf.write(i + '\n')
1266
class cmd_file_path(Command):
1267
"""Print path of file_ids to a file or directory.
1269
This prints one line for each directory down to the target,
1270
starting at the branch root.
1274
takes_args = ['filename']
1277
def run(self, filename):
1278
tree, relpath = WorkingTree.open_containing(filename)
1279
fid = tree.path2id(relpath)
1281
raise errors.NotVersionedError(filename)
1282
segments = osutils.splitpath(relpath)
1283
for pos in range(1, len(segments) + 1):
1284
path = osutils.joinpath(segments[:pos])
1285
self.outf.write("%s\n" % tree.path2id(path))
1288
class cmd_reconcile(Command):
1289
"""Reconcile bzr metadata in a branch.
1291
This can correct data mismatches that may have been caused by
1292
previous ghost operations or bzr upgrades. You should only
1293
need to run this command if 'bzr check' or a bzr developer
1294
advises you to run it.
1296
If a second branch is provided, cross-branch reconciliation is
1297
also attempted, which will check that data like the tree root
1298
id which was not present in very early bzr versions is represented
1299
correctly in both branches.
1301
At the same time it is run it may recompress data resulting in
1302
a potential saving in disk space or performance gain.
1304
The branch *MUST* be on a listable system such as local disk or sftp.
1307
_see_also = ['check']
1308
takes_args = ['branch?']
1310
def run(self, branch="."):
1311
from bzrlib.reconcile import reconcile
1312
dir = bzrdir.BzrDir.open(branch)
1316
class cmd_revision_history(Command):
1317
"""Display the list of revision ids on a branch."""
1320
takes_args = ['location?']
1325
def run(self, location="."):
1326
branch = Branch.open_containing(location)[0]
1327
for revid in branch.revision_history():
1328
self.outf.write(revid)
1329
self.outf.write('\n')
1332
class cmd_ancestry(Command):
1333
"""List all revisions merged into this branch."""
1335
_see_also = ['log', 'revision-history']
1336
takes_args = ['location?']
1341
def run(self, location="."):
1343
wt = WorkingTree.open_containing(location)[0]
1344
except errors.NoWorkingTree:
1345
b = Branch.open(location)
1346
last_revision = b.last_revision()
1349
last_revision = wt.last_revision()
1351
revision_ids = b.repository.get_ancestry(last_revision)
1353
for revision_id in revision_ids:
1354
self.outf.write(revision_id + '\n')
1357
class cmd_init(Command):
1358
"""Make a directory into a versioned branch.
1360
Use this to create an empty branch, or before importing an
1363
If there is a repository in a parent directory of the location, then
1364
the history of the branch will be stored in the repository. Otherwise
1365
init creates a standalone branch which carries its own history
1366
in the .bzr directory.
1368
If there is already a branch at the location but it has no working tree,
1369
the tree can be populated with 'bzr checkout'.
1371
Recipe for importing a tree of files::
1377
bzr commit -m "imported project"
1380
_see_also = ['init-repository', 'branch', 'checkout']
1381
takes_args = ['location?']
1383
Option('create-prefix',
1384
help='Create the path leading up to the branch '
1385
'if it does not already exist.'),
1386
RegistryOption('format',
1387
help='Specify a format for this branch. '
1388
'See "help formats".',
1389
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1390
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1391
value_switches=True,
1392
title="Branch Format",
1394
Option('append-revisions-only',
1395
help='Never change revnos or the existing log.'
1396
' Append revisions to it only.')
1398
def run(self, location=None, format=None, append_revisions_only=False,
1399
create_prefix=False):
1401
format = bzrdir.format_registry.make_bzrdir('default')
1402
if location is None:
1405
to_transport = transport.get_transport(location)
1407
# The path has to exist to initialize a
1408
# branch inside of it.
1409
# Just using os.mkdir, since I don't
1410
# believe that we want to create a bunch of
1411
# locations if the user supplies an extended path
1413
to_transport.ensure_base()
1414
except errors.NoSuchFile:
1415
if not create_prefix:
1416
raise errors.BzrCommandError("Parent directory of %s"
1418
"\nYou may supply --create-prefix to create all"
1419
" leading parent directories."
1421
_create_prefix(to_transport)
1424
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1425
except errors.NotBranchError:
1426
# really a NotBzrDir error...
1427
create_branch = bzrdir.BzrDir.create_branch_convenience
1428
branch = create_branch(to_transport.base, format=format,
1429
possible_transports=[to_transport])
1430
a_bzrdir = branch.bzrdir
1432
from bzrlib.transport.local import LocalTransport
1433
if a_bzrdir.has_branch():
1434
if (isinstance(to_transport, LocalTransport)
1435
and not a_bzrdir.has_workingtree()):
1436
raise errors.BranchExistsWithoutWorkingTree(location)
1437
raise errors.AlreadyBranchError(location)
1438
branch = a_bzrdir.create_branch()
1439
a_bzrdir.create_workingtree()
1440
if append_revisions_only:
1442
branch.set_append_revisions_only(True)
1443
except errors.UpgradeRequired:
1444
raise errors.BzrCommandError('This branch format cannot be set'
1445
' to append-revisions-only. Try --experimental-branch6')
1447
from bzrlib.info import show_bzrdir_info
1448
show_bzrdir_info(a_bzrdir, verbose=0, outfile=self.outf)
1451
class cmd_init_repository(Command):
1452
"""Create a shared repository to hold branches.
1454
New branches created under the repository directory will store their
1455
revisions in the repository, not in the branch directory.
1457
If the --no-trees option is used then the branches in the repository
1458
will not have working trees by default.
1461
Create a shared repositories holding just branches::
1463
bzr init-repo --no-trees repo
1466
Make a lightweight checkout elsewhere::
1468
bzr checkout --lightweight repo/trunk trunk-checkout
1473
_see_also = ['init', 'branch', 'checkout', 'repositories']
1474
takes_args = ["location"]
1475
takes_options = [RegistryOption('format',
1476
help='Specify a format for this repository. See'
1477
' "bzr help formats" for details.',
1478
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1479
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1480
value_switches=True, title='Repository format'),
1482
help='Branches in the repository will default to'
1483
' not having a working tree.'),
1485
aliases = ["init-repo"]
1487
def run(self, location, format=None, no_trees=False):
1489
format = bzrdir.format_registry.make_bzrdir('default')
1491
if location is None:
1494
to_transport = transport.get_transport(location)
1495
to_transport.ensure_base()
1497
newdir = format.initialize_on_transport(to_transport)
1498
repo = newdir.create_repository(shared=True)
1499
repo.set_make_working_trees(not no_trees)
1501
from bzrlib.info import show_bzrdir_info
1502
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1505
class cmd_diff(Command):
1506
"""Show differences in the working tree, between revisions or branches.
1508
If no arguments are given, all changes for the current tree are listed.
1509
If files are given, only the changes in those files are listed.
1510
Remote and multiple branches can be compared by using the --old and
1511
--new options. If not provided, the default for both is derived from
1512
the first argument, if any, or the current tree if no arguments are
1515
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1516
produces patches suitable for "patch -p1".
1520
2 - unrepresentable changes
1525
Shows the difference in the working tree versus the last commit::
1529
Difference between the working tree and revision 1::
1533
Difference between revision 2 and revision 1::
1537
Difference between revision 2 and revision 1 for branch xxx::
1541
Show just the differences for file NEWS::
1545
Show the differences in working tree xxx for file NEWS::
1549
Show the differences from branch xxx to this working tree:
1553
Show the differences between two branches for file NEWS::
1555
bzr diff --old xxx --new yyy NEWS
1557
Same as 'bzr diff' but prefix paths with old/ and new/::
1559
bzr diff --prefix old/:new/
1561
_see_also = ['status']
1562
takes_args = ['file*']
1564
Option('diff-options', type=str,
1565
help='Pass these options to the external diff program.'),
1566
Option('prefix', type=str,
1568
help='Set prefixes added to old and new filenames, as '
1569
'two values separated by a colon. (eg "old/:new/").'),
1571
help='Branch/tree to compare from.',
1575
help='Branch/tree to compare to.',
1581
help='Use this command to compare files.',
1585
aliases = ['di', 'dif']
1586
encoding_type = 'exact'
1589
def run(self, revision=None, file_list=None, diff_options=None,
1590
prefix=None, old=None, new=None, using=None):
1591
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1593
if (prefix is None) or (prefix == '0'):
1601
old_label, new_label = prefix.split(":")
1603
raise errors.BzrCommandError(
1604
'--prefix expects two values separated by a colon'
1605
' (eg "old/:new/")')
1607
if revision and len(revision) > 2:
1608
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1609
' one or two revision specifiers')
1611
old_tree, new_tree, specific_files, extra_trees = \
1612
_get_trees_to_diff(file_list, revision, old, new)
1613
return show_diff_trees(old_tree, new_tree, sys.stdout,
1614
specific_files=specific_files,
1615
external_diff_options=diff_options,
1616
old_label=old_label, new_label=new_label,
1617
extra_trees=extra_trees, using=using)
1620
class cmd_deleted(Command):
1621
"""List files deleted in the working tree.
1623
# TODO: Show files deleted since a previous revision, or
1624
# between two revisions.
1625
# TODO: Much more efficient way to do this: read in new
1626
# directories with readdir, rather than stating each one. Same
1627
# level of effort but possibly much less IO. (Or possibly not,
1628
# if the directories are very large...)
1629
_see_also = ['status', 'ls']
1630
takes_options = ['show-ids']
1633
def run(self, show_ids=False):
1634
tree = WorkingTree.open_containing(u'.')[0]
1637
old = tree.basis_tree()
1640
for path, ie in old.inventory.iter_entries():
1641
if not tree.has_id(ie.file_id):
1642
self.outf.write(path)
1644
self.outf.write(' ')
1645
self.outf.write(ie.file_id)
1646
self.outf.write('\n')
1653
class cmd_modified(Command):
1654
"""List files modified in working tree.
1658
_see_also = ['status', 'ls']
1661
help='Write an ascii NUL (\\0) separator '
1662
'between files rather than a newline.')
1666
def run(self, null=False):
1667
tree = WorkingTree.open_containing(u'.')[0]
1668
td = tree.changes_from(tree.basis_tree())
1669
for path, id, kind, text_modified, meta_modified in td.modified:
1671
self.outf.write(path + '\0')
1673
self.outf.write(osutils.quotefn(path) + '\n')
1676
class cmd_added(Command):
1677
"""List files added in working tree.
1681
_see_also = ['status', 'ls']
1684
help='Write an ascii NUL (\\0) separator '
1685
'between files rather than a newline.')
1689
def run(self, null=False):
1690
wt = WorkingTree.open_containing(u'.')[0]
1693
basis = wt.basis_tree()
1696
basis_inv = basis.inventory
1699
if file_id in basis_inv:
1701
if inv.is_root(file_id) and len(basis_inv) == 0:
1703
path = inv.id2path(file_id)
1704
if not os.access(osutils.abspath(path), os.F_OK):
1707
self.outf.write(path + '\0')
1709
self.outf.write(osutils.quotefn(path) + '\n')
1716
class cmd_root(Command):
1717
"""Show the tree root directory.
1719
The root is the nearest enclosing directory with a .bzr control
1722
takes_args = ['filename?']
1724
def run(self, filename=None):
1725
"""Print the branch root."""
1726
tree = WorkingTree.open_containing(filename)[0]
1727
self.outf.write(tree.basedir + '\n')
1730
def _parse_limit(limitstring):
1732
return int(limitstring)
1734
msg = "The limit argument must be an integer."
1735
raise errors.BzrCommandError(msg)
1738
class cmd_log(Command):
1739
"""Show log of a branch, file, or directory.
1741
By default show the log of the branch containing the working directory.
1743
To request a range of logs, you can use the command -r begin..end
1744
-r revision requests a specific revision, -r ..end or -r begin.. are
1748
Log the current branch::
1756
Log the last 10 revisions of a branch::
1758
bzr log -r -10.. http://server/branch
1761
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1763
takes_args = ['location?']
1766
help='Show from oldest to newest.'),
1768
custom_help('verbose',
1769
help='Show files changed in each revision.'),
1773
type=bzrlib.option._parse_revision_str,
1775
help='Show just the specified revision.'
1776
' See also "help revisionspec".'),
1780
help='Show revisions whose message matches this '
1781
'regular expression.',
1785
help='Limit the output to the first N revisions.',
1789
encoding_type = 'replace'
1792
def run(self, location=None, timezone='original',
1801
from bzrlib.log import show_log
1802
direction = (forward and 'forward') or 'reverse'
1804
if change is not None:
1806
raise errors.RangeInChangeOption()
1807
if revision is not None:
1808
raise errors.BzrCommandError(
1809
'--revision and --change are mutually exclusive')
1816
# find the file id to log:
1818
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1822
tree = b.basis_tree()
1823
file_id = tree.path2id(fp)
1825
raise errors.BzrCommandError(
1826
"Path does not have any revision history: %s" %
1830
# FIXME ? log the current subdir only RBC 20060203
1831
if revision is not None \
1832
and len(revision) > 0 and revision[0].get_branch():
1833
location = revision[0].get_branch()
1836
dir, relpath = bzrdir.BzrDir.open_containing(location)
1837
b = dir.open_branch()
1841
if revision is None:
1844
elif len(revision) == 1:
1845
rev1 = rev2 = revision[0].in_history(b)
1846
elif len(revision) == 2:
1847
if revision[1].get_branch() != revision[0].get_branch():
1848
# b is taken from revision[0].get_branch(), and
1849
# show_log will use its revision_history. Having
1850
# different branches will lead to weird behaviors.
1851
raise errors.BzrCommandError(
1852
"Log doesn't accept two revisions in different"
1854
rev1 = revision[0].in_history(b)
1855
rev2 = revision[1].in_history(b)
1857
raise errors.BzrCommandError(
1858
'bzr log --revision takes one or two values.')
1860
if log_format is None:
1861
log_format = log.log_formatter_registry.get_default(b)
1863
lf = log_format(show_ids=show_ids, to_file=self.outf,
1864
show_timezone=timezone,
1865
delta_format=get_verbosity_level())
1871
direction=direction,
1872
start_revision=rev1,
1880
def get_log_format(long=False, short=False, line=False, default='long'):
1881
log_format = default
1885
log_format = 'short'
1891
class cmd_touching_revisions(Command):
1892
"""Return revision-ids which affected a particular file.
1894
A more user-friendly interface is "bzr log FILE".
1898
takes_args = ["filename"]
1901
def run(self, filename):
1902
tree, relpath = WorkingTree.open_containing(filename)
1904
file_id = tree.path2id(relpath)
1905
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1906
self.outf.write("%6d %s\n" % (revno, what))
1909
class cmd_ls(Command):
1910
"""List files in a tree.
1913
_see_also = ['status', 'cat']
1914
takes_args = ['path?']
1915
# TODO: Take a revision or remote path and list that tree instead.
1919
Option('non-recursive',
1920
help='Don\'t recurse into subdirectories.'),
1922
help='Print paths relative to the root of the branch.'),
1923
Option('unknown', help='Print unknown files.'),
1924
Option('versioned', help='Print versioned files.',
1926
Option('ignored', help='Print ignored files.'),
1928
help='Write an ascii NUL (\\0) separator '
1929
'between files rather than a newline.'),
1931
help='List entries of a particular kind: file, directory, symlink.',
1936
def run(self, revision=None, verbose=False,
1937
non_recursive=False, from_root=False,
1938
unknown=False, versioned=False, ignored=False,
1939
null=False, kind=None, show_ids=False, path=None):
1941
if kind and kind not in ('file', 'directory', 'symlink'):
1942
raise errors.BzrCommandError('invalid kind specified')
1944
if verbose and null:
1945
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1946
all = not (unknown or versioned or ignored)
1948
selection = {'I':ignored, '?':unknown, 'V':versioned}
1955
raise errors.BzrCommandError('cannot specify both --from-root'
1959
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1965
if revision is not None or tree is None:
1966
tree = _get_one_revision_tree('ls', revision, branch=branch)
1970
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1971
if fp.startswith(relpath):
1972
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1973
if non_recursive and '/' in fp:
1975
if not all and not selection[fc]:
1977
if kind is not None and fkind != kind:
1980
kindch = entry.kind_character()
1981
outstring = '%-8s %s%s' % (fc, fp, kindch)
1982
if show_ids and fid is not None:
1983
outstring = "%-50s %s" % (outstring, fid)
1984
self.outf.write(outstring + '\n')
1986
self.outf.write(fp + '\0')
1989
self.outf.write(fid)
1990
self.outf.write('\0')
1998
self.outf.write('%-50s %s\n' % (fp, my_id))
2000
self.outf.write(fp + '\n')
2005
class cmd_unknowns(Command):
2006
"""List unknown files.
2014
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2015
self.outf.write(osutils.quotefn(f) + '\n')
2018
class cmd_ignore(Command):
2019
"""Ignore specified files or patterns.
2021
See ``bzr help patterns`` for details on the syntax of patterns.
2023
To remove patterns from the ignore list, edit the .bzrignore file.
2024
After adding, editing or deleting that file either indirectly by
2025
using this command or directly by using an editor, be sure to commit
2028
Note: ignore patterns containing shell wildcards must be quoted from
2032
Ignore the top level Makefile::
2034
bzr ignore ./Makefile
2036
Ignore class files in all directories::
2038
bzr ignore "*.class"
2040
Ignore .o files under the lib directory::
2042
bzr ignore "lib/**/*.o"
2044
Ignore .o files under the lib directory::
2046
bzr ignore "RE:lib/.*\.o"
2048
Ignore everything but the "debian" toplevel directory::
2050
bzr ignore "RE:(?!debian/).*"
2053
_see_also = ['status', 'ignored', 'patterns']
2054
takes_args = ['name_pattern*']
2056
Option('old-default-rules',
2057
help='Write out the ignore rules bzr < 0.9 always used.')
2060
def run(self, name_pattern_list=None, old_default_rules=None):
2061
from bzrlib import ignores
2062
if old_default_rules is not None:
2063
# dump the rules and exit
2064
for pattern in ignores.OLD_DEFAULTS:
2067
if not name_pattern_list:
2068
raise errors.BzrCommandError("ignore requires at least one "
2069
"NAME_PATTERN or --old-default-rules")
2070
name_pattern_list = [globbing.normalize_pattern(p)
2071
for p in name_pattern_list]
2072
for name_pattern in name_pattern_list:
2073
if (name_pattern[0] == '/' or
2074
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2075
raise errors.BzrCommandError(
2076
"NAME_PATTERN should not be an absolute path")
2077
tree, relpath = WorkingTree.open_containing(u'.')
2078
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2079
ignored = globbing.Globster(name_pattern_list)
2082
for entry in tree.list_files():
2086
if ignored.match(filename):
2087
matches.append(filename.encode('utf-8'))
2089
if len(matches) > 0:
2090
print "Warning: the following files are version controlled and" \
2091
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2094
class cmd_ignored(Command):
2095
"""List ignored files and the patterns that matched them.
2097
List all the ignored files and the ignore pattern that caused the file to
2100
Alternatively, to list just the files::
2105
encoding_type = 'replace'
2106
_see_also = ['ignore', 'ls']
2110
tree = WorkingTree.open_containing(u'.')[0]
2113
for path, file_class, kind, file_id, entry in tree.list_files():
2114
if file_class != 'I':
2116
## XXX: Slightly inefficient since this was already calculated
2117
pat = tree.is_ignored(path)
2118
self.outf.write('%-50s %s\n' % (path, pat))
2123
class cmd_lookup_revision(Command):
2124
"""Lookup the revision-id from a revision-number
2127
bzr lookup-revision 33
2130
takes_args = ['revno']
2133
def run(self, revno):
2137
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2139
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2142
class cmd_export(Command):
2143
"""Export current or past revision to a destination directory or archive.
2145
If no revision is specified this exports the last committed revision.
2147
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2148
given, try to find the format with the extension. If no extension
2149
is found exports to a directory (equivalent to --format=dir).
2151
If root is supplied, it will be used as the root directory inside
2152
container formats (tar, zip, etc). If it is not supplied it will default
2153
to the exported filename. The root option has no effect for 'dir' format.
2155
If branch is omitted then the branch containing the current working
2156
directory will be used.
2158
Note: Export of tree with non-ASCII filenames to zip is not supported.
2160
================= =========================
2161
Supported formats Autodetected by extension
2162
================= =========================
2165
tbz2 .tar.bz2, .tbz2
2168
================= =========================
2170
takes_args = ['dest', 'branch_or_subdir?']
2173
help="Type of file to export to.",
2178
help="Name of the root directory inside the exported file."),
2180
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2182
from bzrlib.export import export
2184
if branch_or_subdir is None:
2185
tree = WorkingTree.open_containing(u'.')[0]
2189
b, subdir = Branch.open_containing(branch_or_subdir)
2192
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2194
export(rev_tree, dest, format, root, subdir)
2195
except errors.NoSuchExportFormat, e:
2196
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2199
class cmd_cat(Command):
2200
"""Write the contents of a file as of a given revision to standard output.
2202
If no revision is nominated, the last revision is used.
2204
Note: Take care to redirect standard output when using this command on a
2210
Option('name-from-revision', help='The path name in the old tree.'),
2213
takes_args = ['filename']
2214
encoding_type = 'exact'
2217
def run(self, filename, revision=None, name_from_revision=False):
2218
if revision is not None and len(revision) != 1:
2219
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2220
" one revision specifier")
2221
tree, branch, relpath = \
2222
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2225
return self._run(tree, branch, relpath, filename, revision,
2230
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2232
tree = b.basis_tree()
2233
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2235
cur_file_id = tree.path2id(relpath)
2236
old_file_id = rev_tree.path2id(relpath)
2238
if name_from_revision:
2239
if old_file_id is None:
2240
raise errors.BzrCommandError(
2241
"%r is not present in revision %s" % (
2242
filename, rev_tree.get_revision_id()))
2244
content = rev_tree.get_file_text(old_file_id)
2245
elif cur_file_id is not None:
2246
content = rev_tree.get_file_text(cur_file_id)
2247
elif old_file_id is not None:
2248
content = rev_tree.get_file_text(old_file_id)
2250
raise errors.BzrCommandError(
2251
"%r is not present in revision %s" % (
2252
filename, rev_tree.get_revision_id()))
2253
self.outf.write(content)
2256
class cmd_local_time_offset(Command):
2257
"""Show the offset in seconds from GMT to local time."""
2261
print osutils.local_time_offset()
2265
class cmd_commit(Command):
2266
"""Commit changes into a new revision.
2268
If no arguments are given, the entire tree is committed.
2270
If selected files are specified, only changes to those files are
2271
committed. If a directory is specified then the directory and everything
2272
within it is committed.
2274
When excludes are given, they take precedence over selected files.
2275
For example, too commit only changes within foo, but not changes within
2278
bzr commit foo -x foo/bar
2280
If author of the change is not the same person as the committer, you can
2281
specify the author's name using the --author option. The name should be
2282
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2284
A selected-file commit may fail in some cases where the committed
2285
tree would be invalid. Consider::
2290
bzr commit foo -m "committing foo"
2291
bzr mv foo/bar foo/baz
2294
bzr commit foo/bar -m "committing bar but not baz"
2296
In the example above, the last commit will fail by design. This gives
2297
the user the opportunity to decide whether they want to commit the
2298
rename at the same time, separately first, or not at all. (As a general
2299
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2301
Note: A selected-file commit after a merge is not yet supported.
2303
# TODO: Run hooks on tree to-be-committed, and after commit.
2305
# TODO: Strict commit that fails if there are deleted files.
2306
# (what does "deleted files" mean ??)
2308
# TODO: Give better message for -s, --summary, used by tla people
2310
# XXX: verbose currently does nothing
2312
_see_also = ['bugs', 'uncommit']
2313
takes_args = ['selected*']
2315
ListOption('exclude', type=str, short_name='x',
2316
help="Do not consider changes made to a given path."),
2317
Option('message', type=unicode,
2319
help="Description of the new revision."),
2322
help='Commit even if nothing has changed.'),
2323
Option('file', type=str,
2326
help='Take commit message from this file.'),
2328
help="Refuse to commit if there are unknown "
2329
"files in the working tree."),
2330
ListOption('fixes', type=str,
2331
help="Mark a bug as being fixed by this revision."),
2332
Option('author', type=unicode,
2333
help="Set the author's name, if it's different "
2334
"from the committer."),
2336
help="Perform a local commit in a bound "
2337
"branch. Local commits are not pushed to "
2338
"the master branch until a normal commit "
2342
help='When no message is supplied, show the diff along'
2343
' with the status summary in the message editor.'),
2345
aliases = ['ci', 'checkin']
2347
def _get_bug_fix_properties(self, fixes, branch):
2349
# Configure the properties for bug fixing attributes.
2350
for fixed_bug in fixes:
2351
tokens = fixed_bug.split(':')
2352
if len(tokens) != 2:
2353
raise errors.BzrCommandError(
2354
"Invalid bug %s. Must be in the form of 'tag:id'. "
2355
"Commit refused." % fixed_bug)
2356
tag, bug_id = tokens
2358
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2359
except errors.UnknownBugTrackerAbbreviation:
2360
raise errors.BzrCommandError(
2361
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2362
except errors.MalformedBugIdentifier:
2363
raise errors.BzrCommandError(
2364
"Invalid bug identifier for %s. Commit refused."
2366
properties.append('%s fixed' % bug_url)
2367
return '\n'.join(properties)
2369
def run(self, message=None, file=None, verbose=False, selected_list=None,
2370
unchanged=False, strict=False, local=False, fixes=None,
2371
author=None, show_diff=False, exclude=None):
2372
from bzrlib.errors import (
2377
from bzrlib.msgeditor import (
2378
edit_commit_message_encoded,
2379
generate_commit_message_template,
2380
make_commit_message_template_encoded
2383
# TODO: Need a blackbox test for invoking the external editor; may be
2384
# slightly problematic to run this cross-platform.
2386
# TODO: do more checks that the commit will succeed before
2387
# spending the user's valuable time typing a commit message.
2391
tree, selected_list = tree_files(selected_list)
2392
if selected_list == ['']:
2393
# workaround - commit of root of tree should be exactly the same
2394
# as just default commit in that tree, and succeed even though
2395
# selected-file merge commit is not done yet
2400
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2402
properties['bugs'] = bug_property
2404
if local and not tree.branch.get_bound_location():
2405
raise errors.LocalRequiresBoundBranch()
2407
def get_message(commit_obj):
2408
"""Callback to get commit message"""
2409
my_message = message
2410
if my_message is None and not file:
2411
t = make_commit_message_template_encoded(tree,
2412
selected_list, diff=show_diff,
2413
output_encoding=osutils.get_user_encoding())
2414
start_message = generate_commit_message_template(commit_obj)
2415
my_message = edit_commit_message_encoded(t,
2416
start_message=start_message)
2417
if my_message is None:
2418
raise errors.BzrCommandError("please specify a commit"
2419
" message with either --message or --file")
2420
elif my_message and file:
2421
raise errors.BzrCommandError(
2422
"please specify either --message or --file")
2424
my_message = codecs.open(file, 'rt',
2425
osutils.get_user_encoding()).read()
2426
if my_message == "":
2427
raise errors.BzrCommandError("empty commit message specified")
2431
tree.commit(message_callback=get_message,
2432
specific_files=selected_list,
2433
allow_pointless=unchanged, strict=strict, local=local,
2434
reporter=None, verbose=verbose, revprops=properties,
2436
exclude=safe_relpath_files(tree, exclude))
2437
except PointlessCommit:
2438
# FIXME: This should really happen before the file is read in;
2439
# perhaps prepare the commit; get the message; then actually commit
2440
raise errors.BzrCommandError("no changes to commit."
2441
" use --unchanged to commit anyhow")
2442
except ConflictsInTree:
2443
raise errors.BzrCommandError('Conflicts detected in working '
2444
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2446
except StrictCommitFailed:
2447
raise errors.BzrCommandError("Commit refused because there are"
2448
" unknown files in the working tree.")
2449
except errors.BoundBranchOutOfDate, e:
2450
raise errors.BzrCommandError(str(e) + "\n"
2451
'To commit to master branch, run update and then commit.\n'
2452
'You can also pass --local to commit to continue working '
2456
class cmd_check(Command):
2457
"""Validate working tree structure, branch consistency and repository history.
2459
This command checks various invariants about branch and repository storage
2460
to detect data corruption or bzr bugs.
2462
The working tree and branch checks will only give output if a problem is
2463
detected. The output fields of the repository check are:
2465
revisions: This is just the number of revisions checked. It doesn't
2467
versionedfiles: This is just the number of versionedfiles checked. It
2468
doesn't indicate a problem.
2469
unreferenced ancestors: Texts that are ancestors of other texts, but
2470
are not properly referenced by the revision ancestry. This is a
2471
subtle problem that Bazaar can work around.
2472
unique file texts: This is the total number of unique file contents
2473
seen in the checked revisions. It does not indicate a problem.
2474
repeated file texts: This is the total number of repeated texts seen
2475
in the checked revisions. Texts can be repeated when their file
2476
entries are modified, but the file contents are not. It does not
2479
If no restrictions are specified, all Bazaar data that is found at the given
2480
location will be checked.
2484
Check the tree and branch at 'foo'::
2486
bzr check --tree --branch foo
2488
Check only the repository at 'bar'::
2490
bzr check --repo bar
2492
Check everything at 'baz'::
2497
_see_also = ['reconcile']
2498
takes_args = ['path?']
2499
takes_options = ['verbose',
2500
Option('branch', help="Check the branch related to the"
2501
" current directory."),
2502
Option('repo', help="Check the repository related to the"
2503
" current directory."),
2504
Option('tree', help="Check the working tree related to"
2505
" the current directory.")]
2507
def run(self, path=None, verbose=False, branch=False, repo=False,
2509
from bzrlib.check import check_dwim
2512
if not branch and not repo and not tree:
2513
branch = repo = tree = True
2514
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2517
class cmd_upgrade(Command):
2518
"""Upgrade branch storage to current format.
2520
The check command or bzr developers may sometimes advise you to run
2521
this command. When the default format has changed you may also be warned
2522
during other operations to upgrade.
2525
_see_also = ['check']
2526
takes_args = ['url?']
2528
RegistryOption('format',
2529
help='Upgrade to a specific format. See "bzr help'
2530
' formats" for details.',
2531
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2532
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2533
value_switches=True, title='Branch format'),
2536
def run(self, url='.', format=None):
2537
from bzrlib.upgrade import upgrade
2539
format = bzrdir.format_registry.make_bzrdir('default')
2540
upgrade(url, format)
2543
class cmd_whoami(Command):
2544
"""Show or set bzr user id.
2547
Show the email of the current user::
2551
Set the current user::
2553
bzr whoami "Frank Chu <fchu@example.com>"
2555
takes_options = [ Option('email',
2556
help='Display email address only.'),
2558
help='Set identity for the current branch instead of '
2561
takes_args = ['name?']
2562
encoding_type = 'replace'
2565
def run(self, email=False, branch=False, name=None):
2567
# use branch if we're inside one; otherwise global config
2569
c = Branch.open_containing('.')[0].get_config()
2570
except errors.NotBranchError:
2571
c = config.GlobalConfig()
2573
self.outf.write(c.user_email() + '\n')
2575
self.outf.write(c.username() + '\n')
2578
# display a warning if an email address isn't included in the given name.
2580
config.extract_email_address(name)
2581
except errors.NoEmailInUsername, e:
2582
warning('"%s" does not seem to contain an email address. '
2583
'This is allowed, but not recommended.', name)
2585
# use global config unless --branch given
2587
c = Branch.open_containing('.')[0].get_config()
2589
c = config.GlobalConfig()
2590
c.set_user_option('email', name)
2593
class cmd_nick(Command):
2594
"""Print or set the branch nickname.
2596
If unset, the tree root directory name is used as the nickname.
2597
To print the current nickname, execute with no argument.
2599
Bound branches use the nickname of its master branch unless it is set
2603
_see_also = ['info']
2604
takes_args = ['nickname?']
2605
def run(self, nickname=None):
2606
branch = Branch.open_containing(u'.')[0]
2607
if nickname is None:
2608
self.printme(branch)
2610
branch.nick = nickname
2613
def printme(self, branch):
2617
class cmd_alias(Command):
2618
"""Set/unset and display aliases.
2621
Show the current aliases::
2625
Show the alias specified for 'll'::
2629
Set an alias for 'll'::
2631
bzr alias ll="log --line -r-10..-1"
2633
To remove an alias for 'll'::
2635
bzr alias --remove ll
2638
takes_args = ['name?']
2640
Option('remove', help='Remove the alias.'),
2643
def run(self, name=None, remove=False):
2645
self.remove_alias(name)
2647
self.print_aliases()
2649
equal_pos = name.find('=')
2651
self.print_alias(name)
2653
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2655
def remove_alias(self, alias_name):
2656
if alias_name is None:
2657
raise errors.BzrCommandError(
2658
'bzr alias --remove expects an alias to remove.')
2659
# If alias is not found, print something like:
2660
# unalias: foo: not found
2661
c = config.GlobalConfig()
2662
c.unset_alias(alias_name)
2665
def print_aliases(self):
2666
"""Print out the defined aliases in a similar format to bash."""
2667
aliases = config.GlobalConfig().get_aliases()
2668
for key, value in sorted(aliases.iteritems()):
2669
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2672
def print_alias(self, alias_name):
2673
from bzrlib.commands import get_alias
2674
alias = get_alias(alias_name)
2676
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2679
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2681
def set_alias(self, alias_name, alias_command):
2682
"""Save the alias in the global config."""
2683
c = config.GlobalConfig()
2684
c.set_alias(alias_name, alias_command)
2687
class cmd_selftest(Command):
2688
"""Run internal test suite.
2690
If arguments are given, they are regular expressions that say which tests
2691
should run. Tests matching any expression are run, and other tests are
2694
Alternatively if --first is given, matching tests are run first and then
2695
all other tests are run. This is useful if you have been working in a
2696
particular area, but want to make sure nothing else was broken.
2698
If --exclude is given, tests that match that regular expression are
2699
excluded, regardless of whether they match --first or not.
2701
To help catch accidential dependencies between tests, the --randomize
2702
option is useful. In most cases, the argument used is the word 'now'.
2703
Note that the seed used for the random number generator is displayed
2704
when this option is used. The seed can be explicitly passed as the
2705
argument to this option if required. This enables reproduction of the
2706
actual ordering used if and when an order sensitive problem is encountered.
2708
If --list-only is given, the tests that would be run are listed. This is
2709
useful when combined with --first, --exclude and/or --randomize to
2710
understand their impact. The test harness reports "Listed nn tests in ..."
2711
instead of "Ran nn tests in ..." when list mode is enabled.
2713
If the global option '--no-plugins' is given, plugins are not loaded
2714
before running the selftests. This has two effects: features provided or
2715
modified by plugins will not be tested, and tests provided by plugins will
2718
Tests that need working space on disk use a common temporary directory,
2719
typically inside $TMPDIR or /tmp.
2722
Run only tests relating to 'ignore'::
2726
Disable plugins and list tests as they're run::
2728
bzr --no-plugins selftest -v
2730
# NB: this is used from the class without creating an instance, which is
2731
# why it does not have a self parameter.
2732
def get_transport_type(typestring):
2733
"""Parse and return a transport specifier."""
2734
if typestring == "sftp":
2735
from bzrlib.transport.sftp import SFTPAbsoluteServer
2736
return SFTPAbsoluteServer
2737
if typestring == "memory":
2738
from bzrlib.transport.memory import MemoryServer
2740
if typestring == "fakenfs":
2741
from bzrlib.transport.fakenfs import FakeNFSServer
2742
return FakeNFSServer
2743
msg = "No known transport type %s. Supported types are: sftp\n" %\
2745
raise errors.BzrCommandError(msg)
2748
takes_args = ['testspecs*']
2749
takes_options = ['verbose',
2751
help='Stop when one test fails.',
2755
help='Use a different transport by default '
2756
'throughout the test suite.',
2757
type=get_transport_type),
2759
help='Run the benchmarks rather than selftests.'),
2760
Option('lsprof-timed',
2761
help='Generate lsprof output for benchmarked'
2762
' sections of code.'),
2763
Option('cache-dir', type=str,
2764
help='Cache intermediate benchmark output in this '
2767
help='Run all tests, but run specified tests first.',
2771
help='List the tests instead of running them.'),
2772
Option('randomize', type=str, argname="SEED",
2773
help='Randomize the order of tests using the given'
2774
' seed or "now" for the current time.'),
2775
Option('exclude', type=str, argname="PATTERN",
2777
help='Exclude tests that match this regular'
2779
Option('strict', help='Fail on missing dependencies or '
2781
Option('load-list', type=str, argname='TESTLISTFILE',
2782
help='Load a test id list from a text file.'),
2783
ListOption('debugflag', type=str, short_name='E',
2784
help='Turn on a selftest debug flag.'),
2785
ListOption('starting-with', type=str, argname='TESTID',
2786
param_name='starting_with', short_name='s',
2788
'Load only the tests starting with TESTID.'),
2790
encoding_type = 'replace'
2792
def run(self, testspecs_list=None, verbose=False, one=False,
2793
transport=None, benchmark=None,
2794
lsprof_timed=None, cache_dir=None,
2795
first=False, list_only=False,
2796
randomize=None, exclude=None, strict=False,
2797
load_list=None, debugflag=None, starting_with=None):
2798
from bzrlib.tests import selftest
2799
import bzrlib.benchmarks as benchmarks
2800
from bzrlib.benchmarks import tree_creator
2802
# Make deprecation warnings visible, unless -Werror is set
2803
symbol_versioning.activate_deprecation_warnings(override=False)
2805
if cache_dir is not None:
2806
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2808
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2809
print ' %s (%s python%s)' % (
2811
bzrlib.version_string,
2812
bzrlib._format_version_tuple(sys.version_info),
2815
if testspecs_list is not None:
2816
pattern = '|'.join(testspecs_list)
2820
test_suite_factory = benchmarks.test_suite
2821
# Unless user explicitly asks for quiet, be verbose in benchmarks
2822
verbose = not is_quiet()
2823
# TODO: should possibly lock the history file...
2824
benchfile = open(".perf_history", "at", buffering=1)
2826
test_suite_factory = None
2829
result = selftest(verbose=verbose,
2831
stop_on_failure=one,
2832
transport=transport,
2833
test_suite_factory=test_suite_factory,
2834
lsprof_timed=lsprof_timed,
2835
bench_history=benchfile,
2836
matching_tests_first=first,
2837
list_only=list_only,
2838
random_seed=randomize,
2839
exclude_pattern=exclude,
2841
load_list=load_list,
2842
debug_flags=debugflag,
2843
starting_with=starting_with,
2846
if benchfile is not None:
2849
note('tests passed')
2851
note('tests failed')
2852
return int(not result)
2855
class cmd_version(Command):
2856
"""Show version of bzr."""
2858
encoding_type = 'replace'
2860
Option("short", help="Print just the version number."),
2864
def run(self, short=False):
2865
from bzrlib.version import show_version
2867
self.outf.write(bzrlib.version_string + '\n')
2869
show_version(to_file=self.outf)
2872
class cmd_rocks(Command):
2873
"""Statement of optimism."""
2879
print "It sure does!"
2882
class cmd_find_merge_base(Command):
2883
"""Find and print a base revision for merging two branches."""
2884
# TODO: Options to specify revisions on either side, as if
2885
# merging only part of the history.
2886
takes_args = ['branch', 'other']
2890
def run(self, branch, other):
2891
from bzrlib.revision import ensure_null
2893
branch1 = Branch.open_containing(branch)[0]
2894
branch2 = Branch.open_containing(other)[0]
2899
last1 = ensure_null(branch1.last_revision())
2900
last2 = ensure_null(branch2.last_revision())
2902
graph = branch1.repository.get_graph(branch2.repository)
2903
base_rev_id = graph.find_unique_lca(last1, last2)
2905
print 'merge base is revision %s' % base_rev_id
2912
class cmd_merge(Command):
2913
"""Perform a three-way merge.
2915
The source of the merge can be specified either in the form of a branch,
2916
or in the form of a path to a file containing a merge directive generated
2917
with bzr send. If neither is specified, the default is the upstream branch
2918
or the branch most recently merged using --remember.
2920
When merging a branch, by default the tip will be merged. To pick a different
2921
revision, pass --revision. If you specify two values, the first will be used as
2922
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2923
available revisions, like this is commonly referred to as "cherrypicking".
2925
Revision numbers are always relative to the branch being merged.
2927
By default, bzr will try to merge in all new work from the other
2928
branch, automatically determining an appropriate base. If this
2929
fails, you may need to give an explicit base.
2931
Merge will do its best to combine the changes in two branches, but there
2932
are some kinds of problems only a human can fix. When it encounters those,
2933
it will mark a conflict. A conflict means that you need to fix something,
2934
before you should commit.
2936
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2938
If there is no default branch set, the first merge will set it. After
2939
that, you can omit the branch to use the default. To change the
2940
default, use --remember. The value will only be saved if the remote
2941
location can be accessed.
2943
The results of the merge are placed into the destination working
2944
directory, where they can be reviewed (with bzr diff), tested, and then
2945
committed to record the result of the merge.
2947
merge refuses to run if there are any uncommitted changes, unless
2951
To merge the latest revision from bzr.dev::
2953
bzr merge ../bzr.dev
2955
To merge changes up to and including revision 82 from bzr.dev::
2957
bzr merge -r 82 ../bzr.dev
2959
To merge the changes introduced by 82, without previous changes::
2961
bzr merge -r 81..82 ../bzr.dev
2963
To apply a merge directive contained in in /tmp/merge:
2965
bzr merge /tmp/merge
2968
encoding_type = 'exact'
2969
_see_also = ['update', 'remerge', 'status-flags']
2970
takes_args = ['location?']
2975
help='Merge even if the destination tree has uncommitted changes.'),
2979
Option('show-base', help="Show base revision text in "
2981
Option('uncommitted', help='Apply uncommitted changes'
2982
' from a working copy, instead of branch changes.'),
2983
Option('pull', help='If the destination is already'
2984
' completely merged into the source, pull from the'
2985
' source rather than merging. When this happens,'
2986
' you do not need to commit the result.'),
2988
help='Branch to merge into, '
2989
'rather than the one containing the working directory.',
2993
Option('preview', help='Instead of merging, show a diff of the merge.')
2996
def run(self, location=None, revision=None, force=False,
2997
merge_type=None, show_base=False, reprocess=None, remember=False,
2998
uncommitted=False, pull=False,
3002
if merge_type is None:
3003
merge_type = _mod_merge.Merge3Merger
3005
if directory is None: directory = u'.'
3006
possible_transports = []
3008
allow_pending = True
3009
verified = 'inapplicable'
3010
tree = WorkingTree.open_containing(directory)[0]
3011
change_reporter = delta._ChangeReporter(
3012
unversioned_filter=tree.is_ignored)
3015
pb = ui.ui_factory.nested_progress_bar()
3016
cleanups.append(pb.finished)
3018
cleanups.append(tree.unlock)
3019
if location is not None:
3021
mergeable = bundle.read_mergeable_from_url(location,
3022
possible_transports=possible_transports)
3023
except errors.NotABundle:
3027
raise errors.BzrCommandError('Cannot use --uncommitted'
3028
' with bundles or merge directives.')
3030
if revision is not None:
3031
raise errors.BzrCommandError(
3032
'Cannot use -r with merge directives or bundles')
3033
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3036
if merger is None and uncommitted:
3037
if revision is not None and len(revision) > 0:
3038
raise errors.BzrCommandError('Cannot use --uncommitted and'
3039
' --revision at the same time.')
3040
location = self._select_branch_location(tree, location)[0]
3041
other_tree, other_path = WorkingTree.open_containing(location)
3042
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3044
allow_pending = False
3045
if other_path != '':
3046
merger.interesting_files = [other_path]
3049
merger, allow_pending = self._get_merger_from_branch(tree,
3050
location, revision, remember, possible_transports, pb)
3052
merger.merge_type = merge_type
3053
merger.reprocess = reprocess
3054
merger.show_base = show_base
3055
self.sanity_check_merger(merger)
3056
if (merger.base_rev_id == merger.other_rev_id and
3057
merger.other_rev_id is not None):
3058
note('Nothing to do.')
3061
if merger.interesting_files is not None:
3062
raise errors.BzrCommandError('Cannot pull individual files')
3063
if (merger.base_rev_id == tree.last_revision()):
3064
result = tree.pull(merger.other_branch, False,
3065
merger.other_rev_id)
3066
result.report(self.outf)
3068
merger.check_basis(not force)
3070
return self._do_preview(merger)
3072
return self._do_merge(merger, change_reporter, allow_pending,
3075
for cleanup in reversed(cleanups):
3078
def _do_preview(self, merger):
3079
from bzrlib.diff import show_diff_trees
3080
tree_merger = merger.make_merger()
3081
tt = tree_merger.make_preview_transform()
3083
result_tree = tt.get_preview_tree()
3084
show_diff_trees(merger.this_tree, result_tree, self.outf,
3085
old_label='', new_label='')
3089
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3090
merger.change_reporter = change_reporter
3091
conflict_count = merger.do_merge()
3093
merger.set_pending()
3094
if verified == 'failed':
3095
warning('Preview patch does not match changes')
3096
if conflict_count != 0:
3101
def sanity_check_merger(self, merger):
3102
if (merger.show_base and
3103
not merger.merge_type is _mod_merge.Merge3Merger):
3104
raise errors.BzrCommandError("Show-base is not supported for this"
3105
" merge type. %s" % merger.merge_type)
3106
if merger.reprocess is None:
3107
if merger.show_base:
3108
merger.reprocess = False
3110
# Use reprocess if the merger supports it
3111
merger.reprocess = merger.merge_type.supports_reprocess
3112
if merger.reprocess and not merger.merge_type.supports_reprocess:
3113
raise errors.BzrCommandError("Conflict reduction is not supported"
3114
" for merge type %s." %
3116
if merger.reprocess and merger.show_base:
3117
raise errors.BzrCommandError("Cannot do conflict reduction and"
3120
def _get_merger_from_branch(self, tree, location, revision, remember,
3121
possible_transports, pb):
3122
"""Produce a merger from a location, assuming it refers to a branch."""
3123
from bzrlib.tag import _merge_tags_if_possible
3124
# find the branch locations
3125
other_loc, user_location = self._select_branch_location(tree, location,
3127
if revision is not None and len(revision) == 2:
3128
base_loc, _unused = self._select_branch_location(tree,
3129
location, revision, 0)
3131
base_loc = other_loc
3133
other_branch, other_path = Branch.open_containing(other_loc,
3134
possible_transports)
3135
if base_loc == other_loc:
3136
base_branch = other_branch
3138
base_branch, base_path = Branch.open_containing(base_loc,
3139
possible_transports)
3140
# Find the revision ids
3141
if revision is None or len(revision) < 1 or revision[-1] is None:
3142
other_revision_id = _mod_revision.ensure_null(
3143
other_branch.last_revision())
3145
other_revision_id = revision[-1].as_revision_id(other_branch)
3146
if (revision is not None and len(revision) == 2
3147
and revision[0] is not None):
3148
base_revision_id = revision[0].as_revision_id(base_branch)
3150
base_revision_id = None
3151
# Remember where we merge from
3152
if ((remember or tree.branch.get_submit_branch() is None) and
3153
user_location is not None):
3154
tree.branch.set_submit_branch(other_branch.base)
3155
_merge_tags_if_possible(other_branch, tree.branch)
3156
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3157
other_revision_id, base_revision_id, other_branch, base_branch)
3158
if other_path != '':
3159
allow_pending = False
3160
merger.interesting_files = [other_path]
3162
allow_pending = True
3163
return merger, allow_pending
3165
def _select_branch_location(self, tree, user_location, revision=None,
3167
"""Select a branch location, according to possible inputs.
3169
If provided, branches from ``revision`` are preferred. (Both
3170
``revision`` and ``index`` must be supplied.)
3172
Otherwise, the ``location`` parameter is used. If it is None, then the
3173
``submit`` or ``parent`` location is used, and a note is printed.
3175
:param tree: The working tree to select a branch for merging into
3176
:param location: The location entered by the user
3177
:param revision: The revision parameter to the command
3178
:param index: The index to use for the revision parameter. Negative
3179
indices are permitted.
3180
:return: (selected_location, user_location). The default location
3181
will be the user-entered location.
3183
if (revision is not None and index is not None
3184
and revision[index] is not None):
3185
branch = revision[index].get_branch()
3186
if branch is not None:
3187
return branch, branch
3188
if user_location is None:
3189
location = self._get_remembered(tree, 'Merging from')
3191
location = user_location
3192
return location, user_location
3194
def _get_remembered(self, tree, verb_string):
3195
"""Use tree.branch's parent if none was supplied.
3197
Report if the remembered location was used.
3199
stored_location = tree.branch.get_submit_branch()
3200
stored_location_type = "submit"
3201
if stored_location is None:
3202
stored_location = tree.branch.get_parent()
3203
stored_location_type = "parent"
3204
mutter("%s", stored_location)
3205
if stored_location is None:
3206
raise errors.BzrCommandError("No location specified or remembered")
3207
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3208
note(u"%s remembered %s location %s", verb_string,
3209
stored_location_type, display_url)
3210
return stored_location
3213
class cmd_remerge(Command):
3216
Use this if you want to try a different merge technique while resolving
3217
conflicts. Some merge techniques are better than others, and remerge
3218
lets you try different ones on different files.
3220
The options for remerge have the same meaning and defaults as the ones for
3221
merge. The difference is that remerge can (only) be run when there is a
3222
pending merge, and it lets you specify particular files.
3225
Re-do the merge of all conflicted files, and show the base text in
3226
conflict regions, in addition to the usual THIS and OTHER texts::
3228
bzr remerge --show-base
3230
Re-do the merge of "foobar", using the weave merge algorithm, with
3231
additional processing to reduce the size of conflict regions::
3233
bzr remerge --merge-type weave --reprocess foobar
3235
takes_args = ['file*']
3240
help="Show base revision text in conflicts."),
3243
def run(self, file_list=None, merge_type=None, show_base=False,
3245
if merge_type is None:
3246
merge_type = _mod_merge.Merge3Merger
3247
tree, file_list = tree_files(file_list)
3250
parents = tree.get_parent_ids()
3251
if len(parents) != 2:
3252
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3253
" merges. Not cherrypicking or"
3255
repository = tree.branch.repository
3256
interesting_ids = None
3258
conflicts = tree.conflicts()
3259
if file_list is not None:
3260
interesting_ids = set()
3261
for filename in file_list:
3262
file_id = tree.path2id(filename)
3264
raise errors.NotVersionedError(filename)
3265
interesting_ids.add(file_id)
3266
if tree.kind(file_id) != "directory":
3269
for name, ie in tree.inventory.iter_entries(file_id):
3270
interesting_ids.add(ie.file_id)
3271
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3273
# Remerge only supports resolving contents conflicts
3274
allowed_conflicts = ('text conflict', 'contents conflict')
3275
restore_files = [c.path for c in conflicts
3276
if c.typestring in allowed_conflicts]
3277
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3278
tree.set_conflicts(ConflictList(new_conflicts))
3279
if file_list is not None:
3280
restore_files = file_list
3281
for filename in restore_files:
3283
restore(tree.abspath(filename))
3284
except errors.NotConflicted:
3286
# Disable pending merges, because the file texts we are remerging
3287
# have not had those merges performed. If we use the wrong parents
3288
# list, we imply that the working tree text has seen and rejected
3289
# all the changes from the other tree, when in fact those changes
3290
# have not yet been seen.
3291
pb = ui.ui_factory.nested_progress_bar()
3292
tree.set_parent_ids(parents[:1])
3294
merger = _mod_merge.Merger.from_revision_ids(pb,
3296
merger.interesting_ids = interesting_ids
3297
merger.merge_type = merge_type
3298
merger.show_base = show_base
3299
merger.reprocess = reprocess
3300
conflicts = merger.do_merge()
3302
tree.set_parent_ids(parents)
3312
class cmd_revert(Command):
3313
"""Revert files to a previous revision.
3315
Giving a list of files will revert only those files. Otherwise, all files
3316
will be reverted. If the revision is not specified with '--revision', the
3317
last committed revision is used.
3319
To remove only some changes, without reverting to a prior version, use
3320
merge instead. For example, "merge . --revision -2..-3" will remove the
3321
changes introduced by -2, without affecting the changes introduced by -1.
3322
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3324
By default, any files that have been manually changed will be backed up
3325
first. (Files changed only by merge are not backed up.) Backup files have
3326
'.~#~' appended to their name, where # is a number.
3328
When you provide files, you can use their current pathname or the pathname
3329
from the target revision. So you can use revert to "undelete" a file by
3330
name. If you name a directory, all the contents of that directory will be
3333
Any files that have been newly added since that revision will be deleted,
3334
with a backup kept if appropriate. Directories containing unknown files
3335
will not be deleted.
3337
The working tree contains a list of pending merged revisions, which will
3338
be included as parents in the next commit. Normally, revert clears that
3339
list as well as reverting the files. If any files are specified, revert
3340
leaves the pending merge list alone and reverts only the files. Use "bzr
3341
revert ." in the tree root to revert all files but keep the merge record,
3342
and "bzr revert --forget-merges" to clear the pending merge list without
3343
reverting any files.
3346
_see_also = ['cat', 'export']
3349
Option('no-backup', "Do not save backups of reverted files."),
3350
Option('forget-merges',
3351
'Remove pending merge marker, without changing any files.'),
3353
takes_args = ['file*']
3355
def run(self, revision=None, no_backup=False, file_list=None,
3356
forget_merges=None):
3357
tree, file_list = tree_files(file_list)
3361
tree.set_parent_ids(tree.get_parent_ids()[:1])
3363
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3368
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3369
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3370
pb = ui.ui_factory.nested_progress_bar()
3372
tree.revert(file_list, rev_tree, not no_backup, pb,
3373
report_changes=True)
3378
class cmd_assert_fail(Command):
3379
"""Test reporting of assertion failures"""
3380
# intended just for use in testing
3385
raise AssertionError("always fails")
3388
class cmd_help(Command):
3389
"""Show help on a command or other topic.
3392
_see_also = ['topics']
3394
Option('long', 'Show help on all commands.'),
3396
takes_args = ['topic?']
3397
aliases = ['?', '--help', '-?', '-h']
3400
def run(self, topic=None, long=False):
3402
if topic is None and long:
3404
bzrlib.help.help(topic)
3407
class cmd_shell_complete(Command):
3408
"""Show appropriate completions for context.
3410
For a list of all available commands, say 'bzr shell-complete'.
3412
takes_args = ['context?']
3417
def run(self, context=None):
3418
import shellcomplete
3419
shellcomplete.shellcomplete(context)
3422
class cmd_missing(Command):
3423
"""Show unmerged/unpulled revisions between two branches.
3425
OTHER_BRANCH may be local or remote.
3428
_see_also = ['merge', 'pull']
3429
takes_args = ['other_branch?']
3431
Option('reverse', 'Reverse the order of revisions.'),
3433
'Display changes in the local branch only.'),
3434
Option('this' , 'Same as --mine-only.'),
3435
Option('theirs-only',
3436
'Display changes in the remote branch only.'),
3437
Option('other', 'Same as --theirs-only.'),
3441
Option('include-merges', 'Show merged revisions.'),
3443
encoding_type = 'replace'
3446
def run(self, other_branch=None, reverse=False, mine_only=False,
3448
log_format=None, long=False, short=False, line=False,
3449
show_ids=False, verbose=False, this=False, other=False,
3450
include_merges=False):
3451
from bzrlib.missing import find_unmerged, iter_log_revisions
3460
# TODO: We should probably check that we don't have mine-only and
3461
# theirs-only set, but it gets complicated because we also have
3462
# this and other which could be used.
3469
local_branch = Branch.open_containing(u".")[0]
3470
parent = local_branch.get_parent()
3471
if other_branch is None:
3472
other_branch = parent
3473
if other_branch is None:
3474
raise errors.BzrCommandError("No peer location known"
3476
display_url = urlutils.unescape_for_display(parent,
3478
message("Using saved parent location: "
3479
+ display_url + "\n")
3481
remote_branch = Branch.open(other_branch)
3482
if remote_branch.base == local_branch.base:
3483
remote_branch = local_branch
3484
local_branch.lock_read()
3486
remote_branch.lock_read()
3488
local_extra, remote_extra = find_unmerged(
3489
local_branch, remote_branch, restrict,
3490
backward=not reverse,
3491
include_merges=include_merges)
3493
if log_format is None:
3494
registry = log.log_formatter_registry
3495
log_format = registry.get_default(local_branch)
3496
lf = log_format(to_file=self.outf,
3498
show_timezone='original')
3501
if local_extra and not theirs_only:
3502
message("You have %d extra revision(s):\n" %
3504
for revision in iter_log_revisions(local_extra,
3505
local_branch.repository,
3507
lf.log_revision(revision)
3508
printed_local = True
3511
printed_local = False
3513
if remote_extra and not mine_only:
3514
if printed_local is True:
3516
message("You are missing %d revision(s):\n" %
3518
for revision in iter_log_revisions(remote_extra,
3519
remote_branch.repository,
3521
lf.log_revision(revision)
3524
if mine_only and not local_extra:
3525
# We checked local, and found nothing extra
3526
message('This branch is up to date.\n')
3527
elif theirs_only and not remote_extra:
3528
# We checked remote, and found nothing extra
3529
message('Other branch is up to date.\n')
3530
elif not (mine_only or theirs_only or local_extra or
3532
# We checked both branches, and neither one had extra
3534
message("Branches are up to date.\n")
3536
remote_branch.unlock()
3538
local_branch.unlock()
3539
if not status_code and parent is None and other_branch is not None:
3540
local_branch.lock_write()
3542
# handle race conditions - a parent might be set while we run.
3543
if local_branch.get_parent() is None:
3544
local_branch.set_parent(remote_branch.base)
3546
local_branch.unlock()
3550
class cmd_pack(Command):
3551
"""Compress the data within a repository."""
3553
_see_also = ['repositories']
3554
takes_args = ['branch_or_repo?']
3556
def run(self, branch_or_repo='.'):
3557
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3559
branch = dir.open_branch()
3560
repository = branch.repository
3561
except errors.NotBranchError:
3562
repository = dir.open_repository()
3566
class cmd_plugins(Command):
3567
"""List the installed plugins.
3569
This command displays the list of installed plugins including
3570
version of plugin and a short description of each.
3572
--verbose shows the path where each plugin is located.
3574
A plugin is an external component for Bazaar that extends the
3575
revision control system, by adding or replacing code in Bazaar.
3576
Plugins can do a variety of things, including overriding commands,
3577
adding new commands, providing additional network transports and
3578
customizing log output.
3580
See the Bazaar web site, http://bazaar-vcs.org, for further
3581
information on plugins including where to find them and how to
3582
install them. Instructions are also provided there on how to
3583
write new plugins using the Python programming language.
3585
takes_options = ['verbose']
3588
def run(self, verbose=False):
3589
import bzrlib.plugin
3590
from inspect import getdoc
3592
for name, plugin in bzrlib.plugin.plugins().items():
3593
version = plugin.__version__
3594
if version == 'unknown':
3596
name_ver = '%s %s' % (name, version)
3597
d = getdoc(plugin.module)
3599
doc = d.split('\n')[0]
3601
doc = '(no description)'
3602
result.append((name_ver, doc, plugin.path()))
3603
for name_ver, doc, path in sorted(result):
3611
class cmd_testament(Command):
3612
"""Show testament (signing-form) of a revision."""
3615
Option('long', help='Produce long-format testament.'),
3617
help='Produce a strict-format testament.')]
3618
takes_args = ['branch?']
3620
def run(self, branch=u'.', revision=None, long=False, strict=False):
3621
from bzrlib.testament import Testament, StrictTestament
3623
testament_class = StrictTestament
3625
testament_class = Testament
3627
b = Branch.open_containing(branch)[0]
3629
b = Branch.open(branch)
3632
if revision is None:
3633
rev_id = b.last_revision()
3635
rev_id = revision[0].as_revision_id(b)
3636
t = testament_class.from_revision(b.repository, rev_id)
3638
sys.stdout.writelines(t.as_text_lines())
3640
sys.stdout.write(t.as_short_text())
3645
class cmd_annotate(Command):
3646
"""Show the origin of each line in a file.
3648
This prints out the given file with an annotation on the left side
3649
indicating which revision, author and date introduced the change.
3651
If the origin is the same for a run of consecutive lines, it is
3652
shown only at the top, unless the --all option is given.
3654
# TODO: annotate directories; showing when each file was last changed
3655
# TODO: if the working copy is modified, show annotations on that
3656
# with new uncommitted lines marked
3657
aliases = ['ann', 'blame', 'praise']
3658
takes_args = ['filename']
3659
takes_options = [Option('all', help='Show annotations on all lines.'),
3660
Option('long', help='Show commit date in annotations.'),
3664
encoding_type = 'exact'
3667
def run(self, filename, all=False, long=False, revision=None,
3669
from bzrlib.annotate import annotate_file, annotate_file_tree
3670
wt, branch, relpath = \
3671
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3677
tree = _get_one_revision_tree('annotate', revision, branch=branch)
3679
file_id = wt.path2id(relpath)
3681
file_id = tree.path2id(relpath)
3683
raise errors.NotVersionedError(filename)
3684
file_version = tree.inventory[file_id].revision
3685
if wt is not None and revision is None:
3686
# If there is a tree and we're not annotating historical
3687
# versions, annotate the working tree's content.
3688
annotate_file_tree(wt, file_id, self.outf, long, all,
3691
annotate_file(branch, file_version, file_id, long, all, self.outf,
3700
class cmd_re_sign(Command):
3701
"""Create a digital signature for an existing revision."""
3702
# TODO be able to replace existing ones.
3704
hidden = True # is this right ?
3705
takes_args = ['revision_id*']
3706
takes_options = ['revision']
3708
def run(self, revision_id_list=None, revision=None):
3709
if revision_id_list is not None and revision is not None:
3710
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3711
if revision_id_list is None and revision is None:
3712
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3713
b = WorkingTree.open_containing(u'.')[0].branch
3716
return self._run(b, revision_id_list, revision)
3720
def _run(self, b, revision_id_list, revision):
3721
import bzrlib.gpg as gpg
3722
gpg_strategy = gpg.GPGStrategy(b.get_config())
3723
if revision_id_list is not None:
3724
b.repository.start_write_group()
3726
for revision_id in revision_id_list:
3727
b.repository.sign_revision(revision_id, gpg_strategy)
3729
b.repository.abort_write_group()
3732
b.repository.commit_write_group()
3733
elif revision is not None:
3734
if len(revision) == 1:
3735
revno, rev_id = revision[0].in_history(b)
3736
b.repository.start_write_group()
3738
b.repository.sign_revision(rev_id, gpg_strategy)
3740
b.repository.abort_write_group()
3743
b.repository.commit_write_group()
3744
elif len(revision) == 2:
3745
# are they both on rh- if so we can walk between them
3746
# might be nice to have a range helper for arbitrary
3747
# revision paths. hmm.
3748
from_revno, from_revid = revision[0].in_history(b)
3749
to_revno, to_revid = revision[1].in_history(b)
3750
if to_revid is None:
3751
to_revno = b.revno()
3752
if from_revno is None or to_revno is None:
3753
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3754
b.repository.start_write_group()
3756
for revno in range(from_revno, to_revno + 1):
3757
b.repository.sign_revision(b.get_rev_id(revno),
3760
b.repository.abort_write_group()
3763
b.repository.commit_write_group()
3765
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3768
class cmd_bind(Command):
3769
"""Convert the current branch into a checkout of the supplied branch.
3771
Once converted into a checkout, commits must succeed on the master branch
3772
before they will be applied to the local branch.
3774
Bound branches use the nickname of its master branch unless it is set
3775
locally, in which case binding will update the the local nickname to be
3779
_see_also = ['checkouts', 'unbind']
3780
takes_args = ['location?']
3783
def run(self, location=None):
3784
b, relpath = Branch.open_containing(u'.')
3785
if location is None:
3787
location = b.get_old_bound_location()
3788
except errors.UpgradeRequired:
3789
raise errors.BzrCommandError('No location supplied. '
3790
'This format does not remember old locations.')
3792
if location is None:
3793
raise errors.BzrCommandError('No location supplied and no '
3794
'previous location known')
3795
b_other = Branch.open(location)
3798
except errors.DivergedBranches:
3799
raise errors.BzrCommandError('These branches have diverged.'
3800
' Try merging, and then bind again.')
3801
if b.get_config().has_explicit_nickname():
3802
b.nick = b_other.nick
3805
class cmd_unbind(Command):
3806
"""Convert the current checkout into a regular branch.
3808
After unbinding, the local branch is considered independent and subsequent
3809
commits will be local only.
3812
_see_also = ['checkouts', 'bind']
3817
b, relpath = Branch.open_containing(u'.')
3819
raise errors.BzrCommandError('Local branch is not bound')
3822
class cmd_uncommit(Command):
3823
"""Remove the last committed revision.
3825
--verbose will print out what is being removed.
3826
--dry-run will go through all the motions, but not actually
3829
If --revision is specified, uncommit revisions to leave the branch at the
3830
specified revision. For example, "bzr uncommit -r 15" will leave the
3831
branch at revision 15.
3833
Uncommit leaves the working tree ready for a new commit. The only change
3834
it may make is to restore any pending merges that were present before
3838
# TODO: jam 20060108 Add an option to allow uncommit to remove
3839
# unreferenced information in 'branch-as-repository' branches.
3840
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3841
# information in shared branches as well.
3842
_see_also = ['commit']
3843
takes_options = ['verbose', 'revision',
3844
Option('dry-run', help='Don\'t actually make changes.'),
3845
Option('force', help='Say yes to all questions.'),
3847
help="Only remove the commits from the local branch"
3848
" when in a checkout."
3851
takes_args = ['location?']
3853
encoding_type = 'replace'
3855
def run(self, location=None,
3856
dry_run=False, verbose=False,
3857
revision=None, force=False, local=False):
3858
if location is None:
3860
control, relpath = bzrdir.BzrDir.open_containing(location)
3862
tree = control.open_workingtree()
3864
except (errors.NoWorkingTree, errors.NotLocalUrl):
3866
b = control.open_branch()
3868
if tree is not None:
3873
return self._run(b, tree, dry_run, verbose, revision, force,
3876
if tree is not None:
3881
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3882
from bzrlib.log import log_formatter, show_log
3883
from bzrlib.uncommit import uncommit
3885
last_revno, last_rev_id = b.last_revision_info()
3888
if revision is None:
3890
rev_id = last_rev_id
3892
# 'bzr uncommit -r 10' actually means uncommit
3893
# so that the final tree is at revno 10.
3894
# but bzrlib.uncommit.uncommit() actually uncommits
3895
# the revisions that are supplied.
3896
# So we need to offset it by one
3897
revno = revision[0].in_history(b).revno + 1
3898
if revno <= last_revno:
3899
rev_id = b.get_rev_id(revno)
3901
if rev_id is None or _mod_revision.is_null(rev_id):
3902
self.outf.write('No revisions to uncommit.\n')
3905
lf = log_formatter('short',
3907
show_timezone='original')
3912
direction='forward',
3913
start_revision=revno,
3914
end_revision=last_revno)
3917
print 'Dry-run, pretending to remove the above revisions.'
3919
val = raw_input('Press <enter> to continue')
3921
print 'The above revision(s) will be removed.'
3923
val = raw_input('Are you sure [y/N]? ')
3924
if val.lower() not in ('y', 'yes'):
3928
mutter('Uncommitting from {%s} to {%s}',
3929
last_rev_id, rev_id)
3930
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3931
revno=revno, local=local)
3932
note('You can restore the old tip by running:\n'
3933
' bzr pull . -r revid:%s', last_rev_id)
3936
class cmd_break_lock(Command):
3937
"""Break a dead lock on a repository, branch or working directory.
3939
CAUTION: Locks should only be broken when you are sure that the process
3940
holding the lock has been stopped.
3942
You can get information on what locks are open via the 'bzr info' command.
3947
takes_args = ['location?']
3949
def run(self, location=None, show=False):
3950
if location is None:
3952
control, relpath = bzrdir.BzrDir.open_containing(location)
3954
control.break_lock()
3955
except NotImplementedError:
3959
class cmd_wait_until_signalled(Command):
3960
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3962
This just prints a line to signal when it is ready, then blocks on stdin.
3968
sys.stdout.write("running\n")
3970
sys.stdin.readline()
3973
class cmd_serve(Command):
3974
"""Run the bzr server."""
3976
aliases = ['server']
3980
help='Serve on stdin/out for use from inetd or sshd.'),
3982
help='Listen for connections on nominated port of the form '
3983
'[hostname:]portnumber. Passing 0 as the port number will '
3984
'result in a dynamically allocated port. The default port is '
3988
help='Serve contents of this directory.',
3990
Option('allow-writes',
3991
help='By default the server is a readonly server. Supplying '
3992
'--allow-writes enables write access to the contents of '
3993
'the served directory and below.'
3997
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3998
from bzrlib import lockdir
3999
from bzrlib.smart import medium, server
4000
from bzrlib.transport import get_transport
4001
from bzrlib.transport.chroot import ChrootServer
4002
if directory is None:
4003
directory = os.getcwd()
4004
url = urlutils.local_path_to_url(directory)
4005
if not allow_writes:
4006
url = 'readonly+' + url
4007
chroot_server = ChrootServer(get_transport(url))
4008
chroot_server.setUp()
4009
t = get_transport(chroot_server.get_url())
4011
smart_server = medium.SmartServerPipeStreamMedium(
4012
sys.stdin, sys.stdout, t)
4014
host = medium.BZR_DEFAULT_INTERFACE
4016
port = medium.BZR_DEFAULT_PORT
4019
host, port = port.split(':')
4021
smart_server = server.SmartTCPServer(t, host=host, port=port)
4022
print 'listening on port: ', smart_server.port
4024
# for the duration of this server, no UI output is permitted.
4025
# note that this may cause problems with blackbox tests. This should
4026
# be changed with care though, as we dont want to use bandwidth sending
4027
# progress over stderr to smart server clients!
4028
old_factory = ui.ui_factory
4029
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4031
ui.ui_factory = ui.SilentUIFactory()
4032
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4033
smart_server.serve()
4035
ui.ui_factory = old_factory
4036
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4039
class cmd_join(Command):
4040
"""Combine a subtree into its containing tree.
4042
This command is for experimental use only. It requires the target tree
4043
to be in dirstate-with-subtree format, which cannot be converted into
4046
The TREE argument should be an independent tree, inside another tree, but
4047
not part of it. (Such trees can be produced by "bzr split", but also by
4048
running "bzr branch" with the target inside a tree.)
4050
The result is a combined tree, with the subtree no longer an independant
4051
part. This is marked as a merge of the subtree into the containing tree,
4052
and all history is preserved.
4054
If --reference is specified, the subtree retains its independence. It can
4055
be branched by itself, and can be part of multiple projects at the same
4056
time. But operations performed in the containing tree, such as commit
4057
and merge, will recurse into the subtree.
4060
_see_also = ['split']
4061
takes_args = ['tree']
4063
Option('reference', help='Join by reference.'),
4067
def run(self, tree, reference=False):
4068
sub_tree = WorkingTree.open(tree)
4069
parent_dir = osutils.dirname(sub_tree.basedir)
4070
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4071
repo = containing_tree.branch.repository
4072
if not repo.supports_rich_root():
4073
raise errors.BzrCommandError(
4074
"Can't join trees because %s doesn't support rich root data.\n"
4075
"You can use bzr upgrade on the repository."
4079
containing_tree.add_reference(sub_tree)
4080
except errors.BadReferenceTarget, e:
4081
# XXX: Would be better to just raise a nicely printable
4082
# exception from the real origin. Also below. mbp 20070306
4083
raise errors.BzrCommandError("Cannot join %s. %s" %
4087
containing_tree.subsume(sub_tree)
4088
except errors.BadSubsumeSource, e:
4089
raise errors.BzrCommandError("Cannot join %s. %s" %
4093
class cmd_split(Command):
4094
"""Split a subdirectory of a tree into a separate tree.
4096
This command will produce a target tree in a format that supports
4097
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4098
converted into earlier formats like 'dirstate-tags'.
4100
The TREE argument should be a subdirectory of a working tree. That
4101
subdirectory will be converted into an independent tree, with its own
4102
branch. Commits in the top-level tree will not apply to the new subtree.
4105
# join is not un-hidden yet
4106
#_see_also = ['join']
4107
takes_args = ['tree']
4109
def run(self, tree):
4110
containing_tree, subdir = WorkingTree.open_containing(tree)
4111
sub_id = containing_tree.path2id(subdir)
4113
raise errors.NotVersionedError(subdir)
4115
containing_tree.extract(sub_id)
4116
except errors.RootNotRich:
4117
raise errors.UpgradeRequired(containing_tree.branch.base)
4120
class cmd_merge_directive(Command):
4121
"""Generate a merge directive for auto-merge tools.
4123
A directive requests a merge to be performed, and also provides all the
4124
information necessary to do so. This means it must either include a
4125
revision bundle, or the location of a branch containing the desired
4128
A submit branch (the location to merge into) must be supplied the first
4129
time the command is issued. After it has been supplied once, it will
4130
be remembered as the default.
4132
A public branch is optional if a revision bundle is supplied, but required
4133
if --diff or --plain is specified. It will be remembered as the default
4134
after the first use.
4137
takes_args = ['submit_branch?', 'public_branch?']
4141
_see_also = ['send']
4144
RegistryOption.from_kwargs('patch-type',
4145
'The type of patch to include in the directive.',
4147
value_switches=True,
4149
bundle='Bazaar revision bundle (default).',
4150
diff='Normal unified diff.',
4151
plain='No patch, just directive.'),
4152
Option('sign', help='GPG-sign the directive.'), 'revision',
4153
Option('mail-to', type=str,
4154
help='Instead of printing the directive, email to this address.'),
4155
Option('message', type=str, short_name='m',
4156
help='Message to use when committing this merge.')
4159
encoding_type = 'exact'
4161
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4162
sign=False, revision=None, mail_to=None, message=None):
4163
from bzrlib.revision import ensure_null, NULL_REVISION
4164
include_patch, include_bundle = {
4165
'plain': (False, False),
4166
'diff': (True, False),
4167
'bundle': (True, True),
4169
branch = Branch.open('.')
4170
stored_submit_branch = branch.get_submit_branch()
4171
if submit_branch is None:
4172
submit_branch = stored_submit_branch
4174
if stored_submit_branch is None:
4175
branch.set_submit_branch(submit_branch)
4176
if submit_branch is None:
4177
submit_branch = branch.get_parent()
4178
if submit_branch is None:
4179
raise errors.BzrCommandError('No submit branch specified or known')
4181
stored_public_branch = branch.get_public_branch()
4182
if public_branch is None:
4183
public_branch = stored_public_branch
4184
elif stored_public_branch is None:
4185
branch.set_public_branch(public_branch)
4186
if not include_bundle and public_branch is None:
4187
raise errors.BzrCommandError('No public branch specified or'
4189
base_revision_id = None
4190
if revision is not None:
4191
if len(revision) > 2:
4192
raise errors.BzrCommandError('bzr merge-directive takes '
4193
'at most two one revision identifiers')
4194
revision_id = revision[-1].as_revision_id(branch)
4195
if len(revision) == 2:
4196
base_revision_id = revision[0].as_revision_id(branch)
4198
revision_id = branch.last_revision()
4199
revision_id = ensure_null(revision_id)
4200
if revision_id == NULL_REVISION:
4201
raise errors.BzrCommandError('No revisions to bundle.')
4202
directive = merge_directive.MergeDirective2.from_objects(
4203
branch.repository, revision_id, time.time(),
4204
osutils.local_time_offset(), submit_branch,
4205
public_branch=public_branch, include_patch=include_patch,
4206
include_bundle=include_bundle, message=message,
4207
base_revision_id=base_revision_id)
4210
self.outf.write(directive.to_signed(branch))
4212
self.outf.writelines(directive.to_lines())
4214
message = directive.to_email(mail_to, branch, sign)
4215
s = SMTPConnection(branch.get_config())
4216
s.send_email(message)
4219
class cmd_send(Command):
4220
"""Mail or create a merge-directive for submiting changes.
4222
A merge directive provides many things needed for requesting merges:
4224
* A machine-readable description of the merge to perform
4226
* An optional patch that is a preview of the changes requested
4228
* An optional bundle of revision data, so that the changes can be applied
4229
directly from the merge directive, without retrieving data from a
4232
If --no-bundle is specified, then public_branch is needed (and must be
4233
up-to-date), so that the receiver can perform the merge using the
4234
public_branch. The public_branch is always included if known, so that
4235
people can check it later.
4237
The submit branch defaults to the parent, but can be overridden. Both
4238
submit branch and public branch will be remembered if supplied.
4240
If a public_branch is known for the submit_branch, that public submit
4241
branch is used in the merge instructions. This means that a local mirror
4242
can be used as your actual submit branch, once you have set public_branch
4245
Mail is sent using your preferred mail program. This should be transparent
4246
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4247
If the preferred client can't be found (or used), your editor will be used.
4249
To use a specific mail program, set the mail_client configuration option.
4250
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4251
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4252
generic options are "default", "editor", "emacsclient", "mapi", and
4253
"xdg-email". Plugins may also add supported clients.
4255
If mail is being sent, a to address is required. This can be supplied
4256
either on the commandline, by setting the submit_to configuration
4257
option in the branch itself or the child_submit_to configuration option
4258
in the submit branch.
4260
Two formats are currently supported: "4" uses revision bundle format 4 and
4261
merge directive format 2. It is significantly faster and smaller than
4262
older formats. It is compatible with Bazaar 0.19 and later. It is the
4263
default. "0.9" uses revision bundle format 0.9 and merge directive
4264
format 1. It is compatible with Bazaar 0.12 - 0.18.
4266
Merge directives are applied using the merge command or the pull command.
4269
encoding_type = 'exact'
4271
_see_also = ['merge', 'pull']
4273
takes_args = ['submit_branch?', 'public_branch?']
4277
help='Do not include a bundle in the merge directive.'),
4278
Option('no-patch', help='Do not include a preview patch in the merge'
4281
help='Remember submit and public branch.'),
4283
help='Branch to generate the submission from, '
4284
'rather than the one containing the working directory.',
4287
Option('output', short_name='o',
4288
help='Write merge directive to this file; '
4289
'use - for stdout.',
4291
Option('mail-to', help='Mail the request to this address.',
4295
RegistryOption.from_kwargs('format',
4296
'Use the specified output format.',
4297
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4298
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4301
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4302
no_patch=False, revision=None, remember=False, output=None,
4303
format='4', mail_to=None, message=None, **kwargs):
4304
return self._run(submit_branch, revision, public_branch, remember,
4305
format, no_bundle, no_patch, output,
4306
kwargs.get('from', '.'), mail_to, message)
4308
def _run(self, submit_branch, revision, public_branch, remember, format,
4309
no_bundle, no_patch, output, from_, mail_to, message):
4310
from bzrlib.revision import NULL_REVISION
4311
branch = Branch.open_containing(from_)[0]
4313
outfile = cStringIO.StringIO()
4317
outfile = open(output, 'wb')
4318
# we may need to write data into branch's repository to calculate
4323
config = branch.get_config()
4325
mail_to = config.get_user_option('submit_to')
4326
mail_client = config.get_mail_client()
4327
if remember and submit_branch is None:
4328
raise errors.BzrCommandError(
4329
'--remember requires a branch to be specified.')
4330
stored_submit_branch = branch.get_submit_branch()
4331
remembered_submit_branch = None
4332
if submit_branch is None:
4333
submit_branch = stored_submit_branch
4334
remembered_submit_branch = "submit"
4336
if stored_submit_branch is None or remember:
4337
branch.set_submit_branch(submit_branch)
4338
if submit_branch is None:
4339
submit_branch = branch.get_parent()
4340
remembered_submit_branch = "parent"
4341
if submit_branch is None:
4342
raise errors.BzrCommandError('No submit branch known or'
4344
if remembered_submit_branch is not None:
4345
note('Using saved %s location "%s" to determine what '
4346
'changes to submit.', remembered_submit_branch,
4350
submit_config = Branch.open(submit_branch).get_config()
4351
mail_to = submit_config.get_user_option("child_submit_to")
4353
stored_public_branch = branch.get_public_branch()
4354
if public_branch is None:
4355
public_branch = stored_public_branch
4356
elif stored_public_branch is None or remember:
4357
branch.set_public_branch(public_branch)
4358
if no_bundle and public_branch is None:
4359
raise errors.BzrCommandError('No public branch specified or'
4361
base_revision_id = None
4363
if revision is not None:
4364
if len(revision) > 2:
4365
raise errors.BzrCommandError('bzr send takes '
4366
'at most two one revision identifiers')
4367
revision_id = revision[-1].as_revision_id(branch)
4368
if len(revision) == 2:
4369
base_revision_id = revision[0].as_revision_id(branch)
4370
if revision_id is None:
4371
revision_id = branch.last_revision()
4372
if revision_id == NULL_REVISION:
4373
raise errors.BzrCommandError('No revisions to submit.')
4375
directive = merge_directive.MergeDirective2.from_objects(
4376
branch.repository, revision_id, time.time(),
4377
osutils.local_time_offset(), submit_branch,
4378
public_branch=public_branch, include_patch=not no_patch,
4379
include_bundle=not no_bundle, message=message,
4380
base_revision_id=base_revision_id)
4381
elif format == '0.9':
4384
patch_type = 'bundle'
4386
raise errors.BzrCommandError('Format 0.9 does not'
4387
' permit bundle with no patch')
4393
directive = merge_directive.MergeDirective.from_objects(
4394
branch.repository, revision_id, time.time(),
4395
osutils.local_time_offset(), submit_branch,
4396
public_branch=public_branch, patch_type=patch_type,
4399
outfile.writelines(directive.to_lines())
4401
subject = '[MERGE] '
4402
if message is not None:
4405
revision = branch.repository.get_revision(revision_id)
4406
subject += revision.get_summary()
4407
basename = directive.get_disk_name(branch)
4408
mail_client.compose_merge_request(mail_to, subject,
4409
outfile.getvalue(), basename)
4416
class cmd_bundle_revisions(cmd_send):
4418
"""Create a merge-directive for submiting changes.
4420
A merge directive provides many things needed for requesting merges:
4422
* A machine-readable description of the merge to perform
4424
* An optional patch that is a preview of the changes requested
4426
* An optional bundle of revision data, so that the changes can be applied
4427
directly from the merge directive, without retrieving data from a
4430
If --no-bundle is specified, then public_branch is needed (and must be
4431
up-to-date), so that the receiver can perform the merge using the
4432
public_branch. The public_branch is always included if known, so that
4433
people can check it later.
4435
The submit branch defaults to the parent, but can be overridden. Both
4436
submit branch and public branch will be remembered if supplied.
4438
If a public_branch is known for the submit_branch, that public submit
4439
branch is used in the merge instructions. This means that a local mirror
4440
can be used as your actual submit branch, once you have set public_branch
4443
Two formats are currently supported: "4" uses revision bundle format 4 and
4444
merge directive format 2. It is significantly faster and smaller than
4445
older formats. It is compatible with Bazaar 0.19 and later. It is the
4446
default. "0.9" uses revision bundle format 0.9 and merge directive
4447
format 1. It is compatible with Bazaar 0.12 - 0.18.
4452
help='Do not include a bundle in the merge directive.'),
4453
Option('no-patch', help='Do not include a preview patch in the merge'
4456
help='Remember submit and public branch.'),
4458
help='Branch to generate the submission from, '
4459
'rather than the one containing the working directory.',
4462
Option('output', short_name='o', help='Write directive to this file.',
4465
RegistryOption.from_kwargs('format',
4466
'Use the specified output format.',
4467
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4468
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4470
aliases = ['bundle']
4472
_see_also = ['send', 'merge']
4476
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4477
no_patch=False, revision=None, remember=False, output=None,
4478
format='4', **kwargs):
4481
return self._run(submit_branch, revision, public_branch, remember,
4482
format, no_bundle, no_patch, output,
4483
kwargs.get('from', '.'), None, None)
4486
class cmd_tag(Command):
4487
"""Create, remove or modify a tag naming a revision.
4489
Tags give human-meaningful names to revisions. Commands that take a -r
4490
(--revision) option can be given -rtag:X, where X is any previously
4493
Tags are stored in the branch. Tags are copied from one branch to another
4494
along when you branch, push, pull or merge.
4496
It is an error to give a tag name that already exists unless you pass
4497
--force, in which case the tag is moved to point to the new revision.
4499
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4500
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4503
_see_also = ['commit', 'tags']
4504
takes_args = ['tag_name']
4507
help='Delete this tag rather than placing it.',
4510
help='Branch in which to place the tag.',
4515
help='Replace existing tags.',
4520
def run(self, tag_name,
4526
branch, relpath = Branch.open_containing(directory)
4530
branch.tags.delete_tag(tag_name)
4531
self.outf.write('Deleted tag %s.\n' % tag_name)
4534
if len(revision) != 1:
4535
raise errors.BzrCommandError(
4536
"Tags can only be placed on a single revision, "
4538
revision_id = revision[0].as_revision_id(branch)
4540
revision_id = branch.last_revision()
4541
if (not force) and branch.tags.has_tag(tag_name):
4542
raise errors.TagAlreadyExists(tag_name)
4543
branch.tags.set_tag(tag_name, revision_id)
4544
self.outf.write('Created tag %s.\n' % tag_name)
4549
class cmd_tags(Command):
4552
This command shows a table of tag names and the revisions they reference.
4558
help='Branch whose tags should be displayed.',
4562
RegistryOption.from_kwargs('sort',
4563
'Sort tags by different criteria.', title='Sorting',
4564
alpha='Sort tags lexicographically (default).',
4565
time='Sort tags chronologically.',
4576
branch, relpath = Branch.open_containing(directory)
4577
tags = branch.tags.get_tag_dict().items()
4582
elif sort == 'time':
4584
for tag, revid in tags:
4586
revobj = branch.repository.get_revision(revid)
4587
except errors.NoSuchRevision:
4588
timestamp = sys.maxint # place them at the end
4590
timestamp = revobj.timestamp
4591
timestamps[revid] = timestamp
4592
tags.sort(key=lambda x: timestamps[x[1]])
4594
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4595
revno_map = branch.get_revision_id_to_revno_map()
4596
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4597
for tag, revid in tags ]
4598
for tag, revspec in tags:
4599
self.outf.write('%-20s %s\n' % (tag, revspec))
4602
class cmd_reconfigure(Command):
4603
"""Reconfigure the type of a bzr directory.
4605
A target configuration must be specified.
4607
For checkouts, the bind-to location will be auto-detected if not specified.
4608
The order of preference is
4609
1. For a lightweight checkout, the current bound location.
4610
2. For branches that used to be checkouts, the previously-bound location.
4611
3. The push location.
4612
4. The parent location.
4613
If none of these is available, --bind-to must be specified.
4616
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4617
takes_args = ['location?']
4618
takes_options = [RegistryOption.from_kwargs('target_type',
4619
title='Target type',
4620
help='The type to reconfigure the directory to.',
4621
value_switches=True, enum_switch=False,
4622
branch='Reconfigure to be an unbound branch '
4623
'with no working tree.',
4624
tree='Reconfigure to be an unbound branch '
4625
'with a working tree.',
4626
checkout='Reconfigure to be a bound branch '
4627
'with a working tree.',
4628
lightweight_checkout='Reconfigure to be a lightweight'
4629
' checkout (with no local history).',
4630
standalone='Reconfigure to be a standalone branch '
4631
'(i.e. stop using shared repository).',
4632
use_shared='Reconfigure to use a shared repository.'),
4633
Option('bind-to', help='Branch to bind checkout to.',
4636
help='Perform reconfiguration even if local changes'
4640
def run(self, location=None, target_type=None, bind_to=None, force=False):
4641
directory = bzrdir.BzrDir.open(location)
4642
if target_type is None:
4643
raise errors.BzrCommandError('No target configuration specified')
4644
elif target_type == 'branch':
4645
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4646
elif target_type == 'tree':
4647
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4648
elif target_type == 'checkout':
4649
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4651
elif target_type == 'lightweight-checkout':
4652
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4654
elif target_type == 'use-shared':
4655
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4656
elif target_type == 'standalone':
4657
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4658
reconfiguration.apply(force)
4661
class cmd_switch(Command):
4662
"""Set the branch of a checkout and update.
4664
For lightweight checkouts, this changes the branch being referenced.
4665
For heavyweight checkouts, this checks that there are no local commits
4666
versus the current bound branch, then it makes the local branch a mirror
4667
of the new location and binds to it.
4669
In both cases, the working tree is updated and uncommitted changes
4670
are merged. The user can commit or revert these as they desire.
4672
Pending merges need to be committed or reverted before using switch.
4674
The path to the branch to switch to can be specified relative to the parent
4675
directory of the current branch. For example, if you are currently in a
4676
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4679
Bound branches use the nickname of its master branch unless it is set
4680
locally, in which case switching will update the the local nickname to be
4684
takes_args = ['to_location']
4685
takes_options = [Option('force',
4686
help='Switch even if local commits will be lost.')
4689
def run(self, to_location, force=False):
4690
from bzrlib import switch
4692
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4693
branch = control_dir.open_branch()
4695
to_branch = Branch.open(to_location)
4696
except errors.NotBranchError:
4697
this_branch = control_dir.open_branch()
4698
# This may be a heavy checkout, where we want the master branch
4699
this_url = this_branch.get_bound_location()
4700
# If not, use a local sibling
4701
if this_url is None:
4702
this_url = this_branch.base
4703
to_branch = Branch.open(
4704
urlutils.join(this_url, '..', to_location))
4705
switch.switch(control_dir, to_branch, force)
4706
if branch.get_config().has_explicit_nickname():
4707
branch = control_dir.open_branch() #get the new branch!
4708
branch.nick = to_branch.nick
4709
note('Switched to branch: %s',
4710
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4713
class cmd_hooks(Command):
4714
"""Show a branch's currently registered hooks.
4718
takes_args = ['path?']
4720
def run(self, path=None):
4723
branch_hooks = Branch.open(path).hooks
4724
for hook_type in branch_hooks:
4725
hooks = branch_hooks[hook_type]
4726
self.outf.write("%s:\n" % (hook_type,))
4729
self.outf.write(" %s\n" %
4730
(branch_hooks.get_hook_name(hook),))
4732
self.outf.write(" <no hooks installed>\n")
4735
class cmd_shelve(Command):
4736
"""Temporarily set aside some changes from the current tree.
4738
Shelve allows you to temporarily put changes you've made "on the shelf",
4739
ie. out of the way, until a later time when you can bring them back from
4740
the shelf with the 'unshelve' command.
4742
Shelve is intended to help separate several sets of changes that have
4743
been inappropriately mingled. If you just want to get rid of all changes
4744
and you don't need to restore them later, use revert. If you want to
4745
shelve all text changes at once, use shelve --all.
4747
If filenames are specified, only the changes to those files will be
4748
shelved. Other files will be left untouched.
4750
If a revision is specified, changes since that revision will be shelved.
4752
You can put multiple items on the shelf, and by default, 'unshelve' will
4753
restore the most recently shelved changes.
4756
takes_args = ['file*']
4760
Option('all', help='Shelve all changes.'),
4762
RegistryOption('writer', 'Method to use for writing diffs.',
4763
bzrlib.option.diff_writer_registry,
4764
value_switches=True, enum_switch=False)
4766
_see_also = ['unshelve']
4768
def run(self, revision=None, all=False, file_list=None, message=None,
4770
from bzrlib.shelf_ui import Shelver
4772
writer = bzrlib.option.diff_writer_registry.get()
4774
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
4776
except errors.UserAbort:
4780
class cmd_unshelve(Command):
4781
"""Restore shelved changes.
4783
By default, the most recently shelved changes are restored. However if you
4784
specify a patch by name those changes will be restored instead. This
4785
works best when the changes don't depend on each other.
4788
takes_args = ['shelf_id?']
4790
RegistryOption.from_kwargs(
4791
'action', help="The action to perform.",
4792
enum_switch=False, value_switches=True,
4793
apply="Apply changes and remove from the shelf.",
4794
dry_run="Show changes, but do not apply or remove them.",
4795
delete_only="Delete changes without applying them."
4798
_see_also = ['shelve']
4800
def run(self, shelf_id=None, action='apply'):
4801
from bzrlib.shelf_ui import Unshelver
4802
Unshelver.from_args(shelf_id, action).run()
4805
def _create_prefix(cur_transport):
4806
needed = [cur_transport]
4807
# Recurse upwards until we can create a directory successfully
4809
new_transport = cur_transport.clone('..')
4810
if new_transport.base == cur_transport.base:
4811
raise errors.BzrCommandError(
4812
"Failed to create path prefix for %s."
4813
% cur_transport.base)
4815
new_transport.mkdir('.')
4816
except errors.NoSuchFile:
4817
needed.append(new_transport)
4818
cur_transport = new_transport
4821
# Now we only need to create child directories
4823
cur_transport = needed.pop()
4824
cur_transport.ensure_base()
4827
# these get imported and then picked up by the scan for cmd_*
4828
# TODO: Some more consistent way to split command definitions across files;
4829
# we do need to load at least some information about them to know of
4830
# aliases. ideally we would avoid loading the implementation until the
4831
# details were needed.
4832
from bzrlib.cmd_version_info import cmd_version_info
4833
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4834
from bzrlib.bundle.commands import (
4837
from bzrlib.sign_my_commits import cmd_sign_my_commits
4838
from bzrlib.weave_commands import cmd_versionedfile_list, \
4839
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
