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
def _get_revision_tree(command_name, revision, branch=None, tree=None):
75
rev_tree = tree.basis_tree()
77
rev_tree = branch.basis_tree()
79
if len(revision) != 1:
80
raise errors.BzrCommandError(
81
'bzr %s --revision takes exactly one revision identifier' % (
83
rev_tree = revision[0].as_tree(branch)
87
# XXX: Bad function name; should possibly also be a class method of
88
# WorkingTree rather than a function.
89
def internal_tree_files(file_list, default_branch=u'.'):
90
"""Convert command-line paths to a WorkingTree and relative paths.
92
This is typically used for command-line processors that take one or
93
more filenames, and infer the workingtree that contains them.
95
The filenames given are not required to exist.
97
:param file_list: Filenames to convert.
99
:param default_branch: Fallback tree path to use if file_list is empty or
102
:return: workingtree, [relative_paths]
104
if file_list is None or len(file_list) == 0:
105
return WorkingTree.open_containing(default_branch)[0], file_list
106
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
107
return tree, safe_relpath_files(tree, file_list)
110
def safe_relpath_files(tree, file_list):
111
"""Convert file_list into a list of relpaths in tree.
113
:param tree: A tree to operate on.
114
:param file_list: A list of user provided paths or None.
115
:return: A list of relative paths.
116
:raises errors.PathNotChild: When a provided path is in a different tree
119
if file_list is None:
122
for filename in file_list:
124
new_list.append(tree.relpath(osutils.dereference_path(filename)))
125
except errors.PathNotChild:
126
raise errors.FileInWrongBranch(tree.branch, filename)
130
# TODO: Make sure no commands unconditionally use the working directory as a
131
# branch. If a filename argument is used, the first of them should be used to
132
# specify the branch. (Perhaps this can be factored out into some kind of
133
# Argument class, representing a file in a branch, where the first occurrence
136
class cmd_status(Command):
137
"""Display status summary.
139
This reports on versioned and unknown files, reporting them
140
grouped by state. Possible states are:
143
Versioned in the working copy but not in the previous revision.
146
Versioned in the previous revision but removed or deleted
150
Path of this file changed from the previous revision;
151
the text may also have changed. This includes files whose
152
parent directory was renamed.
155
Text has changed since the previous revision.
158
File kind has been changed (e.g. from file to directory).
161
Not versioned and not matching an ignore pattern.
163
To see ignored files use 'bzr ignored'. For details on the
164
changes to file texts, use 'bzr diff'.
166
Note that --short or -S gives status flags for each item, similar
167
to Subversion's status command. To get output similar to svn -q,
170
If no arguments are specified, the status of the entire working
171
directory is shown. Otherwise, only the status of the specified
172
files or directories is reported. If a directory is given, status
173
is reported for everything inside that directory.
175
If a revision argument is given, the status is calculated against
176
that revision, or between two revisions if two are provided.
179
# TODO: --no-recurse, --recurse options
181
takes_args = ['file*']
182
takes_options = ['show-ids', 'revision', 'change',
183
Option('short', help='Use short status indicators.',
185
Option('versioned', help='Only show versioned files.',
187
Option('no-pending', help='Don\'t show pending merges.',
190
aliases = ['st', 'stat']
192
encoding_type = 'replace'
193
_see_also = ['diff', 'revert', 'status-flags']
196
def run(self, show_ids=False, file_list=None, revision=None, short=False,
197
versioned=False, no_pending=False):
198
from bzrlib.status import show_tree_status
200
if revision and len(revision) > 2:
201
raise errors.BzrCommandError('bzr status --revision takes exactly'
202
' one or two revision specifiers')
204
tree, relfile_list = tree_files(file_list)
205
# Avoid asking for specific files when that is not needed.
206
if relfile_list == ['']:
208
# Don't disable pending merges for full trees other than '.'.
209
if file_list == ['.']:
211
# A specific path within a tree was given.
212
elif relfile_list is not None:
214
show_tree_status(tree, show_ids=show_ids,
215
specific_files=relfile_list, revision=revision,
216
to_file=self.outf, short=short, versioned=versioned,
217
show_pending=(not no_pending))
220
class cmd_cat_revision(Command):
221
"""Write out metadata for a revision.
223
The revision to print can either be specified by a specific
224
revision identifier, or you can use --revision.
228
takes_args = ['revision_id?']
229
takes_options = ['revision']
230
# cat-revision is more for frontends so should be exact
234
def run(self, revision_id=None, revision=None):
235
if revision_id is not None and revision is not None:
236
raise errors.BzrCommandError('You can only supply one of'
237
' revision_id or --revision')
238
if revision_id is None and revision is None:
239
raise errors.BzrCommandError('You must supply either'
240
' --revision or a revision_id')
241
b = WorkingTree.open_containing(u'.')[0].branch
243
# TODO: jam 20060112 should cat-revision always output utf-8?
244
if revision_id is not None:
245
revision_id = osutils.safe_revision_id(revision_id, warn=False)
246
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
247
elif revision is not None:
250
raise errors.BzrCommandError('You cannot specify a NULL'
252
rev_id = rev.as_revision_id(b)
253
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
256
class cmd_remove_tree(Command):
257
"""Remove the working tree from a given branch/checkout.
259
Since a lightweight checkout is little more than a working tree
260
this will refuse to run against one.
262
To re-create the working tree, use "bzr checkout".
264
_see_also = ['checkout', 'working-trees']
266
takes_args = ['location?']
268
def run(self, location='.'):
269
d = bzrdir.BzrDir.open(location)
272
working = d.open_workingtree()
273
except errors.NoWorkingTree:
274
raise errors.BzrCommandError("No working tree to remove")
275
except errors.NotLocalUrl:
276
raise errors.BzrCommandError("You cannot remove the working tree of a "
279
working_path = working.bzrdir.root_transport.base
280
branch_path = working.branch.bzrdir.root_transport.base
281
if working_path != branch_path:
282
raise errors.BzrCommandError("You cannot remove the working tree from "
283
"a lightweight checkout")
285
d.destroy_workingtree()
288
class cmd_revno(Command):
289
"""Show current revision number.
291
This is equal to the number of revisions on this branch.
295
takes_args = ['location?']
298
def run(self, location=u'.'):
299
self.outf.write(str(Branch.open_containing(location)[0].revno()))
300
self.outf.write('\n')
303
class cmd_revision_info(Command):
304
"""Show revision number and revision id for a given revision identifier.
307
takes_args = ['revision_info*']
308
takes_options = ['revision']
311
def run(self, revision=None, revision_info_list=[]):
314
if revision is not None:
315
revs.extend(revision)
316
if revision_info_list is not None:
317
for rev in revision_info_list:
318
revs.append(RevisionSpec.from_string(rev))
320
b = Branch.open_containing(u'.')[0]
323
revs.append(RevisionSpec.from_string('-1'))
326
revision_id = rev.as_revision_id(b)
328
revno = '%4d' % (b.revision_id_to_revno(revision_id))
329
except errors.NoSuchRevision:
330
dotted_map = b.get_revision_id_to_revno_map()
331
revno = '.'.join(str(i) for i in dotted_map[revision_id])
332
print '%s %s' % (revno, revision_id)
335
class cmd_add(Command):
336
"""Add specified files or directories.
338
In non-recursive mode, all the named items are added, regardless
339
of whether they were previously ignored. A warning is given if
340
any of the named files are already versioned.
342
In recursive mode (the default), files are treated the same way
343
but the behaviour for directories is different. Directories that
344
are already versioned do not give a warning. All directories,
345
whether already versioned or not, are searched for files or
346
subdirectories that are neither versioned or ignored, and these
347
are added. This search proceeds recursively into versioned
348
directories. If no names are given '.' is assumed.
350
Therefore simply saying 'bzr add' will version all files that
351
are currently unknown.
353
Adding a file whose parent directory is not versioned will
354
implicitly add the parent, and so on up to the root. This means
355
you should never need to explicitly add a directory, they'll just
356
get added when you add a file in the directory.
358
--dry-run will show which files would be added, but not actually
361
--file-ids-from will try to use the file ids from the supplied path.
362
It looks up ids trying to find a matching parent directory with the
363
same filename, and then by pure path. This option is rarely needed
364
but can be useful when adding the same logical file into two
365
branches that will be merged later (without showing the two different
366
adds as a conflict). It is also useful when merging another project
367
into a subdirectory of this one.
369
takes_args = ['file*']
372
help="Don't recursively add the contents of directories."),
374
help="Show what would be done, but don't actually do anything."),
376
Option('file-ids-from',
378
help='Lookup file ids from this tree.'),
380
encoding_type = 'replace'
381
_see_also = ['remove']
383
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
388
if file_ids_from is not None:
390
base_tree, base_path = WorkingTree.open_containing(
392
except errors.NoWorkingTree:
393
base_branch, base_path = Branch.open_containing(
395
base_tree = base_branch.basis_tree()
397
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
398
to_file=self.outf, should_print=(not is_quiet()))
400
action = bzrlib.add.AddAction(to_file=self.outf,
401
should_print=(not is_quiet()))
404
base_tree.lock_read()
406
file_list = self._maybe_expand_globs(file_list)
408
tree = WorkingTree.open_containing(file_list[0])[0]
410
tree = WorkingTree.open_containing(u'.')[0]
411
added, ignored = tree.smart_add(file_list, not
412
no_recurse, action=action, save=not dry_run)
414
if base_tree is not None:
418
for glob in sorted(ignored.keys()):
419
for path in ignored[glob]:
420
self.outf.write("ignored %s matching \"%s\"\n"
424
for glob, paths in ignored.items():
425
match_len += len(paths)
426
self.outf.write("ignored %d file(s).\n" % match_len)
427
self.outf.write("If you wish to add some of these files,"
428
" please add them by name.\n")
431
class cmd_mkdir(Command):
432
"""Create a new versioned directory.
434
This is equivalent to creating the directory and then adding it.
437
takes_args = ['dir+']
438
encoding_type = 'replace'
440
def run(self, dir_list):
443
wt, dd = WorkingTree.open_containing(d)
445
self.outf.write('added %s\n' % d)
448
class cmd_relpath(Command):
449
"""Show path of a file relative to root"""
451
takes_args = ['filename']
455
def run(self, filename):
456
# TODO: jam 20050106 Can relpath return a munged path if
457
# sys.stdout encoding cannot represent it?
458
tree, relpath = WorkingTree.open_containing(filename)
459
self.outf.write(relpath)
460
self.outf.write('\n')
463
class cmd_inventory(Command):
464
"""Show inventory of the current working copy or a revision.
466
It is possible to limit the output to a particular entry
467
type using the --kind option. For example: --kind file.
469
It is also possible to restrict the list of files to a specific
470
set. For example: bzr inventory --show-ids this/file
479
help='List entries of a particular kind: file, directory, symlink.',
482
takes_args = ['file*']
485
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
486
if kind and kind not in ['file', 'directory', 'symlink']:
487
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
489
work_tree, file_list = tree_files(file_list)
490
work_tree.lock_read()
492
if revision is not None:
493
if len(revision) > 1:
494
raise errors.BzrCommandError(
495
'bzr inventory --revision takes exactly one revision'
497
tree = revision[0].as_tree(work_tree.branch)
499
extra_trees = [work_tree]
505
if file_list is not None:
506
file_ids = tree.paths2ids(file_list, trees=extra_trees,
507
require_versioned=True)
508
# find_ids_across_trees may include some paths that don't
510
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
511
for file_id in file_ids if file_id in tree)
513
entries = tree.inventory.entries()
516
if tree is not work_tree:
519
for path, entry in entries:
520
if kind and kind != entry.kind:
523
self.outf.write('%-50s %s\n' % (path, entry.file_id))
525
self.outf.write(path)
526
self.outf.write('\n')
529
class cmd_mv(Command):
530
"""Move or rename a file.
533
bzr mv OLDNAME NEWNAME
535
bzr mv SOURCE... DESTINATION
537
If the last argument is a versioned directory, all the other names
538
are moved into it. Otherwise, there must be exactly two arguments
539
and the file is changed to a new name.
541
If OLDNAME does not exist on the filesystem but is versioned and
542
NEWNAME does exist on the filesystem but is not versioned, mv
543
assumes that the file has been manually moved and only updates
544
its internal inventory to reflect that change.
545
The same is valid when moving many SOURCE files to a DESTINATION.
547
Files cannot be moved between branches.
550
takes_args = ['names*']
551
takes_options = [Option("after", help="Move only the bzr identifier"
552
" of the file, because the file has already been moved."),
554
aliases = ['move', 'rename']
555
encoding_type = 'replace'
557
def run(self, names_list, after=False):
558
if names_list is None:
561
if len(names_list) < 2:
562
raise errors.BzrCommandError("missing file argument")
563
tree, rel_names = tree_files(names_list)
566
self._run(tree, names_list, rel_names, after)
570
def _run(self, tree, names_list, rel_names, after):
571
into_existing = osutils.isdir(names_list[-1])
572
if into_existing and len(names_list) == 2:
574
# a. case-insensitive filesystem and change case of dir
575
# b. move directory after the fact (if the source used to be
576
# a directory, but now doesn't exist in the working tree
577
# and the target is an existing directory, just rename it)
578
if (not tree.case_sensitive
579
and rel_names[0].lower() == rel_names[1].lower()):
580
into_existing = False
583
from_id = tree.path2id(rel_names[0])
584
if (not osutils.lexists(names_list[0]) and
585
from_id and inv.get_file_kind(from_id) == "directory"):
586
into_existing = False
589
# move into existing directory
590
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
591
self.outf.write("%s => %s\n" % pair)
593
if len(names_list) != 2:
594
raise errors.BzrCommandError('to mv multiple files the'
595
' destination must be a versioned'
597
tree.rename_one(rel_names[0], rel_names[1], after=after)
598
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
601
class cmd_pull(Command):
602
"""Turn this branch into a mirror of another branch.
604
This command only works on branches that have not diverged. Branches are
605
considered diverged if the destination branch's most recent commit is one
606
that has not been merged (directly or indirectly) into the parent.
608
If branches have diverged, you can use 'bzr merge' to integrate the changes
609
from one into the other. Once one branch has merged, the other should
610
be able to pull it again.
612
If you want to forget your local changes and just update your branch to
613
match the remote one, use pull --overwrite.
615
If there is no default location set, the first pull will set it. After
616
that, you can omit the location to use the default. To change the
617
default, use --remember. The value will only be saved if the remote
618
location can be accessed.
620
Note: The location can be specified either in the form of a branch,
621
or in the form of a path to a file containing a merge directive generated
625
_see_also = ['push', 'update', 'status-flags']
626
takes_options = ['remember', 'overwrite', 'revision',
627
custom_help('verbose',
628
help='Show logs of pulled revisions.'),
630
help='Branch to pull into, '
631
'rather than the one containing the working directory.',
636
takes_args = ['location?']
637
encoding_type = 'replace'
639
def run(self, location=None, remember=False, overwrite=False,
640
revision=None, verbose=False,
642
# FIXME: too much stuff is in the command class
645
if directory is None:
648
tree_to = WorkingTree.open_containing(directory)[0]
649
branch_to = tree_to.branch
650
except errors.NoWorkingTree:
652
branch_to = Branch.open_containing(directory)[0]
654
possible_transports = []
655
if location is not None:
657
mergeable = bundle.read_mergeable_from_url(location,
658
possible_transports=possible_transports)
659
except errors.NotABundle:
662
stored_loc = branch_to.get_parent()
664
if stored_loc is None:
665
raise errors.BzrCommandError("No pull location known or"
668
display_url = urlutils.unescape_for_display(stored_loc,
671
self.outf.write("Using saved parent location: %s\n" % display_url)
672
location = stored_loc
674
if mergeable is not None:
675
if revision is not None:
676
raise errors.BzrCommandError(
677
'Cannot use -r with merge directives or bundles')
678
mergeable.install_revisions(branch_to.repository)
679
base_revision_id, revision_id, verified = \
680
mergeable.get_merge_request(branch_to.repository)
681
branch_from = branch_to
683
branch_from = Branch.open(location,
684
possible_transports=possible_transports)
686
if branch_to.get_parent() is None or remember:
687
branch_to.set_parent(branch_from.base)
689
if revision is not None:
690
if len(revision) == 1:
691
revision_id = revision[0].as_revision_id(branch_from)
693
raise errors.BzrCommandError(
694
'bzr pull --revision takes one value.')
696
branch_to.lock_write()
698
if tree_to is not None:
699
change_reporter = delta._ChangeReporter(
700
unversioned_filter=tree_to.is_ignored)
701
result = tree_to.pull(branch_from, overwrite, revision_id,
703
possible_transports=possible_transports)
705
result = branch_to.pull(branch_from, overwrite, revision_id)
707
result.report(self.outf)
708
if verbose and result.old_revid != result.new_revid:
710
branch_to.repository.iter_reverse_revision_history(
713
new_rh = branch_to.revision_history()
714
log.show_changed_revisions(branch_to, old_rh, new_rh,
720
class cmd_push(Command):
721
"""Update a mirror of this branch.
723
The target branch will not have its working tree populated because this
724
is both expensive, and is not supported on remote file systems.
726
Some smart servers or protocols *may* put the working tree in place in
729
This command only works on branches that have not diverged. Branches are
730
considered diverged if the destination branch's most recent commit is one
731
that has not been merged (directly or indirectly) by the source branch.
733
If branches have diverged, you can use 'bzr push --overwrite' to replace
734
the other branch completely, discarding its unmerged changes.
736
If you want to ensure you have the different changes in the other branch,
737
do a merge (see bzr help merge) from the other branch, and commit that.
738
After that you will be able to do a push without '--overwrite'.
740
If there is no default push location set, the first push will set it.
741
After that, you can omit the location to use the default. To change the
742
default, use --remember. The value will only be saved if the remote
743
location can be accessed.
746
_see_also = ['pull', 'update', 'working-trees']
747
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
748
Option('create-prefix',
749
help='Create the path leading up to the branch '
750
'if it does not already exist.'),
752
help='Branch to push from, '
753
'rather than the one containing the working directory.',
757
Option('use-existing-dir',
758
help='By default push will fail if the target'
759
' directory exists, but does not already'
760
' have a control directory. This flag will'
761
' allow push to proceed.'),
763
help='Create a stacked branch that references the public location '
764
'of the parent branch.'),
766
help='Create a stacked branch that refers to another branch '
767
'for the commit history. Only the work not present in the '
768
'referenced branch is included in the branch created.',
771
takes_args = ['location?']
772
encoding_type = 'replace'
774
def run(self, location=None, remember=False, overwrite=False,
775
create_prefix=False, verbose=False, revision=None,
776
use_existing_dir=False, directory=None, stacked_on=None,
778
from bzrlib.push import _show_push_branch
780
# Get the source branch and revision_id
781
if directory is None:
783
br_from = Branch.open_containing(directory)[0]
784
if revision is not None:
785
if len(revision) == 1:
786
revision_id = revision[0].in_history(br_from).rev_id
788
raise errors.BzrCommandError(
789
'bzr push --revision takes one value.')
791
revision_id = br_from.last_revision()
793
# Get the stacked_on branch, if any
794
if stacked_on is not None:
795
stacked_on = urlutils.normalize_url(stacked_on)
797
parent_url = br_from.get_parent()
799
parent = Branch.open(parent_url)
800
stacked_on = parent.get_public_branch()
802
# I considered excluding non-http url's here, thus forcing
803
# 'public' branches only, but that only works for some
804
# users, so it's best to just depend on the user spotting an
805
# error by the feedback given to them. RBC 20080227.
806
stacked_on = parent_url
808
raise errors.BzrCommandError(
809
"Could not determine branch to refer to.")
811
# Get the destination location
813
stored_loc = br_from.get_push_location()
814
if stored_loc is None:
815
raise errors.BzrCommandError(
816
"No push location known or specified.")
818
display_url = urlutils.unescape_for_display(stored_loc,
820
self.outf.write("Using saved push location: %s\n" % display_url)
821
location = stored_loc
823
_show_push_branch(br_from, revision_id, location, self.outf,
824
verbose=verbose, overwrite=overwrite, remember=remember,
825
stacked_on=stacked_on, create_prefix=create_prefix,
826
use_existing_dir=use_existing_dir)
829
class cmd_branch(Command):
830
"""Create a new copy of a branch.
832
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
833
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
834
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
835
is derived from the FROM_LOCATION by stripping a leading scheme or drive
836
identifier, if any. For example, "branch lp:foo-bar" will attempt to
839
To retrieve the branch as of a particular revision, supply the --revision
840
parameter, as in "branch foo/bar -r 5".
843
_see_also = ['checkout']
844
takes_args = ['from_location', 'to_location?']
845
takes_options = ['revision', Option('hardlink',
846
help='Hard-link working tree files where possible.'),
848
help='Create a stacked branch referring to the source branch. '
849
'The new branch will depend on the availability of the source '
850
'branch for all operations.'),
852
aliases = ['get', 'clone']
854
def run(self, from_location, to_location=None, revision=None,
855
hardlink=False, stacked=False):
856
from bzrlib.tag import _merge_tags_if_possible
859
elif len(revision) > 1:
860
raise errors.BzrCommandError(
861
'bzr branch --revision takes exactly 1 revision value')
863
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
867
if len(revision) == 1 and revision[0] is not None:
868
revision_id = revision[0].as_revision_id(br_from)
870
# FIXME - wt.last_revision, fallback to branch, fall back to
871
# None or perhaps NULL_REVISION to mean copy nothing
873
revision_id = br_from.last_revision()
874
if to_location is None:
875
to_location = urlutils.derive_to_location(from_location)
876
to_transport = transport.get_transport(to_location)
878
to_transport.mkdir('.')
879
except errors.FileExists:
880
raise errors.BzrCommandError('Target directory "%s" already'
881
' exists.' % to_location)
882
except errors.NoSuchFile:
883
raise errors.BzrCommandError('Parent of "%s" does not exist.'
886
# preserve whatever source format we have.
887
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
888
possible_transports=[to_transport],
889
accelerator_tree=accelerator_tree,
890
hardlink=hardlink, stacked=stacked)
891
branch = dir.open_branch()
892
except errors.NoSuchRevision:
893
to_transport.delete_tree('.')
894
msg = "The branch %s has no revision %s." % (from_location,
896
raise errors.BzrCommandError(msg)
897
_merge_tags_if_possible(br_from, branch)
898
# If the source branch is stacked, the new branch may
899
# be stacked whether we asked for that explicitly or not.
900
# We therefore need a try/except here and not just 'if stacked:'
902
note('Created new stacked branch referring to %s.' %
903
branch.get_stacked_on_url())
904
except (errors.NotStacked, errors.UnstackableBranchFormat,
905
errors.UnstackableRepositoryFormat), e:
906
note('Branched %d revision(s).' % branch.revno())
911
class cmd_checkout(Command):
912
"""Create a new checkout of an existing branch.
914
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
915
the branch found in '.'. This is useful if you have removed the working tree
916
or if it was never created - i.e. if you pushed the branch to its current
919
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
920
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
921
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
922
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
923
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
926
To retrieve the branch as of a particular revision, supply the --revision
927
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
928
out of date [so you cannot commit] but it may be useful (i.e. to examine old
932
_see_also = ['checkouts', 'branch']
933
takes_args = ['branch_location?', 'to_location?']
934
takes_options = ['revision',
935
Option('lightweight',
936
help="Perform a lightweight checkout. Lightweight "
937
"checkouts depend on access to the branch for "
938
"every operation. Normal checkouts can perform "
939
"common operations like diff and status without "
940
"such access, and also support local commits."
942
Option('files-from', type=str,
943
help="Get file contents from this tree."),
945
help='Hard-link working tree files where possible.'
950
def run(self, branch_location=None, to_location=None, revision=None,
951
lightweight=False, files_from=None, hardlink=False):
954
elif len(revision) > 1:
955
raise errors.BzrCommandError(
956
'bzr checkout --revision takes exactly 1 revision value')
957
if branch_location is None:
958
branch_location = osutils.getcwd()
959
to_location = branch_location
960
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
962
if files_from is not None:
963
accelerator_tree = WorkingTree.open(files_from)
964
if len(revision) == 1 and revision[0] is not None:
965
revision_id = revision[0].as_revision_id(source)
968
if to_location is None:
969
to_location = urlutils.derive_to_location(branch_location)
970
# if the source and to_location are the same,
971
# and there is no working tree,
972
# then reconstitute a branch
973
if (osutils.abspath(to_location) ==
974
osutils.abspath(branch_location)):
976
source.bzrdir.open_workingtree()
977
except errors.NoWorkingTree:
978
source.bzrdir.create_workingtree(revision_id)
980
source.create_checkout(to_location, revision_id, lightweight,
981
accelerator_tree, hardlink)
984
class cmd_renames(Command):
985
"""Show list of renamed files.
987
# TODO: Option to show renames between two historical versions.
989
# TODO: Only show renames under dir, rather than in the whole branch.
990
_see_also = ['status']
991
takes_args = ['dir?']
994
def run(self, dir=u'.'):
995
tree = WorkingTree.open_containing(dir)[0]
998
new_inv = tree.inventory
999
old_tree = tree.basis_tree()
1000
old_tree.lock_read()
1002
old_inv = old_tree.inventory
1003
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1005
for old_name, new_name in renames:
1006
self.outf.write("%s => %s\n" % (old_name, new_name))
1013
class cmd_update(Command):
1014
"""Update a tree to have the latest code committed to its branch.
1016
This will perform a merge into the working tree, and may generate
1017
conflicts. If you have any local changes, you will still
1018
need to commit them after the update for the update to be complete.
1020
If you want to discard your local changes, you can just do a
1021
'bzr revert' instead of 'bzr commit' after the update.
1024
_see_also = ['pull', 'working-trees', 'status-flags']
1025
takes_args = ['dir?']
1028
def run(self, dir='.'):
1029
tree = WorkingTree.open_containing(dir)[0]
1030
possible_transports = []
1031
master = tree.branch.get_master_branch(
1032
possible_transports=possible_transports)
1033
if master is not None:
1036
tree.lock_tree_write()
1038
existing_pending_merges = tree.get_parent_ids()[1:]
1039
last_rev = _mod_revision.ensure_null(tree.last_revision())
1040
if last_rev == _mod_revision.ensure_null(
1041
tree.branch.last_revision()):
1042
# may be up to date, check master too.
1043
if master is None or last_rev == _mod_revision.ensure_null(
1044
master.last_revision()):
1045
revno = tree.branch.revision_id_to_revno(last_rev)
1046
note("Tree is up to date at revision %d." % (revno,))
1048
conflicts = tree.update(
1049
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1050
possible_transports=possible_transports)
1051
revno = tree.branch.revision_id_to_revno(
1052
_mod_revision.ensure_null(tree.last_revision()))
1053
note('Updated to revision %d.' % (revno,))
1054
if tree.get_parent_ids()[1:] != existing_pending_merges:
1055
note('Your local commits will now show as pending merges with '
1056
"'bzr status', and can be committed with 'bzr commit'.")
1065
class cmd_info(Command):
1066
"""Show information about a working tree, branch or repository.
1068
This command will show all known locations and formats associated to the
1069
tree, branch or repository. Statistical information is included with
1072
Branches and working trees will also report any missing revisions.
1074
_see_also = ['revno', 'working-trees', 'repositories']
1075
takes_args = ['location?']
1076
takes_options = ['verbose']
1077
encoding_type = 'replace'
1080
def run(self, location=None, verbose=False):
1085
from bzrlib.info import show_bzrdir_info
1086
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1087
verbose=noise_level, outfile=self.outf)
1090
class cmd_remove(Command):
1091
"""Remove files or directories.
1093
This makes bzr stop tracking changes to the specified files. bzr will delete
1094
them if they can easily be recovered using revert. If no options or
1095
parameters are given bzr will scan for files that are being tracked by bzr
1096
but missing in your tree and stop tracking them for you.
1098
takes_args = ['file*']
1099
takes_options = ['verbose',
1100
Option('new', help='Only remove files that have never been committed.'),
1101
RegistryOption.from_kwargs('file-deletion-strategy',
1102
'The file deletion mode to be used.',
1103
title='Deletion Strategy', value_switches=True, enum_switch=False,
1104
safe='Only delete files if they can be'
1105
' safely recovered (default).',
1106
keep="Don't delete any files.",
1107
force='Delete all the specified files, even if they can not be '
1108
'recovered and even if they are non-empty directories.')]
1109
aliases = ['rm', 'del']
1110
encoding_type = 'replace'
1112
def run(self, file_list, verbose=False, new=False,
1113
file_deletion_strategy='safe'):
1114
tree, file_list = tree_files(file_list)
1116
if file_list is not None:
1117
file_list = [f for f in file_list]
1121
# Heuristics should probably all move into tree.remove_smart or
1124
added = tree.changes_from(tree.basis_tree(),
1125
specific_files=file_list).added
1126
file_list = sorted([f[0] for f in added], reverse=True)
1127
if len(file_list) == 0:
1128
raise errors.BzrCommandError('No matching files.')
1129
elif file_list is None:
1130
# missing files show up in iter_changes(basis) as
1131
# versioned-with-no-kind.
1133
for change in tree.iter_changes(tree.basis_tree()):
1134
# Find paths in the working tree that have no kind:
1135
if change[1][1] is not None and change[6][1] is None:
1136
missing.append(change[1][1])
1137
file_list = sorted(missing, reverse=True)
1138
file_deletion_strategy = 'keep'
1139
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1140
keep_files=file_deletion_strategy=='keep',
1141
force=file_deletion_strategy=='force')
1146
class cmd_file_id(Command):
1147
"""Print file_id of a particular file or directory.
1149
The file_id is assigned when the file is first added and remains the
1150
same through all revisions where the file exists, even when it is
1155
_see_also = ['inventory', 'ls']
1156
takes_args = ['filename']
1159
def run(self, filename):
1160
tree, relpath = WorkingTree.open_containing(filename)
1161
i = tree.path2id(relpath)
1163
raise errors.NotVersionedError(filename)
1165
self.outf.write(i + '\n')
1168
class cmd_file_path(Command):
1169
"""Print path of file_ids to a file or directory.
1171
This prints one line for each directory down to the target,
1172
starting at the branch root.
1176
takes_args = ['filename']
1179
def run(self, filename):
1180
tree, relpath = WorkingTree.open_containing(filename)
1181
fid = tree.path2id(relpath)
1183
raise errors.NotVersionedError(filename)
1184
segments = osutils.splitpath(relpath)
1185
for pos in range(1, len(segments) + 1):
1186
path = osutils.joinpath(segments[:pos])
1187
self.outf.write("%s\n" % tree.path2id(path))
1190
class cmd_reconcile(Command):
1191
"""Reconcile bzr metadata in a branch.
1193
This can correct data mismatches that may have been caused by
1194
previous ghost operations or bzr upgrades. You should only
1195
need to run this command if 'bzr check' or a bzr developer
1196
advises you to run it.
1198
If a second branch is provided, cross-branch reconciliation is
1199
also attempted, which will check that data like the tree root
1200
id which was not present in very early bzr versions is represented
1201
correctly in both branches.
1203
At the same time it is run it may recompress data resulting in
1204
a potential saving in disk space or performance gain.
1206
The branch *MUST* be on a listable system such as local disk or sftp.
1209
_see_also = ['check']
1210
takes_args = ['branch?']
1212
def run(self, branch="."):
1213
from bzrlib.reconcile import reconcile
1214
dir = bzrdir.BzrDir.open(branch)
1218
class cmd_revision_history(Command):
1219
"""Display the list of revision ids on a branch."""
1222
takes_args = ['location?']
1227
def run(self, location="."):
1228
branch = Branch.open_containing(location)[0]
1229
for revid in branch.revision_history():
1230
self.outf.write(revid)
1231
self.outf.write('\n')
1234
class cmd_ancestry(Command):
1235
"""List all revisions merged into this branch."""
1237
_see_also = ['log', 'revision-history']
1238
takes_args = ['location?']
1243
def run(self, location="."):
1245
wt = WorkingTree.open_containing(location)[0]
1246
except errors.NoWorkingTree:
1247
b = Branch.open(location)
1248
last_revision = b.last_revision()
1251
last_revision = wt.last_revision()
1253
revision_ids = b.repository.get_ancestry(last_revision)
1255
for revision_id in revision_ids:
1256
self.outf.write(revision_id + '\n')
1259
class cmd_init(Command):
1260
"""Make a directory into a versioned branch.
1262
Use this to create an empty branch, or before importing an
1265
If there is a repository in a parent directory of the location, then
1266
the history of the branch will be stored in the repository. Otherwise
1267
init creates a standalone branch which carries its own history
1268
in the .bzr directory.
1270
If there is already a branch at the location but it has no working tree,
1271
the tree can be populated with 'bzr checkout'.
1273
Recipe for importing a tree of files::
1279
bzr commit -m "imported project"
1282
_see_also = ['init-repository', 'branch', 'checkout']
1283
takes_args = ['location?']
1285
Option('create-prefix',
1286
help='Create the path leading up to the branch '
1287
'if it does not already exist.'),
1288
RegistryOption('format',
1289
help='Specify a format for this branch. '
1290
'See "help formats".',
1291
registry=bzrdir.format_registry,
1292
converter=bzrdir.format_registry.make_bzrdir,
1293
value_switches=True,
1294
title="Branch Format",
1296
Option('append-revisions-only',
1297
help='Never change revnos or the existing log.'
1298
' Append revisions to it only.')
1300
def run(self, location=None, format=None, append_revisions_only=False,
1301
create_prefix=False):
1303
format = bzrdir.format_registry.make_bzrdir('default')
1304
if location is None:
1307
to_transport = transport.get_transport(location)
1309
# The path has to exist to initialize a
1310
# branch inside of it.
1311
# Just using os.mkdir, since I don't
1312
# believe that we want to create a bunch of
1313
# locations if the user supplies an extended path
1315
to_transport.ensure_base()
1316
except errors.NoSuchFile:
1317
if not create_prefix:
1318
raise errors.BzrCommandError("Parent directory of %s"
1320
"\nYou may supply --create-prefix to create all"
1321
" leading parent directories."
1323
_create_prefix(to_transport)
1326
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1327
except errors.NotBranchError:
1328
# really a NotBzrDir error...
1329
create_branch = bzrdir.BzrDir.create_branch_convenience
1330
branch = create_branch(to_transport.base, format=format,
1331
possible_transports=[to_transport])
1333
from bzrlib.transport.local import LocalTransport
1334
if existing_bzrdir.has_branch():
1335
if (isinstance(to_transport, LocalTransport)
1336
and not existing_bzrdir.has_workingtree()):
1337
raise errors.BranchExistsWithoutWorkingTree(location)
1338
raise errors.AlreadyBranchError(location)
1340
branch = existing_bzrdir.create_branch()
1341
existing_bzrdir.create_workingtree()
1342
if append_revisions_only:
1344
branch.set_append_revisions_only(True)
1345
except errors.UpgradeRequired:
1346
raise errors.BzrCommandError('This branch format cannot be set'
1347
' to append-revisions-only. Try --experimental-branch6')
1349
from bzrlib.info import show_bzrdir_info
1350
show_bzrdir_info(bzrdir.BzrDir.open_containing_from_transport(
1351
to_transport)[0], verbose=0, outfile=self.outf)
1354
class cmd_init_repository(Command):
1355
"""Create a shared repository to hold branches.
1357
New branches created under the repository directory will store their
1358
revisions in the repository, not in the branch directory.
1360
If the --no-trees option is used then the branches in the repository
1361
will not have working trees by default.
1364
Create a shared repositories holding just branches::
1366
bzr init-repo --no-trees repo
1369
Make a lightweight checkout elsewhere::
1371
bzr checkout --lightweight repo/trunk trunk-checkout
1376
_see_also = ['init', 'branch', 'checkout', 'repositories']
1377
takes_args = ["location"]
1378
takes_options = [RegistryOption('format',
1379
help='Specify a format for this repository. See'
1380
' "bzr help formats" for details.',
1381
registry=bzrdir.format_registry,
1382
converter=bzrdir.format_registry.make_bzrdir,
1383
value_switches=True, title='Repository format'),
1385
help='Branches in the repository will default to'
1386
' not having a working tree.'),
1388
aliases = ["init-repo"]
1390
def run(self, location, format=None, no_trees=False):
1392
format = bzrdir.format_registry.make_bzrdir('default')
1394
if location is None:
1397
to_transport = transport.get_transport(location)
1398
to_transport.ensure_base()
1400
newdir = format.initialize_on_transport(to_transport)
1401
repo = newdir.create_repository(shared=True)
1402
repo.set_make_working_trees(not no_trees)
1404
from bzrlib.info import show_bzrdir_info
1405
show_bzrdir_info(bzrdir.BzrDir.open_containing_from_transport(
1406
to_transport)[0], verbose=0, outfile=self.outf)
1409
class cmd_diff(Command):
1410
"""Show differences in the working tree, between revisions or branches.
1412
If no arguments are given, all changes for the current tree are listed.
1413
If files are given, only the changes in those files are listed.
1414
Remote and multiple branches can be compared by using the --old and
1415
--new options. If not provided, the default for both is derived from
1416
the first argument, if any, or the current tree if no arguments are
1419
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1420
produces patches suitable for "patch -p1".
1424
2 - unrepresentable changes
1429
Shows the difference in the working tree versus the last commit::
1433
Difference between the working tree and revision 1::
1437
Difference between revision 2 and revision 1::
1441
Difference between revision 2 and revision 1 for branch xxx::
1445
Show just the differences for file NEWS::
1449
Show the differences in working tree xxx for file NEWS::
1453
Show the differences from branch xxx to this working tree:
1457
Show the differences between two branches for file NEWS::
1459
bzr diff --old xxx --new yyy NEWS
1461
Same as 'bzr diff' but prefix paths with old/ and new/::
1463
bzr diff --prefix old/:new/
1465
_see_also = ['status']
1466
takes_args = ['file*']
1468
Option('diff-options', type=str,
1469
help='Pass these options to the external diff program.'),
1470
Option('prefix', type=str,
1472
help='Set prefixes added to old and new filenames, as '
1473
'two values separated by a colon. (eg "old/:new/").'),
1475
help='Branch/tree to compare from.',
1479
help='Branch/tree to compare to.',
1485
help='Use this command to compare files.',
1489
aliases = ['di', 'dif']
1490
encoding_type = 'exact'
1493
def run(self, revision=None, file_list=None, diff_options=None,
1494
prefix=None, old=None, new=None, using=None):
1495
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1497
if (prefix is None) or (prefix == '0'):
1505
old_label, new_label = prefix.split(":")
1507
raise errors.BzrCommandError(
1508
'--prefix expects two values separated by a colon'
1509
' (eg "old/:new/")')
1511
if revision and len(revision) > 2:
1512
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1513
' one or two revision specifiers')
1515
old_tree, new_tree, specific_files, extra_trees = \
1516
_get_trees_to_diff(file_list, revision, old, new)
1517
return show_diff_trees(old_tree, new_tree, sys.stdout,
1518
specific_files=specific_files,
1519
external_diff_options=diff_options,
1520
old_label=old_label, new_label=new_label,
1521
extra_trees=extra_trees, using=using)
1524
class cmd_deleted(Command):
1525
"""List files deleted in the working tree.
1527
# TODO: Show files deleted since a previous revision, or
1528
# between two revisions.
1529
# TODO: Much more efficient way to do this: read in new
1530
# directories with readdir, rather than stating each one. Same
1531
# level of effort but possibly much less IO. (Or possibly not,
1532
# if the directories are very large...)
1533
_see_also = ['status', 'ls']
1534
takes_options = ['show-ids']
1537
def run(self, show_ids=False):
1538
tree = WorkingTree.open_containing(u'.')[0]
1541
old = tree.basis_tree()
1544
for path, ie in old.inventory.iter_entries():
1545
if not tree.has_id(ie.file_id):
1546
self.outf.write(path)
1548
self.outf.write(' ')
1549
self.outf.write(ie.file_id)
1550
self.outf.write('\n')
1557
class cmd_modified(Command):
1558
"""List files modified in working tree.
1562
_see_also = ['status', 'ls']
1565
help='Write an ascii NUL (\\0) separator '
1566
'between files rather than a newline.')
1570
def run(self, null=False):
1571
tree = WorkingTree.open_containing(u'.')[0]
1572
td = tree.changes_from(tree.basis_tree())
1573
for path, id, kind, text_modified, meta_modified in td.modified:
1575
self.outf.write(path + '\0')
1577
self.outf.write(osutils.quotefn(path) + '\n')
1580
class cmd_added(Command):
1581
"""List files added in working tree.
1585
_see_also = ['status', 'ls']
1588
help='Write an ascii NUL (\\0) separator '
1589
'between files rather than a newline.')
1593
def run(self, null=False):
1594
wt = WorkingTree.open_containing(u'.')[0]
1597
basis = wt.basis_tree()
1600
basis_inv = basis.inventory
1603
if file_id in basis_inv:
1605
if inv.is_root(file_id) and len(basis_inv) == 0:
1607
path = inv.id2path(file_id)
1608
if not os.access(osutils.abspath(path), os.F_OK):
1611
self.outf.write(path + '\0')
1613
self.outf.write(osutils.quotefn(path) + '\n')
1620
class cmd_root(Command):
1621
"""Show the tree root directory.
1623
The root is the nearest enclosing directory with a .bzr control
1626
takes_args = ['filename?']
1628
def run(self, filename=None):
1629
"""Print the branch root."""
1630
tree = WorkingTree.open_containing(filename)[0]
1631
self.outf.write(tree.basedir + '\n')
1634
def _parse_limit(limitstring):
1636
return int(limitstring)
1638
msg = "The limit argument must be an integer."
1639
raise errors.BzrCommandError(msg)
1642
class cmd_log(Command):
1643
"""Show log of a branch, file, or directory.
1645
By default show the log of the branch containing the working directory.
1647
To request a range of logs, you can use the command -r begin..end
1648
-r revision requests a specific revision, -r ..end or -r begin.. are
1652
Log the current branch::
1660
Log the last 10 revisions of a branch::
1662
bzr log -r -10.. http://server/branch
1665
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1667
takes_args = ['location?']
1670
help='Show from oldest to newest.'),
1673
help='Display timezone as local, original, or utc.'),
1674
custom_help('verbose',
1675
help='Show files changed in each revision.'),
1681
help='Show revisions whose message matches this '
1682
'regular expression.',
1686
help='Limit the output to the first N revisions.',
1690
encoding_type = 'replace'
1693
def run(self, location=None, timezone='original',
1701
from bzrlib.log import show_log
1702
direction = (forward and 'forward') or 'reverse'
1707
# find the file id to log:
1709
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1713
tree = b.basis_tree()
1714
file_id = tree.path2id(fp)
1716
raise errors.BzrCommandError(
1717
"Path does not have any revision history: %s" %
1721
# FIXME ? log the current subdir only RBC 20060203
1722
if revision is not None \
1723
and len(revision) > 0 and revision[0].get_branch():
1724
location = revision[0].get_branch()
1727
dir, relpath = bzrdir.BzrDir.open_containing(location)
1728
b = dir.open_branch()
1732
if revision is None:
1735
elif len(revision) == 1:
1736
rev1 = rev2 = revision[0].in_history(b)
1737
elif len(revision) == 2:
1738
if revision[1].get_branch() != revision[0].get_branch():
1739
# b is taken from revision[0].get_branch(), and
1740
# show_log will use its revision_history. Having
1741
# different branches will lead to weird behaviors.
1742
raise errors.BzrCommandError(
1743
"Log doesn't accept two revisions in different"
1745
rev1 = revision[0].in_history(b)
1746
rev2 = revision[1].in_history(b)
1748
raise errors.BzrCommandError(
1749
'bzr log --revision takes one or two values.')
1751
if log_format is None:
1752
log_format = log.log_formatter_registry.get_default(b)
1754
lf = log_format(show_ids=show_ids, to_file=self.outf,
1755
show_timezone=timezone)
1761
direction=direction,
1762
start_revision=rev1,
1770
def get_log_format(long=False, short=False, line=False, default='long'):
1771
log_format = default
1775
log_format = 'short'
1781
class cmd_touching_revisions(Command):
1782
"""Return revision-ids which affected a particular file.
1784
A more user-friendly interface is "bzr log FILE".
1788
takes_args = ["filename"]
1791
def run(self, filename):
1792
tree, relpath = WorkingTree.open_containing(filename)
1794
file_id = tree.path2id(relpath)
1795
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1796
self.outf.write("%6d %s\n" % (revno, what))
1799
class cmd_ls(Command):
1800
"""List files in a tree.
1803
_see_also = ['status', 'cat']
1804
takes_args = ['path?']
1805
# TODO: Take a revision or remote path and list that tree instead.
1809
Option('non-recursive',
1810
help='Don\'t recurse into subdirectories.'),
1812
help='Print paths relative to the root of the branch.'),
1813
Option('unknown', help='Print unknown files.'),
1814
Option('versioned', help='Print versioned files.',
1816
Option('ignored', help='Print ignored files.'),
1818
help='Write an ascii NUL (\\0) separator '
1819
'between files rather than a newline.'),
1821
help='List entries of a particular kind: file, directory, symlink.',
1826
def run(self, revision=None, verbose=False,
1827
non_recursive=False, from_root=False,
1828
unknown=False, versioned=False, ignored=False,
1829
null=False, kind=None, show_ids=False, path=None):
1831
if kind and kind not in ('file', 'directory', 'symlink'):
1832
raise errors.BzrCommandError('invalid kind specified')
1834
if verbose and null:
1835
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1836
all = not (unknown or versioned or ignored)
1838
selection = {'I':ignored, '?':unknown, 'V':versioned}
1845
raise errors.BzrCommandError('cannot specify both --from-root'
1849
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1855
if revision is not None or tree is None:
1856
tree = _get_revision_tree('ls', revision, branch=branch)
1860
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1861
if fp.startswith(relpath):
1862
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1863
if non_recursive and '/' in fp:
1865
if not all and not selection[fc]:
1867
if kind is not None and fkind != kind:
1870
kindch = entry.kind_character()
1871
outstring = '%-8s %s%s' % (fc, fp, kindch)
1872
if show_ids and fid is not None:
1873
outstring = "%-50s %s" % (outstring, fid)
1874
self.outf.write(outstring + '\n')
1876
self.outf.write(fp + '\0')
1879
self.outf.write(fid)
1880
self.outf.write('\0')
1888
self.outf.write('%-50s %s\n' % (fp, my_id))
1890
self.outf.write(fp + '\n')
1895
class cmd_unknowns(Command):
1896
"""List unknown files.
1904
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1905
self.outf.write(osutils.quotefn(f) + '\n')
1908
class cmd_ignore(Command):
1909
"""Ignore specified files or patterns.
1911
See ``bzr help patterns`` for details on the syntax of patterns.
1913
To remove patterns from the ignore list, edit the .bzrignore file.
1914
After adding, editing or deleting that file either indirectly by
1915
using this command or directly by using an editor, be sure to commit
1918
Note: ignore patterns containing shell wildcards must be quoted from
1922
Ignore the top level Makefile::
1924
bzr ignore ./Makefile
1926
Ignore class files in all directories::
1928
bzr ignore "*.class"
1930
Ignore .o files under the lib directory::
1932
bzr ignore "lib/**/*.o"
1934
Ignore .o files under the lib directory::
1936
bzr ignore "RE:lib/.*\.o"
1938
Ignore everything but the "debian" toplevel directory::
1940
bzr ignore "RE:(?!debian/).*"
1943
_see_also = ['status', 'ignored', 'patterns']
1944
takes_args = ['name_pattern*']
1946
Option('old-default-rules',
1947
help='Write out the ignore rules bzr < 0.9 always used.')
1950
def run(self, name_pattern_list=None, old_default_rules=None):
1951
from bzrlib import ignores
1952
if old_default_rules is not None:
1953
# dump the rules and exit
1954
for pattern in ignores.OLD_DEFAULTS:
1957
if not name_pattern_list:
1958
raise errors.BzrCommandError("ignore requires at least one "
1959
"NAME_PATTERN or --old-default-rules")
1960
name_pattern_list = [globbing.normalize_pattern(p)
1961
for p in name_pattern_list]
1962
for name_pattern in name_pattern_list:
1963
if (name_pattern[0] == '/' or
1964
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1965
raise errors.BzrCommandError(
1966
"NAME_PATTERN should not be an absolute path")
1967
tree, relpath = WorkingTree.open_containing(u'.')
1968
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
1969
ignored = globbing.Globster(name_pattern_list)
1972
for entry in tree.list_files():
1976
if ignored.match(filename):
1977
matches.append(filename.encode('utf-8'))
1979
if len(matches) > 0:
1980
print "Warning: the following files are version controlled and" \
1981
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1984
class cmd_ignored(Command):
1985
"""List ignored files and the patterns that matched them.
1987
List all the ignored files and the ignore pattern that caused the file to
1990
Alternatively, to list just the files::
1995
encoding_type = 'replace'
1996
_see_also = ['ignore', 'ls']
2000
tree = WorkingTree.open_containing(u'.')[0]
2003
for path, file_class, kind, file_id, entry in tree.list_files():
2004
if file_class != 'I':
2006
## XXX: Slightly inefficient since this was already calculated
2007
pat = tree.is_ignored(path)
2008
self.outf.write('%-50s %s\n' % (path, pat))
2013
class cmd_lookup_revision(Command):
2014
"""Lookup the revision-id from a revision-number
2017
bzr lookup-revision 33
2020
takes_args = ['revno']
2023
def run(self, revno):
2027
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2029
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2032
class cmd_export(Command):
2033
"""Export current or past revision to a destination directory or archive.
2035
If no revision is specified this exports the last committed revision.
2037
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2038
given, try to find the format with the extension. If no extension
2039
is found exports to a directory (equivalent to --format=dir).
2041
If root is supplied, it will be used as the root directory inside
2042
container formats (tar, zip, etc). If it is not supplied it will default
2043
to the exported filename. The root option has no effect for 'dir' format.
2045
If branch is omitted then the branch containing the current working
2046
directory will be used.
2048
Note: Export of tree with non-ASCII filenames to zip is not supported.
2050
================= =========================
2051
Supported formats Autodetected by extension
2052
================= =========================
2055
tbz2 .tar.bz2, .tbz2
2058
================= =========================
2060
takes_args = ['dest', 'branch_or_subdir?']
2063
help="Type of file to export to.",
2068
help="Name of the root directory inside the exported file."),
2070
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2072
from bzrlib.export import export
2074
if branch_or_subdir is None:
2075
tree = WorkingTree.open_containing(u'.')[0]
2079
b, subdir = Branch.open_containing(branch_or_subdir)
2082
rev_tree = _get_revision_tree('export', revision, branch=b, tree=tree)
2084
export(rev_tree, dest, format, root, subdir)
2085
except errors.NoSuchExportFormat, e:
2086
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2089
class cmd_cat(Command):
2090
"""Write the contents of a file as of a given revision to standard output.
2092
If no revision is nominated, the last revision is used.
2094
Note: Take care to redirect standard output when using this command on a
2100
Option('name-from-revision', help='The path name in the old tree.'),
2103
takes_args = ['filename']
2104
encoding_type = 'exact'
2107
def run(self, filename, revision=None, name_from_revision=False):
2108
if revision is not None and len(revision) != 1:
2109
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2110
" one revision specifier")
2111
tree, branch, relpath = \
2112
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2115
return self._run(tree, branch, relpath, filename, revision,
2120
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2122
tree = b.basis_tree()
2123
rev_tree = _get_revision_tree('cat', revision, branch=b)
2125
cur_file_id = tree.path2id(relpath)
2126
old_file_id = rev_tree.path2id(relpath)
2128
if name_from_revision:
2129
if old_file_id is None:
2130
raise errors.BzrCommandError(
2131
"%r is not present in revision %s" % (
2132
filename, rev_tree.get_revision_id()))
2134
content = rev_tree.get_file_text(old_file_id)
2135
elif cur_file_id is not None:
2136
content = rev_tree.get_file_text(cur_file_id)
2137
elif old_file_id is not None:
2138
content = rev_tree.get_file_text(old_file_id)
2140
raise errors.BzrCommandError(
2141
"%r is not present in revision %s" % (
2142
filename, rev_tree.get_revision_id()))
2143
self.outf.write(content)
2146
class cmd_local_time_offset(Command):
2147
"""Show the offset in seconds from GMT to local time."""
2151
print osutils.local_time_offset()
2155
class cmd_commit(Command):
2156
"""Commit changes into a new revision.
2158
If no arguments are given, the entire tree is committed.
2160
If selected files are specified, only changes to those files are
2161
committed. If a directory is specified then the directory and everything
2162
within it is committed.
2164
When excludes are given, they take precedence over selected files.
2165
For example, too commit only changes within foo, but not changes within
2168
bzr commit foo -x foo/bar
2170
If author of the change is not the same person as the committer, you can
2171
specify the author's name using the --author option. The name should be
2172
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2174
A selected-file commit may fail in some cases where the committed
2175
tree would be invalid. Consider::
2180
bzr commit foo -m "committing foo"
2181
bzr mv foo/bar foo/baz
2184
bzr commit foo/bar -m "committing bar but not baz"
2186
In the example above, the last commit will fail by design. This gives
2187
the user the opportunity to decide whether they want to commit the
2188
rename at the same time, separately first, or not at all. (As a general
2189
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2191
Note: A selected-file commit after a merge is not yet supported.
2193
# TODO: Run hooks on tree to-be-committed, and after commit.
2195
# TODO: Strict commit that fails if there are deleted files.
2196
# (what does "deleted files" mean ??)
2198
# TODO: Give better message for -s, --summary, used by tla people
2200
# XXX: verbose currently does nothing
2202
_see_also = ['bugs', 'uncommit']
2203
takes_args = ['selected*']
2205
ListOption('exclude', type=str, short_name='x',
2206
help="Do not consider changes made to a given path."),
2207
Option('message', type=unicode,
2209
help="Description of the new revision."),
2212
help='Commit even if nothing has changed.'),
2213
Option('file', type=str,
2216
help='Take commit message from this file.'),
2218
help="Refuse to commit if there are unknown "
2219
"files in the working tree."),
2220
ListOption('fixes', type=str,
2221
help="Mark a bug as being fixed by this revision."),
2222
Option('author', type=unicode,
2223
help="Set the author's name, if it's different "
2224
"from the committer."),
2226
help="Perform a local commit in a bound "
2227
"branch. Local commits are not pushed to "
2228
"the master branch until a normal commit "
2232
help='When no message is supplied, show the diff along'
2233
' with the status summary in the message editor.'),
2235
aliases = ['ci', 'checkin']
2237
def _get_bug_fix_properties(self, fixes, branch):
2239
# Configure the properties for bug fixing attributes.
2240
for fixed_bug in fixes:
2241
tokens = fixed_bug.split(':')
2242
if len(tokens) != 2:
2243
raise errors.BzrCommandError(
2244
"Invalid bug %s. Must be in the form of 'tag:id'. "
2245
"Commit refused." % fixed_bug)
2246
tag, bug_id = tokens
2248
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2249
except errors.UnknownBugTrackerAbbreviation:
2250
raise errors.BzrCommandError(
2251
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2252
except errors.MalformedBugIdentifier:
2253
raise errors.BzrCommandError(
2254
"Invalid bug identifier for %s. Commit refused."
2256
properties.append('%s fixed' % bug_url)
2257
return '\n'.join(properties)
2259
def run(self, message=None, file=None, verbose=False, selected_list=None,
2260
unchanged=False, strict=False, local=False, fixes=None,
2261
author=None, show_diff=False, exclude=None):
2262
from bzrlib.errors import (
2267
from bzrlib.msgeditor import (
2268
edit_commit_message_encoded,
2269
make_commit_message_template_encoded
2272
# TODO: Need a blackbox test for invoking the external editor; may be
2273
# slightly problematic to run this cross-platform.
2275
# TODO: do more checks that the commit will succeed before
2276
# spending the user's valuable time typing a commit message.
2280
tree, selected_list = tree_files(selected_list)
2281
if selected_list == ['']:
2282
# workaround - commit of root of tree should be exactly the same
2283
# as just default commit in that tree, and succeed even though
2284
# selected-file merge commit is not done yet
2289
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2291
properties['bugs'] = bug_property
2293
if local and not tree.branch.get_bound_location():
2294
raise errors.LocalRequiresBoundBranch()
2296
def get_message(commit_obj):
2297
"""Callback to get commit message"""
2298
my_message = message
2299
if my_message is None and not file:
2300
t = make_commit_message_template_encoded(tree,
2301
selected_list, diff=show_diff,
2302
output_encoding=bzrlib.user_encoding)
2303
my_message = edit_commit_message_encoded(t)
2304
if my_message is None:
2305
raise errors.BzrCommandError("please specify a commit"
2306
" message with either --message or --file")
2307
elif my_message and file:
2308
raise errors.BzrCommandError(
2309
"please specify either --message or --file")
2311
my_message = codecs.open(file, 'rt',
2312
bzrlib.user_encoding).read()
2313
if my_message == "":
2314
raise errors.BzrCommandError("empty commit message specified")
2318
tree.commit(message_callback=get_message,
2319
specific_files=selected_list,
2320
allow_pointless=unchanged, strict=strict, local=local,
2321
reporter=None, verbose=verbose, revprops=properties,
2323
exclude=safe_relpath_files(tree, exclude))
2324
except PointlessCommit:
2325
# FIXME: This should really happen before the file is read in;
2326
# perhaps prepare the commit; get the message; then actually commit
2327
raise errors.BzrCommandError("no changes to commit."
2328
" use --unchanged to commit anyhow")
2329
except ConflictsInTree:
2330
raise errors.BzrCommandError('Conflicts detected in working '
2331
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2333
except StrictCommitFailed:
2334
raise errors.BzrCommandError("Commit refused because there are"
2335
" unknown files in the working tree.")
2336
except errors.BoundBranchOutOfDate, e:
2337
raise errors.BzrCommandError(str(e) + "\n"
2338
'To commit to master branch, run update and then commit.\n'
2339
'You can also pass --local to commit to continue working '
2343
class cmd_check(Command):
2344
"""Validate working tree structure, branch consistency and repository history.
2346
This command checks various invariants about branch and repository storage
2347
to detect data corruption or bzr bugs.
2349
The working tree and branch checks will only give output if a problem is
2350
detected. The output fields of the repository check are:
2352
revisions: This is just the number of revisions checked. It doesn't
2354
versionedfiles: This is just the number of versionedfiles checked. It
2355
doesn't indicate a problem.
2356
unreferenced ancestors: Texts that are ancestors of other texts, but
2357
are not properly referenced by the revision ancestry. This is a
2358
subtle problem that Bazaar can work around.
2359
unique file texts: This is the total number of unique file contents
2360
seen in the checked revisions. It does not indicate a problem.
2361
repeated file texts: This is the total number of repeated texts seen
2362
in the checked revisions. Texts can be repeated when their file
2363
entries are modified, but the file contents are not. It does not
2366
If no restrictions are specified, all Bazaar data that is found at the given
2367
location will be checked.
2371
Check the tree and branch at 'foo'::
2373
bzr check --tree --branch foo
2375
Check only the repository at 'bar'::
2377
bzr check --repo bar
2379
Check everything at 'baz'::
2384
_see_also = ['reconcile']
2385
takes_args = ['path?']
2386
takes_options = ['verbose',
2387
Option('branch', help="Check the branch related to the"
2388
" current directory."),
2389
Option('repo', help="Check the repository related to the"
2390
" current directory."),
2391
Option('tree', help="Check the working tree related to"
2392
" the current directory.")]
2394
def run(self, path=None, verbose=False, branch=False, repo=False,
2396
from bzrlib.check import check_dwim
2399
if not branch and not repo and not tree:
2400
branch = repo = tree = True
2401
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2404
class cmd_upgrade(Command):
2405
"""Upgrade branch storage to current format.
2407
The check command or bzr developers may sometimes advise you to run
2408
this command. When the default format has changed you may also be warned
2409
during other operations to upgrade.
2412
_see_also = ['check']
2413
takes_args = ['url?']
2415
RegistryOption('format',
2416
help='Upgrade to a specific format. See "bzr help'
2417
' formats" for details.',
2418
registry=bzrdir.format_registry,
2419
converter=bzrdir.format_registry.make_bzrdir,
2420
value_switches=True, title='Branch format'),
2423
def run(self, url='.', format=None):
2424
from bzrlib.upgrade import upgrade
2426
format = bzrdir.format_registry.make_bzrdir('default')
2427
upgrade(url, format)
2430
class cmd_whoami(Command):
2431
"""Show or set bzr user id.
2434
Show the email of the current user::
2438
Set the current user::
2440
bzr whoami "Frank Chu <fchu@example.com>"
2442
takes_options = [ Option('email',
2443
help='Display email address only.'),
2445
help='Set identity for the current branch instead of '
2448
takes_args = ['name?']
2449
encoding_type = 'replace'
2452
def run(self, email=False, branch=False, name=None):
2454
# use branch if we're inside one; otherwise global config
2456
c = Branch.open_containing('.')[0].get_config()
2457
except errors.NotBranchError:
2458
c = config.GlobalConfig()
2460
self.outf.write(c.user_email() + '\n')
2462
self.outf.write(c.username() + '\n')
2465
# display a warning if an email address isn't included in the given name.
2467
config.extract_email_address(name)
2468
except errors.NoEmailInUsername, e:
2469
warning('"%s" does not seem to contain an email address. '
2470
'This is allowed, but not recommended.', name)
2472
# use global config unless --branch given
2474
c = Branch.open_containing('.')[0].get_config()
2476
c = config.GlobalConfig()
2477
c.set_user_option('email', name)
2480
class cmd_nick(Command):
2481
"""Print or set the branch nickname.
2483
If unset, the tree root directory name is used as the nickname
2484
To print the current nickname, execute with no argument.
2487
_see_also = ['info']
2488
takes_args = ['nickname?']
2489
def run(self, nickname=None):
2490
branch = Branch.open_containing(u'.')[0]
2491
if nickname is None:
2492
self.printme(branch)
2494
branch.nick = nickname
2497
def printme(self, branch):
2501
class cmd_alias(Command):
2502
"""Set/unset and display aliases.
2505
Show the current aliases::
2509
Show the alias specified for 'll'::
2513
Set an alias for 'll'::
2515
bzr alias ll="log --line -r-10..-1"
2517
To remove an alias for 'll'::
2519
bzr alias --remove ll
2522
takes_args = ['name?']
2524
Option('remove', help='Remove the alias.'),
2527
def run(self, name=None, remove=False):
2529
self.remove_alias(name)
2531
self.print_aliases()
2533
equal_pos = name.find('=')
2535
self.print_alias(name)
2537
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2539
def remove_alias(self, alias_name):
2540
if alias_name is None:
2541
raise errors.BzrCommandError(
2542
'bzr alias --remove expects an alias to remove.')
2543
# If alias is not found, print something like:
2544
# unalias: foo: not found
2545
c = config.GlobalConfig()
2546
c.unset_alias(alias_name)
2549
def print_aliases(self):
2550
"""Print out the defined aliases in a similar format to bash."""
2551
aliases = config.GlobalConfig().get_aliases()
2552
for key, value in sorted(aliases.iteritems()):
2553
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2556
def print_alias(self, alias_name):
2557
from bzrlib.commands import get_alias
2558
alias = get_alias(alias_name)
2560
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2563
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2565
def set_alias(self, alias_name, alias_command):
2566
"""Save the alias in the global config."""
2567
c = config.GlobalConfig()
2568
c.set_alias(alias_name, alias_command)
2571
class cmd_selftest(Command):
2572
"""Run internal test suite.
2574
If arguments are given, they are regular expressions that say which tests
2575
should run. Tests matching any expression are run, and other tests are
2578
Alternatively if --first is given, matching tests are run first and then
2579
all other tests are run. This is useful if you have been working in a
2580
particular area, but want to make sure nothing else was broken.
2582
If --exclude is given, tests that match that regular expression are
2583
excluded, regardless of whether they match --first or not.
2585
To help catch accidential dependencies between tests, the --randomize
2586
option is useful. In most cases, the argument used is the word 'now'.
2587
Note that the seed used for the random number generator is displayed
2588
when this option is used. The seed can be explicitly passed as the
2589
argument to this option if required. This enables reproduction of the
2590
actual ordering used if and when an order sensitive problem is encountered.
2592
If --list-only is given, the tests that would be run are listed. This is
2593
useful when combined with --first, --exclude and/or --randomize to
2594
understand their impact. The test harness reports "Listed nn tests in ..."
2595
instead of "Ran nn tests in ..." when list mode is enabled.
2597
If the global option '--no-plugins' is given, plugins are not loaded
2598
before running the selftests. This has two effects: features provided or
2599
modified by plugins will not be tested, and tests provided by plugins will
2602
Tests that need working space on disk use a common temporary directory,
2603
typically inside $TMPDIR or /tmp.
2606
Run only tests relating to 'ignore'::
2610
Disable plugins and list tests as they're run::
2612
bzr --no-plugins selftest -v
2614
# NB: this is used from the class without creating an instance, which is
2615
# why it does not have a self parameter.
2616
def get_transport_type(typestring):
2617
"""Parse and return a transport specifier."""
2618
if typestring == "sftp":
2619
from bzrlib.transport.sftp import SFTPAbsoluteServer
2620
return SFTPAbsoluteServer
2621
if typestring == "memory":
2622
from bzrlib.transport.memory import MemoryServer
2624
if typestring == "fakenfs":
2625
from bzrlib.transport.fakenfs import FakeNFSServer
2626
return FakeNFSServer
2627
msg = "No known transport type %s. Supported types are: sftp\n" %\
2629
raise errors.BzrCommandError(msg)
2632
takes_args = ['testspecs*']
2633
takes_options = ['verbose',
2635
help='Stop when one test fails.',
2639
help='Use a different transport by default '
2640
'throughout the test suite.',
2641
type=get_transport_type),
2643
help='Run the benchmarks rather than selftests.'),
2644
Option('lsprof-timed',
2645
help='Generate lsprof output for benchmarked'
2646
' sections of code.'),
2647
Option('cache-dir', type=str,
2648
help='Cache intermediate benchmark output in this '
2651
help='Run all tests, but run specified tests first.',
2655
help='List the tests instead of running them.'),
2656
Option('randomize', type=str, argname="SEED",
2657
help='Randomize the order of tests using the given'
2658
' seed or "now" for the current time.'),
2659
Option('exclude', type=str, argname="PATTERN",
2661
help='Exclude tests that match this regular'
2663
Option('strict', help='Fail on missing dependencies or '
2665
Option('load-list', type=str, argname='TESTLISTFILE',
2666
help='Load a test id list from a text file.'),
2667
ListOption('debugflag', type=str, short_name='E',
2668
help='Turn on a selftest debug flag.'),
2669
Option('starting-with', type=str, argname='TESTID',
2671
help='Load only the tests starting with TESTID.'),
2673
encoding_type = 'replace'
2675
def run(self, testspecs_list=None, verbose=False, one=False,
2676
transport=None, benchmark=None,
2677
lsprof_timed=None, cache_dir=None,
2678
first=False, list_only=False,
2679
randomize=None, exclude=None, strict=False,
2680
load_list=None, debugflag=None, starting_with=None):
2682
from bzrlib.tests import selftest
2683
import bzrlib.benchmarks as benchmarks
2684
from bzrlib.benchmarks import tree_creator
2686
# Make deprecation warnings visible, unless -Werror is set
2687
symbol_versioning.activate_deprecation_warnings(override=False)
2689
if cache_dir is not None:
2690
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2692
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2693
print ' %s (%s python%s)' % (
2695
bzrlib.version_string,
2696
bzrlib._format_version_tuple(sys.version_info),
2699
if testspecs_list is not None:
2700
pattern = '|'.join(testspecs_list)
2704
test_suite_factory = benchmarks.test_suite
2705
# Unless user explicitly asks for quiet, be verbose in benchmarks
2706
verbose = not is_quiet()
2707
# TODO: should possibly lock the history file...
2708
benchfile = open(".perf_history", "at", buffering=1)
2710
test_suite_factory = None
2713
result = selftest(verbose=verbose,
2715
stop_on_failure=one,
2716
transport=transport,
2717
test_suite_factory=test_suite_factory,
2718
lsprof_timed=lsprof_timed,
2719
bench_history=benchfile,
2720
matching_tests_first=first,
2721
list_only=list_only,
2722
random_seed=randomize,
2723
exclude_pattern=exclude,
2725
load_list=load_list,
2726
debug_flags=debugflag,
2727
starting_with=starting_with,
2730
if benchfile is not None:
2733
note('tests passed')
2735
note('tests failed')
2736
return int(not result)
2739
class cmd_version(Command):
2740
"""Show version of bzr."""
2742
encoding_type = 'replace'
2744
Option("short", help="Print just the version number."),
2748
def run(self, short=False):
2749
from bzrlib.version import show_version
2751
self.outf.write(bzrlib.version_string + '\n')
2753
show_version(to_file=self.outf)
2756
class cmd_rocks(Command):
2757
"""Statement of optimism."""
2763
print "It sure does!"
2766
class cmd_find_merge_base(Command):
2767
"""Find and print a base revision for merging two branches."""
2768
# TODO: Options to specify revisions on either side, as if
2769
# merging only part of the history.
2770
takes_args = ['branch', 'other']
2774
def run(self, branch, other):
2775
from bzrlib.revision import ensure_null
2777
branch1 = Branch.open_containing(branch)[0]
2778
branch2 = Branch.open_containing(other)[0]
2783
last1 = ensure_null(branch1.last_revision())
2784
last2 = ensure_null(branch2.last_revision())
2786
graph = branch1.repository.get_graph(branch2.repository)
2787
base_rev_id = graph.find_unique_lca(last1, last2)
2789
print 'merge base is revision %s' % base_rev_id
2796
class cmd_merge(Command):
2797
"""Perform a three-way merge.
2799
The source of the merge can be specified either in the form of a branch,
2800
or in the form of a path to a file containing a merge directive generated
2801
with bzr send. If neither is specified, the default is the upstream branch
2802
or the branch most recently merged using --remember.
2804
When merging a branch, by default the tip will be merged. To pick a different
2805
revision, pass --revision. If you specify two values, the first will be used as
2806
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2807
available revisions, like this is commonly referred to as "cherrypicking".
2809
Revision numbers are always relative to the branch being merged.
2811
By default, bzr will try to merge in all new work from the other
2812
branch, automatically determining an appropriate base. If this
2813
fails, you may need to give an explicit base.
2815
Merge will do its best to combine the changes in two branches, but there
2816
are some kinds of problems only a human can fix. When it encounters those,
2817
it will mark a conflict. A conflict means that you need to fix something,
2818
before you should commit.
2820
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2822
If there is no default branch set, the first merge will set it. After
2823
that, you can omit the branch to use the default. To change the
2824
default, use --remember. The value will only be saved if the remote
2825
location can be accessed.
2827
The results of the merge are placed into the destination working
2828
directory, where they can be reviewed (with bzr diff), tested, and then
2829
committed to record the result of the merge.
2831
merge refuses to run if there are any uncommitted changes, unless
2835
To merge the latest revision from bzr.dev::
2837
bzr merge ../bzr.dev
2839
To merge changes up to and including revision 82 from bzr.dev::
2841
bzr merge -r 82 ../bzr.dev
2843
To merge the changes introduced by 82, without previous changes::
2845
bzr merge -r 81..82 ../bzr.dev
2847
To apply a merge directive contained in in /tmp/merge:
2849
bzr merge /tmp/merge
2852
encoding_type = 'exact'
2853
_see_also = ['update', 'remerge', 'status-flags']
2854
takes_args = ['location?']
2859
help='Merge even if the destination tree has uncommitted changes.'),
2863
Option('show-base', help="Show base revision text in "
2865
Option('uncommitted', help='Apply uncommitted changes'
2866
' from a working copy, instead of branch changes.'),
2867
Option('pull', help='If the destination is already'
2868
' completely merged into the source, pull from the'
2869
' source rather than merging. When this happens,'
2870
' you do not need to commit the result.'),
2872
help='Branch to merge into, '
2873
'rather than the one containing the working directory.',
2877
Option('preview', help='Instead of merging, show a diff of the merge.')
2880
def run(self, location=None, revision=None, force=False,
2881
merge_type=None, show_base=False, reprocess=False, remember=False,
2882
uncommitted=False, pull=False,
2886
if merge_type is None:
2887
merge_type = _mod_merge.Merge3Merger
2889
if directory is None: directory = u'.'
2890
possible_transports = []
2892
allow_pending = True
2893
verified = 'inapplicable'
2894
tree = WorkingTree.open_containing(directory)[0]
2895
change_reporter = delta._ChangeReporter(
2896
unversioned_filter=tree.is_ignored)
2899
pb = ui.ui_factory.nested_progress_bar()
2900
cleanups.append(pb.finished)
2902
cleanups.append(tree.unlock)
2903
if location is not None:
2905
mergeable = bundle.read_mergeable_from_url(location,
2906
possible_transports=possible_transports)
2907
except errors.NotABundle:
2911
raise errors.BzrCommandError('Cannot use --uncommitted'
2912
' with bundles or merge directives.')
2914
if revision is not None:
2915
raise errors.BzrCommandError(
2916
'Cannot use -r with merge directives or bundles')
2917
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2920
if merger is None and uncommitted:
2921
if revision is not None and len(revision) > 0:
2922
raise errors.BzrCommandError('Cannot use --uncommitted and'
2923
' --revision at the same time.')
2924
location = self._select_branch_location(tree, location)[0]
2925
other_tree, other_path = WorkingTree.open_containing(location)
2926
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2928
allow_pending = False
2929
if other_path != '':
2930
merger.interesting_files = [other_path]
2933
merger, allow_pending = self._get_merger_from_branch(tree,
2934
location, revision, remember, possible_transports, pb)
2936
merger.merge_type = merge_type
2937
merger.reprocess = reprocess
2938
merger.show_base = show_base
2939
self.sanity_check_merger(merger)
2940
if (merger.base_rev_id == merger.other_rev_id and
2941
merger.other_rev_id is not None):
2942
note('Nothing to do.')
2945
if merger.interesting_files is not None:
2946
raise errors.BzrCommandError('Cannot pull individual files')
2947
if (merger.base_rev_id == tree.last_revision()):
2948
result = tree.pull(merger.other_branch, False,
2949
merger.other_rev_id)
2950
result.report(self.outf)
2952
merger.check_basis(not force)
2954
return self._do_preview(merger)
2956
return self._do_merge(merger, change_reporter, allow_pending,
2959
for cleanup in reversed(cleanups):
2962
def _do_preview(self, merger):
2963
from bzrlib.diff import show_diff_trees
2964
tree_merger = merger.make_merger()
2965
tt = tree_merger.make_preview_transform()
2967
result_tree = tt.get_preview_tree()
2968
show_diff_trees(merger.this_tree, result_tree, self.outf,
2969
old_label='', new_label='')
2973
def _do_merge(self, merger, change_reporter, allow_pending, verified):
2974
merger.change_reporter = change_reporter
2975
conflict_count = merger.do_merge()
2977
merger.set_pending()
2978
if verified == 'failed':
2979
warning('Preview patch does not match changes')
2980
if conflict_count != 0:
2985
def sanity_check_merger(self, merger):
2986
if (merger.show_base and
2987
not merger.merge_type is _mod_merge.Merge3Merger):
2988
raise errors.BzrCommandError("Show-base is not supported for this"
2989
" merge type. %s" % merger.merge_type)
2990
if merger.reprocess and not merger.merge_type.supports_reprocess:
2991
raise errors.BzrCommandError("Conflict reduction is not supported"
2992
" for merge type %s." %
2994
if merger.reprocess and merger.show_base:
2995
raise errors.BzrCommandError("Cannot do conflict reduction and"
2998
def _get_merger_from_branch(self, tree, location, revision, remember,
2999
possible_transports, pb):
3000
"""Produce a merger from a location, assuming it refers to a branch."""
3001
from bzrlib.tag import _merge_tags_if_possible
3002
# find the branch locations
3003
other_loc, user_location = self._select_branch_location(tree, location,
3005
if revision is not None and len(revision) == 2:
3006
base_loc, _unused = self._select_branch_location(tree,
3007
location, revision, 0)
3009
base_loc = other_loc
3011
other_branch, other_path = Branch.open_containing(other_loc,
3012
possible_transports)
3013
if base_loc == other_loc:
3014
base_branch = other_branch
3016
base_branch, base_path = Branch.open_containing(base_loc,
3017
possible_transports)
3018
# Find the revision ids
3019
if revision is None or len(revision) < 1 or revision[-1] is None:
3020
other_revision_id = _mod_revision.ensure_null(
3021
other_branch.last_revision())
3023
other_revision_id = revision[-1].as_revision_id(other_branch)
3024
if (revision is not None and len(revision) == 2
3025
and revision[0] is not None):
3026
base_revision_id = revision[0].as_revision_id(base_branch)
3028
base_revision_id = None
3029
# Remember where we merge from
3030
if ((remember or tree.branch.get_submit_branch() is None) and
3031
user_location is not None):
3032
tree.branch.set_submit_branch(other_branch.base)
3033
_merge_tags_if_possible(other_branch, tree.branch)
3034
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3035
other_revision_id, base_revision_id, other_branch, base_branch)
3036
if other_path != '':
3037
allow_pending = False
3038
merger.interesting_files = [other_path]
3040
allow_pending = True
3041
return merger, allow_pending
3043
def _select_branch_location(self, tree, user_location, revision=None,
3045
"""Select a branch location, according to possible inputs.
3047
If provided, branches from ``revision`` are preferred. (Both
3048
``revision`` and ``index`` must be supplied.)
3050
Otherwise, the ``location`` parameter is used. If it is None, then the
3051
``submit`` or ``parent`` location is used, and a note is printed.
3053
:param tree: The working tree to select a branch for merging into
3054
:param location: The location entered by the user
3055
:param revision: The revision parameter to the command
3056
:param index: The index to use for the revision parameter. Negative
3057
indices are permitted.
3058
:return: (selected_location, user_location). The default location
3059
will be the user-entered location.
3061
if (revision is not None and index is not None
3062
and revision[index] is not None):
3063
branch = revision[index].get_branch()
3064
if branch is not None:
3065
return branch, branch
3066
if user_location is None:
3067
location = self._get_remembered(tree, 'Merging from')
3069
location = user_location
3070
return location, user_location
3072
def _get_remembered(self, tree, verb_string):
3073
"""Use tree.branch's parent if none was supplied.
3075
Report if the remembered location was used.
3077
stored_location = tree.branch.get_submit_branch()
3078
stored_location_type = "submit"
3079
if stored_location is None:
3080
stored_location = tree.branch.get_parent()
3081
stored_location_type = "parent"
3082
mutter("%s", stored_location)
3083
if stored_location is None:
3084
raise errors.BzrCommandError("No location specified or remembered")
3085
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3086
note(u"%s remembered %s location %s", verb_string,
3087
stored_location_type, display_url)
3088
return stored_location
3091
class cmd_remerge(Command):
3094
Use this if you want to try a different merge technique while resolving
3095
conflicts. Some merge techniques are better than others, and remerge
3096
lets you try different ones on different files.
3098
The options for remerge have the same meaning and defaults as the ones for
3099
merge. The difference is that remerge can (only) be run when there is a
3100
pending merge, and it lets you specify particular files.
3103
Re-do the merge of all conflicted files, and show the base text in
3104
conflict regions, in addition to the usual THIS and OTHER texts::
3106
bzr remerge --show-base
3108
Re-do the merge of "foobar", using the weave merge algorithm, with
3109
additional processing to reduce the size of conflict regions::
3111
bzr remerge --merge-type weave --reprocess foobar
3113
takes_args = ['file*']
3118
help="Show base revision text in conflicts."),
3121
def run(self, file_list=None, merge_type=None, show_base=False,
3123
if merge_type is None:
3124
merge_type = _mod_merge.Merge3Merger
3125
tree, file_list = tree_files(file_list)
3128
parents = tree.get_parent_ids()
3129
if len(parents) != 2:
3130
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3131
" merges. Not cherrypicking or"
3133
repository = tree.branch.repository
3134
interesting_ids = None
3136
conflicts = tree.conflicts()
3137
if file_list is not None:
3138
interesting_ids = set()
3139
for filename in file_list:
3140
file_id = tree.path2id(filename)
3142
raise errors.NotVersionedError(filename)
3143
interesting_ids.add(file_id)
3144
if tree.kind(file_id) != "directory":
3147
for name, ie in tree.inventory.iter_entries(file_id):
3148
interesting_ids.add(ie.file_id)
3149
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3151
# Remerge only supports resolving contents conflicts
3152
allowed_conflicts = ('text conflict', 'contents conflict')
3153
restore_files = [c.path for c in conflicts
3154
if c.typestring in allowed_conflicts]
3155
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3156
tree.set_conflicts(ConflictList(new_conflicts))
3157
if file_list is not None:
3158
restore_files = file_list
3159
for filename in restore_files:
3161
restore(tree.abspath(filename))
3162
except errors.NotConflicted:
3164
# Disable pending merges, because the file texts we are remerging
3165
# have not had those merges performed. If we use the wrong parents
3166
# list, we imply that the working tree text has seen and rejected
3167
# all the changes from the other tree, when in fact those changes
3168
# have not yet been seen.
3169
pb = ui.ui_factory.nested_progress_bar()
3170
tree.set_parent_ids(parents[:1])
3172
merger = _mod_merge.Merger.from_revision_ids(pb,
3174
merger.interesting_ids = interesting_ids
3175
merger.merge_type = merge_type
3176
merger.show_base = show_base
3177
merger.reprocess = reprocess
3178
conflicts = merger.do_merge()
3180
tree.set_parent_ids(parents)
3190
class cmd_revert(Command):
3191
"""Revert files to a previous revision.
3193
Giving a list of files will revert only those files. Otherwise, all files
3194
will be reverted. If the revision is not specified with '--revision', the
3195
last committed revision is used.
3197
To remove only some changes, without reverting to a prior version, use
3198
merge instead. For example, "merge . --revision -2..-3" will remove the
3199
changes introduced by -2, without affecting the changes introduced by -1.
3200
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3202
By default, any files that have been manually changed will be backed up
3203
first. (Files changed only by merge are not backed up.) Backup files have
3204
'.~#~' appended to their name, where # is a number.
3206
When you provide files, you can use their current pathname or the pathname
3207
from the target revision. So you can use revert to "undelete" a file by
3208
name. If you name a directory, all the contents of that directory will be
3211
Any files that have been newly added since that revision will be deleted,
3212
with a backup kept if appropriate. Directories containing unknown files
3213
will not be deleted.
3215
The working tree contains a list of pending merged revisions, which will
3216
be included as parents in the next commit. Normally, revert clears that
3217
list as well as reverting the files. If any files are specified, revert
3218
leaves the pending merge list alone and reverts only the files. Use "bzr
3219
revert ." in the tree root to revert all files but keep the merge record,
3220
and "bzr revert --forget-merges" to clear the pending merge list without
3221
reverting any files.
3224
_see_also = ['cat', 'export']
3227
Option('no-backup', "Do not save backups of reverted files."),
3228
Option('forget-merges',
3229
'Remove pending merge marker, without changing any files.'),
3231
takes_args = ['file*']
3233
def run(self, revision=None, no_backup=False, file_list=None,
3234
forget_merges=None):
3235
tree, file_list = tree_files(file_list)
3237
tree.set_parent_ids(tree.get_parent_ids()[:1])
3239
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3242
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3243
rev_tree = _get_revision_tree('revert', revision, tree=tree)
3244
pb = ui.ui_factory.nested_progress_bar()
3246
tree.revert(file_list, rev_tree, not no_backup, pb,
3247
report_changes=True)
3252
class cmd_assert_fail(Command):
3253
"""Test reporting of assertion failures"""
3254
# intended just for use in testing
3259
raise AssertionError("always fails")
3262
class cmd_help(Command):
3263
"""Show help on a command or other topic.
3266
_see_also = ['topics']
3268
Option('long', 'Show help on all commands.'),
3270
takes_args = ['topic?']
3271
aliases = ['?', '--help', '-?', '-h']
3274
def run(self, topic=None, long=False):
3276
if topic is None and long:
3278
bzrlib.help.help(topic)
3281
class cmd_shell_complete(Command):
3282
"""Show appropriate completions for context.
3284
For a list of all available commands, say 'bzr shell-complete'.
3286
takes_args = ['context?']
3291
def run(self, context=None):
3292
import shellcomplete
3293
shellcomplete.shellcomplete(context)
3296
class cmd_missing(Command):
3297
"""Show unmerged/unpulled revisions between two branches.
3299
OTHER_BRANCH may be local or remote.
3302
_see_also = ['merge', 'pull']
3303
takes_args = ['other_branch?']
3305
Option('reverse', 'Reverse the order of revisions.'),
3307
'Display changes in the local branch only.'),
3308
Option('this' , 'Same as --mine-only.'),
3309
Option('theirs-only',
3310
'Display changes in the remote branch only.'),
3311
Option('other', 'Same as --theirs-only.'),
3316
encoding_type = 'replace'
3319
def run(self, other_branch=None, reverse=False, mine_only=False,
3320
theirs_only=False, log_format=None, long=False, short=False, line=False,
3321
show_ids=False, verbose=False, this=False, other=False):
3322
from bzrlib.missing import find_unmerged, iter_log_revisions
3328
# TODO: We should probably check that we don't have mine-only and
3329
# theirs-only set, but it gets complicated because we also have
3330
# this and other which could be used.
3337
local_branch = Branch.open_containing(u".")[0]
3338
parent = local_branch.get_parent()
3339
if other_branch is None:
3340
other_branch = parent
3341
if other_branch is None:
3342
raise errors.BzrCommandError("No peer location known"
3344
display_url = urlutils.unescape_for_display(parent,
3346
self.outf.write("Using saved parent location: "
3347
+ display_url + "\n")
3349
remote_branch = Branch.open(other_branch)
3350
if remote_branch.base == local_branch.base:
3351
remote_branch = local_branch
3352
local_branch.lock_read()
3354
remote_branch.lock_read()
3356
local_extra, remote_extra = find_unmerged(
3357
local_branch, remote_branch, restrict)
3359
if log_format is None:
3360
registry = log.log_formatter_registry
3361
log_format = registry.get_default(local_branch)
3362
lf = log_format(to_file=self.outf,
3364
show_timezone='original')
3365
if reverse is False:
3366
if local_extra is not None:
3367
local_extra.reverse()
3368
if remote_extra is not None:
3369
remote_extra.reverse()
3372
if local_extra and not theirs_only:
3373
self.outf.write("You have %d extra revision(s):\n" %
3375
for revision in iter_log_revisions(local_extra,
3376
local_branch.repository,
3378
lf.log_revision(revision)
3379
printed_local = True
3382
printed_local = False
3384
if remote_extra and not mine_only:
3385
if printed_local is True:
3386
self.outf.write("\n\n\n")
3387
self.outf.write("You are missing %d revision(s):\n" %
3389
for revision in iter_log_revisions(remote_extra,
3390
remote_branch.repository,
3392
lf.log_revision(revision)
3395
if mine_only and not local_extra:
3396
# We checked local, and found nothing extra
3397
self.outf.write('This branch is up to date.\n')
3398
elif theirs_only and not remote_extra:
3399
# We checked remote, and found nothing extra
3400
self.outf.write('Other branch is up to date.\n')
3401
elif not (mine_only or theirs_only or local_extra or
3403
# We checked both branches, and neither one had extra
3405
self.outf.write("Branches are up to date.\n")
3407
remote_branch.unlock()
3409
local_branch.unlock()
3410
if not status_code and parent is None and other_branch is not None:
3411
local_branch.lock_write()
3413
# handle race conditions - a parent might be set while we run.
3414
if local_branch.get_parent() is None:
3415
local_branch.set_parent(remote_branch.base)
3417
local_branch.unlock()
3421
class cmd_pack(Command):
3422
"""Compress the data within a repository."""
3424
_see_also = ['repositories']
3425
takes_args = ['branch_or_repo?']
3427
def run(self, branch_or_repo='.'):
3428
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3430
branch = dir.open_branch()
3431
repository = branch.repository
3432
except errors.NotBranchError:
3433
repository = dir.open_repository()
3437
class cmd_plugins(Command):
3438
"""List the installed plugins.
3440
This command displays the list of installed plugins including
3441
version of plugin and a short description of each.
3443
--verbose shows the path where each plugin is located.
3445
A plugin is an external component for Bazaar that extends the
3446
revision control system, by adding or replacing code in Bazaar.
3447
Plugins can do a variety of things, including overriding commands,
3448
adding new commands, providing additional network transports and
3449
customizing log output.
3451
See the Bazaar web site, http://bazaar-vcs.org, for further
3452
information on plugins including where to find them and how to
3453
install them. Instructions are also provided there on how to
3454
write new plugins using the Python programming language.
3456
takes_options = ['verbose']
3459
def run(self, verbose=False):
3460
import bzrlib.plugin
3461
from inspect import getdoc
3463
for name, plugin in bzrlib.plugin.plugins().items():
3464
version = plugin.__version__
3465
if version == 'unknown':
3467
name_ver = '%s %s' % (name, version)
3468
d = getdoc(plugin.module)
3470
doc = d.split('\n')[0]
3472
doc = '(no description)'
3473
result.append((name_ver, doc, plugin.path()))
3474
for name_ver, doc, path in sorted(result):
3482
class cmd_testament(Command):
3483
"""Show testament (signing-form) of a revision."""
3486
Option('long', help='Produce long-format testament.'),
3488
help='Produce a strict-format testament.')]
3489
takes_args = ['branch?']
3491
def run(self, branch=u'.', revision=None, long=False, strict=False):
3492
from bzrlib.testament import Testament, StrictTestament
3494
testament_class = StrictTestament
3496
testament_class = Testament
3498
b = Branch.open_containing(branch)[0]
3500
b = Branch.open(branch)
3503
if revision is None:
3504
rev_id = b.last_revision()
3506
rev_id = revision[0].as_revision_id(b)
3507
t = testament_class.from_revision(b.repository, rev_id)
3509
sys.stdout.writelines(t.as_text_lines())
3511
sys.stdout.write(t.as_short_text())
3516
class cmd_annotate(Command):
3517
"""Show the origin of each line in a file.
3519
This prints out the given file with an annotation on the left side
3520
indicating which revision, author and date introduced the change.
3522
If the origin is the same for a run of consecutive lines, it is
3523
shown only at the top, unless the --all option is given.
3525
# TODO: annotate directories; showing when each file was last changed
3526
# TODO: if the working copy is modified, show annotations on that
3527
# with new uncommitted lines marked
3528
aliases = ['ann', 'blame', 'praise']
3529
takes_args = ['filename']
3530
takes_options = [Option('all', help='Show annotations on all lines.'),
3531
Option('long', help='Show commit date in annotations.'),
3535
encoding_type = 'exact'
3538
def run(self, filename, all=False, long=False, revision=None,
3540
from bzrlib.annotate import annotate_file
3541
wt, branch, relpath = \
3542
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3548
tree = _get_revision_tree('annotate', revision, branch=branch)
3550
file_id = wt.path2id(relpath)
3552
file_id = tree.path2id(relpath)
3554
raise errors.NotVersionedError(filename)
3555
file_version = tree.inventory[file_id].revision
3556
annotate_file(branch, file_version, file_id, long, all, self.outf,
3565
class cmd_re_sign(Command):
3566
"""Create a digital signature for an existing revision."""
3567
# TODO be able to replace existing ones.
3569
hidden = True # is this right ?
3570
takes_args = ['revision_id*']
3571
takes_options = ['revision']
3573
def run(self, revision_id_list=None, revision=None):
3574
if revision_id_list is not None and revision is not None:
3575
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3576
if revision_id_list is None and revision is None:
3577
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3578
b = WorkingTree.open_containing(u'.')[0].branch
3581
return self._run(b, revision_id_list, revision)
3585
def _run(self, b, revision_id_list, revision):
3586
import bzrlib.gpg as gpg
3587
gpg_strategy = gpg.GPGStrategy(b.get_config())
3588
if revision_id_list is not None:
3589
b.repository.start_write_group()
3591
for revision_id in revision_id_list:
3592
b.repository.sign_revision(revision_id, gpg_strategy)
3594
b.repository.abort_write_group()
3597
b.repository.commit_write_group()
3598
elif revision is not None:
3599
if len(revision) == 1:
3600
revno, rev_id = revision[0].in_history(b)
3601
b.repository.start_write_group()
3603
b.repository.sign_revision(rev_id, gpg_strategy)
3605
b.repository.abort_write_group()
3608
b.repository.commit_write_group()
3609
elif len(revision) == 2:
3610
# are they both on rh- if so we can walk between them
3611
# might be nice to have a range helper for arbitrary
3612
# revision paths. hmm.
3613
from_revno, from_revid = revision[0].in_history(b)
3614
to_revno, to_revid = revision[1].in_history(b)
3615
if to_revid is None:
3616
to_revno = b.revno()
3617
if from_revno is None or to_revno is None:
3618
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3619
b.repository.start_write_group()
3621
for revno in range(from_revno, to_revno + 1):
3622
b.repository.sign_revision(b.get_rev_id(revno),
3625
b.repository.abort_write_group()
3628
b.repository.commit_write_group()
3630
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3633
class cmd_bind(Command):
3634
"""Convert the current branch into a checkout of the supplied branch.
3636
Once converted into a checkout, commits must succeed on the master branch
3637
before they will be applied to the local branch.
3640
_see_also = ['checkouts', 'unbind']
3641
takes_args = ['location?']
3644
def run(self, location=None):
3645
b, relpath = Branch.open_containing(u'.')
3646
if location is None:
3648
location = b.get_old_bound_location()
3649
except errors.UpgradeRequired:
3650
raise errors.BzrCommandError('No location supplied. '
3651
'This format does not remember old locations.')
3653
if location is None:
3654
raise errors.BzrCommandError('No location supplied and no '
3655
'previous location known')
3656
b_other = Branch.open(location)
3659
except errors.DivergedBranches:
3660
raise errors.BzrCommandError('These branches have diverged.'
3661
' Try merging, and then bind again.')
3664
class cmd_unbind(Command):
3665
"""Convert the current checkout into a regular branch.
3667
After unbinding, the local branch is considered independent and subsequent
3668
commits will be local only.
3671
_see_also = ['checkouts', 'bind']
3676
b, relpath = Branch.open_containing(u'.')
3678
raise errors.BzrCommandError('Local branch is not bound')
3681
class cmd_uncommit(Command):
3682
"""Remove the last committed revision.
3684
--verbose will print out what is being removed.
3685
--dry-run will go through all the motions, but not actually
3688
If --revision is specified, uncommit revisions to leave the branch at the
3689
specified revision. For example, "bzr uncommit -r 15" will leave the
3690
branch at revision 15.
3692
Uncommit leaves the working tree ready for a new commit. The only change
3693
it may make is to restore any pending merges that were present before
3697
# TODO: jam 20060108 Add an option to allow uncommit to remove
3698
# unreferenced information in 'branch-as-repository' branches.
3699
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3700
# information in shared branches as well.
3701
_see_also = ['commit']
3702
takes_options = ['verbose', 'revision',
3703
Option('dry-run', help='Don\'t actually make changes.'),
3704
Option('force', help='Say yes to all questions.'),
3706
help="Only remove the commits from the local branch"
3707
" when in a checkout."
3710
takes_args = ['location?']
3712
encoding_type = 'replace'
3714
def run(self, location=None,
3715
dry_run=False, verbose=False,
3716
revision=None, force=False, local=False):
3717
if location is None:
3719
control, relpath = bzrdir.BzrDir.open_containing(location)
3721
tree = control.open_workingtree()
3723
except (errors.NoWorkingTree, errors.NotLocalUrl):
3725
b = control.open_branch()
3727
if tree is not None:
3732
return self._run(b, tree, dry_run, verbose, revision, force,
3735
if tree is not None:
3740
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3741
from bzrlib.log import log_formatter, show_log
3742
from bzrlib.uncommit import uncommit
3744
last_revno, last_rev_id = b.last_revision_info()
3747
if revision is None:
3749
rev_id = last_rev_id
3751
# 'bzr uncommit -r 10' actually means uncommit
3752
# so that the final tree is at revno 10.
3753
# but bzrlib.uncommit.uncommit() actually uncommits
3754
# the revisions that are supplied.
3755
# So we need to offset it by one
3756
revno = revision[0].in_history(b).revno + 1
3757
if revno <= last_revno:
3758
rev_id = b.get_rev_id(revno)
3760
if rev_id is None or _mod_revision.is_null(rev_id):
3761
self.outf.write('No revisions to uncommit.\n')
3764
lf = log_formatter('short',
3766
show_timezone='original')
3771
direction='forward',
3772
start_revision=revno,
3773
end_revision=last_revno)
3776
print 'Dry-run, pretending to remove the above revisions.'
3778
val = raw_input('Press <enter> to continue')
3780
print 'The above revision(s) will be removed.'
3782
val = raw_input('Are you sure [y/N]? ')
3783
if val.lower() not in ('y', 'yes'):
3787
mutter('Uncommitting from {%s} to {%s}',
3788
last_rev_id, rev_id)
3789
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3790
revno=revno, local=local)
3791
note('You can restore the old tip by running:\n'
3792
' bzr pull . -r revid:%s', last_rev_id)
3795
class cmd_break_lock(Command):
3796
"""Break a dead lock on a repository, branch or working directory.
3798
CAUTION: Locks should only be broken when you are sure that the process
3799
holding the lock has been stopped.
3801
You can get information on what locks are open via the 'bzr info' command.
3806
takes_args = ['location?']
3808
def run(self, location=None, show=False):
3809
if location is None:
3811
control, relpath = bzrdir.BzrDir.open_containing(location)
3813
control.break_lock()
3814
except NotImplementedError:
3818
class cmd_wait_until_signalled(Command):
3819
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3821
This just prints a line to signal when it is ready, then blocks on stdin.
3827
sys.stdout.write("running\n")
3829
sys.stdin.readline()
3832
class cmd_serve(Command):
3833
"""Run the bzr server."""
3835
aliases = ['server']
3839
help='Serve on stdin/out for use from inetd or sshd.'),
3841
help='Listen for connections on nominated port of the form '
3842
'[hostname:]portnumber. Passing 0 as the port number will '
3843
'result in a dynamically allocated port. The default port is '
3847
help='Serve contents of this directory.',
3849
Option('allow-writes',
3850
help='By default the server is a readonly server. Supplying '
3851
'--allow-writes enables write access to the contents of '
3852
'the served directory and below.'
3856
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3857
from bzrlib import lockdir
3858
from bzrlib.smart import medium, server
3859
from bzrlib.transport import get_transport
3860
from bzrlib.transport.chroot import ChrootServer
3861
if directory is None:
3862
directory = os.getcwd()
3863
url = urlutils.local_path_to_url(directory)
3864
if not allow_writes:
3865
url = 'readonly+' + url
3866
chroot_server = ChrootServer(get_transport(url))
3867
chroot_server.setUp()
3868
t = get_transport(chroot_server.get_url())
3870
smart_server = medium.SmartServerPipeStreamMedium(
3871
sys.stdin, sys.stdout, t)
3873
host = medium.BZR_DEFAULT_INTERFACE
3875
port = medium.BZR_DEFAULT_PORT
3878
host, port = port.split(':')
3880
smart_server = server.SmartTCPServer(t, host=host, port=port)
3881
print 'listening on port: ', smart_server.port
3883
# for the duration of this server, no UI output is permitted.
3884
# note that this may cause problems with blackbox tests. This should
3885
# be changed with care though, as we dont want to use bandwidth sending
3886
# progress over stderr to smart server clients!
3887
old_factory = ui.ui_factory
3888
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3890
ui.ui_factory = ui.SilentUIFactory()
3891
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3892
smart_server.serve()
3894
ui.ui_factory = old_factory
3895
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3898
class cmd_join(Command):
3899
"""Combine a subtree into its containing tree.
3901
This command is for experimental use only. It requires the target tree
3902
to be in dirstate-with-subtree format, which cannot be converted into
3905
The TREE argument should be an independent tree, inside another tree, but
3906
not part of it. (Such trees can be produced by "bzr split", but also by
3907
running "bzr branch" with the target inside a tree.)
3909
The result is a combined tree, with the subtree no longer an independant
3910
part. This is marked as a merge of the subtree into the containing tree,
3911
and all history is preserved.
3913
If --reference is specified, the subtree retains its independence. It can
3914
be branched by itself, and can be part of multiple projects at the same
3915
time. But operations performed in the containing tree, such as commit
3916
and merge, will recurse into the subtree.
3919
_see_also = ['split']
3920
takes_args = ['tree']
3922
Option('reference', help='Join by reference.'),
3926
def run(self, tree, reference=False):
3927
sub_tree = WorkingTree.open(tree)
3928
parent_dir = osutils.dirname(sub_tree.basedir)
3929
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3930
repo = containing_tree.branch.repository
3931
if not repo.supports_rich_root():
3932
raise errors.BzrCommandError(
3933
"Can't join trees because %s doesn't support rich root data.\n"
3934
"You can use bzr upgrade on the repository."
3938
containing_tree.add_reference(sub_tree)
3939
except errors.BadReferenceTarget, e:
3940
# XXX: Would be better to just raise a nicely printable
3941
# exception from the real origin. Also below. mbp 20070306
3942
raise errors.BzrCommandError("Cannot join %s. %s" %
3946
containing_tree.subsume(sub_tree)
3947
except errors.BadSubsumeSource, e:
3948
raise errors.BzrCommandError("Cannot join %s. %s" %
3952
class cmd_split(Command):
3953
"""Split a subdirectory of a tree into a separate tree.
3955
This command will produce a target tree in a format that supports
3956
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
3957
converted into earlier formats like 'dirstate-tags'.
3959
The TREE argument should be a subdirectory of a working tree. That
3960
subdirectory will be converted into an independent tree, with its own
3961
branch. Commits in the top-level tree will not apply to the new subtree.
3964
# join is not un-hidden yet
3965
#_see_also = ['join']
3966
takes_args = ['tree']
3968
def run(self, tree):
3969
containing_tree, subdir = WorkingTree.open_containing(tree)
3970
sub_id = containing_tree.path2id(subdir)
3972
raise errors.NotVersionedError(subdir)
3974
containing_tree.extract(sub_id)
3975
except errors.RootNotRich:
3976
raise errors.UpgradeRequired(containing_tree.branch.base)
3979
class cmd_merge_directive(Command):
3980
"""Generate a merge directive for auto-merge tools.
3982
A directive requests a merge to be performed, and also provides all the
3983
information necessary to do so. This means it must either include a
3984
revision bundle, or the location of a branch containing the desired
3987
A submit branch (the location to merge into) must be supplied the first
3988
time the command is issued. After it has been supplied once, it will
3989
be remembered as the default.
3991
A public branch is optional if a revision bundle is supplied, but required
3992
if --diff or --plain is specified. It will be remembered as the default
3993
after the first use.
3996
takes_args = ['submit_branch?', 'public_branch?']
4000
_see_also = ['send']
4003
RegistryOption.from_kwargs('patch-type',
4004
'The type of patch to include in the directive.',
4006
value_switches=True,
4008
bundle='Bazaar revision bundle (default).',
4009
diff='Normal unified diff.',
4010
plain='No patch, just directive.'),
4011
Option('sign', help='GPG-sign the directive.'), 'revision',
4012
Option('mail-to', type=str,
4013
help='Instead of printing the directive, email to this address.'),
4014
Option('message', type=str, short_name='m',
4015
help='Message to use when committing this merge.')
4018
encoding_type = 'exact'
4020
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4021
sign=False, revision=None, mail_to=None, message=None):
4022
from bzrlib.revision import ensure_null, NULL_REVISION
4023
include_patch, include_bundle = {
4024
'plain': (False, False),
4025
'diff': (True, False),
4026
'bundle': (True, True),
4028
branch = Branch.open('.')
4029
stored_submit_branch = branch.get_submit_branch()
4030
if submit_branch is None:
4031
submit_branch = stored_submit_branch
4033
if stored_submit_branch is None:
4034
branch.set_submit_branch(submit_branch)
4035
if submit_branch is None:
4036
submit_branch = branch.get_parent()
4037
if submit_branch is None:
4038
raise errors.BzrCommandError('No submit branch specified or known')
4040
stored_public_branch = branch.get_public_branch()
4041
if public_branch is None:
4042
public_branch = stored_public_branch
4043
elif stored_public_branch is None:
4044
branch.set_public_branch(public_branch)
4045
if not include_bundle and public_branch is None:
4046
raise errors.BzrCommandError('No public branch specified or'
4048
base_revision_id = None
4049
if revision is not None:
4050
if len(revision) > 2:
4051
raise errors.BzrCommandError('bzr merge-directive takes '
4052
'at most two one revision identifiers')
4053
revision_id = revision[-1].as_revision_id(branch)
4054
if len(revision) == 2:
4055
base_revision_id = revision[0].as_revision_id(branch)
4057
revision_id = branch.last_revision()
4058
revision_id = ensure_null(revision_id)
4059
if revision_id == NULL_REVISION:
4060
raise errors.BzrCommandError('No revisions to bundle.')
4061
directive = merge_directive.MergeDirective2.from_objects(
4062
branch.repository, revision_id, time.time(),
4063
osutils.local_time_offset(), submit_branch,
4064
public_branch=public_branch, include_patch=include_patch,
4065
include_bundle=include_bundle, message=message,
4066
base_revision_id=base_revision_id)
4069
self.outf.write(directive.to_signed(branch))
4071
self.outf.writelines(directive.to_lines())
4073
message = directive.to_email(mail_to, branch, sign)
4074
s = SMTPConnection(branch.get_config())
4075
s.send_email(message)
4078
class cmd_send(Command):
4079
"""Mail or create a merge-directive for submiting changes.
4081
A merge directive provides many things needed for requesting merges:
4083
* A machine-readable description of the merge to perform
4085
* An optional patch that is a preview of the changes requested
4087
* An optional bundle of revision data, so that the changes can be applied
4088
directly from the merge directive, without retrieving data from a
4091
If --no-bundle is specified, then public_branch is needed (and must be
4092
up-to-date), so that the receiver can perform the merge using the
4093
public_branch. The public_branch is always included if known, so that
4094
people can check it later.
4096
The submit branch defaults to the parent, but can be overridden. Both
4097
submit branch and public branch will be remembered if supplied.
4099
If a public_branch is known for the submit_branch, that public submit
4100
branch is used in the merge instructions. This means that a local mirror
4101
can be used as your actual submit branch, once you have set public_branch
4104
Mail is sent using your preferred mail program. This should be transparent
4105
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4106
If the preferred client can't be found (or used), your editor will be used.
4108
To use a specific mail program, set the mail_client configuration option.
4109
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4110
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4111
generic options are "default", "editor", "emacsclient", "mapi", and
4112
"xdg-email". Plugins may also add supported clients.
4114
If mail is being sent, a to address is required. This can be supplied
4115
either on the commandline, by setting the submit_to configuration
4116
option in the branch itself or the child_submit_to configuration option
4117
in the submit branch.
4119
Two formats are currently supported: "4" uses revision bundle format 4 and
4120
merge directive format 2. It is significantly faster and smaller than
4121
older formats. It is compatible with Bazaar 0.19 and later. It is the
4122
default. "0.9" uses revision bundle format 0.9 and merge directive
4123
format 1. It is compatible with Bazaar 0.12 - 0.18.
4125
Merge directives are applied using the merge command or the pull command.
4128
encoding_type = 'exact'
4130
_see_also = ['merge', 'pull']
4132
takes_args = ['submit_branch?', 'public_branch?']
4136
help='Do not include a bundle in the merge directive.'),
4137
Option('no-patch', help='Do not include a preview patch in the merge'
4140
help='Remember submit and public branch.'),
4142
help='Branch to generate the submission from, '
4143
'rather than the one containing the working directory.',
4146
Option('output', short_name='o',
4147
help='Write merge directive to this file; '
4148
'use - for stdout.',
4150
Option('mail-to', help='Mail the request to this address.',
4154
RegistryOption.from_kwargs('format',
4155
'Use the specified output format.',
4156
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4157
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4160
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4161
no_patch=False, revision=None, remember=False, output=None,
4162
format='4', mail_to=None, message=None, **kwargs):
4163
return self._run(submit_branch, revision, public_branch, remember,
4164
format, no_bundle, no_patch, output,
4165
kwargs.get('from', '.'), mail_to, message)
4167
def _run(self, submit_branch, revision, public_branch, remember, format,
4168
no_bundle, no_patch, output, from_, mail_to, message):
4169
from bzrlib.revision import NULL_REVISION
4170
branch = Branch.open_containing(from_)[0]
4172
outfile = StringIO()
4176
outfile = open(output, 'wb')
4177
# we may need to write data into branch's repository to calculate
4182
config = branch.get_config()
4184
mail_to = config.get_user_option('submit_to')
4185
mail_client = config.get_mail_client()
4186
if remember and submit_branch is None:
4187
raise errors.BzrCommandError(
4188
'--remember requires a branch to be specified.')
4189
stored_submit_branch = branch.get_submit_branch()
4190
remembered_submit_branch = None
4191
if submit_branch is None:
4192
submit_branch = stored_submit_branch
4193
remembered_submit_branch = "submit"
4195
if stored_submit_branch is None or remember:
4196
branch.set_submit_branch(submit_branch)
4197
if submit_branch is None:
4198
submit_branch = branch.get_parent()
4199
remembered_submit_branch = "parent"
4200
if submit_branch is None:
4201
raise errors.BzrCommandError('No submit branch known or'
4203
if remembered_submit_branch is not None:
4204
note('Using saved %s location "%s" to determine what '
4205
'changes to submit.', remembered_submit_branch,
4209
submit_config = Branch.open(submit_branch).get_config()
4210
mail_to = submit_config.get_user_option("child_submit_to")
4212
stored_public_branch = branch.get_public_branch()
4213
if public_branch is None:
4214
public_branch = stored_public_branch
4215
elif stored_public_branch is None or remember:
4216
branch.set_public_branch(public_branch)
4217
if no_bundle and public_branch is None:
4218
raise errors.BzrCommandError('No public branch specified or'
4220
base_revision_id = None
4222
if revision is not None:
4223
if len(revision) > 2:
4224
raise errors.BzrCommandError('bzr send takes '
4225
'at most two one revision identifiers')
4226
revision_id = revision[-1].as_revision_id(branch)
4227
if len(revision) == 2:
4228
base_revision_id = revision[0].as_revision_id(branch)
4229
if revision_id is None:
4230
revision_id = branch.last_revision()
4231
if revision_id == NULL_REVISION:
4232
raise errors.BzrCommandError('No revisions to submit.')
4234
directive = merge_directive.MergeDirective2.from_objects(
4235
branch.repository, revision_id, time.time(),
4236
osutils.local_time_offset(), submit_branch,
4237
public_branch=public_branch, include_patch=not no_patch,
4238
include_bundle=not no_bundle, message=message,
4239
base_revision_id=base_revision_id)
4240
elif format == '0.9':
4243
patch_type = 'bundle'
4245
raise errors.BzrCommandError('Format 0.9 does not'
4246
' permit bundle with no patch')
4252
directive = merge_directive.MergeDirective.from_objects(
4253
branch.repository, revision_id, time.time(),
4254
osutils.local_time_offset(), submit_branch,
4255
public_branch=public_branch, patch_type=patch_type,
4258
outfile.writelines(directive.to_lines())
4260
subject = '[MERGE] '
4261
if message is not None:
4264
revision = branch.repository.get_revision(revision_id)
4265
subject += revision.get_summary()
4266
basename = directive.get_disk_name(branch)
4267
mail_client.compose_merge_request(mail_to, subject,
4268
outfile.getvalue(), basename)
4275
class cmd_bundle_revisions(cmd_send):
4277
"""Create a merge-directive for submiting changes.
4279
A merge directive provides many things needed for requesting merges:
4281
* A machine-readable description of the merge to perform
4283
* An optional patch that is a preview of the changes requested
4285
* An optional bundle of revision data, so that the changes can be applied
4286
directly from the merge directive, without retrieving data from a
4289
If --no-bundle is specified, then public_branch is needed (and must be
4290
up-to-date), so that the receiver can perform the merge using the
4291
public_branch. The public_branch is always included if known, so that
4292
people can check it later.
4294
The submit branch defaults to the parent, but can be overridden. Both
4295
submit branch and public branch will be remembered if supplied.
4297
If a public_branch is known for the submit_branch, that public submit
4298
branch is used in the merge instructions. This means that a local mirror
4299
can be used as your actual submit branch, once you have set public_branch
4302
Two formats are currently supported: "4" uses revision bundle format 4 and
4303
merge directive format 2. It is significantly faster and smaller than
4304
older formats. It is compatible with Bazaar 0.19 and later. It is the
4305
default. "0.9" uses revision bundle format 0.9 and merge directive
4306
format 1. It is compatible with Bazaar 0.12 - 0.18.
4311
help='Do not include a bundle in the merge directive.'),
4312
Option('no-patch', help='Do not include a preview patch in the merge'
4315
help='Remember submit and public branch.'),
4317
help='Branch to generate the submission from, '
4318
'rather than the one containing the working directory.',
4321
Option('output', short_name='o', help='Write directive to this file.',
4324
RegistryOption.from_kwargs('format',
4325
'Use the specified output format.',
4326
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4327
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4329
aliases = ['bundle']
4331
_see_also = ['send', 'merge']
4335
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4336
no_patch=False, revision=None, remember=False, output=None,
4337
format='4', **kwargs):
4340
return self._run(submit_branch, revision, public_branch, remember,
4341
format, no_bundle, no_patch, output,
4342
kwargs.get('from', '.'), None, None)
4345
class cmd_tag(Command):
4346
"""Create, remove or modify a tag naming a revision.
4348
Tags give human-meaningful names to revisions. Commands that take a -r
4349
(--revision) option can be given -rtag:X, where X is any previously
4352
Tags are stored in the branch. Tags are copied from one branch to another
4353
along when you branch, push, pull or merge.
4355
It is an error to give a tag name that already exists unless you pass
4356
--force, in which case the tag is moved to point to the new revision.
4358
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4359
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4362
_see_also = ['commit', 'tags']
4363
takes_args = ['tag_name']
4366
help='Delete this tag rather than placing it.',
4369
help='Branch in which to place the tag.',
4374
help='Replace existing tags.',
4379
def run(self, tag_name,
4385
branch, relpath = Branch.open_containing(directory)
4389
branch.tags.delete_tag(tag_name)
4390
self.outf.write('Deleted tag %s.\n' % tag_name)
4393
if len(revision) != 1:
4394
raise errors.BzrCommandError(
4395
"Tags can only be placed on a single revision, "
4397
revision_id = revision[0].as_revision_id(branch)
4399
revision_id = branch.last_revision()
4400
if (not force) and branch.tags.has_tag(tag_name):
4401
raise errors.TagAlreadyExists(tag_name)
4402
branch.tags.set_tag(tag_name, revision_id)
4403
self.outf.write('Created tag %s.\n' % tag_name)
4408
class cmd_tags(Command):
4411
This command shows a table of tag names and the revisions they reference.
4417
help='Branch whose tags should be displayed.',
4421
RegistryOption.from_kwargs('sort',
4422
'Sort tags by different criteria.', title='Sorting',
4423
alpha='Sort tags lexicographically (default).',
4424
time='Sort tags chronologically.',
4435
branch, relpath = Branch.open_containing(directory)
4436
tags = branch.tags.get_tag_dict().items()
4441
elif sort == 'time':
4443
for tag, revid in tags:
4445
revobj = branch.repository.get_revision(revid)
4446
except errors.NoSuchRevision:
4447
timestamp = sys.maxint # place them at the end
4449
timestamp = revobj.timestamp
4450
timestamps[revid] = timestamp
4451
tags.sort(key=lambda x: timestamps[x[1]])
4453
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4454
revno_map = branch.get_revision_id_to_revno_map()
4455
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4456
for tag, revid in tags ]
4457
for tag, revspec in tags:
4458
self.outf.write('%-20s %s\n' % (tag, revspec))
4461
class cmd_reconfigure(Command):
4462
"""Reconfigure the type of a bzr directory.
4464
A target configuration must be specified.
4466
For checkouts, the bind-to location will be auto-detected if not specified.
4467
The order of preference is
4468
1. For a lightweight checkout, the current bound location.
4469
2. For branches that used to be checkouts, the previously-bound location.
4470
3. The push location.
4471
4. The parent location.
4472
If none of these is available, --bind-to must be specified.
4475
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4476
takes_args = ['location?']
4477
takes_options = [RegistryOption.from_kwargs('target_type',
4478
title='Target type',
4479
help='The type to reconfigure the directory to.',
4480
value_switches=True, enum_switch=False,
4481
branch='Reconfigure to be an unbound branch '
4482
'with no working tree.',
4483
tree='Reconfigure to be an unbound branch '
4484
'with a working tree.',
4485
checkout='Reconfigure to be a bound branch '
4486
'with a working tree.',
4487
lightweight_checkout='Reconfigure to be a lightweight'
4488
' checkout (with no local history).',
4489
standalone='Reconfigure to be a standalone branch '
4490
'(i.e. stop using shared repository).',
4491
use_shared='Reconfigure to use a shared repository.'),
4492
Option('bind-to', help='Branch to bind checkout to.',
4495
help='Perform reconfiguration even if local changes'
4499
def run(self, location=None, target_type=None, bind_to=None, force=False):
4500
directory = bzrdir.BzrDir.open(location)
4501
if target_type is None:
4502
raise errors.BzrCommandError('No target configuration specified')
4503
elif target_type == 'branch':
4504
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4505
elif target_type == 'tree':
4506
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4507
elif target_type == 'checkout':
4508
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4510
elif target_type == 'lightweight-checkout':
4511
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4513
elif target_type == 'use-shared':
4514
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4515
elif target_type == 'standalone':
4516
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4517
reconfiguration.apply(force)
4520
class cmd_switch(Command):
4521
"""Set the branch of a checkout and update.
4523
For lightweight checkouts, this changes the branch being referenced.
4524
For heavyweight checkouts, this checks that there are no local commits
4525
versus the current bound branch, then it makes the local branch a mirror
4526
of the new location and binds to it.
4528
In both cases, the working tree is updated and uncommitted changes
4529
are merged. The user can commit or revert these as they desire.
4531
Pending merges need to be committed or reverted before using switch.
4533
The path to the branch to switch to can be specified relative to the parent
4534
directory of the current branch. For example, if you are currently in a
4535
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4539
takes_args = ['to_location']
4540
takes_options = [Option('force',
4541
help='Switch even if local commits will be lost.')
4544
def run(self, to_location, force=False):
4545
from bzrlib import switch
4547
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4549
to_branch = Branch.open(to_location)
4550
except errors.NotBranchError:
4551
to_branch = Branch.open(
4552
control_dir.open_branch().base + '../' + to_location)
4553
switch.switch(control_dir, to_branch, force)
4554
note('Switched to branch: %s',
4555
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4558
class cmd_hooks(Command):
4559
"""Show a branch's currently registered hooks.
4563
takes_args = ['path?']
4565
def run(self, path=None):
4568
branch_hooks = Branch.open(path).hooks
4569
for hook_type in branch_hooks:
4570
hooks = branch_hooks[hook_type]
4571
self.outf.write("%s:\n" % (hook_type,))
4574
self.outf.write(" %s\n" %
4575
(branch_hooks.get_hook_name(hook),))
4577
self.outf.write(" <no hooks installed>\n")
4580
def _create_prefix(cur_transport):
4581
needed = [cur_transport]
4582
# Recurse upwards until we can create a directory successfully
4584
new_transport = cur_transport.clone('..')
4585
if new_transport.base == cur_transport.base:
4586
raise errors.BzrCommandError(
4587
"Failed to create path prefix for %s."
4588
% cur_transport.base)
4590
new_transport.mkdir('.')
4591
except errors.NoSuchFile:
4592
needed.append(new_transport)
4593
cur_transport = new_transport
4596
# Now we only need to create child directories
4598
cur_transport = needed.pop()
4599
cur_transport.ensure_base()
4602
# these get imported and then picked up by the scan for cmd_*
4603
# TODO: Some more consistent way to split command definitions across files;
4604
# we do need to load at least some information about them to know of
4605
# aliases. ideally we would avoid loading the implementation until the
4606
# details were needed.
4607
from bzrlib.cmd_version_info import cmd_version_info
4608
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4609
from bzrlib.bundle.commands import (
4612
from bzrlib.sign_my_commits import cmd_sign_my_commits
4613
from bzrlib.weave_commands import cmd_versionedfile_list, \
4614
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
