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(), """
43
revision as _mod_revision,
50
from bzrlib.branch import Branch
51
from bzrlib.conflicts import ConflictList
52
from bzrlib.revisionspec import RevisionSpec
53
from bzrlib.smtp_connection import SMTPConnection
54
from bzrlib.workingtree import WorkingTree
57
from bzrlib.commands import Command, display_command
58
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
59
from bzrlib.trace import mutter, note, warning, is_quiet, info
62
def tree_files(file_list, default_branch=u'.'):
64
return internal_tree_files(file_list, default_branch)
65
except errors.FileInWrongBranch, e:
66
raise errors.BzrCommandError("%s is not in the same branch as %s" %
67
(e.path, file_list[0]))
70
# XXX: Bad function name; should possibly also be a class method of
71
# WorkingTree rather than a function.
72
def internal_tree_files(file_list, default_branch=u'.'):
73
"""Convert command-line paths to a WorkingTree and relative paths.
75
This is typically used for command-line processors that take one or
76
more filenames, and infer the workingtree that contains them.
78
The filenames given are not required to exist.
80
:param file_list: Filenames to convert.
82
:param default_branch: Fallback tree path to use if file_list is empty or
85
:return: workingtree, [relative_paths]
87
if file_list is None or len(file_list) == 0:
88
return WorkingTree.open_containing(default_branch)[0], file_list
89
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
91
for filename in file_list:
93
new_list.append(tree.relpath(osutils.dereference_path(filename)))
94
except errors.PathNotChild:
95
raise errors.FileInWrongBranch(tree.branch, filename)
99
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
100
def get_format_type(typestring):
101
"""Parse and return a format specifier."""
102
# Have to use BzrDirMetaFormat1 directly, so that
103
# RepositoryFormat.set_default_format works
104
if typestring == "default":
105
return bzrdir.BzrDirMetaFormat1()
107
return bzrdir.format_registry.make_bzrdir(typestring)
109
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
110
raise errors.BzrCommandError(msg)
113
# TODO: Make sure no commands unconditionally use the working directory as a
114
# branch. If a filename argument is used, the first of them should be used to
115
# specify the branch. (Perhaps this can be factored out into some kind of
116
# Argument class, representing a file in a branch, where the first occurrence
119
class cmd_status(Command):
120
"""Display status summary.
122
This reports on versioned and unknown files, reporting them
123
grouped by state. Possible states are:
126
Versioned in the working copy but not in the previous revision.
129
Versioned in the previous revision but removed or deleted
133
Path of this file changed from the previous revision;
134
the text may also have changed. This includes files whose
135
parent directory was renamed.
138
Text has changed since the previous revision.
141
File kind has been changed (e.g. from file to directory).
144
Not versioned and not matching an ignore pattern.
146
To see ignored files use 'bzr ignored'. For details on the
147
changes to file texts, use 'bzr diff'.
149
Note that --short or -S gives status flags for each item, similar
150
to Subversion's status command. To get output similar to svn -q,
153
If no arguments are specified, the status of the entire working
154
directory is shown. Otherwise, only the status of the specified
155
files or directories is reported. If a directory is given, status
156
is reported for everything inside that directory.
158
If a revision argument is given, the status is calculated against
159
that revision, or between two revisions if two are provided.
162
# TODO: --no-recurse, --recurse options
164
takes_args = ['file*']
165
takes_options = ['show-ids', 'revision', 'change',
166
Option('short', help='Use short status indicators.',
168
Option('versioned', help='Only show versioned files.',
171
aliases = ['st', 'stat']
173
encoding_type = 'replace'
174
_see_also = ['diff', 'revert', 'status-flags']
177
def run(self, show_ids=False, file_list=None, revision=None, short=False,
179
from bzrlib.status import show_tree_status
181
if revision and len(revision) > 2:
182
raise errors.BzrCommandError('bzr status --revision takes exactly'
183
' one or two revision specifiers')
185
tree, file_list = tree_files(file_list)
187
show_tree_status(tree, show_ids=show_ids,
188
specific_files=file_list, revision=revision,
189
to_file=self.outf, short=short, versioned=versioned)
192
class cmd_cat_revision(Command):
193
"""Write out metadata for a revision.
195
The revision to print can either be specified by a specific
196
revision identifier, or you can use --revision.
200
takes_args = ['revision_id?']
201
takes_options = ['revision']
202
# cat-revision is more for frontends so should be exact
206
def run(self, revision_id=None, revision=None):
208
revision_id = osutils.safe_revision_id(revision_id, warn=False)
209
if revision_id is not None and revision is not None:
210
raise errors.BzrCommandError('You can only supply one of'
211
' revision_id or --revision')
212
if revision_id is None and revision is None:
213
raise errors.BzrCommandError('You must supply either'
214
' --revision or a revision_id')
215
b = WorkingTree.open_containing(u'.')[0].branch
217
# TODO: jam 20060112 should cat-revision always output utf-8?
218
if revision_id is not None:
219
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
220
elif revision is not None:
223
raise errors.BzrCommandError('You cannot specify a NULL'
225
revno, rev_id = rev.in_history(b)
226
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
229
class cmd_remove_tree(Command):
230
"""Remove the working tree from a given branch/checkout.
232
Since a lightweight checkout is little more than a working tree
233
this will refuse to run against one.
235
To re-create the working tree, use "bzr checkout".
237
_see_also = ['checkout', 'working-trees']
239
takes_args = ['location?']
241
def run(self, location='.'):
242
d = bzrdir.BzrDir.open(location)
245
working = d.open_workingtree()
246
except errors.NoWorkingTree:
247
raise errors.BzrCommandError("No working tree to remove")
248
except errors.NotLocalUrl:
249
raise errors.BzrCommandError("You cannot remove the working tree of a "
252
working_path = working.bzrdir.root_transport.base
253
branch_path = working.branch.bzrdir.root_transport.base
254
if working_path != branch_path:
255
raise errors.BzrCommandError("You cannot remove the working tree from "
256
"a lightweight checkout")
258
d.destroy_workingtree()
261
class cmd_revno(Command):
262
"""Show current revision number.
264
This is equal to the number of revisions on this branch.
268
takes_args = ['location?']
271
def run(self, location=u'.'):
272
self.outf.write(str(Branch.open_containing(location)[0].revno()))
273
self.outf.write('\n')
276
class cmd_revision_info(Command):
277
"""Show revision number and revision id for a given revision identifier.
280
takes_args = ['revision_info*']
281
takes_options = ['revision']
284
def run(self, revision=None, revision_info_list=[]):
287
if revision is not None:
288
revs.extend(revision)
289
if revision_info_list is not None:
290
for rev in revision_info_list:
291
revs.append(RevisionSpec.from_string(rev))
293
b = Branch.open_containing(u'.')[0]
296
revs.append(RevisionSpec.from_string('-1'))
299
revinfo = rev.in_history(b)
300
if revinfo.revno is None:
301
dotted_map = b.get_revision_id_to_revno_map()
302
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
303
print '%s %s' % (revno, revinfo.rev_id)
305
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
308
class cmd_add(Command):
309
"""Add specified files or directories.
311
In non-recursive mode, all the named items are added, regardless
312
of whether they were previously ignored. A warning is given if
313
any of the named files are already versioned.
315
In recursive mode (the default), files are treated the same way
316
but the behaviour for directories is different. Directories that
317
are already versioned do not give a warning. All directories,
318
whether already versioned or not, are searched for files or
319
subdirectories that are neither versioned or ignored, and these
320
are added. This search proceeds recursively into versioned
321
directories. If no names are given '.' is assumed.
323
Therefore simply saying 'bzr add' will version all files that
324
are currently unknown.
326
Adding a file whose parent directory is not versioned will
327
implicitly add the parent, and so on up to the root. This means
328
you should never need to explicitly add a directory, they'll just
329
get added when you add a file in the directory.
331
--dry-run will show which files would be added, but not actually
334
--file-ids-from will try to use the file ids from the supplied path.
335
It looks up ids trying to find a matching parent directory with the
336
same filename, and then by pure path. This option is rarely needed
337
but can be useful when adding the same logical file into two
338
branches that will be merged later (without showing the two different
339
adds as a conflict). It is also useful when merging another project
340
into a subdirectory of this one.
342
takes_args = ['file*']
345
help="Don't recursively add the contents of directories."),
347
help="Show what would be done, but don't actually do anything."),
349
Option('file-ids-from',
351
help='Lookup file ids from this tree.'),
353
encoding_type = 'replace'
354
_see_also = ['remove']
356
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
361
if file_ids_from is not None:
363
base_tree, base_path = WorkingTree.open_containing(
365
except errors.NoWorkingTree:
366
base_branch, base_path = Branch.open_containing(
368
base_tree = base_branch.basis_tree()
370
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
371
to_file=self.outf, should_print=(not is_quiet()))
373
action = bzrlib.add.AddAction(to_file=self.outf,
374
should_print=(not is_quiet()))
377
base_tree.lock_read()
379
file_list = self._maybe_expand_globs(file_list)
381
tree = WorkingTree.open_containing(file_list[0])[0]
383
tree = WorkingTree.open_containing(u'.')[0]
384
added, ignored = tree.smart_add(file_list, not
385
no_recurse, action=action, save=not dry_run)
387
if base_tree is not None:
391
for glob in sorted(ignored.keys()):
392
for path in ignored[glob]:
393
self.outf.write("ignored %s matching \"%s\"\n"
397
for glob, paths in ignored.items():
398
match_len += len(paths)
399
self.outf.write("ignored %d file(s).\n" % match_len)
400
self.outf.write("If you wish to add some of these files,"
401
" please add them by name.\n")
404
class cmd_mkdir(Command):
405
"""Create a new versioned directory.
407
This is equivalent to creating the directory and then adding it.
410
takes_args = ['dir+']
411
encoding_type = 'replace'
413
def run(self, dir_list):
416
wt, dd = WorkingTree.open_containing(d)
418
self.outf.write('added %s\n' % d)
421
class cmd_relpath(Command):
422
"""Show path of a file relative to root"""
424
takes_args = ['filename']
428
def run(self, filename):
429
# TODO: jam 20050106 Can relpath return a munged path if
430
# sys.stdout encoding cannot represent it?
431
tree, relpath = WorkingTree.open_containing(filename)
432
self.outf.write(relpath)
433
self.outf.write('\n')
436
class cmd_inventory(Command):
437
"""Show inventory of the current working copy or a revision.
439
It is possible to limit the output to a particular entry
440
type using the --kind option. For example: --kind file.
442
It is also possible to restrict the list of files to a specific
443
set. For example: bzr inventory --show-ids this/file
452
help='List entries of a particular kind: file, directory, symlink.',
455
takes_args = ['file*']
458
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
459
if kind and kind not in ['file', 'directory', 'symlink']:
460
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
462
work_tree, file_list = tree_files(file_list)
463
work_tree.lock_read()
465
if revision is not None:
466
if len(revision) > 1:
467
raise errors.BzrCommandError(
468
'bzr inventory --revision takes exactly one revision'
470
revision_id = revision[0].in_history(work_tree.branch).rev_id
471
tree = work_tree.branch.repository.revision_tree(revision_id)
473
extra_trees = [work_tree]
479
if file_list is not None:
480
file_ids = tree.paths2ids(file_list, trees=extra_trees,
481
require_versioned=True)
482
# find_ids_across_trees may include some paths that don't
484
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
485
for file_id in file_ids if file_id in tree)
487
entries = tree.inventory.entries()
490
if tree is not work_tree:
493
for path, entry in entries:
494
if kind and kind != entry.kind:
497
self.outf.write('%-50s %s\n' % (path, entry.file_id))
499
self.outf.write(path)
500
self.outf.write('\n')
503
class cmd_mv(Command):
504
"""Move or rename a file.
507
bzr mv OLDNAME NEWNAME
509
bzr mv SOURCE... DESTINATION
511
If the last argument is a versioned directory, all the other names
512
are moved into it. Otherwise, there must be exactly two arguments
513
and the file is changed to a new name.
515
If OLDNAME does not exist on the filesystem but is versioned and
516
NEWNAME does exist on the filesystem but is not versioned, mv
517
assumes that the file has been manually moved and only updates
518
its internal inventory to reflect that change.
519
The same is valid when moving many SOURCE files to a DESTINATION.
521
Files cannot be moved between branches.
524
takes_args = ['names*']
525
takes_options = [Option("after", help="Move only the bzr identifier"
526
" of the file, because the file has already been moved."),
528
aliases = ['move', 'rename']
529
encoding_type = 'replace'
531
def run(self, names_list, after=False):
532
if names_list is None:
535
if len(names_list) < 2:
536
raise errors.BzrCommandError("missing file argument")
537
tree, rel_names = tree_files(names_list)
539
if os.path.isdir(names_list[-1]):
540
# move into existing directory
541
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
542
self.outf.write("%s => %s\n" % pair)
544
if len(names_list) != 2:
545
raise errors.BzrCommandError('to mv multiple files the'
546
' destination must be a versioned'
548
tree.rename_one(rel_names[0], rel_names[1], after=after)
549
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
552
class cmd_pull(Command):
553
"""Turn this branch into a mirror of another branch.
555
This command only works on branches that have not diverged. Branches are
556
considered diverged if the destination branch's most recent commit is one
557
that has not been merged (directly or indirectly) into the parent.
559
If branches have diverged, you can use 'bzr merge' to integrate the changes
560
from one into the other. Once one branch has merged, the other should
561
be able to pull it again.
563
If you want to forget your local changes and just update your branch to
564
match the remote one, use pull --overwrite.
566
If there is no default location set, the first pull will set it. After
567
that, you can omit the location to use the default. To change the
568
default, use --remember. The value will only be saved if the remote
569
location can be accessed.
572
_see_also = ['push', 'update', 'status-flags']
573
takes_options = ['remember', 'overwrite', 'revision',
574
custom_help('verbose',
575
help='Show logs of pulled revisions.'),
577
help='Branch to pull into, '
578
'rather than the one containing the working directory.',
583
takes_args = ['location?']
584
encoding_type = 'replace'
586
def run(self, location=None, remember=False, overwrite=False,
587
revision=None, verbose=False,
589
# FIXME: too much stuff is in the command class
592
if directory is None:
595
tree_to = WorkingTree.open_containing(directory)[0]
596
branch_to = tree_to.branch
597
except errors.NoWorkingTree:
599
branch_to = Branch.open_containing(directory)[0]
601
if location is not None:
602
mergeable, location_transport = _get_mergeable_helper(location)
604
stored_loc = branch_to.get_parent()
606
if stored_loc is None:
607
raise errors.BzrCommandError("No pull location known or"
610
display_url = urlutils.unescape_for_display(stored_loc,
612
self.outf.write("Using saved location: %s\n" % display_url)
613
location = stored_loc
614
location_transport = transport.get_transport(location)
616
if mergeable is not None:
617
if revision is not None:
618
raise errors.BzrCommandError(
619
'Cannot use -r with merge directives or bundles')
620
mergeable.install_revisions(branch_to.repository)
621
base_revision_id, revision_id, verified = \
622
mergeable.get_merge_request(branch_to.repository)
623
branch_from = branch_to
625
branch_from = Branch.open_from_transport(location_transport)
627
if branch_to.get_parent() is None or remember:
628
branch_to.set_parent(branch_from.base)
630
if revision is not None:
631
if len(revision) == 1:
632
revision_id = revision[0].in_history(branch_from).rev_id
634
raise errors.BzrCommandError(
635
'bzr pull --revision takes one value.')
638
old_rh = branch_to.revision_history()
639
if tree_to is not None:
640
result = tree_to.pull(branch_from, overwrite, revision_id,
641
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
643
result = branch_to.pull(branch_from, overwrite, revision_id)
645
result.report(self.outf)
647
new_rh = branch_to.revision_history()
648
log.show_changed_revisions(branch_to, old_rh, new_rh,
652
class cmd_push(Command):
653
"""Update a mirror of this branch.
655
The target branch will not have its working tree populated because this
656
is both expensive, and is not supported on remote file systems.
658
Some smart servers or protocols *may* put the working tree in place in
661
This command only works on branches that have not diverged. Branches are
662
considered diverged if the destination branch's most recent commit is one
663
that has not been merged (directly or indirectly) by the source branch.
665
If branches have diverged, you can use 'bzr push --overwrite' to replace
666
the other branch completely, discarding its unmerged changes.
668
If you want to ensure you have the different changes in the other branch,
669
do a merge (see bzr help merge) from the other branch, and commit that.
670
After that you will be able to do a push without '--overwrite'.
672
If there is no default push location set, the first push will set it.
673
After that, you can omit the location to use the default. To change the
674
default, use --remember. The value will only be saved if the remote
675
location can be accessed.
678
_see_also = ['pull', 'update', 'working-trees']
679
takes_options = ['remember', 'overwrite', 'verbose',
680
Option('create-prefix',
681
help='Create the path leading up to the branch '
682
'if it does not already exist.'),
684
help='Branch to push from, '
685
'rather than the one containing the working directory.',
689
Option('use-existing-dir',
690
help='By default push will fail if the target'
691
' directory exists, but does not already'
692
' have a control directory. This flag will'
693
' allow push to proceed.'),
695
takes_args = ['location?']
696
encoding_type = 'replace'
698
def run(self, location=None, remember=False, overwrite=False,
699
create_prefix=False, verbose=False,
700
use_existing_dir=False,
702
# FIXME: Way too big! Put this into a function called from the
704
if directory is None:
706
br_from = Branch.open_containing(directory)[0]
707
stored_loc = br_from.get_push_location()
709
if stored_loc is None:
710
raise errors.BzrCommandError("No push location known or specified.")
712
display_url = urlutils.unescape_for_display(stored_loc,
714
self.outf.write("Using saved location: %s\n" % display_url)
715
location = stored_loc
717
to_transport = transport.get_transport(location)
719
br_to = repository_to = dir_to = None
721
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
722
except errors.NotBranchError:
723
pass # Didn't find anything
725
# If we can open a branch, use its direct repository, otherwise see
726
# if there is a repository without a branch.
728
br_to = dir_to.open_branch()
729
except errors.NotBranchError:
730
# Didn't find a branch, can we find a repository?
732
repository_to = dir_to.find_repository()
733
except errors.NoRepositoryPresent:
736
# Found a branch, so we must have found a repository
737
repository_to = br_to.repository
742
# The destination doesn't exist; create it.
743
# XXX: Refactor the create_prefix/no_create_prefix code into a
744
# common helper function
746
to_transport.mkdir('.')
747
except errors.FileExists:
748
if not use_existing_dir:
749
raise errors.BzrCommandError("Target directory %s"
750
" already exists, but does not have a valid .bzr"
751
" directory. Supply --use-existing-dir to push"
752
" there anyway." % location)
753
except errors.NoSuchFile:
754
if not create_prefix:
755
raise errors.BzrCommandError("Parent directory of %s"
757
"\nYou may supply --create-prefix to create all"
758
" leading parent directories."
760
_create_prefix(to_transport)
762
# Now the target directory exists, but doesn't have a .bzr
763
# directory. So we need to create it, along with any work to create
764
# all of the dependent branches, etc.
765
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
766
revision_id=br_from.last_revision())
767
br_to = dir_to.open_branch()
768
# TODO: Some more useful message about what was copied
769
note('Created new branch.')
770
# We successfully created the target, remember it
771
if br_from.get_push_location() is None or remember:
772
br_from.set_push_location(br_to.base)
773
elif repository_to is None:
774
# we have a bzrdir but no branch or repository
775
# XXX: Figure out what to do other than complain.
776
raise errors.BzrCommandError("At %s you have a valid .bzr control"
777
" directory, but not a branch or repository. This is an"
778
" unsupported configuration. Please move the target directory"
779
" out of the way and try again."
782
# We have a repository but no branch, copy the revisions, and then
784
last_revision_id = br_from.last_revision()
785
repository_to.fetch(br_from.repository,
786
revision_id=last_revision_id)
787
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
788
note('Created new branch.')
789
if br_from.get_push_location() is None or remember:
790
br_from.set_push_location(br_to.base)
791
else: # We have a valid to branch
792
# We were able to connect to the remote location, so remember it
793
# we don't need to successfully push because of possible divergence.
794
if br_from.get_push_location() is None or remember:
795
br_from.set_push_location(br_to.base)
797
old_rh = br_to.revision_history()
800
tree_to = dir_to.open_workingtree()
801
except errors.NotLocalUrl:
802
warning("This transport does not update the working "
803
"tree of: %s. See 'bzr help working-trees' for "
804
"more information." % br_to.base)
805
push_result = br_from.push(br_to, overwrite)
806
except errors.NoWorkingTree:
807
push_result = br_from.push(br_to, overwrite)
811
push_result = br_from.push(tree_to.branch, overwrite)
815
except errors.DivergedBranches:
816
raise errors.BzrCommandError('These branches have diverged.'
817
' Try using "merge" and then "push".')
818
if push_result is not None:
819
push_result.report(self.outf)
821
new_rh = br_to.revision_history()
824
from bzrlib.log import show_changed_revisions
825
show_changed_revisions(br_to, old_rh, new_rh,
828
# we probably did a clone rather than a push, so a message was
833
class cmd_branch(Command):
834
"""Create a new copy of a branch.
836
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
837
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
838
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
839
is derived from the FROM_LOCATION by stripping a leading scheme or drive
840
identifier, if any. For example, "branch lp:foo-bar" will attempt to
843
To retrieve the branch as of a particular revision, supply the --revision
844
parameter, as in "branch foo/bar -r 5".
847
_see_also = ['checkout']
848
takes_args = ['from_location', 'to_location?']
849
takes_options = ['revision']
850
aliases = ['get', 'clone']
852
def run(self, from_location, to_location=None, revision=None):
853
from bzrlib.tag import _merge_tags_if_possible
856
elif len(revision) > 1:
857
raise errors.BzrCommandError(
858
'bzr branch --revision takes exactly 1 revision value')
860
br_from = Branch.open(from_location)
863
if len(revision) == 1 and revision[0] is not None:
864
revision_id = revision[0].in_history(br_from)[1]
866
# FIXME - wt.last_revision, fallback to branch, fall back to
867
# None or perhaps NULL_REVISION to mean copy nothing
869
revision_id = br_from.last_revision()
870
if to_location is None:
871
to_location = urlutils.derive_to_location(from_location)
874
name = os.path.basename(to_location) + '\n'
876
to_transport = transport.get_transport(to_location)
878
to_transport.mkdir('.')
879
except errors.FileExists:
880
raise errors.BzrCommandError('Target directory "%s" already'
881
' exists.' % to_location)
882
except errors.NoSuchFile:
883
raise errors.BzrCommandError('Parent of "%s" does not exist.'
886
# preserve whatever source format we have.
887
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
888
possible_transports=[to_transport])
889
branch = dir.open_branch()
890
except errors.NoSuchRevision:
891
to_transport.delete_tree('.')
892
msg = "The branch %s has no revision %s." % (from_location, revision[0])
893
raise errors.BzrCommandError(msg)
895
branch.control_files.put_utf8('branch-name', name)
896
_merge_tags_if_possible(br_from, branch)
897
note('Branched %d revision(s).' % branch.revno())
902
class cmd_checkout(Command):
903
"""Create a new checkout of an existing branch.
905
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
906
the branch found in '.'. This is useful if you have removed the working tree
907
or if it was never created - i.e. if you pushed the branch to its current
910
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
911
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
912
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
913
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
914
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
917
To retrieve the branch as of a particular revision, supply the --revision
918
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
919
out of date [so you cannot commit] but it may be useful (i.e. to examine old
923
_see_also = ['checkouts', 'branch']
924
takes_args = ['branch_location?', 'to_location?']
925
takes_options = ['revision',
926
Option('lightweight',
927
help="Perform a lightweight checkout. Lightweight "
928
"checkouts depend on access to the branch for "
929
"every operation. Normal checkouts can perform "
930
"common operations like diff and status without "
931
"such access, and also support local commits."
936
def run(self, branch_location=None, to_location=None, revision=None,
940
elif len(revision) > 1:
941
raise errors.BzrCommandError(
942
'bzr checkout --revision takes exactly 1 revision value')
943
if branch_location is None:
944
branch_location = osutils.getcwd()
945
to_location = branch_location
946
source = Branch.open(branch_location)
947
if len(revision) == 1 and revision[0] is not None:
948
revision_id = _mod_revision.ensure_null(
949
revision[0].in_history(source)[1])
952
if to_location is None:
953
to_location = urlutils.derive_to_location(branch_location)
954
# if the source and to_location are the same,
955
# and there is no working tree,
956
# then reconstitute a branch
957
if (osutils.abspath(to_location) ==
958
osutils.abspath(branch_location)):
960
source.bzrdir.open_workingtree()
961
except errors.NoWorkingTree:
962
source.bzrdir.create_workingtree(revision_id)
964
source.create_checkout(to_location, revision_id, lightweight)
967
class cmd_renames(Command):
968
"""Show list of renamed files.
970
# TODO: Option to show renames between two historical versions.
972
# TODO: Only show renames under dir, rather than in the whole branch.
973
_see_also = ['status']
974
takes_args = ['dir?']
977
def run(self, dir=u'.'):
978
tree = WorkingTree.open_containing(dir)[0]
981
new_inv = tree.inventory
982
old_tree = tree.basis_tree()
985
old_inv = old_tree.inventory
986
renames = list(_mod_tree.find_renames(old_inv, new_inv))
988
for old_name, new_name in renames:
989
self.outf.write("%s => %s\n" % (old_name, new_name))
996
class cmd_update(Command):
997
"""Update a tree to have the latest code committed to its branch.
999
This will perform a merge into the working tree, and may generate
1000
conflicts. If you have any local changes, you will still
1001
need to commit them after the update for the update to be complete.
1003
If you want to discard your local changes, you can just do a
1004
'bzr revert' instead of 'bzr commit' after the update.
1007
_see_also = ['pull', 'working-trees', 'status-flags']
1008
takes_args = ['dir?']
1011
def run(self, dir='.'):
1012
tree = WorkingTree.open_containing(dir)[0]
1013
possible_transports = []
1014
master = tree.branch.get_master_branch(
1015
possible_transports=possible_transports)
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(
1032
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1033
possible_transports=possible_transports)
1034
revno = tree.branch.revision_id_to_revno(
1035
_mod_revision.ensure_null(tree.last_revision()))
1036
note('Updated to revision %d.' % (revno,))
1037
if tree.get_parent_ids()[1:] != existing_pending_merges:
1038
note('Your local commits will now show as pending merges with '
1039
"'bzr status', and can be committed with 'bzr commit'.")
1048
class cmd_info(Command):
1049
"""Show information about a working tree, branch or repository.
1051
This command will show all known locations and formats associated to the
1052
tree, branch or repository. Statistical information is included with
1055
Branches and working trees will also report any missing revisions.
1057
_see_also = ['revno', 'working-trees', 'repositories']
1058
takes_args = ['location?']
1059
takes_options = ['verbose']
1062
def run(self, location=None, verbose=False):
1067
from bzrlib.info import show_bzrdir_info
1068
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1069
verbose=noise_level)
1072
class cmd_remove(Command):
1073
"""Remove files or directories.
1075
This makes bzr stop tracking changes to the specified files and
1076
delete them if they can easily be recovered using revert.
1078
You can specify one or more files, and/or --new. If you specify --new,
1079
only 'added' files will be removed. If you specify both, then new files
1080
in the specified directories will be removed. If the directories are
1081
also new, they will also be removed.
1083
takes_args = ['file*']
1084
takes_options = ['verbose',
1085
Option('new', help='Remove newly-added files.'),
1086
RegistryOption.from_kwargs('file-deletion-strategy',
1087
'The file deletion mode to be used.',
1088
title='Deletion Strategy', value_switches=True, enum_switch=False,
1089
safe='Only delete files if they can be'
1090
' safely recovered (default).',
1091
keep="Don't delete any files.",
1092
force='Delete all the specified files, even if they can not be '
1093
'recovered and even if they are non-empty directories.')]
1095
encoding_type = 'replace'
1097
def run(self, file_list, verbose=False, new=False,
1098
file_deletion_strategy='safe'):
1099
tree, file_list = tree_files(file_list)
1101
if file_list is not None:
1102
file_list = [f for f in file_list]
1104
raise errors.BzrCommandError('Specify one or more files to'
1105
' remove, or use --new.')
1108
added = tree.changes_from(tree.basis_tree(),
1109
specific_files=file_list).added
1110
file_list = sorted([f[0] for f in added], reverse=True)
1111
if len(file_list) == 0:
1112
raise errors.BzrCommandError('No matching files.')
1113
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1114
keep_files=file_deletion_strategy=='keep',
1115
force=file_deletion_strategy=='force')
1118
class cmd_file_id(Command):
1119
"""Print file_id of a particular file or directory.
1121
The file_id is assigned when the file is first added and remains the
1122
same through all revisions where the file exists, even when it is
1127
_see_also = ['inventory', 'ls']
1128
takes_args = ['filename']
1131
def run(self, filename):
1132
tree, relpath = WorkingTree.open_containing(filename)
1133
i = tree.path2id(relpath)
1135
raise errors.NotVersionedError(filename)
1137
self.outf.write(i + '\n')
1140
class cmd_file_path(Command):
1141
"""Print path of file_ids to a file or directory.
1143
This prints one line for each directory down to the target,
1144
starting at the branch root.
1148
takes_args = ['filename']
1151
def run(self, filename):
1152
tree, relpath = WorkingTree.open_containing(filename)
1153
fid = tree.path2id(relpath)
1155
raise errors.NotVersionedError(filename)
1156
segments = osutils.splitpath(relpath)
1157
for pos in range(1, len(segments) + 1):
1158
path = osutils.joinpath(segments[:pos])
1159
self.outf.write("%s\n" % tree.path2id(path))
1162
class cmd_reconcile(Command):
1163
"""Reconcile bzr metadata in a branch.
1165
This can correct data mismatches that may have been caused by
1166
previous ghost operations or bzr upgrades. You should only
1167
need to run this command if 'bzr check' or a bzr developer
1168
advises you to run it.
1170
If a second branch is provided, cross-branch reconciliation is
1171
also attempted, which will check that data like the tree root
1172
id which was not present in very early bzr versions is represented
1173
correctly in both branches.
1175
At the same time it is run it may recompress data resulting in
1176
a potential saving in disk space or performance gain.
1178
The branch *MUST* be on a listable system such as local disk or sftp.
1181
_see_also = ['check']
1182
takes_args = ['branch?']
1184
def run(self, branch="."):
1185
from bzrlib.reconcile import reconcile
1186
dir = bzrdir.BzrDir.open(branch)
1190
class cmd_revision_history(Command):
1191
"""Display the list of revision ids on a branch."""
1194
takes_args = ['location?']
1199
def run(self, location="."):
1200
branch = Branch.open_containing(location)[0]
1201
for revid in branch.revision_history():
1202
self.outf.write(revid)
1203
self.outf.write('\n')
1206
class cmd_ancestry(Command):
1207
"""List all revisions merged into this branch."""
1209
_see_also = ['log', 'revision-history']
1210
takes_args = ['location?']
1215
def run(self, location="."):
1217
wt = WorkingTree.open_containing(location)[0]
1218
except errors.NoWorkingTree:
1219
b = Branch.open(location)
1220
last_revision = b.last_revision()
1223
last_revision = wt.last_revision()
1225
revision_ids = b.repository.get_ancestry(last_revision)
1226
assert revision_ids[0] is None
1228
for revision_id in revision_ids:
1229
self.outf.write(revision_id + '\n')
1232
class cmd_init(Command):
1233
"""Make a directory into a versioned branch.
1235
Use this to create an empty branch, or before importing an
1238
If there is a repository in a parent directory of the location, then
1239
the history of the branch will be stored in the repository. Otherwise
1240
init creates a standalone branch which carries its own history
1241
in the .bzr directory.
1243
If there is already a branch at the location but it has no working tree,
1244
the tree can be populated with 'bzr checkout'.
1246
Recipe for importing a tree of files::
1252
bzr commit -m 'imported project'
1255
_see_also = ['init-repository', 'branch', 'checkout']
1256
takes_args = ['location?']
1258
Option('create-prefix',
1259
help='Create the path leading up to the branch '
1260
'if it does not already exist.'),
1261
RegistryOption('format',
1262
help='Specify a format for this branch. '
1263
'See "help formats".',
1264
registry=bzrdir.format_registry,
1265
converter=bzrdir.format_registry.make_bzrdir,
1266
value_switches=True,
1267
title="Branch Format",
1269
Option('append-revisions-only',
1270
help='Never change revnos or the existing log.'
1271
' Append revisions to it only.')
1273
def run(self, location=None, format=None, append_revisions_only=False,
1274
create_prefix=False):
1276
format = bzrdir.format_registry.make_bzrdir('default')
1277
if location is None:
1280
to_transport = transport.get_transport(location)
1282
# The path has to exist to initialize a
1283
# branch inside of it.
1284
# Just using os.mkdir, since I don't
1285
# believe that we want to create a bunch of
1286
# locations if the user supplies an extended path
1288
to_transport.ensure_base()
1289
except errors.NoSuchFile:
1290
if not create_prefix:
1291
raise errors.BzrCommandError("Parent directory of %s"
1293
"\nYou may supply --create-prefix to create all"
1294
" leading parent directories."
1296
_create_prefix(to_transport)
1299
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1300
except errors.NotBranchError:
1301
# really a NotBzrDir error...
1302
create_branch = bzrdir.BzrDir.create_branch_convenience
1303
branch = create_branch(to_transport.base, format=format,
1304
possible_transports=[to_transport])
1306
from bzrlib.transport.local import LocalTransport
1307
if existing_bzrdir.has_branch():
1308
if (isinstance(to_transport, LocalTransport)
1309
and not existing_bzrdir.has_workingtree()):
1310
raise errors.BranchExistsWithoutWorkingTree(location)
1311
raise errors.AlreadyBranchError(location)
1313
branch = existing_bzrdir.create_branch()
1314
existing_bzrdir.create_workingtree()
1315
if append_revisions_only:
1317
branch.set_append_revisions_only(True)
1318
except errors.UpgradeRequired:
1319
raise errors.BzrCommandError('This branch format cannot be set'
1320
' to append-revisions-only. Try --experimental-branch6')
1323
class cmd_init_repository(Command):
1324
"""Create a shared repository to hold branches.
1326
New branches created under the repository directory will store their
1327
revisions in the repository, not in the branch directory.
1329
If the --no-trees option is used then the branches in the repository
1330
will not have working trees by default.
1333
Create a shared repositories holding just branches::
1335
bzr init-repo --no-trees repo
1338
Make a lightweight checkout elsewhere::
1340
bzr checkout --lightweight repo/trunk trunk-checkout
1345
_see_also = ['init', 'branch', 'checkout', 'repositories']
1346
takes_args = ["location"]
1347
takes_options = [RegistryOption('format',
1348
help='Specify a format for this repository. See'
1349
' "bzr help formats" for details.',
1350
registry=bzrdir.format_registry,
1351
converter=bzrdir.format_registry.make_bzrdir,
1352
value_switches=True, title='Repository format'),
1354
help='Branches in the repository will default to'
1355
' not having a working tree.'),
1357
aliases = ["init-repo"]
1359
def run(self, location, format=None, no_trees=False):
1361
format = bzrdir.format_registry.make_bzrdir('default')
1363
if location is None:
1366
to_transport = transport.get_transport(location)
1367
to_transport.ensure_base()
1369
newdir = format.initialize_on_transport(to_transport)
1370
repo = newdir.create_repository(shared=True)
1371
repo.set_make_working_trees(not no_trees)
1374
class cmd_diff(Command):
1375
"""Show differences in the working tree or between revisions.
1377
If files are listed, only the changes in those files are listed.
1378
Otherwise, all changes for the tree are listed.
1380
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1381
produces patches suitable for "patch -p1".
1384
Shows the difference in the working tree versus the last commit::
1388
Difference between the working tree and revision 1::
1392
Difference between revision 2 and revision 1::
1396
Same as 'bzr diff' but prefix paths with old/ and new/::
1398
bzr diff --prefix old/:new/
1400
Show the differences between the two working trees::
1402
bzr diff bzr.mine bzr.dev
1404
Show just the differences for 'foo.c'::
1408
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1409
# or a graphical diff.
1411
# TODO: Python difflib is not exactly the same as unidiff; should
1412
# either fix it up or prefer to use an external diff.
1414
# TODO: Selected-file diff is inefficient and doesn't show you
1417
# TODO: This probably handles non-Unix newlines poorly.
1419
_see_also = ['status']
1420
takes_args = ['file*']
1422
Option('diff-options', type=str,
1423
help='Pass these options to the external diff program.'),
1424
Option('prefix', type=str,
1426
help='Set prefixes added to old and new filenames, as '
1427
'two values separated by a colon. (eg "old/:new/").'),
1431
aliases = ['di', 'dif']
1432
encoding_type = 'exact'
1435
def run(self, revision=None, file_list=None, diff_options=None,
1437
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1439
if (prefix is None) or (prefix == '0'):
1447
old_label, new_label = prefix.split(":")
1449
raise errors.BzrCommandError(
1450
'--prefix expects two values separated by a colon'
1451
' (eg "old/:new/")')
1453
if revision and len(revision) > 2:
1454
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1455
' one or two revision specifiers')
1458
tree1, file_list = internal_tree_files(file_list)
1462
except errors.FileInWrongBranch:
1463
if len(file_list) != 2:
1464
raise errors.BzrCommandError("Files are in different branches")
1466
tree1, file1 = WorkingTree.open_containing(file_list[0])
1467
tree2, file2 = WorkingTree.open_containing(file_list[1])
1468
if file1 != "" or file2 != "":
1469
# FIXME diff those two files. rbc 20051123
1470
raise errors.BzrCommandError("Files are in different branches")
1472
except errors.NotBranchError:
1473
if (revision is not None and len(revision) == 2
1474
and not revision[0].needs_branch()
1475
and not revision[1].needs_branch()):
1476
# If both revision specs include a branch, we can
1477
# diff them without needing a local working tree
1478
tree1, tree2 = None, None
1482
if tree2 is not None:
1483
if revision is not None:
1484
# FIXME: but there should be a clean way to diff between
1485
# non-default versions of two trees, it's not hard to do
1487
raise errors.BzrCommandError(
1488
"Sorry, diffing arbitrary revisions across branches "
1489
"is not implemented yet")
1490
return show_diff_trees(tree1, tree2, sys.stdout,
1491
specific_files=file_list,
1492
external_diff_options=diff_options,
1493
old_label=old_label, new_label=new_label)
1495
return diff_cmd_helper(tree1, file_list, diff_options,
1496
revision_specs=revision,
1497
old_label=old_label, new_label=new_label)
1500
class cmd_deleted(Command):
1501
"""List files deleted in the working tree.
1503
# TODO: Show files deleted since a previous revision, or
1504
# between two revisions.
1505
# TODO: Much more efficient way to do this: read in new
1506
# directories with readdir, rather than stating each one. Same
1507
# level of effort but possibly much less IO. (Or possibly not,
1508
# if the directories are very large...)
1509
_see_also = ['status', 'ls']
1510
takes_options = ['show-ids']
1513
def run(self, show_ids=False):
1514
tree = WorkingTree.open_containing(u'.')[0]
1517
old = tree.basis_tree()
1520
for path, ie in old.inventory.iter_entries():
1521
if not tree.has_id(ie.file_id):
1522
self.outf.write(path)
1524
self.outf.write(' ')
1525
self.outf.write(ie.file_id)
1526
self.outf.write('\n')
1533
class cmd_modified(Command):
1534
"""List files modified in working tree.
1538
_see_also = ['status', 'ls']
1542
tree = WorkingTree.open_containing(u'.')[0]
1543
td = tree.changes_from(tree.basis_tree())
1544
for path, id, kind, text_modified, meta_modified in td.modified:
1545
self.outf.write(path + '\n')
1548
class cmd_added(Command):
1549
"""List files added in working tree.
1553
_see_also = ['status', 'ls']
1557
wt = WorkingTree.open_containing(u'.')[0]
1560
basis = wt.basis_tree()
1563
basis_inv = basis.inventory
1566
if file_id in basis_inv:
1568
if inv.is_root(file_id) and len(basis_inv) == 0:
1570
path = inv.id2path(file_id)
1571
if not os.access(osutils.abspath(path), os.F_OK):
1573
self.outf.write(path + '\n')
1580
class cmd_root(Command):
1581
"""Show the tree root directory.
1583
The root is the nearest enclosing directory with a .bzr control
1586
takes_args = ['filename?']
1588
def run(self, filename=None):
1589
"""Print the branch root."""
1590
tree = WorkingTree.open_containing(filename)[0]
1591
self.outf.write(tree.basedir + '\n')
1594
def _parse_limit(limitstring):
1596
return int(limitstring)
1598
msg = "The limit argument must be an integer."
1599
raise errors.BzrCommandError(msg)
1602
class cmd_log(Command):
1603
"""Show log of a branch, file, or directory.
1605
By default show the log of the branch containing the working directory.
1607
To request a range of logs, you can use the command -r begin..end
1608
-r revision requests a specific revision, -r ..end or -r begin.. are
1612
Log the current branch::
1620
Log the last 10 revisions of a branch::
1622
bzr log -r -10.. http://server/branch
1625
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1627
takes_args = ['location?']
1630
help='Show from oldest to newest.'),
1633
help='Display timezone as local, original, or utc.'),
1634
custom_help('verbose',
1635
help='Show files changed in each revision.'),
1641
help='Show revisions whose message matches this '
1642
'regular expression.',
1645
help='Limit the output to the first N revisions.',
1649
encoding_type = 'replace'
1652
def run(self, location=None, timezone='original',
1660
from bzrlib.log import show_log
1661
assert message is None or isinstance(message, basestring), \
1662
"invalid message argument %r" % message
1663
direction = (forward and 'forward') or 'reverse'
1668
# find the file id to log:
1670
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1674
tree = b.basis_tree()
1675
file_id = tree.path2id(fp)
1677
raise errors.BzrCommandError(
1678
"Path does not have any revision history: %s" %
1682
# FIXME ? log the current subdir only RBC 20060203
1683
if revision is not None \
1684
and len(revision) > 0 and revision[0].get_branch():
1685
location = revision[0].get_branch()
1688
dir, relpath = bzrdir.BzrDir.open_containing(location)
1689
b = dir.open_branch()
1693
if revision is None:
1696
elif len(revision) == 1:
1697
rev1 = rev2 = revision[0].in_history(b)
1698
elif len(revision) == 2:
1699
if revision[1].get_branch() != revision[0].get_branch():
1700
# b is taken from revision[0].get_branch(), and
1701
# show_log will use its revision_history. Having
1702
# different branches will lead to weird behaviors.
1703
raise errors.BzrCommandError(
1704
"Log doesn't accept two revisions in different"
1706
rev1 = revision[0].in_history(b)
1707
rev2 = revision[1].in_history(b)
1709
raise errors.BzrCommandError(
1710
'bzr log --revision takes one or two values.')
1712
if log_format is None:
1713
log_format = log.log_formatter_registry.get_default(b)
1715
lf = log_format(show_ids=show_ids, to_file=self.outf,
1716
show_timezone=timezone)
1722
direction=direction,
1723
start_revision=rev1,
1731
def get_log_format(long=False, short=False, line=False, default='long'):
1732
log_format = default
1736
log_format = 'short'
1742
class cmd_touching_revisions(Command):
1743
"""Return revision-ids which affected a particular file.
1745
A more user-friendly interface is "bzr log FILE".
1749
takes_args = ["filename"]
1752
def run(self, filename):
1753
tree, relpath = WorkingTree.open_containing(filename)
1755
file_id = tree.path2id(relpath)
1756
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1757
self.outf.write("%6d %s\n" % (revno, what))
1760
class cmd_ls(Command):
1761
"""List files in a tree.
1764
_see_also = ['status', 'cat']
1765
takes_args = ['path?']
1766
# TODO: Take a revision or remote path and list that tree instead.
1770
Option('non-recursive',
1771
help='Don\'t recurse into subdirectories.'),
1773
help='Print paths relative to the root of the branch.'),
1774
Option('unknown', help='Print unknown files.'),
1775
Option('versioned', help='Print versioned files.'),
1776
Option('ignored', help='Print ignored files.'),
1778
help='Write an ascii NUL (\\0) separator '
1779
'between files rather than a newline.'),
1781
help='List entries of a particular kind: file, directory, symlink.',
1786
def run(self, revision=None, verbose=False,
1787
non_recursive=False, from_root=False,
1788
unknown=False, versioned=False, ignored=False,
1789
null=False, kind=None, show_ids=False, path=None):
1791
if kind and kind not in ('file', 'directory', 'symlink'):
1792
raise errors.BzrCommandError('invalid kind specified')
1794
if verbose and null:
1795
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1796
all = not (unknown or versioned or ignored)
1798
selection = {'I':ignored, '?':unknown, 'V':versioned}
1805
raise errors.BzrCommandError('cannot specify both --from-root'
1809
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1815
if revision is not None:
1816
tree = branch.repository.revision_tree(
1817
revision[0].in_history(branch).rev_id)
1819
tree = branch.basis_tree()
1823
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1824
if fp.startswith(relpath):
1825
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1826
if non_recursive and '/' in fp:
1828
if not all and not selection[fc]:
1830
if kind is not None and fkind != kind:
1833
kindch = entry.kind_character()
1834
outstring = '%-8s %s%s' % (fc, fp, kindch)
1835
if show_ids and fid is not None:
1836
outstring = "%-50s %s" % (outstring, fid)
1837
self.outf.write(outstring + '\n')
1839
self.outf.write(fp + '\0')
1842
self.outf.write(fid)
1843
self.outf.write('\0')
1851
self.outf.write('%-50s %s\n' % (fp, my_id))
1853
self.outf.write(fp + '\n')
1858
class cmd_unknowns(Command):
1859
"""List unknown files.
1867
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1868
self.outf.write(osutils.quotefn(f) + '\n')
1871
class cmd_ignore(Command):
1872
"""Ignore specified files or patterns.
1874
To remove patterns from the ignore list, edit the .bzrignore file.
1876
Trailing slashes on patterns are ignored.
1877
If the pattern contains a slash or is a regular expression, it is compared
1878
to the whole path from the branch root. Otherwise, it is compared to only
1879
the last component of the path. To match a file only in the root
1880
directory, prepend './'.
1882
Ignore patterns specifying absolute paths are not allowed.
1884
Ignore patterns may include globbing wildcards such as::
1886
? - Matches any single character except '/'
1887
* - Matches 0 or more characters except '/'
1888
/**/ - Matches 0 or more directories in a path
1889
[a-z] - Matches a single character from within a group of characters
1891
Ignore patterns may also be Python regular expressions.
1892
Regular expression ignore patterns are identified by a 'RE:' prefix
1893
followed by the regular expression. Regular expression ignore patterns
1894
may not include named or numbered groups.
1896
Note: ignore patterns containing shell wildcards must be quoted from
1900
Ignore the top level Makefile::
1902
bzr ignore ./Makefile
1904
Ignore class files in all directories::
1906
bzr ignore '*.class'
1908
Ignore .o files under the lib directory::
1910
bzr ignore 'lib/**/*.o'
1912
Ignore .o files under the lib directory::
1914
bzr ignore 'RE:lib/.*\.o'
1917
_see_also = ['status', 'ignored']
1918
takes_args = ['name_pattern*']
1920
Option('old-default-rules',
1921
help='Write out the ignore rules bzr < 0.9 always used.')
1924
def run(self, name_pattern_list=None, old_default_rules=None):
1925
from bzrlib.atomicfile import AtomicFile
1926
if old_default_rules is not None:
1927
# dump the rules and exit
1928
for pattern in ignores.OLD_DEFAULTS:
1931
if not name_pattern_list:
1932
raise errors.BzrCommandError("ignore requires at least one "
1933
"NAME_PATTERN or --old-default-rules")
1934
name_pattern_list = [globbing.normalize_pattern(p)
1935
for p in name_pattern_list]
1936
for name_pattern in name_pattern_list:
1937
if (name_pattern[0] == '/' or
1938
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1939
raise errors.BzrCommandError(
1940
"NAME_PATTERN should not be an absolute path")
1941
tree, relpath = WorkingTree.open_containing(u'.')
1942
ifn = tree.abspath('.bzrignore')
1943
if os.path.exists(ifn):
1946
igns = f.read().decode('utf-8')
1952
# TODO: If the file already uses crlf-style termination, maybe
1953
# we should use that for the newly added lines?
1955
if igns and igns[-1] != '\n':
1957
for name_pattern in name_pattern_list:
1958
igns += name_pattern + '\n'
1960
f = AtomicFile(ifn, 'wb')
1962
f.write(igns.encode('utf-8'))
1967
if not tree.path2id('.bzrignore'):
1968
tree.add(['.bzrignore'])
1970
ignored = globbing.Globster(name_pattern_list)
1973
for entry in tree.list_files():
1977
if ignored.match(filename):
1978
matches.append(filename.encode('utf-8'))
1980
if len(matches) > 0:
1981
print "Warning: the following files are version controlled and" \
1982
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1984
class cmd_ignored(Command):
1985
"""List ignored files and the patterns that matched them.
1988
_see_also = ['ignore']
1991
tree = WorkingTree.open_containing(u'.')[0]
1994
for path, file_class, kind, file_id, entry in tree.list_files():
1995
if file_class != 'I':
1997
## XXX: Slightly inefficient since this was already calculated
1998
pat = tree.is_ignored(path)
1999
print '%-50s %s' % (path, pat)
2004
class cmd_lookup_revision(Command):
2005
"""Lookup the revision-id from a revision-number
2008
bzr lookup-revision 33
2011
takes_args = ['revno']
2014
def run(self, revno):
2018
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2020
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2023
class cmd_export(Command):
2024
"""Export current or past revision to a destination directory or archive.
2026
If no revision is specified this exports the last committed revision.
2028
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2029
given, try to find the format with the extension. If no extension
2030
is found exports to a directory (equivalent to --format=dir).
2032
If root is supplied, it will be used as the root directory inside
2033
container formats (tar, zip, etc). If it is not supplied it will default
2034
to the exported filename. The root option has no effect for 'dir' format.
2036
If branch is omitted then the branch containing the current working
2037
directory will be used.
2039
Note: Export of tree with non-ASCII filenames to zip is not supported.
2041
================= =========================
2042
Supported formats Autodetected by extension
2043
================= =========================
2046
tbz2 .tar.bz2, .tbz2
2049
================= =========================
2051
takes_args = ['dest', 'branch?']
2054
help="Type of file to export to.",
2059
help="Name of the root directory inside the exported file."),
2061
def run(self, dest, branch=None, revision=None, format=None, root=None):
2062
from bzrlib.export import export
2065
tree = WorkingTree.open_containing(u'.')[0]
2068
b = Branch.open(branch)
2070
if revision is None:
2071
# should be tree.last_revision FIXME
2072
rev_id = b.last_revision()
2074
if len(revision) != 1:
2075
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2076
rev_id = revision[0].in_history(b).rev_id
2077
t = b.repository.revision_tree(rev_id)
2079
export(t, dest, format, root)
2080
except errors.NoSuchExportFormat, e:
2081
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2084
class cmd_cat(Command):
2085
"""Write the contents of a file as of a given revision to standard output.
2087
If no revision is nominated, the last revision is used.
2089
Note: Take care to redirect standard output when using this command on a
2095
Option('name-from-revision', help='The path name in the old tree.'),
2098
takes_args = ['filename']
2099
encoding_type = 'exact'
2102
def run(self, filename, revision=None, name_from_revision=False):
2103
if revision is not None and len(revision) != 1:
2104
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2109
tree, b, relpath = \
2110
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2111
except errors.NotBranchError:
2114
if revision is not None and revision[0].get_branch() is not None:
2115
b = Branch.open(revision[0].get_branch())
2117
tree = b.basis_tree()
2118
if revision is None:
2119
revision_id = b.last_revision()
2121
revision_id = revision[0].in_history(b).rev_id
2123
cur_file_id = tree.path2id(relpath)
2124
rev_tree = b.repository.revision_tree(revision_id)
2125
old_file_id = rev_tree.path2id(relpath)
2127
if name_from_revision:
2128
if old_file_id is None:
2129
raise errors.BzrCommandError("%r is not present in revision %s"
2130
% (filename, revision_id))
2132
rev_tree.print_file(old_file_id)
2133
elif cur_file_id is not None:
2134
rev_tree.print_file(cur_file_id)
2135
elif old_file_id is not None:
2136
rev_tree.print_file(old_file_id)
2138
raise errors.BzrCommandError("%r is not present in revision %s" %
2139
(filename, revision_id))
2142
class cmd_local_time_offset(Command):
2143
"""Show the offset in seconds from GMT to local time."""
2147
print osutils.local_time_offset()
2151
class cmd_commit(Command):
2152
"""Commit changes into a new revision.
2154
If no arguments are given, the entire tree is committed.
2156
If selected files are specified, only changes to those files are
2157
committed. If a directory is specified then the directory and everything
2158
within it is committed.
2160
If author of the change is not the same person as the committer, you can
2161
specify the author's name using the --author option. The name should be
2162
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2164
A selected-file commit may fail in some cases where the committed
2165
tree would be invalid. Consider::
2170
bzr commit foo -m "committing foo"
2171
bzr mv foo/bar foo/baz
2174
bzr commit foo/bar -m "committing bar but not baz"
2176
In the example above, the last commit will fail by design. This gives
2177
the user the opportunity to decide whether they want to commit the
2178
rename at the same time, separately first, or not at all. (As a general
2179
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2181
Note: A selected-file commit after a merge is not yet supported.
2183
# TODO: Run hooks on tree to-be-committed, and after commit.
2185
# TODO: Strict commit that fails if there are deleted files.
2186
# (what does "deleted files" mean ??)
2188
# TODO: Give better message for -s, --summary, used by tla people
2190
# XXX: verbose currently does nothing
2192
_see_also = ['bugs', 'uncommit']
2193
takes_args = ['selected*']
2195
Option('message', type=unicode,
2197
help="Description of the new revision."),
2200
help='Commit even if nothing has changed.'),
2201
Option('file', type=str,
2204
help='Take commit message from this file.'),
2206
help="Refuse to commit if there are unknown "
2207
"files in the working tree."),
2208
ListOption('fixes', type=str,
2209
help="Mark a bug as being fixed by this revision."),
2210
Option('author', type=str,
2211
help="Set the author's name, if it's different "
2212
"from the committer."),
2214
help="Perform a local commit in a bound "
2215
"branch. Local commits are not pushed to "
2216
"the master branch until a normal commit "
2220
help='When no message is supplied, show the diff along'
2221
' with the status summary in the message editor.'),
2223
aliases = ['ci', 'checkin']
2225
def _get_bug_fix_properties(self, fixes, branch):
2227
# Configure the properties for bug fixing attributes.
2228
for fixed_bug in fixes:
2229
tokens = fixed_bug.split(':')
2230
if len(tokens) != 2:
2231
raise errors.BzrCommandError(
2232
"Invalid bug %s. Must be in the form of 'tag:id'. "
2233
"Commit refused." % fixed_bug)
2234
tag, bug_id = tokens
2236
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2237
except errors.UnknownBugTrackerAbbreviation:
2238
raise errors.BzrCommandError(
2239
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2240
except errors.MalformedBugIdentifier:
2241
raise errors.BzrCommandError(
2242
"Invalid bug identifier for %s. Commit refused."
2244
properties.append('%s fixed' % bug_url)
2245
return '\n'.join(properties)
2247
def run(self, message=None, file=None, verbose=False, selected_list=None,
2248
unchanged=False, strict=False, local=False, fixes=None,
2249
author=None, show_diff=False):
2250
from bzrlib.errors import (
2255
from bzrlib.msgeditor import (
2256
edit_commit_message_encoded,
2257
make_commit_message_template_encoded
2260
# TODO: Need a blackbox test for invoking the external editor; may be
2261
# slightly problematic to run this cross-platform.
2263
# TODO: do more checks that the commit will succeed before
2264
# spending the user's valuable time typing a commit message.
2268
tree, selected_list = tree_files(selected_list)
2269
if selected_list == ['']:
2270
# workaround - commit of root of tree should be exactly the same
2271
# as just default commit in that tree, and succeed even though
2272
# selected-file merge commit is not done yet
2275
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2277
properties['bugs'] = bug_property
2279
if local and not tree.branch.get_bound_location():
2280
raise errors.LocalRequiresBoundBranch()
2282
def get_message(commit_obj):
2283
"""Callback to get commit message"""
2284
my_message = message
2285
if my_message is None and not file:
2286
t = make_commit_message_template_encoded(tree,
2287
selected_list, diff=show_diff,
2288
output_encoding=bzrlib.user_encoding)
2289
my_message = edit_commit_message_encoded(t)
2290
if my_message is None:
2291
raise errors.BzrCommandError("please specify a commit"
2292
" message with either --message or --file")
2293
elif my_message and file:
2294
raise errors.BzrCommandError(
2295
"please specify either --message or --file")
2297
my_message = codecs.open(file, 'rt',
2298
bzrlib.user_encoding).read()
2299
if my_message == "":
2300
raise errors.BzrCommandError("empty commit message specified")
2304
tree.commit(message_callback=get_message,
2305
specific_files=selected_list,
2306
allow_pointless=unchanged, strict=strict, local=local,
2307
reporter=None, verbose=verbose, revprops=properties,
2309
except PointlessCommit:
2310
# FIXME: This should really happen before the file is read in;
2311
# perhaps prepare the commit; get the message; then actually commit
2312
raise errors.BzrCommandError("no changes to commit."
2313
" use --unchanged to commit anyhow")
2314
except ConflictsInTree:
2315
raise errors.BzrCommandError('Conflicts detected in working '
2316
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2318
except StrictCommitFailed:
2319
raise errors.BzrCommandError("Commit refused because there are"
2320
" unknown files in the working tree.")
2321
except errors.BoundBranchOutOfDate, e:
2322
raise errors.BzrCommandError(str(e) + "\n"
2323
'To commit to master branch, run update and then commit.\n'
2324
'You can also pass --local to commit to continue working '
2328
class cmd_check(Command):
2329
"""Validate consistency of branch history.
2331
This command checks various invariants about the branch storage to
2332
detect data corruption or bzr bugs.
2335
_see_also = ['reconcile']
2336
takes_args = ['branch?']
2337
takes_options = ['verbose']
2339
def run(self, branch=None, verbose=False):
2340
from bzrlib.check import check
2342
tree = WorkingTree.open_containing()[0]
2343
branch = tree.branch
2345
branch = Branch.open(branch)
2346
check(branch, verbose)
2349
class cmd_upgrade(Command):
2350
"""Upgrade branch storage to current format.
2352
The check command or bzr developers may sometimes advise you to run
2353
this command. When the default format has changed you may also be warned
2354
during other operations to upgrade.
2357
_see_also = ['check']
2358
takes_args = ['url?']
2360
RegistryOption('format',
2361
help='Upgrade to a specific format. See "bzr help'
2362
' formats" for details.',
2363
registry=bzrdir.format_registry,
2364
converter=bzrdir.format_registry.make_bzrdir,
2365
value_switches=True, title='Branch format'),
2368
def run(self, url='.', format=None):
2369
from bzrlib.upgrade import upgrade
2371
format = bzrdir.format_registry.make_bzrdir('default')
2372
upgrade(url, format)
2375
class cmd_whoami(Command):
2376
"""Show or set bzr user id.
2379
Show the email of the current user::
2383
Set the current user::
2385
bzr whoami 'Frank Chu <fchu@example.com>'
2387
takes_options = [ Option('email',
2388
help='Display email address only.'),
2390
help='Set identity for the current branch instead of '
2393
takes_args = ['name?']
2394
encoding_type = 'replace'
2397
def run(self, email=False, branch=False, name=None):
2399
# use branch if we're inside one; otherwise global config
2401
c = Branch.open_containing('.')[0].get_config()
2402
except errors.NotBranchError:
2403
c = config.GlobalConfig()
2405
self.outf.write(c.user_email() + '\n')
2407
self.outf.write(c.username() + '\n')
2410
# display a warning if an email address isn't included in the given name.
2412
config.extract_email_address(name)
2413
except errors.NoEmailInUsername, e:
2414
warning('"%s" does not seem to contain an email address. '
2415
'This is allowed, but not recommended.', name)
2417
# use global config unless --branch given
2419
c = Branch.open_containing('.')[0].get_config()
2421
c = config.GlobalConfig()
2422
c.set_user_option('email', name)
2425
class cmd_nick(Command):
2426
"""Print or set the branch nickname.
2428
If unset, the tree root directory name is used as the nickname
2429
To print the current nickname, execute with no argument.
2432
_see_also = ['info']
2433
takes_args = ['nickname?']
2434
def run(self, nickname=None):
2435
branch = Branch.open_containing(u'.')[0]
2436
if nickname is None:
2437
self.printme(branch)
2439
branch.nick = nickname
2442
def printme(self, branch):
2446
class cmd_selftest(Command):
2447
"""Run internal test suite.
2449
If arguments are given, they are regular expressions that say which tests
2450
should run. Tests matching any expression are run, and other tests are
2453
Alternatively if --first is given, matching tests are run first and then
2454
all other tests are run. This is useful if you have been working in a
2455
particular area, but want to make sure nothing else was broken.
2457
If --exclude is given, tests that match that regular expression are
2458
excluded, regardless of whether they match --first or not.
2460
To help catch accidential dependencies between tests, the --randomize
2461
option is useful. In most cases, the argument used is the word 'now'.
2462
Note that the seed used for the random number generator is displayed
2463
when this option is used. The seed can be explicitly passed as the
2464
argument to this option if required. This enables reproduction of the
2465
actual ordering used if and when an order sensitive problem is encountered.
2467
If --list-only is given, the tests that would be run are listed. This is
2468
useful when combined with --first, --exclude and/or --randomize to
2469
understand their impact. The test harness reports "Listed nn tests in ..."
2470
instead of "Ran nn tests in ..." when list mode is enabled.
2472
If the global option '--no-plugins' is given, plugins are not loaded
2473
before running the selftests. This has two effects: features provided or
2474
modified by plugins will not be tested, and tests provided by plugins will
2477
Tests that need working space on disk use a common temporary directory,
2478
typically inside $TMPDIR or /tmp.
2481
Run only tests relating to 'ignore'::
2485
Disable plugins and list tests as they're run::
2487
bzr --no-plugins selftest -v
2489
# NB: this is used from the class without creating an instance, which is
2490
# why it does not have a self parameter.
2491
def get_transport_type(typestring):
2492
"""Parse and return a transport specifier."""
2493
if typestring == "sftp":
2494
from bzrlib.transport.sftp import SFTPAbsoluteServer
2495
return SFTPAbsoluteServer
2496
if typestring == "memory":
2497
from bzrlib.transport.memory import MemoryServer
2499
if typestring == "fakenfs":
2500
from bzrlib.transport.fakenfs import FakeNFSServer
2501
return FakeNFSServer
2502
msg = "No known transport type %s. Supported types are: sftp\n" %\
2504
raise errors.BzrCommandError(msg)
2507
takes_args = ['testspecs*']
2508
takes_options = ['verbose',
2510
help='Stop when one test fails.',
2514
help='Use a different transport by default '
2515
'throughout the test suite.',
2516
type=get_transport_type),
2518
help='Run the benchmarks rather than selftests.'),
2519
Option('lsprof-timed',
2520
help='Generate lsprof output for benchmarked'
2521
' sections of code.'),
2522
Option('cache-dir', type=str,
2523
help='Cache intermediate benchmark output in this '
2526
help='Run all tests, but run specified tests first.',
2530
help='List the tests instead of running them.'),
2531
Option('randomize', type=str, argname="SEED",
2532
help='Randomize the order of tests using the given'
2533
' seed or "now" for the current time.'),
2534
Option('exclude', type=str, argname="PATTERN",
2536
help='Exclude tests that match this regular'
2538
Option('strict', help='Fail on missing dependencies or '
2541
encoding_type = 'replace'
2543
def run(self, testspecs_list=None, verbose=False, one=False,
2544
transport=None, benchmark=None,
2545
lsprof_timed=None, cache_dir=None,
2546
first=False, list_only=False,
2547
randomize=None, exclude=None, strict=False):
2549
from bzrlib.tests import selftest
2550
import bzrlib.benchmarks as benchmarks
2551
from bzrlib.benchmarks import tree_creator
2553
if cache_dir is not None:
2554
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2556
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2557
print ' %s (%s python%s)' % (
2559
bzrlib.version_string,
2560
'.'.join(map(str, sys.version_info)),
2563
if testspecs_list is not None:
2564
pattern = '|'.join(testspecs_list)
2568
test_suite_factory = benchmarks.test_suite
2569
# Unless user explicitly asks for quiet, be verbose in benchmarks
2570
verbose = not is_quiet()
2571
# TODO: should possibly lock the history file...
2572
benchfile = open(".perf_history", "at", buffering=1)
2574
test_suite_factory = None
2577
result = selftest(verbose=verbose,
2579
stop_on_failure=one,
2580
transport=transport,
2581
test_suite_factory=test_suite_factory,
2582
lsprof_timed=lsprof_timed,
2583
bench_history=benchfile,
2584
matching_tests_first=first,
2585
list_only=list_only,
2586
random_seed=randomize,
2587
exclude_pattern=exclude,
2591
if benchfile is not None:
2594
info('tests passed')
2596
info('tests failed')
2597
return int(not result)
2600
class cmd_version(Command):
2601
"""Show version of bzr."""
2603
encoding_type = 'replace'
2607
from bzrlib.version import show_version
2608
show_version(to_file=self.outf)
2611
class cmd_rocks(Command):
2612
"""Statement of optimism."""
2618
print "It sure does!"
2621
class cmd_find_merge_base(Command):
2622
"""Find and print a base revision for merging two branches."""
2623
# TODO: Options to specify revisions on either side, as if
2624
# merging only part of the history.
2625
takes_args = ['branch', 'other']
2629
def run(self, branch, other):
2630
from bzrlib.revision import ensure_null
2632
branch1 = Branch.open_containing(branch)[0]
2633
branch2 = Branch.open_containing(other)[0]
2635
last1 = ensure_null(branch1.last_revision())
2636
last2 = ensure_null(branch2.last_revision())
2638
graph = branch1.repository.get_graph(branch2.repository)
2639
base_rev_id = graph.find_unique_lca(last1, last2)
2641
print 'merge base is revision %s' % base_rev_id
2644
class cmd_merge(Command):
2645
"""Perform a three-way merge.
2647
The branch is the branch you will merge from. By default, it will merge
2648
the latest revision. If you specify a revision, that revision will be
2649
merged. If you specify two revisions, the first will be used as a BASE,
2650
and the second one as OTHER. Revision numbers are always relative to the
2653
By default, bzr will try to merge in all new work from the other
2654
branch, automatically determining an appropriate base. If this
2655
fails, you may need to give an explicit base.
2657
Merge will do its best to combine the changes in two branches, but there
2658
are some kinds of problems only a human can fix. When it encounters those,
2659
it will mark a conflict. A conflict means that you need to fix something,
2660
before you should commit.
2662
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2664
If there is no default branch set, the first merge will set it. After
2665
that, you can omit the branch to use the default. To change the
2666
default, use --remember. The value will only be saved if the remote
2667
location can be accessed.
2669
The results of the merge are placed into the destination working
2670
directory, where they can be reviewed (with bzr diff), tested, and then
2671
committed to record the result of the merge.
2673
merge refuses to run if there are any uncommitted changes, unless
2677
To merge the latest revision from bzr.dev::
2679
bzr merge ../bzr.dev
2681
To merge changes up to and including revision 82 from bzr.dev::
2683
bzr merge -r 82 ../bzr.dev
2685
To merge the changes introduced by 82, without previous changes::
2687
bzr merge -r 81..82 ../bzr.dev
2690
_see_also = ['update', 'remerge', 'status-flags']
2691
takes_args = ['branch?']
2696
help='Merge even if the destination tree has uncommitted changes.'),
2700
Option('show-base', help="Show base revision text in "
2702
Option('uncommitted', help='Apply uncommitted changes'
2703
' from a working copy, instead of branch changes.'),
2704
Option('pull', help='If the destination is already'
2705
' completely merged into the source, pull from the'
2706
' source rather than merging. When this happens,'
2707
' you do not need to commit the result.'),
2709
help='Branch to merge into, '
2710
'rather than the one containing the working directory.',
2716
def run(self, branch=None, revision=None, force=False, merge_type=None,
2717
show_base=False, reprocess=False, remember=False,
2718
uncommitted=False, pull=False,
2721
# This is actually a branch (or merge-directive) *location*.
2725
if merge_type is None:
2726
merge_type = _mod_merge.Merge3Merger
2728
if directory is None: directory = u'.'
2729
possible_transports = []
2731
allow_pending = True
2732
verified = 'inapplicable'
2733
tree = WorkingTree.open_containing(directory)[0]
2734
change_reporter = delta._ChangeReporter(
2735
unversioned_filter=tree.is_ignored)
2738
pb = ui.ui_factory.nested_progress_bar()
2739
cleanups.append(pb.finished)
2741
cleanups.append(tree.unlock)
2742
if location is not None:
2743
mergeable, other_transport = _get_mergeable_helper(location)
2746
raise errors.BzrCommandError('Cannot use --uncommitted'
2747
' with bundles or merge directives.')
2749
if revision is not None:
2750
raise errors.BzrCommandError(
2751
'Cannot use -r with merge directives or bundles')
2752
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2754
possible_transports.append(other_transport)
2756
if merger is None and uncommitted:
2757
if revision is not None and len(revision) > 0:
2758
raise errors.BzrCommandError('Cannot use --uncommitted and'
2759
' --revision at the same time.')
2760
location = self._select_branch_location(tree, location)[0]
2761
other_tree, other_path = WorkingTree.open_containing(location)
2762
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2764
allow_pending = False
2767
merger, allow_pending = self._get_merger_from_branch(tree,
2768
location, revision, remember, possible_transports, pb)
2770
merger.merge_type = merge_type
2771
merger.reprocess = reprocess
2772
merger.show_base = show_base
2773
merger.change_reporter = change_reporter
2774
self.sanity_check_merger(merger)
2775
if (merger.base_rev_id == merger.other_rev_id and
2776
merger.other_rev_id != None):
2777
note('Nothing to do.')
2780
if merger.interesting_files is not None:
2781
raise errors.BzrCommandError('Cannot pull individual files')
2782
if (merger.base_rev_id == tree.last_revision()):
2783
result = tree.pull(merger.other_branch, False,
2784
merger.other_rev_id)
2785
result.report(self.outf)
2787
merger.check_basis(not force)
2788
conflict_count = merger.do_merge()
2790
merger.set_pending()
2791
if verified == 'failed':
2792
warning('Preview patch does not match changes')
2793
if conflict_count != 0:
2798
for cleanup in reversed(cleanups):
2801
def sanity_check_merger(self, merger):
2802
if (merger.show_base and
2803
not merger.merge_type is _mod_merge.Merge3Merger):
2804
raise errors.BzrCommandError("Show-base is not supported for this"
2805
" merge type. %s" % merger.merge_type)
2806
if merger.reprocess and not merger.merge_type.supports_reprocess:
2807
raise errors.BzrCommandError("Conflict reduction is not supported"
2808
" for merge type %s." %
2810
if merger.reprocess and merger.show_base:
2811
raise errors.BzrCommandError("Cannot do conflict reduction and"
2814
def _get_merger_from_branch(self, tree, location, revision, remember,
2815
possible_transports, pb):
2816
"""Produce a merger from a location, assuming it refers to a branch."""
2817
from bzrlib.tag import _merge_tags_if_possible
2818
assert revision is None or len(revision) < 3
2819
# find the branch locations
2820
other_loc, location = self._select_branch_location(tree, location,
2822
if revision is not None and len(revision) == 2:
2823
base_loc, location = self._select_branch_location(tree, location,
2826
base_loc = other_loc
2828
other_branch, other_path = Branch.open_containing(other_loc,
2829
possible_transports)
2830
if base_loc == other_loc:
2831
base_branch = other_branch
2833
base_branch, base_path = Branch.open_containing(base_loc,
2834
possible_transports)
2835
# Find the revision ids
2836
if revision is None or len(revision) < 1 or revision[-1] is None:
2837
other_revision_id = _mod_revision.ensure_null(
2838
other_branch.last_revision())
2840
other_revision_id = \
2841
_mod_revision.ensure_null(
2842
revision[-1].in_history(other_branch).rev_id)
2843
if (revision is not None and len(revision) == 2
2844
and revision[0] is not None):
2845
base_revision_id = \
2846
_mod_revision.ensure_null(
2847
revision[0].in_history(base_branch).rev_id)
2849
base_revision_id = None
2850
# Remember where we merge from
2851
if ((tree.branch.get_parent() is None or remember) and
2852
other_branch is not None):
2853
tree.branch.set_parent(other_branch.base)
2854
_merge_tags_if_possible(other_branch, tree.branch)
2855
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2856
other_revision_id, base_revision_id, other_branch, base_branch)
2857
if other_path != '':
2858
allow_pending = False
2859
merger.interesting_files = [other_path]
2861
allow_pending = True
2862
return merger, allow_pending
2864
def _select_branch_location(self, tree, location, revision=None,
2866
"""Select a branch location, according to possible inputs.
2868
If provided, branches from ``revision`` are preferred. (Both
2869
``revision`` and ``index`` must be supplied.)
2871
Otherwise, the ``location`` parameter is used. If it is None, then the
2872
``parent`` location is used, and a note is printed.
2874
:param tree: The working tree to select a branch for merging into
2875
:param location: The location entered by the user
2876
:param revision: The revision parameter to the command
2877
:param index: The index to use for the revision parameter. Negative
2878
indices are permitted.
2879
:return: (selected_location, default_location). The default location
2880
will be the user-entered location, if any, or else the remembered
2883
if (revision is not None and index is not None
2884
and revision[index] is not None):
2885
branch = revision[index].get_branch()
2886
if branch is not None:
2887
return branch, location
2888
location = self._get_remembered_parent(tree, location, 'Merging from')
2889
return location, location
2891
# TODO: move up to common parent; this isn't merge-specific anymore.
2892
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2893
"""Use tree.branch's parent if none was supplied.
2895
Report if the remembered location was used.
2897
if supplied_location is not None:
2898
return supplied_location
2899
stored_location = tree.branch.get_parent()
2900
mutter("%s", stored_location)
2901
if stored_location is None:
2902
raise errors.BzrCommandError("No location specified or remembered")
2903
display_url = urlutils.unescape_for_display(stored_location,
2905
self.outf.write("%s remembered location %s\n" % (verb_string,
2907
return stored_location
2910
class cmd_remerge(Command):
2913
Use this if you want to try a different merge technique while resolving
2914
conflicts. Some merge techniques are better than others, and remerge
2915
lets you try different ones on different files.
2917
The options for remerge have the same meaning and defaults as the ones for
2918
merge. The difference is that remerge can (only) be run when there is a
2919
pending merge, and it lets you specify particular files.
2922
Re-do the merge of all conflicted files, and show the base text in
2923
conflict regions, in addition to the usual THIS and OTHER texts::
2925
bzr remerge --show-base
2927
Re-do the merge of "foobar", using the weave merge algorithm, with
2928
additional processing to reduce the size of conflict regions::
2930
bzr remerge --merge-type weave --reprocess foobar
2932
takes_args = ['file*']
2937
help="Show base revision text in conflicts."),
2940
def run(self, file_list=None, merge_type=None, show_base=False,
2942
if merge_type is None:
2943
merge_type = _mod_merge.Merge3Merger
2944
tree, file_list = tree_files(file_list)
2947
parents = tree.get_parent_ids()
2948
if len(parents) != 2:
2949
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2950
" merges. Not cherrypicking or"
2952
repository = tree.branch.repository
2953
graph = repository.get_graph()
2954
base_revision = graph.find_unique_lca(parents[0], parents[1])
2955
base_tree = repository.revision_tree(base_revision)
2956
other_tree = repository.revision_tree(parents[1])
2957
interesting_ids = None
2959
conflicts = tree.conflicts()
2960
if file_list is not None:
2961
interesting_ids = set()
2962
for filename in file_list:
2963
file_id = tree.path2id(filename)
2965
raise errors.NotVersionedError(filename)
2966
interesting_ids.add(file_id)
2967
if tree.kind(file_id) != "directory":
2970
for name, ie in tree.inventory.iter_entries(file_id):
2971
interesting_ids.add(ie.file_id)
2972
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2974
# Remerge only supports resolving contents conflicts
2975
allowed_conflicts = ('text conflict', 'contents conflict')
2976
restore_files = [c.path for c in conflicts
2977
if c.typestring in allowed_conflicts]
2978
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2979
tree.set_conflicts(ConflictList(new_conflicts))
2980
if file_list is not None:
2981
restore_files = file_list
2982
for filename in restore_files:
2984
restore(tree.abspath(filename))
2985
except errors.NotConflicted:
2987
# Disable pending merges, because the file texts we are remerging
2988
# have not had those merges performed. If we use the wrong parents
2989
# list, we imply that the working tree text has seen and rejected
2990
# all the changes from the other tree, when in fact those changes
2991
# have not yet been seen.
2992
tree.set_parent_ids(parents[:1])
2994
conflicts = _mod_merge.merge_inner(
2995
tree.branch, other_tree, base_tree,
2997
interesting_ids=interesting_ids,
2998
other_rev_id=parents[1],
2999
merge_type=merge_type,
3000
show_base=show_base,
3001
reprocess=reprocess)
3003
tree.set_parent_ids(parents)
3012
class cmd_revert(Command):
3013
"""Revert files to a previous revision.
3015
Giving a list of files will revert only those files. Otherwise, all files
3016
will be reverted. If the revision is not specified with '--revision', the
3017
last committed revision is used.
3019
To remove only some changes, without reverting to a prior version, use
3020
merge instead. For example, "merge . --r-2..-3" will remove the changes
3021
introduced by -2, without affecting the changes introduced by -1. Or
3022
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3024
By default, any files that have been manually changed will be backed up
3025
first. (Files changed only by merge are not backed up.) Backup files have
3026
'.~#~' appended to their name, where # is a number.
3028
When you provide files, you can use their current pathname or the pathname
3029
from the target revision. So you can use revert to "undelete" a file by
3030
name. If you name a directory, all the contents of that directory will be
3033
Any files that have been newly added since that revision will be deleted,
3034
with a backup kept if appropriate. Directories containing unknown files
3035
will not be deleted.
3038
_see_also = ['cat', 'export']
3041
Option('no-backup', "Do not save backups of reverted files."),
3042
Option('forget-merges',
3043
'Remove pending merge marker, without changing any files.'),
3045
takes_args = ['file*']
3047
def run(self, revision=None, no_backup=False, file_list=None,
3048
forget_merges=None):
3049
tree, file_list = tree_files(file_list)
3051
tree.set_parent_ids(tree.get_parent_ids()[:1])
3053
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3056
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3057
if revision is None:
3058
rev_id = tree.last_revision()
3059
elif len(revision) != 1:
3060
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3062
rev_id = revision[0].in_history(tree.branch).rev_id
3063
pb = ui.ui_factory.nested_progress_bar()
3065
tree.revert(file_list,
3066
tree.branch.repository.revision_tree(rev_id),
3067
not no_backup, pb, report_changes=True)
3072
class cmd_assert_fail(Command):
3073
"""Test reporting of assertion failures"""
3074
# intended just for use in testing
3079
raise AssertionError("always fails")
3082
class cmd_help(Command):
3083
"""Show help on a command or other topic.
3086
_see_also = ['topics']
3088
Option('long', 'Show help on all commands.'),
3090
takes_args = ['topic?']
3091
aliases = ['?', '--help', '-?', '-h']
3094
def run(self, topic=None, long=False):
3096
if topic is None and long:
3098
bzrlib.help.help(topic)
3101
class cmd_shell_complete(Command):
3102
"""Show appropriate completions for context.
3104
For a list of all available commands, say 'bzr shell-complete'.
3106
takes_args = ['context?']
3111
def run(self, context=None):
3112
import shellcomplete
3113
shellcomplete.shellcomplete(context)
3116
class cmd_fetch(Command):
3117
"""Copy in history from another branch but don't merge it.
3119
This is an internal method used for pull and merge.
3122
takes_args = ['from_branch', 'to_branch']
3123
def run(self, from_branch, to_branch):
3124
from bzrlib.fetch import Fetcher
3125
from_b = Branch.open(from_branch)
3126
to_b = Branch.open(to_branch)
3127
Fetcher(to_b, from_b)
3130
class cmd_missing(Command):
3131
"""Show unmerged/unpulled revisions between two branches.
3133
OTHER_BRANCH may be local or remote.
3136
_see_also = ['merge', 'pull']
3137
takes_args = ['other_branch?']
3139
Option('reverse', 'Reverse the order of revisions.'),
3141
'Display changes in the local branch only.'),
3142
Option('this' , 'Same as --mine-only.'),
3143
Option('theirs-only',
3144
'Display changes in the remote branch only.'),
3145
Option('other', 'Same as --theirs-only.'),
3150
encoding_type = 'replace'
3153
def run(self, other_branch=None, reverse=False, mine_only=False,
3154
theirs_only=False, log_format=None, long=False, short=False, line=False,
3155
show_ids=False, verbose=False, this=False, other=False):
3156
from bzrlib.missing import find_unmerged, iter_log_revisions
3163
local_branch = Branch.open_containing(u".")[0]
3164
parent = local_branch.get_parent()
3165
if other_branch is None:
3166
other_branch = parent
3167
if other_branch is None:
3168
raise errors.BzrCommandError("No peer location known"
3170
display_url = urlutils.unescape_for_display(parent,
3172
self.outf.write("Using last location: " + display_url + "\n")
3174
remote_branch = Branch.open(other_branch)
3175
if remote_branch.base == local_branch.base:
3176
remote_branch = local_branch
3177
local_branch.lock_read()
3179
remote_branch.lock_read()
3181
local_extra, remote_extra = find_unmerged(local_branch,
3183
if log_format is None:
3184
registry = log.log_formatter_registry
3185
log_format = registry.get_default(local_branch)
3186
lf = log_format(to_file=self.outf,
3188
show_timezone='original')
3189
if reverse is False:
3190
local_extra.reverse()
3191
remote_extra.reverse()
3192
if local_extra and not theirs_only:
3193
self.outf.write("You have %d extra revision(s):\n" %
3195
for revision in iter_log_revisions(local_extra,
3196
local_branch.repository,
3198
lf.log_revision(revision)
3199
printed_local = True
3201
printed_local = False
3202
if remote_extra and not mine_only:
3203
if printed_local is True:
3204
self.outf.write("\n\n\n")
3205
self.outf.write("You are missing %d revision(s):\n" %
3207
for revision in iter_log_revisions(remote_extra,
3208
remote_branch.repository,
3210
lf.log_revision(revision)
3211
if not remote_extra and not local_extra:
3213
self.outf.write("Branches are up to date.\n")
3217
remote_branch.unlock()
3219
local_branch.unlock()
3220
if not status_code and parent is None and other_branch is not None:
3221
local_branch.lock_write()
3223
# handle race conditions - a parent might be set while we run.
3224
if local_branch.get_parent() is None:
3225
local_branch.set_parent(remote_branch.base)
3227
local_branch.unlock()
3231
class cmd_pack(Command):
3232
"""Compress the data within a repository."""
3234
_see_also = ['repositories']
3235
takes_args = ['branch_or_repo?']
3237
def run(self, branch_or_repo='.'):
3238
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3240
branch = dir.open_branch()
3241
repository = branch.repository
3242
except errors.NotBranchError:
3243
repository = dir.open_repository()
3247
class cmd_plugins(Command):
3248
"""List the installed plugins.
3250
This command displays the list of installed plugins including the
3251
path where each one is located and a short description of each.
3253
A plugin is an external component for Bazaar that extends the
3254
revision control system, by adding or replacing code in Bazaar.
3255
Plugins can do a variety of things, including overriding commands,
3256
adding new commands, providing additional network transports and
3257
customizing log output.
3259
See the Bazaar web site, http://bazaar-vcs.org, for further
3260
information on plugins including where to find them and how to
3261
install them. Instructions are also provided there on how to
3262
write new plugins using the Python programming language.
3267
import bzrlib.plugin
3268
from inspect import getdoc
3269
for name, plugin in bzrlib.plugin.plugins().items():
3270
print plugin.path(), "[%s]" % plugin.__version__
3271
d = getdoc(plugin.module)
3273
print '\t', d.split('\n')[0]
3276
class cmd_testament(Command):
3277
"""Show testament (signing-form) of a revision."""
3280
Option('long', help='Produce long-format testament.'),
3282
help='Produce a strict-format testament.')]
3283
takes_args = ['branch?']
3285
def run(self, branch=u'.', revision=None, long=False, strict=False):
3286
from bzrlib.testament import Testament, StrictTestament
3288
testament_class = StrictTestament
3290
testament_class = Testament
3291
b = WorkingTree.open_containing(branch)[0].branch
3294
if revision is None:
3295
rev_id = b.last_revision()
3297
rev_id = revision[0].in_history(b).rev_id
3298
t = testament_class.from_revision(b.repository, rev_id)
3300
sys.stdout.writelines(t.as_text_lines())
3302
sys.stdout.write(t.as_short_text())
3307
class cmd_annotate(Command):
3308
"""Show the origin of each line in a file.
3310
This prints out the given file with an annotation on the left side
3311
indicating which revision, author and date introduced the change.
3313
If the origin is the same for a run of consecutive lines, it is
3314
shown only at the top, unless the --all option is given.
3316
# TODO: annotate directories; showing when each file was last changed
3317
# TODO: if the working copy is modified, show annotations on that
3318
# with new uncommitted lines marked
3319
aliases = ['ann', 'blame', 'praise']
3320
takes_args = ['filename']
3321
takes_options = [Option('all', help='Show annotations on all lines.'),
3322
Option('long', help='Show commit date in annotations.'),
3326
encoding_type = 'exact'
3329
def run(self, filename, all=False, long=False, revision=None,
3331
from bzrlib.annotate import annotate_file
3332
tree, relpath = WorkingTree.open_containing(filename)
3333
branch = tree.branch
3336
if revision is None:
3337
revision_id = branch.last_revision()
3338
elif len(revision) != 1:
3339
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3341
revision_id = revision[0].in_history(branch).rev_id
3342
file_id = tree.path2id(relpath)
3344
raise errors.NotVersionedError(filename)
3345
tree = branch.repository.revision_tree(revision_id)
3346
file_version = tree.inventory[file_id].revision
3347
annotate_file(branch, file_version, file_id, long, all, self.outf,
3353
class cmd_re_sign(Command):
3354
"""Create a digital signature for an existing revision."""
3355
# TODO be able to replace existing ones.
3357
hidden = True # is this right ?
3358
takes_args = ['revision_id*']
3359
takes_options = ['revision']
3361
def run(self, revision_id_list=None, revision=None):
3362
import bzrlib.gpg as gpg
3363
if revision_id_list is not None and revision is not None:
3364
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3365
if revision_id_list is None and revision is None:
3366
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3367
b = WorkingTree.open_containing(u'.')[0].branch
3368
gpg_strategy = gpg.GPGStrategy(b.get_config())
3369
if revision_id_list is not None:
3370
for revision_id in revision_id_list:
3371
b.repository.sign_revision(revision_id, gpg_strategy)
3372
elif revision is not None:
3373
if len(revision) == 1:
3374
revno, rev_id = revision[0].in_history(b)
3375
b.repository.sign_revision(rev_id, gpg_strategy)
3376
elif len(revision) == 2:
3377
# are they both on rh- if so we can walk between them
3378
# might be nice to have a range helper for arbitrary
3379
# revision paths. hmm.
3380
from_revno, from_revid = revision[0].in_history(b)
3381
to_revno, to_revid = revision[1].in_history(b)
3382
if to_revid is None:
3383
to_revno = b.revno()
3384
if from_revno is None or to_revno is None:
3385
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3386
for revno in range(from_revno, to_revno + 1):
3387
b.repository.sign_revision(b.get_rev_id(revno),
3390
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3393
class cmd_bind(Command):
3394
"""Convert the current branch into a checkout of the supplied branch.
3396
Once converted into a checkout, commits must succeed on the master branch
3397
before they will be applied to the local branch.
3400
_see_also = ['checkouts', 'unbind']
3401
takes_args = ['location?']
3404
def run(self, location=None):
3405
b, relpath = Branch.open_containing(u'.')
3406
if location is None:
3408
location = b.get_old_bound_location()
3409
except errors.UpgradeRequired:
3410
raise errors.BzrCommandError('No location supplied. '
3411
'This format does not remember old locations.')
3413
if location is None:
3414
raise errors.BzrCommandError('No location supplied and no '
3415
'previous location known')
3416
b_other = Branch.open(location)
3419
except errors.DivergedBranches:
3420
raise errors.BzrCommandError('These branches have diverged.'
3421
' Try merging, and then bind again.')
3424
class cmd_unbind(Command):
3425
"""Convert the current checkout into a regular branch.
3427
After unbinding, the local branch is considered independent and subsequent
3428
commits will be local only.
3431
_see_also = ['checkouts', 'bind']
3436
b, relpath = Branch.open_containing(u'.')
3438
raise errors.BzrCommandError('Local branch is not bound')
3441
class cmd_uncommit(Command):
3442
"""Remove the last committed revision.
3444
--verbose will print out what is being removed.
3445
--dry-run will go through all the motions, but not actually
3448
If --revision is specified, uncommit revisions to leave the branch at the
3449
specified revision. For example, "bzr uncommit -r 15" will leave the
3450
branch at revision 15.
3452
In the future, uncommit will create a revision bundle, which can then
3456
# TODO: jam 20060108 Add an option to allow uncommit to remove
3457
# unreferenced information in 'branch-as-repository' branches.
3458
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3459
# information in shared branches as well.
3460
_see_also = ['commit']
3461
takes_options = ['verbose', 'revision',
3462
Option('dry-run', help='Don\'t actually make changes.'),
3463
Option('force', help='Say yes to all questions.')]
3464
takes_args = ['location?']
3467
def run(self, location=None,
3468
dry_run=False, verbose=False,
3469
revision=None, force=False):
3470
from bzrlib.log import log_formatter, show_log
3471
from bzrlib.uncommit import uncommit
3473
if location is None:
3475
control, relpath = bzrdir.BzrDir.open_containing(location)
3477
tree = control.open_workingtree()
3479
except (errors.NoWorkingTree, errors.NotLocalUrl):
3481
b = control.open_branch()
3484
if revision is None:
3487
# 'bzr uncommit -r 10' actually means uncommit
3488
# so that the final tree is at revno 10.
3489
# but bzrlib.uncommit.uncommit() actually uncommits
3490
# the revisions that are supplied.
3491
# So we need to offset it by one
3492
revno = revision[0].in_history(b).revno+1
3494
if revno <= b.revno():
3495
rev_id = b.get_rev_id(revno)
3497
self.outf.write('No revisions to uncommit.\n')
3500
lf = log_formatter('short',
3502
show_timezone='original')
3507
direction='forward',
3508
start_revision=revno,
3509
end_revision=b.revno())
3512
print 'Dry-run, pretending to remove the above revisions.'
3514
val = raw_input('Press <enter> to continue')
3516
print 'The above revision(s) will be removed.'
3518
val = raw_input('Are you sure [y/N]? ')
3519
if val.lower() not in ('y', 'yes'):
3523
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3527
class cmd_break_lock(Command):
3528
"""Break a dead lock on a repository, branch or working directory.
3530
CAUTION: Locks should only be broken when you are sure that the process
3531
holding the lock has been stopped.
3533
You can get information on what locks are open via the 'bzr info' command.
3538
takes_args = ['location?']
3540
def run(self, location=None, show=False):
3541
if location is None:
3543
control, relpath = bzrdir.BzrDir.open_containing(location)
3545
control.break_lock()
3546
except NotImplementedError:
3550
class cmd_wait_until_signalled(Command):
3551
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3553
This just prints a line to signal when it is ready, then blocks on stdin.
3559
sys.stdout.write("running\n")
3561
sys.stdin.readline()
3564
class cmd_serve(Command):
3565
"""Run the bzr server."""
3567
aliases = ['server']
3571
help='Serve on stdin/out for use from inetd or sshd.'),
3573
help='Listen for connections on nominated port of the form '
3574
'[hostname:]portnumber. Passing 0 as the port number will '
3575
'result in a dynamically allocated port. The default port is '
3579
help='Serve contents of this directory.',
3581
Option('allow-writes',
3582
help='By default the server is a readonly server. Supplying '
3583
'--allow-writes enables write access to the contents of '
3584
'the served directory and below.'
3588
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3589
from bzrlib.smart import medium, server
3590
from bzrlib.transport import get_transport
3591
from bzrlib.transport.chroot import ChrootServer
3592
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3593
if directory is None:
3594
directory = os.getcwd()
3595
url = urlutils.local_path_to_url(directory)
3596
if not allow_writes:
3597
url = 'readonly+' + url
3598
chroot_server = ChrootServer(get_transport(url))
3599
chroot_server.setUp()
3600
t = get_transport(chroot_server.get_url())
3602
smart_server = medium.SmartServerPipeStreamMedium(
3603
sys.stdin, sys.stdout, t)
3605
host = BZR_DEFAULT_INTERFACE
3607
port = BZR_DEFAULT_PORT
3610
host, port = port.split(':')
3612
smart_server = server.SmartTCPServer(t, host=host, port=port)
3613
print 'listening on port: ', smart_server.port
3615
# for the duration of this server, no UI output is permitted.
3616
# note that this may cause problems with blackbox tests. This should
3617
# be changed with care though, as we dont want to use bandwidth sending
3618
# progress over stderr to smart server clients!
3619
old_factory = ui.ui_factory
3621
ui.ui_factory = ui.SilentUIFactory()
3622
smart_server.serve()
3624
ui.ui_factory = old_factory
3627
class cmd_join(Command):
3628
"""Combine a subtree into its containing tree.
3630
This command is for experimental use only. It requires the target tree
3631
to be in dirstate-with-subtree format, which cannot be converted into
3634
The TREE argument should be an independent tree, inside another tree, but
3635
not part of it. (Such trees can be produced by "bzr split", but also by
3636
running "bzr branch" with the target inside a tree.)
3638
The result is a combined tree, with the subtree no longer an independant
3639
part. This is marked as a merge of the subtree into the containing tree,
3640
and all history is preserved.
3642
If --reference is specified, the subtree retains its independence. It can
3643
be branched by itself, and can be part of multiple projects at the same
3644
time. But operations performed in the containing tree, such as commit
3645
and merge, will recurse into the subtree.
3648
_see_also = ['split']
3649
takes_args = ['tree']
3651
Option('reference', help='Join by reference.'),
3655
def run(self, tree, reference=False):
3656
sub_tree = WorkingTree.open(tree)
3657
parent_dir = osutils.dirname(sub_tree.basedir)
3658
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3659
repo = containing_tree.branch.repository
3660
if not repo.supports_rich_root():
3661
raise errors.BzrCommandError(
3662
"Can't join trees because %s doesn't support rich root data.\n"
3663
"You can use bzr upgrade on the repository."
3667
containing_tree.add_reference(sub_tree)
3668
except errors.BadReferenceTarget, e:
3669
# XXX: Would be better to just raise a nicely printable
3670
# exception from the real origin. Also below. mbp 20070306
3671
raise errors.BzrCommandError("Cannot join %s. %s" %
3675
containing_tree.subsume(sub_tree)
3676
except errors.BadSubsumeSource, e:
3677
raise errors.BzrCommandError("Cannot join %s. %s" %
3681
class cmd_split(Command):
3682
"""Split a tree into two trees.
3684
This command is for experimental use only. It requires the target tree
3685
to be in dirstate-with-subtree format, which cannot be converted into
3688
The TREE argument should be a subdirectory of a working tree. That
3689
subdirectory will be converted into an independent tree, with its own
3690
branch. Commits in the top-level tree will not apply to the new subtree.
3691
If you want that behavior, do "bzr join --reference TREE".
3694
_see_also = ['join']
3695
takes_args = ['tree']
3699
def run(self, tree):
3700
containing_tree, subdir = WorkingTree.open_containing(tree)
3701
sub_id = containing_tree.path2id(subdir)
3703
raise errors.NotVersionedError(subdir)
3705
containing_tree.extract(sub_id)
3706
except errors.RootNotRich:
3707
raise errors.UpgradeRequired(containing_tree.branch.base)
3711
class cmd_merge_directive(Command):
3712
"""Generate a merge directive for auto-merge tools.
3714
A directive requests a merge to be performed, and also provides all the
3715
information necessary to do so. This means it must either include a
3716
revision bundle, or the location of a branch containing the desired
3719
A submit branch (the location to merge into) must be supplied the first
3720
time the command is issued. After it has been supplied once, it will
3721
be remembered as the default.
3723
A public branch is optional if a revision bundle is supplied, but required
3724
if --diff or --plain is specified. It will be remembered as the default
3725
after the first use.
3728
takes_args = ['submit_branch?', 'public_branch?']
3732
_see_also = ['send']
3735
RegistryOption.from_kwargs('patch-type',
3736
'The type of patch to include in the directive.',
3738
value_switches=True,
3740
bundle='Bazaar revision bundle (default).',
3741
diff='Normal unified diff.',
3742
plain='No patch, just directive.'),
3743
Option('sign', help='GPG-sign the directive.'), 'revision',
3744
Option('mail-to', type=str,
3745
help='Instead of printing the directive, email to this address.'),
3746
Option('message', type=str, short_name='m',
3747
help='Message to use when committing this merge.')
3750
encoding_type = 'exact'
3752
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3753
sign=False, revision=None, mail_to=None, message=None):
3754
from bzrlib.revision import ensure_null, NULL_REVISION
3755
include_patch, include_bundle = {
3756
'plain': (False, False),
3757
'diff': (True, False),
3758
'bundle': (True, True),
3760
branch = Branch.open('.')
3761
stored_submit_branch = branch.get_submit_branch()
3762
if submit_branch is None:
3763
submit_branch = stored_submit_branch
3765
if stored_submit_branch is None:
3766
branch.set_submit_branch(submit_branch)
3767
if submit_branch is None:
3768
submit_branch = branch.get_parent()
3769
if submit_branch is None:
3770
raise errors.BzrCommandError('No submit branch specified or known')
3772
stored_public_branch = branch.get_public_branch()
3773
if public_branch is None:
3774
public_branch = stored_public_branch
3775
elif stored_public_branch is None:
3776
branch.set_public_branch(public_branch)
3777
if not include_bundle and public_branch is None:
3778
raise errors.BzrCommandError('No public branch specified or'
3780
base_revision_id = None
3781
if revision is not None:
3782
if len(revision) > 2:
3783
raise errors.BzrCommandError('bzr merge-directive takes '
3784
'at most two one revision identifiers')
3785
revision_id = revision[-1].in_history(branch).rev_id
3786
if len(revision) == 2:
3787
base_revision_id = revision[0].in_history(branch).rev_id
3788
base_revision_id = ensure_null(base_revision_id)
3790
revision_id = branch.last_revision()
3791
revision_id = ensure_null(revision_id)
3792
if revision_id == NULL_REVISION:
3793
raise errors.BzrCommandError('No revisions to bundle.')
3794
directive = merge_directive.MergeDirective2.from_objects(
3795
branch.repository, revision_id, time.time(),
3796
osutils.local_time_offset(), submit_branch,
3797
public_branch=public_branch, include_patch=include_patch,
3798
include_bundle=include_bundle, message=message,
3799
base_revision_id=base_revision_id)
3802
self.outf.write(directive.to_signed(branch))
3804
self.outf.writelines(directive.to_lines())
3806
message = directive.to_email(mail_to, branch, sign)
3807
s = SMTPConnection(branch.get_config())
3808
s.send_email(message)
3811
class cmd_send(Command):
3812
"""Mail or create a merge-directive for submiting changes.
3814
A merge directive provides many things needed for requesting merges:
3816
* A machine-readable description of the merge to perform
3818
* An optional patch that is a preview of the changes requested
3820
* An optional bundle of revision data, so that the changes can be applied
3821
directly from the merge directive, without retrieving data from a
3824
If --no-bundle is specified, then public_branch is needed (and must be
3825
up-to-date), so that the receiver can perform the merge using the
3826
public_branch. The public_branch is always included if known, so that
3827
people can check it later.
3829
The submit branch defaults to the parent, but can be overridden. Both
3830
submit branch and public branch will be remembered if supplied.
3832
If a public_branch is known for the submit_branch, that public submit
3833
branch is used in the merge instructions. This means that a local mirror
3834
can be used as your actual submit branch, once you have set public_branch
3837
Mail is sent using your preferred mail program. This should be transparent
3838
on Windows (it uses MAPI). On *nix, it requires the xdg-email utility. If
3839
the preferred client can't be found (or used), your editor will be used.
3841
To use a specific mail program, set the mail_client configuration option.
3842
(For Thunderbird 1.5, this works around some bugs.) Supported values for
3843
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
3844
generic options are "default", "editor", "mapi", and "xdg-email".
3846
If mail is being sent, a to address is required. This can be supplied
3847
either on the commandline, or by setting the submit_to configuration
3850
Two formats are currently supported: "4" uses revision bundle format 4 and
3851
merge directive format 2. It is significantly faster and smaller than
3852
older formats. It is compatible with Bazaar 0.19 and later. It is the
3853
default. "0.9" uses revision bundle format 0.9 and merge directive
3854
format 1. It is compatible with Bazaar 0.12 - 0.18.
3857
encoding_type = 'exact'
3859
_see_also = ['merge']
3861
takes_args = ['submit_branch?', 'public_branch?']
3865
help='Do not include a bundle in the merge directive.'),
3866
Option('no-patch', help='Do not include a preview patch in the merge'
3869
help='Remember submit and public branch.'),
3871
help='Branch to generate the submission from, '
3872
'rather than the one containing the working directory.',
3875
Option('output', short_name='o', help='Write directive to this file.',
3877
Option('mail-to', help='Mail the request to this address.',
3881
RegistryOption.from_kwargs('format',
3882
'Use the specified output format.',
3883
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
3884
'0.9': 'Bundle format 0.9, Merge Directive 1',})
3887
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3888
no_patch=False, revision=None, remember=False, output=None,
3889
format='4', mail_to=None, message=None, **kwargs):
3890
return self._run(submit_branch, revision, public_branch, remember,
3891
format, no_bundle, no_patch, output,
3892
kwargs.get('from', '.'), mail_to, message)
3894
def _run(self, submit_branch, revision, public_branch, remember, format,
3895
no_bundle, no_patch, output, from_, mail_to, message):
3896
from bzrlib.revision import NULL_REVISION
3898
outfile = StringIO()
3902
outfile = open(output, 'wb')
3904
branch = Branch.open_containing(from_)[0]
3906
config = branch.get_config()
3908
mail_to = config.get_user_option('submit_to')
3910
raise errors.BzrCommandError('No mail-to address'
3912
mail_client = config.get_mail_client()
3913
if remember and submit_branch is None:
3914
raise errors.BzrCommandError(
3915
'--remember requires a branch to be specified.')
3916
stored_submit_branch = branch.get_submit_branch()
3917
remembered_submit_branch = False
3918
if submit_branch is None:
3919
submit_branch = stored_submit_branch
3920
remembered_submit_branch = True
3922
if stored_submit_branch is None or remember:
3923
branch.set_submit_branch(submit_branch)
3924
if submit_branch is None:
3925
submit_branch = branch.get_parent()
3926
remembered_submit_branch = True
3927
if submit_branch is None:
3928
raise errors.BzrCommandError('No submit branch known or'
3930
if remembered_submit_branch:
3931
note('Using saved location: %s', submit_branch)
3933
stored_public_branch = branch.get_public_branch()
3934
if public_branch is None:
3935
public_branch = stored_public_branch
3936
elif stored_public_branch is None or remember:
3937
branch.set_public_branch(public_branch)
3938
if no_bundle and public_branch is None:
3939
raise errors.BzrCommandError('No public branch specified or'
3941
base_revision_id = None
3943
if revision is not None:
3944
if len(revision) > 2:
3945
raise errors.BzrCommandError('bzr send takes '
3946
'at most two one revision identifiers')
3947
revision_id = revision[-1].in_history(branch).rev_id
3948
if len(revision) == 2:
3949
base_revision_id = revision[0].in_history(branch).rev_id
3950
if revision_id is None:
3951
revision_id = branch.last_revision()
3952
if revision_id == NULL_REVISION:
3953
raise errors.BzrCommandError('No revisions to submit.')
3955
directive = merge_directive.MergeDirective2.from_objects(
3956
branch.repository, revision_id, time.time(),
3957
osutils.local_time_offset(), submit_branch,
3958
public_branch=public_branch, include_patch=not no_patch,
3959
include_bundle=not no_bundle, message=message,
3960
base_revision_id=base_revision_id)
3961
elif format == '0.9':
3964
patch_type = 'bundle'
3966
raise errors.BzrCommandError('Format 0.9 does not'
3967
' permit bundle with no patch')
3973
directive = merge_directive.MergeDirective.from_objects(
3974
branch.repository, revision_id, time.time(),
3975
osutils.local_time_offset(), submit_branch,
3976
public_branch=public_branch, patch_type=patch_type,
3979
outfile.writelines(directive.to_lines())
3981
subject = '[MERGE] '
3982
if message is not None:
3985
revision = branch.repository.get_revision(revision_id)
3986
subject += revision.get_summary()
3987
mail_client.compose_merge_request(mail_to, subject,
3994
class cmd_bundle_revisions(cmd_send):
3996
"""Create a merge-directive for submiting changes.
3998
A merge directive provides many things needed for requesting merges:
4000
* A machine-readable description of the merge to perform
4002
* An optional patch that is a preview of the changes requested
4004
* An optional bundle of revision data, so that the changes can be applied
4005
directly from the merge directive, without retrieving data from a
4008
If --no-bundle is specified, then public_branch is needed (and must be
4009
up-to-date), so that the receiver can perform the merge using the
4010
public_branch. The public_branch is always included if known, so that
4011
people can check it later.
4013
The submit branch defaults to the parent, but can be overridden. Both
4014
submit branch and public branch will be remembered if supplied.
4016
If a public_branch is known for the submit_branch, that public submit
4017
branch is used in the merge instructions. This means that a local mirror
4018
can be used as your actual submit branch, once you have set public_branch
4021
Two formats are currently supported: "4" uses revision bundle format 4 and
4022
merge directive format 2. It is significantly faster and smaller than
4023
older formats. It is compatible with Bazaar 0.19 and later. It is the
4024
default. "0.9" uses revision bundle format 0.9 and merge directive
4025
format 1. It is compatible with Bazaar 0.12 - 0.18.
4030
help='Do not include a bundle in the merge directive.'),
4031
Option('no-patch', help='Do not include a preview patch in the merge'
4034
help='Remember submit and public branch.'),
4036
help='Branch to generate the submission from, '
4037
'rather than the one containing the working directory.',
4040
Option('output', short_name='o', help='Write directive to this file.',
4043
RegistryOption.from_kwargs('format',
4044
'Use the specified output format.',
4045
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4046
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4048
aliases = ['bundle']
4050
_see_also = ['send', 'merge']
4054
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4055
no_patch=False, revision=None, remember=False, output=None,
4056
format='4', **kwargs):
4059
return self._run(submit_branch, revision, public_branch, remember,
4060
format, no_bundle, no_patch, output,
4061
kwargs.get('from', '.'), None, None)
4064
class cmd_tag(Command):
4065
"""Create, remove or modify a tag naming a revision.
4067
Tags give human-meaningful names to revisions. Commands that take a -r
4068
(--revision) option can be given -rtag:X, where X is any previously
4071
Tags are stored in the branch. Tags are copied from one branch to another
4072
along when you branch, push, pull or merge.
4074
It is an error to give a tag name that already exists unless you pass
4075
--force, in which case the tag is moved to point to the new revision.
4078
_see_also = ['commit', 'tags']
4079
takes_args = ['tag_name']
4082
help='Delete this tag rather than placing it.',
4085
help='Branch in which to place the tag.',
4090
help='Replace existing tags.',
4095
def run(self, tag_name,
4101
branch, relpath = Branch.open_containing(directory)
4105
branch.tags.delete_tag(tag_name)
4106
self.outf.write('Deleted tag %s.\n' % tag_name)
4109
if len(revision) != 1:
4110
raise errors.BzrCommandError(
4111
"Tags can only be placed on a single revision, "
4113
revision_id = revision[0].in_history(branch).rev_id
4115
revision_id = branch.last_revision()
4116
if (not force) and branch.tags.has_tag(tag_name):
4117
raise errors.TagAlreadyExists(tag_name)
4118
branch.tags.set_tag(tag_name, revision_id)
4119
self.outf.write('Created tag %s.\n' % tag_name)
4124
class cmd_tags(Command):
4127
This tag shows a table of tag names and the revisions they reference.
4133
help='Branch whose tags should be displayed.',
4143
branch, relpath = Branch.open_containing(directory)
4144
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
4145
self.outf.write('%-20s %s\n' % (tag_name, target))
4148
class cmd_reconfigure(Command):
4149
"""Reconfigure the type of a bzr directory.
4151
A target configuration must be specified.
4153
For checkouts, the bind-to location will be auto-detected if not specified.
4154
The order of preference is
4155
1. For a lightweight checkout, the current bound location.
4156
2. For branches that used to be checkouts, the previously-bound location.
4157
3. The push location.
4158
4. The parent location.
4159
If none of these is available, --bind-to must be specified.
4162
takes_args = ['location?']
4163
takes_options = [RegistryOption.from_kwargs('target_type',
4164
title='Target type',
4165
help='The type to reconfigure the directory to.',
4166
value_switches=True, enum_switch=False,
4167
branch='Reconfigure to a branch.',
4168
tree='Reconfigure to a tree.',
4169
checkout='Reconfigure to a checkout.'),
4170
Option('bind-to', help='Branch to bind checkout to.',
4173
help='Perform reconfiguration even if local changes'
4177
def run(self, location=None, target_type=None, bind_to=None, force=False):
4178
directory = bzrdir.BzrDir.open(location)
4179
if target_type is None:
4180
raise errors.BzrCommandError('No target configuration specified')
4181
elif target_type == 'branch':
4182
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4183
elif target_type == 'tree':
4184
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4185
elif target_type == 'checkout':
4186
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4188
reconfiguration.apply(force)
4191
def _create_prefix(cur_transport):
4192
needed = [cur_transport]
4193
# Recurse upwards until we can create a directory successfully
4195
new_transport = cur_transport.clone('..')
4196
if new_transport.base == cur_transport.base:
4197
raise errors.BzrCommandError(
4198
"Failed to create path prefix for %s."
4199
% cur_transport.base)
4201
new_transport.mkdir('.')
4202
except errors.NoSuchFile:
4203
needed.append(new_transport)
4204
cur_transport = new_transport
4207
# Now we only need to create child directories
4209
cur_transport = needed.pop()
4210
cur_transport.ensure_base()
4213
def _get_mergeable_helper(location):
4214
"""Get a merge directive or bundle if 'location' points to one.
4216
Try try to identify a bundle and returns its mergeable form. If it's not,
4217
we return the tried transport anyway so that it can reused to access the
4220
:param location: can point to a bundle or a branch.
4222
:return: mergeable, transport
4225
url = urlutils.normalize_url(location)
4226
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4227
location_transport = transport.get_transport(url)
4230
# There may be redirections but we ignore the intermediate
4231
# and final transports used
4232
read = bundle.read_mergeable_from_transport
4233
mergeable, t = read(location_transport, filename)
4234
except errors.NotABundle:
4235
# Continue on considering this url a Branch but adjust the
4236
# location_transport
4237
location_transport = location_transport.clone(filename)
4238
return mergeable, location_transport
4241
# these get imported and then picked up by the scan for cmd_*
4242
# TODO: Some more consistent way to split command definitions across files;
4243
# we do need to load at least some information about them to know of
4244
# aliases. ideally we would avoid loading the implementation until the
4245
# details were needed.
4246
from bzrlib.cmd_version_info import cmd_version_info
4247
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4248
from bzrlib.bundle.commands import (
4251
from bzrlib.sign_my_commits import cmd_sign_my_commits
4252
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4253
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
