1
# Copyright (C) 2004, 2005, 2006, 2007 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(), """
48
revision as _mod_revision,
56
from bzrlib.branch import Branch
57
from bzrlib.conflicts import ConflictList
58
from bzrlib.revisionspec import RevisionSpec
59
from bzrlib.smtp_connection import SMTPConnection
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import Command, display_command
64
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
65
from bzrlib.progress import DummyProgress, ProgressPhase
66
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
69
def tree_files(file_list, default_branch=u'.'):
71
return internal_tree_files(file_list, default_branch)
72
except errors.FileInWrongBranch, e:
73
raise errors.BzrCommandError("%s is not in the same branch as %s" %
74
(e.path, file_list[0]))
77
# XXX: Bad function name; should possibly also be a class method of
78
# WorkingTree rather than a function.
79
def internal_tree_files(file_list, default_branch=u'.'):
80
"""Convert command-line paths to a WorkingTree and relative paths.
82
This is typically used for command-line processors that take one or
83
more filenames, and infer the workingtree that contains them.
85
The filenames given are not required to exist.
87
:param file_list: Filenames to convert.
89
:param default_branch: Fallback tree path to use if file_list is empty or
92
:return: workingtree, [relative_paths]
94
if file_list is None or len(file_list) == 0:
95
return WorkingTree.open_containing(default_branch)[0], file_list
96
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
98
for filename in file_list:
100
new_list.append(tree.relpath(osutils.dereference_path(filename)))
101
except errors.PathNotChild:
102
raise errors.FileInWrongBranch(tree.branch, filename)
103
return tree, new_list
106
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
107
def get_format_type(typestring):
108
"""Parse and return a format specifier."""
109
# Have to use BzrDirMetaFormat1 directly, so that
110
# RepositoryFormat.set_default_format works
111
if typestring == "default":
112
return bzrdir.BzrDirMetaFormat1()
114
return bzrdir.format_registry.make_bzrdir(typestring)
116
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
117
raise errors.BzrCommandError(msg)
120
# TODO: Make sure no commands unconditionally use the working directory as a
121
# branch. If a filename argument is used, the first of them should be used to
122
# specify the branch. (Perhaps this can be factored out into some kind of
123
# Argument class, representing a file in a branch, where the first occurrence
126
class cmd_status(Command):
127
"""Display status summary.
129
This reports on versioned and unknown files, reporting them
130
grouped by state. Possible states are:
133
Versioned in the working copy but not in the previous revision.
136
Versioned in the previous revision but removed or deleted
140
Path of this file changed from the previous revision;
141
the text may also have changed. This includes files whose
142
parent directory was renamed.
145
Text has changed since the previous revision.
148
File kind has been changed (e.g. from file to directory).
151
Not versioned and not matching an ignore pattern.
153
To see ignored files use 'bzr ignored'. For details on the
154
changes to file texts, use 'bzr diff'.
156
Note that --short or -S gives status flags for each item, similar
157
to Subversion's status command. To get output similar to svn -q,
160
If no arguments are specified, the status of the entire working
161
directory is shown. Otherwise, only the status of the specified
162
files or directories is reported. If a directory is given, status
163
is reported for everything inside that directory.
165
If a revision argument is given, the status is calculated against
166
that revision, or between two revisions if two are provided.
169
# TODO: --no-recurse, --recurse options
171
takes_args = ['file*']
172
takes_options = ['show-ids', 'revision', 'change',
173
Option('short', help='Use short status indicators.',
175
Option('versioned', help='Only show versioned files.',
178
aliases = ['st', 'stat']
180
encoding_type = 'replace'
181
_see_also = ['diff', 'revert', 'status-flags']
184
def run(self, show_ids=False, file_list=None, revision=None, short=False,
186
from bzrlib.status import show_tree_status
188
if revision and len(revision) > 2:
189
raise errors.BzrCommandError('bzr status --revision takes exactly'
190
' one or two revision specifiers')
192
tree, file_list = tree_files(file_list)
194
show_tree_status(tree, show_ids=show_ids,
195
specific_files=file_list, revision=revision,
196
to_file=self.outf, short=short, versioned=versioned)
199
class cmd_cat_revision(Command):
200
"""Write out metadata for a revision.
202
The revision to print can either be specified by a specific
203
revision identifier, or you can use --revision.
207
takes_args = ['revision_id?']
208
takes_options = ['revision']
209
# cat-revision is more for frontends so should be exact
213
def run(self, revision_id=None, revision=None):
215
revision_id = osutils.safe_revision_id(revision_id, warn=False)
216
if revision_id is not None and revision is not None:
217
raise errors.BzrCommandError('You can only supply one of'
218
' revision_id or --revision')
219
if revision_id is None and revision is None:
220
raise errors.BzrCommandError('You must supply either'
221
' --revision or a revision_id')
222
b = WorkingTree.open_containing(u'.')[0].branch
224
# TODO: jam 20060112 should cat-revision always output utf-8?
225
if revision_id is not None:
226
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
227
elif revision is not None:
230
raise errors.BzrCommandError('You cannot specify a NULL'
232
revno, rev_id = rev.in_history(b)
233
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
236
class cmd_remove_tree(Command):
237
"""Remove the working tree from a given branch/checkout.
239
Since a lightweight checkout is little more than a working tree
240
this will refuse to run against one.
242
To re-create the working tree, use "bzr checkout".
244
_see_also = ['checkout', 'working-trees']
246
takes_args = ['location?']
248
def run(self, location='.'):
249
d = bzrdir.BzrDir.open(location)
252
working = d.open_workingtree()
253
except errors.NoWorkingTree:
254
raise errors.BzrCommandError("No working tree to remove")
255
except errors.NotLocalUrl:
256
raise errors.BzrCommandError("You cannot remove the working tree of a "
259
working_path = working.bzrdir.root_transport.base
260
branch_path = working.branch.bzrdir.root_transport.base
261
if working_path != branch_path:
262
raise errors.BzrCommandError("You cannot remove the working tree from "
263
"a lightweight checkout")
265
d.destroy_workingtree()
268
class cmd_revno(Command):
269
"""Show current revision number.
271
This is equal to the number of revisions on this branch.
275
takes_args = ['location?']
278
def run(self, location=u'.'):
279
self.outf.write(str(Branch.open_containing(location)[0].revno()))
280
self.outf.write('\n')
283
class cmd_revision_info(Command):
284
"""Show revision number and revision id for a given revision identifier.
287
takes_args = ['revision_info*']
288
takes_options = ['revision']
291
def run(self, revision=None, revision_info_list=[]):
294
if revision is not None:
295
revs.extend(revision)
296
if revision_info_list is not None:
297
for rev in revision_info_list:
298
revs.append(RevisionSpec.from_string(rev))
300
b = Branch.open_containing(u'.')[0]
303
revs.append(RevisionSpec.from_string('-1'))
306
revinfo = rev.in_history(b)
307
if revinfo.revno is None:
308
dotted_map = b.get_revision_id_to_revno_map()
309
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
310
print '%s %s' % (revno, revinfo.rev_id)
312
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
315
class cmd_add(Command):
316
"""Add specified files or directories.
318
In non-recursive mode, all the named items are added, regardless
319
of whether they were previously ignored. A warning is given if
320
any of the named files are already versioned.
322
In recursive mode (the default), files are treated the same way
323
but the behaviour for directories is different. Directories that
324
are already versioned do not give a warning. All directories,
325
whether already versioned or not, are searched for files or
326
subdirectories that are neither versioned or ignored, and these
327
are added. This search proceeds recursively into versioned
328
directories. If no names are given '.' is assumed.
330
Therefore simply saying 'bzr add' will version all files that
331
are currently unknown.
333
Adding a file whose parent directory is not versioned will
334
implicitly add the parent, and so on up to the root. This means
335
you should never need to explicitly add a directory, they'll just
336
get added when you add a file in the directory.
338
--dry-run will show which files would be added, but not actually
341
--file-ids-from will try to use the file ids from the supplied path.
342
It looks up ids trying to find a matching parent directory with the
343
same filename, and then by pure path. This option is rarely needed
344
but can be useful when adding the same logical file into two
345
branches that will be merged later (without showing the two different
346
adds as a conflict). It is also useful when merging another project
347
into a subdirectory of this one.
349
takes_args = ['file*']
352
help="Don't recursively add the contents of directories."),
354
help="Show what would be done, but don't actually do anything."),
356
Option('file-ids-from',
358
help='Lookup file ids from this tree.'),
360
encoding_type = 'replace'
361
_see_also = ['remove']
363
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
368
if file_ids_from is not None:
370
base_tree, base_path = WorkingTree.open_containing(
372
except errors.NoWorkingTree:
373
base_branch, base_path = Branch.open_containing(
375
base_tree = base_branch.basis_tree()
377
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
378
to_file=self.outf, should_print=(not is_quiet()))
380
action = bzrlib.add.AddAction(to_file=self.outf,
381
should_print=(not is_quiet()))
384
base_tree.lock_read()
386
file_list = self._maybe_expand_globs(file_list)
388
tree = WorkingTree.open_containing(file_list[0])[0]
390
tree = WorkingTree.open_containing(u'.')[0]
391
added, ignored = tree.smart_add(file_list, not
392
no_recurse, action=action, save=not dry_run)
394
if base_tree is not None:
398
for glob in sorted(ignored.keys()):
399
for path in ignored[glob]:
400
self.outf.write("ignored %s matching \"%s\"\n"
404
for glob, paths in ignored.items():
405
match_len += len(paths)
406
self.outf.write("ignored %d file(s).\n" % match_len)
407
self.outf.write("If you wish to add some of these files,"
408
" please add them by name.\n")
411
class cmd_mkdir(Command):
412
"""Create a new versioned directory.
414
This is equivalent to creating the directory and then adding it.
417
takes_args = ['dir+']
418
encoding_type = 'replace'
420
def run(self, dir_list):
423
wt, dd = WorkingTree.open_containing(d)
425
self.outf.write('added %s\n' % d)
428
class cmd_relpath(Command):
429
"""Show path of a file relative to root"""
431
takes_args = ['filename']
435
def run(self, filename):
436
# TODO: jam 20050106 Can relpath return a munged path if
437
# sys.stdout encoding cannot represent it?
438
tree, relpath = WorkingTree.open_containing(filename)
439
self.outf.write(relpath)
440
self.outf.write('\n')
443
class cmd_inventory(Command):
444
"""Show inventory of the current working copy or a revision.
446
It is possible to limit the output to a particular entry
447
type using the --kind option. For example: --kind file.
449
It is also possible to restrict the list of files to a specific
450
set. For example: bzr inventory --show-ids this/file
459
help='List entries of a particular kind: file, directory, symlink.',
462
takes_args = ['file*']
465
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
466
if kind and kind not in ['file', 'directory', 'symlink']:
467
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
469
work_tree, file_list = tree_files(file_list)
470
work_tree.lock_read()
472
if revision is not None:
473
if len(revision) > 1:
474
raise errors.BzrCommandError(
475
'bzr inventory --revision takes exactly one revision'
477
revision_id = revision[0].in_history(work_tree.branch).rev_id
478
tree = work_tree.branch.repository.revision_tree(revision_id)
480
extra_trees = [work_tree]
486
if file_list is not None:
487
file_ids = tree.paths2ids(file_list, trees=extra_trees,
488
require_versioned=True)
489
# find_ids_across_trees may include some paths that don't
491
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
492
for file_id in file_ids if file_id in tree)
494
entries = tree.inventory.entries()
497
if tree is not work_tree:
500
for path, entry in entries:
501
if kind and kind != entry.kind:
504
self.outf.write('%-50s %s\n' % (path, entry.file_id))
506
self.outf.write(path)
507
self.outf.write('\n')
510
class cmd_mv(Command):
511
"""Move or rename a file.
514
bzr mv OLDNAME NEWNAME
516
bzr mv SOURCE... DESTINATION
518
If the last argument is a versioned directory, all the other names
519
are moved into it. Otherwise, there must be exactly two arguments
520
and the file is changed to a new name.
522
If OLDNAME does not exist on the filesystem but is versioned and
523
NEWNAME does exist on the filesystem but is not versioned, mv
524
assumes that the file has been manually moved and only updates
525
its internal inventory to reflect that change.
526
The same is valid when moving many SOURCE files to a DESTINATION.
528
Files cannot be moved between branches.
531
takes_args = ['names*']
532
takes_options = [Option("after", help="Move only the bzr identifier"
533
" of the file, because the file has already been moved."),
535
aliases = ['move', 'rename']
536
encoding_type = 'replace'
538
def run(self, names_list, after=False):
539
if names_list is None:
542
if len(names_list) < 2:
543
raise errors.BzrCommandError("missing file argument")
544
tree, rel_names = tree_files(names_list)
546
if os.path.isdir(names_list[-1]):
547
# move into existing directory
548
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
549
self.outf.write("%s => %s\n" % pair)
551
if len(names_list) != 2:
552
raise errors.BzrCommandError('to mv multiple files the'
553
' destination must be a versioned'
555
tree.rename_one(rel_names[0], rel_names[1], after=after)
556
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
559
class cmd_pull(Command):
560
"""Turn this branch into a mirror of another branch.
562
This command only works on branches that have not diverged. Branches are
563
considered diverged if the destination branch's most recent commit is one
564
that has not been merged (directly or indirectly) into the parent.
566
If branches have diverged, you can use 'bzr merge' to integrate the changes
567
from one into the other. Once one branch has merged, the other should
568
be able to pull it again.
570
If you want to forget your local changes and just update your branch to
571
match the remote one, use pull --overwrite.
573
If there is no default location set, the first pull will set it. After
574
that, you can omit the location to use the default. To change the
575
default, use --remember. The value will only be saved if the remote
576
location can be accessed.
579
_see_also = ['push', 'update', 'status-flags']
580
takes_options = ['remember', 'overwrite', 'revision',
581
custom_help('verbose',
582
help='Show logs of pulled revisions.'),
584
help='Branch to pull into, '
585
'rather than the one containing the working directory.',
590
takes_args = ['location?']
591
encoding_type = 'replace'
593
def run(self, location=None, remember=False, overwrite=False,
594
revision=None, verbose=False,
596
# FIXME: too much stuff is in the command class
599
if directory is None:
602
tree_to = WorkingTree.open_containing(directory)[0]
603
branch_to = tree_to.branch
604
except errors.NoWorkingTree:
606
branch_to = Branch.open_containing(directory)[0]
608
if location is not None:
609
mergeable, location_transport = _get_mergeable_helper(location)
611
stored_loc = branch_to.get_parent()
613
if stored_loc is None:
614
raise errors.BzrCommandError("No pull location known or"
617
display_url = urlutils.unescape_for_display(stored_loc,
619
self.outf.write("Using saved location: %s\n" % display_url)
620
location = stored_loc
621
location_transport = transport.get_transport(location)
623
if mergeable is not None:
624
if revision is not None:
625
raise errors.BzrCommandError(
626
'Cannot use -r with merge directives or bundles')
627
mergeable.install_revisions(branch_to.repository)
628
base_revision_id, revision_id, verified = \
629
mergeable.get_merge_request(branch_to.repository)
630
branch_from = branch_to
632
branch_from = Branch.open_from_transport(location_transport)
634
if branch_to.get_parent() is None or remember:
635
branch_to.set_parent(branch_from.base)
637
if revision is not None:
638
if len(revision) == 1:
639
revision_id = revision[0].in_history(branch_from).rev_id
641
raise errors.BzrCommandError(
642
'bzr pull --revision takes one value.')
645
old_rh = branch_to.revision_history()
646
if tree_to is not None:
647
result = tree_to.pull(branch_from, overwrite, revision_id,
648
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
650
result = branch_to.pull(branch_from, overwrite, revision_id)
652
result.report(self.outf)
654
new_rh = branch_to.revision_history()
655
log.show_changed_revisions(branch_to, old_rh, new_rh,
659
class cmd_push(Command):
660
"""Update a mirror of this branch.
662
The target branch will not have its working tree populated because this
663
is both expensive, and is not supported on remote file systems.
665
Some smart servers or protocols *may* put the working tree in place in
668
This command only works on branches that have not diverged. Branches are
669
considered diverged if the destination branch's most recent commit is one
670
that has not been merged (directly or indirectly) by the source branch.
672
If branches have diverged, you can use 'bzr push --overwrite' to replace
673
the other branch completely, discarding its unmerged changes.
675
If you want to ensure you have the different changes in the other branch,
676
do a merge (see bzr help merge) from the other branch, and commit that.
677
After that you will be able to do a push without '--overwrite'.
679
If there is no default push location set, the first push will set it.
680
After that, you can omit the location to use the default. To change the
681
default, use --remember. The value will only be saved if the remote
682
location can be accessed.
685
_see_also = ['pull', 'update', 'working-trees']
686
takes_options = ['remember', 'overwrite', 'verbose',
687
Option('create-prefix',
688
help='Create the path leading up to the branch '
689
'if it does not already exist.'),
691
help='Branch to push from, '
692
'rather than the one containing the working directory.',
696
Option('use-existing-dir',
697
help='By default push will fail if the target'
698
' directory exists, but does not already'
699
' have a control directory. This flag will'
700
' allow push to proceed.'),
702
takes_args = ['location?']
703
encoding_type = 'replace'
705
def run(self, location=None, remember=False, overwrite=False,
706
create_prefix=False, verbose=False,
707
use_existing_dir=False,
709
# FIXME: Way too big! Put this into a function called from the
711
if directory is None:
713
br_from = Branch.open_containing(directory)[0]
714
stored_loc = br_from.get_push_location()
716
if stored_loc is None:
717
raise errors.BzrCommandError("No push location known or specified.")
719
display_url = urlutils.unescape_for_display(stored_loc,
721
self.outf.write("Using saved location: %s\n" % display_url)
722
location = stored_loc
724
to_transport = transport.get_transport(location)
726
br_to = repository_to = dir_to = None
728
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
729
except errors.NotBranchError:
730
pass # Didn't find anything
732
# If we can open a branch, use its direct repository, otherwise see
733
# if there is a repository without a branch.
735
br_to = dir_to.open_branch()
736
except errors.NotBranchError:
737
# Didn't find a branch, can we find a repository?
739
repository_to = dir_to.find_repository()
740
except errors.NoRepositoryPresent:
743
# Found a branch, so we must have found a repository
744
repository_to = br_to.repository
749
# The destination doesn't exist; create it.
750
# XXX: Refactor the create_prefix/no_create_prefix code into a
751
# common helper function
753
to_transport.mkdir('.')
754
except errors.FileExists:
755
if not use_existing_dir:
756
raise errors.BzrCommandError("Target directory %s"
757
" already exists, but does not have a valid .bzr"
758
" directory. Supply --use-existing-dir to push"
759
" there anyway." % location)
760
except errors.NoSuchFile:
761
if not create_prefix:
762
raise errors.BzrCommandError("Parent directory of %s"
764
"\nYou may supply --create-prefix to create all"
765
" leading parent directories."
767
_create_prefix(to_transport)
769
# Now the target directory exists, but doesn't have a .bzr
770
# directory. So we need to create it, along with any work to create
771
# all of the dependent branches, etc.
772
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
773
revision_id=br_from.last_revision())
774
br_to = dir_to.open_branch()
775
# TODO: Some more useful message about what was copied
776
note('Created new branch.')
777
# We successfully created the target, remember it
778
if br_from.get_push_location() is None or remember:
779
br_from.set_push_location(br_to.base)
780
elif repository_to is None:
781
# we have a bzrdir but no branch or repository
782
# XXX: Figure out what to do other than complain.
783
raise errors.BzrCommandError("At %s you have a valid .bzr control"
784
" directory, but not a branch or repository. This is an"
785
" unsupported configuration. Please move the target directory"
786
" out of the way and try again."
789
# We have a repository but no branch, copy the revisions, and then
791
last_revision_id = br_from.last_revision()
792
repository_to.fetch(br_from.repository,
793
revision_id=last_revision_id)
794
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
795
note('Created new branch.')
796
if br_from.get_push_location() is None or remember:
797
br_from.set_push_location(br_to.base)
798
else: # We have a valid to branch
799
# We were able to connect to the remote location, so remember it
800
# we don't need to successfully push because of possible divergence.
801
if br_from.get_push_location() is None or remember:
802
br_from.set_push_location(br_to.base)
804
old_rh = br_to.revision_history()
807
tree_to = dir_to.open_workingtree()
808
except errors.NotLocalUrl:
809
warning("This transport does not update the working "
810
"tree of: %s. See 'bzr help working-trees' for "
811
"more information." % br_to.base)
812
push_result = br_from.push(br_to, overwrite)
813
except errors.NoWorkingTree:
814
push_result = br_from.push(br_to, overwrite)
818
push_result = br_from.push(tree_to.branch, overwrite)
822
except errors.DivergedBranches:
823
raise errors.BzrCommandError('These branches have diverged.'
824
' Try using "merge" and then "push".')
825
if push_result is not None:
826
push_result.report(self.outf)
828
new_rh = br_to.revision_history()
831
from bzrlib.log import show_changed_revisions
832
show_changed_revisions(br_to, old_rh, new_rh,
835
# we probably did a clone rather than a push, so a message was
840
class cmd_branch(Command):
841
"""Create a new copy of a branch.
843
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
844
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
845
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
846
is derived from the FROM_LOCATION by stripping a leading scheme or drive
847
identifier, if any. For example, "branch lp:foo-bar" will attempt to
850
To retrieve the branch as of a particular revision, supply the --revision
851
parameter, as in "branch foo/bar -r 5".
854
_see_also = ['checkout']
855
takes_args = ['from_location', 'to_location?']
856
takes_options = ['revision']
857
aliases = ['get', 'clone']
859
def run(self, from_location, to_location=None, revision=None):
860
from bzrlib.tag import _merge_tags_if_possible
863
elif len(revision) > 1:
864
raise errors.BzrCommandError(
865
'bzr branch --revision takes exactly 1 revision value')
867
br_from = Branch.open(from_location)
870
if len(revision) == 1 and revision[0] is not None:
871
revision_id = revision[0].in_history(br_from)[1]
873
# FIXME - wt.last_revision, fallback to branch, fall back to
874
# None or perhaps NULL_REVISION to mean copy nothing
876
revision_id = br_from.last_revision()
877
if to_location is None:
878
to_location = urlutils.derive_to_location(from_location)
881
name = os.path.basename(to_location) + '\n'
883
to_transport = transport.get_transport(to_location)
885
to_transport.mkdir('.')
886
except errors.FileExists:
887
raise errors.BzrCommandError('Target directory "%s" already'
888
' exists.' % to_location)
889
except errors.NoSuchFile:
890
raise errors.BzrCommandError('Parent of "%s" does not exist.'
893
# preserve whatever source format we have.
894
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
895
possible_transports=[to_transport])
896
branch = dir.open_branch()
897
except errors.NoSuchRevision:
898
to_transport.delete_tree('.')
899
msg = "The branch %s has no revision %s." % (from_location, revision[0])
900
raise errors.BzrCommandError(msg)
902
branch.control_files.put_utf8('branch-name', name)
903
_merge_tags_if_possible(br_from, branch)
904
note('Branched %d revision(s).' % branch.revno())
909
class cmd_checkout(Command):
910
"""Create a new checkout of an existing branch.
912
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
913
the branch found in '.'. This is useful if you have removed the working tree
914
or if it was never created - i.e. if you pushed the branch to its current
917
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
918
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
919
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
920
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
921
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
924
To retrieve the branch as of a particular revision, supply the --revision
925
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
926
out of date [so you cannot commit] but it may be useful (i.e. to examine old
930
_see_also = ['checkouts', 'branch']
931
takes_args = ['branch_location?', 'to_location?']
932
takes_options = ['revision',
933
Option('lightweight',
934
help="Perform a lightweight checkout. Lightweight "
935
"checkouts depend on access to the branch for "
936
"every operation. Normal checkouts can perform "
937
"common operations like diff and status without "
938
"such access, and also support local commits."
943
def run(self, branch_location=None, to_location=None, revision=None,
947
elif len(revision) > 1:
948
raise errors.BzrCommandError(
949
'bzr checkout --revision takes exactly 1 revision value')
950
if branch_location is None:
951
branch_location = osutils.getcwd()
952
to_location = branch_location
953
source = Branch.open(branch_location)
954
if len(revision) == 1 and revision[0] is not None:
955
revision_id = _mod_revision.ensure_null(
956
revision[0].in_history(source)[1])
959
if to_location is None:
960
to_location = urlutils.derive_to_location(branch_location)
961
# if the source and to_location are the same,
962
# and there is no working tree,
963
# then reconstitute a branch
964
if (osutils.abspath(to_location) ==
965
osutils.abspath(branch_location)):
967
source.bzrdir.open_workingtree()
968
except errors.NoWorkingTree:
969
source.bzrdir.create_workingtree(revision_id)
971
source.create_checkout(to_location, revision_id, lightweight)
974
class cmd_renames(Command):
975
"""Show list of renamed files.
977
# TODO: Option to show renames between two historical versions.
979
# TODO: Only show renames under dir, rather than in the whole branch.
980
_see_also = ['status']
981
takes_args = ['dir?']
984
def run(self, dir=u'.'):
985
tree = WorkingTree.open_containing(dir)[0]
988
new_inv = tree.inventory
989
old_tree = tree.basis_tree()
992
old_inv = old_tree.inventory
993
renames = list(_mod_tree.find_renames(old_inv, new_inv))
995
for old_name, new_name in renames:
996
self.outf.write("%s => %s\n" % (old_name, new_name))
1003
class cmd_update(Command):
1004
"""Update a tree to have the latest code committed to its branch.
1006
This will perform a merge into the working tree, and may generate
1007
conflicts. If you have any local changes, you will still
1008
need to commit them after the update for the update to be complete.
1010
If you want to discard your local changes, you can just do a
1011
'bzr revert' instead of 'bzr commit' after the update.
1014
_see_also = ['pull', 'working-trees', 'status-flags']
1015
takes_args = ['dir?']
1018
def run(self, dir='.'):
1019
tree = WorkingTree.open_containing(dir)[0]
1020
possible_transports = []
1021
master = tree.branch.get_master_branch(
1022
possible_transports=possible_transports)
1023
if master is not None:
1026
tree.lock_tree_write()
1028
existing_pending_merges = tree.get_parent_ids()[1:]
1029
last_rev = _mod_revision.ensure_null(tree.last_revision())
1030
if last_rev == _mod_revision.ensure_null(
1031
tree.branch.last_revision()):
1032
# may be up to date, check master too.
1033
if master is None or last_rev == _mod_revision.ensure_null(
1034
master.last_revision()):
1035
revno = tree.branch.revision_id_to_revno(last_rev)
1036
note("Tree is up to date at revision %d." % (revno,))
1038
conflicts = tree.update(
1039
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1040
possible_transports=possible_transports)
1041
revno = tree.branch.revision_id_to_revno(
1042
_mod_revision.ensure_null(tree.last_revision()))
1043
note('Updated to revision %d.' % (revno,))
1044
if tree.get_parent_ids()[1:] != existing_pending_merges:
1045
note('Your local commits will now show as pending merges with '
1046
"'bzr status', and can be committed with 'bzr commit'.")
1055
class cmd_info(Command):
1056
"""Show information about a working tree, branch or repository.
1058
This command will show all known locations and formats associated to the
1059
tree, branch or repository. Statistical information is included with
1062
Branches and working trees will also report any missing revisions.
1064
_see_also = ['revno', 'working-trees', 'repositories']
1065
takes_args = ['location?']
1066
takes_options = ['verbose']
1069
def run(self, location=None, verbose=False):
1074
from bzrlib.info import show_bzrdir_info
1075
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1076
verbose=noise_level)
1079
class cmd_remove(Command):
1080
"""Remove files or directories.
1082
This makes bzr stop tracking changes to the specified files and
1083
delete them if they can easily be recovered using revert.
1085
You can specify one or more files, and/or --new. If you specify --new,
1086
only 'added' files will be removed. If you specify both, then new files
1087
in the specified directories will be removed. If the directories are
1088
also new, they will also be removed.
1090
takes_args = ['file*']
1091
takes_options = ['verbose',
1092
Option('new', help='Remove newly-added files.'),
1093
RegistryOption.from_kwargs('file-deletion-strategy',
1094
'The file deletion mode to be used.',
1095
title='Deletion Strategy', value_switches=True, enum_switch=False,
1096
safe='Only delete files if they can be'
1097
' safely recovered (default).',
1098
keep="Don't delete any files.",
1099
force='Delete all the specified files, even if they can not be '
1100
'recovered and even if they are non-empty directories.')]
1102
encoding_type = 'replace'
1104
def run(self, file_list, verbose=False, new=False,
1105
file_deletion_strategy='safe'):
1106
tree, file_list = tree_files(file_list)
1108
if file_list is not None:
1109
file_list = [f for f in file_list]
1111
raise errors.BzrCommandError('Specify one or more files to'
1112
' remove, or use --new.')
1115
added = tree.changes_from(tree.basis_tree(),
1116
specific_files=file_list).added
1117
file_list = sorted([f[0] for f in added], reverse=True)
1118
if len(file_list) == 0:
1119
raise errors.BzrCommandError('No matching files.')
1120
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1121
keep_files=file_deletion_strategy=='keep',
1122
force=file_deletion_strategy=='force')
1125
class cmd_file_id(Command):
1126
"""Print file_id of a particular file or directory.
1128
The file_id is assigned when the file is first added and remains the
1129
same through all revisions where the file exists, even when it is
1134
_see_also = ['inventory', 'ls']
1135
takes_args = ['filename']
1138
def run(self, filename):
1139
tree, relpath = WorkingTree.open_containing(filename)
1140
i = tree.path2id(relpath)
1142
raise errors.NotVersionedError(filename)
1144
self.outf.write(i + '\n')
1147
class cmd_file_path(Command):
1148
"""Print path of file_ids to a file or directory.
1150
This prints one line for each directory down to the target,
1151
starting at the branch root.
1155
takes_args = ['filename']
1158
def run(self, filename):
1159
tree, relpath = WorkingTree.open_containing(filename)
1160
fid = tree.path2id(relpath)
1162
raise errors.NotVersionedError(filename)
1163
segments = osutils.splitpath(relpath)
1164
for pos in range(1, len(segments) + 1):
1165
path = osutils.joinpath(segments[:pos])
1166
self.outf.write("%s\n" % tree.path2id(path))
1169
class cmd_reconcile(Command):
1170
"""Reconcile bzr metadata in a branch.
1172
This can correct data mismatches that may have been caused by
1173
previous ghost operations or bzr upgrades. You should only
1174
need to run this command if 'bzr check' or a bzr developer
1175
advises you to run it.
1177
If a second branch is provided, cross-branch reconciliation is
1178
also attempted, which will check that data like the tree root
1179
id which was not present in very early bzr versions is represented
1180
correctly in both branches.
1182
At the same time it is run it may recompress data resulting in
1183
a potential saving in disk space or performance gain.
1185
The branch *MUST* be on a listable system such as local disk or sftp.
1188
_see_also = ['check']
1189
takes_args = ['branch?']
1191
def run(self, branch="."):
1192
from bzrlib.reconcile import reconcile
1193
dir = bzrdir.BzrDir.open(branch)
1197
class cmd_revision_history(Command):
1198
"""Display the list of revision ids on a branch."""
1201
takes_args = ['location?']
1206
def run(self, location="."):
1207
branch = Branch.open_containing(location)[0]
1208
for revid in branch.revision_history():
1209
self.outf.write(revid)
1210
self.outf.write('\n')
1213
class cmd_ancestry(Command):
1214
"""List all revisions merged into this branch."""
1216
_see_also = ['log', 'revision-history']
1217
takes_args = ['location?']
1222
def run(self, location="."):
1224
wt = WorkingTree.open_containing(location)[0]
1225
except errors.NoWorkingTree:
1226
b = Branch.open(location)
1227
last_revision = b.last_revision()
1230
last_revision = wt.last_revision()
1232
revision_ids = b.repository.get_ancestry(last_revision)
1233
assert revision_ids[0] is None
1235
for revision_id in revision_ids:
1236
self.outf.write(revision_id + '\n')
1239
class cmd_init(Command):
1240
"""Make a directory into a versioned branch.
1242
Use this to create an empty branch, or before importing an
1245
If there is a repository in a parent directory of the location, then
1246
the history of the branch will be stored in the repository. Otherwise
1247
init creates a standalone branch which carries its own history
1248
in the .bzr directory.
1250
If there is already a branch at the location but it has no working tree,
1251
the tree can be populated with 'bzr checkout'.
1253
Recipe for importing a tree of files::
1259
bzr commit -m 'imported project'
1262
_see_also = ['init-repository', 'branch', 'checkout']
1263
takes_args = ['location?']
1265
Option('create-prefix',
1266
help='Create the path leading up to the branch '
1267
'if it does not already exist.'),
1268
RegistryOption('format',
1269
help='Specify a format for this branch. '
1270
'See "help formats".',
1271
registry=bzrdir.format_registry,
1272
converter=bzrdir.format_registry.make_bzrdir,
1273
value_switches=True,
1274
title="Branch Format",
1276
Option('append-revisions-only',
1277
help='Never change revnos or the existing log.'
1278
' Append revisions to it only.')
1280
def run(self, location=None, format=None, append_revisions_only=False,
1281
create_prefix=False):
1283
format = bzrdir.format_registry.make_bzrdir('default')
1284
if location is None:
1287
to_transport = transport.get_transport(location)
1289
# The path has to exist to initialize a
1290
# branch inside of it.
1291
# Just using os.mkdir, since I don't
1292
# believe that we want to create a bunch of
1293
# locations if the user supplies an extended path
1295
to_transport.ensure_base()
1296
except errors.NoSuchFile:
1297
if not create_prefix:
1298
raise errors.BzrCommandError("Parent directory of %s"
1300
"\nYou may supply --create-prefix to create all"
1301
" leading parent directories."
1303
_create_prefix(to_transport)
1306
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1307
except errors.NotBranchError:
1308
# really a NotBzrDir error...
1309
create_branch = bzrdir.BzrDir.create_branch_convenience
1310
branch = create_branch(to_transport.base, format=format,
1311
possible_transports=[to_transport])
1313
from bzrlib.transport.local import LocalTransport
1314
if existing_bzrdir.has_branch():
1315
if (isinstance(to_transport, LocalTransport)
1316
and not existing_bzrdir.has_workingtree()):
1317
raise errors.BranchExistsWithoutWorkingTree(location)
1318
raise errors.AlreadyBranchError(location)
1320
branch = existing_bzrdir.create_branch()
1321
existing_bzrdir.create_workingtree()
1322
if append_revisions_only:
1324
branch.set_append_revisions_only(True)
1325
except errors.UpgradeRequired:
1326
raise errors.BzrCommandError('This branch format cannot be set'
1327
' to append-revisions-only. Try --experimental-branch6')
1330
class cmd_init_repository(Command):
1331
"""Create a shared repository to hold branches.
1333
New branches created under the repository directory will store their
1334
revisions in the repository, not in the branch directory.
1336
If the --no-trees option is used then the branches in the repository
1337
will not have working trees by default.
1340
Create a shared repositories holding just branches::
1342
bzr init-repo --no-trees repo
1345
Make a lightweight checkout elsewhere::
1347
bzr checkout --lightweight repo/trunk trunk-checkout
1352
_see_also = ['init', 'branch', 'checkout', 'repositories']
1353
takes_args = ["location"]
1354
takes_options = [RegistryOption('format',
1355
help='Specify a format for this repository. See'
1356
' "bzr help formats" for details.',
1357
registry=bzrdir.format_registry,
1358
converter=bzrdir.format_registry.make_bzrdir,
1359
value_switches=True, title='Repository format'),
1361
help='Branches in the repository will default to'
1362
' not having a working tree.'),
1364
aliases = ["init-repo"]
1366
def run(self, location, format=None, no_trees=False):
1368
format = bzrdir.format_registry.make_bzrdir('default')
1370
if location is None:
1373
to_transport = transport.get_transport(location)
1374
to_transport.ensure_base()
1376
newdir = format.initialize_on_transport(to_transport)
1377
repo = newdir.create_repository(shared=True)
1378
repo.set_make_working_trees(not no_trees)
1381
class cmd_diff(Command):
1382
"""Show differences in the working tree or between revisions.
1384
If files are listed, only the changes in those files are listed.
1385
Otherwise, all changes for the tree are listed.
1387
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1388
produces patches suitable for "patch -p1".
1391
Shows the difference in the working tree versus the last commit::
1395
Difference between the working tree and revision 1::
1399
Difference between revision 2 and revision 1::
1403
Same as 'bzr diff' but prefix paths with old/ and new/::
1405
bzr diff --prefix old/:new/
1407
Show the differences between the two working trees::
1409
bzr diff bzr.mine bzr.dev
1411
Show just the differences for 'foo.c'::
1415
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1416
# or a graphical diff.
1418
# TODO: Python difflib is not exactly the same as unidiff; should
1419
# either fix it up or prefer to use an external diff.
1421
# TODO: Selected-file diff is inefficient and doesn't show you
1424
# TODO: This probably handles non-Unix newlines poorly.
1426
_see_also = ['status']
1427
takes_args = ['file*']
1429
Option('diff-options', type=str,
1430
help='Pass these options to the external diff program.'),
1431
Option('prefix', type=str,
1433
help='Set prefixes added to old and new filenames, as '
1434
'two values separated by a colon. (eg "old/:new/").'),
1438
aliases = ['di', 'dif']
1439
encoding_type = 'exact'
1442
def run(self, revision=None, file_list=None, diff_options=None,
1444
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1446
if (prefix is None) or (prefix == '0'):
1454
old_label, new_label = prefix.split(":")
1456
raise errors.BzrCommandError(
1457
'--prefix expects two values separated by a colon'
1458
' (eg "old/:new/")')
1460
if revision and len(revision) > 2:
1461
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1462
' one or two revision specifiers')
1465
tree1, file_list = internal_tree_files(file_list)
1469
except errors.FileInWrongBranch:
1470
if len(file_list) != 2:
1471
raise errors.BzrCommandError("Files are in different branches")
1473
tree1, file1 = WorkingTree.open_containing(file_list[0])
1474
tree2, file2 = WorkingTree.open_containing(file_list[1])
1475
if file1 != "" or file2 != "":
1476
# FIXME diff those two files. rbc 20051123
1477
raise errors.BzrCommandError("Files are in different branches")
1479
except errors.NotBranchError:
1480
if (revision is not None and len(revision) == 2
1481
and not revision[0].needs_branch()
1482
and not revision[1].needs_branch()):
1483
# If both revision specs include a branch, we can
1484
# diff them without needing a local working tree
1485
tree1, tree2 = None, None
1489
if tree2 is not None:
1490
if revision is not None:
1491
# FIXME: but there should be a clean way to diff between
1492
# non-default versions of two trees, it's not hard to do
1494
raise errors.BzrCommandError(
1495
"Sorry, diffing arbitrary revisions across branches "
1496
"is not implemented yet")
1497
return show_diff_trees(tree1, tree2, sys.stdout,
1498
specific_files=file_list,
1499
external_diff_options=diff_options,
1500
old_label=old_label, new_label=new_label)
1502
return diff_cmd_helper(tree1, file_list, diff_options,
1503
revision_specs=revision,
1504
old_label=old_label, new_label=new_label)
1507
class cmd_deleted(Command):
1508
"""List files deleted in the working tree.
1510
# TODO: Show files deleted since a previous revision, or
1511
# between two revisions.
1512
# TODO: Much more efficient way to do this: read in new
1513
# directories with readdir, rather than stating each one. Same
1514
# level of effort but possibly much less IO. (Or possibly not,
1515
# if the directories are very large...)
1516
_see_also = ['status', 'ls']
1517
takes_options = ['show-ids']
1520
def run(self, show_ids=False):
1521
tree = WorkingTree.open_containing(u'.')[0]
1524
old = tree.basis_tree()
1527
for path, ie in old.inventory.iter_entries():
1528
if not tree.has_id(ie.file_id):
1529
self.outf.write(path)
1531
self.outf.write(' ')
1532
self.outf.write(ie.file_id)
1533
self.outf.write('\n')
1540
class cmd_modified(Command):
1541
"""List files modified in working tree.
1545
_see_also = ['status', 'ls']
1549
tree = WorkingTree.open_containing(u'.')[0]
1550
td = tree.changes_from(tree.basis_tree())
1551
for path, id, kind, text_modified, meta_modified in td.modified:
1552
self.outf.write(path + '\n')
1555
class cmd_added(Command):
1556
"""List files added in working tree.
1560
_see_also = ['status', 'ls']
1564
wt = WorkingTree.open_containing(u'.')[0]
1567
basis = wt.basis_tree()
1570
basis_inv = basis.inventory
1573
if file_id in basis_inv:
1575
if inv.is_root(file_id) and len(basis_inv) == 0:
1577
path = inv.id2path(file_id)
1578
if not os.access(osutils.abspath(path), os.F_OK):
1580
self.outf.write(path + '\n')
1587
class cmd_root(Command):
1588
"""Show the tree root directory.
1590
The root is the nearest enclosing directory with a .bzr control
1593
takes_args = ['filename?']
1595
def run(self, filename=None):
1596
"""Print the branch root."""
1597
tree = WorkingTree.open_containing(filename)[0]
1598
self.outf.write(tree.basedir + '\n')
1601
def _parse_limit(limitstring):
1603
return int(limitstring)
1605
msg = "The limit argument must be an integer."
1606
raise errors.BzrCommandError(msg)
1609
class cmd_log(Command):
1610
"""Show log of a branch, file, or directory.
1612
By default show the log of the branch containing the working directory.
1614
To request a range of logs, you can use the command -r begin..end
1615
-r revision requests a specific revision, -r ..end or -r begin.. are
1619
Log the current branch::
1627
Log the last 10 revisions of a branch::
1629
bzr log -r -10.. http://server/branch
1632
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1634
takes_args = ['location?']
1637
help='Show from oldest to newest.'),
1640
help='Display timezone as local, original, or utc.'),
1641
custom_help('verbose',
1642
help='Show files changed in each revision.'),
1648
help='Show revisions whose message matches this '
1649
'regular expression.',
1652
help='Limit the output to the first N revisions.',
1656
encoding_type = 'replace'
1659
def run(self, location=None, timezone='original',
1667
from bzrlib.log import show_log
1668
assert message is None or isinstance(message, basestring), \
1669
"invalid message argument %r" % message
1670
direction = (forward and 'forward') or 'reverse'
1675
# find the file id to log:
1677
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1681
tree = b.basis_tree()
1682
file_id = tree.path2id(fp)
1684
raise errors.BzrCommandError(
1685
"Path does not have any revision history: %s" %
1689
# FIXME ? log the current subdir only RBC 20060203
1690
if revision is not None \
1691
and len(revision) > 0 and revision[0].get_branch():
1692
location = revision[0].get_branch()
1695
dir, relpath = bzrdir.BzrDir.open_containing(location)
1696
b = dir.open_branch()
1700
if revision is None:
1703
elif len(revision) == 1:
1704
rev1 = rev2 = revision[0].in_history(b)
1705
elif len(revision) == 2:
1706
if revision[1].get_branch() != revision[0].get_branch():
1707
# b is taken from revision[0].get_branch(), and
1708
# show_log will use its revision_history. Having
1709
# different branches will lead to weird behaviors.
1710
raise errors.BzrCommandError(
1711
"Log doesn't accept two revisions in different"
1713
rev1 = revision[0].in_history(b)
1714
rev2 = revision[1].in_history(b)
1716
raise errors.BzrCommandError(
1717
'bzr log --revision takes one or two values.')
1719
if log_format is None:
1720
log_format = log.log_formatter_registry.get_default(b)
1722
lf = log_format(show_ids=show_ids, to_file=self.outf,
1723
show_timezone=timezone)
1729
direction=direction,
1730
start_revision=rev1,
1738
def get_log_format(long=False, short=False, line=False, default='long'):
1739
log_format = default
1743
log_format = 'short'
1749
class cmd_touching_revisions(Command):
1750
"""Return revision-ids which affected a particular file.
1752
A more user-friendly interface is "bzr log FILE".
1756
takes_args = ["filename"]
1759
def run(self, filename):
1760
tree, relpath = WorkingTree.open_containing(filename)
1762
file_id = tree.path2id(relpath)
1763
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1764
self.outf.write("%6d %s\n" % (revno, what))
1767
class cmd_ls(Command):
1768
"""List files in a tree.
1771
_see_also = ['status', 'cat']
1772
takes_args = ['path?']
1773
# TODO: Take a revision or remote path and list that tree instead.
1777
Option('non-recursive',
1778
help='Don\'t recurse into subdirectories.'),
1780
help='Print paths relative to the root of the branch.'),
1781
Option('unknown', help='Print unknown files.'),
1782
Option('versioned', help='Print versioned files.'),
1783
Option('ignored', help='Print ignored files.'),
1785
help='Write an ascii NUL (\\0) separator '
1786
'between files rather than a newline.'),
1788
help='List entries of a particular kind: file, directory, symlink.',
1793
def run(self, revision=None, verbose=False,
1794
non_recursive=False, from_root=False,
1795
unknown=False, versioned=False, ignored=False,
1796
null=False, kind=None, show_ids=False, path=None):
1798
if kind and kind not in ('file', 'directory', 'symlink'):
1799
raise errors.BzrCommandError('invalid kind specified')
1801
if verbose and null:
1802
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1803
all = not (unknown or versioned or ignored)
1805
selection = {'I':ignored, '?':unknown, 'V':versioned}
1812
raise errors.BzrCommandError('cannot specify both --from-root'
1816
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1822
if revision is not None:
1823
tree = branch.repository.revision_tree(
1824
revision[0].in_history(branch).rev_id)
1826
tree = branch.basis_tree()
1830
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1831
if fp.startswith(relpath):
1832
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1833
if non_recursive and '/' in fp:
1835
if not all and not selection[fc]:
1837
if kind is not None and fkind != kind:
1840
kindch = entry.kind_character()
1841
outstring = '%-8s %s%s' % (fc, fp, kindch)
1842
if show_ids and fid is not None:
1843
outstring = "%-50s %s" % (outstring, fid)
1844
self.outf.write(outstring + '\n')
1846
self.outf.write(fp + '\0')
1849
self.outf.write(fid)
1850
self.outf.write('\0')
1858
self.outf.write('%-50s %s\n' % (fp, my_id))
1860
self.outf.write(fp + '\n')
1865
class cmd_unknowns(Command):
1866
"""List unknown files.
1874
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1875
self.outf.write(osutils.quotefn(f) + '\n')
1878
class cmd_ignore(Command):
1879
"""Ignore specified files or patterns.
1881
To remove patterns from the ignore list, edit the .bzrignore file.
1883
Trailing slashes on patterns are ignored.
1884
If the pattern contains a slash or is a regular expression, it is compared
1885
to the whole path from the branch root. Otherwise, it is compared to only
1886
the last component of the path. To match a file only in the root
1887
directory, prepend './'.
1889
Ignore patterns specifying absolute paths are not allowed.
1891
Ignore patterns may include globbing wildcards such as::
1893
? - Matches any single character except '/'
1894
* - Matches 0 or more characters except '/'
1895
/**/ - Matches 0 or more directories in a path
1896
[a-z] - Matches a single character from within a group of characters
1898
Ignore patterns may also be Python regular expressions.
1899
Regular expression ignore patterns are identified by a 'RE:' prefix
1900
followed by the regular expression. Regular expression ignore patterns
1901
may not include named or numbered groups.
1903
Note: ignore patterns containing shell wildcards must be quoted from
1907
Ignore the top level Makefile::
1909
bzr ignore ./Makefile
1911
Ignore class files in all directories::
1913
bzr ignore '*.class'
1915
Ignore .o files under the lib directory::
1917
bzr ignore 'lib/**/*.o'
1919
Ignore .o files under the lib directory::
1921
bzr ignore 'RE:lib/.*\.o'
1924
_see_also = ['status', 'ignored']
1925
takes_args = ['name_pattern*']
1927
Option('old-default-rules',
1928
help='Write out the ignore rules bzr < 0.9 always used.')
1931
def run(self, name_pattern_list=None, old_default_rules=None):
1932
from bzrlib.atomicfile import AtomicFile
1933
if old_default_rules is not None:
1934
# dump the rules and exit
1935
for pattern in ignores.OLD_DEFAULTS:
1938
if not name_pattern_list:
1939
raise errors.BzrCommandError("ignore requires at least one "
1940
"NAME_PATTERN or --old-default-rules")
1941
name_pattern_list = [globbing.normalize_pattern(p)
1942
for p in name_pattern_list]
1943
for name_pattern in name_pattern_list:
1944
if (name_pattern[0] == '/' or
1945
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1946
raise errors.BzrCommandError(
1947
"NAME_PATTERN should not be an absolute path")
1948
tree, relpath = WorkingTree.open_containing(u'.')
1949
ifn = tree.abspath('.bzrignore')
1950
if os.path.exists(ifn):
1953
igns = f.read().decode('utf-8')
1959
# TODO: If the file already uses crlf-style termination, maybe
1960
# we should use that for the newly added lines?
1962
if igns and igns[-1] != '\n':
1964
for name_pattern in name_pattern_list:
1965
igns += name_pattern + '\n'
1967
f = AtomicFile(ifn, 'wb')
1969
f.write(igns.encode('utf-8'))
1974
if not tree.path2id('.bzrignore'):
1975
tree.add(['.bzrignore'])
1977
ignored = globbing.Globster(name_pattern_list)
1980
for entry in tree.list_files():
1984
if ignored.match(filename):
1985
matches.append(filename.encode('utf-8'))
1987
if len(matches) > 0:
1988
print "Warning: the following files are version controlled and" \
1989
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1991
class cmd_ignored(Command):
1992
"""List ignored files and the patterns that matched them.
1995
_see_also = ['ignore']
1998
tree = WorkingTree.open_containing(u'.')[0]
2001
for path, file_class, kind, file_id, entry in tree.list_files():
2002
if file_class != 'I':
2004
## XXX: Slightly inefficient since this was already calculated
2005
pat = tree.is_ignored(path)
2006
print '%-50s %s' % (path, pat)
2011
class cmd_lookup_revision(Command):
2012
"""Lookup the revision-id from a revision-number
2015
bzr lookup-revision 33
2018
takes_args = ['revno']
2021
def run(self, revno):
2025
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2027
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2030
class cmd_export(Command):
2031
"""Export current or past revision to a destination directory or archive.
2033
If no revision is specified this exports the last committed revision.
2035
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2036
given, try to find the format with the extension. If no extension
2037
is found exports to a directory (equivalent to --format=dir).
2039
If root is supplied, it will be used as the root directory inside
2040
container formats (tar, zip, etc). If it is not supplied it will default
2041
to the exported filename. The root option has no effect for 'dir' format.
2043
If branch is omitted then the branch containing the current working
2044
directory will be used.
2046
Note: Export of tree with non-ASCII filenames to zip is not supported.
2048
================= =========================
2049
Supported formats Autodetected by extension
2050
================= =========================
2053
tbz2 .tar.bz2, .tbz2
2056
================= =========================
2058
takes_args = ['dest', 'branch?']
2061
help="Type of file to export to.",
2066
help="Name of the root directory inside the exported file."),
2068
def run(self, dest, branch=None, revision=None, format=None, root=None):
2069
from bzrlib.export import export
2072
tree = WorkingTree.open_containing(u'.')[0]
2075
b = Branch.open(branch)
2077
if revision is None:
2078
# should be tree.last_revision FIXME
2079
rev_id = b.last_revision()
2081
if len(revision) != 1:
2082
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2083
rev_id = revision[0].in_history(b).rev_id
2084
t = b.repository.revision_tree(rev_id)
2086
export(t, dest, format, root)
2087
except errors.NoSuchExportFormat, e:
2088
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2091
class cmd_cat(Command):
2092
"""Write the contents of a file as of a given revision to standard output.
2094
If no revision is nominated, the last revision is used.
2096
Note: Take care to redirect standard output when using this command on a
2102
Option('name-from-revision', help='The path name in the old tree.'),
2105
takes_args = ['filename']
2106
encoding_type = 'exact'
2109
def run(self, filename, revision=None, name_from_revision=False):
2110
if revision is not None and len(revision) != 1:
2111
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2116
tree, b, relpath = \
2117
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2118
except errors.NotBranchError:
2121
if revision is not None and revision[0].get_branch() is not None:
2122
b = Branch.open(revision[0].get_branch())
2124
tree = b.basis_tree()
2125
if revision is None:
2126
revision_id = b.last_revision()
2128
revision_id = revision[0].in_history(b).rev_id
2130
cur_file_id = tree.path2id(relpath)
2131
rev_tree = b.repository.revision_tree(revision_id)
2132
old_file_id = rev_tree.path2id(relpath)
2134
if name_from_revision:
2135
if old_file_id is None:
2136
raise errors.BzrCommandError("%r is not present in revision %s"
2137
% (filename, revision_id))
2139
rev_tree.print_file(old_file_id)
2140
elif cur_file_id is not None:
2141
rev_tree.print_file(cur_file_id)
2142
elif old_file_id is not None:
2143
rev_tree.print_file(old_file_id)
2145
raise errors.BzrCommandError("%r is not present in revision %s" %
2146
(filename, revision_id))
2149
class cmd_local_time_offset(Command):
2150
"""Show the offset in seconds from GMT to local time."""
2154
print osutils.local_time_offset()
2158
class cmd_commit(Command):
2159
"""Commit changes into a new revision.
2161
If no arguments are given, the entire tree is committed.
2163
If selected files are specified, only changes to those files are
2164
committed. If a directory is specified then the directory and everything
2165
within it is committed.
2167
If author of the change is not the same person as the committer, you can
2168
specify the author's name using the --author option. The name should be
2169
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2171
A selected-file commit may fail in some cases where the committed
2172
tree would be invalid. Consider::
2177
bzr commit foo -m "committing foo"
2178
bzr mv foo/bar foo/baz
2181
bzr commit foo/bar -m "committing bar but not baz"
2183
In the example above, the last commit will fail by design. This gives
2184
the user the opportunity to decide whether they want to commit the
2185
rename at the same time, separately first, or not at all. (As a general
2186
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2188
Note: A selected-file commit after a merge is not yet supported.
2190
# TODO: Run hooks on tree to-be-committed, and after commit.
2192
# TODO: Strict commit that fails if there are deleted files.
2193
# (what does "deleted files" mean ??)
2195
# TODO: Give better message for -s, --summary, used by tla people
2197
# XXX: verbose currently does nothing
2199
_see_also = ['bugs', 'uncommit']
2200
takes_args = ['selected*']
2202
Option('message', type=unicode,
2204
help="Description of the new revision."),
2207
help='Commit even if nothing has changed.'),
2208
Option('file', type=str,
2211
help='Take commit message from this file.'),
2213
help="Refuse to commit if there are unknown "
2214
"files in the working tree."),
2215
ListOption('fixes', type=str,
2216
help="Mark a bug as being fixed by this revision."),
2217
Option('author', type=str,
2218
help="Set the author's name, if it's different "
2219
"from the committer."),
2221
help="Perform a local commit in a bound "
2222
"branch. Local commits are not pushed to "
2223
"the master branch until a normal commit "
2227
help='When no message is supplied, show the diff along'
2228
' with the status summary in the message editor.'),
2230
aliases = ['ci', 'checkin']
2232
def _get_bug_fix_properties(self, fixes, branch):
2234
# Configure the properties for bug fixing attributes.
2235
for fixed_bug in fixes:
2236
tokens = fixed_bug.split(':')
2237
if len(tokens) != 2:
2238
raise errors.BzrCommandError(
2239
"Invalid bug %s. Must be in the form of 'tag:id'. "
2240
"Commit refused." % fixed_bug)
2241
tag, bug_id = tokens
2243
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2244
except errors.UnknownBugTrackerAbbreviation:
2245
raise errors.BzrCommandError(
2246
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2247
except errors.MalformedBugIdentifier:
2248
raise errors.BzrCommandError(
2249
"Invalid bug identifier for %s. Commit refused."
2251
properties.append('%s fixed' % bug_url)
2252
return '\n'.join(properties)
2254
def run(self, message=None, file=None, verbose=False, selected_list=None,
2255
unchanged=False, strict=False, local=False, fixes=None,
2256
author=None, show_diff=False):
2257
from bzrlib.commit import (
2261
from bzrlib.errors import (
2266
from bzrlib.msgeditor import (
2267
edit_commit_message_encoded,
2268
make_commit_message_template_encoded
2271
# TODO: Need a blackbox test for invoking the external editor; may be
2272
# slightly problematic to run this cross-platform.
2274
# TODO: do more checks that the commit will succeed before
2275
# spending the user's valuable time typing a commit message.
2279
tree, selected_list = tree_files(selected_list)
2280
if selected_list == ['']:
2281
# workaround - commit of root of tree should be exactly the same
2282
# as just default commit in that tree, and succeed even though
2283
# selected-file merge commit is not done yet
2286
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2288
properties['bugs'] = bug_property
2290
if local and not tree.branch.get_bound_location():
2291
raise errors.LocalRequiresBoundBranch()
2293
def get_message(commit_obj):
2294
"""Callback to get commit message"""
2295
my_message = message
2296
if my_message is None and not file:
2297
t = make_commit_message_template_encoded(tree,
2298
selected_list, diff=show_diff,
2299
output_encoding=bzrlib.user_encoding)
2300
my_message = edit_commit_message_encoded(t)
2301
if my_message is None:
2302
raise errors.BzrCommandError("please specify a commit"
2303
" message with either --message or --file")
2304
elif my_message and file:
2305
raise errors.BzrCommandError(
2306
"please specify either --message or --file")
2308
my_message = codecs.open(file, 'rt',
2309
bzrlib.user_encoding).read()
2310
if my_message == "":
2311
raise errors.BzrCommandError("empty commit message specified")
2315
tree.commit(message_callback=get_message,
2316
specific_files=selected_list,
2317
allow_pointless=unchanged, strict=strict, local=local,
2318
reporter=None, verbose=verbose, revprops=properties,
2320
except PointlessCommit:
2321
# FIXME: This should really happen before the file is read in;
2322
# perhaps prepare the commit; get the message; then actually commit
2323
raise errors.BzrCommandError("no changes to commit."
2324
" use --unchanged to commit anyhow")
2325
except ConflictsInTree:
2326
raise errors.BzrCommandError('Conflicts detected in working '
2327
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2329
except StrictCommitFailed:
2330
raise errors.BzrCommandError("Commit refused because there are"
2331
" unknown files in the working tree.")
2332
except errors.BoundBranchOutOfDate, e:
2333
raise errors.BzrCommandError(str(e) + "\n"
2334
'To commit to master branch, run update and then commit.\n'
2335
'You can also pass --local to commit to continue working '
2339
class cmd_check(Command):
2340
"""Validate consistency of branch history.
2342
This command checks various invariants about the branch storage to
2343
detect data corruption or bzr bugs.
2346
_see_also = ['reconcile']
2347
takes_args = ['branch?']
2348
takes_options = ['verbose']
2350
def run(self, branch=None, verbose=False):
2351
from bzrlib.check import check
2353
tree = WorkingTree.open_containing()[0]
2354
branch = tree.branch
2356
branch = Branch.open(branch)
2357
check(branch, verbose)
2360
class cmd_upgrade(Command):
2361
"""Upgrade branch storage to current format.
2363
The check command or bzr developers may sometimes advise you to run
2364
this command. When the default format has changed you may also be warned
2365
during other operations to upgrade.
2368
_see_also = ['check']
2369
takes_args = ['url?']
2371
RegistryOption('format',
2372
help='Upgrade to a specific format. See "bzr help'
2373
' formats" for details.',
2374
registry=bzrdir.format_registry,
2375
converter=bzrdir.format_registry.make_bzrdir,
2376
value_switches=True, title='Branch format'),
2379
def run(self, url='.', format=None):
2380
from bzrlib.upgrade import upgrade
2382
format = bzrdir.format_registry.make_bzrdir('default')
2383
upgrade(url, format)
2386
class cmd_whoami(Command):
2387
"""Show or set bzr user id.
2390
Show the email of the current user::
2394
Set the current user::
2396
bzr whoami 'Frank Chu <fchu@example.com>'
2398
takes_options = [ Option('email',
2399
help='Display email address only.'),
2401
help='Set identity for the current branch instead of '
2404
takes_args = ['name?']
2405
encoding_type = 'replace'
2408
def run(self, email=False, branch=False, name=None):
2410
# use branch if we're inside one; otherwise global config
2412
c = Branch.open_containing('.')[0].get_config()
2413
except errors.NotBranchError:
2414
c = config.GlobalConfig()
2416
self.outf.write(c.user_email() + '\n')
2418
self.outf.write(c.username() + '\n')
2421
# display a warning if an email address isn't included in the given name.
2423
config.extract_email_address(name)
2424
except errors.NoEmailInUsername, e:
2425
warning('"%s" does not seem to contain an email address. '
2426
'This is allowed, but not recommended.', name)
2428
# use global config unless --branch given
2430
c = Branch.open_containing('.')[0].get_config()
2432
c = config.GlobalConfig()
2433
c.set_user_option('email', name)
2436
class cmd_nick(Command):
2437
"""Print or set the branch nickname.
2439
If unset, the tree root directory name is used as the nickname
2440
To print the current nickname, execute with no argument.
2443
_see_also = ['info']
2444
takes_args = ['nickname?']
2445
def run(self, nickname=None):
2446
branch = Branch.open_containing(u'.')[0]
2447
if nickname is None:
2448
self.printme(branch)
2450
branch.nick = nickname
2453
def printme(self, branch):
2457
class cmd_selftest(Command):
2458
"""Run internal test suite.
2460
If arguments are given, they are regular expressions that say which tests
2461
should run. Tests matching any expression are run, and other tests are
2464
Alternatively if --first is given, matching tests are run first and then
2465
all other tests are run. This is useful if you have been working in a
2466
particular area, but want to make sure nothing else was broken.
2468
If --exclude is given, tests that match that regular expression are
2469
excluded, regardless of whether they match --first or not.
2471
To help catch accidential dependencies between tests, the --randomize
2472
option is useful. In most cases, the argument used is the word 'now'.
2473
Note that the seed used for the random number generator is displayed
2474
when this option is used. The seed can be explicitly passed as the
2475
argument to this option if required. This enables reproduction of the
2476
actual ordering used if and when an order sensitive problem is encountered.
2478
If --list-only is given, the tests that would be run are listed. This is
2479
useful when combined with --first, --exclude and/or --randomize to
2480
understand their impact. The test harness reports "Listed nn tests in ..."
2481
instead of "Ran nn tests in ..." when list mode is enabled.
2483
If the global option '--no-plugins' is given, plugins are not loaded
2484
before running the selftests. This has two effects: features provided or
2485
modified by plugins will not be tested, and tests provided by plugins will
2488
Tests that need working space on disk use a common temporary directory,
2489
typically inside $TMPDIR or /tmp.
2492
Run only tests relating to 'ignore'::
2496
Disable plugins and list tests as they're run::
2498
bzr --no-plugins selftest -v
2500
# NB: this is used from the class without creating an instance, which is
2501
# why it does not have a self parameter.
2502
def get_transport_type(typestring):
2503
"""Parse and return a transport specifier."""
2504
if typestring == "sftp":
2505
from bzrlib.transport.sftp import SFTPAbsoluteServer
2506
return SFTPAbsoluteServer
2507
if typestring == "memory":
2508
from bzrlib.transport.memory import MemoryServer
2510
if typestring == "fakenfs":
2511
from bzrlib.transport.fakenfs import FakeNFSServer
2512
return FakeNFSServer
2513
msg = "No known transport type %s. Supported types are: sftp\n" %\
2515
raise errors.BzrCommandError(msg)
2518
takes_args = ['testspecs*']
2519
takes_options = ['verbose',
2521
help='Stop when one test fails.',
2525
help='Use a different transport by default '
2526
'throughout the test suite.',
2527
type=get_transport_type),
2529
help='Run the benchmarks rather than selftests.'),
2530
Option('lsprof-timed',
2531
help='Generate lsprof output for benchmarked'
2532
' sections of code.'),
2533
Option('cache-dir', type=str,
2534
help='Cache intermediate benchmark output in this '
2537
help='Run all tests, but run specified tests first.',
2541
help='List the tests instead of running them.'),
2542
Option('randomize', type=str, argname="SEED",
2543
help='Randomize the order of tests using the given'
2544
' seed or "now" for the current time.'),
2545
Option('exclude', type=str, argname="PATTERN",
2547
help='Exclude tests that match this regular'
2549
Option('strict', help='Fail on missing dependencies or '
2552
encoding_type = 'replace'
2554
def run(self, testspecs_list=None, verbose=False, one=False,
2555
transport=None, benchmark=None,
2556
lsprof_timed=None, cache_dir=None,
2557
first=False, list_only=False,
2558
randomize=None, exclude=None, strict=False):
2560
from bzrlib.tests import selftest
2561
import bzrlib.benchmarks as benchmarks
2562
from bzrlib.benchmarks import tree_creator
2564
if cache_dir is not None:
2565
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2567
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2568
print ' %s (%s python%s)' % (
2570
bzrlib.version_string,
2571
'.'.join(map(str, sys.version_info)),
2574
if testspecs_list is not None:
2575
pattern = '|'.join(testspecs_list)
2579
test_suite_factory = benchmarks.test_suite
2580
# Unless user explicitly asks for quiet, be verbose in benchmarks
2581
verbose = not is_quiet()
2582
# TODO: should possibly lock the history file...
2583
benchfile = open(".perf_history", "at", buffering=1)
2585
test_suite_factory = None
2588
result = selftest(verbose=verbose,
2590
stop_on_failure=one,
2591
transport=transport,
2592
test_suite_factory=test_suite_factory,
2593
lsprof_timed=lsprof_timed,
2594
bench_history=benchfile,
2595
matching_tests_first=first,
2596
list_only=list_only,
2597
random_seed=randomize,
2598
exclude_pattern=exclude,
2602
if benchfile is not None:
2605
info('tests passed')
2607
info('tests failed')
2608
return int(not result)
2611
class cmd_version(Command):
2612
"""Show version of bzr."""
2614
encoding_type = 'replace'
2618
from bzrlib.version import show_version
2619
show_version(to_file=self.outf)
2622
class cmd_rocks(Command):
2623
"""Statement of optimism."""
2629
print "It sure does!"
2632
class cmd_find_merge_base(Command):
2633
"""Find and print a base revision for merging two branches."""
2634
# TODO: Options to specify revisions on either side, as if
2635
# merging only part of the history.
2636
takes_args = ['branch', 'other']
2640
def run(self, branch, other):
2641
from bzrlib.revision import ensure_null, MultipleRevisionSources
2643
branch1 = Branch.open_containing(branch)[0]
2644
branch2 = Branch.open_containing(other)[0]
2646
last1 = ensure_null(branch1.last_revision())
2647
last2 = ensure_null(branch2.last_revision())
2649
graph = branch1.repository.get_graph(branch2.repository)
2650
base_rev_id = graph.find_unique_lca(last1, last2)
2652
print 'merge base is revision %s' % base_rev_id
2655
class cmd_merge(Command):
2656
"""Perform a three-way merge.
2658
The branch is the branch you will merge from. By default, it will merge
2659
the latest revision. If you specify a revision, that revision will be
2660
merged. If you specify two revisions, the first will be used as a BASE,
2661
and the second one as OTHER. Revision numbers are always relative to the
2664
By default, bzr will try to merge in all new work from the other
2665
branch, automatically determining an appropriate base. If this
2666
fails, you may need to give an explicit base.
2668
Merge will do its best to combine the changes in two branches, but there
2669
are some kinds of problems only a human can fix. When it encounters those,
2670
it will mark a conflict. A conflict means that you need to fix something,
2671
before you should commit.
2673
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2675
If there is no default branch set, the first merge will set it. After
2676
that, you can omit the branch to use the default. To change the
2677
default, use --remember. The value will only be saved if the remote
2678
location can be accessed.
2680
The results of the merge are placed into the destination working
2681
directory, where they can be reviewed (with bzr diff), tested, and then
2682
committed to record the result of the merge.
2684
merge refuses to run if there are any uncommitted changes, unless
2688
To merge the latest revision from bzr.dev::
2690
bzr merge ../bzr.dev
2692
To merge changes up to and including revision 82 from bzr.dev::
2694
bzr merge -r 82 ../bzr.dev
2696
To merge the changes introduced by 82, without previous changes::
2698
bzr merge -r 81..82 ../bzr.dev
2701
_see_also = ['update', 'remerge', 'status-flags']
2702
takes_args = ['branch?']
2707
help='Merge even if the destination tree has uncommitted changes.'),
2711
Option('show-base', help="Show base revision text in "
2713
Option('uncommitted', help='Apply uncommitted changes'
2714
' from a working copy, instead of branch changes.'),
2715
Option('pull', help='If the destination is already'
2716
' completely merged into the source, pull from the'
2717
' source rather than merging. When this happens,'
2718
' you do not need to commit the result.'),
2720
help='Branch to merge into, '
2721
'rather than the one containing the working directory.',
2727
def run(self, branch=None, revision=None, force=False, merge_type=None,
2728
show_base=False, reprocess=False, remember=False,
2729
uncommitted=False, pull=False,
2732
from bzrlib.tag import _merge_tags_if_possible
2733
# This is actually a branch (or merge-directive) *location*.
2737
if merge_type is None:
2738
merge_type = _mod_merge.Merge3Merger
2740
if directory is None: directory = u'.'
2741
possible_transports = []
2743
allow_pending = True
2744
verified = 'inapplicable'
2745
tree = WorkingTree.open_containing(directory)[0]
2746
change_reporter = delta._ChangeReporter(
2747
unversioned_filter=tree.is_ignored)
2750
pb = ui.ui_factory.nested_progress_bar()
2751
cleanups.append(pb.finished)
2753
cleanups.append(tree.unlock)
2754
if location is not None:
2755
mergeable, other_transport = _get_mergeable_helper(location)
2758
raise errors.BzrCommandError('Cannot use --uncommitted'
2759
' with bundles or merge directives.')
2761
if revision is not None:
2762
raise errors.BzrCommandError(
2763
'Cannot use -r with merge directives or bundles')
2764
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2766
possible_transports.append(other_transport)
2768
if merger is None and uncommitted:
2769
if revision is not None and len(revision) > 0:
2770
raise errors.BzrCommandError('Cannot use --uncommitted and'
2771
' --revision at the same time.')
2772
location = self._select_branch_location(tree, location)[0]
2773
other_tree, other_path = WorkingTree.open_containing(location)
2774
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2776
allow_pending = False
2779
merger, allow_pending = self._get_merger_from_branch(tree,
2780
location, revision, remember, possible_transports, pb)
2782
merger.merge_type = merge_type
2783
merger.reprocess = reprocess
2784
merger.show_base = show_base
2785
merger.change_reporter = change_reporter
2786
self.sanity_check_merger(merger)
2787
if (merger.base_rev_id == merger.other_rev_id and
2788
merger.other_rev_id != None):
2789
note('Nothing to do.')
2792
if merger.interesting_files is not None:
2793
raise BzrCommandError('Cannot pull individual files')
2794
if (merger.base_rev_id == tree.last_revision()):
2795
result = tree.pull(merger.other_branch, False,
2796
merger.other_rev_id)
2797
result.report(self.outf)
2799
merger.check_basis(not force)
2800
conflict_count = merger.do_merge()
2802
merger.set_pending()
2803
if verified == 'failed':
2804
warning('Preview patch does not match changes')
2805
if conflict_count != 0:
2810
for cleanup in reversed(cleanups):
2813
def sanity_check_merger(self, merger):
2814
if (merger.show_base and
2815
not merger.merge_type is _mod_merge.Merge3Merger):
2816
raise errors.BzrCommandError("Show-base is not supported for this"
2817
" merge type. %s" % merger.merge_type)
2818
if merger.reprocess and not merger.merge_type.supports_reprocess:
2819
raise errors.BzrCommandError("Conflict reduction is not supported"
2820
" for merge type %s." %
2822
if merger.reprocess and merger.show_base:
2823
raise errors.BzrCommandError("Cannot do conflict reduction and"
2826
def _get_merger_from_branch(self, tree, location, revision, remember,
2827
possible_transports, pb):
2828
"""Produce a merger from a location, assuming it refers to a branch."""
2829
from bzrlib.tag import _merge_tags_if_possible
2830
assert revision is None or len(revision) < 3
2831
# find the branch locations
2832
other_loc, location = self._select_branch_location(tree, location,
2834
if revision is not None and len(revision) == 2:
2835
base_loc, location = self._select_branch_location(tree, location,
2838
base_loc = other_loc
2840
other_branch, other_path = Branch.open_containing(other_loc,
2841
possible_transports)
2842
if base_loc == other_loc:
2843
base_branch = other_branch
2845
base_branch, base_path = Branch.open_containing(base_loc,
2846
possible_transports)
2847
# Find the revision ids
2848
if revision is None or len(revision) < 1 or revision[-1] is None:
2849
other_revision_id = _mod_revision.ensure_null(
2850
other_branch.last_revision())
2852
other_revision_id = \
2853
_mod_revision.ensure_null(
2854
revision[-1].in_history(other_branch).rev_id)
2855
if (revision is not None and len(revision) == 2
2856
and revision[0] is not None):
2857
base_revision_id = \
2858
_mod_revision.ensure_null(
2859
revision[0].in_history(base_branch).rev_id)
2861
base_revision_id = None
2862
# Remember where we merge from
2863
if ((tree.branch.get_parent() is None or remember) and
2864
other_branch is not None):
2865
tree.branch.set_parent(other_branch.base)
2866
_merge_tags_if_possible(other_branch, tree.branch)
2867
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2868
other_revision_id, base_revision_id, other_branch, base_branch)
2869
if other_path != '':
2870
allow_pending = False
2871
merger.interesting_files = [other_path]
2873
allow_pending = True
2874
return merger, allow_pending
2876
def _select_branch_location(self, tree, location, revision=None,
2878
"""Select a branch location, according to possible inputs.
2880
If provided, branches from ``revision`` are preferred. (Both
2881
``revision`` and ``index`` must be supplied.)
2883
Otherwise, the ``location`` parameter is used. If it is None, then the
2884
``parent`` location is used, and a note is printed.
2886
:param tree: The working tree to select a branch for merging into
2887
:param location: The location entered by the user
2888
:param revision: The revision parameter to the command
2889
:param index: The index to use for the revision parameter. Negative
2890
indices are permitted.
2891
:return: (selected_location, default_location). The default location
2892
will be the user-entered location, if any, or else the remembered
2895
if (revision is not None and index is not None
2896
and revision[index] is not None):
2897
branch = revision[index].get_branch()
2898
if branch is not None:
2899
return branch, location
2900
location = self._get_remembered_parent(tree, location, 'Merging from')
2901
return location, location
2903
# TODO: move up to common parent; this isn't merge-specific anymore.
2904
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2905
"""Use tree.branch's parent if none was supplied.
2907
Report if the remembered location was used.
2909
if supplied_location is not None:
2910
return supplied_location
2911
stored_location = tree.branch.get_parent()
2912
mutter("%s", stored_location)
2913
if stored_location is None:
2914
raise errors.BzrCommandError("No location specified or remembered")
2915
display_url = urlutils.unescape_for_display(stored_location,
2917
self.outf.write("%s remembered location %s\n" % (verb_string,
2919
return stored_location
2922
class cmd_remerge(Command):
2925
Use this if you want to try a different merge technique while resolving
2926
conflicts. Some merge techniques are better than others, and remerge
2927
lets you try different ones on different files.
2929
The options for remerge have the same meaning and defaults as the ones for
2930
merge. The difference is that remerge can (only) be run when there is a
2931
pending merge, and it lets you specify particular files.
2934
Re-do the merge of all conflicted files, and show the base text in
2935
conflict regions, in addition to the usual THIS and OTHER texts::
2937
bzr remerge --show-base
2939
Re-do the merge of "foobar", using the weave merge algorithm, with
2940
additional processing to reduce the size of conflict regions::
2942
bzr remerge --merge-type weave --reprocess foobar
2944
takes_args = ['file*']
2949
help="Show base revision text in conflicts."),
2952
def run(self, file_list=None, merge_type=None, show_base=False,
2954
if merge_type is None:
2955
merge_type = _mod_merge.Merge3Merger
2956
tree, file_list = tree_files(file_list)
2959
parents = tree.get_parent_ids()
2960
if len(parents) != 2:
2961
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2962
" merges. Not cherrypicking or"
2964
repository = tree.branch.repository
2965
graph = repository.get_graph()
2966
base_revision = graph.find_unique_lca(parents[0], parents[1])
2967
base_tree = repository.revision_tree(base_revision)
2968
other_tree = repository.revision_tree(parents[1])
2969
interesting_ids = None
2971
conflicts = tree.conflicts()
2972
if file_list is not None:
2973
interesting_ids = set()
2974
for filename in file_list:
2975
file_id = tree.path2id(filename)
2977
raise errors.NotVersionedError(filename)
2978
interesting_ids.add(file_id)
2979
if tree.kind(file_id) != "directory":
2982
for name, ie in tree.inventory.iter_entries(file_id):
2983
interesting_ids.add(ie.file_id)
2984
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2986
# Remerge only supports resolving contents conflicts
2987
allowed_conflicts = ('text conflict', 'contents conflict')
2988
restore_files = [c.path for c in conflicts
2989
if c.typestring in allowed_conflicts]
2990
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2991
tree.set_conflicts(ConflictList(new_conflicts))
2992
if file_list is not None:
2993
restore_files = file_list
2994
for filename in restore_files:
2996
restore(tree.abspath(filename))
2997
except errors.NotConflicted:
2999
# Disable pending merges, because the file texts we are remerging
3000
# have not had those merges performed. If we use the wrong parents
3001
# list, we imply that the working tree text has seen and rejected
3002
# all the changes from the other tree, when in fact those changes
3003
# have not yet been seen.
3004
tree.set_parent_ids(parents[:1])
3006
conflicts = _mod_merge.merge_inner(
3007
tree.branch, other_tree, base_tree,
3009
interesting_ids=interesting_ids,
3010
other_rev_id=parents[1],
3011
merge_type=merge_type,
3012
show_base=show_base,
3013
reprocess=reprocess)
3015
tree.set_parent_ids(parents)
3024
class cmd_revert(Command):
3025
"""Revert files to a previous revision.
3027
Giving a list of files will revert only those files. Otherwise, all files
3028
will be reverted. If the revision is not specified with '--revision', the
3029
last committed revision is used.
3031
To remove only some changes, without reverting to a prior version, use
3032
merge instead. For example, "merge . --r-2..-3" will remove the changes
3033
introduced by -2, without affecting the changes introduced by -1. Or
3034
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3036
By default, any files that have been manually changed will be backed up
3037
first. (Files changed only by merge are not backed up.) Backup files have
3038
'.~#~' appended to their name, where # is a number.
3040
When you provide files, you can use their current pathname or the pathname
3041
from the target revision. So you can use revert to "undelete" a file by
3042
name. If you name a directory, all the contents of that directory will be
3045
Any files that have been newly added since that revision will be deleted,
3046
with a backup kept if appropriate. Directories containing unknown files
3047
will not be deleted.
3050
_see_also = ['cat', 'export']
3053
Option('no-backup', "Do not save backups of reverted files."),
3054
Option('forget-merges',
3055
'Remove pending merge marker, without changing any files.'),
3057
takes_args = ['file*']
3059
def run(self, revision=None, no_backup=False, file_list=None,
3060
forget_merges=None):
3061
tree, file_list = tree_files(file_list)
3063
tree.set_parent_ids(tree.get_parent_ids()[:1])
3065
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3068
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3069
if revision is None:
3070
rev_id = tree.last_revision()
3071
elif len(revision) != 1:
3072
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3074
rev_id = revision[0].in_history(tree.branch).rev_id
3075
pb = ui.ui_factory.nested_progress_bar()
3077
tree.revert(file_list,
3078
tree.branch.repository.revision_tree(rev_id),
3079
not no_backup, pb, report_changes=True)
3084
class cmd_assert_fail(Command):
3085
"""Test reporting of assertion failures"""
3086
# intended just for use in testing
3091
raise AssertionError("always fails")
3094
class cmd_help(Command):
3095
"""Show help on a command or other topic.
3098
_see_also = ['topics']
3100
Option('long', 'Show help on all commands.'),
3102
takes_args = ['topic?']
3103
aliases = ['?', '--help', '-?', '-h']
3106
def run(self, topic=None, long=False):
3108
if topic is None and long:
3110
bzrlib.help.help(topic)
3113
class cmd_shell_complete(Command):
3114
"""Show appropriate completions for context.
3116
For a list of all available commands, say 'bzr shell-complete'.
3118
takes_args = ['context?']
3123
def run(self, context=None):
3124
import shellcomplete
3125
shellcomplete.shellcomplete(context)
3128
class cmd_fetch(Command):
3129
"""Copy in history from another branch but don't merge it.
3131
This is an internal method used for pull and merge.
3134
takes_args = ['from_branch', 'to_branch']
3135
def run(self, from_branch, to_branch):
3136
from bzrlib.fetch import Fetcher
3137
from_b = Branch.open(from_branch)
3138
to_b = Branch.open(to_branch)
3139
Fetcher(to_b, from_b)
3142
class cmd_missing(Command):
3143
"""Show unmerged/unpulled revisions between two branches.
3145
OTHER_BRANCH may be local or remote.
3148
_see_also = ['merge', 'pull']
3149
takes_args = ['other_branch?']
3151
Option('reverse', 'Reverse the order of revisions.'),
3153
'Display changes in the local branch only.'),
3154
Option('this' , 'Same as --mine-only.'),
3155
Option('theirs-only',
3156
'Display changes in the remote branch only.'),
3157
Option('other', 'Same as --theirs-only.'),
3162
encoding_type = 'replace'
3165
def run(self, other_branch=None, reverse=False, mine_only=False,
3166
theirs_only=False, log_format=None, long=False, short=False, line=False,
3167
show_ids=False, verbose=False, this=False, other=False):
3168
from bzrlib.missing import find_unmerged, iter_log_revisions
3169
from bzrlib.log import log_formatter
3176
local_branch = Branch.open_containing(u".")[0]
3177
parent = local_branch.get_parent()
3178
if other_branch is None:
3179
other_branch = parent
3180
if other_branch is None:
3181
raise errors.BzrCommandError("No peer location known"
3183
display_url = urlutils.unescape_for_display(parent,
3185
self.outf.write("Using last location: " + display_url + "\n")
3187
remote_branch = Branch.open(other_branch)
3188
if remote_branch.base == local_branch.base:
3189
remote_branch = local_branch
3190
local_branch.lock_read()
3192
remote_branch.lock_read()
3194
local_extra, remote_extra = find_unmerged(local_branch,
3196
if log_format is None:
3197
registry = log.log_formatter_registry
3198
log_format = registry.get_default(local_branch)
3199
lf = log_format(to_file=self.outf,
3201
show_timezone='original')
3202
if reverse is False:
3203
local_extra.reverse()
3204
remote_extra.reverse()
3205
if local_extra and not theirs_only:
3206
self.outf.write("You have %d extra revision(s):\n" %
3208
for revision in iter_log_revisions(local_extra,
3209
local_branch.repository,
3211
lf.log_revision(revision)
3212
printed_local = True
3214
printed_local = False
3215
if remote_extra and not mine_only:
3216
if printed_local is True:
3217
self.outf.write("\n\n\n")
3218
self.outf.write("You are missing %d revision(s):\n" %
3220
for revision in iter_log_revisions(remote_extra,
3221
remote_branch.repository,
3223
lf.log_revision(revision)
3224
if not remote_extra and not local_extra:
3226
self.outf.write("Branches are up to date.\n")
3230
remote_branch.unlock()
3232
local_branch.unlock()
3233
if not status_code and parent is None and other_branch is not None:
3234
local_branch.lock_write()
3236
# handle race conditions - a parent might be set while we run.
3237
if local_branch.get_parent() is None:
3238
local_branch.set_parent(remote_branch.base)
3240
local_branch.unlock()
3244
class cmd_pack(Command):
3245
"""Compress the data within a repository."""
3247
_see_also = ['repositories']
3248
takes_args = ['branch_or_repo?']
3250
def run(self, branch_or_repo='.'):
3251
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3253
branch = dir.open_branch()
3254
repository = branch.repository
3255
except errors.NotBranchError:
3256
repository = dir.open_repository()
3260
class cmd_plugins(Command):
3261
"""List the installed plugins.
3263
This command displays the list of installed plugins including the
3264
path where each one is located and a short description of each.
3266
A plugin is an external component for Bazaar that extends the
3267
revision control system, by adding or replacing code in Bazaar.
3268
Plugins can do a variety of things, including overriding commands,
3269
adding new commands, providing additional network transports and
3270
customizing log output.
3272
See the Bazaar web site, http://bazaar-vcs.org, for further
3273
information on plugins including where to find them and how to
3274
install them. Instructions are also provided there on how to
3275
write new plugins using the Python programming language.
3280
import bzrlib.plugin
3281
from inspect import getdoc
3282
for name, plugin in bzrlib.plugin.plugins().items():
3283
print plugin.path(), "[%s]" % plugin.__version__
3284
d = getdoc(plugin.module)
3286
print '\t', d.split('\n')[0]
3289
class cmd_testament(Command):
3290
"""Show testament (signing-form) of a revision."""
3293
Option('long', help='Produce long-format testament.'),
3295
help='Produce a strict-format testament.')]
3296
takes_args = ['branch?']
3298
def run(self, branch=u'.', revision=None, long=False, strict=False):
3299
from bzrlib.testament import Testament, StrictTestament
3301
testament_class = StrictTestament
3303
testament_class = Testament
3304
b = WorkingTree.open_containing(branch)[0].branch
3307
if revision is None:
3308
rev_id = b.last_revision()
3310
rev_id = revision[0].in_history(b).rev_id
3311
t = testament_class.from_revision(b.repository, rev_id)
3313
sys.stdout.writelines(t.as_text_lines())
3315
sys.stdout.write(t.as_short_text())
3320
class cmd_annotate(Command):
3321
"""Show the origin of each line in a file.
3323
This prints out the given file with an annotation on the left side
3324
indicating which revision, author and date introduced the change.
3326
If the origin is the same for a run of consecutive lines, it is
3327
shown only at the top, unless the --all option is given.
3329
# TODO: annotate directories; showing when each file was last changed
3330
# TODO: if the working copy is modified, show annotations on that
3331
# with new uncommitted lines marked
3332
aliases = ['ann', 'blame', 'praise']
3333
takes_args = ['filename']
3334
takes_options = [Option('all', help='Show annotations on all lines.'),
3335
Option('long', help='Show commit date in annotations.'),
3339
encoding_type = 'exact'
3342
def run(self, filename, all=False, long=False, revision=None,
3344
from bzrlib.annotate import annotate_file
3345
tree, relpath = WorkingTree.open_containing(filename)
3346
branch = tree.branch
3349
if revision is None:
3350
revision_id = branch.last_revision()
3351
elif len(revision) != 1:
3352
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3354
revision_id = revision[0].in_history(branch).rev_id
3355
file_id = tree.path2id(relpath)
3357
raise errors.NotVersionedError(filename)
3358
tree = branch.repository.revision_tree(revision_id)
3359
file_version = tree.inventory[file_id].revision
3360
annotate_file(branch, file_version, file_id, long, all, self.outf,
3366
class cmd_re_sign(Command):
3367
"""Create a digital signature for an existing revision."""
3368
# TODO be able to replace existing ones.
3370
hidden = True # is this right ?
3371
takes_args = ['revision_id*']
3372
takes_options = ['revision']
3374
def run(self, revision_id_list=None, revision=None):
3375
import bzrlib.gpg as gpg
3376
if revision_id_list is not None and revision is not None:
3377
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3378
if revision_id_list is None and revision is None:
3379
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3380
b = WorkingTree.open_containing(u'.')[0].branch
3381
gpg_strategy = gpg.GPGStrategy(b.get_config())
3382
if revision_id_list is not None:
3383
for revision_id in revision_id_list:
3384
b.repository.sign_revision(revision_id, gpg_strategy)
3385
elif revision is not None:
3386
if len(revision) == 1:
3387
revno, rev_id = revision[0].in_history(b)
3388
b.repository.sign_revision(rev_id, gpg_strategy)
3389
elif len(revision) == 2:
3390
# are they both on rh- if so we can walk between them
3391
# might be nice to have a range helper for arbitrary
3392
# revision paths. hmm.
3393
from_revno, from_revid = revision[0].in_history(b)
3394
to_revno, to_revid = revision[1].in_history(b)
3395
if to_revid is None:
3396
to_revno = b.revno()
3397
if from_revno is None or to_revno is None:
3398
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3399
for revno in range(from_revno, to_revno + 1):
3400
b.repository.sign_revision(b.get_rev_id(revno),
3403
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3406
class cmd_bind(Command):
3407
"""Convert the current branch into a checkout of the supplied branch.
3409
Once converted into a checkout, commits must succeed on the master branch
3410
before they will be applied to the local branch.
3413
_see_also = ['checkouts', 'unbind']
3414
takes_args = ['location?']
3417
def run(self, location=None):
3418
b, relpath = Branch.open_containing(u'.')
3419
if location is None:
3421
location = b.get_old_bound_location()
3422
except errors.UpgradeRequired:
3423
raise errors.BzrCommandError('No location supplied. '
3424
'This format does not remember old locations.')
3426
if location is None:
3427
raise errors.BzrCommandError('No location supplied and no '
3428
'previous location known')
3429
b_other = Branch.open(location)
3432
except errors.DivergedBranches:
3433
raise errors.BzrCommandError('These branches have diverged.'
3434
' Try merging, and then bind again.')
3437
class cmd_unbind(Command):
3438
"""Convert the current checkout into a regular branch.
3440
After unbinding, the local branch is considered independent and subsequent
3441
commits will be local only.
3444
_see_also = ['checkouts', 'bind']
3449
b, relpath = Branch.open_containing(u'.')
3451
raise errors.BzrCommandError('Local branch is not bound')
3454
class cmd_uncommit(Command):
3455
"""Remove the last committed revision.
3457
--verbose will print out what is being removed.
3458
--dry-run will go through all the motions, but not actually
3461
If --revision is specified, uncommit revisions to leave the branch at the
3462
specified revision. For example, "bzr uncommit -r 15" will leave the
3463
branch at revision 15.
3465
In the future, uncommit will create a revision bundle, which can then
3469
# TODO: jam 20060108 Add an option to allow uncommit to remove
3470
# unreferenced information in 'branch-as-repository' branches.
3471
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3472
# information in shared branches as well.
3473
_see_also = ['commit']
3474
takes_options = ['verbose', 'revision',
3475
Option('dry-run', help='Don\'t actually make changes.'),
3476
Option('force', help='Say yes to all questions.')]
3477
takes_args = ['location?']
3480
def run(self, location=None,
3481
dry_run=False, verbose=False,
3482
revision=None, force=False):
3483
from bzrlib.log import log_formatter, show_log
3485
from bzrlib.uncommit import uncommit
3487
if location is None:
3489
control, relpath = bzrdir.BzrDir.open_containing(location)
3491
tree = control.open_workingtree()
3493
except (errors.NoWorkingTree, errors.NotLocalUrl):
3495
b = control.open_branch()
3498
if revision is None:
3501
# 'bzr uncommit -r 10' actually means uncommit
3502
# so that the final tree is at revno 10.
3503
# but bzrlib.uncommit.uncommit() actually uncommits
3504
# the revisions that are supplied.
3505
# So we need to offset it by one
3506
revno = revision[0].in_history(b).revno+1
3508
if revno <= b.revno():
3509
rev_id = b.get_rev_id(revno)
3511
self.outf.write('No revisions to uncommit.\n')
3514
lf = log_formatter('short',
3516
show_timezone='original')
3521
direction='forward',
3522
start_revision=revno,
3523
end_revision=b.revno())
3526
print 'Dry-run, pretending to remove the above revisions.'
3528
val = raw_input('Press <enter> to continue')
3530
print 'The above revision(s) will be removed.'
3532
val = raw_input('Are you sure [y/N]? ')
3533
if val.lower() not in ('y', 'yes'):
3537
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3541
class cmd_break_lock(Command):
3542
"""Break a dead lock on a repository, branch or working directory.
3544
CAUTION: Locks should only be broken when you are sure that the process
3545
holding the lock has been stopped.
3547
You can get information on what locks are open via the 'bzr info' command.
3552
takes_args = ['location?']
3554
def run(self, location=None, show=False):
3555
if location is None:
3557
control, relpath = bzrdir.BzrDir.open_containing(location)
3559
control.break_lock()
3560
except NotImplementedError:
3564
class cmd_wait_until_signalled(Command):
3565
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3567
This just prints a line to signal when it is ready, then blocks on stdin.
3573
sys.stdout.write("running\n")
3575
sys.stdin.readline()
3578
class cmd_serve(Command):
3579
"""Run the bzr server."""
3581
aliases = ['server']
3585
help='Serve on stdin/out for use from inetd or sshd.'),
3587
help='Listen for connections on nominated port of the form '
3588
'[hostname:]portnumber. Passing 0 as the port number will '
3589
'result in a dynamically allocated port. The default port is '
3593
help='Serve contents of this directory.',
3595
Option('allow-writes',
3596
help='By default the server is a readonly server. Supplying '
3597
'--allow-writes enables write access to the contents of '
3598
'the served directory and below.'
3602
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3603
from bzrlib.smart import medium, server
3604
from bzrlib.transport import get_transport
3605
from bzrlib.transport.chroot import ChrootServer
3606
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3607
if directory is None:
3608
directory = os.getcwd()
3609
url = urlutils.local_path_to_url(directory)
3610
if not allow_writes:
3611
url = 'readonly+' + url
3612
chroot_server = ChrootServer(get_transport(url))
3613
chroot_server.setUp()
3614
t = get_transport(chroot_server.get_url())
3616
smart_server = medium.SmartServerPipeStreamMedium(
3617
sys.stdin, sys.stdout, t)
3619
host = BZR_DEFAULT_INTERFACE
3621
port = BZR_DEFAULT_PORT
3624
host, port = port.split(':')
3626
smart_server = server.SmartTCPServer(t, host=host, port=port)
3627
print 'listening on port: ', smart_server.port
3629
# for the duration of this server, no UI output is permitted.
3630
# note that this may cause problems with blackbox tests. This should
3631
# be changed with care though, as we dont want to use bandwidth sending
3632
# progress over stderr to smart server clients!
3633
old_factory = ui.ui_factory
3635
ui.ui_factory = ui.SilentUIFactory()
3636
smart_server.serve()
3638
ui.ui_factory = old_factory
3641
class cmd_join(Command):
3642
"""Combine a subtree into its containing tree.
3644
This command is for experimental use only. It requires the target tree
3645
to be in dirstate-with-subtree format, which cannot be converted into
3648
The TREE argument should be an independent tree, inside another tree, but
3649
not part of it. (Such trees can be produced by "bzr split", but also by
3650
running "bzr branch" with the target inside a tree.)
3652
The result is a combined tree, with the subtree no longer an independant
3653
part. This is marked as a merge of the subtree into the containing tree,
3654
and all history is preserved.
3656
If --reference is specified, the subtree retains its independence. It can
3657
be branched by itself, and can be part of multiple projects at the same
3658
time. But operations performed in the containing tree, such as commit
3659
and merge, will recurse into the subtree.
3662
_see_also = ['split']
3663
takes_args = ['tree']
3665
Option('reference', help='Join by reference.'),
3669
def run(self, tree, reference=False):
3670
sub_tree = WorkingTree.open(tree)
3671
parent_dir = osutils.dirname(sub_tree.basedir)
3672
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3673
repo = containing_tree.branch.repository
3674
if not repo.supports_rich_root():
3675
raise errors.BzrCommandError(
3676
"Can't join trees because %s doesn't support rich root data.\n"
3677
"You can use bzr upgrade on the repository."
3681
containing_tree.add_reference(sub_tree)
3682
except errors.BadReferenceTarget, e:
3683
# XXX: Would be better to just raise a nicely printable
3684
# exception from the real origin. Also below. mbp 20070306
3685
raise errors.BzrCommandError("Cannot join %s. %s" %
3689
containing_tree.subsume(sub_tree)
3690
except errors.BadSubsumeSource, e:
3691
raise errors.BzrCommandError("Cannot join %s. %s" %
3695
class cmd_split(Command):
3696
"""Split a tree into two trees.
3698
This command is for experimental use only. It requires the target tree
3699
to be in dirstate-with-subtree format, which cannot be converted into
3702
The TREE argument should be a subdirectory of a working tree. That
3703
subdirectory will be converted into an independent tree, with its own
3704
branch. Commits in the top-level tree will not apply to the new subtree.
3705
If you want that behavior, do "bzr join --reference TREE".
3708
_see_also = ['join']
3709
takes_args = ['tree']
3713
def run(self, tree):
3714
containing_tree, subdir = WorkingTree.open_containing(tree)
3715
sub_id = containing_tree.path2id(subdir)
3717
raise errors.NotVersionedError(subdir)
3719
containing_tree.extract(sub_id)
3720
except errors.RootNotRich:
3721
raise errors.UpgradeRequired(containing_tree.branch.base)
3725
class cmd_merge_directive(Command):
3726
"""Generate a merge directive for auto-merge tools.
3728
A directive requests a merge to be performed, and also provides all the
3729
information necessary to do so. This means it must either include a
3730
revision bundle, or the location of a branch containing the desired
3733
A submit branch (the location to merge into) must be supplied the first
3734
time the command is issued. After it has been supplied once, it will
3735
be remembered as the default.
3737
A public branch is optional if a revision bundle is supplied, but required
3738
if --diff or --plain is specified. It will be remembered as the default
3739
after the first use.
3742
takes_args = ['submit_branch?', 'public_branch?']
3746
_see_also = ['send']
3749
RegistryOption.from_kwargs('patch-type',
3750
'The type of patch to include in the directive.',
3752
value_switches=True,
3754
bundle='Bazaar revision bundle (default).',
3755
diff='Normal unified diff.',
3756
plain='No patch, just directive.'),
3757
Option('sign', help='GPG-sign the directive.'), 'revision',
3758
Option('mail-to', type=str,
3759
help='Instead of printing the directive, email to this address.'),
3760
Option('message', type=str, short_name='m',
3761
help='Message to use when committing this merge.')
3764
encoding_type = 'exact'
3766
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3767
sign=False, revision=None, mail_to=None, message=None):
3768
from bzrlib.revision import ensure_null, NULL_REVISION
3769
include_patch, include_bundle = {
3770
'plain': (False, False),
3771
'diff': (True, False),
3772
'bundle': (True, True),
3774
branch = Branch.open('.')
3775
stored_submit_branch = branch.get_submit_branch()
3776
if submit_branch is None:
3777
submit_branch = stored_submit_branch
3779
if stored_submit_branch is None:
3780
branch.set_submit_branch(submit_branch)
3781
if submit_branch is None:
3782
submit_branch = branch.get_parent()
3783
if submit_branch is None:
3784
raise errors.BzrCommandError('No submit branch specified or known')
3786
stored_public_branch = branch.get_public_branch()
3787
if public_branch is None:
3788
public_branch = stored_public_branch
3789
elif stored_public_branch is None:
3790
branch.set_public_branch(public_branch)
3791
if not include_bundle and public_branch is None:
3792
raise errors.BzrCommandError('No public branch specified or'
3794
base_revision_id = None
3795
if revision is not None:
3796
if len(revision) > 2:
3797
raise errors.BzrCommandError('bzr merge-directive takes '
3798
'at most two one revision identifiers')
3799
revision_id = revision[-1].in_history(branch).rev_id
3800
if len(revision) == 2:
3801
base_revision_id = revision[0].in_history(branch).rev_id
3802
base_revision_id = ensure_null(base_revision_id)
3804
revision_id = branch.last_revision()
3805
revision_id = ensure_null(revision_id)
3806
if revision_id == NULL_REVISION:
3807
raise errors.BzrCommandError('No revisions to bundle.')
3808
directive = merge_directive.MergeDirective2.from_objects(
3809
branch.repository, revision_id, time.time(),
3810
osutils.local_time_offset(), submit_branch,
3811
public_branch=public_branch, include_patch=include_patch,
3812
include_bundle=include_bundle, message=message,
3813
base_revision_id=base_revision_id)
3816
self.outf.write(directive.to_signed(branch))
3818
self.outf.writelines(directive.to_lines())
3820
message = directive.to_email(mail_to, branch, sign)
3821
s = SMTPConnection(branch.get_config())
3822
s.send_email(message)
3825
class cmd_send(Command):
3826
"""Mail or create a merge-directive for submiting changes.
3828
A merge directive provides many things needed for requesting merges:
3830
* A machine-readable description of the merge to perform
3832
* An optional patch that is a preview of the changes requested
3834
* An optional bundle of revision data, so that the changes can be applied
3835
directly from the merge directive, without retrieving data from a
3838
If --no-bundle is specified, then public_branch is needed (and must be
3839
up-to-date), so that the receiver can perform the merge using the
3840
public_branch. The public_branch is always included if known, so that
3841
people can check it later.
3843
The submit branch defaults to the parent, but can be overridden. Both
3844
submit branch and public branch will be remembered if supplied.
3846
If a public_branch is known for the submit_branch, that public submit
3847
branch is used in the merge instructions. This means that a local mirror
3848
can be used as your actual submit branch, once you have set public_branch
3851
Mail is sent using your preferred mail program. This should be transparent
3852
on Windows (it uses MAPI). On *nix, it requires the xdg-email utility. If
3853
the preferred client can't be found (or used), your editor will be used.
3855
To use a specific mail program, set the mail_client configuration option.
3856
(For Thunderbird 1.5, this works around some bugs.) Supported values for
3857
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
3858
generic options are "default", "editor", "mapi", and "xdg-email".
3860
If mail is being sent, a to address is required. This can be supplied
3861
either on the commandline, or by setting the submit_to configuration
3864
Two formats are currently supported: "4" uses revision bundle format 4 and
3865
merge directive format 2. It is significantly faster and smaller than
3866
older formats. It is compatible with Bazaar 0.19 and later. It is the
3867
default. "0.9" uses revision bundle format 0.9 and merge directive
3868
format 1. It is compatible with Bazaar 0.12 - 0.18.
3871
encoding_type = 'exact'
3873
_see_also = ['merge']
3875
takes_args = ['submit_branch?', 'public_branch?']
3879
help='Do not include a bundle in the merge directive.'),
3880
Option('no-patch', help='Do not include a preview patch in the merge'
3883
help='Remember submit and public branch.'),
3885
help='Branch to generate the submission from, '
3886
'rather than the one containing the working directory.',
3889
Option('output', short_name='o', help='Write directive to this file.',
3891
Option('mail-to', help='Mail the request to this address.',
3895
RegistryOption.from_kwargs('format',
3896
'Use the specified output format.',
3897
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
3898
'0.9': 'Bundle format 0.9, Merge Directive 1',})
3901
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3902
no_patch=False, revision=None, remember=False, output=None,
3903
format='4', mail_to=None, message=None, **kwargs):
3904
return self._run(submit_branch, revision, public_branch, remember,
3905
format, no_bundle, no_patch, output,
3906
kwargs.get('from', '.'), mail_to, message)
3908
def _run(self, submit_branch, revision, public_branch, remember, format,
3909
no_bundle, no_patch, output, from_, mail_to, message):
3910
from bzrlib.revision import ensure_null, NULL_REVISION
3912
outfile = StringIO()
3916
outfile = open(output, 'wb')
3918
branch = Branch.open_containing(from_)[0]
3920
config = branch.get_config()
3922
mail_to = config.get_user_option('submit_to')
3924
raise errors.BzrCommandError('No mail-to address'
3926
mail_client = config.get_mail_client()
3927
if remember and submit_branch is None:
3928
raise errors.BzrCommandError(
3929
'--remember requires a branch to be specified.')
3930
stored_submit_branch = branch.get_submit_branch()
3931
remembered_submit_branch = False
3932
if submit_branch is None:
3933
submit_branch = stored_submit_branch
3934
remembered_submit_branch = True
3936
if stored_submit_branch is None or remember:
3937
branch.set_submit_branch(submit_branch)
3938
if submit_branch is None:
3939
submit_branch = branch.get_parent()
3940
remembered_submit_branch = True
3941
if submit_branch is None:
3942
raise errors.BzrCommandError('No submit branch known or'
3944
if remembered_submit_branch:
3945
note('Using saved location: %s', submit_branch)
3947
stored_public_branch = branch.get_public_branch()
3948
if public_branch is None:
3949
public_branch = stored_public_branch
3950
elif stored_public_branch is None or remember:
3951
branch.set_public_branch(public_branch)
3952
if no_bundle and public_branch is None:
3953
raise errors.BzrCommandError('No public branch specified or'
3955
base_revision_id = None
3957
if revision is not None:
3958
if len(revision) > 2:
3959
raise errors.BzrCommandError('bzr send takes '
3960
'at most two one revision identifiers')
3961
revision_id = revision[-1].in_history(branch).rev_id
3962
if len(revision) == 2:
3963
base_revision_id = revision[0].in_history(branch).rev_id
3964
if revision_id is None:
3965
revision_id = branch.last_revision()
3966
if revision_id == NULL_REVISION:
3967
raise errors.BzrCommandError('No revisions to submit.')
3969
directive = merge_directive.MergeDirective2.from_objects(
3970
branch.repository, revision_id, time.time(),
3971
osutils.local_time_offset(), submit_branch,
3972
public_branch=public_branch, include_patch=not no_patch,
3973
include_bundle=not no_bundle, message=message,
3974
base_revision_id=base_revision_id)
3975
elif format == '0.9':
3978
patch_type = 'bundle'
3980
raise errors.BzrCommandError('Format 0.9 does not'
3981
' permit bundle with no patch')
3987
directive = merge_directive.MergeDirective.from_objects(
3988
branch.repository, revision_id, time.time(),
3989
osutils.local_time_offset(), submit_branch,
3990
public_branch=public_branch, patch_type=patch_type,
3993
outfile.writelines(directive.to_lines())
3995
subject = '[MERGE] '
3996
if message is not None:
3999
revision = branch.repository.get_revision(revision_id)
4000
subject += revision.get_summary()
4001
mail_client.compose_merge_request(mail_to, subject,
4008
class cmd_bundle_revisions(cmd_send):
4010
"""Create a merge-directive for submiting changes.
4012
A merge directive provides many things needed for requesting merges:
4014
* A machine-readable description of the merge to perform
4016
* An optional patch that is a preview of the changes requested
4018
* An optional bundle of revision data, so that the changes can be applied
4019
directly from the merge directive, without retrieving data from a
4022
If --no-bundle is specified, then public_branch is needed (and must be
4023
up-to-date), so that the receiver can perform the merge using the
4024
public_branch. The public_branch is always included if known, so that
4025
people can check it later.
4027
The submit branch defaults to the parent, but can be overridden. Both
4028
submit branch and public branch will be remembered if supplied.
4030
If a public_branch is known for the submit_branch, that public submit
4031
branch is used in the merge instructions. This means that a local mirror
4032
can be used as your actual submit branch, once you have set public_branch
4035
Two formats are currently supported: "4" uses revision bundle format 4 and
4036
merge directive format 2. It is significantly faster and smaller than
4037
older formats. It is compatible with Bazaar 0.19 and later. It is the
4038
default. "0.9" uses revision bundle format 0.9 and merge directive
4039
format 1. It is compatible with Bazaar 0.12 - 0.18.
4044
help='Do not include a bundle in the merge directive.'),
4045
Option('no-patch', help='Do not include a preview patch in the merge'
4048
help='Remember submit and public branch.'),
4050
help='Branch to generate the submission from, '
4051
'rather than the one containing the working directory.',
4054
Option('output', short_name='o', help='Write directive to this file.',
4057
RegistryOption.from_kwargs('format',
4058
'Use the specified output format.',
4059
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4060
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4062
aliases = ['bundle']
4064
_see_also = ['send', 'merge']
4068
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4069
no_patch=False, revision=None, remember=False, output=None,
4070
format='4', **kwargs):
4073
return self._run(submit_branch, revision, public_branch, remember,
4074
format, no_bundle, no_patch, output,
4075
kwargs.get('from', '.'), None, None)
4078
class cmd_tag(Command):
4079
"""Create, remove or modify a tag naming a revision.
4081
Tags give human-meaningful names to revisions. Commands that take a -r
4082
(--revision) option can be given -rtag:X, where X is any previously
4085
Tags are stored in the branch. Tags are copied from one branch to another
4086
along when you branch, push, pull or merge.
4088
It is an error to give a tag name that already exists unless you pass
4089
--force, in which case the tag is moved to point to the new revision.
4092
_see_also = ['commit', 'tags']
4093
takes_args = ['tag_name']
4096
help='Delete this tag rather than placing it.',
4099
help='Branch in which to place the tag.',
4104
help='Replace existing tags.',
4109
def run(self, tag_name,
4115
branch, relpath = Branch.open_containing(directory)
4119
branch.tags.delete_tag(tag_name)
4120
self.outf.write('Deleted tag %s.\n' % tag_name)
4123
if len(revision) != 1:
4124
raise errors.BzrCommandError(
4125
"Tags can only be placed on a single revision, "
4127
revision_id = revision[0].in_history(branch).rev_id
4129
revision_id = branch.last_revision()
4130
if (not force) and branch.tags.has_tag(tag_name):
4131
raise errors.TagAlreadyExists(tag_name)
4132
branch.tags.set_tag(tag_name, revision_id)
4133
self.outf.write('Created tag %s.\n' % tag_name)
4138
class cmd_tags(Command):
4141
This tag shows a table of tag names and the revisions they reference.
4147
help='Branch whose tags should be displayed.',
4157
branch, relpath = Branch.open_containing(directory)
4158
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
4159
self.outf.write('%-20s %s\n' % (tag_name, target))
4162
class cmd_reconfigure(Command):
4163
"""Reconfigure the type of a bzr directory.
4165
A target configuration must be specified.
4167
For checkouts, the bind-to location will be auto-detected if not specified.
4168
The order of preference is
4169
1. For a lightweight checkout, the current bound location.
4170
2. For branches that used to be checkouts, the previously-bound location.
4171
3. The push location.
4172
4. The parent location.
4173
If none of these is available, --bind-to must be specified.
4176
takes_args = ['location?']
4177
takes_options = [RegistryOption.from_kwargs('target_type',
4178
title='Target type',
4179
help='The type to reconfigure the directory to.',
4180
value_switches=True, enum_switch=False,
4181
branch='Reconfigure to a branch.',
4182
tree='Reconfigure to a tree.',
4183
checkout='Reconfigure to a checkout.'),
4184
Option('bind-to', help='Branch to bind checkout to.',
4187
help='Perform reconfiguration even if local changes'
4191
def run(self, location=None, target_type=None, bind_to=None, force=False):
4192
directory = bzrdir.BzrDir.open(location)
4193
if target_type is None:
4194
raise errors.BzrCommandError('No target configuration specified')
4195
elif target_type == 'branch':
4196
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4197
elif target_type == 'tree':
4198
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4199
elif target_type == 'checkout':
4200
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4202
reconfiguration.apply(force)
4205
def _create_prefix(cur_transport):
4206
needed = [cur_transport]
4207
# Recurse upwards until we can create a directory successfully
4209
new_transport = cur_transport.clone('..')
4210
if new_transport.base == cur_transport.base:
4211
raise errors.BzrCommandError(
4212
"Failed to create path prefix for %s."
4213
% cur_transport.base)
4215
new_transport.mkdir('.')
4216
except errors.NoSuchFile:
4217
needed.append(new_transport)
4218
cur_transport = new_transport
4221
# Now we only need to create child directories
4223
cur_transport = needed.pop()
4224
cur_transport.ensure_base()
4227
def _get_mergeable_helper(location):
4228
"""Get a merge directive or bundle if 'location' points to one.
4230
Try try to identify a bundle and returns its mergeable form. If it's not,
4231
we return the tried transport anyway so that it can reused to access the
4234
:param location: can point to a bundle or a branch.
4236
:return: mergeable, transport
4239
url = urlutils.normalize_url(location)
4240
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4241
location_transport = transport.get_transport(url)
4244
# There may be redirections but we ignore the intermediate
4245
# and final transports used
4246
read = bundle.read_mergeable_from_transport
4247
mergeable, t = read(location_transport, filename)
4248
except errors.NotABundle:
4249
# Continue on considering this url a Branch but adjust the
4250
# location_transport
4251
location_transport = location_transport.clone(filename)
4252
return mergeable, location_transport
4255
# these get imported and then picked up by the scan for cmd_*
4256
# TODO: Some more consistent way to split command definitions across files;
4257
# we do need to load at least some information about them to know of
4258
# aliases. ideally we would avoid loading the implementation until the
4259
# details were needed.
4260
from bzrlib.cmd_version_info import cmd_version_info
4261
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4262
from bzrlib.bundle.commands import (
4265
from bzrlib.sign_my_commits import cmd_sign_my_commits
4266
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4267
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
