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']
254
takes_args = ['location?']
256
def run(self, location='.'):
257
d = bzrdir.BzrDir.open(location)
260
working = d.open_workingtree()
261
except errors.NoWorkingTree:
262
raise errors.BzrCommandError("No working tree to remove")
263
except errors.NotLocalUrl:
264
raise errors.BzrCommandError("You cannot remove the working tree of a "
267
working_path = working.bzrdir.root_transport.base
268
branch_path = working.branch.bzrdir.root_transport.base
269
if working_path != branch_path:
270
raise errors.BzrCommandError("You cannot remove the working tree from "
271
"a lightweight checkout")
273
d.destroy_workingtree()
276
class cmd_revno(Command):
277
"""Show current revision number.
279
This is equal to the number of revisions on this branch.
283
takes_args = ['location?']
286
def run(self, location=u'.'):
287
self.outf.write(str(Branch.open_containing(location)[0].revno()))
288
self.outf.write('\n')
291
class cmd_revision_info(Command):
292
"""Show revision number and revision id for a given revision identifier.
295
takes_args = ['revision_info*']
296
takes_options = ['revision']
299
def run(self, revision=None, revision_info_list=[]):
302
if revision is not None:
303
revs.extend(revision)
304
if revision_info_list is not None:
305
for rev in revision_info_list:
306
revs.append(RevisionSpec.from_string(rev))
308
b = Branch.open_containing(u'.')[0]
311
revs.append(RevisionSpec.from_string('-1'))
314
revision_id = rev.as_revision_id(b)
316
revno = '%4d' % (b.revision_id_to_revno(revision_id))
317
except errors.NoSuchRevision:
318
dotted_map = b.get_revision_id_to_revno_map()
319
revno = '.'.join(str(i) for i in dotted_map[revision_id])
320
print '%s %s' % (revno, revision_id)
323
class cmd_add(Command):
324
"""Add specified files or directories.
326
In non-recursive mode, all the named items are added, regardless
327
of whether they were previously ignored. A warning is given if
328
any of the named files are already versioned.
330
In recursive mode (the default), files are treated the same way
331
but the behaviour for directories is different. Directories that
332
are already versioned do not give a warning. All directories,
333
whether already versioned or not, are searched for files or
334
subdirectories that are neither versioned or ignored, and these
335
are added. This search proceeds recursively into versioned
336
directories. If no names are given '.' is assumed.
338
Therefore simply saying 'bzr add' will version all files that
339
are currently unknown.
341
Adding a file whose parent directory is not versioned will
342
implicitly add the parent, and so on up to the root. This means
343
you should never need to explicitly add a directory, they'll just
344
get added when you add a file in the directory.
346
--dry-run will show which files would be added, but not actually
349
--file-ids-from will try to use the file ids from the supplied path.
350
It looks up ids trying to find a matching parent directory with the
351
same filename, and then by pure path. This option is rarely needed
352
but can be useful when adding the same logical file into two
353
branches that will be merged later (without showing the two different
354
adds as a conflict). It is also useful when merging another project
355
into a subdirectory of this one.
357
takes_args = ['file*']
360
help="Don't recursively add the contents of directories."),
362
help="Show what would be done, but don't actually do anything."),
364
Option('file-ids-from',
366
help='Lookup file ids from this tree.'),
368
encoding_type = 'replace'
369
_see_also = ['remove']
371
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
376
if file_ids_from is not None:
378
base_tree, base_path = WorkingTree.open_containing(
380
except errors.NoWorkingTree:
381
base_branch, base_path = Branch.open_containing(
383
base_tree = base_branch.basis_tree()
385
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
386
to_file=self.outf, should_print=(not is_quiet()))
388
action = bzrlib.add.AddAction(to_file=self.outf,
389
should_print=(not is_quiet()))
392
base_tree.lock_read()
394
file_list = self._maybe_expand_globs(file_list)
396
tree = WorkingTree.open_containing(file_list[0])[0]
398
tree = WorkingTree.open_containing(u'.')[0]
399
added, ignored = tree.smart_add(file_list, not
400
no_recurse, action=action, save=not dry_run)
402
if base_tree is not None:
406
for glob in sorted(ignored.keys()):
407
for path in ignored[glob]:
408
self.outf.write("ignored %s matching \"%s\"\n"
412
for glob, paths in ignored.items():
413
match_len += len(paths)
414
self.outf.write("ignored %d file(s).\n" % match_len)
415
self.outf.write("If you wish to add some of these files,"
416
" please add them by name.\n")
419
class cmd_mkdir(Command):
420
"""Create a new versioned directory.
422
This is equivalent to creating the directory and then adding it.
425
takes_args = ['dir+']
426
encoding_type = 'replace'
428
def run(self, dir_list):
431
wt, dd = WorkingTree.open_containing(d)
433
self.outf.write('added %s\n' % d)
436
class cmd_relpath(Command):
437
"""Show path of a file relative to root"""
439
takes_args = ['filename']
443
def run(self, filename):
444
# TODO: jam 20050106 Can relpath return a munged path if
445
# sys.stdout encoding cannot represent it?
446
tree, relpath = WorkingTree.open_containing(filename)
447
self.outf.write(relpath)
448
self.outf.write('\n')
451
class cmd_inventory(Command):
452
"""Show inventory of the current working copy or a revision.
454
It is possible to limit the output to a particular entry
455
type using the --kind option. For example: --kind file.
457
It is also possible to restrict the list of files to a specific
458
set. For example: bzr inventory --show-ids this/file
467
help='List entries of a particular kind: file, directory, symlink.',
470
takes_args = ['file*']
473
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
474
if kind and kind not in ['file', 'directory', 'symlink']:
475
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
477
work_tree, file_list = tree_files(file_list)
478
work_tree.lock_read()
480
if revision is not None:
481
if len(revision) > 1:
482
raise errors.BzrCommandError(
483
'bzr inventory --revision takes exactly one revision'
485
revision_id = revision[0].as_revision_id(work_tree.branch)
486
tree = work_tree.branch.repository.revision_tree(revision_id)
488
extra_trees = [work_tree]
494
if file_list is not None:
495
file_ids = tree.paths2ids(file_list, trees=extra_trees,
496
require_versioned=True)
497
# find_ids_across_trees may include some paths that don't
499
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
500
for file_id in file_ids if file_id in tree)
502
entries = tree.inventory.entries()
505
if tree is not work_tree:
508
for path, entry in entries:
509
if kind and kind != entry.kind:
512
self.outf.write('%-50s %s\n' % (path, entry.file_id))
514
self.outf.write(path)
515
self.outf.write('\n')
518
class cmd_mv(Command):
519
"""Move or rename a file.
522
bzr mv OLDNAME NEWNAME
524
bzr mv SOURCE... DESTINATION
526
If the last argument is a versioned directory, all the other names
527
are moved into it. Otherwise, there must be exactly two arguments
528
and the file is changed to a new name.
530
If OLDNAME does not exist on the filesystem but is versioned and
531
NEWNAME does exist on the filesystem but is not versioned, mv
532
assumes that the file has been manually moved and only updates
533
its internal inventory to reflect that change.
534
The same is valid when moving many SOURCE files to a DESTINATION.
536
Files cannot be moved between branches.
539
takes_args = ['names*']
540
takes_options = [Option("after", help="Move only the bzr identifier"
541
" of the file, because the file has already been moved."),
543
aliases = ['move', 'rename']
544
encoding_type = 'replace'
546
def run(self, names_list, after=False):
547
if names_list is None:
550
if len(names_list) < 2:
551
raise errors.BzrCommandError("missing file argument")
552
tree, rel_names = tree_files(names_list)
555
self._run(tree, names_list, rel_names, after)
559
def _run(self, tree, names_list, rel_names, after):
560
into_existing = osutils.isdir(names_list[-1])
561
if into_existing and len(names_list) == 2:
563
# a. case-insensitive filesystem and change case of dir
564
# b. move directory after the fact (if the source used to be
565
# a directory, but now doesn't exist in the working tree
566
# and the target is an existing directory, just rename it)
567
if (not tree.case_sensitive
568
and rel_names[0].lower() == rel_names[1].lower()):
569
into_existing = False
572
from_id = tree.path2id(rel_names[0])
573
if (not osutils.lexists(names_list[0]) and
574
from_id and inv.get_file_kind(from_id) == "directory"):
575
into_existing = False
578
# move into existing directory
579
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
580
self.outf.write("%s => %s\n" % pair)
582
if len(names_list) != 2:
583
raise errors.BzrCommandError('to mv multiple files the'
584
' destination must be a versioned'
586
tree.rename_one(rel_names[0], rel_names[1], after=after)
587
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
590
class cmd_pull(Command):
591
"""Turn this branch into a mirror of another branch.
593
This command only works on branches that have not diverged. Branches are
594
considered diverged if the destination branch's most recent commit is one
595
that has not been merged (directly or indirectly) into the parent.
597
If branches have diverged, you can use 'bzr merge' to integrate the changes
598
from one into the other. Once one branch has merged, the other should
599
be able to pull it again.
601
If you want to forget your local changes and just update your branch to
602
match the remote one, use pull --overwrite.
604
If there is no default location set, the first pull will set it. After
605
that, you can omit the location to use the default. To change the
606
default, use --remember. The value will only be saved if the remote
607
location can be accessed.
609
Note: The location can be specified either in the form of a branch,
610
or in the form of a path to a file containing a merge directive generated
614
_see_also = ['push', 'update', 'status-flags']
615
takes_options = ['remember', 'overwrite', 'revision',
616
custom_help('verbose',
617
help='Show logs of pulled revisions.'),
619
help='Branch to pull into, '
620
'rather than the one containing the working directory.',
625
takes_args = ['location?']
626
encoding_type = 'replace'
628
def run(self, location=None, remember=False, overwrite=False,
629
revision=None, verbose=False,
631
# FIXME: too much stuff is in the command class
634
if directory is None:
637
tree_to = WorkingTree.open_containing(directory)[0]
638
branch_to = tree_to.branch
639
except errors.NoWorkingTree:
641
branch_to = Branch.open_containing(directory)[0]
643
possible_transports = []
644
if location is not None:
646
mergeable = bundle.read_mergeable_from_url(location,
647
possible_transports=possible_transports)
648
except errors.NotABundle:
651
stored_loc = branch_to.get_parent()
653
if stored_loc is None:
654
raise errors.BzrCommandError("No pull location known or"
657
display_url = urlutils.unescape_for_display(stored_loc,
660
self.outf.write("Using saved parent location: %s\n" % display_url)
661
location = stored_loc
663
if mergeable is not None:
664
if revision is not None:
665
raise errors.BzrCommandError(
666
'Cannot use -r with merge directives or bundles')
667
mergeable.install_revisions(branch_to.repository)
668
base_revision_id, revision_id, verified = \
669
mergeable.get_merge_request(branch_to.repository)
670
branch_from = branch_to
672
branch_from = Branch.open(location,
673
possible_transports=possible_transports)
675
if branch_to.get_parent() is None or remember:
676
branch_to.set_parent(branch_from.base)
678
if revision is not None:
679
if len(revision) == 1:
680
revision_id = revision[0].as_revision_id(branch_from)
682
raise errors.BzrCommandError(
683
'bzr pull --revision takes one value.')
685
branch_to.lock_write()
687
if tree_to is not None:
688
change_reporter = delta._ChangeReporter(
689
unversioned_filter=tree_to.is_ignored)
690
result = tree_to.pull(branch_from, overwrite, revision_id,
692
possible_transports=possible_transports)
694
result = branch_to.pull(branch_from, overwrite, revision_id)
696
result.report(self.outf)
697
if verbose and result.old_revid != result.new_revid:
699
branch_to.repository.iter_reverse_revision_history(
702
new_rh = branch_to.revision_history()
703
log.show_changed_revisions(branch_to, old_rh, new_rh,
709
class cmd_push(Command):
710
"""Update a mirror of this branch.
712
The target branch will not have its working tree populated because this
713
is both expensive, and is not supported on remote file systems.
715
Some smart servers or protocols *may* put the working tree in place in
718
This command only works on branches that have not diverged. Branches are
719
considered diverged if the destination branch's most recent commit is one
720
that has not been merged (directly or indirectly) by the source branch.
722
If branches have diverged, you can use 'bzr push --overwrite' to replace
723
the other branch completely, discarding its unmerged changes.
725
If you want to ensure you have the different changes in the other branch,
726
do a merge (see bzr help merge) from the other branch, and commit that.
727
After that you will be able to do a push without '--overwrite'.
729
If there is no default push location set, the first push will set it.
730
After that, you can omit the location to use the default. To change the
731
default, use --remember. The value will only be saved if the remote
732
location can be accessed.
735
_see_also = ['pull', 'update', 'working-trees']
736
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
737
Option('create-prefix',
738
help='Create the path leading up to the branch '
739
'if it does not already exist.'),
741
help='Branch to push from, '
742
'rather than the one containing the working directory.',
746
Option('use-existing-dir',
747
help='By default push will fail if the target'
748
' directory exists, but does not already'
749
' have a control directory. This flag will'
750
' allow push to proceed.'),
752
help='Create a stacked branch that references the public location '
753
'of the parent branch.'),
755
help='Create a stacked branch that refers to another branch '
756
'for the commit history. Only the work not present in the '
757
'referenced branch is included in the branch created.',
760
takes_args = ['location?']
761
encoding_type = 'replace'
763
def run(self, location=None, remember=False, overwrite=False,
764
create_prefix=False, verbose=False, revision=None,
765
use_existing_dir=False, directory=None, stacked_on=None,
767
from bzrlib.push import _show_push_branch
769
# Get the source branch and revision_id
770
if directory is None:
772
br_from = Branch.open_containing(directory)[0]
773
if revision is not None:
774
if len(revision) == 1:
775
revision_id = revision[0].in_history(br_from).rev_id
777
raise errors.BzrCommandError(
778
'bzr push --revision takes one value.')
780
revision_id = br_from.last_revision()
782
# Get the stacked_on branch, if any
783
if stacked_on is not None:
784
stacked_on = urlutils.normalize_url(stacked_on)
786
parent_url = br_from.get_parent()
788
parent = Branch.open(parent_url)
789
stacked_on = parent.get_public_branch()
791
# I considered excluding non-http url's here, thus forcing
792
# 'public' branches only, but that only works for some
793
# users, so it's best to just depend on the user spotting an
794
# error by the feedback given to them. RBC 20080227.
795
stacked_on = parent_url
797
raise errors.BzrCommandError(
798
"Could not determine branch to refer to.")
800
# Get the destination location
802
stored_loc = br_from.get_push_location()
803
if stored_loc is None:
804
raise errors.BzrCommandError(
805
"No push location known or specified.")
807
display_url = urlutils.unescape_for_display(stored_loc,
809
self.outf.write("Using saved push location: %s\n" % display_url)
810
location = stored_loc
812
_show_push_branch(br_from, revision_id, location, self.outf,
813
verbose=verbose, overwrite=overwrite, remember=remember,
814
stacked_on=stacked_on, create_prefix=create_prefix,
815
use_existing_dir=use_existing_dir)
818
class cmd_branch(Command):
819
"""Create a new copy of a branch.
821
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
822
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
823
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
824
is derived from the FROM_LOCATION by stripping a leading scheme or drive
825
identifier, if any. For example, "branch lp:foo-bar" will attempt to
828
To retrieve the branch as of a particular revision, supply the --revision
829
parameter, as in "branch foo/bar -r 5".
832
_see_also = ['checkout']
833
takes_args = ['from_location', 'to_location?']
834
takes_options = ['revision', Option('hardlink',
835
help='Hard-link working tree files where possible.'),
837
help='Create a stacked branch referring to the source branch. '
838
'The new branch will depend on the availability of the source '
839
'branch for all operations.'),
841
aliases = ['get', 'clone']
843
def run(self, from_location, to_location=None, revision=None,
844
hardlink=False, stacked=False):
845
from bzrlib.tag import _merge_tags_if_possible
848
elif len(revision) > 1:
849
raise errors.BzrCommandError(
850
'bzr branch --revision takes exactly 1 revision value')
852
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
856
if len(revision) == 1 and revision[0] is not None:
857
revision_id = revision[0].as_revision_id(br_from)
859
# FIXME - wt.last_revision, fallback to branch, fall back to
860
# None or perhaps NULL_REVISION to mean copy nothing
862
revision_id = br_from.last_revision()
863
if to_location is None:
864
to_location = urlutils.derive_to_location(from_location)
865
to_transport = transport.get_transport(to_location)
867
to_transport.mkdir('.')
868
except errors.FileExists:
869
raise errors.BzrCommandError('Target directory "%s" already'
870
' exists.' % to_location)
871
except errors.NoSuchFile:
872
raise errors.BzrCommandError('Parent of "%s" does not exist.'
875
# preserve whatever source format we have.
876
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
877
possible_transports=[to_transport],
878
accelerator_tree=accelerator_tree,
879
hardlink=hardlink, stacked=stacked)
880
branch = dir.open_branch()
881
except errors.NoSuchRevision:
882
to_transport.delete_tree('.')
883
msg = "The branch %s has no revision %s." % (from_location,
885
raise errors.BzrCommandError(msg)
886
_merge_tags_if_possible(br_from, branch)
887
# If the source branch is stacked, the new branch may
888
# be stacked whether we asked for that explicitly or not.
889
# We therefore need a try/except here and not just 'if stacked:'
891
note('Created new stacked branch referring to %s.' %
892
branch.get_stacked_on_url())
893
except (errors.NotStacked, errors.UnstackableBranchFormat,
894
errors.UnstackableRepositoryFormat), e:
895
note('Branched %d revision(s).' % branch.revno())
900
class cmd_checkout(Command):
901
"""Create a new checkout of an existing branch.
903
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
904
the branch found in '.'. This is useful if you have removed the working tree
905
or if it was never created - i.e. if you pushed the branch to its current
908
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
909
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
910
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
911
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
912
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
915
To retrieve the branch as of a particular revision, supply the --revision
916
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
917
out of date [so you cannot commit] but it may be useful (i.e. to examine old
921
_see_also = ['checkouts', 'branch']
922
takes_args = ['branch_location?', 'to_location?']
923
takes_options = ['revision',
924
Option('lightweight',
925
help="Perform a lightweight checkout. Lightweight "
926
"checkouts depend on access to the branch for "
927
"every operation. Normal checkouts can perform "
928
"common operations like diff and status without "
929
"such access, and also support local commits."
931
Option('files-from', type=str,
932
help="Get file contents from this tree."),
934
help='Hard-link working tree files where possible.'
939
def run(self, branch_location=None, to_location=None, revision=None,
940
lightweight=False, files_from=None, hardlink=False):
943
elif len(revision) > 1:
944
raise errors.BzrCommandError(
945
'bzr checkout --revision takes exactly 1 revision value')
946
if branch_location is None:
947
branch_location = osutils.getcwd()
948
to_location = branch_location
949
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
951
if files_from is not None:
952
accelerator_tree = WorkingTree.open(files_from)
953
if len(revision) == 1 and revision[0] is not None:
954
revision_id = revision[0].as_revision_id(source)
957
if to_location is None:
958
to_location = urlutils.derive_to_location(branch_location)
959
# if the source and to_location are the same,
960
# and there is no working tree,
961
# then reconstitute a branch
962
if (osutils.abspath(to_location) ==
963
osutils.abspath(branch_location)):
965
source.bzrdir.open_workingtree()
966
except errors.NoWorkingTree:
967
source.bzrdir.create_workingtree(revision_id)
969
source.create_checkout(to_location, revision_id, lightweight,
970
accelerator_tree, hardlink)
973
class cmd_renames(Command):
974
"""Show list of renamed files.
976
# TODO: Option to show renames between two historical versions.
978
# TODO: Only show renames under dir, rather than in the whole branch.
979
_see_also = ['status']
980
takes_args = ['dir?']
983
def run(self, dir=u'.'):
984
tree = WorkingTree.open_containing(dir)[0]
987
new_inv = tree.inventory
988
old_tree = tree.basis_tree()
991
old_inv = old_tree.inventory
992
renames = list(_mod_tree.find_renames(old_inv, new_inv))
994
for old_name, new_name in renames:
995
self.outf.write("%s => %s\n" % (old_name, new_name))
1002
class cmd_update(Command):
1003
"""Update a tree to have the latest code committed to its branch.
1005
This will perform a merge into the working tree, and may generate
1006
conflicts. If you have any local changes, you will still
1007
need to commit them after the update for the update to be complete.
1009
If you want to discard your local changes, you can just do a
1010
'bzr revert' instead of 'bzr commit' after the update.
1013
_see_also = ['pull', 'working-trees', 'status-flags']
1014
takes_args = ['dir?']
1017
def run(self, dir='.'):
1018
tree = WorkingTree.open_containing(dir)[0]
1019
possible_transports = []
1020
master = tree.branch.get_master_branch(
1021
possible_transports=possible_transports)
1022
if master is not None:
1025
tree.lock_tree_write()
1027
existing_pending_merges = tree.get_parent_ids()[1:]
1028
last_rev = _mod_revision.ensure_null(tree.last_revision())
1029
if last_rev == _mod_revision.ensure_null(
1030
tree.branch.last_revision()):
1031
# may be up to date, check master too.
1032
if master is None or last_rev == _mod_revision.ensure_null(
1033
master.last_revision()):
1034
revno = tree.branch.revision_id_to_revno(last_rev)
1035
note("Tree is up to date at revision %d." % (revno,))
1037
conflicts = tree.update(
1038
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1039
possible_transports=possible_transports)
1040
revno = tree.branch.revision_id_to_revno(
1041
_mod_revision.ensure_null(tree.last_revision()))
1042
note('Updated to revision %d.' % (revno,))
1043
if tree.get_parent_ids()[1:] != existing_pending_merges:
1044
note('Your local commits will now show as pending merges with '
1045
"'bzr status', and can be committed with 'bzr commit'.")
1054
class cmd_info(Command):
1055
"""Show information about a working tree, branch or repository.
1057
This command will show all known locations and formats associated to the
1058
tree, branch or repository. Statistical information is included with
1061
Branches and working trees will also report any missing revisions.
1063
_see_also = ['revno', 'working-trees', 'repositories']
1064
takes_args = ['location?']
1065
takes_options = ['verbose']
1066
encoding_type = 'replace'
1069
def run(self, location=None, verbose=False):
1074
from bzrlib.info import show_bzrdir_info
1075
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1076
verbose=noise_level, outfile=self.outf)
1079
class cmd_remove(Command):
1080
"""Remove files or directories.
1082
This makes bzr stop tracking changes to the specified files. bzr will delete
1083
them if they can easily be recovered using revert. If no options or
1084
parameters are given bzr will scan for files that are being tracked by bzr
1085
but missing in your tree and stop tracking them for you.
1087
takes_args = ['file*']
1088
takes_options = ['verbose',
1089
Option('new', help='Only remove files that have never been committed.'),
1090
RegistryOption.from_kwargs('file-deletion-strategy',
1091
'The file deletion mode to be used.',
1092
title='Deletion Strategy', value_switches=True, enum_switch=False,
1093
safe='Only delete files if they can be'
1094
' safely recovered (default).',
1095
keep="Don't delete any files.",
1096
force='Delete all the specified files, even if they can not be '
1097
'recovered and even if they are non-empty directories.')]
1098
aliases = ['rm', 'del']
1099
encoding_type = 'replace'
1101
def run(self, file_list, verbose=False, new=False,
1102
file_deletion_strategy='safe'):
1103
tree, file_list = tree_files(file_list)
1105
if file_list is not None:
1106
file_list = [f for f in file_list]
1110
# Heuristics should probably all move into tree.remove_smart or
1113
added = tree.changes_from(tree.basis_tree(),
1114
specific_files=file_list).added
1115
file_list = sorted([f[0] for f in added], reverse=True)
1116
if len(file_list) == 0:
1117
raise errors.BzrCommandError('No matching files.')
1118
elif file_list is None:
1119
# missing files show up in iter_changes(basis) as
1120
# versioned-with-no-kind.
1122
for change in tree.iter_changes(tree.basis_tree()):
1123
# Find paths in the working tree that have no kind:
1124
if change[1][1] is not None and change[6][1] is None:
1125
missing.append(change[1][1])
1126
file_list = sorted(missing, reverse=True)
1127
file_deletion_strategy = 'keep'
1128
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1129
keep_files=file_deletion_strategy=='keep',
1130
force=file_deletion_strategy=='force')
1135
class cmd_file_id(Command):
1136
"""Print file_id of a particular file or directory.
1138
The file_id is assigned when the file is first added and remains the
1139
same through all revisions where the file exists, even when it is
1144
_see_also = ['inventory', 'ls']
1145
takes_args = ['filename']
1148
def run(self, filename):
1149
tree, relpath = WorkingTree.open_containing(filename)
1150
i = tree.path2id(relpath)
1152
raise errors.NotVersionedError(filename)
1154
self.outf.write(i + '\n')
1157
class cmd_file_path(Command):
1158
"""Print path of file_ids to a file or directory.
1160
This prints one line for each directory down to the target,
1161
starting at the branch root.
1165
takes_args = ['filename']
1168
def run(self, filename):
1169
tree, relpath = WorkingTree.open_containing(filename)
1170
fid = tree.path2id(relpath)
1172
raise errors.NotVersionedError(filename)
1173
segments = osutils.splitpath(relpath)
1174
for pos in range(1, len(segments) + 1):
1175
path = osutils.joinpath(segments[:pos])
1176
self.outf.write("%s\n" % tree.path2id(path))
1179
class cmd_reconcile(Command):
1180
"""Reconcile bzr metadata in a branch.
1182
This can correct data mismatches that may have been caused by
1183
previous ghost operations or bzr upgrades. You should only
1184
need to run this command if 'bzr check' or a bzr developer
1185
advises you to run it.
1187
If a second branch is provided, cross-branch reconciliation is
1188
also attempted, which will check that data like the tree root
1189
id which was not present in very early bzr versions is represented
1190
correctly in both branches.
1192
At the same time it is run it may recompress data resulting in
1193
a potential saving in disk space or performance gain.
1195
The branch *MUST* be on a listable system such as local disk or sftp.
1198
_see_also = ['check']
1199
takes_args = ['branch?']
1201
def run(self, branch="."):
1202
from bzrlib.reconcile import reconcile
1203
dir = bzrdir.BzrDir.open(branch)
1207
class cmd_revision_history(Command):
1208
"""Display the list of revision ids on a branch."""
1211
takes_args = ['location?']
1216
def run(self, location="."):
1217
branch = Branch.open_containing(location)[0]
1218
for revid in branch.revision_history():
1219
self.outf.write(revid)
1220
self.outf.write('\n')
1223
class cmd_ancestry(Command):
1224
"""List all revisions merged into this branch."""
1226
_see_also = ['log', 'revision-history']
1227
takes_args = ['location?']
1232
def run(self, location="."):
1234
wt = WorkingTree.open_containing(location)[0]
1235
except errors.NoWorkingTree:
1236
b = Branch.open(location)
1237
last_revision = b.last_revision()
1240
last_revision = wt.last_revision()
1242
revision_ids = b.repository.get_ancestry(last_revision)
1244
for revision_id in revision_ids:
1245
self.outf.write(revision_id + '\n')
1248
class cmd_init(Command):
1249
"""Make a directory into a versioned branch.
1251
Use this to create an empty branch, or before importing an
1254
If there is a repository in a parent directory of the location, then
1255
the history of the branch will be stored in the repository. Otherwise
1256
init creates a standalone branch which carries its own history
1257
in the .bzr directory.
1259
If there is already a branch at the location but it has no working tree,
1260
the tree can be populated with 'bzr checkout'.
1262
Recipe for importing a tree of files::
1268
bzr commit -m "imported project"
1271
_see_also = ['init-repository', 'branch', 'checkout']
1272
takes_args = ['location?']
1274
Option('create-prefix',
1275
help='Create the path leading up to the branch '
1276
'if it does not already exist.'),
1277
RegistryOption('format',
1278
help='Specify a format for this branch. '
1279
'See "help formats".',
1280
registry=bzrdir.format_registry,
1281
converter=bzrdir.format_registry.make_bzrdir,
1282
value_switches=True,
1283
title="Branch Format",
1285
Option('append-revisions-only',
1286
help='Never change revnos or the existing log.'
1287
' Append revisions to it only.')
1289
def run(self, location=None, format=None, append_revisions_only=False,
1290
create_prefix=False):
1292
format = bzrdir.format_registry.make_bzrdir('default')
1293
if location is None:
1296
to_transport = transport.get_transport(location)
1298
# The path has to exist to initialize a
1299
# branch inside of it.
1300
# Just using os.mkdir, since I don't
1301
# believe that we want to create a bunch of
1302
# locations if the user supplies an extended path
1304
to_transport.ensure_base()
1305
except errors.NoSuchFile:
1306
if not create_prefix:
1307
raise errors.BzrCommandError("Parent directory of %s"
1309
"\nYou may supply --create-prefix to create all"
1310
" leading parent directories."
1312
_create_prefix(to_transport)
1315
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1316
except errors.NotBranchError:
1317
# really a NotBzrDir error...
1318
create_branch = bzrdir.BzrDir.create_branch_convenience
1319
branch = create_branch(to_transport.base, format=format,
1320
possible_transports=[to_transport])
1321
a_bzrdir = branch.bzrdir
1323
from bzrlib.transport.local import LocalTransport
1324
if a_bzrdir.has_branch():
1325
if (isinstance(to_transport, LocalTransport)
1326
and not a_bzrdir.has_workingtree()):
1327
raise errors.BranchExistsWithoutWorkingTree(location)
1328
raise errors.AlreadyBranchError(location)
1329
branch = a_bzrdir.create_branch()
1330
a_bzrdir.create_workingtree()
1331
if append_revisions_only:
1333
branch.set_append_revisions_only(True)
1334
except errors.UpgradeRequired:
1335
raise errors.BzrCommandError('This branch format cannot be set'
1336
' to append-revisions-only. Try --experimental-branch6')
1338
from bzrlib.info import show_bzrdir_info
1339
show_bzrdir_info(a_bzrdir, verbose=0, outfile=self.outf)
1342
class cmd_init_repository(Command):
1343
"""Create a shared repository to hold branches.
1345
New branches created under the repository directory will store their
1346
revisions in the repository, not in the branch directory.
1348
If the --no-trees option is used then the branches in the repository
1349
will not have working trees by default.
1352
Create a shared repositories holding just branches::
1354
bzr init-repo --no-trees repo
1357
Make a lightweight checkout elsewhere::
1359
bzr checkout --lightweight repo/trunk trunk-checkout
1364
_see_also = ['init', 'branch', 'checkout', 'repositories']
1365
takes_args = ["location"]
1366
takes_options = [RegistryOption('format',
1367
help='Specify a format for this repository. See'
1368
' "bzr help formats" for details.',
1369
registry=bzrdir.format_registry,
1370
converter=bzrdir.format_registry.make_bzrdir,
1371
value_switches=True, title='Repository format'),
1373
help='Branches in the repository will default to'
1374
' not having a working tree.'),
1376
aliases = ["init-repo"]
1378
def run(self, location, format=None, no_trees=False):
1380
format = bzrdir.format_registry.make_bzrdir('default')
1382
if location is None:
1385
to_transport = transport.get_transport(location)
1386
to_transport.ensure_base()
1388
newdir = format.initialize_on_transport(to_transport)
1389
repo = newdir.create_repository(shared=True)
1390
repo.set_make_working_trees(not no_trees)
1392
from bzrlib.info import show_bzrdir_info
1393
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1396
class cmd_diff(Command):
1397
"""Show differences in the working tree, between revisions or branches.
1399
If no arguments are given, all changes for the current tree are listed.
1400
If files are given, only the changes in those files are listed.
1401
Remote and multiple branches can be compared by using the --old and
1402
--new options. If not provided, the default for both is derived from
1403
the first argument, if any, or the current tree if no arguments are
1406
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1407
produces patches suitable for "patch -p1".
1411
2 - unrepresentable changes
1416
Shows the difference in the working tree versus the last commit::
1420
Difference between the working tree and revision 1::
1424
Difference between revision 2 and revision 1::
1428
Difference between revision 2 and revision 1 for branch xxx::
1432
Show just the differences for file NEWS::
1436
Show the differences in working tree xxx for file NEWS::
1440
Show the differences from branch xxx to this working tree:
1444
Show the differences between two branches for file NEWS::
1446
bzr diff --old xxx --new yyy NEWS
1448
Same as 'bzr diff' but prefix paths with old/ and new/::
1450
bzr diff --prefix old/:new/
1452
_see_also = ['status']
1453
takes_args = ['file*']
1455
Option('diff-options', type=str,
1456
help='Pass these options to the external diff program.'),
1457
Option('prefix', type=str,
1459
help='Set prefixes added to old and new filenames, as '
1460
'two values separated by a colon. (eg "old/:new/").'),
1462
help='Branch/tree to compare from.',
1466
help='Branch/tree to compare to.',
1472
help='Use this command to compare files.',
1476
aliases = ['di', 'dif']
1477
encoding_type = 'exact'
1480
def run(self, revision=None, file_list=None, diff_options=None,
1481
prefix=None, old=None, new=None, using=None):
1482
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1484
if (prefix is None) or (prefix == '0'):
1492
old_label, new_label = prefix.split(":")
1494
raise errors.BzrCommandError(
1495
'--prefix expects two values separated by a colon'
1496
' (eg "old/:new/")')
1498
if revision and len(revision) > 2:
1499
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1500
' one or two revision specifiers')
1502
old_tree, new_tree, specific_files, extra_trees = \
1503
_get_trees_to_diff(file_list, revision, old, new)
1504
return show_diff_trees(old_tree, new_tree, sys.stdout,
1505
specific_files=specific_files,
1506
external_diff_options=diff_options,
1507
old_label=old_label, new_label=new_label,
1508
extra_trees=extra_trees, using=using)
1511
class cmd_deleted(Command):
1512
"""List files deleted in the working tree.
1514
# TODO: Show files deleted since a previous revision, or
1515
# between two revisions.
1516
# TODO: Much more efficient way to do this: read in new
1517
# directories with readdir, rather than stating each one. Same
1518
# level of effort but possibly much less IO. (Or possibly not,
1519
# if the directories are very large...)
1520
_see_also = ['status', 'ls']
1521
takes_options = ['show-ids']
1524
def run(self, show_ids=False):
1525
tree = WorkingTree.open_containing(u'.')[0]
1528
old = tree.basis_tree()
1531
for path, ie in old.inventory.iter_entries():
1532
if not tree.has_id(ie.file_id):
1533
self.outf.write(path)
1535
self.outf.write(' ')
1536
self.outf.write(ie.file_id)
1537
self.outf.write('\n')
1544
class cmd_modified(Command):
1545
"""List files modified in working tree.
1549
_see_also = ['status', 'ls']
1552
help='Write an ascii NUL (\\0) separator '
1553
'between files rather than a newline.')
1557
def run(self, null=False):
1558
tree = WorkingTree.open_containing(u'.')[0]
1559
td = tree.changes_from(tree.basis_tree())
1560
for path, id, kind, text_modified, meta_modified in td.modified:
1562
self.outf.write(path + '\0')
1564
self.outf.write(osutils.quotefn(path) + '\n')
1567
class cmd_added(Command):
1568
"""List files added in working tree.
1572
_see_also = ['status', 'ls']
1575
help='Write an ascii NUL (\\0) separator '
1576
'between files rather than a newline.')
1580
def run(self, null=False):
1581
wt = WorkingTree.open_containing(u'.')[0]
1584
basis = wt.basis_tree()
1587
basis_inv = basis.inventory
1590
if file_id in basis_inv:
1592
if inv.is_root(file_id) and len(basis_inv) == 0:
1594
path = inv.id2path(file_id)
1595
if not os.access(osutils.abspath(path), os.F_OK):
1598
self.outf.write(path + '\0')
1600
self.outf.write(osutils.quotefn(path) + '\n')
1607
class cmd_root(Command):
1608
"""Show the tree root directory.
1610
The root is the nearest enclosing directory with a .bzr control
1613
takes_args = ['filename?']
1615
def run(self, filename=None):
1616
"""Print the branch root."""
1617
tree = WorkingTree.open_containing(filename)[0]
1618
self.outf.write(tree.basedir + '\n')
1621
def _parse_limit(limitstring):
1623
return int(limitstring)
1625
msg = "The limit argument must be an integer."
1626
raise errors.BzrCommandError(msg)
1629
class cmd_log(Command):
1630
"""Show log of a branch, file, or directory.
1632
By default show the log of the branch containing the working directory.
1634
To request a range of logs, you can use the command -r begin..end
1635
-r revision requests a specific revision, -r ..end or -r begin.. are
1639
Log the current branch::
1647
Log the last 10 revisions of a branch::
1649
bzr log -r -10.. http://server/branch
1652
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1654
takes_args = ['location?']
1657
help='Show from oldest to newest.'),
1660
help='Display timezone as local, original, or utc.'),
1661
custom_help('verbose',
1662
help='Show files changed in each revision.'),
1668
help='Show revisions whose message matches this '
1669
'regular expression.',
1673
help='Limit the output to the first N revisions.',
1677
encoding_type = 'replace'
1680
def run(self, location=None, timezone='original',
1688
from bzrlib.log import show_log
1689
direction = (forward and 'forward') or 'reverse'
1694
# find the file id to log:
1696
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1700
tree = b.basis_tree()
1701
file_id = tree.path2id(fp)
1703
raise errors.BzrCommandError(
1704
"Path does not have any revision history: %s" %
1708
# FIXME ? log the current subdir only RBC 20060203
1709
if revision is not None \
1710
and len(revision) > 0 and revision[0].get_branch():
1711
location = revision[0].get_branch()
1714
dir, relpath = bzrdir.BzrDir.open_containing(location)
1715
b = dir.open_branch()
1719
if revision is None:
1722
elif len(revision) == 1:
1723
rev1 = rev2 = revision[0].in_history(b)
1724
elif len(revision) == 2:
1725
if revision[1].get_branch() != revision[0].get_branch():
1726
# b is taken from revision[0].get_branch(), and
1727
# show_log will use its revision_history. Having
1728
# different branches will lead to weird behaviors.
1729
raise errors.BzrCommandError(
1730
"Log doesn't accept two revisions in different"
1732
rev1 = revision[0].in_history(b)
1733
rev2 = revision[1].in_history(b)
1735
raise errors.BzrCommandError(
1736
'bzr log --revision takes one or two values.')
1738
if log_format is None:
1739
log_format = log.log_formatter_registry.get_default(b)
1741
lf = log_format(show_ids=show_ids, to_file=self.outf,
1742
show_timezone=timezone)
1748
direction=direction,
1749
start_revision=rev1,
1757
def get_log_format(long=False, short=False, line=False, default='long'):
1758
log_format = default
1762
log_format = 'short'
1768
class cmd_touching_revisions(Command):
1769
"""Return revision-ids which affected a particular file.
1771
A more user-friendly interface is "bzr log FILE".
1775
takes_args = ["filename"]
1778
def run(self, filename):
1779
tree, relpath = WorkingTree.open_containing(filename)
1781
file_id = tree.path2id(relpath)
1782
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1783
self.outf.write("%6d %s\n" % (revno, what))
1786
class cmd_ls(Command):
1787
"""List files in a tree.
1790
_see_also = ['status', 'cat']
1791
takes_args = ['path?']
1792
# TODO: Take a revision or remote path and list that tree instead.
1796
Option('non-recursive',
1797
help='Don\'t recurse into subdirectories.'),
1799
help='Print paths relative to the root of the branch.'),
1800
Option('unknown', help='Print unknown files.'),
1801
Option('versioned', help='Print versioned files.',
1803
Option('ignored', help='Print ignored files.'),
1805
help='Write an ascii NUL (\\0) separator '
1806
'between files rather than a newline.'),
1808
help='List entries of a particular kind: file, directory, symlink.',
1813
def run(self, revision=None, verbose=False,
1814
non_recursive=False, from_root=False,
1815
unknown=False, versioned=False, ignored=False,
1816
null=False, kind=None, show_ids=False, path=None):
1818
if kind and kind not in ('file', 'directory', 'symlink'):
1819
raise errors.BzrCommandError('invalid kind specified')
1821
if verbose and null:
1822
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1823
all = not (unknown or versioned or ignored)
1825
selection = {'I':ignored, '?':unknown, 'V':versioned}
1832
raise errors.BzrCommandError('cannot specify both --from-root'
1836
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1842
if revision is not None:
1843
tree = branch.repository.revision_tree(
1844
revision[0].as_revision_id(branch))
1846
tree = branch.basis_tree()
1850
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1851
if fp.startswith(relpath):
1852
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1853
if non_recursive and '/' in fp:
1855
if not all and not selection[fc]:
1857
if kind is not None and fkind != kind:
1860
kindch = entry.kind_character()
1861
outstring = '%-8s %s%s' % (fc, fp, kindch)
1862
if show_ids and fid is not None:
1863
outstring = "%-50s %s" % (outstring, fid)
1864
self.outf.write(outstring + '\n')
1866
self.outf.write(fp + '\0')
1869
self.outf.write(fid)
1870
self.outf.write('\0')
1878
self.outf.write('%-50s %s\n' % (fp, my_id))
1880
self.outf.write(fp + '\n')
1885
class cmd_unknowns(Command):
1886
"""List unknown files.
1894
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1895
self.outf.write(osutils.quotefn(f) + '\n')
1898
class cmd_ignore(Command):
1899
"""Ignore specified files or patterns.
1901
See ``bzr help patterns`` for details on the syntax of patterns.
1903
To remove patterns from the ignore list, edit the .bzrignore file.
1904
After adding, editing or deleting that file either indirectly by
1905
using this command or directly by using an editor, be sure to commit
1908
Note: ignore patterns containing shell wildcards must be quoted from
1912
Ignore the top level Makefile::
1914
bzr ignore ./Makefile
1916
Ignore class files in all directories::
1918
bzr ignore "*.class"
1920
Ignore .o files under the lib directory::
1922
bzr ignore "lib/**/*.o"
1924
Ignore .o files under the lib directory::
1926
bzr ignore "RE:lib/.*\.o"
1928
Ignore everything but the "debian" toplevel directory::
1930
bzr ignore "RE:(?!debian/).*"
1933
_see_also = ['status', 'ignored', 'patterns']
1934
takes_args = ['name_pattern*']
1936
Option('old-default-rules',
1937
help='Write out the ignore rules bzr < 0.9 always used.')
1940
def run(self, name_pattern_list=None, old_default_rules=None):
1941
from bzrlib import ignores
1942
if old_default_rules is not None:
1943
# dump the rules and exit
1944
for pattern in ignores.OLD_DEFAULTS:
1947
if not name_pattern_list:
1948
raise errors.BzrCommandError("ignore requires at least one "
1949
"NAME_PATTERN or --old-default-rules")
1950
name_pattern_list = [globbing.normalize_pattern(p)
1951
for p in name_pattern_list]
1952
for name_pattern in name_pattern_list:
1953
if (name_pattern[0] == '/' or
1954
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1955
raise errors.BzrCommandError(
1956
"NAME_PATTERN should not be an absolute path")
1957
tree, relpath = WorkingTree.open_containing(u'.')
1958
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
1959
ignored = globbing.Globster(name_pattern_list)
1962
for entry in tree.list_files():
1966
if ignored.match(filename):
1967
matches.append(filename.encode('utf-8'))
1969
if len(matches) > 0:
1970
print "Warning: the following files are version controlled and" \
1971
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1974
class cmd_ignored(Command):
1975
"""List ignored files and the patterns that matched them.
1977
List all the ignored files and the ignore pattern that caused the file to
1980
Alternatively, to list just the files::
1985
encoding_type = 'replace'
1986
_see_also = ['ignore', 'ls']
1990
tree = WorkingTree.open_containing(u'.')[0]
1993
for path, file_class, kind, file_id, entry in tree.list_files():
1994
if file_class != 'I':
1996
## XXX: Slightly inefficient since this was already calculated
1997
pat = tree.is_ignored(path)
1998
self.outf.write('%-50s %s\n' % (path, pat))
2003
class cmd_lookup_revision(Command):
2004
"""Lookup the revision-id from a revision-number
2007
bzr lookup-revision 33
2010
takes_args = ['revno']
2013
def run(self, revno):
2017
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2019
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2022
class cmd_export(Command):
2023
"""Export current or past revision to a destination directory or archive.
2025
If no revision is specified this exports the last committed revision.
2027
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2028
given, try to find the format with the extension. If no extension
2029
is found exports to a directory (equivalent to --format=dir).
2031
If root is supplied, it will be used as the root directory inside
2032
container formats (tar, zip, etc). If it is not supplied it will default
2033
to the exported filename. The root option has no effect for 'dir' format.
2035
If branch is omitted then the branch containing the current working
2036
directory will be used.
2038
Note: Export of tree with non-ASCII filenames to zip is not supported.
2040
================= =========================
2041
Supported formats Autodetected by extension
2042
================= =========================
2045
tbz2 .tar.bz2, .tbz2
2048
================= =========================
2050
takes_args = ['dest', 'branch_or_subdir?']
2053
help="Type of file to export to.",
2058
help="Name of the root directory inside the exported file."),
2060
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2062
from bzrlib.export import export
2064
if branch_or_subdir is None:
2065
tree = WorkingTree.open_containing(u'.')[0]
2069
b, subdir = Branch.open_containing(branch_or_subdir)
2071
if revision is None:
2072
# should be tree.last_revision FIXME
2073
rev_id = b.last_revision()
2075
if len(revision) != 1:
2076
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2077
rev_id = revision[0].as_revision_id(b)
2078
t = b.repository.revision_tree(rev_id)
2080
export(t, dest, format, root, subdir)
2081
except errors.NoSuchExportFormat, e:
2082
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2085
class cmd_cat(Command):
2086
"""Write the contents of a file as of a given revision to standard output.
2088
If no revision is nominated, the last revision is used.
2090
Note: Take care to redirect standard output when using this command on a
2096
Option('name-from-revision', help='The path name in the old tree.'),
2099
takes_args = ['filename']
2100
encoding_type = 'exact'
2103
def run(self, filename, revision=None, name_from_revision=False):
2104
if revision is not None and len(revision) != 1:
2105
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2106
" one revision specifier")
2107
tree, branch, relpath = \
2108
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2111
return self._run(tree, branch, relpath, filename, revision,
2116
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2118
tree = b.basis_tree()
2119
if revision is None:
2120
revision_id = b.last_revision()
2122
revision_id = revision[0].as_revision_id(b)
2124
cur_file_id = tree.path2id(relpath)
2125
rev_tree = b.repository.revision_tree(revision_id)
2126
old_file_id = rev_tree.path2id(relpath)
2128
if name_from_revision:
2129
if old_file_id is None:
2130
raise errors.BzrCommandError("%r is not present in revision %s"
2131
% (filename, revision_id))
2133
content = rev_tree.get_file_text(old_file_id)
2134
elif cur_file_id is not None:
2135
content = rev_tree.get_file_text(cur_file_id)
2136
elif old_file_id is not None:
2137
content = rev_tree.get_file_text(old_file_id)
2139
raise errors.BzrCommandError("%r is not present in revision %s" %
2140
(filename, revision_id))
2141
self.outf.write(content)
2144
class cmd_local_time_offset(Command):
2145
"""Show the offset in seconds from GMT to local time."""
2149
print osutils.local_time_offset()
2153
class cmd_commit(Command):
2154
"""Commit changes into a new revision.
2156
If no arguments are given, the entire tree is committed.
2158
If selected files are specified, only changes to those files are
2159
committed. If a directory is specified then the directory and everything
2160
within it is committed.
2162
When excludes are given, they take precedence over selected files.
2163
For example, too commit only changes within foo, but not changes within
2166
bzr commit foo -x foo/bar
2168
If author of the change is not the same person as the committer, you can
2169
specify the author's name using the --author option. The name should be
2170
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2172
A selected-file commit may fail in some cases where the committed
2173
tree would be invalid. Consider::
2178
bzr commit foo -m "committing foo"
2179
bzr mv foo/bar foo/baz
2182
bzr commit foo/bar -m "committing bar but not baz"
2184
In the example above, the last commit will fail by design. This gives
2185
the user the opportunity to decide whether they want to commit the
2186
rename at the same time, separately first, or not at all. (As a general
2187
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2189
Note: A selected-file commit after a merge is not yet supported.
2191
# TODO: Run hooks on tree to-be-committed, and after commit.
2193
# TODO: Strict commit that fails if there are deleted files.
2194
# (what does "deleted files" mean ??)
2196
# TODO: Give better message for -s, --summary, used by tla people
2198
# XXX: verbose currently does nothing
2200
_see_also = ['bugs', 'uncommit']
2201
takes_args = ['selected*']
2203
ListOption('exclude', type=str, short_name='x',
2204
help="Do not consider changes made to a given path."),
2205
Option('message', type=unicode,
2207
help="Description of the new revision."),
2210
help='Commit even if nothing has changed.'),
2211
Option('file', type=str,
2214
help='Take commit message from this file.'),
2216
help="Refuse to commit if there are unknown "
2217
"files in the working tree."),
2218
ListOption('fixes', type=str,
2219
help="Mark a bug as being fixed by this revision."),
2220
Option('author', type=unicode,
2221
help="Set the author's name, if it's different "
2222
"from the committer."),
2224
help="Perform a local commit in a bound "
2225
"branch. Local commits are not pushed to "
2226
"the master branch until a normal commit "
2230
help='When no message is supplied, show the diff along'
2231
' with the status summary in the message editor.'),
2233
aliases = ['ci', 'checkin']
2235
def _get_bug_fix_properties(self, fixes, branch):
2237
# Configure the properties for bug fixing attributes.
2238
for fixed_bug in fixes:
2239
tokens = fixed_bug.split(':')
2240
if len(tokens) != 2:
2241
raise errors.BzrCommandError(
2242
"Invalid bug %s. Must be in the form of 'tag:id'. "
2243
"Commit refused." % fixed_bug)
2244
tag, bug_id = tokens
2246
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2247
except errors.UnknownBugTrackerAbbreviation:
2248
raise errors.BzrCommandError(
2249
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2250
except errors.MalformedBugIdentifier:
2251
raise errors.BzrCommandError(
2252
"Invalid bug identifier for %s. Commit refused."
2254
properties.append('%s fixed' % bug_url)
2255
return '\n'.join(properties)
2257
def run(self, message=None, file=None, verbose=False, selected_list=None,
2258
unchanged=False, strict=False, local=False, fixes=None,
2259
author=None, show_diff=False, exclude=None):
2260
from bzrlib.errors import (
2265
from bzrlib.msgeditor import (
2266
edit_commit_message_encoded,
2267
make_commit_message_template_encoded
2270
# TODO: Need a blackbox test for invoking the external editor; may be
2271
# slightly problematic to run this cross-platform.
2273
# TODO: do more checks that the commit will succeed before
2274
# spending the user's valuable time typing a commit message.
2278
tree, selected_list = tree_files(selected_list)
2279
if selected_list == ['']:
2280
# workaround - commit of root of tree should be exactly the same
2281
# as just default commit in that tree, and succeed even though
2282
# selected-file merge commit is not done yet
2287
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2289
properties['bugs'] = bug_property
2291
if local and not tree.branch.get_bound_location():
2292
raise errors.LocalRequiresBoundBranch()
2294
def get_message(commit_obj):
2295
"""Callback to get commit message"""
2296
my_message = message
2297
if my_message is None and not file:
2298
t = make_commit_message_template_encoded(tree,
2299
selected_list, diff=show_diff,
2300
output_encoding=bzrlib.user_encoding)
2301
my_message = edit_commit_message_encoded(t)
2302
if my_message is None:
2303
raise errors.BzrCommandError("please specify a commit"
2304
" message with either --message or --file")
2305
elif my_message and file:
2306
raise errors.BzrCommandError(
2307
"please specify either --message or --file")
2309
my_message = codecs.open(file, 'rt',
2310
bzrlib.user_encoding).read()
2311
if my_message == "":
2312
raise errors.BzrCommandError("empty commit message specified")
2316
tree.commit(message_callback=get_message,
2317
specific_files=selected_list,
2318
allow_pointless=unchanged, strict=strict, local=local,
2319
reporter=None, verbose=verbose, revprops=properties,
2321
exclude=safe_relpath_files(tree, exclude))
2322
except PointlessCommit:
2323
# FIXME: This should really happen before the file is read in;
2324
# perhaps prepare the commit; get the message; then actually commit
2325
raise errors.BzrCommandError("no changes to commit."
2326
" use --unchanged to commit anyhow")
2327
except ConflictsInTree:
2328
raise errors.BzrCommandError('Conflicts detected in working '
2329
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2331
except StrictCommitFailed:
2332
raise errors.BzrCommandError("Commit refused because there are"
2333
" unknown files in the working tree.")
2334
except errors.BoundBranchOutOfDate, e:
2335
raise errors.BzrCommandError(str(e) + "\n"
2336
'To commit to master branch, run update and then commit.\n'
2337
'You can also pass --local to commit to continue working '
2341
class cmd_check(Command):
2342
"""Validate working tree structure, branch consistency and repository history.
2344
This command checks various invariants about branch and repository storage
2345
to detect data corruption or bzr bugs.
2347
The working tree and branch checks will only give output if a problem is
2348
detected. The output fields of the repository check are:
2350
revisions: This is just the number of revisions checked. It doesn't
2352
versionedfiles: This is just the number of versionedfiles checked. It
2353
doesn't indicate a problem.
2354
unreferenced ancestors: Texts that are ancestors of other texts, but
2355
are not properly referenced by the revision ancestry. This is a
2356
subtle problem that Bazaar can work around.
2357
unique file texts: This is the total number of unique file contents
2358
seen in the checked revisions. It does not indicate a problem.
2359
repeated file texts: This is the total number of repeated texts seen
2360
in the checked revisions. Texts can be repeated when their file
2361
entries are modified, but the file contents are not. It does not
2364
If no restrictions are specified, all Bazaar data that is found at the given
2365
location will be checked.
2369
Check the tree and branch at 'foo'::
2371
bzr check --tree --branch foo
2373
Check only the repository at 'bar'::
2375
bzr check --repo bar
2377
Check everything at 'baz'::
2382
_see_also = ['reconcile']
2383
takes_args = ['path?']
2384
takes_options = ['verbose',
2385
Option('branch', help="Check the branch related to the"
2386
" current directory."),
2387
Option('repo', help="Check the repository related to the"
2388
" current directory."),
2389
Option('tree', help="Check the working tree related to"
2390
" the current directory.")]
2392
def run(self, path=None, verbose=False, branch=False, repo=False,
2394
from bzrlib.check import check_dwim
2397
if not branch and not repo and not tree:
2398
branch = repo = tree = True
2399
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2402
class cmd_upgrade(Command):
2403
"""Upgrade branch storage to current format.
2405
The check command or bzr developers may sometimes advise you to run
2406
this command. When the default format has changed you may also be warned
2407
during other operations to upgrade.
2410
_see_also = ['check']
2411
takes_args = ['url?']
2413
RegistryOption('format',
2414
help='Upgrade to a specific format. See "bzr help'
2415
' formats" for details.',
2416
registry=bzrdir.format_registry,
2417
converter=bzrdir.format_registry.make_bzrdir,
2418
value_switches=True, title='Branch format'),
2421
def run(self, url='.', format=None):
2422
from bzrlib.upgrade import upgrade
2424
format = bzrdir.format_registry.make_bzrdir('default')
2425
upgrade(url, format)
2428
class cmd_whoami(Command):
2429
"""Show or set bzr user id.
2432
Show the email of the current user::
2436
Set the current user::
2438
bzr whoami "Frank Chu <fchu@example.com>"
2440
takes_options = [ Option('email',
2441
help='Display email address only.'),
2443
help='Set identity for the current branch instead of '
2446
takes_args = ['name?']
2447
encoding_type = 'replace'
2450
def run(self, email=False, branch=False, name=None):
2452
# use branch if we're inside one; otherwise global config
2454
c = Branch.open_containing('.')[0].get_config()
2455
except errors.NotBranchError:
2456
c = config.GlobalConfig()
2458
self.outf.write(c.user_email() + '\n')
2460
self.outf.write(c.username() + '\n')
2463
# display a warning if an email address isn't included in the given name.
2465
config.extract_email_address(name)
2466
except errors.NoEmailInUsername, e:
2467
warning('"%s" does not seem to contain an email address. '
2468
'This is allowed, but not recommended.', name)
2470
# use global config unless --branch given
2472
c = Branch.open_containing('.')[0].get_config()
2474
c = config.GlobalConfig()
2475
c.set_user_option('email', name)
2478
class cmd_nick(Command):
2479
"""Print or set the branch nickname.
2481
If unset, the tree root directory name is used as the nickname
2482
To print the current nickname, execute with no argument.
2485
_see_also = ['info']
2486
takes_args = ['nickname?']
2487
def run(self, nickname=None):
2488
branch = Branch.open_containing(u'.')[0]
2489
if nickname is None:
2490
self.printme(branch)
2492
branch.nick = nickname
2495
def printme(self, branch):
2499
class cmd_alias(Command):
2500
"""Set/unset and display aliases.
2503
Show the current aliases::
2507
Show the alias specified for 'll'::
2511
Set an alias for 'll'::
2513
bzr alias ll="log --line -r-10..-1"
2515
To remove an alias for 'll'::
2517
bzr alias --remove ll
2520
takes_args = ['name?']
2522
Option('remove', help='Remove the alias.'),
2525
def run(self, name=None, remove=False):
2527
self.remove_alias(name)
2529
self.print_aliases()
2531
equal_pos = name.find('=')
2533
self.print_alias(name)
2535
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2537
def remove_alias(self, alias_name):
2538
if alias_name is None:
2539
raise errors.BzrCommandError(
2540
'bzr alias --remove expects an alias to remove.')
2541
# If alias is not found, print something like:
2542
# unalias: foo: not found
2543
c = config.GlobalConfig()
2544
c.unset_alias(alias_name)
2547
def print_aliases(self):
2548
"""Print out the defined aliases in a similar format to bash."""
2549
aliases = config.GlobalConfig().get_aliases()
2550
for key, value in sorted(aliases.iteritems()):
2551
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2554
def print_alias(self, alias_name):
2555
from bzrlib.commands import get_alias
2556
alias = get_alias(alias_name)
2558
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2561
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2563
def set_alias(self, alias_name, alias_command):
2564
"""Save the alias in the global config."""
2565
c = config.GlobalConfig()
2566
c.set_alias(alias_name, alias_command)
2569
class cmd_selftest(Command):
2570
"""Run internal test suite.
2572
If arguments are given, they are regular expressions that say which tests
2573
should run. Tests matching any expression are run, and other tests are
2576
Alternatively if --first is given, matching tests are run first and then
2577
all other tests are run. This is useful if you have been working in a
2578
particular area, but want to make sure nothing else was broken.
2580
If --exclude is given, tests that match that regular expression are
2581
excluded, regardless of whether they match --first or not.
2583
To help catch accidential dependencies between tests, the --randomize
2584
option is useful. In most cases, the argument used is the word 'now'.
2585
Note that the seed used for the random number generator is displayed
2586
when this option is used. The seed can be explicitly passed as the
2587
argument to this option if required. This enables reproduction of the
2588
actual ordering used if and when an order sensitive problem is encountered.
2590
If --list-only is given, the tests that would be run are listed. This is
2591
useful when combined with --first, --exclude and/or --randomize to
2592
understand their impact. The test harness reports "Listed nn tests in ..."
2593
instead of "Ran nn tests in ..." when list mode is enabled.
2595
If the global option '--no-plugins' is given, plugins are not loaded
2596
before running the selftests. This has two effects: features provided or
2597
modified by plugins will not be tested, and tests provided by plugins will
2600
Tests that need working space on disk use a common temporary directory,
2601
typically inside $TMPDIR or /tmp.
2604
Run only tests relating to 'ignore'::
2608
Disable plugins and list tests as they're run::
2610
bzr --no-plugins selftest -v
2612
# NB: this is used from the class without creating an instance, which is
2613
# why it does not have a self parameter.
2614
def get_transport_type(typestring):
2615
"""Parse and return a transport specifier."""
2616
if typestring == "sftp":
2617
from bzrlib.transport.sftp import SFTPAbsoluteServer
2618
return SFTPAbsoluteServer
2619
if typestring == "memory":
2620
from bzrlib.transport.memory import MemoryServer
2622
if typestring == "fakenfs":
2623
from bzrlib.transport.fakenfs import FakeNFSServer
2624
return FakeNFSServer
2625
msg = "No known transport type %s. Supported types are: sftp\n" %\
2627
raise errors.BzrCommandError(msg)
2630
takes_args = ['testspecs*']
2631
takes_options = ['verbose',
2633
help='Stop when one test fails.',
2637
help='Use a different transport by default '
2638
'throughout the test suite.',
2639
type=get_transport_type),
2641
help='Run the benchmarks rather than selftests.'),
2642
Option('lsprof-timed',
2643
help='Generate lsprof output for benchmarked'
2644
' sections of code.'),
2645
Option('cache-dir', type=str,
2646
help='Cache intermediate benchmark output in this '
2649
help='Run all tests, but run specified tests first.',
2653
help='List the tests instead of running them.'),
2654
Option('randomize', type=str, argname="SEED",
2655
help='Randomize the order of tests using the given'
2656
' seed or "now" for the current time.'),
2657
Option('exclude', type=str, argname="PATTERN",
2659
help='Exclude tests that match this regular'
2661
Option('strict', help='Fail on missing dependencies or '
2663
Option('load-list', type=str, argname='TESTLISTFILE',
2664
help='Load a test id list from a text file.'),
2665
ListOption('debugflag', type=str, short_name='E',
2666
help='Turn on a selftest debug flag.'),
2667
ListOption('starting-with', type=str, argname='TESTID',
2668
param_name='starting_with', short_name='s',
2670
'Load only the tests starting with TESTID.'),
2672
encoding_type = 'replace'
2674
def run(self, testspecs_list=None, verbose=False, one=False,
2675
transport=None, benchmark=None,
2676
lsprof_timed=None, cache_dir=None,
2677
first=False, list_only=False,
2678
randomize=None, exclude=None, strict=False,
2679
load_list=None, debugflag=None, starting_with=None):
2681
from bzrlib.tests import selftest
2682
import bzrlib.benchmarks as benchmarks
2683
from bzrlib.benchmarks import tree_creator
2685
# Make deprecation warnings visible, unless -Werror is set
2686
symbol_versioning.activate_deprecation_warnings(override=False)
2688
if cache_dir is not None:
2689
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2691
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2692
print ' %s (%s python%s)' % (
2694
bzrlib.version_string,
2695
bzrlib._format_version_tuple(sys.version_info),
2698
if testspecs_list is not None:
2699
pattern = '|'.join(testspecs_list)
2703
test_suite_factory = benchmarks.test_suite
2704
# Unless user explicitly asks for quiet, be verbose in benchmarks
2705
verbose = not is_quiet()
2706
# TODO: should possibly lock the history file...
2707
benchfile = open(".perf_history", "at", buffering=1)
2709
test_suite_factory = None
2712
result = selftest(verbose=verbose,
2714
stop_on_failure=one,
2715
transport=transport,
2716
test_suite_factory=test_suite_factory,
2717
lsprof_timed=lsprof_timed,
2718
bench_history=benchfile,
2719
matching_tests_first=first,
2720
list_only=list_only,
2721
random_seed=randomize,
2722
exclude_pattern=exclude,
2724
load_list=load_list,
2725
debug_flags=debugflag,
2726
starting_with=starting_with,
2729
if benchfile is not None:
2732
note('tests passed')
2734
note('tests failed')
2735
return int(not result)
2738
class cmd_version(Command):
2739
"""Show version of bzr."""
2741
encoding_type = 'replace'
2743
Option("short", help="Print just the version number."),
2747
def run(self, short=False):
2748
from bzrlib.version import show_version
2750
self.outf.write(bzrlib.version_string + '\n')
2752
show_version(to_file=self.outf)
2755
class cmd_rocks(Command):
2756
"""Statement of optimism."""
2762
print "It sure does!"
2765
class cmd_find_merge_base(Command):
2766
"""Find and print a base revision for merging two branches."""
2767
# TODO: Options to specify revisions on either side, as if
2768
# merging only part of the history.
2769
takes_args = ['branch', 'other']
2773
def run(self, branch, other):
2774
from bzrlib.revision import ensure_null
2776
branch1 = Branch.open_containing(branch)[0]
2777
branch2 = Branch.open_containing(other)[0]
2782
last1 = ensure_null(branch1.last_revision())
2783
last2 = ensure_null(branch2.last_revision())
2785
graph = branch1.repository.get_graph(branch2.repository)
2786
base_rev_id = graph.find_unique_lca(last1, last2)
2788
print 'merge base is revision %s' % base_rev_id
2795
class cmd_merge(Command):
2796
"""Perform a three-way merge.
2798
The source of the merge can be specified either in the form of a branch,
2799
or in the form of a path to a file containing a merge directive generated
2800
with bzr send. If neither is specified, the default is the upstream branch
2801
or the branch most recently merged using --remember.
2803
When merging a branch, by default the tip will be merged. To pick a different
2804
revision, pass --revision. If you specify two values, the first will be used as
2805
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2806
available revisions, like this is commonly referred to as "cherrypicking".
2808
Revision numbers are always relative to the branch being merged.
2810
By default, bzr will try to merge in all new work from the other
2811
branch, automatically determining an appropriate base. If this
2812
fails, you may need to give an explicit base.
2814
Merge will do its best to combine the changes in two branches, but there
2815
are some kinds of problems only a human can fix. When it encounters those,
2816
it will mark a conflict. A conflict means that you need to fix something,
2817
before you should commit.
2819
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2821
If there is no default branch set, the first merge will set it. After
2822
that, you can omit the branch to use the default. To change the
2823
default, use --remember. The value will only be saved if the remote
2824
location can be accessed.
2826
The results of the merge are placed into the destination working
2827
directory, where they can be reviewed (with bzr diff), tested, and then
2828
committed to record the result of the merge.
2830
merge refuses to run if there are any uncommitted changes, unless
2834
To merge the latest revision from bzr.dev::
2836
bzr merge ../bzr.dev
2838
To merge changes up to and including revision 82 from bzr.dev::
2840
bzr merge -r 82 ../bzr.dev
2842
To merge the changes introduced by 82, without previous changes::
2844
bzr merge -r 81..82 ../bzr.dev
2846
To apply a merge directive contained in in /tmp/merge:
2848
bzr merge /tmp/merge
2851
encoding_type = 'exact'
2852
_see_also = ['update', 'remerge', 'status-flags']
2853
takes_args = ['location?']
2858
help='Merge even if the destination tree has uncommitted changes.'),
2862
Option('show-base', help="Show base revision text in "
2864
Option('uncommitted', help='Apply uncommitted changes'
2865
' from a working copy, instead of branch changes.'),
2866
Option('pull', help='If the destination is already'
2867
' completely merged into the source, pull from the'
2868
' source rather than merging. When this happens,'
2869
' you do not need to commit the result.'),
2871
help='Branch to merge into, '
2872
'rather than the one containing the working directory.',
2876
Option('preview', help='Instead of merging, show a diff of the merge.')
2879
def run(self, location=None, revision=None, force=False,
2880
merge_type=None, show_base=False, reprocess=False, remember=False,
2881
uncommitted=False, pull=False,
2885
if merge_type is None:
2886
merge_type = _mod_merge.Merge3Merger
2888
if directory is None: directory = u'.'
2889
possible_transports = []
2891
allow_pending = True
2892
verified = 'inapplicable'
2893
tree = WorkingTree.open_containing(directory)[0]
2894
change_reporter = delta._ChangeReporter(
2895
unversioned_filter=tree.is_ignored)
2898
pb = ui.ui_factory.nested_progress_bar()
2899
cleanups.append(pb.finished)
2901
cleanups.append(tree.unlock)
2902
if location is not None:
2904
mergeable = bundle.read_mergeable_from_url(location,
2905
possible_transports=possible_transports)
2906
except errors.NotABundle:
2910
raise errors.BzrCommandError('Cannot use --uncommitted'
2911
' with bundles or merge directives.')
2913
if revision is not None:
2914
raise errors.BzrCommandError(
2915
'Cannot use -r with merge directives or bundles')
2916
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2919
if merger is None and uncommitted:
2920
if revision is not None and len(revision) > 0:
2921
raise errors.BzrCommandError('Cannot use --uncommitted and'
2922
' --revision at the same time.')
2923
location = self._select_branch_location(tree, location)[0]
2924
other_tree, other_path = WorkingTree.open_containing(location)
2925
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2927
allow_pending = False
2928
if other_path != '':
2929
merger.interesting_files = [other_path]
2932
merger, allow_pending = self._get_merger_from_branch(tree,
2933
location, revision, remember, possible_transports, pb)
2935
merger.merge_type = merge_type
2936
merger.reprocess = reprocess
2937
merger.show_base = show_base
2938
self.sanity_check_merger(merger)
2939
if (merger.base_rev_id == merger.other_rev_id and
2940
merger.other_rev_id is not None):
2941
note('Nothing to do.')
2944
if merger.interesting_files is not None:
2945
raise errors.BzrCommandError('Cannot pull individual files')
2946
if (merger.base_rev_id == tree.last_revision()):
2947
result = tree.pull(merger.other_branch, False,
2948
merger.other_rev_id)
2949
result.report(self.outf)
2951
merger.check_basis(not force)
2953
return self._do_preview(merger)
2955
return self._do_merge(merger, change_reporter, allow_pending,
2958
for cleanup in reversed(cleanups):
2961
def _do_preview(self, merger):
2962
from bzrlib.diff import show_diff_trees
2963
tree_merger = merger.make_merger()
2964
tt = tree_merger.make_preview_transform()
2966
result_tree = tt.get_preview_tree()
2967
show_diff_trees(merger.this_tree, result_tree, self.outf,
2968
old_label='', new_label='')
2972
def _do_merge(self, merger, change_reporter, allow_pending, verified):
2973
merger.change_reporter = change_reporter
2974
conflict_count = merger.do_merge()
2976
merger.set_pending()
2977
if verified == 'failed':
2978
warning('Preview patch does not match changes')
2979
if conflict_count != 0:
2984
def sanity_check_merger(self, merger):
2985
if (merger.show_base and
2986
not merger.merge_type is _mod_merge.Merge3Merger):
2987
raise errors.BzrCommandError("Show-base is not supported for this"
2988
" merge type. %s" % merger.merge_type)
2989
if merger.reprocess and not merger.merge_type.supports_reprocess:
2990
raise errors.BzrCommandError("Conflict reduction is not supported"
2991
" for merge type %s." %
2993
if merger.reprocess and merger.show_base:
2994
raise errors.BzrCommandError("Cannot do conflict reduction and"
2997
def _get_merger_from_branch(self, tree, location, revision, remember,
2998
possible_transports, pb):
2999
"""Produce a merger from a location, assuming it refers to a branch."""
3000
from bzrlib.tag import _merge_tags_if_possible
3001
# find the branch locations
3002
other_loc, user_location = self._select_branch_location(tree, location,
3004
if revision is not None and len(revision) == 2:
3005
base_loc, _unused = self._select_branch_location(tree,
3006
location, revision, 0)
3008
base_loc = other_loc
3010
other_branch, other_path = Branch.open_containing(other_loc,
3011
possible_transports)
3012
if base_loc == other_loc:
3013
base_branch = other_branch
3015
base_branch, base_path = Branch.open_containing(base_loc,
3016
possible_transports)
3017
# Find the revision ids
3018
if revision is None or len(revision) < 1 or revision[-1] is None:
3019
other_revision_id = _mod_revision.ensure_null(
3020
other_branch.last_revision())
3022
other_revision_id = revision[-1].as_revision_id(other_branch)
3023
if (revision is not None and len(revision) == 2
3024
and revision[0] is not None):
3025
base_revision_id = revision[0].as_revision_id(base_branch)
3027
base_revision_id = None
3028
# Remember where we merge from
3029
if ((remember or tree.branch.get_submit_branch() is None) and
3030
user_location is not None):
3031
tree.branch.set_submit_branch(other_branch.base)
3032
_merge_tags_if_possible(other_branch, tree.branch)
3033
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3034
other_revision_id, base_revision_id, other_branch, base_branch)
3035
if other_path != '':
3036
allow_pending = False
3037
merger.interesting_files = [other_path]
3039
allow_pending = True
3040
return merger, allow_pending
3042
def _select_branch_location(self, tree, user_location, revision=None,
3044
"""Select a branch location, according to possible inputs.
3046
If provided, branches from ``revision`` are preferred. (Both
3047
``revision`` and ``index`` must be supplied.)
3049
Otherwise, the ``location`` parameter is used. If it is None, then the
3050
``submit`` or ``parent`` location is used, and a note is printed.
3052
:param tree: The working tree to select a branch for merging into
3053
:param location: The location entered by the user
3054
:param revision: The revision parameter to the command
3055
:param index: The index to use for the revision parameter. Negative
3056
indices are permitted.
3057
:return: (selected_location, user_location). The default location
3058
will be the user-entered location.
3060
if (revision is not None and index is not None
3061
and revision[index] is not None):
3062
branch = revision[index].get_branch()
3063
if branch is not None:
3064
return branch, branch
3065
if user_location is None:
3066
location = self._get_remembered(tree, 'Merging from')
3068
location = user_location
3069
return location, user_location
3071
def _get_remembered(self, tree, verb_string):
3072
"""Use tree.branch's parent if none was supplied.
3074
Report if the remembered location was used.
3076
stored_location = tree.branch.get_submit_branch()
3077
stored_location_type = "submit"
3078
if stored_location is None:
3079
stored_location = tree.branch.get_parent()
3080
stored_location_type = "parent"
3081
mutter("%s", stored_location)
3082
if stored_location is None:
3083
raise errors.BzrCommandError("No location specified or remembered")
3084
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3085
note(u"%s remembered %s location %s", verb_string,
3086
stored_location_type, display_url)
3087
return stored_location
3090
class cmd_remerge(Command):
3093
Use this if you want to try a different merge technique while resolving
3094
conflicts. Some merge techniques are better than others, and remerge
3095
lets you try different ones on different files.
3097
The options for remerge have the same meaning and defaults as the ones for
3098
merge. The difference is that remerge can (only) be run when there is a
3099
pending merge, and it lets you specify particular files.
3102
Re-do the merge of all conflicted files, and show the base text in
3103
conflict regions, in addition to the usual THIS and OTHER texts::
3105
bzr remerge --show-base
3107
Re-do the merge of "foobar", using the weave merge algorithm, with
3108
additional processing to reduce the size of conflict regions::
3110
bzr remerge --merge-type weave --reprocess foobar
3112
takes_args = ['file*']
3117
help="Show base revision text in conflicts."),
3120
def run(self, file_list=None, merge_type=None, show_base=False,
3122
if merge_type is None:
3123
merge_type = _mod_merge.Merge3Merger
3124
tree, file_list = tree_files(file_list)
3127
parents = tree.get_parent_ids()
3128
if len(parents) != 2:
3129
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3130
" merges. Not cherrypicking or"
3132
repository = tree.branch.repository
3133
interesting_ids = None
3135
conflicts = tree.conflicts()
3136
if file_list is not None:
3137
interesting_ids = set()
3138
for filename in file_list:
3139
file_id = tree.path2id(filename)
3141
raise errors.NotVersionedError(filename)
3142
interesting_ids.add(file_id)
3143
if tree.kind(file_id) != "directory":
3146
for name, ie in tree.inventory.iter_entries(file_id):
3147
interesting_ids.add(ie.file_id)
3148
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3150
# Remerge only supports resolving contents conflicts
3151
allowed_conflicts = ('text conflict', 'contents conflict')
3152
restore_files = [c.path for c in conflicts
3153
if c.typestring in allowed_conflicts]
3154
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3155
tree.set_conflicts(ConflictList(new_conflicts))
3156
if file_list is not None:
3157
restore_files = file_list
3158
for filename in restore_files:
3160
restore(tree.abspath(filename))
3161
except errors.NotConflicted:
3163
# Disable pending merges, because the file texts we are remerging
3164
# have not had those merges performed. If we use the wrong parents
3165
# list, we imply that the working tree text has seen and rejected
3166
# all the changes from the other tree, when in fact those changes
3167
# have not yet been seen.
3168
pb = ui.ui_factory.nested_progress_bar()
3169
tree.set_parent_ids(parents[:1])
3171
merger = _mod_merge.Merger.from_revision_ids(pb,
3173
merger.interesting_ids = interesting_ids
3174
merger.merge_type = merge_type
3175
merger.show_base = show_base
3176
merger.reprocess = reprocess
3177
conflicts = merger.do_merge()
3179
tree.set_parent_ids(parents)
3189
class cmd_revert(Command):
3190
"""Revert files to a previous revision.
3192
Giving a list of files will revert only those files. Otherwise, all files
3193
will be reverted. If the revision is not specified with '--revision', the
3194
last committed revision is used.
3196
To remove only some changes, without reverting to a prior version, use
3197
merge instead. For example, "merge . --revision -2..-3" will remove the
3198
changes introduced by -2, without affecting the changes introduced by -1.
3199
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3201
By default, any files that have been manually changed will be backed up
3202
first. (Files changed only by merge are not backed up.) Backup files have
3203
'.~#~' appended to their name, where # is a number.
3205
When you provide files, you can use their current pathname or the pathname
3206
from the target revision. So you can use revert to "undelete" a file by
3207
name. If you name a directory, all the contents of that directory will be
3210
Any files that have been newly added since that revision will be deleted,
3211
with a backup kept if appropriate. Directories containing unknown files
3212
will not be deleted.
3214
The working tree contains a list of pending merged revisions, which will
3215
be included as parents in the next commit. Normally, revert clears that
3216
list as well as reverting the files. If any files are specified, revert
3217
leaves the pending merge list alone and reverts only the files. Use "bzr
3218
revert ." in the tree root to revert all files but keep the merge record,
3219
and "bzr revert --forget-merges" to clear the pending merge list without
3220
reverting any files.
3223
_see_also = ['cat', 'export']
3226
Option('no-backup', "Do not save backups of reverted files."),
3227
Option('forget-merges',
3228
'Remove pending merge marker, without changing any files.'),
3230
takes_args = ['file*']
3232
def run(self, revision=None, no_backup=False, file_list=None,
3233
forget_merges=None):
3234
tree, file_list = tree_files(file_list)
3236
tree.set_parent_ids(tree.get_parent_ids()[:1])
3238
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3241
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3242
if revision is None:
3243
rev_id = tree.last_revision()
3244
elif len(revision) != 1:
3245
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3247
rev_id = revision[0].as_revision_id(tree.branch)
3248
pb = ui.ui_factory.nested_progress_bar()
3250
tree.revert(file_list,
3251
tree.branch.repository.revision_tree(rev_id),
3252
not no_backup, pb, report_changes=True)
3257
class cmd_assert_fail(Command):
3258
"""Test reporting of assertion failures"""
3259
# intended just for use in testing
3264
raise AssertionError("always fails")
3267
class cmd_help(Command):
3268
"""Show help on a command or other topic.
3271
_see_also = ['topics']
3273
Option('long', 'Show help on all commands.'),
3275
takes_args = ['topic?']
3276
aliases = ['?', '--help', '-?', '-h']
3279
def run(self, topic=None, long=False):
3281
if topic is None and long:
3283
bzrlib.help.help(topic)
3286
class cmd_shell_complete(Command):
3287
"""Show appropriate completions for context.
3289
For a list of all available commands, say 'bzr shell-complete'.
3291
takes_args = ['context?']
3296
def run(self, context=None):
3297
import shellcomplete
3298
shellcomplete.shellcomplete(context)
3301
class cmd_missing(Command):
3302
"""Show unmerged/unpulled revisions between two branches.
3304
OTHER_BRANCH may be local or remote.
3307
_see_also = ['merge', 'pull']
3308
takes_args = ['other_branch?']
3310
Option('reverse', 'Reverse the order of revisions.'),
3312
'Display changes in the local branch only.'),
3313
Option('this' , 'Same as --mine-only.'),
3314
Option('theirs-only',
3315
'Display changes in the remote branch only.'),
3316
Option('other', 'Same as --theirs-only.'),
3321
encoding_type = 'replace'
3324
def run(self, other_branch=None, reverse=False, mine_only=False,
3325
theirs_only=False, log_format=None, long=False, short=False, line=False,
3326
show_ids=False, verbose=False, this=False, other=False):
3327
from bzrlib.missing import find_unmerged, iter_log_revisions
3333
# TODO: We should probably check that we don't have mine-only and
3334
# theirs-only set, but it gets complicated because we also have
3335
# this and other which could be used.
3342
local_branch = Branch.open_containing(u".")[0]
3343
parent = local_branch.get_parent()
3344
if other_branch is None:
3345
other_branch = parent
3346
if other_branch is None:
3347
raise errors.BzrCommandError("No peer location known"
3349
display_url = urlutils.unescape_for_display(parent,
3351
self.outf.write("Using saved parent location: "
3352
+ display_url + "\n")
3354
remote_branch = Branch.open(other_branch)
3355
if remote_branch.base == local_branch.base:
3356
remote_branch = local_branch
3357
local_branch.lock_read()
3359
remote_branch.lock_read()
3361
local_extra, remote_extra = find_unmerged(
3362
local_branch, remote_branch, restrict)
3364
if log_format is None:
3365
registry = log.log_formatter_registry
3366
log_format = registry.get_default(local_branch)
3367
lf = log_format(to_file=self.outf,
3369
show_timezone='original')
3370
if reverse is False:
3371
if local_extra is not None:
3372
local_extra.reverse()
3373
if remote_extra is not None:
3374
remote_extra.reverse()
3377
if local_extra and not theirs_only:
3378
self.outf.write("You have %d extra revision(s):\n" %
3380
for revision in iter_log_revisions(local_extra,
3381
local_branch.repository,
3383
lf.log_revision(revision)
3384
printed_local = True
3387
printed_local = False
3389
if remote_extra and not mine_only:
3390
if printed_local is True:
3391
self.outf.write("\n\n\n")
3392
self.outf.write("You are missing %d revision(s):\n" %
3394
for revision in iter_log_revisions(remote_extra,
3395
remote_branch.repository,
3397
lf.log_revision(revision)
3400
if mine_only and not local_extra:
3401
# We checked local, and found nothing extra
3402
self.outf.write('This branch is up to date.\n')
3403
elif theirs_only and not remote_extra:
3404
# We checked remote, and found nothing extra
3405
self.outf.write('Other branch is up to date.\n')
3406
elif not (mine_only or theirs_only or local_extra or
3408
# We checked both branches, and neither one had extra
3410
self.outf.write("Branches are up to date.\n")
3412
remote_branch.unlock()
3414
local_branch.unlock()
3415
if not status_code and parent is None and other_branch is not None:
3416
local_branch.lock_write()
3418
# handle race conditions - a parent might be set while we run.
3419
if local_branch.get_parent() is None:
3420
local_branch.set_parent(remote_branch.base)
3422
local_branch.unlock()
3426
class cmd_pack(Command):
3427
"""Compress the data within a repository."""
3429
_see_also = ['repositories']
3430
takes_args = ['branch_or_repo?']
3432
def run(self, branch_or_repo='.'):
3433
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3435
branch = dir.open_branch()
3436
repository = branch.repository
3437
except errors.NotBranchError:
3438
repository = dir.open_repository()
3442
class cmd_plugins(Command):
3443
"""List the installed plugins.
3445
This command displays the list of installed plugins including
3446
version of plugin and a short description of each.
3448
--verbose shows the path where each plugin is located.
3450
A plugin is an external component for Bazaar that extends the
3451
revision control system, by adding or replacing code in Bazaar.
3452
Plugins can do a variety of things, including overriding commands,
3453
adding new commands, providing additional network transports and
3454
customizing log output.
3456
See the Bazaar web site, http://bazaar-vcs.org, for further
3457
information on plugins including where to find them and how to
3458
install them. Instructions are also provided there on how to
3459
write new plugins using the Python programming language.
3461
takes_options = ['verbose']
3464
def run(self, verbose=False):
3465
import bzrlib.plugin
3466
from inspect import getdoc
3468
for name, plugin in bzrlib.plugin.plugins().items():
3469
version = plugin.__version__
3470
if version == 'unknown':
3472
name_ver = '%s %s' % (name, version)
3473
d = getdoc(plugin.module)
3475
doc = d.split('\n')[0]
3477
doc = '(no description)'
3478
result.append((name_ver, doc, plugin.path()))
3479
for name_ver, doc, path in sorted(result):
3487
class cmd_testament(Command):
3488
"""Show testament (signing-form) of a revision."""
3491
Option('long', help='Produce long-format testament.'),
3493
help='Produce a strict-format testament.')]
3494
takes_args = ['branch?']
3496
def run(self, branch=u'.', revision=None, long=False, strict=False):
3497
from bzrlib.testament import Testament, StrictTestament
3499
testament_class = StrictTestament
3501
testament_class = Testament
3503
b = Branch.open_containing(branch)[0]
3505
b = Branch.open(branch)
3508
if revision is None:
3509
rev_id = b.last_revision()
3511
rev_id = revision[0].as_revision_id(b)
3512
t = testament_class.from_revision(b.repository, rev_id)
3514
sys.stdout.writelines(t.as_text_lines())
3516
sys.stdout.write(t.as_short_text())
3521
class cmd_annotate(Command):
3522
"""Show the origin of each line in a file.
3524
This prints out the given file with an annotation on the left side
3525
indicating which revision, author and date introduced the change.
3527
If the origin is the same for a run of consecutive lines, it is
3528
shown only at the top, unless the --all option is given.
3530
# TODO: annotate directories; showing when each file was last changed
3531
# TODO: if the working copy is modified, show annotations on that
3532
# with new uncommitted lines marked
3533
aliases = ['ann', 'blame', 'praise']
3534
takes_args = ['filename']
3535
takes_options = [Option('all', help='Show annotations on all lines.'),
3536
Option('long', help='Show commit date in annotations.'),
3540
encoding_type = 'exact'
3543
def run(self, filename, all=False, long=False, revision=None,
3545
from bzrlib.annotate import annotate_file
3546
wt, branch, relpath = \
3547
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3553
if revision is None:
3554
revision_id = branch.last_revision()
3555
elif len(revision) != 1:
3556
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3558
revision_id = revision[0].as_revision_id(branch)
3559
tree = branch.repository.revision_tree(revision_id)
3561
file_id = wt.path2id(relpath)
3563
file_id = tree.path2id(relpath)
3565
raise errors.NotVersionedError(filename)
3566
file_version = tree.inventory[file_id].revision
3567
annotate_file(branch, file_version, file_id, long, all, self.outf,
3576
class cmd_re_sign(Command):
3577
"""Create a digital signature for an existing revision."""
3578
# TODO be able to replace existing ones.
3580
hidden = True # is this right ?
3581
takes_args = ['revision_id*']
3582
takes_options = ['revision']
3584
def run(self, revision_id_list=None, revision=None):
3585
if revision_id_list is not None and revision is not None:
3586
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3587
if revision_id_list is None and revision is None:
3588
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3589
b = WorkingTree.open_containing(u'.')[0].branch
3592
return self._run(b, revision_id_list, revision)
3596
def _run(self, b, revision_id_list, revision):
3597
import bzrlib.gpg as gpg
3598
gpg_strategy = gpg.GPGStrategy(b.get_config())
3599
if revision_id_list is not None:
3600
b.repository.start_write_group()
3602
for revision_id in revision_id_list:
3603
b.repository.sign_revision(revision_id, gpg_strategy)
3605
b.repository.abort_write_group()
3608
b.repository.commit_write_group()
3609
elif revision is not None:
3610
if len(revision) == 1:
3611
revno, rev_id = revision[0].in_history(b)
3612
b.repository.start_write_group()
3614
b.repository.sign_revision(rev_id, gpg_strategy)
3616
b.repository.abort_write_group()
3619
b.repository.commit_write_group()
3620
elif len(revision) == 2:
3621
# are they both on rh- if so we can walk between them
3622
# might be nice to have a range helper for arbitrary
3623
# revision paths. hmm.
3624
from_revno, from_revid = revision[0].in_history(b)
3625
to_revno, to_revid = revision[1].in_history(b)
3626
if to_revid is None:
3627
to_revno = b.revno()
3628
if from_revno is None or to_revno is None:
3629
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3630
b.repository.start_write_group()
3632
for revno in range(from_revno, to_revno + 1):
3633
b.repository.sign_revision(b.get_rev_id(revno),
3636
b.repository.abort_write_group()
3639
b.repository.commit_write_group()
3641
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3644
class cmd_bind(Command):
3645
"""Convert the current branch into a checkout of the supplied branch.
3647
Once converted into a checkout, commits must succeed on the master branch
3648
before they will be applied to the local branch.
3651
_see_also = ['checkouts', 'unbind']
3652
takes_args = ['location?']
3655
def run(self, location=None):
3656
b, relpath = Branch.open_containing(u'.')
3657
if location is None:
3659
location = b.get_old_bound_location()
3660
except errors.UpgradeRequired:
3661
raise errors.BzrCommandError('No location supplied. '
3662
'This format does not remember old locations.')
3664
if location is None:
3665
raise errors.BzrCommandError('No location supplied and no '
3666
'previous location known')
3667
b_other = Branch.open(location)
3670
except errors.DivergedBranches:
3671
raise errors.BzrCommandError('These branches have diverged.'
3672
' Try merging, and then bind again.')
3675
class cmd_unbind(Command):
3676
"""Convert the current checkout into a regular branch.
3678
After unbinding, the local branch is considered independent and subsequent
3679
commits will be local only.
3682
_see_also = ['checkouts', 'bind']
3687
b, relpath = Branch.open_containing(u'.')
3689
raise errors.BzrCommandError('Local branch is not bound')
3692
class cmd_uncommit(Command):
3693
"""Remove the last committed revision.
3695
--verbose will print out what is being removed.
3696
--dry-run will go through all the motions, but not actually
3699
If --revision is specified, uncommit revisions to leave the branch at the
3700
specified revision. For example, "bzr uncommit -r 15" will leave the
3701
branch at revision 15.
3703
Uncommit leaves the working tree ready for a new commit. The only change
3704
it may make is to restore any pending merges that were present before
3708
# TODO: jam 20060108 Add an option to allow uncommit to remove
3709
# unreferenced information in 'branch-as-repository' branches.
3710
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3711
# information in shared branches as well.
3712
_see_also = ['commit']
3713
takes_options = ['verbose', 'revision',
3714
Option('dry-run', help='Don\'t actually make changes.'),
3715
Option('force', help='Say yes to all questions.'),
3717
help="Only remove the commits from the local branch"
3718
" when in a checkout."
3721
takes_args = ['location?']
3723
encoding_type = 'replace'
3725
def run(self, location=None,
3726
dry_run=False, verbose=False,
3727
revision=None, force=False, local=False):
3728
if location is None:
3730
control, relpath = bzrdir.BzrDir.open_containing(location)
3732
tree = control.open_workingtree()
3734
except (errors.NoWorkingTree, errors.NotLocalUrl):
3736
b = control.open_branch()
3738
if tree is not None:
3743
return self._run(b, tree, dry_run, verbose, revision, force,
3746
if tree is not None:
3751
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3752
from bzrlib.log import log_formatter, show_log
3753
from bzrlib.uncommit import uncommit
3755
last_revno, last_rev_id = b.last_revision_info()
3758
if revision is None:
3760
rev_id = last_rev_id
3762
# 'bzr uncommit -r 10' actually means uncommit
3763
# so that the final tree is at revno 10.
3764
# but bzrlib.uncommit.uncommit() actually uncommits
3765
# the revisions that are supplied.
3766
# So we need to offset it by one
3767
revno = revision[0].in_history(b).revno + 1
3768
if revno <= last_revno:
3769
rev_id = b.get_rev_id(revno)
3771
if rev_id is None or _mod_revision.is_null(rev_id):
3772
self.outf.write('No revisions to uncommit.\n')
3775
lf = log_formatter('short',
3777
show_timezone='original')
3782
direction='forward',
3783
start_revision=revno,
3784
end_revision=last_revno)
3787
print 'Dry-run, pretending to remove the above revisions.'
3789
val = raw_input('Press <enter> to continue')
3791
print 'The above revision(s) will be removed.'
3793
val = raw_input('Are you sure [y/N]? ')
3794
if val.lower() not in ('y', 'yes'):
3798
mutter('Uncommitting from {%s} to {%s}',
3799
last_rev_id, rev_id)
3800
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3801
revno=revno, local=local)
3802
note('You can restore the old tip by running:\n'
3803
' bzr pull . -r revid:%s', last_rev_id)
3806
class cmd_break_lock(Command):
3807
"""Break a dead lock on a repository, branch or working directory.
3809
CAUTION: Locks should only be broken when you are sure that the process
3810
holding the lock has been stopped.
3812
You can get information on what locks are open via the 'bzr info' command.
3817
takes_args = ['location?']
3819
def run(self, location=None, show=False):
3820
if location is None:
3822
control, relpath = bzrdir.BzrDir.open_containing(location)
3824
control.break_lock()
3825
except NotImplementedError:
3829
class cmd_wait_until_signalled(Command):
3830
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3832
This just prints a line to signal when it is ready, then blocks on stdin.
3838
sys.stdout.write("running\n")
3840
sys.stdin.readline()
3843
class cmd_serve(Command):
3844
"""Run the bzr server."""
3846
aliases = ['server']
3850
help='Serve on stdin/out for use from inetd or sshd.'),
3852
help='Listen for connections on nominated port of the form '
3853
'[hostname:]portnumber. Passing 0 as the port number will '
3854
'result in a dynamically allocated port. The default port is '
3858
help='Serve contents of this directory.',
3860
Option('allow-writes',
3861
help='By default the server is a readonly server. Supplying '
3862
'--allow-writes enables write access to the contents of '
3863
'the served directory and below.'
3867
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3868
from bzrlib import lockdir
3869
from bzrlib.smart import medium, server
3870
from bzrlib.transport import get_transport
3871
from bzrlib.transport.chroot import ChrootServer
3872
if directory is None:
3873
directory = os.getcwd()
3874
url = urlutils.local_path_to_url(directory)
3875
if not allow_writes:
3876
url = 'readonly+' + url
3877
chroot_server = ChrootServer(get_transport(url))
3878
chroot_server.setUp()
3879
t = get_transport(chroot_server.get_url())
3881
smart_server = medium.SmartServerPipeStreamMedium(
3882
sys.stdin, sys.stdout, t)
3884
host = medium.BZR_DEFAULT_INTERFACE
3886
port = medium.BZR_DEFAULT_PORT
3889
host, port = port.split(':')
3891
smart_server = server.SmartTCPServer(t, host=host, port=port)
3892
print 'listening on port: ', smart_server.port
3894
# for the duration of this server, no UI output is permitted.
3895
# note that this may cause problems with blackbox tests. This should
3896
# be changed with care though, as we dont want to use bandwidth sending
3897
# progress over stderr to smart server clients!
3898
old_factory = ui.ui_factory
3899
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3901
ui.ui_factory = ui.SilentUIFactory()
3902
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3903
smart_server.serve()
3905
ui.ui_factory = old_factory
3906
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3909
class cmd_join(Command):
3910
"""Combine a subtree into its containing tree.
3912
This command is for experimental use only. It requires the target tree
3913
to be in dirstate-with-subtree format, which cannot be converted into
3916
The TREE argument should be an independent tree, inside another tree, but
3917
not part of it. (Such trees can be produced by "bzr split", but also by
3918
running "bzr branch" with the target inside a tree.)
3920
The result is a combined tree, with the subtree no longer an independant
3921
part. This is marked as a merge of the subtree into the containing tree,
3922
and all history is preserved.
3924
If --reference is specified, the subtree retains its independence. It can
3925
be branched by itself, and can be part of multiple projects at the same
3926
time. But operations performed in the containing tree, such as commit
3927
and merge, will recurse into the subtree.
3930
_see_also = ['split']
3931
takes_args = ['tree']
3933
Option('reference', help='Join by reference.'),
3937
def run(self, tree, reference=False):
3938
sub_tree = WorkingTree.open(tree)
3939
parent_dir = osutils.dirname(sub_tree.basedir)
3940
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3941
repo = containing_tree.branch.repository
3942
if not repo.supports_rich_root():
3943
raise errors.BzrCommandError(
3944
"Can't join trees because %s doesn't support rich root data.\n"
3945
"You can use bzr upgrade on the repository."
3949
containing_tree.add_reference(sub_tree)
3950
except errors.BadReferenceTarget, e:
3951
# XXX: Would be better to just raise a nicely printable
3952
# exception from the real origin. Also below. mbp 20070306
3953
raise errors.BzrCommandError("Cannot join %s. %s" %
3957
containing_tree.subsume(sub_tree)
3958
except errors.BadSubsumeSource, e:
3959
raise errors.BzrCommandError("Cannot join %s. %s" %
3963
class cmd_split(Command):
3964
"""Split a subdirectory of a tree into a separate tree.
3966
This command will produce a target tree in a format that supports
3967
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
3968
converted into earlier formats like 'dirstate-tags'.
3970
The TREE argument should be a subdirectory of a working tree. That
3971
subdirectory will be converted into an independent tree, with its own
3972
branch. Commits in the top-level tree will not apply to the new subtree.
3975
# join is not un-hidden yet
3976
#_see_also = ['join']
3977
takes_args = ['tree']
3979
def run(self, tree):
3980
containing_tree, subdir = WorkingTree.open_containing(tree)
3981
sub_id = containing_tree.path2id(subdir)
3983
raise errors.NotVersionedError(subdir)
3985
containing_tree.extract(sub_id)
3986
except errors.RootNotRich:
3987
raise errors.UpgradeRequired(containing_tree.branch.base)
3990
class cmd_merge_directive(Command):
3991
"""Generate a merge directive for auto-merge tools.
3993
A directive requests a merge to be performed, and also provides all the
3994
information necessary to do so. This means it must either include a
3995
revision bundle, or the location of a branch containing the desired
3998
A submit branch (the location to merge into) must be supplied the first
3999
time the command is issued. After it has been supplied once, it will
4000
be remembered as the default.
4002
A public branch is optional if a revision bundle is supplied, but required
4003
if --diff or --plain is specified. It will be remembered as the default
4004
after the first use.
4007
takes_args = ['submit_branch?', 'public_branch?']
4011
_see_also = ['send']
4014
RegistryOption.from_kwargs('patch-type',
4015
'The type of patch to include in the directive.',
4017
value_switches=True,
4019
bundle='Bazaar revision bundle (default).',
4020
diff='Normal unified diff.',
4021
plain='No patch, just directive.'),
4022
Option('sign', help='GPG-sign the directive.'), 'revision',
4023
Option('mail-to', type=str,
4024
help='Instead of printing the directive, email to this address.'),
4025
Option('message', type=str, short_name='m',
4026
help='Message to use when committing this merge.')
4029
encoding_type = 'exact'
4031
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4032
sign=False, revision=None, mail_to=None, message=None):
4033
from bzrlib.revision import ensure_null, NULL_REVISION
4034
include_patch, include_bundle = {
4035
'plain': (False, False),
4036
'diff': (True, False),
4037
'bundle': (True, True),
4039
branch = Branch.open('.')
4040
stored_submit_branch = branch.get_submit_branch()
4041
if submit_branch is None:
4042
submit_branch = stored_submit_branch
4044
if stored_submit_branch is None:
4045
branch.set_submit_branch(submit_branch)
4046
if submit_branch is None:
4047
submit_branch = branch.get_parent()
4048
if submit_branch is None:
4049
raise errors.BzrCommandError('No submit branch specified or known')
4051
stored_public_branch = branch.get_public_branch()
4052
if public_branch is None:
4053
public_branch = stored_public_branch
4054
elif stored_public_branch is None:
4055
branch.set_public_branch(public_branch)
4056
if not include_bundle and public_branch is None:
4057
raise errors.BzrCommandError('No public branch specified or'
4059
base_revision_id = None
4060
if revision is not None:
4061
if len(revision) > 2:
4062
raise errors.BzrCommandError('bzr merge-directive takes '
4063
'at most two one revision identifiers')
4064
revision_id = revision[-1].as_revision_id(branch)
4065
if len(revision) == 2:
4066
base_revision_id = revision[0].as_revision_id(branch)
4068
revision_id = branch.last_revision()
4069
revision_id = ensure_null(revision_id)
4070
if revision_id == NULL_REVISION:
4071
raise errors.BzrCommandError('No revisions to bundle.')
4072
directive = merge_directive.MergeDirective2.from_objects(
4073
branch.repository, revision_id, time.time(),
4074
osutils.local_time_offset(), submit_branch,
4075
public_branch=public_branch, include_patch=include_patch,
4076
include_bundle=include_bundle, message=message,
4077
base_revision_id=base_revision_id)
4080
self.outf.write(directive.to_signed(branch))
4082
self.outf.writelines(directive.to_lines())
4084
message = directive.to_email(mail_to, branch, sign)
4085
s = SMTPConnection(branch.get_config())
4086
s.send_email(message)
4089
class cmd_send(Command):
4090
"""Mail or create a merge-directive for submiting changes.
4092
A merge directive provides many things needed for requesting merges:
4094
* A machine-readable description of the merge to perform
4096
* An optional patch that is a preview of the changes requested
4098
* An optional bundle of revision data, so that the changes can be applied
4099
directly from the merge directive, without retrieving data from a
4102
If --no-bundle is specified, then public_branch is needed (and must be
4103
up-to-date), so that the receiver can perform the merge using the
4104
public_branch. The public_branch is always included if known, so that
4105
people can check it later.
4107
The submit branch defaults to the parent, but can be overridden. Both
4108
submit branch and public branch will be remembered if supplied.
4110
If a public_branch is known for the submit_branch, that public submit
4111
branch is used in the merge instructions. This means that a local mirror
4112
can be used as your actual submit branch, once you have set public_branch
4115
Mail is sent using your preferred mail program. This should be transparent
4116
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4117
If the preferred client can't be found (or used), your editor will be used.
4119
To use a specific mail program, set the mail_client configuration option.
4120
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4121
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4122
generic options are "default", "editor", "emacsclient", "mapi", and
4123
"xdg-email". Plugins may also add supported clients.
4125
If mail is being sent, a to address is required. This can be supplied
4126
either on the commandline, by setting the submit_to configuration
4127
option in the branch itself or the child_submit_to configuration option
4128
in the submit branch.
4130
Two formats are currently supported: "4" uses revision bundle format 4 and
4131
merge directive format 2. It is significantly faster and smaller than
4132
older formats. It is compatible with Bazaar 0.19 and later. It is the
4133
default. "0.9" uses revision bundle format 0.9 and merge directive
4134
format 1. It is compatible with Bazaar 0.12 - 0.18.
4136
Merge directives are applied using the merge command or the pull command.
4139
encoding_type = 'exact'
4141
_see_also = ['merge', 'pull']
4143
takes_args = ['submit_branch?', 'public_branch?']
4147
help='Do not include a bundle in the merge directive.'),
4148
Option('no-patch', help='Do not include a preview patch in the merge'
4151
help='Remember submit and public branch.'),
4153
help='Branch to generate the submission from, '
4154
'rather than the one containing the working directory.',
4157
Option('output', short_name='o',
4158
help='Write merge directive to this file; '
4159
'use - for stdout.',
4161
Option('mail-to', help='Mail the request to this address.',
4165
RegistryOption.from_kwargs('format',
4166
'Use the specified output format.',
4167
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4168
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4171
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4172
no_patch=False, revision=None, remember=False, output=None,
4173
format='4', mail_to=None, message=None, **kwargs):
4174
return self._run(submit_branch, revision, public_branch, remember,
4175
format, no_bundle, no_patch, output,
4176
kwargs.get('from', '.'), mail_to, message)
4178
def _run(self, submit_branch, revision, public_branch, remember, format,
4179
no_bundle, no_patch, output, from_, mail_to, message):
4180
from bzrlib.revision import NULL_REVISION
4181
branch = Branch.open_containing(from_)[0]
4183
outfile = StringIO()
4187
outfile = open(output, 'wb')
4188
# we may need to write data into branch's repository to calculate
4193
config = branch.get_config()
4195
mail_to = config.get_user_option('submit_to')
4196
mail_client = config.get_mail_client()
4197
if remember and submit_branch is None:
4198
raise errors.BzrCommandError(
4199
'--remember requires a branch to be specified.')
4200
stored_submit_branch = branch.get_submit_branch()
4201
remembered_submit_branch = None
4202
if submit_branch is None:
4203
submit_branch = stored_submit_branch
4204
remembered_submit_branch = "submit"
4206
if stored_submit_branch is None or remember:
4207
branch.set_submit_branch(submit_branch)
4208
if submit_branch is None:
4209
submit_branch = branch.get_parent()
4210
remembered_submit_branch = "parent"
4211
if submit_branch is None:
4212
raise errors.BzrCommandError('No submit branch known or'
4214
if remembered_submit_branch is not None:
4215
note('Using saved %s location "%s" to determine what '
4216
'changes to submit.', remembered_submit_branch,
4220
submit_config = Branch.open(submit_branch).get_config()
4221
mail_to = submit_config.get_user_option("child_submit_to")
4223
stored_public_branch = branch.get_public_branch()
4224
if public_branch is None:
4225
public_branch = stored_public_branch
4226
elif stored_public_branch is None or remember:
4227
branch.set_public_branch(public_branch)
4228
if no_bundle and public_branch is None:
4229
raise errors.BzrCommandError('No public branch specified or'
4231
base_revision_id = None
4233
if revision is not None:
4234
if len(revision) > 2:
4235
raise errors.BzrCommandError('bzr send takes '
4236
'at most two one revision identifiers')
4237
revision_id = revision[-1].as_revision_id(branch)
4238
if len(revision) == 2:
4239
base_revision_id = revision[0].as_revision_id(branch)
4240
if revision_id is None:
4241
revision_id = branch.last_revision()
4242
if revision_id == NULL_REVISION:
4243
raise errors.BzrCommandError('No revisions to submit.')
4245
directive = merge_directive.MergeDirective2.from_objects(
4246
branch.repository, revision_id, time.time(),
4247
osutils.local_time_offset(), submit_branch,
4248
public_branch=public_branch, include_patch=not no_patch,
4249
include_bundle=not no_bundle, message=message,
4250
base_revision_id=base_revision_id)
4251
elif format == '0.9':
4254
patch_type = 'bundle'
4256
raise errors.BzrCommandError('Format 0.9 does not'
4257
' permit bundle with no patch')
4263
directive = merge_directive.MergeDirective.from_objects(
4264
branch.repository, revision_id, time.time(),
4265
osutils.local_time_offset(), submit_branch,
4266
public_branch=public_branch, patch_type=patch_type,
4269
outfile.writelines(directive.to_lines())
4271
subject = '[MERGE] '
4272
if message is not None:
4275
revision = branch.repository.get_revision(revision_id)
4276
subject += revision.get_summary()
4277
basename = directive.get_disk_name(branch)
4278
mail_client.compose_merge_request(mail_to, subject,
4279
outfile.getvalue(), basename)
4286
class cmd_bundle_revisions(cmd_send):
4288
"""Create a merge-directive for submiting changes.
4290
A merge directive provides many things needed for requesting merges:
4292
* A machine-readable description of the merge to perform
4294
* An optional patch that is a preview of the changes requested
4296
* An optional bundle of revision data, so that the changes can be applied
4297
directly from the merge directive, without retrieving data from a
4300
If --no-bundle is specified, then public_branch is needed (and must be
4301
up-to-date), so that the receiver can perform the merge using the
4302
public_branch. The public_branch is always included if known, so that
4303
people can check it later.
4305
The submit branch defaults to the parent, but can be overridden. Both
4306
submit branch and public branch will be remembered if supplied.
4308
If a public_branch is known for the submit_branch, that public submit
4309
branch is used in the merge instructions. This means that a local mirror
4310
can be used as your actual submit branch, once you have set public_branch
4313
Two formats are currently supported: "4" uses revision bundle format 4 and
4314
merge directive format 2. It is significantly faster and smaller than
4315
older formats. It is compatible with Bazaar 0.19 and later. It is the
4316
default. "0.9" uses revision bundle format 0.9 and merge directive
4317
format 1. It is compatible with Bazaar 0.12 - 0.18.
4322
help='Do not include a bundle in the merge directive.'),
4323
Option('no-patch', help='Do not include a preview patch in the merge'
4326
help='Remember submit and public branch.'),
4328
help='Branch to generate the submission from, '
4329
'rather than the one containing the working directory.',
4332
Option('output', short_name='o', help='Write directive to this file.',
4335
RegistryOption.from_kwargs('format',
4336
'Use the specified output format.',
4337
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4338
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4340
aliases = ['bundle']
4342
_see_also = ['send', 'merge']
4346
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4347
no_patch=False, revision=None, remember=False, output=None,
4348
format='4', **kwargs):
4351
return self._run(submit_branch, revision, public_branch, remember,
4352
format, no_bundle, no_patch, output,
4353
kwargs.get('from', '.'), None, None)
4356
class cmd_tag(Command):
4357
"""Create, remove or modify a tag naming a revision.
4359
Tags give human-meaningful names to revisions. Commands that take a -r
4360
(--revision) option can be given -rtag:X, where X is any previously
4363
Tags are stored in the branch. Tags are copied from one branch to another
4364
along when you branch, push, pull or merge.
4366
It is an error to give a tag name that already exists unless you pass
4367
--force, in which case the tag is moved to point to the new revision.
4369
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4370
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4373
_see_also = ['commit', 'tags']
4374
takes_args = ['tag_name']
4377
help='Delete this tag rather than placing it.',
4380
help='Branch in which to place the tag.',
4385
help='Replace existing tags.',
4390
def run(self, tag_name,
4396
branch, relpath = Branch.open_containing(directory)
4400
branch.tags.delete_tag(tag_name)
4401
self.outf.write('Deleted tag %s.\n' % tag_name)
4404
if len(revision) != 1:
4405
raise errors.BzrCommandError(
4406
"Tags can only be placed on a single revision, "
4408
revision_id = revision[0].as_revision_id(branch)
4410
revision_id = branch.last_revision()
4411
if (not force) and branch.tags.has_tag(tag_name):
4412
raise errors.TagAlreadyExists(tag_name)
4413
branch.tags.set_tag(tag_name, revision_id)
4414
self.outf.write('Created tag %s.\n' % tag_name)
4419
class cmd_tags(Command):
4422
This command shows a table of tag names and the revisions they reference.
4428
help='Branch whose tags should be displayed.',
4432
RegistryOption.from_kwargs('sort',
4433
'Sort tags by different criteria.', title='Sorting',
4434
alpha='Sort tags lexicographically (default).',
4435
time='Sort tags chronologically.',
4446
branch, relpath = Branch.open_containing(directory)
4447
tags = branch.tags.get_tag_dict().items()
4452
elif sort == 'time':
4454
for tag, revid in tags:
4456
revobj = branch.repository.get_revision(revid)
4457
except errors.NoSuchRevision:
4458
timestamp = sys.maxint # place them at the end
4460
timestamp = revobj.timestamp
4461
timestamps[revid] = timestamp
4462
tags.sort(key=lambda x: timestamps[x[1]])
4464
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4465
revno_map = branch.get_revision_id_to_revno_map()
4466
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4467
for tag, revid in tags ]
4468
for tag, revspec in tags:
4469
self.outf.write('%-20s %s\n' % (tag, revspec))
4472
class cmd_reconfigure(Command):
4473
"""Reconfigure the type of a bzr directory.
4475
A target configuration must be specified.
4477
For checkouts, the bind-to location will be auto-detected if not specified.
4478
The order of preference is
4479
1. For a lightweight checkout, the current bound location.
4480
2. For branches that used to be checkouts, the previously-bound location.
4481
3. The push location.
4482
4. The parent location.
4483
If none of these is available, --bind-to must be specified.
4486
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4487
takes_args = ['location?']
4488
takes_options = [RegistryOption.from_kwargs('target_type',
4489
title='Target type',
4490
help='The type to reconfigure the directory to.',
4491
value_switches=True, enum_switch=False,
4492
branch='Reconfigure to be an unbound branch '
4493
'with no working tree.',
4494
tree='Reconfigure to be an unbound branch '
4495
'with a working tree.',
4496
checkout='Reconfigure to be a bound branch '
4497
'with a working tree.',
4498
lightweight_checkout='Reconfigure to be a lightweight'
4499
' checkout (with no local history).',
4500
standalone='Reconfigure to be a standalone branch '
4501
'(i.e. stop using shared repository).',
4502
use_shared='Reconfigure to use a shared repository.'),
4503
Option('bind-to', help='Branch to bind checkout to.',
4506
help='Perform reconfiguration even if local changes'
4510
def run(self, location=None, target_type=None, bind_to=None, force=False):
4511
directory = bzrdir.BzrDir.open(location)
4512
if target_type is None:
4513
raise errors.BzrCommandError('No target configuration specified')
4514
elif target_type == 'branch':
4515
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4516
elif target_type == 'tree':
4517
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4518
elif target_type == 'checkout':
4519
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4521
elif target_type == 'lightweight-checkout':
4522
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4524
elif target_type == 'use-shared':
4525
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4526
elif target_type == 'standalone':
4527
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4528
reconfiguration.apply(force)
4531
class cmd_switch(Command):
4532
"""Set the branch of a checkout and update.
4534
For lightweight checkouts, this changes the branch being referenced.
4535
For heavyweight checkouts, this checks that there are no local commits
4536
versus the current bound branch, then it makes the local branch a mirror
4537
of the new location and binds to it.
4539
In both cases, the working tree is updated and uncommitted changes
4540
are merged. The user can commit or revert these as they desire.
4542
Pending merges need to be committed or reverted before using switch.
4544
The path to the branch to switch to can be specified relative to the parent
4545
directory of the current branch. For example, if you are currently in a
4546
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4550
takes_args = ['to_location']
4551
takes_options = [Option('force',
4552
help='Switch even if local commits will be lost.')
4555
def run(self, to_location, force=False):
4556
from bzrlib import switch
4558
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4560
to_branch = Branch.open(to_location)
4561
except errors.NotBranchError:
4562
to_branch = Branch.open(
4563
control_dir.open_branch().base + '../' + to_location)
4564
switch.switch(control_dir, to_branch, force)
4565
note('Switched to branch: %s',
4566
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4569
class cmd_hooks(Command):
4570
"""Show a branch's currently registered hooks.
4574
takes_args = ['path?']
4576
def run(self, path=None):
4579
branch_hooks = Branch.open(path).hooks
4580
for hook_type in branch_hooks:
4581
hooks = branch_hooks[hook_type]
4582
self.outf.write("%s:\n" % (hook_type,))
4585
self.outf.write(" %s\n" %
4586
(branch_hooks.get_hook_name(hook),))
4588
self.outf.write(" <no hooks installed>\n")
4591
def _create_prefix(cur_transport):
4592
needed = [cur_transport]
4593
# Recurse upwards until we can create a directory successfully
4595
new_transport = cur_transport.clone('..')
4596
if new_transport.base == cur_transport.base:
4597
raise errors.BzrCommandError(
4598
"Failed to create path prefix for %s."
4599
% cur_transport.base)
4601
new_transport.mkdir('.')
4602
except errors.NoSuchFile:
4603
needed.append(new_transport)
4604
cur_transport = new_transport
4607
# Now we only need to create child directories
4609
cur_transport = needed.pop()
4610
cur_transport.ensure_base()
4613
# these get imported and then picked up by the scan for cmd_*
4614
# TODO: Some more consistent way to split command definitions across files;
4615
# we do need to load at least some information about them to know of
4616
# aliases. ideally we would avoid loading the implementation until the
4617
# details were needed.
4618
from bzrlib.cmd_version_info import cmd_version_info
4619
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4620
from bzrlib.bundle.commands import (
4623
from bzrlib.sign_my_commits import cmd_sign_my_commits
4624
from bzrlib.weave_commands import cmd_versionedfile_list, \
4625
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
