1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
20
from StringIO import StringIO
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
55
from bzrlib.branch import Branch
56
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
57
from bzrlib.conflicts import ConflictList
58
from bzrlib.revision import common_ancestor
59
from bzrlib.revisionspec import RevisionSpec
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import Command, display_command
64
from bzrlib.option import ListOption, Option, RegistryOption
65
from bzrlib.progress import DummyProgress, ProgressPhase
66
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
69
def tree_files(file_list, default_branch=u'.'):
71
return internal_tree_files(file_list, default_branch)
72
except errors.FileInWrongBranch, e:
73
raise errors.BzrCommandError("%s is not in the same branch as %s" %
74
(e.path, file_list[0]))
77
# XXX: Bad function name; should possibly also be a class method of
78
# WorkingTree rather than a function.
79
def internal_tree_files(file_list, default_branch=u'.'):
80
"""Convert command-line paths to a WorkingTree and relative paths.
82
This is typically used for command-line processors that take one or
83
more filenames, and infer the workingtree that contains them.
85
The filenames given are not required to exist.
87
:param file_list: Filenames to convert.
89
:param default_branch: Fallback tree path to use if file_list is empty or
92
:return: workingtree, [relative_paths]
94
if file_list is None or len(file_list) == 0:
95
return WorkingTree.open_containing(default_branch)[0], file_list
96
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
98
for filename in file_list:
100
new_list.append(tree.relpath(osutils.dereference_path(filename)))
101
except errors.PathNotChild:
102
raise errors.FileInWrongBranch(tree.branch, filename)
103
return tree, new_list
106
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
107
def get_format_type(typestring):
108
"""Parse and return a format specifier."""
109
# Have to use BzrDirMetaFormat1 directly, so that
110
# RepositoryFormat.set_default_format works
111
if typestring == "default":
112
return bzrdir.BzrDirMetaFormat1()
114
return bzrdir.format_registry.make_bzrdir(typestring)
116
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
117
raise errors.BzrCommandError(msg)
120
# TODO: Make sure no commands unconditionally use the working directory as a
121
# branch. If a filename argument is used, the first of them should be used to
122
# specify the branch. (Perhaps this can be factored out into some kind of
123
# Argument class, representing a file in a branch, where the first occurrence
126
class cmd_status(Command):
127
"""Display status summary.
129
This reports on versioned and unknown files, reporting them
130
grouped by state. Possible states are:
133
Versioned in the working copy but not in the previous revision.
136
Versioned in the previous revision but removed or deleted
140
Path of this file changed from the previous revision;
141
the text may also have changed. This includes files whose
142
parent directory was renamed.
145
Text has changed since the previous revision.
148
File kind has been changed (e.g. from file to directory).
151
Not versioned and not matching an ignore pattern.
153
To see ignored files use 'bzr ignored'. For details on the
154
changes to file texts, use 'bzr diff'.
156
--short gives a status flags for each item, similar to the SVN's status
159
Column 1: versioning / renames
165
P Entry for a pending merge (not a file)
174
* The execute bit was changed
176
If no arguments are specified, the status of the entire working
177
directory is shown. Otherwise, only the status of the specified
178
files or directories is reported. If a directory is given, status
179
is reported for everything inside that directory.
181
If a revision argument is given, the status is calculated against
182
that revision, or between two revisions if two are provided.
185
# TODO: --no-recurse, --recurse options
187
takes_args = ['file*']
188
takes_options = ['show-ids', 'revision',
189
Option('short', help='Give short SVN-style status lines'),
190
Option('versioned', help='Only show versioned files')]
191
aliases = ['st', 'stat']
193
encoding_type = 'replace'
194
_see_also = ['diff', 'revert']
197
def run(self, show_ids=False, file_list=None, revision=None, short=False,
199
from bzrlib.status import show_tree_status
201
tree, file_list = tree_files(file_list)
203
show_tree_status(tree, show_ids=show_ids,
204
specific_files=file_list, revision=revision,
205
to_file=self.outf, short=short, versioned=versioned)
208
class cmd_cat_revision(Command):
209
"""Write out metadata for a revision.
211
The revision to print can either be specified by a specific
212
revision identifier, or you can use --revision.
216
takes_args = ['revision_id?']
217
takes_options = ['revision']
218
# cat-revision is more for frontends so should be exact
222
def run(self, revision_id=None, revision=None):
224
revision_id = osutils.safe_revision_id(revision_id, warn=False)
225
if revision_id is not None and revision is not None:
226
raise errors.BzrCommandError('You can only supply one of'
227
' revision_id or --revision')
228
if revision_id is None and revision is None:
229
raise errors.BzrCommandError('You must supply either'
230
' --revision or a revision_id')
231
b = WorkingTree.open_containing(u'.')[0].branch
233
# TODO: jam 20060112 should cat-revision always output utf-8?
234
if revision_id is not None:
235
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
236
elif revision is not None:
239
raise errors.BzrCommandError('You cannot specify a NULL'
241
revno, rev_id = rev.in_history(b)
242
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
245
class cmd_remove_tree(Command):
246
"""Remove the working tree from a given branch/checkout.
248
Since a lightweight checkout is little more than a working tree
249
this will refuse to run against one.
251
To re-create the working tree, use "bzr checkout".
253
_see_also = ['checkout', 'working-trees']
255
takes_args = ['location?']
257
def run(self, location='.'):
258
d = bzrdir.BzrDir.open(location)
261
working = d.open_workingtree()
262
except errors.NoWorkingTree:
263
raise errors.BzrCommandError("No working tree to remove")
264
except errors.NotLocalUrl:
265
raise errors.BzrCommandError("You cannot remove the working tree of a "
268
working_path = working.bzrdir.root_transport.base
269
branch_path = working.branch.bzrdir.root_transport.base
270
if working_path != branch_path:
271
raise errors.BzrCommandError("You cannot remove the working tree from "
272
"a lightweight checkout")
274
d.destroy_workingtree()
277
class cmd_revno(Command):
278
"""Show current revision number.
280
This is equal to the number of revisions on this branch.
284
takes_args = ['location?']
287
def run(self, location=u'.'):
288
self.outf.write(str(Branch.open_containing(location)[0].revno()))
289
self.outf.write('\n')
292
class cmd_revision_info(Command):
293
"""Show revision number and revision id for a given revision identifier.
296
takes_args = ['revision_info*']
297
takes_options = ['revision']
300
def run(self, revision=None, revision_info_list=[]):
303
if revision is not None:
304
revs.extend(revision)
305
if revision_info_list is not None:
306
for rev in revision_info_list:
307
revs.append(RevisionSpec.from_string(rev))
309
b = Branch.open_containing(u'.')[0]
312
revs.append(RevisionSpec.from_string('-1'))
315
revinfo = rev.in_history(b)
316
if revinfo.revno is None:
317
dotted_map = b.get_revision_id_to_revno_map()
318
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
319
print '%s %s' % (revno, revinfo.rev_id)
321
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
324
class cmd_add(Command):
325
"""Add specified files or directories.
327
In non-recursive mode, all the named items are added, regardless
328
of whether they were previously ignored. A warning is given if
329
any of the named files are already versioned.
331
In recursive mode (the default), files are treated the same way
332
but the behaviour for directories is different. Directories that
333
are already versioned do not give a warning. All directories,
334
whether already versioned or not, are searched for files or
335
subdirectories that are neither versioned or ignored, and these
336
are added. This search proceeds recursively into versioned
337
directories. If no names are given '.' is assumed.
339
Therefore simply saying 'bzr add' will version all files that
340
are currently unknown.
342
Adding a file whose parent directory is not versioned will
343
implicitly add the parent, and so on up to the root. This means
344
you should never need to explicitly add a directory, they'll just
345
get added when you add a file in the directory.
347
--dry-run will show which files would be added, but not actually
350
--file-ids-from will try to use the file ids from the supplied path.
351
It looks up ids trying to find a matching parent directory with the
352
same filename, and then by pure path. This option is rarely needed
353
but can be useful when adding the same logical file into two
354
branches that will be merged later (without showing the two different
355
adds as a conflict). It is also useful when merging another project
356
into a subdirectory of this one.
358
takes_args = ['file*']
359
takes_options = ['no-recurse', 'dry-run', 'verbose',
360
Option('file-ids-from', type=unicode,
361
help='Lookup file ids from here')]
362
encoding_type = 'replace'
363
_see_also = ['remove']
365
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
370
if file_ids_from is not None:
372
base_tree, base_path = WorkingTree.open_containing(
374
except errors.NoWorkingTree:
375
base_branch, base_path = Branch.open_containing(
377
base_tree = base_branch.basis_tree()
379
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
380
to_file=self.outf, should_print=(not is_quiet()))
382
action = bzrlib.add.AddAction(to_file=self.outf,
383
should_print=(not is_quiet()))
386
base_tree.lock_read()
388
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
389
action=action, save=not dry_run)
391
if base_tree is not None:
395
for glob in sorted(ignored.keys()):
396
for path in ignored[glob]:
397
self.outf.write("ignored %s matching \"%s\"\n"
401
for glob, paths in ignored.items():
402
match_len += len(paths)
403
self.outf.write("ignored %d file(s).\n" % match_len)
404
self.outf.write("If you wish to add some of these files,"
405
" please add them by name.\n")
408
class cmd_mkdir(Command):
409
"""Create a new versioned directory.
411
This is equivalent to creating the directory and then adding it.
414
takes_args = ['dir+']
415
encoding_type = 'replace'
417
def run(self, dir_list):
420
wt, dd = WorkingTree.open_containing(d)
422
self.outf.write('added %s\n' % d)
425
class cmd_relpath(Command):
426
"""Show path of a file relative to root"""
428
takes_args = ['filename']
432
def run(self, filename):
433
# TODO: jam 20050106 Can relpath return a munged path if
434
# sys.stdout encoding cannot represent it?
435
tree, relpath = WorkingTree.open_containing(filename)
436
self.outf.write(relpath)
437
self.outf.write('\n')
440
class cmd_inventory(Command):
441
"""Show inventory of the current working copy or a revision.
443
It is possible to limit the output to a particular entry
444
type using the --kind option. For example: --kind file.
446
It is also possible to restrict the list of files to a specific
447
set. For example: bzr inventory --show-ids this/file
452
takes_options = ['revision', 'show-ids', 'kind']
453
takes_args = ['file*']
456
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
457
if kind and kind not in ['file', 'directory', 'symlink']:
458
raise errors.BzrCommandError('invalid kind specified')
460
work_tree, file_list = tree_files(file_list)
461
work_tree.lock_read()
463
if revision is not None:
464
if len(revision) > 1:
465
raise errors.BzrCommandError(
466
'bzr inventory --revision takes exactly one revision'
468
revision_id = revision[0].in_history(work_tree.branch).rev_id
469
tree = work_tree.branch.repository.revision_tree(revision_id)
471
extra_trees = [work_tree]
477
if file_list is not None:
478
file_ids = tree.paths2ids(file_list, trees=extra_trees,
479
require_versioned=True)
480
# find_ids_across_trees may include some paths that don't
482
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
483
for file_id in file_ids if file_id in tree)
485
entries = tree.inventory.entries()
488
if tree is not work_tree:
491
for path, entry in entries:
492
if kind and kind != entry.kind:
495
self.outf.write('%-50s %s\n' % (path, entry.file_id))
497
self.outf.write(path)
498
self.outf.write('\n')
501
class cmd_mv(Command):
502
"""Move or rename a file.
505
bzr mv OLDNAME NEWNAME
506
bzr mv SOURCE... DESTINATION
508
If the last argument is a versioned directory, all the other names
509
are moved into it. Otherwise, there must be exactly two arguments
510
and the file is changed to a new name.
512
If OLDNAME does not exist on the filesystem but is versioned and
513
NEWNAME does exist on the filesystem but is not versioned, mv
514
assumes that the file has been manually moved and only updates
515
its internal inventory to reflect that change.
516
The same is valid when moving many SOURCE files to a DESTINATION.
518
Files cannot be moved between branches.
521
takes_args = ['names*']
522
takes_options = [Option("after", help="move only the bzr identifier"
523
" of the file (file has already been moved). Use this flag if"
524
" bzr is not able to detect this itself.")]
525
aliases = ['move', 'rename']
526
encoding_type = 'replace'
528
def run(self, names_list, after=False):
529
if names_list is None:
532
if len(names_list) < 2:
533
raise errors.BzrCommandError("missing file argument")
534
tree, rel_names = tree_files(names_list)
536
if os.path.isdir(names_list[-1]):
537
# move into existing directory
538
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
539
self.outf.write("%s => %s\n" % pair)
541
if len(names_list) != 2:
542
raise errors.BzrCommandError('to mv multiple files the'
543
' destination must be a versioned'
545
tree.rename_one(rel_names[0], rel_names[1], after=after)
546
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
549
class cmd_pull(Command):
550
"""Turn this branch into a mirror of another branch.
552
This command only works on branches that have not diverged. Branches are
553
considered diverged if the destination branch's most recent commit is one
554
that has not been merged (directly or indirectly) into the parent.
556
If branches have diverged, you can use 'bzr merge' to integrate the changes
557
from one into the other. Once one branch has merged, the other should
558
be able to pull it again.
560
If you want to forget your local changes and just update your branch to
561
match the remote one, use pull --overwrite.
563
If there is no default location set, the first pull will set it. After
564
that, you can omit the location to use the default. To change the
565
default, use --remember. The value will only be saved if the remote
566
location can be accessed.
569
_see_also = ['push', 'update']
570
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
572
help='branch to pull into, '
573
'rather than the one containing the working directory',
578
takes_args = ['location?']
579
encoding_type = 'replace'
581
def run(self, location=None, remember=False, overwrite=False,
582
revision=None, verbose=False,
584
from bzrlib.tag import _merge_tags_if_possible
585
# FIXME: too much stuff is in the command class
588
if directory is None:
591
tree_to = WorkingTree.open_containing(directory)[0]
592
branch_to = tree_to.branch
593
except errors.NoWorkingTree:
595
branch_to = Branch.open_containing(directory)[0]
598
if location is not None:
600
mergeable = bundle.read_mergeable_from_url(
602
except errors.NotABundle:
603
pass # Continue on considering this url a Branch
605
stored_loc = branch_to.get_parent()
607
if stored_loc is None:
608
raise errors.BzrCommandError("No pull location known or"
611
display_url = urlutils.unescape_for_display(stored_loc,
613
self.outf.write("Using saved location: %s\n" % display_url)
614
location = stored_loc
616
if mergeable is not None:
617
if revision is not None:
618
raise errors.BzrCommandError(
619
'Cannot use -r with merge directives or bundles')
620
revision_id = mergeable.install_revisions(branch_to.repository)
621
branch_from = branch_to
623
branch_from = Branch.open(location)
625
if branch_to.get_parent() is None or remember:
626
branch_to.set_parent(branch_from.base)
628
if revision is not None:
629
if len(revision) == 1:
630
revision_id = revision[0].in_history(branch_from).rev_id
632
raise errors.BzrCommandError(
633
'bzr pull --revision takes one value.')
635
old_rh = branch_to.revision_history()
636
if tree_to is not None:
637
result = tree_to.pull(branch_from, overwrite, revision_id,
638
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
640
result = branch_to.pull(branch_from, overwrite, revision_id)
642
result.report(self.outf)
644
from bzrlib.log import show_changed_revisions
645
new_rh = branch_to.revision_history()
646
show_changed_revisions(branch_to, old_rh, new_rh,
650
class cmd_push(Command):
651
"""Update a mirror of this branch.
653
The target branch will not have its working tree populated because this
654
is both expensive, and is not supported on remote file systems.
656
Some smart servers or protocols *may* put the working tree in place in
659
This command only works on branches that have not diverged. Branches are
660
considered diverged if the destination branch's most recent commit is one
661
that has not been merged (directly or indirectly) by the source branch.
663
If branches have diverged, you can use 'bzr push --overwrite' to replace
664
the other branch completely, discarding its unmerged changes.
666
If you want to ensure you have the different changes in the other branch,
667
do a merge (see bzr help merge) from the other branch, and commit that.
668
After that you will be able to do a push without '--overwrite'.
670
If there is no default push location set, the first push will set it.
671
After that, you can omit the location to use the default. To change the
672
default, use --remember. The value will only be saved if the remote
673
location can be accessed.
676
_see_also = ['pull', 'update', 'working-trees']
677
takes_options = ['remember', 'overwrite', 'verbose',
678
Option('create-prefix',
679
help='Create the path leading up to the branch '
680
'if it does not already exist'),
682
help='branch to push from, '
683
'rather than the one containing the working directory',
687
Option('use-existing-dir',
688
help='By default push will fail if the target'
689
' directory exists, but does not already'
690
' have a control directory. This flag will'
691
' allow push to proceed.'),
693
takes_args = ['location?']
694
encoding_type = 'replace'
696
def run(self, location=None, remember=False, overwrite=False,
697
create_prefix=False, verbose=False,
698
use_existing_dir=False,
700
# FIXME: Way too big! Put this into a function called from the
702
if directory is None:
704
br_from = Branch.open_containing(directory)[0]
705
stored_loc = br_from.get_push_location()
707
if stored_loc is None:
708
raise errors.BzrCommandError("No push location known or specified.")
710
display_url = urlutils.unescape_for_display(stored_loc,
712
self.outf.write("Using saved location: %s\n" % display_url)
713
location = stored_loc
715
to_transport = transport.get_transport(location)
717
br_to = repository_to = dir_to = None
719
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
720
except errors.NotBranchError:
721
pass # Didn't find anything
723
# If we can open a branch, use its direct repository, otherwise see
724
# if there is a repository without a branch.
726
br_to = dir_to.open_branch()
727
except errors.NotBranchError:
728
# Didn't find a branch, can we find a repository?
730
repository_to = dir_to.find_repository()
731
except errors.NoRepositoryPresent:
734
# Found a branch, so we must have found a repository
735
repository_to = br_to.repository
739
# The destination doesn't exist; create it.
740
# XXX: Refactor the create_prefix/no_create_prefix code into a
741
# common helper function
743
to_transport.mkdir('.')
744
except errors.FileExists:
745
if not use_existing_dir:
746
raise errors.BzrCommandError("Target directory %s"
747
" already exists, but does not have a valid .bzr"
748
" directory. Supply --use-existing-dir to push"
749
" there anyway." % location)
750
except errors.NoSuchFile:
751
if not create_prefix:
752
raise errors.BzrCommandError("Parent directory of %s"
754
"\nYou may supply --create-prefix to create all"
755
" leading parent directories."
758
cur_transport = to_transport
759
needed = [cur_transport]
760
# Recurse upwards until we can create a directory successfully
762
new_transport = cur_transport.clone('..')
763
if new_transport.base == cur_transport.base:
764
raise errors.BzrCommandError("Failed to create path"
768
new_transport.mkdir('.')
769
except errors.NoSuchFile:
770
needed.append(new_transport)
771
cur_transport = new_transport
775
# Now we only need to create child directories
777
cur_transport = needed.pop()
778
cur_transport.ensure_base()
780
# Now the target directory exists, but doesn't have a .bzr
781
# directory. So we need to create it, along with any work to create
782
# all of the dependent branches, etc.
783
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
784
revision_id=br_from.last_revision())
785
br_to = dir_to.open_branch()
786
# TODO: Some more useful message about what was copied
787
note('Created new branch.')
788
# We successfully created the target, remember it
789
if br_from.get_push_location() is None or remember:
790
br_from.set_push_location(br_to.base)
791
elif repository_to is None:
792
# we have a bzrdir but no branch or repository
793
# XXX: Figure out what to do other than complain.
794
raise errors.BzrCommandError("At %s you have a valid .bzr control"
795
" directory, but not a branch or repository. This is an"
796
" unsupported configuration. Please move the target directory"
797
" out of the way and try again."
800
# We have a repository but no branch, copy the revisions, and then
802
last_revision_id = br_from.last_revision()
803
repository_to.fetch(br_from.repository,
804
revision_id=last_revision_id)
805
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
806
note('Created new branch.')
807
if br_from.get_push_location() is None or remember:
808
br_from.set_push_location(br_to.base)
809
else: # We have a valid to branch
810
# We were able to connect to the remote location, so remember it
811
# we don't need to successfully push because of possible divergence.
812
if br_from.get_push_location() is None or remember:
813
br_from.set_push_location(br_to.base)
814
old_rh = br_to.revision_history()
817
tree_to = dir_to.open_workingtree()
818
except errors.NotLocalUrl:
819
warning("This transport does not update the working "
820
"tree of: %s. See 'bzr help working-trees' for "
821
"more information." % br_to.base)
822
push_result = br_from.push(br_to, overwrite)
823
except errors.NoWorkingTree:
824
push_result = br_from.push(br_to, overwrite)
828
push_result = br_from.push(tree_to.branch, overwrite)
832
except errors.DivergedBranches:
833
raise errors.BzrCommandError('These branches have diverged.'
834
' Try using "merge" and then "push".')
835
if push_result is not None:
836
push_result.report(self.outf)
838
new_rh = br_to.revision_history()
841
from bzrlib.log import show_changed_revisions
842
show_changed_revisions(br_to, old_rh, new_rh,
845
# we probably did a clone rather than a push, so a message was
850
class cmd_branch(Command):
851
"""Create a new copy of a branch.
853
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
854
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
855
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
856
is derived from the FROM_LOCATION by stripping a leading scheme or drive
857
identifier, if any. For example, "branch lp:foo-bar" will attempt to
860
To retrieve the branch as of a particular revision, supply the --revision
861
parameter, as in "branch foo/bar -r 5".
864
_see_also = ['checkout']
865
takes_args = ['from_location', 'to_location?']
866
takes_options = ['revision']
867
aliases = ['get', 'clone']
869
def run(self, from_location, to_location=None, revision=None):
870
from bzrlib.tag import _merge_tags_if_possible
873
elif len(revision) > 1:
874
raise errors.BzrCommandError(
875
'bzr branch --revision takes exactly 1 revision value')
877
br_from = Branch.open(from_location)
880
if len(revision) == 1 and revision[0] is not None:
881
revision_id = revision[0].in_history(br_from)[1]
883
# FIXME - wt.last_revision, fallback to branch, fall back to
884
# None or perhaps NULL_REVISION to mean copy nothing
886
revision_id = br_from.last_revision()
887
if to_location is None:
888
to_location = urlutils.derive_to_location(from_location)
891
name = os.path.basename(to_location) + '\n'
893
to_transport = transport.get_transport(to_location)
895
to_transport.mkdir('.')
896
except errors.FileExists:
897
raise errors.BzrCommandError('Target directory "%s" already'
898
' exists.' % to_location)
899
except errors.NoSuchFile:
900
raise errors.BzrCommandError('Parent of "%s" does not exist.'
903
# preserve whatever source format we have.
904
dir = br_from.bzrdir.sprout(to_transport.base, revision_id)
905
branch = dir.open_branch()
906
except errors.NoSuchRevision:
907
to_transport.delete_tree('.')
908
msg = "The branch %s has no revision %s." % (from_location, revision[0])
909
raise errors.BzrCommandError(msg)
911
branch.control_files.put_utf8('branch-name', name)
912
_merge_tags_if_possible(br_from, branch)
913
note('Branched %d revision(s).' % branch.revno())
918
class cmd_checkout(Command):
919
"""Create a new checkout of an existing branch.
921
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
922
the branch found in '.'. This is useful if you have removed the working tree
923
or if it was never created - i.e. if you pushed the branch to its current
926
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
927
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
928
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
929
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
930
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
933
To retrieve the branch as of a particular revision, supply the --revision
934
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
935
out of date [so you cannot commit] but it may be useful (i.e. to examine old
939
_see_also = ['checkouts', 'branch']
940
takes_args = ['branch_location?', 'to_location?']
941
takes_options = ['revision',
942
Option('lightweight',
943
help="perform a lightweight checkout. Lightweight "
944
"checkouts depend on access to the branch for "
945
"every operation. Normal checkouts can perform "
946
"common operations like diff and status without "
947
"such access, and also support local commits."
952
def run(self, branch_location=None, to_location=None, revision=None,
956
elif len(revision) > 1:
957
raise errors.BzrCommandError(
958
'bzr checkout --revision takes exactly 1 revision value')
959
if branch_location is None:
960
branch_location = osutils.getcwd()
961
to_location = branch_location
962
source = Branch.open(branch_location)
963
if len(revision) == 1 and revision[0] is not None:
964
revision_id = revision[0].in_history(source)[1]
967
if to_location is None:
968
to_location = urlutils.derive_to_location(branch_location)
969
# if the source and to_location are the same,
970
# and there is no working tree,
971
# then reconstitute a branch
972
if (osutils.abspath(to_location) ==
973
osutils.abspath(branch_location)):
975
source.bzrdir.open_workingtree()
976
except errors.NoWorkingTree:
977
source.bzrdir.create_workingtree()
980
os.mkdir(to_location)
982
if e.errno == errno.EEXIST:
983
raise errors.BzrCommandError('Target directory "%s" already'
984
' exists.' % to_location)
985
if e.errno == errno.ENOENT:
986
raise errors.BzrCommandError('Parent of "%s" does not exist.'
990
source.create_checkout(to_location, revision_id, lightweight)
993
class cmd_renames(Command):
994
"""Show list of renamed files.
996
# TODO: Option to show renames between two historical versions.
998
# TODO: Only show renames under dir, rather than in the whole branch.
999
_see_also = ['status']
1000
takes_args = ['dir?']
1003
def run(self, dir=u'.'):
1004
tree = WorkingTree.open_containing(dir)[0]
1007
new_inv = tree.inventory
1008
old_tree = tree.basis_tree()
1009
old_tree.lock_read()
1011
old_inv = old_tree.inventory
1012
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1014
for old_name, new_name in renames:
1015
self.outf.write("%s => %s\n" % (old_name, new_name))
1022
class cmd_update(Command):
1023
"""Update a tree to have the latest code committed to its branch.
1025
This will perform a merge into the working tree, and may generate
1026
conflicts. If you have any local changes, you will still
1027
need to commit them after the update for the update to be complete.
1029
If you want to discard your local changes, you can just do a
1030
'bzr revert' instead of 'bzr commit' after the update.
1033
_see_also = ['pull', 'working-trees']
1034
takes_args = ['dir?']
1037
def run(self, dir='.'):
1038
tree = WorkingTree.open_containing(dir)[0]
1039
master = tree.branch.get_master_branch()
1040
if master is not None:
1043
tree.lock_tree_write()
1045
existing_pending_merges = tree.get_parent_ids()[1:]
1046
last_rev = tree.last_revision()
1047
if last_rev == tree.branch.last_revision():
1048
# may be up to date, check master too.
1049
master = tree.branch.get_master_branch()
1050
if master is None or last_rev == master.last_revision():
1051
revno = tree.branch.revision_id_to_revno(last_rev)
1052
note("Tree is up to date at revision %d." % (revno,))
1054
conflicts = tree.update()
1055
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1056
note('Updated to revision %d.' % (revno,))
1057
if tree.get_parent_ids()[1:] != existing_pending_merges:
1058
note('Your local commits will now show as pending merges with '
1059
"'bzr status', and can be committed with 'bzr commit'.")
1068
class cmd_info(Command):
1069
"""Show information about a working tree, branch or repository.
1071
This command will show all known locations and formats associated to the
1072
tree, branch or repository. Statistical information is included with
1075
Branches and working trees will also report any missing revisions.
1077
_see_also = ['revno', 'working-trees', 'repositories']
1078
takes_args = ['location?']
1079
takes_options = ['verbose']
1082
def run(self, location=None, verbose=False):
1083
from bzrlib.info import show_bzrdir_info
1084
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1088
class cmd_remove(Command):
1089
"""Remove files or directories.
1091
This makes bzr stop tracking changes to the specified files and
1092
delete them if they can easily be recovered using revert.
1094
You can specify one or more files, and/or --new. If you specify --new,
1095
only 'added' files will be removed. If you specify both, then new files
1096
in the specified directories will be removed. If the directories are
1097
also new, they will also be removed.
1099
takes_args = ['file*']
1100
takes_options = ['verbose',
1101
Option('new', help='remove newly-added files'),
1102
RegistryOption.from_kwargs('file-deletion-strategy',
1103
'The file deletion mode to be used',
1104
title='Deletion Strategy', value_switches=True, enum_switch=False,
1105
safe='Only delete files if they can be'
1106
' safely recovered (default).',
1107
keep="Don't delete any files.",
1108
force='Delete all the specified files, even if they can not be '
1109
'recovered and even if they are non-empty directories.')]
1111
encoding_type = 'replace'
1113
def run(self, file_list, verbose=False, new=False,
1114
file_deletion_strategy='safe'):
1115
tree, file_list = tree_files(file_list)
1117
if file_list is not None:
1118
file_list = [f for f in file_list if f != '']
1120
raise errors.BzrCommandError('Specify one or more files to'
1121
' remove, or use --new.')
1124
added = tree.changes_from(tree.basis_tree(),
1125
specific_files=file_list).added
1126
file_list = sorted([f[0] for f in added], reverse=True)
1127
if len(file_list) == 0:
1128
raise errors.BzrCommandError('No matching files.')
1129
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1130
keep_files=file_deletion_strategy=='keep',
1131
force=file_deletion_strategy=='force')
1134
class cmd_file_id(Command):
1135
"""Print file_id of a particular file or directory.
1137
The file_id is assigned when the file is first added and remains the
1138
same through all revisions where the file exists, even when it is
1143
_see_also = ['inventory', 'ls']
1144
takes_args = ['filename']
1147
def run(self, filename):
1148
tree, relpath = WorkingTree.open_containing(filename)
1149
i = tree.path2id(relpath)
1151
raise errors.NotVersionedError(filename)
1153
self.outf.write(i + '\n')
1156
class cmd_file_path(Command):
1157
"""Print path of file_ids to a file or directory.
1159
This prints one line for each directory down to the target,
1160
starting at the branch root.
1164
takes_args = ['filename']
1167
def run(self, filename):
1168
tree, relpath = WorkingTree.open_containing(filename)
1169
fid = tree.path2id(relpath)
1171
raise errors.NotVersionedError(filename)
1172
segments = osutils.splitpath(relpath)
1173
for pos in range(1, len(segments) + 1):
1174
path = osutils.joinpath(segments[:pos])
1175
self.outf.write("%s\n" % tree.path2id(path))
1178
class cmd_reconcile(Command):
1179
"""Reconcile bzr metadata in a branch.
1181
This can correct data mismatches that may have been caused by
1182
previous ghost operations or bzr upgrades. You should only
1183
need to run this command if 'bzr check' or a bzr developer
1184
advises you to run it.
1186
If a second branch is provided, cross-branch reconciliation is
1187
also attempted, which will check that data like the tree root
1188
id which was not present in very early bzr versions is represented
1189
correctly in both branches.
1191
At the same time it is run it may recompress data resulting in
1192
a potential saving in disk space or performance gain.
1194
The branch *MUST* be on a listable system such as local disk or sftp.
1197
_see_also = ['check']
1198
takes_args = ['branch?']
1200
def run(self, branch="."):
1201
from bzrlib.reconcile import reconcile
1202
dir = bzrdir.BzrDir.open(branch)
1206
class cmd_revision_history(Command):
1207
"""Display the list of revision ids on a branch."""
1210
takes_args = ['location?']
1215
def run(self, location="."):
1216
branch = Branch.open_containing(location)[0]
1217
for revid in branch.revision_history():
1218
self.outf.write(revid)
1219
self.outf.write('\n')
1222
class cmd_ancestry(Command):
1223
"""List all revisions merged into this branch."""
1225
_see_also = ['log', 'revision-history']
1226
takes_args = ['location?']
1231
def run(self, location="."):
1233
wt = WorkingTree.open_containing(location)[0]
1234
except errors.NoWorkingTree:
1235
b = Branch.open(location)
1236
last_revision = b.last_revision()
1239
last_revision = wt.last_revision()
1241
revision_ids = b.repository.get_ancestry(last_revision)
1242
assert revision_ids[0] is None
1244
for revision_id in revision_ids:
1245
self.outf.write(revision_id + '\n')
1248
class cmd_init(Command):
1249
"""Make a directory into a versioned branch.
1251
Use this to create an empty branch, or before importing an
1254
If there is a repository in a parent directory of the location, then
1255
the history of the branch will be stored in the repository. Otherwise
1256
init creates a standalone branch which carries its own history
1257
in the .bzr directory.
1259
If there is already a branch at the location but it has no working tree,
1260
the tree can be populated with 'bzr checkout'.
1262
Recipe for importing a tree of files:
1267
bzr commit -m 'imported project'
1270
_see_also = ['init-repo', 'branch', 'checkout']
1271
takes_args = ['location?']
1273
RegistryOption('format',
1274
help='Specify a format for this branch. '
1275
'See "help formats".',
1276
registry=bzrdir.format_registry,
1277
converter=bzrdir.format_registry.make_bzrdir,
1278
value_switches=True,
1279
title="Branch Format",
1281
Option('append-revisions-only',
1282
help='Never change revnos or the existing log.'
1283
' Append revisions to it only.')
1285
def run(self, location=None, format=None, append_revisions_only=False):
1287
format = bzrdir.format_registry.make_bzrdir('default')
1288
if location is None:
1291
to_transport = transport.get_transport(location)
1293
# The path has to exist to initialize a
1294
# branch inside of it.
1295
# Just using os.mkdir, since I don't
1296
# believe that we want to create a bunch of
1297
# locations if the user supplies an extended path
1298
# TODO: create-prefix
1299
to_transport.ensure_base()
1302
existing_bzrdir = bzrdir.BzrDir.open(location)
1303
except errors.NotBranchError:
1304
# really a NotBzrDir error...
1305
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1308
from bzrlib.transport.local import LocalTransport
1309
if existing_bzrdir.has_branch():
1310
if (isinstance(to_transport, LocalTransport)
1311
and not existing_bzrdir.has_workingtree()):
1312
raise errors.BranchExistsWithoutWorkingTree(location)
1313
raise errors.AlreadyBranchError(location)
1315
branch = existing_bzrdir.create_branch()
1316
existing_bzrdir.create_workingtree()
1317
if append_revisions_only:
1319
branch.set_append_revisions_only(True)
1320
except errors.UpgradeRequired:
1321
raise errors.BzrCommandError('This branch format cannot be set'
1322
' to append-revisions-only. Try --experimental-branch6')
1325
class cmd_init_repository(Command):
1326
"""Create a shared repository to hold branches.
1328
New branches created under the repository directory will store their
1329
revisions in the repository, not in the branch directory.
1331
If the --no-trees option is used then the branches in the repository
1332
will not have working trees by default.
1335
bzr init-repo --no-trees repo
1337
bzr checkout --lightweight repo/trunk trunk-checkout
1341
See 'bzr help repositories' for more information.
1344
_see_also = ['init', 'branch', 'checkout']
1345
takes_args = ["location"]
1346
takes_options = [RegistryOption('format',
1347
help='Specify a format for this repository. See'
1348
' "bzr help formats" for details',
1349
registry=bzrdir.format_registry,
1350
converter=bzrdir.format_registry.make_bzrdir,
1351
value_switches=True, title='Repository format'),
1353
help='Branches in the repository will default to'
1354
' not having a working tree'),
1356
aliases = ["init-repo"]
1358
def run(self, location, format=None, no_trees=False):
1360
format = bzrdir.format_registry.make_bzrdir('default')
1362
if location is None:
1365
to_transport = transport.get_transport(location)
1366
to_transport.ensure_base()
1368
newdir = format.initialize_on_transport(to_transport)
1369
repo = newdir.create_repository(shared=True)
1370
repo.set_make_working_trees(not no_trees)
1373
class cmd_diff(Command):
1374
"""Show differences in the working tree or between revisions.
1376
If files are listed, only the changes in those files are listed.
1377
Otherwise, all changes for the tree are listed.
1379
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1380
produces patches suitable for "patch -p1".
1384
Shows the difference in the working tree versus the last commit
1386
Difference between the working tree and revision 1
1388
Difference between revision 2 and revision 1
1389
bzr diff --prefix old/:new/
1390
Same as 'bzr diff' but prefix paths with old/ and new/
1391
bzr diff bzr.mine bzr.dev
1392
Show the differences between the two working trees
1394
Show just the differences for 'foo.c'
1396
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1397
# or a graphical diff.
1399
# TODO: Python difflib is not exactly the same as unidiff; should
1400
# either fix it up or prefer to use an external diff.
1402
# TODO: Selected-file diff is inefficient and doesn't show you
1405
# TODO: This probably handles non-Unix newlines poorly.
1407
_see_also = ['status']
1408
takes_args = ['file*']
1409
takes_options = ['revision', 'diff-options',
1410
Option('prefix', type=str,
1412
help='Set prefixes to added to old and new filenames, as '
1413
'two values separated by a colon. (eg "old/:new/")'),
1415
aliases = ['di', 'dif']
1416
encoding_type = 'exact'
1419
def run(self, revision=None, file_list=None, diff_options=None,
1421
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1423
if (prefix is None) or (prefix == '0'):
1431
old_label, new_label = prefix.split(":")
1433
raise errors.BzrCommandError(
1434
'--prefix expects two values separated by a colon'
1435
' (eg "old/:new/")')
1437
if revision and len(revision) > 2:
1438
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1439
' one or two revision specifiers')
1442
tree1, file_list = internal_tree_files(file_list)
1446
except errors.FileInWrongBranch:
1447
if len(file_list) != 2:
1448
raise errors.BzrCommandError("Files are in different branches")
1450
tree1, file1 = WorkingTree.open_containing(file_list[0])
1451
tree2, file2 = WorkingTree.open_containing(file_list[1])
1452
if file1 != "" or file2 != "":
1453
# FIXME diff those two files. rbc 20051123
1454
raise errors.BzrCommandError("Files are in different branches")
1456
except errors.NotBranchError:
1457
if (revision is not None and len(revision) == 2
1458
and not revision[0].needs_branch()
1459
and not revision[1].needs_branch()):
1460
# If both revision specs include a branch, we can
1461
# diff them without needing a local working tree
1462
tree1, tree2 = None, None
1466
if tree2 is not None:
1467
if revision is not None:
1468
# FIXME: but there should be a clean way to diff between
1469
# non-default versions of two trees, it's not hard to do
1471
raise errors.BzrCommandError(
1472
"Sorry, diffing arbitrary revisions across branches "
1473
"is not implemented yet")
1474
return show_diff_trees(tree1, tree2, sys.stdout,
1475
specific_files=file_list,
1476
external_diff_options=diff_options,
1477
old_label=old_label, new_label=new_label)
1479
return diff_cmd_helper(tree1, file_list, diff_options,
1480
revision_specs=revision,
1481
old_label=old_label, new_label=new_label)
1484
class cmd_deleted(Command):
1485
"""List files deleted in the working tree.
1487
# TODO: Show files deleted since a previous revision, or
1488
# between two revisions.
1489
# TODO: Much more efficient way to do this: read in new
1490
# directories with readdir, rather than stating each one. Same
1491
# level of effort but possibly much less IO. (Or possibly not,
1492
# if the directories are very large...)
1493
_see_also = ['status', 'ls']
1494
takes_options = ['show-ids']
1497
def run(self, show_ids=False):
1498
tree = WorkingTree.open_containing(u'.')[0]
1501
old = tree.basis_tree()
1504
for path, ie in old.inventory.iter_entries():
1505
if not tree.has_id(ie.file_id):
1506
self.outf.write(path)
1508
self.outf.write(' ')
1509
self.outf.write(ie.file_id)
1510
self.outf.write('\n')
1517
class cmd_modified(Command):
1518
"""List files modified in working tree.
1522
_see_also = ['status', 'ls']
1526
tree = WorkingTree.open_containing(u'.')[0]
1527
td = tree.changes_from(tree.basis_tree())
1528
for path, id, kind, text_modified, meta_modified in td.modified:
1529
self.outf.write(path + '\n')
1532
class cmd_added(Command):
1533
"""List files added in working tree.
1537
_see_also = ['status', 'ls']
1541
wt = WorkingTree.open_containing(u'.')[0]
1544
basis = wt.basis_tree()
1547
basis_inv = basis.inventory
1550
if file_id in basis_inv:
1552
if inv.is_root(file_id) and len(basis_inv) == 0:
1554
path = inv.id2path(file_id)
1555
if not os.access(osutils.abspath(path), os.F_OK):
1557
self.outf.write(path + '\n')
1564
class cmd_root(Command):
1565
"""Show the tree root directory.
1567
The root is the nearest enclosing directory with a .bzr control
1570
takes_args = ['filename?']
1572
def run(self, filename=None):
1573
"""Print the branch root."""
1574
tree = WorkingTree.open_containing(filename)[0]
1575
self.outf.write(tree.basedir + '\n')
1578
def _parse_limit(limitstring):
1580
return int(limitstring)
1582
msg = "The limit argument must be an integer."
1583
raise errors.BzrCommandError(msg)
1586
class cmd_log(Command):
1587
"""Show log of a branch, file, or directory.
1589
By default show the log of the branch containing the working directory.
1591
To request a range of logs, you can use the command -r begin..end
1592
-r revision requests a specific revision, -r ..end or -r begin.. are
1598
bzr log -r -10.. http://server/branch
1601
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1603
takes_args = ['location?']
1604
takes_options = [Option('forward',
1605
help='show from oldest to newest'),
1609
help='show files changed in each revision'),
1610
'show-ids', 'revision',
1614
help='show revisions whose message matches this regexp',
1617
help='limit the output to the first N revisions',
1620
encoding_type = 'replace'
1623
def run(self, location=None, timezone='original',
1631
from bzrlib.log import show_log
1632
assert message is None or isinstance(message, basestring), \
1633
"invalid message argument %r" % message
1634
direction = (forward and 'forward') or 'reverse'
1639
# find the file id to log:
1641
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1645
tree = b.basis_tree()
1646
file_id = tree.path2id(fp)
1648
raise errors.BzrCommandError(
1649
"Path does not have any revision history: %s" %
1653
# FIXME ? log the current subdir only RBC 20060203
1654
if revision is not None \
1655
and len(revision) > 0 and revision[0].get_branch():
1656
location = revision[0].get_branch()
1659
dir, relpath = bzrdir.BzrDir.open_containing(location)
1660
b = dir.open_branch()
1664
if revision is None:
1667
elif len(revision) == 1:
1668
rev1 = rev2 = revision[0].in_history(b).revno
1669
elif len(revision) == 2:
1670
if revision[1].get_branch() != revision[0].get_branch():
1671
# b is taken from revision[0].get_branch(), and
1672
# show_log will use its revision_history. Having
1673
# different branches will lead to weird behaviors.
1674
raise errors.BzrCommandError(
1675
"Log doesn't accept two revisions in different"
1677
if revision[0].spec is None:
1678
# missing begin-range means first revision
1681
rev1 = revision[0].in_history(b).revno
1683
if revision[1].spec is None:
1684
# missing end-range means last known revision
1687
rev2 = revision[1].in_history(b).revno
1689
raise errors.BzrCommandError(
1690
'bzr log --revision takes one or two values.')
1692
# By this point, the revision numbers are converted to the +ve
1693
# form if they were supplied in the -ve form, so we can do
1694
# this comparison in relative safety
1696
(rev2, rev1) = (rev1, rev2)
1698
if log_format is None:
1699
log_format = log.log_formatter_registry.get_default(b)
1701
lf = log_format(show_ids=show_ids, to_file=self.outf,
1702
show_timezone=timezone)
1708
direction=direction,
1709
start_revision=rev1,
1717
def get_log_format(long=False, short=False, line=False, default='long'):
1718
log_format = default
1722
log_format = 'short'
1728
class cmd_touching_revisions(Command):
1729
"""Return revision-ids which affected a particular file.
1731
A more user-friendly interface is "bzr log FILE".
1735
takes_args = ["filename"]
1738
def run(self, filename):
1739
tree, relpath = WorkingTree.open_containing(filename)
1741
file_id = tree.path2id(relpath)
1742
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1743
self.outf.write("%6d %s\n" % (revno, what))
1746
class cmd_ls(Command):
1747
"""List files in a tree.
1750
_see_also = ['status', 'cat']
1751
takes_args = ['path?']
1752
# TODO: Take a revision or remote path and list that tree instead.
1753
takes_options = ['verbose', 'revision',
1754
Option('non-recursive',
1755
help='don\'t recurse into sub-directories'),
1757
help='Print all paths from the root of the branch.'),
1758
Option('unknown', help='Print unknown files'),
1759
Option('versioned', help='Print versioned files'),
1760
Option('ignored', help='Print ignored files'),
1762
Option('null', help='Null separate the files'),
1766
def run(self, revision=None, verbose=False,
1767
non_recursive=False, from_root=False,
1768
unknown=False, versioned=False, ignored=False,
1769
null=False, kind=None, show_ids=False, path=None):
1771
if kind and kind not in ('file', 'directory', 'symlink'):
1772
raise errors.BzrCommandError('invalid kind specified')
1774
if verbose and null:
1775
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1776
all = not (unknown or versioned or ignored)
1778
selection = {'I':ignored, '?':unknown, 'V':versioned}
1785
raise errors.BzrCommandError('cannot specify both --from-root'
1789
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1795
if revision is not None:
1796
tree = branch.repository.revision_tree(
1797
revision[0].in_history(branch).rev_id)
1799
tree = branch.basis_tree()
1803
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1804
if fp.startswith(relpath):
1805
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1806
if non_recursive and '/' in fp:
1808
if not all and not selection[fc]:
1810
if kind is not None and fkind != kind:
1813
kindch = entry.kind_character()
1814
outstring = '%-8s %s%s' % (fc, fp, kindch)
1815
if show_ids and fid is not None:
1816
outstring = "%-50s %s" % (outstring, fid)
1817
self.outf.write(outstring + '\n')
1819
self.outf.write(fp + '\0')
1822
self.outf.write(fid)
1823
self.outf.write('\0')
1831
self.outf.write('%-50s %s\n' % (fp, my_id))
1833
self.outf.write(fp + '\n')
1838
class cmd_unknowns(Command):
1839
"""List unknown files.
1847
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1848
self.outf.write(osutils.quotefn(f) + '\n')
1851
class cmd_ignore(Command):
1852
"""Ignore specified files or patterns.
1854
To remove patterns from the ignore list, edit the .bzrignore file.
1856
Trailing slashes on patterns are ignored.
1857
If the pattern contains a slash or is a regular expression, it is compared
1858
to the whole path from the branch root. Otherwise, it is compared to only
1859
the last component of the path. To match a file only in the root
1860
directory, prepend './'.
1862
Ignore patterns specifying absolute paths are not allowed.
1864
Ignore patterns may include globbing wildcards such as:
1865
? - Matches any single character except '/'
1866
* - Matches 0 or more characters except '/'
1867
/**/ - Matches 0 or more directories in a path
1868
[a-z] - Matches a single character from within a group of characters
1870
Ignore patterns may also be Python regular expressions.
1871
Regular expression ignore patterns are identified by a 'RE:' prefix
1872
followed by the regular expression. Regular expression ignore patterns
1873
may not include named or numbered groups.
1875
Note: ignore patterns containing shell wildcards must be quoted from
1879
bzr ignore ./Makefile
1880
bzr ignore '*.class'
1881
bzr ignore 'lib/**/*.o'
1882
bzr ignore 'RE:lib/.*\.o'
1885
_see_also = ['status', 'ignored']
1886
takes_args = ['name_pattern*']
1888
Option('old-default-rules',
1889
help='Out the ignore rules bzr < 0.9 always used.')
1892
def run(self, name_pattern_list=None, old_default_rules=None):
1893
from bzrlib.atomicfile import AtomicFile
1894
if old_default_rules is not None:
1895
# dump the rules and exit
1896
for pattern in ignores.OLD_DEFAULTS:
1899
if not name_pattern_list:
1900
raise errors.BzrCommandError("ignore requires at least one "
1901
"NAME_PATTERN or --old-default-rules")
1902
name_pattern_list = [globbing.normalize_pattern(p)
1903
for p in name_pattern_list]
1904
for name_pattern in name_pattern_list:
1905
if (name_pattern[0] == '/' or
1906
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1907
raise errors.BzrCommandError(
1908
"NAME_PATTERN should not be an absolute path")
1909
tree, relpath = WorkingTree.open_containing(u'.')
1910
ifn = tree.abspath('.bzrignore')
1911
if os.path.exists(ifn):
1914
igns = f.read().decode('utf-8')
1920
# TODO: If the file already uses crlf-style termination, maybe
1921
# we should use that for the newly added lines?
1923
if igns and igns[-1] != '\n':
1925
for name_pattern in name_pattern_list:
1926
igns += name_pattern + '\n'
1928
f = AtomicFile(ifn, 'wb')
1930
f.write(igns.encode('utf-8'))
1935
if not tree.path2id('.bzrignore'):
1936
tree.add(['.bzrignore'])
1939
class cmd_ignored(Command):
1940
"""List ignored files and the patterns that matched them.
1943
_see_also = ['ignore']
1946
tree = WorkingTree.open_containing(u'.')[0]
1949
for path, file_class, kind, file_id, entry in tree.list_files():
1950
if file_class != 'I':
1952
## XXX: Slightly inefficient since this was already calculated
1953
pat = tree.is_ignored(path)
1954
print '%-50s %s' % (path, pat)
1959
class cmd_lookup_revision(Command):
1960
"""Lookup the revision-id from a revision-number
1963
bzr lookup-revision 33
1966
takes_args = ['revno']
1969
def run(self, revno):
1973
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1975
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1978
class cmd_export(Command):
1979
"""Export current or past revision to a destination directory or archive.
1981
If no revision is specified this exports the last committed revision.
1983
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1984
given, try to find the format with the extension. If no extension
1985
is found exports to a directory (equivalent to --format=dir).
1987
If root is supplied, it will be used as the root directory inside
1988
container formats (tar, zip, etc). If it is not supplied it will default
1989
to the exported filename. The root option has no effect for 'dir' format.
1991
If branch is omitted then the branch containing the current working
1992
directory will be used.
1994
Note: Export of tree with non-ASCII filenames to zip is not supported.
1996
Supported formats Autodetected by extension
1997
----------------- -------------------------
2000
tbz2 .tar.bz2, .tbz2
2004
takes_args = ['dest', 'branch?']
2005
takes_options = ['revision', 'format', 'root']
2006
def run(self, dest, branch=None, revision=None, format=None, root=None):
2007
from bzrlib.export import export
2010
tree = WorkingTree.open_containing(u'.')[0]
2013
b = Branch.open(branch)
2015
if revision is None:
2016
# should be tree.last_revision FIXME
2017
rev_id = b.last_revision()
2019
if len(revision) != 1:
2020
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2021
rev_id = revision[0].in_history(b).rev_id
2022
t = b.repository.revision_tree(rev_id)
2024
export(t, dest, format, root)
2025
except errors.NoSuchExportFormat, e:
2026
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2029
class cmd_cat(Command):
2030
"""Write the contents of a file as of a given revision to standard output.
2032
If no revision is nominated, the last revision is used.
2034
Note: Take care to redirect standard output when using this command on a
2039
takes_options = ['revision', 'name-from-revision']
2040
takes_args = ['filename']
2041
encoding_type = 'exact'
2044
def run(self, filename, revision=None, name_from_revision=False):
2045
if revision is not None and len(revision) != 1:
2046
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2051
tree, b, relpath = \
2052
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2053
except errors.NotBranchError:
2056
if revision is not None and revision[0].get_branch() is not None:
2057
b = Branch.open(revision[0].get_branch())
2059
tree = b.basis_tree()
2060
if revision is None:
2061
revision_id = b.last_revision()
2063
revision_id = revision[0].in_history(b).rev_id
2065
cur_file_id = tree.path2id(relpath)
2066
rev_tree = b.repository.revision_tree(revision_id)
2067
old_file_id = rev_tree.path2id(relpath)
2069
if name_from_revision:
2070
if old_file_id is None:
2071
raise errors.BzrCommandError("%r is not present in revision %s"
2072
% (filename, revision_id))
2074
rev_tree.print_file(old_file_id)
2075
elif cur_file_id is not None:
2076
rev_tree.print_file(cur_file_id)
2077
elif old_file_id is not None:
2078
rev_tree.print_file(old_file_id)
2080
raise errors.BzrCommandError("%r is not present in revision %s" %
2081
(filename, revision_id))
2084
class cmd_local_time_offset(Command):
2085
"""Show the offset in seconds from GMT to local time."""
2089
print osutils.local_time_offset()
2093
class cmd_commit(Command):
2094
"""Commit changes into a new revision.
2096
If no arguments are given, the entire tree is committed.
2098
If selected files are specified, only changes to those files are
2099
committed. If a directory is specified then the directory and everything
2100
within it is committed.
2102
A selected-file commit may fail in some cases where the committed
2103
tree would be invalid. Consider::
2108
bzr commit foo -m "committing foo"
2109
bzr mv foo/bar foo/baz
2112
bzr commit foo/bar -m "committing bar but not baz"
2114
In the example above, the last commit will fail by design. This gives
2115
the user the opportunity to decide whether they want to commit the
2116
rename at the same time, separately first, or not at all. (As a general
2117
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2119
Note: A selected-file commit after a merge is not yet supported.
2121
# TODO: Run hooks on tree to-be-committed, and after commit.
2123
# TODO: Strict commit that fails if there are deleted files.
2124
# (what does "deleted files" mean ??)
2126
# TODO: Give better message for -s, --summary, used by tla people
2128
# XXX: verbose currently does nothing
2130
_see_also = ['bugs', 'uncommit']
2131
takes_args = ['selected*']
2132
takes_options = ['message', 'verbose',
2134
help='commit even if nothing has changed'),
2135
Option('file', type=str,
2138
help='file containing commit message'),
2140
help="refuse to commit if there are unknown "
2141
"files in the working tree."),
2142
ListOption('fixes', type=str,
2143
help="mark a bug as being fixed by this "
2146
help="perform a local only commit in a bound "
2147
"branch. Such commits are not pushed to "
2148
"the master branch until a normal commit "
2152
aliases = ['ci', 'checkin']
2154
def _get_bug_fix_properties(self, fixes, branch):
2156
# Configure the properties for bug fixing attributes.
2157
for fixed_bug in fixes:
2158
tokens = fixed_bug.split(':')
2159
if len(tokens) != 2:
2160
raise errors.BzrCommandError(
2161
"Invalid bug %s. Must be in the form of 'tag:id'. "
2162
"Commit refused." % fixed_bug)
2163
tag, bug_id = tokens
2165
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2166
except errors.UnknownBugTrackerAbbreviation:
2167
raise errors.BzrCommandError(
2168
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2169
except errors.MalformedBugIdentifier:
2170
raise errors.BzrCommandError(
2171
"Invalid bug identifier for %s. Commit refused."
2173
properties.append('%s fixed' % bug_url)
2174
return '\n'.join(properties)
2176
def run(self, message=None, file=None, verbose=True, selected_list=None,
2177
unchanged=False, strict=False, local=False, fixes=None):
2178
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2179
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2181
from bzrlib.msgeditor import edit_commit_message, \
2182
make_commit_message_template
2184
# TODO: Need a blackbox test for invoking the external editor; may be
2185
# slightly problematic to run this cross-platform.
2187
# TODO: do more checks that the commit will succeed before
2188
# spending the user's valuable time typing a commit message.
2192
tree, selected_list = tree_files(selected_list)
2193
if selected_list == ['']:
2194
# workaround - commit of root of tree should be exactly the same
2195
# as just default commit in that tree, and succeed even though
2196
# selected-file merge commit is not done yet
2199
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2201
properties['bugs'] = bug_property
2203
if local and not tree.branch.get_bound_location():
2204
raise errors.LocalRequiresBoundBranch()
2206
def get_message(commit_obj):
2207
"""Callback to get commit message"""
2208
my_message = message
2209
if my_message is None and not file:
2210
template = make_commit_message_template(tree, selected_list)
2211
my_message = edit_commit_message(template)
2212
if my_message is None:
2213
raise errors.BzrCommandError("please specify a commit"
2214
" message with either --message or --file")
2215
elif my_message and file:
2216
raise errors.BzrCommandError(
2217
"please specify either --message or --file")
2219
my_message = codecs.open(file, 'rt',
2220
bzrlib.user_encoding).read()
2221
if my_message == "":
2222
raise errors.BzrCommandError("empty commit message specified")
2226
reporter = ReportCommitToLog()
2228
reporter = NullCommitReporter()
2231
tree.commit(message_callback=get_message,
2232
specific_files=selected_list,
2233
allow_pointless=unchanged, strict=strict, local=local,
2234
reporter=reporter, revprops=properties)
2235
except PointlessCommit:
2236
# FIXME: This should really happen before the file is read in;
2237
# perhaps prepare the commit; get the message; then actually commit
2238
raise errors.BzrCommandError("no changes to commit."
2239
" use --unchanged to commit anyhow")
2240
except ConflictsInTree:
2241
raise errors.BzrCommandError('Conflicts detected in working '
2242
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2244
except StrictCommitFailed:
2245
raise errors.BzrCommandError("Commit refused because there are"
2246
" unknown files in the working tree.")
2247
except errors.BoundBranchOutOfDate, e:
2248
raise errors.BzrCommandError(str(e) + "\n"
2249
'To commit to master branch, run update and then commit.\n'
2250
'You can also pass --local to commit to continue working '
2254
class cmd_check(Command):
2255
"""Validate consistency of branch history.
2257
This command checks various invariants about the branch storage to
2258
detect data corruption or bzr bugs.
2261
_see_also = ['reconcile']
2262
takes_args = ['branch?']
2263
takes_options = ['verbose']
2265
def run(self, branch=None, verbose=False):
2266
from bzrlib.check import check
2268
tree = WorkingTree.open_containing()[0]
2269
branch = tree.branch
2271
branch = Branch.open(branch)
2272
check(branch, verbose)
2275
class cmd_upgrade(Command):
2276
"""Upgrade branch storage to current format.
2278
The check command or bzr developers may sometimes advise you to run
2279
this command. When the default format has changed you may also be warned
2280
during other operations to upgrade.
2283
_see_also = ['check']
2284
takes_args = ['url?']
2286
RegistryOption('format',
2287
help='Upgrade to a specific format. See "bzr help'
2288
' formats" for details',
2289
registry=bzrdir.format_registry,
2290
converter=bzrdir.format_registry.make_bzrdir,
2291
value_switches=True, title='Branch format'),
2294
def run(self, url='.', format=None):
2295
from bzrlib.upgrade import upgrade
2297
format = bzrdir.format_registry.make_bzrdir('default')
2298
upgrade(url, format)
2301
class cmd_whoami(Command):
2302
"""Show or set bzr user id.
2306
bzr whoami 'Frank Chu <fchu@example.com>'
2308
takes_options = [ Option('email',
2309
help='display email address only'),
2311
help='set identity for the current branch instead of '
2314
takes_args = ['name?']
2315
encoding_type = 'replace'
2318
def run(self, email=False, branch=False, name=None):
2320
# use branch if we're inside one; otherwise global config
2322
c = Branch.open_containing('.')[0].get_config()
2323
except errors.NotBranchError:
2324
c = config.GlobalConfig()
2326
self.outf.write(c.user_email() + '\n')
2328
self.outf.write(c.username() + '\n')
2331
# display a warning if an email address isn't included in the given name.
2333
config.extract_email_address(name)
2334
except errors.NoEmailInUsername, e:
2335
warning('"%s" does not seem to contain an email address. '
2336
'This is allowed, but not recommended.', name)
2338
# use global config unless --branch given
2340
c = Branch.open_containing('.')[0].get_config()
2342
c = config.GlobalConfig()
2343
c.set_user_option('email', name)
2346
class cmd_nick(Command):
2347
"""Print or set the branch nickname.
2349
If unset, the tree root directory name is used as the nickname
2350
To print the current nickname, execute with no argument.
2353
_see_also = ['info']
2354
takes_args = ['nickname?']
2355
def run(self, nickname=None):
2356
branch = Branch.open_containing(u'.')[0]
2357
if nickname is None:
2358
self.printme(branch)
2360
branch.nick = nickname
2363
def printme(self, branch):
2367
class cmd_selftest(Command):
2368
"""Run internal test suite.
2370
This creates temporary test directories in the working directory, but no
2371
existing data is affected. These directories are deleted if the tests
2372
pass, or left behind to help in debugging if they fail and --keep-output
2375
If arguments are given, they are regular expressions that say which tests
2376
should run. Tests matching any expression are run, and other tests are
2379
Alternatively if --first is given, matching tests are run first and then
2380
all other tests are run. This is useful if you have been working in a
2381
particular area, but want to make sure nothing else was broken.
2383
If --exclude is given, tests that match that regular expression are
2384
excluded, regardless of whether they match --first or not.
2386
To help catch accidential dependencies between tests, the --randomize
2387
option is useful. In most cases, the argument used is the word 'now'.
2388
Note that the seed used for the random number generator is displayed
2389
when this option is used. The seed can be explicitly passed as the
2390
argument to this option if required. This enables reproduction of the
2391
actual ordering used if and when an order sensitive problem is encountered.
2393
If --list-only is given, the tests that would be run are listed. This is
2394
useful when combined with --first, --exclude and/or --randomize to
2395
understand their impact. The test harness reports "Listed nn tests in ..."
2396
instead of "Ran nn tests in ..." when list mode is enabled.
2398
If the global option '--no-plugins' is given, plugins are not loaded
2399
before running the selftests. This has two effects: features provided or
2400
modified by plugins will not be tested, and tests provided by plugins will
2405
run only tests relating to 'ignore'
2406
bzr --no-plugins selftest -v
2407
disable plugins and list tests as they're run
2409
For each test, that needs actual disk access, bzr create their own
2410
subdirectory in the temporary testing directory (testXXXX.tmp).
2411
By default the name of such subdirectory is based on the name of the test.
2412
If option '--numbered-dirs' is given, bzr will use sequent numbers
2413
of running tests to create such subdirectories. This is default behavior
2414
on Windows because of path length limitation.
2416
# NB: this is used from the class without creating an instance, which is
2417
# why it does not have a self parameter.
2418
def get_transport_type(typestring):
2419
"""Parse and return a transport specifier."""
2420
if typestring == "sftp":
2421
from bzrlib.transport.sftp import SFTPAbsoluteServer
2422
return SFTPAbsoluteServer
2423
if typestring == "memory":
2424
from bzrlib.transport.memory import MemoryServer
2426
if typestring == "fakenfs":
2427
from bzrlib.transport.fakenfs import FakeNFSServer
2428
return FakeNFSServer
2429
msg = "No known transport type %s. Supported types are: sftp\n" %\
2431
raise errors.BzrCommandError(msg)
2434
takes_args = ['testspecs*']
2435
takes_options = ['verbose',
2437
help='stop when one test fails',
2440
Option('keep-output',
2441
help='keep output directories when tests fail'),
2443
help='Use a different transport by default '
2444
'throughout the test suite.',
2445
type=get_transport_type),
2446
Option('benchmark', help='run the bzr benchmarks.'),
2447
Option('lsprof-timed',
2448
help='generate lsprof output for benchmarked'
2449
' sections of code.'),
2450
Option('cache-dir', type=str,
2451
help='a directory to cache intermediate'
2452
' benchmark steps'),
2453
Option('clean-output',
2454
help='clean temporary tests directories'
2455
' without running tests'),
2457
help='run all tests, but run specified tests first',
2460
Option('numbered-dirs',
2461
help='use numbered dirs for TestCaseInTempDir'),
2463
help='list the tests instead of running them'),
2464
Option('randomize', type=str, argname="SEED",
2465
help='randomize the order of tests using the given'
2466
' seed or "now" for the current time'),
2467
Option('exclude', type=str, argname="PATTERN",
2469
help='exclude tests that match this regular'
2472
encoding_type = 'replace'
2474
def run(self, testspecs_list=None, verbose=None, one=False,
2475
keep_output=False, transport=None, benchmark=None,
2476
lsprof_timed=None, cache_dir=None, clean_output=False,
2477
first=False, numbered_dirs=None, list_only=False,
2478
randomize=None, exclude=None):
2480
from bzrlib.tests import selftest
2481
import bzrlib.benchmarks as benchmarks
2482
from bzrlib.benchmarks import tree_creator
2485
from bzrlib.tests import clean_selftest_output
2486
clean_selftest_output()
2489
if numbered_dirs is None and sys.platform == 'win32':
2490
numbered_dirs = True
2492
if cache_dir is not None:
2493
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2494
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2495
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2497
if testspecs_list is not None:
2498
pattern = '|'.join(testspecs_list)
2502
test_suite_factory = benchmarks.test_suite
2505
# TODO: should possibly lock the history file...
2506
benchfile = open(".perf_history", "at", buffering=1)
2508
test_suite_factory = None
2513
result = selftest(verbose=verbose,
2515
stop_on_failure=one,
2516
keep_output=keep_output,
2517
transport=transport,
2518
test_suite_factory=test_suite_factory,
2519
lsprof_timed=lsprof_timed,
2520
bench_history=benchfile,
2521
matching_tests_first=first,
2522
numbered_dirs=numbered_dirs,
2523
list_only=list_only,
2524
random_seed=randomize,
2525
exclude_pattern=exclude
2528
if benchfile is not None:
2531
info('tests passed')
2533
info('tests failed')
2534
return int(not result)
2537
class cmd_version(Command):
2538
"""Show version of bzr."""
2542
from bzrlib.version import show_version
2546
class cmd_rocks(Command):
2547
"""Statement of optimism."""
2553
print "It sure does!"
2556
class cmd_find_merge_base(Command):
2557
"""Find and print a base revision for merging two branches."""
2558
# TODO: Options to specify revisions on either side, as if
2559
# merging only part of the history.
2560
takes_args = ['branch', 'other']
2564
def run(self, branch, other):
2565
from bzrlib.revision import MultipleRevisionSources
2567
branch1 = Branch.open_containing(branch)[0]
2568
branch2 = Branch.open_containing(other)[0]
2570
last1 = branch1.last_revision()
2571
last2 = branch2.last_revision()
2573
source = MultipleRevisionSources(branch1.repository,
2576
base_rev_id = common_ancestor(last1, last2, source)
2578
print 'merge base is revision %s' % base_rev_id
2581
class cmd_merge(Command):
2582
"""Perform a three-way merge.
2584
The branch is the branch you will merge from. By default, it will merge
2585
the latest revision. If you specify a revision, that revision will be
2586
merged. If you specify two revisions, the first will be used as a BASE,
2587
and the second one as OTHER. Revision numbers are always relative to the
2590
By default, bzr will try to merge in all new work from the other
2591
branch, automatically determining an appropriate base. If this
2592
fails, you may need to give an explicit base.
2594
Merge will do its best to combine the changes in two branches, but there
2595
are some kinds of problems only a human can fix. When it encounters those,
2596
it will mark a conflict. A conflict means that you need to fix something,
2597
before you should commit.
2599
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2601
If there is no default branch set, the first merge will set it. After
2602
that, you can omit the branch to use the default. To change the
2603
default, use --remember. The value will only be saved if the remote
2604
location can be accessed.
2606
The results of the merge are placed into the destination working
2607
directory, where they can be reviewed (with bzr diff), tested, and then
2608
committed to record the result of the merge.
2612
To merge the latest revision from bzr.dev:
2613
bzr merge ../bzr.dev
2615
To merge changes up to and including revision 82 from bzr.dev:
2616
bzr merge -r 82 ../bzr.dev
2618
To merge the changes introduced by 82, without previous changes:
2619
bzr merge -r 81..82 ../bzr.dev
2621
merge refuses to run if there are any uncommitted changes, unless
2625
_see_also = ['update', 'remerge']
2626
takes_args = ['branch?']
2627
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2628
Option('show-base', help="Show base revision text in "
2630
Option('uncommitted', help='Apply uncommitted changes'
2631
' from a working copy, instead of branch changes'),
2632
Option('pull', help='If the destination is already'
2633
' completely merged into the source, pull from the'
2634
' source rather than merging. When this happens,'
2635
' you do not need to commit the result.'),
2637
help='Branch to merge into, '
2638
'rather than the one containing the working directory',
2644
def run(self, branch=None, revision=None, force=False, merge_type=None,
2645
show_base=False, reprocess=False, remember=False,
2646
uncommitted=False, pull=False,
2649
from bzrlib.tag import _merge_tags_if_possible
2650
other_revision_id = None
2651
if merge_type is None:
2652
merge_type = _mod_merge.Merge3Merger
2654
if directory is None: directory = u'.'
2655
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2656
# inventory. Because merge is a mutating operation, it really
2657
# should be a lock_write() for the whole cmd_merge operation.
2658
# However, cmd_merge open's its own tree in _merge_helper, which
2659
# means if we lock here, the later lock_write() will always block.
2660
# Either the merge helper code should be updated to take a tree,
2661
# (What about tree.merge_from_branch?)
2662
tree = WorkingTree.open_containing(directory)[0]
2663
change_reporter = delta._ChangeReporter(
2664
unversioned_filter=tree.is_ignored)
2666
if branch is not None:
2668
mergeable = bundle.read_mergeable_from_url(
2670
except errors.NotABundle:
2671
pass # Continue on considering this url a Branch
2673
if revision is not None:
2674
raise errors.BzrCommandError(
2675
'Cannot use -r with merge directives or bundles')
2676
other_revision_id = mergeable.install_revisions(
2677
tree.branch.repository)
2678
revision = [RevisionSpec.from_string(
2679
'revid:' + other_revision_id)]
2681
if revision is None \
2682
or len(revision) < 1 or revision[0].needs_branch():
2683
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2685
if revision is None or len(revision) < 1:
2688
other = [branch, None]
2691
other = [branch, -1]
2692
other_branch, path = Branch.open_containing(branch)
2695
raise errors.BzrCommandError('Cannot use --uncommitted and'
2696
' --revision at the same time.')
2697
branch = revision[0].get_branch() or branch
2698
if len(revision) == 1:
2700
if other_revision_id is not None:
2705
other_branch, path = Branch.open_containing(branch)
2706
revno = revision[0].in_history(other_branch).revno
2707
other = [branch, revno]
2709
assert len(revision) == 2
2710
if None in revision:
2711
raise errors.BzrCommandError(
2712
"Merge doesn't permit empty revision specifier.")
2713
base_branch, path = Branch.open_containing(branch)
2714
branch1 = revision[1].get_branch() or branch
2715
other_branch, path1 = Branch.open_containing(branch1)
2716
if revision[0].get_branch() is not None:
2717
# then path was obtained from it, and is None.
2720
base = [branch, revision[0].in_history(base_branch).revno]
2721
other = [branch1, revision[1].in_history(other_branch).revno]
2723
if ((tree.branch.get_parent() is None or remember) and
2724
other_branch is not None):
2725
tree.branch.set_parent(other_branch.base)
2727
# pull tags now... it's a bit inconsistent to do it ahead of copying
2728
# the history but that's done inside the merge code
2729
if other_branch is not None:
2730
_merge_tags_if_possible(other_branch, tree.branch)
2733
interesting_files = [path]
2735
interesting_files = None
2736
pb = ui.ui_factory.nested_progress_bar()
2739
conflict_count = _merge_helper(
2740
other, base, other_rev_id=other_revision_id,
2741
check_clean=(not force),
2742
merge_type=merge_type,
2743
reprocess=reprocess,
2744
show_base=show_base,
2747
pb=pb, file_list=interesting_files,
2748
change_reporter=change_reporter)
2751
if conflict_count != 0:
2755
except errors.AmbiguousBase, e:
2756
m = ("sorry, bzr can't determine the right merge base yet\n"
2757
"candidates are:\n "
2758
+ "\n ".join(e.bases)
2760
"please specify an explicit base with -r,\n"
2761
"and (if you want) report this to the bzr developers\n")
2764
# TODO: move up to common parent; this isn't merge-specific anymore.
2765
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2766
"""Use tree.branch's parent if none was supplied.
2768
Report if the remembered location was used.
2770
if supplied_location is not None:
2771
return supplied_location
2772
stored_location = tree.branch.get_parent()
2773
mutter("%s", stored_location)
2774
if stored_location is None:
2775
raise errors.BzrCommandError("No location specified or remembered")
2776
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2777
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2778
return stored_location
2781
class cmd_remerge(Command):
2784
Use this if you want to try a different merge technique while resolving
2785
conflicts. Some merge techniques are better than others, and remerge
2786
lets you try different ones on different files.
2788
The options for remerge have the same meaning and defaults as the ones for
2789
merge. The difference is that remerge can (only) be run when there is a
2790
pending merge, and it lets you specify particular files.
2794
$ bzr remerge --show-base
2795
Re-do the merge of all conflicted files, and show the base text in
2796
conflict regions, in addition to the usual THIS and OTHER texts.
2798
$ bzr remerge --merge-type weave --reprocess foobar
2799
Re-do the merge of "foobar", using the weave merge algorithm, with
2800
additional processing to reduce the size of conflict regions.
2802
takes_args = ['file*']
2803
takes_options = ['merge-type', 'reprocess',
2804
Option('show-base', help="Show base revision text in "
2807
def run(self, file_list=None, merge_type=None, show_base=False,
2809
if merge_type is None:
2810
merge_type = _mod_merge.Merge3Merger
2811
tree, file_list = tree_files(file_list)
2814
parents = tree.get_parent_ids()
2815
if len(parents) != 2:
2816
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2817
" merges. Not cherrypicking or"
2819
repository = tree.branch.repository
2820
base_revision = common_ancestor(parents[0],
2821
parents[1], repository)
2822
base_tree = repository.revision_tree(base_revision)
2823
other_tree = repository.revision_tree(parents[1])
2824
interesting_ids = None
2826
conflicts = tree.conflicts()
2827
if file_list is not None:
2828
interesting_ids = set()
2829
for filename in file_list:
2830
file_id = tree.path2id(filename)
2832
raise errors.NotVersionedError(filename)
2833
interesting_ids.add(file_id)
2834
if tree.kind(file_id) != "directory":
2837
for name, ie in tree.inventory.iter_entries(file_id):
2838
interesting_ids.add(ie.file_id)
2839
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2841
# Remerge only supports resolving contents conflicts
2842
allowed_conflicts = ('text conflict', 'contents conflict')
2843
restore_files = [c.path for c in conflicts
2844
if c.typestring in allowed_conflicts]
2845
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2846
tree.set_conflicts(ConflictList(new_conflicts))
2847
if file_list is not None:
2848
restore_files = file_list
2849
for filename in restore_files:
2851
restore(tree.abspath(filename))
2852
except errors.NotConflicted:
2854
conflicts = _mod_merge.merge_inner(
2855
tree.branch, other_tree, base_tree,
2857
interesting_ids=interesting_ids,
2858
other_rev_id=parents[1],
2859
merge_type=merge_type,
2860
show_base=show_base,
2861
reprocess=reprocess)
2870
class cmd_revert(Command):
2871
"""Revert files to a previous revision.
2873
Giving a list of files will revert only those files. Otherwise, all files
2874
will be reverted. If the revision is not specified with '--revision', the
2875
last committed revision is used.
2877
To remove only some changes, without reverting to a prior version, use
2878
merge instead. For example, "merge . --r-2..-3" will remove the changes
2879
introduced by -2, without affecting the changes introduced by -1. Or
2880
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2882
By default, any files that have been manually changed will be backed up
2883
first. (Files changed only by merge are not backed up.) Backup files have
2884
'.~#~' appended to their name, where # is a number.
2886
When you provide files, you can use their current pathname or the pathname
2887
from the target revision. So you can use revert to "undelete" a file by
2888
name. If you name a directory, all the contents of that directory will be
2892
_see_also = ['cat', 'export']
2893
takes_options = ['revision', 'no-backup']
2894
takes_args = ['file*']
2896
def run(self, revision=None, no_backup=False, file_list=None):
2897
if file_list is not None:
2898
if len(file_list) == 0:
2899
raise errors.BzrCommandError("No files specified")
2903
tree, file_list = tree_files(file_list)
2904
if revision is None:
2905
# FIXME should be tree.last_revision
2906
rev_id = tree.last_revision()
2907
elif len(revision) != 1:
2908
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2910
rev_id = revision[0].in_history(tree.branch).rev_id
2911
pb = ui.ui_factory.nested_progress_bar()
2913
tree.revert(file_list,
2914
tree.branch.repository.revision_tree(rev_id),
2915
not no_backup, pb, report_changes=True)
2920
class cmd_assert_fail(Command):
2921
"""Test reporting of assertion failures"""
2922
# intended just for use in testing
2927
raise AssertionError("always fails")
2930
class cmd_help(Command):
2931
"""Show help on a command or other topic.
2934
_see_also = ['topics']
2935
takes_options = [Option('long', 'show help on all commands')]
2936
takes_args = ['topic?']
2937
aliases = ['?', '--help', '-?', '-h']
2940
def run(self, topic=None, long=False):
2942
if topic is None and long:
2944
bzrlib.help.help(topic)
2947
class cmd_shell_complete(Command):
2948
"""Show appropriate completions for context.
2950
For a list of all available commands, say 'bzr shell-complete'.
2952
takes_args = ['context?']
2957
def run(self, context=None):
2958
import shellcomplete
2959
shellcomplete.shellcomplete(context)
2962
class cmd_fetch(Command):
2963
"""Copy in history from another branch but don't merge it.
2965
This is an internal method used for pull and merge.
2968
takes_args = ['from_branch', 'to_branch']
2969
def run(self, from_branch, to_branch):
2970
from bzrlib.fetch import Fetcher
2971
from_b = Branch.open(from_branch)
2972
to_b = Branch.open(to_branch)
2973
Fetcher(to_b, from_b)
2976
class cmd_missing(Command):
2977
"""Show unmerged/unpulled revisions between two branches.
2979
OTHER_BRANCH may be local or remote.
2982
_see_also = ['merge', 'pull']
2983
takes_args = ['other_branch?']
2984
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2986
'Display changes in the local branch only'),
2987
Option('theirs-only',
2988
'Display changes in the remote branch only'),
2993
encoding_type = 'replace'
2996
def run(self, other_branch=None, reverse=False, mine_only=False,
2997
theirs_only=False, log_format=None, long=False, short=False, line=False,
2998
show_ids=False, verbose=False):
2999
from bzrlib.missing import find_unmerged, iter_log_revisions
3000
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)
3150
tree = branch.repository.revision_tree(revision_id)
3151
file_version = tree.inventory[file_id].revision
3152
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
3158
class cmd_re_sign(Command):
3159
"""Create a digital signature for an existing revision."""
3160
# TODO be able to replace existing ones.
3162
hidden = True # is this right ?
3163
takes_args = ['revision_id*']
3164
takes_options = ['revision']
3166
def run(self, revision_id_list=None, revision=None):
3167
import bzrlib.gpg as gpg
3168
if revision_id_list is not None and revision is not None:
3169
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3170
if revision_id_list is None and revision is None:
3171
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3172
b = WorkingTree.open_containing(u'.')[0].branch
3173
gpg_strategy = gpg.GPGStrategy(b.get_config())
3174
if revision_id_list is not None:
3175
for revision_id in revision_id_list:
3176
b.repository.sign_revision(revision_id, gpg_strategy)
3177
elif revision is not None:
3178
if len(revision) == 1:
3179
revno, rev_id = revision[0].in_history(b)
3180
b.repository.sign_revision(rev_id, gpg_strategy)
3181
elif len(revision) == 2:
3182
# are they both on rh- if so we can walk between them
3183
# might be nice to have a range helper for arbitrary
3184
# revision paths. hmm.
3185
from_revno, from_revid = revision[0].in_history(b)
3186
to_revno, to_revid = revision[1].in_history(b)
3187
if to_revid is None:
3188
to_revno = b.revno()
3189
if from_revno is None or to_revno is None:
3190
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3191
for revno in range(from_revno, to_revno + 1):
3192
b.repository.sign_revision(b.get_rev_id(revno),
3195
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3198
class cmd_bind(Command):
3199
"""Convert the current branch into a checkout of the supplied branch.
3201
Once converted into a checkout, commits must succeed on the master branch
3202
before they will be applied to the local branch.
3205
_see_also = ['checkouts', 'unbind']
3206
takes_args = ['location?']
3209
def run(self, location=None):
3210
b, relpath = Branch.open_containing(u'.')
3211
if location is None:
3213
location = b.get_old_bound_location()
3214
except errors.UpgradeRequired:
3215
raise errors.BzrCommandError('No location supplied. '
3216
'This format does not remember old locations.')
3218
if location is None:
3219
raise errors.BzrCommandError('No location supplied and no '
3220
'previous location known')
3221
b_other = Branch.open(location)
3224
except errors.DivergedBranches:
3225
raise errors.BzrCommandError('These branches have diverged.'
3226
' Try merging, and then bind again.')
3229
class cmd_unbind(Command):
3230
"""Convert the current checkout into a regular branch.
3232
After unbinding, the local branch is considered independent and subsequent
3233
commits will be local only.
3236
_see_also = ['checkouts', 'bind']
3241
b, relpath = Branch.open_containing(u'.')
3243
raise errors.BzrCommandError('Local branch is not bound')
3246
class cmd_uncommit(Command):
3247
"""Remove the last committed revision.
3249
--verbose will print out what is being removed.
3250
--dry-run will go through all the motions, but not actually
3253
In the future, uncommit will create a revision bundle, which can then
3257
# TODO: jam 20060108 Add an option to allow uncommit to remove
3258
# unreferenced information in 'branch-as-repository' branches.
3259
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3260
# information in shared branches as well.
3261
_see_also = ['commit']
3262
takes_options = ['verbose', 'revision',
3263
Option('dry-run', help='Don\'t actually make changes'),
3264
Option('force', help='Say yes to all questions.')]
3265
takes_args = ['location?']
3268
def run(self, location=None,
3269
dry_run=False, verbose=False,
3270
revision=None, force=False):
3271
from bzrlib.log import log_formatter, show_log
3273
from bzrlib.uncommit import uncommit
3275
if location is None:
3277
control, relpath = bzrdir.BzrDir.open_containing(location)
3279
tree = control.open_workingtree()
3281
except (errors.NoWorkingTree, errors.NotLocalUrl):
3283
b = control.open_branch()
3286
if revision is None:
3289
# 'bzr uncommit -r 10' actually means uncommit
3290
# so that the final tree is at revno 10.
3291
# but bzrlib.uncommit.uncommit() actually uncommits
3292
# the revisions that are supplied.
3293
# So we need to offset it by one
3294
revno = revision[0].in_history(b).revno+1
3296
if revno <= b.revno():
3297
rev_id = b.get_rev_id(revno)
3299
self.outf.write('No revisions to uncommit.\n')
3302
lf = log_formatter('short',
3304
show_timezone='original')
3309
direction='forward',
3310
start_revision=revno,
3311
end_revision=b.revno())
3314
print 'Dry-run, pretending to remove the above revisions.'
3316
val = raw_input('Press <enter> to continue')
3318
print 'The above revision(s) will be removed.'
3320
val = raw_input('Are you sure [y/N]? ')
3321
if val.lower() not in ('y', 'yes'):
3325
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3329
class cmd_break_lock(Command):
3330
"""Break a dead lock on a repository, branch or working directory.
3332
CAUTION: Locks should only be broken when you are sure that the process
3333
holding the lock has been stopped.
3335
You can get information on what locks are open via the 'bzr info' command.
3340
takes_args = ['location?']
3342
def run(self, location=None, show=False):
3343
if location is None:
3345
control, relpath = bzrdir.BzrDir.open_containing(location)
3347
control.break_lock()
3348
except NotImplementedError:
3352
class cmd_wait_until_signalled(Command):
3353
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3355
This just prints a line to signal when it is ready, then blocks on stdin.
3361
sys.stdout.write("running\n")
3363
sys.stdin.readline()
3366
class cmd_serve(Command):
3367
"""Run the bzr server."""
3369
aliases = ['server']
3373
help='serve on stdin/out for use from inetd or sshd'),
3375
help='listen for connections on nominated port of the form '
3376
'[hostname:]portnumber. Passing 0 as the port number will '
3377
'result in a dynamically allocated port. Default port is '
3381
help='serve contents of directory',
3383
Option('allow-writes',
3384
help='By default the server is a readonly server. Supplying '
3385
'--allow-writes enables write access to the contents of '
3386
'the served directory and below. '
3390
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3391
from bzrlib.smart import medium, server
3392
from bzrlib.transport import get_transport
3393
from bzrlib.transport.chroot import ChrootServer
3394
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3395
if directory is None:
3396
directory = os.getcwd()
3397
url = urlutils.local_path_to_url(directory)
3398
if not allow_writes:
3399
url = 'readonly+' + url
3400
chroot_server = ChrootServer(get_transport(url))
3401
chroot_server.setUp()
3402
t = get_transport(chroot_server.get_url())
3404
smart_server = medium.SmartServerPipeStreamMedium(
3405
sys.stdin, sys.stdout, t)
3407
host = BZR_DEFAULT_INTERFACE
3409
port = BZR_DEFAULT_PORT
3412
host, port = port.split(':')
3414
smart_server = server.SmartTCPServer(t, host=host, port=port)
3415
print 'listening on port: ', smart_server.port
3417
# for the duration of this server, no UI output is permitted.
3418
# note that this may cause problems with blackbox tests. This should
3419
# be changed with care though, as we dont want to use bandwidth sending
3420
# progress over stderr to smart server clients!
3421
old_factory = ui.ui_factory
3423
ui.ui_factory = ui.SilentUIFactory()
3424
smart_server.serve()
3426
ui.ui_factory = old_factory
3429
class cmd_join(Command):
3430
"""Combine a subtree into its containing tree.
3432
This command is for experimental use only. It requires the target tree
3433
to be in dirstate-with-subtree format, which cannot be converted into
3436
The TREE argument should be an independent tree, inside another tree, but
3437
not part of it. (Such trees can be produced by "bzr split", but also by
3438
running "bzr branch" with the target inside a tree.)
3440
The result is a combined tree, with the subtree no longer an independant
3441
part. This is marked as a merge of the subtree into the containing tree,
3442
and all history is preserved.
3444
If --reference is specified, the subtree retains its independence. It can
3445
be branched by itself, and can be part of multiple projects at the same
3446
time. But operations performed in the containing tree, such as commit
3447
and merge, will recurse into the subtree.
3450
_see_also = ['split']
3451
takes_args = ['tree']
3452
takes_options = [Option('reference', 'join by reference')]
3455
def run(self, tree, reference=False):
3456
sub_tree = WorkingTree.open(tree)
3457
parent_dir = osutils.dirname(sub_tree.basedir)
3458
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3459
repo = containing_tree.branch.repository
3460
if not repo.supports_rich_root():
3461
raise errors.BzrCommandError(
3462
"Can't join trees because %s doesn't support rich root data.\n"
3463
"You can use bzr upgrade on the repository."
3467
containing_tree.add_reference(sub_tree)
3468
except errors.BadReferenceTarget, e:
3469
# XXX: Would be better to just raise a nicely printable
3470
# exception from the real origin. Also below. mbp 20070306
3471
raise errors.BzrCommandError("Cannot join %s. %s" %
3475
containing_tree.subsume(sub_tree)
3476
except errors.BadSubsumeSource, e:
3477
raise errors.BzrCommandError("Cannot join %s. %s" %
3481
class cmd_split(Command):
3482
"""Split a tree into two trees.
3484
This command is for experimental use only. It requires the target tree
3485
to be in dirstate-with-subtree format, which cannot be converted into
3488
The TREE argument should be a subdirectory of a working tree. That
3489
subdirectory will be converted into an independent tree, with its own
3490
branch. Commits in the top-level tree will not apply to the new subtree.
3491
If you want that behavior, do "bzr join --reference TREE".
3494
_see_also = ['join']
3495
takes_args = ['tree']
3499
def run(self, tree):
3500
containing_tree, subdir = WorkingTree.open_containing(tree)
3501
sub_id = containing_tree.path2id(subdir)
3503
raise errors.NotVersionedError(subdir)
3505
containing_tree.extract(sub_id)
3506
except errors.RootNotRich:
3507
raise errors.UpgradeRequired(containing_tree.branch.base)
3511
class cmd_merge_directive(Command):
3512
"""Generate a merge directive for auto-merge tools.
3514
A directive requests a merge to be performed, and also provides all the
3515
information necessary to do so. This means it must either include a
3516
revision bundle, or the location of a branch containing the desired
3519
A submit branch (the location to merge into) must be supplied the first
3520
time the command is issued. After it has been supplied once, it will
3521
be remembered as the default.
3523
A public branch is optional if a revision bundle is supplied, but required
3524
if --diff or --plain is specified. It will be remembered as the default
3525
after the first use.
3528
takes_args = ['submit_branch?', 'public_branch?']
3531
RegistryOption.from_kwargs('patch-type',
3532
'The type of patch to include in the directive',
3533
title='Patch type', value_switches=True, enum_switch=False,
3534
bundle='Bazaar revision bundle (default)',
3535
diff='Normal unified diff',
3536
plain='No patch, just directive'),
3537
Option('sign', help='GPG-sign the directive'), 'revision',
3538
Option('mail-to', type=str,
3539
help='Instead of printing the directive, email to this address'),
3540
Option('message', type=str, short_name='m',
3541
help='Message to use when committing this merge')
3544
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3545
sign=False, revision=None, mail_to=None, message=None):
3546
if patch_type == 'plain':
3548
branch = Branch.open('.')
3549
stored_submit_branch = branch.get_submit_branch()
3550
if submit_branch is None:
3551
submit_branch = stored_submit_branch
3553
if stored_submit_branch is None:
3554
branch.set_submit_branch(submit_branch)
3555
if submit_branch is None:
3556
submit_branch = branch.get_parent()
3557
if submit_branch is None:
3558
raise errors.BzrCommandError('No submit branch specified or known')
3560
stored_public_branch = branch.get_public_branch()
3561
if public_branch is None:
3562
public_branch = stored_public_branch
3563
elif stored_public_branch is None:
3564
branch.set_public_branch(public_branch)
3565
if patch_type != "bundle" and public_branch is None:
3566
raise errors.BzrCommandError('No public branch specified or'
3568
if revision is not None:
3569
if len(revision) != 1:
3570
raise errors.BzrCommandError('bzr merge-directive takes '
3571
'exactly one revision identifier')
3573
revision_id = revision[0].in_history(branch).rev_id
3575
revision_id = branch.last_revision()
3576
directive = merge_directive.MergeDirective.from_objects(
3577
branch.repository, revision_id, time.time(),
3578
osutils.local_time_offset(), submit_branch,
3579
public_branch=public_branch, patch_type=patch_type,
3583
self.outf.write(directive.to_signed(branch))
3585
self.outf.writelines(directive.to_lines())
3587
message = directive.to_email(mail_to, branch, sign)
3589
server = branch.get_config().get_user_option('smtp_server')
3591
server = 'localhost'
3593
s.sendmail(message['From'], message['To'], message.as_string())
3596
class cmd_tag(Command):
3597
"""Create a tag naming a revision.
3599
Tags give human-meaningful names to revisions. Commands that take a -r
3600
(--revision) option can be given -rtag:X, where X is any previously
3603
Tags are stored in the branch. Tags are copied from one branch to another
3604
along when you branch, push, pull or merge.
3606
It is an error to give a tag name that already exists unless you pass
3607
--force, in which case the tag is moved to point to the new revision.
3610
_see_also = ['commit', 'tags']
3611
takes_args = ['tag_name']
3614
help='Delete this tag rather than placing it.',
3617
help='Branch in which to place the tag.',
3622
help='Replace existing tags',
3627
def run(self, tag_name,
3633
branch, relpath = Branch.open_containing(directory)
3637
branch.tags.delete_tag(tag_name)
3638
self.outf.write('Deleted tag %s.\n' % tag_name)
3641
if len(revision) != 1:
3642
raise errors.BzrCommandError(
3643
"Tags can only be placed on a single revision, "
3645
revision_id = revision[0].in_history(branch).rev_id
3647
revision_id = branch.last_revision()
3648
if (not force) and branch.tags.has_tag(tag_name):
3649
raise errors.TagAlreadyExists(tag_name)
3650
branch.tags.set_tag(tag_name, revision_id)
3651
self.outf.write('Created tag %s.\n' % tag_name)
3656
class cmd_tags(Command):
3659
This tag shows a table of tag names and the revisions they reference.
3665
help='Branch whose tags should be displayed',
3675
branch, relpath = Branch.open_containing(directory)
3676
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3677
self.outf.write('%-20s %s\n' % (tag_name, target))
3680
# command-line interpretation helper for merge-related commands
3681
def _merge_helper(other_revision, base_revision,
3682
check_clean=True, ignore_zero=False,
3683
this_dir=None, backup_files=False,
3685
file_list=None, show_base=False, reprocess=False,
3688
change_reporter=None,
3690
"""Merge changes into a tree.
3693
list(path, revno) Base for three-way merge.
3694
If [None, None] then a base will be automatically determined.
3696
list(path, revno) Other revision for three-way merge.
3698
Directory to merge changes into; '.' by default.
3700
If true, this_dir must have no uncommitted changes before the
3702
ignore_zero - If true, suppress the "zero conflicts" message when
3703
there are no conflicts; should be set when doing something we expect
3704
to complete perfectly.
3705
file_list - If supplied, merge only changes to selected files.
3707
All available ancestors of other_revision and base_revision are
3708
automatically pulled into the branch.
3710
The revno may be -1 to indicate the last revision on the branch, which is
3713
This function is intended for use from the command line; programmatic
3714
clients might prefer to call merge.merge_inner(), which has less magic
3717
# Loading it late, so that we don't always have to import bzrlib.merge
3718
if merge_type is None:
3719
merge_type = _mod_merge.Merge3Merger
3720
if this_dir is None:
3722
this_tree = WorkingTree.open_containing(this_dir)[0]
3723
if show_base and not merge_type is _mod_merge.Merge3Merger:
3724
raise errors.BzrCommandError("Show-base is not supported for this merge"
3725
" type. %s" % merge_type)
3726
if reprocess and not merge_type.supports_reprocess:
3727
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3728
" type %s." % merge_type)
3729
if reprocess and show_base:
3730
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3731
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3732
# only want to take out a lock_tree_write() if we don't have to pull
3733
# any ancestry. But merge might fetch ancestry in the middle, in
3734
# which case we would need a lock_write().
3735
# Because we cannot upgrade locks, for now we live with the fact that
3736
# the tree will be locked multiple times during a merge. (Maybe
3737
# read-only some of the time, but it means things will get read
3740
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3741
pb=pb, change_reporter=change_reporter)
3742
merger.pp = ProgressPhase("Merge phase", 5, pb)
3743
merger.pp.next_phase()
3744
merger.check_basis(check_clean)
3745
if other_rev_id is not None:
3746
merger.set_other_revision(other_rev_id, this_tree.branch)
3748
merger.set_other(other_revision)
3749
merger.pp.next_phase()
3750
merger.set_base(base_revision)
3751
if merger.base_rev_id == merger.other_rev_id:
3752
note('Nothing to do.')
3754
if file_list is None:
3755
if pull and merger.base_rev_id == merger.this_rev_id:
3756
# FIXME: deduplicate with pull
3757
result = merger.this_tree.pull(merger.this_branch,
3758
False, merger.other_rev_id)
3759
if result.old_revid == result.new_revid:
3760
note('No revisions to pull.')
3762
note('Now on revision %d.' % result.new_revno)
3764
merger.backup_files = backup_files
3765
merger.merge_type = merge_type
3766
merger.set_interesting_files(file_list)
3767
merger.show_base = show_base
3768
merger.reprocess = reprocess
3769
conflicts = merger.do_merge()
3770
if file_list is None:
3771
merger.set_pending()
3778
merge = _merge_helper
3781
# these get imported and then picked up by the scan for cmd_*
3782
# TODO: Some more consistent way to split command definitions across files;
3783
# we do need to load at least some information about them to know of
3784
# aliases. ideally we would avoid loading the implementation until the
3785
# details were needed.
3786
from bzrlib.cmd_version_info import cmd_version_info
3787
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3788
from bzrlib.bundle.commands import cmd_bundle_revisions
3789
from bzrlib.sign_my_commits import cmd_sign_my_commits
3790
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3791
cmd_weave_plan_merge, cmd_weave_merge_text