1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
20
from StringIO import StringIO
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
47
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revisionspec import RevisionSpec
58
from bzrlib.smtp_connection import SMTPConnection
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
64
from bzrlib.progress import DummyProgress, ProgressPhase
65
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
68
def tree_files(file_list, default_branch=u'.'):
70
return internal_tree_files(file_list, default_branch)
71
except errors.FileInWrongBranch, e:
72
raise errors.BzrCommandError("%s is not in the same branch as %s" %
73
(e.path, file_list[0]))
76
# XXX: Bad function name; should possibly also be a class method of
77
# WorkingTree rather than a function.
78
def internal_tree_files(file_list, default_branch=u'.'):
79
"""Convert command-line paths to a WorkingTree and relative paths.
81
This is typically used for command-line processors that take one or
82
more filenames, and infer the workingtree that contains them.
84
The filenames given are not required to exist.
86
:param file_list: Filenames to convert.
88
:param default_branch: Fallback tree path to use if file_list is empty or
91
:return: workingtree, [relative_paths]
93
if file_list is None or len(file_list) == 0:
94
return WorkingTree.open_containing(default_branch)[0], file_list
95
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
97
for filename in file_list:
99
new_list.append(tree.relpath(osutils.dereference_path(filename)))
100
except errors.PathNotChild:
101
raise errors.FileInWrongBranch(tree.branch, filename)
102
return tree, new_list
105
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
106
def get_format_type(typestring):
107
"""Parse and return a format specifier."""
108
# Have to use BzrDirMetaFormat1 directly, so that
109
# RepositoryFormat.set_default_format works
110
if typestring == "default":
111
return bzrdir.BzrDirMetaFormat1()
113
return bzrdir.format_registry.make_bzrdir(typestring)
115
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
116
raise errors.BzrCommandError(msg)
119
# TODO: Make sure no commands unconditionally use the working directory as a
120
# branch. If a filename argument is used, the first of them should be used to
121
# specify the branch. (Perhaps this can be factored out into some kind of
122
# Argument class, representing a file in a branch, where the first occurrence
125
class cmd_status(Command):
126
"""Display status summary.
128
This reports on versioned and unknown files, reporting them
129
grouped by state. Possible states are:
132
Versioned in the working copy but not in the previous revision.
135
Versioned in the previous revision but removed or deleted
139
Path of this file changed from the previous revision;
140
the text may also have changed. This includes files whose
141
parent directory was renamed.
144
Text has changed since the previous revision.
147
File kind has been changed (e.g. from file to directory).
150
Not versioned and not matching an ignore pattern.
152
To see ignored files use 'bzr ignored'. For details on the
153
changes to file texts, use 'bzr diff'.
155
Note that --short or -S gives status flags for each item, similar
156
to Subversion's status command. To get output similar to svn -q,
159
If no arguments are specified, the status of the entire working
160
directory is shown. Otherwise, only the status of the specified
161
files or directories is reported. If a directory is given, status
162
is reported for everything inside that directory.
164
If a revision argument is given, the status is calculated against
165
that revision, or between two revisions if two are provided.
168
# TODO: --no-recurse, --recurse options
170
takes_args = ['file*']
171
takes_options = ['show-ids', 'revision', 'change',
172
Option('short', help='Use short status indicators.',
174
Option('versioned', help='Only show versioned files.',
177
aliases = ['st', 'stat']
179
encoding_type = 'replace'
180
_see_also = ['diff', 'revert', 'status-flags']
183
def run(self, show_ids=False, file_list=None, revision=None, short=False,
185
from bzrlib.status import show_tree_status
187
if revision and len(revision) > 2:
188
raise errors.BzrCommandError('bzr status --revision takes exactly'
189
' one or two revision specifiers')
191
tree, file_list = tree_files(file_list)
193
show_tree_status(tree, show_ids=show_ids,
194
specific_files=file_list, revision=revision,
195
to_file=self.outf, short=short, versioned=versioned)
198
class cmd_cat_revision(Command):
199
"""Write out metadata for a revision.
201
The revision to print can either be specified by a specific
202
revision identifier, or you can use --revision.
206
takes_args = ['revision_id?']
207
takes_options = ['revision']
208
# cat-revision is more for frontends so should be exact
212
def run(self, revision_id=None, revision=None):
214
revision_id = osutils.safe_revision_id(revision_id, warn=False)
215
if revision_id is not None and revision is not None:
216
raise errors.BzrCommandError('You can only supply one of'
217
' revision_id or --revision')
218
if revision_id is None and revision is None:
219
raise errors.BzrCommandError('You must supply either'
220
' --revision or a revision_id')
221
b = WorkingTree.open_containing(u'.')[0].branch
223
# TODO: jam 20060112 should cat-revision always output utf-8?
224
if revision_id is not None:
225
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
226
elif revision is not None:
229
raise errors.BzrCommandError('You cannot specify a NULL'
231
revno, rev_id = rev.in_history(b)
232
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
235
class cmd_remove_tree(Command):
236
"""Remove the working tree from a given branch/checkout.
238
Since a lightweight checkout is little more than a working tree
239
this will refuse to run against one.
241
To re-create the working tree, use "bzr checkout".
243
_see_also = ['checkout', 'working-trees']
245
takes_args = ['location?']
247
def run(self, location='.'):
248
d = bzrdir.BzrDir.open(location)
251
working = d.open_workingtree()
252
except errors.NoWorkingTree:
253
raise errors.BzrCommandError("No working tree to remove")
254
except errors.NotLocalUrl:
255
raise errors.BzrCommandError("You cannot remove the working tree of a "
258
working_path = working.bzrdir.root_transport.base
259
branch_path = working.branch.bzrdir.root_transport.base
260
if working_path != branch_path:
261
raise errors.BzrCommandError("You cannot remove the working tree from "
262
"a lightweight checkout")
264
d.destroy_workingtree()
267
class cmd_revno(Command):
268
"""Show current revision number.
270
This is equal to the number of revisions on this branch.
274
takes_args = ['location?']
277
def run(self, location=u'.'):
278
self.outf.write(str(Branch.open_containing(location)[0].revno()))
279
self.outf.write('\n')
282
class cmd_revision_info(Command):
283
"""Show revision number and revision id for a given revision identifier.
286
takes_args = ['revision_info*']
287
takes_options = ['revision']
290
def run(self, revision=None, revision_info_list=[]):
293
if revision is not None:
294
revs.extend(revision)
295
if revision_info_list is not None:
296
for rev in revision_info_list:
297
revs.append(RevisionSpec.from_string(rev))
299
b = Branch.open_containing(u'.')[0]
302
revs.append(RevisionSpec.from_string('-1'))
305
revinfo = rev.in_history(b)
306
if revinfo.revno is None:
307
dotted_map = b.get_revision_id_to_revno_map()
308
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
309
print '%s %s' % (revno, revinfo.rev_id)
311
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
314
class cmd_add(Command):
315
"""Add specified files or directories.
317
In non-recursive mode, all the named items are added, regardless
318
of whether they were previously ignored. A warning is given if
319
any of the named files are already versioned.
321
In recursive mode (the default), files are treated the same way
322
but the behaviour for directories is different. Directories that
323
are already versioned do not give a warning. All directories,
324
whether already versioned or not, are searched for files or
325
subdirectories that are neither versioned or ignored, and these
326
are added. This search proceeds recursively into versioned
327
directories. If no names are given '.' is assumed.
329
Therefore simply saying 'bzr add' will version all files that
330
are currently unknown.
332
Adding a file whose parent directory is not versioned will
333
implicitly add the parent, and so on up to the root. This means
334
you should never need to explicitly add a directory, they'll just
335
get added when you add a file in the directory.
337
--dry-run will show which files would be added, but not actually
340
--file-ids-from will try to use the file ids from the supplied path.
341
It looks up ids trying to find a matching parent directory with the
342
same filename, and then by pure path. This option is rarely needed
343
but can be useful when adding the same logical file into two
344
branches that will be merged later (without showing the two different
345
adds as a conflict). It is also useful when merging another project
346
into a subdirectory of this one.
348
takes_args = ['file*']
351
help="Don't recursively add the contents of directories."),
353
help="Show what would be done, but don't actually do anything."),
355
Option('file-ids-from',
357
help='Lookup file ids from this tree.'),
359
encoding_type = 'replace'
360
_see_also = ['remove']
362
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
367
if file_ids_from is not None:
369
base_tree, base_path = WorkingTree.open_containing(
371
except errors.NoWorkingTree:
372
base_branch, base_path = Branch.open_containing(
374
base_tree = base_branch.basis_tree()
376
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
377
to_file=self.outf, should_print=(not is_quiet()))
379
action = bzrlib.add.AddAction(to_file=self.outf,
380
should_print=(not is_quiet()))
383
base_tree.lock_read()
385
file_list = self._maybe_expand_globs(file_list)
387
tree = WorkingTree.open_containing(file_list[0])[0]
389
tree = WorkingTree.open_containing(u'.')[0]
390
added, ignored = tree.smart_add(file_list, not
391
no_recurse, action=action, save=not dry_run)
393
if base_tree is not None:
397
for glob in sorted(ignored.keys()):
398
for path in ignored[glob]:
399
self.outf.write("ignored %s matching \"%s\"\n"
403
for glob, paths in ignored.items():
404
match_len += len(paths)
405
self.outf.write("ignored %d file(s).\n" % match_len)
406
self.outf.write("If you wish to add some of these files,"
407
" please add them by name.\n")
410
class cmd_mkdir(Command):
411
"""Create a new versioned directory.
413
This is equivalent to creating the directory and then adding it.
416
takes_args = ['dir+']
417
encoding_type = 'replace'
419
def run(self, dir_list):
422
wt, dd = WorkingTree.open_containing(d)
424
self.outf.write('added %s\n' % d)
427
class cmd_relpath(Command):
428
"""Show path of a file relative to root"""
430
takes_args = ['filename']
434
def run(self, filename):
435
# TODO: jam 20050106 Can relpath return a munged path if
436
# sys.stdout encoding cannot represent it?
437
tree, relpath = WorkingTree.open_containing(filename)
438
self.outf.write(relpath)
439
self.outf.write('\n')
442
class cmd_inventory(Command):
443
"""Show inventory of the current working copy or a revision.
445
It is possible to limit the output to a particular entry
446
type using the --kind option. For example: --kind file.
448
It is also possible to restrict the list of files to a specific
449
set. For example: bzr inventory --show-ids this/file
458
help='List entries of a particular kind: file, directory, symlink.',
461
takes_args = ['file*']
464
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
465
if kind and kind not in ['file', 'directory', 'symlink']:
466
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
468
work_tree, file_list = tree_files(file_list)
469
work_tree.lock_read()
471
if revision is not None:
472
if len(revision) > 1:
473
raise errors.BzrCommandError(
474
'bzr inventory --revision takes exactly one revision'
476
revision_id = revision[0].in_history(work_tree.branch).rev_id
477
tree = work_tree.branch.repository.revision_tree(revision_id)
479
extra_trees = [work_tree]
485
if file_list is not None:
486
file_ids = tree.paths2ids(file_list, trees=extra_trees,
487
require_versioned=True)
488
# find_ids_across_trees may include some paths that don't
490
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
491
for file_id in file_ids if file_id in tree)
493
entries = tree.inventory.entries()
496
if tree is not work_tree:
499
for path, entry in entries:
500
if kind and kind != entry.kind:
503
self.outf.write('%-50s %s\n' % (path, entry.file_id))
505
self.outf.write(path)
506
self.outf.write('\n')
509
class cmd_mv(Command):
510
"""Move or rename a file.
513
bzr mv OLDNAME NEWNAME
515
bzr mv SOURCE... DESTINATION
517
If the last argument is a versioned directory, all the other names
518
are moved into it. Otherwise, there must be exactly two arguments
519
and the file is changed to a new name.
521
If OLDNAME does not exist on the filesystem but is versioned and
522
NEWNAME does exist on the filesystem but is not versioned, mv
523
assumes that the file has been manually moved and only updates
524
its internal inventory to reflect that change.
525
The same is valid when moving many SOURCE files to a DESTINATION.
527
Files cannot be moved between branches.
530
takes_args = ['names*']
531
takes_options = [Option("after", help="Move only the bzr identifier"
532
" of the file, because the file has already been moved."),
534
aliases = ['move', 'rename']
535
encoding_type = 'replace'
537
def run(self, names_list, after=False):
538
if names_list is None:
541
if len(names_list) < 2:
542
raise errors.BzrCommandError("missing file argument")
543
tree, rel_names = tree_files(names_list)
545
if os.path.isdir(names_list[-1]):
546
# move into existing directory
547
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
548
self.outf.write("%s => %s\n" % pair)
550
if len(names_list) != 2:
551
raise errors.BzrCommandError('to mv multiple files the'
552
' destination must be a versioned'
554
tree.rename_one(rel_names[0], rel_names[1], after=after)
555
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
558
class cmd_pull(Command):
559
"""Turn this branch into a mirror of another branch.
561
This command only works on branches that have not diverged. Branches are
562
considered diverged if the destination branch's most recent commit is one
563
that has not been merged (directly or indirectly) into the parent.
565
If branches have diverged, you can use 'bzr merge' to integrate the changes
566
from one into the other. Once one branch has merged, the other should
567
be able to pull it again.
569
If you want to forget your local changes and just update your branch to
570
match the remote one, use pull --overwrite.
572
If there is no default location set, the first pull will set it. After
573
that, you can omit the location to use the default. To change the
574
default, use --remember. The value will only be saved if the remote
575
location can be accessed.
578
_see_also = ['push', 'update', 'status-flags']
579
takes_options = ['remember', 'overwrite', 'revision',
580
custom_help('verbose',
581
help='Show logs of pulled revisions.'),
583
help='Branch to pull into, '
584
'rather than the one containing the working directory.',
589
takes_args = ['location?']
590
encoding_type = 'replace'
592
def run(self, location=None, remember=False, overwrite=False,
593
revision=None, verbose=False,
595
# FIXME: too much stuff is in the command class
598
if directory is None:
601
tree_to = WorkingTree.open_containing(directory)[0]
602
branch_to = tree_to.branch
603
except errors.NoWorkingTree:
605
branch_to = Branch.open_containing(directory)[0]
607
possible_transports = []
608
if location is not None:
609
mergeable, location_transport = _get_mergeable_helper(location)
610
possible_transports.append(location_transport)
612
stored_loc = branch_to.get_parent()
614
if stored_loc is None:
615
raise errors.BzrCommandError("No pull location known or"
618
display_url = urlutils.unescape_for_display(stored_loc,
620
self.outf.write("Using saved location: %s\n" % display_url)
621
location = stored_loc
622
location_transport = transport.get_transport(
623
location, possible_transports=possible_transports)
625
if mergeable is not None:
626
if revision is not None:
627
raise errors.BzrCommandError(
628
'Cannot use -r with merge directives or bundles')
629
mergeable.install_revisions(branch_to.repository)
630
base_revision_id, revision_id, verified = \
631
mergeable.get_merge_request(branch_to.repository)
632
branch_from = branch_to
634
branch_from = Branch.open_from_transport(location_transport)
636
if branch_to.get_parent() is None or remember:
637
branch_to.set_parent(branch_from.base)
639
if revision is not None:
640
if len(revision) == 1:
641
revision_id = revision[0].in_history(branch_from).rev_id
643
raise errors.BzrCommandError(
644
'bzr pull --revision takes one value.')
647
old_rh = branch_to.revision_history()
648
if tree_to is not None:
649
change_reporter = delta._ChangeReporter(
650
unversioned_filter=tree_to.is_ignored)
651
result = tree_to.pull(branch_from, overwrite, revision_id,
653
possible_transports=possible_transports)
655
result = branch_to.pull(branch_from, overwrite, revision_id)
657
result.report(self.outf)
659
new_rh = branch_to.revision_history()
660
log.show_changed_revisions(branch_to, old_rh, new_rh,
664
class cmd_push(Command):
665
"""Update a mirror of this branch.
667
The target branch will not have its working tree populated because this
668
is both expensive, and is not supported on remote file systems.
670
Some smart servers or protocols *may* put the working tree in place in
673
This command only works on branches that have not diverged. Branches are
674
considered diverged if the destination branch's most recent commit is one
675
that has not been merged (directly or indirectly) by the source branch.
677
If branches have diverged, you can use 'bzr push --overwrite' to replace
678
the other branch completely, discarding its unmerged changes.
680
If you want to ensure you have the different changes in the other branch,
681
do a merge (see bzr help merge) from the other branch, and commit that.
682
After that you will be able to do a push without '--overwrite'.
684
If there is no default push location set, the first push will set it.
685
After that, you can omit the location to use the default. To change the
686
default, use --remember. The value will only be saved if the remote
687
location can be accessed.
690
_see_also = ['pull', 'update', 'working-trees']
691
takes_options = ['remember', 'overwrite', 'verbose',
692
Option('create-prefix',
693
help='Create the path leading up to the branch '
694
'if it does not already exist.'),
696
help='Branch to push from, '
697
'rather than the one containing the working directory.',
701
Option('use-existing-dir',
702
help='By default push will fail if the target'
703
' directory exists, but does not already'
704
' have a control directory. This flag will'
705
' allow push to proceed.'),
707
takes_args = ['location?']
708
encoding_type = 'replace'
710
def run(self, location=None, remember=False, overwrite=False,
711
create_prefix=False, verbose=False,
712
use_existing_dir=False,
714
# FIXME: Way too big! Put this into a function called from the
716
if directory is None:
718
br_from = Branch.open_containing(directory)[0]
719
stored_loc = br_from.get_push_location()
721
if stored_loc is None:
722
raise errors.BzrCommandError("No push location known or specified.")
724
display_url = urlutils.unescape_for_display(stored_loc,
726
self.outf.write("Using saved location: %s\n" % display_url)
727
location = stored_loc
729
to_transport = transport.get_transport(location)
731
br_to = repository_to = dir_to = None
733
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
734
except errors.NotBranchError:
735
pass # Didn't find anything
737
# If we can open a branch, use its direct repository, otherwise see
738
# if there is a repository without a branch.
740
br_to = dir_to.open_branch()
741
except errors.NotBranchError:
742
# Didn't find a branch, can we find a repository?
744
repository_to = dir_to.find_repository()
745
except errors.NoRepositoryPresent:
748
# Found a branch, so we must have found a repository
749
repository_to = br_to.repository
754
# The destination doesn't exist; create it.
755
# XXX: Refactor the create_prefix/no_create_prefix code into a
756
# common helper function
758
to_transport.mkdir('.')
759
except errors.FileExists:
760
if not use_existing_dir:
761
raise errors.BzrCommandError("Target directory %s"
762
" already exists, but does not have a valid .bzr"
763
" directory. Supply --use-existing-dir to push"
764
" there anyway." % location)
765
except errors.NoSuchFile:
766
if not create_prefix:
767
raise errors.BzrCommandError("Parent directory of %s"
769
"\nYou may supply --create-prefix to create all"
770
" leading parent directories."
772
_create_prefix(to_transport)
774
# Now the target directory exists, but doesn't have a .bzr
775
# directory. So we need to create it, along with any work to create
776
# all of the dependent branches, etc.
777
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
778
revision_id=br_from.last_revision())
779
br_to = dir_to.open_branch()
780
# TODO: Some more useful message about what was copied
781
note('Created new branch.')
782
# We successfully created the target, remember it
783
if br_from.get_push_location() is None or remember:
784
br_from.set_push_location(br_to.base)
785
elif repository_to is None:
786
# we have a bzrdir but no branch or repository
787
# XXX: Figure out what to do other than complain.
788
raise errors.BzrCommandError("At %s you have a valid .bzr control"
789
" directory, but not a branch or repository. This is an"
790
" unsupported configuration. Please move the target directory"
791
" out of the way and try again."
794
# We have a repository but no branch, copy the revisions, and then
796
last_revision_id = br_from.last_revision()
797
repository_to.fetch(br_from.repository,
798
revision_id=last_revision_id)
799
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
800
note('Created new branch.')
801
if br_from.get_push_location() is None or remember:
802
br_from.set_push_location(br_to.base)
803
else: # We have a valid to branch
804
# We were able to connect to the remote location, so remember it
805
# we don't need to successfully push because of possible divergence.
806
if br_from.get_push_location() is None or remember:
807
br_from.set_push_location(br_to.base)
809
old_rh = br_to.revision_history()
812
tree_to = dir_to.open_workingtree()
813
except errors.NotLocalUrl:
814
warning("This transport does not update the working "
815
"tree of: %s. See 'bzr help working-trees' for "
816
"more information." % br_to.base)
817
push_result = br_from.push(br_to, overwrite)
818
except errors.NoWorkingTree:
819
push_result = br_from.push(br_to, overwrite)
823
push_result = br_from.push(tree_to.branch, overwrite)
827
except errors.DivergedBranches:
828
raise errors.BzrCommandError('These branches have diverged.'
829
' Try using "merge" and then "push".')
830
if push_result is not None:
831
push_result.report(self.outf)
833
new_rh = br_to.revision_history()
836
from bzrlib.log import show_changed_revisions
837
show_changed_revisions(br_to, old_rh, new_rh,
840
# we probably did a clone rather than a push, so a message was
845
class cmd_branch(Command):
846
"""Create a new copy of a branch.
848
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
849
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
850
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
851
is derived from the FROM_LOCATION by stripping a leading scheme or drive
852
identifier, if any. For example, "branch lp:foo-bar" will attempt to
855
To retrieve the branch as of a particular revision, supply the --revision
856
parameter, as in "branch foo/bar -r 5".
859
_see_also = ['checkout']
860
takes_args = ['from_location', 'to_location?']
861
takes_options = ['revision']
862
aliases = ['get', 'clone']
864
def run(self, from_location, to_location=None, revision=None):
865
from bzrlib.tag import _merge_tags_if_possible
868
elif len(revision) > 1:
869
raise errors.BzrCommandError(
870
'bzr branch --revision takes exactly 1 revision value')
872
br_from = Branch.open(from_location)
875
if len(revision) == 1 and revision[0] is not None:
876
revision_id = revision[0].in_history(br_from)[1]
878
# FIXME - wt.last_revision, fallback to branch, fall back to
879
# None or perhaps NULL_REVISION to mean copy nothing
881
revision_id = br_from.last_revision()
882
if to_location is None:
883
to_location = urlutils.derive_to_location(from_location)
886
name = os.path.basename(to_location) + '\n'
888
to_transport = transport.get_transport(to_location)
890
to_transport.mkdir('.')
891
except errors.FileExists:
892
raise errors.BzrCommandError('Target directory "%s" already'
893
' exists.' % to_location)
894
except errors.NoSuchFile:
895
raise errors.BzrCommandError('Parent of "%s" does not exist.'
898
# preserve whatever source format we have.
899
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
900
possible_transports=[to_transport])
901
branch = dir.open_branch()
902
except errors.NoSuchRevision:
903
to_transport.delete_tree('.')
904
msg = "The branch %s has no revision %s." % (from_location, revision[0])
905
raise errors.BzrCommandError(msg)
907
branch.control_files.put_utf8('branch-name', name)
908
_merge_tags_if_possible(br_from, branch)
909
note('Branched %d revision(s).' % branch.revno())
914
class cmd_checkout(Command):
915
"""Create a new checkout of an existing branch.
917
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
918
the branch found in '.'. This is useful if you have removed the working tree
919
or if it was never created - i.e. if you pushed the branch to its current
922
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
923
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
924
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
925
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
926
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
929
To retrieve the branch as of a particular revision, supply the --revision
930
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
931
out of date [so you cannot commit] but it may be useful (i.e. to examine old
935
_see_also = ['checkouts', 'branch']
936
takes_args = ['branch_location?', 'to_location?']
937
takes_options = ['revision',
938
Option('lightweight',
939
help="Perform a lightweight checkout. Lightweight "
940
"checkouts depend on access to the branch for "
941
"every operation. Normal checkouts can perform "
942
"common operations like diff and status without "
943
"such access, and also support local commits."
948
def run(self, branch_location=None, to_location=None, revision=None,
952
elif len(revision) > 1:
953
raise errors.BzrCommandError(
954
'bzr checkout --revision takes exactly 1 revision value')
955
if branch_location is None:
956
branch_location = osutils.getcwd()
957
to_location = branch_location
958
source = Branch.open(branch_location)
959
if len(revision) == 1 and revision[0] is not None:
960
revision_id = _mod_revision.ensure_null(
961
revision[0].in_history(source)[1])
964
if to_location is None:
965
to_location = urlutils.derive_to_location(branch_location)
966
# if the source and to_location are the same,
967
# and there is no working tree,
968
# then reconstitute a branch
969
if (osutils.abspath(to_location) ==
970
osutils.abspath(branch_location)):
972
source.bzrdir.open_workingtree()
973
except errors.NoWorkingTree:
974
source.bzrdir.create_workingtree(revision_id)
976
source.create_checkout(to_location, revision_id, lightweight)
979
class cmd_renames(Command):
980
"""Show list of renamed files.
982
# TODO: Option to show renames between two historical versions.
984
# TODO: Only show renames under dir, rather than in the whole branch.
985
_see_also = ['status']
986
takes_args = ['dir?']
989
def run(self, dir=u'.'):
990
tree = WorkingTree.open_containing(dir)[0]
993
new_inv = tree.inventory
994
old_tree = tree.basis_tree()
997
old_inv = old_tree.inventory
998
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1000
for old_name, new_name in renames:
1001
self.outf.write("%s => %s\n" % (old_name, new_name))
1008
class cmd_update(Command):
1009
"""Update a tree to have the latest code committed to its branch.
1011
This will perform a merge into the working tree, and may generate
1012
conflicts. If you have any local changes, you will still
1013
need to commit them after the update for the update to be complete.
1015
If you want to discard your local changes, you can just do a
1016
'bzr revert' instead of 'bzr commit' after the update.
1019
_see_also = ['pull', 'working-trees', 'status-flags']
1020
takes_args = ['dir?']
1023
def run(self, dir='.'):
1024
tree = WorkingTree.open_containing(dir)[0]
1025
possible_transports = []
1026
master = tree.branch.get_master_branch(
1027
possible_transports=possible_transports)
1028
if master is not None:
1031
tree.lock_tree_write()
1033
existing_pending_merges = tree.get_parent_ids()[1:]
1034
last_rev = _mod_revision.ensure_null(tree.last_revision())
1035
if last_rev == _mod_revision.ensure_null(
1036
tree.branch.last_revision()):
1037
# may be up to date, check master too.
1038
if master is None or last_rev == _mod_revision.ensure_null(
1039
master.last_revision()):
1040
revno = tree.branch.revision_id_to_revno(last_rev)
1041
note("Tree is up to date at revision %d." % (revno,))
1043
conflicts = tree.update(
1044
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1045
possible_transports=possible_transports)
1046
revno = tree.branch.revision_id_to_revno(
1047
_mod_revision.ensure_null(tree.last_revision()))
1048
note('Updated to revision %d.' % (revno,))
1049
if tree.get_parent_ids()[1:] != existing_pending_merges:
1050
note('Your local commits will now show as pending merges with '
1051
"'bzr status', and can be committed with 'bzr commit'.")
1060
class cmd_info(Command):
1061
"""Show information about a working tree, branch or repository.
1063
This command will show all known locations and formats associated to the
1064
tree, branch or repository. Statistical information is included with
1067
Branches and working trees will also report any missing revisions.
1069
_see_also = ['revno', 'working-trees', 'repositories']
1070
takes_args = ['location?']
1071
takes_options = ['verbose']
1074
def run(self, location=None, verbose=False):
1079
from bzrlib.info import show_bzrdir_info
1080
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1081
verbose=noise_level)
1084
class cmd_remove(Command):
1085
"""Remove files or directories.
1087
This makes bzr stop tracking changes to the specified files and
1088
delete them if they can easily be recovered using revert.
1090
You can specify one or more files, and/or --new. If you specify --new,
1091
only 'added' files will be removed. If you specify both, then new files
1092
in the specified directories will be removed. If the directories are
1093
also new, they will also be removed.
1095
takes_args = ['file*']
1096
takes_options = ['verbose',
1097
Option('new', help='Remove newly-added files.'),
1098
RegistryOption.from_kwargs('file-deletion-strategy',
1099
'The file deletion mode to be used.',
1100
title='Deletion Strategy', value_switches=True, enum_switch=False,
1101
safe='Only delete files if they can be'
1102
' safely recovered (default).',
1103
keep="Don't delete any files.",
1104
force='Delete all the specified files, even if they can not be '
1105
'recovered and even if they are non-empty directories.')]
1107
encoding_type = 'replace'
1109
def run(self, file_list, verbose=False, new=False,
1110
file_deletion_strategy='safe'):
1111
tree, file_list = tree_files(file_list)
1113
if file_list is not None:
1114
file_list = [f for f in file_list]
1116
raise errors.BzrCommandError('Specify one or more files to'
1117
' remove, or use --new.')
1120
added = tree.changes_from(tree.basis_tree(),
1121
specific_files=file_list).added
1122
file_list = sorted([f[0] for f in added], reverse=True)
1123
if len(file_list) == 0:
1124
raise errors.BzrCommandError('No matching files.')
1125
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1126
keep_files=file_deletion_strategy=='keep',
1127
force=file_deletion_strategy=='force')
1130
class cmd_file_id(Command):
1131
"""Print file_id of a particular file or directory.
1133
The file_id is assigned when the file is first added and remains the
1134
same through all revisions where the file exists, even when it is
1139
_see_also = ['inventory', 'ls']
1140
takes_args = ['filename']
1143
def run(self, filename):
1144
tree, relpath = WorkingTree.open_containing(filename)
1145
i = tree.path2id(relpath)
1147
raise errors.NotVersionedError(filename)
1149
self.outf.write(i + '\n')
1152
class cmd_file_path(Command):
1153
"""Print path of file_ids to a file or directory.
1155
This prints one line for each directory down to the target,
1156
starting at the branch root.
1160
takes_args = ['filename']
1163
def run(self, filename):
1164
tree, relpath = WorkingTree.open_containing(filename)
1165
fid = tree.path2id(relpath)
1167
raise errors.NotVersionedError(filename)
1168
segments = osutils.splitpath(relpath)
1169
for pos in range(1, len(segments) + 1):
1170
path = osutils.joinpath(segments[:pos])
1171
self.outf.write("%s\n" % tree.path2id(path))
1174
class cmd_reconcile(Command):
1175
"""Reconcile bzr metadata in a branch.
1177
This can correct data mismatches that may have been caused by
1178
previous ghost operations or bzr upgrades. You should only
1179
need to run this command if 'bzr check' or a bzr developer
1180
advises you to run it.
1182
If a second branch is provided, cross-branch reconciliation is
1183
also attempted, which will check that data like the tree root
1184
id which was not present in very early bzr versions is represented
1185
correctly in both branches.
1187
At the same time it is run it may recompress data resulting in
1188
a potential saving in disk space or performance gain.
1190
The branch *MUST* be on a listable system such as local disk or sftp.
1193
_see_also = ['check']
1194
takes_args = ['branch?']
1196
def run(self, branch="."):
1197
from bzrlib.reconcile import reconcile
1198
dir = bzrdir.BzrDir.open(branch)
1202
class cmd_revision_history(Command):
1203
"""Display the list of revision ids on a branch."""
1206
takes_args = ['location?']
1211
def run(self, location="."):
1212
branch = Branch.open_containing(location)[0]
1213
for revid in branch.revision_history():
1214
self.outf.write(revid)
1215
self.outf.write('\n')
1218
class cmd_ancestry(Command):
1219
"""List all revisions merged into this branch."""
1221
_see_also = ['log', 'revision-history']
1222
takes_args = ['location?']
1227
def run(self, location="."):
1229
wt = WorkingTree.open_containing(location)[0]
1230
except errors.NoWorkingTree:
1231
b = Branch.open(location)
1232
last_revision = b.last_revision()
1235
last_revision = wt.last_revision()
1237
revision_ids = b.repository.get_ancestry(last_revision)
1238
assert revision_ids[0] is None
1240
for revision_id in revision_ids:
1241
self.outf.write(revision_id + '\n')
1244
class cmd_init(Command):
1245
"""Make a directory into a versioned branch.
1247
Use this to create an empty branch, or before importing an
1250
If there is a repository in a parent directory of the location, then
1251
the history of the branch will be stored in the repository. Otherwise
1252
init creates a standalone branch which carries its own history
1253
in the .bzr directory.
1255
If there is already a branch at the location but it has no working tree,
1256
the tree can be populated with 'bzr checkout'.
1258
Recipe for importing a tree of files::
1264
bzr commit -m 'imported project'
1267
_see_also = ['init-repository', 'branch', 'checkout']
1268
takes_args = ['location?']
1270
Option('create-prefix',
1271
help='Create the path leading up to the branch '
1272
'if it does not already exist.'),
1273
RegistryOption('format',
1274
help='Specify a format for this branch. '
1275
'See "help formats".',
1276
registry=bzrdir.format_registry,
1277
converter=bzrdir.format_registry.make_bzrdir,
1278
value_switches=True,
1279
title="Branch Format",
1281
Option('append-revisions-only',
1282
help='Never change revnos or the existing log.'
1283
' Append revisions to it only.')
1285
def run(self, location=None, format=None, append_revisions_only=False,
1286
create_prefix=False):
1288
format = bzrdir.format_registry.make_bzrdir('default')
1289
if location is None:
1292
to_transport = transport.get_transport(location)
1294
# The path has to exist to initialize a
1295
# branch inside of it.
1296
# Just using os.mkdir, since I don't
1297
# believe that we want to create a bunch of
1298
# locations if the user supplies an extended path
1300
to_transport.ensure_base()
1301
except errors.NoSuchFile:
1302
if not create_prefix:
1303
raise errors.BzrCommandError("Parent directory of %s"
1305
"\nYou may supply --create-prefix to create all"
1306
" leading parent directories."
1308
_create_prefix(to_transport)
1311
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1312
except errors.NotBranchError:
1313
# really a NotBzrDir error...
1314
create_branch = bzrdir.BzrDir.create_branch_convenience
1315
branch = create_branch(to_transport.base, format=format,
1316
possible_transports=[to_transport])
1318
from bzrlib.transport.local import LocalTransport
1319
if existing_bzrdir.has_branch():
1320
if (isinstance(to_transport, LocalTransport)
1321
and not existing_bzrdir.has_workingtree()):
1322
raise errors.BranchExistsWithoutWorkingTree(location)
1323
raise errors.AlreadyBranchError(location)
1325
branch = existing_bzrdir.create_branch()
1326
existing_bzrdir.create_workingtree()
1327
if append_revisions_only:
1329
branch.set_append_revisions_only(True)
1330
except errors.UpgradeRequired:
1331
raise errors.BzrCommandError('This branch format cannot be set'
1332
' to append-revisions-only. Try --experimental-branch6')
1335
class cmd_init_repository(Command):
1336
"""Create a shared repository to hold branches.
1338
New branches created under the repository directory will store their
1339
revisions in the repository, not in the branch directory.
1341
If the --no-trees option is used then the branches in the repository
1342
will not have working trees by default.
1345
Create a shared repositories holding just branches::
1347
bzr init-repo --no-trees repo
1350
Make a lightweight checkout elsewhere::
1352
bzr checkout --lightweight repo/trunk trunk-checkout
1357
_see_also = ['init', 'branch', 'checkout', 'repositories']
1358
takes_args = ["location"]
1359
takes_options = [RegistryOption('format',
1360
help='Specify a format for this repository. See'
1361
' "bzr help formats" for details.',
1362
registry=bzrdir.format_registry,
1363
converter=bzrdir.format_registry.make_bzrdir,
1364
value_switches=True, title='Repository format'),
1366
help='Branches in the repository will default to'
1367
' not having a working tree.'),
1369
aliases = ["init-repo"]
1371
def run(self, location, format=None, no_trees=False):
1373
format = bzrdir.format_registry.make_bzrdir('default')
1375
if location is None:
1378
to_transport = transport.get_transport(location)
1379
to_transport.ensure_base()
1381
newdir = format.initialize_on_transport(to_transport)
1382
repo = newdir.create_repository(shared=True)
1383
repo.set_make_working_trees(not no_trees)
1386
class cmd_diff(Command):
1387
"""Show differences in the working tree or between revisions.
1389
If files are listed, only the changes in those files are listed.
1390
Otherwise, all changes for the tree are listed.
1392
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1393
produces patches suitable for "patch -p1".
1396
Shows the difference in the working tree versus the last commit::
1400
Difference between the working tree and revision 1::
1404
Difference between revision 2 and revision 1::
1408
Same as 'bzr diff' but prefix paths with old/ and new/::
1410
bzr diff --prefix old/:new/
1412
Show the differences between the two working trees::
1414
bzr diff bzr.mine bzr.dev
1416
Show just the differences for 'foo.c'::
1420
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1421
# or a graphical diff.
1423
# TODO: Python difflib is not exactly the same as unidiff; should
1424
# either fix it up or prefer to use an external diff.
1426
# TODO: Selected-file diff is inefficient and doesn't show you
1429
# TODO: This probably handles non-Unix newlines poorly.
1431
_see_also = ['status']
1432
takes_args = ['file*']
1434
Option('diff-options', type=str,
1435
help='Pass these options to the external diff program.'),
1436
Option('prefix', type=str,
1438
help='Set prefixes to added to old and new filenames, as '
1439
'two values separated by a colon. (eg "old/:new/").'),
1443
aliases = ['di', 'dif']
1444
encoding_type = 'exact'
1447
def run(self, revision=None, file_list=None, diff_options=None,
1449
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1451
if (prefix is None) or (prefix == '0'):
1459
old_label, new_label = prefix.split(":")
1461
raise errors.BzrCommandError(
1462
'--prefix expects two values separated by a colon'
1463
' (eg "old/:new/")')
1465
if revision and len(revision) > 2:
1466
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1467
' one or two revision specifiers')
1470
tree1, file_list = internal_tree_files(file_list)
1474
except errors.FileInWrongBranch:
1475
if len(file_list) != 2:
1476
raise errors.BzrCommandError("Files are in different branches")
1478
tree1, file1 = WorkingTree.open_containing(file_list[0])
1479
tree2, file2 = WorkingTree.open_containing(file_list[1])
1480
if file1 != "" or file2 != "":
1481
# FIXME diff those two files. rbc 20051123
1482
raise errors.BzrCommandError("Files are in different branches")
1484
except errors.NotBranchError:
1485
if (revision is not None and len(revision) == 2
1486
and not revision[0].needs_branch()
1487
and not revision[1].needs_branch()):
1488
# If both revision specs include a branch, we can
1489
# diff them without needing a local working tree
1490
tree1, tree2 = None, None
1494
if tree2 is not None:
1495
if revision is not None:
1496
# FIXME: but there should be a clean way to diff between
1497
# non-default versions of two trees, it's not hard to do
1499
raise errors.BzrCommandError(
1500
"Sorry, diffing arbitrary revisions across branches "
1501
"is not implemented yet")
1502
return show_diff_trees(tree1, tree2, sys.stdout,
1503
specific_files=file_list,
1504
external_diff_options=diff_options,
1505
old_label=old_label, new_label=new_label)
1507
return diff_cmd_helper(tree1, file_list, diff_options,
1508
revision_specs=revision,
1509
old_label=old_label, new_label=new_label)
1512
class cmd_deleted(Command):
1513
"""List files deleted in the working tree.
1515
# TODO: Show files deleted since a previous revision, or
1516
# between two revisions.
1517
# TODO: Much more efficient way to do this: read in new
1518
# directories with readdir, rather than stating each one. Same
1519
# level of effort but possibly much less IO. (Or possibly not,
1520
# if the directories are very large...)
1521
_see_also = ['status', 'ls']
1522
takes_options = ['show-ids']
1525
def run(self, show_ids=False):
1526
tree = WorkingTree.open_containing(u'.')[0]
1529
old = tree.basis_tree()
1532
for path, ie in old.inventory.iter_entries():
1533
if not tree.has_id(ie.file_id):
1534
self.outf.write(path)
1536
self.outf.write(' ')
1537
self.outf.write(ie.file_id)
1538
self.outf.write('\n')
1545
class cmd_modified(Command):
1546
"""List files modified in working tree.
1550
_see_also = ['status', 'ls']
1554
tree = WorkingTree.open_containing(u'.')[0]
1555
td = tree.changes_from(tree.basis_tree())
1556
for path, id, kind, text_modified, meta_modified in td.modified:
1557
self.outf.write(path + '\n')
1560
class cmd_added(Command):
1561
"""List files added in working tree.
1565
_see_also = ['status', 'ls']
1569
wt = WorkingTree.open_containing(u'.')[0]
1572
basis = wt.basis_tree()
1575
basis_inv = basis.inventory
1578
if file_id in basis_inv:
1580
if inv.is_root(file_id) and len(basis_inv) == 0:
1582
path = inv.id2path(file_id)
1583
if not os.access(osutils.abspath(path), os.F_OK):
1585
self.outf.write(path + '\n')
1592
class cmd_root(Command):
1593
"""Show the tree root directory.
1595
The root is the nearest enclosing directory with a .bzr control
1598
takes_args = ['filename?']
1600
def run(self, filename=None):
1601
"""Print the branch root."""
1602
tree = WorkingTree.open_containing(filename)[0]
1603
self.outf.write(tree.basedir + '\n')
1606
def _parse_limit(limitstring):
1608
return int(limitstring)
1610
msg = "The limit argument must be an integer."
1611
raise errors.BzrCommandError(msg)
1614
class cmd_log(Command):
1615
"""Show log of a branch, file, or directory.
1617
By default show the log of the branch containing the working directory.
1619
To request a range of logs, you can use the command -r begin..end
1620
-r revision requests a specific revision, -r ..end or -r begin.. are
1624
Log the current branch::
1632
Log the last 10 revisions of a branch::
1634
bzr log -r -10.. http://server/branch
1637
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1639
takes_args = ['location?']
1642
help='Show from oldest to newest.'),
1645
help='Display timezone as local, original, or utc.'),
1646
custom_help('verbose',
1647
help='Show files changed in each revision.'),
1653
help='Show revisions whose message matches this '
1654
'regular expression.',
1657
help='Limit the output to the first N revisions.',
1661
encoding_type = 'replace'
1664
def run(self, location=None, timezone='original',
1672
from bzrlib.log import show_log
1673
assert message is None or isinstance(message, basestring), \
1674
"invalid message argument %r" % message
1675
direction = (forward and 'forward') or 'reverse'
1680
# find the file id to log:
1682
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1686
tree = b.basis_tree()
1687
file_id = tree.path2id(fp)
1689
raise errors.BzrCommandError(
1690
"Path does not have any revision history: %s" %
1694
# FIXME ? log the current subdir only RBC 20060203
1695
if revision is not None \
1696
and len(revision) > 0 and revision[0].get_branch():
1697
location = revision[0].get_branch()
1700
dir, relpath = bzrdir.BzrDir.open_containing(location)
1701
b = dir.open_branch()
1705
if revision is None:
1708
elif len(revision) == 1:
1709
rev1 = rev2 = revision[0].in_history(b)
1710
elif len(revision) == 2:
1711
if revision[1].get_branch() != revision[0].get_branch():
1712
# b is taken from revision[0].get_branch(), and
1713
# show_log will use its revision_history. Having
1714
# different branches will lead to weird behaviors.
1715
raise errors.BzrCommandError(
1716
"Log doesn't accept two revisions in different"
1718
rev1 = revision[0].in_history(b)
1719
rev2 = revision[1].in_history(b)
1721
raise errors.BzrCommandError(
1722
'bzr log --revision takes one or two values.')
1724
if log_format is None:
1725
log_format = log.log_formatter_registry.get_default(b)
1727
lf = log_format(show_ids=show_ids, to_file=self.outf,
1728
show_timezone=timezone)
1734
direction=direction,
1735
start_revision=rev1,
1743
def get_log_format(long=False, short=False, line=False, default='long'):
1744
log_format = default
1748
log_format = 'short'
1754
class cmd_touching_revisions(Command):
1755
"""Return revision-ids which affected a particular file.
1757
A more user-friendly interface is "bzr log FILE".
1761
takes_args = ["filename"]
1764
def run(self, filename):
1765
tree, relpath = WorkingTree.open_containing(filename)
1767
file_id = tree.path2id(relpath)
1768
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1769
self.outf.write("%6d %s\n" % (revno, what))
1772
class cmd_ls(Command):
1773
"""List files in a tree.
1776
_see_also = ['status', 'cat']
1777
takes_args = ['path?']
1778
# TODO: Take a revision or remote path and list that tree instead.
1782
Option('non-recursive',
1783
help='Don\'t recurse into subdirectories.'),
1785
help='Print paths relative to the root of the branch.'),
1786
Option('unknown', help='Print unknown files.'),
1787
Option('versioned', help='Print versioned files.'),
1788
Option('ignored', help='Print ignored files.'),
1790
help='Write an ascii NUL (\\0) separator '
1791
'between files rather than a newline.'),
1793
help='List entries of a particular kind: file, directory, symlink.',
1798
def run(self, revision=None, verbose=False,
1799
non_recursive=False, from_root=False,
1800
unknown=False, versioned=False, ignored=False,
1801
null=False, kind=None, show_ids=False, path=None):
1803
if kind and kind not in ('file', 'directory', 'symlink'):
1804
raise errors.BzrCommandError('invalid kind specified')
1806
if verbose and null:
1807
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1808
all = not (unknown or versioned or ignored)
1810
selection = {'I':ignored, '?':unknown, 'V':versioned}
1817
raise errors.BzrCommandError('cannot specify both --from-root'
1821
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1827
if revision is not None:
1828
tree = branch.repository.revision_tree(
1829
revision[0].in_history(branch).rev_id)
1831
tree = branch.basis_tree()
1835
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1836
if fp.startswith(relpath):
1837
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1838
if non_recursive and '/' in fp:
1840
if not all and not selection[fc]:
1842
if kind is not None and fkind != kind:
1845
kindch = entry.kind_character()
1846
outstring = '%-8s %s%s' % (fc, fp, kindch)
1847
if show_ids and fid is not None:
1848
outstring = "%-50s %s" % (outstring, fid)
1849
self.outf.write(outstring + '\n')
1851
self.outf.write(fp + '\0')
1854
self.outf.write(fid)
1855
self.outf.write('\0')
1863
self.outf.write('%-50s %s\n' % (fp, my_id))
1865
self.outf.write(fp + '\n')
1870
class cmd_unknowns(Command):
1871
"""List unknown files.
1879
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1880
self.outf.write(osutils.quotefn(f) + '\n')
1883
class cmd_ignore(Command):
1884
"""Ignore specified files or patterns.
1886
To remove patterns from the ignore list, edit the .bzrignore file.
1888
Trailing slashes on patterns are ignored.
1889
If the pattern contains a slash or is a regular expression, it is compared
1890
to the whole path from the branch root. Otherwise, it is compared to only
1891
the last component of the path. To match a file only in the root
1892
directory, prepend './'.
1894
Ignore patterns specifying absolute paths are not allowed.
1896
Ignore patterns may include globbing wildcards such as::
1898
? - Matches any single character except '/'
1899
* - Matches 0 or more characters except '/'
1900
/**/ - Matches 0 or more directories in a path
1901
[a-z] - Matches a single character from within a group of characters
1903
Ignore patterns may also be Python regular expressions.
1904
Regular expression ignore patterns are identified by a 'RE:' prefix
1905
followed by the regular expression. Regular expression ignore patterns
1906
may not include named or numbered groups.
1908
Note: ignore patterns containing shell wildcards must be quoted from
1912
Ignore the top level Makefile::
1914
bzr ignore ./Makefile
1916
Ignore class files in all directories::
1918
bzr ignore '*.class'
1920
Ignore .o files under the lib directory::
1922
bzr ignore 'lib/**/*.o'
1924
Ignore .o files under the lib directory::
1926
bzr ignore 'RE:lib/.*\.o'
1929
_see_also = ['status', 'ignored']
1930
takes_args = ['name_pattern*']
1932
Option('old-default-rules',
1933
help='Write out the ignore rules bzr < 0.9 always used.')
1936
def run(self, name_pattern_list=None, old_default_rules=None):
1937
from bzrlib.atomicfile import AtomicFile
1938
if old_default_rules is not None:
1939
# dump the rules and exit
1940
for pattern in ignores.OLD_DEFAULTS:
1943
if not name_pattern_list:
1944
raise errors.BzrCommandError("ignore requires at least one "
1945
"NAME_PATTERN or --old-default-rules")
1946
name_pattern_list = [globbing.normalize_pattern(p)
1947
for p in name_pattern_list]
1948
for name_pattern in name_pattern_list:
1949
if (name_pattern[0] == '/' or
1950
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1951
raise errors.BzrCommandError(
1952
"NAME_PATTERN should not be an absolute path")
1953
tree, relpath = WorkingTree.open_containing(u'.')
1954
ifn = tree.abspath('.bzrignore')
1955
if os.path.exists(ifn):
1958
igns = f.read().decode('utf-8')
1964
# TODO: If the file already uses crlf-style termination, maybe
1965
# we should use that for the newly added lines?
1967
if igns and igns[-1] != '\n':
1969
for name_pattern in name_pattern_list:
1970
igns += name_pattern + '\n'
1972
f = AtomicFile(ifn, 'wb')
1974
f.write(igns.encode('utf-8'))
1979
if not tree.path2id('.bzrignore'):
1980
tree.add(['.bzrignore'])
1982
ignored = globbing.Globster(name_pattern_list)
1985
for entry in tree.list_files():
1989
if ignored.match(filename):
1990
matches.append(filename.encode('utf-8'))
1992
if len(matches) > 0:
1993
print "Warning: the following files are version controlled and" \
1994
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1996
class cmd_ignored(Command):
1997
"""List ignored files and the patterns that matched them.
2000
_see_also = ['ignore']
2003
tree = WorkingTree.open_containing(u'.')[0]
2006
for path, file_class, kind, file_id, entry in tree.list_files():
2007
if file_class != 'I':
2009
## XXX: Slightly inefficient since this was already calculated
2010
pat = tree.is_ignored(path)
2011
print '%-50s %s' % (path, pat)
2016
class cmd_lookup_revision(Command):
2017
"""Lookup the revision-id from a revision-number
2020
bzr lookup-revision 33
2023
takes_args = ['revno']
2026
def run(self, revno):
2030
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2032
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2035
class cmd_export(Command):
2036
"""Export current or past revision to a destination directory or archive.
2038
If no revision is specified this exports the last committed revision.
2040
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2041
given, try to find the format with the extension. If no extension
2042
is found exports to a directory (equivalent to --format=dir).
2044
If root is supplied, it will be used as the root directory inside
2045
container formats (tar, zip, etc). If it is not supplied it will default
2046
to the exported filename. The root option has no effect for 'dir' format.
2048
If branch is omitted then the branch containing the current working
2049
directory will be used.
2051
Note: Export of tree with non-ASCII filenames to zip is not supported.
2053
================= =========================
2054
Supported formats Autodetected by extension
2055
================= =========================
2058
tbz2 .tar.bz2, .tbz2
2061
================= =========================
2063
takes_args = ['dest', 'branch?']
2066
help="Type of file to export to.",
2071
help="Name of the root directory inside the exported file."),
2073
def run(self, dest, branch=None, revision=None, format=None, root=None):
2074
from bzrlib.export import export
2077
tree = WorkingTree.open_containing(u'.')[0]
2080
b = Branch.open(branch)
2082
if revision is None:
2083
# should be tree.last_revision FIXME
2084
rev_id = b.last_revision()
2086
if len(revision) != 1:
2087
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2088
rev_id = revision[0].in_history(b).rev_id
2089
t = b.repository.revision_tree(rev_id)
2091
export(t, dest, format, root)
2092
except errors.NoSuchExportFormat, e:
2093
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2096
class cmd_cat(Command):
2097
"""Write the contents of a file as of a given revision to standard output.
2099
If no revision is nominated, the last revision is used.
2101
Note: Take care to redirect standard output when using this command on a
2107
Option('name-from-revision', help='The path name in the old tree.'),
2110
takes_args = ['filename']
2111
encoding_type = 'exact'
2114
def run(self, filename, revision=None, name_from_revision=False):
2115
if revision is not None and len(revision) != 1:
2116
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2121
tree, b, relpath = \
2122
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2123
except errors.NotBranchError:
2126
if revision is not None and revision[0].get_branch() is not None:
2127
b = Branch.open(revision[0].get_branch())
2129
tree = b.basis_tree()
2130
if revision is None:
2131
revision_id = b.last_revision()
2133
revision_id = revision[0].in_history(b).rev_id
2135
cur_file_id = tree.path2id(relpath)
2136
rev_tree = b.repository.revision_tree(revision_id)
2137
old_file_id = rev_tree.path2id(relpath)
2139
if name_from_revision:
2140
if old_file_id is None:
2141
raise errors.BzrCommandError("%r is not present in revision %s"
2142
% (filename, revision_id))
2144
rev_tree.print_file(old_file_id)
2145
elif cur_file_id is not None:
2146
rev_tree.print_file(cur_file_id)
2147
elif old_file_id is not None:
2148
rev_tree.print_file(old_file_id)
2150
raise errors.BzrCommandError("%r is not present in revision %s" %
2151
(filename, revision_id))
2154
class cmd_local_time_offset(Command):
2155
"""Show the offset in seconds from GMT to local time."""
2159
print osutils.local_time_offset()
2163
class cmd_commit(Command):
2164
"""Commit changes into a new revision.
2166
If no arguments are given, the entire tree is committed.
2168
If selected files are specified, only changes to those files are
2169
committed. If a directory is specified then the directory and everything
2170
within it is committed.
2172
If author of the change is not the same person as the committer, you can
2173
specify the author's name using the --author option. The name should be
2174
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2176
A selected-file commit may fail in some cases where the committed
2177
tree would be invalid. Consider::
2182
bzr commit foo -m "committing foo"
2183
bzr mv foo/bar foo/baz
2186
bzr commit foo/bar -m "committing bar but not baz"
2188
In the example above, the last commit will fail by design. This gives
2189
the user the opportunity to decide whether they want to commit the
2190
rename at the same time, separately first, or not at all. (As a general
2191
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2193
Note: A selected-file commit after a merge is not yet supported.
2195
# TODO: Run hooks on tree to-be-committed, and after commit.
2197
# TODO: Strict commit that fails if there are deleted files.
2198
# (what does "deleted files" mean ??)
2200
# TODO: Give better message for -s, --summary, used by tla people
2202
# XXX: verbose currently does nothing
2204
_see_also = ['bugs', 'uncommit']
2205
takes_args = ['selected*']
2207
Option('message', type=unicode,
2209
help="Description of the new revision."),
2212
help='Commit even if nothing has changed.'),
2213
Option('file', type=str,
2216
help='Take commit message from this file.'),
2218
help="Refuse to commit if there are unknown "
2219
"files in the working tree."),
2220
ListOption('fixes', type=str,
2221
help="Mark a bug as being fixed by this revision."),
2222
Option('author', type=str,
2223
help="Set the author's name, if it's different "
2224
"from the committer."),
2226
help="Perform a local commit in a bound "
2227
"branch. Local commits are not pushed to "
2228
"the master branch until a normal commit "
2232
help='When no message is supplied, show the diff along'
2233
' with the status summary in the message editor.'),
2235
aliases = ['ci', 'checkin']
2237
def _get_bug_fix_properties(self, fixes, branch):
2239
# Configure the properties for bug fixing attributes.
2240
for fixed_bug in fixes:
2241
tokens = fixed_bug.split(':')
2242
if len(tokens) != 2:
2243
raise errors.BzrCommandError(
2244
"Invalid bug %s. Must be in the form of 'tag:id'. "
2245
"Commit refused." % fixed_bug)
2246
tag, bug_id = tokens
2248
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2249
except errors.UnknownBugTrackerAbbreviation:
2250
raise errors.BzrCommandError(
2251
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2252
except errors.MalformedBugIdentifier:
2253
raise errors.BzrCommandError(
2254
"Invalid bug identifier for %s. Commit refused."
2256
properties.append('%s fixed' % bug_url)
2257
return '\n'.join(properties)
2259
def run(self, message=None, file=None, verbose=False, selected_list=None,
2260
unchanged=False, strict=False, local=False, fixes=[],
2261
author=None, show_diff=False):
2262
from bzrlib.commit import (
2266
from bzrlib.errors import (
2271
from bzrlib.msgeditor import (
2272
edit_commit_message_encoded,
2273
make_commit_message_template_encoded
2276
# TODO: Need a blackbox test for invoking the external editor; may be
2277
# slightly problematic to run this cross-platform.
2279
# TODO: do more checks that the commit will succeed before
2280
# spending the user's valuable time typing a commit message.
2284
tree, selected_list = tree_files(selected_list)
2285
if selected_list == ['']:
2286
# workaround - commit of root of tree should be exactly the same
2287
# as just default commit in that tree, and succeed even though
2288
# selected-file merge commit is not done yet
2291
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2293
properties['bugs'] = bug_property
2295
if local and not tree.branch.get_bound_location():
2296
raise errors.LocalRequiresBoundBranch()
2298
def get_message(commit_obj):
2299
"""Callback to get commit message"""
2300
my_message = message
2301
if my_message is None and not file:
2302
t = make_commit_message_template_encoded(tree,
2303
selected_list, diff=show_diff,
2304
output_encoding=bzrlib.user_encoding)
2305
my_message = edit_commit_message_encoded(t)
2306
if my_message is None:
2307
raise errors.BzrCommandError("please specify a commit"
2308
" message with either --message or --file")
2309
elif my_message and file:
2310
raise errors.BzrCommandError(
2311
"please specify either --message or --file")
2313
my_message = codecs.open(file, 'rt',
2314
bzrlib.user_encoding).read()
2315
if my_message == "":
2316
raise errors.BzrCommandError("empty commit message specified")
2319
if verbose or not is_quiet():
2320
reporter = ReportCommitToLog()
2322
reporter = NullCommitReporter()
2325
tree.commit(message_callback=get_message,
2326
specific_files=selected_list,
2327
allow_pointless=unchanged, strict=strict, local=local,
2328
reporter=reporter, revprops=properties,
2330
except PointlessCommit:
2331
# FIXME: This should really happen before the file is read in;
2332
# perhaps prepare the commit; get the message; then actually commit
2333
raise errors.BzrCommandError("no changes to commit."
2334
" use --unchanged to commit anyhow")
2335
except ConflictsInTree:
2336
raise errors.BzrCommandError('Conflicts detected in working '
2337
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2339
except StrictCommitFailed:
2340
raise errors.BzrCommandError("Commit refused because there are"
2341
" unknown files in the working tree.")
2342
except errors.BoundBranchOutOfDate, e:
2343
raise errors.BzrCommandError(str(e) + "\n"
2344
'To commit to master branch, run update and then commit.\n'
2345
'You can also pass --local to commit to continue working '
2349
class cmd_check(Command):
2350
"""Validate consistency of branch history.
2352
This command checks various invariants about the branch storage to
2353
detect data corruption or bzr bugs.
2356
_see_also = ['reconcile']
2357
takes_args = ['branch?']
2358
takes_options = ['verbose']
2360
def run(self, branch=None, verbose=False):
2361
from bzrlib.check import check
2363
tree = WorkingTree.open_containing()[0]
2364
branch = tree.branch
2366
branch = Branch.open(branch)
2367
check(branch, verbose)
2370
class cmd_upgrade(Command):
2371
"""Upgrade branch storage to current format.
2373
The check command or bzr developers may sometimes advise you to run
2374
this command. When the default format has changed you may also be warned
2375
during other operations to upgrade.
2378
_see_also = ['check']
2379
takes_args = ['url?']
2381
RegistryOption('format',
2382
help='Upgrade to a specific format. See "bzr help'
2383
' formats" for details.',
2384
registry=bzrdir.format_registry,
2385
converter=bzrdir.format_registry.make_bzrdir,
2386
value_switches=True, title='Branch format'),
2389
def run(self, url='.', format=None):
2390
from bzrlib.upgrade import upgrade
2392
format = bzrdir.format_registry.make_bzrdir('default')
2393
upgrade(url, format)
2396
class cmd_whoami(Command):
2397
"""Show or set bzr user id.
2400
Show the email of the current user::
2404
Set the current user::
2406
bzr whoami 'Frank Chu <fchu@example.com>'
2408
takes_options = [ Option('email',
2409
help='Display email address only.'),
2411
help='Set identity for the current branch instead of '
2414
takes_args = ['name?']
2415
encoding_type = 'replace'
2418
def run(self, email=False, branch=False, name=None):
2420
# use branch if we're inside one; otherwise global config
2422
c = Branch.open_containing('.')[0].get_config()
2423
except errors.NotBranchError:
2424
c = config.GlobalConfig()
2426
self.outf.write(c.user_email() + '\n')
2428
self.outf.write(c.username() + '\n')
2431
# display a warning if an email address isn't included in the given name.
2433
config.extract_email_address(name)
2434
except errors.NoEmailInUsername, e:
2435
warning('"%s" does not seem to contain an email address. '
2436
'This is allowed, but not recommended.', name)
2438
# use global config unless --branch given
2440
c = Branch.open_containing('.')[0].get_config()
2442
c = config.GlobalConfig()
2443
c.set_user_option('email', name)
2446
class cmd_nick(Command):
2447
"""Print or set the branch nickname.
2449
If unset, the tree root directory name is used as the nickname
2450
To print the current nickname, execute with no argument.
2453
_see_also = ['info']
2454
takes_args = ['nickname?']
2455
def run(self, nickname=None):
2456
branch = Branch.open_containing(u'.')[0]
2457
if nickname is None:
2458
self.printme(branch)
2460
branch.nick = nickname
2463
def printme(self, branch):
2467
class cmd_selftest(Command):
2468
"""Run internal test suite.
2470
If arguments are given, they are regular expressions that say which tests
2471
should run. Tests matching any expression are run, and other tests are
2474
Alternatively if --first is given, matching tests are run first and then
2475
all other tests are run. This is useful if you have been working in a
2476
particular area, but want to make sure nothing else was broken.
2478
If --exclude is given, tests that match that regular expression are
2479
excluded, regardless of whether they match --first or not.
2481
To help catch accidential dependencies between tests, the --randomize
2482
option is useful. In most cases, the argument used is the word 'now'.
2483
Note that the seed used for the random number generator is displayed
2484
when this option is used. The seed can be explicitly passed as the
2485
argument to this option if required. This enables reproduction of the
2486
actual ordering used if and when an order sensitive problem is encountered.
2488
If --list-only is given, the tests that would be run are listed. This is
2489
useful when combined with --first, --exclude and/or --randomize to
2490
understand their impact. The test harness reports "Listed nn tests in ..."
2491
instead of "Ran nn tests in ..." when list mode is enabled.
2493
If the global option '--no-plugins' is given, plugins are not loaded
2494
before running the selftests. This has two effects: features provided or
2495
modified by plugins will not be tested, and tests provided by plugins will
2498
Tests that need working space on disk use a common temporary directory,
2499
typically inside $TMPDIR or /tmp.
2502
Run only tests relating to 'ignore'::
2506
Disable plugins and list tests as they're run::
2508
bzr --no-plugins selftest -v
2510
# NB: this is used from the class without creating an instance, which is
2511
# why it does not have a self parameter.
2512
def get_transport_type(typestring):
2513
"""Parse and return a transport specifier."""
2514
if typestring == "sftp":
2515
from bzrlib.transport.sftp import SFTPAbsoluteServer
2516
return SFTPAbsoluteServer
2517
if typestring == "memory":
2518
from bzrlib.transport.memory import MemoryServer
2520
if typestring == "fakenfs":
2521
from bzrlib.transport.fakenfs import FakeNFSServer
2522
return FakeNFSServer
2523
msg = "No known transport type %s. Supported types are: sftp\n" %\
2525
raise errors.BzrCommandError(msg)
2528
takes_args = ['testspecs*']
2529
takes_options = ['verbose',
2531
help='Stop when one test fails.',
2535
help='Use a different transport by default '
2536
'throughout the test suite.',
2537
type=get_transport_type),
2539
help='Run the benchmarks rather than selftests.'),
2540
Option('lsprof-timed',
2541
help='Generate lsprof output for benchmarked'
2542
' sections of code.'),
2543
Option('cache-dir', type=str,
2544
help='Cache intermediate benchmark output in this '
2547
help='Run all tests, but run specified tests first.',
2551
help='List the tests instead of running them.'),
2552
Option('randomize', type=str, argname="SEED",
2553
help='Randomize the order of tests using the given'
2554
' seed or "now" for the current time.'),
2555
Option('exclude', type=str, argname="PATTERN",
2557
help='Exclude tests that match this regular'
2559
Option('strict', help='Fail on missing dependencies or '
2562
encoding_type = 'replace'
2564
def run(self, testspecs_list=None, verbose=False, one=False,
2565
transport=None, benchmark=None,
2566
lsprof_timed=None, cache_dir=None,
2567
first=False, list_only=False,
2568
randomize=None, exclude=None, strict=False):
2570
from bzrlib.tests import selftest
2571
import bzrlib.benchmarks as benchmarks
2572
from bzrlib.benchmarks import tree_creator
2574
if cache_dir is not None:
2575
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2577
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2578
print ' %s (%s python%s)' % (
2580
bzrlib.version_string,
2581
'.'.join(map(str, sys.version_info)),
2584
if testspecs_list is not None:
2585
pattern = '|'.join(testspecs_list)
2589
test_suite_factory = benchmarks.test_suite
2590
# Unless user explicitly asks for quiet, be verbose in benchmarks
2591
verbose = not is_quiet()
2592
# TODO: should possibly lock the history file...
2593
benchfile = open(".perf_history", "at", buffering=1)
2595
test_suite_factory = None
2598
result = selftest(verbose=verbose,
2600
stop_on_failure=one,
2601
transport=transport,
2602
test_suite_factory=test_suite_factory,
2603
lsprof_timed=lsprof_timed,
2604
bench_history=benchfile,
2605
matching_tests_first=first,
2606
list_only=list_only,
2607
random_seed=randomize,
2608
exclude_pattern=exclude,
2612
if benchfile is not None:
2615
info('tests passed')
2617
info('tests failed')
2618
return int(not result)
2621
class cmd_version(Command):
2622
"""Show version of bzr."""
2624
encoding_type = 'replace'
2628
from bzrlib.version import show_version
2629
show_version(to_file=self.outf)
2632
class cmd_rocks(Command):
2633
"""Statement of optimism."""
2639
print "It sure does!"
2642
class cmd_find_merge_base(Command):
2643
"""Find and print a base revision for merging two branches."""
2644
# TODO: Options to specify revisions on either side, as if
2645
# merging only part of the history.
2646
takes_args = ['branch', 'other']
2650
def run(self, branch, other):
2651
from bzrlib.revision import ensure_null, MultipleRevisionSources
2653
branch1 = Branch.open_containing(branch)[0]
2654
branch2 = Branch.open_containing(other)[0]
2656
last1 = ensure_null(branch1.last_revision())
2657
last2 = ensure_null(branch2.last_revision())
2659
graph = branch1.repository.get_graph(branch2.repository)
2660
base_rev_id = graph.find_unique_lca(last1, last2)
2662
print 'merge base is revision %s' % base_rev_id
2665
class cmd_merge(Command):
2666
"""Perform a three-way merge.
2668
The branch is the branch you will merge from. By default, it will merge
2669
the latest revision. If you specify a revision, that revision will be
2670
merged. If you specify two revisions, the first will be used as a BASE,
2671
and the second one as OTHER. Revision numbers are always relative to the
2674
By default, bzr will try to merge in all new work from the other
2675
branch, automatically determining an appropriate base. If this
2676
fails, you may need to give an explicit base.
2678
Merge will do its best to combine the changes in two branches, but there
2679
are some kinds of problems only a human can fix. When it encounters those,
2680
it will mark a conflict. A conflict means that you need to fix something,
2681
before you should commit.
2683
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2685
If there is no default branch set, the first merge will set it. After
2686
that, you can omit the branch to use the default. To change the
2687
default, use --remember. The value will only be saved if the remote
2688
location can be accessed.
2690
The results of the merge are placed into the destination working
2691
directory, where they can be reviewed (with bzr diff), tested, and then
2692
committed to record the result of the merge.
2694
merge refuses to run if there are any uncommitted changes, unless
2698
To merge the latest revision from bzr.dev::
2700
bzr merge ../bzr.dev
2702
To merge changes up to and including revision 82 from bzr.dev::
2704
bzr merge -r 82 ../bzr.dev
2706
To merge the changes introduced by 82, without previous changes::
2708
bzr merge -r 81..82 ../bzr.dev
2711
_see_also = ['update', 'remerge', 'status-flags']
2712
takes_args = ['branch?']
2716
help='Merge even if the destination tree has uncommitted changes.'),
2720
Option('show-base', help="Show base revision text in "
2722
Option('uncommitted', help='Apply uncommitted changes'
2723
' from a working copy, instead of branch changes.'),
2724
Option('pull', help='If the destination is already'
2725
' completely merged into the source, pull from the'
2726
' source rather than merging. When this happens,'
2727
' you do not need to commit the result.'),
2729
help='Branch to merge into, '
2730
'rather than the one containing the working directory.',
2736
def run(self, branch=None, revision=None, force=False, merge_type=None,
2737
show_base=False, reprocess=False, remember=False,
2738
uncommitted=False, pull=False,
2741
from bzrlib.tag import _merge_tags_if_possible
2742
# This is actually a branch (or merge-directive) *location*.
2746
if merge_type is None:
2747
merge_type = _mod_merge.Merge3Merger
2749
if directory is None: directory = u'.'
2750
possible_transports = []
2752
allow_pending = True
2753
verified = 'inapplicable'
2754
tree = WorkingTree.open_containing(directory)[0]
2755
change_reporter = delta._ChangeReporter(
2756
unversioned_filter=tree.is_ignored)
2759
pb = ui.ui_factory.nested_progress_bar()
2760
cleanups.append(pb.finished)
2762
cleanups.append(tree.unlock)
2763
if location is not None:
2764
mergeable, other_transport = _get_mergeable_helper(location)
2767
raise errors.BzrCommandError('Cannot use --uncommitted'
2768
' with bundles or merge directives.')
2770
if revision is not None:
2771
raise errors.BzrCommandError(
2772
'Cannot use -r with merge directives or bundles')
2773
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2775
possible_transports.append(other_transport)
2777
if merger is None and uncommitted:
2778
if revision is not None and len(revision) > 0:
2779
raise errors.BzrCommandError('Cannot use --uncommitted and'
2780
' --revision at the same time.')
2781
location = self._select_branch_location(tree, location)[0]
2782
other_tree, other_path = WorkingTree.open_containing(location)
2783
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2785
allow_pending = False
2788
merger, allow_pending = self._get_merger_from_branch(tree,
2789
location, revision, remember, possible_transports, pb)
2791
merger.merge_type = merge_type
2792
merger.reprocess = reprocess
2793
merger.show_base = show_base
2794
merger.change_reporter = change_reporter
2795
self.sanity_check_merger(merger)
2796
if (merger.base_rev_id == merger.other_rev_id and
2797
merger.other_rev_id != None):
2798
note('Nothing to do.')
2801
if merger.interesting_files is not None:
2802
raise BzrCommandError('Cannot pull individual files')
2803
if (merger.base_rev_id == tree.last_revision()):
2804
result = tree.pull(merger.other_branch, False,
2805
merger.other_rev_id)
2806
result.report(self.outf)
2808
merger.check_basis(not force)
2809
conflict_count = merger.do_merge()
2811
merger.set_pending()
2812
if verified == 'failed':
2813
warning('Preview patch does not match changes')
2814
if conflict_count != 0:
2819
for cleanup in reversed(cleanups):
2822
def sanity_check_merger(self, merger):
2823
if (merger.show_base and
2824
not merger.merge_type is _mod_merge.Merge3Merger):
2825
raise errors.BzrCommandError("Show-base is not supported for this"
2826
" merge type. %s" % merger.merge_type)
2827
if merger.reprocess and not merger.merge_type.supports_reprocess:
2828
raise errors.BzrCommandError("Conflict reduction is not supported"
2829
" for merge type %s." %
2831
if merger.reprocess and merger.show_base:
2832
raise errors.BzrCommandError("Cannot do conflict reduction and"
2835
def _get_merger_from_branch(self, tree, location, revision, remember,
2836
possible_transports, pb):
2837
"""Produce a merger from a location, assuming it refers to a branch."""
2838
from bzrlib.tag import _merge_tags_if_possible
2839
assert revision is None or len(revision) < 3
2840
# find the branch locations
2841
other_loc, location = self._select_branch_location(tree, location,
2843
if revision is not None and len(revision) == 2:
2844
base_loc, location = self._select_branch_location(tree, location,
2847
base_loc = other_loc
2849
other_branch, other_path = Branch.open_containing(other_loc,
2850
possible_transports)
2851
if base_loc == other_loc:
2852
base_branch = other_branch
2854
base_branch, base_path = Branch.open_containing(base_loc,
2855
possible_transports)
2856
# Find the revision ids
2857
if revision is None or len(revision) < 1 or revision[-1] is None:
2858
other_revision_id = _mod_revision.ensure_null(
2859
other_branch.last_revision())
2861
other_revision_id = \
2862
_mod_revision.ensure_null(
2863
revision[-1].in_history(other_branch).rev_id)
2864
if (revision is not None and len(revision) == 2
2865
and revision[0] is not None):
2866
base_revision_id = \
2867
_mod_revision.ensure_null(
2868
revision[0].in_history(base_branch).rev_id)
2870
base_revision_id = None
2871
# Remember where we merge from
2872
if ((tree.branch.get_parent() is None or remember) and
2873
other_branch is not None):
2874
tree.branch.set_parent(other_branch.base)
2875
_merge_tags_if_possible(other_branch, tree.branch)
2876
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2877
other_revision_id, base_revision_id, other_branch, base_branch)
2878
if other_path != '':
2879
allow_pending = False
2880
merger.interesting_files = [other_path]
2882
allow_pending = True
2883
return merger, allow_pending
2885
def _select_branch_location(self, tree, location, revision=None,
2887
"""Select a branch location, according to possible inputs.
2889
If provided, branches from ``revision`` are preferred. (Both
2890
``revision`` and ``index`` must be supplied.)
2892
Otherwise, the ``location`` parameter is used. If it is None, then the
2893
``parent`` location is used, and a note is printed.
2895
:param tree: The working tree to select a branch for merging into
2896
:param location: The location entered by the user
2897
:param revision: The revision parameter to the command
2898
:param index: The index to use for the revision parameter. Negative
2899
indices are permitted.
2900
:return: (selected_location, default_location). The default location
2901
will be the user-entered location, if any, or else the remembered
2904
if (revision is not None and index is not None
2905
and revision[index] is not None):
2906
branch = revision[index].get_branch()
2907
if branch is not None:
2908
return branch, location
2909
location = self._get_remembered_parent(tree, location, 'Merging from')
2910
return location, location
2912
# TODO: move up to common parent; this isn't merge-specific anymore.
2913
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2914
"""Use tree.branch's parent if none was supplied.
2916
Report if the remembered location was used.
2918
if supplied_location is not None:
2919
return supplied_location
2920
stored_location = tree.branch.get_parent()
2921
mutter("%s", stored_location)
2922
if stored_location is None:
2923
raise errors.BzrCommandError("No location specified or remembered")
2924
display_url = urlutils.unescape_for_display(stored_location,
2926
self.outf.write("%s remembered location %s\n" % (verb_string,
2928
return stored_location
2931
class cmd_remerge(Command):
2934
Use this if you want to try a different merge technique while resolving
2935
conflicts. Some merge techniques are better than others, and remerge
2936
lets you try different ones on different files.
2938
The options for remerge have the same meaning and defaults as the ones for
2939
merge. The difference is that remerge can (only) be run when there is a
2940
pending merge, and it lets you specify particular files.
2943
Re-do the merge of all conflicted files, and show the base text in
2944
conflict regions, in addition to the usual THIS and OTHER texts::
2946
bzr remerge --show-base
2948
Re-do the merge of "foobar", using the weave merge algorithm, with
2949
additional processing to reduce the size of conflict regions::
2951
bzr remerge --merge-type weave --reprocess foobar
2953
takes_args = ['file*']
2958
help="Show base revision text in conflicts."),
2961
def run(self, file_list=None, merge_type=None, show_base=False,
2963
if merge_type is None:
2964
merge_type = _mod_merge.Merge3Merger
2965
tree, file_list = tree_files(file_list)
2968
parents = tree.get_parent_ids()
2969
if len(parents) != 2:
2970
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2971
" merges. Not cherrypicking or"
2973
repository = tree.branch.repository
2974
graph = repository.get_graph()
2975
base_revision = graph.find_unique_lca(parents[0], parents[1])
2976
base_tree = repository.revision_tree(base_revision)
2977
other_tree = repository.revision_tree(parents[1])
2978
interesting_ids = None
2980
conflicts = tree.conflicts()
2981
if file_list is not None:
2982
interesting_ids = set()
2983
for filename in file_list:
2984
file_id = tree.path2id(filename)
2986
raise errors.NotVersionedError(filename)
2987
interesting_ids.add(file_id)
2988
if tree.kind(file_id) != "directory":
2991
for name, ie in tree.inventory.iter_entries(file_id):
2992
interesting_ids.add(ie.file_id)
2993
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2995
# Remerge only supports resolving contents conflicts
2996
allowed_conflicts = ('text conflict', 'contents conflict')
2997
restore_files = [c.path for c in conflicts
2998
if c.typestring in allowed_conflicts]
2999
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3000
tree.set_conflicts(ConflictList(new_conflicts))
3001
if file_list is not None:
3002
restore_files = file_list
3003
for filename in restore_files:
3005
restore(tree.abspath(filename))
3006
except errors.NotConflicted:
3008
# Disable pending merges, because the file texts we are remerging
3009
# have not had those merges performed. If we use the wrong parents
3010
# list, we imply that the working tree text has seen and rejected
3011
# all the changes from the other tree, when in fact those changes
3012
# have not yet been seen.
3013
tree.set_parent_ids(parents[:1])
3015
conflicts = _mod_merge.merge_inner(
3016
tree.branch, other_tree, base_tree,
3018
interesting_ids=interesting_ids,
3019
other_rev_id=parents[1],
3020
merge_type=merge_type,
3021
show_base=show_base,
3022
reprocess=reprocess)
3024
tree.set_parent_ids(parents)
3033
class cmd_revert(Command):
3034
"""Revert files to a previous revision.
3036
Giving a list of files will revert only those files. Otherwise, all files
3037
will be reverted. If the revision is not specified with '--revision', the
3038
last committed revision is used.
3040
To remove only some changes, without reverting to a prior version, use
3041
merge instead. For example, "merge . --r-2..-3" will remove the changes
3042
introduced by -2, without affecting the changes introduced by -1. Or
3043
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3045
By default, any files that have been manually changed will be backed up
3046
first. (Files changed only by merge are not backed up.) Backup files have
3047
'.~#~' appended to their name, where # is a number.
3049
When you provide files, you can use their current pathname or the pathname
3050
from the target revision. So you can use revert to "undelete" a file by
3051
name. If you name a directory, all the contents of that directory will be
3054
Any files that have been newly added since that revision will be deleted,
3055
with a backup kept if appropriate. Directories containing unknown files
3056
will not be deleted.
3059
_see_also = ['cat', 'export']
3062
Option('no-backup', "Do not save backups of reverted files."),
3064
takes_args = ['file*']
3066
def run(self, revision=None, no_backup=False, file_list=None):
3067
if file_list is not None:
3068
if len(file_list) == 0:
3069
raise errors.BzrCommandError("No files specified")
3071
tree, file_list = tree_files(file_list)
3072
if revision is None:
3073
# FIXME should be tree.last_revision
3074
rev_id = tree.last_revision()
3075
elif len(revision) != 1:
3076
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3078
rev_id = revision[0].in_history(tree.branch).rev_id
3079
pb = ui.ui_factory.nested_progress_bar()
3081
tree.revert(file_list,
3082
tree.branch.repository.revision_tree(rev_id),
3083
not no_backup, pb, report_changes=True)
3088
class cmd_assert_fail(Command):
3089
"""Test reporting of assertion failures"""
3090
# intended just for use in testing
3095
raise AssertionError("always fails")
3098
class cmd_help(Command):
3099
"""Show help on a command or other topic.
3102
_see_also = ['topics']
3104
Option('long', 'Show help on all commands.'),
3106
takes_args = ['topic?']
3107
aliases = ['?', '--help', '-?', '-h']
3110
def run(self, topic=None, long=False):
3112
if topic is None and long:
3114
bzrlib.help.help(topic)
3117
class cmd_shell_complete(Command):
3118
"""Show appropriate completions for context.
3120
For a list of all available commands, say 'bzr shell-complete'.
3122
takes_args = ['context?']
3127
def run(self, context=None):
3128
import shellcomplete
3129
shellcomplete.shellcomplete(context)
3132
class cmd_fetch(Command):
3133
"""Copy in history from another branch but don't merge it.
3135
This is an internal method used for pull and merge.
3138
takes_args = ['from_branch', 'to_branch']
3139
def run(self, from_branch, to_branch):
3140
from bzrlib.fetch import Fetcher
3141
from_b = Branch.open(from_branch)
3142
to_b = Branch.open(to_branch)
3143
Fetcher(to_b, from_b)
3146
class cmd_missing(Command):
3147
"""Show unmerged/unpulled revisions between two branches.
3149
OTHER_BRANCH may be local or remote.
3152
_see_also = ['merge', 'pull']
3153
takes_args = ['other_branch?']
3155
Option('reverse', 'Reverse the order of revisions.'),
3157
'Display changes in the local branch only.'),
3158
Option('this' , 'Same as --mine-only.'),
3159
Option('theirs-only',
3160
'Display changes in the remote branch only.'),
3161
Option('other', 'Same as --theirs-only.'),
3166
encoding_type = 'replace'
3169
def run(self, other_branch=None, reverse=False, mine_only=False,
3170
theirs_only=False, log_format=None, long=False, short=False, line=False,
3171
show_ids=False, verbose=False, this=False, other=False):
3172
from bzrlib.missing import find_unmerged, iter_log_revisions
3173
from bzrlib.log import log_formatter
3180
local_branch = Branch.open_containing(u".")[0]
3181
parent = local_branch.get_parent()
3182
if other_branch is None:
3183
other_branch = parent
3184
if other_branch is None:
3185
raise errors.BzrCommandError("No peer location known"
3187
display_url = urlutils.unescape_for_display(parent,
3189
self.outf.write("Using last location: " + display_url + "\n")
3191
remote_branch = Branch.open(other_branch)
3192
if remote_branch.base == local_branch.base:
3193
remote_branch = local_branch
3194
local_branch.lock_read()
3196
remote_branch.lock_read()
3198
local_extra, remote_extra = find_unmerged(local_branch,
3200
if log_format is None:
3201
registry = log.log_formatter_registry
3202
log_format = registry.get_default(local_branch)
3203
lf = log_format(to_file=self.outf,
3205
show_timezone='original')
3206
if reverse is False:
3207
local_extra.reverse()
3208
remote_extra.reverse()
3209
if local_extra and not theirs_only:
3210
self.outf.write("You have %d extra revision(s):\n" %
3212
for revision in iter_log_revisions(local_extra,
3213
local_branch.repository,
3215
lf.log_revision(revision)
3216
printed_local = True
3218
printed_local = False
3219
if remote_extra and not mine_only:
3220
if printed_local is True:
3221
self.outf.write("\n\n\n")
3222
self.outf.write("You are missing %d revision(s):\n" %
3224
for revision in iter_log_revisions(remote_extra,
3225
remote_branch.repository,
3227
lf.log_revision(revision)
3228
if not remote_extra and not local_extra:
3230
self.outf.write("Branches are up to date.\n")
3234
remote_branch.unlock()
3236
local_branch.unlock()
3237
if not status_code and parent is None and other_branch is not None:
3238
local_branch.lock_write()
3240
# handle race conditions - a parent might be set while we run.
3241
if local_branch.get_parent() is None:
3242
local_branch.set_parent(remote_branch.base)
3244
local_branch.unlock()
3248
class cmd_pack(Command):
3249
"""Compress the data within a repository."""
3251
_see_also = ['repositories']
3252
takes_args = ['branch_or_repo?']
3254
def run(self, branch_or_repo='.'):
3255
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3257
branch = dir.open_branch()
3258
repository = branch.repository
3259
except errors.NotBranchError:
3260
repository = dir.open_repository()
3264
class cmd_plugins(Command):
3265
"""List the installed plugins.
3267
This command displays the list of installed plugins including the
3268
path where each one is located and a short description of each.
3270
A plugin is an external component for Bazaar that extends the
3271
revision control system, by adding or replacing code in Bazaar.
3272
Plugins can do a variety of things, including overriding commands,
3273
adding new commands, providing additional network transports and
3274
customizing log output.
3276
See the Bazaar web site, http://bazaar-vcs.org, for further
3277
information on plugins including where to find them and how to
3278
install them. Instructions are also provided there on how to
3279
write new plugins using the Python programming language.
3284
import bzrlib.plugin
3285
from inspect import getdoc
3286
for name, plugin in bzrlib.plugin.plugins().items():
3287
print plugin.path(), "[%s]" % plugin.__version__
3288
d = getdoc(plugin.module)
3290
print '\t', d.split('\n')[0]
3293
class cmd_testament(Command):
3294
"""Show testament (signing-form) of a revision."""
3297
Option('long', help='Produce long-format testament.'),
3299
help='Produce a strict-format testament.')]
3300
takes_args = ['branch?']
3302
def run(self, branch=u'.', revision=None, long=False, strict=False):
3303
from bzrlib.testament import Testament, StrictTestament
3305
testament_class = StrictTestament
3307
testament_class = Testament
3308
b = WorkingTree.open_containing(branch)[0].branch
3311
if revision is None:
3312
rev_id = b.last_revision()
3314
rev_id = revision[0].in_history(b).rev_id
3315
t = testament_class.from_revision(b.repository, rev_id)
3317
sys.stdout.writelines(t.as_text_lines())
3319
sys.stdout.write(t.as_short_text())
3324
class cmd_annotate(Command):
3325
"""Show the origin of each line in a file.
3327
This prints out the given file with an annotation on the left side
3328
indicating which revision, author and date introduced the change.
3330
If the origin is the same for a run of consecutive lines, it is
3331
shown only at the top, unless the --all option is given.
3333
# TODO: annotate directories; showing when each file was last changed
3334
# TODO: if the working copy is modified, show annotations on that
3335
# with new uncommitted lines marked
3336
aliases = ['ann', 'blame', 'praise']
3337
takes_args = ['filename']
3338
takes_options = [Option('all', help='Show annotations on all lines.'),
3339
Option('long', help='Show commit date in annotations.'),
3343
encoding_type = 'exact'
3346
def run(self, filename, all=False, long=False, revision=None,
3348
from bzrlib.annotate import annotate_file
3349
tree, relpath = WorkingTree.open_containing(filename)
3350
branch = tree.branch
3353
if revision is None:
3354
revision_id = branch.last_revision()
3355
elif len(revision) != 1:
3356
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3358
revision_id = revision[0].in_history(branch).rev_id
3359
file_id = tree.path2id(relpath)
3361
raise errors.NotVersionedError(filename)
3362
tree = branch.repository.revision_tree(revision_id)
3363
file_version = tree.inventory[file_id].revision
3364
annotate_file(branch, file_version, file_id, long, all, self.outf,
3370
class cmd_re_sign(Command):
3371
"""Create a digital signature for an existing revision."""
3372
# TODO be able to replace existing ones.
3374
hidden = True # is this right ?
3375
takes_args = ['revision_id*']
3376
takes_options = ['revision']
3378
def run(self, revision_id_list=None, revision=None):
3379
import bzrlib.gpg as gpg
3380
if revision_id_list is not None and revision is not None:
3381
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3382
if revision_id_list is None and revision is None:
3383
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3384
b = WorkingTree.open_containing(u'.')[0].branch
3385
gpg_strategy = gpg.GPGStrategy(b.get_config())
3386
if revision_id_list is not None:
3387
for revision_id in revision_id_list:
3388
b.repository.sign_revision(revision_id, gpg_strategy)
3389
elif revision is not None:
3390
if len(revision) == 1:
3391
revno, rev_id = revision[0].in_history(b)
3392
b.repository.sign_revision(rev_id, gpg_strategy)
3393
elif len(revision) == 2:
3394
# are they both on rh- if so we can walk between them
3395
# might be nice to have a range helper for arbitrary
3396
# revision paths. hmm.
3397
from_revno, from_revid = revision[0].in_history(b)
3398
to_revno, to_revid = revision[1].in_history(b)
3399
if to_revid is None:
3400
to_revno = b.revno()
3401
if from_revno is None or to_revno is None:
3402
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3403
for revno in range(from_revno, to_revno + 1):
3404
b.repository.sign_revision(b.get_rev_id(revno),
3407
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3410
class cmd_bind(Command):
3411
"""Convert the current branch into a checkout of the supplied branch.
3413
Once converted into a checkout, commits must succeed on the master branch
3414
before they will be applied to the local branch.
3417
_see_also = ['checkouts', 'unbind']
3418
takes_args = ['location?']
3421
def run(self, location=None):
3422
b, relpath = Branch.open_containing(u'.')
3423
if location is None:
3425
location = b.get_old_bound_location()
3426
except errors.UpgradeRequired:
3427
raise errors.BzrCommandError('No location supplied. '
3428
'This format does not remember old locations.')
3430
if location is None:
3431
raise errors.BzrCommandError('No location supplied and no '
3432
'previous location known')
3433
b_other = Branch.open(location)
3436
except errors.DivergedBranches:
3437
raise errors.BzrCommandError('These branches have diverged.'
3438
' Try merging, and then bind again.')
3441
class cmd_unbind(Command):
3442
"""Convert the current checkout into a regular branch.
3444
After unbinding, the local branch is considered independent and subsequent
3445
commits will be local only.
3448
_see_also = ['checkouts', 'bind']
3453
b, relpath = Branch.open_containing(u'.')
3455
raise errors.BzrCommandError('Local branch is not bound')
3458
class cmd_uncommit(Command):
3459
"""Remove the last committed revision.
3461
--verbose will print out what is being removed.
3462
--dry-run will go through all the motions, but not actually
3465
If --revision is specified, uncommit revisions to leave the branch at the
3466
specified revision. For example, "bzr uncommit -r 15" will leave the
3467
branch at revision 15.
3469
In the future, uncommit will create a revision bundle, which can then
3473
# TODO: jam 20060108 Add an option to allow uncommit to remove
3474
# unreferenced information in 'branch-as-repository' branches.
3475
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3476
# information in shared branches as well.
3477
_see_also = ['commit']
3478
takes_options = ['verbose', 'revision',
3479
Option('dry-run', help='Don\'t actually make changes.'),
3480
Option('force', help='Say yes to all questions.')]
3481
takes_args = ['location?']
3484
def run(self, location=None,
3485
dry_run=False, verbose=False,
3486
revision=None, force=False):
3487
from bzrlib.log import log_formatter, show_log
3489
from bzrlib.uncommit import uncommit
3491
if location is None:
3493
control, relpath = bzrdir.BzrDir.open_containing(location)
3495
tree = control.open_workingtree()
3497
except (errors.NoWorkingTree, errors.NotLocalUrl):
3499
b = control.open_branch()
3502
if revision is None:
3505
# 'bzr uncommit -r 10' actually means uncommit
3506
# so that the final tree is at revno 10.
3507
# but bzrlib.uncommit.uncommit() actually uncommits
3508
# the revisions that are supplied.
3509
# So we need to offset it by one
3510
revno = revision[0].in_history(b).revno+1
3512
if revno <= b.revno():
3513
rev_id = b.get_rev_id(revno)
3515
self.outf.write('No revisions to uncommit.\n')
3518
lf = log_formatter('short',
3520
show_timezone='original')
3525
direction='forward',
3526
start_revision=revno,
3527
end_revision=b.revno())
3530
print 'Dry-run, pretending to remove the above revisions.'
3532
val = raw_input('Press <enter> to continue')
3534
print 'The above revision(s) will be removed.'
3536
val = raw_input('Are you sure [y/N]? ')
3537
if val.lower() not in ('y', 'yes'):
3541
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3545
class cmd_break_lock(Command):
3546
"""Break a dead lock on a repository, branch or working directory.
3548
CAUTION: Locks should only be broken when you are sure that the process
3549
holding the lock has been stopped.
3551
You can get information on what locks are open via the 'bzr info' command.
3556
takes_args = ['location?']
3558
def run(self, location=None, show=False):
3559
if location is None:
3561
control, relpath = bzrdir.BzrDir.open_containing(location)
3563
control.break_lock()
3564
except NotImplementedError:
3568
class cmd_wait_until_signalled(Command):
3569
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3571
This just prints a line to signal when it is ready, then blocks on stdin.
3577
sys.stdout.write("running\n")
3579
sys.stdin.readline()
3582
class cmd_serve(Command):
3583
"""Run the bzr server."""
3585
aliases = ['server']
3589
help='Serve on stdin/out for use from inetd or sshd.'),
3591
help='Listen for connections on nominated port of the form '
3592
'[hostname:]portnumber. Passing 0 as the port number will '
3593
'result in a dynamically allocated port. The default port is '
3597
help='Serve contents of this directory.',
3599
Option('allow-writes',
3600
help='By default the server is a readonly server. Supplying '
3601
'--allow-writes enables write access to the contents of '
3602
'the served directory and below.'
3606
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3607
from bzrlib.smart import medium, server
3608
from bzrlib.transport import get_transport
3609
from bzrlib.transport.chroot import ChrootServer
3610
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3611
if directory is None:
3612
directory = os.getcwd()
3613
url = urlutils.local_path_to_url(directory)
3614
if not allow_writes:
3615
url = 'readonly+' + url
3616
chroot_server = ChrootServer(get_transport(url))
3617
chroot_server.setUp()
3618
t = get_transport(chroot_server.get_url())
3620
smart_server = medium.SmartServerPipeStreamMedium(
3621
sys.stdin, sys.stdout, t)
3623
host = BZR_DEFAULT_INTERFACE
3625
port = BZR_DEFAULT_PORT
3628
host, port = port.split(':')
3630
smart_server = server.SmartTCPServer(t, host=host, port=port)
3631
print 'listening on port: ', smart_server.port
3633
# for the duration of this server, no UI output is permitted.
3634
# note that this may cause problems with blackbox tests. This should
3635
# be changed with care though, as we dont want to use bandwidth sending
3636
# progress over stderr to smart server clients!
3637
old_factory = ui.ui_factory
3639
ui.ui_factory = ui.SilentUIFactory()
3640
smart_server.serve()
3642
ui.ui_factory = old_factory
3645
class cmd_join(Command):
3646
"""Combine a subtree into its containing tree.
3648
This command is for experimental use only. It requires the target tree
3649
to be in dirstate-with-subtree format, which cannot be converted into
3652
The TREE argument should be an independent tree, inside another tree, but
3653
not part of it. (Such trees can be produced by "bzr split", but also by
3654
running "bzr branch" with the target inside a tree.)
3656
The result is a combined tree, with the subtree no longer an independant
3657
part. This is marked as a merge of the subtree into the containing tree,
3658
and all history is preserved.
3660
If --reference is specified, the subtree retains its independence. It can
3661
be branched by itself, and can be part of multiple projects at the same
3662
time. But operations performed in the containing tree, such as commit
3663
and merge, will recurse into the subtree.
3666
_see_also = ['split']
3667
takes_args = ['tree']
3669
Option('reference', help='Join by reference.'),
3673
def run(self, tree, reference=False):
3674
sub_tree = WorkingTree.open(tree)
3675
parent_dir = osutils.dirname(sub_tree.basedir)
3676
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3677
repo = containing_tree.branch.repository
3678
if not repo.supports_rich_root():
3679
raise errors.BzrCommandError(
3680
"Can't join trees because %s doesn't support rich root data.\n"
3681
"You can use bzr upgrade on the repository."
3685
containing_tree.add_reference(sub_tree)
3686
except errors.BadReferenceTarget, e:
3687
# XXX: Would be better to just raise a nicely printable
3688
# exception from the real origin. Also below. mbp 20070306
3689
raise errors.BzrCommandError("Cannot join %s. %s" %
3693
containing_tree.subsume(sub_tree)
3694
except errors.BadSubsumeSource, e:
3695
raise errors.BzrCommandError("Cannot join %s. %s" %
3699
class cmd_split(Command):
3700
"""Split a tree into two trees.
3702
This command is for experimental use only. It requires the target tree
3703
to be in dirstate-with-subtree format, which cannot be converted into
3706
The TREE argument should be a subdirectory of a working tree. That
3707
subdirectory will be converted into an independent tree, with its own
3708
branch. Commits in the top-level tree will not apply to the new subtree.
3709
If you want that behavior, do "bzr join --reference TREE".
3712
_see_also = ['join']
3713
takes_args = ['tree']
3717
def run(self, tree):
3718
containing_tree, subdir = WorkingTree.open_containing(tree)
3719
sub_id = containing_tree.path2id(subdir)
3721
raise errors.NotVersionedError(subdir)
3723
containing_tree.extract(sub_id)
3724
except errors.RootNotRich:
3725
raise errors.UpgradeRequired(containing_tree.branch.base)
3729
class cmd_merge_directive(Command):
3730
"""Generate a merge directive for auto-merge tools.
3732
A directive requests a merge to be performed, and also provides all the
3733
information necessary to do so. This means it must either include a
3734
revision bundle, or the location of a branch containing the desired
3737
A submit branch (the location to merge into) must be supplied the first
3738
time the command is issued. After it has been supplied once, it will
3739
be remembered as the default.
3741
A public branch is optional if a revision bundle is supplied, but required
3742
if --diff or --plain is specified. It will be remembered as the default
3743
after the first use.
3746
takes_args = ['submit_branch?', 'public_branch?']
3750
_see_also = ['send']
3753
RegistryOption.from_kwargs('patch-type',
3754
'The type of patch to include in the directive.',
3756
value_switches=True,
3758
bundle='Bazaar revision bundle (default).',
3759
diff='Normal unified diff.',
3760
plain='No patch, just directive.'),
3761
Option('sign', help='GPG-sign the directive.'), 'revision',
3762
Option('mail-to', type=str,
3763
help='Instead of printing the directive, email to this address.'),
3764
Option('message', type=str, short_name='m',
3765
help='Message to use when committing this merge.')
3768
encoding_type = 'exact'
3770
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3771
sign=False, revision=None, mail_to=None, message=None):
3772
from bzrlib.revision import ensure_null, NULL_REVISION
3773
include_patch, include_bundle = {
3774
'plain': (False, False),
3775
'diff': (True, False),
3776
'bundle': (True, True),
3778
branch = Branch.open('.')
3779
stored_submit_branch = branch.get_submit_branch()
3780
if submit_branch is None:
3781
submit_branch = stored_submit_branch
3783
if stored_submit_branch is None:
3784
branch.set_submit_branch(submit_branch)
3785
if submit_branch is None:
3786
submit_branch = branch.get_parent()
3787
if submit_branch is None:
3788
raise errors.BzrCommandError('No submit branch specified or known')
3790
stored_public_branch = branch.get_public_branch()
3791
if public_branch is None:
3792
public_branch = stored_public_branch
3793
elif stored_public_branch is None:
3794
branch.set_public_branch(public_branch)
3795
if not include_bundle and public_branch is None:
3796
raise errors.BzrCommandError('No public branch specified or'
3798
base_revision_id = None
3799
if revision is not None:
3800
if len(revision) > 2:
3801
raise errors.BzrCommandError('bzr merge-directive takes '
3802
'at most two one revision identifiers')
3803
revision_id = revision[-1].in_history(branch).rev_id
3804
if len(revision) == 2:
3805
base_revision_id = revision[0].in_history(branch).rev_id
3806
base_revision_id = ensure_null(base_revision_id)
3808
revision_id = branch.last_revision()
3809
revision_id = ensure_null(revision_id)
3810
if revision_id == NULL_REVISION:
3811
raise errors.BzrCommandError('No revisions to bundle.')
3812
directive = merge_directive.MergeDirective2.from_objects(
3813
branch.repository, revision_id, time.time(),
3814
osutils.local_time_offset(), submit_branch,
3815
public_branch=public_branch, include_patch=include_patch,
3816
include_bundle=include_bundle, message=message,
3817
base_revision_id=base_revision_id)
3820
self.outf.write(directive.to_signed(branch))
3822
self.outf.writelines(directive.to_lines())
3824
message = directive.to_email(mail_to, branch, sign)
3825
s = SMTPConnection(branch.get_config())
3826
s.send_email(message)
3829
class cmd_send(Command):
3830
"""Mail or create a merge-directive for submiting changes.
3832
A merge directive provides many things needed for requesting merges:
3834
* A machine-readable description of the merge to perform
3836
* An optional patch that is a preview of the changes requested
3838
* An optional bundle of revision data, so that the changes can be applied
3839
directly from the merge directive, without retrieving data from a
3842
If --no-bundle is specified, then public_branch is needed (and must be
3843
up-to-date), so that the receiver can perform the merge using the
3844
public_branch. The public_branch is always included if known, so that
3845
people can check it later.
3847
The submit branch defaults to the parent, but can be overridden. Both
3848
submit branch and public branch will be remembered if supplied.
3850
If a public_branch is known for the submit_branch, that public submit
3851
branch is used in the merge instructions. This means that a local mirror
3852
can be used as your actual submit branch, once you have set public_branch
3855
Mail is sent using your preferred mail program. This should be transparent
3856
on Windows (it uses MAPI). On *nix, it requires the xdg-email utility. If
3857
the preferred client can't be found (or used), your editor will be used.
3859
To use a specific mail program, set the mail_client configuration option.
3860
(For Thunderbird 1.5, this works around some bugs.) Supported values are
3861
"thunderbird", "evolution", "editor", "xdg-email", "mapi", "kmail" and
3864
If mail is being sent, a to address is required. This can be supplied
3865
either on the commandline, or by setting the submit_to configuration
3868
Two formats are currently supported: "4" uses revision bundle format 4 and
3869
merge directive format 2. It is significantly faster and smaller than
3870
older formats. It is compatible with Bazaar 0.19 and later. It is the
3871
default. "0.9" uses revision bundle format 0.9 and merge directive
3872
format 1. It is compatible with Bazaar 0.12 - 0.18.
3875
encoding_type = 'exact'
3877
_see_also = ['merge']
3879
takes_args = ['submit_branch?', 'public_branch?']
3883
help='Do not include a bundle in the merge directive.'),
3884
Option('no-patch', help='Do not include a preview patch in the merge'
3887
help='Remember submit and public branch.'),
3889
help='Branch to generate the submission from, '
3890
'rather than the one containing the working directory.',
3893
Option('output', short_name='o', help='Write directive to this file.',
3895
Option('mail-to', help='Mail the request to this address.',
3899
RegistryOption.from_kwargs('format',
3900
'Use the specified output format.',
3901
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
3902
'0.9': 'Bundle format 0.9, Merge Directive 1',})
3905
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3906
no_patch=False, revision=None, remember=False, output=None,
3907
format='4', mail_to=None, message=None, **kwargs):
3908
return self._run(submit_branch, revision, public_branch, remember,
3909
format, no_bundle, no_patch, output,
3910
kwargs.get('from', '.'), mail_to, message)
3912
def _run(self, submit_branch, revision, public_branch, remember, format,
3913
no_bundle, no_patch, output, from_, mail_to, message):
3914
from bzrlib.revision import ensure_null, NULL_REVISION
3916
outfile = StringIO()
3920
outfile = open(output, 'wb')
3922
branch = Branch.open_containing(from_)[0]
3924
config = branch.get_config()
3926
mail_to = config.get_user_option('submit_to')
3928
raise errors.BzrCommandError('No mail-to address'
3930
mail_client = config.get_mail_client()
3931
if remember and submit_branch is None:
3932
raise errors.BzrCommandError(
3933
'--remember requires a branch to be specified.')
3934
stored_submit_branch = branch.get_submit_branch()
3935
remembered_submit_branch = False
3936
if submit_branch is None:
3937
submit_branch = stored_submit_branch
3938
remembered_submit_branch = True
3940
if stored_submit_branch is None or remember:
3941
branch.set_submit_branch(submit_branch)
3942
if submit_branch is None:
3943
submit_branch = branch.get_parent()
3944
remembered_submit_branch = True
3945
if submit_branch is None:
3946
raise errors.BzrCommandError('No submit branch known or'
3948
if remembered_submit_branch:
3949
note('Using saved location: %s', submit_branch)
3951
stored_public_branch = branch.get_public_branch()
3952
if public_branch is None:
3953
public_branch = stored_public_branch
3954
elif stored_public_branch is None or remember:
3955
branch.set_public_branch(public_branch)
3956
if no_bundle and public_branch is None:
3957
raise errors.BzrCommandError('No public branch specified or'
3959
base_revision_id = None
3961
if revision is not None:
3962
if len(revision) > 2:
3963
raise errors.BzrCommandError('bzr send takes '
3964
'at most two one revision identifiers')
3965
revision_id = revision[-1].in_history(branch).rev_id
3966
if len(revision) == 2:
3967
base_revision_id = revision[0].in_history(branch).rev_id
3968
if revision_id is None:
3969
revision_id = branch.last_revision()
3970
if revision_id == NULL_REVISION:
3971
raise errors.BzrCommandError('No revisions to submit.')
3973
directive = merge_directive.MergeDirective2.from_objects(
3974
branch.repository, revision_id, time.time(),
3975
osutils.local_time_offset(), submit_branch,
3976
public_branch=public_branch, include_patch=not no_patch,
3977
include_bundle=not no_bundle, message=message,
3978
base_revision_id=base_revision_id)
3979
elif format == '0.9':
3982
patch_type = 'bundle'
3984
raise errors.BzrCommandError('Format 0.9 does not'
3985
' permit bundle with no patch')
3991
directive = merge_directive.MergeDirective.from_objects(
3992
branch.repository, revision_id, time.time(),
3993
osutils.local_time_offset(), submit_branch,
3994
public_branch=public_branch, patch_type=patch_type,
3997
outfile.writelines(directive.to_lines())
3999
subject = '[MERGE] '
4000
if message is not None:
4003
revision = branch.repository.get_revision(revision_id)
4004
subject += revision.get_summary()
4005
mail_client.compose_merge_request(mail_to, subject,
4012
class cmd_bundle_revisions(cmd_send):
4014
"""Create a merge-directive for submiting changes.
4016
A merge directive provides many things needed for requesting merges:
4018
* A machine-readable description of the merge to perform
4020
* An optional patch that is a preview of the changes requested
4022
* An optional bundle of revision data, so that the changes can be applied
4023
directly from the merge directive, without retrieving data from a
4026
If --no-bundle is specified, then public_branch is needed (and must be
4027
up-to-date), so that the receiver can perform the merge using the
4028
public_branch. The public_branch is always included if known, so that
4029
people can check it later.
4031
The submit branch defaults to the parent, but can be overridden. Both
4032
submit branch and public branch will be remembered if supplied.
4034
If a public_branch is known for the submit_branch, that public submit
4035
branch is used in the merge instructions. This means that a local mirror
4036
can be used as your actual submit branch, once you have set public_branch
4039
Two formats are currently supported: "4" uses revision bundle format 4 and
4040
merge directive format 2. It is significantly faster and smaller than
4041
older formats. It is compatible with Bazaar 0.19 and later. It is the
4042
default. "0.9" uses revision bundle format 0.9 and merge directive
4043
format 1. It is compatible with Bazaar 0.12 - 0.18.
4048
help='Do not include a bundle in the merge directive.'),
4049
Option('no-patch', help='Do not include a preview patch in the merge'
4052
help='Remember submit and public branch.'),
4054
help='Branch to generate the submission from, '
4055
'rather than the one containing the working directory.',
4058
Option('output', short_name='o', help='Write directive to this file.',
4061
RegistryOption.from_kwargs('format',
4062
'Use the specified output format.',
4063
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4064
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4066
aliases = ['bundle']
4068
_see_also = ['send', 'merge']
4072
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4073
no_patch=False, revision=None, remember=False, output=None,
4074
format='4', **kwargs):
4077
return self._run(submit_branch, revision, public_branch, remember,
4078
format, no_bundle, no_patch, output,
4079
kwargs.get('from', '.'), None, None)
4082
class cmd_tag(Command):
4083
"""Create, remove or modify a tag naming a revision.
4085
Tags give human-meaningful names to revisions. Commands that take a -r
4086
(--revision) option can be given -rtag:X, where X is any previously
4089
Tags are stored in the branch. Tags are copied from one branch to another
4090
along when you branch, push, pull or merge.
4092
It is an error to give a tag name that already exists unless you pass
4093
--force, in which case the tag is moved to point to the new revision.
4096
_see_also = ['commit', 'tags']
4097
takes_args = ['tag_name']
4100
help='Delete this tag rather than placing it.',
4103
help='Branch in which to place the tag.',
4108
help='Replace existing tags.',
4113
def run(self, tag_name,
4119
branch, relpath = Branch.open_containing(directory)
4123
branch.tags.delete_tag(tag_name)
4124
self.outf.write('Deleted tag %s.\n' % tag_name)
4127
if len(revision) != 1:
4128
raise errors.BzrCommandError(
4129
"Tags can only be placed on a single revision, "
4131
revision_id = revision[0].in_history(branch).rev_id
4133
revision_id = branch.last_revision()
4134
if (not force) and branch.tags.has_tag(tag_name):
4135
raise errors.TagAlreadyExists(tag_name)
4136
branch.tags.set_tag(tag_name, revision_id)
4137
self.outf.write('Created tag %s.\n' % tag_name)
4142
class cmd_tags(Command):
4145
This tag shows a table of tag names and the revisions they reference.
4151
help='Branch whose tags should be displayed.',
4161
branch, relpath = Branch.open_containing(directory)
4162
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
4163
self.outf.write('%-20s %s\n' % (tag_name, target))
4166
def _create_prefix(cur_transport):
4167
needed = [cur_transport]
4168
# Recurse upwards until we can create a directory successfully
4170
new_transport = cur_transport.clone('..')
4171
if new_transport.base == cur_transport.base:
4172
raise errors.BzrCommandError(
4173
"Failed to create path prefix for %s."
4174
% cur_transport.base)
4176
new_transport.mkdir('.')
4177
except errors.NoSuchFile:
4178
needed.append(new_transport)
4179
cur_transport = new_transport
4182
# Now we only need to create child directories
4184
cur_transport = needed.pop()
4185
cur_transport.ensure_base()
4188
def _get_mergeable_helper(location):
4189
"""Get a merge directive or bundle if 'location' points to one.
4191
Try try to identify a bundle and returns its mergeable form. If it's not,
4192
we return the tried transport anyway so that it can reused to access the
4195
:param location: can point to a bundle or a branch.
4197
:return: mergeable, transport
4200
url = urlutils.normalize_url(location)
4201
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4202
location_transport = transport.get_transport(url)
4205
# There may be redirections but we ignore the intermediate
4206
# and final transports used
4207
read = bundle.read_mergeable_from_transport
4208
mergeable, t = read(location_transport, filename)
4209
except errors.NotABundle:
4210
# Continue on considering this url a Branch but adjust the
4211
# location_transport
4212
location_transport = location_transport.clone(filename)
4213
return mergeable, location_transport
4216
# these get imported and then picked up by the scan for cmd_*
4217
# TODO: Some more consistent way to split command definitions across files;
4218
# we do need to load at least some information about them to know of
4219
# aliases. ideally we would avoid loading the implementation until the
4220
# details were needed.
4221
from bzrlib.cmd_version_info import cmd_version_info
4222
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4223
from bzrlib.bundle.commands import (
4226
from bzrlib.sign_my_commits import cmd_sign_my_commits
4227
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4228
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
