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*']
344
help="Don't recursively add the contents of directories."),
346
help="Show what would be done, but don't actually do anything."),
348
Option('file-ids-from',
350
help='Lookup file ids from this tree.'),
352
encoding_type = 'replace'
353
_see_also = ['remove']
355
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
360
if file_ids_from is not None:
362
base_tree, base_path = WorkingTree.open_containing(
364
except errors.NoWorkingTree:
365
base_branch, base_path = Branch.open_containing(
367
base_tree = base_branch.basis_tree()
369
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
370
to_file=self.outf, should_print=(not is_quiet()))
372
action = bzrlib.add.AddAction(to_file=self.outf,
373
should_print=(not is_quiet()))
376
base_tree.lock_read()
378
file_list = self._maybe_expand_globs(file_list)
380
tree = WorkingTree.open_containing(file_list[0])[0]
382
tree = WorkingTree.open_containing(u'.')[0]
383
added, ignored = tree.smart_add(file_list, not
384
no_recurse, action=action, save=not dry_run)
386
if base_tree is not None:
390
for glob in sorted(ignored.keys()):
391
for path in ignored[glob]:
392
self.outf.write("ignored %s matching \"%s\"\n"
396
for glob, paths in ignored.items():
397
match_len += len(paths)
398
self.outf.write("ignored %d file(s).\n" % match_len)
399
self.outf.write("If you wish to add some of these files,"
400
" please add them by name.\n")
403
class cmd_mkdir(Command):
404
"""Create a new versioned directory.
406
This is equivalent to creating the directory and then adding it.
409
takes_args = ['dir+']
410
encoding_type = 'replace'
412
def run(self, dir_list):
415
wt, dd = WorkingTree.open_containing(d)
417
self.outf.write('added %s\n' % d)
420
class cmd_relpath(Command):
421
"""Show path of a file relative to root"""
423
takes_args = ['filename']
427
def run(self, filename):
428
# TODO: jam 20050106 Can relpath return a munged path if
429
# sys.stdout encoding cannot represent it?
430
tree, relpath = WorkingTree.open_containing(filename)
431
self.outf.write(relpath)
432
self.outf.write('\n')
435
class cmd_inventory(Command):
436
"""Show inventory of the current working copy or a revision.
438
It is possible to limit the output to a particular entry
439
type using the --kind option. For example: --kind file.
441
It is also possible to restrict the list of files to a specific
442
set. For example: bzr inventory --show-ids this/file
451
help='List entries of a particular kind: file, directory, symlink.',
454
takes_args = ['file*']
457
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
458
if kind and kind not in ['file', 'directory', 'symlink']:
459
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
461
work_tree, file_list = tree_files(file_list)
462
work_tree.lock_read()
464
if revision is not None:
465
if len(revision) > 1:
466
raise errors.BzrCommandError(
467
'bzr inventory --revision takes exactly one revision'
469
revision_id = revision[0].in_history(work_tree.branch).rev_id
470
tree = work_tree.branch.repository.revision_tree(revision_id)
472
extra_trees = [work_tree]
478
if file_list is not None:
479
file_ids = tree.paths2ids(file_list, trees=extra_trees,
480
require_versioned=True)
481
# find_ids_across_trees may include some paths that don't
483
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
484
for file_id in file_ids if file_id in tree)
486
entries = tree.inventory.entries()
489
if tree is not work_tree:
492
for path, entry in entries:
493
if kind and kind != entry.kind:
496
self.outf.write('%-50s %s\n' % (path, entry.file_id))
498
self.outf.write(path)
499
self.outf.write('\n')
502
class cmd_mv(Command):
503
"""Move or rename a file.
506
bzr mv OLDNAME NEWNAME
507
bzr mv SOURCE... DESTINATION
509
If the last argument is a versioned directory, all the other names
510
are moved into it. Otherwise, there must be exactly two arguments
511
and the file is changed to a new name.
513
If OLDNAME does not exist on the filesystem but is versioned and
514
NEWNAME does exist on the filesystem but is not versioned, mv
515
assumes that the file has been manually moved and only updates
516
its internal inventory to reflect that change.
517
The same is valid when moving many SOURCE files to a DESTINATION.
519
Files cannot be moved between branches.
522
takes_args = ['names*']
523
takes_options = [Option("after", help="Move only the bzr identifier"
524
" of the file, because the file has already been moved."),
526
aliases = ['move', 'rename']
527
encoding_type = 'replace'
529
def run(self, names_list, after=False):
530
if names_list is None:
533
if len(names_list) < 2:
534
raise errors.BzrCommandError("missing file argument")
535
tree, rel_names = tree_files(names_list)
537
if os.path.isdir(names_list[-1]):
538
# move into existing directory
539
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
540
self.outf.write("%s => %s\n" % pair)
542
if len(names_list) != 2:
543
raise errors.BzrCommandError('to mv multiple files the'
544
' destination must be a versioned'
546
tree.rename_one(rel_names[0], rel_names[1], after=after)
547
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
550
class cmd_pull(Command):
551
"""Turn this branch into a mirror of another branch.
553
This command only works on branches that have not diverged. Branches are
554
considered diverged if the destination branch's most recent commit is one
555
that has not been merged (directly or indirectly) into the parent.
557
If branches have diverged, you can use 'bzr merge' to integrate the changes
558
from one into the other. Once one branch has merged, the other should
559
be able to pull it again.
561
If you want to forget your local changes and just update your branch to
562
match the remote one, use pull --overwrite.
564
If there is no default location set, the first pull will set it. After
565
that, you can omit the location to use the default. To change the
566
default, use --remember. The value will only be saved if the remote
567
location can be accessed.
570
_see_also = ['push', 'update', 'status-flags']
571
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
573
help='Branch to pull into, '
574
'rather than the one containing the working directory.',
579
takes_args = ['location?']
580
encoding_type = 'replace'
582
def run(self, location=None, remember=False, overwrite=False,
583
revision=None, verbose=False,
585
from bzrlib.tag import _merge_tags_if_possible
586
# FIXME: too much stuff is in the command class
589
if directory is None:
592
tree_to = WorkingTree.open_containing(directory)[0]
593
branch_to = tree_to.branch
594
except errors.NoWorkingTree:
596
branch_to = Branch.open_containing(directory)[0]
599
if location is not None:
601
mergeable = bundle.read_mergeable_from_url(
603
except errors.NotABundle:
604
pass # Continue on considering this url a Branch
606
stored_loc = branch_to.get_parent()
608
if stored_loc is None:
609
raise errors.BzrCommandError("No pull location known or"
612
display_url = urlutils.unescape_for_display(stored_loc,
614
self.outf.write("Using saved location: %s\n" % display_url)
615
location = stored_loc
617
if mergeable is not None:
618
if revision is not None:
619
raise errors.BzrCommandError(
620
'Cannot use -r with merge directives or bundles')
621
revision_id = mergeable.install_revisions(branch_to.repository)
622
branch_from = branch_to
624
branch_from = Branch.open(location)
626
if branch_to.get_parent() is None or remember:
627
branch_to.set_parent(branch_from.base)
629
if revision is not None:
630
if len(revision) == 1:
631
revision_id = revision[0].in_history(branch_from).rev_id
633
raise errors.BzrCommandError(
634
'bzr pull --revision takes one value.')
636
old_rh = branch_to.revision_history()
637
if tree_to is not None:
638
result = tree_to.pull(branch_from, overwrite, revision_id,
639
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
641
result = branch_to.pull(branch_from, overwrite, revision_id)
643
result.report(self.outf)
645
from bzrlib.log import show_changed_revisions
646
new_rh = branch_to.revision_history()
647
show_changed_revisions(branch_to, old_rh, new_rh,
651
class cmd_push(Command):
652
"""Update a mirror of this branch.
654
The target branch will not have its working tree populated because this
655
is both expensive, and is not supported on remote file systems.
657
Some smart servers or protocols *may* put the working tree in place in
660
This command only works on branches that have not diverged. Branches are
661
considered diverged if the destination branch's most recent commit is one
662
that has not been merged (directly or indirectly) by the source branch.
664
If branches have diverged, you can use 'bzr push --overwrite' to replace
665
the other branch completely, discarding its unmerged changes.
667
If you want to ensure you have the different changes in the other branch,
668
do a merge (see bzr help merge) from the other branch, and commit that.
669
After that you will be able to do a push without '--overwrite'.
671
If there is no default push location set, the first push will set it.
672
After that, you can omit the location to use the default. To change the
673
default, use --remember. The value will only be saved if the remote
674
location can be accessed.
677
_see_also = ['pull', 'update', 'working-trees']
678
takes_options = ['remember', 'overwrite', 'verbose',
679
Option('create-prefix',
680
help='Create the path leading up to the branch '
681
'if it does not already exist.'),
683
help='Branch to push from, '
684
'rather than the one containing the working directory.',
688
Option('use-existing-dir',
689
help='By default push will fail if the target'
690
' directory exists, but does not already'
691
' have a control directory. This flag will'
692
' allow push to proceed.'),
694
takes_args = ['location?']
695
encoding_type = 'replace'
697
def run(self, location=None, remember=False, overwrite=False,
698
create_prefix=False, verbose=False,
699
use_existing_dir=False,
701
# FIXME: Way too big! Put this into a function called from the
703
if directory is None:
705
br_from = Branch.open_containing(directory)[0]
706
stored_loc = br_from.get_push_location()
708
if stored_loc is None:
709
raise errors.BzrCommandError("No push location known or specified.")
711
display_url = urlutils.unescape_for_display(stored_loc,
713
self.outf.write("Using saved location: %s\n" % display_url)
714
location = stored_loc
716
to_transport = transport.get_transport(location)
718
br_to = repository_to = dir_to = None
720
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
721
except errors.NotBranchError:
722
pass # Didn't find anything
724
# If we can open a branch, use its direct repository, otherwise see
725
# if there is a repository without a branch.
727
br_to = dir_to.open_branch()
728
except errors.NotBranchError:
729
# Didn't find a branch, can we find a repository?
731
repository_to = dir_to.find_repository()
732
except errors.NoRepositoryPresent:
735
# Found a branch, so we must have found a repository
736
repository_to = br_to.repository
740
# The destination doesn't exist; create it.
741
# XXX: Refactor the create_prefix/no_create_prefix code into a
742
# common helper function
744
to_transport.mkdir('.')
745
except errors.FileExists:
746
if not use_existing_dir:
747
raise errors.BzrCommandError("Target directory %s"
748
" already exists, but does not have a valid .bzr"
749
" directory. Supply --use-existing-dir to push"
750
" there anyway." % location)
751
except errors.NoSuchFile:
752
if not create_prefix:
753
raise errors.BzrCommandError("Parent directory of %s"
755
"\nYou may supply --create-prefix to create all"
756
" leading parent directories."
759
_create_prefix(to_transport)
761
# Now the target directory exists, but doesn't have a .bzr
762
# directory. So we need to create it, along with any work to create
763
# all of the dependent branches, etc.
764
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
765
revision_id=br_from.last_revision())
766
br_to = dir_to.open_branch()
767
# TODO: Some more useful message about what was copied
768
note('Created new branch.')
769
# We successfully created the target, remember it
770
if br_from.get_push_location() is None or remember:
771
br_from.set_push_location(br_to.base)
772
elif repository_to is None:
773
# we have a bzrdir but no branch or repository
774
# XXX: Figure out what to do other than complain.
775
raise errors.BzrCommandError("At %s you have a valid .bzr control"
776
" directory, but not a branch or repository. This is an"
777
" unsupported configuration. Please move the target directory"
778
" out of the way and try again."
781
# We have a repository but no branch, copy the revisions, and then
783
last_revision_id = br_from.last_revision()
784
repository_to.fetch(br_from.repository,
785
revision_id=last_revision_id)
786
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
787
note('Created new branch.')
788
if br_from.get_push_location() is None or remember:
789
br_from.set_push_location(br_to.base)
790
else: # We have a valid to branch
791
# We were able to connect to the remote location, so remember it
792
# we don't need to successfully push because of possible divergence.
793
if br_from.get_push_location() is None or remember:
794
br_from.set_push_location(br_to.base)
795
old_rh = br_to.revision_history()
798
tree_to = dir_to.open_workingtree()
799
except errors.NotLocalUrl:
800
warning("This transport does not update the working "
801
"tree of: %s. See 'bzr help working-trees' for "
802
"more information." % br_to.base)
803
push_result = br_from.push(br_to, overwrite)
804
except errors.NoWorkingTree:
805
push_result = br_from.push(br_to, overwrite)
809
push_result = br_from.push(tree_to.branch, overwrite)
813
except errors.DivergedBranches:
814
raise errors.BzrCommandError('These branches have diverged.'
815
' Try using "merge" and then "push".')
816
if push_result is not None:
817
push_result.report(self.outf)
819
new_rh = br_to.revision_history()
822
from bzrlib.log import show_changed_revisions
823
show_changed_revisions(br_to, old_rh, new_rh,
826
# we probably did a clone rather than a push, so a message was
831
class cmd_branch(Command):
832
"""Create a new copy of a branch.
834
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
835
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
836
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
837
is derived from the FROM_LOCATION by stripping a leading scheme or drive
838
identifier, if any. For example, "branch lp:foo-bar" will attempt to
841
To retrieve the branch as of a particular revision, supply the --revision
842
parameter, as in "branch foo/bar -r 5".
845
_see_also = ['checkout']
846
takes_args = ['from_location', 'to_location?']
847
takes_options = ['revision']
848
aliases = ['get', 'clone']
850
def run(self, from_location, to_location=None, revision=None):
851
from bzrlib.tag import _merge_tags_if_possible
854
elif len(revision) > 1:
855
raise errors.BzrCommandError(
856
'bzr branch --revision takes exactly 1 revision value')
858
br_from = Branch.open(from_location)
861
if len(revision) == 1 and revision[0] is not None:
862
revision_id = revision[0].in_history(br_from)[1]
864
# FIXME - wt.last_revision, fallback to branch, fall back to
865
# None or perhaps NULL_REVISION to mean copy nothing
867
revision_id = br_from.last_revision()
868
if to_location is None:
869
to_location = urlutils.derive_to_location(from_location)
872
name = os.path.basename(to_location) + '\n'
874
to_transport = transport.get_transport(to_location)
876
to_transport.mkdir('.')
877
except errors.FileExists:
878
raise errors.BzrCommandError('Target directory "%s" already'
879
' exists.' % to_location)
880
except errors.NoSuchFile:
881
raise errors.BzrCommandError('Parent of "%s" does not exist.'
884
# preserve whatever source format we have.
885
dir = br_from.bzrdir.sprout(to_transport.base, revision_id)
886
branch = dir.open_branch()
887
except errors.NoSuchRevision:
888
to_transport.delete_tree('.')
889
msg = "The branch %s has no revision %s." % (from_location, revision[0])
890
raise errors.BzrCommandError(msg)
892
branch.control_files.put_utf8('branch-name', name)
893
_merge_tags_if_possible(br_from, branch)
894
note('Branched %d revision(s).' % branch.revno())
899
class cmd_checkout(Command):
900
"""Create a new checkout of an existing branch.
902
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
903
the branch found in '.'. This is useful if you have removed the working tree
904
or if it was never created - i.e. if you pushed the branch to its current
907
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
908
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
909
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
910
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
911
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
914
To retrieve the branch as of a particular revision, supply the --revision
915
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
916
out of date [so you cannot commit] but it may be useful (i.e. to examine old
920
_see_also = ['checkouts', 'branch']
921
takes_args = ['branch_location?', 'to_location?']
922
takes_options = ['revision',
923
Option('lightweight',
924
help="Perform a lightweight checkout. Lightweight "
925
"checkouts depend on access to the branch for "
926
"every operation. Normal checkouts can perform "
927
"common operations like diff and status without "
928
"such access, and also support local commits."
933
def run(self, branch_location=None, to_location=None, revision=None,
937
elif len(revision) > 1:
938
raise errors.BzrCommandError(
939
'bzr checkout --revision takes exactly 1 revision value')
940
if branch_location is None:
941
branch_location = osutils.getcwd()
942
to_location = branch_location
943
source = Branch.open(branch_location)
944
if len(revision) == 1 and revision[0] is not None:
945
revision_id = revision[0].in_history(source)[1]
948
if to_location is None:
949
to_location = urlutils.derive_to_location(branch_location)
950
# if the source and to_location are the same,
951
# and there is no working tree,
952
# then reconstitute a branch
953
if (osutils.abspath(to_location) ==
954
osutils.abspath(branch_location)):
956
source.bzrdir.open_workingtree()
957
except errors.NoWorkingTree:
958
source.bzrdir.create_workingtree()
961
os.mkdir(to_location)
963
if e.errno == errno.EEXIST:
964
raise errors.BzrCommandError('Target directory "%s" already'
965
' exists.' % to_location)
966
if e.errno == errno.ENOENT:
967
raise errors.BzrCommandError('Parent of "%s" does not exist.'
971
source.create_checkout(to_location, revision_id, lightweight)
974
class cmd_renames(Command):
975
"""Show list of renamed files.
977
# TODO: Option to show renames between two historical versions.
979
# TODO: Only show renames under dir, rather than in the whole branch.
980
_see_also = ['status']
981
takes_args = ['dir?']
984
def run(self, dir=u'.'):
985
tree = WorkingTree.open_containing(dir)[0]
988
new_inv = tree.inventory
989
old_tree = tree.basis_tree()
992
old_inv = old_tree.inventory
993
renames = list(_mod_tree.find_renames(old_inv, new_inv))
995
for old_name, new_name in renames:
996
self.outf.write("%s => %s\n" % (old_name, new_name))
1003
class cmd_update(Command):
1004
"""Update a tree to have the latest code committed to its branch.
1006
This will perform a merge into the working tree, and may generate
1007
conflicts. If you have any local changes, you will still
1008
need to commit them after the update for the update to be complete.
1010
If you want to discard your local changes, you can just do a
1011
'bzr revert' instead of 'bzr commit' after the update.
1014
_see_also = ['pull', 'working-trees']
1015
takes_args = ['dir?']
1018
def run(self, dir='.'):
1019
tree = WorkingTree.open_containing(dir)[0]
1020
master = tree.branch.get_master_branch()
1021
if master is not None:
1024
tree.lock_tree_write()
1026
existing_pending_merges = tree.get_parent_ids()[1:]
1027
last_rev = _mod_revision.ensure_null(tree.last_revision())
1028
if last_rev == _mod_revision.ensure_null(
1029
tree.branch.last_revision()):
1030
# may be up to date, check master too.
1031
master = tree.branch.get_master_branch()
1032
if master is None or last_rev == _mod_revision.ensure_null(
1033
master.last_revision()):
1034
revno = tree.branch.revision_id_to_revno(last_rev)
1035
note("Tree is up to date at revision %d." % (revno,))
1037
conflicts = tree.update(delta._ChangeReporter(
1038
unversioned_filter=tree.is_ignored))
1039
revno = tree.branch.revision_id_to_revno(
1040
_mod_revision.ensure_null(tree.last_revision()))
1041
note('Updated to revision %d.' % (revno,))
1042
if tree.get_parent_ids()[1:] != existing_pending_merges:
1043
note('Your local commits will now show as pending merges with '
1044
"'bzr status', and can be committed with 'bzr commit'.")
1053
class cmd_info(Command):
1054
"""Show information about a working tree, branch or repository.
1056
This command will show all known locations and formats associated to the
1057
tree, branch or repository. Statistical information is included with
1060
Branches and working trees will also report any missing revisions.
1062
_see_also = ['revno', 'working-trees', 'repositories']
1063
takes_args = ['location?']
1064
takes_options = ['verbose']
1067
def run(self, location=None, verbose=0):
1068
from bzrlib.info import show_bzrdir_info
1069
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1073
class cmd_remove(Command):
1074
"""Remove files or directories.
1076
This makes bzr stop tracking changes to the specified files and
1077
delete them if they can easily be recovered using revert.
1079
You can specify one or more files, and/or --new. If you specify --new,
1080
only 'added' files will be removed. If you specify both, then new files
1081
in the specified directories will be removed. If the directories are
1082
also new, they will also be removed.
1084
takes_args = ['file*']
1085
takes_options = ['verbose',
1086
Option('new', help='Remove newly-added files.'),
1087
RegistryOption.from_kwargs('file-deletion-strategy',
1088
'The file deletion mode to be used',
1089
title='Deletion Strategy', value_switches=True, enum_switch=False,
1090
safe='Only delete files if they can be'
1091
' safely recovered (default).',
1092
keep="Don't delete any files.",
1093
force='Delete all the specified files, even if they can not be '
1094
'recovered and even if they are non-empty directories.')]
1096
encoding_type = 'replace'
1098
def run(self, file_list, verbose=False, new=False,
1099
file_deletion_strategy='safe'):
1100
tree, file_list = tree_files(file_list)
1102
if file_list is not None:
1103
file_list = [f for f in file_list if f != '']
1105
raise errors.BzrCommandError('Specify one or more files to'
1106
' remove, or use --new.')
1109
added = tree.changes_from(tree.basis_tree(),
1110
specific_files=file_list).added
1111
file_list = sorted([f[0] for f in added], reverse=True)
1112
if len(file_list) == 0:
1113
raise errors.BzrCommandError('No matching files.')
1114
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1115
keep_files=file_deletion_strategy=='keep',
1116
force=file_deletion_strategy=='force')
1119
class cmd_file_id(Command):
1120
"""Print file_id of a particular file or directory.
1122
The file_id is assigned when the file is first added and remains the
1123
same through all revisions where the file exists, even when it is
1128
_see_also = ['inventory', 'ls']
1129
takes_args = ['filename']
1132
def run(self, filename):
1133
tree, relpath = WorkingTree.open_containing(filename)
1134
i = tree.path2id(relpath)
1136
raise errors.NotVersionedError(filename)
1138
self.outf.write(i + '\n')
1141
class cmd_file_path(Command):
1142
"""Print path of file_ids to a file or directory.
1144
This prints one line for each directory down to the target,
1145
starting at the branch root.
1149
takes_args = ['filename']
1152
def run(self, filename):
1153
tree, relpath = WorkingTree.open_containing(filename)
1154
fid = tree.path2id(relpath)
1156
raise errors.NotVersionedError(filename)
1157
segments = osutils.splitpath(relpath)
1158
for pos in range(1, len(segments) + 1):
1159
path = osutils.joinpath(segments[:pos])
1160
self.outf.write("%s\n" % tree.path2id(path))
1163
class cmd_reconcile(Command):
1164
"""Reconcile bzr metadata in a branch.
1166
This can correct data mismatches that may have been caused by
1167
previous ghost operations or bzr upgrades. You should only
1168
need to run this command if 'bzr check' or a bzr developer
1169
advises you to run it.
1171
If a second branch is provided, cross-branch reconciliation is
1172
also attempted, which will check that data like the tree root
1173
id which was not present in very early bzr versions is represented
1174
correctly in both branches.
1176
At the same time it is run it may recompress data resulting in
1177
a potential saving in disk space or performance gain.
1179
The branch *MUST* be on a listable system such as local disk or sftp.
1182
_see_also = ['check']
1183
takes_args = ['branch?']
1185
def run(self, branch="."):
1186
from bzrlib.reconcile import reconcile
1187
dir = bzrdir.BzrDir.open(branch)
1191
class cmd_revision_history(Command):
1192
"""Display the list of revision ids on a branch."""
1195
takes_args = ['location?']
1200
def run(self, location="."):
1201
branch = Branch.open_containing(location)[0]
1202
for revid in branch.revision_history():
1203
self.outf.write(revid)
1204
self.outf.write('\n')
1207
class cmd_ancestry(Command):
1208
"""List all revisions merged into this branch."""
1210
_see_also = ['log', 'revision-history']
1211
takes_args = ['location?']
1216
def run(self, location="."):
1218
wt = WorkingTree.open_containing(location)[0]
1219
except errors.NoWorkingTree:
1220
b = Branch.open(location)
1221
last_revision = b.last_revision()
1224
last_revision = wt.last_revision()
1226
revision_ids = b.repository.get_ancestry(last_revision)
1227
assert revision_ids[0] is None
1229
for revision_id in revision_ids:
1230
self.outf.write(revision_id + '\n')
1233
class cmd_init(Command):
1234
"""Make a directory into a versioned branch.
1236
Use this to create an empty branch, or before importing an
1239
If there is a repository in a parent directory of the location, then
1240
the history of the branch will be stored in the repository. Otherwise
1241
init creates a standalone branch which carries its own history
1242
in the .bzr directory.
1244
If there is already a branch at the location but it has no working tree,
1245
the tree can be populated with 'bzr checkout'.
1247
Recipe for importing a tree of files:
1252
bzr commit -m 'imported project'
1255
_see_also = ['init-repo', 'branch', 'checkout']
1256
takes_args = ['location?']
1258
Option('create-prefix',
1259
help='Create the path leading up to the branch '
1260
'if it does not already exist.'),
1261
RegistryOption('format',
1262
help='Specify a format for this branch. '
1263
'See "help formats".',
1264
registry=bzrdir.format_registry,
1265
converter=bzrdir.format_registry.make_bzrdir,
1266
value_switches=True,
1267
title="Branch Format",
1269
Option('append-revisions-only',
1270
help='Never change revnos or the existing log.'
1271
' Append revisions to it only.')
1273
def run(self, location=None, format=None, append_revisions_only=False,
1274
create_prefix=False):
1276
format = bzrdir.format_registry.make_bzrdir('default')
1277
if location is None:
1280
to_transport = transport.get_transport(location)
1282
# The path has to exist to initialize a
1283
# branch inside of it.
1284
# Just using os.mkdir, since I don't
1285
# believe that we want to create a bunch of
1286
# locations if the user supplies an extended path
1288
to_transport.ensure_base()
1289
except errors.NoSuchFile:
1290
if not create_prefix:
1291
raise errors.BzrCommandError("Parent directory of %s"
1293
"\nYou may supply --create-prefix to create all"
1294
" leading parent directories."
1296
_create_prefix(to_transport)
1299
existing_bzrdir = bzrdir.BzrDir.open(location)
1300
except errors.NotBranchError:
1301
# really a NotBzrDir error...
1302
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1305
from bzrlib.transport.local import LocalTransport
1306
if existing_bzrdir.has_branch():
1307
if (isinstance(to_transport, LocalTransport)
1308
and not existing_bzrdir.has_workingtree()):
1309
raise errors.BranchExistsWithoutWorkingTree(location)
1310
raise errors.AlreadyBranchError(location)
1312
branch = existing_bzrdir.create_branch()
1313
existing_bzrdir.create_workingtree()
1314
if append_revisions_only:
1316
branch.set_append_revisions_only(True)
1317
except errors.UpgradeRequired:
1318
raise errors.BzrCommandError('This branch format cannot be set'
1319
' to append-revisions-only. Try --experimental-branch6')
1322
class cmd_init_repository(Command):
1323
"""Create a shared repository to hold branches.
1325
New branches created under the repository directory will store their
1326
revisions in the repository, not in the branch directory.
1328
If the --no-trees option is used then the branches in the repository
1329
will not have working trees by default.
1332
bzr init-repo --no-trees repo
1334
bzr checkout --lightweight repo/trunk trunk-checkout
1338
See 'bzr help repositories' for more information.
1341
_see_also = ['init', 'branch', 'checkout']
1342
takes_args = ["location"]
1343
takes_options = [RegistryOption('format',
1344
help='Specify a format for this repository. See'
1345
' "bzr help formats" for details.',
1346
registry=bzrdir.format_registry,
1347
converter=bzrdir.format_registry.make_bzrdir,
1348
value_switches=True, title='Repository format'),
1350
help='Branches in the repository will default to'
1351
' not having a working tree.'),
1353
aliases = ["init-repo"]
1355
def run(self, location, format=None, no_trees=False):
1357
format = bzrdir.format_registry.make_bzrdir('default')
1359
if location is None:
1362
to_transport = transport.get_transport(location)
1363
to_transport.ensure_base()
1365
newdir = format.initialize_on_transport(to_transport)
1366
repo = newdir.create_repository(shared=True)
1367
repo.set_make_working_trees(not no_trees)
1370
class cmd_diff(Command):
1371
"""Show differences in the working tree or between revisions.
1373
If files are listed, only the changes in those files are listed.
1374
Otherwise, all changes for the tree are listed.
1376
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1377
produces patches suitable for "patch -p1".
1381
Shows the difference in the working tree versus the last commit
1383
Difference between the working tree and revision 1
1385
Difference between revision 2 and revision 1
1386
bzr diff --prefix old/:new/
1387
Same as 'bzr diff' but prefix paths with old/ and new/
1388
bzr diff bzr.mine bzr.dev
1389
Show the differences between the two working trees
1391
Show just the differences for 'foo.c'
1393
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1394
# or a graphical diff.
1396
# TODO: Python difflib is not exactly the same as unidiff; should
1397
# either fix it up or prefer to use an external diff.
1399
# TODO: Selected-file diff is inefficient and doesn't show you
1402
# TODO: This probably handles non-Unix newlines poorly.
1404
_see_also = ['status']
1405
takes_args = ['file*']
1407
Option('diff-options', type=str,
1408
help='Pass these options to the external diff program.'),
1409
Option('prefix', type=str,
1411
help='Set prefixes to added to old and new filenames, as '
1412
'two values separated by a colon. (eg "old/:new/").'),
1415
aliases = ['di', 'dif']
1416
encoding_type = 'exact'
1419
def run(self, revision=None, file_list=None, diff_options=None,
1421
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1423
if (prefix is None) or (prefix == '0'):
1431
old_label, new_label = prefix.split(":")
1433
raise errors.BzrCommandError(
1434
'--prefix expects two values separated by a colon'
1435
' (eg "old/:new/")')
1437
if revision and len(revision) > 2:
1438
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1439
' one or two revision specifiers')
1442
tree1, file_list = internal_tree_files(file_list)
1446
except errors.FileInWrongBranch:
1447
if len(file_list) != 2:
1448
raise errors.BzrCommandError("Files are in different branches")
1450
tree1, file1 = WorkingTree.open_containing(file_list[0])
1451
tree2, file2 = WorkingTree.open_containing(file_list[1])
1452
if file1 != "" or file2 != "":
1453
# FIXME diff those two files. rbc 20051123
1454
raise errors.BzrCommandError("Files are in different branches")
1456
except errors.NotBranchError:
1457
if (revision is not None and len(revision) == 2
1458
and not revision[0].needs_branch()
1459
and not revision[1].needs_branch()):
1460
# If both revision specs include a branch, we can
1461
# diff them without needing a local working tree
1462
tree1, tree2 = None, None
1466
if tree2 is not None:
1467
if revision is not None:
1468
# FIXME: but there should be a clean way to diff between
1469
# non-default versions of two trees, it's not hard to do
1471
raise errors.BzrCommandError(
1472
"Sorry, diffing arbitrary revisions across branches "
1473
"is not implemented yet")
1474
return show_diff_trees(tree1, tree2, sys.stdout,
1475
specific_files=file_list,
1476
external_diff_options=diff_options,
1477
old_label=old_label, new_label=new_label)
1479
return diff_cmd_helper(tree1, file_list, diff_options,
1480
revision_specs=revision,
1481
old_label=old_label, new_label=new_label)
1484
class cmd_deleted(Command):
1485
"""List files deleted in the working tree.
1487
# TODO: Show files deleted since a previous revision, or
1488
# between two revisions.
1489
# TODO: Much more efficient way to do this: read in new
1490
# directories with readdir, rather than stating each one. Same
1491
# level of effort but possibly much less IO. (Or possibly not,
1492
# if the directories are very large...)
1493
_see_also = ['status', 'ls']
1494
takes_options = ['show-ids']
1497
def run(self, show_ids=False):
1498
tree = WorkingTree.open_containing(u'.')[0]
1501
old = tree.basis_tree()
1504
for path, ie in old.inventory.iter_entries():
1505
if not tree.has_id(ie.file_id):
1506
self.outf.write(path)
1508
self.outf.write(' ')
1509
self.outf.write(ie.file_id)
1510
self.outf.write('\n')
1517
class cmd_modified(Command):
1518
"""List files modified in working tree.
1522
_see_also = ['status', 'ls']
1526
tree = WorkingTree.open_containing(u'.')[0]
1527
td = tree.changes_from(tree.basis_tree())
1528
for path, id, kind, text_modified, meta_modified in td.modified:
1529
self.outf.write(path + '\n')
1532
class cmd_added(Command):
1533
"""List files added in working tree.
1537
_see_also = ['status', 'ls']
1541
wt = WorkingTree.open_containing(u'.')[0]
1544
basis = wt.basis_tree()
1547
basis_inv = basis.inventory
1550
if file_id in basis_inv:
1552
if inv.is_root(file_id) and len(basis_inv) == 0:
1554
path = inv.id2path(file_id)
1555
if not os.access(osutils.abspath(path), os.F_OK):
1557
self.outf.write(path + '\n')
1564
class cmd_root(Command):
1565
"""Show the tree root directory.
1567
The root is the nearest enclosing directory with a .bzr control
1570
takes_args = ['filename?']
1572
def run(self, filename=None):
1573
"""Print the branch root."""
1574
tree = WorkingTree.open_containing(filename)[0]
1575
self.outf.write(tree.basedir + '\n')
1578
def _parse_limit(limitstring):
1580
return int(limitstring)
1582
msg = "The limit argument must be an integer."
1583
raise errors.BzrCommandError(msg)
1586
class cmd_log(Command):
1587
"""Show log of a branch, file, or directory.
1589
By default show the log of the branch containing the working directory.
1591
To request a range of logs, you can use the command -r begin..end
1592
-r revision requests a specific revision, -r ..end or -r begin.. are
1598
bzr log -r -10.. http://server/branch
1601
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1603
takes_args = ['location?']
1606
help='Show from oldest to newest.'),
1609
help='Display timezone as local, original, or utc.'),
1612
help='Show files changed in each revision.'),
1618
help='Show revisions whose message matches this '
1619
'regular expression.',
1622
help='Limit the output to the first N revisions.',
1626
encoding_type = 'replace'
1629
def run(self, location=None, timezone='original',
1637
from bzrlib.log import show_log
1638
assert message is None or isinstance(message, basestring), \
1639
"invalid message argument %r" % message
1640
direction = (forward and 'forward') or 'reverse'
1645
# find the file id to log:
1647
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1651
tree = b.basis_tree()
1652
file_id = tree.path2id(fp)
1654
raise errors.BzrCommandError(
1655
"Path does not have any revision history: %s" %
1659
# FIXME ? log the current subdir only RBC 20060203
1660
if revision is not None \
1661
and len(revision) > 0 and revision[0].get_branch():
1662
location = revision[0].get_branch()
1665
dir, relpath = bzrdir.BzrDir.open_containing(location)
1666
b = dir.open_branch()
1670
if revision is None:
1673
elif len(revision) == 1:
1674
rev1 = rev2 = revision[0].in_history(b)
1675
elif len(revision) == 2:
1676
if revision[1].get_branch() != revision[0].get_branch():
1677
# b is taken from revision[0].get_branch(), and
1678
# show_log will use its revision_history. Having
1679
# different branches will lead to weird behaviors.
1680
raise errors.BzrCommandError(
1681
"Log doesn't accept two revisions in different"
1683
rev1 = revision[0].in_history(b)
1684
rev2 = revision[1].in_history(b)
1686
raise errors.BzrCommandError(
1687
'bzr log --revision takes one or two values.')
1689
if log_format is None:
1690
log_format = log.log_formatter_registry.get_default(b)
1692
lf = log_format(show_ids=show_ids, to_file=self.outf,
1693
show_timezone=timezone)
1699
direction=direction,
1700
start_revision=rev1,
1708
def get_log_format(long=False, short=False, line=False, default='long'):
1709
log_format = default
1713
log_format = 'short'
1719
class cmd_touching_revisions(Command):
1720
"""Return revision-ids which affected a particular file.
1722
A more user-friendly interface is "bzr log FILE".
1726
takes_args = ["filename"]
1729
def run(self, filename):
1730
tree, relpath = WorkingTree.open_containing(filename)
1732
file_id = tree.path2id(relpath)
1733
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1734
self.outf.write("%6d %s\n" % (revno, what))
1737
class cmd_ls(Command):
1738
"""List files in a tree.
1741
_see_also = ['status', 'cat']
1742
takes_args = ['path?']
1743
# TODO: Take a revision or remote path and list that tree instead.
1747
Option('non-recursive',
1748
help='Don\'t recurse into subdirectories.'),
1750
help='Print paths relative to the root of the branch.'),
1751
Option('unknown', help='Print unknown files.'),
1752
Option('versioned', help='Print versioned files.'),
1753
Option('ignored', help='Print ignored files.'),
1755
help='Write an ascii NUL (\\0) separator '
1756
'between files rather than a newline.'),
1758
help='List entries of a particular kind: file, directory, symlink.',
1763
def run(self, revision=None, verbose=False,
1764
non_recursive=False, from_root=False,
1765
unknown=False, versioned=False, ignored=False,
1766
null=False, kind=None, show_ids=False, path=None):
1768
if kind and kind not in ('file', 'directory', 'symlink'):
1769
raise errors.BzrCommandError('invalid kind specified')
1771
if verbose and null:
1772
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1773
all = not (unknown or versioned or ignored)
1775
selection = {'I':ignored, '?':unknown, 'V':versioned}
1782
raise errors.BzrCommandError('cannot specify both --from-root'
1786
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1792
if revision is not None:
1793
tree = branch.repository.revision_tree(
1794
revision[0].in_history(branch).rev_id)
1796
tree = branch.basis_tree()
1800
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1801
if fp.startswith(relpath):
1802
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1803
if non_recursive and '/' in fp:
1805
if not all and not selection[fc]:
1807
if kind is not None and fkind != kind:
1810
kindch = entry.kind_character()
1811
outstring = '%-8s %s%s' % (fc, fp, kindch)
1812
if show_ids and fid is not None:
1813
outstring = "%-50s %s" % (outstring, fid)
1814
self.outf.write(outstring + '\n')
1816
self.outf.write(fp + '\0')
1819
self.outf.write(fid)
1820
self.outf.write('\0')
1828
self.outf.write('%-50s %s\n' % (fp, my_id))
1830
self.outf.write(fp + '\n')
1835
class cmd_unknowns(Command):
1836
"""List unknown files.
1844
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1845
self.outf.write(osutils.quotefn(f) + '\n')
1848
class cmd_ignore(Command):
1849
"""Ignore specified files or patterns.
1851
To remove patterns from the ignore list, edit the .bzrignore file.
1853
Trailing slashes on patterns are ignored.
1854
If the pattern contains a slash or is a regular expression, it is compared
1855
to the whole path from the branch root. Otherwise, it is compared to only
1856
the last component of the path. To match a file only in the root
1857
directory, prepend './'.
1859
Ignore patterns specifying absolute paths are not allowed.
1861
Ignore patterns may include globbing wildcards such as:
1862
? - Matches any single character except '/'
1863
* - Matches 0 or more characters except '/'
1864
/**/ - Matches 0 or more directories in a path
1865
[a-z] - Matches a single character from within a group of characters
1867
Ignore patterns may also be Python regular expressions.
1868
Regular expression ignore patterns are identified by a 'RE:' prefix
1869
followed by the regular expression. Regular expression ignore patterns
1870
may not include named or numbered groups.
1872
Note: ignore patterns containing shell wildcards must be quoted from
1876
bzr ignore ./Makefile
1877
bzr ignore '*.class'
1878
bzr ignore 'lib/**/*.o'
1879
bzr ignore 'RE:lib/.*\.o'
1882
_see_also = ['status', 'ignored']
1883
takes_args = ['name_pattern*']
1885
Option('old-default-rules',
1886
help='Write out the ignore rules bzr < 0.9 always used.')
1889
def run(self, name_pattern_list=None, old_default_rules=None):
1890
from bzrlib.atomicfile import AtomicFile
1891
if old_default_rules is not None:
1892
# dump the rules and exit
1893
for pattern in ignores.OLD_DEFAULTS:
1896
if not name_pattern_list:
1897
raise errors.BzrCommandError("ignore requires at least one "
1898
"NAME_PATTERN or --old-default-rules")
1899
name_pattern_list = [globbing.normalize_pattern(p)
1900
for p in name_pattern_list]
1901
for name_pattern in name_pattern_list:
1902
if (name_pattern[0] == '/' or
1903
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1904
raise errors.BzrCommandError(
1905
"NAME_PATTERN should not be an absolute path")
1906
tree, relpath = WorkingTree.open_containing(u'.')
1907
ifn = tree.abspath('.bzrignore')
1908
if os.path.exists(ifn):
1911
igns = f.read().decode('utf-8')
1917
# TODO: If the file already uses crlf-style termination, maybe
1918
# we should use that for the newly added lines?
1920
if igns and igns[-1] != '\n':
1922
for name_pattern in name_pattern_list:
1923
igns += name_pattern + '\n'
1925
f = AtomicFile(ifn, 'wb')
1927
f.write(igns.encode('utf-8'))
1932
if not tree.path2id('.bzrignore'):
1933
tree.add(['.bzrignore'])
1936
class cmd_ignored(Command):
1937
"""List ignored files and the patterns that matched them.
1940
_see_also = ['ignore']
1943
tree = WorkingTree.open_containing(u'.')[0]
1946
for path, file_class, kind, file_id, entry in tree.list_files():
1947
if file_class != 'I':
1949
## XXX: Slightly inefficient since this was already calculated
1950
pat = tree.is_ignored(path)
1951
print '%-50s %s' % (path, pat)
1956
class cmd_lookup_revision(Command):
1957
"""Lookup the revision-id from a revision-number
1960
bzr lookup-revision 33
1963
takes_args = ['revno']
1966
def run(self, revno):
1970
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1972
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1975
class cmd_export(Command):
1976
"""Export current or past revision to a destination directory or archive.
1978
If no revision is specified this exports the last committed revision.
1980
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1981
given, try to find the format with the extension. If no extension
1982
is found exports to a directory (equivalent to --format=dir).
1984
If root is supplied, it will be used as the root directory inside
1985
container formats (tar, zip, etc). If it is not supplied it will default
1986
to the exported filename. The root option has no effect for 'dir' format.
1988
If branch is omitted then the branch containing the current working
1989
directory will be used.
1991
Note: Export of tree with non-ASCII filenames to zip is not supported.
1993
Supported formats Autodetected by extension
1994
----------------- -------------------------
1997
tbz2 .tar.bz2, .tbz2
2001
takes_args = ['dest', 'branch?']
2004
help="Type of file to export to.",
2009
help="Name of the root directory inside the exported file."),
2011
def run(self, dest, branch=None, revision=None, format=None, root=None):
2012
from bzrlib.export import export
2015
tree = WorkingTree.open_containing(u'.')[0]
2018
b = Branch.open(branch)
2020
if revision is None:
2021
# should be tree.last_revision FIXME
2022
rev_id = b.last_revision()
2024
if len(revision) != 1:
2025
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2026
rev_id = revision[0].in_history(b).rev_id
2027
t = b.repository.revision_tree(rev_id)
2029
export(t, dest, format, root)
2030
except errors.NoSuchExportFormat, e:
2031
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2034
class cmd_cat(Command):
2035
"""Write the contents of a file as of a given revision to standard output.
2037
If no revision is nominated, the last revision is used.
2039
Note: Take care to redirect standard output when using this command on a
2045
Option('name-from-revision', help='The path name in the old tree.'),
2048
takes_args = ['filename']
2049
encoding_type = 'exact'
2052
def run(self, filename, revision=None, name_from_revision=False):
2053
if revision is not None and len(revision) != 1:
2054
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2059
tree, b, relpath = \
2060
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2061
except errors.NotBranchError:
2064
if revision is not None and revision[0].get_branch() is not None:
2065
b = Branch.open(revision[0].get_branch())
2067
tree = b.basis_tree()
2068
if revision is None:
2069
revision_id = b.last_revision()
2071
revision_id = revision[0].in_history(b).rev_id
2073
cur_file_id = tree.path2id(relpath)
2074
rev_tree = b.repository.revision_tree(revision_id)
2075
old_file_id = rev_tree.path2id(relpath)
2077
if name_from_revision:
2078
if old_file_id is None:
2079
raise errors.BzrCommandError("%r is not present in revision %s"
2080
% (filename, revision_id))
2082
rev_tree.print_file(old_file_id)
2083
elif cur_file_id is not None:
2084
rev_tree.print_file(cur_file_id)
2085
elif old_file_id is not None:
2086
rev_tree.print_file(old_file_id)
2088
raise errors.BzrCommandError("%r is not present in revision %s" %
2089
(filename, revision_id))
2092
class cmd_local_time_offset(Command):
2093
"""Show the offset in seconds from GMT to local time."""
2097
print osutils.local_time_offset()
2101
class cmd_commit(Command):
2102
"""Commit changes into a new revision.
2104
If no arguments are given, the entire tree is committed.
2106
If selected files are specified, only changes to those files are
2107
committed. If a directory is specified then the directory and everything
2108
within it is committed.
2110
A selected-file commit may fail in some cases where the committed
2111
tree would be invalid. Consider::
2116
bzr commit foo -m "committing foo"
2117
bzr mv foo/bar foo/baz
2120
bzr commit foo/bar -m "committing bar but not baz"
2122
In the example above, the last commit will fail by design. This gives
2123
the user the opportunity to decide whether they want to commit the
2124
rename at the same time, separately first, or not at all. (As a general
2125
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2127
Note: A selected-file commit after a merge is not yet supported.
2129
# TODO: Run hooks on tree to-be-committed, and after commit.
2131
# TODO: Strict commit that fails if there are deleted files.
2132
# (what does "deleted files" mean ??)
2134
# TODO: Give better message for -s, --summary, used by tla people
2136
# XXX: verbose currently does nothing
2138
_see_also = ['bugs', 'uncommit']
2139
takes_args = ['selected*']
2141
Option('message', type=unicode,
2143
help="Description of the new revision."),
2146
help='Commit even if nothing has changed.'),
2147
Option('file', type=str,
2150
help='Take commit message from this file.'),
2152
help="Refuse to commit if there are unknown "
2153
"files in the working tree."),
2154
ListOption('fixes', type=str,
2155
help="Mark a bug as being fixed by this revision."),
2157
help="Perform a local commit in a bound "
2158
"branch. Local commits are not pushed to "
2159
"the master branch until a normal commit "
2163
aliases = ['ci', 'checkin']
2165
def _get_bug_fix_properties(self, fixes, branch):
2167
# Configure the properties for bug fixing attributes.
2168
for fixed_bug in fixes:
2169
tokens = fixed_bug.split(':')
2170
if len(tokens) != 2:
2171
raise errors.BzrCommandError(
2172
"Invalid bug %s. Must be in the form of 'tag:id'. "
2173
"Commit refused." % fixed_bug)
2174
tag, bug_id = tokens
2176
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2177
except errors.UnknownBugTrackerAbbreviation:
2178
raise errors.BzrCommandError(
2179
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2180
except errors.MalformedBugIdentifier:
2181
raise errors.BzrCommandError(
2182
"Invalid bug identifier for %s. Commit refused."
2184
properties.append('%s fixed' % bug_url)
2185
return '\n'.join(properties)
2187
def run(self, message=None, file=None, verbose=True, selected_list=None,
2188
unchanged=False, strict=False, local=False, fixes=None):
2189
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2190
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2192
from bzrlib.msgeditor import edit_commit_message, \
2193
make_commit_message_template
2195
# TODO: Need a blackbox test for invoking the external editor; may be
2196
# slightly problematic to run this cross-platform.
2198
# TODO: do more checks that the commit will succeed before
2199
# spending the user's valuable time typing a commit message.
2203
tree, selected_list = tree_files(selected_list)
2204
if selected_list == ['']:
2205
# workaround - commit of root of tree should be exactly the same
2206
# as just default commit in that tree, and succeed even though
2207
# selected-file merge commit is not done yet
2210
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2212
properties['bugs'] = bug_property
2214
if local and not tree.branch.get_bound_location():
2215
raise errors.LocalRequiresBoundBranch()
2217
def get_message(commit_obj):
2218
"""Callback to get commit message"""
2219
my_message = message
2220
if my_message is None and not file:
2221
template = make_commit_message_template(tree, selected_list)
2222
my_message = edit_commit_message(template)
2223
if my_message is None:
2224
raise errors.BzrCommandError("please specify a commit"
2225
" message with either --message or --file")
2226
elif my_message and file:
2227
raise errors.BzrCommandError(
2228
"please specify either --message or --file")
2230
my_message = codecs.open(file, 'rt',
2231
bzrlib.user_encoding).read()
2232
if my_message == "":
2233
raise errors.BzrCommandError("empty commit message specified")
2237
reporter = ReportCommitToLog()
2239
reporter = NullCommitReporter()
2242
tree.commit(message_callback=get_message,
2243
specific_files=selected_list,
2244
allow_pointless=unchanged, strict=strict, local=local,
2245
reporter=reporter, revprops=properties)
2246
except PointlessCommit:
2247
# FIXME: This should really happen before the file is read in;
2248
# perhaps prepare the commit; get the message; then actually commit
2249
raise errors.BzrCommandError("no changes to commit."
2250
" use --unchanged to commit anyhow")
2251
except ConflictsInTree:
2252
raise errors.BzrCommandError('Conflicts detected in working '
2253
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2255
except StrictCommitFailed:
2256
raise errors.BzrCommandError("Commit refused because there are"
2257
" unknown files in the working tree.")
2258
except errors.BoundBranchOutOfDate, e:
2259
raise errors.BzrCommandError(str(e) + "\n"
2260
'To commit to master branch, run update and then commit.\n'
2261
'You can also pass --local to commit to continue working '
2265
class cmd_check(Command):
2266
"""Validate consistency of branch history.
2268
This command checks various invariants about the branch storage to
2269
detect data corruption or bzr bugs.
2272
_see_also = ['reconcile']
2273
takes_args = ['branch?']
2274
takes_options = ['verbose']
2276
def run(self, branch=None, verbose=False):
2277
from bzrlib.check import check
2279
tree = WorkingTree.open_containing()[0]
2280
branch = tree.branch
2282
branch = Branch.open(branch)
2283
check(branch, verbose)
2286
class cmd_upgrade(Command):
2287
"""Upgrade branch storage to current format.
2289
The check command or bzr developers may sometimes advise you to run
2290
this command. When the default format has changed you may also be warned
2291
during other operations to upgrade.
2294
_see_also = ['check']
2295
takes_args = ['url?']
2297
RegistryOption('format',
2298
help='Upgrade to a specific format. See "bzr help'
2299
' formats" for details.',
2300
registry=bzrdir.format_registry,
2301
converter=bzrdir.format_registry.make_bzrdir,
2302
value_switches=True, title='Branch format'),
2305
def run(self, url='.', format=None):
2306
from bzrlib.upgrade import upgrade
2308
format = bzrdir.format_registry.make_bzrdir('default')
2309
upgrade(url, format)
2312
class cmd_whoami(Command):
2313
"""Show or set bzr user id.
2317
bzr whoami 'Frank Chu <fchu@example.com>'
2319
takes_options = [ Option('email',
2320
help='Display email address only.'),
2322
help='Set identity for the current branch instead of '
2325
takes_args = ['name?']
2326
encoding_type = 'replace'
2329
def run(self, email=False, branch=False, name=None):
2331
# use branch if we're inside one; otherwise global config
2333
c = Branch.open_containing('.')[0].get_config()
2334
except errors.NotBranchError:
2335
c = config.GlobalConfig()
2337
self.outf.write(c.user_email() + '\n')
2339
self.outf.write(c.username() + '\n')
2342
# display a warning if an email address isn't included in the given name.
2344
config.extract_email_address(name)
2345
except errors.NoEmailInUsername, e:
2346
warning('"%s" does not seem to contain an email address. '
2347
'This is allowed, but not recommended.', name)
2349
# use global config unless --branch given
2351
c = Branch.open_containing('.')[0].get_config()
2353
c = config.GlobalConfig()
2354
c.set_user_option('email', name)
2357
class cmd_nick(Command):
2358
"""Print or set the branch nickname.
2360
If unset, the tree root directory name is used as the nickname
2361
To print the current nickname, execute with no argument.
2364
_see_also = ['info']
2365
takes_args = ['nickname?']
2366
def run(self, nickname=None):
2367
branch = Branch.open_containing(u'.')[0]
2368
if nickname is None:
2369
self.printme(branch)
2371
branch.nick = nickname
2374
def printme(self, branch):
2378
class cmd_selftest(Command):
2379
"""Run internal test suite.
2381
If arguments are given, they are regular expressions that say which tests
2382
should run. Tests matching any expression are run, and other tests are
2385
Alternatively if --first is given, matching tests are run first and then
2386
all other tests are run. This is useful if you have been working in a
2387
particular area, but want to make sure nothing else was broken.
2389
If --exclude is given, tests that match that regular expression are
2390
excluded, regardless of whether they match --first or not.
2392
To help catch accidential dependencies between tests, the --randomize
2393
option is useful. In most cases, the argument used is the word 'now'.
2394
Note that the seed used for the random number generator is displayed
2395
when this option is used. The seed can be explicitly passed as the
2396
argument to this option if required. This enables reproduction of the
2397
actual ordering used if and when an order sensitive problem is encountered.
2399
If --list-only is given, the tests that would be run are listed. This is
2400
useful when combined with --first, --exclude and/or --randomize to
2401
understand their impact. The test harness reports "Listed nn tests in ..."
2402
instead of "Ran nn tests in ..." when list mode is enabled.
2404
If the global option '--no-plugins' is given, plugins are not loaded
2405
before running the selftests. This has two effects: features provided or
2406
modified by plugins will not be tested, and tests provided by plugins will
2409
Tests that need working space on disk use a common temporary directory,
2410
typically inside $TMPDIR or /tmp.
2414
run only tests relating to 'ignore'
2415
bzr --no-plugins selftest -v
2416
disable plugins and list tests as they're run
2418
# NB: this is used from the class without creating an instance, which is
2419
# why it does not have a self parameter.
2420
def get_transport_type(typestring):
2421
"""Parse and return a transport specifier."""
2422
if typestring == "sftp":
2423
from bzrlib.transport.sftp import SFTPAbsoluteServer
2424
return SFTPAbsoluteServer
2425
if typestring == "memory":
2426
from bzrlib.transport.memory import MemoryServer
2428
if typestring == "fakenfs":
2429
from bzrlib.transport.fakenfs import FakeNFSServer
2430
return FakeNFSServer
2431
msg = "No known transport type %s. Supported types are: sftp\n" %\
2433
raise errors.BzrCommandError(msg)
2436
takes_args = ['testspecs*']
2437
takes_options = ['verbose',
2439
help='Stop when one test fails.',
2443
help='Use a different transport by default '
2444
'throughout the test suite.',
2445
type=get_transport_type),
2447
help='Run the benchmarks rather than selftests.'),
2448
Option('lsprof-timed',
2449
help='Generate lsprof output for benchmarked'
2450
' sections of code.'),
2451
Option('cache-dir', type=str,
2452
help='Cache intermediate benchmark output in this '
2455
help='Run all tests, but run specified tests first.',
2459
help='List the tests instead of running them.'),
2460
Option('randomize', type=str, argname="SEED",
2461
help='Randomize the order of tests using the given'
2462
' seed or "now" for the current time.'),
2463
Option('exclude', type=str, argname="PATTERN",
2465
help='Exclude tests that match this regular'
2468
encoding_type = 'replace'
2470
def run(self, testspecs_list=None, verbose=None, one=False,
2471
transport=None, benchmark=None,
2472
lsprof_timed=None, cache_dir=None,
2473
first=False, list_only=False,
2474
randomize=None, exclude=None):
2476
from bzrlib.tests import selftest
2477
import bzrlib.benchmarks as benchmarks
2478
from bzrlib.benchmarks import tree_creator
2479
from bzrlib.version import show_version
2481
if cache_dir is not None:
2482
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2484
show_version(show_config=False, show_copyright=False)
2486
if testspecs_list is not None:
2487
pattern = '|'.join(testspecs_list)
2491
test_suite_factory = benchmarks.test_suite
2494
# TODO: should possibly lock the history file...
2495
benchfile = open(".perf_history", "at", buffering=1)
2497
test_suite_factory = None
2502
result = selftest(verbose=verbose,
2504
stop_on_failure=one,
2505
transport=transport,
2506
test_suite_factory=test_suite_factory,
2507
lsprof_timed=lsprof_timed,
2508
bench_history=benchfile,
2509
matching_tests_first=first,
2510
list_only=list_only,
2511
random_seed=randomize,
2512
exclude_pattern=exclude
2515
if benchfile is not None:
2518
info('tests passed')
2520
info('tests failed')
2521
return int(not result)
2524
class cmd_version(Command):
2525
"""Show version of bzr."""
2529
from bzrlib.version import show_version
2533
class cmd_rocks(Command):
2534
"""Statement of optimism."""
2540
print "It sure does!"
2543
class cmd_find_merge_base(Command):
2544
"""Find and print a base revision for merging two branches."""
2545
# TODO: Options to specify revisions on either side, as if
2546
# merging only part of the history.
2547
takes_args = ['branch', 'other']
2551
def run(self, branch, other):
2552
from bzrlib.revision import ensure_null, MultipleRevisionSources
2554
branch1 = Branch.open_containing(branch)[0]
2555
branch2 = Branch.open_containing(other)[0]
2557
last1 = ensure_null(branch1.last_revision())
2558
last2 = ensure_null(branch2.last_revision())
2560
graph = branch1.repository.get_graph(branch2.repository)
2561
base_rev_id = graph.find_unique_lca(last1, last2)
2563
print 'merge base is revision %s' % base_rev_id
2566
class cmd_merge(Command):
2567
"""Perform a three-way merge.
2569
The branch is the branch you will merge from. By default, it will merge
2570
the latest revision. If you specify a revision, that revision will be
2571
merged. If you specify two revisions, the first will be used as a BASE,
2572
and the second one as OTHER. Revision numbers are always relative to the
2575
By default, bzr will try to merge in all new work from the other
2576
branch, automatically determining an appropriate base. If this
2577
fails, you may need to give an explicit base.
2579
Merge will do its best to combine the changes in two branches, but there
2580
are some kinds of problems only a human can fix. When it encounters those,
2581
it will mark a conflict. A conflict means that you need to fix something,
2582
before you should commit.
2584
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2586
If there is no default branch set, the first merge will set it. After
2587
that, you can omit the branch to use the default. To change the
2588
default, use --remember. The value will only be saved if the remote
2589
location can be accessed.
2591
The results of the merge are placed into the destination working
2592
directory, where they can be reviewed (with bzr diff), tested, and then
2593
committed to record the result of the merge.
2597
To merge the latest revision from bzr.dev:
2598
bzr merge ../bzr.dev
2600
To merge changes up to and including revision 82 from bzr.dev:
2601
bzr merge -r 82 ../bzr.dev
2603
To merge the changes introduced by 82, without previous changes:
2604
bzr merge -r 81..82 ../bzr.dev
2606
merge refuses to run if there are any uncommitted changes, unless
2610
_see_also = ['update', 'remerge', 'status-flags']
2611
takes_args = ['branch?']
2615
help='Merge even if the destination tree has uncommitted changes.'),
2619
Option('show-base', help="Show base revision text in "
2621
Option('uncommitted', help='Apply uncommitted changes'
2622
' from a working copy, instead of branch changes.'),
2623
Option('pull', help='If the destination is already'
2624
' completely merged into the source, pull from the'
2625
' source rather than merging. When this happens,'
2626
' you do not need to commit the result.'),
2628
help='Branch to merge into, '
2629
'rather than the one containing the working directory.',
2635
def run(self, branch=None, revision=None, force=False, merge_type=None,
2636
show_base=False, reprocess=False, remember=False,
2637
uncommitted=False, pull=False,
2640
from bzrlib.tag import _merge_tags_if_possible
2641
other_revision_id = None
2642
if merge_type is None:
2643
merge_type = _mod_merge.Merge3Merger
2645
if directory is None: directory = u'.'
2646
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2647
# inventory. Because merge is a mutating operation, it really
2648
# should be a lock_write() for the whole cmd_merge operation.
2649
# However, cmd_merge open's its own tree in _merge_helper, which
2650
# means if we lock here, the later lock_write() will always block.
2651
# Either the merge helper code should be updated to take a tree,
2652
# (What about tree.merge_from_branch?)
2653
tree = WorkingTree.open_containing(directory)[0]
2654
change_reporter = delta._ChangeReporter(
2655
unversioned_filter=tree.is_ignored)
2657
if branch is not None:
2659
mergeable = bundle.read_mergeable_from_url(
2661
except errors.NotABundle:
2662
pass # Continue on considering this url a Branch
2664
if revision is not None:
2665
raise errors.BzrCommandError(
2666
'Cannot use -r with merge directives or bundles')
2667
other_revision_id = mergeable.install_revisions(
2668
tree.branch.repository)
2669
revision = [RevisionSpec.from_string(
2670
'revid:' + other_revision_id)]
2672
if revision is None \
2673
or len(revision) < 1 or revision[0].needs_branch():
2674
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2676
if revision is None or len(revision) < 1:
2679
other = [branch, None]
2682
other = [branch, -1]
2683
other_branch, path = Branch.open_containing(branch)
2686
raise errors.BzrCommandError('Cannot use --uncommitted and'
2687
' --revision at the same time.')
2688
branch = revision[0].get_branch() or branch
2689
if len(revision) == 1:
2691
if other_revision_id is not None:
2696
other_branch, path = Branch.open_containing(branch)
2697
revno = revision[0].in_history(other_branch).revno
2698
other = [branch, revno]
2700
assert len(revision) == 2
2701
if None in revision:
2702
raise errors.BzrCommandError(
2703
"Merge doesn't permit empty revision specifier.")
2704
base_branch, path = Branch.open_containing(branch)
2705
branch1 = revision[1].get_branch() or branch
2706
other_branch, path1 = Branch.open_containing(branch1)
2707
if revision[0].get_branch() is not None:
2708
# then path was obtained from it, and is None.
2711
base = [branch, revision[0].in_history(base_branch).revno]
2712
other = [branch1, revision[1].in_history(other_branch).revno]
2714
if ((tree.branch.get_parent() is None or remember) and
2715
other_branch is not None):
2716
tree.branch.set_parent(other_branch.base)
2718
# pull tags now... it's a bit inconsistent to do it ahead of copying
2719
# the history but that's done inside the merge code
2720
if other_branch is not None:
2721
_merge_tags_if_possible(other_branch, tree.branch)
2724
interesting_files = [path]
2726
interesting_files = None
2727
pb = ui.ui_factory.nested_progress_bar()
2730
conflict_count = _merge_helper(
2731
other, base, other_rev_id=other_revision_id,
2732
check_clean=(not force),
2733
merge_type=merge_type,
2734
reprocess=reprocess,
2735
show_base=show_base,
2738
pb=pb, file_list=interesting_files,
2739
change_reporter=change_reporter)
2742
if conflict_count != 0:
2746
except errors.AmbiguousBase, e:
2747
m = ("sorry, bzr can't determine the right merge base yet\n"
2748
"candidates are:\n "
2749
+ "\n ".join(e.bases)
2751
"please specify an explicit base with -r,\n"
2752
"and (if you want) report this to the bzr developers\n")
2755
# TODO: move up to common parent; this isn't merge-specific anymore.
2756
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2757
"""Use tree.branch's parent if none was supplied.
2759
Report if the remembered location was used.
2761
if supplied_location is not None:
2762
return supplied_location
2763
stored_location = tree.branch.get_parent()
2764
mutter("%s", stored_location)
2765
if stored_location is None:
2766
raise errors.BzrCommandError("No location specified or remembered")
2767
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2768
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2769
return stored_location
2772
class cmd_remerge(Command):
2775
Use this if you want to try a different merge technique while resolving
2776
conflicts. Some merge techniques are better than others, and remerge
2777
lets you try different ones on different files.
2779
The options for remerge have the same meaning and defaults as the ones for
2780
merge. The difference is that remerge can (only) be run when there is a
2781
pending merge, and it lets you specify particular files.
2785
$ bzr remerge --show-base
2786
Re-do the merge of all conflicted files, and show the base text in
2787
conflict regions, in addition to the usual THIS and OTHER texts.
2789
$ bzr remerge --merge-type weave --reprocess foobar
2790
Re-do the merge of "foobar", using the weave merge algorithm, with
2791
additional processing to reduce the size of conflict regions.
2793
takes_args = ['file*']
2798
help="Show base revision text in conflicts."),
2801
def run(self, file_list=None, merge_type=None, show_base=False,
2803
if merge_type is None:
2804
merge_type = _mod_merge.Merge3Merger
2805
tree, file_list = tree_files(file_list)
2808
parents = tree.get_parent_ids()
2809
if len(parents) != 2:
2810
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2811
" merges. Not cherrypicking or"
2813
repository = tree.branch.repository
2814
graph = repository.get_graph()
2815
base_revision = graph.find_unique_lca(parents[0], parents[1])
2816
base_tree = repository.revision_tree(base_revision)
2817
other_tree = repository.revision_tree(parents[1])
2818
interesting_ids = None
2820
conflicts = tree.conflicts()
2821
if file_list is not None:
2822
interesting_ids = set()
2823
for filename in file_list:
2824
file_id = tree.path2id(filename)
2826
raise errors.NotVersionedError(filename)
2827
interesting_ids.add(file_id)
2828
if tree.kind(file_id) != "directory":
2831
for name, ie in tree.inventory.iter_entries(file_id):
2832
interesting_ids.add(ie.file_id)
2833
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2835
# Remerge only supports resolving contents conflicts
2836
allowed_conflicts = ('text conflict', 'contents conflict')
2837
restore_files = [c.path for c in conflicts
2838
if c.typestring in allowed_conflicts]
2839
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2840
tree.set_conflicts(ConflictList(new_conflicts))
2841
if file_list is not None:
2842
restore_files = file_list
2843
for filename in restore_files:
2845
restore(tree.abspath(filename))
2846
except errors.NotConflicted:
2848
conflicts = _mod_merge.merge_inner(
2849
tree.branch, other_tree, base_tree,
2851
interesting_ids=interesting_ids,
2852
other_rev_id=parents[1],
2853
merge_type=merge_type,
2854
show_base=show_base,
2855
reprocess=reprocess)
2864
class cmd_revert(Command):
2865
"""Revert files to a previous revision.
2867
Giving a list of files will revert only those files. Otherwise, all files
2868
will be reverted. If the revision is not specified with '--revision', the
2869
last committed revision is used.
2871
To remove only some changes, without reverting to a prior version, use
2872
merge instead. For example, "merge . --r-2..-3" will remove the changes
2873
introduced by -2, without affecting the changes introduced by -1. Or
2874
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2876
By default, any files that have been manually changed will be backed up
2877
first. (Files changed only by merge are not backed up.) Backup files have
2878
'.~#~' appended to their name, where # is a number.
2880
When you provide files, you can use their current pathname or the pathname
2881
from the target revision. So you can use revert to "undelete" a file by
2882
name. If you name a directory, all the contents of that directory will be
2886
_see_also = ['cat', 'export']
2889
Option('no-backup', "Do not save backups of reverted files."),
2891
takes_args = ['file*']
2893
def run(self, revision=None, no_backup=False, file_list=None):
2894
if file_list is not None:
2895
if len(file_list) == 0:
2896
raise errors.BzrCommandError("No files specified")
2900
tree, file_list = tree_files(file_list)
2901
if revision is None:
2902
# FIXME should be tree.last_revision
2903
rev_id = tree.last_revision()
2904
elif len(revision) != 1:
2905
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2907
rev_id = revision[0].in_history(tree.branch).rev_id
2908
pb = ui.ui_factory.nested_progress_bar()
2910
tree.revert(file_list,
2911
tree.branch.repository.revision_tree(rev_id),
2912
not no_backup, pb, report_changes=True)
2917
class cmd_assert_fail(Command):
2918
"""Test reporting of assertion failures"""
2919
# intended just for use in testing
2924
raise AssertionError("always fails")
2927
class cmd_help(Command):
2928
"""Show help on a command or other topic.
2931
_see_also = ['topics']
2933
Option('long', 'Show help on all commands.'),
2935
takes_args = ['topic?']
2936
aliases = ['?', '--help', '-?', '-h']
2939
def run(self, topic=None, long=False):
2941
if topic is None and long:
2943
bzrlib.help.help(topic)
2946
class cmd_shell_complete(Command):
2947
"""Show appropriate completions for context.
2949
For a list of all available commands, say 'bzr shell-complete'.
2951
takes_args = ['context?']
2956
def run(self, context=None):
2957
import shellcomplete
2958
shellcomplete.shellcomplete(context)
2961
class cmd_fetch(Command):
2962
"""Copy in history from another branch but don't merge it.
2964
This is an internal method used for pull and merge.
2967
takes_args = ['from_branch', 'to_branch']
2968
def run(self, from_branch, to_branch):
2969
from bzrlib.fetch import Fetcher
2970
from_b = Branch.open(from_branch)
2971
to_b = Branch.open(to_branch)
2972
Fetcher(to_b, from_b)
2975
class cmd_missing(Command):
2976
"""Show unmerged/unpulled revisions between two branches.
2978
OTHER_BRANCH may be local or remote.
2981
_see_also = ['merge', 'pull']
2982
takes_args = ['other_branch?']
2984
Option('reverse', 'Reverse the order of revisions.'),
2986
'Display changes in the local branch only.'),
2987
Option('this' , 'Same as --mine-only.'),
2988
Option('theirs-only',
2989
'Display changes in the remote branch only.'),
2990
Option('other', 'Same as --theirs-only.'),
2995
encoding_type = 'replace'
2998
def run(self, other_branch=None, reverse=False, mine_only=False,
2999
theirs_only=False, log_format=None, long=False, short=False, line=False,
3000
show_ids=False, verbose=False, this=False, other=False):
3001
from bzrlib.missing import find_unmerged, iter_log_revisions
3002
from bzrlib.log import log_formatter
3009
local_branch = Branch.open_containing(u".")[0]
3010
parent = local_branch.get_parent()
3011
if other_branch is None:
3012
other_branch = parent
3013
if other_branch is None:
3014
raise errors.BzrCommandError("No peer location known or specified.")
3015
display_url = urlutils.unescape_for_display(parent,
3017
print "Using last location: " + display_url
3019
remote_branch = Branch.open(other_branch)
3020
if remote_branch.base == local_branch.base:
3021
remote_branch = local_branch
3022
local_branch.lock_read()
3024
remote_branch.lock_read()
3026
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
3027
if (log_format is None):
3028
log_format = log.log_formatter_registry.get_default(
3030
lf = log_format(to_file=self.outf,
3032
show_timezone='original')
3033
if reverse is False:
3034
local_extra.reverse()
3035
remote_extra.reverse()
3036
if local_extra and not theirs_only:
3037
print "You have %d extra revision(s):" % len(local_extra)
3038
for revision in iter_log_revisions(local_extra,
3039
local_branch.repository,
3041
lf.log_revision(revision)
3042
printed_local = True
3044
printed_local = False
3045
if remote_extra and not mine_only:
3046
if printed_local is True:
3048
print "You are missing %d revision(s):" % len(remote_extra)
3049
for revision in iter_log_revisions(remote_extra,
3050
remote_branch.repository,
3052
lf.log_revision(revision)
3053
if not remote_extra and not local_extra:
3055
print "Branches are up to date."
3059
remote_branch.unlock()
3061
local_branch.unlock()
3062
if not status_code and parent is None and other_branch is not None:
3063
local_branch.lock_write()
3065
# handle race conditions - a parent might be set while we run.
3066
if local_branch.get_parent() is None:
3067
local_branch.set_parent(remote_branch.base)
3069
local_branch.unlock()
3073
class cmd_plugins(Command):
3078
import bzrlib.plugin
3079
from inspect import getdoc
3080
for name, plugin in bzrlib.plugin.all_plugins().items():
3081
if getattr(plugin, '__path__', None) is not None:
3082
print plugin.__path__[0]
3083
elif getattr(plugin, '__file__', None) is not None:
3084
print plugin.__file__
3090
print '\t', d.split('\n')[0]
3093
class cmd_testament(Command):
3094
"""Show testament (signing-form) of a revision."""
3097
Option('long', help='Produce long-format testament.'),
3099
help='Produce a strict-format testament.')]
3100
takes_args = ['branch?']
3102
def run(self, branch=u'.', revision=None, long=False, strict=False):
3103
from bzrlib.testament import Testament, StrictTestament
3105
testament_class = StrictTestament
3107
testament_class = Testament
3108
b = WorkingTree.open_containing(branch)[0].branch
3111
if revision is None:
3112
rev_id = b.last_revision()
3114
rev_id = revision[0].in_history(b).rev_id
3115
t = testament_class.from_revision(b.repository, rev_id)
3117
sys.stdout.writelines(t.as_text_lines())
3119
sys.stdout.write(t.as_short_text())
3124
class cmd_annotate(Command):
3125
"""Show the origin of each line in a file.
3127
This prints out the given file with an annotation on the left side
3128
indicating which revision, author and date introduced the change.
3130
If the origin is the same for a run of consecutive lines, it is
3131
shown only at the top, unless the --all option is given.
3133
# TODO: annotate directories; showing when each file was last changed
3134
# TODO: if the working copy is modified, show annotations on that
3135
# with new uncommitted lines marked
3136
aliases = ['ann', 'blame', 'praise']
3137
takes_args = ['filename']
3138
takes_options = [Option('all', help='Show annotations on all lines.'),
3139
Option('long', help='Show commit date in annotations.'),
3143
encoding_type = 'exact'
3146
def run(self, filename, all=False, long=False, revision=None,
3148
from bzrlib.annotate import annotate_file
3149
tree, relpath = WorkingTree.open_containing(filename)
3150
branch = tree.branch
3153
if revision is None:
3154
revision_id = branch.last_revision()
3155
elif len(revision) != 1:
3156
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3158
revision_id = revision[0].in_history(branch).rev_id
3159
file_id = tree.path2id(relpath)
3161
raise errors.NotVersionedError(filename)
3162
tree = branch.repository.revision_tree(revision_id)
3163
file_version = tree.inventory[file_id].revision
3164
annotate_file(branch, file_version, file_id, long, all, self.outf,
3170
class cmd_re_sign(Command):
3171
"""Create a digital signature for an existing revision."""
3172
# TODO be able to replace existing ones.
3174
hidden = True # is this right ?
3175
takes_args = ['revision_id*']
3176
takes_options = ['revision']
3178
def run(self, revision_id_list=None, revision=None):
3179
import bzrlib.gpg as gpg
3180
if revision_id_list is not None and revision is not None:
3181
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3182
if revision_id_list is None and revision is None:
3183
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3184
b = WorkingTree.open_containing(u'.')[0].branch
3185
gpg_strategy = gpg.GPGStrategy(b.get_config())
3186
if revision_id_list is not None:
3187
for revision_id in revision_id_list:
3188
b.repository.sign_revision(revision_id, gpg_strategy)
3189
elif revision is not None:
3190
if len(revision) == 1:
3191
revno, rev_id = revision[0].in_history(b)
3192
b.repository.sign_revision(rev_id, gpg_strategy)
3193
elif len(revision) == 2:
3194
# are they both on rh- if so we can walk between them
3195
# might be nice to have a range helper for arbitrary
3196
# revision paths. hmm.
3197
from_revno, from_revid = revision[0].in_history(b)
3198
to_revno, to_revid = revision[1].in_history(b)
3199
if to_revid is None:
3200
to_revno = b.revno()
3201
if from_revno is None or to_revno is None:
3202
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3203
for revno in range(from_revno, to_revno + 1):
3204
b.repository.sign_revision(b.get_rev_id(revno),
3207
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3210
class cmd_bind(Command):
3211
"""Convert the current branch into a checkout of the supplied branch.
3213
Once converted into a checkout, commits must succeed on the master branch
3214
before they will be applied to the local branch.
3217
_see_also = ['checkouts', 'unbind']
3218
takes_args = ['location?']
3221
def run(self, location=None):
3222
b, relpath = Branch.open_containing(u'.')
3223
if location is None:
3225
location = b.get_old_bound_location()
3226
except errors.UpgradeRequired:
3227
raise errors.BzrCommandError('No location supplied. '
3228
'This format does not remember old locations.')
3230
if location is None:
3231
raise errors.BzrCommandError('No location supplied and no '
3232
'previous location known')
3233
b_other = Branch.open(location)
3236
except errors.DivergedBranches:
3237
raise errors.BzrCommandError('These branches have diverged.'
3238
' Try merging, and then bind again.')
3241
class cmd_unbind(Command):
3242
"""Convert the current checkout into a regular branch.
3244
After unbinding, the local branch is considered independent and subsequent
3245
commits will be local only.
3248
_see_also = ['checkouts', 'bind']
3253
b, relpath = Branch.open_containing(u'.')
3255
raise errors.BzrCommandError('Local branch is not bound')
3258
class cmd_uncommit(Command):
3259
"""Remove the last committed revision.
3261
--verbose will print out what is being removed.
3262
--dry-run will go through all the motions, but not actually
3265
In the future, uncommit will create a revision bundle, which can then
3269
# TODO: jam 20060108 Add an option to allow uncommit to remove
3270
# unreferenced information in 'branch-as-repository' branches.
3271
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3272
# information in shared branches as well.
3273
_see_also = ['commit']
3274
takes_options = ['verbose', 'revision',
3275
Option('dry-run', help='Don\'t actually make changes.'),
3276
Option('force', help='Say yes to all questions.')]
3277
takes_args = ['location?']
3280
def run(self, location=None,
3281
dry_run=False, verbose=False,
3282
revision=None, force=False):
3283
from bzrlib.log import log_formatter, show_log
3285
from bzrlib.uncommit import uncommit
3287
if location is None:
3289
control, relpath = bzrdir.BzrDir.open_containing(location)
3291
tree = control.open_workingtree()
3293
except (errors.NoWorkingTree, errors.NotLocalUrl):
3295
b = control.open_branch()
3298
if revision is None:
3301
# 'bzr uncommit -r 10' actually means uncommit
3302
# so that the final tree is at revno 10.
3303
# but bzrlib.uncommit.uncommit() actually uncommits
3304
# the revisions that are supplied.
3305
# So we need to offset it by one
3306
revno = revision[0].in_history(b).revno+1
3308
if revno <= b.revno():
3309
rev_id = b.get_rev_id(revno)
3311
self.outf.write('No revisions to uncommit.\n')
3314
lf = log_formatter('short',
3316
show_timezone='original')
3321
direction='forward',
3322
start_revision=revno,
3323
end_revision=b.revno())
3326
print 'Dry-run, pretending to remove the above revisions.'
3328
val = raw_input('Press <enter> to continue')
3330
print 'The above revision(s) will be removed.'
3332
val = raw_input('Are you sure [y/N]? ')
3333
if val.lower() not in ('y', 'yes'):
3337
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3341
class cmd_break_lock(Command):
3342
"""Break a dead lock on a repository, branch or working directory.
3344
CAUTION: Locks should only be broken when you are sure that the process
3345
holding the lock has been stopped.
3347
You can get information on what locks are open via the 'bzr info' command.
3352
takes_args = ['location?']
3354
def run(self, location=None, show=False):
3355
if location is None:
3357
control, relpath = bzrdir.BzrDir.open_containing(location)
3359
control.break_lock()
3360
except NotImplementedError:
3364
class cmd_wait_until_signalled(Command):
3365
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3367
This just prints a line to signal when it is ready, then blocks on stdin.
3373
sys.stdout.write("running\n")
3375
sys.stdin.readline()
3378
class cmd_serve(Command):
3379
"""Run the bzr server."""
3381
aliases = ['server']
3385
help='Serve on stdin/out for use from inetd or sshd.'),
3387
help='Listen for connections on nominated port of the form '
3388
'[hostname:]portnumber. Passing 0 as the port number will '
3389
'result in a dynamically allocated port. The default port is '
3393
help='Serve contents of this directory.',
3395
Option('allow-writes',
3396
help='By default the server is a readonly server. Supplying '
3397
'--allow-writes enables write access to the contents of '
3398
'the served directory and below.'
3402
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3403
from bzrlib.smart import medium, server
3404
from bzrlib.transport import get_transport
3405
from bzrlib.transport.chroot import ChrootServer
3406
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3407
if directory is None:
3408
directory = os.getcwd()
3409
url = urlutils.local_path_to_url(directory)
3410
if not allow_writes:
3411
url = 'readonly+' + url
3412
chroot_server = ChrootServer(get_transport(url))
3413
chroot_server.setUp()
3414
t = get_transport(chroot_server.get_url())
3416
smart_server = medium.SmartServerPipeStreamMedium(
3417
sys.stdin, sys.stdout, t)
3419
host = BZR_DEFAULT_INTERFACE
3421
port = BZR_DEFAULT_PORT
3424
host, port = port.split(':')
3426
smart_server = server.SmartTCPServer(t, host=host, port=port)
3427
print 'listening on port: ', smart_server.port
3429
# for the duration of this server, no UI output is permitted.
3430
# note that this may cause problems with blackbox tests. This should
3431
# be changed with care though, as we dont want to use bandwidth sending
3432
# progress over stderr to smart server clients!
3433
old_factory = ui.ui_factory
3435
ui.ui_factory = ui.SilentUIFactory()
3436
smart_server.serve()
3438
ui.ui_factory = old_factory
3441
class cmd_join(Command):
3442
"""Combine a subtree into its containing tree.
3444
This command is for experimental use only. It requires the target tree
3445
to be in dirstate-with-subtree format, which cannot be converted into
3448
The TREE argument should be an independent tree, inside another tree, but
3449
not part of it. (Such trees can be produced by "bzr split", but also by
3450
running "bzr branch" with the target inside a tree.)
3452
The result is a combined tree, with the subtree no longer an independant
3453
part. This is marked as a merge of the subtree into the containing tree,
3454
and all history is preserved.
3456
If --reference is specified, the subtree retains its independence. It can
3457
be branched by itself, and can be part of multiple projects at the same
3458
time. But operations performed in the containing tree, such as commit
3459
and merge, will recurse into the subtree.
3462
_see_also = ['split']
3463
takes_args = ['tree']
3465
Option('reference', help='Join by reference.'),
3469
def run(self, tree, reference=False):
3470
sub_tree = WorkingTree.open(tree)
3471
parent_dir = osutils.dirname(sub_tree.basedir)
3472
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3473
repo = containing_tree.branch.repository
3474
if not repo.supports_rich_root():
3475
raise errors.BzrCommandError(
3476
"Can't join trees because %s doesn't support rich root data.\n"
3477
"You can use bzr upgrade on the repository."
3481
containing_tree.add_reference(sub_tree)
3482
except errors.BadReferenceTarget, e:
3483
# XXX: Would be better to just raise a nicely printable
3484
# exception from the real origin. Also below. mbp 20070306
3485
raise errors.BzrCommandError("Cannot join %s. %s" %
3489
containing_tree.subsume(sub_tree)
3490
except errors.BadSubsumeSource, e:
3491
raise errors.BzrCommandError("Cannot join %s. %s" %
3495
class cmd_split(Command):
3496
"""Split a tree into two trees.
3498
This command is for experimental use only. It requires the target tree
3499
to be in dirstate-with-subtree format, which cannot be converted into
3502
The TREE argument should be a subdirectory of a working tree. That
3503
subdirectory will be converted into an independent tree, with its own
3504
branch. Commits in the top-level tree will not apply to the new subtree.
3505
If you want that behavior, do "bzr join --reference TREE".
3508
_see_also = ['join']
3509
takes_args = ['tree']
3513
def run(self, tree):
3514
containing_tree, subdir = WorkingTree.open_containing(tree)
3515
sub_id = containing_tree.path2id(subdir)
3517
raise errors.NotVersionedError(subdir)
3519
containing_tree.extract(sub_id)
3520
except errors.RootNotRich:
3521
raise errors.UpgradeRequired(containing_tree.branch.base)
3525
class cmd_merge_directive(Command):
3526
"""Generate a merge directive for auto-merge tools.
3528
A directive requests a merge to be performed, and also provides all the
3529
information necessary to do so. This means it must either include a
3530
revision bundle, or the location of a branch containing the desired
3533
A submit branch (the location to merge into) must be supplied the first
3534
time the command is issued. After it has been supplied once, it will
3535
be remembered as the default.
3537
A public branch is optional if a revision bundle is supplied, but required
3538
if --diff or --plain is specified. It will be remembered as the default
3539
after the first use.
3542
takes_args = ['submit_branch?', 'public_branch?']
3545
RegistryOption.from_kwargs('patch-type',
3546
'The type of patch to include in the directive',
3548
value_switches=True,
3550
bundle='Bazaar revision bundle (default).',
3551
diff='Normal unified diff.',
3552
plain='No patch, just directive.'),
3553
Option('sign', help='GPG-sign the directive.'), 'revision',
3554
Option('mail-to', type=str,
3555
help='Instead of printing the directive, email to this address.'),
3556
Option('message', type=str, short_name='m',
3557
help='Message to use when committing this merge.')
3560
encoding_type = 'exact'
3562
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3563
sign=False, revision=None, mail_to=None, message=None):
3564
from bzrlib.revision import ensure_null, NULL_REVISION
3565
if patch_type == 'plain':
3567
branch = Branch.open('.')
3568
stored_submit_branch = branch.get_submit_branch()
3569
if submit_branch is None:
3570
submit_branch = stored_submit_branch
3572
if stored_submit_branch is None:
3573
branch.set_submit_branch(submit_branch)
3574
if submit_branch is None:
3575
submit_branch = branch.get_parent()
3576
if submit_branch is None:
3577
raise errors.BzrCommandError('No submit branch specified or known')
3579
stored_public_branch = branch.get_public_branch()
3580
if public_branch is None:
3581
public_branch = stored_public_branch
3582
elif stored_public_branch is None:
3583
branch.set_public_branch(public_branch)
3584
if patch_type != "bundle" and public_branch is None:
3585
raise errors.BzrCommandError('No public branch specified or'
3587
if revision is not None:
3588
if len(revision) != 1:
3589
raise errors.BzrCommandError('bzr merge-directive takes '
3590
'exactly one revision identifier')
3592
revision_id = revision[0].in_history(branch).rev_id
3594
revision_id = branch.last_revision()
3595
revision_id = ensure_null(revision_id)
3596
if revision_id == NULL_REVISION:
3597
raise errors.BzrCommandError('No revisions to bundle.')
3598
directive = merge_directive.MergeDirective.from_objects(
3599
branch.repository, revision_id, time.time(),
3600
osutils.local_time_offset(), submit_branch,
3601
public_branch=public_branch, patch_type=patch_type,
3605
self.outf.write(directive.to_signed(branch))
3607
self.outf.writelines(directive.to_lines())
3609
message = directive.to_email(mail_to, branch, sign)
3610
s = SMTPConnection(branch.get_config())
3611
s.send_email(message)
3614
class cmd_tag(Command):
3615
"""Create a tag naming a revision.
3617
Tags give human-meaningful names to revisions. Commands that take a -r
3618
(--revision) option can be given -rtag:X, where X is any previously
3621
Tags are stored in the branch. Tags are copied from one branch to another
3622
along when you branch, push, pull or merge.
3624
It is an error to give a tag name that already exists unless you pass
3625
--force, in which case the tag is moved to point to the new revision.
3628
_see_also = ['commit', 'tags']
3629
takes_args = ['tag_name']
3632
help='Delete this tag rather than placing it.',
3635
help='Branch in which to place the tag.',
3640
help='Replace existing tags.',
3645
def run(self, tag_name,
3651
branch, relpath = Branch.open_containing(directory)
3655
branch.tags.delete_tag(tag_name)
3656
self.outf.write('Deleted tag %s.\n' % tag_name)
3659
if len(revision) != 1:
3660
raise errors.BzrCommandError(
3661
"Tags can only be placed on a single revision, "
3663
revision_id = revision[0].in_history(branch).rev_id
3665
revision_id = branch.last_revision()
3666
if (not force) and branch.tags.has_tag(tag_name):
3667
raise errors.TagAlreadyExists(tag_name)
3668
branch.tags.set_tag(tag_name, revision_id)
3669
self.outf.write('Created tag %s.\n' % tag_name)
3674
class cmd_tags(Command):
3677
This tag shows a table of tag names and the revisions they reference.
3683
help='Branch whose tags should be displayed.',
3693
branch, relpath = Branch.open_containing(directory)
3694
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3695
self.outf.write('%-20s %s\n' % (tag_name, target))
3698
# command-line interpretation helper for merge-related commands
3699
def _merge_helper(other_revision, base_revision,
3700
check_clean=True, ignore_zero=False,
3701
this_dir=None, backup_files=False,
3703
file_list=None, show_base=False, reprocess=False,
3706
change_reporter=None,
3708
"""Merge changes into a tree.
3711
list(path, revno) Base for three-way merge.
3712
If [None, None] then a base will be automatically determined.
3714
list(path, revno) Other revision for three-way merge.
3716
Directory to merge changes into; '.' by default.
3718
If true, this_dir must have no uncommitted changes before the
3720
ignore_zero - If true, suppress the "zero conflicts" message when
3721
there are no conflicts; should be set when doing something we expect
3722
to complete perfectly.
3723
file_list - If supplied, merge only changes to selected files.
3725
All available ancestors of other_revision and base_revision are
3726
automatically pulled into the branch.
3728
The revno may be -1 to indicate the last revision on the branch, which is
3731
This function is intended for use from the command line; programmatic
3732
clients might prefer to call merge.merge_inner(), which has less magic
3735
# Loading it late, so that we don't always have to import bzrlib.merge
3736
if merge_type is None:
3737
merge_type = _mod_merge.Merge3Merger
3738
if this_dir is None:
3740
this_tree = WorkingTree.open_containing(this_dir)[0]
3741
if show_base and not merge_type is _mod_merge.Merge3Merger:
3742
raise errors.BzrCommandError("Show-base is not supported for this merge"
3743
" type. %s" % merge_type)
3744
if reprocess and not merge_type.supports_reprocess:
3745
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3746
" type %s." % merge_type)
3747
if reprocess and show_base:
3748
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3749
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3750
# only want to take out a lock_tree_write() if we don't have to pull
3751
# any ancestry. But merge might fetch ancestry in the middle, in
3752
# which case we would need a lock_write().
3753
# Because we cannot upgrade locks, for now we live with the fact that
3754
# the tree will be locked multiple times during a merge. (Maybe
3755
# read-only some of the time, but it means things will get read
3758
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3759
pb=pb, change_reporter=change_reporter)
3760
merger.pp = ProgressPhase("Merge phase", 5, pb)
3761
merger.pp.next_phase()
3762
merger.check_basis(check_clean)
3763
if other_rev_id is not None:
3764
merger.set_other_revision(other_rev_id, this_tree.branch)
3766
merger.set_other(other_revision)
3767
merger.pp.next_phase()
3768
merger.set_base(base_revision)
3769
if merger.base_rev_id == merger.other_rev_id:
3770
note('Nothing to do.')
3772
if file_list is None:
3773
if pull and merger.base_rev_id == merger.this_rev_id:
3774
# FIXME: deduplicate with pull
3775
result = merger.this_tree.pull(merger.this_branch,
3776
False, merger.other_rev_id)
3777
if result.old_revid == result.new_revid:
3778
note('No revisions to pull.')
3780
note('Now on revision %d.' % result.new_revno)
3782
merger.backup_files = backup_files
3783
merger.merge_type = merge_type
3784
merger.set_interesting_files(file_list)
3785
merger.show_base = show_base
3786
merger.reprocess = reprocess
3787
conflicts = merger.do_merge()
3788
if file_list is None:
3789
merger.set_pending()
3795
def _create_prefix(cur_transport):
3796
needed = [cur_transport]
3797
# Recurse upwards until we can create a directory successfully
3799
new_transport = cur_transport.clone('..')
3800
if new_transport.base == cur_transport.base:
3801
raise errors.BzrCommandError("Failed to create path"
3805
new_transport.mkdir('.')
3806
except errors.NoSuchFile:
3807
needed.append(new_transport)
3808
cur_transport = new_transport
3812
# Now we only need to create child directories
3814
cur_transport = needed.pop()
3815
cur_transport.ensure_base()
3818
merge = _merge_helper
3821
# these get imported and then picked up by the scan for cmd_*
3822
# TODO: Some more consistent way to split command definitions across files;
3823
# we do need to load at least some information about them to know of
3824
# aliases. ideally we would avoid loading the implementation until the
3825
# details were needed.
3826
from bzrlib.cmd_version_info import cmd_version_info
3827
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3828
from bzrlib.bundle.commands import cmd_bundle_revisions
3829
from bzrlib.sign_my_commits import cmd_sign_my_commits
3830
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
3831
cmd_weave_plan_merge, cmd_weave_merge_text