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, file_list = tree_files(file_list)
189
show_tree_status(tree, show_ids=show_ids,
190
specific_files=file_list, revision=revision,
191
to_file=self.outf, short=short, versioned=versioned,
192
show_pending=not no_pending)
195
class cmd_cat_revision(Command):
196
"""Write out metadata for a revision.
198
The revision to print can either be specified by a specific
199
revision identifier, or you can use --revision.
203
takes_args = ['revision_id?']
204
takes_options = ['revision']
205
# cat-revision is more for frontends so should be exact
209
def run(self, revision_id=None, revision=None):
210
if revision_id is not None and revision is not None:
211
raise errors.BzrCommandError('You can only supply one of'
212
' revision_id or --revision')
213
if revision_id is None and revision is None:
214
raise errors.BzrCommandError('You must supply either'
215
' --revision or a revision_id')
216
b = WorkingTree.open_containing(u'.')[0].branch
218
# TODO: jam 20060112 should cat-revision always output utf-8?
219
if revision_id is not None:
220
revision_id = osutils.safe_revision_id(revision_id, warn=False)
221
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
222
elif revision is not None:
225
raise errors.BzrCommandError('You cannot specify a NULL'
227
rev_id = rev.as_revision_id(b)
228
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
231
class cmd_remove_tree(Command):
232
"""Remove the working tree from a given branch/checkout.
234
Since a lightweight checkout is little more than a working tree
235
this will refuse to run against one.
237
To re-create the working tree, use "bzr checkout".
239
_see_also = ['checkout', 'working-trees']
241
takes_args = ['location?']
243
def run(self, location='.'):
244
d = bzrdir.BzrDir.open(location)
247
working = d.open_workingtree()
248
except errors.NoWorkingTree:
249
raise errors.BzrCommandError("No working tree to remove")
250
except errors.NotLocalUrl:
251
raise errors.BzrCommandError("You cannot remove the working tree of a "
254
working_path = working.bzrdir.root_transport.base
255
branch_path = working.branch.bzrdir.root_transport.base
256
if working_path != branch_path:
257
raise errors.BzrCommandError("You cannot remove the working tree from "
258
"a lightweight checkout")
260
d.destroy_workingtree()
263
class cmd_revno(Command):
264
"""Show current revision number.
266
This is equal to the number of revisions on this branch.
270
takes_args = ['location?']
273
def run(self, location=u'.'):
274
self.outf.write(str(Branch.open_containing(location)[0].revno()))
275
self.outf.write('\n')
278
class cmd_revision_info(Command):
279
"""Show revision number and revision id for a given revision identifier.
282
takes_args = ['revision_info*']
283
takes_options = ['revision']
286
def run(self, revision=None, revision_info_list=[]):
289
if revision is not None:
290
revs.extend(revision)
291
if revision_info_list is not None:
292
for rev in revision_info_list:
293
revs.append(RevisionSpec.from_string(rev))
295
b = Branch.open_containing(u'.')[0]
298
revs.append(RevisionSpec.from_string('-1'))
301
revision_id = rev.as_revision_id(b)
303
revno = '%4d' % (b.revision_id_to_revno(revision_id))
304
except errors.NoSuchRevision:
305
dotted_map = b.get_revision_id_to_revno_map()
306
revno = '.'.join(str(i) for i in dotted_map[revision_id])
307
print '%s %s' % (revno, revision_id)
310
class cmd_add(Command):
311
"""Add specified files or directories.
313
In non-recursive mode, all the named items are added, regardless
314
of whether they were previously ignored. A warning is given if
315
any of the named files are already versioned.
317
In recursive mode (the default), files are treated the same way
318
but the behaviour for directories is different. Directories that
319
are already versioned do not give a warning. All directories,
320
whether already versioned or not, are searched for files or
321
subdirectories that are neither versioned or ignored, and these
322
are added. This search proceeds recursively into versioned
323
directories. If no names are given '.' is assumed.
325
Therefore simply saying 'bzr add' will version all files that
326
are currently unknown.
328
Adding a file whose parent directory is not versioned will
329
implicitly add the parent, and so on up to the root. This means
330
you should never need to explicitly add a directory, they'll just
331
get added when you add a file in the directory.
333
--dry-run will show which files would be added, but not actually
336
--file-ids-from will try to use the file ids from the supplied path.
337
It looks up ids trying to find a matching parent directory with the
338
same filename, and then by pure path. This option is rarely needed
339
but can be useful when adding the same logical file into two
340
branches that will be merged later (without showing the two different
341
adds as a conflict). It is also useful when merging another project
342
into a subdirectory of this one.
344
takes_args = ['file*']
347
help="Don't recursively add the contents of directories."),
349
help="Show what would be done, but don't actually do anything."),
351
Option('file-ids-from',
353
help='Lookup file ids from this tree.'),
355
encoding_type = 'replace'
356
_see_also = ['remove']
358
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
363
if file_ids_from is not None:
365
base_tree, base_path = WorkingTree.open_containing(
367
except errors.NoWorkingTree:
368
base_branch, base_path = Branch.open_containing(
370
base_tree = base_branch.basis_tree()
372
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
373
to_file=self.outf, should_print=(not is_quiet()))
375
action = bzrlib.add.AddAction(to_file=self.outf,
376
should_print=(not is_quiet()))
379
base_tree.lock_read()
381
file_list = self._maybe_expand_globs(file_list)
383
tree = WorkingTree.open_containing(file_list[0])[0]
385
tree = WorkingTree.open_containing(u'.')[0]
386
added, ignored = tree.smart_add(file_list, not
387
no_recurse, action=action, save=not dry_run)
389
if base_tree is not None:
393
for glob in sorted(ignored.keys()):
394
for path in ignored[glob]:
395
self.outf.write("ignored %s matching \"%s\"\n"
399
for glob, paths in ignored.items():
400
match_len += len(paths)
401
self.outf.write("ignored %d file(s).\n" % match_len)
402
self.outf.write("If you wish to add some of these files,"
403
" please add them by name.\n")
406
class cmd_mkdir(Command):
407
"""Create a new versioned directory.
409
This is equivalent to creating the directory and then adding it.
412
takes_args = ['dir+']
413
encoding_type = 'replace'
415
def run(self, dir_list):
418
wt, dd = WorkingTree.open_containing(d)
420
self.outf.write('added %s\n' % d)
423
class cmd_relpath(Command):
424
"""Show path of a file relative to root"""
426
takes_args = ['filename']
430
def run(self, filename):
431
# TODO: jam 20050106 Can relpath return a munged path if
432
# sys.stdout encoding cannot represent it?
433
tree, relpath = WorkingTree.open_containing(filename)
434
self.outf.write(relpath)
435
self.outf.write('\n')
438
class cmd_inventory(Command):
439
"""Show inventory of the current working copy or a revision.
441
It is possible to limit the output to a particular entry
442
type using the --kind option. For example: --kind file.
444
It is also possible to restrict the list of files to a specific
445
set. For example: bzr inventory --show-ids this/file
454
help='List entries of a particular kind: file, directory, symlink.',
457
takes_args = ['file*']
460
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
461
if kind and kind not in ['file', 'directory', 'symlink']:
462
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
464
work_tree, file_list = tree_files(file_list)
465
work_tree.lock_read()
467
if revision is not None:
468
if len(revision) > 1:
469
raise errors.BzrCommandError(
470
'bzr inventory --revision takes exactly one revision'
472
revision_id = revision[0].as_revision_id(work_tree.branch)
473
tree = work_tree.branch.repository.revision_tree(revision_id)
475
extra_trees = [work_tree]
481
if file_list is not None:
482
file_ids = tree.paths2ids(file_list, trees=extra_trees,
483
require_versioned=True)
484
# find_ids_across_trees may include some paths that don't
486
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
487
for file_id in file_ids if file_id in tree)
489
entries = tree.inventory.entries()
492
if tree is not work_tree:
495
for path, entry in entries:
496
if kind and kind != entry.kind:
499
self.outf.write('%-50s %s\n' % (path, entry.file_id))
501
self.outf.write(path)
502
self.outf.write('\n')
505
class cmd_mv(Command):
506
"""Move or rename a file.
509
bzr mv OLDNAME NEWNAME
511
bzr mv SOURCE... DESTINATION
513
If the last argument is a versioned directory, all the other names
514
are moved into it. Otherwise, there must be exactly two arguments
515
and the file is changed to a new name.
517
If OLDNAME does not exist on the filesystem but is versioned and
518
NEWNAME does exist on the filesystem but is not versioned, mv
519
assumes that the file has been manually moved and only updates
520
its internal inventory to reflect that change.
521
The same is valid when moving many SOURCE files to a DESTINATION.
523
Files cannot be moved between branches.
526
takes_args = ['names*']
527
takes_options = [Option("after", help="Move only the bzr identifier"
528
" of the file, because the file has already been moved."),
530
aliases = ['move', 'rename']
531
encoding_type = 'replace'
533
def run(self, names_list, after=False):
534
if names_list is None:
537
if len(names_list) < 2:
538
raise errors.BzrCommandError("missing file argument")
539
tree, rel_names = tree_files(names_list)
542
self._run(tree, names_list, rel_names, after)
546
def _run(self, tree, names_list, rel_names, after):
547
into_existing = osutils.isdir(names_list[-1])
548
if into_existing and len(names_list) == 2:
550
# a. case-insensitive filesystem and change case of dir
551
# b. move directory after the fact (if the source used to be
552
# a directory, but now doesn't exist in the working tree
553
# and the target is an existing directory, just rename it)
554
if (not tree.case_sensitive
555
and rel_names[0].lower() == rel_names[1].lower()):
556
into_existing = False
559
from_id = tree.path2id(rel_names[0])
560
if (not osutils.lexists(names_list[0]) and
561
from_id and inv.get_file_kind(from_id) == "directory"):
562
into_existing = False
565
# move into existing directory
566
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
567
self.outf.write("%s => %s\n" % pair)
569
if len(names_list) != 2:
570
raise errors.BzrCommandError('to mv multiple files the'
571
' destination must be a versioned'
573
tree.rename_one(rel_names[0], rel_names[1], after=after)
574
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
577
class cmd_pull(Command):
578
"""Turn this branch into a mirror of another branch.
580
This command only works on branches that have not diverged. Branches are
581
considered diverged if the destination branch's most recent commit is one
582
that has not been merged (directly or indirectly) into the parent.
584
If branches have diverged, you can use 'bzr merge' to integrate the changes
585
from one into the other. Once one branch has merged, the other should
586
be able to pull it again.
588
If you want to forget your local changes and just update your branch to
589
match the remote one, use pull --overwrite.
591
If there is no default location set, the first pull will set it. After
592
that, you can omit the location to use the default. To change the
593
default, use --remember. The value will only be saved if the remote
594
location can be accessed.
596
Note: The location can be specified either in the form of a branch,
597
or in the form of a path to a file containing a merge directive generated
601
_see_also = ['push', 'update', 'status-flags']
602
takes_options = ['remember', 'overwrite', 'revision',
603
custom_help('verbose',
604
help='Show logs of pulled revisions.'),
606
help='Branch to pull into, '
607
'rather than the one containing the working directory.',
612
takes_args = ['location?']
613
encoding_type = 'replace'
615
def run(self, location=None, remember=False, overwrite=False,
616
revision=None, verbose=False,
618
# FIXME: too much stuff is in the command class
621
if directory is None:
624
tree_to = WorkingTree.open_containing(directory)[0]
625
branch_to = tree_to.branch
626
except errors.NoWorkingTree:
628
branch_to = Branch.open_containing(directory)[0]
630
possible_transports = []
631
if location is not None:
633
mergeable = bundle.read_mergeable_from_url(location,
634
possible_transports=possible_transports)
635
except errors.NotABundle:
638
stored_loc = branch_to.get_parent()
640
if stored_loc is None:
641
raise errors.BzrCommandError("No pull location known or"
644
display_url = urlutils.unescape_for_display(stored_loc,
647
self.outf.write("Using saved location: %s\n" % display_url)
648
location = stored_loc
650
if mergeable is not None:
651
if revision is not None:
652
raise errors.BzrCommandError(
653
'Cannot use -r with merge directives or bundles')
654
mergeable.install_revisions(branch_to.repository)
655
base_revision_id, revision_id, verified = \
656
mergeable.get_merge_request(branch_to.repository)
657
branch_from = branch_to
659
branch_from = Branch.open(location,
660
possible_transports=possible_transports)
662
if branch_to.get_parent() is None or remember:
663
branch_to.set_parent(branch_from.base)
665
if revision is not None:
666
if len(revision) == 1:
667
revision_id = revision[0].as_revision_id(branch_from)
669
raise errors.BzrCommandError(
670
'bzr pull --revision takes one value.')
672
branch_to.lock_write()
674
if tree_to is not None:
675
change_reporter = delta._ChangeReporter(
676
unversioned_filter=tree_to.is_ignored)
677
result = tree_to.pull(branch_from, overwrite, revision_id,
679
possible_transports=possible_transports)
681
result = branch_to.pull(branch_from, overwrite, revision_id)
683
result.report(self.outf)
684
if verbose and result.old_revid != result.new_revid:
686
branch_to.repository.iter_reverse_revision_history(
689
new_rh = branch_to.revision_history()
690
log.show_changed_revisions(branch_to, old_rh, new_rh,
696
class cmd_push(Command):
697
"""Update a mirror of this branch.
699
The target branch will not have its working tree populated because this
700
is both expensive, and is not supported on remote file systems.
702
Some smart servers or protocols *may* put the working tree in place in
705
This command only works on branches that have not diverged. Branches are
706
considered diverged if the destination branch's most recent commit is one
707
that has not been merged (directly or indirectly) by the source branch.
709
If branches have diverged, you can use 'bzr push --overwrite' to replace
710
the other branch completely, discarding its unmerged changes.
712
If you want to ensure you have the different changes in the other branch,
713
do a merge (see bzr help merge) from the other branch, and commit that.
714
After that you will be able to do a push without '--overwrite'.
716
If there is no default push location set, the first push will set it.
717
After that, you can omit the location to use the default. To change the
718
default, use --remember. The value will only be saved if the remote
719
location can be accessed.
722
_see_also = ['pull', 'update', 'working-trees']
723
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
724
Option('create-prefix',
725
help='Create the path leading up to the branch '
726
'if it does not already exist.'),
728
help='Branch to push from, '
729
'rather than the one containing the working directory.',
733
Option('use-existing-dir',
734
help='By default push will fail if the target'
735
' directory exists, but does not already'
736
' have a control directory. This flag will'
737
' allow push to proceed.'),
739
help='Create a stacked branch that references the public location '
740
'of the parent branch.'),
742
help='Create a stacked branch that refers to another branch '
743
'for the commit history. Only the work not present in the '
744
'referenced branch is included in the branch created.',
747
takes_args = ['location?']
748
encoding_type = 'replace'
750
def run(self, location=None, remember=False, overwrite=False,
751
create_prefix=False, verbose=False, revision=None,
752
use_existing_dir=False, directory=None, stacked_on=None,
754
from bzrlib.push import _show_push_branch
756
# Get the source branch and revision_id
757
if directory is None:
759
br_from = Branch.open_containing(directory)[0]
760
if revision is not None:
761
if len(revision) == 1:
762
revision_id = revision[0].in_history(br_from).rev_id
764
raise errors.BzrCommandError(
765
'bzr push --revision takes one value.')
767
revision_id = br_from.last_revision()
769
# Get the stacked_on branch, if any
770
if stacked_on is not None:
771
stacked_on = urlutils.normalize_url(stacked_on)
773
parent_url = br_from.get_parent()
775
parent = Branch.open(parent_url)
776
stacked_on = parent.get_public_branch()
778
# I considered excluding non-http url's here, thus forcing
779
# 'public' branches only, but that only works for some
780
# users, so it's best to just depend on the user spotting an
781
# error by the feedback given to them. RBC 20080227.
782
stacked_on = parent_url
784
raise errors.BzrCommandError(
785
"Could not determine branch to refer to.")
787
# Get the destination location
789
stored_loc = br_from.get_push_location()
790
if stored_loc is None:
791
raise errors.BzrCommandError(
792
"No push location known or specified.")
794
display_url = urlutils.unescape_for_display(stored_loc,
796
self.outf.write("Using saved location: %s\n" % display_url)
797
location = stored_loc
799
_show_push_branch(br_from, revision_id, location, self.outf,
800
verbose=verbose, overwrite=overwrite, remember=remember,
801
stacked_on=stacked_on, create_prefix=create_prefix,
802
use_existing_dir=use_existing_dir)
805
class cmd_branch(Command):
806
"""Create a new copy of a branch.
808
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
809
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
810
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
811
is derived from the FROM_LOCATION by stripping a leading scheme or drive
812
identifier, if any. For example, "branch lp:foo-bar" will attempt to
815
To retrieve the branch as of a particular revision, supply the --revision
816
parameter, as in "branch foo/bar -r 5".
819
_see_also = ['checkout']
820
takes_args = ['from_location', 'to_location?']
821
takes_options = ['revision', Option('hardlink',
822
help='Hard-link working tree files where possible.'),
824
help='Create a stacked branch referring to the source branch. '
825
'The new branch will depend on the availability of the source '
826
'branch for all operations.'),
828
aliases = ['get', 'clone']
830
def run(self, from_location, to_location=None, revision=None,
831
hardlink=False, stacked=False):
832
from bzrlib.tag import _merge_tags_if_possible
835
elif len(revision) > 1:
836
raise errors.BzrCommandError(
837
'bzr branch --revision takes exactly 1 revision value')
839
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
843
if len(revision) == 1 and revision[0] is not None:
844
revision_id = revision[0].as_revision_id(br_from)
846
# FIXME - wt.last_revision, fallback to branch, fall back to
847
# None or perhaps NULL_REVISION to mean copy nothing
849
revision_id = br_from.last_revision()
850
if to_location is None:
851
to_location = urlutils.derive_to_location(from_location)
852
to_transport = transport.get_transport(to_location)
854
to_transport.mkdir('.')
855
except errors.FileExists:
856
raise errors.BzrCommandError('Target directory "%s" already'
857
' exists.' % to_location)
858
except errors.NoSuchFile:
859
raise errors.BzrCommandError('Parent of "%s" does not exist.'
862
# preserve whatever source format we have.
863
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
864
possible_transports=[to_transport],
865
accelerator_tree=accelerator_tree,
866
hardlink=hardlink, stacked=stacked)
867
branch = dir.open_branch()
868
except errors.NoSuchRevision:
869
to_transport.delete_tree('.')
870
msg = "The branch %s has no revision %s." % (from_location,
872
raise errors.BzrCommandError(msg)
873
_merge_tags_if_possible(br_from, branch)
874
# If the source branch is stacked, the new branch may
875
# be stacked whether we asked for that explicitly or not.
876
# We therefore need a try/except here and not just 'if stacked:'
878
note('Created new stacked branch referring to %s.' %
879
branch.get_stacked_on_url())
880
except (errors.NotStacked, errors.UnstackableBranchFormat,
881
errors.UnstackableRepositoryFormat), e:
882
note('Branched %d revision(s).' % branch.revno())
887
class cmd_checkout(Command):
888
"""Create a new checkout of an existing branch.
890
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
891
the branch found in '.'. This is useful if you have removed the working tree
892
or if it was never created - i.e. if you pushed the branch to its current
895
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
896
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
897
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
898
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
899
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
902
To retrieve the branch as of a particular revision, supply the --revision
903
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
904
out of date [so you cannot commit] but it may be useful (i.e. to examine old
908
_see_also = ['checkouts', 'branch']
909
takes_args = ['branch_location?', 'to_location?']
910
takes_options = ['revision',
911
Option('lightweight',
912
help="Perform a lightweight checkout. Lightweight "
913
"checkouts depend on access to the branch for "
914
"every operation. Normal checkouts can perform "
915
"common operations like diff and status without "
916
"such access, and also support local commits."
918
Option('files-from', type=str,
919
help="Get file contents from this tree."),
921
help='Hard-link working tree files where possible.'
926
def run(self, branch_location=None, to_location=None, revision=None,
927
lightweight=False, files_from=None, hardlink=False):
930
elif len(revision) > 1:
931
raise errors.BzrCommandError(
932
'bzr checkout --revision takes exactly 1 revision value')
933
if branch_location is None:
934
branch_location = osutils.getcwd()
935
to_location = branch_location
936
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
938
if files_from is not None:
939
accelerator_tree = WorkingTree.open(files_from)
940
if len(revision) == 1 and revision[0] is not None:
941
revision_id = revision[0].as_revision_id(source)
944
if to_location is None:
945
to_location = urlutils.derive_to_location(branch_location)
946
# if the source and to_location are the same,
947
# and there is no working tree,
948
# then reconstitute a branch
949
if (osutils.abspath(to_location) ==
950
osutils.abspath(branch_location)):
952
source.bzrdir.open_workingtree()
953
except errors.NoWorkingTree:
954
source.bzrdir.create_workingtree(revision_id)
956
source.create_checkout(to_location, revision_id, lightweight,
957
accelerator_tree, hardlink)
960
class cmd_renames(Command):
961
"""Show list of renamed files.
963
# TODO: Option to show renames between two historical versions.
965
# TODO: Only show renames under dir, rather than in the whole branch.
966
_see_also = ['status']
967
takes_args = ['dir?']
970
def run(self, dir=u'.'):
971
tree = WorkingTree.open_containing(dir)[0]
974
new_inv = tree.inventory
975
old_tree = tree.basis_tree()
978
old_inv = old_tree.inventory
979
renames = list(_mod_tree.find_renames(old_inv, new_inv))
981
for old_name, new_name in renames:
982
self.outf.write("%s => %s\n" % (old_name, new_name))
989
class cmd_update(Command):
990
"""Update a tree to have the latest code committed to its branch.
992
This will perform a merge into the working tree, and may generate
993
conflicts. If you have any local changes, you will still
994
need to commit them after the update for the update to be complete.
996
If you want to discard your local changes, you can just do a
997
'bzr revert' instead of 'bzr commit' after the update.
1000
_see_also = ['pull', 'working-trees', 'status-flags']
1001
takes_args = ['dir?']
1004
def run(self, dir='.'):
1005
tree = WorkingTree.open_containing(dir)[0]
1006
possible_transports = []
1007
master = tree.branch.get_master_branch(
1008
possible_transports=possible_transports)
1009
if master is not None:
1012
tree.lock_tree_write()
1014
existing_pending_merges = tree.get_parent_ids()[1:]
1015
last_rev = _mod_revision.ensure_null(tree.last_revision())
1016
if last_rev == _mod_revision.ensure_null(
1017
tree.branch.last_revision()):
1018
# may be up to date, check master too.
1019
if master is None or last_rev == _mod_revision.ensure_null(
1020
master.last_revision()):
1021
revno = tree.branch.revision_id_to_revno(last_rev)
1022
note("Tree is up to date at revision %d." % (revno,))
1024
conflicts = tree.update(
1025
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1026
possible_transports=possible_transports)
1027
revno = tree.branch.revision_id_to_revno(
1028
_mod_revision.ensure_null(tree.last_revision()))
1029
note('Updated to revision %d.' % (revno,))
1030
if tree.get_parent_ids()[1:] != existing_pending_merges:
1031
note('Your local commits will now show as pending merges with '
1032
"'bzr status', and can be committed with 'bzr commit'.")
1041
class cmd_info(Command):
1042
"""Show information about a working tree, branch or repository.
1044
This command will show all known locations and formats associated to the
1045
tree, branch or repository. Statistical information is included with
1048
Branches and working trees will also report any missing revisions.
1050
_see_also = ['revno', 'working-trees', 'repositories']
1051
takes_args = ['location?']
1052
takes_options = ['verbose']
1053
encoding_type = 'replace'
1056
def run(self, location=None, verbose=False):
1061
from bzrlib.info import show_bzrdir_info
1062
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1063
verbose=noise_level, outfile=self.outf)
1066
class cmd_remove(Command):
1067
"""Remove files or directories.
1069
This makes bzr stop tracking changes to the specified files. bzr will delete
1070
them if they can easily be recovered using revert. If no options or
1071
parameters are given bzr will scan for files that are being tracked by bzr
1072
but missing in your tree and stop tracking them for you.
1074
takes_args = ['file*']
1075
takes_options = ['verbose',
1076
Option('new', help='Only remove files that have never been committed.'),
1077
RegistryOption.from_kwargs('file-deletion-strategy',
1078
'The file deletion mode to be used.',
1079
title='Deletion Strategy', value_switches=True, enum_switch=False,
1080
safe='Only delete files if they can be'
1081
' safely recovered (default).',
1082
keep="Don't delete any files.",
1083
force='Delete all the specified files, even if they can not be '
1084
'recovered and even if they are non-empty directories.')]
1085
aliases = ['rm', 'del']
1086
encoding_type = 'replace'
1088
def run(self, file_list, verbose=False, new=False,
1089
file_deletion_strategy='safe'):
1090
tree, file_list = tree_files(file_list)
1092
if file_list is not None:
1093
file_list = [f for f in file_list]
1097
# Heuristics should probably all move into tree.remove_smart or
1100
added = tree.changes_from(tree.basis_tree(),
1101
specific_files=file_list).added
1102
file_list = sorted([f[0] for f in added], reverse=True)
1103
if len(file_list) == 0:
1104
raise errors.BzrCommandError('No matching files.')
1105
elif file_list is None:
1106
# missing files show up in iter_changes(basis) as
1107
# versioned-with-no-kind.
1109
for change in tree.iter_changes(tree.basis_tree()):
1110
# Find paths in the working tree that have no kind:
1111
if change[1][1] is not None and change[6][1] is None:
1112
missing.append(change[1][1])
1113
file_list = sorted(missing, reverse=True)
1114
file_deletion_strategy = 'keep'
1115
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1116
keep_files=file_deletion_strategy=='keep',
1117
force=file_deletion_strategy=='force')
1122
class cmd_file_id(Command):
1123
"""Print file_id of a particular file or directory.
1125
The file_id is assigned when the file is first added and remains the
1126
same through all revisions where the file exists, even when it is
1131
_see_also = ['inventory', 'ls']
1132
takes_args = ['filename']
1135
def run(self, filename):
1136
tree, relpath = WorkingTree.open_containing(filename)
1137
i = tree.path2id(relpath)
1139
raise errors.NotVersionedError(filename)
1141
self.outf.write(i + '\n')
1144
class cmd_file_path(Command):
1145
"""Print path of file_ids to a file or directory.
1147
This prints one line for each directory down to the target,
1148
starting at the branch root.
1152
takes_args = ['filename']
1155
def run(self, filename):
1156
tree, relpath = WorkingTree.open_containing(filename)
1157
fid = tree.path2id(relpath)
1159
raise errors.NotVersionedError(filename)
1160
segments = osutils.splitpath(relpath)
1161
for pos in range(1, len(segments) + 1):
1162
path = osutils.joinpath(segments[:pos])
1163
self.outf.write("%s\n" % tree.path2id(path))
1166
class cmd_reconcile(Command):
1167
"""Reconcile bzr metadata in a branch.
1169
This can correct data mismatches that may have been caused by
1170
previous ghost operations or bzr upgrades. You should only
1171
need to run this command if 'bzr check' or a bzr developer
1172
advises you to run it.
1174
If a second branch is provided, cross-branch reconciliation is
1175
also attempted, which will check that data like the tree root
1176
id which was not present in very early bzr versions is represented
1177
correctly in both branches.
1179
At the same time it is run it may recompress data resulting in
1180
a potential saving in disk space or performance gain.
1182
The branch *MUST* be on a listable system such as local disk or sftp.
1185
_see_also = ['check']
1186
takes_args = ['branch?']
1188
def run(self, branch="."):
1189
from bzrlib.reconcile import reconcile
1190
dir = bzrdir.BzrDir.open(branch)
1194
class cmd_revision_history(Command):
1195
"""Display the list of revision ids on a branch."""
1198
takes_args = ['location?']
1203
def run(self, location="."):
1204
branch = Branch.open_containing(location)[0]
1205
for revid in branch.revision_history():
1206
self.outf.write(revid)
1207
self.outf.write('\n')
1210
class cmd_ancestry(Command):
1211
"""List all revisions merged into this branch."""
1213
_see_also = ['log', 'revision-history']
1214
takes_args = ['location?']
1219
def run(self, location="."):
1221
wt = WorkingTree.open_containing(location)[0]
1222
except errors.NoWorkingTree:
1223
b = Branch.open(location)
1224
last_revision = b.last_revision()
1227
last_revision = wt.last_revision()
1229
revision_ids = b.repository.get_ancestry(last_revision)
1231
for revision_id in revision_ids:
1232
self.outf.write(revision_id + '\n')
1235
class cmd_init(Command):
1236
"""Make a directory into a versioned branch.
1238
Use this to create an empty branch, or before importing an
1241
If there is a repository in a parent directory of the location, then
1242
the history of the branch will be stored in the repository. Otherwise
1243
init creates a standalone branch which carries its own history
1244
in the .bzr directory.
1246
If there is already a branch at the location but it has no working tree,
1247
the tree can be populated with 'bzr checkout'.
1249
Recipe for importing a tree of files::
1255
bzr commit -m "imported project"
1258
_see_also = ['init-repository', 'branch', 'checkout']
1259
takes_args = ['location?']
1261
Option('create-prefix',
1262
help='Create the path leading up to the branch '
1263
'if it does not already exist.'),
1264
RegistryOption('format',
1265
help='Specify a format for this branch. '
1266
'See "help formats".',
1267
registry=bzrdir.format_registry,
1268
converter=bzrdir.format_registry.make_bzrdir,
1269
value_switches=True,
1270
title="Branch Format",
1272
Option('append-revisions-only',
1273
help='Never change revnos or the existing log.'
1274
' Append revisions to it only.')
1276
def run(self, location=None, format=None, append_revisions_only=False,
1277
create_prefix=False):
1279
format = bzrdir.format_registry.make_bzrdir('default')
1280
if location is None:
1283
to_transport = transport.get_transport(location)
1285
# The path has to exist to initialize a
1286
# branch inside of it.
1287
# Just using os.mkdir, since I don't
1288
# believe that we want to create a bunch of
1289
# locations if the user supplies an extended path
1291
to_transport.ensure_base()
1292
except errors.NoSuchFile:
1293
if not create_prefix:
1294
raise errors.BzrCommandError("Parent directory of %s"
1296
"\nYou may supply --create-prefix to create all"
1297
" leading parent directories."
1299
_create_prefix(to_transport)
1302
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1303
except errors.NotBranchError:
1304
# really a NotBzrDir error...
1305
create_branch = bzrdir.BzrDir.create_branch_convenience
1306
branch = create_branch(to_transport.base, format=format,
1307
possible_transports=[to_transport])
1309
from bzrlib.transport.local import LocalTransport
1310
if existing_bzrdir.has_branch():
1311
if (isinstance(to_transport, LocalTransport)
1312
and not existing_bzrdir.has_workingtree()):
1313
raise errors.BranchExistsWithoutWorkingTree(location)
1314
raise errors.AlreadyBranchError(location)
1316
branch = existing_bzrdir.create_branch()
1317
existing_bzrdir.create_workingtree()
1318
if append_revisions_only:
1320
branch.set_append_revisions_only(True)
1321
except errors.UpgradeRequired:
1322
raise errors.BzrCommandError('This branch format cannot be set'
1323
' to append-revisions-only. Try --experimental-branch6')
1325
from bzrlib.info import show_bzrdir_info
1326
show_bzrdir_info(bzrdir.BzrDir.open_containing_from_transport(
1327
to_transport)[0], verbose=0, outfile=self.outf)
1330
class cmd_init_repository(Command):
1331
"""Create a shared repository to hold branches.
1333
New branches created under the repository directory will store their
1334
revisions in the repository, not in the branch directory.
1336
If the --no-trees option is used then the branches in the repository
1337
will not have working trees by default.
1340
Create a shared repositories holding just branches::
1342
bzr init-repo --no-trees repo
1345
Make a lightweight checkout elsewhere::
1347
bzr checkout --lightweight repo/trunk trunk-checkout
1352
_see_also = ['init', 'branch', 'checkout', 'repositories']
1353
takes_args = ["location"]
1354
takes_options = [RegistryOption('format',
1355
help='Specify a format for this repository. See'
1356
' "bzr help formats" for details.',
1357
registry=bzrdir.format_registry,
1358
converter=bzrdir.format_registry.make_bzrdir,
1359
value_switches=True, title='Repository format'),
1361
help='Branches in the repository will default to'
1362
' not having a working tree.'),
1364
aliases = ["init-repo"]
1366
def run(self, location, format=None, no_trees=False):
1368
format = bzrdir.format_registry.make_bzrdir('default')
1370
if location is None:
1373
to_transport = transport.get_transport(location)
1374
to_transport.ensure_base()
1376
newdir = format.initialize_on_transport(to_transport)
1377
repo = newdir.create_repository(shared=True)
1378
repo.set_make_working_trees(not no_trees)
1380
from bzrlib.info import show_bzrdir_info
1381
show_bzrdir_info(bzrdir.BzrDir.open_containing_from_transport(
1382
to_transport)[0], verbose=0, outfile=self.outf)
1385
class cmd_diff(Command):
1386
"""Show differences in the working tree, between revisions or branches.
1388
If no arguments are given, all changes for the current tree are listed.
1389
If files are given, only the changes in those files are listed.
1390
Remote and multiple branches can be compared by using the --old and
1391
--new options. If not provided, the default for both is derived from
1392
the first argument, if any, or the current tree if no arguments are
1395
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1396
produces patches suitable for "patch -p1".
1400
2 - unrepresentable changes
1405
Shows the difference in the working tree versus the last commit::
1409
Difference between the working tree and revision 1::
1413
Difference between revision 2 and revision 1::
1417
Difference between revision 2 and revision 1 for branch xxx::
1421
Show just the differences for file NEWS::
1425
Show the differences in working tree xxx for file NEWS::
1429
Show the differences from branch xxx to this working tree:
1433
Show the differences between two branches for file NEWS::
1435
bzr diff --old xxx --new yyy NEWS
1437
Same as 'bzr diff' but prefix paths with old/ and new/::
1439
bzr diff --prefix old/:new/
1441
_see_also = ['status']
1442
takes_args = ['file*']
1444
Option('diff-options', type=str,
1445
help='Pass these options to the external diff program.'),
1446
Option('prefix', type=str,
1448
help='Set prefixes added to old and new filenames, as '
1449
'two values separated by a colon. (eg "old/:new/").'),
1451
help='Branch/tree to compare from.',
1455
help='Branch/tree to compare to.',
1461
help='Use this command to compare files.',
1465
aliases = ['di', 'dif']
1466
encoding_type = 'exact'
1469
def run(self, revision=None, file_list=None, diff_options=None,
1470
prefix=None, old=None, new=None, using=None):
1471
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1473
if (prefix is None) or (prefix == '0'):
1481
old_label, new_label = prefix.split(":")
1483
raise errors.BzrCommandError(
1484
'--prefix expects two values separated by a colon'
1485
' (eg "old/:new/")')
1487
if revision and len(revision) > 2:
1488
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1489
' one or two revision specifiers')
1491
old_tree, new_tree, specific_files, extra_trees = \
1492
_get_trees_to_diff(file_list, revision, old, new)
1493
return show_diff_trees(old_tree, new_tree, sys.stdout,
1494
specific_files=specific_files,
1495
external_diff_options=diff_options,
1496
old_label=old_label, new_label=new_label,
1497
extra_trees=extra_trees, using=using)
1500
class cmd_deleted(Command):
1501
"""List files deleted in the working tree.
1503
# TODO: Show files deleted since a previous revision, or
1504
# between two revisions.
1505
# TODO: Much more efficient way to do this: read in new
1506
# directories with readdir, rather than stating each one. Same
1507
# level of effort but possibly much less IO. (Or possibly not,
1508
# if the directories are very large...)
1509
_see_also = ['status', 'ls']
1510
takes_options = ['show-ids']
1513
def run(self, show_ids=False):
1514
tree = WorkingTree.open_containing(u'.')[0]
1517
old = tree.basis_tree()
1520
for path, ie in old.inventory.iter_entries():
1521
if not tree.has_id(ie.file_id):
1522
self.outf.write(path)
1524
self.outf.write(' ')
1525
self.outf.write(ie.file_id)
1526
self.outf.write('\n')
1533
class cmd_modified(Command):
1534
"""List files modified in working tree.
1538
_see_also = ['status', 'ls']
1541
help='Write an ascii NUL (\\0) separator '
1542
'between files rather than a newline.')
1546
def run(self, null=False):
1547
tree = WorkingTree.open_containing(u'.')[0]
1548
td = tree.changes_from(tree.basis_tree())
1549
for path, id, kind, text_modified, meta_modified in td.modified:
1551
self.outf.write(path + '\0')
1553
self.outf.write(osutils.quotefn(path) + '\n')
1556
class cmd_added(Command):
1557
"""List files added in working tree.
1561
_see_also = ['status', 'ls']
1564
help='Write an ascii NUL (\\0) separator '
1565
'between files rather than a newline.')
1569
def run(self, null=False):
1570
wt = WorkingTree.open_containing(u'.')[0]
1573
basis = wt.basis_tree()
1576
basis_inv = basis.inventory
1579
if file_id in basis_inv:
1581
if inv.is_root(file_id) and len(basis_inv) == 0:
1583
path = inv.id2path(file_id)
1584
if not os.access(osutils.abspath(path), os.F_OK):
1587
self.outf.write(path + '\0')
1589
self.outf.write(osutils.quotefn(path) + '\n')
1596
class cmd_root(Command):
1597
"""Show the tree root directory.
1599
The root is the nearest enclosing directory with a .bzr control
1602
takes_args = ['filename?']
1604
def run(self, filename=None):
1605
"""Print the branch root."""
1606
tree = WorkingTree.open_containing(filename)[0]
1607
self.outf.write(tree.basedir + '\n')
1610
def _parse_limit(limitstring):
1612
return int(limitstring)
1614
msg = "The limit argument must be an integer."
1615
raise errors.BzrCommandError(msg)
1618
class cmd_log(Command):
1619
"""Show log of a branch, file, or directory.
1621
By default show the log of the branch containing the working directory.
1623
To request a range of logs, you can use the command -r begin..end
1624
-r revision requests a specific revision, -r ..end or -r begin.. are
1628
Log the current branch::
1636
Log the last 10 revisions of a branch::
1638
bzr log -r -10.. http://server/branch
1641
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1643
takes_args = ['location?']
1646
help='Show from oldest to newest.'),
1649
help='Display timezone as local, original, or utc.'),
1650
custom_help('verbose',
1651
help='Show files changed in each revision.'),
1657
help='Show revisions whose message matches this '
1658
'regular expression.',
1662
help='Limit the output to the first N revisions.',
1666
encoding_type = 'replace'
1669
def run(self, location=None, timezone='original',
1677
from bzrlib.log import show_log
1678
direction = (forward and 'forward') or 'reverse'
1683
# find the file id to log:
1685
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1689
tree = b.basis_tree()
1690
file_id = tree.path2id(fp)
1692
raise errors.BzrCommandError(
1693
"Path does not have any revision history: %s" %
1697
# FIXME ? log the current subdir only RBC 20060203
1698
if revision is not None \
1699
and len(revision) > 0 and revision[0].get_branch():
1700
location = revision[0].get_branch()
1703
dir, relpath = bzrdir.BzrDir.open_containing(location)
1704
b = dir.open_branch()
1708
if revision is None:
1711
elif len(revision) == 1:
1712
rev1 = rev2 = revision[0].in_history(b)
1713
elif len(revision) == 2:
1714
if revision[1].get_branch() != revision[0].get_branch():
1715
# b is taken from revision[0].get_branch(), and
1716
# show_log will use its revision_history. Having
1717
# different branches will lead to weird behaviors.
1718
raise errors.BzrCommandError(
1719
"Log doesn't accept two revisions in different"
1721
rev1 = revision[0].in_history(b)
1722
rev2 = revision[1].in_history(b)
1724
raise errors.BzrCommandError(
1725
'bzr log --revision takes one or two values.')
1727
if log_format is None:
1728
log_format = log.log_formatter_registry.get_default(b)
1730
lf = log_format(show_ids=show_ids, to_file=self.outf,
1731
show_timezone=timezone)
1737
direction=direction,
1738
start_revision=rev1,
1746
def get_log_format(long=False, short=False, line=False, default='long'):
1747
log_format = default
1751
log_format = 'short'
1757
class cmd_touching_revisions(Command):
1758
"""Return revision-ids which affected a particular file.
1760
A more user-friendly interface is "bzr log FILE".
1764
takes_args = ["filename"]
1767
def run(self, filename):
1768
tree, relpath = WorkingTree.open_containing(filename)
1770
file_id = tree.path2id(relpath)
1771
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1772
self.outf.write("%6d %s\n" % (revno, what))
1775
class cmd_ls(Command):
1776
"""List files in a tree.
1779
_see_also = ['status', 'cat']
1780
takes_args = ['path?']
1781
# TODO: Take a revision or remote path and list that tree instead.
1785
Option('non-recursive',
1786
help='Don\'t recurse into subdirectories.'),
1788
help='Print paths relative to the root of the branch.'),
1789
Option('unknown', help='Print unknown files.'),
1790
Option('versioned', help='Print versioned files.',
1792
Option('ignored', help='Print ignored files.'),
1794
help='Write an ascii NUL (\\0) separator '
1795
'between files rather than a newline.'),
1797
help='List entries of a particular kind: file, directory, symlink.',
1802
def run(self, revision=None, verbose=False,
1803
non_recursive=False, from_root=False,
1804
unknown=False, versioned=False, ignored=False,
1805
null=False, kind=None, show_ids=False, path=None):
1807
if kind and kind not in ('file', 'directory', 'symlink'):
1808
raise errors.BzrCommandError('invalid kind specified')
1810
if verbose and null:
1811
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1812
all = not (unknown or versioned or ignored)
1814
selection = {'I':ignored, '?':unknown, 'V':versioned}
1821
raise errors.BzrCommandError('cannot specify both --from-root'
1825
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1831
if revision is not None:
1832
tree = branch.repository.revision_tree(
1833
revision[0].as_revision_id(branch))
1835
tree = branch.basis_tree()
1839
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1840
if fp.startswith(relpath):
1841
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1842
if non_recursive and '/' in fp:
1844
if not all and not selection[fc]:
1846
if kind is not None and fkind != kind:
1849
kindch = entry.kind_character()
1850
outstring = '%-8s %s%s' % (fc, fp, kindch)
1851
if show_ids and fid is not None:
1852
outstring = "%-50s %s" % (outstring, fid)
1853
self.outf.write(outstring + '\n')
1855
self.outf.write(fp + '\0')
1858
self.outf.write(fid)
1859
self.outf.write('\0')
1867
self.outf.write('%-50s %s\n' % (fp, my_id))
1869
self.outf.write(fp + '\n')
1874
class cmd_unknowns(Command):
1875
"""List unknown files.
1883
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1884
self.outf.write(osutils.quotefn(f) + '\n')
1887
class cmd_ignore(Command):
1888
"""Ignore specified files or patterns.
1890
See ``bzr help patterns`` for details on the syntax of patterns.
1892
To remove patterns from the ignore list, edit the .bzrignore file.
1893
After adding, editing or deleting that file either indirectly by
1894
using this command or directly by using an editor, be sure to commit
1897
Note: ignore patterns containing shell wildcards must be quoted from
1901
Ignore the top level Makefile::
1903
bzr ignore ./Makefile
1905
Ignore class files in all directories::
1907
bzr ignore "*.class"
1909
Ignore .o files under the lib directory::
1911
bzr ignore "lib/**/*.o"
1913
Ignore .o files under the lib directory::
1915
bzr ignore "RE:lib/.*\.o"
1917
Ignore everything but the "debian" toplevel directory::
1919
bzr ignore "RE:(?!debian/).*"
1922
_see_also = ['status', 'ignored', 'patterns']
1923
takes_args = ['name_pattern*']
1925
Option('old-default-rules',
1926
help='Write out the ignore rules bzr < 0.9 always used.')
1929
def run(self, name_pattern_list=None, old_default_rules=None):
1930
from bzrlib import ignores
1931
if old_default_rules is not None:
1932
# dump the rules and exit
1933
for pattern in ignores.OLD_DEFAULTS:
1936
if not name_pattern_list:
1937
raise errors.BzrCommandError("ignore requires at least one "
1938
"NAME_PATTERN or --old-default-rules")
1939
name_pattern_list = [globbing.normalize_pattern(p)
1940
for p in name_pattern_list]
1941
for name_pattern in name_pattern_list:
1942
if (name_pattern[0] == '/' or
1943
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1944
raise errors.BzrCommandError(
1945
"NAME_PATTERN should not be an absolute path")
1946
tree, relpath = WorkingTree.open_containing(u'.')
1947
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
1948
ignored = globbing.Globster(name_pattern_list)
1951
for entry in tree.list_files():
1955
if ignored.match(filename):
1956
matches.append(filename.encode('utf-8'))
1958
if len(matches) > 0:
1959
print "Warning: the following files are version controlled and" \
1960
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1963
class cmd_ignored(Command):
1964
"""List ignored files and the patterns that matched them.
1966
List all the ignored files and the ignore pattern that caused the file to
1969
Alternatively, to list just the files::
1974
encoding_type = 'replace'
1975
_see_also = ['ignore', 'ls']
1979
tree = WorkingTree.open_containing(u'.')[0]
1982
for path, file_class, kind, file_id, entry in tree.list_files():
1983
if file_class != 'I':
1985
## XXX: Slightly inefficient since this was already calculated
1986
pat = tree.is_ignored(path)
1987
self.outf.write('%-50s %s\n' % (path, pat))
1992
class cmd_lookup_revision(Command):
1993
"""Lookup the revision-id from a revision-number
1996
bzr lookup-revision 33
1999
takes_args = ['revno']
2002
def run(self, revno):
2006
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2008
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2011
class cmd_export(Command):
2012
"""Export current or past revision to a destination directory or archive.
2014
If no revision is specified this exports the last committed revision.
2016
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2017
given, try to find the format with the extension. If no extension
2018
is found exports to a directory (equivalent to --format=dir).
2020
If root is supplied, it will be used as the root directory inside
2021
container formats (tar, zip, etc). If it is not supplied it will default
2022
to the exported filename. The root option has no effect for 'dir' format.
2024
If branch is omitted then the branch containing the current working
2025
directory will be used.
2027
Note: Export of tree with non-ASCII filenames to zip is not supported.
2029
================= =========================
2030
Supported formats Autodetected by extension
2031
================= =========================
2034
tbz2 .tar.bz2, .tbz2
2037
================= =========================
2039
takes_args = ['dest', 'branch_or_subdir?']
2042
help="Type of file to export to.",
2047
help="Name of the root directory inside the exported file."),
2049
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2051
from bzrlib.export import export
2053
if branch_or_subdir is None:
2054
tree = WorkingTree.open_containing(u'.')[0]
2058
b, subdir = Branch.open_containing(branch_or_subdir)
2060
if revision is None:
2061
# should be tree.last_revision FIXME
2062
rev_id = b.last_revision()
2064
if len(revision) != 1:
2065
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2066
rev_id = revision[0].as_revision_id(b)
2067
t = b.repository.revision_tree(rev_id)
2069
export(t, dest, format, root, subdir)
2070
except errors.NoSuchExportFormat, e:
2071
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2074
class cmd_cat(Command):
2075
"""Write the contents of a file as of a given revision to standard output.
2077
If no revision is nominated, the last revision is used.
2079
Note: Take care to redirect standard output when using this command on a
2085
Option('name-from-revision', help='The path name in the old tree.'),
2088
takes_args = ['filename']
2089
encoding_type = 'exact'
2092
def run(self, filename, revision=None, name_from_revision=False):
2093
if revision is not None and len(revision) != 1:
2094
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2095
" one revision specifier")
2096
tree, branch, relpath = \
2097
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2100
return self._run(tree, branch, relpath, filename, revision,
2105
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2107
tree = b.basis_tree()
2108
if revision is None:
2109
revision_id = b.last_revision()
2111
revision_id = revision[0].as_revision_id(b)
2113
cur_file_id = tree.path2id(relpath)
2114
rev_tree = b.repository.revision_tree(revision_id)
2115
old_file_id = rev_tree.path2id(relpath)
2117
if name_from_revision:
2118
if old_file_id is None:
2119
raise errors.BzrCommandError("%r is not present in revision %s"
2120
% (filename, revision_id))
2122
content = rev_tree.get_file_text(old_file_id)
2123
elif cur_file_id is not None:
2124
content = rev_tree.get_file_text(cur_file_id)
2125
elif old_file_id is not None:
2126
content = rev_tree.get_file_text(old_file_id)
2128
raise errors.BzrCommandError("%r is not present in revision %s" %
2129
(filename, revision_id))
2130
self.outf.write(content)
2133
class cmd_local_time_offset(Command):
2134
"""Show the offset in seconds from GMT to local time."""
2138
print osutils.local_time_offset()
2142
class cmd_commit(Command):
2143
"""Commit changes into a new revision.
2145
If no arguments are given, the entire tree is committed.
2147
If selected files are specified, only changes to those files are
2148
committed. If a directory is specified then the directory and everything
2149
within it is committed.
2151
When excludes are given, they take precedence over selected files.
2152
For example, too commit only changes within foo, but not changes within
2155
bzr commit foo -x foo/bar
2157
If author of the change is not the same person as the committer, you can
2158
specify the author's name using the --author option. The name should be
2159
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2161
A selected-file commit may fail in some cases where the committed
2162
tree would be invalid. Consider::
2167
bzr commit foo -m "committing foo"
2168
bzr mv foo/bar foo/baz
2171
bzr commit foo/bar -m "committing bar but not baz"
2173
In the example above, the last commit will fail by design. This gives
2174
the user the opportunity to decide whether they want to commit the
2175
rename at the same time, separately first, or not at all. (As a general
2176
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2178
Note: A selected-file commit after a merge is not yet supported.
2180
# TODO: Run hooks on tree to-be-committed, and after commit.
2182
# TODO: Strict commit that fails if there are deleted files.
2183
# (what does "deleted files" mean ??)
2185
# TODO: Give better message for -s, --summary, used by tla people
2187
# XXX: verbose currently does nothing
2189
_see_also = ['bugs', 'uncommit']
2190
takes_args = ['selected*']
2192
ListOption('exclude', type=str, short_name='x',
2193
help="Do not consider changes made to a given path."),
2194
Option('message', type=unicode,
2196
help="Description of the new revision."),
2199
help='Commit even if nothing has changed.'),
2200
Option('file', type=str,
2203
help='Take commit message from this file.'),
2205
help="Refuse to commit if there are unknown "
2206
"files in the working tree."),
2207
ListOption('fixes', type=str,
2208
help="Mark a bug as being fixed by this revision."),
2209
Option('author', type=unicode,
2210
help="Set the author's name, if it's different "
2211
"from the committer."),
2213
help="Perform a local commit in a bound "
2214
"branch. Local commits are not pushed to "
2215
"the master branch until a normal commit "
2219
help='When no message is supplied, show the diff along'
2220
' with the status summary in the message editor.'),
2222
aliases = ['ci', 'checkin']
2224
def _get_bug_fix_properties(self, fixes, branch):
2226
# Configure the properties for bug fixing attributes.
2227
for fixed_bug in fixes:
2228
tokens = fixed_bug.split(':')
2229
if len(tokens) != 2:
2230
raise errors.BzrCommandError(
2231
"Invalid bug %s. Must be in the form of 'tag:id'. "
2232
"Commit refused." % fixed_bug)
2233
tag, bug_id = tokens
2235
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2236
except errors.UnknownBugTrackerAbbreviation:
2237
raise errors.BzrCommandError(
2238
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2239
except errors.MalformedBugIdentifier:
2240
raise errors.BzrCommandError(
2241
"Invalid bug identifier for %s. Commit refused."
2243
properties.append('%s fixed' % bug_url)
2244
return '\n'.join(properties)
2246
def run(self, message=None, file=None, verbose=False, selected_list=None,
2247
unchanged=False, strict=False, local=False, fixes=None,
2248
author=None, show_diff=False, exclude=None):
2249
from bzrlib.errors import (
2254
from bzrlib.msgeditor import (
2255
edit_commit_message_encoded,
2256
make_commit_message_template_encoded
2259
# TODO: Need a blackbox test for invoking the external editor; may be
2260
# slightly problematic to run this cross-platform.
2262
# TODO: do more checks that the commit will succeed before
2263
# spending the user's valuable time typing a commit message.
2267
tree, selected_list = tree_files(selected_list)
2268
if selected_list == ['']:
2269
# workaround - commit of root of tree should be exactly the same
2270
# as just default commit in that tree, and succeed even though
2271
# selected-file merge commit is not done yet
2276
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2278
properties['bugs'] = bug_property
2280
if local and not tree.branch.get_bound_location():
2281
raise errors.LocalRequiresBoundBranch()
2283
def get_message(commit_obj):
2284
"""Callback to get commit message"""
2285
my_message = message
2286
if my_message is None and not file:
2287
t = make_commit_message_template_encoded(tree,
2288
selected_list, diff=show_diff,
2289
output_encoding=bzrlib.user_encoding)
2290
my_message = edit_commit_message_encoded(t)
2291
if my_message is None:
2292
raise errors.BzrCommandError("please specify a commit"
2293
" message with either --message or --file")
2294
elif my_message and file:
2295
raise errors.BzrCommandError(
2296
"please specify either --message or --file")
2298
my_message = codecs.open(file, 'rt',
2299
bzrlib.user_encoding).read()
2300
if my_message == "":
2301
raise errors.BzrCommandError("empty commit message specified")
2305
tree.commit(message_callback=get_message,
2306
specific_files=selected_list,
2307
allow_pointless=unchanged, strict=strict, local=local,
2308
reporter=None, verbose=verbose, revprops=properties,
2310
exclude=safe_relpath_files(tree, exclude))
2311
except PointlessCommit:
2312
# FIXME: This should really happen before the file is read in;
2313
# perhaps prepare the commit; get the message; then actually commit
2314
raise errors.BzrCommandError("no changes to commit."
2315
" use --unchanged to commit anyhow")
2316
except ConflictsInTree:
2317
raise errors.BzrCommandError('Conflicts detected in working '
2318
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2320
except StrictCommitFailed:
2321
raise errors.BzrCommandError("Commit refused because there are"
2322
" unknown files in the working tree.")
2323
except errors.BoundBranchOutOfDate, e:
2324
raise errors.BzrCommandError(str(e) + "\n"
2325
'To commit to master branch, run update and then commit.\n'
2326
'You can also pass --local to commit to continue working '
2330
class cmd_check(Command):
2331
"""Validate working tree structure, branch consistency and repository history.
2333
This command checks various invariants about branch and repository storage
2334
to detect data corruption or bzr bugs.
2336
The working tree and branch checks will only give output if a problem is
2337
detected. The output fields of the repository check are:
2339
revisions: This is just the number of revisions checked. It doesn't
2341
versionedfiles: This is just the number of versionedfiles checked. It
2342
doesn't indicate a problem.
2343
unreferenced ancestors: Texts that are ancestors of other texts, but
2344
are not properly referenced by the revision ancestry. This is a
2345
subtle problem that Bazaar can work around.
2346
unique file texts: This is the total number of unique file contents
2347
seen in the checked revisions. It does not indicate a problem.
2348
repeated file texts: This is the total number of repeated texts seen
2349
in the checked revisions. Texts can be repeated when their file
2350
entries are modified, but the file contents are not. It does not
2353
If no restrictions are specified, all Bazaar data that is found at the given
2354
location will be checked.
2358
Check the tree and branch at 'foo'::
2360
bzr check --tree --branch foo
2362
Check only the repository at 'bar'::
2364
bzr check --repo bar
2366
Check everything at 'baz'::
2371
_see_also = ['reconcile']
2372
takes_args = ['path?']
2373
takes_options = ['verbose',
2374
Option('branch', help="Check the branch related to the"
2375
" current directory."),
2376
Option('repo', help="Check the repository related to the"
2377
" current directory."),
2378
Option('tree', help="Check the working tree related to"
2379
" the current directory.")]
2381
def run(self, path=None, verbose=False, branch=False, repo=False,
2383
from bzrlib.check import check_dwim
2386
if not branch and not repo and not tree:
2387
branch = repo = tree = True
2388
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2391
class cmd_upgrade(Command):
2392
"""Upgrade branch storage to current format.
2394
The check command or bzr developers may sometimes advise you to run
2395
this command. When the default format has changed you may also be warned
2396
during other operations to upgrade.
2399
_see_also = ['check']
2400
takes_args = ['url?']
2402
RegistryOption('format',
2403
help='Upgrade to a specific format. See "bzr help'
2404
' formats" for details.',
2405
registry=bzrdir.format_registry,
2406
converter=bzrdir.format_registry.make_bzrdir,
2407
value_switches=True, title='Branch format'),
2410
def run(self, url='.', format=None):
2411
from bzrlib.upgrade import upgrade
2413
format = bzrdir.format_registry.make_bzrdir('default')
2414
upgrade(url, format)
2417
class cmd_whoami(Command):
2418
"""Show or set bzr user id.
2421
Show the email of the current user::
2425
Set the current user::
2427
bzr whoami "Frank Chu <fchu@example.com>"
2429
takes_options = [ Option('email',
2430
help='Display email address only.'),
2432
help='Set identity for the current branch instead of '
2435
takes_args = ['name?']
2436
encoding_type = 'replace'
2439
def run(self, email=False, branch=False, name=None):
2441
# use branch if we're inside one; otherwise global config
2443
c = Branch.open_containing('.')[0].get_config()
2444
except errors.NotBranchError:
2445
c = config.GlobalConfig()
2447
self.outf.write(c.user_email() + '\n')
2449
self.outf.write(c.username() + '\n')
2452
# display a warning if an email address isn't included in the given name.
2454
config.extract_email_address(name)
2455
except errors.NoEmailInUsername, e:
2456
warning('"%s" does not seem to contain an email address. '
2457
'This is allowed, but not recommended.', name)
2459
# use global config unless --branch given
2461
c = Branch.open_containing('.')[0].get_config()
2463
c = config.GlobalConfig()
2464
c.set_user_option('email', name)
2467
class cmd_nick(Command):
2468
"""Print or set the branch nickname.
2470
If unset, the tree root directory name is used as the nickname
2471
To print the current nickname, execute with no argument.
2474
_see_also = ['info']
2475
takes_args = ['nickname?']
2476
def run(self, nickname=None):
2477
branch = Branch.open_containing(u'.')[0]
2478
if nickname is None:
2479
self.printme(branch)
2481
branch.nick = nickname
2484
def printme(self, branch):
2488
class cmd_alias(Command):
2489
"""Set/unset and display aliases.
2492
Show the current aliases::
2496
Show the alias specified for 'll'::
2500
Set an alias for 'll'::
2502
bzr alias ll="log --line -r-10..-1"
2504
To remove an alias for 'll'::
2506
bzr alias --remove ll
2509
takes_args = ['name?']
2511
Option('remove', help='Remove the alias.'),
2514
def run(self, name=None, remove=False):
2516
self.remove_alias(name)
2518
self.print_aliases()
2520
equal_pos = name.find('=')
2522
self.print_alias(name)
2524
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2526
def remove_alias(self, alias_name):
2527
if alias_name is None:
2528
raise errors.BzrCommandError(
2529
'bzr alias --remove expects an alias to remove.')
2530
# If alias is not found, print something like:
2531
# unalias: foo: not found
2532
c = config.GlobalConfig()
2533
c.unset_alias(alias_name)
2536
def print_aliases(self):
2537
"""Print out the defined aliases in a similar format to bash."""
2538
aliases = config.GlobalConfig().get_aliases()
2539
for key, value in sorted(aliases.iteritems()):
2540
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2543
def print_alias(self, alias_name):
2544
from bzrlib.commands import get_alias
2545
alias = get_alias(alias_name)
2547
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2550
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2552
def set_alias(self, alias_name, alias_command):
2553
"""Save the alias in the global config."""
2554
c = config.GlobalConfig()
2555
c.set_alias(alias_name, alias_command)
2558
class cmd_selftest(Command):
2559
"""Run internal test suite.
2561
If arguments are given, they are regular expressions that say which tests
2562
should run. Tests matching any expression are run, and other tests are
2565
Alternatively if --first is given, matching tests are run first and then
2566
all other tests are run. This is useful if you have been working in a
2567
particular area, but want to make sure nothing else was broken.
2569
If --exclude is given, tests that match that regular expression are
2570
excluded, regardless of whether they match --first or not.
2572
To help catch accidential dependencies between tests, the --randomize
2573
option is useful. In most cases, the argument used is the word 'now'.
2574
Note that the seed used for the random number generator is displayed
2575
when this option is used. The seed can be explicitly passed as the
2576
argument to this option if required. This enables reproduction of the
2577
actual ordering used if and when an order sensitive problem is encountered.
2579
If --list-only is given, the tests that would be run are listed. This is
2580
useful when combined with --first, --exclude and/or --randomize to
2581
understand their impact. The test harness reports "Listed nn tests in ..."
2582
instead of "Ran nn tests in ..." when list mode is enabled.
2584
If the global option '--no-plugins' is given, plugins are not loaded
2585
before running the selftests. This has two effects: features provided or
2586
modified by plugins will not be tested, and tests provided by plugins will
2589
Tests that need working space on disk use a common temporary directory,
2590
typically inside $TMPDIR or /tmp.
2593
Run only tests relating to 'ignore'::
2597
Disable plugins and list tests as they're run::
2599
bzr --no-plugins selftest -v
2601
# NB: this is used from the class without creating an instance, which is
2602
# why it does not have a self parameter.
2603
def get_transport_type(typestring):
2604
"""Parse and return a transport specifier."""
2605
if typestring == "sftp":
2606
from bzrlib.transport.sftp import SFTPAbsoluteServer
2607
return SFTPAbsoluteServer
2608
if typestring == "memory":
2609
from bzrlib.transport.memory import MemoryServer
2611
if typestring == "fakenfs":
2612
from bzrlib.transport.fakenfs import FakeNFSServer
2613
return FakeNFSServer
2614
msg = "No known transport type %s. Supported types are: sftp\n" %\
2616
raise errors.BzrCommandError(msg)
2619
takes_args = ['testspecs*']
2620
takes_options = ['verbose',
2622
help='Stop when one test fails.',
2626
help='Use a different transport by default '
2627
'throughout the test suite.',
2628
type=get_transport_type),
2630
help='Run the benchmarks rather than selftests.'),
2631
Option('lsprof-timed',
2632
help='Generate lsprof output for benchmarked'
2633
' sections of code.'),
2634
Option('cache-dir', type=str,
2635
help='Cache intermediate benchmark output in this '
2638
help='Run all tests, but run specified tests first.',
2642
help='List the tests instead of running them.'),
2643
Option('randomize', type=str, argname="SEED",
2644
help='Randomize the order of tests using the given'
2645
' seed or "now" for the current time.'),
2646
Option('exclude', type=str, argname="PATTERN",
2648
help='Exclude tests that match this regular'
2650
Option('strict', help='Fail on missing dependencies or '
2652
Option('load-list', type=str, argname='TESTLISTFILE',
2653
help='Load a test id list from a text file.'),
2654
ListOption('debugflag', type=str, short_name='E',
2655
help='Turn on a selftest debug flag.'),
2656
Option('starting-with', type=str, argname='TESTID',
2658
help='Load only the tests starting with TESTID.'),
2660
encoding_type = 'replace'
2662
def run(self, testspecs_list=None, verbose=False, one=False,
2663
transport=None, benchmark=None,
2664
lsprof_timed=None, cache_dir=None,
2665
first=False, list_only=False,
2666
randomize=None, exclude=None, strict=False,
2667
load_list=None, debugflag=None, starting_with=None):
2669
from bzrlib.tests import selftest
2670
import bzrlib.benchmarks as benchmarks
2671
from bzrlib.benchmarks import tree_creator
2673
# Make deprecation warnings visible, unless -Werror is set
2674
symbol_versioning.activate_deprecation_warnings(override=False)
2676
if cache_dir is not None:
2677
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2679
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2680
print ' %s (%s python%s)' % (
2682
bzrlib.version_string,
2683
bzrlib._format_version_tuple(sys.version_info),
2686
if testspecs_list is not None:
2687
pattern = '|'.join(testspecs_list)
2691
test_suite_factory = benchmarks.test_suite
2692
# Unless user explicitly asks for quiet, be verbose in benchmarks
2693
verbose = not is_quiet()
2694
# TODO: should possibly lock the history file...
2695
benchfile = open(".perf_history", "at", buffering=1)
2697
test_suite_factory = None
2700
result = selftest(verbose=verbose,
2702
stop_on_failure=one,
2703
transport=transport,
2704
test_suite_factory=test_suite_factory,
2705
lsprof_timed=lsprof_timed,
2706
bench_history=benchfile,
2707
matching_tests_first=first,
2708
list_only=list_only,
2709
random_seed=randomize,
2710
exclude_pattern=exclude,
2712
load_list=load_list,
2713
debug_flags=debugflag,
2714
starting_with=starting_with,
2717
if benchfile is not None:
2720
note('tests passed')
2722
note('tests failed')
2723
return int(not result)
2726
class cmd_version(Command):
2727
"""Show version of bzr."""
2729
encoding_type = 'replace'
2731
Option("short", help="Print just the version number."),
2735
def run(self, short=False):
2736
from bzrlib.version import show_version
2738
self.outf.write(bzrlib.version_string + '\n')
2740
show_version(to_file=self.outf)
2743
class cmd_rocks(Command):
2744
"""Statement of optimism."""
2750
print "It sure does!"
2753
class cmd_find_merge_base(Command):
2754
"""Find and print a base revision for merging two branches."""
2755
# TODO: Options to specify revisions on either side, as if
2756
# merging only part of the history.
2757
takes_args = ['branch', 'other']
2761
def run(self, branch, other):
2762
from bzrlib.revision import ensure_null
2764
branch1 = Branch.open_containing(branch)[0]
2765
branch2 = Branch.open_containing(other)[0]
2770
last1 = ensure_null(branch1.last_revision())
2771
last2 = ensure_null(branch2.last_revision())
2773
graph = branch1.repository.get_graph(branch2.repository)
2774
base_rev_id = graph.find_unique_lca(last1, last2)
2776
print 'merge base is revision %s' % base_rev_id
2783
class cmd_merge(Command):
2784
"""Perform a three-way merge.
2786
The source of the merge can be specified either in the form of a branch,
2787
or in the form of a path to a file containing a merge directive generated
2788
with bzr send. If neither is specified, the default is the upstream branch
2789
or the branch most recently merged using --remember.
2791
When merging a branch, by default the tip will be merged. To pick a different
2792
revision, pass --revision. If you specify two values, the first will be used as
2793
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2794
available revisions, like this is commonly referred to as "cherrypicking".
2796
Revision numbers are always relative to the branch being merged.
2798
By default, bzr will try to merge in all new work from the other
2799
branch, automatically determining an appropriate base. If this
2800
fails, you may need to give an explicit base.
2802
Merge will do its best to combine the changes in two branches, but there
2803
are some kinds of problems only a human can fix. When it encounters those,
2804
it will mark a conflict. A conflict means that you need to fix something,
2805
before you should commit.
2807
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2809
If there is no default branch set, the first merge will set it. After
2810
that, you can omit the branch to use the default. To change the
2811
default, use --remember. The value will only be saved if the remote
2812
location can be accessed.
2814
The results of the merge are placed into the destination working
2815
directory, where they can be reviewed (with bzr diff), tested, and then
2816
committed to record the result of the merge.
2818
merge refuses to run if there are any uncommitted changes, unless
2822
To merge the latest revision from bzr.dev::
2824
bzr merge ../bzr.dev
2826
To merge changes up to and including revision 82 from bzr.dev::
2828
bzr merge -r 82 ../bzr.dev
2830
To merge the changes introduced by 82, without previous changes::
2832
bzr merge -r 81..82 ../bzr.dev
2834
To apply a merge directive contained in in /tmp/merge:
2836
bzr merge /tmp/merge
2839
encoding_type = 'exact'
2840
_see_also = ['update', 'remerge', 'status-flags']
2841
takes_args = ['location?']
2846
help='Merge even if the destination tree has uncommitted changes.'),
2850
Option('show-base', help="Show base revision text in "
2852
Option('uncommitted', help='Apply uncommitted changes'
2853
' from a working copy, instead of branch changes.'),
2854
Option('pull', help='If the destination is already'
2855
' completely merged into the source, pull from the'
2856
' source rather than merging. When this happens,'
2857
' you do not need to commit the result.'),
2859
help='Branch to merge into, '
2860
'rather than the one containing the working directory.',
2864
Option('preview', help='Instead of merging, show a diff of the merge.')
2867
def run(self, location=None, revision=None, force=False,
2868
merge_type=None, show_base=False, reprocess=False, remember=False,
2869
uncommitted=False, pull=False,
2873
if merge_type is None:
2874
merge_type = _mod_merge.Merge3Merger
2876
if directory is None: directory = u'.'
2877
possible_transports = []
2879
allow_pending = True
2880
verified = 'inapplicable'
2881
tree = WorkingTree.open_containing(directory)[0]
2882
change_reporter = delta._ChangeReporter(
2883
unversioned_filter=tree.is_ignored)
2886
pb = ui.ui_factory.nested_progress_bar()
2887
cleanups.append(pb.finished)
2889
cleanups.append(tree.unlock)
2890
if location is not None:
2892
mergeable = bundle.read_mergeable_from_url(location,
2893
possible_transports=possible_transports)
2894
except errors.NotABundle:
2898
raise errors.BzrCommandError('Cannot use --uncommitted'
2899
' with bundles or merge directives.')
2901
if revision is not None:
2902
raise errors.BzrCommandError(
2903
'Cannot use -r with merge directives or bundles')
2904
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2907
if merger is None and uncommitted:
2908
if revision is not None and len(revision) > 0:
2909
raise errors.BzrCommandError('Cannot use --uncommitted and'
2910
' --revision at the same time.')
2911
location = self._select_branch_location(tree, location)[0]
2912
other_tree, other_path = WorkingTree.open_containing(location)
2913
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2915
allow_pending = False
2916
if other_path != '':
2917
merger.interesting_files = [other_path]
2920
merger, allow_pending = self._get_merger_from_branch(tree,
2921
location, revision, remember, possible_transports, pb)
2923
merger.merge_type = merge_type
2924
merger.reprocess = reprocess
2925
merger.show_base = show_base
2926
self.sanity_check_merger(merger)
2927
if (merger.base_rev_id == merger.other_rev_id and
2928
merger.other_rev_id is not None):
2929
note('Nothing to do.')
2932
if merger.interesting_files is not None:
2933
raise errors.BzrCommandError('Cannot pull individual files')
2934
if (merger.base_rev_id == tree.last_revision()):
2935
result = tree.pull(merger.other_branch, False,
2936
merger.other_rev_id)
2937
result.report(self.outf)
2939
merger.check_basis(not force)
2941
return self._do_preview(merger)
2943
return self._do_merge(merger, change_reporter, allow_pending,
2946
for cleanup in reversed(cleanups):
2949
def _do_preview(self, merger):
2950
from bzrlib.diff import show_diff_trees
2951
tree_merger = merger.make_merger()
2952
tt = tree_merger.make_preview_transform()
2954
result_tree = tt.get_preview_tree()
2955
show_diff_trees(merger.this_tree, result_tree, self.outf,
2956
old_label='', new_label='')
2960
def _do_merge(self, merger, change_reporter, allow_pending, verified):
2961
merger.change_reporter = change_reporter
2962
conflict_count = merger.do_merge()
2964
merger.set_pending()
2965
if verified == 'failed':
2966
warning('Preview patch does not match changes')
2967
if conflict_count != 0:
2972
def sanity_check_merger(self, merger):
2973
if (merger.show_base and
2974
not merger.merge_type is _mod_merge.Merge3Merger):
2975
raise errors.BzrCommandError("Show-base is not supported for this"
2976
" merge type. %s" % merger.merge_type)
2977
if merger.reprocess and not merger.merge_type.supports_reprocess:
2978
raise errors.BzrCommandError("Conflict reduction is not supported"
2979
" for merge type %s." %
2981
if merger.reprocess and merger.show_base:
2982
raise errors.BzrCommandError("Cannot do conflict reduction and"
2985
def _get_merger_from_branch(self, tree, location, revision, remember,
2986
possible_transports, pb):
2987
"""Produce a merger from a location, assuming it refers to a branch."""
2988
from bzrlib.tag import _merge_tags_if_possible
2989
# find the branch locations
2990
other_loc, user_location = self._select_branch_location(tree, location,
2992
if revision is not None and len(revision) == 2:
2993
base_loc, _unused = self._select_branch_location(tree,
2994
location, revision, 0)
2996
base_loc = other_loc
2998
other_branch, other_path = Branch.open_containing(other_loc,
2999
possible_transports)
3000
if base_loc == other_loc:
3001
base_branch = other_branch
3003
base_branch, base_path = Branch.open_containing(base_loc,
3004
possible_transports)
3005
# Find the revision ids
3006
if revision is None or len(revision) < 1 or revision[-1] is None:
3007
other_revision_id = _mod_revision.ensure_null(
3008
other_branch.last_revision())
3010
other_revision_id = revision[-1].as_revision_id(other_branch)
3011
if (revision is not None and len(revision) == 2
3012
and revision[0] is not None):
3013
base_revision_id = revision[0].as_revision_id(base_branch)
3015
base_revision_id = None
3016
# Remember where we merge from
3017
if ((remember or tree.branch.get_submit_branch() is None) and
3018
user_location is not None):
3019
tree.branch.set_submit_branch(other_branch.base)
3020
_merge_tags_if_possible(other_branch, tree.branch)
3021
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3022
other_revision_id, base_revision_id, other_branch, base_branch)
3023
if other_path != '':
3024
allow_pending = False
3025
merger.interesting_files = [other_path]
3027
allow_pending = True
3028
return merger, allow_pending
3030
def _select_branch_location(self, tree, user_location, revision=None,
3032
"""Select a branch location, according to possible inputs.
3034
If provided, branches from ``revision`` are preferred. (Both
3035
``revision`` and ``index`` must be supplied.)
3037
Otherwise, the ``location`` parameter is used. If it is None, then the
3038
``submit`` or ``parent`` location is used, and a note is printed.
3040
:param tree: The working tree to select a branch for merging into
3041
:param location: The location entered by the user
3042
:param revision: The revision parameter to the command
3043
:param index: The index to use for the revision parameter. Negative
3044
indices are permitted.
3045
:return: (selected_location, user_location). The default location
3046
will be the user-entered location.
3048
if (revision is not None and index is not None
3049
and revision[index] is not None):
3050
branch = revision[index].get_branch()
3051
if branch is not None:
3052
return branch, branch
3053
if user_location is None:
3054
location = self._get_remembered(tree, 'Merging from')
3056
location = user_location
3057
return location, user_location
3059
def _get_remembered(self, tree, verb_string):
3060
"""Use tree.branch's parent if none was supplied.
3062
Report if the remembered location was used.
3064
stored_location = tree.branch.get_submit_branch()
3065
if stored_location is None:
3066
stored_location = tree.branch.get_parent()
3067
mutter("%s", stored_location)
3068
if stored_location is None:
3069
raise errors.BzrCommandError("No location specified or remembered")
3070
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3071
note(u"%s remembered location %s", verb_string, display_url)
3072
return stored_location
3075
class cmd_remerge(Command):
3078
Use this if you want to try a different merge technique while resolving
3079
conflicts. Some merge techniques are better than others, and remerge
3080
lets you try different ones on different files.
3082
The options for remerge have the same meaning and defaults as the ones for
3083
merge. The difference is that remerge can (only) be run when there is a
3084
pending merge, and it lets you specify particular files.
3087
Re-do the merge of all conflicted files, and show the base text in
3088
conflict regions, in addition to the usual THIS and OTHER texts::
3090
bzr remerge --show-base
3092
Re-do the merge of "foobar", using the weave merge algorithm, with
3093
additional processing to reduce the size of conflict regions::
3095
bzr remerge --merge-type weave --reprocess foobar
3097
takes_args = ['file*']
3102
help="Show base revision text in conflicts."),
3105
def run(self, file_list=None, merge_type=None, show_base=False,
3107
if merge_type is None:
3108
merge_type = _mod_merge.Merge3Merger
3109
tree, file_list = tree_files(file_list)
3112
parents = tree.get_parent_ids()
3113
if len(parents) != 2:
3114
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3115
" merges. Not cherrypicking or"
3117
repository = tree.branch.repository
3118
interesting_ids = None
3120
conflicts = tree.conflicts()
3121
if file_list is not None:
3122
interesting_ids = set()
3123
for filename in file_list:
3124
file_id = tree.path2id(filename)
3126
raise errors.NotVersionedError(filename)
3127
interesting_ids.add(file_id)
3128
if tree.kind(file_id) != "directory":
3131
for name, ie in tree.inventory.iter_entries(file_id):
3132
interesting_ids.add(ie.file_id)
3133
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3135
# Remerge only supports resolving contents conflicts
3136
allowed_conflicts = ('text conflict', 'contents conflict')
3137
restore_files = [c.path for c in conflicts
3138
if c.typestring in allowed_conflicts]
3139
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3140
tree.set_conflicts(ConflictList(new_conflicts))
3141
if file_list is not None:
3142
restore_files = file_list
3143
for filename in restore_files:
3145
restore(tree.abspath(filename))
3146
except errors.NotConflicted:
3148
# Disable pending merges, because the file texts we are remerging
3149
# have not had those merges performed. If we use the wrong parents
3150
# list, we imply that the working tree text has seen and rejected
3151
# all the changes from the other tree, when in fact those changes
3152
# have not yet been seen.
3153
pb = ui.ui_factory.nested_progress_bar()
3154
tree.set_parent_ids(parents[:1])
3156
merger = _mod_merge.Merger.from_revision_ids(pb,
3158
merger.interesting_ids = interesting_ids
3159
merger.merge_type = merge_type
3160
merger.show_base = show_base
3161
merger.reprocess = reprocess
3162
conflicts = merger.do_merge()
3164
tree.set_parent_ids(parents)
3174
class cmd_revert(Command):
3175
"""Revert files to a previous revision.
3177
Giving a list of files will revert only those files. Otherwise, all files
3178
will be reverted. If the revision is not specified with '--revision', the
3179
last committed revision is used.
3181
To remove only some changes, without reverting to a prior version, use
3182
merge instead. For example, "merge . --revision -2..-3" will remove the
3183
changes introduced by -2, without affecting the changes introduced by -1.
3184
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3186
By default, any files that have been manually changed will be backed up
3187
first. (Files changed only by merge are not backed up.) Backup files have
3188
'.~#~' appended to their name, where # is a number.
3190
When you provide files, you can use their current pathname or the pathname
3191
from the target revision. So you can use revert to "undelete" a file by
3192
name. If you name a directory, all the contents of that directory will be
3195
Any files that have been newly added since that revision will be deleted,
3196
with a backup kept if appropriate. Directories containing unknown files
3197
will not be deleted.
3199
The working tree contains a list of pending merged revisions, which will
3200
be included as parents in the next commit. Normally, revert clears that
3201
list as well as reverting the files. If any files are specified, revert
3202
leaves the pending merge list alone and reverts only the files. Use "bzr
3203
revert ." in the tree root to revert all files but keep the merge record,
3204
and "bzr revert --forget-merges" to clear the pending merge list without
3205
reverting any files.
3208
_see_also = ['cat', 'export']
3211
Option('no-backup', "Do not save backups of reverted files."),
3212
Option('forget-merges',
3213
'Remove pending merge marker, without changing any files.'),
3215
takes_args = ['file*']
3217
def run(self, revision=None, no_backup=False, file_list=None,
3218
forget_merges=None):
3219
tree, file_list = tree_files(file_list)
3221
tree.set_parent_ids(tree.get_parent_ids()[:1])
3223
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3226
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3227
if revision is None:
3228
rev_id = tree.last_revision()
3229
elif len(revision) != 1:
3230
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3232
rev_id = revision[0].as_revision_id(tree.branch)
3233
pb = ui.ui_factory.nested_progress_bar()
3235
tree.revert(file_list,
3236
tree.branch.repository.revision_tree(rev_id),
3237
not no_backup, pb, report_changes=True)
3242
class cmd_assert_fail(Command):
3243
"""Test reporting of assertion failures"""
3244
# intended just for use in testing
3249
raise AssertionError("always fails")
3252
class cmd_help(Command):
3253
"""Show help on a command or other topic.
3256
_see_also = ['topics']
3258
Option('long', 'Show help on all commands.'),
3260
takes_args = ['topic?']
3261
aliases = ['?', '--help', '-?', '-h']
3264
def run(self, topic=None, long=False):
3266
if topic is None and long:
3268
bzrlib.help.help(topic)
3271
class cmd_shell_complete(Command):
3272
"""Show appropriate completions for context.
3274
For a list of all available commands, say 'bzr shell-complete'.
3276
takes_args = ['context?']
3281
def run(self, context=None):
3282
import shellcomplete
3283
shellcomplete.shellcomplete(context)
3286
class cmd_missing(Command):
3287
"""Show unmerged/unpulled revisions between two branches.
3289
OTHER_BRANCH may be local or remote.
3292
_see_also = ['merge', 'pull']
3293
takes_args = ['other_branch?']
3295
Option('reverse', 'Reverse the order of revisions.'),
3297
'Display changes in the local branch only.'),
3298
Option('this' , 'Same as --mine-only.'),
3299
Option('theirs-only',
3300
'Display changes in the remote branch only.'),
3301
Option('other', 'Same as --theirs-only.'),
3306
encoding_type = 'replace'
3309
def run(self, other_branch=None, reverse=False, mine_only=False,
3310
theirs_only=False, log_format=None, long=False, short=False, line=False,
3311
show_ids=False, verbose=False, this=False, other=False):
3312
from bzrlib.missing import find_unmerged, iter_log_revisions
3318
# TODO: We should probably check that we don't have mine-only and
3319
# theirs-only set, but it gets complicated because we also have
3320
# this and other which could be used.
3327
local_branch = Branch.open_containing(u".")[0]
3328
parent = local_branch.get_parent()
3329
if other_branch is None:
3330
other_branch = parent
3331
if other_branch is None:
3332
raise errors.BzrCommandError("No peer location known"
3334
display_url = urlutils.unescape_for_display(parent,
3336
self.outf.write("Using last location: " + display_url + "\n")
3338
remote_branch = Branch.open(other_branch)
3339
if remote_branch.base == local_branch.base:
3340
remote_branch = local_branch
3341
local_branch.lock_read()
3343
remote_branch.lock_read()
3345
local_extra, remote_extra = find_unmerged(
3346
local_branch, remote_branch, restrict)
3348
if log_format is None:
3349
registry = log.log_formatter_registry
3350
log_format = registry.get_default(local_branch)
3351
lf = log_format(to_file=self.outf,
3353
show_timezone='original')
3354
if reverse is False:
3355
if local_extra is not None:
3356
local_extra.reverse()
3357
if remote_extra is not None:
3358
remote_extra.reverse()
3361
if local_extra and not theirs_only:
3362
self.outf.write("You have %d extra revision(s):\n" %
3364
for revision in iter_log_revisions(local_extra,
3365
local_branch.repository,
3367
lf.log_revision(revision)
3368
printed_local = True
3371
printed_local = False
3373
if remote_extra and not mine_only:
3374
if printed_local is True:
3375
self.outf.write("\n\n\n")
3376
self.outf.write("You are missing %d revision(s):\n" %
3378
for revision in iter_log_revisions(remote_extra,
3379
remote_branch.repository,
3381
lf.log_revision(revision)
3384
if mine_only and not local_extra:
3385
# We checked local, and found nothing extra
3386
self.outf.write('This branch is up to date.\n')
3387
elif theirs_only and not remote_extra:
3388
# We checked remote, and found nothing extra
3389
self.outf.write('Other branch is up to date.\n')
3390
elif not (mine_only or theirs_only or local_extra or
3392
# We checked both branches, and neither one had extra
3394
self.outf.write("Branches are up to date.\n")
3396
remote_branch.unlock()
3398
local_branch.unlock()
3399
if not status_code and parent is None and other_branch is not None:
3400
local_branch.lock_write()
3402
# handle race conditions - a parent might be set while we run.
3403
if local_branch.get_parent() is None:
3404
local_branch.set_parent(remote_branch.base)
3406
local_branch.unlock()
3410
class cmd_pack(Command):
3411
"""Compress the data within a repository."""
3413
_see_also = ['repositories']
3414
takes_args = ['branch_or_repo?']
3416
def run(self, branch_or_repo='.'):
3417
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3419
branch = dir.open_branch()
3420
repository = branch.repository
3421
except errors.NotBranchError:
3422
repository = dir.open_repository()
3426
class cmd_plugins(Command):
3427
"""List the installed plugins.
3429
This command displays the list of installed plugins including
3430
version of plugin and a short description of each.
3432
--verbose shows the path where each plugin is located.
3434
A plugin is an external component for Bazaar that extends the
3435
revision control system, by adding or replacing code in Bazaar.
3436
Plugins can do a variety of things, including overriding commands,
3437
adding new commands, providing additional network transports and
3438
customizing log output.
3440
See the Bazaar web site, http://bazaar-vcs.org, for further
3441
information on plugins including where to find them and how to
3442
install them. Instructions are also provided there on how to
3443
write new plugins using the Python programming language.
3445
takes_options = ['verbose']
3448
def run(self, verbose=False):
3449
import bzrlib.plugin
3450
from inspect import getdoc
3452
for name, plugin in bzrlib.plugin.plugins().items():
3453
version = plugin.__version__
3454
if version == 'unknown':
3456
name_ver = '%s %s' % (name, version)
3457
d = getdoc(plugin.module)
3459
doc = d.split('\n')[0]
3461
doc = '(no description)'
3462
result.append((name_ver, doc, plugin.path()))
3463
for name_ver, doc, path in sorted(result):
3471
class cmd_testament(Command):
3472
"""Show testament (signing-form) of a revision."""
3475
Option('long', help='Produce long-format testament.'),
3477
help='Produce a strict-format testament.')]
3478
takes_args = ['branch?']
3480
def run(self, branch=u'.', revision=None, long=False, strict=False):
3481
from bzrlib.testament import Testament, StrictTestament
3483
testament_class = StrictTestament
3485
testament_class = Testament
3487
b = Branch.open_containing(branch)[0]
3489
b = Branch.open(branch)
3492
if revision is None:
3493
rev_id = b.last_revision()
3495
rev_id = revision[0].as_revision_id(b)
3496
t = testament_class.from_revision(b.repository, rev_id)
3498
sys.stdout.writelines(t.as_text_lines())
3500
sys.stdout.write(t.as_short_text())
3505
class cmd_annotate(Command):
3506
"""Show the origin of each line in a file.
3508
This prints out the given file with an annotation on the left side
3509
indicating which revision, author and date introduced the change.
3511
If the origin is the same for a run of consecutive lines, it is
3512
shown only at the top, unless the --all option is given.
3514
# TODO: annotate directories; showing when each file was last changed
3515
# TODO: if the working copy is modified, show annotations on that
3516
# with new uncommitted lines marked
3517
aliases = ['ann', 'blame', 'praise']
3518
takes_args = ['filename']
3519
takes_options = [Option('all', help='Show annotations on all lines.'),
3520
Option('long', help='Show commit date in annotations.'),
3524
encoding_type = 'exact'
3527
def run(self, filename, all=False, long=False, revision=None,
3529
from bzrlib.annotate import annotate_file
3530
wt, branch, relpath = \
3531
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3537
if revision is None:
3538
revision_id = branch.last_revision()
3539
elif len(revision) != 1:
3540
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3542
revision_id = revision[0].as_revision_id(branch)
3543
tree = branch.repository.revision_tree(revision_id)
3545
file_id = wt.path2id(relpath)
3547
file_id = tree.path2id(relpath)
3549
raise errors.NotVersionedError(filename)
3550
file_version = tree.inventory[file_id].revision
3551
annotate_file(branch, file_version, file_id, long, all, self.outf,
3560
class cmd_re_sign(Command):
3561
"""Create a digital signature for an existing revision."""
3562
# TODO be able to replace existing ones.
3564
hidden = True # is this right ?
3565
takes_args = ['revision_id*']
3566
takes_options = ['revision']
3568
def run(self, revision_id_list=None, revision=None):
3569
if revision_id_list is not None and revision is not None:
3570
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3571
if revision_id_list is None and revision is None:
3572
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3573
b = WorkingTree.open_containing(u'.')[0].branch
3576
return self._run(b, revision_id_list, revision)
3580
def _run(self, b, revision_id_list, revision):
3581
import bzrlib.gpg as gpg
3582
gpg_strategy = gpg.GPGStrategy(b.get_config())
3583
if revision_id_list is not None:
3584
b.repository.start_write_group()
3586
for revision_id in revision_id_list:
3587
b.repository.sign_revision(revision_id, gpg_strategy)
3589
b.repository.abort_write_group()
3592
b.repository.commit_write_group()
3593
elif revision is not None:
3594
if len(revision) == 1:
3595
revno, rev_id = revision[0].in_history(b)
3596
b.repository.start_write_group()
3598
b.repository.sign_revision(rev_id, gpg_strategy)
3600
b.repository.abort_write_group()
3603
b.repository.commit_write_group()
3604
elif len(revision) == 2:
3605
# are they both on rh- if so we can walk between them
3606
# might be nice to have a range helper for arbitrary
3607
# revision paths. hmm.
3608
from_revno, from_revid = revision[0].in_history(b)
3609
to_revno, to_revid = revision[1].in_history(b)
3610
if to_revid is None:
3611
to_revno = b.revno()
3612
if from_revno is None or to_revno is None:
3613
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3614
b.repository.start_write_group()
3616
for revno in range(from_revno, to_revno + 1):
3617
b.repository.sign_revision(b.get_rev_id(revno),
3620
b.repository.abort_write_group()
3623
b.repository.commit_write_group()
3625
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3628
class cmd_bind(Command):
3629
"""Convert the current branch into a checkout of the supplied branch.
3631
Once converted into a checkout, commits must succeed on the master branch
3632
before they will be applied to the local branch.
3635
_see_also = ['checkouts', 'unbind']
3636
takes_args = ['location?']
3639
def run(self, location=None):
3640
b, relpath = Branch.open_containing(u'.')
3641
if location is None:
3643
location = b.get_old_bound_location()
3644
except errors.UpgradeRequired:
3645
raise errors.BzrCommandError('No location supplied. '
3646
'This format does not remember old locations.')
3648
if location is None:
3649
raise errors.BzrCommandError('No location supplied and no '
3650
'previous location known')
3651
b_other = Branch.open(location)
3654
except errors.DivergedBranches:
3655
raise errors.BzrCommandError('These branches have diverged.'
3656
' Try merging, and then bind again.')
3659
class cmd_unbind(Command):
3660
"""Convert the current checkout into a regular branch.
3662
After unbinding, the local branch is considered independent and subsequent
3663
commits will be local only.
3666
_see_also = ['checkouts', 'bind']
3671
b, relpath = Branch.open_containing(u'.')
3673
raise errors.BzrCommandError('Local branch is not bound')
3676
class cmd_uncommit(Command):
3677
"""Remove the last committed revision.
3679
--verbose will print out what is being removed.
3680
--dry-run will go through all the motions, but not actually
3683
If --revision is specified, uncommit revisions to leave the branch at the
3684
specified revision. For example, "bzr uncommit -r 15" will leave the
3685
branch at revision 15.
3687
Uncommit leaves the working tree ready for a new commit. The only change
3688
it may make is to restore any pending merges that were present before
3692
# TODO: jam 20060108 Add an option to allow uncommit to remove
3693
# unreferenced information in 'branch-as-repository' branches.
3694
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3695
# information in shared branches as well.
3696
_see_also = ['commit']
3697
takes_options = ['verbose', 'revision',
3698
Option('dry-run', help='Don\'t actually make changes.'),
3699
Option('force', help='Say yes to all questions.'),
3701
help="Only remove the commits from the local branch"
3702
" when in a checkout."
3705
takes_args = ['location?']
3707
encoding_type = 'replace'
3709
def run(self, location=None,
3710
dry_run=False, verbose=False,
3711
revision=None, force=False, local=False):
3712
if location is None:
3714
control, relpath = bzrdir.BzrDir.open_containing(location)
3716
tree = control.open_workingtree()
3718
except (errors.NoWorkingTree, errors.NotLocalUrl):
3720
b = control.open_branch()
3722
if tree is not None:
3727
return self._run(b, tree, dry_run, verbose, revision, force,
3730
if tree is not None:
3735
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3736
from bzrlib.log import log_formatter, show_log
3737
from bzrlib.uncommit import uncommit
3739
last_revno, last_rev_id = b.last_revision_info()
3742
if revision is None:
3744
rev_id = last_rev_id
3746
# 'bzr uncommit -r 10' actually means uncommit
3747
# so that the final tree is at revno 10.
3748
# but bzrlib.uncommit.uncommit() actually uncommits
3749
# the revisions that are supplied.
3750
# So we need to offset it by one
3751
revno = revision[0].in_history(b).revno + 1
3752
if revno <= last_revno:
3753
rev_id = b.get_rev_id(revno)
3755
if rev_id is None or _mod_revision.is_null(rev_id):
3756
self.outf.write('No revisions to uncommit.\n')
3759
lf = log_formatter('short',
3761
show_timezone='original')
3766
direction='forward',
3767
start_revision=revno,
3768
end_revision=last_revno)
3771
print 'Dry-run, pretending to remove the above revisions.'
3773
val = raw_input('Press <enter> to continue')
3775
print 'The above revision(s) will be removed.'
3777
val = raw_input('Are you sure [y/N]? ')
3778
if val.lower() not in ('y', 'yes'):
3782
mutter('Uncommitting from {%s} to {%s}',
3783
last_rev_id, rev_id)
3784
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3785
revno=revno, local=local)
3786
note('You can restore the old tip by running:\n'
3787
' bzr pull . -r revid:%s', last_rev_id)
3790
class cmd_break_lock(Command):
3791
"""Break a dead lock on a repository, branch or working directory.
3793
CAUTION: Locks should only be broken when you are sure that the process
3794
holding the lock has been stopped.
3796
You can get information on what locks are open via the 'bzr info' command.
3801
takes_args = ['location?']
3803
def run(self, location=None, show=False):
3804
if location is None:
3806
control, relpath = bzrdir.BzrDir.open_containing(location)
3808
control.break_lock()
3809
except NotImplementedError:
3813
class cmd_wait_until_signalled(Command):
3814
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3816
This just prints a line to signal when it is ready, then blocks on stdin.
3822
sys.stdout.write("running\n")
3824
sys.stdin.readline()
3827
class cmd_serve(Command):
3828
"""Run the bzr server."""
3830
aliases = ['server']
3834
help='Serve on stdin/out for use from inetd or sshd.'),
3836
help='Listen for connections on nominated port of the form '
3837
'[hostname:]portnumber. Passing 0 as the port number will '
3838
'result in a dynamically allocated port. The default port is '
3842
help='Serve contents of this directory.',
3844
Option('allow-writes',
3845
help='By default the server is a readonly server. Supplying '
3846
'--allow-writes enables write access to the contents of '
3847
'the served directory and below.'
3851
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3852
from bzrlib import lockdir
3853
from bzrlib.smart import medium, server
3854
from bzrlib.transport import get_transport
3855
from bzrlib.transport.chroot import ChrootServer
3856
if directory is None:
3857
directory = os.getcwd()
3858
url = urlutils.local_path_to_url(directory)
3859
if not allow_writes:
3860
url = 'readonly+' + url
3861
chroot_server = ChrootServer(get_transport(url))
3862
chroot_server.setUp()
3863
t = get_transport(chroot_server.get_url())
3865
smart_server = medium.SmartServerPipeStreamMedium(
3866
sys.stdin, sys.stdout, t)
3868
host = medium.BZR_DEFAULT_INTERFACE
3870
port = medium.BZR_DEFAULT_PORT
3873
host, port = port.split(':')
3875
smart_server = server.SmartTCPServer(t, host=host, port=port)
3876
print 'listening on port: ', smart_server.port
3878
# for the duration of this server, no UI output is permitted.
3879
# note that this may cause problems with blackbox tests. This should
3880
# be changed with care though, as we dont want to use bandwidth sending
3881
# progress over stderr to smart server clients!
3882
old_factory = ui.ui_factory
3883
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3885
ui.ui_factory = ui.SilentUIFactory()
3886
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3887
smart_server.serve()
3889
ui.ui_factory = old_factory
3890
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3893
class cmd_join(Command):
3894
"""Combine a subtree into its containing tree.
3896
This command is for experimental use only. It requires the target tree
3897
to be in dirstate-with-subtree format, which cannot be converted into
3900
The TREE argument should be an independent tree, inside another tree, but
3901
not part of it. (Such trees can be produced by "bzr split", but also by
3902
running "bzr branch" with the target inside a tree.)
3904
The result is a combined tree, with the subtree no longer an independant
3905
part. This is marked as a merge of the subtree into the containing tree,
3906
and all history is preserved.
3908
If --reference is specified, the subtree retains its independence. It can
3909
be branched by itself, and can be part of multiple projects at the same
3910
time. But operations performed in the containing tree, such as commit
3911
and merge, will recurse into the subtree.
3914
_see_also = ['split']
3915
takes_args = ['tree']
3917
Option('reference', help='Join by reference.'),
3921
def run(self, tree, reference=False):
3922
sub_tree = WorkingTree.open(tree)
3923
parent_dir = osutils.dirname(sub_tree.basedir)
3924
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3925
repo = containing_tree.branch.repository
3926
if not repo.supports_rich_root():
3927
raise errors.BzrCommandError(
3928
"Can't join trees because %s doesn't support rich root data.\n"
3929
"You can use bzr upgrade on the repository."
3933
containing_tree.add_reference(sub_tree)
3934
except errors.BadReferenceTarget, e:
3935
# XXX: Would be better to just raise a nicely printable
3936
# exception from the real origin. Also below. mbp 20070306
3937
raise errors.BzrCommandError("Cannot join %s. %s" %
3941
containing_tree.subsume(sub_tree)
3942
except errors.BadSubsumeSource, e:
3943
raise errors.BzrCommandError("Cannot join %s. %s" %
3947
class cmd_split(Command):
3948
"""Split a subdirectory of a tree into a separate tree.
3950
This command will produce a target tree in a format that supports
3951
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
3952
converted into earlier formats like 'dirstate-tags'.
3954
The TREE argument should be a subdirectory of a working tree. That
3955
subdirectory will be converted into an independent tree, with its own
3956
branch. Commits in the top-level tree will not apply to the new subtree.
3959
# join is not un-hidden yet
3960
#_see_also = ['join']
3961
takes_args = ['tree']
3963
def run(self, tree):
3964
containing_tree, subdir = WorkingTree.open_containing(tree)
3965
sub_id = containing_tree.path2id(subdir)
3967
raise errors.NotVersionedError(subdir)
3969
containing_tree.extract(sub_id)
3970
except errors.RootNotRich:
3971
raise errors.UpgradeRequired(containing_tree.branch.base)
3974
class cmd_merge_directive(Command):
3975
"""Generate a merge directive for auto-merge tools.
3977
A directive requests a merge to be performed, and also provides all the
3978
information necessary to do so. This means it must either include a
3979
revision bundle, or the location of a branch containing the desired
3982
A submit branch (the location to merge into) must be supplied the first
3983
time the command is issued. After it has been supplied once, it will
3984
be remembered as the default.
3986
A public branch is optional if a revision bundle is supplied, but required
3987
if --diff or --plain is specified. It will be remembered as the default
3988
after the first use.
3991
takes_args = ['submit_branch?', 'public_branch?']
3995
_see_also = ['send']
3998
RegistryOption.from_kwargs('patch-type',
3999
'The type of patch to include in the directive.',
4001
value_switches=True,
4003
bundle='Bazaar revision bundle (default).',
4004
diff='Normal unified diff.',
4005
plain='No patch, just directive.'),
4006
Option('sign', help='GPG-sign the directive.'), 'revision',
4007
Option('mail-to', type=str,
4008
help='Instead of printing the directive, email to this address.'),
4009
Option('message', type=str, short_name='m',
4010
help='Message to use when committing this merge.')
4013
encoding_type = 'exact'
4015
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4016
sign=False, revision=None, mail_to=None, message=None):
4017
from bzrlib.revision import ensure_null, NULL_REVISION
4018
include_patch, include_bundle = {
4019
'plain': (False, False),
4020
'diff': (True, False),
4021
'bundle': (True, True),
4023
branch = Branch.open('.')
4024
stored_submit_branch = branch.get_submit_branch()
4025
if submit_branch is None:
4026
submit_branch = stored_submit_branch
4028
if stored_submit_branch is None:
4029
branch.set_submit_branch(submit_branch)
4030
if submit_branch is None:
4031
submit_branch = branch.get_parent()
4032
if submit_branch is None:
4033
raise errors.BzrCommandError('No submit branch specified or known')
4035
stored_public_branch = branch.get_public_branch()
4036
if public_branch is None:
4037
public_branch = stored_public_branch
4038
elif stored_public_branch is None:
4039
branch.set_public_branch(public_branch)
4040
if not include_bundle and public_branch is None:
4041
raise errors.BzrCommandError('No public branch specified or'
4043
base_revision_id = None
4044
if revision is not None:
4045
if len(revision) > 2:
4046
raise errors.BzrCommandError('bzr merge-directive takes '
4047
'at most two one revision identifiers')
4048
revision_id = revision[-1].as_revision_id(branch)
4049
if len(revision) == 2:
4050
base_revision_id = revision[0].as_revision_id(branch)
4052
revision_id = branch.last_revision()
4053
revision_id = ensure_null(revision_id)
4054
if revision_id == NULL_REVISION:
4055
raise errors.BzrCommandError('No revisions to bundle.')
4056
directive = merge_directive.MergeDirective2.from_objects(
4057
branch.repository, revision_id, time.time(),
4058
osutils.local_time_offset(), submit_branch,
4059
public_branch=public_branch, include_patch=include_patch,
4060
include_bundle=include_bundle, message=message,
4061
base_revision_id=base_revision_id)
4064
self.outf.write(directive.to_signed(branch))
4066
self.outf.writelines(directive.to_lines())
4068
message = directive.to_email(mail_to, branch, sign)
4069
s = SMTPConnection(branch.get_config())
4070
s.send_email(message)
4073
class cmd_send(Command):
4074
"""Mail or create a merge-directive for submiting changes.
4076
A merge directive provides many things needed for requesting merges:
4078
* A machine-readable description of the merge to perform
4080
* An optional patch that is a preview of the changes requested
4082
* An optional bundle of revision data, so that the changes can be applied
4083
directly from the merge directive, without retrieving data from a
4086
If --no-bundle is specified, then public_branch is needed (and must be
4087
up-to-date), so that the receiver can perform the merge using the
4088
public_branch. The public_branch is always included if known, so that
4089
people can check it later.
4091
The submit branch defaults to the parent, but can be overridden. Both
4092
submit branch and public branch will be remembered if supplied.
4094
If a public_branch is known for the submit_branch, that public submit
4095
branch is used in the merge instructions. This means that a local mirror
4096
can be used as your actual submit branch, once you have set public_branch
4099
Mail is sent using your preferred mail program. This should be transparent
4100
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4101
If the preferred client can't be found (or used), your editor will be used.
4103
To use a specific mail program, set the mail_client configuration option.
4104
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4105
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4106
generic options are "default", "editor", "emacsclient", "mapi", and
4109
If mail is being sent, a to address is required. This can be supplied
4110
either on the commandline, by setting the submit_to configuration
4111
option in the branch itself or the child_submit_to configuration option
4112
in the submit branch.
4114
Two formats are currently supported: "4" uses revision bundle format 4 and
4115
merge directive format 2. It is significantly faster and smaller than
4116
older formats. It is compatible with Bazaar 0.19 and later. It is the
4117
default. "0.9" uses revision bundle format 0.9 and merge directive
4118
format 1. It is compatible with Bazaar 0.12 - 0.18.
4120
Merge directives are applied using the merge command or the pull command.
4123
encoding_type = 'exact'
4125
_see_also = ['merge', 'pull']
4127
takes_args = ['submit_branch?', 'public_branch?']
4131
help='Do not include a bundle in the merge directive.'),
4132
Option('no-patch', help='Do not include a preview patch in the merge'
4135
help='Remember submit and public branch.'),
4137
help='Branch to generate the submission from, '
4138
'rather than the one containing the working directory.',
4141
Option('output', short_name='o',
4142
help='Write merge directive to this file; '
4143
'use - for stdout.',
4145
Option('mail-to', help='Mail the request to this address.',
4149
RegistryOption.from_kwargs('format',
4150
'Use the specified output format.',
4151
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4152
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4155
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4156
no_patch=False, revision=None, remember=False, output=None,
4157
format='4', mail_to=None, message=None, **kwargs):
4158
return self._run(submit_branch, revision, public_branch, remember,
4159
format, no_bundle, no_patch, output,
4160
kwargs.get('from', '.'), mail_to, message)
4162
def _run(self, submit_branch, revision, public_branch, remember, format,
4163
no_bundle, no_patch, output, from_, mail_to, message):
4164
from bzrlib.revision import NULL_REVISION
4165
branch = Branch.open_containing(from_)[0]
4167
outfile = StringIO()
4171
outfile = open(output, 'wb')
4172
# we may need to write data into branch's repository to calculate
4177
config = branch.get_config()
4179
mail_to = config.get_user_option('submit_to')
4180
mail_client = config.get_mail_client()
4181
if remember and submit_branch is None:
4182
raise errors.BzrCommandError(
4183
'--remember requires a branch to be specified.')
4184
stored_submit_branch = branch.get_submit_branch()
4185
remembered_submit_branch = False
4186
if submit_branch is None:
4187
submit_branch = stored_submit_branch
4188
remembered_submit_branch = True
4190
if stored_submit_branch is None or remember:
4191
branch.set_submit_branch(submit_branch)
4192
if submit_branch is None:
4193
submit_branch = branch.get_parent()
4194
remembered_submit_branch = True
4195
if submit_branch is None:
4196
raise errors.BzrCommandError('No submit branch known or'
4198
if remembered_submit_branch:
4199
note('Using saved location "%s" to determine what changes to submit.', submit_branch)
4202
submit_config = Branch.open(submit_branch).get_config()
4203
mail_to = submit_config.get_user_option("child_submit_to")
4205
stored_public_branch = branch.get_public_branch()
4206
if public_branch is None:
4207
public_branch = stored_public_branch
4208
elif stored_public_branch is None or remember:
4209
branch.set_public_branch(public_branch)
4210
if no_bundle and public_branch is None:
4211
raise errors.BzrCommandError('No public branch specified or'
4213
base_revision_id = None
4215
if revision is not None:
4216
if len(revision) > 2:
4217
raise errors.BzrCommandError('bzr send takes '
4218
'at most two one revision identifiers')
4219
revision_id = revision[-1].as_revision_id(branch)
4220
if len(revision) == 2:
4221
base_revision_id = revision[0].as_revision_id(branch)
4222
if revision_id is None:
4223
revision_id = branch.last_revision()
4224
if revision_id == NULL_REVISION:
4225
raise errors.BzrCommandError('No revisions to submit.')
4227
directive = merge_directive.MergeDirective2.from_objects(
4228
branch.repository, revision_id, time.time(),
4229
osutils.local_time_offset(), submit_branch,
4230
public_branch=public_branch, include_patch=not no_patch,
4231
include_bundle=not no_bundle, message=message,
4232
base_revision_id=base_revision_id)
4233
elif format == '0.9':
4236
patch_type = 'bundle'
4238
raise errors.BzrCommandError('Format 0.9 does not'
4239
' permit bundle with no patch')
4245
directive = merge_directive.MergeDirective.from_objects(
4246
branch.repository, revision_id, time.time(),
4247
osutils.local_time_offset(), submit_branch,
4248
public_branch=public_branch, patch_type=patch_type,
4251
outfile.writelines(directive.to_lines())
4253
subject = '[MERGE] '
4254
if message is not None:
4257
revision = branch.repository.get_revision(revision_id)
4258
subject += revision.get_summary()
4259
basename = directive.get_disk_name(branch)
4260
mail_client.compose_merge_request(mail_to, subject,
4261
outfile.getvalue(), basename)
4268
class cmd_bundle_revisions(cmd_send):
4270
"""Create a merge-directive for submiting changes.
4272
A merge directive provides many things needed for requesting merges:
4274
* A machine-readable description of the merge to perform
4276
* An optional patch that is a preview of the changes requested
4278
* An optional bundle of revision data, so that the changes can be applied
4279
directly from the merge directive, without retrieving data from a
4282
If --no-bundle is specified, then public_branch is needed (and must be
4283
up-to-date), so that the receiver can perform the merge using the
4284
public_branch. The public_branch is always included if known, so that
4285
people can check it later.
4287
The submit branch defaults to the parent, but can be overridden. Both
4288
submit branch and public branch will be remembered if supplied.
4290
If a public_branch is known for the submit_branch, that public submit
4291
branch is used in the merge instructions. This means that a local mirror
4292
can be used as your actual submit branch, once you have set public_branch
4295
Two formats are currently supported: "4" uses revision bundle format 4 and
4296
merge directive format 2. It is significantly faster and smaller than
4297
older formats. It is compatible with Bazaar 0.19 and later. It is the
4298
default. "0.9" uses revision bundle format 0.9 and merge directive
4299
format 1. It is compatible with Bazaar 0.12 - 0.18.
4304
help='Do not include a bundle in the merge directive.'),
4305
Option('no-patch', help='Do not include a preview patch in the merge'
4308
help='Remember submit and public branch.'),
4310
help='Branch to generate the submission from, '
4311
'rather than the one containing the working directory.',
4314
Option('output', short_name='o', help='Write directive to this file.',
4317
RegistryOption.from_kwargs('format',
4318
'Use the specified output format.',
4319
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4320
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4322
aliases = ['bundle']
4324
_see_also = ['send', 'merge']
4328
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4329
no_patch=False, revision=None, remember=False, output=None,
4330
format='4', **kwargs):
4333
return self._run(submit_branch, revision, public_branch, remember,
4334
format, no_bundle, no_patch, output,
4335
kwargs.get('from', '.'), None, None)
4338
class cmd_tag(Command):
4339
"""Create, remove or modify a tag naming a revision.
4341
Tags give human-meaningful names to revisions. Commands that take a -r
4342
(--revision) option can be given -rtag:X, where X is any previously
4345
Tags are stored in the branch. Tags are copied from one branch to another
4346
along when you branch, push, pull or merge.
4348
It is an error to give a tag name that already exists unless you pass
4349
--force, in which case the tag is moved to point to the new revision.
4351
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4352
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4355
_see_also = ['commit', 'tags']
4356
takes_args = ['tag_name']
4359
help='Delete this tag rather than placing it.',
4362
help='Branch in which to place the tag.',
4367
help='Replace existing tags.',
4372
def run(self, tag_name,
4378
branch, relpath = Branch.open_containing(directory)
4382
branch.tags.delete_tag(tag_name)
4383
self.outf.write('Deleted tag %s.\n' % tag_name)
4386
if len(revision) != 1:
4387
raise errors.BzrCommandError(
4388
"Tags can only be placed on a single revision, "
4390
revision_id = revision[0].as_revision_id(branch)
4392
revision_id = branch.last_revision()
4393
if (not force) and branch.tags.has_tag(tag_name):
4394
raise errors.TagAlreadyExists(tag_name)
4395
branch.tags.set_tag(tag_name, revision_id)
4396
self.outf.write('Created tag %s.\n' % tag_name)
4401
class cmd_tags(Command):
4404
This command shows a table of tag names and the revisions they reference.
4410
help='Branch whose tags should be displayed.',
4414
RegistryOption.from_kwargs('sort',
4415
'Sort tags by different criteria.', title='Sorting',
4416
alpha='Sort tags lexicographically (default).',
4417
time='Sort tags chronologically.',
4428
branch, relpath = Branch.open_containing(directory)
4429
tags = branch.tags.get_tag_dict().items()
4434
elif sort == 'time':
4436
for tag, revid in tags:
4438
revobj = branch.repository.get_revision(revid)
4439
except errors.NoSuchRevision:
4440
timestamp = sys.maxint # place them at the end
4442
timestamp = revobj.timestamp
4443
timestamps[revid] = timestamp
4444
tags.sort(key=lambda x: timestamps[x[1]])
4446
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4447
revno_map = branch.get_revision_id_to_revno_map()
4448
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4449
for tag, revid in tags ]
4450
for tag, revspec in tags:
4451
self.outf.write('%-20s %s\n' % (tag, revspec))
4454
class cmd_reconfigure(Command):
4455
"""Reconfigure the type of a bzr directory.
4457
A target configuration must be specified.
4459
For checkouts, the bind-to location will be auto-detected if not specified.
4460
The order of preference is
4461
1. For a lightweight checkout, the current bound location.
4462
2. For branches that used to be checkouts, the previously-bound location.
4463
3. The push location.
4464
4. The parent location.
4465
If none of these is available, --bind-to must be specified.
4468
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4469
takes_args = ['location?']
4470
takes_options = [RegistryOption.from_kwargs('target_type',
4471
title='Target type',
4472
help='The type to reconfigure the directory to.',
4473
value_switches=True, enum_switch=False,
4474
branch='Reconfigure to be an unbound branch '
4475
'with no working tree.',
4476
tree='Reconfigure to be an unbound branch '
4477
'with a working tree.',
4478
checkout='Reconfigure to be a bound branch '
4479
'with a working tree.',
4480
lightweight_checkout='Reconfigure to be a lightweight'
4481
' checkout (with no local history).',
4482
standalone='Reconfigure to be a standalone branch '
4483
'(i.e. stop using shared repository).',
4484
use_shared='Reconfigure to use a shared repository.'),
4485
Option('bind-to', help='Branch to bind checkout to.',
4488
help='Perform reconfiguration even if local changes'
4492
def run(self, location=None, target_type=None, bind_to=None, force=False):
4493
directory = bzrdir.BzrDir.open(location)
4494
if target_type is None:
4495
raise errors.BzrCommandError('No target configuration specified')
4496
elif target_type == 'branch':
4497
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4498
elif target_type == 'tree':
4499
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4500
elif target_type == 'checkout':
4501
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4503
elif target_type == 'lightweight-checkout':
4504
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4506
elif target_type == 'use-shared':
4507
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4508
elif target_type == 'standalone':
4509
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4510
reconfiguration.apply(force)
4513
class cmd_switch(Command):
4514
"""Set the branch of a checkout and update.
4516
For lightweight checkouts, this changes the branch being referenced.
4517
For heavyweight checkouts, this checks that there are no local commits
4518
versus the current bound branch, then it makes the local branch a mirror
4519
of the new location and binds to it.
4521
In both cases, the working tree is updated and uncommitted changes
4522
are merged. The user can commit or revert these as they desire.
4524
Pending merges need to be committed or reverted before using switch.
4526
The path to the branch to switch to can be specified relative to the parent
4527
directory of the current branch. For example, if you are currently in a
4528
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4532
takes_args = ['to_location']
4533
takes_options = [Option('force',
4534
help='Switch even if local commits will be lost.')
4537
def run(self, to_location, force=False):
4538
from bzrlib import switch
4540
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4542
to_branch = Branch.open(to_location)
4543
except errors.NotBranchError:
4544
to_branch = Branch.open(
4545
control_dir.open_branch().base + '../' + to_location)
4546
switch.switch(control_dir, to_branch, force)
4547
note('Switched to branch: %s',
4548
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4551
class cmd_hooks(Command):
4552
"""Show a branch's currently registered hooks.
4556
takes_args = ['path?']
4558
def run(self, path=None):
4561
branch_hooks = Branch.open(path).hooks
4562
for hook_type in branch_hooks:
4563
hooks = branch_hooks[hook_type]
4564
self.outf.write("%s:\n" % (hook_type,))
4567
self.outf.write(" %s\n" %
4568
(branch_hooks.get_hook_name(hook),))
4570
self.outf.write(" <no hooks installed>\n")
4573
def _create_prefix(cur_transport):
4574
needed = [cur_transport]
4575
# Recurse upwards until we can create a directory successfully
4577
new_transport = cur_transport.clone('..')
4578
if new_transport.base == cur_transport.base:
4579
raise errors.BzrCommandError(
4580
"Failed to create path prefix for %s."
4581
% cur_transport.base)
4583
new_transport.mkdir('.')
4584
except errors.NoSuchFile:
4585
needed.append(new_transport)
4586
cur_transport = new_transport
4589
# Now we only need to create child directories
4591
cur_transport = needed.pop()
4592
cur_transport.ensure_base()
4595
# these get imported and then picked up by the scan for cmd_*
4596
# TODO: Some more consistent way to split command definitions across files;
4597
# we do need to load at least some information about them to know of
4598
# aliases. ideally we would avoid loading the implementation until the
4599
# details were needed.
4600
from bzrlib.cmd_version_info import cmd_version_info
4601
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4602
from bzrlib.bundle.commands import (
4605
from bzrlib.sign_my_commits import cmd_sign_my_commits
4606
from bzrlib.weave_commands import cmd_versionedfile_list, \
4607
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
