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)
962
source.create_checkout(to_location, revision_id, lightweight)
965
class cmd_renames(Command):
966
"""Show list of renamed files.
968
# TODO: Option to show renames between two historical versions.
970
# TODO: Only show renames under dir, rather than in the whole branch.
971
_see_also = ['status']
972
takes_args = ['dir?']
975
def run(self, dir=u'.'):
976
tree = WorkingTree.open_containing(dir)[0]
979
new_inv = tree.inventory
980
old_tree = tree.basis_tree()
983
old_inv = old_tree.inventory
984
renames = list(_mod_tree.find_renames(old_inv, new_inv))
986
for old_name, new_name in renames:
987
self.outf.write("%s => %s\n" % (old_name, new_name))
994
class cmd_update(Command):
995
"""Update a tree to have the latest code committed to its branch.
997
This will perform a merge into the working tree, and may generate
998
conflicts. If you have any local changes, you will still
999
need to commit them after the update for the update to be complete.
1001
If you want to discard your local changes, you can just do a
1002
'bzr revert' instead of 'bzr commit' after the update.
1005
_see_also = ['pull', 'working-trees', 'status-flags']
1006
takes_args = ['dir?']
1009
def run(self, dir='.'):
1010
tree = WorkingTree.open_containing(dir)[0]
1011
master = tree.branch.get_master_branch()
1012
if master is not None:
1015
tree.lock_tree_write()
1017
existing_pending_merges = tree.get_parent_ids()[1:]
1018
last_rev = _mod_revision.ensure_null(tree.last_revision())
1019
if last_rev == _mod_revision.ensure_null(
1020
tree.branch.last_revision()):
1021
# may be up to date, check master too.
1022
if master is None or last_rev == _mod_revision.ensure_null(
1023
master.last_revision()):
1024
revno = tree.branch.revision_id_to_revno(last_rev)
1025
note("Tree is up to date at revision %d." % (revno,))
1027
conflicts = tree.update(delta._ChangeReporter(
1028
unversioned_filter=tree.is_ignored))
1029
revno = tree.branch.revision_id_to_revno(
1030
_mod_revision.ensure_null(tree.last_revision()))
1031
note('Updated to revision %d.' % (revno,))
1032
if tree.get_parent_ids()[1:] != existing_pending_merges:
1033
note('Your local commits will now show as pending merges with '
1034
"'bzr status', and can be committed with 'bzr commit'.")
1043
class cmd_info(Command):
1044
"""Show information about a working tree, branch or repository.
1046
This command will show all known locations and formats associated to the
1047
tree, branch or repository. Statistical information is included with
1050
Branches and working trees will also report any missing revisions.
1052
_see_also = ['revno', 'working-trees', 'repositories']
1053
takes_args = ['location?']
1054
takes_options = ['verbose']
1057
def run(self, location=None, verbose=0):
1058
from bzrlib.info import show_bzrdir_info
1059
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1063
class cmd_remove(Command):
1064
"""Remove files or directories.
1066
This makes bzr stop tracking changes to the specified files and
1067
delete them if they can easily be recovered using revert.
1069
You can specify one or more files, and/or --new. If you specify --new,
1070
only 'added' files will be removed. If you specify both, then new files
1071
in the specified directories will be removed. If the directories are
1072
also new, they will also be removed.
1074
takes_args = ['file*']
1075
takes_options = ['verbose',
1076
Option('new', help='Remove newly-added files.'),
1077
RegistryOption.from_kwargs('file-deletion-strategy',
1078
'The file deletion mode to be used.',
1079
title='Deletion Strategy', value_switches=True, enum_switch=False,
1080
safe='Only delete files if they can be'
1081
' safely recovered (default).',
1082
keep="Don't delete any files.",
1083
force='Delete all the specified files, even if they can not be '
1084
'recovered and even if they are non-empty directories.')]
1086
encoding_type = 'replace'
1088
def run(self, file_list, verbose=False, new=False,
1089
file_deletion_strategy='safe'):
1090
tree, file_list = tree_files(file_list)
1092
if file_list is not None:
1093
file_list = [f for f in file_list if f != '']
1095
raise errors.BzrCommandError('Specify one or more files to'
1096
' remove, or use --new.')
1099
added = tree.changes_from(tree.basis_tree(),
1100
specific_files=file_list).added
1101
file_list = sorted([f[0] for f in added], reverse=True)
1102
if len(file_list) == 0:
1103
raise errors.BzrCommandError('No matching files.')
1104
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1105
keep_files=file_deletion_strategy=='keep',
1106
force=file_deletion_strategy=='force')
1109
class cmd_file_id(Command):
1110
"""Print file_id of a particular file or directory.
1112
The file_id is assigned when the file is first added and remains the
1113
same through all revisions where the file exists, even when it is
1118
_see_also = ['inventory', 'ls']
1119
takes_args = ['filename']
1122
def run(self, filename):
1123
tree, relpath = WorkingTree.open_containing(filename)
1124
i = tree.path2id(relpath)
1126
raise errors.NotVersionedError(filename)
1128
self.outf.write(i + '\n')
1131
class cmd_file_path(Command):
1132
"""Print path of file_ids to a file or directory.
1134
This prints one line for each directory down to the target,
1135
starting at the branch root.
1139
takes_args = ['filename']
1142
def run(self, filename):
1143
tree, relpath = WorkingTree.open_containing(filename)
1144
fid = tree.path2id(relpath)
1146
raise errors.NotVersionedError(filename)
1147
segments = osutils.splitpath(relpath)
1148
for pos in range(1, len(segments) + 1):
1149
path = osutils.joinpath(segments[:pos])
1150
self.outf.write("%s\n" % tree.path2id(path))
1153
class cmd_reconcile(Command):
1154
"""Reconcile bzr metadata in a branch.
1156
This can correct data mismatches that may have been caused by
1157
previous ghost operations or bzr upgrades. You should only
1158
need to run this command if 'bzr check' or a bzr developer
1159
advises you to run it.
1161
If a second branch is provided, cross-branch reconciliation is
1162
also attempted, which will check that data like the tree root
1163
id which was not present in very early bzr versions is represented
1164
correctly in both branches.
1166
At the same time it is run it may recompress data resulting in
1167
a potential saving in disk space or performance gain.
1169
The branch *MUST* be on a listable system such as local disk or sftp.
1172
_see_also = ['check']
1173
takes_args = ['branch?']
1175
def run(self, branch="."):
1176
from bzrlib.reconcile import reconcile
1177
dir = bzrdir.BzrDir.open(branch)
1181
class cmd_revision_history(Command):
1182
"""Display the list of revision ids on a branch."""
1185
takes_args = ['location?']
1190
def run(self, location="."):
1191
branch = Branch.open_containing(location)[0]
1192
for revid in branch.revision_history():
1193
self.outf.write(revid)
1194
self.outf.write('\n')
1197
class cmd_ancestry(Command):
1198
"""List all revisions merged into this branch."""
1200
_see_also = ['log', 'revision-history']
1201
takes_args = ['location?']
1206
def run(self, location="."):
1208
wt = WorkingTree.open_containing(location)[0]
1209
except errors.NoWorkingTree:
1210
b = Branch.open(location)
1211
last_revision = b.last_revision()
1214
last_revision = wt.last_revision()
1216
revision_ids = b.repository.get_ancestry(last_revision)
1217
assert revision_ids[0] is None
1219
for revision_id in revision_ids:
1220
self.outf.write(revision_id + '\n')
1223
class cmd_init(Command):
1224
"""Make a directory into a versioned branch.
1226
Use this to create an empty branch, or before importing an
1229
If there is a repository in a parent directory of the location, then
1230
the history of the branch will be stored in the repository. Otherwise
1231
init creates a standalone branch which carries its own history
1232
in the .bzr directory.
1234
If there is already a branch at the location but it has no working tree,
1235
the tree can be populated with 'bzr checkout'.
1237
Recipe for importing a tree of files::
1243
bzr commit -m 'imported project'
1246
_see_also = ['init-repository', 'branch', 'checkout']
1247
takes_args = ['location?']
1249
Option('create-prefix',
1250
help='Create the path leading up to the branch '
1251
'if it does not already exist.'),
1252
RegistryOption('format',
1253
help='Specify a format for this branch. '
1254
'See "help formats".',
1255
registry=bzrdir.format_registry,
1256
converter=bzrdir.format_registry.make_bzrdir,
1257
value_switches=True,
1258
title="Branch Format",
1260
Option('append-revisions-only',
1261
help='Never change revnos or the existing log.'
1262
' Append revisions to it only.')
1264
def run(self, location=None, format=None, append_revisions_only=False,
1265
create_prefix=False):
1267
format = bzrdir.format_registry.make_bzrdir('default')
1268
if location is None:
1271
to_transport = transport.get_transport(location)
1273
# The path has to exist to initialize a
1274
# branch inside of it.
1275
# Just using os.mkdir, since I don't
1276
# believe that we want to create a bunch of
1277
# locations if the user supplies an extended path
1279
to_transport.ensure_base()
1280
except errors.NoSuchFile:
1281
if not create_prefix:
1282
raise errors.BzrCommandError("Parent directory of %s"
1284
"\nYou may supply --create-prefix to create all"
1285
" leading parent directories."
1287
_create_prefix(to_transport)
1290
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1291
except errors.NotBranchError:
1292
# really a NotBzrDir error...
1293
create_branch = bzrdir.BzrDir.create_branch_convenience
1294
branch = create_branch(to_transport.base, format=format,
1295
possible_transports=[to_transport])
1297
from bzrlib.transport.local import LocalTransport
1298
if existing_bzrdir.has_branch():
1299
if (isinstance(to_transport, LocalTransport)
1300
and not existing_bzrdir.has_workingtree()):
1301
raise errors.BranchExistsWithoutWorkingTree(location)
1302
raise errors.AlreadyBranchError(location)
1304
branch = existing_bzrdir.create_branch()
1305
existing_bzrdir.create_workingtree()
1306
if append_revisions_only:
1308
branch.set_append_revisions_only(True)
1309
except errors.UpgradeRequired:
1310
raise errors.BzrCommandError('This branch format cannot be set'
1311
' to append-revisions-only. Try --experimental-branch6')
1314
class cmd_init_repository(Command):
1315
"""Create a shared repository to hold branches.
1317
New branches created under the repository directory will store their
1318
revisions in the repository, not in the branch directory.
1320
If the --no-trees option is used then the branches in the repository
1321
will not have working trees by default.
1324
Create a shared repositories holding just branches::
1326
bzr init-repo --no-trees repo
1329
Make a lightweight checkout elsewhere::
1331
bzr checkout --lightweight repo/trunk trunk-checkout
1336
_see_also = ['init', 'branch', 'checkout', 'repositories']
1337
takes_args = ["location"]
1338
takes_options = [RegistryOption('format',
1339
help='Specify a format for this repository. See'
1340
' "bzr help formats" for details.',
1341
registry=bzrdir.format_registry,
1342
converter=bzrdir.format_registry.make_bzrdir,
1343
value_switches=True, title='Repository format'),
1345
help='Branches in the repository will default to'
1346
' not having a working tree.'),
1348
aliases = ["init-repo"]
1350
def run(self, location, format=None, no_trees=False):
1352
format = bzrdir.format_registry.make_bzrdir('default')
1354
if location is None:
1357
to_transport = transport.get_transport(location)
1358
to_transport.ensure_base()
1360
newdir = format.initialize_on_transport(to_transport)
1361
repo = newdir.create_repository(shared=True)
1362
repo.set_make_working_trees(not no_trees)
1365
class cmd_diff(Command):
1366
"""Show differences in the working tree or between revisions.
1368
If files are listed, only the changes in those files are listed.
1369
Otherwise, all changes for the tree are listed.
1371
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1372
produces patches suitable for "patch -p1".
1375
Shows the difference in the working tree versus the last commit::
1379
Difference between the working tree and revision 1::
1383
Difference between revision 2 and revision 1::
1387
Same as 'bzr diff' but prefix paths with old/ and new/::
1389
bzr diff --prefix old/:new/
1391
Show the differences between the two working trees::
1393
bzr diff bzr.mine bzr.dev
1395
Show just the differences for 'foo.c'::
1399
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1400
# or a graphical diff.
1402
# TODO: Python difflib is not exactly the same as unidiff; should
1403
# either fix it up or prefer to use an external diff.
1405
# TODO: Selected-file diff is inefficient and doesn't show you
1408
# TODO: This probably handles non-Unix newlines poorly.
1410
_see_also = ['status']
1411
takes_args = ['file*']
1413
Option('diff-options', type=str,
1414
help='Pass these options to the external diff program.'),
1415
Option('prefix', type=str,
1417
help='Set prefixes to added to old and new filenames, as '
1418
'two values separated by a colon. (eg "old/:new/").'),
1421
aliases = ['di', 'dif']
1422
encoding_type = 'exact'
1425
def run(self, revision=None, file_list=None, diff_options=None,
1427
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1429
if (prefix is None) or (prefix == '0'):
1437
old_label, new_label = prefix.split(":")
1439
raise errors.BzrCommandError(
1440
'--prefix expects two values separated by a colon'
1441
' (eg "old/:new/")')
1443
if revision and len(revision) > 2:
1444
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1445
' one or two revision specifiers')
1448
tree1, file_list = internal_tree_files(file_list)
1452
except errors.FileInWrongBranch:
1453
if len(file_list) != 2:
1454
raise errors.BzrCommandError("Files are in different branches")
1456
tree1, file1 = WorkingTree.open_containing(file_list[0])
1457
tree2, file2 = WorkingTree.open_containing(file_list[1])
1458
if file1 != "" or file2 != "":
1459
# FIXME diff those two files. rbc 20051123
1460
raise errors.BzrCommandError("Files are in different branches")
1462
except errors.NotBranchError:
1463
if (revision is not None and len(revision) == 2
1464
and not revision[0].needs_branch()
1465
and not revision[1].needs_branch()):
1466
# If both revision specs include a branch, we can
1467
# diff them without needing a local working tree
1468
tree1, tree2 = None, None
1472
if tree2 is not None:
1473
if revision is not None:
1474
# FIXME: but there should be a clean way to diff between
1475
# non-default versions of two trees, it's not hard to do
1477
raise errors.BzrCommandError(
1478
"Sorry, diffing arbitrary revisions across branches "
1479
"is not implemented yet")
1480
return show_diff_trees(tree1, tree2, sys.stdout,
1481
specific_files=file_list,
1482
external_diff_options=diff_options,
1483
old_label=old_label, new_label=new_label)
1485
return diff_cmd_helper(tree1, file_list, diff_options,
1486
revision_specs=revision,
1487
old_label=old_label, new_label=new_label)
1490
class cmd_deleted(Command):
1491
"""List files deleted in the working tree.
1493
# TODO: Show files deleted since a previous revision, or
1494
# between two revisions.
1495
# TODO: Much more efficient way to do this: read in new
1496
# directories with readdir, rather than stating each one. Same
1497
# level of effort but possibly much less IO. (Or possibly not,
1498
# if the directories are very large...)
1499
_see_also = ['status', 'ls']
1500
takes_options = ['show-ids']
1503
def run(self, show_ids=False):
1504
tree = WorkingTree.open_containing(u'.')[0]
1507
old = tree.basis_tree()
1510
for path, ie in old.inventory.iter_entries():
1511
if not tree.has_id(ie.file_id):
1512
self.outf.write(path)
1514
self.outf.write(' ')
1515
self.outf.write(ie.file_id)
1516
self.outf.write('\n')
1523
class cmd_modified(Command):
1524
"""List files modified in working tree.
1528
_see_also = ['status', 'ls']
1532
tree = WorkingTree.open_containing(u'.')[0]
1533
td = tree.changes_from(tree.basis_tree())
1534
for path, id, kind, text_modified, meta_modified in td.modified:
1535
self.outf.write(path + '\n')
1538
class cmd_added(Command):
1539
"""List files added in working tree.
1543
_see_also = ['status', 'ls']
1547
wt = WorkingTree.open_containing(u'.')[0]
1550
basis = wt.basis_tree()
1553
basis_inv = basis.inventory
1556
if file_id in basis_inv:
1558
if inv.is_root(file_id) and len(basis_inv) == 0:
1560
path = inv.id2path(file_id)
1561
if not os.access(osutils.abspath(path), os.F_OK):
1563
self.outf.write(path + '\n')
1570
class cmd_root(Command):
1571
"""Show the tree root directory.
1573
The root is the nearest enclosing directory with a .bzr control
1576
takes_args = ['filename?']
1578
def run(self, filename=None):
1579
"""Print the branch root."""
1580
tree = WorkingTree.open_containing(filename)[0]
1581
self.outf.write(tree.basedir + '\n')
1584
def _parse_limit(limitstring):
1586
return int(limitstring)
1588
msg = "The limit argument must be an integer."
1589
raise errors.BzrCommandError(msg)
1592
class cmd_log(Command):
1593
"""Show log of a branch, file, or directory.
1595
By default show the log of the branch containing the working directory.
1597
To request a range of logs, you can use the command -r begin..end
1598
-r revision requests a specific revision, -r ..end or -r begin.. are
1602
Log the current branch::
1610
Log the last 10 revisions of a branch::
1612
bzr log -r -10.. http://server/branch
1615
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1617
takes_args = ['location?']
1620
help='Show from oldest to newest.'),
1623
help='Display timezone as local, original, or utc.'),
1626
help='Show files changed in each revision.'),
1632
help='Show revisions whose message matches this '
1633
'regular expression.',
1636
help='Limit the output to the first N revisions.',
1640
encoding_type = 'replace'
1643
def run(self, location=None, timezone='original',
1651
from bzrlib.log import show_log
1652
assert message is None or isinstance(message, basestring), \
1653
"invalid message argument %r" % message
1654
direction = (forward and 'forward') or 'reverse'
1659
# find the file id to log:
1661
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1665
tree = b.basis_tree()
1666
file_id = tree.path2id(fp)
1668
raise errors.BzrCommandError(
1669
"Path does not have any revision history: %s" %
1673
# FIXME ? log the current subdir only RBC 20060203
1674
if revision is not None \
1675
and len(revision) > 0 and revision[0].get_branch():
1676
location = revision[0].get_branch()
1679
dir, relpath = bzrdir.BzrDir.open_containing(location)
1680
b = dir.open_branch()
1684
if revision is None:
1687
elif len(revision) == 1:
1688
rev1 = rev2 = revision[0].in_history(b)
1689
elif len(revision) == 2:
1690
if revision[1].get_branch() != revision[0].get_branch():
1691
# b is taken from revision[0].get_branch(), and
1692
# show_log will use its revision_history. Having
1693
# different branches will lead to weird behaviors.
1694
raise errors.BzrCommandError(
1695
"Log doesn't accept two revisions in different"
1697
rev1 = revision[0].in_history(b)
1698
rev2 = revision[1].in_history(b)
1700
raise errors.BzrCommandError(
1701
'bzr log --revision takes one or two values.')
1703
if log_format is None:
1704
log_format = log.log_formatter_registry.get_default(b)
1706
lf = log_format(show_ids=show_ids, to_file=self.outf,
1707
show_timezone=timezone)
1713
direction=direction,
1714
start_revision=rev1,
1722
def get_log_format(long=False, short=False, line=False, default='long'):
1723
log_format = default
1727
log_format = 'short'
1733
class cmd_touching_revisions(Command):
1734
"""Return revision-ids which affected a particular file.
1736
A more user-friendly interface is "bzr log FILE".
1740
takes_args = ["filename"]
1743
def run(self, filename):
1744
tree, relpath = WorkingTree.open_containing(filename)
1746
file_id = tree.path2id(relpath)
1747
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1748
self.outf.write("%6d %s\n" % (revno, what))
1751
class cmd_ls(Command):
1752
"""List files in a tree.
1755
_see_also = ['status', 'cat']
1756
takes_args = ['path?']
1757
# TODO: Take a revision or remote path and list that tree instead.
1761
Option('non-recursive',
1762
help='Don\'t recurse into subdirectories.'),
1764
help='Print paths relative to the root of the branch.'),
1765
Option('unknown', help='Print unknown files.'),
1766
Option('versioned', help='Print versioned files.'),
1767
Option('ignored', help='Print ignored files.'),
1769
help='Write an ascii NUL (\\0) separator '
1770
'between files rather than a newline.'),
1772
help='List entries of a particular kind: file, directory, symlink.',
1777
def run(self, revision=None, verbose=False,
1778
non_recursive=False, from_root=False,
1779
unknown=False, versioned=False, ignored=False,
1780
null=False, kind=None, show_ids=False, path=None):
1782
if kind and kind not in ('file', 'directory', 'symlink'):
1783
raise errors.BzrCommandError('invalid kind specified')
1785
if verbose and null:
1786
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1787
all = not (unknown or versioned or ignored)
1789
selection = {'I':ignored, '?':unknown, 'V':versioned}
1796
raise errors.BzrCommandError('cannot specify both --from-root'
1800
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1806
if revision is not None:
1807
tree = branch.repository.revision_tree(
1808
revision[0].in_history(branch).rev_id)
1810
tree = branch.basis_tree()
1814
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1815
if fp.startswith(relpath):
1816
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1817
if non_recursive and '/' in fp:
1819
if not all and not selection[fc]:
1821
if kind is not None and fkind != kind:
1824
kindch = entry.kind_character()
1825
outstring = '%-8s %s%s' % (fc, fp, kindch)
1826
if show_ids and fid is not None:
1827
outstring = "%-50s %s" % (outstring, fid)
1828
self.outf.write(outstring + '\n')
1830
self.outf.write(fp + '\0')
1833
self.outf.write(fid)
1834
self.outf.write('\0')
1842
self.outf.write('%-50s %s\n' % (fp, my_id))
1844
self.outf.write(fp + '\n')
1849
class cmd_unknowns(Command):
1850
"""List unknown files.
1858
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1859
self.outf.write(osutils.quotefn(f) + '\n')
1862
class cmd_ignore(Command):
1863
"""Ignore specified files or patterns.
1865
To remove patterns from the ignore list, edit the .bzrignore file.
1867
Trailing slashes on patterns are ignored.
1868
If the pattern contains a slash or is a regular expression, it is compared
1869
to the whole path from the branch root. Otherwise, it is compared to only
1870
the last component of the path. To match a file only in the root
1871
directory, prepend './'.
1873
Ignore patterns specifying absolute paths are not allowed.
1875
Ignore patterns may include globbing wildcards such as::
1877
? - Matches any single character except '/'
1878
* - Matches 0 or more characters except '/'
1879
/**/ - Matches 0 or more directories in a path
1880
[a-z] - Matches a single character from within a group of characters
1882
Ignore patterns may also be Python regular expressions.
1883
Regular expression ignore patterns are identified by a 'RE:' prefix
1884
followed by the regular expression. Regular expression ignore patterns
1885
may not include named or numbered groups.
1887
Note: ignore patterns containing shell wildcards must be quoted from
1891
Ignore the top level Makefile::
1893
bzr ignore ./Makefile
1895
Ignore class files in all directories::
1897
bzr ignore '*.class'
1899
Ignore .o files under the lib directory::
1901
bzr ignore 'lib/**/*.o'
1903
Ignore .o files under the lib directory::
1905
bzr ignore 'RE:lib/.*\.o'
1908
_see_also = ['status', 'ignored']
1909
takes_args = ['name_pattern*']
1911
Option('old-default-rules',
1912
help='Write out the ignore rules bzr < 0.9 always used.')
1915
def run(self, name_pattern_list=None, old_default_rules=None):
1916
from bzrlib.atomicfile import AtomicFile
1917
if old_default_rules is not None:
1918
# dump the rules and exit
1919
for pattern in ignores.OLD_DEFAULTS:
1922
if not name_pattern_list:
1923
raise errors.BzrCommandError("ignore requires at least one "
1924
"NAME_PATTERN or --old-default-rules")
1925
name_pattern_list = [globbing.normalize_pattern(p)
1926
for p in name_pattern_list]
1927
for name_pattern in name_pattern_list:
1928
if (name_pattern[0] == '/' or
1929
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1930
raise errors.BzrCommandError(
1931
"NAME_PATTERN should not be an absolute path")
1932
tree, relpath = WorkingTree.open_containing(u'.')
1933
ifn = tree.abspath('.bzrignore')
1934
if os.path.exists(ifn):
1937
igns = f.read().decode('utf-8')
1943
# TODO: If the file already uses crlf-style termination, maybe
1944
# we should use that for the newly added lines?
1946
if igns and igns[-1] != '\n':
1948
for name_pattern in name_pattern_list:
1949
igns += name_pattern + '\n'
1951
f = AtomicFile(ifn, 'wb')
1953
f.write(igns.encode('utf-8'))
1958
if not tree.path2id('.bzrignore'):
1959
tree.add(['.bzrignore'])
1962
class cmd_ignored(Command):
1963
"""List ignored files and the patterns that matched them.
1966
_see_also = ['ignore']
1969
tree = WorkingTree.open_containing(u'.')[0]
1972
for path, file_class, kind, file_id, entry in tree.list_files():
1973
if file_class != 'I':
1975
## XXX: Slightly inefficient since this was already calculated
1976
pat = tree.is_ignored(path)
1977
print '%-50s %s' % (path, pat)
1982
class cmd_lookup_revision(Command):
1983
"""Lookup the revision-id from a revision-number
1986
bzr lookup-revision 33
1989
takes_args = ['revno']
1992
def run(self, revno):
1996
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1998
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2001
class cmd_export(Command):
2002
"""Export current or past revision to a destination directory or archive.
2004
If no revision is specified this exports the last committed revision.
2006
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2007
given, try to find the format with the extension. If no extension
2008
is found exports to a directory (equivalent to --format=dir).
2010
If root is supplied, it will be used as the root directory inside
2011
container formats (tar, zip, etc). If it is not supplied it will default
2012
to the exported filename. The root option has no effect for 'dir' format.
2014
If branch is omitted then the branch containing the current working
2015
directory will be used.
2017
Note: Export of tree with non-ASCII filenames to zip is not supported.
2019
================= =========================
2020
Supported formats Autodetected by extension
2021
================= =========================
2024
tbz2 .tar.bz2, .tbz2
2027
================= =========================
2029
takes_args = ['dest', 'branch?']
2032
help="Type of file to export to.",
2037
help="Name of the root directory inside the exported file."),
2039
def run(self, dest, branch=None, revision=None, format=None, root=None):
2040
from bzrlib.export import export
2043
tree = WorkingTree.open_containing(u'.')[0]
2046
b = Branch.open(branch)
2048
if revision is None:
2049
# should be tree.last_revision FIXME
2050
rev_id = b.last_revision()
2052
if len(revision) != 1:
2053
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2054
rev_id = revision[0].in_history(b).rev_id
2055
t = b.repository.revision_tree(rev_id)
2057
export(t, dest, format, root)
2058
except errors.NoSuchExportFormat, e:
2059
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2062
class cmd_cat(Command):
2063
"""Write the contents of a file as of a given revision to standard output.
2065
If no revision is nominated, the last revision is used.
2067
Note: Take care to redirect standard output when using this command on a
2073
Option('name-from-revision', help='The path name in the old tree.'),
2076
takes_args = ['filename']
2077
encoding_type = 'exact'
2080
def run(self, filename, revision=None, name_from_revision=False):
2081
if revision is not None and len(revision) != 1:
2082
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2087
tree, b, relpath = \
2088
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2089
except errors.NotBranchError:
2092
if revision is not None and revision[0].get_branch() is not None:
2093
b = Branch.open(revision[0].get_branch())
2095
tree = b.basis_tree()
2096
if revision is None:
2097
revision_id = b.last_revision()
2099
revision_id = revision[0].in_history(b).rev_id
2101
cur_file_id = tree.path2id(relpath)
2102
rev_tree = b.repository.revision_tree(revision_id)
2103
old_file_id = rev_tree.path2id(relpath)
2105
if name_from_revision:
2106
if old_file_id is None:
2107
raise errors.BzrCommandError("%r is not present in revision %s"
2108
% (filename, revision_id))
2110
rev_tree.print_file(old_file_id)
2111
elif cur_file_id is not None:
2112
rev_tree.print_file(cur_file_id)
2113
elif old_file_id is not None:
2114
rev_tree.print_file(old_file_id)
2116
raise errors.BzrCommandError("%r is not present in revision %s" %
2117
(filename, revision_id))
2120
class cmd_local_time_offset(Command):
2121
"""Show the offset in seconds from GMT to local time."""
2125
print osutils.local_time_offset()
2129
class cmd_commit(Command):
2130
"""Commit changes into a new revision.
2132
If no arguments are given, the entire tree is committed.
2134
If selected files are specified, only changes to those files are
2135
committed. If a directory is specified then the directory and everything
2136
within it is committed.
2138
If author of the change is not the same person as the committer, you can
2139
specify the author's name using the --author option. The name should be
2140
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2142
A selected-file commit may fail in some cases where the committed
2143
tree would be invalid. Consider::
2148
bzr commit foo -m "committing foo"
2149
bzr mv foo/bar foo/baz
2152
bzr commit foo/bar -m "committing bar but not baz"
2154
In the example above, the last commit will fail by design. This gives
2155
the user the opportunity to decide whether they want to commit the
2156
rename at the same time, separately first, or not at all. (As a general
2157
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2159
Note: A selected-file commit after a merge is not yet supported.
2161
# TODO: Run hooks on tree to-be-committed, and after commit.
2163
# TODO: Strict commit that fails if there are deleted files.
2164
# (what does "deleted files" mean ??)
2166
# TODO: Give better message for -s, --summary, used by tla people
2168
# XXX: verbose currently does nothing
2170
_see_also = ['bugs', 'uncommit']
2171
takes_args = ['selected*']
2173
Option('message', type=unicode,
2175
help="Description of the new revision."),
2178
help='Commit even if nothing has changed.'),
2179
Option('file', type=str,
2182
help='Take commit message from this file.'),
2184
help="Refuse to commit if there are unknown "
2185
"files in the working tree."),
2186
ListOption('fixes', type=str,
2187
help="Mark a bug as being fixed by this revision."),
2188
Option('author', type=str,
2189
help="Set the author's name, if it's different "
2190
"from the committer."),
2192
help="Perform a local commit in a bound "
2193
"branch. Local commits are not pushed to "
2194
"the master branch until a normal commit "
2198
help='When no message is supplied, show the diff along'
2199
' with the status summary in the message editor.'),
2201
aliases = ['ci', 'checkin']
2203
def _get_bug_fix_properties(self, fixes, branch):
2205
# Configure the properties for bug fixing attributes.
2206
for fixed_bug in fixes:
2207
tokens = fixed_bug.split(':')
2208
if len(tokens) != 2:
2209
raise errors.BzrCommandError(
2210
"Invalid bug %s. Must be in the form of 'tag:id'. "
2211
"Commit refused." % fixed_bug)
2212
tag, bug_id = tokens
2214
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2215
except errors.UnknownBugTrackerAbbreviation:
2216
raise errors.BzrCommandError(
2217
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2218
except errors.MalformedBugIdentifier:
2219
raise errors.BzrCommandError(
2220
"Invalid bug identifier for %s. Commit refused."
2222
properties.append('%s fixed' % bug_url)
2223
return '\n'.join(properties)
2225
def run(self, message=None, file=None, verbose=True, selected_list=None,
2226
unchanged=False, strict=False, local=False, fixes=None,
2227
author=None, show_diff=False):
2228
from bzrlib.commit import (
2232
from bzrlib.errors import (
2237
from bzrlib.msgeditor import (
2238
edit_commit_message_encoded,
2239
make_commit_message_template_encoded
2242
# TODO: Need a blackbox test for invoking the external editor; may be
2243
# slightly problematic to run this cross-platform.
2245
# TODO: do more checks that the commit will succeed before
2246
# spending the user's valuable time typing a commit message.
2250
tree, selected_list = tree_files(selected_list)
2251
if selected_list == ['']:
2252
# workaround - commit of root of tree should be exactly the same
2253
# as just default commit in that tree, and succeed even though
2254
# selected-file merge commit is not done yet
2257
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2259
properties['bugs'] = bug_property
2261
if local and not tree.branch.get_bound_location():
2262
raise errors.LocalRequiresBoundBranch()
2264
def get_message(commit_obj):
2265
"""Callback to get commit message"""
2266
my_message = message
2267
if my_message is None and not file:
2268
t = make_commit_message_template_encoded(tree,
2269
selected_list, diff=show_diff,
2270
output_encoding=bzrlib.user_encoding)
2271
my_message = edit_commit_message_encoded(t)
2272
if my_message is None:
2273
raise errors.BzrCommandError("please specify a commit"
2274
" message with either --message or --file")
2275
elif my_message and file:
2276
raise errors.BzrCommandError(
2277
"please specify either --message or --file")
2279
my_message = codecs.open(file, 'rt',
2280
bzrlib.user_encoding).read()
2281
if my_message == "":
2282
raise errors.BzrCommandError("empty commit message specified")
2286
reporter = ReportCommitToLog()
2288
reporter = NullCommitReporter()
2291
tree.commit(message_callback=get_message,
2292
specific_files=selected_list,
2293
allow_pointless=unchanged, strict=strict, local=local,
2294
reporter=reporter, revprops=properties,
2296
except PointlessCommit:
2297
# FIXME: This should really happen before the file is read in;
2298
# perhaps prepare the commit; get the message; then actually commit
2299
raise errors.BzrCommandError("no changes to commit."
2300
" use --unchanged to commit anyhow")
2301
except ConflictsInTree:
2302
raise errors.BzrCommandError('Conflicts detected in working '
2303
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2305
except StrictCommitFailed:
2306
raise errors.BzrCommandError("Commit refused because there are"
2307
" unknown files in the working tree.")
2308
except errors.BoundBranchOutOfDate, e:
2309
raise errors.BzrCommandError(str(e) + "\n"
2310
'To commit to master branch, run update and then commit.\n'
2311
'You can also pass --local to commit to continue working '
2315
class cmd_check(Command):
2316
"""Validate consistency of branch history.
2318
This command checks various invariants about the branch storage to
2319
detect data corruption or bzr bugs.
2322
_see_also = ['reconcile']
2323
takes_args = ['branch?']
2324
takes_options = ['verbose']
2326
def run(self, branch=None, verbose=False):
2327
from bzrlib.check import check
2329
tree = WorkingTree.open_containing()[0]
2330
branch = tree.branch
2332
branch = Branch.open(branch)
2333
check(branch, verbose)
2336
class cmd_upgrade(Command):
2337
"""Upgrade branch storage to current format.
2339
The check command or bzr developers may sometimes advise you to run
2340
this command. When the default format has changed you may also be warned
2341
during other operations to upgrade.
2344
_see_also = ['check']
2345
takes_args = ['url?']
2347
RegistryOption('format',
2348
help='Upgrade to a specific format. See "bzr help'
2349
' formats" for details.',
2350
registry=bzrdir.format_registry,
2351
converter=bzrdir.format_registry.make_bzrdir,
2352
value_switches=True, title='Branch format'),
2355
def run(self, url='.', format=None):
2356
from bzrlib.upgrade import upgrade
2358
format = bzrdir.format_registry.make_bzrdir('default')
2359
upgrade(url, format)
2362
class cmd_whoami(Command):
2363
"""Show or set bzr user id.
2366
Show the email of the current user::
2370
Set the current user::
2372
bzr whoami 'Frank Chu <fchu@example.com>'
2374
takes_options = [ Option('email',
2375
help='Display email address only.'),
2377
help='Set identity for the current branch instead of '
2380
takes_args = ['name?']
2381
encoding_type = 'replace'
2384
def run(self, email=False, branch=False, name=None):
2386
# use branch if we're inside one; otherwise global config
2388
c = Branch.open_containing('.')[0].get_config()
2389
except errors.NotBranchError:
2390
c = config.GlobalConfig()
2392
self.outf.write(c.user_email() + '\n')
2394
self.outf.write(c.username() + '\n')
2397
# display a warning if an email address isn't included in the given name.
2399
config.extract_email_address(name)
2400
except errors.NoEmailInUsername, e:
2401
warning('"%s" does not seem to contain an email address. '
2402
'This is allowed, but not recommended.', name)
2404
# use global config unless --branch given
2406
c = Branch.open_containing('.')[0].get_config()
2408
c = config.GlobalConfig()
2409
c.set_user_option('email', name)
2412
class cmd_nick(Command):
2413
"""Print or set the branch nickname.
2415
If unset, the tree root directory name is used as the nickname
2416
To print the current nickname, execute with no argument.
2419
_see_also = ['info']
2420
takes_args = ['nickname?']
2421
def run(self, nickname=None):
2422
branch = Branch.open_containing(u'.')[0]
2423
if nickname is None:
2424
self.printme(branch)
2426
branch.nick = nickname
2429
def printme(self, branch):
2433
class cmd_selftest(Command):
2434
"""Run internal test suite.
2436
If arguments are given, they are regular expressions that say which tests
2437
should run. Tests matching any expression are run, and other tests are
2440
Alternatively if --first is given, matching tests are run first and then
2441
all other tests are run. This is useful if you have been working in a
2442
particular area, but want to make sure nothing else was broken.
2444
If --exclude is given, tests that match that regular expression are
2445
excluded, regardless of whether they match --first or not.
2447
To help catch accidential dependencies between tests, the --randomize
2448
option is useful. In most cases, the argument used is the word 'now'.
2449
Note that the seed used for the random number generator is displayed
2450
when this option is used. The seed can be explicitly passed as the
2451
argument to this option if required. This enables reproduction of the
2452
actual ordering used if and when an order sensitive problem is encountered.
2454
If --list-only is given, the tests that would be run are listed. This is
2455
useful when combined with --first, --exclude and/or --randomize to
2456
understand their impact. The test harness reports "Listed nn tests in ..."
2457
instead of "Ran nn tests in ..." when list mode is enabled.
2459
If the global option '--no-plugins' is given, plugins are not loaded
2460
before running the selftests. This has two effects: features provided or
2461
modified by plugins will not be tested, and tests provided by plugins will
2464
Tests that need working space on disk use a common temporary directory,
2465
typically inside $TMPDIR or /tmp.
2468
Run only tests relating to 'ignore'::
2472
Disable plugins and list tests as they're run::
2474
bzr --no-plugins selftest -v
2476
# NB: this is used from the class without creating an instance, which is
2477
# why it does not have a self parameter.
2478
def get_transport_type(typestring):
2479
"""Parse and return a transport specifier."""
2480
if typestring == "sftp":
2481
from bzrlib.transport.sftp import SFTPAbsoluteServer
2482
return SFTPAbsoluteServer
2483
if typestring == "memory":
2484
from bzrlib.transport.memory import MemoryServer
2486
if typestring == "fakenfs":
2487
from bzrlib.transport.fakenfs import FakeNFSServer
2488
return FakeNFSServer
2489
msg = "No known transport type %s. Supported types are: sftp\n" %\
2491
raise errors.BzrCommandError(msg)
2494
takes_args = ['testspecs*']
2495
takes_options = ['verbose',
2497
help='Stop when one test fails.',
2501
help='Use a different transport by default '
2502
'throughout the test suite.',
2503
type=get_transport_type),
2505
help='Run the benchmarks rather than selftests.'),
2506
Option('lsprof-timed',
2507
help='Generate lsprof output for benchmarked'
2508
' sections of code.'),
2509
Option('cache-dir', type=str,
2510
help='Cache intermediate benchmark output in this '
2513
help='Run all tests, but run specified tests first.',
2517
help='List the tests instead of running them.'),
2518
Option('randomize', type=str, argname="SEED",
2519
help='Randomize the order of tests using the given'
2520
' seed or "now" for the current time.'),
2521
Option('exclude', type=str, argname="PATTERN",
2523
help='Exclude tests that match this regular'
2525
Option('strict', help='Fail on missing dependencies or '
2528
encoding_type = 'replace'
2530
def run(self, testspecs_list=None, verbose=None, one=False,
2531
transport=None, benchmark=None,
2532
lsprof_timed=None, cache_dir=None,
2533
first=False, list_only=False,
2534
randomize=None, exclude=None, strict=False):
2536
from bzrlib.tests import selftest
2537
import bzrlib.benchmarks as benchmarks
2538
from bzrlib.benchmarks import tree_creator
2539
from bzrlib.version import show_version
2541
if cache_dir is not None:
2542
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2544
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2545
print ' %s (%s python%s)' % (
2547
bzrlib.version_string,
2548
'.'.join(map(str, sys.version_info)),
2551
if testspecs_list is not None:
2552
pattern = '|'.join(testspecs_list)
2556
test_suite_factory = benchmarks.test_suite
2559
# TODO: should possibly lock the history file...
2560
benchfile = open(".perf_history", "at", buffering=1)
2562
test_suite_factory = None
2567
result = selftest(verbose=verbose,
2569
stop_on_failure=one,
2570
transport=transport,
2571
test_suite_factory=test_suite_factory,
2572
lsprof_timed=lsprof_timed,
2573
bench_history=benchfile,
2574
matching_tests_first=first,
2575
list_only=list_only,
2576
random_seed=randomize,
2577
exclude_pattern=exclude,
2581
if benchfile is not None:
2584
info('tests passed')
2586
info('tests failed')
2587
return int(not result)
2590
class cmd_version(Command):
2591
"""Show version of bzr."""
2595
from bzrlib.version import show_version
2599
class cmd_rocks(Command):
2600
"""Statement of optimism."""
2606
print "It sure does!"
2609
class cmd_find_merge_base(Command):
2610
"""Find and print a base revision for merging two branches."""
2611
# TODO: Options to specify revisions on either side, as if
2612
# merging only part of the history.
2613
takes_args = ['branch', 'other']
2617
def run(self, branch, other):
2618
from bzrlib.revision import ensure_null, MultipleRevisionSources
2620
branch1 = Branch.open_containing(branch)[0]
2621
branch2 = Branch.open_containing(other)[0]
2623
last1 = ensure_null(branch1.last_revision())
2624
last2 = ensure_null(branch2.last_revision())
2626
graph = branch1.repository.get_graph(branch2.repository)
2627
base_rev_id = graph.find_unique_lca(last1, last2)
2629
print 'merge base is revision %s' % base_rev_id
2632
class cmd_merge(Command):
2633
"""Perform a three-way merge.
2635
The branch is the branch you will merge from. By default, it will merge
2636
the latest revision. If you specify a revision, that revision will be
2637
merged. If you specify two revisions, the first will be used as a BASE,
2638
and the second one as OTHER. Revision numbers are always relative to the
2641
By default, bzr will try to merge in all new work from the other
2642
branch, automatically determining an appropriate base. If this
2643
fails, you may need to give an explicit base.
2645
Merge will do its best to combine the changes in two branches, but there
2646
are some kinds of problems only a human can fix. When it encounters those,
2647
it will mark a conflict. A conflict means that you need to fix something,
2648
before you should commit.
2650
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2652
If there is no default branch set, the first merge will set it. After
2653
that, you can omit the branch to use the default. To change the
2654
default, use --remember. The value will only be saved if the remote
2655
location can be accessed.
2657
The results of the merge are placed into the destination working
2658
directory, where they can be reviewed (with bzr diff), tested, and then
2659
committed to record the result of the merge.
2661
merge refuses to run if there are any uncommitted changes, unless
2665
To merge the latest revision from bzr.dev::
2667
bzr merge ../bzr.dev
2669
To merge changes up to and including revision 82 from bzr.dev::
2671
bzr merge -r 82 ../bzr.dev
2673
To merge the changes introduced by 82, without previous changes::
2675
bzr merge -r 81..82 ../bzr.dev
2678
_see_also = ['update', 'remerge', 'status-flags']
2679
takes_args = ['branch?']
2683
help='Merge even if the destination tree has uncommitted changes.'),
2687
Option('show-base', help="Show base revision text in "
2689
Option('uncommitted', help='Apply uncommitted changes'
2690
' from a working copy, instead of branch changes.'),
2691
Option('pull', help='If the destination is already'
2692
' completely merged into the source, pull from the'
2693
' source rather than merging. When this happens,'
2694
' you do not need to commit the result.'),
2696
help='Branch to merge into, '
2697
'rather than the one containing the working directory.',
2703
def run(self, branch=None, revision=None, force=False, merge_type=None,
2704
show_base=False, reprocess=False, remember=False,
2705
uncommitted=False, pull=False,
2708
from bzrlib.tag import _merge_tags_if_possible
2709
# This is actually a branch (or merge-directive) *location*.
2713
if merge_type is None:
2714
merge_type = _mod_merge.Merge3Merger
2716
if directory is None: directory = u'.'
2717
possible_transports = []
2719
allow_pending = True
2720
verified = 'inapplicable'
2721
tree = WorkingTree.open_containing(directory)[0]
2722
change_reporter = delta._ChangeReporter(
2723
unversioned_filter=tree.is_ignored)
2726
pb = ui.ui_factory.nested_progress_bar()
2727
cleanups.append(pb.finished)
2729
cleanups.append(tree.unlock)
2730
if location is not None:
2731
mergeable, other_transport = _get_mergeable_helper(location)
2734
raise errors.BzrCommandError('Cannot use --uncommitted'
2735
' with bundles or merge directives.')
2737
if revision is not None:
2738
raise errors.BzrCommandError(
2739
'Cannot use -r with merge directives or bundles')
2740
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2742
possible_transports.append(other_transport)
2744
if merger is None and uncommitted:
2745
if revision is not None and len(revision) > 0:
2746
raise errors.BzrCommandError('Cannot use --uncommitted and'
2747
' --revision at the same time.')
2748
location = self._select_branch_location(tree, location)[0]
2749
other_tree, other_path = WorkingTree.open_containing(location)
2750
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2752
allow_pending = False
2755
merger, allow_pending = self._get_merger_from_branch(tree,
2756
location, revision, remember, possible_transports, pb)
2758
merger.merge_type = merge_type
2759
merger.reprocess = reprocess
2760
merger.show_base = show_base
2761
merger.change_reporter = change_reporter
2762
self.sanity_check_merger(merger)
2763
if (merger.base_rev_id == merger.other_rev_id and
2764
merger.other_rev_id != None):
2765
note('Nothing to do.')
2768
if merger.interesting_files is not None:
2769
raise BzrCommandError('Cannot pull individual files')
2770
if (merger.base_rev_id == tree.last_revision()):
2771
result = tree.pull(merger.other_branch, False,
2772
merger.other_rev_id)
2773
result.report(self.outf)
2775
merger.check_basis(not force)
2776
conflict_count = merger.do_merge()
2778
merger.set_pending()
2779
if verified == 'failed':
2780
warning('Preview patch does not match changes')
2781
if conflict_count != 0:
2786
for cleanup in reversed(cleanups):
2789
def sanity_check_merger(self, merger):
2790
if (merger.show_base and
2791
not merger.merge_type is _mod_merge.Merge3Merger):
2792
raise errors.BzrCommandError("Show-base is not supported for this"
2793
" merge type. %s" % merger.merge_type)
2794
if merger.reprocess and not merger.merge_type.supports_reprocess:
2795
raise errors.BzrCommandError("Conflict reduction is not supported"
2796
" for merge type %s." %
2798
if merger.reprocess and merger.show_base:
2799
raise errors.BzrCommandError("Cannot do conflict reduction and"
2802
def _get_merger_from_branch(self, tree, location, revision, remember,
2803
possible_transports, pb):
2804
"""Produce a merger from a location, assuming it refers to a branch."""
2805
from bzrlib.tag import _merge_tags_if_possible
2806
assert revision is None or len(revision) < 3
2807
# find the branch locations
2808
other_loc, location = self._select_branch_location(tree, location,
2810
if revision is not None and len(revision) == 2:
2811
base_loc, location = self._select_branch_location(tree, location,
2814
base_loc = other_loc
2816
other_branch, other_path = Branch.open_containing(other_loc,
2817
possible_transports)
2818
if base_loc == other_loc:
2819
base_branch = other_branch
2821
base_branch, base_path = Branch.open_containing(base_loc,
2822
possible_transports)
2823
# Find the revision ids
2824
if revision is None or len(revision) < 1 or revision[-1] is None:
2825
other_revision_id = _mod_revision.ensure_null(
2826
other_branch.last_revision())
2828
other_revision_id = \
2829
_mod_revision.ensure_null(
2830
revision[-1].in_history(other_branch).rev_id)
2831
if (revision is not None and len(revision) == 2
2832
and revision[0] is not None):
2833
base_revision_id = \
2834
_mod_revision.ensure_null(
2835
revision[0].in_history(base_branch).rev_id)
2837
base_revision_id = None
2838
# Remember where we merge from
2839
if ((tree.branch.get_parent() is None or remember) and
2840
other_branch is not None):
2841
tree.branch.set_parent(other_branch.base)
2842
_merge_tags_if_possible(other_branch, tree.branch)
2843
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2844
other_revision_id, base_revision_id, other_branch, base_branch)
2845
if other_path != '':
2846
allow_pending = False
2847
merger.interesting_files = [other_path]
2849
allow_pending = True
2850
return merger, allow_pending
2852
def _select_branch_location(self, tree, location, revision=None,
2854
"""Select a branch location, according to possible inputs.
2856
If provided, branches from ``revision`` are preferred. (Both
2857
``revision`` and ``index`` must be supplied.)
2859
Otherwise, the ``location`` parameter is used. If it is None, then the
2860
``parent`` location is used, and a note is printed.
2862
:param tree: The working tree to select a branch for merging into
2863
:param location: The location entered by the user
2864
:param revision: The revision parameter to the command
2865
:param index: The index to use for the revision parameter. Negative
2866
indices are permitted.
2867
:return: (selected_location, default_location). The default location
2868
will be the user-entered location, if any, or else the remembered
2871
if (revision is not None and index is not None
2872
and revision[index] is not None):
2873
branch = revision[index].get_branch()
2874
if branch is not None:
2875
return branch, location
2876
location = self._get_remembered_parent(tree, location, 'Merging from')
2877
return location, location
2879
# TODO: move up to common parent; this isn't merge-specific anymore.
2880
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2881
"""Use tree.branch's parent if none was supplied.
2883
Report if the remembered location was used.
2885
if supplied_location is not None:
2886
return supplied_location
2887
stored_location = tree.branch.get_parent()
2888
mutter("%s", stored_location)
2889
if stored_location is None:
2890
raise errors.BzrCommandError("No location specified or remembered")
2891
display_url = urlutils.unescape_for_display(stored_location,
2893
self.outf.write("%s remembered location %s\n" % (verb_string,
2895
return stored_location
2898
class cmd_remerge(Command):
2901
Use this if you want to try a different merge technique while resolving
2902
conflicts. Some merge techniques are better than others, and remerge
2903
lets you try different ones on different files.
2905
The options for remerge have the same meaning and defaults as the ones for
2906
merge. The difference is that remerge can (only) be run when there is a
2907
pending merge, and it lets you specify particular files.
2910
Re-do the merge of all conflicted files, and show the base text in
2911
conflict regions, in addition to the usual THIS and OTHER texts::
2913
bzr remerge --show-base
2915
Re-do the merge of "foobar", using the weave merge algorithm, with
2916
additional processing to reduce the size of conflict regions::
2918
bzr remerge --merge-type weave --reprocess foobar
2920
takes_args = ['file*']
2925
help="Show base revision text in conflicts."),
2928
def run(self, file_list=None, merge_type=None, show_base=False,
2930
if merge_type is None:
2931
merge_type = _mod_merge.Merge3Merger
2932
tree, file_list = tree_files(file_list)
2935
parents = tree.get_parent_ids()
2936
if len(parents) != 2:
2937
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2938
" merges. Not cherrypicking or"
2940
repository = tree.branch.repository
2941
graph = repository.get_graph()
2942
base_revision = graph.find_unique_lca(parents[0], parents[1])
2943
base_tree = repository.revision_tree(base_revision)
2944
other_tree = repository.revision_tree(parents[1])
2945
interesting_ids = None
2947
conflicts = tree.conflicts()
2948
if file_list is not None:
2949
interesting_ids = set()
2950
for filename in file_list:
2951
file_id = tree.path2id(filename)
2953
raise errors.NotVersionedError(filename)
2954
interesting_ids.add(file_id)
2955
if tree.kind(file_id) != "directory":
2958
for name, ie in tree.inventory.iter_entries(file_id):
2959
interesting_ids.add(ie.file_id)
2960
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2962
# Remerge only supports resolving contents conflicts
2963
allowed_conflicts = ('text conflict', 'contents conflict')
2964
restore_files = [c.path for c in conflicts
2965
if c.typestring in allowed_conflicts]
2966
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2967
tree.set_conflicts(ConflictList(new_conflicts))
2968
if file_list is not None:
2969
restore_files = file_list
2970
for filename in restore_files:
2972
restore(tree.abspath(filename))
2973
except errors.NotConflicted:
2975
# Disable pending merges, because the file texts we are remerging
2976
# have not had those merges performed. If we use the wrong parents
2977
# list, we imply that the working tree text has seen and rejected
2978
# all the changes from the other tree, when in fact those changes
2979
# have not yet been seen.
2980
tree.set_parent_ids(parents[:1])
2982
conflicts = _mod_merge.merge_inner(
2983
tree.branch, other_tree, base_tree,
2985
interesting_ids=interesting_ids,
2986
other_rev_id=parents[1],
2987
merge_type=merge_type,
2988
show_base=show_base,
2989
reprocess=reprocess)
2991
tree.set_parent_ids(parents)
3000
class cmd_revert(Command):
3001
"""Revert files to a previous revision.
3003
Giving a list of files will revert only those files. Otherwise, all files
3004
will be reverted. If the revision is not specified with '--revision', the
3005
last committed revision is used.
3007
To remove only some changes, without reverting to a prior version, use
3008
merge instead. For example, "merge . --r-2..-3" will remove the changes
3009
introduced by -2, without affecting the changes introduced by -1. Or
3010
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3012
By default, any files that have been manually changed will be backed up
3013
first. (Files changed only by merge are not backed up.) Backup files have
3014
'.~#~' appended to their name, where # is a number.
3016
When you provide files, you can use their current pathname or the pathname
3017
from the target revision. So you can use revert to "undelete" a file by
3018
name. If you name a directory, all the contents of that directory will be
3022
_see_also = ['cat', 'export']
3025
Option('no-backup', "Do not save backups of reverted files."),
3027
takes_args = ['file*']
3029
def run(self, revision=None, no_backup=False, file_list=None):
3030
if file_list is not None:
3031
if len(file_list) == 0:
3032
raise errors.BzrCommandError("No files specified")
3036
tree, file_list = tree_files(file_list)
3037
if revision is None:
3038
# FIXME should be tree.last_revision
3039
rev_id = tree.last_revision()
3040
elif len(revision) != 1:
3041
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3043
rev_id = revision[0].in_history(tree.branch).rev_id
3044
pb = ui.ui_factory.nested_progress_bar()
3046
tree.revert(file_list,
3047
tree.branch.repository.revision_tree(rev_id),
3048
not no_backup, pb, report_changes=True)
3053
class cmd_assert_fail(Command):
3054
"""Test reporting of assertion failures"""
3055
# intended just for use in testing
3060
raise AssertionError("always fails")
3063
class cmd_help(Command):
3064
"""Show help on a command or other topic.
3067
_see_also = ['topics']
3069
Option('long', 'Show help on all commands.'),
3071
takes_args = ['topic?']
3072
aliases = ['?', '--help', '-?', '-h']
3075
def run(self, topic=None, long=False):
3077
if topic is None and long:
3079
bzrlib.help.help(topic)
3082
class cmd_shell_complete(Command):
3083
"""Show appropriate completions for context.
3085
For a list of all available commands, say 'bzr shell-complete'.
3087
takes_args = ['context?']
3092
def run(self, context=None):
3093
import shellcomplete
3094
shellcomplete.shellcomplete(context)
3097
class cmd_fetch(Command):
3098
"""Copy in history from another branch but don't merge it.
3100
This is an internal method used for pull and merge.
3103
takes_args = ['from_branch', 'to_branch']
3104
def run(self, from_branch, to_branch):
3105
from bzrlib.fetch import Fetcher
3106
from_b = Branch.open(from_branch)
3107
to_b = Branch.open(to_branch)
3108
Fetcher(to_b, from_b)
3111
class cmd_missing(Command):
3112
"""Show unmerged/unpulled revisions between two branches.
3114
OTHER_BRANCH may be local or remote.
3117
_see_also = ['merge', 'pull']
3118
takes_args = ['other_branch?']
3120
Option('reverse', 'Reverse the order of revisions.'),
3122
'Display changes in the local branch only.'),
3123
Option('this' , 'Same as --mine-only.'),
3124
Option('theirs-only',
3125
'Display changes in the remote branch only.'),
3126
Option('other', 'Same as --theirs-only.'),
3131
encoding_type = 'replace'
3134
def run(self, other_branch=None, reverse=False, mine_only=False,
3135
theirs_only=False, log_format=None, long=False, short=False, line=False,
3136
show_ids=False, verbose=False, this=False, other=False):
3137
from bzrlib.missing import find_unmerged, iter_log_revisions
3138
from bzrlib.log import log_formatter
3145
local_branch = Branch.open_containing(u".")[0]
3146
parent = local_branch.get_parent()
3147
if other_branch is None:
3148
other_branch = parent
3149
if other_branch is None:
3150
raise errors.BzrCommandError("No peer location known"
3152
display_url = urlutils.unescape_for_display(parent,
3154
self.outf.write("Using last location: " + display_url + "\n")
3156
remote_branch = Branch.open(other_branch)
3157
if remote_branch.base == local_branch.base:
3158
remote_branch = local_branch
3159
local_branch.lock_read()
3161
remote_branch.lock_read()
3163
local_extra, remote_extra = find_unmerged(local_branch,
3165
if log_format is None:
3166
registry = log.log_formatter_registry
3167
log_format = registry.get_default(local_branch)
3168
lf = log_format(to_file=self.outf,
3170
show_timezone='original')
3171
if reverse is False:
3172
local_extra.reverse()
3173
remote_extra.reverse()
3174
if local_extra and not theirs_only:
3175
self.outf.write("You have %d extra revision(s):\n" %
3177
for revision in iter_log_revisions(local_extra,
3178
local_branch.repository,
3180
lf.log_revision(revision)
3181
printed_local = True
3183
printed_local = False
3184
if remote_extra and not mine_only:
3185
if printed_local is True:
3186
self.outf.write("\n\n\n")
3187
self.outf.write("You are missing %d revision(s):\n" %
3189
for revision in iter_log_revisions(remote_extra,
3190
remote_branch.repository,
3192
lf.log_revision(revision)
3193
if not remote_extra and not local_extra:
3195
self.outf.write("Branches are up to date.\n")
3199
remote_branch.unlock()
3201
local_branch.unlock()
3202
if not status_code and parent is None and other_branch is not None:
3203
local_branch.lock_write()
3205
# handle race conditions - a parent might be set while we run.
3206
if local_branch.get_parent() is None:
3207
local_branch.set_parent(remote_branch.base)
3209
local_branch.unlock()
3213
class cmd_pack(Command):
3214
"""Compress the data within a repository."""
3216
_see_also = ['repositories']
3217
takes_args = ['branch_or_repo?']
3219
def run(self, branch_or_repo='.'):
3220
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3222
branch = dir.open_branch()
3223
repository = branch.repository
3224
except errors.NotBranchError:
3225
repository = dir.open_repository()
3229
class cmd_plugins(Command):
3230
"""List the installed plugins.
3232
This command displays the list of installed plugins including the
3233
path where each one is located and a short description of each.
3235
A plugin is an external component for Bazaar that extends the
3236
revision control system, by adding or replacing code in Bazaar.
3237
Plugins can do a variety of things, including overriding commands,
3238
adding new commands, providing additional network transports and
3239
customizing log output.
3241
See the Bazaar web site, http://bazaar-vcs.org, for further
3242
information on plugins including where to find them and how to
3243
install them. Instructions are also provided there on how to
3244
write new plugins using the Python programming language.
3249
import bzrlib.plugin
3250
from inspect import getdoc
3251
for name, plugin in bzrlib.plugin.plugins().items():
3252
print plugin.path(), "[%s]" % plugin.__version__
3253
d = getdoc(plugin.module)
3255
print '\t', d.split('\n')[0]
3258
class cmd_testament(Command):
3259
"""Show testament (signing-form) of a revision."""
3262
Option('long', help='Produce long-format testament.'),
3264
help='Produce a strict-format testament.')]
3265
takes_args = ['branch?']
3267
def run(self, branch=u'.', revision=None, long=False, strict=False):
3268
from bzrlib.testament import Testament, StrictTestament
3270
testament_class = StrictTestament
3272
testament_class = Testament
3273
b = WorkingTree.open_containing(branch)[0].branch
3276
if revision is None:
3277
rev_id = b.last_revision()
3279
rev_id = revision[0].in_history(b).rev_id
3280
t = testament_class.from_revision(b.repository, rev_id)
3282
sys.stdout.writelines(t.as_text_lines())
3284
sys.stdout.write(t.as_short_text())
3289
class cmd_annotate(Command):
3290
"""Show the origin of each line in a file.
3292
This prints out the given file with an annotation on the left side
3293
indicating which revision, author and date introduced the change.
3295
If the origin is the same for a run of consecutive lines, it is
3296
shown only at the top, unless the --all option is given.
3298
# TODO: annotate directories; showing when each file was last changed
3299
# TODO: if the working copy is modified, show annotations on that
3300
# with new uncommitted lines marked
3301
aliases = ['ann', 'blame', 'praise']
3302
takes_args = ['filename']
3303
takes_options = [Option('all', help='Show annotations on all lines.'),
3304
Option('long', help='Show commit date in annotations.'),
3308
encoding_type = 'exact'
3311
def run(self, filename, all=False, long=False, revision=None,
3313
from bzrlib.annotate import annotate_file
3314
tree, relpath = WorkingTree.open_containing(filename)
3315
branch = tree.branch
3318
if revision is None:
3319
revision_id = branch.last_revision()
3320
elif len(revision) != 1:
3321
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3323
revision_id = revision[0].in_history(branch).rev_id
3324
file_id = tree.path2id(relpath)
3326
raise errors.NotVersionedError(filename)
3327
tree = branch.repository.revision_tree(revision_id)
3328
file_version = tree.inventory[file_id].revision
3329
annotate_file(branch, file_version, file_id, long, all, self.outf,
3335
class cmd_re_sign(Command):
3336
"""Create a digital signature for an existing revision."""
3337
# TODO be able to replace existing ones.
3339
hidden = True # is this right ?
3340
takes_args = ['revision_id*']
3341
takes_options = ['revision']
3343
def run(self, revision_id_list=None, revision=None):
3344
import bzrlib.gpg as gpg
3345
if revision_id_list is not None and revision is not None:
3346
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3347
if revision_id_list is None and revision is None:
3348
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3349
b = WorkingTree.open_containing(u'.')[0].branch
3350
gpg_strategy = gpg.GPGStrategy(b.get_config())
3351
if revision_id_list is not None:
3352
for revision_id in revision_id_list:
3353
b.repository.sign_revision(revision_id, gpg_strategy)
3354
elif revision is not None:
3355
if len(revision) == 1:
3356
revno, rev_id = revision[0].in_history(b)
3357
b.repository.sign_revision(rev_id, gpg_strategy)
3358
elif len(revision) == 2:
3359
# are they both on rh- if so we can walk between them
3360
# might be nice to have a range helper for arbitrary
3361
# revision paths. hmm.
3362
from_revno, from_revid = revision[0].in_history(b)
3363
to_revno, to_revid = revision[1].in_history(b)
3364
if to_revid is None:
3365
to_revno = b.revno()
3366
if from_revno is None or to_revno is None:
3367
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3368
for revno in range(from_revno, to_revno + 1):
3369
b.repository.sign_revision(b.get_rev_id(revno),
3372
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3375
class cmd_bind(Command):
3376
"""Convert the current branch into a checkout of the supplied branch.
3378
Once converted into a checkout, commits must succeed on the master branch
3379
before they will be applied to the local branch.
3382
_see_also = ['checkouts', 'unbind']
3383
takes_args = ['location?']
3386
def run(self, location=None):
3387
b, relpath = Branch.open_containing(u'.')
3388
if location is None:
3390
location = b.get_old_bound_location()
3391
except errors.UpgradeRequired:
3392
raise errors.BzrCommandError('No location supplied. '
3393
'This format does not remember old locations.')
3395
if location is None:
3396
raise errors.BzrCommandError('No location supplied and no '
3397
'previous location known')
3398
b_other = Branch.open(location)
3401
except errors.DivergedBranches:
3402
raise errors.BzrCommandError('These branches have diverged.'
3403
' Try merging, and then bind again.')
3406
class cmd_unbind(Command):
3407
"""Convert the current checkout into a regular branch.
3409
After unbinding, the local branch is considered independent and subsequent
3410
commits will be local only.
3413
_see_also = ['checkouts', 'bind']
3418
b, relpath = Branch.open_containing(u'.')
3420
raise errors.BzrCommandError('Local branch is not bound')
3423
class cmd_uncommit(Command):
3424
"""Remove the last committed revision.
3426
--verbose will print out what is being removed.
3427
--dry-run will go through all the motions, but not actually
3430
If --revision is specified, uncommit revisions to leave the branch at the
3431
specified revision. For example, "bzr uncommit -r 15" will leave the
3432
branch at revision 15.
3434
In the future, uncommit will create a revision bundle, which can then
3438
# TODO: jam 20060108 Add an option to allow uncommit to remove
3439
# unreferenced information in 'branch-as-repository' branches.
3440
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3441
# information in shared branches as well.
3442
_see_also = ['commit']
3443
takes_options = ['verbose', 'revision',
3444
Option('dry-run', help='Don\'t actually make changes.'),
3445
Option('force', help='Say yes to all questions.')]
3446
takes_args = ['location?']
3449
def run(self, location=None,
3450
dry_run=False, verbose=False,
3451
revision=None, force=False):
3452
from bzrlib.log import log_formatter, show_log
3454
from bzrlib.uncommit import uncommit
3456
if location is None:
3458
control, relpath = bzrdir.BzrDir.open_containing(location)
3460
tree = control.open_workingtree()
3462
except (errors.NoWorkingTree, errors.NotLocalUrl):
3464
b = control.open_branch()
3467
if revision is None:
3470
# 'bzr uncommit -r 10' actually means uncommit
3471
# so that the final tree is at revno 10.
3472
# but bzrlib.uncommit.uncommit() actually uncommits
3473
# the revisions that are supplied.
3474
# So we need to offset it by one
3475
revno = revision[0].in_history(b).revno+1
3477
if revno <= b.revno():
3478
rev_id = b.get_rev_id(revno)
3480
self.outf.write('No revisions to uncommit.\n')
3483
lf = log_formatter('short',
3485
show_timezone='original')
3490
direction='forward',
3491
start_revision=revno,
3492
end_revision=b.revno())
3495
print 'Dry-run, pretending to remove the above revisions.'
3497
val = raw_input('Press <enter> to continue')
3499
print 'The above revision(s) will be removed.'
3501
val = raw_input('Are you sure [y/N]? ')
3502
if val.lower() not in ('y', 'yes'):
3506
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3510
class cmd_break_lock(Command):
3511
"""Break a dead lock on a repository, branch or working directory.
3513
CAUTION: Locks should only be broken when you are sure that the process
3514
holding the lock has been stopped.
3516
You can get information on what locks are open via the 'bzr info' command.
3521
takes_args = ['location?']
3523
def run(self, location=None, show=False):
3524
if location is None:
3526
control, relpath = bzrdir.BzrDir.open_containing(location)
3528
control.break_lock()
3529
except NotImplementedError:
3533
class cmd_wait_until_signalled(Command):
3534
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3536
This just prints a line to signal when it is ready, then blocks on stdin.
3542
sys.stdout.write("running\n")
3544
sys.stdin.readline()
3547
class cmd_serve(Command):
3548
"""Run the bzr server."""
3550
aliases = ['server']
3554
help='Serve on stdin/out for use from inetd or sshd.'),
3556
help='Listen for connections on nominated port of the form '
3557
'[hostname:]portnumber. Passing 0 as the port number will '
3558
'result in a dynamically allocated port. The default port is '
3562
help='Serve contents of this directory.',
3564
Option('allow-writes',
3565
help='By default the server is a readonly server. Supplying '
3566
'--allow-writes enables write access to the contents of '
3567
'the served directory and below.'
3571
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3572
from bzrlib.smart import medium, server
3573
from bzrlib.transport import get_transport
3574
from bzrlib.transport.chroot import ChrootServer
3575
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3576
if directory is None:
3577
directory = os.getcwd()
3578
url = urlutils.local_path_to_url(directory)
3579
if not allow_writes:
3580
url = 'readonly+' + url
3581
chroot_server = ChrootServer(get_transport(url))
3582
chroot_server.setUp()
3583
t = get_transport(chroot_server.get_url())
3585
smart_server = medium.SmartServerPipeStreamMedium(
3586
sys.stdin, sys.stdout, t)
3588
host = BZR_DEFAULT_INTERFACE
3590
port = BZR_DEFAULT_PORT
3593
host, port = port.split(':')
3595
smart_server = server.SmartTCPServer(t, host=host, port=port)
3596
print 'listening on port: ', smart_server.port
3598
# for the duration of this server, no UI output is permitted.
3599
# note that this may cause problems with blackbox tests. This should
3600
# be changed with care though, as we dont want to use bandwidth sending
3601
# progress over stderr to smart server clients!
3602
old_factory = ui.ui_factory
3604
ui.ui_factory = ui.SilentUIFactory()
3605
smart_server.serve()
3607
ui.ui_factory = old_factory
3610
class cmd_join(Command):
3611
"""Combine a subtree into its containing tree.
3613
This command is for experimental use only. It requires the target tree
3614
to be in dirstate-with-subtree format, which cannot be converted into
3617
The TREE argument should be an independent tree, inside another tree, but
3618
not part of it. (Such trees can be produced by "bzr split", but also by
3619
running "bzr branch" with the target inside a tree.)
3621
The result is a combined tree, with the subtree no longer an independant
3622
part. This is marked as a merge of the subtree into the containing tree,
3623
and all history is preserved.
3625
If --reference is specified, the subtree retains its independence. It can
3626
be branched by itself, and can be part of multiple projects at the same
3627
time. But operations performed in the containing tree, such as commit
3628
and merge, will recurse into the subtree.
3631
_see_also = ['split']
3632
takes_args = ['tree']
3634
Option('reference', help='Join by reference.'),
3638
def run(self, tree, reference=False):
3639
sub_tree = WorkingTree.open(tree)
3640
parent_dir = osutils.dirname(sub_tree.basedir)
3641
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3642
repo = containing_tree.branch.repository
3643
if not repo.supports_rich_root():
3644
raise errors.BzrCommandError(
3645
"Can't join trees because %s doesn't support rich root data.\n"
3646
"You can use bzr upgrade on the repository."
3650
containing_tree.add_reference(sub_tree)
3651
except errors.BadReferenceTarget, e:
3652
# XXX: Would be better to just raise a nicely printable
3653
# exception from the real origin. Also below. mbp 20070306
3654
raise errors.BzrCommandError("Cannot join %s. %s" %
3658
containing_tree.subsume(sub_tree)
3659
except errors.BadSubsumeSource, e:
3660
raise errors.BzrCommandError("Cannot join %s. %s" %
3664
class cmd_split(Command):
3665
"""Split a tree into two trees.
3667
This command is for experimental use only. It requires the target tree
3668
to be in dirstate-with-subtree format, which cannot be converted into
3671
The TREE argument should be a subdirectory of a working tree. That
3672
subdirectory will be converted into an independent tree, with its own
3673
branch. Commits in the top-level tree will not apply to the new subtree.
3674
If you want that behavior, do "bzr join --reference TREE".
3677
_see_also = ['join']
3678
takes_args = ['tree']
3682
def run(self, tree):
3683
containing_tree, subdir = WorkingTree.open_containing(tree)
3684
sub_id = containing_tree.path2id(subdir)
3686
raise errors.NotVersionedError(subdir)
3688
containing_tree.extract(sub_id)
3689
except errors.RootNotRich:
3690
raise errors.UpgradeRequired(containing_tree.branch.base)
3694
class cmd_merge_directive(Command):
3695
"""Generate a merge directive for auto-merge tools.
3697
A directive requests a merge to be performed, and also provides all the
3698
information necessary to do so. This means it must either include a
3699
revision bundle, or the location of a branch containing the desired
3702
A submit branch (the location to merge into) must be supplied the first
3703
time the command is issued. After it has been supplied once, it will
3704
be remembered as the default.
3706
A public branch is optional if a revision bundle is supplied, but required
3707
if --diff or --plain is specified. It will be remembered as the default
3708
after the first use.
3711
takes_args = ['submit_branch?', 'public_branch?']
3715
_see_also = ['send']
3718
RegistryOption.from_kwargs('patch-type',
3719
'The type of patch to include in the directive.',
3721
value_switches=True,
3723
bundle='Bazaar revision bundle (default).',
3724
diff='Normal unified diff.',
3725
plain='No patch, just directive.'),
3726
Option('sign', help='GPG-sign the directive.'), 'revision',
3727
Option('mail-to', type=str,
3728
help='Instead of printing the directive, email to this address.'),
3729
Option('message', type=str, short_name='m',
3730
help='Message to use when committing this merge.')
3733
encoding_type = 'exact'
3735
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3736
sign=False, revision=None, mail_to=None, message=None):
3737
from bzrlib.revision import ensure_null, NULL_REVISION
3738
include_patch, include_bundle = {
3739
'plain': (False, False),
3740
'diff': (True, False),
3741
'bundle': (True, True),
3743
branch = Branch.open('.')
3744
stored_submit_branch = branch.get_submit_branch()
3745
if submit_branch is None:
3746
submit_branch = stored_submit_branch
3748
if stored_submit_branch is None:
3749
branch.set_submit_branch(submit_branch)
3750
if submit_branch is None:
3751
submit_branch = branch.get_parent()
3752
if submit_branch is None:
3753
raise errors.BzrCommandError('No submit branch specified or known')
3755
stored_public_branch = branch.get_public_branch()
3756
if public_branch is None:
3757
public_branch = stored_public_branch
3758
elif stored_public_branch is None:
3759
branch.set_public_branch(public_branch)
3760
if not include_bundle and public_branch is None:
3761
raise errors.BzrCommandError('No public branch specified or'
3763
base_revision_id = None
3764
if revision is not None:
3765
if len(revision) > 2:
3766
raise errors.BzrCommandError('bzr merge-directive takes '
3767
'at most two one revision identifiers')
3768
revision_id = revision[-1].in_history(branch).rev_id
3769
if len(revision) == 2:
3770
base_revision_id = revision[0].in_history(branch).rev_id
3771
base_revision_id = ensure_null(base_revision_id)
3773
revision_id = branch.last_revision()
3774
revision_id = ensure_null(revision_id)
3775
if revision_id == NULL_REVISION:
3776
raise errors.BzrCommandError('No revisions to bundle.')
3777
directive = merge_directive.MergeDirective2.from_objects(
3778
branch.repository, revision_id, time.time(),
3779
osutils.local_time_offset(), submit_branch,
3780
public_branch=public_branch, include_patch=include_patch,
3781
include_bundle=include_bundle, message=message,
3782
base_revision_id=base_revision_id)
3785
self.outf.write(directive.to_signed(branch))
3787
self.outf.writelines(directive.to_lines())
3789
message = directive.to_email(mail_to, branch, sign)
3790
s = SMTPConnection(branch.get_config())
3791
s.send_email(message)
3794
class cmd_send(Command):
3795
"""Mail or create a merge-directive for submiting changes.
3797
A merge directive provides many things needed for requesting merges:
3799
* A machine-readable description of the merge to perform
3801
* An optional patch that is a preview of the changes requested
3803
* An optional bundle of revision data, so that the changes can be applied
3804
directly from the merge directive, without retrieving data from a
3807
If --no-bundle is specified, then public_branch is needed (and must be
3808
up-to-date), so that the receiver can perform the merge using the
3809
public_branch. The public_branch is always included if known, so that
3810
people can check it later.
3812
The submit branch defaults to the parent, but can be overridden. Both
3813
submit branch and public branch will be remembered if supplied.
3815
If a public_branch is known for the submit_branch, that public submit
3816
branch is used in the merge instructions. This means that a local mirror
3817
can be used as your actual submit branch, once you have set public_branch
3820
Mail is sent using your preferred mail program. This should be transparent
3821
on Windows (it uses MAPI). On *nix, it requires the xdg-email utility. If
3822
the preferred client can't be found (or used), your editor will be used.
3824
To use a specific mail program, set the mail_client configuration option.
3825
(For Thunderbird 1.5, this works around some bugs.) Supported values are
3826
"thunderbird", "evolution", "editor", "xdg-email", "mapi", "kmail" and
3829
If mail is being sent, a to address is required. This can be supplied
3830
either on the commandline, or by setting the submit_to configuration
3833
Two formats are currently supported: "4" uses revision bundle format 4 and
3834
merge directive format 2. It is significantly faster and smaller than
3835
older formats. It is compatible with Bazaar 0.19 and later. It is the
3836
default. "0.9" uses revision bundle format 0.9 and merge directive
3837
format 1. It is compatible with Bazaar 0.12 - 0.18.
3840
encoding_type = 'exact'
3842
_see_also = ['merge', 'doc/configuration.txt']
3844
takes_args = ['submit_branch?', 'public_branch?']
3848
help='Do not include a bundle in the merge directive.'),
3849
Option('no-patch', help='Do not include a preview patch in the merge'
3852
help='Remember submit and public branch.'),
3854
help='Branch to generate the submission from, '
3855
'rather than the one containing the working directory.',
3858
Option('output', short_name='o', help='Write directive to this file.',
3860
Option('mail-to', help='Mail the request to this address.',
3864
RegistryOption.from_kwargs('format',
3865
'Use the specified output format.',
3866
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
3867
'0.9': 'Bundle format 0.9, Merge Directive 1',})
3870
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3871
no_patch=False, revision=None, remember=False, output=None,
3872
format='4', mail_to=None, message=None, **kwargs):
3873
return self._run(submit_branch, revision, public_branch, remember,
3874
format, no_bundle, no_patch, output,
3875
kwargs.get('from', '.'), mail_to, message)
3877
def _run(self, submit_branch, revision, public_branch, remember, format,
3878
no_bundle, no_patch, output, from_, mail_to, message):
3879
from bzrlib.revision import ensure_null, NULL_REVISION
3881
outfile = StringIO()
3885
outfile = open(output, 'wb')
3887
branch = Branch.open_containing(from_)[0]
3889
config = branch.get_config()
3891
mail_to = config.get_user_option('submit_to')
3893
raise errors.BzrCommandError('No mail-to address'
3895
mail_client = config.get_mail_client()
3896
if remember and submit_branch is None:
3897
raise errors.BzrCommandError(
3898
'--remember requires a branch to be specified.')
3899
stored_submit_branch = branch.get_submit_branch()
3900
remembered_submit_branch = False
3901
if submit_branch is None:
3902
submit_branch = stored_submit_branch
3903
remembered_submit_branch = True
3905
if stored_submit_branch is None or remember:
3906
branch.set_submit_branch(submit_branch)
3907
if submit_branch is None:
3908
submit_branch = branch.get_parent()
3909
remembered_submit_branch = True
3910
if submit_branch is None:
3911
raise errors.BzrCommandError('No submit branch known or'
3913
if remembered_submit_branch:
3914
note('Using saved location: %s', submit_branch)
3916
stored_public_branch = branch.get_public_branch()
3917
if public_branch is None:
3918
public_branch = stored_public_branch
3919
elif stored_public_branch is None or remember:
3920
branch.set_public_branch(public_branch)
3921
if no_bundle and public_branch is None:
3922
raise errors.BzrCommandError('No public branch specified or'
3924
base_revision_id = None
3926
if revision is not None:
3927
if len(revision) > 2:
3928
raise errors.BzrCommandError('bzr send takes '
3929
'at most two one revision identifiers')
3930
revision_id = revision[-1].in_history(branch).rev_id
3931
if len(revision) == 2:
3932
base_revision_id = revision[0].in_history(branch).rev_id
3933
if revision_id is None:
3934
revision_id = branch.last_revision()
3935
if revision_id == NULL_REVISION:
3936
raise errors.BzrCommandError('No revisions to submit.')
3938
directive = merge_directive.MergeDirective2.from_objects(
3939
branch.repository, revision_id, time.time(),
3940
osutils.local_time_offset(), submit_branch,
3941
public_branch=public_branch, include_patch=not no_patch,
3942
include_bundle=not no_bundle, message=message,
3943
base_revision_id=base_revision_id)
3944
elif format == '0.9':
3947
patch_type = 'bundle'
3949
raise errors.BzrCommandError('Format 0.9 does not'
3950
' permit bundle with no patch')
3956
directive = merge_directive.MergeDirective.from_objects(
3957
branch.repository, revision_id, time.time(),
3958
osutils.local_time_offset(), submit_branch,
3959
public_branch=public_branch, patch_type=patch_type,
3962
outfile.writelines(directive.to_lines())
3964
subject = '[MERGE] '
3965
if message is not None:
3968
revision = branch.repository.get_revision(revision_id)
3969
subject += revision.get_summary()
3970
mail_client.compose_merge_request(mail_to, subject,
3977
class cmd_bundle_revisions(cmd_send):
3979
"""Create a merge-directive for submiting changes.
3981
A merge directive provides many things needed for requesting merges:
3983
* A machine-readable description of the merge to perform
3985
* An optional patch that is a preview of the changes requested
3987
* An optional bundle of revision data, so that the changes can be applied
3988
directly from the merge directive, without retrieving data from a
3991
If --no-bundle is specified, then public_branch is needed (and must be
3992
up-to-date), so that the receiver can perform the merge using the
3993
public_branch. The public_branch is always included if known, so that
3994
people can check it later.
3996
The submit branch defaults to the parent, but can be overridden. Both
3997
submit branch and public branch will be remembered if supplied.
3999
If a public_branch is known for the submit_branch, that public submit
4000
branch is used in the merge instructions. This means that a local mirror
4001
can be used as your actual submit branch, once you have set public_branch
4004
Two formats are currently supported: "4" uses revision bundle format 4 and
4005
merge directive format 2. It is significantly faster and smaller than
4006
older formats. It is compatible with Bazaar 0.19 and later. It is the
4007
default. "0.9" uses revision bundle format 0.9 and merge directive
4008
format 1. It is compatible with Bazaar 0.12 - 0.18.
4013
help='Do not include a bundle in the merge directive.'),
4014
Option('no-patch', help='Do not include a preview patch in the merge'
4017
help='Remember submit and public branch.'),
4019
help='Branch to generate the submission from, '
4020
'rather than the one containing the working directory.',
4023
Option('output', short_name='o', help='Write directive to this file.',
4026
RegistryOption.from_kwargs('format',
4027
'Use the specified output format.',
4028
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4029
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4031
aliases = ['bundle']
4033
_see_also = ['send', 'merge']
4037
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4038
no_patch=False, revision=None, remember=False, output=None,
4039
format='4', **kwargs):
4042
return self._run(submit_branch, revision, public_branch, remember,
4043
format, no_bundle, no_patch, output,
4044
kwargs.get('from', '.'), None, None)
4047
class cmd_tag(Command):
4048
"""Create, remove or modify a tag naming a revision.
4050
Tags give human-meaningful names to revisions. Commands that take a -r
4051
(--revision) option can be given -rtag:X, where X is any previously
4054
Tags are stored in the branch. Tags are copied from one branch to another
4055
along when you branch, push, pull or merge.
4057
It is an error to give a tag name that already exists unless you pass
4058
--force, in which case the tag is moved to point to the new revision.
4061
_see_also = ['commit', 'tags']
4062
takes_args = ['tag_name']
4065
help='Delete this tag rather than placing it.',
4068
help='Branch in which to place the tag.',
4073
help='Replace existing tags.',
4078
def run(self, tag_name,
4084
branch, relpath = Branch.open_containing(directory)
4088
branch.tags.delete_tag(tag_name)
4089
self.outf.write('Deleted tag %s.\n' % tag_name)
4092
if len(revision) != 1:
4093
raise errors.BzrCommandError(
4094
"Tags can only be placed on a single revision, "
4096
revision_id = revision[0].in_history(branch).rev_id
4098
revision_id = branch.last_revision()
4099
if (not force) and branch.tags.has_tag(tag_name):
4100
raise errors.TagAlreadyExists(tag_name)
4101
branch.tags.set_tag(tag_name, revision_id)
4102
self.outf.write('Created tag %s.\n' % tag_name)
4107
class cmd_tags(Command):
4110
This tag shows a table of tag names and the revisions they reference.
4116
help='Branch whose tags should be displayed.',
4126
branch, relpath = Branch.open_containing(directory)
4127
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
4128
self.outf.write('%-20s %s\n' % (tag_name, target))
4131
def _create_prefix(cur_transport):
4132
needed = [cur_transport]
4133
# Recurse upwards until we can create a directory successfully
4135
new_transport = cur_transport.clone('..')
4136
if new_transport.base == cur_transport.base:
4137
raise errors.BzrCommandError(
4138
"Failed to create path prefix for %s."
4139
% cur_transport.base)
4141
new_transport.mkdir('.')
4142
except errors.NoSuchFile:
4143
needed.append(new_transport)
4144
cur_transport = new_transport
4147
# Now we only need to create child directories
4149
cur_transport = needed.pop()
4150
cur_transport.ensure_base()
4153
def _get_mergeable_helper(location):
4154
"""Get a merge directive or bundle if 'location' points to one.
4156
Try try to identify a bundle and returns its mergeable form. If it's not,
4157
we return the tried transport anyway so that it can reused to access the
4160
:param location: can point to a bundle or a branch.
4162
:return: mergeable, transport
4165
url = urlutils.normalize_url(location)
4166
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4167
location_transport = transport.get_transport(url)
4170
# There may be redirections but we ignore the intermediate
4171
# and final transports used
4172
read = bundle.read_mergeable_from_transport
4173
mergeable, t = read(location_transport, filename)
4174
except errors.NotABundle:
4175
# Continue on considering this url a Branch but adjust the
4176
# location_transport
4177
location_transport = location_transport.clone(filename)
4178
return mergeable, location_transport
4181
# these get imported and then picked up by the scan for cmd_*
4182
# TODO: Some more consistent way to split command definitions across files;
4183
# we do need to load at least some information about them to know of
4184
# aliases. ideally we would avoid loading the implementation until the
4185
# details were needed.
4186
from bzrlib.cmd_version_info import cmd_version_info
4187
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4188
from bzrlib.bundle.commands import (
4191
from bzrlib.sign_my_commits import cmd_sign_my_commits
4192
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4193
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
