1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
20
from StringIO import StringIO
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
54
from bzrlib.branch import Branch
55
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revision import common_ancestor
58
from bzrlib.revisionspec import RevisionSpec
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import ListOption, Option, RegistryOption
64
from bzrlib.progress import DummyProgress, ProgressPhase
65
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
68
def tree_files(file_list, default_branch=u'.'):
70
return internal_tree_files(file_list, default_branch)
71
except errors.FileInWrongBranch, e:
72
raise errors.BzrCommandError("%s is not in the same branch as %s" %
73
(e.path, file_list[0]))
76
# XXX: Bad function name; should possibly also be a class method of
77
# WorkingTree rather than a function.
78
def internal_tree_files(file_list, default_branch=u'.'):
79
"""Convert command-line paths to a WorkingTree and relative paths.
81
This is typically used for command-line processors that take one or
82
more filenames, and infer the workingtree that contains them.
84
The filenames given are not required to exist.
86
:param file_list: Filenames to convert.
88
:param default_branch: Fallback tree path to use if file_list is empty or
91
:return: workingtree, [relative_paths]
93
if file_list is None or len(file_list) == 0:
94
return WorkingTree.open_containing(default_branch)[0], file_list
95
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
97
for filename in file_list:
99
new_list.append(tree.relpath(osutils.dereference_path(filename)))
100
except errors.PathNotChild:
101
raise errors.FileInWrongBranch(tree.branch, filename)
102
return tree, new_list
105
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
106
def get_format_type(typestring):
107
"""Parse and return a format specifier."""
108
# Have to use BzrDirMetaFormat1 directly, so that
109
# RepositoryFormat.set_default_format works
110
if typestring == "default":
111
return bzrdir.BzrDirMetaFormat1()
113
return bzrdir.format_registry.make_bzrdir(typestring)
115
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
116
raise errors.BzrCommandError(msg)
119
# TODO: Make sure no commands unconditionally use the working directory as a
120
# branch. If a filename argument is used, the first of them should be used to
121
# specify the branch. (Perhaps this can be factored out into some kind of
122
# Argument class, representing a file in a branch, where the first occurrence
125
class cmd_status(Command):
126
"""Display status summary.
128
This reports on versioned and unknown files, reporting them
129
grouped by state. Possible states are:
132
Versioned in the working copy but not in the previous revision.
135
Versioned in the previous revision but removed or deleted
139
Path of this file changed from the previous revision;
140
the text may also have changed. This includes files whose
141
parent directory was renamed.
144
Text has changed since the previous revision.
147
File kind has been changed (e.g. from file to directory).
150
Not versioned and not matching an ignore pattern.
152
To see ignored files use 'bzr ignored'. For details on the
153
changes to file texts, use 'bzr diff'.
155
--short gives a status flags for each item, similar to the SVN's status
158
Column 1: versioning / renames
164
P Entry for a pending merge (not a file)
173
* The execute bit was changed
175
If no arguments are specified, the status of the entire working
176
directory is shown. Otherwise, only the status of the specified
177
files or directories is reported. If a directory is given, status
178
is reported for everything inside that directory.
180
If a revision argument is given, the status is calculated against
181
that revision, or between two revisions if two are provided.
184
# TODO: --no-recurse, --recurse options
186
takes_args = ['file*']
187
takes_options = ['show-ids', 'revision',
188
Option('short', help='Give short SVN-style status lines'),
189
Option('versioned', help='Only show versioned files')]
190
aliases = ['st', 'stat']
192
encoding_type = 'replace'
193
_see_also = ['diff', 'revert']
196
def run(self, show_ids=False, file_list=None, revision=None, short=False,
198
from bzrlib.status import show_tree_status
200
tree, file_list = tree_files(file_list)
202
show_tree_status(tree, show_ids=show_ids,
203
specific_files=file_list, revision=revision,
204
to_file=self.outf, short=short, versioned=versioned)
207
class cmd_cat_revision(Command):
208
"""Write out metadata for a revision.
210
The revision to print can either be specified by a specific
211
revision identifier, or you can use --revision.
215
takes_args = ['revision_id?']
216
takes_options = ['revision']
217
# cat-revision is more for frontends so should be exact
221
def run(self, revision_id=None, revision=None):
223
revision_id = osutils.safe_revision_id(revision_id, warn=False)
224
if revision_id is not None and revision is not None:
225
raise errors.BzrCommandError('You can only supply one of'
226
' revision_id or --revision')
227
if revision_id is None and revision is None:
228
raise errors.BzrCommandError('You must supply either'
229
' --revision or a revision_id')
230
b = WorkingTree.open_containing(u'.')[0].branch
232
# TODO: jam 20060112 should cat-revision always output utf-8?
233
if revision_id is not None:
234
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
235
elif revision is not None:
238
raise errors.BzrCommandError('You cannot specify a NULL'
240
revno, rev_id = rev.in_history(b)
241
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
244
class cmd_remove_tree(Command):
245
"""Remove the working tree from a given branch/checkout.
247
Since a lightweight checkout is little more than a working tree
248
this will refuse to run against one.
250
To re-create the working tree, use "bzr checkout".
252
_see_also = ['checkout', 'working-trees']
254
takes_args = ['location?']
256
def run(self, location='.'):
257
d = bzrdir.BzrDir.open(location)
260
working = d.open_workingtree()
261
except errors.NoWorkingTree:
262
raise errors.BzrCommandError("No working tree to remove")
263
except errors.NotLocalUrl:
264
raise errors.BzrCommandError("You cannot remove the working tree of a "
267
working_path = working.bzrdir.root_transport.base
268
branch_path = working.branch.bzrdir.root_transport.base
269
if working_path != branch_path:
270
raise errors.BzrCommandError("You cannot remove the working tree from "
271
"a lightweight checkout")
273
d.destroy_workingtree()
276
class cmd_revno(Command):
277
"""Show current revision number.
279
This is equal to the number of revisions on this branch.
283
takes_args = ['location?']
286
def run(self, location=u'.'):
287
self.outf.write(str(Branch.open_containing(location)[0].revno()))
288
self.outf.write('\n')
291
class cmd_revision_info(Command):
292
"""Show revision number and revision id for a given revision identifier.
295
takes_args = ['revision_info*']
296
takes_options = ['revision']
299
def run(self, revision=None, revision_info_list=[]):
302
if revision is not None:
303
revs.extend(revision)
304
if revision_info_list is not None:
305
for rev in revision_info_list:
306
revs.append(RevisionSpec.from_string(rev))
308
raise errors.BzrCommandError('You must supply a revision identifier')
310
b = WorkingTree.open_containing(u'.')[0].branch
313
revinfo = rev.in_history(b)
314
if revinfo.revno is None:
315
print ' %s' % revinfo.rev_id
317
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
320
class cmd_add(Command):
321
"""Add specified files or directories.
323
In non-recursive mode, all the named items are added, regardless
324
of whether they were previously ignored. A warning is given if
325
any of the named files are already versioned.
327
In recursive mode (the default), files are treated the same way
328
but the behaviour for directories is different. Directories that
329
are already versioned do not give a warning. All directories,
330
whether already versioned or not, are searched for files or
331
subdirectories that are neither versioned or ignored, and these
332
are added. This search proceeds recursively into versioned
333
directories. If no names are given '.' is assumed.
335
Therefore simply saying 'bzr add' will version all files that
336
are currently unknown.
338
Adding a file whose parent directory is not versioned will
339
implicitly add the parent, and so on up to the root. This means
340
you should never need to explicitly add a directory, they'll just
341
get added when you add a file in the directory.
343
--dry-run will show which files would be added, but not actually
346
--file-ids-from will try to use the file ids from the supplied path.
347
It looks up ids trying to find a matching parent directory with the
348
same filename, and then by pure path. This option is rarely needed
349
but can be useful when adding the same logical file into two
350
branches that will be merged later (without showing the two different
351
adds as a conflict). It is also useful when merging another project
352
into a subdirectory of this one.
354
takes_args = ['file*']
355
takes_options = ['no-recurse', 'dry-run', 'verbose',
356
Option('file-ids-from', type=unicode,
357
help='Lookup file ids from here')]
358
encoding_type = 'replace'
359
_see_also = ['remove']
361
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
366
if file_ids_from is not None:
368
base_tree, base_path = WorkingTree.open_containing(
370
except errors.NoWorkingTree:
371
base_branch, base_path = Branch.open_containing(
373
base_tree = base_branch.basis_tree()
375
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
376
to_file=self.outf, should_print=(not is_quiet()))
378
action = bzrlib.add.AddAction(to_file=self.outf,
379
should_print=(not is_quiet()))
382
base_tree.lock_read()
384
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
385
action=action, save=not dry_run)
387
if base_tree is not None:
391
for glob in sorted(ignored.keys()):
392
for path in ignored[glob]:
393
self.outf.write("ignored %s matching \"%s\"\n"
397
for glob, paths in ignored.items():
398
match_len += len(paths)
399
self.outf.write("ignored %d file(s).\n" % match_len)
400
self.outf.write("If you wish to add some of these files,"
401
" please add them by name.\n")
404
class cmd_mkdir(Command):
405
"""Create a new versioned directory.
407
This is equivalent to creating the directory and then adding it.
410
takes_args = ['dir+']
411
encoding_type = 'replace'
413
def run(self, dir_list):
416
wt, dd = WorkingTree.open_containing(d)
418
self.outf.write('added %s\n' % d)
421
class cmd_relpath(Command):
422
"""Show path of a file relative to root"""
424
takes_args = ['filename']
428
def run(self, filename):
429
# TODO: jam 20050106 Can relpath return a munged path if
430
# sys.stdout encoding cannot represent it?
431
tree, relpath = WorkingTree.open_containing(filename)
432
self.outf.write(relpath)
433
self.outf.write('\n')
436
class cmd_inventory(Command):
437
"""Show inventory of the current working copy or a revision.
439
It is possible to limit the output to a particular entry
440
type using the --kind option. For example: --kind file.
442
It is also possible to restrict the list of files to a specific
443
set. For example: bzr inventory --show-ids this/file
448
takes_options = ['revision', 'show-ids', 'kind']
449
takes_args = ['file*']
452
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
453
if kind and kind not in ['file', 'directory', 'symlink']:
454
raise errors.BzrCommandError('invalid kind specified')
456
work_tree, file_list = tree_files(file_list)
457
work_tree.lock_read()
459
if revision is not None:
460
if len(revision) > 1:
461
raise errors.BzrCommandError(
462
'bzr inventory --revision takes exactly one revision'
464
revision_id = revision[0].in_history(work_tree.branch).rev_id
465
tree = work_tree.branch.repository.revision_tree(revision_id)
467
extra_trees = [work_tree]
473
if file_list is not None:
474
file_ids = tree.paths2ids(file_list, trees=extra_trees,
475
require_versioned=True)
476
# find_ids_across_trees may include some paths that don't
478
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
479
for file_id in file_ids if file_id in tree)
481
entries = tree.inventory.entries()
484
if tree is not work_tree:
487
for path, entry in entries:
488
if kind and kind != entry.kind:
491
self.outf.write('%-50s %s\n' % (path, entry.file_id))
493
self.outf.write(path)
494
self.outf.write('\n')
497
class cmd_mv(Command):
498
"""Move or rename a file.
501
bzr mv OLDNAME NEWNAME
502
bzr mv SOURCE... DESTINATION
504
If the last argument is a versioned directory, all the other names
505
are moved into it. Otherwise, there must be exactly two arguments
506
and the file is changed to a new name.
508
If OLDNAME does not exist on the filesystem but is versioned and
509
NEWNAME does exist on the filesystem but is not versioned, mv
510
assumes that the file has been manually moved and only updates
511
its internal inventory to reflect that change.
512
The same is valid when moving many SOURCE files to a DESTINATION.
514
Files cannot be moved between branches.
517
takes_args = ['names*']
518
takes_options = [Option("after", help="move only the bzr identifier"
519
" of the file (file has already been moved). Use this flag if"
520
" bzr is not able to detect this itself.")]
521
aliases = ['move', 'rename']
522
encoding_type = 'replace'
524
def run(self, names_list, after=False):
525
if names_list is None:
528
if len(names_list) < 2:
529
raise errors.BzrCommandError("missing file argument")
530
tree, rel_names = tree_files(names_list)
532
if os.path.isdir(names_list[-1]):
533
# move into existing directory
534
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
535
self.outf.write("%s => %s\n" % pair)
537
if len(names_list) != 2:
538
raise errors.BzrCommandError('to mv multiple files the'
539
' destination must be a versioned'
541
tree.rename_one(rel_names[0], rel_names[1], after=after)
542
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
545
class cmd_pull(Command):
546
"""Turn this branch into a mirror of another branch.
548
This command only works on branches that have not diverged. Branches are
549
considered diverged if the destination branch's most recent commit is one
550
that has not been merged (directly or indirectly) into the parent.
552
If branches have diverged, you can use 'bzr merge' to integrate the changes
553
from one into the other. Once one branch has merged, the other should
554
be able to pull it again.
556
If you want to forget your local changes and just update your branch to
557
match the remote one, use pull --overwrite.
559
If there is no default location set, the first pull will set it. After
560
that, you can omit the location to use the default. To change the
561
default, use --remember. The value will only be saved if the remote
562
location can be accessed.
565
_see_also = ['push', 'update']
566
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
568
help='branch to pull into, '
569
'rather than the one containing the working directory',
574
takes_args = ['location?']
575
encoding_type = 'replace'
577
def run(self, location=None, remember=False, overwrite=False,
578
revision=None, verbose=False,
580
from bzrlib.tag import _merge_tags_if_possible
581
# FIXME: too much stuff is in the command class
584
if directory is None:
587
tree_to = WorkingTree.open_containing(directory)[0]
588
branch_to = tree_to.branch
589
except errors.NoWorkingTree:
591
branch_to = Branch.open_containing(directory)[0]
594
if location is not None:
596
mergeable = bundle.read_mergeable_from_url(
598
except errors.NotABundle:
599
pass # Continue on considering this url a Branch
601
stored_loc = branch_to.get_parent()
603
if stored_loc is None:
604
raise errors.BzrCommandError("No pull location known or"
607
display_url = urlutils.unescape_for_display(stored_loc,
609
self.outf.write("Using saved location: %s\n" % display_url)
610
location = stored_loc
612
if mergeable is not None:
613
if revision is not None:
614
raise errors.BzrCommandError(
615
'Cannot use -r with merge directives or bundles')
616
revision_id = mergeable.install_revisions(branch_to.repository)
617
branch_from = branch_to
619
branch_from = Branch.open(location)
621
if branch_to.get_parent() is None or remember:
622
branch_to.set_parent(branch_from.base)
624
if revision is not None:
625
if len(revision) == 1:
626
revision_id = revision[0].in_history(branch_from).rev_id
628
raise errors.BzrCommandError(
629
'bzr pull --revision takes one value.')
631
old_rh = branch_to.revision_history()
632
if tree_to is not None:
633
result = tree_to.pull(branch_from, overwrite, revision_id,
634
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
636
result = branch_to.pull(branch_from, overwrite, revision_id)
638
result.report(self.outf)
640
from bzrlib.log import show_changed_revisions
641
new_rh = branch_to.revision_history()
642
show_changed_revisions(branch_to, old_rh, new_rh,
646
class cmd_push(Command):
647
"""Update a mirror of this branch.
649
The target branch will not have its working tree populated because this
650
is both expensive, and is not supported on remote file systems.
652
Some smart servers or protocols *may* put the working tree in place in
655
This command only works on branches that have not diverged. Branches are
656
considered diverged if the destination branch's most recent commit is one
657
that has not been merged (directly or indirectly) by the source branch.
659
If branches have diverged, you can use 'bzr push --overwrite' to replace
660
the other branch completely, discarding its unmerged changes.
662
If you want to ensure you have the different changes in the other branch,
663
do a merge (see bzr help merge) from the other branch, and commit that.
664
After that you will be able to do a push without '--overwrite'.
666
If there is no default push location set, the first push will set it.
667
After that, you can omit the location to use the default. To change the
668
default, use --remember. The value will only be saved if the remote
669
location can be accessed.
672
_see_also = ['pull', 'update', 'working-trees']
673
takes_options = ['remember', 'overwrite', 'verbose',
674
Option('create-prefix',
675
help='Create the path leading up to the branch '
676
'if it does not already exist'),
678
help='branch to push from, '
679
'rather than the one containing the working directory',
683
Option('use-existing-dir',
684
help='By default push will fail if the target'
685
' directory exists, but does not already'
686
' have a control directory. This flag will'
687
' allow push to proceed.'),
689
takes_args = ['location?']
690
encoding_type = 'replace'
692
def run(self, location=None, remember=False, overwrite=False,
693
create_prefix=False, verbose=False,
694
use_existing_dir=False,
696
# FIXME: Way too big! Put this into a function called from the
698
if directory is None:
700
br_from = Branch.open_containing(directory)[0]
701
stored_loc = br_from.get_push_location()
703
if stored_loc is None:
704
raise errors.BzrCommandError("No push location known or specified.")
706
display_url = urlutils.unescape_for_display(stored_loc,
708
self.outf.write("Using saved location: %s\n" % display_url)
709
location = stored_loc
711
to_transport = transport.get_transport(location)
713
br_to = repository_to = dir_to = None
715
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
716
except errors.NotBranchError:
717
pass # Didn't find anything
719
# If we can open a branch, use its direct repository, otherwise see
720
# if there is a repository without a branch.
722
br_to = dir_to.open_branch()
723
except errors.NotBranchError:
724
# Didn't find a branch, can we find a repository?
726
repository_to = dir_to.find_repository()
727
except errors.NoRepositoryPresent:
730
# Found a branch, so we must have found a repository
731
repository_to = br_to.repository
735
# The destination doesn't exist; create it.
736
# XXX: Refactor the create_prefix/no_create_prefix code into a
737
# common helper function
739
to_transport.mkdir('.')
740
except errors.FileExists:
741
if not use_existing_dir:
742
raise errors.BzrCommandError("Target directory %s"
743
" already exists, but does not have a valid .bzr"
744
" directory. Supply --use-existing-dir to push"
745
" there anyway." % location)
746
except errors.NoSuchFile:
747
if not create_prefix:
748
raise errors.BzrCommandError("Parent directory of %s"
750
"\nYou may supply --create-prefix to create all"
751
" leading parent directories."
754
cur_transport = to_transport
755
needed = [cur_transport]
756
# Recurse upwards until we can create a directory successfully
758
new_transport = cur_transport.clone('..')
759
if new_transport.base == cur_transport.base:
760
raise errors.BzrCommandError("Failed to create path"
764
new_transport.mkdir('.')
765
except errors.NoSuchFile:
766
needed.append(new_transport)
767
cur_transport = new_transport
771
# Now we only need to create child directories
773
cur_transport = needed.pop()
774
cur_transport.ensure_base()
776
# Now the target directory exists, but doesn't have a .bzr
777
# directory. So we need to create it, along with any work to create
778
# all of the dependent branches, etc.
779
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
780
revision_id=br_from.last_revision())
781
br_to = dir_to.open_branch()
782
# TODO: Some more useful message about what was copied
783
note('Created new branch.')
784
# We successfully created the target, remember it
785
if br_from.get_push_location() is None or remember:
786
br_from.set_push_location(br_to.base)
787
elif repository_to is None:
788
# we have a bzrdir but no branch or repository
789
# XXX: Figure out what to do other than complain.
790
raise errors.BzrCommandError("At %s you have a valid .bzr control"
791
" directory, but not a branch or repository. This is an"
792
" unsupported configuration. Please move the target directory"
793
" out of the way and try again."
796
# We have a repository but no branch, copy the revisions, and then
798
last_revision_id = br_from.last_revision()
799
repository_to.fetch(br_from.repository,
800
revision_id=last_revision_id)
801
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
802
note('Created new branch.')
803
if br_from.get_push_location() is None or remember:
804
br_from.set_push_location(br_to.base)
805
else: # We have a valid to branch
806
# We were able to connect to the remote location, so remember it
807
# we don't need to successfully push because of possible divergence.
808
if br_from.get_push_location() is None or remember:
809
br_from.set_push_location(br_to.base)
810
old_rh = br_to.revision_history()
813
tree_to = dir_to.open_workingtree()
814
except errors.NotLocalUrl:
815
warning("This transport does not update the working "
816
"tree of: %s. See 'bzr help working-trees' for "
817
"more information." % br_to.base)
818
push_result = br_from.push(br_to, overwrite)
819
except errors.NoWorkingTree:
820
push_result = br_from.push(br_to, overwrite)
824
push_result = br_from.push(tree_to.branch, overwrite)
828
except errors.DivergedBranches:
829
raise errors.BzrCommandError('These branches have diverged.'
830
' Try using "merge" and then "push".')
831
if push_result is not None:
832
push_result.report(self.outf)
834
new_rh = br_to.revision_history()
837
from bzrlib.log import show_changed_revisions
838
show_changed_revisions(br_to, old_rh, new_rh,
841
# we probably did a clone rather than a push, so a message was
846
class cmd_branch(Command):
847
"""Create a new copy of a branch.
849
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
850
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
851
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
852
is derived from the FROM_LOCATION by stripping a leading scheme or drive
853
identifier, if any. For example, "branch lp:foo-bar" will attempt to
856
To retrieve the branch as of a particular revision, supply the --revision
857
parameter, as in "branch foo/bar -r 5".
860
_see_also = ['checkout']
861
takes_args = ['from_location', 'to_location?']
862
takes_options = ['revision']
863
aliases = ['get', 'clone']
865
def run(self, from_location, to_location=None, revision=None):
866
from bzrlib.tag import _merge_tags_if_possible
869
elif len(revision) > 1:
870
raise errors.BzrCommandError(
871
'bzr branch --revision takes exactly 1 revision value')
873
br_from = Branch.open(from_location)
876
if len(revision) == 1 and revision[0] is not None:
877
revision_id = revision[0].in_history(br_from)[1]
879
# FIXME - wt.last_revision, fallback to branch, fall back to
880
# None or perhaps NULL_REVISION to mean copy nothing
882
revision_id = br_from.last_revision()
883
if to_location is None:
884
to_location = urlutils.derive_to_location(from_location)
887
name = os.path.basename(to_location) + '\n'
889
to_transport = transport.get_transport(to_location)
891
to_transport.mkdir('.')
892
except errors.FileExists:
893
raise errors.BzrCommandError('Target directory "%s" already'
894
' exists.' % to_location)
895
except errors.NoSuchFile:
896
raise errors.BzrCommandError('Parent of "%s" does not exist.'
899
# preserve whatever source format we have.
900
dir = br_from.bzrdir.sprout(to_transport.base, revision_id)
901
branch = dir.open_branch()
902
except errors.NoSuchRevision:
903
to_transport.delete_tree('.')
904
msg = "The branch %s has no revision %s." % (from_location, revision[0])
905
raise errors.BzrCommandError(msg)
907
branch.control_files.put_utf8('branch-name', name)
908
_merge_tags_if_possible(br_from, branch)
909
note('Branched %d revision(s).' % branch.revno())
914
class cmd_checkout(Command):
915
"""Create a new checkout of an existing branch.
917
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
918
the branch found in '.'. This is useful if you have removed the working tree
919
or if it was never created - i.e. if you pushed the branch to its current
922
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
923
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
924
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
925
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
926
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
929
To retrieve the branch as of a particular revision, supply the --revision
930
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
931
out of date [so you cannot commit] but it may be useful (i.e. to examine old
935
_see_also = ['checkouts', 'branch']
936
takes_args = ['branch_location?', 'to_location?']
937
takes_options = ['revision',
938
Option('lightweight',
939
help="perform a lightweight checkout. Lightweight "
940
"checkouts depend on access to the branch for "
941
"every operation. Normal checkouts can perform "
942
"common operations like diff and status without "
943
"such access, and also support local commits."
948
def run(self, branch_location=None, to_location=None, revision=None,
952
elif len(revision) > 1:
953
raise errors.BzrCommandError(
954
'bzr checkout --revision takes exactly 1 revision value')
955
if branch_location is None:
956
branch_location = osutils.getcwd()
957
to_location = branch_location
958
source = Branch.open(branch_location)
959
if len(revision) == 1 and revision[0] is not None:
960
revision_id = revision[0].in_history(source)[1]
963
if to_location is None:
964
to_location = urlutils.derive_to_location(branch_location)
965
# if the source and to_location are the same,
966
# and there is no working tree,
967
# then reconstitute a branch
968
if (osutils.abspath(to_location) ==
969
osutils.abspath(branch_location)):
971
source.bzrdir.open_workingtree()
972
except errors.NoWorkingTree:
973
source.bzrdir.create_workingtree()
976
os.mkdir(to_location)
978
if e.errno == errno.EEXIST:
979
raise errors.BzrCommandError('Target directory "%s" already'
980
' exists.' % to_location)
981
if e.errno == errno.ENOENT:
982
raise errors.BzrCommandError('Parent of "%s" does not exist.'
986
source.create_checkout(to_location, revision_id, lightweight)
989
class cmd_renames(Command):
990
"""Show list of renamed files.
992
# TODO: Option to show renames between two historical versions.
994
# TODO: Only show renames under dir, rather than in the whole branch.
995
_see_also = ['status']
996
takes_args = ['dir?']
999
def run(self, dir=u'.'):
1000
tree = WorkingTree.open_containing(dir)[0]
1003
new_inv = tree.inventory
1004
old_tree = tree.basis_tree()
1005
old_tree.lock_read()
1007
old_inv = old_tree.inventory
1008
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1010
for old_name, new_name in renames:
1011
self.outf.write("%s => %s\n" % (old_name, new_name))
1018
class cmd_update(Command):
1019
"""Update a tree to have the latest code committed to its branch.
1021
This will perform a merge into the working tree, and may generate
1022
conflicts. If you have any local changes, you will still
1023
need to commit them after the update for the update to be complete.
1025
If you want to discard your local changes, you can just do a
1026
'bzr revert' instead of 'bzr commit' after the update.
1029
_see_also = ['pull', 'working-trees']
1030
takes_args = ['dir?']
1033
def run(self, dir='.'):
1034
tree = WorkingTree.open_containing(dir)[0]
1035
master = tree.branch.get_master_branch()
1036
if master is not None:
1039
tree.lock_tree_write()
1041
existing_pending_merges = tree.get_parent_ids()[1:]
1042
last_rev = tree.last_revision()
1043
if last_rev == tree.branch.last_revision():
1044
# may be up to date, check master too.
1045
master = tree.branch.get_master_branch()
1046
if master is None or last_rev == master.last_revision():
1047
revno = tree.branch.revision_id_to_revno(last_rev)
1048
note("Tree is up to date at revision %d." % (revno,))
1050
conflicts = tree.update()
1051
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1052
note('Updated to revision %d.' % (revno,))
1053
if tree.get_parent_ids()[1:] != existing_pending_merges:
1054
note('Your local commits will now show as pending merges with '
1055
"'bzr status', and can be committed with 'bzr commit'.")
1064
class cmd_info(Command):
1065
"""Show information about a working tree, branch or repository.
1067
This command will show all known locations and formats associated to the
1068
tree, branch or repository. Statistical information is included with
1071
Branches and working trees will also report any missing revisions.
1073
_see_also = ['revno', 'working-trees', 'repositories']
1074
takes_args = ['location?']
1075
takes_options = ['verbose']
1078
def run(self, location=None, verbose=False):
1079
from bzrlib.info import show_bzrdir_info
1080
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1084
class cmd_remove(Command):
1085
"""Remove files or directories.
1087
This makes bzr stop tracking changes to the specified files and
1088
delete them if they can easily be recovered using revert.
1090
You can specify one or more files, and/or --new. If you specify --new,
1091
only 'added' files will be removed. If you specify both, then new files
1092
in the specified directories will be removed. If the directories are
1093
also new, they will also be removed.
1095
takes_args = ['file*']
1096
takes_options = ['verbose',
1097
Option('new', help='remove newly-added files'),
1098
RegistryOption.from_kwargs('file-deletion-strategy',
1099
'The file deletion mode to be used',
1100
title='Deletion Strategy', value_switches=True, enum_switch=False,
1101
safe='Only delete files if they can be'
1102
' safely recovered (default).',
1103
keep="Don't delete any files.",
1104
force='Delete all the specified files, even if they can not be '
1105
'recovered and even if they are non-empty directories.')]
1107
encoding_type = 'replace'
1109
def run(self, file_list, verbose=False, new=False,
1110
file_deletion_strategy='safe'):
1111
tree, file_list = tree_files(file_list)
1113
if file_list is not None:
1114
file_list = [f for f in file_list if f != '']
1116
raise errors.BzrCommandError('Specify one or more files to'
1117
' remove, or use --new.')
1120
added = tree.changes_from(tree.basis_tree(),
1121
specific_files=file_list).added
1122
file_list = sorted([f[0] for f in added], reverse=True)
1123
if len(file_list) == 0:
1124
raise errors.BzrCommandError('No matching files.')
1125
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1126
keep_files=file_deletion_strategy=='keep',
1127
force=file_deletion_strategy=='force')
1130
class cmd_file_id(Command):
1131
"""Print file_id of a particular file or directory.
1133
The file_id is assigned when the file is first added and remains the
1134
same through all revisions where the file exists, even when it is
1139
_see_also = ['inventory', 'ls']
1140
takes_args = ['filename']
1143
def run(self, filename):
1144
tree, relpath = WorkingTree.open_containing(filename)
1145
i = tree.path2id(relpath)
1147
raise errors.NotVersionedError(filename)
1149
self.outf.write(i + '\n')
1152
class cmd_file_path(Command):
1153
"""Print path of file_ids to a file or directory.
1155
This prints one line for each directory down to the target,
1156
starting at the branch root.
1160
takes_args = ['filename']
1163
def run(self, filename):
1164
tree, relpath = WorkingTree.open_containing(filename)
1165
fid = tree.path2id(relpath)
1167
raise errors.NotVersionedError(filename)
1168
segments = osutils.splitpath(relpath)
1169
for pos in range(1, len(segments) + 1):
1170
path = osutils.joinpath(segments[:pos])
1171
self.outf.write("%s\n" % tree.path2id(path))
1174
class cmd_reconcile(Command):
1175
"""Reconcile bzr metadata in a branch.
1177
This can correct data mismatches that may have been caused by
1178
previous ghost operations or bzr upgrades. You should only
1179
need to run this command if 'bzr check' or a bzr developer
1180
advises you to run it.
1182
If a second branch is provided, cross-branch reconciliation is
1183
also attempted, which will check that data like the tree root
1184
id which was not present in very early bzr versions is represented
1185
correctly in both branches.
1187
At the same time it is run it may recompress data resulting in
1188
a potential saving in disk space or performance gain.
1190
The branch *MUST* be on a listable system such as local disk or sftp.
1193
_see_also = ['check']
1194
takes_args = ['branch?']
1196
def run(self, branch="."):
1197
from bzrlib.reconcile import reconcile
1198
dir = bzrdir.BzrDir.open(branch)
1202
class cmd_revision_history(Command):
1203
"""Display the list of revision ids on a branch."""
1206
takes_args = ['location?']
1211
def run(self, location="."):
1212
branch = Branch.open_containing(location)[0]
1213
for revid in branch.revision_history():
1214
self.outf.write(revid)
1215
self.outf.write('\n')
1218
class cmd_ancestry(Command):
1219
"""List all revisions merged into this branch."""
1221
_see_also = ['log', 'revision-history']
1222
takes_args = ['location?']
1227
def run(self, location="."):
1229
wt = WorkingTree.open_containing(location)[0]
1230
except errors.NoWorkingTree:
1231
b = Branch.open(location)
1232
last_revision = b.last_revision()
1235
last_revision = wt.last_revision()
1237
revision_ids = b.repository.get_ancestry(last_revision)
1238
assert revision_ids[0] is None
1240
for revision_id in revision_ids:
1241
self.outf.write(revision_id + '\n')
1244
class cmd_init(Command):
1245
"""Make a directory into a versioned branch.
1247
Use this to create an empty branch, or before importing an
1250
If there is a repository in a parent directory of the location, then
1251
the history of the branch will be stored in the repository. Otherwise
1252
init creates a standalone branch which carries its own history
1253
in the .bzr directory.
1255
If there is already a branch at the location but it has no working tree,
1256
the tree can be populated with 'bzr checkout'.
1258
Recipe for importing a tree of files:
1263
bzr commit -m 'imported project'
1266
_see_also = ['init-repo', 'branch', 'checkout']
1267
takes_args = ['location?']
1269
RegistryOption('format',
1270
help='Specify a format for this branch. '
1271
'See "help formats".',
1272
registry=bzrdir.format_registry,
1273
converter=bzrdir.format_registry.make_bzrdir,
1274
value_switches=True,
1275
title="Branch Format",
1277
Option('append-revisions-only',
1278
help='Never change revnos or the existing log.'
1279
' Append revisions to it only.')
1281
def run(self, location=None, format=None, append_revisions_only=False):
1283
format = bzrdir.format_registry.make_bzrdir('default')
1284
if location is None:
1287
to_transport = transport.get_transport(location)
1289
# The path has to exist to initialize a
1290
# branch inside of it.
1291
# Just using os.mkdir, since I don't
1292
# believe that we want to create a bunch of
1293
# locations if the user supplies an extended path
1294
# TODO: create-prefix
1295
to_transport.ensure_base()
1298
existing_bzrdir = bzrdir.BzrDir.open(location)
1299
except errors.NotBranchError:
1300
# really a NotBzrDir error...
1301
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1304
from bzrlib.transport.local import LocalTransport
1305
if existing_bzrdir.has_branch():
1306
if (isinstance(to_transport, LocalTransport)
1307
and not existing_bzrdir.has_workingtree()):
1308
raise errors.BranchExistsWithoutWorkingTree(location)
1309
raise errors.AlreadyBranchError(location)
1311
branch = existing_bzrdir.create_branch()
1312
existing_bzrdir.create_workingtree()
1313
if append_revisions_only:
1315
branch.set_append_revisions_only(True)
1316
except errors.UpgradeRequired:
1317
raise errors.BzrCommandError('This branch format cannot be set'
1318
' to append-revisions-only. Try --experimental-branch6')
1321
class cmd_init_repository(Command):
1322
"""Create a shared repository to hold branches.
1324
New branches created under the repository directory will store their
1325
revisions in the repository, not in the branch directory.
1327
If the --no-trees option is used then the branches in the repository
1328
will not have working trees by default.
1331
bzr init-repo --no-trees repo
1333
bzr checkout --lightweight repo/trunk trunk-checkout
1337
See 'bzr help repositories' for more information.
1340
_see_also = ['init', 'branch', 'checkout']
1341
takes_args = ["location"]
1342
takes_options = [RegistryOption('format',
1343
help='Specify a format for this repository. See'
1344
' "bzr help formats" for details',
1345
registry=bzrdir.format_registry,
1346
converter=bzrdir.format_registry.make_bzrdir,
1347
value_switches=True, title='Repository format'),
1349
help='Branches in the repository will default to'
1350
' not having a working tree'),
1352
aliases = ["init-repo"]
1354
def run(self, location, format=None, no_trees=False):
1356
format = bzrdir.format_registry.make_bzrdir('default')
1358
if location is None:
1361
to_transport = transport.get_transport(location)
1362
to_transport.ensure_base()
1364
newdir = format.initialize_on_transport(to_transport)
1365
repo = newdir.create_repository(shared=True)
1366
repo.set_make_working_trees(not no_trees)
1369
class cmd_diff(Command):
1370
"""Show differences in the working tree or between revisions.
1372
If files are listed, only the changes in those files are listed.
1373
Otherwise, all changes for the tree are listed.
1375
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1376
produces patches suitable for "patch -p1".
1380
Shows the difference in the working tree versus the last commit
1382
Difference between the working tree and revision 1
1384
Difference between revision 2 and revision 1
1385
bzr diff --prefix old/:new/
1386
Same as 'bzr diff' but prefix paths with old/ and new/
1387
bzr diff bzr.mine bzr.dev
1388
Show the differences between the two working trees
1390
Show just the differences for 'foo.c'
1392
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1393
# or a graphical diff.
1395
# TODO: Python difflib is not exactly the same as unidiff; should
1396
# either fix it up or prefer to use an external diff.
1398
# TODO: Selected-file diff is inefficient and doesn't show you
1401
# TODO: This probably handles non-Unix newlines poorly.
1403
_see_also = ['status']
1404
takes_args = ['file*']
1405
takes_options = ['revision', 'diff-options',
1406
Option('prefix', type=str,
1408
help='Set prefixes to added to old and new filenames, as '
1409
'two values separated by a colon. (eg "old/:new/")'),
1411
aliases = ['di', 'dif']
1412
encoding_type = 'exact'
1415
def run(self, revision=None, file_list=None, diff_options=None,
1417
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1419
if (prefix is None) or (prefix == '0'):
1427
old_label, new_label = prefix.split(":")
1429
raise errors.BzrCommandError(
1430
'--prefix expects two values separated by a colon'
1431
' (eg "old/:new/")')
1433
if revision and len(revision) > 2:
1434
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1435
' one or two revision specifiers')
1438
tree1, file_list = internal_tree_files(file_list)
1442
except errors.FileInWrongBranch:
1443
if len(file_list) != 2:
1444
raise errors.BzrCommandError("Files are in different branches")
1446
tree1, file1 = WorkingTree.open_containing(file_list[0])
1447
tree2, file2 = WorkingTree.open_containing(file_list[1])
1448
if file1 != "" or file2 != "":
1449
# FIXME diff those two files. rbc 20051123
1450
raise errors.BzrCommandError("Files are in different branches")
1452
except errors.NotBranchError:
1453
if (revision is not None and len(revision) == 2
1454
and not revision[0].needs_branch()
1455
and not revision[1].needs_branch()):
1456
# If both revision specs include a branch, we can
1457
# diff them without needing a local working tree
1458
tree1, tree2 = None, None
1462
if tree2 is not None:
1463
if revision is not None:
1464
# FIXME: but there should be a clean way to diff between
1465
# non-default versions of two trees, it's not hard to do
1467
raise errors.BzrCommandError(
1468
"Sorry, diffing arbitrary revisions across branches "
1469
"is not implemented yet")
1470
return show_diff_trees(tree1, tree2, sys.stdout,
1471
specific_files=file_list,
1472
external_diff_options=diff_options,
1473
old_label=old_label, new_label=new_label)
1475
return diff_cmd_helper(tree1, file_list, diff_options,
1476
revision_specs=revision,
1477
old_label=old_label, new_label=new_label)
1480
class cmd_deleted(Command):
1481
"""List files deleted in the working tree.
1483
# TODO: Show files deleted since a previous revision, or
1484
# between two revisions.
1485
# TODO: Much more efficient way to do this: read in new
1486
# directories with readdir, rather than stating each one. Same
1487
# level of effort but possibly much less IO. (Or possibly not,
1488
# if the directories are very large...)
1489
_see_also = ['status', 'ls']
1490
takes_options = ['show-ids']
1493
def run(self, show_ids=False):
1494
tree = WorkingTree.open_containing(u'.')[0]
1497
old = tree.basis_tree()
1500
for path, ie in old.inventory.iter_entries():
1501
if not tree.has_id(ie.file_id):
1502
self.outf.write(path)
1504
self.outf.write(' ')
1505
self.outf.write(ie.file_id)
1506
self.outf.write('\n')
1513
class cmd_modified(Command):
1514
"""List files modified in working tree.
1518
_see_also = ['status', 'ls']
1522
tree = WorkingTree.open_containing(u'.')[0]
1523
td = tree.changes_from(tree.basis_tree())
1524
for path, id, kind, text_modified, meta_modified in td.modified:
1525
self.outf.write(path + '\n')
1528
class cmd_added(Command):
1529
"""List files added in working tree.
1533
_see_also = ['status', 'ls']
1537
wt = WorkingTree.open_containing(u'.')[0]
1540
basis = wt.basis_tree()
1543
basis_inv = basis.inventory
1546
if file_id in basis_inv:
1548
if inv.is_root(file_id) and len(basis_inv) == 0:
1550
path = inv.id2path(file_id)
1551
if not os.access(osutils.abspath(path), os.F_OK):
1553
self.outf.write(path + '\n')
1560
class cmd_root(Command):
1561
"""Show the tree root directory.
1563
The root is the nearest enclosing directory with a .bzr control
1566
takes_args = ['filename?']
1568
def run(self, filename=None):
1569
"""Print the branch root."""
1570
tree = WorkingTree.open_containing(filename)[0]
1571
self.outf.write(tree.basedir + '\n')
1574
def _parse_limit(limitstring):
1576
return int(limitstring)
1578
msg = "The limit argument must be an integer."
1579
raise errors.BzrCommandError(msg)
1582
class cmd_log(Command):
1583
"""Show log of a branch, file, or directory.
1585
By default show the log of the branch containing the working directory.
1587
To request a range of logs, you can use the command -r begin..end
1588
-r revision requests a specific revision, -r ..end or -r begin.. are
1594
bzr log -r -10.. http://server/branch
1597
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1599
takes_args = ['location?']
1600
takes_options = [Option('forward',
1601
help='show from oldest to newest'),
1605
help='show files changed in each revision'),
1606
'show-ids', 'revision',
1610
help='show revisions whose message matches this regexp',
1613
help='limit the output to the first N revisions',
1616
encoding_type = 'replace'
1619
def run(self, location=None, timezone='original',
1627
from bzrlib.log import show_log
1628
assert message is None or isinstance(message, basestring), \
1629
"invalid message argument %r" % message
1630
direction = (forward and 'forward') or 'reverse'
1635
# find the file id to log:
1637
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1641
tree = b.basis_tree()
1642
file_id = tree.path2id(fp)
1644
raise errors.BzrCommandError(
1645
"Path does not have any revision history: %s" %
1649
# FIXME ? log the current subdir only RBC 20060203
1650
if revision is not None \
1651
and len(revision) > 0 and revision[0].get_branch():
1652
location = revision[0].get_branch()
1655
dir, relpath = bzrdir.BzrDir.open_containing(location)
1656
b = dir.open_branch()
1660
if revision is None:
1663
elif len(revision) == 1:
1664
rev1 = rev2 = revision[0].in_history(b).revno
1665
elif len(revision) == 2:
1666
if revision[1].get_branch() != revision[0].get_branch():
1667
# b is taken from revision[0].get_branch(), and
1668
# show_log will use its revision_history. Having
1669
# different branches will lead to weird behaviors.
1670
raise errors.BzrCommandError(
1671
"Log doesn't accept two revisions in different"
1673
if revision[0].spec is None:
1674
# missing begin-range means first revision
1677
rev1 = revision[0].in_history(b).revno
1679
if revision[1].spec is None:
1680
# missing end-range means last known revision
1683
rev2 = revision[1].in_history(b).revno
1685
raise errors.BzrCommandError(
1686
'bzr log --revision takes one or two values.')
1688
# By this point, the revision numbers are converted to the +ve
1689
# form if they were supplied in the -ve form, so we can do
1690
# this comparison in relative safety
1692
(rev2, rev1) = (rev1, rev2)
1694
if log_format is None:
1695
log_format = log.log_formatter_registry.get_default(b)
1697
lf = log_format(show_ids=show_ids, to_file=self.outf,
1698
show_timezone=timezone)
1704
direction=direction,
1705
start_revision=rev1,
1713
def get_log_format(long=False, short=False, line=False, default='long'):
1714
log_format = default
1718
log_format = 'short'
1724
class cmd_touching_revisions(Command):
1725
"""Return revision-ids which affected a particular file.
1727
A more user-friendly interface is "bzr log FILE".
1731
takes_args = ["filename"]
1734
def run(self, filename):
1735
tree, relpath = WorkingTree.open_containing(filename)
1737
file_id = tree.path2id(relpath)
1738
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1739
self.outf.write("%6d %s\n" % (revno, what))
1742
class cmd_ls(Command):
1743
"""List files in a tree.
1746
_see_also = ['status', 'cat']
1747
takes_args = ['path?']
1748
# TODO: Take a revision or remote path and list that tree instead.
1749
takes_options = ['verbose', 'revision',
1750
Option('non-recursive',
1751
help='don\'t recurse into sub-directories'),
1753
help='Print all paths from the root of the branch.'),
1754
Option('unknown', help='Print unknown files'),
1755
Option('versioned', help='Print versioned files'),
1756
Option('ignored', help='Print ignored files'),
1758
Option('null', help='Null separate the files'),
1762
def run(self, revision=None, verbose=False,
1763
non_recursive=False, from_root=False,
1764
unknown=False, versioned=False, ignored=False,
1765
null=False, kind=None, show_ids=False, path=None):
1767
if kind and kind not in ('file', 'directory', 'symlink'):
1768
raise errors.BzrCommandError('invalid kind specified')
1770
if verbose and null:
1771
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1772
all = not (unknown or versioned or ignored)
1774
selection = {'I':ignored, '?':unknown, 'V':versioned}
1781
raise errors.BzrCommandError('cannot specify both --from-root'
1785
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1791
if revision is not None:
1792
tree = branch.repository.revision_tree(
1793
revision[0].in_history(branch).rev_id)
1795
tree = branch.basis_tree()
1799
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1800
if fp.startswith(relpath):
1801
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1802
if non_recursive and '/' in fp:
1804
if not all and not selection[fc]:
1806
if kind is not None and fkind != kind:
1809
kindch = entry.kind_character()
1810
outstring = '%-8s %s%s' % (fc, fp, kindch)
1811
if show_ids and fid is not None:
1812
outstring = "%-50s %s" % (outstring, fid)
1813
self.outf.write(outstring + '\n')
1815
self.outf.write(fp + '\0')
1818
self.outf.write(fid)
1819
self.outf.write('\0')
1827
self.outf.write('%-50s %s\n' % (fp, my_id))
1829
self.outf.write(fp + '\n')
1834
class cmd_unknowns(Command):
1835
"""List unknown files.
1843
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1844
self.outf.write(osutils.quotefn(f) + '\n')
1847
class cmd_ignore(Command):
1848
"""Ignore specified files or patterns.
1850
To remove patterns from the ignore list, edit the .bzrignore file.
1852
Trailing slashes on patterns are ignored.
1853
If the pattern contains a slash or is a regular expression, it is compared
1854
to the whole path from the branch root. Otherwise, it is compared to only
1855
the last component of the path. To match a file only in the root
1856
directory, prepend './'.
1858
Ignore patterns specifying absolute paths are not allowed.
1860
Ignore patterns may include globbing wildcards such as:
1861
? - Matches any single character except '/'
1862
* - Matches 0 or more characters except '/'
1863
/**/ - Matches 0 or more directories in a path
1864
[a-z] - Matches a single character from within a group of characters
1866
Ignore patterns may also be Python regular expressions.
1867
Regular expression ignore patterns are identified by a 'RE:' prefix
1868
followed by the regular expression. Regular expression ignore patterns
1869
may not include named or numbered groups.
1871
Note: ignore patterns containing shell wildcards must be quoted from
1875
bzr ignore ./Makefile
1876
bzr ignore '*.class'
1877
bzr ignore 'lib/**/*.o'
1878
bzr ignore 'RE:lib/.*\.o'
1881
_see_also = ['status', 'ignored']
1882
takes_args = ['name_pattern*']
1884
Option('old-default-rules',
1885
help='Out the ignore rules bzr < 0.9 always used.')
1888
def run(self, name_pattern_list=None, old_default_rules=None):
1889
from bzrlib.atomicfile import AtomicFile
1890
if old_default_rules is not None:
1891
# dump the rules and exit
1892
for pattern in ignores.OLD_DEFAULTS:
1895
if not name_pattern_list:
1896
raise errors.BzrCommandError("ignore requires at least one "
1897
"NAME_PATTERN or --old-default-rules")
1898
name_pattern_list = [globbing.normalize_pattern(p)
1899
for p in name_pattern_list]
1900
for name_pattern in name_pattern_list:
1901
if (name_pattern[0] == '/' or
1902
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1903
raise errors.BzrCommandError(
1904
"NAME_PATTERN should not be an absolute path")
1905
tree, relpath = WorkingTree.open_containing(u'.')
1906
ifn = tree.abspath('.bzrignore')
1907
if os.path.exists(ifn):
1910
igns = f.read().decode('utf-8')
1916
# TODO: If the file already uses crlf-style termination, maybe
1917
# we should use that for the newly added lines?
1919
if igns and igns[-1] != '\n':
1921
for name_pattern in name_pattern_list:
1922
igns += name_pattern + '\n'
1924
f = AtomicFile(ifn, 'wb')
1926
f.write(igns.encode('utf-8'))
1931
if not tree.path2id('.bzrignore'):
1932
tree.add(['.bzrignore'])
1935
class cmd_ignored(Command):
1936
"""List ignored files and the patterns that matched them.
1939
_see_also = ['ignore']
1942
tree = WorkingTree.open_containing(u'.')[0]
1945
for path, file_class, kind, file_id, entry in tree.list_files():
1946
if file_class != 'I':
1948
## XXX: Slightly inefficient since this was already calculated
1949
pat = tree.is_ignored(path)
1950
print '%-50s %s' % (path, pat)
1955
class cmd_lookup_revision(Command):
1956
"""Lookup the revision-id from a revision-number
1959
bzr lookup-revision 33
1962
takes_args = ['revno']
1965
def run(self, revno):
1969
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1971
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1974
class cmd_export(Command):
1975
"""Export current or past revision to a destination directory or archive.
1977
If no revision is specified this exports the last committed revision.
1979
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1980
given, try to find the format with the extension. If no extension
1981
is found exports to a directory (equivalent to --format=dir).
1983
If root is supplied, it will be used as the root directory inside
1984
container formats (tar, zip, etc). If it is not supplied it will default
1985
to the exported filename. The root option has no effect for 'dir' format.
1987
If branch is omitted then the branch containing the current working
1988
directory will be used.
1990
Note: Export of tree with non-ASCII filenames to zip is not supported.
1992
Supported formats Autodetected by extension
1993
----------------- -------------------------
1996
tbz2 .tar.bz2, .tbz2
2000
takes_args = ['dest', 'branch?']
2001
takes_options = ['revision', 'format', 'root']
2002
def run(self, dest, branch=None, revision=None, format=None, root=None):
2003
from bzrlib.export import export
2006
tree = WorkingTree.open_containing(u'.')[0]
2009
b = Branch.open(branch)
2011
if revision is None:
2012
# should be tree.last_revision FIXME
2013
rev_id = b.last_revision()
2015
if len(revision) != 1:
2016
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2017
rev_id = revision[0].in_history(b).rev_id
2018
t = b.repository.revision_tree(rev_id)
2020
export(t, dest, format, root)
2021
except errors.NoSuchExportFormat, e:
2022
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2025
class cmd_cat(Command):
2026
"""Write the contents of a file as of a given revision to standard output.
2028
If no revision is nominated, the last revision is used.
2030
Note: Take care to redirect standard output when using this command on a
2035
takes_options = ['revision', 'name-from-revision']
2036
takes_args = ['filename']
2037
encoding_type = 'exact'
2040
def run(self, filename, revision=None, name_from_revision=False):
2041
if revision is not None and len(revision) != 1:
2042
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2047
tree, b, relpath = \
2048
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2049
except errors.NotBranchError:
2052
if revision is not None and revision[0].get_branch() is not None:
2053
b = Branch.open(revision[0].get_branch())
2055
tree = b.basis_tree()
2056
if revision is None:
2057
revision_id = b.last_revision()
2059
revision_id = revision[0].in_history(b).rev_id
2061
cur_file_id = tree.path2id(relpath)
2062
rev_tree = b.repository.revision_tree(revision_id)
2063
old_file_id = rev_tree.path2id(relpath)
2065
if name_from_revision:
2066
if old_file_id is None:
2067
raise errors.BzrCommandError("%r is not present in revision %s"
2068
% (filename, revision_id))
2070
rev_tree.print_file(old_file_id)
2071
elif cur_file_id is not None:
2072
rev_tree.print_file(cur_file_id)
2073
elif old_file_id is not None:
2074
rev_tree.print_file(old_file_id)
2076
raise errors.BzrCommandError("%r is not present in revision %s" %
2077
(filename, revision_id))
2080
class cmd_local_time_offset(Command):
2081
"""Show the offset in seconds from GMT to local time."""
2085
print osutils.local_time_offset()
2089
class cmd_commit(Command):
2090
"""Commit changes into a new revision.
2092
If no arguments are given, the entire tree is committed.
2094
If selected files are specified, only changes to those files are
2095
committed. If a directory is specified then the directory and everything
2096
within it is committed.
2098
A selected-file commit may fail in some cases where the committed
2099
tree would be invalid. Consider::
2104
bzr commit foo -m "committing foo"
2105
bzr mv foo/bar foo/baz
2108
bzr commit foo/bar -m "committing bar but not baz"
2110
In the example above, the last commit will fail by design. This gives
2111
the user the opportunity to decide whether they want to commit the
2112
rename at the same time, separately first, or not at all. (As a general
2113
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2115
Note: A selected-file commit after a merge is not yet supported.
2117
# TODO: Run hooks on tree to-be-committed, and after commit.
2119
# TODO: Strict commit that fails if there are deleted files.
2120
# (what does "deleted files" mean ??)
2122
# TODO: Give better message for -s, --summary, used by tla people
2124
# XXX: verbose currently does nothing
2126
_see_also = ['bugs', 'uncommit']
2127
takes_args = ['selected*']
2128
takes_options = ['message', 'verbose',
2130
help='commit even if nothing has changed'),
2131
Option('file', type=str,
2134
help='file containing commit message'),
2136
help="refuse to commit if there are unknown "
2137
"files in the working tree."),
2138
ListOption('fixes', type=str,
2139
help="mark a bug as being fixed by this "
2142
help="perform a local only commit in a bound "
2143
"branch. Such commits are not pushed to "
2144
"the master branch until a normal commit "
2148
aliases = ['ci', 'checkin']
2150
def _get_bug_fix_properties(self, fixes, branch):
2152
# Configure the properties for bug fixing attributes.
2153
for fixed_bug in fixes:
2154
tokens = fixed_bug.split(':')
2155
if len(tokens) != 2:
2156
raise errors.BzrCommandError(
2157
"Invalid bug %s. Must be in the form of 'tag:id'. "
2158
"Commit refused." % fixed_bug)
2159
tag, bug_id = tokens
2161
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2162
except errors.UnknownBugTrackerAbbreviation:
2163
raise errors.BzrCommandError(
2164
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2165
except errors.MalformedBugIdentifier:
2166
raise errors.BzrCommandError(
2167
"Invalid bug identifier for %s. Commit refused."
2169
properties.append('%s fixed' % bug_url)
2170
return '\n'.join(properties)
2172
def run(self, message=None, file=None, verbose=True, selected_list=None,
2173
unchanged=False, strict=False, local=False, fixes=None):
2174
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2175
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2177
from bzrlib.msgeditor import edit_commit_message, \
2178
make_commit_message_template
2180
# TODO: Need a blackbox test for invoking the external editor; may be
2181
# slightly problematic to run this cross-platform.
2183
# TODO: do more checks that the commit will succeed before
2184
# spending the user's valuable time typing a commit message.
2188
tree, selected_list = tree_files(selected_list)
2189
if selected_list == ['']:
2190
# workaround - commit of root of tree should be exactly the same
2191
# as just default commit in that tree, and succeed even though
2192
# selected-file merge commit is not done yet
2195
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2197
properties['bugs'] = bug_property
2199
if local and not tree.branch.get_bound_location():
2200
raise errors.LocalRequiresBoundBranch()
2202
def get_message(commit_obj):
2203
"""Callback to get commit message"""
2204
my_message = message
2205
if my_message is None and not file:
2206
template = make_commit_message_template(tree, selected_list)
2207
my_message = edit_commit_message(template)
2208
if my_message is None:
2209
raise errors.BzrCommandError("please specify a commit"
2210
" message with either --message or --file")
2211
elif my_message and file:
2212
raise errors.BzrCommandError(
2213
"please specify either --message or --file")
2215
my_message = codecs.open(file, 'rt',
2216
bzrlib.user_encoding).read()
2217
if my_message == "":
2218
raise errors.BzrCommandError("empty commit message specified")
2222
reporter = ReportCommitToLog()
2224
reporter = NullCommitReporter()
2227
tree.commit(message_callback=get_message,
2228
specific_files=selected_list,
2229
allow_pointless=unchanged, strict=strict, local=local,
2230
reporter=reporter, revprops=properties)
2231
except PointlessCommit:
2232
# FIXME: This should really happen before the file is read in;
2233
# perhaps prepare the commit; get the message; then actually commit
2234
raise errors.BzrCommandError("no changes to commit."
2235
" use --unchanged to commit anyhow")
2236
except ConflictsInTree:
2237
raise errors.BzrCommandError('Conflicts detected in working '
2238
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2240
except StrictCommitFailed:
2241
raise errors.BzrCommandError("Commit refused because there are"
2242
" unknown files in the working tree.")
2243
except errors.BoundBranchOutOfDate, e:
2244
raise errors.BzrCommandError(str(e) + "\n"
2245
'To commit to master branch, run update and then commit.\n'
2246
'You can also pass --local to commit to continue working '
2250
class cmd_check(Command):
2251
"""Validate consistency of branch history.
2253
This command checks various invariants about the branch storage to
2254
detect data corruption or bzr bugs.
2257
_see_also = ['reconcile']
2258
takes_args = ['branch?']
2259
takes_options = ['verbose']
2261
def run(self, branch=None, verbose=False):
2262
from bzrlib.check import check
2264
tree = WorkingTree.open_containing()[0]
2265
branch = tree.branch
2267
branch = Branch.open(branch)
2268
check(branch, verbose)
2271
class cmd_upgrade(Command):
2272
"""Upgrade branch storage to current format.
2274
The check command or bzr developers may sometimes advise you to run
2275
this command. When the default format has changed you may also be warned
2276
during other operations to upgrade.
2279
_see_also = ['check']
2280
takes_args = ['url?']
2282
RegistryOption('format',
2283
help='Upgrade to a specific format. See "bzr help'
2284
' formats" for details',
2285
registry=bzrdir.format_registry,
2286
converter=bzrdir.format_registry.make_bzrdir,
2287
value_switches=True, title='Branch format'),
2290
def run(self, url='.', format=None):
2291
from bzrlib.upgrade import upgrade
2293
format = bzrdir.format_registry.make_bzrdir('default')
2294
upgrade(url, format)
2297
class cmd_whoami(Command):
2298
"""Show or set bzr user id.
2302
bzr whoami 'Frank Chu <fchu@example.com>'
2304
takes_options = [ Option('email',
2305
help='display email address only'),
2307
help='set identity for the current branch instead of '
2310
takes_args = ['name?']
2311
encoding_type = 'replace'
2314
def run(self, email=False, branch=False, name=None):
2316
# use branch if we're inside one; otherwise global config
2318
c = Branch.open_containing('.')[0].get_config()
2319
except errors.NotBranchError:
2320
c = config.GlobalConfig()
2322
self.outf.write(c.user_email() + '\n')
2324
self.outf.write(c.username() + '\n')
2327
# display a warning if an email address isn't included in the given name.
2329
config.extract_email_address(name)
2330
except errors.NoEmailInUsername, e:
2331
warning('"%s" does not seem to contain an email address. '
2332
'This is allowed, but not recommended.', name)
2334
# use global config unless --branch given
2336
c = Branch.open_containing('.')[0].get_config()
2338
c = config.GlobalConfig()
2339
c.set_user_option('email', name)
2342
class cmd_nick(Command):
2343
"""Print or set the branch nickname.
2345
If unset, the tree root directory name is used as the nickname
2346
To print the current nickname, execute with no argument.
2349
_see_also = ['info']
2350
takes_args = ['nickname?']
2351
def run(self, nickname=None):
2352
branch = Branch.open_containing(u'.')[0]
2353
if nickname is None:
2354
self.printme(branch)
2356
branch.nick = nickname
2359
def printme(self, branch):
2363
class cmd_selftest(Command):
2364
"""Run internal test suite.
2366
This creates temporary test directories in the working directory, but no
2367
existing data is affected. These directories are deleted if the tests
2368
pass, or left behind to help in debugging if they fail and --keep-output
2371
If arguments are given, they are regular expressions that say which tests
2372
should run. Tests matching any expression are run, and other tests are
2375
Alternatively if --first is given, matching tests are run first and then
2376
all other tests are run. This is useful if you have been working in a
2377
particular area, but want to make sure nothing else was broken.
2379
If --exclude is given, tests that match that regular expression are
2380
excluded, regardless of whether they match --first or not.
2382
To help catch accidential dependencies between tests, the --randomize
2383
option is useful. In most cases, the argument used is the word 'now'.
2384
Note that the seed used for the random number generator is displayed
2385
when this option is used. The seed can be explicitly passed as the
2386
argument to this option if required. This enables reproduction of the
2387
actual ordering used if and when an order sensitive problem is encountered.
2389
If --list-only is given, the tests that would be run are listed. This is
2390
useful when combined with --first, --exclude and/or --randomize to
2391
understand their impact. The test harness reports "Listed nn tests in ..."
2392
instead of "Ran nn tests in ..." when list mode is enabled.
2394
If the global option '--no-plugins' is given, plugins are not loaded
2395
before running the selftests. This has two effects: features provided or
2396
modified by plugins will not be tested, and tests provided by plugins will
2401
run only tests relating to 'ignore'
2402
bzr --no-plugins selftest -v
2403
disable plugins and list tests as they're run
2405
For each test, that needs actual disk access, bzr create their own
2406
subdirectory in the temporary testing directory (testXXXX.tmp).
2407
By default the name of such subdirectory is based on the name of the test.
2408
If option '--numbered-dirs' is given, bzr will use sequent numbers
2409
of running tests to create such subdirectories. This is default behavior
2410
on Windows because of path length limitation.
2412
# NB: this is used from the class without creating an instance, which is
2413
# why it does not have a self parameter.
2414
def get_transport_type(typestring):
2415
"""Parse and return a transport specifier."""
2416
if typestring == "sftp":
2417
from bzrlib.transport.sftp import SFTPAbsoluteServer
2418
return SFTPAbsoluteServer
2419
if typestring == "memory":
2420
from bzrlib.transport.memory import MemoryServer
2422
if typestring == "fakenfs":
2423
from bzrlib.transport.fakenfs import FakeNFSServer
2424
return FakeNFSServer
2425
msg = "No known transport type %s. Supported types are: sftp\n" %\
2427
raise errors.BzrCommandError(msg)
2430
takes_args = ['testspecs*']
2431
takes_options = ['verbose',
2433
help='stop when one test fails',
2436
Option('keep-output',
2437
help='keep output directories when tests fail'),
2439
help='Use a different transport by default '
2440
'throughout the test suite.',
2441
type=get_transport_type),
2442
Option('benchmark', help='run the bzr benchmarks.'),
2443
Option('lsprof-timed',
2444
help='generate lsprof output for benchmarked'
2445
' sections of code.'),
2446
Option('cache-dir', type=str,
2447
help='a directory to cache intermediate'
2448
' benchmark steps'),
2449
Option('clean-output',
2450
help='clean temporary tests directories'
2451
' without running tests'),
2453
help='run all tests, but run specified tests first',
2456
Option('numbered-dirs',
2457
help='use numbered dirs for TestCaseInTempDir'),
2459
help='list the tests instead of running them'),
2460
Option('randomize', type=str, argname="SEED",
2461
help='randomize the order of tests using the given'
2462
' seed or "now" for the current time'),
2463
Option('exclude', type=str, argname="PATTERN",
2465
help='exclude tests that match this regular'
2468
encoding_type = 'replace'
2470
def run(self, testspecs_list=None, verbose=None, one=False,
2471
keep_output=False, transport=None, benchmark=None,
2472
lsprof_timed=None, cache_dir=None, clean_output=False,
2473
first=False, numbered_dirs=None, list_only=False,
2474
randomize=None, exclude=None):
2476
from bzrlib.tests import selftest
2477
import bzrlib.benchmarks as benchmarks
2478
from bzrlib.benchmarks import tree_creator
2481
from bzrlib.tests import clean_selftest_output
2482
clean_selftest_output()
2485
if numbered_dirs is None and sys.platform == 'win32':
2486
numbered_dirs = True
2488
if cache_dir is not None:
2489
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2490
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2491
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2493
if testspecs_list is not None:
2494
pattern = '|'.join(testspecs_list)
2498
test_suite_factory = benchmarks.test_suite
2501
# TODO: should possibly lock the history file...
2502
benchfile = open(".perf_history", "at", buffering=1)
2504
test_suite_factory = None
2509
result = selftest(verbose=verbose,
2511
stop_on_failure=one,
2512
keep_output=keep_output,
2513
transport=transport,
2514
test_suite_factory=test_suite_factory,
2515
lsprof_timed=lsprof_timed,
2516
bench_history=benchfile,
2517
matching_tests_first=first,
2518
numbered_dirs=numbered_dirs,
2519
list_only=list_only,
2520
random_seed=randomize,
2521
exclude_pattern=exclude
2524
if benchfile is not None:
2527
info('tests passed')
2529
info('tests failed')
2530
return int(not result)
2533
class cmd_version(Command):
2534
"""Show version of bzr."""
2538
from bzrlib.version import show_version
2542
class cmd_rocks(Command):
2543
"""Statement of optimism."""
2549
print "It sure does!"
2552
class cmd_find_merge_base(Command):
2553
"""Find and print a base revision for merging two branches."""
2554
# TODO: Options to specify revisions on either side, as if
2555
# merging only part of the history.
2556
takes_args = ['branch', 'other']
2560
def run(self, branch, other):
2561
from bzrlib.revision import MultipleRevisionSources
2563
branch1 = Branch.open_containing(branch)[0]
2564
branch2 = Branch.open_containing(other)[0]
2566
last1 = branch1.last_revision()
2567
last2 = branch2.last_revision()
2569
source = MultipleRevisionSources(branch1.repository,
2572
base_rev_id = common_ancestor(last1, last2, source)
2574
print 'merge base is revision %s' % base_rev_id
2577
class cmd_merge(Command):
2578
"""Perform a three-way merge.
2580
The branch is the branch you will merge from. By default, it will merge
2581
the latest revision. If you specify a revision, that revision will be
2582
merged. If you specify two revisions, the first will be used as a BASE,
2583
and the second one as OTHER. Revision numbers are always relative to the
2586
By default, bzr will try to merge in all new work from the other
2587
branch, automatically determining an appropriate base. If this
2588
fails, you may need to give an explicit base.
2590
Merge will do its best to combine the changes in two branches, but there
2591
are some kinds of problems only a human can fix. When it encounters those,
2592
it will mark a conflict. A conflict means that you need to fix something,
2593
before you should commit.
2595
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2597
If there is no default branch set, the first merge will set it. After
2598
that, you can omit the branch to use the default. To change the
2599
default, use --remember. The value will only be saved if the remote
2600
location can be accessed.
2602
The results of the merge are placed into the destination working
2603
directory, where they can be reviewed (with bzr diff), tested, and then
2604
committed to record the result of the merge.
2608
To merge the latest revision from bzr.dev:
2609
bzr merge ../bzr.dev
2611
To merge changes up to and including revision 82 from bzr.dev:
2612
bzr merge -r 82 ../bzr.dev
2614
To merge the changes introduced by 82, without previous changes:
2615
bzr merge -r 81..82 ../bzr.dev
2617
merge refuses to run if there are any uncommitted changes, unless
2621
_see_also = ['update', 'remerge']
2622
takes_args = ['branch?']
2623
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2624
Option('show-base', help="Show base revision text in "
2626
Option('uncommitted', help='Apply uncommitted changes'
2627
' from a working copy, instead of branch changes'),
2628
Option('pull', help='If the destination is already'
2629
' completely merged into the source, pull from the'
2630
' source rather than merging. When this happens,'
2631
' you do not need to commit the result.'),
2633
help='Branch to merge into, '
2634
'rather than the one containing the working directory',
2640
def run(self, branch=None, revision=None, force=False, merge_type=None,
2641
show_base=False, reprocess=False, remember=False,
2642
uncommitted=False, pull=False,
2645
from bzrlib.tag import _merge_tags_if_possible
2646
other_revision_id = None
2647
if merge_type is None:
2648
merge_type = _mod_merge.Merge3Merger
2650
if directory is None: directory = u'.'
2651
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2652
# inventory. Because merge is a mutating operation, it really
2653
# should be a lock_write() for the whole cmd_merge operation.
2654
# However, cmd_merge open's its own tree in _merge_helper, which
2655
# means if we lock here, the later lock_write() will always block.
2656
# Either the merge helper code should be updated to take a tree,
2657
# (What about tree.merge_from_branch?)
2658
tree = WorkingTree.open_containing(directory)[0]
2659
change_reporter = delta._ChangeReporter(
2660
unversioned_filter=tree.is_ignored)
2662
if branch is not None:
2664
mergeable = bundle.read_mergeable_from_url(
2666
except errors.NotABundle:
2667
pass # Continue on considering this url a Branch
2669
if revision is not None:
2670
raise errors.BzrCommandError(
2671
'Cannot use -r with merge directives or bundles')
2672
other_revision_id = mergeable.install_revisions(
2673
tree.branch.repository)
2674
revision = [RevisionSpec.from_string(
2675
'revid:' + other_revision_id)]
2677
if revision is None \
2678
or len(revision) < 1 or revision[0].needs_branch():
2679
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2681
if revision is None or len(revision) < 1:
2684
other = [branch, None]
2687
other = [branch, -1]
2688
other_branch, path = Branch.open_containing(branch)
2691
raise errors.BzrCommandError('Cannot use --uncommitted and'
2692
' --revision at the same time.')
2693
branch = revision[0].get_branch() or branch
2694
if len(revision) == 1:
2696
if other_revision_id is not None:
2701
other_branch, path = Branch.open_containing(branch)
2702
revno = revision[0].in_history(other_branch).revno
2703
other = [branch, revno]
2705
assert len(revision) == 2
2706
if None in revision:
2707
raise errors.BzrCommandError(
2708
"Merge doesn't permit empty revision specifier.")
2709
base_branch, path = Branch.open_containing(branch)
2710
branch1 = revision[1].get_branch() or branch
2711
other_branch, path1 = Branch.open_containing(branch1)
2712
if revision[0].get_branch() is not None:
2713
# then path was obtained from it, and is None.
2716
base = [branch, revision[0].in_history(base_branch).revno]
2717
other = [branch1, revision[1].in_history(other_branch).revno]
2719
if ((tree.branch.get_parent() is None or remember) and
2720
other_branch is not None):
2721
tree.branch.set_parent(other_branch.base)
2723
# pull tags now... it's a bit inconsistent to do it ahead of copying
2724
# the history but that's done inside the merge code
2725
if other_branch is not None:
2726
_merge_tags_if_possible(other_branch, tree.branch)
2729
interesting_files = [path]
2731
interesting_files = None
2732
pb = ui.ui_factory.nested_progress_bar()
2735
conflict_count = _merge_helper(
2736
other, base, other_rev_id=other_revision_id,
2737
check_clean=(not force),
2738
merge_type=merge_type,
2739
reprocess=reprocess,
2740
show_base=show_base,
2743
pb=pb, file_list=interesting_files,
2744
change_reporter=change_reporter)
2747
if conflict_count != 0:
2751
except errors.AmbiguousBase, e:
2752
m = ("sorry, bzr can't determine the right merge base yet\n"
2753
"candidates are:\n "
2754
+ "\n ".join(e.bases)
2756
"please specify an explicit base with -r,\n"
2757
"and (if you want) report this to the bzr developers\n")
2760
# TODO: move up to common parent; this isn't merge-specific anymore.
2761
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2762
"""Use tree.branch's parent if none was supplied.
2764
Report if the remembered location was used.
2766
if supplied_location is not None:
2767
return supplied_location
2768
stored_location = tree.branch.get_parent()
2769
mutter("%s", stored_location)
2770
if stored_location is None:
2771
raise errors.BzrCommandError("No location specified or remembered")
2772
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2773
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2774
return stored_location
2777
class cmd_remerge(Command):
2780
Use this if you want to try a different merge technique while resolving
2781
conflicts. Some merge techniques are better than others, and remerge
2782
lets you try different ones on different files.
2784
The options for remerge have the same meaning and defaults as the ones for
2785
merge. The difference is that remerge can (only) be run when there is a
2786
pending merge, and it lets you specify particular files.
2790
$ bzr remerge --show-base
2791
Re-do the merge of all conflicted files, and show the base text in
2792
conflict regions, in addition to the usual THIS and OTHER texts.
2794
$ bzr remerge --merge-type weave --reprocess foobar
2795
Re-do the merge of "foobar", using the weave merge algorithm, with
2796
additional processing to reduce the size of conflict regions.
2798
takes_args = ['file*']
2799
takes_options = ['merge-type', 'reprocess',
2800
Option('show-base', help="Show base revision text in "
2803
def run(self, file_list=None, merge_type=None, show_base=False,
2805
if merge_type is None:
2806
merge_type = _mod_merge.Merge3Merger
2807
tree, file_list = tree_files(file_list)
2810
parents = tree.get_parent_ids()
2811
if len(parents) != 2:
2812
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2813
" merges. Not cherrypicking or"
2815
repository = tree.branch.repository
2816
base_revision = common_ancestor(parents[0],
2817
parents[1], repository)
2818
base_tree = repository.revision_tree(base_revision)
2819
other_tree = repository.revision_tree(parents[1])
2820
interesting_ids = None
2822
conflicts = tree.conflicts()
2823
if file_list is not None:
2824
interesting_ids = set()
2825
for filename in file_list:
2826
file_id = tree.path2id(filename)
2828
raise errors.NotVersionedError(filename)
2829
interesting_ids.add(file_id)
2830
if tree.kind(file_id) != "directory":
2833
for name, ie in tree.inventory.iter_entries(file_id):
2834
interesting_ids.add(ie.file_id)
2835
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2837
# Remerge only supports resolving contents conflicts
2838
allowed_conflicts = ('text conflict', 'contents conflict')
2839
restore_files = [c.path for c in conflicts
2840
if c.typestring in allowed_conflicts]
2841
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2842
tree.set_conflicts(ConflictList(new_conflicts))
2843
if file_list is not None:
2844
restore_files = file_list
2845
for filename in restore_files:
2847
restore(tree.abspath(filename))
2848
except errors.NotConflicted:
2850
conflicts = _mod_merge.merge_inner(
2851
tree.branch, other_tree, base_tree,
2853
interesting_ids=interesting_ids,
2854
other_rev_id=parents[1],
2855
merge_type=merge_type,
2856
show_base=show_base,
2857
reprocess=reprocess)
2866
class cmd_revert(Command):
2867
"""Revert files to a previous revision.
2869
Giving a list of files will revert only those files. Otherwise, all files
2870
will be reverted. If the revision is not specified with '--revision', the
2871
last committed revision is used.
2873
To remove only some changes, without reverting to a prior version, use
2874
merge instead. For example, "merge . --r-2..-3" will remove the changes
2875
introduced by -2, without affecting the changes introduced by -1. Or
2876
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2878
By default, any files that have been manually changed will be backed up
2879
first. (Files changed only by merge are not backed up.) Backup files have
2880
'.~#~' appended to their name, where # is a number.
2882
When you provide files, you can use their current pathname or the pathname
2883
from the target revision. So you can use revert to "undelete" a file by
2884
name. If you name a directory, all the contents of that directory will be
2888
_see_also = ['cat', 'export']
2889
takes_options = ['revision', 'no-backup']
2890
takes_args = ['file*']
2892
def run(self, revision=None, no_backup=False, file_list=None):
2893
if file_list is not None:
2894
if len(file_list) == 0:
2895
raise errors.BzrCommandError("No files specified")
2899
tree, file_list = tree_files(file_list)
2900
if revision is None:
2901
# FIXME should be tree.last_revision
2902
rev_id = tree.last_revision()
2903
elif len(revision) != 1:
2904
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2906
rev_id = revision[0].in_history(tree.branch).rev_id
2907
pb = ui.ui_factory.nested_progress_bar()
2909
tree.revert(file_list,
2910
tree.branch.repository.revision_tree(rev_id),
2911
not no_backup, pb, report_changes=True)
2916
class cmd_assert_fail(Command):
2917
"""Test reporting of assertion failures"""
2918
# intended just for use in testing
2923
raise AssertionError("always fails")
2926
class cmd_help(Command):
2927
"""Show help on a command or other topic.
2930
_see_also = ['topics']
2931
takes_options = [Option('long', 'show help on all commands')]
2932
takes_args = ['topic?']
2933
aliases = ['?', '--help', '-?', '-h']
2936
def run(self, topic=None, long=False):
2938
if topic is None and long:
2940
bzrlib.help.help(topic)
2943
class cmd_shell_complete(Command):
2944
"""Show appropriate completions for context.
2946
For a list of all available commands, say 'bzr shell-complete'.
2948
takes_args = ['context?']
2953
def run(self, context=None):
2954
import shellcomplete
2955
shellcomplete.shellcomplete(context)
2958
class cmd_fetch(Command):
2959
"""Copy in history from another branch but don't merge it.
2961
This is an internal method used for pull and merge.
2964
takes_args = ['from_branch', 'to_branch']
2965
def run(self, from_branch, to_branch):
2966
from bzrlib.fetch import Fetcher
2967
from_b = Branch.open(from_branch)
2968
to_b = Branch.open(to_branch)
2969
Fetcher(to_b, from_b)
2972
class cmd_missing(Command):
2973
"""Show unmerged/unpulled revisions between two branches.
2975
OTHER_BRANCH may be local or remote.
2978
_see_also = ['merge', 'pull']
2979
takes_args = ['other_branch?']
2980
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2982
'Display changes in the local branch only'),
2983
Option('theirs-only',
2984
'Display changes in the remote branch only'),
2989
encoding_type = 'replace'
2992
def run(self, other_branch=None, reverse=False, mine_only=False,
2993
theirs_only=False, log_format=None, long=False, short=False, line=False,
2994
show_ids=False, verbose=False):
2995
from bzrlib.missing import find_unmerged, iter_log_revisions
2996
from bzrlib.log import log_formatter
2997
local_branch = Branch.open_containing(u".")[0]
2998
parent = local_branch.get_parent()
2999
if other_branch is None:
3000
other_branch = parent
3001
if other_branch is None:
3002
raise errors.BzrCommandError("No peer location known or specified.")
3003
display_url = urlutils.unescape_for_display(parent,
3005
print "Using last location: " + display_url
3007
remote_branch = Branch.open(other_branch)
3008
if remote_branch.base == local_branch.base:
3009
remote_branch = local_branch
3010
local_branch.lock_read()
3012
remote_branch.lock_read()
3014
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
3015
if (log_format is None):
3016
log_format = log.log_formatter_registry.get_default(
3018
lf = log_format(to_file=self.outf,
3020
show_timezone='original')
3021
if reverse is False:
3022
local_extra.reverse()
3023
remote_extra.reverse()
3024
if local_extra and not theirs_only:
3025
print "You have %d extra revision(s):" % len(local_extra)
3026
for revision in iter_log_revisions(local_extra,
3027
local_branch.repository,
3029
lf.log_revision(revision)
3030
printed_local = True
3032
printed_local = False
3033
if remote_extra and not mine_only:
3034
if printed_local is True:
3036
print "You are missing %d revision(s):" % len(remote_extra)
3037
for revision in iter_log_revisions(remote_extra,
3038
remote_branch.repository,
3040
lf.log_revision(revision)
3041
if not remote_extra and not local_extra:
3043
print "Branches are up to date."
3047
remote_branch.unlock()
3049
local_branch.unlock()
3050
if not status_code and parent is None and other_branch is not None:
3051
local_branch.lock_write()
3053
# handle race conditions - a parent might be set while we run.
3054
if local_branch.get_parent() is None:
3055
local_branch.set_parent(remote_branch.base)
3057
local_branch.unlock()
3061
class cmd_plugins(Command):
3066
import bzrlib.plugin
3067
from inspect import getdoc
3068
for name, plugin in bzrlib.plugin.all_plugins().items():
3069
if getattr(plugin, '__path__', None) is not None:
3070
print plugin.__path__[0]
3071
elif getattr(plugin, '__file__', None) is not None:
3072
print plugin.__file__
3078
print '\t', d.split('\n')[0]
3081
class cmd_testament(Command):
3082
"""Show testament (signing-form) of a revision."""
3083
takes_options = ['revision',
3084
Option('long', help='Produce long-format testament'),
3085
Option('strict', help='Produce a strict-format'
3087
takes_args = ['branch?']
3089
def run(self, branch=u'.', revision=None, long=False, strict=False):
3090
from bzrlib.testament import Testament, StrictTestament
3092
testament_class = StrictTestament
3094
testament_class = Testament
3095
b = WorkingTree.open_containing(branch)[0].branch
3098
if revision is None:
3099
rev_id = b.last_revision()
3101
rev_id = revision[0].in_history(b).rev_id
3102
t = testament_class.from_revision(b.repository, rev_id)
3104
sys.stdout.writelines(t.as_text_lines())
3106
sys.stdout.write(t.as_short_text())
3111
class cmd_annotate(Command):
3112
"""Show the origin of each line in a file.
3114
This prints out the given file with an annotation on the left side
3115
indicating which revision, author and date introduced the change.
3117
If the origin is the same for a run of consecutive lines, it is
3118
shown only at the top, unless the --all option is given.
3120
# TODO: annotate directories; showing when each file was last changed
3121
# TODO: if the working copy is modified, show annotations on that
3122
# with new uncommitted lines marked
3123
aliases = ['ann', 'blame', 'praise']
3124
takes_args = ['filename']
3125
takes_options = [Option('all', help='show annotations on all lines'),
3126
Option('long', help='show date in annotations'),
3132
def run(self, filename, all=False, long=False, revision=None,
3134
from bzrlib.annotate import annotate_file
3135
tree, relpath = WorkingTree.open_containing(filename)
3136
branch = tree.branch
3139
if revision is None:
3140
revision_id = branch.last_revision()
3141
elif len(revision) != 1:
3142
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3144
revision_id = revision[0].in_history(branch).rev_id
3145
file_id = tree.path2id(relpath)
3146
tree = branch.repository.revision_tree(revision_id)
3147
file_version = tree.inventory[file_id].revision
3148
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
3154
class cmd_re_sign(Command):
3155
"""Create a digital signature for an existing revision."""
3156
# TODO be able to replace existing ones.
3158
hidden = True # is this right ?
3159
takes_args = ['revision_id*']
3160
takes_options = ['revision']
3162
def run(self, revision_id_list=None, revision=None):
3163
import bzrlib.gpg as gpg
3164
if revision_id_list is not None and revision is not None:
3165
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3166
if revision_id_list is None and revision is None:
3167
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3168
b = WorkingTree.open_containing(u'.')[0].branch
3169
gpg_strategy = gpg.GPGStrategy(b.get_config())
3170
if revision_id_list is not None:
3171
for revision_id in revision_id_list:
3172
b.repository.sign_revision(revision_id, gpg_strategy)
3173
elif revision is not None:
3174
if len(revision) == 1:
3175
revno, rev_id = revision[0].in_history(b)
3176
b.repository.sign_revision(rev_id, gpg_strategy)
3177
elif len(revision) == 2:
3178
# are they both on rh- if so we can walk between them
3179
# might be nice to have a range helper for arbitrary
3180
# revision paths. hmm.
3181
from_revno, from_revid = revision[0].in_history(b)
3182
to_revno, to_revid = revision[1].in_history(b)
3183
if to_revid is None:
3184
to_revno = b.revno()
3185
if from_revno is None or to_revno is None:
3186
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3187
for revno in range(from_revno, to_revno + 1):
3188
b.repository.sign_revision(b.get_rev_id(revno),
3191
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3194
class cmd_bind(Command):
3195
"""Convert the current branch into a checkout of the supplied branch.
3197
Once converted into a checkout, commits must succeed on the master branch
3198
before they will be applied to the local branch.
3201
_see_also = ['checkouts', 'unbind']
3202
takes_args = ['location?']
3205
def run(self, location=None):
3206
b, relpath = Branch.open_containing(u'.')
3207
if location is None:
3209
location = b.get_old_bound_location()
3210
except errors.UpgradeRequired:
3211
raise errors.BzrCommandError('No location supplied. '
3212
'This format does not remember old locations.')
3214
if location is None:
3215
raise errors.BzrCommandError('No location supplied and no '
3216
'previous location known')
3217
b_other = Branch.open(location)
3220
except errors.DivergedBranches:
3221
raise errors.BzrCommandError('These branches have diverged.'
3222
' Try merging, and then bind again.')
3225
class cmd_unbind(Command):
3226
"""Convert the current checkout into a regular branch.
3228
After unbinding, the local branch is considered independent and subsequent
3229
commits will be local only.
3232
_see_also = ['checkouts', 'bind']
3237
b, relpath = Branch.open_containing(u'.')
3239
raise errors.BzrCommandError('Local branch is not bound')
3242
class cmd_uncommit(Command):
3243
"""Remove the last committed revision.
3245
--verbose will print out what is being removed.
3246
--dry-run will go through all the motions, but not actually
3249
In the future, uncommit will create a revision bundle, which can then
3253
# TODO: jam 20060108 Add an option to allow uncommit to remove
3254
# unreferenced information in 'branch-as-repository' branches.
3255
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3256
# information in shared branches as well.
3257
_see_also = ['commit']
3258
takes_options = ['verbose', 'revision',
3259
Option('dry-run', help='Don\'t actually make changes'),
3260
Option('force', help='Say yes to all questions.')]
3261
takes_args = ['location?']
3264
def run(self, location=None,
3265
dry_run=False, verbose=False,
3266
revision=None, force=False):
3267
from bzrlib.log import log_formatter, show_log
3269
from bzrlib.uncommit import uncommit
3271
if location is None:
3273
control, relpath = bzrdir.BzrDir.open_containing(location)
3275
tree = control.open_workingtree()
3277
except (errors.NoWorkingTree, errors.NotLocalUrl):
3279
b = control.open_branch()
3282
if revision is None:
3285
# 'bzr uncommit -r 10' actually means uncommit
3286
# so that the final tree is at revno 10.
3287
# but bzrlib.uncommit.uncommit() actually uncommits
3288
# the revisions that are supplied.
3289
# So we need to offset it by one
3290
revno = revision[0].in_history(b).revno+1
3292
if revno <= b.revno():
3293
rev_id = b.get_rev_id(revno)
3295
self.outf.write('No revisions to uncommit.\n')
3298
lf = log_formatter('short',
3300
show_timezone='original')
3305
direction='forward',
3306
start_revision=revno,
3307
end_revision=b.revno())
3310
print 'Dry-run, pretending to remove the above revisions.'
3312
val = raw_input('Press <enter> to continue')
3314
print 'The above revision(s) will be removed.'
3316
val = raw_input('Are you sure [y/N]? ')
3317
if val.lower() not in ('y', 'yes'):
3321
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3325
class cmd_break_lock(Command):
3326
"""Break a dead lock on a repository, branch or working directory.
3328
CAUTION: Locks should only be broken when you are sure that the process
3329
holding the lock has been stopped.
3331
You can get information on what locks are open via the 'bzr info' command.
3336
takes_args = ['location?']
3338
def run(self, location=None, show=False):
3339
if location is None:
3341
control, relpath = bzrdir.BzrDir.open_containing(location)
3343
control.break_lock()
3344
except NotImplementedError:
3348
class cmd_wait_until_signalled(Command):
3349
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3351
This just prints a line to signal when it is ready, then blocks on stdin.
3357
sys.stdout.write("running\n")
3359
sys.stdin.readline()
3362
class cmd_serve(Command):
3363
"""Run the bzr server."""
3365
aliases = ['server']
3369
help='serve on stdin/out for use from inetd or sshd'),
3371
help='listen for connections on nominated port of the form '
3372
'[hostname:]portnumber. Passing 0 as the port number will '
3373
'result in a dynamically allocated port. Default port is '
3377
help='serve contents of directory',
3379
Option('allow-writes',
3380
help='By default the server is a readonly server. Supplying '
3381
'--allow-writes enables write access to the contents of '
3382
'the served directory and below. '
3386
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3387
from bzrlib.smart import medium, server
3388
from bzrlib.transport import get_transport
3389
from bzrlib.transport.chroot import ChrootServer
3390
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3391
if directory is None:
3392
directory = os.getcwd()
3393
url = urlutils.local_path_to_url(directory)
3394
if not allow_writes:
3395
url = 'readonly+' + url
3396
chroot_server = ChrootServer(get_transport(url))
3397
chroot_server.setUp()
3398
t = get_transport(chroot_server.get_url())
3400
smart_server = medium.SmartServerPipeStreamMedium(
3401
sys.stdin, sys.stdout, t)
3403
host = BZR_DEFAULT_INTERFACE
3405
port = BZR_DEFAULT_PORT
3408
host, port = port.split(':')
3410
smart_server = server.SmartTCPServer(t, host=host, port=port)
3411
print 'listening on port: ', smart_server.port
3413
# for the duration of this server, no UI output is permitted.
3414
# note that this may cause problems with blackbox tests. This should
3415
# be changed with care though, as we dont want to use bandwidth sending
3416
# progress over stderr to smart server clients!
3417
old_factory = ui.ui_factory
3419
ui.ui_factory = ui.SilentUIFactory()
3420
smart_server.serve()
3422
ui.ui_factory = old_factory
3425
class cmd_join(Command):
3426
"""Combine a subtree into its containing tree.
3428
This command is for experimental use only. It requires the target tree
3429
to be in dirstate-with-subtree format, which cannot be converted into
3432
The TREE argument should be an independent tree, inside another tree, but
3433
not part of it. (Such trees can be produced by "bzr split", but also by
3434
running "bzr branch" with the target inside a tree.)
3436
The result is a combined tree, with the subtree no longer an independant
3437
part. This is marked as a merge of the subtree into the containing tree,
3438
and all history is preserved.
3440
If --reference is specified, the subtree retains its independence. It can
3441
be branched by itself, and can be part of multiple projects at the same
3442
time. But operations performed in the containing tree, such as commit
3443
and merge, will recurse into the subtree.
3446
_see_also = ['split']
3447
takes_args = ['tree']
3448
takes_options = [Option('reference', 'join by reference')]
3451
def run(self, tree, reference=False):
3452
sub_tree = WorkingTree.open(tree)
3453
parent_dir = osutils.dirname(sub_tree.basedir)
3454
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3455
repo = containing_tree.branch.repository
3456
if not repo.supports_rich_root():
3457
raise errors.BzrCommandError(
3458
"Can't join trees because %s doesn't support rich root data.\n"
3459
"You can use bzr upgrade on the repository."
3463
containing_tree.add_reference(sub_tree)
3464
except errors.BadReferenceTarget, e:
3465
# XXX: Would be better to just raise a nicely printable
3466
# exception from the real origin. Also below. mbp 20070306
3467
raise errors.BzrCommandError("Cannot join %s. %s" %
3471
containing_tree.subsume(sub_tree)
3472
except errors.BadSubsumeSource, e:
3473
raise errors.BzrCommandError("Cannot join %s. %s" %
3477
class cmd_split(Command):
3478
"""Split a tree into two trees.
3480
This command is for experimental use only. It requires the target tree
3481
to be in dirstate-with-subtree format, which cannot be converted into
3484
The TREE argument should be a subdirectory of a working tree. That
3485
subdirectory will be converted into an independent tree, with its own
3486
branch. Commits in the top-level tree will not apply to the new subtree.
3487
If you want that behavior, do "bzr join --reference TREE".
3490
_see_also = ['join']
3491
takes_args = ['tree']
3495
def run(self, tree):
3496
containing_tree, subdir = WorkingTree.open_containing(tree)
3497
sub_id = containing_tree.path2id(subdir)
3499
raise errors.NotVersionedError(subdir)
3501
containing_tree.extract(sub_id)
3502
except errors.RootNotRich:
3503
raise errors.UpgradeRequired(containing_tree.branch.base)
3507
class cmd_merge_directive(Command):
3508
"""Generate a merge directive for auto-merge tools.
3510
A directive requests a merge to be performed, and also provides all the
3511
information necessary to do so. This means it must either include a
3512
revision bundle, or the location of a branch containing the desired
3515
A submit branch (the location to merge into) must be supplied the first
3516
time the command is issued. After it has been supplied once, it will
3517
be remembered as the default.
3519
A public branch is optional if a revision bundle is supplied, but required
3520
if --diff or --plain is specified. It will be remembered as the default
3521
after the first use.
3524
takes_args = ['submit_branch?', 'public_branch?']
3527
RegistryOption.from_kwargs('patch-type',
3528
'The type of patch to include in the directive',
3529
title='Patch type', value_switches=True, enum_switch=False,
3530
bundle='Bazaar revision bundle (default)',
3531
diff='Normal unified diff',
3532
plain='No patch, just directive'),
3533
Option('sign', help='GPG-sign the directive'), 'revision',
3534
Option('mail-to', type=str,
3535
help='Instead of printing the directive, email to this address'),
3536
Option('message', type=str, short_name='m',
3537
help='Message to use when committing this merge')
3540
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3541
sign=False, revision=None, mail_to=None, message=None):
3542
if patch_type == 'plain':
3544
branch = Branch.open('.')
3545
stored_submit_branch = branch.get_submit_branch()
3546
if submit_branch is None:
3547
submit_branch = stored_submit_branch
3549
if stored_submit_branch is None:
3550
branch.set_submit_branch(submit_branch)
3551
if submit_branch is None:
3552
submit_branch = branch.get_parent()
3553
if submit_branch is None:
3554
raise errors.BzrCommandError('No submit branch specified or known')
3556
stored_public_branch = branch.get_public_branch()
3557
if public_branch is None:
3558
public_branch = stored_public_branch
3559
elif stored_public_branch is None:
3560
branch.set_public_branch(public_branch)
3561
if patch_type != "bundle" and public_branch is None:
3562
raise errors.BzrCommandError('No public branch specified or'
3564
if revision is not None:
3565
if len(revision) != 1:
3566
raise errors.BzrCommandError('bzr merge-directive takes '
3567
'exactly one revision identifier')
3569
revision_id = revision[0].in_history(branch).rev_id
3571
revision_id = branch.last_revision()
3572
directive = merge_directive.MergeDirective.from_objects(
3573
branch.repository, revision_id, time.time(),
3574
osutils.local_time_offset(), submit_branch,
3575
public_branch=public_branch, patch_type=patch_type,
3579
self.outf.write(directive.to_signed(branch))
3581
self.outf.writelines(directive.to_lines())
3583
message = directive.to_email(mail_to, branch, sign)
3585
server = branch.get_config().get_user_option('smtp_server')
3587
server = 'localhost'
3589
s.sendmail(message['From'], message['To'], message.as_string())
3592
class cmd_tag(Command):
3593
"""Create a tag naming a revision.
3595
Tags give human-meaningful names to revisions. Commands that take a -r
3596
(--revision) option can be given -rtag:X, where X is any previously
3599
Tags are stored in the branch. Tags are copied from one branch to another
3600
along when you branch, push, pull or merge.
3602
It is an error to give a tag name that already exists unless you pass
3603
--force, in which case the tag is moved to point to the new revision.
3606
_see_also = ['commit', 'tags']
3607
takes_args = ['tag_name']
3610
help='Delete this tag rather than placing it.',
3613
help='Branch in which to place the tag.',
3618
help='Replace existing tags',
3623
def run(self, tag_name,
3629
branch, relpath = Branch.open_containing(directory)
3633
branch.tags.delete_tag(tag_name)
3634
self.outf.write('Deleted tag %s.\n' % tag_name)
3637
if len(revision) != 1:
3638
raise errors.BzrCommandError(
3639
"Tags can only be placed on a single revision, "
3641
revision_id = revision[0].in_history(branch).rev_id
3643
revision_id = branch.last_revision()
3644
if (not force) and branch.tags.has_tag(tag_name):
3645
raise errors.TagAlreadyExists(tag_name)
3646
branch.tags.set_tag(tag_name, revision_id)
3647
self.outf.write('Created tag %s.\n' % tag_name)
3652
class cmd_tags(Command):
3655
This tag shows a table of tag names and the revisions they reference.
3661
help='Branch whose tags should be displayed',
3671
branch, relpath = Branch.open_containing(directory)
3672
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3673
self.outf.write('%-20s %s\n' % (tag_name, target))
3676
# command-line interpretation helper for merge-related commands
3677
def _merge_helper(other_revision, base_revision,
3678
check_clean=True, ignore_zero=False,
3679
this_dir=None, backup_files=False,
3681
file_list=None, show_base=False, reprocess=False,
3684
change_reporter=None,
3686
"""Merge changes into a tree.
3689
list(path, revno) Base for three-way merge.
3690
If [None, None] then a base will be automatically determined.
3692
list(path, revno) Other revision for three-way merge.
3694
Directory to merge changes into; '.' by default.
3696
If true, this_dir must have no uncommitted changes before the
3698
ignore_zero - If true, suppress the "zero conflicts" message when
3699
there are no conflicts; should be set when doing something we expect
3700
to complete perfectly.
3701
file_list - If supplied, merge only changes to selected files.
3703
All available ancestors of other_revision and base_revision are
3704
automatically pulled into the branch.
3706
The revno may be -1 to indicate the last revision on the branch, which is
3709
This function is intended for use from the command line; programmatic
3710
clients might prefer to call merge.merge_inner(), which has less magic
3713
# Loading it late, so that we don't always have to import bzrlib.merge
3714
if merge_type is None:
3715
merge_type = _mod_merge.Merge3Merger
3716
if this_dir is None:
3718
this_tree = WorkingTree.open_containing(this_dir)[0]
3719
if show_base and not merge_type is _mod_merge.Merge3Merger:
3720
raise errors.BzrCommandError("Show-base is not supported for this merge"
3721
" type. %s" % merge_type)
3722
if reprocess and not merge_type.supports_reprocess:
3723
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3724
" type %s." % merge_type)
3725
if reprocess and show_base:
3726
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3727
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3728
# only want to take out a lock_tree_write() if we don't have to pull
3729
# any ancestry. But merge might fetch ancestry in the middle, in
3730
# which case we would need a lock_write().
3731
# Because we cannot upgrade locks, for now we live with the fact that
3732
# the tree will be locked multiple times during a merge. (Maybe
3733
# read-only some of the time, but it means things will get read
3736
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3737
pb=pb, change_reporter=change_reporter)
3738
merger.pp = ProgressPhase("Merge phase", 5, pb)
3739
merger.pp.next_phase()
3740
merger.check_basis(check_clean)
3741
if other_rev_id is not None:
3742
merger.set_other_revision(other_rev_id, this_tree.branch)
3744
merger.set_other(other_revision)
3745
merger.pp.next_phase()
3746
merger.set_base(base_revision)
3747
if merger.base_rev_id == merger.other_rev_id:
3748
note('Nothing to do.')
3750
if file_list is None:
3751
if pull and merger.base_rev_id == merger.this_rev_id:
3752
# FIXME: deduplicate with pull
3753
result = merger.this_tree.pull(merger.this_branch,
3754
False, merger.other_rev_id)
3755
if result.old_revid == result.new_revid:
3756
note('No revisions to pull.')
3758
note('Now on revision %d.' % result.new_revno)
3760
merger.backup_files = backup_files
3761
merger.merge_type = merge_type
3762
merger.set_interesting_files(file_list)
3763
merger.show_base = show_base
3764
merger.reprocess = reprocess
3765
conflicts = merger.do_merge()
3766
if file_list is None:
3767
merger.set_pending()
3774
merge = _merge_helper
3777
# these get imported and then picked up by the scan for cmd_*
3778
# TODO: Some more consistent way to split command definitions across files;
3779
# we do need to load at least some information about them to know of
3780
# aliases. ideally we would avoid loading the implementation until the
3781
# details were needed.
3782
from bzrlib.cmd_version_info import cmd_version_info
3783
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3784
from bzrlib.bundle.commands import cmd_bundle_revisions
3785
from bzrlib.sign_my_commits import cmd_sign_my_commits
3786
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3787
cmd_weave_plan_merge, cmd_weave_merge_text