1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
20
from StringIO import StringIO
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
55
from bzrlib.branch import Branch
56
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
57
from bzrlib.conflicts import ConflictList
58
from bzrlib.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
b = Branch.open_containing(u'.')[0]
311
revs.append(RevisionSpec.from_string('-1'))
314
revinfo = rev.in_history(b)
315
if revinfo.revno is None:
316
dotted_map = b.get_revision_id_to_revno_map()
317
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
318
print '%s %s' % (revno, revinfo.rev_id)
320
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
323
class cmd_add(Command):
324
"""Add specified files or directories.
326
In non-recursive mode, all the named items are added, regardless
327
of whether they were previously ignored. A warning is given if
328
any of the named files are already versioned.
330
In recursive mode (the default), files are treated the same way
331
but the behaviour for directories is different. Directories that
332
are already versioned do not give a warning. All directories,
333
whether already versioned or not, are searched for files or
334
subdirectories that are neither versioned or ignored, and these
335
are added. This search proceeds recursively into versioned
336
directories. If no names are given '.' is assumed.
338
Therefore simply saying 'bzr add' will version all files that
339
are currently unknown.
341
Adding a file whose parent directory is not versioned will
342
implicitly add the parent, and so on up to the root. This means
343
you should never need to explicitly add a directory, they'll just
344
get added when you add a file in the directory.
346
--dry-run will show which files would be added, but not actually
349
--file-ids-from will try to use the file ids from the supplied path.
350
It looks up ids trying to find a matching parent directory with the
351
same filename, and then by pure path. This option is rarely needed
352
but can be useful when adding the same logical file into two
353
branches that will be merged later (without showing the two different
354
adds as a conflict). It is also useful when merging another project
355
into a subdirectory of this one.
357
takes_args = ['file*']
358
takes_options = ['no-recurse', 'dry-run', 'verbose',
359
Option('file-ids-from', type=unicode,
360
help='Lookup file ids from here')]
361
encoding_type = 'replace'
362
_see_also = ['remove']
364
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
369
if file_ids_from is not None:
371
base_tree, base_path = WorkingTree.open_containing(
373
except errors.NoWorkingTree:
374
base_branch, base_path = Branch.open_containing(
376
base_tree = base_branch.basis_tree()
378
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
379
to_file=self.outf, should_print=(not is_quiet()))
381
action = bzrlib.add.AddAction(to_file=self.outf,
382
should_print=(not is_quiet()))
385
base_tree.lock_read()
387
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
388
action=action, save=not dry_run)
390
if base_tree is not None:
394
for glob in sorted(ignored.keys()):
395
for path in ignored[glob]:
396
self.outf.write("ignored %s matching \"%s\"\n"
400
for glob, paths in ignored.items():
401
match_len += len(paths)
402
self.outf.write("ignored %d file(s).\n" % match_len)
403
self.outf.write("If you wish to add some of these files,"
404
" please add them by name.\n")
407
class cmd_mkdir(Command):
408
"""Create a new versioned directory.
410
This is equivalent to creating the directory and then adding it.
413
takes_args = ['dir+']
414
encoding_type = 'replace'
416
def run(self, dir_list):
419
wt, dd = WorkingTree.open_containing(d)
421
self.outf.write('added %s\n' % d)
424
class cmd_relpath(Command):
425
"""Show path of a file relative to root"""
427
takes_args = ['filename']
431
def run(self, filename):
432
# TODO: jam 20050106 Can relpath return a munged path if
433
# sys.stdout encoding cannot represent it?
434
tree, relpath = WorkingTree.open_containing(filename)
435
self.outf.write(relpath)
436
self.outf.write('\n')
439
class cmd_inventory(Command):
440
"""Show inventory of the current working copy or a revision.
442
It is possible to limit the output to a particular entry
443
type using the --kind option. For example: --kind file.
445
It is also possible to restrict the list of files to a specific
446
set. For example: bzr inventory --show-ids this/file
451
takes_options = ['revision', 'show-ids', 'kind']
452
takes_args = ['file*']
455
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
456
if kind and kind not in ['file', 'directory', 'symlink']:
457
raise errors.BzrCommandError('invalid kind specified')
459
work_tree, file_list = tree_files(file_list)
460
work_tree.lock_read()
462
if revision is not None:
463
if len(revision) > 1:
464
raise errors.BzrCommandError(
465
'bzr inventory --revision takes exactly one revision'
467
revision_id = revision[0].in_history(work_tree.branch).rev_id
468
tree = work_tree.branch.repository.revision_tree(revision_id)
470
extra_trees = [work_tree]
476
if file_list is not None:
477
file_ids = tree.paths2ids(file_list, trees=extra_trees,
478
require_versioned=True)
479
# find_ids_across_trees may include some paths that don't
481
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
482
for file_id in file_ids if file_id in tree)
484
entries = tree.inventory.entries()
487
if tree is not work_tree:
490
for path, entry in entries:
491
if kind and kind != entry.kind:
494
self.outf.write('%-50s %s\n' % (path, entry.file_id))
496
self.outf.write(path)
497
self.outf.write('\n')
500
class cmd_mv(Command):
501
"""Move or rename a file.
504
bzr mv OLDNAME NEWNAME
505
bzr mv SOURCE... DESTINATION
507
If the last argument is a versioned directory, all the other names
508
are moved into it. Otherwise, there must be exactly two arguments
509
and the file is changed to a new name.
511
If OLDNAME does not exist on the filesystem but is versioned and
512
NEWNAME does exist on the filesystem but is not versioned, mv
513
assumes that the file has been manually moved and only updates
514
its internal inventory to reflect that change.
515
The same is valid when moving many SOURCE files to a DESTINATION.
517
Files cannot be moved between branches.
520
takes_args = ['names*']
521
takes_options = [Option("after", help="move only the bzr identifier"
522
" of the file (file has already been moved). Use this flag if"
523
" bzr is not able to detect this itself.")]
524
aliases = ['move', 'rename']
525
encoding_type = 'replace'
527
def run(self, names_list, after=False):
528
if names_list is None:
531
if len(names_list) < 2:
532
raise errors.BzrCommandError("missing file argument")
533
tree, rel_names = tree_files(names_list)
535
if os.path.isdir(names_list[-1]):
536
# move into existing directory
537
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
538
self.outf.write("%s => %s\n" % pair)
540
if len(names_list) != 2:
541
raise errors.BzrCommandError('to mv multiple files the'
542
' destination must be a versioned'
544
tree.rename_one(rel_names[0], rel_names[1], after=after)
545
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
548
class cmd_pull(Command):
549
"""Turn this branch into a mirror of another branch.
551
This command only works on branches that have not diverged. Branches are
552
considered diverged if the destination branch's most recent commit is one
553
that has not been merged (directly or indirectly) into the parent.
555
If branches have diverged, you can use 'bzr merge' to integrate the changes
556
from one into the other. Once one branch has merged, the other should
557
be able to pull it again.
559
If you want to forget your local changes and just update your branch to
560
match the remote one, use pull --overwrite.
562
If there is no default location set, the first pull will set it. After
563
that, you can omit the location to use the default. To change the
564
default, use --remember. The value will only be saved if the remote
565
location can be accessed.
568
_see_also = ['push', 'update']
569
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
571
help='branch to pull into, '
572
'rather than the one containing the working directory',
577
takes_args = ['location?']
578
encoding_type = 'replace'
580
def run(self, location=None, remember=False, overwrite=False,
581
revision=None, verbose=False,
583
from bzrlib.tag import _merge_tags_if_possible
584
# FIXME: too much stuff is in the command class
587
if directory is None:
590
tree_to = WorkingTree.open_containing(directory)[0]
591
branch_to = tree_to.branch
592
except errors.NoWorkingTree:
594
branch_to = Branch.open_containing(directory)[0]
597
if location is not None:
599
mergeable = bundle.read_mergeable_from_url(
601
except errors.NotABundle:
602
pass # Continue on considering this url a Branch
604
stored_loc = branch_to.get_parent()
606
if stored_loc is None:
607
raise errors.BzrCommandError("No pull location known or"
610
display_url = urlutils.unescape_for_display(stored_loc,
612
self.outf.write("Using saved location: %s\n" % display_url)
613
location = stored_loc
615
if mergeable is not None:
616
if revision is not None:
617
raise errors.BzrCommandError(
618
'Cannot use -r with merge directives or bundles')
619
revision_id = mergeable.install_revisions(branch_to.repository)
620
branch_from = branch_to
622
branch_from = Branch.open(location)
624
if branch_to.get_parent() is None or remember:
625
branch_to.set_parent(branch_from.base)
627
if revision is not None:
628
if len(revision) == 1:
629
revision_id = revision[0].in_history(branch_from).rev_id
631
raise errors.BzrCommandError(
632
'bzr pull --revision takes one value.')
634
old_rh = branch_to.revision_history()
635
if tree_to is not None:
636
result = tree_to.pull(branch_from, overwrite, revision_id,
637
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
639
result = branch_to.pull(branch_from, overwrite, revision_id)
641
result.report(self.outf)
643
from bzrlib.log import show_changed_revisions
644
new_rh = branch_to.revision_history()
645
show_changed_revisions(branch_to, old_rh, new_rh,
649
class cmd_push(Command):
650
"""Update a mirror of this branch.
652
The target branch will not have its working tree populated because this
653
is both expensive, and is not supported on remote file systems.
655
Some smart servers or protocols *may* put the working tree in place in
658
This command only works on branches that have not diverged. Branches are
659
considered diverged if the destination branch's most recent commit is one
660
that has not been merged (directly or indirectly) by the source branch.
662
If branches have diverged, you can use 'bzr push --overwrite' to replace
663
the other branch completely, discarding its unmerged changes.
665
If you want to ensure you have the different changes in the other branch,
666
do a merge (see bzr help merge) from the other branch, and commit that.
667
After that you will be able to do a push without '--overwrite'.
669
If there is no default push location set, the first push will set it.
670
After that, you can omit the location to use the default. To change the
671
default, use --remember. The value will only be saved if the remote
672
location can be accessed.
675
_see_also = ['pull', 'update', 'working-trees']
676
takes_options = ['remember', 'overwrite', 'verbose',
677
Option('create-prefix',
678
help='Create the path leading up to the branch '
679
'if it does not already exist'),
681
help='branch to push from, '
682
'rather than the one containing the working directory',
686
Option('use-existing-dir',
687
help='By default push will fail if the target'
688
' directory exists, but does not already'
689
' have a control directory. This flag will'
690
' allow push to proceed.'),
692
takes_args = ['location?']
693
encoding_type = 'replace'
695
def run(self, location=None, remember=False, overwrite=False,
696
create_prefix=False, verbose=False,
697
use_existing_dir=False,
699
# FIXME: Way too big! Put this into a function called from the
701
if directory is None:
703
br_from = Branch.open_containing(directory)[0]
704
stored_loc = br_from.get_push_location()
706
if stored_loc is None:
707
raise errors.BzrCommandError("No push location known or specified.")
709
display_url = urlutils.unescape_for_display(stored_loc,
711
self.outf.write("Using saved location: %s\n" % display_url)
712
location = stored_loc
714
to_transport = transport.get_transport(location)
716
br_to = repository_to = dir_to = None
718
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
719
except errors.NotBranchError:
720
pass # Didn't find anything
722
# If we can open a branch, use its direct repository, otherwise see
723
# if there is a repository without a branch.
725
br_to = dir_to.open_branch()
726
except errors.NotBranchError:
727
# Didn't find a branch, can we find a repository?
729
repository_to = dir_to.find_repository()
730
except errors.NoRepositoryPresent:
733
# Found a branch, so we must have found a repository
734
repository_to = br_to.repository
738
# The destination doesn't exist; create it.
739
# XXX: Refactor the create_prefix/no_create_prefix code into a
740
# common helper function
742
to_transport.mkdir('.')
743
except errors.FileExists:
744
if not use_existing_dir:
745
raise errors.BzrCommandError("Target directory %s"
746
" already exists, but does not have a valid .bzr"
747
" directory. Supply --use-existing-dir to push"
748
" there anyway." % location)
749
except errors.NoSuchFile:
750
if not create_prefix:
751
raise errors.BzrCommandError("Parent directory of %s"
753
"\nYou may supply --create-prefix to create all"
754
" leading parent directories."
757
cur_transport = to_transport
758
needed = [cur_transport]
759
# Recurse upwards until we can create a directory successfully
761
new_transport = cur_transport.clone('..')
762
if new_transport.base == cur_transport.base:
763
raise errors.BzrCommandError("Failed to create path"
767
new_transport.mkdir('.')
768
except errors.NoSuchFile:
769
needed.append(new_transport)
770
cur_transport = new_transport
774
# Now we only need to create child directories
776
cur_transport = needed.pop()
777
cur_transport.ensure_base()
779
# Now the target directory exists, but doesn't have a .bzr
780
# directory. So we need to create it, along with any work to create
781
# all of the dependent branches, etc.
782
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
783
revision_id=br_from.last_revision())
784
br_to = dir_to.open_branch()
785
# TODO: Some more useful message about what was copied
786
note('Created new branch.')
787
# We successfully created the target, remember it
788
if br_from.get_push_location() is None or remember:
789
br_from.set_push_location(br_to.base)
790
elif repository_to is None:
791
# we have a bzrdir but no branch or repository
792
# XXX: Figure out what to do other than complain.
793
raise errors.BzrCommandError("At %s you have a valid .bzr control"
794
" directory, but not a branch or repository. This is an"
795
" unsupported configuration. Please move the target directory"
796
" out of the way and try again."
799
# We have a repository but no branch, copy the revisions, and then
801
last_revision_id = br_from.last_revision()
802
repository_to.fetch(br_from.repository,
803
revision_id=last_revision_id)
804
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
805
note('Created new branch.')
806
if br_from.get_push_location() is None or remember:
807
br_from.set_push_location(br_to.base)
808
else: # We have a valid to branch
809
# We were able to connect to the remote location, so remember it
810
# we don't need to successfully push because of possible divergence.
811
if br_from.get_push_location() is None or remember:
812
br_from.set_push_location(br_to.base)
813
old_rh = br_to.revision_history()
816
tree_to = dir_to.open_workingtree()
817
except errors.NotLocalUrl:
818
warning("This transport does not update the working "
819
"tree of: %s. See 'bzr help working-trees' for "
820
"more information." % br_to.base)
821
push_result = br_from.push(br_to, overwrite)
822
except errors.NoWorkingTree:
823
push_result = br_from.push(br_to, overwrite)
827
push_result = br_from.push(tree_to.branch, overwrite)
831
except errors.DivergedBranches:
832
raise errors.BzrCommandError('These branches have diverged.'
833
' Try using "merge" and then "push".')
834
if push_result is not None:
835
push_result.report(self.outf)
837
new_rh = br_to.revision_history()
840
from bzrlib.log import show_changed_revisions
841
show_changed_revisions(br_to, old_rh, new_rh,
844
# we probably did a clone rather than a push, so a message was
849
class cmd_branch(Command):
850
"""Create a new copy of a branch.
852
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
853
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
855
To retrieve the branch as of a particular revision, supply the --revision
856
parameter, as in "branch foo/bar -r 5".
859
_see_also = ['checkout']
860
takes_args = ['from_location', 'to_location?']
861
takes_options = ['revision']
862
aliases = ['get', 'clone']
864
def run(self, from_location, to_location=None, revision=None):
865
from bzrlib.tag import _merge_tags_if_possible
868
elif len(revision) > 1:
869
raise errors.BzrCommandError(
870
'bzr branch --revision takes exactly 1 revision value')
872
br_from = Branch.open(from_location)
875
if len(revision) == 1 and revision[0] is not None:
876
revision_id = revision[0].in_history(br_from)[1]
878
# FIXME - wt.last_revision, fallback to branch, fall back to
879
# None or perhaps NULL_REVISION to mean copy nothing
881
revision_id = br_from.last_revision()
882
if to_location is None:
883
to_location = os.path.basename(from_location.rstrip("/\\"))
886
name = os.path.basename(to_location) + '\n'
888
to_transport = transport.get_transport(to_location)
890
to_transport.mkdir('.')
891
except errors.FileExists:
892
raise errors.BzrCommandError('Target directory "%s" already'
893
' exists.' % to_location)
894
except errors.NoSuchFile:
895
raise errors.BzrCommandError('Parent of "%s" does not exist.'
898
# preserve whatever source format we have.
899
dir = br_from.bzrdir.sprout(to_transport.base, revision_id)
900
branch = dir.open_branch()
901
except errors.NoSuchRevision:
902
to_transport.delete_tree('.')
903
msg = "The branch %s has no revision %s." % (from_location, revision[0])
904
raise errors.BzrCommandError(msg)
906
branch.control_files.put_utf8('branch-name', name)
907
_merge_tags_if_possible(br_from, branch)
908
note('Branched %d revision(s).' % branch.revno())
913
class cmd_checkout(Command):
914
"""Create a new checkout of an existing branch.
916
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
917
the branch found in '.'. This is useful if you have removed the working tree
918
or if it was never created - i.e. if you pushed the branch to its current
921
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
922
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
924
To retrieve the branch as of a particular revision, supply the --revision
925
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
926
out of date [so you cannot commit] but it may be useful (i.e. to examine old
930
_see_also = ['checkouts', 'branch']
931
takes_args = ['branch_location?', 'to_location?']
932
takes_options = ['revision',
933
Option('lightweight',
934
help="perform a lightweight checkout. Lightweight "
935
"checkouts depend on access to the branch for "
936
"every operation. Normal checkouts can perform "
937
"common operations like diff and status without "
938
"such access, and also support local commits."
943
def run(self, branch_location=None, to_location=None, revision=None,
947
elif len(revision) > 1:
948
raise errors.BzrCommandError(
949
'bzr checkout --revision takes exactly 1 revision value')
950
if branch_location is None:
951
branch_location = osutils.getcwd()
952
to_location = branch_location
953
source = Branch.open(branch_location)
954
if len(revision) == 1 and revision[0] is not None:
955
revision_id = revision[0].in_history(source)[1]
958
if to_location is None:
959
to_location = os.path.basename(branch_location.rstrip("/\\"))
960
# if the source and to_location are the same,
961
# and there is no working tree,
962
# then reconstitute a branch
963
if (osutils.abspath(to_location) ==
964
osutils.abspath(branch_location)):
966
source.bzrdir.open_workingtree()
967
except errors.NoWorkingTree:
968
source.bzrdir.create_workingtree()
971
os.mkdir(to_location)
973
if e.errno == errno.EEXIST:
974
raise errors.BzrCommandError('Target directory "%s" already'
975
' exists.' % to_location)
976
if e.errno == errno.ENOENT:
977
raise errors.BzrCommandError('Parent of "%s" does not exist.'
981
source.create_checkout(to_location, revision_id, lightweight)
984
class cmd_renames(Command):
985
"""Show list of renamed files.
987
# TODO: Option to show renames between two historical versions.
989
# TODO: Only show renames under dir, rather than in the whole branch.
990
_see_also = ['status']
991
takes_args = ['dir?']
994
def run(self, dir=u'.'):
995
tree = WorkingTree.open_containing(dir)[0]
998
new_inv = tree.inventory
999
old_tree = tree.basis_tree()
1000
old_tree.lock_read()
1002
old_inv = old_tree.inventory
1003
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1005
for old_name, new_name in renames:
1006
self.outf.write("%s => %s\n" % (old_name, new_name))
1013
class cmd_update(Command):
1014
"""Update a tree to have the latest code committed to its branch.
1016
This will perform a merge into the working tree, and may generate
1017
conflicts. If you have any local changes, you will still
1018
need to commit them after the update for the update to be complete.
1020
If you want to discard your local changes, you can just do a
1021
'bzr revert' instead of 'bzr commit' after the update.
1024
_see_also = ['pull', 'working-trees']
1025
takes_args = ['dir?']
1028
def run(self, dir='.'):
1029
tree = WorkingTree.open_containing(dir)[0]
1030
master = tree.branch.get_master_branch()
1031
if master is not None:
1034
tree.lock_tree_write()
1036
existing_pending_merges = tree.get_parent_ids()[1:]
1037
last_rev = tree.last_revision()
1038
if last_rev == tree.branch.last_revision():
1039
# may be up to date, check master too.
1040
master = tree.branch.get_master_branch()
1041
if master is None or last_rev == master.last_revision():
1042
revno = tree.branch.revision_id_to_revno(last_rev)
1043
note("Tree is up to date at revision %d." % (revno,))
1045
conflicts = tree.update()
1046
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1047
note('Updated to revision %d.' % (revno,))
1048
if tree.get_parent_ids()[1:] != existing_pending_merges:
1049
note('Your local commits will now show as pending merges with '
1050
"'bzr status', and can be committed with 'bzr commit'.")
1059
class cmd_info(Command):
1060
"""Show information about a working tree, branch or repository.
1062
This command will show all known locations and formats associated to the
1063
tree, branch or repository. Statistical information is included with
1066
Branches and working trees will also report any missing revisions.
1068
_see_also = ['revno', 'working-trees', 'repositories']
1069
takes_args = ['location?']
1070
takes_options = ['verbose']
1073
def run(self, location=None, verbose=False):
1074
from bzrlib.info import show_bzrdir_info
1075
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1079
class cmd_remove(Command):
1080
"""Remove files or directories.
1082
This makes bzr stop tracking changes to the specified files and
1083
delete them if they can easily be recovered using revert.
1085
You can specify one or more files, and/or --new. If you specify --new,
1086
only 'added' files will be removed. If you specify both, then new files
1087
in the specified directories will be removed. If the directories are
1088
also new, they will also be removed.
1090
takes_args = ['file*']
1091
takes_options = ['verbose',
1092
Option('new', help='remove newly-added files'),
1093
RegistryOption.from_kwargs('file-deletion-strategy',
1094
'The file deletion mode to be used',
1095
title='Deletion Strategy', value_switches=True, enum_switch=False,
1096
safe='Only delete files if they can be'
1097
' safely recovered (default).',
1098
keep="Don't delete any files.",
1099
force='Delete all the specified files, even if they can not be '
1100
'recovered and even if they are non-empty directories.')]
1102
encoding_type = 'replace'
1104
def run(self, file_list, verbose=False, new=False,
1105
file_deletion_strategy='safe'):
1106
tree, file_list = tree_files(file_list)
1108
if file_list is not None:
1109
file_list = [f for f in file_list if f != '']
1111
raise errors.BzrCommandError('Specify one or more files to'
1112
' remove, or use --new.')
1115
added = tree.changes_from(tree.basis_tree(),
1116
specific_files=file_list).added
1117
file_list = sorted([f[0] for f in added], reverse=True)
1118
if len(file_list) == 0:
1119
raise errors.BzrCommandError('No matching files.')
1120
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1121
keep_files=file_deletion_strategy=='keep',
1122
force=file_deletion_strategy=='force')
1125
class cmd_file_id(Command):
1126
"""Print file_id of a particular file or directory.
1128
The file_id is assigned when the file is first added and remains the
1129
same through all revisions where the file exists, even when it is
1134
_see_also = ['inventory', 'ls']
1135
takes_args = ['filename']
1138
def run(self, filename):
1139
tree, relpath = WorkingTree.open_containing(filename)
1140
i = tree.path2id(relpath)
1142
raise errors.NotVersionedError(filename)
1144
self.outf.write(i + '\n')
1147
class cmd_file_path(Command):
1148
"""Print path of file_ids to a file or directory.
1150
This prints one line for each directory down to the target,
1151
starting at the branch root.
1155
takes_args = ['filename']
1158
def run(self, filename):
1159
tree, relpath = WorkingTree.open_containing(filename)
1160
fid = tree.path2id(relpath)
1162
raise errors.NotVersionedError(filename)
1163
segments = osutils.splitpath(relpath)
1164
for pos in range(1, len(segments) + 1):
1165
path = osutils.joinpath(segments[:pos])
1166
self.outf.write("%s\n" % tree.path2id(path))
1169
class cmd_reconcile(Command):
1170
"""Reconcile bzr metadata in a branch.
1172
This can correct data mismatches that may have been caused by
1173
previous ghost operations or bzr upgrades. You should only
1174
need to run this command if 'bzr check' or a bzr developer
1175
advises you to run it.
1177
If a second branch is provided, cross-branch reconciliation is
1178
also attempted, which will check that data like the tree root
1179
id which was not present in very early bzr versions is represented
1180
correctly in both branches.
1182
At the same time it is run it may recompress data resulting in
1183
a potential saving in disk space or performance gain.
1185
The branch *MUST* be on a listable system such as local disk or sftp.
1188
_see_also = ['check']
1189
takes_args = ['branch?']
1191
def run(self, branch="."):
1192
from bzrlib.reconcile import reconcile
1193
dir = bzrdir.BzrDir.open(branch)
1197
class cmd_revision_history(Command):
1198
"""Display the list of revision ids on a branch."""
1201
takes_args = ['location?']
1206
def run(self, location="."):
1207
branch = Branch.open_containing(location)[0]
1208
for revid in branch.revision_history():
1209
self.outf.write(revid)
1210
self.outf.write('\n')
1213
class cmd_ancestry(Command):
1214
"""List all revisions merged into this branch."""
1216
_see_also = ['log', 'revision-history']
1217
takes_args = ['location?']
1222
def run(self, location="."):
1224
wt = WorkingTree.open_containing(location)[0]
1225
except errors.NoWorkingTree:
1226
b = Branch.open(location)
1227
last_revision = b.last_revision()
1230
last_revision = wt.last_revision()
1232
revision_ids = b.repository.get_ancestry(last_revision)
1233
assert revision_ids[0] is None
1235
for revision_id in revision_ids:
1236
self.outf.write(revision_id + '\n')
1239
class cmd_init(Command):
1240
"""Make a directory into a versioned branch.
1242
Use this to create an empty branch, or before importing an
1245
If there is a repository in a parent directory of the location, then
1246
the history of the branch will be stored in the repository. Otherwise
1247
init creates a standalone branch which carries its own history
1248
in the .bzr directory.
1250
If there is already a branch at the location but it has no working tree,
1251
the tree can be populated with 'bzr checkout'.
1253
Recipe for importing a tree of files:
1258
bzr commit -m 'imported project'
1261
_see_also = ['init-repo', 'branch', 'checkout']
1262
takes_args = ['location?']
1264
RegistryOption('format',
1265
help='Specify a format for this branch. '
1266
'See "help formats".',
1267
registry=bzrdir.format_registry,
1268
converter=bzrdir.format_registry.make_bzrdir,
1269
value_switches=True,
1270
title="Branch Format",
1272
Option('append-revisions-only',
1273
help='Never change revnos or the existing log.'
1274
' Append revisions to it only.')
1276
def run(self, location=None, format=None, append_revisions_only=False):
1278
format = bzrdir.format_registry.make_bzrdir('default')
1279
if location is None:
1282
to_transport = transport.get_transport(location)
1284
# The path has to exist to initialize a
1285
# branch inside of it.
1286
# Just using os.mkdir, since I don't
1287
# believe that we want to create a bunch of
1288
# locations if the user supplies an extended path
1289
# TODO: create-prefix
1290
to_transport.ensure_base()
1293
existing_bzrdir = bzrdir.BzrDir.open(location)
1294
except errors.NotBranchError:
1295
# really a NotBzrDir error...
1296
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1299
from bzrlib.transport.local import LocalTransport
1300
if existing_bzrdir.has_branch():
1301
if (isinstance(to_transport, LocalTransport)
1302
and not existing_bzrdir.has_workingtree()):
1303
raise errors.BranchExistsWithoutWorkingTree(location)
1304
raise errors.AlreadyBranchError(location)
1306
branch = existing_bzrdir.create_branch()
1307
existing_bzrdir.create_workingtree()
1308
if append_revisions_only:
1310
branch.set_append_revisions_only(True)
1311
except errors.UpgradeRequired:
1312
raise errors.BzrCommandError('This branch format cannot be set'
1313
' to append-revisions-only. Try --experimental-branch6')
1316
class cmd_init_repository(Command):
1317
"""Create a shared repository to hold branches.
1319
New branches created under the repository directory will store their
1320
revisions in the repository, not in the branch directory.
1322
If the --no-trees option is used then the branches in the repository
1323
will not have working trees by default.
1326
bzr init-repo --no-trees repo
1328
bzr checkout --lightweight repo/trunk trunk-checkout
1332
See 'bzr help repositories' for more information.
1335
_see_also = ['init', 'branch', 'checkout']
1336
takes_args = ["location"]
1337
takes_options = [RegistryOption('format',
1338
help='Specify a format for this repository. See'
1339
' "bzr help formats" for details',
1340
registry=bzrdir.format_registry,
1341
converter=bzrdir.format_registry.make_bzrdir,
1342
value_switches=True, title='Repository format'),
1344
help='Branches in the repository will default to'
1345
' not having a working tree'),
1347
aliases = ["init-repo"]
1349
def run(self, location, format=None, no_trees=False):
1351
format = bzrdir.format_registry.make_bzrdir('default')
1353
if location is None:
1356
to_transport = transport.get_transport(location)
1357
to_transport.ensure_base()
1359
newdir = format.initialize_on_transport(to_transport)
1360
repo = newdir.create_repository(shared=True)
1361
repo.set_make_working_trees(not no_trees)
1364
class cmd_diff(Command):
1365
"""Show differences in the working tree or between revisions.
1367
If files are listed, only the changes in those files are listed.
1368
Otherwise, all changes for the tree are listed.
1370
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1371
produces patches suitable for "patch -p1".
1375
Shows the difference in the working tree versus the last commit
1377
Difference between the working tree and revision 1
1379
Difference between revision 2 and revision 1
1380
bzr diff --prefix old/:new/
1381
Same as 'bzr diff' but prefix paths with old/ and new/
1382
bzr diff bzr.mine bzr.dev
1383
Show the differences between the two working trees
1385
Show just the differences for 'foo.c'
1387
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1388
# or a graphical diff.
1390
# TODO: Python difflib is not exactly the same as unidiff; should
1391
# either fix it up or prefer to use an external diff.
1393
# TODO: Selected-file diff is inefficient and doesn't show you
1396
# TODO: This probably handles non-Unix newlines poorly.
1398
_see_also = ['status']
1399
takes_args = ['file*']
1400
takes_options = ['revision', 'diff-options',
1401
Option('prefix', type=str,
1403
help='Set prefixes to added to old and new filenames, as '
1404
'two values separated by a colon. (eg "old/:new/")'),
1406
aliases = ['di', 'dif']
1407
encoding_type = 'exact'
1410
def run(self, revision=None, file_list=None, diff_options=None,
1412
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1414
if (prefix is None) or (prefix == '0'):
1422
old_label, new_label = prefix.split(":")
1424
raise errors.BzrCommandError(
1425
'--prefix expects two values separated by a colon'
1426
' (eg "old/:new/")')
1428
if revision and len(revision) > 2:
1429
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1430
' one or two revision specifiers')
1433
tree1, file_list = internal_tree_files(file_list)
1437
except errors.FileInWrongBranch:
1438
if len(file_list) != 2:
1439
raise errors.BzrCommandError("Files are in different branches")
1441
tree1, file1 = WorkingTree.open_containing(file_list[0])
1442
tree2, file2 = WorkingTree.open_containing(file_list[1])
1443
if file1 != "" or file2 != "":
1444
# FIXME diff those two files. rbc 20051123
1445
raise errors.BzrCommandError("Files are in different branches")
1447
except errors.NotBranchError:
1448
if (revision is not None and len(revision) == 2
1449
and not revision[0].needs_branch()
1450
and not revision[1].needs_branch()):
1451
# If both revision specs include a branch, we can
1452
# diff them without needing a local working tree
1453
tree1, tree2 = None, None
1457
if tree2 is not None:
1458
if revision is not None:
1459
# FIXME: but there should be a clean way to diff between
1460
# non-default versions of two trees, it's not hard to do
1462
raise errors.BzrCommandError(
1463
"Sorry, diffing arbitrary revisions across branches "
1464
"is not implemented yet")
1465
return show_diff_trees(tree1, tree2, sys.stdout,
1466
specific_files=file_list,
1467
external_diff_options=diff_options,
1468
old_label=old_label, new_label=new_label)
1470
return diff_cmd_helper(tree1, file_list, diff_options,
1471
revision_specs=revision,
1472
old_label=old_label, new_label=new_label)
1475
class cmd_deleted(Command):
1476
"""List files deleted in the working tree.
1478
# TODO: Show files deleted since a previous revision, or
1479
# between two revisions.
1480
# TODO: Much more efficient way to do this: read in new
1481
# directories with readdir, rather than stating each one. Same
1482
# level of effort but possibly much less IO. (Or possibly not,
1483
# if the directories are very large...)
1484
_see_also = ['status', 'ls']
1485
takes_options = ['show-ids']
1488
def run(self, show_ids=False):
1489
tree = WorkingTree.open_containing(u'.')[0]
1492
old = tree.basis_tree()
1495
for path, ie in old.inventory.iter_entries():
1496
if not tree.has_id(ie.file_id):
1497
self.outf.write(path)
1499
self.outf.write(' ')
1500
self.outf.write(ie.file_id)
1501
self.outf.write('\n')
1508
class cmd_modified(Command):
1509
"""List files modified in working tree.
1513
_see_also = ['status', 'ls']
1517
tree = WorkingTree.open_containing(u'.')[0]
1518
td = tree.changes_from(tree.basis_tree())
1519
for path, id, kind, text_modified, meta_modified in td.modified:
1520
self.outf.write(path + '\n')
1523
class cmd_added(Command):
1524
"""List files added in working tree.
1528
_see_also = ['status', 'ls']
1532
wt = WorkingTree.open_containing(u'.')[0]
1535
basis = wt.basis_tree()
1538
basis_inv = basis.inventory
1541
if file_id in basis_inv:
1543
if inv.is_root(file_id) and len(basis_inv) == 0:
1545
path = inv.id2path(file_id)
1546
if not os.access(osutils.abspath(path), os.F_OK):
1548
self.outf.write(path + '\n')
1555
class cmd_root(Command):
1556
"""Show the tree root directory.
1558
The root is the nearest enclosing directory with a .bzr control
1561
takes_args = ['filename?']
1563
def run(self, filename=None):
1564
"""Print the branch root."""
1565
tree = WorkingTree.open_containing(filename)[0]
1566
self.outf.write(tree.basedir + '\n')
1569
def _parse_limit(limitstring):
1571
return int(limitstring)
1573
msg = "The limit argument must be an integer."
1574
raise errors.BzrCommandError(msg)
1577
class cmd_log(Command):
1578
"""Show log of a branch, file, or directory.
1580
By default show the log of the branch containing the working directory.
1582
To request a range of logs, you can use the command -r begin..end
1583
-r revision requests a specific revision, -r ..end or -r begin.. are
1589
bzr log -r -10.. http://server/branch
1592
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1594
takes_args = ['location?']
1595
takes_options = [Option('forward',
1596
help='show from oldest to newest'),
1600
help='show files changed in each revision'),
1601
'show-ids', 'revision',
1605
help='show revisions whose message matches this regexp',
1608
help='limit the output to the first N revisions',
1611
encoding_type = 'replace'
1614
def run(self, location=None, timezone='original',
1622
from bzrlib.log import show_log
1623
assert message is None or isinstance(message, basestring), \
1624
"invalid message argument %r" % message
1625
direction = (forward and 'forward') or 'reverse'
1630
# find the file id to log:
1632
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1636
tree = b.basis_tree()
1637
file_id = tree.path2id(fp)
1639
raise errors.BzrCommandError(
1640
"Path does not have any revision history: %s" %
1644
# FIXME ? log the current subdir only RBC 20060203
1645
if revision is not None \
1646
and len(revision) > 0 and revision[0].get_branch():
1647
location = revision[0].get_branch()
1650
dir, relpath = bzrdir.BzrDir.open_containing(location)
1651
b = dir.open_branch()
1655
if revision is None:
1658
elif len(revision) == 1:
1659
rev1 = rev2 = revision[0].in_history(b).revno
1660
elif len(revision) == 2:
1661
if revision[1].get_branch() != revision[0].get_branch():
1662
# b is taken from revision[0].get_branch(), and
1663
# show_log will use its revision_history. Having
1664
# different branches will lead to weird behaviors.
1665
raise errors.BzrCommandError(
1666
"Log doesn't accept two revisions in different"
1668
if revision[0].spec is None:
1669
# missing begin-range means first revision
1672
rev1 = revision[0].in_history(b).revno
1674
if revision[1].spec is None:
1675
# missing end-range means last known revision
1678
rev2 = revision[1].in_history(b).revno
1680
raise errors.BzrCommandError(
1681
'bzr log --revision takes one or two values.')
1683
# By this point, the revision numbers are converted to the +ve
1684
# form if they were supplied in the -ve form, so we can do
1685
# this comparison in relative safety
1687
(rev2, rev1) = (rev1, rev2)
1689
if log_format is None:
1690
log_format = log.log_formatter_registry.get_default(b)
1692
lf = log_format(show_ids=show_ids, to_file=self.outf,
1693
show_timezone=timezone)
1699
direction=direction,
1700
start_revision=rev1,
1708
def get_log_format(long=False, short=False, line=False, default='long'):
1709
log_format = default
1713
log_format = 'short'
1719
class cmd_touching_revisions(Command):
1720
"""Return revision-ids which affected a particular file.
1722
A more user-friendly interface is "bzr log FILE".
1726
takes_args = ["filename"]
1729
def run(self, filename):
1730
tree, relpath = WorkingTree.open_containing(filename)
1732
file_id = tree.path2id(relpath)
1733
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1734
self.outf.write("%6d %s\n" % (revno, what))
1737
class cmd_ls(Command):
1738
"""List files in a tree.
1741
_see_also = ['status', 'cat']
1742
takes_args = ['path?']
1743
# TODO: Take a revision or remote path and list that tree instead.
1744
takes_options = ['verbose', 'revision',
1745
Option('non-recursive',
1746
help='don\'t recurse into sub-directories'),
1748
help='Print all paths from the root of the branch.'),
1749
Option('unknown', help='Print unknown files'),
1750
Option('versioned', help='Print versioned files'),
1751
Option('ignored', help='Print ignored files'),
1753
Option('null', help='Null separate the files'),
1757
def run(self, revision=None, verbose=False,
1758
non_recursive=False, from_root=False,
1759
unknown=False, versioned=False, ignored=False,
1760
null=False, kind=None, show_ids=False, path=None):
1762
if kind and kind not in ('file', 'directory', 'symlink'):
1763
raise errors.BzrCommandError('invalid kind specified')
1765
if verbose and null:
1766
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1767
all = not (unknown or versioned or ignored)
1769
selection = {'I':ignored, '?':unknown, 'V':versioned}
1776
raise errors.BzrCommandError('cannot specify both --from-root'
1780
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1786
if revision is not None:
1787
tree = branch.repository.revision_tree(
1788
revision[0].in_history(branch).rev_id)
1790
tree = branch.basis_tree()
1794
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1795
if fp.startswith(relpath):
1796
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1797
if non_recursive and '/' in fp:
1799
if not all and not selection[fc]:
1801
if kind is not None and fkind != kind:
1804
kindch = entry.kind_character()
1805
outstring = '%-8s %s%s' % (fc, fp, kindch)
1806
if show_ids and fid is not None:
1807
outstring = "%-50s %s" % (outstring, fid)
1808
self.outf.write(outstring + '\n')
1810
self.outf.write(fp + '\0')
1813
self.outf.write(fid)
1814
self.outf.write('\0')
1822
self.outf.write('%-50s %s\n' % (fp, my_id))
1824
self.outf.write(fp + '\n')
1829
class cmd_unknowns(Command):
1830
"""List unknown files.
1838
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1839
self.outf.write(osutils.quotefn(f) + '\n')
1842
class cmd_ignore(Command):
1843
"""Ignore specified files or patterns.
1845
To remove patterns from the ignore list, edit the .bzrignore file.
1847
Trailing slashes on patterns are ignored.
1848
If the pattern contains a slash or is a regular expression, it is compared
1849
to the whole path from the branch root. Otherwise, it is compared to only
1850
the last component of the path. To match a file only in the root
1851
directory, prepend './'.
1853
Ignore patterns specifying absolute paths are not allowed.
1855
Ignore patterns may include globbing wildcards such as:
1856
? - Matches any single character except '/'
1857
* - Matches 0 or more characters except '/'
1858
/**/ - Matches 0 or more directories in a path
1859
[a-z] - Matches a single character from within a group of characters
1861
Ignore patterns may also be Python regular expressions.
1862
Regular expression ignore patterns are identified by a 'RE:' prefix
1863
followed by the regular expression. Regular expression ignore patterns
1864
may not include named or numbered groups.
1866
Note: ignore patterns containing shell wildcards must be quoted from
1870
bzr ignore ./Makefile
1871
bzr ignore '*.class'
1872
bzr ignore 'lib/**/*.o'
1873
bzr ignore 'RE:lib/.*\.o'
1876
_see_also = ['status', 'ignored']
1877
takes_args = ['name_pattern*']
1879
Option('old-default-rules',
1880
help='Out the ignore rules bzr < 0.9 always used.')
1883
def run(self, name_pattern_list=None, old_default_rules=None):
1884
from bzrlib.atomicfile import AtomicFile
1885
if old_default_rules is not None:
1886
# dump the rules and exit
1887
for pattern in ignores.OLD_DEFAULTS:
1890
if not name_pattern_list:
1891
raise errors.BzrCommandError("ignore requires at least one "
1892
"NAME_PATTERN or --old-default-rules")
1893
name_pattern_list = [globbing.normalize_pattern(p)
1894
for p in name_pattern_list]
1895
for name_pattern in name_pattern_list:
1896
if (name_pattern[0] == '/' or
1897
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1898
raise errors.BzrCommandError(
1899
"NAME_PATTERN should not be an absolute path")
1900
tree, relpath = WorkingTree.open_containing(u'.')
1901
ifn = tree.abspath('.bzrignore')
1902
if os.path.exists(ifn):
1905
igns = f.read().decode('utf-8')
1911
# TODO: If the file already uses crlf-style termination, maybe
1912
# we should use that for the newly added lines?
1914
if igns and igns[-1] != '\n':
1916
for name_pattern in name_pattern_list:
1917
igns += name_pattern + '\n'
1919
f = AtomicFile(ifn, 'wb')
1921
f.write(igns.encode('utf-8'))
1926
if not tree.path2id('.bzrignore'):
1927
tree.add(['.bzrignore'])
1930
class cmd_ignored(Command):
1931
"""List ignored files and the patterns that matched them.
1934
_see_also = ['ignore']
1937
tree = WorkingTree.open_containing(u'.')[0]
1940
for path, file_class, kind, file_id, entry in tree.list_files():
1941
if file_class != 'I':
1943
## XXX: Slightly inefficient since this was already calculated
1944
pat = tree.is_ignored(path)
1945
print '%-50s %s' % (path, pat)
1950
class cmd_lookup_revision(Command):
1951
"""Lookup the revision-id from a revision-number
1954
bzr lookup-revision 33
1957
takes_args = ['revno']
1960
def run(self, revno):
1964
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1966
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1969
class cmd_export(Command):
1970
"""Export current or past revision to a destination directory or archive.
1972
If no revision is specified this exports the last committed revision.
1974
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1975
given, try to find the format with the extension. If no extension
1976
is found exports to a directory (equivalent to --format=dir).
1978
If root is supplied, it will be used as the root directory inside
1979
container formats (tar, zip, etc). If it is not supplied it will default
1980
to the exported filename. The root option has no effect for 'dir' format.
1982
If branch is omitted then the branch containing the current working
1983
directory will be used.
1985
Note: Export of tree with non-ASCII filenames to zip is not supported.
1987
Supported formats Autodetected by extension
1988
----------------- -------------------------
1991
tbz2 .tar.bz2, .tbz2
1995
takes_args = ['dest', 'branch?']
1996
takes_options = ['revision', 'format', 'root']
1997
def run(self, dest, branch=None, revision=None, format=None, root=None):
1998
from bzrlib.export import export
2001
tree = WorkingTree.open_containing(u'.')[0]
2004
b = Branch.open(branch)
2006
if revision is None:
2007
# should be tree.last_revision FIXME
2008
rev_id = b.last_revision()
2010
if len(revision) != 1:
2011
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2012
rev_id = revision[0].in_history(b).rev_id
2013
t = b.repository.revision_tree(rev_id)
2015
export(t, dest, format, root)
2016
except errors.NoSuchExportFormat, e:
2017
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2020
class cmd_cat(Command):
2021
"""Write the contents of a file as of a given revision to standard output.
2023
If no revision is nominated, the last revision is used.
2025
Note: Take care to redirect standard output when using this command on a
2030
takes_options = ['revision', 'name-from-revision']
2031
takes_args = ['filename']
2032
encoding_type = 'exact'
2035
def run(self, filename, revision=None, name_from_revision=False):
2036
if revision is not None and len(revision) != 1:
2037
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2042
tree, b, relpath = \
2043
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2044
except errors.NotBranchError:
2047
if revision is not None and revision[0].get_branch() is not None:
2048
b = Branch.open(revision[0].get_branch())
2050
tree = b.basis_tree()
2051
if revision is None:
2052
revision_id = b.last_revision()
2054
revision_id = revision[0].in_history(b).rev_id
2056
cur_file_id = tree.path2id(relpath)
2057
rev_tree = b.repository.revision_tree(revision_id)
2058
old_file_id = rev_tree.path2id(relpath)
2060
if name_from_revision:
2061
if old_file_id is None:
2062
raise errors.BzrCommandError("%r is not present in revision %s"
2063
% (filename, revision_id))
2065
rev_tree.print_file(old_file_id)
2066
elif cur_file_id is not None:
2067
rev_tree.print_file(cur_file_id)
2068
elif old_file_id is not None:
2069
rev_tree.print_file(old_file_id)
2071
raise errors.BzrCommandError("%r is not present in revision %s" %
2072
(filename, revision_id))
2075
class cmd_local_time_offset(Command):
2076
"""Show the offset in seconds from GMT to local time."""
2080
print osutils.local_time_offset()
2084
class cmd_commit(Command):
2085
"""Commit changes into a new revision.
2087
If no arguments are given, the entire tree is committed.
2089
If selected files are specified, only changes to those files are
2090
committed. If a directory is specified then the directory and everything
2091
within it is committed.
2093
A selected-file commit may fail in some cases where the committed
2094
tree would be invalid. Consider::
2099
bzr commit foo -m "committing foo"
2100
bzr mv foo/bar foo/baz
2103
bzr commit foo/bar -m "committing bar but not baz"
2105
In the example above, the last commit will fail by design. This gives
2106
the user the opportunity to decide whether they want to commit the
2107
rename at the same time, separately first, or not at all. (As a general
2108
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2110
Note: A selected-file commit after a merge is not yet supported.
2112
# TODO: Run hooks on tree to-be-committed, and after commit.
2114
# TODO: Strict commit that fails if there are deleted files.
2115
# (what does "deleted files" mean ??)
2117
# TODO: Give better message for -s, --summary, used by tla people
2119
# XXX: verbose currently does nothing
2121
_see_also = ['bugs', 'uncommit']
2122
takes_args = ['selected*']
2123
takes_options = ['message', 'verbose',
2125
help='commit even if nothing has changed'),
2126
Option('file', type=str,
2129
help='file containing commit message'),
2131
help="refuse to commit if there are unknown "
2132
"files in the working tree."),
2133
ListOption('fixes', type=str,
2134
help="mark a bug as being fixed by this "
2137
help="perform a local only commit in a bound "
2138
"branch. Such commits are not pushed to "
2139
"the master branch until a normal commit "
2143
aliases = ['ci', 'checkin']
2145
def _get_bug_fix_properties(self, fixes, branch):
2147
# Configure the properties for bug fixing attributes.
2148
for fixed_bug in fixes:
2149
tokens = fixed_bug.split(':')
2150
if len(tokens) != 2:
2151
raise errors.BzrCommandError(
2152
"Invalid bug %s. Must be in the form of 'tag:id'. "
2153
"Commit refused." % fixed_bug)
2154
tag, bug_id = tokens
2156
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2157
except errors.UnknownBugTrackerAbbreviation:
2158
raise errors.BzrCommandError(
2159
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2160
except errors.MalformedBugIdentifier:
2161
raise errors.BzrCommandError(
2162
"Invalid bug identifier for %s. Commit refused."
2164
properties.append('%s fixed' % bug_url)
2165
return '\n'.join(properties)
2167
def run(self, message=None, file=None, verbose=True, selected_list=None,
2168
unchanged=False, strict=False, local=False, fixes=None):
2169
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2170
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2172
from bzrlib.msgeditor import edit_commit_message, \
2173
make_commit_message_template
2175
# TODO: Need a blackbox test for invoking the external editor; may be
2176
# slightly problematic to run this cross-platform.
2178
# TODO: do more checks that the commit will succeed before
2179
# spending the user's valuable time typing a commit message.
2183
tree, selected_list = tree_files(selected_list)
2184
if selected_list == ['']:
2185
# workaround - commit of root of tree should be exactly the same
2186
# as just default commit in that tree, and succeed even though
2187
# selected-file merge commit is not done yet
2190
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2192
properties['bugs'] = bug_property
2194
if local and not tree.branch.get_bound_location():
2195
raise errors.LocalRequiresBoundBranch()
2197
def get_message(commit_obj):
2198
"""Callback to get commit message"""
2199
my_message = message
2200
if my_message is None and not file:
2201
template = make_commit_message_template(tree, selected_list)
2202
my_message = edit_commit_message(template)
2203
if my_message is None:
2204
raise errors.BzrCommandError("please specify a commit"
2205
" message with either --message or --file")
2206
elif my_message and file:
2207
raise errors.BzrCommandError(
2208
"please specify either --message or --file")
2210
my_message = codecs.open(file, 'rt',
2211
bzrlib.user_encoding).read()
2212
if my_message == "":
2213
raise errors.BzrCommandError("empty commit message specified")
2217
reporter = ReportCommitToLog()
2219
reporter = NullCommitReporter()
2222
tree.commit(message_callback=get_message,
2223
specific_files=selected_list,
2224
allow_pointless=unchanged, strict=strict, local=local,
2225
reporter=reporter, revprops=properties)
2226
except PointlessCommit:
2227
# FIXME: This should really happen before the file is read in;
2228
# perhaps prepare the commit; get the message; then actually commit
2229
raise errors.BzrCommandError("no changes to commit."
2230
" use --unchanged to commit anyhow")
2231
except ConflictsInTree:
2232
raise errors.BzrCommandError('Conflicts detected in working '
2233
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2235
except StrictCommitFailed:
2236
raise errors.BzrCommandError("Commit refused because there are"
2237
" unknown files in the working tree.")
2238
except errors.BoundBranchOutOfDate, e:
2239
raise errors.BzrCommandError(str(e) + "\n"
2240
'To commit to master branch, run update and then commit.\n'
2241
'You can also pass --local to commit to continue working '
2245
class cmd_check(Command):
2246
"""Validate consistency of branch history.
2248
This command checks various invariants about the branch storage to
2249
detect data corruption or bzr bugs.
2252
_see_also = ['reconcile']
2253
takes_args = ['branch?']
2254
takes_options = ['verbose']
2256
def run(self, branch=None, verbose=False):
2257
from bzrlib.check import check
2259
tree = WorkingTree.open_containing()[0]
2260
branch = tree.branch
2262
branch = Branch.open(branch)
2263
check(branch, verbose)
2266
class cmd_upgrade(Command):
2267
"""Upgrade branch storage to current format.
2269
The check command or bzr developers may sometimes advise you to run
2270
this command. When the default format has changed you may also be warned
2271
during other operations to upgrade.
2274
_see_also = ['check']
2275
takes_args = ['url?']
2277
RegistryOption('format',
2278
help='Upgrade to a specific format. See "bzr help'
2279
' formats" for details',
2280
registry=bzrdir.format_registry,
2281
converter=bzrdir.format_registry.make_bzrdir,
2282
value_switches=True, title='Branch format'),
2285
def run(self, url='.', format=None):
2286
from bzrlib.upgrade import upgrade
2288
format = bzrdir.format_registry.make_bzrdir('default')
2289
upgrade(url, format)
2292
class cmd_whoami(Command):
2293
"""Show or set bzr user id.
2297
bzr whoami 'Frank Chu <fchu@example.com>'
2299
takes_options = [ Option('email',
2300
help='display email address only'),
2302
help='set identity for the current branch instead of '
2305
takes_args = ['name?']
2306
encoding_type = 'replace'
2309
def run(self, email=False, branch=False, name=None):
2311
# use branch if we're inside one; otherwise global config
2313
c = Branch.open_containing('.')[0].get_config()
2314
except errors.NotBranchError:
2315
c = config.GlobalConfig()
2317
self.outf.write(c.user_email() + '\n')
2319
self.outf.write(c.username() + '\n')
2322
# display a warning if an email address isn't included in the given name.
2324
config.extract_email_address(name)
2325
except errors.NoEmailInUsername, e:
2326
warning('"%s" does not seem to contain an email address. '
2327
'This is allowed, but not recommended.', name)
2329
# use global config unless --branch given
2331
c = Branch.open_containing('.')[0].get_config()
2333
c = config.GlobalConfig()
2334
c.set_user_option('email', name)
2337
class cmd_nick(Command):
2338
"""Print or set the branch nickname.
2340
If unset, the tree root directory name is used as the nickname
2341
To print the current nickname, execute with no argument.
2344
_see_also = ['info']
2345
takes_args = ['nickname?']
2346
def run(self, nickname=None):
2347
branch = Branch.open_containing(u'.')[0]
2348
if nickname is None:
2349
self.printme(branch)
2351
branch.nick = nickname
2354
def printme(self, branch):
2358
class cmd_selftest(Command):
2359
"""Run internal test suite.
2361
This creates temporary test directories in the working directory, but no
2362
existing data is affected. These directories are deleted if the tests
2363
pass, or left behind to help in debugging if they fail and --keep-output
2366
If arguments are given, they are regular expressions that say which tests
2367
should run. Tests matching any expression are run, and other tests are
2370
Alternatively if --first is given, matching tests are run first and then
2371
all other tests are run. This is useful if you have been working in a
2372
particular area, but want to make sure nothing else was broken.
2374
If --exclude is given, tests that match that regular expression are
2375
excluded, regardless of whether they match --first or not.
2377
To help catch accidential dependencies between tests, the --randomize
2378
option is useful. In most cases, the argument used is the word 'now'.
2379
Note that the seed used for the random number generator is displayed
2380
when this option is used. The seed can be explicitly passed as the
2381
argument to this option if required. This enables reproduction of the
2382
actual ordering used if and when an order sensitive problem is encountered.
2384
If --list-only is given, the tests that would be run are listed. This is
2385
useful when combined with --first, --exclude and/or --randomize to
2386
understand their impact. The test harness reports "Listed nn tests in ..."
2387
instead of "Ran nn tests in ..." when list mode is enabled.
2389
If the global option '--no-plugins' is given, plugins are not loaded
2390
before running the selftests. This has two effects: features provided or
2391
modified by plugins will not be tested, and tests provided by plugins will
2396
run only tests relating to 'ignore'
2397
bzr --no-plugins selftest -v
2398
disable plugins and list tests as they're run
2400
For each test, that needs actual disk access, bzr create their own
2401
subdirectory in the temporary testing directory (testXXXX.tmp).
2402
By default the name of such subdirectory is based on the name of the test.
2403
If option '--numbered-dirs' is given, bzr will use sequent numbers
2404
of running tests to create such subdirectories. This is default behavior
2405
on Windows because of path length limitation.
2407
# NB: this is used from the class without creating an instance, which is
2408
# why it does not have a self parameter.
2409
def get_transport_type(typestring):
2410
"""Parse and return a transport specifier."""
2411
if typestring == "sftp":
2412
from bzrlib.transport.sftp import SFTPAbsoluteServer
2413
return SFTPAbsoluteServer
2414
if typestring == "memory":
2415
from bzrlib.transport.memory import MemoryServer
2417
if typestring == "fakenfs":
2418
from bzrlib.transport.fakenfs import FakeNFSServer
2419
return FakeNFSServer
2420
msg = "No known transport type %s. Supported types are: sftp\n" %\
2422
raise errors.BzrCommandError(msg)
2425
takes_args = ['testspecs*']
2426
takes_options = ['verbose',
2428
help='stop when one test fails',
2431
Option('keep-output',
2432
help='keep output directories when tests fail'),
2434
help='Use a different transport by default '
2435
'throughout the test suite.',
2436
type=get_transport_type),
2437
Option('benchmark', help='run the bzr benchmarks.'),
2438
Option('lsprof-timed',
2439
help='generate lsprof output for benchmarked'
2440
' sections of code.'),
2441
Option('cache-dir', type=str,
2442
help='a directory to cache intermediate'
2443
' benchmark steps'),
2444
Option('clean-output',
2445
help='clean temporary tests directories'
2446
' without running tests'),
2448
help='run all tests, but run specified tests first',
2451
Option('numbered-dirs',
2452
help='use numbered dirs for TestCaseInTempDir'),
2454
help='list the tests instead of running them'),
2455
Option('randomize', type=str, argname="SEED",
2456
help='randomize the order of tests using the given'
2457
' seed or "now" for the current time'),
2458
Option('exclude', type=str, argname="PATTERN",
2460
help='exclude tests that match this regular'
2463
encoding_type = 'replace'
2465
def run(self, testspecs_list=None, verbose=None, one=False,
2466
keep_output=False, transport=None, benchmark=None,
2467
lsprof_timed=None, cache_dir=None, clean_output=False,
2468
first=False, numbered_dirs=None, list_only=False,
2469
randomize=None, exclude=None):
2471
from bzrlib.tests import selftest
2472
import bzrlib.benchmarks as benchmarks
2473
from bzrlib.benchmarks import tree_creator
2476
from bzrlib.tests import clean_selftest_output
2477
clean_selftest_output()
2480
if numbered_dirs is None and sys.platform == 'win32':
2481
numbered_dirs = True
2483
if cache_dir is not None:
2484
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2485
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2486
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2488
if testspecs_list is not None:
2489
pattern = '|'.join(testspecs_list)
2493
test_suite_factory = benchmarks.test_suite
2496
# TODO: should possibly lock the history file...
2497
benchfile = open(".perf_history", "at", buffering=1)
2499
test_suite_factory = None
2504
result = selftest(verbose=verbose,
2506
stop_on_failure=one,
2507
keep_output=keep_output,
2508
transport=transport,
2509
test_suite_factory=test_suite_factory,
2510
lsprof_timed=lsprof_timed,
2511
bench_history=benchfile,
2512
matching_tests_first=first,
2513
numbered_dirs=numbered_dirs,
2514
list_only=list_only,
2515
random_seed=randomize,
2516
exclude_pattern=exclude
2519
if benchfile is not None:
2522
info('tests passed')
2524
info('tests failed')
2525
return int(not result)
2528
class cmd_version(Command):
2529
"""Show version of bzr."""
2533
from bzrlib.version import show_version
2537
class cmd_rocks(Command):
2538
"""Statement of optimism."""
2544
print "It sure does!"
2547
class cmd_find_merge_base(Command):
2548
"""Find and print a base revision for merging two branches."""
2549
# TODO: Options to specify revisions on either side, as if
2550
# merging only part of the history.
2551
takes_args = ['branch', 'other']
2555
def run(self, branch, other):
2556
from bzrlib.revision import MultipleRevisionSources
2558
branch1 = Branch.open_containing(branch)[0]
2559
branch2 = Branch.open_containing(other)[0]
2561
last1 = branch1.last_revision()
2562
last2 = branch2.last_revision()
2564
graph = branch1.repository.get_graph(branch2.repository)
2565
base_rev_id = graph.find_unique_lca(last1, last2)
2567
print 'merge base is revision %s' % base_rev_id
2570
class cmd_merge(Command):
2571
"""Perform a three-way merge.
2573
The branch is the branch you will merge from. By default, it will merge
2574
the latest revision. If you specify a revision, that revision will be
2575
merged. If you specify two revisions, the first will be used as a BASE,
2576
and the second one as OTHER. Revision numbers are always relative to the
2579
By default, bzr will try to merge in all new work from the other
2580
branch, automatically determining an appropriate base. If this
2581
fails, you may need to give an explicit base.
2583
Merge will do its best to combine the changes in two branches, but there
2584
are some kinds of problems only a human can fix. When it encounters those,
2585
it will mark a conflict. A conflict means that you need to fix something,
2586
before you should commit.
2588
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2590
If there is no default branch set, the first merge will set it. After
2591
that, you can omit the branch to use the default. To change the
2592
default, use --remember. The value will only be saved if the remote
2593
location can be accessed.
2595
The results of the merge are placed into the destination working
2596
directory, where they can be reviewed (with bzr diff), tested, and then
2597
committed to record the result of the merge.
2601
To merge the latest revision from bzr.dev:
2602
bzr merge ../bzr.dev
2604
To merge changes up to and including revision 82 from bzr.dev:
2605
bzr merge -r 82 ../bzr.dev
2607
To merge the changes introduced by 82, without previous changes:
2608
bzr merge -r 81..82 ../bzr.dev
2610
merge refuses to run if there are any uncommitted changes, unless
2614
_see_also = ['update', 'remerge']
2615
takes_args = ['branch?']
2616
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2617
Option('show-base', help="Show base revision text in "
2619
Option('uncommitted', help='Apply uncommitted changes'
2620
' from a working copy, instead of branch changes'),
2621
Option('pull', help='If the destination is already'
2622
' completely merged into the source, pull from the'
2623
' source rather than merging. When this happens,'
2624
' you do not need to commit the result.'),
2626
help='Branch to merge into, '
2627
'rather than the one containing the working directory',
2633
def run(self, branch=None, revision=None, force=False, merge_type=None,
2634
show_base=False, reprocess=False, remember=False,
2635
uncommitted=False, pull=False,
2638
from bzrlib.tag import _merge_tags_if_possible
2639
other_revision_id = None
2640
if merge_type is None:
2641
merge_type = _mod_merge.Merge3Merger
2643
if directory is None: directory = u'.'
2644
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2645
# inventory. Because merge is a mutating operation, it really
2646
# should be a lock_write() for the whole cmd_merge operation.
2647
# However, cmd_merge open's its own tree in _merge_helper, which
2648
# means if we lock here, the later lock_write() will always block.
2649
# Either the merge helper code should be updated to take a tree,
2650
# (What about tree.merge_from_branch?)
2651
tree = WorkingTree.open_containing(directory)[0]
2652
change_reporter = delta._ChangeReporter(
2653
unversioned_filter=tree.is_ignored)
2655
if branch is not None:
2657
mergeable = bundle.read_mergeable_from_url(
2659
except errors.NotABundle:
2660
pass # Continue on considering this url a Branch
2662
if revision is not None:
2663
raise errors.BzrCommandError(
2664
'Cannot use -r with merge directives or bundles')
2665
other_revision_id = mergeable.install_revisions(
2666
tree.branch.repository)
2667
revision = [RevisionSpec.from_string(
2668
'revid:' + other_revision_id)]
2670
if revision is None \
2671
or len(revision) < 1 or revision[0].needs_branch():
2672
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2674
if revision is None or len(revision) < 1:
2677
other = [branch, None]
2680
other = [branch, -1]
2681
other_branch, path = Branch.open_containing(branch)
2684
raise errors.BzrCommandError('Cannot use --uncommitted and'
2685
' --revision at the same time.')
2686
branch = revision[0].get_branch() or branch
2687
if len(revision) == 1:
2689
if other_revision_id is not None:
2694
other_branch, path = Branch.open_containing(branch)
2695
revno = revision[0].in_history(other_branch).revno
2696
other = [branch, revno]
2698
assert len(revision) == 2
2699
if None in revision:
2700
raise errors.BzrCommandError(
2701
"Merge doesn't permit empty revision specifier.")
2702
base_branch, path = Branch.open_containing(branch)
2703
branch1 = revision[1].get_branch() or branch
2704
other_branch, path1 = Branch.open_containing(branch1)
2705
if revision[0].get_branch() is not None:
2706
# then path was obtained from it, and is None.
2709
base = [branch, revision[0].in_history(base_branch).revno]
2710
other = [branch1, revision[1].in_history(other_branch).revno]
2712
if ((tree.branch.get_parent() is None or remember) and
2713
other_branch is not None):
2714
tree.branch.set_parent(other_branch.base)
2716
# pull tags now... it's a bit inconsistent to do it ahead of copying
2717
# the history but that's done inside the merge code
2718
if other_branch is not None:
2719
_merge_tags_if_possible(other_branch, tree.branch)
2722
interesting_files = [path]
2724
interesting_files = None
2725
pb = ui.ui_factory.nested_progress_bar()
2728
conflict_count = _merge_helper(
2729
other, base, other_rev_id=other_revision_id,
2730
check_clean=(not force),
2731
merge_type=merge_type,
2732
reprocess=reprocess,
2733
show_base=show_base,
2736
pb=pb, file_list=interesting_files,
2737
change_reporter=change_reporter)
2740
if conflict_count != 0:
2744
except errors.AmbiguousBase, e:
2745
m = ("sorry, bzr can't determine the right merge base yet\n"
2746
"candidates are:\n "
2747
+ "\n ".join(e.bases)
2749
"please specify an explicit base with -r,\n"
2750
"and (if you want) report this to the bzr developers\n")
2753
# TODO: move up to common parent; this isn't merge-specific anymore.
2754
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2755
"""Use tree.branch's parent if none was supplied.
2757
Report if the remembered location was used.
2759
if supplied_location is not None:
2760
return supplied_location
2761
stored_location = tree.branch.get_parent()
2762
mutter("%s", stored_location)
2763
if stored_location is None:
2764
raise errors.BzrCommandError("No location specified or remembered")
2765
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2766
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2767
return stored_location
2770
class cmd_remerge(Command):
2773
Use this if you want to try a different merge technique while resolving
2774
conflicts. Some merge techniques are better than others, and remerge
2775
lets you try different ones on different files.
2777
The options for remerge have the same meaning and defaults as the ones for
2778
merge. The difference is that remerge can (only) be run when there is a
2779
pending merge, and it lets you specify particular files.
2783
$ bzr remerge --show-base
2784
Re-do the merge of all conflicted files, and show the base text in
2785
conflict regions, in addition to the usual THIS and OTHER texts.
2787
$ bzr remerge --merge-type weave --reprocess foobar
2788
Re-do the merge of "foobar", using the weave merge algorithm, with
2789
additional processing to reduce the size of conflict regions.
2791
takes_args = ['file*']
2792
takes_options = ['merge-type', 'reprocess',
2793
Option('show-base', help="Show base revision text in "
2796
def run(self, file_list=None, merge_type=None, show_base=False,
2798
if merge_type is None:
2799
merge_type = _mod_merge.Merge3Merger
2800
tree, file_list = tree_files(file_list)
2803
parents = tree.get_parent_ids()
2804
if len(parents) != 2:
2805
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2806
" merges. Not cherrypicking or"
2808
repository = tree.branch.repository
2809
graph = repository.get_graph()
2810
base_revision = graph.find_unique_lca(parents[0], parents[1])
2811
base_tree = repository.revision_tree(base_revision)
2812
other_tree = repository.revision_tree(parents[1])
2813
interesting_ids = None
2815
conflicts = tree.conflicts()
2816
if file_list is not None:
2817
interesting_ids = set()
2818
for filename in file_list:
2819
file_id = tree.path2id(filename)
2821
raise errors.NotVersionedError(filename)
2822
interesting_ids.add(file_id)
2823
if tree.kind(file_id) != "directory":
2826
for name, ie in tree.inventory.iter_entries(file_id):
2827
interesting_ids.add(ie.file_id)
2828
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2830
# Remerge only supports resolving contents conflicts
2831
allowed_conflicts = ('text conflict', 'contents conflict')
2832
restore_files = [c.path for c in conflicts
2833
if c.typestring in allowed_conflicts]
2834
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2835
tree.set_conflicts(ConflictList(new_conflicts))
2836
if file_list is not None:
2837
restore_files = file_list
2838
for filename in restore_files:
2840
restore(tree.abspath(filename))
2841
except errors.NotConflicted:
2843
conflicts = _mod_merge.merge_inner(
2844
tree.branch, other_tree, base_tree,
2846
interesting_ids=interesting_ids,
2847
other_rev_id=parents[1],
2848
merge_type=merge_type,
2849
show_base=show_base,
2850
reprocess=reprocess)
2859
class cmd_revert(Command):
2860
"""Revert files to a previous revision.
2862
Giving a list of files will revert only those files. Otherwise, all files
2863
will be reverted. If the revision is not specified with '--revision', the
2864
last committed revision is used.
2866
To remove only some changes, without reverting to a prior version, use
2867
merge instead. For example, "merge . --r-2..-3" will remove the changes
2868
introduced by -2, without affecting the changes introduced by -1. Or
2869
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2871
By default, any files that have been manually changed will be backed up
2872
first. (Files changed only by merge are not backed up.) Backup files have
2873
'.~#~' appended to their name, where # is a number.
2875
When you provide files, you can use their current pathname or the pathname
2876
from the target revision. So you can use revert to "undelete" a file by
2877
name. If you name a directory, all the contents of that directory will be
2881
_see_also = ['cat', 'export']
2882
takes_options = ['revision', 'no-backup']
2883
takes_args = ['file*']
2885
def run(self, revision=None, no_backup=False, file_list=None):
2886
if file_list is not None:
2887
if len(file_list) == 0:
2888
raise errors.BzrCommandError("No files specified")
2892
tree, file_list = tree_files(file_list)
2893
if revision is None:
2894
# FIXME should be tree.last_revision
2895
rev_id = tree.last_revision()
2896
elif len(revision) != 1:
2897
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2899
rev_id = revision[0].in_history(tree.branch).rev_id
2900
pb = ui.ui_factory.nested_progress_bar()
2902
tree.revert(file_list,
2903
tree.branch.repository.revision_tree(rev_id),
2904
not no_backup, pb, report_changes=True)
2909
class cmd_assert_fail(Command):
2910
"""Test reporting of assertion failures"""
2911
# intended just for use in testing
2916
raise AssertionError("always fails")
2919
class cmd_help(Command):
2920
"""Show help on a command or other topic.
2923
_see_also = ['topics']
2924
takes_options = [Option('long', 'show help on all commands')]
2925
takes_args = ['topic?']
2926
aliases = ['?', '--help', '-?', '-h']
2929
def run(self, topic=None, long=False):
2931
if topic is None and long:
2933
bzrlib.help.help(topic)
2936
class cmd_shell_complete(Command):
2937
"""Show appropriate completions for context.
2939
For a list of all available commands, say 'bzr shell-complete'.
2941
takes_args = ['context?']
2946
def run(self, context=None):
2947
import shellcomplete
2948
shellcomplete.shellcomplete(context)
2951
class cmd_fetch(Command):
2952
"""Copy in history from another branch but don't merge it.
2954
This is an internal method used for pull and merge.
2957
takes_args = ['from_branch', 'to_branch']
2958
def run(self, from_branch, to_branch):
2959
from bzrlib.fetch import Fetcher
2960
from_b = Branch.open(from_branch)
2961
to_b = Branch.open(to_branch)
2962
Fetcher(to_b, from_b)
2965
class cmd_missing(Command):
2966
"""Show unmerged/unpulled revisions between two branches.
2968
OTHER_BRANCH may be local or remote.
2971
_see_also = ['merge', 'pull']
2972
takes_args = ['other_branch?']
2973
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2975
'Display changes in the local branch only'),
2976
Option('theirs-only',
2977
'Display changes in the remote branch only'),
2982
encoding_type = 'replace'
2985
def run(self, other_branch=None, reverse=False, mine_only=False,
2986
theirs_only=False, log_format=None, long=False, short=False, line=False,
2987
show_ids=False, verbose=False):
2988
from bzrlib.missing import find_unmerged, iter_log_revisions
2989
from bzrlib.log import log_formatter
2990
local_branch = Branch.open_containing(u".")[0]
2991
parent = local_branch.get_parent()
2992
if other_branch is None:
2993
other_branch = parent
2994
if other_branch is None:
2995
raise errors.BzrCommandError("No peer location known or specified.")
2996
display_url = urlutils.unescape_for_display(parent,
2998
print "Using last location: " + display_url
3000
remote_branch = Branch.open(other_branch)
3001
if remote_branch.base == local_branch.base:
3002
remote_branch = local_branch
3003
local_branch.lock_read()
3005
remote_branch.lock_read()
3007
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
3008
if (log_format is None):
3009
log_format = log.log_formatter_registry.get_default(
3011
lf = log_format(to_file=self.outf,
3013
show_timezone='original')
3014
if reverse is False:
3015
local_extra.reverse()
3016
remote_extra.reverse()
3017
if local_extra and not theirs_only:
3018
print "You have %d extra revision(s):" % len(local_extra)
3019
for revision in iter_log_revisions(local_extra,
3020
local_branch.repository,
3022
lf.log_revision(revision)
3023
printed_local = True
3025
printed_local = False
3026
if remote_extra and not mine_only:
3027
if printed_local is True:
3029
print "You are missing %d revision(s):" % len(remote_extra)
3030
for revision in iter_log_revisions(remote_extra,
3031
remote_branch.repository,
3033
lf.log_revision(revision)
3034
if not remote_extra and not local_extra:
3036
print "Branches are up to date."
3040
remote_branch.unlock()
3042
local_branch.unlock()
3043
if not status_code and parent is None and other_branch is not None:
3044
local_branch.lock_write()
3046
# handle race conditions - a parent might be set while we run.
3047
if local_branch.get_parent() is None:
3048
local_branch.set_parent(remote_branch.base)
3050
local_branch.unlock()
3054
class cmd_plugins(Command):
3059
import bzrlib.plugin
3060
from inspect import getdoc
3061
for name, plugin in bzrlib.plugin.all_plugins().items():
3062
if getattr(plugin, '__path__', None) is not None:
3063
print plugin.__path__[0]
3064
elif getattr(plugin, '__file__', None) is not None:
3065
print plugin.__file__
3071
print '\t', d.split('\n')[0]
3074
class cmd_testament(Command):
3075
"""Show testament (signing-form) of a revision."""
3076
takes_options = ['revision',
3077
Option('long', help='Produce long-format testament'),
3078
Option('strict', help='Produce a strict-format'
3080
takes_args = ['branch?']
3082
def run(self, branch=u'.', revision=None, long=False, strict=False):
3083
from bzrlib.testament import Testament, StrictTestament
3085
testament_class = StrictTestament
3087
testament_class = Testament
3088
b = WorkingTree.open_containing(branch)[0].branch
3091
if revision is None:
3092
rev_id = b.last_revision()
3094
rev_id = revision[0].in_history(b).rev_id
3095
t = testament_class.from_revision(b.repository, rev_id)
3097
sys.stdout.writelines(t.as_text_lines())
3099
sys.stdout.write(t.as_short_text())
3104
class cmd_annotate(Command):
3105
"""Show the origin of each line in a file.
3107
This prints out the given file with an annotation on the left side
3108
indicating which revision, author and date introduced the change.
3110
If the origin is the same for a run of consecutive lines, it is
3111
shown only at the top, unless the --all option is given.
3113
# TODO: annotate directories; showing when each file was last changed
3114
# TODO: if the working copy is modified, show annotations on that
3115
# with new uncommitted lines marked
3116
aliases = ['ann', 'blame', 'praise']
3117
takes_args = ['filename']
3118
takes_options = [Option('all', help='show annotations on all lines'),
3119
Option('long', help='show date in annotations'),
3125
def run(self, filename, all=False, long=False, revision=None,
3127
from bzrlib.annotate import annotate_file
3128
tree, relpath = WorkingTree.open_containing(filename)
3129
branch = tree.branch
3132
if revision is None:
3133
revision_id = branch.last_revision()
3134
elif len(revision) != 1:
3135
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3137
revision_id = revision[0].in_history(branch).rev_id
3138
file_id = tree.path2id(relpath)
3139
tree = branch.repository.revision_tree(revision_id)
3140
file_version = tree.inventory[file_id].revision
3141
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
3147
class cmd_re_sign(Command):
3148
"""Create a digital signature for an existing revision."""
3149
# TODO be able to replace existing ones.
3151
hidden = True # is this right ?
3152
takes_args = ['revision_id*']
3153
takes_options = ['revision']
3155
def run(self, revision_id_list=None, revision=None):
3156
import bzrlib.gpg as gpg
3157
if revision_id_list is not None and revision is not None:
3158
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3159
if revision_id_list is None and revision is None:
3160
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3161
b = WorkingTree.open_containing(u'.')[0].branch
3162
gpg_strategy = gpg.GPGStrategy(b.get_config())
3163
if revision_id_list is not None:
3164
for revision_id in revision_id_list:
3165
b.repository.sign_revision(revision_id, gpg_strategy)
3166
elif revision is not None:
3167
if len(revision) == 1:
3168
revno, rev_id = revision[0].in_history(b)
3169
b.repository.sign_revision(rev_id, gpg_strategy)
3170
elif len(revision) == 2:
3171
# are they both on rh- if so we can walk between them
3172
# might be nice to have a range helper for arbitrary
3173
# revision paths. hmm.
3174
from_revno, from_revid = revision[0].in_history(b)
3175
to_revno, to_revid = revision[1].in_history(b)
3176
if to_revid is None:
3177
to_revno = b.revno()
3178
if from_revno is None or to_revno is None:
3179
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3180
for revno in range(from_revno, to_revno + 1):
3181
b.repository.sign_revision(b.get_rev_id(revno),
3184
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3187
class cmd_bind(Command):
3188
"""Convert the current branch into a checkout of the supplied branch.
3190
Once converted into a checkout, commits must succeed on the master branch
3191
before they will be applied to the local branch.
3194
_see_also = ['checkouts', 'unbind']
3195
takes_args = ['location?']
3198
def run(self, location=None):
3199
b, relpath = Branch.open_containing(u'.')
3200
if location is None:
3202
location = b.get_old_bound_location()
3203
except errors.UpgradeRequired:
3204
raise errors.BzrCommandError('No location supplied. '
3205
'This format does not remember old locations.')
3207
if location is None:
3208
raise errors.BzrCommandError('No location supplied and no '
3209
'previous location known')
3210
b_other = Branch.open(location)
3213
except errors.DivergedBranches:
3214
raise errors.BzrCommandError('These branches have diverged.'
3215
' Try merging, and then bind again.')
3218
class cmd_unbind(Command):
3219
"""Convert the current checkout into a regular branch.
3221
After unbinding, the local branch is considered independent and subsequent
3222
commits will be local only.
3225
_see_also = ['checkouts', 'bind']
3230
b, relpath = Branch.open_containing(u'.')
3232
raise errors.BzrCommandError('Local branch is not bound')
3235
class cmd_uncommit(Command):
3236
"""Remove the last committed revision.
3238
--verbose will print out what is being removed.
3239
--dry-run will go through all the motions, but not actually
3242
In the future, uncommit will create a revision bundle, which can then
3246
# TODO: jam 20060108 Add an option to allow uncommit to remove
3247
# unreferenced information in 'branch-as-repository' branches.
3248
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3249
# information in shared branches as well.
3250
_see_also = ['commit']
3251
takes_options = ['verbose', 'revision',
3252
Option('dry-run', help='Don\'t actually make changes'),
3253
Option('force', help='Say yes to all questions.')]
3254
takes_args = ['location?']
3257
def run(self, location=None,
3258
dry_run=False, verbose=False,
3259
revision=None, force=False):
3260
from bzrlib.log import log_formatter, show_log
3262
from bzrlib.uncommit import uncommit
3264
if location is None:
3266
control, relpath = bzrdir.BzrDir.open_containing(location)
3268
tree = control.open_workingtree()
3270
except (errors.NoWorkingTree, errors.NotLocalUrl):
3272
b = control.open_branch()
3275
if revision is None:
3278
# 'bzr uncommit -r 10' actually means uncommit
3279
# so that the final tree is at revno 10.
3280
# but bzrlib.uncommit.uncommit() actually uncommits
3281
# the revisions that are supplied.
3282
# So we need to offset it by one
3283
revno = revision[0].in_history(b).revno+1
3285
if revno <= b.revno():
3286
rev_id = b.get_rev_id(revno)
3288
self.outf.write('No revisions to uncommit.\n')
3291
lf = log_formatter('short',
3293
show_timezone='original')
3298
direction='forward',
3299
start_revision=revno,
3300
end_revision=b.revno())
3303
print 'Dry-run, pretending to remove the above revisions.'
3305
val = raw_input('Press <enter> to continue')
3307
print 'The above revision(s) will be removed.'
3309
val = raw_input('Are you sure [y/N]? ')
3310
if val.lower() not in ('y', 'yes'):
3314
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3318
class cmd_break_lock(Command):
3319
"""Break a dead lock on a repository, branch or working directory.
3321
CAUTION: Locks should only be broken when you are sure that the process
3322
holding the lock has been stopped.
3324
You can get information on what locks are open via the 'bzr info' command.
3329
takes_args = ['location?']
3331
def run(self, location=None, show=False):
3332
if location is None:
3334
control, relpath = bzrdir.BzrDir.open_containing(location)
3336
control.break_lock()
3337
except NotImplementedError:
3341
class cmd_wait_until_signalled(Command):
3342
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3344
This just prints a line to signal when it is ready, then blocks on stdin.
3350
sys.stdout.write("running\n")
3352
sys.stdin.readline()
3355
class cmd_serve(Command):
3356
"""Run the bzr server."""
3358
aliases = ['server']
3362
help='serve on stdin/out for use from inetd or sshd'),
3364
help='listen for connections on nominated port of the form '
3365
'[hostname:]portnumber. Passing 0 as the port number will '
3366
'result in a dynamically allocated port. Default port is '
3370
help='serve contents of directory',
3372
Option('allow-writes',
3373
help='By default the server is a readonly server. Supplying '
3374
'--allow-writes enables write access to the contents of '
3375
'the served directory and below. '
3379
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3380
from bzrlib.smart import medium, server
3381
from bzrlib.transport import get_transport
3382
from bzrlib.transport.chroot import ChrootServer
3383
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3384
if directory is None:
3385
directory = os.getcwd()
3386
url = urlutils.local_path_to_url(directory)
3387
if not allow_writes:
3388
url = 'readonly+' + url
3389
chroot_server = ChrootServer(get_transport(url))
3390
chroot_server.setUp()
3391
t = get_transport(chroot_server.get_url())
3393
smart_server = medium.SmartServerPipeStreamMedium(
3394
sys.stdin, sys.stdout, t)
3396
host = BZR_DEFAULT_INTERFACE
3398
port = BZR_DEFAULT_PORT
3401
host, port = port.split(':')
3403
smart_server = server.SmartTCPServer(t, host=host, port=port)
3404
print 'listening on port: ', smart_server.port
3406
# for the duration of this server, no UI output is permitted.
3407
# note that this may cause problems with blackbox tests. This should
3408
# be changed with care though, as we dont want to use bandwidth sending
3409
# progress over stderr to smart server clients!
3410
old_factory = ui.ui_factory
3412
ui.ui_factory = ui.SilentUIFactory()
3413
smart_server.serve()
3415
ui.ui_factory = old_factory
3418
class cmd_join(Command):
3419
"""Combine a subtree into its containing tree.
3421
This command is for experimental use only. It requires the target tree
3422
to be in dirstate-with-subtree format, which cannot be converted into
3425
The TREE argument should be an independent tree, inside another tree, but
3426
not part of it. (Such trees can be produced by "bzr split", but also by
3427
running "bzr branch" with the target inside a tree.)
3429
The result is a combined tree, with the subtree no longer an independant
3430
part. This is marked as a merge of the subtree into the containing tree,
3431
and all history is preserved.
3433
If --reference is specified, the subtree retains its independence. It can
3434
be branched by itself, and can be part of multiple projects at the same
3435
time. But operations performed in the containing tree, such as commit
3436
and merge, will recurse into the subtree.
3439
_see_also = ['split']
3440
takes_args = ['tree']
3441
takes_options = [Option('reference', 'join by reference')]
3444
def run(self, tree, reference=False):
3445
sub_tree = WorkingTree.open(tree)
3446
parent_dir = osutils.dirname(sub_tree.basedir)
3447
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3448
repo = containing_tree.branch.repository
3449
if not repo.supports_rich_root():
3450
raise errors.BzrCommandError(
3451
"Can't join trees because %s doesn't support rich root data.\n"
3452
"You can use bzr upgrade on the repository."
3456
containing_tree.add_reference(sub_tree)
3457
except errors.BadReferenceTarget, e:
3458
# XXX: Would be better to just raise a nicely printable
3459
# exception from the real origin. Also below. mbp 20070306
3460
raise errors.BzrCommandError("Cannot join %s. %s" %
3464
containing_tree.subsume(sub_tree)
3465
except errors.BadSubsumeSource, e:
3466
raise errors.BzrCommandError("Cannot join %s. %s" %
3470
class cmd_split(Command):
3471
"""Split a tree into two trees.
3473
This command is for experimental use only. It requires the target tree
3474
to be in dirstate-with-subtree format, which cannot be converted into
3477
The TREE argument should be a subdirectory of a working tree. That
3478
subdirectory will be converted into an independent tree, with its own
3479
branch. Commits in the top-level tree will not apply to the new subtree.
3480
If you want that behavior, do "bzr join --reference TREE".
3483
_see_also = ['join']
3484
takes_args = ['tree']
3488
def run(self, tree):
3489
containing_tree, subdir = WorkingTree.open_containing(tree)
3490
sub_id = containing_tree.path2id(subdir)
3492
raise errors.NotVersionedError(subdir)
3494
containing_tree.extract(sub_id)
3495
except errors.RootNotRich:
3496
raise errors.UpgradeRequired(containing_tree.branch.base)
3500
class cmd_merge_directive(Command):
3501
"""Generate a merge directive for auto-merge tools.
3503
A directive requests a merge to be performed, and also provides all the
3504
information necessary to do so. This means it must either include a
3505
revision bundle, or the location of a branch containing the desired
3508
A submit branch (the location to merge into) must be supplied the first
3509
time the command is issued. After it has been supplied once, it will
3510
be remembered as the default.
3512
A public branch is optional if a revision bundle is supplied, but required
3513
if --diff or --plain is specified. It will be remembered as the default
3514
after the first use.
3517
takes_args = ['submit_branch?', 'public_branch?']
3520
RegistryOption.from_kwargs('patch-type',
3521
'The type of patch to include in the directive',
3522
title='Patch type', value_switches=True, enum_switch=False,
3523
bundle='Bazaar revision bundle (default)',
3524
diff='Normal unified diff',
3525
plain='No patch, just directive'),
3526
Option('sign', help='GPG-sign the directive'), 'revision',
3527
Option('mail-to', type=str,
3528
help='Instead of printing the directive, email to this address'),
3529
Option('message', type=str, short_name='m',
3530
help='Message to use when committing this merge')
3533
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3534
sign=False, revision=None, mail_to=None, message=None):
3535
if patch_type == 'plain':
3537
branch = Branch.open('.')
3538
stored_submit_branch = branch.get_submit_branch()
3539
if submit_branch is None:
3540
submit_branch = stored_submit_branch
3542
if stored_submit_branch is None:
3543
branch.set_submit_branch(submit_branch)
3544
if submit_branch is None:
3545
submit_branch = branch.get_parent()
3546
if submit_branch is None:
3547
raise errors.BzrCommandError('No submit branch specified or known')
3549
stored_public_branch = branch.get_public_branch()
3550
if public_branch is None:
3551
public_branch = stored_public_branch
3552
elif stored_public_branch is None:
3553
branch.set_public_branch(public_branch)
3554
if patch_type != "bundle" and public_branch is None:
3555
raise errors.BzrCommandError('No public branch specified or'
3557
if revision is not None:
3558
if len(revision) != 1:
3559
raise errors.BzrCommandError('bzr merge-directive takes '
3560
'exactly one revision identifier')
3562
revision_id = revision[0].in_history(branch).rev_id
3564
revision_id = branch.last_revision()
3565
directive = merge_directive.MergeDirective.from_objects(
3566
branch.repository, revision_id, time.time(),
3567
osutils.local_time_offset(), submit_branch,
3568
public_branch=public_branch, patch_type=patch_type,
3572
self.outf.write(directive.to_signed(branch))
3574
self.outf.writelines(directive.to_lines())
3576
message = directive.to_email(mail_to, branch, sign)
3578
server = branch.get_config().get_user_option('smtp_server')
3580
server = 'localhost'
3582
s.sendmail(message['From'], message['To'], message.as_string())
3585
class cmd_tag(Command):
3586
"""Create a tag naming a revision.
3588
Tags give human-meaningful names to revisions. Commands that take a -r
3589
(--revision) option can be given -rtag:X, where X is any previously
3592
Tags are stored in the branch. Tags are copied from one branch to another
3593
along when you branch, push, pull or merge.
3595
It is an error to give a tag name that already exists unless you pass
3596
--force, in which case the tag is moved to point to the new revision.
3599
_see_also = ['commit', 'tags']
3600
takes_args = ['tag_name']
3603
help='Delete this tag rather than placing it.',
3606
help='Branch in which to place the tag.',
3611
help='Replace existing tags',
3616
def run(self, tag_name,
3622
branch, relpath = Branch.open_containing(directory)
3626
branch.tags.delete_tag(tag_name)
3627
self.outf.write('Deleted tag %s.\n' % tag_name)
3630
if len(revision) != 1:
3631
raise errors.BzrCommandError(
3632
"Tags can only be placed on a single revision, "
3634
revision_id = revision[0].in_history(branch).rev_id
3636
revision_id = branch.last_revision()
3637
if (not force) and branch.tags.has_tag(tag_name):
3638
raise errors.TagAlreadyExists(tag_name)
3639
branch.tags.set_tag(tag_name, revision_id)
3640
self.outf.write('Created tag %s.\n' % tag_name)
3645
class cmd_tags(Command):
3648
This tag shows a table of tag names and the revisions they reference.
3654
help='Branch whose tags should be displayed',
3664
branch, relpath = Branch.open_containing(directory)
3665
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3666
self.outf.write('%-20s %s\n' % (tag_name, target))
3669
# command-line interpretation helper for merge-related commands
3670
def _merge_helper(other_revision, base_revision,
3671
check_clean=True, ignore_zero=False,
3672
this_dir=None, backup_files=False,
3674
file_list=None, show_base=False, reprocess=False,
3677
change_reporter=None,
3679
"""Merge changes into a tree.
3682
list(path, revno) Base for three-way merge.
3683
If [None, None] then a base will be automatically determined.
3685
list(path, revno) Other revision for three-way merge.
3687
Directory to merge changes into; '.' by default.
3689
If true, this_dir must have no uncommitted changes before the
3691
ignore_zero - If true, suppress the "zero conflicts" message when
3692
there are no conflicts; should be set when doing something we expect
3693
to complete perfectly.
3694
file_list - If supplied, merge only changes to selected files.
3696
All available ancestors of other_revision and base_revision are
3697
automatically pulled into the branch.
3699
The revno may be -1 to indicate the last revision on the branch, which is
3702
This function is intended for use from the command line; programmatic
3703
clients might prefer to call merge.merge_inner(), which has less magic
3706
# Loading it late, so that we don't always have to import bzrlib.merge
3707
if merge_type is None:
3708
merge_type = _mod_merge.Merge3Merger
3709
if this_dir is None:
3711
this_tree = WorkingTree.open_containing(this_dir)[0]
3712
if show_base and not merge_type is _mod_merge.Merge3Merger:
3713
raise errors.BzrCommandError("Show-base is not supported for this merge"
3714
" type. %s" % merge_type)
3715
if reprocess and not merge_type.supports_reprocess:
3716
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3717
" type %s." % merge_type)
3718
if reprocess and show_base:
3719
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3720
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3721
# only want to take out a lock_tree_write() if we don't have to pull
3722
# any ancestry. But merge might fetch ancestry in the middle, in
3723
# which case we would need a lock_write().
3724
# Because we cannot upgrade locks, for now we live with the fact that
3725
# the tree will be locked multiple times during a merge. (Maybe
3726
# read-only some of the time, but it means things will get read
3729
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3730
pb=pb, change_reporter=change_reporter)
3731
merger.pp = ProgressPhase("Merge phase", 5, pb)
3732
merger.pp.next_phase()
3733
merger.check_basis(check_clean)
3734
if other_rev_id is not None:
3735
merger.set_other_revision(other_rev_id, this_tree.branch)
3737
merger.set_other(other_revision)
3738
merger.pp.next_phase()
3739
merger.set_base(base_revision)
3740
if merger.base_rev_id == merger.other_rev_id:
3741
note('Nothing to do.')
3743
if file_list is None:
3744
if pull and merger.base_rev_id == merger.this_rev_id:
3745
# FIXME: deduplicate with pull
3746
result = merger.this_tree.pull(merger.this_branch,
3747
False, merger.other_rev_id)
3748
if result.old_revid == result.new_revid:
3749
note('No revisions to pull.')
3751
note('Now on revision %d.' % result.new_revno)
3753
merger.backup_files = backup_files
3754
merger.merge_type = merge_type
3755
merger.set_interesting_files(file_list)
3756
merger.show_base = show_base
3757
merger.reprocess = reprocess
3758
conflicts = merger.do_merge()
3759
if file_list is None:
3760
merger.set_pending()
3767
merge = _merge_helper
3770
# these get imported and then picked up by the scan for cmd_*
3771
# TODO: Some more consistent way to split command definitions across files;
3772
# we do need to load at least some information about them to know of
3773
# aliases. ideally we would avoid loading the implementation until the
3774
# details were needed.
3775
from bzrlib.cmd_version_info import cmd_version_info
3776
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3777
from bzrlib.bundle.commands import cmd_bundle_revisions
3778
from bzrlib.sign_my_commits import cmd_sign_my_commits
3779
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3780
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
