1
# Copyright (C) 2004, 2005, 2006 by 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"""
26
from bzrlib.branch import Branch
27
import bzrlib.bzrdir as bzrdir
28
from bzrlib.commands import Command, display_command
29
import bzrlib.errors as errors
30
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError,
31
NotBranchError, DivergedBranches, NotConflicted,
32
NoSuchFile, NoWorkingTree, FileInWrongBranch,
34
from bzrlib.log import show_one_log
35
from bzrlib.merge import Merge3Merger
36
from bzrlib.option import Option
37
from bzrlib.progress import DummyProgress, ProgressPhase
38
from bzrlib.revision import common_ancestor
39
from bzrlib.revisionspec import RevisionSpec
41
from bzrlib.trace import mutter, note, log_error, warning, is_quiet
42
from bzrlib.transport.local import LocalTransport
44
from bzrlib.workingtree import WorkingTree
47
def tree_files(file_list, default_branch=u'.'):
49
return internal_tree_files(file_list, default_branch)
50
except FileInWrongBranch, e:
51
raise BzrCommandError("%s is not in the same branch as %s" %
52
(e.path, file_list[0]))
55
# XXX: Bad function name; should possibly also be a class method of
56
# WorkingTree rather than a function.
57
def internal_tree_files(file_list, default_branch=u'.'):
58
"""Convert command-line paths to a WorkingTree and relative paths.
60
This is typically used for command-line processors that take one or
61
more filenames, and infer the workingtree that contains them.
63
The filenames given are not required to exist.
65
:param file_list: Filenames to convert.
67
:param default_branch: Fallback tree path to use if file_list is empty or None.
69
:return: workingtree, [relative_paths]
71
if file_list is None or len(file_list) == 0:
72
return WorkingTree.open_containing(default_branch)[0], file_list
73
tree = WorkingTree.open_containing(file_list[0])[0]
75
for filename in file_list:
77
new_list.append(tree.relpath(filename))
78
except errors.PathNotChild:
79
raise FileInWrongBranch(tree.branch, filename)
83
def get_format_type(typestring):
84
"""Parse and return a format specifier."""
85
if typestring == "weave":
86
return bzrdir.BzrDirFormat6()
87
if typestring == "default":
88
return bzrdir.BzrDirMetaFormat1()
89
if typestring == "metaweave":
90
format = bzrdir.BzrDirMetaFormat1()
91
format.repository_format = bzrlib.repository.RepositoryFormat7()
93
if typestring == "knit":
94
format = bzrdir.BzrDirMetaFormat1()
95
format.repository_format = bzrlib.repository.RepositoryFormatKnit1()
97
msg = "Unknown bzr format %s. Current formats are: default, knit,\n" \
98
"metaweave and weave" % typestring
99
raise BzrCommandError(msg)
102
# TODO: Make sure no commands unconditionally use the working directory as a
103
# branch. If a filename argument is used, the first of them should be used to
104
# specify the branch. (Perhaps this can be factored out into some kind of
105
# Argument class, representing a file in a branch, where the first occurrence
108
class cmd_status(Command):
109
"""Display status summary.
111
This reports on versioned and unknown files, reporting them
112
grouped by state. Possible states are:
115
Versioned in the working copy but not in the previous revision.
118
Versioned in the previous revision but removed or deleted
122
Path of this file changed from the previous revision;
123
the text may also have changed. This includes files whose
124
parent directory was renamed.
127
Text has changed since the previous revision.
130
Nothing about this file has changed since the previous revision.
131
Only shown with --all.
134
Not versioned and not matching an ignore pattern.
136
To see ignored files use 'bzr ignored'. For details in the
137
changes to file texts, use 'bzr diff'.
139
If no arguments are specified, the status of the entire working
140
directory is shown. Otherwise, only the status of the specified
141
files or directories is reported. If a directory is given, status
142
is reported for everything inside that directory.
144
If a revision argument is given, the status is calculated against
145
that revision, or between two revisions if two are provided.
148
# TODO: --no-recurse, --recurse options
150
takes_args = ['file*']
151
takes_options = ['all', 'show-ids', 'revision']
152
aliases = ['st', 'stat']
155
def run(self, all=False, show_ids=False, file_list=None, revision=None):
156
tree, file_list = tree_files(file_list)
158
from bzrlib.status import show_tree_status
159
show_tree_status(tree, show_unchanged=all, show_ids=show_ids,
160
specific_files=file_list, revision=revision)
163
class cmd_cat_revision(Command):
164
"""Write out metadata for a revision.
166
The revision to print can either be specified by a specific
167
revision identifier, or you can use --revision.
171
takes_args = ['revision_id?']
172
takes_options = ['revision']
175
def run(self, revision_id=None, revision=None):
177
if revision_id is not None and revision is not None:
178
raise BzrCommandError('You can only supply one of revision_id or --revision')
179
if revision_id is None and revision is None:
180
raise BzrCommandError('You must supply either --revision or a revision_id')
181
b = WorkingTree.open_containing(u'.')[0].branch
182
if revision_id is not None:
183
sys.stdout.write(b.repository.get_revision_xml(revision_id))
184
elif revision is not None:
187
raise BzrCommandError('You cannot specify a NULL revision.')
188
revno, rev_id = rev.in_history(b)
189
sys.stdout.write(b.repository.get_revision_xml(rev_id))
192
class cmd_revno(Command):
193
"""Show current revision number.
195
This is equal to the number of revisions on this branch."""
196
takes_args = ['location?']
198
def run(self, location=u'.'):
199
print Branch.open_containing(location)[0].revno()
202
class cmd_revision_info(Command):
203
"""Show revision number and revision id for a given revision identifier.
206
takes_args = ['revision_info*']
207
takes_options = ['revision']
209
def run(self, revision=None, revision_info_list=[]):
212
if revision is not None:
213
revs.extend(revision)
214
if revision_info_list is not None:
215
for rev in revision_info_list:
216
revs.append(RevisionSpec(rev))
218
raise BzrCommandError('You must supply a revision identifier')
220
b = WorkingTree.open_containing(u'.')[0].branch
223
revinfo = rev.in_history(b)
224
if revinfo.revno is None:
225
print ' %s' % revinfo.rev_id
227
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
230
class cmd_add(Command):
231
"""Add specified files or directories.
233
In non-recursive mode, all the named items are added, regardless
234
of whether they were previously ignored. A warning is given if
235
any of the named files are already versioned.
237
In recursive mode (the default), files are treated the same way
238
but the behaviour for directories is different. Directories that
239
are already versioned do not give a warning. All directories,
240
whether already versioned or not, are searched for files or
241
subdirectories that are neither versioned or ignored, and these
242
are added. This search proceeds recursively into versioned
243
directories. If no names are given '.' is assumed.
245
Therefore simply saying 'bzr add' will version all files that
246
are currently unknown.
248
Adding a file whose parent directory is not versioned will
249
implicitly add the parent, and so on up to the root. This means
250
you should never need to explictly add a directory, they'll just
251
get added when you add a file in the directory.
253
--dry-run will show which files would be added, but not actually
256
takes_args = ['file*']
257
takes_options = ['no-recurse', 'dry-run', 'verbose']
259
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False):
264
# This is pointless, but I'd rather not raise an error
265
action = bzrlib.add.add_action_null
267
action = bzrlib.add.add_action_print
269
action = bzrlib.add.add_action_add
271
action = bzrlib.add.add_action_add_and_print
273
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
277
for glob in sorted(ignored.keys()):
278
for path in ignored[glob]:
279
print "ignored %s matching \"%s\"" % (path, glob)
282
for glob, paths in ignored.items():
283
match_len += len(paths)
284
print "ignored %d file(s)." % match_len
285
print "If you wish to add some of these files, please add them"\
289
class cmd_mkdir(Command):
290
"""Create a new versioned directory.
292
This is equivalent to creating the directory and then adding it.
294
takes_args = ['dir+']
296
def run(self, dir_list):
299
wt, dd = WorkingTree.open_containing(d)
304
class cmd_relpath(Command):
305
"""Show path of a file relative to root"""
306
takes_args = ['filename']
310
def run(self, filename):
311
tree, relpath = WorkingTree.open_containing(filename)
315
class cmd_inventory(Command):
316
"""Show inventory of the current working copy or a revision.
318
It is possible to limit the output to a particular entry
319
type using the --kind option. For example; --kind file.
321
takes_options = ['revision', 'show-ids', 'kind']
324
def run(self, revision=None, show_ids=False, kind=None):
325
if kind and kind not in ['file', 'directory', 'symlink']:
326
raise BzrCommandError('invalid kind specified')
327
tree = WorkingTree.open_containing(u'.')[0]
329
inv = tree.read_working_inventory()
331
if len(revision) > 1:
332
raise BzrCommandError('bzr inventory --revision takes'
333
' exactly one revision identifier')
334
inv = tree.branch.repository.get_revision_inventory(
335
revision[0].in_history(tree.branch).rev_id)
337
for path, entry in inv.entries():
338
if kind and kind != entry.kind:
341
print '%-50s %s' % (path, entry.file_id)
346
class cmd_mv(Command):
347
"""Move or rename a file.
350
bzr mv OLDNAME NEWNAME
351
bzr mv SOURCE... DESTINATION
353
If the last argument is a versioned directory, all the other names
354
are moved into it. Otherwise, there must be exactly two arguments
355
and the file is changed to a new name, which must not already exist.
357
Files cannot be moved between branches.
359
takes_args = ['names*']
360
aliases = ['move', 'rename']
362
def run(self, names_list):
363
if len(names_list) < 2:
364
raise BzrCommandError("missing file argument")
365
tree, rel_names = tree_files(names_list)
367
if os.path.isdir(names_list[-1]):
368
# move into existing directory
369
for pair in tree.move(rel_names[:-1], rel_names[-1]):
370
print "%s => %s" % pair
372
if len(names_list) != 2:
373
raise BzrCommandError('to mv multiple files the destination '
374
'must be a versioned directory')
375
tree.rename_one(rel_names[0], rel_names[1])
376
print "%s => %s" % (rel_names[0], rel_names[1])
379
class cmd_pull(Command):
380
"""Turn this branch into a mirror of another branch.
382
This command only works on branches that have not diverged. Branches are
383
considered diverged if the destination branch's most recent commit is one
384
that has not been merged (directly or indirectly) into the parent.
386
If branches have diverged, you can use 'bzr merge' to integrate the changes
387
from one into the other. Once one branch has merged, the other should
388
be able to pull it again.
390
If branches have diverged, you can use 'bzr merge' to pull the text changes
391
from one into the other. Once one branch has merged, the other should
392
be able to pull it again.
394
If you want to forget your local changes and just update your branch to
395
match the remote one, use pull --overwrite.
397
If there is no default location set, the first pull will set it. After
398
that, you can omit the location to use the default. To change the
399
default, use --remember.
401
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
402
takes_args = ['location?']
404
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
405
# FIXME: too much stuff is in the command class
407
tree_to = WorkingTree.open_containing(u'.')[0]
408
branch_to = tree_to.branch
409
except NoWorkingTree:
411
branch_to = Branch.open_containing(u'.')[0]
412
stored_loc = branch_to.get_parent()
414
if stored_loc is None:
415
raise BzrCommandError("No pull location known or specified.")
417
print "Using saved location: %s" % stored_loc
418
location = stored_loc
420
if branch_to.get_parent() is None or remember:
421
branch_to.set_parent(location)
423
branch_from = Branch.open(location)
427
elif len(revision) == 1:
428
rev_id = revision[0].in_history(branch_from).rev_id
430
raise BzrCommandError('bzr pull --revision takes one value.')
432
old_rh = branch_to.revision_history()
433
if tree_to is not None:
434
count = tree_to.pull(branch_from, overwrite, rev_id)
436
count = branch_to.pull(branch_from, overwrite, rev_id)
437
note('%d revision(s) pulled.' % (count,))
440
new_rh = branch_to.revision_history()
443
from bzrlib.log import show_changed_revisions
444
show_changed_revisions(branch_to, old_rh, new_rh)
447
class cmd_push(Command):
448
"""Update a mirror of this branch.
450
The target branch will not have its working tree populated because this
451
is both expensive, and is not supported on remote file systems.
453
Some smart servers or protocols *may* put the working tree in place in
456
This command only works on branches that have not diverged. Branches are
457
considered diverged if the destination branch's most recent commit is one
458
that has not been merged (directly or indirectly) by the source branch.
460
If branches have diverged, you can use 'bzr push --overwrite' to replace
461
the other branch completely, discarding its unmerged changes.
463
If you want to ensure you have the different changes in the other branch,
464
do a merge (see bzr help merge) from the other branch, and commit that.
465
After that you will be able to do a push without '--overwrite'.
467
If there is no default push location set, the first push will set it.
468
After that, you can omit the location to use the default. To change the
469
default, use --remember.
471
takes_options = ['remember', 'overwrite',
472
Option('create-prefix',
473
help='Create the path leading up to the branch '
474
'if it does not already exist')]
475
takes_args = ['location?']
477
def run(self, location=None, remember=False, overwrite=False,
478
create_prefix=False, verbose=False):
479
# FIXME: Way too big! Put this into a function called from the
481
from bzrlib.transport import get_transport
483
br_from = Branch.open_containing('.')[0]
484
stored_loc = br_from.get_push_location()
486
if stored_loc is None:
487
raise BzrCommandError("No push location known or specified.")
489
print "Using saved location: %s" % stored_loc
490
location = stored_loc
491
if br_from.get_push_location() is None or remember:
492
br_from.set_push_location(location)
494
dir_to = bzrlib.bzrdir.BzrDir.open(location)
495
br_to = dir_to.open_branch()
496
except NotBranchError:
498
transport = get_transport(location).clone('..')
499
if not create_prefix:
501
transport.mkdir(transport.relpath(location))
503
raise BzrCommandError("Parent directory of %s "
504
"does not exist." % location)
506
current = transport.base
507
needed = [(transport, transport.relpath(location))]
510
transport, relpath = needed[-1]
511
transport.mkdir(relpath)
514
new_transport = transport.clone('..')
515
needed.append((new_transport,
516
new_transport.relpath(transport.base)))
517
if new_transport.base == transport.base:
518
raise BzrCommandError("Could not create "
520
dir_to = br_from.bzrdir.clone(location)
521
br_to = dir_to.open_branch()
522
count = len(br_to.revision_history())
524
old_rh = br_to.revision_history()
527
tree_to = dir_to.open_workingtree()
528
except errors.NotLocalUrl:
529
warning('This transport does not update the working '
530
'tree of: %s' % (br_to.base,))
531
count = br_to.pull(br_from, overwrite)
532
except NoWorkingTree:
533
count = br_to.pull(br_from, overwrite)
535
count = tree_to.pull(br_from, overwrite)
536
except DivergedBranches:
537
raise BzrCommandError("These branches have diverged."
538
" Try a merge then push with overwrite.")
539
note('%d revision(s) pushed.' % (count,))
542
new_rh = br_to.revision_history()
545
from bzrlib.log import show_changed_revisions
546
show_changed_revisions(br_to, old_rh, new_rh)
549
class cmd_branch(Command):
550
"""Create a new copy of a branch.
552
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
553
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
555
To retrieve the branch as of a particular revision, supply the --revision
556
parameter, as in "branch foo/bar -r 5".
558
--basis is to speed up branching from remote branches. When specified, it
559
copies all the file-contents, inventory and revision data from the basis
560
branch before copying anything from the remote branch.
562
takes_args = ['from_location', 'to_location?']
563
takes_options = ['revision', 'basis']
564
aliases = ['get', 'clone']
566
def run(self, from_location, to_location=None, revision=None, basis=None):
567
from bzrlib.osutils import rmtree
570
elif len(revision) > 1:
571
raise BzrCommandError(
572
'bzr branch --revision takes exactly 1 revision value')
574
br_from = Branch.open(from_location)
576
if e.errno == errno.ENOENT:
577
raise BzrCommandError('Source location "%s" does not'
578
' exist.' % to_location)
583
if basis is not None:
584
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
587
if len(revision) == 1 and revision[0] is not None:
588
revision_id = revision[0].in_history(br_from)[1]
590
# FIXME - wt.last_revision, fallback to branch, fall back to
591
# None or perhaps NULL_REVISION to mean copy nothing
593
revision_id = br_from.last_revision()
594
if to_location is None:
595
to_location = os.path.basename(from_location.rstrip("/\\"))
598
name = os.path.basename(to_location) + '\n'
600
os.mkdir(to_location)
602
if e.errno == errno.EEXIST:
603
raise BzrCommandError('Target directory "%s" already'
604
' exists.' % to_location)
605
if e.errno == errno.ENOENT:
606
raise BzrCommandError('Parent of "%s" does not exist.' %
611
# preserve whatever source format we have.
612
dir = br_from.bzrdir.sprout(to_location, revision_id, basis_dir)
613
branch = dir.open_branch()
614
except bzrlib.errors.NoSuchRevision:
616
msg = "The branch %s has no revision %s." % (from_location, revision[0])
617
raise BzrCommandError(msg)
618
except bzrlib.errors.UnlistableBranch:
620
msg = "The branch %s cannot be used as a --basis" % (basis,)
621
raise BzrCommandError(msg)
623
branch.control_files.put_utf8('branch-name', name)
625
note('Branched %d revision(s).' % branch.revno())
630
class cmd_checkout(Command):
631
"""Create a new checkout of an existing branch.
633
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
634
the branch found in '.'. This is useful if you have removed the working tree
635
or if it was never created - i.e. if you pushed the branch to its current
638
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
639
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
641
To retrieve the branch as of a particular revision, supply the --revision
642
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
643
out of date [so you cannot commit] but it may be useful (i.e. to examine old
646
--basis is to speed up checking out from remote branches. When specified, it
647
uses the inventory and file contents from the basis branch in preference to the
648
branch being checked out.
650
takes_args = ['branch_location?', 'to_location?']
651
takes_options = ['revision', # , 'basis']
652
Option('lightweight',
653
help="perform a lightweight checkout. Lightweight "
654
"checkouts depend on access to the branch for "
655
"every operation. Normal checkouts can perform "
656
"common operations like diff and status without "
657
"such access, and also support local commits."
661
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
665
elif len(revision) > 1:
666
raise BzrCommandError(
667
'bzr checkout --revision takes exactly 1 revision value')
668
if branch_location is None:
669
branch_location = bzrlib.osutils.getcwd()
670
to_location = branch_location
671
source = Branch.open(branch_location)
672
if len(revision) == 1 and revision[0] is not None:
673
revision_id = revision[0].in_history(source)[1]
676
if to_location is None:
677
to_location = os.path.basename(branch_location.rstrip("/\\"))
678
# if the source and to_location are the same,
679
# and there is no working tree,
680
# then reconstitute a branch
681
if (bzrlib.osutils.abspath(to_location) ==
682
bzrlib.osutils.abspath(branch_location)):
684
source.bzrdir.open_workingtree()
685
except errors.NoWorkingTree:
686
source.bzrdir.create_workingtree()
689
os.mkdir(to_location)
691
if e.errno == errno.EEXIST:
692
raise BzrCommandError('Target directory "%s" already'
693
' exists.' % to_location)
694
if e.errno == errno.ENOENT:
695
raise BzrCommandError('Parent of "%s" does not exist.' %
699
old_format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
700
bzrlib.bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
703
checkout = bzrdir.BzrDirMetaFormat1().initialize(to_location)
704
bzrlib.branch.BranchReferenceFormat().initialize(checkout, source)
706
checkout_branch = bzrlib.bzrdir.BzrDir.create_branch_convenience(
707
to_location, force_new_tree=False)
708
checkout = checkout_branch.bzrdir
709
checkout_branch.bind(source)
710
if revision_id is not None:
711
rh = checkout_branch.revision_history()
712
checkout_branch.set_revision_history(rh[:rh.index(revision_id) + 1])
713
checkout.create_workingtree(revision_id)
715
bzrlib.bzrdir.BzrDirFormat.set_default_format(old_format)
718
class cmd_renames(Command):
719
"""Show list of renamed files.
721
# TODO: Option to show renames between two historical versions.
723
# TODO: Only show renames under dir, rather than in the whole branch.
724
takes_args = ['dir?']
727
def run(self, dir=u'.'):
728
tree = WorkingTree.open_containing(dir)[0]
729
old_inv = tree.basis_tree().inventory
730
new_inv = tree.read_working_inventory()
732
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
734
for old_name, new_name in renames:
735
print "%s => %s" % (old_name, new_name)
738
class cmd_update(Command):
739
"""Update a tree to have the latest code committed to its branch.
741
This will perform a merge into the working tree, and may generate
742
conflicts. If you have any local changes, you will still
743
need to commit them after the update for the update to be complete.
745
If you want to discard your local changes, you can just do a
746
'bzr revert' instead of 'bzr commit' after the update.
748
takes_args = ['dir?']
750
def run(self, dir='.'):
751
tree = WorkingTree.open_containing(dir)[0]
754
if tree.last_revision() == tree.branch.last_revision():
755
# may be up to date, check master too.
756
master = tree.branch.get_master_branch()
757
if master is None or master.last_revision == tree.last_revision():
758
note("Tree is up to date.")
760
conflicts = tree.update()
761
note('Updated to revision %d.' %
762
(tree.branch.revision_id_to_revno(tree.last_revision()),))
771
class cmd_info(Command):
772
"""Show information about a working tree, branch or repository.
774
This command will show all known locations and formats associated to the
775
tree, branch or repository. Statistical information is included with
778
Branches and working trees will also report any missing revisions.
780
takes_args = ['location?']
781
takes_options = ['verbose']
784
def run(self, location=None, verbose=False):
785
from bzrlib.info import show_bzrdir_info
786
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
790
class cmd_remove(Command):
791
"""Make a file unversioned.
793
This makes bzr stop tracking changes to a versioned file. It does
794
not delete the working copy.
796
takes_args = ['file+']
797
takes_options = ['verbose']
800
def run(self, file_list, verbose=False):
801
tree, file_list = tree_files(file_list)
802
tree.remove(file_list, verbose=verbose)
805
class cmd_file_id(Command):
806
"""Print file_id of a particular file or directory.
808
The file_id is assigned when the file is first added and remains the
809
same through all revisions where the file exists, even when it is
813
takes_args = ['filename']
815
def run(self, filename):
816
tree, relpath = WorkingTree.open_containing(filename)
817
i = tree.inventory.path2id(relpath)
819
raise BzrError("%r is not a versioned file" % filename)
824
class cmd_file_path(Command):
825
"""Print path of file_ids to a file or directory.
827
This prints one line for each directory down to the target,
828
starting at the branch root."""
830
takes_args = ['filename']
832
def run(self, filename):
833
tree, relpath = WorkingTree.open_containing(filename)
835
fid = inv.path2id(relpath)
837
raise BzrError("%r is not a versioned file" % filename)
838
for fip in inv.get_idpath(fid):
842
class cmd_reconcile(Command):
843
"""Reconcile bzr metadata in a branch.
845
This can correct data mismatches that may have been caused by
846
previous ghost operations or bzr upgrades. You should only
847
need to run this command if 'bzr check' or a bzr developer
848
advises you to run it.
850
If a second branch is provided, cross-branch reconciliation is
851
also attempted, which will check that data like the tree root
852
id which was not present in very early bzr versions is represented
853
correctly in both branches.
855
At the same time it is run it may recompress data resulting in
856
a potential saving in disk space or performance gain.
858
The branch *MUST* be on a listable system such as local disk or sftp.
860
takes_args = ['branch?']
862
def run(self, branch="."):
863
from bzrlib.reconcile import reconcile
864
dir = bzrlib.bzrdir.BzrDir.open(branch)
868
class cmd_revision_history(Command):
869
"""Display list of revision ids on this branch."""
873
branch = WorkingTree.open_containing(u'.')[0].branch
874
for patchid in branch.revision_history():
878
class cmd_ancestry(Command):
879
"""List all revisions merged into this branch."""
883
tree = WorkingTree.open_containing(u'.')[0]
885
# FIXME. should be tree.last_revision
886
revision_ids = b.repository.get_ancestry(b.last_revision())
887
assert revision_ids[0] == None
889
for revision_id in revision_ids:
893
class cmd_init(Command):
894
"""Make a directory into a versioned branch.
896
Use this to create an empty branch, or before importing an
899
If there is a repository in a parent directory of the location, then
900
the history of the branch will be stored in the repository. Otherwise
901
init creates a standalone branch which carries its own history in
904
If there is already a branch at the location but it has no working tree,
905
the tree can be populated with 'bzr checkout'.
907
Recipe for importing a tree of files:
912
bzr commit -m 'imported project'
914
takes_args = ['location?']
917
help='Specify a format for this branch. Current'
918
' formats are: default, knit, metaweave and'
919
' weave. Default is knit; metaweave and'
920
' weave are deprecated',
921
type=get_format_type),
923
def run(self, location=None, format=None):
924
from bzrlib.branch import Branch
926
format = get_format_type('default')
930
# The path has to exist to initialize a
931
# branch inside of it.
932
# Just using os.mkdir, since I don't
933
# believe that we want to create a bunch of
934
# locations if the user supplies an extended path
935
if not os.path.exists(location):
938
existing_bzrdir = bzrdir.BzrDir.open(location)
939
except NotBranchError:
940
# really a NotBzrDir error...
941
bzrdir.BzrDir.create_branch_convenience(location, format=format)
943
if existing_bzrdir.has_branch():
944
if existing_bzrdir.has_workingtree():
945
raise errors.AlreadyBranchError(location)
947
raise errors.BranchExistsWithoutWorkingTree(location)
949
existing_bzrdir.create_branch()
950
existing_bzrdir.create_workingtree()
953
class cmd_init_repository(Command):
954
"""Create a shared repository to hold branches.
956
New branches created under the repository directory will store their revisions
957
in the repository, not in the branch directory, if the branch format supports
963
bzr checkout --lightweight repo/trunk trunk-checkout
967
takes_args = ["location"]
968
takes_options = [Option('format',
969
help='Specify a format for this repository.'
970
' Current formats are: default, knit,'
971
' metaweave and weave. Default is knit;'
972
' metaweave and weave are deprecated',
973
type=get_format_type),
975
help='Allows branches in repository to have'
977
aliases = ["init-repo"]
978
def run(self, location, format=None, trees=False):
979
from bzrlib.transport import get_transport
981
format = get_format_type('default')
982
transport = get_transport(location)
983
if not transport.has('.'):
985
newdir = format.initialize_on_transport(transport)
986
repo = newdir.create_repository(shared=True)
987
repo.set_make_working_trees(trees)
990
class cmd_diff(Command):
991
"""Show differences in working tree.
993
If files are listed, only the changes in those files are listed.
994
Otherwise, all changes for the tree are listed.
996
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
997
produces patches suitable for "patch -p1".
1003
bzr diff --diff-prefix old/:new/
1004
bzr diff bzr.mine bzr.dev
1007
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1008
# or a graphical diff.
1010
# TODO: Python difflib is not exactly the same as unidiff; should
1011
# either fix it up or prefer to use an external diff.
1013
# TODO: Selected-file diff is inefficient and doesn't show you
1016
# TODO: This probably handles non-Unix newlines poorly.
1018
takes_args = ['file*']
1019
takes_options = ['revision', 'diff-options', 'prefix']
1020
aliases = ['di', 'dif']
1023
def run(self, revision=None, file_list=None, diff_options=None,
1025
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1027
if (prefix is None) or (prefix == '0'):
1035
if not ':' in prefix:
1036
raise BzrError("--diff-prefix expects two values separated by a colon")
1037
old_label, new_label = prefix.split(":")
1040
tree1, file_list = internal_tree_files(file_list)
1044
except FileInWrongBranch:
1045
if len(file_list) != 2:
1046
raise BzrCommandError("Files are in different branches")
1048
tree1, file1 = WorkingTree.open_containing(file_list[0])
1049
tree2, file2 = WorkingTree.open_containing(file_list[1])
1050
if file1 != "" or file2 != "":
1051
# FIXME diff those two files. rbc 20051123
1052
raise BzrCommandError("Files are in different branches")
1054
if revision is not None:
1055
if tree2 is not None:
1056
raise BzrCommandError("Can't specify -r with two branches")
1057
if (len(revision) == 1) or (revision[1].spec is None):
1058
return diff_cmd_helper(tree1, file_list, diff_options,
1060
old_label=old_label, new_label=new_label)
1061
elif len(revision) == 2:
1062
return diff_cmd_helper(tree1, file_list, diff_options,
1063
revision[0], revision[1],
1064
old_label=old_label, new_label=new_label)
1066
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
1068
if tree2 is not None:
1069
return show_diff_trees(tree1, tree2, sys.stdout,
1070
specific_files=file_list,
1071
external_diff_options=diff_options,
1072
old_label=old_label, new_label=new_label)
1074
return diff_cmd_helper(tree1, file_list, diff_options,
1075
old_label=old_label, new_label=new_label)
1078
class cmd_deleted(Command):
1079
"""List files deleted in the working tree.
1081
# TODO: Show files deleted since a previous revision, or
1082
# between two revisions.
1083
# TODO: Much more efficient way to do this: read in new
1084
# directories with readdir, rather than stating each one. Same
1085
# level of effort but possibly much less IO. (Or possibly not,
1086
# if the directories are very large...)
1088
def run(self, show_ids=False):
1089
tree = WorkingTree.open_containing(u'.')[0]
1090
old = tree.basis_tree()
1091
for path, ie in old.inventory.iter_entries():
1092
if not tree.has_id(ie.file_id):
1094
print '%-50s %s' % (path, ie.file_id)
1099
class cmd_modified(Command):
1100
"""List files modified in working tree."""
1104
from bzrlib.delta import compare_trees
1106
tree = WorkingTree.open_containing(u'.')[0]
1107
td = compare_trees(tree.basis_tree(), tree)
1109
for path, id, kind, text_modified, meta_modified in td.modified:
1114
class cmd_added(Command):
1115
"""List files added in working tree."""
1119
wt = WorkingTree.open_containing(u'.')[0]
1120
basis_inv = wt.basis_tree().inventory
1123
if file_id in basis_inv:
1125
path = inv.id2path(file_id)
1126
if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
1132
class cmd_root(Command):
1133
"""Show the tree root directory.
1135
The root is the nearest enclosing directory with a .bzr control
1137
takes_args = ['filename?']
1139
def run(self, filename=None):
1140
"""Print the branch root."""
1141
tree = WorkingTree.open_containing(filename)[0]
1145
class cmd_log(Command):
1146
"""Show log of a branch, file, or directory.
1148
By default show the log of the branch containing the working directory.
1150
To request a range of logs, you can use the command -r begin..end
1151
-r revision requests a specific revision, -r ..end or -r begin.. are
1157
bzr log -r -10.. http://server/branch
1160
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1162
takes_args = ['location?']
1163
takes_options = [Option('forward',
1164
help='show from oldest to newest'),
1167
help='show files changed in each revision'),
1168
'show-ids', 'revision',
1172
help='show revisions whose message matches this regexp',
1177
def run(self, location=None, timezone='original',
1187
from bzrlib.log import log_formatter, show_log
1189
assert message is None or isinstance(message, basestring), \
1190
"invalid message argument %r" % message
1191
direction = (forward and 'forward') or 'reverse'
1196
# find the file id to log:
1198
dir, fp = bzrdir.BzrDir.open_containing(location)
1199
b = dir.open_branch()
1203
inv = dir.open_workingtree().inventory
1204
except (errors.NotBranchError, errors.NotLocalUrl):
1205
# either no tree, or is remote.
1206
inv = b.basis_tree().inventory
1207
file_id = inv.path2id(fp)
1210
# FIXME ? log the current subdir only RBC 20060203
1211
dir, relpath = bzrdir.BzrDir.open_containing('.')
1212
b = dir.open_branch()
1214
if revision is None:
1217
elif len(revision) == 1:
1218
rev1 = rev2 = revision[0].in_history(b).revno
1219
elif len(revision) == 2:
1220
if revision[0].spec is None:
1221
# missing begin-range means first revision
1224
rev1 = revision[0].in_history(b).revno
1226
if revision[1].spec is None:
1227
# missing end-range means last known revision
1230
rev2 = revision[1].in_history(b).revno
1232
raise BzrCommandError('bzr log --revision takes one or two values.')
1234
# By this point, the revision numbers are converted to the +ve
1235
# form if they were supplied in the -ve form, so we can do
1236
# this comparison in relative safety
1238
(rev2, rev1) = (rev1, rev2)
1240
mutter('encoding log as %r', bzrlib.user_encoding)
1242
# use 'replace' so that we don't abort if trying to write out
1243
# in e.g. the default C locale.
1244
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1246
if (log_format == None):
1247
default = bzrlib.config.BranchConfig(b).log_format()
1248
log_format = get_log_format(long=long, short=short, line=line, default=default)
1250
lf = log_formatter(log_format,
1253
show_timezone=timezone)
1259
direction=direction,
1260
start_revision=rev1,
1265
def get_log_format(long=False, short=False, line=False, default='long'):
1266
log_format = default
1270
log_format = 'short'
1276
class cmd_touching_revisions(Command):
1277
"""Return revision-ids which affected a particular file.
1279
A more user-friendly interface is "bzr log FILE"."""
1281
takes_args = ["filename"]
1283
def run(self, filename):
1284
tree, relpath = WorkingTree.open_containing(filename)
1286
inv = tree.read_working_inventory()
1287
file_id = inv.path2id(relpath)
1288
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1289
print "%6d %s" % (revno, what)
1292
class cmd_ls(Command):
1293
"""List files in a tree.
1295
# TODO: Take a revision or remote path and list that tree instead.
1297
takes_options = ['verbose', 'revision',
1298
Option('non-recursive',
1299
help='don\'t recurse into sub-directories'),
1301
help='Print all paths from the root of the branch.'),
1302
Option('unknown', help='Print unknown files'),
1303
Option('versioned', help='Print versioned files'),
1304
Option('ignored', help='Print ignored files'),
1306
Option('null', help='Null separate the files'),
1309
def run(self, revision=None, verbose=False,
1310
non_recursive=False, from_root=False,
1311
unknown=False, versioned=False, ignored=False,
1314
if verbose and null:
1315
raise BzrCommandError('Cannot set both --verbose and --null')
1316
all = not (unknown or versioned or ignored)
1318
selection = {'I':ignored, '?':unknown, 'V':versioned}
1320
tree, relpath = WorkingTree.open_containing(u'.')
1325
if revision is not None:
1326
tree = tree.branch.repository.revision_tree(
1327
revision[0].in_history(tree.branch).rev_id)
1328
for fp, fc, kind, fid, entry in tree.list_files():
1329
if fp.startswith(relpath):
1330
fp = fp[len(relpath):]
1331
if non_recursive and '/' in fp:
1333
if not all and not selection[fc]:
1336
kindch = entry.kind_character()
1337
print '%-8s %s%s' % (fc, fp, kindch)
1339
sys.stdout.write(fp)
1340
sys.stdout.write('\0')
1346
class cmd_unknowns(Command):
1347
"""List unknown files."""
1350
from bzrlib.osutils import quotefn
1351
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1355
class cmd_ignore(Command):
1356
"""Ignore a command or pattern.
1358
To remove patterns from the ignore list, edit the .bzrignore file.
1360
If the pattern contains a slash, it is compared to the whole path
1361
from the branch root. Otherwise, it is compared to only the last
1362
component of the path. To match a file only in the root directory,
1365
Ignore patterns are case-insensitive on case-insensitive systems.
1367
Note: wildcards must be quoted from the shell on Unix.
1370
bzr ignore ./Makefile
1371
bzr ignore '*.class'
1373
# TODO: Complain if the filename is absolute
1374
takes_args = ['name_pattern']
1376
def run(self, name_pattern):
1377
from bzrlib.atomicfile import AtomicFile
1380
tree, relpath = WorkingTree.open_containing(u'.')
1381
ifn = tree.abspath('.bzrignore')
1383
if os.path.exists(ifn):
1386
igns = f.read().decode('utf-8')
1392
# TODO: If the file already uses crlf-style termination, maybe
1393
# we should use that for the newly added lines?
1395
if igns and igns[-1] != '\n':
1397
igns += name_pattern + '\n'
1400
f = AtomicFile(ifn, 'wt')
1401
f.write(igns.encode('utf-8'))
1406
inv = tree.inventory
1407
if inv.path2id('.bzrignore'):
1408
mutter('.bzrignore is already versioned')
1410
mutter('need to make new .bzrignore file versioned')
1411
tree.add(['.bzrignore'])
1414
class cmd_ignored(Command):
1415
"""List ignored files and the patterns that matched them.
1417
See also: bzr ignore"""
1420
tree = WorkingTree.open_containing(u'.')[0]
1421
for path, file_class, kind, file_id, entry in tree.list_files():
1422
if file_class != 'I':
1424
## XXX: Slightly inefficient since this was already calculated
1425
pat = tree.is_ignored(path)
1426
print '%-50s %s' % (path, pat)
1429
class cmd_lookup_revision(Command):
1430
"""Lookup the revision-id from a revision-number
1433
bzr lookup-revision 33
1436
takes_args = ['revno']
1439
def run(self, revno):
1443
raise BzrCommandError("not a valid revision-number: %r" % revno)
1445
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1448
class cmd_export(Command):
1449
"""Export past revision to destination directory.
1451
If no revision is specified this exports the last committed revision.
1453
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1454
given, try to find the format with the extension. If no extension
1455
is found exports to a directory (equivalent to --format=dir).
1457
Root may be the top directory for tar, tgz and tbz2 formats. If none
1458
is given, the top directory will be the root name of the file.
1460
Note: export of tree with non-ascii filenames to zip is not supported.
1462
Supported formats Autodetected by extension
1463
----------------- -------------------------
1466
tbz2 .tar.bz2, .tbz2
1470
takes_args = ['dest']
1471
takes_options = ['revision', 'format', 'root']
1472
def run(self, dest, revision=None, format=None, root=None):
1474
from bzrlib.export import export
1475
tree = WorkingTree.open_containing(u'.')[0]
1477
if revision is None:
1478
# should be tree.last_revision FIXME
1479
rev_id = b.last_revision()
1481
if len(revision) != 1:
1482
raise BzrError('bzr export --revision takes exactly 1 argument')
1483
rev_id = revision[0].in_history(b).rev_id
1484
t = b.repository.revision_tree(rev_id)
1486
export(t, dest, format, root)
1487
except errors.NoSuchExportFormat, e:
1488
raise BzrCommandError('Unsupported export format: %s' % e.format)
1491
class cmd_cat(Command):
1492
"""Write a file's text from a previous revision."""
1494
takes_options = ['revision']
1495
takes_args = ['filename']
1498
def run(self, filename, revision=None):
1499
if revision is not None and len(revision) != 1:
1500
raise BzrCommandError("bzr cat --revision takes exactly one number")
1503
tree, relpath = WorkingTree.open_containing(filename)
1505
except NotBranchError:
1509
b, relpath = Branch.open_containing(filename)
1510
if revision is None:
1511
revision_id = b.last_revision()
1513
revision_id = revision[0].in_history(b).rev_id
1514
b.print_file(relpath, revision_id)
1517
class cmd_local_time_offset(Command):
1518
"""Show the offset in seconds from GMT to local time."""
1522
print bzrlib.osutils.local_time_offset()
1526
class cmd_commit(Command):
1527
"""Commit changes into a new revision.
1529
If no arguments are given, the entire tree is committed.
1531
If selected files are specified, only changes to those files are
1532
committed. If a directory is specified then the directory and everything
1533
within it is committed.
1535
A selected-file commit may fail in some cases where the committed
1536
tree would be invalid, such as trying to commit a file in a
1537
newly-added directory that is not itself committed.
1539
# TODO: Run hooks on tree to-be-committed, and after commit.
1541
# TODO: Strict commit that fails if there are deleted files.
1542
# (what does "deleted files" mean ??)
1544
# TODO: Give better message for -s, --summary, used by tla people
1546
# XXX: verbose currently does nothing
1548
takes_args = ['selected*']
1549
takes_options = ['message', 'verbose',
1551
help='commit even if nothing has changed'),
1552
Option('file', type=str,
1554
help='file containing commit message'),
1556
help="refuse to commit if there are unknown "
1557
"files in the working tree."),
1559
help="perform a local only commit in a bound "
1560
"branch. Such commits are not pushed to "
1561
"the master branch until a normal commit "
1565
aliases = ['ci', 'checkin']
1567
def run(self, message=None, file=None, verbose=True, selected_list=None,
1568
unchanged=False, strict=False, local=False):
1569
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1570
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1572
from bzrlib.msgeditor import edit_commit_message, \
1573
make_commit_message_template
1574
from tempfile import TemporaryFile
1577
# TODO: Need a blackbox test for invoking the external editor; may be
1578
# slightly problematic to run this cross-platform.
1580
# TODO: do more checks that the commit will succeed before
1581
# spending the user's valuable time typing a commit message.
1583
# TODO: if the commit *does* happen to fail, then save the commit
1584
# message to a temporary file where it can be recovered
1585
tree, selected_list = tree_files(selected_list)
1586
if selected_list == ['']:
1587
# workaround - commit of root of tree should be exactly the same
1588
# as just default commit in that tree, and succeed even though
1589
# selected-file merge commit is not done yet
1592
if local and not tree.branch.get_bound_location():
1593
raise errors.LocalRequiresBoundBranch()
1594
if message is None and not file:
1595
template = make_commit_message_template(tree, selected_list)
1596
message = edit_commit_message(template)
1598
raise BzrCommandError("please specify a commit message"
1599
" with either --message or --file")
1600
elif message and file:
1601
raise BzrCommandError("please specify either --message or --file")
1605
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1608
raise BzrCommandError("empty commit message specified")
1611
reporter = ReportCommitToLog()
1613
reporter = NullCommitReporter()
1616
tree.commit(message, specific_files=selected_list,
1617
allow_pointless=unchanged, strict=strict, local=local,
1619
except PointlessCommit:
1620
# FIXME: This should really happen before the file is read in;
1621
# perhaps prepare the commit; get the message; then actually commit
1622
raise BzrCommandError("no changes to commit",
1623
["use --unchanged to commit anyhow"])
1624
except ConflictsInTree:
1625
raise BzrCommandError("Conflicts detected in working tree. "
1626
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1627
except StrictCommitFailed:
1628
raise BzrCommandError("Commit refused because there are unknown "
1629
"files in the working tree.")
1630
except errors.BoundBranchOutOfDate, e:
1631
raise BzrCommandError(str(e)
1632
+ ' Either unbind, update, or'
1633
' pass --local to commit.')
1636
class cmd_check(Command):
1637
"""Validate consistency of branch history.
1639
This command checks various invariants about the branch storage to
1640
detect data corruption or bzr bugs.
1642
takes_args = ['branch?']
1643
takes_options = ['verbose']
1645
def run(self, branch=None, verbose=False):
1646
from bzrlib.check import check
1648
tree = WorkingTree.open_containing()[0]
1649
branch = tree.branch
1651
branch = Branch.open(branch)
1652
check(branch, verbose)
1655
class cmd_scan_cache(Command):
1658
from bzrlib.hashcache import HashCache
1664
print '%6d stats' % c.stat_count
1665
print '%6d in hashcache' % len(c._cache)
1666
print '%6d files removed from cache' % c.removed_count
1667
print '%6d hashes updated' % c.update_count
1668
print '%6d files changed too recently to cache' % c.danger_count
1674
class cmd_upgrade(Command):
1675
"""Upgrade branch storage to current format.
1677
The check command or bzr developers may sometimes advise you to run
1678
this command. When the default format has changed you may also be warned
1679
during other operations to upgrade.
1681
takes_args = ['url?']
1684
help='Upgrade to a specific format. Current formats'
1685
' are: default, knit, metaweave and weave.'
1686
' Default is knit; metaweave and weave are'
1688
type=get_format_type),
1692
def run(self, url='.', format=None):
1693
from bzrlib.upgrade import upgrade
1695
format = get_format_type('default')
1696
upgrade(url, format)
1699
class cmd_whoami(Command):
1700
"""Show bzr user id."""
1701
takes_options = ['email']
1704
def run(self, email=False):
1706
b = WorkingTree.open_containing(u'.')[0].branch
1707
config = bzrlib.config.BranchConfig(b)
1708
except NotBranchError:
1709
config = bzrlib.config.GlobalConfig()
1712
print config.user_email()
1714
print config.username()
1717
class cmd_nick(Command):
1718
"""Print or set the branch nickname.
1720
If unset, the tree root directory name is used as the nickname
1721
To print the current nickname, execute with no argument.
1723
takes_args = ['nickname?']
1724
def run(self, nickname=None):
1725
branch = Branch.open_containing(u'.')[0]
1726
if nickname is None:
1727
self.printme(branch)
1729
branch.nick = nickname
1732
def printme(self, branch):
1736
class cmd_selftest(Command):
1737
"""Run internal test suite.
1739
This creates temporary test directories in the working directory,
1740
but not existing data is affected. These directories are deleted
1741
if the tests pass, or left behind to help in debugging if they
1742
fail and --keep-output is specified.
1744
If arguments are given, they are regular expressions that say
1745
which tests should run.
1747
If the global option '--no-plugins' is given, plugins are not loaded
1748
before running the selftests. This has two effects: features provided or
1749
modified by plugins will not be tested, and tests provided by plugins will
1754
bzr --no-plugins selftest -v
1756
# TODO: --list should give a list of all available tests
1758
# NB: this is used from the class without creating an instance, which is
1759
# why it does not have a self parameter.
1760
def get_transport_type(typestring):
1761
"""Parse and return a transport specifier."""
1762
if typestring == "sftp":
1763
from bzrlib.transport.sftp import SFTPAbsoluteServer
1764
return SFTPAbsoluteServer
1765
if typestring == "memory":
1766
from bzrlib.transport.memory import MemoryServer
1768
if typestring == "fakenfs":
1769
from bzrlib.transport.fakenfs import FakeNFSServer
1770
return FakeNFSServer
1771
msg = "No known transport type %s. Supported types are: sftp\n" %\
1773
raise BzrCommandError(msg)
1776
takes_args = ['testspecs*']
1777
takes_options = ['verbose',
1778
Option('one', help='stop when one test fails'),
1779
Option('keep-output',
1780
help='keep output directories when tests fail'),
1782
help='Use a different transport by default '
1783
'throughout the test suite.',
1784
type=get_transport_type),
1785
Option('benchmark', help='run the bzr bencharks.'),
1788
def run(self, testspecs_list=None, verbose=False, one=False,
1789
keep_output=False, transport=None, benchmark=None):
1791
from bzrlib.tests import selftest
1792
import bzrlib.benchmarks as benchmarks
1793
# we don't want progress meters from the tests to go to the
1794
# real output; and we don't want log messages cluttering up
1796
save_ui = bzrlib.ui.ui_factory
1797
print '%10s: %s' % ('bzr', bzrlib.osutils.realpath(sys.argv[0]))
1798
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
1800
bzrlib.trace.info('running tests...')
1802
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1803
if testspecs_list is not None:
1804
pattern = '|'.join(testspecs_list)
1808
test_suite_factory = benchmarks.test_suite
1810
test_suite_factory = None
1811
result = selftest(verbose=verbose,
1813
stop_on_failure=one,
1814
keep_output=keep_output,
1815
transport=transport,
1816
test_suite_factory=test_suite_factory)
1818
bzrlib.trace.info('tests passed')
1820
bzrlib.trace.info('tests failed')
1821
return int(not result)
1823
bzrlib.ui.ui_factory = save_ui
1826
def _get_bzr_branch():
1827
"""If bzr is run from a branch, return Branch or None"""
1828
import bzrlib.errors
1829
from bzrlib.branch import Branch
1830
from bzrlib.osutils import abspath
1831
from os.path import dirname
1834
branch = Branch.open(dirname(abspath(dirname(__file__))))
1836
except bzrlib.errors.BzrError:
1841
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1842
# is bzrlib itself in a branch?
1843
branch = _get_bzr_branch()
1845
rh = branch.revision_history()
1847
print " bzr checkout, revision %d" % (revno,)
1848
print " nick: %s" % (branch.nick,)
1850
print " revid: %s" % (rh[-1],)
1851
print bzrlib.__copyright__
1852
print "http://bazaar-vcs.org/"
1854
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1855
print "you may use, modify and redistribute it under the terms of the GNU"
1856
print "General Public License version 2 or later."
1859
class cmd_version(Command):
1860
"""Show version of bzr."""
1865
class cmd_rocks(Command):
1866
"""Statement of optimism."""
1870
print "it sure does!"
1873
class cmd_find_merge_base(Command):
1874
"""Find and print a base revision for merging two branches.
1876
# TODO: Options to specify revisions on either side, as if
1877
# merging only part of the history.
1878
takes_args = ['branch', 'other']
1882
def run(self, branch, other):
1883
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1885
branch1 = Branch.open_containing(branch)[0]
1886
branch2 = Branch.open_containing(other)[0]
1888
history_1 = branch1.revision_history()
1889
history_2 = branch2.revision_history()
1891
last1 = branch1.last_revision()
1892
last2 = branch2.last_revision()
1894
source = MultipleRevisionSources(branch1.repository,
1897
base_rev_id = common_ancestor(last1, last2, source)
1899
print 'merge base is revision %s' % base_rev_id
1903
if base_revno is None:
1904
raise bzrlib.errors.UnrelatedBranches()
1906
print ' r%-6d in %s' % (base_revno, branch)
1908
other_revno = branch2.revision_id_to_revno(base_revid)
1910
print ' r%-6d in %s' % (other_revno, other)
1914
class cmd_merge(Command):
1915
"""Perform a three-way merge.
1917
The branch is the branch you will merge from. By default, it will
1918
merge the latest revision. If you specify a revision, that
1919
revision will be merged. If you specify two revisions, the first
1920
will be used as a BASE, and the second one as OTHER. Revision
1921
numbers are always relative to the specified branch.
1923
By default, bzr will try to merge in all new work from the other
1924
branch, automatically determining an appropriate base. If this
1925
fails, you may need to give an explicit base.
1927
Merge will do its best to combine the changes in two branches, but there
1928
are some kinds of problems only a human can fix. When it encounters those,
1929
it will mark a conflict. A conflict means that you need to fix something,
1930
before you should commit.
1932
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
1934
If there is no default branch set, the first merge will set it. After
1935
that, you can omit the branch to use the default. To change the
1936
default, use --remember.
1940
To merge the latest revision from bzr.dev
1941
bzr merge ../bzr.dev
1943
To merge changes up to and including revision 82 from bzr.dev
1944
bzr merge -r 82 ../bzr.dev
1946
To merge the changes introduced by 82, without previous changes:
1947
bzr merge -r 81..82 ../bzr.dev
1949
merge refuses to run if there are any uncommitted changes, unless
1952
takes_args = ['branch?']
1953
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
1954
Option('show-base', help="Show base revision text in "
1957
def run(self, branch=None, revision=None, force=False, merge_type=None,
1958
show_base=False, reprocess=False, remember=False):
1959
if merge_type is None:
1960
merge_type = Merge3Merger
1962
tree = WorkingTree.open_containing(u'.')[0]
1963
stored_loc = tree.branch.get_parent()
1965
if stored_loc is None:
1966
raise BzrCommandError("No merge branch known or specified.")
1968
print "Using saved branch: %s" % stored_loc
1971
if tree.branch.get_parent() is None or remember:
1972
tree.branch.set_parent(branch)
1974
if revision is None or len(revision) < 1:
1976
other = [branch, -1]
1977
other_branch, path = Branch.open_containing(branch)
1979
if len(revision) == 1:
1981
other_branch, path = Branch.open_containing(branch)
1982
revno = revision[0].in_history(other_branch).revno
1983
other = [branch, revno]
1985
assert len(revision) == 2
1986
if None in revision:
1987
raise BzrCommandError(
1988
"Merge doesn't permit that revision specifier.")
1989
b, path = Branch.open_containing(branch)
1991
base = [branch, revision[0].in_history(b).revno]
1992
other = [branch, revision[1].in_history(b).revno]
1994
interesting_files = [path]
1996
interesting_files = None
1997
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2000
conflict_count = merge(other, base, check_clean=(not force),
2001
merge_type=merge_type,
2002
reprocess=reprocess,
2003
show_base=show_base,
2004
pb=pb, file_list=interesting_files)
2007
if conflict_count != 0:
2011
except bzrlib.errors.AmbiguousBase, e:
2012
m = ("sorry, bzr can't determine the right merge base yet\n"
2013
"candidates are:\n "
2014
+ "\n ".join(e.bases)
2016
"please specify an explicit base with -r,\n"
2017
"and (if you want) report this to the bzr developers\n")
2021
class cmd_remerge(Command):
2024
takes_args = ['file*']
2025
takes_options = ['merge-type', 'reprocess',
2026
Option('show-base', help="Show base revision text in "
2029
def run(self, file_list=None, merge_type=None, show_base=False,
2031
from bzrlib.merge import merge_inner, transform_tree
2032
if merge_type is None:
2033
merge_type = Merge3Merger
2034
tree, file_list = tree_files(file_list)
2037
pending_merges = tree.pending_merges()
2038
if len(pending_merges) != 1:
2039
raise BzrCommandError("Sorry, remerge only works after normal"
2040
+ " merges. Not cherrypicking or"
2042
repository = tree.branch.repository
2043
base_revision = common_ancestor(tree.branch.last_revision(),
2044
pending_merges[0], repository)
2045
base_tree = repository.revision_tree(base_revision)
2046
other_tree = repository.revision_tree(pending_merges[0])
2047
interesting_ids = None
2048
if file_list is not None:
2049
interesting_ids = set()
2050
for filename in file_list:
2051
file_id = tree.path2id(filename)
2053
raise NotVersionedError(filename)
2054
interesting_ids.add(file_id)
2055
if tree.kind(file_id) != "directory":
2058
for name, ie in tree.inventory.iter_entries(file_id):
2059
interesting_ids.add(ie.file_id)
2060
transform_tree(tree, tree.basis_tree(), interesting_ids)
2061
if file_list is None:
2062
restore_files = list(tree.iter_conflicts())
2064
restore_files = file_list
2065
for filename in restore_files:
2067
restore(tree.abspath(filename))
2068
except NotConflicted:
2070
conflicts = merge_inner(tree.branch, other_tree, base_tree,
2072
interesting_ids = interesting_ids,
2073
other_rev_id=pending_merges[0],
2074
merge_type=merge_type,
2075
show_base=show_base,
2076
reprocess=reprocess)
2084
class cmd_revert(Command):
2085
"""Reverse all changes since the last commit.
2087
Only versioned files are affected. Specify filenames to revert only
2088
those files. By default, any files that are changed will be backed up
2089
first. Backup files have a '~' appended to their name.
2091
takes_options = ['revision', 'no-backup']
2092
takes_args = ['file*']
2093
aliases = ['merge-revert']
2095
def run(self, revision=None, no_backup=False, file_list=None):
2096
from bzrlib.commands import parse_spec
2097
if file_list is not None:
2098
if len(file_list) == 0:
2099
raise BzrCommandError("No files specified")
2103
tree, file_list = tree_files(file_list)
2104
if revision is None:
2105
# FIXME should be tree.last_revision
2106
rev_id = tree.last_revision()
2107
elif len(revision) != 1:
2108
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
2110
rev_id = revision[0].in_history(tree.branch).rev_id
2111
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2113
tree.revert(file_list,
2114
tree.branch.repository.revision_tree(rev_id),
2120
class cmd_assert_fail(Command):
2121
"""Test reporting of assertion failures"""
2124
assert False, "always fails"
2127
class cmd_help(Command):
2128
"""Show help on a command or other topic.
2130
For a list of all available commands, say 'bzr help commands'."""
2131
takes_options = [Option('long', 'show help on all commands')]
2132
takes_args = ['topic?']
2133
aliases = ['?', '--help', '-?', '-h']
2136
def run(self, topic=None, long=False):
2138
if topic is None and long:
2143
class cmd_shell_complete(Command):
2144
"""Show appropriate completions for context.
2146
For a list of all available commands, say 'bzr shell-complete'."""
2147
takes_args = ['context?']
2152
def run(self, context=None):
2153
import shellcomplete
2154
shellcomplete.shellcomplete(context)
2157
class cmd_fetch(Command):
2158
"""Copy in history from another branch but don't merge it.
2160
This is an internal method used for pull and merge."""
2162
takes_args = ['from_branch', 'to_branch']
2163
def run(self, from_branch, to_branch):
2164
from bzrlib.fetch import Fetcher
2165
from bzrlib.branch import Branch
2166
from_b = Branch.open(from_branch)
2167
to_b = Branch.open(to_branch)
2168
Fetcher(to_b, from_b)
2171
class cmd_missing(Command):
2172
"""Show unmerged/unpulled revisions between two branches.
2174
OTHER_BRANCH may be local or remote."""
2175
takes_args = ['other_branch?']
2176
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2178
'Display changes in the local branch only'),
2179
Option('theirs-only',
2180
'Display changes in the remote branch only'),
2189
def run(self, other_branch=None, reverse=False, mine_only=False,
2190
theirs_only=False, log_format=None, long=False, short=False, line=False,
2191
show_ids=False, verbose=False):
2192
from bzrlib.missing import find_unmerged, iter_log_data
2193
from bzrlib.log import log_formatter
2194
local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
2195
parent = local_branch.get_parent()
2196
if other_branch is None:
2197
other_branch = parent
2198
if other_branch is None:
2199
raise BzrCommandError("No missing location known or specified.")
2200
print "Using last location: " + local_branch.get_parent()
2201
remote_branch = bzrlib.branch.Branch.open(other_branch)
2202
if remote_branch.base == local_branch.base:
2203
remote_branch = local_branch
2204
local_branch.lock_read()
2206
remote_branch.lock_read()
2208
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2209
if (log_format == None):
2210
default = bzrlib.config.BranchConfig(local_branch).log_format()
2211
log_format = get_log_format(long=long, short=short, line=line, default=default)
2212
lf = log_formatter(log_format, sys.stdout,
2214
show_timezone='original')
2215
if reverse is False:
2216
local_extra.reverse()
2217
remote_extra.reverse()
2218
if local_extra and not theirs_only:
2219
print "You have %d extra revision(s):" % len(local_extra)
2220
for data in iter_log_data(local_extra, local_branch.repository,
2223
printed_local = True
2225
printed_local = False
2226
if remote_extra and not mine_only:
2227
if printed_local is True:
2229
print "You are missing %d revision(s):" % len(remote_extra)
2230
for data in iter_log_data(remote_extra, remote_branch.repository,
2233
if not remote_extra and not local_extra:
2235
print "Branches are up to date."
2239
remote_branch.unlock()
2241
local_branch.unlock()
2242
if not status_code and parent is None and other_branch is not None:
2243
local_branch.lock_write()
2245
# handle race conditions - a parent might be set while we run.
2246
if local_branch.get_parent() is None:
2247
local_branch.set_parent(other_branch)
2249
local_branch.unlock()
2253
class cmd_plugins(Command):
2258
import bzrlib.plugin
2259
from inspect import getdoc
2260
for name, plugin in bzrlib.plugin.all_plugins().items():
2261
if hasattr(plugin, '__path__'):
2262
print plugin.__path__[0]
2263
elif hasattr(plugin, '__file__'):
2264
print plugin.__file__
2270
print '\t', d.split('\n')[0]
2273
class cmd_testament(Command):
2274
"""Show testament (signing-form) of a revision."""
2275
takes_options = ['revision', 'long']
2276
takes_args = ['branch?']
2278
def run(self, branch=u'.', revision=None, long=False):
2279
from bzrlib.testament import Testament
2280
b = WorkingTree.open_containing(branch)[0].branch
2283
if revision is None:
2284
rev_id = b.last_revision()
2286
rev_id = revision[0].in_history(b).rev_id
2287
t = Testament.from_revision(b.repository, rev_id)
2289
sys.stdout.writelines(t.as_text_lines())
2291
sys.stdout.write(t.as_short_text())
2296
class cmd_annotate(Command):
2297
"""Show the origin of each line in a file.
2299
This prints out the given file with an annotation on the left side
2300
indicating which revision, author and date introduced the change.
2302
If the origin is the same for a run of consecutive lines, it is
2303
shown only at the top, unless the --all option is given.
2305
# TODO: annotate directories; showing when each file was last changed
2306
# TODO: if the working copy is modified, show annotations on that
2307
# with new uncommitted lines marked
2308
aliases = ['blame', 'praise']
2309
takes_args = ['filename']
2310
takes_options = [Option('all', help='show annotations on all lines'),
2311
Option('long', help='show date in annotations'),
2316
def run(self, filename, all=False, long=False, revision=None):
2317
from bzrlib.annotate import annotate_file
2318
tree, relpath = WorkingTree.open_containing(filename)
2319
branch = tree.branch
2322
if revision is None:
2323
revision_id = branch.last_revision()
2324
elif len(revision) != 1:
2325
raise BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2327
revision_id = revision[0].in_history(branch).rev_id
2328
file_id = tree.inventory.path2id(relpath)
2329
tree = branch.repository.revision_tree(revision_id)
2330
file_version = tree.inventory[file_id].revision
2331
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2336
class cmd_re_sign(Command):
2337
"""Create a digital signature for an existing revision."""
2338
# TODO be able to replace existing ones.
2340
hidden = True # is this right ?
2341
takes_args = ['revision_id*']
2342
takes_options = ['revision']
2344
def run(self, revision_id_list=None, revision=None):
2345
import bzrlib.config as config
2346
import bzrlib.gpg as gpg
2347
if revision_id_list is not None and revision is not None:
2348
raise BzrCommandError('You can only supply one of revision_id or --revision')
2349
if revision_id_list is None and revision is None:
2350
raise BzrCommandError('You must supply either --revision or a revision_id')
2351
b = WorkingTree.open_containing(u'.')[0].branch
2352
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
2353
if revision_id_list is not None:
2354
for revision_id in revision_id_list:
2355
b.repository.sign_revision(revision_id, gpg_strategy)
2356
elif revision is not None:
2357
if len(revision) == 1:
2358
revno, rev_id = revision[0].in_history(b)
2359
b.repository.sign_revision(rev_id, gpg_strategy)
2360
elif len(revision) == 2:
2361
# are they both on rh- if so we can walk between them
2362
# might be nice to have a range helper for arbitrary
2363
# revision paths. hmm.
2364
from_revno, from_revid = revision[0].in_history(b)
2365
to_revno, to_revid = revision[1].in_history(b)
2366
if to_revid is None:
2367
to_revno = b.revno()
2368
if from_revno is None or to_revno is None:
2369
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
2370
for revno in range(from_revno, to_revno + 1):
2371
b.repository.sign_revision(b.get_rev_id(revno),
2374
raise BzrCommandError('Please supply either one revision, or a range.')
2377
class cmd_bind(Command):
2378
"""Bind the current branch to a master branch.
2380
After binding, commits must succeed on the master branch
2381
before they are executed on the local one.
2384
takes_args = ['location']
2387
def run(self, location=None):
2388
b, relpath = Branch.open_containing(u'.')
2389
b_other = Branch.open(location)
2392
except DivergedBranches:
2393
raise BzrCommandError('These branches have diverged.'
2394
' Try merging, and then bind again.')
2397
class cmd_unbind(Command):
2398
"""Unbind the current branch from its master branch.
2400
After unbinding, the local branch is considered independent.
2401
All subsequent commits will be local.
2408
b, relpath = Branch.open_containing(u'.')
2410
raise BzrCommandError('Local branch is not bound')
2413
class cmd_uncommit(bzrlib.commands.Command):
2414
"""Remove the last committed revision.
2416
--verbose will print out what is being removed.
2417
--dry-run will go through all the motions, but not actually
2420
In the future, uncommit will create a changeset, which can then
2424
# TODO: jam 20060108 Add an option to allow uncommit to remove
2425
# unreferenced information in 'branch-as-repostory' branches.
2426
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2427
# information in shared branches as well.
2428
takes_options = ['verbose', 'revision',
2429
Option('dry-run', help='Don\'t actually make changes'),
2430
Option('force', help='Say yes to all questions.')]
2431
takes_args = ['location?']
2434
def run(self, location=None,
2435
dry_run=False, verbose=False,
2436
revision=None, force=False):
2437
from bzrlib.branch import Branch
2438
from bzrlib.log import log_formatter
2440
from bzrlib.uncommit import uncommit
2442
if location is None:
2444
control, relpath = bzrdir.BzrDir.open_containing(location)
2446
tree = control.open_workingtree()
2448
except (errors.NoWorkingTree, errors.NotLocalUrl):
2450
b = control.open_branch()
2452
if revision is None:
2454
rev_id = b.last_revision()
2456
revno, rev_id = revision[0].in_history(b)
2458
print 'No revisions to uncommit.'
2460
for r in range(revno, b.revno()+1):
2461
rev_id = b.get_rev_id(r)
2462
lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
2463
lf.show(r, b.repository.get_revision(rev_id), None)
2466
print 'Dry-run, pretending to remove the above revisions.'
2468
val = raw_input('Press <enter> to continue')
2470
print 'The above revision(s) will be removed.'
2472
val = raw_input('Are you sure [y/N]? ')
2473
if val.lower() not in ('y', 'yes'):
2477
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2481
class cmd_break_lock(Command):
2482
"""Break a dead lock on a repository, branch or working directory.
2484
CAUTION: Locks should only be broken when you are sure that the process
2485
holding the lock has been stopped.
2487
You can get information on what locks are open via the 'bzr info' command.
2492
takes_args = ['location?']
2494
def run(self, location=None, show=False):
2495
if location is None:
2497
control, relpath = bzrdir.BzrDir.open_containing(location)
2499
control.break_lock()
2500
except NotImplementedError:
2505
# command-line interpretation helper for merge-related commands
2506
def merge(other_revision, base_revision,
2507
check_clean=True, ignore_zero=False,
2508
this_dir=None, backup_files=False, merge_type=Merge3Merger,
2509
file_list=None, show_base=False, reprocess=False,
2510
pb=DummyProgress()):
2511
"""Merge changes into a tree.
2514
list(path, revno) Base for three-way merge.
2515
If [None, None] then a base will be automatically determined.
2517
list(path, revno) Other revision for three-way merge.
2519
Directory to merge changes into; '.' by default.
2521
If true, this_dir must have no uncommitted changes before the
2523
ignore_zero - If true, suppress the "zero conflicts" message when
2524
there are no conflicts; should be set when doing something we expect
2525
to complete perfectly.
2526
file_list - If supplied, merge only changes to selected files.
2528
All available ancestors of other_revision and base_revision are
2529
automatically pulled into the branch.
2531
The revno may be -1 to indicate the last revision on the branch, which is
2534
This function is intended for use from the command line; programmatic
2535
clients might prefer to call merge.merge_inner(), which has less magic
2538
from bzrlib.merge import Merger
2539
if this_dir is None:
2541
this_tree = WorkingTree.open_containing(this_dir)[0]
2542
if show_base and not merge_type is Merge3Merger:
2543
raise BzrCommandError("Show-base is not supported for this merge"
2544
" type. %s" % merge_type)
2545
if reprocess and not merge_type.supports_reprocess:
2546
raise BzrCommandError("Conflict reduction is not supported for merge"
2547
" type %s." % merge_type)
2548
if reprocess and show_base:
2549
raise BzrCommandError("Cannot do conflict reduction and show base.")
2551
merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
2552
merger.pp = ProgressPhase("Merge phase", 5, pb)
2553
merger.pp.next_phase()
2554
merger.check_basis(check_clean)
2555
merger.set_other(other_revision)
2556
merger.pp.next_phase()
2557
merger.set_base(base_revision)
2558
if merger.base_rev_id == merger.other_rev_id:
2559
note('Nothing to do.')
2561
merger.backup_files = backup_files
2562
merger.merge_type = merge_type
2563
merger.set_interesting_files(file_list)
2564
merger.show_base = show_base
2565
merger.reprocess = reprocess
2566
conflicts = merger.do_merge()
2567
if file_list is None:
2568
merger.set_pending()
2574
# these get imported and then picked up by the scan for cmd_*
2575
# TODO: Some more consistent way to split command definitions across files;
2576
# we do need to load at least some information about them to know of
2577
# aliases. ideally we would avoid loading the implementation until the
2578
# details were needed.
2579
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2580
from bzrlib.sign_my_commits import cmd_sign_my_commits
2581
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
2582
cmd_weave_plan_merge, cmd_weave_merge_text