1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
20
from StringIO import StringIO
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
47
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revisionspec import RevisionSpec
58
from bzrlib.smtp_connection import SMTPConnection
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
64
from bzrlib.progress import DummyProgress, ProgressPhase
65
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
68
def tree_files(file_list, default_branch=u'.'):
70
return internal_tree_files(file_list, default_branch)
71
except errors.FileInWrongBranch, e:
72
raise errors.BzrCommandError("%s is not in the same branch as %s" %
73
(e.path, file_list[0]))
76
# XXX: Bad function name; should possibly also be a class method of
77
# WorkingTree rather than a function.
78
def internal_tree_files(file_list, default_branch=u'.'):
79
"""Convert command-line paths to a WorkingTree and relative paths.
81
This is typically used for command-line processors that take one or
82
more filenames, and infer the workingtree that contains them.
84
The filenames given are not required to exist.
86
:param file_list: Filenames to convert.
88
:param default_branch: Fallback tree path to use if file_list is empty or
91
:return: workingtree, [relative_paths]
93
if file_list is None or len(file_list) == 0:
94
return WorkingTree.open_containing(default_branch)[0], file_list
95
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
97
for filename in file_list:
99
new_list.append(tree.relpath(osutils.dereference_path(filename)))
100
except errors.PathNotChild:
101
raise errors.FileInWrongBranch(tree.branch, filename)
102
return tree, new_list
105
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
106
def get_format_type(typestring):
107
"""Parse and return a format specifier."""
108
# Have to use BzrDirMetaFormat1 directly, so that
109
# RepositoryFormat.set_default_format works
110
if typestring == "default":
111
return bzrdir.BzrDirMetaFormat1()
113
return bzrdir.format_registry.make_bzrdir(typestring)
115
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
116
raise errors.BzrCommandError(msg)
119
# TODO: Make sure no commands unconditionally use the working directory as a
120
# branch. If a filename argument is used, the first of them should be used to
121
# specify the branch. (Perhaps this can be factored out into some kind of
122
# Argument class, representing a file in a branch, where the first occurrence
125
class cmd_status(Command):
126
"""Display status summary.
128
This reports on versioned and unknown files, reporting them
129
grouped by state. Possible states are:
132
Versioned in the working copy but not in the previous revision.
135
Versioned in the previous revision but removed or deleted
139
Path of this file changed from the previous revision;
140
the text may also have changed. This includes files whose
141
parent directory was renamed.
144
Text has changed since the previous revision.
147
File kind has been changed (e.g. from file to directory).
150
Not versioned and not matching an ignore pattern.
152
To see ignored files use 'bzr ignored'. For details on the
153
changes to file texts, use 'bzr diff'.
155
Note that --short or -S gives status flags for each item, similar
156
to Subversion's status command. To get output similar to svn -q,
159
If no arguments are specified, the status of the entire working
160
directory is shown. Otherwise, only the status of the specified
161
files or directories is reported. If a directory is given, status
162
is reported for everything inside that directory.
164
If a revision argument is given, the status is calculated against
165
that revision, or between two revisions if two are provided.
168
# TODO: --no-recurse, --recurse options
170
takes_args = ['file*']
171
takes_options = ['show-ids', 'revision', 'change',
172
Option('short', help='Use short status indicators.',
174
Option('versioned', help='Only show versioned files.',
177
aliases = ['st', 'stat']
179
encoding_type = 'replace'
180
_see_also = ['diff', 'revert', 'status-flags']
183
def run(self, show_ids=False, file_list=None, revision=None, short=False,
185
from bzrlib.status import show_tree_status
187
if revision and len(revision) > 2:
188
raise errors.BzrCommandError('bzr status --revision takes exactly'
189
' one or two revision specifiers')
191
tree, file_list = tree_files(file_list)
193
show_tree_status(tree, show_ids=show_ids,
194
specific_files=file_list, revision=revision,
195
to_file=self.outf, short=short, versioned=versioned)
198
class cmd_cat_revision(Command):
199
"""Write out metadata for a revision.
201
The revision to print can either be specified by a specific
202
revision identifier, or you can use --revision.
206
takes_args = ['revision_id?']
207
takes_options = ['revision']
208
# cat-revision is more for frontends so should be exact
212
def run(self, revision_id=None, revision=None):
214
revision_id = osutils.safe_revision_id(revision_id, warn=False)
215
if revision_id is not None and revision is not None:
216
raise errors.BzrCommandError('You can only supply one of'
217
' revision_id or --revision')
218
if revision_id is None and revision is None:
219
raise errors.BzrCommandError('You must supply either'
220
' --revision or a revision_id')
221
b = WorkingTree.open_containing(u'.')[0].branch
223
# TODO: jam 20060112 should cat-revision always output utf-8?
224
if revision_id is not None:
225
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
226
elif revision is not None:
229
raise errors.BzrCommandError('You cannot specify a NULL'
231
revno, rev_id = rev.in_history(b)
232
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
235
class cmd_remove_tree(Command):
236
"""Remove the working tree from a given branch/checkout.
238
Since a lightweight checkout is little more than a working tree
239
this will refuse to run against one.
241
To re-create the working tree, use "bzr checkout".
243
_see_also = ['checkout', 'working-trees']
245
takes_args = ['location?']
247
def run(self, location='.'):
248
d = bzrdir.BzrDir.open(location)
251
working = d.open_workingtree()
252
except errors.NoWorkingTree:
253
raise errors.BzrCommandError("No working tree to remove")
254
except errors.NotLocalUrl:
255
raise errors.BzrCommandError("You cannot remove the working tree of a "
258
working_path = working.bzrdir.root_transport.base
259
branch_path = working.branch.bzrdir.root_transport.base
260
if working_path != branch_path:
261
raise errors.BzrCommandError("You cannot remove the working tree from "
262
"a lightweight checkout")
264
d.destroy_workingtree()
267
class cmd_revno(Command):
268
"""Show current revision number.
270
This is equal to the number of revisions on this branch.
274
takes_args = ['location?']
277
def run(self, location=u'.'):
278
self.outf.write(str(Branch.open_containing(location)[0].revno()))
279
self.outf.write('\n')
282
class cmd_revision_info(Command):
283
"""Show revision number and revision id for a given revision identifier.
286
takes_args = ['revision_info*']
287
takes_options = ['revision']
290
def run(self, revision=None, revision_info_list=[]):
293
if revision is not None:
294
revs.extend(revision)
295
if revision_info_list is not None:
296
for rev in revision_info_list:
297
revs.append(RevisionSpec.from_string(rev))
299
b = Branch.open_containing(u'.')[0]
302
revs.append(RevisionSpec.from_string('-1'))
305
revinfo = rev.in_history(b)
306
if revinfo.revno is None:
307
dotted_map = b.get_revision_id_to_revno_map()
308
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
309
print '%s %s' % (revno, revinfo.rev_id)
311
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
314
class cmd_add(Command):
315
"""Add specified files or directories.
317
In non-recursive mode, all the named items are added, regardless
318
of whether they were previously ignored. A warning is given if
319
any of the named files are already versioned.
321
In recursive mode (the default), files are treated the same way
322
but the behaviour for directories is different. Directories that
323
are already versioned do not give a warning. All directories,
324
whether already versioned or not, are searched for files or
325
subdirectories that are neither versioned or ignored, and these
326
are added. This search proceeds recursively into versioned
327
directories. If no names are given '.' is assumed.
329
Therefore simply saying 'bzr add' will version all files that
330
are currently unknown.
332
Adding a file whose parent directory is not versioned will
333
implicitly add the parent, and so on up to the root. This means
334
you should never need to explicitly add a directory, they'll just
335
get added when you add a file in the directory.
337
--dry-run will show which files would be added, but not actually
340
--file-ids-from will try to use the file ids from the supplied path.
341
It looks up ids trying to find a matching parent directory with the
342
same filename, and then by pure path. This option is rarely needed
343
but can be useful when adding the same logical file into two
344
branches that will be merged later (without showing the two different
345
adds as a conflict). It is also useful when merging another project
346
into a subdirectory of this one.
348
takes_args = ['file*']
351
help="Don't recursively add the contents of directories."),
353
help="Show what would be done, but don't actually do anything."),
355
Option('file-ids-from',
357
help='Lookup file ids from this tree.'),
359
encoding_type = 'replace'
360
_see_also = ['remove']
362
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
367
if file_ids_from is not None:
369
base_tree, base_path = WorkingTree.open_containing(
371
except errors.NoWorkingTree:
372
base_branch, base_path = Branch.open_containing(
374
base_tree = base_branch.basis_tree()
376
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
377
to_file=self.outf, should_print=(not is_quiet()))
379
action = bzrlib.add.AddAction(to_file=self.outf,
380
should_print=(not is_quiet()))
383
base_tree.lock_read()
385
file_list = self._maybe_expand_globs(file_list)
387
tree = WorkingTree.open_containing(file_list[0])[0]
389
tree = WorkingTree.open_containing(u'.')[0]
390
added, ignored = tree.smart_add(file_list, not
391
no_recurse, action=action, save=not dry_run)
393
if base_tree is not None:
397
for glob in sorted(ignored.keys()):
398
for path in ignored[glob]:
399
self.outf.write("ignored %s matching \"%s\"\n"
403
for glob, paths in ignored.items():
404
match_len += len(paths)
405
self.outf.write("ignored %d file(s).\n" % match_len)
406
self.outf.write("If you wish to add some of these files,"
407
" please add them by name.\n")
410
class cmd_mkdir(Command):
411
"""Create a new versioned directory.
413
This is equivalent to creating the directory and then adding it.
416
takes_args = ['dir+']
417
encoding_type = 'replace'
419
def run(self, dir_list):
422
wt, dd = WorkingTree.open_containing(d)
424
self.outf.write('added %s\n' % d)
427
class cmd_relpath(Command):
428
"""Show path of a file relative to root"""
430
takes_args = ['filename']
434
def run(self, filename):
435
# TODO: jam 20050106 Can relpath return a munged path if
436
# sys.stdout encoding cannot represent it?
437
tree, relpath = WorkingTree.open_containing(filename)
438
self.outf.write(relpath)
439
self.outf.write('\n')
442
class cmd_inventory(Command):
443
"""Show inventory of the current working copy or a revision.
445
It is possible to limit the output to a particular entry
446
type using the --kind option. For example: --kind file.
448
It is also possible to restrict the list of files to a specific
449
set. For example: bzr inventory --show-ids this/file
458
help='List entries of a particular kind: file, directory, symlink.',
461
takes_args = ['file*']
464
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
465
if kind and kind not in ['file', 'directory', 'symlink']:
466
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
468
work_tree, file_list = tree_files(file_list)
469
work_tree.lock_read()
471
if revision is not None:
472
if len(revision) > 1:
473
raise errors.BzrCommandError(
474
'bzr inventory --revision takes exactly one revision'
476
revision_id = revision[0].in_history(work_tree.branch).rev_id
477
tree = work_tree.branch.repository.revision_tree(revision_id)
479
extra_trees = [work_tree]
485
if file_list is not None:
486
file_ids = tree.paths2ids(file_list, trees=extra_trees,
487
require_versioned=True)
488
# find_ids_across_trees may include some paths that don't
490
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
491
for file_id in file_ids if file_id in tree)
493
entries = tree.inventory.entries()
496
if tree is not work_tree:
499
for path, entry in entries:
500
if kind and kind != entry.kind:
503
self.outf.write('%-50s %s\n' % (path, entry.file_id))
505
self.outf.write(path)
506
self.outf.write('\n')
509
class cmd_mv(Command):
510
"""Move or rename a file.
513
bzr mv OLDNAME NEWNAME
515
bzr mv SOURCE... DESTINATION
517
If the last argument is a versioned directory, all the other names
518
are moved into it. Otherwise, there must be exactly two arguments
519
and the file is changed to a new name.
521
If OLDNAME does not exist on the filesystem but is versioned and
522
NEWNAME does exist on the filesystem but is not versioned, mv
523
assumes that the file has been manually moved and only updates
524
its internal inventory to reflect that change.
525
The same is valid when moving many SOURCE files to a DESTINATION.
527
Files cannot be moved between branches.
530
takes_args = ['names*']
531
takes_options = [Option("after", help="Move only the bzr identifier"
532
" of the file, because the file has already been moved."),
534
aliases = ['move', 'rename']
535
encoding_type = 'replace'
537
def run(self, names_list, after=False):
538
if names_list is None:
541
if len(names_list) < 2:
542
raise errors.BzrCommandError("missing file argument")
543
tree, rel_names = tree_files(names_list)
545
if os.path.isdir(names_list[-1]):
546
# move into existing directory
547
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
548
self.outf.write("%s => %s\n" % pair)
550
if len(names_list) != 2:
551
raise errors.BzrCommandError('to mv multiple files the'
552
' destination must be a versioned'
554
tree.rename_one(rel_names[0], rel_names[1], after=after)
555
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
558
class cmd_pull(Command):
559
"""Turn this branch into a mirror of another branch.
561
This command only works on branches that have not diverged. Branches are
562
considered diverged if the destination branch's most recent commit is one
563
that has not been merged (directly or indirectly) into the parent.
565
If branches have diverged, you can use 'bzr merge' to integrate the changes
566
from one into the other. Once one branch has merged, the other should
567
be able to pull it again.
569
If you want to forget your local changes and just update your branch to
570
match the remote one, use pull --overwrite.
572
If there is no default location set, the first pull will set it. After
573
that, you can omit the location to use the default. To change the
574
default, use --remember. The value will only be saved if the remote
575
location can be accessed.
578
_see_also = ['push', 'update', 'status-flags']
579
takes_options = ['remember', 'overwrite', 'revision',
580
custom_help('verbose',
581
help='Show logs of pulled revisions.'),
583
help='Branch to pull into, '
584
'rather than the one containing the working directory.',
589
takes_args = ['location?']
590
encoding_type = 'replace'
592
def run(self, location=None, remember=False, overwrite=False,
593
revision=None, verbose=False,
595
# FIXME: too much stuff is in the command class
598
if directory is None:
601
tree_to = WorkingTree.open_containing(directory)[0]
602
branch_to = tree_to.branch
603
except errors.NoWorkingTree:
605
branch_to = Branch.open_containing(directory)[0]
607
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
master = tree.branch.get_master_branch()
1020
if master is not None:
1023
tree.lock_tree_write()
1025
existing_pending_merges = tree.get_parent_ids()[1:]
1026
last_rev = _mod_revision.ensure_null(tree.last_revision())
1027
if last_rev == _mod_revision.ensure_null(
1028
tree.branch.last_revision()):
1029
# may be up to date, check master too.
1030
if master is None or last_rev == _mod_revision.ensure_null(
1031
master.last_revision()):
1032
revno = tree.branch.revision_id_to_revno(last_rev)
1033
note("Tree is up to date at revision %d." % (revno,))
1035
conflicts = tree.update(delta._ChangeReporter(
1036
unversioned_filter=tree.is_ignored))
1037
revno = tree.branch.revision_id_to_revno(
1038
_mod_revision.ensure_null(tree.last_revision()))
1039
note('Updated to revision %d.' % (revno,))
1040
if tree.get_parent_ids()[1:] != existing_pending_merges:
1041
note('Your local commits will now show as pending merges with '
1042
"'bzr status', and can be committed with 'bzr commit'.")
1051
class cmd_info(Command):
1052
"""Show information about a working tree, branch or repository.
1054
This command will show all known locations and formats associated to the
1055
tree, branch or repository. Statistical information is included with
1058
Branches and working trees will also report any missing revisions.
1060
_see_also = ['revno', 'working-trees', 'repositories']
1061
takes_args = ['location?']
1062
takes_options = ['verbose']
1065
def run(self, location=None, verbose=False):
1070
from bzrlib.info import show_bzrdir_info
1071
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1072
verbose=noise_level)
1075
class cmd_remove(Command):
1076
"""Remove files or directories.
1078
This makes bzr stop tracking changes to the specified files and
1079
delete them if they can easily be recovered using revert.
1081
You can specify one or more files, and/or --new. If you specify --new,
1082
only 'added' files will be removed. If you specify both, then new files
1083
in the specified directories will be removed. If the directories are
1084
also new, they will also be removed.
1086
takes_args = ['file*']
1087
takes_options = ['verbose',
1088
Option('new', help='Remove newly-added files.'),
1089
RegistryOption.from_kwargs('file-deletion-strategy',
1090
'The file deletion mode to be used.',
1091
title='Deletion Strategy', value_switches=True, enum_switch=False,
1092
safe='Only delete files if they can be'
1093
' safely recovered (default).',
1094
keep="Don't delete any files.",
1095
force='Delete all the specified files, even if they can not be '
1096
'recovered and even if they are non-empty directories.')]
1098
encoding_type = 'replace'
1100
def run(self, file_list, verbose=False, new=False,
1101
file_deletion_strategy='safe'):
1102
tree, file_list = tree_files(file_list)
1104
if file_list is not None:
1105
file_list = [f for f in file_list if f != '']
1107
raise errors.BzrCommandError('Specify one or more files to'
1108
' remove, or use --new.')
1111
added = tree.changes_from(tree.basis_tree(),
1112
specific_files=file_list).added
1113
file_list = sorted([f[0] for f in added], reverse=True)
1114
if len(file_list) == 0:
1115
raise errors.BzrCommandError('No matching files.')
1116
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1117
keep_files=file_deletion_strategy=='keep',
1118
force=file_deletion_strategy=='force')
1121
class cmd_file_id(Command):
1122
"""Print file_id of a particular file or directory.
1124
The file_id is assigned when the file is first added and remains the
1125
same through all revisions where the file exists, even when it is
1130
_see_also = ['inventory', 'ls']
1131
takes_args = ['filename']
1134
def run(self, filename):
1135
tree, relpath = WorkingTree.open_containing(filename)
1136
i = tree.path2id(relpath)
1138
raise errors.NotVersionedError(filename)
1140
self.outf.write(i + '\n')
1143
class cmd_file_path(Command):
1144
"""Print path of file_ids to a file or directory.
1146
This prints one line for each directory down to the target,
1147
starting at the branch root.
1151
takes_args = ['filename']
1154
def run(self, filename):
1155
tree, relpath = WorkingTree.open_containing(filename)
1156
fid = tree.path2id(relpath)
1158
raise errors.NotVersionedError(filename)
1159
segments = osutils.splitpath(relpath)
1160
for pos in range(1, len(segments) + 1):
1161
path = osutils.joinpath(segments[:pos])
1162
self.outf.write("%s\n" % tree.path2id(path))
1165
class cmd_reconcile(Command):
1166
"""Reconcile bzr metadata in a branch.
1168
This can correct data mismatches that may have been caused by
1169
previous ghost operations or bzr upgrades. You should only
1170
need to run this command if 'bzr check' or a bzr developer
1171
advises you to run it.
1173
If a second branch is provided, cross-branch reconciliation is
1174
also attempted, which will check that data like the tree root
1175
id which was not present in very early bzr versions is represented
1176
correctly in both branches.
1178
At the same time it is run it may recompress data resulting in
1179
a potential saving in disk space or performance gain.
1181
The branch *MUST* be on a listable system such as local disk or sftp.
1184
_see_also = ['check']
1185
takes_args = ['branch?']
1187
def run(self, branch="."):
1188
from bzrlib.reconcile import reconcile
1189
dir = bzrdir.BzrDir.open(branch)
1193
class cmd_revision_history(Command):
1194
"""Display the list of revision ids on a branch."""
1197
takes_args = ['location?']
1202
def run(self, location="."):
1203
branch = Branch.open_containing(location)[0]
1204
for revid in branch.revision_history():
1205
self.outf.write(revid)
1206
self.outf.write('\n')
1209
class cmd_ancestry(Command):
1210
"""List all revisions merged into this branch."""
1212
_see_also = ['log', 'revision-history']
1213
takes_args = ['location?']
1218
def run(self, location="."):
1220
wt = WorkingTree.open_containing(location)[0]
1221
except errors.NoWorkingTree:
1222
b = Branch.open(location)
1223
last_revision = b.last_revision()
1226
last_revision = wt.last_revision()
1228
revision_ids = b.repository.get_ancestry(last_revision)
1229
assert revision_ids[0] is None
1231
for revision_id in revision_ids:
1232
self.outf.write(revision_id + '\n')
1235
class cmd_init(Command):
1236
"""Make a directory into a versioned branch.
1238
Use this to create an empty branch, or before importing an
1241
If there is a repository in a parent directory of the location, then
1242
the history of the branch will be stored in the repository. Otherwise
1243
init creates a standalone branch which carries its own history
1244
in the .bzr directory.
1246
If there is already a branch at the location but it has no working tree,
1247
the tree can be populated with 'bzr checkout'.
1249
Recipe for importing a tree of files::
1255
bzr commit -m 'imported project'
1258
_see_also = ['init-repository', 'branch', 'checkout']
1259
takes_args = ['location?']
1261
Option('create-prefix',
1262
help='Create the path leading up to the branch '
1263
'if it does not already exist.'),
1264
RegistryOption('format',
1265
help='Specify a format for this branch. '
1266
'See "help formats".',
1267
registry=bzrdir.format_registry,
1268
converter=bzrdir.format_registry.make_bzrdir,
1269
value_switches=True,
1270
title="Branch Format",
1272
Option('append-revisions-only',
1273
help='Never change revnos or the existing log.'
1274
' Append revisions to it only.')
1276
def run(self, location=None, format=None, append_revisions_only=False,
1277
create_prefix=False):
1279
format = bzrdir.format_registry.make_bzrdir('default')
1280
if location is None:
1283
to_transport = transport.get_transport(location)
1285
# The path has to exist to initialize a
1286
# branch inside of it.
1287
# Just using os.mkdir, since I don't
1288
# believe that we want to create a bunch of
1289
# locations if the user supplies an extended path
1291
to_transport.ensure_base()
1292
except errors.NoSuchFile:
1293
if not create_prefix:
1294
raise errors.BzrCommandError("Parent directory of %s"
1296
"\nYou may supply --create-prefix to create all"
1297
" leading parent directories."
1299
_create_prefix(to_transport)
1302
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1303
except errors.NotBranchError:
1304
# really a NotBzrDir error...
1305
create_branch = bzrdir.BzrDir.create_branch_convenience
1306
branch = create_branch(to_transport.base, format=format,
1307
possible_transports=[to_transport])
1309
from bzrlib.transport.local import LocalTransport
1310
if existing_bzrdir.has_branch():
1311
if (isinstance(to_transport, LocalTransport)
1312
and not existing_bzrdir.has_workingtree()):
1313
raise errors.BranchExistsWithoutWorkingTree(location)
1314
raise errors.AlreadyBranchError(location)
1316
branch = existing_bzrdir.create_branch()
1317
existing_bzrdir.create_workingtree()
1318
if append_revisions_only:
1320
branch.set_append_revisions_only(True)
1321
except errors.UpgradeRequired:
1322
raise errors.BzrCommandError('This branch format cannot be set'
1323
' to append-revisions-only. Try --experimental-branch6')
1326
class cmd_init_repository(Command):
1327
"""Create a shared repository to hold branches.
1329
New branches created under the repository directory will store their
1330
revisions in the repository, not in the branch directory.
1332
If the --no-trees option is used then the branches in the repository
1333
will not have working trees by default.
1336
Create a shared repositories holding just branches::
1338
bzr init-repo --no-trees repo
1341
Make a lightweight checkout elsewhere::
1343
bzr checkout --lightweight repo/trunk trunk-checkout
1348
_see_also = ['init', 'branch', 'checkout', 'repositories']
1349
takes_args = ["location"]
1350
takes_options = [RegistryOption('format',
1351
help='Specify a format for this repository. See'
1352
' "bzr help formats" for details.',
1353
registry=bzrdir.format_registry,
1354
converter=bzrdir.format_registry.make_bzrdir,
1355
value_switches=True, title='Repository format'),
1357
help='Branches in the repository will default to'
1358
' not having a working tree.'),
1360
aliases = ["init-repo"]
1362
def run(self, location, format=None, no_trees=False):
1364
format = bzrdir.format_registry.make_bzrdir('default')
1366
if location is None:
1369
to_transport = transport.get_transport(location)
1370
to_transport.ensure_base()
1372
newdir = format.initialize_on_transport(to_transport)
1373
repo = newdir.create_repository(shared=True)
1374
repo.set_make_working_trees(not no_trees)
1377
class cmd_diff(Command):
1378
"""Show differences in the working tree or between revisions.
1380
If files are listed, only the changes in those files are listed.
1381
Otherwise, all changes for the tree are listed.
1383
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1384
produces patches suitable for "patch -p1".
1387
Shows the difference in the working tree versus the last commit::
1391
Difference between the working tree and revision 1::
1395
Difference between revision 2 and revision 1::
1399
Same as 'bzr diff' but prefix paths with old/ and new/::
1401
bzr diff --prefix old/:new/
1403
Show the differences between the two working trees::
1405
bzr diff bzr.mine bzr.dev
1407
Show just the differences for 'foo.c'::
1411
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1412
# or a graphical diff.
1414
# TODO: Python difflib is not exactly the same as unidiff; should
1415
# either fix it up or prefer to use an external diff.
1417
# TODO: Selected-file diff is inefficient and doesn't show you
1420
# TODO: This probably handles non-Unix newlines poorly.
1422
_see_also = ['status']
1423
takes_args = ['file*']
1425
Option('diff-options', type=str,
1426
help='Pass these options to the external diff program.'),
1427
Option('prefix', type=str,
1429
help='Set prefixes to added to old and new filenames, as '
1430
'two values separated by a colon. (eg "old/:new/").'),
1434
aliases = ['di', 'dif']
1435
encoding_type = 'exact'
1438
def run(self, revision=None, file_list=None, diff_options=None,
1440
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1442
if (prefix is None) or (prefix == '0'):
1450
old_label, new_label = prefix.split(":")
1452
raise errors.BzrCommandError(
1453
'--prefix expects two values separated by a colon'
1454
' (eg "old/:new/")')
1456
if revision and len(revision) > 2:
1457
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1458
' one or two revision specifiers')
1461
tree1, file_list = internal_tree_files(file_list)
1465
except errors.FileInWrongBranch:
1466
if len(file_list) != 2:
1467
raise errors.BzrCommandError("Files are in different branches")
1469
tree1, file1 = WorkingTree.open_containing(file_list[0])
1470
tree2, file2 = WorkingTree.open_containing(file_list[1])
1471
if file1 != "" or file2 != "":
1472
# FIXME diff those two files. rbc 20051123
1473
raise errors.BzrCommandError("Files are in different branches")
1475
except errors.NotBranchError:
1476
if (revision is not None and len(revision) == 2
1477
and not revision[0].needs_branch()
1478
and not revision[1].needs_branch()):
1479
# If both revision specs include a branch, we can
1480
# diff them without needing a local working tree
1481
tree1, tree2 = None, None
1485
if tree2 is not None:
1486
if revision is not None:
1487
# FIXME: but there should be a clean way to diff between
1488
# non-default versions of two trees, it's not hard to do
1490
raise errors.BzrCommandError(
1491
"Sorry, diffing arbitrary revisions across branches "
1492
"is not implemented yet")
1493
return show_diff_trees(tree1, tree2, sys.stdout,
1494
specific_files=file_list,
1495
external_diff_options=diff_options,
1496
old_label=old_label, new_label=new_label)
1498
return diff_cmd_helper(tree1, file_list, diff_options,
1499
revision_specs=revision,
1500
old_label=old_label, new_label=new_label)
1503
class cmd_deleted(Command):
1504
"""List files deleted in the working tree.
1506
# TODO: Show files deleted since a previous revision, or
1507
# between two revisions.
1508
# TODO: Much more efficient way to do this: read in new
1509
# directories with readdir, rather than stating each one. Same
1510
# level of effort but possibly much less IO. (Or possibly not,
1511
# if the directories are very large...)
1512
_see_also = ['status', 'ls']
1513
takes_options = ['show-ids']
1516
def run(self, show_ids=False):
1517
tree = WorkingTree.open_containing(u'.')[0]
1520
old = tree.basis_tree()
1523
for path, ie in old.inventory.iter_entries():
1524
if not tree.has_id(ie.file_id):
1525
self.outf.write(path)
1527
self.outf.write(' ')
1528
self.outf.write(ie.file_id)
1529
self.outf.write('\n')
1536
class cmd_modified(Command):
1537
"""List files modified in working tree.
1541
_see_also = ['status', 'ls']
1545
tree = WorkingTree.open_containing(u'.')[0]
1546
td = tree.changes_from(tree.basis_tree())
1547
for path, id, kind, text_modified, meta_modified in td.modified:
1548
self.outf.write(path + '\n')
1551
class cmd_added(Command):
1552
"""List files added in working tree.
1556
_see_also = ['status', 'ls']
1560
wt = WorkingTree.open_containing(u'.')[0]
1563
basis = wt.basis_tree()
1566
basis_inv = basis.inventory
1569
if file_id in basis_inv:
1571
if inv.is_root(file_id) and len(basis_inv) == 0:
1573
path = inv.id2path(file_id)
1574
if not os.access(osutils.abspath(path), os.F_OK):
1576
self.outf.write(path + '\n')
1583
class cmd_root(Command):
1584
"""Show the tree root directory.
1586
The root is the nearest enclosing directory with a .bzr control
1589
takes_args = ['filename?']
1591
def run(self, filename=None):
1592
"""Print the branch root."""
1593
tree = WorkingTree.open_containing(filename)[0]
1594
self.outf.write(tree.basedir + '\n')
1597
def _parse_limit(limitstring):
1599
return int(limitstring)
1601
msg = "The limit argument must be an integer."
1602
raise errors.BzrCommandError(msg)
1605
class cmd_log(Command):
1606
"""Show log of a branch, file, or directory.
1608
By default show the log of the branch containing the working directory.
1610
To request a range of logs, you can use the command -r begin..end
1611
-r revision requests a specific revision, -r ..end or -r begin.. are
1615
Log the current branch::
1623
Log the last 10 revisions of a branch::
1625
bzr log -r -10.. http://server/branch
1628
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1630
takes_args = ['location?']
1633
help='Show from oldest to newest.'),
1636
help='Display timezone as local, original, or utc.'),
1637
custom_help('verbose',
1638
help='Show files changed in each revision.'),
1644
help='Show revisions whose message matches this '
1645
'regular expression.',
1648
help='Limit the output to the first N revisions.',
1652
encoding_type = 'replace'
1655
def run(self, location=None, timezone='original',
1663
from bzrlib.log import show_log
1664
assert message is None or isinstance(message, basestring), \
1665
"invalid message argument %r" % message
1666
direction = (forward and 'forward') or 'reverse'
1671
# find the file id to log:
1673
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1677
tree = b.basis_tree()
1678
file_id = tree.path2id(fp)
1680
raise errors.BzrCommandError(
1681
"Path does not have any revision history: %s" %
1685
# FIXME ? log the current subdir only RBC 20060203
1686
if revision is not None \
1687
and len(revision) > 0 and revision[0].get_branch():
1688
location = revision[0].get_branch()
1691
dir, relpath = bzrdir.BzrDir.open_containing(location)
1692
b = dir.open_branch()
1696
if revision is None:
1699
elif len(revision) == 1:
1700
rev1 = rev2 = revision[0].in_history(b)
1701
elif len(revision) == 2:
1702
if revision[1].get_branch() != revision[0].get_branch():
1703
# b is taken from revision[0].get_branch(), and
1704
# show_log will use its revision_history. Having
1705
# different branches will lead to weird behaviors.
1706
raise errors.BzrCommandError(
1707
"Log doesn't accept two revisions in different"
1709
rev1 = revision[0].in_history(b)
1710
rev2 = revision[1].in_history(b)
1712
raise errors.BzrCommandError(
1713
'bzr log --revision takes one or two values.')
1715
if log_format is None:
1716
log_format = log.log_formatter_registry.get_default(b)
1718
lf = log_format(show_ids=show_ids, to_file=self.outf,
1719
show_timezone=timezone)
1725
direction=direction,
1726
start_revision=rev1,
1734
def get_log_format(long=False, short=False, line=False, default='long'):
1735
log_format = default
1739
log_format = 'short'
1745
class cmd_touching_revisions(Command):
1746
"""Return revision-ids which affected a particular file.
1748
A more user-friendly interface is "bzr log FILE".
1752
takes_args = ["filename"]
1755
def run(self, filename):
1756
tree, relpath = WorkingTree.open_containing(filename)
1758
file_id = tree.path2id(relpath)
1759
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1760
self.outf.write("%6d %s\n" % (revno, what))
1763
class cmd_ls(Command):
1764
"""List files in a tree.
1767
_see_also = ['status', 'cat']
1768
takes_args = ['path?']
1769
# TODO: Take a revision or remote path and list that tree instead.
1773
Option('non-recursive',
1774
help='Don\'t recurse into subdirectories.'),
1776
help='Print paths relative to the root of the branch.'),
1777
Option('unknown', help='Print unknown files.'),
1778
Option('versioned', help='Print versioned files.'),
1779
Option('ignored', help='Print ignored files.'),
1781
help='Write an ascii NUL (\\0) separator '
1782
'between files rather than a newline.'),
1784
help='List entries of a particular kind: file, directory, symlink.',
1789
def run(self, revision=None, verbose=False,
1790
non_recursive=False, from_root=False,
1791
unknown=False, versioned=False, ignored=False,
1792
null=False, kind=None, show_ids=False, path=None):
1794
if kind and kind not in ('file', 'directory', 'symlink'):
1795
raise errors.BzrCommandError('invalid kind specified')
1797
if verbose and null:
1798
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1799
all = not (unknown or versioned or ignored)
1801
selection = {'I':ignored, '?':unknown, 'V':versioned}
1808
raise errors.BzrCommandError('cannot specify both --from-root'
1812
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1818
if revision is not None:
1819
tree = branch.repository.revision_tree(
1820
revision[0].in_history(branch).rev_id)
1822
tree = branch.basis_tree()
1826
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1827
if fp.startswith(relpath):
1828
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1829
if non_recursive and '/' in fp:
1831
if not all and not selection[fc]:
1833
if kind is not None and fkind != kind:
1836
kindch = entry.kind_character()
1837
outstring = '%-8s %s%s' % (fc, fp, kindch)
1838
if show_ids and fid is not None:
1839
outstring = "%-50s %s" % (outstring, fid)
1840
self.outf.write(outstring + '\n')
1842
self.outf.write(fp + '\0')
1845
self.outf.write(fid)
1846
self.outf.write('\0')
1854
self.outf.write('%-50s %s\n' % (fp, my_id))
1856
self.outf.write(fp + '\n')
1861
class cmd_unknowns(Command):
1862
"""List unknown files.
1870
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1871
self.outf.write(osutils.quotefn(f) + '\n')
1874
class cmd_ignore(Command):
1875
"""Ignore specified files or patterns.
1877
To remove patterns from the ignore list, edit the .bzrignore file.
1879
Trailing slashes on patterns are ignored.
1880
If the pattern contains a slash or is a regular expression, it is compared
1881
to the whole path from the branch root. Otherwise, it is compared to only
1882
the last component of the path. To match a file only in the root
1883
directory, prepend './'.
1885
Ignore patterns specifying absolute paths are not allowed.
1887
Ignore patterns may include globbing wildcards such as::
1889
? - Matches any single character except '/'
1890
* - Matches 0 or more characters except '/'
1891
/**/ - Matches 0 or more directories in a path
1892
[a-z] - Matches a single character from within a group of characters
1894
Ignore patterns may also be Python regular expressions.
1895
Regular expression ignore patterns are identified by a 'RE:' prefix
1896
followed by the regular expression. Regular expression ignore patterns
1897
may not include named or numbered groups.
1899
Note: ignore patterns containing shell wildcards must be quoted from
1903
Ignore the top level Makefile::
1905
bzr ignore ./Makefile
1907
Ignore class files in all directories::
1909
bzr ignore '*.class'
1911
Ignore .o files under the lib directory::
1913
bzr ignore 'lib/**/*.o'
1915
Ignore .o files under the lib directory::
1917
bzr ignore 'RE:lib/.*\.o'
1920
_see_also = ['status', 'ignored']
1921
takes_args = ['name_pattern*']
1923
Option('old-default-rules',
1924
help='Write out the ignore rules bzr < 0.9 always used.')
1927
def run(self, name_pattern_list=None, old_default_rules=None):
1928
from bzrlib.atomicfile import AtomicFile
1929
if old_default_rules is not None:
1930
# dump the rules and exit
1931
for pattern in ignores.OLD_DEFAULTS:
1934
if not name_pattern_list:
1935
raise errors.BzrCommandError("ignore requires at least one "
1936
"NAME_PATTERN or --old-default-rules")
1937
name_pattern_list = [globbing.normalize_pattern(p)
1938
for p in name_pattern_list]
1939
for name_pattern in name_pattern_list:
1940
if (name_pattern[0] == '/' or
1941
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1942
raise errors.BzrCommandError(
1943
"NAME_PATTERN should not be an absolute path")
1944
tree, relpath = WorkingTree.open_containing(u'.')
1945
ifn = tree.abspath('.bzrignore')
1946
if os.path.exists(ifn):
1949
igns = f.read().decode('utf-8')
1955
# TODO: If the file already uses crlf-style termination, maybe
1956
# we should use that for the newly added lines?
1958
if igns and igns[-1] != '\n':
1960
for name_pattern in name_pattern_list:
1961
igns += name_pattern + '\n'
1963
f = AtomicFile(ifn, 'wb')
1965
f.write(igns.encode('utf-8'))
1970
if not tree.path2id('.bzrignore'):
1971
tree.add(['.bzrignore'])
1973
ignored = globbing.Globster(name_pattern_list)
1976
for entry in tree.list_files():
1980
if ignored.match(filename):
1981
matches.append(filename.encode('utf-8'))
1983
if len(matches) > 0:
1984
print "Warning: the following files are version controlled and" \
1985
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1987
class cmd_ignored(Command):
1988
"""List ignored files and the patterns that matched them.
1991
_see_also = ['ignore']
1994
tree = WorkingTree.open_containing(u'.')[0]
1997
for path, file_class, kind, file_id, entry in tree.list_files():
1998
if file_class != 'I':
2000
## XXX: Slightly inefficient since this was already calculated
2001
pat = tree.is_ignored(path)
2002
print '%-50s %s' % (path, pat)
2007
class cmd_lookup_revision(Command):
2008
"""Lookup the revision-id from a revision-number
2011
bzr lookup-revision 33
2014
takes_args = ['revno']
2017
def run(self, revno):
2021
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2023
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2026
class cmd_export(Command):
2027
"""Export current or past revision to a destination directory or archive.
2029
If no revision is specified this exports the last committed revision.
2031
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2032
given, try to find the format with the extension. If no extension
2033
is found exports to a directory (equivalent to --format=dir).
2035
If root is supplied, it will be used as the root directory inside
2036
container formats (tar, zip, etc). If it is not supplied it will default
2037
to the exported filename. The root option has no effect for 'dir' format.
2039
If branch is omitted then the branch containing the current working
2040
directory will be used.
2042
Note: Export of tree with non-ASCII filenames to zip is not supported.
2044
================= =========================
2045
Supported formats Autodetected by extension
2046
================= =========================
2049
tbz2 .tar.bz2, .tbz2
2052
================= =========================
2054
takes_args = ['dest', 'branch?']
2057
help="Type of file to export to.",
2062
help="Name of the root directory inside the exported file."),
2064
def run(self, dest, branch=None, revision=None, format=None, root=None):
2065
from bzrlib.export import export
2068
tree = WorkingTree.open_containing(u'.')[0]
2071
b = Branch.open(branch)
2073
if revision is None:
2074
# should be tree.last_revision FIXME
2075
rev_id = b.last_revision()
2077
if len(revision) != 1:
2078
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2079
rev_id = revision[0].in_history(b).rev_id
2080
t = b.repository.revision_tree(rev_id)
2082
export(t, dest, format, root)
2083
except errors.NoSuchExportFormat, e:
2084
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2087
class cmd_cat(Command):
2088
"""Write the contents of a file as of a given revision to standard output.
2090
If no revision is nominated, the last revision is used.
2092
Note: Take care to redirect standard output when using this command on a
2098
Option('name-from-revision', help='The path name in the old tree.'),
2101
takes_args = ['filename']
2102
encoding_type = 'exact'
2105
def run(self, filename, revision=None, name_from_revision=False):
2106
if revision is not None and len(revision) != 1:
2107
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2112
tree, b, relpath = \
2113
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2114
except errors.NotBranchError:
2117
if revision is not None and revision[0].get_branch() is not None:
2118
b = Branch.open(revision[0].get_branch())
2120
tree = b.basis_tree()
2121
if revision is None:
2122
revision_id = b.last_revision()
2124
revision_id = revision[0].in_history(b).rev_id
2126
cur_file_id = tree.path2id(relpath)
2127
rev_tree = b.repository.revision_tree(revision_id)
2128
old_file_id = rev_tree.path2id(relpath)
2130
if name_from_revision:
2131
if old_file_id is None:
2132
raise errors.BzrCommandError("%r is not present in revision %s"
2133
% (filename, revision_id))
2135
rev_tree.print_file(old_file_id)
2136
elif cur_file_id is not None:
2137
rev_tree.print_file(cur_file_id)
2138
elif old_file_id is not None:
2139
rev_tree.print_file(old_file_id)
2141
raise errors.BzrCommandError("%r is not present in revision %s" %
2142
(filename, revision_id))
2145
class cmd_local_time_offset(Command):
2146
"""Show the offset in seconds from GMT to local time."""
2150
print osutils.local_time_offset()
2154
class cmd_commit(Command):
2155
"""Commit changes into a new revision.
2157
If no arguments are given, the entire tree is committed.
2159
If selected files are specified, only changes to those files are
2160
committed. If a directory is specified then the directory and everything
2161
within it is committed.
2163
If author of the change is not the same person as the committer, you can
2164
specify the author's name using the --author option. The name should be
2165
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2167
A selected-file commit may fail in some cases where the committed
2168
tree would be invalid. Consider::
2173
bzr commit foo -m "committing foo"
2174
bzr mv foo/bar foo/baz
2177
bzr commit foo/bar -m "committing bar but not baz"
2179
In the example above, the last commit will fail by design. This gives
2180
the user the opportunity to decide whether they want to commit the
2181
rename at the same time, separately first, or not at all. (As a general
2182
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2184
Note: A selected-file commit after a merge is not yet supported.
2186
# TODO: Run hooks on tree to-be-committed, and after commit.
2188
# TODO: Strict commit that fails if there are deleted files.
2189
# (what does "deleted files" mean ??)
2191
# TODO: Give better message for -s, --summary, used by tla people
2193
# XXX: verbose currently does nothing
2195
_see_also = ['bugs', 'uncommit']
2196
takes_args = ['selected*']
2198
Option('message', type=unicode,
2200
help="Description of the new revision."),
2203
help='Commit even if nothing has changed.'),
2204
Option('file', type=str,
2207
help='Take commit message from this file.'),
2209
help="Refuse to commit if there are unknown "
2210
"files in the working tree."),
2211
ListOption('fixes', type=str,
2212
help="Mark a bug as being fixed by this revision."),
2213
Option('author', type=str,
2214
help="Set the author's name, if it's different "
2215
"from the committer."),
2217
help="Perform a local commit in a bound "
2218
"branch. Local commits are not pushed to "
2219
"the master branch until a normal commit "
2223
help='When no message is supplied, show the diff along'
2224
' with the status summary in the message editor.'),
2226
aliases = ['ci', 'checkin']
2228
def _get_bug_fix_properties(self, fixes, branch):
2230
# Configure the properties for bug fixing attributes.
2231
for fixed_bug in fixes:
2232
tokens = fixed_bug.split(':')
2233
if len(tokens) != 2:
2234
raise errors.BzrCommandError(
2235
"Invalid bug %s. Must be in the form of 'tag:id'. "
2236
"Commit refused." % fixed_bug)
2237
tag, bug_id = tokens
2239
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2240
except errors.UnknownBugTrackerAbbreviation:
2241
raise errors.BzrCommandError(
2242
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2243
except errors.MalformedBugIdentifier:
2244
raise errors.BzrCommandError(
2245
"Invalid bug identifier for %s. Commit refused."
2247
properties.append('%s fixed' % bug_url)
2248
return '\n'.join(properties)
2250
def run(self, message=None, file=None, verbose=False, selected_list=None,
2251
unchanged=False, strict=False, local=False, fixes=None,
2252
author=None, show_diff=False):
2253
from bzrlib.commit import (
2257
from bzrlib.errors import (
2262
from bzrlib.msgeditor import (
2263
edit_commit_message_encoded,
2264
make_commit_message_template_encoded
2267
# TODO: Need a blackbox test for invoking the external editor; may be
2268
# slightly problematic to run this cross-platform.
2270
# TODO: do more checks that the commit will succeed before
2271
# spending the user's valuable time typing a commit message.
2275
tree, selected_list = tree_files(selected_list)
2276
if selected_list == ['']:
2277
# workaround - commit of root of tree should be exactly the same
2278
# as just default commit in that tree, and succeed even though
2279
# selected-file merge commit is not done yet
2282
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2284
properties['bugs'] = bug_property
2286
if local and not tree.branch.get_bound_location():
2287
raise errors.LocalRequiresBoundBranch()
2289
def get_message(commit_obj):
2290
"""Callback to get commit message"""
2291
my_message = message
2292
if my_message is None and not file:
2293
t = make_commit_message_template_encoded(tree,
2294
selected_list, diff=show_diff,
2295
output_encoding=bzrlib.user_encoding)
2296
my_message = edit_commit_message_encoded(t)
2297
if my_message is None:
2298
raise errors.BzrCommandError("please specify a commit"
2299
" message with either --message or --file")
2300
elif my_message and file:
2301
raise errors.BzrCommandError(
2302
"please specify either --message or --file")
2304
my_message = codecs.open(file, 'rt',
2305
bzrlib.user_encoding).read()
2306
if my_message == "":
2307
raise errors.BzrCommandError("empty commit message specified")
2310
if verbose or not is_quiet():
2311
reporter = ReportCommitToLog()
2313
reporter = NullCommitReporter()
2316
tree.commit(message_callback=get_message,
2317
specific_files=selected_list,
2318
allow_pointless=unchanged, strict=strict, local=local,
2319
reporter=reporter, revprops=properties,
2321
except PointlessCommit:
2322
# FIXME: This should really happen before the file is read in;
2323
# perhaps prepare the commit; get the message; then actually commit
2324
raise errors.BzrCommandError("no changes to commit."
2325
" use --unchanged to commit anyhow")
2326
except ConflictsInTree:
2327
raise errors.BzrCommandError('Conflicts detected in working '
2328
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2330
except StrictCommitFailed:
2331
raise errors.BzrCommandError("Commit refused because there are"
2332
" unknown files in the working tree.")
2333
except errors.BoundBranchOutOfDate, e:
2334
raise errors.BzrCommandError(str(e) + "\n"
2335
'To commit to master branch, run update and then commit.\n'
2336
'You can also pass --local to commit to continue working '
2340
class cmd_check(Command):
2341
"""Validate consistency of branch history.
2343
This command checks various invariants about the branch storage to
2344
detect data corruption or bzr bugs.
2347
_see_also = ['reconcile']
2348
takes_args = ['branch?']
2349
takes_options = ['verbose']
2351
def run(self, branch=None, verbose=False):
2352
from bzrlib.check import check
2354
tree = WorkingTree.open_containing()[0]
2355
branch = tree.branch
2357
branch = Branch.open(branch)
2358
check(branch, verbose)
2361
class cmd_upgrade(Command):
2362
"""Upgrade branch storage to current format.
2364
The check command or bzr developers may sometimes advise you to run
2365
this command. When the default format has changed you may also be warned
2366
during other operations to upgrade.
2369
_see_also = ['check']
2370
takes_args = ['url?']
2372
RegistryOption('format',
2373
help='Upgrade to a specific format. See "bzr help'
2374
' formats" for details.',
2375
registry=bzrdir.format_registry,
2376
converter=bzrdir.format_registry.make_bzrdir,
2377
value_switches=True, title='Branch format'),
2380
def run(self, url='.', format=None):
2381
from bzrlib.upgrade import upgrade
2383
format = bzrdir.format_registry.make_bzrdir('default')
2384
upgrade(url, format)
2387
class cmd_whoami(Command):
2388
"""Show or set bzr user id.
2391
Show the email of the current user::
2395
Set the current user::
2397
bzr whoami 'Frank Chu <fchu@example.com>'
2399
takes_options = [ Option('email',
2400
help='Display email address only.'),
2402
help='Set identity for the current branch instead of '
2405
takes_args = ['name?']
2406
encoding_type = 'replace'
2409
def run(self, email=False, branch=False, name=None):
2411
# use branch if we're inside one; otherwise global config
2413
c = Branch.open_containing('.')[0].get_config()
2414
except errors.NotBranchError:
2415
c = config.GlobalConfig()
2417
self.outf.write(c.user_email() + '\n')
2419
self.outf.write(c.username() + '\n')
2422
# display a warning if an email address isn't included in the given name.
2424
config.extract_email_address(name)
2425
except errors.NoEmailInUsername, e:
2426
warning('"%s" does not seem to contain an email address. '
2427
'This is allowed, but not recommended.', name)
2429
# use global config unless --branch given
2431
c = Branch.open_containing('.')[0].get_config()
2433
c = config.GlobalConfig()
2434
c.set_user_option('email', name)
2437
class cmd_nick(Command):
2438
"""Print or set the branch nickname.
2440
If unset, the tree root directory name is used as the nickname
2441
To print the current nickname, execute with no argument.
2444
_see_also = ['info']
2445
takes_args = ['nickname?']
2446
def run(self, nickname=None):
2447
branch = Branch.open_containing(u'.')[0]
2448
if nickname is None:
2449
self.printme(branch)
2451
branch.nick = nickname
2454
def printme(self, branch):
2458
class cmd_selftest(Command):
2459
"""Run internal test suite.
2461
If arguments are given, they are regular expressions that say which tests
2462
should run. Tests matching any expression are run, and other tests are
2465
Alternatively if --first is given, matching tests are run first and then
2466
all other tests are run. This is useful if you have been working in a
2467
particular area, but want to make sure nothing else was broken.
2469
If --exclude is given, tests that match that regular expression are
2470
excluded, regardless of whether they match --first or not.
2472
To help catch accidential dependencies between tests, the --randomize
2473
option is useful. In most cases, the argument used is the word 'now'.
2474
Note that the seed used for the random number generator is displayed
2475
when this option is used. The seed can be explicitly passed as the
2476
argument to this option if required. This enables reproduction of the
2477
actual ordering used if and when an order sensitive problem is encountered.
2479
If --list-only is given, the tests that would be run are listed. This is
2480
useful when combined with --first, --exclude and/or --randomize to
2481
understand their impact. The test harness reports "Listed nn tests in ..."
2482
instead of "Ran nn tests in ..." when list mode is enabled.
2484
If the global option '--no-plugins' is given, plugins are not loaded
2485
before running the selftests. This has two effects: features provided or
2486
modified by plugins will not be tested, and tests provided by plugins will
2489
Tests that need working space on disk use a common temporary directory,
2490
typically inside $TMPDIR or /tmp.
2493
Run only tests relating to 'ignore'::
2497
Disable plugins and list tests as they're run::
2499
bzr --no-plugins selftest -v
2501
# NB: this is used from the class without creating an instance, which is
2502
# why it does not have a self parameter.
2503
def get_transport_type(typestring):
2504
"""Parse and return a transport specifier."""
2505
if typestring == "sftp":
2506
from bzrlib.transport.sftp import SFTPAbsoluteServer
2507
return SFTPAbsoluteServer
2508
if typestring == "memory":
2509
from bzrlib.transport.memory import MemoryServer
2511
if typestring == "fakenfs":
2512
from bzrlib.transport.fakenfs import FakeNFSServer
2513
return FakeNFSServer
2514
msg = "No known transport type %s. Supported types are: sftp\n" %\
2516
raise errors.BzrCommandError(msg)
2519
takes_args = ['testspecs*']
2520
takes_options = ['verbose',
2522
help='Stop when one test fails.',
2526
help='Use a different transport by default '
2527
'throughout the test suite.',
2528
type=get_transport_type),
2530
help='Run the benchmarks rather than selftests.'),
2531
Option('lsprof-timed',
2532
help='Generate lsprof output for benchmarked'
2533
' sections of code.'),
2534
Option('cache-dir', type=str,
2535
help='Cache intermediate benchmark output in this '
2538
help='Run all tests, but run specified tests first.',
2542
help='List the tests instead of running them.'),
2543
Option('randomize', type=str, argname="SEED",
2544
help='Randomize the order of tests using the given'
2545
' seed or "now" for the current time.'),
2546
Option('exclude', type=str, argname="PATTERN",
2548
help='Exclude tests that match this regular'
2550
Option('strict', help='Fail on missing dependencies or '
2553
encoding_type = 'replace'
2555
def run(self, testspecs_list=None, verbose=None, one=False,
2556
transport=None, benchmark=None,
2557
lsprof_timed=None, cache_dir=None,
2558
first=False, list_only=False,
2559
randomize=None, exclude=None, strict=False):
2561
from bzrlib.tests import selftest
2562
import bzrlib.benchmarks as benchmarks
2563
from bzrlib.benchmarks import tree_creator
2564
from bzrlib.version import show_version
2566
if cache_dir is not None:
2567
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2569
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2570
print ' %s (%s python%s)' % (
2572
bzrlib.version_string,
2573
'.'.join(map(str, sys.version_info)),
2576
if testspecs_list is not None:
2577
pattern = '|'.join(testspecs_list)
2581
test_suite_factory = benchmarks.test_suite
2584
# TODO: should possibly lock the history file...
2585
benchfile = open(".perf_history", "at", buffering=1)
2587
test_suite_factory = None
2592
result = selftest(verbose=verbose,
2594
stop_on_failure=one,
2595
transport=transport,
2596
test_suite_factory=test_suite_factory,
2597
lsprof_timed=lsprof_timed,
2598
bench_history=benchfile,
2599
matching_tests_first=first,
2600
list_only=list_only,
2601
random_seed=randomize,
2602
exclude_pattern=exclude,
2606
if benchfile is not None:
2609
info('tests passed')
2611
info('tests failed')
2612
return int(not result)
2615
class cmd_version(Command):
2616
"""Show version of bzr."""
2620
from bzrlib.version import show_version
2624
class cmd_rocks(Command):
2625
"""Statement of optimism."""
2631
print "It sure does!"
2634
class cmd_find_merge_base(Command):
2635
"""Find and print a base revision for merging two branches."""
2636
# TODO: Options to specify revisions on either side, as if
2637
# merging only part of the history.
2638
takes_args = ['branch', 'other']
2642
def run(self, branch, other):
2643
from bzrlib.revision import ensure_null, MultipleRevisionSources
2645
branch1 = Branch.open_containing(branch)[0]
2646
branch2 = Branch.open_containing(other)[0]
2648
last1 = ensure_null(branch1.last_revision())
2649
last2 = ensure_null(branch2.last_revision())
2651
graph = branch1.repository.get_graph(branch2.repository)
2652
base_rev_id = graph.find_unique_lca(last1, last2)
2654
print 'merge base is revision %s' % base_rev_id
2657
class cmd_merge(Command):
2658
"""Perform a three-way merge.
2660
The branch is the branch you will merge from. By default, it will merge
2661
the latest revision. If you specify a revision, that revision will be
2662
merged. If you specify two revisions, the first will be used as a BASE,
2663
and the second one as OTHER. Revision numbers are always relative to the
2666
By default, bzr will try to merge in all new work from the other
2667
branch, automatically determining an appropriate base. If this
2668
fails, you may need to give an explicit base.
2670
Merge will do its best to combine the changes in two branches, but there
2671
are some kinds of problems only a human can fix. When it encounters those,
2672
it will mark a conflict. A conflict means that you need to fix something,
2673
before you should commit.
2675
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2677
If there is no default branch set, the first merge will set it. After
2678
that, you can omit the branch to use the default. To change the
2679
default, use --remember. The value will only be saved if the remote
2680
location can be accessed.
2682
The results of the merge are placed into the destination working
2683
directory, where they can be reviewed (with bzr diff), tested, and then
2684
committed to record the result of the merge.
2686
merge refuses to run if there are any uncommitted changes, unless
2690
To merge the latest revision from bzr.dev::
2692
bzr merge ../bzr.dev
2694
To merge changes up to and including revision 82 from bzr.dev::
2696
bzr merge -r 82 ../bzr.dev
2698
To merge the changes introduced by 82, without previous changes::
2700
bzr merge -r 81..82 ../bzr.dev
2703
_see_also = ['update', 'remerge', 'status-flags']
2704
takes_args = ['branch?']
2708
help='Merge even if the destination tree has uncommitted changes.'),
2712
Option('show-base', help="Show base revision text in "
2714
Option('uncommitted', help='Apply uncommitted changes'
2715
' from a working copy, instead of branch changes.'),
2716
Option('pull', help='If the destination is already'
2717
' completely merged into the source, pull from the'
2718
' source rather than merging. When this happens,'
2719
' you do not need to commit the result.'),
2721
help='Branch to merge into, '
2722
'rather than the one containing the working directory.',
2728
def run(self, branch=None, revision=None, force=False, merge_type=None,
2729
show_base=False, reprocess=False, remember=False,
2730
uncommitted=False, pull=False,
2733
from bzrlib.tag import _merge_tags_if_possible
2734
# This is actually a branch (or merge-directive) *location*.
2738
if merge_type is None:
2739
merge_type = _mod_merge.Merge3Merger
2741
if directory is None: directory = u'.'
2742
possible_transports = []
2744
allow_pending = True
2745
verified = 'inapplicable'
2746
tree = WorkingTree.open_containing(directory)[0]
2747
change_reporter = delta._ChangeReporter(
2748
unversioned_filter=tree.is_ignored)
2751
pb = ui.ui_factory.nested_progress_bar()
2752
cleanups.append(pb.finished)
2754
cleanups.append(tree.unlock)
2755
if location is not None:
2756
mergeable, other_transport = _get_mergeable_helper(location)
2759
raise errors.BzrCommandError('Cannot use --uncommitted'
2760
' with bundles or merge directives.')
2762
if revision is not None:
2763
raise errors.BzrCommandError(
2764
'Cannot use -r with merge directives or bundles')
2765
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2767
possible_transports.append(other_transport)
2769
if merger is None and uncommitted:
2770
if revision is not None and len(revision) > 0:
2771
raise errors.BzrCommandError('Cannot use --uncommitted and'
2772
' --revision at the same time.')
2773
location = self._select_branch_location(tree, location)[0]
2774
other_tree, other_path = WorkingTree.open_containing(location)
2775
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2777
allow_pending = False
2780
merger, allow_pending = self._get_merger_from_branch(tree,
2781
location, revision, remember, possible_transports, pb)
2783
merger.merge_type = merge_type
2784
merger.reprocess = reprocess
2785
merger.show_base = show_base
2786
merger.change_reporter = change_reporter
2787
self.sanity_check_merger(merger)
2788
if (merger.base_rev_id == merger.other_rev_id and
2789
merger.other_rev_id != None):
2790
note('Nothing to do.')
2793
if merger.interesting_files is not None:
2794
raise BzrCommandError('Cannot pull individual files')
2795
if (merger.base_rev_id == tree.last_revision()):
2796
result = tree.pull(merger.other_branch, False,
2797
merger.other_rev_id)
2798
result.report(self.outf)
2800
merger.check_basis(not force)
2801
conflict_count = merger.do_merge()
2803
merger.set_pending()
2804
if verified == 'failed':
2805
warning('Preview patch does not match changes')
2806
if conflict_count != 0:
2811
for cleanup in reversed(cleanups):
2814
def sanity_check_merger(self, merger):
2815
if (merger.show_base and
2816
not merger.merge_type is _mod_merge.Merge3Merger):
2817
raise errors.BzrCommandError("Show-base is not supported for this"
2818
" merge type. %s" % merger.merge_type)
2819
if merger.reprocess and not merger.merge_type.supports_reprocess:
2820
raise errors.BzrCommandError("Conflict reduction is not supported"
2821
" for merge type %s." %
2823
if merger.reprocess and merger.show_base:
2824
raise errors.BzrCommandError("Cannot do conflict reduction and"
2827
def _get_merger_from_branch(self, tree, location, revision, remember,
2828
possible_transports, pb):
2829
"""Produce a merger from a location, assuming it refers to a branch."""
2830
from bzrlib.tag import _merge_tags_if_possible
2831
assert revision is None or len(revision) < 3
2832
# find the branch locations
2833
other_loc, location = self._select_branch_location(tree, location,
2835
if revision is not None and len(revision) == 2:
2836
base_loc, location = self._select_branch_location(tree, location,
2839
base_loc = other_loc
2841
other_branch, other_path = Branch.open_containing(other_loc,
2842
possible_transports)
2843
if base_loc == other_loc:
2844
base_branch = other_branch
2846
base_branch, base_path = Branch.open_containing(base_loc,
2847
possible_transports)
2848
# Find the revision ids
2849
if revision is None or len(revision) < 1 or revision[-1] is None:
2850
other_revision_id = _mod_revision.ensure_null(
2851
other_branch.last_revision())
2853
other_revision_id = \
2854
_mod_revision.ensure_null(
2855
revision[-1].in_history(other_branch).rev_id)
2856
if (revision is not None and len(revision) == 2
2857
and revision[0] is not None):
2858
base_revision_id = \
2859
_mod_revision.ensure_null(
2860
revision[0].in_history(base_branch).rev_id)
2862
base_revision_id = None
2863
# Remember where we merge from
2864
if ((tree.branch.get_parent() is None or remember) and
2865
other_branch is not None):
2866
tree.branch.set_parent(other_branch.base)
2867
_merge_tags_if_possible(other_branch, tree.branch)
2868
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2869
other_revision_id, base_revision_id, other_branch, base_branch)
2870
if other_path != '':
2871
allow_pending = False
2872
merger.interesting_files = [other_path]
2874
allow_pending = True
2875
return merger, allow_pending
2877
def _select_branch_location(self, tree, location, revision=None,
2879
"""Select a branch location, according to possible inputs.
2881
If provided, branches from ``revision`` are preferred. (Both
2882
``revision`` and ``index`` must be supplied.)
2884
Otherwise, the ``location`` parameter is used. If it is None, then the
2885
``parent`` location is used, and a note is printed.
2887
:param tree: The working tree to select a branch for merging into
2888
:param location: The location entered by the user
2889
:param revision: The revision parameter to the command
2890
:param index: The index to use for the revision parameter. Negative
2891
indices are permitted.
2892
:return: (selected_location, default_location). The default location
2893
will be the user-entered location, if any, or else the remembered
2896
if (revision is not None and index is not None
2897
and revision[index] is not None):
2898
branch = revision[index].get_branch()
2899
if branch is not None:
2900
return branch, location
2901
location = self._get_remembered_parent(tree, location, 'Merging from')
2902
return location, location
2904
# TODO: move up to common parent; this isn't merge-specific anymore.
2905
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2906
"""Use tree.branch's parent if none was supplied.
2908
Report if the remembered location was used.
2910
if supplied_location is not None:
2911
return supplied_location
2912
stored_location = tree.branch.get_parent()
2913
mutter("%s", stored_location)
2914
if stored_location is None:
2915
raise errors.BzrCommandError("No location specified or remembered")
2916
display_url = urlutils.unescape_for_display(stored_location,
2918
self.outf.write("%s remembered location %s\n" % (verb_string,
2920
return stored_location
2923
class cmd_remerge(Command):
2926
Use this if you want to try a different merge technique while resolving
2927
conflicts. Some merge techniques are better than others, and remerge
2928
lets you try different ones on different files.
2930
The options for remerge have the same meaning and defaults as the ones for
2931
merge. The difference is that remerge can (only) be run when there is a
2932
pending merge, and it lets you specify particular files.
2935
Re-do the merge of all conflicted files, and show the base text in
2936
conflict regions, in addition to the usual THIS and OTHER texts::
2938
bzr remerge --show-base
2940
Re-do the merge of "foobar", using the weave merge algorithm, with
2941
additional processing to reduce the size of conflict regions::
2943
bzr remerge --merge-type weave --reprocess foobar
2945
takes_args = ['file*']
2950
help="Show base revision text in conflicts."),
2953
def run(self, file_list=None, merge_type=None, show_base=False,
2955
if merge_type is None:
2956
merge_type = _mod_merge.Merge3Merger
2957
tree, file_list = tree_files(file_list)
2960
parents = tree.get_parent_ids()
2961
if len(parents) != 2:
2962
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2963
" merges. Not cherrypicking or"
2965
repository = tree.branch.repository
2966
graph = repository.get_graph()
2967
base_revision = graph.find_unique_lca(parents[0], parents[1])
2968
base_tree = repository.revision_tree(base_revision)
2969
other_tree = repository.revision_tree(parents[1])
2970
interesting_ids = None
2972
conflicts = tree.conflicts()
2973
if file_list is not None:
2974
interesting_ids = set()
2975
for filename in file_list:
2976
file_id = tree.path2id(filename)
2978
raise errors.NotVersionedError(filename)
2979
interesting_ids.add(file_id)
2980
if tree.kind(file_id) != "directory":
2983
for name, ie in tree.inventory.iter_entries(file_id):
2984
interesting_ids.add(ie.file_id)
2985
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2987
# Remerge only supports resolving contents conflicts
2988
allowed_conflicts = ('text conflict', 'contents conflict')
2989
restore_files = [c.path for c in conflicts
2990
if c.typestring in allowed_conflicts]
2991
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2992
tree.set_conflicts(ConflictList(new_conflicts))
2993
if file_list is not None:
2994
restore_files = file_list
2995
for filename in restore_files:
2997
restore(tree.abspath(filename))
2998
except errors.NotConflicted:
3000
# Disable pending merges, because the file texts we are remerging
3001
# have not had those merges performed. If we use the wrong parents
3002
# list, we imply that the working tree text has seen and rejected
3003
# all the changes from the other tree, when in fact those changes
3004
# have not yet been seen.
3005
tree.set_parent_ids(parents[:1])
3007
conflicts = _mod_merge.merge_inner(
3008
tree.branch, other_tree, base_tree,
3010
interesting_ids=interesting_ids,
3011
other_rev_id=parents[1],
3012
merge_type=merge_type,
3013
show_base=show_base,
3014
reprocess=reprocess)
3016
tree.set_parent_ids(parents)
3025
class cmd_revert(Command):
3026
"""Revert files to a previous revision.
3028
Giving a list of files will revert only those files. Otherwise, all files
3029
will be reverted. If the revision is not specified with '--revision', the
3030
last committed revision is used.
3032
To remove only some changes, without reverting to a prior version, use
3033
merge instead. For example, "merge . --r-2..-3" will remove the changes
3034
introduced by -2, without affecting the changes introduced by -1. Or
3035
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3037
By default, any files that have been manually changed will be backed up
3038
first. (Files changed only by merge are not backed up.) Backup files have
3039
'.~#~' appended to their name, where # is a number.
3041
When you provide files, you can use their current pathname or the pathname
3042
from the target revision. So you can use revert to "undelete" a file by
3043
name. If you name a directory, all the contents of that directory will be
3046
Any files that have been newly added since that revision will be deleted,
3047
with a backup kept if appropriate. Directories containing unknown files
3048
will not be deleted.
3051
_see_also = ['cat', 'export']
3054
Option('no-backup', "Do not save backups of reverted files."),
3056
takes_args = ['file*']
3058
def run(self, revision=None, no_backup=False, file_list=None):
3059
if file_list is not None:
3060
if len(file_list) == 0:
3061
raise errors.BzrCommandError("No files specified")
3065
tree, file_list = tree_files(file_list)
3066
if revision is None:
3067
# FIXME should be tree.last_revision
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 are
3855
"thunderbird", "evolution", "editor", "xdg-email", "mapi", "kmail" and
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', 'doc/configuration.txt']
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
def _create_prefix(cur_transport):
4161
needed = [cur_transport]
4162
# Recurse upwards until we can create a directory successfully
4164
new_transport = cur_transport.clone('..')
4165
if new_transport.base == cur_transport.base:
4166
raise errors.BzrCommandError(
4167
"Failed to create path prefix for %s."
4168
% cur_transport.base)
4170
new_transport.mkdir('.')
4171
except errors.NoSuchFile:
4172
needed.append(new_transport)
4173
cur_transport = new_transport
4176
# Now we only need to create child directories
4178
cur_transport = needed.pop()
4179
cur_transport.ensure_base()
4182
def _get_mergeable_helper(location):
4183
"""Get a merge directive or bundle if 'location' points to one.
4185
Try try to identify a bundle and returns its mergeable form. If it's not,
4186
we return the tried transport anyway so that it can reused to access the
4189
:param location: can point to a bundle or a branch.
4191
:return: mergeable, transport
4194
url = urlutils.normalize_url(location)
4195
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4196
location_transport = transport.get_transport(url)
4199
# There may be redirections but we ignore the intermediate
4200
# and final transports used
4201
read = bundle.read_mergeable_from_transport
4202
mergeable, t = read(location_transport, filename)
4203
except errors.NotABundle:
4204
# Continue on considering this url a Branch but adjust the
4205
# location_transport
4206
location_transport = location_transport.clone(filename)
4207
return mergeable, location_transport
4210
# these get imported and then picked up by the scan for cmd_*
4211
# TODO: Some more consistent way to split command definitions across files;
4212
# we do need to load at least some information about them to know of
4213
# aliases. ideally we would avoid loading the implementation until the
4214
# details were needed.
4215
from bzrlib.cmd_version_info import cmd_version_info
4216
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4217
from bzrlib.bundle.commands import (
4220
from bzrlib.sign_my_commits import cmd_sign_my_commits
4221
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4222
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
