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
Column 1: versioning / renames
164
P Entry for a pending merge (not a file)
173
* The execute bit was changed
175
If no arguments are specified, the status of the entire working
176
directory is shown. Otherwise, only the status of the specified
177
files or directories is reported. If a directory is given, status
178
is reported for everything inside that directory.
180
If a revision argument is given, the status is calculated against
181
that revision, or between two revisions if two are provided.
184
# TODO: --no-recurse, --recurse options
186
takes_args = ['file*']
187
takes_options = ['show-ids', 'revision',
188
Option('short', help='Give short SVN-style status lines'),
189
Option('versioned', help='Only show versioned files')]
190
aliases = ['st', 'stat']
192
encoding_type = 'replace'
193
_see_also = ['diff', 'revert']
196
def run(self, show_ids=False, file_list=None, revision=None, short=False,
198
from bzrlib.status import show_tree_status
200
tree, file_list = tree_files(file_list)
202
show_tree_status(tree, show_ids=show_ids,
203
specific_files=file_list, revision=revision,
204
to_file=self.outf, short=short, versioned=versioned)
207
class cmd_cat_revision(Command):
208
"""Write out metadata for a revision.
210
The revision to print can either be specified by a specific
211
revision identifier, or you can use --revision.
215
takes_args = ['revision_id?']
216
takes_options = ['revision']
217
# cat-revision is more for frontends so should be exact
221
def run(self, revision_id=None, revision=None):
223
revision_id = osutils.safe_revision_id(revision_id, warn=False)
224
if revision_id is not None and revision is not None:
225
raise errors.BzrCommandError('You can only supply one of'
226
' revision_id or --revision')
227
if revision_id is None and revision is None:
228
raise errors.BzrCommandError('You must supply either'
229
' --revision or a revision_id')
230
b = WorkingTree.open_containing(u'.')[0].branch
232
# TODO: jam 20060112 should cat-revision always output utf-8?
233
if revision_id is not None:
234
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
235
elif revision is not None:
238
raise errors.BzrCommandError('You cannot specify a NULL'
240
revno, rev_id = rev.in_history(b)
241
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
244
class cmd_remove_tree(Command):
245
"""Remove the working tree from a given branch/checkout.
247
Since a lightweight checkout is little more than a working tree
248
this will refuse to run against one.
250
To re-create the working tree, use "bzr checkout".
252
_see_also = ['checkout', 'working-trees']
254
takes_args = ['location?']
256
def run(self, location='.'):
257
d = bzrdir.BzrDir.open(location)
260
working = d.open_workingtree()
261
except errors.NoWorkingTree:
262
raise errors.BzrCommandError("No working tree to remove")
263
except errors.NotLocalUrl:
264
raise errors.BzrCommandError("You cannot remove the working tree of a "
267
working_path = working.bzrdir.root_transport.base
268
branch_path = working.branch.bzrdir.root_transport.base
269
if working_path != branch_path:
270
raise errors.BzrCommandError("You cannot remove the working tree from "
271
"a lightweight checkout")
273
d.destroy_workingtree()
276
class cmd_revno(Command):
277
"""Show current revision number.
279
This is equal to the number of revisions on this branch.
283
takes_args = ['location?']
286
def run(self, location=u'.'):
287
self.outf.write(str(Branch.open_containing(location)[0].revno()))
288
self.outf.write('\n')
291
class cmd_revision_info(Command):
292
"""Show revision number and revision id for a given revision identifier.
295
takes_args = ['revision_info*']
296
takes_options = ['revision']
299
def run(self, revision=None, revision_info_list=[]):
302
if revision is not None:
303
revs.extend(revision)
304
if revision_info_list is not None:
305
for rev in revision_info_list:
306
revs.append(RevisionSpec.from_string(rev))
308
b = Branch.open_containing(u'.')[0]
311
revs.append(RevisionSpec.from_string('-1'))
314
revinfo = rev.in_history(b)
315
if revinfo.revno is None:
316
dotted_map = b.get_revision_id_to_revno_map()
317
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
318
print '%s %s' % (revno, revinfo.rev_id)
320
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
323
class cmd_add(Command):
324
"""Add specified files or directories.
326
In non-recursive mode, all the named items are added, regardless
327
of whether they were previously ignored. A warning is given if
328
any of the named files are already versioned.
330
In recursive mode (the default), files are treated the same way
331
but the behaviour for directories is different. Directories that
332
are already versioned do not give a warning. All directories,
333
whether already versioned or not, are searched for files or
334
subdirectories that are neither versioned or ignored, and these
335
are added. This search proceeds recursively into versioned
336
directories. If no names are given '.' is assumed.
338
Therefore simply saying 'bzr add' will version all files that
339
are currently unknown.
341
Adding a file whose parent directory is not versioned will
342
implicitly add the parent, and so on up to the root. This means
343
you should never need to explicitly add a directory, they'll just
344
get added when you add a file in the directory.
346
--dry-run will show which files would be added, but not actually
349
--file-ids-from will try to use the file ids from the supplied path.
350
It looks up ids trying to find a matching parent directory with the
351
same filename, and then by pure path. This option is rarely needed
352
but can be useful when adding the same logical file into two
353
branches that will be merged later (without showing the two different
354
adds as a conflict). It is also useful when merging another project
355
into a subdirectory of this one.
357
takes_args = ['file*']
358
takes_options = ['no-recurse', 'dry-run', 'verbose',
359
Option('file-ids-from', type=unicode,
360
help='Lookup file ids from here')]
361
encoding_type = 'replace'
362
_see_also = ['remove']
364
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
369
if file_ids_from is not None:
371
base_tree, base_path = WorkingTree.open_containing(
373
except errors.NoWorkingTree:
374
base_branch, base_path = Branch.open_containing(
376
base_tree = base_branch.basis_tree()
378
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
379
to_file=self.outf, should_print=(not is_quiet()))
381
action = bzrlib.add.AddAction(to_file=self.outf,
382
should_print=(not is_quiet()))
385
base_tree.lock_read()
387
file_list = self._maybe_expand_globs(file_list)
389
tree = WorkingTree.open_containing(file_list[0])[0]
391
tree = WorkingTree.open_containing(u'.')[0]
392
added, ignored = bzrlib.add.smart_add_tree(tree, file_list, not
393
no_recurse, action=action, save=not dry_run)
395
if base_tree is not None:
399
for glob in sorted(ignored.keys()):
400
for path in ignored[glob]:
401
self.outf.write("ignored %s matching \"%s\"\n"
405
for glob, paths in ignored.items():
406
match_len += len(paths)
407
self.outf.write("ignored %d file(s).\n" % match_len)
408
self.outf.write("If you wish to add some of these files,"
409
" please add them by name.\n")
412
class cmd_mkdir(Command):
413
"""Create a new versioned directory.
415
This is equivalent to creating the directory and then adding it.
418
takes_args = ['dir+']
419
encoding_type = 'replace'
421
def run(self, dir_list):
424
wt, dd = WorkingTree.open_containing(d)
426
self.outf.write('added %s\n' % d)
429
class cmd_relpath(Command):
430
"""Show path of a file relative to root"""
432
takes_args = ['filename']
436
def run(self, filename):
437
# TODO: jam 20050106 Can relpath return a munged path if
438
# sys.stdout encoding cannot represent it?
439
tree, relpath = WorkingTree.open_containing(filename)
440
self.outf.write(relpath)
441
self.outf.write('\n')
444
class cmd_inventory(Command):
445
"""Show inventory of the current working copy or a revision.
447
It is possible to limit the output to a particular entry
448
type using the --kind option. For example: --kind file.
450
It is also possible to restrict the list of files to a specific
451
set. For example: bzr inventory --show-ids this/file
456
takes_options = ['revision', 'show-ids', 'kind']
457
takes_args = ['file*']
460
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
461
if kind and kind not in ['file', 'directory', 'symlink']:
462
raise errors.BzrCommandError('invalid kind specified')
464
work_tree, file_list = tree_files(file_list)
465
work_tree.lock_read()
467
if revision is not None:
468
if len(revision) > 1:
469
raise errors.BzrCommandError(
470
'bzr inventory --revision takes exactly one revision'
472
revision_id = revision[0].in_history(work_tree.branch).rev_id
473
tree = work_tree.branch.repository.revision_tree(revision_id)
475
extra_trees = [work_tree]
481
if file_list is not None:
482
file_ids = tree.paths2ids(file_list, trees=extra_trees,
483
require_versioned=True)
484
# find_ids_across_trees may include some paths that don't
486
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
487
for file_id in file_ids if file_id in tree)
489
entries = tree.inventory.entries()
492
if tree is not work_tree:
495
for path, entry in entries:
496
if kind and kind != entry.kind:
499
self.outf.write('%-50s %s\n' % (path, entry.file_id))
501
self.outf.write(path)
502
self.outf.write('\n')
505
class cmd_mv(Command):
506
"""Move or rename a file.
509
bzr mv OLDNAME NEWNAME
510
bzr mv SOURCE... DESTINATION
512
If the last argument is a versioned directory, all the other names
513
are moved into it. Otherwise, there must be exactly two arguments
514
and the file is changed to a new name.
516
If OLDNAME does not exist on the filesystem but is versioned and
517
NEWNAME does exist on the filesystem but is not versioned, mv
518
assumes that the file has been manually moved and only updates
519
its internal inventory to reflect that change.
520
The same is valid when moving many SOURCE files to a DESTINATION.
522
Files cannot be moved between branches.
525
takes_args = ['names*']
526
takes_options = [Option("after", help="move only the bzr identifier"
527
" of the file (file has already been moved). Use this flag if"
528
" bzr is not able to detect this itself.")]
529
aliases = ['move', 'rename']
530
encoding_type = 'replace'
532
def run(self, names_list, after=False):
533
if names_list is None:
536
if len(names_list) < 2:
537
raise errors.BzrCommandError("missing file argument")
538
tree, rel_names = tree_files(names_list)
540
if os.path.isdir(names_list[-1]):
541
# move into existing directory
542
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
543
self.outf.write("%s => %s\n" % pair)
545
if len(names_list) != 2:
546
raise errors.BzrCommandError('to mv multiple files the'
547
' destination must be a versioned'
549
tree.rename_one(rel_names[0], rel_names[1], after=after)
550
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
553
class cmd_pull(Command):
554
"""Turn this branch into a mirror of another branch.
556
This command only works on branches that have not diverged. Branches are
557
considered diverged if the destination branch's most recent commit is one
558
that has not been merged (directly or indirectly) into the parent.
560
If branches have diverged, you can use 'bzr merge' to integrate the changes
561
from one into the other. Once one branch has merged, the other should
562
be able to pull it again.
564
If you want to forget your local changes and just update your branch to
565
match the remote one, use pull --overwrite.
567
If there is no default location set, the first pull will set it. After
568
that, you can omit the location to use the default. To change the
569
default, use --remember. The value will only be saved if the remote
570
location can be accessed.
573
_see_also = ['push', 'update']
574
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
576
help='branch to pull into, '
577
'rather than the one containing the working directory',
582
takes_args = ['location?']
583
encoding_type = 'replace'
585
def run(self, location=None, remember=False, overwrite=False,
586
revision=None, verbose=False,
588
from bzrlib.tag import _merge_tags_if_possible
589
# FIXME: too much stuff is in the command class
592
if directory is None:
595
tree_to = WorkingTree.open_containing(directory)[0]
596
branch_to = tree_to.branch
597
except errors.NoWorkingTree:
599
branch_to = Branch.open_containing(directory)[0]
602
if location is not None:
604
mergeable = bundle.read_mergeable_from_url(
606
except errors.NotABundle:
607
pass # Continue on considering this url a Branch
609
stored_loc = branch_to.get_parent()
611
if stored_loc is None:
612
raise errors.BzrCommandError("No pull location known or"
615
display_url = urlutils.unescape_for_display(stored_loc,
617
self.outf.write("Using saved location: %s\n" % display_url)
618
location = stored_loc
620
if mergeable is not None:
621
if revision is not None:
622
raise errors.BzrCommandError(
623
'Cannot use -r with merge directives or bundles')
624
revision_id = mergeable.install_revisions(branch_to.repository)
625
branch_from = branch_to
627
branch_from = Branch.open(location)
629
if branch_to.get_parent() is None or remember:
630
branch_to.set_parent(branch_from.base)
632
if revision is not None:
633
if len(revision) == 1:
634
revision_id = revision[0].in_history(branch_from).rev_id
636
raise errors.BzrCommandError(
637
'bzr pull --revision takes one value.')
639
old_rh = branch_to.revision_history()
640
if tree_to is not None:
641
result = tree_to.pull(branch_from, overwrite, revision_id,
642
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
644
result = branch_to.pull(branch_from, overwrite, revision_id)
646
result.report(self.outf)
648
from bzrlib.log import show_changed_revisions
649
new_rh = branch_to.revision_history()
650
show_changed_revisions(branch_to, old_rh, new_rh,
654
class cmd_push(Command):
655
"""Update a mirror of this branch.
657
The target branch will not have its working tree populated because this
658
is both expensive, and is not supported on remote file systems.
660
Some smart servers or protocols *may* put the working tree in place in
663
This command only works on branches that have not diverged. Branches are
664
considered diverged if the destination branch's most recent commit is one
665
that has not been merged (directly or indirectly) by the source branch.
667
If branches have diverged, you can use 'bzr push --overwrite' to replace
668
the other branch completely, discarding its unmerged changes.
670
If you want to ensure you have the different changes in the other branch,
671
do a merge (see bzr help merge) from the other branch, and commit that.
672
After that you will be able to do a push without '--overwrite'.
674
If there is no default push location set, the first push will set it.
675
After that, you can omit the location to use the default. To change the
676
default, use --remember. The value will only be saved if the remote
677
location can be accessed.
680
_see_also = ['pull', 'update', 'working-trees']
681
takes_options = ['remember', 'overwrite', 'verbose',
682
Option('create-prefix',
683
help='Create the path leading up to the branch '
684
'if it does not already exist'),
686
help='branch to push from, '
687
'rather than the one containing the working directory',
691
Option('use-existing-dir',
692
help='By default push will fail if the target'
693
' directory exists, but does not already'
694
' have a control directory. This flag will'
695
' allow push to proceed.'),
697
takes_args = ['location?']
698
encoding_type = 'replace'
700
def run(self, location=None, remember=False, overwrite=False,
701
create_prefix=False, verbose=False,
702
use_existing_dir=False,
704
# FIXME: Way too big! Put this into a function called from the
706
if directory is None:
708
br_from = Branch.open_containing(directory)[0]
709
stored_loc = br_from.get_push_location()
711
if stored_loc is None:
712
raise errors.BzrCommandError("No push location known or specified.")
714
display_url = urlutils.unescape_for_display(stored_loc,
716
self.outf.write("Using saved location: %s\n" % display_url)
717
location = stored_loc
719
to_transport = transport.get_transport(location)
721
br_to = repository_to = dir_to = None
723
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
724
except errors.NotBranchError:
725
pass # Didn't find anything
727
# If we can open a branch, use its direct repository, otherwise see
728
# if there is a repository without a branch.
730
br_to = dir_to.open_branch()
731
except errors.NotBranchError:
732
# Didn't find a branch, can we find a repository?
734
repository_to = dir_to.find_repository()
735
except errors.NoRepositoryPresent:
738
# Found a branch, so we must have found a repository
739
repository_to = br_to.repository
743
# The destination doesn't exist; create it.
744
# XXX: Refactor the create_prefix/no_create_prefix code into a
745
# common helper function
747
to_transport.mkdir('.')
748
except errors.FileExists:
749
if not use_existing_dir:
750
raise errors.BzrCommandError("Target directory %s"
751
" already exists, but does not have a valid .bzr"
752
" directory. Supply --use-existing-dir to push"
753
" there anyway." % location)
754
except errors.NoSuchFile:
755
if not create_prefix:
756
raise errors.BzrCommandError("Parent directory of %s"
758
"\nYou may supply --create-prefix to create all"
759
" leading parent directories."
762
_create_prefix(to_transport)
764
# Now the target directory exists, but doesn't have a .bzr
765
# directory. So we need to create it, along with any work to create
766
# all of the dependent branches, etc.
767
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
768
revision_id=br_from.last_revision())
769
br_to = dir_to.open_branch()
770
# TODO: Some more useful message about what was copied
771
note('Created new branch.')
772
# We successfully created the target, remember it
773
if br_from.get_push_location() is None or remember:
774
br_from.set_push_location(br_to.base)
775
elif repository_to is None:
776
# we have a bzrdir but no branch or repository
777
# XXX: Figure out what to do other than complain.
778
raise errors.BzrCommandError("At %s you have a valid .bzr control"
779
" directory, but not a branch or repository. This is an"
780
" unsupported configuration. Please move the target directory"
781
" out of the way and try again."
784
# We have a repository but no branch, copy the revisions, and then
786
last_revision_id = br_from.last_revision()
787
repository_to.fetch(br_from.repository,
788
revision_id=last_revision_id)
789
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
790
note('Created new branch.')
791
if br_from.get_push_location() is None or remember:
792
br_from.set_push_location(br_to.base)
793
else: # We have a valid to branch
794
# We were able to connect to the remote location, so remember it
795
# we don't need to successfully push because of possible divergence.
796
if br_from.get_push_location() is None or remember:
797
br_from.set_push_location(br_to.base)
798
old_rh = br_to.revision_history()
801
tree_to = dir_to.open_workingtree()
802
except errors.NotLocalUrl:
803
warning("This transport does not update the working "
804
"tree of: %s. See 'bzr help working-trees' for "
805
"more information." % br_to.base)
806
push_result = br_from.push(br_to, overwrite)
807
except errors.NoWorkingTree:
808
push_result = br_from.push(br_to, overwrite)
812
push_result = br_from.push(tree_to.branch, overwrite)
816
except errors.DivergedBranches:
817
raise errors.BzrCommandError('These branches have diverged.'
818
' Try using "merge" and then "push".')
819
if push_result is not None:
820
push_result.report(self.outf)
822
new_rh = br_to.revision_history()
825
from bzrlib.log import show_changed_revisions
826
show_changed_revisions(br_to, old_rh, new_rh,
829
# we probably did a clone rather than a push, so a message was
834
class cmd_branch(Command):
835
"""Create a new copy of a branch.
837
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
838
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
839
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
840
is derived from the FROM_LOCATION by stripping a leading scheme or drive
841
identifier, if any. For example, "branch lp:foo-bar" will attempt to
844
To retrieve the branch as of a particular revision, supply the --revision
845
parameter, as in "branch foo/bar -r 5".
848
_see_also = ['checkout']
849
takes_args = ['from_location', 'to_location?']
850
takes_options = ['revision']
851
aliases = ['get', 'clone']
853
def run(self, from_location, to_location=None, revision=None):
854
from bzrlib.tag import _merge_tags_if_possible
857
elif len(revision) > 1:
858
raise errors.BzrCommandError(
859
'bzr branch --revision takes exactly 1 revision value')
861
br_from = Branch.open(from_location)
864
if len(revision) == 1 and revision[0] is not None:
865
revision_id = revision[0].in_history(br_from)[1]
867
# FIXME - wt.last_revision, fallback to branch, fall back to
868
# None or perhaps NULL_REVISION to mean copy nothing
870
revision_id = br_from.last_revision()
871
if to_location is None:
872
to_location = urlutils.derive_to_location(from_location)
875
name = os.path.basename(to_location) + '\n'
877
to_transport = transport.get_transport(to_location)
879
to_transport.mkdir('.')
880
except errors.FileExists:
881
raise errors.BzrCommandError('Target directory "%s" already'
882
' exists.' % to_location)
883
except errors.NoSuchFile:
884
raise errors.BzrCommandError('Parent of "%s" does not exist.'
887
# preserve whatever source format we have.
888
dir = br_from.bzrdir.sprout(to_transport.base, revision_id)
889
branch = dir.open_branch()
890
except errors.NoSuchRevision:
891
to_transport.delete_tree('.')
892
msg = "The branch %s has no revision %s." % (from_location, revision[0])
893
raise errors.BzrCommandError(msg)
895
branch.control_files.put_utf8('branch-name', name)
896
_merge_tags_if_possible(br_from, branch)
897
note('Branched %d revision(s).' % branch.revno())
902
class cmd_checkout(Command):
903
"""Create a new checkout of an existing branch.
905
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
906
the branch found in '.'. This is useful if you have removed the working tree
907
or if it was never created - i.e. if you pushed the branch to its current
910
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
911
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
912
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
913
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
914
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
917
To retrieve the branch as of a particular revision, supply the --revision
918
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
919
out of date [so you cannot commit] but it may be useful (i.e. to examine old
923
_see_also = ['checkouts', 'branch']
924
takes_args = ['branch_location?', 'to_location?']
925
takes_options = ['revision',
926
Option('lightweight',
927
help="perform a lightweight checkout. Lightweight "
928
"checkouts depend on access to the branch for "
929
"every operation. Normal checkouts can perform "
930
"common operations like diff and status without "
931
"such access, and also support local commits."
936
def run(self, branch_location=None, to_location=None, revision=None,
940
elif len(revision) > 1:
941
raise errors.BzrCommandError(
942
'bzr checkout --revision takes exactly 1 revision value')
943
if branch_location is None:
944
branch_location = osutils.getcwd()
945
to_location = branch_location
946
source = Branch.open(branch_location)
947
if len(revision) == 1 and revision[0] is not None:
948
revision_id = revision[0].in_history(source)[1]
951
if to_location is None:
952
to_location = urlutils.derive_to_location(branch_location)
953
# if the source and to_location are the same,
954
# and there is no working tree,
955
# then reconstitute a branch
956
if (osutils.abspath(to_location) ==
957
osutils.abspath(branch_location)):
959
source.bzrdir.open_workingtree()
960
except errors.NoWorkingTree:
961
source.bzrdir.create_workingtree()
964
os.mkdir(to_location)
966
if e.errno == errno.EEXIST:
967
raise errors.BzrCommandError('Target directory "%s" already'
968
' exists.' % to_location)
969
if e.errno == errno.ENOENT:
970
raise errors.BzrCommandError('Parent of "%s" does not exist.'
974
source.create_checkout(to_location, revision_id, lightweight)
977
class cmd_renames(Command):
978
"""Show list of renamed files.
980
# TODO: Option to show renames between two historical versions.
982
# TODO: Only show renames under dir, rather than in the whole branch.
983
_see_also = ['status']
984
takes_args = ['dir?']
987
def run(self, dir=u'.'):
988
tree = WorkingTree.open_containing(dir)[0]
991
new_inv = tree.inventory
992
old_tree = tree.basis_tree()
995
old_inv = old_tree.inventory
996
renames = list(_mod_tree.find_renames(old_inv, new_inv))
998
for old_name, new_name in renames:
999
self.outf.write("%s => %s\n" % (old_name, new_name))
1006
class cmd_update(Command):
1007
"""Update a tree to have the latest code committed to its branch.
1009
This will perform a merge into the working tree, and may generate
1010
conflicts. If you have any local changes, you will still
1011
need to commit them after the update for the update to be complete.
1013
If you want to discard your local changes, you can just do a
1014
'bzr revert' instead of 'bzr commit' after the update.
1017
_see_also = ['pull', 'working-trees']
1018
takes_args = ['dir?']
1021
def run(self, dir='.'):
1022
tree = WorkingTree.open_containing(dir)[0]
1023
master = tree.branch.get_master_branch()
1024
if master is not None:
1027
tree.lock_tree_write()
1029
existing_pending_merges = tree.get_parent_ids()[1:]
1030
last_rev = tree.last_revision()
1031
if last_rev == tree.branch.last_revision():
1032
# may be up to date, check master too.
1033
master = tree.branch.get_master_branch()
1034
if master is None or last_rev == master.last_revision():
1035
revno = tree.branch.revision_id_to_revno(last_rev)
1036
note("Tree is up to date at revision %d." % (revno,))
1038
conflicts = tree.update()
1039
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1040
note('Updated to revision %d.' % (revno,))
1041
if tree.get_parent_ids()[1:] != existing_pending_merges:
1042
note('Your local commits will now show as pending merges with '
1043
"'bzr status', and can be committed with 'bzr commit'.")
1052
class cmd_info(Command):
1053
"""Show information about a working tree, branch or repository.
1055
This command will show all known locations and formats associated to the
1056
tree, branch or repository. Statistical information is included with
1059
Branches and working trees will also report any missing revisions.
1061
_see_also = ['revno', 'working-trees', 'repositories']
1062
takes_args = ['location?']
1063
takes_options = ['verbose']
1066
def run(self, location=None, verbose=0):
1067
from bzrlib.info import show_bzrdir_info
1068
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1072
class cmd_remove(Command):
1073
"""Remove files or directories.
1075
This makes bzr stop tracking changes to the specified files and
1076
delete them if they can easily be recovered using revert.
1078
You can specify one or more files, and/or --new. If you specify --new,
1079
only 'added' files will be removed. If you specify both, then new files
1080
in the specified directories will be removed. If the directories are
1081
also new, they will also be removed.
1083
takes_args = ['file*']
1084
takes_options = ['verbose',
1085
Option('new', help='remove newly-added files'),
1086
RegistryOption.from_kwargs('file-deletion-strategy',
1087
'The file deletion mode to be used',
1088
title='Deletion Strategy', value_switches=True, enum_switch=False,
1089
safe='Only delete files if they can be'
1090
' safely recovered (default).',
1091
keep="Don't delete any files.",
1092
force='Delete all the specified files, even if they can not be '
1093
'recovered and even if they are non-empty directories.')]
1095
encoding_type = 'replace'
1097
def run(self, file_list, verbose=False, new=False,
1098
file_deletion_strategy='safe'):
1099
tree, file_list = tree_files(file_list)
1101
if file_list is not None:
1102
file_list = [f for f in file_list if f != '']
1104
raise errors.BzrCommandError('Specify one or more files to'
1105
' remove, or use --new.')
1108
added = tree.changes_from(tree.basis_tree(),
1109
specific_files=file_list).added
1110
file_list = sorted([f[0] for f in added], reverse=True)
1111
if len(file_list) == 0:
1112
raise errors.BzrCommandError('No matching files.')
1113
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1114
keep_files=file_deletion_strategy=='keep',
1115
force=file_deletion_strategy=='force')
1118
class cmd_file_id(Command):
1119
"""Print file_id of a particular file or directory.
1121
The file_id is assigned when the file is first added and remains the
1122
same through all revisions where the file exists, even when it is
1127
_see_also = ['inventory', 'ls']
1128
takes_args = ['filename']
1131
def run(self, filename):
1132
tree, relpath = WorkingTree.open_containing(filename)
1133
i = tree.path2id(relpath)
1135
raise errors.NotVersionedError(filename)
1137
self.outf.write(i + '\n')
1140
class cmd_file_path(Command):
1141
"""Print path of file_ids to a file or directory.
1143
This prints one line for each directory down to the target,
1144
starting at the branch root.
1148
takes_args = ['filename']
1151
def run(self, filename):
1152
tree, relpath = WorkingTree.open_containing(filename)
1153
fid = tree.path2id(relpath)
1155
raise errors.NotVersionedError(filename)
1156
segments = osutils.splitpath(relpath)
1157
for pos in range(1, len(segments) + 1):
1158
path = osutils.joinpath(segments[:pos])
1159
self.outf.write("%s\n" % tree.path2id(path))
1162
class cmd_reconcile(Command):
1163
"""Reconcile bzr metadata in a branch.
1165
This can correct data mismatches that may have been caused by
1166
previous ghost operations or bzr upgrades. You should only
1167
need to run this command if 'bzr check' or a bzr developer
1168
advises you to run it.
1170
If a second branch is provided, cross-branch reconciliation is
1171
also attempted, which will check that data like the tree root
1172
id which was not present in very early bzr versions is represented
1173
correctly in both branches.
1175
At the same time it is run it may recompress data resulting in
1176
a potential saving in disk space or performance gain.
1178
The branch *MUST* be on a listable system such as local disk or sftp.
1181
_see_also = ['check']
1182
takes_args = ['branch?']
1184
def run(self, branch="."):
1185
from bzrlib.reconcile import reconcile
1186
dir = bzrdir.BzrDir.open(branch)
1190
class cmd_revision_history(Command):
1191
"""Display the list of revision ids on a branch."""
1194
takes_args = ['location?']
1199
def run(self, location="."):
1200
branch = Branch.open_containing(location)[0]
1201
for revid in branch.revision_history():
1202
self.outf.write(revid)
1203
self.outf.write('\n')
1206
class cmd_ancestry(Command):
1207
"""List all revisions merged into this branch."""
1209
_see_also = ['log', 'revision-history']
1210
takes_args = ['location?']
1215
def run(self, location="."):
1217
wt = WorkingTree.open_containing(location)[0]
1218
except errors.NoWorkingTree:
1219
b = Branch.open(location)
1220
last_revision = b.last_revision()
1223
last_revision = wt.last_revision()
1225
revision_ids = b.repository.get_ancestry(last_revision)
1226
assert revision_ids[0] is None
1228
for revision_id in revision_ids:
1229
self.outf.write(revision_id + '\n')
1232
class cmd_init(Command):
1233
"""Make a directory into a versioned branch.
1235
Use this to create an empty branch, or before importing an
1238
If there is a repository in a parent directory of the location, then
1239
the history of the branch will be stored in the repository. Otherwise
1240
init creates a standalone branch which carries its own history
1241
in the .bzr directory.
1243
If there is already a branch at the location but it has no working tree,
1244
the tree can be populated with 'bzr checkout'.
1246
Recipe for importing a tree of files:
1251
bzr commit -m 'imported project'
1254
_see_also = ['init-repo', 'branch', 'checkout']
1255
takes_args = ['location?']
1257
Option('create-prefix',
1258
help='Create the path leading up to the branch '
1259
'if it does not already exist'),
1260
RegistryOption('format',
1261
help='Specify a format for this branch. '
1262
'See "help formats".',
1263
registry=bzrdir.format_registry,
1264
converter=bzrdir.format_registry.make_bzrdir,
1265
value_switches=True,
1266
title="Branch Format",
1268
Option('append-revisions-only',
1269
help='Never change revnos or the existing log.'
1270
' Append revisions to it only.')
1272
def run(self, location=None, format=None, append_revisions_only=False,
1273
create_prefix=False):
1275
format = bzrdir.format_registry.make_bzrdir('default')
1276
if location is None:
1279
to_transport = transport.get_transport(location)
1281
# The path has to exist to initialize a
1282
# branch inside of it.
1283
# Just using os.mkdir, since I don't
1284
# believe that we want to create a bunch of
1285
# locations if the user supplies an extended path
1287
to_transport.ensure_base()
1288
except errors.NoSuchFile:
1289
if not create_prefix:
1290
raise errors.BzrCommandError("Parent directory of %s"
1292
"\nYou may supply --create-prefix to create all"
1293
" leading parent directories."
1295
_create_prefix(to_transport)
1298
existing_bzrdir = bzrdir.BzrDir.open(location)
1299
except errors.NotBranchError:
1300
# really a NotBzrDir error...
1301
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1304
from bzrlib.transport.local import LocalTransport
1305
if existing_bzrdir.has_branch():
1306
if (isinstance(to_transport, LocalTransport)
1307
and not existing_bzrdir.has_workingtree()):
1308
raise errors.BranchExistsWithoutWorkingTree(location)
1309
raise errors.AlreadyBranchError(location)
1311
branch = existing_bzrdir.create_branch()
1312
existing_bzrdir.create_workingtree()
1313
if append_revisions_only:
1315
branch.set_append_revisions_only(True)
1316
except errors.UpgradeRequired:
1317
raise errors.BzrCommandError('This branch format cannot be set'
1318
' to append-revisions-only. Try --experimental-branch6')
1321
class cmd_init_repository(Command):
1322
"""Create a shared repository to hold branches.
1324
New branches created under the repository directory will store their
1325
revisions in the repository, not in the branch directory.
1327
If the --no-trees option is used then the branches in the repository
1328
will not have working trees by default.
1331
bzr init-repo --no-trees repo
1333
bzr checkout --lightweight repo/trunk trunk-checkout
1337
See 'bzr help repositories' for more information.
1340
_see_also = ['init', 'branch', 'checkout']
1341
takes_args = ["location"]
1342
takes_options = [RegistryOption('format',
1343
help='Specify a format for this repository. See'
1344
' "bzr help formats" for details',
1345
registry=bzrdir.format_registry,
1346
converter=bzrdir.format_registry.make_bzrdir,
1347
value_switches=True, title='Repository format'),
1349
help='Branches in the repository will default to'
1350
' not having a working tree'),
1352
aliases = ["init-repo"]
1354
def run(self, location, format=None, no_trees=False):
1356
format = bzrdir.format_registry.make_bzrdir('default')
1358
if location is None:
1361
to_transport = transport.get_transport(location)
1362
to_transport.ensure_base()
1364
newdir = format.initialize_on_transport(to_transport)
1365
repo = newdir.create_repository(shared=True)
1366
repo.set_make_working_trees(not no_trees)
1369
class cmd_diff(Command):
1370
"""Show differences in the working tree or between revisions.
1372
If files are listed, only the changes in those files are listed.
1373
Otherwise, all changes for the tree are listed.
1375
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1376
produces patches suitable for "patch -p1".
1380
Shows the difference in the working tree versus the last commit
1382
Difference between the working tree and revision 1
1384
Difference between revision 2 and revision 1
1385
bzr diff --prefix old/:new/
1386
Same as 'bzr diff' but prefix paths with old/ and new/
1387
bzr diff bzr.mine bzr.dev
1388
Show the differences between the two working trees
1390
Show just the differences for 'foo.c'
1392
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1393
# or a graphical diff.
1395
# TODO: Python difflib is not exactly the same as unidiff; should
1396
# either fix it up or prefer to use an external diff.
1398
# TODO: Selected-file diff is inefficient and doesn't show you
1401
# TODO: This probably handles non-Unix newlines poorly.
1403
_see_also = ['status']
1404
takes_args = ['file*']
1405
takes_options = ['revision', 'diff-options',
1406
Option('prefix', type=str,
1408
help='Set prefixes to added to old and new filenames, as '
1409
'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?']
1600
takes_options = [Option('forward',
1601
help='show from oldest to newest'),
1605
help='show files changed in each revision'),
1606
'show-ids', 'revision',
1610
help='show revisions whose message matches this regexp',
1613
help='limit the output to the first N revisions',
1616
encoding_type = 'replace'
1619
def run(self, location=None, timezone='original',
1627
from bzrlib.log import show_log
1628
assert message is None or isinstance(message, basestring), \
1629
"invalid message argument %r" % message
1630
direction = (forward and 'forward') or 'reverse'
1635
# find the file id to log:
1637
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1641
tree = b.basis_tree()
1642
file_id = tree.path2id(fp)
1644
raise errors.BzrCommandError(
1645
"Path does not have any revision history: %s" %
1649
# FIXME ? log the current subdir only RBC 20060203
1650
if revision is not None \
1651
and len(revision) > 0 and revision[0].get_branch():
1652
location = revision[0].get_branch()
1655
dir, relpath = bzrdir.BzrDir.open_containing(location)
1656
b = dir.open_branch()
1660
if revision is None:
1663
elif len(revision) == 1:
1664
rev1 = rev2 = revision[0].in_history(b).revno
1665
elif len(revision) == 2:
1666
if revision[1].get_branch() != revision[0].get_branch():
1667
# b is taken from revision[0].get_branch(), and
1668
# show_log will use its revision_history. Having
1669
# different branches will lead to weird behaviors.
1670
raise errors.BzrCommandError(
1671
"Log doesn't accept two revisions in different"
1673
if revision[0].spec is None:
1674
# missing begin-range means first revision
1677
rev1 = revision[0].in_history(b).revno
1679
if revision[1].spec is None:
1680
# missing end-range means last known revision
1683
rev2 = revision[1].in_history(b).revno
1685
raise errors.BzrCommandError(
1686
'bzr log --revision takes one or two values.')
1688
# By this point, the revision numbers are converted to the +ve
1689
# form if they were supplied in the -ve form, so we can do
1690
# this comparison in relative safety
1692
(rev2, rev1) = (rev1, rev2)
1694
if log_format is None:
1695
log_format = log.log_formatter_registry.get_default(b)
1697
lf = log_format(show_ids=show_ids, to_file=self.outf,
1698
show_timezone=timezone)
1704
direction=direction,
1705
start_revision=rev1,
1713
def get_log_format(long=False, short=False, line=False, default='long'):
1714
log_format = default
1718
log_format = 'short'
1724
class cmd_touching_revisions(Command):
1725
"""Return revision-ids which affected a particular file.
1727
A more user-friendly interface is "bzr log FILE".
1731
takes_args = ["filename"]
1734
def run(self, filename):
1735
tree, relpath = WorkingTree.open_containing(filename)
1737
file_id = tree.path2id(relpath)
1738
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1739
self.outf.write("%6d %s\n" % (revno, what))
1742
class cmd_ls(Command):
1743
"""List files in a tree.
1746
_see_also = ['status', 'cat']
1747
takes_args = ['path?']
1748
# TODO: Take a revision or remote path and list that tree instead.
1749
takes_options = ['verbose', 'revision',
1750
Option('non-recursive',
1751
help='don\'t recurse into sub-directories'),
1753
help='Print all paths from the root of the branch.'),
1754
Option('unknown', help='Print unknown files'),
1755
Option('versioned', help='Print versioned files'),
1756
Option('ignored', help='Print ignored files'),
1758
Option('null', help='Null separate the files'),
1762
def run(self, revision=None, verbose=False,
1763
non_recursive=False, from_root=False,
1764
unknown=False, versioned=False, ignored=False,
1765
null=False, kind=None, show_ids=False, path=None):
1767
if kind and kind not in ('file', 'directory', 'symlink'):
1768
raise errors.BzrCommandError('invalid kind specified')
1770
if verbose and null:
1771
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1772
all = not (unknown or versioned or ignored)
1774
selection = {'I':ignored, '?':unknown, 'V':versioned}
1781
raise errors.BzrCommandError('cannot specify both --from-root'
1785
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1791
if revision is not None:
1792
tree = branch.repository.revision_tree(
1793
revision[0].in_history(branch).rev_id)
1795
tree = branch.basis_tree()
1799
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1800
if fp.startswith(relpath):
1801
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1802
if non_recursive and '/' in fp:
1804
if not all and not selection[fc]:
1806
if kind is not None and fkind != kind:
1809
kindch = entry.kind_character()
1810
outstring = '%-8s %s%s' % (fc, fp, kindch)
1811
if show_ids and fid is not None:
1812
outstring = "%-50s %s" % (outstring, fid)
1813
self.outf.write(outstring + '\n')
1815
self.outf.write(fp + '\0')
1818
self.outf.write(fid)
1819
self.outf.write('\0')
1827
self.outf.write('%-50s %s\n' % (fp, my_id))
1829
self.outf.write(fp + '\n')
1834
class cmd_unknowns(Command):
1835
"""List unknown files.
1843
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1844
self.outf.write(osutils.quotefn(f) + '\n')
1847
class cmd_ignore(Command):
1848
"""Ignore specified files or patterns.
1850
To remove patterns from the ignore list, edit the .bzrignore file.
1852
Trailing slashes on patterns are ignored.
1853
If the pattern contains a slash or is a regular expression, it is compared
1854
to the whole path from the branch root. Otherwise, it is compared to only
1855
the last component of the path. To match a file only in the root
1856
directory, prepend './'.
1858
Ignore patterns specifying absolute paths are not allowed.
1860
Ignore patterns may include globbing wildcards such as:
1861
? - Matches any single character except '/'
1862
* - Matches 0 or more characters except '/'
1863
/**/ - Matches 0 or more directories in a path
1864
[a-z] - Matches a single character from within a group of characters
1866
Ignore patterns may also be Python regular expressions.
1867
Regular expression ignore patterns are identified by a 'RE:' prefix
1868
followed by the regular expression. Regular expression ignore patterns
1869
may not include named or numbered groups.
1871
Note: ignore patterns containing shell wildcards must be quoted from
1875
bzr ignore ./Makefile
1876
bzr ignore '*.class'
1877
bzr ignore 'lib/**/*.o'
1878
bzr ignore 'RE:lib/.*\.o'
1881
_see_also = ['status', 'ignored']
1882
takes_args = ['name_pattern*']
1884
Option('old-default-rules',
1885
help='Out the ignore rules bzr < 0.9 always used.')
1888
def run(self, name_pattern_list=None, old_default_rules=None):
1889
from bzrlib.atomicfile import AtomicFile
1890
if old_default_rules is not None:
1891
# dump the rules and exit
1892
for pattern in ignores.OLD_DEFAULTS:
1895
if not name_pattern_list:
1896
raise errors.BzrCommandError("ignore requires at least one "
1897
"NAME_PATTERN or --old-default-rules")
1898
name_pattern_list = [globbing.normalize_pattern(p)
1899
for p in name_pattern_list]
1900
for name_pattern in name_pattern_list:
1901
if (name_pattern[0] == '/' or
1902
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1903
raise errors.BzrCommandError(
1904
"NAME_PATTERN should not be an absolute path")
1905
tree, relpath = WorkingTree.open_containing(u'.')
1906
ifn = tree.abspath('.bzrignore')
1907
if os.path.exists(ifn):
1910
igns = f.read().decode('utf-8')
1916
# TODO: If the file already uses crlf-style termination, maybe
1917
# we should use that for the newly added lines?
1919
if igns and igns[-1] != '\n':
1921
for name_pattern in name_pattern_list:
1922
igns += name_pattern + '\n'
1924
f = AtomicFile(ifn, 'wb')
1926
f.write(igns.encode('utf-8'))
1931
if not tree.path2id('.bzrignore'):
1932
tree.add(['.bzrignore'])
1935
class cmd_ignored(Command):
1936
"""List ignored files and the patterns that matched them.
1939
_see_also = ['ignore']
1942
tree = WorkingTree.open_containing(u'.')[0]
1945
for path, file_class, kind, file_id, entry in tree.list_files():
1946
if file_class != 'I':
1948
## XXX: Slightly inefficient since this was already calculated
1949
pat = tree.is_ignored(path)
1950
print '%-50s %s' % (path, pat)
1955
class cmd_lookup_revision(Command):
1956
"""Lookup the revision-id from a revision-number
1959
bzr lookup-revision 33
1962
takes_args = ['revno']
1965
def run(self, revno):
1969
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1971
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1974
class cmd_export(Command):
1975
"""Export current or past revision to a destination directory or archive.
1977
If no revision is specified this exports the last committed revision.
1979
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1980
given, try to find the format with the extension. If no extension
1981
is found exports to a directory (equivalent to --format=dir).
1983
If root is supplied, it will be used as the root directory inside
1984
container formats (tar, zip, etc). If it is not supplied it will default
1985
to the exported filename. The root option has no effect for 'dir' format.
1987
If branch is omitted then the branch containing the current working
1988
directory will be used.
1990
Note: Export of tree with non-ASCII filenames to zip is not supported.
1992
Supported formats Autodetected by extension
1993
----------------- -------------------------
1996
tbz2 .tar.bz2, .tbz2
2000
takes_args = ['dest', 'branch?']
2001
takes_options = ['revision', 'format', 'root']
2002
def run(self, dest, branch=None, revision=None, format=None, root=None):
2003
from bzrlib.export import export
2006
tree = WorkingTree.open_containing(u'.')[0]
2009
b = Branch.open(branch)
2011
if revision is None:
2012
# should be tree.last_revision FIXME
2013
rev_id = b.last_revision()
2015
if len(revision) != 1:
2016
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2017
rev_id = revision[0].in_history(b).rev_id
2018
t = b.repository.revision_tree(rev_id)
2020
export(t, dest, format, root)
2021
except errors.NoSuchExportFormat, e:
2022
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2025
class cmd_cat(Command):
2026
"""Write the contents of a file as of a given revision to standard output.
2028
If no revision is nominated, the last revision is used.
2030
Note: Take care to redirect standard output when using this command on a
2035
takes_options = ['revision', 'name-from-revision']
2036
takes_args = ['filename']
2037
encoding_type = 'exact'
2040
def run(self, filename, revision=None, name_from_revision=False):
2041
if revision is not None and len(revision) != 1:
2042
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2047
tree, b, relpath = \
2048
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2049
except errors.NotBranchError:
2052
if revision is not None and revision[0].get_branch() is not None:
2053
b = Branch.open(revision[0].get_branch())
2055
tree = b.basis_tree()
2056
if revision is None:
2057
revision_id = b.last_revision()
2059
revision_id = revision[0].in_history(b).rev_id
2061
cur_file_id = tree.path2id(relpath)
2062
rev_tree = b.repository.revision_tree(revision_id)
2063
old_file_id = rev_tree.path2id(relpath)
2065
if name_from_revision:
2066
if old_file_id is None:
2067
raise errors.BzrCommandError("%r is not present in revision %s"
2068
% (filename, revision_id))
2070
rev_tree.print_file(old_file_id)
2071
elif cur_file_id is not None:
2072
rev_tree.print_file(cur_file_id)
2073
elif old_file_id is not None:
2074
rev_tree.print_file(old_file_id)
2076
raise errors.BzrCommandError("%r is not present in revision %s" %
2077
(filename, revision_id))
2080
class cmd_local_time_offset(Command):
2081
"""Show the offset in seconds from GMT to local time."""
2085
print osutils.local_time_offset()
2089
class cmd_commit(Command):
2090
"""Commit changes into a new revision.
2092
If no arguments are given, the entire tree is committed.
2094
If selected files are specified, only changes to those files are
2095
committed. If a directory is specified then the directory and everything
2096
within it is committed.
2098
A selected-file commit may fail in some cases where the committed
2099
tree would be invalid. Consider::
2104
bzr commit foo -m "committing foo"
2105
bzr mv foo/bar foo/baz
2108
bzr commit foo/bar -m "committing bar but not baz"
2110
In the example above, the last commit will fail by design. This gives
2111
the user the opportunity to decide whether they want to commit the
2112
rename at the same time, separately first, or not at all. (As a general
2113
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2115
Note: A selected-file commit after a merge is not yet supported.
2117
# TODO: Run hooks on tree to-be-committed, and after commit.
2119
# TODO: Strict commit that fails if there are deleted files.
2120
# (what does "deleted files" mean ??)
2122
# TODO: Give better message for -s, --summary, used by tla people
2124
# XXX: verbose currently does nothing
2126
_see_also = ['bugs', 'uncommit']
2127
takes_args = ['selected*']
2128
takes_options = ['message', 'verbose',
2130
help='commit even if nothing has changed'),
2131
Option('file', type=str,
2134
help='file containing commit message'),
2136
help="refuse to commit if there are unknown "
2137
"files in the working tree."),
2138
ListOption('fixes', type=str,
2139
help="mark a bug as being fixed by this "
2142
help="perform a local only commit in a bound "
2143
"branch. Such commits are not pushed to "
2144
"the master branch until a normal commit "
2148
aliases = ['ci', 'checkin']
2150
def _get_bug_fix_properties(self, fixes, branch):
2152
# Configure the properties for bug fixing attributes.
2153
for fixed_bug in fixes:
2154
tokens = fixed_bug.split(':')
2155
if len(tokens) != 2:
2156
raise errors.BzrCommandError(
2157
"Invalid bug %s. Must be in the form of 'tag:id'. "
2158
"Commit refused." % fixed_bug)
2159
tag, bug_id = tokens
2161
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2162
except errors.UnknownBugTrackerAbbreviation:
2163
raise errors.BzrCommandError(
2164
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2165
except errors.MalformedBugIdentifier:
2166
raise errors.BzrCommandError(
2167
"Invalid bug identifier for %s. Commit refused."
2169
properties.append('%s fixed' % bug_url)
2170
return '\n'.join(properties)
2172
def run(self, message=None, file=None, verbose=True, selected_list=None,
2173
unchanged=False, strict=False, local=False, fixes=None):
2174
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2175
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2177
from bzrlib.msgeditor import edit_commit_message, \
2178
make_commit_message_template
2180
# TODO: Need a blackbox test for invoking the external editor; may be
2181
# slightly problematic to run this cross-platform.
2183
# TODO: do more checks that the commit will succeed before
2184
# spending the user's valuable time typing a commit message.
2188
tree, selected_list = tree_files(selected_list)
2189
if selected_list == ['']:
2190
# workaround - commit of root of tree should be exactly the same
2191
# as just default commit in that tree, and succeed even though
2192
# selected-file merge commit is not done yet
2195
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2197
properties['bugs'] = bug_property
2199
if local and not tree.branch.get_bound_location():
2200
raise errors.LocalRequiresBoundBranch()
2202
def get_message(commit_obj):
2203
"""Callback to get commit message"""
2204
my_message = message
2205
if my_message is None and not file:
2206
template = make_commit_message_template(tree, selected_list)
2207
my_message = edit_commit_message(template)
2208
if my_message is None:
2209
raise errors.BzrCommandError("please specify a commit"
2210
" message with either --message or --file")
2211
elif my_message and file:
2212
raise errors.BzrCommandError(
2213
"please specify either --message or --file")
2215
my_message = codecs.open(file, 'rt',
2216
bzrlib.user_encoding).read()
2217
if my_message == "":
2218
raise errors.BzrCommandError("empty commit message specified")
2222
reporter = ReportCommitToLog()
2224
reporter = NullCommitReporter()
2227
tree.commit(message_callback=get_message,
2228
specific_files=selected_list,
2229
allow_pointless=unchanged, strict=strict, local=local,
2230
reporter=reporter, revprops=properties)
2231
except PointlessCommit:
2232
# FIXME: This should really happen before the file is read in;
2233
# perhaps prepare the commit; get the message; then actually commit
2234
raise errors.BzrCommandError("no changes to commit."
2235
" use --unchanged to commit anyhow")
2236
except ConflictsInTree:
2237
raise errors.BzrCommandError('Conflicts detected in working '
2238
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2240
except StrictCommitFailed:
2241
raise errors.BzrCommandError("Commit refused because there are"
2242
" unknown files in the working tree.")
2243
except errors.BoundBranchOutOfDate, e:
2244
raise errors.BzrCommandError(str(e) + "\n"
2245
'To commit to master branch, run update and then commit.\n'
2246
'You can also pass --local to commit to continue working '
2250
class cmd_check(Command):
2251
"""Validate consistency of branch history.
2253
This command checks various invariants about the branch storage to
2254
detect data corruption or bzr bugs.
2257
_see_also = ['reconcile']
2258
takes_args = ['branch?']
2259
takes_options = ['verbose']
2261
def run(self, branch=None, verbose=False):
2262
from bzrlib.check import check
2264
tree = WorkingTree.open_containing()[0]
2265
branch = tree.branch
2267
branch = Branch.open(branch)
2268
check(branch, verbose)
2271
class cmd_upgrade(Command):
2272
"""Upgrade branch storage to current format.
2274
The check command or bzr developers may sometimes advise you to run
2275
this command. When the default format has changed you may also be warned
2276
during other operations to upgrade.
2279
_see_also = ['check']
2280
takes_args = ['url?']
2282
RegistryOption('format',
2283
help='Upgrade to a specific format. See "bzr help'
2284
' formats" for details',
2285
registry=bzrdir.format_registry,
2286
converter=bzrdir.format_registry.make_bzrdir,
2287
value_switches=True, title='Branch format'),
2290
def run(self, url='.', format=None):
2291
from bzrlib.upgrade import upgrade
2293
format = bzrdir.format_registry.make_bzrdir('default')
2294
upgrade(url, format)
2297
class cmd_whoami(Command):
2298
"""Show or set bzr user id.
2302
bzr whoami 'Frank Chu <fchu@example.com>'
2304
takes_options = [ Option('email',
2305
help='display email address only'),
2307
help='set identity for the current branch instead of '
2310
takes_args = ['name?']
2311
encoding_type = 'replace'
2314
def run(self, email=False, branch=False, name=None):
2316
# use branch if we're inside one; otherwise global config
2318
c = Branch.open_containing('.')[0].get_config()
2319
except errors.NotBranchError:
2320
c = config.GlobalConfig()
2322
self.outf.write(c.user_email() + '\n')
2324
self.outf.write(c.username() + '\n')
2327
# display a warning if an email address isn't included in the given name.
2329
config.extract_email_address(name)
2330
except errors.NoEmailInUsername, e:
2331
warning('"%s" does not seem to contain an email address. '
2332
'This is allowed, but not recommended.', name)
2334
# use global config unless --branch given
2336
c = Branch.open_containing('.')[0].get_config()
2338
c = config.GlobalConfig()
2339
c.set_user_option('email', name)
2342
class cmd_nick(Command):
2343
"""Print or set the branch nickname.
2345
If unset, the tree root directory name is used as the nickname
2346
To print the current nickname, execute with no argument.
2349
_see_also = ['info']
2350
takes_args = ['nickname?']
2351
def run(self, nickname=None):
2352
branch = Branch.open_containing(u'.')[0]
2353
if nickname is None:
2354
self.printme(branch)
2356
branch.nick = nickname
2359
def printme(self, branch):
2363
class cmd_selftest(Command):
2364
"""Run internal test suite.
2366
If arguments are given, they are regular expressions that say which tests
2367
should run. Tests matching any expression are run, and other tests are
2370
Alternatively if --first is given, matching tests are run first and then
2371
all other tests are run. This is useful if you have been working in a
2372
particular area, but want to make sure nothing else was broken.
2374
If --exclude is given, tests that match that regular expression are
2375
excluded, regardless of whether they match --first or not.
2377
To help catch accidential dependencies between tests, the --randomize
2378
option is useful. In most cases, the argument used is the word 'now'.
2379
Note that the seed used for the random number generator is displayed
2380
when this option is used. The seed can be explicitly passed as the
2381
argument to this option if required. This enables reproduction of the
2382
actual ordering used if and when an order sensitive problem is encountered.
2384
If --list-only is given, the tests that would be run are listed. This is
2385
useful when combined with --first, --exclude and/or --randomize to
2386
understand their impact. The test harness reports "Listed nn tests in ..."
2387
instead of "Ran nn tests in ..." when list mode is enabled.
2389
If the global option '--no-plugins' is given, plugins are not loaded
2390
before running the selftests. This has two effects: features provided or
2391
modified by plugins will not be tested, and tests provided by plugins will
2396
run only tests relating to 'ignore'
2397
bzr --no-plugins selftest -v
2398
disable plugins and list tests as they're run
2400
For each test, that needs actual disk access, bzr create their own
2401
subdirectory in the temporary testing directory (testXXXX.tmp).
2402
By default the name of such subdirectory is based on the name of the test.
2403
If option '--numbered-dirs' is given, bzr will use sequent numbers
2404
of running tests to create such subdirectories. This is default behavior
2405
on Windows because of path length limitation.
2407
# NB: this is used from the class without creating an instance, which is
2408
# why it does not have a self parameter.
2409
def get_transport_type(typestring):
2410
"""Parse and return a transport specifier."""
2411
if typestring == "sftp":
2412
from bzrlib.transport.sftp import SFTPAbsoluteServer
2413
return SFTPAbsoluteServer
2414
if typestring == "memory":
2415
from bzrlib.transport.memory import MemoryServer
2417
if typestring == "fakenfs":
2418
from bzrlib.transport.fakenfs import FakeNFSServer
2419
return FakeNFSServer
2420
msg = "No known transport type %s. Supported types are: sftp\n" %\
2422
raise errors.BzrCommandError(msg)
2425
takes_args = ['testspecs*']
2426
takes_options = ['verbose',
2428
help='stop when one test fails',
2431
Option('keep-output',
2432
help='keep output directories when tests fail'),
2434
help='Use a different transport by default '
2435
'throughout the test suite.',
2436
type=get_transport_type),
2437
Option('benchmark', help='run the bzr benchmarks.'),
2438
Option('lsprof-timed',
2439
help='generate lsprof output for benchmarked'
2440
' sections of code.'),
2441
Option('cache-dir', type=str,
2442
help='a directory to cache intermediate'
2443
' benchmark steps'),
2444
Option('clean-output',
2445
help='clean temporary tests directories'
2446
' without running tests'),
2448
help='run all tests, but run specified tests first',
2451
Option('numbered-dirs',
2452
help='use numbered dirs for TestCaseInTempDir'),
2454
help='list the tests instead of running them'),
2455
Option('randomize', type=str, argname="SEED",
2456
help='randomize the order of tests using the given'
2457
' seed or "now" for the current time'),
2458
Option('exclude', type=str, argname="PATTERN",
2460
help='exclude tests that match this regular'
2463
encoding_type = 'replace'
2465
def run(self, testspecs_list=None, verbose=None, one=False,
2466
keep_output=False, transport=None, benchmark=None,
2467
lsprof_timed=None, cache_dir=None, clean_output=False,
2468
first=False, numbered_dirs=None, list_only=False,
2469
randomize=None, exclude=None):
2471
from bzrlib.tests import selftest
2472
import bzrlib.benchmarks as benchmarks
2473
from bzrlib.benchmarks import tree_creator
2476
from bzrlib.tests import clean_selftest_output
2477
clean_selftest_output()
2480
warning("notice: selftest --keep-output "
2481
"is no longer supported; "
2482
"test output is always removed")
2484
if numbered_dirs is None and sys.platform == 'win32':
2485
numbered_dirs = True
2487
if cache_dir is not None:
2488
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2489
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2490
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2492
if testspecs_list is not None:
2493
pattern = '|'.join(testspecs_list)
2497
test_suite_factory = benchmarks.test_suite
2500
# TODO: should possibly lock the history file...
2501
benchfile = open(".perf_history", "at", buffering=1)
2503
test_suite_factory = None
2508
result = selftest(verbose=verbose,
2510
stop_on_failure=one,
2511
transport=transport,
2512
test_suite_factory=test_suite_factory,
2513
lsprof_timed=lsprof_timed,
2514
bench_history=benchfile,
2515
matching_tests_first=first,
2516
numbered_dirs=numbered_dirs,
2517
list_only=list_only,
2518
random_seed=randomize,
2519
exclude_pattern=exclude
2522
if benchfile is not None:
2525
info('tests passed')
2527
info('tests failed')
2528
return int(not result)
2531
class cmd_version(Command):
2532
"""Show version of bzr."""
2536
from bzrlib.version import show_version
2540
class cmd_rocks(Command):
2541
"""Statement of optimism."""
2547
print "It sure does!"
2550
class cmd_find_merge_base(Command):
2551
"""Find and print a base revision for merging two branches."""
2552
# TODO: Options to specify revisions on either side, as if
2553
# merging only part of the history.
2554
takes_args = ['branch', 'other']
2558
def run(self, branch, other):
2559
from bzrlib.revision import ensure_null, MultipleRevisionSources
2561
branch1 = Branch.open_containing(branch)[0]
2562
branch2 = Branch.open_containing(other)[0]
2564
last1 = ensure_null(branch1.last_revision())
2565
last2 = ensure_null(branch2.last_revision())
2567
graph = branch1.repository.get_graph(branch2.repository)
2568
base_rev_id = graph.find_unique_lca(last1, last2)
2570
print 'merge base is revision %s' % base_rev_id
2573
class cmd_merge(Command):
2574
"""Perform a three-way merge.
2576
The branch is the branch you will merge from. By default, it will merge
2577
the latest revision. If you specify a revision, that revision will be
2578
merged. If you specify two revisions, the first will be used as a BASE,
2579
and the second one as OTHER. Revision numbers are always relative to the
2582
By default, bzr will try to merge in all new work from the other
2583
branch, automatically determining an appropriate base. If this
2584
fails, you may need to give an explicit base.
2586
Merge will do its best to combine the changes in two branches, but there
2587
are some kinds of problems only a human can fix. When it encounters those,
2588
it will mark a conflict. A conflict means that you need to fix something,
2589
before you should commit.
2591
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2593
If there is no default branch set, the first merge will set it. After
2594
that, you can omit the branch to use the default. To change the
2595
default, use --remember. The value will only be saved if the remote
2596
location can be accessed.
2598
The results of the merge are placed into the destination working
2599
directory, where they can be reviewed (with bzr diff), tested, and then
2600
committed to record the result of the merge.
2604
To merge the latest revision from bzr.dev:
2605
bzr merge ../bzr.dev
2607
To merge changes up to and including revision 82 from bzr.dev:
2608
bzr merge -r 82 ../bzr.dev
2610
To merge the changes introduced by 82, without previous changes:
2611
bzr merge -r 81..82 ../bzr.dev
2613
merge refuses to run if there are any uncommitted changes, unless
2617
_see_also = ['update', 'remerge']
2618
takes_args = ['branch?']
2619
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2620
Option('show-base', help="Show base revision text in "
2622
Option('uncommitted', help='Apply uncommitted changes'
2623
' from a working copy, instead of branch changes'),
2624
Option('pull', help='If the destination is already'
2625
' completely merged into the source, pull from the'
2626
' source rather than merging. When this happens,'
2627
' you do not need to commit the result.'),
2629
help='Branch to merge into, '
2630
'rather than the one containing the working directory',
2636
def run(self, branch=None, revision=None, force=False, merge_type=None,
2637
show_base=False, reprocess=False, remember=False,
2638
uncommitted=False, pull=False,
2641
from bzrlib.tag import _merge_tags_if_possible
2642
other_revision_id = None
2643
if merge_type is None:
2644
merge_type = _mod_merge.Merge3Merger
2646
if directory is None: directory = u'.'
2647
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2648
# inventory. Because merge is a mutating operation, it really
2649
# should be a lock_write() for the whole cmd_merge operation.
2650
# However, cmd_merge open's its own tree in _merge_helper, which
2651
# means if we lock here, the later lock_write() will always block.
2652
# Either the merge helper code should be updated to take a tree,
2653
# (What about tree.merge_from_branch?)
2654
tree = WorkingTree.open_containing(directory)[0]
2655
change_reporter = delta._ChangeReporter(
2656
unversioned_filter=tree.is_ignored)
2658
if branch is not None:
2660
mergeable = bundle.read_mergeable_from_url(
2662
except errors.NotABundle:
2663
pass # Continue on considering this url a Branch
2665
if revision is not None:
2666
raise errors.BzrCommandError(
2667
'Cannot use -r with merge directives or bundles')
2668
other_revision_id = mergeable.install_revisions(
2669
tree.branch.repository)
2670
revision = [RevisionSpec.from_string(
2671
'revid:' + other_revision_id)]
2673
if revision is None \
2674
or len(revision) < 1 or revision[0].needs_branch():
2675
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2677
if revision is None or len(revision) < 1:
2680
other = [branch, None]
2683
other = [branch, -1]
2684
other_branch, path = Branch.open_containing(branch)
2687
raise errors.BzrCommandError('Cannot use --uncommitted and'
2688
' --revision at the same time.')
2689
branch = revision[0].get_branch() or branch
2690
if len(revision) == 1:
2692
if other_revision_id is not None:
2697
other_branch, path = Branch.open_containing(branch)
2698
revno = revision[0].in_history(other_branch).revno
2699
other = [branch, revno]
2701
assert len(revision) == 2
2702
if None in revision:
2703
raise errors.BzrCommandError(
2704
"Merge doesn't permit empty revision specifier.")
2705
base_branch, path = Branch.open_containing(branch)
2706
branch1 = revision[1].get_branch() or branch
2707
other_branch, path1 = Branch.open_containing(branch1)
2708
if revision[0].get_branch() is not None:
2709
# then path was obtained from it, and is None.
2712
base = [branch, revision[0].in_history(base_branch).revno]
2713
other = [branch1, revision[1].in_history(other_branch).revno]
2715
if ((tree.branch.get_parent() is None or remember) and
2716
other_branch is not None):
2717
tree.branch.set_parent(other_branch.base)
2719
# pull tags now... it's a bit inconsistent to do it ahead of copying
2720
# the history but that's done inside the merge code
2721
if other_branch is not None:
2722
_merge_tags_if_possible(other_branch, tree.branch)
2725
interesting_files = [path]
2727
interesting_files = None
2728
pb = ui.ui_factory.nested_progress_bar()
2731
conflict_count = _merge_helper(
2732
other, base, other_rev_id=other_revision_id,
2733
check_clean=(not force),
2734
merge_type=merge_type,
2735
reprocess=reprocess,
2736
show_base=show_base,
2739
pb=pb, file_list=interesting_files,
2740
change_reporter=change_reporter)
2743
if conflict_count != 0:
2747
except errors.AmbiguousBase, e:
2748
m = ("sorry, bzr can't determine the right merge base yet\n"
2749
"candidates are:\n "
2750
+ "\n ".join(e.bases)
2752
"please specify an explicit base with -r,\n"
2753
"and (if you want) report this to the bzr developers\n")
2756
# TODO: move up to common parent; this isn't merge-specific anymore.
2757
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2758
"""Use tree.branch's parent if none was supplied.
2760
Report if the remembered location was used.
2762
if supplied_location is not None:
2763
return supplied_location
2764
stored_location = tree.branch.get_parent()
2765
mutter("%s", stored_location)
2766
if stored_location is None:
2767
raise errors.BzrCommandError("No location specified or remembered")
2768
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2769
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2770
return stored_location
2773
class cmd_remerge(Command):
2776
Use this if you want to try a different merge technique while resolving
2777
conflicts. Some merge techniques are better than others, and remerge
2778
lets you try different ones on different files.
2780
The options for remerge have the same meaning and defaults as the ones for
2781
merge. The difference is that remerge can (only) be run when there is a
2782
pending merge, and it lets you specify particular files.
2786
$ bzr remerge --show-base
2787
Re-do the merge of all conflicted files, and show the base text in
2788
conflict regions, in addition to the usual THIS and OTHER texts.
2790
$ bzr remerge --merge-type weave --reprocess foobar
2791
Re-do the merge of "foobar", using the weave merge algorithm, with
2792
additional processing to reduce the size of conflict regions.
2794
takes_args = ['file*']
2795
takes_options = ['merge-type', 'reprocess',
2796
Option('show-base', help="Show base revision text in "
2799
def run(self, file_list=None, merge_type=None, show_base=False,
2801
if merge_type is None:
2802
merge_type = _mod_merge.Merge3Merger
2803
tree, file_list = tree_files(file_list)
2806
parents = tree.get_parent_ids()
2807
if len(parents) != 2:
2808
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2809
" merges. Not cherrypicking or"
2811
repository = tree.branch.repository
2812
graph = repository.get_graph()
2813
base_revision = graph.find_unique_lca(parents[0], parents[1])
2814
base_tree = repository.revision_tree(base_revision)
2815
other_tree = repository.revision_tree(parents[1])
2816
interesting_ids = None
2818
conflicts = tree.conflicts()
2819
if file_list is not None:
2820
interesting_ids = set()
2821
for filename in file_list:
2822
file_id = tree.path2id(filename)
2824
raise errors.NotVersionedError(filename)
2825
interesting_ids.add(file_id)
2826
if tree.kind(file_id) != "directory":
2829
for name, ie in tree.inventory.iter_entries(file_id):
2830
interesting_ids.add(ie.file_id)
2831
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2833
# Remerge only supports resolving contents conflicts
2834
allowed_conflicts = ('text conflict', 'contents conflict')
2835
restore_files = [c.path for c in conflicts
2836
if c.typestring in allowed_conflicts]
2837
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2838
tree.set_conflicts(ConflictList(new_conflicts))
2839
if file_list is not None:
2840
restore_files = file_list
2841
for filename in restore_files:
2843
restore(tree.abspath(filename))
2844
except errors.NotConflicted:
2846
conflicts = _mod_merge.merge_inner(
2847
tree.branch, other_tree, base_tree,
2849
interesting_ids=interesting_ids,
2850
other_rev_id=parents[1],
2851
merge_type=merge_type,
2852
show_base=show_base,
2853
reprocess=reprocess)
2862
class cmd_revert(Command):
2863
"""Revert files to a previous revision.
2865
Giving a list of files will revert only those files. Otherwise, all files
2866
will be reverted. If the revision is not specified with '--revision', the
2867
last committed revision is used.
2869
To remove only some changes, without reverting to a prior version, use
2870
merge instead. For example, "merge . --r-2..-3" will remove the changes
2871
introduced by -2, without affecting the changes introduced by -1. Or
2872
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2874
By default, any files that have been manually changed will be backed up
2875
first. (Files changed only by merge are not backed up.) Backup files have
2876
'.~#~' appended to their name, where # is a number.
2878
When you provide files, you can use their current pathname or the pathname
2879
from the target revision. So you can use revert to "undelete" a file by
2880
name. If you name a directory, all the contents of that directory will be
2884
_see_also = ['cat', 'export']
2885
takes_options = ['revision', 'no-backup']
2886
takes_args = ['file*']
2888
def run(self, revision=None, no_backup=False, file_list=None):
2889
if file_list is not None:
2890
if len(file_list) == 0:
2891
raise errors.BzrCommandError("No files specified")
2895
tree, file_list = tree_files(file_list)
2896
if revision is None:
2897
# FIXME should be tree.last_revision
2898
rev_id = tree.last_revision()
2899
elif len(revision) != 1:
2900
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2902
rev_id = revision[0].in_history(tree.branch).rev_id
2903
pb = ui.ui_factory.nested_progress_bar()
2905
tree.revert(file_list,
2906
tree.branch.repository.revision_tree(rev_id),
2907
not no_backup, pb, report_changes=True)
2912
class cmd_assert_fail(Command):
2913
"""Test reporting of assertion failures"""
2914
# intended just for use in testing
2919
raise AssertionError("always fails")
2922
class cmd_help(Command):
2923
"""Show help on a command or other topic.
2926
_see_also = ['topics']
2927
takes_options = [Option('long', 'show help on all commands')]
2928
takes_args = ['topic?']
2929
aliases = ['?', '--help', '-?', '-h']
2932
def run(self, topic=None, long=False):
2934
if topic is None and long:
2936
bzrlib.help.help(topic)
2939
class cmd_shell_complete(Command):
2940
"""Show appropriate completions for context.
2942
For a list of all available commands, say 'bzr shell-complete'.
2944
takes_args = ['context?']
2949
def run(self, context=None):
2950
import shellcomplete
2951
shellcomplete.shellcomplete(context)
2954
class cmd_fetch(Command):
2955
"""Copy in history from another branch but don't merge it.
2957
This is an internal method used for pull and merge.
2960
takes_args = ['from_branch', 'to_branch']
2961
def run(self, from_branch, to_branch):
2962
from bzrlib.fetch import Fetcher
2963
from_b = Branch.open(from_branch)
2964
to_b = Branch.open(to_branch)
2965
Fetcher(to_b, from_b)
2968
class cmd_missing(Command):
2969
"""Show unmerged/unpulled revisions between two branches.
2971
OTHER_BRANCH may be local or remote.
2974
_see_also = ['merge', 'pull']
2975
takes_args = ['other_branch?']
2976
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2978
'Display changes in the local branch only'),
2979
Option('this' , 'same as --mine-only'),
2980
Option('theirs-only',
2981
'Display changes in the remote branch only'),
2982
Option('other', 'same as --theirs-only'),
2987
encoding_type = 'replace'
2990
def run(self, other_branch=None, reverse=False, mine_only=False,
2991
theirs_only=False, log_format=None, long=False, short=False, line=False,
2992
show_ids=False, verbose=False, this=False, other=False):
2993
from bzrlib.missing import find_unmerged, iter_log_revisions
2994
from bzrlib.log import log_formatter
3001
local_branch = Branch.open_containing(u".")[0]
3002
parent = local_branch.get_parent()
3003
if other_branch is None:
3004
other_branch = parent
3005
if other_branch is None:
3006
raise errors.BzrCommandError("No peer location known or specified.")
3007
display_url = urlutils.unescape_for_display(parent,
3009
print "Using last location: " + display_url
3011
remote_branch = Branch.open(other_branch)
3012
if remote_branch.base == local_branch.base:
3013
remote_branch = local_branch
3014
local_branch.lock_read()
3016
remote_branch.lock_read()
3018
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
3019
if (log_format is None):
3020
log_format = log.log_formatter_registry.get_default(
3022
lf = log_format(to_file=self.outf,
3024
show_timezone='original')
3025
if reverse is False:
3026
local_extra.reverse()
3027
remote_extra.reverse()
3028
if local_extra and not theirs_only:
3029
print "You have %d extra revision(s):" % len(local_extra)
3030
for revision in iter_log_revisions(local_extra,
3031
local_branch.repository,
3033
lf.log_revision(revision)
3034
printed_local = True
3036
printed_local = False
3037
if remote_extra and not mine_only:
3038
if printed_local is True:
3040
print "You are missing %d revision(s):" % len(remote_extra)
3041
for revision in iter_log_revisions(remote_extra,
3042
remote_branch.repository,
3044
lf.log_revision(revision)
3045
if not remote_extra and not local_extra:
3047
print "Branches are up to date."
3051
remote_branch.unlock()
3053
local_branch.unlock()
3054
if not status_code and parent is None and other_branch is not None:
3055
local_branch.lock_write()
3057
# handle race conditions - a parent might be set while we run.
3058
if local_branch.get_parent() is None:
3059
local_branch.set_parent(remote_branch.base)
3061
local_branch.unlock()
3065
class cmd_plugins(Command):
3070
import bzrlib.plugin
3071
from inspect import getdoc
3072
for name, plugin in bzrlib.plugin.all_plugins().items():
3073
if getattr(plugin, '__path__', None) is not None:
3074
print plugin.__path__[0]
3075
elif getattr(plugin, '__file__', None) is not None:
3076
print plugin.__file__
3082
print '\t', d.split('\n')[0]
3085
class cmd_testament(Command):
3086
"""Show testament (signing-form) of a revision."""
3087
takes_options = ['revision',
3088
Option('long', help='Produce long-format testament'),
3089
Option('strict', help='Produce a strict-format'
3091
takes_args = ['branch?']
3093
def run(self, branch=u'.', revision=None, long=False, strict=False):
3094
from bzrlib.testament import Testament, StrictTestament
3096
testament_class = StrictTestament
3098
testament_class = Testament
3099
b = WorkingTree.open_containing(branch)[0].branch
3102
if revision is None:
3103
rev_id = b.last_revision()
3105
rev_id = revision[0].in_history(b).rev_id
3106
t = testament_class.from_revision(b.repository, rev_id)
3108
sys.stdout.writelines(t.as_text_lines())
3110
sys.stdout.write(t.as_short_text())
3115
class cmd_annotate(Command):
3116
"""Show the origin of each line in a file.
3118
This prints out the given file with an annotation on the left side
3119
indicating which revision, author and date introduced the change.
3121
If the origin is the same for a run of consecutive lines, it is
3122
shown only at the top, unless the --all option is given.
3124
# TODO: annotate directories; showing when each file was last changed
3125
# TODO: if the working copy is modified, show annotations on that
3126
# with new uncommitted lines marked
3127
aliases = ['ann', 'blame', 'praise']
3128
takes_args = ['filename']
3129
takes_options = [Option('all', help='show annotations on all lines'),
3130
Option('long', help='show date in annotations'),
3136
def run(self, filename, all=False, long=False, revision=None,
3138
from bzrlib.annotate import annotate_file
3139
tree, relpath = WorkingTree.open_containing(filename)
3140
branch = tree.branch
3143
if revision is None:
3144
revision_id = branch.last_revision()
3145
elif len(revision) != 1:
3146
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3148
revision_id = revision[0].in_history(branch).rev_id
3149
file_id = tree.path2id(relpath)
3151
raise errors.NotVersionedError(filename)
3152
tree = branch.repository.revision_tree(revision_id)
3153
file_version = tree.inventory[file_id].revision
3154
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
3160
class cmd_re_sign(Command):
3161
"""Create a digital signature for an existing revision."""
3162
# TODO be able to replace existing ones.
3164
hidden = True # is this right ?
3165
takes_args = ['revision_id*']
3166
takes_options = ['revision']
3168
def run(self, revision_id_list=None, revision=None):
3169
import bzrlib.gpg as gpg
3170
if revision_id_list is not None and revision is not None:
3171
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3172
if revision_id_list is None and revision is None:
3173
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3174
b = WorkingTree.open_containing(u'.')[0].branch
3175
gpg_strategy = gpg.GPGStrategy(b.get_config())
3176
if revision_id_list is not None:
3177
for revision_id in revision_id_list:
3178
b.repository.sign_revision(revision_id, gpg_strategy)
3179
elif revision is not None:
3180
if len(revision) == 1:
3181
revno, rev_id = revision[0].in_history(b)
3182
b.repository.sign_revision(rev_id, gpg_strategy)
3183
elif len(revision) == 2:
3184
# are they both on rh- if so we can walk between them
3185
# might be nice to have a range helper for arbitrary
3186
# revision paths. hmm.
3187
from_revno, from_revid = revision[0].in_history(b)
3188
to_revno, to_revid = revision[1].in_history(b)
3189
if to_revid is None:
3190
to_revno = b.revno()
3191
if from_revno is None or to_revno is None:
3192
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3193
for revno in range(from_revno, to_revno + 1):
3194
b.repository.sign_revision(b.get_rev_id(revno),
3197
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3200
class cmd_bind(Command):
3201
"""Convert the current branch into a checkout of the supplied branch.
3203
Once converted into a checkout, commits must succeed on the master branch
3204
before they will be applied to the local branch.
3207
_see_also = ['checkouts', 'unbind']
3208
takes_args = ['location?']
3211
def run(self, location=None):
3212
b, relpath = Branch.open_containing(u'.')
3213
if location is None:
3215
location = b.get_old_bound_location()
3216
except errors.UpgradeRequired:
3217
raise errors.BzrCommandError('No location supplied. '
3218
'This format does not remember old locations.')
3220
if location is None:
3221
raise errors.BzrCommandError('No location supplied and no '
3222
'previous location known')
3223
b_other = Branch.open(location)
3226
except errors.DivergedBranches:
3227
raise errors.BzrCommandError('These branches have diverged.'
3228
' Try merging, and then bind again.')
3231
class cmd_unbind(Command):
3232
"""Convert the current checkout into a regular branch.
3234
After unbinding, the local branch is considered independent and subsequent
3235
commits will be local only.
3238
_see_also = ['checkouts', 'bind']
3243
b, relpath = Branch.open_containing(u'.')
3245
raise errors.BzrCommandError('Local branch is not bound')
3248
class cmd_uncommit(Command):
3249
"""Remove the last committed revision.
3251
--verbose will print out what is being removed.
3252
--dry-run will go through all the motions, but not actually
3255
In the future, uncommit will create a revision bundle, which can then
3259
# TODO: jam 20060108 Add an option to allow uncommit to remove
3260
# unreferenced information in 'branch-as-repository' branches.
3261
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3262
# information in shared branches as well.
3263
_see_also = ['commit']
3264
takes_options = ['verbose', 'revision',
3265
Option('dry-run', help='Don\'t actually make changes'),
3266
Option('force', help='Say yes to all questions.')]
3267
takes_args = ['location?']
3270
def run(self, location=None,
3271
dry_run=False, verbose=False,
3272
revision=None, force=False):
3273
from bzrlib.log import log_formatter, show_log
3275
from bzrlib.uncommit import uncommit
3277
if location is None:
3279
control, relpath = bzrdir.BzrDir.open_containing(location)
3281
tree = control.open_workingtree()
3283
except (errors.NoWorkingTree, errors.NotLocalUrl):
3285
b = control.open_branch()
3288
if revision is None:
3291
# 'bzr uncommit -r 10' actually means uncommit
3292
# so that the final tree is at revno 10.
3293
# but bzrlib.uncommit.uncommit() actually uncommits
3294
# the revisions that are supplied.
3295
# So we need to offset it by one
3296
revno = revision[0].in_history(b).revno+1
3298
if revno <= b.revno():
3299
rev_id = b.get_rev_id(revno)
3301
self.outf.write('No revisions to uncommit.\n')
3304
lf = log_formatter('short',
3306
show_timezone='original')
3311
direction='forward',
3312
start_revision=revno,
3313
end_revision=b.revno())
3316
print 'Dry-run, pretending to remove the above revisions.'
3318
val = raw_input('Press <enter> to continue')
3320
print 'The above revision(s) will be removed.'
3322
val = raw_input('Are you sure [y/N]? ')
3323
if val.lower() not in ('y', 'yes'):
3327
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3331
class cmd_break_lock(Command):
3332
"""Break a dead lock on a repository, branch or working directory.
3334
CAUTION: Locks should only be broken when you are sure that the process
3335
holding the lock has been stopped.
3337
You can get information on what locks are open via the 'bzr info' command.
3342
takes_args = ['location?']
3344
def run(self, location=None, show=False):
3345
if location is None:
3347
control, relpath = bzrdir.BzrDir.open_containing(location)
3349
control.break_lock()
3350
except NotImplementedError:
3354
class cmd_wait_until_signalled(Command):
3355
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3357
This just prints a line to signal when it is ready, then blocks on stdin.
3363
sys.stdout.write("running\n")
3365
sys.stdin.readline()
3368
class cmd_serve(Command):
3369
"""Run the bzr server."""
3371
aliases = ['server']
3375
help='serve on stdin/out for use from inetd or sshd'),
3377
help='listen for connections on nominated port of the form '
3378
'[hostname:]portnumber. Passing 0 as the port number will '
3379
'result in a dynamically allocated port. Default port is '
3383
help='serve contents of directory',
3385
Option('allow-writes',
3386
help='By default the server is a readonly server. Supplying '
3387
'--allow-writes enables write access to the contents of '
3388
'the served directory and below. '
3392
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3393
from bzrlib.smart import medium, server
3394
from bzrlib.transport import get_transport
3395
from bzrlib.transport.chroot import ChrootServer
3396
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3397
if directory is None:
3398
directory = os.getcwd()
3399
url = urlutils.local_path_to_url(directory)
3400
if not allow_writes:
3401
url = 'readonly+' + url
3402
chroot_server = ChrootServer(get_transport(url))
3403
chroot_server.setUp()
3404
t = get_transport(chroot_server.get_url())
3406
smart_server = medium.SmartServerPipeStreamMedium(
3407
sys.stdin, sys.stdout, t)
3409
host = BZR_DEFAULT_INTERFACE
3411
port = BZR_DEFAULT_PORT
3414
host, port = port.split(':')
3416
smart_server = server.SmartTCPServer(t, host=host, port=port)
3417
print 'listening on port: ', smart_server.port
3419
# for the duration of this server, no UI output is permitted.
3420
# note that this may cause problems with blackbox tests. This should
3421
# be changed with care though, as we dont want to use bandwidth sending
3422
# progress over stderr to smart server clients!
3423
old_factory = ui.ui_factory
3425
ui.ui_factory = ui.SilentUIFactory()
3426
smart_server.serve()
3428
ui.ui_factory = old_factory
3431
class cmd_join(Command):
3432
"""Combine a subtree into its containing tree.
3434
This command is for experimental use only. It requires the target tree
3435
to be in dirstate-with-subtree format, which cannot be converted into
3438
The TREE argument should be an independent tree, inside another tree, but
3439
not part of it. (Such trees can be produced by "bzr split", but also by
3440
running "bzr branch" with the target inside a tree.)
3442
The result is a combined tree, with the subtree no longer an independant
3443
part. This is marked as a merge of the subtree into the containing tree,
3444
and all history is preserved.
3446
If --reference is specified, the subtree retains its independence. It can
3447
be branched by itself, and can be part of multiple projects at the same
3448
time. But operations performed in the containing tree, such as commit
3449
and merge, will recurse into the subtree.
3452
_see_also = ['split']
3453
takes_args = ['tree']
3454
takes_options = [Option('reference', 'join by reference')]
3457
def run(self, tree, reference=False):
3458
sub_tree = WorkingTree.open(tree)
3459
parent_dir = osutils.dirname(sub_tree.basedir)
3460
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3461
repo = containing_tree.branch.repository
3462
if not repo.supports_rich_root():
3463
raise errors.BzrCommandError(
3464
"Can't join trees because %s doesn't support rich root data.\n"
3465
"You can use bzr upgrade on the repository."
3469
containing_tree.add_reference(sub_tree)
3470
except errors.BadReferenceTarget, e:
3471
# XXX: Would be better to just raise a nicely printable
3472
# exception from the real origin. Also below. mbp 20070306
3473
raise errors.BzrCommandError("Cannot join %s. %s" %
3477
containing_tree.subsume(sub_tree)
3478
except errors.BadSubsumeSource, e:
3479
raise errors.BzrCommandError("Cannot join %s. %s" %
3483
class cmd_split(Command):
3484
"""Split a tree into two trees.
3486
This command is for experimental use only. It requires the target tree
3487
to be in dirstate-with-subtree format, which cannot be converted into
3490
The TREE argument should be a subdirectory of a working tree. That
3491
subdirectory will be converted into an independent tree, with its own
3492
branch. Commits in the top-level tree will not apply to the new subtree.
3493
If you want that behavior, do "bzr join --reference TREE".
3496
_see_also = ['join']
3497
takes_args = ['tree']
3501
def run(self, tree):
3502
containing_tree, subdir = WorkingTree.open_containing(tree)
3503
sub_id = containing_tree.path2id(subdir)
3505
raise errors.NotVersionedError(subdir)
3507
containing_tree.extract(sub_id)
3508
except errors.RootNotRich:
3509
raise errors.UpgradeRequired(containing_tree.branch.base)
3513
class cmd_merge_directive(Command):
3514
"""Generate a merge directive for auto-merge tools.
3516
A directive requests a merge to be performed, and also provides all the
3517
information necessary to do so. This means it must either include a
3518
revision bundle, or the location of a branch containing the desired
3521
A submit branch (the location to merge into) must be supplied the first
3522
time the command is issued. After it has been supplied once, it will
3523
be remembered as the default.
3525
A public branch is optional if a revision bundle is supplied, but required
3526
if --diff or --plain is specified. It will be remembered as the default
3527
after the first use.
3530
takes_args = ['submit_branch?', 'public_branch?']
3533
RegistryOption.from_kwargs('patch-type',
3534
'The type of patch to include in the directive',
3535
title='Patch type', value_switches=True, enum_switch=False,
3536
bundle='Bazaar revision bundle (default)',
3537
diff='Normal unified diff',
3538
plain='No patch, just directive'),
3539
Option('sign', help='GPG-sign the directive'), 'revision',
3540
Option('mail-to', type=str,
3541
help='Instead of printing the directive, email to this address'),
3542
Option('message', type=str, short_name='m',
3543
help='Message to use when committing this merge')
3546
encoding_type = 'exact'
3548
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3549
sign=False, revision=None, mail_to=None, message=None):
3550
from bzrlib.revision import ensure_null, NULL_REVISION
3551
if patch_type == 'plain':
3553
branch = Branch.open('.')
3554
stored_submit_branch = branch.get_submit_branch()
3555
if submit_branch is None:
3556
submit_branch = stored_submit_branch
3558
if stored_submit_branch is None:
3559
branch.set_submit_branch(submit_branch)
3560
if submit_branch is None:
3561
submit_branch = branch.get_parent()
3562
if submit_branch is None:
3563
raise errors.BzrCommandError('No submit branch specified or known')
3565
stored_public_branch = branch.get_public_branch()
3566
if public_branch is None:
3567
public_branch = stored_public_branch
3568
elif stored_public_branch is None:
3569
branch.set_public_branch(public_branch)
3570
if patch_type != "bundle" and public_branch is None:
3571
raise errors.BzrCommandError('No public branch specified or'
3573
if revision is not None:
3574
if len(revision) != 1:
3575
raise errors.BzrCommandError('bzr merge-directive takes '
3576
'exactly one revision identifier')
3578
revision_id = revision[0].in_history(branch).rev_id
3580
revision_id = branch.last_revision()
3581
revision_id = ensure_null(revision_id)
3582
if revision_id == NULL_REVISION:
3583
raise errors.BzrCommandError('No revisions to bundle.')
3584
directive = merge_directive.MergeDirective.from_objects(
3585
branch.repository, revision_id, time.time(),
3586
osutils.local_time_offset(), submit_branch,
3587
public_branch=public_branch, patch_type=patch_type,
3591
self.outf.write(directive.to_signed(branch))
3593
self.outf.writelines(directive.to_lines())
3595
message = directive.to_email(mail_to, branch, sign)
3596
s = SMTPConnection(branch.get_config())
3597
s.send_email(message)
3600
class cmd_tag(Command):
3601
"""Create a tag naming a revision.
3603
Tags give human-meaningful names to revisions. Commands that take a -r
3604
(--revision) option can be given -rtag:X, where X is any previously
3607
Tags are stored in the branch. Tags are copied from one branch to another
3608
along when you branch, push, pull or merge.
3610
It is an error to give a tag name that already exists unless you pass
3611
--force, in which case the tag is moved to point to the new revision.
3614
_see_also = ['commit', 'tags']
3615
takes_args = ['tag_name']
3618
help='Delete this tag rather than placing it.',
3621
help='Branch in which to place the tag.',
3626
help='Replace existing tags',
3631
def run(self, tag_name,
3637
branch, relpath = Branch.open_containing(directory)
3641
branch.tags.delete_tag(tag_name)
3642
self.outf.write('Deleted tag %s.\n' % tag_name)
3645
if len(revision) != 1:
3646
raise errors.BzrCommandError(
3647
"Tags can only be placed on a single revision, "
3649
revision_id = revision[0].in_history(branch).rev_id
3651
revision_id = branch.last_revision()
3652
if (not force) and branch.tags.has_tag(tag_name):
3653
raise errors.TagAlreadyExists(tag_name)
3654
branch.tags.set_tag(tag_name, revision_id)
3655
self.outf.write('Created tag %s.\n' % tag_name)
3660
class cmd_tags(Command):
3663
This tag shows a table of tag names and the revisions they reference.
3669
help='Branch whose tags should be displayed',
3679
branch, relpath = Branch.open_containing(directory)
3680
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3681
self.outf.write('%-20s %s\n' % (tag_name, target))
3684
# command-line interpretation helper for merge-related commands
3685
def _merge_helper(other_revision, base_revision,
3686
check_clean=True, ignore_zero=False,
3687
this_dir=None, backup_files=False,
3689
file_list=None, show_base=False, reprocess=False,
3692
change_reporter=None,
3694
"""Merge changes into a tree.
3697
list(path, revno) Base for three-way merge.
3698
If [None, None] then a base will be automatically determined.
3700
list(path, revno) Other revision for three-way merge.
3702
Directory to merge changes into; '.' by default.
3704
If true, this_dir must have no uncommitted changes before the
3706
ignore_zero - If true, suppress the "zero conflicts" message when
3707
there are no conflicts; should be set when doing something we expect
3708
to complete perfectly.
3709
file_list - If supplied, merge only changes to selected files.
3711
All available ancestors of other_revision and base_revision are
3712
automatically pulled into the branch.
3714
The revno may be -1 to indicate the last revision on the branch, which is
3717
This function is intended for use from the command line; programmatic
3718
clients might prefer to call merge.merge_inner(), which has less magic
3721
# Loading it late, so that we don't always have to import bzrlib.merge
3722
if merge_type is None:
3723
merge_type = _mod_merge.Merge3Merger
3724
if this_dir is None:
3726
this_tree = WorkingTree.open_containing(this_dir)[0]
3727
if show_base and not merge_type is _mod_merge.Merge3Merger:
3728
raise errors.BzrCommandError("Show-base is not supported for this merge"
3729
" type. %s" % merge_type)
3730
if reprocess and not merge_type.supports_reprocess:
3731
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3732
" type %s." % merge_type)
3733
if reprocess and show_base:
3734
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3735
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3736
# only want to take out a lock_tree_write() if we don't have to pull
3737
# any ancestry. But merge might fetch ancestry in the middle, in
3738
# which case we would need a lock_write().
3739
# Because we cannot upgrade locks, for now we live with the fact that
3740
# the tree will be locked multiple times during a merge. (Maybe
3741
# read-only some of the time, but it means things will get read
3744
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3745
pb=pb, change_reporter=change_reporter)
3746
merger.pp = ProgressPhase("Merge phase", 5, pb)
3747
merger.pp.next_phase()
3748
merger.check_basis(check_clean)
3749
if other_rev_id is not None:
3750
merger.set_other_revision(other_rev_id, this_tree.branch)
3752
merger.set_other(other_revision)
3753
merger.pp.next_phase()
3754
merger.set_base(base_revision)
3755
if merger.base_rev_id == merger.other_rev_id:
3756
note('Nothing to do.')
3758
if file_list is None:
3759
if pull and merger.base_rev_id == merger.this_rev_id:
3760
# FIXME: deduplicate with pull
3761
result = merger.this_tree.pull(merger.this_branch,
3762
False, merger.other_rev_id)
3763
if result.old_revid == result.new_revid:
3764
note('No revisions to pull.')
3766
note('Now on revision %d.' % result.new_revno)
3768
merger.backup_files = backup_files
3769
merger.merge_type = merge_type
3770
merger.set_interesting_files(file_list)
3771
merger.show_base = show_base
3772
merger.reprocess = reprocess
3773
conflicts = merger.do_merge()
3774
if file_list is None:
3775
merger.set_pending()
3781
def _create_prefix(cur_transport):
3782
needed = [cur_transport]
3783
# Recurse upwards until we can create a directory successfully
3785
new_transport = cur_transport.clone('..')
3786
if new_transport.base == cur_transport.base:
3787
raise errors.BzrCommandError("Failed to create path"
3791
new_transport.mkdir('.')
3792
except errors.NoSuchFile:
3793
needed.append(new_transport)
3794
cur_transport = new_transport
3798
# Now we only need to create child directories
3800
cur_transport = needed.pop()
3801
cur_transport.ensure_base()
3804
merge = _merge_helper
3807
# these get imported and then picked up by the scan for cmd_*
3808
# TODO: Some more consistent way to split command definitions across files;
3809
# we do need to load at least some information about them to know of
3810
# aliases. ideally we would avoid loading the implementation until the
3811
# details were needed.
3812
from bzrlib.cmd_version_info import cmd_version_info
3813
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3814
from bzrlib.bundle.commands import cmd_bundle_revisions
3815
from bzrlib.sign_my_commits import cmd_sign_my_commits
3816
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
3817
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
