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(), """
54
from bzrlib.branch import Branch
55
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revision import common_ancestor
58
from bzrlib.revisionspec import RevisionSpec
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import ListOption, Option, RegistryOption
64
from bzrlib.progress import DummyProgress, ProgressPhase
65
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
68
def tree_files(file_list, default_branch=u'.'):
70
return internal_tree_files(file_list, default_branch)
71
except errors.FileInWrongBranch, e:
72
raise errors.BzrCommandError("%s is not in the same branch as %s" %
73
(e.path, file_list[0]))
76
# XXX: Bad function name; should possibly also be a class method of
77
# WorkingTree rather than a function.
78
def internal_tree_files(file_list, default_branch=u'.'):
79
"""Convert command-line paths to a WorkingTree and relative paths.
81
This is typically used for command-line processors that take one or
82
more filenames, and infer the workingtree that contains them.
84
The filenames given are not required to exist.
86
:param file_list: Filenames to convert.
88
:param default_branch: Fallback tree path to use if file_list is empty or
91
:return: workingtree, [relative_paths]
93
if file_list is None or len(file_list) == 0:
94
return WorkingTree.open_containing(default_branch)[0], file_list
95
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
97
for filename in file_list:
99
new_list.append(tree.relpath(osutils.dereference_path(filename)))
100
except errors.PathNotChild:
101
raise errors.FileInWrongBranch(tree.branch, filename)
102
return tree, new_list
105
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
106
def get_format_type(typestring):
107
"""Parse and return a format specifier."""
108
# Have to use BzrDirMetaFormat1 directly, so that
109
# RepositoryFormat.set_default_format works
110
if typestring == "default":
111
return bzrdir.BzrDirMetaFormat1()
113
return bzrdir.format_registry.make_bzrdir(typestring)
115
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
116
raise errors.BzrCommandError(msg)
119
# TODO: Make sure no commands unconditionally use the working directory as a
120
# branch. If a filename argument is used, the first of them should be used to
121
# specify the branch. (Perhaps this can be factored out into some kind of
122
# Argument class, representing a file in a branch, where the first occurrence
125
class cmd_status(Command):
126
"""Display status summary.
128
This reports on versioned and unknown files, reporting them
129
grouped by state. Possible states are:
132
Versioned in the working copy but not in the previous revision.
135
Versioned in the previous revision but removed or deleted
139
Path of this file changed from the previous revision;
140
the text may also have changed. This includes files whose
141
parent directory was renamed.
144
Text has changed since the previous revision.
147
File kind has been changed (e.g. from file to directory).
150
Not versioned and not matching an ignore pattern.
152
To see ignored files use 'bzr ignored'. For details on the
153
changes to file texts, use 'bzr diff'.
155
--short gives a status flags for each item, similar to the SVN's status
158
Column 1: versioning / renames
164
P Entry for a pending merge (not a file)
173
* The execute bit was changed
175
If no arguments are specified, the status of the entire working
176
directory is shown. Otherwise, only the status of the specified
177
files or directories is reported. If a directory is given, status
178
is reported for everything inside that directory.
180
If a revision argument is given, the status is calculated against
181
that revision, or between two revisions if two are provided.
184
# TODO: --no-recurse, --recurse options
186
takes_args = ['file*']
187
takes_options = ['show-ids', 'revision',
188
Option('short', help='Give short SVN-style status lines'),
189
Option('versioned', help='Only show versioned files')]
190
aliases = ['st', 'stat']
192
encoding_type = 'replace'
193
_see_also = ['diff', 'revert']
196
def run(self, show_ids=False, file_list=None, revision=None, short=False,
198
from bzrlib.status import show_tree_status
200
tree, file_list = tree_files(file_list)
202
show_tree_status(tree, show_ids=show_ids,
203
specific_files=file_list, revision=revision,
204
to_file=self.outf, short=short, versioned=versioned)
207
class cmd_cat_revision(Command):
208
"""Write out metadata for a revision.
210
The revision to print can either be specified by a specific
211
revision identifier, or you can use --revision.
215
takes_args = ['revision_id?']
216
takes_options = ['revision']
217
# cat-revision is more for frontends so should be exact
221
def run(self, revision_id=None, revision=None):
223
revision_id = osutils.safe_revision_id(revision_id, warn=False)
224
if revision_id is not None and revision is not None:
225
raise errors.BzrCommandError('You can only supply one of'
226
' revision_id or --revision')
227
if revision_id is None and revision is None:
228
raise errors.BzrCommandError('You must supply either'
229
' --revision or a revision_id')
230
b = WorkingTree.open_containing(u'.')[0].branch
232
# TODO: jam 20060112 should cat-revision always output utf-8?
233
if revision_id is not None:
234
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
235
elif revision is not None:
238
raise errors.BzrCommandError('You cannot specify a NULL'
240
revno, rev_id = rev.in_history(b)
241
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
244
class cmd_remove_tree(Command):
245
"""Remove the working tree from a given branch/checkout.
247
Since a lightweight checkout is little more than a working tree
248
this will refuse to run against one.
250
To re-create the working tree, use "bzr checkout".
252
_see_also = ['checkout', 'working-trees']
254
takes_args = ['location?']
256
def run(self, location='.'):
257
d = bzrdir.BzrDir.open(location)
260
working = d.open_workingtree()
261
except errors.NoWorkingTree:
262
raise errors.BzrCommandError("No working tree to remove")
263
except errors.NotLocalUrl:
264
raise errors.BzrCommandError("You cannot remove the working tree of a "
267
working_path = working.bzrdir.root_transport.base
268
branch_path = working.branch.bzrdir.root_transport.base
269
if working_path != branch_path:
270
raise errors.BzrCommandError("You cannot remove the working tree from "
271
"a lightweight checkout")
273
d.destroy_workingtree()
276
class cmd_revno(Command):
277
"""Show current revision number.
279
This is equal to the number of revisions on this branch.
283
takes_args = ['location?']
286
def run(self, location=u'.'):
287
self.outf.write(str(Branch.open_containing(location)[0].revno()))
288
self.outf.write('\n')
291
class cmd_revision_info(Command):
292
"""Show revision number and revision id for a given revision identifier.
295
takes_args = ['revision_info*']
296
takes_options = ['revision']
299
def run(self, revision=None, revision_info_list=[]):
302
if revision is not None:
303
revs.extend(revision)
304
if revision_info_list is not None:
305
for rev in revision_info_list:
306
revs.append(RevisionSpec.from_string(rev))
308
raise errors.BzrCommandError('You must supply a revision identifier')
310
b = WorkingTree.open_containing(u'.')[0].branch
313
revinfo = rev.in_history(b)
314
if revinfo.revno is None:
315
print ' %s' % revinfo.rev_id
317
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
320
class cmd_add(Command):
321
"""Add specified files or directories.
323
In non-recursive mode, all the named items are added, regardless
324
of whether they were previously ignored. A warning is given if
325
any of the named files are already versioned.
327
In recursive mode (the default), files are treated the same way
328
but the behaviour for directories is different. Directories that
329
are already versioned do not give a warning. All directories,
330
whether already versioned or not, are searched for files or
331
subdirectories that are neither versioned or ignored, and these
332
are added. This search proceeds recursively into versioned
333
directories. If no names are given '.' is assumed.
335
Therefore simply saying 'bzr add' will version all files that
336
are currently unknown.
338
Adding a file whose parent directory is not versioned will
339
implicitly add the parent, and so on up to the root. This means
340
you should never need to explicitly add a directory, they'll just
341
get added when you add a file in the directory.
343
--dry-run will show which files would be added, but not actually
346
--file-ids-from will try to use the file ids from the supplied path.
347
It looks up ids trying to find a matching parent directory with the
348
same filename, and then by pure path. This option is rarely needed
349
but can be useful when adding the same logical file into two
350
branches that will be merged later (without showing the two different
351
adds as a conflict). It is also useful when merging another project
352
into a subdirectory of this one.
354
takes_args = ['file*']
355
takes_options = ['no-recurse', 'dry-run', 'verbose',
356
Option('file-ids-from', type=unicode,
357
help='Lookup file ids from here')]
358
encoding_type = 'replace'
359
_see_also = ['remove']
361
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
366
if file_ids_from is not None:
368
base_tree, base_path = WorkingTree.open_containing(
370
except errors.NoWorkingTree:
371
base_branch, base_path = Branch.open_containing(
373
base_tree = base_branch.basis_tree()
375
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
376
to_file=self.outf, should_print=(not is_quiet()))
378
action = bzrlib.add.AddAction(to_file=self.outf,
379
should_print=(not is_quiet()))
382
base_tree.lock_read()
384
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
385
action=action, save=not dry_run)
387
if base_tree is not None:
391
for glob in sorted(ignored.keys()):
392
for path in ignored[glob]:
393
self.outf.write("ignored %s matching \"%s\"\n"
397
for glob, paths in ignored.items():
398
match_len += len(paths)
399
self.outf.write("ignored %d file(s).\n" % match_len)
400
self.outf.write("If you wish to add some of these files,"
401
" please add them by name.\n")
404
class cmd_mkdir(Command):
405
"""Create a new versioned directory.
407
This is equivalent to creating the directory and then adding it.
410
takes_args = ['dir+']
411
encoding_type = 'replace'
413
def run(self, dir_list):
416
wt, dd = WorkingTree.open_containing(d)
418
self.outf.write('added %s\n' % d)
421
class cmd_relpath(Command):
422
"""Show path of a file relative to root"""
424
takes_args = ['filename']
428
def run(self, filename):
429
# TODO: jam 20050106 Can relpath return a munged path if
430
# sys.stdout encoding cannot represent it?
431
tree, relpath = WorkingTree.open_containing(filename)
432
self.outf.write(relpath)
433
self.outf.write('\n')
436
class cmd_inventory(Command):
437
"""Show inventory of the current working copy or a revision.
439
It is possible to limit the output to a particular entry
440
type using the --kind option. For example: --kind file.
442
It is also possible to restrict the list of files to a specific
443
set. For example: bzr inventory --show-ids this/file
448
takes_options = ['revision', 'show-ids', 'kind']
449
takes_args = ['file*']
452
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
453
if kind and kind not in ['file', 'directory', 'symlink']:
454
raise errors.BzrCommandError('invalid kind specified')
456
work_tree, file_list = tree_files(file_list)
457
work_tree.lock_read()
459
if revision is not None:
460
if len(revision) > 1:
461
raise errors.BzrCommandError(
462
'bzr inventory --revision takes exactly one revision'
464
revision_id = revision[0].in_history(work_tree.branch).rev_id
465
tree = work_tree.branch.repository.revision_tree(revision_id)
467
extra_trees = [work_tree]
473
if file_list is not None:
474
file_ids = tree.paths2ids(file_list, trees=extra_trees,
475
require_versioned=True)
476
# find_ids_across_trees may include some paths that don't
478
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
479
for file_id in file_ids if file_id in tree)
481
entries = tree.inventory.entries()
484
if tree is not work_tree:
487
for path, entry in entries:
488
if kind and kind != entry.kind:
491
self.outf.write('%-50s %s\n' % (path, entry.file_id))
493
self.outf.write(path)
494
self.outf.write('\n')
497
class cmd_mv(Command):
498
"""Move or rename a file.
501
bzr mv OLDNAME NEWNAME
502
bzr mv SOURCE... DESTINATION
504
If the last argument is a versioned directory, all the other names
505
are moved into it. Otherwise, there must be exactly two arguments
506
and the file is changed to a new name.
508
If OLDNAME does not exist on the filesystem but is versioned and
509
NEWNAME does exist on the filesystem but is not versioned, mv
510
assumes that the file has been manually moved and only updates
511
its internal inventory to reflect that change.
512
The same is valid when moving many SOURCE files to a DESTINATION.
514
Files cannot be moved between branches.
517
takes_args = ['names*']
518
takes_options = [Option("after", help="move only the bzr identifier"
519
" of the file (file has already been moved). Use this flag if"
520
" bzr is not able to detect this itself.")]
521
aliases = ['move', 'rename']
522
encoding_type = 'replace'
524
def run(self, names_list, after=False):
525
if names_list is None:
528
if len(names_list) < 2:
529
raise errors.BzrCommandError("missing file argument")
530
tree, rel_names = tree_files(names_list)
532
if os.path.isdir(names_list[-1]):
533
# move into existing directory
534
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
535
self.outf.write("%s => %s\n" % pair)
537
if len(names_list) != 2:
538
raise errors.BzrCommandError('to mv multiple files the'
539
' destination must be a versioned'
541
tree.rename_one(rel_names[0], rel_names[1], after=after)
542
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
545
class cmd_pull(Command):
546
"""Turn this branch into a mirror of another branch.
548
This command only works on branches that have not diverged. Branches are
549
considered diverged if the destination branch's most recent commit is one
550
that has not been merged (directly or indirectly) into the parent.
552
If branches have diverged, you can use 'bzr merge' to integrate the changes
553
from one into the other. Once one branch has merged, the other should
554
be able to pull it again.
556
If you want to forget your local changes and just update your branch to
557
match the remote one, use pull --overwrite.
559
If there is no default location set, the first pull will set it. After
560
that, you can omit the location to use the default. To change the
561
default, use --remember. The value will only be saved if the remote
562
location can be accessed.
565
_see_also = ['push', 'update']
566
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
568
help='branch to pull into, '
569
'rather than the one containing the working directory',
574
takes_args = ['location?']
575
encoding_type = 'replace'
577
def run(self, location=None, remember=False, overwrite=False,
578
revision=None, verbose=False,
580
from bzrlib.tag import _merge_tags_if_possible
581
# FIXME: too much stuff is in the command class
584
if directory is None:
587
tree_to = WorkingTree.open_containing(directory)[0]
588
branch_to = tree_to.branch
589
except errors.NoWorkingTree:
591
branch_to = Branch.open_containing(directory)[0]
594
if location is not None:
596
mergeable = bundle.read_mergeable_from_url(
598
except errors.NotABundle:
599
pass # Continue on considering this url a Branch
601
stored_loc = branch_to.get_parent()
603
if stored_loc is None:
604
raise errors.BzrCommandError("No pull location known or"
607
display_url = urlutils.unescape_for_display(stored_loc,
609
self.outf.write("Using saved location: %s\n" % display_url)
610
location = stored_loc
612
if mergeable is not None:
613
if revision is not None:
614
raise errors.BzrCommandError(
615
'Cannot use -r with merge directives or bundles')
616
revision_id = mergeable.install_revisions(branch_to.repository)
617
branch_from = branch_to
619
branch_from = Branch.open(location)
621
if branch_to.get_parent() is None or remember:
622
branch_to.set_parent(branch_from.base)
624
if revision is not None:
625
if len(revision) == 1:
626
revision_id = revision[0].in_history(branch_from).rev_id
628
raise errors.BzrCommandError(
629
'bzr pull --revision takes one value.')
631
old_rh = branch_to.revision_history()
632
if tree_to is not None:
633
result = tree_to.pull(branch_from, overwrite, revision_id,
634
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
636
result = branch_to.pull(branch_from, overwrite, revision_id)
638
result.report(self.outf)
640
from bzrlib.log import show_changed_revisions
641
new_rh = branch_to.revision_history()
642
show_changed_revisions(branch_to, old_rh, new_rh,
646
class cmd_push(Command):
647
"""Update a mirror of this branch.
649
The target branch will not have its working tree populated because this
650
is both expensive, and is not supported on remote file systems.
652
Some smart servers or protocols *may* put the working tree in place in
655
This command only works on branches that have not diverged. Branches are
656
considered diverged if the destination branch's most recent commit is one
657
that has not been merged (directly or indirectly) by the source branch.
659
If branches have diverged, you can use 'bzr push --overwrite' to replace
660
the other branch completely, discarding its unmerged changes.
662
If you want to ensure you have the different changes in the other branch,
663
do a merge (see bzr help merge) from the other branch, and commit that.
664
After that you will be able to do a push without '--overwrite'.
666
If there is no default push location set, the first push will set it.
667
After that, you can omit the location to use the default. To change the
668
default, use --remember. The value will only be saved if the remote
669
location can be accessed.
672
_see_also = ['pull', 'update', 'working-trees']
673
takes_options = ['remember', 'overwrite', 'verbose',
674
Option('create-prefix',
675
help='Create the path leading up to the branch '
676
'if it does not already exist'),
678
help='branch to push from, '
679
'rather than the one containing the working directory',
683
Option('use-existing-dir',
684
help='By default push will fail if the target'
685
' directory exists, but does not already'
686
' have a control directory. This flag will'
687
' allow push to proceed.'),
689
takes_args = ['location?']
690
encoding_type = 'replace'
692
def run(self, location=None, remember=False, overwrite=False,
693
create_prefix=False, verbose=False,
694
use_existing_dir=False,
696
# FIXME: Way too big! Put this into a function called from the
698
if directory is None:
700
br_from = Branch.open_containing(directory)[0]
701
stored_loc = br_from.get_push_location()
703
if stored_loc is None:
704
raise errors.BzrCommandError("No push location known or specified.")
706
display_url = urlutils.unescape_for_display(stored_loc,
708
self.outf.write("Using saved location: %s\n" % display_url)
709
location = stored_loc
711
to_transport = transport.get_transport(location)
713
br_to = repository_to = dir_to = None
715
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
716
except errors.NotBranchError:
717
pass # Didn't find anything
719
# If we can open a branch, use its direct repository, otherwise see
720
# if there is a repository without a branch.
722
br_to = dir_to.open_branch()
723
except errors.NotBranchError:
724
# Didn't find a branch, can we find a repository?
726
repository_to = dir_to.find_repository()
727
except errors.NoRepositoryPresent:
730
# Found a branch, so we must have found a repository
731
repository_to = br_to.repository
735
# The destination doesn't exist; create it.
736
# XXX: Refactor the create_prefix/no_create_prefix code into a
737
# common helper function
739
to_transport.mkdir('.')
740
except errors.FileExists:
741
if not use_existing_dir:
742
raise errors.BzrCommandError("Target directory %s"
743
" already exists, but does not have a valid .bzr"
744
" directory. Supply --use-existing-dir to push"
745
" there anyway." % location)
746
except errors.NoSuchFile:
747
if not create_prefix:
748
raise errors.BzrCommandError("Parent directory of %s"
750
"\nYou may supply --create-prefix to create all"
751
" leading parent directories."
754
cur_transport = to_transport
755
needed = [cur_transport]
756
# Recurse upwards until we can create a directory successfully
758
new_transport = cur_transport.clone('..')
759
if new_transport.base == cur_transport.base:
760
raise errors.BzrCommandError("Failed to create path"
764
new_transport.mkdir('.')
765
except errors.NoSuchFile:
766
needed.append(new_transport)
767
cur_transport = new_transport
771
# Now we only need to create child directories
773
cur_transport = needed.pop()
774
cur_transport.ensure_base()
776
# Now the target directory exists, but doesn't have a .bzr
777
# directory. So we need to create it, along with any work to create
778
# all of the dependent branches, etc.
779
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
780
revision_id=br_from.last_revision())
781
br_to = dir_to.open_branch()
782
# TODO: Some more useful message about what was copied
783
note('Created new branch.')
784
# We successfully created the target, remember it
785
if br_from.get_push_location() is None or remember:
786
br_from.set_push_location(br_to.base)
787
elif repository_to is None:
788
# we have a bzrdir but no branch or repository
789
# XXX: Figure out what to do other than complain.
790
raise errors.BzrCommandError("At %s you have a valid .bzr control"
791
" directory, but not a branch or repository. This is an"
792
" unsupported configuration. Please move the target directory"
793
" out of the way and try again."
796
# We have a repository but no branch, copy the revisions, and then
798
last_revision_id = br_from.last_revision()
799
repository_to.fetch(br_from.repository,
800
revision_id=last_revision_id)
801
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
802
note('Created new branch.')
803
if br_from.get_push_location() is None or remember:
804
br_from.set_push_location(br_to.base)
805
else: # We have a valid to branch
806
# We were able to connect to the remote location, so remember it
807
# we don't need to successfully push because of possible divergence.
808
if br_from.get_push_location() is None or remember:
809
br_from.set_push_location(br_to.base)
810
old_rh = br_to.revision_history()
813
tree_to = dir_to.open_workingtree()
814
except errors.NotLocalUrl:
815
warning("This transport does not update the working "
816
"tree of: %s. See 'bzr help working-trees' for "
817
"more information." % br_to.base)
818
push_result = br_from.push(br_to, overwrite)
819
except errors.NoWorkingTree:
820
push_result = br_from.push(br_to, overwrite)
824
push_result = br_from.push(tree_to.branch, overwrite)
828
except errors.DivergedBranches:
829
raise errors.BzrCommandError('These branches have diverged.'
830
' Try using "merge" and then "push".')
831
if push_result is not None:
832
push_result.report(self.outf)
834
new_rh = br_to.revision_history()
837
from bzrlib.log import show_changed_revisions
838
show_changed_revisions(br_to, old_rh, new_rh,
841
# we probably did a clone rather than a push, so a message was
846
class cmd_branch(Command):
847
"""Create a new copy of a branch.
849
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
850
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
852
To retrieve the branch as of a particular revision, supply the --revision
853
parameter, as in "branch foo/bar -r 5".
856
_see_also = ['checkout']
857
takes_args = ['from_location', 'to_location?']
858
takes_options = ['revision']
859
aliases = ['get', 'clone']
861
def run(self, from_location, to_location=None, revision=None):
862
from bzrlib.tag import _merge_tags_if_possible
865
elif len(revision) > 1:
866
raise errors.BzrCommandError(
867
'bzr branch --revision takes exactly 1 revision value')
869
br_from = Branch.open(from_location)
872
if len(revision) == 1 and revision[0] is not None:
873
revision_id = revision[0].in_history(br_from)[1]
875
# FIXME - wt.last_revision, fallback to branch, fall back to
876
# None or perhaps NULL_REVISION to mean copy nothing
878
revision_id = br_from.last_revision()
879
if to_location is None:
880
to_location = os.path.basename(from_location.rstrip("/\\"))
883
name = os.path.basename(to_location) + '\n'
885
to_transport = transport.get_transport(to_location)
887
to_transport.mkdir('.')
888
except errors.FileExists:
889
raise errors.BzrCommandError('Target directory "%s" already'
890
' exists.' % to_location)
891
except errors.NoSuchFile:
892
raise errors.BzrCommandError('Parent of "%s" does not exist.'
895
# preserve whatever source format we have.
896
dir = br_from.bzrdir.sprout(to_transport.base, revision_id)
897
branch = dir.open_branch()
898
except errors.NoSuchRevision:
899
to_transport.delete_tree('.')
900
msg = "The branch %s has no revision %s." % (from_location, revision[0])
901
raise errors.BzrCommandError(msg)
903
branch.control_files.put_utf8('branch-name', name)
904
_merge_tags_if_possible(br_from, branch)
905
note('Branched %d revision(s).' % branch.revno())
910
class cmd_checkout(Command):
911
"""Create a new checkout of an existing branch.
913
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
914
the branch found in '.'. This is useful if you have removed the working tree
915
or if it was never created - i.e. if you pushed the branch to its current
918
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
919
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
921
To retrieve the branch as of a particular revision, supply the --revision
922
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
923
out of date [so you cannot commit] but it may be useful (i.e. to examine old
927
_see_also = ['checkouts', 'branch']
928
takes_args = ['branch_location?', 'to_location?']
929
takes_options = ['revision',
930
Option('lightweight',
931
help="perform a lightweight checkout. Lightweight "
932
"checkouts depend on access to the branch for "
933
"every operation. Normal checkouts can perform "
934
"common operations like diff and status without "
935
"such access, and also support local commits."
940
def run(self, branch_location=None, to_location=None, revision=None,
944
elif len(revision) > 1:
945
raise errors.BzrCommandError(
946
'bzr checkout --revision takes exactly 1 revision value')
947
if branch_location is None:
948
branch_location = osutils.getcwd()
949
to_location = branch_location
950
source = Branch.open(branch_location)
951
if len(revision) == 1 and revision[0] is not None:
952
revision_id = revision[0].in_history(source)[1]
955
if to_location is None:
956
to_location = os.path.basename(branch_location.rstrip("/\\"))
957
# if the source and to_location are the same,
958
# and there is no working tree,
959
# then reconstitute a branch
960
if (osutils.abspath(to_location) ==
961
osutils.abspath(branch_location)):
963
source.bzrdir.open_workingtree()
964
except errors.NoWorkingTree:
965
source.bzrdir.create_workingtree()
968
os.mkdir(to_location)
970
if e.errno == errno.EEXIST:
971
raise errors.BzrCommandError('Target directory "%s" already'
972
' exists.' % to_location)
973
if e.errno == errno.ENOENT:
974
raise errors.BzrCommandError('Parent of "%s" does not exist.'
978
source.create_checkout(to_location, revision_id, lightweight)
981
class cmd_renames(Command):
982
"""Show list of renamed files.
984
# TODO: Option to show renames between two historical versions.
986
# TODO: Only show renames under dir, rather than in the whole branch.
987
_see_also = ['status']
988
takes_args = ['dir?']
991
def run(self, dir=u'.'):
992
tree = WorkingTree.open_containing(dir)[0]
995
new_inv = tree.inventory
996
old_tree = tree.basis_tree()
999
old_inv = old_tree.inventory
1000
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1002
for old_name, new_name in renames:
1003
self.outf.write("%s => %s\n" % (old_name, new_name))
1010
class cmd_update(Command):
1011
"""Update a tree to have the latest code committed to its branch.
1013
This will perform a merge into the working tree, and may generate
1014
conflicts. If you have any local changes, you will still
1015
need to commit them after the update for the update to be complete.
1017
If you want to discard your local changes, you can just do a
1018
'bzr revert' instead of 'bzr commit' after the update.
1021
_see_also = ['pull', 'working-trees']
1022
takes_args = ['dir?']
1025
def run(self, dir='.'):
1026
tree = WorkingTree.open_containing(dir)[0]
1027
master = tree.branch.get_master_branch()
1028
if master is not None:
1031
tree.lock_tree_write()
1033
existing_pending_merges = tree.get_parent_ids()[1:]
1034
last_rev = tree.last_revision()
1035
if last_rev == tree.branch.last_revision():
1036
# may be up to date, check master too.
1037
master = tree.branch.get_master_branch()
1038
if master is None or last_rev == master.last_revision():
1039
revno = tree.branch.revision_id_to_revno(last_rev)
1040
note("Tree is up to date at revision %d." % (revno,))
1042
conflicts = tree.update()
1043
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1044
note('Updated to revision %d.' % (revno,))
1045
if tree.get_parent_ids()[1:] != existing_pending_merges:
1046
note('Your local commits will now show as pending merges with '
1047
"'bzr status', and can be committed with 'bzr commit'.")
1056
class cmd_info(Command):
1057
"""Show information about a working tree, branch or repository.
1059
This command will show all known locations and formats associated to the
1060
tree, branch or repository. Statistical information is included with
1063
Branches and working trees will also report any missing revisions.
1065
_see_also = ['revno', 'working-trees', 'repositories']
1066
takes_args = ['location?']
1067
takes_options = ['verbose']
1070
def run(self, location=None, verbose=False):
1071
from bzrlib.info import show_bzrdir_info
1072
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1076
class cmd_remove(Command):
1077
"""Remove files or directories.
1079
This makes bzr stop tracking changes to the specified files and
1080
delete them if they can easily be recovered using revert.
1082
You can specify one or more files, and/or --new. If you specify --new,
1083
only 'added' files will be removed. If you specify both, then new files
1084
in the specified directories will be removed. If the directories are
1085
also new, they will also be removed.
1087
takes_args = ['file*']
1088
takes_options = ['verbose',
1089
Option('new', help='remove newly-added files'),
1090
RegistryOption.from_kwargs('file-deletion-strategy',
1091
'The file deletion mode to be used',
1092
title='Deletion Strategy', value_switches=True, enum_switch=False,
1093
safe='Only delete files if they can be'
1094
' safely recovered (default).',
1095
keep="Don't delete any files.",
1096
force='Delete all the specified files, even if they can not be '
1097
'recovered and even if they are non-empty directories.')]
1099
encoding_type = 'replace'
1101
def run(self, file_list, verbose=False, new=False,
1102
file_deletion_strategy='safe'):
1103
tree, file_list = tree_files(file_list)
1105
if file_list is not None:
1106
file_list = [f for f in file_list if f != '']
1108
raise errors.BzrCommandError('Specify one or more files to'
1109
' remove, or use --new.')
1112
added = tree.changes_from(tree.basis_tree(),
1113
specific_files=file_list).added
1114
file_list = sorted([f[0] for f in added], reverse=True)
1115
if len(file_list) == 0:
1116
raise errors.BzrCommandError('No matching files.')
1117
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1118
keep_files=file_deletion_strategy=='keep',
1119
force=file_deletion_strategy=='force')
1122
class cmd_file_id(Command):
1123
"""Print file_id of a particular file or directory.
1125
The file_id is assigned when the file is first added and remains the
1126
same through all revisions where the file exists, even when it is
1131
_see_also = ['inventory', 'ls']
1132
takes_args = ['filename']
1135
def run(self, filename):
1136
tree, relpath = WorkingTree.open_containing(filename)
1137
i = tree.path2id(relpath)
1139
raise errors.NotVersionedError(filename)
1141
self.outf.write(i + '\n')
1144
class cmd_file_path(Command):
1145
"""Print path of file_ids to a file or directory.
1147
This prints one line for each directory down to the target,
1148
starting at the branch root.
1152
takes_args = ['filename']
1155
def run(self, filename):
1156
tree, relpath = WorkingTree.open_containing(filename)
1157
fid = tree.path2id(relpath)
1159
raise errors.NotVersionedError(filename)
1160
segments = osutils.splitpath(relpath)
1161
for pos in range(1, len(segments) + 1):
1162
path = osutils.joinpath(segments[:pos])
1163
self.outf.write("%s\n" % tree.path2id(path))
1166
class cmd_reconcile(Command):
1167
"""Reconcile bzr metadata in a branch.
1169
This can correct data mismatches that may have been caused by
1170
previous ghost operations or bzr upgrades. You should only
1171
need to run this command if 'bzr check' or a bzr developer
1172
advises you to run it.
1174
If a second branch is provided, cross-branch reconciliation is
1175
also attempted, which will check that data like the tree root
1176
id which was not present in very early bzr versions is represented
1177
correctly in both branches.
1179
At the same time it is run it may recompress data resulting in
1180
a potential saving in disk space or performance gain.
1182
The branch *MUST* be on a listable system such as local disk or sftp.
1185
_see_also = ['check']
1186
takes_args = ['branch?']
1188
def run(self, branch="."):
1189
from bzrlib.reconcile import reconcile
1190
dir = bzrdir.BzrDir.open(branch)
1194
class cmd_revision_history(Command):
1195
"""Display the list of revision ids on a branch."""
1198
takes_args = ['location?']
1203
def run(self, location="."):
1204
branch = Branch.open_containing(location)[0]
1205
for revid in branch.revision_history():
1206
self.outf.write(revid)
1207
self.outf.write('\n')
1210
class cmd_ancestry(Command):
1211
"""List all revisions merged into this branch."""
1213
_see_also = ['log', 'revision-history']
1214
takes_args = ['location?']
1219
def run(self, location="."):
1221
wt = WorkingTree.open_containing(location)[0]
1222
except errors.NoWorkingTree:
1223
b = Branch.open(location)
1224
last_revision = b.last_revision()
1227
last_revision = wt.last_revision()
1229
revision_ids = b.repository.get_ancestry(last_revision)
1230
assert revision_ids[0] is None
1232
for revision_id in revision_ids:
1233
self.outf.write(revision_id + '\n')
1236
class cmd_init(Command):
1237
"""Make a directory into a versioned branch.
1239
Use this to create an empty branch, or before importing an
1242
If there is a repository in a parent directory of the location, then
1243
the history of the branch will be stored in the repository. Otherwise
1244
init creates a standalone branch which carries its own history
1245
in the .bzr directory.
1247
If there is already a branch at the location but it has no working tree,
1248
the tree can be populated with 'bzr checkout'.
1250
Recipe for importing a tree of files:
1255
bzr commit -m 'imported project'
1258
_see_also = ['init-repo', 'branch', 'checkout']
1259
takes_args = ['location?']
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):
1275
format = bzrdir.format_registry.make_bzrdir('default')
1276
if location is None:
1279
to_transport = transport.get_transport(location)
1281
# The path has to exist to initialize a
1282
# branch inside of it.
1283
# Just using os.mkdir, since I don't
1284
# believe that we want to create a bunch of
1285
# locations if the user supplies an extended path
1286
# TODO: create-prefix
1287
to_transport.ensure_base()
1290
existing_bzrdir = bzrdir.BzrDir.open(location)
1291
except errors.NotBranchError:
1292
# really a NotBzrDir error...
1293
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1296
from bzrlib.transport.local import LocalTransport
1297
if existing_bzrdir.has_branch():
1298
if (isinstance(to_transport, LocalTransport)
1299
and not existing_bzrdir.has_workingtree()):
1300
raise errors.BranchExistsWithoutWorkingTree(location)
1301
raise errors.AlreadyBranchError(location)
1303
branch = existing_bzrdir.create_branch()
1304
existing_bzrdir.create_workingtree()
1305
if append_revisions_only:
1307
branch.set_append_revisions_only(True)
1308
except errors.UpgradeRequired:
1309
raise errors.BzrCommandError('This branch format cannot be set'
1310
' to append-revisions-only. Try --experimental-branch6')
1313
class cmd_init_repository(Command):
1314
"""Create a shared repository to hold branches.
1316
New branches created under the repository directory will store their
1317
revisions in the repository, not in the branch directory.
1319
If the --no-trees option is used then the branches in the repository
1320
will not have working trees by default.
1323
bzr init-repo --no-trees repo
1325
bzr checkout --lightweight repo/trunk trunk-checkout
1329
See 'bzr help repositories' for more information.
1332
_see_also = ['init', 'branch', 'checkout']
1333
takes_args = ["location"]
1334
takes_options = [RegistryOption('format',
1335
help='Specify a format for this repository. See'
1336
' "bzr help formats" for details',
1337
registry=bzrdir.format_registry,
1338
converter=bzrdir.format_registry.make_bzrdir,
1339
value_switches=True, title='Repository format'),
1341
help='Branches in the repository will default to'
1342
' not having a working tree'),
1344
aliases = ["init-repo"]
1346
def run(self, location, format=None, no_trees=False):
1348
format = bzrdir.format_registry.make_bzrdir('default')
1350
if location is None:
1353
to_transport = transport.get_transport(location)
1354
to_transport.ensure_base()
1356
newdir = format.initialize_on_transport(to_transport)
1357
repo = newdir.create_repository(shared=True)
1358
repo.set_make_working_trees(not no_trees)
1361
class cmd_diff(Command):
1362
"""Show differences in the working tree or between revisions.
1364
If files are listed, only the changes in those files are listed.
1365
Otherwise, all changes for the tree are listed.
1367
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1368
produces patches suitable for "patch -p1".
1372
Shows the difference in the working tree versus the last commit
1374
Difference between the working tree and revision 1
1376
Difference between revision 2 and revision 1
1377
bzr diff --prefix old/:new/
1378
Same as 'bzr diff' but prefix paths with old/ and new/
1379
bzr diff bzr.mine bzr.dev
1380
Show the differences between the two working trees
1382
Show just the differences for 'foo.c'
1384
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1385
# or a graphical diff.
1387
# TODO: Python difflib is not exactly the same as unidiff; should
1388
# either fix it up or prefer to use an external diff.
1390
# TODO: Selected-file diff is inefficient and doesn't show you
1393
# TODO: This probably handles non-Unix newlines poorly.
1395
_see_also = ['status']
1396
takes_args = ['file*']
1397
takes_options = ['revision', 'diff-options',
1398
Option('prefix', type=str,
1400
help='Set prefixes to added to old and new filenames, as '
1401
'two values separated by a colon. (eg "old/:new/")'),
1403
aliases = ['di', 'dif']
1404
encoding_type = 'exact'
1407
def run(self, revision=None, file_list=None, diff_options=None,
1409
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1411
if (prefix is None) or (prefix == '0'):
1419
old_label, new_label = prefix.split(":")
1421
raise errors.BzrCommandError(
1422
'--prefix expects two values separated by a colon'
1423
' (eg "old/:new/")')
1425
if revision and len(revision) > 2:
1426
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1427
' one or two revision specifiers')
1430
tree1, file_list = internal_tree_files(file_list)
1434
except errors.FileInWrongBranch:
1435
if len(file_list) != 2:
1436
raise errors.BzrCommandError("Files are in different branches")
1438
tree1, file1 = WorkingTree.open_containing(file_list[0])
1439
tree2, file2 = WorkingTree.open_containing(file_list[1])
1440
if file1 != "" or file2 != "":
1441
# FIXME diff those two files. rbc 20051123
1442
raise errors.BzrCommandError("Files are in different branches")
1444
except errors.NotBranchError:
1445
if (revision is not None and len(revision) == 2
1446
and not revision[0].needs_branch()
1447
and not revision[1].needs_branch()):
1448
# If both revision specs include a branch, we can
1449
# diff them without needing a local working tree
1450
tree1, tree2 = None, None
1454
if tree2 is not None:
1455
if revision is not None:
1456
# FIXME: but there should be a clean way to diff between
1457
# non-default versions of two trees, it's not hard to do
1459
raise errors.BzrCommandError(
1460
"Sorry, diffing arbitrary revisions across branches "
1461
"is not implemented yet")
1462
return show_diff_trees(tree1, tree2, sys.stdout,
1463
specific_files=file_list,
1464
external_diff_options=diff_options,
1465
old_label=old_label, new_label=new_label)
1467
return diff_cmd_helper(tree1, file_list, diff_options,
1468
revision_specs=revision,
1469
old_label=old_label, new_label=new_label)
1472
class cmd_deleted(Command):
1473
"""List files deleted in the working tree.
1475
# TODO: Show files deleted since a previous revision, or
1476
# between two revisions.
1477
# TODO: Much more efficient way to do this: read in new
1478
# directories with readdir, rather than stating each one. Same
1479
# level of effort but possibly much less IO. (Or possibly not,
1480
# if the directories are very large...)
1481
_see_also = ['status', 'ls']
1482
takes_options = ['show-ids']
1485
def run(self, show_ids=False):
1486
tree = WorkingTree.open_containing(u'.')[0]
1489
old = tree.basis_tree()
1492
for path, ie in old.inventory.iter_entries():
1493
if not tree.has_id(ie.file_id):
1494
self.outf.write(path)
1496
self.outf.write(' ')
1497
self.outf.write(ie.file_id)
1498
self.outf.write('\n')
1505
class cmd_modified(Command):
1506
"""List files modified in working tree.
1510
_see_also = ['status', 'ls']
1514
tree = WorkingTree.open_containing(u'.')[0]
1515
td = tree.changes_from(tree.basis_tree())
1516
for path, id, kind, text_modified, meta_modified in td.modified:
1517
self.outf.write(path + '\n')
1520
class cmd_added(Command):
1521
"""List files added in working tree.
1525
_see_also = ['status', 'ls']
1529
wt = WorkingTree.open_containing(u'.')[0]
1532
basis = wt.basis_tree()
1535
basis_inv = basis.inventory
1538
if file_id in basis_inv:
1540
if inv.is_root(file_id) and len(basis_inv) == 0:
1542
path = inv.id2path(file_id)
1543
if not os.access(osutils.abspath(path), os.F_OK):
1545
self.outf.write(path + '\n')
1552
class cmd_root(Command):
1553
"""Show the tree root directory.
1555
The root is the nearest enclosing directory with a .bzr control
1558
takes_args = ['filename?']
1560
def run(self, filename=None):
1561
"""Print the branch root."""
1562
tree = WorkingTree.open_containing(filename)[0]
1563
self.outf.write(tree.basedir + '\n')
1566
def _parse_limit(limitstring):
1568
return int(limitstring)
1570
msg = "The limit argument must be an integer."
1571
raise errors.BzrCommandError(msg)
1574
class cmd_log(Command):
1575
"""Show log of a branch, file, or directory.
1577
By default show the log of the branch containing the working directory.
1579
To request a range of logs, you can use the command -r begin..end
1580
-r revision requests a specific revision, -r ..end or -r begin.. are
1586
bzr log -r -10.. http://server/branch
1589
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1591
takes_args = ['location?']
1592
takes_options = [Option('forward',
1593
help='show from oldest to newest'),
1597
help='show files changed in each revision'),
1598
'show-ids', 'revision',
1602
help='show revisions whose message matches this regexp',
1605
help='limit the output to the first N revisions',
1608
encoding_type = 'replace'
1611
def run(self, location=None, timezone='original',
1619
from bzrlib.log import show_log
1620
assert message is None or isinstance(message, basestring), \
1621
"invalid message argument %r" % message
1622
direction = (forward and 'forward') or 'reverse'
1627
# find the file id to log:
1629
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1633
tree = b.basis_tree()
1634
file_id = tree.path2id(fp)
1636
raise errors.BzrCommandError(
1637
"Path does not have any revision history: %s" %
1641
# FIXME ? log the current subdir only RBC 20060203
1642
if revision is not None \
1643
and len(revision) > 0 and revision[0].get_branch():
1644
location = revision[0].get_branch()
1647
dir, relpath = bzrdir.BzrDir.open_containing(location)
1648
b = dir.open_branch()
1652
if revision is None:
1655
elif len(revision) == 1:
1656
rev1 = rev2 = revision[0].in_history(b).revno
1657
elif len(revision) == 2:
1658
if revision[1].get_branch() != revision[0].get_branch():
1659
# b is taken from revision[0].get_branch(), and
1660
# show_log will use its revision_history. Having
1661
# different branches will lead to weird behaviors.
1662
raise errors.BzrCommandError(
1663
"Log doesn't accept two revisions in different"
1665
if revision[0].spec is None:
1666
# missing begin-range means first revision
1669
rev1 = revision[0].in_history(b).revno
1671
if revision[1].spec is None:
1672
# missing end-range means last known revision
1675
rev2 = revision[1].in_history(b).revno
1677
raise errors.BzrCommandError(
1678
'bzr log --revision takes one or two values.')
1680
# By this point, the revision numbers are converted to the +ve
1681
# form if they were supplied in the -ve form, so we can do
1682
# this comparison in relative safety
1684
(rev2, rev1) = (rev1, rev2)
1686
if log_format is None:
1687
log_format = log.log_formatter_registry.get_default(b)
1689
lf = log_format(show_ids=show_ids, to_file=self.outf,
1690
show_timezone=timezone)
1696
direction=direction,
1697
start_revision=rev1,
1705
def get_log_format(long=False, short=False, line=False, default='long'):
1706
log_format = default
1710
log_format = 'short'
1716
class cmd_touching_revisions(Command):
1717
"""Return revision-ids which affected a particular file.
1719
A more user-friendly interface is "bzr log FILE".
1723
takes_args = ["filename"]
1726
def run(self, filename):
1727
tree, relpath = WorkingTree.open_containing(filename)
1729
file_id = tree.path2id(relpath)
1730
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1731
self.outf.write("%6d %s\n" % (revno, what))
1734
class cmd_ls(Command):
1735
"""List files in a tree.
1738
_see_also = ['status', 'cat']
1739
takes_args = ['path?']
1740
# TODO: Take a revision or remote path and list that tree instead.
1741
takes_options = ['verbose', 'revision',
1742
Option('non-recursive',
1743
help='don\'t recurse into sub-directories'),
1745
help='Print all paths from the root of the branch.'),
1746
Option('unknown', help='Print unknown files'),
1747
Option('versioned', help='Print versioned files'),
1748
Option('ignored', help='Print ignored files'),
1750
Option('null', help='Null separate the files'),
1754
def run(self, revision=None, verbose=False,
1755
non_recursive=False, from_root=False,
1756
unknown=False, versioned=False, ignored=False,
1757
null=False, kind=None, show_ids=False, path=None):
1759
if kind and kind not in ('file', 'directory', 'symlink'):
1760
raise errors.BzrCommandError('invalid kind specified')
1762
if verbose and null:
1763
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1764
all = not (unknown or versioned or ignored)
1766
selection = {'I':ignored, '?':unknown, 'V':versioned}
1773
raise errors.BzrCommandError('cannot specify both --from-root'
1777
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1783
if revision is not None:
1784
tree = branch.repository.revision_tree(
1785
revision[0].in_history(branch).rev_id)
1787
tree = branch.basis_tree()
1791
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1792
if fp.startswith(relpath):
1793
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1794
if non_recursive and '/' in fp:
1796
if not all and not selection[fc]:
1798
if kind is not None and fkind != kind:
1801
kindch = entry.kind_character()
1802
outstring = '%-8s %s%s' % (fc, fp, kindch)
1803
if show_ids and fid is not None:
1804
outstring = "%-50s %s" % (outstring, fid)
1805
self.outf.write(outstring + '\n')
1807
self.outf.write(fp + '\0')
1810
self.outf.write(fid)
1811
self.outf.write('\0')
1819
self.outf.write('%-50s %s\n' % (fp, my_id))
1821
self.outf.write(fp + '\n')
1826
class cmd_unknowns(Command):
1827
"""List unknown files.
1835
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1836
self.outf.write(osutils.quotefn(f) + '\n')
1839
class cmd_ignore(Command):
1840
"""Ignore specified files or patterns.
1842
To remove patterns from the ignore list, edit the .bzrignore file.
1844
Trailing slashes on patterns are ignored.
1845
If the pattern contains a slash or is a regular expression, it is compared
1846
to the whole path from the branch root. Otherwise, it is compared to only
1847
the last component of the path. To match a file only in the root
1848
directory, prepend './'.
1850
Ignore patterns specifying absolute paths are not allowed.
1852
Ignore patterns may include globbing wildcards such as:
1853
? - Matches any single character except '/'
1854
* - Matches 0 or more characters except '/'
1855
/**/ - Matches 0 or more directories in a path
1856
[a-z] - Matches a single character from within a group of characters
1858
Ignore patterns may also be Python regular expressions.
1859
Regular expression ignore patterns are identified by a 'RE:' prefix
1860
followed by the regular expression. Regular expression ignore patterns
1861
may not include named or numbered groups.
1863
Note: ignore patterns containing shell wildcards must be quoted from
1867
bzr ignore ./Makefile
1868
bzr ignore '*.class'
1869
bzr ignore 'lib/**/*.o'
1870
bzr ignore 'RE:lib/.*\.o'
1873
_see_also = ['status', 'ignored']
1874
takes_args = ['name_pattern*']
1876
Option('old-default-rules',
1877
help='Out the ignore rules bzr < 0.9 always used.')
1880
def run(self, name_pattern_list=None, old_default_rules=None):
1881
from bzrlib.atomicfile import AtomicFile
1882
if old_default_rules is not None:
1883
# dump the rules and exit
1884
for pattern in ignores.OLD_DEFAULTS:
1887
if not name_pattern_list:
1888
raise errors.BzrCommandError("ignore requires at least one "
1889
"NAME_PATTERN or --old-default-rules")
1890
name_pattern_list = [globbing.normalize_pattern(p)
1891
for p in name_pattern_list]
1892
for name_pattern in name_pattern_list:
1893
if (name_pattern[0] == '/' or
1894
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1895
raise errors.BzrCommandError(
1896
"NAME_PATTERN should not be an absolute path")
1897
tree, relpath = WorkingTree.open_containing(u'.')
1898
ifn = tree.abspath('.bzrignore')
1899
if os.path.exists(ifn):
1902
igns = f.read().decode('utf-8')
1908
# TODO: If the file already uses crlf-style termination, maybe
1909
# we should use that for the newly added lines?
1911
if igns and igns[-1] != '\n':
1913
for name_pattern in name_pattern_list:
1914
igns += name_pattern + '\n'
1916
f = AtomicFile(ifn, 'wb')
1918
f.write(igns.encode('utf-8'))
1923
if not tree.path2id('.bzrignore'):
1924
tree.add(['.bzrignore'])
1927
class cmd_ignored(Command):
1928
"""List ignored files and the patterns that matched them.
1931
_see_also = ['ignore']
1934
tree = WorkingTree.open_containing(u'.')[0]
1937
for path, file_class, kind, file_id, entry in tree.list_files():
1938
if file_class != 'I':
1940
## XXX: Slightly inefficient since this was already calculated
1941
pat = tree.is_ignored(path)
1942
print '%-50s %s' % (path, pat)
1947
class cmd_lookup_revision(Command):
1948
"""Lookup the revision-id from a revision-number
1951
bzr lookup-revision 33
1954
takes_args = ['revno']
1957
def run(self, revno):
1961
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1963
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1966
class cmd_export(Command):
1967
"""Export current or past revision to a destination directory or archive.
1969
If no revision is specified this exports the last committed revision.
1971
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1972
given, try to find the format with the extension. If no extension
1973
is found exports to a directory (equivalent to --format=dir).
1975
If root is supplied, it will be used as the root directory inside
1976
container formats (tar, zip, etc). If it is not supplied it will default
1977
to the exported filename. The root option has no effect for 'dir' format.
1979
If branch is omitted then the branch containing the current working
1980
directory will be used.
1982
Note: Export of tree with non-ASCII filenames to zip is not supported.
1984
Supported formats Autodetected by extension
1985
----------------- -------------------------
1988
tbz2 .tar.bz2, .tbz2
1992
takes_args = ['dest', 'branch?']
1993
takes_options = ['revision', 'format', 'root']
1994
def run(self, dest, branch=None, revision=None, format=None, root=None):
1995
from bzrlib.export import export
1998
tree = WorkingTree.open_containing(u'.')[0]
2001
b = Branch.open(branch)
2003
if revision is None:
2004
# should be tree.last_revision FIXME
2005
rev_id = b.last_revision()
2007
if len(revision) != 1:
2008
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2009
rev_id = revision[0].in_history(b).rev_id
2010
t = b.repository.revision_tree(rev_id)
2012
export(t, dest, format, root)
2013
except errors.NoSuchExportFormat, e:
2014
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2017
class cmd_cat(Command):
2018
"""Write the contents of a file as of a given revision to standard output.
2020
If no revision is nominated, the last revision is used.
2022
Note: Take care to redirect standard output when using this command on a
2027
takes_options = ['revision', 'name-from-revision']
2028
takes_args = ['filename']
2029
encoding_type = 'exact'
2032
def run(self, filename, revision=None, name_from_revision=False):
2033
if revision is not None and len(revision) != 1:
2034
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2039
tree, b, relpath = \
2040
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2041
except errors.NotBranchError:
2044
if revision is not None and revision[0].get_branch() is not None:
2045
b = Branch.open(revision[0].get_branch())
2047
tree = b.basis_tree()
2048
if revision is None:
2049
revision_id = b.last_revision()
2051
revision_id = revision[0].in_history(b).rev_id
2053
cur_file_id = tree.path2id(relpath)
2054
rev_tree = b.repository.revision_tree(revision_id)
2055
old_file_id = rev_tree.path2id(relpath)
2057
if name_from_revision:
2058
if old_file_id is None:
2059
raise errors.BzrCommandError("%r is not present in revision %s"
2060
% (filename, revision_id))
2062
rev_tree.print_file(old_file_id)
2063
elif cur_file_id is not None:
2064
rev_tree.print_file(cur_file_id)
2065
elif old_file_id is not None:
2066
rev_tree.print_file(old_file_id)
2068
raise errors.BzrCommandError("%r is not present in revision %s" %
2069
(filename, revision_id))
2072
class cmd_local_time_offset(Command):
2073
"""Show the offset in seconds from GMT to local time."""
2077
print osutils.local_time_offset()
2081
class cmd_commit(Command):
2082
"""Commit changes into a new revision.
2084
If no arguments are given, the entire tree is committed.
2086
If selected files are specified, only changes to those files are
2087
committed. If a directory is specified then the directory and everything
2088
within it is committed.
2090
A selected-file commit may fail in some cases where the committed
2091
tree would be invalid. Consider::
2096
bzr commit foo -m "committing foo"
2097
bzr mv foo/bar foo/baz
2100
bzr commit foo/bar -m "committing bar but not baz"
2102
In the example above, the last commit will fail by design. This gives
2103
the user the opportunity to decide whether they want to commit the
2104
rename at the same time, separately first, or not at all. (As a general
2105
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2107
Note: A selected-file commit after a merge is not yet supported.
2109
# TODO: Run hooks on tree to-be-committed, and after commit.
2111
# TODO: Strict commit that fails if there are deleted files.
2112
# (what does "deleted files" mean ??)
2114
# TODO: Give better message for -s, --summary, used by tla people
2116
# XXX: verbose currently does nothing
2118
_see_also = ['bugs', 'uncommit']
2119
takes_args = ['selected*']
2120
takes_options = ['message', 'verbose',
2122
help='commit even if nothing has changed'),
2123
Option('file', type=str,
2126
help='file containing commit message'),
2128
help="refuse to commit if there are unknown "
2129
"files in the working tree."),
2130
ListOption('fixes', type=str,
2131
help="mark a bug as being fixed by this "
2134
help="perform a local only commit in a bound "
2135
"branch. Such commits are not pushed to "
2136
"the master branch until a normal commit "
2140
aliases = ['ci', 'checkin']
2142
def _get_bug_fix_properties(self, fixes, branch):
2144
# Configure the properties for bug fixing attributes.
2145
for fixed_bug in fixes:
2146
tokens = fixed_bug.split(':')
2147
if len(tokens) != 2:
2148
raise errors.BzrCommandError(
2149
"Invalid bug %s. Must be in the form of 'tag:id'. "
2150
"Commit refused." % fixed_bug)
2151
tag, bug_id = tokens
2153
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2154
except errors.UnknownBugTrackerAbbreviation:
2155
raise errors.BzrCommandError(
2156
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2157
except errors.MalformedBugIdentifier:
2158
raise errors.BzrCommandError(
2159
"Invalid bug identifier for %s. Commit refused."
2161
properties.append('%s fixed' % bug_url)
2162
return '\n'.join(properties)
2164
def run(self, message=None, file=None, verbose=True, selected_list=None,
2165
unchanged=False, strict=False, local=False, fixes=None):
2166
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2167
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2169
from bzrlib.msgeditor import edit_commit_message, \
2170
make_commit_message_template
2172
# TODO: Need a blackbox test for invoking the external editor; may be
2173
# slightly problematic to run this cross-platform.
2175
# TODO: do more checks that the commit will succeed before
2176
# spending the user's valuable time typing a commit message.
2180
tree, selected_list = tree_files(selected_list)
2181
if selected_list == ['']:
2182
# workaround - commit of root of tree should be exactly the same
2183
# as just default commit in that tree, and succeed even though
2184
# selected-file merge commit is not done yet
2187
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2189
properties['bugs'] = bug_property
2191
if local and not tree.branch.get_bound_location():
2192
raise errors.LocalRequiresBoundBranch()
2194
def get_message(commit_obj):
2195
"""Callback to get commit message"""
2196
my_message = message
2197
if my_message is None and not file:
2198
template = make_commit_message_template(tree, selected_list)
2199
my_message = edit_commit_message(template)
2200
if my_message is None:
2201
raise errors.BzrCommandError("please specify a commit"
2202
" message with either --message or --file")
2203
elif my_message and file:
2204
raise errors.BzrCommandError(
2205
"please specify either --message or --file")
2207
my_message = codecs.open(file, 'rt',
2208
bzrlib.user_encoding).read()
2209
if my_message == "":
2210
raise errors.BzrCommandError("empty commit message specified")
2214
reporter = ReportCommitToLog()
2216
reporter = NullCommitReporter()
2219
tree.commit(message_callback=get_message,
2220
specific_files=selected_list,
2221
allow_pointless=unchanged, strict=strict, local=local,
2222
reporter=reporter, revprops=properties)
2223
except PointlessCommit:
2224
# FIXME: This should really happen before the file is read in;
2225
# perhaps prepare the commit; get the message; then actually commit
2226
raise errors.BzrCommandError("no changes to commit."
2227
" use --unchanged to commit anyhow")
2228
except ConflictsInTree:
2229
raise errors.BzrCommandError('Conflicts detected in working '
2230
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2232
except StrictCommitFailed:
2233
raise errors.BzrCommandError("Commit refused because there are"
2234
" unknown files in the working tree.")
2235
except errors.BoundBranchOutOfDate, e:
2236
raise errors.BzrCommandError(str(e) + "\n"
2237
'To commit to master branch, run update and then commit.\n'
2238
'You can also pass --local to commit to continue working '
2242
class cmd_check(Command):
2243
"""Validate consistency of branch history.
2245
This command checks various invariants about the branch storage to
2246
detect data corruption or bzr bugs.
2249
_see_also = ['reconcile']
2250
takes_args = ['branch?']
2251
takes_options = ['verbose']
2253
def run(self, branch=None, verbose=False):
2254
from bzrlib.check import check
2256
tree = WorkingTree.open_containing()[0]
2257
branch = tree.branch
2259
branch = Branch.open(branch)
2260
check(branch, verbose)
2263
class cmd_upgrade(Command):
2264
"""Upgrade branch storage to current format.
2266
The check command or bzr developers may sometimes advise you to run
2267
this command. When the default format has changed you may also be warned
2268
during other operations to upgrade.
2271
_see_also = ['check']
2272
takes_args = ['url?']
2274
RegistryOption('format',
2275
help='Upgrade to a specific format. See "bzr help'
2276
' formats" for details',
2277
registry=bzrdir.format_registry,
2278
converter=bzrdir.format_registry.make_bzrdir,
2279
value_switches=True, title='Branch format'),
2282
def run(self, url='.', format=None):
2283
from bzrlib.upgrade import upgrade
2285
format = bzrdir.format_registry.make_bzrdir('default')
2286
upgrade(url, format)
2289
class cmd_whoami(Command):
2290
"""Show or set bzr user id.
2294
bzr whoami 'Frank Chu <fchu@example.com>'
2296
takes_options = [ Option('email',
2297
help='display email address only'),
2299
help='set identity for the current branch instead of '
2302
takes_args = ['name?']
2303
encoding_type = 'replace'
2306
def run(self, email=False, branch=False, name=None):
2308
# use branch if we're inside one; otherwise global config
2310
c = Branch.open_containing('.')[0].get_config()
2311
except errors.NotBranchError:
2312
c = config.GlobalConfig()
2314
self.outf.write(c.user_email() + '\n')
2316
self.outf.write(c.username() + '\n')
2319
# display a warning if an email address isn't included in the given name.
2321
config.extract_email_address(name)
2322
except errors.NoEmailInUsername, e:
2323
warning('"%s" does not seem to contain an email address. '
2324
'This is allowed, but not recommended.', name)
2326
# use global config unless --branch given
2328
c = Branch.open_containing('.')[0].get_config()
2330
c = config.GlobalConfig()
2331
c.set_user_option('email', name)
2334
class cmd_nick(Command):
2335
"""Print or set the branch nickname.
2337
If unset, the tree root directory name is used as the nickname
2338
To print the current nickname, execute with no argument.
2341
_see_also = ['info']
2342
takes_args = ['nickname?']
2343
def run(self, nickname=None):
2344
branch = Branch.open_containing(u'.')[0]
2345
if nickname is None:
2346
self.printme(branch)
2348
branch.nick = nickname
2351
def printme(self, branch):
2355
class cmd_selftest(Command):
2356
"""Run internal test suite.
2358
This creates temporary test directories in the working directory, but no
2359
existing data is affected. These directories are deleted if the tests
2360
pass, or left behind to help in debugging if they fail and --keep-output
2363
If arguments are given, they are regular expressions that say which tests
2364
should run. Tests matching any expression are run, and other tests are
2367
Alternatively if --first is given, matching tests are run first and then
2368
all other tests are run. This is useful if you have been working in a
2369
particular area, but want to make sure nothing else was broken.
2371
If --exclude is given, tests that match that regular expression are
2372
excluded, regardless of whether they match --first or not.
2374
To help catch accidential dependencies between tests, the --randomize
2375
option is useful. In most cases, the argument used is the word 'now'.
2376
Note that the seed used for the random number generator is displayed
2377
when this option is used. The seed can be explicitly passed as the
2378
argument to this option if required. This enables reproduction of the
2379
actual ordering used if and when an order sensitive problem is encountered.
2381
If --list-only is given, the tests that would be run are listed. This is
2382
useful when combined with --first, --exclude and/or --randomize to
2383
understand their impact. The test harness reports "Listed nn tests in ..."
2384
instead of "Ran nn tests in ..." when list mode is enabled.
2386
If the global option '--no-plugins' is given, plugins are not loaded
2387
before running the selftests. This has two effects: features provided or
2388
modified by plugins will not be tested, and tests provided by plugins will
2393
run only tests relating to 'ignore'
2394
bzr --no-plugins selftest -v
2395
disable plugins and list tests as they're run
2397
For each test, that needs actual disk access, bzr create their own
2398
subdirectory in the temporary testing directory (testXXXX.tmp).
2399
By default the name of such subdirectory is based on the name of the test.
2400
If option '--numbered-dirs' is given, bzr will use sequent numbers
2401
of running tests to create such subdirectories. This is default behavior
2402
on Windows because of path length limitation.
2404
# NB: this is used from the class without creating an instance, which is
2405
# why it does not have a self parameter.
2406
def get_transport_type(typestring):
2407
"""Parse and return a transport specifier."""
2408
if typestring == "sftp":
2409
from bzrlib.transport.sftp import SFTPAbsoluteServer
2410
return SFTPAbsoluteServer
2411
if typestring == "memory":
2412
from bzrlib.transport.memory import MemoryServer
2414
if typestring == "fakenfs":
2415
from bzrlib.transport.fakenfs import FakeNFSServer
2416
return FakeNFSServer
2417
msg = "No known transport type %s. Supported types are: sftp\n" %\
2419
raise errors.BzrCommandError(msg)
2422
takes_args = ['testspecs*']
2423
takes_options = ['verbose',
2425
help='stop when one test fails',
2428
Option('keep-output',
2429
help='keep output directories when tests fail'),
2431
help='Use a different transport by default '
2432
'throughout the test suite.',
2433
type=get_transport_type),
2434
Option('benchmark', help='run the bzr benchmarks.'),
2435
Option('lsprof-timed',
2436
help='generate lsprof output for benchmarked'
2437
' sections of code.'),
2438
Option('cache-dir', type=str,
2439
help='a directory to cache intermediate'
2440
' benchmark steps'),
2441
Option('clean-output',
2442
help='clean temporary tests directories'
2443
' without running tests'),
2445
help='run all tests, but run specified tests first',
2448
Option('numbered-dirs',
2449
help='use numbered dirs for TestCaseInTempDir'),
2451
help='list the tests instead of running them'),
2452
Option('randomize', type=str, argname="SEED",
2453
help='randomize the order of tests using the given'
2454
' seed or "now" for the current time'),
2455
Option('exclude', type=str, argname="PATTERN",
2457
help='exclude tests that match this regular'
2460
encoding_type = 'replace'
2462
def run(self, testspecs_list=None, verbose=None, one=False,
2463
keep_output=False, transport=None, benchmark=None,
2464
lsprof_timed=None, cache_dir=None, clean_output=False,
2465
first=False, numbered_dirs=None, list_only=False,
2466
randomize=None, exclude=None):
2468
from bzrlib.tests import selftest
2469
import bzrlib.benchmarks as benchmarks
2470
from bzrlib.benchmarks import tree_creator
2473
from bzrlib.tests import clean_selftest_output
2474
clean_selftest_output()
2477
if numbered_dirs is None and sys.platform == 'win32':
2478
numbered_dirs = True
2480
if cache_dir is not None:
2481
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2482
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2483
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2485
if testspecs_list is not None:
2486
pattern = '|'.join(testspecs_list)
2490
test_suite_factory = benchmarks.test_suite
2493
# TODO: should possibly lock the history file...
2494
benchfile = open(".perf_history", "at", buffering=1)
2496
test_suite_factory = None
2501
result = selftest(verbose=verbose,
2503
stop_on_failure=one,
2504
keep_output=keep_output,
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
numbered_dirs=numbered_dirs,
2511
list_only=list_only,
2512
random_seed=randomize,
2513
exclude_pattern=exclude
2516
if benchfile is not None:
2519
info('tests passed')
2521
info('tests failed')
2522
return int(not result)
2525
class cmd_version(Command):
2526
"""Show version of bzr."""
2530
from bzrlib.version import show_version
2534
class cmd_rocks(Command):
2535
"""Statement of optimism."""
2541
print "It sure does!"
2544
class cmd_find_merge_base(Command):
2545
"""Find and print a base revision for merging two branches."""
2546
# TODO: Options to specify revisions on either side, as if
2547
# merging only part of the history.
2548
takes_args = ['branch', 'other']
2552
def run(self, branch, other):
2553
from bzrlib.revision import MultipleRevisionSources
2555
branch1 = Branch.open_containing(branch)[0]
2556
branch2 = Branch.open_containing(other)[0]
2558
last1 = branch1.last_revision()
2559
last2 = branch2.last_revision()
2561
source = MultipleRevisionSources(branch1.repository,
2564
base_rev_id = common_ancestor(last1, last2, source)
2566
print 'merge base is revision %s' % base_rev_id
2569
class cmd_merge(Command):
2570
"""Perform a three-way merge.
2572
The branch is the branch you will merge from. By default, it will merge
2573
the latest revision. If you specify a revision, that revision will be
2574
merged. If you specify two revisions, the first will be used as a BASE,
2575
and the second one as OTHER. Revision numbers are always relative to the
2578
By default, bzr will try to merge in all new work from the other
2579
branch, automatically determining an appropriate base. If this
2580
fails, you may need to give an explicit base.
2582
Merge will do its best to combine the changes in two branches, but there
2583
are some kinds of problems only a human can fix. When it encounters those,
2584
it will mark a conflict. A conflict means that you need to fix something,
2585
before you should commit.
2587
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2589
If there is no default branch set, the first merge will set it. After
2590
that, you can omit the branch to use the default. To change the
2591
default, use --remember. The value will only be saved if the remote
2592
location can be accessed.
2594
The results of the merge are placed into the destination working
2595
directory, where they can be reviewed (with bzr diff), tested, and then
2596
committed to record the result of the merge.
2600
To merge the latest revision from bzr.dev:
2601
bzr merge ../bzr.dev
2603
To merge changes up to and including revision 82 from bzr.dev:
2604
bzr merge -r 82 ../bzr.dev
2606
To merge the changes introduced by 82, without previous changes:
2607
bzr merge -r 81..82 ../bzr.dev
2609
merge refuses to run if there are any uncommitted changes, unless
2613
_see_also = ['update', 'remerge']
2614
takes_args = ['branch?']
2615
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2616
Option('show-base', help="Show base revision text in "
2618
Option('uncommitted', help='Apply uncommitted changes'
2619
' from a working copy, instead of branch changes'),
2620
Option('pull', help='If the destination is already'
2621
' completely merged into the source, pull from the'
2622
' source rather than merging. When this happens,'
2623
' you do not need to commit the result.'),
2625
help='Branch to merge into, '
2626
'rather than the one containing the working directory',
2632
def run(self, branch=None, revision=None, force=False, merge_type=None,
2633
show_base=False, reprocess=False, remember=False,
2634
uncommitted=False, pull=False,
2637
from bzrlib.tag import _merge_tags_if_possible
2638
other_revision_id = None
2639
if merge_type is None:
2640
merge_type = _mod_merge.Merge3Merger
2642
if directory is None: directory = u'.'
2643
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2644
# inventory. Because merge is a mutating operation, it really
2645
# should be a lock_write() for the whole cmd_merge operation.
2646
# However, cmd_merge open's its own tree in _merge_helper, which
2647
# means if we lock here, the later lock_write() will always block.
2648
# Either the merge helper code should be updated to take a tree,
2649
# (What about tree.merge_from_branch?)
2650
tree = WorkingTree.open_containing(directory)[0]
2651
change_reporter = delta._ChangeReporter(
2652
unversioned_filter=tree.is_ignored)
2654
if branch is not None:
2656
mergeable = bundle.read_mergeable_from_url(
2658
except errors.NotABundle:
2659
pass # Continue on considering this url a Branch
2661
if revision is not None:
2662
raise errors.BzrCommandError(
2663
'Cannot use -r with merge directives or bundles')
2664
other_revision_id = mergeable.install_revisions(
2665
tree.branch.repository)
2666
revision = [RevisionSpec.from_string(
2667
'revid:' + other_revision_id)]
2669
if revision is None \
2670
or len(revision) < 1 or revision[0].needs_branch():
2671
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2673
if revision is None or len(revision) < 1:
2676
other = [branch, None]
2679
other = [branch, -1]
2680
other_branch, path = Branch.open_containing(branch)
2683
raise errors.BzrCommandError('Cannot use --uncommitted and'
2684
' --revision at the same time.')
2685
branch = revision[0].get_branch() or branch
2686
if len(revision) == 1:
2688
if other_revision_id is not None:
2693
other_branch, path = Branch.open_containing(branch)
2694
revno = revision[0].in_history(other_branch).revno
2695
other = [branch, revno]
2697
assert len(revision) == 2
2698
if None in revision:
2699
raise errors.BzrCommandError(
2700
"Merge doesn't permit empty revision specifier.")
2701
base_branch, path = Branch.open_containing(branch)
2702
branch1 = revision[1].get_branch() or branch
2703
other_branch, path1 = Branch.open_containing(branch1)
2704
if revision[0].get_branch() is not None:
2705
# then path was obtained from it, and is None.
2708
base = [branch, revision[0].in_history(base_branch).revno]
2709
other = [branch1, revision[1].in_history(other_branch).revno]
2711
if ((tree.branch.get_parent() is None or remember) and
2712
other_branch is not None):
2713
tree.branch.set_parent(other_branch.base)
2715
# pull tags now... it's a bit inconsistent to do it ahead of copying
2716
# the history but that's done inside the merge code
2717
if other_branch is not None:
2718
_merge_tags_if_possible(other_branch, tree.branch)
2721
interesting_files = [path]
2723
interesting_files = None
2724
pb = ui.ui_factory.nested_progress_bar()
2727
conflict_count = _merge_helper(
2728
other, base, other_rev_id=other_revision_id,
2729
check_clean=(not force),
2730
merge_type=merge_type,
2731
reprocess=reprocess,
2732
show_base=show_base,
2735
pb=pb, file_list=interesting_files,
2736
change_reporter=change_reporter)
2739
if conflict_count != 0:
2743
except errors.AmbiguousBase, e:
2744
m = ("sorry, bzr can't determine the right merge base yet\n"
2745
"candidates are:\n "
2746
+ "\n ".join(e.bases)
2748
"please specify an explicit base with -r,\n"
2749
"and (if you want) report this to the bzr developers\n")
2752
# TODO: move up to common parent; this isn't merge-specific anymore.
2753
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2754
"""Use tree.branch's parent if none was supplied.
2756
Report if the remembered location was used.
2758
if supplied_location is not None:
2759
return supplied_location
2760
stored_location = tree.branch.get_parent()
2761
mutter("%s", stored_location)
2762
if stored_location is None:
2763
raise errors.BzrCommandError("No location specified or remembered")
2764
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2765
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2766
return stored_location
2769
class cmd_remerge(Command):
2772
Use this if you want to try a different merge technique while resolving
2773
conflicts. Some merge techniques are better than others, and remerge
2774
lets you try different ones on different files.
2776
The options for remerge have the same meaning and defaults as the ones for
2777
merge. The difference is that remerge can (only) be run when there is a
2778
pending merge, and it lets you specify particular files.
2782
$ bzr remerge --show-base
2783
Re-do the merge of all conflicted files, and show the base text in
2784
conflict regions, in addition to the usual THIS and OTHER texts.
2786
$ bzr remerge --merge-type weave --reprocess foobar
2787
Re-do the merge of "foobar", using the weave merge algorithm, with
2788
additional processing to reduce the size of conflict regions.
2790
takes_args = ['file*']
2791
takes_options = ['merge-type', 'reprocess',
2792
Option('show-base', help="Show base revision text in "
2795
def run(self, file_list=None, merge_type=None, show_base=False,
2797
if merge_type is None:
2798
merge_type = _mod_merge.Merge3Merger
2799
tree, file_list = tree_files(file_list)
2802
parents = tree.get_parent_ids()
2803
if len(parents) != 2:
2804
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2805
" merges. Not cherrypicking or"
2807
repository = tree.branch.repository
2808
base_revision = common_ancestor(parents[0],
2809
parents[1], repository)
2810
base_tree = repository.revision_tree(base_revision)
2811
other_tree = repository.revision_tree(parents[1])
2812
interesting_ids = None
2814
conflicts = tree.conflicts()
2815
if file_list is not None:
2816
interesting_ids = set()
2817
for filename in file_list:
2818
file_id = tree.path2id(filename)
2820
raise errors.NotVersionedError(filename)
2821
interesting_ids.add(file_id)
2822
if tree.kind(file_id) != "directory":
2825
for name, ie in tree.inventory.iter_entries(file_id):
2826
interesting_ids.add(ie.file_id)
2827
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2829
# Remerge only supports resolving contents conflicts
2830
allowed_conflicts = ('text conflict', 'contents conflict')
2831
restore_files = [c.path for c in conflicts
2832
if c.typestring in allowed_conflicts]
2833
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2834
tree.set_conflicts(ConflictList(new_conflicts))
2835
if file_list is not None:
2836
restore_files = file_list
2837
for filename in restore_files:
2839
restore(tree.abspath(filename))
2840
except errors.NotConflicted:
2842
conflicts = _mod_merge.merge_inner(
2843
tree.branch, other_tree, base_tree,
2845
interesting_ids=interesting_ids,
2846
other_rev_id=parents[1],
2847
merge_type=merge_type,
2848
show_base=show_base,
2849
reprocess=reprocess)
2858
class cmd_revert(Command):
2859
"""Revert files to a previous revision.
2861
Giving a list of files will revert only those files. Otherwise, all files
2862
will be reverted. If the revision is not specified with '--revision', the
2863
last committed revision is used.
2865
To remove only some changes, without reverting to a prior version, use
2866
merge instead. For example, "merge . --r-2..-3" will remove the changes
2867
introduced by -2, without affecting the changes introduced by -1. Or
2868
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2870
By default, any files that have been manually changed will be backed up
2871
first. (Files changed only by merge are not backed up.) Backup files have
2872
'.~#~' appended to their name, where # is a number.
2874
When you provide files, you can use their current pathname or the pathname
2875
from the target revision. So you can use revert to "undelete" a file by
2876
name. If you name a directory, all the contents of that directory will be
2880
_see_also = ['cat', 'export']
2881
takes_options = ['revision', 'no-backup']
2882
takes_args = ['file*']
2884
def run(self, revision=None, no_backup=False, file_list=None):
2885
if file_list is not None:
2886
if len(file_list) == 0:
2887
raise errors.BzrCommandError("No files specified")
2891
tree, file_list = tree_files(file_list)
2892
if revision is None:
2893
# FIXME should be tree.last_revision
2894
rev_id = tree.last_revision()
2895
elif len(revision) != 1:
2896
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2898
rev_id = revision[0].in_history(tree.branch).rev_id
2899
pb = ui.ui_factory.nested_progress_bar()
2901
tree.revert(file_list,
2902
tree.branch.repository.revision_tree(rev_id),
2903
not no_backup, pb, report_changes=True)
2908
class cmd_assert_fail(Command):
2909
"""Test reporting of assertion failures"""
2910
# intended just for use in testing
2915
raise AssertionError("always fails")
2918
class cmd_help(Command):
2919
"""Show help on a command or other topic.
2922
_see_also = ['topics']
2923
takes_options = [Option('long', 'show help on all commands')]
2924
takes_args = ['topic?']
2925
aliases = ['?', '--help', '-?', '-h']
2928
def run(self, topic=None, long=False):
2930
if topic is None and long:
2932
bzrlib.help.help(topic)
2935
class cmd_shell_complete(Command):
2936
"""Show appropriate completions for context.
2938
For a list of all available commands, say 'bzr shell-complete'.
2940
takes_args = ['context?']
2945
def run(self, context=None):
2946
import shellcomplete
2947
shellcomplete.shellcomplete(context)
2950
class cmd_fetch(Command):
2951
"""Copy in history from another branch but don't merge it.
2953
This is an internal method used for pull and merge.
2956
takes_args = ['from_branch', 'to_branch']
2957
def run(self, from_branch, to_branch):
2958
from bzrlib.fetch import Fetcher
2959
from_b = Branch.open(from_branch)
2960
to_b = Branch.open(to_branch)
2961
Fetcher(to_b, from_b)
2964
class cmd_missing(Command):
2965
"""Show unmerged/unpulled revisions between two branches.
2967
OTHER_BRANCH may be local or remote.
2970
_see_also = ['merge', 'pull']
2971
takes_args = ['other_branch?']
2972
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2974
'Display changes in the local branch only'),
2975
Option('theirs-only',
2976
'Display changes in the remote branch only'),
2981
encoding_type = 'replace'
2984
def run(self, other_branch=None, reverse=False, mine_only=False,
2985
theirs_only=False, log_format=None, long=False, short=False, line=False,
2986
show_ids=False, verbose=False):
2987
from bzrlib.missing import find_unmerged, iter_log_revisions
2988
from bzrlib.log import log_formatter
2989
local_branch = Branch.open_containing(u".")[0]
2990
parent = local_branch.get_parent()
2991
if other_branch is None:
2992
other_branch = parent
2993
if other_branch is None:
2994
raise errors.BzrCommandError("No peer location known or specified.")
2995
display_url = urlutils.unescape_for_display(parent,
2997
print "Using last location: " + display_url
2999
remote_branch = Branch.open(other_branch)
3000
if remote_branch.base == local_branch.base:
3001
remote_branch = local_branch
3002
local_branch.lock_read()
3004
remote_branch.lock_read()
3006
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
3007
if (log_format is None):
3008
log_format = log.log_formatter_registry.get_default(
3010
lf = log_format(to_file=self.outf,
3012
show_timezone='original')
3013
if reverse is False:
3014
local_extra.reverse()
3015
remote_extra.reverse()
3016
if local_extra and not theirs_only:
3017
print "You have %d extra revision(s):" % len(local_extra)
3018
for revision in iter_log_revisions(local_extra,
3019
local_branch.repository,
3021
lf.log_revision(revision)
3022
printed_local = True
3024
printed_local = False
3025
if remote_extra and not mine_only:
3026
if printed_local is True:
3028
print "You are missing %d revision(s):" % len(remote_extra)
3029
for revision in iter_log_revisions(remote_extra,
3030
remote_branch.repository,
3032
lf.log_revision(revision)
3033
if not remote_extra and not local_extra:
3035
print "Branches are up to date."
3039
remote_branch.unlock()
3041
local_branch.unlock()
3042
if not status_code and parent is None and other_branch is not None:
3043
local_branch.lock_write()
3045
# handle race conditions - a parent might be set while we run.
3046
if local_branch.get_parent() is None:
3047
local_branch.set_parent(remote_branch.base)
3049
local_branch.unlock()
3053
class cmd_plugins(Command):
3058
import bzrlib.plugin
3059
from inspect import getdoc
3060
for name, plugin in bzrlib.plugin.all_plugins().items():
3061
if getattr(plugin, '__path__', None) is not None:
3062
print plugin.__path__[0]
3063
elif getattr(plugin, '__file__', None) is not None:
3064
print plugin.__file__
3070
print '\t', d.split('\n')[0]
3073
class cmd_testament(Command):
3074
"""Show testament (signing-form) of a revision."""
3075
takes_options = ['revision',
3076
Option('long', help='Produce long-format testament'),
3077
Option('strict', help='Produce a strict-format'
3079
takes_args = ['branch?']
3081
def run(self, branch=u'.', revision=None, long=False, strict=False):
3082
from bzrlib.testament import Testament, StrictTestament
3084
testament_class = StrictTestament
3086
testament_class = Testament
3087
b = WorkingTree.open_containing(branch)[0].branch
3090
if revision is None:
3091
rev_id = b.last_revision()
3093
rev_id = revision[0].in_history(b).rev_id
3094
t = testament_class.from_revision(b.repository, rev_id)
3096
sys.stdout.writelines(t.as_text_lines())
3098
sys.stdout.write(t.as_short_text())
3103
class cmd_annotate(Command):
3104
"""Show the origin of each line in a file.
3106
This prints out the given file with an annotation on the left side
3107
indicating which revision, author and date introduced the change.
3109
If the origin is the same for a run of consecutive lines, it is
3110
shown only at the top, unless the --all option is given.
3112
# TODO: annotate directories; showing when each file was last changed
3113
# TODO: if the working copy is modified, show annotations on that
3114
# with new uncommitted lines marked
3115
aliases = ['ann', 'blame', 'praise']
3116
takes_args = ['filename']
3117
takes_options = [Option('all', help='show annotations on all lines'),
3118
Option('long', help='show date in annotations'),
3124
def run(self, filename, all=False, long=False, revision=None,
3126
from bzrlib.annotate import annotate_file
3127
tree, relpath = WorkingTree.open_containing(filename)
3128
branch = tree.branch
3131
if revision is None:
3132
revision_id = branch.last_revision()
3133
elif len(revision) != 1:
3134
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3136
revision_id = revision[0].in_history(branch).rev_id
3137
file_id = tree.path2id(relpath)
3138
tree = branch.repository.revision_tree(revision_id)
3139
file_version = tree.inventory[file_id].revision
3140
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
3146
class cmd_re_sign(Command):
3147
"""Create a digital signature for an existing revision."""
3148
# TODO be able to replace existing ones.
3150
hidden = True # is this right ?
3151
takes_args = ['revision_id*']
3152
takes_options = ['revision']
3154
def run(self, revision_id_list=None, revision=None):
3155
import bzrlib.gpg as gpg
3156
if revision_id_list is not None and revision is not None:
3157
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3158
if revision_id_list is None and revision is None:
3159
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3160
b = WorkingTree.open_containing(u'.')[0].branch
3161
gpg_strategy = gpg.GPGStrategy(b.get_config())
3162
if revision_id_list is not None:
3163
for revision_id in revision_id_list:
3164
b.repository.sign_revision(revision_id, gpg_strategy)
3165
elif revision is not None:
3166
if len(revision) == 1:
3167
revno, rev_id = revision[0].in_history(b)
3168
b.repository.sign_revision(rev_id, gpg_strategy)
3169
elif len(revision) == 2:
3170
# are they both on rh- if so we can walk between them
3171
# might be nice to have a range helper for arbitrary
3172
# revision paths. hmm.
3173
from_revno, from_revid = revision[0].in_history(b)
3174
to_revno, to_revid = revision[1].in_history(b)
3175
if to_revid is None:
3176
to_revno = b.revno()
3177
if from_revno is None or to_revno is None:
3178
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3179
for revno in range(from_revno, to_revno + 1):
3180
b.repository.sign_revision(b.get_rev_id(revno),
3183
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3186
class cmd_bind(Command):
3187
"""Convert the current branch into a checkout of the supplied branch.
3189
Once converted into a checkout, commits must succeed on the master branch
3190
before they will be applied to the local branch.
3193
_see_also = ['checkouts', 'unbind']
3194
takes_args = ['location?']
3197
def run(self, location=None):
3198
b, relpath = Branch.open_containing(u'.')
3199
if location is None:
3201
location = b.get_old_bound_location()
3202
except errors.UpgradeRequired:
3203
raise errors.BzrCommandError('No location supplied. '
3204
'This format does not remember old locations.')
3206
if location is None:
3207
raise errors.BzrCommandError('No location supplied and no '
3208
'previous location known')
3209
b_other = Branch.open(location)
3212
except errors.DivergedBranches:
3213
raise errors.BzrCommandError('These branches have diverged.'
3214
' Try merging, and then bind again.')
3217
class cmd_unbind(Command):
3218
"""Convert the current checkout into a regular branch.
3220
After unbinding, the local branch is considered independent and subsequent
3221
commits will be local only.
3224
_see_also = ['checkouts', 'bind']
3229
b, relpath = Branch.open_containing(u'.')
3231
raise errors.BzrCommandError('Local branch is not bound')
3234
class cmd_uncommit(Command):
3235
"""Remove the last committed revision.
3237
--verbose will print out what is being removed.
3238
--dry-run will go through all the motions, but not actually
3241
In the future, uncommit will create a revision bundle, which can then
3245
# TODO: jam 20060108 Add an option to allow uncommit to remove
3246
# unreferenced information in 'branch-as-repository' branches.
3247
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3248
# information in shared branches as well.
3249
_see_also = ['commit']
3250
takes_options = ['verbose', 'revision',
3251
Option('dry-run', help='Don\'t actually make changes'),
3252
Option('force', help='Say yes to all questions.')]
3253
takes_args = ['location?']
3256
def run(self, location=None,
3257
dry_run=False, verbose=False,
3258
revision=None, force=False):
3259
from bzrlib.log import log_formatter, show_log
3261
from bzrlib.uncommit import uncommit
3263
if location is None:
3265
control, relpath = bzrdir.BzrDir.open_containing(location)
3267
tree = control.open_workingtree()
3269
except (errors.NoWorkingTree, errors.NotLocalUrl):
3271
b = control.open_branch()
3274
if revision is None:
3277
# 'bzr uncommit -r 10' actually means uncommit
3278
# so that the final tree is at revno 10.
3279
# but bzrlib.uncommit.uncommit() actually uncommits
3280
# the revisions that are supplied.
3281
# So we need to offset it by one
3282
revno = revision[0].in_history(b).revno+1
3284
if revno <= b.revno():
3285
rev_id = b.get_rev_id(revno)
3287
self.outf.write('No revisions to uncommit.\n')
3290
lf = log_formatter('short',
3292
show_timezone='original')
3297
direction='forward',
3298
start_revision=revno,
3299
end_revision=b.revno())
3302
print 'Dry-run, pretending to remove the above revisions.'
3304
val = raw_input('Press <enter> to continue')
3306
print 'The above revision(s) will be removed.'
3308
val = raw_input('Are you sure [y/N]? ')
3309
if val.lower() not in ('y', 'yes'):
3313
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3317
class cmd_break_lock(Command):
3318
"""Break a dead lock on a repository, branch or working directory.
3320
CAUTION: Locks should only be broken when you are sure that the process
3321
holding the lock has been stopped.
3323
You can get information on what locks are open via the 'bzr info' command.
3328
takes_args = ['location?']
3330
def run(self, location=None, show=False):
3331
if location is None:
3333
control, relpath = bzrdir.BzrDir.open_containing(location)
3335
control.break_lock()
3336
except NotImplementedError:
3340
class cmd_wait_until_signalled(Command):
3341
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3343
This just prints a line to signal when it is ready, then blocks on stdin.
3349
sys.stdout.write("running\n")
3351
sys.stdin.readline()
3354
class cmd_serve(Command):
3355
"""Run the bzr server."""
3357
aliases = ['server']
3361
help='serve on stdin/out for use from inetd or sshd'),
3363
help='listen for connections on nominated port of the form '
3364
'[hostname:]portnumber. Passing 0 as the port number will '
3365
'result in a dynamically allocated port. Default port is '
3369
help='serve contents of directory',
3371
Option('allow-writes',
3372
help='By default the server is a readonly server. Supplying '
3373
'--allow-writes enables write access to the contents of '
3374
'the served directory and below. '
3378
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3379
from bzrlib.smart import medium, server
3380
from bzrlib.transport import get_transport
3381
from bzrlib.transport.chroot import ChrootServer
3382
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3383
if directory is None:
3384
directory = os.getcwd()
3385
url = urlutils.local_path_to_url(directory)
3386
if not allow_writes:
3387
url = 'readonly+' + url
3388
chroot_server = ChrootServer(get_transport(url))
3389
chroot_server.setUp()
3390
t = get_transport(chroot_server.get_url())
3392
smart_server = medium.SmartServerPipeStreamMedium(
3393
sys.stdin, sys.stdout, t)
3395
host = BZR_DEFAULT_INTERFACE
3397
port = BZR_DEFAULT_PORT
3400
host, port = port.split(':')
3402
smart_server = server.SmartTCPServer(t, host=host, port=port)
3403
print 'listening on port: ', smart_server.port
3405
# for the duration of this server, no UI output is permitted.
3406
# note that this may cause problems with blackbox tests. This should
3407
# be changed with care though, as we dont want to use bandwidth sending
3408
# progress over stderr to smart server clients!
3409
old_factory = ui.ui_factory
3411
ui.ui_factory = ui.SilentUIFactory()
3412
smart_server.serve()
3414
ui.ui_factory = old_factory
3417
class cmd_join(Command):
3418
"""Combine a subtree into its containing tree.
3420
This command is for experimental use only. It requires the target tree
3421
to be in dirstate-with-subtree format, which cannot be converted into
3424
The TREE argument should be an independent tree, inside another tree, but
3425
not part of it. (Such trees can be produced by "bzr split", but also by
3426
running "bzr branch" with the target inside a tree.)
3428
The result is a combined tree, with the subtree no longer an independant
3429
part. This is marked as a merge of the subtree into the containing tree,
3430
and all history is preserved.
3432
If --reference is specified, the subtree retains its independence. It can
3433
be branched by itself, and can be part of multiple projects at the same
3434
time. But operations performed in the containing tree, such as commit
3435
and merge, will recurse into the subtree.
3438
_see_also = ['split']
3439
takes_args = ['tree']
3440
takes_options = [Option('reference', 'join by reference')]
3443
def run(self, tree, reference=False):
3444
sub_tree = WorkingTree.open(tree)
3445
parent_dir = osutils.dirname(sub_tree.basedir)
3446
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3447
repo = containing_tree.branch.repository
3448
if not repo.supports_rich_root():
3449
raise errors.BzrCommandError(
3450
"Can't join trees because %s doesn't support rich root data.\n"
3451
"You can use bzr upgrade on the repository."
3455
containing_tree.add_reference(sub_tree)
3456
except errors.BadReferenceTarget, e:
3457
# XXX: Would be better to just raise a nicely printable
3458
# exception from the real origin. Also below. mbp 20070306
3459
raise errors.BzrCommandError("Cannot join %s. %s" %
3463
containing_tree.subsume(sub_tree)
3464
except errors.BadSubsumeSource, e:
3465
raise errors.BzrCommandError("Cannot join %s. %s" %
3469
class cmd_split(Command):
3470
"""Split a tree into two trees.
3472
This command is for experimental use only. It requires the target tree
3473
to be in dirstate-with-subtree format, which cannot be converted into
3476
The TREE argument should be a subdirectory of a working tree. That
3477
subdirectory will be converted into an independent tree, with its own
3478
branch. Commits in the top-level tree will not apply to the new subtree.
3479
If you want that behavior, do "bzr join --reference TREE".
3482
_see_also = ['join']
3483
takes_args = ['tree']
3487
def run(self, tree):
3488
containing_tree, subdir = WorkingTree.open_containing(tree)
3489
sub_id = containing_tree.path2id(subdir)
3491
raise errors.NotVersionedError(subdir)
3493
containing_tree.extract(sub_id)
3494
except errors.RootNotRich:
3495
raise errors.UpgradeRequired(containing_tree.branch.base)
3499
class cmd_merge_directive(Command):
3500
"""Generate a merge directive for auto-merge tools.
3502
A directive requests a merge to be performed, and also provides all the
3503
information necessary to do so. This means it must either include a
3504
revision bundle, or the location of a branch containing the desired
3507
A submit branch (the location to merge into) must be supplied the first
3508
time the command is issued. After it has been supplied once, it will
3509
be remembered as the default.
3511
A public branch is optional if a revision bundle is supplied, but required
3512
if --diff or --plain is specified. It will be remembered as the default
3513
after the first use.
3516
takes_args = ['submit_branch?', 'public_branch?']
3519
RegistryOption.from_kwargs('patch-type',
3520
'The type of patch to include in the directive',
3521
title='Patch type', value_switches=True, enum_switch=False,
3522
bundle='Bazaar revision bundle (default)',
3523
diff='Normal unified diff',
3524
plain='No patch, just directive'),
3525
Option('sign', help='GPG-sign the directive'), 'revision',
3526
Option('mail-to', type=str,
3527
help='Instead of printing the directive, email to this address'),
3528
Option('message', type=str, short_name='m',
3529
help='Message to use when committing this merge')
3532
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3533
sign=False, revision=None, mail_to=None, message=None):
3534
if patch_type == 'plain':
3536
branch = Branch.open('.')
3537
stored_submit_branch = branch.get_submit_branch()
3538
if submit_branch is None:
3539
submit_branch = stored_submit_branch
3541
if stored_submit_branch is None:
3542
branch.set_submit_branch(submit_branch)
3543
if submit_branch is None:
3544
submit_branch = branch.get_parent()
3545
if submit_branch is None:
3546
raise errors.BzrCommandError('No submit branch specified or known')
3548
stored_public_branch = branch.get_public_branch()
3549
if public_branch is None:
3550
public_branch = stored_public_branch
3551
elif stored_public_branch is None:
3552
branch.set_public_branch(public_branch)
3553
if patch_type != "bundle" and public_branch is None:
3554
raise errors.BzrCommandError('No public branch specified or'
3556
if revision is not None:
3557
if len(revision) != 1:
3558
raise errors.BzrCommandError('bzr merge-directive takes '
3559
'exactly one revision identifier')
3561
revision_id = revision[0].in_history(branch).rev_id
3563
revision_id = branch.last_revision()
3564
directive = merge_directive.MergeDirective.from_objects(
3565
branch.repository, revision_id, time.time(),
3566
osutils.local_time_offset(), submit_branch,
3567
public_branch=public_branch, patch_type=patch_type,
3571
self.outf.write(directive.to_signed(branch))
3573
self.outf.writelines(directive.to_lines())
3575
message = directive.to_email(mail_to, branch, sign)
3577
server = branch.get_config().get_user_option('smtp_server')
3579
server = 'localhost'
3581
s.sendmail(message['From'], message['To'], message.as_string())
3584
class cmd_tag(Command):
3585
"""Create a tag naming a revision.
3587
Tags give human-meaningful names to revisions. Commands that take a -r
3588
(--revision) option can be given -rtag:X, where X is any previously
3591
Tags are stored in the branch. Tags are copied from one branch to another
3592
along when you branch, push, pull or merge.
3594
It is an error to give a tag name that already exists unless you pass
3595
--force, in which case the tag is moved to point to the new revision.
3598
_see_also = ['commit', 'tags']
3599
takes_args = ['tag_name']
3602
help='Delete this tag rather than placing it.',
3605
help='Branch in which to place the tag.',
3610
help='Replace existing tags',
3615
def run(self, tag_name,
3621
branch, relpath = Branch.open_containing(directory)
3625
branch.tags.delete_tag(tag_name)
3626
self.outf.write('Deleted tag %s.\n' % tag_name)
3629
if len(revision) != 1:
3630
raise errors.BzrCommandError(
3631
"Tags can only be placed on a single revision, "
3633
revision_id = revision[0].in_history(branch).rev_id
3635
revision_id = branch.last_revision()
3636
if (not force) and branch.tags.has_tag(tag_name):
3637
raise errors.TagAlreadyExists(tag_name)
3638
branch.tags.set_tag(tag_name, revision_id)
3639
self.outf.write('Created tag %s.\n' % tag_name)
3644
class cmd_tags(Command):
3647
This tag shows a table of tag names and the revisions they reference.
3653
help='Branch whose tags should be displayed',
3663
branch, relpath = Branch.open_containing(directory)
3664
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3665
self.outf.write('%-20s %s\n' % (tag_name, target))
3668
# command-line interpretation helper for merge-related commands
3669
def _merge_helper(other_revision, base_revision,
3670
check_clean=True, ignore_zero=False,
3671
this_dir=None, backup_files=False,
3673
file_list=None, show_base=False, reprocess=False,
3676
change_reporter=None,
3678
"""Merge changes into a tree.
3681
list(path, revno) Base for three-way merge.
3682
If [None, None] then a base will be automatically determined.
3684
list(path, revno) Other revision for three-way merge.
3686
Directory to merge changes into; '.' by default.
3688
If true, this_dir must have no uncommitted changes before the
3690
ignore_zero - If true, suppress the "zero conflicts" message when
3691
there are no conflicts; should be set when doing something we expect
3692
to complete perfectly.
3693
file_list - If supplied, merge only changes to selected files.
3695
All available ancestors of other_revision and base_revision are
3696
automatically pulled into the branch.
3698
The revno may be -1 to indicate the last revision on the branch, which is
3701
This function is intended for use from the command line; programmatic
3702
clients might prefer to call merge.merge_inner(), which has less magic
3705
# Loading it late, so that we don't always have to import bzrlib.merge
3706
if merge_type is None:
3707
merge_type = _mod_merge.Merge3Merger
3708
if this_dir is None:
3710
this_tree = WorkingTree.open_containing(this_dir)[0]
3711
if show_base and not merge_type is _mod_merge.Merge3Merger:
3712
raise errors.BzrCommandError("Show-base is not supported for this merge"
3713
" type. %s" % merge_type)
3714
if reprocess and not merge_type.supports_reprocess:
3715
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3716
" type %s." % merge_type)
3717
if reprocess and show_base:
3718
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3719
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3720
# only want to take out a lock_tree_write() if we don't have to pull
3721
# any ancestry. But merge might fetch ancestry in the middle, in
3722
# which case we would need a lock_write().
3723
# Because we cannot upgrade locks, for now we live with the fact that
3724
# the tree will be locked multiple times during a merge. (Maybe
3725
# read-only some of the time, but it means things will get read
3728
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3729
pb=pb, change_reporter=change_reporter)
3730
merger.pp = ProgressPhase("Merge phase", 5, pb)
3731
merger.pp.next_phase()
3732
merger.check_basis(check_clean)
3733
if other_rev_id is not None:
3734
merger.set_other_revision(other_rev_id, this_tree.branch)
3736
merger.set_other(other_revision)
3737
merger.pp.next_phase()
3738
merger.set_base(base_revision)
3739
if merger.base_rev_id == merger.other_rev_id:
3740
note('Nothing to do.')
3742
if file_list is None:
3743
if pull and merger.base_rev_id == merger.this_rev_id:
3744
# FIXME: deduplicate with pull
3745
result = merger.this_tree.pull(merger.this_branch,
3746
False, merger.other_rev_id)
3747
if result.old_revid == result.new_revid:
3748
note('No revisions to pull.')
3750
note('Now on revision %d.' % result.new_revno)
3752
merger.backup_files = backup_files
3753
merger.merge_type = merge_type
3754
merger.set_interesting_files(file_list)
3755
merger.show_base = show_base
3756
merger.reprocess = reprocess
3757
conflicts = merger.do_merge()
3758
if file_list is None:
3759
merger.set_pending()
3766
merge = _merge_helper
3769
# these get imported and then picked up by the scan for cmd_*
3770
# TODO: Some more consistent way to split command definitions across files;
3771
# we do need to load at least some information about them to know of
3772
# aliases. ideally we would avoid loading the implementation until the
3773
# details were needed.
3774
from bzrlib.cmd_version_info import cmd_version_info
3775
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3776
from bzrlib.bundle.commands import cmd_bundle_revisions
3777
from bzrlib.sign_my_commits import cmd_sign_my_commits
3778
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3779
cmd_weave_plan_merge, cmd_weave_merge_text