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
revision_id=br_from.last_revision())
522
br_to = dir_to.open_branch()
523
count = len(br_to.revision_history())
525
old_rh = br_to.revision_history()
528
tree_to = dir_to.open_workingtree()
529
except errors.NotLocalUrl:
530
warning('This transport does not update the working '
531
'tree of: %s' % (br_to.base,))
532
count = br_to.pull(br_from, overwrite)
533
except NoWorkingTree:
534
count = br_to.pull(br_from, overwrite)
536
count = tree_to.pull(br_from, overwrite)
537
except DivergedBranches:
538
raise BzrCommandError("These branches have diverged."
539
" Try a merge then push with overwrite.")
540
note('%d revision(s) pushed.' % (count,))
543
new_rh = br_to.revision_history()
546
from bzrlib.log import show_changed_revisions
547
show_changed_revisions(br_to, old_rh, new_rh)
550
class cmd_branch(Command):
551
"""Create a new copy of a branch.
553
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
554
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
556
To retrieve the branch as of a particular revision, supply the --revision
557
parameter, as in "branch foo/bar -r 5".
559
--basis is to speed up branching from remote branches. When specified, it
560
copies all the file-contents, inventory and revision data from the basis
561
branch before copying anything from the remote branch.
563
takes_args = ['from_location', 'to_location?']
564
takes_options = ['revision', 'basis']
565
aliases = ['get', 'clone']
567
def run(self, from_location, to_location=None, revision=None, basis=None):
568
from bzrlib.osutils import rmtree
571
elif len(revision) > 1:
572
raise BzrCommandError(
573
'bzr branch --revision takes exactly 1 revision value')
575
br_from = Branch.open(from_location)
577
if e.errno == errno.ENOENT:
578
raise BzrCommandError('Source location "%s" does not'
579
' exist.' % to_location)
584
if basis is not None:
585
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
588
if len(revision) == 1 and revision[0] is not None:
589
revision_id = revision[0].in_history(br_from)[1]
591
# FIXME - wt.last_revision, fallback to branch, fall back to
592
# None or perhaps NULL_REVISION to mean copy nothing
594
revision_id = br_from.last_revision()
595
if to_location is None:
596
to_location = os.path.basename(from_location.rstrip("/\\"))
599
name = os.path.basename(to_location) + '\n'
601
os.mkdir(to_location)
603
if e.errno == errno.EEXIST:
604
raise BzrCommandError('Target directory "%s" already'
605
' exists.' % to_location)
606
if e.errno == errno.ENOENT:
607
raise BzrCommandError('Parent of "%s" does not exist.' %
612
# preserve whatever source format we have.
613
dir = br_from.bzrdir.sprout(to_location, revision_id, basis_dir)
614
branch = dir.open_branch()
615
except bzrlib.errors.NoSuchRevision:
617
msg = "The branch %s has no revision %s." % (from_location, revision[0])
618
raise BzrCommandError(msg)
619
except bzrlib.errors.UnlistableBranch:
621
msg = "The branch %s cannot be used as a --basis" % (basis,)
622
raise BzrCommandError(msg)
624
branch.control_files.put_utf8('branch-name', name)
626
note('Branched %d revision(s).' % branch.revno())
631
class cmd_checkout(Command):
632
"""Create a new checkout of an existing branch.
634
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
635
the branch found in '.'. This is useful if you have removed the working tree
636
or if it was never created - i.e. if you pushed the branch to its current
639
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
640
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
642
To retrieve the branch as of a particular revision, supply the --revision
643
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
644
out of date [so you cannot commit] but it may be useful (i.e. to examine old
647
--basis is to speed up checking out from remote branches. When specified, it
648
uses the inventory and file contents from the basis branch in preference to the
649
branch being checked out.
651
takes_args = ['branch_location?', 'to_location?']
652
takes_options = ['revision', # , 'basis']
653
Option('lightweight',
654
help="perform a lightweight checkout. Lightweight "
655
"checkouts depend on access to the branch for "
656
"every operation. Normal checkouts can perform "
657
"common operations like diff and status without "
658
"such access, and also support local commits."
662
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
666
elif len(revision) > 1:
667
raise BzrCommandError(
668
'bzr checkout --revision takes exactly 1 revision value')
669
if branch_location is None:
670
branch_location = bzrlib.osutils.getcwd()
671
to_location = branch_location
672
source = Branch.open(branch_location)
673
if len(revision) == 1 and revision[0] is not None:
674
revision_id = revision[0].in_history(source)[1]
677
if to_location is None:
678
to_location = os.path.basename(branch_location.rstrip("/\\"))
679
# if the source and to_location are the same,
680
# and there is no working tree,
681
# then reconstitute a branch
682
if (bzrlib.osutils.abspath(to_location) ==
683
bzrlib.osutils.abspath(branch_location)):
685
source.bzrdir.open_workingtree()
686
except errors.NoWorkingTree:
687
source.bzrdir.create_workingtree()
690
os.mkdir(to_location)
692
if e.errno == errno.EEXIST:
693
raise BzrCommandError('Target directory "%s" already'
694
' exists.' % to_location)
695
if e.errno == errno.ENOENT:
696
raise BzrCommandError('Parent of "%s" does not exist.' %
700
old_format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
701
bzrlib.bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
704
checkout = bzrdir.BzrDirMetaFormat1().initialize(to_location)
705
bzrlib.branch.BranchReferenceFormat().initialize(checkout, source)
707
checkout_branch = bzrlib.bzrdir.BzrDir.create_branch_convenience(
708
to_location, force_new_tree=False)
709
checkout = checkout_branch.bzrdir
710
checkout_branch.bind(source)
711
if revision_id is not None:
712
rh = checkout_branch.revision_history()
713
checkout_branch.set_revision_history(rh[:rh.index(revision_id) + 1])
714
checkout.create_workingtree(revision_id)
716
bzrlib.bzrdir.BzrDirFormat.set_default_format(old_format)
719
class cmd_renames(Command):
720
"""Show list of renamed files.
722
# TODO: Option to show renames between two historical versions.
724
# TODO: Only show renames under dir, rather than in the whole branch.
725
takes_args = ['dir?']
728
def run(self, dir=u'.'):
729
tree = WorkingTree.open_containing(dir)[0]
730
old_inv = tree.basis_tree().inventory
731
new_inv = tree.read_working_inventory()
733
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
735
for old_name, new_name in renames:
736
print "%s => %s" % (old_name, new_name)
739
class cmd_update(Command):
740
"""Update a tree to have the latest code committed to its branch.
742
This will perform a merge into the working tree, and may generate
743
conflicts. If you have any local changes, you will still
744
need to commit them after the update for the update to be complete.
746
If you want to discard your local changes, you can just do a
747
'bzr revert' instead of 'bzr commit' after the update.
749
takes_args = ['dir?']
751
def run(self, dir='.'):
752
tree = WorkingTree.open_containing(dir)[0]
755
if tree.last_revision() == tree.branch.last_revision():
756
# may be up to date, check master too.
757
master = tree.branch.get_master_branch()
758
if master is None or master.last_revision == tree.last_revision():
759
note("Tree is up to date.")
761
conflicts = tree.update()
762
note('Updated to revision %d.' %
763
(tree.branch.revision_id_to_revno(tree.last_revision()),))
772
class cmd_info(Command):
773
"""Show information about a working tree, branch or repository.
775
This command will show all known locations and formats associated to the
776
tree, branch or repository. Statistical information is included with
779
Branches and working trees will also report any missing revisions.
781
takes_args = ['location?']
782
takes_options = ['verbose']
785
def run(self, location=None, verbose=False):
786
from bzrlib.info import show_bzrdir_info
787
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
791
class cmd_remove(Command):
792
"""Make a file unversioned.
794
This makes bzr stop tracking changes to a versioned file. It does
795
not delete the working copy.
797
takes_args = ['file+']
798
takes_options = ['verbose']
801
def run(self, file_list, verbose=False):
802
tree, file_list = tree_files(file_list)
803
tree.remove(file_list, verbose=verbose)
806
class cmd_file_id(Command):
807
"""Print file_id of a particular file or directory.
809
The file_id is assigned when the file is first added and remains the
810
same through all revisions where the file exists, even when it is
814
takes_args = ['filename']
816
def run(self, filename):
817
tree, relpath = WorkingTree.open_containing(filename)
818
i = tree.inventory.path2id(relpath)
820
raise BzrError("%r is not a versioned file" % filename)
825
class cmd_file_path(Command):
826
"""Print path of file_ids to a file or directory.
828
This prints one line for each directory down to the target,
829
starting at the branch root."""
831
takes_args = ['filename']
833
def run(self, filename):
834
tree, relpath = WorkingTree.open_containing(filename)
836
fid = inv.path2id(relpath)
838
raise BzrError("%r is not a versioned file" % filename)
839
for fip in inv.get_idpath(fid):
843
class cmd_reconcile(Command):
844
"""Reconcile bzr metadata in a branch.
846
This can correct data mismatches that may have been caused by
847
previous ghost operations or bzr upgrades. You should only
848
need to run this command if 'bzr check' or a bzr developer
849
advises you to run it.
851
If a second branch is provided, cross-branch reconciliation is
852
also attempted, which will check that data like the tree root
853
id which was not present in very early bzr versions is represented
854
correctly in both branches.
856
At the same time it is run it may recompress data resulting in
857
a potential saving in disk space or performance gain.
859
The branch *MUST* be on a listable system such as local disk or sftp.
861
takes_args = ['branch?']
863
def run(self, branch="."):
864
from bzrlib.reconcile import reconcile
865
dir = bzrlib.bzrdir.BzrDir.open(branch)
869
class cmd_revision_history(Command):
870
"""Display the list of revision ids on a branch."""
871
takes_args = ['location?']
875
def run(self, location="."):
876
branch = Branch.open_containing(location)[0]
877
for revid in branch.revision_history():
881
class cmd_ancestry(Command):
882
"""List all revisions merged into this branch."""
886
tree = WorkingTree.open_containing(u'.')[0]
888
# FIXME. should be tree.last_revision
889
revision_ids = b.repository.get_ancestry(b.last_revision())
890
assert revision_ids[0] == None
892
for revision_id in revision_ids:
896
class cmd_init(Command):
897
"""Make a directory into a versioned branch.
899
Use this to create an empty branch, or before importing an
902
If there is a repository in a parent directory of the location, then
903
the history of the branch will be stored in the repository. Otherwise
904
init creates a standalone branch which carries its own history in
907
If there is already a branch at the location but it has no working tree,
908
the tree can be populated with 'bzr checkout'.
910
Recipe for importing a tree of files:
915
bzr commit -m 'imported project'
917
takes_args = ['location?']
920
help='Specify a format for this branch. Current'
921
' formats are: default, knit, metaweave and'
922
' weave. Default is knit; metaweave and'
923
' weave are deprecated',
924
type=get_format_type),
926
def run(self, location=None, format=None):
927
from bzrlib.branch import Branch
929
format = get_format_type('default')
933
# The path has to exist to initialize a
934
# branch inside of it.
935
# Just using os.mkdir, since I don't
936
# believe that we want to create a bunch of
937
# locations if the user supplies an extended path
938
if not os.path.exists(location):
941
existing_bzrdir = bzrdir.BzrDir.open(location)
942
except NotBranchError:
943
# really a NotBzrDir error...
944
bzrdir.BzrDir.create_branch_convenience(location, format=format)
946
if existing_bzrdir.has_branch():
947
if existing_bzrdir.has_workingtree():
948
raise errors.AlreadyBranchError(location)
950
raise errors.BranchExistsWithoutWorkingTree(location)
952
existing_bzrdir.create_branch()
953
existing_bzrdir.create_workingtree()
956
class cmd_init_repository(Command):
957
"""Create a shared repository to hold branches.
959
New branches created under the repository directory will store their revisions
960
in the repository, not in the branch directory, if the branch format supports
966
bzr checkout --lightweight repo/trunk trunk-checkout
970
takes_args = ["location"]
971
takes_options = [Option('format',
972
help='Specify a format for this repository.'
973
' Current formats are: default, knit,'
974
' metaweave and weave. Default is knit;'
975
' metaweave and weave are deprecated',
976
type=get_format_type),
978
help='Allows branches in repository to have'
980
aliases = ["init-repo"]
981
def run(self, location, format=None, trees=False):
982
from bzrlib.transport import get_transport
984
format = get_format_type('default')
985
transport = get_transport(location)
986
if not transport.has('.'):
988
newdir = format.initialize_on_transport(transport)
989
repo = newdir.create_repository(shared=True)
990
repo.set_make_working_trees(trees)
993
class cmd_diff(Command):
994
"""Show differences in working tree.
996
If files are listed, only the changes in those files are listed.
997
Otherwise, all changes for the tree are listed.
999
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1000
produces patches suitable for "patch -p1".
1006
bzr diff --diff-prefix old/:new/
1007
bzr diff bzr.mine bzr.dev
1010
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1011
# or a graphical diff.
1013
# TODO: Python difflib is not exactly the same as unidiff; should
1014
# either fix it up or prefer to use an external diff.
1016
# TODO: Selected-file diff is inefficient and doesn't show you
1019
# TODO: This probably handles non-Unix newlines poorly.
1021
takes_args = ['file*']
1022
takes_options = ['revision', 'diff-options', 'prefix']
1023
aliases = ['di', 'dif']
1026
def run(self, revision=None, file_list=None, diff_options=None,
1028
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1030
if (prefix is None) or (prefix == '0'):
1038
if not ':' in prefix:
1039
raise BzrError("--diff-prefix expects two values separated by a colon")
1040
old_label, new_label = prefix.split(":")
1043
tree1, file_list = internal_tree_files(file_list)
1047
except FileInWrongBranch:
1048
if len(file_list) != 2:
1049
raise BzrCommandError("Files are in different branches")
1051
tree1, file1 = WorkingTree.open_containing(file_list[0])
1052
tree2, file2 = WorkingTree.open_containing(file_list[1])
1053
if file1 != "" or file2 != "":
1054
# FIXME diff those two files. rbc 20051123
1055
raise BzrCommandError("Files are in different branches")
1057
if revision is not None:
1058
if tree2 is not None:
1059
raise BzrCommandError("Can't specify -r with two branches")
1060
if (len(revision) == 1) or (revision[1].spec is None):
1061
return diff_cmd_helper(tree1, file_list, diff_options,
1063
old_label=old_label, new_label=new_label)
1064
elif len(revision) == 2:
1065
return diff_cmd_helper(tree1, file_list, diff_options,
1066
revision[0], revision[1],
1067
old_label=old_label, new_label=new_label)
1069
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
1071
if tree2 is not None:
1072
return show_diff_trees(tree1, tree2, sys.stdout,
1073
specific_files=file_list,
1074
external_diff_options=diff_options,
1075
old_label=old_label, new_label=new_label)
1077
return diff_cmd_helper(tree1, file_list, diff_options,
1078
old_label=old_label, new_label=new_label)
1081
class cmd_deleted(Command):
1082
"""List files deleted in the working tree.
1084
# TODO: Show files deleted since a previous revision, or
1085
# between two revisions.
1086
# TODO: Much more efficient way to do this: read in new
1087
# directories with readdir, rather than stating each one. Same
1088
# level of effort but possibly much less IO. (Or possibly not,
1089
# if the directories are very large...)
1091
def run(self, show_ids=False):
1092
tree = WorkingTree.open_containing(u'.')[0]
1093
old = tree.basis_tree()
1094
for path, ie in old.inventory.iter_entries():
1095
if not tree.has_id(ie.file_id):
1097
print '%-50s %s' % (path, ie.file_id)
1102
class cmd_modified(Command):
1103
"""List files modified in working tree."""
1107
from bzrlib.delta import compare_trees
1109
tree = WorkingTree.open_containing(u'.')[0]
1110
td = compare_trees(tree.basis_tree(), tree)
1112
for path, id, kind, text_modified, meta_modified in td.modified:
1117
class cmd_added(Command):
1118
"""List files added in working tree."""
1122
wt = WorkingTree.open_containing(u'.')[0]
1123
basis_inv = wt.basis_tree().inventory
1126
if file_id in basis_inv:
1128
path = inv.id2path(file_id)
1129
if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
1135
class cmd_root(Command):
1136
"""Show the tree root directory.
1138
The root is the nearest enclosing directory with a .bzr control
1140
takes_args = ['filename?']
1142
def run(self, filename=None):
1143
"""Print the branch root."""
1144
tree = WorkingTree.open_containing(filename)[0]
1148
class cmd_log(Command):
1149
"""Show log of a branch, file, or directory.
1151
By default show the log of the branch containing the working directory.
1153
To request a range of logs, you can use the command -r begin..end
1154
-r revision requests a specific revision, -r ..end or -r begin.. are
1160
bzr log -r -10.. http://server/branch
1163
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1165
takes_args = ['location?']
1166
takes_options = [Option('forward',
1167
help='show from oldest to newest'),
1170
help='show files changed in each revision'),
1171
'show-ids', 'revision',
1175
help='show revisions whose message matches this regexp',
1180
def run(self, location=None, timezone='original',
1190
from bzrlib.log import log_formatter, show_log
1192
assert message is None or isinstance(message, basestring), \
1193
"invalid message argument %r" % message
1194
direction = (forward and 'forward') or 'reverse'
1199
# find the file id to log:
1201
dir, fp = bzrdir.BzrDir.open_containing(location)
1202
b = dir.open_branch()
1206
inv = dir.open_workingtree().inventory
1207
except (errors.NotBranchError, errors.NotLocalUrl):
1208
# either no tree, or is remote.
1209
inv = b.basis_tree().inventory
1210
file_id = inv.path2id(fp)
1213
# FIXME ? log the current subdir only RBC 20060203
1214
dir, relpath = bzrdir.BzrDir.open_containing('.')
1215
b = dir.open_branch()
1217
if revision is None:
1220
elif len(revision) == 1:
1221
rev1 = rev2 = revision[0].in_history(b).revno
1222
elif len(revision) == 2:
1223
if revision[0].spec is None:
1224
# missing begin-range means first revision
1227
rev1 = revision[0].in_history(b).revno
1229
if revision[1].spec is None:
1230
# missing end-range means last known revision
1233
rev2 = revision[1].in_history(b).revno
1235
raise BzrCommandError('bzr log --revision takes one or two values.')
1237
# By this point, the revision numbers are converted to the +ve
1238
# form if they were supplied in the -ve form, so we can do
1239
# this comparison in relative safety
1241
(rev2, rev1) = (rev1, rev2)
1243
mutter('encoding log as %r', bzrlib.user_encoding)
1245
# use 'replace' so that we don't abort if trying to write out
1246
# in e.g. the default C locale.
1247
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1249
if (log_format == None):
1250
default = bzrlib.config.BranchConfig(b).log_format()
1251
log_format = get_log_format(long=long, short=short, line=line, default=default)
1253
lf = log_formatter(log_format,
1256
show_timezone=timezone)
1262
direction=direction,
1263
start_revision=rev1,
1268
def get_log_format(long=False, short=False, line=False, default='long'):
1269
log_format = default
1273
log_format = 'short'
1279
class cmd_touching_revisions(Command):
1280
"""Return revision-ids which affected a particular file.
1282
A more user-friendly interface is "bzr log FILE"."""
1284
takes_args = ["filename"]
1286
def run(self, filename):
1287
tree, relpath = WorkingTree.open_containing(filename)
1289
inv = tree.read_working_inventory()
1290
file_id = inv.path2id(relpath)
1291
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1292
print "%6d %s" % (revno, what)
1295
class cmd_ls(Command):
1296
"""List files in a tree.
1298
# TODO: Take a revision or remote path and list that tree instead.
1300
takes_options = ['verbose', 'revision',
1301
Option('non-recursive',
1302
help='don\'t recurse into sub-directories'),
1304
help='Print all paths from the root of the branch.'),
1305
Option('unknown', help='Print unknown files'),
1306
Option('versioned', help='Print versioned files'),
1307
Option('ignored', help='Print ignored files'),
1309
Option('null', help='Null separate the files'),
1312
def run(self, revision=None, verbose=False,
1313
non_recursive=False, from_root=False,
1314
unknown=False, versioned=False, ignored=False,
1317
if verbose and null:
1318
raise BzrCommandError('Cannot set both --verbose and --null')
1319
all = not (unknown or versioned or ignored)
1321
selection = {'I':ignored, '?':unknown, 'V':versioned}
1323
tree, relpath = WorkingTree.open_containing(u'.')
1328
if revision is not None:
1329
tree = tree.branch.repository.revision_tree(
1330
revision[0].in_history(tree.branch).rev_id)
1331
for fp, fc, kind, fid, entry in tree.list_files():
1332
if fp.startswith(relpath):
1333
fp = fp[len(relpath):]
1334
if non_recursive and '/' in fp:
1336
if not all and not selection[fc]:
1339
kindch = entry.kind_character()
1340
print '%-8s %s%s' % (fc, fp, kindch)
1342
sys.stdout.write(fp)
1343
sys.stdout.write('\0')
1349
class cmd_unknowns(Command):
1350
"""List unknown files."""
1353
from bzrlib.osutils import quotefn
1354
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1358
class cmd_ignore(Command):
1359
"""Ignore a command or pattern.
1361
To remove patterns from the ignore list, edit the .bzrignore file.
1363
If the pattern contains a slash, it is compared to the whole path
1364
from the branch root. Otherwise, it is compared to only the last
1365
component of the path. To match a file only in the root directory,
1368
Ignore patterns are case-insensitive on case-insensitive systems.
1370
Note: wildcards must be quoted from the shell on Unix.
1373
bzr ignore ./Makefile
1374
bzr ignore '*.class'
1376
# TODO: Complain if the filename is absolute
1377
takes_args = ['name_pattern']
1379
def run(self, name_pattern):
1380
from bzrlib.atomicfile import AtomicFile
1383
tree, relpath = WorkingTree.open_containing(u'.')
1384
ifn = tree.abspath('.bzrignore')
1386
if os.path.exists(ifn):
1389
igns = f.read().decode('utf-8')
1395
# TODO: If the file already uses crlf-style termination, maybe
1396
# we should use that for the newly added lines?
1398
if igns and igns[-1] != '\n':
1400
igns += name_pattern + '\n'
1402
f = AtomicFile(ifn, 'wt')
1404
f.write(igns.encode('utf-8'))
1409
inv = tree.inventory
1410
if inv.path2id('.bzrignore'):
1411
mutter('.bzrignore is already versioned')
1413
mutter('need to make new .bzrignore file versioned')
1414
tree.add(['.bzrignore'])
1417
class cmd_ignored(Command):
1418
"""List ignored files and the patterns that matched them.
1420
See also: bzr ignore"""
1423
tree = WorkingTree.open_containing(u'.')[0]
1424
for path, file_class, kind, file_id, entry in tree.list_files():
1425
if file_class != 'I':
1427
## XXX: Slightly inefficient since this was already calculated
1428
pat = tree.is_ignored(path)
1429
print '%-50s %s' % (path, pat)
1432
class cmd_lookup_revision(Command):
1433
"""Lookup the revision-id from a revision-number
1436
bzr lookup-revision 33
1439
takes_args = ['revno']
1442
def run(self, revno):
1446
raise BzrCommandError("not a valid revision-number: %r" % revno)
1448
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1451
class cmd_export(Command):
1452
"""Export past revision to destination directory.
1454
If no revision is specified this exports the last committed revision.
1456
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1457
given, try to find the format with the extension. If no extension
1458
is found exports to a directory (equivalent to --format=dir).
1460
Root may be the top directory for tar, tgz and tbz2 formats. If none
1461
is given, the top directory will be the root name of the file.
1463
Note: export of tree with non-ascii filenames to zip is not supported.
1465
Supported formats Autodetected by extension
1466
----------------- -------------------------
1469
tbz2 .tar.bz2, .tbz2
1473
takes_args = ['dest']
1474
takes_options = ['revision', 'format', 'root']
1475
def run(self, dest, revision=None, format=None, root=None):
1477
from bzrlib.export import export
1478
tree = WorkingTree.open_containing(u'.')[0]
1480
if revision is None:
1481
# should be tree.last_revision FIXME
1482
rev_id = b.last_revision()
1484
if len(revision) != 1:
1485
raise BzrError('bzr export --revision takes exactly 1 argument')
1486
rev_id = revision[0].in_history(b).rev_id
1487
t = b.repository.revision_tree(rev_id)
1489
export(t, dest, format, root)
1490
except errors.NoSuchExportFormat, e:
1491
raise BzrCommandError('Unsupported export format: %s' % e.format)
1494
class cmd_cat(Command):
1495
"""Write a file's text from a previous revision."""
1497
takes_options = ['revision']
1498
takes_args = ['filename']
1501
def run(self, filename, revision=None):
1502
if revision is not None and len(revision) != 1:
1503
raise BzrCommandError("bzr cat --revision takes exactly one number")
1506
tree, relpath = WorkingTree.open_containing(filename)
1508
except NotBranchError:
1512
b, relpath = Branch.open_containing(filename)
1513
if revision is None:
1514
revision_id = b.last_revision()
1516
revision_id = revision[0].in_history(b).rev_id
1517
b.print_file(relpath, revision_id)
1520
class cmd_local_time_offset(Command):
1521
"""Show the offset in seconds from GMT to local time."""
1525
print bzrlib.osutils.local_time_offset()
1529
class cmd_commit(Command):
1530
"""Commit changes into a new revision.
1532
If no arguments are given, the entire tree is committed.
1534
If selected files are specified, only changes to those files are
1535
committed. If a directory is specified then the directory and everything
1536
within it is committed.
1538
A selected-file commit may fail in some cases where the committed
1539
tree would be invalid, such as trying to commit a file in a
1540
newly-added directory that is not itself committed.
1542
# TODO: Run hooks on tree to-be-committed, and after commit.
1544
# TODO: Strict commit that fails if there are deleted files.
1545
# (what does "deleted files" mean ??)
1547
# TODO: Give better message for -s, --summary, used by tla people
1549
# XXX: verbose currently does nothing
1551
takes_args = ['selected*']
1552
takes_options = ['message', 'verbose',
1554
help='commit even if nothing has changed'),
1555
Option('file', type=str,
1557
help='file containing commit message'),
1559
help="refuse to commit if there are unknown "
1560
"files in the working tree."),
1562
help="perform a local only commit in a bound "
1563
"branch. Such commits are not pushed to "
1564
"the master branch until a normal commit "
1568
aliases = ['ci', 'checkin']
1570
def run(self, message=None, file=None, verbose=True, selected_list=None,
1571
unchanged=False, strict=False, local=False):
1572
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1573
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1575
from bzrlib.msgeditor import edit_commit_message, \
1576
make_commit_message_template
1577
from tempfile import TemporaryFile
1580
# TODO: Need a blackbox test for invoking the external editor; may be
1581
# slightly problematic to run this cross-platform.
1583
# TODO: do more checks that the commit will succeed before
1584
# spending the user's valuable time typing a commit message.
1586
# TODO: if the commit *does* happen to fail, then save the commit
1587
# message to a temporary file where it can be recovered
1588
tree, selected_list = tree_files(selected_list)
1589
if selected_list == ['']:
1590
# workaround - commit of root of tree should be exactly the same
1591
# as just default commit in that tree, and succeed even though
1592
# selected-file merge commit is not done yet
1595
if local and not tree.branch.get_bound_location():
1596
raise errors.LocalRequiresBoundBranch()
1597
if message is None and not file:
1598
template = make_commit_message_template(tree, selected_list)
1599
message = edit_commit_message(template)
1601
raise BzrCommandError("please specify a commit message"
1602
" with either --message or --file")
1603
elif message and file:
1604
raise BzrCommandError("please specify either --message or --file")
1608
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1611
raise BzrCommandError("empty commit message specified")
1614
reporter = ReportCommitToLog()
1616
reporter = NullCommitReporter()
1619
tree.commit(message, specific_files=selected_list,
1620
allow_pointless=unchanged, strict=strict, local=local,
1622
except PointlessCommit:
1623
# FIXME: This should really happen before the file is read in;
1624
# perhaps prepare the commit; get the message; then actually commit
1625
raise BzrCommandError("no changes to commit",
1626
["use --unchanged to commit anyhow"])
1627
except ConflictsInTree:
1628
raise BzrCommandError("Conflicts detected in working tree. "
1629
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1630
except StrictCommitFailed:
1631
raise BzrCommandError("Commit refused because there are unknown "
1632
"files in the working tree.")
1633
except errors.BoundBranchOutOfDate, e:
1634
raise BzrCommandError(str(e)
1635
+ ' Either unbind, update, or'
1636
' pass --local to commit.')
1639
class cmd_check(Command):
1640
"""Validate consistency of branch history.
1642
This command checks various invariants about the branch storage to
1643
detect data corruption or bzr bugs.
1645
takes_args = ['branch?']
1646
takes_options = ['verbose']
1648
def run(self, branch=None, verbose=False):
1649
from bzrlib.check import check
1651
tree = WorkingTree.open_containing()[0]
1652
branch = tree.branch
1654
branch = Branch.open(branch)
1655
check(branch, verbose)
1658
class cmd_scan_cache(Command):
1661
from bzrlib.hashcache import HashCache
1667
print '%6d stats' % c.stat_count
1668
print '%6d in hashcache' % len(c._cache)
1669
print '%6d files removed from cache' % c.removed_count
1670
print '%6d hashes updated' % c.update_count
1671
print '%6d files changed too recently to cache' % c.danger_count
1677
class cmd_upgrade(Command):
1678
"""Upgrade branch storage to current format.
1680
The check command or bzr developers may sometimes advise you to run
1681
this command. When the default format has changed you may also be warned
1682
during other operations to upgrade.
1684
takes_args = ['url?']
1687
help='Upgrade to a specific format. Current formats'
1688
' are: default, knit, metaweave and weave.'
1689
' Default is knit; metaweave and weave are'
1691
type=get_format_type),
1695
def run(self, url='.', format=None):
1696
from bzrlib.upgrade import upgrade
1698
format = get_format_type('default')
1699
upgrade(url, format)
1702
class cmd_whoami(Command):
1703
"""Show bzr user id."""
1704
takes_options = ['email']
1707
def run(self, email=False):
1709
b = WorkingTree.open_containing(u'.')[0].branch
1710
config = bzrlib.config.BranchConfig(b)
1711
except NotBranchError:
1712
config = bzrlib.config.GlobalConfig()
1715
print config.user_email()
1717
print config.username()
1720
class cmd_nick(Command):
1721
"""Print or set the branch nickname.
1723
If unset, the tree root directory name is used as the nickname
1724
To print the current nickname, execute with no argument.
1726
takes_args = ['nickname?']
1727
def run(self, nickname=None):
1728
branch = Branch.open_containing(u'.')[0]
1729
if nickname is None:
1730
self.printme(branch)
1732
branch.nick = nickname
1735
def printme(self, branch):
1739
class cmd_selftest(Command):
1740
"""Run internal test suite.
1742
This creates temporary test directories in the working directory,
1743
but not existing data is affected. These directories are deleted
1744
if the tests pass, or left behind to help in debugging if they
1745
fail and --keep-output is specified.
1747
If arguments are given, they are regular expressions that say
1748
which tests should run.
1750
If the global option '--no-plugins' is given, plugins are not loaded
1751
before running the selftests. This has two effects: features provided or
1752
modified by plugins will not be tested, and tests provided by plugins will
1757
bzr --no-plugins selftest -v
1759
# TODO: --list should give a list of all available tests
1761
# NB: this is used from the class without creating an instance, which is
1762
# why it does not have a self parameter.
1763
def get_transport_type(typestring):
1764
"""Parse and return a transport specifier."""
1765
if typestring == "sftp":
1766
from bzrlib.transport.sftp import SFTPAbsoluteServer
1767
return SFTPAbsoluteServer
1768
if typestring == "memory":
1769
from bzrlib.transport.memory import MemoryServer
1771
if typestring == "fakenfs":
1772
from bzrlib.transport.fakenfs import FakeNFSServer
1773
return FakeNFSServer
1774
msg = "No known transport type %s. Supported types are: sftp\n" %\
1776
raise BzrCommandError(msg)
1779
takes_args = ['testspecs*']
1780
takes_options = ['verbose',
1781
Option('one', help='stop when one test fails'),
1782
Option('keep-output',
1783
help='keep output directories when tests fail'),
1785
help='Use a different transport by default '
1786
'throughout the test suite.',
1787
type=get_transport_type),
1788
Option('benchmark', help='run the bzr bencharks.'),
1789
Option('lsprof-timed',
1790
help='generate lsprof output for benchmarked'
1791
' sections of code.'),
1794
def run(self, testspecs_list=None, verbose=None, one=False,
1795
keep_output=False, transport=None, benchmark=None,
1798
from bzrlib.tests import selftest
1799
import bzrlib.benchmarks as benchmarks
1800
# we don't want progress meters from the tests to go to the
1801
# real output; and we don't want log messages cluttering up
1803
save_ui = bzrlib.ui.ui_factory
1804
print '%10s: %s' % ('bzr', bzrlib.osutils.realpath(sys.argv[0]))
1805
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
1807
bzrlib.trace.info('running tests...')
1809
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1810
if testspecs_list is not None:
1811
pattern = '|'.join(testspecs_list)
1815
test_suite_factory = benchmarks.test_suite
1819
test_suite_factory = None
1822
result = selftest(verbose=verbose,
1824
stop_on_failure=one,
1825
keep_output=keep_output,
1826
transport=transport,
1827
test_suite_factory=test_suite_factory,
1828
lsprof_timed=lsprof_timed)
1830
bzrlib.trace.info('tests passed')
1832
bzrlib.trace.info('tests failed')
1833
return int(not result)
1835
bzrlib.ui.ui_factory = save_ui
1838
def _get_bzr_branch():
1839
"""If bzr is run from a branch, return Branch or None"""
1840
import bzrlib.errors
1841
from bzrlib.branch import Branch
1842
from bzrlib.osutils import abspath
1843
from os.path import dirname
1846
branch = Branch.open(dirname(abspath(dirname(__file__))))
1848
except bzrlib.errors.BzrError:
1853
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1854
# is bzrlib itself in a branch?
1855
branch = _get_bzr_branch()
1857
rh = branch.revision_history()
1859
print " bzr checkout, revision %d" % (revno,)
1860
print " nick: %s" % (branch.nick,)
1862
print " revid: %s" % (rh[-1],)
1863
print bzrlib.__copyright__
1864
print "http://bazaar-vcs.org/"
1866
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1867
print "you may use, modify and redistribute it under the terms of the GNU"
1868
print "General Public License version 2 or later."
1871
class cmd_version(Command):
1872
"""Show version of bzr."""
1877
class cmd_rocks(Command):
1878
"""Statement of optimism."""
1882
print "it sure does!"
1885
class cmd_find_merge_base(Command):
1886
"""Find and print a base revision for merging two branches.
1888
# TODO: Options to specify revisions on either side, as if
1889
# merging only part of the history.
1890
takes_args = ['branch', 'other']
1894
def run(self, branch, other):
1895
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1897
branch1 = Branch.open_containing(branch)[0]
1898
branch2 = Branch.open_containing(other)[0]
1900
history_1 = branch1.revision_history()
1901
history_2 = branch2.revision_history()
1903
last1 = branch1.last_revision()
1904
last2 = branch2.last_revision()
1906
source = MultipleRevisionSources(branch1.repository,
1909
base_rev_id = common_ancestor(last1, last2, source)
1911
print 'merge base is revision %s' % base_rev_id
1915
if base_revno is None:
1916
raise bzrlib.errors.UnrelatedBranches()
1918
print ' r%-6d in %s' % (base_revno, branch)
1920
other_revno = branch2.revision_id_to_revno(base_revid)
1922
print ' r%-6d in %s' % (other_revno, other)
1926
class cmd_merge(Command):
1927
"""Perform a three-way merge.
1929
The branch is the branch you will merge from. By default, it will
1930
merge the latest revision. If you specify a revision, that
1931
revision will be merged. If you specify two revisions, the first
1932
will be used as a BASE, and the second one as OTHER. Revision
1933
numbers are always relative to the specified branch.
1935
By default, bzr will try to merge in all new work from the other
1936
branch, automatically determining an appropriate base. If this
1937
fails, you may need to give an explicit base.
1939
Merge will do its best to combine the changes in two branches, but there
1940
are some kinds of problems only a human can fix. When it encounters those,
1941
it will mark a conflict. A conflict means that you need to fix something,
1942
before you should commit.
1944
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
1946
If there is no default branch set, the first merge will set it. After
1947
that, you can omit the branch to use the default. To change the
1948
default, use --remember.
1952
To merge the latest revision from bzr.dev
1953
bzr merge ../bzr.dev
1955
To merge changes up to and including revision 82 from bzr.dev
1956
bzr merge -r 82 ../bzr.dev
1958
To merge the changes introduced by 82, without previous changes:
1959
bzr merge -r 81..82 ../bzr.dev
1961
merge refuses to run if there are any uncommitted changes, unless
1964
The following merge types are available:
1966
takes_args = ['branch?']
1967
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
1968
Option('show-base', help="Show base revision text in "
1972
from merge import merge_type_help
1973
from inspect import getdoc
1974
return getdoc(self) + '\n' + merge_type_help()
1976
def run(self, branch=None, revision=None, force=False, merge_type=None,
1977
show_base=False, reprocess=False, remember=False):
1978
if merge_type is None:
1979
merge_type = Merge3Merger
1981
tree = WorkingTree.open_containing(u'.')[0]
1982
stored_loc = tree.branch.get_parent()
1984
if stored_loc is None:
1985
raise BzrCommandError("No merge branch known or specified.")
1987
print "Using saved branch: %s" % stored_loc
1990
if tree.branch.get_parent() is None or remember:
1991
tree.branch.set_parent(branch)
1993
if revision is None or len(revision) < 1:
1995
other = [branch, -1]
1996
other_branch, path = Branch.open_containing(branch)
1998
if len(revision) == 1:
2000
other_branch, path = Branch.open_containing(branch)
2001
revno = revision[0].in_history(other_branch).revno
2002
other = [branch, revno]
2004
assert len(revision) == 2
2005
if None in revision:
2006
raise BzrCommandError(
2007
"Merge doesn't permit that revision specifier.")
2008
b, path = Branch.open_containing(branch)
2010
base = [branch, revision[0].in_history(b).revno]
2011
other = [branch, revision[1].in_history(b).revno]
2013
interesting_files = [path]
2015
interesting_files = None
2016
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2019
conflict_count = merge(other, base, check_clean=(not force),
2020
merge_type=merge_type,
2021
reprocess=reprocess,
2022
show_base=show_base,
2023
pb=pb, file_list=interesting_files)
2026
if conflict_count != 0:
2030
except bzrlib.errors.AmbiguousBase, e:
2031
m = ("sorry, bzr can't determine the right merge base yet\n"
2032
"candidates are:\n "
2033
+ "\n ".join(e.bases)
2035
"please specify an explicit base with -r,\n"
2036
"and (if you want) report this to the bzr developers\n")
2040
class cmd_remerge(Command):
2043
Use this if you want to try a different merge technique while resolving
2044
conflicts. Some merge techniques are better than others, and remerge
2045
lets you try different ones on different files.
2047
The options for remerge have the same meaning and defaults as the ones for
2048
merge. The difference is that remerge can (only) be run when there is a
2049
pending merge, and it lets you specify particular files.
2052
$ bzr remerge --show-base
2053
Re-do the merge of all conflicted files, and show the base text in
2054
conflict regions, in addition to the usual THIS and OTHER texts.
2056
$ bzr remerge --merge-type weave --reprocess foobar
2057
Re-do the merge of "foobar", using the weave merge algorithm, with
2058
additional processing to reduce the size of conflict regions.
2060
The following merge types are available:"""
2061
takes_args = ['file*']
2062
takes_options = ['merge-type', 'reprocess',
2063
Option('show-base', help="Show base revision text in "
2067
from merge import merge_type_help
2068
from inspect import getdoc
2069
return getdoc(self) + '\n' + merge_type_help()
2071
def run(self, file_list=None, merge_type=None, show_base=False,
2073
from bzrlib.merge import merge_inner, transform_tree
2074
if merge_type is None:
2075
merge_type = Merge3Merger
2076
tree, file_list = tree_files(file_list)
2079
pending_merges = tree.pending_merges()
2080
if len(pending_merges) != 1:
2081
raise BzrCommandError("Sorry, remerge only works after normal"
2082
+ " merges. Not cherrypicking or"
2084
repository = tree.branch.repository
2085
base_revision = common_ancestor(tree.branch.last_revision(),
2086
pending_merges[0], repository)
2087
base_tree = repository.revision_tree(base_revision)
2088
other_tree = repository.revision_tree(pending_merges[0])
2089
interesting_ids = None
2090
if file_list is not None:
2091
interesting_ids = set()
2092
for filename in file_list:
2093
file_id = tree.path2id(filename)
2095
raise NotVersionedError(filename)
2096
interesting_ids.add(file_id)
2097
if tree.kind(file_id) != "directory":
2100
for name, ie in tree.inventory.iter_entries(file_id):
2101
interesting_ids.add(ie.file_id)
2102
transform_tree(tree, tree.basis_tree(), interesting_ids)
2103
if file_list is None:
2104
restore_files = list(tree.iter_conflicts())
2106
restore_files = file_list
2107
for filename in restore_files:
2109
restore(tree.abspath(filename))
2110
except NotConflicted:
2112
conflicts = merge_inner(tree.branch, other_tree, base_tree,
2114
interesting_ids = interesting_ids,
2115
other_rev_id=pending_merges[0],
2116
merge_type=merge_type,
2117
show_base=show_base,
2118
reprocess=reprocess)
2126
class cmd_revert(Command):
2127
"""Reverse all changes since the last commit.
2129
Only versioned files are affected. Specify filenames to revert only
2130
those files. By default, any files that are changed will be backed up
2131
first. Backup files have a '~' appended to their name.
2133
takes_options = ['revision', 'no-backup']
2134
takes_args = ['file*']
2135
aliases = ['merge-revert']
2137
def run(self, revision=None, no_backup=False, file_list=None):
2138
from bzrlib.commands import parse_spec
2139
if file_list is not None:
2140
if len(file_list) == 0:
2141
raise BzrCommandError("No files specified")
2145
tree, file_list = tree_files(file_list)
2146
if revision is None:
2147
# FIXME should be tree.last_revision
2148
rev_id = tree.last_revision()
2149
elif len(revision) != 1:
2150
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
2152
rev_id = revision[0].in_history(tree.branch).rev_id
2153
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2155
tree.revert(file_list,
2156
tree.branch.repository.revision_tree(rev_id),
2162
class cmd_assert_fail(Command):
2163
"""Test reporting of assertion failures"""
2166
assert False, "always fails"
2169
class cmd_help(Command):
2170
"""Show help on a command or other topic.
2172
For a list of all available commands, say 'bzr help commands'."""
2173
takes_options = [Option('long', 'show help on all commands')]
2174
takes_args = ['topic?']
2175
aliases = ['?', '--help', '-?', '-h']
2178
def run(self, topic=None, long=False):
2180
if topic is None and long:
2185
class cmd_shell_complete(Command):
2186
"""Show appropriate completions for context.
2188
For a list of all available commands, say 'bzr shell-complete'."""
2189
takes_args = ['context?']
2194
def run(self, context=None):
2195
import shellcomplete
2196
shellcomplete.shellcomplete(context)
2199
class cmd_fetch(Command):
2200
"""Copy in history from another branch but don't merge it.
2202
This is an internal method used for pull and merge."""
2204
takes_args = ['from_branch', 'to_branch']
2205
def run(self, from_branch, to_branch):
2206
from bzrlib.fetch import Fetcher
2207
from bzrlib.branch import Branch
2208
from_b = Branch.open(from_branch)
2209
to_b = Branch.open(to_branch)
2210
Fetcher(to_b, from_b)
2213
class cmd_missing(Command):
2214
"""Show unmerged/unpulled revisions between two branches.
2216
OTHER_BRANCH may be local or remote."""
2217
takes_args = ['other_branch?']
2218
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2220
'Display changes in the local branch only'),
2221
Option('theirs-only',
2222
'Display changes in the remote branch only'),
2231
def run(self, other_branch=None, reverse=False, mine_only=False,
2232
theirs_only=False, log_format=None, long=False, short=False, line=False,
2233
show_ids=False, verbose=False):
2234
from bzrlib.missing import find_unmerged, iter_log_data
2235
from bzrlib.log import log_formatter
2236
local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
2237
parent = local_branch.get_parent()
2238
if other_branch is None:
2239
other_branch = parent
2240
if other_branch is None:
2241
raise BzrCommandError("No missing location known or specified.")
2242
print "Using last location: " + local_branch.get_parent()
2243
remote_branch = bzrlib.branch.Branch.open(other_branch)
2244
if remote_branch.base == local_branch.base:
2245
remote_branch = local_branch
2246
local_branch.lock_read()
2248
remote_branch.lock_read()
2250
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2251
if (log_format == None):
2252
default = bzrlib.config.BranchConfig(local_branch).log_format()
2253
log_format = get_log_format(long=long, short=short, line=line, default=default)
2254
lf = log_formatter(log_format, sys.stdout,
2256
show_timezone='original')
2257
if reverse is False:
2258
local_extra.reverse()
2259
remote_extra.reverse()
2260
if local_extra and not theirs_only:
2261
print "You have %d extra revision(s):" % len(local_extra)
2262
for data in iter_log_data(local_extra, local_branch.repository,
2265
printed_local = True
2267
printed_local = False
2268
if remote_extra and not mine_only:
2269
if printed_local is True:
2271
print "You are missing %d revision(s):" % len(remote_extra)
2272
for data in iter_log_data(remote_extra, remote_branch.repository,
2275
if not remote_extra and not local_extra:
2277
print "Branches are up to date."
2281
remote_branch.unlock()
2283
local_branch.unlock()
2284
if not status_code and parent is None and other_branch is not None:
2285
local_branch.lock_write()
2287
# handle race conditions - a parent might be set while we run.
2288
if local_branch.get_parent() is None:
2289
local_branch.set_parent(other_branch)
2291
local_branch.unlock()
2295
class cmd_plugins(Command):
2300
import bzrlib.plugin
2301
from inspect import getdoc
2302
for name, plugin in bzrlib.plugin.all_plugins().items():
2303
if hasattr(plugin, '__path__'):
2304
print plugin.__path__[0]
2305
elif hasattr(plugin, '__file__'):
2306
print plugin.__file__
2312
print '\t', d.split('\n')[0]
2315
class cmd_testament(Command):
2316
"""Show testament (signing-form) of a revision."""
2317
takes_options = ['revision', 'long']
2318
takes_args = ['branch?']
2320
def run(self, branch=u'.', revision=None, long=False):
2321
from bzrlib.testament import Testament
2322
b = WorkingTree.open_containing(branch)[0].branch
2325
if revision is None:
2326
rev_id = b.last_revision()
2328
rev_id = revision[0].in_history(b).rev_id
2329
t = Testament.from_revision(b.repository, rev_id)
2331
sys.stdout.writelines(t.as_text_lines())
2333
sys.stdout.write(t.as_short_text())
2338
class cmd_annotate(Command):
2339
"""Show the origin of each line in a file.
2341
This prints out the given file with an annotation on the left side
2342
indicating which revision, author and date introduced the change.
2344
If the origin is the same for a run of consecutive lines, it is
2345
shown only at the top, unless the --all option is given.
2347
# TODO: annotate directories; showing when each file was last changed
2348
# TODO: if the working copy is modified, show annotations on that
2349
# with new uncommitted lines marked
2350
aliases = ['blame', 'praise']
2351
takes_args = ['filename']
2352
takes_options = [Option('all', help='show annotations on all lines'),
2353
Option('long', help='show date in annotations'),
2358
def run(self, filename, all=False, long=False, revision=None):
2359
from bzrlib.annotate import annotate_file
2360
tree, relpath = WorkingTree.open_containing(filename)
2361
branch = tree.branch
2364
if revision is None:
2365
revision_id = branch.last_revision()
2366
elif len(revision) != 1:
2367
raise BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2369
revision_id = revision[0].in_history(branch).rev_id
2370
file_id = tree.inventory.path2id(relpath)
2371
tree = branch.repository.revision_tree(revision_id)
2372
file_version = tree.inventory[file_id].revision
2373
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2378
class cmd_re_sign(Command):
2379
"""Create a digital signature for an existing revision."""
2380
# TODO be able to replace existing ones.
2382
hidden = True # is this right ?
2383
takes_args = ['revision_id*']
2384
takes_options = ['revision']
2386
def run(self, revision_id_list=None, revision=None):
2387
import bzrlib.config as config
2388
import bzrlib.gpg as gpg
2389
if revision_id_list is not None and revision is not None:
2390
raise BzrCommandError('You can only supply one of revision_id or --revision')
2391
if revision_id_list is None and revision is None:
2392
raise BzrCommandError('You must supply either --revision or a revision_id')
2393
b = WorkingTree.open_containing(u'.')[0].branch
2394
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
2395
if revision_id_list is not None:
2396
for revision_id in revision_id_list:
2397
b.repository.sign_revision(revision_id, gpg_strategy)
2398
elif revision is not None:
2399
if len(revision) == 1:
2400
revno, rev_id = revision[0].in_history(b)
2401
b.repository.sign_revision(rev_id, gpg_strategy)
2402
elif len(revision) == 2:
2403
# are they both on rh- if so we can walk between them
2404
# might be nice to have a range helper for arbitrary
2405
# revision paths. hmm.
2406
from_revno, from_revid = revision[0].in_history(b)
2407
to_revno, to_revid = revision[1].in_history(b)
2408
if to_revid is None:
2409
to_revno = b.revno()
2410
if from_revno is None or to_revno is None:
2411
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
2412
for revno in range(from_revno, to_revno + 1):
2413
b.repository.sign_revision(b.get_rev_id(revno),
2416
raise BzrCommandError('Please supply either one revision, or a range.')
2419
class cmd_bind(Command):
2420
"""Bind the current branch to a master branch.
2422
After binding, commits must succeed on the master branch
2423
before they are executed on the local one.
2426
takes_args = ['location']
2429
def run(self, location=None):
2430
b, relpath = Branch.open_containing(u'.')
2431
b_other = Branch.open(location)
2434
except DivergedBranches:
2435
raise BzrCommandError('These branches have diverged.'
2436
' Try merging, and then bind again.')
2439
class cmd_unbind(Command):
2440
"""Unbind the current branch from its master branch.
2442
After unbinding, the local branch is considered independent.
2443
All subsequent commits will be local.
2450
b, relpath = Branch.open_containing(u'.')
2452
raise BzrCommandError('Local branch is not bound')
2455
class cmd_uncommit(bzrlib.commands.Command):
2456
"""Remove the last committed revision.
2458
--verbose will print out what is being removed.
2459
--dry-run will go through all the motions, but not actually
2462
In the future, uncommit will create a changeset, which can then
2466
# TODO: jam 20060108 Add an option to allow uncommit to remove
2467
# unreferenced information in 'branch-as-repostory' branches.
2468
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2469
# information in shared branches as well.
2470
takes_options = ['verbose', 'revision',
2471
Option('dry-run', help='Don\'t actually make changes'),
2472
Option('force', help='Say yes to all questions.')]
2473
takes_args = ['location?']
2476
def run(self, location=None,
2477
dry_run=False, verbose=False,
2478
revision=None, force=False):
2479
from bzrlib.branch import Branch
2480
from bzrlib.log import log_formatter
2482
from bzrlib.uncommit import uncommit
2484
if location is None:
2486
control, relpath = bzrdir.BzrDir.open_containing(location)
2488
tree = control.open_workingtree()
2490
except (errors.NoWorkingTree, errors.NotLocalUrl):
2492
b = control.open_branch()
2494
if revision is None:
2496
rev_id = b.last_revision()
2498
revno, rev_id = revision[0].in_history(b)
2500
print 'No revisions to uncommit.'
2502
for r in range(revno, b.revno()+1):
2503
rev_id = b.get_rev_id(r)
2504
lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
2505
lf.show(r, b.repository.get_revision(rev_id), None)
2508
print 'Dry-run, pretending to remove the above revisions.'
2510
val = raw_input('Press <enter> to continue')
2512
print 'The above revision(s) will be removed.'
2514
val = raw_input('Are you sure [y/N]? ')
2515
if val.lower() not in ('y', 'yes'):
2519
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2523
class cmd_break_lock(Command):
2524
"""Break a dead lock on a repository, branch or working directory.
2526
CAUTION: Locks should only be broken when you are sure that the process
2527
holding the lock has been stopped.
2529
You can get information on what locks are open via the 'bzr info' command.
2534
takes_args = ['location?']
2536
def run(self, location=None, show=False):
2537
if location is None:
2539
control, relpath = bzrdir.BzrDir.open_containing(location)
2541
control.break_lock()
2542
except NotImplementedError:
2547
# command-line interpretation helper for merge-related commands
2548
def merge(other_revision, base_revision,
2549
check_clean=True, ignore_zero=False,
2550
this_dir=None, backup_files=False, merge_type=Merge3Merger,
2551
file_list=None, show_base=False, reprocess=False,
2552
pb=DummyProgress()):
2553
"""Merge changes into a tree.
2556
list(path, revno) Base for three-way merge.
2557
If [None, None] then a base will be automatically determined.
2559
list(path, revno) Other revision for three-way merge.
2561
Directory to merge changes into; '.' by default.
2563
If true, this_dir must have no uncommitted changes before the
2565
ignore_zero - If true, suppress the "zero conflicts" message when
2566
there are no conflicts; should be set when doing something we expect
2567
to complete perfectly.
2568
file_list - If supplied, merge only changes to selected files.
2570
All available ancestors of other_revision and base_revision are
2571
automatically pulled into the branch.
2573
The revno may be -1 to indicate the last revision on the branch, which is
2576
This function is intended for use from the command line; programmatic
2577
clients might prefer to call merge.merge_inner(), which has less magic
2580
from bzrlib.merge import Merger
2581
if this_dir is None:
2583
this_tree = WorkingTree.open_containing(this_dir)[0]
2584
if show_base and not merge_type is Merge3Merger:
2585
raise BzrCommandError("Show-base is not supported for this merge"
2586
" type. %s" % merge_type)
2587
if reprocess and not merge_type.supports_reprocess:
2588
raise BzrCommandError("Conflict reduction is not supported for merge"
2589
" type %s." % merge_type)
2590
if reprocess and show_base:
2591
raise BzrCommandError("Cannot do conflict reduction and show base.")
2593
merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
2594
merger.pp = ProgressPhase("Merge phase", 5, pb)
2595
merger.pp.next_phase()
2596
merger.check_basis(check_clean)
2597
merger.set_other(other_revision)
2598
merger.pp.next_phase()
2599
merger.set_base(base_revision)
2600
if merger.base_rev_id == merger.other_rev_id:
2601
note('Nothing to do.')
2603
merger.backup_files = backup_files
2604
merger.merge_type = merge_type
2605
merger.set_interesting_files(file_list)
2606
merger.show_base = show_base
2607
merger.reprocess = reprocess
2608
conflicts = merger.do_merge()
2609
if file_list is None:
2610
merger.set_pending()
2616
# these get imported and then picked up by the scan for cmd_*
2617
# TODO: Some more consistent way to split command definitions across files;
2618
# we do need to load at least some information about them to know of
2619
# aliases. ideally we would avoid loading the implementation until the
2620
# details were needed.
2621
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2622
from bzrlib.sign_my_commits import cmd_sign_my_commits
2623
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
2624
cmd_weave_plan_merge, cmd_weave_merge_text