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(), """
48
revision as _mod_revision,
56
from bzrlib.branch import Branch
57
from bzrlib.conflicts import ConflictList
58
from bzrlib.revisionspec import RevisionSpec
59
from bzrlib.smtp_connection import SMTPConnection
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import Command, display_command
64
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
65
from bzrlib.progress import DummyProgress, ProgressPhase
66
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
69
def tree_files(file_list, default_branch=u'.'):
71
return internal_tree_files(file_list, default_branch)
72
except errors.FileInWrongBranch, e:
73
raise errors.BzrCommandError("%s is not in the same branch as %s" %
74
(e.path, file_list[0]))
77
# XXX: Bad function name; should possibly also be a class method of
78
# WorkingTree rather than a function.
79
def internal_tree_files(file_list, default_branch=u'.'):
80
"""Convert command-line paths to a WorkingTree and relative paths.
82
This is typically used for command-line processors that take one or
83
more filenames, and infer the workingtree that contains them.
85
The filenames given are not required to exist.
87
:param file_list: Filenames to convert.
89
:param default_branch: Fallback tree path to use if file_list is empty or
92
:return: workingtree, [relative_paths]
94
if file_list is None or len(file_list) == 0:
95
return WorkingTree.open_containing(default_branch)[0], file_list
96
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
98
for filename in file_list:
100
new_list.append(tree.relpath(osutils.dereference_path(filename)))
101
except errors.PathNotChild:
102
raise errors.FileInWrongBranch(tree.branch, filename)
103
return tree, new_list
106
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
107
def get_format_type(typestring):
108
"""Parse and return a format specifier."""
109
# Have to use BzrDirMetaFormat1 directly, so that
110
# RepositoryFormat.set_default_format works
111
if typestring == "default":
112
return bzrdir.BzrDirMetaFormat1()
114
return bzrdir.format_registry.make_bzrdir(typestring)
116
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
117
raise errors.BzrCommandError(msg)
120
# TODO: Make sure no commands unconditionally use the working directory as a
121
# branch. If a filename argument is used, the first of them should be used to
122
# specify the branch. (Perhaps this can be factored out into some kind of
123
# Argument class, representing a file in a branch, where the first occurrence
126
class cmd_status(Command):
127
"""Display status summary.
129
This reports on versioned and unknown files, reporting them
130
grouped by state. Possible states are:
133
Versioned in the working copy but not in the previous revision.
136
Versioned in the previous revision but removed or deleted
140
Path of this file changed from the previous revision;
141
the text may also have changed. This includes files whose
142
parent directory was renamed.
145
Text has changed since the previous revision.
148
File kind has been changed (e.g. from file to directory).
151
Not versioned and not matching an ignore pattern.
153
To see ignored files use 'bzr ignored'. For details on the
154
changes to file texts, use 'bzr diff'.
156
Note that --short or -S gives status flags for each item, similar
157
to Subversion's status command. To get output similar to svn -q,
160
If no arguments are specified, the status of the entire working
161
directory is shown. Otherwise, only the status of the specified
162
files or directories is reported. If a directory is given, status
163
is reported for everything inside that directory.
165
If a revision argument is given, the status is calculated against
166
that revision, or between two revisions if two are provided.
169
# TODO: --no-recurse, --recurse options
171
takes_args = ['file*']
172
takes_options = ['show-ids', 'revision', 'change',
173
Option('short', help='Use short status indicators.',
175
Option('versioned', help='Only show versioned files.',
178
aliases = ['st', 'stat']
180
encoding_type = 'replace'
181
_see_also = ['diff', 'revert', 'status-flags']
184
def run(self, show_ids=False, file_list=None, revision=None, short=False,
186
from bzrlib.status import show_tree_status
188
if revision and len(revision) > 2:
189
raise errors.BzrCommandError('bzr status --revision takes exactly'
190
' one or two revision specifiers')
192
tree, file_list = tree_files(file_list)
194
show_tree_status(tree, show_ids=show_ids,
195
specific_files=file_list, revision=revision,
196
to_file=self.outf, short=short, versioned=versioned)
199
class cmd_cat_revision(Command):
200
"""Write out metadata for a revision.
202
The revision to print can either be specified by a specific
203
revision identifier, or you can use --revision.
207
takes_args = ['revision_id?']
208
takes_options = ['revision']
209
# cat-revision is more for frontends so should be exact
213
def run(self, revision_id=None, revision=None):
214
if revision_id is not None and revision is not None:
215
raise errors.BzrCommandError('You can only supply one of'
216
' revision_id or --revision')
217
if revision_id is None and revision is None:
218
raise errors.BzrCommandError('You must supply either'
219
' --revision or a revision_id')
220
b = WorkingTree.open_containing(u'.')[0].branch
222
# TODO: jam 20060112 should cat-revision always output utf-8?
223
if revision_id is not None:
224
revision_id = osutils.safe_revision_id(revision_id, warn=False)
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
if location is not None:
608
mergeable, location_transport = _get_mergeable_helper(location)
610
stored_loc = branch_to.get_parent()
612
if stored_loc is None:
613
raise errors.BzrCommandError("No pull location known or"
616
display_url = urlutils.unescape_for_display(stored_loc,
618
self.outf.write("Using saved location: %s\n" % display_url)
619
location = stored_loc
620
location_transport = transport.get_transport(location)
622
if mergeable is not None:
623
if revision is not None:
624
raise errors.BzrCommandError(
625
'Cannot use -r with merge directives or bundles')
626
mergeable.install_revisions(branch_to.repository)
627
base_revision_id, revision_id, verified = \
628
mergeable.get_merge_request(branch_to.repository)
629
branch_from = branch_to
631
branch_from = Branch.open_from_transport(location_transport)
633
if branch_to.get_parent() is None or remember:
634
branch_to.set_parent(branch_from.base)
636
if revision is not None:
637
if len(revision) == 1:
638
revision_id = revision[0].in_history(branch_from).rev_id
640
raise errors.BzrCommandError(
641
'bzr pull --revision takes one value.')
644
old_rh = branch_to.revision_history()
645
if tree_to is not None:
646
result = tree_to.pull(branch_from, overwrite, revision_id,
647
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
649
result = branch_to.pull(branch_from, overwrite, revision_id)
651
result.report(self.outf)
653
new_rh = branch_to.revision_history()
654
log.show_changed_revisions(branch_to, old_rh, new_rh,
658
class cmd_push(Command):
659
"""Update a mirror of this branch.
661
The target branch will not have its working tree populated because this
662
is both expensive, and is not supported on remote file systems.
664
Some smart servers or protocols *may* put the working tree in place in
667
This command only works on branches that have not diverged. Branches are
668
considered diverged if the destination branch's most recent commit is one
669
that has not been merged (directly or indirectly) by the source branch.
671
If branches have diverged, you can use 'bzr push --overwrite' to replace
672
the other branch completely, discarding its unmerged changes.
674
If you want to ensure you have the different changes in the other branch,
675
do a merge (see bzr help merge) from the other branch, and commit that.
676
After that you will be able to do a push without '--overwrite'.
678
If there is no default push location set, the first push will set it.
679
After that, you can omit the location to use the default. To change the
680
default, use --remember. The value will only be saved if the remote
681
location can be accessed.
684
_see_also = ['pull', 'update', 'working-trees']
685
takes_options = ['remember', 'overwrite', 'verbose',
686
Option('create-prefix',
687
help='Create the path leading up to the branch '
688
'if it does not already exist.'),
690
help='Branch to push from, '
691
'rather than the one containing the working directory.',
695
Option('use-existing-dir',
696
help='By default push will fail if the target'
697
' directory exists, but does not already'
698
' have a control directory. This flag will'
699
' allow push to proceed.'),
701
takes_args = ['location?']
702
encoding_type = 'replace'
704
def run(self, location=None, remember=False, overwrite=False,
705
create_prefix=False, verbose=False,
706
use_existing_dir=False,
708
# FIXME: Way too big! Put this into a function called from the
710
if directory is None:
712
br_from = Branch.open_containing(directory)[0]
713
stored_loc = br_from.get_push_location()
715
if stored_loc is None:
716
raise errors.BzrCommandError("No push location known or specified.")
718
display_url = urlutils.unescape_for_display(stored_loc,
720
self.outf.write("Using saved location: %s\n" % display_url)
721
location = stored_loc
723
to_transport = transport.get_transport(location)
725
br_to = repository_to = dir_to = None
727
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
728
except errors.NotBranchError:
729
pass # Didn't find anything
731
# If we can open a branch, use its direct repository, otherwise see
732
# if there is a repository without a branch.
734
br_to = dir_to.open_branch()
735
except errors.NotBranchError:
736
# Didn't find a branch, can we find a repository?
738
repository_to = dir_to.find_repository()
739
except errors.NoRepositoryPresent:
742
# Found a branch, so we must have found a repository
743
repository_to = br_to.repository
748
# The destination doesn't exist; create it.
749
# XXX: Refactor the create_prefix/no_create_prefix code into a
750
# common helper function
752
to_transport.mkdir('.')
753
except errors.FileExists:
754
if not use_existing_dir:
755
raise errors.BzrCommandError("Target directory %s"
756
" already exists, but does not have a valid .bzr"
757
" directory. Supply --use-existing-dir to push"
758
" there anyway." % location)
759
except errors.NoSuchFile:
760
if not create_prefix:
761
raise errors.BzrCommandError("Parent directory of %s"
763
"\nYou may supply --create-prefix to create all"
764
" leading parent directories."
766
_create_prefix(to_transport)
768
# Now the target directory exists, but doesn't have a .bzr
769
# directory. So we need to create it, along with any work to create
770
# all of the dependent branches, etc.
771
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
772
revision_id=br_from.last_revision())
773
br_to = dir_to.open_branch()
774
# TODO: Some more useful message about what was copied
775
note('Created new branch.')
776
# We successfully created the target, remember it
777
if br_from.get_push_location() is None or remember:
778
br_from.set_push_location(br_to.base)
779
elif repository_to is None:
780
# we have a bzrdir but no branch or repository
781
# XXX: Figure out what to do other than complain.
782
raise errors.BzrCommandError("At %s you have a valid .bzr control"
783
" directory, but not a branch or repository. This is an"
784
" unsupported configuration. Please move the target directory"
785
" out of the way and try again."
788
# We have a repository but no branch, copy the revisions, and then
790
last_revision_id = br_from.last_revision()
791
repository_to.fetch(br_from.repository,
792
revision_id=last_revision_id)
793
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
794
note('Created new branch.')
795
if br_from.get_push_location() is None or remember:
796
br_from.set_push_location(br_to.base)
797
else: # We have a valid to branch
798
# We were able to connect to the remote location, so remember it
799
# we don't need to successfully push because of possible divergence.
800
if br_from.get_push_location() is None or remember:
801
br_from.set_push_location(br_to.base)
803
old_rh = br_to.revision_history()
806
tree_to = dir_to.open_workingtree()
807
except errors.NotLocalUrl:
808
warning("This transport does not update the working "
809
"tree of: %s. See 'bzr help working-trees' for "
810
"more information." % br_to.base)
811
push_result = br_from.push(br_to, overwrite)
812
except errors.NoWorkingTree:
813
push_result = br_from.push(br_to, overwrite)
817
push_result = br_from.push(tree_to.branch, overwrite)
821
except errors.DivergedBranches:
822
raise errors.BzrCommandError('These branches have diverged.'
823
' Try using "merge" and then "push".')
824
if push_result is not None:
825
push_result.report(self.outf)
827
new_rh = br_to.revision_history()
830
from bzrlib.log import show_changed_revisions
831
show_changed_revisions(br_to, old_rh, new_rh,
834
# we probably did a clone rather than a push, so a message was
839
class cmd_branch(Command):
840
"""Create a new copy of a branch.
842
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
843
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
844
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
845
is derived from the FROM_LOCATION by stripping a leading scheme or drive
846
identifier, if any. For example, "branch lp:foo-bar" will attempt to
849
To retrieve the branch as of a particular revision, supply the --revision
850
parameter, as in "branch foo/bar -r 5".
853
_see_also = ['checkout']
854
takes_args = ['from_location', 'to_location?']
855
takes_options = ['revision']
856
aliases = ['get', 'clone']
858
def run(self, from_location, to_location=None, revision=None):
859
from bzrlib.tag import _merge_tags_if_possible
862
elif len(revision) > 1:
863
raise errors.BzrCommandError(
864
'bzr branch --revision takes exactly 1 revision value')
866
br_from = Branch.open(from_location)
869
if len(revision) == 1 and revision[0] is not None:
870
revision_id = revision[0].in_history(br_from)[1]
872
# FIXME - wt.last_revision, fallback to branch, fall back to
873
# None or perhaps NULL_REVISION to mean copy nothing
875
revision_id = br_from.last_revision()
876
if to_location is None:
877
to_location = urlutils.derive_to_location(from_location)
880
name = os.path.basename(to_location) + '\n'
882
to_transport = transport.get_transport(to_location)
884
to_transport.mkdir('.')
885
except errors.FileExists:
886
raise errors.BzrCommandError('Target directory "%s" already'
887
' exists.' % to_location)
888
except errors.NoSuchFile:
889
raise errors.BzrCommandError('Parent of "%s" does not exist.'
892
# preserve whatever source format we have.
893
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
894
possible_transports=[to_transport])
895
branch = dir.open_branch()
896
except errors.NoSuchRevision:
897
to_transport.delete_tree('.')
898
msg = "The branch %s has no revision %s." % (from_location, revision[0])
899
raise errors.BzrCommandError(msg)
901
branch.control_files.put_utf8('branch-name', name)
902
_merge_tags_if_possible(br_from, branch)
903
note('Branched %d revision(s).' % branch.revno())
908
class cmd_checkout(Command):
909
"""Create a new checkout of an existing branch.
911
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
912
the branch found in '.'. This is useful if you have removed the working tree
913
or if it was never created - i.e. if you pushed the branch to its current
916
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
917
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
918
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
919
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
920
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
923
To retrieve the branch as of a particular revision, supply the --revision
924
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
925
out of date [so you cannot commit] but it may be useful (i.e. to examine old
929
_see_also = ['checkouts', 'branch']
930
takes_args = ['branch_location?', 'to_location?']
931
takes_options = ['revision',
932
Option('lightweight',
933
help="Perform a lightweight checkout. Lightweight "
934
"checkouts depend on access to the branch for "
935
"every operation. Normal checkouts can perform "
936
"common operations like diff and status without "
937
"such access, and also support local commits."
942
def run(self, branch_location=None, to_location=None, revision=None,
946
elif len(revision) > 1:
947
raise errors.BzrCommandError(
948
'bzr checkout --revision takes exactly 1 revision value')
949
if branch_location is None:
950
branch_location = osutils.getcwd()
951
to_location = branch_location
952
source = Branch.open(branch_location)
953
if len(revision) == 1 and revision[0] is not None:
954
revision_id = _mod_revision.ensure_null(
955
revision[0].in_history(source)[1])
958
if to_location is None:
959
to_location = urlutils.derive_to_location(branch_location)
960
# if the source and to_location are the same,
961
# and there is no working tree,
962
# then reconstitute a branch
963
if (osutils.abspath(to_location) ==
964
osutils.abspath(branch_location)):
966
source.bzrdir.open_workingtree()
967
except errors.NoWorkingTree:
968
source.bzrdir.create_workingtree(revision_id)
970
source.create_checkout(to_location, revision_id, lightweight)
973
class cmd_renames(Command):
974
"""Show list of renamed files.
976
# TODO: Option to show renames between two historical versions.
978
# TODO: Only show renames under dir, rather than in the whole branch.
979
_see_also = ['status']
980
takes_args = ['dir?']
983
def run(self, dir=u'.'):
984
tree = WorkingTree.open_containing(dir)[0]
987
new_inv = tree.inventory
988
old_tree = tree.basis_tree()
991
old_inv = old_tree.inventory
992
renames = list(_mod_tree.find_renames(old_inv, new_inv))
994
for old_name, new_name in renames:
995
self.outf.write("%s => %s\n" % (old_name, new_name))
1002
class cmd_update(Command):
1003
"""Update a tree to have the latest code committed to its branch.
1005
This will perform a merge into the working tree, and may generate
1006
conflicts. If you have any local changes, you will still
1007
need to commit them after the update for the update to be complete.
1009
If you want to discard your local changes, you can just do a
1010
'bzr revert' instead of 'bzr commit' after the update.
1013
_see_also = ['pull', 'working-trees', 'status-flags']
1014
takes_args = ['dir?']
1017
def run(self, dir='.'):
1018
tree = WorkingTree.open_containing(dir)[0]
1019
possible_transports = []
1020
master = tree.branch.get_master_branch(
1021
possible_transports=possible_transports)
1022
if master is not None:
1025
tree.lock_tree_write()
1027
existing_pending_merges = tree.get_parent_ids()[1:]
1028
last_rev = _mod_revision.ensure_null(tree.last_revision())
1029
if last_rev == _mod_revision.ensure_null(
1030
tree.branch.last_revision()):
1031
# may be up to date, check master too.
1032
if master is None or last_rev == _mod_revision.ensure_null(
1033
master.last_revision()):
1034
revno = tree.branch.revision_id_to_revno(last_rev)
1035
note("Tree is up to date at revision %d." % (revno,))
1037
conflicts = tree.update(
1038
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1039
possible_transports=possible_transports)
1040
revno = tree.branch.revision_id_to_revno(
1041
_mod_revision.ensure_null(tree.last_revision()))
1042
note('Updated to revision %d.' % (revno,))
1043
if tree.get_parent_ids()[1:] != existing_pending_merges:
1044
note('Your local commits will now show as pending merges with '
1045
"'bzr status', and can be committed with 'bzr commit'.")
1054
class cmd_info(Command):
1055
"""Show information about a working tree, branch or repository.
1057
This command will show all known locations and formats associated to the
1058
tree, branch or repository. Statistical information is included with
1061
Branches and working trees will also report any missing revisions.
1063
_see_also = ['revno', 'working-trees', 'repositories']
1064
takes_args = ['location?']
1065
takes_options = ['verbose']
1068
def run(self, location=None, verbose=False):
1073
from bzrlib.info import show_bzrdir_info
1074
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1075
verbose=noise_level)
1078
class cmd_remove(Command):
1079
"""Remove files or directories.
1081
This makes bzr stop tracking changes to the specified files and
1082
delete them if they can easily be recovered using revert.
1084
You can specify one or more files, and/or --new. If you specify --new,
1085
only 'added' files will be removed. If you specify both, then new files
1086
in the specified directories will be removed. If the directories are
1087
also new, they will also be removed.
1089
takes_args = ['file*']
1090
takes_options = ['verbose',
1091
Option('new', help='Remove newly-added files.'),
1092
RegistryOption.from_kwargs('file-deletion-strategy',
1093
'The file deletion mode to be used.',
1094
title='Deletion Strategy', value_switches=True, enum_switch=False,
1095
safe='Only delete files if they can be'
1096
' safely recovered (default).',
1097
keep="Don't delete any files.",
1098
force='Delete all the specified files, even if they can not be '
1099
'recovered and even if they are non-empty directories.')]
1101
encoding_type = 'replace'
1103
def run(self, file_list, verbose=False, new=False,
1104
file_deletion_strategy='safe'):
1105
tree, file_list = tree_files(file_list)
1107
if file_list is not None:
1108
file_list = [f for f in file_list]
1110
raise errors.BzrCommandError('Specify one or more files to'
1111
' remove, or use --new.')
1114
added = tree.changes_from(tree.basis_tree(),
1115
specific_files=file_list).added
1116
file_list = sorted([f[0] for f in added], reverse=True)
1117
if len(file_list) == 0:
1118
raise errors.BzrCommandError('No matching files.')
1119
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1120
keep_files=file_deletion_strategy=='keep',
1121
force=file_deletion_strategy=='force')
1124
class cmd_file_id(Command):
1125
"""Print file_id of a particular file or directory.
1127
The file_id is assigned when the file is first added and remains the
1128
same through all revisions where the file exists, even when it is
1133
_see_also = ['inventory', 'ls']
1134
takes_args = ['filename']
1137
def run(self, filename):
1138
tree, relpath = WorkingTree.open_containing(filename)
1139
i = tree.path2id(relpath)
1141
raise errors.NotVersionedError(filename)
1143
self.outf.write(i + '\n')
1146
class cmd_file_path(Command):
1147
"""Print path of file_ids to a file or directory.
1149
This prints one line for each directory down to the target,
1150
starting at the branch root.
1154
takes_args = ['filename']
1157
def run(self, filename):
1158
tree, relpath = WorkingTree.open_containing(filename)
1159
fid = tree.path2id(relpath)
1161
raise errors.NotVersionedError(filename)
1162
segments = osutils.splitpath(relpath)
1163
for pos in range(1, len(segments) + 1):
1164
path = osutils.joinpath(segments[:pos])
1165
self.outf.write("%s\n" % tree.path2id(path))
1168
class cmd_reconcile(Command):
1169
"""Reconcile bzr metadata in a branch.
1171
This can correct data mismatches that may have been caused by
1172
previous ghost operations or bzr upgrades. You should only
1173
need to run this command if 'bzr check' or a bzr developer
1174
advises you to run it.
1176
If a second branch is provided, cross-branch reconciliation is
1177
also attempted, which will check that data like the tree root
1178
id which was not present in very early bzr versions is represented
1179
correctly in both branches.
1181
At the same time it is run it may recompress data resulting in
1182
a potential saving in disk space or performance gain.
1184
The branch *MUST* be on a listable system such as local disk or sftp.
1187
_see_also = ['check']
1188
takes_args = ['branch?']
1190
def run(self, branch="."):
1191
from bzrlib.reconcile import reconcile
1192
dir = bzrdir.BzrDir.open(branch)
1196
class cmd_revision_history(Command):
1197
"""Display the list of revision ids on a branch."""
1200
takes_args = ['location?']
1205
def run(self, location="."):
1206
branch = Branch.open_containing(location)[0]
1207
for revid in branch.revision_history():
1208
self.outf.write(revid)
1209
self.outf.write('\n')
1212
class cmd_ancestry(Command):
1213
"""List all revisions merged into this branch."""
1215
_see_also = ['log', 'revision-history']
1216
takes_args = ['location?']
1221
def run(self, location="."):
1223
wt = WorkingTree.open_containing(location)[0]
1224
except errors.NoWorkingTree:
1225
b = Branch.open(location)
1226
last_revision = b.last_revision()
1229
last_revision = wt.last_revision()
1231
revision_ids = b.repository.get_ancestry(last_revision)
1232
assert revision_ids[0] is None
1234
for revision_id in revision_ids:
1235
self.outf.write(revision_id + '\n')
1238
class cmd_init(Command):
1239
"""Make a directory into a versioned branch.
1241
Use this to create an empty branch, or before importing an
1244
If there is a repository in a parent directory of the location, then
1245
the history of the branch will be stored in the repository. Otherwise
1246
init creates a standalone branch which carries its own history
1247
in the .bzr directory.
1249
If there is already a branch at the location but it has no working tree,
1250
the tree can be populated with 'bzr checkout'.
1252
Recipe for importing a tree of files::
1258
bzr commit -m 'imported project'
1261
_see_also = ['init-repository', 'branch', 'checkout']
1262
takes_args = ['location?']
1264
Option('create-prefix',
1265
help='Create the path leading up to the branch '
1266
'if it does not already exist.'),
1267
RegistryOption('format',
1268
help='Specify a format for this branch. '
1269
'See "help formats".',
1270
registry=bzrdir.format_registry,
1271
converter=bzrdir.format_registry.make_bzrdir,
1272
value_switches=True,
1273
title="Branch Format",
1275
Option('append-revisions-only',
1276
help='Never change revnos or the existing log.'
1277
' Append revisions to it only.')
1279
def run(self, location=None, format=None, append_revisions_only=False,
1280
create_prefix=False):
1282
format = bzrdir.format_registry.make_bzrdir('default')
1283
if location is None:
1286
to_transport = transport.get_transport(location)
1288
# The path has to exist to initialize a
1289
# branch inside of it.
1290
# Just using os.mkdir, since I don't
1291
# believe that we want to create a bunch of
1292
# locations if the user supplies an extended path
1294
to_transport.ensure_base()
1295
except errors.NoSuchFile:
1296
if not create_prefix:
1297
raise errors.BzrCommandError("Parent directory of %s"
1299
"\nYou may supply --create-prefix to create all"
1300
" leading parent directories."
1302
_create_prefix(to_transport)
1305
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1306
except errors.NotBranchError:
1307
# really a NotBzrDir error...
1308
create_branch = bzrdir.BzrDir.create_branch_convenience
1309
branch = create_branch(to_transport.base, format=format,
1310
possible_transports=[to_transport])
1312
from bzrlib.transport.local import LocalTransport
1313
if existing_bzrdir.has_branch():
1314
if (isinstance(to_transport, LocalTransport)
1315
and not existing_bzrdir.has_workingtree()):
1316
raise errors.BranchExistsWithoutWorkingTree(location)
1317
raise errors.AlreadyBranchError(location)
1319
branch = existing_bzrdir.create_branch()
1320
existing_bzrdir.create_workingtree()
1321
if append_revisions_only:
1323
branch.set_append_revisions_only(True)
1324
except errors.UpgradeRequired:
1325
raise errors.BzrCommandError('This branch format cannot be set'
1326
' to append-revisions-only. Try --experimental-branch6')
1329
class cmd_init_repository(Command):
1330
"""Create a shared repository to hold branches.
1332
New branches created under the repository directory will store their
1333
revisions in the repository, not in the branch directory.
1335
If the --no-trees option is used then the branches in the repository
1336
will not have working trees by default.
1339
Create a shared repositories holding just branches::
1341
bzr init-repo --no-trees repo
1344
Make a lightweight checkout elsewhere::
1346
bzr checkout --lightweight repo/trunk trunk-checkout
1351
_see_also = ['init', 'branch', 'checkout', 'repositories']
1352
takes_args = ["location"]
1353
takes_options = [RegistryOption('format',
1354
help='Specify a format for this repository. See'
1355
' "bzr help formats" for details.',
1356
registry=bzrdir.format_registry,
1357
converter=bzrdir.format_registry.make_bzrdir,
1358
value_switches=True, title='Repository format'),
1360
help='Branches in the repository will default to'
1361
' not having a working tree.'),
1363
aliases = ["init-repo"]
1365
def run(self, location, format=None, no_trees=False):
1367
format = bzrdir.format_registry.make_bzrdir('default')
1369
if location is None:
1372
to_transport = transport.get_transport(location)
1373
to_transport.ensure_base()
1375
newdir = format.initialize_on_transport(to_transport)
1376
repo = newdir.create_repository(shared=True)
1377
repo.set_make_working_trees(not no_trees)
1380
class cmd_diff(Command):
1381
"""Show differences in the working tree or between revisions.
1383
If files are listed, only the changes in those files are listed.
1384
Otherwise, all changes for the tree are listed.
1386
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1387
produces patches suitable for "patch -p1".
1390
Shows the difference in the working tree versus the last commit::
1394
Difference between the working tree and revision 1::
1398
Difference between revision 2 and revision 1::
1402
Same as 'bzr diff' but prefix paths with old/ and new/::
1404
bzr diff --prefix old/:new/
1406
Show the differences between the two working trees::
1408
bzr diff bzr.mine bzr.dev
1410
Show just the differences for 'foo.c'::
1414
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1415
# or a graphical diff.
1417
# TODO: Python difflib is not exactly the same as unidiff; should
1418
# either fix it up or prefer to use an external diff.
1420
# TODO: Selected-file diff is inefficient and doesn't show you
1423
# TODO: This probably handles non-Unix newlines poorly.
1425
_see_also = ['status']
1426
takes_args = ['file*']
1428
Option('diff-options', type=str,
1429
help='Pass these options to the external diff program.'),
1430
Option('prefix', type=str,
1432
help='Set prefixes added to old and new filenames, as '
1433
'two values separated by a colon. (eg "old/:new/").'),
1437
aliases = ['di', 'dif']
1438
encoding_type = 'exact'
1441
def run(self, revision=None, file_list=None, diff_options=None,
1443
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1445
if (prefix is None) or (prefix == '0'):
1453
old_label, new_label = prefix.split(":")
1455
raise errors.BzrCommandError(
1456
'--prefix expects two values separated by a colon'
1457
' (eg "old/:new/")')
1459
if revision and len(revision) > 2:
1460
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1461
' one or two revision specifiers')
1464
tree1, file_list = internal_tree_files(file_list)
1468
except errors.FileInWrongBranch:
1469
if len(file_list) != 2:
1470
raise errors.BzrCommandError("Files are in different branches")
1472
tree1, file1 = WorkingTree.open_containing(file_list[0])
1473
tree2, file2 = WorkingTree.open_containing(file_list[1])
1474
if file1 != "" or file2 != "":
1475
# FIXME diff those two files. rbc 20051123
1476
raise errors.BzrCommandError("Files are in different branches")
1478
except errors.NotBranchError:
1479
if (revision is not None and len(revision) == 2
1480
and not revision[0].needs_branch()
1481
and not revision[1].needs_branch()):
1482
# If both revision specs include a branch, we can
1483
# diff them without needing a local working tree
1484
tree1, tree2 = None, None
1488
if tree2 is not None:
1489
if revision is not None:
1490
# FIXME: but there should be a clean way to diff between
1491
# non-default versions of two trees, it's not hard to do
1493
raise errors.BzrCommandError(
1494
"Sorry, diffing arbitrary revisions across branches "
1495
"is not implemented yet")
1496
return show_diff_trees(tree1, tree2, sys.stdout,
1497
specific_files=file_list,
1498
external_diff_options=diff_options,
1499
old_label=old_label, new_label=new_label)
1501
return diff_cmd_helper(tree1, file_list, diff_options,
1502
revision_specs=revision,
1503
old_label=old_label, new_label=new_label)
1506
class cmd_deleted(Command):
1507
"""List files deleted in the working tree.
1509
# TODO: Show files deleted since a previous revision, or
1510
# between two revisions.
1511
# TODO: Much more efficient way to do this: read in new
1512
# directories with readdir, rather than stating each one. Same
1513
# level of effort but possibly much less IO. (Or possibly not,
1514
# if the directories are very large...)
1515
_see_also = ['status', 'ls']
1516
takes_options = ['show-ids']
1519
def run(self, show_ids=False):
1520
tree = WorkingTree.open_containing(u'.')[0]
1523
old = tree.basis_tree()
1526
for path, ie in old.inventory.iter_entries():
1527
if not tree.has_id(ie.file_id):
1528
self.outf.write(path)
1530
self.outf.write(' ')
1531
self.outf.write(ie.file_id)
1532
self.outf.write('\n')
1539
class cmd_modified(Command):
1540
"""List files modified in working tree.
1544
_see_also = ['status', 'ls']
1548
tree = WorkingTree.open_containing(u'.')[0]
1549
td = tree.changes_from(tree.basis_tree())
1550
for path, id, kind, text_modified, meta_modified in td.modified:
1551
self.outf.write(path + '\n')
1554
class cmd_added(Command):
1555
"""List files added in working tree.
1559
_see_also = ['status', 'ls']
1563
wt = WorkingTree.open_containing(u'.')[0]
1566
basis = wt.basis_tree()
1569
basis_inv = basis.inventory
1572
if file_id in basis_inv:
1574
if inv.is_root(file_id) and len(basis_inv) == 0:
1576
path = inv.id2path(file_id)
1577
if not os.access(osutils.abspath(path), os.F_OK):
1579
self.outf.write(path + '\n')
1586
class cmd_root(Command):
1587
"""Show the tree root directory.
1589
The root is the nearest enclosing directory with a .bzr control
1592
takes_args = ['filename?']
1594
def run(self, filename=None):
1595
"""Print the branch root."""
1596
tree = WorkingTree.open_containing(filename)[0]
1597
self.outf.write(tree.basedir + '\n')
1600
def _parse_limit(limitstring):
1602
return int(limitstring)
1604
msg = "The limit argument must be an integer."
1605
raise errors.BzrCommandError(msg)
1608
class cmd_log(Command):
1609
"""Show log of a branch, file, or directory.
1611
By default show the log of the branch containing the working directory.
1613
To request a range of logs, you can use the command -r begin..end
1614
-r revision requests a specific revision, -r ..end or -r begin.. are
1618
Log the current branch::
1626
Log the last 10 revisions of a branch::
1628
bzr log -r -10.. http://server/branch
1631
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1633
takes_args = ['location?']
1636
help='Show from oldest to newest.'),
1639
help='Display timezone as local, original, or utc.'),
1640
custom_help('verbose',
1641
help='Show files changed in each revision.'),
1647
help='Show revisions whose message matches this '
1648
'regular expression.',
1651
help='Limit the output to the first N revisions.',
1655
encoding_type = 'replace'
1658
def run(self, location=None, timezone='original',
1666
from bzrlib.log import show_log
1667
assert message is None or isinstance(message, basestring), \
1668
"invalid message argument %r" % message
1669
direction = (forward and 'forward') or 'reverse'
1674
# find the file id to log:
1676
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1680
tree = b.basis_tree()
1681
file_id = tree.path2id(fp)
1683
raise errors.BzrCommandError(
1684
"Path does not have any revision history: %s" %
1688
# FIXME ? log the current subdir only RBC 20060203
1689
if revision is not None \
1690
and len(revision) > 0 and revision[0].get_branch():
1691
location = revision[0].get_branch()
1694
dir, relpath = bzrdir.BzrDir.open_containing(location)
1695
b = dir.open_branch()
1699
if revision is None:
1702
elif len(revision) == 1:
1703
rev1 = rev2 = revision[0].in_history(b)
1704
elif len(revision) == 2:
1705
if revision[1].get_branch() != revision[0].get_branch():
1706
# b is taken from revision[0].get_branch(), and
1707
# show_log will use its revision_history. Having
1708
# different branches will lead to weird behaviors.
1709
raise errors.BzrCommandError(
1710
"Log doesn't accept two revisions in different"
1712
rev1 = revision[0].in_history(b)
1713
rev2 = revision[1].in_history(b)
1715
raise errors.BzrCommandError(
1716
'bzr log --revision takes one or two values.')
1718
if log_format is None:
1719
log_format = log.log_formatter_registry.get_default(b)
1721
lf = log_format(show_ids=show_ids, to_file=self.outf,
1722
show_timezone=timezone)
1728
direction=direction,
1729
start_revision=rev1,
1737
def get_log_format(long=False, short=False, line=False, default='long'):
1738
log_format = default
1742
log_format = 'short'
1748
class cmd_touching_revisions(Command):
1749
"""Return revision-ids which affected a particular file.
1751
A more user-friendly interface is "bzr log FILE".
1755
takes_args = ["filename"]
1758
def run(self, filename):
1759
tree, relpath = WorkingTree.open_containing(filename)
1761
file_id = tree.path2id(relpath)
1762
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1763
self.outf.write("%6d %s\n" % (revno, what))
1766
class cmd_ls(Command):
1767
"""List files in a tree.
1770
_see_also = ['status', 'cat']
1771
takes_args = ['path?']
1772
# TODO: Take a revision or remote path and list that tree instead.
1776
Option('non-recursive',
1777
help='Don\'t recurse into subdirectories.'),
1779
help='Print paths relative to the root of the branch.'),
1780
Option('unknown', help='Print unknown files.'),
1781
Option('versioned', help='Print versioned files.'),
1782
Option('ignored', help='Print ignored files.'),
1784
help='Write an ascii NUL (\\0) separator '
1785
'between files rather than a newline.'),
1787
help='List entries of a particular kind: file, directory, symlink.',
1792
def run(self, revision=None, verbose=False,
1793
non_recursive=False, from_root=False,
1794
unknown=False, versioned=False, ignored=False,
1795
null=False, kind=None, show_ids=False, path=None):
1797
if kind and kind not in ('file', 'directory', 'symlink'):
1798
raise errors.BzrCommandError('invalid kind specified')
1800
if verbose and null:
1801
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1802
all = not (unknown or versioned or ignored)
1804
selection = {'I':ignored, '?':unknown, 'V':versioned}
1811
raise errors.BzrCommandError('cannot specify both --from-root'
1815
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1821
if revision is not None:
1822
tree = branch.repository.revision_tree(
1823
revision[0].in_history(branch).rev_id)
1825
tree = branch.basis_tree()
1829
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1830
if fp.startswith(relpath):
1831
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1832
if non_recursive and '/' in fp:
1834
if not all and not selection[fc]:
1836
if kind is not None and fkind != kind:
1839
kindch = entry.kind_character()
1840
outstring = '%-8s %s%s' % (fc, fp, kindch)
1841
if show_ids and fid is not None:
1842
outstring = "%-50s %s" % (outstring, fid)
1843
self.outf.write(outstring + '\n')
1845
self.outf.write(fp + '\0')
1848
self.outf.write(fid)
1849
self.outf.write('\0')
1857
self.outf.write('%-50s %s\n' % (fp, my_id))
1859
self.outf.write(fp + '\n')
1864
class cmd_unknowns(Command):
1865
"""List unknown files.
1873
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1874
self.outf.write(osutils.quotefn(f) + '\n')
1877
class cmd_ignore(Command):
1878
"""Ignore specified files or patterns.
1880
To remove patterns from the ignore list, edit the .bzrignore file.
1882
Trailing slashes on patterns are ignored.
1883
If the pattern contains a slash or is a regular expression, it is compared
1884
to the whole path from the branch root. Otherwise, it is compared to only
1885
the last component of the path. To match a file only in the root
1886
directory, prepend './'.
1888
Ignore patterns specifying absolute paths are not allowed.
1890
Ignore patterns may include globbing wildcards such as::
1892
? - Matches any single character except '/'
1893
* - Matches 0 or more characters except '/'
1894
/**/ - Matches 0 or more directories in a path
1895
[a-z] - Matches a single character from within a group of characters
1897
Ignore patterns may also be Python regular expressions.
1898
Regular expression ignore patterns are identified by a 'RE:' prefix
1899
followed by the regular expression. Regular expression ignore patterns
1900
may not include named or numbered groups.
1902
Note: ignore patterns containing shell wildcards must be quoted from
1906
Ignore the top level Makefile::
1908
bzr ignore ./Makefile
1910
Ignore class files in all directories::
1912
bzr ignore '*.class'
1914
Ignore .o files under the lib directory::
1916
bzr ignore 'lib/**/*.o'
1918
Ignore .o files under the lib directory::
1920
bzr ignore 'RE:lib/.*\.o'
1923
_see_also = ['status', 'ignored']
1924
takes_args = ['name_pattern*']
1926
Option('old-default-rules',
1927
help='Write out the ignore rules bzr < 0.9 always used.')
1930
def run(self, name_pattern_list=None, old_default_rules=None):
1931
from bzrlib.atomicfile import AtomicFile
1932
if old_default_rules is not None:
1933
# dump the rules and exit
1934
for pattern in ignores.OLD_DEFAULTS:
1937
if not name_pattern_list:
1938
raise errors.BzrCommandError("ignore requires at least one "
1939
"NAME_PATTERN or --old-default-rules")
1940
name_pattern_list = [globbing.normalize_pattern(p)
1941
for p in name_pattern_list]
1942
for name_pattern in name_pattern_list:
1943
if (name_pattern[0] == '/' or
1944
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1945
raise errors.BzrCommandError(
1946
"NAME_PATTERN should not be an absolute path")
1947
tree, relpath = WorkingTree.open_containing(u'.')
1948
ifn = tree.abspath('.bzrignore')
1949
if os.path.exists(ifn):
1952
igns = f.read().decode('utf-8')
1958
# TODO: If the file already uses crlf-style termination, maybe
1959
# we should use that for the newly added lines?
1961
if igns and igns[-1] != '\n':
1963
for name_pattern in name_pattern_list:
1964
igns += name_pattern + '\n'
1966
f = AtomicFile(ifn, 'wb')
1968
f.write(igns.encode('utf-8'))
1973
if not tree.path2id('.bzrignore'):
1974
tree.add(['.bzrignore'])
1976
ignored = globbing.Globster(name_pattern_list)
1979
for entry in tree.list_files():
1983
if ignored.match(filename):
1984
matches.append(filename.encode('utf-8'))
1986
if len(matches) > 0:
1987
print "Warning: the following files are version controlled and" \
1988
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1990
class cmd_ignored(Command):
1991
"""List ignored files and the patterns that matched them.
1994
_see_also = ['ignore']
1997
tree = WorkingTree.open_containing(u'.')[0]
2000
for path, file_class, kind, file_id, entry in tree.list_files():
2001
if file_class != 'I':
2003
## XXX: Slightly inefficient since this was already calculated
2004
pat = tree.is_ignored(path)
2005
print '%-50s %s' % (path, pat)
2010
class cmd_lookup_revision(Command):
2011
"""Lookup the revision-id from a revision-number
2014
bzr lookup-revision 33
2017
takes_args = ['revno']
2020
def run(self, revno):
2024
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2026
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2029
class cmd_export(Command):
2030
"""Export current or past revision to a destination directory or archive.
2032
If no revision is specified this exports the last committed revision.
2034
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2035
given, try to find the format with the extension. If no extension
2036
is found exports to a directory (equivalent to --format=dir).
2038
If root is supplied, it will be used as the root directory inside
2039
container formats (tar, zip, etc). If it is not supplied it will default
2040
to the exported filename. The root option has no effect for 'dir' format.
2042
If branch is omitted then the branch containing the current working
2043
directory will be used.
2045
Note: Export of tree with non-ASCII filenames to zip is not supported.
2047
================= =========================
2048
Supported formats Autodetected by extension
2049
================= =========================
2052
tbz2 .tar.bz2, .tbz2
2055
================= =========================
2057
takes_args = ['dest', 'branch?']
2060
help="Type of file to export to.",
2065
help="Name of the root directory inside the exported file."),
2067
def run(self, dest, branch=None, revision=None, format=None, root=None):
2068
from bzrlib.export import export
2071
tree = WorkingTree.open_containing(u'.')[0]
2074
b = Branch.open(branch)
2076
if revision is None:
2077
# should be tree.last_revision FIXME
2078
rev_id = b.last_revision()
2080
if len(revision) != 1:
2081
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2082
rev_id = revision[0].in_history(b).rev_id
2083
t = b.repository.revision_tree(rev_id)
2085
export(t, dest, format, root)
2086
except errors.NoSuchExportFormat, e:
2087
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2090
class cmd_cat(Command):
2091
"""Write the contents of a file as of a given revision to standard output.
2093
If no revision is nominated, the last revision is used.
2095
Note: Take care to redirect standard output when using this command on a
2101
Option('name-from-revision', help='The path name in the old tree.'),
2104
takes_args = ['filename']
2105
encoding_type = 'exact'
2108
def run(self, filename, revision=None, name_from_revision=False):
2109
if revision is not None and len(revision) != 1:
2110
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2115
tree, b, relpath = \
2116
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2117
except errors.NotBranchError:
2120
if revision is not None and revision[0].get_branch() is not None:
2121
b = Branch.open(revision[0].get_branch())
2123
tree = b.basis_tree()
2124
if revision is None:
2125
revision_id = b.last_revision()
2127
revision_id = revision[0].in_history(b).rev_id
2129
cur_file_id = tree.path2id(relpath)
2130
rev_tree = b.repository.revision_tree(revision_id)
2131
old_file_id = rev_tree.path2id(relpath)
2133
if name_from_revision:
2134
if old_file_id is None:
2135
raise errors.BzrCommandError("%r is not present in revision %s"
2136
% (filename, revision_id))
2138
rev_tree.print_file(old_file_id)
2139
elif cur_file_id is not None:
2140
rev_tree.print_file(cur_file_id)
2141
elif old_file_id is not None:
2142
rev_tree.print_file(old_file_id)
2144
raise errors.BzrCommandError("%r is not present in revision %s" %
2145
(filename, revision_id))
2148
class cmd_local_time_offset(Command):
2149
"""Show the offset in seconds from GMT to local time."""
2153
print osutils.local_time_offset()
2157
class cmd_commit(Command):
2158
"""Commit changes into a new revision.
2160
If no arguments are given, the entire tree is committed.
2162
If selected files are specified, only changes to those files are
2163
committed. If a directory is specified then the directory and everything
2164
within it is committed.
2166
If author of the change is not the same person as the committer, you can
2167
specify the author's name using the --author option. The name should be
2168
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2170
A selected-file commit may fail in some cases where the committed
2171
tree would be invalid. Consider::
2176
bzr commit foo -m "committing foo"
2177
bzr mv foo/bar foo/baz
2180
bzr commit foo/bar -m "committing bar but not baz"
2182
In the example above, the last commit will fail by design. This gives
2183
the user the opportunity to decide whether they want to commit the
2184
rename at the same time, separately first, or not at all. (As a general
2185
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2187
Note: A selected-file commit after a merge is not yet supported.
2189
# TODO: Run hooks on tree to-be-committed, and after commit.
2191
# TODO: Strict commit that fails if there are deleted files.
2192
# (what does "deleted files" mean ??)
2194
# TODO: Give better message for -s, --summary, used by tla people
2196
# XXX: verbose currently does nothing
2198
_see_also = ['bugs', 'uncommit']
2199
takes_args = ['selected*']
2201
Option('message', type=unicode,
2203
help="Description of the new revision."),
2206
help='Commit even if nothing has changed.'),
2207
Option('file', type=str,
2210
help='Take commit message from this file.'),
2212
help="Refuse to commit if there are unknown "
2213
"files in the working tree."),
2214
ListOption('fixes', type=str,
2215
help="Mark a bug as being fixed by this revision."),
2216
Option('author', type=str,
2217
help="Set the author's name, if it's different "
2218
"from the committer."),
2220
help="Perform a local commit in a bound "
2221
"branch. Local commits are not pushed to "
2222
"the master branch until a normal commit "
2226
help='When no message is supplied, show the diff along'
2227
' with the status summary in the message editor.'),
2229
aliases = ['ci', 'checkin']
2231
def _get_bug_fix_properties(self, fixes, branch):
2233
# Configure the properties for bug fixing attributes.
2234
for fixed_bug in fixes:
2235
tokens = fixed_bug.split(':')
2236
if len(tokens) != 2:
2237
raise errors.BzrCommandError(
2238
"Invalid bug %s. Must be in the form of 'tag:id'. "
2239
"Commit refused." % fixed_bug)
2240
tag, bug_id = tokens
2242
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2243
except errors.UnknownBugTrackerAbbreviation:
2244
raise errors.BzrCommandError(
2245
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2246
except errors.MalformedBugIdentifier:
2247
raise errors.BzrCommandError(
2248
"Invalid bug identifier for %s. Commit refused."
2250
properties.append('%s fixed' % bug_url)
2251
return '\n'.join(properties)
2253
def run(self, message=None, file=None, verbose=False, selected_list=None,
2254
unchanged=False, strict=False, local=False, fixes=None,
2255
author=None, show_diff=False):
2256
from bzrlib.commit import (
2260
from bzrlib.errors import (
2265
from bzrlib.msgeditor import (
2266
edit_commit_message_encoded,
2267
make_commit_message_template_encoded
2270
# TODO: Need a blackbox test for invoking the external editor; may be
2271
# slightly problematic to run this cross-platform.
2273
# TODO: do more checks that the commit will succeed before
2274
# spending the user's valuable time typing a commit message.
2278
tree, selected_list = tree_files(selected_list)
2279
if selected_list == ['']:
2280
# workaround - commit of root of tree should be exactly the same
2281
# as just default commit in that tree, and succeed even though
2282
# selected-file merge commit is not done yet
2285
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2287
properties['bugs'] = bug_property
2289
if local and not tree.branch.get_bound_location():
2290
raise errors.LocalRequiresBoundBranch()
2292
def get_message(commit_obj):
2293
"""Callback to get commit message"""
2294
my_message = message
2295
if my_message is None and not file:
2296
t = make_commit_message_template_encoded(tree,
2297
selected_list, diff=show_diff,
2298
output_encoding=bzrlib.user_encoding)
2299
my_message = edit_commit_message_encoded(t)
2300
if my_message is None:
2301
raise errors.BzrCommandError("please specify a commit"
2302
" message with either --message or --file")
2303
elif my_message and file:
2304
raise errors.BzrCommandError(
2305
"please specify either --message or --file")
2307
my_message = codecs.open(file, 'rt',
2308
bzrlib.user_encoding).read()
2309
if my_message == "":
2310
raise errors.BzrCommandError("empty commit message specified")
2314
tree.commit(message_callback=get_message,
2315
specific_files=selected_list,
2316
allow_pointless=unchanged, strict=strict, local=local,
2317
reporter=None, verbose=verbose, revprops=properties,
2319
except PointlessCommit:
2320
# FIXME: This should really happen before the file is read in;
2321
# perhaps prepare the commit; get the message; then actually commit
2322
raise errors.BzrCommandError("no changes to commit."
2323
" use --unchanged to commit anyhow")
2324
except ConflictsInTree:
2325
raise errors.BzrCommandError('Conflicts detected in working '
2326
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2328
except StrictCommitFailed:
2329
raise errors.BzrCommandError("Commit refused because there are"
2330
" unknown files in the working tree.")
2331
except errors.BoundBranchOutOfDate, e:
2332
raise errors.BzrCommandError(str(e) + "\n"
2333
'To commit to master branch, run update and then commit.\n'
2334
'You can also pass --local to commit to continue working '
2338
class cmd_check(Command):
2339
"""Validate consistency of branch history.
2341
This command checks various invariants about the branch storage to
2342
detect data corruption or bzr bugs.
2345
_see_also = ['reconcile']
2346
takes_args = ['branch?']
2347
takes_options = ['verbose']
2349
def run(self, branch=None, verbose=False):
2350
from bzrlib.check import check
2352
tree = WorkingTree.open_containing()[0]
2353
branch = tree.branch
2355
branch = Branch.open(branch)
2356
check(branch, verbose)
2359
class cmd_upgrade(Command):
2360
"""Upgrade branch storage to current format.
2362
The check command or bzr developers may sometimes advise you to run
2363
this command. When the default format has changed you may also be warned
2364
during other operations to upgrade.
2367
_see_also = ['check']
2368
takes_args = ['url?']
2370
RegistryOption('format',
2371
help='Upgrade to a specific format. See "bzr help'
2372
' formats" for details.',
2373
registry=bzrdir.format_registry,
2374
converter=bzrdir.format_registry.make_bzrdir,
2375
value_switches=True, title='Branch format'),
2378
def run(self, url='.', format=None):
2379
from bzrlib.upgrade import upgrade
2381
format = bzrdir.format_registry.make_bzrdir('default')
2382
upgrade(url, format)
2385
class cmd_whoami(Command):
2386
"""Show or set bzr user id.
2389
Show the email of the current user::
2393
Set the current user::
2395
bzr whoami 'Frank Chu <fchu@example.com>'
2397
takes_options = [ Option('email',
2398
help='Display email address only.'),
2400
help='Set identity for the current branch instead of '
2403
takes_args = ['name?']
2404
encoding_type = 'replace'
2407
def run(self, email=False, branch=False, name=None):
2409
# use branch if we're inside one; otherwise global config
2411
c = Branch.open_containing('.')[0].get_config()
2412
except errors.NotBranchError:
2413
c = config.GlobalConfig()
2415
self.outf.write(c.user_email() + '\n')
2417
self.outf.write(c.username() + '\n')
2420
# display a warning if an email address isn't included in the given name.
2422
config.extract_email_address(name)
2423
except errors.NoEmailInUsername, e:
2424
warning('"%s" does not seem to contain an email address. '
2425
'This is allowed, but not recommended.', name)
2427
# use global config unless --branch given
2429
c = Branch.open_containing('.')[0].get_config()
2431
c = config.GlobalConfig()
2432
c.set_user_option('email', name)
2435
class cmd_nick(Command):
2436
"""Print or set the branch nickname.
2438
If unset, the tree root directory name is used as the nickname
2439
To print the current nickname, execute with no argument.
2442
_see_also = ['info']
2443
takes_args = ['nickname?']
2444
def run(self, nickname=None):
2445
branch = Branch.open_containing(u'.')[0]
2446
if nickname is None:
2447
self.printme(branch)
2449
branch.nick = nickname
2452
def printme(self, branch):
2456
class cmd_selftest(Command):
2457
"""Run internal test suite.
2459
If arguments are given, they are regular expressions that say which tests
2460
should run. Tests matching any expression are run, and other tests are
2463
Alternatively if --first is given, matching tests are run first and then
2464
all other tests are run. This is useful if you have been working in a
2465
particular area, but want to make sure nothing else was broken.
2467
If --exclude is given, tests that match that regular expression are
2468
excluded, regardless of whether they match --first or not.
2470
To help catch accidential dependencies between tests, the --randomize
2471
option is useful. In most cases, the argument used is the word 'now'.
2472
Note that the seed used for the random number generator is displayed
2473
when this option is used. The seed can be explicitly passed as the
2474
argument to this option if required. This enables reproduction of the
2475
actual ordering used if and when an order sensitive problem is encountered.
2477
If --list-only is given, the tests that would be run are listed. This is
2478
useful when combined with --first, --exclude and/or --randomize to
2479
understand their impact. The test harness reports "Listed nn tests in ..."
2480
instead of "Ran nn tests in ..." when list mode is enabled.
2482
If the global option '--no-plugins' is given, plugins are not loaded
2483
before running the selftests. This has two effects: features provided or
2484
modified by plugins will not be tested, and tests provided by plugins will
2487
Tests that need working space on disk use a common temporary directory,
2488
typically inside $TMPDIR or /tmp.
2491
Run only tests relating to 'ignore'::
2495
Disable plugins and list tests as they're run::
2497
bzr --no-plugins selftest -v
2499
# NB: this is used from the class without creating an instance, which is
2500
# why it does not have a self parameter.
2501
def get_transport_type(typestring):
2502
"""Parse and return a transport specifier."""
2503
if typestring == "sftp":
2504
from bzrlib.transport.sftp import SFTPAbsoluteServer
2505
return SFTPAbsoluteServer
2506
if typestring == "memory":
2507
from bzrlib.transport.memory import MemoryServer
2509
if typestring == "fakenfs":
2510
from bzrlib.transport.fakenfs import FakeNFSServer
2511
return FakeNFSServer
2512
msg = "No known transport type %s. Supported types are: sftp\n" %\
2514
raise errors.BzrCommandError(msg)
2517
takes_args = ['testspecs*']
2518
takes_options = ['verbose',
2520
help='Stop when one test fails.',
2524
help='Use a different transport by default '
2525
'throughout the test suite.',
2526
type=get_transport_type),
2528
help='Run the benchmarks rather than selftests.'),
2529
Option('lsprof-timed',
2530
help='Generate lsprof output for benchmarked'
2531
' sections of code.'),
2532
Option('cache-dir', type=str,
2533
help='Cache intermediate benchmark output in this '
2536
help='Run all tests, but run specified tests first.',
2540
help='List the tests instead of running them.'),
2541
Option('randomize', type=str, argname="SEED",
2542
help='Randomize the order of tests using the given'
2543
' seed or "now" for the current time.'),
2544
Option('exclude', type=str, argname="PATTERN",
2546
help='Exclude tests that match this regular'
2548
Option('strict', help='Fail on missing dependencies or '
2551
encoding_type = 'replace'
2553
def run(self, testspecs_list=None, verbose=False, one=False,
2554
transport=None, benchmark=None,
2555
lsprof_timed=None, cache_dir=None,
2556
first=False, list_only=False,
2557
randomize=None, exclude=None, strict=False):
2559
from bzrlib.tests import selftest
2560
import bzrlib.benchmarks as benchmarks
2561
from bzrlib.benchmarks import tree_creator
2563
if cache_dir is not None:
2564
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2566
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2567
print ' %s (%s python%s)' % (
2569
bzrlib.version_string,
2570
'.'.join(map(str, sys.version_info)),
2573
if testspecs_list is not None:
2574
pattern = '|'.join(testspecs_list)
2578
test_suite_factory = benchmarks.test_suite
2579
# Unless user explicitly asks for quiet, be verbose in benchmarks
2580
verbose = not is_quiet()
2581
# TODO: should possibly lock the history file...
2582
benchfile = open(".perf_history", "at", buffering=1)
2584
test_suite_factory = None
2587
result = selftest(verbose=verbose,
2589
stop_on_failure=one,
2590
transport=transport,
2591
test_suite_factory=test_suite_factory,
2592
lsprof_timed=lsprof_timed,
2593
bench_history=benchfile,
2594
matching_tests_first=first,
2595
list_only=list_only,
2596
random_seed=randomize,
2597
exclude_pattern=exclude,
2601
if benchfile is not None:
2604
info('tests passed')
2606
info('tests failed')
2607
return int(not result)
2610
class cmd_version(Command):
2611
"""Show version of bzr."""
2613
encoding_type = 'replace'
2617
from bzrlib.version import show_version
2618
show_version(to_file=self.outf)
2621
class cmd_rocks(Command):
2622
"""Statement of optimism."""
2628
print "It sure does!"
2631
class cmd_find_merge_base(Command):
2632
"""Find and print a base revision for merging two branches."""
2633
# TODO: Options to specify revisions on either side, as if
2634
# merging only part of the history.
2635
takes_args = ['branch', 'other']
2639
def run(self, branch, other):
2640
from bzrlib.revision import ensure_null, MultipleRevisionSources
2642
branch1 = Branch.open_containing(branch)[0]
2643
branch2 = Branch.open_containing(other)[0]
2645
last1 = ensure_null(branch1.last_revision())
2646
last2 = ensure_null(branch2.last_revision())
2648
graph = branch1.repository.get_graph(branch2.repository)
2649
base_rev_id = graph.find_unique_lca(last1, last2)
2651
print 'merge base is revision %s' % base_rev_id
2654
class cmd_merge(Command):
2655
"""Perform a three-way merge.
2657
The branch is the branch you will merge from. By default, it will merge
2658
the latest revision. If you specify a revision, that revision will be
2659
merged. If you specify two revisions, the first will be used as a BASE,
2660
and the second one as OTHER. Revision numbers are always relative to the
2663
By default, bzr will try to merge in all new work from the other
2664
branch, automatically determining an appropriate base. If this
2665
fails, you may need to give an explicit base.
2667
Merge will do its best to combine the changes in two branches, but there
2668
are some kinds of problems only a human can fix. When it encounters those,
2669
it will mark a conflict. A conflict means that you need to fix something,
2670
before you should commit.
2672
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2674
If there is no default branch set, the first merge will set it. After
2675
that, you can omit the branch to use the default. To change the
2676
default, use --remember. The value will only be saved if the remote
2677
location can be accessed.
2679
The results of the merge are placed into the destination working
2680
directory, where they can be reviewed (with bzr diff), tested, and then
2681
committed to record the result of the merge.
2683
merge refuses to run if there are any uncommitted changes, unless
2687
To merge the latest revision from bzr.dev::
2689
bzr merge ../bzr.dev
2691
To merge changes up to and including revision 82 from bzr.dev::
2693
bzr merge -r 82 ../bzr.dev
2695
To merge the changes introduced by 82, without previous changes::
2697
bzr merge -r 81..82 ../bzr.dev
2700
_see_also = ['update', 'remerge', 'status-flags']
2701
takes_args = ['branch?']
2705
help='Merge even if the destination tree has uncommitted changes.'),
2709
Option('show-base', help="Show base revision text in "
2711
Option('uncommitted', help='Apply uncommitted changes'
2712
' from a working copy, instead of branch changes.'),
2713
Option('pull', help='If the destination is already'
2714
' completely merged into the source, pull from the'
2715
' source rather than merging. When this happens,'
2716
' you do not need to commit the result.'),
2718
help='Branch to merge into, '
2719
'rather than the one containing the working directory.',
2725
def run(self, branch=None, revision=None, force=False, merge_type=None,
2726
show_base=False, reprocess=False, remember=False,
2727
uncommitted=False, pull=False,
2730
from bzrlib.tag import _merge_tags_if_possible
2731
# This is actually a branch (or merge-directive) *location*.
2735
if merge_type is None:
2736
merge_type = _mod_merge.Merge3Merger
2738
if directory is None: directory = u'.'
2739
possible_transports = []
2741
allow_pending = True
2742
verified = 'inapplicable'
2743
tree = WorkingTree.open_containing(directory)[0]
2744
change_reporter = delta._ChangeReporter(
2745
unversioned_filter=tree.is_ignored)
2748
pb = ui.ui_factory.nested_progress_bar()
2749
cleanups.append(pb.finished)
2751
cleanups.append(tree.unlock)
2752
if location is not None:
2753
mergeable, other_transport = _get_mergeable_helper(location)
2756
raise errors.BzrCommandError('Cannot use --uncommitted'
2757
' with bundles or merge directives.')
2759
if revision is not None:
2760
raise errors.BzrCommandError(
2761
'Cannot use -r with merge directives or bundles')
2762
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2764
possible_transports.append(other_transport)
2766
if merger is None and uncommitted:
2767
if revision is not None and len(revision) > 0:
2768
raise errors.BzrCommandError('Cannot use --uncommitted and'
2769
' --revision at the same time.')
2770
location = self._select_branch_location(tree, location)[0]
2771
other_tree, other_path = WorkingTree.open_containing(location)
2772
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2774
allow_pending = False
2777
merger, allow_pending = self._get_merger_from_branch(tree,
2778
location, revision, remember, possible_transports, pb)
2780
merger.merge_type = merge_type
2781
merger.reprocess = reprocess
2782
merger.show_base = show_base
2783
merger.change_reporter = change_reporter
2784
self.sanity_check_merger(merger)
2785
if (merger.base_rev_id == merger.other_rev_id and
2786
merger.other_rev_id != None):
2787
note('Nothing to do.')
2790
if merger.interesting_files is not None:
2791
raise BzrCommandError('Cannot pull individual files')
2792
if (merger.base_rev_id == tree.last_revision()):
2793
result = tree.pull(merger.other_branch, False,
2794
merger.other_rev_id)
2795
result.report(self.outf)
2797
merger.check_basis(not force)
2798
conflict_count = merger.do_merge()
2800
merger.set_pending()
2801
if verified == 'failed':
2802
warning('Preview patch does not match changes')
2803
if conflict_count != 0:
2808
for cleanup in reversed(cleanups):
2811
def sanity_check_merger(self, merger):
2812
if (merger.show_base and
2813
not merger.merge_type is _mod_merge.Merge3Merger):
2814
raise errors.BzrCommandError("Show-base is not supported for this"
2815
" merge type. %s" % merger.merge_type)
2816
if merger.reprocess and not merger.merge_type.supports_reprocess:
2817
raise errors.BzrCommandError("Conflict reduction is not supported"
2818
" for merge type %s." %
2820
if merger.reprocess and merger.show_base:
2821
raise errors.BzrCommandError("Cannot do conflict reduction and"
2824
def _get_merger_from_branch(self, tree, location, revision, remember,
2825
possible_transports, pb):
2826
"""Produce a merger from a location, assuming it refers to a branch."""
2827
from bzrlib.tag import _merge_tags_if_possible
2828
assert revision is None or len(revision) < 3
2829
# find the branch locations
2830
other_loc, location = self._select_branch_location(tree, location,
2832
if revision is not None and len(revision) == 2:
2833
base_loc, location = self._select_branch_location(tree, location,
2836
base_loc = other_loc
2838
other_branch, other_path = Branch.open_containing(other_loc,
2839
possible_transports)
2840
if base_loc == other_loc:
2841
base_branch = other_branch
2843
base_branch, base_path = Branch.open_containing(base_loc,
2844
possible_transports)
2845
# Find the revision ids
2846
if revision is None or len(revision) < 1 or revision[-1] is None:
2847
other_revision_id = _mod_revision.ensure_null(
2848
other_branch.last_revision())
2850
other_revision_id = \
2851
_mod_revision.ensure_null(
2852
revision[-1].in_history(other_branch).rev_id)
2853
if (revision is not None and len(revision) == 2
2854
and revision[0] is not None):
2855
base_revision_id = \
2856
_mod_revision.ensure_null(
2857
revision[0].in_history(base_branch).rev_id)
2859
base_revision_id = None
2860
# Remember where we merge from
2861
if ((tree.branch.get_parent() is None or remember) and
2862
other_branch is not None):
2863
tree.branch.set_parent(other_branch.base)
2864
_merge_tags_if_possible(other_branch, tree.branch)
2865
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2866
other_revision_id, base_revision_id, other_branch, base_branch)
2867
if other_path != '':
2868
allow_pending = False
2869
merger.interesting_files = [other_path]
2871
allow_pending = True
2872
return merger, allow_pending
2874
def _select_branch_location(self, tree, location, revision=None,
2876
"""Select a branch location, according to possible inputs.
2878
If provided, branches from ``revision`` are preferred. (Both
2879
``revision`` and ``index`` must be supplied.)
2881
Otherwise, the ``location`` parameter is used. If it is None, then the
2882
``parent`` location is used, and a note is printed.
2884
:param tree: The working tree to select a branch for merging into
2885
:param location: The location entered by the user
2886
:param revision: The revision parameter to the command
2887
:param index: The index to use for the revision parameter. Negative
2888
indices are permitted.
2889
:return: (selected_location, default_location). The default location
2890
will be the user-entered location, if any, or else the remembered
2893
if (revision is not None and index is not None
2894
and revision[index] is not None):
2895
branch = revision[index].get_branch()
2896
if branch is not None:
2897
return branch, location
2898
location = self._get_remembered_parent(tree, location, 'Merging from')
2899
return location, location
2901
# TODO: move up to common parent; this isn't merge-specific anymore.
2902
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2903
"""Use tree.branch's parent if none was supplied.
2905
Report if the remembered location was used.
2907
if supplied_location is not None:
2908
return supplied_location
2909
stored_location = tree.branch.get_parent()
2910
mutter("%s", stored_location)
2911
if stored_location is None:
2912
raise errors.BzrCommandError("No location specified or remembered")
2913
display_url = urlutils.unescape_for_display(stored_location,
2915
self.outf.write("%s remembered location %s\n" % (verb_string,
2917
return stored_location
2920
class cmd_remerge(Command):
2923
Use this if you want to try a different merge technique while resolving
2924
conflicts. Some merge techniques are better than others, and remerge
2925
lets you try different ones on different files.
2927
The options for remerge have the same meaning and defaults as the ones for
2928
merge. The difference is that remerge can (only) be run when there is a
2929
pending merge, and it lets you specify particular files.
2932
Re-do the merge of all conflicted files, and show the base text in
2933
conflict regions, in addition to the usual THIS and OTHER texts::
2935
bzr remerge --show-base
2937
Re-do the merge of "foobar", using the weave merge algorithm, with
2938
additional processing to reduce the size of conflict regions::
2940
bzr remerge --merge-type weave --reprocess foobar
2942
takes_args = ['file*']
2947
help="Show base revision text in conflicts."),
2950
def run(self, file_list=None, merge_type=None, show_base=False,
2952
if merge_type is None:
2953
merge_type = _mod_merge.Merge3Merger
2954
tree, file_list = tree_files(file_list)
2957
parents = tree.get_parent_ids()
2958
if len(parents) != 2:
2959
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2960
" merges. Not cherrypicking or"
2962
repository = tree.branch.repository
2963
graph = repository.get_graph()
2964
base_revision = graph.find_unique_lca(parents[0], parents[1])
2965
base_tree = repository.revision_tree(base_revision)
2966
other_tree = repository.revision_tree(parents[1])
2967
interesting_ids = None
2969
conflicts = tree.conflicts()
2970
if file_list is not None:
2971
interesting_ids = set()
2972
for filename in file_list:
2973
file_id = tree.path2id(filename)
2975
raise errors.NotVersionedError(filename)
2976
interesting_ids.add(file_id)
2977
if tree.kind(file_id) != "directory":
2980
for name, ie in tree.inventory.iter_entries(file_id):
2981
interesting_ids.add(ie.file_id)
2982
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2984
# Remerge only supports resolving contents conflicts
2985
allowed_conflicts = ('text conflict', 'contents conflict')
2986
restore_files = [c.path for c in conflicts
2987
if c.typestring in allowed_conflicts]
2988
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2989
tree.set_conflicts(ConflictList(new_conflicts))
2990
if file_list is not None:
2991
restore_files = file_list
2992
for filename in restore_files:
2994
restore(tree.abspath(filename))
2995
except errors.NotConflicted:
2997
# Disable pending merges, because the file texts we are remerging
2998
# have not had those merges performed. If we use the wrong parents
2999
# list, we imply that the working tree text has seen and rejected
3000
# all the changes from the other tree, when in fact those changes
3001
# have not yet been seen.
3002
tree.set_parent_ids(parents[:1])
3004
conflicts = _mod_merge.merge_inner(
3005
tree.branch, other_tree, base_tree,
3007
interesting_ids=interesting_ids,
3008
other_rev_id=parents[1],
3009
merge_type=merge_type,
3010
show_base=show_base,
3011
reprocess=reprocess)
3013
tree.set_parent_ids(parents)
3022
class cmd_revert(Command):
3023
"""Revert files to a previous revision.
3025
Giving a list of files will revert only those files. Otherwise, all files
3026
will be reverted. If the revision is not specified with '--revision', the
3027
last committed revision is used.
3029
To remove only some changes, without reverting to a prior version, use
3030
merge instead. For example, "merge . --r-2..-3" will remove the changes
3031
introduced by -2, without affecting the changes introduced by -1. Or
3032
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3034
By default, any files that have been manually changed will be backed up
3035
first. (Files changed only by merge are not backed up.) Backup files have
3036
'.~#~' appended to their name, where # is a number.
3038
When you provide files, you can use their current pathname or the pathname
3039
from the target revision. So you can use revert to "undelete" a file by
3040
name. If you name a directory, all the contents of that directory will be
3043
Any files that have been newly added since that revision will be deleted,
3044
with a backup kept if appropriate. Directories containing unknown files
3045
will not be deleted.
3048
_see_also = ['cat', 'export']
3051
Option('no-backup', "Do not save backups of reverted files."),
3052
Option('forget-merges',
3053
'Remove pending merge marker, without changing any files.'),
3055
takes_args = ['file*']
3057
def run(self, revision=None, no_backup=False, file_list=None,
3058
forget_merges=None):
3059
tree, file_list = tree_files(file_list)
3061
tree.set_parent_ids(tree.get_parent_ids()[:1])
3063
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3066
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3067
if revision is None:
3068
rev_id = tree.last_revision()
3069
elif len(revision) != 1:
3070
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3072
rev_id = revision[0].in_history(tree.branch).rev_id
3073
pb = ui.ui_factory.nested_progress_bar()
3075
tree.revert(file_list,
3076
tree.branch.repository.revision_tree(rev_id),
3077
not no_backup, pb, report_changes=True)
3082
class cmd_assert_fail(Command):
3083
"""Test reporting of assertion failures"""
3084
# intended just for use in testing
3089
raise AssertionError("always fails")
3092
class cmd_help(Command):
3093
"""Show help on a command or other topic.
3096
_see_also = ['topics']
3098
Option('long', 'Show help on all commands.'),
3100
takes_args = ['topic?']
3101
aliases = ['?', '--help', '-?', '-h']
3104
def run(self, topic=None, long=False):
3106
if topic is None and long:
3108
bzrlib.help.help(topic)
3111
class cmd_shell_complete(Command):
3112
"""Show appropriate completions for context.
3114
For a list of all available commands, say 'bzr shell-complete'.
3116
takes_args = ['context?']
3121
def run(self, context=None):
3122
import shellcomplete
3123
shellcomplete.shellcomplete(context)
3126
class cmd_fetch(Command):
3127
"""Copy in history from another branch but don't merge it.
3129
This is an internal method used for pull and merge.
3132
takes_args = ['from_branch', 'to_branch']
3133
def run(self, from_branch, to_branch):
3134
from bzrlib.fetch import Fetcher
3135
from_b = Branch.open(from_branch)
3136
to_b = Branch.open(to_branch)
3137
Fetcher(to_b, from_b)
3140
class cmd_missing(Command):
3141
"""Show unmerged/unpulled revisions between two branches.
3143
OTHER_BRANCH may be local or remote.
3146
_see_also = ['merge', 'pull']
3147
takes_args = ['other_branch?']
3149
Option('reverse', 'Reverse the order of revisions.'),
3151
'Display changes in the local branch only.'),
3152
Option('this' , 'Same as --mine-only.'),
3153
Option('theirs-only',
3154
'Display changes in the remote branch only.'),
3155
Option('other', 'Same as --theirs-only.'),
3160
encoding_type = 'replace'
3163
def run(self, other_branch=None, reverse=False, mine_only=False,
3164
theirs_only=False, log_format=None, long=False, short=False, line=False,
3165
show_ids=False, verbose=False, this=False, other=False):
3166
from bzrlib.missing import find_unmerged, iter_log_revisions
3167
from bzrlib.log import log_formatter
3174
local_branch = Branch.open_containing(u".")[0]
3175
parent = local_branch.get_parent()
3176
if other_branch is None:
3177
other_branch = parent
3178
if other_branch is None:
3179
raise errors.BzrCommandError("No peer location known"
3181
display_url = urlutils.unescape_for_display(parent,
3183
self.outf.write("Using last location: " + display_url + "\n")
3185
remote_branch = Branch.open(other_branch)
3186
if remote_branch.base == local_branch.base:
3187
remote_branch = local_branch
3188
local_branch.lock_read()
3190
remote_branch.lock_read()
3192
local_extra, remote_extra = find_unmerged(local_branch,
3194
if log_format is None:
3195
registry = log.log_formatter_registry
3196
log_format = registry.get_default(local_branch)
3197
lf = log_format(to_file=self.outf,
3199
show_timezone='original')
3200
if reverse is False:
3201
local_extra.reverse()
3202
remote_extra.reverse()
3203
if local_extra and not theirs_only:
3204
self.outf.write("You have %d extra revision(s):\n" %
3206
for revision in iter_log_revisions(local_extra,
3207
local_branch.repository,
3209
lf.log_revision(revision)
3210
printed_local = True
3212
printed_local = False
3213
if remote_extra and not mine_only:
3214
if printed_local is True:
3215
self.outf.write("\n\n\n")
3216
self.outf.write("You are missing %d revision(s):\n" %
3218
for revision in iter_log_revisions(remote_extra,
3219
remote_branch.repository,
3221
lf.log_revision(revision)
3222
if not remote_extra and not local_extra:
3224
self.outf.write("Branches are up to date.\n")
3228
remote_branch.unlock()
3230
local_branch.unlock()
3231
if not status_code and parent is None and other_branch is not None:
3232
local_branch.lock_write()
3234
# handle race conditions - a parent might be set while we run.
3235
if local_branch.get_parent() is None:
3236
local_branch.set_parent(remote_branch.base)
3238
local_branch.unlock()
3242
class cmd_pack(Command):
3243
"""Compress the data within a repository."""
3245
_see_also = ['repositories']
3246
takes_args = ['branch_or_repo?']
3248
def run(self, branch_or_repo='.'):
3249
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3251
branch = dir.open_branch()
3252
repository = branch.repository
3253
except errors.NotBranchError:
3254
repository = dir.open_repository()
3258
class cmd_plugins(Command):
3259
"""List the installed plugins.
3261
This command displays the list of installed plugins including the
3262
path where each one is located and a short description of each.
3264
A plugin is an external component for Bazaar that extends the
3265
revision control system, by adding or replacing code in Bazaar.
3266
Plugins can do a variety of things, including overriding commands,
3267
adding new commands, providing additional network transports and
3268
customizing log output.
3270
See the Bazaar web site, http://bazaar-vcs.org, for further
3271
information on plugins including where to find them and how to
3272
install them. Instructions are also provided there on how to
3273
write new plugins using the Python programming language.
3278
import bzrlib.plugin
3279
from inspect import getdoc
3280
for name, plugin in bzrlib.plugin.plugins().items():
3281
print plugin.path(), "[%s]" % plugin.__version__
3282
d = getdoc(plugin.module)
3284
print '\t', d.split('\n')[0]
3287
class cmd_testament(Command):
3288
"""Show testament (signing-form) of a revision."""
3291
Option('long', help='Produce long-format testament.'),
3293
help='Produce a strict-format testament.')]
3294
takes_args = ['branch?']
3296
def run(self, branch=u'.', revision=None, long=False, strict=False):
3297
from bzrlib.testament import Testament, StrictTestament
3299
testament_class = StrictTestament
3301
testament_class = Testament
3302
b = WorkingTree.open_containing(branch)[0].branch
3305
if revision is None:
3306
rev_id = b.last_revision()
3308
rev_id = revision[0].in_history(b).rev_id
3309
t = testament_class.from_revision(b.repository, rev_id)
3311
sys.stdout.writelines(t.as_text_lines())
3313
sys.stdout.write(t.as_short_text())
3318
class cmd_annotate(Command):
3319
"""Show the origin of each line in a file.
3321
This prints out the given file with an annotation on the left side
3322
indicating which revision, author and date introduced the change.
3324
If the origin is the same for a run of consecutive lines, it is
3325
shown only at the top, unless the --all option is given.
3327
# TODO: annotate directories; showing when each file was last changed
3328
# TODO: if the working copy is modified, show annotations on that
3329
# with new uncommitted lines marked
3330
aliases = ['ann', 'blame', 'praise']
3331
takes_args = ['filename']
3332
takes_options = [Option('all', help='Show annotations on all lines.'),
3333
Option('long', help='Show commit date in annotations.'),
3337
encoding_type = 'exact'
3340
def run(self, filename, all=False, long=False, revision=None,
3342
from bzrlib.annotate import annotate_file
3343
tree, relpath = WorkingTree.open_containing(filename)
3344
branch = tree.branch
3347
if revision is None:
3348
revision_id = branch.last_revision()
3349
elif len(revision) != 1:
3350
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3352
revision_id = revision[0].in_history(branch).rev_id
3353
file_id = tree.path2id(relpath)
3355
raise errors.NotVersionedError(filename)
3356
tree = branch.repository.revision_tree(revision_id)
3357
file_version = tree.inventory[file_id].revision
3358
annotate_file(branch, file_version, file_id, long, all, self.outf,
3364
class cmd_re_sign(Command):
3365
"""Create a digital signature for an existing revision."""
3366
# TODO be able to replace existing ones.
3368
hidden = True # is this right ?
3369
takes_args = ['revision_id*']
3370
takes_options = ['revision']
3372
def run(self, revision_id_list=None, revision=None):
3373
import bzrlib.gpg as gpg
3374
if revision_id_list is not None and revision is not None:
3375
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3376
if revision_id_list is None and revision is None:
3377
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3378
b = WorkingTree.open_containing(u'.')[0].branch
3379
gpg_strategy = gpg.GPGStrategy(b.get_config())
3380
if revision_id_list is not None:
3381
for revision_id in revision_id_list:
3382
b.repository.sign_revision(revision_id, gpg_strategy)
3383
elif revision is not None:
3384
if len(revision) == 1:
3385
revno, rev_id = revision[0].in_history(b)
3386
b.repository.sign_revision(rev_id, gpg_strategy)
3387
elif len(revision) == 2:
3388
# are they both on rh- if so we can walk between them
3389
# might be nice to have a range helper for arbitrary
3390
# revision paths. hmm.
3391
from_revno, from_revid = revision[0].in_history(b)
3392
to_revno, to_revid = revision[1].in_history(b)
3393
if to_revid is None:
3394
to_revno = b.revno()
3395
if from_revno is None or to_revno is None:
3396
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3397
for revno in range(from_revno, to_revno + 1):
3398
b.repository.sign_revision(b.get_rev_id(revno),
3401
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3404
class cmd_bind(Command):
3405
"""Convert the current branch into a checkout of the supplied branch.
3407
Once converted into a checkout, commits must succeed on the master branch
3408
before they will be applied to the local branch.
3411
_see_also = ['checkouts', 'unbind']
3412
takes_args = ['location?']
3415
def run(self, location=None):
3416
b, relpath = Branch.open_containing(u'.')
3417
if location is None:
3419
location = b.get_old_bound_location()
3420
except errors.UpgradeRequired:
3421
raise errors.BzrCommandError('No location supplied. '
3422
'This format does not remember old locations.')
3424
if location is None:
3425
raise errors.BzrCommandError('No location supplied and no '
3426
'previous location known')
3427
b_other = Branch.open(location)
3430
except errors.DivergedBranches:
3431
raise errors.BzrCommandError('These branches have diverged.'
3432
' Try merging, and then bind again.')
3435
class cmd_unbind(Command):
3436
"""Convert the current checkout into a regular branch.
3438
After unbinding, the local branch is considered independent and subsequent
3439
commits will be local only.
3442
_see_also = ['checkouts', 'bind']
3447
b, relpath = Branch.open_containing(u'.')
3449
raise errors.BzrCommandError('Local branch is not bound')
3452
class cmd_uncommit(Command):
3453
"""Remove the last committed revision.
3455
--verbose will print out what is being removed.
3456
--dry-run will go through all the motions, but not actually
3459
If --revision is specified, uncommit revisions to leave the branch at the
3460
specified revision. For example, "bzr uncommit -r 15" will leave the
3461
branch at revision 15.
3463
In the future, uncommit will create a revision bundle, which can then
3467
# TODO: jam 20060108 Add an option to allow uncommit to remove
3468
# unreferenced information in 'branch-as-repository' branches.
3469
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3470
# information in shared branches as well.
3471
_see_also = ['commit']
3472
takes_options = ['verbose', 'revision',
3473
Option('dry-run', help='Don\'t actually make changes.'),
3474
Option('force', help='Say yes to all questions.')]
3475
takes_args = ['location?']
3478
def run(self, location=None,
3479
dry_run=False, verbose=False,
3480
revision=None, force=False):
3481
from bzrlib.log import log_formatter, show_log
3483
from bzrlib.uncommit import uncommit
3485
if location is None:
3487
control, relpath = bzrdir.BzrDir.open_containing(location)
3489
tree = control.open_workingtree()
3491
except (errors.NoWorkingTree, errors.NotLocalUrl):
3493
b = control.open_branch()
3496
if revision is None:
3499
# 'bzr uncommit -r 10' actually means uncommit
3500
# so that the final tree is at revno 10.
3501
# but bzrlib.uncommit.uncommit() actually uncommits
3502
# the revisions that are supplied.
3503
# So we need to offset it by one
3504
revno = revision[0].in_history(b).revno+1
3506
if revno <= b.revno():
3507
rev_id = b.get_rev_id(revno)
3509
self.outf.write('No revisions to uncommit.\n')
3512
lf = log_formatter('short',
3514
show_timezone='original')
3519
direction='forward',
3520
start_revision=revno,
3521
end_revision=b.revno())
3524
print 'Dry-run, pretending to remove the above revisions.'
3526
val = raw_input('Press <enter> to continue')
3528
print 'The above revision(s) will be removed.'
3530
val = raw_input('Are you sure [y/N]? ')
3531
if val.lower() not in ('y', 'yes'):
3535
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3539
class cmd_break_lock(Command):
3540
"""Break a dead lock on a repository, branch or working directory.
3542
CAUTION: Locks should only be broken when you are sure that the process
3543
holding the lock has been stopped.
3545
You can get information on what locks are open via the 'bzr info' command.
3550
takes_args = ['location?']
3552
def run(self, location=None, show=False):
3553
if location is None:
3555
control, relpath = bzrdir.BzrDir.open_containing(location)
3557
control.break_lock()
3558
except NotImplementedError:
3562
class cmd_wait_until_signalled(Command):
3563
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3565
This just prints a line to signal when it is ready, then blocks on stdin.
3571
sys.stdout.write("running\n")
3573
sys.stdin.readline()
3576
class cmd_serve(Command):
3577
"""Run the bzr server."""
3579
aliases = ['server']
3583
help='Serve on stdin/out for use from inetd or sshd.'),
3585
help='Listen for connections on nominated port of the form '
3586
'[hostname:]portnumber. Passing 0 as the port number will '
3587
'result in a dynamically allocated port. The default port is '
3591
help='Serve contents of this directory.',
3593
Option('allow-writes',
3594
help='By default the server is a readonly server. Supplying '
3595
'--allow-writes enables write access to the contents of '
3596
'the served directory and below.'
3600
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3601
from bzrlib.smart import medium, server
3602
from bzrlib.transport import get_transport
3603
from bzrlib.transport.chroot import ChrootServer
3604
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3605
if directory is None:
3606
directory = os.getcwd()
3607
url = urlutils.local_path_to_url(directory)
3608
if not allow_writes:
3609
url = 'readonly+' + url
3610
chroot_server = ChrootServer(get_transport(url))
3611
chroot_server.setUp()
3612
t = get_transport(chroot_server.get_url())
3614
smart_server = medium.SmartServerPipeStreamMedium(
3615
sys.stdin, sys.stdout, t)
3617
host = BZR_DEFAULT_INTERFACE
3619
port = BZR_DEFAULT_PORT
3622
host, port = port.split(':')
3624
smart_server = server.SmartTCPServer(t, host=host, port=port)
3625
print 'listening on port: ', smart_server.port
3627
# for the duration of this server, no UI output is permitted.
3628
# note that this may cause problems with blackbox tests. This should
3629
# be changed with care though, as we dont want to use bandwidth sending
3630
# progress over stderr to smart server clients!
3631
old_factory = ui.ui_factory
3633
ui.ui_factory = ui.SilentUIFactory()
3634
smart_server.serve()
3636
ui.ui_factory = old_factory
3639
class cmd_join(Command):
3640
"""Combine a subtree into its containing tree.
3642
This command is for experimental use only. It requires the target tree
3643
to be in dirstate-with-subtree format, which cannot be converted into
3646
The TREE argument should be an independent tree, inside another tree, but
3647
not part of it. (Such trees can be produced by "bzr split", but also by
3648
running "bzr branch" with the target inside a tree.)
3650
The result is a combined tree, with the subtree no longer an independant
3651
part. This is marked as a merge of the subtree into the containing tree,
3652
and all history is preserved.
3654
If --reference is specified, the subtree retains its independence. It can
3655
be branched by itself, and can be part of multiple projects at the same
3656
time. But operations performed in the containing tree, such as commit
3657
and merge, will recurse into the subtree.
3660
_see_also = ['split']
3661
takes_args = ['tree']
3663
Option('reference', help='Join by reference.'),
3667
def run(self, tree, reference=False):
3668
sub_tree = WorkingTree.open(tree)
3669
parent_dir = osutils.dirname(sub_tree.basedir)
3670
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3671
repo = containing_tree.branch.repository
3672
if not repo.supports_rich_root():
3673
raise errors.BzrCommandError(
3674
"Can't join trees because %s doesn't support rich root data.\n"
3675
"You can use bzr upgrade on the repository."
3679
containing_tree.add_reference(sub_tree)
3680
except errors.BadReferenceTarget, e:
3681
# XXX: Would be better to just raise a nicely printable
3682
# exception from the real origin. Also below. mbp 20070306
3683
raise errors.BzrCommandError("Cannot join %s. %s" %
3687
containing_tree.subsume(sub_tree)
3688
except errors.BadSubsumeSource, e:
3689
raise errors.BzrCommandError("Cannot join %s. %s" %
3693
class cmd_split(Command):
3694
"""Split a tree into two trees.
3696
This command is for experimental use only. It requires the target tree
3697
to be in dirstate-with-subtree format, which cannot be converted into
3700
The TREE argument should be a subdirectory of a working tree. That
3701
subdirectory will be converted into an independent tree, with its own
3702
branch. Commits in the top-level tree will not apply to the new subtree.
3703
If you want that behavior, do "bzr join --reference TREE".
3706
_see_also = ['join']
3707
takes_args = ['tree']
3711
def run(self, tree):
3712
containing_tree, subdir = WorkingTree.open_containing(tree)
3713
sub_id = containing_tree.path2id(subdir)
3715
raise errors.NotVersionedError(subdir)
3717
containing_tree.extract(sub_id)
3718
except errors.RootNotRich:
3719
raise errors.UpgradeRequired(containing_tree.branch.base)
3723
class cmd_merge_directive(Command):
3724
"""Generate a merge directive for auto-merge tools.
3726
A directive requests a merge to be performed, and also provides all the
3727
information necessary to do so. This means it must either include a
3728
revision bundle, or the location of a branch containing the desired
3731
A submit branch (the location to merge into) must be supplied the first
3732
time the command is issued. After it has been supplied once, it will
3733
be remembered as the default.
3735
A public branch is optional if a revision bundle is supplied, but required
3736
if --diff or --plain is specified. It will be remembered as the default
3737
after the first use.
3740
takes_args = ['submit_branch?', 'public_branch?']
3744
_see_also = ['send']
3747
RegistryOption.from_kwargs('patch-type',
3748
'The type of patch to include in the directive.',
3750
value_switches=True,
3752
bundle='Bazaar revision bundle (default).',
3753
diff='Normal unified diff.',
3754
plain='No patch, just directive.'),
3755
Option('sign', help='GPG-sign the directive.'), 'revision',
3756
Option('mail-to', type=str,
3757
help='Instead of printing the directive, email to this address.'),
3758
Option('message', type=str, short_name='m',
3759
help='Message to use when committing this merge.')
3762
encoding_type = 'exact'
3764
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3765
sign=False, revision=None, mail_to=None, message=None):
3766
from bzrlib.revision import ensure_null, NULL_REVISION
3767
include_patch, include_bundle = {
3768
'plain': (False, False),
3769
'diff': (True, False),
3770
'bundle': (True, True),
3772
branch = Branch.open('.')
3773
stored_submit_branch = branch.get_submit_branch()
3774
if submit_branch is None:
3775
submit_branch = stored_submit_branch
3777
if stored_submit_branch is None:
3778
branch.set_submit_branch(submit_branch)
3779
if submit_branch is None:
3780
submit_branch = branch.get_parent()
3781
if submit_branch is None:
3782
raise errors.BzrCommandError('No submit branch specified or known')
3784
stored_public_branch = branch.get_public_branch()
3785
if public_branch is None:
3786
public_branch = stored_public_branch
3787
elif stored_public_branch is None:
3788
branch.set_public_branch(public_branch)
3789
if not include_bundle and public_branch is None:
3790
raise errors.BzrCommandError('No public branch specified or'
3792
base_revision_id = None
3793
if revision is not None:
3794
if len(revision) > 2:
3795
raise errors.BzrCommandError('bzr merge-directive takes '
3796
'at most two one revision identifiers')
3797
revision_id = revision[-1].in_history(branch).rev_id
3798
if len(revision) == 2:
3799
base_revision_id = revision[0].in_history(branch).rev_id
3800
base_revision_id = ensure_null(base_revision_id)
3802
revision_id = branch.last_revision()
3803
revision_id = ensure_null(revision_id)
3804
if revision_id == NULL_REVISION:
3805
raise errors.BzrCommandError('No revisions to bundle.')
3806
directive = merge_directive.MergeDirective2.from_objects(
3807
branch.repository, revision_id, time.time(),
3808
osutils.local_time_offset(), submit_branch,
3809
public_branch=public_branch, include_patch=include_patch,
3810
include_bundle=include_bundle, message=message,
3811
base_revision_id=base_revision_id)
3814
self.outf.write(directive.to_signed(branch))
3816
self.outf.writelines(directive.to_lines())
3818
message = directive.to_email(mail_to, branch, sign)
3819
s = SMTPConnection(branch.get_config())
3820
s.send_email(message)
3823
class cmd_send(Command):
3824
"""Mail or create a merge-directive for submiting changes.
3826
A merge directive provides many things needed for requesting merges:
3828
* A machine-readable description of the merge to perform
3830
* An optional patch that is a preview of the changes requested
3832
* An optional bundle of revision data, so that the changes can be applied
3833
directly from the merge directive, without retrieving data from a
3836
If --no-bundle is specified, then public_branch is needed (and must be
3837
up-to-date), so that the receiver can perform the merge using the
3838
public_branch. The public_branch is always included if known, so that
3839
people can check it later.
3841
The submit branch defaults to the parent, but can be overridden. Both
3842
submit branch and public branch will be remembered if supplied.
3844
If a public_branch is known for the submit_branch, that public submit
3845
branch is used in the merge instructions. This means that a local mirror
3846
can be used as your actual submit branch, once you have set public_branch
3849
Mail is sent using your preferred mail program. This should be transparent
3850
on Windows (it uses MAPI). On *nix, it requires the xdg-email utility. If
3851
the preferred client can't be found (or used), your editor will be used.
3853
To use a specific mail program, set the mail_client configuration option.
3854
(For Thunderbird 1.5, this works around some bugs.) Supported values for
3855
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
3856
generic options are "default", "editor", "mapi", and "xdg-email".
3858
If mail is being sent, a to address is required. This can be supplied
3859
either on the commandline, or by setting the submit_to configuration
3862
Two formats are currently supported: "4" uses revision bundle format 4 and
3863
merge directive format 2. It is significantly faster and smaller than
3864
older formats. It is compatible with Bazaar 0.19 and later. It is the
3865
default. "0.9" uses revision bundle format 0.9 and merge directive
3866
format 1. It is compatible with Bazaar 0.12 - 0.18.
3869
encoding_type = 'exact'
3871
_see_also = ['merge']
3873
takes_args = ['submit_branch?', 'public_branch?']
3877
help='Do not include a bundle in the merge directive.'),
3878
Option('no-patch', help='Do not include a preview patch in the merge'
3881
help='Remember submit and public branch.'),
3883
help='Branch to generate the submission from, '
3884
'rather than the one containing the working directory.',
3887
Option('output', short_name='o', help='Write directive to this file.',
3889
Option('mail-to', help='Mail the request to this address.',
3893
RegistryOption.from_kwargs('format',
3894
'Use the specified output format.',
3895
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
3896
'0.9': 'Bundle format 0.9, Merge Directive 1',})
3899
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3900
no_patch=False, revision=None, remember=False, output=None,
3901
format='4', mail_to=None, message=None, **kwargs):
3902
return self._run(submit_branch, revision, public_branch, remember,
3903
format, no_bundle, no_patch, output,
3904
kwargs.get('from', '.'), mail_to, message)
3906
def _run(self, submit_branch, revision, public_branch, remember, format,
3907
no_bundle, no_patch, output, from_, mail_to, message):
3908
from bzrlib.revision import ensure_null, NULL_REVISION
3910
outfile = StringIO()
3914
outfile = open(output, 'wb')
3916
branch = Branch.open_containing(from_)[0]
3918
config = branch.get_config()
3920
mail_to = config.get_user_option('submit_to')
3922
raise errors.BzrCommandError('No mail-to address'
3924
mail_client = config.get_mail_client()
3925
if remember and submit_branch is None:
3926
raise errors.BzrCommandError(
3927
'--remember requires a branch to be specified.')
3928
stored_submit_branch = branch.get_submit_branch()
3929
remembered_submit_branch = False
3930
if submit_branch is None:
3931
submit_branch = stored_submit_branch
3932
remembered_submit_branch = True
3934
if stored_submit_branch is None or remember:
3935
branch.set_submit_branch(submit_branch)
3936
if submit_branch is None:
3937
submit_branch = branch.get_parent()
3938
remembered_submit_branch = True
3939
if submit_branch is None:
3940
raise errors.BzrCommandError('No submit branch known or'
3942
if remembered_submit_branch:
3943
note('Using saved location: %s', submit_branch)
3945
stored_public_branch = branch.get_public_branch()
3946
if public_branch is None:
3947
public_branch = stored_public_branch
3948
elif stored_public_branch is None or remember:
3949
branch.set_public_branch(public_branch)
3950
if no_bundle and public_branch is None:
3951
raise errors.BzrCommandError('No public branch specified or'
3953
base_revision_id = None
3955
if revision is not None:
3956
if len(revision) > 2:
3957
raise errors.BzrCommandError('bzr send takes '
3958
'at most two one revision identifiers')
3959
revision_id = revision[-1].in_history(branch).rev_id
3960
if len(revision) == 2:
3961
base_revision_id = revision[0].in_history(branch).rev_id
3962
if revision_id is None:
3963
revision_id = branch.last_revision()
3964
if revision_id == NULL_REVISION:
3965
raise errors.BzrCommandError('No revisions to submit.')
3967
directive = merge_directive.MergeDirective2.from_objects(
3968
branch.repository, revision_id, time.time(),
3969
osutils.local_time_offset(), submit_branch,
3970
public_branch=public_branch, include_patch=not no_patch,
3971
include_bundle=not no_bundle, message=message,
3972
base_revision_id=base_revision_id)
3973
elif format == '0.9':
3976
patch_type = 'bundle'
3978
raise errors.BzrCommandError('Format 0.9 does not'
3979
' permit bundle with no patch')
3985
directive = merge_directive.MergeDirective.from_objects(
3986
branch.repository, revision_id, time.time(),
3987
osutils.local_time_offset(), submit_branch,
3988
public_branch=public_branch, patch_type=patch_type,
3991
outfile.writelines(directive.to_lines())
3993
subject = '[MERGE] '
3994
if message is not None:
3997
revision = branch.repository.get_revision(revision_id)
3998
subject += revision.get_summary()
3999
mail_client.compose_merge_request(mail_to, subject,
4006
class cmd_bundle_revisions(cmd_send):
4008
"""Create a merge-directive for submiting changes.
4010
A merge directive provides many things needed for requesting merges:
4012
* A machine-readable description of the merge to perform
4014
* An optional patch that is a preview of the changes requested
4016
* An optional bundle of revision data, so that the changes can be applied
4017
directly from the merge directive, without retrieving data from a
4020
If --no-bundle is specified, then public_branch is needed (and must be
4021
up-to-date), so that the receiver can perform the merge using the
4022
public_branch. The public_branch is always included if known, so that
4023
people can check it later.
4025
The submit branch defaults to the parent, but can be overridden. Both
4026
submit branch and public branch will be remembered if supplied.
4028
If a public_branch is known for the submit_branch, that public submit
4029
branch is used in the merge instructions. This means that a local mirror
4030
can be used as your actual submit branch, once you have set public_branch
4033
Two formats are currently supported: "4" uses revision bundle format 4 and
4034
merge directive format 2. It is significantly faster and smaller than
4035
older formats. It is compatible with Bazaar 0.19 and later. It is the
4036
default. "0.9" uses revision bundle format 0.9 and merge directive
4037
format 1. It is compatible with Bazaar 0.12 - 0.18.
4042
help='Do not include a bundle in the merge directive.'),
4043
Option('no-patch', help='Do not include a preview patch in the merge'
4046
help='Remember submit and public branch.'),
4048
help='Branch to generate the submission from, '
4049
'rather than the one containing the working directory.',
4052
Option('output', short_name='o', help='Write directive to this file.',
4055
RegistryOption.from_kwargs('format',
4056
'Use the specified output format.',
4057
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4058
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4060
aliases = ['bundle']
4062
_see_also = ['send', 'merge']
4066
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4067
no_patch=False, revision=None, remember=False, output=None,
4068
format='4', **kwargs):
4071
return self._run(submit_branch, revision, public_branch, remember,
4072
format, no_bundle, no_patch, output,
4073
kwargs.get('from', '.'), None, None)
4076
class cmd_tag(Command):
4077
"""Create, remove or modify a tag naming a revision.
4079
Tags give human-meaningful names to revisions. Commands that take a -r
4080
(--revision) option can be given -rtag:X, where X is any previously
4083
Tags are stored in the branch. Tags are copied from one branch to another
4084
along when you branch, push, pull or merge.
4086
It is an error to give a tag name that already exists unless you pass
4087
--force, in which case the tag is moved to point to the new revision.
4090
_see_also = ['commit', 'tags']
4091
takes_args = ['tag_name']
4094
help='Delete this tag rather than placing it.',
4097
help='Branch in which to place the tag.',
4102
help='Replace existing tags.',
4107
def run(self, tag_name,
4113
branch, relpath = Branch.open_containing(directory)
4117
branch.tags.delete_tag(tag_name)
4118
self.outf.write('Deleted tag %s.\n' % tag_name)
4121
if len(revision) != 1:
4122
raise errors.BzrCommandError(
4123
"Tags can only be placed on a single revision, "
4125
revision_id = revision[0].in_history(branch).rev_id
4127
revision_id = branch.last_revision()
4128
if (not force) and branch.tags.has_tag(tag_name):
4129
raise errors.TagAlreadyExists(tag_name)
4130
branch.tags.set_tag(tag_name, revision_id)
4131
self.outf.write('Created tag %s.\n' % tag_name)
4136
class cmd_tags(Command):
4139
This tag shows a table of tag names and the revisions they reference.
4145
help='Branch whose tags should be displayed.',
4155
branch, relpath = Branch.open_containing(directory)
4156
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
4157
self.outf.write('%-20s %s\n' % (tag_name, target))
4160
class cmd_reconfigure(Command):
4161
"""Reconfigure the type of a bzr directory.
4163
A target configuration must be specified.
4165
For checkouts, the bind-to location will be auto-detected if not specified.
4166
The order of preference is
4167
1. For a lightweight checkout, the current bound location.
4168
2. For branches that used to be checkouts, the previously-bound location.
4169
3. The push location.
4170
4. The parent location.
4171
If none of these is available, --bind-to must be specified.
4174
takes_args = ['location?']
4175
takes_options = [RegistryOption.from_kwargs('target_type',
4176
title='Target type',
4177
help='The type to reconfigure the directory to.',
4178
value_switches=True, enum_switch=False,
4179
branch='Reconfigure to a branch.',
4180
tree='Reconfigure to a tree.',
4181
checkout='Reconfigure to a checkout.'),
4182
Option('bind-to', help='Branch to bind checkout to.',
4185
help='Perform reconfiguration even if local changes'
4189
def run(self, location=None, target_type=None, bind_to=None, force=False):
4190
directory = bzrdir.BzrDir.open(location)
4191
if target_type is None:
4192
raise errors.BzrCommandError('No target configuration specified')
4193
elif target_type == 'branch':
4194
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4195
elif target_type == 'tree':
4196
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4197
elif target_type == 'checkout':
4198
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4200
reconfiguration.apply(force)
4203
def _create_prefix(cur_transport):
4204
needed = [cur_transport]
4205
# Recurse upwards until we can create a directory successfully
4207
new_transport = cur_transport.clone('..')
4208
if new_transport.base == cur_transport.base:
4209
raise errors.BzrCommandError(
4210
"Failed to create path prefix for %s."
4211
% cur_transport.base)
4213
new_transport.mkdir('.')
4214
except errors.NoSuchFile:
4215
needed.append(new_transport)
4216
cur_transport = new_transport
4219
# Now we only need to create child directories
4221
cur_transport = needed.pop()
4222
cur_transport.ensure_base()
4225
def _get_mergeable_helper(location):
4226
"""Get a merge directive or bundle if 'location' points to one.
4228
Try try to identify a bundle and returns its mergeable form. If it's not,
4229
we return the tried transport anyway so that it can reused to access the
4232
:param location: can point to a bundle or a branch.
4234
:return: mergeable, transport
4237
url = urlutils.normalize_url(location)
4238
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4239
location_transport = transport.get_transport(url)
4242
# There may be redirections but we ignore the intermediate
4243
# and final transports used
4244
read = bundle.read_mergeable_from_transport
4245
mergeable, t = read(location_transport, filename)
4246
except errors.NotABundle:
4247
# Continue on considering this url a Branch but adjust the
4248
# location_transport
4249
location_transport = location_transport.clone(filename)
4250
return mergeable, location_transport
4253
# these get imported and then picked up by the scan for cmd_*
4254
# TODO: Some more consistent way to split command definitions across files;
4255
# we do need to load at least some information about them to know of
4256
# aliases. ideally we would avoid loading the implementation until the
4257
# details were needed.
4258
from bzrlib.cmd_version_info import cmd_version_info
4259
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4260
from bzrlib.bundle.commands import (
4263
from bzrlib.sign_my_commits import cmd_sign_my_commits
4264
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4265
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
