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.
993
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
994
produces patches suitable for "patch -p1".
1000
bzr diff --diff-prefix old/:new/
1001
bzr diff bzr.mine bzr.dev
1004
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1005
# or a graphical diff.
1007
# TODO: Python difflib is not exactly the same as unidiff; should
1008
# either fix it up or prefer to use an external diff.
1010
# TODO: Selected-file diff is inefficient and doesn't show you
1013
# TODO: This probably handles non-Unix newlines poorly.
1015
takes_args = ['file*']
1016
takes_options = ['revision', 'diff-options', 'prefix']
1017
aliases = ['di', 'dif']
1020
def run(self, revision=None, file_list=None, diff_options=None,
1022
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1024
if (prefix is None) or (prefix == '0'):
1032
if not ':' in prefix:
1033
raise BzrError("--diff-prefix expects two values separated by a colon")
1034
old_label, new_label = prefix.split(":")
1037
tree1, file_list = internal_tree_files(file_list)
1041
except FileInWrongBranch:
1042
if len(file_list) != 2:
1043
raise BzrCommandError("Files are in different branches")
1045
tree1, file1 = WorkingTree.open_containing(file_list[0])
1046
tree2, file2 = WorkingTree.open_containing(file_list[1])
1047
if file1 != "" or file2 != "":
1048
# FIXME diff those two files. rbc 20051123
1049
raise BzrCommandError("Files are in different branches")
1051
if revision is not None:
1052
if tree2 is not None:
1053
raise BzrCommandError("Can't specify -r with two branches")
1054
if (len(revision) == 1) or (revision[1].spec is None):
1055
return diff_cmd_helper(tree1, file_list, diff_options,
1057
old_label=old_label, new_label=new_label)
1058
elif len(revision) == 2:
1059
return diff_cmd_helper(tree1, file_list, diff_options,
1060
revision[0], revision[1],
1061
old_label=old_label, new_label=new_label)
1063
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
1065
if tree2 is not None:
1066
return show_diff_trees(tree1, tree2, sys.stdout,
1067
specific_files=file_list,
1068
external_diff_options=diff_options,
1069
old_label=old_label, new_label=new_label)
1071
return diff_cmd_helper(tree1, file_list, diff_options,
1072
old_label=old_label, new_label=new_label)
1075
class cmd_deleted(Command):
1076
"""List files deleted in the working tree.
1078
# TODO: Show files deleted since a previous revision, or
1079
# between two revisions.
1080
# TODO: Much more efficient way to do this: read in new
1081
# directories with readdir, rather than stating each one. Same
1082
# level of effort but possibly much less IO. (Or possibly not,
1083
# if the directories are very large...)
1085
def run(self, show_ids=False):
1086
tree = WorkingTree.open_containing(u'.')[0]
1087
old = tree.basis_tree()
1088
for path, ie in old.inventory.iter_entries():
1089
if not tree.has_id(ie.file_id):
1091
print '%-50s %s' % (path, ie.file_id)
1096
class cmd_modified(Command):
1097
"""List files modified in working tree."""
1101
from bzrlib.delta import compare_trees
1103
tree = WorkingTree.open_containing(u'.')[0]
1104
td = compare_trees(tree.basis_tree(), tree)
1106
for path, id, kind, text_modified, meta_modified in td.modified:
1111
class cmd_added(Command):
1112
"""List files added in working tree."""
1116
wt = WorkingTree.open_containing(u'.')[0]
1117
basis_inv = wt.basis_tree().inventory
1120
if file_id in basis_inv:
1122
path = inv.id2path(file_id)
1123
if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
1129
class cmd_root(Command):
1130
"""Show the tree root directory.
1132
The root is the nearest enclosing directory with a .bzr control
1134
takes_args = ['filename?']
1136
def run(self, filename=None):
1137
"""Print the branch root."""
1138
tree = WorkingTree.open_containing(filename)[0]
1142
class cmd_log(Command):
1143
"""Show log of a branch, file, or directory.
1145
By default show the log of the branch containing the working directory.
1147
To request a range of logs, you can use the command -r begin..end
1148
-r revision requests a specific revision, -r ..end or -r begin.. are
1154
bzr log -r -10.. http://server/branch
1157
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1159
takes_args = ['location?']
1160
takes_options = [Option('forward',
1161
help='show from oldest to newest'),
1164
help='show files changed in each revision'),
1165
'show-ids', 'revision',
1169
help='show revisions whose message matches this regexp',
1174
def run(self, location=None, timezone='original',
1184
from bzrlib.log import log_formatter, show_log
1186
assert message is None or isinstance(message, basestring), \
1187
"invalid message argument %r" % message
1188
direction = (forward and 'forward') or 'reverse'
1193
# find the file id to log:
1195
dir, fp = bzrdir.BzrDir.open_containing(location)
1196
b = dir.open_branch()
1200
inv = dir.open_workingtree().inventory
1201
except (errors.NotBranchError, errors.NotLocalUrl):
1202
# either no tree, or is remote.
1203
inv = b.basis_tree().inventory
1204
file_id = inv.path2id(fp)
1207
# FIXME ? log the current subdir only RBC 20060203
1208
dir, relpath = bzrdir.BzrDir.open_containing('.')
1209
b = dir.open_branch()
1211
if revision is None:
1214
elif len(revision) == 1:
1215
rev1 = rev2 = revision[0].in_history(b).revno
1216
elif len(revision) == 2:
1217
if revision[0].spec is None:
1218
# missing begin-range means first revision
1221
rev1 = revision[0].in_history(b).revno
1223
if revision[1].spec is None:
1224
# missing end-range means last known revision
1227
rev2 = revision[1].in_history(b).revno
1229
raise BzrCommandError('bzr log --revision takes one or two values.')
1231
# By this point, the revision numbers are converted to the +ve
1232
# form if they were supplied in the -ve form, so we can do
1233
# this comparison in relative safety
1235
(rev2, rev1) = (rev1, rev2)
1237
mutter('encoding log as %r', bzrlib.user_encoding)
1239
# use 'replace' so that we don't abort if trying to write out
1240
# in e.g. the default C locale.
1241
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1243
if (log_format == None):
1244
default = bzrlib.config.BranchConfig(b).log_format()
1245
log_format = get_log_format(long=long, short=short, line=line, default=default)
1247
lf = log_formatter(log_format,
1250
show_timezone=timezone)
1256
direction=direction,
1257
start_revision=rev1,
1262
def get_log_format(long=False, short=False, line=False, default='long'):
1263
log_format = default
1267
log_format = 'short'
1273
class cmd_touching_revisions(Command):
1274
"""Return revision-ids which affected a particular file.
1276
A more user-friendly interface is "bzr log FILE"."""
1278
takes_args = ["filename"]
1280
def run(self, filename):
1281
tree, relpath = WorkingTree.open_containing(filename)
1283
inv = tree.read_working_inventory()
1284
file_id = inv.path2id(relpath)
1285
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1286
print "%6d %s" % (revno, what)
1289
class cmd_ls(Command):
1290
"""List files in a tree.
1292
# TODO: Take a revision or remote path and list that tree instead.
1294
takes_options = ['verbose', 'revision',
1295
Option('non-recursive',
1296
help='don\'t recurse into sub-directories'),
1298
help='Print all paths from the root of the branch.'),
1299
Option('unknown', help='Print unknown files'),
1300
Option('versioned', help='Print versioned files'),
1301
Option('ignored', help='Print ignored files'),
1303
Option('null', help='Null separate the files'),
1306
def run(self, revision=None, verbose=False,
1307
non_recursive=False, from_root=False,
1308
unknown=False, versioned=False, ignored=False,
1311
if verbose and null:
1312
raise BzrCommandError('Cannot set both --verbose and --null')
1313
all = not (unknown or versioned or ignored)
1315
selection = {'I':ignored, '?':unknown, 'V':versioned}
1317
tree, relpath = WorkingTree.open_containing(u'.')
1322
if revision is not None:
1323
tree = tree.branch.repository.revision_tree(
1324
revision[0].in_history(tree.branch).rev_id)
1325
for fp, fc, kind, fid, entry in tree.list_files():
1326
if fp.startswith(relpath):
1327
fp = fp[len(relpath):]
1328
if non_recursive and '/' in fp:
1330
if not all and not selection[fc]:
1333
kindch = entry.kind_character()
1334
print '%-8s %s%s' % (fc, fp, kindch)
1336
sys.stdout.write(fp)
1337
sys.stdout.write('\0')
1343
class cmd_unknowns(Command):
1344
"""List unknown files."""
1347
from bzrlib.osutils import quotefn
1348
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1352
class cmd_ignore(Command):
1353
"""Ignore a command or pattern.
1355
To remove patterns from the ignore list, edit the .bzrignore file.
1357
If the pattern contains a slash, it is compared to the whole path
1358
from the branch root. Otherwise, it is compared to only the last
1359
component of the path. To match a file only in the root directory,
1362
Ignore patterns are case-insensitive on case-insensitive systems.
1364
Note: wildcards must be quoted from the shell on Unix.
1367
bzr ignore ./Makefile
1368
bzr ignore '*.class'
1370
# TODO: Complain if the filename is absolute
1371
takes_args = ['name_pattern']
1373
def run(self, name_pattern):
1374
from bzrlib.atomicfile import AtomicFile
1377
tree, relpath = WorkingTree.open_containing(u'.')
1378
ifn = tree.abspath('.bzrignore')
1380
if os.path.exists(ifn):
1383
igns = f.read().decode('utf-8')
1389
# TODO: If the file already uses crlf-style termination, maybe
1390
# we should use that for the newly added lines?
1392
if igns and igns[-1] != '\n':
1394
igns += name_pattern + '\n'
1397
f = AtomicFile(ifn, 'wt')
1398
f.write(igns.encode('utf-8'))
1403
inv = tree.inventory
1404
if inv.path2id('.bzrignore'):
1405
mutter('.bzrignore is already versioned')
1407
mutter('need to make new .bzrignore file versioned')
1408
tree.add(['.bzrignore'])
1411
class cmd_ignored(Command):
1412
"""List ignored files and the patterns that matched them.
1414
See also: bzr ignore"""
1417
tree = WorkingTree.open_containing(u'.')[0]
1418
for path, file_class, kind, file_id, entry in tree.list_files():
1419
if file_class != 'I':
1421
## XXX: Slightly inefficient since this was already calculated
1422
pat = tree.is_ignored(path)
1423
print '%-50s %s' % (path, pat)
1426
class cmd_lookup_revision(Command):
1427
"""Lookup the revision-id from a revision-number
1430
bzr lookup-revision 33
1433
takes_args = ['revno']
1436
def run(self, revno):
1440
raise BzrCommandError("not a valid revision-number: %r" % revno)
1442
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1445
class cmd_export(Command):
1446
"""Export past revision to destination directory.
1448
If no revision is specified this exports the last committed revision.
1450
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1451
given, try to find the format with the extension. If no extension
1452
is found exports to a directory (equivalent to --format=dir).
1454
Root may be the top directory for tar, tgz and tbz2 formats. If none
1455
is given, the top directory will be the root name of the file.
1457
Note: export of tree with non-ascii filenames to zip is not supported.
1459
Supported formats Autodetected by extension
1460
----------------- -------------------------
1463
tbz2 .tar.bz2, .tbz2
1467
takes_args = ['dest']
1468
takes_options = ['revision', 'format', 'root']
1469
def run(self, dest, revision=None, format=None, root=None):
1471
from bzrlib.export import export
1472
tree = WorkingTree.open_containing(u'.')[0]
1474
if revision is None:
1475
# should be tree.last_revision FIXME
1476
rev_id = b.last_revision()
1478
if len(revision) != 1:
1479
raise BzrError('bzr export --revision takes exactly 1 argument')
1480
rev_id = revision[0].in_history(b).rev_id
1481
t = b.repository.revision_tree(rev_id)
1483
export(t, dest, format, root)
1484
except errors.NoSuchExportFormat, e:
1485
raise BzrCommandError('Unsupported export format: %s' % e.format)
1488
class cmd_cat(Command):
1489
"""Write a file's text from a previous revision."""
1491
takes_options = ['revision']
1492
takes_args = ['filename']
1495
def run(self, filename, revision=None):
1496
if revision is not None and len(revision) != 1:
1497
raise BzrCommandError("bzr cat --revision takes exactly one number")
1500
tree, relpath = WorkingTree.open_containing(filename)
1502
except NotBranchError:
1506
b, relpath = Branch.open_containing(filename)
1507
if revision is None:
1508
revision_id = b.last_revision()
1510
revision_id = revision[0].in_history(b).rev_id
1511
b.print_file(relpath, revision_id)
1514
class cmd_local_time_offset(Command):
1515
"""Show the offset in seconds from GMT to local time."""
1519
print bzrlib.osutils.local_time_offset()
1523
class cmd_commit(Command):
1524
"""Commit changes into a new revision.
1526
If no arguments are given, the entire tree is committed.
1528
If selected files are specified, only changes to those files are
1529
committed. If a directory is specified then the directory and everything
1530
within it is committed.
1532
A selected-file commit may fail in some cases where the committed
1533
tree would be invalid, such as trying to commit a file in a
1534
newly-added directory that is not itself committed.
1536
# TODO: Run hooks on tree to-be-committed, and after commit.
1538
# TODO: Strict commit that fails if there are deleted files.
1539
# (what does "deleted files" mean ??)
1541
# TODO: Give better message for -s, --summary, used by tla people
1543
# XXX: verbose currently does nothing
1545
takes_args = ['selected*']
1546
takes_options = ['message', 'verbose',
1548
help='commit even if nothing has changed'),
1549
Option('file', type=str,
1551
help='file containing commit message'),
1553
help="refuse to commit if there are unknown "
1554
"files in the working tree."),
1556
help="perform a local only commit in a bound "
1557
"branch. Such commits are not pushed to "
1558
"the master branch until a normal commit "
1562
aliases = ['ci', 'checkin']
1564
def run(self, message=None, file=None, verbose=True, selected_list=None,
1565
unchanged=False, strict=False, local=False):
1566
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1567
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1569
from bzrlib.msgeditor import edit_commit_message, \
1570
make_commit_message_template
1571
from tempfile import TemporaryFile
1574
# TODO: Need a blackbox test for invoking the external editor; may be
1575
# slightly problematic to run this cross-platform.
1577
# TODO: do more checks that the commit will succeed before
1578
# spending the user's valuable time typing a commit message.
1580
# TODO: if the commit *does* happen to fail, then save the commit
1581
# message to a temporary file where it can be recovered
1582
tree, selected_list = tree_files(selected_list)
1583
if local and not tree.branch.get_bound_location():
1584
raise errors.LocalRequiresBoundBranch()
1585
if message is None and not file:
1586
template = make_commit_message_template(tree, selected_list)
1587
message = edit_commit_message(template)
1589
raise BzrCommandError("please specify a commit message"
1590
" with either --message or --file")
1591
elif message and file:
1592
raise BzrCommandError("please specify either --message or --file")
1596
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1599
raise BzrCommandError("empty commit message specified")
1602
reporter = ReportCommitToLog()
1604
reporter = NullCommitReporter()
1607
tree.commit(message, specific_files=selected_list,
1608
allow_pointless=unchanged, strict=strict, local=local,
1610
except PointlessCommit:
1611
# FIXME: This should really happen before the file is read in;
1612
# perhaps prepare the commit; get the message; then actually commit
1613
raise BzrCommandError("no changes to commit",
1614
["use --unchanged to commit anyhow"])
1615
except ConflictsInTree:
1616
raise BzrCommandError("Conflicts detected in working tree. "
1617
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1618
except StrictCommitFailed:
1619
raise BzrCommandError("Commit refused because there are unknown "
1620
"files in the working tree.")
1621
except errors.BoundBranchOutOfDate, e:
1622
raise BzrCommandError(str(e)
1623
+ ' Either unbind, update, or'
1624
' pass --local to commit.')
1627
class cmd_check(Command):
1628
"""Validate consistency of branch history.
1630
This command checks various invariants about the branch storage to
1631
detect data corruption or bzr bugs.
1633
takes_args = ['branch?']
1634
takes_options = ['verbose']
1636
def run(self, branch=None, verbose=False):
1637
from bzrlib.check import check
1639
tree = WorkingTree.open_containing()[0]
1640
branch = tree.branch
1642
branch = Branch.open(branch)
1643
check(branch, verbose)
1646
class cmd_scan_cache(Command):
1649
from bzrlib.hashcache import HashCache
1655
print '%6d stats' % c.stat_count
1656
print '%6d in hashcache' % len(c._cache)
1657
print '%6d files removed from cache' % c.removed_count
1658
print '%6d hashes updated' % c.update_count
1659
print '%6d files changed too recently to cache' % c.danger_count
1665
class cmd_upgrade(Command):
1666
"""Upgrade branch storage to current format.
1668
The check command or bzr developers may sometimes advise you to run
1669
this command. When the default format has changed you may also be warned
1670
during other operations to upgrade.
1672
takes_args = ['url?']
1675
help='Upgrade to a specific format. Current formats'
1676
' are: default, knit, metaweave and weave.'
1677
' Default is knit; metaweave and weave are'
1679
type=get_format_type),
1683
def run(self, url='.', format=None):
1684
from bzrlib.upgrade import upgrade
1686
format = get_format_type('default')
1687
upgrade(url, format)
1690
class cmd_whoami(Command):
1691
"""Show bzr user id."""
1692
takes_options = ['email']
1695
def run(self, email=False):
1697
b = WorkingTree.open_containing(u'.')[0].branch
1698
config = bzrlib.config.BranchConfig(b)
1699
except NotBranchError:
1700
config = bzrlib.config.GlobalConfig()
1703
print config.user_email()
1705
print config.username()
1708
class cmd_nick(Command):
1709
"""Print or set the branch nickname.
1711
If unset, the tree root directory name is used as the nickname
1712
To print the current nickname, execute with no argument.
1714
takes_args = ['nickname?']
1715
def run(self, nickname=None):
1716
branch = Branch.open_containing(u'.')[0]
1717
if nickname is None:
1718
self.printme(branch)
1720
branch.nick = nickname
1723
def printme(self, branch):
1727
class cmd_selftest(Command):
1728
"""Run internal test suite.
1730
This creates temporary test directories in the working directory,
1731
but not existing data is affected. These directories are deleted
1732
if the tests pass, or left behind to help in debugging if they
1733
fail and --keep-output is specified.
1735
If arguments are given, they are regular expressions that say
1736
which tests should run.
1738
If the global option '--no-plugins' is given, plugins are not loaded
1739
before running the selftests. This has two effects: features provided or
1740
modified by plugins will not be tested, and tests provided by plugins will
1745
bzr --no-plugins selftest -v
1747
# TODO: --list should give a list of all available tests
1749
# NB: this is used from the class without creating an instance, which is
1750
# why it does not have a self parameter.
1751
def get_transport_type(typestring):
1752
"""Parse and return a transport specifier."""
1753
if typestring == "sftp":
1754
from bzrlib.transport.sftp import SFTPAbsoluteServer
1755
return SFTPAbsoluteServer
1756
if typestring == "memory":
1757
from bzrlib.transport.memory import MemoryServer
1759
if typestring == "fakenfs":
1760
from bzrlib.transport.fakenfs import FakeNFSServer
1761
return FakeNFSServer
1762
msg = "No known transport type %s. Supported types are: sftp\n" %\
1764
raise BzrCommandError(msg)
1767
takes_args = ['testspecs*']
1768
takes_options = ['verbose',
1769
Option('one', help='stop when one test fails'),
1770
Option('keep-output',
1771
help='keep output directories when tests fail'),
1773
help='Use a different transport by default '
1774
'throughout the test suite.',
1775
type=get_transport_type),
1778
def run(self, testspecs_list=None, verbose=False, one=False,
1779
keep_output=False, transport=None):
1781
from bzrlib.tests import selftest
1782
# we don't want progress meters from the tests to go to the
1783
# real output; and we don't want log messages cluttering up
1785
save_ui = bzrlib.ui.ui_factory
1786
bzrlib.trace.info('running tests...')
1788
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1789
if testspecs_list is not None:
1790
pattern = '|'.join(testspecs_list)
1793
result = selftest(verbose=verbose,
1795
stop_on_failure=one,
1796
keep_output=keep_output,
1797
transport=transport)
1799
bzrlib.trace.info('tests passed')
1801
bzrlib.trace.info('tests failed')
1802
return int(not result)
1804
bzrlib.ui.ui_factory = save_ui
1807
def _get_bzr_branch():
1808
"""If bzr is run from a branch, return Branch or None"""
1809
import bzrlib.errors
1810
from bzrlib.branch import Branch
1811
from bzrlib.osutils import abspath
1812
from os.path import dirname
1815
branch = Branch.open(dirname(abspath(dirname(__file__))))
1817
except bzrlib.errors.BzrError:
1822
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1823
# is bzrlib itself in a branch?
1824
branch = _get_bzr_branch()
1826
rh = branch.revision_history()
1828
print " bzr checkout, revision %d" % (revno,)
1829
print " nick: %s" % (branch.nick,)
1831
print " revid: %s" % (rh[-1],)
1832
print bzrlib.__copyright__
1833
print "http://bazaar-ng.org/"
1835
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1836
print "you may use, modify and redistribute it under the terms of the GNU"
1837
print "General Public License version 2 or later."
1840
class cmd_version(Command):
1841
"""Show version of bzr."""
1846
class cmd_rocks(Command):
1847
"""Statement of optimism."""
1851
print "it sure does!"
1854
class cmd_find_merge_base(Command):
1855
"""Find and print a base revision for merging two branches.
1857
# TODO: Options to specify revisions on either side, as if
1858
# merging only part of the history.
1859
takes_args = ['branch', 'other']
1863
def run(self, branch, other):
1864
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1866
branch1 = Branch.open_containing(branch)[0]
1867
branch2 = Branch.open_containing(other)[0]
1869
history_1 = branch1.revision_history()
1870
history_2 = branch2.revision_history()
1872
last1 = branch1.last_revision()
1873
last2 = branch2.last_revision()
1875
source = MultipleRevisionSources(branch1.repository,
1878
base_rev_id = common_ancestor(last1, last2, source)
1880
print 'merge base is revision %s' % base_rev_id
1884
if base_revno is None:
1885
raise bzrlib.errors.UnrelatedBranches()
1887
print ' r%-6d in %s' % (base_revno, branch)
1889
other_revno = branch2.revision_id_to_revno(base_revid)
1891
print ' r%-6d in %s' % (other_revno, other)
1895
class cmd_merge(Command):
1896
"""Perform a three-way merge.
1898
The branch is the branch you will merge from. By default, it will
1899
merge the latest revision. If you specify a revision, that
1900
revision will be merged. If you specify two revisions, the first
1901
will be used as a BASE, and the second one as OTHER. Revision
1902
numbers are always relative to the specified branch.
1904
By default, bzr will try to merge in all new work from the other
1905
branch, automatically determining an appropriate base. If this
1906
fails, you may need to give an explicit base.
1908
Merge will do its best to combine the changes in two branches, but there
1909
are some kinds of problems only a human can fix. When it encounters those,
1910
it will mark a conflict. A conflict means that you need to fix something,
1911
before you should commit.
1913
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
1915
If there is no default branch set, the first merge will set it. After
1916
that, you can omit the branch to use the default. To change the
1917
default, use --remember.
1921
To merge the latest revision from bzr.dev
1922
bzr merge ../bzr.dev
1924
To merge changes up to and including revision 82 from bzr.dev
1925
bzr merge -r 82 ../bzr.dev
1927
To merge the changes introduced by 82, without previous changes:
1928
bzr merge -r 81..82 ../bzr.dev
1930
merge refuses to run if there are any uncommitted changes, unless
1933
takes_args = ['branch?']
1934
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
1935
Option('show-base', help="Show base revision text in "
1938
def run(self, branch=None, revision=None, force=False, merge_type=None,
1939
show_base=False, reprocess=False, remember=False):
1940
if merge_type is None:
1941
merge_type = Merge3Merger
1943
tree = WorkingTree.open_containing(u'.')[0]
1944
stored_loc = tree.branch.get_parent()
1946
if stored_loc is None:
1947
raise BzrCommandError("No merge branch known or specified.")
1949
print "Using saved branch: %s" % stored_loc
1952
if tree.branch.get_parent() is None or remember:
1953
tree.branch.set_parent(branch)
1955
if revision is None or len(revision) < 1:
1957
other = [branch, -1]
1958
other_branch, path = Branch.open_containing(branch)
1960
if len(revision) == 1:
1962
other_branch, path = Branch.open_containing(branch)
1963
revno = revision[0].in_history(other_branch).revno
1964
other = [branch, revno]
1966
assert len(revision) == 2
1967
if None in revision:
1968
raise BzrCommandError(
1969
"Merge doesn't permit that revision specifier.")
1970
b, path = Branch.open_containing(branch)
1972
base = [branch, revision[0].in_history(b).revno]
1973
other = [branch, revision[1].in_history(b).revno]
1975
interesting_files = [path]
1977
interesting_files = None
1978
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1981
conflict_count = merge(other, base, check_clean=(not force),
1982
merge_type=merge_type,
1983
reprocess=reprocess,
1984
show_base=show_base,
1985
pb=pb, file_list=interesting_files)
1988
if conflict_count != 0:
1992
except bzrlib.errors.AmbiguousBase, e:
1993
m = ("sorry, bzr can't determine the right merge base yet\n"
1994
"candidates are:\n "
1995
+ "\n ".join(e.bases)
1997
"please specify an explicit base with -r,\n"
1998
"and (if you want) report this to the bzr developers\n")
2002
class cmd_remerge(Command):
2005
takes_args = ['file*']
2006
takes_options = ['merge-type', 'reprocess',
2007
Option('show-base', help="Show base revision text in "
2010
def run(self, file_list=None, merge_type=None, show_base=False,
2012
from bzrlib.merge import merge_inner, transform_tree
2013
if merge_type is None:
2014
merge_type = Merge3Merger
2015
tree, file_list = tree_files(file_list)
2018
pending_merges = tree.pending_merges()
2019
if len(pending_merges) != 1:
2020
raise BzrCommandError("Sorry, remerge only works after normal"
2021
+ " merges. Not cherrypicking or"
2023
repository = tree.branch.repository
2024
base_revision = common_ancestor(tree.branch.last_revision(),
2025
pending_merges[0], repository)
2026
base_tree = repository.revision_tree(base_revision)
2027
other_tree = repository.revision_tree(pending_merges[0])
2028
interesting_ids = None
2029
if file_list is not None:
2030
interesting_ids = set()
2031
for filename in file_list:
2032
file_id = tree.path2id(filename)
2034
raise NotVersionedError(filename)
2035
interesting_ids.add(file_id)
2036
if tree.kind(file_id) != "directory":
2039
for name, ie in tree.inventory.iter_entries(file_id):
2040
interesting_ids.add(ie.file_id)
2041
transform_tree(tree, tree.basis_tree(), interesting_ids)
2042
if file_list is None:
2043
restore_files = list(tree.iter_conflicts())
2045
restore_files = file_list
2046
for filename in restore_files:
2048
restore(tree.abspath(filename))
2049
except NotConflicted:
2051
conflicts = merge_inner(tree.branch, other_tree, base_tree,
2053
interesting_ids = interesting_ids,
2054
other_rev_id=pending_merges[0],
2055
merge_type=merge_type,
2056
show_base=show_base,
2057
reprocess=reprocess)
2065
class cmd_revert(Command):
2066
"""Reverse all changes since the last commit.
2068
Only versioned files are affected. Specify filenames to revert only
2069
those files. By default, any files that are changed will be backed up
2070
first. Backup files have a '~' appended to their name.
2072
takes_options = ['revision', 'no-backup']
2073
takes_args = ['file*']
2074
aliases = ['merge-revert']
2076
def run(self, revision=None, no_backup=False, file_list=None):
2077
from bzrlib.commands import parse_spec
2078
if file_list is not None:
2079
if len(file_list) == 0:
2080
raise BzrCommandError("No files specified")
2084
tree, file_list = tree_files(file_list)
2085
if revision is None:
2086
# FIXME should be tree.last_revision
2087
rev_id = tree.last_revision()
2088
elif len(revision) != 1:
2089
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
2091
rev_id = revision[0].in_history(tree.branch).rev_id
2092
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2094
tree.revert(file_list,
2095
tree.branch.repository.revision_tree(rev_id),
2101
class cmd_assert_fail(Command):
2102
"""Test reporting of assertion failures"""
2105
assert False, "always fails"
2108
class cmd_help(Command):
2109
"""Show help on a command or other topic.
2111
For a list of all available commands, say 'bzr help commands'."""
2112
takes_options = [Option('long', 'show help on all commands')]
2113
takes_args = ['topic?']
2114
aliases = ['?', '--help', '-?', '-h']
2117
def run(self, topic=None, long=False):
2119
if topic is None and long:
2124
class cmd_shell_complete(Command):
2125
"""Show appropriate completions for context.
2127
For a list of all available commands, say 'bzr shell-complete'."""
2128
takes_args = ['context?']
2133
def run(self, context=None):
2134
import shellcomplete
2135
shellcomplete.shellcomplete(context)
2138
class cmd_fetch(Command):
2139
"""Copy in history from another branch but don't merge it.
2141
This is an internal method used for pull and merge."""
2143
takes_args = ['from_branch', 'to_branch']
2144
def run(self, from_branch, to_branch):
2145
from bzrlib.fetch import Fetcher
2146
from bzrlib.branch import Branch
2147
from_b = Branch.open(from_branch)
2148
to_b = Branch.open(to_branch)
2149
Fetcher(to_b, from_b)
2152
class cmd_missing(Command):
2153
"""Show unmerged/unpulled revisions between two branches.
2155
OTHER_BRANCH may be local or remote."""
2156
takes_args = ['other_branch?']
2157
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2159
'Display changes in the local branch only'),
2160
Option('theirs-only',
2161
'Display changes in the remote branch only'),
2170
def run(self, other_branch=None, reverse=False, mine_only=False,
2171
theirs_only=False, log_format=None, long=False, short=False, line=False,
2172
show_ids=False, verbose=False):
2173
from bzrlib.missing import find_unmerged, iter_log_data
2174
from bzrlib.log import log_formatter
2175
local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
2176
parent = local_branch.get_parent()
2177
if other_branch is None:
2178
other_branch = parent
2179
if other_branch is None:
2180
raise BzrCommandError("No missing location known or specified.")
2181
print "Using last location: " + local_branch.get_parent()
2182
remote_branch = bzrlib.branch.Branch.open(other_branch)
2183
if remote_branch.base == local_branch.base:
2184
remote_branch = local_branch
2185
local_branch.lock_read()
2187
remote_branch.lock_read()
2189
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2190
if (log_format == None):
2191
default = bzrlib.config.BranchConfig(local_branch).log_format()
2192
log_format = get_log_format(long=long, short=short, line=line, default=default)
2193
lf = log_formatter(log_format, sys.stdout,
2195
show_timezone='original')
2196
if reverse is False:
2197
local_extra.reverse()
2198
remote_extra.reverse()
2199
if local_extra and not theirs_only:
2200
print "You have %d extra revision(s):" % len(local_extra)
2201
for data in iter_log_data(local_extra, local_branch.repository,
2204
printed_local = True
2206
printed_local = False
2207
if remote_extra and not mine_only:
2208
if printed_local is True:
2210
print "You are missing %d revision(s):" % len(remote_extra)
2211
for data in iter_log_data(remote_extra, remote_branch.repository,
2214
if not remote_extra and not local_extra:
2216
print "Branches are up to date."
2220
remote_branch.unlock()
2222
local_branch.unlock()
2223
if not status_code and parent is None and other_branch is not None:
2224
local_branch.lock_write()
2226
# handle race conditions - a parent might be set while we run.
2227
if local_branch.get_parent() is None:
2228
local_branch.set_parent(other_branch)
2230
local_branch.unlock()
2234
class cmd_plugins(Command):
2239
import bzrlib.plugin
2240
from inspect import getdoc
2241
for name, plugin in bzrlib.plugin.all_plugins().items():
2242
if hasattr(plugin, '__path__'):
2243
print plugin.__path__[0]
2244
elif hasattr(plugin, '__file__'):
2245
print plugin.__file__
2251
print '\t', d.split('\n')[0]
2254
class cmd_testament(Command):
2255
"""Show testament (signing-form) of a revision."""
2256
takes_options = ['revision', 'long']
2257
takes_args = ['branch?']
2259
def run(self, branch=u'.', revision=None, long=False):
2260
from bzrlib.testament import Testament
2261
b = WorkingTree.open_containing(branch)[0].branch
2264
if revision is None:
2265
rev_id = b.last_revision()
2267
rev_id = revision[0].in_history(b).rev_id
2268
t = Testament.from_revision(b.repository, rev_id)
2270
sys.stdout.writelines(t.as_text_lines())
2272
sys.stdout.write(t.as_short_text())
2277
class cmd_annotate(Command):
2278
"""Show the origin of each line in a file.
2280
This prints out the given file with an annotation on the left side
2281
indicating which revision, author and date introduced the change.
2283
If the origin is the same for a run of consecutive lines, it is
2284
shown only at the top, unless the --all option is given.
2286
# TODO: annotate directories; showing when each file was last changed
2287
# TODO: if the working copy is modified, show annotations on that
2288
# with new uncommitted lines marked
2289
aliases = ['blame', 'praise']
2290
takes_args = ['filename']
2291
takes_options = [Option('all', help='show annotations on all lines'),
2292
Option('long', help='show date in annotations'),
2297
def run(self, filename, all=False, long=False, revision=None):
2298
from bzrlib.annotate import annotate_file
2299
tree, relpath = WorkingTree.open_containing(filename)
2300
branch = tree.branch
2303
if revision is None:
2304
revision_id = branch.last_revision()
2305
elif len(revision) != 1:
2306
raise BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2308
revision_id = revision[0].in_history(branch).rev_id
2309
file_id = tree.inventory.path2id(relpath)
2310
tree = branch.repository.revision_tree(revision_id)
2311
file_version = tree.inventory[file_id].revision
2312
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2317
class cmd_re_sign(Command):
2318
"""Create a digital signature for an existing revision."""
2319
# TODO be able to replace existing ones.
2321
hidden = True # is this right ?
2322
takes_args = ['revision_id*']
2323
takes_options = ['revision']
2325
def run(self, revision_id_list=None, revision=None):
2326
import bzrlib.config as config
2327
import bzrlib.gpg as gpg
2328
if revision_id_list is not None and revision is not None:
2329
raise BzrCommandError('You can only supply one of revision_id or --revision')
2330
if revision_id_list is None and revision is None:
2331
raise BzrCommandError('You must supply either --revision or a revision_id')
2332
b = WorkingTree.open_containing(u'.')[0].branch
2333
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
2334
if revision_id_list is not None:
2335
for revision_id in revision_id_list:
2336
b.repository.sign_revision(revision_id, gpg_strategy)
2337
elif revision is not None:
2338
if len(revision) == 1:
2339
revno, rev_id = revision[0].in_history(b)
2340
b.repository.sign_revision(rev_id, gpg_strategy)
2341
elif len(revision) == 2:
2342
# are they both on rh- if so we can walk between them
2343
# might be nice to have a range helper for arbitrary
2344
# revision paths. hmm.
2345
from_revno, from_revid = revision[0].in_history(b)
2346
to_revno, to_revid = revision[1].in_history(b)
2347
if to_revid is None:
2348
to_revno = b.revno()
2349
if from_revno is None or to_revno is None:
2350
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
2351
for revno in range(from_revno, to_revno + 1):
2352
b.repository.sign_revision(b.get_rev_id(revno),
2355
raise BzrCommandError('Please supply either one revision, or a range.')
2358
class cmd_bind(Command):
2359
"""Bind the current branch to a master branch.
2361
After binding, commits must succeed on the master branch
2362
before they are executed on the local one.
2365
takes_args = ['location']
2368
def run(self, location=None):
2369
b, relpath = Branch.open_containing(u'.')
2370
b_other = Branch.open(location)
2373
except DivergedBranches:
2374
raise BzrCommandError('These branches have diverged.'
2375
' Try merging, and then bind again.')
2378
class cmd_unbind(Command):
2379
"""Unbind the current branch from its master branch.
2381
After unbinding, the local branch is considered independent.
2382
All subsequent commits will be local.
2389
b, relpath = Branch.open_containing(u'.')
2391
raise BzrCommandError('Local branch is not bound')
2394
class cmd_uncommit(bzrlib.commands.Command):
2395
"""Remove the last committed revision.
2397
By supplying the --all flag, it will not only remove the entry
2398
from revision_history, but also remove all of the entries in the
2401
--verbose will print out what is being removed.
2402
--dry-run will go through all the motions, but not actually
2405
In the future, uncommit will create a changeset, which can then
2409
# TODO: jam 20060108 Add an option to allow uncommit to remove
2410
# unreferenced information in 'branch-as-repostory' branches.
2411
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2412
# information in shared branches as well.
2413
takes_options = ['verbose', 'revision',
2414
Option('dry-run', help='Don\'t actually make changes'),
2415
Option('force', help='Say yes to all questions.')]
2416
takes_args = ['location?']
2419
def run(self, location=None,
2420
dry_run=False, verbose=False,
2421
revision=None, force=False):
2422
from bzrlib.branch import Branch
2423
from bzrlib.log import log_formatter
2425
from bzrlib.uncommit import uncommit
2427
if location is None:
2429
control, relpath = bzrdir.BzrDir.open_containing(location)
2431
tree = control.open_workingtree()
2433
except (errors.NoWorkingTree, errors.NotLocalUrl):
2435
b = control.open_branch()
2437
if revision is None:
2439
rev_id = b.last_revision()
2441
revno, rev_id = revision[0].in_history(b)
2443
print 'No revisions to uncommit.'
2445
for r in range(revno, b.revno()+1):
2446
rev_id = b.get_rev_id(r)
2447
lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
2448
lf.show(r, b.repository.get_revision(rev_id), None)
2451
print 'Dry-run, pretending to remove the above revisions.'
2453
val = raw_input('Press <enter> to continue')
2455
print 'The above revision(s) will be removed.'
2457
val = raw_input('Are you sure [y/N]? ')
2458
if val.lower() not in ('y', 'yes'):
2462
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2466
class cmd_break_lock(Command):
2467
"""Break a dead lock on a repository, branch or working directory.
2469
CAUTION: Locks should only be broken when you are sure that the process
2470
holding the lock has been stopped.
2472
You can get information on what locks are open via the 'bzr info' command.
2477
takes_args = ['location?']
2479
def run(self, location=None, show=False):
2480
if location is None:
2482
control, relpath = bzrdir.BzrDir.open_containing(location)
2484
control.break_lock()
2485
except NotImplementedError:
2490
# command-line interpretation helper for merge-related commands
2491
def merge(other_revision, base_revision,
2492
check_clean=True, ignore_zero=False,
2493
this_dir=None, backup_files=False, merge_type=Merge3Merger,
2494
file_list=None, show_base=False, reprocess=False,
2495
pb=DummyProgress()):
2496
"""Merge changes into a tree.
2499
list(path, revno) Base for three-way merge.
2500
If [None, None] then a base will be automatically determined.
2502
list(path, revno) Other revision for three-way merge.
2504
Directory to merge changes into; '.' by default.
2506
If true, this_dir must have no uncommitted changes before the
2508
ignore_zero - If true, suppress the "zero conflicts" message when
2509
there are no conflicts; should be set when doing something we expect
2510
to complete perfectly.
2511
file_list - If supplied, merge only changes to selected files.
2513
All available ancestors of other_revision and base_revision are
2514
automatically pulled into the branch.
2516
The revno may be -1 to indicate the last revision on the branch, which is
2519
This function is intended for use from the command line; programmatic
2520
clients might prefer to call merge.merge_inner(), which has less magic
2523
from bzrlib.merge import Merger
2524
if this_dir is None:
2526
this_tree = WorkingTree.open_containing(this_dir)[0]
2527
if show_base and not merge_type is Merge3Merger:
2528
raise BzrCommandError("Show-base is not supported for this merge"
2529
" type. %s" % merge_type)
2530
if reprocess and not merge_type.supports_reprocess:
2531
raise BzrCommandError("Conflict reduction is not supported for merge"
2532
" type %s." % merge_type)
2533
if reprocess and show_base:
2534
raise BzrCommandError("Cannot do conflict reduction and show base.")
2536
merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
2537
merger.pp = ProgressPhase("Merge phase", 5, pb)
2538
merger.pp.next_phase()
2539
merger.check_basis(check_clean)
2540
merger.set_other(other_revision)
2541
merger.pp.next_phase()
2542
merger.set_base(base_revision)
2543
if merger.base_rev_id == merger.other_rev_id:
2544
note('Nothing to do.')
2546
merger.backup_files = backup_files
2547
merger.merge_type = merge_type
2548
merger.set_interesting_files(file_list)
2549
merger.show_base = show_base
2550
merger.reprocess = reprocess
2551
conflicts = merger.do_merge()
2552
if file_list is None:
2553
merger.set_pending()
2559
# these get imported and then picked up by the scan for cmd_*
2560
# TODO: Some more consistent way to split command definitions across files;
2561
# we do need to load at least some information about them to know of
2562
# aliases. ideally we would avoid loading the implementation until the
2563
# details were needed.
2564
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2565
from bzrlib.sign_my_commits import cmd_sign_my_commits
2566
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
2567
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
