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
from bzrlib.revision import common_ancestor
30
import bzrlib.errors as errors
31
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError,
32
NotBranchError, DivergedBranches, NotConflicted,
33
NoSuchFile, NoWorkingTree, FileInWrongBranch,
35
from bzrlib.log import show_one_log
36
from bzrlib.merge import Merge3Merger
37
from bzrlib.option import Option
38
from bzrlib.progress import DummyProgress, ProgressPhase
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,
276
for glob in sorted(ignored.keys()):
277
match_len = len(ignored[glob])
279
for path in ignored[glob]:
280
print "ignored %s matching \"%s\"" % (path, glob)
282
print "ignored %d file(s) matching \"%s\"" % (match_len,
284
print "If you wish to add some of these files, please add them"\
288
class cmd_mkdir(Command):
289
"""Create a new versioned directory.
291
This is equivalent to creating the directory and then adding it.
293
takes_args = ['dir+']
295
def run(self, dir_list):
298
wt, dd = WorkingTree.open_containing(d)
303
class cmd_relpath(Command):
304
"""Show path of a file relative to root"""
305
takes_args = ['filename']
309
def run(self, filename):
310
tree, relpath = WorkingTree.open_containing(filename)
314
class cmd_inventory(Command):
315
"""Show inventory of the current working copy or a revision.
317
It is possible to limit the output to a particular entry
318
type using the --kind option. For example; --kind file.
320
takes_options = ['revision', 'show-ids', 'kind']
323
def run(self, revision=None, show_ids=False, kind=None):
324
if kind and kind not in ['file', 'directory', 'symlink']:
325
raise BzrCommandError('invalid kind specified')
326
tree = WorkingTree.open_containing(u'.')[0]
328
inv = tree.read_working_inventory()
330
if len(revision) > 1:
331
raise BzrCommandError('bzr inventory --revision takes'
332
' exactly one revision identifier')
333
inv = tree.branch.repository.get_revision_inventory(
334
revision[0].in_history(tree.branch).rev_id)
336
for path, entry in inv.entries():
337
if kind and kind != entry.kind:
340
print '%-50s %s' % (path, entry.file_id)
345
class cmd_mv(Command):
346
"""Move or rename a file.
349
bzr mv OLDNAME NEWNAME
350
bzr mv SOURCE... DESTINATION
352
If the last argument is a versioned directory, all the other names
353
are moved into it. Otherwise, there must be exactly two arguments
354
and the file is changed to a new name, which must not already exist.
356
Files cannot be moved between branches.
358
takes_args = ['names*']
359
aliases = ['move', 'rename']
361
def run(self, names_list):
362
if len(names_list) < 2:
363
raise BzrCommandError("missing file argument")
364
tree, rel_names = tree_files(names_list)
366
if os.path.isdir(names_list[-1]):
367
# move into existing directory
368
for pair in tree.move(rel_names[:-1], rel_names[-1]):
369
print "%s => %s" % pair
371
if len(names_list) != 2:
372
raise BzrCommandError('to mv multiple files the destination '
373
'must be a versioned directory')
374
tree.rename_one(rel_names[0], rel_names[1])
375
print "%s => %s" % (rel_names[0], rel_names[1])
378
class cmd_pull(Command):
379
"""Turn this branch into a mirror of another branch.
381
This command only works on branches that have not diverged. Branches are
382
considered diverged if the destination branch's most recent commit is one
383
that has not been merged (directly or indirectly) into the parent.
385
If branches have diverged, you can use 'bzr merge' to integrate the changes
386
from one into the other. Once one branch has merged, the other should
387
be able to pull it again.
389
If branches have diverged, you can use 'bzr merge' to pull the text changes
390
from one into the other. Once one branch has merged, the other should
391
be able to pull it again.
393
If you want to forget your local changes and just update your branch to
394
match the remote one, use pull --overwrite.
396
If there is no default location set, the first pull will set it. After
397
that, you can omit the location to use the default. To change the
398
default, use --remember.
400
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
401
takes_args = ['location?']
403
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
404
# FIXME: too much stuff is in the command class
406
tree_to = WorkingTree.open_containing(u'.')[0]
407
branch_to = tree_to.branch
408
except NoWorkingTree:
410
branch_to = Branch.open_containing(u'.')[0]
411
stored_loc = branch_to.get_parent()
413
if stored_loc is None:
414
raise BzrCommandError("No pull location known or specified.")
416
print "Using saved location: %s" % stored_loc
417
location = stored_loc
419
if branch_to.get_parent() is None or remember:
420
branch_to.set_parent(location)
422
branch_from = Branch.open(location)
426
elif len(revision) == 1:
427
rev_id = revision[0].in_history(branch_from).rev_id
429
raise BzrCommandError('bzr pull --revision takes one value.')
431
old_rh = branch_to.revision_history()
432
if tree_to is not None:
433
count = tree_to.pull(branch_from, overwrite, rev_id)
435
count = branch_to.pull(branch_from, overwrite, rev_id)
436
note('%d revision(s) pulled.' % (count,))
439
new_rh = branch_to.revision_history()
442
from bzrlib.log import show_changed_revisions
443
show_changed_revisions(branch_to, old_rh, new_rh)
446
class cmd_push(Command):
447
"""Update a mirror of this branch.
449
The target branch will not have its working tree populated because this
450
is both expensive, and is not supported on remote file systems.
452
Some smart servers or protocols *may* put the working tree in place in
455
This command only works on branches that have not diverged. Branches are
456
considered diverged if the destination branch's most recent commit is one
457
that has not been merged (directly or indirectly) by the source branch.
459
If branches have diverged, you can use 'bzr push --overwrite' to replace
460
the other branch completely, discarding its unmerged changes.
462
If you want to ensure you have the different changes in the other branch,
463
do a merge (see bzr help merge) from the other branch, and commit that.
464
After that you will be able to do a push without '--overwrite'.
466
If there is no default push location set, the first push will set it.
467
After that, you can omit the location to use the default. To change the
468
default, use --remember.
470
takes_options = ['remember', 'overwrite',
471
Option('create-prefix',
472
help='Create the path leading up to the branch '
473
'if it does not already exist')]
474
takes_args = ['location?']
476
def run(self, location=None, remember=False, overwrite=False,
477
create_prefix=False, verbose=False):
478
# FIXME: Way too big! Put this into a function called from the
480
from bzrlib.transport import get_transport
482
br_from = Branch.open_containing('.')[0]
483
stored_loc = br_from.get_push_location()
485
if stored_loc is None:
486
raise BzrCommandError("No push location known or specified.")
488
print "Using saved location: %s" % stored_loc
489
location = stored_loc
490
if br_from.get_push_location() is None or remember:
491
br_from.set_push_location(location)
493
dir_to = bzrlib.bzrdir.BzrDir.open(location)
494
br_to = dir_to.open_branch()
495
except NotBranchError:
497
transport = get_transport(location).clone('..')
498
if not create_prefix:
500
transport.mkdir(transport.relpath(location))
502
raise BzrCommandError("Parent directory of %s "
503
"does not exist." % location)
505
current = transport.base
506
needed = [(transport, transport.relpath(location))]
509
transport, relpath = needed[-1]
510
transport.mkdir(relpath)
513
new_transport = transport.clone('..')
514
needed.append((new_transport,
515
new_transport.relpath(transport.base)))
516
if new_transport.base == transport.base:
517
raise BzrCommandError("Could not create "
519
dir_to = br_from.bzrdir.clone(location)
520
br_to = dir_to.open_branch()
521
old_rh = br_to.revision_history()
524
tree_to = dir_to.open_workingtree()
525
except errors.NotLocalUrl:
526
# TODO: This should be updated for branches which don't have a
527
# working tree, as opposed to ones where we just couldn't
529
warning('This transport does not update the working '
530
'tree of: %s' % (br_to.base,))
531
count = br_to.pull(br_from, overwrite)
532
except NoWorkingTree:
533
count = br_to.pull(br_from, overwrite)
535
count = tree_to.pull(br_from, overwrite)
536
except DivergedBranches:
537
raise BzrCommandError("These branches have diverged."
538
" Try a merge then push with overwrite.")
539
note('%d revision(s) pushed.' % (count,))
542
new_rh = br_to.revision_history()
545
from bzrlib.log import show_changed_revisions
546
show_changed_revisions(br_to, old_rh, new_rh)
549
class cmd_branch(Command):
550
"""Create a new copy of a branch.
552
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
553
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
555
To retrieve the branch as of a particular revision, supply the --revision
556
parameter, as in "branch foo/bar -r 5".
558
--basis is to speed up branching from remote branches. When specified, it
559
copies all the file-contents, inventory and revision data from the basis
560
branch before copying anything from the remote branch.
562
takes_args = ['from_location', 'to_location?']
563
takes_options = ['revision', 'basis']
564
aliases = ['get', 'clone']
566
def run(self, from_location, to_location=None, revision=None, basis=None):
567
from bzrlib.osutils import rmtree
570
elif len(revision) > 1:
571
raise BzrCommandError(
572
'bzr branch --revision takes exactly 1 revision value')
574
br_from = Branch.open(from_location)
576
if e.errno == errno.ENOENT:
577
raise BzrCommandError('Source location "%s" does not'
578
' exist.' % to_location)
583
if basis is not None:
584
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
587
if len(revision) == 1 and revision[0] is not None:
588
revision_id = revision[0].in_history(br_from)[1]
590
# FIXME - wt.last_revision, fallback to branch, fall back to
591
# None or perhaps NULL_REVISION to mean copy nothing
593
revision_id = br_from.last_revision()
594
if to_location is None:
595
to_location = os.path.basename(from_location.rstrip("/\\"))
598
name = os.path.basename(to_location) + '\n'
600
os.mkdir(to_location)
602
if e.errno == errno.EEXIST:
603
raise BzrCommandError('Target directory "%s" already'
604
' exists.' % to_location)
605
if e.errno == errno.ENOENT:
606
raise BzrCommandError('Parent of "%s" does not exist.' %
611
# preserve whatever source format we have.
612
dir = br_from.bzrdir.sprout(to_location, revision_id, basis_dir)
613
branch = dir.open_branch()
614
except bzrlib.errors.NoSuchRevision:
616
msg = "The branch %s has no revision %s." % (from_location, revision[0])
617
raise BzrCommandError(msg)
618
except bzrlib.errors.UnlistableBranch:
620
msg = "The branch %s cannot be used as a --basis" % (basis,)
621
raise BzrCommandError(msg)
623
branch.control_files.put_utf8('branch-name', name)
625
note('Branched %d revision(s).' % branch.revno())
630
class cmd_checkout(Command):
631
"""Create a new checkout of an existing branch.
633
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
634
the branch found in '.'. This is useful if you have removed the working tree
635
or if it was never created - i.e. if you pushed the branch to its current
638
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
639
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
641
To retrieve the branch as of a particular revision, supply the --revision
642
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
643
out of date [so you cannot commit] but it may be useful (i.e. to examine old
646
--basis is to speed up checking out from remote branches. When specified, it
647
uses the inventory and file contents from the basis branch in preference to the
648
branch being checked out.
650
takes_args = ['branch_location?', 'to_location?']
651
takes_options = ['revision', # , 'basis']
652
Option('lightweight',
653
help="perform a lightweight checkout. Lightweight "
654
"checkouts depend on access to the branch for "
655
"every operation. Normal checkouts can perform "
656
"common operations like diff and status without "
657
"such access, and also support local commits."
661
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
665
elif len(revision) > 1:
666
raise BzrCommandError(
667
'bzr checkout --revision takes exactly 1 revision value')
668
if branch_location is None:
669
branch_location = bzrlib.osutils.getcwd()
670
to_location = branch_location
671
source = Branch.open(branch_location)
672
if len(revision) == 1 and revision[0] is not None:
673
revision_id = revision[0].in_history(source)[1]
676
if to_location is None:
677
to_location = os.path.basename(branch_location.rstrip("/\\"))
678
# if the source and to_location are the same,
679
# and there is no working tree,
680
# then reconstitute a branch
681
if (bzrlib.osutils.abspath(to_location) ==
682
bzrlib.osutils.abspath(branch_location)):
684
source.bzrdir.open_workingtree()
685
except errors.NoWorkingTree:
686
source.bzrdir.create_workingtree()
689
os.mkdir(to_location)
691
if e.errno == errno.EEXIST:
692
raise BzrCommandError('Target directory "%s" already'
693
' exists.' % to_location)
694
if e.errno == errno.ENOENT:
695
raise BzrCommandError('Parent of "%s" does not exist.' %
699
old_format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
700
bzrlib.bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
703
checkout = bzrdir.BzrDirMetaFormat1().initialize(to_location)
704
bzrlib.branch.BranchReferenceFormat().initialize(checkout, source)
706
checkout_branch = bzrlib.bzrdir.BzrDir.create_branch_convenience(
707
to_location, force_new_tree=False)
708
checkout = checkout_branch.bzrdir
709
checkout_branch.bind(source)
710
if revision_id is not None:
711
rh = checkout_branch.revision_history()
712
checkout_branch.set_revision_history(rh[:rh.index(revision_id) + 1])
713
checkout.create_workingtree(revision_id)
715
bzrlib.bzrdir.BzrDirFormat.set_default_format(old_format)
718
class cmd_renames(Command):
719
"""Show list of renamed files.
721
# TODO: Option to show renames between two historical versions.
723
# TODO: Only show renames under dir, rather than in the whole branch.
724
takes_args = ['dir?']
727
def run(self, dir=u'.'):
728
tree = WorkingTree.open_containing(dir)[0]
729
old_inv = tree.basis_tree().inventory
730
new_inv = tree.read_working_inventory()
732
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
734
for old_name, new_name in renames:
735
print "%s => %s" % (old_name, new_name)
738
class cmd_update(Command):
739
"""Update a tree to have the latest code committed to its branch.
741
This will perform a merge into the working tree, and may generate
742
conflicts. If you have any local changes, you will still
743
need to commit them after the update for the update to be complete.
745
If you want to discard your local changes, you can just do a
746
'bzr revert' instead of 'bzr commit' after the update.
748
takes_args = ['dir?']
750
def run(self, dir='.'):
751
tree = WorkingTree.open_containing(dir)[0]
754
if tree.last_revision() == tree.branch.last_revision():
755
# may be up to date, check master too.
756
master = tree.branch.get_master_branch()
757
if master is None or master.last_revision == tree.last_revision():
758
note("Tree is up to date.")
760
conflicts = tree.update()
761
note('Updated to revision %d.' %
762
(tree.branch.revision_id_to_revno(tree.last_revision()),))
771
class cmd_info(Command):
772
"""Show information about a working tree, branch or repository.
774
This command will show all known locations and formats associated to the
775
tree, branch or repository. Statistical information is included with
778
Branches and working trees will also report any missing revisions.
780
takes_args = ['location?']
781
takes_options = ['verbose']
784
def run(self, location=None, verbose=False):
785
from bzrlib.info import show_bzrdir_info
786
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
790
class cmd_remove(Command):
791
"""Make a file unversioned.
793
This makes bzr stop tracking changes to a versioned file. It does
794
not delete the working copy.
796
takes_args = ['file+']
797
takes_options = ['verbose']
800
def run(self, file_list, verbose=False):
801
tree, file_list = tree_files(file_list)
802
tree.remove(file_list, verbose=verbose)
805
class cmd_file_id(Command):
806
"""Print file_id of a particular file or directory.
808
The file_id is assigned when the file is first added and remains the
809
same through all revisions where the file exists, even when it is
813
takes_args = ['filename']
815
def run(self, filename):
816
tree, relpath = WorkingTree.open_containing(filename)
817
i = tree.inventory.path2id(relpath)
819
raise BzrError("%r is not a versioned file" % filename)
824
class cmd_file_path(Command):
825
"""Print path of file_ids to a file or directory.
827
This prints one line for each directory down to the target,
828
starting at the branch root."""
830
takes_args = ['filename']
832
def run(self, filename):
833
tree, relpath = WorkingTree.open_containing(filename)
835
fid = inv.path2id(relpath)
837
raise BzrError("%r is not a versioned file" % filename)
838
for fip in inv.get_idpath(fid):
842
class cmd_reconcile(Command):
843
"""Reconcile bzr metadata in a branch.
845
This can correct data mismatches that may have been caused by
846
previous ghost operations or bzr upgrades. You should only
847
need to run this command if 'bzr check' or a bzr developer
848
advises you to run it.
850
If a second branch is provided, cross-branch reconciliation is
851
also attempted, which will check that data like the tree root
852
id which was not present in very early bzr versions is represented
853
correctly in both branches.
855
At the same time it is run it may recompress data resulting in
856
a potential saving in disk space or performance gain.
858
The branch *MUST* be on a listable system such as local disk or sftp.
860
takes_args = ['branch?']
862
def run(self, branch="."):
863
from bzrlib.reconcile import reconcile
864
dir = bzrlib.bzrdir.BzrDir.open(branch)
868
class cmd_revision_history(Command):
869
"""Display list of revision ids on this branch."""
873
branch = WorkingTree.open_containing(u'.')[0].branch
874
for patchid in branch.revision_history():
878
class cmd_ancestry(Command):
879
"""List all revisions merged into this branch."""
883
tree = WorkingTree.open_containing(u'.')[0]
885
# FIXME. should be tree.last_revision
886
for revision_id in b.repository.get_ancestry(b.last_revision()):
890
class cmd_init(Command):
891
"""Make a directory into a versioned branch.
893
Use this to create an empty branch, or before importing an
896
If there is a repository in a parent directory of the location, then
897
the history of the branch will be stored in the repository. Otherwise
898
init creates a standalone branch which carries its own history in
901
If there is already a branch at the location but it has no working tree,
902
the tree can be populated with 'bzr checkout'.
904
Recipe for importing a tree of files:
909
bzr commit -m 'imported project'
911
takes_args = ['location?']
914
help='Specify a format for this branch. Current'
915
' formats are: default, knit, metaweave and'
916
' weave. Default is knit; metaweave and'
917
' weave are deprecated',
918
type=get_format_type),
920
def run(self, location=None, format=None):
921
from bzrlib.branch import Branch
923
format = get_format_type('default')
927
# The path has to exist to initialize a
928
# branch inside of it.
929
# Just using os.mkdir, since I don't
930
# believe that we want to create a bunch of
931
# locations if the user supplies an extended path
932
if not os.path.exists(location):
935
existing_bzrdir = bzrdir.BzrDir.open(location)
936
except NotBranchError:
937
# really a NotBzrDir error...
938
bzrdir.BzrDir.create_branch_convenience(location, format=format)
940
if existing_bzrdir.has_branch():
941
if existing_bzrdir.has_workingtree():
942
raise errors.AlreadyBranchError(location)
944
raise errors.BranchExistsWithoutWorkingTree(location)
946
existing_bzrdir.create_branch()
947
existing_bzrdir.create_workingtree()
950
class cmd_init_repository(Command):
951
"""Create a shared repository to hold branches.
953
New branches created under the repository directory will store their revisions
954
in the repository, not in the branch directory, if the branch format supports
960
bzr checkout --lightweight repo/trunk trunk-checkout
964
takes_args = ["location"]
965
takes_options = [Option('format',
966
help='Specify a format for this repository.'
967
' Current formats are: default, knit,'
968
' metaweave and weave. Default is knit;'
969
' metaweave and weave are deprecated',
970
type=get_format_type),
972
help='Allows branches in repository to have'
974
aliases = ["init-repo"]
975
def run(self, location, format=None, trees=False):
976
from bzrlib.transport import get_transport
978
format = get_format_type('default')
979
transport = get_transport(location)
980
if not transport.has('.'):
982
newdir = format.initialize_on_transport(transport)
983
repo = newdir.create_repository(shared=True)
984
repo.set_make_working_trees(trees)
987
class cmd_diff(Command):
988
"""Show differences in working tree.
990
If files are listed, only the changes in those files are listed.
991
Otherwise, all changes for the tree are listed.
998
# TODO: Allow diff across branches.
999
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1000
# or a graphical diff.
1002
# TODO: Python difflib is not exactly the same as unidiff; should
1003
# either fix it up or prefer to use an external diff.
1005
# TODO: If a directory is given, diff everything under that.
1007
# TODO: Selected-file diff is inefficient and doesn't show you
1010
# TODO: This probably handles non-Unix newlines poorly.
1012
takes_args = ['file*']
1013
takes_options = ['revision', 'diff-options', 'diff-prefix']
1014
aliases = ['di', 'dif']
1017
def run(self, revision=None, file_list=None, diff_options=None,
1019
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1022
if not ':' in diff_prefix:
1023
raise BzrError("--diff-prefix expects two values separated by a colon")
1024
old_label,new_label=diff_prefix.split(":")
1030
tree1, file_list = internal_tree_files(file_list)
1034
except FileInWrongBranch:
1035
if len(file_list) != 2:
1036
raise BzrCommandError("Files are in different branches")
1038
tree1, file1 = WorkingTree.open_containing(file_list[0])
1039
tree2, file2 = WorkingTree.open_containing(file_list[1])
1040
if file1 != "" or file2 != "":
1041
# FIXME diff those two files. rbc 20051123
1042
raise BzrCommandError("Files are in different branches")
1044
if revision is not None:
1045
if tree2 is not None:
1046
raise BzrCommandError("Can't specify -r with two branches")
1047
if (len(revision) == 1) or (revision[1].spec is None):
1048
return diff_cmd_helper(tree1, file_list, diff_options,
1050
old_label=old_label, new_label=new_label)
1051
elif len(revision) == 2:
1052
return diff_cmd_helper(tree1, file_list, diff_options,
1053
revision[0], revision[1],
1054
old_label=old_label, new_label=new_label)
1056
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
1058
if tree2 is not None:
1059
return show_diff_trees(tree1, tree2, sys.stdout,
1060
specific_files=file_list,
1061
external_diff_options=diff_options,
1062
old_label=old_label, new_label=new_label)
1064
return diff_cmd_helper(tree1, file_list, diff_options,
1065
old_label=old_label, new_label=new_label)
1068
class cmd_deleted(Command):
1069
"""List files deleted in the working tree.
1071
# TODO: Show files deleted since a previous revision, or
1072
# between two revisions.
1073
# TODO: Much more efficient way to do this: read in new
1074
# directories with readdir, rather than stating each one. Same
1075
# level of effort but possibly much less IO. (Or possibly not,
1076
# if the directories are very large...)
1078
def run(self, show_ids=False):
1079
tree = WorkingTree.open_containing(u'.')[0]
1080
old = tree.basis_tree()
1081
for path, ie in old.inventory.iter_entries():
1082
if not tree.has_id(ie.file_id):
1084
print '%-50s %s' % (path, ie.file_id)
1089
class cmd_modified(Command):
1090
"""List files modified in working tree."""
1094
from bzrlib.delta import compare_trees
1096
tree = WorkingTree.open_containing(u'.')[0]
1097
td = compare_trees(tree.basis_tree(), tree)
1099
for path, id, kind, text_modified, meta_modified in td.modified:
1104
class cmd_added(Command):
1105
"""List files added in working tree."""
1109
wt = WorkingTree.open_containing(u'.')[0]
1110
basis_inv = wt.basis_tree().inventory
1113
if file_id in basis_inv:
1115
path = inv.id2path(file_id)
1116
if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
1122
class cmd_root(Command):
1123
"""Show the tree root directory.
1125
The root is the nearest enclosing directory with a .bzr control
1127
takes_args = ['filename?']
1129
def run(self, filename=None):
1130
"""Print the branch root."""
1131
tree = WorkingTree.open_containing(filename)[0]
1135
class cmd_log(Command):
1136
"""Show log of a branch, file, or directory.
1138
By default show the log of the branch containing the working directory.
1140
To request a range of logs, you can use the command -r begin..end
1141
-r revision requests a specific revision, -r ..end or -r begin.. are
1147
bzr log -r -10.. http://server/branch
1150
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1152
takes_args = ['location?']
1153
takes_options = [Option('forward',
1154
help='show from oldest to newest'),
1157
help='show files changed in each revision'),
1158
'show-ids', 'revision',
1162
help='show revisions whose message matches this regexp',
1167
def run(self, location=None, timezone='original',
1177
from bzrlib.log import log_formatter, show_log
1179
assert message is None or isinstance(message, basestring), \
1180
"invalid message argument %r" % message
1181
direction = (forward and 'forward') or 'reverse'
1186
# find the file id to log:
1188
dir, fp = bzrdir.BzrDir.open_containing(location)
1189
b = dir.open_branch()
1193
inv = dir.open_workingtree().inventory
1194
except (errors.NotBranchError, errors.NotLocalUrl):
1195
# either no tree, or is remote.
1196
inv = b.basis_tree().inventory
1197
file_id = inv.path2id(fp)
1200
# FIXME ? log the current subdir only RBC 20060203
1201
dir, relpath = bzrdir.BzrDir.open_containing('.')
1202
b = dir.open_branch()
1204
if revision is None:
1207
elif len(revision) == 1:
1208
rev1 = rev2 = revision[0].in_history(b).revno
1209
elif len(revision) == 2:
1210
if revision[0].spec is None:
1211
# missing begin-range means first revision
1214
rev1 = revision[0].in_history(b).revno
1216
if revision[1].spec is None:
1217
# missing end-range means last known revision
1220
rev2 = revision[1].in_history(b).revno
1222
raise BzrCommandError('bzr log --revision takes one or two values.')
1224
# By this point, the revision numbers are converted to the +ve
1225
# form if they were supplied in the -ve form, so we can do
1226
# this comparison in relative safety
1228
(rev2, rev1) = (rev1, rev2)
1230
mutter('encoding log as %r', bzrlib.user_encoding)
1232
# use 'replace' so that we don't abort if trying to write out
1233
# in e.g. the default C locale.
1234
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1236
if (log_format == None):
1237
default = bzrlib.config.BranchConfig(b).log_format()
1238
log_format = get_log_format(long=long, short=short, line=line, default=default)
1240
lf = log_formatter(log_format,
1243
show_timezone=timezone)
1249
direction=direction,
1250
start_revision=rev1,
1255
def get_log_format(long=False, short=False, line=False, default='long'):
1256
log_format = default
1260
log_format = 'short'
1266
class cmd_touching_revisions(Command):
1267
"""Return revision-ids which affected a particular file.
1269
A more user-friendly interface is "bzr log FILE"."""
1271
takes_args = ["filename"]
1273
def run(self, filename):
1274
tree, relpath = WorkingTree.open_containing(filename)
1276
inv = tree.read_working_inventory()
1277
file_id = inv.path2id(relpath)
1278
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1279
print "%6d %s" % (revno, what)
1282
class cmd_ls(Command):
1283
"""List files in a tree.
1285
# TODO: Take a revision or remote path and list that tree instead.
1287
takes_options = ['verbose', 'revision',
1288
Option('non-recursive',
1289
help='don\'t recurse into sub-directories'),
1291
help='Print all paths from the root of the branch.'),
1292
Option('unknown', help='Print unknown files'),
1293
Option('versioned', help='Print versioned files'),
1294
Option('ignored', help='Print ignored files'),
1296
Option('null', help='Null separate the files'),
1299
def run(self, revision=None, verbose=False,
1300
non_recursive=False, from_root=False,
1301
unknown=False, versioned=False, ignored=False,
1304
if verbose and null:
1305
raise BzrCommandError('Cannot set both --verbose and --null')
1306
all = not (unknown or versioned or ignored)
1308
selection = {'I':ignored, '?':unknown, 'V':versioned}
1310
tree, relpath = WorkingTree.open_containing(u'.')
1315
if revision is not None:
1316
tree = tree.branch.repository.revision_tree(
1317
revision[0].in_history(tree.branch).rev_id)
1318
for fp, fc, kind, fid, entry in tree.list_files():
1319
if fp.startswith(relpath):
1320
fp = fp[len(relpath):]
1321
if non_recursive and '/' in fp:
1323
if not all and not selection[fc]:
1326
kindch = entry.kind_character()
1327
print '%-8s %s%s' % (fc, fp, kindch)
1329
sys.stdout.write(fp)
1330
sys.stdout.write('\0')
1336
class cmd_unknowns(Command):
1337
"""List unknown files."""
1340
from bzrlib.osutils import quotefn
1341
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1345
class cmd_ignore(Command):
1346
"""Ignore a command or pattern.
1348
To remove patterns from the ignore list, edit the .bzrignore file.
1350
If the pattern contains a slash, it is compared to the whole path
1351
from the branch root. Otherwise, it is compared to only the last
1352
component of the path. To match a file only in the root directory,
1355
Ignore patterns are case-insensitive on case-insensitive systems.
1357
Note: wildcards must be quoted from the shell on Unix.
1360
bzr ignore ./Makefile
1361
bzr ignore '*.class'
1363
# TODO: Complain if the filename is absolute
1364
takes_args = ['name_pattern']
1366
def run(self, name_pattern):
1367
from bzrlib.atomicfile import AtomicFile
1370
tree, relpath = WorkingTree.open_containing(u'.')
1371
ifn = tree.abspath('.bzrignore')
1373
if os.path.exists(ifn):
1376
igns = f.read().decode('utf-8')
1382
# TODO: If the file already uses crlf-style termination, maybe
1383
# we should use that for the newly added lines?
1385
if igns and igns[-1] != '\n':
1387
igns += name_pattern + '\n'
1390
f = AtomicFile(ifn, 'wt')
1391
f.write(igns.encode('utf-8'))
1396
inv = tree.inventory
1397
if inv.path2id('.bzrignore'):
1398
mutter('.bzrignore is already versioned')
1400
mutter('need to make new .bzrignore file versioned')
1401
tree.add(['.bzrignore'])
1404
class cmd_ignored(Command):
1405
"""List ignored files and the patterns that matched them.
1407
See also: bzr ignore"""
1410
tree = WorkingTree.open_containing(u'.')[0]
1411
for path, file_class, kind, file_id, entry in tree.list_files():
1412
if file_class != 'I':
1414
## XXX: Slightly inefficient since this was already calculated
1415
pat = tree.is_ignored(path)
1416
print '%-50s %s' % (path, pat)
1419
class cmd_lookup_revision(Command):
1420
"""Lookup the revision-id from a revision-number
1423
bzr lookup-revision 33
1426
takes_args = ['revno']
1429
def run(self, revno):
1433
raise BzrCommandError("not a valid revision-number: %r" % revno)
1435
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1438
class cmd_export(Command):
1439
"""Export past revision to destination directory.
1441
If no revision is specified this exports the last committed revision.
1443
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1444
given, try to find the format with the extension. If no extension
1445
is found exports to a directory (equivalent to --format=dir).
1447
Root may be the top directory for tar, tgz and tbz2 formats. If none
1448
is given, the top directory will be the root name of the file.
1450
Note: export of tree with non-ascii filenames to zip is not supported.
1452
Supported formats Autodetected by extension
1453
----------------- -------------------------
1456
tbz2 .tar.bz2, .tbz2
1460
takes_args = ['dest']
1461
takes_options = ['revision', 'format', 'root']
1462
def run(self, dest, revision=None, format=None, root=None):
1464
from bzrlib.export import export
1465
tree = WorkingTree.open_containing(u'.')[0]
1467
if revision is None:
1468
# should be tree.last_revision FIXME
1469
rev_id = b.last_revision()
1471
if len(revision) != 1:
1472
raise BzrError('bzr export --revision takes exactly 1 argument')
1473
rev_id = revision[0].in_history(b).rev_id
1474
t = b.repository.revision_tree(rev_id)
1476
export(t, dest, format, root)
1477
except errors.NoSuchExportFormat, e:
1478
raise BzrCommandError('Unsupported export format: %s' % e.format)
1481
class cmd_cat(Command):
1482
"""Write a file's text from a previous revision."""
1484
takes_options = ['revision']
1485
takes_args = ['filename']
1488
def run(self, filename, revision=None):
1489
if revision is not None and len(revision) != 1:
1490
raise BzrCommandError("bzr cat --revision takes exactly one number")
1493
tree, relpath = WorkingTree.open_containing(filename)
1495
except NotBranchError:
1499
b, relpath = Branch.open_containing(filename)
1500
if revision is None:
1501
revision_id = b.last_revision()
1503
revision_id = revision[0].in_history(b).rev_id
1504
b.print_file(relpath, revision_id)
1507
class cmd_local_time_offset(Command):
1508
"""Show the offset in seconds from GMT to local time."""
1512
print bzrlib.osutils.local_time_offset()
1516
class cmd_commit(Command):
1517
"""Commit changes into a new revision.
1519
If no arguments are given, the entire tree is committed.
1521
If selected files are specified, only changes to those files are
1522
committed. If a directory is specified then the directory and everything
1523
within it is committed.
1525
A selected-file commit may fail in some cases where the committed
1526
tree would be invalid, such as trying to commit a file in a
1527
newly-added directory that is not itself committed.
1529
# TODO: Run hooks on tree to-be-committed, and after commit.
1531
# TODO: Strict commit that fails if there are deleted files.
1532
# (what does "deleted files" mean ??)
1534
# TODO: Give better message for -s, --summary, used by tla people
1536
# XXX: verbose currently does nothing
1538
takes_args = ['selected*']
1539
takes_options = ['message', 'verbose',
1541
help='commit even if nothing has changed'),
1542
Option('file', type=str,
1544
help='file containing commit message'),
1546
help="refuse to commit if there are unknown "
1547
"files in the working tree."),
1549
help="perform a local only commit in a bound "
1550
"branch. Such commits are not pushed to "
1551
"the master branch until a normal commit "
1555
aliases = ['ci', 'checkin']
1557
def run(self, message=None, file=None, verbose=True, selected_list=None,
1558
unchanged=False, strict=False, local=False):
1559
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1560
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1562
from bzrlib.msgeditor import edit_commit_message, \
1563
make_commit_message_template
1564
from tempfile import TemporaryFile
1567
# TODO: Need a blackbox test for invoking the external editor; may be
1568
# slightly problematic to run this cross-platform.
1570
# TODO: do more checks that the commit will succeed before
1571
# spending the user's valuable time typing a commit message.
1573
# TODO: if the commit *does* happen to fail, then save the commit
1574
# message to a temporary file where it can be recovered
1575
tree, selected_list = tree_files(selected_list)
1576
if local and not tree.branch.get_bound_location():
1577
raise errors.LocalRequiresBoundBranch()
1578
if message is None and not file:
1579
template = make_commit_message_template(tree, selected_list)
1580
message = edit_commit_message(template)
1582
raise BzrCommandError("please specify a commit message"
1583
" with either --message or --file")
1584
elif message and file:
1585
raise BzrCommandError("please specify either --message or --file")
1589
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1592
raise BzrCommandError("empty commit message specified")
1595
reporter = ReportCommitToLog()
1597
reporter = NullCommitReporter()
1600
tree.commit(message, specific_files=selected_list,
1601
allow_pointless=unchanged, strict=strict, local=local,
1603
except PointlessCommit:
1604
# FIXME: This should really happen before the file is read in;
1605
# perhaps prepare the commit; get the message; then actually commit
1606
raise BzrCommandError("no changes to commit",
1607
["use --unchanged to commit anyhow"])
1608
except ConflictsInTree:
1609
raise BzrCommandError("Conflicts detected in working tree. "
1610
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1611
except StrictCommitFailed:
1612
raise BzrCommandError("Commit refused because there are unknown "
1613
"files in the working tree.")
1614
except errors.BoundBranchOutOfDate, e:
1615
raise BzrCommandError(str(e)
1616
+ ' Either unbind, update, or'
1617
' pass --local to commit.')
1620
class cmd_check(Command):
1621
"""Validate consistency of branch history.
1623
This command checks various invariants about the branch storage to
1624
detect data corruption or bzr bugs.
1626
takes_args = ['branch?']
1627
takes_options = ['verbose']
1629
def run(self, branch=None, verbose=False):
1630
from bzrlib.check import check
1632
tree = WorkingTree.open_containing()[0]
1633
branch = tree.branch
1635
branch = Branch.open(branch)
1636
check(branch, verbose)
1639
class cmd_scan_cache(Command):
1642
from bzrlib.hashcache import HashCache
1648
print '%6d stats' % c.stat_count
1649
print '%6d in hashcache' % len(c._cache)
1650
print '%6d files removed from cache' % c.removed_count
1651
print '%6d hashes updated' % c.update_count
1652
print '%6d files changed too recently to cache' % c.danger_count
1658
class cmd_upgrade(Command):
1659
"""Upgrade branch storage to current format.
1661
The check command or bzr developers may sometimes advise you to run
1662
this command. When the default format has changed you may also be warned
1663
during other operations to upgrade.
1665
takes_args = ['url?']
1668
help='Upgrade to a specific format. Current formats'
1669
' are: default, knit, metaweave and weave.'
1670
' Default is knit; metaweave and weave are'
1672
type=get_format_type),
1676
def run(self, url='.', format=None):
1677
from bzrlib.upgrade import upgrade
1679
format = get_format_type('default')
1680
upgrade(url, format)
1683
class cmd_whoami(Command):
1684
"""Show bzr user id."""
1685
takes_options = ['email']
1688
def run(self, email=False):
1690
b = WorkingTree.open_containing(u'.')[0].branch
1691
config = bzrlib.config.BranchConfig(b)
1692
except NotBranchError:
1693
config = bzrlib.config.GlobalConfig()
1696
print config.user_email()
1698
print config.username()
1701
class cmd_nick(Command):
1702
"""Print or set the branch nickname.
1704
If unset, the tree root directory name is used as the nickname
1705
To print the current nickname, execute with no argument.
1707
takes_args = ['nickname?']
1708
def run(self, nickname=None):
1709
branch = Branch.open_containing(u'.')[0]
1710
if nickname is None:
1711
self.printme(branch)
1713
branch.nick = nickname
1716
def printme(self, branch):
1720
class cmd_selftest(Command):
1721
"""Run internal test suite.
1723
This creates temporary test directories in the working directory,
1724
but not existing data is affected. These directories are deleted
1725
if the tests pass, or left behind to help in debugging if they
1726
fail and --keep-output is specified.
1728
If arguments are given, they are regular expressions that say
1729
which tests should run.
1731
If the global option '--no-plugins' is given, plugins are not loaded
1732
before running the selftests. This has two effects: features provided or
1733
modified by plugins will not be tested, and tests provided by plugins will
1738
bzr --no-plugins selftest -v
1740
# TODO: --list should give a list of all available tests
1742
# NB: this is used from the class without creating an instance, which is
1743
# why it does not have a self parameter.
1744
def get_transport_type(typestring):
1745
"""Parse and return a transport specifier."""
1746
if typestring == "sftp":
1747
from bzrlib.transport.sftp import SFTPAbsoluteServer
1748
return SFTPAbsoluteServer
1749
if typestring == "memory":
1750
from bzrlib.transport.memory import MemoryServer
1752
if typestring == "fakenfs":
1753
from bzrlib.transport.fakenfs import FakeNFSServer
1754
return FakeNFSServer
1755
msg = "No known transport type %s. Supported types are: sftp\n" %\
1757
raise BzrCommandError(msg)
1760
takes_args = ['testspecs*']
1761
takes_options = ['verbose',
1762
Option('one', help='stop when one test fails'),
1763
Option('keep-output',
1764
help='keep output directories when tests fail'),
1766
help='Use a different transport by default '
1767
'throughout the test suite.',
1768
type=get_transport_type),
1771
def run(self, testspecs_list=None, verbose=False, one=False,
1772
keep_output=False, transport=None):
1774
from bzrlib.tests import selftest
1775
# we don't want progress meters from the tests to go to the
1776
# real output; and we don't want log messages cluttering up
1778
save_ui = bzrlib.ui.ui_factory
1779
bzrlib.trace.info('running tests...')
1781
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1782
if testspecs_list is not None:
1783
pattern = '|'.join(testspecs_list)
1786
result = selftest(verbose=verbose,
1788
stop_on_failure=one,
1789
keep_output=keep_output,
1790
transport=transport)
1792
bzrlib.trace.info('tests passed')
1794
bzrlib.trace.info('tests failed')
1795
return int(not result)
1797
bzrlib.ui.ui_factory = save_ui
1800
def _get_bzr_branch():
1801
"""If bzr is run from a branch, return Branch or None"""
1802
import bzrlib.errors
1803
from bzrlib.branch import Branch
1804
from bzrlib.osutils import abspath
1805
from os.path import dirname
1808
branch = Branch.open(dirname(abspath(dirname(__file__))))
1810
except bzrlib.errors.BzrError:
1815
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1816
# is bzrlib itself in a branch?
1817
branch = _get_bzr_branch()
1819
rh = branch.revision_history()
1821
print " bzr checkout, revision %d" % (revno,)
1822
print " nick: %s" % (branch.nick,)
1824
print " revid: %s" % (rh[-1],)
1825
print bzrlib.__copyright__
1826
print "http://bazaar-ng.org/"
1828
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1829
print "you may use, modify and redistribute it under the terms of the GNU"
1830
print "General Public License version 2 or later."
1833
class cmd_version(Command):
1834
"""Show version of bzr."""
1839
class cmd_rocks(Command):
1840
"""Statement of optimism."""
1844
print "it sure does!"
1847
class cmd_find_merge_base(Command):
1848
"""Find and print a base revision for merging two branches.
1850
# TODO: Options to specify revisions on either side, as if
1851
# merging only part of the history.
1852
takes_args = ['branch', 'other']
1856
def run(self, branch, other):
1857
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1859
branch1 = Branch.open_containing(branch)[0]
1860
branch2 = Branch.open_containing(other)[0]
1862
history_1 = branch1.revision_history()
1863
history_2 = branch2.revision_history()
1865
last1 = branch1.last_revision()
1866
last2 = branch2.last_revision()
1868
source = MultipleRevisionSources(branch1.repository,
1871
base_rev_id = common_ancestor(last1, last2, source)
1873
print 'merge base is revision %s' % base_rev_id
1877
if base_revno is None:
1878
raise bzrlib.errors.UnrelatedBranches()
1880
print ' r%-6d in %s' % (base_revno, branch)
1882
other_revno = branch2.revision_id_to_revno(base_revid)
1884
print ' r%-6d in %s' % (other_revno, other)
1888
class cmd_merge(Command):
1889
"""Perform a three-way merge.
1891
The branch is the branch you will merge from. By default, it will
1892
merge the latest revision. If you specify a revision, that
1893
revision will be merged. If you specify two revisions, the first
1894
will be used as a BASE, and the second one as OTHER. Revision
1895
numbers are always relative to the specified branch.
1897
By default, bzr will try to merge in all new work from the other
1898
branch, automatically determining an appropriate base. If this
1899
fails, you may need to give an explicit base.
1901
Merge will do its best to combine the changes in two branches, but there
1902
are some kinds of problems only a human can fix. When it encounters those,
1903
it will mark a conflict. A conflict means that you need to fix something,
1904
before you should commit.
1906
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
1908
If there is no default branch set, the first merge will set it. After
1909
that, you can omit the branch to use the default. To change the
1910
default, use --remember.
1914
To merge the latest revision from bzr.dev
1915
bzr merge ../bzr.dev
1917
To merge changes up to and including revision 82 from bzr.dev
1918
bzr merge -r 82 ../bzr.dev
1920
To merge the changes introduced by 82, without previous changes:
1921
bzr merge -r 81..82 ../bzr.dev
1923
merge refuses to run if there are any uncommitted changes, unless
1926
takes_args = ['branch?']
1927
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
1928
Option('show-base', help="Show base revision text in "
1931
def run(self, branch=None, revision=None, force=False, merge_type=None,
1932
show_base=False, reprocess=False, remember=False):
1933
if merge_type is None:
1934
merge_type = Merge3Merger
1936
tree = WorkingTree.open_containing(u'.')[0]
1937
stored_loc = tree.branch.get_parent()
1939
if stored_loc is None:
1940
raise BzrCommandError("No merge branch known or specified.")
1942
print "Using saved branch: %s" % stored_loc
1945
if tree.branch.get_parent() is None or remember:
1946
tree.branch.set_parent(branch)
1948
if revision is None or len(revision) < 1:
1950
other = [branch, -1]
1951
other_branch, path = Branch.open_containing(branch)
1953
if len(revision) == 1:
1955
other_branch, path = Branch.open_containing(branch)
1956
revno = revision[0].in_history(other_branch).revno
1957
other = [branch, revno]
1959
assert len(revision) == 2
1960
if None in revision:
1961
raise BzrCommandError(
1962
"Merge doesn't permit that revision specifier.")
1963
b, path = Branch.open_containing(branch)
1965
base = [branch, revision[0].in_history(b).revno]
1966
other = [branch, revision[1].in_history(b).revno]
1968
interesting_files = [path]
1970
interesting_files = None
1971
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1974
conflict_count = merge(other, base, check_clean=(not force),
1975
merge_type=merge_type,
1976
reprocess=reprocess,
1977
show_base=show_base,
1978
pb=pb, file_list=interesting_files)
1981
if conflict_count != 0:
1985
except bzrlib.errors.AmbiguousBase, e:
1986
m = ("sorry, bzr can't determine the right merge base yet\n"
1987
"candidates are:\n "
1988
+ "\n ".join(e.bases)
1990
"please specify an explicit base with -r,\n"
1991
"and (if you want) report this to the bzr developers\n")
1995
class cmd_remerge(Command):
1998
takes_args = ['file*']
1999
takes_options = ['merge-type', 'reprocess',
2000
Option('show-base', help="Show base revision text in "
2003
def run(self, file_list=None, merge_type=None, show_base=False,
2005
from bzrlib.merge import merge_inner, transform_tree
2006
if merge_type is None:
2007
merge_type = Merge3Merger
2008
tree, file_list = tree_files(file_list)
2011
pending_merges = tree.pending_merges()
2012
if len(pending_merges) != 1:
2013
raise BzrCommandError("Sorry, remerge only works after normal"
2014
+ " merges. Not cherrypicking or"
2016
repository = tree.branch.repository
2017
base_revision = common_ancestor(tree.branch.last_revision(),
2018
pending_merges[0], repository)
2019
base_tree = repository.revision_tree(base_revision)
2020
other_tree = repository.revision_tree(pending_merges[0])
2021
interesting_ids = None
2022
if file_list is not None:
2023
interesting_ids = set()
2024
for filename in file_list:
2025
file_id = tree.path2id(filename)
2027
raise NotVersionedError(filename)
2028
interesting_ids.add(file_id)
2029
if tree.kind(file_id) != "directory":
2032
for name, ie in tree.inventory.iter_entries(file_id):
2033
interesting_ids.add(ie.file_id)
2034
transform_tree(tree, tree.basis_tree(), interesting_ids)
2035
if file_list is None:
2036
restore_files = list(tree.iter_conflicts())
2038
restore_files = file_list
2039
for filename in restore_files:
2041
restore(tree.abspath(filename))
2042
except NotConflicted:
2044
conflicts = merge_inner(tree.branch, other_tree, base_tree,
2046
interesting_ids = interesting_ids,
2047
other_rev_id=pending_merges[0],
2048
merge_type=merge_type,
2049
show_base=show_base,
2050
reprocess=reprocess)
2058
class cmd_revert(Command):
2059
"""Reverse all changes since the last commit.
2061
Only versioned files are affected. Specify filenames to revert only
2062
those files. By default, any files that are changed will be backed up
2063
first. Backup files have a '~' appended to their name.
2065
takes_options = ['revision', 'no-backup']
2066
takes_args = ['file*']
2067
aliases = ['merge-revert']
2069
def run(self, revision=None, no_backup=False, file_list=None):
2070
from bzrlib.commands import parse_spec
2071
if file_list is not None:
2072
if len(file_list) == 0:
2073
raise BzrCommandError("No files specified")
2077
tree, file_list = tree_files(file_list)
2078
if revision is None:
2079
# FIXME should be tree.last_revision
2080
rev_id = tree.last_revision()
2081
elif len(revision) != 1:
2082
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
2084
rev_id = revision[0].in_history(tree.branch).rev_id
2085
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2087
tree.revert(file_list,
2088
tree.branch.repository.revision_tree(rev_id),
2094
class cmd_assert_fail(Command):
2095
"""Test reporting of assertion failures"""
2098
assert False, "always fails"
2101
class cmd_help(Command):
2102
"""Show help on a command or other topic.
2104
For a list of all available commands, say 'bzr help commands'."""
2105
takes_options = [Option('long', 'show help on all commands')]
2106
takes_args = ['topic?']
2107
aliases = ['?', '--help', '-?', '-h']
2110
def run(self, topic=None, long=False):
2112
if topic is None and long:
2117
class cmd_shell_complete(Command):
2118
"""Show appropriate completions for context.
2120
For a list of all available commands, say 'bzr shell-complete'."""
2121
takes_args = ['context?']
2126
def run(self, context=None):
2127
import shellcomplete
2128
shellcomplete.shellcomplete(context)
2131
class cmd_fetch(Command):
2132
"""Copy in history from another branch but don't merge it.
2134
This is an internal method used for pull and merge."""
2136
takes_args = ['from_branch', 'to_branch']
2137
def run(self, from_branch, to_branch):
2138
from bzrlib.fetch import Fetcher
2139
from bzrlib.branch import Branch
2140
from_b = Branch.open(from_branch)
2141
to_b = Branch.open(to_branch)
2142
Fetcher(to_b, from_b)
2145
class cmd_missing(Command):
2146
"""Show unmerged/unpulled revisions between two branches.
2148
OTHER_BRANCH may be local or remote."""
2149
takes_args = ['other_branch?']
2150
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2152
'Display changes in the local branch only'),
2153
Option('theirs-only',
2154
'Display changes in the remote branch only'),
2163
def run(self, other_branch=None, reverse=False, mine_only=False,
2164
theirs_only=False, log_format=None, long=False, short=False, line=False,
2165
show_ids=False, verbose=False):
2166
from bzrlib.missing import find_unmerged, iter_log_data
2167
from bzrlib.log import log_formatter
2168
local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
2169
parent = local_branch.get_parent()
2170
if other_branch is None:
2171
other_branch = parent
2172
if other_branch is None:
2173
raise BzrCommandError("No missing location known or specified.")
2174
print "Using last location: " + local_branch.get_parent()
2175
remote_branch = bzrlib.branch.Branch.open(other_branch)
2176
if remote_branch.base == local_branch.base:
2177
remote_branch = local_branch
2178
local_branch.lock_read()
2180
remote_branch.lock_read()
2182
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2183
if (log_format == None):
2184
default = bzrlib.config.BranchConfig(local_branch).log_format()
2185
log_format = get_log_format(long=long, short=short, line=line, default=default)
2186
lf = log_formatter(log_format, sys.stdout,
2188
show_timezone='original')
2189
if reverse is False:
2190
local_extra.reverse()
2191
remote_extra.reverse()
2192
if local_extra and not theirs_only:
2193
print "You have %d extra revision(s):" % len(local_extra)
2194
for data in iter_log_data(local_extra, local_branch.repository,
2197
printed_local = True
2199
printed_local = False
2200
if remote_extra and not mine_only:
2201
if printed_local is True:
2203
print "You are missing %d revision(s):" % len(remote_extra)
2204
for data in iter_log_data(remote_extra, remote_branch.repository,
2207
if not remote_extra and not local_extra:
2209
print "Branches are up to date."
2213
remote_branch.unlock()
2215
local_branch.unlock()
2216
if not status_code and parent is None and other_branch is not None:
2217
local_branch.lock_write()
2219
# handle race conditions - a parent might be set while we run.
2220
if local_branch.get_parent() is None:
2221
local_branch.set_parent(other_branch)
2223
local_branch.unlock()
2227
class cmd_plugins(Command):
2232
import bzrlib.plugin
2233
from inspect import getdoc
2234
for name, plugin in bzrlib.plugin.all_plugins().items():
2235
if hasattr(plugin, '__path__'):
2236
print plugin.__path__[0]
2237
elif hasattr(plugin, '__file__'):
2238
print plugin.__file__
2244
print '\t', d.split('\n')[0]
2247
class cmd_testament(Command):
2248
"""Show testament (signing-form) of a revision."""
2249
takes_options = ['revision', 'long']
2250
takes_args = ['branch?']
2252
def run(self, branch=u'.', revision=None, long=False):
2253
from bzrlib.testament import Testament
2254
b = WorkingTree.open_containing(branch)[0].branch
2257
if revision is None:
2258
rev_id = b.last_revision()
2260
rev_id = revision[0].in_history(b).rev_id
2261
t = Testament.from_revision(b.repository, rev_id)
2263
sys.stdout.writelines(t.as_text_lines())
2265
sys.stdout.write(t.as_short_text())
2270
class cmd_annotate(Command):
2271
"""Show the origin of each line in a file.
2273
This prints out the given file with an annotation on the left side
2274
indicating which revision, author and date introduced the change.
2276
If the origin is the same for a run of consecutive lines, it is
2277
shown only at the top, unless the --all option is given.
2279
# TODO: annotate directories; showing when each file was last changed
2280
# TODO: if the working copy is modified, show annotations on that
2281
# with new uncommitted lines marked
2282
aliases = ['blame', 'praise']
2283
takes_args = ['filename']
2284
takes_options = [Option('all', help='show annotations on all lines'),
2285
Option('long', help='show date in annotations'),
2290
def run(self, filename, all=False, long=False, revision=None):
2291
from bzrlib.annotate import annotate_file
2292
tree, relpath = WorkingTree.open_containing(filename)
2293
branch = tree.branch
2296
if revision is None:
2297
revision_id = branch.last_revision()
2298
elif len(revision) != 1:
2299
raise BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2301
revision_id = revision[0].in_history(branch).rev_id
2302
file_id = tree.inventory.path2id(relpath)
2303
tree = branch.repository.revision_tree(revision_id)
2304
file_version = tree.inventory[file_id].revision
2305
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2310
class cmd_re_sign(Command):
2311
"""Create a digital signature for an existing revision."""
2312
# TODO be able to replace existing ones.
2314
hidden = True # is this right ?
2315
takes_args = ['revision_id*']
2316
takes_options = ['revision']
2318
def run(self, revision_id_list=None, revision=None):
2319
import bzrlib.config as config
2320
import bzrlib.gpg as gpg
2321
if revision_id_list is not None and revision is not None:
2322
raise BzrCommandError('You can only supply one of revision_id or --revision')
2323
if revision_id_list is None and revision is None:
2324
raise BzrCommandError('You must supply either --revision or a revision_id')
2325
b = WorkingTree.open_containing(u'.')[0].branch
2326
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
2327
if revision_id_list is not None:
2328
for revision_id in revision_id_list:
2329
b.repository.sign_revision(revision_id, gpg_strategy)
2330
elif revision is not None:
2331
if len(revision) == 1:
2332
revno, rev_id = revision[0].in_history(b)
2333
b.repository.sign_revision(rev_id, gpg_strategy)
2334
elif len(revision) == 2:
2335
# are they both on rh- if so we can walk between them
2336
# might be nice to have a range helper for arbitrary
2337
# revision paths. hmm.
2338
from_revno, from_revid = revision[0].in_history(b)
2339
to_revno, to_revid = revision[1].in_history(b)
2340
if to_revid is None:
2341
to_revno = b.revno()
2342
if from_revno is None or to_revno is None:
2343
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
2344
for revno in range(from_revno, to_revno + 1):
2345
b.repository.sign_revision(b.get_rev_id(revno),
2348
raise BzrCommandError('Please supply either one revision, or a range.')
2351
class cmd_bind(Command):
2352
"""Bind the current branch to a master branch.
2354
After binding, commits must succeed on the master branch
2355
before they are executed on the local one.
2358
takes_args = ['location']
2361
def run(self, location=None):
2362
b, relpath = Branch.open_containing(u'.')
2363
b_other = Branch.open(location)
2366
except DivergedBranches:
2367
raise BzrCommandError('These branches have diverged.'
2368
' Try merging, and then bind again.')
2371
class cmd_unbind(Command):
2372
"""Bind the current branch to its parent.
2374
After unbinding, the local branch is considered independent.
2381
b, relpath = Branch.open_containing(u'.')
2383
raise BzrCommandError('Local branch is not bound')
2386
class cmd_uncommit(bzrlib.commands.Command):
2387
"""Remove the last committed revision.
2389
By supplying the --all flag, it will not only remove the entry
2390
from revision_history, but also remove all of the entries in the
2393
--verbose will print out what is being removed.
2394
--dry-run will go through all the motions, but not actually
2397
In the future, uncommit will create a changeset, which can then
2401
# TODO: jam 20060108 Add an option to allow uncommit to remove
2402
# unreferenced information in 'branch-as-repostory' branches.
2403
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2404
# information in shared branches as well.
2405
takes_options = ['verbose', 'revision',
2406
Option('dry-run', help='Don\'t actually make changes'),
2407
Option('force', help='Say yes to all questions.')]
2408
takes_args = ['location?']
2411
def run(self, location=None,
2412
dry_run=False, verbose=False,
2413
revision=None, force=False):
2414
from bzrlib.branch import Branch
2415
from bzrlib.log import log_formatter
2417
from bzrlib.uncommit import uncommit
2419
if location is None:
2421
control, relpath = bzrdir.BzrDir.open_containing(location)
2423
tree = control.open_workingtree()
2425
except (errors.NoWorkingTree, errors.NotLocalUrl):
2427
b = control.open_branch()
2429
if revision is None:
2431
rev_id = b.last_revision()
2433
revno, rev_id = revision[0].in_history(b)
2435
print 'No revisions to uncommit.'
2437
for r in range(revno, b.revno()+1):
2438
rev_id = b.get_rev_id(r)
2439
lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
2440
lf.show(r, b.repository.get_revision(rev_id), None)
2443
print 'Dry-run, pretending to remove the above revisions.'
2445
val = raw_input('Press <enter> to continue')
2447
print 'The above revision(s) will be removed.'
2449
val = raw_input('Are you sure [y/N]? ')
2450
if val.lower() not in ('y', 'yes'):
2454
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2458
class cmd_break_lock(Command):
2459
"""Break a dead lock on a repository, branch or working directory.
2461
CAUTION: Locks should only be broken when you are sure that the process
2462
holding the lock has been stopped.
2467
takes_args = ['location']
2468
takes_options = [Option('show',
2469
help="just show information on the lock, " \
2472
def run(self, location, show=False):
2473
raise NotImplementedError("sorry, break-lock is not complete yet; "
2474
"you can remove the 'held' directory manually to break the lock")
2477
# command-line interpretation helper for merge-related commands
2478
def merge(other_revision, base_revision,
2479
check_clean=True, ignore_zero=False,
2480
this_dir=None, backup_files=False, merge_type=Merge3Merger,
2481
file_list=None, show_base=False, reprocess=False,
2482
pb=DummyProgress()):
2483
"""Merge changes into a tree.
2486
list(path, revno) Base for three-way merge.
2487
If [None, None] then a base will be automatically determined.
2489
list(path, revno) Other revision for three-way merge.
2491
Directory to merge changes into; '.' by default.
2493
If true, this_dir must have no uncommitted changes before the
2495
ignore_zero - If true, suppress the "zero conflicts" message when
2496
there are no conflicts; should be set when doing something we expect
2497
to complete perfectly.
2498
file_list - If supplied, merge only changes to selected files.
2500
All available ancestors of other_revision and base_revision are
2501
automatically pulled into the branch.
2503
The revno may be -1 to indicate the last revision on the branch, which is
2506
This function is intended for use from the command line; programmatic
2507
clients might prefer to call merge.merge_inner(), which has less magic
2510
from bzrlib.merge import Merger
2511
if this_dir is None:
2513
this_tree = WorkingTree.open_containing(this_dir)[0]
2514
if show_base and not merge_type is Merge3Merger:
2515
raise BzrCommandError("Show-base is not supported for this merge"
2516
" type. %s" % merge_type)
2517
if reprocess and not merge_type.supports_reprocess:
2518
raise BzrCommandError("Conflict reduction is not supported for merge"
2519
" type %s." % merge_type)
2520
if reprocess and show_base:
2521
raise BzrCommandError("Cannot do conflict reduction and show base.")
2523
merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
2524
merger.pp = ProgressPhase("Merge phase", 5, pb)
2525
merger.pp.next_phase()
2526
merger.check_basis(check_clean)
2527
merger.set_other(other_revision)
2528
merger.pp.next_phase()
2529
merger.set_base(base_revision)
2530
if merger.base_rev_id == merger.other_rev_id:
2531
note('Nothing to do.')
2533
merger.backup_files = backup_files
2534
merger.merge_type = merge_type
2535
merger.set_interesting_files(file_list)
2536
merger.show_base = show_base
2537
merger.reprocess = reprocess
2538
conflicts = merger.do_merge()
2539
if file_list is None:
2540
merger.set_pending()
2546
# these get imported and then picked up by the scan for cmd_*
2547
# TODO: Some more consistent way to split command definitions across files;
2548
# we do need to load at least some information about them to know of
2549
# aliases. ideally we would avoid loading the implementation until the
2550
# details were needed.
2551
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2552
from bzrlib.sign_my_commits import cmd_sign_my_commits
2553
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
2554
cmd_weave_plan_merge, cmd_weave_merge_text