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"""
22
from shutil import rmtree
27
from bzrlib.branch import Branch
28
import bzrlib.bzrdir as bzrdir
29
from bzrlib.commands import Command, display_command
30
from bzrlib.revision import common_ancestor
31
import bzrlib.errors as errors
32
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError,
33
NotBranchError, DivergedBranches, NotConflicted,
34
NoSuchFile, NoWorkingTree, FileInWrongBranch,
36
from bzrlib.log import show_one_log
37
from bzrlib.merge import Merge3Merger
38
from bzrlib.option import Option
39
from bzrlib.progress import DummyProgress, ProgressPhase
40
from bzrlib.revisionspec import RevisionSpec
42
from bzrlib.trace import mutter, note, log_error, warning, is_quiet
43
from bzrlib.transport.local import LocalTransport
45
from bzrlib.workingtree import WorkingTree
48
def tree_files(file_list, default_branch=u'.'):
50
return internal_tree_files(file_list, default_branch)
51
except FileInWrongBranch, e:
52
raise BzrCommandError("%s is not in the same branch as %s" %
53
(e.path, file_list[0]))
56
# XXX: Bad function name; should possibly also be a class method of
57
# WorkingTree rather than a function.
58
def internal_tree_files(file_list, default_branch=u'.'):
59
"""Convert command-line paths to a WorkingTree and relative paths.
61
This is typically used for command-line processors that take one or
62
more filenames, and infer the workingtree that contains them.
64
The filenames given are not required to exist.
66
:param file_list: Filenames to convert.
68
:param default_branch: Fallback tree path to use if file_list is empty or None.
70
:return: workingtree, [relative_paths]
72
if file_list is None or len(file_list) == 0:
73
return WorkingTree.open_containing(default_branch)[0], file_list
74
tree = WorkingTree.open_containing(file_list[0])[0]
76
for filename in file_list:
78
new_list.append(tree.relpath(filename))
79
except errors.PathNotChild:
80
raise FileInWrongBranch(tree.branch, filename)
84
def get_format_type(typestring):
85
"""Parse and return a format specifier."""
86
if typestring == "weave":
87
return bzrdir.BzrDirFormat6()
88
if typestring == "metadir":
89
return bzrdir.BzrDirMetaFormat1()
90
if typestring == "knit":
91
format = bzrdir.BzrDirMetaFormat1()
92
format.repository_format = bzrlib.repository.RepositoryFormatKnit1()
94
msg = "No known bzr-dir format %s. Supported types are: weave, metadir\n" %\
96
raise BzrCommandError(msg)
99
# TODO: Make sure no commands unconditionally use the working directory as a
100
# branch. If a filename argument is used, the first of them should be used to
101
# specify the branch. (Perhaps this can be factored out into some kind of
102
# Argument class, representing a file in a branch, where the first occurrence
105
class cmd_status(Command):
106
"""Display status summary.
108
This reports on versioned and unknown files, reporting them
109
grouped by state. Possible states are:
112
Versioned in the working copy but not in the previous revision.
115
Versioned in the previous revision but removed or deleted
119
Path of this file changed from the previous revision;
120
the text may also have changed. This includes files whose
121
parent directory was renamed.
124
Text has changed since the previous revision.
127
Nothing about this file has changed since the previous revision.
128
Only shown with --all.
131
Not versioned and not matching an ignore pattern.
133
To see ignored files use 'bzr ignored'. For details in the
134
changes to file texts, use 'bzr diff'.
136
If no arguments are specified, the status of the entire working
137
directory is shown. Otherwise, only the status of the specified
138
files or directories is reported. If a directory is given, status
139
is reported for everything inside that directory.
141
If a revision argument is given, the status is calculated against
142
that revision, or between two revisions if two are provided.
145
# TODO: --no-recurse, --recurse options
147
takes_args = ['file*']
148
takes_options = ['all', 'show-ids', 'revision']
149
aliases = ['st', 'stat']
152
def run(self, all=False, show_ids=False, file_list=None, revision=None):
153
tree, file_list = tree_files(file_list)
155
from bzrlib.status import show_tree_status
156
show_tree_status(tree, show_unchanged=all, show_ids=show_ids,
157
specific_files=file_list, revision=revision)
160
class cmd_cat_revision(Command):
161
"""Write out metadata for a revision.
163
The revision to print can either be specified by a specific
164
revision identifier, or you can use --revision.
168
takes_args = ['revision_id?']
169
takes_options = ['revision']
172
def run(self, revision_id=None, revision=None):
174
if revision_id is not None and revision is not None:
175
raise BzrCommandError('You can only supply one of revision_id or --revision')
176
if revision_id is None and revision is None:
177
raise BzrCommandError('You must supply either --revision or a revision_id')
178
b = WorkingTree.open_containing(u'.')[0].branch
179
if revision_id is not None:
180
sys.stdout.write(b.repository.get_revision_xml(revision_id))
181
elif revision is not None:
184
raise BzrCommandError('You cannot specify a NULL revision.')
185
revno, rev_id = rev.in_history(b)
186
sys.stdout.write(b.repository.get_revision_xml(rev_id))
189
class cmd_revno(Command):
190
"""Show current revision number.
192
This is equal to the number of revisions on this branch."""
193
takes_args = ['location?']
195
def run(self, location=u'.'):
196
print Branch.open_containing(location)[0].revno()
199
class cmd_revision_info(Command):
200
"""Show revision number and revision id for a given revision identifier.
203
takes_args = ['revision_info*']
204
takes_options = ['revision']
206
def run(self, revision=None, revision_info_list=[]):
209
if revision is not None:
210
revs.extend(revision)
211
if revision_info_list is not None:
212
for rev in revision_info_list:
213
revs.append(RevisionSpec(rev))
215
raise BzrCommandError('You must supply a revision identifier')
217
b = WorkingTree.open_containing(u'.')[0].branch
220
revinfo = rev.in_history(b)
221
if revinfo.revno is None:
222
print ' %s' % revinfo.rev_id
224
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
227
class cmd_add(Command):
228
"""Add specified files or directories.
230
In non-recursive mode, all the named items are added, regardless
231
of whether they were previously ignored. A warning is given if
232
any of the named files are already versioned.
234
In recursive mode (the default), files are treated the same way
235
but the behaviour for directories is different. Directories that
236
are already versioned do not give a warning. All directories,
237
whether already versioned or not, are searched for files or
238
subdirectories that are neither versioned or ignored, and these
239
are added. This search proceeds recursively into versioned
240
directories. If no names are given '.' is assumed.
242
Therefore simply saying 'bzr add' will version all files that
243
are currently unknown.
245
Adding a file whose parent directory is not versioned will
246
implicitly add the parent, and so on up to the root. This means
247
you should never need to explictly add a directory, they'll just
248
get added when you add a file in the directory.
250
--dry-run will show which files would be added, but not actually
253
takes_args = ['file*']
254
takes_options = ['no-recurse', 'dry-run', 'verbose']
256
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False):
261
# This is pointless, but I'd rather not raise an error
262
action = bzrlib.add.add_action_null
264
action = bzrlib.add.add_action_print
266
action = bzrlib.add.add_action_add
268
action = bzrlib.add.add_action_add_and_print
270
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
273
for glob in sorted(ignored.keys()):
274
match_len = len(ignored[glob])
276
for path in ignored[glob]:
277
print "ignored %s matching \"%s\"" % (path, glob)
279
print "ignored %d file(s) matching \"%s\"" % (match_len,
281
print "If you wish to add some of these files, please add them"\
285
class cmd_mkdir(Command):
286
"""Create a new versioned directory.
288
This is equivalent to creating the directory and then adding it.
290
takes_args = ['dir+']
292
def run(self, dir_list):
295
wt, dd = WorkingTree.open_containing(d)
300
class cmd_relpath(Command):
301
"""Show path of a file relative to root"""
302
takes_args = ['filename']
306
def run(self, filename):
307
tree, relpath = WorkingTree.open_containing(filename)
311
class cmd_inventory(Command):
312
"""Show inventory of the current working copy or a revision.
314
It is possible to limit the output to a particular entry
315
type using the --kind option. For example; --kind file.
317
takes_options = ['revision', 'show-ids', 'kind']
320
def run(self, revision=None, show_ids=False, kind=None):
321
if kind and kind not in ['file', 'directory', 'symlink']:
322
raise BzrCommandError('invalid kind specified')
323
tree = WorkingTree.open_containing(u'.')[0]
325
inv = tree.read_working_inventory()
327
if len(revision) > 1:
328
raise BzrCommandError('bzr inventory --revision takes'
329
' exactly one revision identifier')
330
inv = tree.branch.repository.get_revision_inventory(
331
revision[0].in_history(tree.branch).rev_id)
333
for path, entry in inv.entries():
334
if kind and kind != entry.kind:
337
print '%-50s %s' % (path, entry.file_id)
342
class cmd_mv(Command):
343
"""Move or rename a file.
346
bzr mv OLDNAME NEWNAME
347
bzr mv SOURCE... DESTINATION
349
If the last argument is a versioned directory, all the other names
350
are moved into it. Otherwise, there must be exactly two arguments
351
and the file is changed to a new name, which must not already exist.
353
Files cannot be moved between branches.
355
takes_args = ['names*']
356
aliases = ['move', 'rename']
358
def run(self, names_list):
359
if len(names_list) < 2:
360
raise BzrCommandError("missing file argument")
361
tree, rel_names = tree_files(names_list)
363
if os.path.isdir(names_list[-1]):
364
# move into existing directory
365
for pair in tree.move(rel_names[:-1], rel_names[-1]):
366
print "%s => %s" % pair
368
if len(names_list) != 2:
369
raise BzrCommandError('to mv multiple files the destination '
370
'must be a versioned directory')
371
tree.rename_one(rel_names[0], rel_names[1])
372
print "%s => %s" % (rel_names[0], rel_names[1])
375
class cmd_pull(Command):
376
"""Turn this branch into a mirror of another branch.
378
This command only works on branches that have not diverged. Branches are
379
considered diverged if the destination branch's most recent commit is one
380
that has not been merged (directly or indirectly) into the parent.
382
If branches have diverged, you can use 'bzr merge' to integrate the changes
383
from one into the other. Once one branch has merged, the other should
384
be able to pull it again.
386
If branches have diverged, you can use 'bzr merge' to pull the text changes
387
from one into the other. Once one branch has merged, the other should
388
be able to pull it again.
390
If you want to forget your local changes and just update your branch to
391
match the remote one, use pull --overwrite.
393
If there is no default location set, the first pull will set it. After
394
that, you can omit the location to use the default. To change the
395
default, use --remember.
397
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
398
takes_args = ['location?']
400
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
401
# FIXME: too much stuff is in the command class
403
tree_to = WorkingTree.open_containing(u'.')[0]
404
branch_to = tree_to.branch
405
except NoWorkingTree:
407
branch_to = Branch.open_containing(u'.')[0]
408
stored_loc = branch_to.get_parent()
410
if stored_loc is None:
411
raise BzrCommandError("No pull location known or specified.")
413
print "Using saved location: %s" % stored_loc
414
location = stored_loc
416
if branch_to.get_parent() is None or remember:
417
branch_to.set_parent(location)
419
branch_from = Branch.open(location)
423
elif len(revision) == 1:
424
rev_id = revision[0].in_history(branch_from).rev_id
426
raise BzrCommandError('bzr pull --revision takes one value.')
428
old_rh = branch_to.revision_history()
429
if tree_to is not None:
430
count = tree_to.pull(branch_from, overwrite, rev_id)
432
count = branch_to.pull(branch_from, overwrite, rev_id)
433
note('%d revision(s) pulled.' % (count,))
436
new_rh = branch_to.revision_history()
439
from bzrlib.log import show_changed_revisions
440
show_changed_revisions(branch_to, old_rh, new_rh)
443
class cmd_push(Command):
444
"""Update a mirror of this branch.
446
The target branch will not have its working tree populated because this
447
is both expensive, and is not supported on remote file systems.
449
Some smart servers or protocols *may* put the working tree in place in
452
This command only works on branches that have not diverged. Branches are
453
considered diverged if the destination branch's most recent commit is one
454
that has not been merged (directly or indirectly) by the source branch.
456
If branches have diverged, you can use 'bzr push --overwrite' to replace
457
the other branch completely, discarding its unmerged changes.
459
If you want to ensure you have the different changes in the other branch,
460
do a merge (see bzr help merge) from the other branch, and commit that.
461
After that you will be able to do a push without '--overwrite'.
463
If there is no default push location set, the first push will set it.
464
After that, you can omit the location to use the default. To change the
465
default, use --remember.
467
takes_options = ['remember', 'overwrite',
468
Option('create-prefix',
469
help='Create the path leading up to the branch '
470
'if it does not already exist')]
471
takes_args = ['location?']
473
def run(self, location=None, remember=False, overwrite=False,
474
create_prefix=False, verbose=False):
475
# FIXME: Way too big! Put this into a function called from the
477
from bzrlib.transport import get_transport
479
br_from = Branch.open_containing('.')[0]
480
stored_loc = br_from.get_push_location()
482
if stored_loc is None:
483
raise BzrCommandError("No push location known or specified.")
485
print "Using saved location: %s" % stored_loc
486
location = stored_loc
487
if br_from.get_push_location() is None or remember:
488
br_from.set_push_location(location)
490
dir_to = bzrlib.bzrdir.BzrDir.open(location)
491
br_to = dir_to.open_branch()
492
except NotBranchError:
494
transport = get_transport(location).clone('..')
495
if not create_prefix:
497
transport.mkdir(transport.relpath(location))
499
raise BzrCommandError("Parent directory of %s "
500
"does not exist." % location)
502
current = transport.base
503
needed = [(transport, transport.relpath(location))]
506
transport, relpath = needed[-1]
507
transport.mkdir(relpath)
510
new_transport = transport.clone('..')
511
needed.append((new_transport,
512
new_transport.relpath(transport.base)))
513
if new_transport.base == transport.base:
514
raise BzrCommandError("Could not create "
516
dir_to = br_from.bzrdir.clone(location)
517
br_to = dir_to.open_branch()
518
old_rh = br_to.revision_history()
521
tree_to = dir_to.open_workingtree()
522
except errors.NotLocalUrl:
523
# TODO: This should be updated for branches which don't have a
524
# working tree, as opposed to ones where we just couldn't
526
warning('This transport does not update the working '
527
'tree of: %s' % (br_to.base,))
528
count = br_to.pull(br_from, overwrite)
529
except NoWorkingTree:
530
count = br_to.pull(br_from, overwrite)
532
count = tree_to.pull(br_from, overwrite)
533
except DivergedBranches:
534
raise BzrCommandError("These branches have diverged."
535
" Try a merge then push with overwrite.")
536
note('%d revision(s) pushed.' % (count,))
539
new_rh = br_to.revision_history()
542
from bzrlib.log import show_changed_revisions
543
show_changed_revisions(br_to, old_rh, new_rh)
546
class cmd_branch(Command):
547
"""Create a new copy of a branch.
549
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
550
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
552
To retrieve the branch as of a particular revision, supply the --revision
553
parameter, as in "branch foo/bar -r 5".
555
--basis is to speed up branching from remote branches. When specified, it
556
copies all the file-contents, inventory and revision data from the basis
557
branch before copying anything from the remote branch.
559
takes_args = ['from_location', 'to_location?']
560
takes_options = ['revision', 'basis']
561
aliases = ['get', 'clone']
563
def run(self, from_location, to_location=None, revision=None, basis=None):
566
elif len(revision) > 1:
567
raise BzrCommandError(
568
'bzr branch --revision takes exactly 1 revision value')
570
br_from = Branch.open(from_location)
572
if e.errno == errno.ENOENT:
573
raise BzrCommandError('Source location "%s" does not'
574
' exist.' % to_location)
579
if basis is not None:
580
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
583
if len(revision) == 1 and revision[0] is not None:
584
revision_id = revision[0].in_history(br_from)[1]
586
# FIXME - wt.last_revision, fallback to branch, fall back to
587
# None or perhaps NULL_REVISION to mean copy nothing
589
revision_id = br_from.last_revision()
590
if to_location is None:
591
to_location = os.path.basename(from_location.rstrip("/\\"))
594
name = os.path.basename(to_location) + '\n'
596
os.mkdir(to_location)
598
if e.errno == errno.EEXIST:
599
raise BzrCommandError('Target directory "%s" already'
600
' exists.' % to_location)
601
if e.errno == errno.ENOENT:
602
raise BzrCommandError('Parent of "%s" does not exist.' %
607
# preserve whatever source format we have.
608
dir = br_from.bzrdir.sprout(to_location, revision_id, basis_dir)
609
branch = dir.open_branch()
610
except bzrlib.errors.NoSuchRevision:
612
msg = "The branch %s has no revision %s." % (from_location, revision[0])
613
raise BzrCommandError(msg)
614
except bzrlib.errors.UnlistableBranch:
616
msg = "The branch %s cannot be used as a --basis" % (basis,)
617
raise BzrCommandError(msg)
619
branch.control_files.put_utf8('branch-name', name)
621
note('Branched %d revision(s).' % branch.revno())
626
class cmd_checkout(Command):
627
"""Create a new checkout of an existing branch.
629
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
630
the branch found in '.'. This is useful if you have removed the working tree
631
or if it was never created - i.e. if you pushed the branch to its current
634
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
635
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
637
To retrieve the branch as of a particular revision, supply the --revision
638
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
639
out of date [so you cannot commit] but it may be useful (i.e. to examine old
642
--basis is to speed up checking out from remote branches. When specified, it
643
uses the inventory and file contents from the basis branch in preference to the
644
branch being checked out.
646
takes_args = ['branch_location?', 'to_location?']
647
takes_options = ['revision', # , 'basis']
648
Option('lightweight',
649
help="perform a lightweight checkout. Lightweight "
650
"checkouts depend on access to the branch for "
651
"every operation. Normal checkouts can perform "
652
"common operations like diff and status without "
653
"such access, and also support local commits."
657
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
661
elif len(revision) > 1:
662
raise BzrCommandError(
663
'bzr checkout --revision takes exactly 1 revision value')
664
if branch_location is None:
665
branch_location = bzrlib.osutils.getcwd()
666
to_location = branch_location
667
source = Branch.open(branch_location)
668
if len(revision) == 1 and revision[0] is not None:
669
revision_id = revision[0].in_history(source)[1]
672
if to_location is None:
673
to_location = os.path.basename(branch_location.rstrip("/\\"))
674
# if the source and to_location are the same,
675
# and there is no working tree,
676
# then reconstitute a branch
677
if (bzrlib.osutils.abspath(to_location) ==
678
bzrlib.osutils.abspath(branch_location)):
680
source.bzrdir.open_workingtree()
681
except errors.NoWorkingTree:
682
source.bzrdir.create_workingtree()
685
os.mkdir(to_location)
687
if e.errno == errno.EEXIST:
688
raise BzrCommandError('Target directory "%s" already'
689
' exists.' % to_location)
690
if e.errno == errno.ENOENT:
691
raise BzrCommandError('Parent of "%s" does not exist.' %
695
old_format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
696
bzrlib.bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
699
checkout = bzrdir.BzrDirMetaFormat1().initialize(to_location)
700
bzrlib.branch.BranchReferenceFormat().initialize(checkout, source)
702
checkout_branch = bzrlib.bzrdir.BzrDir.create_branch_convenience(
703
to_location, force_new_tree=False)
704
checkout = checkout_branch.bzrdir
705
checkout_branch.bind(source)
706
if revision_id is not None:
707
rh = checkout_branch.revision_history()
708
checkout_branch.set_revision_history(rh[:rh.index(revision_id) + 1])
709
checkout.create_workingtree(revision_id)
711
bzrlib.bzrdir.BzrDirFormat.set_default_format(old_format)
714
class cmd_renames(Command):
715
"""Show list of renamed files.
717
# TODO: Option to show renames between two historical versions.
719
# TODO: Only show renames under dir, rather than in the whole branch.
720
takes_args = ['dir?']
723
def run(self, dir=u'.'):
724
tree = WorkingTree.open_containing(dir)[0]
725
old_inv = tree.basis_tree().inventory
726
new_inv = tree.read_working_inventory()
728
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
730
for old_name, new_name in renames:
731
print "%s => %s" % (old_name, new_name)
734
class cmd_update(Command):
735
"""Update a tree to have the latest code committed to its branch.
737
This will perform a merge into the working tree, and may generate
738
conflicts. If you have any local changes, you will still
739
need to commit them after the update for the update to be complete.
741
If you want to discard your local changes, you can just do a
742
'bzr revert' instead of 'bzr commit' after the update.
744
takes_args = ['dir?']
746
def run(self, dir='.'):
747
tree = WorkingTree.open_containing(dir)[0]
750
if tree.last_revision() == tree.branch.last_revision():
751
# may be up to date, check master too.
752
master = tree.branch.get_master_branch()
753
if master is None or master.last_revision == tree.last_revision():
754
note("Tree is up to date.")
756
conflicts = tree.update()
757
note('Updated to revision %d.' %
758
(tree.branch.revision_id_to_revno(tree.last_revision()),))
767
class cmd_info(Command):
768
"""Show statistical information about a branch."""
769
takes_args = ['branch?']
770
takes_options = ['verbose']
773
def run(self, branch=None, verbose=False):
775
bzrlib.info.show_bzrdir_info(bzrdir.BzrDir.open_containing(branch)[0],
779
class cmd_remove(Command):
780
"""Make a file unversioned.
782
This makes bzr stop tracking changes to a versioned file. It does
783
not delete the working copy.
785
takes_args = ['file+']
786
takes_options = ['verbose']
789
def run(self, file_list, verbose=False):
790
tree, file_list = tree_files(file_list)
791
tree.remove(file_list, verbose=verbose)
794
class cmd_file_id(Command):
795
"""Print file_id of a particular file or directory.
797
The file_id is assigned when the file is first added and remains the
798
same through all revisions where the file exists, even when it is
802
takes_args = ['filename']
804
def run(self, filename):
805
tree, relpath = WorkingTree.open_containing(filename)
806
i = tree.inventory.path2id(relpath)
808
raise BzrError("%r is not a versioned file" % filename)
813
class cmd_file_path(Command):
814
"""Print path of file_ids to a file or directory.
816
This prints one line for each directory down to the target,
817
starting at the branch root."""
819
takes_args = ['filename']
821
def run(self, filename):
822
tree, relpath = WorkingTree.open_containing(filename)
824
fid = inv.path2id(relpath)
826
raise BzrError("%r is not a versioned file" % filename)
827
for fip in inv.get_idpath(fid):
831
class cmd_reconcile(Command):
832
"""Reconcile bzr metadata in a branch.
834
This can correct data mismatches that may have been caused by
835
previous ghost operations or bzr upgrades. You should only
836
need to run this command if 'bzr check' or a bzr developer
837
advises you to run it.
839
If a second branch is provided, cross-branch reconciliation is
840
also attempted, which will check that data like the tree root
841
id which was not present in very early bzr versions is represented
842
correctly in both branches.
844
At the same time it is run it may recompress data resulting in
845
a potential saving in disk space or performance gain.
847
The branch *MUST* be on a listable system such as local disk or sftp.
849
takes_args = ['branch?']
851
def run(self, branch="."):
852
from bzrlib.reconcile import reconcile
853
dir = bzrlib.bzrdir.BzrDir.open(branch)
857
class cmd_revision_history(Command):
858
"""Display list of revision ids on this branch."""
862
branch = WorkingTree.open_containing(u'.')[0].branch
863
for patchid in branch.revision_history():
867
class cmd_ancestry(Command):
868
"""List all revisions merged into this branch."""
872
tree = WorkingTree.open_containing(u'.')[0]
874
# FIXME. should be tree.last_revision
875
for revision_id in b.repository.get_ancestry(b.last_revision()):
879
class cmd_init(Command):
880
"""Make a directory into a versioned branch.
882
Use this to create an empty branch, or before importing an
885
If there is a repository in a parent directory of the location, then
886
the history of the branch will be stored in the repository. Otherwise
887
init creates a standalone branch which carries its own history in
890
If there is already a branch at the location but it has no working tree,
891
the tree can be populated with 'bzr checkout'.
893
Recipe for importing a tree of files:
898
bzr commit -m 'imported project'
900
takes_args = ['location?']
903
help='Create a specific format rather than the'
904
' current default format. Currently supports:'
905
' metadir, knit, and weave',
906
type=get_format_type),
908
def run(self, location=None, format=None):
909
from bzrlib.branch import Branch
913
# The path has to exist to initialize a
914
# branch inside of it.
915
# Just using os.mkdir, since I don't
916
# believe that we want to create a bunch of
917
# locations if the user supplies an extended path
918
if not os.path.exists(location):
921
existing_bzrdir = bzrdir.BzrDir.open(location)
922
except NotBranchError:
923
# really a NotBzrDir error...
924
bzrdir.BzrDir.create_branch_convenience(location, format=format)
926
if existing_bzrdir.has_branch():
927
if existing_bzrdir.has_workingtree():
928
raise errors.AlreadyBranchError(location)
930
raise errors.BranchExistsWithoutWorkingTree(location)
932
existing_bzrdir.create_branch()
933
existing_bzrdir.create_workingtree()
936
class cmd_init_repository(Command):
937
"""Create a shared repository to hold branches.
939
New branches created under the repository directory will store their revisions
940
in the repository, not in the branch directory, if the branch format supports
946
bzr checkout --lightweight repo/trunk trunk-checkout
950
takes_args = ["location"]
951
takes_options = [Option('format',
952
help='Use a specific format rather than the'
953
' current default format. Currently this'
954
' option accepts "weave", "metadir" and "knit"',
955
type=get_format_type),
957
help='Allows branches in repository to have'
959
aliases = ["init-repo"]
960
def run(self, location, format=None, trees=False):
961
from bzrlib.bzrdir import BzrDirMetaFormat1
962
from bzrlib.transport import get_transport
964
format = BzrDirMetaFormat1()
965
transport = get_transport(location)
966
if not transport.has('.'):
968
newdir = format.initialize_on_transport(transport)
969
repo = newdir.create_repository(shared=True)
970
repo.set_make_working_trees(trees)
973
class cmd_diff(Command):
974
"""Show differences in working tree.
976
If files are listed, only the changes in those files are listed.
977
Otherwise, all changes for the tree are listed.
984
# TODO: Allow diff across branches.
985
# TODO: Option to use external diff command; could be GNU diff, wdiff,
986
# or a graphical diff.
988
# TODO: Python difflib is not exactly the same as unidiff; should
989
# either fix it up or prefer to use an external diff.
991
# TODO: If a directory is given, diff everything under that.
993
# TODO: Selected-file diff is inefficient and doesn't show you
996
# TODO: This probably handles non-Unix newlines poorly.
998
takes_args = ['file*']
999
takes_options = ['revision', 'diff-options', 'diff-prefix']
1000
aliases = ['di', 'dif']
1003
def run(self, revision=None, file_list=None, diff_options=None,
1005
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1008
if not ':' in diff_prefix:
1009
raise BzrError("--diff-prefix expects two values separated by a colon")
1010
old_label,new_label=diff_prefix.split(":")
1016
tree1, file_list = internal_tree_files(file_list)
1020
except FileInWrongBranch:
1021
if len(file_list) != 2:
1022
raise BzrCommandError("Files are in different branches")
1024
tree1, file1 = WorkingTree.open_containing(file_list[0])
1025
tree2, file2 = WorkingTree.open_containing(file_list[1])
1026
if file1 != "" or file2 != "":
1027
# FIXME diff those two files. rbc 20051123
1028
raise BzrCommandError("Files are in different branches")
1030
if revision is not None:
1031
if tree2 is not None:
1032
raise BzrCommandError("Can't specify -r with two branches")
1033
if (len(revision) == 1) or (revision[1].spec is None):
1034
return diff_cmd_helper(tree1, file_list, diff_options,
1036
old_label=old_label, new_label=new_label)
1037
elif len(revision) == 2:
1038
return diff_cmd_helper(tree1, file_list, diff_options,
1039
revision[0], revision[1],
1040
old_label=old_label, new_label=new_label)
1042
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
1044
if tree2 is not None:
1045
return show_diff_trees(tree1, tree2, sys.stdout,
1046
specific_files=file_list,
1047
external_diff_options=diff_options,
1048
old_label=old_label, new_label=new_label)
1050
return diff_cmd_helper(tree1, file_list, diff_options,
1051
old_label=old_label, new_label=new_label)
1054
class cmd_deleted(Command):
1055
"""List files deleted in the working tree.
1057
# TODO: Show files deleted since a previous revision, or
1058
# between two revisions.
1059
# TODO: Much more efficient way to do this: read in new
1060
# directories with readdir, rather than stating each one. Same
1061
# level of effort but possibly much less IO. (Or possibly not,
1062
# if the directories are very large...)
1064
def run(self, show_ids=False):
1065
tree = WorkingTree.open_containing(u'.')[0]
1066
old = tree.basis_tree()
1067
for path, ie in old.inventory.iter_entries():
1068
if not tree.has_id(ie.file_id):
1070
print '%-50s %s' % (path, ie.file_id)
1075
class cmd_modified(Command):
1076
"""List files modified in working tree."""
1080
from bzrlib.delta import compare_trees
1082
tree = WorkingTree.open_containing(u'.')[0]
1083
td = compare_trees(tree.basis_tree(), tree)
1085
for path, id, kind, text_modified, meta_modified in td.modified:
1090
class cmd_added(Command):
1091
"""List files added in working tree."""
1095
wt = WorkingTree.open_containing(u'.')[0]
1096
basis_inv = wt.basis_tree().inventory
1099
if file_id in basis_inv:
1101
path = inv.id2path(file_id)
1102
if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
1108
class cmd_root(Command):
1109
"""Show the tree root directory.
1111
The root is the nearest enclosing directory with a .bzr control
1113
takes_args = ['filename?']
1115
def run(self, filename=None):
1116
"""Print the branch root."""
1117
tree = WorkingTree.open_containing(filename)[0]
1121
class cmd_log(Command):
1122
"""Show log of a branch, file, or directory.
1124
By default show the log of the branch containing the working directory.
1126
To request a range of logs, you can use the command -r begin..end
1127
-r revision requests a specific revision, -r ..end or -r begin.. are
1133
bzr log -r -10.. http://server/branch
1136
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1138
takes_args = ['location?']
1139
takes_options = [Option('forward',
1140
help='show from oldest to newest'),
1143
help='show files changed in each revision'),
1144
'show-ids', 'revision',
1148
help='show revisions whose message matches this regexp',
1153
def run(self, location=None, timezone='original',
1163
from bzrlib.log import log_formatter, show_log
1165
assert message is None or isinstance(message, basestring), \
1166
"invalid message argument %r" % message
1167
direction = (forward and 'forward') or 'reverse'
1172
# find the file id to log:
1174
dir, fp = bzrdir.BzrDir.open_containing(location)
1175
b = dir.open_branch()
1179
inv = dir.open_workingtree().inventory
1180
except (errors.NotBranchError, errors.NotLocalUrl):
1181
# either no tree, or is remote.
1182
inv = b.basis_tree().inventory
1183
file_id = inv.path2id(fp)
1186
# FIXME ? log the current subdir only RBC 20060203
1187
dir, relpath = bzrdir.BzrDir.open_containing('.')
1188
b = dir.open_branch()
1190
if revision is None:
1193
elif len(revision) == 1:
1194
rev1 = rev2 = revision[0].in_history(b).revno
1195
elif len(revision) == 2:
1196
if revision[0].spec is None:
1197
# missing begin-range means first revision
1200
rev1 = revision[0].in_history(b).revno
1202
if revision[1].spec is None:
1203
# missing end-range means last known revision
1206
rev2 = revision[1].in_history(b).revno
1208
raise BzrCommandError('bzr log --revision takes one or two values.')
1210
# By this point, the revision numbers are converted to the +ve
1211
# form if they were supplied in the -ve form, so we can do
1212
# this comparison in relative safety
1214
(rev2, rev1) = (rev1, rev2)
1216
mutter('encoding log as %r', bzrlib.user_encoding)
1218
# use 'replace' so that we don't abort if trying to write out
1219
# in e.g. the default C locale.
1220
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1222
if (log_format == None):
1223
default = bzrlib.config.BranchConfig(b).log_format()
1224
log_format = get_log_format(long=long, short=short, line=line, default=default)
1226
lf = log_formatter(log_format,
1229
show_timezone=timezone)
1235
direction=direction,
1236
start_revision=rev1,
1241
def get_log_format(long=False, short=False, line=False, default='long'):
1242
log_format = default
1246
log_format = 'short'
1252
class cmd_touching_revisions(Command):
1253
"""Return revision-ids which affected a particular file.
1255
A more user-friendly interface is "bzr log FILE"."""
1257
takes_args = ["filename"]
1259
def run(self, filename):
1260
tree, relpath = WorkingTree.open_containing(filename)
1262
inv = tree.read_working_inventory()
1263
file_id = inv.path2id(relpath)
1264
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1265
print "%6d %s" % (revno, what)
1268
class cmd_ls(Command):
1269
"""List files in a tree.
1271
# TODO: Take a revision or remote path and list that tree instead.
1273
takes_options = ['verbose', 'revision',
1274
Option('non-recursive',
1275
help='don\'t recurse into sub-directories'),
1277
help='Print all paths from the root of the branch.'),
1278
Option('unknown', help='Print unknown files'),
1279
Option('versioned', help='Print versioned files'),
1280
Option('ignored', help='Print ignored files'),
1282
Option('null', help='Null separate the files'),
1285
def run(self, revision=None, verbose=False,
1286
non_recursive=False, from_root=False,
1287
unknown=False, versioned=False, ignored=False,
1290
if verbose and null:
1291
raise BzrCommandError('Cannot set both --verbose and --null')
1292
all = not (unknown or versioned or ignored)
1294
selection = {'I':ignored, '?':unknown, 'V':versioned}
1296
tree, relpath = WorkingTree.open_containing(u'.')
1301
if revision is not None:
1302
tree = tree.branch.repository.revision_tree(
1303
revision[0].in_history(tree.branch).rev_id)
1304
for fp, fc, kind, fid, entry in tree.list_files():
1305
if fp.startswith(relpath):
1306
fp = fp[len(relpath):]
1307
if non_recursive and '/' in fp:
1309
if not all and not selection[fc]:
1312
kindch = entry.kind_character()
1313
print '%-8s %s%s' % (fc, fp, kindch)
1315
sys.stdout.write(fp)
1316
sys.stdout.write('\0')
1322
class cmd_unknowns(Command):
1323
"""List unknown files."""
1326
from bzrlib.osutils import quotefn
1327
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1331
class cmd_ignore(Command):
1332
"""Ignore a command or pattern.
1334
To remove patterns from the ignore list, edit the .bzrignore file.
1336
If the pattern contains a slash, it is compared to the whole path
1337
from the branch root. Otherwise, it is compared to only the last
1338
component of the path. To match a file only in the root directory,
1341
Ignore patterns are case-insensitive on case-insensitive systems.
1343
Note: wildcards must be quoted from the shell on Unix.
1346
bzr ignore ./Makefile
1347
bzr ignore '*.class'
1349
# TODO: Complain if the filename is absolute
1350
takes_args = ['name_pattern']
1352
def run(self, name_pattern):
1353
from bzrlib.atomicfile import AtomicFile
1356
tree, relpath = WorkingTree.open_containing(u'.')
1357
ifn = tree.abspath('.bzrignore')
1359
if os.path.exists(ifn):
1362
igns = f.read().decode('utf-8')
1368
# TODO: If the file already uses crlf-style termination, maybe
1369
# we should use that for the newly added lines?
1371
if igns and igns[-1] != '\n':
1373
igns += name_pattern + '\n'
1376
f = AtomicFile(ifn, 'wt')
1377
f.write(igns.encode('utf-8'))
1382
inv = tree.inventory
1383
if inv.path2id('.bzrignore'):
1384
mutter('.bzrignore is already versioned')
1386
mutter('need to make new .bzrignore file versioned')
1387
tree.add(['.bzrignore'])
1390
class cmd_ignored(Command):
1391
"""List ignored files and the patterns that matched them.
1393
See also: bzr ignore"""
1396
tree = WorkingTree.open_containing(u'.')[0]
1397
for path, file_class, kind, file_id, entry in tree.list_files():
1398
if file_class != 'I':
1400
## XXX: Slightly inefficient since this was already calculated
1401
pat = tree.is_ignored(path)
1402
print '%-50s %s' % (path, pat)
1405
class cmd_lookup_revision(Command):
1406
"""Lookup the revision-id from a revision-number
1409
bzr lookup-revision 33
1412
takes_args = ['revno']
1415
def run(self, revno):
1419
raise BzrCommandError("not a valid revision-number: %r" % revno)
1421
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1424
class cmd_export(Command):
1425
"""Export past revision to destination directory.
1427
If no revision is specified this exports the last committed revision.
1429
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1430
given, try to find the format with the extension. If no extension
1431
is found exports to a directory (equivalent to --format=dir).
1433
Root may be the top directory for tar, tgz and tbz2 formats. If none
1434
is given, the top directory will be the root name of the file.
1436
Note: export of tree with non-ascii filenames to zip is not supported.
1438
Supported formats Autodetected by extension
1439
----------------- -------------------------
1442
tbz2 .tar.bz2, .tbz2
1446
takes_args = ['dest']
1447
takes_options = ['revision', 'format', 'root']
1448
def run(self, dest, revision=None, format=None, root=None):
1450
from bzrlib.export import export
1451
tree = WorkingTree.open_containing(u'.')[0]
1453
if revision is None:
1454
# should be tree.last_revision FIXME
1455
rev_id = b.last_revision()
1457
if len(revision) != 1:
1458
raise BzrError('bzr export --revision takes exactly 1 argument')
1459
rev_id = revision[0].in_history(b).rev_id
1460
t = b.repository.revision_tree(rev_id)
1462
export(t, dest, format, root)
1463
except errors.NoSuchExportFormat, e:
1464
raise BzrCommandError('Unsupported export format: %s' % e.format)
1467
class cmd_cat(Command):
1468
"""Write a file's text from a previous revision."""
1470
takes_options = ['revision']
1471
takes_args = ['filename']
1474
def run(self, filename, revision=None):
1475
if revision is not None and len(revision) != 1:
1476
raise BzrCommandError("bzr cat --revision takes exactly one number")
1479
tree, relpath = WorkingTree.open_containing(filename)
1481
except NotBranchError:
1485
b, relpath = Branch.open_containing(filename)
1486
if revision is None:
1487
revision_id = b.last_revision()
1489
revision_id = revision[0].in_history(b).rev_id
1490
b.print_file(relpath, revision_id)
1493
class cmd_local_time_offset(Command):
1494
"""Show the offset in seconds from GMT to local time."""
1498
print bzrlib.osutils.local_time_offset()
1502
class cmd_commit(Command):
1503
"""Commit changes into a new revision.
1505
If no arguments are given, the entire tree is committed.
1507
If selected files are specified, only changes to those files are
1508
committed. If a directory is specified then the directory and everything
1509
within it is committed.
1511
A selected-file commit may fail in some cases where the committed
1512
tree would be invalid, such as trying to commit a file in a
1513
newly-added directory that is not itself committed.
1515
# TODO: Run hooks on tree to-be-committed, and after commit.
1517
# TODO: Strict commit that fails if there are deleted files.
1518
# (what does "deleted files" mean ??)
1520
# TODO: Give better message for -s, --summary, used by tla people
1522
# XXX: verbose currently does nothing
1524
takes_args = ['selected*']
1525
takes_options = ['message', 'verbose',
1527
help='commit even if nothing has changed'),
1528
Option('file', type=str,
1530
help='file containing commit message'),
1532
help="refuse to commit if there are unknown "
1533
"files in the working tree."),
1535
help="perform a local only commit in a bound "
1536
"branch. Such commits are not pushed to "
1537
"the master branch until a normal commit "
1541
aliases = ['ci', 'checkin']
1543
def run(self, message=None, file=None, verbose=True, selected_list=None,
1544
unchanged=False, strict=False, local=False):
1545
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1546
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1548
from bzrlib.msgeditor import edit_commit_message, \
1549
make_commit_message_template
1550
from tempfile import TemporaryFile
1553
# TODO: Need a blackbox test for invoking the external editor; may be
1554
# slightly problematic to run this cross-platform.
1556
# TODO: do more checks that the commit will succeed before
1557
# spending the user's valuable time typing a commit message.
1559
# TODO: if the commit *does* happen to fail, then save the commit
1560
# message to a temporary file where it can be recovered
1561
tree, selected_list = tree_files(selected_list)
1562
if local and not tree.branch.get_bound_location():
1563
raise errors.LocalRequiresBoundBranch()
1564
if message is None and not file:
1565
template = make_commit_message_template(tree, selected_list)
1566
message = edit_commit_message(template)
1568
raise BzrCommandError("please specify a commit message"
1569
" with either --message or --file")
1570
elif message and file:
1571
raise BzrCommandError("please specify either --message or --file")
1575
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1578
raise BzrCommandError("empty commit message specified")
1581
reporter = ReportCommitToLog()
1583
reporter = NullCommitReporter()
1586
tree.commit(message, specific_files=selected_list,
1587
allow_pointless=unchanged, strict=strict, local=local,
1589
except PointlessCommit:
1590
# FIXME: This should really happen before the file is read in;
1591
# perhaps prepare the commit; get the message; then actually commit
1592
raise BzrCommandError("no changes to commit",
1593
["use --unchanged to commit anyhow"])
1594
except ConflictsInTree:
1595
raise BzrCommandError("Conflicts detected in working tree. "
1596
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1597
except StrictCommitFailed:
1598
raise BzrCommandError("Commit refused because there are unknown "
1599
"files in the working tree.")
1600
except errors.BoundBranchOutOfDate, e:
1601
raise BzrCommandError(str(e)
1602
+ ' Either unbind, update, or'
1603
' pass --local to commit.')
1606
class cmd_check(Command):
1607
"""Validate consistency of branch history.
1609
This command checks various invariants about the branch storage to
1610
detect data corruption or bzr bugs.
1612
takes_args = ['branch?']
1613
takes_options = ['verbose']
1615
def run(self, branch=None, verbose=False):
1616
from bzrlib.check import check
1618
tree = WorkingTree.open_containing()[0]
1619
branch = tree.branch
1621
branch = Branch.open(branch)
1622
check(branch, verbose)
1625
class cmd_scan_cache(Command):
1628
from bzrlib.hashcache import HashCache
1634
print '%6d stats' % c.stat_count
1635
print '%6d in hashcache' % len(c._cache)
1636
print '%6d files removed from cache' % c.removed_count
1637
print '%6d hashes updated' % c.update_count
1638
print '%6d files changed too recently to cache' % c.danger_count
1644
class cmd_upgrade(Command):
1645
"""Upgrade branch storage to current format.
1647
The check command or bzr developers may sometimes advise you to run
1648
this command. When the default format has changed you may also be warned
1649
during other operations to upgrade.
1651
takes_args = ['url?']
1654
help='Upgrade to a specific format rather than the'
1655
' current default format. Currently this'
1656
' option accepts "weave", "metadir" and'
1658
type=get_format_type),
1662
def run(self, url='.', format=None):
1663
from bzrlib.upgrade import upgrade
1664
upgrade(url, format)
1667
class cmd_whoami(Command):
1668
"""Show bzr user id."""
1669
takes_options = ['email']
1672
def run(self, email=False):
1674
b = WorkingTree.open_containing(u'.')[0].branch
1675
config = bzrlib.config.BranchConfig(b)
1676
except NotBranchError:
1677
config = bzrlib.config.GlobalConfig()
1680
print config.user_email()
1682
print config.username()
1685
class cmd_nick(Command):
1686
"""Print or set the branch nickname.
1688
If unset, the tree root directory name is used as the nickname
1689
To print the current nickname, execute with no argument.
1691
takes_args = ['nickname?']
1692
def run(self, nickname=None):
1693
branch = Branch.open_containing(u'.')[0]
1694
if nickname is None:
1695
self.printme(branch)
1697
branch.nick = nickname
1700
def printme(self, branch):
1704
class cmd_selftest(Command):
1705
"""Run internal test suite.
1707
This creates temporary test directories in the working directory,
1708
but not existing data is affected. These directories are deleted
1709
if the tests pass, or left behind to help in debugging if they
1710
fail and --keep-output is specified.
1712
If arguments are given, they are regular expressions that say
1713
which tests should run.
1715
If the global option '--no-plugins' is given, plugins are not loaded
1716
before running the selftests. This has two effects: features provided or
1717
modified by plugins will not be tested, and tests provided by plugins will
1722
bzr --no-plugins selftest -v
1724
# TODO: --list should give a list of all available tests
1726
# NB: this is used from the class without creating an instance, which is
1727
# why it does not have a self parameter.
1728
def get_transport_type(typestring):
1729
"""Parse and return a transport specifier."""
1730
if typestring == "sftp":
1731
from bzrlib.transport.sftp import SFTPAbsoluteServer
1732
return SFTPAbsoluteServer
1733
if typestring == "memory":
1734
from bzrlib.transport.memory import MemoryServer
1736
if typestring == "fakenfs":
1737
from bzrlib.transport.fakenfs import FakeNFSServer
1738
return FakeNFSServer
1739
msg = "No known transport type %s. Supported types are: sftp\n" %\
1741
raise BzrCommandError(msg)
1744
takes_args = ['testspecs*']
1745
takes_options = ['verbose',
1746
Option('one', help='stop when one test fails'),
1747
Option('keep-output',
1748
help='keep output directories when tests fail'),
1750
help='Use a different transport by default '
1751
'throughout the test suite.',
1752
type=get_transport_type),
1755
def run(self, testspecs_list=None, verbose=False, one=False,
1756
keep_output=False, transport=None):
1758
from bzrlib.tests import selftest
1759
# we don't want progress meters from the tests to go to the
1760
# real output; and we don't want log messages cluttering up
1762
save_ui = bzrlib.ui.ui_factory
1763
bzrlib.trace.info('running tests...')
1765
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1766
if testspecs_list is not None:
1767
pattern = '|'.join(testspecs_list)
1770
result = selftest(verbose=verbose,
1772
stop_on_failure=one,
1773
keep_output=keep_output,
1774
transport=transport)
1776
bzrlib.trace.info('tests passed')
1778
bzrlib.trace.info('tests failed')
1779
return int(not result)
1781
bzrlib.ui.ui_factory = save_ui
1784
def _get_bzr_branch():
1785
"""If bzr is run from a branch, return Branch or None"""
1786
import bzrlib.errors
1787
from bzrlib.branch import Branch
1788
from bzrlib.osutils import abspath
1789
from os.path import dirname
1792
branch = Branch.open(dirname(abspath(dirname(__file__))))
1794
except bzrlib.errors.BzrError:
1799
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1800
# is bzrlib itself in a branch?
1801
branch = _get_bzr_branch()
1803
rh = branch.revision_history()
1805
print " bzr checkout, revision %d" % (revno,)
1806
print " nick: %s" % (branch.nick,)
1808
print " revid: %s" % (rh[-1],)
1809
print bzrlib.__copyright__
1810
print "http://bazaar-ng.org/"
1812
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1813
print "you may use, modify and redistribute it under the terms of the GNU"
1814
print "General Public License version 2 or later."
1817
class cmd_version(Command):
1818
"""Show version of bzr."""
1823
class cmd_rocks(Command):
1824
"""Statement of optimism."""
1828
print "it sure does!"
1831
class cmd_find_merge_base(Command):
1832
"""Find and print a base revision for merging two branches.
1834
# TODO: Options to specify revisions on either side, as if
1835
# merging only part of the history.
1836
takes_args = ['branch', 'other']
1840
def run(self, branch, other):
1841
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1843
branch1 = Branch.open_containing(branch)[0]
1844
branch2 = Branch.open_containing(other)[0]
1846
history_1 = branch1.revision_history()
1847
history_2 = branch2.revision_history()
1849
last1 = branch1.last_revision()
1850
last2 = branch2.last_revision()
1852
source = MultipleRevisionSources(branch1.repository,
1855
base_rev_id = common_ancestor(last1, last2, source)
1857
print 'merge base is revision %s' % base_rev_id
1861
if base_revno is None:
1862
raise bzrlib.errors.UnrelatedBranches()
1864
print ' r%-6d in %s' % (base_revno, branch)
1866
other_revno = branch2.revision_id_to_revno(base_revid)
1868
print ' r%-6d in %s' % (other_revno, other)
1872
class cmd_merge(Command):
1873
"""Perform a three-way merge.
1875
The branch is the branch you will merge from. By default, it will
1876
merge the latest revision. If you specify a revision, that
1877
revision will be merged. If you specify two revisions, the first
1878
will be used as a BASE, and the second one as OTHER. Revision
1879
numbers are always relative to the specified branch.
1881
By default, bzr will try to merge in all new work from the other
1882
branch, automatically determining an appropriate base. If this
1883
fails, you may need to give an explicit base.
1885
Merge will do its best to combine the changes in two branches, but there
1886
are some kinds of problems only a human can fix. When it encounters those,
1887
it will mark a conflict. A conflict means that you need to fix something,
1888
before you should commit.
1890
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
1892
If there is no default branch set, the first merge will set it. After
1893
that, you can omit the branch to use the default. To change the
1894
default, use --remember.
1898
To merge the latest revision from bzr.dev
1899
bzr merge ../bzr.dev
1901
To merge changes up to and including revision 82 from bzr.dev
1902
bzr merge -r 82 ../bzr.dev
1904
To merge the changes introduced by 82, without previous changes:
1905
bzr merge -r 81..82 ../bzr.dev
1907
merge refuses to run if there are any uncommitted changes, unless
1910
takes_args = ['branch?']
1911
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
1912
Option('show-base', help="Show base revision text in "
1915
def run(self, branch=None, revision=None, force=False, merge_type=None,
1916
show_base=False, reprocess=False, remember=False):
1917
if merge_type is None:
1918
merge_type = Merge3Merger
1920
tree = WorkingTree.open_containing(u'.')[0]
1921
stored_loc = tree.branch.get_parent()
1923
if stored_loc is None:
1924
raise BzrCommandError("No merge branch known or specified.")
1926
print "Using saved branch: %s" % stored_loc
1929
if tree.branch.get_parent() is None or remember:
1930
tree.branch.set_parent(branch)
1932
if revision is None or len(revision) < 1:
1934
other = [branch, -1]
1935
other_branch, path = Branch.open_containing(branch)
1937
if len(revision) == 1:
1939
other_branch, path = Branch.open_containing(branch)
1940
revno = revision[0].in_history(other_branch).revno
1941
other = [branch, revno]
1943
assert len(revision) == 2
1944
if None in revision:
1945
raise BzrCommandError(
1946
"Merge doesn't permit that revision specifier.")
1947
b, path = Branch.open_containing(branch)
1949
base = [branch, revision[0].in_history(b).revno]
1950
other = [branch, revision[1].in_history(b).revno]
1952
interesting_files = [path]
1954
interesting_files = None
1955
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1958
conflict_count = merge(other, base, check_clean=(not force),
1959
merge_type=merge_type,
1960
reprocess=reprocess,
1961
show_base=show_base,
1962
pb=pb, file_list=interesting_files)
1965
if conflict_count != 0:
1969
except bzrlib.errors.AmbiguousBase, e:
1970
m = ("sorry, bzr can't determine the right merge base yet\n"
1971
"candidates are:\n "
1972
+ "\n ".join(e.bases)
1974
"please specify an explicit base with -r,\n"
1975
"and (if you want) report this to the bzr developers\n")
1979
class cmd_remerge(Command):
1982
takes_args = ['file*']
1983
takes_options = ['merge-type', 'reprocess',
1984
Option('show-base', help="Show base revision text in "
1987
def run(self, file_list=None, merge_type=None, show_base=False,
1989
from bzrlib.merge import merge_inner, transform_tree
1990
if merge_type is None:
1991
merge_type = Merge3Merger
1992
tree, file_list = tree_files(file_list)
1995
pending_merges = tree.pending_merges()
1996
if len(pending_merges) != 1:
1997
raise BzrCommandError("Sorry, remerge only works after normal"
1998
+ " merges. Not cherrypicking or"
2000
repository = tree.branch.repository
2001
base_revision = common_ancestor(tree.branch.last_revision(),
2002
pending_merges[0], repository)
2003
base_tree = repository.revision_tree(base_revision)
2004
other_tree = repository.revision_tree(pending_merges[0])
2005
interesting_ids = None
2006
if file_list is not None:
2007
interesting_ids = set()
2008
for filename in file_list:
2009
file_id = tree.path2id(filename)
2011
raise NotVersionedError(filename)
2012
interesting_ids.add(file_id)
2013
if tree.kind(file_id) != "directory":
2016
for name, ie in tree.inventory.iter_entries(file_id):
2017
interesting_ids.add(ie.file_id)
2018
transform_tree(tree, tree.basis_tree(), interesting_ids)
2019
if file_list is None:
2020
restore_files = list(tree.iter_conflicts())
2022
restore_files = file_list
2023
for filename in restore_files:
2025
restore(tree.abspath(filename))
2026
except NotConflicted:
2028
conflicts = merge_inner(tree.branch, other_tree, base_tree,
2030
interesting_ids = interesting_ids,
2031
other_rev_id=pending_merges[0],
2032
merge_type=merge_type,
2033
show_base=show_base,
2034
reprocess=reprocess)
2042
class cmd_revert(Command):
2043
"""Reverse all changes since the last commit.
2045
Only versioned files are affected. Specify filenames to revert only
2046
those files. By default, any files that are changed will be backed up
2047
first. Backup files have a '~' appended to their name.
2049
takes_options = ['revision', 'no-backup']
2050
takes_args = ['file*']
2051
aliases = ['merge-revert']
2053
def run(self, revision=None, no_backup=False, file_list=None):
2054
from bzrlib.commands import parse_spec
2055
if file_list is not None:
2056
if len(file_list) == 0:
2057
raise BzrCommandError("No files specified")
2061
tree, file_list = tree_files(file_list)
2062
if revision is None:
2063
# FIXME should be tree.last_revision
2064
rev_id = tree.last_revision()
2065
elif len(revision) != 1:
2066
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
2068
rev_id = revision[0].in_history(tree.branch).rev_id
2069
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2071
tree.revert(file_list,
2072
tree.branch.repository.revision_tree(rev_id),
2078
class cmd_assert_fail(Command):
2079
"""Test reporting of assertion failures"""
2082
assert False, "always fails"
2085
class cmd_help(Command):
2086
"""Show help on a command or other topic.
2088
For a list of all available commands, say 'bzr help commands'."""
2089
takes_options = [Option('long', 'show help on all commands')]
2090
takes_args = ['topic?']
2091
aliases = ['?', '--help', '-?', '-h']
2094
def run(self, topic=None, long=False):
2096
if topic is None and long:
2101
class cmd_shell_complete(Command):
2102
"""Show appropriate completions for context.
2104
For a list of all available commands, say 'bzr shell-complete'."""
2105
takes_args = ['context?']
2110
def run(self, context=None):
2111
import shellcomplete
2112
shellcomplete.shellcomplete(context)
2115
class cmd_fetch(Command):
2116
"""Copy in history from another branch but don't merge it.
2118
This is an internal method used for pull and merge."""
2120
takes_args = ['from_branch', 'to_branch']
2121
def run(self, from_branch, to_branch):
2122
from bzrlib.fetch import Fetcher
2123
from bzrlib.branch import Branch
2124
from_b = Branch.open(from_branch)
2125
to_b = Branch.open(to_branch)
2126
Fetcher(to_b, from_b)
2129
class cmd_missing(Command):
2130
"""Show unmerged/unpulled revisions between two branches.
2132
OTHER_BRANCH may be local or remote."""
2133
takes_args = ['other_branch?']
2134
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2136
'Display changes in the local branch only'),
2137
Option('theirs-only',
2138
'Display changes in the remote branch only'),
2147
def run(self, other_branch=None, reverse=False, mine_only=False,
2148
theirs_only=False, log_format=None, long=False, short=False, line=False,
2149
show_ids=False, verbose=False):
2150
from bzrlib.missing import find_unmerged, iter_log_data
2151
from bzrlib.log import log_formatter
2152
local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
2153
parent = local_branch.get_parent()
2154
if other_branch is None:
2155
other_branch = parent
2156
if other_branch is None:
2157
raise BzrCommandError("No missing location known or specified.")
2158
print "Using last location: " + local_branch.get_parent()
2159
remote_branch = bzrlib.branch.Branch.open(other_branch)
2160
if remote_branch.base == local_branch.base:
2161
remote_branch = local_branch
2162
local_branch.lock_read()
2164
remote_branch.lock_read()
2166
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2167
if (log_format == None):
2168
default = bzrlib.config.BranchConfig(local_branch).log_format()
2169
log_format = get_log_format(long=long, short=short, line=line, default=default)
2170
lf = log_formatter(log_format, sys.stdout,
2172
show_timezone='original')
2173
if reverse is False:
2174
local_extra.reverse()
2175
remote_extra.reverse()
2176
if local_extra and not theirs_only:
2177
print "You have %d extra revision(s):" % len(local_extra)
2178
for data in iter_log_data(local_extra, local_branch.repository,
2181
printed_local = True
2183
printed_local = False
2184
if remote_extra and not mine_only:
2185
if printed_local is True:
2187
print "You are missing %d revision(s):" % len(remote_extra)
2188
for data in iter_log_data(remote_extra, remote_branch.repository,
2191
if not remote_extra and not local_extra:
2193
print "Branches are up to date."
2197
remote_branch.unlock()
2199
local_branch.unlock()
2200
if not status_code and parent is None and other_branch is not None:
2201
local_branch.lock_write()
2203
# handle race conditions - a parent might be set while we run.
2204
if local_branch.get_parent() is None:
2205
local_branch.set_parent(other_branch)
2207
local_branch.unlock()
2211
class cmd_plugins(Command):
2216
import bzrlib.plugin
2217
from inspect import getdoc
2218
for name, plugin in bzrlib.plugin.all_plugins().items():
2219
if hasattr(plugin, '__path__'):
2220
print plugin.__path__[0]
2221
elif hasattr(plugin, '__file__'):
2222
print plugin.__file__
2228
print '\t', d.split('\n')[0]
2231
class cmd_testament(Command):
2232
"""Show testament (signing-form) of a revision."""
2233
takes_options = ['revision', 'long']
2234
takes_args = ['branch?']
2236
def run(self, branch=u'.', revision=None, long=False):
2237
from bzrlib.testament import Testament
2238
b = WorkingTree.open_containing(branch)[0].branch
2241
if revision is None:
2242
rev_id = b.last_revision()
2244
rev_id = revision[0].in_history(b).rev_id
2245
t = Testament.from_revision(b.repository, rev_id)
2247
sys.stdout.writelines(t.as_text_lines())
2249
sys.stdout.write(t.as_short_text())
2254
class cmd_annotate(Command):
2255
"""Show the origin of each line in a file.
2257
This prints out the given file with an annotation on the left side
2258
indicating which revision, author and date introduced the change.
2260
If the origin is the same for a run of consecutive lines, it is
2261
shown only at the top, unless the --all option is given.
2263
# TODO: annotate directories; showing when each file was last changed
2264
# TODO: annotate a previous version of a file
2265
# TODO: if the working copy is modified, show annotations on that
2266
# with new uncommitted lines marked
2267
aliases = ['blame', 'praise']
2268
takes_args = ['filename']
2269
takes_options = [Option('all', help='show annotations on all lines'),
2270
Option('long', help='show date in annotations'),
2274
def run(self, filename, all=False, long=False):
2275
from bzrlib.annotate import annotate_file
2276
tree, relpath = WorkingTree.open_containing(filename)
2277
branch = tree.branch
2280
file_id = tree.inventory.path2id(relpath)
2281
tree = branch.repository.revision_tree(branch.last_revision())
2282
file_version = tree.inventory[file_id].revision
2283
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2288
class cmd_re_sign(Command):
2289
"""Create a digital signature for an existing revision."""
2290
# TODO be able to replace existing ones.
2292
hidden = True # is this right ?
2293
takes_args = ['revision_id*']
2294
takes_options = ['revision']
2296
def run(self, revision_id_list=None, revision=None):
2297
import bzrlib.config as config
2298
import bzrlib.gpg as gpg
2299
if revision_id_list is not None and revision is not None:
2300
raise BzrCommandError('You can only supply one of revision_id or --revision')
2301
if revision_id_list is None and revision is None:
2302
raise BzrCommandError('You must supply either --revision or a revision_id')
2303
b = WorkingTree.open_containing(u'.')[0].branch
2304
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
2305
if revision_id_list is not None:
2306
for revision_id in revision_id_list:
2307
b.repository.sign_revision(revision_id, gpg_strategy)
2308
elif revision is not None:
2309
if len(revision) == 1:
2310
revno, rev_id = revision[0].in_history(b)
2311
b.repository.sign_revision(rev_id, gpg_strategy)
2312
elif len(revision) == 2:
2313
# are they both on rh- if so we can walk between them
2314
# might be nice to have a range helper for arbitrary
2315
# revision paths. hmm.
2316
from_revno, from_revid = revision[0].in_history(b)
2317
to_revno, to_revid = revision[1].in_history(b)
2318
if to_revid is None:
2319
to_revno = b.revno()
2320
if from_revno is None or to_revno is None:
2321
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
2322
for revno in range(from_revno, to_revno + 1):
2323
b.repository.sign_revision(b.get_rev_id(revno),
2326
raise BzrCommandError('Please supply either one revision, or a range.')
2329
class cmd_bind(Command):
2330
"""Bind the current branch to a master branch.
2332
After binding, commits must succeed on the master branch
2333
before they are executed on the local one.
2336
takes_args = ['location']
2339
def run(self, location=None):
2340
b, relpath = Branch.open_containing(u'.')
2341
b_other = Branch.open(location)
2344
except DivergedBranches:
2345
raise BzrCommandError('These branches have diverged.'
2346
' Try merging, and then bind again.')
2349
class cmd_unbind(Command):
2350
"""Bind the current branch to its parent.
2352
After unbinding, the local branch is considered independent.
2359
b, relpath = Branch.open_containing(u'.')
2361
raise BzrCommandError('Local branch is not bound')
2364
class cmd_uncommit(bzrlib.commands.Command):
2365
"""Remove the last committed revision.
2367
By supplying the --all flag, it will not only remove the entry
2368
from revision_history, but also remove all of the entries in the
2371
--verbose will print out what is being removed.
2372
--dry-run will go through all the motions, but not actually
2375
In the future, uncommit will create a changeset, which can then
2379
# TODO: jam 20060108 Add an option to allow uncommit to remove
2380
# unreferenced information in 'branch-as-repostory' branches.
2381
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2382
# information in shared branches as well.
2383
takes_options = ['verbose', 'revision',
2384
Option('dry-run', help='Don\'t actually make changes'),
2385
Option('force', help='Say yes to all questions.')]
2386
takes_args = ['location?']
2389
def run(self, location=None,
2390
dry_run=False, verbose=False,
2391
revision=None, force=False):
2392
from bzrlib.branch import Branch
2393
from bzrlib.log import log_formatter
2395
from bzrlib.uncommit import uncommit
2397
if location is None:
2399
control, relpath = bzrdir.BzrDir.open_containing(location)
2401
tree = control.open_workingtree()
2403
except (errors.NoWorkingTree, errors.NotLocalUrl):
2405
b = control.open_branch()
2407
if revision is None:
2409
rev_id = b.last_revision()
2411
revno, rev_id = revision[0].in_history(b)
2413
print 'No revisions to uncommit.'
2415
for r in range(revno, b.revno()+1):
2416
rev_id = b.get_rev_id(r)
2417
lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
2418
lf.show(r, b.repository.get_revision(rev_id), None)
2421
print 'Dry-run, pretending to remove the above revisions.'
2423
val = raw_input('Press <enter> to continue')
2425
print 'The above revision(s) will be removed.'
2427
val = raw_input('Are you sure [y/N]? ')
2428
if val.lower() not in ('y', 'yes'):
2432
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2436
class cmd_break_lock(Command):
2437
"""Break a dead lock on a repository, branch or working directory.
2439
CAUTION: Locks should only be broken when you are sure that the process
2440
holding the lock has been stopped.
2445
takes_args = ['location']
2446
takes_options = [Option('show',
2447
help="just show information on the lock, " \
2450
def run(self, location, show=False):
2451
raise NotImplementedError("sorry, break-lock is not complete yet; "
2452
"you can remove the 'held' directory manually to break the lock")
2455
# command-line interpretation helper for merge-related commands
2456
def merge(other_revision, base_revision,
2457
check_clean=True, ignore_zero=False,
2458
this_dir=None, backup_files=False, merge_type=Merge3Merger,
2459
file_list=None, show_base=False, reprocess=False,
2460
pb=DummyProgress()):
2461
"""Merge changes into a tree.
2464
list(path, revno) Base for three-way merge.
2465
If [None, None] then a base will be automatically determined.
2467
list(path, revno) Other revision for three-way merge.
2469
Directory to merge changes into; '.' by default.
2471
If true, this_dir must have no uncommitted changes before the
2473
ignore_zero - If true, suppress the "zero conflicts" message when
2474
there are no conflicts; should be set when doing something we expect
2475
to complete perfectly.
2476
file_list - If supplied, merge only changes to selected files.
2478
All available ancestors of other_revision and base_revision are
2479
automatically pulled into the branch.
2481
The revno may be -1 to indicate the last revision on the branch, which is
2484
This function is intended for use from the command line; programmatic
2485
clients might prefer to call merge.merge_inner(), which has less magic
2488
from bzrlib.merge import Merger
2489
if this_dir is None:
2491
this_tree = WorkingTree.open_containing(this_dir)[0]
2492
if show_base and not merge_type is Merge3Merger:
2493
raise BzrCommandError("Show-base is not supported for this merge"
2494
" type. %s" % merge_type)
2495
if reprocess and not merge_type.supports_reprocess:
2496
raise BzrCommandError("Conflict reduction is not supported for merge"
2497
" type %s." % merge_type)
2498
if reprocess and show_base:
2499
raise BzrCommandError("Cannot do conflict reduction and show base.")
2501
merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
2502
merger.pp = ProgressPhase("Merge phase", 5, pb)
2503
merger.pp.next_phase()
2504
merger.check_basis(check_clean)
2505
merger.set_other(other_revision)
2506
merger.pp.next_phase()
2507
merger.set_base(base_revision)
2508
if merger.base_rev_id == merger.other_rev_id:
2509
note('Nothing to do.')
2511
merger.backup_files = backup_files
2512
merger.merge_type = merge_type
2513
merger.set_interesting_files(file_list)
2514
merger.show_base = show_base
2515
merger.reprocess = reprocess
2516
conflicts = merger.do_merge()
2517
if file_list is None:
2518
merger.set_pending()
2524
# these get imported and then picked up by the scan for cmd_*
2525
# TODO: Some more consistent way to split command definitions across files;
2526
# we do need to load at least some information about them to know of
2527
# aliases. ideally we would avoid loading the implementation until the
2528
# details were needed.
2529
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2530
from bzrlib.sign_my_commits import cmd_sign_my_commits
2531
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
2532
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
