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(), """
55
from bzrlib.branch import Branch
56
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
57
from bzrlib.conflicts import ConflictList
58
from bzrlib.revision import common_ancestor
59
from bzrlib.revisionspec import RevisionSpec
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import Command, display_command
64
from bzrlib.option import ListOption, Option, RegistryOption
65
from bzrlib.progress import DummyProgress, ProgressPhase
66
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
69
def tree_files(file_list, default_branch=u'.'):
71
return internal_tree_files(file_list, default_branch)
72
except errors.FileInWrongBranch, e:
73
raise errors.BzrCommandError("%s is not in the same branch as %s" %
74
(e.path, file_list[0]))
77
# XXX: Bad function name; should possibly also be a class method of
78
# WorkingTree rather than a function.
79
def internal_tree_files(file_list, default_branch=u'.'):
80
"""Convert command-line paths to a WorkingTree and relative paths.
82
This is typically used for command-line processors that take one or
83
more filenames, and infer the workingtree that contains them.
85
The filenames given are not required to exist.
87
:param file_list: Filenames to convert.
89
:param default_branch: Fallback tree path to use if file_list is empty or
92
:return: workingtree, [relative_paths]
94
if file_list is None or len(file_list) == 0:
95
return WorkingTree.open_containing(default_branch)[0], file_list
96
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
98
for filename in file_list:
100
new_list.append(tree.relpath(osutils.dereference_path(filename)))
101
except errors.PathNotChild:
102
raise errors.FileInWrongBranch(tree.branch, filename)
103
return tree, new_list
106
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
107
def get_format_type(typestring):
108
"""Parse and return a format specifier."""
109
# Have to use BzrDirMetaFormat1 directly, so that
110
# RepositoryFormat.set_default_format works
111
if typestring == "default":
112
return bzrdir.BzrDirMetaFormat1()
114
return bzrdir.format_registry.make_bzrdir(typestring)
116
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
117
raise errors.BzrCommandError(msg)
120
# TODO: Make sure no commands unconditionally use the working directory as a
121
# branch. If a filename argument is used, the first of them should be used to
122
# specify the branch. (Perhaps this can be factored out into some kind of
123
# Argument class, representing a file in a branch, where the first occurrence
126
class cmd_status(Command):
127
"""Display status summary.
129
This reports on versioned and unknown files, reporting them
130
grouped by state. Possible states are:
133
Versioned in the working copy but not in the previous revision.
136
Versioned in the previous revision but removed or deleted
140
Path of this file changed from the previous revision;
141
the text may also have changed. This includes files whose
142
parent directory was renamed.
145
Text has changed since the previous revision.
148
File kind has been changed (e.g. from file to directory).
151
Not versioned and not matching an ignore pattern.
153
To see ignored files use 'bzr ignored'. For details on the
154
changes to file texts, use 'bzr diff'.
156
--short gives a status flags for each item, similar to the SVN's status
159
Column 1: versioning / renames
165
P Entry for a pending merge (not a file)
174
* The execute bit was changed
176
If no arguments are specified, the status of the entire working
177
directory is shown. Otherwise, only the status of the specified
178
files or directories is reported. If a directory is given, status
179
is reported for everything inside that directory.
181
If a revision argument is given, the status is calculated against
182
that revision, or between two revisions if two are provided.
185
# TODO: --no-recurse, --recurse options
187
takes_args = ['file*']
188
takes_options = ['show-ids', 'revision',
189
Option('short', help='Give short SVN-style status lines'),
190
Option('versioned', help='Only show versioned files')]
191
aliases = ['st', 'stat']
193
encoding_type = 'replace'
194
_see_also = ['diff', 'revert']
197
def run(self, show_ids=False, file_list=None, revision=None, short=False,
199
from bzrlib.status import show_tree_status
201
tree, file_list = tree_files(file_list)
203
show_tree_status(tree, show_ids=show_ids,
204
specific_files=file_list, revision=revision,
205
to_file=self.outf, short=short, versioned=versioned)
208
class cmd_cat_revision(Command):
209
"""Write out metadata for a revision.
211
The revision to print can either be specified by a specific
212
revision identifier, or you can use --revision.
216
takes_args = ['revision_id?']
217
takes_options = ['revision']
218
# cat-revision is more for frontends so should be exact
222
def run(self, revision_id=None, revision=None):
224
revision_id = osutils.safe_revision_id(revision_id, warn=False)
225
if revision_id is not None and revision is not None:
226
raise errors.BzrCommandError('You can only supply one of'
227
' revision_id or --revision')
228
if revision_id is None and revision is None:
229
raise errors.BzrCommandError('You must supply either'
230
' --revision or a revision_id')
231
b = WorkingTree.open_containing(u'.')[0].branch
233
# TODO: jam 20060112 should cat-revision always output utf-8?
234
if revision_id is not None:
235
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
236
elif revision is not None:
239
raise errors.BzrCommandError('You cannot specify a NULL'
241
revno, rev_id = rev.in_history(b)
242
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
245
class cmd_remove_tree(Command):
246
"""Remove the working tree from a given branch/checkout.
248
Since a lightweight checkout is little more than a working tree
249
this will refuse to run against one.
251
To re-create the working tree, use "bzr checkout".
253
_see_also = ['checkout', 'working-trees']
255
takes_args = ['location?']
257
def run(self, location='.'):
258
d = bzrdir.BzrDir.open(location)
261
working = d.open_workingtree()
262
except errors.NoWorkingTree:
263
raise errors.BzrCommandError("No working tree to remove")
264
except errors.NotLocalUrl:
265
raise errors.BzrCommandError("You cannot remove the working tree of a "
268
working_path = working.bzrdir.root_transport.base
269
branch_path = working.branch.bzrdir.root_transport.base
270
if working_path != branch_path:
271
raise errors.BzrCommandError("You cannot remove the working tree from "
272
"a lightweight checkout")
274
d.destroy_workingtree()
277
class cmd_revno(Command):
278
"""Show current revision number.
280
This is equal to the number of revisions on this branch.
284
takes_args = ['location?']
287
def run(self, location=u'.'):
288
self.outf.write(str(Branch.open_containing(location)[0].revno()))
289
self.outf.write('\n')
292
class cmd_revision_info(Command):
293
"""Show revision number and revision id for a given revision identifier.
296
takes_args = ['revision_info*']
297
takes_options = ['revision']
300
def run(self, revision=None, revision_info_list=[]):
303
if revision is not None:
304
revs.extend(revision)
305
if revision_info_list is not None:
306
for rev in revision_info_list:
307
revs.append(RevisionSpec.from_string(rev))
309
b = Branch.open_containing(u'.')[0]
312
revs.append(RevisionSpec.from_string('-1'))
315
revinfo = rev.in_history(b)
316
if revinfo.revno is None:
317
dotted_map = b.get_revision_id_to_revno_map()
318
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
319
print '%s %s' % (revno, revinfo.rev_id)
321
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
324
class cmd_add(Command):
325
"""Add specified files or directories.
327
In non-recursive mode, all the named items are added, regardless
328
of whether they were previously ignored. A warning is given if
329
any of the named files are already versioned.
331
In recursive mode (the default), files are treated the same way
332
but the behaviour for directories is different. Directories that
333
are already versioned do not give a warning. All directories,
334
whether already versioned or not, are searched for files or
335
subdirectories that are neither versioned or ignored, and these
336
are added. This search proceeds recursively into versioned
337
directories. If no names are given '.' is assumed.
339
Therefore simply saying 'bzr add' will version all files that
340
are currently unknown.
342
Adding a file whose parent directory is not versioned will
343
implicitly add the parent, and so on up to the root. This means
344
you should never need to explicitly add a directory, they'll just
345
get added when you add a file in the directory.
347
--dry-run will show which files would be added, but not actually
350
--file-ids-from will try to use the file ids from the supplied path.
351
It looks up ids trying to find a matching parent directory with the
352
same filename, and then by pure path. This option is rarely needed
353
but can be useful when adding the same logical file into two
354
branches that will be merged later (without showing the two different
355
adds as a conflict). It is also useful when merging another project
356
into a subdirectory of this one.
358
takes_args = ['file*']
359
takes_options = ['no-recurse', 'dry-run', 'verbose',
360
Option('file-ids-from', type=unicode,
361
help='Lookup file ids from here')]
362
encoding_type = 'replace'
363
_see_also = ['remove']
365
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
370
if file_ids_from is not None:
372
base_tree, base_path = WorkingTree.open_containing(
374
except errors.NoWorkingTree:
375
base_branch, base_path = Branch.open_containing(
377
base_tree = base_branch.basis_tree()
379
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
380
to_file=self.outf, should_print=(not is_quiet()))
382
action = bzrlib.add.AddAction(to_file=self.outf,
383
should_print=(not is_quiet()))
386
base_tree.lock_read()
388
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
389
action=action, save=not dry_run)
391
if base_tree is not None:
395
for glob in sorted(ignored.keys()):
396
for path in ignored[glob]:
397
self.outf.write("ignored %s matching \"%s\"\n"
401
for glob, paths in ignored.items():
402
match_len += len(paths)
403
self.outf.write("ignored %d file(s).\n" % match_len)
404
self.outf.write("If you wish to add some of these files,"
405
" please add them by name.\n")
408
class cmd_mkdir(Command):
409
"""Create a new versioned directory.
411
This is equivalent to creating the directory and then adding it.
414
takes_args = ['dir+']
415
encoding_type = 'replace'
417
def run(self, dir_list):
420
wt, dd = WorkingTree.open_containing(d)
422
self.outf.write('added %s\n' % d)
425
class cmd_relpath(Command):
426
"""Show path of a file relative to root"""
428
takes_args = ['filename']
432
def run(self, filename):
433
# TODO: jam 20050106 Can relpath return a munged path if
434
# sys.stdout encoding cannot represent it?
435
tree, relpath = WorkingTree.open_containing(filename)
436
self.outf.write(relpath)
437
self.outf.write('\n')
440
class cmd_inventory(Command):
441
"""Show inventory of the current working copy or a revision.
443
It is possible to limit the output to a particular entry
444
type using the --kind option. For example: --kind file.
446
It is also possible to restrict the list of files to a specific
447
set. For example: bzr inventory --show-ids this/file
452
takes_options = ['revision', 'show-ids', 'kind']
453
takes_args = ['file*']
456
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
457
if kind and kind not in ['file', 'directory', 'symlink']:
458
raise errors.BzrCommandError('invalid kind specified')
460
work_tree, file_list = tree_files(file_list)
461
work_tree.lock_read()
463
if revision is not None:
464
if len(revision) > 1:
465
raise errors.BzrCommandError(
466
'bzr inventory --revision takes exactly one revision'
468
revision_id = revision[0].in_history(work_tree.branch).rev_id
469
tree = work_tree.branch.repository.revision_tree(revision_id)
471
extra_trees = [work_tree]
477
if file_list is not None:
478
file_ids = tree.paths2ids(file_list, trees=extra_trees,
479
require_versioned=True)
480
# find_ids_across_trees may include some paths that don't
482
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
483
for file_id in file_ids if file_id in tree)
485
entries = tree.inventory.entries()
488
if tree is not work_tree:
491
for path, entry in entries:
492
if kind and kind != entry.kind:
495
self.outf.write('%-50s %s\n' % (path, entry.file_id))
497
self.outf.write(path)
498
self.outf.write('\n')
501
class cmd_mv(Command):
502
"""Move or rename a file.
505
bzr mv OLDNAME NEWNAME
506
bzr mv SOURCE... DESTINATION
508
If the last argument is a versioned directory, all the other names
509
are moved into it. Otherwise, there must be exactly two arguments
510
and the file is changed to a new name.
512
If OLDNAME does not exist on the filesystem but is versioned and
513
NEWNAME does exist on the filesystem but is not versioned, mv
514
assumes that the file has been manually moved and only updates
515
its internal inventory to reflect that change.
516
The same is valid when moving many SOURCE files to a DESTINATION.
518
Files cannot be moved between branches.
521
takes_args = ['names*']
522
takes_options = [Option("after", help="move only the bzr identifier"
523
" of the file (file has already been moved). Use this flag if"
524
" bzr is not able to detect this itself.")]
525
aliases = ['move', 'rename']
526
encoding_type = 'replace'
528
def run(self, names_list, after=False):
529
if names_list is None:
532
if len(names_list) < 2:
533
raise errors.BzrCommandError("missing file argument")
534
tree, rel_names = tree_files(names_list)
536
if os.path.isdir(names_list[-1]):
537
# move into existing directory
538
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
539
self.outf.write("%s => %s\n" % pair)
541
if len(names_list) != 2:
542
raise errors.BzrCommandError('to mv multiple files the'
543
' destination must be a versioned'
545
tree.rename_one(rel_names[0], rel_names[1], after=after)
546
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
549
class cmd_pull(Command):
550
"""Turn this branch into a mirror of another branch.
552
This command only works on branches that have not diverged. Branches are
553
considered diverged if the destination branch's most recent commit is one
554
that has not been merged (directly or indirectly) into the parent.
556
If branches have diverged, you can use 'bzr merge' to integrate the changes
557
from one into the other. Once one branch has merged, the other should
558
be able to pull it again.
560
If you want to forget your local changes and just update your branch to
561
match the remote one, use pull --overwrite.
563
If there is no default location set, the first pull will set it. After
564
that, you can omit the location to use the default. To change the
565
default, use --remember. The value will only be saved if the remote
566
location can be accessed.
569
_see_also = ['push', 'update']
570
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
572
help='branch to pull into, '
573
'rather than the one containing the working directory',
578
takes_args = ['location?']
579
encoding_type = 'replace'
581
def run(self, location=None, remember=False, overwrite=False,
582
revision=None, verbose=False,
584
from bzrlib.tag import _merge_tags_if_possible
585
# FIXME: too much stuff is in the command class
588
if directory is None:
591
tree_to = WorkingTree.open_containing(directory)[0]
592
branch_to = tree_to.branch
593
except errors.NoWorkingTree:
595
branch_to = Branch.open_containing(directory)[0]
598
if location is not None:
600
mergeable = bundle.read_mergeable_from_url(
602
except errors.NotABundle:
603
pass # Continue on considering this url a Branch
605
stored_loc = branch_to.get_parent()
607
if stored_loc is None:
608
raise errors.BzrCommandError("No pull location known or"
611
display_url = urlutils.unescape_for_display(stored_loc,
613
self.outf.write("Using saved location: %s\n" % display_url)
614
location = stored_loc
616
if mergeable is not None:
617
if revision is not None:
618
raise errors.BzrCommandError(
619
'Cannot use -r with merge directives or bundles')
620
revision_id = mergeable.install_revisions(branch_to.repository)
621
branch_from = branch_to
623
branch_from = Branch.open(location)
625
if branch_to.get_parent() is None or remember:
626
branch_to.set_parent(branch_from.base)
628
if revision is not None:
629
if len(revision) == 1:
630
revision_id = revision[0].in_history(branch_from).rev_id
632
raise errors.BzrCommandError(
633
'bzr pull --revision takes one value.')
635
old_rh = branch_to.revision_history()
636
if tree_to is not None:
637
result = tree_to.pull(branch_from, overwrite, revision_id,
638
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
640
result = branch_to.pull(branch_from, overwrite, revision_id)
642
result.report(self.outf)
644
from bzrlib.log import show_changed_revisions
645
new_rh = branch_to.revision_history()
646
show_changed_revisions(branch_to, old_rh, new_rh,
650
class cmd_push(Command):
651
"""Update a mirror of this branch.
653
The target branch will not have its working tree populated because this
654
is both expensive, and is not supported on remote file systems.
656
Some smart servers or protocols *may* put the working tree in place in
659
This command only works on branches that have not diverged. Branches are
660
considered diverged if the destination branch's most recent commit is one
661
that has not been merged (directly or indirectly) by the source branch.
663
If branches have diverged, you can use 'bzr push --overwrite' to replace
664
the other branch completely, discarding its unmerged changes.
666
If you want to ensure you have the different changes in the other branch,
667
do a merge (see bzr help merge) from the other branch, and commit that.
668
After that you will be able to do a push without '--overwrite'.
670
If there is no default push location set, the first push will set it.
671
After that, you can omit the location to use the default. To change the
672
default, use --remember. The value will only be saved if the remote
673
location can be accessed.
676
_see_also = ['pull', 'update', 'working-trees']
677
takes_options = ['remember', 'overwrite', 'verbose',
678
Option('create-prefix',
679
help='Create the path leading up to the branch '
680
'if it does not already exist'),
682
help='branch to push from, '
683
'rather than the one containing the working directory',
687
Option('use-existing-dir',
688
help='By default push will fail if the target'
689
' directory exists, but does not already'
690
' have a control directory. This flag will'
691
' allow push to proceed.'),
693
takes_args = ['location?']
694
encoding_type = 'replace'
696
def run(self, location=None, remember=False, overwrite=False,
697
create_prefix=False, verbose=False,
698
use_existing_dir=False,
700
# FIXME: Way too big! Put this into a function called from the
702
if directory is None:
704
br_from = Branch.open_containing(directory)[0]
705
stored_loc = br_from.get_push_location()
707
if stored_loc is None:
708
raise errors.BzrCommandError("No push location known or specified.")
710
display_url = urlutils.unescape_for_display(stored_loc,
712
self.outf.write("Using saved location: %s\n" % display_url)
713
location = stored_loc
715
to_transport = transport.get_transport(location)
717
br_to = repository_to = dir_to = None
719
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
720
except errors.NotBranchError:
721
pass # Didn't find anything
723
# If we can open a branch, use its direct repository, otherwise see
724
# if there is a repository without a branch.
726
br_to = dir_to.open_branch()
727
except errors.NotBranchError:
728
# Didn't find a branch, can we find a repository?
730
repository_to = dir_to.find_repository()
731
except errors.NoRepositoryPresent:
734
# Found a branch, so we must have found a repository
735
repository_to = br_to.repository
739
# The destination doesn't exist; create it.
740
# XXX: Refactor the create_prefix/no_create_prefix code into a
741
# common helper function
743
to_transport.mkdir('.')
744
except errors.FileExists:
745
if not use_existing_dir:
746
raise errors.BzrCommandError("Target directory %s"
747
" already exists, but does not have a valid .bzr"
748
" directory. Supply --use-existing-dir to push"
749
" there anyway." % location)
750
except errors.NoSuchFile:
751
if not create_prefix:
752
raise errors.BzrCommandError("Parent directory of %s"
754
"\nYou may supply --create-prefix to create all"
755
" leading parent directories."
758
_create_prefix(to_transport)
760
# Now the target directory exists, but doesn't have a .bzr
761
# directory. So we need to create it, along with any work to create
762
# all of the dependent branches, etc.
763
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
764
revision_id=br_from.last_revision())
765
br_to = dir_to.open_branch()
766
# TODO: Some more useful message about what was copied
767
note('Created new branch.')
768
# We successfully created the target, remember it
769
if br_from.get_push_location() is None or remember:
770
br_from.set_push_location(br_to.base)
771
elif repository_to is None:
772
# we have a bzrdir but no branch or repository
773
# XXX: Figure out what to do other than complain.
774
raise errors.BzrCommandError("At %s you have a valid .bzr control"
775
" directory, but not a branch or repository. This is an"
776
" unsupported configuration. Please move the target directory"
777
" out of the way and try again."
780
# We have a repository but no branch, copy the revisions, and then
782
last_revision_id = br_from.last_revision()
783
repository_to.fetch(br_from.repository,
784
revision_id=last_revision_id)
785
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
786
note('Created new branch.')
787
if br_from.get_push_location() is None or remember:
788
br_from.set_push_location(br_to.base)
789
else: # We have a valid to branch
790
# We were able to connect to the remote location, so remember it
791
# we don't need to successfully push because of possible divergence.
792
if br_from.get_push_location() is None or remember:
793
br_from.set_push_location(br_to.base)
794
old_rh = br_to.revision_history()
797
tree_to = dir_to.open_workingtree()
798
except errors.NotLocalUrl:
799
warning("This transport does not update the working "
800
"tree of: %s. See 'bzr help working-trees' for "
801
"more information." % br_to.base)
802
push_result = br_from.push(br_to, overwrite)
803
except errors.NoWorkingTree:
804
push_result = br_from.push(br_to, overwrite)
808
push_result = br_from.push(tree_to.branch, overwrite)
812
except errors.DivergedBranches:
813
raise errors.BzrCommandError('These branches have diverged.'
814
' Try using "merge" and then "push".')
815
if push_result is not None:
816
push_result.report(self.outf)
818
new_rh = br_to.revision_history()
821
from bzrlib.log import show_changed_revisions
822
show_changed_revisions(br_to, old_rh, new_rh,
825
# we probably did a clone rather than a push, so a message was
830
class cmd_branch(Command):
831
"""Create a new copy of a branch.
833
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
834
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
835
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
836
is derived from the FROM_LOCATION by stripping a leading scheme or drive
837
identifier, if any. For example, "branch lp:foo-bar" will attempt to
840
To retrieve the branch as of a particular revision, supply the --revision
841
parameter, as in "branch foo/bar -r 5".
844
_see_also = ['checkout']
845
takes_args = ['from_location', 'to_location?']
846
takes_options = ['revision']
847
aliases = ['get', 'clone']
849
def run(self, from_location, to_location=None, revision=None):
850
from bzrlib.tag import _merge_tags_if_possible
853
elif len(revision) > 1:
854
raise errors.BzrCommandError(
855
'bzr branch --revision takes exactly 1 revision value')
857
br_from = Branch.open(from_location)
860
if len(revision) == 1 and revision[0] is not None:
861
revision_id = revision[0].in_history(br_from)[1]
863
# FIXME - wt.last_revision, fallback to branch, fall back to
864
# None or perhaps NULL_REVISION to mean copy nothing
866
revision_id = br_from.last_revision()
867
if to_location is None:
868
to_location = urlutils.derive_to_location(from_location)
871
name = os.path.basename(to_location) + '\n'
873
to_transport = transport.get_transport(to_location)
875
to_transport.mkdir('.')
876
except errors.FileExists:
877
raise errors.BzrCommandError('Target directory "%s" already'
878
' exists.' % to_location)
879
except errors.NoSuchFile:
880
raise errors.BzrCommandError('Parent of "%s" does not exist.'
883
# preserve whatever source format we have.
884
dir = br_from.bzrdir.sprout(to_transport.base, revision_id)
885
branch = dir.open_branch()
886
except errors.NoSuchRevision:
887
to_transport.delete_tree('.')
888
msg = "The branch %s has no revision %s." % (from_location, revision[0])
889
raise errors.BzrCommandError(msg)
891
branch.control_files.put_utf8('branch-name', name)
892
_merge_tags_if_possible(br_from, branch)
893
note('Branched %d revision(s).' % branch.revno())
898
class cmd_checkout(Command):
899
"""Create a new checkout of an existing branch.
901
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
902
the branch found in '.'. This is useful if you have removed the working tree
903
or if it was never created - i.e. if you pushed the branch to its current
906
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
907
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
908
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
909
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
910
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
913
To retrieve the branch as of a particular revision, supply the --revision
914
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
915
out of date [so you cannot commit] but it may be useful (i.e. to examine old
919
_see_also = ['checkouts', 'branch']
920
takes_args = ['branch_location?', 'to_location?']
921
takes_options = ['revision',
922
Option('lightweight',
923
help="perform a lightweight checkout. Lightweight "
924
"checkouts depend on access to the branch for "
925
"every operation. Normal checkouts can perform "
926
"common operations like diff and status without "
927
"such access, and also support local commits."
932
def run(self, branch_location=None, to_location=None, revision=None,
936
elif len(revision) > 1:
937
raise errors.BzrCommandError(
938
'bzr checkout --revision takes exactly 1 revision value')
939
if branch_location is None:
940
branch_location = osutils.getcwd()
941
to_location = branch_location
942
source = Branch.open(branch_location)
943
if len(revision) == 1 and revision[0] is not None:
944
revision_id = revision[0].in_history(source)[1]
947
if to_location is None:
948
to_location = urlutils.derive_to_location(branch_location)
949
# if the source and to_location are the same,
950
# and there is no working tree,
951
# then reconstitute a branch
952
if (osutils.abspath(to_location) ==
953
osutils.abspath(branch_location)):
955
source.bzrdir.open_workingtree()
956
except errors.NoWorkingTree:
957
source.bzrdir.create_workingtree()
960
os.mkdir(to_location)
962
if e.errno == errno.EEXIST:
963
raise errors.BzrCommandError('Target directory "%s" already'
964
' exists.' % to_location)
965
if e.errno == errno.ENOENT:
966
raise errors.BzrCommandError('Parent of "%s" does not exist.'
970
source.create_checkout(to_location, revision_id, lightweight)
973
class cmd_renames(Command):
974
"""Show list of renamed files.
976
# TODO: Option to show renames between two historical versions.
978
# TODO: Only show renames under dir, rather than in the whole branch.
979
_see_also = ['status']
980
takes_args = ['dir?']
983
def run(self, dir=u'.'):
984
tree = WorkingTree.open_containing(dir)[0]
987
new_inv = tree.inventory
988
old_tree = tree.basis_tree()
991
old_inv = old_tree.inventory
992
renames = list(_mod_tree.find_renames(old_inv, new_inv))
994
for old_name, new_name in renames:
995
self.outf.write("%s => %s\n" % (old_name, new_name))
1002
class cmd_update(Command):
1003
"""Update a tree to have the latest code committed to its branch.
1005
This will perform a merge into the working tree, and may generate
1006
conflicts. If you have any local changes, you will still
1007
need to commit them after the update for the update to be complete.
1009
If you want to discard your local changes, you can just do a
1010
'bzr revert' instead of 'bzr commit' after the update.
1013
_see_also = ['pull', 'working-trees']
1014
takes_args = ['dir?']
1017
def run(self, dir='.'):
1018
tree = WorkingTree.open_containing(dir)[0]
1019
master = tree.branch.get_master_branch()
1020
if master is not None:
1023
tree.lock_tree_write()
1025
existing_pending_merges = tree.get_parent_ids()[1:]
1026
last_rev = tree.last_revision()
1027
if last_rev == tree.branch.last_revision():
1028
# may be up to date, check master too.
1029
master = tree.branch.get_master_branch()
1030
if master is None or last_rev == master.last_revision():
1031
revno = tree.branch.revision_id_to_revno(last_rev)
1032
note("Tree is up to date at revision %d." % (revno,))
1034
conflicts = tree.update()
1035
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1036
note('Updated to revision %d.' % (revno,))
1037
if tree.get_parent_ids()[1:] != existing_pending_merges:
1038
note('Your local commits will now show as pending merges with '
1039
"'bzr status', and can be committed with 'bzr commit'.")
1048
class cmd_info(Command):
1049
"""Show information about a working tree, branch or repository.
1051
This command will show all known locations and formats associated to the
1052
tree, branch or repository. Statistical information is included with
1055
Branches and working trees will also report any missing revisions.
1057
_see_also = ['revno', 'working-trees', 'repositories']
1058
takes_args = ['location?']
1059
takes_options = ['verbose']
1062
def run(self, location=None, verbose=0):
1063
from bzrlib.info import show_bzrdir_info
1064
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1068
class cmd_remove(Command):
1069
"""Remove files or directories.
1071
This makes bzr stop tracking changes to the specified files and
1072
delete them if they can easily be recovered using revert.
1074
You can specify one or more files, and/or --new. If you specify --new,
1075
only 'added' files will be removed. If you specify both, then new files
1076
in the specified directories will be removed. If the directories are
1077
also new, they will also be removed.
1079
takes_args = ['file*']
1080
takes_options = ['verbose',
1081
Option('new', help='remove newly-added files'),
1082
RegistryOption.from_kwargs('file-deletion-strategy',
1083
'The file deletion mode to be used',
1084
title='Deletion Strategy', value_switches=True, enum_switch=False,
1085
safe='Only delete files if they can be'
1086
' safely recovered (default).',
1087
keep="Don't delete any files.",
1088
force='Delete all the specified files, even if they can not be '
1089
'recovered and even if they are non-empty directories.')]
1091
encoding_type = 'replace'
1093
def run(self, file_list, verbose=False, new=False,
1094
file_deletion_strategy='safe'):
1095
tree, file_list = tree_files(file_list)
1097
if file_list is not None:
1098
file_list = [f for f in file_list if f != '']
1100
raise errors.BzrCommandError('Specify one or more files to'
1101
' remove, or use --new.')
1104
added = tree.changes_from(tree.basis_tree(),
1105
specific_files=file_list).added
1106
file_list = sorted([f[0] for f in added], reverse=True)
1107
if len(file_list) == 0:
1108
raise errors.BzrCommandError('No matching files.')
1109
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1110
keep_files=file_deletion_strategy=='keep',
1111
force=file_deletion_strategy=='force')
1114
class cmd_file_id(Command):
1115
"""Print file_id of a particular file or directory.
1117
The file_id is assigned when the file is first added and remains the
1118
same through all revisions where the file exists, even when it is
1123
_see_also = ['inventory', 'ls']
1124
takes_args = ['filename']
1127
def run(self, filename):
1128
tree, relpath = WorkingTree.open_containing(filename)
1129
i = tree.path2id(relpath)
1131
raise errors.NotVersionedError(filename)
1133
self.outf.write(i + '\n')
1136
class cmd_file_path(Command):
1137
"""Print path of file_ids to a file or directory.
1139
This prints one line for each directory down to the target,
1140
starting at the branch root.
1144
takes_args = ['filename']
1147
def run(self, filename):
1148
tree, relpath = WorkingTree.open_containing(filename)
1149
fid = tree.path2id(relpath)
1151
raise errors.NotVersionedError(filename)
1152
segments = osutils.splitpath(relpath)
1153
for pos in range(1, len(segments) + 1):
1154
path = osutils.joinpath(segments[:pos])
1155
self.outf.write("%s\n" % tree.path2id(path))
1158
class cmd_reconcile(Command):
1159
"""Reconcile bzr metadata in a branch.
1161
This can correct data mismatches that may have been caused by
1162
previous ghost operations or bzr upgrades. You should only
1163
need to run this command if 'bzr check' or a bzr developer
1164
advises you to run it.
1166
If a second branch is provided, cross-branch reconciliation is
1167
also attempted, which will check that data like the tree root
1168
id which was not present in very early bzr versions is represented
1169
correctly in both branches.
1171
At the same time it is run it may recompress data resulting in
1172
a potential saving in disk space or performance gain.
1174
The branch *MUST* be on a listable system such as local disk or sftp.
1177
_see_also = ['check']
1178
takes_args = ['branch?']
1180
def run(self, branch="."):
1181
from bzrlib.reconcile import reconcile
1182
dir = bzrdir.BzrDir.open(branch)
1186
class cmd_revision_history(Command):
1187
"""Display the list of revision ids on a branch."""
1190
takes_args = ['location?']
1195
def run(self, location="."):
1196
branch = Branch.open_containing(location)[0]
1197
for revid in branch.revision_history():
1198
self.outf.write(revid)
1199
self.outf.write('\n')
1202
class cmd_ancestry(Command):
1203
"""List all revisions merged into this branch."""
1205
_see_also = ['log', 'revision-history']
1206
takes_args = ['location?']
1211
def run(self, location="."):
1213
wt = WorkingTree.open_containing(location)[0]
1214
except errors.NoWorkingTree:
1215
b = Branch.open(location)
1216
last_revision = b.last_revision()
1219
last_revision = wt.last_revision()
1221
revision_ids = b.repository.get_ancestry(last_revision)
1222
assert revision_ids[0] is None
1224
for revision_id in revision_ids:
1225
self.outf.write(revision_id + '\n')
1228
class cmd_init(Command):
1229
"""Make a directory into a versioned branch.
1231
Use this to create an empty branch, or before importing an
1234
If there is a repository in a parent directory of the location, then
1235
the history of the branch will be stored in the repository. Otherwise
1236
init creates a standalone branch which carries its own history
1237
in the .bzr directory.
1239
If there is already a branch at the location but it has no working tree,
1240
the tree can be populated with 'bzr checkout'.
1242
Recipe for importing a tree of files:
1247
bzr commit -m 'imported project'
1250
_see_also = ['init-repo', 'branch', 'checkout']
1251
takes_args = ['location?']
1253
Option('create-prefix',
1254
help='Create the path leading up to the branch '
1255
'if it does not already exist'),
1256
RegistryOption('format',
1257
help='Specify a format for this branch. '
1258
'See "help formats".',
1259
registry=bzrdir.format_registry,
1260
converter=bzrdir.format_registry.make_bzrdir,
1261
value_switches=True,
1262
title="Branch Format",
1264
Option('append-revisions-only',
1265
help='Never change revnos or the existing log.'
1266
' Append revisions to it only.')
1268
def run(self, location=None, format=None, append_revisions_only=False,
1269
create_prefix=False):
1271
format = bzrdir.format_registry.make_bzrdir('default')
1272
if location is None:
1275
to_transport = transport.get_transport(location)
1277
# The path has to exist to initialize a
1278
# branch inside of it.
1279
# Just using os.mkdir, since I don't
1280
# believe that we want to create a bunch of
1281
# locations if the user supplies an extended path
1283
to_transport.ensure_base()
1284
except errors.NoSuchFile:
1285
if not create_prefix:
1286
raise errors.BzrCommandError("Parent directory of %s"
1288
"\nYou may supply --create-prefix to create all"
1289
" leading parent directories."
1291
_create_prefix(to_transport)
1294
existing_bzrdir = bzrdir.BzrDir.open(location)
1295
except errors.NotBranchError:
1296
# really a NotBzrDir error...
1297
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1300
from bzrlib.transport.local import LocalTransport
1301
if existing_bzrdir.has_branch():
1302
if (isinstance(to_transport, LocalTransport)
1303
and not existing_bzrdir.has_workingtree()):
1304
raise errors.BranchExistsWithoutWorkingTree(location)
1305
raise errors.AlreadyBranchError(location)
1307
branch = existing_bzrdir.create_branch()
1308
existing_bzrdir.create_workingtree()
1309
if append_revisions_only:
1311
branch.set_append_revisions_only(True)
1312
except errors.UpgradeRequired:
1313
raise errors.BzrCommandError('This branch format cannot be set'
1314
' to append-revisions-only. Try --experimental-branch6')
1317
class cmd_init_repository(Command):
1318
"""Create a shared repository to hold branches.
1320
New branches created under the repository directory will store their
1321
revisions in the repository, not in the branch directory.
1323
If the --no-trees option is used then the branches in the repository
1324
will not have working trees by default.
1327
bzr init-repo --no-trees repo
1329
bzr checkout --lightweight repo/trunk trunk-checkout
1333
See 'bzr help repositories' for more information.
1336
_see_also = ['init', 'branch', 'checkout']
1337
takes_args = ["location"]
1338
takes_options = [RegistryOption('format',
1339
help='Specify a format for this repository. See'
1340
' "bzr help formats" for details',
1341
registry=bzrdir.format_registry,
1342
converter=bzrdir.format_registry.make_bzrdir,
1343
value_switches=True, title='Repository format'),
1345
help='Branches in the repository will default to'
1346
' not having a working tree'),
1348
aliases = ["init-repo"]
1350
def run(self, location, format=None, no_trees=False):
1352
format = bzrdir.format_registry.make_bzrdir('default')
1354
if location is None:
1357
to_transport = transport.get_transport(location)
1358
to_transport.ensure_base()
1360
newdir = format.initialize_on_transport(to_transport)
1361
repo = newdir.create_repository(shared=True)
1362
repo.set_make_working_trees(not no_trees)
1365
class cmd_diff(Command):
1366
"""Show differences in the working tree or between revisions.
1368
If files are listed, only the changes in those files are listed.
1369
Otherwise, all changes for the tree are listed.
1371
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1372
produces patches suitable for "patch -p1".
1376
Shows the difference in the working tree versus the last commit
1378
Difference between the working tree and revision 1
1380
Difference between revision 2 and revision 1
1381
bzr diff --prefix old/:new/
1382
Same as 'bzr diff' but prefix paths with old/ and new/
1383
bzr diff bzr.mine bzr.dev
1384
Show the differences between the two working trees
1386
Show just the differences for 'foo.c'
1388
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1389
# or a graphical diff.
1391
# TODO: Python difflib is not exactly the same as unidiff; should
1392
# either fix it up or prefer to use an external diff.
1394
# TODO: Selected-file diff is inefficient and doesn't show you
1397
# TODO: This probably handles non-Unix newlines poorly.
1399
_see_also = ['status']
1400
takes_args = ['file*']
1401
takes_options = ['revision', 'diff-options',
1402
Option('prefix', type=str,
1404
help='Set prefixes to added to old and new filenames, as '
1405
'two values separated by a colon. (eg "old/:new/")'),
1407
aliases = ['di', 'dif']
1408
encoding_type = 'exact'
1411
def run(self, revision=None, file_list=None, diff_options=None,
1413
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1415
if (prefix is None) or (prefix == '0'):
1423
old_label, new_label = prefix.split(":")
1425
raise errors.BzrCommandError(
1426
'--prefix expects two values separated by a colon'
1427
' (eg "old/:new/")')
1429
if revision and len(revision) > 2:
1430
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1431
' one or two revision specifiers')
1434
tree1, file_list = internal_tree_files(file_list)
1438
except errors.FileInWrongBranch:
1439
if len(file_list) != 2:
1440
raise errors.BzrCommandError("Files are in different branches")
1442
tree1, file1 = WorkingTree.open_containing(file_list[0])
1443
tree2, file2 = WorkingTree.open_containing(file_list[1])
1444
if file1 != "" or file2 != "":
1445
# FIXME diff those two files. rbc 20051123
1446
raise errors.BzrCommandError("Files are in different branches")
1448
except errors.NotBranchError:
1449
if (revision is not None and len(revision) == 2
1450
and not revision[0].needs_branch()
1451
and not revision[1].needs_branch()):
1452
# If both revision specs include a branch, we can
1453
# diff them without needing a local working tree
1454
tree1, tree2 = None, None
1458
if tree2 is not None:
1459
if revision is not None:
1460
# FIXME: but there should be a clean way to diff between
1461
# non-default versions of two trees, it's not hard to do
1463
raise errors.BzrCommandError(
1464
"Sorry, diffing arbitrary revisions across branches "
1465
"is not implemented yet")
1466
return show_diff_trees(tree1, tree2, sys.stdout,
1467
specific_files=file_list,
1468
external_diff_options=diff_options,
1469
old_label=old_label, new_label=new_label)
1471
return diff_cmd_helper(tree1, file_list, diff_options,
1472
revision_specs=revision,
1473
old_label=old_label, new_label=new_label)
1476
class cmd_deleted(Command):
1477
"""List files deleted in the working tree.
1479
# TODO: Show files deleted since a previous revision, or
1480
# between two revisions.
1481
# TODO: Much more efficient way to do this: read in new
1482
# directories with readdir, rather than stating each one. Same
1483
# level of effort but possibly much less IO. (Or possibly not,
1484
# if the directories are very large...)
1485
_see_also = ['status', 'ls']
1486
takes_options = ['show-ids']
1489
def run(self, show_ids=False):
1490
tree = WorkingTree.open_containing(u'.')[0]
1493
old = tree.basis_tree()
1496
for path, ie in old.inventory.iter_entries():
1497
if not tree.has_id(ie.file_id):
1498
self.outf.write(path)
1500
self.outf.write(' ')
1501
self.outf.write(ie.file_id)
1502
self.outf.write('\n')
1509
class cmd_modified(Command):
1510
"""List files modified in working tree.
1514
_see_also = ['status', 'ls']
1518
tree = WorkingTree.open_containing(u'.')[0]
1519
td = tree.changes_from(tree.basis_tree())
1520
for path, id, kind, text_modified, meta_modified in td.modified:
1521
self.outf.write(path + '\n')
1524
class cmd_added(Command):
1525
"""List files added in working tree.
1529
_see_also = ['status', 'ls']
1533
wt = WorkingTree.open_containing(u'.')[0]
1536
basis = wt.basis_tree()
1539
basis_inv = basis.inventory
1542
if file_id in basis_inv:
1544
if inv.is_root(file_id) and len(basis_inv) == 0:
1546
path = inv.id2path(file_id)
1547
if not os.access(osutils.abspath(path), os.F_OK):
1549
self.outf.write(path + '\n')
1556
class cmd_root(Command):
1557
"""Show the tree root directory.
1559
The root is the nearest enclosing directory with a .bzr control
1562
takes_args = ['filename?']
1564
def run(self, filename=None):
1565
"""Print the branch root."""
1566
tree = WorkingTree.open_containing(filename)[0]
1567
self.outf.write(tree.basedir + '\n')
1570
def _parse_limit(limitstring):
1572
return int(limitstring)
1574
msg = "The limit argument must be an integer."
1575
raise errors.BzrCommandError(msg)
1578
class cmd_log(Command):
1579
"""Show log of a branch, file, or directory.
1581
By default show the log of the branch containing the working directory.
1583
To request a range of logs, you can use the command -r begin..end
1584
-r revision requests a specific revision, -r ..end or -r begin.. are
1590
bzr log -r -10.. http://server/branch
1593
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1595
takes_args = ['location?']
1596
takes_options = [Option('forward',
1597
help='show from oldest to newest'),
1601
help='show files changed in each revision'),
1602
'show-ids', 'revision',
1606
help='show revisions whose message matches this regexp',
1609
help='limit the output to the first N revisions',
1612
encoding_type = 'replace'
1615
def run(self, location=None, timezone='original',
1623
from bzrlib.log import show_log
1624
assert message is None or isinstance(message, basestring), \
1625
"invalid message argument %r" % message
1626
direction = (forward and 'forward') or 'reverse'
1631
# find the file id to log:
1633
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1637
tree = b.basis_tree()
1638
file_id = tree.path2id(fp)
1640
raise errors.BzrCommandError(
1641
"Path does not have any revision history: %s" %
1645
# FIXME ? log the current subdir only RBC 20060203
1646
if revision is not None \
1647
and len(revision) > 0 and revision[0].get_branch():
1648
location = revision[0].get_branch()
1651
dir, relpath = bzrdir.BzrDir.open_containing(location)
1652
b = dir.open_branch()
1656
if revision is None:
1659
elif len(revision) == 1:
1660
rev1 = rev2 = revision[0].in_history(b).revno
1661
elif len(revision) == 2:
1662
if revision[1].get_branch() != revision[0].get_branch():
1663
# b is taken from revision[0].get_branch(), and
1664
# show_log will use its revision_history. Having
1665
# different branches will lead to weird behaviors.
1666
raise errors.BzrCommandError(
1667
"Log doesn't accept two revisions in different"
1669
if revision[0].spec is None:
1670
# missing begin-range means first revision
1673
rev1 = revision[0].in_history(b).revno
1675
if revision[1].spec is None:
1676
# missing end-range means last known revision
1679
rev2 = revision[1].in_history(b).revno
1681
raise errors.BzrCommandError(
1682
'bzr log --revision takes one or two values.')
1684
# By this point, the revision numbers are converted to the +ve
1685
# form if they were supplied in the -ve form, so we can do
1686
# this comparison in relative safety
1688
(rev2, rev1) = (rev1, rev2)
1690
if log_format is None:
1691
log_format = log.log_formatter_registry.get_default(b)
1693
lf = log_format(show_ids=show_ids, to_file=self.outf,
1694
show_timezone=timezone)
1700
direction=direction,
1701
start_revision=rev1,
1709
def get_log_format(long=False, short=False, line=False, default='long'):
1710
log_format = default
1714
log_format = 'short'
1720
class cmd_touching_revisions(Command):
1721
"""Return revision-ids which affected a particular file.
1723
A more user-friendly interface is "bzr log FILE".
1727
takes_args = ["filename"]
1730
def run(self, filename):
1731
tree, relpath = WorkingTree.open_containing(filename)
1733
file_id = tree.path2id(relpath)
1734
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1735
self.outf.write("%6d %s\n" % (revno, what))
1738
class cmd_ls(Command):
1739
"""List files in a tree.
1742
_see_also = ['status', 'cat']
1743
takes_args = ['path?']
1744
# TODO: Take a revision or remote path and list that tree instead.
1745
takes_options = ['verbose', 'revision',
1746
Option('non-recursive',
1747
help='don\'t recurse into sub-directories'),
1749
help='Print all paths from the root of the branch.'),
1750
Option('unknown', help='Print unknown files'),
1751
Option('versioned', help='Print versioned files'),
1752
Option('ignored', help='Print ignored files'),
1754
Option('null', help='Null separate the files'),
1758
def run(self, revision=None, verbose=False,
1759
non_recursive=False, from_root=False,
1760
unknown=False, versioned=False, ignored=False,
1761
null=False, kind=None, show_ids=False, path=None):
1763
if kind and kind not in ('file', 'directory', 'symlink'):
1764
raise errors.BzrCommandError('invalid kind specified')
1766
if verbose and null:
1767
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1768
all = not (unknown or versioned or ignored)
1770
selection = {'I':ignored, '?':unknown, 'V':versioned}
1777
raise errors.BzrCommandError('cannot specify both --from-root'
1781
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1787
if revision is not None:
1788
tree = branch.repository.revision_tree(
1789
revision[0].in_history(branch).rev_id)
1791
tree = branch.basis_tree()
1795
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1796
if fp.startswith(relpath):
1797
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1798
if non_recursive and '/' in fp:
1800
if not all and not selection[fc]:
1802
if kind is not None and fkind != kind:
1805
kindch = entry.kind_character()
1806
outstring = '%-8s %s%s' % (fc, fp, kindch)
1807
if show_ids and fid is not None:
1808
outstring = "%-50s %s" % (outstring, fid)
1809
self.outf.write(outstring + '\n')
1811
self.outf.write(fp + '\0')
1814
self.outf.write(fid)
1815
self.outf.write('\0')
1823
self.outf.write('%-50s %s\n' % (fp, my_id))
1825
self.outf.write(fp + '\n')
1830
class cmd_unknowns(Command):
1831
"""List unknown files.
1839
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1840
self.outf.write(osutils.quotefn(f) + '\n')
1843
class cmd_ignore(Command):
1844
"""Ignore specified files or patterns.
1846
To remove patterns from the ignore list, edit the .bzrignore file.
1848
Trailing slashes on patterns are ignored.
1849
If the pattern contains a slash or is a regular expression, it is compared
1850
to the whole path from the branch root. Otherwise, it is compared to only
1851
the last component of the path. To match a file only in the root
1852
directory, prepend './'.
1854
Ignore patterns specifying absolute paths are not allowed.
1856
Ignore patterns may include globbing wildcards such as:
1857
? - Matches any single character except '/'
1858
* - Matches 0 or more characters except '/'
1859
/**/ - Matches 0 or more directories in a path
1860
[a-z] - Matches a single character from within a group of characters
1862
Ignore patterns may also be Python regular expressions.
1863
Regular expression ignore patterns are identified by a 'RE:' prefix
1864
followed by the regular expression. Regular expression ignore patterns
1865
may not include named or numbered groups.
1867
Note: ignore patterns containing shell wildcards must be quoted from
1871
bzr ignore ./Makefile
1872
bzr ignore '*.class'
1873
bzr ignore 'lib/**/*.o'
1874
bzr ignore 'RE:lib/.*\.o'
1877
_see_also = ['status', 'ignored']
1878
takes_args = ['name_pattern*']
1880
Option('old-default-rules',
1881
help='Out the ignore rules bzr < 0.9 always used.')
1884
def run(self, name_pattern_list=None, old_default_rules=None):
1885
from bzrlib.atomicfile import AtomicFile
1886
if old_default_rules is not None:
1887
# dump the rules and exit
1888
for pattern in ignores.OLD_DEFAULTS:
1891
if not name_pattern_list:
1892
raise errors.BzrCommandError("ignore requires at least one "
1893
"NAME_PATTERN or --old-default-rules")
1894
name_pattern_list = [globbing.normalize_pattern(p)
1895
for p in name_pattern_list]
1896
for name_pattern in name_pattern_list:
1897
if (name_pattern[0] == '/' or
1898
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1899
raise errors.BzrCommandError(
1900
"NAME_PATTERN should not be an absolute path")
1901
tree, relpath = WorkingTree.open_containing(u'.')
1902
ifn = tree.abspath('.bzrignore')
1903
if os.path.exists(ifn):
1906
igns = f.read().decode('utf-8')
1912
# TODO: If the file already uses crlf-style termination, maybe
1913
# we should use that for the newly added lines?
1915
if igns and igns[-1] != '\n':
1917
for name_pattern in name_pattern_list:
1918
igns += name_pattern + '\n'
1920
f = AtomicFile(ifn, 'wb')
1922
f.write(igns.encode('utf-8'))
1927
if not tree.path2id('.bzrignore'):
1928
tree.add(['.bzrignore'])
1931
class cmd_ignored(Command):
1932
"""List ignored files and the patterns that matched them.
1935
_see_also = ['ignore']
1938
tree = WorkingTree.open_containing(u'.')[0]
1941
for path, file_class, kind, file_id, entry in tree.list_files():
1942
if file_class != 'I':
1944
## XXX: Slightly inefficient since this was already calculated
1945
pat = tree.is_ignored(path)
1946
print '%-50s %s' % (path, pat)
1951
class cmd_lookup_revision(Command):
1952
"""Lookup the revision-id from a revision-number
1955
bzr lookup-revision 33
1958
takes_args = ['revno']
1961
def run(self, revno):
1965
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1967
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1970
class cmd_export(Command):
1971
"""Export current or past revision to a destination directory or archive.
1973
If no revision is specified this exports the last committed revision.
1975
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1976
given, try to find the format with the extension. If no extension
1977
is found exports to a directory (equivalent to --format=dir).
1979
If root is supplied, it will be used as the root directory inside
1980
container formats (tar, zip, etc). If it is not supplied it will default
1981
to the exported filename. The root option has no effect for 'dir' format.
1983
If branch is omitted then the branch containing the current working
1984
directory will be used.
1986
Note: Export of tree with non-ASCII filenames to zip is not supported.
1988
Supported formats Autodetected by extension
1989
----------------- -------------------------
1992
tbz2 .tar.bz2, .tbz2
1996
takes_args = ['dest', 'branch?']
1997
takes_options = ['revision', 'format', 'root']
1998
def run(self, dest, branch=None, revision=None, format=None, root=None):
1999
from bzrlib.export import export
2002
tree = WorkingTree.open_containing(u'.')[0]
2005
b = Branch.open(branch)
2007
if revision is None:
2008
# should be tree.last_revision FIXME
2009
rev_id = b.last_revision()
2011
if len(revision) != 1:
2012
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2013
rev_id = revision[0].in_history(b).rev_id
2014
t = b.repository.revision_tree(rev_id)
2016
export(t, dest, format, root)
2017
except errors.NoSuchExportFormat, e:
2018
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2021
class cmd_cat(Command):
2022
"""Write the contents of a file as of a given revision to standard output.
2024
If no revision is nominated, the last revision is used.
2026
Note: Take care to redirect standard output when using this command on a
2031
takes_options = ['revision', 'name-from-revision']
2032
takes_args = ['filename']
2033
encoding_type = 'exact'
2036
def run(self, filename, revision=None, name_from_revision=False):
2037
if revision is not None and len(revision) != 1:
2038
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2043
tree, b, relpath = \
2044
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2045
except errors.NotBranchError:
2048
if revision is not None and revision[0].get_branch() is not None:
2049
b = Branch.open(revision[0].get_branch())
2051
tree = b.basis_tree()
2052
if revision is None:
2053
revision_id = b.last_revision()
2055
revision_id = revision[0].in_history(b).rev_id
2057
cur_file_id = tree.path2id(relpath)
2058
rev_tree = b.repository.revision_tree(revision_id)
2059
old_file_id = rev_tree.path2id(relpath)
2061
if name_from_revision:
2062
if old_file_id is None:
2063
raise errors.BzrCommandError("%r is not present in revision %s"
2064
% (filename, revision_id))
2066
rev_tree.print_file(old_file_id)
2067
elif cur_file_id is not None:
2068
rev_tree.print_file(cur_file_id)
2069
elif old_file_id is not None:
2070
rev_tree.print_file(old_file_id)
2072
raise errors.BzrCommandError("%r is not present in revision %s" %
2073
(filename, revision_id))
2076
class cmd_local_time_offset(Command):
2077
"""Show the offset in seconds from GMT to local time."""
2081
print osutils.local_time_offset()
2085
class cmd_commit(Command):
2086
"""Commit changes into a new revision.
2088
If no arguments are given, the entire tree is committed.
2090
If selected files are specified, only changes to those files are
2091
committed. If a directory is specified then the directory and everything
2092
within it is committed.
2094
A selected-file commit may fail in some cases where the committed
2095
tree would be invalid. Consider::
2100
bzr commit foo -m "committing foo"
2101
bzr mv foo/bar foo/baz
2104
bzr commit foo/bar -m "committing bar but not baz"
2106
In the example above, the last commit will fail by design. This gives
2107
the user the opportunity to decide whether they want to commit the
2108
rename at the same time, separately first, or not at all. (As a general
2109
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2111
Note: A selected-file commit after a merge is not yet supported.
2113
# TODO: Run hooks on tree to-be-committed, and after commit.
2115
# TODO: Strict commit that fails if there are deleted files.
2116
# (what does "deleted files" mean ??)
2118
# TODO: Give better message for -s, --summary, used by tla people
2120
# XXX: verbose currently does nothing
2122
_see_also = ['bugs', 'uncommit']
2123
takes_args = ['selected*']
2124
takes_options = ['message', 'verbose',
2126
help='commit even if nothing has changed'),
2127
Option('file', type=str,
2130
help='file containing commit message'),
2132
help="refuse to commit if there are unknown "
2133
"files in the working tree."),
2134
ListOption('fixes', type=str,
2135
help="mark a bug as being fixed by this "
2138
help="perform a local only commit in a bound "
2139
"branch. Such commits are not pushed to "
2140
"the master branch until a normal commit "
2144
aliases = ['ci', 'checkin']
2146
def _get_bug_fix_properties(self, fixes, branch):
2148
# Configure the properties for bug fixing attributes.
2149
for fixed_bug in fixes:
2150
tokens = fixed_bug.split(':')
2151
if len(tokens) != 2:
2152
raise errors.BzrCommandError(
2153
"Invalid bug %s. Must be in the form of 'tag:id'. "
2154
"Commit refused." % fixed_bug)
2155
tag, bug_id = tokens
2157
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2158
except errors.UnknownBugTrackerAbbreviation:
2159
raise errors.BzrCommandError(
2160
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2161
except errors.MalformedBugIdentifier:
2162
raise errors.BzrCommandError(
2163
"Invalid bug identifier for %s. Commit refused."
2165
properties.append('%s fixed' % bug_url)
2166
return '\n'.join(properties)
2168
def run(self, message=None, file=None, verbose=True, selected_list=None,
2169
unchanged=False, strict=False, local=False, fixes=None):
2170
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2171
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2173
from bzrlib.msgeditor import edit_commit_message, \
2174
make_commit_message_template
2176
# TODO: Need a blackbox test for invoking the external editor; may be
2177
# slightly problematic to run this cross-platform.
2179
# TODO: do more checks that the commit will succeed before
2180
# spending the user's valuable time typing a commit message.
2184
tree, selected_list = tree_files(selected_list)
2185
if selected_list == ['']:
2186
# workaround - commit of root of tree should be exactly the same
2187
# as just default commit in that tree, and succeed even though
2188
# selected-file merge commit is not done yet
2191
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2193
properties['bugs'] = bug_property
2195
if local and not tree.branch.get_bound_location():
2196
raise errors.LocalRequiresBoundBranch()
2198
def get_message(commit_obj):
2199
"""Callback to get commit message"""
2200
my_message = message
2201
if my_message is None and not file:
2202
template = make_commit_message_template(tree, selected_list)
2203
my_message = edit_commit_message(template)
2204
if my_message is None:
2205
raise errors.BzrCommandError("please specify a commit"
2206
" message with either --message or --file")
2207
elif my_message and file:
2208
raise errors.BzrCommandError(
2209
"please specify either --message or --file")
2211
my_message = codecs.open(file, 'rt',
2212
bzrlib.user_encoding).read()
2213
if my_message == "":
2214
raise errors.BzrCommandError("empty commit message specified")
2218
reporter = ReportCommitToLog()
2220
reporter = NullCommitReporter()
2223
tree.commit(message_callback=get_message,
2224
specific_files=selected_list,
2225
allow_pointless=unchanged, strict=strict, local=local,
2226
reporter=reporter, revprops=properties)
2227
except PointlessCommit:
2228
# FIXME: This should really happen before the file is read in;
2229
# perhaps prepare the commit; get the message; then actually commit
2230
raise errors.BzrCommandError("no changes to commit."
2231
" use --unchanged to commit anyhow")
2232
except ConflictsInTree:
2233
raise errors.BzrCommandError('Conflicts detected in working '
2234
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2236
except StrictCommitFailed:
2237
raise errors.BzrCommandError("Commit refused because there are"
2238
" unknown files in the working tree.")
2239
except errors.BoundBranchOutOfDate, e:
2240
raise errors.BzrCommandError(str(e) + "\n"
2241
'To commit to master branch, run update and then commit.\n'
2242
'You can also pass --local to commit to continue working '
2246
class cmd_check(Command):
2247
"""Validate consistency of branch history.
2249
This command checks various invariants about the branch storage to
2250
detect data corruption or bzr bugs.
2253
_see_also = ['reconcile']
2254
takes_args = ['branch?']
2255
takes_options = ['verbose']
2257
def run(self, branch=None, verbose=False):
2258
from bzrlib.check import check
2260
tree = WorkingTree.open_containing()[0]
2261
branch = tree.branch
2263
branch = Branch.open(branch)
2264
check(branch, verbose)
2267
class cmd_upgrade(Command):
2268
"""Upgrade branch storage to current format.
2270
The check command or bzr developers may sometimes advise you to run
2271
this command. When the default format has changed you may also be warned
2272
during other operations to upgrade.
2275
_see_also = ['check']
2276
takes_args = ['url?']
2278
RegistryOption('format',
2279
help='Upgrade to a specific format. See "bzr help'
2280
' formats" for details',
2281
registry=bzrdir.format_registry,
2282
converter=bzrdir.format_registry.make_bzrdir,
2283
value_switches=True, title='Branch format'),
2286
def run(self, url='.', format=None):
2287
from bzrlib.upgrade import upgrade
2289
format = bzrdir.format_registry.make_bzrdir('default')
2290
upgrade(url, format)
2293
class cmd_whoami(Command):
2294
"""Show or set bzr user id.
2298
bzr whoami 'Frank Chu <fchu@example.com>'
2300
takes_options = [ Option('email',
2301
help='display email address only'),
2303
help='set identity for the current branch instead of '
2306
takes_args = ['name?']
2307
encoding_type = 'replace'
2310
def run(self, email=False, branch=False, name=None):
2312
# use branch if we're inside one; otherwise global config
2314
c = Branch.open_containing('.')[0].get_config()
2315
except errors.NotBranchError:
2316
c = config.GlobalConfig()
2318
self.outf.write(c.user_email() + '\n')
2320
self.outf.write(c.username() + '\n')
2323
# display a warning if an email address isn't included in the given name.
2325
config.extract_email_address(name)
2326
except errors.NoEmailInUsername, e:
2327
warning('"%s" does not seem to contain an email address. '
2328
'This is allowed, but not recommended.', name)
2330
# use global config unless --branch given
2332
c = Branch.open_containing('.')[0].get_config()
2334
c = config.GlobalConfig()
2335
c.set_user_option('email', name)
2338
class cmd_nick(Command):
2339
"""Print or set the branch nickname.
2341
If unset, the tree root directory name is used as the nickname
2342
To print the current nickname, execute with no argument.
2345
_see_also = ['info']
2346
takes_args = ['nickname?']
2347
def run(self, nickname=None):
2348
branch = Branch.open_containing(u'.')[0]
2349
if nickname is None:
2350
self.printme(branch)
2352
branch.nick = nickname
2355
def printme(self, branch):
2359
class cmd_selftest(Command):
2360
"""Run internal test suite.
2362
If arguments are given, they are regular expressions that say which tests
2363
should run. Tests matching any expression are run, and other tests are
2366
Alternatively if --first is given, matching tests are run first and then
2367
all other tests are run. This is useful if you have been working in a
2368
particular area, but want to make sure nothing else was broken.
2370
If --exclude is given, tests that match that regular expression are
2371
excluded, regardless of whether they match --first or not.
2373
To help catch accidential dependencies between tests, the --randomize
2374
option is useful. In most cases, the argument used is the word 'now'.
2375
Note that the seed used for the random number generator is displayed
2376
when this option is used. The seed can be explicitly passed as the
2377
argument to this option if required. This enables reproduction of the
2378
actual ordering used if and when an order sensitive problem is encountered.
2380
If --list-only is given, the tests that would be run are listed. This is
2381
useful when combined with --first, --exclude and/or --randomize to
2382
understand their impact. The test harness reports "Listed nn tests in ..."
2383
instead of "Ran nn tests in ..." when list mode is enabled.
2385
If the global option '--no-plugins' is given, plugins are not loaded
2386
before running the selftests. This has two effects: features provided or
2387
modified by plugins will not be tested, and tests provided by plugins will
2392
run only tests relating to 'ignore'
2393
bzr --no-plugins selftest -v
2394
disable plugins and list tests as they're run
2396
For each test, that needs actual disk access, bzr create their own
2397
subdirectory in the temporary testing directory (testXXXX.tmp).
2398
By default the name of such subdirectory is based on the name of the test.
2399
If option '--numbered-dirs' is given, bzr will use sequent numbers
2400
of running tests to create such subdirectories. This is default behavior
2401
on Windows because of path length limitation.
2403
# NB: this is used from the class without creating an instance, which is
2404
# why it does not have a self parameter.
2405
def get_transport_type(typestring):
2406
"""Parse and return a transport specifier."""
2407
if typestring == "sftp":
2408
from bzrlib.transport.sftp import SFTPAbsoluteServer
2409
return SFTPAbsoluteServer
2410
if typestring == "memory":
2411
from bzrlib.transport.memory import MemoryServer
2413
if typestring == "fakenfs":
2414
from bzrlib.transport.fakenfs import FakeNFSServer
2415
return FakeNFSServer
2416
msg = "No known transport type %s. Supported types are: sftp\n" %\
2418
raise errors.BzrCommandError(msg)
2421
takes_args = ['testspecs*']
2422
takes_options = ['verbose',
2424
help='stop when one test fails',
2427
Option('keep-output',
2428
help='keep output directories when tests fail'),
2430
help='Use a different transport by default '
2431
'throughout the test suite.',
2432
type=get_transport_type),
2433
Option('benchmark', help='run the bzr benchmarks.'),
2434
Option('lsprof-timed',
2435
help='generate lsprof output for benchmarked'
2436
' sections of code.'),
2437
Option('cache-dir', type=str,
2438
help='a directory to cache intermediate'
2439
' benchmark steps'),
2440
Option('clean-output',
2441
help='clean temporary tests directories'
2442
' without running tests'),
2444
help='run all tests, but run specified tests first',
2447
Option('numbered-dirs',
2448
help='use numbered dirs for TestCaseInTempDir'),
2450
help='list the tests instead of running them'),
2451
Option('randomize', type=str, argname="SEED",
2452
help='randomize the order of tests using the given'
2453
' seed or "now" for the current time'),
2454
Option('exclude', type=str, argname="PATTERN",
2456
help='exclude tests that match this regular'
2459
encoding_type = 'replace'
2461
def run(self, testspecs_list=None, verbose=None, one=False,
2462
keep_output=False, transport=None, benchmark=None,
2463
lsprof_timed=None, cache_dir=None, clean_output=False,
2464
first=False, numbered_dirs=None, list_only=False,
2465
randomize=None, exclude=None):
2467
from bzrlib.tests import selftest
2468
import bzrlib.benchmarks as benchmarks
2469
from bzrlib.benchmarks import tree_creator
2472
from bzrlib.tests import clean_selftest_output
2473
clean_selftest_output()
2476
trace.warning("notice: selftest --keep-output "
2477
"is no longer supported; "
2478
"test output is always removed")
2480
if numbered_dirs is None and sys.platform == 'win32':
2481
numbered_dirs = True
2483
if cache_dir is not None:
2484
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2485
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2486
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2488
if testspecs_list is not None:
2489
pattern = '|'.join(testspecs_list)
2493
test_suite_factory = benchmarks.test_suite
2496
# TODO: should possibly lock the history file...
2497
benchfile = open(".perf_history", "at", buffering=1)
2499
test_suite_factory = None
2504
result = selftest(verbose=verbose,
2506
stop_on_failure=one,
2507
transport=transport,
2508
test_suite_factory=test_suite_factory,
2509
lsprof_timed=lsprof_timed,
2510
bench_history=benchfile,
2511
matching_tests_first=first,
2512
numbered_dirs=numbered_dirs,
2513
list_only=list_only,
2514
random_seed=randomize,
2515
exclude_pattern=exclude
2518
if benchfile is not None:
2521
info('tests passed')
2523
info('tests failed')
2524
return int(not result)
2527
class cmd_version(Command):
2528
"""Show version of bzr."""
2532
from bzrlib.version import show_version
2536
class cmd_rocks(Command):
2537
"""Statement of optimism."""
2543
print "It sure does!"
2546
class cmd_find_merge_base(Command):
2547
"""Find and print a base revision for merging two branches."""
2548
# TODO: Options to specify revisions on either side, as if
2549
# merging only part of the history.
2550
takes_args = ['branch', 'other']
2554
def run(self, branch, other):
2555
from bzrlib.revision import MultipleRevisionSources
2557
branch1 = Branch.open_containing(branch)[0]
2558
branch2 = Branch.open_containing(other)[0]
2560
last1 = branch1.last_revision()
2561
last2 = branch2.last_revision()
2563
source = MultipleRevisionSources(branch1.repository,
2566
base_rev_id = common_ancestor(last1, last2, source)
2568
print 'merge base is revision %s' % base_rev_id
2571
class cmd_merge(Command):
2572
"""Perform a three-way merge.
2574
The branch is the branch you will merge from. By default, it will merge
2575
the latest revision. If you specify a revision, that revision will be
2576
merged. If you specify two revisions, the first will be used as a BASE,
2577
and the second one as OTHER. Revision numbers are always relative to the
2580
By default, bzr will try to merge in all new work from the other
2581
branch, automatically determining an appropriate base. If this
2582
fails, you may need to give an explicit base.
2584
Merge will do its best to combine the changes in two branches, but there
2585
are some kinds of problems only a human can fix. When it encounters those,
2586
it will mark a conflict. A conflict means that you need to fix something,
2587
before you should commit.
2589
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2591
If there is no default branch set, the first merge will set it. After
2592
that, you can omit the branch to use the default. To change the
2593
default, use --remember. The value will only be saved if the remote
2594
location can be accessed.
2596
The results of the merge are placed into the destination working
2597
directory, where they can be reviewed (with bzr diff), tested, and then
2598
committed to record the result of the merge.
2602
To merge the latest revision from bzr.dev:
2603
bzr merge ../bzr.dev
2605
To merge changes up to and including revision 82 from bzr.dev:
2606
bzr merge -r 82 ../bzr.dev
2608
To merge the changes introduced by 82, without previous changes:
2609
bzr merge -r 81..82 ../bzr.dev
2611
merge refuses to run if there are any uncommitted changes, unless
2615
_see_also = ['update', 'remerge']
2616
takes_args = ['branch?']
2617
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2618
Option('show-base', help="Show base revision text in "
2620
Option('uncommitted', help='Apply uncommitted changes'
2621
' from a working copy, instead of branch changes'),
2622
Option('pull', help='If the destination is already'
2623
' completely merged into the source, pull from the'
2624
' source rather than merging. When this happens,'
2625
' you do not need to commit the result.'),
2627
help='Branch to merge into, '
2628
'rather than the one containing the working directory',
2634
def run(self, branch=None, revision=None, force=False, merge_type=None,
2635
show_base=False, reprocess=False, remember=False,
2636
uncommitted=False, pull=False,
2639
from bzrlib.tag import _merge_tags_if_possible
2640
other_revision_id = None
2641
if merge_type is None:
2642
merge_type = _mod_merge.Merge3Merger
2644
if directory is None: directory = u'.'
2645
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2646
# inventory. Because merge is a mutating operation, it really
2647
# should be a lock_write() for the whole cmd_merge operation.
2648
# However, cmd_merge open's its own tree in _merge_helper, which
2649
# means if we lock here, the later lock_write() will always block.
2650
# Either the merge helper code should be updated to take a tree,
2651
# (What about tree.merge_from_branch?)
2652
tree = WorkingTree.open_containing(directory)[0]
2653
change_reporter = delta._ChangeReporter(
2654
unversioned_filter=tree.is_ignored)
2656
if branch is not None:
2658
mergeable = bundle.read_mergeable_from_url(
2660
except errors.NotABundle:
2661
pass # Continue on considering this url a Branch
2663
if revision is not None:
2664
raise errors.BzrCommandError(
2665
'Cannot use -r with merge directives or bundles')
2666
other_revision_id = mergeable.install_revisions(
2667
tree.branch.repository)
2668
revision = [RevisionSpec.from_string(
2669
'revid:' + other_revision_id)]
2671
if revision is None \
2672
or len(revision) < 1 or revision[0].needs_branch():
2673
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2675
if revision is None or len(revision) < 1:
2678
other = [branch, None]
2681
other = [branch, -1]
2682
other_branch, path = Branch.open_containing(branch)
2685
raise errors.BzrCommandError('Cannot use --uncommitted and'
2686
' --revision at the same time.')
2687
branch = revision[0].get_branch() or branch
2688
if len(revision) == 1:
2690
if other_revision_id is not None:
2695
other_branch, path = Branch.open_containing(branch)
2696
revno = revision[0].in_history(other_branch).revno
2697
other = [branch, revno]
2699
assert len(revision) == 2
2700
if None in revision:
2701
raise errors.BzrCommandError(
2702
"Merge doesn't permit empty revision specifier.")
2703
base_branch, path = Branch.open_containing(branch)
2704
branch1 = revision[1].get_branch() or branch
2705
other_branch, path1 = Branch.open_containing(branch1)
2706
if revision[0].get_branch() is not None:
2707
# then path was obtained from it, and is None.
2710
base = [branch, revision[0].in_history(base_branch).revno]
2711
other = [branch1, revision[1].in_history(other_branch).revno]
2713
if ((tree.branch.get_parent() is None or remember) and
2714
other_branch is not None):
2715
tree.branch.set_parent(other_branch.base)
2717
# pull tags now... it's a bit inconsistent to do it ahead of copying
2718
# the history but that's done inside the merge code
2719
if other_branch is not None:
2720
_merge_tags_if_possible(other_branch, tree.branch)
2723
interesting_files = [path]
2725
interesting_files = None
2726
pb = ui.ui_factory.nested_progress_bar()
2729
conflict_count = _merge_helper(
2730
other, base, other_rev_id=other_revision_id,
2731
check_clean=(not force),
2732
merge_type=merge_type,
2733
reprocess=reprocess,
2734
show_base=show_base,
2737
pb=pb, file_list=interesting_files,
2738
change_reporter=change_reporter)
2741
if conflict_count != 0:
2745
except errors.AmbiguousBase, e:
2746
m = ("sorry, bzr can't determine the right merge base yet\n"
2747
"candidates are:\n "
2748
+ "\n ".join(e.bases)
2750
"please specify an explicit base with -r,\n"
2751
"and (if you want) report this to the bzr developers\n")
2754
# TODO: move up to common parent; this isn't merge-specific anymore.
2755
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2756
"""Use tree.branch's parent if none was supplied.
2758
Report if the remembered location was used.
2760
if supplied_location is not None:
2761
return supplied_location
2762
stored_location = tree.branch.get_parent()
2763
mutter("%s", stored_location)
2764
if stored_location is None:
2765
raise errors.BzrCommandError("No location specified or remembered")
2766
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2767
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2768
return stored_location
2771
class cmd_remerge(Command):
2774
Use this if you want to try a different merge technique while resolving
2775
conflicts. Some merge techniques are better than others, and remerge
2776
lets you try different ones on different files.
2778
The options for remerge have the same meaning and defaults as the ones for
2779
merge. The difference is that remerge can (only) be run when there is a
2780
pending merge, and it lets you specify particular files.
2784
$ bzr remerge --show-base
2785
Re-do the merge of all conflicted files, and show the base text in
2786
conflict regions, in addition to the usual THIS and OTHER texts.
2788
$ bzr remerge --merge-type weave --reprocess foobar
2789
Re-do the merge of "foobar", using the weave merge algorithm, with
2790
additional processing to reduce the size of conflict regions.
2792
takes_args = ['file*']
2793
takes_options = ['merge-type', 'reprocess',
2794
Option('show-base', help="Show base revision text in "
2797
def run(self, file_list=None, merge_type=None, show_base=False,
2799
if merge_type is None:
2800
merge_type = _mod_merge.Merge3Merger
2801
tree, file_list = tree_files(file_list)
2804
parents = tree.get_parent_ids()
2805
if len(parents) != 2:
2806
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2807
" merges. Not cherrypicking or"
2809
repository = tree.branch.repository
2810
base_revision = common_ancestor(parents[0],
2811
parents[1], repository)
2812
base_tree = repository.revision_tree(base_revision)
2813
other_tree = repository.revision_tree(parents[1])
2814
interesting_ids = None
2816
conflicts = tree.conflicts()
2817
if file_list is not None:
2818
interesting_ids = set()
2819
for filename in file_list:
2820
file_id = tree.path2id(filename)
2822
raise errors.NotVersionedError(filename)
2823
interesting_ids.add(file_id)
2824
if tree.kind(file_id) != "directory":
2827
for name, ie in tree.inventory.iter_entries(file_id):
2828
interesting_ids.add(ie.file_id)
2829
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2831
# Remerge only supports resolving contents conflicts
2832
allowed_conflicts = ('text conflict', 'contents conflict')
2833
restore_files = [c.path for c in conflicts
2834
if c.typestring in allowed_conflicts]
2835
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2836
tree.set_conflicts(ConflictList(new_conflicts))
2837
if file_list is not None:
2838
restore_files = file_list
2839
for filename in restore_files:
2841
restore(tree.abspath(filename))
2842
except errors.NotConflicted:
2844
conflicts = _mod_merge.merge_inner(
2845
tree.branch, other_tree, base_tree,
2847
interesting_ids=interesting_ids,
2848
other_rev_id=parents[1],
2849
merge_type=merge_type,
2850
show_base=show_base,
2851
reprocess=reprocess)
2860
class cmd_revert(Command):
2861
"""Revert files to a previous revision.
2863
Giving a list of files will revert only those files. Otherwise, all files
2864
will be reverted. If the revision is not specified with '--revision', the
2865
last committed revision is used.
2867
To remove only some changes, without reverting to a prior version, use
2868
merge instead. For example, "merge . --r-2..-3" will remove the changes
2869
introduced by -2, without affecting the changes introduced by -1. Or
2870
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2872
By default, any files that have been manually changed will be backed up
2873
first. (Files changed only by merge are not backed up.) Backup files have
2874
'.~#~' appended to their name, where # is a number.
2876
When you provide files, you can use their current pathname or the pathname
2877
from the target revision. So you can use revert to "undelete" a file by
2878
name. If you name a directory, all the contents of that directory will be
2882
_see_also = ['cat', 'export']
2883
takes_options = ['revision', 'no-backup']
2884
takes_args = ['file*']
2886
def run(self, revision=None, no_backup=False, file_list=None):
2887
if file_list is not None:
2888
if len(file_list) == 0:
2889
raise errors.BzrCommandError("No files specified")
2893
tree, file_list = tree_files(file_list)
2894
if revision is None:
2895
# FIXME should be tree.last_revision
2896
rev_id = tree.last_revision()
2897
elif len(revision) != 1:
2898
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2900
rev_id = revision[0].in_history(tree.branch).rev_id
2901
pb = ui.ui_factory.nested_progress_bar()
2903
tree.revert(file_list,
2904
tree.branch.repository.revision_tree(rev_id),
2905
not no_backup, pb, report_changes=True)
2910
class cmd_assert_fail(Command):
2911
"""Test reporting of assertion failures"""
2912
# intended just for use in testing
2917
raise AssertionError("always fails")
2920
class cmd_help(Command):
2921
"""Show help on a command or other topic.
2924
_see_also = ['topics']
2925
takes_options = [Option('long', 'show help on all commands')]
2926
takes_args = ['topic?']
2927
aliases = ['?', '--help', '-?', '-h']
2930
def run(self, topic=None, long=False):
2932
if topic is None and long:
2934
bzrlib.help.help(topic)
2937
class cmd_shell_complete(Command):
2938
"""Show appropriate completions for context.
2940
For a list of all available commands, say 'bzr shell-complete'.
2942
takes_args = ['context?']
2947
def run(self, context=None):
2948
import shellcomplete
2949
shellcomplete.shellcomplete(context)
2952
class cmd_fetch(Command):
2953
"""Copy in history from another branch but don't merge it.
2955
This is an internal method used for pull and merge.
2958
takes_args = ['from_branch', 'to_branch']
2959
def run(self, from_branch, to_branch):
2960
from bzrlib.fetch import Fetcher
2961
from_b = Branch.open(from_branch)
2962
to_b = Branch.open(to_branch)
2963
Fetcher(to_b, from_b)
2966
class cmd_missing(Command):
2967
"""Show unmerged/unpulled revisions between two branches.
2969
OTHER_BRANCH may be local or remote.
2972
_see_also = ['merge', 'pull']
2973
takes_args = ['other_branch?']
2974
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2976
'Display changes in the local branch only'),
2977
Option('theirs-only',
2978
'Display changes in the remote branch only'),
2983
encoding_type = 'replace'
2986
def run(self, other_branch=None, reverse=False, mine_only=False,
2987
theirs_only=False, log_format=None, long=False, short=False, line=False,
2988
show_ids=False, verbose=False):
2989
from bzrlib.missing import find_unmerged, iter_log_revisions
2990
from bzrlib.log import log_formatter
2991
local_branch = Branch.open_containing(u".")[0]
2992
parent = local_branch.get_parent()
2993
if other_branch is None:
2994
other_branch = parent
2995
if other_branch is None:
2996
raise errors.BzrCommandError("No peer location known or specified.")
2997
display_url = urlutils.unescape_for_display(parent,
2999
print "Using last location: " + display_url
3001
remote_branch = Branch.open(other_branch)
3002
if remote_branch.base == local_branch.base:
3003
remote_branch = local_branch
3004
local_branch.lock_read()
3006
remote_branch.lock_read()
3008
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
3009
if (log_format is None):
3010
log_format = log.log_formatter_registry.get_default(
3012
lf = log_format(to_file=self.outf,
3014
show_timezone='original')
3015
if reverse is False:
3016
local_extra.reverse()
3017
remote_extra.reverse()
3018
if local_extra and not theirs_only:
3019
print "You have %d extra revision(s):" % len(local_extra)
3020
for revision in iter_log_revisions(local_extra,
3021
local_branch.repository,
3023
lf.log_revision(revision)
3024
printed_local = True
3026
printed_local = False
3027
if remote_extra and not mine_only:
3028
if printed_local is True:
3030
print "You are missing %d revision(s):" % len(remote_extra)
3031
for revision in iter_log_revisions(remote_extra,
3032
remote_branch.repository,
3034
lf.log_revision(revision)
3035
if not remote_extra and not local_extra:
3037
print "Branches are up to date."
3041
remote_branch.unlock()
3043
local_branch.unlock()
3044
if not status_code and parent is None and other_branch is not None:
3045
local_branch.lock_write()
3047
# handle race conditions - a parent might be set while we run.
3048
if local_branch.get_parent() is None:
3049
local_branch.set_parent(remote_branch.base)
3051
local_branch.unlock()
3055
class cmd_plugins(Command):
3060
import bzrlib.plugin
3061
from inspect import getdoc
3062
for name, plugin in bzrlib.plugin.all_plugins().items():
3063
if getattr(plugin, '__path__', None) is not None:
3064
print plugin.__path__[0]
3065
elif getattr(plugin, '__file__', None) is not None:
3066
print plugin.__file__
3072
print '\t', d.split('\n')[0]
3075
class cmd_testament(Command):
3076
"""Show testament (signing-form) of a revision."""
3077
takes_options = ['revision',
3078
Option('long', help='Produce long-format testament'),
3079
Option('strict', help='Produce a strict-format'
3081
takes_args = ['branch?']
3083
def run(self, branch=u'.', revision=None, long=False, strict=False):
3084
from bzrlib.testament import Testament, StrictTestament
3086
testament_class = StrictTestament
3088
testament_class = Testament
3089
b = WorkingTree.open_containing(branch)[0].branch
3092
if revision is None:
3093
rev_id = b.last_revision()
3095
rev_id = revision[0].in_history(b).rev_id
3096
t = testament_class.from_revision(b.repository, rev_id)
3098
sys.stdout.writelines(t.as_text_lines())
3100
sys.stdout.write(t.as_short_text())
3105
class cmd_annotate(Command):
3106
"""Show the origin of each line in a file.
3108
This prints out the given file with an annotation on the left side
3109
indicating which revision, author and date introduced the change.
3111
If the origin is the same for a run of consecutive lines, it is
3112
shown only at the top, unless the --all option is given.
3114
# TODO: annotate directories; showing when each file was last changed
3115
# TODO: if the working copy is modified, show annotations on that
3116
# with new uncommitted lines marked
3117
aliases = ['ann', 'blame', 'praise']
3118
takes_args = ['filename']
3119
takes_options = [Option('all', help='show annotations on all lines'),
3120
Option('long', help='show date in annotations'),
3126
def run(self, filename, all=False, long=False, revision=None,
3128
from bzrlib.annotate import annotate_file
3129
tree, relpath = WorkingTree.open_containing(filename)
3130
branch = tree.branch
3133
if revision is None:
3134
revision_id = branch.last_revision()
3135
elif len(revision) != 1:
3136
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3138
revision_id = revision[0].in_history(branch).rev_id
3139
file_id = tree.path2id(relpath)
3140
tree = branch.repository.revision_tree(revision_id)
3141
file_version = tree.inventory[file_id].revision
3142
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
3148
class cmd_re_sign(Command):
3149
"""Create a digital signature for an existing revision."""
3150
# TODO be able to replace existing ones.
3152
hidden = True # is this right ?
3153
takes_args = ['revision_id*']
3154
takes_options = ['revision']
3156
def run(self, revision_id_list=None, revision=None):
3157
import bzrlib.gpg as gpg
3158
if revision_id_list is not None and revision is not None:
3159
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3160
if revision_id_list is None and revision is None:
3161
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3162
b = WorkingTree.open_containing(u'.')[0].branch
3163
gpg_strategy = gpg.GPGStrategy(b.get_config())
3164
if revision_id_list is not None:
3165
for revision_id in revision_id_list:
3166
b.repository.sign_revision(revision_id, gpg_strategy)
3167
elif revision is not None:
3168
if len(revision) == 1:
3169
revno, rev_id = revision[0].in_history(b)
3170
b.repository.sign_revision(rev_id, gpg_strategy)
3171
elif len(revision) == 2:
3172
# are they both on rh- if so we can walk between them
3173
# might be nice to have a range helper for arbitrary
3174
# revision paths. hmm.
3175
from_revno, from_revid = revision[0].in_history(b)
3176
to_revno, to_revid = revision[1].in_history(b)
3177
if to_revid is None:
3178
to_revno = b.revno()
3179
if from_revno is None or to_revno is None:
3180
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3181
for revno in range(from_revno, to_revno + 1):
3182
b.repository.sign_revision(b.get_rev_id(revno),
3185
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3188
class cmd_bind(Command):
3189
"""Convert the current branch into a checkout of the supplied branch.
3191
Once converted into a checkout, commits must succeed on the master branch
3192
before they will be applied to the local branch.
3195
_see_also = ['checkouts', 'unbind']
3196
takes_args = ['location?']
3199
def run(self, location=None):
3200
b, relpath = Branch.open_containing(u'.')
3201
if location is None:
3203
location = b.get_old_bound_location()
3204
except errors.UpgradeRequired:
3205
raise errors.BzrCommandError('No location supplied. '
3206
'This format does not remember old locations.')
3208
if location is None:
3209
raise errors.BzrCommandError('No location supplied and no '
3210
'previous location known')
3211
b_other = Branch.open(location)
3214
except errors.DivergedBranches:
3215
raise errors.BzrCommandError('These branches have diverged.'
3216
' Try merging, and then bind again.')
3219
class cmd_unbind(Command):
3220
"""Convert the current checkout into a regular branch.
3222
After unbinding, the local branch is considered independent and subsequent
3223
commits will be local only.
3226
_see_also = ['checkouts', 'bind']
3231
b, relpath = Branch.open_containing(u'.')
3233
raise errors.BzrCommandError('Local branch is not bound')
3236
class cmd_uncommit(Command):
3237
"""Remove the last committed revision.
3239
--verbose will print out what is being removed.
3240
--dry-run will go through all the motions, but not actually
3243
In the future, uncommit will create a revision bundle, which can then
3247
# TODO: jam 20060108 Add an option to allow uncommit to remove
3248
# unreferenced information in 'branch-as-repository' branches.
3249
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3250
# information in shared branches as well.
3251
_see_also = ['commit']
3252
takes_options = ['verbose', 'revision',
3253
Option('dry-run', help='Don\'t actually make changes'),
3254
Option('force', help='Say yes to all questions.')]
3255
takes_args = ['location?']
3258
def run(self, location=None,
3259
dry_run=False, verbose=False,
3260
revision=None, force=False):
3261
from bzrlib.log import log_formatter, show_log
3263
from bzrlib.uncommit import uncommit
3265
if location is None:
3267
control, relpath = bzrdir.BzrDir.open_containing(location)
3269
tree = control.open_workingtree()
3271
except (errors.NoWorkingTree, errors.NotLocalUrl):
3273
b = control.open_branch()
3276
if revision is None:
3279
# 'bzr uncommit -r 10' actually means uncommit
3280
# so that the final tree is at revno 10.
3281
# but bzrlib.uncommit.uncommit() actually uncommits
3282
# the revisions that are supplied.
3283
# So we need to offset it by one
3284
revno = revision[0].in_history(b).revno+1
3286
if revno <= b.revno():
3287
rev_id = b.get_rev_id(revno)
3289
self.outf.write('No revisions to uncommit.\n')
3292
lf = log_formatter('short',
3294
show_timezone='original')
3299
direction='forward',
3300
start_revision=revno,
3301
end_revision=b.revno())
3304
print 'Dry-run, pretending to remove the above revisions.'
3306
val = raw_input('Press <enter> to continue')
3308
print 'The above revision(s) will be removed.'
3310
val = raw_input('Are you sure [y/N]? ')
3311
if val.lower() not in ('y', 'yes'):
3315
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3319
class cmd_break_lock(Command):
3320
"""Break a dead lock on a repository, branch or working directory.
3322
CAUTION: Locks should only be broken when you are sure that the process
3323
holding the lock has been stopped.
3325
You can get information on what locks are open via the 'bzr info' command.
3330
takes_args = ['location?']
3332
def run(self, location=None, show=False):
3333
if location is None:
3335
control, relpath = bzrdir.BzrDir.open_containing(location)
3337
control.break_lock()
3338
except NotImplementedError:
3342
class cmd_wait_until_signalled(Command):
3343
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3345
This just prints a line to signal when it is ready, then blocks on stdin.
3351
sys.stdout.write("running\n")
3353
sys.stdin.readline()
3356
class cmd_serve(Command):
3357
"""Run the bzr server."""
3359
aliases = ['server']
3363
help='serve on stdin/out for use from inetd or sshd'),
3365
help='listen for connections on nominated port of the form '
3366
'[hostname:]portnumber. Passing 0 as the port number will '
3367
'result in a dynamically allocated port. Default port is '
3371
help='serve contents of directory',
3373
Option('allow-writes',
3374
help='By default the server is a readonly server. Supplying '
3375
'--allow-writes enables write access to the contents of '
3376
'the served directory and below. '
3380
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3381
from bzrlib.smart import medium, server
3382
from bzrlib.transport import get_transport
3383
from bzrlib.transport.chroot import ChrootServer
3384
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3385
if directory is None:
3386
directory = os.getcwd()
3387
url = urlutils.local_path_to_url(directory)
3388
if not allow_writes:
3389
url = 'readonly+' + url
3390
chroot_server = ChrootServer(get_transport(url))
3391
chroot_server.setUp()
3392
t = get_transport(chroot_server.get_url())
3394
smart_server = medium.SmartServerPipeStreamMedium(
3395
sys.stdin, sys.stdout, t)
3397
host = BZR_DEFAULT_INTERFACE
3399
port = BZR_DEFAULT_PORT
3402
host, port = port.split(':')
3404
smart_server = server.SmartTCPServer(t, host=host, port=port)
3405
print 'listening on port: ', smart_server.port
3407
# for the duration of this server, no UI output is permitted.
3408
# note that this may cause problems with blackbox tests. This should
3409
# be changed with care though, as we dont want to use bandwidth sending
3410
# progress over stderr to smart server clients!
3411
old_factory = ui.ui_factory
3413
ui.ui_factory = ui.SilentUIFactory()
3414
smart_server.serve()
3416
ui.ui_factory = old_factory
3419
class cmd_join(Command):
3420
"""Combine a subtree into its containing tree.
3422
This command is for experimental use only. It requires the target tree
3423
to be in dirstate-with-subtree format, which cannot be converted into
3426
The TREE argument should be an independent tree, inside another tree, but
3427
not part of it. (Such trees can be produced by "bzr split", but also by
3428
running "bzr branch" with the target inside a tree.)
3430
The result is a combined tree, with the subtree no longer an independant
3431
part. This is marked as a merge of the subtree into the containing tree,
3432
and all history is preserved.
3434
If --reference is specified, the subtree retains its independence. It can
3435
be branched by itself, and can be part of multiple projects at the same
3436
time. But operations performed in the containing tree, such as commit
3437
and merge, will recurse into the subtree.
3440
_see_also = ['split']
3441
takes_args = ['tree']
3442
takes_options = [Option('reference', 'join by reference')]
3445
def run(self, tree, reference=False):
3446
sub_tree = WorkingTree.open(tree)
3447
parent_dir = osutils.dirname(sub_tree.basedir)
3448
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3449
repo = containing_tree.branch.repository
3450
if not repo.supports_rich_root():
3451
raise errors.BzrCommandError(
3452
"Can't join trees because %s doesn't support rich root data.\n"
3453
"You can use bzr upgrade on the repository."
3457
containing_tree.add_reference(sub_tree)
3458
except errors.BadReferenceTarget, e:
3459
# XXX: Would be better to just raise a nicely printable
3460
# exception from the real origin. Also below. mbp 20070306
3461
raise errors.BzrCommandError("Cannot join %s. %s" %
3465
containing_tree.subsume(sub_tree)
3466
except errors.BadSubsumeSource, e:
3467
raise errors.BzrCommandError("Cannot join %s. %s" %
3471
class cmd_split(Command):
3472
"""Split a tree into two trees.
3474
This command is for experimental use only. It requires the target tree
3475
to be in dirstate-with-subtree format, which cannot be converted into
3478
The TREE argument should be a subdirectory of a working tree. That
3479
subdirectory will be converted into an independent tree, with its own
3480
branch. Commits in the top-level tree will not apply to the new subtree.
3481
If you want that behavior, do "bzr join --reference TREE".
3484
_see_also = ['join']
3485
takes_args = ['tree']
3489
def run(self, tree):
3490
containing_tree, subdir = WorkingTree.open_containing(tree)
3491
sub_id = containing_tree.path2id(subdir)
3493
raise errors.NotVersionedError(subdir)
3495
containing_tree.extract(sub_id)
3496
except errors.RootNotRich:
3497
raise errors.UpgradeRequired(containing_tree.branch.base)
3501
class cmd_merge_directive(Command):
3502
"""Generate a merge directive for auto-merge tools.
3504
A directive requests a merge to be performed, and also provides all the
3505
information necessary to do so. This means it must either include a
3506
revision bundle, or the location of a branch containing the desired
3509
A submit branch (the location to merge into) must be supplied the first
3510
time the command is issued. After it has been supplied once, it will
3511
be remembered as the default.
3513
A public branch is optional if a revision bundle is supplied, but required
3514
if --diff or --plain is specified. It will be remembered as the default
3515
after the first use.
3518
takes_args = ['submit_branch?', 'public_branch?']
3521
RegistryOption.from_kwargs('patch-type',
3522
'The type of patch to include in the directive',
3523
title='Patch type', value_switches=True, enum_switch=False,
3524
bundle='Bazaar revision bundle (default)',
3525
diff='Normal unified diff',
3526
plain='No patch, just directive'),
3527
Option('sign', help='GPG-sign the directive'), 'revision',
3528
Option('mail-to', type=str,
3529
help='Instead of printing the directive, email to this address'),
3530
Option('message', type=str, short_name='m',
3531
help='Message to use when committing this merge')
3534
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3535
sign=False, revision=None, mail_to=None, message=None):
3536
if patch_type == 'plain':
3538
branch = Branch.open('.')
3539
stored_submit_branch = branch.get_submit_branch()
3540
if submit_branch is None:
3541
submit_branch = stored_submit_branch
3543
if stored_submit_branch is None:
3544
branch.set_submit_branch(submit_branch)
3545
if submit_branch is None:
3546
submit_branch = branch.get_parent()
3547
if submit_branch is None:
3548
raise errors.BzrCommandError('No submit branch specified or known')
3550
stored_public_branch = branch.get_public_branch()
3551
if public_branch is None:
3552
public_branch = stored_public_branch
3553
elif stored_public_branch is None:
3554
branch.set_public_branch(public_branch)
3555
if patch_type != "bundle" and public_branch is None:
3556
raise errors.BzrCommandError('No public branch specified or'
3558
if revision is not None:
3559
if len(revision) != 1:
3560
raise errors.BzrCommandError('bzr merge-directive takes '
3561
'exactly one revision identifier')
3563
revision_id = revision[0].in_history(branch).rev_id
3565
revision_id = branch.last_revision()
3566
directive = merge_directive.MergeDirective.from_objects(
3567
branch.repository, revision_id, time.time(),
3568
osutils.local_time_offset(), submit_branch,
3569
public_branch=public_branch, patch_type=patch_type,
3573
self.outf.write(directive.to_signed(branch))
3575
self.outf.writelines(directive.to_lines())
3577
message = directive.to_email(mail_to, branch, sign)
3579
server = branch.get_config().get_user_option('smtp_server')
3581
server = 'localhost'
3583
s.sendmail(message['From'], message['To'], message.as_string())
3586
class cmd_tag(Command):
3587
"""Create a tag naming a revision.
3589
Tags give human-meaningful names to revisions. Commands that take a -r
3590
(--revision) option can be given -rtag:X, where X is any previously
3593
Tags are stored in the branch. Tags are copied from one branch to another
3594
along when you branch, push, pull or merge.
3596
It is an error to give a tag name that already exists unless you pass
3597
--force, in which case the tag is moved to point to the new revision.
3600
_see_also = ['commit', 'tags']
3601
takes_args = ['tag_name']
3604
help='Delete this tag rather than placing it.',
3607
help='Branch in which to place the tag.',
3612
help='Replace existing tags',
3617
def run(self, tag_name,
3623
branch, relpath = Branch.open_containing(directory)
3627
branch.tags.delete_tag(tag_name)
3628
self.outf.write('Deleted tag %s.\n' % tag_name)
3631
if len(revision) != 1:
3632
raise errors.BzrCommandError(
3633
"Tags can only be placed on a single revision, "
3635
revision_id = revision[0].in_history(branch).rev_id
3637
revision_id = branch.last_revision()
3638
if (not force) and branch.tags.has_tag(tag_name):
3639
raise errors.TagAlreadyExists(tag_name)
3640
branch.tags.set_tag(tag_name, revision_id)
3641
self.outf.write('Created tag %s.\n' % tag_name)
3646
class cmd_tags(Command):
3649
This tag shows a table of tag names and the revisions they reference.
3655
help='Branch whose tags should be displayed',
3665
branch, relpath = Branch.open_containing(directory)
3666
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3667
self.outf.write('%-20s %s\n' % (tag_name, target))
3670
# command-line interpretation helper for merge-related commands
3671
def _merge_helper(other_revision, base_revision,
3672
check_clean=True, ignore_zero=False,
3673
this_dir=None, backup_files=False,
3675
file_list=None, show_base=False, reprocess=False,
3678
change_reporter=None,
3680
"""Merge changes into a tree.
3683
list(path, revno) Base for three-way merge.
3684
If [None, None] then a base will be automatically determined.
3686
list(path, revno) Other revision for three-way merge.
3688
Directory to merge changes into; '.' by default.
3690
If true, this_dir must have no uncommitted changes before the
3692
ignore_zero - If true, suppress the "zero conflicts" message when
3693
there are no conflicts; should be set when doing something we expect
3694
to complete perfectly.
3695
file_list - If supplied, merge only changes to selected files.
3697
All available ancestors of other_revision and base_revision are
3698
automatically pulled into the branch.
3700
The revno may be -1 to indicate the last revision on the branch, which is
3703
This function is intended for use from the command line; programmatic
3704
clients might prefer to call merge.merge_inner(), which has less magic
3707
# Loading it late, so that we don't always have to import bzrlib.merge
3708
if merge_type is None:
3709
merge_type = _mod_merge.Merge3Merger
3710
if this_dir is None:
3712
this_tree = WorkingTree.open_containing(this_dir)[0]
3713
if show_base and not merge_type is _mod_merge.Merge3Merger:
3714
raise errors.BzrCommandError("Show-base is not supported for this merge"
3715
" type. %s" % merge_type)
3716
if reprocess and not merge_type.supports_reprocess:
3717
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3718
" type %s." % merge_type)
3719
if reprocess and show_base:
3720
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3721
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3722
# only want to take out a lock_tree_write() if we don't have to pull
3723
# any ancestry. But merge might fetch ancestry in the middle, in
3724
# which case we would need a lock_write().
3725
# Because we cannot upgrade locks, for now we live with the fact that
3726
# the tree will be locked multiple times during a merge. (Maybe
3727
# read-only some of the time, but it means things will get read
3730
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3731
pb=pb, change_reporter=change_reporter)
3732
merger.pp = ProgressPhase("Merge phase", 5, pb)
3733
merger.pp.next_phase()
3734
merger.check_basis(check_clean)
3735
if other_rev_id is not None:
3736
merger.set_other_revision(other_rev_id, this_tree.branch)
3738
merger.set_other(other_revision)
3739
merger.pp.next_phase()
3740
merger.set_base(base_revision)
3741
if merger.base_rev_id == merger.other_rev_id:
3742
note('Nothing to do.')
3744
if file_list is None:
3745
if pull and merger.base_rev_id == merger.this_rev_id:
3746
# FIXME: deduplicate with pull
3747
result = merger.this_tree.pull(merger.this_branch,
3748
False, merger.other_rev_id)
3749
if result.old_revid == result.new_revid:
3750
note('No revisions to pull.')
3752
note('Now on revision %d.' % result.new_revno)
3754
merger.backup_files = backup_files
3755
merger.merge_type = merge_type
3756
merger.set_interesting_files(file_list)
3757
merger.show_base = show_base
3758
merger.reprocess = reprocess
3759
conflicts = merger.do_merge()
3760
if file_list is None:
3761
merger.set_pending()
3767
def _create_prefix(cur_transport):
3768
needed = [cur_transport]
3769
# Recurse upwards until we can create a directory successfully
3771
new_transport = cur_transport.clone('..')
3772
if new_transport.base == cur_transport.base:
3773
raise errors.BzrCommandError("Failed to create path"
3777
new_transport.mkdir('.')
3778
except errors.NoSuchFile:
3779
needed.append(new_transport)
3780
cur_transport = new_transport
3784
# Now we only need to create child directories
3786
cur_transport = needed.pop()
3787
cur_transport.ensure_base()
3790
merge = _merge_helper
3793
# these get imported and then picked up by the scan for cmd_*
3794
# TODO: Some more consistent way to split command definitions across files;
3795
# we do need to load at least some information about them to know of
3796
# aliases. ideally we would avoid loading the implementation until the
3797
# details were needed.
3798
from bzrlib.cmd_version_info import cmd_version_info
3799
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3800
from bzrlib.bundle.commands import cmd_bundle_revisions
3801
from bzrlib.sign_my_commits import cmd_sign_my_commits
3802
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3803
cmd_weave_plan_merge, cmd_weave_merge_text