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"""
20
from StringIO import StringIO
22
from bzrlib.lazy_import import lazy_import
23
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, info
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
# XXX: Bad function name; should possibly also be a class method of
71
# WorkingTree rather than a function.
72
def internal_tree_files(file_list, default_branch=u'.'):
73
"""Convert command-line paths to a WorkingTree and relative paths.
75
This is typically used for command-line processors that take one or
76
more filenames, and infer the workingtree that contains them.
78
The filenames given are not required to exist.
80
:param file_list: Filenames to convert.
82
:param default_branch: Fallback tree path to use if file_list is empty or
85
:return: workingtree, [relative_paths]
87
if file_list is None or len(file_list) == 0:
88
return WorkingTree.open_containing(default_branch)[0], file_list
89
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
90
return tree, safe_relpath_files(tree, file_list)
93
def safe_relpath_files(tree, file_list):
94
"""Convert file_list into a list of relpaths in tree.
96
:param tree: A tree to operate on.
97
:param file_list: A list of user provided paths or None.
98
:return: A list of relative paths.
99
:raises errors.PathNotChild: When a provided path is in a different tree
102
if file_list is None:
105
for filename in file_list:
107
new_list.append(tree.relpath(osutils.dereference_path(filename)))
108
except errors.PathNotChild:
109
raise errors.FileInWrongBranch(tree.branch, filename)
113
# TODO: Make sure no commands unconditionally use the working directory as a
114
# branch. If a filename argument is used, the first of them should be used to
115
# specify the branch. (Perhaps this can be factored out into some kind of
116
# Argument class, representing a file in a branch, where the first occurrence
119
class cmd_status(Command):
120
"""Display status summary.
122
This reports on versioned and unknown files, reporting them
123
grouped by state. Possible states are:
126
Versioned in the working copy but not in the previous revision.
129
Versioned in the previous revision but removed or deleted
133
Path of this file changed from the previous revision;
134
the text may also have changed. This includes files whose
135
parent directory was renamed.
138
Text has changed since the previous revision.
141
File kind has been changed (e.g. from file to directory).
144
Not versioned and not matching an ignore pattern.
146
To see ignored files use 'bzr ignored'. For details on the
147
changes to file texts, use 'bzr diff'.
149
Note that --short or -S gives status flags for each item, similar
150
to Subversion's status command. To get output similar to svn -q,
153
If no arguments are specified, the status of the entire working
154
directory is shown. Otherwise, only the status of the specified
155
files or directories is reported. If a directory is given, status
156
is reported for everything inside that directory.
158
If a revision argument is given, the status is calculated against
159
that revision, or between two revisions if two are provided.
162
# TODO: --no-recurse, --recurse options
164
takes_args = ['file*']
165
takes_options = ['show-ids', 'revision', 'change',
166
Option('short', help='Use short status indicators.',
168
Option('versioned', help='Only show versioned files.',
170
Option('no-pending', help='Don\'t show pending merges.',
173
aliases = ['st', 'stat']
175
encoding_type = 'replace'
176
_see_also = ['diff', 'revert', 'status-flags']
179
def run(self, show_ids=False, file_list=None, revision=None, short=False,
180
versioned=False, no_pending=False):
181
from bzrlib.status import show_tree_status
183
if revision and len(revision) > 2:
184
raise errors.BzrCommandError('bzr status --revision takes exactly'
185
' one or two revision specifiers')
187
tree, relfile_list = tree_files(file_list)
188
# Avoid asking for specific files when that is not needed.
189
if relfile_list == ['']:
191
# Don't disable pending merges for full trees other than '.'.
192
if file_list == ['.']:
194
# A specific path within a tree was given.
195
elif relfile_list is not None:
197
show_tree_status(tree, show_ids=show_ids,
198
specific_files=relfile_list, revision=revision,
199
to_file=self.outf, short=short, versioned=versioned,
200
show_pending=(not no_pending))
203
class cmd_cat_revision(Command):
204
"""Write out metadata for a revision.
206
The revision to print can either be specified by a specific
207
revision identifier, or you can use --revision.
211
takes_args = ['revision_id?']
212
takes_options = ['revision']
213
# cat-revision is more for frontends so should be exact
217
def run(self, revision_id=None, revision=None):
218
if revision_id is not None and revision is not None:
219
raise errors.BzrCommandError('You can only supply one of'
220
' revision_id or --revision')
221
if revision_id is None and revision is None:
222
raise errors.BzrCommandError('You must supply either'
223
' --revision or a revision_id')
224
b = WorkingTree.open_containing(u'.')[0].branch
226
# TODO: jam 20060112 should cat-revision always output utf-8?
227
if revision_id is not None:
228
revision_id = osutils.safe_revision_id(revision_id, warn=False)
230
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
231
except errors.NoSuchRevision:
232
msg = "The repository %s contains no revision %s." % (b.repository.base,
234
raise errors.BzrCommandError(msg)
235
elif revision is not None:
238
raise errors.BzrCommandError('You cannot specify a NULL'
240
rev_id = rev.as_revision_id(b)
241
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
244
class cmd_remove_tree(Command):
245
"""Remove the working tree from a given branch/checkout.
247
Since a lightweight checkout is little more than a working tree
248
this will refuse to run against one.
250
To re-create the working tree, use "bzr checkout".
252
_see_also = ['checkout', 'working-trees']
253
takes_args = ['location?']
256
help='Remove the working tree even if it has '
257
'uncommitted changes.'),
260
def run(self, location='.', force=False):
261
d = bzrdir.BzrDir.open(location)
264
working = d.open_workingtree()
265
except errors.NoWorkingTree:
266
raise errors.BzrCommandError("No working tree to remove")
267
except errors.NotLocalUrl:
268
raise errors.BzrCommandError("You cannot remove the working tree of a "
271
changes = working.changes_from(working.basis_tree())
272
if changes.has_changed():
273
raise errors.UncommittedChanges(working)
275
working_path = working.bzrdir.root_transport.base
276
branch_path = working.branch.bzrdir.root_transport.base
277
if working_path != branch_path:
278
raise errors.BzrCommandError("You cannot remove the working tree from "
279
"a lightweight checkout")
281
d.destroy_workingtree()
284
class cmd_revno(Command):
285
"""Show current revision number.
287
This is equal to the number of revisions on this branch.
291
takes_args = ['location?']
294
def run(self, location=u'.'):
295
self.outf.write(str(Branch.open_containing(location)[0].revno()))
296
self.outf.write('\n')
299
class cmd_revision_info(Command):
300
"""Show revision number and revision id for a given revision identifier.
303
takes_args = ['revision_info*']
304
takes_options = ['revision']
307
def run(self, revision=None, revision_info_list=[]):
310
if revision is not None:
311
revs.extend(revision)
312
if revision_info_list is not None:
313
for rev in revision_info_list:
314
revs.append(RevisionSpec.from_string(rev))
316
b = Branch.open_containing(u'.')[0]
319
revs.append(RevisionSpec.from_string('-1'))
322
revision_id = rev.as_revision_id(b)
324
revno = '%4d' % (b.revision_id_to_revno(revision_id))
325
except errors.NoSuchRevision:
326
dotted_map = b.get_revision_id_to_revno_map()
327
revno = '.'.join(str(i) for i in dotted_map[revision_id])
328
print '%s %s' % (revno, revision_id)
331
class cmd_add(Command):
332
"""Add specified files or directories.
334
In non-recursive mode, all the named items are added, regardless
335
of whether they were previously ignored. A warning is given if
336
any of the named files are already versioned.
338
In recursive mode (the default), files are treated the same way
339
but the behaviour for directories is different. Directories that
340
are already versioned do not give a warning. All directories,
341
whether already versioned or not, are searched for files or
342
subdirectories that are neither versioned or ignored, and these
343
are added. This search proceeds recursively into versioned
344
directories. If no names are given '.' is assumed.
346
Therefore simply saying 'bzr add' will version all files that
347
are currently unknown.
349
Adding a file whose parent directory is not versioned will
350
implicitly add the parent, and so on up to the root. This means
351
you should never need to explicitly add a directory, they'll just
352
get added when you add a file in the directory.
354
--dry-run will show which files would be added, but not actually
357
--file-ids-from will try to use the file ids from the supplied path.
358
It looks up ids trying to find a matching parent directory with the
359
same filename, and then by pure path. This option is rarely needed
360
but can be useful when adding the same logical file into two
361
branches that will be merged later (without showing the two different
362
adds as a conflict). It is also useful when merging another project
363
into a subdirectory of this one.
365
takes_args = ['file*']
368
help="Don't recursively add the contents of directories."),
370
help="Show what would be done, but don't actually do anything."),
372
Option('file-ids-from',
374
help='Lookup file ids from this tree.'),
376
encoding_type = 'replace'
377
_see_also = ['remove']
379
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
384
if file_ids_from is not None:
386
base_tree, base_path = WorkingTree.open_containing(
388
except errors.NoWorkingTree:
389
base_branch, base_path = Branch.open_containing(
391
base_tree = base_branch.basis_tree()
393
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
394
to_file=self.outf, should_print=(not is_quiet()))
396
action = bzrlib.add.AddAction(to_file=self.outf,
397
should_print=(not is_quiet()))
400
base_tree.lock_read()
402
file_list = self._maybe_expand_globs(file_list)
404
tree = WorkingTree.open_containing(file_list[0])[0]
406
tree = WorkingTree.open_containing(u'.')[0]
407
added, ignored = tree.smart_add(file_list, not
408
no_recurse, action=action, save=not dry_run)
410
if base_tree is not None:
414
for glob in sorted(ignored.keys()):
415
for path in ignored[glob]:
416
self.outf.write("ignored %s matching \"%s\"\n"
420
for glob, paths in ignored.items():
421
match_len += len(paths)
422
self.outf.write("ignored %d file(s).\n" % match_len)
423
self.outf.write("If you wish to add some of these files,"
424
" please add them by name.\n")
427
class cmd_mkdir(Command):
428
"""Create a new versioned directory.
430
This is equivalent to creating the directory and then adding it.
433
takes_args = ['dir+']
434
encoding_type = 'replace'
436
def run(self, dir_list):
439
wt, dd = WorkingTree.open_containing(d)
441
self.outf.write('added %s\n' % d)
444
class cmd_relpath(Command):
445
"""Show path of a file relative to root"""
447
takes_args = ['filename']
451
def run(self, filename):
452
# TODO: jam 20050106 Can relpath return a munged path if
453
# sys.stdout encoding cannot represent it?
454
tree, relpath = WorkingTree.open_containing(filename)
455
self.outf.write(relpath)
456
self.outf.write('\n')
459
class cmd_inventory(Command):
460
"""Show inventory of the current working copy or a revision.
462
It is possible to limit the output to a particular entry
463
type using the --kind option. For example: --kind file.
465
It is also possible to restrict the list of files to a specific
466
set. For example: bzr inventory --show-ids this/file
475
help='List entries of a particular kind: file, directory, symlink.',
478
takes_args = ['file*']
481
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
482
if kind and kind not in ['file', 'directory', 'symlink']:
483
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
485
work_tree, file_list = tree_files(file_list)
486
work_tree.lock_read()
488
if revision is not None:
489
if len(revision) > 1:
490
raise errors.BzrCommandError(
491
'bzr inventory --revision takes exactly one revision'
493
revision_id = revision[0].as_revision_id(work_tree.branch)
494
tree = work_tree.branch.repository.revision_tree(revision_id)
496
extra_trees = [work_tree]
502
if file_list is not None:
503
file_ids = tree.paths2ids(file_list, trees=extra_trees,
504
require_versioned=True)
505
# find_ids_across_trees may include some paths that don't
507
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
508
for file_id in file_ids if file_id in tree)
510
entries = tree.inventory.entries()
513
if tree is not work_tree:
516
for path, entry in entries:
517
if kind and kind != entry.kind:
520
self.outf.write('%-50s %s\n' % (path, entry.file_id))
522
self.outf.write(path)
523
self.outf.write('\n')
526
class cmd_mv(Command):
527
"""Move or rename a file.
530
bzr mv OLDNAME NEWNAME
532
bzr mv SOURCE... DESTINATION
534
If the last argument is a versioned directory, all the other names
535
are moved into it. Otherwise, there must be exactly two arguments
536
and the file is changed to a new name.
538
If OLDNAME does not exist on the filesystem but is versioned and
539
NEWNAME does exist on the filesystem but is not versioned, mv
540
assumes that the file has been manually moved and only updates
541
its internal inventory to reflect that change.
542
The same is valid when moving many SOURCE files to a DESTINATION.
544
Files cannot be moved between branches.
547
takes_args = ['names*']
548
takes_options = [Option("after", help="Move only the bzr identifier"
549
" of the file, because the file has already been moved."),
551
aliases = ['move', 'rename']
552
encoding_type = 'replace'
554
def run(self, names_list, after=False):
555
if names_list is None:
558
if len(names_list) < 2:
559
raise errors.BzrCommandError("missing file argument")
560
tree, rel_names = tree_files(names_list)
563
self._run(tree, names_list, rel_names, after)
567
def _run(self, tree, names_list, rel_names, after):
568
into_existing = osutils.isdir(names_list[-1])
569
if into_existing and len(names_list) == 2:
571
# a. case-insensitive filesystem and change case of dir
572
# b. move directory after the fact (if the source used to be
573
# a directory, but now doesn't exist in the working tree
574
# and the target is an existing directory, just rename it)
575
if (not tree.case_sensitive
576
and rel_names[0].lower() == rel_names[1].lower()):
577
into_existing = False
580
from_id = tree.path2id(rel_names[0])
581
if (not osutils.lexists(names_list[0]) and
582
from_id and inv.get_file_kind(from_id) == "directory"):
583
into_existing = False
586
# move into existing directory
587
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
588
self.outf.write("%s => %s\n" % pair)
590
if len(names_list) != 2:
591
raise errors.BzrCommandError('to mv multiple files the'
592
' destination must be a versioned'
594
tree.rename_one(rel_names[0], rel_names[1], after=after)
595
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
598
class cmd_pull(Command):
599
"""Turn this branch into a mirror of another branch.
601
This command only works on branches that have not diverged. Branches are
602
considered diverged if the destination branch's most recent commit is one
603
that has not been merged (directly or indirectly) into the parent.
605
If branches have diverged, you can use 'bzr merge' to integrate the changes
606
from one into the other. Once one branch has merged, the other should
607
be able to pull it again.
609
If you want to forget your local changes and just update your branch to
610
match the remote one, use pull --overwrite.
612
If there is no default location set, the first pull will set it. After
613
that, you can omit the location to use the default. To change the
614
default, use --remember. The value will only be saved if the remote
615
location can be accessed.
617
Note: The location can be specified either in the form of a branch,
618
or in the form of a path to a file containing a merge directive generated
622
_see_also = ['push', 'update', 'status-flags']
623
takes_options = ['remember', 'overwrite', 'revision',
624
custom_help('verbose',
625
help='Show logs of pulled revisions.'),
627
help='Branch to pull into, '
628
'rather than the one containing the working directory.',
633
takes_args = ['location?']
634
encoding_type = 'replace'
636
def run(self, location=None, remember=False, overwrite=False,
637
revision=None, verbose=False,
639
# FIXME: too much stuff is in the command class
642
if directory is None:
645
tree_to = WorkingTree.open_containing(directory)[0]
646
branch_to = tree_to.branch
647
except errors.NoWorkingTree:
649
branch_to = Branch.open_containing(directory)[0]
651
possible_transports = []
652
if location is not None:
654
mergeable = bundle.read_mergeable_from_url(location,
655
possible_transports=possible_transports)
656
except errors.NotABundle:
659
stored_loc = branch_to.get_parent()
661
if stored_loc is None:
662
raise errors.BzrCommandError("No pull location known or"
665
display_url = urlutils.unescape_for_display(stored_loc,
668
self.outf.write("Using saved parent location: %s\n" % display_url)
669
location = stored_loc
671
if mergeable is not None:
672
if revision is not None:
673
raise errors.BzrCommandError(
674
'Cannot use -r with merge directives or bundles')
675
mergeable.install_revisions(branch_to.repository)
676
base_revision_id, revision_id, verified = \
677
mergeable.get_merge_request(branch_to.repository)
678
branch_from = branch_to
680
branch_from = Branch.open(location,
681
possible_transports=possible_transports)
683
if branch_to.get_parent() is None or remember:
684
branch_to.set_parent(branch_from.base)
686
if revision is not None:
687
if len(revision) == 1:
688
revision_id = revision[0].as_revision_id(branch_from)
690
raise errors.BzrCommandError(
691
'bzr pull --revision takes one value.')
693
branch_to.lock_write()
695
if tree_to is not None:
696
change_reporter = delta._ChangeReporter(
697
unversioned_filter=tree_to.is_ignored)
698
result = tree_to.pull(branch_from, overwrite, revision_id,
700
possible_transports=possible_transports)
702
result = branch_to.pull(branch_from, overwrite, revision_id)
704
result.report(self.outf)
705
if verbose and result.old_revid != result.new_revid:
707
branch_to.repository.iter_reverse_revision_history(
710
new_rh = branch_to.revision_history()
711
log.show_changed_revisions(branch_to, old_rh, new_rh,
717
class cmd_push(Command):
718
"""Update a mirror of this branch.
720
The target branch will not have its working tree populated because this
721
is both expensive, and is not supported on remote file systems.
723
Some smart servers or protocols *may* put the working tree in place in
726
This command only works on branches that have not diverged. Branches are
727
considered diverged if the destination branch's most recent commit is one
728
that has not been merged (directly or indirectly) by the source branch.
730
If branches have diverged, you can use 'bzr push --overwrite' to replace
731
the other branch completely, discarding its unmerged changes.
733
If you want to ensure you have the different changes in the other branch,
734
do a merge (see bzr help merge) from the other branch, and commit that.
735
After that you will be able to do a push without '--overwrite'.
737
If there is no default push location set, the first push will set it.
738
After that, you can omit the location to use the default. To change the
739
default, use --remember. The value will only be saved if the remote
740
location can be accessed.
743
_see_also = ['pull', 'update', 'working-trees']
744
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
745
Option('create-prefix',
746
help='Create the path leading up to the branch '
747
'if it does not already exist.'),
749
help='Branch to push from, '
750
'rather than the one containing the working directory.',
754
Option('use-existing-dir',
755
help='By default push will fail if the target'
756
' directory exists, but does not already'
757
' have a control directory. This flag will'
758
' allow push to proceed.'),
760
help='Create a stacked branch that references the public location '
761
'of the parent branch.'),
763
help='Create a stacked branch that refers to another branch '
764
'for the commit history. Only the work not present in the '
765
'referenced branch is included in the branch created.',
768
takes_args = ['location?']
769
encoding_type = 'replace'
771
def run(self, location=None, remember=False, overwrite=False,
772
create_prefix=False, verbose=False, revision=None,
773
use_existing_dir=False, directory=None, stacked_on=None,
775
from bzrlib.push import _show_push_branch
777
# Get the source branch and revision_id
778
if directory is None:
780
br_from = Branch.open_containing(directory)[0]
781
if revision is not None:
782
if len(revision) == 1:
783
revision_id = revision[0].in_history(br_from).rev_id
785
raise errors.BzrCommandError(
786
'bzr push --revision takes one value.')
788
revision_id = br_from.last_revision()
790
# Get the stacked_on branch, if any
791
if stacked_on is not None:
792
stacked_on = urlutils.normalize_url(stacked_on)
794
parent_url = br_from.get_parent()
796
parent = Branch.open(parent_url)
797
stacked_on = parent.get_public_branch()
799
# I considered excluding non-http url's here, thus forcing
800
# 'public' branches only, but that only works for some
801
# users, so it's best to just depend on the user spotting an
802
# error by the feedback given to them. RBC 20080227.
803
stacked_on = parent_url
805
raise errors.BzrCommandError(
806
"Could not determine branch to refer to.")
808
# Get the destination location
810
stored_loc = br_from.get_push_location()
811
if stored_loc is None:
812
raise errors.BzrCommandError(
813
"No push location known or specified.")
815
display_url = urlutils.unescape_for_display(stored_loc,
817
self.outf.write("Using saved push location: %s\n" % display_url)
818
location = stored_loc
820
_show_push_branch(br_from, revision_id, location, self.outf,
821
verbose=verbose, overwrite=overwrite, remember=remember,
822
stacked_on=stacked_on, create_prefix=create_prefix,
823
use_existing_dir=use_existing_dir)
826
class cmd_branch(Command):
827
"""Create a new copy of a branch.
829
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
830
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
831
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
832
is derived from the FROM_LOCATION by stripping a leading scheme or drive
833
identifier, if any. For example, "branch lp:foo-bar" will attempt to
836
To retrieve the branch as of a particular revision, supply the --revision
837
parameter, as in "branch foo/bar -r 5".
840
_see_also = ['checkout']
841
takes_args = ['from_location', 'to_location?']
842
takes_options = ['revision', Option('hardlink',
843
help='Hard-link working tree files where possible.'),
845
help='Create a stacked branch referring to the source branch. '
846
'The new branch will depend on the availability of the source '
847
'branch for all operations.'),
849
help='Do not use a shared repository, even if available.'),
851
aliases = ['get', 'clone']
853
def run(self, from_location, to_location=None, revision=None,
854
hardlink=False, stacked=False, standalone=False):
855
from bzrlib.tag import _merge_tags_if_possible
858
elif len(revision) > 1:
859
raise errors.BzrCommandError(
860
'bzr branch --revision takes exactly 1 revision value')
862
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
866
if len(revision) == 1 and revision[0] is not None:
867
revision_id = revision[0].as_revision_id(br_from)
869
# FIXME - wt.last_revision, fallback to branch, fall back to
870
# None or perhaps NULL_REVISION to mean copy nothing
872
revision_id = br_from.last_revision()
873
if to_location is None:
874
to_location = urlutils.derive_to_location(from_location)
875
to_transport = transport.get_transport(to_location)
877
to_transport.mkdir('.')
878
except errors.FileExists:
879
raise errors.BzrCommandError('Target directory "%s" already'
880
' exists.' % to_location)
881
except errors.NoSuchFile:
882
raise errors.BzrCommandError('Parent of "%s" does not exist.'
885
# preserve whatever source format we have.
886
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
887
possible_transports=[to_transport],
888
accelerator_tree=accelerator_tree,
889
hardlink=hardlink, stacked=stacked,
890
force_new_repo=standalone)
891
branch = dir.open_branch()
892
except errors.NoSuchRevision:
893
to_transport.delete_tree('.')
894
msg = "The branch %s has no revision %s." % (from_location,
896
raise errors.BzrCommandError(msg)
897
_merge_tags_if_possible(br_from, branch)
898
# If the source branch is stacked, the new branch may
899
# be stacked whether we asked for that explicitly or not.
900
# We therefore need a try/except here and not just 'if stacked:'
902
note('Created new stacked branch referring to %s.' %
903
branch.get_stacked_on_url())
904
except (errors.NotStacked, errors.UnstackableBranchFormat,
905
errors.UnstackableRepositoryFormat), e:
906
note('Branched %d revision(s).' % branch.revno())
911
class cmd_checkout(Command):
912
"""Create a new checkout of an existing branch.
914
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
915
the branch found in '.'. This is useful if you have removed the working tree
916
or if it was never created - i.e. if you pushed the branch to its current
919
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
920
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
921
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
922
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
923
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
926
To retrieve the branch as of a particular revision, supply the --revision
927
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
928
out of date [so you cannot commit] but it may be useful (i.e. to examine old
932
_see_also = ['checkouts', 'branch']
933
takes_args = ['branch_location?', 'to_location?']
934
takes_options = ['revision',
935
Option('lightweight',
936
help="Perform a lightweight checkout. Lightweight "
937
"checkouts depend on access to the branch for "
938
"every operation. Normal checkouts can perform "
939
"common operations like diff and status without "
940
"such access, and also support local commits."
942
Option('files-from', type=str,
943
help="Get file contents from this tree."),
945
help='Hard-link working tree files where possible.'
950
def run(self, branch_location=None, to_location=None, revision=None,
951
lightweight=False, files_from=None, hardlink=False):
954
elif len(revision) > 1:
955
raise errors.BzrCommandError(
956
'bzr checkout --revision takes exactly 1 revision value')
957
if branch_location is None:
958
branch_location = osutils.getcwd()
959
to_location = branch_location
960
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
962
if files_from is not None:
963
accelerator_tree = WorkingTree.open(files_from)
964
if len(revision) == 1 and revision[0] is not None:
965
revision_id = revision[0].as_revision_id(source)
968
if to_location is None:
969
to_location = urlutils.derive_to_location(branch_location)
970
# if the source and to_location are the same,
971
# and there is no working tree,
972
# then reconstitute a branch
973
if (osutils.abspath(to_location) ==
974
osutils.abspath(branch_location)):
976
source.bzrdir.open_workingtree()
977
except errors.NoWorkingTree:
978
source.bzrdir.create_workingtree(revision_id)
980
source.create_checkout(to_location, revision_id, lightweight,
981
accelerator_tree, hardlink)
984
class cmd_renames(Command):
985
"""Show list of renamed files.
987
# TODO: Option to show renames between two historical versions.
989
# TODO: Only show renames under dir, rather than in the whole branch.
990
_see_also = ['status']
991
takes_args = ['dir?']
994
def run(self, dir=u'.'):
995
tree = WorkingTree.open_containing(dir)[0]
998
new_inv = tree.inventory
999
old_tree = tree.basis_tree()
1000
old_tree.lock_read()
1002
old_inv = old_tree.inventory
1003
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1005
for old_name, new_name in renames:
1006
self.outf.write("%s => %s\n" % (old_name, new_name))
1013
class cmd_update(Command):
1014
"""Update a tree to have the latest code committed to its branch.
1016
This will perform a merge into the working tree, and may generate
1017
conflicts. If you have any local changes, you will still
1018
need to commit them after the update for the update to be complete.
1020
If you want to discard your local changes, you can just do a
1021
'bzr revert' instead of 'bzr commit' after the update.
1024
_see_also = ['pull', 'working-trees', 'status-flags']
1025
takes_args = ['dir?']
1028
def run(self, dir='.'):
1029
tree = WorkingTree.open_containing(dir)[0]
1030
possible_transports = []
1031
master = tree.branch.get_master_branch(
1032
possible_transports=possible_transports)
1033
if master is not None:
1036
tree.lock_tree_write()
1038
existing_pending_merges = tree.get_parent_ids()[1:]
1039
last_rev = _mod_revision.ensure_null(tree.last_revision())
1040
if last_rev == _mod_revision.ensure_null(
1041
tree.branch.last_revision()):
1042
# may be up to date, check master too.
1043
if master is None or last_rev == _mod_revision.ensure_null(
1044
master.last_revision()):
1045
revno = tree.branch.revision_id_to_revno(last_rev)
1046
note("Tree is up to date at revision %d." % (revno,))
1048
conflicts = tree.update(
1049
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1050
possible_transports=possible_transports)
1051
revno = tree.branch.revision_id_to_revno(
1052
_mod_revision.ensure_null(tree.last_revision()))
1053
note('Updated to revision %d.' % (revno,))
1054
if tree.get_parent_ids()[1:] != existing_pending_merges:
1055
note('Your local commits will now show as pending merges with '
1056
"'bzr status', and can be committed with 'bzr commit'.")
1065
class cmd_info(Command):
1066
"""Show information about a working tree, branch or repository.
1068
This command will show all known locations and formats associated to the
1069
tree, branch or repository. Statistical information is included with
1072
Branches and working trees will also report any missing revisions.
1074
_see_also = ['revno', 'working-trees', 'repositories']
1075
takes_args = ['location?']
1076
takes_options = ['verbose']
1077
encoding_type = 'replace'
1080
def run(self, location=None, verbose=False):
1085
from bzrlib.info import show_bzrdir_info
1086
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1087
verbose=noise_level, outfile=self.outf)
1090
class cmd_remove(Command):
1091
"""Remove files or directories.
1093
This makes bzr stop tracking changes to the specified files. bzr will delete
1094
them if they can easily be recovered using revert. If no options or
1095
parameters are given bzr will scan for files that are being tracked by bzr
1096
but missing in your tree and stop tracking them for you.
1098
takes_args = ['file*']
1099
takes_options = ['verbose',
1100
Option('new', help='Only remove files that have never been committed.'),
1101
RegistryOption.from_kwargs('file-deletion-strategy',
1102
'The file deletion mode to be used.',
1103
title='Deletion Strategy', value_switches=True, enum_switch=False,
1104
safe='Only delete files if they can be'
1105
' safely recovered (default).',
1106
keep="Don't delete any files.",
1107
force='Delete all the specified files, even if they can not be '
1108
'recovered and even if they are non-empty directories.')]
1109
aliases = ['rm', 'del']
1110
encoding_type = 'replace'
1112
def run(self, file_list, verbose=False, new=False,
1113
file_deletion_strategy='safe'):
1114
tree, file_list = tree_files(file_list)
1116
if file_list is not None:
1117
file_list = [f for f in file_list]
1121
# Heuristics should probably all move into tree.remove_smart or
1124
added = tree.changes_from(tree.basis_tree(),
1125
specific_files=file_list).added
1126
file_list = sorted([f[0] for f in added], reverse=True)
1127
if len(file_list) == 0:
1128
raise errors.BzrCommandError('No matching files.')
1129
elif file_list is None:
1130
# missing files show up in iter_changes(basis) as
1131
# versioned-with-no-kind.
1133
for change in tree.iter_changes(tree.basis_tree()):
1134
# Find paths in the working tree that have no kind:
1135
if change[1][1] is not None and change[6][1] is None:
1136
missing.append(change[1][1])
1137
file_list = sorted(missing, reverse=True)
1138
file_deletion_strategy = 'keep'
1139
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1140
keep_files=file_deletion_strategy=='keep',
1141
force=file_deletion_strategy=='force')
1146
class cmd_file_id(Command):
1147
"""Print file_id of a particular file or directory.
1149
The file_id is assigned when the file is first added and remains the
1150
same through all revisions where the file exists, even when it is
1155
_see_also = ['inventory', 'ls']
1156
takes_args = ['filename']
1159
def run(self, filename):
1160
tree, relpath = WorkingTree.open_containing(filename)
1161
i = tree.path2id(relpath)
1163
raise errors.NotVersionedError(filename)
1165
self.outf.write(i + '\n')
1168
class cmd_file_path(Command):
1169
"""Print path of file_ids to a file or directory.
1171
This prints one line for each directory down to the target,
1172
starting at the branch root.
1176
takes_args = ['filename']
1179
def run(self, filename):
1180
tree, relpath = WorkingTree.open_containing(filename)
1181
fid = tree.path2id(relpath)
1183
raise errors.NotVersionedError(filename)
1184
segments = osutils.splitpath(relpath)
1185
for pos in range(1, len(segments) + 1):
1186
path = osutils.joinpath(segments[:pos])
1187
self.outf.write("%s\n" % tree.path2id(path))
1190
class cmd_reconcile(Command):
1191
"""Reconcile bzr metadata in a branch.
1193
This can correct data mismatches that may have been caused by
1194
previous ghost operations or bzr upgrades. You should only
1195
need to run this command if 'bzr check' or a bzr developer
1196
advises you to run it.
1198
If a second branch is provided, cross-branch reconciliation is
1199
also attempted, which will check that data like the tree root
1200
id which was not present in very early bzr versions is represented
1201
correctly in both branches.
1203
At the same time it is run it may recompress data resulting in
1204
a potential saving in disk space or performance gain.
1206
The branch *MUST* be on a listable system such as local disk or sftp.
1209
_see_also = ['check']
1210
takes_args = ['branch?']
1212
def run(self, branch="."):
1213
from bzrlib.reconcile import reconcile
1214
dir = bzrdir.BzrDir.open(branch)
1218
class cmd_revision_history(Command):
1219
"""Display the list of revision ids on a branch."""
1222
takes_args = ['location?']
1227
def run(self, location="."):
1228
branch = Branch.open_containing(location)[0]
1229
for revid in branch.revision_history():
1230
self.outf.write(revid)
1231
self.outf.write('\n')
1234
class cmd_ancestry(Command):
1235
"""List all revisions merged into this branch."""
1237
_see_also = ['log', 'revision-history']
1238
takes_args = ['location?']
1243
def run(self, location="."):
1245
wt = WorkingTree.open_containing(location)[0]
1246
except errors.NoWorkingTree:
1247
b = Branch.open(location)
1248
last_revision = b.last_revision()
1251
last_revision = wt.last_revision()
1253
revision_ids = b.repository.get_ancestry(last_revision)
1255
for revision_id in revision_ids:
1256
self.outf.write(revision_id + '\n')
1259
class cmd_init(Command):
1260
"""Make a directory into a versioned branch.
1262
Use this to create an empty branch, or before importing an
1265
If there is a repository in a parent directory of the location, then
1266
the history of the branch will be stored in the repository. Otherwise
1267
init creates a standalone branch which carries its own history
1268
in the .bzr directory.
1270
If there is already a branch at the location but it has no working tree,
1271
the tree can be populated with 'bzr checkout'.
1273
Recipe for importing a tree of files::
1279
bzr commit -m "imported project"
1282
_see_also = ['init-repository', 'branch', 'checkout']
1283
takes_args = ['location?']
1285
Option('create-prefix',
1286
help='Create the path leading up to the branch '
1287
'if it does not already exist.'),
1288
RegistryOption('format',
1289
help='Specify a format for this branch. '
1290
'See "help formats".',
1291
registry=bzrdir.format_registry,
1292
converter=bzrdir.format_registry.make_bzrdir,
1293
value_switches=True,
1294
title="Branch Format",
1296
Option('append-revisions-only',
1297
help='Never change revnos or the existing log.'
1298
' Append revisions to it only.')
1300
def run(self, location=None, format=None, append_revisions_only=False,
1301
create_prefix=False):
1303
format = bzrdir.format_registry.make_bzrdir('default')
1304
if location is None:
1307
to_transport = transport.get_transport(location)
1309
# The path has to exist to initialize a
1310
# branch inside of it.
1311
# Just using os.mkdir, since I don't
1312
# believe that we want to create a bunch of
1313
# locations if the user supplies an extended path
1315
to_transport.ensure_base()
1316
except errors.NoSuchFile:
1317
if not create_prefix:
1318
raise errors.BzrCommandError("Parent directory of %s"
1320
"\nYou may supply --create-prefix to create all"
1321
" leading parent directories."
1323
_create_prefix(to_transport)
1326
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1327
except errors.NotBranchError:
1328
# really a NotBzrDir error...
1329
create_branch = bzrdir.BzrDir.create_branch_convenience
1330
branch = create_branch(to_transport.base, format=format,
1331
possible_transports=[to_transport])
1332
a_bzrdir = branch.bzrdir
1334
from bzrlib.transport.local import LocalTransport
1335
if a_bzrdir.has_branch():
1336
if (isinstance(to_transport, LocalTransport)
1337
and not a_bzrdir.has_workingtree()):
1338
raise errors.BranchExistsWithoutWorkingTree(location)
1339
raise errors.AlreadyBranchError(location)
1340
branch = a_bzrdir.create_branch()
1341
a_bzrdir.create_workingtree()
1342
if append_revisions_only:
1344
branch.set_append_revisions_only(True)
1345
except errors.UpgradeRequired:
1346
raise errors.BzrCommandError('This branch format cannot be set'
1347
' to append-revisions-only. Try --experimental-branch6')
1349
from bzrlib.info import show_bzrdir_info
1350
show_bzrdir_info(a_bzrdir, verbose=0, outfile=self.outf)
1353
class cmd_init_repository(Command):
1354
"""Create a shared repository to hold branches.
1356
New branches created under the repository directory will store their
1357
revisions in the repository, not in the branch directory.
1359
If the --no-trees option is used then the branches in the repository
1360
will not have working trees by default.
1363
Create a shared repositories holding just branches::
1365
bzr init-repo --no-trees repo
1368
Make a lightweight checkout elsewhere::
1370
bzr checkout --lightweight repo/trunk trunk-checkout
1375
_see_also = ['init', 'branch', 'checkout', 'repositories']
1376
takes_args = ["location"]
1377
takes_options = [RegistryOption('format',
1378
help='Specify a format for this repository. See'
1379
' "bzr help formats" for details.',
1380
registry=bzrdir.format_registry,
1381
converter=bzrdir.format_registry.make_bzrdir,
1382
value_switches=True, title='Repository format'),
1384
help='Branches in the repository will default to'
1385
' not having a working tree.'),
1387
aliases = ["init-repo"]
1389
def run(self, location, format=None, no_trees=False):
1391
format = bzrdir.format_registry.make_bzrdir('default')
1393
if location is None:
1396
to_transport = transport.get_transport(location)
1397
to_transport.ensure_base()
1399
newdir = format.initialize_on_transport(to_transport)
1400
repo = newdir.create_repository(shared=True)
1401
repo.set_make_working_trees(not no_trees)
1403
from bzrlib.info import show_bzrdir_info
1404
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1407
class cmd_diff(Command):
1408
"""Show differences in the working tree, between revisions or branches.
1410
If no arguments are given, all changes for the current tree are listed.
1411
If files are given, only the changes in those files are listed.
1412
Remote and multiple branches can be compared by using the --old and
1413
--new options. If not provided, the default for both is derived from
1414
the first argument, if any, or the current tree if no arguments are
1417
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1418
produces patches suitable for "patch -p1".
1422
2 - unrepresentable changes
1427
Shows the difference in the working tree versus the last commit::
1431
Difference between the working tree and revision 1::
1435
Difference between revision 2 and revision 1::
1439
Difference between revision 2 and revision 1 for branch xxx::
1443
Show just the differences for file NEWS::
1447
Show the differences in working tree xxx for file NEWS::
1451
Show the differences from branch xxx to this working tree:
1455
Show the differences between two branches for file NEWS::
1457
bzr diff --old xxx --new yyy NEWS
1459
Same as 'bzr diff' but prefix paths with old/ and new/::
1461
bzr diff --prefix old/:new/
1463
_see_also = ['status']
1464
takes_args = ['file*']
1466
Option('diff-options', type=str,
1467
help='Pass these options to the external diff program.'),
1468
Option('prefix', type=str,
1470
help='Set prefixes added to old and new filenames, as '
1471
'two values separated by a colon. (eg "old/:new/").'),
1473
help='Branch/tree to compare from.',
1477
help='Branch/tree to compare to.',
1483
help='Use this command to compare files.',
1487
aliases = ['di', 'dif']
1488
encoding_type = 'exact'
1491
def run(self, revision=None, file_list=None, diff_options=None,
1492
prefix=None, old=None, new=None, using=None):
1493
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1495
if (prefix is None) or (prefix == '0'):
1503
old_label, new_label = prefix.split(":")
1505
raise errors.BzrCommandError(
1506
'--prefix expects two values separated by a colon'
1507
' (eg "old/:new/")')
1509
if revision and len(revision) > 2:
1510
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1511
' one or two revision specifiers')
1513
old_tree, new_tree, specific_files, extra_trees = \
1514
_get_trees_to_diff(file_list, revision, old, new)
1515
return show_diff_trees(old_tree, new_tree, sys.stdout,
1516
specific_files=specific_files,
1517
external_diff_options=diff_options,
1518
old_label=old_label, new_label=new_label,
1519
extra_trees=extra_trees, using=using)
1522
class cmd_deleted(Command):
1523
"""List files deleted in the working tree.
1525
# TODO: Show files deleted since a previous revision, or
1526
# between two revisions.
1527
# TODO: Much more efficient way to do this: read in new
1528
# directories with readdir, rather than stating each one. Same
1529
# level of effort but possibly much less IO. (Or possibly not,
1530
# if the directories are very large...)
1531
_see_also = ['status', 'ls']
1532
takes_options = ['show-ids']
1535
def run(self, show_ids=False):
1536
tree = WorkingTree.open_containing(u'.')[0]
1539
old = tree.basis_tree()
1542
for path, ie in old.inventory.iter_entries():
1543
if not tree.has_id(ie.file_id):
1544
self.outf.write(path)
1546
self.outf.write(' ')
1547
self.outf.write(ie.file_id)
1548
self.outf.write('\n')
1555
class cmd_modified(Command):
1556
"""List files modified in working tree.
1560
_see_also = ['status', 'ls']
1563
help='Write an ascii NUL (\\0) separator '
1564
'between files rather than a newline.')
1568
def run(self, null=False):
1569
tree = WorkingTree.open_containing(u'.')[0]
1570
td = tree.changes_from(tree.basis_tree())
1571
for path, id, kind, text_modified, meta_modified in td.modified:
1573
self.outf.write(path + '\0')
1575
self.outf.write(osutils.quotefn(path) + '\n')
1578
class cmd_added(Command):
1579
"""List files added in working tree.
1583
_see_also = ['status', 'ls']
1586
help='Write an ascii NUL (\\0) separator '
1587
'between files rather than a newline.')
1591
def run(self, null=False):
1592
wt = WorkingTree.open_containing(u'.')[0]
1595
basis = wt.basis_tree()
1598
basis_inv = basis.inventory
1601
if file_id in basis_inv:
1603
if inv.is_root(file_id) and len(basis_inv) == 0:
1605
path = inv.id2path(file_id)
1606
if not os.access(osutils.abspath(path), os.F_OK):
1609
self.outf.write(path + '\0')
1611
self.outf.write(osutils.quotefn(path) + '\n')
1618
class cmd_root(Command):
1619
"""Show the tree root directory.
1621
The root is the nearest enclosing directory with a .bzr control
1624
takes_args = ['filename?']
1626
def run(self, filename=None):
1627
"""Print the branch root."""
1628
tree = WorkingTree.open_containing(filename)[0]
1629
self.outf.write(tree.basedir + '\n')
1632
def _parse_limit(limitstring):
1634
return int(limitstring)
1636
msg = "The limit argument must be an integer."
1637
raise errors.BzrCommandError(msg)
1640
class cmd_log(Command):
1641
"""Show log of a branch, file, or directory.
1643
By default show the log of the branch containing the working directory.
1645
To request a range of logs, you can use the command -r begin..end
1646
-r revision requests a specific revision, -r ..end or -r begin.. are
1650
Log the current branch::
1658
Log the last 10 revisions of a branch::
1660
bzr log -r -10.. http://server/branch
1663
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1665
takes_args = ['location?']
1668
help='Show from oldest to newest.'),
1671
help='Display timezone as local, original, or utc.'),
1672
custom_help('verbose',
1673
help='Show files changed in each revision.'),
1679
help='Show revisions whose message matches this '
1680
'regular expression.',
1684
help='Limit the output to the first N revisions.',
1688
encoding_type = 'replace'
1691
def run(self, location=None, timezone='original',
1699
from bzrlib.log import show_log
1700
direction = (forward and 'forward') or 'reverse'
1705
# find the file id to log:
1707
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1711
tree = b.basis_tree()
1712
file_id = tree.path2id(fp)
1714
raise errors.BzrCommandError(
1715
"Path does not have any revision history: %s" %
1719
# FIXME ? log the current subdir only RBC 20060203
1720
if revision is not None \
1721
and len(revision) > 0 and revision[0].get_branch():
1722
location = revision[0].get_branch()
1725
dir, relpath = bzrdir.BzrDir.open_containing(location)
1726
b = dir.open_branch()
1730
if revision is None:
1733
elif len(revision) == 1:
1734
rev1 = rev2 = revision[0].in_history(b)
1735
elif len(revision) == 2:
1736
if revision[1].get_branch() != revision[0].get_branch():
1737
# b is taken from revision[0].get_branch(), and
1738
# show_log will use its revision_history. Having
1739
# different branches will lead to weird behaviors.
1740
raise errors.BzrCommandError(
1741
"Log doesn't accept two revisions in different"
1743
rev1 = revision[0].in_history(b)
1744
rev2 = revision[1].in_history(b)
1746
raise errors.BzrCommandError(
1747
'bzr log --revision takes one or two values.')
1749
if log_format is None:
1750
log_format = log.log_formatter_registry.get_default(b)
1752
lf = log_format(show_ids=show_ids, to_file=self.outf,
1753
show_timezone=timezone)
1759
direction=direction,
1760
start_revision=rev1,
1768
def get_log_format(long=False, short=False, line=False, default='long'):
1769
log_format = default
1773
log_format = 'short'
1779
class cmd_touching_revisions(Command):
1780
"""Return revision-ids which affected a particular file.
1782
A more user-friendly interface is "bzr log FILE".
1786
takes_args = ["filename"]
1789
def run(self, filename):
1790
tree, relpath = WorkingTree.open_containing(filename)
1792
file_id = tree.path2id(relpath)
1793
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1794
self.outf.write("%6d %s\n" % (revno, what))
1797
class cmd_ls(Command):
1798
"""List files in a tree.
1801
_see_also = ['status', 'cat']
1802
takes_args = ['path?']
1803
# TODO: Take a revision or remote path and list that tree instead.
1807
Option('non-recursive',
1808
help='Don\'t recurse into subdirectories.'),
1810
help='Print paths relative to the root of the branch.'),
1811
Option('unknown', help='Print unknown files.'),
1812
Option('versioned', help='Print versioned files.',
1814
Option('ignored', help='Print ignored files.'),
1816
help='Write an ascii NUL (\\0) separator '
1817
'between files rather than a newline.'),
1819
help='List entries of a particular kind: file, directory, symlink.',
1824
def run(self, revision=None, verbose=False,
1825
non_recursive=False, from_root=False,
1826
unknown=False, versioned=False, ignored=False,
1827
null=False, kind=None, show_ids=False, path=None):
1829
if kind and kind not in ('file', 'directory', 'symlink'):
1830
raise errors.BzrCommandError('invalid kind specified')
1832
if verbose and null:
1833
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1834
all = not (unknown or versioned or ignored)
1836
selection = {'I':ignored, '?':unknown, 'V':versioned}
1843
raise errors.BzrCommandError('cannot specify both --from-root'
1847
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1853
if revision is not None:
1854
tree = branch.repository.revision_tree(
1855
revision[0].as_revision_id(branch))
1857
tree = branch.basis_tree()
1861
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1862
if fp.startswith(relpath):
1863
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1864
if non_recursive and '/' in fp:
1866
if not all and not selection[fc]:
1868
if kind is not None and fkind != kind:
1871
kindch = entry.kind_character()
1872
outstring = '%-8s %s%s' % (fc, fp, kindch)
1873
if show_ids and fid is not None:
1874
outstring = "%-50s %s" % (outstring, fid)
1875
self.outf.write(outstring + '\n')
1877
self.outf.write(fp + '\0')
1880
self.outf.write(fid)
1881
self.outf.write('\0')
1889
self.outf.write('%-50s %s\n' % (fp, my_id))
1891
self.outf.write(fp + '\n')
1896
class cmd_unknowns(Command):
1897
"""List unknown files.
1905
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1906
self.outf.write(osutils.quotefn(f) + '\n')
1909
class cmd_ignore(Command):
1910
"""Ignore specified files or patterns.
1912
See ``bzr help patterns`` for details on the syntax of patterns.
1914
To remove patterns from the ignore list, edit the .bzrignore file.
1915
After adding, editing or deleting that file either indirectly by
1916
using this command or directly by using an editor, be sure to commit
1919
Note: ignore patterns containing shell wildcards must be quoted from
1923
Ignore the top level Makefile::
1925
bzr ignore ./Makefile
1927
Ignore class files in all directories::
1929
bzr ignore "*.class"
1931
Ignore .o files under the lib directory::
1933
bzr ignore "lib/**/*.o"
1935
Ignore .o files under the lib directory::
1937
bzr ignore "RE:lib/.*\.o"
1939
Ignore everything but the "debian" toplevel directory::
1941
bzr ignore "RE:(?!debian/).*"
1944
_see_also = ['status', 'ignored', 'patterns']
1945
takes_args = ['name_pattern*']
1947
Option('old-default-rules',
1948
help='Write out the ignore rules bzr < 0.9 always used.')
1951
def run(self, name_pattern_list=None, old_default_rules=None):
1952
from bzrlib import ignores
1953
if old_default_rules is not None:
1954
# dump the rules and exit
1955
for pattern in ignores.OLD_DEFAULTS:
1958
if not name_pattern_list:
1959
raise errors.BzrCommandError("ignore requires at least one "
1960
"NAME_PATTERN or --old-default-rules")
1961
name_pattern_list = [globbing.normalize_pattern(p)
1962
for p in name_pattern_list]
1963
for name_pattern in name_pattern_list:
1964
if (name_pattern[0] == '/' or
1965
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1966
raise errors.BzrCommandError(
1967
"NAME_PATTERN should not be an absolute path")
1968
tree, relpath = WorkingTree.open_containing(u'.')
1969
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
1970
ignored = globbing.Globster(name_pattern_list)
1973
for entry in tree.list_files():
1977
if ignored.match(filename):
1978
matches.append(filename.encode('utf-8'))
1980
if len(matches) > 0:
1981
print "Warning: the following files are version controlled and" \
1982
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1985
class cmd_ignored(Command):
1986
"""List ignored files and the patterns that matched them.
1988
List all the ignored files and the ignore pattern that caused the file to
1991
Alternatively, to list just the files::
1996
encoding_type = 'replace'
1997
_see_also = ['ignore', 'ls']
2001
tree = WorkingTree.open_containing(u'.')[0]
2004
for path, file_class, kind, file_id, entry in tree.list_files():
2005
if file_class != 'I':
2007
## XXX: Slightly inefficient since this was already calculated
2008
pat = tree.is_ignored(path)
2009
self.outf.write('%-50s %s\n' % (path, pat))
2014
class cmd_lookup_revision(Command):
2015
"""Lookup the revision-id from a revision-number
2018
bzr lookup-revision 33
2021
takes_args = ['revno']
2024
def run(self, revno):
2028
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2030
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2033
class cmd_export(Command):
2034
"""Export current or past revision to a destination directory or archive.
2036
If no revision is specified this exports the last committed revision.
2038
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2039
given, try to find the format with the extension. If no extension
2040
is found exports to a directory (equivalent to --format=dir).
2042
If root is supplied, it will be used as the root directory inside
2043
container formats (tar, zip, etc). If it is not supplied it will default
2044
to the exported filename. The root option has no effect for 'dir' format.
2046
If branch is omitted then the branch containing the current working
2047
directory will be used.
2049
Note: Export of tree with non-ASCII filenames to zip is not supported.
2051
================= =========================
2052
Supported formats Autodetected by extension
2053
================= =========================
2056
tbz2 .tar.bz2, .tbz2
2059
================= =========================
2061
takes_args = ['dest', 'branch_or_subdir?']
2064
help="Type of file to export to.",
2069
help="Name of the root directory inside the exported file."),
2071
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2073
from bzrlib.export import export
2075
if branch_or_subdir is None:
2076
tree = WorkingTree.open_containing(u'.')[0]
2080
b, subdir = Branch.open_containing(branch_or_subdir)
2082
if revision is None:
2083
# should be tree.last_revision FIXME
2084
rev_id = b.last_revision()
2086
if len(revision) != 1:
2087
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2088
rev_id = revision[0].as_revision_id(b)
2089
t = b.repository.revision_tree(rev_id)
2091
export(t, dest, format, root, subdir)
2092
except errors.NoSuchExportFormat, e:
2093
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2096
class cmd_cat(Command):
2097
"""Write the contents of a file as of a given revision to standard output.
2099
If no revision is nominated, the last revision is used.
2101
Note: Take care to redirect standard output when using this command on a
2107
Option('name-from-revision', help='The path name in the old tree.'),
2110
takes_args = ['filename']
2111
encoding_type = 'exact'
2114
def run(self, filename, revision=None, name_from_revision=False):
2115
if revision is not None and len(revision) != 1:
2116
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2117
" one revision specifier")
2118
tree, branch, relpath = \
2119
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2122
return self._run(tree, branch, relpath, filename, revision,
2127
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2129
tree = b.basis_tree()
2130
if revision is None:
2131
revision_id = b.last_revision()
2133
revision_id = revision[0].as_revision_id(b)
2135
cur_file_id = tree.path2id(relpath)
2136
rev_tree = b.repository.revision_tree(revision_id)
2137
old_file_id = rev_tree.path2id(relpath)
2139
if name_from_revision:
2140
if old_file_id is None:
2141
raise errors.BzrCommandError("%r is not present in revision %s"
2142
% (filename, revision_id))
2144
content = rev_tree.get_file_text(old_file_id)
2145
elif cur_file_id is not None:
2146
content = rev_tree.get_file_text(cur_file_id)
2147
elif old_file_id is not None:
2148
content = rev_tree.get_file_text(old_file_id)
2150
raise errors.BzrCommandError("%r is not present in revision %s" %
2151
(filename, revision_id))
2152
self.outf.write(content)
2155
class cmd_local_time_offset(Command):
2156
"""Show the offset in seconds from GMT to local time."""
2160
print osutils.local_time_offset()
2164
class cmd_commit(Command):
2165
"""Commit changes into a new revision.
2167
If no arguments are given, the entire tree is committed.
2169
If selected files are specified, only changes to those files are
2170
committed. If a directory is specified then the directory and everything
2171
within it is committed.
2173
When excludes are given, they take precedence over selected files.
2174
For example, too commit only changes within foo, but not changes within
2177
bzr commit foo -x foo/bar
2179
If author of the change is not the same person as the committer, you can
2180
specify the author's name using the --author option. The name should be
2181
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2183
A selected-file commit may fail in some cases where the committed
2184
tree would be invalid. Consider::
2189
bzr commit foo -m "committing foo"
2190
bzr mv foo/bar foo/baz
2193
bzr commit foo/bar -m "committing bar but not baz"
2195
In the example above, the last commit will fail by design. This gives
2196
the user the opportunity to decide whether they want to commit the
2197
rename at the same time, separately first, or not at all. (As a general
2198
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2200
Note: A selected-file commit after a merge is not yet supported.
2202
# TODO: Run hooks on tree to-be-committed, and after commit.
2204
# TODO: Strict commit that fails if there are deleted files.
2205
# (what does "deleted files" mean ??)
2207
# TODO: Give better message for -s, --summary, used by tla people
2209
# XXX: verbose currently does nothing
2211
_see_also = ['bugs', 'uncommit']
2212
takes_args = ['selected*']
2214
ListOption('exclude', type=str, short_name='x',
2215
help="Do not consider changes made to a given path."),
2216
Option('message', type=unicode,
2218
help="Description of the new revision."),
2221
help='Commit even if nothing has changed.'),
2222
Option('file', type=str,
2225
help='Take commit message from this file.'),
2227
help="Refuse to commit if there are unknown "
2228
"files in the working tree."),
2229
ListOption('fixes', type=str,
2230
help="Mark a bug as being fixed by this revision."),
2231
Option('author', type=unicode,
2232
help="Set the author's name, if it's different "
2233
"from the committer."),
2235
help="Perform a local commit in a bound "
2236
"branch. Local commits are not pushed to "
2237
"the master branch until a normal commit "
2241
help='When no message is supplied, show the diff along'
2242
' with the status summary in the message editor.'),
2244
aliases = ['ci', 'checkin']
2246
def _get_bug_fix_properties(self, fixes, branch):
2248
# Configure the properties for bug fixing attributes.
2249
for fixed_bug in fixes:
2250
tokens = fixed_bug.split(':')
2251
if len(tokens) != 2:
2252
raise errors.BzrCommandError(
2253
"Invalid bug %s. Must be in the form of 'tag:id'. "
2254
"Commit refused." % fixed_bug)
2255
tag, bug_id = tokens
2257
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2258
except errors.UnknownBugTrackerAbbreviation:
2259
raise errors.BzrCommandError(
2260
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2261
except errors.MalformedBugIdentifier:
2262
raise errors.BzrCommandError(
2263
"Invalid bug identifier for %s. Commit refused."
2265
properties.append('%s fixed' % bug_url)
2266
return '\n'.join(properties)
2268
def run(self, message=None, file=None, verbose=False, selected_list=None,
2269
unchanged=False, strict=False, local=False, fixes=None,
2270
author=None, show_diff=False, exclude=None):
2271
from bzrlib.errors import (
2276
from bzrlib.msgeditor import (
2277
edit_commit_message_encoded,
2278
make_commit_message_template_encoded
2281
# TODO: Need a blackbox test for invoking the external editor; may be
2282
# slightly problematic to run this cross-platform.
2284
# TODO: do more checks that the commit will succeed before
2285
# spending the user's valuable time typing a commit message.
2289
tree, selected_list = tree_files(selected_list)
2290
if selected_list == ['']:
2291
# workaround - commit of root of tree should be exactly the same
2292
# as just default commit in that tree, and succeed even though
2293
# selected-file merge commit is not done yet
2298
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2300
properties['bugs'] = bug_property
2302
if local and not tree.branch.get_bound_location():
2303
raise errors.LocalRequiresBoundBranch()
2305
def get_message(commit_obj):
2306
"""Callback to get commit message"""
2307
my_message = message
2308
if my_message is None and not file:
2309
t = make_commit_message_template_encoded(tree,
2310
selected_list, diff=show_diff,
2311
output_encoding=bzrlib.user_encoding)
2312
my_message = edit_commit_message_encoded(t)
2313
if my_message is None:
2314
raise errors.BzrCommandError("please specify a commit"
2315
" message with either --message or --file")
2316
elif my_message and file:
2317
raise errors.BzrCommandError(
2318
"please specify either --message or --file")
2320
my_message = codecs.open(file, 'rt',
2321
bzrlib.user_encoding).read()
2322
if my_message == "":
2323
raise errors.BzrCommandError("empty commit message specified")
2327
tree.commit(message_callback=get_message,
2328
specific_files=selected_list,
2329
allow_pointless=unchanged, strict=strict, local=local,
2330
reporter=None, verbose=verbose, revprops=properties,
2332
exclude=safe_relpath_files(tree, exclude))
2333
except PointlessCommit:
2334
# FIXME: This should really happen before the file is read in;
2335
# perhaps prepare the commit; get the message; then actually commit
2336
raise errors.BzrCommandError("no changes to commit."
2337
" use --unchanged to commit anyhow")
2338
except ConflictsInTree:
2339
raise errors.BzrCommandError('Conflicts detected in working '
2340
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2342
except StrictCommitFailed:
2343
raise errors.BzrCommandError("Commit refused because there are"
2344
" unknown files in the working tree.")
2345
except errors.BoundBranchOutOfDate, e:
2346
raise errors.BzrCommandError(str(e) + "\n"
2347
'To commit to master branch, run update and then commit.\n'
2348
'You can also pass --local to commit to continue working '
2352
class cmd_check(Command):
2353
"""Validate working tree structure, branch consistency and repository history.
2355
This command checks various invariants about branch and repository storage
2356
to detect data corruption or bzr bugs.
2358
The working tree and branch checks will only give output if a problem is
2359
detected. The output fields of the repository check are:
2361
revisions: This is just the number of revisions checked. It doesn't
2363
versionedfiles: This is just the number of versionedfiles checked. It
2364
doesn't indicate a problem.
2365
unreferenced ancestors: Texts that are ancestors of other texts, but
2366
are not properly referenced by the revision ancestry. This is a
2367
subtle problem that Bazaar can work around.
2368
unique file texts: This is the total number of unique file contents
2369
seen in the checked revisions. It does not indicate a problem.
2370
repeated file texts: This is the total number of repeated texts seen
2371
in the checked revisions. Texts can be repeated when their file
2372
entries are modified, but the file contents are not. It does not
2375
If no restrictions are specified, all Bazaar data that is found at the given
2376
location will be checked.
2380
Check the tree and branch at 'foo'::
2382
bzr check --tree --branch foo
2384
Check only the repository at 'bar'::
2386
bzr check --repo bar
2388
Check everything at 'baz'::
2393
_see_also = ['reconcile']
2394
takes_args = ['path?']
2395
takes_options = ['verbose',
2396
Option('branch', help="Check the branch related to the"
2397
" current directory."),
2398
Option('repo', help="Check the repository related to the"
2399
" current directory."),
2400
Option('tree', help="Check the working tree related to"
2401
" the current directory.")]
2403
def run(self, path=None, verbose=False, branch=False, repo=False,
2405
from bzrlib.check import check_dwim
2408
if not branch and not repo and not tree:
2409
branch = repo = tree = True
2410
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2413
class cmd_upgrade(Command):
2414
"""Upgrade branch storage to current format.
2416
The check command or bzr developers may sometimes advise you to run
2417
this command. When the default format has changed you may also be warned
2418
during other operations to upgrade.
2421
_see_also = ['check']
2422
takes_args = ['url?']
2424
RegistryOption('format',
2425
help='Upgrade to a specific format. See "bzr help'
2426
' formats" for details.',
2427
registry=bzrdir.format_registry,
2428
converter=bzrdir.format_registry.make_bzrdir,
2429
value_switches=True, title='Branch format'),
2432
def run(self, url='.', format=None):
2433
from bzrlib.upgrade import upgrade
2435
format = bzrdir.format_registry.make_bzrdir('default')
2436
upgrade(url, format)
2439
class cmd_whoami(Command):
2440
"""Show or set bzr user id.
2443
Show the email of the current user::
2447
Set the current user::
2449
bzr whoami "Frank Chu <fchu@example.com>"
2451
takes_options = [ Option('email',
2452
help='Display email address only.'),
2454
help='Set identity for the current branch instead of '
2457
takes_args = ['name?']
2458
encoding_type = 'replace'
2461
def run(self, email=False, branch=False, name=None):
2463
# use branch if we're inside one; otherwise global config
2465
c = Branch.open_containing('.')[0].get_config()
2466
except errors.NotBranchError:
2467
c = config.GlobalConfig()
2469
self.outf.write(c.user_email() + '\n')
2471
self.outf.write(c.username() + '\n')
2474
# display a warning if an email address isn't included in the given name.
2476
config.extract_email_address(name)
2477
except errors.NoEmailInUsername, e:
2478
warning('"%s" does not seem to contain an email address. '
2479
'This is allowed, but not recommended.', name)
2481
# use global config unless --branch given
2483
c = Branch.open_containing('.')[0].get_config()
2485
c = config.GlobalConfig()
2486
c.set_user_option('email', name)
2489
class cmd_nick(Command):
2490
"""Print or set the branch nickname.
2492
If unset, the tree root directory name is used as the nickname
2493
To print the current nickname, execute with no argument.
2496
_see_also = ['info']
2497
takes_args = ['nickname?']
2498
def run(self, nickname=None):
2499
branch = Branch.open_containing(u'.')[0]
2500
if nickname is None:
2501
self.printme(branch)
2503
branch.nick = nickname
2506
def printme(self, branch):
2510
class cmd_alias(Command):
2511
"""Set/unset and display aliases.
2514
Show the current aliases::
2518
Show the alias specified for 'll'::
2522
Set an alias for 'll'::
2524
bzr alias ll="log --line -r-10..-1"
2526
To remove an alias for 'll'::
2528
bzr alias --remove ll
2531
takes_args = ['name?']
2533
Option('remove', help='Remove the alias.'),
2536
def run(self, name=None, remove=False):
2538
self.remove_alias(name)
2540
self.print_aliases()
2542
equal_pos = name.find('=')
2544
self.print_alias(name)
2546
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2548
def remove_alias(self, alias_name):
2549
if alias_name is None:
2550
raise errors.BzrCommandError(
2551
'bzr alias --remove expects an alias to remove.')
2552
# If alias is not found, print something like:
2553
# unalias: foo: not found
2554
c = config.GlobalConfig()
2555
c.unset_alias(alias_name)
2558
def print_aliases(self):
2559
"""Print out the defined aliases in a similar format to bash."""
2560
aliases = config.GlobalConfig().get_aliases()
2561
for key, value in sorted(aliases.iteritems()):
2562
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2565
def print_alias(self, alias_name):
2566
from bzrlib.commands import get_alias
2567
alias = get_alias(alias_name)
2569
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2572
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2574
def set_alias(self, alias_name, alias_command):
2575
"""Save the alias in the global config."""
2576
c = config.GlobalConfig()
2577
c.set_alias(alias_name, alias_command)
2580
class cmd_selftest(Command):
2581
"""Run internal test suite.
2583
If arguments are given, they are regular expressions that say which tests
2584
should run. Tests matching any expression are run, and other tests are
2587
Alternatively if --first is given, matching tests are run first and then
2588
all other tests are run. This is useful if you have been working in a
2589
particular area, but want to make sure nothing else was broken.
2591
If --exclude is given, tests that match that regular expression are
2592
excluded, regardless of whether they match --first or not.
2594
To help catch accidential dependencies between tests, the --randomize
2595
option is useful. In most cases, the argument used is the word 'now'.
2596
Note that the seed used for the random number generator is displayed
2597
when this option is used. The seed can be explicitly passed as the
2598
argument to this option if required. This enables reproduction of the
2599
actual ordering used if and when an order sensitive problem is encountered.
2601
If --list-only is given, the tests that would be run are listed. This is
2602
useful when combined with --first, --exclude and/or --randomize to
2603
understand their impact. The test harness reports "Listed nn tests in ..."
2604
instead of "Ran nn tests in ..." when list mode is enabled.
2606
If the global option '--no-plugins' is given, plugins are not loaded
2607
before running the selftests. This has two effects: features provided or
2608
modified by plugins will not be tested, and tests provided by plugins will
2611
Tests that need working space on disk use a common temporary directory,
2612
typically inside $TMPDIR or /tmp.
2615
Run only tests relating to 'ignore'::
2619
Disable plugins and list tests as they're run::
2621
bzr --no-plugins selftest -v
2623
# NB: this is used from the class without creating an instance, which is
2624
# why it does not have a self parameter.
2625
def get_transport_type(typestring):
2626
"""Parse and return a transport specifier."""
2627
if typestring == "sftp":
2628
from bzrlib.transport.sftp import SFTPAbsoluteServer
2629
return SFTPAbsoluteServer
2630
if typestring == "memory":
2631
from bzrlib.transport.memory import MemoryServer
2633
if typestring == "fakenfs":
2634
from bzrlib.transport.fakenfs import FakeNFSServer
2635
return FakeNFSServer
2636
msg = "No known transport type %s. Supported types are: sftp\n" %\
2638
raise errors.BzrCommandError(msg)
2641
takes_args = ['testspecs*']
2642
takes_options = ['verbose',
2644
help='Stop when one test fails.',
2648
help='Use a different transport by default '
2649
'throughout the test suite.',
2650
type=get_transport_type),
2652
help='Run the benchmarks rather than selftests.'),
2653
Option('lsprof-timed',
2654
help='Generate lsprof output for benchmarked'
2655
' sections of code.'),
2656
Option('cache-dir', type=str,
2657
help='Cache intermediate benchmark output in this '
2660
help='Run all tests, but run specified tests first.',
2664
help='List the tests instead of running them.'),
2665
Option('randomize', type=str, argname="SEED",
2666
help='Randomize the order of tests using the given'
2667
' seed or "now" for the current time.'),
2668
Option('exclude', type=str, argname="PATTERN",
2670
help='Exclude tests that match this regular'
2672
Option('strict', help='Fail on missing dependencies or '
2674
Option('load-list', type=str, argname='TESTLISTFILE',
2675
help='Load a test id list from a text file.'),
2676
ListOption('debugflag', type=str, short_name='E',
2677
help='Turn on a selftest debug flag.'),
2678
ListOption('starting-with', type=str, argname='TESTID',
2679
param_name='starting_with', short_name='s',
2681
'Load only the tests starting with TESTID.'),
2683
encoding_type = 'replace'
2685
def run(self, testspecs_list=None, verbose=False, one=False,
2686
transport=None, benchmark=None,
2687
lsprof_timed=None, cache_dir=None,
2688
first=False, list_only=False,
2689
randomize=None, exclude=None, strict=False,
2690
load_list=None, debugflag=None, starting_with=None):
2692
from bzrlib.tests import selftest
2693
import bzrlib.benchmarks as benchmarks
2694
from bzrlib.benchmarks import tree_creator
2696
# Make deprecation warnings visible, unless -Werror is set
2697
symbol_versioning.activate_deprecation_warnings(override=False)
2699
if cache_dir is not None:
2700
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2702
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2703
print ' %s (%s python%s)' % (
2705
bzrlib.version_string,
2706
bzrlib._format_version_tuple(sys.version_info),
2709
if testspecs_list is not None:
2710
pattern = '|'.join(testspecs_list)
2714
test_suite_factory = benchmarks.test_suite
2715
# Unless user explicitly asks for quiet, be verbose in benchmarks
2716
verbose = not is_quiet()
2717
# TODO: should possibly lock the history file...
2718
benchfile = open(".perf_history", "at", buffering=1)
2720
test_suite_factory = None
2723
result = selftest(verbose=verbose,
2725
stop_on_failure=one,
2726
transport=transport,
2727
test_suite_factory=test_suite_factory,
2728
lsprof_timed=lsprof_timed,
2729
bench_history=benchfile,
2730
matching_tests_first=first,
2731
list_only=list_only,
2732
random_seed=randomize,
2733
exclude_pattern=exclude,
2735
load_list=load_list,
2736
debug_flags=debugflag,
2737
starting_with=starting_with,
2740
if benchfile is not None:
2743
note('tests passed')
2745
note('tests failed')
2746
return int(not result)
2749
class cmd_version(Command):
2750
"""Show version of bzr."""
2752
encoding_type = 'replace'
2754
Option("short", help="Print just the version number."),
2758
def run(self, short=False):
2759
from bzrlib.version import show_version
2761
self.outf.write(bzrlib.version_string + '\n')
2763
show_version(to_file=self.outf)
2766
class cmd_rocks(Command):
2767
"""Statement of optimism."""
2773
print "It sure does!"
2776
class cmd_find_merge_base(Command):
2777
"""Find and print a base revision for merging two branches."""
2778
# TODO: Options to specify revisions on either side, as if
2779
# merging only part of the history.
2780
takes_args = ['branch', 'other']
2784
def run(self, branch, other):
2785
from bzrlib.revision import ensure_null
2787
branch1 = Branch.open_containing(branch)[0]
2788
branch2 = Branch.open_containing(other)[0]
2793
last1 = ensure_null(branch1.last_revision())
2794
last2 = ensure_null(branch2.last_revision())
2796
graph = branch1.repository.get_graph(branch2.repository)
2797
base_rev_id = graph.find_unique_lca(last1, last2)
2799
print 'merge base is revision %s' % base_rev_id
2806
class cmd_merge(Command):
2807
"""Perform a three-way merge.
2809
The source of the merge can be specified either in the form of a branch,
2810
or in the form of a path to a file containing a merge directive generated
2811
with bzr send. If neither is specified, the default is the upstream branch
2812
or the branch most recently merged using --remember.
2814
When merging a branch, by default the tip will be merged. To pick a different
2815
revision, pass --revision. If you specify two values, the first will be used as
2816
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2817
available revisions, like this is commonly referred to as "cherrypicking".
2819
Revision numbers are always relative to the branch being merged.
2821
By default, bzr will try to merge in all new work from the other
2822
branch, automatically determining an appropriate base. If this
2823
fails, you may need to give an explicit base.
2825
Merge will do its best to combine the changes in two branches, but there
2826
are some kinds of problems only a human can fix. When it encounters those,
2827
it will mark a conflict. A conflict means that you need to fix something,
2828
before you should commit.
2830
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2832
If there is no default branch set, the first merge will set it. After
2833
that, you can omit the branch to use the default. To change the
2834
default, use --remember. The value will only be saved if the remote
2835
location can be accessed.
2837
The results of the merge are placed into the destination working
2838
directory, where they can be reviewed (with bzr diff), tested, and then
2839
committed to record the result of the merge.
2841
merge refuses to run if there are any uncommitted changes, unless
2845
To merge the latest revision from bzr.dev::
2847
bzr merge ../bzr.dev
2849
To merge changes up to and including revision 82 from bzr.dev::
2851
bzr merge -r 82 ../bzr.dev
2853
To merge the changes introduced by 82, without previous changes::
2855
bzr merge -r 81..82 ../bzr.dev
2857
To apply a merge directive contained in in /tmp/merge:
2859
bzr merge /tmp/merge
2862
encoding_type = 'exact'
2863
_see_also = ['update', 'remerge', 'status-flags']
2864
takes_args = ['location?']
2869
help='Merge even if the destination tree has uncommitted changes.'),
2873
Option('show-base', help="Show base revision text in "
2875
Option('uncommitted', help='Apply uncommitted changes'
2876
' from a working copy, instead of branch changes.'),
2877
Option('pull', help='If the destination is already'
2878
' completely merged into the source, pull from the'
2879
' source rather than merging. When this happens,'
2880
' you do not need to commit the result.'),
2882
help='Branch to merge into, '
2883
'rather than the one containing the working directory.',
2887
Option('preview', help='Instead of merging, show a diff of the merge.')
2890
def run(self, location=None, revision=None, force=False,
2891
merge_type=None, show_base=False, reprocess=False, remember=False,
2892
uncommitted=False, pull=False,
2896
if merge_type is None:
2897
merge_type = _mod_merge.Merge3Merger
2899
if directory is None: directory = u'.'
2900
possible_transports = []
2902
allow_pending = True
2903
verified = 'inapplicable'
2904
tree = WorkingTree.open_containing(directory)[0]
2905
change_reporter = delta._ChangeReporter(
2906
unversioned_filter=tree.is_ignored)
2909
pb = ui.ui_factory.nested_progress_bar()
2910
cleanups.append(pb.finished)
2912
cleanups.append(tree.unlock)
2913
if location is not None:
2915
mergeable = bundle.read_mergeable_from_url(location,
2916
possible_transports=possible_transports)
2917
except errors.NotABundle:
2921
raise errors.BzrCommandError('Cannot use --uncommitted'
2922
' with bundles or merge directives.')
2924
if revision is not None:
2925
raise errors.BzrCommandError(
2926
'Cannot use -r with merge directives or bundles')
2927
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2930
if merger is None and uncommitted:
2931
if revision is not None and len(revision) > 0:
2932
raise errors.BzrCommandError('Cannot use --uncommitted and'
2933
' --revision at the same time.')
2934
location = self._select_branch_location(tree, location)[0]
2935
other_tree, other_path = WorkingTree.open_containing(location)
2936
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2938
allow_pending = False
2939
if other_path != '':
2940
merger.interesting_files = [other_path]
2943
merger, allow_pending = self._get_merger_from_branch(tree,
2944
location, revision, remember, possible_transports, pb)
2946
merger.merge_type = merge_type
2947
merger.reprocess = reprocess
2948
merger.show_base = show_base
2949
self.sanity_check_merger(merger)
2950
if (merger.base_rev_id == merger.other_rev_id and
2951
merger.other_rev_id is not None):
2952
note('Nothing to do.')
2955
if merger.interesting_files is not None:
2956
raise errors.BzrCommandError('Cannot pull individual files')
2957
if (merger.base_rev_id == tree.last_revision()):
2958
result = tree.pull(merger.other_branch, False,
2959
merger.other_rev_id)
2960
result.report(self.outf)
2962
merger.check_basis(not force)
2964
return self._do_preview(merger)
2966
return self._do_merge(merger, change_reporter, allow_pending,
2969
for cleanup in reversed(cleanups):
2972
def _do_preview(self, merger):
2973
from bzrlib.diff import show_diff_trees
2974
tree_merger = merger.make_merger()
2975
tt = tree_merger.make_preview_transform()
2977
result_tree = tt.get_preview_tree()
2978
show_diff_trees(merger.this_tree, result_tree, self.outf,
2979
old_label='', new_label='')
2983
def _do_merge(self, merger, change_reporter, allow_pending, verified):
2984
merger.change_reporter = change_reporter
2985
conflict_count = merger.do_merge()
2987
merger.set_pending()
2988
if verified == 'failed':
2989
warning('Preview patch does not match changes')
2990
if conflict_count != 0:
2995
def sanity_check_merger(self, merger):
2996
if (merger.show_base and
2997
not merger.merge_type is _mod_merge.Merge3Merger):
2998
raise errors.BzrCommandError("Show-base is not supported for this"
2999
" merge type. %s" % merger.merge_type)
3000
if merger.reprocess and not merger.merge_type.supports_reprocess:
3001
raise errors.BzrCommandError("Conflict reduction is not supported"
3002
" for merge type %s." %
3004
if merger.reprocess and merger.show_base:
3005
raise errors.BzrCommandError("Cannot do conflict reduction and"
3008
def _get_merger_from_branch(self, tree, location, revision, remember,
3009
possible_transports, pb):
3010
"""Produce a merger from a location, assuming it refers to a branch."""
3011
from bzrlib.tag import _merge_tags_if_possible
3012
# find the branch locations
3013
other_loc, user_location = self._select_branch_location(tree, location,
3015
if revision is not None and len(revision) == 2:
3016
base_loc, _unused = self._select_branch_location(tree,
3017
location, revision, 0)
3019
base_loc = other_loc
3021
other_branch, other_path = Branch.open_containing(other_loc,
3022
possible_transports)
3023
if base_loc == other_loc:
3024
base_branch = other_branch
3026
base_branch, base_path = Branch.open_containing(base_loc,
3027
possible_transports)
3028
# Find the revision ids
3029
if revision is None or len(revision) < 1 or revision[-1] is None:
3030
other_revision_id = _mod_revision.ensure_null(
3031
other_branch.last_revision())
3033
other_revision_id = revision[-1].as_revision_id(other_branch)
3034
if (revision is not None and len(revision) == 2
3035
and revision[0] is not None):
3036
base_revision_id = revision[0].as_revision_id(base_branch)
3038
base_revision_id = None
3039
# Remember where we merge from
3040
if ((remember or tree.branch.get_submit_branch() is None) and
3041
user_location is not None):
3042
tree.branch.set_submit_branch(other_branch.base)
3043
_merge_tags_if_possible(other_branch, tree.branch)
3044
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3045
other_revision_id, base_revision_id, other_branch, base_branch)
3046
if other_path != '':
3047
allow_pending = False
3048
merger.interesting_files = [other_path]
3050
allow_pending = True
3051
return merger, allow_pending
3053
def _select_branch_location(self, tree, user_location, revision=None,
3055
"""Select a branch location, according to possible inputs.
3057
If provided, branches from ``revision`` are preferred. (Both
3058
``revision`` and ``index`` must be supplied.)
3060
Otherwise, the ``location`` parameter is used. If it is None, then the
3061
``submit`` or ``parent`` location is used, and a note is printed.
3063
:param tree: The working tree to select a branch for merging into
3064
:param location: The location entered by the user
3065
:param revision: The revision parameter to the command
3066
:param index: The index to use for the revision parameter. Negative
3067
indices are permitted.
3068
:return: (selected_location, user_location). The default location
3069
will be the user-entered location.
3071
if (revision is not None and index is not None
3072
and revision[index] is not None):
3073
branch = revision[index].get_branch()
3074
if branch is not None:
3075
return branch, branch
3076
if user_location is None:
3077
location = self._get_remembered(tree, 'Merging from')
3079
location = user_location
3080
return location, user_location
3082
def _get_remembered(self, tree, verb_string):
3083
"""Use tree.branch's parent if none was supplied.
3085
Report if the remembered location was used.
3087
stored_location = tree.branch.get_submit_branch()
3088
stored_location_type = "submit"
3089
if stored_location is None:
3090
stored_location = tree.branch.get_parent()
3091
stored_location_type = "parent"
3092
mutter("%s", stored_location)
3093
if stored_location is None:
3094
raise errors.BzrCommandError("No location specified or remembered")
3095
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3096
note(u"%s remembered %s location %s", verb_string,
3097
stored_location_type, display_url)
3098
return stored_location
3101
class cmd_remerge(Command):
3104
Use this if you want to try a different merge technique while resolving
3105
conflicts. Some merge techniques are better than others, and remerge
3106
lets you try different ones on different files.
3108
The options for remerge have the same meaning and defaults as the ones for
3109
merge. The difference is that remerge can (only) be run when there is a
3110
pending merge, and it lets you specify particular files.
3113
Re-do the merge of all conflicted files, and show the base text in
3114
conflict regions, in addition to the usual THIS and OTHER texts::
3116
bzr remerge --show-base
3118
Re-do the merge of "foobar", using the weave merge algorithm, with
3119
additional processing to reduce the size of conflict regions::
3121
bzr remerge --merge-type weave --reprocess foobar
3123
takes_args = ['file*']
3128
help="Show base revision text in conflicts."),
3131
def run(self, file_list=None, merge_type=None, show_base=False,
3133
if merge_type is None:
3134
merge_type = _mod_merge.Merge3Merger
3135
tree, file_list = tree_files(file_list)
3138
parents = tree.get_parent_ids()
3139
if len(parents) != 2:
3140
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3141
" merges. Not cherrypicking or"
3143
repository = tree.branch.repository
3144
interesting_ids = None
3146
conflicts = tree.conflicts()
3147
if file_list is not None:
3148
interesting_ids = set()
3149
for filename in file_list:
3150
file_id = tree.path2id(filename)
3152
raise errors.NotVersionedError(filename)
3153
interesting_ids.add(file_id)
3154
if tree.kind(file_id) != "directory":
3157
for name, ie in tree.inventory.iter_entries(file_id):
3158
interesting_ids.add(ie.file_id)
3159
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3161
# Remerge only supports resolving contents conflicts
3162
allowed_conflicts = ('text conflict', 'contents conflict')
3163
restore_files = [c.path for c in conflicts
3164
if c.typestring in allowed_conflicts]
3165
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3166
tree.set_conflicts(ConflictList(new_conflicts))
3167
if file_list is not None:
3168
restore_files = file_list
3169
for filename in restore_files:
3171
restore(tree.abspath(filename))
3172
except errors.NotConflicted:
3174
# Disable pending merges, because the file texts we are remerging
3175
# have not had those merges performed. If we use the wrong parents
3176
# list, we imply that the working tree text has seen and rejected
3177
# all the changes from the other tree, when in fact those changes
3178
# have not yet been seen.
3179
pb = ui.ui_factory.nested_progress_bar()
3180
tree.set_parent_ids(parents[:1])
3182
merger = _mod_merge.Merger.from_revision_ids(pb,
3184
merger.interesting_ids = interesting_ids
3185
merger.merge_type = merge_type
3186
merger.show_base = show_base
3187
merger.reprocess = reprocess
3188
conflicts = merger.do_merge()
3190
tree.set_parent_ids(parents)
3200
class cmd_revert(Command):
3201
"""Revert files to a previous revision.
3203
Giving a list of files will revert only those files. Otherwise, all files
3204
will be reverted. If the revision is not specified with '--revision', the
3205
last committed revision is used.
3207
To remove only some changes, without reverting to a prior version, use
3208
merge instead. For example, "merge . --revision -2..-3" will remove the
3209
changes introduced by -2, without affecting the changes introduced by -1.
3210
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3212
By default, any files that have been manually changed will be backed up
3213
first. (Files changed only by merge are not backed up.) Backup files have
3214
'.~#~' appended to their name, where # is a number.
3216
When you provide files, you can use their current pathname or the pathname
3217
from the target revision. So you can use revert to "undelete" a file by
3218
name. If you name a directory, all the contents of that directory will be
3221
Any files that have been newly added since that revision will be deleted,
3222
with a backup kept if appropriate. Directories containing unknown files
3223
will not be deleted.
3225
The working tree contains a list of pending merged revisions, which will
3226
be included as parents in the next commit. Normally, revert clears that
3227
list as well as reverting the files. If any files are specified, revert
3228
leaves the pending merge list alone and reverts only the files. Use "bzr
3229
revert ." in the tree root to revert all files but keep the merge record,
3230
and "bzr revert --forget-merges" to clear the pending merge list without
3231
reverting any files.
3234
_see_also = ['cat', 'export']
3237
Option('no-backup', "Do not save backups of reverted files."),
3238
Option('forget-merges',
3239
'Remove pending merge marker, without changing any files.'),
3241
takes_args = ['file*']
3243
def run(self, revision=None, no_backup=False, file_list=None,
3244
forget_merges=None):
3245
tree, file_list = tree_files(file_list)
3247
tree.set_parent_ids(tree.get_parent_ids()[:1])
3249
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3252
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3253
if revision is None:
3254
rev_id = tree.last_revision()
3255
elif len(revision) != 1:
3256
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3258
rev_id = revision[0].as_revision_id(tree.branch)
3259
pb = ui.ui_factory.nested_progress_bar()
3261
tree.revert(file_list,
3262
tree.branch.repository.revision_tree(rev_id),
3263
not no_backup, pb, report_changes=True)
3268
class cmd_assert_fail(Command):
3269
"""Test reporting of assertion failures"""
3270
# intended just for use in testing
3275
raise AssertionError("always fails")
3278
class cmd_help(Command):
3279
"""Show help on a command or other topic.
3282
_see_also = ['topics']
3284
Option('long', 'Show help on all commands.'),
3286
takes_args = ['topic?']
3287
aliases = ['?', '--help', '-?', '-h']
3290
def run(self, topic=None, long=False):
3292
if topic is None and long:
3294
bzrlib.help.help(topic)
3297
class cmd_shell_complete(Command):
3298
"""Show appropriate completions for context.
3300
For a list of all available commands, say 'bzr shell-complete'.
3302
takes_args = ['context?']
3307
def run(self, context=None):
3308
import shellcomplete
3309
shellcomplete.shellcomplete(context)
3312
class cmd_missing(Command):
3313
"""Show unmerged/unpulled revisions between two branches.
3315
OTHER_BRANCH may be local or remote.
3318
_see_also = ['merge', 'pull']
3319
takes_args = ['other_branch?']
3321
Option('reverse', 'Reverse the order of revisions.'),
3323
'Display changes in the local branch only.'),
3324
Option('this' , 'Same as --mine-only.'),
3325
Option('theirs-only',
3326
'Display changes in the remote branch only.'),
3327
Option('other', 'Same as --theirs-only.'),
3331
Option('include-merges', 'Show merged revisions.'),
3333
encoding_type = 'replace'
3336
def run(self, other_branch=None, reverse=False, mine_only=False,
3338
log_format=None, long=False, short=False, line=False,
3339
show_ids=False, verbose=False, this=False, other=False,
3340
include_merges=False):
3341
from bzrlib.missing import find_unmerged, iter_log_revisions
3347
# TODO: We should probably check that we don't have mine-only and
3348
# theirs-only set, but it gets complicated because we also have
3349
# this and other which could be used.
3356
local_branch = Branch.open_containing(u".")[0]
3357
parent = local_branch.get_parent()
3358
if other_branch is None:
3359
other_branch = parent
3360
if other_branch is None:
3361
raise errors.BzrCommandError("No peer location known"
3363
display_url = urlutils.unescape_for_display(parent,
3365
self.outf.write("Using saved parent location: "
3366
+ display_url + "\n")
3368
remote_branch = Branch.open(other_branch)
3369
if remote_branch.base == local_branch.base:
3370
remote_branch = local_branch
3371
local_branch.lock_read()
3373
remote_branch.lock_read()
3375
local_extra, remote_extra = find_unmerged(
3376
local_branch, remote_branch, restrict,
3377
backward=not reverse,
3378
include_merges=include_merges)
3380
if log_format is None:
3381
registry = log.log_formatter_registry
3382
log_format = registry.get_default(local_branch)
3383
lf = log_format(to_file=self.outf,
3385
show_timezone='original')
3388
if local_extra and not theirs_only:
3389
self.outf.write("You have %d extra revision(s):\n" %
3391
for revision in iter_log_revisions(local_extra,
3392
local_branch.repository,
3394
lf.log_revision(revision)
3395
printed_local = True
3398
printed_local = False
3400
if remote_extra and not mine_only:
3401
if printed_local is True:
3402
self.outf.write("\n\n\n")
3403
self.outf.write("You are missing %d revision(s):\n" %
3405
for revision in iter_log_revisions(remote_extra,
3406
remote_branch.repository,
3408
lf.log_revision(revision)
3411
if mine_only and not local_extra:
3412
# We checked local, and found nothing extra
3413
self.outf.write('This branch is up to date.\n')
3414
elif theirs_only and not remote_extra:
3415
# We checked remote, and found nothing extra
3416
self.outf.write('Other branch is up to date.\n')
3417
elif not (mine_only or theirs_only or local_extra or
3419
# We checked both branches, and neither one had extra
3421
self.outf.write("Branches are up to date.\n")
3423
remote_branch.unlock()
3425
local_branch.unlock()
3426
if not status_code and parent is None and other_branch is not None:
3427
local_branch.lock_write()
3429
# handle race conditions - a parent might be set while we run.
3430
if local_branch.get_parent() is None:
3431
local_branch.set_parent(remote_branch.base)
3433
local_branch.unlock()
3437
class cmd_pack(Command):
3438
"""Compress the data within a repository."""
3440
_see_also = ['repositories']
3441
takes_args = ['branch_or_repo?']
3443
def run(self, branch_or_repo='.'):
3444
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3446
branch = dir.open_branch()
3447
repository = branch.repository
3448
except errors.NotBranchError:
3449
repository = dir.open_repository()
3453
class cmd_plugins(Command):
3454
"""List the installed plugins.
3456
This command displays the list of installed plugins including
3457
version of plugin and a short description of each.
3459
--verbose shows the path where each plugin is located.
3461
A plugin is an external component for Bazaar that extends the
3462
revision control system, by adding or replacing code in Bazaar.
3463
Plugins can do a variety of things, including overriding commands,
3464
adding new commands, providing additional network transports and
3465
customizing log output.
3467
See the Bazaar web site, http://bazaar-vcs.org, for further
3468
information on plugins including where to find them and how to
3469
install them. Instructions are also provided there on how to
3470
write new plugins using the Python programming language.
3472
takes_options = ['verbose']
3475
def run(self, verbose=False):
3476
import bzrlib.plugin
3477
from inspect import getdoc
3479
for name, plugin in bzrlib.plugin.plugins().items():
3480
version = plugin.__version__
3481
if version == 'unknown':
3483
name_ver = '%s %s' % (name, version)
3484
d = getdoc(plugin.module)
3486
doc = d.split('\n')[0]
3488
doc = '(no description)'
3489
result.append((name_ver, doc, plugin.path()))
3490
for name_ver, doc, path in sorted(result):
3498
class cmd_testament(Command):
3499
"""Show testament (signing-form) of a revision."""
3502
Option('long', help='Produce long-format testament.'),
3504
help='Produce a strict-format testament.')]
3505
takes_args = ['branch?']
3507
def run(self, branch=u'.', revision=None, long=False, strict=False):
3508
from bzrlib.testament import Testament, StrictTestament
3510
testament_class = StrictTestament
3512
testament_class = Testament
3514
b = Branch.open_containing(branch)[0]
3516
b = Branch.open(branch)
3519
if revision is None:
3520
rev_id = b.last_revision()
3522
rev_id = revision[0].as_revision_id(b)
3523
t = testament_class.from_revision(b.repository, rev_id)
3525
sys.stdout.writelines(t.as_text_lines())
3527
sys.stdout.write(t.as_short_text())
3532
class cmd_annotate(Command):
3533
"""Show the origin of each line in a file.
3535
This prints out the given file with an annotation on the left side
3536
indicating which revision, author and date introduced the change.
3538
If the origin is the same for a run of consecutive lines, it is
3539
shown only at the top, unless the --all option is given.
3541
# TODO: annotate directories; showing when each file was last changed
3542
# TODO: if the working copy is modified, show annotations on that
3543
# with new uncommitted lines marked
3544
aliases = ['ann', 'blame', 'praise']
3545
takes_args = ['filename']
3546
takes_options = [Option('all', help='Show annotations on all lines.'),
3547
Option('long', help='Show commit date in annotations.'),
3551
encoding_type = 'exact'
3554
def run(self, filename, all=False, long=False, revision=None,
3556
from bzrlib.annotate import annotate_file, annotate_file_tree
3557
wt, branch, relpath = \
3558
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3564
if revision is None:
3565
revision_id = branch.last_revision()
3566
elif len(revision) != 1:
3567
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3569
revision_id = revision[0].as_revision_id(branch)
3570
tree = branch.repository.revision_tree(revision_id)
3572
file_id = wt.path2id(relpath)
3574
file_id = tree.path2id(relpath)
3576
raise errors.NotVersionedError(filename)
3577
file_version = tree.inventory[file_id].revision
3578
if wt is not None and revision is None:
3579
# If there is a tree and we're not annotating historical
3580
# versions, annotate the working tree's content.
3581
annotate_file_tree(wt, file_id, self.outf, long, all,
3584
annotate_file(branch, file_version, file_id, long, all, self.outf,
3593
class cmd_re_sign(Command):
3594
"""Create a digital signature for an existing revision."""
3595
# TODO be able to replace existing ones.
3597
hidden = True # is this right ?
3598
takes_args = ['revision_id*']
3599
takes_options = ['revision']
3601
def run(self, revision_id_list=None, revision=None):
3602
if revision_id_list is not None and revision is not None:
3603
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3604
if revision_id_list is None and revision is None:
3605
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3606
b = WorkingTree.open_containing(u'.')[0].branch
3609
return self._run(b, revision_id_list, revision)
3613
def _run(self, b, revision_id_list, revision):
3614
import bzrlib.gpg as gpg
3615
gpg_strategy = gpg.GPGStrategy(b.get_config())
3616
if revision_id_list is not None:
3617
b.repository.start_write_group()
3619
for revision_id in revision_id_list:
3620
b.repository.sign_revision(revision_id, gpg_strategy)
3622
b.repository.abort_write_group()
3625
b.repository.commit_write_group()
3626
elif revision is not None:
3627
if len(revision) == 1:
3628
revno, rev_id = revision[0].in_history(b)
3629
b.repository.start_write_group()
3631
b.repository.sign_revision(rev_id, gpg_strategy)
3633
b.repository.abort_write_group()
3636
b.repository.commit_write_group()
3637
elif len(revision) == 2:
3638
# are they both on rh- if so we can walk between them
3639
# might be nice to have a range helper for arbitrary
3640
# revision paths. hmm.
3641
from_revno, from_revid = revision[0].in_history(b)
3642
to_revno, to_revid = revision[1].in_history(b)
3643
if to_revid is None:
3644
to_revno = b.revno()
3645
if from_revno is None or to_revno is None:
3646
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3647
b.repository.start_write_group()
3649
for revno in range(from_revno, to_revno + 1):
3650
b.repository.sign_revision(b.get_rev_id(revno),
3653
b.repository.abort_write_group()
3656
b.repository.commit_write_group()
3658
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3661
class cmd_bind(Command):
3662
"""Convert the current branch into a checkout of the supplied branch.
3664
Once converted into a checkout, commits must succeed on the master branch
3665
before they will be applied to the local branch.
3668
_see_also = ['checkouts', 'unbind']
3669
takes_args = ['location?']
3672
def run(self, location=None):
3673
b, relpath = Branch.open_containing(u'.')
3674
if location is None:
3676
location = b.get_old_bound_location()
3677
except errors.UpgradeRequired:
3678
raise errors.BzrCommandError('No location supplied. '
3679
'This format does not remember old locations.')
3681
if location is None:
3682
raise errors.BzrCommandError('No location supplied and no '
3683
'previous location known')
3684
b_other = Branch.open(location)
3687
except errors.DivergedBranches:
3688
raise errors.BzrCommandError('These branches have diverged.'
3689
' Try merging, and then bind again.')
3692
class cmd_unbind(Command):
3693
"""Convert the current checkout into a regular branch.
3695
After unbinding, the local branch is considered independent and subsequent
3696
commits will be local only.
3699
_see_also = ['checkouts', 'bind']
3704
b, relpath = Branch.open_containing(u'.')
3706
raise errors.BzrCommandError('Local branch is not bound')
3709
class cmd_uncommit(Command):
3710
"""Remove the last committed revision.
3712
--verbose will print out what is being removed.
3713
--dry-run will go through all the motions, but not actually
3716
If --revision is specified, uncommit revisions to leave the branch at the
3717
specified revision. For example, "bzr uncommit -r 15" will leave the
3718
branch at revision 15.
3720
Uncommit leaves the working tree ready for a new commit. The only change
3721
it may make is to restore any pending merges that were present before
3725
# TODO: jam 20060108 Add an option to allow uncommit to remove
3726
# unreferenced information in 'branch-as-repository' branches.
3727
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3728
# information in shared branches as well.
3729
_see_also = ['commit']
3730
takes_options = ['verbose', 'revision',
3731
Option('dry-run', help='Don\'t actually make changes.'),
3732
Option('force', help='Say yes to all questions.'),
3734
help="Only remove the commits from the local branch"
3735
" when in a checkout."
3738
takes_args = ['location?']
3740
encoding_type = 'replace'
3742
def run(self, location=None,
3743
dry_run=False, verbose=False,
3744
revision=None, force=False, local=False):
3745
if location is None:
3747
control, relpath = bzrdir.BzrDir.open_containing(location)
3749
tree = control.open_workingtree()
3751
except (errors.NoWorkingTree, errors.NotLocalUrl):
3753
b = control.open_branch()
3755
if tree is not None:
3760
return self._run(b, tree, dry_run, verbose, revision, force,
3763
if tree is not None:
3768
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3769
from bzrlib.log import log_formatter, show_log
3770
from bzrlib.uncommit import uncommit
3772
last_revno, last_rev_id = b.last_revision_info()
3775
if revision is None:
3777
rev_id = last_rev_id
3779
# 'bzr uncommit -r 10' actually means uncommit
3780
# so that the final tree is at revno 10.
3781
# but bzrlib.uncommit.uncommit() actually uncommits
3782
# the revisions that are supplied.
3783
# So we need to offset it by one
3784
revno = revision[0].in_history(b).revno + 1
3785
if revno <= last_revno:
3786
rev_id = b.get_rev_id(revno)
3788
if rev_id is None or _mod_revision.is_null(rev_id):
3789
self.outf.write('No revisions to uncommit.\n')
3792
lf = log_formatter('short',
3794
show_timezone='original')
3799
direction='forward',
3800
start_revision=revno,
3801
end_revision=last_revno)
3804
print 'Dry-run, pretending to remove the above revisions.'
3806
val = raw_input('Press <enter> to continue')
3808
print 'The above revision(s) will be removed.'
3810
val = raw_input('Are you sure [y/N]? ')
3811
if val.lower() not in ('y', 'yes'):
3815
mutter('Uncommitting from {%s} to {%s}',
3816
last_rev_id, rev_id)
3817
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3818
revno=revno, local=local)
3819
note('You can restore the old tip by running:\n'
3820
' bzr pull . -r revid:%s', last_rev_id)
3823
class cmd_break_lock(Command):
3824
"""Break a dead lock on a repository, branch or working directory.
3826
CAUTION: Locks should only be broken when you are sure that the process
3827
holding the lock has been stopped.
3829
You can get information on what locks are open via the 'bzr info' command.
3834
takes_args = ['location?']
3836
def run(self, location=None, show=False):
3837
if location is None:
3839
control, relpath = bzrdir.BzrDir.open_containing(location)
3841
control.break_lock()
3842
except NotImplementedError:
3846
class cmd_wait_until_signalled(Command):
3847
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3849
This just prints a line to signal when it is ready, then blocks on stdin.
3855
sys.stdout.write("running\n")
3857
sys.stdin.readline()
3860
class cmd_serve(Command):
3861
"""Run the bzr server."""
3863
aliases = ['server']
3867
help='Serve on stdin/out for use from inetd or sshd.'),
3869
help='Listen for connections on nominated port of the form '
3870
'[hostname:]portnumber. Passing 0 as the port number will '
3871
'result in a dynamically allocated port. The default port is '
3875
help='Serve contents of this directory.',
3877
Option('allow-writes',
3878
help='By default the server is a readonly server. Supplying '
3879
'--allow-writes enables write access to the contents of '
3880
'the served directory and below.'
3884
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3885
from bzrlib import lockdir
3886
from bzrlib.smart import medium, server
3887
from bzrlib.transport import get_transport
3888
from bzrlib.transport.chroot import ChrootServer
3889
if directory is None:
3890
directory = os.getcwd()
3891
url = urlutils.local_path_to_url(directory)
3892
if not allow_writes:
3893
url = 'readonly+' + url
3894
chroot_server = ChrootServer(get_transport(url))
3895
chroot_server.setUp()
3896
t = get_transport(chroot_server.get_url())
3898
smart_server = medium.SmartServerPipeStreamMedium(
3899
sys.stdin, sys.stdout, t)
3901
host = medium.BZR_DEFAULT_INTERFACE
3903
port = medium.BZR_DEFAULT_PORT
3906
host, port = port.split(':')
3908
smart_server = server.SmartTCPServer(t, host=host, port=port)
3909
print 'listening on port: ', smart_server.port
3911
# for the duration of this server, no UI output is permitted.
3912
# note that this may cause problems with blackbox tests. This should
3913
# be changed with care though, as we dont want to use bandwidth sending
3914
# progress over stderr to smart server clients!
3915
old_factory = ui.ui_factory
3916
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3918
ui.ui_factory = ui.SilentUIFactory()
3919
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3920
smart_server.serve()
3922
ui.ui_factory = old_factory
3923
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3926
class cmd_join(Command):
3927
"""Combine a subtree into its containing tree.
3929
This command is for experimental use only. It requires the target tree
3930
to be in dirstate-with-subtree format, which cannot be converted into
3933
The TREE argument should be an independent tree, inside another tree, but
3934
not part of it. (Such trees can be produced by "bzr split", but also by
3935
running "bzr branch" with the target inside a tree.)
3937
The result is a combined tree, with the subtree no longer an independant
3938
part. This is marked as a merge of the subtree into the containing tree,
3939
and all history is preserved.
3941
If --reference is specified, the subtree retains its independence. It can
3942
be branched by itself, and can be part of multiple projects at the same
3943
time. But operations performed in the containing tree, such as commit
3944
and merge, will recurse into the subtree.
3947
_see_also = ['split']
3948
takes_args = ['tree']
3950
Option('reference', help='Join by reference.'),
3954
def run(self, tree, reference=False):
3955
sub_tree = WorkingTree.open(tree)
3956
parent_dir = osutils.dirname(sub_tree.basedir)
3957
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3958
repo = containing_tree.branch.repository
3959
if not repo.supports_rich_root():
3960
raise errors.BzrCommandError(
3961
"Can't join trees because %s doesn't support rich root data.\n"
3962
"You can use bzr upgrade on the repository."
3966
containing_tree.add_reference(sub_tree)
3967
except errors.BadReferenceTarget, e:
3968
# XXX: Would be better to just raise a nicely printable
3969
# exception from the real origin. Also below. mbp 20070306
3970
raise errors.BzrCommandError("Cannot join %s. %s" %
3974
containing_tree.subsume(sub_tree)
3975
except errors.BadSubsumeSource, e:
3976
raise errors.BzrCommandError("Cannot join %s. %s" %
3980
class cmd_split(Command):
3981
"""Split a subdirectory of a tree into a separate tree.
3983
This command will produce a target tree in a format that supports
3984
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
3985
converted into earlier formats like 'dirstate-tags'.
3987
The TREE argument should be a subdirectory of a working tree. That
3988
subdirectory will be converted into an independent tree, with its own
3989
branch. Commits in the top-level tree will not apply to the new subtree.
3992
# join is not un-hidden yet
3993
#_see_also = ['join']
3994
takes_args = ['tree']
3996
def run(self, tree):
3997
containing_tree, subdir = WorkingTree.open_containing(tree)
3998
sub_id = containing_tree.path2id(subdir)
4000
raise errors.NotVersionedError(subdir)
4002
containing_tree.extract(sub_id)
4003
except errors.RootNotRich:
4004
raise errors.UpgradeRequired(containing_tree.branch.base)
4007
class cmd_merge_directive(Command):
4008
"""Generate a merge directive for auto-merge tools.
4010
A directive requests a merge to be performed, and also provides all the
4011
information necessary to do so. This means it must either include a
4012
revision bundle, or the location of a branch containing the desired
4015
A submit branch (the location to merge into) must be supplied the first
4016
time the command is issued. After it has been supplied once, it will
4017
be remembered as the default.
4019
A public branch is optional if a revision bundle is supplied, but required
4020
if --diff or --plain is specified. It will be remembered as the default
4021
after the first use.
4024
takes_args = ['submit_branch?', 'public_branch?']
4028
_see_also = ['send']
4031
RegistryOption.from_kwargs('patch-type',
4032
'The type of patch to include in the directive.',
4034
value_switches=True,
4036
bundle='Bazaar revision bundle (default).',
4037
diff='Normal unified diff.',
4038
plain='No patch, just directive.'),
4039
Option('sign', help='GPG-sign the directive.'), 'revision',
4040
Option('mail-to', type=str,
4041
help='Instead of printing the directive, email to this address.'),
4042
Option('message', type=str, short_name='m',
4043
help='Message to use when committing this merge.')
4046
encoding_type = 'exact'
4048
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4049
sign=False, revision=None, mail_to=None, message=None):
4050
from bzrlib.revision import ensure_null, NULL_REVISION
4051
include_patch, include_bundle = {
4052
'plain': (False, False),
4053
'diff': (True, False),
4054
'bundle': (True, True),
4056
branch = Branch.open('.')
4057
stored_submit_branch = branch.get_submit_branch()
4058
if submit_branch is None:
4059
submit_branch = stored_submit_branch
4061
if stored_submit_branch is None:
4062
branch.set_submit_branch(submit_branch)
4063
if submit_branch is None:
4064
submit_branch = branch.get_parent()
4065
if submit_branch is None:
4066
raise errors.BzrCommandError('No submit branch specified or known')
4068
stored_public_branch = branch.get_public_branch()
4069
if public_branch is None:
4070
public_branch = stored_public_branch
4071
elif stored_public_branch is None:
4072
branch.set_public_branch(public_branch)
4073
if not include_bundle and public_branch is None:
4074
raise errors.BzrCommandError('No public branch specified or'
4076
base_revision_id = None
4077
if revision is not None:
4078
if len(revision) > 2:
4079
raise errors.BzrCommandError('bzr merge-directive takes '
4080
'at most two one revision identifiers')
4081
revision_id = revision[-1].as_revision_id(branch)
4082
if len(revision) == 2:
4083
base_revision_id = revision[0].as_revision_id(branch)
4085
revision_id = branch.last_revision()
4086
revision_id = ensure_null(revision_id)
4087
if revision_id == NULL_REVISION:
4088
raise errors.BzrCommandError('No revisions to bundle.')
4089
directive = merge_directive.MergeDirective2.from_objects(
4090
branch.repository, revision_id, time.time(),
4091
osutils.local_time_offset(), submit_branch,
4092
public_branch=public_branch, include_patch=include_patch,
4093
include_bundle=include_bundle, message=message,
4094
base_revision_id=base_revision_id)
4097
self.outf.write(directive.to_signed(branch))
4099
self.outf.writelines(directive.to_lines())
4101
message = directive.to_email(mail_to, branch, sign)
4102
s = SMTPConnection(branch.get_config())
4103
s.send_email(message)
4106
class cmd_send(Command):
4107
"""Mail or create a merge-directive for submiting changes.
4109
A merge directive provides many things needed for requesting merges:
4111
* A machine-readable description of the merge to perform
4113
* An optional patch that is a preview of the changes requested
4115
* An optional bundle of revision data, so that the changes can be applied
4116
directly from the merge directive, without retrieving data from a
4119
If --no-bundle is specified, then public_branch is needed (and must be
4120
up-to-date), so that the receiver can perform the merge using the
4121
public_branch. The public_branch is always included if known, so that
4122
people can check it later.
4124
The submit branch defaults to the parent, but can be overridden. Both
4125
submit branch and public branch will be remembered if supplied.
4127
If a public_branch is known for the submit_branch, that public submit
4128
branch is used in the merge instructions. This means that a local mirror
4129
can be used as your actual submit branch, once you have set public_branch
4132
Mail is sent using your preferred mail program. This should be transparent
4133
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4134
If the preferred client can't be found (or used), your editor will be used.
4136
To use a specific mail program, set the mail_client configuration option.
4137
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4138
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4139
generic options are "default", "editor", "emacsclient", "mapi", and
4140
"xdg-email". Plugins may also add supported clients.
4142
If mail is being sent, a to address is required. This can be supplied
4143
either on the commandline, by setting the submit_to configuration
4144
option in the branch itself or the child_submit_to configuration option
4145
in the submit branch.
4147
Two formats are currently supported: "4" uses revision bundle format 4 and
4148
merge directive format 2. It is significantly faster and smaller than
4149
older formats. It is compatible with Bazaar 0.19 and later. It is the
4150
default. "0.9" uses revision bundle format 0.9 and merge directive
4151
format 1. It is compatible with Bazaar 0.12 - 0.18.
4153
Merge directives are applied using the merge command or the pull command.
4156
encoding_type = 'exact'
4158
_see_also = ['merge', 'pull']
4160
takes_args = ['submit_branch?', 'public_branch?']
4164
help='Do not include a bundle in the merge directive.'),
4165
Option('no-patch', help='Do not include a preview patch in the merge'
4168
help='Remember submit and public branch.'),
4170
help='Branch to generate the submission from, '
4171
'rather than the one containing the working directory.',
4174
Option('output', short_name='o',
4175
help='Write merge directive to this file; '
4176
'use - for stdout.',
4178
Option('mail-to', help='Mail the request to this address.',
4182
RegistryOption.from_kwargs('format',
4183
'Use the specified output format.',
4184
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4185
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4188
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4189
no_patch=False, revision=None, remember=False, output=None,
4190
format='4', mail_to=None, message=None, **kwargs):
4191
return self._run(submit_branch, revision, public_branch, remember,
4192
format, no_bundle, no_patch, output,
4193
kwargs.get('from', '.'), mail_to, message)
4195
def _run(self, submit_branch, revision, public_branch, remember, format,
4196
no_bundle, no_patch, output, from_, mail_to, message):
4197
from bzrlib.revision import NULL_REVISION
4198
branch = Branch.open_containing(from_)[0]
4200
outfile = StringIO()
4204
outfile = open(output, 'wb')
4205
# we may need to write data into branch's repository to calculate
4210
config = branch.get_config()
4212
mail_to = config.get_user_option('submit_to')
4213
mail_client = config.get_mail_client()
4214
if remember and submit_branch is None:
4215
raise errors.BzrCommandError(
4216
'--remember requires a branch to be specified.')
4217
stored_submit_branch = branch.get_submit_branch()
4218
remembered_submit_branch = None
4219
if submit_branch is None:
4220
submit_branch = stored_submit_branch
4221
remembered_submit_branch = "submit"
4223
if stored_submit_branch is None or remember:
4224
branch.set_submit_branch(submit_branch)
4225
if submit_branch is None:
4226
submit_branch = branch.get_parent()
4227
remembered_submit_branch = "parent"
4228
if submit_branch is None:
4229
raise errors.BzrCommandError('No submit branch known or'
4231
if remembered_submit_branch is not None:
4232
note('Using saved %s location "%s" to determine what '
4233
'changes to submit.', remembered_submit_branch,
4237
submit_config = Branch.open(submit_branch).get_config()
4238
mail_to = submit_config.get_user_option("child_submit_to")
4240
stored_public_branch = branch.get_public_branch()
4241
if public_branch is None:
4242
public_branch = stored_public_branch
4243
elif stored_public_branch is None or remember:
4244
branch.set_public_branch(public_branch)
4245
if no_bundle and public_branch is None:
4246
raise errors.BzrCommandError('No public branch specified or'
4248
base_revision_id = None
4250
if revision is not None:
4251
if len(revision) > 2:
4252
raise errors.BzrCommandError('bzr send takes '
4253
'at most two one revision identifiers')
4254
revision_id = revision[-1].as_revision_id(branch)
4255
if len(revision) == 2:
4256
base_revision_id = revision[0].as_revision_id(branch)
4257
if revision_id is None:
4258
revision_id = branch.last_revision()
4259
if revision_id == NULL_REVISION:
4260
raise errors.BzrCommandError('No revisions to submit.')
4262
directive = merge_directive.MergeDirective2.from_objects(
4263
branch.repository, revision_id, time.time(),
4264
osutils.local_time_offset(), submit_branch,
4265
public_branch=public_branch, include_patch=not no_patch,
4266
include_bundle=not no_bundle, message=message,
4267
base_revision_id=base_revision_id)
4268
elif format == '0.9':
4271
patch_type = 'bundle'
4273
raise errors.BzrCommandError('Format 0.9 does not'
4274
' permit bundle with no patch')
4280
directive = merge_directive.MergeDirective.from_objects(
4281
branch.repository, revision_id, time.time(),
4282
osutils.local_time_offset(), submit_branch,
4283
public_branch=public_branch, patch_type=patch_type,
4286
outfile.writelines(directive.to_lines())
4288
subject = '[MERGE] '
4289
if message is not None:
4292
revision = branch.repository.get_revision(revision_id)
4293
subject += revision.get_summary()
4294
basename = directive.get_disk_name(branch)
4295
mail_client.compose_merge_request(mail_to, subject,
4296
outfile.getvalue(), basename)
4303
class cmd_bundle_revisions(cmd_send):
4305
"""Create a merge-directive for submiting changes.
4307
A merge directive provides many things needed for requesting merges:
4309
* A machine-readable description of the merge to perform
4311
* An optional patch that is a preview of the changes requested
4313
* An optional bundle of revision data, so that the changes can be applied
4314
directly from the merge directive, without retrieving data from a
4317
If --no-bundle is specified, then public_branch is needed (and must be
4318
up-to-date), so that the receiver can perform the merge using the
4319
public_branch. The public_branch is always included if known, so that
4320
people can check it later.
4322
The submit branch defaults to the parent, but can be overridden. Both
4323
submit branch and public branch will be remembered if supplied.
4325
If a public_branch is known for the submit_branch, that public submit
4326
branch is used in the merge instructions. This means that a local mirror
4327
can be used as your actual submit branch, once you have set public_branch
4330
Two formats are currently supported: "4" uses revision bundle format 4 and
4331
merge directive format 2. It is significantly faster and smaller than
4332
older formats. It is compatible with Bazaar 0.19 and later. It is the
4333
default. "0.9" uses revision bundle format 0.9 and merge directive
4334
format 1. It is compatible with Bazaar 0.12 - 0.18.
4339
help='Do not include a bundle in the merge directive.'),
4340
Option('no-patch', help='Do not include a preview patch in the merge'
4343
help='Remember submit and public branch.'),
4345
help='Branch to generate the submission from, '
4346
'rather than the one containing the working directory.',
4349
Option('output', short_name='o', help='Write directive to this file.',
4352
RegistryOption.from_kwargs('format',
4353
'Use the specified output format.',
4354
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4355
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4357
aliases = ['bundle']
4359
_see_also = ['send', 'merge']
4363
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4364
no_patch=False, revision=None, remember=False, output=None,
4365
format='4', **kwargs):
4368
return self._run(submit_branch, revision, public_branch, remember,
4369
format, no_bundle, no_patch, output,
4370
kwargs.get('from', '.'), None, None)
4373
class cmd_tag(Command):
4374
"""Create, remove or modify a tag naming a revision.
4376
Tags give human-meaningful names to revisions. Commands that take a -r
4377
(--revision) option can be given -rtag:X, where X is any previously
4380
Tags are stored in the branch. Tags are copied from one branch to another
4381
along when you branch, push, pull or merge.
4383
It is an error to give a tag name that already exists unless you pass
4384
--force, in which case the tag is moved to point to the new revision.
4386
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4387
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4390
_see_also = ['commit', 'tags']
4391
takes_args = ['tag_name']
4394
help='Delete this tag rather than placing it.',
4397
help='Branch in which to place the tag.',
4402
help='Replace existing tags.',
4407
def run(self, tag_name,
4413
branch, relpath = Branch.open_containing(directory)
4417
branch.tags.delete_tag(tag_name)
4418
self.outf.write('Deleted tag %s.\n' % tag_name)
4421
if len(revision) != 1:
4422
raise errors.BzrCommandError(
4423
"Tags can only be placed on a single revision, "
4425
revision_id = revision[0].as_revision_id(branch)
4427
revision_id = branch.last_revision()
4428
if (not force) and branch.tags.has_tag(tag_name):
4429
raise errors.TagAlreadyExists(tag_name)
4430
branch.tags.set_tag(tag_name, revision_id)
4431
self.outf.write('Created tag %s.\n' % tag_name)
4436
class cmd_tags(Command):
4439
This command shows a table of tag names and the revisions they reference.
4445
help='Branch whose tags should be displayed.',
4449
RegistryOption.from_kwargs('sort',
4450
'Sort tags by different criteria.', title='Sorting',
4451
alpha='Sort tags lexicographically (default).',
4452
time='Sort tags chronologically.',
4463
branch, relpath = Branch.open_containing(directory)
4464
tags = branch.tags.get_tag_dict().items()
4469
elif sort == 'time':
4471
for tag, revid in tags:
4473
revobj = branch.repository.get_revision(revid)
4474
except errors.NoSuchRevision:
4475
timestamp = sys.maxint # place them at the end
4477
timestamp = revobj.timestamp
4478
timestamps[revid] = timestamp
4479
tags.sort(key=lambda x: timestamps[x[1]])
4481
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4482
revno_map = branch.get_revision_id_to_revno_map()
4483
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4484
for tag, revid in tags ]
4485
for tag, revspec in tags:
4486
self.outf.write('%-20s %s\n' % (tag, revspec))
4489
class cmd_reconfigure(Command):
4490
"""Reconfigure the type of a bzr directory.
4492
A target configuration must be specified.
4494
For checkouts, the bind-to location will be auto-detected if not specified.
4495
The order of preference is
4496
1. For a lightweight checkout, the current bound location.
4497
2. For branches that used to be checkouts, the previously-bound location.
4498
3. The push location.
4499
4. The parent location.
4500
If none of these is available, --bind-to must be specified.
4503
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4504
takes_args = ['location?']
4505
takes_options = [RegistryOption.from_kwargs('target_type',
4506
title='Target type',
4507
help='The type to reconfigure the directory to.',
4508
value_switches=True, enum_switch=False,
4509
branch='Reconfigure to be an unbound branch '
4510
'with no working tree.',
4511
tree='Reconfigure to be an unbound branch '
4512
'with a working tree.',
4513
checkout='Reconfigure to be a bound branch '
4514
'with a working tree.',
4515
lightweight_checkout='Reconfigure to be a lightweight'
4516
' checkout (with no local history).',
4517
standalone='Reconfigure to be a standalone branch '
4518
'(i.e. stop using shared repository).',
4519
use_shared='Reconfigure to use a shared repository.'),
4520
Option('bind-to', help='Branch to bind checkout to.',
4523
help='Perform reconfiguration even if local changes'
4527
def run(self, location=None, target_type=None, bind_to=None, force=False):
4528
directory = bzrdir.BzrDir.open(location)
4529
if target_type is None:
4530
raise errors.BzrCommandError('No target configuration specified')
4531
elif target_type == 'branch':
4532
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4533
elif target_type == 'tree':
4534
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4535
elif target_type == 'checkout':
4536
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4538
elif target_type == 'lightweight-checkout':
4539
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4541
elif target_type == 'use-shared':
4542
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4543
elif target_type == 'standalone':
4544
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4545
reconfiguration.apply(force)
4548
class cmd_switch(Command):
4549
"""Set the branch of a checkout and update.
4551
For lightweight checkouts, this changes the branch being referenced.
4552
For heavyweight checkouts, this checks that there are no local commits
4553
versus the current bound branch, then it makes the local branch a mirror
4554
of the new location and binds to it.
4556
In both cases, the working tree is updated and uncommitted changes
4557
are merged. The user can commit or revert these as they desire.
4559
Pending merges need to be committed or reverted before using switch.
4561
The path to the branch to switch to can be specified relative to the parent
4562
directory of the current branch. For example, if you are currently in a
4563
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4567
takes_args = ['to_location']
4568
takes_options = [Option('force',
4569
help='Switch even if local commits will be lost.')
4572
def run(self, to_location, force=False):
4573
from bzrlib import switch
4575
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4577
to_branch = Branch.open(to_location)
4578
except errors.NotBranchError:
4579
this_branch = control_dir.open_branch()
4580
# This may be a heavy checkout, where we want the master branch
4581
this_url = this_branch.get_bound_location()
4582
# If not, use a local sibling
4583
if this_url is None:
4584
this_url = this_branch.base
4585
to_branch = Branch.open(
4586
urlutils.join(this_url, '..', to_location))
4587
switch.switch(control_dir, to_branch, force)
4588
note('Switched to branch: %s',
4589
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4592
class cmd_hooks(Command):
4593
"""Show a branch's currently registered hooks.
4597
takes_args = ['path?']
4599
def run(self, path=None):
4602
branch_hooks = Branch.open(path).hooks
4603
for hook_type in branch_hooks:
4604
hooks = branch_hooks[hook_type]
4605
self.outf.write("%s:\n" % (hook_type,))
4608
self.outf.write(" %s\n" %
4609
(branch_hooks.get_hook_name(hook),))
4611
self.outf.write(" <no hooks installed>\n")
4614
def _create_prefix(cur_transport):
4615
needed = [cur_transport]
4616
# Recurse upwards until we can create a directory successfully
4618
new_transport = cur_transport.clone('..')
4619
if new_transport.base == cur_transport.base:
4620
raise errors.BzrCommandError(
4621
"Failed to create path prefix for %s."
4622
% cur_transport.base)
4624
new_transport.mkdir('.')
4625
except errors.NoSuchFile:
4626
needed.append(new_transport)
4627
cur_transport = new_transport
4630
# Now we only need to create child directories
4632
cur_transport = needed.pop()
4633
cur_transport.ensure_base()
4636
# these get imported and then picked up by the scan for cmd_*
4637
# TODO: Some more consistent way to split command definitions across files;
4638
# we do need to load at least some information about them to know of
4639
# aliases. ideally we would avoid loading the implementation until the
4640
# details were needed.
4641
from bzrlib.cmd_version_info import cmd_version_info
4642
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4643
from bzrlib.bundle.commands import (
4646
from bzrlib.sign_my_commits import cmd_sign_my_commits
4647
from bzrlib.weave_commands import cmd_versionedfile_list, \
4648
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
