1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
20
from StringIO import StringIO
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
54
from bzrlib.branch import Branch
55
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revisionspec import RevisionSpec
58
from bzrlib.smtp_connection import SMTPConnection
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import ListOption, Option, RegistryOption
64
from bzrlib.progress import DummyProgress, ProgressPhase
65
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
68
def tree_files(file_list, default_branch=u'.'):
70
return internal_tree_files(file_list, default_branch)
71
except errors.FileInWrongBranch, e:
72
raise errors.BzrCommandError("%s is not in the same branch as %s" %
73
(e.path, file_list[0]))
76
# XXX: Bad function name; should possibly also be a class method of
77
# WorkingTree rather than a function.
78
def internal_tree_files(file_list, default_branch=u'.'):
79
"""Convert command-line paths to a WorkingTree and relative paths.
81
This is typically used for command-line processors that take one or
82
more filenames, and infer the workingtree that contains them.
84
The filenames given are not required to exist.
86
:param file_list: Filenames to convert.
88
:param default_branch: Fallback tree path to use if file_list is empty or
91
:return: workingtree, [relative_paths]
93
if file_list is None or len(file_list) == 0:
94
return WorkingTree.open_containing(default_branch)[0], file_list
95
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
97
for filename in file_list:
99
new_list.append(tree.relpath(osutils.dereference_path(filename)))
100
except errors.PathNotChild:
101
raise errors.FileInWrongBranch(tree.branch, filename)
102
return tree, new_list
105
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
106
def get_format_type(typestring):
107
"""Parse and return a format specifier."""
108
# Have to use BzrDirMetaFormat1 directly, so that
109
# RepositoryFormat.set_default_format works
110
if typestring == "default":
111
return bzrdir.BzrDirMetaFormat1()
113
return bzrdir.format_registry.make_bzrdir(typestring)
115
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
116
raise errors.BzrCommandError(msg)
119
# TODO: Make sure no commands unconditionally use the working directory as a
120
# branch. If a filename argument is used, the first of them should be used to
121
# specify the branch. (Perhaps this can be factored out into some kind of
122
# Argument class, representing a file in a branch, where the first occurrence
125
class cmd_status(Command):
126
"""Display status summary.
128
This reports on versioned and unknown files, reporting them
129
grouped by state. Possible states are:
132
Versioned in the working copy but not in the previous revision.
135
Versioned in the previous revision but removed or deleted
139
Path of this file changed from the previous revision;
140
the text may also have changed. This includes files whose
141
parent directory was renamed.
144
Text has changed since the previous revision.
147
File kind has been changed (e.g. from file to directory).
150
Not versioned and not matching an ignore pattern.
152
To see ignored files use 'bzr ignored'. For details on the
153
changes to file texts, use 'bzr diff'.
155
--short gives a status flags for each item, similar to the SVN's status
158
If no arguments are specified, the status of the entire working
159
directory is shown. Otherwise, only the status of the specified
160
files or directories is reported. If a directory is given, status
161
is reported for everything inside that directory.
163
If a revision argument is given, the status is calculated against
164
that revision, or between two revisions if two are provided.
167
# TODO: --no-recurse, --recurse options
169
takes_args = ['file*']
170
takes_options = ['show-ids', 'revision',
171
Option('short', help='Give short SVN-style status lines'),
172
Option('versioned', help='Only show versioned files')]
173
aliases = ['st', 'stat']
175
encoding_type = 'replace'
176
_see_also = ['diff', 'revert', 'status-flags']
179
def run(self, show_ids=False, file_list=None, revision=None, short=False,
181
from bzrlib.status import show_tree_status
183
tree, file_list = tree_files(file_list)
185
show_tree_status(tree, show_ids=show_ids,
186
specific_files=file_list, revision=revision,
187
to_file=self.outf, short=short, versioned=versioned)
190
class cmd_cat_revision(Command):
191
"""Write out metadata for a revision.
193
The revision to print can either be specified by a specific
194
revision identifier, or you can use --revision.
198
takes_args = ['revision_id?']
199
takes_options = ['revision']
200
# cat-revision is more for frontends so should be exact
204
def run(self, revision_id=None, revision=None):
206
revision_id = osutils.safe_revision_id(revision_id, warn=False)
207
if revision_id is not None and revision is not None:
208
raise errors.BzrCommandError('You can only supply one of'
209
' revision_id or --revision')
210
if revision_id is None and revision is None:
211
raise errors.BzrCommandError('You must supply either'
212
' --revision or a revision_id')
213
b = WorkingTree.open_containing(u'.')[0].branch
215
# TODO: jam 20060112 should cat-revision always output utf-8?
216
if revision_id is not None:
217
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
218
elif revision is not None:
221
raise errors.BzrCommandError('You cannot specify a NULL'
223
revno, rev_id = rev.in_history(b)
224
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
227
class cmd_remove_tree(Command):
228
"""Remove the working tree from a given branch/checkout.
230
Since a lightweight checkout is little more than a working tree
231
this will refuse to run against one.
233
To re-create the working tree, use "bzr checkout".
235
_see_also = ['checkout', 'working-trees']
237
takes_args = ['location?']
239
def run(self, location='.'):
240
d = bzrdir.BzrDir.open(location)
243
working = d.open_workingtree()
244
except errors.NoWorkingTree:
245
raise errors.BzrCommandError("No working tree to remove")
246
except errors.NotLocalUrl:
247
raise errors.BzrCommandError("You cannot remove the working tree of a "
250
working_path = working.bzrdir.root_transport.base
251
branch_path = working.branch.bzrdir.root_transport.base
252
if working_path != branch_path:
253
raise errors.BzrCommandError("You cannot remove the working tree from "
254
"a lightweight checkout")
256
d.destroy_workingtree()
259
class cmd_revno(Command):
260
"""Show current revision number.
262
This is equal to the number of revisions on this branch.
266
takes_args = ['location?']
269
def run(self, location=u'.'):
270
self.outf.write(str(Branch.open_containing(location)[0].revno()))
271
self.outf.write('\n')
274
class cmd_revision_info(Command):
275
"""Show revision number and revision id for a given revision identifier.
278
takes_args = ['revision_info*']
279
takes_options = ['revision']
282
def run(self, revision=None, revision_info_list=[]):
285
if revision is not None:
286
revs.extend(revision)
287
if revision_info_list is not None:
288
for rev in revision_info_list:
289
revs.append(RevisionSpec.from_string(rev))
291
b = Branch.open_containing(u'.')[0]
294
revs.append(RevisionSpec.from_string('-1'))
297
revinfo = rev.in_history(b)
298
if revinfo.revno is None:
299
dotted_map = b.get_revision_id_to_revno_map()
300
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
301
print '%s %s' % (revno, revinfo.rev_id)
303
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
306
class cmd_add(Command):
307
"""Add specified files or directories.
309
In non-recursive mode, all the named items are added, regardless
310
of whether they were previously ignored. A warning is given if
311
any of the named files are already versioned.
313
In recursive mode (the default), files are treated the same way
314
but the behaviour for directories is different. Directories that
315
are already versioned do not give a warning. All directories,
316
whether already versioned or not, are searched for files or
317
subdirectories that are neither versioned or ignored, and these
318
are added. This search proceeds recursively into versioned
319
directories. If no names are given '.' is assumed.
321
Therefore simply saying 'bzr add' will version all files that
322
are currently unknown.
324
Adding a file whose parent directory is not versioned will
325
implicitly add the parent, and so on up to the root. This means
326
you should never need to explicitly add a directory, they'll just
327
get added when you add a file in the directory.
329
--dry-run will show which files would be added, but not actually
332
--file-ids-from will try to use the file ids from the supplied path.
333
It looks up ids trying to find a matching parent directory with the
334
same filename, and then by pure path. This option is rarely needed
335
but can be useful when adding the same logical file into two
336
branches that will be merged later (without showing the two different
337
adds as a conflict). It is also useful when merging another project
338
into a subdirectory of this one.
340
takes_args = ['file*']
341
takes_options = ['no-recurse', 'dry-run', 'verbose',
342
Option('file-ids-from', type=unicode,
343
help='Lookup file ids from here')]
344
encoding_type = 'replace'
345
_see_also = ['remove']
347
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
352
if file_ids_from is not None:
354
base_tree, base_path = WorkingTree.open_containing(
356
except errors.NoWorkingTree:
357
base_branch, base_path = Branch.open_containing(
359
base_tree = base_branch.basis_tree()
361
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
362
to_file=self.outf, should_print=(not is_quiet()))
364
action = bzrlib.add.AddAction(to_file=self.outf,
365
should_print=(not is_quiet()))
368
base_tree.lock_read()
370
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
371
action=action, save=not dry_run)
373
if base_tree is not None:
377
for glob in sorted(ignored.keys()):
378
for path in ignored[glob]:
379
self.outf.write("ignored %s matching \"%s\"\n"
383
for glob, paths in ignored.items():
384
match_len += len(paths)
385
self.outf.write("ignored %d file(s).\n" % match_len)
386
self.outf.write("If you wish to add some of these files,"
387
" please add them by name.\n")
390
class cmd_mkdir(Command):
391
"""Create a new versioned directory.
393
This is equivalent to creating the directory and then adding it.
396
takes_args = ['dir+']
397
encoding_type = 'replace'
399
def run(self, dir_list):
402
wt, dd = WorkingTree.open_containing(d)
404
self.outf.write('added %s\n' % d)
407
class cmd_relpath(Command):
408
"""Show path of a file relative to root"""
410
takes_args = ['filename']
414
def run(self, filename):
415
# TODO: jam 20050106 Can relpath return a munged path if
416
# sys.stdout encoding cannot represent it?
417
tree, relpath = WorkingTree.open_containing(filename)
418
self.outf.write(relpath)
419
self.outf.write('\n')
422
class cmd_inventory(Command):
423
"""Show inventory of the current working copy or a revision.
425
It is possible to limit the output to a particular entry
426
type using the --kind option. For example: --kind file.
428
It is also possible to restrict the list of files to a specific
429
set. For example: bzr inventory --show-ids this/file
434
takes_options = ['revision', 'show-ids', 'kind']
435
takes_args = ['file*']
438
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
439
if kind and kind not in ['file', 'directory', 'symlink']:
440
raise errors.BzrCommandError('invalid kind specified')
442
work_tree, file_list = tree_files(file_list)
443
work_tree.lock_read()
445
if revision is not None:
446
if len(revision) > 1:
447
raise errors.BzrCommandError(
448
'bzr inventory --revision takes exactly one revision'
450
revision_id = revision[0].in_history(work_tree.branch).rev_id
451
tree = work_tree.branch.repository.revision_tree(revision_id)
453
extra_trees = [work_tree]
459
if file_list is not None:
460
file_ids = tree.paths2ids(file_list, trees=extra_trees,
461
require_versioned=True)
462
# find_ids_across_trees may include some paths that don't
464
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
465
for file_id in file_ids if file_id in tree)
467
entries = tree.inventory.entries()
470
if tree is not work_tree:
473
for path, entry in entries:
474
if kind and kind != entry.kind:
477
self.outf.write('%-50s %s\n' % (path, entry.file_id))
479
self.outf.write(path)
480
self.outf.write('\n')
483
class cmd_mv(Command):
484
"""Move or rename a file.
487
bzr mv OLDNAME NEWNAME
488
bzr mv SOURCE... DESTINATION
490
If the last argument is a versioned directory, all the other names
491
are moved into it. Otherwise, there must be exactly two arguments
492
and the file is changed to a new name.
494
If OLDNAME does not exist on the filesystem but is versioned and
495
NEWNAME does exist on the filesystem but is not versioned, mv
496
assumes that the file has been manually moved and only updates
497
its internal inventory to reflect that change.
498
The same is valid when moving many SOURCE files to a DESTINATION.
500
Files cannot be moved between branches.
503
takes_args = ['names*']
504
takes_options = [Option("after", help="move only the bzr identifier"
505
" of the file (file has already been moved). Use this flag if"
506
" bzr is not able to detect this itself.")]
507
aliases = ['move', 'rename']
508
encoding_type = 'replace'
510
def run(self, names_list, after=False):
511
if names_list is None:
514
if len(names_list) < 2:
515
raise errors.BzrCommandError("missing file argument")
516
tree, rel_names = tree_files(names_list)
518
if os.path.isdir(names_list[-1]):
519
# move into existing directory
520
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
521
self.outf.write("%s => %s\n" % pair)
523
if len(names_list) != 2:
524
raise errors.BzrCommandError('to mv multiple files the'
525
' destination must be a versioned'
527
tree.rename_one(rel_names[0], rel_names[1], after=after)
528
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
531
class cmd_pull(Command):
532
"""Turn this branch into a mirror of another branch.
534
This command only works on branches that have not diverged. Branches are
535
considered diverged if the destination branch's most recent commit is one
536
that has not been merged (directly or indirectly) into the parent.
538
If branches have diverged, you can use 'bzr merge' to integrate the changes
539
from one into the other. Once one branch has merged, the other should
540
be able to pull it again.
542
If you want to forget your local changes and just update your branch to
543
match the remote one, use pull --overwrite.
545
If there is no default location set, the first pull will set it. After
546
that, you can omit the location to use the default. To change the
547
default, use --remember. The value will only be saved if the remote
548
location can be accessed.
551
_see_also = ['push', 'update', 'status-flags']
552
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
554
help='branch to pull into, '
555
'rather than the one containing the working directory',
560
takes_args = ['location?']
561
encoding_type = 'replace'
563
def run(self, location=None, remember=False, overwrite=False,
564
revision=None, verbose=False,
566
from bzrlib.tag import _merge_tags_if_possible
567
# FIXME: too much stuff is in the command class
570
if directory is None:
573
tree_to = WorkingTree.open_containing(directory)[0]
574
branch_to = tree_to.branch
575
except errors.NoWorkingTree:
577
branch_to = Branch.open_containing(directory)[0]
580
if location is not None:
582
mergeable = bundle.read_mergeable_from_url(
584
except errors.NotABundle:
585
pass # Continue on considering this url a Branch
587
stored_loc = branch_to.get_parent()
589
if stored_loc is None:
590
raise errors.BzrCommandError("No pull location known or"
593
display_url = urlutils.unescape_for_display(stored_loc,
595
self.outf.write("Using saved location: %s\n" % display_url)
596
location = stored_loc
598
if mergeable is not None:
599
if revision is not None:
600
raise errors.BzrCommandError(
601
'Cannot use -r with merge directives or bundles')
602
revision_id = mergeable.install_revisions(branch_to.repository)
603
branch_from = branch_to
605
branch_from = Branch.open(location)
607
if branch_to.get_parent() is None or remember:
608
branch_to.set_parent(branch_from.base)
610
if revision is not None:
611
if len(revision) == 1:
612
revision_id = revision[0].in_history(branch_from).rev_id
614
raise errors.BzrCommandError(
615
'bzr pull --revision takes one value.')
617
old_rh = branch_to.revision_history()
618
if tree_to is not None:
619
result = tree_to.pull(branch_from, overwrite, revision_id,
620
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
622
result = branch_to.pull(branch_from, overwrite, revision_id)
624
result.report(self.outf)
626
from bzrlib.log import show_changed_revisions
627
new_rh = branch_to.revision_history()
628
show_changed_revisions(branch_to, old_rh, new_rh,
632
class cmd_push(Command):
633
"""Update a mirror of this branch.
635
The target branch will not have its working tree populated because this
636
is both expensive, and is not supported on remote file systems.
638
Some smart servers or protocols *may* put the working tree in place in
641
This command only works on branches that have not diverged. Branches are
642
considered diverged if the destination branch's most recent commit is one
643
that has not been merged (directly or indirectly) by the source branch.
645
If branches have diverged, you can use 'bzr push --overwrite' to replace
646
the other branch completely, discarding its unmerged changes.
648
If you want to ensure you have the different changes in the other branch,
649
do a merge (see bzr help merge) from the other branch, and commit that.
650
After that you will be able to do a push without '--overwrite'.
652
If there is no default push location set, the first push will set it.
653
After that, you can omit the location to use the default. To change the
654
default, use --remember. The value will only be saved if the remote
655
location can be accessed.
658
_see_also = ['pull', 'update', 'working-trees']
659
takes_options = ['remember', 'overwrite', 'verbose',
660
Option('create-prefix',
661
help='Create the path leading up to the branch '
662
'if it does not already exist'),
664
help='branch to push from, '
665
'rather than the one containing the working directory',
669
Option('use-existing-dir',
670
help='By default push will fail if the target'
671
' directory exists, but does not already'
672
' have a control directory. This flag will'
673
' allow push to proceed.'),
675
takes_args = ['location?']
676
encoding_type = 'replace'
678
def run(self, location=None, remember=False, overwrite=False,
679
create_prefix=False, verbose=False,
680
use_existing_dir=False,
682
# FIXME: Way too big! Put this into a function called from the
684
if directory is None:
686
br_from = Branch.open_containing(directory)[0]
687
stored_loc = br_from.get_push_location()
689
if stored_loc is None:
690
raise errors.BzrCommandError("No push location known or specified.")
692
display_url = urlutils.unescape_for_display(stored_loc,
694
self.outf.write("Using saved location: %s\n" % display_url)
695
location = stored_loc
697
to_transport = transport.get_transport(location)
699
br_to = repository_to = dir_to = None
701
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
702
except errors.NotBranchError:
703
pass # Didn't find anything
705
# If we can open a branch, use its direct repository, otherwise see
706
# if there is a repository without a branch.
708
br_to = dir_to.open_branch()
709
except errors.NotBranchError:
710
# Didn't find a branch, can we find a repository?
712
repository_to = dir_to.find_repository()
713
except errors.NoRepositoryPresent:
716
# Found a branch, so we must have found a repository
717
repository_to = br_to.repository
721
# The destination doesn't exist; create it.
722
# XXX: Refactor the create_prefix/no_create_prefix code into a
723
# common helper function
725
to_transport.mkdir('.')
726
except errors.FileExists:
727
if not use_existing_dir:
728
raise errors.BzrCommandError("Target directory %s"
729
" already exists, but does not have a valid .bzr"
730
" directory. Supply --use-existing-dir to push"
731
" there anyway." % location)
732
except errors.NoSuchFile:
733
if not create_prefix:
734
raise errors.BzrCommandError("Parent directory of %s"
736
"\nYou may supply --create-prefix to create all"
737
" leading parent directories."
740
_create_prefix(to_transport)
742
# Now the target directory exists, but doesn't have a .bzr
743
# directory. So we need to create it, along with any work to create
744
# all of the dependent branches, etc.
745
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
746
revision_id=br_from.last_revision())
747
br_to = dir_to.open_branch()
748
# TODO: Some more useful message about what was copied
749
note('Created new branch.')
750
# We successfully created the target, remember it
751
if br_from.get_push_location() is None or remember:
752
br_from.set_push_location(br_to.base)
753
elif repository_to is None:
754
# we have a bzrdir but no branch or repository
755
# XXX: Figure out what to do other than complain.
756
raise errors.BzrCommandError("At %s you have a valid .bzr control"
757
" directory, but not a branch or repository. This is an"
758
" unsupported configuration. Please move the target directory"
759
" out of the way and try again."
762
# We have a repository but no branch, copy the revisions, and then
764
last_revision_id = br_from.last_revision()
765
repository_to.fetch(br_from.repository,
766
revision_id=last_revision_id)
767
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
768
note('Created new branch.')
769
if br_from.get_push_location() is None or remember:
770
br_from.set_push_location(br_to.base)
771
else: # We have a valid to branch
772
# We were able to connect to the remote location, so remember it
773
# we don't need to successfully push because of possible divergence.
774
if br_from.get_push_location() is None or remember:
775
br_from.set_push_location(br_to.base)
776
old_rh = br_to.revision_history()
779
tree_to = dir_to.open_workingtree()
780
except errors.NotLocalUrl:
781
warning("This transport does not update the working "
782
"tree of: %s. See 'bzr help working-trees' for "
783
"more information." % br_to.base)
784
push_result = br_from.push(br_to, overwrite)
785
except errors.NoWorkingTree:
786
push_result = br_from.push(br_to, overwrite)
790
push_result = br_from.push(tree_to.branch, overwrite)
794
except errors.DivergedBranches:
795
raise errors.BzrCommandError('These branches have diverged.'
796
' Try using "merge" and then "push".')
797
if push_result is not None:
798
push_result.report(self.outf)
800
new_rh = br_to.revision_history()
803
from bzrlib.log import show_changed_revisions
804
show_changed_revisions(br_to, old_rh, new_rh,
807
# we probably did a clone rather than a push, so a message was
812
class cmd_branch(Command):
813
"""Create a new copy of a branch.
815
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
816
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
817
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
818
is derived from the FROM_LOCATION by stripping a leading scheme or drive
819
identifier, if any. For example, "branch lp:foo-bar" will attempt to
822
To retrieve the branch as of a particular revision, supply the --revision
823
parameter, as in "branch foo/bar -r 5".
826
_see_also = ['checkout']
827
takes_args = ['from_location', 'to_location?']
828
takes_options = ['revision']
829
aliases = ['get', 'clone']
831
def run(self, from_location, to_location=None, revision=None):
832
from bzrlib.tag import _merge_tags_if_possible
835
elif len(revision) > 1:
836
raise errors.BzrCommandError(
837
'bzr branch --revision takes exactly 1 revision value')
839
br_from = Branch.open(from_location)
842
if len(revision) == 1 and revision[0] is not None:
843
revision_id = revision[0].in_history(br_from)[1]
845
# FIXME - wt.last_revision, fallback to branch, fall back to
846
# None or perhaps NULL_REVISION to mean copy nothing
848
revision_id = br_from.last_revision()
849
if to_location is None:
850
to_location = urlutils.derive_to_location(from_location)
853
name = os.path.basename(to_location) + '\n'
855
to_transport = transport.get_transport(to_location)
857
to_transport.mkdir('.')
858
except errors.FileExists:
859
raise errors.BzrCommandError('Target directory "%s" already'
860
' exists.' % to_location)
861
except errors.NoSuchFile:
862
raise errors.BzrCommandError('Parent of "%s" does not exist.'
865
# preserve whatever source format we have.
866
dir = br_from.bzrdir.sprout(to_transport.base, revision_id)
867
branch = dir.open_branch()
868
except errors.NoSuchRevision:
869
to_transport.delete_tree('.')
870
msg = "The branch %s has no revision %s." % (from_location, revision[0])
871
raise errors.BzrCommandError(msg)
873
branch.control_files.put_utf8('branch-name', name)
874
_merge_tags_if_possible(br_from, branch)
875
note('Branched %d revision(s).' % branch.revno())
880
class cmd_checkout(Command):
881
"""Create a new checkout of an existing branch.
883
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
884
the branch found in '.'. This is useful if you have removed the working tree
885
or if it was never created - i.e. if you pushed the branch to its current
888
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
889
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
890
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
891
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
892
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
895
To retrieve the branch as of a particular revision, supply the --revision
896
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
897
out of date [so you cannot commit] but it may be useful (i.e. to examine old
901
_see_also = ['checkouts', 'branch']
902
takes_args = ['branch_location?', 'to_location?']
903
takes_options = ['revision',
904
Option('lightweight',
905
help="perform a lightweight checkout. Lightweight "
906
"checkouts depend on access to the branch for "
907
"every operation. Normal checkouts can perform "
908
"common operations like diff and status without "
909
"such access, and also support local commits."
914
def run(self, branch_location=None, to_location=None, revision=None,
918
elif len(revision) > 1:
919
raise errors.BzrCommandError(
920
'bzr checkout --revision takes exactly 1 revision value')
921
if branch_location is None:
922
branch_location = osutils.getcwd()
923
to_location = branch_location
924
source = Branch.open(branch_location)
925
if len(revision) == 1 and revision[0] is not None:
926
revision_id = revision[0].in_history(source)[1]
929
if to_location is None:
930
to_location = urlutils.derive_to_location(branch_location)
931
# if the source and to_location are the same,
932
# and there is no working tree,
933
# then reconstitute a branch
934
if (osutils.abspath(to_location) ==
935
osutils.abspath(branch_location)):
937
source.bzrdir.open_workingtree()
938
except errors.NoWorkingTree:
939
source.bzrdir.create_workingtree()
942
os.mkdir(to_location)
944
if e.errno == errno.EEXIST:
945
raise errors.BzrCommandError('Target directory "%s" already'
946
' exists.' % to_location)
947
if e.errno == errno.ENOENT:
948
raise errors.BzrCommandError('Parent of "%s" does not exist.'
952
source.create_checkout(to_location, revision_id, lightweight)
955
class cmd_renames(Command):
956
"""Show list of renamed files.
958
# TODO: Option to show renames between two historical versions.
960
# TODO: Only show renames under dir, rather than in the whole branch.
961
_see_also = ['status']
962
takes_args = ['dir?']
965
def run(self, dir=u'.'):
966
tree = WorkingTree.open_containing(dir)[0]
969
new_inv = tree.inventory
970
old_tree = tree.basis_tree()
973
old_inv = old_tree.inventory
974
renames = list(_mod_tree.find_renames(old_inv, new_inv))
976
for old_name, new_name in renames:
977
self.outf.write("%s => %s\n" % (old_name, new_name))
984
class cmd_update(Command):
985
"""Update a tree to have the latest code committed to its branch.
987
This will perform a merge into the working tree, and may generate
988
conflicts. If you have any local changes, you will still
989
need to commit them after the update for the update to be complete.
991
If you want to discard your local changes, you can just do a
992
'bzr revert' instead of 'bzr commit' after the update.
995
_see_also = ['pull', 'working-trees']
996
takes_args = ['dir?']
999
def run(self, dir='.'):
1000
tree = WorkingTree.open_containing(dir)[0]
1001
master = tree.branch.get_master_branch()
1002
if master is not None:
1005
tree.lock_tree_write()
1007
existing_pending_merges = tree.get_parent_ids()[1:]
1008
last_rev = tree.last_revision()
1009
if last_rev == tree.branch.last_revision():
1010
# may be up to date, check master too.
1011
master = tree.branch.get_master_branch()
1012
if master is None or last_rev == master.last_revision():
1013
revno = tree.branch.revision_id_to_revno(last_rev)
1014
note("Tree is up to date at revision %d." % (revno,))
1016
conflicts = tree.update()
1017
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1018
note('Updated to revision %d.' % (revno,))
1019
if tree.get_parent_ids()[1:] != existing_pending_merges:
1020
note('Your local commits will now show as pending merges with '
1021
"'bzr status', and can be committed with 'bzr commit'.")
1030
class cmd_info(Command):
1031
"""Show information about a working tree, branch or repository.
1033
This command will show all known locations and formats associated to the
1034
tree, branch or repository. Statistical information is included with
1037
Branches and working trees will also report any missing revisions.
1039
_see_also = ['revno', 'working-trees', 'repositories']
1040
takes_args = ['location?']
1041
takes_options = ['verbose']
1044
def run(self, location=None, verbose=0):
1045
from bzrlib.info import show_bzrdir_info
1046
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1050
class cmd_remove(Command):
1051
"""Remove files or directories.
1053
This makes bzr stop tracking changes to the specified files and
1054
delete them if they can easily be recovered using revert.
1056
You can specify one or more files, and/or --new. If you specify --new,
1057
only 'added' files will be removed. If you specify both, then new files
1058
in the specified directories will be removed. If the directories are
1059
also new, they will also be removed.
1061
takes_args = ['file*']
1062
takes_options = ['verbose',
1063
Option('new', help='remove newly-added files'),
1064
RegistryOption.from_kwargs('file-deletion-strategy',
1065
'The file deletion mode to be used',
1066
title='Deletion Strategy', value_switches=True, enum_switch=False,
1067
safe='Only delete files if they can be'
1068
' safely recovered (default).',
1069
keep="Don't delete any files.",
1070
force='Delete all the specified files, even if they can not be '
1071
'recovered and even if they are non-empty directories.')]
1073
encoding_type = 'replace'
1075
def run(self, file_list, verbose=False, new=False,
1076
file_deletion_strategy='safe'):
1077
tree, file_list = tree_files(file_list)
1079
if file_list is not None:
1080
file_list = [f for f in file_list if f != '']
1082
raise errors.BzrCommandError('Specify one or more files to'
1083
' remove, or use --new.')
1086
added = tree.changes_from(tree.basis_tree(),
1087
specific_files=file_list).added
1088
file_list = sorted([f[0] for f in added], reverse=True)
1089
if len(file_list) == 0:
1090
raise errors.BzrCommandError('No matching files.')
1091
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1092
keep_files=file_deletion_strategy=='keep',
1093
force=file_deletion_strategy=='force')
1096
class cmd_file_id(Command):
1097
"""Print file_id of a particular file or directory.
1099
The file_id is assigned when the file is first added and remains the
1100
same through all revisions where the file exists, even when it is
1105
_see_also = ['inventory', 'ls']
1106
takes_args = ['filename']
1109
def run(self, filename):
1110
tree, relpath = WorkingTree.open_containing(filename)
1111
i = tree.path2id(relpath)
1113
raise errors.NotVersionedError(filename)
1115
self.outf.write(i + '\n')
1118
class cmd_file_path(Command):
1119
"""Print path of file_ids to a file or directory.
1121
This prints one line for each directory down to the target,
1122
starting at the branch root.
1126
takes_args = ['filename']
1129
def run(self, filename):
1130
tree, relpath = WorkingTree.open_containing(filename)
1131
fid = tree.path2id(relpath)
1133
raise errors.NotVersionedError(filename)
1134
segments = osutils.splitpath(relpath)
1135
for pos in range(1, len(segments) + 1):
1136
path = osutils.joinpath(segments[:pos])
1137
self.outf.write("%s\n" % tree.path2id(path))
1140
class cmd_reconcile(Command):
1141
"""Reconcile bzr metadata in a branch.
1143
This can correct data mismatches that may have been caused by
1144
previous ghost operations or bzr upgrades. You should only
1145
need to run this command if 'bzr check' or a bzr developer
1146
advises you to run it.
1148
If a second branch is provided, cross-branch reconciliation is
1149
also attempted, which will check that data like the tree root
1150
id which was not present in very early bzr versions is represented
1151
correctly in both branches.
1153
At the same time it is run it may recompress data resulting in
1154
a potential saving in disk space or performance gain.
1156
The branch *MUST* be on a listable system such as local disk or sftp.
1159
_see_also = ['check']
1160
takes_args = ['branch?']
1162
def run(self, branch="."):
1163
from bzrlib.reconcile import reconcile
1164
dir = bzrdir.BzrDir.open(branch)
1168
class cmd_revision_history(Command):
1169
"""Display the list of revision ids on a branch."""
1172
takes_args = ['location?']
1177
def run(self, location="."):
1178
branch = Branch.open_containing(location)[0]
1179
for revid in branch.revision_history():
1180
self.outf.write(revid)
1181
self.outf.write('\n')
1184
class cmd_ancestry(Command):
1185
"""List all revisions merged into this branch."""
1187
_see_also = ['log', 'revision-history']
1188
takes_args = ['location?']
1193
def run(self, location="."):
1195
wt = WorkingTree.open_containing(location)[0]
1196
except errors.NoWorkingTree:
1197
b = Branch.open(location)
1198
last_revision = b.last_revision()
1201
last_revision = wt.last_revision()
1203
revision_ids = b.repository.get_ancestry(last_revision)
1204
assert revision_ids[0] is None
1206
for revision_id in revision_ids:
1207
self.outf.write(revision_id + '\n')
1210
class cmd_init(Command):
1211
"""Make a directory into a versioned branch.
1213
Use this to create an empty branch, or before importing an
1216
If there is a repository in a parent directory of the location, then
1217
the history of the branch will be stored in the repository. Otherwise
1218
init creates a standalone branch which carries its own history
1219
in the .bzr directory.
1221
If there is already a branch at the location but it has no working tree,
1222
the tree can be populated with 'bzr checkout'.
1224
Recipe for importing a tree of files:
1229
bzr commit -m 'imported project'
1232
_see_also = ['init-repo', 'branch', 'checkout']
1233
takes_args = ['location?']
1235
Option('create-prefix',
1236
help='Create the path leading up to the branch '
1237
'if it does not already exist'),
1238
RegistryOption('format',
1239
help='Specify a format for this branch. '
1240
'See "help formats".',
1241
registry=bzrdir.format_registry,
1242
converter=bzrdir.format_registry.make_bzrdir,
1243
value_switches=True,
1244
title="Branch Format",
1246
Option('append-revisions-only',
1247
help='Never change revnos or the existing log.'
1248
' Append revisions to it only.')
1250
def run(self, location=None, format=None, append_revisions_only=False,
1251
create_prefix=False):
1253
format = bzrdir.format_registry.make_bzrdir('default')
1254
if location is None:
1257
to_transport = transport.get_transport(location)
1259
# The path has to exist to initialize a
1260
# branch inside of it.
1261
# Just using os.mkdir, since I don't
1262
# believe that we want to create a bunch of
1263
# locations if the user supplies an extended path
1265
to_transport.ensure_base()
1266
except errors.NoSuchFile:
1267
if not create_prefix:
1268
raise errors.BzrCommandError("Parent directory of %s"
1270
"\nYou may supply --create-prefix to create all"
1271
" leading parent directories."
1273
_create_prefix(to_transport)
1276
existing_bzrdir = bzrdir.BzrDir.open(location)
1277
except errors.NotBranchError:
1278
# really a NotBzrDir error...
1279
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1282
from bzrlib.transport.local import LocalTransport
1283
if existing_bzrdir.has_branch():
1284
if (isinstance(to_transport, LocalTransport)
1285
and not existing_bzrdir.has_workingtree()):
1286
raise errors.BranchExistsWithoutWorkingTree(location)
1287
raise errors.AlreadyBranchError(location)
1289
branch = existing_bzrdir.create_branch()
1290
existing_bzrdir.create_workingtree()
1291
if append_revisions_only:
1293
branch.set_append_revisions_only(True)
1294
except errors.UpgradeRequired:
1295
raise errors.BzrCommandError('This branch format cannot be set'
1296
' to append-revisions-only. Try --experimental-branch6')
1299
class cmd_init_repository(Command):
1300
"""Create a shared repository to hold branches.
1302
New branches created under the repository directory will store their
1303
revisions in the repository, not in the branch directory.
1305
If the --no-trees option is used then the branches in the repository
1306
will not have working trees by default.
1309
bzr init-repo --no-trees repo
1311
bzr checkout --lightweight repo/trunk trunk-checkout
1315
See 'bzr help repositories' for more information.
1318
_see_also = ['init', 'branch', 'checkout']
1319
takes_args = ["location"]
1320
takes_options = [RegistryOption('format',
1321
help='Specify a format for this repository. See'
1322
' "bzr help formats" for details',
1323
registry=bzrdir.format_registry,
1324
converter=bzrdir.format_registry.make_bzrdir,
1325
value_switches=True, title='Repository format'),
1327
help='Branches in the repository will default to'
1328
' not having a working tree'),
1330
aliases = ["init-repo"]
1332
def run(self, location, format=None, no_trees=False):
1334
format = bzrdir.format_registry.make_bzrdir('default')
1336
if location is None:
1339
to_transport = transport.get_transport(location)
1340
to_transport.ensure_base()
1342
newdir = format.initialize_on_transport(to_transport)
1343
repo = newdir.create_repository(shared=True)
1344
repo.set_make_working_trees(not no_trees)
1347
class cmd_diff(Command):
1348
"""Show differences in the working tree or between revisions.
1350
If files are listed, only the changes in those files are listed.
1351
Otherwise, all changes for the tree are listed.
1353
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1354
produces patches suitable for "patch -p1".
1358
Shows the difference in the working tree versus the last commit
1360
Difference between the working tree and revision 1
1362
Difference between revision 2 and revision 1
1363
bzr diff --prefix old/:new/
1364
Same as 'bzr diff' but prefix paths with old/ and new/
1365
bzr diff bzr.mine bzr.dev
1366
Show the differences between the two working trees
1368
Show just the differences for 'foo.c'
1370
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1371
# or a graphical diff.
1373
# TODO: Python difflib is not exactly the same as unidiff; should
1374
# either fix it up or prefer to use an external diff.
1376
# TODO: Selected-file diff is inefficient and doesn't show you
1379
# TODO: This probably handles non-Unix newlines poorly.
1381
_see_also = ['status']
1382
takes_args = ['file*']
1383
takes_options = ['revision', 'diff-options',
1384
Option('prefix', type=str,
1386
help='Set prefixes to added to old and new filenames, as '
1387
'two values separated by a colon. (eg "old/:new/")'),
1389
aliases = ['di', 'dif']
1390
encoding_type = 'exact'
1393
def run(self, revision=None, file_list=None, diff_options=None,
1395
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1397
if (prefix is None) or (prefix == '0'):
1405
old_label, new_label = prefix.split(":")
1407
raise errors.BzrCommandError(
1408
'--prefix expects two values separated by a colon'
1409
' (eg "old/:new/")')
1411
if revision and len(revision) > 2:
1412
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1413
' one or two revision specifiers')
1416
tree1, file_list = internal_tree_files(file_list)
1420
except errors.FileInWrongBranch:
1421
if len(file_list) != 2:
1422
raise errors.BzrCommandError("Files are in different branches")
1424
tree1, file1 = WorkingTree.open_containing(file_list[0])
1425
tree2, file2 = WorkingTree.open_containing(file_list[1])
1426
if file1 != "" or file2 != "":
1427
# FIXME diff those two files. rbc 20051123
1428
raise errors.BzrCommandError("Files are in different branches")
1430
except errors.NotBranchError:
1431
if (revision is not None and len(revision) == 2
1432
and not revision[0].needs_branch()
1433
and not revision[1].needs_branch()):
1434
# If both revision specs include a branch, we can
1435
# diff them without needing a local working tree
1436
tree1, tree2 = None, None
1440
if tree2 is not None:
1441
if revision is not None:
1442
# FIXME: but there should be a clean way to diff between
1443
# non-default versions of two trees, it's not hard to do
1445
raise errors.BzrCommandError(
1446
"Sorry, diffing arbitrary revisions across branches "
1447
"is not implemented yet")
1448
return show_diff_trees(tree1, tree2, sys.stdout,
1449
specific_files=file_list,
1450
external_diff_options=diff_options,
1451
old_label=old_label, new_label=new_label)
1453
return diff_cmd_helper(tree1, file_list, diff_options,
1454
revision_specs=revision,
1455
old_label=old_label, new_label=new_label)
1458
class cmd_deleted(Command):
1459
"""List files deleted in the working tree.
1461
# TODO: Show files deleted since a previous revision, or
1462
# between two revisions.
1463
# TODO: Much more efficient way to do this: read in new
1464
# directories with readdir, rather than stating each one. Same
1465
# level of effort but possibly much less IO. (Or possibly not,
1466
# if the directories are very large...)
1467
_see_also = ['status', 'ls']
1468
takes_options = ['show-ids']
1471
def run(self, show_ids=False):
1472
tree = WorkingTree.open_containing(u'.')[0]
1475
old = tree.basis_tree()
1478
for path, ie in old.inventory.iter_entries():
1479
if not tree.has_id(ie.file_id):
1480
self.outf.write(path)
1482
self.outf.write(' ')
1483
self.outf.write(ie.file_id)
1484
self.outf.write('\n')
1491
class cmd_modified(Command):
1492
"""List files modified in working tree.
1496
_see_also = ['status', 'ls']
1500
tree = WorkingTree.open_containing(u'.')[0]
1501
td = tree.changes_from(tree.basis_tree())
1502
for path, id, kind, text_modified, meta_modified in td.modified:
1503
self.outf.write(path + '\n')
1506
class cmd_added(Command):
1507
"""List files added in working tree.
1511
_see_also = ['status', 'ls']
1515
wt = WorkingTree.open_containing(u'.')[0]
1518
basis = wt.basis_tree()
1521
basis_inv = basis.inventory
1524
if file_id in basis_inv:
1526
if inv.is_root(file_id) and len(basis_inv) == 0:
1528
path = inv.id2path(file_id)
1529
if not os.access(osutils.abspath(path), os.F_OK):
1531
self.outf.write(path + '\n')
1538
class cmd_root(Command):
1539
"""Show the tree root directory.
1541
The root is the nearest enclosing directory with a .bzr control
1544
takes_args = ['filename?']
1546
def run(self, filename=None):
1547
"""Print the branch root."""
1548
tree = WorkingTree.open_containing(filename)[0]
1549
self.outf.write(tree.basedir + '\n')
1552
def _parse_limit(limitstring):
1554
return int(limitstring)
1556
msg = "The limit argument must be an integer."
1557
raise errors.BzrCommandError(msg)
1560
class cmd_log(Command):
1561
"""Show log of a branch, file, or directory.
1563
By default show the log of the branch containing the working directory.
1565
To request a range of logs, you can use the command -r begin..end
1566
-r revision requests a specific revision, -r ..end or -r begin.. are
1572
bzr log -r -10.. http://server/branch
1575
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1577
takes_args = ['location?']
1578
takes_options = [Option('forward',
1579
help='show from oldest to newest'),
1583
help='show files changed in each revision'),
1584
'show-ids', 'revision',
1588
help='show revisions whose message matches this regexp',
1591
help='limit the output to the first N revisions',
1594
encoding_type = 'replace'
1597
def run(self, location=None, timezone='original',
1605
from bzrlib.log import show_log
1606
assert message is None or isinstance(message, basestring), \
1607
"invalid message argument %r" % message
1608
direction = (forward and 'forward') or 'reverse'
1613
# find the file id to log:
1615
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1619
tree = b.basis_tree()
1620
file_id = tree.path2id(fp)
1622
raise errors.BzrCommandError(
1623
"Path does not have any revision history: %s" %
1627
# FIXME ? log the current subdir only RBC 20060203
1628
if revision is not None \
1629
and len(revision) > 0 and revision[0].get_branch():
1630
location = revision[0].get_branch()
1633
dir, relpath = bzrdir.BzrDir.open_containing(location)
1634
b = dir.open_branch()
1638
if revision is None:
1641
elif len(revision) == 1:
1642
rev1 = rev2 = revision[0].in_history(b).revno
1643
elif len(revision) == 2:
1644
if revision[1].get_branch() != revision[0].get_branch():
1645
# b is taken from revision[0].get_branch(), and
1646
# show_log will use its revision_history. Having
1647
# different branches will lead to weird behaviors.
1648
raise errors.BzrCommandError(
1649
"Log doesn't accept two revisions in different"
1651
if revision[0].spec is None:
1652
# missing begin-range means first revision
1655
rev1 = revision[0].in_history(b).revno
1657
if revision[1].spec is None:
1658
# missing end-range means last known revision
1661
rev2 = revision[1].in_history(b).revno
1663
raise errors.BzrCommandError(
1664
'bzr log --revision takes one or two values.')
1666
# By this point, the revision numbers are converted to the +ve
1667
# form if they were supplied in the -ve form, so we can do
1668
# this comparison in relative safety
1670
(rev2, rev1) = (rev1, rev2)
1672
if log_format is None:
1673
log_format = log.log_formatter_registry.get_default(b)
1675
lf = log_format(show_ids=show_ids, to_file=self.outf,
1676
show_timezone=timezone)
1682
direction=direction,
1683
start_revision=rev1,
1691
def get_log_format(long=False, short=False, line=False, default='long'):
1692
log_format = default
1696
log_format = 'short'
1702
class cmd_touching_revisions(Command):
1703
"""Return revision-ids which affected a particular file.
1705
A more user-friendly interface is "bzr log FILE".
1709
takes_args = ["filename"]
1712
def run(self, filename):
1713
tree, relpath = WorkingTree.open_containing(filename)
1715
file_id = tree.path2id(relpath)
1716
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1717
self.outf.write("%6d %s\n" % (revno, what))
1720
class cmd_ls(Command):
1721
"""List files in a tree.
1724
_see_also = ['status', 'cat']
1725
takes_args = ['path?']
1726
# TODO: Take a revision or remote path and list that tree instead.
1727
takes_options = ['verbose', 'revision',
1728
Option('non-recursive',
1729
help='don\'t recurse into sub-directories'),
1731
help='Print all paths from the root of the branch.'),
1732
Option('unknown', help='Print unknown files'),
1733
Option('versioned', help='Print versioned files'),
1734
Option('ignored', help='Print ignored files'),
1736
Option('null', help='Null separate the files'),
1740
def run(self, revision=None, verbose=False,
1741
non_recursive=False, from_root=False,
1742
unknown=False, versioned=False, ignored=False,
1743
null=False, kind=None, show_ids=False, path=None):
1745
if kind and kind not in ('file', 'directory', 'symlink'):
1746
raise errors.BzrCommandError('invalid kind specified')
1748
if verbose and null:
1749
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1750
all = not (unknown or versioned or ignored)
1752
selection = {'I':ignored, '?':unknown, 'V':versioned}
1759
raise errors.BzrCommandError('cannot specify both --from-root'
1763
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1769
if revision is not None:
1770
tree = branch.repository.revision_tree(
1771
revision[0].in_history(branch).rev_id)
1773
tree = branch.basis_tree()
1777
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1778
if fp.startswith(relpath):
1779
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1780
if non_recursive and '/' in fp:
1782
if not all and not selection[fc]:
1784
if kind is not None and fkind != kind:
1787
kindch = entry.kind_character()
1788
outstring = '%-8s %s%s' % (fc, fp, kindch)
1789
if show_ids and fid is not None:
1790
outstring = "%-50s %s" % (outstring, fid)
1791
self.outf.write(outstring + '\n')
1793
self.outf.write(fp + '\0')
1796
self.outf.write(fid)
1797
self.outf.write('\0')
1805
self.outf.write('%-50s %s\n' % (fp, my_id))
1807
self.outf.write(fp + '\n')
1812
class cmd_unknowns(Command):
1813
"""List unknown files.
1821
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1822
self.outf.write(osutils.quotefn(f) + '\n')
1825
class cmd_ignore(Command):
1826
"""Ignore specified files or patterns.
1828
To remove patterns from the ignore list, edit the .bzrignore file.
1830
Trailing slashes on patterns are ignored.
1831
If the pattern contains a slash or is a regular expression, it is compared
1832
to the whole path from the branch root. Otherwise, it is compared to only
1833
the last component of the path. To match a file only in the root
1834
directory, prepend './'.
1836
Ignore patterns specifying absolute paths are not allowed.
1838
Ignore patterns may include globbing wildcards such as:
1839
? - Matches any single character except '/'
1840
* - Matches 0 or more characters except '/'
1841
/**/ - Matches 0 or more directories in a path
1842
[a-z] - Matches a single character from within a group of characters
1844
Ignore patterns may also be Python regular expressions.
1845
Regular expression ignore patterns are identified by a 'RE:' prefix
1846
followed by the regular expression. Regular expression ignore patterns
1847
may not include named or numbered groups.
1849
Note: ignore patterns containing shell wildcards must be quoted from
1853
bzr ignore ./Makefile
1854
bzr ignore '*.class'
1855
bzr ignore 'lib/**/*.o'
1856
bzr ignore 'RE:lib/.*\.o'
1859
_see_also = ['status', 'ignored']
1860
takes_args = ['name_pattern*']
1862
Option('old-default-rules',
1863
help='Out the ignore rules bzr < 0.9 always used.')
1866
def run(self, name_pattern_list=None, old_default_rules=None):
1867
from bzrlib.atomicfile import AtomicFile
1868
if old_default_rules is not None:
1869
# dump the rules and exit
1870
for pattern in ignores.OLD_DEFAULTS:
1873
if not name_pattern_list:
1874
raise errors.BzrCommandError("ignore requires at least one "
1875
"NAME_PATTERN or --old-default-rules")
1876
name_pattern_list = [globbing.normalize_pattern(p)
1877
for p in name_pattern_list]
1878
for name_pattern in name_pattern_list:
1879
if (name_pattern[0] == '/' or
1880
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1881
raise errors.BzrCommandError(
1882
"NAME_PATTERN should not be an absolute path")
1883
tree, relpath = WorkingTree.open_containing(u'.')
1884
ifn = tree.abspath('.bzrignore')
1885
if os.path.exists(ifn):
1888
igns = f.read().decode('utf-8')
1894
# TODO: If the file already uses crlf-style termination, maybe
1895
# we should use that for the newly added lines?
1897
if igns and igns[-1] != '\n':
1899
for name_pattern in name_pattern_list:
1900
igns += name_pattern + '\n'
1902
f = AtomicFile(ifn, 'wb')
1904
f.write(igns.encode('utf-8'))
1909
if not tree.path2id('.bzrignore'):
1910
tree.add(['.bzrignore'])
1913
class cmd_ignored(Command):
1914
"""List ignored files and the patterns that matched them.
1917
_see_also = ['ignore']
1920
tree = WorkingTree.open_containing(u'.')[0]
1923
for path, file_class, kind, file_id, entry in tree.list_files():
1924
if file_class != 'I':
1926
## XXX: Slightly inefficient since this was already calculated
1927
pat = tree.is_ignored(path)
1928
print '%-50s %s' % (path, pat)
1933
class cmd_lookup_revision(Command):
1934
"""Lookup the revision-id from a revision-number
1937
bzr lookup-revision 33
1940
takes_args = ['revno']
1943
def run(self, revno):
1947
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1949
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1952
class cmd_export(Command):
1953
"""Export current or past revision to a destination directory or archive.
1955
If no revision is specified this exports the last committed revision.
1957
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1958
given, try to find the format with the extension. If no extension
1959
is found exports to a directory (equivalent to --format=dir).
1961
If root is supplied, it will be used as the root directory inside
1962
container formats (tar, zip, etc). If it is not supplied it will default
1963
to the exported filename. The root option has no effect for 'dir' format.
1965
If branch is omitted then the branch containing the current working
1966
directory will be used.
1968
Note: Export of tree with non-ASCII filenames to zip is not supported.
1970
Supported formats Autodetected by extension
1971
----------------- -------------------------
1974
tbz2 .tar.bz2, .tbz2
1978
takes_args = ['dest', 'branch?']
1979
takes_options = ['revision', 'format', 'root']
1980
def run(self, dest, branch=None, revision=None, format=None, root=None):
1981
from bzrlib.export import export
1984
tree = WorkingTree.open_containing(u'.')[0]
1987
b = Branch.open(branch)
1989
if revision is None:
1990
# should be tree.last_revision FIXME
1991
rev_id = b.last_revision()
1993
if len(revision) != 1:
1994
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1995
rev_id = revision[0].in_history(b).rev_id
1996
t = b.repository.revision_tree(rev_id)
1998
export(t, dest, format, root)
1999
except errors.NoSuchExportFormat, e:
2000
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2003
class cmd_cat(Command):
2004
"""Write the contents of a file as of a given revision to standard output.
2006
If no revision is nominated, the last revision is used.
2008
Note: Take care to redirect standard output when using this command on a
2013
takes_options = ['revision', 'name-from-revision']
2014
takes_args = ['filename']
2015
encoding_type = 'exact'
2018
def run(self, filename, revision=None, name_from_revision=False):
2019
if revision is not None and len(revision) != 1:
2020
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2025
tree, b, relpath = \
2026
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2027
except errors.NotBranchError:
2030
if revision is not None and revision[0].get_branch() is not None:
2031
b = Branch.open(revision[0].get_branch())
2033
tree = b.basis_tree()
2034
if revision is None:
2035
revision_id = b.last_revision()
2037
revision_id = revision[0].in_history(b).rev_id
2039
cur_file_id = tree.path2id(relpath)
2040
rev_tree = b.repository.revision_tree(revision_id)
2041
old_file_id = rev_tree.path2id(relpath)
2043
if name_from_revision:
2044
if old_file_id is None:
2045
raise errors.BzrCommandError("%r is not present in revision %s"
2046
% (filename, revision_id))
2048
rev_tree.print_file(old_file_id)
2049
elif cur_file_id is not None:
2050
rev_tree.print_file(cur_file_id)
2051
elif old_file_id is not None:
2052
rev_tree.print_file(old_file_id)
2054
raise errors.BzrCommandError("%r is not present in revision %s" %
2055
(filename, revision_id))
2058
class cmd_local_time_offset(Command):
2059
"""Show the offset in seconds from GMT to local time."""
2063
print osutils.local_time_offset()
2067
class cmd_commit(Command):
2068
"""Commit changes into a new revision.
2070
If no arguments are given, the entire tree is committed.
2072
If selected files are specified, only changes to those files are
2073
committed. If a directory is specified then the directory and everything
2074
within it is committed.
2076
A selected-file commit may fail in some cases where the committed
2077
tree would be invalid. Consider::
2082
bzr commit foo -m "committing foo"
2083
bzr mv foo/bar foo/baz
2086
bzr commit foo/bar -m "committing bar but not baz"
2088
In the example above, the last commit will fail by design. This gives
2089
the user the opportunity to decide whether they want to commit the
2090
rename at the same time, separately first, or not at all. (As a general
2091
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2093
Note: A selected-file commit after a merge is not yet supported.
2095
# TODO: Run hooks on tree to-be-committed, and after commit.
2097
# TODO: Strict commit that fails if there are deleted files.
2098
# (what does "deleted files" mean ??)
2100
# TODO: Give better message for -s, --summary, used by tla people
2102
# XXX: verbose currently does nothing
2104
_see_also = ['bugs', 'uncommit']
2105
takes_args = ['selected*']
2106
takes_options = ['message', 'verbose',
2108
help='commit even if nothing has changed'),
2109
Option('file', type=str,
2112
help='file containing commit message'),
2114
help="refuse to commit if there are unknown "
2115
"files in the working tree."),
2116
ListOption('fixes', type=str,
2117
help="mark a bug as being fixed by this "
2120
help="perform a local only commit in a bound "
2121
"branch. Such commits are not pushed to "
2122
"the master branch until a normal commit "
2126
aliases = ['ci', 'checkin']
2128
def _get_bug_fix_properties(self, fixes, branch):
2130
# Configure the properties for bug fixing attributes.
2131
for fixed_bug in fixes:
2132
tokens = fixed_bug.split(':')
2133
if len(tokens) != 2:
2134
raise errors.BzrCommandError(
2135
"Invalid bug %s. Must be in the form of 'tag:id'. "
2136
"Commit refused." % fixed_bug)
2137
tag, bug_id = tokens
2139
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2140
except errors.UnknownBugTrackerAbbreviation:
2141
raise errors.BzrCommandError(
2142
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2143
except errors.MalformedBugIdentifier:
2144
raise errors.BzrCommandError(
2145
"Invalid bug identifier for %s. Commit refused."
2147
properties.append('%s fixed' % bug_url)
2148
return '\n'.join(properties)
2150
def run(self, message=None, file=None, verbose=True, selected_list=None,
2151
unchanged=False, strict=False, local=False, fixes=None):
2152
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2153
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2155
from bzrlib.msgeditor import edit_commit_message, \
2156
make_commit_message_template
2158
# TODO: Need a blackbox test for invoking the external editor; may be
2159
# slightly problematic to run this cross-platform.
2161
# TODO: do more checks that the commit will succeed before
2162
# spending the user's valuable time typing a commit message.
2166
tree, selected_list = tree_files(selected_list)
2167
if selected_list == ['']:
2168
# workaround - commit of root of tree should be exactly the same
2169
# as just default commit in that tree, and succeed even though
2170
# selected-file merge commit is not done yet
2173
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2175
properties['bugs'] = bug_property
2177
if local and not tree.branch.get_bound_location():
2178
raise errors.LocalRequiresBoundBranch()
2180
def get_message(commit_obj):
2181
"""Callback to get commit message"""
2182
my_message = message
2183
if my_message is None and not file:
2184
template = make_commit_message_template(tree, selected_list)
2185
my_message = edit_commit_message(template)
2186
if my_message is None:
2187
raise errors.BzrCommandError("please specify a commit"
2188
" message with either --message or --file")
2189
elif my_message and file:
2190
raise errors.BzrCommandError(
2191
"please specify either --message or --file")
2193
my_message = codecs.open(file, 'rt',
2194
bzrlib.user_encoding).read()
2195
if my_message == "":
2196
raise errors.BzrCommandError("empty commit message specified")
2200
reporter = ReportCommitToLog()
2202
reporter = NullCommitReporter()
2205
tree.commit(message_callback=get_message,
2206
specific_files=selected_list,
2207
allow_pointless=unchanged, strict=strict, local=local,
2208
reporter=reporter, revprops=properties)
2209
except PointlessCommit:
2210
# FIXME: This should really happen before the file is read in;
2211
# perhaps prepare the commit; get the message; then actually commit
2212
raise errors.BzrCommandError("no changes to commit."
2213
" use --unchanged to commit anyhow")
2214
except ConflictsInTree:
2215
raise errors.BzrCommandError('Conflicts detected in working '
2216
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2218
except StrictCommitFailed:
2219
raise errors.BzrCommandError("Commit refused because there are"
2220
" unknown files in the working tree.")
2221
except errors.BoundBranchOutOfDate, e:
2222
raise errors.BzrCommandError(str(e) + "\n"
2223
'To commit to master branch, run update and then commit.\n'
2224
'You can also pass --local to commit to continue working '
2228
class cmd_check(Command):
2229
"""Validate consistency of branch history.
2231
This command checks various invariants about the branch storage to
2232
detect data corruption or bzr bugs.
2235
_see_also = ['reconcile']
2236
takes_args = ['branch?']
2237
takes_options = ['verbose']
2239
def run(self, branch=None, verbose=False):
2240
from bzrlib.check import check
2242
tree = WorkingTree.open_containing()[0]
2243
branch = tree.branch
2245
branch = Branch.open(branch)
2246
check(branch, verbose)
2249
class cmd_upgrade(Command):
2250
"""Upgrade branch storage to current format.
2252
The check command or bzr developers may sometimes advise you to run
2253
this command. When the default format has changed you may also be warned
2254
during other operations to upgrade.
2257
_see_also = ['check']
2258
takes_args = ['url?']
2260
RegistryOption('format',
2261
help='Upgrade to a specific format. See "bzr help'
2262
' formats" for details',
2263
registry=bzrdir.format_registry,
2264
converter=bzrdir.format_registry.make_bzrdir,
2265
value_switches=True, title='Branch format'),
2268
def run(self, url='.', format=None):
2269
from bzrlib.upgrade import upgrade
2271
format = bzrdir.format_registry.make_bzrdir('default')
2272
upgrade(url, format)
2275
class cmd_whoami(Command):
2276
"""Show or set bzr user id.
2280
bzr whoami 'Frank Chu <fchu@example.com>'
2282
takes_options = [ Option('email',
2283
help='display email address only'),
2285
help='set identity for the current branch instead of '
2288
takes_args = ['name?']
2289
encoding_type = 'replace'
2292
def run(self, email=False, branch=False, name=None):
2294
# use branch if we're inside one; otherwise global config
2296
c = Branch.open_containing('.')[0].get_config()
2297
except errors.NotBranchError:
2298
c = config.GlobalConfig()
2300
self.outf.write(c.user_email() + '\n')
2302
self.outf.write(c.username() + '\n')
2305
# display a warning if an email address isn't included in the given name.
2307
config.extract_email_address(name)
2308
except errors.NoEmailInUsername, e:
2309
warning('"%s" does not seem to contain an email address. '
2310
'This is allowed, but not recommended.', name)
2312
# use global config unless --branch given
2314
c = Branch.open_containing('.')[0].get_config()
2316
c = config.GlobalConfig()
2317
c.set_user_option('email', name)
2320
class cmd_nick(Command):
2321
"""Print or set the branch nickname.
2323
If unset, the tree root directory name is used as the nickname
2324
To print the current nickname, execute with no argument.
2327
_see_also = ['info']
2328
takes_args = ['nickname?']
2329
def run(self, nickname=None):
2330
branch = Branch.open_containing(u'.')[0]
2331
if nickname is None:
2332
self.printme(branch)
2334
branch.nick = nickname
2337
def printme(self, branch):
2341
class cmd_selftest(Command):
2342
"""Run internal test suite.
2344
If arguments are given, they are regular expressions that say which tests
2345
should run. Tests matching any expression are run, and other tests are
2348
Alternatively if --first is given, matching tests are run first and then
2349
all other tests are run. This is useful if you have been working in a
2350
particular area, but want to make sure nothing else was broken.
2352
If --exclude is given, tests that match that regular expression are
2353
excluded, regardless of whether they match --first or not.
2355
To help catch accidential dependencies between tests, the --randomize
2356
option is useful. In most cases, the argument used is the word 'now'.
2357
Note that the seed used for the random number generator is displayed
2358
when this option is used. The seed can be explicitly passed as the
2359
argument to this option if required. This enables reproduction of the
2360
actual ordering used if and when an order sensitive problem is encountered.
2362
If --list-only is given, the tests that would be run are listed. This is
2363
useful when combined with --first, --exclude and/or --randomize to
2364
understand their impact. The test harness reports "Listed nn tests in ..."
2365
instead of "Ran nn tests in ..." when list mode is enabled.
2367
If the global option '--no-plugins' is given, plugins are not loaded
2368
before running the selftests. This has two effects: features provided or
2369
modified by plugins will not be tested, and tests provided by plugins will
2374
run only tests relating to 'ignore'
2375
bzr --no-plugins selftest -v
2376
disable plugins and list tests as they're run
2378
For each test, that needs actual disk access, bzr create their own
2379
subdirectory in the temporary testing directory (testXXXX.tmp).
2380
By default the name of such subdirectory is based on the name of the test.
2381
If option '--numbered-dirs' is given, bzr will use sequent numbers
2382
of running tests to create such subdirectories. This is default behavior
2383
on Windows because of path length limitation.
2385
# NB: this is used from the class without creating an instance, which is
2386
# why it does not have a self parameter.
2387
def get_transport_type(typestring):
2388
"""Parse and return a transport specifier."""
2389
if typestring == "sftp":
2390
from bzrlib.transport.sftp import SFTPAbsoluteServer
2391
return SFTPAbsoluteServer
2392
if typestring == "memory":
2393
from bzrlib.transport.memory import MemoryServer
2395
if typestring == "fakenfs":
2396
from bzrlib.transport.fakenfs import FakeNFSServer
2397
return FakeNFSServer
2398
msg = "No known transport type %s. Supported types are: sftp\n" %\
2400
raise errors.BzrCommandError(msg)
2403
takes_args = ['testspecs*']
2404
takes_options = ['verbose',
2406
help='stop when one test fails',
2409
Option('keep-output',
2410
help='keep output directories when tests fail'),
2412
help='Use a different transport by default '
2413
'throughout the test suite.',
2414
type=get_transport_type),
2415
Option('benchmark', help='run the bzr benchmarks.'),
2416
Option('lsprof-timed',
2417
help='generate lsprof output for benchmarked'
2418
' sections of code.'),
2419
Option('cache-dir', type=str,
2420
help='a directory to cache intermediate'
2421
' benchmark steps'),
2422
Option('clean-output',
2423
help='clean temporary tests directories'
2424
' without running tests'),
2426
help='run all tests, but run specified tests first',
2429
Option('numbered-dirs',
2430
help='use numbered dirs for TestCaseInTempDir'),
2432
help='list the tests instead of running them'),
2433
Option('randomize', type=str, argname="SEED",
2434
help='randomize the order of tests using the given'
2435
' seed or "now" for the current time'),
2436
Option('exclude', type=str, argname="PATTERN",
2438
help='exclude tests that match this regular'
2441
encoding_type = 'replace'
2443
def run(self, testspecs_list=None, verbose=None, one=False,
2444
keep_output=False, transport=None, benchmark=None,
2445
lsprof_timed=None, cache_dir=None, clean_output=False,
2446
first=False, numbered_dirs=None, list_only=False,
2447
randomize=None, exclude=None):
2449
from bzrlib.tests import selftest
2450
import bzrlib.benchmarks as benchmarks
2451
from bzrlib.benchmarks import tree_creator
2454
from bzrlib.tests import clean_selftest_output
2455
clean_selftest_output()
2458
warning("notice: selftest --keep-output "
2459
"is no longer supported; "
2460
"test output is always removed")
2462
if numbered_dirs is None and sys.platform == 'win32':
2463
numbered_dirs = True
2465
if cache_dir is not None:
2466
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2467
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2468
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2470
if testspecs_list is not None:
2471
pattern = '|'.join(testspecs_list)
2475
test_suite_factory = benchmarks.test_suite
2478
# TODO: should possibly lock the history file...
2479
benchfile = open(".perf_history", "at", buffering=1)
2481
test_suite_factory = None
2486
result = selftest(verbose=verbose,
2488
stop_on_failure=one,
2489
transport=transport,
2490
test_suite_factory=test_suite_factory,
2491
lsprof_timed=lsprof_timed,
2492
bench_history=benchfile,
2493
matching_tests_first=first,
2494
numbered_dirs=numbered_dirs,
2495
list_only=list_only,
2496
random_seed=randomize,
2497
exclude_pattern=exclude
2500
if benchfile is not None:
2503
info('tests passed')
2505
info('tests failed')
2506
return int(not result)
2509
class cmd_version(Command):
2510
"""Show version of bzr."""
2514
from bzrlib.version import show_version
2518
class cmd_rocks(Command):
2519
"""Statement of optimism."""
2525
print "It sure does!"
2528
class cmd_find_merge_base(Command):
2529
"""Find and print a base revision for merging two branches."""
2530
# TODO: Options to specify revisions on either side, as if
2531
# merging only part of the history.
2532
takes_args = ['branch', 'other']
2536
def run(self, branch, other):
2537
from bzrlib.revision import ensure_null, MultipleRevisionSources
2539
branch1 = Branch.open_containing(branch)[0]
2540
branch2 = Branch.open_containing(other)[0]
2542
last1 = ensure_null(branch1.last_revision())
2543
last2 = ensure_null(branch2.last_revision())
2545
graph = branch1.repository.get_graph(branch2.repository)
2546
base_rev_id = graph.find_unique_lca(last1, last2)
2548
print 'merge base is revision %s' % base_rev_id
2551
class cmd_merge(Command):
2552
"""Perform a three-way merge.
2554
The branch is the branch you will merge from. By default, it will merge
2555
the latest revision. If you specify a revision, that revision will be
2556
merged. If you specify two revisions, the first will be used as a BASE,
2557
and the second one as OTHER. Revision numbers are always relative to the
2560
By default, bzr will try to merge in all new work from the other
2561
branch, automatically determining an appropriate base. If this
2562
fails, you may need to give an explicit base.
2564
Merge will do its best to combine the changes in two branches, but there
2565
are some kinds of problems only a human can fix. When it encounters those,
2566
it will mark a conflict. A conflict means that you need to fix something,
2567
before you should commit.
2569
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2571
If there is no default branch set, the first merge will set it. After
2572
that, you can omit the branch to use the default. To change the
2573
default, use --remember. The value will only be saved if the remote
2574
location can be accessed.
2576
The results of the merge are placed into the destination working
2577
directory, where they can be reviewed (with bzr diff), tested, and then
2578
committed to record the result of the merge.
2582
To merge the latest revision from bzr.dev:
2583
bzr merge ../bzr.dev
2585
To merge changes up to and including revision 82 from bzr.dev:
2586
bzr merge -r 82 ../bzr.dev
2588
To merge the changes introduced by 82, without previous changes:
2589
bzr merge -r 81..82 ../bzr.dev
2591
merge refuses to run if there are any uncommitted changes, unless
2595
_see_also = ['update', 'remerge', 'status-flags']
2596
takes_args = ['branch?']
2597
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2598
Option('show-base', help="Show base revision text in "
2600
Option('uncommitted', help='Apply uncommitted changes'
2601
' from a working copy, instead of branch changes'),
2602
Option('pull', help='If the destination is already'
2603
' completely merged into the source, pull from the'
2604
' source rather than merging. When this happens,'
2605
' you do not need to commit the result.'),
2607
help='Branch to merge into, '
2608
'rather than the one containing the working directory',
2614
def run(self, branch=None, revision=None, force=False, merge_type=None,
2615
show_base=False, reprocess=False, remember=False,
2616
uncommitted=False, pull=False,
2619
from bzrlib.tag import _merge_tags_if_possible
2620
other_revision_id = None
2621
if merge_type is None:
2622
merge_type = _mod_merge.Merge3Merger
2624
if directory is None: directory = u'.'
2625
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2626
# inventory. Because merge is a mutating operation, it really
2627
# should be a lock_write() for the whole cmd_merge operation.
2628
# However, cmd_merge open's its own tree in _merge_helper, which
2629
# means if we lock here, the later lock_write() will always block.
2630
# Either the merge helper code should be updated to take a tree,
2631
# (What about tree.merge_from_branch?)
2632
tree = WorkingTree.open_containing(directory)[0]
2633
change_reporter = delta._ChangeReporter(
2634
unversioned_filter=tree.is_ignored)
2636
if branch is not None:
2638
mergeable = bundle.read_mergeable_from_url(
2640
except errors.NotABundle:
2641
pass # Continue on considering this url a Branch
2643
if revision is not None:
2644
raise errors.BzrCommandError(
2645
'Cannot use -r with merge directives or bundles')
2646
other_revision_id = mergeable.install_revisions(
2647
tree.branch.repository)
2648
revision = [RevisionSpec.from_string(
2649
'revid:' + other_revision_id)]
2651
if revision is None \
2652
or len(revision) < 1 or revision[0].needs_branch():
2653
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2655
if revision is None or len(revision) < 1:
2658
other = [branch, None]
2661
other = [branch, -1]
2662
other_branch, path = Branch.open_containing(branch)
2665
raise errors.BzrCommandError('Cannot use --uncommitted and'
2666
' --revision at the same time.')
2667
branch = revision[0].get_branch() or branch
2668
if len(revision) == 1:
2670
if other_revision_id is not None:
2675
other_branch, path = Branch.open_containing(branch)
2676
revno = revision[0].in_history(other_branch).revno
2677
other = [branch, revno]
2679
assert len(revision) == 2
2680
if None in revision:
2681
raise errors.BzrCommandError(
2682
"Merge doesn't permit empty revision specifier.")
2683
base_branch, path = Branch.open_containing(branch)
2684
branch1 = revision[1].get_branch() or branch
2685
other_branch, path1 = Branch.open_containing(branch1)
2686
if revision[0].get_branch() is not None:
2687
# then path was obtained from it, and is None.
2690
base = [branch, revision[0].in_history(base_branch).revno]
2691
other = [branch1, revision[1].in_history(other_branch).revno]
2693
if ((tree.branch.get_parent() is None or remember) and
2694
other_branch is not None):
2695
tree.branch.set_parent(other_branch.base)
2697
# pull tags now... it's a bit inconsistent to do it ahead of copying
2698
# the history but that's done inside the merge code
2699
if other_branch is not None:
2700
_merge_tags_if_possible(other_branch, tree.branch)
2703
interesting_files = [path]
2705
interesting_files = None
2706
pb = ui.ui_factory.nested_progress_bar()
2709
conflict_count = _merge_helper(
2710
other, base, other_rev_id=other_revision_id,
2711
check_clean=(not force),
2712
merge_type=merge_type,
2713
reprocess=reprocess,
2714
show_base=show_base,
2717
pb=pb, file_list=interesting_files,
2718
change_reporter=change_reporter)
2721
if conflict_count != 0:
2725
except errors.AmbiguousBase, e:
2726
m = ("sorry, bzr can't determine the right merge base yet\n"
2727
"candidates are:\n "
2728
+ "\n ".join(e.bases)
2730
"please specify an explicit base with -r,\n"
2731
"and (if you want) report this to the bzr developers\n")
2734
# TODO: move up to common parent; this isn't merge-specific anymore.
2735
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2736
"""Use tree.branch's parent if none was supplied.
2738
Report if the remembered location was used.
2740
if supplied_location is not None:
2741
return supplied_location
2742
stored_location = tree.branch.get_parent()
2743
mutter("%s", stored_location)
2744
if stored_location is None:
2745
raise errors.BzrCommandError("No location specified or remembered")
2746
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2747
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2748
return stored_location
2751
class cmd_remerge(Command):
2754
Use this if you want to try a different merge technique while resolving
2755
conflicts. Some merge techniques are better than others, and remerge
2756
lets you try different ones on different files.
2758
The options for remerge have the same meaning and defaults as the ones for
2759
merge. The difference is that remerge can (only) be run when there is a
2760
pending merge, and it lets you specify particular files.
2764
$ bzr remerge --show-base
2765
Re-do the merge of all conflicted files, and show the base text in
2766
conflict regions, in addition to the usual THIS and OTHER texts.
2768
$ bzr remerge --merge-type weave --reprocess foobar
2769
Re-do the merge of "foobar", using the weave merge algorithm, with
2770
additional processing to reduce the size of conflict regions.
2772
takes_args = ['file*']
2773
takes_options = ['merge-type', 'reprocess',
2774
Option('show-base', help="Show base revision text in "
2777
def run(self, file_list=None, merge_type=None, show_base=False,
2779
if merge_type is None:
2780
merge_type = _mod_merge.Merge3Merger
2781
tree, file_list = tree_files(file_list)
2784
parents = tree.get_parent_ids()
2785
if len(parents) != 2:
2786
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2787
" merges. Not cherrypicking or"
2789
repository = tree.branch.repository
2790
graph = repository.get_graph()
2791
base_revision = graph.find_unique_lca(parents[0], parents[1])
2792
base_tree = repository.revision_tree(base_revision)
2793
other_tree = repository.revision_tree(parents[1])
2794
interesting_ids = None
2796
conflicts = tree.conflicts()
2797
if file_list is not None:
2798
interesting_ids = set()
2799
for filename in file_list:
2800
file_id = tree.path2id(filename)
2802
raise errors.NotVersionedError(filename)
2803
interesting_ids.add(file_id)
2804
if tree.kind(file_id) != "directory":
2807
for name, ie in tree.inventory.iter_entries(file_id):
2808
interesting_ids.add(ie.file_id)
2809
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2811
# Remerge only supports resolving contents conflicts
2812
allowed_conflicts = ('text conflict', 'contents conflict')
2813
restore_files = [c.path for c in conflicts
2814
if c.typestring in allowed_conflicts]
2815
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2816
tree.set_conflicts(ConflictList(new_conflicts))
2817
if file_list is not None:
2818
restore_files = file_list
2819
for filename in restore_files:
2821
restore(tree.abspath(filename))
2822
except errors.NotConflicted:
2824
conflicts = _mod_merge.merge_inner(
2825
tree.branch, other_tree, base_tree,
2827
interesting_ids=interesting_ids,
2828
other_rev_id=parents[1],
2829
merge_type=merge_type,
2830
show_base=show_base,
2831
reprocess=reprocess)
2840
class cmd_revert(Command):
2841
"""Revert files to a previous revision.
2843
Giving a list of files will revert only those files. Otherwise, all files
2844
will be reverted. If the revision is not specified with '--revision', the
2845
last committed revision is used.
2847
To remove only some changes, without reverting to a prior version, use
2848
merge instead. For example, "merge . --r-2..-3" will remove the changes
2849
introduced by -2, without affecting the changes introduced by -1. Or
2850
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2852
By default, any files that have been manually changed will be backed up
2853
first. (Files changed only by merge are not backed up.) Backup files have
2854
'.~#~' appended to their name, where # is a number.
2856
When you provide files, you can use their current pathname or the pathname
2857
from the target revision. So you can use revert to "undelete" a file by
2858
name. If you name a directory, all the contents of that directory will be
2862
_see_also = ['cat', 'export']
2863
takes_options = ['revision', 'no-backup']
2864
takes_args = ['file*']
2866
def run(self, revision=None, no_backup=False, file_list=None):
2867
if file_list is not None:
2868
if len(file_list) == 0:
2869
raise errors.BzrCommandError("No files specified")
2873
tree, file_list = tree_files(file_list)
2874
if revision is None:
2875
# FIXME should be tree.last_revision
2876
rev_id = tree.last_revision()
2877
elif len(revision) != 1:
2878
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2880
rev_id = revision[0].in_history(tree.branch).rev_id
2881
pb = ui.ui_factory.nested_progress_bar()
2883
tree.revert(file_list,
2884
tree.branch.repository.revision_tree(rev_id),
2885
not no_backup, pb, report_changes=True)
2890
class cmd_assert_fail(Command):
2891
"""Test reporting of assertion failures"""
2892
# intended just for use in testing
2897
raise AssertionError("always fails")
2900
class cmd_help(Command):
2901
"""Show help on a command or other topic.
2904
_see_also = ['topics']
2905
takes_options = [Option('long', 'show help on all commands')]
2906
takes_args = ['topic?']
2907
aliases = ['?', '--help', '-?', '-h']
2910
def run(self, topic=None, long=False):
2912
if topic is None and long:
2914
bzrlib.help.help(topic)
2917
class cmd_shell_complete(Command):
2918
"""Show appropriate completions for context.
2920
For a list of all available commands, say 'bzr shell-complete'.
2922
takes_args = ['context?']
2927
def run(self, context=None):
2928
import shellcomplete
2929
shellcomplete.shellcomplete(context)
2932
class cmd_fetch(Command):
2933
"""Copy in history from another branch but don't merge it.
2935
This is an internal method used for pull and merge.
2938
takes_args = ['from_branch', 'to_branch']
2939
def run(self, from_branch, to_branch):
2940
from bzrlib.fetch import Fetcher
2941
from_b = Branch.open(from_branch)
2942
to_b = Branch.open(to_branch)
2943
Fetcher(to_b, from_b)
2946
class cmd_missing(Command):
2947
"""Show unmerged/unpulled revisions between two branches.
2949
OTHER_BRANCH may be local or remote.
2952
_see_also = ['merge', 'pull']
2953
takes_args = ['other_branch?']
2954
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2956
'Display changes in the local branch only'),
2957
Option('this' , 'same as --mine-only'),
2958
Option('theirs-only',
2959
'Display changes in the remote branch only'),
2960
Option('other', 'same as --theirs-only'),
2965
encoding_type = 'replace'
2968
def run(self, other_branch=None, reverse=False, mine_only=False,
2969
theirs_only=False, log_format=None, long=False, short=False, line=False,
2970
show_ids=False, verbose=False, this=False, other=False):
2971
from bzrlib.missing import find_unmerged, iter_log_revisions
2972
from bzrlib.log import log_formatter
2979
local_branch = Branch.open_containing(u".")[0]
2980
parent = local_branch.get_parent()
2981
if other_branch is None:
2982
other_branch = parent
2983
if other_branch is None:
2984
raise errors.BzrCommandError("No peer location known or specified.")
2985
display_url = urlutils.unescape_for_display(parent,
2987
print "Using last location: " + display_url
2989
remote_branch = Branch.open(other_branch)
2990
if remote_branch.base == local_branch.base:
2991
remote_branch = local_branch
2992
local_branch.lock_read()
2994
remote_branch.lock_read()
2996
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2997
if (log_format is None):
2998
log_format = log.log_formatter_registry.get_default(
3000
lf = log_format(to_file=self.outf,
3002
show_timezone='original')
3003
if reverse is False:
3004
local_extra.reverse()
3005
remote_extra.reverse()
3006
if local_extra and not theirs_only:
3007
print "You have %d extra revision(s):" % len(local_extra)
3008
for revision in iter_log_revisions(local_extra,
3009
local_branch.repository,
3011
lf.log_revision(revision)
3012
printed_local = True
3014
printed_local = False
3015
if remote_extra and not mine_only:
3016
if printed_local is True:
3018
print "You are missing %d revision(s):" % len(remote_extra)
3019
for revision in iter_log_revisions(remote_extra,
3020
remote_branch.repository,
3022
lf.log_revision(revision)
3023
if not remote_extra and not local_extra:
3025
print "Branches are up to date."
3029
remote_branch.unlock()
3031
local_branch.unlock()
3032
if not status_code and parent is None and other_branch is not None:
3033
local_branch.lock_write()
3035
# handle race conditions - a parent might be set while we run.
3036
if local_branch.get_parent() is None:
3037
local_branch.set_parent(remote_branch.base)
3039
local_branch.unlock()
3043
class cmd_plugins(Command):
3048
import bzrlib.plugin
3049
from inspect import getdoc
3050
for name, plugin in bzrlib.plugin.all_plugins().items():
3051
if getattr(plugin, '__path__', None) is not None:
3052
print plugin.__path__[0]
3053
elif getattr(plugin, '__file__', None) is not None:
3054
print plugin.__file__
3060
print '\t', d.split('\n')[0]
3063
class cmd_testament(Command):
3064
"""Show testament (signing-form) of a revision."""
3065
takes_options = ['revision',
3066
Option('long', help='Produce long-format testament'),
3067
Option('strict', help='Produce a strict-format'
3069
takes_args = ['branch?']
3071
def run(self, branch=u'.', revision=None, long=False, strict=False):
3072
from bzrlib.testament import Testament, StrictTestament
3074
testament_class = StrictTestament
3076
testament_class = Testament
3077
b = WorkingTree.open_containing(branch)[0].branch
3080
if revision is None:
3081
rev_id = b.last_revision()
3083
rev_id = revision[0].in_history(b).rev_id
3084
t = testament_class.from_revision(b.repository, rev_id)
3086
sys.stdout.writelines(t.as_text_lines())
3088
sys.stdout.write(t.as_short_text())
3093
class cmd_annotate(Command):
3094
"""Show the origin of each line in a file.
3096
This prints out the given file with an annotation on the left side
3097
indicating which revision, author and date introduced the change.
3099
If the origin is the same for a run of consecutive lines, it is
3100
shown only at the top, unless the --all option is given.
3102
# TODO: annotate directories; showing when each file was last changed
3103
# TODO: if the working copy is modified, show annotations on that
3104
# with new uncommitted lines marked
3105
aliases = ['ann', 'blame', 'praise']
3106
takes_args = ['filename']
3107
takes_options = [Option('all', help='show annotations on all lines'),
3108
Option('long', help='show date in annotations'),
3114
def run(self, filename, all=False, long=False, revision=None,
3116
from bzrlib.annotate import annotate_file
3117
tree, relpath = WorkingTree.open_containing(filename)
3118
branch = tree.branch
3121
if revision is None:
3122
revision_id = branch.last_revision()
3123
elif len(revision) != 1:
3124
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3126
revision_id = revision[0].in_history(branch).rev_id
3127
file_id = tree.path2id(relpath)
3129
raise errors.NotVersionedError(filename)
3130
tree = branch.repository.revision_tree(revision_id)
3131
file_version = tree.inventory[file_id].revision
3132
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
3138
class cmd_re_sign(Command):
3139
"""Create a digital signature for an existing revision."""
3140
# TODO be able to replace existing ones.
3142
hidden = True # is this right ?
3143
takes_args = ['revision_id*']
3144
takes_options = ['revision']
3146
def run(self, revision_id_list=None, revision=None):
3147
import bzrlib.gpg as gpg
3148
if revision_id_list is not None and revision is not None:
3149
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3150
if revision_id_list is None and revision is None:
3151
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3152
b = WorkingTree.open_containing(u'.')[0].branch
3153
gpg_strategy = gpg.GPGStrategy(b.get_config())
3154
if revision_id_list is not None:
3155
for revision_id in revision_id_list:
3156
b.repository.sign_revision(revision_id, gpg_strategy)
3157
elif revision is not None:
3158
if len(revision) == 1:
3159
revno, rev_id = revision[0].in_history(b)
3160
b.repository.sign_revision(rev_id, gpg_strategy)
3161
elif len(revision) == 2:
3162
# are they both on rh- if so we can walk between them
3163
# might be nice to have a range helper for arbitrary
3164
# revision paths. hmm.
3165
from_revno, from_revid = revision[0].in_history(b)
3166
to_revno, to_revid = revision[1].in_history(b)
3167
if to_revid is None:
3168
to_revno = b.revno()
3169
if from_revno is None or to_revno is None:
3170
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3171
for revno in range(from_revno, to_revno + 1):
3172
b.repository.sign_revision(b.get_rev_id(revno),
3175
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3178
class cmd_bind(Command):
3179
"""Convert the current branch into a checkout of the supplied branch.
3181
Once converted into a checkout, commits must succeed on the master branch
3182
before they will be applied to the local branch.
3185
_see_also = ['checkouts', 'unbind']
3186
takes_args = ['location?']
3189
def run(self, location=None):
3190
b, relpath = Branch.open_containing(u'.')
3191
if location is None:
3193
location = b.get_old_bound_location()
3194
except errors.UpgradeRequired:
3195
raise errors.BzrCommandError('No location supplied. '
3196
'This format does not remember old locations.')
3198
if location is None:
3199
raise errors.BzrCommandError('No location supplied and no '
3200
'previous location known')
3201
b_other = Branch.open(location)
3204
except errors.DivergedBranches:
3205
raise errors.BzrCommandError('These branches have diverged.'
3206
' Try merging, and then bind again.')
3209
class cmd_unbind(Command):
3210
"""Convert the current checkout into a regular branch.
3212
After unbinding, the local branch is considered independent and subsequent
3213
commits will be local only.
3216
_see_also = ['checkouts', 'bind']
3221
b, relpath = Branch.open_containing(u'.')
3223
raise errors.BzrCommandError('Local branch is not bound')
3226
class cmd_uncommit(Command):
3227
"""Remove the last committed revision.
3229
--verbose will print out what is being removed.
3230
--dry-run will go through all the motions, but not actually
3233
In the future, uncommit will create a revision bundle, which can then
3237
# TODO: jam 20060108 Add an option to allow uncommit to remove
3238
# unreferenced information in 'branch-as-repository' branches.
3239
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3240
# information in shared branches as well.
3241
_see_also = ['commit']
3242
takes_options = ['verbose', 'revision',
3243
Option('dry-run', help='Don\'t actually make changes'),
3244
Option('force', help='Say yes to all questions.')]
3245
takes_args = ['location?']
3248
def run(self, location=None,
3249
dry_run=False, verbose=False,
3250
revision=None, force=False):
3251
from bzrlib.log import log_formatter, show_log
3253
from bzrlib.uncommit import uncommit
3255
if location is None:
3257
control, relpath = bzrdir.BzrDir.open_containing(location)
3259
tree = control.open_workingtree()
3261
except (errors.NoWorkingTree, errors.NotLocalUrl):
3263
b = control.open_branch()
3266
if revision is None:
3269
# 'bzr uncommit -r 10' actually means uncommit
3270
# so that the final tree is at revno 10.
3271
# but bzrlib.uncommit.uncommit() actually uncommits
3272
# the revisions that are supplied.
3273
# So we need to offset it by one
3274
revno = revision[0].in_history(b).revno+1
3276
if revno <= b.revno():
3277
rev_id = b.get_rev_id(revno)
3279
self.outf.write('No revisions to uncommit.\n')
3282
lf = log_formatter('short',
3284
show_timezone='original')
3289
direction='forward',
3290
start_revision=revno,
3291
end_revision=b.revno())
3294
print 'Dry-run, pretending to remove the above revisions.'
3296
val = raw_input('Press <enter> to continue')
3298
print 'The above revision(s) will be removed.'
3300
val = raw_input('Are you sure [y/N]? ')
3301
if val.lower() not in ('y', 'yes'):
3305
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3309
class cmd_break_lock(Command):
3310
"""Break a dead lock on a repository, branch or working directory.
3312
CAUTION: Locks should only be broken when you are sure that the process
3313
holding the lock has been stopped.
3315
You can get information on what locks are open via the 'bzr info' command.
3320
takes_args = ['location?']
3322
def run(self, location=None, show=False):
3323
if location is None:
3325
control, relpath = bzrdir.BzrDir.open_containing(location)
3327
control.break_lock()
3328
except NotImplementedError:
3332
class cmd_wait_until_signalled(Command):
3333
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3335
This just prints a line to signal when it is ready, then blocks on stdin.
3341
sys.stdout.write("running\n")
3343
sys.stdin.readline()
3346
class cmd_serve(Command):
3347
"""Run the bzr server."""
3349
aliases = ['server']
3353
help='serve on stdin/out for use from inetd or sshd'),
3355
help='listen for connections on nominated port of the form '
3356
'[hostname:]portnumber. Passing 0 as the port number will '
3357
'result in a dynamically allocated port. Default port is '
3361
help='serve contents of directory',
3363
Option('allow-writes',
3364
help='By default the server is a readonly server. Supplying '
3365
'--allow-writes enables write access to the contents of '
3366
'the served directory and below. '
3370
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3371
from bzrlib.smart import medium, server
3372
from bzrlib.transport import get_transport
3373
from bzrlib.transport.chroot import ChrootServer
3374
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3375
if directory is None:
3376
directory = os.getcwd()
3377
url = urlutils.local_path_to_url(directory)
3378
if not allow_writes:
3379
url = 'readonly+' + url
3380
chroot_server = ChrootServer(get_transport(url))
3381
chroot_server.setUp()
3382
t = get_transport(chroot_server.get_url())
3384
smart_server = medium.SmartServerPipeStreamMedium(
3385
sys.stdin, sys.stdout, t)
3387
host = BZR_DEFAULT_INTERFACE
3389
port = BZR_DEFAULT_PORT
3392
host, port = port.split(':')
3394
smart_server = server.SmartTCPServer(t, host=host, port=port)
3395
print 'listening on port: ', smart_server.port
3397
# for the duration of this server, no UI output is permitted.
3398
# note that this may cause problems with blackbox tests. This should
3399
# be changed with care though, as we dont want to use bandwidth sending
3400
# progress over stderr to smart server clients!
3401
old_factory = ui.ui_factory
3403
ui.ui_factory = ui.SilentUIFactory()
3404
smart_server.serve()
3406
ui.ui_factory = old_factory
3409
class cmd_join(Command):
3410
"""Combine a subtree into its containing tree.
3412
This command is for experimental use only. It requires the target tree
3413
to be in dirstate-with-subtree format, which cannot be converted into
3416
The TREE argument should be an independent tree, inside another tree, but
3417
not part of it. (Such trees can be produced by "bzr split", but also by
3418
running "bzr branch" with the target inside a tree.)
3420
The result is a combined tree, with the subtree no longer an independant
3421
part. This is marked as a merge of the subtree into the containing tree,
3422
and all history is preserved.
3424
If --reference is specified, the subtree retains its independence. It can
3425
be branched by itself, and can be part of multiple projects at the same
3426
time. But operations performed in the containing tree, such as commit
3427
and merge, will recurse into the subtree.
3430
_see_also = ['split']
3431
takes_args = ['tree']
3432
takes_options = [Option('reference', 'join by reference')]
3435
def run(self, tree, reference=False):
3436
sub_tree = WorkingTree.open(tree)
3437
parent_dir = osutils.dirname(sub_tree.basedir)
3438
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3439
repo = containing_tree.branch.repository
3440
if not repo.supports_rich_root():
3441
raise errors.BzrCommandError(
3442
"Can't join trees because %s doesn't support rich root data.\n"
3443
"You can use bzr upgrade on the repository."
3447
containing_tree.add_reference(sub_tree)
3448
except errors.BadReferenceTarget, e:
3449
# XXX: Would be better to just raise a nicely printable
3450
# exception from the real origin. Also below. mbp 20070306
3451
raise errors.BzrCommandError("Cannot join %s. %s" %
3455
containing_tree.subsume(sub_tree)
3456
except errors.BadSubsumeSource, e:
3457
raise errors.BzrCommandError("Cannot join %s. %s" %
3461
class cmd_split(Command):
3462
"""Split a tree into two trees.
3464
This command is for experimental use only. It requires the target tree
3465
to be in dirstate-with-subtree format, which cannot be converted into
3468
The TREE argument should be a subdirectory of a working tree. That
3469
subdirectory will be converted into an independent tree, with its own
3470
branch. Commits in the top-level tree will not apply to the new subtree.
3471
If you want that behavior, do "bzr join --reference TREE".
3474
_see_also = ['join']
3475
takes_args = ['tree']
3479
def run(self, tree):
3480
containing_tree, subdir = WorkingTree.open_containing(tree)
3481
sub_id = containing_tree.path2id(subdir)
3483
raise errors.NotVersionedError(subdir)
3485
containing_tree.extract(sub_id)
3486
except errors.RootNotRich:
3487
raise errors.UpgradeRequired(containing_tree.branch.base)
3491
class cmd_merge_directive(Command):
3492
"""Generate a merge directive for auto-merge tools.
3494
A directive requests a merge to be performed, and also provides all the
3495
information necessary to do so. This means it must either include a
3496
revision bundle, or the location of a branch containing the desired
3499
A submit branch (the location to merge into) must be supplied the first
3500
time the command is issued. After it has been supplied once, it will
3501
be remembered as the default.
3503
A public branch is optional if a revision bundle is supplied, but required
3504
if --diff or --plain is specified. It will be remembered as the default
3505
after the first use.
3508
takes_args = ['submit_branch?', 'public_branch?']
3511
RegistryOption.from_kwargs('patch-type',
3512
'The type of patch to include in the directive',
3513
title='Patch type', value_switches=True, enum_switch=False,
3514
bundle='Bazaar revision bundle (default)',
3515
diff='Normal unified diff',
3516
plain='No patch, just directive'),
3517
Option('sign', help='GPG-sign the directive'), 'revision',
3518
Option('mail-to', type=str,
3519
help='Instead of printing the directive, email to this address'),
3520
Option('message', type=str, short_name='m',
3521
help='Message to use when committing this merge')
3524
encoding_type = 'exact'
3526
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3527
sign=False, revision=None, mail_to=None, message=None):
3528
from bzrlib.revision import ensure_null, NULL_REVISION
3529
if patch_type == 'plain':
3531
branch = Branch.open('.')
3532
stored_submit_branch = branch.get_submit_branch()
3533
if submit_branch is None:
3534
submit_branch = stored_submit_branch
3536
if stored_submit_branch is None:
3537
branch.set_submit_branch(submit_branch)
3538
if submit_branch is None:
3539
submit_branch = branch.get_parent()
3540
if submit_branch is None:
3541
raise errors.BzrCommandError('No submit branch specified or known')
3543
stored_public_branch = branch.get_public_branch()
3544
if public_branch is None:
3545
public_branch = stored_public_branch
3546
elif stored_public_branch is None:
3547
branch.set_public_branch(public_branch)
3548
if patch_type != "bundle" and public_branch is None:
3549
raise errors.BzrCommandError('No public branch specified or'
3551
if revision is not None:
3552
if len(revision) != 1:
3553
raise errors.BzrCommandError('bzr merge-directive takes '
3554
'exactly one revision identifier')
3556
revision_id = revision[0].in_history(branch).rev_id
3558
revision_id = branch.last_revision()
3559
revision_id = ensure_null(revision_id)
3560
if revision_id == NULL_REVISION:
3561
raise errors.BzrCommandError('No revisions to bundle.')
3562
directive = merge_directive.MergeDirective.from_objects(
3563
branch.repository, revision_id, time.time(),
3564
osutils.local_time_offset(), submit_branch,
3565
public_branch=public_branch, patch_type=patch_type,
3569
self.outf.write(directive.to_signed(branch))
3571
self.outf.writelines(directive.to_lines())
3573
message = directive.to_email(mail_to, branch, sign)
3574
s = SMTPConnection(branch.get_config())
3575
s.send_email(message)
3578
class cmd_tag(Command):
3579
"""Create a tag naming a revision.
3581
Tags give human-meaningful names to revisions. Commands that take a -r
3582
(--revision) option can be given -rtag:X, where X is any previously
3585
Tags are stored in the branch. Tags are copied from one branch to another
3586
along when you branch, push, pull or merge.
3588
It is an error to give a tag name that already exists unless you pass
3589
--force, in which case the tag is moved to point to the new revision.
3592
_see_also = ['commit', 'tags']
3593
takes_args = ['tag_name']
3596
help='Delete this tag rather than placing it.',
3599
help='Branch in which to place the tag.',
3604
help='Replace existing tags',
3609
def run(self, tag_name,
3615
branch, relpath = Branch.open_containing(directory)
3619
branch.tags.delete_tag(tag_name)
3620
self.outf.write('Deleted tag %s.\n' % tag_name)
3623
if len(revision) != 1:
3624
raise errors.BzrCommandError(
3625
"Tags can only be placed on a single revision, "
3627
revision_id = revision[0].in_history(branch).rev_id
3629
revision_id = branch.last_revision()
3630
if (not force) and branch.tags.has_tag(tag_name):
3631
raise errors.TagAlreadyExists(tag_name)
3632
branch.tags.set_tag(tag_name, revision_id)
3633
self.outf.write('Created tag %s.\n' % tag_name)
3638
class cmd_tags(Command):
3641
This tag shows a table of tag names and the revisions they reference.
3647
help='Branch whose tags should be displayed',
3657
branch, relpath = Branch.open_containing(directory)
3658
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3659
self.outf.write('%-20s %s\n' % (tag_name, target))
3662
# command-line interpretation helper for merge-related commands
3663
def _merge_helper(other_revision, base_revision,
3664
check_clean=True, ignore_zero=False,
3665
this_dir=None, backup_files=False,
3667
file_list=None, show_base=False, reprocess=False,
3670
change_reporter=None,
3672
"""Merge changes into a tree.
3675
list(path, revno) Base for three-way merge.
3676
If [None, None] then a base will be automatically determined.
3678
list(path, revno) Other revision for three-way merge.
3680
Directory to merge changes into; '.' by default.
3682
If true, this_dir must have no uncommitted changes before the
3684
ignore_zero - If true, suppress the "zero conflicts" message when
3685
there are no conflicts; should be set when doing something we expect
3686
to complete perfectly.
3687
file_list - If supplied, merge only changes to selected files.
3689
All available ancestors of other_revision and base_revision are
3690
automatically pulled into the branch.
3692
The revno may be -1 to indicate the last revision on the branch, which is
3695
This function is intended for use from the command line; programmatic
3696
clients might prefer to call merge.merge_inner(), which has less magic
3699
# Loading it late, so that we don't always have to import bzrlib.merge
3700
if merge_type is None:
3701
merge_type = _mod_merge.Merge3Merger
3702
if this_dir is None:
3704
this_tree = WorkingTree.open_containing(this_dir)[0]
3705
if show_base and not merge_type is _mod_merge.Merge3Merger:
3706
raise errors.BzrCommandError("Show-base is not supported for this merge"
3707
" type. %s" % merge_type)
3708
if reprocess and not merge_type.supports_reprocess:
3709
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3710
" type %s." % merge_type)
3711
if reprocess and show_base:
3712
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3713
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3714
# only want to take out a lock_tree_write() if we don't have to pull
3715
# any ancestry. But merge might fetch ancestry in the middle, in
3716
# which case we would need a lock_write().
3717
# Because we cannot upgrade locks, for now we live with the fact that
3718
# the tree will be locked multiple times during a merge. (Maybe
3719
# read-only some of the time, but it means things will get read
3722
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3723
pb=pb, change_reporter=change_reporter)
3724
merger.pp = ProgressPhase("Merge phase", 5, pb)
3725
merger.pp.next_phase()
3726
merger.check_basis(check_clean)
3727
if other_rev_id is not None:
3728
merger.set_other_revision(other_rev_id, this_tree.branch)
3730
merger.set_other(other_revision)
3731
merger.pp.next_phase()
3732
merger.set_base(base_revision)
3733
if merger.base_rev_id == merger.other_rev_id:
3734
note('Nothing to do.')
3736
if file_list is None:
3737
if pull and merger.base_rev_id == merger.this_rev_id:
3738
# FIXME: deduplicate with pull
3739
result = merger.this_tree.pull(merger.this_branch,
3740
False, merger.other_rev_id)
3741
if result.old_revid == result.new_revid:
3742
note('No revisions to pull.')
3744
note('Now on revision %d.' % result.new_revno)
3746
merger.backup_files = backup_files
3747
merger.merge_type = merge_type
3748
merger.set_interesting_files(file_list)
3749
merger.show_base = show_base
3750
merger.reprocess = reprocess
3751
conflicts = merger.do_merge()
3752
if file_list is None:
3753
merger.set_pending()
3759
def _create_prefix(cur_transport):
3760
needed = [cur_transport]
3761
# Recurse upwards until we can create a directory successfully
3763
new_transport = cur_transport.clone('..')
3764
if new_transport.base == cur_transport.base:
3765
raise errors.BzrCommandError("Failed to create path"
3769
new_transport.mkdir('.')
3770
except errors.NoSuchFile:
3771
needed.append(new_transport)
3772
cur_transport = new_transport
3776
# Now we only need to create child directories
3778
cur_transport = needed.pop()
3779
cur_transport.ensure_base()
3782
merge = _merge_helper
3785
# these get imported and then picked up by the scan for cmd_*
3786
# TODO: Some more consistent way to split command definitions across files;
3787
# we do need to load at least some information about them to know of
3788
# aliases. ideally we would avoid loading the implementation until the
3789
# details were needed.
3790
from bzrlib.cmd_version_info import cmd_version_info
3791
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3792
from bzrlib.bundle.commands import cmd_bundle_revisions
3793
from bzrlib.sign_my_commits import cmd_sign_my_commits
3794
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
3795
cmd_weave_plan_merge, cmd_weave_merge_text