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 list of revision ids on this branch."""
874
branch = WorkingTree.open_containing(u'.')[0].branch
875
for patchid in branch.revision_history():
879
class cmd_ancestry(Command):
880
"""List all revisions merged into this branch."""
884
tree = WorkingTree.open_containing(u'.')[0]
886
# FIXME. should be tree.last_revision
887
revision_ids = b.repository.get_ancestry(b.last_revision())
888
assert revision_ids[0] == None
890
for revision_id in revision_ids:
894
class cmd_init(Command):
895
"""Make a directory into a versioned branch.
897
Use this to create an empty branch, or before importing an
900
If there is a repository in a parent directory of the location, then
901
the history of the branch will be stored in the repository. Otherwise
902
init creates a standalone branch which carries its own history in
905
If there is already a branch at the location but it has no working tree,
906
the tree can be populated with 'bzr checkout'.
908
Recipe for importing a tree of files:
913
bzr commit -m 'imported project'
915
takes_args = ['location?']
918
help='Specify a format for this branch. Current'
919
' formats are: default, knit, metaweave and'
920
' weave. Default is knit; metaweave and'
921
' weave are deprecated',
922
type=get_format_type),
924
def run(self, location=None, format=None):
925
from bzrlib.branch import Branch
927
format = get_format_type('default')
931
# The path has to exist to initialize a
932
# branch inside of it.
933
# Just using os.mkdir, since I don't
934
# believe that we want to create a bunch of
935
# locations if the user supplies an extended path
936
if not os.path.exists(location):
939
existing_bzrdir = bzrdir.BzrDir.open(location)
940
except NotBranchError:
941
# really a NotBzrDir error...
942
bzrdir.BzrDir.create_branch_convenience(location, format=format)
944
if existing_bzrdir.has_branch():
945
if existing_bzrdir.has_workingtree():
946
raise errors.AlreadyBranchError(location)
948
raise errors.BranchExistsWithoutWorkingTree(location)
950
existing_bzrdir.create_branch()
951
existing_bzrdir.create_workingtree()
954
class cmd_init_repository(Command):
955
"""Create a shared repository to hold branches.
957
New branches created under the repository directory will store their revisions
958
in the repository, not in the branch directory, if the branch format supports
964
bzr checkout --lightweight repo/trunk trunk-checkout
968
takes_args = ["location"]
969
takes_options = [Option('format',
970
help='Specify a format for this repository.'
971
' Current formats are: default, knit,'
972
' metaweave and weave. Default is knit;'
973
' metaweave and weave are deprecated',
974
type=get_format_type),
976
help='Allows branches in repository to have'
978
aliases = ["init-repo"]
979
def run(self, location, format=None, trees=False):
980
from bzrlib.transport import get_transport
982
format = get_format_type('default')
983
transport = get_transport(location)
984
if not transport.has('.'):
986
newdir = format.initialize_on_transport(transport)
987
repo = newdir.create_repository(shared=True)
988
repo.set_make_working_trees(trees)
991
class cmd_diff(Command):
992
"""Show differences in working tree.
994
If files are listed, only the changes in those files are listed.
995
Otherwise, all changes for the tree are listed.
997
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
998
produces patches suitable for "patch -p1".
1004
bzr diff --diff-prefix old/:new/
1005
bzr diff bzr.mine bzr.dev
1008
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1009
# or a graphical diff.
1011
# TODO: Python difflib is not exactly the same as unidiff; should
1012
# either fix it up or prefer to use an external diff.
1014
# TODO: Selected-file diff is inefficient and doesn't show you
1017
# TODO: This probably handles non-Unix newlines poorly.
1019
takes_args = ['file*']
1020
takes_options = ['revision', 'diff-options', 'prefix']
1021
aliases = ['di', 'dif']
1024
def run(self, revision=None, file_list=None, diff_options=None,
1026
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1028
if (prefix is None) or (prefix == '0'):
1036
if not ':' in prefix:
1037
raise BzrError("--diff-prefix expects two values separated by a colon")
1038
old_label, new_label = prefix.split(":")
1041
tree1, file_list = internal_tree_files(file_list)
1045
except FileInWrongBranch:
1046
if len(file_list) != 2:
1047
raise BzrCommandError("Files are in different branches")
1049
tree1, file1 = WorkingTree.open_containing(file_list[0])
1050
tree2, file2 = WorkingTree.open_containing(file_list[1])
1051
if file1 != "" or file2 != "":
1052
# FIXME diff those two files. rbc 20051123
1053
raise BzrCommandError("Files are in different branches")
1055
if revision is not None:
1056
if tree2 is not None:
1057
raise BzrCommandError("Can't specify -r with two branches")
1058
if (len(revision) == 1) or (revision[1].spec is None):
1059
return diff_cmd_helper(tree1, file_list, diff_options,
1061
old_label=old_label, new_label=new_label)
1062
elif len(revision) == 2:
1063
return diff_cmd_helper(tree1, file_list, diff_options,
1064
revision[0], revision[1],
1065
old_label=old_label, new_label=new_label)
1067
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
1069
if tree2 is not None:
1070
return show_diff_trees(tree1, tree2, sys.stdout,
1071
specific_files=file_list,
1072
external_diff_options=diff_options,
1073
old_label=old_label, new_label=new_label)
1075
return diff_cmd_helper(tree1, file_list, diff_options,
1076
old_label=old_label, new_label=new_label)
1079
class cmd_deleted(Command):
1080
"""List files deleted in the working tree.
1082
# TODO: Show files deleted since a previous revision, or
1083
# between two revisions.
1084
# TODO: Much more efficient way to do this: read in new
1085
# directories with readdir, rather than stating each one. Same
1086
# level of effort but possibly much less IO. (Or possibly not,
1087
# if the directories are very large...)
1089
def run(self, show_ids=False):
1090
tree = WorkingTree.open_containing(u'.')[0]
1091
old = tree.basis_tree()
1092
for path, ie in old.inventory.iter_entries():
1093
if not tree.has_id(ie.file_id):
1095
print '%-50s %s' % (path, ie.file_id)
1100
class cmd_modified(Command):
1101
"""List files modified in working tree."""
1105
from bzrlib.delta import compare_trees
1107
tree = WorkingTree.open_containing(u'.')[0]
1108
td = compare_trees(tree.basis_tree(), tree)
1110
for path, id, kind, text_modified, meta_modified in td.modified:
1115
class cmd_added(Command):
1116
"""List files added in working tree."""
1120
wt = WorkingTree.open_containing(u'.')[0]
1121
basis_inv = wt.basis_tree().inventory
1124
if file_id in basis_inv:
1126
path = inv.id2path(file_id)
1127
if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
1133
class cmd_root(Command):
1134
"""Show the tree root directory.
1136
The root is the nearest enclosing directory with a .bzr control
1138
takes_args = ['filename?']
1140
def run(self, filename=None):
1141
"""Print the branch root."""
1142
tree = WorkingTree.open_containing(filename)[0]
1146
class cmd_log(Command):
1147
"""Show log of a branch, file, or directory.
1149
By default show the log of the branch containing the working directory.
1151
To request a range of logs, you can use the command -r begin..end
1152
-r revision requests a specific revision, -r ..end or -r begin.. are
1158
bzr log -r -10.. http://server/branch
1161
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1163
takes_args = ['location?']
1164
takes_options = [Option('forward',
1165
help='show from oldest to newest'),
1168
help='show files changed in each revision'),
1169
'show-ids', 'revision',
1173
help='show revisions whose message matches this regexp',
1178
def run(self, location=None, timezone='original',
1188
from bzrlib.log import log_formatter, show_log
1190
assert message is None or isinstance(message, basestring), \
1191
"invalid message argument %r" % message
1192
direction = (forward and 'forward') or 'reverse'
1197
# find the file id to log:
1199
dir, fp = bzrdir.BzrDir.open_containing(location)
1200
b = dir.open_branch()
1204
inv = dir.open_workingtree().inventory
1205
except (errors.NotBranchError, errors.NotLocalUrl):
1206
# either no tree, or is remote.
1207
inv = b.basis_tree().inventory
1208
file_id = inv.path2id(fp)
1211
# FIXME ? log the current subdir only RBC 20060203
1212
dir, relpath = bzrdir.BzrDir.open_containing('.')
1213
b = dir.open_branch()
1215
if revision is None:
1218
elif len(revision) == 1:
1219
rev1 = rev2 = revision[0].in_history(b).revno
1220
elif len(revision) == 2:
1221
if revision[0].spec is None:
1222
# missing begin-range means first revision
1225
rev1 = revision[0].in_history(b).revno
1227
if revision[1].spec is None:
1228
# missing end-range means last known revision
1231
rev2 = revision[1].in_history(b).revno
1233
raise BzrCommandError('bzr log --revision takes one or two values.')
1235
# By this point, the revision numbers are converted to the +ve
1236
# form if they were supplied in the -ve form, so we can do
1237
# this comparison in relative safety
1239
(rev2, rev1) = (rev1, rev2)
1241
mutter('encoding log as %r', bzrlib.user_encoding)
1243
# use 'replace' so that we don't abort if trying to write out
1244
# in e.g. the default C locale.
1245
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1247
if (log_format == None):
1248
default = bzrlib.config.BranchConfig(b).log_format()
1249
log_format = get_log_format(long=long, short=short, line=line, default=default)
1251
lf = log_formatter(log_format,
1254
show_timezone=timezone)
1260
direction=direction,
1261
start_revision=rev1,
1266
def get_log_format(long=False, short=False, line=False, default='long'):
1267
log_format = default
1271
log_format = 'short'
1277
class cmd_touching_revisions(Command):
1278
"""Return revision-ids which affected a particular file.
1280
A more user-friendly interface is "bzr log FILE"."""
1282
takes_args = ["filename"]
1284
def run(self, filename):
1285
tree, relpath = WorkingTree.open_containing(filename)
1287
inv = tree.read_working_inventory()
1288
file_id = inv.path2id(relpath)
1289
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1290
print "%6d %s" % (revno, what)
1293
class cmd_ls(Command):
1294
"""List files in a tree.
1296
# TODO: Take a revision or remote path and list that tree instead.
1298
takes_options = ['verbose', 'revision',
1299
Option('non-recursive',
1300
help='don\'t recurse into sub-directories'),
1302
help='Print all paths from the root of the branch.'),
1303
Option('unknown', help='Print unknown files'),
1304
Option('versioned', help='Print versioned files'),
1305
Option('ignored', help='Print ignored files'),
1307
Option('null', help='Null separate the files'),
1310
def run(self, revision=None, verbose=False,
1311
non_recursive=False, from_root=False,
1312
unknown=False, versioned=False, ignored=False,
1315
if verbose and null:
1316
raise BzrCommandError('Cannot set both --verbose and --null')
1317
all = not (unknown or versioned or ignored)
1319
selection = {'I':ignored, '?':unknown, 'V':versioned}
1321
tree, relpath = WorkingTree.open_containing(u'.')
1326
if revision is not None:
1327
tree = tree.branch.repository.revision_tree(
1328
revision[0].in_history(tree.branch).rev_id)
1329
for fp, fc, kind, fid, entry in tree.list_files():
1330
if fp.startswith(relpath):
1331
fp = fp[len(relpath):]
1332
if non_recursive and '/' in fp:
1334
if not all and not selection[fc]:
1337
kindch = entry.kind_character()
1338
print '%-8s %s%s' % (fc, fp, kindch)
1340
sys.stdout.write(fp)
1341
sys.stdout.write('\0')
1347
class cmd_unknowns(Command):
1348
"""List unknown files."""
1351
from bzrlib.osutils import quotefn
1352
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1356
class cmd_ignore(Command):
1357
"""Ignore a command or pattern.
1359
To remove patterns from the ignore list, edit the .bzrignore file.
1361
If the pattern contains a slash, it is compared to the whole path
1362
from the branch root. Otherwise, it is compared to only the last
1363
component of the path. To match a file only in the root directory,
1366
Ignore patterns are case-insensitive on case-insensitive systems.
1368
Note: wildcards must be quoted from the shell on Unix.
1371
bzr ignore ./Makefile
1372
bzr ignore '*.class'
1374
# TODO: Complain if the filename is absolute
1375
takes_args = ['name_pattern']
1377
def run(self, name_pattern):
1378
from bzrlib.atomicfile import AtomicFile
1381
tree, relpath = WorkingTree.open_containing(u'.')
1382
ifn = tree.abspath('.bzrignore')
1384
if os.path.exists(ifn):
1387
igns = f.read().decode('utf-8')
1393
# TODO: If the file already uses crlf-style termination, maybe
1394
# we should use that for the newly added lines?
1396
if igns and igns[-1] != '\n':
1398
igns += name_pattern + '\n'
1400
f = AtomicFile(ifn, 'wt')
1402
f.write(igns.encode('utf-8'))
1407
inv = tree.inventory
1408
if inv.path2id('.bzrignore'):
1409
mutter('.bzrignore is already versioned')
1411
mutter('need to make new .bzrignore file versioned')
1412
tree.add(['.bzrignore'])
1415
class cmd_ignored(Command):
1416
"""List ignored files and the patterns that matched them.
1418
See also: bzr ignore"""
1421
tree = WorkingTree.open_containing(u'.')[0]
1422
for path, file_class, kind, file_id, entry in tree.list_files():
1423
if file_class != 'I':
1425
## XXX: Slightly inefficient since this was already calculated
1426
pat = tree.is_ignored(path)
1427
print '%-50s %s' % (path, pat)
1430
class cmd_lookup_revision(Command):
1431
"""Lookup the revision-id from a revision-number
1434
bzr lookup-revision 33
1437
takes_args = ['revno']
1440
def run(self, revno):
1444
raise BzrCommandError("not a valid revision-number: %r" % revno)
1446
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1449
class cmd_export(Command):
1450
"""Export past revision to destination directory.
1452
If no revision is specified this exports the last committed revision.
1454
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1455
given, try to find the format with the extension. If no extension
1456
is found exports to a directory (equivalent to --format=dir).
1458
Root may be the top directory for tar, tgz and tbz2 formats. If none
1459
is given, the top directory will be the root name of the file.
1461
Note: export of tree with non-ascii filenames to zip is not supported.
1463
Supported formats Autodetected by extension
1464
----------------- -------------------------
1467
tbz2 .tar.bz2, .tbz2
1471
takes_args = ['dest']
1472
takes_options = ['revision', 'format', 'root']
1473
def run(self, dest, revision=None, format=None, root=None):
1475
from bzrlib.export import export
1476
tree = WorkingTree.open_containing(u'.')[0]
1478
if revision is None:
1479
# should be tree.last_revision FIXME
1480
rev_id = b.last_revision()
1482
if len(revision) != 1:
1483
raise BzrError('bzr export --revision takes exactly 1 argument')
1484
rev_id = revision[0].in_history(b).rev_id
1485
t = b.repository.revision_tree(rev_id)
1487
export(t, dest, format, root)
1488
except errors.NoSuchExportFormat, e:
1489
raise BzrCommandError('Unsupported export format: %s' % e.format)
1492
class cmd_cat(Command):
1493
"""Write a file's text from a previous revision."""
1495
takes_options = ['revision']
1496
takes_args = ['filename']
1499
def run(self, filename, revision=None):
1500
if revision is not None and len(revision) != 1:
1501
raise BzrCommandError("bzr cat --revision takes exactly one number")
1504
tree, relpath = WorkingTree.open_containing(filename)
1506
except NotBranchError:
1510
b, relpath = Branch.open_containing(filename)
1511
if revision is None:
1512
revision_id = b.last_revision()
1514
revision_id = revision[0].in_history(b).rev_id
1515
b.print_file(relpath, revision_id)
1518
class cmd_local_time_offset(Command):
1519
"""Show the offset in seconds from GMT to local time."""
1523
print bzrlib.osutils.local_time_offset()
1527
class cmd_commit(Command):
1528
"""Commit changes into a new revision.
1530
If no arguments are given, the entire tree is committed.
1532
If selected files are specified, only changes to those files are
1533
committed. If a directory is specified then the directory and everything
1534
within it is committed.
1536
A selected-file commit may fail in some cases where the committed
1537
tree would be invalid, such as trying to commit a file in a
1538
newly-added directory that is not itself committed.
1540
# TODO: Run hooks on tree to-be-committed, and after commit.
1542
# TODO: Strict commit that fails if there are deleted files.
1543
# (what does "deleted files" mean ??)
1545
# TODO: Give better message for -s, --summary, used by tla people
1547
# XXX: verbose currently does nothing
1549
takes_args = ['selected*']
1550
takes_options = ['message', 'verbose',
1552
help='commit even if nothing has changed'),
1553
Option('file', type=str,
1555
help='file containing commit message'),
1557
help="refuse to commit if there are unknown "
1558
"files in the working tree."),
1560
help="perform a local only commit in a bound "
1561
"branch. Such commits are not pushed to "
1562
"the master branch until a normal commit "
1566
aliases = ['ci', 'checkin']
1568
def run(self, message=None, file=None, verbose=True, selected_list=None,
1569
unchanged=False, strict=False, local=False):
1570
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1571
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1573
from bzrlib.msgeditor import edit_commit_message, \
1574
make_commit_message_template
1575
from tempfile import TemporaryFile
1578
# TODO: Need a blackbox test for invoking the external editor; may be
1579
# slightly problematic to run this cross-platform.
1581
# TODO: do more checks that the commit will succeed before
1582
# spending the user's valuable time typing a commit message.
1584
# TODO: if the commit *does* happen to fail, then save the commit
1585
# message to a temporary file where it can be recovered
1586
tree, selected_list = tree_files(selected_list)
1587
if selected_list == ['']:
1588
# workaround - commit of root of tree should be exactly the same
1589
# as just default commit in that tree, and succeed even though
1590
# selected-file merge commit is not done yet
1593
if local and not tree.branch.get_bound_location():
1594
raise errors.LocalRequiresBoundBranch()
1595
if message is None and not file:
1596
template = make_commit_message_template(tree, selected_list)
1597
message = edit_commit_message(template)
1599
raise BzrCommandError("please specify a commit message"
1600
" with either --message or --file")
1601
elif message and file:
1602
raise BzrCommandError("please specify either --message or --file")
1606
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1609
raise BzrCommandError("empty commit message specified")
1612
reporter = ReportCommitToLog()
1614
reporter = NullCommitReporter()
1617
tree.commit(message, specific_files=selected_list,
1618
allow_pointless=unchanged, strict=strict, local=local,
1620
except PointlessCommit:
1621
# FIXME: This should really happen before the file is read in;
1622
# perhaps prepare the commit; get the message; then actually commit
1623
raise BzrCommandError("no changes to commit",
1624
["use --unchanged to commit anyhow"])
1625
except ConflictsInTree:
1626
raise BzrCommandError("Conflicts detected in working tree. "
1627
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1628
except StrictCommitFailed:
1629
raise BzrCommandError("Commit refused because there are unknown "
1630
"files in the working tree.")
1631
except errors.BoundBranchOutOfDate, e:
1632
raise BzrCommandError(str(e)
1633
+ ' Either unbind, update, or'
1634
' pass --local to commit.')
1637
class cmd_check(Command):
1638
"""Validate consistency of branch history.
1640
This command checks various invariants about the branch storage to
1641
detect data corruption or bzr bugs.
1643
takes_args = ['branch?']
1644
takes_options = ['verbose']
1646
def run(self, branch=None, verbose=False):
1647
from bzrlib.check import check
1649
tree = WorkingTree.open_containing()[0]
1650
branch = tree.branch
1652
branch = Branch.open(branch)
1653
check(branch, verbose)
1656
class cmd_scan_cache(Command):
1659
from bzrlib.hashcache import HashCache
1665
print '%6d stats' % c.stat_count
1666
print '%6d in hashcache' % len(c._cache)
1667
print '%6d files removed from cache' % c.removed_count
1668
print '%6d hashes updated' % c.update_count
1669
print '%6d files changed too recently to cache' % c.danger_count
1675
class cmd_upgrade(Command):
1676
"""Upgrade branch storage to current format.
1678
The check command or bzr developers may sometimes advise you to run
1679
this command. When the default format has changed you may also be warned
1680
during other operations to upgrade.
1682
takes_args = ['url?']
1685
help='Upgrade to a specific format. Current formats'
1686
' are: default, knit, metaweave and weave.'
1687
' Default is knit; metaweave and weave are'
1689
type=get_format_type),
1693
def run(self, url='.', format=None):
1694
from bzrlib.upgrade import upgrade
1696
format = get_format_type('default')
1697
upgrade(url, format)
1700
class cmd_whoami(Command):
1701
"""Show bzr user id."""
1702
takes_options = ['email']
1705
def run(self, email=False):
1707
b = WorkingTree.open_containing(u'.')[0].branch
1708
config = bzrlib.config.BranchConfig(b)
1709
except NotBranchError:
1710
config = bzrlib.config.GlobalConfig()
1713
print config.user_email()
1715
print config.username()
1718
class cmd_nick(Command):
1719
"""Print or set the branch nickname.
1721
If unset, the tree root directory name is used as the nickname
1722
To print the current nickname, execute with no argument.
1724
takes_args = ['nickname?']
1725
def run(self, nickname=None):
1726
branch = Branch.open_containing(u'.')[0]
1727
if nickname is None:
1728
self.printme(branch)
1730
branch.nick = nickname
1733
def printme(self, branch):
1737
class cmd_selftest(Command):
1738
"""Run internal test suite.
1740
This creates temporary test directories in the working directory,
1741
but not existing data is affected. These directories are deleted
1742
if the tests pass, or left behind to help in debugging if they
1743
fail and --keep-output is specified.
1745
If arguments are given, they are regular expressions that say
1746
which tests should run.
1748
If the global option '--no-plugins' is given, plugins are not loaded
1749
before running the selftests. This has two effects: features provided or
1750
modified by plugins will not be tested, and tests provided by plugins will
1755
bzr --no-plugins selftest -v
1757
# TODO: --list should give a list of all available tests
1759
# NB: this is used from the class without creating an instance, which is
1760
# why it does not have a self parameter.
1761
def get_transport_type(typestring):
1762
"""Parse and return a transport specifier."""
1763
if typestring == "sftp":
1764
from bzrlib.transport.sftp import SFTPAbsoluteServer
1765
return SFTPAbsoluteServer
1766
if typestring == "memory":
1767
from bzrlib.transport.memory import MemoryServer
1769
if typestring == "fakenfs":
1770
from bzrlib.transport.fakenfs import FakeNFSServer
1771
return FakeNFSServer
1772
msg = "No known transport type %s. Supported types are: sftp\n" %\
1774
raise BzrCommandError(msg)
1777
takes_args = ['testspecs*']
1778
takes_options = ['verbose',
1779
Option('one', help='stop when one test fails'),
1780
Option('keep-output',
1781
help='keep output directories when tests fail'),
1783
help='Use a different transport by default '
1784
'throughout the test suite.',
1785
type=get_transport_type),
1786
Option('benchmark', help='run the bzr bencharks.'),
1787
Option('lsprof-timed',
1788
help='generate lsprof output for benchmarked'
1789
' sections of code.'),
1792
def run(self, testspecs_list=None, verbose=None, one=False,
1793
keep_output=False, transport=None, benchmark=None,
1796
from bzrlib.tests import selftest
1797
import bzrlib.benchmarks as benchmarks
1798
# we don't want progress meters from the tests to go to the
1799
# real output; and we don't want log messages cluttering up
1801
save_ui = bzrlib.ui.ui_factory
1802
print '%10s: %s' % ('bzr', bzrlib.osutils.realpath(sys.argv[0]))
1803
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
1805
bzrlib.trace.info('running tests...')
1807
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1808
if testspecs_list is not None:
1809
pattern = '|'.join(testspecs_list)
1813
test_suite_factory = benchmarks.test_suite
1817
test_suite_factory = None
1820
result = selftest(verbose=verbose,
1822
stop_on_failure=one,
1823
keep_output=keep_output,
1824
transport=transport,
1825
test_suite_factory=test_suite_factory,
1826
lsprof_timed=lsprof_timed)
1828
bzrlib.trace.info('tests passed')
1830
bzrlib.trace.info('tests failed')
1831
return int(not result)
1833
bzrlib.ui.ui_factory = save_ui
1836
def _get_bzr_branch():
1837
"""If bzr is run from a branch, return Branch or None"""
1838
import bzrlib.errors
1839
from bzrlib.branch import Branch
1840
from bzrlib.osutils import abspath
1841
from os.path import dirname
1844
branch = Branch.open(dirname(abspath(dirname(__file__))))
1846
except bzrlib.errors.BzrError:
1851
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1852
# is bzrlib itself in a branch?
1853
branch = _get_bzr_branch()
1855
rh = branch.revision_history()
1857
print " bzr checkout, revision %d" % (revno,)
1858
print " nick: %s" % (branch.nick,)
1860
print " revid: %s" % (rh[-1],)
1861
print bzrlib.__copyright__
1862
print "http://bazaar-vcs.org/"
1864
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1865
print "you may use, modify and redistribute it under the terms of the GNU"
1866
print "General Public License version 2 or later."
1869
class cmd_version(Command):
1870
"""Show version of bzr."""
1875
class cmd_rocks(Command):
1876
"""Statement of optimism."""
1880
print "it sure does!"
1883
class cmd_find_merge_base(Command):
1884
"""Find and print a base revision for merging two branches.
1886
# TODO: Options to specify revisions on either side, as if
1887
# merging only part of the history.
1888
takes_args = ['branch', 'other']
1892
def run(self, branch, other):
1893
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1895
branch1 = Branch.open_containing(branch)[0]
1896
branch2 = Branch.open_containing(other)[0]
1898
history_1 = branch1.revision_history()
1899
history_2 = branch2.revision_history()
1901
last1 = branch1.last_revision()
1902
last2 = branch2.last_revision()
1904
source = MultipleRevisionSources(branch1.repository,
1907
base_rev_id = common_ancestor(last1, last2, source)
1909
print 'merge base is revision %s' % base_rev_id
1913
if base_revno is None:
1914
raise bzrlib.errors.UnrelatedBranches()
1916
print ' r%-6d in %s' % (base_revno, branch)
1918
other_revno = branch2.revision_id_to_revno(base_revid)
1920
print ' r%-6d in %s' % (other_revno, other)
1924
class cmd_merge(Command):
1925
"""Perform a three-way merge.
1927
The branch is the branch you will merge from. By default, it will
1928
merge the latest revision. If you specify a revision, that
1929
revision will be merged. If you specify two revisions, the first
1930
will be used as a BASE, and the second one as OTHER. Revision
1931
numbers are always relative to the specified branch.
1933
By default, bzr will try to merge in all new work from the other
1934
branch, automatically determining an appropriate base. If this
1935
fails, you may need to give an explicit base.
1937
Merge will do its best to combine the changes in two branches, but there
1938
are some kinds of problems only a human can fix. When it encounters those,
1939
it will mark a conflict. A conflict means that you need to fix something,
1940
before you should commit.
1942
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
1944
If there is no default branch set, the first merge will set it. After
1945
that, you can omit the branch to use the default. To change the
1946
default, use --remember.
1950
To merge the latest revision from bzr.dev
1951
bzr merge ../bzr.dev
1953
To merge changes up to and including revision 82 from bzr.dev
1954
bzr merge -r 82 ../bzr.dev
1956
To merge the changes introduced by 82, without previous changes:
1957
bzr merge -r 81..82 ../bzr.dev
1959
merge refuses to run if there are any uncommitted changes, unless
1962
The following merge types are available:
1964
takes_args = ['branch?']
1965
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
1966
Option('show-base', help="Show base revision text in "
1970
from merge import merge_type_help
1971
from inspect import getdoc
1972
return getdoc(self) + '\n' + merge_type_help()
1974
def run(self, branch=None, revision=None, force=False, merge_type=None,
1975
show_base=False, reprocess=False, remember=False):
1976
if merge_type is None:
1977
merge_type = Merge3Merger
1979
tree = WorkingTree.open_containing(u'.')[0]
1980
stored_loc = tree.branch.get_parent()
1982
if stored_loc is None:
1983
raise BzrCommandError("No merge branch known or specified.")
1985
print "Using saved branch: %s" % stored_loc
1988
if tree.branch.get_parent() is None or remember:
1989
tree.branch.set_parent(branch)
1991
if revision is None or len(revision) < 1:
1993
other = [branch, -1]
1994
other_branch, path = Branch.open_containing(branch)
1996
if len(revision) == 1:
1998
other_branch, path = Branch.open_containing(branch)
1999
revno = revision[0].in_history(other_branch).revno
2000
other = [branch, revno]
2002
assert len(revision) == 2
2003
if None in revision:
2004
raise BzrCommandError(
2005
"Merge doesn't permit that revision specifier.")
2006
b, path = Branch.open_containing(branch)
2008
base = [branch, revision[0].in_history(b).revno]
2009
other = [branch, revision[1].in_history(b).revno]
2011
interesting_files = [path]
2013
interesting_files = None
2014
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2017
conflict_count = merge(other, base, check_clean=(not force),
2018
merge_type=merge_type,
2019
reprocess=reprocess,
2020
show_base=show_base,
2021
pb=pb, file_list=interesting_files)
2024
if conflict_count != 0:
2028
except bzrlib.errors.AmbiguousBase, e:
2029
m = ("sorry, bzr can't determine the right merge base yet\n"
2030
"candidates are:\n "
2031
+ "\n ".join(e.bases)
2033
"please specify an explicit base with -r,\n"
2034
"and (if you want) report this to the bzr developers\n")
2038
class cmd_remerge(Command):
2041
Use this if you want to try a different merge technique while resolving
2042
conflicts. Some merge techniques are better than others, and remerge
2043
lets you try different ones on different files.
2045
The options for remerge have the same meaning and defaults as the ones for
2046
merge. The difference is that remerge can (only) be run when there is a
2047
pending merge, and it lets you specify particular files.
2050
$ bzr remerge --show-base
2051
Re-do the merge of all conflicted files, and show the base text in
2052
conflict regions, in addition to the usual THIS and OTHER texts.
2054
$ bzr remerge --merge-type weave --reprocess foobar
2055
Re-do the merge of "foobar", using the weave merge algorithm, with
2056
additional processing to reduce the size of conflict regions.
2058
The following merge types are available:"""
2059
takes_args = ['file*']
2060
takes_options = ['merge-type', 'reprocess',
2061
Option('show-base', help="Show base revision text in "
2065
from merge import merge_type_help
2066
from inspect import getdoc
2067
return getdoc(self) + '\n' + merge_type_help()
2069
def run(self, file_list=None, merge_type=None, show_base=False,
2071
from bzrlib.merge import merge_inner, transform_tree
2072
if merge_type is None:
2073
merge_type = Merge3Merger
2074
tree, file_list = tree_files(file_list)
2077
pending_merges = tree.pending_merges()
2078
if len(pending_merges) != 1:
2079
raise BzrCommandError("Sorry, remerge only works after normal"
2080
+ " merges. Not cherrypicking or"
2082
repository = tree.branch.repository
2083
base_revision = common_ancestor(tree.branch.last_revision(),
2084
pending_merges[0], repository)
2085
base_tree = repository.revision_tree(base_revision)
2086
other_tree = repository.revision_tree(pending_merges[0])
2087
interesting_ids = None
2088
if file_list is not None:
2089
interesting_ids = set()
2090
for filename in file_list:
2091
file_id = tree.path2id(filename)
2093
raise NotVersionedError(filename)
2094
interesting_ids.add(file_id)
2095
if tree.kind(file_id) != "directory":
2098
for name, ie in tree.inventory.iter_entries(file_id):
2099
interesting_ids.add(ie.file_id)
2100
transform_tree(tree, tree.basis_tree(), interesting_ids)
2101
if file_list is None:
2102
restore_files = list(tree.iter_conflicts())
2104
restore_files = file_list
2105
for filename in restore_files:
2107
restore(tree.abspath(filename))
2108
except NotConflicted:
2110
conflicts = merge_inner(tree.branch, other_tree, base_tree,
2112
interesting_ids = interesting_ids,
2113
other_rev_id=pending_merges[0],
2114
merge_type=merge_type,
2115
show_base=show_base,
2116
reprocess=reprocess)
2124
class cmd_revert(Command):
2125
"""Reverse all changes since the last commit.
2127
Only versioned files are affected. Specify filenames to revert only
2128
those files. By default, any files that are changed will be backed up
2129
first. Backup files have a '~' appended to their name.
2131
takes_options = ['revision', 'no-backup']
2132
takes_args = ['file*']
2133
aliases = ['merge-revert']
2135
def run(self, revision=None, no_backup=False, file_list=None):
2136
from bzrlib.commands import parse_spec
2137
if file_list is not None:
2138
if len(file_list) == 0:
2139
raise BzrCommandError("No files specified")
2143
tree, file_list = tree_files(file_list)
2144
if revision is None:
2145
# FIXME should be tree.last_revision
2146
rev_id = tree.last_revision()
2147
elif len(revision) != 1:
2148
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
2150
rev_id = revision[0].in_history(tree.branch).rev_id
2151
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2153
tree.revert(file_list,
2154
tree.branch.repository.revision_tree(rev_id),
2160
class cmd_assert_fail(Command):
2161
"""Test reporting of assertion failures"""
2164
assert False, "always fails"
2167
class cmd_help(Command):
2168
"""Show help on a command or other topic.
2170
For a list of all available commands, say 'bzr help commands'."""
2171
takes_options = [Option('long', 'show help on all commands')]
2172
takes_args = ['topic?']
2173
aliases = ['?', '--help', '-?', '-h']
2176
def run(self, topic=None, long=False):
2178
if topic is None and long:
2183
class cmd_shell_complete(Command):
2184
"""Show appropriate completions for context.
2186
For a list of all available commands, say 'bzr shell-complete'."""
2187
takes_args = ['context?']
2192
def run(self, context=None):
2193
import shellcomplete
2194
shellcomplete.shellcomplete(context)
2197
class cmd_fetch(Command):
2198
"""Copy in history from another branch but don't merge it.
2200
This is an internal method used for pull and merge."""
2202
takes_args = ['from_branch', 'to_branch']
2203
def run(self, from_branch, to_branch):
2204
from bzrlib.fetch import Fetcher
2205
from bzrlib.branch import Branch
2206
from_b = Branch.open(from_branch)
2207
to_b = Branch.open(to_branch)
2208
Fetcher(to_b, from_b)
2211
class cmd_missing(Command):
2212
"""Show unmerged/unpulled revisions between two branches.
2214
OTHER_BRANCH may be local or remote."""
2215
takes_args = ['other_branch?']
2216
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2218
'Display changes in the local branch only'),
2219
Option('theirs-only',
2220
'Display changes in the remote branch only'),
2229
def run(self, other_branch=None, reverse=False, mine_only=False,
2230
theirs_only=False, log_format=None, long=False, short=False, line=False,
2231
show_ids=False, verbose=False):
2232
from bzrlib.missing import find_unmerged, iter_log_data
2233
from bzrlib.log import log_formatter
2234
local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
2235
parent = local_branch.get_parent()
2236
if other_branch is None:
2237
other_branch = parent
2238
if other_branch is None:
2239
raise BzrCommandError("No missing location known or specified.")
2240
print "Using last location: " + local_branch.get_parent()
2241
remote_branch = bzrlib.branch.Branch.open(other_branch)
2242
if remote_branch.base == local_branch.base:
2243
remote_branch = local_branch
2244
local_branch.lock_read()
2246
remote_branch.lock_read()
2248
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2249
if (log_format == None):
2250
default = bzrlib.config.BranchConfig(local_branch).log_format()
2251
log_format = get_log_format(long=long, short=short, line=line, default=default)
2252
lf = log_formatter(log_format, sys.stdout,
2254
show_timezone='original')
2255
if reverse is False:
2256
local_extra.reverse()
2257
remote_extra.reverse()
2258
if local_extra and not theirs_only:
2259
print "You have %d extra revision(s):" % len(local_extra)
2260
for data in iter_log_data(local_extra, local_branch.repository,
2263
printed_local = True
2265
printed_local = False
2266
if remote_extra and not mine_only:
2267
if printed_local is True:
2269
print "You are missing %d revision(s):" % len(remote_extra)
2270
for data in iter_log_data(remote_extra, remote_branch.repository,
2273
if not remote_extra and not local_extra:
2275
print "Branches are up to date."
2279
remote_branch.unlock()
2281
local_branch.unlock()
2282
if not status_code and parent is None and other_branch is not None:
2283
local_branch.lock_write()
2285
# handle race conditions - a parent might be set while we run.
2286
if local_branch.get_parent() is None:
2287
local_branch.set_parent(other_branch)
2289
local_branch.unlock()
2293
class cmd_plugins(Command):
2298
import bzrlib.plugin
2299
from inspect import getdoc
2300
for name, plugin in bzrlib.plugin.all_plugins().items():
2301
if hasattr(plugin, '__path__'):
2302
print plugin.__path__[0]
2303
elif hasattr(plugin, '__file__'):
2304
print plugin.__file__
2310
print '\t', d.split('\n')[0]
2313
class cmd_testament(Command):
2314
"""Show testament (signing-form) of a revision."""
2315
takes_options = ['revision', 'long']
2316
takes_args = ['branch?']
2318
def run(self, branch=u'.', revision=None, long=False):
2319
from bzrlib.testament import Testament
2320
b = WorkingTree.open_containing(branch)[0].branch
2323
if revision is None:
2324
rev_id = b.last_revision()
2326
rev_id = revision[0].in_history(b).rev_id
2327
t = Testament.from_revision(b.repository, rev_id)
2329
sys.stdout.writelines(t.as_text_lines())
2331
sys.stdout.write(t.as_short_text())
2336
class cmd_annotate(Command):
2337
"""Show the origin of each line in a file.
2339
This prints out the given file with an annotation on the left side
2340
indicating which revision, author and date introduced the change.
2342
If the origin is the same for a run of consecutive lines, it is
2343
shown only at the top, unless the --all option is given.
2345
# TODO: annotate directories; showing when each file was last changed
2346
# TODO: if the working copy is modified, show annotations on that
2347
# with new uncommitted lines marked
2348
aliases = ['blame', 'praise']
2349
takes_args = ['filename']
2350
takes_options = [Option('all', help='show annotations on all lines'),
2351
Option('long', help='show date in annotations'),
2356
def run(self, filename, all=False, long=False, revision=None):
2357
from bzrlib.annotate import annotate_file
2358
tree, relpath = WorkingTree.open_containing(filename)
2359
branch = tree.branch
2362
if revision is None:
2363
revision_id = branch.last_revision()
2364
elif len(revision) != 1:
2365
raise BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2367
revision_id = revision[0].in_history(branch).rev_id
2368
file_id = tree.inventory.path2id(relpath)
2369
tree = branch.repository.revision_tree(revision_id)
2370
file_version = tree.inventory[file_id].revision
2371
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2376
class cmd_re_sign(Command):
2377
"""Create a digital signature for an existing revision."""
2378
# TODO be able to replace existing ones.
2380
hidden = True # is this right ?
2381
takes_args = ['revision_id*']
2382
takes_options = ['revision']
2384
def run(self, revision_id_list=None, revision=None):
2385
import bzrlib.config as config
2386
import bzrlib.gpg as gpg
2387
if revision_id_list is not None and revision is not None:
2388
raise BzrCommandError('You can only supply one of revision_id or --revision')
2389
if revision_id_list is None and revision is None:
2390
raise BzrCommandError('You must supply either --revision or a revision_id')
2391
b = WorkingTree.open_containing(u'.')[0].branch
2392
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
2393
if revision_id_list is not None:
2394
for revision_id in revision_id_list:
2395
b.repository.sign_revision(revision_id, gpg_strategy)
2396
elif revision is not None:
2397
if len(revision) == 1:
2398
revno, rev_id = revision[0].in_history(b)
2399
b.repository.sign_revision(rev_id, gpg_strategy)
2400
elif len(revision) == 2:
2401
# are they both on rh- if so we can walk between them
2402
# might be nice to have a range helper for arbitrary
2403
# revision paths. hmm.
2404
from_revno, from_revid = revision[0].in_history(b)
2405
to_revno, to_revid = revision[1].in_history(b)
2406
if to_revid is None:
2407
to_revno = b.revno()
2408
if from_revno is None or to_revno is None:
2409
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
2410
for revno in range(from_revno, to_revno + 1):
2411
b.repository.sign_revision(b.get_rev_id(revno),
2414
raise BzrCommandError('Please supply either one revision, or a range.')
2417
class cmd_bind(Command):
2418
"""Bind the current branch to a master branch.
2420
After binding, commits must succeed on the master branch
2421
before they are executed on the local one.
2424
takes_args = ['location']
2427
def run(self, location=None):
2428
b, relpath = Branch.open_containing(u'.')
2429
b_other = Branch.open(location)
2432
except DivergedBranches:
2433
raise BzrCommandError('These branches have diverged.'
2434
' Try merging, and then bind again.')
2437
class cmd_unbind(Command):
2438
"""Unbind the current branch from its master branch.
2440
After unbinding, the local branch is considered independent.
2441
All subsequent commits will be local.
2448
b, relpath = Branch.open_containing(u'.')
2450
raise BzrCommandError('Local branch is not bound')
2453
class cmd_uncommit(bzrlib.commands.Command):
2454
"""Remove the last committed revision.
2456
--verbose will print out what is being removed.
2457
--dry-run will go through all the motions, but not actually
2460
In the future, uncommit will create a changeset, which can then
2464
# TODO: jam 20060108 Add an option to allow uncommit to remove
2465
# unreferenced information in 'branch-as-repostory' branches.
2466
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2467
# information in shared branches as well.
2468
takes_options = ['verbose', 'revision',
2469
Option('dry-run', help='Don\'t actually make changes'),
2470
Option('force', help='Say yes to all questions.')]
2471
takes_args = ['location?']
2474
def run(self, location=None,
2475
dry_run=False, verbose=False,
2476
revision=None, force=False):
2477
from bzrlib.branch import Branch
2478
from bzrlib.log import log_formatter
2480
from bzrlib.uncommit import uncommit
2482
if location is None:
2484
control, relpath = bzrdir.BzrDir.open_containing(location)
2486
tree = control.open_workingtree()
2488
except (errors.NoWorkingTree, errors.NotLocalUrl):
2490
b = control.open_branch()
2492
if revision is None:
2494
rev_id = b.last_revision()
2496
revno, rev_id = revision[0].in_history(b)
2498
print 'No revisions to uncommit.'
2500
for r in range(revno, b.revno()+1):
2501
rev_id = b.get_rev_id(r)
2502
lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
2503
lf.show(r, b.repository.get_revision(rev_id), None)
2506
print 'Dry-run, pretending to remove the above revisions.'
2508
val = raw_input('Press <enter> to continue')
2510
print 'The above revision(s) will be removed.'
2512
val = raw_input('Are you sure [y/N]? ')
2513
if val.lower() not in ('y', 'yes'):
2517
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2521
class cmd_break_lock(Command):
2522
"""Break a dead lock on a repository, branch or working directory.
2524
CAUTION: Locks should only be broken when you are sure that the process
2525
holding the lock has been stopped.
2527
You can get information on what locks are open via the 'bzr info' command.
2532
takes_args = ['location?']
2534
def run(self, location=None, show=False):
2535
if location is None:
2537
control, relpath = bzrdir.BzrDir.open_containing(location)
2539
control.break_lock()
2540
except NotImplementedError:
2545
# command-line interpretation helper for merge-related commands
2546
def merge(other_revision, base_revision,
2547
check_clean=True, ignore_zero=False,
2548
this_dir=None, backup_files=False, merge_type=Merge3Merger,
2549
file_list=None, show_base=False, reprocess=False,
2550
pb=DummyProgress()):
2551
"""Merge changes into a tree.
2554
list(path, revno) Base for three-way merge.
2555
If [None, None] then a base will be automatically determined.
2557
list(path, revno) Other revision for three-way merge.
2559
Directory to merge changes into; '.' by default.
2561
If true, this_dir must have no uncommitted changes before the
2563
ignore_zero - If true, suppress the "zero conflicts" message when
2564
there are no conflicts; should be set when doing something we expect
2565
to complete perfectly.
2566
file_list - If supplied, merge only changes to selected files.
2568
All available ancestors of other_revision and base_revision are
2569
automatically pulled into the branch.
2571
The revno may be -1 to indicate the last revision on the branch, which is
2574
This function is intended for use from the command line; programmatic
2575
clients might prefer to call merge.merge_inner(), which has less magic
2578
from bzrlib.merge import Merger
2579
if this_dir is None:
2581
this_tree = WorkingTree.open_containing(this_dir)[0]
2582
if show_base and not merge_type is Merge3Merger:
2583
raise BzrCommandError("Show-base is not supported for this merge"
2584
" type. %s" % merge_type)
2585
if reprocess and not merge_type.supports_reprocess:
2586
raise BzrCommandError("Conflict reduction is not supported for merge"
2587
" type %s." % merge_type)
2588
if reprocess and show_base:
2589
raise BzrCommandError("Cannot do conflict reduction and show base.")
2591
merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
2592
merger.pp = ProgressPhase("Merge phase", 5, pb)
2593
merger.pp.next_phase()
2594
merger.check_basis(check_clean)
2595
merger.set_other(other_revision)
2596
merger.pp.next_phase()
2597
merger.set_base(base_revision)
2598
if merger.base_rev_id == merger.other_rev_id:
2599
note('Nothing to do.')
2601
merger.backup_files = backup_files
2602
merger.merge_type = merge_type
2603
merger.set_interesting_files(file_list)
2604
merger.show_base = show_base
2605
merger.reprocess = reprocess
2606
conflicts = merger.do_merge()
2607
if file_list is None:
2608
merger.set_pending()
2614
# these get imported and then picked up by the scan for cmd_*
2615
# TODO: Some more consistent way to split command definitions across files;
2616
# we do need to load at least some information about them to know of
2617
# aliases. ideally we would avoid loading the implementation until the
2618
# details were needed.
2619
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2620
from bzrlib.sign_my_commits import cmd_sign_my_commits
2621
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
2622
cmd_weave_plan_merge, cmd_weave_merge_text