1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
20
from StringIO import StringIO
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
54
from bzrlib.branch import Branch
55
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revisionspec import RevisionSpec
58
from bzrlib.smtp_connection import SMTPConnection
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import ListOption, Option, RegistryOption
64
from bzrlib.progress import DummyProgress, ProgressPhase
65
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
68
def tree_files(file_list, default_branch=u'.'):
70
return internal_tree_files(file_list, default_branch)
71
except errors.FileInWrongBranch, e:
72
raise errors.BzrCommandError("%s is not in the same branch as %s" %
73
(e.path, file_list[0]))
76
# XXX: Bad function name; should possibly also be a class method of
77
# WorkingTree rather than a function.
78
def internal_tree_files(file_list, default_branch=u'.'):
79
"""Convert command-line paths to a WorkingTree and relative paths.
81
This is typically used for command-line processors that take one or
82
more filenames, and infer the workingtree that contains them.
84
The filenames given are not required to exist.
86
:param file_list: Filenames to convert.
88
:param default_branch: Fallback tree path to use if file_list is empty or
91
:return: workingtree, [relative_paths]
93
if file_list is None or len(file_list) == 0:
94
return WorkingTree.open_containing(default_branch)[0], file_list
95
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
97
for filename in file_list:
99
new_list.append(tree.relpath(osutils.dereference_path(filename)))
100
except errors.PathNotChild:
101
raise errors.FileInWrongBranch(tree.branch, filename)
102
return tree, new_list
105
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
106
def get_format_type(typestring):
107
"""Parse and return a format specifier."""
108
# Have to use BzrDirMetaFormat1 directly, so that
109
# RepositoryFormat.set_default_format works
110
if typestring == "default":
111
return bzrdir.BzrDirMetaFormat1()
113
return bzrdir.format_registry.make_bzrdir(typestring)
115
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
116
raise errors.BzrCommandError(msg)
119
# TODO: Make sure no commands unconditionally use the working directory as a
120
# branch. If a filename argument is used, the first of them should be used to
121
# specify the branch. (Perhaps this can be factored out into some kind of
122
# Argument class, representing a file in a branch, where the first occurrence
125
class cmd_status(Command):
126
"""Display status summary.
128
This reports on versioned and unknown files, reporting them
129
grouped by state. Possible states are:
132
Versioned in the working copy but not in the previous revision.
135
Versioned in the previous revision but removed or deleted
139
Path of this file changed from the previous revision;
140
the text may also have changed. This includes files whose
141
parent directory was renamed.
144
Text has changed since the previous revision.
147
File kind has been changed (e.g. from file to directory).
150
Not versioned and not matching an ignore pattern.
152
To see ignored files use 'bzr ignored'. For details on the
153
changes to file texts, use 'bzr diff'.
155
--short gives a status flags for each item, similar to the SVN's status
158
If no arguments are specified, the status of the entire working
159
directory is shown. Otherwise, only the status of the specified
160
files or directories is reported. If a directory is given, status
161
is reported for everything inside that directory.
163
If a revision argument is given, the status is calculated against
164
that revision, or between two revisions if two are provided.
167
# TODO: --no-recurse, --recurse options
169
takes_args = ['file*']
170
takes_options = ['show-ids', 'revision',
171
Option('short', help='Give short SVN-style status lines.'),
172
Option('versioned', help='Only show versioned files.')]
173
aliases = ['st', 'stat']
175
encoding_type = 'replace'
176
_see_also = ['diff', 'revert', 'status-flags']
179
def run(self, show_ids=False, file_list=None, revision=None, short=False,
181
from bzrlib.status import show_tree_status
183
tree, file_list = tree_files(file_list)
185
show_tree_status(tree, show_ids=show_ids,
186
specific_files=file_list, revision=revision,
187
to_file=self.outf, short=short, versioned=versioned)
190
class cmd_cat_revision(Command):
191
"""Write out metadata for a revision.
193
The revision to print can either be specified by a specific
194
revision identifier, or you can use --revision.
198
takes_args = ['revision_id?']
199
takes_options = ['revision']
200
# cat-revision is more for frontends so should be exact
204
def run(self, revision_id=None, revision=None):
206
revision_id = osutils.safe_revision_id(revision_id, warn=False)
207
if revision_id is not None and revision is not None:
208
raise errors.BzrCommandError('You can only supply one of'
209
' revision_id or --revision')
210
if revision_id is None and revision is None:
211
raise errors.BzrCommandError('You must supply either'
212
' --revision or a revision_id')
213
b = WorkingTree.open_containing(u'.')[0].branch
215
# TODO: jam 20060112 should cat-revision always output utf-8?
216
if revision_id is not None:
217
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
218
elif revision is not None:
221
raise errors.BzrCommandError('You cannot specify a NULL'
223
revno, rev_id = rev.in_history(b)
224
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
227
class cmd_remove_tree(Command):
228
"""Remove the working tree from a given branch/checkout.
230
Since a lightweight checkout is little more than a working tree
231
this will refuse to run against one.
233
To re-create the working tree, use "bzr checkout".
235
_see_also = ['checkout', 'working-trees']
237
takes_args = ['location?']
239
def run(self, location='.'):
240
d = bzrdir.BzrDir.open(location)
243
working = d.open_workingtree()
244
except errors.NoWorkingTree:
245
raise errors.BzrCommandError("No working tree to remove")
246
except errors.NotLocalUrl:
247
raise errors.BzrCommandError("You cannot remove the working tree of a "
250
working_path = working.bzrdir.root_transport.base
251
branch_path = working.branch.bzrdir.root_transport.base
252
if working_path != branch_path:
253
raise errors.BzrCommandError("You cannot remove the working tree from "
254
"a lightweight checkout")
256
d.destroy_workingtree()
259
class cmd_revno(Command):
260
"""Show current revision number.
262
This is equal to the number of revisions on this branch.
266
takes_args = ['location?']
269
def run(self, location=u'.'):
270
self.outf.write(str(Branch.open_containing(location)[0].revno()))
271
self.outf.write('\n')
274
class cmd_revision_info(Command):
275
"""Show revision number and revision id for a given revision identifier.
278
takes_args = ['revision_info*']
279
takes_options = ['revision']
282
def run(self, revision=None, revision_info_list=[]):
285
if revision is not None:
286
revs.extend(revision)
287
if revision_info_list is not None:
288
for rev in revision_info_list:
289
revs.append(RevisionSpec.from_string(rev))
291
b = Branch.open_containing(u'.')[0]
294
revs.append(RevisionSpec.from_string('-1'))
297
revinfo = rev.in_history(b)
298
if revinfo.revno is None:
299
dotted_map = b.get_revision_id_to_revno_map()
300
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
301
print '%s %s' % (revno, revinfo.rev_id)
303
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
306
class cmd_add(Command):
307
"""Add specified files or directories.
309
In non-recursive mode, all the named items are added, regardless
310
of whether they were previously ignored. A warning is given if
311
any of the named files are already versioned.
313
In recursive mode (the default), files are treated the same way
314
but the behaviour for directories is different. Directories that
315
are already versioned do not give a warning. All directories,
316
whether already versioned or not, are searched for files or
317
subdirectories that are neither versioned or ignored, and these
318
are added. This search proceeds recursively into versioned
319
directories. If no names are given '.' is assumed.
321
Therefore simply saying 'bzr add' will version all files that
322
are currently unknown.
324
Adding a file whose parent directory is not versioned will
325
implicitly add the parent, and so on up to the root. This means
326
you should never need to explicitly add a directory, they'll just
327
get added when you add a file in the directory.
329
--dry-run will show which files would be added, but not actually
332
--file-ids-from will try to use the file ids from the supplied path.
333
It looks up ids trying to find a matching parent directory with the
334
same filename, and then by pure path. This option is rarely needed
335
but can be useful when adding the same logical file into two
336
branches that will be merged later (without showing the two different
337
adds as a conflict). It is also useful when merging another project
338
into a subdirectory of this one.
340
takes_args = ['file*']
343
help="Don't recursively add the contents of directories."),
345
help="Show what would be done, but don't actually do anything."),
347
Option('file-ids-from',
349
help='Lookup file ids from this tree.'),
351
encoding_type = 'replace'
352
_see_also = ['remove']
354
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
359
if file_ids_from is not None:
361
base_tree, base_path = WorkingTree.open_containing(
363
except errors.NoWorkingTree:
364
base_branch, base_path = Branch.open_containing(
366
base_tree = base_branch.basis_tree()
368
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
369
to_file=self.outf, should_print=(not is_quiet()))
371
action = bzrlib.add.AddAction(to_file=self.outf,
372
should_print=(not is_quiet()))
375
base_tree.lock_read()
377
file_list = self._maybe_expand_globs(file_list)
379
tree = WorkingTree.open_containing(file_list[0])[0]
381
tree = WorkingTree.open_containing(u'.')[0]
382
added, ignored = tree.smart_add(file_list, not
383
no_recurse, action=action, save=not dry_run)
385
if base_tree is not None:
389
for glob in sorted(ignored.keys()):
390
for path in ignored[glob]:
391
self.outf.write("ignored %s matching \"%s\"\n"
395
for glob, paths in ignored.items():
396
match_len += len(paths)
397
self.outf.write("ignored %d file(s).\n" % match_len)
398
self.outf.write("If you wish to add some of these files,"
399
" please add them by name.\n")
402
class cmd_mkdir(Command):
403
"""Create a new versioned directory.
405
This is equivalent to creating the directory and then adding it.
408
takes_args = ['dir+']
409
encoding_type = 'replace'
411
def run(self, dir_list):
414
wt, dd = WorkingTree.open_containing(d)
416
self.outf.write('added %s\n' % d)
419
class cmd_relpath(Command):
420
"""Show path of a file relative to root"""
422
takes_args = ['filename']
426
def run(self, filename):
427
# TODO: jam 20050106 Can relpath return a munged path if
428
# sys.stdout encoding cannot represent it?
429
tree, relpath = WorkingTree.open_containing(filename)
430
self.outf.write(relpath)
431
self.outf.write('\n')
434
class cmd_inventory(Command):
435
"""Show inventory of the current working copy or a revision.
437
It is possible to limit the output to a particular entry
438
type using the --kind option. For example: --kind file.
440
It is also possible to restrict the list of files to a specific
441
set. For example: bzr inventory --show-ids this/file
450
help='List entries of a particular kind: file, directory, symlink.',
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 %r specified' % (kind,))
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, because the file has already been moved."),
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', 'status-flags']
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(delta._ChangeReporter(
1035
unversioned_filter=tree.is_ignored))
1036
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1037
note('Updated to revision %d.' % (revno,))
1038
if tree.get_parent_ids()[1:] != existing_pending_merges:
1039
note('Your local commits will now show as pending merges with '
1040
"'bzr status', and can be committed with 'bzr commit'.")
1049
class cmd_info(Command):
1050
"""Show information about a working tree, branch or repository.
1052
This command will show all known locations and formats associated to the
1053
tree, branch or repository. Statistical information is included with
1056
Branches and working trees will also report any missing revisions.
1058
_see_also = ['revno', 'working-trees', 'repositories']
1059
takes_args = ['location?']
1060
takes_options = ['verbose']
1063
def run(self, location=None, verbose=0):
1064
from bzrlib.info import show_bzrdir_info
1065
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1069
class cmd_remove(Command):
1070
"""Remove files or directories.
1072
This makes bzr stop tracking changes to the specified files and
1073
delete them if they can easily be recovered using revert.
1075
You can specify one or more files, and/or --new. If you specify --new,
1076
only 'added' files will be removed. If you specify both, then new files
1077
in the specified directories will be removed. If the directories are
1078
also new, they will also be removed.
1080
takes_args = ['file*']
1081
takes_options = ['verbose',
1082
Option('new', help='Remove newly-added files.'),
1083
RegistryOption.from_kwargs('file-deletion-strategy',
1084
'The file deletion mode to be used',
1085
title='Deletion Strategy', value_switches=True, enum_switch=False,
1086
safe='Only delete files if they can be'
1087
' safely recovered (default).',
1088
keep="Don't delete any files.",
1089
force='Delete all the specified files, even if they can not be '
1090
'recovered and even if they are non-empty directories.')]
1092
encoding_type = 'replace'
1094
def run(self, file_list, verbose=False, new=False,
1095
file_deletion_strategy='safe'):
1096
tree, file_list = tree_files(file_list)
1098
if file_list is not None:
1099
file_list = [f for f in file_list if f != '']
1101
raise errors.BzrCommandError('Specify one or more files to'
1102
' remove, or use --new.')
1105
added = tree.changes_from(tree.basis_tree(),
1106
specific_files=file_list).added
1107
file_list = sorted([f[0] for f in added], reverse=True)
1108
if len(file_list) == 0:
1109
raise errors.BzrCommandError('No matching files.')
1110
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1111
keep_files=file_deletion_strategy=='keep',
1112
force=file_deletion_strategy=='force')
1115
class cmd_file_id(Command):
1116
"""Print file_id of a particular file or directory.
1118
The file_id is assigned when the file is first added and remains the
1119
same through all revisions where the file exists, even when it is
1124
_see_also = ['inventory', 'ls']
1125
takes_args = ['filename']
1128
def run(self, filename):
1129
tree, relpath = WorkingTree.open_containing(filename)
1130
i = tree.path2id(relpath)
1132
raise errors.NotVersionedError(filename)
1134
self.outf.write(i + '\n')
1137
class cmd_file_path(Command):
1138
"""Print path of file_ids to a file or directory.
1140
This prints one line for each directory down to the target,
1141
starting at the branch root.
1145
takes_args = ['filename']
1148
def run(self, filename):
1149
tree, relpath = WorkingTree.open_containing(filename)
1150
fid = tree.path2id(relpath)
1152
raise errors.NotVersionedError(filename)
1153
segments = osutils.splitpath(relpath)
1154
for pos in range(1, len(segments) + 1):
1155
path = osutils.joinpath(segments[:pos])
1156
self.outf.write("%s\n" % tree.path2id(path))
1159
class cmd_reconcile(Command):
1160
"""Reconcile bzr metadata in a branch.
1162
This can correct data mismatches that may have been caused by
1163
previous ghost operations or bzr upgrades. You should only
1164
need to run this command if 'bzr check' or a bzr developer
1165
advises you to run it.
1167
If a second branch is provided, cross-branch reconciliation is
1168
also attempted, which will check that data like the tree root
1169
id which was not present in very early bzr versions is represented
1170
correctly in both branches.
1172
At the same time it is run it may recompress data resulting in
1173
a potential saving in disk space or performance gain.
1175
The branch *MUST* be on a listable system such as local disk or sftp.
1178
_see_also = ['check']
1179
takes_args = ['branch?']
1181
def run(self, branch="."):
1182
from bzrlib.reconcile import reconcile
1183
dir = bzrdir.BzrDir.open(branch)
1187
class cmd_revision_history(Command):
1188
"""Display the list of revision ids on a branch."""
1191
takes_args = ['location?']
1196
def run(self, location="."):
1197
branch = Branch.open_containing(location)[0]
1198
for revid in branch.revision_history():
1199
self.outf.write(revid)
1200
self.outf.write('\n')
1203
class cmd_ancestry(Command):
1204
"""List all revisions merged into this branch."""
1206
_see_also = ['log', 'revision-history']
1207
takes_args = ['location?']
1212
def run(self, location="."):
1214
wt = WorkingTree.open_containing(location)[0]
1215
except errors.NoWorkingTree:
1216
b = Branch.open(location)
1217
last_revision = b.last_revision()
1220
last_revision = wt.last_revision()
1222
revision_ids = b.repository.get_ancestry(last_revision)
1223
assert revision_ids[0] is None
1225
for revision_id in revision_ids:
1226
self.outf.write(revision_id + '\n')
1229
class cmd_init(Command):
1230
"""Make a directory into a versioned branch.
1232
Use this to create an empty branch, or before importing an
1235
If there is a repository in a parent directory of the location, then
1236
the history of the branch will be stored in the repository. Otherwise
1237
init creates a standalone branch which carries its own history
1238
in the .bzr directory.
1240
If there is already a branch at the location but it has no working tree,
1241
the tree can be populated with 'bzr checkout'.
1243
Recipe for importing a tree of files:
1248
bzr commit -m 'imported project'
1251
_see_also = ['init-repo', 'branch', 'checkout']
1252
takes_args = ['location?']
1254
Option('create-prefix',
1255
help='Create the path leading up to the branch '
1256
'if it does not already exist.'),
1257
RegistryOption('format',
1258
help='Specify a format for this branch. '
1259
'See "help formats".',
1260
registry=bzrdir.format_registry,
1261
converter=bzrdir.format_registry.make_bzrdir,
1262
value_switches=True,
1263
title="Branch Format",
1265
Option('append-revisions-only',
1266
help='Never change revnos or the existing log.'
1267
' Append revisions to it only.')
1269
def run(self, location=None, format=None, append_revisions_only=False,
1270
create_prefix=False):
1272
format = bzrdir.format_registry.make_bzrdir('default')
1273
if location is None:
1276
to_transport = transport.get_transport(location)
1278
# The path has to exist to initialize a
1279
# branch inside of it.
1280
# Just using os.mkdir, since I don't
1281
# believe that we want to create a bunch of
1282
# locations if the user supplies an extended path
1284
to_transport.ensure_base()
1285
except errors.NoSuchFile:
1286
if not create_prefix:
1287
raise errors.BzrCommandError("Parent directory of %s"
1289
"\nYou may supply --create-prefix to create all"
1290
" leading parent directories."
1292
_create_prefix(to_transport)
1295
existing_bzrdir = bzrdir.BzrDir.open(location)
1296
except errors.NotBranchError:
1297
# really a NotBzrDir error...
1298
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1301
from bzrlib.transport.local import LocalTransport
1302
if existing_bzrdir.has_branch():
1303
if (isinstance(to_transport, LocalTransport)
1304
and not existing_bzrdir.has_workingtree()):
1305
raise errors.BranchExistsWithoutWorkingTree(location)
1306
raise errors.AlreadyBranchError(location)
1308
branch = existing_bzrdir.create_branch()
1309
existing_bzrdir.create_workingtree()
1310
if append_revisions_only:
1312
branch.set_append_revisions_only(True)
1313
except errors.UpgradeRequired:
1314
raise errors.BzrCommandError('This branch format cannot be set'
1315
' to append-revisions-only. Try --experimental-branch6')
1318
class cmd_init_repository(Command):
1319
"""Create a shared repository to hold branches.
1321
New branches created under the repository directory will store their
1322
revisions in the repository, not in the branch directory.
1324
If the --no-trees option is used then the branches in the repository
1325
will not have working trees by default.
1328
bzr init-repo --no-trees repo
1330
bzr checkout --lightweight repo/trunk trunk-checkout
1334
See 'bzr help repositories' for more information.
1337
_see_also = ['init', 'branch', 'checkout']
1338
takes_args = ["location"]
1339
takes_options = [RegistryOption('format',
1340
help='Specify a format for this repository. See'
1341
' "bzr help formats" for details.',
1342
registry=bzrdir.format_registry,
1343
converter=bzrdir.format_registry.make_bzrdir,
1344
value_switches=True, title='Repository format'),
1346
help='Branches in the repository will default to'
1347
' not having a working tree.'),
1349
aliases = ["init-repo"]
1351
def run(self, location, format=None, no_trees=False):
1353
format = bzrdir.format_registry.make_bzrdir('default')
1355
if location is None:
1358
to_transport = transport.get_transport(location)
1359
to_transport.ensure_base()
1361
newdir = format.initialize_on_transport(to_transport)
1362
repo = newdir.create_repository(shared=True)
1363
repo.set_make_working_trees(not no_trees)
1366
class cmd_diff(Command):
1367
"""Show differences in the working tree or between revisions.
1369
If files are listed, only the changes in those files are listed.
1370
Otherwise, all changes for the tree are listed.
1372
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1373
produces patches suitable for "patch -p1".
1377
Shows the difference in the working tree versus the last commit
1379
Difference between the working tree and revision 1
1381
Difference between revision 2 and revision 1
1382
bzr diff --prefix old/:new/
1383
Same as 'bzr diff' but prefix paths with old/ and new/
1384
bzr diff bzr.mine bzr.dev
1385
Show the differences between the two working trees
1387
Show just the differences for 'foo.c'
1389
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1390
# or a graphical diff.
1392
# TODO: Python difflib is not exactly the same as unidiff; should
1393
# either fix it up or prefer to use an external diff.
1395
# TODO: Selected-file diff is inefficient and doesn't show you
1398
# TODO: This probably handles non-Unix newlines poorly.
1400
_see_also = ['status']
1401
takes_args = ['file*']
1403
Option('diff-options', type=str,
1404
help='Pass these options to the external diff program.'),
1405
Option('prefix', type=str,
1407
help='Set prefixes to added to old and new filenames, as '
1408
'two values separated by a colon. (eg "old/:new/").'),
1411
aliases = ['di', 'dif']
1412
encoding_type = 'exact'
1415
def run(self, revision=None, file_list=None, diff_options=None,
1417
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1419
if (prefix is None) or (prefix == '0'):
1427
old_label, new_label = prefix.split(":")
1429
raise errors.BzrCommandError(
1430
'--prefix expects two values separated by a colon'
1431
' (eg "old/:new/")')
1433
if revision and len(revision) > 2:
1434
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1435
' one or two revision specifiers')
1438
tree1, file_list = internal_tree_files(file_list)
1442
except errors.FileInWrongBranch:
1443
if len(file_list) != 2:
1444
raise errors.BzrCommandError("Files are in different branches")
1446
tree1, file1 = WorkingTree.open_containing(file_list[0])
1447
tree2, file2 = WorkingTree.open_containing(file_list[1])
1448
if file1 != "" or file2 != "":
1449
# FIXME diff those two files. rbc 20051123
1450
raise errors.BzrCommandError("Files are in different branches")
1452
except errors.NotBranchError:
1453
if (revision is not None and len(revision) == 2
1454
and not revision[0].needs_branch()
1455
and not revision[1].needs_branch()):
1456
# If both revision specs include a branch, we can
1457
# diff them without needing a local working tree
1458
tree1, tree2 = None, None
1462
if tree2 is not None:
1463
if revision is not None:
1464
# FIXME: but there should be a clean way to diff between
1465
# non-default versions of two trees, it's not hard to do
1467
raise errors.BzrCommandError(
1468
"Sorry, diffing arbitrary revisions across branches "
1469
"is not implemented yet")
1470
return show_diff_trees(tree1, tree2, sys.stdout,
1471
specific_files=file_list,
1472
external_diff_options=diff_options,
1473
old_label=old_label, new_label=new_label)
1475
return diff_cmd_helper(tree1, file_list, diff_options,
1476
revision_specs=revision,
1477
old_label=old_label, new_label=new_label)
1480
class cmd_deleted(Command):
1481
"""List files deleted in the working tree.
1483
# TODO: Show files deleted since a previous revision, or
1484
# between two revisions.
1485
# TODO: Much more efficient way to do this: read in new
1486
# directories with readdir, rather than stating each one. Same
1487
# level of effort but possibly much less IO. (Or possibly not,
1488
# if the directories are very large...)
1489
_see_also = ['status', 'ls']
1490
takes_options = ['show-ids']
1493
def run(self, show_ids=False):
1494
tree = WorkingTree.open_containing(u'.')[0]
1497
old = tree.basis_tree()
1500
for path, ie in old.inventory.iter_entries():
1501
if not tree.has_id(ie.file_id):
1502
self.outf.write(path)
1504
self.outf.write(' ')
1505
self.outf.write(ie.file_id)
1506
self.outf.write('\n')
1513
class cmd_modified(Command):
1514
"""List files modified in working tree.
1518
_see_also = ['status', 'ls']
1522
tree = WorkingTree.open_containing(u'.')[0]
1523
td = tree.changes_from(tree.basis_tree())
1524
for path, id, kind, text_modified, meta_modified in td.modified:
1525
self.outf.write(path + '\n')
1528
class cmd_added(Command):
1529
"""List files added in working tree.
1533
_see_also = ['status', 'ls']
1537
wt = WorkingTree.open_containing(u'.')[0]
1540
basis = wt.basis_tree()
1543
basis_inv = basis.inventory
1546
if file_id in basis_inv:
1548
if inv.is_root(file_id) and len(basis_inv) == 0:
1550
path = inv.id2path(file_id)
1551
if not os.access(osutils.abspath(path), os.F_OK):
1553
self.outf.write(path + '\n')
1560
class cmd_root(Command):
1561
"""Show the tree root directory.
1563
The root is the nearest enclosing directory with a .bzr control
1566
takes_args = ['filename?']
1568
def run(self, filename=None):
1569
"""Print the branch root."""
1570
tree = WorkingTree.open_containing(filename)[0]
1571
self.outf.write(tree.basedir + '\n')
1574
def _parse_limit(limitstring):
1576
return int(limitstring)
1578
msg = "The limit argument must be an integer."
1579
raise errors.BzrCommandError(msg)
1582
class cmd_log(Command):
1583
"""Show log of a branch, file, or directory.
1585
By default show the log of the branch containing the working directory.
1587
To request a range of logs, you can use the command -r begin..end
1588
-r revision requests a specific revision, -r ..end or -r begin.. are
1594
bzr log -r -10.. http://server/branch
1597
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1599
takes_args = ['location?']
1602
help='Show from oldest to newest.'),
1605
help='Display timezone as local, original, or utc.'),
1608
help='Show files changed in each revision.'),
1614
help='Show revisions whose message matches this '
1615
'regular expression.',
1618
help='Limit the output to the first N revisions.',
1622
encoding_type = 'replace'
1625
def run(self, location=None, timezone='original',
1633
from bzrlib.log import show_log
1634
assert message is None or isinstance(message, basestring), \
1635
"invalid message argument %r" % message
1636
direction = (forward and 'forward') or 'reverse'
1641
# find the file id to log:
1643
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1647
tree = b.basis_tree()
1648
file_id = tree.path2id(fp)
1650
raise errors.BzrCommandError(
1651
"Path does not have any revision history: %s" %
1655
# FIXME ? log the current subdir only RBC 20060203
1656
if revision is not None \
1657
and len(revision) > 0 and revision[0].get_branch():
1658
location = revision[0].get_branch()
1661
dir, relpath = bzrdir.BzrDir.open_containing(location)
1662
b = dir.open_branch()
1666
if revision is None:
1669
elif len(revision) == 1:
1670
rev1 = rev2 = revision[0].in_history(b)
1671
elif len(revision) == 2:
1672
if revision[1].get_branch() != revision[0].get_branch():
1673
# b is taken from revision[0].get_branch(), and
1674
# show_log will use its revision_history. Having
1675
# different branches will lead to weird behaviors.
1676
raise errors.BzrCommandError(
1677
"Log doesn't accept two revisions in different"
1679
rev1 = revision[0].in_history(b)
1680
rev2 = revision[1].in_history(b)
1682
raise errors.BzrCommandError(
1683
'bzr log --revision takes one or two values.')
1685
if log_format is None:
1686
log_format = log.log_formatter_registry.get_default(b)
1688
lf = log_format(show_ids=show_ids, to_file=self.outf,
1689
show_timezone=timezone)
1695
direction=direction,
1696
start_revision=rev1,
1704
def get_log_format(long=False, short=False, line=False, default='long'):
1705
log_format = default
1709
log_format = 'short'
1715
class cmd_touching_revisions(Command):
1716
"""Return revision-ids which affected a particular file.
1718
A more user-friendly interface is "bzr log FILE".
1722
takes_args = ["filename"]
1725
def run(self, filename):
1726
tree, relpath = WorkingTree.open_containing(filename)
1728
file_id = tree.path2id(relpath)
1729
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1730
self.outf.write("%6d %s\n" % (revno, what))
1733
class cmd_ls(Command):
1734
"""List files in a tree.
1737
_see_also = ['status', 'cat']
1738
takes_args = ['path?']
1739
# TODO: Take a revision or remote path and list that tree instead.
1743
Option('non-recursive',
1744
help='Don\'t recurse into subdirectories.'),
1746
help='Print paths relative to the root of the branch.'),
1747
Option('unknown', help='Print unknown files.'),
1748
Option('versioned', help='Print versioned files.'),
1749
Option('ignored', help='Print ignored files.'),
1751
help='Write an ascii NUL (\\0) separator '
1752
'between files rather than a newline.'),
1754
help='List entries of a particular kind: file, directory, symlink.',
1759
def run(self, revision=None, verbose=False,
1760
non_recursive=False, from_root=False,
1761
unknown=False, versioned=False, ignored=False,
1762
null=False, kind=None, show_ids=False, path=None):
1764
if kind and kind not in ('file', 'directory', 'symlink'):
1765
raise errors.BzrCommandError('invalid kind specified')
1767
if verbose and null:
1768
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1769
all = not (unknown or versioned or ignored)
1771
selection = {'I':ignored, '?':unknown, 'V':versioned}
1778
raise errors.BzrCommandError('cannot specify both --from-root'
1782
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1788
if revision is not None:
1789
tree = branch.repository.revision_tree(
1790
revision[0].in_history(branch).rev_id)
1792
tree = branch.basis_tree()
1796
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1797
if fp.startswith(relpath):
1798
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1799
if non_recursive and '/' in fp:
1801
if not all and not selection[fc]:
1803
if kind is not None and fkind != kind:
1806
kindch = entry.kind_character()
1807
outstring = '%-8s %s%s' % (fc, fp, kindch)
1808
if show_ids and fid is not None:
1809
outstring = "%-50s %s" % (outstring, fid)
1810
self.outf.write(outstring + '\n')
1812
self.outf.write(fp + '\0')
1815
self.outf.write(fid)
1816
self.outf.write('\0')
1824
self.outf.write('%-50s %s\n' % (fp, my_id))
1826
self.outf.write(fp + '\n')
1831
class cmd_unknowns(Command):
1832
"""List unknown files.
1840
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1841
self.outf.write(osutils.quotefn(f) + '\n')
1844
class cmd_ignore(Command):
1845
"""Ignore specified files or patterns.
1847
To remove patterns from the ignore list, edit the .bzrignore file.
1849
Trailing slashes on patterns are ignored.
1850
If the pattern contains a slash or is a regular expression, it is compared
1851
to the whole path from the branch root. Otherwise, it is compared to only
1852
the last component of the path. To match a file only in the root
1853
directory, prepend './'.
1855
Ignore patterns specifying absolute paths are not allowed.
1857
Ignore patterns may include globbing wildcards such as:
1858
? - Matches any single character except '/'
1859
* - Matches 0 or more characters except '/'
1860
/**/ - Matches 0 or more directories in a path
1861
[a-z] - Matches a single character from within a group of characters
1863
Ignore patterns may also be Python regular expressions.
1864
Regular expression ignore patterns are identified by a 'RE:' prefix
1865
followed by the regular expression. Regular expression ignore patterns
1866
may not include named or numbered groups.
1868
Note: ignore patterns containing shell wildcards must be quoted from
1872
bzr ignore ./Makefile
1873
bzr ignore '*.class'
1874
bzr ignore 'lib/**/*.o'
1875
bzr ignore 'RE:lib/.*\.o'
1878
_see_also = ['status', 'ignored']
1879
takes_args = ['name_pattern*']
1881
Option('old-default-rules',
1882
help='Write out the ignore rules bzr < 0.9 always used.')
1885
def run(self, name_pattern_list=None, old_default_rules=None):
1886
from bzrlib.atomicfile import AtomicFile
1887
if old_default_rules is not None:
1888
# dump the rules and exit
1889
for pattern in ignores.OLD_DEFAULTS:
1892
if not name_pattern_list:
1893
raise errors.BzrCommandError("ignore requires at least one "
1894
"NAME_PATTERN or --old-default-rules")
1895
name_pattern_list = [globbing.normalize_pattern(p)
1896
for p in name_pattern_list]
1897
for name_pattern in name_pattern_list:
1898
if (name_pattern[0] == '/' or
1899
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1900
raise errors.BzrCommandError(
1901
"NAME_PATTERN should not be an absolute path")
1902
tree, relpath = WorkingTree.open_containing(u'.')
1903
ifn = tree.abspath('.bzrignore')
1904
if os.path.exists(ifn):
1907
igns = f.read().decode('utf-8')
1913
# TODO: If the file already uses crlf-style termination, maybe
1914
# we should use that for the newly added lines?
1916
if igns and igns[-1] != '\n':
1918
for name_pattern in name_pattern_list:
1919
igns += name_pattern + '\n'
1921
f = AtomicFile(ifn, 'wb')
1923
f.write(igns.encode('utf-8'))
1928
if not tree.path2id('.bzrignore'):
1929
tree.add(['.bzrignore'])
1932
class cmd_ignored(Command):
1933
"""List ignored files and the patterns that matched them.
1936
_see_also = ['ignore']
1939
tree = WorkingTree.open_containing(u'.')[0]
1942
for path, file_class, kind, file_id, entry in tree.list_files():
1943
if file_class != 'I':
1945
## XXX: Slightly inefficient since this was already calculated
1946
pat = tree.is_ignored(path)
1947
print '%-50s %s' % (path, pat)
1952
class cmd_lookup_revision(Command):
1953
"""Lookup the revision-id from a revision-number
1956
bzr lookup-revision 33
1959
takes_args = ['revno']
1962
def run(self, revno):
1966
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1968
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1971
class cmd_export(Command):
1972
"""Export current or past revision to a destination directory or archive.
1974
If no revision is specified this exports the last committed revision.
1976
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1977
given, try to find the format with the extension. If no extension
1978
is found exports to a directory (equivalent to --format=dir).
1980
If root is supplied, it will be used as the root directory inside
1981
container formats (tar, zip, etc). If it is not supplied it will default
1982
to the exported filename. The root option has no effect for 'dir' format.
1984
If branch is omitted then the branch containing the current working
1985
directory will be used.
1987
Note: Export of tree with non-ASCII filenames to zip is not supported.
1989
Supported formats Autodetected by extension
1990
----------------- -------------------------
1993
tbz2 .tar.bz2, .tbz2
1997
takes_args = ['dest', 'branch?']
2000
help="Type of file to export to.",
2005
help="Name of the root directory inside the exported file."),
2007
def run(self, dest, branch=None, revision=None, format=None, root=None):
2008
from bzrlib.export import export
2011
tree = WorkingTree.open_containing(u'.')[0]
2014
b = Branch.open(branch)
2016
if revision is None:
2017
# should be tree.last_revision FIXME
2018
rev_id = b.last_revision()
2020
if len(revision) != 1:
2021
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2022
rev_id = revision[0].in_history(b).rev_id
2023
t = b.repository.revision_tree(rev_id)
2025
export(t, dest, format, root)
2026
except errors.NoSuchExportFormat, e:
2027
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2030
class cmd_cat(Command):
2031
"""Write the contents of a file as of a given revision to standard output.
2033
If no revision is nominated, the last revision is used.
2035
Note: Take care to redirect standard output when using this command on a
2041
Option('name-from-revision', help='The path name in the old tree.'),
2044
takes_args = ['filename']
2045
encoding_type = 'exact'
2048
def run(self, filename, revision=None, name_from_revision=False):
2049
if revision is not None and len(revision) != 1:
2050
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2055
tree, b, relpath = \
2056
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2057
except errors.NotBranchError:
2060
if revision is not None and revision[0].get_branch() is not None:
2061
b = Branch.open(revision[0].get_branch())
2063
tree = b.basis_tree()
2064
if revision is None:
2065
revision_id = b.last_revision()
2067
revision_id = revision[0].in_history(b).rev_id
2069
cur_file_id = tree.path2id(relpath)
2070
rev_tree = b.repository.revision_tree(revision_id)
2071
old_file_id = rev_tree.path2id(relpath)
2073
if name_from_revision:
2074
if old_file_id is None:
2075
raise errors.BzrCommandError("%r is not present in revision %s"
2076
% (filename, revision_id))
2078
rev_tree.print_file(old_file_id)
2079
elif cur_file_id is not None:
2080
rev_tree.print_file(cur_file_id)
2081
elif old_file_id is not None:
2082
rev_tree.print_file(old_file_id)
2084
raise errors.BzrCommandError("%r is not present in revision %s" %
2085
(filename, revision_id))
2088
class cmd_local_time_offset(Command):
2089
"""Show the offset in seconds from GMT to local time."""
2093
print osutils.local_time_offset()
2097
class cmd_commit(Command):
2098
"""Commit changes into a new revision.
2100
If no arguments are given, the entire tree is committed.
2102
If selected files are specified, only changes to those files are
2103
committed. If a directory is specified then the directory and everything
2104
within it is committed.
2106
A selected-file commit may fail in some cases where the committed
2107
tree would be invalid. Consider::
2112
bzr commit foo -m "committing foo"
2113
bzr mv foo/bar foo/baz
2116
bzr commit foo/bar -m "committing bar but not baz"
2118
In the example above, the last commit will fail by design. This gives
2119
the user the opportunity to decide whether they want to commit the
2120
rename at the same time, separately first, or not at all. (As a general
2121
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2123
Note: A selected-file commit after a merge is not yet supported.
2125
# TODO: Run hooks on tree to-be-committed, and after commit.
2127
# TODO: Strict commit that fails if there are deleted files.
2128
# (what does "deleted files" mean ??)
2130
# TODO: Give better message for -s, --summary, used by tla people
2132
# XXX: verbose currently does nothing
2134
_see_also = ['bugs', 'uncommit']
2135
takes_args = ['selected*']
2137
Option('message', type=unicode,
2139
help="Description of the new revision."),
2142
help='Commit even if nothing has changed.'),
2143
Option('file', type=str,
2146
help='Take commit message from this file.'),
2148
help="Refuse to commit if there are unknown "
2149
"files in the working tree."),
2150
ListOption('fixes', type=str,
2151
help="Mark a bug as being fixed by this revision."),
2153
help="Perform a local commit in a bound "
2154
"branch. Local commits are not pushed to "
2155
"the master branch until a normal commit "
2159
aliases = ['ci', 'checkin']
2161
def _get_bug_fix_properties(self, fixes, branch):
2163
# Configure the properties for bug fixing attributes.
2164
for fixed_bug in fixes:
2165
tokens = fixed_bug.split(':')
2166
if len(tokens) != 2:
2167
raise errors.BzrCommandError(
2168
"Invalid bug %s. Must be in the form of 'tag:id'. "
2169
"Commit refused." % fixed_bug)
2170
tag, bug_id = tokens
2172
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2173
except errors.UnknownBugTrackerAbbreviation:
2174
raise errors.BzrCommandError(
2175
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2176
except errors.MalformedBugIdentifier:
2177
raise errors.BzrCommandError(
2178
"Invalid bug identifier for %s. Commit refused."
2180
properties.append('%s fixed' % bug_url)
2181
return '\n'.join(properties)
2183
def run(self, message=None, file=None, verbose=True, selected_list=None,
2184
unchanged=False, strict=False, local=False, fixes=None):
2185
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2186
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2188
from bzrlib.msgeditor import edit_commit_message, \
2189
make_commit_message_template
2191
# TODO: Need a blackbox test for invoking the external editor; may be
2192
# slightly problematic to run this cross-platform.
2194
# TODO: do more checks that the commit will succeed before
2195
# spending the user's valuable time typing a commit message.
2199
tree, selected_list = tree_files(selected_list)
2200
if selected_list == ['']:
2201
# workaround - commit of root of tree should be exactly the same
2202
# as just default commit in that tree, and succeed even though
2203
# selected-file merge commit is not done yet
2206
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2208
properties['bugs'] = bug_property
2210
if local and not tree.branch.get_bound_location():
2211
raise errors.LocalRequiresBoundBranch()
2213
def get_message(commit_obj):
2214
"""Callback to get commit message"""
2215
my_message = message
2216
if my_message is None and not file:
2217
template = make_commit_message_template(tree, selected_list)
2218
my_message = edit_commit_message(template)
2219
if my_message is None:
2220
raise errors.BzrCommandError("please specify a commit"
2221
" message with either --message or --file")
2222
elif my_message and file:
2223
raise errors.BzrCommandError(
2224
"please specify either --message or --file")
2226
my_message = codecs.open(file, 'rt',
2227
bzrlib.user_encoding).read()
2228
if my_message == "":
2229
raise errors.BzrCommandError("empty commit message specified")
2233
reporter = ReportCommitToLog()
2235
reporter = NullCommitReporter()
2238
tree.commit(message_callback=get_message,
2239
specific_files=selected_list,
2240
allow_pointless=unchanged, strict=strict, local=local,
2241
reporter=reporter, revprops=properties)
2242
except PointlessCommit:
2243
# FIXME: This should really happen before the file is read in;
2244
# perhaps prepare the commit; get the message; then actually commit
2245
raise errors.BzrCommandError("no changes to commit."
2246
" use --unchanged to commit anyhow")
2247
except ConflictsInTree:
2248
raise errors.BzrCommandError('Conflicts detected in working '
2249
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2251
except StrictCommitFailed:
2252
raise errors.BzrCommandError("Commit refused because there are"
2253
" unknown files in the working tree.")
2254
except errors.BoundBranchOutOfDate, e:
2255
raise errors.BzrCommandError(str(e) + "\n"
2256
'To commit to master branch, run update and then commit.\n'
2257
'You can also pass --local to commit to continue working '
2261
class cmd_check(Command):
2262
"""Validate consistency of branch history.
2264
This command checks various invariants about the branch storage to
2265
detect data corruption or bzr bugs.
2268
_see_also = ['reconcile']
2269
takes_args = ['branch?']
2270
takes_options = ['verbose']
2272
def run(self, branch=None, verbose=False):
2273
from bzrlib.check import check
2275
tree = WorkingTree.open_containing()[0]
2276
branch = tree.branch
2278
branch = Branch.open(branch)
2279
check(branch, verbose)
2282
class cmd_upgrade(Command):
2283
"""Upgrade branch storage to current format.
2285
The check command or bzr developers may sometimes advise you to run
2286
this command. When the default format has changed you may also be warned
2287
during other operations to upgrade.
2290
_see_also = ['check']
2291
takes_args = ['url?']
2293
RegistryOption('format',
2294
help='Upgrade to a specific format. See "bzr help'
2295
' formats" for details.',
2296
registry=bzrdir.format_registry,
2297
converter=bzrdir.format_registry.make_bzrdir,
2298
value_switches=True, title='Branch format'),
2301
def run(self, url='.', format=None):
2302
from bzrlib.upgrade import upgrade
2304
format = bzrdir.format_registry.make_bzrdir('default')
2305
upgrade(url, format)
2308
class cmd_whoami(Command):
2309
"""Show or set bzr user id.
2313
bzr whoami 'Frank Chu <fchu@example.com>'
2315
takes_options = [ Option('email',
2316
help='Display email address only.'),
2318
help='Set identity for the current branch instead of '
2321
takes_args = ['name?']
2322
encoding_type = 'replace'
2325
def run(self, email=False, branch=False, name=None):
2327
# use branch if we're inside one; otherwise global config
2329
c = Branch.open_containing('.')[0].get_config()
2330
except errors.NotBranchError:
2331
c = config.GlobalConfig()
2333
self.outf.write(c.user_email() + '\n')
2335
self.outf.write(c.username() + '\n')
2338
# display a warning if an email address isn't included in the given name.
2340
config.extract_email_address(name)
2341
except errors.NoEmailInUsername, e:
2342
warning('"%s" does not seem to contain an email address. '
2343
'This is allowed, but not recommended.', name)
2345
# use global config unless --branch given
2347
c = Branch.open_containing('.')[0].get_config()
2349
c = config.GlobalConfig()
2350
c.set_user_option('email', name)
2353
class cmd_nick(Command):
2354
"""Print or set the branch nickname.
2356
If unset, the tree root directory name is used as the nickname
2357
To print the current nickname, execute with no argument.
2360
_see_also = ['info']
2361
takes_args = ['nickname?']
2362
def run(self, nickname=None):
2363
branch = Branch.open_containing(u'.')[0]
2364
if nickname is None:
2365
self.printme(branch)
2367
branch.nick = nickname
2370
def printme(self, branch):
2374
class cmd_selftest(Command):
2375
"""Run internal test suite.
2377
If arguments are given, they are regular expressions that say which tests
2378
should run. Tests matching any expression are run, and other tests are
2381
Alternatively if --first is given, matching tests are run first and then
2382
all other tests are run. This is useful if you have been working in a
2383
particular area, but want to make sure nothing else was broken.
2385
If --exclude is given, tests that match that regular expression are
2386
excluded, regardless of whether they match --first or not.
2388
To help catch accidential dependencies between tests, the --randomize
2389
option is useful. In most cases, the argument used is the word 'now'.
2390
Note that the seed used for the random number generator is displayed
2391
when this option is used. The seed can be explicitly passed as the
2392
argument to this option if required. This enables reproduction of the
2393
actual ordering used if and when an order sensitive problem is encountered.
2395
If --list-only is given, the tests that would be run are listed. This is
2396
useful when combined with --first, --exclude and/or --randomize to
2397
understand their impact. The test harness reports "Listed nn tests in ..."
2398
instead of "Ran nn tests in ..." when list mode is enabled.
2400
If the global option '--no-plugins' is given, plugins are not loaded
2401
before running the selftests. This has two effects: features provided or
2402
modified by plugins will not be tested, and tests provided by plugins will
2407
run only tests relating to 'ignore'
2408
bzr --no-plugins selftest -v
2409
disable plugins and list tests as they're run
2411
For each test, that needs actual disk access, bzr create their own
2412
subdirectory in the temporary testing directory (testXXXX.tmp).
2413
By default the name of such subdirectory is based on the name of the test.
2414
If option '--numbered-dirs' is given, bzr will use sequent numbers
2415
of running tests to create such subdirectories. This is default behavior
2416
on Windows because of path length limitation.
2418
# NB: this is used from the class without creating an instance, which is
2419
# why it does not have a self parameter.
2420
def get_transport_type(typestring):
2421
"""Parse and return a transport specifier."""
2422
if typestring == "sftp":
2423
from bzrlib.transport.sftp import SFTPAbsoluteServer
2424
return SFTPAbsoluteServer
2425
if typestring == "memory":
2426
from bzrlib.transport.memory import MemoryServer
2428
if typestring == "fakenfs":
2429
from bzrlib.transport.fakenfs import FakeNFSServer
2430
return FakeNFSServer
2431
msg = "No known transport type %s. Supported types are: sftp\n" %\
2433
raise errors.BzrCommandError(msg)
2436
takes_args = ['testspecs*']
2437
takes_options = ['verbose',
2439
help='Stop when one test fails.',
2442
Option('keep-output',
2443
help='Keep output directories when tests fail.'),
2445
help='Use a different transport by default '
2446
'throughout the test suite.',
2447
type=get_transport_type),
2449
help='Run the benchmarks rather than selftests.'),
2450
Option('lsprof-timed',
2451
help='Generate lsprof output for benchmarked'
2452
' sections of code.'),
2453
Option('cache-dir', type=str,
2454
help='Cache intermediate benchmark output in this '
2456
Option('clean-output',
2457
help='Clean temporary tests directories'
2458
' without running tests.'),
2460
help='Run all tests, but run specified tests first.',
2463
Option('numbered-dirs',
2464
help='Use numbered dirs for TestCaseInTempDir.'),
2466
help='List the tests instead of running them.'),
2467
Option('randomize', type=str, argname="SEED",
2468
help='Randomize the order of tests using the given'
2469
' seed or "now" for the current time.'),
2470
Option('exclude', type=str, argname="PATTERN",
2472
help='Exclude tests that match this regular'
2475
encoding_type = 'replace'
2477
def run(self, testspecs_list=None, verbose=None, one=False,
2478
keep_output=False, transport=None, benchmark=None,
2479
lsprof_timed=None, cache_dir=None, clean_output=False,
2480
first=False, numbered_dirs=None, list_only=False,
2481
randomize=None, exclude=None):
2483
from bzrlib.tests import selftest
2484
import bzrlib.benchmarks as benchmarks
2485
from bzrlib.benchmarks import tree_creator
2488
from bzrlib.tests import clean_selftest_output
2489
clean_selftest_output()
2492
warning("notice: selftest --keep-output "
2493
"is no longer supported; "
2494
"test output is always removed")
2496
if numbered_dirs is None and sys.platform == 'win32':
2497
numbered_dirs = True
2499
if cache_dir is not None:
2500
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2501
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2502
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2504
if testspecs_list is not None:
2505
pattern = '|'.join(testspecs_list)
2509
test_suite_factory = benchmarks.test_suite
2512
# TODO: should possibly lock the history file...
2513
benchfile = open(".perf_history", "at", buffering=1)
2515
test_suite_factory = None
2520
result = selftest(verbose=verbose,
2522
stop_on_failure=one,
2523
transport=transport,
2524
test_suite_factory=test_suite_factory,
2525
lsprof_timed=lsprof_timed,
2526
bench_history=benchfile,
2527
matching_tests_first=first,
2528
numbered_dirs=numbered_dirs,
2529
list_only=list_only,
2530
random_seed=randomize,
2531
exclude_pattern=exclude
2534
if benchfile is not None:
2537
info('tests passed')
2539
info('tests failed')
2540
return int(not result)
2543
class cmd_version(Command):
2544
"""Show version of bzr."""
2548
from bzrlib.version import show_version
2552
class cmd_rocks(Command):
2553
"""Statement of optimism."""
2559
print "It sure does!"
2562
class cmd_find_merge_base(Command):
2563
"""Find and print a base revision for merging two branches."""
2564
# TODO: Options to specify revisions on either side, as if
2565
# merging only part of the history.
2566
takes_args = ['branch', 'other']
2570
def run(self, branch, other):
2571
from bzrlib.revision import ensure_null, MultipleRevisionSources
2573
branch1 = Branch.open_containing(branch)[0]
2574
branch2 = Branch.open_containing(other)[0]
2576
last1 = ensure_null(branch1.last_revision())
2577
last2 = ensure_null(branch2.last_revision())
2579
graph = branch1.repository.get_graph(branch2.repository)
2580
base_rev_id = graph.find_unique_lca(last1, last2)
2582
print 'merge base is revision %s' % base_rev_id
2585
class cmd_merge(Command):
2586
"""Perform a three-way merge.
2588
The branch is the branch you will merge from. By default, it will merge
2589
the latest revision. If you specify a revision, that revision will be
2590
merged. If you specify two revisions, the first will be used as a BASE,
2591
and the second one as OTHER. Revision numbers are always relative to the
2594
By default, bzr will try to merge in all new work from the other
2595
branch, automatically determining an appropriate base. If this
2596
fails, you may need to give an explicit base.
2598
Merge will do its best to combine the changes in two branches, but there
2599
are some kinds of problems only a human can fix. When it encounters those,
2600
it will mark a conflict. A conflict means that you need to fix something,
2601
before you should commit.
2603
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2605
If there is no default branch set, the first merge will set it. After
2606
that, you can omit the branch to use the default. To change the
2607
default, use --remember. The value will only be saved if the remote
2608
location can be accessed.
2610
The results of the merge are placed into the destination working
2611
directory, where they can be reviewed (with bzr diff), tested, and then
2612
committed to record the result of the merge.
2616
To merge the latest revision from bzr.dev:
2617
bzr merge ../bzr.dev
2619
To merge changes up to and including revision 82 from bzr.dev:
2620
bzr merge -r 82 ../bzr.dev
2622
To merge the changes introduced by 82, without previous changes:
2623
bzr merge -r 81..82 ../bzr.dev
2625
merge refuses to run if there are any uncommitted changes, unless
2629
_see_also = ['update', 'remerge', 'status-flags']
2630
takes_args = ['branch?']
2634
help='Merge even if the destination tree has uncommitted changes.'),
2638
Option('show-base', help="Show base revision text in "
2640
Option('uncommitted', help='Apply uncommitted changes'
2641
' from a working copy, instead of branch changes.'),
2642
Option('pull', help='If the destination is already'
2643
' completely merged into the source, pull from the'
2644
' source rather than merging. When this happens,'
2645
' you do not need to commit the result.'),
2647
help='Branch to merge into, '
2648
'rather than the one containing the working directory.',
2654
def run(self, branch=None, revision=None, force=False, merge_type=None,
2655
show_base=False, reprocess=False, remember=False,
2656
uncommitted=False, pull=False,
2659
from bzrlib.tag import _merge_tags_if_possible
2660
other_revision_id = None
2661
if merge_type is None:
2662
merge_type = _mod_merge.Merge3Merger
2664
if directory is None: directory = u'.'
2665
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2666
# inventory. Because merge is a mutating operation, it really
2667
# should be a lock_write() for the whole cmd_merge operation.
2668
# However, cmd_merge open's its own tree in _merge_helper, which
2669
# means if we lock here, the later lock_write() will always block.
2670
# Either the merge helper code should be updated to take a tree,
2671
# (What about tree.merge_from_branch?)
2672
tree = WorkingTree.open_containing(directory)[0]
2673
change_reporter = delta._ChangeReporter(
2674
unversioned_filter=tree.is_ignored)
2676
if branch is not None:
2678
mergeable = bundle.read_mergeable_from_url(
2680
except errors.NotABundle:
2681
pass # Continue on considering this url a Branch
2683
if revision is not None:
2684
raise errors.BzrCommandError(
2685
'Cannot use -r with merge directives or bundles')
2686
other_revision_id = mergeable.install_revisions(
2687
tree.branch.repository)
2688
revision = [RevisionSpec.from_string(
2689
'revid:' + other_revision_id)]
2691
if revision is None \
2692
or len(revision) < 1 or revision[0].needs_branch():
2693
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2695
if revision is None or len(revision) < 1:
2698
other = [branch, None]
2701
other = [branch, -1]
2702
other_branch, path = Branch.open_containing(branch)
2705
raise errors.BzrCommandError('Cannot use --uncommitted and'
2706
' --revision at the same time.')
2707
branch = revision[0].get_branch() or branch
2708
if len(revision) == 1:
2710
if other_revision_id is not None:
2715
other_branch, path = Branch.open_containing(branch)
2716
revno = revision[0].in_history(other_branch).revno
2717
other = [branch, revno]
2719
assert len(revision) == 2
2720
if None in revision:
2721
raise errors.BzrCommandError(
2722
"Merge doesn't permit empty revision specifier.")
2723
base_branch, path = Branch.open_containing(branch)
2724
branch1 = revision[1].get_branch() or branch
2725
other_branch, path1 = Branch.open_containing(branch1)
2726
if revision[0].get_branch() is not None:
2727
# then path was obtained from it, and is None.
2730
base = [branch, revision[0].in_history(base_branch).revno]
2731
other = [branch1, revision[1].in_history(other_branch).revno]
2733
if ((tree.branch.get_parent() is None or remember) and
2734
other_branch is not None):
2735
tree.branch.set_parent(other_branch.base)
2737
# pull tags now... it's a bit inconsistent to do it ahead of copying
2738
# the history but that's done inside the merge code
2739
if other_branch is not None:
2740
_merge_tags_if_possible(other_branch, tree.branch)
2743
interesting_files = [path]
2745
interesting_files = None
2746
pb = ui.ui_factory.nested_progress_bar()
2749
conflict_count = _merge_helper(
2750
other, base, other_rev_id=other_revision_id,
2751
check_clean=(not force),
2752
merge_type=merge_type,
2753
reprocess=reprocess,
2754
show_base=show_base,
2757
pb=pb, file_list=interesting_files,
2758
change_reporter=change_reporter)
2761
if conflict_count != 0:
2765
except errors.AmbiguousBase, e:
2766
m = ("sorry, bzr can't determine the right merge base yet\n"
2767
"candidates are:\n "
2768
+ "\n ".join(e.bases)
2770
"please specify an explicit base with -r,\n"
2771
"and (if you want) report this to the bzr developers\n")
2774
# TODO: move up to common parent; this isn't merge-specific anymore.
2775
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2776
"""Use tree.branch's parent if none was supplied.
2778
Report if the remembered location was used.
2780
if supplied_location is not None:
2781
return supplied_location
2782
stored_location = tree.branch.get_parent()
2783
mutter("%s", stored_location)
2784
if stored_location is None:
2785
raise errors.BzrCommandError("No location specified or remembered")
2786
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2787
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2788
return stored_location
2791
class cmd_remerge(Command):
2794
Use this if you want to try a different merge technique while resolving
2795
conflicts. Some merge techniques are better than others, and remerge
2796
lets you try different ones on different files.
2798
The options for remerge have the same meaning and defaults as the ones for
2799
merge. The difference is that remerge can (only) be run when there is a
2800
pending merge, and it lets you specify particular files.
2804
$ bzr remerge --show-base
2805
Re-do the merge of all conflicted files, and show the base text in
2806
conflict regions, in addition to the usual THIS and OTHER texts.
2808
$ bzr remerge --merge-type weave --reprocess foobar
2809
Re-do the merge of "foobar", using the weave merge algorithm, with
2810
additional processing to reduce the size of conflict regions.
2812
takes_args = ['file*']
2817
help="Show base revision text in conflicts."),
2820
def run(self, file_list=None, merge_type=None, show_base=False,
2822
if merge_type is None:
2823
merge_type = _mod_merge.Merge3Merger
2824
tree, file_list = tree_files(file_list)
2827
parents = tree.get_parent_ids()
2828
if len(parents) != 2:
2829
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2830
" merges. Not cherrypicking or"
2832
repository = tree.branch.repository
2833
graph = repository.get_graph()
2834
base_revision = graph.find_unique_lca(parents[0], parents[1])
2835
base_tree = repository.revision_tree(base_revision)
2836
other_tree = repository.revision_tree(parents[1])
2837
interesting_ids = None
2839
conflicts = tree.conflicts()
2840
if file_list is not None:
2841
interesting_ids = set()
2842
for filename in file_list:
2843
file_id = tree.path2id(filename)
2845
raise errors.NotVersionedError(filename)
2846
interesting_ids.add(file_id)
2847
if tree.kind(file_id) != "directory":
2850
for name, ie in tree.inventory.iter_entries(file_id):
2851
interesting_ids.add(ie.file_id)
2852
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2854
# Remerge only supports resolving contents conflicts
2855
allowed_conflicts = ('text conflict', 'contents conflict')
2856
restore_files = [c.path for c in conflicts
2857
if c.typestring in allowed_conflicts]
2858
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2859
tree.set_conflicts(ConflictList(new_conflicts))
2860
if file_list is not None:
2861
restore_files = file_list
2862
for filename in restore_files:
2864
restore(tree.abspath(filename))
2865
except errors.NotConflicted:
2867
conflicts = _mod_merge.merge_inner(
2868
tree.branch, other_tree, base_tree,
2870
interesting_ids=interesting_ids,
2871
other_rev_id=parents[1],
2872
merge_type=merge_type,
2873
show_base=show_base,
2874
reprocess=reprocess)
2883
class cmd_revert(Command):
2884
"""Revert files to a previous revision.
2886
Giving a list of files will revert only those files. Otherwise, all files
2887
will be reverted. If the revision is not specified with '--revision', the
2888
last committed revision is used.
2890
To remove only some changes, without reverting to a prior version, use
2891
merge instead. For example, "merge . --r-2..-3" will remove the changes
2892
introduced by -2, without affecting the changes introduced by -1. Or
2893
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2895
By default, any files that have been manually changed will be backed up
2896
first. (Files changed only by merge are not backed up.) Backup files have
2897
'.~#~' appended to their name, where # is a number.
2899
When you provide files, you can use their current pathname or the pathname
2900
from the target revision. So you can use revert to "undelete" a file by
2901
name. If you name a directory, all the contents of that directory will be
2905
_see_also = ['cat', 'export']
2908
Option('no-backup', "Do not save backups of reverted files."),
2910
takes_args = ['file*']
2912
def run(self, revision=None, no_backup=False, file_list=None):
2913
if file_list is not None:
2914
if len(file_list) == 0:
2915
raise errors.BzrCommandError("No files specified")
2919
tree, file_list = tree_files(file_list)
2920
if revision is None:
2921
# FIXME should be tree.last_revision
2922
rev_id = tree.last_revision()
2923
elif len(revision) != 1:
2924
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2926
rev_id = revision[0].in_history(tree.branch).rev_id
2927
pb = ui.ui_factory.nested_progress_bar()
2929
tree.revert(file_list,
2930
tree.branch.repository.revision_tree(rev_id),
2931
not no_backup, pb, report_changes=True)
2936
class cmd_assert_fail(Command):
2937
"""Test reporting of assertion failures"""
2938
# intended just for use in testing
2943
raise AssertionError("always fails")
2946
class cmd_help(Command):
2947
"""Show help on a command or other topic.
2950
_see_also = ['topics']
2952
Option('long', 'Show help on all commands.'),
2954
takes_args = ['topic?']
2955
aliases = ['?', '--help', '-?', '-h']
2958
def run(self, topic=None, long=False):
2960
if topic is None and long:
2962
bzrlib.help.help(topic)
2965
class cmd_shell_complete(Command):
2966
"""Show appropriate completions for context.
2968
For a list of all available commands, say 'bzr shell-complete'.
2970
takes_args = ['context?']
2975
def run(self, context=None):
2976
import shellcomplete
2977
shellcomplete.shellcomplete(context)
2980
class cmd_fetch(Command):
2981
"""Copy in history from another branch but don't merge it.
2983
This is an internal method used for pull and merge.
2986
takes_args = ['from_branch', 'to_branch']
2987
def run(self, from_branch, to_branch):
2988
from bzrlib.fetch import Fetcher
2989
from_b = Branch.open(from_branch)
2990
to_b = Branch.open(to_branch)
2991
Fetcher(to_b, from_b)
2994
class cmd_missing(Command):
2995
"""Show unmerged/unpulled revisions between two branches.
2997
OTHER_BRANCH may be local or remote.
3000
_see_also = ['merge', 'pull']
3001
takes_args = ['other_branch?']
3003
Option('reverse', 'Reverse the order of revisions.'),
3005
'Display changes in the local branch only.'),
3006
Option('this' , 'Same as --mine-only.'),
3007
Option('theirs-only',
3008
'Display changes in the remote branch only.'),
3009
Option('other', 'Same as --theirs-only.'),
3014
encoding_type = 'replace'
3017
def run(self, other_branch=None, reverse=False, mine_only=False,
3018
theirs_only=False, log_format=None, long=False, short=False, line=False,
3019
show_ids=False, verbose=False, this=False, other=False):
3020
from bzrlib.missing import find_unmerged, iter_log_revisions
3021
from bzrlib.log import log_formatter
3028
local_branch = Branch.open_containing(u".")[0]
3029
parent = local_branch.get_parent()
3030
if other_branch is None:
3031
other_branch = parent
3032
if other_branch is None:
3033
raise errors.BzrCommandError("No peer location known or specified.")
3034
display_url = urlutils.unescape_for_display(parent,
3036
print "Using last location: " + display_url
3038
remote_branch = Branch.open(other_branch)
3039
if remote_branch.base == local_branch.base:
3040
remote_branch = local_branch
3041
local_branch.lock_read()
3043
remote_branch.lock_read()
3045
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
3046
if (log_format is None):
3047
log_format = log.log_formatter_registry.get_default(
3049
lf = log_format(to_file=self.outf,
3051
show_timezone='original')
3052
if reverse is False:
3053
local_extra.reverse()
3054
remote_extra.reverse()
3055
if local_extra and not theirs_only:
3056
print "You have %d extra revision(s):" % len(local_extra)
3057
for revision in iter_log_revisions(local_extra,
3058
local_branch.repository,
3060
lf.log_revision(revision)
3061
printed_local = True
3063
printed_local = False
3064
if remote_extra and not mine_only:
3065
if printed_local is True:
3067
print "You are missing %d revision(s):" % len(remote_extra)
3068
for revision in iter_log_revisions(remote_extra,
3069
remote_branch.repository,
3071
lf.log_revision(revision)
3072
if not remote_extra and not local_extra:
3074
print "Branches are up to date."
3078
remote_branch.unlock()
3080
local_branch.unlock()
3081
if not status_code and parent is None and other_branch is not None:
3082
local_branch.lock_write()
3084
# handle race conditions - a parent might be set while we run.
3085
if local_branch.get_parent() is None:
3086
local_branch.set_parent(remote_branch.base)
3088
local_branch.unlock()
3092
class cmd_plugins(Command):
3097
import bzrlib.plugin
3098
from inspect import getdoc
3099
for name, plugin in bzrlib.plugin.all_plugins().items():
3100
if getattr(plugin, '__path__', None) is not None:
3101
print plugin.__path__[0]
3102
elif getattr(plugin, '__file__', None) is not None:
3103
print plugin.__file__
3109
print '\t', d.split('\n')[0]
3112
class cmd_testament(Command):
3113
"""Show testament (signing-form) of a revision."""
3116
Option('long', help='Produce long-format testament.'),
3118
help='Produce a strict-format testament.')]
3119
takes_args = ['branch?']
3121
def run(self, branch=u'.', revision=None, long=False, strict=False):
3122
from bzrlib.testament import Testament, StrictTestament
3124
testament_class = StrictTestament
3126
testament_class = Testament
3127
b = WorkingTree.open_containing(branch)[0].branch
3130
if revision is None:
3131
rev_id = b.last_revision()
3133
rev_id = revision[0].in_history(b).rev_id
3134
t = testament_class.from_revision(b.repository, rev_id)
3136
sys.stdout.writelines(t.as_text_lines())
3138
sys.stdout.write(t.as_short_text())
3143
class cmd_annotate(Command):
3144
"""Show the origin of each line in a file.
3146
This prints out the given file with an annotation on the left side
3147
indicating which revision, author and date introduced the change.
3149
If the origin is the same for a run of consecutive lines, it is
3150
shown only at the top, unless the --all option is given.
3152
# TODO: annotate directories; showing when each file was last changed
3153
# TODO: if the working copy is modified, show annotations on that
3154
# with new uncommitted lines marked
3155
aliases = ['ann', 'blame', 'praise']
3156
takes_args = ['filename']
3157
takes_options = [Option('all', help='Show annotations on all lines.'),
3158
Option('long', help='Show commit date in annotations.'),
3162
encoding_type = 'exact'
3165
def run(self, filename, all=False, long=False, revision=None,
3167
from bzrlib.annotate import annotate_file
3168
tree, relpath = WorkingTree.open_containing(filename)
3169
branch = tree.branch
3172
if revision is None:
3173
revision_id = branch.last_revision()
3174
elif len(revision) != 1:
3175
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3177
revision_id = revision[0].in_history(branch).rev_id
3178
file_id = tree.path2id(relpath)
3180
raise errors.NotVersionedError(filename)
3181
tree = branch.repository.revision_tree(revision_id)
3182
file_version = tree.inventory[file_id].revision
3183
annotate_file(branch, file_version, file_id, long, all, self.outf,
3189
class cmd_re_sign(Command):
3190
"""Create a digital signature for an existing revision."""
3191
# TODO be able to replace existing ones.
3193
hidden = True # is this right ?
3194
takes_args = ['revision_id*']
3195
takes_options = ['revision']
3197
def run(self, revision_id_list=None, revision=None):
3198
import bzrlib.gpg as gpg
3199
if revision_id_list is not None and revision is not None:
3200
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3201
if revision_id_list is None and revision is None:
3202
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3203
b = WorkingTree.open_containing(u'.')[0].branch
3204
gpg_strategy = gpg.GPGStrategy(b.get_config())
3205
if revision_id_list is not None:
3206
for revision_id in revision_id_list:
3207
b.repository.sign_revision(revision_id, gpg_strategy)
3208
elif revision is not None:
3209
if len(revision) == 1:
3210
revno, rev_id = revision[0].in_history(b)
3211
b.repository.sign_revision(rev_id, gpg_strategy)
3212
elif len(revision) == 2:
3213
# are they both on rh- if so we can walk between them
3214
# might be nice to have a range helper for arbitrary
3215
# revision paths. hmm.
3216
from_revno, from_revid = revision[0].in_history(b)
3217
to_revno, to_revid = revision[1].in_history(b)
3218
if to_revid is None:
3219
to_revno = b.revno()
3220
if from_revno is None or to_revno is None:
3221
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3222
for revno in range(from_revno, to_revno + 1):
3223
b.repository.sign_revision(b.get_rev_id(revno),
3226
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3229
class cmd_bind(Command):
3230
"""Convert the current branch into a checkout of the supplied branch.
3232
Once converted into a checkout, commits must succeed on the master branch
3233
before they will be applied to the local branch.
3236
_see_also = ['checkouts', 'unbind']
3237
takes_args = ['location?']
3240
def run(self, location=None):
3241
b, relpath = Branch.open_containing(u'.')
3242
if location is None:
3244
location = b.get_old_bound_location()
3245
except errors.UpgradeRequired:
3246
raise errors.BzrCommandError('No location supplied. '
3247
'This format does not remember old locations.')
3249
if location is None:
3250
raise errors.BzrCommandError('No location supplied and no '
3251
'previous location known')
3252
b_other = Branch.open(location)
3255
except errors.DivergedBranches:
3256
raise errors.BzrCommandError('These branches have diverged.'
3257
' Try merging, and then bind again.')
3260
class cmd_unbind(Command):
3261
"""Convert the current checkout into a regular branch.
3263
After unbinding, the local branch is considered independent and subsequent
3264
commits will be local only.
3267
_see_also = ['checkouts', 'bind']
3272
b, relpath = Branch.open_containing(u'.')
3274
raise errors.BzrCommandError('Local branch is not bound')
3277
class cmd_uncommit(Command):
3278
"""Remove the last committed revision.
3280
--verbose will print out what is being removed.
3281
--dry-run will go through all the motions, but not actually
3284
In the future, uncommit will create a revision bundle, which can then
3288
# TODO: jam 20060108 Add an option to allow uncommit to remove
3289
# unreferenced information in 'branch-as-repository' branches.
3290
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3291
# information in shared branches as well.
3292
_see_also = ['commit']
3293
takes_options = ['verbose', 'revision',
3294
Option('dry-run', help='Don\'t actually make changes.'),
3295
Option('force', help='Say yes to all questions.')]
3296
takes_args = ['location?']
3299
def run(self, location=None,
3300
dry_run=False, verbose=False,
3301
revision=None, force=False):
3302
from bzrlib.log import log_formatter, show_log
3304
from bzrlib.uncommit import uncommit
3306
if location is None:
3308
control, relpath = bzrdir.BzrDir.open_containing(location)
3310
tree = control.open_workingtree()
3312
except (errors.NoWorkingTree, errors.NotLocalUrl):
3314
b = control.open_branch()
3317
if revision is None:
3320
# 'bzr uncommit -r 10' actually means uncommit
3321
# so that the final tree is at revno 10.
3322
# but bzrlib.uncommit.uncommit() actually uncommits
3323
# the revisions that are supplied.
3324
# So we need to offset it by one
3325
revno = revision[0].in_history(b).revno+1
3327
if revno <= b.revno():
3328
rev_id = b.get_rev_id(revno)
3330
self.outf.write('No revisions to uncommit.\n')
3333
lf = log_formatter('short',
3335
show_timezone='original')
3340
direction='forward',
3341
start_revision=revno,
3342
end_revision=b.revno())
3345
print 'Dry-run, pretending to remove the above revisions.'
3347
val = raw_input('Press <enter> to continue')
3349
print 'The above revision(s) will be removed.'
3351
val = raw_input('Are you sure [y/N]? ')
3352
if val.lower() not in ('y', 'yes'):
3356
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3360
class cmd_break_lock(Command):
3361
"""Break a dead lock on a repository, branch or working directory.
3363
CAUTION: Locks should only be broken when you are sure that the process
3364
holding the lock has been stopped.
3366
You can get information on what locks are open via the 'bzr info' command.
3371
takes_args = ['location?']
3373
def run(self, location=None, show=False):
3374
if location is None:
3376
control, relpath = bzrdir.BzrDir.open_containing(location)
3378
control.break_lock()
3379
except NotImplementedError:
3383
class cmd_wait_until_signalled(Command):
3384
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3386
This just prints a line to signal when it is ready, then blocks on stdin.
3392
sys.stdout.write("running\n")
3394
sys.stdin.readline()
3397
class cmd_serve(Command):
3398
"""Run the bzr server."""
3400
aliases = ['server']
3404
help='Serve on stdin/out for use from inetd or sshd.'),
3406
help='Listen for connections on nominated port of the form '
3407
'[hostname:]portnumber. Passing 0 as the port number will '
3408
'result in a dynamically allocated port. The default port is '
3412
help='Serve contents of this directory.',
3414
Option('allow-writes',
3415
help='By default the server is a readonly server. Supplying '
3416
'--allow-writes enables write access to the contents of '
3417
'the served directory and below.'
3421
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3422
from bzrlib.smart import medium, server
3423
from bzrlib.transport import get_transport
3424
from bzrlib.transport.chroot import ChrootServer
3425
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3426
if directory is None:
3427
directory = os.getcwd()
3428
url = urlutils.local_path_to_url(directory)
3429
if not allow_writes:
3430
url = 'readonly+' + url
3431
chroot_server = ChrootServer(get_transport(url))
3432
chroot_server.setUp()
3433
t = get_transport(chroot_server.get_url())
3435
smart_server = medium.SmartServerPipeStreamMedium(
3436
sys.stdin, sys.stdout, t)
3438
host = BZR_DEFAULT_INTERFACE
3440
port = BZR_DEFAULT_PORT
3443
host, port = port.split(':')
3445
smart_server = server.SmartTCPServer(t, host=host, port=port)
3446
print 'listening on port: ', smart_server.port
3448
# for the duration of this server, no UI output is permitted.
3449
# note that this may cause problems with blackbox tests. This should
3450
# be changed with care though, as we dont want to use bandwidth sending
3451
# progress over stderr to smart server clients!
3452
old_factory = ui.ui_factory
3454
ui.ui_factory = ui.SilentUIFactory()
3455
smart_server.serve()
3457
ui.ui_factory = old_factory
3460
class cmd_join(Command):
3461
"""Combine a subtree into its containing tree.
3463
This command is for experimental use only. It requires the target tree
3464
to be in dirstate-with-subtree format, which cannot be converted into
3467
The TREE argument should be an independent tree, inside another tree, but
3468
not part of it. (Such trees can be produced by "bzr split", but also by
3469
running "bzr branch" with the target inside a tree.)
3471
The result is a combined tree, with the subtree no longer an independant
3472
part. This is marked as a merge of the subtree into the containing tree,
3473
and all history is preserved.
3475
If --reference is specified, the subtree retains its independence. It can
3476
be branched by itself, and can be part of multiple projects at the same
3477
time. But operations performed in the containing tree, such as commit
3478
and merge, will recurse into the subtree.
3481
_see_also = ['split']
3482
takes_args = ['tree']
3484
Option('reference', help='Join by reference.'),
3488
def run(self, tree, reference=False):
3489
sub_tree = WorkingTree.open(tree)
3490
parent_dir = osutils.dirname(sub_tree.basedir)
3491
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3492
repo = containing_tree.branch.repository
3493
if not repo.supports_rich_root():
3494
raise errors.BzrCommandError(
3495
"Can't join trees because %s doesn't support rich root data.\n"
3496
"You can use bzr upgrade on the repository."
3500
containing_tree.add_reference(sub_tree)
3501
except errors.BadReferenceTarget, e:
3502
# XXX: Would be better to just raise a nicely printable
3503
# exception from the real origin. Also below. mbp 20070306
3504
raise errors.BzrCommandError("Cannot join %s. %s" %
3508
containing_tree.subsume(sub_tree)
3509
except errors.BadSubsumeSource, e:
3510
raise errors.BzrCommandError("Cannot join %s. %s" %
3514
class cmd_split(Command):
3515
"""Split a tree into two trees.
3517
This command is for experimental use only. It requires the target tree
3518
to be in dirstate-with-subtree format, which cannot be converted into
3521
The TREE argument should be a subdirectory of a working tree. That
3522
subdirectory will be converted into an independent tree, with its own
3523
branch. Commits in the top-level tree will not apply to the new subtree.
3524
If you want that behavior, do "bzr join --reference TREE".
3527
_see_also = ['join']
3528
takes_args = ['tree']
3532
def run(self, tree):
3533
containing_tree, subdir = WorkingTree.open_containing(tree)
3534
sub_id = containing_tree.path2id(subdir)
3536
raise errors.NotVersionedError(subdir)
3538
containing_tree.extract(sub_id)
3539
except errors.RootNotRich:
3540
raise errors.UpgradeRequired(containing_tree.branch.base)
3544
class cmd_merge_directive(Command):
3545
"""Generate a merge directive for auto-merge tools.
3547
A directive requests a merge to be performed, and also provides all the
3548
information necessary to do so. This means it must either include a
3549
revision bundle, or the location of a branch containing the desired
3552
A submit branch (the location to merge into) must be supplied the first
3553
time the command is issued. After it has been supplied once, it will
3554
be remembered as the default.
3556
A public branch is optional if a revision bundle is supplied, but required
3557
if --diff or --plain is specified. It will be remembered as the default
3558
after the first use.
3561
takes_args = ['submit_branch?', 'public_branch?']
3564
RegistryOption.from_kwargs('patch-type',
3565
'The type of patch to include in the directive',
3567
value_switches=True,
3569
bundle='Bazaar revision bundle (default).',
3570
diff='Normal unified diff.',
3571
plain='No patch, just directive.'),
3572
Option('sign', help='GPG-sign the directive.'), 'revision',
3573
Option('mail-to', type=str,
3574
help='Instead of printing the directive, email to this address.'),
3575
Option('message', type=str, short_name='m',
3576
help='Message to use when committing this merge.')
3579
encoding_type = 'exact'
3581
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3582
sign=False, revision=None, mail_to=None, message=None):
3583
from bzrlib.revision import ensure_null, NULL_REVISION
3584
if patch_type == 'plain':
3586
branch = Branch.open('.')
3587
stored_submit_branch = branch.get_submit_branch()
3588
if submit_branch is None:
3589
submit_branch = stored_submit_branch
3591
if stored_submit_branch is None:
3592
branch.set_submit_branch(submit_branch)
3593
if submit_branch is None:
3594
submit_branch = branch.get_parent()
3595
if submit_branch is None:
3596
raise errors.BzrCommandError('No submit branch specified or known')
3598
stored_public_branch = branch.get_public_branch()
3599
if public_branch is None:
3600
public_branch = stored_public_branch
3601
elif stored_public_branch is None:
3602
branch.set_public_branch(public_branch)
3603
if patch_type != "bundle" and public_branch is None:
3604
raise errors.BzrCommandError('No public branch specified or'
3606
if revision is not None:
3607
if len(revision) != 1:
3608
raise errors.BzrCommandError('bzr merge-directive takes '
3609
'exactly one revision identifier')
3611
revision_id = revision[0].in_history(branch).rev_id
3613
revision_id = branch.last_revision()
3614
revision_id = ensure_null(revision_id)
3615
if revision_id == NULL_REVISION:
3616
raise errors.BzrCommandError('No revisions to bundle.')
3617
directive = merge_directive.MergeDirective.from_objects(
3618
branch.repository, revision_id, time.time(),
3619
osutils.local_time_offset(), submit_branch,
3620
public_branch=public_branch, patch_type=patch_type,
3624
self.outf.write(directive.to_signed(branch))
3626
self.outf.writelines(directive.to_lines())
3628
message = directive.to_email(mail_to, branch, sign)
3629
s = SMTPConnection(branch.get_config())
3630
s.send_email(message)
3633
class cmd_tag(Command):
3634
"""Create a tag naming a revision.
3636
Tags give human-meaningful names to revisions. Commands that take a -r
3637
(--revision) option can be given -rtag:X, where X is any previously
3640
Tags are stored in the branch. Tags are copied from one branch to another
3641
along when you branch, push, pull or merge.
3643
It is an error to give a tag name that already exists unless you pass
3644
--force, in which case the tag is moved to point to the new revision.
3647
_see_also = ['commit', 'tags']
3648
takes_args = ['tag_name']
3651
help='Delete this tag rather than placing it.',
3654
help='Branch in which to place the tag.',
3659
help='Replace existing tags.',
3664
def run(self, tag_name,
3670
branch, relpath = Branch.open_containing(directory)
3674
branch.tags.delete_tag(tag_name)
3675
self.outf.write('Deleted tag %s.\n' % tag_name)
3678
if len(revision) != 1:
3679
raise errors.BzrCommandError(
3680
"Tags can only be placed on a single revision, "
3682
revision_id = revision[0].in_history(branch).rev_id
3684
revision_id = branch.last_revision()
3685
if (not force) and branch.tags.has_tag(tag_name):
3686
raise errors.TagAlreadyExists(tag_name)
3687
branch.tags.set_tag(tag_name, revision_id)
3688
self.outf.write('Created tag %s.\n' % tag_name)
3693
class cmd_tags(Command):
3696
This tag shows a table of tag names and the revisions they reference.
3702
help='Branch whose tags should be displayed.',
3712
branch, relpath = Branch.open_containing(directory)
3713
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3714
self.outf.write('%-20s %s\n' % (tag_name, target))
3717
# command-line interpretation helper for merge-related commands
3718
def _merge_helper(other_revision, base_revision,
3719
check_clean=True, ignore_zero=False,
3720
this_dir=None, backup_files=False,
3722
file_list=None, show_base=False, reprocess=False,
3725
change_reporter=None,
3727
"""Merge changes into a tree.
3730
list(path, revno) Base for three-way merge.
3731
If [None, None] then a base will be automatically determined.
3733
list(path, revno) Other revision for three-way merge.
3735
Directory to merge changes into; '.' by default.
3737
If true, this_dir must have no uncommitted changes before the
3739
ignore_zero - If true, suppress the "zero conflicts" message when
3740
there are no conflicts; should be set when doing something we expect
3741
to complete perfectly.
3742
file_list - If supplied, merge only changes to selected files.
3744
All available ancestors of other_revision and base_revision are
3745
automatically pulled into the branch.
3747
The revno may be -1 to indicate the last revision on the branch, which is
3750
This function is intended for use from the command line; programmatic
3751
clients might prefer to call merge.merge_inner(), which has less magic
3754
# Loading it late, so that we don't always have to import bzrlib.merge
3755
if merge_type is None:
3756
merge_type = _mod_merge.Merge3Merger
3757
if this_dir is None:
3759
this_tree = WorkingTree.open_containing(this_dir)[0]
3760
if show_base and not merge_type is _mod_merge.Merge3Merger:
3761
raise errors.BzrCommandError("Show-base is not supported for this merge"
3762
" type. %s" % merge_type)
3763
if reprocess and not merge_type.supports_reprocess:
3764
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3765
" type %s." % merge_type)
3766
if reprocess and show_base:
3767
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3768
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3769
# only want to take out a lock_tree_write() if we don't have to pull
3770
# any ancestry. But merge might fetch ancestry in the middle, in
3771
# which case we would need a lock_write().
3772
# Because we cannot upgrade locks, for now we live with the fact that
3773
# the tree will be locked multiple times during a merge. (Maybe
3774
# read-only some of the time, but it means things will get read
3777
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3778
pb=pb, change_reporter=change_reporter)
3779
merger.pp = ProgressPhase("Merge phase", 5, pb)
3780
merger.pp.next_phase()
3781
merger.check_basis(check_clean)
3782
if other_rev_id is not None:
3783
merger.set_other_revision(other_rev_id, this_tree.branch)
3785
merger.set_other(other_revision)
3786
merger.pp.next_phase()
3787
merger.set_base(base_revision)
3788
if merger.base_rev_id == merger.other_rev_id:
3789
note('Nothing to do.')
3791
if file_list is None:
3792
if pull and merger.base_rev_id == merger.this_rev_id:
3793
# FIXME: deduplicate with pull
3794
result = merger.this_tree.pull(merger.this_branch,
3795
False, merger.other_rev_id)
3796
if result.old_revid == result.new_revid:
3797
note('No revisions to pull.')
3799
note('Now on revision %d.' % result.new_revno)
3801
merger.backup_files = backup_files
3802
merger.merge_type = merge_type
3803
merger.set_interesting_files(file_list)
3804
merger.show_base = show_base
3805
merger.reprocess = reprocess
3806
conflicts = merger.do_merge()
3807
if file_list is None:
3808
merger.set_pending()
3814
def _create_prefix(cur_transport):
3815
needed = [cur_transport]
3816
# Recurse upwards until we can create a directory successfully
3818
new_transport = cur_transport.clone('..')
3819
if new_transport.base == cur_transport.base:
3820
raise errors.BzrCommandError("Failed to create path"
3824
new_transport.mkdir('.')
3825
except errors.NoSuchFile:
3826
needed.append(new_transport)
3827
cur_transport = new_transport
3831
# Now we only need to create child directories
3833
cur_transport = needed.pop()
3834
cur_transport.ensure_base()
3837
merge = _merge_helper
3840
# these get imported and then picked up by the scan for cmd_*
3841
# TODO: Some more consistent way to split command definitions across files;
3842
# we do need to load at least some information about them to know of
3843
# aliases. ideally we would avoid loading the implementation until the
3844
# details were needed.
3845
from bzrlib.cmd_version_info import cmd_version_info
3846
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3847
from bzrlib.bundle.commands import cmd_bundle_revisions
3848
from bzrlib.sign_my_commits import cmd_sign_my_commits
3849
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
3850
cmd_weave_plan_merge, cmd_weave_merge_text