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(), """
47
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
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
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
--short gives a status flags for each item, similar to the SVN's status
159
If no arguments are specified, the status of the entire working
160
directory is shown. Otherwise, only the status of the specified
161
files or directories is reported. If a directory is given, status
162
is reported for everything inside that directory.
164
If a revision argument is given, the status is calculated against
165
that revision, or between two revisions if two are provided.
168
# TODO: --no-recurse, --recurse options
170
takes_args = ['file*']
171
takes_options = ['show-ids', 'revision',
172
Option('short', help='Give short SVN-style status lines'),
173
Option('versioned', help='Only show versioned files')]
174
aliases = ['st', 'stat']
176
encoding_type = 'replace'
177
_see_also = ['diff', 'revert', 'status-flags']
180
def run(self, show_ids=False, file_list=None, revision=None, short=False,
182
from bzrlib.status import show_tree_status
184
tree, file_list = tree_files(file_list)
186
show_tree_status(tree, show_ids=show_ids,
187
specific_files=file_list, revision=revision,
188
to_file=self.outf, short=short, versioned=versioned)
191
class cmd_cat_revision(Command):
192
"""Write out metadata for a revision.
194
The revision to print can either be specified by a specific
195
revision identifier, or you can use --revision.
199
takes_args = ['revision_id?']
200
takes_options = ['revision']
201
# cat-revision is more for frontends so should be exact
205
def run(self, revision_id=None, revision=None):
207
revision_id = osutils.safe_revision_id(revision_id, warn=False)
208
if revision_id is not None and revision is not None:
209
raise errors.BzrCommandError('You can only supply one of'
210
' revision_id or --revision')
211
if revision_id is None and revision is None:
212
raise errors.BzrCommandError('You must supply either'
213
' --revision or a revision_id')
214
b = WorkingTree.open_containing(u'.')[0].branch
216
# TODO: jam 20060112 should cat-revision always output utf-8?
217
if revision_id is not None:
218
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
219
elif revision is not None:
222
raise errors.BzrCommandError('You cannot specify a NULL'
224
revno, rev_id = rev.in_history(b)
225
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
228
class cmd_remove_tree(Command):
229
"""Remove the working tree from a given branch/checkout.
231
Since a lightweight checkout is little more than a working tree
232
this will refuse to run against one.
234
To re-create the working tree, use "bzr checkout".
236
_see_also = ['checkout', 'working-trees']
238
takes_args = ['location?']
240
def run(self, location='.'):
241
d = bzrdir.BzrDir.open(location)
244
working = d.open_workingtree()
245
except errors.NoWorkingTree:
246
raise errors.BzrCommandError("No working tree to remove")
247
except errors.NotLocalUrl:
248
raise errors.BzrCommandError("You cannot remove the working tree of a "
251
working_path = working.bzrdir.root_transport.base
252
branch_path = working.branch.bzrdir.root_transport.base
253
if working_path != branch_path:
254
raise errors.BzrCommandError("You cannot remove the working tree from "
255
"a lightweight checkout")
257
d.destroy_workingtree()
260
class cmd_revno(Command):
261
"""Show current revision number.
263
This is equal to the number of revisions on this branch.
267
takes_args = ['location?']
270
def run(self, location=u'.'):
271
self.outf.write(str(Branch.open_containing(location)[0].revno()))
272
self.outf.write('\n')
275
class cmd_revision_info(Command):
276
"""Show revision number and revision id for a given revision identifier.
279
takes_args = ['revision_info*']
280
takes_options = ['revision']
283
def run(self, revision=None, revision_info_list=[]):
286
if revision is not None:
287
revs.extend(revision)
288
if revision_info_list is not None:
289
for rev in revision_info_list:
290
revs.append(RevisionSpec.from_string(rev))
292
b = Branch.open_containing(u'.')[0]
295
revs.append(RevisionSpec.from_string('-1'))
298
revinfo = rev.in_history(b)
299
if revinfo.revno is None:
300
dotted_map = b.get_revision_id_to_revno_map()
301
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
302
print '%s %s' % (revno, revinfo.rev_id)
304
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
307
class cmd_add(Command):
308
"""Add specified files or directories.
310
In non-recursive mode, all the named items are added, regardless
311
of whether they were previously ignored. A warning is given if
312
any of the named files are already versioned.
314
In recursive mode (the default), files are treated the same way
315
but the behaviour for directories is different. Directories that
316
are already versioned do not give a warning. All directories,
317
whether already versioned or not, are searched for files or
318
subdirectories that are neither versioned or ignored, and these
319
are added. This search proceeds recursively into versioned
320
directories. If no names are given '.' is assumed.
322
Therefore simply saying 'bzr add' will version all files that
323
are currently unknown.
325
Adding a file whose parent directory is not versioned will
326
implicitly add the parent, and so on up to the root. This means
327
you should never need to explicitly add a directory, they'll just
328
get added when you add a file in the directory.
330
--dry-run will show which files would be added, but not actually
333
--file-ids-from will try to use the file ids from the supplied path.
334
It looks up ids trying to find a matching parent directory with the
335
same filename, and then by pure path. This option is rarely needed
336
but can be useful when adding the same logical file into two
337
branches that will be merged later (without showing the two different
338
adds as a conflict). It is also useful when merging another project
339
into a subdirectory of this one.
341
takes_args = ['file*']
342
takes_options = ['no-recurse', 'dry-run', 'verbose',
343
Option('file-ids-from', type=unicode,
344
help='Lookup file ids from here')]
345
encoding_type = 'replace'
346
_see_also = ['remove']
348
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
353
if file_ids_from is not None:
355
base_tree, base_path = WorkingTree.open_containing(
357
except errors.NoWorkingTree:
358
base_branch, base_path = Branch.open_containing(
360
base_tree = base_branch.basis_tree()
362
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
363
to_file=self.outf, should_print=(not is_quiet()))
365
action = bzrlib.add.AddAction(to_file=self.outf,
366
should_print=(not is_quiet()))
369
base_tree.lock_read()
371
file_list = self._maybe_expand_globs(file_list)
373
tree = WorkingTree.open_containing(file_list[0])[0]
375
tree = WorkingTree.open_containing(u'.')[0]
376
added, ignored = tree.smart_add(file_list, not
377
no_recurse, action=action, save=not dry_run)
379
if base_tree is not None:
383
for glob in sorted(ignored.keys()):
384
for path in ignored[glob]:
385
self.outf.write("ignored %s matching \"%s\"\n"
389
for glob, paths in ignored.items():
390
match_len += len(paths)
391
self.outf.write("ignored %d file(s).\n" % match_len)
392
self.outf.write("If you wish to add some of these files,"
393
" please add them by name.\n")
396
class cmd_mkdir(Command):
397
"""Create a new versioned directory.
399
This is equivalent to creating the directory and then adding it.
402
takes_args = ['dir+']
403
encoding_type = 'replace'
405
def run(self, dir_list):
408
wt, dd = WorkingTree.open_containing(d)
410
self.outf.write('added %s\n' % d)
413
class cmd_relpath(Command):
414
"""Show path of a file relative to root"""
416
takes_args = ['filename']
420
def run(self, filename):
421
# TODO: jam 20050106 Can relpath return a munged path if
422
# sys.stdout encoding cannot represent it?
423
tree, relpath = WorkingTree.open_containing(filename)
424
self.outf.write(relpath)
425
self.outf.write('\n')
428
class cmd_inventory(Command):
429
"""Show inventory of the current working copy or a revision.
431
It is possible to limit the output to a particular entry
432
type using the --kind option. For example: --kind file.
434
It is also possible to restrict the list of files to a specific
435
set. For example: bzr inventory --show-ids this/file
440
takes_options = ['revision', 'show-ids', 'kind']
441
takes_args = ['file*']
444
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
445
if kind and kind not in ['file', 'directory', 'symlink']:
446
raise errors.BzrCommandError('invalid kind specified')
448
work_tree, file_list = tree_files(file_list)
449
work_tree.lock_read()
451
if revision is not None:
452
if len(revision) > 1:
453
raise errors.BzrCommandError(
454
'bzr inventory --revision takes exactly one revision'
456
revision_id = revision[0].in_history(work_tree.branch).rev_id
457
tree = work_tree.branch.repository.revision_tree(revision_id)
459
extra_trees = [work_tree]
465
if file_list is not None:
466
file_ids = tree.paths2ids(file_list, trees=extra_trees,
467
require_versioned=True)
468
# find_ids_across_trees may include some paths that don't
470
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
471
for file_id in file_ids if file_id in tree)
473
entries = tree.inventory.entries()
476
if tree is not work_tree:
479
for path, entry in entries:
480
if kind and kind != entry.kind:
483
self.outf.write('%-50s %s\n' % (path, entry.file_id))
485
self.outf.write(path)
486
self.outf.write('\n')
489
class cmd_mv(Command):
490
"""Move or rename a file.
493
bzr mv OLDNAME NEWNAME
494
bzr mv SOURCE... DESTINATION
496
If the last argument is a versioned directory, all the other names
497
are moved into it. Otherwise, there must be exactly two arguments
498
and the file is changed to a new name.
500
If OLDNAME does not exist on the filesystem but is versioned and
501
NEWNAME does exist on the filesystem but is not versioned, mv
502
assumes that the file has been manually moved and only updates
503
its internal inventory to reflect that change.
504
The same is valid when moving many SOURCE files to a DESTINATION.
506
Files cannot be moved between branches.
509
takes_args = ['names*']
510
takes_options = [Option("after", help="move only the bzr identifier"
511
" of the file (file has already been moved). Use this flag if"
512
" bzr is not able to detect this itself.")]
513
aliases = ['move', 'rename']
514
encoding_type = 'replace'
516
def run(self, names_list, after=False):
517
if names_list is None:
520
if len(names_list) < 2:
521
raise errors.BzrCommandError("missing file argument")
522
tree, rel_names = tree_files(names_list)
524
if os.path.isdir(names_list[-1]):
525
# move into existing directory
526
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
527
self.outf.write("%s => %s\n" % pair)
529
if len(names_list) != 2:
530
raise errors.BzrCommandError('to mv multiple files the'
531
' destination must be a versioned'
533
tree.rename_one(rel_names[0], rel_names[1], after=after)
534
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
537
class cmd_pull(Command):
538
"""Turn this branch into a mirror of another branch.
540
This command only works on branches that have not diverged. Branches are
541
considered diverged if the destination branch's most recent commit is one
542
that has not been merged (directly or indirectly) into the parent.
544
If branches have diverged, you can use 'bzr merge' to integrate the changes
545
from one into the other. Once one branch has merged, the other should
546
be able to pull it again.
548
If you want to forget your local changes and just update your branch to
549
match the remote one, use pull --overwrite.
551
If there is no default location set, the first pull will set it. After
552
that, you can omit the location to use the default. To change the
553
default, use --remember. The value will only be saved if the remote
554
location can be accessed.
557
_see_also = ['push', 'update', 'status-flags']
558
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
560
help='branch to pull into, '
561
'rather than the one containing the working directory',
566
takes_args = ['location?']
567
encoding_type = 'replace'
569
def run(self, location=None, remember=False, overwrite=False,
570
revision=None, verbose=False,
572
from bzrlib.tag import _merge_tags_if_possible
573
# FIXME: too much stuff is in the command class
576
if directory is None:
579
tree_to = WorkingTree.open_containing(directory)[0]
580
branch_to = tree_to.branch
581
except errors.NoWorkingTree:
583
branch_to = Branch.open_containing(directory)[0]
586
if location is not None:
588
mergeable = bundle.read_mergeable_from_url(
590
except errors.NotABundle:
591
pass # Continue on considering this url a Branch
593
stored_loc = branch_to.get_parent()
595
if stored_loc is None:
596
raise errors.BzrCommandError("No pull location known or"
599
display_url = urlutils.unescape_for_display(stored_loc,
601
self.outf.write("Using saved location: %s\n" % display_url)
602
location = stored_loc
604
if mergeable is not None:
605
if revision is not None:
606
raise errors.BzrCommandError(
607
'Cannot use -r with merge directives or bundles')
608
revision_id = mergeable.install_revisions(branch_to.repository)
609
branch_from = branch_to
611
branch_from = Branch.open(location)
613
if branch_to.get_parent() is None or remember:
614
branch_to.set_parent(branch_from.base)
616
if revision is not None:
617
if len(revision) == 1:
618
revision_id = revision[0].in_history(branch_from).rev_id
620
raise errors.BzrCommandError(
621
'bzr pull --revision takes one value.')
623
old_rh = branch_to.revision_history()
624
if tree_to is not None:
625
result = tree_to.pull(branch_from, overwrite, revision_id,
626
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
628
result = branch_to.pull(branch_from, overwrite, revision_id)
630
result.report(self.outf)
632
from bzrlib.log import show_changed_revisions
633
new_rh = branch_to.revision_history()
634
show_changed_revisions(branch_to, old_rh, new_rh,
638
class cmd_push(Command):
639
"""Update a mirror of this branch.
641
The target branch will not have its working tree populated because this
642
is both expensive, and is not supported on remote file systems.
644
Some smart servers or protocols *may* put the working tree in place in
647
This command only works on branches that have not diverged. Branches are
648
considered diverged if the destination branch's most recent commit is one
649
that has not been merged (directly or indirectly) by the source branch.
651
If branches have diverged, you can use 'bzr push --overwrite' to replace
652
the other branch completely, discarding its unmerged changes.
654
If you want to ensure you have the different changes in the other branch,
655
do a merge (see bzr help merge) from the other branch, and commit that.
656
After that you will be able to do a push without '--overwrite'.
658
If there is no default push location set, the first push will set it.
659
After that, you can omit the location to use the default. To change the
660
default, use --remember. The value will only be saved if the remote
661
location can be accessed.
664
_see_also = ['pull', 'update', 'working-trees']
665
takes_options = ['remember', 'overwrite', 'verbose',
666
Option('create-prefix',
667
help='Create the path leading up to the branch '
668
'if it does not already exist'),
670
help='branch to push from, '
671
'rather than the one containing the working directory',
675
Option('use-existing-dir',
676
help='By default push will fail if the target'
677
' directory exists, but does not already'
678
' have a control directory. This flag will'
679
' allow push to proceed.'),
681
takes_args = ['location?']
682
encoding_type = 'replace'
684
def run(self, location=None, remember=False, overwrite=False,
685
create_prefix=False, verbose=False,
686
use_existing_dir=False,
688
# FIXME: Way too big! Put this into a function called from the
690
if directory is None:
692
br_from = Branch.open_containing(directory)[0]
693
stored_loc = br_from.get_push_location()
695
if stored_loc is None:
696
raise errors.BzrCommandError("No push location known or specified.")
698
display_url = urlutils.unescape_for_display(stored_loc,
700
self.outf.write("Using saved location: %s\n" % display_url)
701
location = stored_loc
703
to_transport = transport.get_transport(location)
705
br_to = repository_to = dir_to = None
707
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
708
except errors.NotBranchError:
709
pass # Didn't find anything
711
# If we can open a branch, use its direct repository, otherwise see
712
# if there is a repository without a branch.
714
br_to = dir_to.open_branch()
715
except errors.NotBranchError:
716
# Didn't find a branch, can we find a repository?
718
repository_to = dir_to.find_repository()
719
except errors.NoRepositoryPresent:
722
# Found a branch, so we must have found a repository
723
repository_to = br_to.repository
727
# The destination doesn't exist; create it.
728
# XXX: Refactor the create_prefix/no_create_prefix code into a
729
# common helper function
731
to_transport.mkdir('.')
732
except errors.FileExists:
733
if not use_existing_dir:
734
raise errors.BzrCommandError("Target directory %s"
735
" already exists, but does not have a valid .bzr"
736
" directory. Supply --use-existing-dir to push"
737
" there anyway." % location)
738
except errors.NoSuchFile:
739
if not create_prefix:
740
raise errors.BzrCommandError("Parent directory of %s"
742
"\nYou may supply --create-prefix to create all"
743
" leading parent directories."
746
_create_prefix(to_transport)
748
# Now the target directory exists, but doesn't have a .bzr
749
# directory. So we need to create it, along with any work to create
750
# all of the dependent branches, etc.
751
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
752
revision_id=br_from.last_revision())
753
br_to = dir_to.open_branch()
754
# TODO: Some more useful message about what was copied
755
note('Created new branch.')
756
# We successfully created the target, remember it
757
if br_from.get_push_location() is None or remember:
758
br_from.set_push_location(br_to.base)
759
elif repository_to is None:
760
# we have a bzrdir but no branch or repository
761
# XXX: Figure out what to do other than complain.
762
raise errors.BzrCommandError("At %s you have a valid .bzr control"
763
" directory, but not a branch or repository. This is an"
764
" unsupported configuration. Please move the target directory"
765
" out of the way and try again."
768
# We have a repository but no branch, copy the revisions, and then
770
last_revision_id = br_from.last_revision()
771
repository_to.fetch(br_from.repository,
772
revision_id=last_revision_id)
773
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
774
note('Created new branch.')
775
if br_from.get_push_location() is None or remember:
776
br_from.set_push_location(br_to.base)
777
else: # We have a valid to branch
778
# We were able to connect to the remote location, so remember it
779
# we don't need to successfully push because of possible divergence.
780
if br_from.get_push_location() is None or remember:
781
br_from.set_push_location(br_to.base)
782
old_rh = br_to.revision_history()
785
tree_to = dir_to.open_workingtree()
786
except errors.NotLocalUrl:
787
warning("This transport does not update the working "
788
"tree of: %s. See 'bzr help working-trees' for "
789
"more information." % br_to.base)
790
push_result = br_from.push(br_to, overwrite)
791
except errors.NoWorkingTree:
792
push_result = br_from.push(br_to, overwrite)
796
push_result = br_from.push(tree_to.branch, overwrite)
800
except errors.DivergedBranches:
801
raise errors.BzrCommandError('These branches have diverged.'
802
' Try using "merge" and then "push".')
803
if push_result is not None:
804
push_result.report(self.outf)
806
new_rh = br_to.revision_history()
809
from bzrlib.log import show_changed_revisions
810
show_changed_revisions(br_to, old_rh, new_rh,
813
# we probably did a clone rather than a push, so a message was
818
class cmd_branch(Command):
819
"""Create a new copy of a branch.
821
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
822
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
823
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
824
is derived from the FROM_LOCATION by stripping a leading scheme or drive
825
identifier, if any. For example, "branch lp:foo-bar" will attempt to
828
To retrieve the branch as of a particular revision, supply the --revision
829
parameter, as in "branch foo/bar -r 5".
832
_see_also = ['checkout']
833
takes_args = ['from_location', 'to_location?']
834
takes_options = ['revision']
835
aliases = ['get', 'clone']
837
def run(self, from_location, to_location=None, revision=None):
838
from bzrlib.tag import _merge_tags_if_possible
841
elif len(revision) > 1:
842
raise errors.BzrCommandError(
843
'bzr branch --revision takes exactly 1 revision value')
845
br_from = Branch.open(from_location)
848
if len(revision) == 1 and revision[0] is not None:
849
revision_id = revision[0].in_history(br_from)[1]
851
# FIXME - wt.last_revision, fallback to branch, fall back to
852
# None or perhaps NULL_REVISION to mean copy nothing
854
revision_id = br_from.last_revision()
855
if to_location is None:
856
to_location = urlutils.derive_to_location(from_location)
859
name = os.path.basename(to_location) + '\n'
861
to_transport = transport.get_transport(to_location)
863
to_transport.mkdir('.')
864
except errors.FileExists:
865
raise errors.BzrCommandError('Target directory "%s" already'
866
' exists.' % to_location)
867
except errors.NoSuchFile:
868
raise errors.BzrCommandError('Parent of "%s" does not exist.'
871
# preserve whatever source format we have.
872
dir = br_from.bzrdir.sprout(to_transport.base, revision_id)
873
branch = dir.open_branch()
874
except errors.NoSuchRevision:
875
to_transport.delete_tree('.')
876
msg = "The branch %s has no revision %s." % (from_location, revision[0])
877
raise errors.BzrCommandError(msg)
879
branch.control_files.put_utf8('branch-name', name)
880
_merge_tags_if_possible(br_from, branch)
881
note('Branched %d revision(s).' % branch.revno())
886
class cmd_checkout(Command):
887
"""Create a new checkout of an existing branch.
889
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
890
the branch found in '.'. This is useful if you have removed the working tree
891
or if it was never created - i.e. if you pushed the branch to its current
894
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
895
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
896
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
897
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
898
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
901
To retrieve the branch as of a particular revision, supply the --revision
902
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
903
out of date [so you cannot commit] but it may be useful (i.e. to examine old
907
_see_also = ['checkouts', 'branch']
908
takes_args = ['branch_location?', 'to_location?']
909
takes_options = ['revision',
910
Option('lightweight',
911
help="perform a lightweight checkout. Lightweight "
912
"checkouts depend on access to the branch for "
913
"every operation. Normal checkouts can perform "
914
"common operations like diff and status without "
915
"such access, and also support local commits."
920
def run(self, branch_location=None, to_location=None, revision=None,
924
elif len(revision) > 1:
925
raise errors.BzrCommandError(
926
'bzr checkout --revision takes exactly 1 revision value')
927
if branch_location is None:
928
branch_location = osutils.getcwd()
929
to_location = branch_location
930
source = Branch.open(branch_location)
931
if len(revision) == 1 and revision[0] is not None:
932
revision_id = revision[0].in_history(source)[1]
935
if to_location is None:
936
to_location = urlutils.derive_to_location(branch_location)
937
# if the source and to_location are the same,
938
# and there is no working tree,
939
# then reconstitute a branch
940
if (osutils.abspath(to_location) ==
941
osutils.abspath(branch_location)):
943
source.bzrdir.open_workingtree()
944
except errors.NoWorkingTree:
945
source.bzrdir.create_workingtree()
948
os.mkdir(to_location)
950
if e.errno == errno.EEXIST:
951
raise errors.BzrCommandError('Target directory "%s" already'
952
' exists.' % to_location)
953
if e.errno == errno.ENOENT:
954
raise errors.BzrCommandError('Parent of "%s" does not exist.'
958
source.create_checkout(to_location, revision_id, lightweight)
961
class cmd_renames(Command):
962
"""Show list of renamed files.
964
# TODO: Option to show renames between two historical versions.
966
# TODO: Only show renames under dir, rather than in the whole branch.
967
_see_also = ['status']
968
takes_args = ['dir?']
971
def run(self, dir=u'.'):
972
tree = WorkingTree.open_containing(dir)[0]
975
new_inv = tree.inventory
976
old_tree = tree.basis_tree()
979
old_inv = old_tree.inventory
980
renames = list(_mod_tree.find_renames(old_inv, new_inv))
982
for old_name, new_name in renames:
983
self.outf.write("%s => %s\n" % (old_name, new_name))
990
class cmd_update(Command):
991
"""Update a tree to have the latest code committed to its branch.
993
This will perform a merge into the working tree, and may generate
994
conflicts. If you have any local changes, you will still
995
need to commit them after the update for the update to be complete.
997
If you want to discard your local changes, you can just do a
998
'bzr revert' instead of 'bzr commit' after the update.
1001
_see_also = ['pull', 'working-trees']
1002
takes_args = ['dir?']
1005
def run(self, dir='.'):
1006
tree = WorkingTree.open_containing(dir)[0]
1007
master = tree.branch.get_master_branch()
1008
if master is not None:
1011
tree.lock_tree_write()
1013
existing_pending_merges = tree.get_parent_ids()[1:]
1014
last_rev = tree.last_revision()
1015
if last_rev is None:
1016
last_rev = _mod_revision.NULL_REVISION
1017
if last_rev == tree.branch.last_revision():
1018
# may be up to date, check master too.
1019
master = tree.branch.get_master_branch()
1020
if master is None or last_rev == master.last_revision():
1021
revno = tree.branch.revision_id_to_revno(last_rev)
1022
note("Tree is up to date at revision %d." % (revno,))
1024
conflicts = tree.update(delta._ChangeReporter(
1025
unversioned_filter=tree.is_ignored))
1026
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1027
note('Updated to revision %d.' % (revno,))
1028
if tree.get_parent_ids()[1:] != existing_pending_merges:
1029
note('Your local commits will now show as pending merges with '
1030
"'bzr status', and can be committed with 'bzr commit'.")
1039
class cmd_info(Command):
1040
"""Show information about a working tree, branch or repository.
1042
This command will show all known locations and formats associated to the
1043
tree, branch or repository. Statistical information is included with
1046
Branches and working trees will also report any missing revisions.
1048
_see_also = ['revno', 'working-trees', 'repositories']
1049
takes_args = ['location?']
1050
takes_options = ['verbose']
1053
def run(self, location=None, verbose=0):
1054
from bzrlib.info import show_bzrdir_info
1055
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1059
class cmd_remove(Command):
1060
"""Remove files or directories.
1062
This makes bzr stop tracking changes to the specified files and
1063
delete them if they can easily be recovered using revert.
1065
You can specify one or more files, and/or --new. If you specify --new,
1066
only 'added' files will be removed. If you specify both, then new files
1067
in the specified directories will be removed. If the directories are
1068
also new, they will also be removed.
1070
takes_args = ['file*']
1071
takes_options = ['verbose',
1072
Option('new', help='remove newly-added files'),
1073
RegistryOption.from_kwargs('file-deletion-strategy',
1074
'The file deletion mode to be used',
1075
title='Deletion Strategy', value_switches=True, enum_switch=False,
1076
safe='Only delete files if they can be'
1077
' safely recovered (default).',
1078
keep="Don't delete any files.",
1079
force='Delete all the specified files, even if they can not be '
1080
'recovered and even if they are non-empty directories.')]
1082
encoding_type = 'replace'
1084
def run(self, file_list, verbose=False, new=False,
1085
file_deletion_strategy='safe'):
1086
tree, file_list = tree_files(file_list)
1088
if file_list is not None:
1089
file_list = [f for f in file_list if f != '']
1091
raise errors.BzrCommandError('Specify one or more files to'
1092
' remove, or use --new.')
1095
added = tree.changes_from(tree.basis_tree(),
1096
specific_files=file_list).added
1097
file_list = sorted([f[0] for f in added], reverse=True)
1098
if len(file_list) == 0:
1099
raise errors.BzrCommandError('No matching files.')
1100
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1101
keep_files=file_deletion_strategy=='keep',
1102
force=file_deletion_strategy=='force')
1105
class cmd_file_id(Command):
1106
"""Print file_id of a particular file or directory.
1108
The file_id is assigned when the file is first added and remains the
1109
same through all revisions where the file exists, even when it is
1114
_see_also = ['inventory', 'ls']
1115
takes_args = ['filename']
1118
def run(self, filename):
1119
tree, relpath = WorkingTree.open_containing(filename)
1120
i = tree.path2id(relpath)
1122
raise errors.NotVersionedError(filename)
1124
self.outf.write(i + '\n')
1127
class cmd_file_path(Command):
1128
"""Print path of file_ids to a file or directory.
1130
This prints one line for each directory down to the target,
1131
starting at the branch root.
1135
takes_args = ['filename']
1138
def run(self, filename):
1139
tree, relpath = WorkingTree.open_containing(filename)
1140
fid = tree.path2id(relpath)
1142
raise errors.NotVersionedError(filename)
1143
segments = osutils.splitpath(relpath)
1144
for pos in range(1, len(segments) + 1):
1145
path = osutils.joinpath(segments[:pos])
1146
self.outf.write("%s\n" % tree.path2id(path))
1149
class cmd_reconcile(Command):
1150
"""Reconcile bzr metadata in a branch.
1152
This can correct data mismatches that may have been caused by
1153
previous ghost operations or bzr upgrades. You should only
1154
need to run this command if 'bzr check' or a bzr developer
1155
advises you to run it.
1157
If a second branch is provided, cross-branch reconciliation is
1158
also attempted, which will check that data like the tree root
1159
id which was not present in very early bzr versions is represented
1160
correctly in both branches.
1162
At the same time it is run it may recompress data resulting in
1163
a potential saving in disk space or performance gain.
1165
The branch *MUST* be on a listable system such as local disk or sftp.
1168
_see_also = ['check']
1169
takes_args = ['branch?']
1171
def run(self, branch="."):
1172
from bzrlib.reconcile import reconcile
1173
dir = bzrdir.BzrDir.open(branch)
1177
class cmd_revision_history(Command):
1178
"""Display the list of revision ids on a branch."""
1181
takes_args = ['location?']
1186
def run(self, location="."):
1187
branch = Branch.open_containing(location)[0]
1188
for revid in branch.revision_history():
1189
self.outf.write(revid)
1190
self.outf.write('\n')
1193
class cmd_ancestry(Command):
1194
"""List all revisions merged into this branch."""
1196
_see_also = ['log', 'revision-history']
1197
takes_args = ['location?']
1202
def run(self, location="."):
1204
wt = WorkingTree.open_containing(location)[0]
1205
except errors.NoWorkingTree:
1206
b = Branch.open(location)
1207
last_revision = b.last_revision()
1210
last_revision = wt.last_revision()
1212
revision_ids = b.repository.get_ancestry(last_revision)
1213
assert revision_ids[0] is None
1215
for revision_id in revision_ids:
1216
self.outf.write(revision_id + '\n')
1219
class cmd_init(Command):
1220
"""Make a directory into a versioned branch.
1222
Use this to create an empty branch, or before importing an
1225
If there is a repository in a parent directory of the location, then
1226
the history of the branch will be stored in the repository. Otherwise
1227
init creates a standalone branch which carries its own history
1228
in the .bzr directory.
1230
If there is already a branch at the location but it has no working tree,
1231
the tree can be populated with 'bzr checkout'.
1233
Recipe for importing a tree of files:
1238
bzr commit -m 'imported project'
1241
_see_also = ['init-repo', 'branch', 'checkout']
1242
takes_args = ['location?']
1244
Option('create-prefix',
1245
help='Create the path leading up to the branch '
1246
'if it does not already exist'),
1247
RegistryOption('format',
1248
help='Specify a format for this branch. '
1249
'See "help formats".',
1250
registry=bzrdir.format_registry,
1251
converter=bzrdir.format_registry.make_bzrdir,
1252
value_switches=True,
1253
title="Branch Format",
1255
Option('append-revisions-only',
1256
help='Never change revnos or the existing log.'
1257
' Append revisions to it only.')
1259
def run(self, location=None, format=None, append_revisions_only=False,
1260
create_prefix=False):
1262
format = bzrdir.format_registry.make_bzrdir('default')
1263
if location is None:
1266
to_transport = transport.get_transport(location)
1268
# The path has to exist to initialize a
1269
# branch inside of it.
1270
# Just using os.mkdir, since I don't
1271
# believe that we want to create a bunch of
1272
# locations if the user supplies an extended path
1274
to_transport.ensure_base()
1275
except errors.NoSuchFile:
1276
if not create_prefix:
1277
raise errors.BzrCommandError("Parent directory of %s"
1279
"\nYou may supply --create-prefix to create all"
1280
" leading parent directories."
1282
_create_prefix(to_transport)
1285
existing_bzrdir = bzrdir.BzrDir.open(location)
1286
except errors.NotBranchError:
1287
# really a NotBzrDir error...
1288
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1291
from bzrlib.transport.local import LocalTransport
1292
if existing_bzrdir.has_branch():
1293
if (isinstance(to_transport, LocalTransport)
1294
and not existing_bzrdir.has_workingtree()):
1295
raise errors.BranchExistsWithoutWorkingTree(location)
1296
raise errors.AlreadyBranchError(location)
1298
branch = existing_bzrdir.create_branch()
1299
existing_bzrdir.create_workingtree()
1300
if append_revisions_only:
1302
branch.set_append_revisions_only(True)
1303
except errors.UpgradeRequired:
1304
raise errors.BzrCommandError('This branch format cannot be set'
1305
' to append-revisions-only. Try --experimental-branch6')
1308
class cmd_init_repository(Command):
1309
"""Create a shared repository to hold branches.
1311
New branches created under the repository directory will store their
1312
revisions in the repository, not in the branch directory.
1314
If the --no-trees option is used then the branches in the repository
1315
will not have working trees by default.
1318
bzr init-repo --no-trees repo
1320
bzr checkout --lightweight repo/trunk trunk-checkout
1324
See 'bzr help repositories' for more information.
1327
_see_also = ['init', 'branch', 'checkout']
1328
takes_args = ["location"]
1329
takes_options = [RegistryOption('format',
1330
help='Specify a format for this repository. See'
1331
' "bzr help formats" for details',
1332
registry=bzrdir.format_registry,
1333
converter=bzrdir.format_registry.make_bzrdir,
1334
value_switches=True, title='Repository format'),
1336
help='Branches in the repository will default to'
1337
' not having a working tree'),
1339
aliases = ["init-repo"]
1341
def run(self, location, format=None, no_trees=False):
1343
format = bzrdir.format_registry.make_bzrdir('default')
1345
if location is None:
1348
to_transport = transport.get_transport(location)
1349
to_transport.ensure_base()
1351
newdir = format.initialize_on_transport(to_transport)
1352
repo = newdir.create_repository(shared=True)
1353
repo.set_make_working_trees(not no_trees)
1356
class cmd_diff(Command):
1357
"""Show differences in the working tree or between revisions.
1359
If files are listed, only the changes in those files are listed.
1360
Otherwise, all changes for the tree are listed.
1362
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1363
produces patches suitable for "patch -p1".
1367
Shows the difference in the working tree versus the last commit
1369
Difference between the working tree and revision 1
1371
Difference between revision 2 and revision 1
1372
bzr diff --prefix old/:new/
1373
Same as 'bzr diff' but prefix paths with old/ and new/
1374
bzr diff bzr.mine bzr.dev
1375
Show the differences between the two working trees
1377
Show just the differences for 'foo.c'
1379
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1380
# or a graphical diff.
1382
# TODO: Python difflib is not exactly the same as unidiff; should
1383
# either fix it up or prefer to use an external diff.
1385
# TODO: Selected-file diff is inefficient and doesn't show you
1388
# TODO: This probably handles non-Unix newlines poorly.
1390
_see_also = ['status']
1391
takes_args = ['file*']
1392
takes_options = ['revision', 'diff-options',
1393
Option('prefix', type=str,
1395
help='Set prefixes to added to old and new filenames, as '
1396
'two values separated by a colon. (eg "old/:new/")'),
1398
aliases = ['di', 'dif']
1399
encoding_type = 'exact'
1402
def run(self, revision=None, file_list=None, diff_options=None,
1404
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1406
if (prefix is None) or (prefix == '0'):
1414
old_label, new_label = prefix.split(":")
1416
raise errors.BzrCommandError(
1417
'--prefix expects two values separated by a colon'
1418
' (eg "old/:new/")')
1420
if revision and len(revision) > 2:
1421
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1422
' one or two revision specifiers')
1425
tree1, file_list = internal_tree_files(file_list)
1429
except errors.FileInWrongBranch:
1430
if len(file_list) != 2:
1431
raise errors.BzrCommandError("Files are in different branches")
1433
tree1, file1 = WorkingTree.open_containing(file_list[0])
1434
tree2, file2 = WorkingTree.open_containing(file_list[1])
1435
if file1 != "" or file2 != "":
1436
# FIXME diff those two files. rbc 20051123
1437
raise errors.BzrCommandError("Files are in different branches")
1439
except errors.NotBranchError:
1440
if (revision is not None and len(revision) == 2
1441
and not revision[0].needs_branch()
1442
and not revision[1].needs_branch()):
1443
# If both revision specs include a branch, we can
1444
# diff them without needing a local working tree
1445
tree1, tree2 = None, None
1449
if tree2 is not None:
1450
if revision is not None:
1451
# FIXME: but there should be a clean way to diff between
1452
# non-default versions of two trees, it's not hard to do
1454
raise errors.BzrCommandError(
1455
"Sorry, diffing arbitrary revisions across branches "
1456
"is not implemented yet")
1457
return show_diff_trees(tree1, tree2, sys.stdout,
1458
specific_files=file_list,
1459
external_diff_options=diff_options,
1460
old_label=old_label, new_label=new_label)
1462
return diff_cmd_helper(tree1, file_list, diff_options,
1463
revision_specs=revision,
1464
old_label=old_label, new_label=new_label)
1467
class cmd_deleted(Command):
1468
"""List files deleted in the working tree.
1470
# TODO: Show files deleted since a previous revision, or
1471
# between two revisions.
1472
# TODO: Much more efficient way to do this: read in new
1473
# directories with readdir, rather than stating each one. Same
1474
# level of effort but possibly much less IO. (Or possibly not,
1475
# if the directories are very large...)
1476
_see_also = ['status', 'ls']
1477
takes_options = ['show-ids']
1480
def run(self, show_ids=False):
1481
tree = WorkingTree.open_containing(u'.')[0]
1484
old = tree.basis_tree()
1487
for path, ie in old.inventory.iter_entries():
1488
if not tree.has_id(ie.file_id):
1489
self.outf.write(path)
1491
self.outf.write(' ')
1492
self.outf.write(ie.file_id)
1493
self.outf.write('\n')
1500
class cmd_modified(Command):
1501
"""List files modified in working tree.
1505
_see_also = ['status', 'ls']
1509
tree = WorkingTree.open_containing(u'.')[0]
1510
td = tree.changes_from(tree.basis_tree())
1511
for path, id, kind, text_modified, meta_modified in td.modified:
1512
self.outf.write(path + '\n')
1515
class cmd_added(Command):
1516
"""List files added in working tree.
1520
_see_also = ['status', 'ls']
1524
wt = WorkingTree.open_containing(u'.')[0]
1527
basis = wt.basis_tree()
1530
basis_inv = basis.inventory
1533
if file_id in basis_inv:
1535
if inv.is_root(file_id) and len(basis_inv) == 0:
1537
path = inv.id2path(file_id)
1538
if not os.access(osutils.abspath(path), os.F_OK):
1540
self.outf.write(path + '\n')
1547
class cmd_root(Command):
1548
"""Show the tree root directory.
1550
The root is the nearest enclosing directory with a .bzr control
1553
takes_args = ['filename?']
1555
def run(self, filename=None):
1556
"""Print the branch root."""
1557
tree = WorkingTree.open_containing(filename)[0]
1558
self.outf.write(tree.basedir + '\n')
1561
def _parse_limit(limitstring):
1563
return int(limitstring)
1565
msg = "The limit argument must be an integer."
1566
raise errors.BzrCommandError(msg)
1569
class cmd_log(Command):
1570
"""Show log of a branch, file, or directory.
1572
By default show the log of the branch containing the working directory.
1574
To request a range of logs, you can use the command -r begin..end
1575
-r revision requests a specific revision, -r ..end or -r begin.. are
1581
bzr log -r -10.. http://server/branch
1584
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1586
takes_args = ['location?']
1587
takes_options = [Option('forward',
1588
help='show from oldest to newest'),
1592
help='show files changed in each revision'),
1593
'show-ids', 'revision',
1597
help='show revisions whose message matches this regexp',
1600
help='limit the output to the first N revisions',
1603
encoding_type = 'replace'
1606
def run(self, location=None, timezone='original',
1614
from bzrlib.log import show_log
1615
assert message is None or isinstance(message, basestring), \
1616
"invalid message argument %r" % message
1617
direction = (forward and 'forward') or 'reverse'
1622
# find the file id to log:
1624
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1628
tree = b.basis_tree()
1629
file_id = tree.path2id(fp)
1631
raise errors.BzrCommandError(
1632
"Path does not have any revision history: %s" %
1636
# FIXME ? log the current subdir only RBC 20060203
1637
if revision is not None \
1638
and len(revision) > 0 and revision[0].get_branch():
1639
location = revision[0].get_branch()
1642
dir, relpath = bzrdir.BzrDir.open_containing(location)
1643
b = dir.open_branch()
1647
if revision is None:
1650
elif len(revision) == 1:
1651
rev1 = rev2 = revision[0].in_history(b)
1652
elif len(revision) == 2:
1653
if revision[1].get_branch() != revision[0].get_branch():
1654
# b is taken from revision[0].get_branch(), and
1655
# show_log will use its revision_history. Having
1656
# different branches will lead to weird behaviors.
1657
raise errors.BzrCommandError(
1658
"Log doesn't accept two revisions in different"
1660
rev1 = revision[0].in_history(b)
1661
rev2 = revision[1].in_history(b)
1663
raise errors.BzrCommandError(
1664
'bzr log --revision takes one or two values.')
1666
if log_format is None:
1667
log_format = log.log_formatter_registry.get_default(b)
1669
lf = log_format(show_ids=show_ids, to_file=self.outf,
1670
show_timezone=timezone)
1676
direction=direction,
1677
start_revision=rev1,
1685
def get_log_format(long=False, short=False, line=False, default='long'):
1686
log_format = default
1690
log_format = 'short'
1696
class cmd_touching_revisions(Command):
1697
"""Return revision-ids which affected a particular file.
1699
A more user-friendly interface is "bzr log FILE".
1703
takes_args = ["filename"]
1706
def run(self, filename):
1707
tree, relpath = WorkingTree.open_containing(filename)
1709
file_id = tree.path2id(relpath)
1710
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1711
self.outf.write("%6d %s\n" % (revno, what))
1714
class cmd_ls(Command):
1715
"""List files in a tree.
1718
_see_also = ['status', 'cat']
1719
takes_args = ['path?']
1720
# TODO: Take a revision or remote path and list that tree instead.
1721
takes_options = ['verbose', 'revision',
1722
Option('non-recursive',
1723
help='don\'t recurse into sub-directories'),
1725
help='Print all paths from the root of the branch.'),
1726
Option('unknown', help='Print unknown files'),
1727
Option('versioned', help='Print versioned files'),
1728
Option('ignored', help='Print ignored files'),
1730
Option('null', help='Null separate the files'),
1734
def run(self, revision=None, verbose=False,
1735
non_recursive=False, from_root=False,
1736
unknown=False, versioned=False, ignored=False,
1737
null=False, kind=None, show_ids=False, path=None):
1739
if kind and kind not in ('file', 'directory', 'symlink'):
1740
raise errors.BzrCommandError('invalid kind specified')
1742
if verbose and null:
1743
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1744
all = not (unknown or versioned or ignored)
1746
selection = {'I':ignored, '?':unknown, 'V':versioned}
1753
raise errors.BzrCommandError('cannot specify both --from-root'
1757
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1763
if revision is not None:
1764
tree = branch.repository.revision_tree(
1765
revision[0].in_history(branch).rev_id)
1767
tree = branch.basis_tree()
1771
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1772
if fp.startswith(relpath):
1773
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1774
if non_recursive and '/' in fp:
1776
if not all and not selection[fc]:
1778
if kind is not None and fkind != kind:
1781
kindch = entry.kind_character()
1782
outstring = '%-8s %s%s' % (fc, fp, kindch)
1783
if show_ids and fid is not None:
1784
outstring = "%-50s %s" % (outstring, fid)
1785
self.outf.write(outstring + '\n')
1787
self.outf.write(fp + '\0')
1790
self.outf.write(fid)
1791
self.outf.write('\0')
1799
self.outf.write('%-50s %s\n' % (fp, my_id))
1801
self.outf.write(fp + '\n')
1806
class cmd_unknowns(Command):
1807
"""List unknown files.
1815
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1816
self.outf.write(osutils.quotefn(f) + '\n')
1819
class cmd_ignore(Command):
1820
"""Ignore specified files or patterns.
1822
To remove patterns from the ignore list, edit the .bzrignore file.
1824
Trailing slashes on patterns are ignored.
1825
If the pattern contains a slash or is a regular expression, it is compared
1826
to the whole path from the branch root. Otherwise, it is compared to only
1827
the last component of the path. To match a file only in the root
1828
directory, prepend './'.
1830
Ignore patterns specifying absolute paths are not allowed.
1832
Ignore patterns may include globbing wildcards such as:
1833
? - Matches any single character except '/'
1834
* - Matches 0 or more characters except '/'
1835
/**/ - Matches 0 or more directories in a path
1836
[a-z] - Matches a single character from within a group of characters
1838
Ignore patterns may also be Python regular expressions.
1839
Regular expression ignore patterns are identified by a 'RE:' prefix
1840
followed by the regular expression. Regular expression ignore patterns
1841
may not include named or numbered groups.
1843
Note: ignore patterns containing shell wildcards must be quoted from
1847
bzr ignore ./Makefile
1848
bzr ignore '*.class'
1849
bzr ignore 'lib/**/*.o'
1850
bzr ignore 'RE:lib/.*\.o'
1853
_see_also = ['status', 'ignored']
1854
takes_args = ['name_pattern*']
1856
Option('old-default-rules',
1857
help='Out the ignore rules bzr < 0.9 always used.')
1860
def run(self, name_pattern_list=None, old_default_rules=None):
1861
from bzrlib.atomicfile import AtomicFile
1862
if old_default_rules is not None:
1863
# dump the rules and exit
1864
for pattern in ignores.OLD_DEFAULTS:
1867
if not name_pattern_list:
1868
raise errors.BzrCommandError("ignore requires at least one "
1869
"NAME_PATTERN or --old-default-rules")
1870
name_pattern_list = [globbing.normalize_pattern(p)
1871
for p in name_pattern_list]
1872
for name_pattern in name_pattern_list:
1873
if (name_pattern[0] == '/' or
1874
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1875
raise errors.BzrCommandError(
1876
"NAME_PATTERN should not be an absolute path")
1877
tree, relpath = WorkingTree.open_containing(u'.')
1878
ifn = tree.abspath('.bzrignore')
1879
if os.path.exists(ifn):
1882
igns = f.read().decode('utf-8')
1888
# TODO: If the file already uses crlf-style termination, maybe
1889
# we should use that for the newly added lines?
1891
if igns and igns[-1] != '\n':
1893
for name_pattern in name_pattern_list:
1894
igns += name_pattern + '\n'
1896
f = AtomicFile(ifn, 'wb')
1898
f.write(igns.encode('utf-8'))
1903
if not tree.path2id('.bzrignore'):
1904
tree.add(['.bzrignore'])
1907
class cmd_ignored(Command):
1908
"""List ignored files and the patterns that matched them.
1911
_see_also = ['ignore']
1914
tree = WorkingTree.open_containing(u'.')[0]
1917
for path, file_class, kind, file_id, entry in tree.list_files():
1918
if file_class != 'I':
1920
## XXX: Slightly inefficient since this was already calculated
1921
pat = tree.is_ignored(path)
1922
print '%-50s %s' % (path, pat)
1927
class cmd_lookup_revision(Command):
1928
"""Lookup the revision-id from a revision-number
1931
bzr lookup-revision 33
1934
takes_args = ['revno']
1937
def run(self, revno):
1941
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1943
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1946
class cmd_export(Command):
1947
"""Export current or past revision to a destination directory or archive.
1949
If no revision is specified this exports the last committed revision.
1951
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1952
given, try to find the format with the extension. If no extension
1953
is found exports to a directory (equivalent to --format=dir).
1955
If root is supplied, it will be used as the root directory inside
1956
container formats (tar, zip, etc). If it is not supplied it will default
1957
to the exported filename. The root option has no effect for 'dir' format.
1959
If branch is omitted then the branch containing the current working
1960
directory will be used.
1962
Note: Export of tree with non-ASCII filenames to zip is not supported.
1964
Supported formats Autodetected by extension
1965
----------------- -------------------------
1968
tbz2 .tar.bz2, .tbz2
1972
takes_args = ['dest', 'branch?']
1973
takes_options = ['revision', 'format', 'root']
1974
def run(self, dest, branch=None, revision=None, format=None, root=None):
1975
from bzrlib.export import export
1978
tree = WorkingTree.open_containing(u'.')[0]
1981
b = Branch.open(branch)
1983
if revision is None:
1984
# should be tree.last_revision FIXME
1985
rev_id = b.last_revision()
1987
if len(revision) != 1:
1988
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1989
rev_id = revision[0].in_history(b).rev_id
1990
t = b.repository.revision_tree(rev_id)
1992
export(t, dest, format, root)
1993
except errors.NoSuchExportFormat, e:
1994
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1997
class cmd_cat(Command):
1998
"""Write the contents of a file as of a given revision to standard output.
2000
If no revision is nominated, the last revision is used.
2002
Note: Take care to redirect standard output when using this command on a
2007
takes_options = ['revision', 'name-from-revision']
2008
takes_args = ['filename']
2009
encoding_type = 'exact'
2012
def run(self, filename, revision=None, name_from_revision=False):
2013
if revision is not None and len(revision) != 1:
2014
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2019
tree, b, relpath = \
2020
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2021
except errors.NotBranchError:
2024
if revision is not None and revision[0].get_branch() is not None:
2025
b = Branch.open(revision[0].get_branch())
2027
tree = b.basis_tree()
2028
if revision is None:
2029
revision_id = b.last_revision()
2031
revision_id = revision[0].in_history(b).rev_id
2033
cur_file_id = tree.path2id(relpath)
2034
rev_tree = b.repository.revision_tree(revision_id)
2035
old_file_id = rev_tree.path2id(relpath)
2037
if name_from_revision:
2038
if old_file_id is None:
2039
raise errors.BzrCommandError("%r is not present in revision %s"
2040
% (filename, revision_id))
2042
rev_tree.print_file(old_file_id)
2043
elif cur_file_id is not None:
2044
rev_tree.print_file(cur_file_id)
2045
elif old_file_id is not None:
2046
rev_tree.print_file(old_file_id)
2048
raise errors.BzrCommandError("%r is not present in revision %s" %
2049
(filename, revision_id))
2052
class cmd_local_time_offset(Command):
2053
"""Show the offset in seconds from GMT to local time."""
2057
print osutils.local_time_offset()
2061
class cmd_commit(Command):
2062
"""Commit changes into a new revision.
2064
If no arguments are given, the entire tree is committed.
2066
If selected files are specified, only changes to those files are
2067
committed. If a directory is specified then the directory and everything
2068
within it is committed.
2070
A selected-file commit may fail in some cases where the committed
2071
tree would be invalid. Consider::
2076
bzr commit foo -m "committing foo"
2077
bzr mv foo/bar foo/baz
2080
bzr commit foo/bar -m "committing bar but not baz"
2082
In the example above, the last commit will fail by design. This gives
2083
the user the opportunity to decide whether they want to commit the
2084
rename at the same time, separately first, or not at all. (As a general
2085
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2087
Note: A selected-file commit after a merge is not yet supported.
2089
# TODO: Run hooks on tree to-be-committed, and after commit.
2091
# TODO: Strict commit that fails if there are deleted files.
2092
# (what does "deleted files" mean ??)
2094
# TODO: Give better message for -s, --summary, used by tla people
2096
# XXX: verbose currently does nothing
2098
_see_also = ['bugs', 'uncommit']
2099
takes_args = ['selected*']
2100
takes_options = ['message', 'verbose',
2102
help='commit even if nothing has changed'),
2103
Option('file', type=str,
2106
help='file containing commit message'),
2108
help="refuse to commit if there are unknown "
2109
"files in the working tree."),
2110
ListOption('fixes', type=str,
2111
help="mark a bug as being fixed by this "
2114
help="perform a local only commit in a bound "
2115
"branch. Such commits are not pushed to "
2116
"the master branch until a normal commit "
2120
aliases = ['ci', 'checkin']
2122
def _get_bug_fix_properties(self, fixes, branch):
2124
# Configure the properties for bug fixing attributes.
2125
for fixed_bug in fixes:
2126
tokens = fixed_bug.split(':')
2127
if len(tokens) != 2:
2128
raise errors.BzrCommandError(
2129
"Invalid bug %s. Must be in the form of 'tag:id'. "
2130
"Commit refused." % fixed_bug)
2131
tag, bug_id = tokens
2133
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2134
except errors.UnknownBugTrackerAbbreviation:
2135
raise errors.BzrCommandError(
2136
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2137
except errors.MalformedBugIdentifier:
2138
raise errors.BzrCommandError(
2139
"Invalid bug identifier for %s. Commit refused."
2141
properties.append('%s fixed' % bug_url)
2142
return '\n'.join(properties)
2144
def run(self, message=None, file=None, verbose=True, selected_list=None,
2145
unchanged=False, strict=False, local=False, fixes=None):
2146
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2147
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2149
from bzrlib.msgeditor import edit_commit_message, \
2150
make_commit_message_template
2152
# TODO: Need a blackbox test for invoking the external editor; may be
2153
# slightly problematic to run this cross-platform.
2155
# TODO: do more checks that the commit will succeed before
2156
# spending the user's valuable time typing a commit message.
2160
tree, selected_list = tree_files(selected_list)
2161
if selected_list == ['']:
2162
# workaround - commit of root of tree should be exactly the same
2163
# as just default commit in that tree, and succeed even though
2164
# selected-file merge commit is not done yet
2167
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2169
properties['bugs'] = bug_property
2171
if local and not tree.branch.get_bound_location():
2172
raise errors.LocalRequiresBoundBranch()
2174
def get_message(commit_obj):
2175
"""Callback to get commit message"""
2176
my_message = message
2177
if my_message is None and not file:
2178
template = make_commit_message_template(tree, selected_list)
2179
my_message = edit_commit_message(template)
2180
if my_message is None:
2181
raise errors.BzrCommandError("please specify a commit"
2182
" message with either --message or --file")
2183
elif my_message and file:
2184
raise errors.BzrCommandError(
2185
"please specify either --message or --file")
2187
my_message = codecs.open(file, 'rt',
2188
bzrlib.user_encoding).read()
2189
if my_message == "":
2190
raise errors.BzrCommandError("empty commit message specified")
2194
reporter = ReportCommitToLog()
2196
reporter = NullCommitReporter()
2199
tree.commit(message_callback=get_message,
2200
specific_files=selected_list,
2201
allow_pointless=unchanged, strict=strict, local=local,
2202
reporter=reporter, revprops=properties)
2203
except PointlessCommit:
2204
# FIXME: This should really happen before the file is read in;
2205
# perhaps prepare the commit; get the message; then actually commit
2206
raise errors.BzrCommandError("no changes to commit."
2207
" use --unchanged to commit anyhow")
2208
except ConflictsInTree:
2209
raise errors.BzrCommandError('Conflicts detected in working '
2210
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2212
except StrictCommitFailed:
2213
raise errors.BzrCommandError("Commit refused because there are"
2214
" unknown files in the working tree.")
2215
except errors.BoundBranchOutOfDate, e:
2216
raise errors.BzrCommandError(str(e) + "\n"
2217
'To commit to master branch, run update and then commit.\n'
2218
'You can also pass --local to commit to continue working '
2222
class cmd_check(Command):
2223
"""Validate consistency of branch history.
2225
This command checks various invariants about the branch storage to
2226
detect data corruption or bzr bugs.
2229
_see_also = ['reconcile']
2230
takes_args = ['branch?']
2231
takes_options = ['verbose']
2233
def run(self, branch=None, verbose=False):
2234
from bzrlib.check import check
2236
tree = WorkingTree.open_containing()[0]
2237
branch = tree.branch
2239
branch = Branch.open(branch)
2240
check(branch, verbose)
2243
class cmd_upgrade(Command):
2244
"""Upgrade branch storage to current format.
2246
The check command or bzr developers may sometimes advise you to run
2247
this command. When the default format has changed you may also be warned
2248
during other operations to upgrade.
2251
_see_also = ['check']
2252
takes_args = ['url?']
2254
RegistryOption('format',
2255
help='Upgrade to a specific format. See "bzr help'
2256
' formats" for details',
2257
registry=bzrdir.format_registry,
2258
converter=bzrdir.format_registry.make_bzrdir,
2259
value_switches=True, title='Branch format'),
2262
def run(self, url='.', format=None):
2263
from bzrlib.upgrade import upgrade
2265
format = bzrdir.format_registry.make_bzrdir('default')
2266
upgrade(url, format)
2269
class cmd_whoami(Command):
2270
"""Show or set bzr user id.
2274
bzr whoami 'Frank Chu <fchu@example.com>'
2276
takes_options = [ Option('email',
2277
help='display email address only'),
2279
help='set identity for the current branch instead of '
2282
takes_args = ['name?']
2283
encoding_type = 'replace'
2286
def run(self, email=False, branch=False, name=None):
2288
# use branch if we're inside one; otherwise global config
2290
c = Branch.open_containing('.')[0].get_config()
2291
except errors.NotBranchError:
2292
c = config.GlobalConfig()
2294
self.outf.write(c.user_email() + '\n')
2296
self.outf.write(c.username() + '\n')
2299
# display a warning if an email address isn't included in the given name.
2301
config.extract_email_address(name)
2302
except errors.NoEmailInUsername, e:
2303
warning('"%s" does not seem to contain an email address. '
2304
'This is allowed, but not recommended.', name)
2306
# use global config unless --branch given
2308
c = Branch.open_containing('.')[0].get_config()
2310
c = config.GlobalConfig()
2311
c.set_user_option('email', name)
2314
class cmd_nick(Command):
2315
"""Print or set the branch nickname.
2317
If unset, the tree root directory name is used as the nickname
2318
To print the current nickname, execute with no argument.
2321
_see_also = ['info']
2322
takes_args = ['nickname?']
2323
def run(self, nickname=None):
2324
branch = Branch.open_containing(u'.')[0]
2325
if nickname is None:
2326
self.printme(branch)
2328
branch.nick = nickname
2331
def printme(self, branch):
2335
class cmd_selftest(Command):
2336
"""Run internal test suite.
2338
If arguments are given, they are regular expressions that say which tests
2339
should run. Tests matching any expression are run, and other tests are
2342
Alternatively if --first is given, matching tests are run first and then
2343
all other tests are run. This is useful if you have been working in a
2344
particular area, but want to make sure nothing else was broken.
2346
If --exclude is given, tests that match that regular expression are
2347
excluded, regardless of whether they match --first or not.
2349
To help catch accidential dependencies between tests, the --randomize
2350
option is useful. In most cases, the argument used is the word 'now'.
2351
Note that the seed used for the random number generator is displayed
2352
when this option is used. The seed can be explicitly passed as the
2353
argument to this option if required. This enables reproduction of the
2354
actual ordering used if and when an order sensitive problem is encountered.
2356
If --list-only is given, the tests that would be run are listed. This is
2357
useful when combined with --first, --exclude and/or --randomize to
2358
understand their impact. The test harness reports "Listed nn tests in ..."
2359
instead of "Ran nn tests in ..." when list mode is enabled.
2361
If the global option '--no-plugins' is given, plugins are not loaded
2362
before running the selftests. This has two effects: features provided or
2363
modified by plugins will not be tested, and tests provided by plugins will
2368
run only tests relating to 'ignore'
2369
bzr --no-plugins selftest -v
2370
disable plugins and list tests as they're run
2372
For each test, that needs actual disk access, bzr create their own
2373
subdirectory in the temporary testing directory (testXXXX.tmp).
2374
By default the name of such subdirectory is based on the name of the test.
2375
If option '--numbered-dirs' is given, bzr will use sequent numbers
2376
of running tests to create such subdirectories. This is default behavior
2377
on Windows because of path length limitation.
2379
# NB: this is used from the class without creating an instance, which is
2380
# why it does not have a self parameter.
2381
def get_transport_type(typestring):
2382
"""Parse and return a transport specifier."""
2383
if typestring == "sftp":
2384
from bzrlib.transport.sftp import SFTPAbsoluteServer
2385
return SFTPAbsoluteServer
2386
if typestring == "memory":
2387
from bzrlib.transport.memory import MemoryServer
2389
if typestring == "fakenfs":
2390
from bzrlib.transport.fakenfs import FakeNFSServer
2391
return FakeNFSServer
2392
msg = "No known transport type %s. Supported types are: sftp\n" %\
2394
raise errors.BzrCommandError(msg)
2397
takes_args = ['testspecs*']
2398
takes_options = ['verbose',
2400
help='stop when one test fails',
2403
Option('keep-output',
2404
help='keep output directories when tests fail'),
2406
help='Use a different transport by default '
2407
'throughout the test suite.',
2408
type=get_transport_type),
2409
Option('benchmark', help='run the bzr benchmarks.'),
2410
Option('lsprof-timed',
2411
help='generate lsprof output for benchmarked'
2412
' sections of code.'),
2413
Option('cache-dir', type=str,
2414
help='a directory to cache intermediate'
2415
' benchmark steps'),
2416
Option('clean-output',
2417
help='clean temporary tests directories'
2418
' without running tests'),
2420
help='run all tests, but run specified tests first',
2423
Option('numbered-dirs',
2424
help='use numbered dirs for TestCaseInTempDir'),
2426
help='list the tests instead of running them'),
2427
Option('randomize', type=str, argname="SEED",
2428
help='randomize the order of tests using the given'
2429
' seed or "now" for the current time'),
2430
Option('exclude', type=str, argname="PATTERN",
2432
help='exclude tests that match this regular'
2435
encoding_type = 'replace'
2437
def run(self, testspecs_list=None, verbose=None, one=False,
2438
keep_output=False, transport=None, benchmark=None,
2439
lsprof_timed=None, cache_dir=None, clean_output=False,
2440
first=False, numbered_dirs=None, list_only=False,
2441
randomize=None, exclude=None):
2443
from bzrlib.tests import selftest
2444
import bzrlib.benchmarks as benchmarks
2445
from bzrlib.benchmarks import tree_creator
2448
from bzrlib.tests import clean_selftest_output
2449
clean_selftest_output()
2452
warning("notice: selftest --keep-output "
2453
"is no longer supported; "
2454
"test output is always removed")
2456
if numbered_dirs is None and sys.platform == 'win32':
2457
numbered_dirs = True
2459
if cache_dir is not None:
2460
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2461
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2462
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2464
if testspecs_list is not None:
2465
pattern = '|'.join(testspecs_list)
2469
test_suite_factory = benchmarks.test_suite
2472
# TODO: should possibly lock the history file...
2473
benchfile = open(".perf_history", "at", buffering=1)
2475
test_suite_factory = None
2480
result = selftest(verbose=verbose,
2482
stop_on_failure=one,
2483
transport=transport,
2484
test_suite_factory=test_suite_factory,
2485
lsprof_timed=lsprof_timed,
2486
bench_history=benchfile,
2487
matching_tests_first=first,
2488
numbered_dirs=numbered_dirs,
2489
list_only=list_only,
2490
random_seed=randomize,
2491
exclude_pattern=exclude
2494
if benchfile is not None:
2497
info('tests passed')
2499
info('tests failed')
2500
return int(not result)
2503
class cmd_version(Command):
2504
"""Show version of bzr."""
2508
from bzrlib.version import show_version
2512
class cmd_rocks(Command):
2513
"""Statement of optimism."""
2519
print "It sure does!"
2522
class cmd_find_merge_base(Command):
2523
"""Find and print a base revision for merging two branches."""
2524
# TODO: Options to specify revisions on either side, as if
2525
# merging only part of the history.
2526
takes_args = ['branch', 'other']
2530
def run(self, branch, other):
2531
from bzrlib.revision import ensure_null, MultipleRevisionSources
2533
branch1 = Branch.open_containing(branch)[0]
2534
branch2 = Branch.open_containing(other)[0]
2536
last1 = ensure_null(branch1.last_revision())
2537
last2 = ensure_null(branch2.last_revision())
2539
graph = branch1.repository.get_graph(branch2.repository)
2540
base_rev_id = graph.find_unique_lca(last1, last2)
2542
print 'merge base is revision %s' % base_rev_id
2545
class cmd_merge(Command):
2546
"""Perform a three-way merge.
2548
The branch is the branch you will merge from. By default, it will merge
2549
the latest revision. If you specify a revision, that revision will be
2550
merged. If you specify two revisions, the first will be used as a BASE,
2551
and the second one as OTHER. Revision numbers are always relative to the
2554
By default, bzr will try to merge in all new work from the other
2555
branch, automatically determining an appropriate base. If this
2556
fails, you may need to give an explicit base.
2558
Merge will do its best to combine the changes in two branches, but there
2559
are some kinds of problems only a human can fix. When it encounters those,
2560
it will mark a conflict. A conflict means that you need to fix something,
2561
before you should commit.
2563
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2565
If there is no default branch set, the first merge will set it. After
2566
that, you can omit the branch to use the default. To change the
2567
default, use --remember. The value will only be saved if the remote
2568
location can be accessed.
2570
The results of the merge are placed into the destination working
2571
directory, where they can be reviewed (with bzr diff), tested, and then
2572
committed to record the result of the merge.
2576
To merge the latest revision from bzr.dev:
2577
bzr merge ../bzr.dev
2579
To merge changes up to and including revision 82 from bzr.dev:
2580
bzr merge -r 82 ../bzr.dev
2582
To merge the changes introduced by 82, without previous changes:
2583
bzr merge -r 81..82 ../bzr.dev
2585
merge refuses to run if there are any uncommitted changes, unless
2589
_see_also = ['update', 'remerge', 'status-flags']
2590
takes_args = ['branch?']
2591
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2592
Option('show-base', help="Show base revision text in "
2594
Option('uncommitted', help='Apply uncommitted changes'
2595
' from a working copy, instead of branch changes'),
2596
Option('pull', help='If the destination is already'
2597
' completely merged into the source, pull from the'
2598
' source rather than merging. When this happens,'
2599
' you do not need to commit the result.'),
2601
help='Branch to merge into, '
2602
'rather than the one containing the working directory',
2608
def run(self, branch=None, revision=None, force=False, merge_type=None,
2609
show_base=False, reprocess=False, remember=False,
2610
uncommitted=False, pull=False,
2613
from bzrlib.tag import _merge_tags_if_possible
2614
other_revision_id = None
2615
if merge_type is None:
2616
merge_type = _mod_merge.Merge3Merger
2618
if directory is None: directory = u'.'
2619
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2620
# inventory. Because merge is a mutating operation, it really
2621
# should be a lock_write() for the whole cmd_merge operation.
2622
# However, cmd_merge open's its own tree in _merge_helper, which
2623
# means if we lock here, the later lock_write() will always block.
2624
# Either the merge helper code should be updated to take a tree,
2625
# (What about tree.merge_from_branch?)
2626
tree = WorkingTree.open_containing(directory)[0]
2627
change_reporter = delta._ChangeReporter(
2628
unversioned_filter=tree.is_ignored)
2630
if branch is not None:
2632
mergeable = bundle.read_mergeable_from_url(
2634
except errors.NotABundle:
2635
pass # Continue on considering this url a Branch
2637
if revision is not None:
2638
raise errors.BzrCommandError(
2639
'Cannot use -r with merge directives or bundles')
2640
other_revision_id = mergeable.install_revisions(
2641
tree.branch.repository)
2642
revision = [RevisionSpec.from_string(
2643
'revid:' + other_revision_id)]
2645
if revision is None \
2646
or len(revision) < 1 or revision[0].needs_branch():
2647
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2649
if revision is None or len(revision) < 1:
2652
other = [branch, None]
2655
other = [branch, -1]
2656
other_branch, path = Branch.open_containing(branch)
2659
raise errors.BzrCommandError('Cannot use --uncommitted and'
2660
' --revision at the same time.')
2661
branch = revision[0].get_branch() or branch
2662
if len(revision) == 1:
2664
if other_revision_id is not None:
2669
other_branch, path = Branch.open_containing(branch)
2670
revno = revision[0].in_history(other_branch).revno
2671
other = [branch, revno]
2673
assert len(revision) == 2
2674
if None in revision:
2675
raise errors.BzrCommandError(
2676
"Merge doesn't permit empty revision specifier.")
2677
base_branch, path = Branch.open_containing(branch)
2678
branch1 = revision[1].get_branch() or branch
2679
other_branch, path1 = Branch.open_containing(branch1)
2680
if revision[0].get_branch() is not None:
2681
# then path was obtained from it, and is None.
2684
base = [branch, revision[0].in_history(base_branch).revno]
2685
other = [branch1, revision[1].in_history(other_branch).revno]
2687
if ((tree.branch.get_parent() is None or remember) and
2688
other_branch is not None):
2689
tree.branch.set_parent(other_branch.base)
2691
# pull tags now... it's a bit inconsistent to do it ahead of copying
2692
# the history but that's done inside the merge code
2693
if other_branch is not None:
2694
_merge_tags_if_possible(other_branch, tree.branch)
2697
interesting_files = [path]
2699
interesting_files = None
2700
pb = ui.ui_factory.nested_progress_bar()
2703
conflict_count = _merge_helper(
2704
other, base, other_rev_id=other_revision_id,
2705
check_clean=(not force),
2706
merge_type=merge_type,
2707
reprocess=reprocess,
2708
show_base=show_base,
2711
pb=pb, file_list=interesting_files,
2712
change_reporter=change_reporter)
2715
if conflict_count != 0:
2719
except errors.AmbiguousBase, e:
2720
m = ("sorry, bzr can't determine the right merge base yet\n"
2721
"candidates are:\n "
2722
+ "\n ".join(e.bases)
2724
"please specify an explicit base with -r,\n"
2725
"and (if you want) report this to the bzr developers\n")
2728
# TODO: move up to common parent; this isn't merge-specific anymore.
2729
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2730
"""Use tree.branch's parent if none was supplied.
2732
Report if the remembered location was used.
2734
if supplied_location is not None:
2735
return supplied_location
2736
stored_location = tree.branch.get_parent()
2737
mutter("%s", stored_location)
2738
if stored_location is None:
2739
raise errors.BzrCommandError("No location specified or remembered")
2740
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2741
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2742
return stored_location
2745
class cmd_remerge(Command):
2748
Use this if you want to try a different merge technique while resolving
2749
conflicts. Some merge techniques are better than others, and remerge
2750
lets you try different ones on different files.
2752
The options for remerge have the same meaning and defaults as the ones for
2753
merge. The difference is that remerge can (only) be run when there is a
2754
pending merge, and it lets you specify particular files.
2758
$ bzr remerge --show-base
2759
Re-do the merge of all conflicted files, and show the base text in
2760
conflict regions, in addition to the usual THIS and OTHER texts.
2762
$ bzr remerge --merge-type weave --reprocess foobar
2763
Re-do the merge of "foobar", using the weave merge algorithm, with
2764
additional processing to reduce the size of conflict regions.
2766
takes_args = ['file*']
2767
takes_options = ['merge-type', 'reprocess',
2768
Option('show-base', help="Show base revision text in "
2771
def run(self, file_list=None, merge_type=None, show_base=False,
2773
if merge_type is None:
2774
merge_type = _mod_merge.Merge3Merger
2775
tree, file_list = tree_files(file_list)
2778
parents = tree.get_parent_ids()
2779
if len(parents) != 2:
2780
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2781
" merges. Not cherrypicking or"
2783
repository = tree.branch.repository
2784
graph = repository.get_graph()
2785
base_revision = graph.find_unique_lca(parents[0], parents[1])
2786
base_tree = repository.revision_tree(base_revision)
2787
other_tree = repository.revision_tree(parents[1])
2788
interesting_ids = None
2790
conflicts = tree.conflicts()
2791
if file_list is not None:
2792
interesting_ids = set()
2793
for filename in file_list:
2794
file_id = tree.path2id(filename)
2796
raise errors.NotVersionedError(filename)
2797
interesting_ids.add(file_id)
2798
if tree.kind(file_id) != "directory":
2801
for name, ie in tree.inventory.iter_entries(file_id):
2802
interesting_ids.add(ie.file_id)
2803
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2805
# Remerge only supports resolving contents conflicts
2806
allowed_conflicts = ('text conflict', 'contents conflict')
2807
restore_files = [c.path for c in conflicts
2808
if c.typestring in allowed_conflicts]
2809
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2810
tree.set_conflicts(ConflictList(new_conflicts))
2811
if file_list is not None:
2812
restore_files = file_list
2813
for filename in restore_files:
2815
restore(tree.abspath(filename))
2816
except errors.NotConflicted:
2818
conflicts = _mod_merge.merge_inner(
2819
tree.branch, other_tree, base_tree,
2821
interesting_ids=interesting_ids,
2822
other_rev_id=parents[1],
2823
merge_type=merge_type,
2824
show_base=show_base,
2825
reprocess=reprocess)
2834
class cmd_revert(Command):
2835
"""Revert files to a previous revision.
2837
Giving a list of files will revert only those files. Otherwise, all files
2838
will be reverted. If the revision is not specified with '--revision', the
2839
last committed revision is used.
2841
To remove only some changes, without reverting to a prior version, use
2842
merge instead. For example, "merge . --r-2..-3" will remove the changes
2843
introduced by -2, without affecting the changes introduced by -1. Or
2844
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2846
By default, any files that have been manually changed will be backed up
2847
first. (Files changed only by merge are not backed up.) Backup files have
2848
'.~#~' appended to their name, where # is a number.
2850
When you provide files, you can use their current pathname or the pathname
2851
from the target revision. So you can use revert to "undelete" a file by
2852
name. If you name a directory, all the contents of that directory will be
2856
_see_also = ['cat', 'export']
2857
takes_options = ['revision', 'no-backup']
2858
takes_args = ['file*']
2860
def run(self, revision=None, no_backup=False, file_list=None):
2861
if file_list is not None:
2862
if len(file_list) == 0:
2863
raise errors.BzrCommandError("No files specified")
2867
tree, file_list = tree_files(file_list)
2868
if revision is None:
2869
# FIXME should be tree.last_revision
2870
rev_id = tree.last_revision()
2871
elif len(revision) != 1:
2872
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2874
rev_id = revision[0].in_history(tree.branch).rev_id
2875
pb = ui.ui_factory.nested_progress_bar()
2877
tree.revert(file_list,
2878
tree.branch.repository.revision_tree(rev_id),
2879
not no_backup, pb, report_changes=True)
2884
class cmd_assert_fail(Command):
2885
"""Test reporting of assertion failures"""
2886
# intended just for use in testing
2891
raise AssertionError("always fails")
2894
class cmd_help(Command):
2895
"""Show help on a command or other topic.
2898
_see_also = ['topics']
2899
takes_options = [Option('long', 'show help on all commands')]
2900
takes_args = ['topic?']
2901
aliases = ['?', '--help', '-?', '-h']
2904
def run(self, topic=None, long=False):
2906
if topic is None and long:
2908
bzrlib.help.help(topic)
2911
class cmd_shell_complete(Command):
2912
"""Show appropriate completions for context.
2914
For a list of all available commands, say 'bzr shell-complete'.
2916
takes_args = ['context?']
2921
def run(self, context=None):
2922
import shellcomplete
2923
shellcomplete.shellcomplete(context)
2926
class cmd_fetch(Command):
2927
"""Copy in history from another branch but don't merge it.
2929
This is an internal method used for pull and merge.
2932
takes_args = ['from_branch', 'to_branch']
2933
def run(self, from_branch, to_branch):
2934
from bzrlib.fetch import Fetcher
2935
from_b = Branch.open(from_branch)
2936
to_b = Branch.open(to_branch)
2937
Fetcher(to_b, from_b)
2940
class cmd_missing(Command):
2941
"""Show unmerged/unpulled revisions between two branches.
2943
OTHER_BRANCH may be local or remote.
2946
_see_also = ['merge', 'pull']
2947
takes_args = ['other_branch?']
2948
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2950
'Display changes in the local branch only'),
2951
Option('this' , 'same as --mine-only'),
2952
Option('theirs-only',
2953
'Display changes in the remote branch only'),
2954
Option('other', 'same as --theirs-only'),
2959
encoding_type = 'replace'
2962
def run(self, other_branch=None, reverse=False, mine_only=False,
2963
theirs_only=False, log_format=None, long=False, short=False, line=False,
2964
show_ids=False, verbose=False, this=False, other=False):
2965
from bzrlib.missing import find_unmerged, iter_log_revisions
2966
from bzrlib.log import log_formatter
2973
local_branch = Branch.open_containing(u".")[0]
2974
parent = local_branch.get_parent()
2975
if other_branch is None:
2976
other_branch = parent
2977
if other_branch is None:
2978
raise errors.BzrCommandError("No peer location known or specified.")
2979
display_url = urlutils.unescape_for_display(parent,
2981
print "Using last location: " + display_url
2983
remote_branch = Branch.open(other_branch)
2984
if remote_branch.base == local_branch.base:
2985
remote_branch = local_branch
2986
local_branch.lock_read()
2988
remote_branch.lock_read()
2990
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2991
if (log_format is None):
2992
log_format = log.log_formatter_registry.get_default(
2994
lf = log_format(to_file=self.outf,
2996
show_timezone='original')
2997
if reverse is False:
2998
local_extra.reverse()
2999
remote_extra.reverse()
3000
if local_extra and not theirs_only:
3001
print "You have %d extra revision(s):" % len(local_extra)
3002
for revision in iter_log_revisions(local_extra,
3003
local_branch.repository,
3005
lf.log_revision(revision)
3006
printed_local = True
3008
printed_local = False
3009
if remote_extra and not mine_only:
3010
if printed_local is True:
3012
print "You are missing %d revision(s):" % len(remote_extra)
3013
for revision in iter_log_revisions(remote_extra,
3014
remote_branch.repository,
3016
lf.log_revision(revision)
3017
if not remote_extra and not local_extra:
3019
print "Branches are up to date."
3023
remote_branch.unlock()
3025
local_branch.unlock()
3026
if not status_code and parent is None and other_branch is not None:
3027
local_branch.lock_write()
3029
# handle race conditions - a parent might be set while we run.
3030
if local_branch.get_parent() is None:
3031
local_branch.set_parent(remote_branch.base)
3033
local_branch.unlock()
3037
class cmd_plugins(Command):
3042
import bzrlib.plugin
3043
from inspect import getdoc
3044
for name, plugin in bzrlib.plugin.all_plugins().items():
3045
if getattr(plugin, '__path__', None) is not None:
3046
print plugin.__path__[0]
3047
elif getattr(plugin, '__file__', None) is not None:
3048
print plugin.__file__
3054
print '\t', d.split('\n')[0]
3057
class cmd_testament(Command):
3058
"""Show testament (signing-form) of a revision."""
3059
takes_options = ['revision',
3060
Option('long', help='Produce long-format testament'),
3061
Option('strict', help='Produce a strict-format'
3063
takes_args = ['branch?']
3065
def run(self, branch=u'.', revision=None, long=False, strict=False):
3066
from bzrlib.testament import Testament, StrictTestament
3068
testament_class = StrictTestament
3070
testament_class = Testament
3071
b = WorkingTree.open_containing(branch)[0].branch
3074
if revision is None:
3075
rev_id = b.last_revision()
3077
rev_id = revision[0].in_history(b).rev_id
3078
t = testament_class.from_revision(b.repository, rev_id)
3080
sys.stdout.writelines(t.as_text_lines())
3082
sys.stdout.write(t.as_short_text())
3087
class cmd_annotate(Command):
3088
"""Show the origin of each line in a file.
3090
This prints out the given file with an annotation on the left side
3091
indicating which revision, author and date introduced the change.
3093
If the origin is the same for a run of consecutive lines, it is
3094
shown only at the top, unless the --all option is given.
3096
# TODO: annotate directories; showing when each file was last changed
3097
# TODO: if the working copy is modified, show annotations on that
3098
# with new uncommitted lines marked
3099
aliases = ['ann', 'blame', 'praise']
3100
takes_args = ['filename']
3101
takes_options = [Option('all', help='show annotations on all lines'),
3102
Option('long', help='show date in annotations'),
3106
encoding_type = 'exact'
3109
def run(self, filename, all=False, long=False, revision=None,
3111
from bzrlib.annotate import annotate_file
3112
tree, relpath = WorkingTree.open_containing(filename)
3113
branch = tree.branch
3116
if revision is None:
3117
revision_id = branch.last_revision()
3118
elif len(revision) != 1:
3119
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3121
revision_id = revision[0].in_history(branch).rev_id
3122
file_id = tree.path2id(relpath)
3124
raise errors.NotVersionedError(filename)
3125
tree = branch.repository.revision_tree(revision_id)
3126
file_version = tree.inventory[file_id].revision
3127
annotate_file(branch, file_version, file_id, long, all, self.outf,
3133
class cmd_re_sign(Command):
3134
"""Create a digital signature for an existing revision."""
3135
# TODO be able to replace existing ones.
3137
hidden = True # is this right ?
3138
takes_args = ['revision_id*']
3139
takes_options = ['revision']
3141
def run(self, revision_id_list=None, revision=None):
3142
import bzrlib.gpg as gpg
3143
if revision_id_list is not None and revision is not None:
3144
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3145
if revision_id_list is None and revision is None:
3146
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3147
b = WorkingTree.open_containing(u'.')[0].branch
3148
gpg_strategy = gpg.GPGStrategy(b.get_config())
3149
if revision_id_list is not None:
3150
for revision_id in revision_id_list:
3151
b.repository.sign_revision(revision_id, gpg_strategy)
3152
elif revision is not None:
3153
if len(revision) == 1:
3154
revno, rev_id = revision[0].in_history(b)
3155
b.repository.sign_revision(rev_id, gpg_strategy)
3156
elif len(revision) == 2:
3157
# are they both on rh- if so we can walk between them
3158
# might be nice to have a range helper for arbitrary
3159
# revision paths. hmm.
3160
from_revno, from_revid = revision[0].in_history(b)
3161
to_revno, to_revid = revision[1].in_history(b)
3162
if to_revid is None:
3163
to_revno = b.revno()
3164
if from_revno is None or to_revno is None:
3165
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3166
for revno in range(from_revno, to_revno + 1):
3167
b.repository.sign_revision(b.get_rev_id(revno),
3170
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3173
class cmd_bind(Command):
3174
"""Convert the current branch into a checkout of the supplied branch.
3176
Once converted into a checkout, commits must succeed on the master branch
3177
before they will be applied to the local branch.
3180
_see_also = ['checkouts', 'unbind']
3181
takes_args = ['location?']
3184
def run(self, location=None):
3185
b, relpath = Branch.open_containing(u'.')
3186
if location is None:
3188
location = b.get_old_bound_location()
3189
except errors.UpgradeRequired:
3190
raise errors.BzrCommandError('No location supplied. '
3191
'This format does not remember old locations.')
3193
if location is None:
3194
raise errors.BzrCommandError('No location supplied and no '
3195
'previous location known')
3196
b_other = Branch.open(location)
3199
except errors.DivergedBranches:
3200
raise errors.BzrCommandError('These branches have diverged.'
3201
' Try merging, and then bind again.')
3204
class cmd_unbind(Command):
3205
"""Convert the current checkout into a regular branch.
3207
After unbinding, the local branch is considered independent and subsequent
3208
commits will be local only.
3211
_see_also = ['checkouts', 'bind']
3216
b, relpath = Branch.open_containing(u'.')
3218
raise errors.BzrCommandError('Local branch is not bound')
3221
class cmd_uncommit(Command):
3222
"""Remove the last committed revision.
3224
--verbose will print out what is being removed.
3225
--dry-run will go through all the motions, but not actually
3228
In the future, uncommit will create a revision bundle, which can then
3232
# TODO: jam 20060108 Add an option to allow uncommit to remove
3233
# unreferenced information in 'branch-as-repository' branches.
3234
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3235
# information in shared branches as well.
3236
_see_also = ['commit']
3237
takes_options = ['verbose', 'revision',
3238
Option('dry-run', help='Don\'t actually make changes'),
3239
Option('force', help='Say yes to all questions.')]
3240
takes_args = ['location?']
3243
def run(self, location=None,
3244
dry_run=False, verbose=False,
3245
revision=None, force=False):
3246
from bzrlib.log import log_formatter, show_log
3248
from bzrlib.uncommit import uncommit
3250
if location is None:
3252
control, relpath = bzrdir.BzrDir.open_containing(location)
3254
tree = control.open_workingtree()
3256
except (errors.NoWorkingTree, errors.NotLocalUrl):
3258
b = control.open_branch()
3261
if revision is None:
3264
# 'bzr uncommit -r 10' actually means uncommit
3265
# so that the final tree is at revno 10.
3266
# but bzrlib.uncommit.uncommit() actually uncommits
3267
# the revisions that are supplied.
3268
# So we need to offset it by one
3269
revno = revision[0].in_history(b).revno+1
3271
if revno <= b.revno():
3272
rev_id = b.get_rev_id(revno)
3274
self.outf.write('No revisions to uncommit.\n')
3277
lf = log_formatter('short',
3279
show_timezone='original')
3284
direction='forward',
3285
start_revision=revno,
3286
end_revision=b.revno())
3289
print 'Dry-run, pretending to remove the above revisions.'
3291
val = raw_input('Press <enter> to continue')
3293
print 'The above revision(s) will be removed.'
3295
val = raw_input('Are you sure [y/N]? ')
3296
if val.lower() not in ('y', 'yes'):
3300
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3304
class cmd_break_lock(Command):
3305
"""Break a dead lock on a repository, branch or working directory.
3307
CAUTION: Locks should only be broken when you are sure that the process
3308
holding the lock has been stopped.
3310
You can get information on what locks are open via the 'bzr info' command.
3315
takes_args = ['location?']
3317
def run(self, location=None, show=False):
3318
if location is None:
3320
control, relpath = bzrdir.BzrDir.open_containing(location)
3322
control.break_lock()
3323
except NotImplementedError:
3327
class cmd_wait_until_signalled(Command):
3328
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3330
This just prints a line to signal when it is ready, then blocks on stdin.
3336
sys.stdout.write("running\n")
3338
sys.stdin.readline()
3341
class cmd_serve(Command):
3342
"""Run the bzr server."""
3344
aliases = ['server']
3348
help='serve on stdin/out for use from inetd or sshd'),
3350
help='listen for connections on nominated port of the form '
3351
'[hostname:]portnumber. Passing 0 as the port number will '
3352
'result in a dynamically allocated port. Default port is '
3356
help='serve contents of directory',
3358
Option('allow-writes',
3359
help='By default the server is a readonly server. Supplying '
3360
'--allow-writes enables write access to the contents of '
3361
'the served directory and below. '
3365
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3366
from bzrlib.smart import medium, server
3367
from bzrlib.transport import get_transport
3368
from bzrlib.transport.chroot import ChrootServer
3369
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3370
if directory is None:
3371
directory = os.getcwd()
3372
url = urlutils.local_path_to_url(directory)
3373
if not allow_writes:
3374
url = 'readonly+' + url
3375
chroot_server = ChrootServer(get_transport(url))
3376
chroot_server.setUp()
3377
t = get_transport(chroot_server.get_url())
3379
smart_server = medium.SmartServerPipeStreamMedium(
3380
sys.stdin, sys.stdout, t)
3382
host = BZR_DEFAULT_INTERFACE
3384
port = BZR_DEFAULT_PORT
3387
host, port = port.split(':')
3389
smart_server = server.SmartTCPServer(t, host=host, port=port)
3390
print 'listening on port: ', smart_server.port
3392
# for the duration of this server, no UI output is permitted.
3393
# note that this may cause problems with blackbox tests. This should
3394
# be changed with care though, as we dont want to use bandwidth sending
3395
# progress over stderr to smart server clients!
3396
old_factory = ui.ui_factory
3398
ui.ui_factory = ui.SilentUIFactory()
3399
smart_server.serve()
3401
ui.ui_factory = old_factory
3404
class cmd_join(Command):
3405
"""Combine a subtree into its containing tree.
3407
This command is for experimental use only. It requires the target tree
3408
to be in dirstate-with-subtree format, which cannot be converted into
3411
The TREE argument should be an independent tree, inside another tree, but
3412
not part of it. (Such trees can be produced by "bzr split", but also by
3413
running "bzr branch" with the target inside a tree.)
3415
The result is a combined tree, with the subtree no longer an independant
3416
part. This is marked as a merge of the subtree into the containing tree,
3417
and all history is preserved.
3419
If --reference is specified, the subtree retains its independence. It can
3420
be branched by itself, and can be part of multiple projects at the same
3421
time. But operations performed in the containing tree, such as commit
3422
and merge, will recurse into the subtree.
3425
_see_also = ['split']
3426
takes_args = ['tree']
3427
takes_options = [Option('reference', 'join by reference')]
3430
def run(self, tree, reference=False):
3431
sub_tree = WorkingTree.open(tree)
3432
parent_dir = osutils.dirname(sub_tree.basedir)
3433
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3434
repo = containing_tree.branch.repository
3435
if not repo.supports_rich_root():
3436
raise errors.BzrCommandError(
3437
"Can't join trees because %s doesn't support rich root data.\n"
3438
"You can use bzr upgrade on the repository."
3442
containing_tree.add_reference(sub_tree)
3443
except errors.BadReferenceTarget, e:
3444
# XXX: Would be better to just raise a nicely printable
3445
# exception from the real origin. Also below. mbp 20070306
3446
raise errors.BzrCommandError("Cannot join %s. %s" %
3450
containing_tree.subsume(sub_tree)
3451
except errors.BadSubsumeSource, e:
3452
raise errors.BzrCommandError("Cannot join %s. %s" %
3456
class cmd_split(Command):
3457
"""Split a tree into two trees.
3459
This command is for experimental use only. It requires the target tree
3460
to be in dirstate-with-subtree format, which cannot be converted into
3463
The TREE argument should be a subdirectory of a working tree. That
3464
subdirectory will be converted into an independent tree, with its own
3465
branch. Commits in the top-level tree will not apply to the new subtree.
3466
If you want that behavior, do "bzr join --reference TREE".
3469
_see_also = ['join']
3470
takes_args = ['tree']
3474
def run(self, tree):
3475
containing_tree, subdir = WorkingTree.open_containing(tree)
3476
sub_id = containing_tree.path2id(subdir)
3478
raise errors.NotVersionedError(subdir)
3480
containing_tree.extract(sub_id)
3481
except errors.RootNotRich:
3482
raise errors.UpgradeRequired(containing_tree.branch.base)
3486
class cmd_merge_directive(Command):
3487
"""Generate a merge directive for auto-merge tools.
3489
A directive requests a merge to be performed, and also provides all the
3490
information necessary to do so. This means it must either include a
3491
revision bundle, or the location of a branch containing the desired
3494
A submit branch (the location to merge into) must be supplied the first
3495
time the command is issued. After it has been supplied once, it will
3496
be remembered as the default.
3498
A public branch is optional if a revision bundle is supplied, but required
3499
if --diff or --plain is specified. It will be remembered as the default
3500
after the first use.
3503
takes_args = ['submit_branch?', 'public_branch?']
3506
RegistryOption.from_kwargs('patch-type',
3507
'The type of patch to include in the directive',
3508
title='Patch type', value_switches=True, enum_switch=False,
3509
bundle='Bazaar revision bundle (default)',
3510
diff='Normal unified diff',
3511
plain='No patch, just directive'),
3512
Option('sign', help='GPG-sign the directive'), 'revision',
3513
Option('mail-to', type=str,
3514
help='Instead of printing the directive, email to this address'),
3515
Option('message', type=str, short_name='m',
3516
help='Message to use when committing this merge')
3519
encoding_type = 'exact'
3521
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3522
sign=False, revision=None, mail_to=None, message=None):
3523
from bzrlib.revision import ensure_null, NULL_REVISION
3524
if patch_type == 'plain':
3526
branch = Branch.open('.')
3527
stored_submit_branch = branch.get_submit_branch()
3528
if submit_branch is None:
3529
submit_branch = stored_submit_branch
3531
if stored_submit_branch is None:
3532
branch.set_submit_branch(submit_branch)
3533
if submit_branch is None:
3534
submit_branch = branch.get_parent()
3535
if submit_branch is None:
3536
raise errors.BzrCommandError('No submit branch specified or known')
3538
stored_public_branch = branch.get_public_branch()
3539
if public_branch is None:
3540
public_branch = stored_public_branch
3541
elif stored_public_branch is None:
3542
branch.set_public_branch(public_branch)
3543
if patch_type != "bundle" and public_branch is None:
3544
raise errors.BzrCommandError('No public branch specified or'
3546
if revision is not None:
3547
if len(revision) != 1:
3548
raise errors.BzrCommandError('bzr merge-directive takes '
3549
'exactly one revision identifier')
3551
revision_id = revision[0].in_history(branch).rev_id
3553
revision_id = branch.last_revision()
3554
revision_id = ensure_null(revision_id)
3555
if revision_id == NULL_REVISION:
3556
raise errors.BzrCommandError('No revisions to bundle.')
3557
directive = merge_directive.MergeDirective.from_objects(
3558
branch.repository, revision_id, time.time(),
3559
osutils.local_time_offset(), submit_branch,
3560
public_branch=public_branch, patch_type=patch_type,
3564
self.outf.write(directive.to_signed(branch))
3566
self.outf.writelines(directive.to_lines())
3568
message = directive.to_email(mail_to, branch, sign)
3569
s = SMTPConnection(branch.get_config())
3570
s.send_email(message)
3573
class cmd_tag(Command):
3574
"""Create a tag naming a revision.
3576
Tags give human-meaningful names to revisions. Commands that take a -r
3577
(--revision) option can be given -rtag:X, where X is any previously
3580
Tags are stored in the branch. Tags are copied from one branch to another
3581
along when you branch, push, pull or merge.
3583
It is an error to give a tag name that already exists unless you pass
3584
--force, in which case the tag is moved to point to the new revision.
3587
_see_also = ['commit', 'tags']
3588
takes_args = ['tag_name']
3591
help='Delete this tag rather than placing it.',
3594
help='Branch in which to place the tag.',
3599
help='Replace existing tags',
3604
def run(self, tag_name,
3610
branch, relpath = Branch.open_containing(directory)
3614
branch.tags.delete_tag(tag_name)
3615
self.outf.write('Deleted tag %s.\n' % tag_name)
3618
if len(revision) != 1:
3619
raise errors.BzrCommandError(
3620
"Tags can only be placed on a single revision, "
3622
revision_id = revision[0].in_history(branch).rev_id
3624
revision_id = branch.last_revision()
3625
if (not force) and branch.tags.has_tag(tag_name):
3626
raise errors.TagAlreadyExists(tag_name)
3627
branch.tags.set_tag(tag_name, revision_id)
3628
self.outf.write('Created tag %s.\n' % tag_name)
3633
class cmd_tags(Command):
3636
This tag shows a table of tag names and the revisions they reference.
3642
help='Branch whose tags should be displayed',
3652
branch, relpath = Branch.open_containing(directory)
3653
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3654
self.outf.write('%-20s %s\n' % (tag_name, target))
3657
# command-line interpretation helper for merge-related commands
3658
def _merge_helper(other_revision, base_revision,
3659
check_clean=True, ignore_zero=False,
3660
this_dir=None, backup_files=False,
3662
file_list=None, show_base=False, reprocess=False,
3665
change_reporter=None,
3667
"""Merge changes into a tree.
3670
list(path, revno) Base for three-way merge.
3671
If [None, None] then a base will be automatically determined.
3673
list(path, revno) Other revision for three-way merge.
3675
Directory to merge changes into; '.' by default.
3677
If true, this_dir must have no uncommitted changes before the
3679
ignore_zero - If true, suppress the "zero conflicts" message when
3680
there are no conflicts; should be set when doing something we expect
3681
to complete perfectly.
3682
file_list - If supplied, merge only changes to selected files.
3684
All available ancestors of other_revision and base_revision are
3685
automatically pulled into the branch.
3687
The revno may be -1 to indicate the last revision on the branch, which is
3690
This function is intended for use from the command line; programmatic
3691
clients might prefer to call merge.merge_inner(), which has less magic
3694
# Loading it late, so that we don't always have to import bzrlib.merge
3695
if merge_type is None:
3696
merge_type = _mod_merge.Merge3Merger
3697
if this_dir is None:
3699
this_tree = WorkingTree.open_containing(this_dir)[0]
3700
if show_base and not merge_type is _mod_merge.Merge3Merger:
3701
raise errors.BzrCommandError("Show-base is not supported for this merge"
3702
" type. %s" % merge_type)
3703
if reprocess and not merge_type.supports_reprocess:
3704
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3705
" type %s." % merge_type)
3706
if reprocess and show_base:
3707
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3708
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3709
# only want to take out a lock_tree_write() if we don't have to pull
3710
# any ancestry. But merge might fetch ancestry in the middle, in
3711
# which case we would need a lock_write().
3712
# Because we cannot upgrade locks, for now we live with the fact that
3713
# the tree will be locked multiple times during a merge. (Maybe
3714
# read-only some of the time, but it means things will get read
3717
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3718
pb=pb, change_reporter=change_reporter)
3719
merger.pp = ProgressPhase("Merge phase", 5, pb)
3720
merger.pp.next_phase()
3721
merger.check_basis(check_clean)
3722
if other_rev_id is not None:
3723
merger.set_other_revision(other_rev_id, this_tree.branch)
3725
merger.set_other(other_revision)
3726
merger.pp.next_phase()
3727
merger.set_base(base_revision)
3728
if merger.base_rev_id == merger.other_rev_id:
3729
note('Nothing to do.')
3731
if file_list is None:
3732
if pull and merger.base_rev_id == merger.this_rev_id:
3733
# FIXME: deduplicate with pull
3734
result = merger.this_tree.pull(merger.this_branch,
3735
False, merger.other_rev_id)
3736
if result.old_revid == result.new_revid:
3737
note('No revisions to pull.')
3739
note('Now on revision %d.' % result.new_revno)
3741
merger.backup_files = backup_files
3742
merger.merge_type = merge_type
3743
merger.set_interesting_files(file_list)
3744
merger.show_base = show_base
3745
merger.reprocess = reprocess
3746
conflicts = merger.do_merge()
3747
if file_list is None:
3748
merger.set_pending()
3754
def _create_prefix(cur_transport):
3755
needed = [cur_transport]
3756
# Recurse upwards until we can create a directory successfully
3758
new_transport = cur_transport.clone('..')
3759
if new_transport.base == cur_transport.base:
3760
raise errors.BzrCommandError("Failed to create path"
3764
new_transport.mkdir('.')
3765
except errors.NoSuchFile:
3766
needed.append(new_transport)
3767
cur_transport = new_transport
3771
# Now we only need to create child directories
3773
cur_transport = needed.pop()
3774
cur_transport.ensure_base()
3777
merge = _merge_helper
3780
# these get imported and then picked up by the scan for cmd_*
3781
# TODO: Some more consistent way to split command definitions across files;
3782
# we do need to load at least some information about them to know of
3783
# aliases. ideally we would avoid loading the implementation until the
3784
# details were needed.
3785
from bzrlib.cmd_version_info import cmd_version_info
3786
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3787
from bzrlib.bundle.commands import cmd_bundle_revisions
3788
from bzrlib.sign_my_commits import cmd_sign_my_commits
3789
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
3790
cmd_weave_plan_merge, cmd_weave_merge_text