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
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
--short gives a status flags for each item, similar to the SVN's status
158
If no arguments are specified, the status of the entire working
159
directory is shown. Otherwise, only the status of the specified
160
files or directories is reported. If a directory is given, status
161
is reported for everything inside that directory.
163
If a revision argument is given, the status is calculated against
164
that revision, or between two revisions if two are provided.
167
# TODO: --no-recurse, --recurse options
169
takes_args = ['file*']
170
takes_options = ['show-ids', 'revision',
171
Option('short', help='Give short SVN-style status lines.'),
172
Option('versioned', help='Only show versioned files.')]
173
aliases = ['st', 'stat']
175
encoding_type = 'replace'
176
_see_also = ['diff', 'revert', 'status-flags']
179
def run(self, show_ids=False, file_list=None, revision=None, short=False,
181
from bzrlib.status import show_tree_status
183
tree, file_list = tree_files(file_list)
185
show_tree_status(tree, show_ids=show_ids,
186
specific_files=file_list, revision=revision,
187
to_file=self.outf, short=short, versioned=versioned)
190
class cmd_cat_revision(Command):
191
"""Write out metadata for a revision.
193
The revision to print can either be specified by a specific
194
revision identifier, or you can use --revision.
198
takes_args = ['revision_id?']
199
takes_options = ['revision']
200
# cat-revision is more for frontends so should be exact
204
def run(self, revision_id=None, revision=None):
206
revision_id = osutils.safe_revision_id(revision_id, warn=False)
207
if revision_id is not None and revision is not None:
208
raise errors.BzrCommandError('You can only supply one of'
209
' revision_id or --revision')
210
if revision_id is None and revision is None:
211
raise errors.BzrCommandError('You must supply either'
212
' --revision or a revision_id')
213
b = WorkingTree.open_containing(u'.')[0].branch
215
# TODO: jam 20060112 should cat-revision always output utf-8?
216
if revision_id is not None:
217
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
218
elif revision is not None:
221
raise errors.BzrCommandError('You cannot specify a NULL'
223
revno, rev_id = rev.in_history(b)
224
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
227
class cmd_remove_tree(Command):
228
"""Remove the working tree from a given branch/checkout.
230
Since a lightweight checkout is little more than a working tree
231
this will refuse to run against one.
233
To re-create the working tree, use "bzr checkout".
235
_see_also = ['checkout', 'working-trees']
237
takes_args = ['location?']
239
def run(self, location='.'):
240
d = bzrdir.BzrDir.open(location)
243
working = d.open_workingtree()
244
except errors.NoWorkingTree:
245
raise errors.BzrCommandError("No working tree to remove")
246
except errors.NotLocalUrl:
247
raise errors.BzrCommandError("You cannot remove the working tree of a "
250
working_path = working.bzrdir.root_transport.base
251
branch_path = working.branch.bzrdir.root_transport.base
252
if working_path != branch_path:
253
raise errors.BzrCommandError("You cannot remove the working tree from "
254
"a lightweight checkout")
256
d.destroy_workingtree()
259
class cmd_revno(Command):
260
"""Show current revision number.
262
This is equal to the number of revisions on this branch.
266
takes_args = ['location?']
269
def run(self, location=u'.'):
270
self.outf.write(str(Branch.open_containing(location)[0].revno()))
271
self.outf.write('\n')
274
class cmd_revision_info(Command):
275
"""Show revision number and revision id for a given revision identifier.
278
takes_args = ['revision_info*']
279
takes_options = ['revision']
282
def run(self, revision=None, revision_info_list=[]):
285
if revision is not None:
286
revs.extend(revision)
287
if revision_info_list is not None:
288
for rev in revision_info_list:
289
revs.append(RevisionSpec.from_string(rev))
291
b = Branch.open_containing(u'.')[0]
294
revs.append(RevisionSpec.from_string('-1'))
297
revinfo = rev.in_history(b)
298
if revinfo.revno is None:
299
dotted_map = b.get_revision_id_to_revno_map()
300
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
301
print '%s %s' % (revno, revinfo.rev_id)
303
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
306
class cmd_add(Command):
307
"""Add specified files or directories.
309
In non-recursive mode, all the named items are added, regardless
310
of whether they were previously ignored. A warning is given if
311
any of the named files are already versioned.
313
In recursive mode (the default), files are treated the same way
314
but the behaviour for directories is different. Directories that
315
are already versioned do not give a warning. All directories,
316
whether already versioned or not, are searched for files or
317
subdirectories that are neither versioned or ignored, and these
318
are added. This search proceeds recursively into versioned
319
directories. If no names are given '.' is assumed.
321
Therefore simply saying 'bzr add' will version all files that
322
are currently unknown.
324
Adding a file whose parent directory is not versioned will
325
implicitly add the parent, and so on up to the root. This means
326
you should never need to explicitly add a directory, they'll just
327
get added when you add a file in the directory.
329
--dry-run will show which files would be added, but not actually
332
--file-ids-from will try to use the file ids from the supplied path.
333
It looks up ids trying to find a matching parent directory with the
334
same filename, and then by pure path. This option is rarely needed
335
but can be useful when adding the same logical file into two
336
branches that will be merged later (without showing the two different
337
adds as a conflict). It is also useful when merging another project
338
into a subdirectory of this one.
340
takes_args = ['file*']
343
help="Don't recursively add the contents of directories."),
345
help="Show what would be done, but don't actually do anything."),
347
Option('file-ids-from',
349
help='Lookup file ids from this tree.'),
351
encoding_type = 'replace'
352
_see_also = ['remove']
354
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
359
if file_ids_from is not None:
361
base_tree, base_path = WorkingTree.open_containing(
363
except errors.NoWorkingTree:
364
base_branch, base_path = Branch.open_containing(
366
base_tree = base_branch.basis_tree()
368
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
369
to_file=self.outf, should_print=(not is_quiet()))
371
action = bzrlib.add.AddAction(to_file=self.outf,
372
should_print=(not is_quiet()))
375
base_tree.lock_read()
377
file_list = self._maybe_expand_globs(file_list)
379
tree = WorkingTree.open_containing(file_list[0])[0]
381
tree = WorkingTree.open_containing(u'.')[0]
382
added, ignored = tree.smart_add(file_list, not
383
no_recurse, action=action, save=not dry_run)
385
if base_tree is not None:
389
for glob in sorted(ignored.keys()):
390
for path in ignored[glob]:
391
self.outf.write("ignored %s matching \"%s\"\n"
395
for glob, paths in ignored.items():
396
match_len += len(paths)
397
self.outf.write("ignored %d file(s).\n" % match_len)
398
self.outf.write("If you wish to add some of these files,"
399
" please add them by name.\n")
402
class cmd_mkdir(Command):
403
"""Create a new versioned directory.
405
This is equivalent to creating the directory and then adding it.
408
takes_args = ['dir+']
409
encoding_type = 'replace'
411
def run(self, dir_list):
414
wt, dd = WorkingTree.open_containing(d)
416
self.outf.write('added %s\n' % d)
419
class cmd_relpath(Command):
420
"""Show path of a file relative to root"""
422
takes_args = ['filename']
426
def run(self, filename):
427
# TODO: jam 20050106 Can relpath return a munged path if
428
# sys.stdout encoding cannot represent it?
429
tree, relpath = WorkingTree.open_containing(filename)
430
self.outf.write(relpath)
431
self.outf.write('\n')
434
class cmd_inventory(Command):
435
"""Show inventory of the current working copy or a revision.
437
It is possible to limit the output to a particular entry
438
type using the --kind option. For example: --kind file.
440
It is also possible to restrict the list of files to a specific
441
set. For example: bzr inventory --show-ids this/file
450
help='List entries of a particular kind: file, directory, symlink.',
453
takes_args = ['file*']
456
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
457
if kind and kind not in ['file', 'directory', 'symlink']:
458
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
460
work_tree, file_list = tree_files(file_list)
461
work_tree.lock_read()
463
if revision is not None:
464
if len(revision) > 1:
465
raise errors.BzrCommandError(
466
'bzr inventory --revision takes exactly one revision'
468
revision_id = revision[0].in_history(work_tree.branch).rev_id
469
tree = work_tree.branch.repository.revision_tree(revision_id)
471
extra_trees = [work_tree]
477
if file_list is not None:
478
file_ids = tree.paths2ids(file_list, trees=extra_trees,
479
require_versioned=True)
480
# find_ids_across_trees may include some paths that don't
482
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
483
for file_id in file_ids if file_id in tree)
485
entries = tree.inventory.entries()
488
if tree is not work_tree:
491
for path, entry in entries:
492
if kind and kind != entry.kind:
495
self.outf.write('%-50s %s\n' % (path, entry.file_id))
497
self.outf.write(path)
498
self.outf.write('\n')
501
class cmd_mv(Command):
502
"""Move or rename a file.
505
bzr mv OLDNAME NEWNAME
507
bzr mv SOURCE... DESTINATION
509
If the last argument is a versioned directory, all the other names
510
are moved into it. Otherwise, there must be exactly two arguments
511
and the file is changed to a new name.
513
If OLDNAME does not exist on the filesystem but is versioned and
514
NEWNAME does exist on the filesystem but is not versioned, mv
515
assumes that the file has been manually moved and only updates
516
its internal inventory to reflect that change.
517
The same is valid when moving many SOURCE files to a DESTINATION.
519
Files cannot be moved between branches.
522
takes_args = ['names*']
523
takes_options = [Option("after", help="Move only the bzr identifier"
524
" of the file, because the file has already been moved."),
526
aliases = ['move', 'rename']
527
encoding_type = 'replace'
529
def run(self, names_list, after=False):
530
if names_list is None:
533
if len(names_list) < 2:
534
raise errors.BzrCommandError("missing file argument")
535
tree, rel_names = tree_files(names_list)
537
if os.path.isdir(names_list[-1]):
538
# move into existing directory
539
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
540
self.outf.write("%s => %s\n" % pair)
542
if len(names_list) != 2:
543
raise errors.BzrCommandError('to mv multiple files the'
544
' destination must be a versioned'
546
tree.rename_one(rel_names[0], rel_names[1], after=after)
547
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
550
class cmd_pull(Command):
551
"""Turn this branch into a mirror of another branch.
553
This command only works on branches that have not diverged. Branches are
554
considered diverged if the destination branch's most recent commit is one
555
that has not been merged (directly or indirectly) into the parent.
557
If branches have diverged, you can use 'bzr merge' to integrate the changes
558
from one into the other. Once one branch has merged, the other should
559
be able to pull it again.
561
If you want to forget your local changes and just update your branch to
562
match the remote one, use pull --overwrite.
564
If there is no default location set, the first pull will set it. After
565
that, you can omit the location to use the default. To change the
566
default, use --remember. The value will only be saved if the remote
567
location can be accessed.
570
_see_also = ['push', 'update', 'status-flags']
571
takes_options = ['remember', 'overwrite', 'revision',
572
Option('verbose', short_name='v',
573
help='Show logs of pulled revisions.'),
575
help='Branch to pull into, '
576
'rather than the one containing the working directory.',
581
takes_args = ['location?']
582
encoding_type = 'replace'
584
def run(self, location=None, remember=False, overwrite=False,
585
revision=None, verbose=False,
587
# FIXME: too much stuff is in the command class
590
if directory is None:
593
tree_to = WorkingTree.open_containing(directory)[0]
594
branch_to = tree_to.branch
595
except errors.NoWorkingTree:
597
branch_to = Branch.open_containing(directory)[0]
599
if location is not None:
600
mergeable, location_transport = _get_mergeable_helper(location)
602
stored_loc = branch_to.get_parent()
604
if stored_loc is None:
605
raise errors.BzrCommandError("No pull location known or"
608
display_url = urlutils.unescape_for_display(stored_loc,
610
self.outf.write("Using saved location: %s\n" % display_url)
611
location = stored_loc
612
location_transport = transport.get_transport(location)
614
if mergeable is not None:
615
if revision is not None:
616
raise errors.BzrCommandError(
617
'Cannot use -r with merge directives or bundles')
618
mergeable.install_revisions(branch_to.repository)
619
base_revision_id, revision_id, verified = \
620
mergeable.get_merge_request(branch_to.repository)
621
branch_from = branch_to
623
branch_from = Branch.open_from_transport(location_transport)
625
if branch_to.get_parent() is None or remember:
626
branch_to.set_parent(branch_from.base)
628
if revision is not None:
629
if len(revision) == 1:
630
revision_id = revision[0].in_history(branch_from).rev_id
632
raise errors.BzrCommandError(
633
'bzr pull --revision takes one value.')
636
old_rh = branch_to.revision_history()
637
if tree_to is not None:
638
result = tree_to.pull(branch_from, overwrite, revision_id,
639
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
641
result = branch_to.pull(branch_from, overwrite, revision_id)
643
result.report(self.outf)
645
new_rh = branch_to.revision_history()
646
log.show_changed_revisions(branch_to, old_rh, new_rh,
650
class cmd_push(Command):
651
"""Update a mirror of this branch.
653
The target branch will not have its working tree populated because this
654
is both expensive, and is not supported on remote file systems.
656
Some smart servers or protocols *may* put the working tree in place in
659
This command only works on branches that have not diverged. Branches are
660
considered diverged if the destination branch's most recent commit is one
661
that has not been merged (directly or indirectly) by the source branch.
663
If branches have diverged, you can use 'bzr push --overwrite' to replace
664
the other branch completely, discarding its unmerged changes.
666
If you want to ensure you have the different changes in the other branch,
667
do a merge (see bzr help merge) from the other branch, and commit that.
668
After that you will be able to do a push without '--overwrite'.
670
If there is no default push location set, the first push will set it.
671
After that, you can omit the location to use the default. To change the
672
default, use --remember. The value will only be saved if the remote
673
location can be accessed.
676
_see_also = ['pull', 'update', 'working-trees']
677
takes_options = ['remember', 'overwrite', 'verbose',
678
Option('create-prefix',
679
help='Create the path leading up to the branch '
680
'if it does not already exist.'),
682
help='Branch to push from, '
683
'rather than the one containing the working directory.',
687
Option('use-existing-dir',
688
help='By default push will fail if the target'
689
' directory exists, but does not already'
690
' have a control directory. This flag will'
691
' allow push to proceed.'),
693
takes_args = ['location?']
694
encoding_type = 'replace'
696
def run(self, location=None, remember=False, overwrite=False,
697
create_prefix=False, verbose=False,
698
use_existing_dir=False,
700
# FIXME: Way too big! Put this into a function called from the
702
if directory is None:
704
br_from = Branch.open_containing(directory)[0]
705
stored_loc = br_from.get_push_location()
707
if stored_loc is None:
708
raise errors.BzrCommandError("No push location known or specified.")
710
display_url = urlutils.unescape_for_display(stored_loc,
712
self.outf.write("Using saved location: %s\n" % display_url)
713
location = stored_loc
715
to_transport = transport.get_transport(location)
717
br_to = repository_to = dir_to = None
719
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
720
except errors.NotBranchError:
721
pass # Didn't find anything
723
# If we can open a branch, use its direct repository, otherwise see
724
# if there is a repository without a branch.
726
br_to = dir_to.open_branch()
727
except errors.NotBranchError:
728
# Didn't find a branch, can we find a repository?
730
repository_to = dir_to.find_repository()
731
except errors.NoRepositoryPresent:
734
# Found a branch, so we must have found a repository
735
repository_to = br_to.repository
740
# The destination doesn't exist; create it.
741
# XXX: Refactor the create_prefix/no_create_prefix code into a
742
# common helper function
744
to_transport.mkdir('.')
745
except errors.FileExists:
746
if not use_existing_dir:
747
raise errors.BzrCommandError("Target directory %s"
748
" already exists, but does not have a valid .bzr"
749
" directory. Supply --use-existing-dir to push"
750
" there anyway." % location)
751
except errors.NoSuchFile:
752
if not create_prefix:
753
raise errors.BzrCommandError("Parent directory of %s"
755
"\nYou may supply --create-prefix to create all"
756
" leading parent directories."
758
_create_prefix(to_transport)
760
# Now the target directory exists, but doesn't have a .bzr
761
# directory. So we need to create it, along with any work to create
762
# all of the dependent branches, etc.
763
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
764
revision_id=br_from.last_revision())
765
br_to = dir_to.open_branch()
766
# TODO: Some more useful message about what was copied
767
note('Created new branch.')
768
# We successfully created the target, remember it
769
if br_from.get_push_location() is None or remember:
770
br_from.set_push_location(br_to.base)
771
elif repository_to is None:
772
# we have a bzrdir but no branch or repository
773
# XXX: Figure out what to do other than complain.
774
raise errors.BzrCommandError("At %s you have a valid .bzr control"
775
" directory, but not a branch or repository. This is an"
776
" unsupported configuration. Please move the target directory"
777
" out of the way and try again."
780
# We have a repository but no branch, copy the revisions, and then
782
last_revision_id = br_from.last_revision()
783
repository_to.fetch(br_from.repository,
784
revision_id=last_revision_id)
785
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
786
note('Created new branch.')
787
if br_from.get_push_location() is None or remember:
788
br_from.set_push_location(br_to.base)
789
else: # We have a valid to branch
790
# We were able to connect to the remote location, so remember it
791
# we don't need to successfully push because of possible divergence.
792
if br_from.get_push_location() is None or remember:
793
br_from.set_push_location(br_to.base)
795
old_rh = br_to.revision_history()
798
tree_to = dir_to.open_workingtree()
799
except errors.NotLocalUrl:
800
warning("This transport does not update the working "
801
"tree of: %s. See 'bzr help working-trees' for "
802
"more information." % br_to.base)
803
push_result = br_from.push(br_to, overwrite)
804
except errors.NoWorkingTree:
805
push_result = br_from.push(br_to, overwrite)
809
push_result = br_from.push(tree_to.branch, overwrite)
813
except errors.DivergedBranches:
814
raise errors.BzrCommandError('These branches have diverged.'
815
' Try using "merge" and then "push".')
816
if push_result is not None:
817
push_result.report(self.outf)
819
new_rh = br_to.revision_history()
822
from bzrlib.log import show_changed_revisions
823
show_changed_revisions(br_to, old_rh, new_rh,
826
# we probably did a clone rather than a push, so a message was
831
class cmd_branch(Command):
832
"""Create a new copy of a branch.
834
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
835
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
836
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
837
is derived from the FROM_LOCATION by stripping a leading scheme or drive
838
identifier, if any. For example, "branch lp:foo-bar" will attempt to
841
To retrieve the branch as of a particular revision, supply the --revision
842
parameter, as in "branch foo/bar -r 5".
845
_see_also = ['checkout']
846
takes_args = ['from_location', 'to_location?']
847
takes_options = ['revision']
848
aliases = ['get', 'clone']
850
def run(self, from_location, to_location=None, revision=None):
851
from bzrlib.tag import _merge_tags_if_possible
854
elif len(revision) > 1:
855
raise errors.BzrCommandError(
856
'bzr branch --revision takes exactly 1 revision value')
858
br_from = Branch.open(from_location)
861
if len(revision) == 1 and revision[0] is not None:
862
revision_id = revision[0].in_history(br_from)[1]
864
# FIXME - wt.last_revision, fallback to branch, fall back to
865
# None or perhaps NULL_REVISION to mean copy nothing
867
revision_id = br_from.last_revision()
868
if to_location is None:
869
to_location = urlutils.derive_to_location(from_location)
872
name = os.path.basename(to_location) + '\n'
874
to_transport = transport.get_transport(to_location)
876
to_transport.mkdir('.')
877
except errors.FileExists:
878
raise errors.BzrCommandError('Target directory "%s" already'
879
' exists.' % to_location)
880
except errors.NoSuchFile:
881
raise errors.BzrCommandError('Parent of "%s" does not exist.'
884
# preserve whatever source format we have.
885
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
886
possible_transports=[to_transport])
887
branch = dir.open_branch()
888
except errors.NoSuchRevision:
889
to_transport.delete_tree('.')
890
msg = "The branch %s has no revision %s." % (from_location, revision[0])
891
raise errors.BzrCommandError(msg)
893
branch.control_files.put_utf8('branch-name', name)
894
_merge_tags_if_possible(br_from, branch)
895
note('Branched %d revision(s).' % branch.revno())
900
class cmd_checkout(Command):
901
"""Create a new checkout of an existing branch.
903
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
904
the branch found in '.'. This is useful if you have removed the working tree
905
or if it was never created - i.e. if you pushed the branch to its current
908
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
909
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
910
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
911
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
912
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
915
To retrieve the branch as of a particular revision, supply the --revision
916
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
917
out of date [so you cannot commit] but it may be useful (i.e. to examine old
921
_see_also = ['checkouts', 'branch']
922
takes_args = ['branch_location?', 'to_location?']
923
takes_options = ['revision',
924
Option('lightweight',
925
help="Perform a lightweight checkout. Lightweight "
926
"checkouts depend on access to the branch for "
927
"every operation. Normal checkouts can perform "
928
"common operations like diff and status without "
929
"such access, and also support local commits."
934
def run(self, branch_location=None, to_location=None, revision=None,
938
elif len(revision) > 1:
939
raise errors.BzrCommandError(
940
'bzr checkout --revision takes exactly 1 revision value')
941
if branch_location is None:
942
branch_location = osutils.getcwd()
943
to_location = branch_location
944
source = Branch.open(branch_location)
945
if len(revision) == 1 and revision[0] is not None:
946
revision_id = _mod_revision.ensure_null(
947
revision[0].in_history(source)[1])
950
if to_location is None:
951
to_location = urlutils.derive_to_location(branch_location)
952
# if the source and to_location are the same,
953
# and there is no working tree,
954
# then reconstitute a branch
955
if (osutils.abspath(to_location) ==
956
osutils.abspath(branch_location)):
958
source.bzrdir.open_workingtree()
959
except errors.NoWorkingTree:
960
source.bzrdir.create_workingtree(revision_id)
963
os.mkdir(to_location)
965
if e.errno == errno.EEXIST:
966
raise errors.BzrCommandError('Target directory "%s" already'
967
' exists.' % to_location)
968
if e.errno == errno.ENOENT:
969
raise errors.BzrCommandError('Parent of "%s" does not exist.'
973
source.create_checkout(to_location, revision_id, lightweight)
976
class cmd_renames(Command):
977
"""Show list of renamed files.
979
# TODO: Option to show renames between two historical versions.
981
# TODO: Only show renames under dir, rather than in the whole branch.
982
_see_also = ['status']
983
takes_args = ['dir?']
986
def run(self, dir=u'.'):
987
tree = WorkingTree.open_containing(dir)[0]
990
new_inv = tree.inventory
991
old_tree = tree.basis_tree()
994
old_inv = old_tree.inventory
995
renames = list(_mod_tree.find_renames(old_inv, new_inv))
997
for old_name, new_name in renames:
998
self.outf.write("%s => %s\n" % (old_name, new_name))
1005
class cmd_update(Command):
1006
"""Update a tree to have the latest code committed to its branch.
1008
This will perform a merge into the working tree, and may generate
1009
conflicts. If you have any local changes, you will still
1010
need to commit them after the update for the update to be complete.
1012
If you want to discard your local changes, you can just do a
1013
'bzr revert' instead of 'bzr commit' after the update.
1016
_see_also = ['pull', 'working-trees', 'status-flags']
1017
takes_args = ['dir?']
1020
def run(self, dir='.'):
1021
tree = WorkingTree.open_containing(dir)[0]
1022
master = tree.branch.get_master_branch()
1023
if master is not None:
1026
tree.lock_tree_write()
1028
existing_pending_merges = tree.get_parent_ids()[1:]
1029
last_rev = _mod_revision.ensure_null(tree.last_revision())
1030
if last_rev == _mod_revision.ensure_null(
1031
tree.branch.last_revision()):
1032
# may be up to date, check master too.
1033
if master is None or last_rev == _mod_revision.ensure_null(
1034
master.last_revision()):
1035
revno = tree.branch.revision_id_to_revno(last_rev)
1036
note("Tree is up to date at revision %d." % (revno,))
1038
conflicts = tree.update(delta._ChangeReporter(
1039
unversioned_filter=tree.is_ignored))
1040
revno = tree.branch.revision_id_to_revno(
1041
_mod_revision.ensure_null(tree.last_revision()))
1042
note('Updated to revision %d.' % (revno,))
1043
if tree.get_parent_ids()[1:] != existing_pending_merges:
1044
note('Your local commits will now show as pending merges with '
1045
"'bzr status', and can be committed with 'bzr commit'.")
1054
class cmd_info(Command):
1055
"""Show information about a working tree, branch or repository.
1057
This command will show all known locations and formats associated to the
1058
tree, branch or repository. Statistical information is included with
1061
Branches and working trees will also report any missing revisions.
1063
_see_also = ['revno', 'working-trees', 'repositories']
1064
takes_args = ['location?']
1065
takes_options = ['verbose']
1068
def run(self, location=None, verbose=0):
1069
from bzrlib.info import show_bzrdir_info
1070
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1074
class cmd_remove(Command):
1075
"""Remove files or directories.
1077
This makes bzr stop tracking changes to the specified files and
1078
delete them if they can easily be recovered using revert.
1080
You can specify one or more files, and/or --new. If you specify --new,
1081
only 'added' files will be removed. If you specify both, then new files
1082
in the specified directories will be removed. If the directories are
1083
also new, they will also be removed.
1085
takes_args = ['file*']
1086
takes_options = ['verbose',
1087
Option('new', help='Remove newly-added files.'),
1088
RegistryOption.from_kwargs('file-deletion-strategy',
1089
'The file deletion mode to be used.',
1090
title='Deletion Strategy', value_switches=True, enum_switch=False,
1091
safe='Only delete files if they can be'
1092
' safely recovered (default).',
1093
keep="Don't delete any files.",
1094
force='Delete all the specified files, even if they can not be '
1095
'recovered and even if they are non-empty directories.')]
1097
encoding_type = 'replace'
1099
def run(self, file_list, verbose=False, new=False,
1100
file_deletion_strategy='safe'):
1101
tree, file_list = tree_files(file_list)
1103
if file_list is not None:
1104
file_list = [f for f in file_list if f != '']
1106
raise errors.BzrCommandError('Specify one or more files to'
1107
' remove, or use --new.')
1110
added = tree.changes_from(tree.basis_tree(),
1111
specific_files=file_list).added
1112
file_list = sorted([f[0] for f in added], reverse=True)
1113
if len(file_list) == 0:
1114
raise errors.BzrCommandError('No matching files.')
1115
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1116
keep_files=file_deletion_strategy=='keep',
1117
force=file_deletion_strategy=='force')
1120
class cmd_file_id(Command):
1121
"""Print file_id of a particular file or directory.
1123
The file_id is assigned when the file is first added and remains the
1124
same through all revisions where the file exists, even when it is
1129
_see_also = ['inventory', 'ls']
1130
takes_args = ['filename']
1133
def run(self, filename):
1134
tree, relpath = WorkingTree.open_containing(filename)
1135
i = tree.path2id(relpath)
1137
raise errors.NotVersionedError(filename)
1139
self.outf.write(i + '\n')
1142
class cmd_file_path(Command):
1143
"""Print path of file_ids to a file or directory.
1145
This prints one line for each directory down to the target,
1146
starting at the branch root.
1150
takes_args = ['filename']
1153
def run(self, filename):
1154
tree, relpath = WorkingTree.open_containing(filename)
1155
fid = tree.path2id(relpath)
1157
raise errors.NotVersionedError(filename)
1158
segments = osutils.splitpath(relpath)
1159
for pos in range(1, len(segments) + 1):
1160
path = osutils.joinpath(segments[:pos])
1161
self.outf.write("%s\n" % tree.path2id(path))
1164
class cmd_reconcile(Command):
1165
"""Reconcile bzr metadata in a branch.
1167
This can correct data mismatches that may have been caused by
1168
previous ghost operations or bzr upgrades. You should only
1169
need to run this command if 'bzr check' or a bzr developer
1170
advises you to run it.
1172
If a second branch is provided, cross-branch reconciliation is
1173
also attempted, which will check that data like the tree root
1174
id which was not present in very early bzr versions is represented
1175
correctly in both branches.
1177
At the same time it is run it may recompress data resulting in
1178
a potential saving in disk space or performance gain.
1180
The branch *MUST* be on a listable system such as local disk or sftp.
1183
_see_also = ['check']
1184
takes_args = ['branch?']
1186
def run(self, branch="."):
1187
from bzrlib.reconcile import reconcile
1188
dir = bzrdir.BzrDir.open(branch)
1192
class cmd_revision_history(Command):
1193
"""Display the list of revision ids on a branch."""
1196
takes_args = ['location?']
1201
def run(self, location="."):
1202
branch = Branch.open_containing(location)[0]
1203
for revid in branch.revision_history():
1204
self.outf.write(revid)
1205
self.outf.write('\n')
1208
class cmd_ancestry(Command):
1209
"""List all revisions merged into this branch."""
1211
_see_also = ['log', 'revision-history']
1212
takes_args = ['location?']
1217
def run(self, location="."):
1219
wt = WorkingTree.open_containing(location)[0]
1220
except errors.NoWorkingTree:
1221
b = Branch.open(location)
1222
last_revision = b.last_revision()
1225
last_revision = wt.last_revision()
1227
revision_ids = b.repository.get_ancestry(last_revision)
1228
assert revision_ids[0] is None
1230
for revision_id in revision_ids:
1231
self.outf.write(revision_id + '\n')
1234
class cmd_init(Command):
1235
"""Make a directory into a versioned branch.
1237
Use this to create an empty branch, or before importing an
1240
If there is a repository in a parent directory of the location, then
1241
the history of the branch will be stored in the repository. Otherwise
1242
init creates a standalone branch which carries its own history
1243
in the .bzr directory.
1245
If there is already a branch at the location but it has no working tree,
1246
the tree can be populated with 'bzr checkout'.
1248
Recipe for importing a tree of files::
1254
bzr commit -m 'imported project'
1257
_see_also = ['init-repository', 'branch', 'checkout']
1258
takes_args = ['location?']
1260
Option('create-prefix',
1261
help='Create the path leading up to the branch '
1262
'if it does not already exist.'),
1263
RegistryOption('format',
1264
help='Specify a format for this branch. '
1265
'See "help formats".',
1266
registry=bzrdir.format_registry,
1267
converter=bzrdir.format_registry.make_bzrdir,
1268
value_switches=True,
1269
title="Branch Format",
1271
Option('append-revisions-only',
1272
help='Never change revnos or the existing log.'
1273
' Append revisions to it only.')
1275
def run(self, location=None, format=None, append_revisions_only=False,
1276
create_prefix=False):
1278
format = bzrdir.format_registry.make_bzrdir('default')
1279
if location is None:
1282
to_transport = transport.get_transport(location)
1284
# The path has to exist to initialize a
1285
# branch inside of it.
1286
# Just using os.mkdir, since I don't
1287
# believe that we want to create a bunch of
1288
# locations if the user supplies an extended path
1290
to_transport.ensure_base()
1291
except errors.NoSuchFile:
1292
if not create_prefix:
1293
raise errors.BzrCommandError("Parent directory of %s"
1295
"\nYou may supply --create-prefix to create all"
1296
" leading parent directories."
1298
_create_prefix(to_transport)
1301
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1302
except errors.NotBranchError:
1303
# really a NotBzrDir error...
1304
create_branch = bzrdir.BzrDir.create_branch_convenience
1305
branch = create_branch(to_transport.base, format=format,
1306
possible_transports=[to_transport])
1308
from bzrlib.transport.local import LocalTransport
1309
if existing_bzrdir.has_branch():
1310
if (isinstance(to_transport, LocalTransport)
1311
and not existing_bzrdir.has_workingtree()):
1312
raise errors.BranchExistsWithoutWorkingTree(location)
1313
raise errors.AlreadyBranchError(location)
1315
branch = existing_bzrdir.create_branch()
1316
existing_bzrdir.create_workingtree()
1317
if append_revisions_only:
1319
branch.set_append_revisions_only(True)
1320
except errors.UpgradeRequired:
1321
raise errors.BzrCommandError('This branch format cannot be set'
1322
' to append-revisions-only. Try --experimental-branch6')
1325
class cmd_init_repository(Command):
1326
"""Create a shared repository to hold branches.
1328
New branches created under the repository directory will store their
1329
revisions in the repository, not in the branch directory.
1331
If the --no-trees option is used then the branches in the repository
1332
will not have working trees by default.
1335
Create a shared repositories holding just branches::
1337
bzr init-repo --no-trees repo
1340
Make a lightweight checkout elsewhere::
1342
bzr checkout --lightweight repo/trunk trunk-checkout
1347
_see_also = ['init', 'branch', 'checkout', 'repositories']
1348
takes_args = ["location"]
1349
takes_options = [RegistryOption('format',
1350
help='Specify a format for this repository. See'
1351
' "bzr help formats" for details.',
1352
registry=bzrdir.format_registry,
1353
converter=bzrdir.format_registry.make_bzrdir,
1354
value_switches=True, title='Repository format'),
1356
help='Branches in the repository will default to'
1357
' not having a working tree.'),
1359
aliases = ["init-repo"]
1361
def run(self, location, format=None, no_trees=False):
1363
format = bzrdir.format_registry.make_bzrdir('default')
1365
if location is None:
1368
to_transport = transport.get_transport(location)
1369
to_transport.ensure_base()
1371
newdir = format.initialize_on_transport(to_transport)
1372
repo = newdir.create_repository(shared=True)
1373
repo.set_make_working_trees(not no_trees)
1376
class cmd_diff(Command):
1377
"""Show differences in the working tree or between revisions.
1379
If files are listed, only the changes in those files are listed.
1380
Otherwise, all changes for the tree are listed.
1382
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1383
produces patches suitable for "patch -p1".
1386
Shows the difference in the working tree versus the last commit::
1390
Difference between the working tree and revision 1::
1394
Difference between revision 2 and revision 1::
1398
Same as 'bzr diff' but prefix paths with old/ and new/::
1400
bzr diff --prefix old/:new/
1402
Show the differences between the two working trees::
1404
bzr diff bzr.mine bzr.dev
1406
Show just the differences for 'foo.c'::
1410
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1411
# or a graphical diff.
1413
# TODO: Python difflib is not exactly the same as unidiff; should
1414
# either fix it up or prefer to use an external diff.
1416
# TODO: Selected-file diff is inefficient and doesn't show you
1419
# TODO: This probably handles non-Unix newlines poorly.
1421
_see_also = ['status']
1422
takes_args = ['file*']
1424
Option('diff-options', type=str,
1425
help='Pass these options to the external diff program.'),
1426
Option('prefix', type=str,
1428
help='Set prefixes to added to old and new filenames, as '
1429
'two values separated by a colon. (eg "old/:new/").'),
1432
aliases = ['di', 'dif']
1433
encoding_type = 'exact'
1436
def run(self, revision=None, file_list=None, diff_options=None,
1438
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1440
if (prefix is None) or (prefix == '0'):
1448
old_label, new_label = prefix.split(":")
1450
raise errors.BzrCommandError(
1451
'--prefix expects two values separated by a colon'
1452
' (eg "old/:new/")')
1454
if revision and len(revision) > 2:
1455
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1456
' one or two revision specifiers')
1459
tree1, file_list = internal_tree_files(file_list)
1463
except errors.FileInWrongBranch:
1464
if len(file_list) != 2:
1465
raise errors.BzrCommandError("Files are in different branches")
1467
tree1, file1 = WorkingTree.open_containing(file_list[0])
1468
tree2, file2 = WorkingTree.open_containing(file_list[1])
1469
if file1 != "" or file2 != "":
1470
# FIXME diff those two files. rbc 20051123
1471
raise errors.BzrCommandError("Files are in different branches")
1473
except errors.NotBranchError:
1474
if (revision is not None and len(revision) == 2
1475
and not revision[0].needs_branch()
1476
and not revision[1].needs_branch()):
1477
# If both revision specs include a branch, we can
1478
# diff them without needing a local working tree
1479
tree1, tree2 = None, None
1483
if tree2 is not None:
1484
if revision is not None:
1485
# FIXME: but there should be a clean way to diff between
1486
# non-default versions of two trees, it's not hard to do
1488
raise errors.BzrCommandError(
1489
"Sorry, diffing arbitrary revisions across branches "
1490
"is not implemented yet")
1491
return show_diff_trees(tree1, tree2, sys.stdout,
1492
specific_files=file_list,
1493
external_diff_options=diff_options,
1494
old_label=old_label, new_label=new_label)
1496
return diff_cmd_helper(tree1, file_list, diff_options,
1497
revision_specs=revision,
1498
old_label=old_label, new_label=new_label)
1501
class cmd_deleted(Command):
1502
"""List files deleted in the working tree.
1504
# TODO: Show files deleted since a previous revision, or
1505
# between two revisions.
1506
# TODO: Much more efficient way to do this: read in new
1507
# directories with readdir, rather than stating each one. Same
1508
# level of effort but possibly much less IO. (Or possibly not,
1509
# if the directories are very large...)
1510
_see_also = ['status', 'ls']
1511
takes_options = ['show-ids']
1514
def run(self, show_ids=False):
1515
tree = WorkingTree.open_containing(u'.')[0]
1518
old = tree.basis_tree()
1521
for path, ie in old.inventory.iter_entries():
1522
if not tree.has_id(ie.file_id):
1523
self.outf.write(path)
1525
self.outf.write(' ')
1526
self.outf.write(ie.file_id)
1527
self.outf.write('\n')
1534
class cmd_modified(Command):
1535
"""List files modified in working tree.
1539
_see_also = ['status', 'ls']
1543
tree = WorkingTree.open_containing(u'.')[0]
1544
td = tree.changes_from(tree.basis_tree())
1545
for path, id, kind, text_modified, meta_modified in td.modified:
1546
self.outf.write(path + '\n')
1549
class cmd_added(Command):
1550
"""List files added in working tree.
1554
_see_also = ['status', 'ls']
1558
wt = WorkingTree.open_containing(u'.')[0]
1561
basis = wt.basis_tree()
1564
basis_inv = basis.inventory
1567
if file_id in basis_inv:
1569
if inv.is_root(file_id) and len(basis_inv) == 0:
1571
path = inv.id2path(file_id)
1572
if not os.access(osutils.abspath(path), os.F_OK):
1574
self.outf.write(path + '\n')
1581
class cmd_root(Command):
1582
"""Show the tree root directory.
1584
The root is the nearest enclosing directory with a .bzr control
1587
takes_args = ['filename?']
1589
def run(self, filename=None):
1590
"""Print the branch root."""
1591
tree = WorkingTree.open_containing(filename)[0]
1592
self.outf.write(tree.basedir + '\n')
1595
def _parse_limit(limitstring):
1597
return int(limitstring)
1599
msg = "The limit argument must be an integer."
1600
raise errors.BzrCommandError(msg)
1603
class cmd_log(Command):
1604
"""Show log of a branch, file, or directory.
1606
By default show the log of the branch containing the working directory.
1608
To request a range of logs, you can use the command -r begin..end
1609
-r revision requests a specific revision, -r ..end or -r begin.. are
1613
Log the current branch::
1621
Log the last 10 revisions of a branch::
1623
bzr log -r -10.. http://server/branch
1626
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1628
takes_args = ['location?']
1631
help='Show from oldest to newest.'),
1634
help='Display timezone as local, original, or utc.'),
1637
help='Show files changed in each revision.'),
1643
help='Show revisions whose message matches this '
1644
'regular expression.',
1647
help='Limit the output to the first N revisions.',
1651
encoding_type = 'replace'
1654
def run(self, location=None, timezone='original',
1662
from bzrlib.log import show_log
1663
assert message is None or isinstance(message, basestring), \
1664
"invalid message argument %r" % message
1665
direction = (forward and 'forward') or 'reverse'
1670
# find the file id to log:
1672
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1676
tree = b.basis_tree()
1677
file_id = tree.path2id(fp)
1679
raise errors.BzrCommandError(
1680
"Path does not have any revision history: %s" %
1684
# FIXME ? log the current subdir only RBC 20060203
1685
if revision is not None \
1686
and len(revision) > 0 and revision[0].get_branch():
1687
location = revision[0].get_branch()
1690
dir, relpath = bzrdir.BzrDir.open_containing(location)
1691
b = dir.open_branch()
1695
if revision is None:
1698
elif len(revision) == 1:
1699
rev1 = rev2 = revision[0].in_history(b)
1700
elif len(revision) == 2:
1701
if revision[1].get_branch() != revision[0].get_branch():
1702
# b is taken from revision[0].get_branch(), and
1703
# show_log will use its revision_history. Having
1704
# different branches will lead to weird behaviors.
1705
raise errors.BzrCommandError(
1706
"Log doesn't accept two revisions in different"
1708
rev1 = revision[0].in_history(b)
1709
rev2 = revision[1].in_history(b)
1711
raise errors.BzrCommandError(
1712
'bzr log --revision takes one or two values.')
1714
if log_format is None:
1715
log_format = log.log_formatter_registry.get_default(b)
1717
lf = log_format(show_ids=show_ids, to_file=self.outf,
1718
show_timezone=timezone)
1724
direction=direction,
1725
start_revision=rev1,
1733
def get_log_format(long=False, short=False, line=False, default='long'):
1734
log_format = default
1738
log_format = 'short'
1744
class cmd_touching_revisions(Command):
1745
"""Return revision-ids which affected a particular file.
1747
A more user-friendly interface is "bzr log FILE".
1751
takes_args = ["filename"]
1754
def run(self, filename):
1755
tree, relpath = WorkingTree.open_containing(filename)
1757
file_id = tree.path2id(relpath)
1758
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1759
self.outf.write("%6d %s\n" % (revno, what))
1762
class cmd_ls(Command):
1763
"""List files in a tree.
1766
_see_also = ['status', 'cat']
1767
takes_args = ['path?']
1768
# TODO: Take a revision or remote path and list that tree instead.
1772
Option('non-recursive',
1773
help='Don\'t recurse into subdirectories.'),
1775
help='Print paths relative to the root of the branch.'),
1776
Option('unknown', help='Print unknown files.'),
1777
Option('versioned', help='Print versioned files.'),
1778
Option('ignored', help='Print ignored files.'),
1780
help='Write an ascii NUL (\\0) separator '
1781
'between files rather than a newline.'),
1783
help='List entries of a particular kind: file, directory, symlink.',
1788
def run(self, revision=None, verbose=False,
1789
non_recursive=False, from_root=False,
1790
unknown=False, versioned=False, ignored=False,
1791
null=False, kind=None, show_ids=False, path=None):
1793
if kind and kind not in ('file', 'directory', 'symlink'):
1794
raise errors.BzrCommandError('invalid kind specified')
1796
if verbose and null:
1797
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1798
all = not (unknown or versioned or ignored)
1800
selection = {'I':ignored, '?':unknown, 'V':versioned}
1807
raise errors.BzrCommandError('cannot specify both --from-root'
1811
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1817
if revision is not None:
1818
tree = branch.repository.revision_tree(
1819
revision[0].in_history(branch).rev_id)
1821
tree = branch.basis_tree()
1825
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1826
if fp.startswith(relpath):
1827
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1828
if non_recursive and '/' in fp:
1830
if not all and not selection[fc]:
1832
if kind is not None and fkind != kind:
1835
kindch = entry.kind_character()
1836
outstring = '%-8s %s%s' % (fc, fp, kindch)
1837
if show_ids and fid is not None:
1838
outstring = "%-50s %s" % (outstring, fid)
1839
self.outf.write(outstring + '\n')
1841
self.outf.write(fp + '\0')
1844
self.outf.write(fid)
1845
self.outf.write('\0')
1853
self.outf.write('%-50s %s\n' % (fp, my_id))
1855
self.outf.write(fp + '\n')
1860
class cmd_unknowns(Command):
1861
"""List unknown files.
1869
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1870
self.outf.write(osutils.quotefn(f) + '\n')
1873
class cmd_ignore(Command):
1874
"""Ignore specified files or patterns.
1876
To remove patterns from the ignore list, edit the .bzrignore file.
1878
Trailing slashes on patterns are ignored.
1879
If the pattern contains a slash or is a regular expression, it is compared
1880
to the whole path from the branch root. Otherwise, it is compared to only
1881
the last component of the path. To match a file only in the root
1882
directory, prepend './'.
1884
Ignore patterns specifying absolute paths are not allowed.
1886
Ignore patterns may include globbing wildcards such as::
1888
? - Matches any single character except '/'
1889
* - Matches 0 or more characters except '/'
1890
/**/ - Matches 0 or more directories in a path
1891
[a-z] - Matches a single character from within a group of characters
1893
Ignore patterns may also be Python regular expressions.
1894
Regular expression ignore patterns are identified by a 'RE:' prefix
1895
followed by the regular expression. Regular expression ignore patterns
1896
may not include named or numbered groups.
1898
Note: ignore patterns containing shell wildcards must be quoted from
1902
Ignore the top level Makefile::
1904
bzr ignore ./Makefile
1906
Ignore class files in all directories::
1908
bzr ignore '*.class'
1910
Ignore .o files under the lib directory::
1912
bzr ignore 'lib/**/*.o'
1914
Ignore .o files under the lib directory::
1916
bzr ignore 'RE:lib/.*\.o'
1919
_see_also = ['status', 'ignored']
1920
takes_args = ['name_pattern*']
1922
Option('old-default-rules',
1923
help='Write out the ignore rules bzr < 0.9 always used.')
1926
def run(self, name_pattern_list=None, old_default_rules=None):
1927
from bzrlib.atomicfile import AtomicFile
1928
if old_default_rules is not None:
1929
# dump the rules and exit
1930
for pattern in ignores.OLD_DEFAULTS:
1933
if not name_pattern_list:
1934
raise errors.BzrCommandError("ignore requires at least one "
1935
"NAME_PATTERN or --old-default-rules")
1936
name_pattern_list = [globbing.normalize_pattern(p)
1937
for p in name_pattern_list]
1938
for name_pattern in name_pattern_list:
1939
if (name_pattern[0] == '/' or
1940
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1941
raise errors.BzrCommandError(
1942
"NAME_PATTERN should not be an absolute path")
1943
tree, relpath = WorkingTree.open_containing(u'.')
1944
ifn = tree.abspath('.bzrignore')
1945
if os.path.exists(ifn):
1948
igns = f.read().decode('utf-8')
1954
# TODO: If the file already uses crlf-style termination, maybe
1955
# we should use that for the newly added lines?
1957
if igns and igns[-1] != '\n':
1959
for name_pattern in name_pattern_list:
1960
igns += name_pattern + '\n'
1962
f = AtomicFile(ifn, 'wb')
1964
f.write(igns.encode('utf-8'))
1969
if not tree.path2id('.bzrignore'):
1970
tree.add(['.bzrignore'])
1973
class cmd_ignored(Command):
1974
"""List ignored files and the patterns that matched them.
1977
_see_also = ['ignore']
1980
tree = WorkingTree.open_containing(u'.')[0]
1983
for path, file_class, kind, file_id, entry in tree.list_files():
1984
if file_class != 'I':
1986
## XXX: Slightly inefficient since this was already calculated
1987
pat = tree.is_ignored(path)
1988
print '%-50s %s' % (path, pat)
1993
class cmd_lookup_revision(Command):
1994
"""Lookup the revision-id from a revision-number
1997
bzr lookup-revision 33
2000
takes_args = ['revno']
2003
def run(self, revno):
2007
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2009
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2012
class cmd_export(Command):
2013
"""Export current or past revision to a destination directory or archive.
2015
If no revision is specified this exports the last committed revision.
2017
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2018
given, try to find the format with the extension. If no extension
2019
is found exports to a directory (equivalent to --format=dir).
2021
If root is supplied, it will be used as the root directory inside
2022
container formats (tar, zip, etc). If it is not supplied it will default
2023
to the exported filename. The root option has no effect for 'dir' format.
2025
If branch is omitted then the branch containing the current working
2026
directory will be used.
2028
Note: Export of tree with non-ASCII filenames to zip is not supported.
2030
================= =========================
2031
Supported formats Autodetected by extension
2032
================= =========================
2035
tbz2 .tar.bz2, .tbz2
2038
================= =========================
2040
takes_args = ['dest', 'branch?']
2043
help="Type of file to export to.",
2048
help="Name of the root directory inside the exported file."),
2050
def run(self, dest, branch=None, revision=None, format=None, root=None):
2051
from bzrlib.export import export
2054
tree = WorkingTree.open_containing(u'.')[0]
2057
b = Branch.open(branch)
2059
if revision is None:
2060
# should be tree.last_revision FIXME
2061
rev_id = b.last_revision()
2063
if len(revision) != 1:
2064
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2065
rev_id = revision[0].in_history(b).rev_id
2066
t = b.repository.revision_tree(rev_id)
2068
export(t, dest, format, root)
2069
except errors.NoSuchExportFormat, e:
2070
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2073
class cmd_cat(Command):
2074
"""Write the contents of a file as of a given revision to standard output.
2076
If no revision is nominated, the last revision is used.
2078
Note: Take care to redirect standard output when using this command on a
2084
Option('name-from-revision', help='The path name in the old tree.'),
2087
takes_args = ['filename']
2088
encoding_type = 'exact'
2091
def run(self, filename, revision=None, name_from_revision=False):
2092
if revision is not None and len(revision) != 1:
2093
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2098
tree, b, relpath = \
2099
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2100
except errors.NotBranchError:
2103
if revision is not None and revision[0].get_branch() is not None:
2104
b = Branch.open(revision[0].get_branch())
2106
tree = b.basis_tree()
2107
if revision is None:
2108
revision_id = b.last_revision()
2110
revision_id = revision[0].in_history(b).rev_id
2112
cur_file_id = tree.path2id(relpath)
2113
rev_tree = b.repository.revision_tree(revision_id)
2114
old_file_id = rev_tree.path2id(relpath)
2116
if name_from_revision:
2117
if old_file_id is None:
2118
raise errors.BzrCommandError("%r is not present in revision %s"
2119
% (filename, revision_id))
2121
rev_tree.print_file(old_file_id)
2122
elif cur_file_id is not None:
2123
rev_tree.print_file(cur_file_id)
2124
elif old_file_id is not None:
2125
rev_tree.print_file(old_file_id)
2127
raise errors.BzrCommandError("%r is not present in revision %s" %
2128
(filename, revision_id))
2131
class cmd_local_time_offset(Command):
2132
"""Show the offset in seconds from GMT to local time."""
2136
print osutils.local_time_offset()
2140
class cmd_commit(Command):
2141
"""Commit changes into a new revision.
2143
If no arguments are given, the entire tree is committed.
2145
If selected files are specified, only changes to those files are
2146
committed. If a directory is specified then the directory and everything
2147
within it is committed.
2149
A selected-file commit may fail in some cases where the committed
2150
tree would be invalid. Consider::
2155
bzr commit foo -m "committing foo"
2156
bzr mv foo/bar foo/baz
2159
bzr commit foo/bar -m "committing bar but not baz"
2161
In the example above, the last commit will fail by design. This gives
2162
the user the opportunity to decide whether they want to commit the
2163
rename at the same time, separately first, or not at all. (As a general
2164
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2166
Note: A selected-file commit after a merge is not yet supported.
2168
# TODO: Run hooks on tree to-be-committed, and after commit.
2170
# TODO: Strict commit that fails if there are deleted files.
2171
# (what does "deleted files" mean ??)
2173
# TODO: Give better message for -s, --summary, used by tla people
2175
# XXX: verbose currently does nothing
2177
_see_also = ['bugs', 'uncommit']
2178
takes_args = ['selected*']
2180
Option('message', type=unicode,
2182
help="Description of the new revision."),
2185
help='Commit even if nothing has changed.'),
2186
Option('file', type=str,
2189
help='Take commit message from this file.'),
2191
help="Refuse to commit if there are unknown "
2192
"files in the working tree."),
2193
ListOption('fixes', type=str,
2194
help="Mark a bug as being fixed by this revision."),
2196
help="Perform a local commit in a bound "
2197
"branch. Local commits are not pushed to "
2198
"the master branch until a normal commit "
2202
aliases = ['ci', 'checkin']
2204
def _get_bug_fix_properties(self, fixes, branch):
2206
# Configure the properties for bug fixing attributes.
2207
for fixed_bug in fixes:
2208
tokens = fixed_bug.split(':')
2209
if len(tokens) != 2:
2210
raise errors.BzrCommandError(
2211
"Invalid bug %s. Must be in the form of 'tag:id'. "
2212
"Commit refused." % fixed_bug)
2213
tag, bug_id = tokens
2215
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2216
except errors.UnknownBugTrackerAbbreviation:
2217
raise errors.BzrCommandError(
2218
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2219
except errors.MalformedBugIdentifier:
2220
raise errors.BzrCommandError(
2221
"Invalid bug identifier for %s. Commit refused."
2223
properties.append('%s fixed' % bug_url)
2224
return '\n'.join(properties)
2226
def run(self, message=None, file=None, verbose=True, selected_list=None,
2227
unchanged=False, strict=False, local=False, fixes=None):
2228
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2229
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2231
from bzrlib.msgeditor import edit_commit_message, \
2232
make_commit_message_template
2234
# TODO: Need a blackbox test for invoking the external editor; may be
2235
# slightly problematic to run this cross-platform.
2237
# TODO: do more checks that the commit will succeed before
2238
# spending the user's valuable time typing a commit message.
2242
tree, selected_list = tree_files(selected_list)
2243
if selected_list == ['']:
2244
# workaround - commit of root of tree should be exactly the same
2245
# as just default commit in that tree, and succeed even though
2246
# selected-file merge commit is not done yet
2249
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2251
properties['bugs'] = bug_property
2253
if local and not tree.branch.get_bound_location():
2254
raise errors.LocalRequiresBoundBranch()
2256
def get_message(commit_obj):
2257
"""Callback to get commit message"""
2258
my_message = message
2259
if my_message is None and not file:
2260
template = make_commit_message_template(tree, selected_list)
2261
my_message = edit_commit_message(template)
2262
if my_message is None:
2263
raise errors.BzrCommandError("please specify a commit"
2264
" message with either --message or --file")
2265
elif my_message and file:
2266
raise errors.BzrCommandError(
2267
"please specify either --message or --file")
2269
my_message = codecs.open(file, 'rt',
2270
bzrlib.user_encoding).read()
2271
if my_message == "":
2272
raise errors.BzrCommandError("empty commit message specified")
2276
reporter = ReportCommitToLog()
2278
reporter = NullCommitReporter()
2281
tree.commit(message_callback=get_message,
2282
specific_files=selected_list,
2283
allow_pointless=unchanged, strict=strict, local=local,
2284
reporter=reporter, revprops=properties)
2285
except PointlessCommit:
2286
# FIXME: This should really happen before the file is read in;
2287
# perhaps prepare the commit; get the message; then actually commit
2288
raise errors.BzrCommandError("no changes to commit."
2289
" use --unchanged to commit anyhow")
2290
except ConflictsInTree:
2291
raise errors.BzrCommandError('Conflicts detected in working '
2292
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2294
except StrictCommitFailed:
2295
raise errors.BzrCommandError("Commit refused because there are"
2296
" unknown files in the working tree.")
2297
except errors.BoundBranchOutOfDate, e:
2298
raise errors.BzrCommandError(str(e) + "\n"
2299
'To commit to master branch, run update and then commit.\n'
2300
'You can also pass --local to commit to continue working '
2304
class cmd_check(Command):
2305
"""Validate consistency of branch history.
2307
This command checks various invariants about the branch storage to
2308
detect data corruption or bzr bugs.
2311
_see_also = ['reconcile']
2312
takes_args = ['branch?']
2313
takes_options = ['verbose']
2315
def run(self, branch=None, verbose=False):
2316
from bzrlib.check import check
2318
tree = WorkingTree.open_containing()[0]
2319
branch = tree.branch
2321
branch = Branch.open(branch)
2322
check(branch, verbose)
2325
class cmd_upgrade(Command):
2326
"""Upgrade branch storage to current format.
2328
The check command or bzr developers may sometimes advise you to run
2329
this command. When the default format has changed you may also be warned
2330
during other operations to upgrade.
2333
_see_also = ['check']
2334
takes_args = ['url?']
2336
RegistryOption('format',
2337
help='Upgrade to a specific format. See "bzr help'
2338
' formats" for details.',
2339
registry=bzrdir.format_registry,
2340
converter=bzrdir.format_registry.make_bzrdir,
2341
value_switches=True, title='Branch format'),
2344
def run(self, url='.', format=None):
2345
from bzrlib.upgrade import upgrade
2347
format = bzrdir.format_registry.make_bzrdir('default')
2348
upgrade(url, format)
2351
class cmd_whoami(Command):
2352
"""Show or set bzr user id.
2355
Show the email of the current user::
2359
Set the current user::
2361
bzr whoami 'Frank Chu <fchu@example.com>'
2363
takes_options = [ Option('email',
2364
help='Display email address only.'),
2366
help='Set identity for the current branch instead of '
2369
takes_args = ['name?']
2370
encoding_type = 'replace'
2373
def run(self, email=False, branch=False, name=None):
2375
# use branch if we're inside one; otherwise global config
2377
c = Branch.open_containing('.')[0].get_config()
2378
except errors.NotBranchError:
2379
c = config.GlobalConfig()
2381
self.outf.write(c.user_email() + '\n')
2383
self.outf.write(c.username() + '\n')
2386
# display a warning if an email address isn't included in the given name.
2388
config.extract_email_address(name)
2389
except errors.NoEmailInUsername, e:
2390
warning('"%s" does not seem to contain an email address. '
2391
'This is allowed, but not recommended.', name)
2393
# use global config unless --branch given
2395
c = Branch.open_containing('.')[0].get_config()
2397
c = config.GlobalConfig()
2398
c.set_user_option('email', name)
2401
class cmd_nick(Command):
2402
"""Print or set the branch nickname.
2404
If unset, the tree root directory name is used as the nickname
2405
To print the current nickname, execute with no argument.
2408
_see_also = ['info']
2409
takes_args = ['nickname?']
2410
def run(self, nickname=None):
2411
branch = Branch.open_containing(u'.')[0]
2412
if nickname is None:
2413
self.printme(branch)
2415
branch.nick = nickname
2418
def printme(self, branch):
2422
class cmd_selftest(Command):
2423
"""Run internal test suite.
2425
If arguments are given, they are regular expressions that say which tests
2426
should run. Tests matching any expression are run, and other tests are
2429
Alternatively if --first is given, matching tests are run first and then
2430
all other tests are run. This is useful if you have been working in a
2431
particular area, but want to make sure nothing else was broken.
2433
If --exclude is given, tests that match that regular expression are
2434
excluded, regardless of whether they match --first or not.
2436
To help catch accidential dependencies between tests, the --randomize
2437
option is useful. In most cases, the argument used is the word 'now'.
2438
Note that the seed used for the random number generator is displayed
2439
when this option is used. The seed can be explicitly passed as the
2440
argument to this option if required. This enables reproduction of the
2441
actual ordering used if and when an order sensitive problem is encountered.
2443
If --list-only is given, the tests that would be run are listed. This is
2444
useful when combined with --first, --exclude and/or --randomize to
2445
understand their impact. The test harness reports "Listed nn tests in ..."
2446
instead of "Ran nn tests in ..." when list mode is enabled.
2448
If the global option '--no-plugins' is given, plugins are not loaded
2449
before running the selftests. This has two effects: features provided or
2450
modified by plugins will not be tested, and tests provided by plugins will
2453
Tests that need working space on disk use a common temporary directory,
2454
typically inside $TMPDIR or /tmp.
2457
Run only tests relating to 'ignore'::
2461
Disable plugins and list tests as they're run::
2463
bzr --no-plugins selftest -v
2465
# NB: this is used from the class without creating an instance, which is
2466
# why it does not have a self parameter.
2467
def get_transport_type(typestring):
2468
"""Parse and return a transport specifier."""
2469
if typestring == "sftp":
2470
from bzrlib.transport.sftp import SFTPAbsoluteServer
2471
return SFTPAbsoluteServer
2472
if typestring == "memory":
2473
from bzrlib.transport.memory import MemoryServer
2475
if typestring == "fakenfs":
2476
from bzrlib.transport.fakenfs import FakeNFSServer
2477
return FakeNFSServer
2478
msg = "No known transport type %s. Supported types are: sftp\n" %\
2480
raise errors.BzrCommandError(msg)
2483
takes_args = ['testspecs*']
2484
takes_options = ['verbose',
2486
help='Stop when one test fails.',
2490
help='Use a different transport by default '
2491
'throughout the test suite.',
2492
type=get_transport_type),
2494
help='Run the benchmarks rather than selftests.'),
2495
Option('lsprof-timed',
2496
help='Generate lsprof output for benchmarked'
2497
' sections of code.'),
2498
Option('cache-dir', type=str,
2499
help='Cache intermediate benchmark output in this '
2502
help='Run all tests, but run specified tests first.',
2506
help='List the tests instead of running them.'),
2507
Option('randomize', type=str, argname="SEED",
2508
help='Randomize the order of tests using the given'
2509
' seed or "now" for the current time.'),
2510
Option('exclude', type=str, argname="PATTERN",
2512
help='Exclude tests that match this regular'
2514
Option('strict', help='Fail on missing dependencies or '
2517
encoding_type = 'replace'
2519
def run(self, testspecs_list=None, verbose=None, one=False,
2520
transport=None, benchmark=None,
2521
lsprof_timed=None, cache_dir=None,
2522
first=False, list_only=False,
2523
randomize=None, exclude=None, strict=False):
2525
from bzrlib.tests import selftest
2526
import bzrlib.benchmarks as benchmarks
2527
from bzrlib.benchmarks import tree_creator
2528
from bzrlib.version import show_version
2530
if cache_dir is not None:
2531
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2533
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2534
print ' %s (%s python%s)' % (
2536
bzrlib.version_string,
2537
'.'.join(map(str, sys.version_info)),
2540
if testspecs_list is not None:
2541
pattern = '|'.join(testspecs_list)
2545
test_suite_factory = benchmarks.test_suite
2548
# TODO: should possibly lock the history file...
2549
benchfile = open(".perf_history", "at", buffering=1)
2551
test_suite_factory = None
2556
result = selftest(verbose=verbose,
2558
stop_on_failure=one,
2559
transport=transport,
2560
test_suite_factory=test_suite_factory,
2561
lsprof_timed=lsprof_timed,
2562
bench_history=benchfile,
2563
matching_tests_first=first,
2564
list_only=list_only,
2565
random_seed=randomize,
2566
exclude_pattern=exclude,
2570
if benchfile is not None:
2573
info('tests passed')
2575
info('tests failed')
2576
return int(not result)
2579
class cmd_version(Command):
2580
"""Show version of bzr."""
2584
from bzrlib.version import show_version
2588
class cmd_rocks(Command):
2589
"""Statement of optimism."""
2595
print "It sure does!"
2598
class cmd_find_merge_base(Command):
2599
"""Find and print a base revision for merging two branches."""
2600
# TODO: Options to specify revisions on either side, as if
2601
# merging only part of the history.
2602
takes_args = ['branch', 'other']
2606
def run(self, branch, other):
2607
from bzrlib.revision import ensure_null, MultipleRevisionSources
2609
branch1 = Branch.open_containing(branch)[0]
2610
branch2 = Branch.open_containing(other)[0]
2612
last1 = ensure_null(branch1.last_revision())
2613
last2 = ensure_null(branch2.last_revision())
2615
graph = branch1.repository.get_graph(branch2.repository)
2616
base_rev_id = graph.find_unique_lca(last1, last2)
2618
print 'merge base is revision %s' % base_rev_id
2621
class cmd_merge(Command):
2622
"""Perform a three-way merge.
2624
The branch is the branch you will merge from. By default, it will merge
2625
the latest revision. If you specify a revision, that revision will be
2626
merged. If you specify two revisions, the first will be used as a BASE,
2627
and the second one as OTHER. Revision numbers are always relative to the
2630
By default, bzr will try to merge in all new work from the other
2631
branch, automatically determining an appropriate base. If this
2632
fails, you may need to give an explicit base.
2634
Merge will do its best to combine the changes in two branches, but there
2635
are some kinds of problems only a human can fix. When it encounters those,
2636
it will mark a conflict. A conflict means that you need to fix something,
2637
before you should commit.
2639
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2641
If there is no default branch set, the first merge will set it. After
2642
that, you can omit the branch to use the default. To change the
2643
default, use --remember. The value will only be saved if the remote
2644
location can be accessed.
2646
The results of the merge are placed into the destination working
2647
directory, where they can be reviewed (with bzr diff), tested, and then
2648
committed to record the result of the merge.
2650
merge refuses to run if there are any uncommitted changes, unless
2654
To merge the latest revision from bzr.dev::
2656
bzr merge ../bzr.dev
2658
To merge changes up to and including revision 82 from bzr.dev::
2660
bzr merge -r 82 ../bzr.dev
2662
To merge the changes introduced by 82, without previous changes::
2664
bzr merge -r 81..82 ../bzr.dev
2667
_see_also = ['update', 'remerge', 'status-flags']
2668
takes_args = ['branch?']
2672
help='Merge even if the destination tree has uncommitted changes.'),
2676
Option('show-base', help="Show base revision text in "
2678
Option('uncommitted', help='Apply uncommitted changes'
2679
' from a working copy, instead of branch changes.'),
2680
Option('pull', help='If the destination is already'
2681
' completely merged into the source, pull from the'
2682
' source rather than merging. When this happens,'
2683
' you do not need to commit the result.'),
2685
help='Branch to merge into, '
2686
'rather than the one containing the working directory.',
2692
def run(self, branch=None, revision=None, force=False, merge_type=None,
2693
show_base=False, reprocess=False, remember=False,
2694
uncommitted=False, pull=False,
2697
from bzrlib.tag import _merge_tags_if_possible
2698
# This is actually a branch (or merge-directive) *location*.
2702
if merge_type is None:
2703
merge_type = _mod_merge.Merge3Merger
2705
if directory is None: directory = u'.'
2706
possible_transports = []
2708
allow_pending = True
2709
verified = 'inapplicable'
2710
tree = WorkingTree.open_containing(directory)[0]
2711
change_reporter = delta._ChangeReporter(
2712
unversioned_filter=tree.is_ignored)
2715
pb = ui.ui_factory.nested_progress_bar()
2716
cleanups.append(pb.finished)
2718
cleanups.append(tree.unlock)
2719
if location is not None:
2720
mergeable, other_transport = _get_mergeable_helper(location)
2723
raise errors.BzrCommandError('Cannot use --uncommitted'
2724
' with bundles or merge directives.')
2726
if revision is not None:
2727
raise errors.BzrCommandError(
2728
'Cannot use -r with merge directives or bundles')
2729
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2731
possible_transports.append(other_transport)
2733
if merger is None and uncommitted:
2734
if revision is not None and len(revision) > 0:
2735
raise errors.BzrCommandError('Cannot use --uncommitted and'
2736
' --revision at the same time.')
2737
location = self._select_branch_location(tree, location)[0]
2738
other_tree, other_path = WorkingTree.open_containing(location)
2739
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2741
allow_pending = False
2744
merger, allow_pending = self._get_merger_from_branch(tree,
2745
location, revision, remember, possible_transports, pb)
2747
merger.merge_type = merge_type
2748
merger.reprocess = reprocess
2749
merger.show_base = show_base
2750
merger.change_reporter = change_reporter
2751
self.sanity_check_merger(merger)
2752
if (merger.base_rev_id == merger.other_rev_id and
2753
merger.other_rev_id != None):
2754
note('Nothing to do.')
2757
if merger.interesting_files is not None:
2758
raise BzrCommandError('Cannot pull individual files')
2759
if (merger.base_rev_id == tree.last_revision()):
2760
result = tree.pull(merger.other_branch, False,
2761
merger.other_rev_id)
2762
result.report(self.outf)
2764
merger.check_basis(not force)
2765
conflict_count = merger.do_merge()
2767
merger.set_pending()
2768
if verified == 'failed':
2769
warning('Preview patch does not match changes')
2770
if conflict_count != 0:
2775
for cleanup in reversed(cleanups):
2778
def sanity_check_merger(self, merger):
2779
if (merger.show_base and
2780
not merger.merge_type is _mod_merge.Merge3Merger):
2781
raise errors.BzrCommandError("Show-base is not supported for this"
2782
" merge type. %s" % merger.merge_type)
2783
if merger.reprocess and not merger.merge_type.supports_reprocess:
2784
raise errors.BzrCommandError("Conflict reduction is not supported"
2785
" for merge type %s." %
2787
if merger.reprocess and merger.show_base:
2788
raise errors.BzrCommandError("Cannot do conflict reduction and"
2791
def _get_merger_from_branch(self, tree, location, revision, remember,
2792
possible_transports, pb):
2793
"""Produce a merger from a location, assuming it refers to a branch."""
2794
from bzrlib.tag import _merge_tags_if_possible
2795
assert revision is None or len(revision) < 3
2796
# find the branch locations
2797
other_loc, location = self._select_branch_location(tree, location,
2799
if revision is not None and len(revision) == 2:
2800
base_loc, location = self._select_branch_location(tree, location,
2803
base_loc = other_loc
2805
other_branch, other_path = Branch.open_containing(other_loc,
2806
possible_transports)
2807
if base_loc == other_loc:
2808
base_branch = other_branch
2810
base_branch, base_path = Branch.open_containing(base_loc,
2811
possible_transports)
2812
# Find the revision ids
2813
if revision is None or len(revision) < 1 or revision[-1] is None:
2814
other_revision_id = _mod_revision.ensure_null(
2815
other_branch.last_revision())
2817
other_revision_id = \
2818
_mod_revision.ensure_null(
2819
revision[-1].in_history(other_branch).rev_id)
2820
if (revision is not None and len(revision) == 2
2821
and revision[0] is not None):
2822
base_revision_id = \
2823
_mod_revision.ensure_null(
2824
revision[0].in_history(base_branch).rev_id)
2826
base_revision_id = None
2827
# Remember where we merge from
2828
if ((tree.branch.get_parent() is None or remember) and
2829
other_branch is not None):
2830
tree.branch.set_parent(other_branch.base)
2831
_merge_tags_if_possible(other_branch, tree.branch)
2832
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2833
other_revision_id, base_revision_id, other_branch, base_branch)
2834
if other_path != '':
2835
allow_pending = False
2836
merger.interesting_files = [other_path]
2838
allow_pending = True
2839
return merger, allow_pending
2841
def _select_branch_location(self, tree, location, revision=None,
2843
"""Select a branch location, according to possible inputs.
2845
If provided, branches from ``revision`` are preferred. (Both
2846
``revision`` and ``index`` must be supplied.)
2848
Otherwise, the ``location`` parameter is used. If it is None, then the
2849
``parent`` location is used, and a note is printed.
2851
:param tree: The working tree to select a branch for merging into
2852
:param location: The location entered by the user
2853
:param revision: The revision parameter to the command
2854
:param index: The index to use for the revision parameter. Negative
2855
indices are permitted.
2856
:return: (selected_location, default_location). The default location
2857
will be the user-entered location, if any, or else the remembered
2860
if (revision is not None and index is not None
2861
and revision[index] is not None):
2862
branch = revision[index].get_branch()
2863
if branch is not None:
2864
return branch, location
2865
location = self._get_remembered_parent(tree, location, 'Merging from')
2866
return location, location
2868
# TODO: move up to common parent; this isn't merge-specific anymore.
2869
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2870
"""Use tree.branch's parent if none was supplied.
2872
Report if the remembered location was used.
2874
if supplied_location is not None:
2875
return supplied_location
2876
stored_location = tree.branch.get_parent()
2877
mutter("%s", stored_location)
2878
if stored_location is None:
2879
raise errors.BzrCommandError("No location specified or remembered")
2880
display_url = urlutils.unescape_for_display(stored_location,
2882
self.outf.write("%s remembered location %s\n" % (verb_string,
2884
return stored_location
2887
class cmd_remerge(Command):
2890
Use this if you want to try a different merge technique while resolving
2891
conflicts. Some merge techniques are better than others, and remerge
2892
lets you try different ones on different files.
2894
The options for remerge have the same meaning and defaults as the ones for
2895
merge. The difference is that remerge can (only) be run when there is a
2896
pending merge, and it lets you specify particular files.
2899
Re-do the merge of all conflicted files, and show the base text in
2900
conflict regions, in addition to the usual THIS and OTHER texts::
2902
bzr remerge --show-base
2904
Re-do the merge of "foobar", using the weave merge algorithm, with
2905
additional processing to reduce the size of conflict regions::
2907
bzr remerge --merge-type weave --reprocess foobar
2909
takes_args = ['file*']
2914
help="Show base revision text in conflicts."),
2917
def run(self, file_list=None, merge_type=None, show_base=False,
2919
if merge_type is None:
2920
merge_type = _mod_merge.Merge3Merger
2921
tree, file_list = tree_files(file_list)
2924
parents = tree.get_parent_ids()
2925
if len(parents) != 2:
2926
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2927
" merges. Not cherrypicking or"
2929
repository = tree.branch.repository
2930
graph = repository.get_graph()
2931
base_revision = graph.find_unique_lca(parents[0], parents[1])
2932
base_tree = repository.revision_tree(base_revision)
2933
other_tree = repository.revision_tree(parents[1])
2934
interesting_ids = None
2936
conflicts = tree.conflicts()
2937
if file_list is not None:
2938
interesting_ids = set()
2939
for filename in file_list:
2940
file_id = tree.path2id(filename)
2942
raise errors.NotVersionedError(filename)
2943
interesting_ids.add(file_id)
2944
if tree.kind(file_id) != "directory":
2947
for name, ie in tree.inventory.iter_entries(file_id):
2948
interesting_ids.add(ie.file_id)
2949
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2951
# Remerge only supports resolving contents conflicts
2952
allowed_conflicts = ('text conflict', 'contents conflict')
2953
restore_files = [c.path for c in conflicts
2954
if c.typestring in allowed_conflicts]
2955
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2956
tree.set_conflicts(ConflictList(new_conflicts))
2957
if file_list is not None:
2958
restore_files = file_list
2959
for filename in restore_files:
2961
restore(tree.abspath(filename))
2962
except errors.NotConflicted:
2964
# Disable pending merges, because the file texts we are remerging
2965
# have not had those merges performed. If we use the wrong parents
2966
# list, we imply that the working tree text has seen and rejected
2967
# all the changes from the other tree, when in fact those changes
2968
# have not yet been seen.
2969
tree.set_parent_ids(parents[:1])
2971
conflicts = _mod_merge.merge_inner(
2972
tree.branch, other_tree, base_tree,
2974
interesting_ids=interesting_ids,
2975
other_rev_id=parents[1],
2976
merge_type=merge_type,
2977
show_base=show_base,
2978
reprocess=reprocess)
2980
tree.set_parent_ids(parents)
2989
class cmd_revert(Command):
2990
"""Revert files to a previous revision.
2992
Giving a list of files will revert only those files. Otherwise, all files
2993
will be reverted. If the revision is not specified with '--revision', the
2994
last committed revision is used.
2996
To remove only some changes, without reverting to a prior version, use
2997
merge instead. For example, "merge . --r-2..-3" will remove the changes
2998
introduced by -2, without affecting the changes introduced by -1. Or
2999
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3001
By default, any files that have been manually changed will be backed up
3002
first. (Files changed only by merge are not backed up.) Backup files have
3003
'.~#~' appended to their name, where # is a number.
3005
When you provide files, you can use their current pathname or the pathname
3006
from the target revision. So you can use revert to "undelete" a file by
3007
name. If you name a directory, all the contents of that directory will be
3011
_see_also = ['cat', 'export']
3014
Option('no-backup', "Do not save backups of reverted files."),
3016
takes_args = ['file*']
3018
def run(self, revision=None, no_backup=False, file_list=None):
3019
if file_list is not None:
3020
if len(file_list) == 0:
3021
raise errors.BzrCommandError("No files specified")
3025
tree, file_list = tree_files(file_list)
3026
if revision is None:
3027
# FIXME should be tree.last_revision
3028
rev_id = tree.last_revision()
3029
elif len(revision) != 1:
3030
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3032
rev_id = revision[0].in_history(tree.branch).rev_id
3033
pb = ui.ui_factory.nested_progress_bar()
3035
tree.revert(file_list,
3036
tree.branch.repository.revision_tree(rev_id),
3037
not no_backup, pb, report_changes=True)
3042
class cmd_assert_fail(Command):
3043
"""Test reporting of assertion failures"""
3044
# intended just for use in testing
3049
raise AssertionError("always fails")
3052
class cmd_help(Command):
3053
"""Show help on a command or other topic.
3056
_see_also = ['topics']
3058
Option('long', 'Show help on all commands.'),
3060
takes_args = ['topic?']
3061
aliases = ['?', '--help', '-?', '-h']
3064
def run(self, topic=None, long=False):
3066
if topic is None and long:
3068
bzrlib.help.help(topic)
3071
class cmd_shell_complete(Command):
3072
"""Show appropriate completions for context.
3074
For a list of all available commands, say 'bzr shell-complete'.
3076
takes_args = ['context?']
3081
def run(self, context=None):
3082
import shellcomplete
3083
shellcomplete.shellcomplete(context)
3086
class cmd_fetch(Command):
3087
"""Copy in history from another branch but don't merge it.
3089
This is an internal method used for pull and merge.
3092
takes_args = ['from_branch', 'to_branch']
3093
def run(self, from_branch, to_branch):
3094
from bzrlib.fetch import Fetcher
3095
from_b = Branch.open(from_branch)
3096
to_b = Branch.open(to_branch)
3097
Fetcher(to_b, from_b)
3100
class cmd_missing(Command):
3101
"""Show unmerged/unpulled revisions between two branches.
3103
OTHER_BRANCH may be local or remote.
3106
_see_also = ['merge', 'pull']
3107
takes_args = ['other_branch?']
3109
Option('reverse', 'Reverse the order of revisions.'),
3111
'Display changes in the local branch only.'),
3112
Option('this' , 'Same as --mine-only.'),
3113
Option('theirs-only',
3114
'Display changes in the remote branch only.'),
3115
Option('other', 'Same as --theirs-only.'),
3120
encoding_type = 'replace'
3123
def run(self, other_branch=None, reverse=False, mine_only=False,
3124
theirs_only=False, log_format=None, long=False, short=False, line=False,
3125
show_ids=False, verbose=False, this=False, other=False):
3126
from bzrlib.missing import find_unmerged, iter_log_revisions
3127
from bzrlib.log import log_formatter
3134
local_branch = Branch.open_containing(u".")[0]
3135
parent = local_branch.get_parent()
3136
if other_branch is None:
3137
other_branch = parent
3138
if other_branch is None:
3139
raise errors.BzrCommandError("No peer location known"
3141
display_url = urlutils.unescape_for_display(parent,
3143
self.outf.write("Using last location: " + display_url + "\n")
3145
remote_branch = Branch.open(other_branch)
3146
if remote_branch.base == local_branch.base:
3147
remote_branch = local_branch
3148
local_branch.lock_read()
3150
remote_branch.lock_read()
3152
local_extra, remote_extra = find_unmerged(local_branch,
3154
if log_format is None:
3155
registry = log.log_formatter_registry
3156
log_format = registry.get_default(local_branch)
3157
lf = log_format(to_file=self.outf,
3159
show_timezone='original')
3160
if reverse is False:
3161
local_extra.reverse()
3162
remote_extra.reverse()
3163
if local_extra and not theirs_only:
3164
self.outf.write("You have %d extra revision(s):\n" %
3166
for revision in iter_log_revisions(local_extra,
3167
local_branch.repository,
3169
lf.log_revision(revision)
3170
printed_local = True
3172
printed_local = False
3173
if remote_extra and not mine_only:
3174
if printed_local is True:
3175
self.outf.write("\n\n\n")
3176
self.outf.write("You are missing %d revision(s):\n" %
3178
for revision in iter_log_revisions(remote_extra,
3179
remote_branch.repository,
3181
lf.log_revision(revision)
3182
if not remote_extra and not local_extra:
3184
self.outf.write("Branches are up to date.\n")
3188
remote_branch.unlock()
3190
local_branch.unlock()
3191
if not status_code and parent is None and other_branch is not None:
3192
local_branch.lock_write()
3194
# handle race conditions - a parent might be set while we run.
3195
if local_branch.get_parent() is None:
3196
local_branch.set_parent(remote_branch.base)
3198
local_branch.unlock()
3202
class cmd_pack(Command):
3203
"""Compress the data within a repository."""
3205
_see_also = ['repositories']
3206
takes_args = ['branch_or_repo?']
3208
def run(self, branch_or_repo='.'):
3209
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3211
branch = dir.open_branch()
3212
repository = branch.repository
3213
except errors.NotBranchError:
3214
repository = dir.open_repository()
3218
class cmd_plugins(Command):
3219
"""List the installed plugins.
3221
This command displays the list of installed plugins including the
3222
path where each one is located and a short description of each.
3224
A plugin is an external component for Bazaar that extends the
3225
revision control system, by adding or replacing code in Bazaar.
3226
Plugins can do a variety of things, including overriding commands,
3227
adding new commands, providing additional network transports and
3228
customizing log output.
3230
See the Bazaar web site, http://bazaar-vcs.org, for further
3231
information on plugins including where to find them and how to
3232
install them. Instructions are also provided there on how to
3233
write new plugins using the Python programming language.
3238
import bzrlib.plugin
3239
from inspect import getdoc
3240
for name, plugin in bzrlib.plugin.all_plugins().items():
3241
if getattr(plugin, '__path__', None) is not None:
3242
print plugin.__path__[0]
3243
elif getattr(plugin, '__file__', None) is not None:
3244
print plugin.__file__
3250
print '\t', d.split('\n')[0]
3253
class cmd_testament(Command):
3254
"""Show testament (signing-form) of a revision."""
3257
Option('long', help='Produce long-format testament.'),
3259
help='Produce a strict-format testament.')]
3260
takes_args = ['branch?']
3262
def run(self, branch=u'.', revision=None, long=False, strict=False):
3263
from bzrlib.testament import Testament, StrictTestament
3265
testament_class = StrictTestament
3267
testament_class = Testament
3268
b = WorkingTree.open_containing(branch)[0].branch
3271
if revision is None:
3272
rev_id = b.last_revision()
3274
rev_id = revision[0].in_history(b).rev_id
3275
t = testament_class.from_revision(b.repository, rev_id)
3277
sys.stdout.writelines(t.as_text_lines())
3279
sys.stdout.write(t.as_short_text())
3284
class cmd_annotate(Command):
3285
"""Show the origin of each line in a file.
3287
This prints out the given file with an annotation on the left side
3288
indicating which revision, author and date introduced the change.
3290
If the origin is the same for a run of consecutive lines, it is
3291
shown only at the top, unless the --all option is given.
3293
# TODO: annotate directories; showing when each file was last changed
3294
# TODO: if the working copy is modified, show annotations on that
3295
# with new uncommitted lines marked
3296
aliases = ['ann', 'blame', 'praise']
3297
takes_args = ['filename']
3298
takes_options = [Option('all', help='Show annotations on all lines.'),
3299
Option('long', help='Show commit date in annotations.'),
3303
encoding_type = 'exact'
3306
def run(self, filename, all=False, long=False, revision=None,
3308
from bzrlib.annotate import annotate_file
3309
tree, relpath = WorkingTree.open_containing(filename)
3310
branch = tree.branch
3313
if revision is None:
3314
revision_id = branch.last_revision()
3315
elif len(revision) != 1:
3316
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3318
revision_id = revision[0].in_history(branch).rev_id
3319
file_id = tree.path2id(relpath)
3321
raise errors.NotVersionedError(filename)
3322
tree = branch.repository.revision_tree(revision_id)
3323
file_version = tree.inventory[file_id].revision
3324
annotate_file(branch, file_version, file_id, long, all, self.outf,
3330
class cmd_re_sign(Command):
3331
"""Create a digital signature for an existing revision."""
3332
# TODO be able to replace existing ones.
3334
hidden = True # is this right ?
3335
takes_args = ['revision_id*']
3336
takes_options = ['revision']
3338
def run(self, revision_id_list=None, revision=None):
3339
import bzrlib.gpg as gpg
3340
if revision_id_list is not None and revision is not None:
3341
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3342
if revision_id_list is None and revision is None:
3343
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3344
b = WorkingTree.open_containing(u'.')[0].branch
3345
gpg_strategy = gpg.GPGStrategy(b.get_config())
3346
if revision_id_list is not None:
3347
for revision_id in revision_id_list:
3348
b.repository.sign_revision(revision_id, gpg_strategy)
3349
elif revision is not None:
3350
if len(revision) == 1:
3351
revno, rev_id = revision[0].in_history(b)
3352
b.repository.sign_revision(rev_id, gpg_strategy)
3353
elif len(revision) == 2:
3354
# are they both on rh- if so we can walk between them
3355
# might be nice to have a range helper for arbitrary
3356
# revision paths. hmm.
3357
from_revno, from_revid = revision[0].in_history(b)
3358
to_revno, to_revid = revision[1].in_history(b)
3359
if to_revid is None:
3360
to_revno = b.revno()
3361
if from_revno is None or to_revno is None:
3362
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3363
for revno in range(from_revno, to_revno + 1):
3364
b.repository.sign_revision(b.get_rev_id(revno),
3367
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3370
class cmd_bind(Command):
3371
"""Convert the current branch into a checkout of the supplied branch.
3373
Once converted into a checkout, commits must succeed on the master branch
3374
before they will be applied to the local branch.
3377
_see_also = ['checkouts', 'unbind']
3378
takes_args = ['location?']
3381
def run(self, location=None):
3382
b, relpath = Branch.open_containing(u'.')
3383
if location is None:
3385
location = b.get_old_bound_location()
3386
except errors.UpgradeRequired:
3387
raise errors.BzrCommandError('No location supplied. '
3388
'This format does not remember old locations.')
3390
if location is None:
3391
raise errors.BzrCommandError('No location supplied and no '
3392
'previous location known')
3393
b_other = Branch.open(location)
3396
except errors.DivergedBranches:
3397
raise errors.BzrCommandError('These branches have diverged.'
3398
' Try merging, and then bind again.')
3401
class cmd_unbind(Command):
3402
"""Convert the current checkout into a regular branch.
3404
After unbinding, the local branch is considered independent and subsequent
3405
commits will be local only.
3408
_see_also = ['checkouts', 'bind']
3413
b, relpath = Branch.open_containing(u'.')
3415
raise errors.BzrCommandError('Local branch is not bound')
3418
class cmd_uncommit(Command):
3419
"""Remove the last committed revision.
3421
--verbose will print out what is being removed.
3422
--dry-run will go through all the motions, but not actually
3425
In the future, uncommit will create a revision bundle, which can then
3429
# TODO: jam 20060108 Add an option to allow uncommit to remove
3430
# unreferenced information in 'branch-as-repository' branches.
3431
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3432
# information in shared branches as well.
3433
_see_also = ['commit']
3434
takes_options = ['verbose', 'revision',
3435
Option('dry-run', help='Don\'t actually make changes.'),
3436
Option('force', help='Say yes to all questions.')]
3437
takes_args = ['location?']
3440
def run(self, location=None,
3441
dry_run=False, verbose=False,
3442
revision=None, force=False):
3443
from bzrlib.log import log_formatter, show_log
3445
from bzrlib.uncommit import uncommit
3447
if location is None:
3449
control, relpath = bzrdir.BzrDir.open_containing(location)
3451
tree = control.open_workingtree()
3453
except (errors.NoWorkingTree, errors.NotLocalUrl):
3455
b = control.open_branch()
3458
if revision is None:
3461
# 'bzr uncommit -r 10' actually means uncommit
3462
# so that the final tree is at revno 10.
3463
# but bzrlib.uncommit.uncommit() actually uncommits
3464
# the revisions that are supplied.
3465
# So we need to offset it by one
3466
revno = revision[0].in_history(b).revno+1
3468
if revno <= b.revno():
3469
rev_id = b.get_rev_id(revno)
3471
self.outf.write('No revisions to uncommit.\n')
3474
lf = log_formatter('short',
3476
show_timezone='original')
3481
direction='forward',
3482
start_revision=revno,
3483
end_revision=b.revno())
3486
print 'Dry-run, pretending to remove the above revisions.'
3488
val = raw_input('Press <enter> to continue')
3490
print 'The above revision(s) will be removed.'
3492
val = raw_input('Are you sure [y/N]? ')
3493
if val.lower() not in ('y', 'yes'):
3497
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3501
class cmd_break_lock(Command):
3502
"""Break a dead lock on a repository, branch or working directory.
3504
CAUTION: Locks should only be broken when you are sure that the process
3505
holding the lock has been stopped.
3507
You can get information on what locks are open via the 'bzr info' command.
3512
takes_args = ['location?']
3514
def run(self, location=None, show=False):
3515
if location is None:
3517
control, relpath = bzrdir.BzrDir.open_containing(location)
3519
control.break_lock()
3520
except NotImplementedError:
3524
class cmd_wait_until_signalled(Command):
3525
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3527
This just prints a line to signal when it is ready, then blocks on stdin.
3533
sys.stdout.write("running\n")
3535
sys.stdin.readline()
3538
class cmd_serve(Command):
3539
"""Run the bzr server."""
3541
aliases = ['server']
3545
help='Serve on stdin/out for use from inetd or sshd.'),
3547
help='Listen for connections on nominated port of the form '
3548
'[hostname:]portnumber. Passing 0 as the port number will '
3549
'result in a dynamically allocated port. The default port is '
3553
help='Serve contents of this directory.',
3555
Option('allow-writes',
3556
help='By default the server is a readonly server. Supplying '
3557
'--allow-writes enables write access to the contents of '
3558
'the served directory and below.'
3562
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3563
from bzrlib.smart import medium, server
3564
from bzrlib.transport import get_transport
3565
from bzrlib.transport.chroot import ChrootServer
3566
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3567
if directory is None:
3568
directory = os.getcwd()
3569
url = urlutils.local_path_to_url(directory)
3570
if not allow_writes:
3571
url = 'readonly+' + url
3572
chroot_server = ChrootServer(get_transport(url))
3573
chroot_server.setUp()
3574
t = get_transport(chroot_server.get_url())
3576
smart_server = medium.SmartServerPipeStreamMedium(
3577
sys.stdin, sys.stdout, t)
3579
host = BZR_DEFAULT_INTERFACE
3581
port = BZR_DEFAULT_PORT
3584
host, port = port.split(':')
3586
smart_server = server.SmartTCPServer(t, host=host, port=port)
3587
print 'listening on port: ', smart_server.port
3589
# for the duration of this server, no UI output is permitted.
3590
# note that this may cause problems with blackbox tests. This should
3591
# be changed with care though, as we dont want to use bandwidth sending
3592
# progress over stderr to smart server clients!
3593
old_factory = ui.ui_factory
3595
ui.ui_factory = ui.SilentUIFactory()
3596
smart_server.serve()
3598
ui.ui_factory = old_factory
3601
class cmd_join(Command):
3602
"""Combine a subtree into its containing tree.
3604
This command is for experimental use only. It requires the target tree
3605
to be in dirstate-with-subtree format, which cannot be converted into
3608
The TREE argument should be an independent tree, inside another tree, but
3609
not part of it. (Such trees can be produced by "bzr split", but also by
3610
running "bzr branch" with the target inside a tree.)
3612
The result is a combined tree, with the subtree no longer an independant
3613
part. This is marked as a merge of the subtree into the containing tree,
3614
and all history is preserved.
3616
If --reference is specified, the subtree retains its independence. It can
3617
be branched by itself, and can be part of multiple projects at the same
3618
time. But operations performed in the containing tree, such as commit
3619
and merge, will recurse into the subtree.
3622
_see_also = ['split']
3623
takes_args = ['tree']
3625
Option('reference', help='Join by reference.'),
3629
def run(self, tree, reference=False):
3630
sub_tree = WorkingTree.open(tree)
3631
parent_dir = osutils.dirname(sub_tree.basedir)
3632
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3633
repo = containing_tree.branch.repository
3634
if not repo.supports_rich_root():
3635
raise errors.BzrCommandError(
3636
"Can't join trees because %s doesn't support rich root data.\n"
3637
"You can use bzr upgrade on the repository."
3641
containing_tree.add_reference(sub_tree)
3642
except errors.BadReferenceTarget, e:
3643
# XXX: Would be better to just raise a nicely printable
3644
# exception from the real origin. Also below. mbp 20070306
3645
raise errors.BzrCommandError("Cannot join %s. %s" %
3649
containing_tree.subsume(sub_tree)
3650
except errors.BadSubsumeSource, e:
3651
raise errors.BzrCommandError("Cannot join %s. %s" %
3655
class cmd_split(Command):
3656
"""Split a tree into two trees.
3658
This command is for experimental use only. It requires the target tree
3659
to be in dirstate-with-subtree format, which cannot be converted into
3662
The TREE argument should be a subdirectory of a working tree. That
3663
subdirectory will be converted into an independent tree, with its own
3664
branch. Commits in the top-level tree will not apply to the new subtree.
3665
If you want that behavior, do "bzr join --reference TREE".
3668
_see_also = ['join']
3669
takes_args = ['tree']
3673
def run(self, tree):
3674
containing_tree, subdir = WorkingTree.open_containing(tree)
3675
sub_id = containing_tree.path2id(subdir)
3677
raise errors.NotVersionedError(subdir)
3679
containing_tree.extract(sub_id)
3680
except errors.RootNotRich:
3681
raise errors.UpgradeRequired(containing_tree.branch.base)
3685
class cmd_merge_directive(Command):
3686
"""Generate a merge directive for auto-merge tools.
3688
A directive requests a merge to be performed, and also provides all the
3689
information necessary to do so. This means it must either include a
3690
revision bundle, or the location of a branch containing the desired
3693
A submit branch (the location to merge into) must be supplied the first
3694
time the command is issued. After it has been supplied once, it will
3695
be remembered as the default.
3697
A public branch is optional if a revision bundle is supplied, but required
3698
if --diff or --plain is specified. It will be remembered as the default
3699
after the first use.
3702
takes_args = ['submit_branch?', 'public_branch?']
3706
_see_also = ['send']
3709
RegistryOption.from_kwargs('patch-type',
3710
'The type of patch to include in the directive.',
3712
value_switches=True,
3714
bundle='Bazaar revision bundle (default).',
3715
diff='Normal unified diff.',
3716
plain='No patch, just directive.'),
3717
Option('sign', help='GPG-sign the directive.'), 'revision',
3718
Option('mail-to', type=str,
3719
help='Instead of printing the directive, email to this address.'),
3720
Option('message', type=str, short_name='m',
3721
help='Message to use when committing this merge.')
3724
encoding_type = 'exact'
3726
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3727
sign=False, revision=None, mail_to=None, message=None):
3728
from bzrlib.revision import ensure_null, NULL_REVISION
3729
include_patch, include_bundle = {
3730
'plain': (False, False),
3731
'diff': (True, False),
3732
'bundle': (True, True),
3734
branch = Branch.open('.')
3735
stored_submit_branch = branch.get_submit_branch()
3736
if submit_branch is None:
3737
submit_branch = stored_submit_branch
3739
if stored_submit_branch is None:
3740
branch.set_submit_branch(submit_branch)
3741
if submit_branch is None:
3742
submit_branch = branch.get_parent()
3743
if submit_branch is None:
3744
raise errors.BzrCommandError('No submit branch specified or known')
3746
stored_public_branch = branch.get_public_branch()
3747
if public_branch is None:
3748
public_branch = stored_public_branch
3749
elif stored_public_branch is None:
3750
branch.set_public_branch(public_branch)
3751
if not include_bundle and public_branch is None:
3752
raise errors.BzrCommandError('No public branch specified or'
3754
base_revision_id = None
3755
if revision is not None:
3756
if len(revision) > 2:
3757
raise errors.BzrCommandError('bzr merge-directive takes '
3758
'at most two one revision identifiers')
3759
revision_id = revision[-1].in_history(branch).rev_id
3760
if len(revision) == 2:
3761
base_revision_id = revision[0].in_history(branch).rev_id
3762
base_revision_id = ensure_null(base_revision_id)
3764
revision_id = branch.last_revision()
3765
revision_id = ensure_null(revision_id)
3766
if revision_id == NULL_REVISION:
3767
raise errors.BzrCommandError('No revisions to bundle.')
3768
directive = merge_directive.MergeDirective2.from_objects(
3769
branch.repository, revision_id, time.time(),
3770
osutils.local_time_offset(), submit_branch,
3771
public_branch=public_branch, include_patch=include_patch,
3772
include_bundle=include_bundle, message=message,
3773
base_revision_id=base_revision_id)
3776
self.outf.write(directive.to_signed(branch))
3778
self.outf.writelines(directive.to_lines())
3780
message = directive.to_email(mail_to, branch, sign)
3781
s = SMTPConnection(branch.get_config())
3782
s.send_email(message)
3785
class cmd_send(Command):
3786
"""Create a merge-directive for submiting changes.
3788
A merge directive provides many things needed for requesting merges:
3790
* A machine-readable description of the merge to perform
3792
* An optional patch that is a preview of the changes requested
3794
* An optional bundle of revision data, so that the changes can be applied
3795
directly from the merge directive, without retrieving data from a
3798
If --no-bundle is specified, then public_branch is needed (and must be
3799
up-to-date), so that the receiver can perform the merge using the
3800
public_branch. The public_branch is always included if known, so that
3801
people can check it later.
3803
The submit branch defaults to the parent, but can be overridden. Both
3804
submit branch and public branch will be remembered if supplied.
3806
If a public_branch is known for the submit_branch, that public submit
3807
branch is used in the merge instructions. This means that a local mirror
3808
can be used as your actual submit branch, once you have set public_branch
3811
Two formats are currently supported: "4" uses revision bundle format 4 and
3812
merge directive format 2. It is significantly faster and smaller than
3813
older formats. It is compatible with Bazaar 0.19 and later. It is the
3814
default. "0.9" uses revision bundle format 0.9 and merge directive
3815
format 1. It is compatible with Bazaar 0.12 - 0.18.
3818
encoding_type = 'exact'
3820
_see_also = ['merge']
3822
takes_args = ['submit_branch?', 'public_branch?']
3826
help='Do not include a bundle in the merge directive.'),
3827
Option('no-patch', help='Do not include a preview patch in the merge'
3830
help='Remember submit and public branch.'),
3832
help='Branch to generate the submission from, '
3833
'rather than the one containing the working directory.',
3836
Option('output', short_name='o', help='Write directive to this file.',
3839
RegistryOption.from_kwargs('format',
3840
'Use the specified output format.',
3841
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
3842
'0.9': 'Bundle format 0.9, Merge Directive 1',})
3845
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3846
no_patch=False, revision=None, remember=False, output=None,
3847
format='4', **kwargs):
3849
raise errors.BzrCommandError('File must be specified with'
3851
return self._run(submit_branch, revision, public_branch, remember,
3852
format, no_bundle, no_patch, output,
3853
kwargs.get('from', '.'))
3855
def _run(self, submit_branch, revision, public_branch, remember, format,
3856
no_bundle, no_patch, output, from_,):
3857
from bzrlib.revision import ensure_null, NULL_REVISION
3861
outfile = open(output, 'wb')
3863
branch = Branch.open_containing(from_)[0]
3864
if remember and submit_branch is None:
3865
raise errors.BzrCommandError(
3866
'--remember requires a branch to be specified.')
3867
stored_submit_branch = branch.get_submit_branch()
3868
remembered_submit_branch = False
3869
if submit_branch is None:
3870
submit_branch = stored_submit_branch
3871
remembered_submit_branch = True
3873
if stored_submit_branch is None or remember:
3874
branch.set_submit_branch(submit_branch)
3875
if submit_branch is None:
3876
submit_branch = branch.get_parent()
3877
remembered_submit_branch = True
3878
if submit_branch is None:
3879
raise errors.BzrCommandError('No submit branch known or'
3881
if remembered_submit_branch:
3882
note('Using saved location: %s', submit_branch)
3884
stored_public_branch = branch.get_public_branch()
3885
if public_branch is None:
3886
public_branch = stored_public_branch
3887
elif stored_public_branch is None or remember:
3888
branch.set_public_branch(public_branch)
3889
if no_bundle and public_branch is None:
3890
raise errors.BzrCommandError('No public branch specified or'
3892
base_revision_id = None
3893
if revision is not None:
3894
if len(revision) > 2:
3895
raise errors.BzrCommandError('bzr send takes '
3896
'at most two one revision identifiers')
3897
revision_id = revision[-1].in_history(branch).rev_id
3898
if len(revision) == 2:
3899
base_revision_id = revision[0].in_history(branch).rev_id
3900
base_revision_id = ensure_null(base_revision_id)
3902
revision_id = branch.last_revision()
3903
revision_id = ensure_null(revision_id)
3904
if revision_id == NULL_REVISION:
3905
raise errors.BzrCommandError('No revisions to submit.')
3907
directive = merge_directive.MergeDirective2.from_objects(
3908
branch.repository, revision_id, time.time(),
3909
osutils.local_time_offset(), submit_branch,
3910
public_branch=public_branch, include_patch=not no_patch,
3911
include_bundle=not no_bundle, message=None,
3912
base_revision_id=base_revision_id)
3913
elif format == '0.9':
3916
patch_type = 'bundle'
3918
raise errors.BzrCommandError('Format 0.9 does not'
3919
' permit bundle with no patch')
3925
directive = merge_directive.MergeDirective.from_objects(
3926
branch.repository, revision_id, time.time(),
3927
osutils.local_time_offset(), submit_branch,
3928
public_branch=public_branch, patch_type=patch_type,
3931
outfile.writelines(directive.to_lines())
3937
class cmd_bundle_revisions(cmd_send):
3939
"""Create a merge-directive for submiting changes.
3941
A merge directive provides many things needed for requesting merges:
3943
* A machine-readable description of the merge to perform
3945
* An optional patch that is a preview of the changes requested
3947
* An optional bundle of revision data, so that the changes can be applied
3948
directly from the merge directive, without retrieving data from a
3951
If --no-bundle is specified, then public_branch is needed (and must be
3952
up-to-date), so that the receiver can perform the merge using the
3953
public_branch. The public_branch is always included if known, so that
3954
people can check it later.
3956
The submit branch defaults to the parent, but can be overridden. Both
3957
submit branch and public branch will be remembered if supplied.
3959
If a public_branch is known for the submit_branch, that public submit
3960
branch is used in the merge instructions. This means that a local mirror
3961
can be used as your actual submit branch, once you have set public_branch
3964
Two formats are currently supported: "4" uses revision bundle format 4 and
3965
merge directive format 2. It is significantly faster and smaller than
3966
older formats. It is compatible with Bazaar 0.19 and later. It is the
3967
default. "0.9" uses revision bundle format 0.9 and merge directive
3968
format 1. It is compatible with Bazaar 0.12 - 0.18.
3971
aliases = ['bundle']
3973
_see_also = ['send', 'merge']
3977
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3978
no_patch=False, revision=None, remember=False, output=None,
3979
format='4', **kwargs):
3982
return self._run(submit_branch, revision, public_branch, remember,
3983
format, no_bundle, no_patch, output,
3984
kwargs.get('from', '.'))
3987
class cmd_tag(Command):
3988
"""Create, remove or modify a tag naming a revision.
3990
Tags give human-meaningful names to revisions. Commands that take a -r
3991
(--revision) option can be given -rtag:X, where X is any previously
3994
Tags are stored in the branch. Tags are copied from one branch to another
3995
along when you branch, push, pull or merge.
3997
It is an error to give a tag name that already exists unless you pass
3998
--force, in which case the tag is moved to point to the new revision.
4001
_see_also = ['commit', 'tags']
4002
takes_args = ['tag_name']
4005
help='Delete this tag rather than placing it.',
4008
help='Branch in which to place the tag.',
4013
help='Replace existing tags.',
4018
def run(self, tag_name,
4024
branch, relpath = Branch.open_containing(directory)
4028
branch.tags.delete_tag(tag_name)
4029
self.outf.write('Deleted tag %s.\n' % tag_name)
4032
if len(revision) != 1:
4033
raise errors.BzrCommandError(
4034
"Tags can only be placed on a single revision, "
4036
revision_id = revision[0].in_history(branch).rev_id
4038
revision_id = branch.last_revision()
4039
if (not force) and branch.tags.has_tag(tag_name):
4040
raise errors.TagAlreadyExists(tag_name)
4041
branch.tags.set_tag(tag_name, revision_id)
4042
self.outf.write('Created tag %s.\n' % tag_name)
4047
class cmd_tags(Command):
4050
This tag shows a table of tag names and the revisions they reference.
4056
help='Branch whose tags should be displayed.',
4066
branch, relpath = Branch.open_containing(directory)
4067
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
4068
self.outf.write('%-20s %s\n' % (tag_name, target))
4071
def _create_prefix(cur_transport):
4072
needed = [cur_transport]
4073
# Recurse upwards until we can create a directory successfully
4075
new_transport = cur_transport.clone('..')
4076
if new_transport.base == cur_transport.base:
4077
raise errors.BzrCommandError(
4078
"Failed to create path prefix for %s."
4079
% cur_transport.base)
4081
new_transport.mkdir('.')
4082
except errors.NoSuchFile:
4083
needed.append(new_transport)
4084
cur_transport = new_transport
4087
# Now we only need to create child directories
4089
cur_transport = needed.pop()
4090
cur_transport.ensure_base()
4093
def _get_mergeable_helper(location):
4094
"""Get a merge directive or bundle if 'location' points to one.
4096
Try try to identify a bundle and returns its mergeable form. If it's not,
4097
we return the tried transport anyway so that it can reused to access the
4100
:param location: can point to a bundle or a branch.
4102
:return: mergeable, transport
4105
url = urlutils.normalize_url(location)
4106
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4107
location_transport = transport.get_transport(url)
4110
# There may be redirections but we ignore the intermediate
4111
# and final transports used
4112
read = bundle.read_mergeable_from_transport
4113
mergeable, t = read(location_transport, filename)
4114
except errors.NotABundle:
4115
# Continue on considering this url a Branch but adjust the
4116
# location_transport
4117
location_transport = location_transport.clone(filename)
4118
return mergeable, location_transport
4121
# these get imported and then picked up by the scan for cmd_*
4122
# TODO: Some more consistent way to split command definitions across files;
4123
# we do need to load at least some information about them to know of
4124
# aliases. ideally we would avoid loading the implementation until the
4125
# details were needed.
4126
from bzrlib.cmd_version_info import cmd_version_info
4127
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4128
from bzrlib.bundle.commands import (
4131
from bzrlib.sign_my_commits import cmd_sign_my_commits
4132
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4133
cmd_weave_plan_merge, cmd_weave_merge_text