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):
207
if revision_id is not None and revision is not None:
208
raise errors.BzrCommandError('You can only supply one of'
209
' revision_id or --revision')
210
if revision_id is None and revision is None:
211
raise errors.BzrCommandError('You must supply either'
212
' --revision or a revision_id')
213
b = WorkingTree.open_containing(u'.')[0].branch
215
# TODO: jam 20060112 should cat-revision always output utf-8?
216
if revision_id is not None:
217
revision_id = osutils.safe_revision_id(revision_id, warn=False)
218
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
219
elif revision is not None:
222
raise errors.BzrCommandError('You cannot specify a NULL'
224
revno, rev_id = rev.in_history(b)
225
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
228
class cmd_remove_tree(Command):
229
"""Remove the working tree from a given branch/checkout.
231
Since a lightweight checkout is little more than a working tree
232
this will refuse to run against one.
234
To re-create the working tree, use "bzr checkout".
236
_see_also = ['checkout', 'working-trees']
238
takes_args = ['location?']
240
def run(self, location='.'):
241
d = bzrdir.BzrDir.open(location)
244
working = d.open_workingtree()
245
except errors.NoWorkingTree:
246
raise errors.BzrCommandError("No working tree to remove")
247
except errors.NotLocalUrl:
248
raise errors.BzrCommandError("You cannot remove the working tree of a "
251
working_path = working.bzrdir.root_transport.base
252
branch_path = working.branch.bzrdir.root_transport.base
253
if working_path != branch_path:
254
raise errors.BzrCommandError("You cannot remove the working tree from "
255
"a lightweight checkout")
257
d.destroy_workingtree()
260
class cmd_revno(Command):
261
"""Show current revision number.
263
This is equal to the number of revisions on this branch.
267
takes_args = ['location?']
270
def run(self, location=u'.'):
271
self.outf.write(str(Branch.open_containing(location)[0].revno()))
272
self.outf.write('\n')
275
class cmd_revision_info(Command):
276
"""Show revision number and revision id for a given revision identifier.
279
takes_args = ['revision_info*']
280
takes_options = ['revision']
283
def run(self, revision=None, revision_info_list=[]):
286
if revision is not None:
287
revs.extend(revision)
288
if revision_info_list is not None:
289
for rev in revision_info_list:
290
revs.append(RevisionSpec.from_string(rev))
292
b = Branch.open_containing(u'.')[0]
295
revs.append(RevisionSpec.from_string('-1'))
298
revinfo = rev.in_history(b)
299
if revinfo.revno is None:
300
dotted_map = b.get_revision_id_to_revno_map()
301
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
302
print '%s %s' % (revno, revinfo.rev_id)
304
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
307
class cmd_add(Command):
308
"""Add specified files or directories.
310
In non-recursive mode, all the named items are added, regardless
311
of whether they were previously ignored. A warning is given if
312
any of the named files are already versioned.
314
In recursive mode (the default), files are treated the same way
315
but the behaviour for directories is different. Directories that
316
are already versioned do not give a warning. All directories,
317
whether already versioned or not, are searched for files or
318
subdirectories that are neither versioned or ignored, and these
319
are added. This search proceeds recursively into versioned
320
directories. If no names are given '.' is assumed.
322
Therefore simply saying 'bzr add' will version all files that
323
are currently unknown.
325
Adding a file whose parent directory is not versioned will
326
implicitly add the parent, and so on up to the root. This means
327
you should never need to explicitly add a directory, they'll just
328
get added when you add a file in the directory.
330
--dry-run will show which files would be added, but not actually
333
--file-ids-from will try to use the file ids from the supplied path.
334
It looks up ids trying to find a matching parent directory with the
335
same filename, and then by pure path. This option is rarely needed
336
but can be useful when adding the same logical file into two
337
branches that will be merged later (without showing the two different
338
adds as a conflict). It is also useful when merging another project
339
into a subdirectory of this one.
341
takes_args = ['file*']
344
help="Don't recursively add the contents of directories."),
346
help="Show what would be done, but don't actually do anything."),
348
Option('file-ids-from',
350
help='Lookup file ids from this tree.'),
352
encoding_type = 'replace'
353
_see_also = ['remove']
355
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
360
if file_ids_from is not None:
362
base_tree, base_path = WorkingTree.open_containing(
364
except errors.NoWorkingTree:
365
base_branch, base_path = Branch.open_containing(
367
base_tree = base_branch.basis_tree()
369
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
370
to_file=self.outf, should_print=(not is_quiet()))
372
action = bzrlib.add.AddAction(to_file=self.outf,
373
should_print=(not is_quiet()))
376
base_tree.lock_read()
378
file_list = self._maybe_expand_globs(file_list)
380
tree = WorkingTree.open_containing(file_list[0])[0]
382
tree = WorkingTree.open_containing(u'.')[0]
383
added, ignored = tree.smart_add(file_list, not
384
no_recurse, action=action, save=not dry_run)
386
if base_tree is not None:
390
for glob in sorted(ignored.keys()):
391
for path in ignored[glob]:
392
self.outf.write("ignored %s matching \"%s\"\n"
396
for glob, paths in ignored.items():
397
match_len += len(paths)
398
self.outf.write("ignored %d file(s).\n" % match_len)
399
self.outf.write("If you wish to add some of these files,"
400
" please add them by name.\n")
403
class cmd_mkdir(Command):
404
"""Create a new versioned directory.
406
This is equivalent to creating the directory and then adding it.
409
takes_args = ['dir+']
410
encoding_type = 'replace'
412
def run(self, dir_list):
415
wt, dd = WorkingTree.open_containing(d)
417
self.outf.write('added %s\n' % d)
420
class cmd_relpath(Command):
421
"""Show path of a file relative to root"""
423
takes_args = ['filename']
427
def run(self, filename):
428
# TODO: jam 20050106 Can relpath return a munged path if
429
# sys.stdout encoding cannot represent it?
430
tree, relpath = WorkingTree.open_containing(filename)
431
self.outf.write(relpath)
432
self.outf.write('\n')
435
class cmd_inventory(Command):
436
"""Show inventory of the current working copy or a revision.
438
It is possible to limit the output to a particular entry
439
type using the --kind option. For example: --kind file.
441
It is also possible to restrict the list of files to a specific
442
set. For example: bzr inventory --show-ids this/file
451
help='List entries of a particular kind: file, directory, symlink.',
454
takes_args = ['file*']
457
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
458
if kind and kind not in ['file', 'directory', 'symlink']:
459
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
461
work_tree, file_list = tree_files(file_list)
462
work_tree.lock_read()
464
if revision is not None:
465
if len(revision) > 1:
466
raise errors.BzrCommandError(
467
'bzr inventory --revision takes exactly one revision'
469
revision_id = revision[0].in_history(work_tree.branch).rev_id
470
tree = work_tree.branch.repository.revision_tree(revision_id)
472
extra_trees = [work_tree]
478
if file_list is not None:
479
file_ids = tree.paths2ids(file_list, trees=extra_trees,
480
require_versioned=True)
481
# find_ids_across_trees may include some paths that don't
483
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
484
for file_id in file_ids if file_id in tree)
486
entries = tree.inventory.entries()
489
if tree is not work_tree:
492
for path, entry in entries:
493
if kind and kind != entry.kind:
496
self.outf.write('%-50s %s\n' % (path, entry.file_id))
498
self.outf.write(path)
499
self.outf.write('\n')
502
class cmd_mv(Command):
503
"""Move or rename a file.
506
bzr mv OLDNAME NEWNAME
508
bzr mv SOURCE... DESTINATION
510
If the last argument is a versioned directory, all the other names
511
are moved into it. Otherwise, there must be exactly two arguments
512
and the file is changed to a new name.
514
If OLDNAME does not exist on the filesystem but is versioned and
515
NEWNAME does exist on the filesystem but is not versioned, mv
516
assumes that the file has been manually moved and only updates
517
its internal inventory to reflect that change.
518
The same is valid when moving many SOURCE files to a DESTINATION.
520
Files cannot be moved between branches.
523
takes_args = ['names*']
524
takes_options = [Option("after", help="Move only the bzr identifier"
525
" of the file, because the file has already been moved."),
527
aliases = ['move', 'rename']
528
encoding_type = 'replace'
530
def run(self, names_list, after=False):
531
if names_list is None:
534
if len(names_list) < 2:
535
raise errors.BzrCommandError("missing file argument")
536
tree, rel_names = tree_files(names_list)
538
if os.path.isdir(names_list[-1]):
539
# move into existing directory
540
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
541
self.outf.write("%s => %s\n" % pair)
543
if len(names_list) != 2:
544
raise errors.BzrCommandError('to mv multiple files the'
545
' destination must be a versioned'
547
tree.rename_one(rel_names[0], rel_names[1], after=after)
548
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
551
class cmd_pull(Command):
552
"""Turn this branch into a mirror of another branch.
554
This command only works on branches that have not diverged. Branches are
555
considered diverged if the destination branch's most recent commit is one
556
that has not been merged (directly or indirectly) into the parent.
558
If branches have diverged, you can use 'bzr merge' to integrate the changes
559
from one into the other. Once one branch has merged, the other should
560
be able to pull it again.
562
If you want to forget your local changes and just update your branch to
563
match the remote one, use pull --overwrite.
565
If there is no default location set, the first pull will set it. After
566
that, you can omit the location to use the default. To change the
567
default, use --remember. The value will only be saved if the remote
568
location can be accessed.
571
_see_also = ['push', 'update', 'status-flags']
572
takes_options = ['remember', 'overwrite', 'revision',
573
custom_help('verbose',
574
help='Show logs of pulled revisions.'),
576
help='Branch to pull into, '
577
'rather than the one containing the working directory.',
582
takes_args = ['location?']
583
encoding_type = 'replace'
585
def run(self, location=None, remember=False, overwrite=False,
586
revision=None, verbose=False,
588
# FIXME: too much stuff is in the command class
591
if directory is None:
594
tree_to = WorkingTree.open_containing(directory)[0]
595
branch_to = tree_to.branch
596
except errors.NoWorkingTree:
598
branch_to = Branch.open_containing(directory)[0]
600
possible_transports = []
601
if location is not None:
602
mergeable, location_transport = _get_mergeable_helper(location)
603
possible_transports.append(location_transport)
605
stored_loc = branch_to.get_parent()
607
if stored_loc is None:
608
raise errors.BzrCommandError("No pull location known or"
611
display_url = urlutils.unescape_for_display(stored_loc,
613
self.outf.write("Using saved location: %s\n" % display_url)
614
location = stored_loc
615
location_transport = transport.get_transport(
616
location, possible_transports=possible_transports)
618
if mergeable is not None:
619
if revision is not None:
620
raise errors.BzrCommandError(
621
'Cannot use -r with merge directives or bundles')
622
mergeable.install_revisions(branch_to.repository)
623
base_revision_id, revision_id, verified = \
624
mergeable.get_merge_request(branch_to.repository)
625
branch_from = branch_to
627
branch_from = Branch.open_from_transport(location_transport)
629
if branch_to.get_parent() is None or remember:
630
branch_to.set_parent(branch_from.base)
632
if revision is not None:
633
if len(revision) == 1:
634
revision_id = revision[0].in_history(branch_from).rev_id
636
raise errors.BzrCommandError(
637
'bzr pull --revision takes one value.')
640
old_rh = branch_to.revision_history()
641
if tree_to is not None:
642
change_reporter = delta._ChangeReporter(
643
unversioned_filter=tree_to.is_ignored)
644
result = tree_to.pull(branch_from, overwrite, revision_id,
646
possible_transports=possible_transports)
648
result = branch_to.pull(branch_from, overwrite, revision_id)
650
result.report(self.outf)
652
new_rh = branch_to.revision_history()
653
log.show_changed_revisions(branch_to, old_rh, new_rh,
657
class cmd_push(Command):
658
"""Update a mirror of this branch.
660
The target branch will not have its working tree populated because this
661
is both expensive, and is not supported on remote file systems.
663
Some smart servers or protocols *may* put the working tree in place in
666
This command only works on branches that have not diverged. Branches are
667
considered diverged if the destination branch's most recent commit is one
668
that has not been merged (directly or indirectly) by the source branch.
670
If branches have diverged, you can use 'bzr push --overwrite' to replace
671
the other branch completely, discarding its unmerged changes.
673
If you want to ensure you have the different changes in the other branch,
674
do a merge (see bzr help merge) from the other branch, and commit that.
675
After that you will be able to do a push without '--overwrite'.
677
If there is no default push location set, the first push will set it.
678
After that, you can omit the location to use the default. To change the
679
default, use --remember. The value will only be saved if the remote
680
location can be accessed.
683
_see_also = ['pull', 'update', 'working-trees']
684
takes_options = ['remember', 'overwrite', 'verbose',
685
Option('create-prefix',
686
help='Create the path leading up to the branch '
687
'if it does not already exist.'),
689
help='Branch to push from, '
690
'rather than the one containing the working directory.',
694
Option('use-existing-dir',
695
help='By default push will fail if the target'
696
' directory exists, but does not already'
697
' have a control directory. This flag will'
698
' allow push to proceed.'),
700
takes_args = ['location?']
701
encoding_type = 'replace'
703
def run(self, location=None, remember=False, overwrite=False,
704
create_prefix=False, verbose=False,
705
use_existing_dir=False,
707
# FIXME: Way too big! Put this into a function called from the
709
if directory is None:
711
br_from = Branch.open_containing(directory)[0]
712
stored_loc = br_from.get_push_location()
714
if stored_loc is None:
715
raise errors.BzrCommandError("No push location known or specified.")
717
display_url = urlutils.unescape_for_display(stored_loc,
719
self.outf.write("Using saved location: %s\n" % display_url)
720
location = stored_loc
722
to_transport = transport.get_transport(location)
724
br_to = repository_to = dir_to = None
726
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
727
except errors.NotBranchError:
728
pass # Didn't find anything
730
# If we can open a branch, use its direct repository, otherwise see
731
# if there is a repository without a branch.
733
br_to = dir_to.open_branch()
734
except errors.NotBranchError:
735
# Didn't find a branch, can we find a repository?
737
repository_to = dir_to.find_repository()
738
except errors.NoRepositoryPresent:
741
# Found a branch, so we must have found a repository
742
repository_to = br_to.repository
747
# The destination doesn't exist; create it.
748
# XXX: Refactor the create_prefix/no_create_prefix code into a
749
# common helper function
751
to_transport.mkdir('.')
752
except errors.FileExists:
753
if not use_existing_dir:
754
raise errors.BzrCommandError("Target directory %s"
755
" already exists, but does not have a valid .bzr"
756
" directory. Supply --use-existing-dir to push"
757
" there anyway." % location)
758
except errors.NoSuchFile:
759
if not create_prefix:
760
raise errors.BzrCommandError("Parent directory of %s"
762
"\nYou may supply --create-prefix to create all"
763
" leading parent directories."
765
_create_prefix(to_transport)
767
# Now the target directory exists, but doesn't have a .bzr
768
# directory. So we need to create it, along with any work to create
769
# all of the dependent branches, etc.
770
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
771
revision_id=br_from.last_revision())
772
br_to = dir_to.open_branch()
773
# TODO: Some more useful message about what was copied
774
note('Created new branch.')
775
# We successfully created the target, remember it
776
if br_from.get_push_location() is None or remember:
777
br_from.set_push_location(br_to.base)
778
elif repository_to is None:
779
# we have a bzrdir but no branch or repository
780
# XXX: Figure out what to do other than complain.
781
raise errors.BzrCommandError("At %s you have a valid .bzr control"
782
" directory, but not a branch or repository. This is an"
783
" unsupported configuration. Please move the target directory"
784
" out of the way and try again."
787
# We have a repository but no branch, copy the revisions, and then
789
last_revision_id = br_from.last_revision()
790
repository_to.fetch(br_from.repository,
791
revision_id=last_revision_id)
792
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
793
note('Created new branch.')
794
if br_from.get_push_location() is None or remember:
795
br_from.set_push_location(br_to.base)
796
else: # We have a valid to branch
797
# We were able to connect to the remote location, so remember it
798
# we don't need to successfully push because of possible divergence.
799
if br_from.get_push_location() is None or remember:
800
br_from.set_push_location(br_to.base)
802
old_rh = br_to.revision_history()
805
tree_to = dir_to.open_workingtree()
806
except errors.NotLocalUrl:
807
warning("This transport does not update the working "
808
"tree of: %s. See 'bzr help working-trees' for "
809
"more information." % br_to.base)
810
push_result = br_from.push(br_to, overwrite)
811
except errors.NoWorkingTree:
812
push_result = br_from.push(br_to, overwrite)
816
push_result = br_from.push(tree_to.branch, overwrite)
820
except errors.DivergedBranches:
821
raise errors.BzrCommandError('These branches have diverged.'
822
' Try using "merge" and then "push".')
823
if push_result is not None:
824
push_result.report(self.outf)
826
new_rh = br_to.revision_history()
829
from bzrlib.log import show_changed_revisions
830
show_changed_revisions(br_to, old_rh, new_rh,
833
# we probably did a clone rather than a push, so a message was
838
class cmd_branch(Command):
839
"""Create a new copy of a branch.
841
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
842
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
843
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
844
is derived from the FROM_LOCATION by stripping a leading scheme or drive
845
identifier, if any. For example, "branch lp:foo-bar" will attempt to
848
To retrieve the branch as of a particular revision, supply the --revision
849
parameter, as in "branch foo/bar -r 5".
852
_see_also = ['checkout']
853
takes_args = ['from_location', 'to_location?']
854
takes_options = ['revision']
855
aliases = ['get', 'clone']
857
def run(self, from_location, to_location=None, revision=None):
858
from bzrlib.tag import _merge_tags_if_possible
861
elif len(revision) > 1:
862
raise errors.BzrCommandError(
863
'bzr branch --revision takes exactly 1 revision value')
865
br_from = Branch.open(from_location)
868
if len(revision) == 1 and revision[0] is not None:
869
revision_id = revision[0].in_history(br_from)[1]
871
# FIXME - wt.last_revision, fallback to branch, fall back to
872
# None or perhaps NULL_REVISION to mean copy nothing
874
revision_id = br_from.last_revision()
875
if to_location is None:
876
to_location = urlutils.derive_to_location(from_location)
879
name = os.path.basename(to_location) + '\n'
881
to_transport = transport.get_transport(to_location)
883
to_transport.mkdir('.')
884
except errors.FileExists:
885
raise errors.BzrCommandError('Target directory "%s" already'
886
' exists.' % to_location)
887
except errors.NoSuchFile:
888
raise errors.BzrCommandError('Parent of "%s" does not exist.'
891
# preserve whatever source format we have.
892
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
893
possible_transports=[to_transport])
894
branch = dir.open_branch()
895
except errors.NoSuchRevision:
896
to_transport.delete_tree('.')
897
msg = "The branch %s has no revision %s." % (from_location, revision[0])
898
raise errors.BzrCommandError(msg)
900
branch.control_files.put_utf8('branch-name', name)
901
_merge_tags_if_possible(br_from, branch)
902
note('Branched %d revision(s).' % branch.revno())
907
class cmd_checkout(Command):
908
"""Create a new checkout of an existing branch.
910
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
911
the branch found in '.'. This is useful if you have removed the working tree
912
or if it was never created - i.e. if you pushed the branch to its current
915
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
916
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
917
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
918
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
919
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
922
To retrieve the branch as of a particular revision, supply the --revision
923
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
924
out of date [so you cannot commit] but it may be useful (i.e. to examine old
928
_see_also = ['checkouts', 'branch']
929
takes_args = ['branch_location?', 'to_location?']
930
takes_options = ['revision',
931
Option('lightweight',
932
help="Perform a lightweight checkout. Lightweight "
933
"checkouts depend on access to the branch for "
934
"every operation. Normal checkouts can perform "
935
"common operations like diff and status without "
936
"such access, and also support local commits."
941
def run(self, branch_location=None, to_location=None, revision=None,
945
elif len(revision) > 1:
946
raise errors.BzrCommandError(
947
'bzr checkout --revision takes exactly 1 revision value')
948
if branch_location is None:
949
branch_location = osutils.getcwd()
950
to_location = branch_location
951
source = Branch.open(branch_location)
952
if len(revision) == 1 and revision[0] is not None:
953
revision_id = _mod_revision.ensure_null(
954
revision[0].in_history(source)[1])
957
if to_location is None:
958
to_location = urlutils.derive_to_location(branch_location)
959
# if the source and to_location are the same,
960
# and there is no working tree,
961
# then reconstitute a branch
962
if (osutils.abspath(to_location) ==
963
osutils.abspath(branch_location)):
965
source.bzrdir.open_workingtree()
966
except errors.NoWorkingTree:
967
source.bzrdir.create_workingtree(revision_id)
969
source.create_checkout(to_location, revision_id, lightweight)
972
class cmd_renames(Command):
973
"""Show list of renamed files.
975
# TODO: Option to show renames between two historical versions.
977
# TODO: Only show renames under dir, rather than in the whole branch.
978
_see_also = ['status']
979
takes_args = ['dir?']
982
def run(self, dir=u'.'):
983
tree = WorkingTree.open_containing(dir)[0]
986
new_inv = tree.inventory
987
old_tree = tree.basis_tree()
990
old_inv = old_tree.inventory
991
renames = list(_mod_tree.find_renames(old_inv, new_inv))
993
for old_name, new_name in renames:
994
self.outf.write("%s => %s\n" % (old_name, new_name))
1001
class cmd_update(Command):
1002
"""Update a tree to have the latest code committed to its branch.
1004
This will perform a merge into the working tree, and may generate
1005
conflicts. If you have any local changes, you will still
1006
need to commit them after the update for the update to be complete.
1008
If you want to discard your local changes, you can just do a
1009
'bzr revert' instead of 'bzr commit' after the update.
1012
_see_also = ['pull', 'working-trees', 'status-flags']
1013
takes_args = ['dir?']
1016
def run(self, dir='.'):
1017
tree = WorkingTree.open_containing(dir)[0]
1018
possible_transports = []
1019
master = tree.branch.get_master_branch(
1020
possible_transports=possible_transports)
1021
if master is not None:
1024
tree.lock_tree_write()
1026
existing_pending_merges = tree.get_parent_ids()[1:]
1027
last_rev = _mod_revision.ensure_null(tree.last_revision())
1028
if last_rev == _mod_revision.ensure_null(
1029
tree.branch.last_revision()):
1030
# may be up to date, check master too.
1031
if master is None or last_rev == _mod_revision.ensure_null(
1032
master.last_revision()):
1033
revno = tree.branch.revision_id_to_revno(last_rev)
1034
note("Tree is up to date at revision %d." % (revno,))
1036
conflicts = tree.update(
1037
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1038
possible_transports=possible_transports)
1039
revno = tree.branch.revision_id_to_revno(
1040
_mod_revision.ensure_null(tree.last_revision()))
1041
note('Updated to revision %d.' % (revno,))
1042
if tree.get_parent_ids()[1:] != existing_pending_merges:
1043
note('Your local commits will now show as pending merges with '
1044
"'bzr status', and can be committed with 'bzr commit'.")
1053
class cmd_info(Command):
1054
"""Show information about a working tree, branch or repository.
1056
This command will show all known locations and formats associated to the
1057
tree, branch or repository. Statistical information is included with
1060
Branches and working trees will also report any missing revisions.
1062
_see_also = ['revno', 'working-trees', 'repositories']
1063
takes_args = ['location?']
1064
takes_options = ['verbose']
1067
def run(self, location=None, verbose=False):
1072
from bzrlib.info import show_bzrdir_info
1073
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1074
verbose=noise_level)
1077
class cmd_remove(Command):
1078
"""Remove files or directories.
1080
This makes bzr stop tracking changes to the specified files and
1081
delete them if they can easily be recovered using revert.
1083
You can specify one or more files, and/or --new. If you specify --new,
1084
only 'added' files will be removed. If you specify both, then new files
1085
in the specified directories will be removed. If the directories are
1086
also new, they will also be removed.
1088
takes_args = ['file*']
1089
takes_options = ['verbose',
1090
Option('new', help='Remove newly-added files.'),
1091
RegistryOption.from_kwargs('file-deletion-strategy',
1092
'The file deletion mode to be used.',
1093
title='Deletion Strategy', value_switches=True, enum_switch=False,
1094
safe='Only delete files if they can be'
1095
' safely recovered (default).',
1096
keep="Don't delete any files.",
1097
force='Delete all the specified files, even if they can not be '
1098
'recovered and even if they are non-empty directories.')]
1100
encoding_type = 'replace'
1102
def run(self, file_list, verbose=False, new=False,
1103
file_deletion_strategy='safe'):
1104
tree, file_list = tree_files(file_list)
1106
if file_list is not None:
1107
file_list = [f for f in file_list]
1109
raise errors.BzrCommandError('Specify one or more files to'
1110
' remove, or use --new.')
1113
added = tree.changes_from(tree.basis_tree(),
1114
specific_files=file_list).added
1115
file_list = sorted([f[0] for f in added], reverse=True)
1116
if len(file_list) == 0:
1117
raise errors.BzrCommandError('No matching files.')
1118
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1119
keep_files=file_deletion_strategy=='keep',
1120
force=file_deletion_strategy=='force')
1123
class cmd_file_id(Command):
1124
"""Print file_id of a particular file or directory.
1126
The file_id is assigned when the file is first added and remains the
1127
same through all revisions where the file exists, even when it is
1132
_see_also = ['inventory', 'ls']
1133
takes_args = ['filename']
1136
def run(self, filename):
1137
tree, relpath = WorkingTree.open_containing(filename)
1138
i = tree.path2id(relpath)
1140
raise errors.NotVersionedError(filename)
1142
self.outf.write(i + '\n')
1145
class cmd_file_path(Command):
1146
"""Print path of file_ids to a file or directory.
1148
This prints one line for each directory down to the target,
1149
starting at the branch root.
1153
takes_args = ['filename']
1156
def run(self, filename):
1157
tree, relpath = WorkingTree.open_containing(filename)
1158
fid = tree.path2id(relpath)
1160
raise errors.NotVersionedError(filename)
1161
segments = osutils.splitpath(relpath)
1162
for pos in range(1, len(segments) + 1):
1163
path = osutils.joinpath(segments[:pos])
1164
self.outf.write("%s\n" % tree.path2id(path))
1167
class cmd_reconcile(Command):
1168
"""Reconcile bzr metadata in a branch.
1170
This can correct data mismatches that may have been caused by
1171
previous ghost operations or bzr upgrades. You should only
1172
need to run this command if 'bzr check' or a bzr developer
1173
advises you to run it.
1175
If a second branch is provided, cross-branch reconciliation is
1176
also attempted, which will check that data like the tree root
1177
id which was not present in very early bzr versions is represented
1178
correctly in both branches.
1180
At the same time it is run it may recompress data resulting in
1181
a potential saving in disk space or performance gain.
1183
The branch *MUST* be on a listable system such as local disk or sftp.
1186
_see_also = ['check']
1187
takes_args = ['branch?']
1189
def run(self, branch="."):
1190
from bzrlib.reconcile import reconcile
1191
dir = bzrdir.BzrDir.open(branch)
1195
class cmd_revision_history(Command):
1196
"""Display the list of revision ids on a branch."""
1199
takes_args = ['location?']
1204
def run(self, location="."):
1205
branch = Branch.open_containing(location)[0]
1206
for revid in branch.revision_history():
1207
self.outf.write(revid)
1208
self.outf.write('\n')
1211
class cmd_ancestry(Command):
1212
"""List all revisions merged into this branch."""
1214
_see_also = ['log', 'revision-history']
1215
takes_args = ['location?']
1220
def run(self, location="."):
1222
wt = WorkingTree.open_containing(location)[0]
1223
except errors.NoWorkingTree:
1224
b = Branch.open(location)
1225
last_revision = b.last_revision()
1228
last_revision = wt.last_revision()
1230
revision_ids = b.repository.get_ancestry(last_revision)
1231
assert revision_ids[0] is None
1233
for revision_id in revision_ids:
1234
self.outf.write(revision_id + '\n')
1237
class cmd_init(Command):
1238
"""Make a directory into a versioned branch.
1240
Use this to create an empty branch, or before importing an
1243
If there is a repository in a parent directory of the location, then
1244
the history of the branch will be stored in the repository. Otherwise
1245
init creates a standalone branch which carries its own history
1246
in the .bzr directory.
1248
If there is already a branch at the location but it has no working tree,
1249
the tree can be populated with 'bzr checkout'.
1251
Recipe for importing a tree of files::
1257
bzr commit -m 'imported project'
1260
_see_also = ['init-repository', 'branch', 'checkout']
1261
takes_args = ['location?']
1263
Option('create-prefix',
1264
help='Create the path leading up to the branch '
1265
'if it does not already exist.'),
1266
RegistryOption('format',
1267
help='Specify a format for this branch. '
1268
'See "help formats".',
1269
registry=bzrdir.format_registry,
1270
converter=bzrdir.format_registry.make_bzrdir,
1271
value_switches=True,
1272
title="Branch Format",
1274
Option('append-revisions-only',
1275
help='Never change revnos or the existing log.'
1276
' Append revisions to it only.')
1278
def run(self, location=None, format=None, append_revisions_only=False,
1279
create_prefix=False):
1281
format = bzrdir.format_registry.make_bzrdir('default')
1282
if location is None:
1285
to_transport = transport.get_transport(location)
1287
# The path has to exist to initialize a
1288
# branch inside of it.
1289
# Just using os.mkdir, since I don't
1290
# believe that we want to create a bunch of
1291
# locations if the user supplies an extended path
1293
to_transport.ensure_base()
1294
except errors.NoSuchFile:
1295
if not create_prefix:
1296
raise errors.BzrCommandError("Parent directory of %s"
1298
"\nYou may supply --create-prefix to create all"
1299
" leading parent directories."
1301
_create_prefix(to_transport)
1304
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1305
except errors.NotBranchError:
1306
# really a NotBzrDir error...
1307
create_branch = bzrdir.BzrDir.create_branch_convenience
1308
branch = create_branch(to_transport.base, format=format,
1309
possible_transports=[to_transport])
1311
from bzrlib.transport.local import LocalTransport
1312
if existing_bzrdir.has_branch():
1313
if (isinstance(to_transport, LocalTransport)
1314
and not existing_bzrdir.has_workingtree()):
1315
raise errors.BranchExistsWithoutWorkingTree(location)
1316
raise errors.AlreadyBranchError(location)
1318
branch = existing_bzrdir.create_branch()
1319
existing_bzrdir.create_workingtree()
1320
if append_revisions_only:
1322
branch.set_append_revisions_only(True)
1323
except errors.UpgradeRequired:
1324
raise errors.BzrCommandError('This branch format cannot be set'
1325
' to append-revisions-only. Try --experimental-branch6')
1328
class cmd_init_repository(Command):
1329
"""Create a shared repository to hold branches.
1331
New branches created under the repository directory will store their
1332
revisions in the repository, not in the branch directory.
1334
If the --no-trees option is used then the branches in the repository
1335
will not have working trees by default.
1338
Create a shared repositories holding just branches::
1340
bzr init-repo --no-trees repo
1343
Make a lightweight checkout elsewhere::
1345
bzr checkout --lightweight repo/trunk trunk-checkout
1350
_see_also = ['init', 'branch', 'checkout', 'repositories']
1351
takes_args = ["location"]
1352
takes_options = [RegistryOption('format',
1353
help='Specify a format for this repository. See'
1354
' "bzr help formats" for details.',
1355
registry=bzrdir.format_registry,
1356
converter=bzrdir.format_registry.make_bzrdir,
1357
value_switches=True, title='Repository format'),
1359
help='Branches in the repository will default to'
1360
' not having a working tree.'),
1362
aliases = ["init-repo"]
1364
def run(self, location, format=None, no_trees=False):
1366
format = bzrdir.format_registry.make_bzrdir('default')
1368
if location is None:
1371
to_transport = transport.get_transport(location)
1372
to_transport.ensure_base()
1374
newdir = format.initialize_on_transport(to_transport)
1375
repo = newdir.create_repository(shared=True)
1376
repo.set_make_working_trees(not no_trees)
1379
class cmd_diff(Command):
1380
"""Show differences in the working tree or between revisions.
1382
If files are listed, only the changes in those files are listed.
1383
Otherwise, all changes for the tree are listed.
1385
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1386
produces patches suitable for "patch -p1".
1389
Shows the difference in the working tree versus the last commit::
1393
Difference between the working tree and revision 1::
1397
Difference between revision 2 and revision 1::
1401
Same as 'bzr diff' but prefix paths with old/ and new/::
1403
bzr diff --prefix old/:new/
1405
Show the differences between the two working trees::
1407
bzr diff bzr.mine bzr.dev
1409
Show just the differences for 'foo.c'::
1413
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1414
# or a graphical diff.
1416
# TODO: Python difflib is not exactly the same as unidiff; should
1417
# either fix it up or prefer to use an external diff.
1419
# TODO: Selected-file diff is inefficient and doesn't show you
1422
# TODO: This probably handles non-Unix newlines poorly.
1424
_see_also = ['status']
1425
takes_args = ['file*']
1427
Option('diff-options', type=str,
1428
help='Pass these options to the external diff program.'),
1429
Option('prefix', type=str,
1431
help='Set prefixes added to old and new filenames, as '
1432
'two values separated by a colon. (eg "old/:new/").'),
1436
aliases = ['di', 'dif']
1437
encoding_type = 'exact'
1440
def run(self, revision=None, file_list=None, diff_options=None,
1442
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1444
if (prefix is None) or (prefix == '0'):
1452
old_label, new_label = prefix.split(":")
1454
raise errors.BzrCommandError(
1455
'--prefix expects two values separated by a colon'
1456
' (eg "old/:new/")')
1458
if revision and len(revision) > 2:
1459
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1460
' one or two revision specifiers')
1463
tree1, file_list = internal_tree_files(file_list)
1467
except errors.FileInWrongBranch:
1468
if len(file_list) != 2:
1469
raise errors.BzrCommandError("Files are in different branches")
1471
tree1, file1 = WorkingTree.open_containing(file_list[0])
1472
tree2, file2 = WorkingTree.open_containing(file_list[1])
1473
if file1 != "" or file2 != "":
1474
# FIXME diff those two files. rbc 20051123
1475
raise errors.BzrCommandError("Files are in different branches")
1477
except errors.NotBranchError:
1478
if (revision is not None and len(revision) == 2
1479
and not revision[0].needs_branch()
1480
and not revision[1].needs_branch()):
1481
# If both revision specs include a branch, we can
1482
# diff them without needing a local working tree
1483
tree1, tree2 = None, None
1487
if tree2 is not None:
1488
if revision is not None:
1489
# FIXME: but there should be a clean way to diff between
1490
# non-default versions of two trees, it's not hard to do
1492
raise errors.BzrCommandError(
1493
"Sorry, diffing arbitrary revisions across branches "
1494
"is not implemented yet")
1495
return show_diff_trees(tree1, tree2, sys.stdout,
1496
specific_files=file_list,
1497
external_diff_options=diff_options,
1498
old_label=old_label, new_label=new_label)
1500
return diff_cmd_helper(tree1, file_list, diff_options,
1501
revision_specs=revision,
1502
old_label=old_label, new_label=new_label)
1505
class cmd_deleted(Command):
1506
"""List files deleted in the working tree.
1508
# TODO: Show files deleted since a previous revision, or
1509
# between two revisions.
1510
# TODO: Much more efficient way to do this: read in new
1511
# directories with readdir, rather than stating each one. Same
1512
# level of effort but possibly much less IO. (Or possibly not,
1513
# if the directories are very large...)
1514
_see_also = ['status', 'ls']
1515
takes_options = ['show-ids']
1518
def run(self, show_ids=False):
1519
tree = WorkingTree.open_containing(u'.')[0]
1522
old = tree.basis_tree()
1525
for path, ie in old.inventory.iter_entries():
1526
if not tree.has_id(ie.file_id):
1527
self.outf.write(path)
1529
self.outf.write(' ')
1530
self.outf.write(ie.file_id)
1531
self.outf.write('\n')
1538
class cmd_modified(Command):
1539
"""List files modified in working tree.
1543
_see_also = ['status', 'ls']
1547
tree = WorkingTree.open_containing(u'.')[0]
1548
td = tree.changes_from(tree.basis_tree())
1549
for path, id, kind, text_modified, meta_modified in td.modified:
1550
self.outf.write(path + '\n')
1553
class cmd_added(Command):
1554
"""List files added in working tree.
1558
_see_also = ['status', 'ls']
1562
wt = WorkingTree.open_containing(u'.')[0]
1565
basis = wt.basis_tree()
1568
basis_inv = basis.inventory
1571
if file_id in basis_inv:
1573
if inv.is_root(file_id) and len(basis_inv) == 0:
1575
path = inv.id2path(file_id)
1576
if not os.access(osutils.abspath(path), os.F_OK):
1578
self.outf.write(path + '\n')
1585
class cmd_root(Command):
1586
"""Show the tree root directory.
1588
The root is the nearest enclosing directory with a .bzr control
1591
takes_args = ['filename?']
1593
def run(self, filename=None):
1594
"""Print the branch root."""
1595
tree = WorkingTree.open_containing(filename)[0]
1596
self.outf.write(tree.basedir + '\n')
1599
def _parse_limit(limitstring):
1601
return int(limitstring)
1603
msg = "The limit argument must be an integer."
1604
raise errors.BzrCommandError(msg)
1607
class cmd_log(Command):
1608
"""Show log of a branch, file, or directory.
1610
By default show the log of the branch containing the working directory.
1612
To request a range of logs, you can use the command -r begin..end
1613
-r revision requests a specific revision, -r ..end or -r begin.. are
1617
Log the current branch::
1625
Log the last 10 revisions of a branch::
1627
bzr log -r -10.. http://server/branch
1630
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1632
takes_args = ['location?']
1635
help='Show from oldest to newest.'),
1638
help='Display timezone as local, original, or utc.'),
1639
custom_help('verbose',
1640
help='Show files changed in each revision.'),
1646
help='Show revisions whose message matches this '
1647
'regular expression.',
1650
help='Limit the output to the first N revisions.',
1654
encoding_type = 'replace'
1657
def run(self, location=None, timezone='original',
1665
from bzrlib.log import show_log
1666
assert message is None or isinstance(message, basestring), \
1667
"invalid message argument %r" % message
1668
direction = (forward and 'forward') or 'reverse'
1673
# find the file id to log:
1675
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1679
tree = b.basis_tree()
1680
file_id = tree.path2id(fp)
1682
raise errors.BzrCommandError(
1683
"Path does not have any revision history: %s" %
1687
# FIXME ? log the current subdir only RBC 20060203
1688
if revision is not None \
1689
and len(revision) > 0 and revision[0].get_branch():
1690
location = revision[0].get_branch()
1693
dir, relpath = bzrdir.BzrDir.open_containing(location)
1694
b = dir.open_branch()
1698
if revision is None:
1701
elif len(revision) == 1:
1702
rev1 = rev2 = revision[0].in_history(b)
1703
elif len(revision) == 2:
1704
if revision[1].get_branch() != revision[0].get_branch():
1705
# b is taken from revision[0].get_branch(), and
1706
# show_log will use its revision_history. Having
1707
# different branches will lead to weird behaviors.
1708
raise errors.BzrCommandError(
1709
"Log doesn't accept two revisions in different"
1711
rev1 = revision[0].in_history(b)
1712
rev2 = revision[1].in_history(b)
1714
raise errors.BzrCommandError(
1715
'bzr log --revision takes one or two values.')
1717
if log_format is None:
1718
log_format = log.log_formatter_registry.get_default(b)
1720
lf = log_format(show_ids=show_ids, to_file=self.outf,
1721
show_timezone=timezone)
1727
direction=direction,
1728
start_revision=rev1,
1736
def get_log_format(long=False, short=False, line=False, default='long'):
1737
log_format = default
1741
log_format = 'short'
1747
class cmd_touching_revisions(Command):
1748
"""Return revision-ids which affected a particular file.
1750
A more user-friendly interface is "bzr log FILE".
1754
takes_args = ["filename"]
1757
def run(self, filename):
1758
tree, relpath = WorkingTree.open_containing(filename)
1760
file_id = tree.path2id(relpath)
1761
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1762
self.outf.write("%6d %s\n" % (revno, what))
1765
class cmd_ls(Command):
1766
"""List files in a tree.
1769
_see_also = ['status', 'cat']
1770
takes_args = ['path?']
1771
# TODO: Take a revision or remote path and list that tree instead.
1775
Option('non-recursive',
1776
help='Don\'t recurse into subdirectories.'),
1778
help='Print paths relative to the root of the branch.'),
1779
Option('unknown', help='Print unknown files.'),
1780
Option('versioned', help='Print versioned files.'),
1781
Option('ignored', help='Print ignored files.'),
1783
help='Write an ascii NUL (\\0) separator '
1784
'between files rather than a newline.'),
1786
help='List entries of a particular kind: file, directory, symlink.',
1791
def run(self, revision=None, verbose=False,
1792
non_recursive=False, from_root=False,
1793
unknown=False, versioned=False, ignored=False,
1794
null=False, kind=None, show_ids=False, path=None):
1796
if kind and kind not in ('file', 'directory', 'symlink'):
1797
raise errors.BzrCommandError('invalid kind specified')
1799
if verbose and null:
1800
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1801
all = not (unknown or versioned or ignored)
1803
selection = {'I':ignored, '?':unknown, 'V':versioned}
1810
raise errors.BzrCommandError('cannot specify both --from-root'
1814
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1820
if revision is not None:
1821
tree = branch.repository.revision_tree(
1822
revision[0].in_history(branch).rev_id)
1824
tree = branch.basis_tree()
1828
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1829
if fp.startswith(relpath):
1830
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1831
if non_recursive and '/' in fp:
1833
if not all and not selection[fc]:
1835
if kind is not None and fkind != kind:
1838
kindch = entry.kind_character()
1839
outstring = '%-8s %s%s' % (fc, fp, kindch)
1840
if show_ids and fid is not None:
1841
outstring = "%-50s %s" % (outstring, fid)
1842
self.outf.write(outstring + '\n')
1844
self.outf.write(fp + '\0')
1847
self.outf.write(fid)
1848
self.outf.write('\0')
1856
self.outf.write('%-50s %s\n' % (fp, my_id))
1858
self.outf.write(fp + '\n')
1863
class cmd_unknowns(Command):
1864
"""List unknown files.
1872
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1873
self.outf.write(osutils.quotefn(f) + '\n')
1876
class cmd_ignore(Command):
1877
"""Ignore specified files or patterns.
1879
To remove patterns from the ignore list, edit the .bzrignore file.
1881
Trailing slashes on patterns are ignored.
1882
If the pattern contains a slash or is a regular expression, it is compared
1883
to the whole path from the branch root. Otherwise, it is compared to only
1884
the last component of the path. To match a file only in the root
1885
directory, prepend './'.
1887
Ignore patterns specifying absolute paths are not allowed.
1889
Ignore patterns may include globbing wildcards such as::
1891
? - Matches any single character except '/'
1892
* - Matches 0 or more characters except '/'
1893
/**/ - Matches 0 or more directories in a path
1894
[a-z] - Matches a single character from within a group of characters
1896
Ignore patterns may also be Python regular expressions.
1897
Regular expression ignore patterns are identified by a 'RE:' prefix
1898
followed by the regular expression. Regular expression ignore patterns
1899
may not include named or numbered groups.
1901
Note: ignore patterns containing shell wildcards must be quoted from
1905
Ignore the top level Makefile::
1907
bzr ignore ./Makefile
1909
Ignore class files in all directories::
1911
bzr ignore '*.class'
1913
Ignore .o files under the lib directory::
1915
bzr ignore 'lib/**/*.o'
1917
Ignore .o files under the lib directory::
1919
bzr ignore 'RE:lib/.*\.o'
1922
_see_also = ['status', 'ignored']
1923
takes_args = ['name_pattern*']
1925
Option('old-default-rules',
1926
help='Write out the ignore rules bzr < 0.9 always used.')
1929
def run(self, name_pattern_list=None, old_default_rules=None):
1930
from bzrlib.atomicfile import AtomicFile
1931
if old_default_rules is not None:
1932
# dump the rules and exit
1933
for pattern in ignores.OLD_DEFAULTS:
1936
if not name_pattern_list:
1937
raise errors.BzrCommandError("ignore requires at least one "
1938
"NAME_PATTERN or --old-default-rules")
1939
name_pattern_list = [globbing.normalize_pattern(p)
1940
for p in name_pattern_list]
1941
for name_pattern in name_pattern_list:
1942
if (name_pattern[0] == '/' or
1943
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1944
raise errors.BzrCommandError(
1945
"NAME_PATTERN should not be an absolute path")
1946
tree, relpath = WorkingTree.open_containing(u'.')
1947
ifn = tree.abspath('.bzrignore')
1948
if os.path.exists(ifn):
1951
igns = f.read().decode('utf-8')
1957
# TODO: If the file already uses crlf-style termination, maybe
1958
# we should use that for the newly added lines?
1960
if igns and igns[-1] != '\n':
1962
for name_pattern in name_pattern_list:
1963
igns += name_pattern + '\n'
1965
f = AtomicFile(ifn, 'wb')
1967
f.write(igns.encode('utf-8'))
1972
if not tree.path2id('.bzrignore'):
1973
tree.add(['.bzrignore'])
1975
ignored = globbing.Globster(name_pattern_list)
1978
for entry in tree.list_files():
1982
if ignored.match(filename):
1983
matches.append(filename.encode('utf-8'))
1985
if len(matches) > 0:
1986
print "Warning: the following files are version controlled and" \
1987
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1989
class cmd_ignored(Command):
1990
"""List ignored files and the patterns that matched them.
1993
_see_also = ['ignore']
1996
tree = WorkingTree.open_containing(u'.')[0]
1999
for path, file_class, kind, file_id, entry in tree.list_files():
2000
if file_class != 'I':
2002
## XXX: Slightly inefficient since this was already calculated
2003
pat = tree.is_ignored(path)
2004
print '%-50s %s' % (path, pat)
2009
class cmd_lookup_revision(Command):
2010
"""Lookup the revision-id from a revision-number
2013
bzr lookup-revision 33
2016
takes_args = ['revno']
2019
def run(self, revno):
2023
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2025
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2028
class cmd_export(Command):
2029
"""Export current or past revision to a destination directory or archive.
2031
If no revision is specified this exports the last committed revision.
2033
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2034
given, try to find the format with the extension. If no extension
2035
is found exports to a directory (equivalent to --format=dir).
2037
If root is supplied, it will be used as the root directory inside
2038
container formats (tar, zip, etc). If it is not supplied it will default
2039
to the exported filename. The root option has no effect for 'dir' format.
2041
If branch is omitted then the branch containing the current working
2042
directory will be used.
2044
Note: Export of tree with non-ASCII filenames to zip is not supported.
2046
================= =========================
2047
Supported formats Autodetected by extension
2048
================= =========================
2051
tbz2 .tar.bz2, .tbz2
2054
================= =========================
2056
takes_args = ['dest', 'branch?']
2059
help="Type of file to export to.",
2064
help="Name of the root directory inside the exported file."),
2066
def run(self, dest, branch=None, revision=None, format=None, root=None):
2067
from bzrlib.export import export
2070
tree = WorkingTree.open_containing(u'.')[0]
2073
b = Branch.open(branch)
2075
if revision is None:
2076
# should be tree.last_revision FIXME
2077
rev_id = b.last_revision()
2079
if len(revision) != 1:
2080
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2081
rev_id = revision[0].in_history(b).rev_id
2082
t = b.repository.revision_tree(rev_id)
2084
export(t, dest, format, root)
2085
except errors.NoSuchExportFormat, e:
2086
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2089
class cmd_cat(Command):
2090
"""Write the contents of a file as of a given revision to standard output.
2092
If no revision is nominated, the last revision is used.
2094
Note: Take care to redirect standard output when using this command on a
2100
Option('name-from-revision', help='The path name in the old tree.'),
2103
takes_args = ['filename']
2104
encoding_type = 'exact'
2107
def run(self, filename, revision=None, name_from_revision=False):
2108
if revision is not None and len(revision) != 1:
2109
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2114
tree, b, relpath = \
2115
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2116
except errors.NotBranchError:
2119
if revision is not None and revision[0].get_branch() is not None:
2120
b = Branch.open(revision[0].get_branch())
2122
tree = b.basis_tree()
2123
if revision is None:
2124
revision_id = b.last_revision()
2126
revision_id = revision[0].in_history(b).rev_id
2128
cur_file_id = tree.path2id(relpath)
2129
rev_tree = b.repository.revision_tree(revision_id)
2130
old_file_id = rev_tree.path2id(relpath)
2132
if name_from_revision:
2133
if old_file_id is None:
2134
raise errors.BzrCommandError("%r is not present in revision %s"
2135
% (filename, revision_id))
2137
rev_tree.print_file(old_file_id)
2138
elif cur_file_id is not None:
2139
rev_tree.print_file(cur_file_id)
2140
elif old_file_id is not None:
2141
rev_tree.print_file(old_file_id)
2143
raise errors.BzrCommandError("%r is not present in revision %s" %
2144
(filename, revision_id))
2147
class cmd_local_time_offset(Command):
2148
"""Show the offset in seconds from GMT to local time."""
2152
print osutils.local_time_offset()
2156
class cmd_commit(Command):
2157
"""Commit changes into a new revision.
2159
If no arguments are given, the entire tree is committed.
2161
If selected files are specified, only changes to those files are
2162
committed. If a directory is specified then the directory and everything
2163
within it is committed.
2165
If author of the change is not the same person as the committer, you can
2166
specify the author's name using the --author option. The name should be
2167
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2169
A selected-file commit may fail in some cases where the committed
2170
tree would be invalid. Consider::
2175
bzr commit foo -m "committing foo"
2176
bzr mv foo/bar foo/baz
2179
bzr commit foo/bar -m "committing bar but not baz"
2181
In the example above, the last commit will fail by design. This gives
2182
the user the opportunity to decide whether they want to commit the
2183
rename at the same time, separately first, or not at all. (As a general
2184
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2186
Note: A selected-file commit after a merge is not yet supported.
2188
# TODO: Run hooks on tree to-be-committed, and after commit.
2190
# TODO: Strict commit that fails if there are deleted files.
2191
# (what does "deleted files" mean ??)
2193
# TODO: Give better message for -s, --summary, used by tla people
2195
# XXX: verbose currently does nothing
2197
_see_also = ['bugs', 'uncommit']
2198
takes_args = ['selected*']
2200
Option('message', type=unicode,
2202
help="Description of the new revision."),
2205
help='Commit even if nothing has changed.'),
2206
Option('file', type=str,
2209
help='Take commit message from this file.'),
2211
help="Refuse to commit if there are unknown "
2212
"files in the working tree."),
2213
ListOption('fixes', type=str,
2214
help="Mark a bug as being fixed by this revision."),
2215
Option('author', type=str,
2216
help="Set the author's name, if it's different "
2217
"from the committer."),
2219
help="Perform a local commit in a bound "
2220
"branch. Local commits are not pushed to "
2221
"the master branch until a normal commit "
2225
help='When no message is supplied, show the diff along'
2226
' with the status summary in the message editor.'),
2228
aliases = ['ci', 'checkin']
2230
def _get_bug_fix_properties(self, fixes, branch):
2232
# Configure the properties for bug fixing attributes.
2233
for fixed_bug in fixes:
2234
tokens = fixed_bug.split(':')
2235
if len(tokens) != 2:
2236
raise errors.BzrCommandError(
2237
"Invalid bug %s. Must be in the form of 'tag:id'. "
2238
"Commit refused." % fixed_bug)
2239
tag, bug_id = tokens
2241
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2242
except errors.UnknownBugTrackerAbbreviation:
2243
raise errors.BzrCommandError(
2244
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2245
except errors.MalformedBugIdentifier:
2246
raise errors.BzrCommandError(
2247
"Invalid bug identifier for %s. Commit refused."
2249
properties.append('%s fixed' % bug_url)
2250
return '\n'.join(properties)
2252
def run(self, message=None, file=None, verbose=False, selected_list=None,
2253
unchanged=False, strict=False, local=False, fixes=None,
2254
author=None, show_diff=False):
2255
from bzrlib.errors import (
2260
from bzrlib.msgeditor import (
2261
edit_commit_message_encoded,
2262
make_commit_message_template_encoded
2265
# TODO: Need a blackbox test for invoking the external editor; may be
2266
# slightly problematic to run this cross-platform.
2268
# TODO: do more checks that the commit will succeed before
2269
# spending the user's valuable time typing a commit message.
2273
tree, selected_list = tree_files(selected_list)
2274
if selected_list == ['']:
2275
# workaround - commit of root of tree should be exactly the same
2276
# as just default commit in that tree, and succeed even though
2277
# selected-file merge commit is not done yet
2282
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2284
properties['bugs'] = bug_property
2286
if local and not tree.branch.get_bound_location():
2287
raise errors.LocalRequiresBoundBranch()
2289
def get_message(commit_obj):
2290
"""Callback to get commit message"""
2291
my_message = message
2292
if my_message is None and not file:
2293
t = make_commit_message_template_encoded(tree,
2294
selected_list, diff=show_diff,
2295
output_encoding=bzrlib.user_encoding)
2296
my_message = edit_commit_message_encoded(t)
2297
if my_message is None:
2298
raise errors.BzrCommandError("please specify a commit"
2299
" message with either --message or --file")
2300
elif my_message and file:
2301
raise errors.BzrCommandError(
2302
"please specify either --message or --file")
2304
my_message = codecs.open(file, 'rt',
2305
bzrlib.user_encoding).read()
2306
if my_message == "":
2307
raise errors.BzrCommandError("empty commit message specified")
2311
tree.commit(message_callback=get_message,
2312
specific_files=selected_list,
2313
allow_pointless=unchanged, strict=strict, local=local,
2314
reporter=None, verbose=verbose, revprops=properties,
2316
except PointlessCommit:
2317
# FIXME: This should really happen before the file is read in;
2318
# perhaps prepare the commit; get the message; then actually commit
2319
raise errors.BzrCommandError("no changes to commit."
2320
" use --unchanged to commit anyhow")
2321
except ConflictsInTree:
2322
raise errors.BzrCommandError('Conflicts detected in working '
2323
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2325
except StrictCommitFailed:
2326
raise errors.BzrCommandError("Commit refused because there are"
2327
" unknown files in the working tree.")
2328
except errors.BoundBranchOutOfDate, e:
2329
raise errors.BzrCommandError(str(e) + "\n"
2330
'To commit to master branch, run update and then commit.\n'
2331
'You can also pass --local to commit to continue working '
2335
class cmd_check(Command):
2336
"""Validate consistency of branch history.
2338
This command checks various invariants about the branch storage to
2339
detect data corruption or bzr bugs.
2343
revisions: This is just the number of revisions checked. It doesn't
2345
versionedfiles: This is just the number of versionedfiles checked. It
2346
doesn't indicate a problem.
2347
unreferenced ancestors: Texts that are ancestors of other texts, but
2348
are not properly referenced by the revision ancestry. This is a
2349
subtle problem that Bazaar can work around.
2350
unique file texts: This is the total number of unique file contents
2351
seen in the checked revisions. It does not indicate a problem.
2352
repeated file texts: This is the total number of repeated texts seen
2353
in the checked revisions. Texts can be repeated when their file
2354
entries are modified, but the file contents are not. It does not
2358
_see_also = ['reconcile']
2359
takes_args = ['branch?']
2360
takes_options = ['verbose']
2362
def run(self, branch=None, verbose=False):
2363
from bzrlib.check import check
2365
branch = Branch.open_containing('.')[0]
2367
branch = Branch.open(branch)
2368
check(branch, verbose)
2371
class cmd_upgrade(Command):
2372
"""Upgrade branch storage to current format.
2374
The check command or bzr developers may sometimes advise you to run
2375
this command. When the default format has changed you may also be warned
2376
during other operations to upgrade.
2379
_see_also = ['check']
2380
takes_args = ['url?']
2382
RegistryOption('format',
2383
help='Upgrade to a specific format. See "bzr help'
2384
' formats" for details.',
2385
registry=bzrdir.format_registry,
2386
converter=bzrdir.format_registry.make_bzrdir,
2387
value_switches=True, title='Branch format'),
2390
def run(self, url='.', format=None):
2391
from bzrlib.upgrade import upgrade
2393
format = bzrdir.format_registry.make_bzrdir('default')
2394
upgrade(url, format)
2397
class cmd_whoami(Command):
2398
"""Show or set bzr user id.
2401
Show the email of the current user::
2405
Set the current user::
2407
bzr whoami 'Frank Chu <fchu@example.com>'
2409
takes_options = [ Option('email',
2410
help='Display email address only.'),
2412
help='Set identity for the current branch instead of '
2415
takes_args = ['name?']
2416
encoding_type = 'replace'
2419
def run(self, email=False, branch=False, name=None):
2421
# use branch if we're inside one; otherwise global config
2423
c = Branch.open_containing('.')[0].get_config()
2424
except errors.NotBranchError:
2425
c = config.GlobalConfig()
2427
self.outf.write(c.user_email() + '\n')
2429
self.outf.write(c.username() + '\n')
2432
# display a warning if an email address isn't included in the given name.
2434
config.extract_email_address(name)
2435
except errors.NoEmailInUsername, e:
2436
warning('"%s" does not seem to contain an email address. '
2437
'This is allowed, but not recommended.', name)
2439
# use global config unless --branch given
2441
c = Branch.open_containing('.')[0].get_config()
2443
c = config.GlobalConfig()
2444
c.set_user_option('email', name)
2447
class cmd_nick(Command):
2448
"""Print or set the branch nickname.
2450
If unset, the tree root directory name is used as the nickname
2451
To print the current nickname, execute with no argument.
2454
_see_also = ['info']
2455
takes_args = ['nickname?']
2456
def run(self, nickname=None):
2457
branch = Branch.open_containing(u'.')[0]
2458
if nickname is None:
2459
self.printme(branch)
2461
branch.nick = nickname
2464
def printme(self, branch):
2468
class cmd_selftest(Command):
2469
"""Run internal test suite.
2471
If arguments are given, they are regular expressions that say which tests
2472
should run. Tests matching any expression are run, and other tests are
2475
Alternatively if --first is given, matching tests are run first and then
2476
all other tests are run. This is useful if you have been working in a
2477
particular area, but want to make sure nothing else was broken.
2479
If --exclude is given, tests that match that regular expression are
2480
excluded, regardless of whether they match --first or not.
2482
To help catch accidential dependencies between tests, the --randomize
2483
option is useful. In most cases, the argument used is the word 'now'.
2484
Note that the seed used for the random number generator is displayed
2485
when this option is used. The seed can be explicitly passed as the
2486
argument to this option if required. This enables reproduction of the
2487
actual ordering used if and when an order sensitive problem is encountered.
2489
If --list-only is given, the tests that would be run are listed. This is
2490
useful when combined with --first, --exclude and/or --randomize to
2491
understand their impact. The test harness reports "Listed nn tests in ..."
2492
instead of "Ran nn tests in ..." when list mode is enabled.
2494
If the global option '--no-plugins' is given, plugins are not loaded
2495
before running the selftests. This has two effects: features provided or
2496
modified by plugins will not be tested, and tests provided by plugins will
2499
Tests that need working space on disk use a common temporary directory,
2500
typically inside $TMPDIR or /tmp.
2503
Run only tests relating to 'ignore'::
2507
Disable plugins and list tests as they're run::
2509
bzr --no-plugins selftest -v
2511
# NB: this is used from the class without creating an instance, which is
2512
# why it does not have a self parameter.
2513
def get_transport_type(typestring):
2514
"""Parse and return a transport specifier."""
2515
if typestring == "sftp":
2516
from bzrlib.transport.sftp import SFTPAbsoluteServer
2517
return SFTPAbsoluteServer
2518
if typestring == "memory":
2519
from bzrlib.transport.memory import MemoryServer
2521
if typestring == "fakenfs":
2522
from bzrlib.transport.fakenfs import FakeNFSServer
2523
return FakeNFSServer
2524
msg = "No known transport type %s. Supported types are: sftp\n" %\
2526
raise errors.BzrCommandError(msg)
2529
takes_args = ['testspecs*']
2530
takes_options = ['verbose',
2532
help='Stop when one test fails.',
2536
help='Use a different transport by default '
2537
'throughout the test suite.',
2538
type=get_transport_type),
2540
help='Run the benchmarks rather than selftests.'),
2541
Option('lsprof-timed',
2542
help='Generate lsprof output for benchmarked'
2543
' sections of code.'),
2544
Option('cache-dir', type=str,
2545
help='Cache intermediate benchmark output in this '
2548
help='Run all tests, but run specified tests first.',
2552
help='List the tests instead of running them.'),
2553
Option('randomize', type=str, argname="SEED",
2554
help='Randomize the order of tests using the given'
2555
' seed or "now" for the current time.'),
2556
Option('exclude', type=str, argname="PATTERN",
2558
help='Exclude tests that match this regular'
2560
Option('strict', help='Fail on missing dependencies or '
2563
encoding_type = 'replace'
2565
def run(self, testspecs_list=None, verbose=False, one=False,
2566
transport=None, benchmark=None,
2567
lsprof_timed=None, cache_dir=None,
2568
first=False, list_only=False,
2569
randomize=None, exclude=None, strict=False):
2571
from bzrlib.tests import selftest
2572
import bzrlib.benchmarks as benchmarks
2573
from bzrlib.benchmarks import tree_creator
2575
if cache_dir is not None:
2576
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2578
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2579
print ' %s (%s python%s)' % (
2581
bzrlib.version_string,
2582
'.'.join(map(str, sys.version_info)),
2585
if testspecs_list is not None:
2586
pattern = '|'.join(testspecs_list)
2590
test_suite_factory = benchmarks.test_suite
2591
# Unless user explicitly asks for quiet, be verbose in benchmarks
2592
verbose = not is_quiet()
2593
# TODO: should possibly lock the history file...
2594
benchfile = open(".perf_history", "at", buffering=1)
2596
test_suite_factory = None
2599
result = selftest(verbose=verbose,
2601
stop_on_failure=one,
2602
transport=transport,
2603
test_suite_factory=test_suite_factory,
2604
lsprof_timed=lsprof_timed,
2605
bench_history=benchfile,
2606
matching_tests_first=first,
2607
list_only=list_only,
2608
random_seed=randomize,
2609
exclude_pattern=exclude,
2613
if benchfile is not None:
2616
info('tests passed')
2618
info('tests failed')
2619
return int(not result)
2622
class cmd_version(Command):
2623
"""Show version of bzr."""
2625
encoding_type = 'replace'
2629
from bzrlib.version import show_version
2630
show_version(to_file=self.outf)
2633
class cmd_rocks(Command):
2634
"""Statement of optimism."""
2640
print "It sure does!"
2643
class cmd_find_merge_base(Command):
2644
"""Find and print a base revision for merging two branches."""
2645
# TODO: Options to specify revisions on either side, as if
2646
# merging only part of the history.
2647
takes_args = ['branch', 'other']
2651
def run(self, branch, other):
2652
from bzrlib.revision import ensure_null
2654
branch1 = Branch.open_containing(branch)[0]
2655
branch2 = Branch.open_containing(other)[0]
2657
last1 = ensure_null(branch1.last_revision())
2658
last2 = ensure_null(branch2.last_revision())
2660
graph = branch1.repository.get_graph(branch2.repository)
2661
base_rev_id = graph.find_unique_lca(last1, last2)
2663
print 'merge base is revision %s' % base_rev_id
2666
class cmd_merge(Command):
2667
"""Perform a three-way merge.
2669
The branch is the branch you will merge from. By default, it will merge
2670
the latest revision. If you specify a revision, that revision will be
2671
merged. If you specify two revisions, the first will be used as a BASE,
2672
and the second one as OTHER. Revision numbers are always relative to the
2675
By default, bzr will try to merge in all new work from the other
2676
branch, automatically determining an appropriate base. If this
2677
fails, you may need to give an explicit base.
2679
Merge will do its best to combine the changes in two branches, but there
2680
are some kinds of problems only a human can fix. When it encounters those,
2681
it will mark a conflict. A conflict means that you need to fix something,
2682
before you should commit.
2684
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2686
If there is no default branch set, the first merge will set it. After
2687
that, you can omit the branch to use the default. To change the
2688
default, use --remember. The value will only be saved if the remote
2689
location can be accessed.
2691
The results of the merge are placed into the destination working
2692
directory, where they can be reviewed (with bzr diff), tested, and then
2693
committed to record the result of the merge.
2695
merge refuses to run if there are any uncommitted changes, unless
2699
To merge the latest revision from bzr.dev::
2701
bzr merge ../bzr.dev
2703
To merge changes up to and including revision 82 from bzr.dev::
2705
bzr merge -r 82 ../bzr.dev
2707
To merge the changes introduced by 82, without previous changes::
2709
bzr merge -r 81..82 ../bzr.dev
2712
_see_also = ['update', 'remerge', 'status-flags']
2713
takes_args = ['branch?']
2718
help='Merge even if the destination tree has uncommitted changes.'),
2722
Option('show-base', help="Show base revision text in "
2724
Option('uncommitted', help='Apply uncommitted changes'
2725
' from a working copy, instead of branch changes.'),
2726
Option('pull', help='If the destination is already'
2727
' completely merged into the source, pull from the'
2728
' source rather than merging. When this happens,'
2729
' you do not need to commit the result.'),
2731
help='Branch to merge into, '
2732
'rather than the one containing the working directory.',
2738
def run(self, branch=None, revision=None, force=False, merge_type=None,
2739
show_base=False, reprocess=False, remember=False,
2740
uncommitted=False, pull=False,
2743
# This is actually a branch (or merge-directive) *location*.
2747
if merge_type is None:
2748
merge_type = _mod_merge.Merge3Merger
2750
if directory is None: directory = u'.'
2751
possible_transports = []
2753
allow_pending = True
2754
verified = 'inapplicable'
2755
tree = WorkingTree.open_containing(directory)[0]
2756
change_reporter = delta._ChangeReporter(
2757
unversioned_filter=tree.is_ignored)
2760
pb = ui.ui_factory.nested_progress_bar()
2761
cleanups.append(pb.finished)
2763
cleanups.append(tree.unlock)
2764
if location is not None:
2765
mergeable, other_transport = _get_mergeable_helper(location)
2768
raise errors.BzrCommandError('Cannot use --uncommitted'
2769
' with bundles or merge directives.')
2771
if revision is not None:
2772
raise errors.BzrCommandError(
2773
'Cannot use -r with merge directives or bundles')
2774
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2776
possible_transports.append(other_transport)
2778
if merger is None and uncommitted:
2779
if revision is not None and len(revision) > 0:
2780
raise errors.BzrCommandError('Cannot use --uncommitted and'
2781
' --revision at the same time.')
2782
location = self._select_branch_location(tree, location)[0]
2783
other_tree, other_path = WorkingTree.open_containing(location)
2784
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2786
allow_pending = False
2789
merger, allow_pending = self._get_merger_from_branch(tree,
2790
location, revision, remember, possible_transports, pb)
2792
merger.merge_type = merge_type
2793
merger.reprocess = reprocess
2794
merger.show_base = show_base
2795
merger.change_reporter = change_reporter
2796
self.sanity_check_merger(merger)
2797
if (merger.base_rev_id == merger.other_rev_id and
2798
merger.other_rev_id != None):
2799
note('Nothing to do.')
2802
if merger.interesting_files is not None:
2803
raise errors.BzrCommandError('Cannot pull individual files')
2804
if (merger.base_rev_id == tree.last_revision()):
2805
result = tree.pull(merger.other_branch, False,
2806
merger.other_rev_id)
2807
result.report(self.outf)
2809
merger.check_basis(not force)
2810
conflict_count = merger.do_merge()
2812
merger.set_pending()
2813
if verified == 'failed':
2814
warning('Preview patch does not match changes')
2815
if conflict_count != 0:
2820
for cleanup in reversed(cleanups):
2823
def sanity_check_merger(self, merger):
2824
if (merger.show_base and
2825
not merger.merge_type is _mod_merge.Merge3Merger):
2826
raise errors.BzrCommandError("Show-base is not supported for this"
2827
" merge type. %s" % merger.merge_type)
2828
if merger.reprocess and not merger.merge_type.supports_reprocess:
2829
raise errors.BzrCommandError("Conflict reduction is not supported"
2830
" for merge type %s." %
2832
if merger.reprocess and merger.show_base:
2833
raise errors.BzrCommandError("Cannot do conflict reduction and"
2836
def _get_merger_from_branch(self, tree, location, revision, remember,
2837
possible_transports, pb):
2838
"""Produce a merger from a location, assuming it refers to a branch."""
2839
from bzrlib.tag import _merge_tags_if_possible
2840
assert revision is None or len(revision) < 3
2841
# find the branch locations
2842
other_loc, location = self._select_branch_location(tree, location,
2844
if revision is not None and len(revision) == 2:
2845
base_loc, location = self._select_branch_location(tree, location,
2848
base_loc = other_loc
2850
other_branch, other_path = Branch.open_containing(other_loc,
2851
possible_transports)
2852
if base_loc == other_loc:
2853
base_branch = other_branch
2855
base_branch, base_path = Branch.open_containing(base_loc,
2856
possible_transports)
2857
# Find the revision ids
2858
if revision is None or len(revision) < 1 or revision[-1] is None:
2859
other_revision_id = _mod_revision.ensure_null(
2860
other_branch.last_revision())
2862
other_revision_id = \
2863
_mod_revision.ensure_null(
2864
revision[-1].in_history(other_branch).rev_id)
2865
if (revision is not None and len(revision) == 2
2866
and revision[0] is not None):
2867
base_revision_id = \
2868
_mod_revision.ensure_null(
2869
revision[0].in_history(base_branch).rev_id)
2871
base_revision_id = None
2872
# Remember where we merge from
2873
if ((tree.branch.get_parent() is None or remember) and
2874
other_branch is not None):
2875
tree.branch.set_parent(other_branch.base)
2876
_merge_tags_if_possible(other_branch, tree.branch)
2877
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2878
other_revision_id, base_revision_id, other_branch, base_branch)
2879
if other_path != '':
2880
allow_pending = False
2881
merger.interesting_files = [other_path]
2883
allow_pending = True
2884
return merger, allow_pending
2886
def _select_branch_location(self, tree, location, revision=None,
2888
"""Select a branch location, according to possible inputs.
2890
If provided, branches from ``revision`` are preferred. (Both
2891
``revision`` and ``index`` must be supplied.)
2893
Otherwise, the ``location`` parameter is used. If it is None, then the
2894
``parent`` location is used, and a note is printed.
2896
:param tree: The working tree to select a branch for merging into
2897
:param location: The location entered by the user
2898
:param revision: The revision parameter to the command
2899
:param index: The index to use for the revision parameter. Negative
2900
indices are permitted.
2901
:return: (selected_location, default_location). The default location
2902
will be the user-entered location, if any, or else the remembered
2905
if (revision is not None and index is not None
2906
and revision[index] is not None):
2907
branch = revision[index].get_branch()
2908
if branch is not None:
2909
return branch, location
2910
location = self._get_remembered_parent(tree, location, 'Merging from')
2911
return location, location
2913
# TODO: move up to common parent; this isn't merge-specific anymore.
2914
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2915
"""Use tree.branch's parent if none was supplied.
2917
Report if the remembered location was used.
2919
if supplied_location is not None:
2920
return supplied_location
2921
stored_location = tree.branch.get_parent()
2922
mutter("%s", stored_location)
2923
if stored_location is None:
2924
raise errors.BzrCommandError("No location specified or remembered")
2925
display_url = urlutils.unescape_for_display(stored_location,
2927
self.outf.write("%s remembered location %s\n" % (verb_string,
2929
return stored_location
2932
class cmd_remerge(Command):
2935
Use this if you want to try a different merge technique while resolving
2936
conflicts. Some merge techniques are better than others, and remerge
2937
lets you try different ones on different files.
2939
The options for remerge have the same meaning and defaults as the ones for
2940
merge. The difference is that remerge can (only) be run when there is a
2941
pending merge, and it lets you specify particular files.
2944
Re-do the merge of all conflicted files, and show the base text in
2945
conflict regions, in addition to the usual THIS and OTHER texts::
2947
bzr remerge --show-base
2949
Re-do the merge of "foobar", using the weave merge algorithm, with
2950
additional processing to reduce the size of conflict regions::
2952
bzr remerge --merge-type weave --reprocess foobar
2954
takes_args = ['file*']
2959
help="Show base revision text in conflicts."),
2962
def run(self, file_list=None, merge_type=None, show_base=False,
2964
if merge_type is None:
2965
merge_type = _mod_merge.Merge3Merger
2966
tree, file_list = tree_files(file_list)
2969
parents = tree.get_parent_ids()
2970
if len(parents) != 2:
2971
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2972
" merges. Not cherrypicking or"
2974
repository = tree.branch.repository
2975
graph = repository.get_graph()
2976
base_revision = graph.find_unique_lca(parents[0], parents[1])
2977
base_tree = repository.revision_tree(base_revision)
2978
other_tree = repository.revision_tree(parents[1])
2979
interesting_ids = None
2981
conflicts = tree.conflicts()
2982
if file_list is not None:
2983
interesting_ids = set()
2984
for filename in file_list:
2985
file_id = tree.path2id(filename)
2987
raise errors.NotVersionedError(filename)
2988
interesting_ids.add(file_id)
2989
if tree.kind(file_id) != "directory":
2992
for name, ie in tree.inventory.iter_entries(file_id):
2993
interesting_ids.add(ie.file_id)
2994
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2996
# Remerge only supports resolving contents conflicts
2997
allowed_conflicts = ('text conflict', 'contents conflict')
2998
restore_files = [c.path for c in conflicts
2999
if c.typestring in allowed_conflicts]
3000
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3001
tree.set_conflicts(ConflictList(new_conflicts))
3002
if file_list is not None:
3003
restore_files = file_list
3004
for filename in restore_files:
3006
restore(tree.abspath(filename))
3007
except errors.NotConflicted:
3009
# Disable pending merges, because the file texts we are remerging
3010
# have not had those merges performed. If we use the wrong parents
3011
# list, we imply that the working tree text has seen and rejected
3012
# all the changes from the other tree, when in fact those changes
3013
# have not yet been seen.
3014
tree.set_parent_ids(parents[:1])
3016
conflicts = _mod_merge.merge_inner(
3017
tree.branch, other_tree, base_tree,
3019
interesting_ids=interesting_ids,
3020
other_rev_id=parents[1],
3021
merge_type=merge_type,
3022
show_base=show_base,
3023
reprocess=reprocess)
3025
tree.set_parent_ids(parents)
3034
class cmd_revert(Command):
3035
"""Revert files to a previous revision.
3037
Giving a list of files will revert only those files. Otherwise, all files
3038
will be reverted. If the revision is not specified with '--revision', the
3039
last committed revision is used.
3041
To remove only some changes, without reverting to a prior version, use
3042
merge instead. For example, "merge . --r-2..-3" will remove the changes
3043
introduced by -2, without affecting the changes introduced by -1. Or
3044
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3046
By default, any files that have been manually changed will be backed up
3047
first. (Files changed only by merge are not backed up.) Backup files have
3048
'.~#~' appended to their name, where # is a number.
3050
When you provide files, you can use their current pathname or the pathname
3051
from the target revision. So you can use revert to "undelete" a file by
3052
name. If you name a directory, all the contents of that directory will be
3055
Any files that have been newly added since that revision will be deleted,
3056
with a backup kept if appropriate. Directories containing unknown files
3057
will not be deleted.
3059
The working tree contains a list of pending merged revisions, which will
3060
be included as parents in the next commit. Normally, revert clears that
3061
list as well as reverting the files. If any files, are specified, revert
3062
leaves the pending merge list alnone and reverts only the files. Use "bzr
3063
revert ." in the tree root to revert all files but keep the merge record,
3064
and "bzr revert --forget-merges" to clear the pending merge list without
3065
reverting any files.
3068
_see_also = ['cat', 'export']
3071
Option('no-backup', "Do not save backups of reverted files."),
3072
Option('forget-merges',
3073
'Remove pending merge marker, without changing any files.'),
3075
takes_args = ['file*']
3077
def run(self, revision=None, no_backup=False, file_list=None,
3078
forget_merges=None):
3079
tree, file_list = tree_files(file_list)
3081
tree.set_parent_ids(tree.get_parent_ids()[:1])
3083
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3086
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3087
if revision is None:
3088
rev_id = tree.last_revision()
3089
elif len(revision) != 1:
3090
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3092
rev_id = revision[0].in_history(tree.branch).rev_id
3093
pb = ui.ui_factory.nested_progress_bar()
3095
tree.revert(file_list,
3096
tree.branch.repository.revision_tree(rev_id),
3097
not no_backup, pb, report_changes=True)
3102
class cmd_assert_fail(Command):
3103
"""Test reporting of assertion failures"""
3104
# intended just for use in testing
3109
raise AssertionError("always fails")
3112
class cmd_help(Command):
3113
"""Show help on a command or other topic.
3116
_see_also = ['topics']
3118
Option('long', 'Show help on all commands.'),
3120
takes_args = ['topic?']
3121
aliases = ['?', '--help', '-?', '-h']
3124
def run(self, topic=None, long=False):
3126
if topic is None and long:
3128
bzrlib.help.help(topic)
3131
class cmd_shell_complete(Command):
3132
"""Show appropriate completions for context.
3134
For a list of all available commands, say 'bzr shell-complete'.
3136
takes_args = ['context?']
3141
def run(self, context=None):
3142
import shellcomplete
3143
shellcomplete.shellcomplete(context)
3146
class cmd_fetch(Command):
3147
"""Copy in history from another branch but don't merge it.
3149
This is an internal method used for pull and merge.
3152
takes_args = ['from_branch', 'to_branch']
3153
def run(self, from_branch, to_branch):
3154
from bzrlib.fetch import Fetcher
3155
from_b = Branch.open(from_branch)
3156
to_b = Branch.open(to_branch)
3157
Fetcher(to_b, from_b)
3160
class cmd_missing(Command):
3161
"""Show unmerged/unpulled revisions between two branches.
3163
OTHER_BRANCH may be local or remote.
3166
_see_also = ['merge', 'pull']
3167
takes_args = ['other_branch?']
3169
Option('reverse', 'Reverse the order of revisions.'),
3171
'Display changes in the local branch only.'),
3172
Option('this' , 'Same as --mine-only.'),
3173
Option('theirs-only',
3174
'Display changes in the remote branch only.'),
3175
Option('other', 'Same as --theirs-only.'),
3180
encoding_type = 'replace'
3183
def run(self, other_branch=None, reverse=False, mine_only=False,
3184
theirs_only=False, log_format=None, long=False, short=False, line=False,
3185
show_ids=False, verbose=False, this=False, other=False):
3186
from bzrlib.missing import find_unmerged, iter_log_revisions
3193
local_branch = Branch.open_containing(u".")[0]
3194
parent = local_branch.get_parent()
3195
if other_branch is None:
3196
other_branch = parent
3197
if other_branch is None:
3198
raise errors.BzrCommandError("No peer location known"
3200
display_url = urlutils.unescape_for_display(parent,
3202
self.outf.write("Using last location: " + display_url + "\n")
3204
remote_branch = Branch.open(other_branch)
3205
if remote_branch.base == local_branch.base:
3206
remote_branch = local_branch
3207
local_branch.lock_read()
3209
remote_branch.lock_read()
3211
local_extra, remote_extra = find_unmerged(local_branch,
3213
if log_format is None:
3214
registry = log.log_formatter_registry
3215
log_format = registry.get_default(local_branch)
3216
lf = log_format(to_file=self.outf,
3218
show_timezone='original')
3219
if reverse is False:
3220
local_extra.reverse()
3221
remote_extra.reverse()
3222
if local_extra and not theirs_only:
3223
self.outf.write("You have %d extra revision(s):\n" %
3225
for revision in iter_log_revisions(local_extra,
3226
local_branch.repository,
3228
lf.log_revision(revision)
3229
printed_local = True
3231
printed_local = False
3232
if remote_extra and not mine_only:
3233
if printed_local is True:
3234
self.outf.write("\n\n\n")
3235
self.outf.write("You are missing %d revision(s):\n" %
3237
for revision in iter_log_revisions(remote_extra,
3238
remote_branch.repository,
3240
lf.log_revision(revision)
3241
if not remote_extra and not local_extra:
3243
self.outf.write("Branches are up to date.\n")
3247
remote_branch.unlock()
3249
local_branch.unlock()
3250
if not status_code and parent is None and other_branch is not None:
3251
local_branch.lock_write()
3253
# handle race conditions - a parent might be set while we run.
3254
if local_branch.get_parent() is None:
3255
local_branch.set_parent(remote_branch.base)
3257
local_branch.unlock()
3261
class cmd_pack(Command):
3262
"""Compress the data within a repository."""
3264
_see_also = ['repositories']
3265
takes_args = ['branch_or_repo?']
3267
def run(self, branch_or_repo='.'):
3268
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3270
branch = dir.open_branch()
3271
repository = branch.repository
3272
except errors.NotBranchError:
3273
repository = dir.open_repository()
3277
class cmd_plugins(Command):
3278
"""List the installed plugins.
3280
This command displays the list of installed plugins including the
3281
path where each one is located and a short description of each.
3283
A plugin is an external component for Bazaar that extends the
3284
revision control system, by adding or replacing code in Bazaar.
3285
Plugins can do a variety of things, including overriding commands,
3286
adding new commands, providing additional network transports and
3287
customizing log output.
3289
See the Bazaar web site, http://bazaar-vcs.org, for further
3290
information on plugins including where to find them and how to
3291
install them. Instructions are also provided there on how to
3292
write new plugins using the Python programming language.
3297
import bzrlib.plugin
3298
from inspect import getdoc
3299
for name, plugin in bzrlib.plugin.plugins().items():
3300
print plugin.path(), "[%s]" % plugin.__version__
3301
d = getdoc(plugin.module)
3303
print '\t', d.split('\n')[0]
3306
class cmd_testament(Command):
3307
"""Show testament (signing-form) of a revision."""
3310
Option('long', help='Produce long-format testament.'),
3312
help='Produce a strict-format testament.')]
3313
takes_args = ['branch?']
3315
def run(self, branch=u'.', revision=None, long=False, strict=False):
3316
from bzrlib.testament import Testament, StrictTestament
3318
testament_class = StrictTestament
3320
testament_class = Testament
3321
b = WorkingTree.open_containing(branch)[0].branch
3324
if revision is None:
3325
rev_id = b.last_revision()
3327
rev_id = revision[0].in_history(b).rev_id
3328
t = testament_class.from_revision(b.repository, rev_id)
3330
sys.stdout.writelines(t.as_text_lines())
3332
sys.stdout.write(t.as_short_text())
3337
class cmd_annotate(Command):
3338
"""Show the origin of each line in a file.
3340
This prints out the given file with an annotation on the left side
3341
indicating which revision, author and date introduced the change.
3343
If the origin is the same for a run of consecutive lines, it is
3344
shown only at the top, unless the --all option is given.
3346
# TODO: annotate directories; showing when each file was last changed
3347
# TODO: if the working copy is modified, show annotations on that
3348
# with new uncommitted lines marked
3349
aliases = ['ann', 'blame', 'praise']
3350
takes_args = ['filename']
3351
takes_options = [Option('all', help='Show annotations on all lines.'),
3352
Option('long', help='Show commit date in annotations.'),
3356
encoding_type = 'exact'
3359
def run(self, filename, all=False, long=False, revision=None,
3361
from bzrlib.annotate import annotate_file
3362
tree, relpath = WorkingTree.open_containing(filename)
3363
branch = tree.branch
3366
if revision is None:
3367
revision_id = branch.last_revision()
3368
elif len(revision) != 1:
3369
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3371
revision_id = revision[0].in_history(branch).rev_id
3372
file_id = tree.path2id(relpath)
3374
raise errors.NotVersionedError(filename)
3375
tree = branch.repository.revision_tree(revision_id)
3376
file_version = tree.inventory[file_id].revision
3377
annotate_file(branch, file_version, file_id, long, all, self.outf,
3383
class cmd_re_sign(Command):
3384
"""Create a digital signature for an existing revision."""
3385
# TODO be able to replace existing ones.
3387
hidden = True # is this right ?
3388
takes_args = ['revision_id*']
3389
takes_options = ['revision']
3391
def run(self, revision_id_list=None, revision=None):
3392
import bzrlib.gpg as gpg
3393
if revision_id_list is not None and revision is not None:
3394
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3395
if revision_id_list is None and revision is None:
3396
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3397
b = WorkingTree.open_containing(u'.')[0].branch
3398
gpg_strategy = gpg.GPGStrategy(b.get_config())
3399
if revision_id_list is not None:
3400
for revision_id in revision_id_list:
3401
b.repository.sign_revision(revision_id, gpg_strategy)
3402
elif revision is not None:
3403
if len(revision) == 1:
3404
revno, rev_id = revision[0].in_history(b)
3405
b.repository.sign_revision(rev_id, gpg_strategy)
3406
elif len(revision) == 2:
3407
# are they both on rh- if so we can walk between them
3408
# might be nice to have a range helper for arbitrary
3409
# revision paths. hmm.
3410
from_revno, from_revid = revision[0].in_history(b)
3411
to_revno, to_revid = revision[1].in_history(b)
3412
if to_revid is None:
3413
to_revno = b.revno()
3414
if from_revno is None or to_revno is None:
3415
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3416
for revno in range(from_revno, to_revno + 1):
3417
b.repository.sign_revision(b.get_rev_id(revno),
3420
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3423
class cmd_bind(Command):
3424
"""Convert the current branch into a checkout of the supplied branch.
3426
Once converted into a checkout, commits must succeed on the master branch
3427
before they will be applied to the local branch.
3430
_see_also = ['checkouts', 'unbind']
3431
takes_args = ['location?']
3434
def run(self, location=None):
3435
b, relpath = Branch.open_containing(u'.')
3436
if location is None:
3438
location = b.get_old_bound_location()
3439
except errors.UpgradeRequired:
3440
raise errors.BzrCommandError('No location supplied. '
3441
'This format does not remember old locations.')
3443
if location is None:
3444
raise errors.BzrCommandError('No location supplied and no '
3445
'previous location known')
3446
b_other = Branch.open(location)
3449
except errors.DivergedBranches:
3450
raise errors.BzrCommandError('These branches have diverged.'
3451
' Try merging, and then bind again.')
3454
class cmd_unbind(Command):
3455
"""Convert the current checkout into a regular branch.
3457
After unbinding, the local branch is considered independent and subsequent
3458
commits will be local only.
3461
_see_also = ['checkouts', 'bind']
3466
b, relpath = Branch.open_containing(u'.')
3468
raise errors.BzrCommandError('Local branch is not bound')
3471
class cmd_uncommit(Command):
3472
"""Remove the last committed revision.
3474
--verbose will print out what is being removed.
3475
--dry-run will go through all the motions, but not actually
3478
If --revision is specified, uncommit revisions to leave the branch at the
3479
specified revision. For example, "bzr uncommit -r 15" will leave the
3480
branch at revision 15.
3482
In the future, uncommit will create a revision bundle, which can then
3486
# TODO: jam 20060108 Add an option to allow uncommit to remove
3487
# unreferenced information in 'branch-as-repository' branches.
3488
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3489
# information in shared branches as well.
3490
_see_also = ['commit']
3491
takes_options = ['verbose', 'revision',
3492
Option('dry-run', help='Don\'t actually make changes.'),
3493
Option('force', help='Say yes to all questions.')]
3494
takes_args = ['location?']
3497
def run(self, location=None,
3498
dry_run=False, verbose=False,
3499
revision=None, force=False):
3500
from bzrlib.log import log_formatter, show_log
3501
from bzrlib.uncommit import uncommit
3503
if location is None:
3505
control, relpath = bzrdir.BzrDir.open_containing(location)
3507
tree = control.open_workingtree()
3509
except (errors.NoWorkingTree, errors.NotLocalUrl):
3511
b = control.open_branch()
3514
if revision is None:
3517
# 'bzr uncommit -r 10' actually means uncommit
3518
# so that the final tree is at revno 10.
3519
# but bzrlib.uncommit.uncommit() actually uncommits
3520
# the revisions that are supplied.
3521
# So we need to offset it by one
3522
revno = revision[0].in_history(b).revno+1
3524
if revno <= b.revno():
3525
rev_id = b.get_rev_id(revno)
3527
self.outf.write('No revisions to uncommit.\n')
3530
lf = log_formatter('short',
3532
show_timezone='original')
3537
direction='forward',
3538
start_revision=revno,
3539
end_revision=b.revno())
3542
print 'Dry-run, pretending to remove the above revisions.'
3544
val = raw_input('Press <enter> to continue')
3546
print 'The above revision(s) will be removed.'
3548
val = raw_input('Are you sure [y/N]? ')
3549
if val.lower() not in ('y', 'yes'):
3553
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3557
class cmd_break_lock(Command):
3558
"""Break a dead lock on a repository, branch or working directory.
3560
CAUTION: Locks should only be broken when you are sure that the process
3561
holding the lock has been stopped.
3563
You can get information on what locks are open via the 'bzr info' command.
3568
takes_args = ['location?']
3570
def run(self, location=None, show=False):
3571
if location is None:
3573
control, relpath = bzrdir.BzrDir.open_containing(location)
3575
control.break_lock()
3576
except NotImplementedError:
3580
class cmd_wait_until_signalled(Command):
3581
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3583
This just prints a line to signal when it is ready, then blocks on stdin.
3589
sys.stdout.write("running\n")
3591
sys.stdin.readline()
3594
class cmd_serve(Command):
3595
"""Run the bzr server."""
3597
aliases = ['server']
3601
help='Serve on stdin/out for use from inetd or sshd.'),
3603
help='Listen for connections on nominated port of the form '
3604
'[hostname:]portnumber. Passing 0 as the port number will '
3605
'result in a dynamically allocated port. The default port is '
3609
help='Serve contents of this directory.',
3611
Option('allow-writes',
3612
help='By default the server is a readonly server. Supplying '
3613
'--allow-writes enables write access to the contents of '
3614
'the served directory and below.'
3618
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3619
from bzrlib.smart import medium, server
3620
from bzrlib.transport import get_transport
3621
from bzrlib.transport.chroot import ChrootServer
3622
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3623
if directory is None:
3624
directory = os.getcwd()
3625
url = urlutils.local_path_to_url(directory)
3626
if not allow_writes:
3627
url = 'readonly+' + url
3628
chroot_server = ChrootServer(get_transport(url))
3629
chroot_server.setUp()
3630
t = get_transport(chroot_server.get_url())
3632
smart_server = medium.SmartServerPipeStreamMedium(
3633
sys.stdin, sys.stdout, t)
3635
host = BZR_DEFAULT_INTERFACE
3637
port = BZR_DEFAULT_PORT
3640
host, port = port.split(':')
3642
smart_server = server.SmartTCPServer(t, host=host, port=port)
3643
print 'listening on port: ', smart_server.port
3645
# for the duration of this server, no UI output is permitted.
3646
# note that this may cause problems with blackbox tests. This should
3647
# be changed with care though, as we dont want to use bandwidth sending
3648
# progress over stderr to smart server clients!
3649
old_factory = ui.ui_factory
3651
ui.ui_factory = ui.SilentUIFactory()
3652
smart_server.serve()
3654
ui.ui_factory = old_factory
3657
class cmd_join(Command):
3658
"""Combine a subtree into its containing tree.
3660
This command is for experimental use only. It requires the target tree
3661
to be in dirstate-with-subtree format, which cannot be converted into
3664
The TREE argument should be an independent tree, inside another tree, but
3665
not part of it. (Such trees can be produced by "bzr split", but also by
3666
running "bzr branch" with the target inside a tree.)
3668
The result is a combined tree, with the subtree no longer an independant
3669
part. This is marked as a merge of the subtree into the containing tree,
3670
and all history is preserved.
3672
If --reference is specified, the subtree retains its independence. It can
3673
be branched by itself, and can be part of multiple projects at the same
3674
time. But operations performed in the containing tree, such as commit
3675
and merge, will recurse into the subtree.
3678
_see_also = ['split']
3679
takes_args = ['tree']
3681
Option('reference', help='Join by reference.'),
3685
def run(self, tree, reference=False):
3686
sub_tree = WorkingTree.open(tree)
3687
parent_dir = osutils.dirname(sub_tree.basedir)
3688
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3689
repo = containing_tree.branch.repository
3690
if not repo.supports_rich_root():
3691
raise errors.BzrCommandError(
3692
"Can't join trees because %s doesn't support rich root data.\n"
3693
"You can use bzr upgrade on the repository."
3697
containing_tree.add_reference(sub_tree)
3698
except errors.BadReferenceTarget, e:
3699
# XXX: Would be better to just raise a nicely printable
3700
# exception from the real origin. Also below. mbp 20070306
3701
raise errors.BzrCommandError("Cannot join %s. %s" %
3705
containing_tree.subsume(sub_tree)
3706
except errors.BadSubsumeSource, e:
3707
raise errors.BzrCommandError("Cannot join %s. %s" %
3711
class cmd_split(Command):
3712
"""Split a tree into two trees.
3714
This command is for experimental use only. It requires the target tree
3715
to be in dirstate-with-subtree format, which cannot be converted into
3718
The TREE argument should be a subdirectory of a working tree. That
3719
subdirectory will be converted into an independent tree, with its own
3720
branch. Commits in the top-level tree will not apply to the new subtree.
3721
If you want that behavior, do "bzr join --reference TREE".
3724
_see_also = ['join']
3725
takes_args = ['tree']
3729
def run(self, tree):
3730
containing_tree, subdir = WorkingTree.open_containing(tree)
3731
sub_id = containing_tree.path2id(subdir)
3733
raise errors.NotVersionedError(subdir)
3735
containing_tree.extract(sub_id)
3736
except errors.RootNotRich:
3737
raise errors.UpgradeRequired(containing_tree.branch.base)
3741
class cmd_merge_directive(Command):
3742
"""Generate a merge directive for auto-merge tools.
3744
A directive requests a merge to be performed, and also provides all the
3745
information necessary to do so. This means it must either include a
3746
revision bundle, or the location of a branch containing the desired
3749
A submit branch (the location to merge into) must be supplied the first
3750
time the command is issued. After it has been supplied once, it will
3751
be remembered as the default.
3753
A public branch is optional if a revision bundle is supplied, but required
3754
if --diff or --plain is specified. It will be remembered as the default
3755
after the first use.
3758
takes_args = ['submit_branch?', 'public_branch?']
3762
_see_also = ['send']
3765
RegistryOption.from_kwargs('patch-type',
3766
'The type of patch to include in the directive.',
3768
value_switches=True,
3770
bundle='Bazaar revision bundle (default).',
3771
diff='Normal unified diff.',
3772
plain='No patch, just directive.'),
3773
Option('sign', help='GPG-sign the directive.'), 'revision',
3774
Option('mail-to', type=str,
3775
help='Instead of printing the directive, email to this address.'),
3776
Option('message', type=str, short_name='m',
3777
help='Message to use when committing this merge.')
3780
encoding_type = 'exact'
3782
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3783
sign=False, revision=None, mail_to=None, message=None):
3784
from bzrlib.revision import ensure_null, NULL_REVISION
3785
include_patch, include_bundle = {
3786
'plain': (False, False),
3787
'diff': (True, False),
3788
'bundle': (True, True),
3790
branch = Branch.open('.')
3791
stored_submit_branch = branch.get_submit_branch()
3792
if submit_branch is None:
3793
submit_branch = stored_submit_branch
3795
if stored_submit_branch is None:
3796
branch.set_submit_branch(submit_branch)
3797
if submit_branch is None:
3798
submit_branch = branch.get_parent()
3799
if submit_branch is None:
3800
raise errors.BzrCommandError('No submit branch specified or known')
3802
stored_public_branch = branch.get_public_branch()
3803
if public_branch is None:
3804
public_branch = stored_public_branch
3805
elif stored_public_branch is None:
3806
branch.set_public_branch(public_branch)
3807
if not include_bundle and public_branch is None:
3808
raise errors.BzrCommandError('No public branch specified or'
3810
base_revision_id = None
3811
if revision is not None:
3812
if len(revision) > 2:
3813
raise errors.BzrCommandError('bzr merge-directive takes '
3814
'at most two one revision identifiers')
3815
revision_id = revision[-1].in_history(branch).rev_id
3816
if len(revision) == 2:
3817
base_revision_id = revision[0].in_history(branch).rev_id
3818
base_revision_id = ensure_null(base_revision_id)
3820
revision_id = branch.last_revision()
3821
revision_id = ensure_null(revision_id)
3822
if revision_id == NULL_REVISION:
3823
raise errors.BzrCommandError('No revisions to bundle.')
3824
directive = merge_directive.MergeDirective2.from_objects(
3825
branch.repository, revision_id, time.time(),
3826
osutils.local_time_offset(), submit_branch,
3827
public_branch=public_branch, include_patch=include_patch,
3828
include_bundle=include_bundle, message=message,
3829
base_revision_id=base_revision_id)
3832
self.outf.write(directive.to_signed(branch))
3834
self.outf.writelines(directive.to_lines())
3836
message = directive.to_email(mail_to, branch, sign)
3837
s = SMTPConnection(branch.get_config())
3838
s.send_email(message)
3841
class cmd_send(Command):
3842
"""Mail or create a merge-directive for submiting changes.
3844
A merge directive provides many things needed for requesting merges:
3846
* A machine-readable description of the merge to perform
3848
* An optional patch that is a preview of the changes requested
3850
* An optional bundle of revision data, so that the changes can be applied
3851
directly from the merge directive, without retrieving data from a
3854
If --no-bundle is specified, then public_branch is needed (and must be
3855
up-to-date), so that the receiver can perform the merge using the
3856
public_branch. The public_branch is always included if known, so that
3857
people can check it later.
3859
The submit branch defaults to the parent, but can be overridden. Both
3860
submit branch and public branch will be remembered if supplied.
3862
If a public_branch is known for the submit_branch, that public submit
3863
branch is used in the merge instructions. This means that a local mirror
3864
can be used as your actual submit branch, once you have set public_branch
3867
Mail is sent using your preferred mail program. This should be transparent
3868
on Windows (it uses MAPI). On *nix, it requires the xdg-email utility. If
3869
the preferred client can't be found (or used), your editor will be used.
3871
To use a specific mail program, set the mail_client configuration option.
3872
(For Thunderbird 1.5, this works around some bugs.) Supported values for
3873
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
3874
generic options are "default", "editor", "mapi", and "xdg-email".
3876
If mail is being sent, a to address is required. This can be supplied
3877
either on the commandline, or by setting the submit_to configuration
3880
Two formats are currently supported: "4" uses revision bundle format 4 and
3881
merge directive format 2. It is significantly faster and smaller than
3882
older formats. It is compatible with Bazaar 0.19 and later. It is the
3883
default. "0.9" uses revision bundle format 0.9 and merge directive
3884
format 1. It is compatible with Bazaar 0.12 - 0.18.
3887
encoding_type = 'exact'
3889
_see_also = ['merge']
3891
takes_args = ['submit_branch?', 'public_branch?']
3895
help='Do not include a bundle in the merge directive.'),
3896
Option('no-patch', help='Do not include a preview patch in the merge'
3899
help='Remember submit and public branch.'),
3901
help='Branch to generate the submission from, '
3902
'rather than the one containing the working directory.',
3905
Option('output', short_name='o', help='Write directive to this file.',
3907
Option('mail-to', help='Mail the request to this address.',
3911
RegistryOption.from_kwargs('format',
3912
'Use the specified output format.',
3913
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
3914
'0.9': 'Bundle format 0.9, Merge Directive 1',})
3917
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3918
no_patch=False, revision=None, remember=False, output=None,
3919
format='4', mail_to=None, message=None, **kwargs):
3920
return self._run(submit_branch, revision, public_branch, remember,
3921
format, no_bundle, no_patch, output,
3922
kwargs.get('from', '.'), mail_to, message)
3924
def _run(self, submit_branch, revision, public_branch, remember, format,
3925
no_bundle, no_patch, output, from_, mail_to, message):
3926
from bzrlib.revision import NULL_REVISION
3928
outfile = StringIO()
3932
outfile = open(output, 'wb')
3934
branch = Branch.open_containing(from_)[0]
3936
config = branch.get_config()
3938
mail_to = config.get_user_option('submit_to')
3940
raise errors.BzrCommandError('No mail-to address'
3942
mail_client = config.get_mail_client()
3943
if remember and submit_branch is None:
3944
raise errors.BzrCommandError(
3945
'--remember requires a branch to be specified.')
3946
stored_submit_branch = branch.get_submit_branch()
3947
remembered_submit_branch = False
3948
if submit_branch is None:
3949
submit_branch = stored_submit_branch
3950
remembered_submit_branch = True
3952
if stored_submit_branch is None or remember:
3953
branch.set_submit_branch(submit_branch)
3954
if submit_branch is None:
3955
submit_branch = branch.get_parent()
3956
remembered_submit_branch = True
3957
if submit_branch is None:
3958
raise errors.BzrCommandError('No submit branch known or'
3960
if remembered_submit_branch:
3961
note('Using saved location: %s', submit_branch)
3963
stored_public_branch = branch.get_public_branch()
3964
if public_branch is None:
3965
public_branch = stored_public_branch
3966
elif stored_public_branch is None or remember:
3967
branch.set_public_branch(public_branch)
3968
if no_bundle and public_branch is None:
3969
raise errors.BzrCommandError('No public branch specified or'
3971
base_revision_id = None
3973
if revision is not None:
3974
if len(revision) > 2:
3975
raise errors.BzrCommandError('bzr send takes '
3976
'at most two one revision identifiers')
3977
revision_id = revision[-1].in_history(branch).rev_id
3978
if len(revision) == 2:
3979
base_revision_id = revision[0].in_history(branch).rev_id
3980
if revision_id is None:
3981
revision_id = branch.last_revision()
3982
if revision_id == NULL_REVISION:
3983
raise errors.BzrCommandError('No revisions to submit.')
3985
directive = merge_directive.MergeDirective2.from_objects(
3986
branch.repository, revision_id, time.time(),
3987
osutils.local_time_offset(), submit_branch,
3988
public_branch=public_branch, include_patch=not no_patch,
3989
include_bundle=not no_bundle, message=message,
3990
base_revision_id=base_revision_id)
3991
elif format == '0.9':
3994
patch_type = 'bundle'
3996
raise errors.BzrCommandError('Format 0.9 does not'
3997
' permit bundle with no patch')
4003
directive = merge_directive.MergeDirective.from_objects(
4004
branch.repository, revision_id, time.time(),
4005
osutils.local_time_offset(), submit_branch,
4006
public_branch=public_branch, patch_type=patch_type,
4009
outfile.writelines(directive.to_lines())
4011
subject = '[MERGE] '
4012
if message is not None:
4015
revision = branch.repository.get_revision(revision_id)
4016
subject += revision.get_summary()
4017
mail_client.compose_merge_request(mail_to, subject,
4024
class cmd_bundle_revisions(cmd_send):
4026
"""Create a merge-directive for submiting changes.
4028
A merge directive provides many things needed for requesting merges:
4030
* A machine-readable description of the merge to perform
4032
* An optional patch that is a preview of the changes requested
4034
* An optional bundle of revision data, so that the changes can be applied
4035
directly from the merge directive, without retrieving data from a
4038
If --no-bundle is specified, then public_branch is needed (and must be
4039
up-to-date), so that the receiver can perform the merge using the
4040
public_branch. The public_branch is always included if known, so that
4041
people can check it later.
4043
The submit branch defaults to the parent, but can be overridden. Both
4044
submit branch and public branch will be remembered if supplied.
4046
If a public_branch is known for the submit_branch, that public submit
4047
branch is used in the merge instructions. This means that a local mirror
4048
can be used as your actual submit branch, once you have set public_branch
4051
Two formats are currently supported: "4" uses revision bundle format 4 and
4052
merge directive format 2. It is significantly faster and smaller than
4053
older formats. It is compatible with Bazaar 0.19 and later. It is the
4054
default. "0.9" uses revision bundle format 0.9 and merge directive
4055
format 1. It is compatible with Bazaar 0.12 - 0.18.
4060
help='Do not include a bundle in the merge directive.'),
4061
Option('no-patch', help='Do not include a preview patch in the merge'
4064
help='Remember submit and public branch.'),
4066
help='Branch to generate the submission from, '
4067
'rather than the one containing the working directory.',
4070
Option('output', short_name='o', help='Write directive to this file.',
4073
RegistryOption.from_kwargs('format',
4074
'Use the specified output format.',
4075
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4076
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4078
aliases = ['bundle']
4080
_see_also = ['send', 'merge']
4084
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4085
no_patch=False, revision=None, remember=False, output=None,
4086
format='4', **kwargs):
4089
return self._run(submit_branch, revision, public_branch, remember,
4090
format, no_bundle, no_patch, output,
4091
kwargs.get('from', '.'), None, None)
4094
class cmd_tag(Command):
4095
"""Create, remove or modify a tag naming a revision.
4097
Tags give human-meaningful names to revisions. Commands that take a -r
4098
(--revision) option can be given -rtag:X, where X is any previously
4101
Tags are stored in the branch. Tags are copied from one branch to another
4102
along when you branch, push, pull or merge.
4104
It is an error to give a tag name that already exists unless you pass
4105
--force, in which case the tag is moved to point to the new revision.
4108
_see_also = ['commit', 'tags']
4109
takes_args = ['tag_name']
4112
help='Delete this tag rather than placing it.',
4115
help='Branch in which to place the tag.',
4120
help='Replace existing tags.',
4125
def run(self, tag_name,
4131
branch, relpath = Branch.open_containing(directory)
4135
branch.tags.delete_tag(tag_name)
4136
self.outf.write('Deleted tag %s.\n' % tag_name)
4139
if len(revision) != 1:
4140
raise errors.BzrCommandError(
4141
"Tags can only be placed on a single revision, "
4143
revision_id = revision[0].in_history(branch).rev_id
4145
revision_id = branch.last_revision()
4146
if (not force) and branch.tags.has_tag(tag_name):
4147
raise errors.TagAlreadyExists(tag_name)
4148
branch.tags.set_tag(tag_name, revision_id)
4149
self.outf.write('Created tag %s.\n' % tag_name)
4154
class cmd_tags(Command):
4157
This tag shows a table of tag names and the revisions they reference.
4163
help='Branch whose tags should be displayed.',
4173
branch, relpath = Branch.open_containing(directory)
4174
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
4175
self.outf.write('%-20s %s\n' % (tag_name, target))
4178
class cmd_reconfigure(Command):
4179
"""Reconfigure the type of a bzr directory.
4181
A target configuration must be specified.
4183
For checkouts, the bind-to location will be auto-detected if not specified.
4184
The order of preference is
4185
1. For a lightweight checkout, the current bound location.
4186
2. For branches that used to be checkouts, the previously-bound location.
4187
3. The push location.
4188
4. The parent location.
4189
If none of these is available, --bind-to must be specified.
4192
takes_args = ['location?']
4193
takes_options = [RegistryOption.from_kwargs('target_type',
4194
title='Target type',
4195
help='The type to reconfigure the directory to.',
4196
value_switches=True, enum_switch=False,
4197
branch='Reconfigure to a branch.',
4198
tree='Reconfigure to a tree.',
4199
checkout='Reconfigure to a checkout.'),
4200
Option('bind-to', help='Branch to bind checkout to.',
4203
help='Perform reconfiguration even if local changes'
4207
def run(self, location=None, target_type=None, bind_to=None, force=False):
4208
directory = bzrdir.BzrDir.open(location)
4209
if target_type is None:
4210
raise errors.BzrCommandError('No target configuration specified')
4211
elif target_type == 'branch':
4212
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4213
elif target_type == 'tree':
4214
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4215
elif target_type == 'checkout':
4216
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4218
reconfiguration.apply(force)
4221
def _create_prefix(cur_transport):
4222
needed = [cur_transport]
4223
# Recurse upwards until we can create a directory successfully
4225
new_transport = cur_transport.clone('..')
4226
if new_transport.base == cur_transport.base:
4227
raise errors.BzrCommandError(
4228
"Failed to create path prefix for %s."
4229
% cur_transport.base)
4231
new_transport.mkdir('.')
4232
except errors.NoSuchFile:
4233
needed.append(new_transport)
4234
cur_transport = new_transport
4237
# Now we only need to create child directories
4239
cur_transport = needed.pop()
4240
cur_transport.ensure_base()
4243
def _get_mergeable_helper(location):
4244
"""Get a merge directive or bundle if 'location' points to one.
4246
Try try to identify a bundle and returns its mergeable form. If it's not,
4247
we return the tried transport anyway so that it can reused to access the
4250
:param location: can point to a bundle or a branch.
4252
:return: mergeable, transport
4255
url = urlutils.normalize_url(location)
4256
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4257
location_transport = transport.get_transport(url)
4260
# There may be redirections but we ignore the intermediate
4261
# and final transports used
4262
read = bundle.read_mergeable_from_transport
4263
mergeable, t = read(location_transport, filename)
4264
except errors.NotABundle:
4265
# Continue on considering this url a Branch but adjust the
4266
# location_transport
4267
location_transport = location_transport.clone(filename)
4268
return mergeable, location_transport
4271
# these get imported and then picked up by the scan for cmd_*
4272
# TODO: Some more consistent way to split command definitions across files;
4273
# we do need to load at least some information about them to know of
4274
# aliases. ideally we would avoid loading the implementation until the
4275
# details were needed.
4276
from bzrlib.cmd_version_info import cmd_version_info
4277
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4278
from bzrlib.bundle.commands import (
4281
from bzrlib.sign_my_commits import cmd_sign_my_commits
4282
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4283
cmd_weave_plan_merge, cmd_weave_merge_text