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)
229
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
230
elif revision is not None:
233
raise errors.BzrCommandError('You cannot specify a NULL'
235
rev_id = rev.as_revision_id(b)
236
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
239
class cmd_remove_tree(Command):
240
"""Remove the working tree from a given branch/checkout.
242
Since a lightweight checkout is little more than a working tree
243
this will refuse to run against one.
245
To re-create the working tree, use "bzr checkout".
247
_see_also = ['checkout', 'working-trees']
249
takes_args = ['location?']
251
def run(self, location='.'):
252
d = bzrdir.BzrDir.open(location)
255
working = d.open_workingtree()
256
except errors.NoWorkingTree:
257
raise errors.BzrCommandError("No working tree to remove")
258
except errors.NotLocalUrl:
259
raise errors.BzrCommandError("You cannot remove the working tree of a "
262
working_path = working.bzrdir.root_transport.base
263
branch_path = working.branch.bzrdir.root_transport.base
264
if working_path != branch_path:
265
raise errors.BzrCommandError("You cannot remove the working tree from "
266
"a lightweight checkout")
268
d.destroy_workingtree()
271
class cmd_revno(Command):
272
"""Show current revision number.
274
This is equal to the number of revisions on this branch.
278
takes_args = ['location?']
281
def run(self, location=u'.'):
282
self.outf.write(str(Branch.open_containing(location)[0].revno()))
283
self.outf.write('\n')
286
class cmd_revision_info(Command):
287
"""Show revision number and revision id for a given revision identifier.
290
takes_args = ['revision_info*']
291
takes_options = ['revision']
294
def run(self, revision=None, revision_info_list=[]):
297
if revision is not None:
298
revs.extend(revision)
299
if revision_info_list is not None:
300
for rev in revision_info_list:
301
revs.append(RevisionSpec.from_string(rev))
303
b = Branch.open_containing(u'.')[0]
306
revs.append(RevisionSpec.from_string('-1'))
309
revision_id = rev.as_revision_id(b)
311
revno = '%4d' % (b.revision_id_to_revno(revision_id))
312
except errors.NoSuchRevision:
313
dotted_map = b.get_revision_id_to_revno_map()
314
revno = '.'.join(str(i) for i in dotted_map[revision_id])
315
print '%s %s' % (revno, revision_id)
318
class cmd_add(Command):
319
"""Add specified files or directories.
321
In non-recursive mode, all the named items are added, regardless
322
of whether they were previously ignored. A warning is given if
323
any of the named files are already versioned.
325
In recursive mode (the default), files are treated the same way
326
but the behaviour for directories is different. Directories that
327
are already versioned do not give a warning. All directories,
328
whether already versioned or not, are searched for files or
329
subdirectories that are neither versioned or ignored, and these
330
are added. This search proceeds recursively into versioned
331
directories. If no names are given '.' is assumed.
333
Therefore simply saying 'bzr add' will version all files that
334
are currently unknown.
336
Adding a file whose parent directory is not versioned will
337
implicitly add the parent, and so on up to the root. This means
338
you should never need to explicitly add a directory, they'll just
339
get added when you add a file in the directory.
341
--dry-run will show which files would be added, but not actually
344
--file-ids-from will try to use the file ids from the supplied path.
345
It looks up ids trying to find a matching parent directory with the
346
same filename, and then by pure path. This option is rarely needed
347
but can be useful when adding the same logical file into two
348
branches that will be merged later (without showing the two different
349
adds as a conflict). It is also useful when merging another project
350
into a subdirectory of this one.
352
takes_args = ['file*']
355
help="Don't recursively add the contents of directories."),
357
help="Show what would be done, but don't actually do anything."),
359
Option('file-ids-from',
361
help='Lookup file ids from this tree.'),
363
encoding_type = 'replace'
364
_see_also = ['remove']
366
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
371
if file_ids_from is not None:
373
base_tree, base_path = WorkingTree.open_containing(
375
except errors.NoWorkingTree:
376
base_branch, base_path = Branch.open_containing(
378
base_tree = base_branch.basis_tree()
380
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
381
to_file=self.outf, should_print=(not is_quiet()))
383
action = bzrlib.add.AddAction(to_file=self.outf,
384
should_print=(not is_quiet()))
387
base_tree.lock_read()
389
file_list = self._maybe_expand_globs(file_list)
391
tree = WorkingTree.open_containing(file_list[0])[0]
393
tree = WorkingTree.open_containing(u'.')[0]
394
added, ignored = tree.smart_add(file_list, not
395
no_recurse, action=action, save=not dry_run)
397
if base_tree is not None:
401
for glob in sorted(ignored.keys()):
402
for path in ignored[glob]:
403
self.outf.write("ignored %s matching \"%s\"\n"
407
for glob, paths in ignored.items():
408
match_len += len(paths)
409
self.outf.write("ignored %d file(s).\n" % match_len)
410
self.outf.write("If you wish to add some of these files,"
411
" please add them by name.\n")
414
class cmd_mkdir(Command):
415
"""Create a new versioned directory.
417
This is equivalent to creating the directory and then adding it.
420
takes_args = ['dir+']
421
encoding_type = 'replace'
423
def run(self, dir_list):
426
wt, dd = WorkingTree.open_containing(d)
428
self.outf.write('added %s\n' % d)
431
class cmd_relpath(Command):
432
"""Show path of a file relative to root"""
434
takes_args = ['filename']
438
def run(self, filename):
439
# TODO: jam 20050106 Can relpath return a munged path if
440
# sys.stdout encoding cannot represent it?
441
tree, relpath = WorkingTree.open_containing(filename)
442
self.outf.write(relpath)
443
self.outf.write('\n')
446
class cmd_inventory(Command):
447
"""Show inventory of the current working copy or a revision.
449
It is possible to limit the output to a particular entry
450
type using the --kind option. For example: --kind file.
452
It is also possible to restrict the list of files to a specific
453
set. For example: bzr inventory --show-ids this/file
462
help='List entries of a particular kind: file, directory, symlink.',
465
takes_args = ['file*']
468
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
469
if kind and kind not in ['file', 'directory', 'symlink']:
470
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
472
work_tree, file_list = tree_files(file_list)
473
work_tree.lock_read()
475
if revision is not None:
476
if len(revision) > 1:
477
raise errors.BzrCommandError(
478
'bzr inventory --revision takes exactly one revision'
480
revision_id = revision[0].as_revision_id(work_tree.branch)
481
tree = work_tree.branch.repository.revision_tree(revision_id)
483
extra_trees = [work_tree]
489
if file_list is not None:
490
file_ids = tree.paths2ids(file_list, trees=extra_trees,
491
require_versioned=True)
492
# find_ids_across_trees may include some paths that don't
494
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
495
for file_id in file_ids if file_id in tree)
497
entries = tree.inventory.entries()
500
if tree is not work_tree:
503
for path, entry in entries:
504
if kind and kind != entry.kind:
507
self.outf.write('%-50s %s\n' % (path, entry.file_id))
509
self.outf.write(path)
510
self.outf.write('\n')
513
class cmd_mv(Command):
514
"""Move or rename a file.
517
bzr mv OLDNAME NEWNAME
519
bzr mv SOURCE... DESTINATION
521
If the last argument is a versioned directory, all the other names
522
are moved into it. Otherwise, there must be exactly two arguments
523
and the file is changed to a new name.
525
If OLDNAME does not exist on the filesystem but is versioned and
526
NEWNAME does exist on the filesystem but is not versioned, mv
527
assumes that the file has been manually moved and only updates
528
its internal inventory to reflect that change.
529
The same is valid when moving many SOURCE files to a DESTINATION.
531
Files cannot be moved between branches.
534
takes_args = ['names*']
535
takes_options = [Option("after", help="Move only the bzr identifier"
536
" of the file, because the file has already been moved."),
538
aliases = ['move', 'rename']
539
encoding_type = 'replace'
541
def run(self, names_list, after=False):
542
if names_list is None:
545
if len(names_list) < 2:
546
raise errors.BzrCommandError("missing file argument")
547
tree, rel_names = tree_files(names_list)
550
self._run(tree, names_list, rel_names, after)
554
def _run(self, tree, names_list, rel_names, after):
555
into_existing = osutils.isdir(names_list[-1])
556
if into_existing and len(names_list) == 2:
558
# a. case-insensitive filesystem and change case of dir
559
# b. move directory after the fact (if the source used to be
560
# a directory, but now doesn't exist in the working tree
561
# and the target is an existing directory, just rename it)
562
if (not tree.case_sensitive
563
and rel_names[0].lower() == rel_names[1].lower()):
564
into_existing = False
567
from_id = tree.path2id(rel_names[0])
568
if (not osutils.lexists(names_list[0]) and
569
from_id and inv.get_file_kind(from_id) == "directory"):
570
into_existing = False
573
# move into existing directory
574
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
575
self.outf.write("%s => %s\n" % pair)
577
if len(names_list) != 2:
578
raise errors.BzrCommandError('to mv multiple files the'
579
' destination must be a versioned'
581
tree.rename_one(rel_names[0], rel_names[1], after=after)
582
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
585
class cmd_pull(Command):
586
"""Turn this branch into a mirror of another branch.
588
This command only works on branches that have not diverged. Branches are
589
considered diverged if the destination branch's most recent commit is one
590
that has not been merged (directly or indirectly) into the parent.
592
If branches have diverged, you can use 'bzr merge' to integrate the changes
593
from one into the other. Once one branch has merged, the other should
594
be able to pull it again.
596
If you want to forget your local changes and just update your branch to
597
match the remote one, use pull --overwrite.
599
If there is no default location set, the first pull will set it. After
600
that, you can omit the location to use the default. To change the
601
default, use --remember. The value will only be saved if the remote
602
location can be accessed.
604
Note: The location can be specified either in the form of a branch,
605
or in the form of a path to a file containing a merge directive generated
609
_see_also = ['push', 'update', 'status-flags']
610
takes_options = ['remember', 'overwrite', 'revision',
611
custom_help('verbose',
612
help='Show logs of pulled revisions.'),
614
help='Branch to pull into, '
615
'rather than the one containing the working directory.',
620
takes_args = ['location?']
621
encoding_type = 'replace'
623
def run(self, location=None, remember=False, overwrite=False,
624
revision=None, verbose=False,
626
# FIXME: too much stuff is in the command class
629
if directory is None:
632
tree_to = WorkingTree.open_containing(directory)[0]
633
branch_to = tree_to.branch
634
except errors.NoWorkingTree:
636
branch_to = Branch.open_containing(directory)[0]
638
possible_transports = []
639
if location is not None:
641
mergeable = bundle.read_mergeable_from_url(location,
642
possible_transports=possible_transports)
643
except errors.NotABundle:
646
stored_loc = branch_to.get_parent()
648
if stored_loc is None:
649
raise errors.BzrCommandError("No pull location known or"
652
display_url = urlutils.unescape_for_display(stored_loc,
655
self.outf.write("Using saved parent location: %s\n" % display_url)
656
location = stored_loc
658
if mergeable is not None:
659
if revision is not None:
660
raise errors.BzrCommandError(
661
'Cannot use -r with merge directives or bundles')
662
mergeable.install_revisions(branch_to.repository)
663
base_revision_id, revision_id, verified = \
664
mergeable.get_merge_request(branch_to.repository)
665
branch_from = branch_to
667
branch_from = Branch.open(location,
668
possible_transports=possible_transports)
670
if branch_to.get_parent() is None or remember:
671
branch_to.set_parent(branch_from.base)
673
if revision is not None:
674
if len(revision) == 1:
675
revision_id = revision[0].as_revision_id(branch_from)
677
raise errors.BzrCommandError(
678
'bzr pull --revision takes one value.')
680
branch_to.lock_write()
682
if tree_to is not None:
683
change_reporter = delta._ChangeReporter(
684
unversioned_filter=tree_to.is_ignored)
685
result = tree_to.pull(branch_from, overwrite, revision_id,
687
possible_transports=possible_transports)
689
result = branch_to.pull(branch_from, overwrite, revision_id)
691
result.report(self.outf)
692
if verbose and result.old_revid != result.new_revid:
694
branch_to.repository.iter_reverse_revision_history(
697
new_rh = branch_to.revision_history()
698
log.show_changed_revisions(branch_to, old_rh, new_rh,
704
class cmd_push(Command):
705
"""Update a mirror of this branch.
707
The target branch will not have its working tree populated because this
708
is both expensive, and is not supported on remote file systems.
710
Some smart servers or protocols *may* put the working tree in place in
713
This command only works on branches that have not diverged. Branches are
714
considered diverged if the destination branch's most recent commit is one
715
that has not been merged (directly or indirectly) by the source branch.
717
If branches have diverged, you can use 'bzr push --overwrite' to replace
718
the other branch completely, discarding its unmerged changes.
720
If you want to ensure you have the different changes in the other branch,
721
do a merge (see bzr help merge) from the other branch, and commit that.
722
After that you will be able to do a push without '--overwrite'.
724
If there is no default push location set, the first push will set it.
725
After that, you can omit the location to use the default. To change the
726
default, use --remember. The value will only be saved if the remote
727
location can be accessed.
730
_see_also = ['pull', 'update', 'working-trees']
731
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
732
Option('create-prefix',
733
help='Create the path leading up to the branch '
734
'if it does not already exist.'),
736
help='Branch to push from, '
737
'rather than the one containing the working directory.',
741
Option('use-existing-dir',
742
help='By default push will fail if the target'
743
' directory exists, but does not already'
744
' have a control directory. This flag will'
745
' allow push to proceed.'),
747
help='Create a stacked branch that references the public location '
748
'of the parent branch.'),
750
help='Create a stacked branch that refers to another branch '
751
'for the commit history. Only the work not present in the '
752
'referenced branch is included in the branch created.',
755
takes_args = ['location?']
756
encoding_type = 'replace'
758
def run(self, location=None, remember=False, overwrite=False,
759
create_prefix=False, verbose=False, revision=None,
760
use_existing_dir=False, directory=None, stacked_on=None,
762
from bzrlib.push import _show_push_branch
764
# Get the source branch and revision_id
765
if directory is None:
767
br_from = Branch.open_containing(directory)[0]
768
if revision is not None:
769
if len(revision) == 1:
770
revision_id = revision[0].in_history(br_from).rev_id
772
raise errors.BzrCommandError(
773
'bzr push --revision takes one value.')
775
revision_id = br_from.last_revision()
777
# Get the stacked_on branch, if any
778
if stacked_on is not None:
779
stacked_on = urlutils.normalize_url(stacked_on)
781
parent_url = br_from.get_parent()
783
parent = Branch.open(parent_url)
784
stacked_on = parent.get_public_branch()
786
# I considered excluding non-http url's here, thus forcing
787
# 'public' branches only, but that only works for some
788
# users, so it's best to just depend on the user spotting an
789
# error by the feedback given to them. RBC 20080227.
790
stacked_on = parent_url
792
raise errors.BzrCommandError(
793
"Could not determine branch to refer to.")
795
# Get the destination location
797
stored_loc = br_from.get_push_location()
798
if stored_loc is None:
799
raise errors.BzrCommandError(
800
"No push location known or specified.")
802
display_url = urlutils.unescape_for_display(stored_loc,
804
self.outf.write("Using saved push location: %s\n" % display_url)
805
location = stored_loc
807
_show_push_branch(br_from, revision_id, location, self.outf,
808
verbose=verbose, overwrite=overwrite, remember=remember,
809
stacked_on=stacked_on, create_prefix=create_prefix,
810
use_existing_dir=use_existing_dir)
813
class cmd_branch(Command):
814
"""Create a new copy of a branch.
816
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
817
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
818
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
819
is derived from the FROM_LOCATION by stripping a leading scheme or drive
820
identifier, if any. For example, "branch lp:foo-bar" will attempt to
823
To retrieve the branch as of a particular revision, supply the --revision
824
parameter, as in "branch foo/bar -r 5".
827
_see_also = ['checkout']
828
takes_args = ['from_location', 'to_location?']
829
takes_options = ['revision', Option('hardlink',
830
help='Hard-link working tree files where possible.'),
832
help='Create a stacked branch referring to the source branch. '
833
'The new branch will depend on the availability of the source '
834
'branch for all operations.'),
836
aliases = ['get', 'clone']
838
def run(self, from_location, to_location=None, revision=None,
839
hardlink=False, stacked=False):
840
from bzrlib.tag import _merge_tags_if_possible
843
elif len(revision) > 1:
844
raise errors.BzrCommandError(
845
'bzr branch --revision takes exactly 1 revision value')
847
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
851
if len(revision) == 1 and revision[0] is not None:
852
revision_id = revision[0].as_revision_id(br_from)
854
# FIXME - wt.last_revision, fallback to branch, fall back to
855
# None or perhaps NULL_REVISION to mean copy nothing
857
revision_id = br_from.last_revision()
858
if to_location is None:
859
to_location = urlutils.derive_to_location(from_location)
860
to_transport = transport.get_transport(to_location)
862
to_transport.mkdir('.')
863
except errors.FileExists:
864
raise errors.BzrCommandError('Target directory "%s" already'
865
' exists.' % to_location)
866
except errors.NoSuchFile:
867
raise errors.BzrCommandError('Parent of "%s" does not exist.'
870
# preserve whatever source format we have.
871
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
872
possible_transports=[to_transport],
873
accelerator_tree=accelerator_tree,
874
hardlink=hardlink, stacked=stacked)
875
branch = dir.open_branch()
876
except errors.NoSuchRevision:
877
to_transport.delete_tree('.')
878
msg = "The branch %s has no revision %s." % (from_location,
880
raise errors.BzrCommandError(msg)
881
_merge_tags_if_possible(br_from, branch)
882
# If the source branch is stacked, the new branch may
883
# be stacked whether we asked for that explicitly or not.
884
# We therefore need a try/except here and not just 'if stacked:'
886
note('Created new stacked branch referring to %s.' %
887
branch.get_stacked_on_url())
888
except (errors.NotStacked, errors.UnstackableBranchFormat,
889
errors.UnstackableRepositoryFormat), e:
890
note('Branched %d revision(s).' % branch.revno())
895
class cmd_checkout(Command):
896
"""Create a new checkout of an existing branch.
898
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
899
the branch found in '.'. This is useful if you have removed the working tree
900
or if it was never created - i.e. if you pushed the branch to its current
903
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
904
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
905
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
906
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
907
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
910
To retrieve the branch as of a particular revision, supply the --revision
911
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
912
out of date [so you cannot commit] but it may be useful (i.e. to examine old
916
_see_also = ['checkouts', 'branch']
917
takes_args = ['branch_location?', 'to_location?']
918
takes_options = ['revision',
919
Option('lightweight',
920
help="Perform a lightweight checkout. Lightweight "
921
"checkouts depend on access to the branch for "
922
"every operation. Normal checkouts can perform "
923
"common operations like diff and status without "
924
"such access, and also support local commits."
926
Option('files-from', type=str,
927
help="Get file contents from this tree."),
929
help='Hard-link working tree files where possible.'
934
def run(self, branch_location=None, to_location=None, revision=None,
935
lightweight=False, files_from=None, hardlink=False):
938
elif len(revision) > 1:
939
raise errors.BzrCommandError(
940
'bzr checkout --revision takes exactly 1 revision value')
941
if branch_location is None:
942
branch_location = osutils.getcwd()
943
to_location = branch_location
944
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
946
if files_from is not None:
947
accelerator_tree = WorkingTree.open(files_from)
948
if len(revision) == 1 and revision[0] is not None:
949
revision_id = revision[0].as_revision_id(source)
952
if to_location is None:
953
to_location = urlutils.derive_to_location(branch_location)
954
# if the source and to_location are the same,
955
# and there is no working tree,
956
# then reconstitute a branch
957
if (osutils.abspath(to_location) ==
958
osutils.abspath(branch_location)):
960
source.bzrdir.open_workingtree()
961
except errors.NoWorkingTree:
962
source.bzrdir.create_workingtree(revision_id)
964
source.create_checkout(to_location, revision_id, lightweight,
965
accelerator_tree, hardlink)
968
class cmd_renames(Command):
969
"""Show list of renamed files.
971
# TODO: Option to show renames between two historical versions.
973
# TODO: Only show renames under dir, rather than in the whole branch.
974
_see_also = ['status']
975
takes_args = ['dir?']
978
def run(self, dir=u'.'):
979
tree = WorkingTree.open_containing(dir)[0]
982
new_inv = tree.inventory
983
old_tree = tree.basis_tree()
986
old_inv = old_tree.inventory
987
renames = list(_mod_tree.find_renames(old_inv, new_inv))
989
for old_name, new_name in renames:
990
self.outf.write("%s => %s\n" % (old_name, new_name))
997
class cmd_update(Command):
998
"""Update a tree to have the latest code committed to its branch.
1000
This will perform a merge into the working tree, and may generate
1001
conflicts. If you have any local changes, you will still
1002
need to commit them after the update for the update to be complete.
1004
If you want to discard your local changes, you can just do a
1005
'bzr revert' instead of 'bzr commit' after the update.
1008
_see_also = ['pull', 'working-trees', 'status-flags']
1009
takes_args = ['dir?']
1012
def run(self, dir='.'):
1013
tree = WorkingTree.open_containing(dir)[0]
1014
possible_transports = []
1015
master = tree.branch.get_master_branch(
1016
possible_transports=possible_transports)
1017
if master is not None:
1020
tree.lock_tree_write()
1022
existing_pending_merges = tree.get_parent_ids()[1:]
1023
last_rev = _mod_revision.ensure_null(tree.last_revision())
1024
if last_rev == _mod_revision.ensure_null(
1025
tree.branch.last_revision()):
1026
# may be up to date, check master too.
1027
if master is None or last_rev == _mod_revision.ensure_null(
1028
master.last_revision()):
1029
revno = tree.branch.revision_id_to_revno(last_rev)
1030
note("Tree is up to date at revision %d." % (revno,))
1032
conflicts = tree.update(
1033
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1034
possible_transports=possible_transports)
1035
revno = tree.branch.revision_id_to_revno(
1036
_mod_revision.ensure_null(tree.last_revision()))
1037
note('Updated to revision %d.' % (revno,))
1038
if tree.get_parent_ids()[1:] != existing_pending_merges:
1039
note('Your local commits will now show as pending merges with '
1040
"'bzr status', and can be committed with 'bzr commit'.")
1049
class cmd_info(Command):
1050
"""Show information about a working tree, branch or repository.
1052
This command will show all known locations and formats associated to the
1053
tree, branch or repository. Statistical information is included with
1056
Branches and working trees will also report any missing revisions.
1058
_see_also = ['revno', 'working-trees', 'repositories']
1059
takes_args = ['location?']
1060
takes_options = ['verbose']
1061
encoding_type = 'replace'
1064
def run(self, location=None, verbose=False):
1069
from bzrlib.info import show_bzrdir_info
1070
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1071
verbose=noise_level, outfile=self.outf)
1074
class cmd_remove(Command):
1075
"""Remove files or directories.
1077
This makes bzr stop tracking changes to the specified files. bzr will delete
1078
them if they can easily be recovered using revert. If no options or
1079
parameters are given bzr will scan for files that are being tracked by bzr
1080
but missing in your tree and stop tracking them for you.
1082
takes_args = ['file*']
1083
takes_options = ['verbose',
1084
Option('new', help='Only remove files that have never been committed.'),
1085
RegistryOption.from_kwargs('file-deletion-strategy',
1086
'The file deletion mode to be used.',
1087
title='Deletion Strategy', value_switches=True, enum_switch=False,
1088
safe='Only delete files if they can be'
1089
' safely recovered (default).',
1090
keep="Don't delete any files.",
1091
force='Delete all the specified files, even if they can not be '
1092
'recovered and even if they are non-empty directories.')]
1093
aliases = ['rm', 'del']
1094
encoding_type = 'replace'
1096
def run(self, file_list, verbose=False, new=False,
1097
file_deletion_strategy='safe'):
1098
tree, file_list = tree_files(file_list)
1100
if file_list is not None:
1101
file_list = [f for f in file_list]
1105
# Heuristics should probably all move into tree.remove_smart or
1108
added = tree.changes_from(tree.basis_tree(),
1109
specific_files=file_list).added
1110
file_list = sorted([f[0] for f in added], reverse=True)
1111
if len(file_list) == 0:
1112
raise errors.BzrCommandError('No matching files.')
1113
elif file_list is None:
1114
# missing files show up in iter_changes(basis) as
1115
# versioned-with-no-kind.
1117
for change in tree.iter_changes(tree.basis_tree()):
1118
# Find paths in the working tree that have no kind:
1119
if change[1][1] is not None and change[6][1] is None:
1120
missing.append(change[1][1])
1121
file_list = sorted(missing, reverse=True)
1122
file_deletion_strategy = 'keep'
1123
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1124
keep_files=file_deletion_strategy=='keep',
1125
force=file_deletion_strategy=='force')
1130
class cmd_file_id(Command):
1131
"""Print file_id of a particular file or directory.
1133
The file_id is assigned when the file is first added and remains the
1134
same through all revisions where the file exists, even when it is
1139
_see_also = ['inventory', 'ls']
1140
takes_args = ['filename']
1143
def run(self, filename):
1144
tree, relpath = WorkingTree.open_containing(filename)
1145
i = tree.path2id(relpath)
1147
raise errors.NotVersionedError(filename)
1149
self.outf.write(i + '\n')
1152
class cmd_file_path(Command):
1153
"""Print path of file_ids to a file or directory.
1155
This prints one line for each directory down to the target,
1156
starting at the branch root.
1160
takes_args = ['filename']
1163
def run(self, filename):
1164
tree, relpath = WorkingTree.open_containing(filename)
1165
fid = tree.path2id(relpath)
1167
raise errors.NotVersionedError(filename)
1168
segments = osutils.splitpath(relpath)
1169
for pos in range(1, len(segments) + 1):
1170
path = osutils.joinpath(segments[:pos])
1171
self.outf.write("%s\n" % tree.path2id(path))
1174
class cmd_reconcile(Command):
1175
"""Reconcile bzr metadata in a branch.
1177
This can correct data mismatches that may have been caused by
1178
previous ghost operations or bzr upgrades. You should only
1179
need to run this command if 'bzr check' or a bzr developer
1180
advises you to run it.
1182
If a second branch is provided, cross-branch reconciliation is
1183
also attempted, which will check that data like the tree root
1184
id which was not present in very early bzr versions is represented
1185
correctly in both branches.
1187
At the same time it is run it may recompress data resulting in
1188
a potential saving in disk space or performance gain.
1190
The branch *MUST* be on a listable system such as local disk or sftp.
1193
_see_also = ['check']
1194
takes_args = ['branch?']
1196
def run(self, branch="."):
1197
from bzrlib.reconcile import reconcile
1198
dir = bzrdir.BzrDir.open(branch)
1202
class cmd_revision_history(Command):
1203
"""Display the list of revision ids on a branch."""
1206
takes_args = ['location?']
1211
def run(self, location="."):
1212
branch = Branch.open_containing(location)[0]
1213
for revid in branch.revision_history():
1214
self.outf.write(revid)
1215
self.outf.write('\n')
1218
class cmd_ancestry(Command):
1219
"""List all revisions merged into this branch."""
1221
_see_also = ['log', 'revision-history']
1222
takes_args = ['location?']
1227
def run(self, location="."):
1229
wt = WorkingTree.open_containing(location)[0]
1230
except errors.NoWorkingTree:
1231
b = Branch.open(location)
1232
last_revision = b.last_revision()
1235
last_revision = wt.last_revision()
1237
revision_ids = b.repository.get_ancestry(last_revision)
1239
for revision_id in revision_ids:
1240
self.outf.write(revision_id + '\n')
1243
class cmd_init(Command):
1244
"""Make a directory into a versioned branch.
1246
Use this to create an empty branch, or before importing an
1249
If there is a repository in a parent directory of the location, then
1250
the history of the branch will be stored in the repository. Otherwise
1251
init creates a standalone branch which carries its own history
1252
in the .bzr directory.
1254
If there is already a branch at the location but it has no working tree,
1255
the tree can be populated with 'bzr checkout'.
1257
Recipe for importing a tree of files::
1263
bzr commit -m "imported project"
1266
_see_also = ['init-repository', 'branch', 'checkout']
1267
takes_args = ['location?']
1269
Option('create-prefix',
1270
help='Create the path leading up to the branch '
1271
'if it does not already exist.'),
1272
RegistryOption('format',
1273
help='Specify a format for this branch. '
1274
'See "help formats".',
1275
registry=bzrdir.format_registry,
1276
converter=bzrdir.format_registry.make_bzrdir,
1277
value_switches=True,
1278
title="Branch Format",
1280
Option('append-revisions-only',
1281
help='Never change revnos or the existing log.'
1282
' Append revisions to it only.')
1284
def run(self, location=None, format=None, append_revisions_only=False,
1285
create_prefix=False):
1287
format = bzrdir.format_registry.make_bzrdir('default')
1288
if location is None:
1291
to_transport = transport.get_transport(location)
1293
# The path has to exist to initialize a
1294
# branch inside of it.
1295
# Just using os.mkdir, since I don't
1296
# believe that we want to create a bunch of
1297
# locations if the user supplies an extended path
1299
to_transport.ensure_base()
1300
except errors.NoSuchFile:
1301
if not create_prefix:
1302
raise errors.BzrCommandError("Parent directory of %s"
1304
"\nYou may supply --create-prefix to create all"
1305
" leading parent directories."
1307
_create_prefix(to_transport)
1310
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1311
except errors.NotBranchError:
1312
# really a NotBzrDir error...
1313
create_branch = bzrdir.BzrDir.create_branch_convenience
1314
branch = create_branch(to_transport.base, format=format,
1315
possible_transports=[to_transport])
1317
from bzrlib.transport.local import LocalTransport
1318
if existing_bzrdir.has_branch():
1319
if (isinstance(to_transport, LocalTransport)
1320
and not existing_bzrdir.has_workingtree()):
1321
raise errors.BranchExistsWithoutWorkingTree(location)
1322
raise errors.AlreadyBranchError(location)
1324
branch = existing_bzrdir.create_branch()
1325
existing_bzrdir.create_workingtree()
1326
if append_revisions_only:
1328
branch.set_append_revisions_only(True)
1329
except errors.UpgradeRequired:
1330
raise errors.BzrCommandError('This branch format cannot be set'
1331
' to append-revisions-only. Try --experimental-branch6')
1333
from bzrlib.info import show_bzrdir_info
1334
show_bzrdir_info(bzrdir.BzrDir.open_containing_from_transport(
1335
to_transport)[0], verbose=0, outfile=self.outf)
1338
class cmd_init_repository(Command):
1339
"""Create a shared repository to hold branches.
1341
New branches created under the repository directory will store their
1342
revisions in the repository, not in the branch directory.
1344
If the --no-trees option is used then the branches in the repository
1345
will not have working trees by default.
1348
Create a shared repositories holding just branches::
1350
bzr init-repo --no-trees repo
1353
Make a lightweight checkout elsewhere::
1355
bzr checkout --lightweight repo/trunk trunk-checkout
1360
_see_also = ['init', 'branch', 'checkout', 'repositories']
1361
takes_args = ["location"]
1362
takes_options = [RegistryOption('format',
1363
help='Specify a format for this repository. See'
1364
' "bzr help formats" for details.',
1365
registry=bzrdir.format_registry,
1366
converter=bzrdir.format_registry.make_bzrdir,
1367
value_switches=True, title='Repository format'),
1369
help='Branches in the repository will default to'
1370
' not having a working tree.'),
1372
aliases = ["init-repo"]
1374
def run(self, location, format=None, no_trees=False):
1376
format = bzrdir.format_registry.make_bzrdir('default')
1378
if location is None:
1381
to_transport = transport.get_transport(location)
1382
to_transport.ensure_base()
1384
newdir = format.initialize_on_transport(to_transport)
1385
repo = newdir.create_repository(shared=True)
1386
repo.set_make_working_trees(not no_trees)
1388
from bzrlib.info import show_bzrdir_info
1389
show_bzrdir_info(bzrdir.BzrDir.open_containing_from_transport(
1390
to_transport)[0], verbose=0, outfile=self.outf)
1393
class cmd_diff(Command):
1394
"""Show differences in the working tree, between revisions or branches.
1396
If no arguments are given, all changes for the current tree are listed.
1397
If files are given, only the changes in those files are listed.
1398
Remote and multiple branches can be compared by using the --old and
1399
--new options. If not provided, the default for both is derived from
1400
the first argument, if any, or the current tree if no arguments are
1403
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1404
produces patches suitable for "patch -p1".
1408
2 - unrepresentable changes
1413
Shows the difference in the working tree versus the last commit::
1417
Difference between the working tree and revision 1::
1421
Difference between revision 2 and revision 1::
1425
Difference between revision 2 and revision 1 for branch xxx::
1429
Show just the differences for file NEWS::
1433
Show the differences in working tree xxx for file NEWS::
1437
Show the differences from branch xxx to this working tree:
1441
Show the differences between two branches for file NEWS::
1443
bzr diff --old xxx --new yyy NEWS
1445
Same as 'bzr diff' but prefix paths with old/ and new/::
1447
bzr diff --prefix old/:new/
1449
_see_also = ['status']
1450
takes_args = ['file*']
1452
Option('diff-options', type=str,
1453
help='Pass these options to the external diff program.'),
1454
Option('prefix', type=str,
1456
help='Set prefixes added to old and new filenames, as '
1457
'two values separated by a colon. (eg "old/:new/").'),
1459
help='Branch/tree to compare from.',
1463
help='Branch/tree to compare to.',
1469
help='Use this command to compare files.',
1473
aliases = ['di', 'dif']
1474
encoding_type = 'exact'
1477
def run(self, revision=None, file_list=None, diff_options=None,
1478
prefix=None, old=None, new=None, using=None):
1479
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1481
if (prefix is None) or (prefix == '0'):
1489
old_label, new_label = prefix.split(":")
1491
raise errors.BzrCommandError(
1492
'--prefix expects two values separated by a colon'
1493
' (eg "old/:new/")')
1495
if revision and len(revision) > 2:
1496
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1497
' one or two revision specifiers')
1499
old_tree, new_tree, specific_files, extra_trees = \
1500
_get_trees_to_diff(file_list, revision, old, new)
1501
return show_diff_trees(old_tree, new_tree, sys.stdout,
1502
specific_files=specific_files,
1503
external_diff_options=diff_options,
1504
old_label=old_label, new_label=new_label,
1505
extra_trees=extra_trees, using=using)
1508
class cmd_deleted(Command):
1509
"""List files deleted in the working tree.
1511
# TODO: Show files deleted since a previous revision, or
1512
# between two revisions.
1513
# TODO: Much more efficient way to do this: read in new
1514
# directories with readdir, rather than stating each one. Same
1515
# level of effort but possibly much less IO. (Or possibly not,
1516
# if the directories are very large...)
1517
_see_also = ['status', 'ls']
1518
takes_options = ['show-ids']
1521
def run(self, show_ids=False):
1522
tree = WorkingTree.open_containing(u'.')[0]
1525
old = tree.basis_tree()
1528
for path, ie in old.inventory.iter_entries():
1529
if not tree.has_id(ie.file_id):
1530
self.outf.write(path)
1532
self.outf.write(' ')
1533
self.outf.write(ie.file_id)
1534
self.outf.write('\n')
1541
class cmd_modified(Command):
1542
"""List files modified in working tree.
1546
_see_also = ['status', 'ls']
1549
help='Write an ascii NUL (\\0) separator '
1550
'between files rather than a newline.')
1554
def run(self, null=False):
1555
tree = WorkingTree.open_containing(u'.')[0]
1556
td = tree.changes_from(tree.basis_tree())
1557
for path, id, kind, text_modified, meta_modified in td.modified:
1559
self.outf.write(path + '\0')
1561
self.outf.write(osutils.quotefn(path) + '\n')
1564
class cmd_added(Command):
1565
"""List files added in working tree.
1569
_see_also = ['status', 'ls']
1572
help='Write an ascii NUL (\\0) separator '
1573
'between files rather than a newline.')
1577
def run(self, null=False):
1578
wt = WorkingTree.open_containing(u'.')[0]
1581
basis = wt.basis_tree()
1584
basis_inv = basis.inventory
1587
if file_id in basis_inv:
1589
if inv.is_root(file_id) and len(basis_inv) == 0:
1591
path = inv.id2path(file_id)
1592
if not os.access(osutils.abspath(path), os.F_OK):
1595
self.outf.write(path + '\0')
1597
self.outf.write(osutils.quotefn(path) + '\n')
1604
class cmd_root(Command):
1605
"""Show the tree root directory.
1607
The root is the nearest enclosing directory with a .bzr control
1610
takes_args = ['filename?']
1612
def run(self, filename=None):
1613
"""Print the branch root."""
1614
tree = WorkingTree.open_containing(filename)[0]
1615
self.outf.write(tree.basedir + '\n')
1618
def _parse_limit(limitstring):
1620
return int(limitstring)
1622
msg = "The limit argument must be an integer."
1623
raise errors.BzrCommandError(msg)
1626
class cmd_log(Command):
1627
"""Show log of a branch, file, or directory.
1629
By default show the log of the branch containing the working directory.
1631
To request a range of logs, you can use the command -r begin..end
1632
-r revision requests a specific revision, -r ..end or -r begin.. are
1636
Log the current branch::
1644
Log the last 10 revisions of a branch::
1646
bzr log -r -10.. http://server/branch
1649
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1651
takes_args = ['location?']
1654
help='Show from oldest to newest.'),
1657
help='Display timezone as local, original, or utc.'),
1658
custom_help('verbose',
1659
help='Show files changed in each revision.'),
1665
help='Show revisions whose message matches this '
1666
'regular expression.',
1670
help='Limit the output to the first N revisions.',
1674
encoding_type = 'replace'
1677
def run(self, location=None, timezone='original',
1685
from bzrlib.log import show_log
1686
direction = (forward and 'forward') or 'reverse'
1691
# find the file id to log:
1693
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1697
tree = b.basis_tree()
1698
file_id = tree.path2id(fp)
1700
raise errors.BzrCommandError(
1701
"Path does not have any revision history: %s" %
1705
# FIXME ? log the current subdir only RBC 20060203
1706
if revision is not None \
1707
and len(revision) > 0 and revision[0].get_branch():
1708
location = revision[0].get_branch()
1711
dir, relpath = bzrdir.BzrDir.open_containing(location)
1712
b = dir.open_branch()
1716
if revision is None:
1719
elif len(revision) == 1:
1720
rev1 = rev2 = revision[0].in_history(b)
1721
elif len(revision) == 2:
1722
if revision[1].get_branch() != revision[0].get_branch():
1723
# b is taken from revision[0].get_branch(), and
1724
# show_log will use its revision_history. Having
1725
# different branches will lead to weird behaviors.
1726
raise errors.BzrCommandError(
1727
"Log doesn't accept two revisions in different"
1729
rev1 = revision[0].in_history(b)
1730
rev2 = revision[1].in_history(b)
1732
raise errors.BzrCommandError(
1733
'bzr log --revision takes one or two values.')
1735
if log_format is None:
1736
log_format = log.log_formatter_registry.get_default(b)
1738
lf = log_format(show_ids=show_ids, to_file=self.outf,
1739
show_timezone=timezone)
1745
direction=direction,
1746
start_revision=rev1,
1754
def get_log_format(long=False, short=False, line=False, default='long'):
1755
log_format = default
1759
log_format = 'short'
1765
class cmd_touching_revisions(Command):
1766
"""Return revision-ids which affected a particular file.
1768
A more user-friendly interface is "bzr log FILE".
1772
takes_args = ["filename"]
1775
def run(self, filename):
1776
tree, relpath = WorkingTree.open_containing(filename)
1778
file_id = tree.path2id(relpath)
1779
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1780
self.outf.write("%6d %s\n" % (revno, what))
1783
class cmd_ls(Command):
1784
"""List files in a tree.
1787
_see_also = ['status', 'cat']
1788
takes_args = ['path?']
1789
# TODO: Take a revision or remote path and list that tree instead.
1793
Option('non-recursive',
1794
help='Don\'t recurse into subdirectories.'),
1796
help='Print paths relative to the root of the branch.'),
1797
Option('unknown', help='Print unknown files.'),
1798
Option('versioned', help='Print versioned files.',
1800
Option('ignored', help='Print ignored files.'),
1802
help='Write an ascii NUL (\\0) separator '
1803
'between files rather than a newline.'),
1805
help='List entries of a particular kind: file, directory, symlink.',
1810
def run(self, revision=None, verbose=False,
1811
non_recursive=False, from_root=False,
1812
unknown=False, versioned=False, ignored=False,
1813
null=False, kind=None, show_ids=False, path=None):
1815
if kind and kind not in ('file', 'directory', 'symlink'):
1816
raise errors.BzrCommandError('invalid kind specified')
1818
if verbose and null:
1819
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1820
all = not (unknown or versioned or ignored)
1822
selection = {'I':ignored, '?':unknown, 'V':versioned}
1829
raise errors.BzrCommandError('cannot specify both --from-root'
1833
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1839
if revision is not None:
1840
tree = branch.repository.revision_tree(
1841
revision[0].as_revision_id(branch))
1843
tree = branch.basis_tree()
1847
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1848
if fp.startswith(relpath):
1849
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1850
if non_recursive and '/' in fp:
1852
if not all and not selection[fc]:
1854
if kind is not None and fkind != kind:
1857
kindch = entry.kind_character()
1858
outstring = '%-8s %s%s' % (fc, fp, kindch)
1859
if show_ids and fid is not None:
1860
outstring = "%-50s %s" % (outstring, fid)
1861
self.outf.write(outstring + '\n')
1863
self.outf.write(fp + '\0')
1866
self.outf.write(fid)
1867
self.outf.write('\0')
1875
self.outf.write('%-50s %s\n' % (fp, my_id))
1877
self.outf.write(fp + '\n')
1882
class cmd_unknowns(Command):
1883
"""List unknown files.
1891
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1892
self.outf.write(osutils.quotefn(f) + '\n')
1895
class cmd_ignore(Command):
1896
"""Ignore specified files or patterns.
1898
See ``bzr help patterns`` for details on the syntax of patterns.
1900
To remove patterns from the ignore list, edit the .bzrignore file.
1901
After adding, editing or deleting that file either indirectly by
1902
using this command or directly by using an editor, be sure to commit
1905
Note: ignore patterns containing shell wildcards must be quoted from
1909
Ignore the top level Makefile::
1911
bzr ignore ./Makefile
1913
Ignore class files in all directories::
1915
bzr ignore "*.class"
1917
Ignore .o files under the lib directory::
1919
bzr ignore "lib/**/*.o"
1921
Ignore .o files under the lib directory::
1923
bzr ignore "RE:lib/.*\.o"
1925
Ignore everything but the "debian" toplevel directory::
1927
bzr ignore "RE:(?!debian/).*"
1930
_see_also = ['status', 'ignored', 'patterns']
1931
takes_args = ['name_pattern*']
1933
Option('old-default-rules',
1934
help='Write out the ignore rules bzr < 0.9 always used.')
1937
def run(self, name_pattern_list=None, old_default_rules=None):
1938
from bzrlib import ignores
1939
if old_default_rules is not None:
1940
# dump the rules and exit
1941
for pattern in ignores.OLD_DEFAULTS:
1944
if not name_pattern_list:
1945
raise errors.BzrCommandError("ignore requires at least one "
1946
"NAME_PATTERN or --old-default-rules")
1947
name_pattern_list = [globbing.normalize_pattern(p)
1948
for p in name_pattern_list]
1949
for name_pattern in name_pattern_list:
1950
if (name_pattern[0] == '/' or
1951
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1952
raise errors.BzrCommandError(
1953
"NAME_PATTERN should not be an absolute path")
1954
tree, relpath = WorkingTree.open_containing(u'.')
1955
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
1956
ignored = globbing.Globster(name_pattern_list)
1959
for entry in tree.list_files():
1963
if ignored.match(filename):
1964
matches.append(filename.encode('utf-8'))
1966
if len(matches) > 0:
1967
print "Warning: the following files are version controlled and" \
1968
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1971
class cmd_ignored(Command):
1972
"""List ignored files and the patterns that matched them.
1974
List all the ignored files and the ignore pattern that caused the file to
1977
Alternatively, to list just the files::
1982
encoding_type = 'replace'
1983
_see_also = ['ignore', 'ls']
1987
tree = WorkingTree.open_containing(u'.')[0]
1990
for path, file_class, kind, file_id, entry in tree.list_files():
1991
if file_class != 'I':
1993
## XXX: Slightly inefficient since this was already calculated
1994
pat = tree.is_ignored(path)
1995
self.outf.write('%-50s %s\n' % (path, pat))
2000
class cmd_lookup_revision(Command):
2001
"""Lookup the revision-id from a revision-number
2004
bzr lookup-revision 33
2007
takes_args = ['revno']
2010
def run(self, revno):
2014
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2016
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2019
class cmd_export(Command):
2020
"""Export current or past revision to a destination directory or archive.
2022
If no revision is specified this exports the last committed revision.
2024
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2025
given, try to find the format with the extension. If no extension
2026
is found exports to a directory (equivalent to --format=dir).
2028
If root is supplied, it will be used as the root directory inside
2029
container formats (tar, zip, etc). If it is not supplied it will default
2030
to the exported filename. The root option has no effect for 'dir' format.
2032
If branch is omitted then the branch containing the current working
2033
directory will be used.
2035
Note: Export of tree with non-ASCII filenames to zip is not supported.
2037
================= =========================
2038
Supported formats Autodetected by extension
2039
================= =========================
2042
tbz2 .tar.bz2, .tbz2
2045
================= =========================
2047
takes_args = ['dest', 'branch_or_subdir?']
2050
help="Type of file to export to.",
2055
help="Name of the root directory inside the exported file."),
2057
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2059
from bzrlib.export import export
2061
if branch_or_subdir is None:
2062
tree = WorkingTree.open_containing(u'.')[0]
2066
b, subdir = Branch.open_containing(branch_or_subdir)
2068
if revision is None:
2069
# should be tree.last_revision FIXME
2070
rev_id = b.last_revision()
2072
if len(revision) != 1:
2073
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2074
rev_id = revision[0].as_revision_id(b)
2075
t = b.repository.revision_tree(rev_id)
2077
export(t, dest, format, root, subdir)
2078
except errors.NoSuchExportFormat, e:
2079
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2082
class cmd_cat(Command):
2083
"""Write the contents of a file as of a given revision to standard output.
2085
If no revision is nominated, the last revision is used.
2087
Note: Take care to redirect standard output when using this command on a
2093
Option('name-from-revision', help='The path name in the old tree.'),
2096
takes_args = ['filename']
2097
encoding_type = 'exact'
2100
def run(self, filename, revision=None, name_from_revision=False):
2101
if revision is not None and len(revision) != 1:
2102
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2103
" one revision specifier")
2104
tree, branch, relpath = \
2105
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2108
return self._run(tree, branch, relpath, filename, revision,
2113
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2115
tree = b.basis_tree()
2116
if revision is None:
2117
revision_id = b.last_revision()
2119
revision_id = revision[0].as_revision_id(b)
2121
cur_file_id = tree.path2id(relpath)
2122
rev_tree = b.repository.revision_tree(revision_id)
2123
old_file_id = rev_tree.path2id(relpath)
2125
if name_from_revision:
2126
if old_file_id is None:
2127
raise errors.BzrCommandError("%r is not present in revision %s"
2128
% (filename, revision_id))
2130
content = rev_tree.get_file_text(old_file_id)
2131
elif cur_file_id is not None:
2132
content = rev_tree.get_file_text(cur_file_id)
2133
elif old_file_id is not None:
2134
content = rev_tree.get_file_text(old_file_id)
2136
raise errors.BzrCommandError("%r is not present in revision %s" %
2137
(filename, revision_id))
2138
self.outf.write(content)
2141
class cmd_local_time_offset(Command):
2142
"""Show the offset in seconds from GMT to local time."""
2146
print osutils.local_time_offset()
2150
class cmd_commit(Command):
2151
"""Commit changes into a new revision.
2153
If no arguments are given, the entire tree is committed.
2155
If selected files are specified, only changes to those files are
2156
committed. If a directory is specified then the directory and everything
2157
within it is committed.
2159
When excludes are given, they take precedence over selected files.
2160
For example, too commit only changes within foo, but not changes within
2163
bzr commit foo -x foo/bar
2165
If author of the change is not the same person as the committer, you can
2166
specify the author's name using the --author option. The name should be
2167
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2169
A selected-file commit may fail in some cases where the committed
2170
tree would be invalid. Consider::
2175
bzr commit foo -m "committing foo"
2176
bzr mv foo/bar foo/baz
2179
bzr commit foo/bar -m "committing bar but not baz"
2181
In the example above, the last commit will fail by design. This gives
2182
the user the opportunity to decide whether they want to commit the
2183
rename at the same time, separately first, or not at all. (As a general
2184
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2186
Note: A selected-file commit after a merge is not yet supported.
2188
# TODO: Run hooks on tree to-be-committed, and after commit.
2190
# TODO: Strict commit that fails if there are deleted files.
2191
# (what does "deleted files" mean ??)
2193
# TODO: Give better message for -s, --summary, used by tla people
2195
# XXX: verbose currently does nothing
2197
_see_also = ['bugs', 'uncommit']
2198
takes_args = ['selected*']
2200
ListOption('exclude', type=str, short_name='x',
2201
help="Do not consider changes made to a given path."),
2202
Option('message', type=unicode,
2204
help="Description of the new revision."),
2207
help='Commit even if nothing has changed.'),
2208
Option('file', type=str,
2211
help='Take commit message from this file.'),
2213
help="Refuse to commit if there are unknown "
2214
"files in the working tree."),
2215
ListOption('fixes', type=str,
2216
help="Mark a bug as being fixed by this revision."),
2217
Option('author', type=unicode,
2218
help="Set the author's name, if it's different "
2219
"from the committer."),
2221
help="Perform a local commit in a bound "
2222
"branch. Local commits are not pushed to "
2223
"the master branch until a normal commit "
2227
help='When no message is supplied, show the diff along'
2228
' with the status summary in the message editor.'),
2230
aliases = ['ci', 'checkin']
2232
def _get_bug_fix_properties(self, fixes, branch):
2234
# Configure the properties for bug fixing attributes.
2235
for fixed_bug in fixes:
2236
tokens = fixed_bug.split(':')
2237
if len(tokens) != 2:
2238
raise errors.BzrCommandError(
2239
"Invalid bug %s. Must be in the form of 'tag:id'. "
2240
"Commit refused." % fixed_bug)
2241
tag, bug_id = tokens
2243
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2244
except errors.UnknownBugTrackerAbbreviation:
2245
raise errors.BzrCommandError(
2246
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2247
except errors.MalformedBugIdentifier:
2248
raise errors.BzrCommandError(
2249
"Invalid bug identifier for %s. Commit refused."
2251
properties.append('%s fixed' % bug_url)
2252
return '\n'.join(properties)
2254
def run(self, message=None, file=None, verbose=False, selected_list=None,
2255
unchanged=False, strict=False, local=False, fixes=None,
2256
author=None, show_diff=False, exclude=None):
2257
from bzrlib.errors import (
2262
from bzrlib.msgeditor import (
2263
edit_commit_message_encoded,
2264
make_commit_message_template_encoded
2267
# TODO: Need a blackbox test for invoking the external editor; may be
2268
# slightly problematic to run this cross-platform.
2270
# TODO: do more checks that the commit will succeed before
2271
# spending the user's valuable time typing a commit message.
2275
tree, selected_list = tree_files(selected_list)
2276
if selected_list == ['']:
2277
# workaround - commit of root of tree should be exactly the same
2278
# as just default commit in that tree, and succeed even though
2279
# selected-file merge commit is not done yet
2284
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2286
properties['bugs'] = bug_property
2288
if local and not tree.branch.get_bound_location():
2289
raise errors.LocalRequiresBoundBranch()
2291
def get_message(commit_obj):
2292
"""Callback to get commit message"""
2293
my_message = message
2294
if my_message is None and not file:
2295
t = make_commit_message_template_encoded(tree,
2296
selected_list, diff=show_diff,
2297
output_encoding=bzrlib.user_encoding)
2298
my_message = edit_commit_message_encoded(t)
2299
if my_message is None:
2300
raise errors.BzrCommandError("please specify a commit"
2301
" message with either --message or --file")
2302
elif my_message and file:
2303
raise errors.BzrCommandError(
2304
"please specify either --message or --file")
2306
my_message = codecs.open(file, 'rt',
2307
bzrlib.user_encoding).read()
2308
if my_message == "":
2309
raise errors.BzrCommandError("empty commit message specified")
2313
tree.commit(message_callback=get_message,
2314
specific_files=selected_list,
2315
allow_pointless=unchanged, strict=strict, local=local,
2316
reporter=None, verbose=verbose, revprops=properties,
2318
exclude=safe_relpath_files(tree, exclude))
2319
except PointlessCommit:
2320
# FIXME: This should really happen before the file is read in;
2321
# perhaps prepare the commit; get the message; then actually commit
2322
raise errors.BzrCommandError("no changes to commit."
2323
" use --unchanged to commit anyhow")
2324
except ConflictsInTree:
2325
raise errors.BzrCommandError('Conflicts detected in working '
2326
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2328
except StrictCommitFailed:
2329
raise errors.BzrCommandError("Commit refused because there are"
2330
" unknown files in the working tree.")
2331
except errors.BoundBranchOutOfDate, e:
2332
raise errors.BzrCommandError(str(e) + "\n"
2333
'To commit to master branch, run update and then commit.\n'
2334
'You can also pass --local to commit to continue working '
2338
class cmd_check(Command):
2339
"""Validate working tree structure, branch consistency and repository history.
2341
This command checks various invariants about branch and repository storage
2342
to detect data corruption or bzr bugs.
2344
The working tree and branch checks will only give output if a problem is
2345
detected. The output fields of the repository check are:
2347
revisions: This is just the number of revisions checked. It doesn't
2349
versionedfiles: This is just the number of versionedfiles checked. It
2350
doesn't indicate a problem.
2351
unreferenced ancestors: Texts that are ancestors of other texts, but
2352
are not properly referenced by the revision ancestry. This is a
2353
subtle problem that Bazaar can work around.
2354
unique file texts: This is the total number of unique file contents
2355
seen in the checked revisions. It does not indicate a problem.
2356
repeated file texts: This is the total number of repeated texts seen
2357
in the checked revisions. Texts can be repeated when their file
2358
entries are modified, but the file contents are not. It does not
2361
If no restrictions are specified, all Bazaar data that is found at the given
2362
location will be checked.
2366
Check the tree and branch at 'foo'::
2368
bzr check --tree --branch foo
2370
Check only the repository at 'bar'::
2372
bzr check --repo bar
2374
Check everything at 'baz'::
2379
_see_also = ['reconcile']
2380
takes_args = ['path?']
2381
takes_options = ['verbose',
2382
Option('branch', help="Check the branch related to the"
2383
" current directory."),
2384
Option('repo', help="Check the repository related to the"
2385
" current directory."),
2386
Option('tree', help="Check the working tree related to"
2387
" the current directory.")]
2389
def run(self, path=None, verbose=False, branch=False, repo=False,
2391
from bzrlib.check import check_dwim
2394
if not branch and not repo and not tree:
2395
branch = repo = tree = True
2396
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2399
class cmd_upgrade(Command):
2400
"""Upgrade branch storage to current format.
2402
The check command or bzr developers may sometimes advise you to run
2403
this command. When the default format has changed you may also be warned
2404
during other operations to upgrade.
2407
_see_also = ['check']
2408
takes_args = ['url?']
2410
RegistryOption('format',
2411
help='Upgrade to a specific format. See "bzr help'
2412
' formats" for details.',
2413
registry=bzrdir.format_registry,
2414
converter=bzrdir.format_registry.make_bzrdir,
2415
value_switches=True, title='Branch format'),
2418
def run(self, url='.', format=None):
2419
from bzrlib.upgrade import upgrade
2421
format = bzrdir.format_registry.make_bzrdir('default')
2422
upgrade(url, format)
2425
class cmd_whoami(Command):
2426
"""Show or set bzr user id.
2429
Show the email of the current user::
2433
Set the current user::
2435
bzr whoami "Frank Chu <fchu@example.com>"
2437
takes_options = [ Option('email',
2438
help='Display email address only.'),
2440
help='Set identity for the current branch instead of '
2443
takes_args = ['name?']
2444
encoding_type = 'replace'
2447
def run(self, email=False, branch=False, name=None):
2449
# use branch if we're inside one; otherwise global config
2451
c = Branch.open_containing('.')[0].get_config()
2452
except errors.NotBranchError:
2453
c = config.GlobalConfig()
2455
self.outf.write(c.user_email() + '\n')
2457
self.outf.write(c.username() + '\n')
2460
# display a warning if an email address isn't included in the given name.
2462
config.extract_email_address(name)
2463
except errors.NoEmailInUsername, e:
2464
warning('"%s" does not seem to contain an email address. '
2465
'This is allowed, but not recommended.', name)
2467
# use global config unless --branch given
2469
c = Branch.open_containing('.')[0].get_config()
2471
c = config.GlobalConfig()
2472
c.set_user_option('email', name)
2475
class cmd_nick(Command):
2476
"""Print or set the branch nickname.
2478
If unset, the tree root directory name is used as the nickname
2479
To print the current nickname, execute with no argument.
2482
_see_also = ['info']
2483
takes_args = ['nickname?']
2484
def run(self, nickname=None):
2485
branch = Branch.open_containing(u'.')[0]
2486
if nickname is None:
2487
self.printme(branch)
2489
branch.nick = nickname
2492
def printme(self, branch):
2496
class cmd_alias(Command):
2497
"""Set/unset and display aliases.
2500
Show the current aliases::
2504
Show the alias specified for 'll'::
2508
Set an alias for 'll'::
2510
bzr alias ll="log --line -r-10..-1"
2512
To remove an alias for 'll'::
2514
bzr alias --remove ll
2517
takes_args = ['name?']
2519
Option('remove', help='Remove the alias.'),
2522
def run(self, name=None, remove=False):
2524
self.remove_alias(name)
2526
self.print_aliases()
2528
equal_pos = name.find('=')
2530
self.print_alias(name)
2532
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2534
def remove_alias(self, alias_name):
2535
if alias_name is None:
2536
raise errors.BzrCommandError(
2537
'bzr alias --remove expects an alias to remove.')
2538
# If alias is not found, print something like:
2539
# unalias: foo: not found
2540
c = config.GlobalConfig()
2541
c.unset_alias(alias_name)
2544
def print_aliases(self):
2545
"""Print out the defined aliases in a similar format to bash."""
2546
aliases = config.GlobalConfig().get_aliases()
2547
for key, value in sorted(aliases.iteritems()):
2548
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2551
def print_alias(self, alias_name):
2552
from bzrlib.commands import get_alias
2553
alias = get_alias(alias_name)
2555
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2558
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2560
def set_alias(self, alias_name, alias_command):
2561
"""Save the alias in the global config."""
2562
c = config.GlobalConfig()
2563
c.set_alias(alias_name, alias_command)
2566
class cmd_selftest(Command):
2567
"""Run internal test suite.
2569
If arguments are given, they are regular expressions that say which tests
2570
should run. Tests matching any expression are run, and other tests are
2573
Alternatively if --first is given, matching tests are run first and then
2574
all other tests are run. This is useful if you have been working in a
2575
particular area, but want to make sure nothing else was broken.
2577
If --exclude is given, tests that match that regular expression are
2578
excluded, regardless of whether they match --first or not.
2580
To help catch accidential dependencies between tests, the --randomize
2581
option is useful. In most cases, the argument used is the word 'now'.
2582
Note that the seed used for the random number generator is displayed
2583
when this option is used. The seed can be explicitly passed as the
2584
argument to this option if required. This enables reproduction of the
2585
actual ordering used if and when an order sensitive problem is encountered.
2587
If --list-only is given, the tests that would be run are listed. This is
2588
useful when combined with --first, --exclude and/or --randomize to
2589
understand their impact. The test harness reports "Listed nn tests in ..."
2590
instead of "Ran nn tests in ..." when list mode is enabled.
2592
If the global option '--no-plugins' is given, plugins are not loaded
2593
before running the selftests. This has two effects: features provided or
2594
modified by plugins will not be tested, and tests provided by plugins will
2597
Tests that need working space on disk use a common temporary directory,
2598
typically inside $TMPDIR or /tmp.
2601
Run only tests relating to 'ignore'::
2605
Disable plugins and list tests as they're run::
2607
bzr --no-plugins selftest -v
2609
# NB: this is used from the class without creating an instance, which is
2610
# why it does not have a self parameter.
2611
def get_transport_type(typestring):
2612
"""Parse and return a transport specifier."""
2613
if typestring == "sftp":
2614
from bzrlib.transport.sftp import SFTPAbsoluteServer
2615
return SFTPAbsoluteServer
2616
if typestring == "memory":
2617
from bzrlib.transport.memory import MemoryServer
2619
if typestring == "fakenfs":
2620
from bzrlib.transport.fakenfs import FakeNFSServer
2621
return FakeNFSServer
2622
msg = "No known transport type %s. Supported types are: sftp\n" %\
2624
raise errors.BzrCommandError(msg)
2627
takes_args = ['testspecs*']
2628
takes_options = ['verbose',
2630
help='Stop when one test fails.',
2634
help='Use a different transport by default '
2635
'throughout the test suite.',
2636
type=get_transport_type),
2638
help='Run the benchmarks rather than selftests.'),
2639
Option('lsprof-timed',
2640
help='Generate lsprof output for benchmarked'
2641
' sections of code.'),
2642
Option('cache-dir', type=str,
2643
help='Cache intermediate benchmark output in this '
2646
help='Run all tests, but run specified tests first.',
2650
help='List the tests instead of running them.'),
2651
Option('randomize', type=str, argname="SEED",
2652
help='Randomize the order of tests using the given'
2653
' seed or "now" for the current time.'),
2654
Option('exclude', type=str, argname="PATTERN",
2656
help='Exclude tests that match this regular'
2658
Option('strict', help='Fail on missing dependencies or '
2660
Option('load-list', type=str, argname='TESTLISTFILE',
2661
help='Load a test id list from a text file.'),
2662
ListOption('debugflag', type=str, short_name='E',
2663
help='Turn on a selftest debug flag.'),
2664
Option('starting-with', type=str, argname='TESTID',
2666
help='Load only the tests starting with TESTID.'),
2668
encoding_type = 'replace'
2670
def run(self, testspecs_list=None, verbose=False, one=False,
2671
transport=None, benchmark=None,
2672
lsprof_timed=None, cache_dir=None,
2673
first=False, list_only=False,
2674
randomize=None, exclude=None, strict=False,
2675
load_list=None, debugflag=None, starting_with=None):
2677
from bzrlib.tests import selftest
2678
import bzrlib.benchmarks as benchmarks
2679
from bzrlib.benchmarks import tree_creator
2681
# Make deprecation warnings visible, unless -Werror is set
2682
symbol_versioning.activate_deprecation_warnings(override=False)
2684
if cache_dir is not None:
2685
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2687
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2688
print ' %s (%s python%s)' % (
2690
bzrlib.version_string,
2691
bzrlib._format_version_tuple(sys.version_info),
2694
if testspecs_list is not None:
2695
pattern = '|'.join(testspecs_list)
2699
test_suite_factory = benchmarks.test_suite
2700
# Unless user explicitly asks for quiet, be verbose in benchmarks
2701
verbose = not is_quiet()
2702
# TODO: should possibly lock the history file...
2703
benchfile = open(".perf_history", "at", buffering=1)
2705
test_suite_factory = None
2708
result = selftest(verbose=verbose,
2710
stop_on_failure=one,
2711
transport=transport,
2712
test_suite_factory=test_suite_factory,
2713
lsprof_timed=lsprof_timed,
2714
bench_history=benchfile,
2715
matching_tests_first=first,
2716
list_only=list_only,
2717
random_seed=randomize,
2718
exclude_pattern=exclude,
2720
load_list=load_list,
2721
debug_flags=debugflag,
2722
starting_with=starting_with,
2725
if benchfile is not None:
2728
note('tests passed')
2730
note('tests failed')
2731
return int(not result)
2734
class cmd_version(Command):
2735
"""Show version of bzr."""
2737
encoding_type = 'replace'
2739
Option("short", help="Print just the version number."),
2743
def run(self, short=False):
2744
from bzrlib.version import show_version
2746
self.outf.write(bzrlib.version_string + '\n')
2748
show_version(to_file=self.outf)
2751
class cmd_rocks(Command):
2752
"""Statement of optimism."""
2758
print "It sure does!"
2761
class cmd_find_merge_base(Command):
2762
"""Find and print a base revision for merging two branches."""
2763
# TODO: Options to specify revisions on either side, as if
2764
# merging only part of the history.
2765
takes_args = ['branch', 'other']
2769
def run(self, branch, other):
2770
from bzrlib.revision import ensure_null
2772
branch1 = Branch.open_containing(branch)[0]
2773
branch2 = Branch.open_containing(other)[0]
2778
last1 = ensure_null(branch1.last_revision())
2779
last2 = ensure_null(branch2.last_revision())
2781
graph = branch1.repository.get_graph(branch2.repository)
2782
base_rev_id = graph.find_unique_lca(last1, last2)
2784
print 'merge base is revision %s' % base_rev_id
2791
class cmd_merge(Command):
2792
"""Perform a three-way merge.
2794
The source of the merge can be specified either in the form of a branch,
2795
or in the form of a path to a file containing a merge directive generated
2796
with bzr send. If neither is specified, the default is the upstream branch
2797
or the branch most recently merged using --remember.
2799
When merging a branch, by default the tip will be merged. To pick a different
2800
revision, pass --revision. If you specify two values, the first will be used as
2801
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2802
available revisions, like this is commonly referred to as "cherrypicking".
2804
Revision numbers are always relative to the branch being merged.
2806
By default, bzr will try to merge in all new work from the other
2807
branch, automatically determining an appropriate base. If this
2808
fails, you may need to give an explicit base.
2810
Merge will do its best to combine the changes in two branches, but there
2811
are some kinds of problems only a human can fix. When it encounters those,
2812
it will mark a conflict. A conflict means that you need to fix something,
2813
before you should commit.
2815
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2817
If there is no default branch set, the first merge will set it. After
2818
that, you can omit the branch to use the default. To change the
2819
default, use --remember. The value will only be saved if the remote
2820
location can be accessed.
2822
The results of the merge are placed into the destination working
2823
directory, where they can be reviewed (with bzr diff), tested, and then
2824
committed to record the result of the merge.
2826
merge refuses to run if there are any uncommitted changes, unless
2830
To merge the latest revision from bzr.dev::
2832
bzr merge ../bzr.dev
2834
To merge changes up to and including revision 82 from bzr.dev::
2836
bzr merge -r 82 ../bzr.dev
2838
To merge the changes introduced by 82, without previous changes::
2840
bzr merge -r 81..82 ../bzr.dev
2842
To apply a merge directive contained in in /tmp/merge:
2844
bzr merge /tmp/merge
2847
encoding_type = 'exact'
2848
_see_also = ['update', 'remerge', 'status-flags']
2849
takes_args = ['location?']
2854
help='Merge even if the destination tree has uncommitted changes.'),
2858
Option('show-base', help="Show base revision text in "
2860
Option('uncommitted', help='Apply uncommitted changes'
2861
' from a working copy, instead of branch changes.'),
2862
Option('pull', help='If the destination is already'
2863
' completely merged into the source, pull from the'
2864
' source rather than merging. When this happens,'
2865
' you do not need to commit the result.'),
2867
help='Branch to merge into, '
2868
'rather than the one containing the working directory.',
2872
Option('preview', help='Instead of merging, show a diff of the merge.')
2875
def run(self, location=None, revision=None, force=False,
2876
merge_type=None, show_base=False, reprocess=False, remember=False,
2877
uncommitted=False, pull=False,
2881
if merge_type is None:
2882
merge_type = _mod_merge.Merge3Merger
2884
if directory is None: directory = u'.'
2885
possible_transports = []
2887
allow_pending = True
2888
verified = 'inapplicable'
2889
tree = WorkingTree.open_containing(directory)[0]
2890
change_reporter = delta._ChangeReporter(
2891
unversioned_filter=tree.is_ignored)
2894
pb = ui.ui_factory.nested_progress_bar()
2895
cleanups.append(pb.finished)
2897
cleanups.append(tree.unlock)
2898
if location is not None:
2900
mergeable = bundle.read_mergeable_from_url(location,
2901
possible_transports=possible_transports)
2902
except errors.NotABundle:
2906
raise errors.BzrCommandError('Cannot use --uncommitted'
2907
' with bundles or merge directives.')
2909
if revision is not None:
2910
raise errors.BzrCommandError(
2911
'Cannot use -r with merge directives or bundles')
2912
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2915
if merger is None and uncommitted:
2916
if revision is not None and len(revision) > 0:
2917
raise errors.BzrCommandError('Cannot use --uncommitted and'
2918
' --revision at the same time.')
2919
location = self._select_branch_location(tree, location)[0]
2920
other_tree, other_path = WorkingTree.open_containing(location)
2921
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2923
allow_pending = False
2924
if other_path != '':
2925
merger.interesting_files = [other_path]
2928
merger, allow_pending = self._get_merger_from_branch(tree,
2929
location, revision, remember, possible_transports, pb)
2931
merger.merge_type = merge_type
2932
merger.reprocess = reprocess
2933
merger.show_base = show_base
2934
self.sanity_check_merger(merger)
2935
if (merger.base_rev_id == merger.other_rev_id and
2936
merger.other_rev_id is not None):
2937
note('Nothing to do.')
2940
if merger.interesting_files is not None:
2941
raise errors.BzrCommandError('Cannot pull individual files')
2942
if (merger.base_rev_id == tree.last_revision()):
2943
result = tree.pull(merger.other_branch, False,
2944
merger.other_rev_id)
2945
result.report(self.outf)
2947
merger.check_basis(not force)
2949
return self._do_preview(merger)
2951
return self._do_merge(merger, change_reporter, allow_pending,
2954
for cleanup in reversed(cleanups):
2957
def _do_preview(self, merger):
2958
from bzrlib.diff import show_diff_trees
2959
tree_merger = merger.make_merger()
2960
tt = tree_merger.make_preview_transform()
2962
result_tree = tt.get_preview_tree()
2963
show_diff_trees(merger.this_tree, result_tree, self.outf,
2964
old_label='', new_label='')
2968
def _do_merge(self, merger, change_reporter, allow_pending, verified):
2969
merger.change_reporter = change_reporter
2970
conflict_count = merger.do_merge()
2972
merger.set_pending()
2973
if verified == 'failed':
2974
warning('Preview patch does not match changes')
2975
if conflict_count != 0:
2980
def sanity_check_merger(self, merger):
2981
if (merger.show_base and
2982
not merger.merge_type is _mod_merge.Merge3Merger):
2983
raise errors.BzrCommandError("Show-base is not supported for this"
2984
" merge type. %s" % merger.merge_type)
2985
if merger.reprocess and not merger.merge_type.supports_reprocess:
2986
raise errors.BzrCommandError("Conflict reduction is not supported"
2987
" for merge type %s." %
2989
if merger.reprocess and merger.show_base:
2990
raise errors.BzrCommandError("Cannot do conflict reduction and"
2993
def _get_merger_from_branch(self, tree, location, revision, remember,
2994
possible_transports, pb):
2995
"""Produce a merger from a location, assuming it refers to a branch."""
2996
from bzrlib.tag import _merge_tags_if_possible
2997
# find the branch locations
2998
other_loc, user_location = self._select_branch_location(tree, location,
3000
if revision is not None and len(revision) == 2:
3001
base_loc, _unused = self._select_branch_location(tree,
3002
location, revision, 0)
3004
base_loc = other_loc
3006
other_branch, other_path = Branch.open_containing(other_loc,
3007
possible_transports)
3008
if base_loc == other_loc:
3009
base_branch = other_branch
3011
base_branch, base_path = Branch.open_containing(base_loc,
3012
possible_transports)
3013
# Find the revision ids
3014
if revision is None or len(revision) < 1 or revision[-1] is None:
3015
other_revision_id = _mod_revision.ensure_null(
3016
other_branch.last_revision())
3018
other_revision_id = revision[-1].as_revision_id(other_branch)
3019
if (revision is not None and len(revision) == 2
3020
and revision[0] is not None):
3021
base_revision_id = revision[0].as_revision_id(base_branch)
3023
base_revision_id = None
3024
# Remember where we merge from
3025
if ((remember or tree.branch.get_submit_branch() is None) and
3026
user_location is not None):
3027
tree.branch.set_submit_branch(other_branch.base)
3028
_merge_tags_if_possible(other_branch, tree.branch)
3029
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3030
other_revision_id, base_revision_id, other_branch, base_branch)
3031
if other_path != '':
3032
allow_pending = False
3033
merger.interesting_files = [other_path]
3035
allow_pending = True
3036
return merger, allow_pending
3038
def _select_branch_location(self, tree, user_location, revision=None,
3040
"""Select a branch location, according to possible inputs.
3042
If provided, branches from ``revision`` are preferred. (Both
3043
``revision`` and ``index`` must be supplied.)
3045
Otherwise, the ``location`` parameter is used. If it is None, then the
3046
``submit`` or ``parent`` location is used, and a note is printed.
3048
:param tree: The working tree to select a branch for merging into
3049
:param location: The location entered by the user
3050
:param revision: The revision parameter to the command
3051
:param index: The index to use for the revision parameter. Negative
3052
indices are permitted.
3053
:return: (selected_location, user_location). The default location
3054
will be the user-entered location.
3056
if (revision is not None and index is not None
3057
and revision[index] is not None):
3058
branch = revision[index].get_branch()
3059
if branch is not None:
3060
return branch, branch
3061
if user_location is None:
3062
location = self._get_remembered(tree, 'Merging from')
3064
location = user_location
3065
return location, user_location
3067
def _get_remembered(self, tree, verb_string):
3068
"""Use tree.branch's parent if none was supplied.
3070
Report if the remembered location was used.
3072
stored_location = tree.branch.get_submit_branch()
3073
stored_location_type = "submit"
3074
if stored_location is None:
3075
stored_location = tree.branch.get_parent()
3076
stored_location_type = "parent"
3077
mutter("%s", stored_location)
3078
if stored_location is None:
3079
raise errors.BzrCommandError("No location specified or remembered")
3080
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3081
note(u"%s remembered %s location %s", verb_string,
3082
stored_location_type, display_url)
3083
return stored_location
3086
class cmd_remerge(Command):
3089
Use this if you want to try a different merge technique while resolving
3090
conflicts. Some merge techniques are better than others, and remerge
3091
lets you try different ones on different files.
3093
The options for remerge have the same meaning and defaults as the ones for
3094
merge. The difference is that remerge can (only) be run when there is a
3095
pending merge, and it lets you specify particular files.
3098
Re-do the merge of all conflicted files, and show the base text in
3099
conflict regions, in addition to the usual THIS and OTHER texts::
3101
bzr remerge --show-base
3103
Re-do the merge of "foobar", using the weave merge algorithm, with
3104
additional processing to reduce the size of conflict regions::
3106
bzr remerge --merge-type weave --reprocess foobar
3108
takes_args = ['file*']
3113
help="Show base revision text in conflicts."),
3116
def run(self, file_list=None, merge_type=None, show_base=False,
3118
if merge_type is None:
3119
merge_type = _mod_merge.Merge3Merger
3120
tree, file_list = tree_files(file_list)
3123
parents = tree.get_parent_ids()
3124
if len(parents) != 2:
3125
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3126
" merges. Not cherrypicking or"
3128
repository = tree.branch.repository
3129
interesting_ids = None
3131
conflicts = tree.conflicts()
3132
if file_list is not None:
3133
interesting_ids = set()
3134
for filename in file_list:
3135
file_id = tree.path2id(filename)
3137
raise errors.NotVersionedError(filename)
3138
interesting_ids.add(file_id)
3139
if tree.kind(file_id) != "directory":
3142
for name, ie in tree.inventory.iter_entries(file_id):
3143
interesting_ids.add(ie.file_id)
3144
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3146
# Remerge only supports resolving contents conflicts
3147
allowed_conflicts = ('text conflict', 'contents conflict')
3148
restore_files = [c.path for c in conflicts
3149
if c.typestring in allowed_conflicts]
3150
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3151
tree.set_conflicts(ConflictList(new_conflicts))
3152
if file_list is not None:
3153
restore_files = file_list
3154
for filename in restore_files:
3156
restore(tree.abspath(filename))
3157
except errors.NotConflicted:
3159
# Disable pending merges, because the file texts we are remerging
3160
# have not had those merges performed. If we use the wrong parents
3161
# list, we imply that the working tree text has seen and rejected
3162
# all the changes from the other tree, when in fact those changes
3163
# have not yet been seen.
3164
pb = ui.ui_factory.nested_progress_bar()
3165
tree.set_parent_ids(parents[:1])
3167
merger = _mod_merge.Merger.from_revision_ids(pb,
3169
merger.interesting_ids = interesting_ids
3170
merger.merge_type = merge_type
3171
merger.show_base = show_base
3172
merger.reprocess = reprocess
3173
conflicts = merger.do_merge()
3175
tree.set_parent_ids(parents)
3185
class cmd_revert(Command):
3186
"""Revert files to a previous revision.
3188
Giving a list of files will revert only those files. Otherwise, all files
3189
will be reverted. If the revision is not specified with '--revision', the
3190
last committed revision is used.
3192
To remove only some changes, without reverting to a prior version, use
3193
merge instead. For example, "merge . --revision -2..-3" will remove the
3194
changes introduced by -2, without affecting the changes introduced by -1.
3195
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3197
By default, any files that have been manually changed will be backed up
3198
first. (Files changed only by merge are not backed up.) Backup files have
3199
'.~#~' appended to their name, where # is a number.
3201
When you provide files, you can use their current pathname or the pathname
3202
from the target revision. So you can use revert to "undelete" a file by
3203
name. If you name a directory, all the contents of that directory will be
3206
Any files that have been newly added since that revision will be deleted,
3207
with a backup kept if appropriate. Directories containing unknown files
3208
will not be deleted.
3210
The working tree contains a list of pending merged revisions, which will
3211
be included as parents in the next commit. Normally, revert clears that
3212
list as well as reverting the files. If any files are specified, revert
3213
leaves the pending merge list alone and reverts only the files. Use "bzr
3214
revert ." in the tree root to revert all files but keep the merge record,
3215
and "bzr revert --forget-merges" to clear the pending merge list without
3216
reverting any files.
3219
_see_also = ['cat', 'export']
3222
Option('no-backup', "Do not save backups of reverted files."),
3223
Option('forget-merges',
3224
'Remove pending merge marker, without changing any files.'),
3226
takes_args = ['file*']
3228
def run(self, revision=None, no_backup=False, file_list=None,
3229
forget_merges=None):
3230
tree, file_list = tree_files(file_list)
3232
tree.set_parent_ids(tree.get_parent_ids()[:1])
3234
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3237
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3238
if revision is None:
3239
rev_id = tree.last_revision()
3240
elif len(revision) != 1:
3241
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3243
rev_id = revision[0].as_revision_id(tree.branch)
3244
pb = ui.ui_factory.nested_progress_bar()
3246
tree.revert(file_list,
3247
tree.branch.repository.revision_tree(rev_id),
3248
not no_backup, pb, report_changes=True)
3253
class cmd_assert_fail(Command):
3254
"""Test reporting of assertion failures"""
3255
# intended just for use in testing
3260
raise AssertionError("always fails")
3263
class cmd_help(Command):
3264
"""Show help on a command or other topic.
3267
_see_also = ['topics']
3269
Option('long', 'Show help on all commands.'),
3271
takes_args = ['topic?']
3272
aliases = ['?', '--help', '-?', '-h']
3275
def run(self, topic=None, long=False):
3277
if topic is None and long:
3279
bzrlib.help.help(topic)
3282
class cmd_shell_complete(Command):
3283
"""Show appropriate completions for context.
3285
For a list of all available commands, say 'bzr shell-complete'.
3287
takes_args = ['context?']
3292
def run(self, context=None):
3293
import shellcomplete
3294
shellcomplete.shellcomplete(context)
3297
class cmd_missing(Command):
3298
"""Show unmerged/unpulled revisions between two branches.
3300
OTHER_BRANCH may be local or remote.
3303
_see_also = ['merge', 'pull']
3304
takes_args = ['other_branch?']
3306
Option('reverse', 'Reverse the order of revisions.'),
3308
'Display changes in the local branch only.'),
3309
Option('this' , 'Same as --mine-only.'),
3310
Option('theirs-only',
3311
'Display changes in the remote branch only.'),
3312
Option('other', 'Same as --theirs-only.'),
3317
encoding_type = 'replace'
3320
def run(self, other_branch=None, reverse=False, mine_only=False,
3321
theirs_only=False, log_format=None, long=False, short=False, line=False,
3322
show_ids=False, verbose=False, this=False, other=False):
3323
from bzrlib.missing import find_unmerged, iter_log_revisions
3329
# TODO: We should probably check that we don't have mine-only and
3330
# theirs-only set, but it gets complicated because we also have
3331
# this and other which could be used.
3338
local_branch = Branch.open_containing(u".")[0]
3339
parent = local_branch.get_parent()
3340
if other_branch is None:
3341
other_branch = parent
3342
if other_branch is None:
3343
raise errors.BzrCommandError("No peer location known"
3345
display_url = urlutils.unescape_for_display(parent,
3347
self.outf.write("Using saved parent location: "
3348
+ display_url + "\n")
3350
remote_branch = Branch.open(other_branch)
3351
if remote_branch.base == local_branch.base:
3352
remote_branch = local_branch
3353
local_branch.lock_read()
3355
remote_branch.lock_read()
3357
local_extra, remote_extra = find_unmerged(
3358
local_branch, remote_branch, restrict)
3360
if log_format is None:
3361
registry = log.log_formatter_registry
3362
log_format = registry.get_default(local_branch)
3363
lf = log_format(to_file=self.outf,
3365
show_timezone='original')
3366
if reverse is False:
3367
if local_extra is not None:
3368
local_extra.reverse()
3369
if remote_extra is not None:
3370
remote_extra.reverse()
3373
if local_extra and not theirs_only:
3374
self.outf.write("You have %d extra revision(s):\n" %
3376
for revision in iter_log_revisions(local_extra,
3377
local_branch.repository,
3379
lf.log_revision(revision)
3380
printed_local = True
3383
printed_local = False
3385
if remote_extra and not mine_only:
3386
if printed_local is True:
3387
self.outf.write("\n\n\n")
3388
self.outf.write("You are missing %d revision(s):\n" %
3390
for revision in iter_log_revisions(remote_extra,
3391
remote_branch.repository,
3393
lf.log_revision(revision)
3396
if mine_only and not local_extra:
3397
# We checked local, and found nothing extra
3398
self.outf.write('This branch is up to date.\n')
3399
elif theirs_only and not remote_extra:
3400
# We checked remote, and found nothing extra
3401
self.outf.write('Other branch is up to date.\n')
3402
elif not (mine_only or theirs_only or local_extra or
3404
# We checked both branches, and neither one had extra
3406
self.outf.write("Branches are up to date.\n")
3408
remote_branch.unlock()
3410
local_branch.unlock()
3411
if not status_code and parent is None and other_branch is not None:
3412
local_branch.lock_write()
3414
# handle race conditions - a parent might be set while we run.
3415
if local_branch.get_parent() is None:
3416
local_branch.set_parent(remote_branch.base)
3418
local_branch.unlock()
3422
class cmd_pack(Command):
3423
"""Compress the data within a repository."""
3425
_see_also = ['repositories']
3426
takes_args = ['branch_or_repo?']
3428
def run(self, branch_or_repo='.'):
3429
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3431
branch = dir.open_branch()
3432
repository = branch.repository
3433
except errors.NotBranchError:
3434
repository = dir.open_repository()
3438
class cmd_plugins(Command):
3439
"""List the installed plugins.
3441
This command displays the list of installed plugins including
3442
version of plugin and a short description of each.
3444
--verbose shows the path where each plugin is located.
3446
A plugin is an external component for Bazaar that extends the
3447
revision control system, by adding or replacing code in Bazaar.
3448
Plugins can do a variety of things, including overriding commands,
3449
adding new commands, providing additional network transports and
3450
customizing log output.
3452
See the Bazaar web site, http://bazaar-vcs.org, for further
3453
information on plugins including where to find them and how to
3454
install them. Instructions are also provided there on how to
3455
write new plugins using the Python programming language.
3457
takes_options = ['verbose']
3460
def run(self, verbose=False):
3461
import bzrlib.plugin
3462
from inspect import getdoc
3464
for name, plugin in bzrlib.plugin.plugins().items():
3465
version = plugin.__version__
3466
if version == 'unknown':
3468
name_ver = '%s %s' % (name, version)
3469
d = getdoc(plugin.module)
3471
doc = d.split('\n')[0]
3473
doc = '(no description)'
3474
result.append((name_ver, doc, plugin.path()))
3475
for name_ver, doc, path in sorted(result):
3483
class cmd_testament(Command):
3484
"""Show testament (signing-form) of a revision."""
3487
Option('long', help='Produce long-format testament.'),
3489
help='Produce a strict-format testament.')]
3490
takes_args = ['branch?']
3492
def run(self, branch=u'.', revision=None, long=False, strict=False):
3493
from bzrlib.testament import Testament, StrictTestament
3495
testament_class = StrictTestament
3497
testament_class = Testament
3499
b = Branch.open_containing(branch)[0]
3501
b = Branch.open(branch)
3504
if revision is None:
3505
rev_id = b.last_revision()
3507
rev_id = revision[0].as_revision_id(b)
3508
t = testament_class.from_revision(b.repository, rev_id)
3510
sys.stdout.writelines(t.as_text_lines())
3512
sys.stdout.write(t.as_short_text())
3517
class cmd_annotate(Command):
3518
"""Show the origin of each line in a file.
3520
This prints out the given file with an annotation on the left side
3521
indicating which revision, author and date introduced the change.
3523
If the origin is the same for a run of consecutive lines, it is
3524
shown only at the top, unless the --all option is given.
3526
# TODO: annotate directories; showing when each file was last changed
3527
# TODO: if the working copy is modified, show annotations on that
3528
# with new uncommitted lines marked
3529
aliases = ['ann', 'blame', 'praise']
3530
takes_args = ['filename']
3531
takes_options = [Option('all', help='Show annotations on all lines.'),
3532
Option('long', help='Show commit date in annotations.'),
3536
encoding_type = 'exact'
3539
def run(self, filename, all=False, long=False, revision=None,
3541
from bzrlib.annotate import annotate_file
3542
wt, branch, relpath = \
3543
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3549
if revision is None:
3550
revision_id = branch.last_revision()
3551
elif len(revision) != 1:
3552
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3554
revision_id = revision[0].as_revision_id(branch)
3555
tree = branch.repository.revision_tree(revision_id)
3557
file_id = wt.path2id(relpath)
3559
file_id = tree.path2id(relpath)
3561
raise errors.NotVersionedError(filename)
3562
file_version = tree.inventory[file_id].revision
3563
annotate_file(branch, file_version, file_id, long, all, self.outf,
3572
class cmd_re_sign(Command):
3573
"""Create a digital signature for an existing revision."""
3574
# TODO be able to replace existing ones.
3576
hidden = True # is this right ?
3577
takes_args = ['revision_id*']
3578
takes_options = ['revision']
3580
def run(self, revision_id_list=None, revision=None):
3581
if revision_id_list is not None and revision is not None:
3582
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3583
if revision_id_list is None and revision is None:
3584
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3585
b = WorkingTree.open_containing(u'.')[0].branch
3588
return self._run(b, revision_id_list, revision)
3592
def _run(self, b, revision_id_list, revision):
3593
import bzrlib.gpg as gpg
3594
gpg_strategy = gpg.GPGStrategy(b.get_config())
3595
if revision_id_list is not None:
3596
b.repository.start_write_group()
3598
for revision_id in revision_id_list:
3599
b.repository.sign_revision(revision_id, gpg_strategy)
3601
b.repository.abort_write_group()
3604
b.repository.commit_write_group()
3605
elif revision is not None:
3606
if len(revision) == 1:
3607
revno, rev_id = revision[0].in_history(b)
3608
b.repository.start_write_group()
3610
b.repository.sign_revision(rev_id, gpg_strategy)
3612
b.repository.abort_write_group()
3615
b.repository.commit_write_group()
3616
elif len(revision) == 2:
3617
# are they both on rh- if so we can walk between them
3618
# might be nice to have a range helper for arbitrary
3619
# revision paths. hmm.
3620
from_revno, from_revid = revision[0].in_history(b)
3621
to_revno, to_revid = revision[1].in_history(b)
3622
if to_revid is None:
3623
to_revno = b.revno()
3624
if from_revno is None or to_revno is None:
3625
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3626
b.repository.start_write_group()
3628
for revno in range(from_revno, to_revno + 1):
3629
b.repository.sign_revision(b.get_rev_id(revno),
3632
b.repository.abort_write_group()
3635
b.repository.commit_write_group()
3637
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3640
class cmd_bind(Command):
3641
"""Convert the current branch into a checkout of the supplied branch.
3643
Once converted into a checkout, commits must succeed on the master branch
3644
before they will be applied to the local branch.
3647
_see_also = ['checkouts', 'unbind']
3648
takes_args = ['location?']
3651
def run(self, location=None):
3652
b, relpath = Branch.open_containing(u'.')
3653
if location is None:
3655
location = b.get_old_bound_location()
3656
except errors.UpgradeRequired:
3657
raise errors.BzrCommandError('No location supplied. '
3658
'This format does not remember old locations.')
3660
if location is None:
3661
raise errors.BzrCommandError('No location supplied and no '
3662
'previous location known')
3663
b_other = Branch.open(location)
3666
except errors.DivergedBranches:
3667
raise errors.BzrCommandError('These branches have diverged.'
3668
' Try merging, and then bind again.')
3671
class cmd_unbind(Command):
3672
"""Convert the current checkout into a regular branch.
3674
After unbinding, the local branch is considered independent and subsequent
3675
commits will be local only.
3678
_see_also = ['checkouts', 'bind']
3683
b, relpath = Branch.open_containing(u'.')
3685
raise errors.BzrCommandError('Local branch is not bound')
3688
class cmd_uncommit(Command):
3689
"""Remove the last committed revision.
3691
--verbose will print out what is being removed.
3692
--dry-run will go through all the motions, but not actually
3695
If --revision is specified, uncommit revisions to leave the branch at the
3696
specified revision. For example, "bzr uncommit -r 15" will leave the
3697
branch at revision 15.
3699
Uncommit leaves the working tree ready for a new commit. The only change
3700
it may make is to restore any pending merges that were present before
3704
# TODO: jam 20060108 Add an option to allow uncommit to remove
3705
# unreferenced information in 'branch-as-repository' branches.
3706
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3707
# information in shared branches as well.
3708
_see_also = ['commit']
3709
takes_options = ['verbose', 'revision',
3710
Option('dry-run', help='Don\'t actually make changes.'),
3711
Option('force', help='Say yes to all questions.'),
3713
help="Only remove the commits from the local branch"
3714
" when in a checkout."
3717
takes_args = ['location?']
3719
encoding_type = 'replace'
3721
def run(self, location=None,
3722
dry_run=False, verbose=False,
3723
revision=None, force=False, local=False):
3724
if location is None:
3726
control, relpath = bzrdir.BzrDir.open_containing(location)
3728
tree = control.open_workingtree()
3730
except (errors.NoWorkingTree, errors.NotLocalUrl):
3732
b = control.open_branch()
3734
if tree is not None:
3739
return self._run(b, tree, dry_run, verbose, revision, force,
3742
if tree is not None:
3747
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3748
from bzrlib.log import log_formatter, show_log
3749
from bzrlib.uncommit import uncommit
3751
last_revno, last_rev_id = b.last_revision_info()
3754
if revision is None:
3756
rev_id = last_rev_id
3758
# 'bzr uncommit -r 10' actually means uncommit
3759
# so that the final tree is at revno 10.
3760
# but bzrlib.uncommit.uncommit() actually uncommits
3761
# the revisions that are supplied.
3762
# So we need to offset it by one
3763
revno = revision[0].in_history(b).revno + 1
3764
if revno <= last_revno:
3765
rev_id = b.get_rev_id(revno)
3767
if rev_id is None or _mod_revision.is_null(rev_id):
3768
self.outf.write('No revisions to uncommit.\n')
3771
lf = log_formatter('short',
3773
show_timezone='original')
3778
direction='forward',
3779
start_revision=revno,
3780
end_revision=last_revno)
3783
print 'Dry-run, pretending to remove the above revisions.'
3785
val = raw_input('Press <enter> to continue')
3787
print 'The above revision(s) will be removed.'
3789
val = raw_input('Are you sure [y/N]? ')
3790
if val.lower() not in ('y', 'yes'):
3794
mutter('Uncommitting from {%s} to {%s}',
3795
last_rev_id, rev_id)
3796
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3797
revno=revno, local=local)
3798
note('You can restore the old tip by running:\n'
3799
' bzr pull . -r revid:%s', last_rev_id)
3802
class cmd_break_lock(Command):
3803
"""Break a dead lock on a repository, branch or working directory.
3805
CAUTION: Locks should only be broken when you are sure that the process
3806
holding the lock has been stopped.
3808
You can get information on what locks are open via the 'bzr info' command.
3813
takes_args = ['location?']
3815
def run(self, location=None, show=False):
3816
if location is None:
3818
control, relpath = bzrdir.BzrDir.open_containing(location)
3820
control.break_lock()
3821
except NotImplementedError:
3825
class cmd_wait_until_signalled(Command):
3826
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3828
This just prints a line to signal when it is ready, then blocks on stdin.
3834
sys.stdout.write("running\n")
3836
sys.stdin.readline()
3839
class cmd_serve(Command):
3840
"""Run the bzr server."""
3842
aliases = ['server']
3846
help='Serve on stdin/out for use from inetd or sshd.'),
3848
help='Listen for connections on nominated port of the form '
3849
'[hostname:]portnumber. Passing 0 as the port number will '
3850
'result in a dynamically allocated port. The default port is '
3854
help='Serve contents of this directory.',
3856
Option('allow-writes',
3857
help='By default the server is a readonly server. Supplying '
3858
'--allow-writes enables write access to the contents of '
3859
'the served directory and below.'
3863
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3864
from bzrlib import lockdir
3865
from bzrlib.smart import medium, server
3866
from bzrlib.transport import get_transport
3867
from bzrlib.transport.chroot import ChrootServer
3868
if directory is None:
3869
directory = os.getcwd()
3870
url = urlutils.local_path_to_url(directory)
3871
if not allow_writes:
3872
url = 'readonly+' + url
3873
chroot_server = ChrootServer(get_transport(url))
3874
chroot_server.setUp()
3875
t = get_transport(chroot_server.get_url())
3877
smart_server = medium.SmartServerPipeStreamMedium(
3878
sys.stdin, sys.stdout, t)
3880
host = medium.BZR_DEFAULT_INTERFACE
3882
port = medium.BZR_DEFAULT_PORT
3885
host, port = port.split(':')
3887
smart_server = server.SmartTCPServer(t, host=host, port=port)
3888
print 'listening on port: ', smart_server.port
3890
# for the duration of this server, no UI output is permitted.
3891
# note that this may cause problems with blackbox tests. This should
3892
# be changed with care though, as we dont want to use bandwidth sending
3893
# progress over stderr to smart server clients!
3894
old_factory = ui.ui_factory
3895
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3897
ui.ui_factory = ui.SilentUIFactory()
3898
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3899
smart_server.serve()
3901
ui.ui_factory = old_factory
3902
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3905
class cmd_join(Command):
3906
"""Combine a subtree into its containing tree.
3908
This command is for experimental use only. It requires the target tree
3909
to be in dirstate-with-subtree format, which cannot be converted into
3912
The TREE argument should be an independent tree, inside another tree, but
3913
not part of it. (Such trees can be produced by "bzr split", but also by
3914
running "bzr branch" with the target inside a tree.)
3916
The result is a combined tree, with the subtree no longer an independant
3917
part. This is marked as a merge of the subtree into the containing tree,
3918
and all history is preserved.
3920
If --reference is specified, the subtree retains its independence. It can
3921
be branched by itself, and can be part of multiple projects at the same
3922
time. But operations performed in the containing tree, such as commit
3923
and merge, will recurse into the subtree.
3926
_see_also = ['split']
3927
takes_args = ['tree']
3929
Option('reference', help='Join by reference.'),
3933
def run(self, tree, reference=False):
3934
sub_tree = WorkingTree.open(tree)
3935
parent_dir = osutils.dirname(sub_tree.basedir)
3936
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3937
repo = containing_tree.branch.repository
3938
if not repo.supports_rich_root():
3939
raise errors.BzrCommandError(
3940
"Can't join trees because %s doesn't support rich root data.\n"
3941
"You can use bzr upgrade on the repository."
3945
containing_tree.add_reference(sub_tree)
3946
except errors.BadReferenceTarget, e:
3947
# XXX: Would be better to just raise a nicely printable
3948
# exception from the real origin. Also below. mbp 20070306
3949
raise errors.BzrCommandError("Cannot join %s. %s" %
3953
containing_tree.subsume(sub_tree)
3954
except errors.BadSubsumeSource, e:
3955
raise errors.BzrCommandError("Cannot join %s. %s" %
3959
class cmd_split(Command):
3960
"""Split a subdirectory of a tree into a separate tree.
3962
This command will produce a target tree in a format that supports
3963
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
3964
converted into earlier formats like 'dirstate-tags'.
3966
The TREE argument should be a subdirectory of a working tree. That
3967
subdirectory will be converted into an independent tree, with its own
3968
branch. Commits in the top-level tree will not apply to the new subtree.
3971
# join is not un-hidden yet
3972
#_see_also = ['join']
3973
takes_args = ['tree']
3975
def run(self, tree):
3976
containing_tree, subdir = WorkingTree.open_containing(tree)
3977
sub_id = containing_tree.path2id(subdir)
3979
raise errors.NotVersionedError(subdir)
3981
containing_tree.extract(sub_id)
3982
except errors.RootNotRich:
3983
raise errors.UpgradeRequired(containing_tree.branch.base)
3986
class cmd_merge_directive(Command):
3987
"""Generate a merge directive for auto-merge tools.
3989
A directive requests a merge to be performed, and also provides all the
3990
information necessary to do so. This means it must either include a
3991
revision bundle, or the location of a branch containing the desired
3994
A submit branch (the location to merge into) must be supplied the first
3995
time the command is issued. After it has been supplied once, it will
3996
be remembered as the default.
3998
A public branch is optional if a revision bundle is supplied, but required
3999
if --diff or --plain is specified. It will be remembered as the default
4000
after the first use.
4003
takes_args = ['submit_branch?', 'public_branch?']
4007
_see_also = ['send']
4010
RegistryOption.from_kwargs('patch-type',
4011
'The type of patch to include in the directive.',
4013
value_switches=True,
4015
bundle='Bazaar revision bundle (default).',
4016
diff='Normal unified diff.',
4017
plain='No patch, just directive.'),
4018
Option('sign', help='GPG-sign the directive.'), 'revision',
4019
Option('mail-to', type=str,
4020
help='Instead of printing the directive, email to this address.'),
4021
Option('message', type=str, short_name='m',
4022
help='Message to use when committing this merge.')
4025
encoding_type = 'exact'
4027
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4028
sign=False, revision=None, mail_to=None, message=None):
4029
from bzrlib.revision import ensure_null, NULL_REVISION
4030
include_patch, include_bundle = {
4031
'plain': (False, False),
4032
'diff': (True, False),
4033
'bundle': (True, True),
4035
branch = Branch.open('.')
4036
stored_submit_branch = branch.get_submit_branch()
4037
if submit_branch is None:
4038
submit_branch = stored_submit_branch
4040
if stored_submit_branch is None:
4041
branch.set_submit_branch(submit_branch)
4042
if submit_branch is None:
4043
submit_branch = branch.get_parent()
4044
if submit_branch is None:
4045
raise errors.BzrCommandError('No submit branch specified or known')
4047
stored_public_branch = branch.get_public_branch()
4048
if public_branch is None:
4049
public_branch = stored_public_branch
4050
elif stored_public_branch is None:
4051
branch.set_public_branch(public_branch)
4052
if not include_bundle and public_branch is None:
4053
raise errors.BzrCommandError('No public branch specified or'
4055
base_revision_id = None
4056
if revision is not None:
4057
if len(revision) > 2:
4058
raise errors.BzrCommandError('bzr merge-directive takes '
4059
'at most two one revision identifiers')
4060
revision_id = revision[-1].as_revision_id(branch)
4061
if len(revision) == 2:
4062
base_revision_id = revision[0].as_revision_id(branch)
4064
revision_id = branch.last_revision()
4065
revision_id = ensure_null(revision_id)
4066
if revision_id == NULL_REVISION:
4067
raise errors.BzrCommandError('No revisions to bundle.')
4068
directive = merge_directive.MergeDirective2.from_objects(
4069
branch.repository, revision_id, time.time(),
4070
osutils.local_time_offset(), submit_branch,
4071
public_branch=public_branch, include_patch=include_patch,
4072
include_bundle=include_bundle, message=message,
4073
base_revision_id=base_revision_id)
4076
self.outf.write(directive.to_signed(branch))
4078
self.outf.writelines(directive.to_lines())
4080
message = directive.to_email(mail_to, branch, sign)
4081
s = SMTPConnection(branch.get_config())
4082
s.send_email(message)
4085
class cmd_send(Command):
4086
"""Mail or create a merge-directive for submiting changes.
4088
A merge directive provides many things needed for requesting merges:
4090
* A machine-readable description of the merge to perform
4092
* An optional patch that is a preview of the changes requested
4094
* An optional bundle of revision data, so that the changes can be applied
4095
directly from the merge directive, without retrieving data from a
4098
If --no-bundle is specified, then public_branch is needed (and must be
4099
up-to-date), so that the receiver can perform the merge using the
4100
public_branch. The public_branch is always included if known, so that
4101
people can check it later.
4103
The submit branch defaults to the parent, but can be overridden. Both
4104
submit branch and public branch will be remembered if supplied.
4106
If a public_branch is known for the submit_branch, that public submit
4107
branch is used in the merge instructions. This means that a local mirror
4108
can be used as your actual submit branch, once you have set public_branch
4111
Mail is sent using your preferred mail program. This should be transparent
4112
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4113
If the preferred client can't be found (or used), your editor will be used.
4115
To use a specific mail program, set the mail_client configuration option.
4116
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4117
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4118
generic options are "default", "editor", "emacsclient", "mapi", and
4119
"xdg-email". Plugins may also add supported clients.
4121
If mail is being sent, a to address is required. This can be supplied
4122
either on the commandline, by setting the submit_to configuration
4123
option in the branch itself or the child_submit_to configuration option
4124
in the submit branch.
4126
Two formats are currently supported: "4" uses revision bundle format 4 and
4127
merge directive format 2. It is significantly faster and smaller than
4128
older formats. It is compatible with Bazaar 0.19 and later. It is the
4129
default. "0.9" uses revision bundle format 0.9 and merge directive
4130
format 1. It is compatible with Bazaar 0.12 - 0.18.
4132
Merge directives are applied using the merge command or the pull command.
4135
encoding_type = 'exact'
4137
_see_also = ['merge', 'pull']
4139
takes_args = ['submit_branch?', 'public_branch?']
4143
help='Do not include a bundle in the merge directive.'),
4144
Option('no-patch', help='Do not include a preview patch in the merge'
4147
help='Remember submit and public branch.'),
4149
help='Branch to generate the submission from, '
4150
'rather than the one containing the working directory.',
4153
Option('output', short_name='o',
4154
help='Write merge directive to this file; '
4155
'use - for stdout.',
4157
Option('mail-to', help='Mail the request to this address.',
4161
RegistryOption.from_kwargs('format',
4162
'Use the specified output format.',
4163
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4164
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4167
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4168
no_patch=False, revision=None, remember=False, output=None,
4169
format='4', mail_to=None, message=None, **kwargs):
4170
return self._run(submit_branch, revision, public_branch, remember,
4171
format, no_bundle, no_patch, output,
4172
kwargs.get('from', '.'), mail_to, message)
4174
def _run(self, submit_branch, revision, public_branch, remember, format,
4175
no_bundle, no_patch, output, from_, mail_to, message):
4176
from bzrlib.revision import NULL_REVISION
4177
branch = Branch.open_containing(from_)[0]
4179
outfile = StringIO()
4183
outfile = open(output, 'wb')
4184
# we may need to write data into branch's repository to calculate
4189
config = branch.get_config()
4191
mail_to = config.get_user_option('submit_to')
4192
mail_client = config.get_mail_client()
4193
if remember and submit_branch is None:
4194
raise errors.BzrCommandError(
4195
'--remember requires a branch to be specified.')
4196
stored_submit_branch = branch.get_submit_branch()
4197
remembered_submit_branch = None
4198
if submit_branch is None:
4199
submit_branch = stored_submit_branch
4200
remembered_submit_branch = "submit"
4202
if stored_submit_branch is None or remember:
4203
branch.set_submit_branch(submit_branch)
4204
if submit_branch is None:
4205
submit_branch = branch.get_parent()
4206
remembered_submit_branch = "parent"
4207
if submit_branch is None:
4208
raise errors.BzrCommandError('No submit branch known or'
4210
if remembered_submit_branch is not None:
4211
note('Using saved %s location "%s" to determine what '
4212
'changes to submit.', remembered_submit_branch,
4216
submit_config = Branch.open(submit_branch).get_config()
4217
mail_to = submit_config.get_user_option("child_submit_to")
4219
stored_public_branch = branch.get_public_branch()
4220
if public_branch is None:
4221
public_branch = stored_public_branch
4222
elif stored_public_branch is None or remember:
4223
branch.set_public_branch(public_branch)
4224
if no_bundle and public_branch is None:
4225
raise errors.BzrCommandError('No public branch specified or'
4227
base_revision_id = None
4229
if revision is not None:
4230
if len(revision) > 2:
4231
raise errors.BzrCommandError('bzr send takes '
4232
'at most two one revision identifiers')
4233
revision_id = revision[-1].as_revision_id(branch)
4234
if len(revision) == 2:
4235
base_revision_id = revision[0].as_revision_id(branch)
4236
if revision_id is None:
4237
revision_id = branch.last_revision()
4238
if revision_id == NULL_REVISION:
4239
raise errors.BzrCommandError('No revisions to submit.')
4241
directive = merge_directive.MergeDirective2.from_objects(
4242
branch.repository, revision_id, time.time(),
4243
osutils.local_time_offset(), submit_branch,
4244
public_branch=public_branch, include_patch=not no_patch,
4245
include_bundle=not no_bundle, message=message,
4246
base_revision_id=base_revision_id)
4247
elif format == '0.9':
4250
patch_type = 'bundle'
4252
raise errors.BzrCommandError('Format 0.9 does not'
4253
' permit bundle with no patch')
4259
directive = merge_directive.MergeDirective.from_objects(
4260
branch.repository, revision_id, time.time(),
4261
osutils.local_time_offset(), submit_branch,
4262
public_branch=public_branch, patch_type=patch_type,
4265
outfile.writelines(directive.to_lines())
4267
subject = '[MERGE] '
4268
if message is not None:
4271
revision = branch.repository.get_revision(revision_id)
4272
subject += revision.get_summary()
4273
basename = directive.get_disk_name(branch)
4274
mail_client.compose_merge_request(mail_to, subject,
4275
outfile.getvalue(), basename)
4282
class cmd_bundle_revisions(cmd_send):
4284
"""Create a merge-directive for submiting changes.
4286
A merge directive provides many things needed for requesting merges:
4288
* A machine-readable description of the merge to perform
4290
* An optional patch that is a preview of the changes requested
4292
* An optional bundle of revision data, so that the changes can be applied
4293
directly from the merge directive, without retrieving data from a
4296
If --no-bundle is specified, then public_branch is needed (and must be
4297
up-to-date), so that the receiver can perform the merge using the
4298
public_branch. The public_branch is always included if known, so that
4299
people can check it later.
4301
The submit branch defaults to the parent, but can be overridden. Both
4302
submit branch and public branch will be remembered if supplied.
4304
If a public_branch is known for the submit_branch, that public submit
4305
branch is used in the merge instructions. This means that a local mirror
4306
can be used as your actual submit branch, once you have set public_branch
4309
Two formats are currently supported: "4" uses revision bundle format 4 and
4310
merge directive format 2. It is significantly faster and smaller than
4311
older formats. It is compatible with Bazaar 0.19 and later. It is the
4312
default. "0.9" uses revision bundle format 0.9 and merge directive
4313
format 1. It is compatible with Bazaar 0.12 - 0.18.
4318
help='Do not include a bundle in the merge directive.'),
4319
Option('no-patch', help='Do not include a preview patch in the merge'
4322
help='Remember submit and public branch.'),
4324
help='Branch to generate the submission from, '
4325
'rather than the one containing the working directory.',
4328
Option('output', short_name='o', help='Write directive to this file.',
4331
RegistryOption.from_kwargs('format',
4332
'Use the specified output format.',
4333
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4334
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4336
aliases = ['bundle']
4338
_see_also = ['send', 'merge']
4342
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4343
no_patch=False, revision=None, remember=False, output=None,
4344
format='4', **kwargs):
4347
return self._run(submit_branch, revision, public_branch, remember,
4348
format, no_bundle, no_patch, output,
4349
kwargs.get('from', '.'), None, None)
4352
class cmd_tag(Command):
4353
"""Create, remove or modify a tag naming a revision.
4355
Tags give human-meaningful names to revisions. Commands that take a -r
4356
(--revision) option can be given -rtag:X, where X is any previously
4359
Tags are stored in the branch. Tags are copied from one branch to another
4360
along when you branch, push, pull or merge.
4362
It is an error to give a tag name that already exists unless you pass
4363
--force, in which case the tag is moved to point to the new revision.
4365
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4366
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4369
_see_also = ['commit', 'tags']
4370
takes_args = ['tag_name']
4373
help='Delete this tag rather than placing it.',
4376
help='Branch in which to place the tag.',
4381
help='Replace existing tags.',
4386
def run(self, tag_name,
4392
branch, relpath = Branch.open_containing(directory)
4396
branch.tags.delete_tag(tag_name)
4397
self.outf.write('Deleted tag %s.\n' % tag_name)
4400
if len(revision) != 1:
4401
raise errors.BzrCommandError(
4402
"Tags can only be placed on a single revision, "
4404
revision_id = revision[0].as_revision_id(branch)
4406
revision_id = branch.last_revision()
4407
if (not force) and branch.tags.has_tag(tag_name):
4408
raise errors.TagAlreadyExists(tag_name)
4409
branch.tags.set_tag(tag_name, revision_id)
4410
self.outf.write('Created tag %s.\n' % tag_name)
4415
class cmd_tags(Command):
4418
This command shows a table of tag names and the revisions they reference.
4424
help='Branch whose tags should be displayed.',
4428
RegistryOption.from_kwargs('sort',
4429
'Sort tags by different criteria.', title='Sorting',
4430
alpha='Sort tags lexicographically (default).',
4431
time='Sort tags chronologically.',
4442
branch, relpath = Branch.open_containing(directory)
4443
tags = branch.tags.get_tag_dict().items()
4448
elif sort == 'time':
4450
for tag, revid in tags:
4452
revobj = branch.repository.get_revision(revid)
4453
except errors.NoSuchRevision:
4454
timestamp = sys.maxint # place them at the end
4456
timestamp = revobj.timestamp
4457
timestamps[revid] = timestamp
4458
tags.sort(key=lambda x: timestamps[x[1]])
4460
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4461
revno_map = branch.get_revision_id_to_revno_map()
4462
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4463
for tag, revid in tags ]
4464
for tag, revspec in tags:
4465
self.outf.write('%-20s %s\n' % (tag, revspec))
4468
class cmd_reconfigure(Command):
4469
"""Reconfigure the type of a bzr directory.
4471
A target configuration must be specified.
4473
For checkouts, the bind-to location will be auto-detected if not specified.
4474
The order of preference is
4475
1. For a lightweight checkout, the current bound location.
4476
2. For branches that used to be checkouts, the previously-bound location.
4477
3. The push location.
4478
4. The parent location.
4479
If none of these is available, --bind-to must be specified.
4482
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4483
takes_args = ['location?']
4484
takes_options = [RegistryOption.from_kwargs('target_type',
4485
title='Target type',
4486
help='The type to reconfigure the directory to.',
4487
value_switches=True, enum_switch=False,
4488
branch='Reconfigure to be an unbound branch '
4489
'with no working tree.',
4490
tree='Reconfigure to be an unbound branch '
4491
'with a working tree.',
4492
checkout='Reconfigure to be a bound branch '
4493
'with a working tree.',
4494
lightweight_checkout='Reconfigure to be a lightweight'
4495
' checkout (with no local history).',
4496
standalone='Reconfigure to be a standalone branch '
4497
'(i.e. stop using shared repository).',
4498
use_shared='Reconfigure to use a shared repository.'),
4499
Option('bind-to', help='Branch to bind checkout to.',
4502
help='Perform reconfiguration even if local changes'
4506
def run(self, location=None, target_type=None, bind_to=None, force=False):
4507
directory = bzrdir.BzrDir.open(location)
4508
if target_type is None:
4509
raise errors.BzrCommandError('No target configuration specified')
4510
elif target_type == 'branch':
4511
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4512
elif target_type == 'tree':
4513
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4514
elif target_type == 'checkout':
4515
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4517
elif target_type == 'lightweight-checkout':
4518
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4520
elif target_type == 'use-shared':
4521
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4522
elif target_type == 'standalone':
4523
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4524
reconfiguration.apply(force)
4527
class cmd_switch(Command):
4528
"""Set the branch of a checkout and update.
4530
For lightweight checkouts, this changes the branch being referenced.
4531
For heavyweight checkouts, this checks that there are no local commits
4532
versus the current bound branch, then it makes the local branch a mirror
4533
of the new location and binds to it.
4535
In both cases, the working tree is updated and uncommitted changes
4536
are merged. The user can commit or revert these as they desire.
4538
Pending merges need to be committed or reverted before using switch.
4540
The path to the branch to switch to can be specified relative to the parent
4541
directory of the current branch. For example, if you are currently in a
4542
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4546
takes_args = ['to_location']
4547
takes_options = [Option('force',
4548
help='Switch even if local commits will be lost.')
4551
def run(self, to_location, force=False):
4552
from bzrlib import switch
4554
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4556
to_branch = Branch.open(to_location)
4557
except errors.NotBranchError:
4558
to_branch = Branch.open(
4559
control_dir.open_branch().base + '../' + to_location)
4560
switch.switch(control_dir, to_branch, force)
4561
note('Switched to branch: %s',
4562
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4565
class cmd_hooks(Command):
4566
"""Show a branch's currently registered hooks.
4570
takes_args = ['path?']
4572
def run(self, path=None):
4575
branch_hooks = Branch.open(path).hooks
4576
for hook_type in branch_hooks:
4577
hooks = branch_hooks[hook_type]
4578
self.outf.write("%s:\n" % (hook_type,))
4581
self.outf.write(" %s\n" %
4582
(branch_hooks.get_hook_name(hook),))
4584
self.outf.write(" <no hooks installed>\n")
4587
def _create_prefix(cur_transport):
4588
needed = [cur_transport]
4589
# Recurse upwards until we can create a directory successfully
4591
new_transport = cur_transport.clone('..')
4592
if new_transport.base == cur_transport.base:
4593
raise errors.BzrCommandError(
4594
"Failed to create path prefix for %s."
4595
% cur_transport.base)
4597
new_transport.mkdir('.')
4598
except errors.NoSuchFile:
4599
needed.append(new_transport)
4600
cur_transport = new_transport
4603
# Now we only need to create child directories
4605
cur_transport = needed.pop()
4606
cur_transport.ensure_base()
4609
# these get imported and then picked up by the scan for cmd_*
4610
# TODO: Some more consistent way to split command definitions across files;
4611
# we do need to load at least some information about them to know of
4612
# aliases. ideally we would avoid loading the implementation until the
4613
# details were needed.
4614
from bzrlib.cmd_version_info import cmd_version_info
4615
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4616
from bzrlib.bundle.commands import (
4619
from bzrlib.sign_my_commits import cmd_sign_my_commits
4620
from bzrlib.weave_commands import cmd_versionedfile_list, \
4621
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
