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(), """
47
revision as _mod_revision,
55
from bzrlib.branch import Branch
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, custom_help
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', 'change',
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
if revision and len(revision) > 2:
184
raise errors.BzrCommandError('bzr status --revision takes exactly'
185
' one or two revision specifiers')
187
tree, file_list = tree_files(file_list)
189
show_tree_status(tree, show_ids=show_ids,
190
specific_files=file_list, revision=revision,
191
to_file=self.outf, short=short, versioned=versioned)
194
class cmd_cat_revision(Command):
195
"""Write out metadata for a revision.
197
The revision to print can either be specified by a specific
198
revision identifier, or you can use --revision.
202
takes_args = ['revision_id?']
203
takes_options = ['revision']
204
# cat-revision is more for frontends so should be exact
208
def run(self, revision_id=None, revision=None):
210
revision_id = osutils.safe_revision_id(revision_id, warn=False)
211
if revision_id is not None and revision is not None:
212
raise errors.BzrCommandError('You can only supply one of'
213
' revision_id or --revision')
214
if revision_id is None and revision is None:
215
raise errors.BzrCommandError('You must supply either'
216
' --revision or a revision_id')
217
b = WorkingTree.open_containing(u'.')[0].branch
219
# TODO: jam 20060112 should cat-revision always output utf-8?
220
if revision_id is not None:
221
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
222
elif revision is not None:
225
raise errors.BzrCommandError('You cannot specify a NULL'
227
revno, rev_id = rev.in_history(b)
228
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
231
class cmd_remove_tree(Command):
232
"""Remove the working tree from a given branch/checkout.
234
Since a lightweight checkout is little more than a working tree
235
this will refuse to run against one.
237
To re-create the working tree, use "bzr checkout".
239
_see_also = ['checkout', 'working-trees']
241
takes_args = ['location?']
243
def run(self, location='.'):
244
d = bzrdir.BzrDir.open(location)
247
working = d.open_workingtree()
248
except errors.NoWorkingTree:
249
raise errors.BzrCommandError("No working tree to remove")
250
except errors.NotLocalUrl:
251
raise errors.BzrCommandError("You cannot remove the working tree of a "
254
working_path = working.bzrdir.root_transport.base
255
branch_path = working.branch.bzrdir.root_transport.base
256
if working_path != branch_path:
257
raise errors.BzrCommandError("You cannot remove the working tree from "
258
"a lightweight checkout")
260
d.destroy_workingtree()
263
class cmd_revno(Command):
264
"""Show current revision number.
266
This is equal to the number of revisions on this branch.
270
takes_args = ['location?']
273
def run(self, location=u'.'):
274
self.outf.write(str(Branch.open_containing(location)[0].revno()))
275
self.outf.write('\n')
278
class cmd_revision_info(Command):
279
"""Show revision number and revision id for a given revision identifier.
282
takes_args = ['revision_info*']
283
takes_options = ['revision']
286
def run(self, revision=None, revision_info_list=[]):
289
if revision is not None:
290
revs.extend(revision)
291
if revision_info_list is not None:
292
for rev in revision_info_list:
293
revs.append(RevisionSpec.from_string(rev))
295
b = Branch.open_containing(u'.')[0]
298
revs.append(RevisionSpec.from_string('-1'))
301
revinfo = rev.in_history(b)
302
if revinfo.revno is None:
303
dotted_map = b.get_revision_id_to_revno_map()
304
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
305
print '%s %s' % (revno, revinfo.rev_id)
307
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
310
class cmd_add(Command):
311
"""Add specified files or directories.
313
In non-recursive mode, all the named items are added, regardless
314
of whether they were previously ignored. A warning is given if
315
any of the named files are already versioned.
317
In recursive mode (the default), files are treated the same way
318
but the behaviour for directories is different. Directories that
319
are already versioned do not give a warning. All directories,
320
whether already versioned or not, are searched for files or
321
subdirectories that are neither versioned or ignored, and these
322
are added. This search proceeds recursively into versioned
323
directories. If no names are given '.' is assumed.
325
Therefore simply saying 'bzr add' will version all files that
326
are currently unknown.
328
Adding a file whose parent directory is not versioned will
329
implicitly add the parent, and so on up to the root. This means
330
you should never need to explicitly add a directory, they'll just
331
get added when you add a file in the directory.
333
--dry-run will show which files would be added, but not actually
336
--file-ids-from will try to use the file ids from the supplied path.
337
It looks up ids trying to find a matching parent directory with the
338
same filename, and then by pure path. This option is rarely needed
339
but can be useful when adding the same logical file into two
340
branches that will be merged later (without showing the two different
341
adds as a conflict). It is also useful when merging another project
342
into a subdirectory of this one.
344
takes_args = ['file*']
347
help="Don't recursively add the contents of directories."),
349
help="Show what would be done, but don't actually do anything."),
351
Option('file-ids-from',
353
help='Lookup file ids from this tree.'),
355
encoding_type = 'replace'
356
_see_also = ['remove']
358
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
363
if file_ids_from is not None:
365
base_tree, base_path = WorkingTree.open_containing(
367
except errors.NoWorkingTree:
368
base_branch, base_path = Branch.open_containing(
370
base_tree = base_branch.basis_tree()
372
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
373
to_file=self.outf, should_print=(not is_quiet()))
375
action = bzrlib.add.AddAction(to_file=self.outf,
376
should_print=(not is_quiet()))
379
base_tree.lock_read()
381
file_list = self._maybe_expand_globs(file_list)
383
tree = WorkingTree.open_containing(file_list[0])[0]
385
tree = WorkingTree.open_containing(u'.')[0]
386
added, ignored = tree.smart_add(file_list, not
387
no_recurse, action=action, save=not dry_run)
389
if base_tree is not None:
393
for glob in sorted(ignored.keys()):
394
for path in ignored[glob]:
395
self.outf.write("ignored %s matching \"%s\"\n"
399
for glob, paths in ignored.items():
400
match_len += len(paths)
401
self.outf.write("ignored %d file(s).\n" % match_len)
402
self.outf.write("If you wish to add some of these files,"
403
" please add them by name.\n")
406
class cmd_mkdir(Command):
407
"""Create a new versioned directory.
409
This is equivalent to creating the directory and then adding it.
412
takes_args = ['dir+']
413
encoding_type = 'replace'
415
def run(self, dir_list):
418
wt, dd = WorkingTree.open_containing(d)
420
self.outf.write('added %s\n' % d)
423
class cmd_relpath(Command):
424
"""Show path of a file relative to root"""
426
takes_args = ['filename']
430
def run(self, filename):
431
# TODO: jam 20050106 Can relpath return a munged path if
432
# sys.stdout encoding cannot represent it?
433
tree, relpath = WorkingTree.open_containing(filename)
434
self.outf.write(relpath)
435
self.outf.write('\n')
438
class cmd_inventory(Command):
439
"""Show inventory of the current working copy or a revision.
441
It is possible to limit the output to a particular entry
442
type using the --kind option. For example: --kind file.
444
It is also possible to restrict the list of files to a specific
445
set. For example: bzr inventory --show-ids this/file
454
help='List entries of a particular kind: file, directory, symlink.',
457
takes_args = ['file*']
460
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
461
if kind and kind not in ['file', 'directory', 'symlink']:
462
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
464
work_tree, file_list = tree_files(file_list)
465
work_tree.lock_read()
467
if revision is not None:
468
if len(revision) > 1:
469
raise errors.BzrCommandError(
470
'bzr inventory --revision takes exactly one revision'
472
revision_id = revision[0].in_history(work_tree.branch).rev_id
473
tree = work_tree.branch.repository.revision_tree(revision_id)
475
extra_trees = [work_tree]
481
if file_list is not None:
482
file_ids = tree.paths2ids(file_list, trees=extra_trees,
483
require_versioned=True)
484
# find_ids_across_trees may include some paths that don't
486
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
487
for file_id in file_ids if file_id in tree)
489
entries = tree.inventory.entries()
492
if tree is not work_tree:
495
for path, entry in entries:
496
if kind and kind != entry.kind:
499
self.outf.write('%-50s %s\n' % (path, entry.file_id))
501
self.outf.write(path)
502
self.outf.write('\n')
505
class cmd_mv(Command):
506
"""Move or rename a file.
509
bzr mv OLDNAME NEWNAME
511
bzr mv SOURCE... DESTINATION
513
If the last argument is a versioned directory, all the other names
514
are moved into it. Otherwise, there must be exactly two arguments
515
and the file is changed to a new name.
517
If OLDNAME does not exist on the filesystem but is versioned and
518
NEWNAME does exist on the filesystem but is not versioned, mv
519
assumes that the file has been manually moved and only updates
520
its internal inventory to reflect that change.
521
The same is valid when moving many SOURCE files to a DESTINATION.
523
Files cannot be moved between branches.
526
takes_args = ['names*']
527
takes_options = [Option("after", help="Move only the bzr identifier"
528
" of the file, because the file has already been moved."),
530
aliases = ['move', 'rename']
531
encoding_type = 'replace'
533
def run(self, names_list, after=False):
534
if names_list is None:
537
if len(names_list) < 2:
538
raise errors.BzrCommandError("missing file argument")
539
tree, rel_names = tree_files(names_list)
541
if os.path.isdir(names_list[-1]):
542
# move into existing directory
543
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
544
self.outf.write("%s => %s\n" % pair)
546
if len(names_list) != 2:
547
raise errors.BzrCommandError('to mv multiple files the'
548
' destination must be a versioned'
550
tree.rename_one(rel_names[0], rel_names[1], after=after)
551
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
554
class cmd_pull(Command):
555
"""Turn this branch into a mirror of another branch.
557
This command only works on branches that have not diverged. Branches are
558
considered diverged if the destination branch's most recent commit is one
559
that has not been merged (directly or indirectly) into the parent.
561
If branches have diverged, you can use 'bzr merge' to integrate the changes
562
from one into the other. Once one branch has merged, the other should
563
be able to pull it again.
565
If you want to forget your local changes and just update your branch to
566
match the remote one, use pull --overwrite.
568
If there is no default location set, the first pull will set it. After
569
that, you can omit the location to use the default. To change the
570
default, use --remember. The value will only be saved if the remote
571
location can be accessed.
574
_see_also = ['push', 'update', 'status-flags']
575
takes_options = ['remember', 'overwrite', 'revision',
576
custom_help('verbose',
577
help='Show logs of pulled revisions.'),
579
help='Branch to pull into, '
580
'rather than the one containing the working directory.',
585
takes_args = ['location?']
586
encoding_type = 'replace'
588
def run(self, location=None, remember=False, overwrite=False,
589
revision=None, verbose=False,
591
# FIXME: too much stuff is in the command class
594
if directory is None:
597
tree_to = WorkingTree.open_containing(directory)[0]
598
branch_to = tree_to.branch
599
except errors.NoWorkingTree:
601
branch_to = Branch.open_containing(directory)[0]
603
if location is not None:
604
mergeable, location_transport = _get_mergeable_helper(location)
606
stored_loc = branch_to.get_parent()
608
if stored_loc is None:
609
raise errors.BzrCommandError("No pull location known or"
612
display_url = urlutils.unescape_for_display(stored_loc,
614
self.outf.write("Using saved location: %s\n" % display_url)
615
location = stored_loc
616
location_transport = transport.get_transport(location)
618
if mergeable is not None:
619
if revision is not None:
620
raise errors.BzrCommandError(
621
'Cannot use -r with merge directives or bundles')
622
mergeable.install_revisions(branch_to.repository)
623
base_revision_id, revision_id, verified = \
624
mergeable.get_merge_request(branch_to.repository)
625
branch_from = branch_to
627
branch_from = Branch.open_from_transport(location_transport)
629
if branch_to.get_parent() is None or remember:
630
branch_to.set_parent(branch_from.base)
632
if revision is not None:
633
if len(revision) == 1:
634
revision_id = revision[0].in_history(branch_from).rev_id
636
raise errors.BzrCommandError(
637
'bzr pull --revision takes one value.')
640
old_rh = branch_to.revision_history()
641
if tree_to is not None:
642
result = tree_to.pull(branch_from, overwrite, revision_id,
643
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
645
result = branch_to.pull(branch_from, overwrite, revision_id)
647
result.report(self.outf)
649
new_rh = branch_to.revision_history()
650
log.show_changed_revisions(branch_to, old_rh, new_rh,
654
class cmd_push(Command):
655
"""Update a mirror of this branch.
657
The target branch will not have its working tree populated because this
658
is both expensive, and is not supported on remote file systems.
660
Some smart servers or protocols *may* put the working tree in place in
663
This command only works on branches that have not diverged. Branches are
664
considered diverged if the destination branch's most recent commit is one
665
that has not been merged (directly or indirectly) by the source branch.
667
If branches have diverged, you can use 'bzr push --overwrite' to replace
668
the other branch completely, discarding its unmerged changes.
670
If you want to ensure you have the different changes in the other branch,
671
do a merge (see bzr help merge) from the other branch, and commit that.
672
After that you will be able to do a push without '--overwrite'.
674
If there is no default push location set, the first push will set it.
675
After that, you can omit the location to use the default. To change the
676
default, use --remember. The value will only be saved if the remote
677
location can be accessed.
680
_see_also = ['pull', 'update', 'working-trees']
681
takes_options = ['remember', 'overwrite', 'verbose',
682
Option('create-prefix',
683
help='Create the path leading up to the branch '
684
'if it does not already exist.'),
686
help='Branch to push from, '
687
'rather than the one containing the working directory.',
691
Option('use-existing-dir',
692
help='By default push will fail if the target'
693
' directory exists, but does not already'
694
' have a control directory. This flag will'
695
' allow push to proceed.'),
697
takes_args = ['location?']
698
encoding_type = 'replace'
700
def run(self, location=None, remember=False, overwrite=False,
701
create_prefix=False, verbose=False,
702
use_existing_dir=False,
704
# FIXME: Way too big! Put this into a function called from the
706
if directory is None:
708
br_from = Branch.open_containing(directory)[0]
709
stored_loc = br_from.get_push_location()
711
if stored_loc is None:
712
raise errors.BzrCommandError("No push location known or specified.")
714
display_url = urlutils.unescape_for_display(stored_loc,
716
self.outf.write("Using saved location: %s\n" % display_url)
717
location = stored_loc
719
to_transport = transport.get_transport(location)
721
br_to = repository_to = dir_to = None
723
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
724
except errors.NotBranchError:
725
pass # Didn't find anything
727
# If we can open a branch, use its direct repository, otherwise see
728
# if there is a repository without a branch.
730
br_to = dir_to.open_branch()
731
except errors.NotBranchError:
732
# Didn't find a branch, can we find a repository?
734
repository_to = dir_to.find_repository()
735
except errors.NoRepositoryPresent:
738
# Found a branch, so we must have found a repository
739
repository_to = br_to.repository
744
# The destination doesn't exist; create it.
745
# XXX: Refactor the create_prefix/no_create_prefix code into a
746
# common helper function
748
to_transport.mkdir('.')
749
except errors.FileExists:
750
if not use_existing_dir:
751
raise errors.BzrCommandError("Target directory %s"
752
" already exists, but does not have a valid .bzr"
753
" directory. Supply --use-existing-dir to push"
754
" there anyway." % location)
755
except errors.NoSuchFile:
756
if not create_prefix:
757
raise errors.BzrCommandError("Parent directory of %s"
759
"\nYou may supply --create-prefix to create all"
760
" leading parent directories."
762
_create_prefix(to_transport)
764
# Now the target directory exists, but doesn't have a .bzr
765
# directory. So we need to create it, along with any work to create
766
# all of the dependent branches, etc.
767
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
768
revision_id=br_from.last_revision())
769
br_to = dir_to.open_branch()
770
# TODO: Some more useful message about what was copied
771
note('Created new branch.')
772
# We successfully created the target, remember it
773
if br_from.get_push_location() is None or remember:
774
br_from.set_push_location(br_to.base)
775
elif repository_to is None:
776
# we have a bzrdir but no branch or repository
777
# XXX: Figure out what to do other than complain.
778
raise errors.BzrCommandError("At %s you have a valid .bzr control"
779
" directory, but not a branch or repository. This is an"
780
" unsupported configuration. Please move the target directory"
781
" out of the way and try again."
784
# We have a repository but no branch, copy the revisions, and then
786
last_revision_id = br_from.last_revision()
787
repository_to.fetch(br_from.repository,
788
revision_id=last_revision_id)
789
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
790
note('Created new branch.')
791
if br_from.get_push_location() is None or remember:
792
br_from.set_push_location(br_to.base)
793
else: # We have a valid to branch
794
# We were able to connect to the remote location, so remember it
795
# we don't need to successfully push because of possible divergence.
796
if br_from.get_push_location() is None or remember:
797
br_from.set_push_location(br_to.base)
799
old_rh = br_to.revision_history()
802
tree_to = dir_to.open_workingtree()
803
except errors.NotLocalUrl:
804
warning("This transport does not update the working "
805
"tree of: %s. See 'bzr help working-trees' for "
806
"more information." % br_to.base)
807
push_result = br_from.push(br_to, overwrite)
808
except errors.NoWorkingTree:
809
push_result = br_from.push(br_to, overwrite)
813
push_result = br_from.push(tree_to.branch, overwrite)
817
except errors.DivergedBranches:
818
raise errors.BzrCommandError('These branches have diverged.'
819
' Try using "merge" and then "push".')
820
if push_result is not None:
821
push_result.report(self.outf)
823
new_rh = br_to.revision_history()
826
from bzrlib.log import show_changed_revisions
827
show_changed_revisions(br_to, old_rh, new_rh,
830
# we probably did a clone rather than a push, so a message was
835
class cmd_branch(Command):
836
"""Create a new copy of a branch.
838
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
839
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
840
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
841
is derived from the FROM_LOCATION by stripping a leading scheme or drive
842
identifier, if any. For example, "branch lp:foo-bar" will attempt to
845
To retrieve the branch as of a particular revision, supply the --revision
846
parameter, as in "branch foo/bar -r 5".
849
_see_also = ['checkout']
850
takes_args = ['from_location', 'to_location?']
851
takes_options = ['revision']
852
aliases = ['get', 'clone']
854
def run(self, from_location, to_location=None, revision=None):
855
from bzrlib.tag import _merge_tags_if_possible
858
elif len(revision) > 1:
859
raise errors.BzrCommandError(
860
'bzr branch --revision takes exactly 1 revision value')
862
br_from = Branch.open(from_location)
865
if len(revision) == 1 and revision[0] is not None:
866
revision_id = revision[0].in_history(br_from)[1]
868
# FIXME - wt.last_revision, fallback to branch, fall back to
869
# None or perhaps NULL_REVISION to mean copy nothing
871
revision_id = br_from.last_revision()
872
if to_location is None:
873
to_location = urlutils.derive_to_location(from_location)
876
name = os.path.basename(to_location) + '\n'
878
to_transport = transport.get_transport(to_location)
880
to_transport.mkdir('.')
881
except errors.FileExists:
882
raise errors.BzrCommandError('Target directory "%s" already'
883
' exists.' % to_location)
884
except errors.NoSuchFile:
885
raise errors.BzrCommandError('Parent of "%s" does not exist.'
888
# preserve whatever source format we have.
889
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
890
possible_transports=[to_transport])
891
branch = dir.open_branch()
892
except errors.NoSuchRevision:
893
to_transport.delete_tree('.')
894
msg = "The branch %s has no revision %s." % (from_location, revision[0])
895
raise errors.BzrCommandError(msg)
897
branch.control_files.put_utf8('branch-name', name)
898
_merge_tags_if_possible(br_from, branch)
899
note('Branched %d revision(s).' % branch.revno())
904
class cmd_checkout(Command):
905
"""Create a new checkout of an existing branch.
907
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
908
the branch found in '.'. This is useful if you have removed the working tree
909
or if it was never created - i.e. if you pushed the branch to its current
912
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
913
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
914
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
915
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
916
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
919
To retrieve the branch as of a particular revision, supply the --revision
920
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
921
out of date [so you cannot commit] but it may be useful (i.e. to examine old
925
_see_also = ['checkouts', 'branch']
926
takes_args = ['branch_location?', 'to_location?']
927
takes_options = ['revision',
928
Option('lightweight',
929
help="Perform a lightweight checkout. Lightweight "
930
"checkouts depend on access to the branch for "
931
"every operation. Normal checkouts can perform "
932
"common operations like diff and status without "
933
"such access, and also support local commits."
938
def run(self, branch_location=None, to_location=None, revision=None,
942
elif len(revision) > 1:
943
raise errors.BzrCommandError(
944
'bzr checkout --revision takes exactly 1 revision value')
945
if branch_location is None:
946
branch_location = osutils.getcwd()
947
to_location = branch_location
948
source = Branch.open(branch_location)
949
if len(revision) == 1 and revision[0] is not None:
950
revision_id = _mod_revision.ensure_null(
951
revision[0].in_history(source)[1])
954
if to_location is None:
955
to_location = urlutils.derive_to_location(branch_location)
956
# if the source and to_location are the same,
957
# and there is no working tree,
958
# then reconstitute a branch
959
if (osutils.abspath(to_location) ==
960
osutils.abspath(branch_location)):
962
source.bzrdir.open_workingtree()
963
except errors.NoWorkingTree:
964
source.bzrdir.create_workingtree(revision_id)
966
source.create_checkout(to_location, revision_id, lightweight)
969
class cmd_renames(Command):
970
"""Show list of renamed files.
972
# TODO: Option to show renames between two historical versions.
974
# TODO: Only show renames under dir, rather than in the whole branch.
975
_see_also = ['status']
976
takes_args = ['dir?']
979
def run(self, dir=u'.'):
980
tree = WorkingTree.open_containing(dir)[0]
983
new_inv = tree.inventory
984
old_tree = tree.basis_tree()
987
old_inv = old_tree.inventory
988
renames = list(_mod_tree.find_renames(old_inv, new_inv))
990
for old_name, new_name in renames:
991
self.outf.write("%s => %s\n" % (old_name, new_name))
998
class cmd_update(Command):
999
"""Update a tree to have the latest code committed to its branch.
1001
This will perform a merge into the working tree, and may generate
1002
conflicts. If you have any local changes, you will still
1003
need to commit them after the update for the update to be complete.
1005
If you want to discard your local changes, you can just do a
1006
'bzr revert' instead of 'bzr commit' after the update.
1009
_see_also = ['pull', 'working-trees', 'status-flags']
1010
takes_args = ['dir?']
1013
def run(self, dir='.'):
1014
tree = WorkingTree.open_containing(dir)[0]
1015
master = tree.branch.get_master_branch()
1016
if master is not None:
1019
tree.lock_tree_write()
1021
existing_pending_merges = tree.get_parent_ids()[1:]
1022
last_rev = _mod_revision.ensure_null(tree.last_revision())
1023
if last_rev == _mod_revision.ensure_null(
1024
tree.branch.last_revision()):
1025
# may be up to date, check master too.
1026
if master is None or last_rev == _mod_revision.ensure_null(
1027
master.last_revision()):
1028
revno = tree.branch.revision_id_to_revno(last_rev)
1029
note("Tree is up to date at revision %d." % (revno,))
1031
conflicts = tree.update(delta._ChangeReporter(
1032
unversioned_filter=tree.is_ignored))
1033
revno = tree.branch.revision_id_to_revno(
1034
_mod_revision.ensure_null(tree.last_revision()))
1035
note('Updated to revision %d.' % (revno,))
1036
if tree.get_parent_ids()[1:] != existing_pending_merges:
1037
note('Your local commits will now show as pending merges with '
1038
"'bzr status', and can be committed with 'bzr commit'.")
1047
class cmd_info(Command):
1048
"""Show information about a working tree, branch or repository.
1050
This command will show all known locations and formats associated to the
1051
tree, branch or repository. Statistical information is included with
1054
Branches and working trees will also report any missing revisions.
1056
_see_also = ['revno', 'working-trees', 'repositories']
1057
takes_args = ['location?']
1058
takes_options = ['verbose']
1061
def run(self, location=None, verbose=False):
1066
from bzrlib.info import show_bzrdir_info
1067
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1068
verbose=noise_level)
1071
class cmd_remove(Command):
1072
"""Remove files or directories.
1074
This makes bzr stop tracking changes to the specified files and
1075
delete them if they can easily be recovered using revert.
1077
You can specify one or more files, and/or --new. If you specify --new,
1078
only 'added' files will be removed. If you specify both, then new files
1079
in the specified directories will be removed. If the directories are
1080
also new, they will also be removed.
1082
takes_args = ['file*']
1083
takes_options = ['verbose',
1084
Option('new', help='Remove newly-added files.'),
1085
RegistryOption.from_kwargs('file-deletion-strategy',
1086
'The file deletion mode to be used.',
1087
title='Deletion Strategy', value_switches=True, enum_switch=False,
1088
safe='Only delete files if they can be'
1089
' safely recovered (default).',
1090
keep="Don't delete any files.",
1091
force='Delete all the specified files, even if they can not be '
1092
'recovered and even if they are non-empty directories.')]
1094
encoding_type = 'replace'
1096
def run(self, file_list, verbose=False, new=False,
1097
file_deletion_strategy='safe'):
1098
tree, file_list = tree_files(file_list)
1100
if file_list is not None:
1101
file_list = [f for f in file_list if f != '']
1103
raise errors.BzrCommandError('Specify one or more files to'
1104
' remove, or use --new.')
1107
added = tree.changes_from(tree.basis_tree(),
1108
specific_files=file_list).added
1109
file_list = sorted([f[0] for f in added], reverse=True)
1110
if len(file_list) == 0:
1111
raise errors.BzrCommandError('No matching files.')
1112
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1113
keep_files=file_deletion_strategy=='keep',
1114
force=file_deletion_strategy=='force')
1117
class cmd_file_id(Command):
1118
"""Print file_id of a particular file or directory.
1120
The file_id is assigned when the file is first added and remains the
1121
same through all revisions where the file exists, even when it is
1126
_see_also = ['inventory', 'ls']
1127
takes_args = ['filename']
1130
def run(self, filename):
1131
tree, relpath = WorkingTree.open_containing(filename)
1132
i = tree.path2id(relpath)
1134
raise errors.NotVersionedError(filename)
1136
self.outf.write(i + '\n')
1139
class cmd_file_path(Command):
1140
"""Print path of file_ids to a file or directory.
1142
This prints one line for each directory down to the target,
1143
starting at the branch root.
1147
takes_args = ['filename']
1150
def run(self, filename):
1151
tree, relpath = WorkingTree.open_containing(filename)
1152
fid = tree.path2id(relpath)
1154
raise errors.NotVersionedError(filename)
1155
segments = osutils.splitpath(relpath)
1156
for pos in range(1, len(segments) + 1):
1157
path = osutils.joinpath(segments[:pos])
1158
self.outf.write("%s\n" % tree.path2id(path))
1161
class cmd_reconcile(Command):
1162
"""Reconcile bzr metadata in a branch.
1164
This can correct data mismatches that may have been caused by
1165
previous ghost operations or bzr upgrades. You should only
1166
need to run this command if 'bzr check' or a bzr developer
1167
advises you to run it.
1169
If a second branch is provided, cross-branch reconciliation is
1170
also attempted, which will check that data like the tree root
1171
id which was not present in very early bzr versions is represented
1172
correctly in both branches.
1174
At the same time it is run it may recompress data resulting in
1175
a potential saving in disk space or performance gain.
1177
The branch *MUST* be on a listable system such as local disk or sftp.
1180
_see_also = ['check']
1181
takes_args = ['branch?']
1183
def run(self, branch="."):
1184
from bzrlib.reconcile import reconcile
1185
dir = bzrdir.BzrDir.open(branch)
1189
class cmd_revision_history(Command):
1190
"""Display the list of revision ids on a branch."""
1193
takes_args = ['location?']
1198
def run(self, location="."):
1199
branch = Branch.open_containing(location)[0]
1200
for revid in branch.revision_history():
1201
self.outf.write(revid)
1202
self.outf.write('\n')
1205
class cmd_ancestry(Command):
1206
"""List all revisions merged into this branch."""
1208
_see_also = ['log', 'revision-history']
1209
takes_args = ['location?']
1214
def run(self, location="."):
1216
wt = WorkingTree.open_containing(location)[0]
1217
except errors.NoWorkingTree:
1218
b = Branch.open(location)
1219
last_revision = b.last_revision()
1222
last_revision = wt.last_revision()
1224
revision_ids = b.repository.get_ancestry(last_revision)
1225
assert revision_ids[0] is None
1227
for revision_id in revision_ids:
1228
self.outf.write(revision_id + '\n')
1231
class cmd_init(Command):
1232
"""Make a directory into a versioned branch.
1234
Use this to create an empty branch, or before importing an
1237
If there is a repository in a parent directory of the location, then
1238
the history of the branch will be stored in the repository. Otherwise
1239
init creates a standalone branch which carries its own history
1240
in the .bzr directory.
1242
If there is already a branch at the location but it has no working tree,
1243
the tree can be populated with 'bzr checkout'.
1245
Recipe for importing a tree of files::
1251
bzr commit -m 'imported project'
1254
_see_also = ['init-repository', 'branch', 'checkout']
1255
takes_args = ['location?']
1257
Option('create-prefix',
1258
help='Create the path leading up to the branch '
1259
'if it does not already exist.'),
1260
RegistryOption('format',
1261
help='Specify a format for this branch. '
1262
'See "help formats".',
1263
registry=bzrdir.format_registry,
1264
converter=bzrdir.format_registry.make_bzrdir,
1265
value_switches=True,
1266
title="Branch Format",
1268
Option('append-revisions-only',
1269
help='Never change revnos or the existing log.'
1270
' Append revisions to it only.')
1272
def run(self, location=None, format=None, append_revisions_only=False,
1273
create_prefix=False):
1275
format = bzrdir.format_registry.make_bzrdir('default')
1276
if location is None:
1279
to_transport = transport.get_transport(location)
1281
# The path has to exist to initialize a
1282
# branch inside of it.
1283
# Just using os.mkdir, since I don't
1284
# believe that we want to create a bunch of
1285
# locations if the user supplies an extended path
1287
to_transport.ensure_base()
1288
except errors.NoSuchFile:
1289
if not create_prefix:
1290
raise errors.BzrCommandError("Parent directory of %s"
1292
"\nYou may supply --create-prefix to create all"
1293
" leading parent directories."
1295
_create_prefix(to_transport)
1298
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1299
except errors.NotBranchError:
1300
# really a NotBzrDir error...
1301
create_branch = bzrdir.BzrDir.create_branch_convenience
1302
branch = create_branch(to_transport.base, format=format,
1303
possible_transports=[to_transport])
1305
from bzrlib.transport.local import LocalTransport
1306
if existing_bzrdir.has_branch():
1307
if (isinstance(to_transport, LocalTransport)
1308
and not existing_bzrdir.has_workingtree()):
1309
raise errors.BranchExistsWithoutWorkingTree(location)
1310
raise errors.AlreadyBranchError(location)
1312
branch = existing_bzrdir.create_branch()
1313
existing_bzrdir.create_workingtree()
1314
if append_revisions_only:
1316
branch.set_append_revisions_only(True)
1317
except errors.UpgradeRequired:
1318
raise errors.BzrCommandError('This branch format cannot be set'
1319
' to append-revisions-only. Try --experimental-branch6')
1322
class cmd_init_repository(Command):
1323
"""Create a shared repository to hold branches.
1325
New branches created under the repository directory will store their
1326
revisions in the repository, not in the branch directory.
1328
If the --no-trees option is used then the branches in the repository
1329
will not have working trees by default.
1332
Create a shared repositories holding just branches::
1334
bzr init-repo --no-trees repo
1337
Make a lightweight checkout elsewhere::
1339
bzr checkout --lightweight repo/trunk trunk-checkout
1344
_see_also = ['init', 'branch', 'checkout', 'repositories']
1345
takes_args = ["location"]
1346
takes_options = [RegistryOption('format',
1347
help='Specify a format for this repository. See'
1348
' "bzr help formats" for details.',
1349
registry=bzrdir.format_registry,
1350
converter=bzrdir.format_registry.make_bzrdir,
1351
value_switches=True, title='Repository format'),
1353
help='Branches in the repository will default to'
1354
' not having a working tree.'),
1356
aliases = ["init-repo"]
1358
def run(self, location, format=None, no_trees=False):
1360
format = bzrdir.format_registry.make_bzrdir('default')
1362
if location is None:
1365
to_transport = transport.get_transport(location)
1366
to_transport.ensure_base()
1368
newdir = format.initialize_on_transport(to_transport)
1369
repo = newdir.create_repository(shared=True)
1370
repo.set_make_working_trees(not no_trees)
1373
class cmd_diff(Command):
1374
"""Show differences in the working tree or between revisions.
1376
If files are listed, only the changes in those files are listed.
1377
Otherwise, all changes for the tree are listed.
1379
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1380
produces patches suitable for "patch -p1".
1383
Shows the difference in the working tree versus the last commit::
1387
Difference between the working tree and revision 1::
1391
Difference between revision 2 and revision 1::
1395
Same as 'bzr diff' but prefix paths with old/ and new/::
1397
bzr diff --prefix old/:new/
1399
Show the differences between the two working trees::
1401
bzr diff bzr.mine bzr.dev
1403
Show just the differences for 'foo.c'::
1407
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1408
# or a graphical diff.
1410
# TODO: Python difflib is not exactly the same as unidiff; should
1411
# either fix it up or prefer to use an external diff.
1413
# TODO: Selected-file diff is inefficient and doesn't show you
1416
# TODO: This probably handles non-Unix newlines poorly.
1418
_see_also = ['status']
1419
takes_args = ['file*']
1421
Option('diff-options', type=str,
1422
help='Pass these options to the external diff program.'),
1423
Option('prefix', type=str,
1425
help='Set prefixes to added to old and new filenames, as '
1426
'two values separated by a colon. (eg "old/:new/").'),
1430
aliases = ['di', 'dif']
1431
encoding_type = 'exact'
1434
def run(self, revision=None, file_list=None, diff_options=None,
1436
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1438
if (prefix is None) or (prefix == '0'):
1446
old_label, new_label = prefix.split(":")
1448
raise errors.BzrCommandError(
1449
'--prefix expects two values separated by a colon'
1450
' (eg "old/:new/")')
1452
if revision and len(revision) > 2:
1453
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1454
' one or two revision specifiers')
1457
tree1, file_list = internal_tree_files(file_list)
1461
except errors.FileInWrongBranch:
1462
if len(file_list) != 2:
1463
raise errors.BzrCommandError("Files are in different branches")
1465
tree1, file1 = WorkingTree.open_containing(file_list[0])
1466
tree2, file2 = WorkingTree.open_containing(file_list[1])
1467
if file1 != "" or file2 != "":
1468
# FIXME diff those two files. rbc 20051123
1469
raise errors.BzrCommandError("Files are in different branches")
1471
except errors.NotBranchError:
1472
if (revision is not None and len(revision) == 2
1473
and not revision[0].needs_branch()
1474
and not revision[1].needs_branch()):
1475
# If both revision specs include a branch, we can
1476
# diff them without needing a local working tree
1477
tree1, tree2 = None, None
1481
if tree2 is not None:
1482
if revision is not None:
1483
# FIXME: but there should be a clean way to diff between
1484
# non-default versions of two trees, it's not hard to do
1486
raise errors.BzrCommandError(
1487
"Sorry, diffing arbitrary revisions across branches "
1488
"is not implemented yet")
1489
return show_diff_trees(tree1, tree2, sys.stdout,
1490
specific_files=file_list,
1491
external_diff_options=diff_options,
1492
old_label=old_label, new_label=new_label)
1494
return diff_cmd_helper(tree1, file_list, diff_options,
1495
revision_specs=revision,
1496
old_label=old_label, new_label=new_label)
1499
class cmd_deleted(Command):
1500
"""List files deleted in the working tree.
1502
# TODO: Show files deleted since a previous revision, or
1503
# between two revisions.
1504
# TODO: Much more efficient way to do this: read in new
1505
# directories with readdir, rather than stating each one. Same
1506
# level of effort but possibly much less IO. (Or possibly not,
1507
# if the directories are very large...)
1508
_see_also = ['status', 'ls']
1509
takes_options = ['show-ids']
1512
def run(self, show_ids=False):
1513
tree = WorkingTree.open_containing(u'.')[0]
1516
old = tree.basis_tree()
1519
for path, ie in old.inventory.iter_entries():
1520
if not tree.has_id(ie.file_id):
1521
self.outf.write(path)
1523
self.outf.write(' ')
1524
self.outf.write(ie.file_id)
1525
self.outf.write('\n')
1532
class cmd_modified(Command):
1533
"""List files modified in working tree.
1537
_see_also = ['status', 'ls']
1541
tree = WorkingTree.open_containing(u'.')[0]
1542
td = tree.changes_from(tree.basis_tree())
1543
for path, id, kind, text_modified, meta_modified in td.modified:
1544
self.outf.write(path + '\n')
1547
class cmd_added(Command):
1548
"""List files added in working tree.
1552
_see_also = ['status', 'ls']
1556
wt = WorkingTree.open_containing(u'.')[0]
1559
basis = wt.basis_tree()
1562
basis_inv = basis.inventory
1565
if file_id in basis_inv:
1567
if inv.is_root(file_id) and len(basis_inv) == 0:
1569
path = inv.id2path(file_id)
1570
if not os.access(osutils.abspath(path), os.F_OK):
1572
self.outf.write(path + '\n')
1579
class cmd_root(Command):
1580
"""Show the tree root directory.
1582
The root is the nearest enclosing directory with a .bzr control
1585
takes_args = ['filename?']
1587
def run(self, filename=None):
1588
"""Print the branch root."""
1589
tree = WorkingTree.open_containing(filename)[0]
1590
self.outf.write(tree.basedir + '\n')
1593
def _parse_limit(limitstring):
1595
return int(limitstring)
1597
msg = "The limit argument must be an integer."
1598
raise errors.BzrCommandError(msg)
1601
class cmd_log(Command):
1602
"""Show log of a branch, file, or directory.
1604
By default show the log of the branch containing the working directory.
1606
To request a range of logs, you can use the command -r begin..end
1607
-r revision requests a specific revision, -r ..end or -r begin.. are
1611
Log the current branch::
1619
Log the last 10 revisions of a branch::
1621
bzr log -r -10.. http://server/branch
1624
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1626
takes_args = ['location?']
1629
help='Show from oldest to newest.'),
1632
help='Display timezone as local, original, or utc.'),
1633
custom_help('verbose',
1634
help='Show files changed in each revision.'),
1640
help='Show revisions whose message matches this '
1641
'regular expression.',
1644
help='Limit the output to the first N revisions.',
1648
encoding_type = 'replace'
1651
def run(self, location=None, timezone='original',
1659
from bzrlib.log import show_log
1660
assert message is None or isinstance(message, basestring), \
1661
"invalid message argument %r" % message
1662
direction = (forward and 'forward') or 'reverse'
1667
# find the file id to log:
1669
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1673
tree = b.basis_tree()
1674
file_id = tree.path2id(fp)
1676
raise errors.BzrCommandError(
1677
"Path does not have any revision history: %s" %
1681
# FIXME ? log the current subdir only RBC 20060203
1682
if revision is not None \
1683
and len(revision) > 0 and revision[0].get_branch():
1684
location = revision[0].get_branch()
1687
dir, relpath = bzrdir.BzrDir.open_containing(location)
1688
b = dir.open_branch()
1692
if revision is None:
1695
elif len(revision) == 1:
1696
rev1 = rev2 = revision[0].in_history(b)
1697
elif len(revision) == 2:
1698
if revision[1].get_branch() != revision[0].get_branch():
1699
# b is taken from revision[0].get_branch(), and
1700
# show_log will use its revision_history. Having
1701
# different branches will lead to weird behaviors.
1702
raise errors.BzrCommandError(
1703
"Log doesn't accept two revisions in different"
1705
rev1 = revision[0].in_history(b)
1706
rev2 = revision[1].in_history(b)
1708
raise errors.BzrCommandError(
1709
'bzr log --revision takes one or two values.')
1711
if log_format is None:
1712
log_format = log.log_formatter_registry.get_default(b)
1714
lf = log_format(show_ids=show_ids, to_file=self.outf,
1715
show_timezone=timezone)
1721
direction=direction,
1722
start_revision=rev1,
1730
def get_log_format(long=False, short=False, line=False, default='long'):
1731
log_format = default
1735
log_format = 'short'
1741
class cmd_touching_revisions(Command):
1742
"""Return revision-ids which affected a particular file.
1744
A more user-friendly interface is "bzr log FILE".
1748
takes_args = ["filename"]
1751
def run(self, filename):
1752
tree, relpath = WorkingTree.open_containing(filename)
1754
file_id = tree.path2id(relpath)
1755
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1756
self.outf.write("%6d %s\n" % (revno, what))
1759
class cmd_ls(Command):
1760
"""List files in a tree.
1763
_see_also = ['status', 'cat']
1764
takes_args = ['path?']
1765
# TODO: Take a revision or remote path and list that tree instead.
1769
Option('non-recursive',
1770
help='Don\'t recurse into subdirectories.'),
1772
help='Print paths relative to the root of the branch.'),
1773
Option('unknown', help='Print unknown files.'),
1774
Option('versioned', help='Print versioned files.'),
1775
Option('ignored', help='Print ignored files.'),
1777
help='Write an ascii NUL (\\0) separator '
1778
'between files rather than a newline.'),
1780
help='List entries of a particular kind: file, directory, symlink.',
1785
def run(self, revision=None, verbose=False,
1786
non_recursive=False, from_root=False,
1787
unknown=False, versioned=False, ignored=False,
1788
null=False, kind=None, show_ids=False, path=None):
1790
if kind and kind not in ('file', 'directory', 'symlink'):
1791
raise errors.BzrCommandError('invalid kind specified')
1793
if verbose and null:
1794
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1795
all = not (unknown or versioned or ignored)
1797
selection = {'I':ignored, '?':unknown, 'V':versioned}
1804
raise errors.BzrCommandError('cannot specify both --from-root'
1808
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1814
if revision is not None:
1815
tree = branch.repository.revision_tree(
1816
revision[0].in_history(branch).rev_id)
1818
tree = branch.basis_tree()
1822
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1823
if fp.startswith(relpath):
1824
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1825
if non_recursive and '/' in fp:
1827
if not all and not selection[fc]:
1829
if kind is not None and fkind != kind:
1832
kindch = entry.kind_character()
1833
outstring = '%-8s %s%s' % (fc, fp, kindch)
1834
if show_ids and fid is not None:
1835
outstring = "%-50s %s" % (outstring, fid)
1836
self.outf.write(outstring + '\n')
1838
self.outf.write(fp + '\0')
1841
self.outf.write(fid)
1842
self.outf.write('\0')
1850
self.outf.write('%-50s %s\n' % (fp, my_id))
1852
self.outf.write(fp + '\n')
1857
class cmd_unknowns(Command):
1858
"""List unknown files.
1866
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1867
self.outf.write(osutils.quotefn(f) + '\n')
1870
class cmd_ignore(Command):
1871
"""Ignore specified files or patterns.
1873
To remove patterns from the ignore list, edit the .bzrignore file.
1875
Trailing slashes on patterns are ignored.
1876
If the pattern contains a slash or is a regular expression, it is compared
1877
to the whole path from the branch root. Otherwise, it is compared to only
1878
the last component of the path. To match a file only in the root
1879
directory, prepend './'.
1881
Ignore patterns specifying absolute paths are not allowed.
1883
Ignore patterns may include globbing wildcards such as::
1885
? - Matches any single character except '/'
1886
* - Matches 0 or more characters except '/'
1887
/**/ - Matches 0 or more directories in a path
1888
[a-z] - Matches a single character from within a group of characters
1890
Ignore patterns may also be Python regular expressions.
1891
Regular expression ignore patterns are identified by a 'RE:' prefix
1892
followed by the regular expression. Regular expression ignore patterns
1893
may not include named or numbered groups.
1895
Note: ignore patterns containing shell wildcards must be quoted from
1899
Ignore the top level Makefile::
1901
bzr ignore ./Makefile
1903
Ignore class files in all directories::
1905
bzr ignore '*.class'
1907
Ignore .o files under the lib directory::
1909
bzr ignore 'lib/**/*.o'
1911
Ignore .o files under the lib directory::
1913
bzr ignore 'RE:lib/.*\.o'
1916
_see_also = ['status', 'ignored']
1917
takes_args = ['name_pattern*']
1919
Option('old-default-rules',
1920
help='Write out the ignore rules bzr < 0.9 always used.')
1923
def run(self, name_pattern_list=None, old_default_rules=None):
1924
from bzrlib.atomicfile import AtomicFile
1925
if old_default_rules is not None:
1926
# dump the rules and exit
1927
for pattern in ignores.OLD_DEFAULTS:
1930
if not name_pattern_list:
1931
raise errors.BzrCommandError("ignore requires at least one "
1932
"NAME_PATTERN or --old-default-rules")
1933
name_pattern_list = [globbing.normalize_pattern(p)
1934
for p in name_pattern_list]
1935
for name_pattern in name_pattern_list:
1936
if (name_pattern[0] == '/' or
1937
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1938
raise errors.BzrCommandError(
1939
"NAME_PATTERN should not be an absolute path")
1940
tree, relpath = WorkingTree.open_containing(u'.')
1941
ifn = tree.abspath('.bzrignore')
1942
if os.path.exists(ifn):
1945
igns = f.read().decode('utf-8')
1951
# TODO: If the file already uses crlf-style termination, maybe
1952
# we should use that for the newly added lines?
1954
if igns and igns[-1] != '\n':
1956
for name_pattern in name_pattern_list:
1957
igns += name_pattern + '\n'
1959
f = AtomicFile(ifn, 'wb')
1961
f.write(igns.encode('utf-8'))
1966
if not tree.path2id('.bzrignore'):
1967
tree.add(['.bzrignore'])
1969
ignored = globbing.Globster(name_pattern_list)
1972
for entry in tree.list_files():
1976
if ignored.match(filename):
1977
matches.append(filename.encode('utf-8'))
1979
if len(matches) > 0:
1980
print "Warning: the following files are version controlled and" \
1981
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1983
class cmd_ignored(Command):
1984
"""List ignored files and the patterns that matched them.
1987
_see_also = ['ignore']
1990
tree = WorkingTree.open_containing(u'.')[0]
1993
for path, file_class, kind, file_id, entry in tree.list_files():
1994
if file_class != 'I':
1996
## XXX: Slightly inefficient since this was already calculated
1997
pat = tree.is_ignored(path)
1998
print '%-50s %s' % (path, pat)
2003
class cmd_lookup_revision(Command):
2004
"""Lookup the revision-id from a revision-number
2007
bzr lookup-revision 33
2010
takes_args = ['revno']
2013
def run(self, revno):
2017
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2019
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2022
class cmd_export(Command):
2023
"""Export current or past revision to a destination directory or archive.
2025
If no revision is specified this exports the last committed revision.
2027
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2028
given, try to find the format with the extension. If no extension
2029
is found exports to a directory (equivalent to --format=dir).
2031
If root is supplied, it will be used as the root directory inside
2032
container formats (tar, zip, etc). If it is not supplied it will default
2033
to the exported filename. The root option has no effect for 'dir' format.
2035
If branch is omitted then the branch containing the current working
2036
directory will be used.
2038
Note: Export of tree with non-ASCII filenames to zip is not supported.
2040
================= =========================
2041
Supported formats Autodetected by extension
2042
================= =========================
2045
tbz2 .tar.bz2, .tbz2
2048
================= =========================
2050
takes_args = ['dest', 'branch?']
2053
help="Type of file to export to.",
2058
help="Name of the root directory inside the exported file."),
2060
def run(self, dest, branch=None, revision=None, format=None, root=None):
2061
from bzrlib.export import export
2064
tree = WorkingTree.open_containing(u'.')[0]
2067
b = Branch.open(branch)
2069
if revision is None:
2070
# should be tree.last_revision FIXME
2071
rev_id = b.last_revision()
2073
if len(revision) != 1:
2074
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2075
rev_id = revision[0].in_history(b).rev_id
2076
t = b.repository.revision_tree(rev_id)
2078
export(t, dest, format, root)
2079
except errors.NoSuchExportFormat, e:
2080
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2083
class cmd_cat(Command):
2084
"""Write the contents of a file as of a given revision to standard output.
2086
If no revision is nominated, the last revision is used.
2088
Note: Take care to redirect standard output when using this command on a
2094
Option('name-from-revision', help='The path name in the old tree.'),
2097
takes_args = ['filename']
2098
encoding_type = 'exact'
2101
def run(self, filename, revision=None, name_from_revision=False):
2102
if revision is not None and len(revision) != 1:
2103
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2108
tree, b, relpath = \
2109
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2110
except errors.NotBranchError:
2113
if revision is not None and revision[0].get_branch() is not None:
2114
b = Branch.open(revision[0].get_branch())
2116
tree = b.basis_tree()
2117
if revision is None:
2118
revision_id = b.last_revision()
2120
revision_id = revision[0].in_history(b).rev_id
2122
cur_file_id = tree.path2id(relpath)
2123
rev_tree = b.repository.revision_tree(revision_id)
2124
old_file_id = rev_tree.path2id(relpath)
2126
if name_from_revision:
2127
if old_file_id is None:
2128
raise errors.BzrCommandError("%r is not present in revision %s"
2129
% (filename, revision_id))
2131
rev_tree.print_file(old_file_id)
2132
elif cur_file_id is not None:
2133
rev_tree.print_file(cur_file_id)
2134
elif old_file_id is not None:
2135
rev_tree.print_file(old_file_id)
2137
raise errors.BzrCommandError("%r is not present in revision %s" %
2138
(filename, revision_id))
2141
class cmd_local_time_offset(Command):
2142
"""Show the offset in seconds from GMT to local time."""
2146
print osutils.local_time_offset()
2150
class cmd_commit(Command):
2151
"""Commit changes into a new revision.
2153
If no arguments are given, the entire tree is committed.
2155
If selected files are specified, only changes to those files are
2156
committed. If a directory is specified then the directory and everything
2157
within it is committed.
2159
If author of the change is not the same person as the committer, you can
2160
specify the author's name using the --author option. The name should be
2161
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2163
A selected-file commit may fail in some cases where the committed
2164
tree would be invalid. Consider::
2169
bzr commit foo -m "committing foo"
2170
bzr mv foo/bar foo/baz
2173
bzr commit foo/bar -m "committing bar but not baz"
2175
In the example above, the last commit will fail by design. This gives
2176
the user the opportunity to decide whether they want to commit the
2177
rename at the same time, separately first, or not at all. (As a general
2178
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2180
Note: A selected-file commit after a merge is not yet supported.
2182
# TODO: Run hooks on tree to-be-committed, and after commit.
2184
# TODO: Strict commit that fails if there are deleted files.
2185
# (what does "deleted files" mean ??)
2187
# TODO: Give better message for -s, --summary, used by tla people
2189
# XXX: verbose currently does nothing
2191
_see_also = ['bugs', 'uncommit']
2192
takes_args = ['selected*']
2194
Option('message', type=unicode,
2196
help="Description of the new revision."),
2199
help='Commit even if nothing has changed.'),
2200
Option('file', type=str,
2203
help='Take commit message from this file.'),
2205
help="Refuse to commit if there are unknown "
2206
"files in the working tree."),
2207
ListOption('fixes', type=str,
2208
help="Mark a bug as being fixed by this revision."),
2209
Option('author', type=str,
2210
help="Set the author's name, if it's different "
2211
"from the committer."),
2213
help="Perform a local commit in a bound "
2214
"branch. Local commits are not pushed to "
2215
"the master branch until a normal commit "
2219
help='When no message is supplied, show the diff along'
2220
' with the status summary in the message editor.'),
2222
aliases = ['ci', 'checkin']
2224
def _get_bug_fix_properties(self, fixes, branch):
2226
# Configure the properties for bug fixing attributes.
2227
for fixed_bug in fixes:
2228
tokens = fixed_bug.split(':')
2229
if len(tokens) != 2:
2230
raise errors.BzrCommandError(
2231
"Invalid bug %s. Must be in the form of 'tag:id'. "
2232
"Commit refused." % fixed_bug)
2233
tag, bug_id = tokens
2235
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2236
except errors.UnknownBugTrackerAbbreviation:
2237
raise errors.BzrCommandError(
2238
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2239
except errors.MalformedBugIdentifier:
2240
raise errors.BzrCommandError(
2241
"Invalid bug identifier for %s. Commit refused."
2243
properties.append('%s fixed' % bug_url)
2244
return '\n'.join(properties)
2246
def run(self, message=None, file=None, verbose=False, selected_list=None,
2247
unchanged=False, strict=False, local=False, fixes=None,
2248
author=None, show_diff=False):
2249
from bzrlib.commit import (
2253
from bzrlib.errors import (
2258
from bzrlib.msgeditor import (
2259
edit_commit_message_encoded,
2260
make_commit_message_template_encoded
2263
# TODO: Need a blackbox test for invoking the external editor; may be
2264
# slightly problematic to run this cross-platform.
2266
# TODO: do more checks that the commit will succeed before
2267
# spending the user's valuable time typing a commit message.
2271
tree, selected_list = tree_files(selected_list)
2272
if selected_list == ['']:
2273
# workaround - commit of root of tree should be exactly the same
2274
# as just default commit in that tree, and succeed even though
2275
# selected-file merge commit is not done yet
2278
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2280
properties['bugs'] = bug_property
2282
if local and not tree.branch.get_bound_location():
2283
raise errors.LocalRequiresBoundBranch()
2285
def get_message(commit_obj):
2286
"""Callback to get commit message"""
2287
my_message = message
2288
if my_message is None and not file:
2289
t = make_commit_message_template_encoded(tree,
2290
selected_list, diff=show_diff,
2291
output_encoding=bzrlib.user_encoding)
2292
my_message = edit_commit_message_encoded(t)
2293
if my_message is None:
2294
raise errors.BzrCommandError("please specify a commit"
2295
" message with either --message or --file")
2296
elif my_message and file:
2297
raise errors.BzrCommandError(
2298
"please specify either --message or --file")
2300
my_message = codecs.open(file, 'rt',
2301
bzrlib.user_encoding).read()
2302
if my_message == "":
2303
raise errors.BzrCommandError("empty commit message specified")
2307
tree.commit(message_callback=get_message,
2308
specific_files=selected_list,
2309
allow_pointless=unchanged, strict=strict, local=local,
2310
reporter=None, verbose=verbose, revprops=properties,
2312
except PointlessCommit:
2313
# FIXME: This should really happen before the file is read in;
2314
# perhaps prepare the commit; get the message; then actually commit
2315
raise errors.BzrCommandError("no changes to commit."
2316
" use --unchanged to commit anyhow")
2317
except ConflictsInTree:
2318
raise errors.BzrCommandError('Conflicts detected in working '
2319
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2321
except StrictCommitFailed:
2322
raise errors.BzrCommandError("Commit refused because there are"
2323
" unknown files in the working tree.")
2324
except errors.BoundBranchOutOfDate, e:
2325
raise errors.BzrCommandError(str(e) + "\n"
2326
'To commit to master branch, run update and then commit.\n'
2327
'You can also pass --local to commit to continue working '
2331
class cmd_check(Command):
2332
"""Validate consistency of branch history.
2334
This command checks various invariants about the branch storage to
2335
detect data corruption or bzr bugs.
2338
_see_also = ['reconcile']
2339
takes_args = ['branch?']
2340
takes_options = ['verbose']
2342
def run(self, branch=None, verbose=False):
2343
from bzrlib.check import check
2345
tree = WorkingTree.open_containing()[0]
2346
branch = tree.branch
2348
branch = Branch.open(branch)
2349
check(branch, verbose)
2352
class cmd_upgrade(Command):
2353
"""Upgrade branch storage to current format.
2355
The check command or bzr developers may sometimes advise you to run
2356
this command. When the default format has changed you may also be warned
2357
during other operations to upgrade.
2360
_see_also = ['check']
2361
takes_args = ['url?']
2363
RegistryOption('format',
2364
help='Upgrade to a specific format. See "bzr help'
2365
' formats" for details.',
2366
registry=bzrdir.format_registry,
2367
converter=bzrdir.format_registry.make_bzrdir,
2368
value_switches=True, title='Branch format'),
2371
def run(self, url='.', format=None):
2372
from bzrlib.upgrade import upgrade
2374
format = bzrdir.format_registry.make_bzrdir('default')
2375
upgrade(url, format)
2378
class cmd_whoami(Command):
2379
"""Show or set bzr user id.
2382
Show the email of the current user::
2386
Set the current user::
2388
bzr whoami 'Frank Chu <fchu@example.com>'
2390
takes_options = [ Option('email',
2391
help='Display email address only.'),
2393
help='Set identity for the current branch instead of '
2396
takes_args = ['name?']
2397
encoding_type = 'replace'
2400
def run(self, email=False, branch=False, name=None):
2402
# use branch if we're inside one; otherwise global config
2404
c = Branch.open_containing('.')[0].get_config()
2405
except errors.NotBranchError:
2406
c = config.GlobalConfig()
2408
self.outf.write(c.user_email() + '\n')
2410
self.outf.write(c.username() + '\n')
2413
# display a warning if an email address isn't included in the given name.
2415
config.extract_email_address(name)
2416
except errors.NoEmailInUsername, e:
2417
warning('"%s" does not seem to contain an email address. '
2418
'This is allowed, but not recommended.', name)
2420
# use global config unless --branch given
2422
c = Branch.open_containing('.')[0].get_config()
2424
c = config.GlobalConfig()
2425
c.set_user_option('email', name)
2428
class cmd_nick(Command):
2429
"""Print or set the branch nickname.
2431
If unset, the tree root directory name is used as the nickname
2432
To print the current nickname, execute with no argument.
2435
_see_also = ['info']
2436
takes_args = ['nickname?']
2437
def run(self, nickname=None):
2438
branch = Branch.open_containing(u'.')[0]
2439
if nickname is None:
2440
self.printme(branch)
2442
branch.nick = nickname
2445
def printme(self, branch):
2449
class cmd_selftest(Command):
2450
"""Run internal test suite.
2452
If arguments are given, they are regular expressions that say which tests
2453
should run. Tests matching any expression are run, and other tests are
2456
Alternatively if --first is given, matching tests are run first and then
2457
all other tests are run. This is useful if you have been working in a
2458
particular area, but want to make sure nothing else was broken.
2460
If --exclude is given, tests that match that regular expression are
2461
excluded, regardless of whether they match --first or not.
2463
To help catch accidential dependencies between tests, the --randomize
2464
option is useful. In most cases, the argument used is the word 'now'.
2465
Note that the seed used for the random number generator is displayed
2466
when this option is used. The seed can be explicitly passed as the
2467
argument to this option if required. This enables reproduction of the
2468
actual ordering used if and when an order sensitive problem is encountered.
2470
If --list-only is given, the tests that would be run are listed. This is
2471
useful when combined with --first, --exclude and/or --randomize to
2472
understand their impact. The test harness reports "Listed nn tests in ..."
2473
instead of "Ran nn tests in ..." when list mode is enabled.
2475
If the global option '--no-plugins' is given, plugins are not loaded
2476
before running the selftests. This has two effects: features provided or
2477
modified by plugins will not be tested, and tests provided by plugins will
2480
Tests that need working space on disk use a common temporary directory,
2481
typically inside $TMPDIR or /tmp.
2484
Run only tests relating to 'ignore'::
2488
Disable plugins and list tests as they're run::
2490
bzr --no-plugins selftest -v
2492
# NB: this is used from the class without creating an instance, which is
2493
# why it does not have a self parameter.
2494
def get_transport_type(typestring):
2495
"""Parse and return a transport specifier."""
2496
if typestring == "sftp":
2497
from bzrlib.transport.sftp import SFTPAbsoluteServer
2498
return SFTPAbsoluteServer
2499
if typestring == "memory":
2500
from bzrlib.transport.memory import MemoryServer
2502
if typestring == "fakenfs":
2503
from bzrlib.transport.fakenfs import FakeNFSServer
2504
return FakeNFSServer
2505
msg = "No known transport type %s. Supported types are: sftp\n" %\
2507
raise errors.BzrCommandError(msg)
2510
takes_args = ['testspecs*']
2511
takes_options = ['verbose',
2513
help='Stop when one test fails.',
2517
help='Use a different transport by default '
2518
'throughout the test suite.',
2519
type=get_transport_type),
2521
help='Run the benchmarks rather than selftests.'),
2522
Option('lsprof-timed',
2523
help='Generate lsprof output for benchmarked'
2524
' sections of code.'),
2525
Option('cache-dir', type=str,
2526
help='Cache intermediate benchmark output in this '
2529
help='Run all tests, but run specified tests first.',
2533
help='List the tests instead of running them.'),
2534
Option('randomize', type=str, argname="SEED",
2535
help='Randomize the order of tests using the given'
2536
' seed or "now" for the current time.'),
2537
Option('exclude', type=str, argname="PATTERN",
2539
help='Exclude tests that match this regular'
2541
Option('strict', help='Fail on missing dependencies or '
2544
encoding_type = 'replace'
2546
def run(self, testspecs_list=None, verbose=None, one=False,
2547
transport=None, benchmark=None,
2548
lsprof_timed=None, cache_dir=None,
2549
first=False, list_only=False,
2550
randomize=None, exclude=None, strict=False):
2552
from bzrlib.tests import selftest
2553
import bzrlib.benchmarks as benchmarks
2554
from bzrlib.benchmarks import tree_creator
2555
from bzrlib.version import show_version
2557
if cache_dir is not None:
2558
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2560
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2561
print ' %s (%s python%s)' % (
2563
bzrlib.version_string,
2564
'.'.join(map(str, sys.version_info)),
2567
if testspecs_list is not None:
2568
pattern = '|'.join(testspecs_list)
2572
test_suite_factory = benchmarks.test_suite
2575
# TODO: should possibly lock the history file...
2576
benchfile = open(".perf_history", "at", buffering=1)
2578
test_suite_factory = None
2583
result = selftest(verbose=verbose,
2585
stop_on_failure=one,
2586
transport=transport,
2587
test_suite_factory=test_suite_factory,
2588
lsprof_timed=lsprof_timed,
2589
bench_history=benchfile,
2590
matching_tests_first=first,
2591
list_only=list_only,
2592
random_seed=randomize,
2593
exclude_pattern=exclude,
2597
if benchfile is not None:
2600
info('tests passed')
2602
info('tests failed')
2603
return int(not result)
2606
class cmd_version(Command):
2607
"""Show version of bzr."""
2611
from bzrlib.version import show_version
2615
class cmd_rocks(Command):
2616
"""Statement of optimism."""
2622
print "It sure does!"
2625
class cmd_find_merge_base(Command):
2626
"""Find and print a base revision for merging two branches."""
2627
# TODO: Options to specify revisions on either side, as if
2628
# merging only part of the history.
2629
takes_args = ['branch', 'other']
2633
def run(self, branch, other):
2634
from bzrlib.revision import ensure_null, MultipleRevisionSources
2636
branch1 = Branch.open_containing(branch)[0]
2637
branch2 = Branch.open_containing(other)[0]
2639
last1 = ensure_null(branch1.last_revision())
2640
last2 = ensure_null(branch2.last_revision())
2642
graph = branch1.repository.get_graph(branch2.repository)
2643
base_rev_id = graph.find_unique_lca(last1, last2)
2645
print 'merge base is revision %s' % base_rev_id
2648
class cmd_merge(Command):
2649
"""Perform a three-way merge.
2651
The branch is the branch you will merge from. By default, it will merge
2652
the latest revision. If you specify a revision, that revision will be
2653
merged. If you specify two revisions, the first will be used as a BASE,
2654
and the second one as OTHER. Revision numbers are always relative to the
2657
By default, bzr will try to merge in all new work from the other
2658
branch, automatically determining an appropriate base. If this
2659
fails, you may need to give an explicit base.
2661
Merge will do its best to combine the changes in two branches, but there
2662
are some kinds of problems only a human can fix. When it encounters those,
2663
it will mark a conflict. A conflict means that you need to fix something,
2664
before you should commit.
2666
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2668
If there is no default branch set, the first merge will set it. After
2669
that, you can omit the branch to use the default. To change the
2670
default, use --remember. The value will only be saved if the remote
2671
location can be accessed.
2673
The results of the merge are placed into the destination working
2674
directory, where they can be reviewed (with bzr diff), tested, and then
2675
committed to record the result of the merge.
2677
merge refuses to run if there are any uncommitted changes, unless
2681
To merge the latest revision from bzr.dev::
2683
bzr merge ../bzr.dev
2685
To merge changes up to and including revision 82 from bzr.dev::
2687
bzr merge -r 82 ../bzr.dev
2689
To merge the changes introduced by 82, without previous changes::
2691
bzr merge -r 81..82 ../bzr.dev
2694
_see_also = ['update', 'remerge', 'status-flags']
2695
takes_args = ['branch?']
2699
help='Merge even if the destination tree has uncommitted changes.'),
2703
Option('show-base', help="Show base revision text in "
2705
Option('uncommitted', help='Apply uncommitted changes'
2706
' from a working copy, instead of branch changes.'),
2707
Option('pull', help='If the destination is already'
2708
' completely merged into the source, pull from the'
2709
' source rather than merging. When this happens,'
2710
' you do not need to commit the result.'),
2712
help='Branch to merge into, '
2713
'rather than the one containing the working directory.',
2719
def run(self, branch=None, revision=None, force=False, merge_type=None,
2720
show_base=False, reprocess=False, remember=False,
2721
uncommitted=False, pull=False,
2724
from bzrlib.tag import _merge_tags_if_possible
2725
# This is actually a branch (or merge-directive) *location*.
2729
if merge_type is None:
2730
merge_type = _mod_merge.Merge3Merger
2732
if directory is None: directory = u'.'
2733
possible_transports = []
2735
allow_pending = True
2736
verified = 'inapplicable'
2737
tree = WorkingTree.open_containing(directory)[0]
2738
change_reporter = delta._ChangeReporter(
2739
unversioned_filter=tree.is_ignored)
2742
pb = ui.ui_factory.nested_progress_bar()
2743
cleanups.append(pb.finished)
2745
cleanups.append(tree.unlock)
2746
if location is not None:
2747
mergeable, other_transport = _get_mergeable_helper(location)
2750
raise errors.BzrCommandError('Cannot use --uncommitted'
2751
' with bundles or merge directives.')
2753
if revision is not None:
2754
raise errors.BzrCommandError(
2755
'Cannot use -r with merge directives or bundles')
2756
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2758
possible_transports.append(other_transport)
2760
if merger is None and uncommitted:
2761
if revision is not None and len(revision) > 0:
2762
raise errors.BzrCommandError('Cannot use --uncommitted and'
2763
' --revision at the same time.')
2764
location = self._select_branch_location(tree, location)[0]
2765
other_tree, other_path = WorkingTree.open_containing(location)
2766
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2768
allow_pending = False
2771
merger, allow_pending = self._get_merger_from_branch(tree,
2772
location, revision, remember, possible_transports, pb)
2774
merger.merge_type = merge_type
2775
merger.reprocess = reprocess
2776
merger.show_base = show_base
2777
merger.change_reporter = change_reporter
2778
self.sanity_check_merger(merger)
2779
if (merger.base_rev_id == merger.other_rev_id and
2780
merger.other_rev_id != None):
2781
note('Nothing to do.')
2784
if merger.interesting_files is not None:
2785
raise BzrCommandError('Cannot pull individual files')
2786
if (merger.base_rev_id == tree.last_revision()):
2787
result = tree.pull(merger.other_branch, False,
2788
merger.other_rev_id)
2789
result.report(self.outf)
2791
merger.check_basis(not force)
2792
conflict_count = merger.do_merge()
2794
merger.set_pending()
2795
if verified == 'failed':
2796
warning('Preview patch does not match changes')
2797
if conflict_count != 0:
2802
for cleanup in reversed(cleanups):
2805
def sanity_check_merger(self, merger):
2806
if (merger.show_base and
2807
not merger.merge_type is _mod_merge.Merge3Merger):
2808
raise errors.BzrCommandError("Show-base is not supported for this"
2809
" merge type. %s" % merger.merge_type)
2810
if merger.reprocess and not merger.merge_type.supports_reprocess:
2811
raise errors.BzrCommandError("Conflict reduction is not supported"
2812
" for merge type %s." %
2814
if merger.reprocess and merger.show_base:
2815
raise errors.BzrCommandError("Cannot do conflict reduction and"
2818
def _get_merger_from_branch(self, tree, location, revision, remember,
2819
possible_transports, pb):
2820
"""Produce a merger from a location, assuming it refers to a branch."""
2821
from bzrlib.tag import _merge_tags_if_possible
2822
assert revision is None or len(revision) < 3
2823
# find the branch locations
2824
other_loc, location = self._select_branch_location(tree, location,
2826
if revision is not None and len(revision) == 2:
2827
base_loc, location = self._select_branch_location(tree, location,
2830
base_loc = other_loc
2832
other_branch, other_path = Branch.open_containing(other_loc,
2833
possible_transports)
2834
if base_loc == other_loc:
2835
base_branch = other_branch
2837
base_branch, base_path = Branch.open_containing(base_loc,
2838
possible_transports)
2839
# Find the revision ids
2840
if revision is None or len(revision) < 1 or revision[-1] is None:
2841
other_revision_id = _mod_revision.ensure_null(
2842
other_branch.last_revision())
2844
other_revision_id = \
2845
_mod_revision.ensure_null(
2846
revision[-1].in_history(other_branch).rev_id)
2847
if (revision is not None and len(revision) == 2
2848
and revision[0] is not None):
2849
base_revision_id = \
2850
_mod_revision.ensure_null(
2851
revision[0].in_history(base_branch).rev_id)
2853
base_revision_id = None
2854
# Remember where we merge from
2855
if ((tree.branch.get_parent() is None or remember) and
2856
other_branch is not None):
2857
tree.branch.set_parent(other_branch.base)
2858
_merge_tags_if_possible(other_branch, tree.branch)
2859
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2860
other_revision_id, base_revision_id, other_branch, base_branch)
2861
if other_path != '':
2862
allow_pending = False
2863
merger.interesting_files = [other_path]
2865
allow_pending = True
2866
return merger, allow_pending
2868
def _select_branch_location(self, tree, location, revision=None,
2870
"""Select a branch location, according to possible inputs.
2872
If provided, branches from ``revision`` are preferred. (Both
2873
``revision`` and ``index`` must be supplied.)
2875
Otherwise, the ``location`` parameter is used. If it is None, then the
2876
``parent`` location is used, and a note is printed.
2878
:param tree: The working tree to select a branch for merging into
2879
:param location: The location entered by the user
2880
:param revision: The revision parameter to the command
2881
:param index: The index to use for the revision parameter. Negative
2882
indices are permitted.
2883
:return: (selected_location, default_location). The default location
2884
will be the user-entered location, if any, or else the remembered
2887
if (revision is not None and index is not None
2888
and revision[index] is not None):
2889
branch = revision[index].get_branch()
2890
if branch is not None:
2891
return branch, location
2892
location = self._get_remembered_parent(tree, location, 'Merging from')
2893
return location, location
2895
# TODO: move up to common parent; this isn't merge-specific anymore.
2896
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2897
"""Use tree.branch's parent if none was supplied.
2899
Report if the remembered location was used.
2901
if supplied_location is not None:
2902
return supplied_location
2903
stored_location = tree.branch.get_parent()
2904
mutter("%s", stored_location)
2905
if stored_location is None:
2906
raise errors.BzrCommandError("No location specified or remembered")
2907
display_url = urlutils.unescape_for_display(stored_location,
2909
self.outf.write("%s remembered location %s\n" % (verb_string,
2911
return stored_location
2914
class cmd_remerge(Command):
2917
Use this if you want to try a different merge technique while resolving
2918
conflicts. Some merge techniques are better than others, and remerge
2919
lets you try different ones on different files.
2921
The options for remerge have the same meaning and defaults as the ones for
2922
merge. The difference is that remerge can (only) be run when there is a
2923
pending merge, and it lets you specify particular files.
2926
Re-do the merge of all conflicted files, and show the base text in
2927
conflict regions, in addition to the usual THIS and OTHER texts::
2929
bzr remerge --show-base
2931
Re-do the merge of "foobar", using the weave merge algorithm, with
2932
additional processing to reduce the size of conflict regions::
2934
bzr remerge --merge-type weave --reprocess foobar
2936
takes_args = ['file*']
2941
help="Show base revision text in conflicts."),
2944
def run(self, file_list=None, merge_type=None, show_base=False,
2946
if merge_type is None:
2947
merge_type = _mod_merge.Merge3Merger
2948
tree, file_list = tree_files(file_list)
2951
parents = tree.get_parent_ids()
2952
if len(parents) != 2:
2953
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2954
" merges. Not cherrypicking or"
2956
repository = tree.branch.repository
2957
graph = repository.get_graph()
2958
base_revision = graph.find_unique_lca(parents[0], parents[1])
2959
base_tree = repository.revision_tree(base_revision)
2960
other_tree = repository.revision_tree(parents[1])
2961
interesting_ids = None
2963
conflicts = tree.conflicts()
2964
if file_list is not None:
2965
interesting_ids = set()
2966
for filename in file_list:
2967
file_id = tree.path2id(filename)
2969
raise errors.NotVersionedError(filename)
2970
interesting_ids.add(file_id)
2971
if tree.kind(file_id) != "directory":
2974
for name, ie in tree.inventory.iter_entries(file_id):
2975
interesting_ids.add(ie.file_id)
2976
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2978
# Remerge only supports resolving contents conflicts
2979
allowed_conflicts = ('text conflict', 'contents conflict')
2980
restore_files = [c.path for c in conflicts
2981
if c.typestring in allowed_conflicts]
2982
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2983
tree.set_conflicts(ConflictList(new_conflicts))
2984
if file_list is not None:
2985
restore_files = file_list
2986
for filename in restore_files:
2988
restore(tree.abspath(filename))
2989
except errors.NotConflicted:
2991
# Disable pending merges, because the file texts we are remerging
2992
# have not had those merges performed. If we use the wrong parents
2993
# list, we imply that the working tree text has seen and rejected
2994
# all the changes from the other tree, when in fact those changes
2995
# have not yet been seen.
2996
tree.set_parent_ids(parents[:1])
2998
conflicts = _mod_merge.merge_inner(
2999
tree.branch, other_tree, base_tree,
3001
interesting_ids=interesting_ids,
3002
other_rev_id=parents[1],
3003
merge_type=merge_type,
3004
show_base=show_base,
3005
reprocess=reprocess)
3007
tree.set_parent_ids(parents)
3016
class cmd_revert(Command):
3017
"""Revert files to a previous revision.
3019
Giving a list of files will revert only those files. Otherwise, all files
3020
will be reverted. If the revision is not specified with '--revision', the
3021
last committed revision is used.
3023
To remove only some changes, without reverting to a prior version, use
3024
merge instead. For example, "merge . --r-2..-3" will remove the changes
3025
introduced by -2, without affecting the changes introduced by -1. Or
3026
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3028
By default, any files that have been manually changed will be backed up
3029
first. (Files changed only by merge are not backed up.) Backup files have
3030
'.~#~' appended to their name, where # is a number.
3032
When you provide files, you can use their current pathname or the pathname
3033
from the target revision. So you can use revert to "undelete" a file by
3034
name. If you name a directory, all the contents of that directory will be
3037
Any files that have been newly added since that revision will be deleted,
3038
with a backup kept if appropriate. Directories containing unknown files
3039
will not be deleted.
3042
_see_also = ['cat', 'export']
3045
Option('no-backup', "Do not save backups of reverted files."),
3047
takes_args = ['file*']
3049
def run(self, revision=None, no_backup=False, file_list=None):
3050
if file_list is not None:
3051
if len(file_list) == 0:
3052
raise errors.BzrCommandError("No files specified")
3056
tree, file_list = tree_files(file_list)
3057
if revision is None:
3058
# FIXME should be tree.last_revision
3059
rev_id = tree.last_revision()
3060
elif len(revision) != 1:
3061
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3063
rev_id = revision[0].in_history(tree.branch).rev_id
3064
pb = ui.ui_factory.nested_progress_bar()
3066
tree.revert(file_list,
3067
tree.branch.repository.revision_tree(rev_id),
3068
not no_backup, pb, report_changes=True)
3073
class cmd_assert_fail(Command):
3074
"""Test reporting of assertion failures"""
3075
# intended just for use in testing
3080
raise AssertionError("always fails")
3083
class cmd_help(Command):
3084
"""Show help on a command or other topic.
3087
_see_also = ['topics']
3089
Option('long', 'Show help on all commands.'),
3091
takes_args = ['topic?']
3092
aliases = ['?', '--help', '-?', '-h']
3095
def run(self, topic=None, long=False):
3097
if topic is None and long:
3099
bzrlib.help.help(topic)
3102
class cmd_shell_complete(Command):
3103
"""Show appropriate completions for context.
3105
For a list of all available commands, say 'bzr shell-complete'.
3107
takes_args = ['context?']
3112
def run(self, context=None):
3113
import shellcomplete
3114
shellcomplete.shellcomplete(context)
3117
class cmd_fetch(Command):
3118
"""Copy in history from another branch but don't merge it.
3120
This is an internal method used for pull and merge.
3123
takes_args = ['from_branch', 'to_branch']
3124
def run(self, from_branch, to_branch):
3125
from bzrlib.fetch import Fetcher
3126
from_b = Branch.open(from_branch)
3127
to_b = Branch.open(to_branch)
3128
Fetcher(to_b, from_b)
3131
class cmd_missing(Command):
3132
"""Show unmerged/unpulled revisions between two branches.
3134
OTHER_BRANCH may be local or remote.
3137
_see_also = ['merge', 'pull']
3138
takes_args = ['other_branch?']
3140
Option('reverse', 'Reverse the order of revisions.'),
3142
'Display changes in the local branch only.'),
3143
Option('this' , 'Same as --mine-only.'),
3144
Option('theirs-only',
3145
'Display changes in the remote branch only.'),
3146
Option('other', 'Same as --theirs-only.'),
3151
encoding_type = 'replace'
3154
def run(self, other_branch=None, reverse=False, mine_only=False,
3155
theirs_only=False, log_format=None, long=False, short=False, line=False,
3156
show_ids=False, verbose=False, this=False, other=False):
3157
from bzrlib.missing import find_unmerged, iter_log_revisions
3158
from bzrlib.log import log_formatter
3165
local_branch = Branch.open_containing(u".")[0]
3166
parent = local_branch.get_parent()
3167
if other_branch is None:
3168
other_branch = parent
3169
if other_branch is None:
3170
raise errors.BzrCommandError("No peer location known"
3172
display_url = urlutils.unescape_for_display(parent,
3174
self.outf.write("Using last location: " + display_url + "\n")
3176
remote_branch = Branch.open(other_branch)
3177
if remote_branch.base == local_branch.base:
3178
remote_branch = local_branch
3179
local_branch.lock_read()
3181
remote_branch.lock_read()
3183
local_extra, remote_extra = find_unmerged(local_branch,
3185
if log_format is None:
3186
registry = log.log_formatter_registry
3187
log_format = registry.get_default(local_branch)
3188
lf = log_format(to_file=self.outf,
3190
show_timezone='original')
3191
if reverse is False:
3192
local_extra.reverse()
3193
remote_extra.reverse()
3194
if local_extra and not theirs_only:
3195
self.outf.write("You have %d extra revision(s):\n" %
3197
for revision in iter_log_revisions(local_extra,
3198
local_branch.repository,
3200
lf.log_revision(revision)
3201
printed_local = True
3203
printed_local = False
3204
if remote_extra and not mine_only:
3205
if printed_local is True:
3206
self.outf.write("\n\n\n")
3207
self.outf.write("You are missing %d revision(s):\n" %
3209
for revision in iter_log_revisions(remote_extra,
3210
remote_branch.repository,
3212
lf.log_revision(revision)
3213
if not remote_extra and not local_extra:
3215
self.outf.write("Branches are up to date.\n")
3219
remote_branch.unlock()
3221
local_branch.unlock()
3222
if not status_code and parent is None and other_branch is not None:
3223
local_branch.lock_write()
3225
# handle race conditions - a parent might be set while we run.
3226
if local_branch.get_parent() is None:
3227
local_branch.set_parent(remote_branch.base)
3229
local_branch.unlock()
3233
class cmd_pack(Command):
3234
"""Compress the data within a repository."""
3236
_see_also = ['repositories']
3237
takes_args = ['branch_or_repo?']
3239
def run(self, branch_or_repo='.'):
3240
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3242
branch = dir.open_branch()
3243
repository = branch.repository
3244
except errors.NotBranchError:
3245
repository = dir.open_repository()
3249
class cmd_plugins(Command):
3250
"""List the installed plugins.
3252
This command displays the list of installed plugins including the
3253
path where each one is located and a short description of each.
3255
A plugin is an external component for Bazaar that extends the
3256
revision control system, by adding or replacing code in Bazaar.
3257
Plugins can do a variety of things, including overriding commands,
3258
adding new commands, providing additional network transports and
3259
customizing log output.
3261
See the Bazaar web site, http://bazaar-vcs.org, for further
3262
information on plugins including where to find them and how to
3263
install them. Instructions are also provided there on how to
3264
write new plugins using the Python programming language.
3269
import bzrlib.plugin
3270
from inspect import getdoc
3271
for name, plugin in bzrlib.plugin.plugins().items():
3272
print plugin.path(), "[%s]" % plugin.__version__
3273
d = getdoc(plugin.module)
3275
print '\t', d.split('\n')[0]
3278
class cmd_testament(Command):
3279
"""Show testament (signing-form) of a revision."""
3282
Option('long', help='Produce long-format testament.'),
3284
help='Produce a strict-format testament.')]
3285
takes_args = ['branch?']
3287
def run(self, branch=u'.', revision=None, long=False, strict=False):
3288
from bzrlib.testament import Testament, StrictTestament
3290
testament_class = StrictTestament
3292
testament_class = Testament
3293
b = WorkingTree.open_containing(branch)[0].branch
3296
if revision is None:
3297
rev_id = b.last_revision()
3299
rev_id = revision[0].in_history(b).rev_id
3300
t = testament_class.from_revision(b.repository, rev_id)
3302
sys.stdout.writelines(t.as_text_lines())
3304
sys.stdout.write(t.as_short_text())
3309
class cmd_annotate(Command):
3310
"""Show the origin of each line in a file.
3312
This prints out the given file with an annotation on the left side
3313
indicating which revision, author and date introduced the change.
3315
If the origin is the same for a run of consecutive lines, it is
3316
shown only at the top, unless the --all option is given.
3318
# TODO: annotate directories; showing when each file was last changed
3319
# TODO: if the working copy is modified, show annotations on that
3320
# with new uncommitted lines marked
3321
aliases = ['ann', 'blame', 'praise']
3322
takes_args = ['filename']
3323
takes_options = [Option('all', help='Show annotations on all lines.'),
3324
Option('long', help='Show commit date in annotations.'),
3328
encoding_type = 'exact'
3331
def run(self, filename, all=False, long=False, revision=None,
3333
from bzrlib.annotate import annotate_file
3334
tree, relpath = WorkingTree.open_containing(filename)
3335
branch = tree.branch
3338
if revision is None:
3339
revision_id = branch.last_revision()
3340
elif len(revision) != 1:
3341
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3343
revision_id = revision[0].in_history(branch).rev_id
3344
file_id = tree.path2id(relpath)
3346
raise errors.NotVersionedError(filename)
3347
tree = branch.repository.revision_tree(revision_id)
3348
file_version = tree.inventory[file_id].revision
3349
annotate_file(branch, file_version, file_id, long, all, self.outf,
3355
class cmd_re_sign(Command):
3356
"""Create a digital signature for an existing revision."""
3357
# TODO be able to replace existing ones.
3359
hidden = True # is this right ?
3360
takes_args = ['revision_id*']
3361
takes_options = ['revision']
3363
def run(self, revision_id_list=None, revision=None):
3364
import bzrlib.gpg as gpg
3365
if revision_id_list is not None and revision is not None:
3366
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3367
if revision_id_list is None and revision is None:
3368
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3369
b = WorkingTree.open_containing(u'.')[0].branch
3370
gpg_strategy = gpg.GPGStrategy(b.get_config())
3371
if revision_id_list is not None:
3372
for revision_id in revision_id_list:
3373
b.repository.sign_revision(revision_id, gpg_strategy)
3374
elif revision is not None:
3375
if len(revision) == 1:
3376
revno, rev_id = revision[0].in_history(b)
3377
b.repository.sign_revision(rev_id, gpg_strategy)
3378
elif len(revision) == 2:
3379
# are they both on rh- if so we can walk between them
3380
# might be nice to have a range helper for arbitrary
3381
# revision paths. hmm.
3382
from_revno, from_revid = revision[0].in_history(b)
3383
to_revno, to_revid = revision[1].in_history(b)
3384
if to_revid is None:
3385
to_revno = b.revno()
3386
if from_revno is None or to_revno is None:
3387
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3388
for revno in range(from_revno, to_revno + 1):
3389
b.repository.sign_revision(b.get_rev_id(revno),
3392
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3395
class cmd_bind(Command):
3396
"""Convert the current branch into a checkout of the supplied branch.
3398
Once converted into a checkout, commits must succeed on the master branch
3399
before they will be applied to the local branch.
3402
_see_also = ['checkouts', 'unbind']
3403
takes_args = ['location?']
3406
def run(self, location=None):
3407
b, relpath = Branch.open_containing(u'.')
3408
if location is None:
3410
location = b.get_old_bound_location()
3411
except errors.UpgradeRequired:
3412
raise errors.BzrCommandError('No location supplied. '
3413
'This format does not remember old locations.')
3415
if location is None:
3416
raise errors.BzrCommandError('No location supplied and no '
3417
'previous location known')
3418
b_other = Branch.open(location)
3421
except errors.DivergedBranches:
3422
raise errors.BzrCommandError('These branches have diverged.'
3423
' Try merging, and then bind again.')
3426
class cmd_unbind(Command):
3427
"""Convert the current checkout into a regular branch.
3429
After unbinding, the local branch is considered independent and subsequent
3430
commits will be local only.
3433
_see_also = ['checkouts', 'bind']
3438
b, relpath = Branch.open_containing(u'.')
3440
raise errors.BzrCommandError('Local branch is not bound')
3443
class cmd_uncommit(Command):
3444
"""Remove the last committed revision.
3446
--verbose will print out what is being removed.
3447
--dry-run will go through all the motions, but not actually
3450
If --revision is specified, uncommit revisions to leave the branch at the
3451
specified revision. For example, "bzr uncommit -r 15" will leave the
3452
branch at revision 15.
3454
In the future, uncommit will create a revision bundle, which can then
3458
# TODO: jam 20060108 Add an option to allow uncommit to remove
3459
# unreferenced information in 'branch-as-repository' branches.
3460
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3461
# information in shared branches as well.
3462
_see_also = ['commit']
3463
takes_options = ['verbose', 'revision',
3464
Option('dry-run', help='Don\'t actually make changes.'),
3465
Option('force', help='Say yes to all questions.')]
3466
takes_args = ['location?']
3469
def run(self, location=None,
3470
dry_run=False, verbose=False,
3471
revision=None, force=False):
3472
from bzrlib.log import log_formatter, show_log
3474
from bzrlib.uncommit import uncommit
3476
if location is None:
3478
control, relpath = bzrdir.BzrDir.open_containing(location)
3480
tree = control.open_workingtree()
3482
except (errors.NoWorkingTree, errors.NotLocalUrl):
3484
b = control.open_branch()
3487
if revision is None:
3490
# 'bzr uncommit -r 10' actually means uncommit
3491
# so that the final tree is at revno 10.
3492
# but bzrlib.uncommit.uncommit() actually uncommits
3493
# the revisions that are supplied.
3494
# So we need to offset it by one
3495
revno = revision[0].in_history(b).revno+1
3497
if revno <= b.revno():
3498
rev_id = b.get_rev_id(revno)
3500
self.outf.write('No revisions to uncommit.\n')
3503
lf = log_formatter('short',
3505
show_timezone='original')
3510
direction='forward',
3511
start_revision=revno,
3512
end_revision=b.revno())
3515
print 'Dry-run, pretending to remove the above revisions.'
3517
val = raw_input('Press <enter> to continue')
3519
print 'The above revision(s) will be removed.'
3521
val = raw_input('Are you sure [y/N]? ')
3522
if val.lower() not in ('y', 'yes'):
3526
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3530
class cmd_break_lock(Command):
3531
"""Break a dead lock on a repository, branch or working directory.
3533
CAUTION: Locks should only be broken when you are sure that the process
3534
holding the lock has been stopped.
3536
You can get information on what locks are open via the 'bzr info' command.
3541
takes_args = ['location?']
3543
def run(self, location=None, show=False):
3544
if location is None:
3546
control, relpath = bzrdir.BzrDir.open_containing(location)
3548
control.break_lock()
3549
except NotImplementedError:
3553
class cmd_wait_until_signalled(Command):
3554
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3556
This just prints a line to signal when it is ready, then blocks on stdin.
3562
sys.stdout.write("running\n")
3564
sys.stdin.readline()
3567
class cmd_serve(Command):
3568
"""Run the bzr server."""
3570
aliases = ['server']
3574
help='Serve on stdin/out for use from inetd or sshd.'),
3576
help='Listen for connections on nominated port of the form '
3577
'[hostname:]portnumber. Passing 0 as the port number will '
3578
'result in a dynamically allocated port. The default port is '
3582
help='Serve contents of this directory.',
3584
Option('allow-writes',
3585
help='By default the server is a readonly server. Supplying '
3586
'--allow-writes enables write access to the contents of '
3587
'the served directory and below.'
3591
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3592
from bzrlib.smart import medium, server
3593
from bzrlib.transport import get_transport
3594
from bzrlib.transport.chroot import ChrootServer
3595
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3596
if directory is None:
3597
directory = os.getcwd()
3598
url = urlutils.local_path_to_url(directory)
3599
if not allow_writes:
3600
url = 'readonly+' + url
3601
chroot_server = ChrootServer(get_transport(url))
3602
chroot_server.setUp()
3603
t = get_transport(chroot_server.get_url())
3605
smart_server = medium.SmartServerPipeStreamMedium(
3606
sys.stdin, sys.stdout, t)
3608
host = BZR_DEFAULT_INTERFACE
3610
port = BZR_DEFAULT_PORT
3613
host, port = port.split(':')
3615
smart_server = server.SmartTCPServer(t, host=host, port=port)
3616
print 'listening on port: ', smart_server.port
3618
# for the duration of this server, no UI output is permitted.
3619
# note that this may cause problems with blackbox tests. This should
3620
# be changed with care though, as we dont want to use bandwidth sending
3621
# progress over stderr to smart server clients!
3622
old_factory = ui.ui_factory
3624
ui.ui_factory = ui.SilentUIFactory()
3625
smart_server.serve()
3627
ui.ui_factory = old_factory
3630
class cmd_join(Command):
3631
"""Combine a subtree into its containing tree.
3633
This command is for experimental use only. It requires the target tree
3634
to be in dirstate-with-subtree format, which cannot be converted into
3637
The TREE argument should be an independent tree, inside another tree, but
3638
not part of it. (Such trees can be produced by "bzr split", but also by
3639
running "bzr branch" with the target inside a tree.)
3641
The result is a combined tree, with the subtree no longer an independant
3642
part. This is marked as a merge of the subtree into the containing tree,
3643
and all history is preserved.
3645
If --reference is specified, the subtree retains its independence. It can
3646
be branched by itself, and can be part of multiple projects at the same
3647
time. But operations performed in the containing tree, such as commit
3648
and merge, will recurse into the subtree.
3651
_see_also = ['split']
3652
takes_args = ['tree']
3654
Option('reference', help='Join by reference.'),
3658
def run(self, tree, reference=False):
3659
sub_tree = WorkingTree.open(tree)
3660
parent_dir = osutils.dirname(sub_tree.basedir)
3661
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3662
repo = containing_tree.branch.repository
3663
if not repo.supports_rich_root():
3664
raise errors.BzrCommandError(
3665
"Can't join trees because %s doesn't support rich root data.\n"
3666
"You can use bzr upgrade on the repository."
3670
containing_tree.add_reference(sub_tree)
3671
except errors.BadReferenceTarget, e:
3672
# XXX: Would be better to just raise a nicely printable
3673
# exception from the real origin. Also below. mbp 20070306
3674
raise errors.BzrCommandError("Cannot join %s. %s" %
3678
containing_tree.subsume(sub_tree)
3679
except errors.BadSubsumeSource, e:
3680
raise errors.BzrCommandError("Cannot join %s. %s" %
3684
class cmd_split(Command):
3685
"""Split a tree into two trees.
3687
This command is for experimental use only. It requires the target tree
3688
to be in dirstate-with-subtree format, which cannot be converted into
3691
The TREE argument should be a subdirectory of a working tree. That
3692
subdirectory will be converted into an independent tree, with its own
3693
branch. Commits in the top-level tree will not apply to the new subtree.
3694
If you want that behavior, do "bzr join --reference TREE".
3697
_see_also = ['join']
3698
takes_args = ['tree']
3702
def run(self, tree):
3703
containing_tree, subdir = WorkingTree.open_containing(tree)
3704
sub_id = containing_tree.path2id(subdir)
3706
raise errors.NotVersionedError(subdir)
3708
containing_tree.extract(sub_id)
3709
except errors.RootNotRich:
3710
raise errors.UpgradeRequired(containing_tree.branch.base)
3714
class cmd_merge_directive(Command):
3715
"""Generate a merge directive for auto-merge tools.
3717
A directive requests a merge to be performed, and also provides all the
3718
information necessary to do so. This means it must either include a
3719
revision bundle, or the location of a branch containing the desired
3722
A submit branch (the location to merge into) must be supplied the first
3723
time the command is issued. After it has been supplied once, it will
3724
be remembered as the default.
3726
A public branch is optional if a revision bundle is supplied, but required
3727
if --diff or --plain is specified. It will be remembered as the default
3728
after the first use.
3731
takes_args = ['submit_branch?', 'public_branch?']
3735
_see_also = ['send']
3738
RegistryOption.from_kwargs('patch-type',
3739
'The type of patch to include in the directive.',
3741
value_switches=True,
3743
bundle='Bazaar revision bundle (default).',
3744
diff='Normal unified diff.',
3745
plain='No patch, just directive.'),
3746
Option('sign', help='GPG-sign the directive.'), 'revision',
3747
Option('mail-to', type=str,
3748
help='Instead of printing the directive, email to this address.'),
3749
Option('message', type=str, short_name='m',
3750
help='Message to use when committing this merge.')
3753
encoding_type = 'exact'
3755
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3756
sign=False, revision=None, mail_to=None, message=None):
3757
from bzrlib.revision import ensure_null, NULL_REVISION
3758
include_patch, include_bundle = {
3759
'plain': (False, False),
3760
'diff': (True, False),
3761
'bundle': (True, True),
3763
branch = Branch.open('.')
3764
stored_submit_branch = branch.get_submit_branch()
3765
if submit_branch is None:
3766
submit_branch = stored_submit_branch
3768
if stored_submit_branch is None:
3769
branch.set_submit_branch(submit_branch)
3770
if submit_branch is None:
3771
submit_branch = branch.get_parent()
3772
if submit_branch is None:
3773
raise errors.BzrCommandError('No submit branch specified or known')
3775
stored_public_branch = branch.get_public_branch()
3776
if public_branch is None:
3777
public_branch = stored_public_branch
3778
elif stored_public_branch is None:
3779
branch.set_public_branch(public_branch)
3780
if not include_bundle and public_branch is None:
3781
raise errors.BzrCommandError('No public branch specified or'
3783
base_revision_id = None
3784
if revision is not None:
3785
if len(revision) > 2:
3786
raise errors.BzrCommandError('bzr merge-directive takes '
3787
'at most two one revision identifiers')
3788
revision_id = revision[-1].in_history(branch).rev_id
3789
if len(revision) == 2:
3790
base_revision_id = revision[0].in_history(branch).rev_id
3791
base_revision_id = ensure_null(base_revision_id)
3793
revision_id = branch.last_revision()
3794
revision_id = ensure_null(revision_id)
3795
if revision_id == NULL_REVISION:
3796
raise errors.BzrCommandError('No revisions to bundle.')
3797
directive = merge_directive.MergeDirective2.from_objects(
3798
branch.repository, revision_id, time.time(),
3799
osutils.local_time_offset(), submit_branch,
3800
public_branch=public_branch, include_patch=include_patch,
3801
include_bundle=include_bundle, message=message,
3802
base_revision_id=base_revision_id)
3805
self.outf.write(directive.to_signed(branch))
3807
self.outf.writelines(directive.to_lines())
3809
message = directive.to_email(mail_to, branch, sign)
3810
s = SMTPConnection(branch.get_config())
3811
s.send_email(message)
3814
class cmd_send(Command):
3815
"""Mail or create a merge-directive for submiting changes.
3817
A merge directive provides many things needed for requesting merges:
3819
* A machine-readable description of the merge to perform
3821
* An optional patch that is a preview of the changes requested
3823
* An optional bundle of revision data, so that the changes can be applied
3824
directly from the merge directive, without retrieving data from a
3827
If --no-bundle is specified, then public_branch is needed (and must be
3828
up-to-date), so that the receiver can perform the merge using the
3829
public_branch. The public_branch is always included if known, so that
3830
people can check it later.
3832
The submit branch defaults to the parent, but can be overridden. Both
3833
submit branch and public branch will be remembered if supplied.
3835
If a public_branch is known for the submit_branch, that public submit
3836
branch is used in the merge instructions. This means that a local mirror
3837
can be used as your actual submit branch, once you have set public_branch
3840
Mail is sent using your preferred mail program. This should be transparent
3841
on Windows (it uses MAPI). On *nix, it requires the xdg-email utility. If
3842
the preferred client can't be found (or used), your editor will be used.
3844
To use a specific mail program, set the mail_client configuration option.
3845
(For Thunderbird 1.5, this works around some bugs.) Supported values are
3846
"thunderbird", "evolution", "editor", "xdg-email", "mapi", "kmail" and
3849
If mail is being sent, a to address is required. This can be supplied
3850
either on the commandline, or by setting the submit_to configuration
3853
Two formats are currently supported: "4" uses revision bundle format 4 and
3854
merge directive format 2. It is significantly faster and smaller than
3855
older formats. It is compatible with Bazaar 0.19 and later. It is the
3856
default. "0.9" uses revision bundle format 0.9 and merge directive
3857
format 1. It is compatible with Bazaar 0.12 - 0.18.
3860
encoding_type = 'exact'
3862
_see_also = ['merge', 'doc/configuration.txt']
3864
takes_args = ['submit_branch?', 'public_branch?']
3868
help='Do not include a bundle in the merge directive.'),
3869
Option('no-patch', help='Do not include a preview patch in the merge'
3872
help='Remember submit and public branch.'),
3874
help='Branch to generate the submission from, '
3875
'rather than the one containing the working directory.',
3878
Option('output', short_name='o', help='Write directive to this file.',
3880
Option('mail-to', help='Mail the request to this address.',
3884
RegistryOption.from_kwargs('format',
3885
'Use the specified output format.',
3886
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
3887
'0.9': 'Bundle format 0.9, Merge Directive 1',})
3890
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3891
no_patch=False, revision=None, remember=False, output=None,
3892
format='4', mail_to=None, message=None, **kwargs):
3893
return self._run(submit_branch, revision, public_branch, remember,
3894
format, no_bundle, no_patch, output,
3895
kwargs.get('from', '.'), mail_to, message)
3897
def _run(self, submit_branch, revision, public_branch, remember, format,
3898
no_bundle, no_patch, output, from_, mail_to, message):
3899
from bzrlib.revision import ensure_null, NULL_REVISION
3901
outfile = StringIO()
3905
outfile = open(output, 'wb')
3907
branch = Branch.open_containing(from_)[0]
3909
config = branch.get_config()
3911
mail_to = config.get_user_option('submit_to')
3913
raise errors.BzrCommandError('No mail-to address'
3915
mail_client = config.get_mail_client()
3916
if remember and submit_branch is None:
3917
raise errors.BzrCommandError(
3918
'--remember requires a branch to be specified.')
3919
stored_submit_branch = branch.get_submit_branch()
3920
remembered_submit_branch = False
3921
if submit_branch is None:
3922
submit_branch = stored_submit_branch
3923
remembered_submit_branch = True
3925
if stored_submit_branch is None or remember:
3926
branch.set_submit_branch(submit_branch)
3927
if submit_branch is None:
3928
submit_branch = branch.get_parent()
3929
remembered_submit_branch = True
3930
if submit_branch is None:
3931
raise errors.BzrCommandError('No submit branch known or'
3933
if remembered_submit_branch:
3934
note('Using saved location: %s', submit_branch)
3936
stored_public_branch = branch.get_public_branch()
3937
if public_branch is None:
3938
public_branch = stored_public_branch
3939
elif stored_public_branch is None or remember:
3940
branch.set_public_branch(public_branch)
3941
if no_bundle and public_branch is None:
3942
raise errors.BzrCommandError('No public branch specified or'
3944
base_revision_id = None
3946
if revision is not None:
3947
if len(revision) > 2:
3948
raise errors.BzrCommandError('bzr send takes '
3949
'at most two one revision identifiers')
3950
revision_id = revision[-1].in_history(branch).rev_id
3951
if len(revision) == 2:
3952
base_revision_id = revision[0].in_history(branch).rev_id
3953
if revision_id is None:
3954
revision_id = branch.last_revision()
3955
if revision_id == NULL_REVISION:
3956
raise errors.BzrCommandError('No revisions to submit.')
3958
directive = merge_directive.MergeDirective2.from_objects(
3959
branch.repository, revision_id, time.time(),
3960
osutils.local_time_offset(), submit_branch,
3961
public_branch=public_branch, include_patch=not no_patch,
3962
include_bundle=not no_bundle, message=message,
3963
base_revision_id=base_revision_id)
3964
elif format == '0.9':
3967
patch_type = 'bundle'
3969
raise errors.BzrCommandError('Format 0.9 does not'
3970
' permit bundle with no patch')
3976
directive = merge_directive.MergeDirective.from_objects(
3977
branch.repository, revision_id, time.time(),
3978
osutils.local_time_offset(), submit_branch,
3979
public_branch=public_branch, patch_type=patch_type,
3982
outfile.writelines(directive.to_lines())
3984
subject = '[MERGE] '
3985
if message is not None:
3988
revision = branch.repository.get_revision(revision_id)
3989
subject += revision.get_summary()
3990
mail_client.compose_merge_request(mail_to, subject,
3997
class cmd_bundle_revisions(cmd_send):
3999
"""Create a merge-directive for submiting changes.
4001
A merge directive provides many things needed for requesting merges:
4003
* A machine-readable description of the merge to perform
4005
* An optional patch that is a preview of the changes requested
4007
* An optional bundle of revision data, so that the changes can be applied
4008
directly from the merge directive, without retrieving data from a
4011
If --no-bundle is specified, then public_branch is needed (and must be
4012
up-to-date), so that the receiver can perform the merge using the
4013
public_branch. The public_branch is always included if known, so that
4014
people can check it later.
4016
The submit branch defaults to the parent, but can be overridden. Both
4017
submit branch and public branch will be remembered if supplied.
4019
If a public_branch is known for the submit_branch, that public submit
4020
branch is used in the merge instructions. This means that a local mirror
4021
can be used as your actual submit branch, once you have set public_branch
4024
Two formats are currently supported: "4" uses revision bundle format 4 and
4025
merge directive format 2. It is significantly faster and smaller than
4026
older formats. It is compatible with Bazaar 0.19 and later. It is the
4027
default. "0.9" uses revision bundle format 0.9 and merge directive
4028
format 1. It is compatible with Bazaar 0.12 - 0.18.
4033
help='Do not include a bundle in the merge directive.'),
4034
Option('no-patch', help='Do not include a preview patch in the merge'
4037
help='Remember submit and public branch.'),
4039
help='Branch to generate the submission from, '
4040
'rather than the one containing the working directory.',
4043
Option('output', short_name='o', help='Write directive to this file.',
4046
RegistryOption.from_kwargs('format',
4047
'Use the specified output format.',
4048
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4049
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4051
aliases = ['bundle']
4053
_see_also = ['send', 'merge']
4057
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4058
no_patch=False, revision=None, remember=False, output=None,
4059
format='4', **kwargs):
4062
return self._run(submit_branch, revision, public_branch, remember,
4063
format, no_bundle, no_patch, output,
4064
kwargs.get('from', '.'), None, None)
4067
class cmd_tag(Command):
4068
"""Create, remove or modify a tag naming a revision.
4070
Tags give human-meaningful names to revisions. Commands that take a -r
4071
(--revision) option can be given -rtag:X, where X is any previously
4074
Tags are stored in the branch. Tags are copied from one branch to another
4075
along when you branch, push, pull or merge.
4077
It is an error to give a tag name that already exists unless you pass
4078
--force, in which case the tag is moved to point to the new revision.
4081
_see_also = ['commit', 'tags']
4082
takes_args = ['tag_name']
4085
help='Delete this tag rather than placing it.',
4088
help='Branch in which to place the tag.',
4093
help='Replace existing tags.',
4098
def run(self, tag_name,
4104
branch, relpath = Branch.open_containing(directory)
4108
branch.tags.delete_tag(tag_name)
4109
self.outf.write('Deleted tag %s.\n' % tag_name)
4112
if len(revision) != 1:
4113
raise errors.BzrCommandError(
4114
"Tags can only be placed on a single revision, "
4116
revision_id = revision[0].in_history(branch).rev_id
4118
revision_id = branch.last_revision()
4119
if (not force) and branch.tags.has_tag(tag_name):
4120
raise errors.TagAlreadyExists(tag_name)
4121
branch.tags.set_tag(tag_name, revision_id)
4122
self.outf.write('Created tag %s.\n' % tag_name)
4127
class cmd_tags(Command):
4130
This tag shows a table of tag names and the revisions they reference.
4136
help='Branch whose tags should be displayed.',
4146
branch, relpath = Branch.open_containing(directory)
4147
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
4148
self.outf.write('%-20s %s\n' % (tag_name, target))
4151
def _create_prefix(cur_transport):
4152
needed = [cur_transport]
4153
# Recurse upwards until we can create a directory successfully
4155
new_transport = cur_transport.clone('..')
4156
if new_transport.base == cur_transport.base:
4157
raise errors.BzrCommandError(
4158
"Failed to create path prefix for %s."
4159
% cur_transport.base)
4161
new_transport.mkdir('.')
4162
except errors.NoSuchFile:
4163
needed.append(new_transport)
4164
cur_transport = new_transport
4167
# Now we only need to create child directories
4169
cur_transport = needed.pop()
4170
cur_transport.ensure_base()
4173
def _get_mergeable_helper(location):
4174
"""Get a merge directive or bundle if 'location' points to one.
4176
Try try to identify a bundle and returns its mergeable form. If it's not,
4177
we return the tried transport anyway so that it can reused to access the
4180
:param location: can point to a bundle or a branch.
4182
:return: mergeable, transport
4185
url = urlutils.normalize_url(location)
4186
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4187
location_transport = transport.get_transport(url)
4190
# There may be redirections but we ignore the intermediate
4191
# and final transports used
4192
read = bundle.read_mergeable_from_transport
4193
mergeable, t = read(location_transport, filename)
4194
except errors.NotABundle:
4195
# Continue on considering this url a Branch but adjust the
4196
# location_transport
4197
location_transport = location_transport.clone(filename)
4198
return mergeable, location_transport
4201
# these get imported and then picked up by the scan for cmd_*
4202
# TODO: Some more consistent way to split command definitions across files;
4203
# we do need to load at least some information about them to know of
4204
# aliases. ideally we would avoid loading the implementation until the
4205
# details were needed.
4206
from bzrlib.cmd_version_info import cmd_version_info
4207
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4208
from bzrlib.bundle.commands import (
4211
from bzrlib.sign_my_commits import cmd_sign_my_commits
4212
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4213
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
