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 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 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 and
1078
delete them if they can easily be recovered using revert.
1080
You can specify one or more files, and/or --new. If you specify --new,
1081
only 'added' files will be removed. If you specify both, then new files
1082
in the specified directories will be removed. If the directories are
1083
also new, they will also be removed.
1085
takes_args = ['file*']
1086
takes_options = ['verbose',
1087
Option('new', help='Remove newly-added files.'),
1088
RegistryOption.from_kwargs('file-deletion-strategy',
1089
'The file deletion mode to be used.',
1090
title='Deletion Strategy', value_switches=True, enum_switch=False,
1091
safe='Only delete files if they can be'
1092
' safely recovered (default).',
1093
keep="Don't delete any files.",
1094
force='Delete all the specified files, even if they can not be '
1095
'recovered and even if they are non-empty directories.')]
1097
encoding_type = 'replace'
1099
def run(self, file_list, verbose=False, new=False,
1100
file_deletion_strategy='safe'):
1101
tree, file_list = tree_files(file_list)
1103
if file_list is not None:
1104
file_list = [f for f in file_list]
1106
raise errors.BzrCommandError('Specify one or more files to'
1107
' remove, or use --new.')
1110
added = tree.changes_from(tree.basis_tree(),
1111
specific_files=file_list).added
1112
file_list = sorted([f[0] for f in added], reverse=True)
1113
if len(file_list) == 0:
1114
raise errors.BzrCommandError('No matching files.')
1115
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1116
keep_files=file_deletion_strategy=='keep',
1117
force=file_deletion_strategy=='force')
1120
class cmd_file_id(Command):
1121
"""Print file_id of a particular file or directory.
1123
The file_id is assigned when the file is first added and remains the
1124
same through all revisions where the file exists, even when it is
1129
_see_also = ['inventory', 'ls']
1130
takes_args = ['filename']
1133
def run(self, filename):
1134
tree, relpath = WorkingTree.open_containing(filename)
1135
i = tree.path2id(relpath)
1137
raise errors.NotVersionedError(filename)
1139
self.outf.write(i + '\n')
1142
class cmd_file_path(Command):
1143
"""Print path of file_ids to a file or directory.
1145
This prints one line for each directory down to the target,
1146
starting at the branch root.
1150
takes_args = ['filename']
1153
def run(self, filename):
1154
tree, relpath = WorkingTree.open_containing(filename)
1155
fid = tree.path2id(relpath)
1157
raise errors.NotVersionedError(filename)
1158
segments = osutils.splitpath(relpath)
1159
for pos in range(1, len(segments) + 1):
1160
path = osutils.joinpath(segments[:pos])
1161
self.outf.write("%s\n" % tree.path2id(path))
1164
class cmd_reconcile(Command):
1165
"""Reconcile bzr metadata in a branch.
1167
This can correct data mismatches that may have been caused by
1168
previous ghost operations or bzr upgrades. You should only
1169
need to run this command if 'bzr check' or a bzr developer
1170
advises you to run it.
1172
If a second branch is provided, cross-branch reconciliation is
1173
also attempted, which will check that data like the tree root
1174
id which was not present in very early bzr versions is represented
1175
correctly in both branches.
1177
At the same time it is run it may recompress data resulting in
1178
a potential saving in disk space or performance gain.
1180
The branch *MUST* be on a listable system such as local disk or sftp.
1183
_see_also = ['check']
1184
takes_args = ['branch?']
1186
def run(self, branch="."):
1187
from bzrlib.reconcile import reconcile
1188
dir = bzrdir.BzrDir.open(branch)
1192
class cmd_revision_history(Command):
1193
"""Display the list of revision ids on a branch."""
1196
takes_args = ['location?']
1201
def run(self, location="."):
1202
branch = Branch.open_containing(location)[0]
1203
for revid in branch.revision_history():
1204
self.outf.write(revid)
1205
self.outf.write('\n')
1208
class cmd_ancestry(Command):
1209
"""List all revisions merged into this branch."""
1211
_see_also = ['log', 'revision-history']
1212
takes_args = ['location?']
1217
def run(self, location="."):
1219
wt = WorkingTree.open_containing(location)[0]
1220
except errors.NoWorkingTree:
1221
b = Branch.open(location)
1222
last_revision = b.last_revision()
1225
last_revision = wt.last_revision()
1227
revision_ids = b.repository.get_ancestry(last_revision)
1229
for revision_id in revision_ids:
1230
self.outf.write(revision_id + '\n')
1233
class cmd_init(Command):
1234
"""Make a directory into a versioned branch.
1236
Use this to create an empty branch, or before importing an
1239
If there is a repository in a parent directory of the location, then
1240
the history of the branch will be stored in the repository. Otherwise
1241
init creates a standalone branch which carries its own history
1242
in the .bzr directory.
1244
If there is already a branch at the location but it has no working tree,
1245
the tree can be populated with 'bzr checkout'.
1247
Recipe for importing a tree of files::
1253
bzr commit -m "imported project"
1256
_see_also = ['init-repository', 'branch', 'checkout']
1257
takes_args = ['location?']
1259
Option('create-prefix',
1260
help='Create the path leading up to the branch '
1261
'if it does not already exist.'),
1262
RegistryOption('format',
1263
help='Specify a format for this branch. '
1264
'See "help formats".',
1265
registry=bzrdir.format_registry,
1266
converter=bzrdir.format_registry.make_bzrdir,
1267
value_switches=True,
1268
title="Branch Format",
1270
Option('append-revisions-only',
1271
help='Never change revnos or the existing log.'
1272
' Append revisions to it only.')
1274
def run(self, location=None, format=None, append_revisions_only=False,
1275
create_prefix=False):
1277
format = bzrdir.format_registry.make_bzrdir('default')
1278
if location is None:
1281
to_transport = transport.get_transport(location)
1283
# The path has to exist to initialize a
1284
# branch inside of it.
1285
# Just using os.mkdir, since I don't
1286
# believe that we want to create a bunch of
1287
# locations if the user supplies an extended path
1289
to_transport.ensure_base()
1290
except errors.NoSuchFile:
1291
if not create_prefix:
1292
raise errors.BzrCommandError("Parent directory of %s"
1294
"\nYou may supply --create-prefix to create all"
1295
" leading parent directories."
1297
_create_prefix(to_transport)
1300
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1301
except errors.NotBranchError:
1302
# really a NotBzrDir error...
1303
create_branch = bzrdir.BzrDir.create_branch_convenience
1304
branch = create_branch(to_transport.base, format=format,
1305
possible_transports=[to_transport])
1307
from bzrlib.transport.local import LocalTransport
1308
if existing_bzrdir.has_branch():
1309
if (isinstance(to_transport, LocalTransport)
1310
and not existing_bzrdir.has_workingtree()):
1311
raise errors.BranchExistsWithoutWorkingTree(location)
1312
raise errors.AlreadyBranchError(location)
1314
branch = existing_bzrdir.create_branch()
1315
existing_bzrdir.create_workingtree()
1316
if append_revisions_only:
1318
branch.set_append_revisions_only(True)
1319
except errors.UpgradeRequired:
1320
raise errors.BzrCommandError('This branch format cannot be set'
1321
' to append-revisions-only. Try --experimental-branch6')
1323
from bzrlib.info import show_bzrdir_info
1324
show_bzrdir_info(bzrdir.BzrDir.open_containing_from_transport(
1325
to_transport)[0], verbose=0, outfile=self.outf)
1328
class cmd_init_repository(Command):
1329
"""Create a shared repository to hold branches.
1331
New branches created under the repository directory will store their
1332
revisions in the repository, not in the branch directory.
1334
If the --no-trees option is used then the branches in the repository
1335
will not have working trees by default.
1338
Create a shared repositories holding just branches::
1340
bzr init-repo --no-trees repo
1343
Make a lightweight checkout elsewhere::
1345
bzr checkout --lightweight repo/trunk trunk-checkout
1350
_see_also = ['init', 'branch', 'checkout', 'repositories']
1351
takes_args = ["location"]
1352
takes_options = [RegistryOption('format',
1353
help='Specify a format for this repository. See'
1354
' "bzr help formats" for details.',
1355
registry=bzrdir.format_registry,
1356
converter=bzrdir.format_registry.make_bzrdir,
1357
value_switches=True, title='Repository format'),
1359
help='Branches in the repository will default to'
1360
' not having a working tree.'),
1362
aliases = ["init-repo"]
1364
def run(self, location, format=None, no_trees=False):
1366
format = bzrdir.format_registry.make_bzrdir('default')
1368
if location is None:
1371
to_transport = transport.get_transport(location)
1372
to_transport.ensure_base()
1374
newdir = format.initialize_on_transport(to_transport)
1375
repo = newdir.create_repository(shared=True)
1376
repo.set_make_working_trees(not no_trees)
1378
from bzrlib.info import show_bzrdir_info
1379
show_bzrdir_info(bzrdir.BzrDir.open_containing_from_transport(
1380
to_transport)[0], verbose=0, outfile=self.outf)
1383
class cmd_diff(Command):
1384
"""Show differences in the working tree, between revisions or branches.
1386
If no arguments are given, all changes for the current tree are listed.
1387
If files are given, only the changes in those files are listed.
1388
Remote and multiple branches can be compared by using the --old and
1389
--new options. If not provided, the default for both is derived from
1390
the first argument, if any, or the current tree if no arguments are
1393
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1394
produces patches suitable for "patch -p1".
1398
2 - unrepresentable changes
1403
Shows the difference in the working tree versus the last commit::
1407
Difference between the working tree and revision 1::
1411
Difference between revision 2 and revision 1::
1415
Difference between revision 2 and revision 1 for branch xxx::
1419
Show just the differences for file NEWS::
1423
Show the differences in working tree xxx for file NEWS::
1427
Show the differences from branch xxx to this working tree:
1431
Show the differences between two branches for file NEWS::
1433
bzr diff --old xxx --new yyy NEWS
1435
Same as 'bzr diff' but prefix paths with old/ and new/::
1437
bzr diff --prefix old/:new/
1439
_see_also = ['status']
1440
takes_args = ['file*']
1442
Option('diff-options', type=str,
1443
help='Pass these options to the external diff program.'),
1444
Option('prefix', type=str,
1446
help='Set prefixes added to old and new filenames, as '
1447
'two values separated by a colon. (eg "old/:new/").'),
1449
help='Branch/tree to compare from.',
1453
help='Branch/tree to compare to.',
1459
help='Use this command to compare files.',
1463
aliases = ['di', 'dif']
1464
encoding_type = 'exact'
1467
def run(self, revision=None, file_list=None, diff_options=None,
1468
prefix=None, old=None, new=None, using=None):
1469
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1471
if (prefix is None) or (prefix == '0'):
1479
old_label, new_label = prefix.split(":")
1481
raise errors.BzrCommandError(
1482
'--prefix expects two values separated by a colon'
1483
' (eg "old/:new/")')
1485
if revision and len(revision) > 2:
1486
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1487
' one or two revision specifiers')
1489
old_tree, new_tree, specific_files, extra_trees = \
1490
_get_trees_to_diff(file_list, revision, old, new)
1491
return show_diff_trees(old_tree, new_tree, sys.stdout,
1492
specific_files=specific_files,
1493
external_diff_options=diff_options,
1494
old_label=old_label, new_label=new_label,
1495
extra_trees=extra_trees, using=using)
1498
class cmd_deleted(Command):
1499
"""List files deleted in the working tree.
1501
# TODO: Show files deleted since a previous revision, or
1502
# between two revisions.
1503
# TODO: Much more efficient way to do this: read in new
1504
# directories with readdir, rather than stating each one. Same
1505
# level of effort but possibly much less IO. (Or possibly not,
1506
# if the directories are very large...)
1507
_see_also = ['status', 'ls']
1508
takes_options = ['show-ids']
1511
def run(self, show_ids=False):
1512
tree = WorkingTree.open_containing(u'.')[0]
1515
old = tree.basis_tree()
1518
for path, ie in old.inventory.iter_entries():
1519
if not tree.has_id(ie.file_id):
1520
self.outf.write(path)
1522
self.outf.write(' ')
1523
self.outf.write(ie.file_id)
1524
self.outf.write('\n')
1531
class cmd_modified(Command):
1532
"""List files modified in working tree.
1536
_see_also = ['status', 'ls']
1539
help='Write an ascii NUL (\\0) separator '
1540
'between files rather than a newline.')
1544
def run(self, null=False):
1545
tree = WorkingTree.open_containing(u'.')[0]
1546
td = tree.changes_from(tree.basis_tree())
1547
for path, id, kind, text_modified, meta_modified in td.modified:
1549
self.outf.write(path + '\0')
1551
self.outf.write(osutils.quotefn(path) + '\n')
1554
class cmd_added(Command):
1555
"""List files added in working tree.
1559
_see_also = ['status', 'ls']
1562
help='Write an ascii NUL (\\0) separator '
1563
'between files rather than a newline.')
1567
def run(self, null=False):
1568
wt = WorkingTree.open_containing(u'.')[0]
1571
basis = wt.basis_tree()
1574
basis_inv = basis.inventory
1577
if file_id in basis_inv:
1579
if inv.is_root(file_id) and len(basis_inv) == 0:
1581
path = inv.id2path(file_id)
1582
if not os.access(osutils.abspath(path), os.F_OK):
1585
self.outf.write(path + '\0')
1587
self.outf.write(osutils.quotefn(path) + '\n')
1594
class cmd_root(Command):
1595
"""Show the tree root directory.
1597
The root is the nearest enclosing directory with a .bzr control
1600
takes_args = ['filename?']
1602
def run(self, filename=None):
1603
"""Print the branch root."""
1604
tree = WorkingTree.open_containing(filename)[0]
1605
self.outf.write(tree.basedir + '\n')
1608
def _parse_limit(limitstring):
1610
return int(limitstring)
1612
msg = "The limit argument must be an integer."
1613
raise errors.BzrCommandError(msg)
1616
class cmd_log(Command):
1617
"""Show log of a branch, file, or directory.
1619
By default show the log of the branch containing the working directory.
1621
To request a range of logs, you can use the command -r begin..end
1622
-r revision requests a specific revision, -r ..end or -r begin.. are
1626
Log the current branch::
1634
Log the last 10 revisions of a branch::
1636
bzr log -r -10.. http://server/branch
1639
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1641
takes_args = ['location?']
1644
help='Show from oldest to newest.'),
1647
help='Display timezone as local, original, or utc.'),
1648
custom_help('verbose',
1649
help='Show files changed in each revision.'),
1655
help='Show revisions whose message matches this '
1656
'regular expression.',
1660
help='Limit the output to the first N revisions.',
1664
encoding_type = 'replace'
1667
def run(self, location=None, timezone='original',
1675
from bzrlib.log import show_log
1676
direction = (forward and 'forward') or 'reverse'
1681
# find the file id to log:
1683
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1687
tree = b.basis_tree()
1688
file_id = tree.path2id(fp)
1690
raise errors.BzrCommandError(
1691
"Path does not have any revision history: %s" %
1695
# FIXME ? log the current subdir only RBC 20060203
1696
if revision is not None \
1697
and len(revision) > 0 and revision[0].get_branch():
1698
location = revision[0].get_branch()
1701
dir, relpath = bzrdir.BzrDir.open_containing(location)
1702
b = dir.open_branch()
1706
if revision is None:
1709
elif len(revision) == 1:
1710
rev1 = rev2 = revision[0].in_history(b)
1711
elif len(revision) == 2:
1712
if revision[1].get_branch() != revision[0].get_branch():
1713
# b is taken from revision[0].get_branch(), and
1714
# show_log will use its revision_history. Having
1715
# different branches will lead to weird behaviors.
1716
raise errors.BzrCommandError(
1717
"Log doesn't accept two revisions in different"
1719
rev1 = revision[0].in_history(b)
1720
rev2 = revision[1].in_history(b)
1722
raise errors.BzrCommandError(
1723
'bzr log --revision takes one or two values.')
1725
if log_format is None:
1726
log_format = log.log_formatter_registry.get_default(b)
1728
lf = log_format(show_ids=show_ids, to_file=self.outf,
1729
show_timezone=timezone)
1735
direction=direction,
1736
start_revision=rev1,
1744
def get_log_format(long=False, short=False, line=False, default='long'):
1745
log_format = default
1749
log_format = 'short'
1755
class cmd_touching_revisions(Command):
1756
"""Return revision-ids which affected a particular file.
1758
A more user-friendly interface is "bzr log FILE".
1762
takes_args = ["filename"]
1765
def run(self, filename):
1766
tree, relpath = WorkingTree.open_containing(filename)
1768
file_id = tree.path2id(relpath)
1769
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1770
self.outf.write("%6d %s\n" % (revno, what))
1773
class cmd_ls(Command):
1774
"""List files in a tree.
1777
_see_also = ['status', 'cat']
1778
takes_args = ['path?']
1779
# TODO: Take a revision or remote path and list that tree instead.
1783
Option('non-recursive',
1784
help='Don\'t recurse into subdirectories.'),
1786
help='Print paths relative to the root of the branch.'),
1787
Option('unknown', help='Print unknown files.'),
1788
Option('versioned', help='Print versioned files.',
1790
Option('ignored', help='Print ignored files.'),
1792
help='Write an ascii NUL (\\0) separator '
1793
'between files rather than a newline.'),
1795
help='List entries of a particular kind: file, directory, symlink.',
1800
def run(self, revision=None, verbose=False,
1801
non_recursive=False, from_root=False,
1802
unknown=False, versioned=False, ignored=False,
1803
null=False, kind=None, show_ids=False, path=None):
1805
if kind and kind not in ('file', 'directory', 'symlink'):
1806
raise errors.BzrCommandError('invalid kind specified')
1808
if verbose and null:
1809
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1810
all = not (unknown or versioned or ignored)
1812
selection = {'I':ignored, '?':unknown, 'V':versioned}
1819
raise errors.BzrCommandError('cannot specify both --from-root'
1823
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1829
if revision is not None:
1830
tree = branch.repository.revision_tree(
1831
revision[0].as_revision_id(branch))
1833
tree = branch.basis_tree()
1837
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1838
if fp.startswith(relpath):
1839
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1840
if non_recursive and '/' in fp:
1842
if not all and not selection[fc]:
1844
if kind is not None and fkind != kind:
1847
kindch = entry.kind_character()
1848
outstring = '%-8s %s%s' % (fc, fp, kindch)
1849
if show_ids and fid is not None:
1850
outstring = "%-50s %s" % (outstring, fid)
1851
self.outf.write(outstring + '\n')
1853
self.outf.write(fp + '\0')
1856
self.outf.write(fid)
1857
self.outf.write('\0')
1865
self.outf.write('%-50s %s\n' % (fp, my_id))
1867
self.outf.write(fp + '\n')
1872
class cmd_unknowns(Command):
1873
"""List unknown files.
1881
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1882
self.outf.write(osutils.quotefn(f) + '\n')
1885
class cmd_ignore(Command):
1886
"""Ignore specified files or patterns.
1888
See ``bzr help patterns`` for details on the syntax of patterns.
1890
To remove patterns from the ignore list, edit the .bzrignore file.
1891
After adding, editing or deleting that file either indirectly by
1892
using this command or directly by using an editor, be sure to commit
1895
Note: ignore patterns containing shell wildcards must be quoted from
1899
Ignore the top level Makefile::
1901
bzr ignore ./Makefile
1903
Ignore class files in all directories::
1905
bzr ignore "*.class"
1907
Ignore .o files under the lib directory::
1909
bzr ignore "lib/**/*.o"
1911
Ignore .o files under the lib directory::
1913
bzr ignore "RE:lib/.*\.o"
1915
Ignore everything but the "debian" toplevel directory::
1917
bzr ignore "RE:(?!debian/).*"
1920
_see_also = ['status', 'ignored', 'patterns']
1921
takes_args = ['name_pattern*']
1923
Option('old-default-rules',
1924
help='Write out the ignore rules bzr < 0.9 always used.')
1927
def run(self, name_pattern_list=None, old_default_rules=None):
1928
from bzrlib import ignores
1929
if old_default_rules is not None:
1930
# dump the rules and exit
1931
for pattern in ignores.OLD_DEFAULTS:
1934
if not name_pattern_list:
1935
raise errors.BzrCommandError("ignore requires at least one "
1936
"NAME_PATTERN or --old-default-rules")
1937
name_pattern_list = [globbing.normalize_pattern(p)
1938
for p in name_pattern_list]
1939
for name_pattern in name_pattern_list:
1940
if (name_pattern[0] == '/' or
1941
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1942
raise errors.BzrCommandError(
1943
"NAME_PATTERN should not be an absolute path")
1944
tree, relpath = WorkingTree.open_containing(u'.')
1945
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
1946
ignored = globbing.Globster(name_pattern_list)
1949
for entry in tree.list_files():
1953
if ignored.match(filename):
1954
matches.append(filename.encode('utf-8'))
1956
if len(matches) > 0:
1957
print "Warning: the following files are version controlled and" \
1958
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1961
class cmd_ignored(Command):
1962
"""List ignored files and the patterns that matched them.
1964
List all the ignored files and the ignore pattern that caused the file to
1967
Alternatively, to list just the files::
1972
encoding_type = 'replace'
1973
_see_also = ['ignore', 'ls']
1977
tree = WorkingTree.open_containing(u'.')[0]
1980
for path, file_class, kind, file_id, entry in tree.list_files():
1981
if file_class != 'I':
1983
## XXX: Slightly inefficient since this was already calculated
1984
pat = tree.is_ignored(path)
1985
self.outf.write('%-50s %s\n' % (path, pat))
1990
class cmd_lookup_revision(Command):
1991
"""Lookup the revision-id from a revision-number
1994
bzr lookup-revision 33
1997
takes_args = ['revno']
2000
def run(self, revno):
2004
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2006
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2009
class cmd_export(Command):
2010
"""Export current or past revision to a destination directory or archive.
2012
If no revision is specified this exports the last committed revision.
2014
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2015
given, try to find the format with the extension. If no extension
2016
is found exports to a directory (equivalent to --format=dir).
2018
If root is supplied, it will be used as the root directory inside
2019
container formats (tar, zip, etc). If it is not supplied it will default
2020
to the exported filename. The root option has no effect for 'dir' format.
2022
If branch is omitted then the branch containing the current working
2023
directory will be used.
2025
Note: Export of tree with non-ASCII filenames to zip is not supported.
2027
================= =========================
2028
Supported formats Autodetected by extension
2029
================= =========================
2032
tbz2 .tar.bz2, .tbz2
2035
================= =========================
2037
takes_args = ['dest', 'branch_or_subdir?']
2040
help="Type of file to export to.",
2045
help="Name of the root directory inside the exported file."),
2047
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2049
from bzrlib.export import export
2051
if branch_or_subdir is None:
2052
tree = WorkingTree.open_containing(u'.')[0]
2056
b, subdir = Branch.open_containing(branch_or_subdir)
2058
if revision is None:
2059
# should be tree.last_revision FIXME
2060
rev_id = b.last_revision()
2062
if len(revision) != 1:
2063
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2064
rev_id = revision[0].as_revision_id(b)
2065
t = b.repository.revision_tree(rev_id)
2067
export(t, dest, format, root, subdir)
2068
except errors.NoSuchExportFormat, e:
2069
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2072
class cmd_cat(Command):
2073
"""Write the contents of a file as of a given revision to standard output.
2075
If no revision is nominated, the last revision is used.
2077
Note: Take care to redirect standard output when using this command on a
2083
Option('name-from-revision', help='The path name in the old tree.'),
2086
takes_args = ['filename']
2087
encoding_type = 'exact'
2090
def run(self, filename, revision=None, name_from_revision=False):
2091
if revision is not None and len(revision) != 1:
2092
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2093
" one revision specifier")
2094
tree, branch, relpath = \
2095
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2098
return self._run(tree, branch, relpath, filename, revision,
2103
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2105
tree = b.basis_tree()
2106
if revision is None:
2107
revision_id = b.last_revision()
2109
revision_id = revision[0].as_revision_id(b)
2111
cur_file_id = tree.path2id(relpath)
2112
rev_tree = b.repository.revision_tree(revision_id)
2113
old_file_id = rev_tree.path2id(relpath)
2115
if name_from_revision:
2116
if old_file_id is None:
2117
raise errors.BzrCommandError("%r is not present in revision %s"
2118
% (filename, revision_id))
2120
content = rev_tree.get_file_text(old_file_id)
2121
elif cur_file_id is not None:
2122
content = rev_tree.get_file_text(cur_file_id)
2123
elif old_file_id is not None:
2124
content = rev_tree.get_file_text(old_file_id)
2126
raise errors.BzrCommandError("%r is not present in revision %s" %
2127
(filename, revision_id))
2128
self.outf.write(content)
2131
class cmd_local_time_offset(Command):
2132
"""Show the offset in seconds from GMT to local time."""
2136
print osutils.local_time_offset()
2140
class cmd_commit(Command):
2141
"""Commit changes into a new revision.
2143
If no arguments are given, the entire tree is committed.
2145
If selected files are specified, only changes to those files are
2146
committed. If a directory is specified then the directory and everything
2147
within it is committed.
2149
When excludes are given, they take precedence over selected files.
2150
For example, too commit only changes within foo, but not changes within
2153
bzr commit foo -x foo/bar
2155
If author of the change is not the same person as the committer, you can
2156
specify the author's name using the --author option. The name should be
2157
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2159
A selected-file commit may fail in some cases where the committed
2160
tree would be invalid. Consider::
2165
bzr commit foo -m "committing foo"
2166
bzr mv foo/bar foo/baz
2169
bzr commit foo/bar -m "committing bar but not baz"
2171
In the example above, the last commit will fail by design. This gives
2172
the user the opportunity to decide whether they want to commit the
2173
rename at the same time, separately first, or not at all. (As a general
2174
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2176
Note: A selected-file commit after a merge is not yet supported.
2178
# TODO: Run hooks on tree to-be-committed, and after commit.
2180
# TODO: Strict commit that fails if there are deleted files.
2181
# (what does "deleted files" mean ??)
2183
# TODO: Give better message for -s, --summary, used by tla people
2185
# XXX: verbose currently does nothing
2187
_see_also = ['bugs', 'uncommit']
2188
takes_args = ['selected*']
2190
ListOption('exclude', type=str, short_name='x',
2191
help="Do not consider changes made to a given path."),
2192
Option('message', type=unicode,
2194
help="Description of the new revision."),
2197
help='Commit even if nothing has changed.'),
2198
Option('file', type=str,
2201
help='Take commit message from this file.'),
2203
help="Refuse to commit if there are unknown "
2204
"files in the working tree."),
2205
ListOption('fixes', type=str,
2206
help="Mark a bug as being fixed by this revision."),
2207
Option('author', type=unicode,
2208
help="Set the author's name, if it's different "
2209
"from the committer."),
2211
help="Perform a local commit in a bound "
2212
"branch. Local commits are not pushed to "
2213
"the master branch until a normal commit "
2217
help='When no message is supplied, show the diff along'
2218
' with the status summary in the message editor.'),
2220
aliases = ['ci', 'checkin']
2222
def _get_bug_fix_properties(self, fixes, branch):
2224
# Configure the properties for bug fixing attributes.
2225
for fixed_bug in fixes:
2226
tokens = fixed_bug.split(':')
2227
if len(tokens) != 2:
2228
raise errors.BzrCommandError(
2229
"Invalid bug %s. Must be in the form of 'tag:id'. "
2230
"Commit refused." % fixed_bug)
2231
tag, bug_id = tokens
2233
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2234
except errors.UnknownBugTrackerAbbreviation:
2235
raise errors.BzrCommandError(
2236
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2237
except errors.MalformedBugIdentifier:
2238
raise errors.BzrCommandError(
2239
"Invalid bug identifier for %s. Commit refused."
2241
properties.append('%s fixed' % bug_url)
2242
return '\n'.join(properties)
2244
def run(self, message=None, file=None, verbose=False, selected_list=None,
2245
unchanged=False, strict=False, local=False, fixes=None,
2246
author=None, show_diff=False, exclude=None):
2247
from bzrlib.errors import (
2252
from bzrlib.msgeditor import (
2253
edit_commit_message_encoded,
2254
make_commit_message_template_encoded
2257
# TODO: Need a blackbox test for invoking the external editor; may be
2258
# slightly problematic to run this cross-platform.
2260
# TODO: do more checks that the commit will succeed before
2261
# spending the user's valuable time typing a commit message.
2265
tree, selected_list = tree_files(selected_list)
2266
if selected_list == ['']:
2267
# workaround - commit of root of tree should be exactly the same
2268
# as just default commit in that tree, and succeed even though
2269
# selected-file merge commit is not done yet
2274
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2276
properties['bugs'] = bug_property
2278
if local and not tree.branch.get_bound_location():
2279
raise errors.LocalRequiresBoundBranch()
2281
def get_message(commit_obj):
2282
"""Callback to get commit message"""
2283
my_message = message
2284
if my_message is None and not file:
2285
t = make_commit_message_template_encoded(tree,
2286
selected_list, diff=show_diff,
2287
output_encoding=bzrlib.user_encoding)
2288
my_message = edit_commit_message_encoded(t)
2289
if my_message is None:
2290
raise errors.BzrCommandError("please specify a commit"
2291
" message with either --message or --file")
2292
elif my_message and file:
2293
raise errors.BzrCommandError(
2294
"please specify either --message or --file")
2296
my_message = codecs.open(file, 'rt',
2297
bzrlib.user_encoding).read()
2298
if my_message == "":
2299
raise errors.BzrCommandError("empty commit message specified")
2303
tree.commit(message_callback=get_message,
2304
specific_files=selected_list,
2305
allow_pointless=unchanged, strict=strict, local=local,
2306
reporter=None, verbose=verbose, revprops=properties,
2308
exclude=safe_relpath_files(tree, exclude))
2309
except PointlessCommit:
2310
# FIXME: This should really happen before the file is read in;
2311
# perhaps prepare the commit; get the message; then actually commit
2312
raise errors.BzrCommandError("no changes to commit."
2313
" use --unchanged to commit anyhow")
2314
except ConflictsInTree:
2315
raise errors.BzrCommandError('Conflicts detected in working '
2316
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2318
except StrictCommitFailed:
2319
raise errors.BzrCommandError("Commit refused because there are"
2320
" unknown files in the working tree.")
2321
except errors.BoundBranchOutOfDate, e:
2322
raise errors.BzrCommandError(str(e) + "\n"
2323
'To commit to master branch, run update and then commit.\n'
2324
'You can also pass --local to commit to continue working '
2328
class cmd_check(Command):
2329
"""Validate working tree structure, branch consistency and repository history.
2331
This command checks various invariants about branch and repository storage
2332
to detect data corruption or bzr bugs.
2334
The working tree and branch checks will only give output if a problem is
2335
detected. The output fields of the repository check are:
2337
revisions: This is just the number of revisions checked. It doesn't
2339
versionedfiles: This is just the number of versionedfiles checked. It
2340
doesn't indicate a problem.
2341
unreferenced ancestors: Texts that are ancestors of other texts, but
2342
are not properly referenced by the revision ancestry. This is a
2343
subtle problem that Bazaar can work around.
2344
unique file texts: This is the total number of unique file contents
2345
seen in the checked revisions. It does not indicate a problem.
2346
repeated file texts: This is the total number of repeated texts seen
2347
in the checked revisions. Texts can be repeated when their file
2348
entries are modified, but the file contents are not. It does not
2351
If no restrictions are specified, all Bazaar data that is found at the given
2352
location will be checked.
2356
Check the tree and branch at 'foo'::
2358
bzr check --tree --branch foo
2360
Check only the repository at 'bar'::
2362
bzr check --repo bar
2364
Check everything at 'baz'::
2369
_see_also = ['reconcile']
2370
takes_args = ['path?']
2371
takes_options = ['verbose',
2372
Option('branch', help="Check the branch related to the"
2373
" current directory."),
2374
Option('repo', help="Check the repository related to the"
2375
" current directory."),
2376
Option('tree', help="Check the working tree related to"
2377
" the current directory.")]
2379
def run(self, path=None, verbose=False, branch=False, repo=False,
2381
from bzrlib.check import check_dwim
2384
if not branch and not repo and not tree:
2385
branch = repo = tree = True
2386
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2389
class cmd_upgrade(Command):
2390
"""Upgrade branch storage to current format.
2392
The check command or bzr developers may sometimes advise you to run
2393
this command. When the default format has changed you may also be warned
2394
during other operations to upgrade.
2397
_see_also = ['check']
2398
takes_args = ['url?']
2400
RegistryOption('format',
2401
help='Upgrade to a specific format. See "bzr help'
2402
' formats" for details.',
2403
registry=bzrdir.format_registry,
2404
converter=bzrdir.format_registry.make_bzrdir,
2405
value_switches=True, title='Branch format'),
2408
def run(self, url='.', format=None):
2409
from bzrlib.upgrade import upgrade
2411
format = bzrdir.format_registry.make_bzrdir('default')
2412
upgrade(url, format)
2415
class cmd_whoami(Command):
2416
"""Show or set bzr user id.
2419
Show the email of the current user::
2423
Set the current user::
2425
bzr whoami "Frank Chu <fchu@example.com>"
2427
takes_options = [ Option('email',
2428
help='Display email address only.'),
2430
help='Set identity for the current branch instead of '
2433
takes_args = ['name?']
2434
encoding_type = 'replace'
2437
def run(self, email=False, branch=False, name=None):
2439
# use branch if we're inside one; otherwise global config
2441
c = Branch.open_containing('.')[0].get_config()
2442
except errors.NotBranchError:
2443
c = config.GlobalConfig()
2445
self.outf.write(c.user_email() + '\n')
2447
self.outf.write(c.username() + '\n')
2450
# display a warning if an email address isn't included in the given name.
2452
config.extract_email_address(name)
2453
except errors.NoEmailInUsername, e:
2454
warning('"%s" does not seem to contain an email address. '
2455
'This is allowed, but not recommended.', name)
2457
# use global config unless --branch given
2459
c = Branch.open_containing('.')[0].get_config()
2461
c = config.GlobalConfig()
2462
c.set_user_option('email', name)
2465
class cmd_nick(Command):
2466
"""Print or set the branch nickname.
2468
If unset, the tree root directory name is used as the nickname
2469
To print the current nickname, execute with no argument.
2472
_see_also = ['info']
2473
takes_args = ['nickname?']
2474
def run(self, nickname=None):
2475
branch = Branch.open_containing(u'.')[0]
2476
if nickname is None:
2477
self.printme(branch)
2479
branch.nick = nickname
2482
def printme(self, branch):
2486
class cmd_alias(Command):
2487
"""Set/unset and display aliases.
2490
Show the current aliases::
2494
Show the alias specified for 'll'::
2498
Set an alias for 'll'::
2500
bzr alias ll="log --line -r-10..-1"
2502
To remove an alias for 'll'::
2504
bzr alias --remove ll
2507
takes_args = ['name?']
2509
Option('remove', help='Remove the alias.'),
2512
def run(self, name=None, remove=False):
2514
self.remove_alias(name)
2516
self.print_aliases()
2518
equal_pos = name.find('=')
2520
self.print_alias(name)
2522
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2524
def remove_alias(self, alias_name):
2525
if alias_name is None:
2526
raise errors.BzrCommandError(
2527
'bzr alias --remove expects an alias to remove.')
2528
# If alias is not found, print something like:
2529
# unalias: foo: not found
2530
c = config.GlobalConfig()
2531
c.unset_alias(alias_name)
2534
def print_aliases(self):
2535
"""Print out the defined aliases in a similar format to bash."""
2536
aliases = config.GlobalConfig().get_aliases()
2537
for key, value in sorted(aliases.iteritems()):
2538
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2541
def print_alias(self, alias_name):
2542
from bzrlib.commands import get_alias
2543
alias = get_alias(alias_name)
2545
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2548
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2550
def set_alias(self, alias_name, alias_command):
2551
"""Save the alias in the global config."""
2552
c = config.GlobalConfig()
2553
c.set_alias(alias_name, alias_command)
2556
class cmd_selftest(Command):
2557
"""Run internal test suite.
2559
If arguments are given, they are regular expressions that say which tests
2560
should run. Tests matching any expression are run, and other tests are
2563
Alternatively if --first is given, matching tests are run first and then
2564
all other tests are run. This is useful if you have been working in a
2565
particular area, but want to make sure nothing else was broken.
2567
If --exclude is given, tests that match that regular expression are
2568
excluded, regardless of whether they match --first or not.
2570
To help catch accidential dependencies between tests, the --randomize
2571
option is useful. In most cases, the argument used is the word 'now'.
2572
Note that the seed used for the random number generator is displayed
2573
when this option is used. The seed can be explicitly passed as the
2574
argument to this option if required. This enables reproduction of the
2575
actual ordering used if and when an order sensitive problem is encountered.
2577
If --list-only is given, the tests that would be run are listed. This is
2578
useful when combined with --first, --exclude and/or --randomize to
2579
understand their impact. The test harness reports "Listed nn tests in ..."
2580
instead of "Ran nn tests in ..." when list mode is enabled.
2582
If the global option '--no-plugins' is given, plugins are not loaded
2583
before running the selftests. This has two effects: features provided or
2584
modified by plugins will not be tested, and tests provided by plugins will
2587
Tests that need working space on disk use a common temporary directory,
2588
typically inside $TMPDIR or /tmp.
2591
Run only tests relating to 'ignore'::
2595
Disable plugins and list tests as they're run::
2597
bzr --no-plugins selftest -v
2599
# NB: this is used from the class without creating an instance, which is
2600
# why it does not have a self parameter.
2601
def get_transport_type(typestring):
2602
"""Parse and return a transport specifier."""
2603
if typestring == "sftp":
2604
from bzrlib.transport.sftp import SFTPAbsoluteServer
2605
return SFTPAbsoluteServer
2606
if typestring == "memory":
2607
from bzrlib.transport.memory import MemoryServer
2609
if typestring == "fakenfs":
2610
from bzrlib.transport.fakenfs import FakeNFSServer
2611
return FakeNFSServer
2612
msg = "No known transport type %s. Supported types are: sftp\n" %\
2614
raise errors.BzrCommandError(msg)
2617
takes_args = ['testspecs*']
2618
takes_options = ['verbose',
2620
help='Stop when one test fails.',
2624
help='Use a different transport by default '
2625
'throughout the test suite.',
2626
type=get_transport_type),
2628
help='Run the benchmarks rather than selftests.'),
2629
Option('lsprof-timed',
2630
help='Generate lsprof output for benchmarked'
2631
' sections of code.'),
2632
Option('cache-dir', type=str,
2633
help='Cache intermediate benchmark output in this '
2636
help='Run all tests, but run specified tests first.',
2640
help='List the tests instead of running them.'),
2641
Option('randomize', type=str, argname="SEED",
2642
help='Randomize the order of tests using the given'
2643
' seed or "now" for the current time.'),
2644
Option('exclude', type=str, argname="PATTERN",
2646
help='Exclude tests that match this regular'
2648
Option('strict', help='Fail on missing dependencies or '
2650
Option('load-list', type=str, argname='TESTLISTFILE',
2651
help='Load a test id list from a text file.'),
2652
ListOption('debugflag', type=str, short_name='E',
2653
help='Turn on a selftest debug flag.'),
2654
Option('starting-with', type=str, argname='TESTID',
2656
help='Load only the tests starting with TESTID.'),
2658
encoding_type = 'replace'
2660
def run(self, testspecs_list=None, verbose=False, one=False,
2661
transport=None, benchmark=None,
2662
lsprof_timed=None, cache_dir=None,
2663
first=False, list_only=False,
2664
randomize=None, exclude=None, strict=False,
2665
load_list=None, debugflag=None, starting_with=None):
2667
from bzrlib.tests import selftest
2668
import bzrlib.benchmarks as benchmarks
2669
from bzrlib.benchmarks import tree_creator
2671
# Make deprecation warnings visible, unless -Werror is set
2672
symbol_versioning.activate_deprecation_warnings(override=False)
2674
if cache_dir is not None:
2675
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2677
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2678
print ' %s (%s python%s)' % (
2680
bzrlib.version_string,
2681
bzrlib._format_version_tuple(sys.version_info),
2684
if testspecs_list is not None:
2685
pattern = '|'.join(testspecs_list)
2689
test_suite_factory = benchmarks.test_suite
2690
# Unless user explicitly asks for quiet, be verbose in benchmarks
2691
verbose = not is_quiet()
2692
# TODO: should possibly lock the history file...
2693
benchfile = open(".perf_history", "at", buffering=1)
2695
test_suite_factory = None
2698
result = selftest(verbose=verbose,
2700
stop_on_failure=one,
2701
transport=transport,
2702
test_suite_factory=test_suite_factory,
2703
lsprof_timed=lsprof_timed,
2704
bench_history=benchfile,
2705
matching_tests_first=first,
2706
list_only=list_only,
2707
random_seed=randomize,
2708
exclude_pattern=exclude,
2710
load_list=load_list,
2711
debug_flags=debugflag,
2712
starting_with=starting_with,
2715
if benchfile is not None:
2718
note('tests passed')
2720
note('tests failed')
2721
return int(not result)
2724
class cmd_version(Command):
2725
"""Show version of bzr."""
2727
encoding_type = 'replace'
2729
Option("short", help="Print just the version number."),
2733
def run(self, short=False):
2734
from bzrlib.version import show_version
2736
self.outf.write(bzrlib.version_string + '\n')
2738
show_version(to_file=self.outf)
2741
class cmd_rocks(Command):
2742
"""Statement of optimism."""
2748
print "It sure does!"
2751
class cmd_find_merge_base(Command):
2752
"""Find and print a base revision for merging two branches."""
2753
# TODO: Options to specify revisions on either side, as if
2754
# merging only part of the history.
2755
takes_args = ['branch', 'other']
2759
def run(self, branch, other):
2760
from bzrlib.revision import ensure_null
2762
branch1 = Branch.open_containing(branch)[0]
2763
branch2 = Branch.open_containing(other)[0]
2768
last1 = ensure_null(branch1.last_revision())
2769
last2 = ensure_null(branch2.last_revision())
2771
graph = branch1.repository.get_graph(branch2.repository)
2772
base_rev_id = graph.find_unique_lca(last1, last2)
2774
print 'merge base is revision %s' % base_rev_id
2781
class cmd_merge(Command):
2782
"""Perform a three-way merge.
2784
The source of the merge can be specified either in the form of a branch,
2785
or in the form of a path to a file containing a merge directive generated
2786
with bzr send. If neither is specified, the default is the upstream branch
2787
or the branch most recently merged using --remember.
2789
When merging a branch, by default the tip will be merged. To pick a different
2790
revision, pass --revision. If you specify two values, the first will be used as
2791
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2792
available revisions, like this is commonly referred to as "cherrypicking".
2794
Revision numbers are always relative to the branch being merged.
2796
By default, bzr will try to merge in all new work from the other
2797
branch, automatically determining an appropriate base. If this
2798
fails, you may need to give an explicit base.
2800
Merge will do its best to combine the changes in two branches, but there
2801
are some kinds of problems only a human can fix. When it encounters those,
2802
it will mark a conflict. A conflict means that you need to fix something,
2803
before you should commit.
2805
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2807
If there is no default branch set, the first merge will set it. After
2808
that, you can omit the branch to use the default. To change the
2809
default, use --remember. The value will only be saved if the remote
2810
location can be accessed.
2812
The results of the merge are placed into the destination working
2813
directory, where they can be reviewed (with bzr diff), tested, and then
2814
committed to record the result of the merge.
2816
merge refuses to run if there are any uncommitted changes, unless
2820
To merge the latest revision from bzr.dev::
2822
bzr merge ../bzr.dev
2824
To merge changes up to and including revision 82 from bzr.dev::
2826
bzr merge -r 82 ../bzr.dev
2828
To merge the changes introduced by 82, without previous changes::
2830
bzr merge -r 81..82 ../bzr.dev
2832
To apply a merge directive contained in in /tmp/merge:
2834
bzr merge /tmp/merge
2837
encoding_type = 'exact'
2838
_see_also = ['update', 'remerge', 'status-flags']
2839
takes_args = ['location?']
2844
help='Merge even if the destination tree has uncommitted changes.'),
2848
Option('show-base', help="Show base revision text in "
2850
Option('uncommitted', help='Apply uncommitted changes'
2851
' from a working copy, instead of branch changes.'),
2852
Option('pull', help='If the destination is already'
2853
' completely merged into the source, pull from the'
2854
' source rather than merging. When this happens,'
2855
' you do not need to commit the result.'),
2857
help='Branch to merge into, '
2858
'rather than the one containing the working directory.',
2862
Option('preview', help='Instead of merging, show a diff of the merge.')
2865
def run(self, location=None, revision=None, force=False,
2866
merge_type=None, show_base=False, reprocess=False, remember=False,
2867
uncommitted=False, pull=False,
2871
if merge_type is None:
2872
merge_type = _mod_merge.Merge3Merger
2874
if directory is None: directory = u'.'
2875
possible_transports = []
2877
allow_pending = True
2878
verified = 'inapplicable'
2879
tree = WorkingTree.open_containing(directory)[0]
2880
change_reporter = delta._ChangeReporter(
2881
unversioned_filter=tree.is_ignored)
2884
pb = ui.ui_factory.nested_progress_bar()
2885
cleanups.append(pb.finished)
2887
cleanups.append(tree.unlock)
2888
if location is not None:
2890
mergeable = bundle.read_mergeable_from_url(location,
2891
possible_transports=possible_transports)
2892
except errors.NotABundle:
2896
raise errors.BzrCommandError('Cannot use --uncommitted'
2897
' with bundles or merge directives.')
2899
if revision is not None:
2900
raise errors.BzrCommandError(
2901
'Cannot use -r with merge directives or bundles')
2902
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2905
if merger is None and uncommitted:
2906
if revision is not None and len(revision) > 0:
2907
raise errors.BzrCommandError('Cannot use --uncommitted and'
2908
' --revision at the same time.')
2909
location = self._select_branch_location(tree, location)[0]
2910
other_tree, other_path = WorkingTree.open_containing(location)
2911
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2913
allow_pending = False
2914
if other_path != '':
2915
merger.interesting_files = [other_path]
2918
merger, allow_pending = self._get_merger_from_branch(tree,
2919
location, revision, remember, possible_transports, pb)
2921
merger.merge_type = merge_type
2922
merger.reprocess = reprocess
2923
merger.show_base = show_base
2924
self.sanity_check_merger(merger)
2925
if (merger.base_rev_id == merger.other_rev_id and
2926
merger.other_rev_id is not None):
2927
note('Nothing to do.')
2930
if merger.interesting_files is not None:
2931
raise errors.BzrCommandError('Cannot pull individual files')
2932
if (merger.base_rev_id == tree.last_revision()):
2933
result = tree.pull(merger.other_branch, False,
2934
merger.other_rev_id)
2935
result.report(self.outf)
2937
merger.check_basis(not force)
2939
return self._do_preview(merger)
2941
return self._do_merge(merger, change_reporter, allow_pending,
2944
for cleanup in reversed(cleanups):
2947
def _do_preview(self, merger):
2948
from bzrlib.diff import show_diff_trees
2949
tree_merger = merger.make_merger()
2950
tt = tree_merger.make_preview_transform()
2952
result_tree = tt.get_preview_tree()
2953
show_diff_trees(merger.this_tree, result_tree, self.outf,
2954
old_label='', new_label='')
2958
def _do_merge(self, merger, change_reporter, allow_pending, verified):
2959
merger.change_reporter = change_reporter
2960
conflict_count = merger.do_merge()
2962
merger.set_pending()
2963
if verified == 'failed':
2964
warning('Preview patch does not match changes')
2965
if conflict_count != 0:
2970
def sanity_check_merger(self, merger):
2971
if (merger.show_base and
2972
not merger.merge_type is _mod_merge.Merge3Merger):
2973
raise errors.BzrCommandError("Show-base is not supported for this"
2974
" merge type. %s" % merger.merge_type)
2975
if merger.reprocess and not merger.merge_type.supports_reprocess:
2976
raise errors.BzrCommandError("Conflict reduction is not supported"
2977
" for merge type %s." %
2979
if merger.reprocess and merger.show_base:
2980
raise errors.BzrCommandError("Cannot do conflict reduction and"
2983
def _get_merger_from_branch(self, tree, location, revision, remember,
2984
possible_transports, pb):
2985
"""Produce a merger from a location, assuming it refers to a branch."""
2986
from bzrlib.tag import _merge_tags_if_possible
2987
# find the branch locations
2988
other_loc, user_location = self._select_branch_location(tree, location,
2990
if revision is not None and len(revision) == 2:
2991
base_loc, _unused = self._select_branch_location(tree,
2992
location, revision, 0)
2994
base_loc = other_loc
2996
other_branch, other_path = Branch.open_containing(other_loc,
2997
possible_transports)
2998
if base_loc == other_loc:
2999
base_branch = other_branch
3001
base_branch, base_path = Branch.open_containing(base_loc,
3002
possible_transports)
3003
# Find the revision ids
3004
if revision is None or len(revision) < 1 or revision[-1] is None:
3005
other_revision_id = _mod_revision.ensure_null(
3006
other_branch.last_revision())
3008
other_revision_id = revision[-1].as_revision_id(other_branch)
3009
if (revision is not None and len(revision) == 2
3010
and revision[0] is not None):
3011
base_revision_id = revision[0].as_revision_id(base_branch)
3013
base_revision_id = None
3014
# Remember where we merge from
3015
if ((remember or tree.branch.get_submit_branch() is None) and
3016
user_location is not None):
3017
tree.branch.set_submit_branch(other_branch.base)
3018
_merge_tags_if_possible(other_branch, tree.branch)
3019
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3020
other_revision_id, base_revision_id, other_branch, base_branch)
3021
if other_path != '':
3022
allow_pending = False
3023
merger.interesting_files = [other_path]
3025
allow_pending = True
3026
return merger, allow_pending
3028
def _select_branch_location(self, tree, user_location, revision=None,
3030
"""Select a branch location, according to possible inputs.
3032
If provided, branches from ``revision`` are preferred. (Both
3033
``revision`` and ``index`` must be supplied.)
3035
Otherwise, the ``location`` parameter is used. If it is None, then the
3036
``submit`` or ``parent`` location is used, and a note is printed.
3038
:param tree: The working tree to select a branch for merging into
3039
:param location: The location entered by the user
3040
:param revision: The revision parameter to the command
3041
:param index: The index to use for the revision parameter. Negative
3042
indices are permitted.
3043
:return: (selected_location, user_location). The default location
3044
will be the user-entered location.
3046
if (revision is not None and index is not None
3047
and revision[index] is not None):
3048
branch = revision[index].get_branch()
3049
if branch is not None:
3050
return branch, branch
3051
if user_location is None:
3052
location = self._get_remembered(tree, 'Merging from')
3054
location = user_location
3055
return location, user_location
3057
def _get_remembered(self, tree, verb_string):
3058
"""Use tree.branch's parent if none was supplied.
3060
Report if the remembered location was used.
3062
stored_location = tree.branch.get_submit_branch()
3063
if stored_location is None:
3064
stored_location = tree.branch.get_parent()
3065
mutter("%s", stored_location)
3066
if stored_location is None:
3067
raise errors.BzrCommandError("No location specified or remembered")
3068
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3069
note(u"%s remembered location %s", verb_string, display_url)
3070
return stored_location
3073
class cmd_remerge(Command):
3076
Use this if you want to try a different merge technique while resolving
3077
conflicts. Some merge techniques are better than others, and remerge
3078
lets you try different ones on different files.
3080
The options for remerge have the same meaning and defaults as the ones for
3081
merge. The difference is that remerge can (only) be run when there is a
3082
pending merge, and it lets you specify particular files.
3085
Re-do the merge of all conflicted files, and show the base text in
3086
conflict regions, in addition to the usual THIS and OTHER texts::
3088
bzr remerge --show-base
3090
Re-do the merge of "foobar", using the weave merge algorithm, with
3091
additional processing to reduce the size of conflict regions::
3093
bzr remerge --merge-type weave --reprocess foobar
3095
takes_args = ['file*']
3100
help="Show base revision text in conflicts."),
3103
def run(self, file_list=None, merge_type=None, show_base=False,
3105
if merge_type is None:
3106
merge_type = _mod_merge.Merge3Merger
3107
tree, file_list = tree_files(file_list)
3110
parents = tree.get_parent_ids()
3111
if len(parents) != 2:
3112
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3113
" merges. Not cherrypicking or"
3115
repository = tree.branch.repository
3116
interesting_ids = None
3118
conflicts = tree.conflicts()
3119
if file_list is not None:
3120
interesting_ids = set()
3121
for filename in file_list:
3122
file_id = tree.path2id(filename)
3124
raise errors.NotVersionedError(filename)
3125
interesting_ids.add(file_id)
3126
if tree.kind(file_id) != "directory":
3129
for name, ie in tree.inventory.iter_entries(file_id):
3130
interesting_ids.add(ie.file_id)
3131
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3133
# Remerge only supports resolving contents conflicts
3134
allowed_conflicts = ('text conflict', 'contents conflict')
3135
restore_files = [c.path for c in conflicts
3136
if c.typestring in allowed_conflicts]
3137
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3138
tree.set_conflicts(ConflictList(new_conflicts))
3139
if file_list is not None:
3140
restore_files = file_list
3141
for filename in restore_files:
3143
restore(tree.abspath(filename))
3144
except errors.NotConflicted:
3146
# Disable pending merges, because the file texts we are remerging
3147
# have not had those merges performed. If we use the wrong parents
3148
# list, we imply that the working tree text has seen and rejected
3149
# all the changes from the other tree, when in fact those changes
3150
# have not yet been seen.
3151
pb = ui.ui_factory.nested_progress_bar()
3152
tree.set_parent_ids(parents[:1])
3154
merger = _mod_merge.Merger.from_revision_ids(pb,
3156
merger.interesting_ids = interesting_ids
3157
merger.merge_type = merge_type
3158
merger.show_base = show_base
3159
merger.reprocess = reprocess
3160
conflicts = merger.do_merge()
3162
tree.set_parent_ids(parents)
3172
class cmd_revert(Command):
3173
"""Revert files to a previous revision.
3175
Giving a list of files will revert only those files. Otherwise, all files
3176
will be reverted. If the revision is not specified with '--revision', the
3177
last committed revision is used.
3179
To remove only some changes, without reverting to a prior version, use
3180
merge instead. For example, "merge . --revision -2..-3" will remove the
3181
changes introduced by -2, without affecting the changes introduced by -1.
3182
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3184
By default, any files that have been manually changed will be backed up
3185
first. (Files changed only by merge are not backed up.) Backup files have
3186
'.~#~' appended to their name, where # is a number.
3188
When you provide files, you can use their current pathname or the pathname
3189
from the target revision. So you can use revert to "undelete" a file by
3190
name. If you name a directory, all the contents of that directory will be
3193
Any files that have been newly added since that revision will be deleted,
3194
with a backup kept if appropriate. Directories containing unknown files
3195
will not be deleted.
3197
The working tree contains a list of pending merged revisions, which will
3198
be included as parents in the next commit. Normally, revert clears that
3199
list as well as reverting the files. If any files are specified, revert
3200
leaves the pending merge list alone and reverts only the files. Use "bzr
3201
revert ." in the tree root to revert all files but keep the merge record,
3202
and "bzr revert --forget-merges" to clear the pending merge list without
3203
reverting any files.
3206
_see_also = ['cat', 'export']
3209
Option('no-backup', "Do not save backups of reverted files."),
3210
Option('forget-merges',
3211
'Remove pending merge marker, without changing any files.'),
3213
takes_args = ['file*']
3215
def run(self, revision=None, no_backup=False, file_list=None,
3216
forget_merges=None):
3217
tree, file_list = tree_files(file_list)
3219
tree.set_parent_ids(tree.get_parent_ids()[:1])
3221
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3224
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3225
if revision is None:
3226
rev_id = tree.last_revision()
3227
elif len(revision) != 1:
3228
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3230
rev_id = revision[0].as_revision_id(tree.branch)
3231
pb = ui.ui_factory.nested_progress_bar()
3233
tree.revert(file_list,
3234
tree.branch.repository.revision_tree(rev_id),
3235
not no_backup, pb, report_changes=True)
3240
class cmd_assert_fail(Command):
3241
"""Test reporting of assertion failures"""
3242
# intended just for use in testing
3247
raise AssertionError("always fails")
3250
class cmd_help(Command):
3251
"""Show help on a command or other topic.
3254
_see_also = ['topics']
3256
Option('long', 'Show help on all commands.'),
3258
takes_args = ['topic?']
3259
aliases = ['?', '--help', '-?', '-h']
3262
def run(self, topic=None, long=False):
3264
if topic is None and long:
3266
bzrlib.help.help(topic)
3269
class cmd_shell_complete(Command):
3270
"""Show appropriate completions for context.
3272
For a list of all available commands, say 'bzr shell-complete'.
3274
takes_args = ['context?']
3279
def run(self, context=None):
3280
import shellcomplete
3281
shellcomplete.shellcomplete(context)
3284
class cmd_missing(Command):
3285
"""Show unmerged/unpulled revisions between two branches.
3287
OTHER_BRANCH may be local or remote.
3290
_see_also = ['merge', 'pull']
3291
takes_args = ['other_branch?']
3293
Option('reverse', 'Reverse the order of revisions.'),
3295
'Display changes in the local branch only.'),
3296
Option('this' , 'Same as --mine-only.'),
3297
Option('theirs-only',
3298
'Display changes in the remote branch only.'),
3299
Option('other', 'Same as --theirs-only.'),
3304
encoding_type = 'replace'
3307
def run(self, other_branch=None, reverse=False, mine_only=False,
3308
theirs_only=False, log_format=None, long=False, short=False, line=False,
3309
show_ids=False, verbose=False, this=False, other=False):
3310
from bzrlib.missing import find_unmerged, iter_log_revisions
3316
# TODO: We should probably check that we don't have mine-only and
3317
# theirs-only set, but it gets complicated because we also have
3318
# this and other which could be used.
3325
local_branch = Branch.open_containing(u".")[0]
3326
parent = local_branch.get_parent()
3327
if other_branch is None:
3328
other_branch = parent
3329
if other_branch is None:
3330
raise errors.BzrCommandError("No peer location known"
3332
display_url = urlutils.unescape_for_display(parent,
3334
self.outf.write("Using last location: " + display_url + "\n")
3336
remote_branch = Branch.open(other_branch)
3337
if remote_branch.base == local_branch.base:
3338
remote_branch = local_branch
3339
local_branch.lock_read()
3341
remote_branch.lock_read()
3343
local_extra, remote_extra = find_unmerged(
3344
local_branch, remote_branch, restrict)
3346
if log_format is None:
3347
registry = log.log_formatter_registry
3348
log_format = registry.get_default(local_branch)
3349
lf = log_format(to_file=self.outf,
3351
show_timezone='original')
3352
if reverse is False:
3353
if local_extra is not None:
3354
local_extra.reverse()
3355
if remote_extra is not None:
3356
remote_extra.reverse()
3359
if local_extra and not theirs_only:
3360
self.outf.write("You have %d extra revision(s):\n" %
3362
for revision in iter_log_revisions(local_extra,
3363
local_branch.repository,
3365
lf.log_revision(revision)
3366
printed_local = True
3369
printed_local = False
3371
if remote_extra and not mine_only:
3372
if printed_local is True:
3373
self.outf.write("\n\n\n")
3374
self.outf.write("You are missing %d revision(s):\n" %
3376
for revision in iter_log_revisions(remote_extra,
3377
remote_branch.repository,
3379
lf.log_revision(revision)
3382
if mine_only and not local_extra:
3383
# We checked local, and found nothing extra
3384
self.outf.write('This branch is up to date.\n')
3385
elif theirs_only and not remote_extra:
3386
# We checked remote, and found nothing extra
3387
self.outf.write('Other branch is up to date.\n')
3388
elif not (mine_only or theirs_only or local_extra or
3390
# We checked both branches, and neither one had extra
3392
self.outf.write("Branches are up to date.\n")
3394
remote_branch.unlock()
3396
local_branch.unlock()
3397
if not status_code and parent is None and other_branch is not None:
3398
local_branch.lock_write()
3400
# handle race conditions - a parent might be set while we run.
3401
if local_branch.get_parent() is None:
3402
local_branch.set_parent(remote_branch.base)
3404
local_branch.unlock()
3408
class cmd_pack(Command):
3409
"""Compress the data within a repository."""
3411
_see_also = ['repositories']
3412
takes_args = ['branch_or_repo?']
3414
def run(self, branch_or_repo='.'):
3415
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3417
branch = dir.open_branch()
3418
repository = branch.repository
3419
except errors.NotBranchError:
3420
repository = dir.open_repository()
3424
class cmd_plugins(Command):
3425
"""List the installed plugins.
3427
This command displays the list of installed plugins including
3428
version of plugin and a short description of each.
3430
--verbose shows the path where each plugin is located.
3432
A plugin is an external component for Bazaar that extends the
3433
revision control system, by adding or replacing code in Bazaar.
3434
Plugins can do a variety of things, including overriding commands,
3435
adding new commands, providing additional network transports and
3436
customizing log output.
3438
See the Bazaar web site, http://bazaar-vcs.org, for further
3439
information on plugins including where to find them and how to
3440
install them. Instructions are also provided there on how to
3441
write new plugins using the Python programming language.
3443
takes_options = ['verbose']
3446
def run(self, verbose=False):
3447
import bzrlib.plugin
3448
from inspect import getdoc
3450
for name, plugin in bzrlib.plugin.plugins().items():
3451
version = plugin.__version__
3452
if version == 'unknown':
3454
name_ver = '%s %s' % (name, version)
3455
d = getdoc(plugin.module)
3457
doc = d.split('\n')[0]
3459
doc = '(no description)'
3460
result.append((name_ver, doc, plugin.path()))
3461
for name_ver, doc, path in sorted(result):
3469
class cmd_testament(Command):
3470
"""Show testament (signing-form) of a revision."""
3473
Option('long', help='Produce long-format testament.'),
3475
help='Produce a strict-format testament.')]
3476
takes_args = ['branch?']
3478
def run(self, branch=u'.', revision=None, long=False, strict=False):
3479
from bzrlib.testament import Testament, StrictTestament
3481
testament_class = StrictTestament
3483
testament_class = Testament
3485
b = Branch.open_containing(branch)[0]
3487
b = Branch.open(branch)
3490
if revision is None:
3491
rev_id = b.last_revision()
3493
rev_id = revision[0].as_revision_id(b)
3494
t = testament_class.from_revision(b.repository, rev_id)
3496
sys.stdout.writelines(t.as_text_lines())
3498
sys.stdout.write(t.as_short_text())
3503
class cmd_annotate(Command):
3504
"""Show the origin of each line in a file.
3506
This prints out the given file with an annotation on the left side
3507
indicating which revision, author and date introduced the change.
3509
If the origin is the same for a run of consecutive lines, it is
3510
shown only at the top, unless the --all option is given.
3512
# TODO: annotate directories; showing when each file was last changed
3513
# TODO: if the working copy is modified, show annotations on that
3514
# with new uncommitted lines marked
3515
aliases = ['ann', 'blame', 'praise']
3516
takes_args = ['filename']
3517
takes_options = [Option('all', help='Show annotations on all lines.'),
3518
Option('long', help='Show commit date in annotations.'),
3522
encoding_type = 'exact'
3525
def run(self, filename, all=False, long=False, revision=None,
3527
from bzrlib.annotate import annotate_file
3528
wt, branch, relpath = \
3529
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3535
if revision is None:
3536
revision_id = branch.last_revision()
3537
elif len(revision) != 1:
3538
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3540
revision_id = revision[0].as_revision_id(branch)
3541
tree = branch.repository.revision_tree(revision_id)
3543
file_id = wt.path2id(relpath)
3545
file_id = tree.path2id(relpath)
3547
raise errors.NotVersionedError(filename)
3548
file_version = tree.inventory[file_id].revision
3549
annotate_file(branch, file_version, file_id, long, all, self.outf,
3558
class cmd_re_sign(Command):
3559
"""Create a digital signature for an existing revision."""
3560
# TODO be able to replace existing ones.
3562
hidden = True # is this right ?
3563
takes_args = ['revision_id*']
3564
takes_options = ['revision']
3566
def run(self, revision_id_list=None, revision=None):
3567
if revision_id_list is not None and revision is not None:
3568
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3569
if revision_id_list is None and revision is None:
3570
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3571
b = WorkingTree.open_containing(u'.')[0].branch
3574
return self._run(b, revision_id_list, revision)
3578
def _run(self, b, revision_id_list, revision):
3579
import bzrlib.gpg as gpg
3580
gpg_strategy = gpg.GPGStrategy(b.get_config())
3581
if revision_id_list is not None:
3582
b.repository.start_write_group()
3584
for revision_id in revision_id_list:
3585
b.repository.sign_revision(revision_id, gpg_strategy)
3587
b.repository.abort_write_group()
3590
b.repository.commit_write_group()
3591
elif revision is not None:
3592
if len(revision) == 1:
3593
revno, rev_id = revision[0].in_history(b)
3594
b.repository.start_write_group()
3596
b.repository.sign_revision(rev_id, gpg_strategy)
3598
b.repository.abort_write_group()
3601
b.repository.commit_write_group()
3602
elif len(revision) == 2:
3603
# are they both on rh- if so we can walk between them
3604
# might be nice to have a range helper for arbitrary
3605
# revision paths. hmm.
3606
from_revno, from_revid = revision[0].in_history(b)
3607
to_revno, to_revid = revision[1].in_history(b)
3608
if to_revid is None:
3609
to_revno = b.revno()
3610
if from_revno is None or to_revno is None:
3611
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3612
b.repository.start_write_group()
3614
for revno in range(from_revno, to_revno + 1):
3615
b.repository.sign_revision(b.get_rev_id(revno),
3618
b.repository.abort_write_group()
3621
b.repository.commit_write_group()
3623
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3626
class cmd_bind(Command):
3627
"""Convert the current branch into a checkout of the supplied branch.
3629
Once converted into a checkout, commits must succeed on the master branch
3630
before they will be applied to the local branch.
3633
_see_also = ['checkouts', 'unbind']
3634
takes_args = ['location?']
3637
def run(self, location=None):
3638
b, relpath = Branch.open_containing(u'.')
3639
if location is None:
3641
location = b.get_old_bound_location()
3642
except errors.UpgradeRequired:
3643
raise errors.BzrCommandError('No location supplied. '
3644
'This format does not remember old locations.')
3646
if location is None:
3647
raise errors.BzrCommandError('No location supplied and no '
3648
'previous location known')
3649
b_other = Branch.open(location)
3652
except errors.DivergedBranches:
3653
raise errors.BzrCommandError('These branches have diverged.'
3654
' Try merging, and then bind again.')
3657
class cmd_unbind(Command):
3658
"""Convert the current checkout into a regular branch.
3660
After unbinding, the local branch is considered independent and subsequent
3661
commits will be local only.
3664
_see_also = ['checkouts', 'bind']
3669
b, relpath = Branch.open_containing(u'.')
3671
raise errors.BzrCommandError('Local branch is not bound')
3674
class cmd_uncommit(Command):
3675
"""Remove the last committed revision.
3677
--verbose will print out what is being removed.
3678
--dry-run will go through all the motions, but not actually
3681
If --revision is specified, uncommit revisions to leave the branch at the
3682
specified revision. For example, "bzr uncommit -r 15" will leave the
3683
branch at revision 15.
3685
Uncommit leaves the working tree ready for a new commit. The only change
3686
it may make is to restore any pending merges that were present before
3690
# TODO: jam 20060108 Add an option to allow uncommit to remove
3691
# unreferenced information in 'branch-as-repository' branches.
3692
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3693
# information in shared branches as well.
3694
_see_also = ['commit']
3695
takes_options = ['verbose', 'revision',
3696
Option('dry-run', help='Don\'t actually make changes.'),
3697
Option('force', help='Say yes to all questions.'),
3699
help="Only remove the commits from the local branch"
3700
" when in a checkout."
3703
takes_args = ['location?']
3705
encoding_type = 'replace'
3707
def run(self, location=None,
3708
dry_run=False, verbose=False,
3709
revision=None, force=False, local=False):
3710
if location is None:
3712
control, relpath = bzrdir.BzrDir.open_containing(location)
3714
tree = control.open_workingtree()
3716
except (errors.NoWorkingTree, errors.NotLocalUrl):
3718
b = control.open_branch()
3720
if tree is not None:
3725
return self._run(b, tree, dry_run, verbose, revision, force,
3728
if tree is not None:
3733
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3734
from bzrlib.log import log_formatter, show_log
3735
from bzrlib.uncommit import uncommit
3737
last_revno, last_rev_id = b.last_revision_info()
3740
if revision is None:
3742
rev_id = last_rev_id
3744
# 'bzr uncommit -r 10' actually means uncommit
3745
# so that the final tree is at revno 10.
3746
# but bzrlib.uncommit.uncommit() actually uncommits
3747
# the revisions that are supplied.
3748
# So we need to offset it by one
3749
revno = revision[0].in_history(b).revno + 1
3750
if revno <= last_revno:
3751
rev_id = b.get_rev_id(revno)
3753
if rev_id is None or _mod_revision.is_null(rev_id):
3754
self.outf.write('No revisions to uncommit.\n')
3757
lf = log_formatter('short',
3759
show_timezone='original')
3764
direction='forward',
3765
start_revision=revno,
3766
end_revision=last_revno)
3769
print 'Dry-run, pretending to remove the above revisions.'
3771
val = raw_input('Press <enter> to continue')
3773
print 'The above revision(s) will be removed.'
3775
val = raw_input('Are you sure [y/N]? ')
3776
if val.lower() not in ('y', 'yes'):
3780
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3781
revno=revno, local=local)
3784
class cmd_break_lock(Command):
3785
"""Break a dead lock on a repository, branch or working directory.
3787
CAUTION: Locks should only be broken when you are sure that the process
3788
holding the lock has been stopped.
3790
You can get information on what locks are open via the 'bzr info' command.
3795
takes_args = ['location?']
3797
def run(self, location=None, show=False):
3798
if location is None:
3800
control, relpath = bzrdir.BzrDir.open_containing(location)
3802
control.break_lock()
3803
except NotImplementedError:
3807
class cmd_wait_until_signalled(Command):
3808
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3810
This just prints a line to signal when it is ready, then blocks on stdin.
3816
sys.stdout.write("running\n")
3818
sys.stdin.readline()
3821
class cmd_serve(Command):
3822
"""Run the bzr server."""
3824
aliases = ['server']
3828
help='Serve on stdin/out for use from inetd or sshd.'),
3830
help='Listen for connections on nominated port of the form '
3831
'[hostname:]portnumber. Passing 0 as the port number will '
3832
'result in a dynamically allocated port. The default port is '
3836
help='Serve contents of this directory.',
3838
Option('allow-writes',
3839
help='By default the server is a readonly server. Supplying '
3840
'--allow-writes enables write access to the contents of '
3841
'the served directory and below.'
3845
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3846
from bzrlib import lockdir
3847
from bzrlib.smart import medium, server
3848
from bzrlib.transport import get_transport
3849
from bzrlib.transport.chroot import ChrootServer
3850
if directory is None:
3851
directory = os.getcwd()
3852
url = urlutils.local_path_to_url(directory)
3853
if not allow_writes:
3854
url = 'readonly+' + url
3855
chroot_server = ChrootServer(get_transport(url))
3856
chroot_server.setUp()
3857
t = get_transport(chroot_server.get_url())
3859
smart_server = medium.SmartServerPipeStreamMedium(
3860
sys.stdin, sys.stdout, t)
3862
host = medium.BZR_DEFAULT_INTERFACE
3864
port = medium.BZR_DEFAULT_PORT
3867
host, port = port.split(':')
3869
smart_server = server.SmartTCPServer(t, host=host, port=port)
3870
print 'listening on port: ', smart_server.port
3872
# for the duration of this server, no UI output is permitted.
3873
# note that this may cause problems with blackbox tests. This should
3874
# be changed with care though, as we dont want to use bandwidth sending
3875
# progress over stderr to smart server clients!
3876
old_factory = ui.ui_factory
3877
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3879
ui.ui_factory = ui.SilentUIFactory()
3880
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3881
smart_server.serve()
3883
ui.ui_factory = old_factory
3884
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3887
class cmd_join(Command):
3888
"""Combine a subtree into its containing tree.
3890
This command is for experimental use only. It requires the target tree
3891
to be in dirstate-with-subtree format, which cannot be converted into
3894
The TREE argument should be an independent tree, inside another tree, but
3895
not part of it. (Such trees can be produced by "bzr split", but also by
3896
running "bzr branch" with the target inside a tree.)
3898
The result is a combined tree, with the subtree no longer an independant
3899
part. This is marked as a merge of the subtree into the containing tree,
3900
and all history is preserved.
3902
If --reference is specified, the subtree retains its independence. It can
3903
be branched by itself, and can be part of multiple projects at the same
3904
time. But operations performed in the containing tree, such as commit
3905
and merge, will recurse into the subtree.
3908
_see_also = ['split']
3909
takes_args = ['tree']
3911
Option('reference', help='Join by reference.'),
3915
def run(self, tree, reference=False):
3916
sub_tree = WorkingTree.open(tree)
3917
parent_dir = osutils.dirname(sub_tree.basedir)
3918
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3919
repo = containing_tree.branch.repository
3920
if not repo.supports_rich_root():
3921
raise errors.BzrCommandError(
3922
"Can't join trees because %s doesn't support rich root data.\n"
3923
"You can use bzr upgrade on the repository."
3927
containing_tree.add_reference(sub_tree)
3928
except errors.BadReferenceTarget, e:
3929
# XXX: Would be better to just raise a nicely printable
3930
# exception from the real origin. Also below. mbp 20070306
3931
raise errors.BzrCommandError("Cannot join %s. %s" %
3935
containing_tree.subsume(sub_tree)
3936
except errors.BadSubsumeSource, e:
3937
raise errors.BzrCommandError("Cannot join %s. %s" %
3941
class cmd_split(Command):
3942
"""Split a subdirectory of a tree into a separate tree.
3944
This command will produce a target tree in a format that supports
3945
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
3946
converted into earlier formats like 'dirstate-tags'.
3948
The TREE argument should be a subdirectory of a working tree. That
3949
subdirectory will be converted into an independent tree, with its own
3950
branch. Commits in the top-level tree will not apply to the new subtree.
3953
# join is not un-hidden yet
3954
#_see_also = ['join']
3955
takes_args = ['tree']
3957
def run(self, tree):
3958
containing_tree, subdir = WorkingTree.open_containing(tree)
3959
sub_id = containing_tree.path2id(subdir)
3961
raise errors.NotVersionedError(subdir)
3963
containing_tree.extract(sub_id)
3964
except errors.RootNotRich:
3965
raise errors.UpgradeRequired(containing_tree.branch.base)
3968
class cmd_merge_directive(Command):
3969
"""Generate a merge directive for auto-merge tools.
3971
A directive requests a merge to be performed, and also provides all the
3972
information necessary to do so. This means it must either include a
3973
revision bundle, or the location of a branch containing the desired
3976
A submit branch (the location to merge into) must be supplied the first
3977
time the command is issued. After it has been supplied once, it will
3978
be remembered as the default.
3980
A public branch is optional if a revision bundle is supplied, but required
3981
if --diff or --plain is specified. It will be remembered as the default
3982
after the first use.
3985
takes_args = ['submit_branch?', 'public_branch?']
3989
_see_also = ['send']
3992
RegistryOption.from_kwargs('patch-type',
3993
'The type of patch to include in the directive.',
3995
value_switches=True,
3997
bundle='Bazaar revision bundle (default).',
3998
diff='Normal unified diff.',
3999
plain='No patch, just directive.'),
4000
Option('sign', help='GPG-sign the directive.'), 'revision',
4001
Option('mail-to', type=str,
4002
help='Instead of printing the directive, email to this address.'),
4003
Option('message', type=str, short_name='m',
4004
help='Message to use when committing this merge.')
4007
encoding_type = 'exact'
4009
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4010
sign=False, revision=None, mail_to=None, message=None):
4011
from bzrlib.revision import ensure_null, NULL_REVISION
4012
include_patch, include_bundle = {
4013
'plain': (False, False),
4014
'diff': (True, False),
4015
'bundle': (True, True),
4017
branch = Branch.open('.')
4018
stored_submit_branch = branch.get_submit_branch()
4019
if submit_branch is None:
4020
submit_branch = stored_submit_branch
4022
if stored_submit_branch is None:
4023
branch.set_submit_branch(submit_branch)
4024
if submit_branch is None:
4025
submit_branch = branch.get_parent()
4026
if submit_branch is None:
4027
raise errors.BzrCommandError('No submit branch specified or known')
4029
stored_public_branch = branch.get_public_branch()
4030
if public_branch is None:
4031
public_branch = stored_public_branch
4032
elif stored_public_branch is None:
4033
branch.set_public_branch(public_branch)
4034
if not include_bundle and public_branch is None:
4035
raise errors.BzrCommandError('No public branch specified or'
4037
base_revision_id = None
4038
if revision is not None:
4039
if len(revision) > 2:
4040
raise errors.BzrCommandError('bzr merge-directive takes '
4041
'at most two one revision identifiers')
4042
revision_id = revision[-1].as_revision_id(branch)
4043
if len(revision) == 2:
4044
base_revision_id = revision[0].as_revision_id(branch)
4046
revision_id = branch.last_revision()
4047
revision_id = ensure_null(revision_id)
4048
if revision_id == NULL_REVISION:
4049
raise errors.BzrCommandError('No revisions to bundle.')
4050
directive = merge_directive.MergeDirective2.from_objects(
4051
branch.repository, revision_id, time.time(),
4052
osutils.local_time_offset(), submit_branch,
4053
public_branch=public_branch, include_patch=include_patch,
4054
include_bundle=include_bundle, message=message,
4055
base_revision_id=base_revision_id)
4058
self.outf.write(directive.to_signed(branch))
4060
self.outf.writelines(directive.to_lines())
4062
message = directive.to_email(mail_to, branch, sign)
4063
s = SMTPConnection(branch.get_config())
4064
s.send_email(message)
4067
class cmd_send(Command):
4068
"""Mail or create a merge-directive for submiting changes.
4070
A merge directive provides many things needed for requesting merges:
4072
* A machine-readable description of the merge to perform
4074
* An optional patch that is a preview of the changes requested
4076
* An optional bundle of revision data, so that the changes can be applied
4077
directly from the merge directive, without retrieving data from a
4080
If --no-bundle is specified, then public_branch is needed (and must be
4081
up-to-date), so that the receiver can perform the merge using the
4082
public_branch. The public_branch is always included if known, so that
4083
people can check it later.
4085
The submit branch defaults to the parent, but can be overridden. Both
4086
submit branch and public branch will be remembered if supplied.
4088
If a public_branch is known for the submit_branch, that public submit
4089
branch is used in the merge instructions. This means that a local mirror
4090
can be used as your actual submit branch, once you have set public_branch
4093
Mail is sent using your preferred mail program. This should be transparent
4094
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4095
If the preferred client can't be found (or used), your editor will be used.
4097
To use a specific mail program, set the mail_client configuration option.
4098
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4099
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4100
generic options are "default", "editor", "emacsclient", "mapi", and
4103
If mail is being sent, a to address is required. This can be supplied
4104
either on the commandline, by setting the submit_to configuration
4105
option in the branch itself or the child_submit_to configuration option
4106
in the submit branch.
4108
Two formats are currently supported: "4" uses revision bundle format 4 and
4109
merge directive format 2. It is significantly faster and smaller than
4110
older formats. It is compatible with Bazaar 0.19 and later. It is the
4111
default. "0.9" uses revision bundle format 0.9 and merge directive
4112
format 1. It is compatible with Bazaar 0.12 - 0.18.
4114
Merge directives are applied using the merge command or the pull command.
4117
encoding_type = 'exact'
4119
_see_also = ['merge', 'pull']
4121
takes_args = ['submit_branch?', 'public_branch?']
4125
help='Do not include a bundle in the merge directive.'),
4126
Option('no-patch', help='Do not include a preview patch in the merge'
4129
help='Remember submit and public branch.'),
4131
help='Branch to generate the submission from, '
4132
'rather than the one containing the working directory.',
4135
Option('output', short_name='o',
4136
help='Write merge directive to this file; '
4137
'use - for stdout.',
4139
Option('mail-to', help='Mail the request to this address.',
4143
RegistryOption.from_kwargs('format',
4144
'Use the specified output format.',
4145
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4146
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4149
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4150
no_patch=False, revision=None, remember=False, output=None,
4151
format='4', mail_to=None, message=None, **kwargs):
4152
return self._run(submit_branch, revision, public_branch, remember,
4153
format, no_bundle, no_patch, output,
4154
kwargs.get('from', '.'), mail_to, message)
4156
def _run(self, submit_branch, revision, public_branch, remember, format,
4157
no_bundle, no_patch, output, from_, mail_to, message):
4158
from bzrlib.revision import NULL_REVISION
4159
branch = Branch.open_containing(from_)[0]
4161
outfile = StringIO()
4165
outfile = open(output, 'wb')
4166
# we may need to write data into branch's repository to calculate
4171
config = branch.get_config()
4173
mail_to = config.get_user_option('submit_to')
4174
mail_client = config.get_mail_client()
4175
if remember and submit_branch is None:
4176
raise errors.BzrCommandError(
4177
'--remember requires a branch to be specified.')
4178
stored_submit_branch = branch.get_submit_branch()
4179
remembered_submit_branch = False
4180
if submit_branch is None:
4181
submit_branch = stored_submit_branch
4182
remembered_submit_branch = True
4184
if stored_submit_branch is None or remember:
4185
branch.set_submit_branch(submit_branch)
4186
if submit_branch is None:
4187
submit_branch = branch.get_parent()
4188
remembered_submit_branch = True
4189
if submit_branch is None:
4190
raise errors.BzrCommandError('No submit branch known or'
4192
if remembered_submit_branch:
4193
note('Using saved location "%s" to determine what changes to submit.', submit_branch)
4196
submit_config = Branch.open(submit_branch).get_config()
4197
mail_to = submit_config.get_user_option("child_submit_to")
4199
stored_public_branch = branch.get_public_branch()
4200
if public_branch is None:
4201
public_branch = stored_public_branch
4202
elif stored_public_branch is None or remember:
4203
branch.set_public_branch(public_branch)
4204
if no_bundle and public_branch is None:
4205
raise errors.BzrCommandError('No public branch specified or'
4207
base_revision_id = None
4209
if revision is not None:
4210
if len(revision) > 2:
4211
raise errors.BzrCommandError('bzr send takes '
4212
'at most two one revision identifiers')
4213
revision_id = revision[-1].as_revision_id(branch)
4214
if len(revision) == 2:
4215
base_revision_id = revision[0].as_revision_id(branch)
4216
if revision_id is None:
4217
revision_id = branch.last_revision()
4218
if revision_id == NULL_REVISION:
4219
raise errors.BzrCommandError('No revisions to submit.')
4221
directive = merge_directive.MergeDirective2.from_objects(
4222
branch.repository, revision_id, time.time(),
4223
osutils.local_time_offset(), submit_branch,
4224
public_branch=public_branch, include_patch=not no_patch,
4225
include_bundle=not no_bundle, message=message,
4226
base_revision_id=base_revision_id)
4227
elif format == '0.9':
4230
patch_type = 'bundle'
4232
raise errors.BzrCommandError('Format 0.9 does not'
4233
' permit bundle with no patch')
4239
directive = merge_directive.MergeDirective.from_objects(
4240
branch.repository, revision_id, time.time(),
4241
osutils.local_time_offset(), submit_branch,
4242
public_branch=public_branch, patch_type=patch_type,
4245
outfile.writelines(directive.to_lines())
4247
subject = '[MERGE] '
4248
if message is not None:
4251
revision = branch.repository.get_revision(revision_id)
4252
subject += revision.get_summary()
4253
basename = directive.get_disk_name(branch)
4254
mail_client.compose_merge_request(mail_to, subject,
4255
outfile.getvalue(), basename)
4262
class cmd_bundle_revisions(cmd_send):
4264
"""Create a merge-directive for submiting changes.
4266
A merge directive provides many things needed for requesting merges:
4268
* A machine-readable description of the merge to perform
4270
* An optional patch that is a preview of the changes requested
4272
* An optional bundle of revision data, so that the changes can be applied
4273
directly from the merge directive, without retrieving data from a
4276
If --no-bundle is specified, then public_branch is needed (and must be
4277
up-to-date), so that the receiver can perform the merge using the
4278
public_branch. The public_branch is always included if known, so that
4279
people can check it later.
4281
The submit branch defaults to the parent, but can be overridden. Both
4282
submit branch and public branch will be remembered if supplied.
4284
If a public_branch is known for the submit_branch, that public submit
4285
branch is used in the merge instructions. This means that a local mirror
4286
can be used as your actual submit branch, once you have set public_branch
4289
Two formats are currently supported: "4" uses revision bundle format 4 and
4290
merge directive format 2. It is significantly faster and smaller than
4291
older formats. It is compatible with Bazaar 0.19 and later. It is the
4292
default. "0.9" uses revision bundle format 0.9 and merge directive
4293
format 1. It is compatible with Bazaar 0.12 - 0.18.
4298
help='Do not include a bundle in the merge directive.'),
4299
Option('no-patch', help='Do not include a preview patch in the merge'
4302
help='Remember submit and public branch.'),
4304
help='Branch to generate the submission from, '
4305
'rather than the one containing the working directory.',
4308
Option('output', short_name='o', help='Write directive to this file.',
4311
RegistryOption.from_kwargs('format',
4312
'Use the specified output format.',
4313
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4314
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4316
aliases = ['bundle']
4318
_see_also = ['send', 'merge']
4322
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4323
no_patch=False, revision=None, remember=False, output=None,
4324
format='4', **kwargs):
4327
return self._run(submit_branch, revision, public_branch, remember,
4328
format, no_bundle, no_patch, output,
4329
kwargs.get('from', '.'), None, None)
4332
class cmd_tag(Command):
4333
"""Create, remove or modify a tag naming a revision.
4335
Tags give human-meaningful names to revisions. Commands that take a -r
4336
(--revision) option can be given -rtag:X, where X is any previously
4339
Tags are stored in the branch. Tags are copied from one branch to another
4340
along when you branch, push, pull or merge.
4342
It is an error to give a tag name that already exists unless you pass
4343
--force, in which case the tag is moved to point to the new revision.
4345
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4346
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4349
_see_also = ['commit', 'tags']
4350
takes_args = ['tag_name']
4353
help='Delete this tag rather than placing it.',
4356
help='Branch in which to place the tag.',
4361
help='Replace existing tags.',
4366
def run(self, tag_name,
4372
branch, relpath = Branch.open_containing(directory)
4376
branch.tags.delete_tag(tag_name)
4377
self.outf.write('Deleted tag %s.\n' % tag_name)
4380
if len(revision) != 1:
4381
raise errors.BzrCommandError(
4382
"Tags can only be placed on a single revision, "
4384
revision_id = revision[0].as_revision_id(branch)
4386
revision_id = branch.last_revision()
4387
if (not force) and branch.tags.has_tag(tag_name):
4388
raise errors.TagAlreadyExists(tag_name)
4389
branch.tags.set_tag(tag_name, revision_id)
4390
self.outf.write('Created tag %s.\n' % tag_name)
4395
class cmd_tags(Command):
4398
This command shows a table of tag names and the revisions they reference.
4404
help='Branch whose tags should be displayed.',
4408
RegistryOption.from_kwargs('sort',
4409
'Sort tags by different criteria.', title='Sorting',
4410
alpha='Sort tags lexicographically (default).',
4411
time='Sort tags chronologically.',
4422
branch, relpath = Branch.open_containing(directory)
4423
tags = branch.tags.get_tag_dict().items()
4428
elif sort == 'time':
4430
for tag, revid in tags:
4432
revobj = branch.repository.get_revision(revid)
4433
except errors.NoSuchRevision:
4434
timestamp = sys.maxint # place them at the end
4436
timestamp = revobj.timestamp
4437
timestamps[revid] = timestamp
4438
tags.sort(key=lambda x: timestamps[x[1]])
4440
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4441
revno_map = branch.get_revision_id_to_revno_map()
4442
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4443
for tag, revid in tags ]
4444
for tag, revspec in tags:
4445
self.outf.write('%-20s %s\n' % (tag, revspec))
4448
class cmd_reconfigure(Command):
4449
"""Reconfigure the type of a bzr directory.
4451
A target configuration must be specified.
4453
For checkouts, the bind-to location will be auto-detected if not specified.
4454
The order of preference is
4455
1. For a lightweight checkout, the current bound location.
4456
2. For branches that used to be checkouts, the previously-bound location.
4457
3. The push location.
4458
4. The parent location.
4459
If none of these is available, --bind-to must be specified.
4462
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4463
takes_args = ['location?']
4464
takes_options = [RegistryOption.from_kwargs('target_type',
4465
title='Target type',
4466
help='The type to reconfigure the directory to.',
4467
value_switches=True, enum_switch=False,
4468
branch='Reconfigure to be an unbound branch '
4469
'with no working tree.',
4470
tree='Reconfigure to be an unbound branch '
4471
'with a working tree.',
4472
checkout='Reconfigure to be a bound branch '
4473
'with a working tree.',
4474
lightweight_checkout='Reconfigure to be a lightweight'
4475
' checkout (with no local history).',
4476
standalone='Reconfigure to be a standalone branch '
4477
'(i.e. stop using shared repository).',
4478
use_shared='Reconfigure to use a shared repository.'),
4479
Option('bind-to', help='Branch to bind checkout to.',
4482
help='Perform reconfiguration even if local changes'
4486
def run(self, location=None, target_type=None, bind_to=None, force=False):
4487
directory = bzrdir.BzrDir.open(location)
4488
if target_type is None:
4489
raise errors.BzrCommandError('No target configuration specified')
4490
elif target_type == 'branch':
4491
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4492
elif target_type == 'tree':
4493
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4494
elif target_type == 'checkout':
4495
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4497
elif target_type == 'lightweight-checkout':
4498
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4500
elif target_type == 'use-shared':
4501
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4502
elif target_type == 'standalone':
4503
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4504
reconfiguration.apply(force)
4507
class cmd_switch(Command):
4508
"""Set the branch of a checkout and update.
4510
For lightweight checkouts, this changes the branch being referenced.
4511
For heavyweight checkouts, this checks that there are no local commits
4512
versus the current bound branch, then it makes the local branch a mirror
4513
of the new location and binds to it.
4515
In both cases, the working tree is updated and uncommitted changes
4516
are merged. The user can commit or revert these as they desire.
4518
Pending merges need to be committed or reverted before using switch.
4520
The path to the branch to switch to can be specified relative to the parent
4521
directory of the current branch. For example, if you are currently in a
4522
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4526
takes_args = ['to_location']
4527
takes_options = [Option('force',
4528
help='Switch even if local commits will be lost.')
4531
def run(self, to_location, force=False):
4532
from bzrlib import switch
4534
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4536
to_branch = Branch.open(to_location)
4537
except errors.NotBranchError:
4538
to_branch = Branch.open(
4539
control_dir.open_branch().base + '../' + to_location)
4540
switch.switch(control_dir, to_branch, force)
4541
note('Switched to branch: %s',
4542
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4545
class cmd_hooks(Command):
4546
"""Show a branch's currently registered hooks.
4550
takes_args = ['path?']
4552
def run(self, path=None):
4555
branch_hooks = Branch.open(path).hooks
4556
for hook_type in branch_hooks:
4557
hooks = branch_hooks[hook_type]
4558
self.outf.write("%s:\n" % (hook_type,))
4561
self.outf.write(" %s\n" %
4562
(branch_hooks.get_hook_name(hook),))
4564
self.outf.write(" <no hooks installed>\n")
4567
def _create_prefix(cur_transport):
4568
needed = [cur_transport]
4569
# Recurse upwards until we can create a directory successfully
4571
new_transport = cur_transport.clone('..')
4572
if new_transport.base == cur_transport.base:
4573
raise errors.BzrCommandError(
4574
"Failed to create path prefix for %s."
4575
% cur_transport.base)
4577
new_transport.mkdir('.')
4578
except errors.NoSuchFile:
4579
needed.append(new_transport)
4580
cur_transport = new_transport
4583
# Now we only need to create child directories
4585
cur_transport = needed.pop()
4586
cur_transport.ensure_base()
4589
# these get imported and then picked up by the scan for cmd_*
4590
# TODO: Some more consistent way to split command definitions across files;
4591
# we do need to load at least some information about them to know of
4592
# aliases. ideally we would avoid loading the implementation until the
4593
# details were needed.
4594
from bzrlib.cmd_version_info import cmd_version_info
4595
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4596
from bzrlib.bundle.commands import (
4599
from bzrlib.sign_my_commits import cmd_sign_my_commits
4600
from bzrlib.weave_commands import cmd_versionedfile_list, \
4601
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
