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
tree_from = WorkingTree.open_containing(u'.')[0]
480
br_from = tree_from.branch
481
stored_loc = tree_from.branch.get_push_location()
483
if stored_loc is None:
484
raise BzrCommandError("No push location known or specified.")
486
print "Using saved location: %s" % stored_loc
487
location = stored_loc
488
if br_from.get_push_location() is None or remember:
489
br_from.set_push_location(location)
491
dir_to = bzrlib.bzrdir.BzrDir.open(location)
492
br_to = dir_to.open_branch()
493
except NotBranchError:
495
transport = get_transport(location).clone('..')
496
if not create_prefix:
498
transport.mkdir(transport.relpath(location))
500
raise BzrCommandError("Parent directory of %s "
501
"does not exist." % location)
503
current = transport.base
504
needed = [(transport, transport.relpath(location))]
507
transport, relpath = needed[-1]
508
transport.mkdir(relpath)
511
new_transport = transport.clone('..')
512
needed.append((new_transport,
513
new_transport.relpath(transport.base)))
514
if new_transport.base == transport.base:
515
raise BzrCommandError("Could not create "
517
dir_to = br_from.bzrdir.clone(location)
518
br_to = dir_to.open_branch()
519
old_rh = br_to.revision_history()
522
tree_to = dir_to.open_workingtree()
523
except errors.NotLocalUrl:
524
# TODO: This should be updated for branches which don't have a
525
# working tree, as opposed to ones where we just couldn't
527
warning('This transport does not update the working '
528
'tree of: %s' % (br_to.base,))
529
count = br_to.pull(br_from, overwrite)
530
except NoWorkingTree:
531
count = br_to.pull(br_from, overwrite)
533
count = tree_to.pull(br_from, overwrite)
534
except DivergedBranches:
535
raise BzrCommandError("These branches have diverged."
536
" Try a merge then push with overwrite.")
537
note('%d revision(s) pushed.' % (count,))
540
new_rh = br_to.revision_history()
543
from bzrlib.log import show_changed_revisions
544
show_changed_revisions(br_to, old_rh, new_rh)
547
class cmd_branch(Command):
548
"""Create a new copy of a branch.
550
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
551
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
553
To retrieve the branch as of a particular revision, supply the --revision
554
parameter, as in "branch foo/bar -r 5".
556
--basis is to speed up branching from remote branches. When specified, it
557
copies all the file-contents, inventory and revision data from the basis
558
branch before copying anything from the remote branch.
560
takes_args = ['from_location', 'to_location?']
561
takes_options = ['revision', 'basis']
562
aliases = ['get', 'clone']
564
def run(self, from_location, to_location=None, revision=None, basis=None):
567
elif len(revision) > 1:
568
raise BzrCommandError(
569
'bzr branch --revision takes exactly 1 revision value')
571
br_from = Branch.open(from_location)
573
if e.errno == errno.ENOENT:
574
raise BzrCommandError('Source location "%s" does not'
575
' exist.' % to_location)
580
if basis is not None:
581
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
584
if len(revision) == 1 and revision[0] is not None:
585
revision_id = revision[0].in_history(br_from)[1]
587
# FIXME - wt.last_revision, fallback to branch, fall back to
588
# None or perhaps NULL_REVISION to mean copy nothing
590
revision_id = br_from.last_revision()
591
if to_location is None:
592
to_location = os.path.basename(from_location.rstrip("/\\"))
595
name = os.path.basename(to_location) + '\n'
597
os.mkdir(to_location)
599
if e.errno == errno.EEXIST:
600
raise BzrCommandError('Target directory "%s" already'
601
' exists.' % to_location)
602
if e.errno == errno.ENOENT:
603
raise BzrCommandError('Parent of "%s" does not exist.' %
608
# preserve whatever source format we have.
609
dir = br_from.bzrdir.sprout(to_location, revision_id, basis_dir)
610
branch = dir.open_branch()
611
except bzrlib.errors.NoSuchRevision:
613
msg = "The branch %s has no revision %s." % (from_location, revision[0])
614
raise BzrCommandError(msg)
615
except bzrlib.errors.UnlistableBranch:
617
msg = "The branch %s cannot be used as a --basis" % (basis,)
618
raise BzrCommandError(msg)
620
branch.control_files.put_utf8('branch-name', name)
622
note('Branched %d revision(s).' % branch.revno())
627
class cmd_checkout(Command):
628
"""Create a new checkout of an existing branch.
630
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
631
the branch found in '.'. This is useful if you have removed the working tree
632
or if it was never created - i.e. if you pushed the branch to its current
635
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
636
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
638
To retrieve the branch as of a particular revision, supply the --revision
639
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
640
out of date [so you cannot commit] but it may be useful (i.e. to examine old
643
--basis is to speed up checking out from remote branches. When specified, it
644
uses the inventory and file contents from the basis branch in preference to the
645
branch being checked out. [Not implemented yet.]
647
takes_args = ['branch_location?', 'to_location?']
648
takes_options = ['revision', # , 'basis']
649
Option('lightweight',
650
help="perform a lightweight checkout. Lightweight "
651
"checkouts depend on access to the branch for "
652
"every operation. Normal checkouts can perform "
653
"common operations like diff and status without "
654
"such access, and also support local commits."
658
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
662
elif len(revision) > 1:
663
raise BzrCommandError(
664
'bzr checkout --revision takes exactly 1 revision value')
665
if branch_location is None:
666
branch_location = bzrlib.osutils.getcwd()
667
to_location = branch_location
668
source = Branch.open(branch_location)
669
if len(revision) == 1 and revision[0] is not None:
670
revision_id = revision[0].in_history(source)[1]
673
if to_location is None:
674
to_location = os.path.basename(branch_location.rstrip("/\\"))
675
# if the source and to_location are the same,
676
# and there is no working tree,
677
# then reconstitute a branch
678
if (bzrlib.osutils.abspath(to_location) ==
679
bzrlib.osutils.abspath(branch_location)):
681
source.bzrdir.open_workingtree()
682
except errors.NoWorkingTree:
683
source.bzrdir.create_workingtree()
686
os.mkdir(to_location)
688
if e.errno == errno.EEXIST:
689
raise BzrCommandError('Target directory "%s" already'
690
' exists.' % to_location)
691
if e.errno == errno.ENOENT:
692
raise BzrCommandError('Parent of "%s" does not exist.' %
696
old_format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
697
bzrlib.bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
700
checkout = bzrdir.BzrDirMetaFormat1().initialize(to_location)
701
bzrlib.branch.BranchReferenceFormat().initialize(checkout, source)
703
checkout_branch = bzrlib.bzrdir.BzrDir.create_branch_convenience(
704
to_location, force_new_tree=False)
705
checkout = checkout_branch.bzrdir
706
checkout_branch.bind(source)
707
if revision_id is not None:
708
rh = checkout_branch.revision_history()
709
checkout_branch.set_revision_history(rh[:rh.index(revision_id) + 1])
710
checkout.create_workingtree(revision_id)
712
bzrlib.bzrdir.BzrDirFormat.set_default_format(old_format)
715
class cmd_renames(Command):
716
"""Show list of renamed files.
718
# TODO: Option to show renames between two historical versions.
720
# TODO: Only show renames under dir, rather than in the whole branch.
721
takes_args = ['dir?']
724
def run(self, dir=u'.'):
725
tree = WorkingTree.open_containing(dir)[0]
726
old_inv = tree.basis_tree().inventory
727
new_inv = tree.read_working_inventory()
729
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
731
for old_name, new_name in renames:
732
print "%s => %s" % (old_name, new_name)
735
class cmd_update(Command):
736
"""Update a tree to have the latest code committed to its branch.
738
This will perform a merge into the working tree, and may generate
739
conflicts. If you have any local changes, you will still
740
need to commit them after the update for the update to be complete.
742
If you want to discard your local changes, you can just do a
743
'bzr revert' instead of 'bzr commit' after the update.
745
takes_args = ['dir?']
747
def run(self, dir='.'):
748
tree = WorkingTree.open_containing(dir)[0]
751
if tree.last_revision() == tree.branch.last_revision():
752
# may be up to date, check master too.
753
master = tree.branch.get_master_branch()
754
if master is None or master.last_revision == tree.last_revision():
755
note("Tree is up to date.")
757
conflicts = tree.update()
758
note('Updated to revision %d.' %
759
(tree.branch.revision_id_to_revno(tree.last_revision()),))
768
class cmd_info(Command):
769
"""Show statistical information about a branch."""
770
takes_args = ['branch?']
771
takes_options = ['verbose']
774
def run(self, branch=None, verbose=False):
776
bzrlib.info.show_bzrdir_info(bzrdir.BzrDir.open_containing(branch)[0],
780
class cmd_remove(Command):
781
"""Make a file unversioned.
783
This makes bzr stop tracking changes to a versioned file. It does
784
not delete the working copy.
786
takes_args = ['file+']
787
takes_options = ['verbose']
790
def run(self, file_list, verbose=False):
791
tree, file_list = tree_files(file_list)
792
tree.remove(file_list, verbose=verbose)
795
class cmd_file_id(Command):
796
"""Print file_id of a particular file or directory.
798
The file_id is assigned when the file is first added and remains the
799
same through all revisions where the file exists, even when it is
803
takes_args = ['filename']
805
def run(self, filename):
806
tree, relpath = WorkingTree.open_containing(filename)
807
i = tree.inventory.path2id(relpath)
809
raise BzrError("%r is not a versioned file" % filename)
814
class cmd_file_path(Command):
815
"""Print path of file_ids to a file or directory.
817
This prints one line for each directory down to the target,
818
starting at the branch root."""
820
takes_args = ['filename']
822
def run(self, filename):
823
tree, relpath = WorkingTree.open_containing(filename)
825
fid = inv.path2id(relpath)
827
raise BzrError("%r is not a versioned file" % filename)
828
for fip in inv.get_idpath(fid):
832
class cmd_reconcile(Command):
833
"""Reconcile bzr metadata in a branch.
835
This can correct data mismatches that may have been caused by
836
previous ghost operations or bzr upgrades. You should only
837
need to run this command if 'bzr check' or a bzr developer
838
advises you to run it.
840
If a second branch is provided, cross-branch reconciliation is
841
also attempted, which will check that data like the tree root
842
id which was not present in very early bzr versions is represented
843
correctly in both branches.
845
At the same time it is run it may recompress data resulting in
846
a potential saving in disk space or performance gain.
848
The branch *MUST* be on a listable system such as local disk or sftp.
850
takes_args = ['branch?']
852
def run(self, branch="."):
853
from bzrlib.reconcile import reconcile
854
dir = bzrlib.bzrdir.BzrDir.open(branch)
858
class cmd_revision_history(Command):
859
"""Display list of revision ids on this branch."""
863
branch = WorkingTree.open_containing(u'.')[0].branch
864
for patchid in branch.revision_history():
868
class cmd_ancestry(Command):
869
"""List all revisions merged into this branch."""
873
tree = WorkingTree.open_containing(u'.')[0]
875
# FIXME. should be tree.last_revision
876
for revision_id in b.repository.get_ancestry(b.last_revision()):
880
class cmd_init(Command):
881
"""Make a directory into a versioned branch.
883
Use this to create an empty branch, or before importing an
886
Recipe for importing a tree of files:
891
bzr commit -m 'imported project'
893
takes_args = ['location?']
896
help='Create a specific format rather than the'
897
' current default format. Currently this '
898
' option only accepts "metadir"',
899
type=get_format_type),
901
def run(self, location=None, format=None):
902
from bzrlib.branch import Branch
906
# The path has to exist to initialize a
907
# branch inside of it.
908
# Just using os.mkdir, since I don't
909
# believe that we want to create a bunch of
910
# locations if the user supplies an extended path
911
if not os.path.exists(location):
914
existing = bzrdir.BzrDir.open(location)
915
except NotBranchError:
916
bzrdir.BzrDir.create_branch_convenience(location, format=format)
919
existing.open_branch()
920
except NotBranchError:
921
existing.create_branch()
922
existing.create_workingtree()
924
raise errors.AlreadyBranchError(location)
927
class cmd_init_repository(Command):
928
"""Create a shared repository to hold branches.
930
New branches created under the repository directory will store their revisions
931
in the repository, not in the branch directory, if the branch format supports
937
bzr checkout --lightweight repo/trunk trunk-checkout
941
takes_args = ["location"]
942
takes_options = [Option('format',
943
help='Use a specific format rather than the'
944
' current default format. Currently this'
945
' option accepts "weave", "metadir" and "knit"',
946
type=get_format_type),
948
help='Allows branches in repository to have'
950
aliases = ["init-repo"]
951
def run(self, location, format=None, trees=False):
952
from bzrlib.bzrdir import BzrDirMetaFormat1
953
from bzrlib.transport import get_transport
955
format = BzrDirMetaFormat1()
956
transport = get_transport(location)
957
if not transport.has('.'):
959
newdir = format.initialize_on_transport(transport)
960
repo = newdir.create_repository(shared=True)
961
repo.set_make_working_trees(trees)
964
class cmd_diff(Command):
965
"""Show differences in working tree.
967
If files are listed, only the changes in those files are listed.
968
Otherwise, all changes for the tree are listed.
975
# TODO: Allow diff across branches.
976
# TODO: Option to use external diff command; could be GNU diff, wdiff,
977
# or a graphical diff.
979
# TODO: Python difflib is not exactly the same as unidiff; should
980
# either fix it up or prefer to use an external diff.
982
# TODO: If a directory is given, diff everything under that.
984
# TODO: Selected-file diff is inefficient and doesn't show you
987
# TODO: This probably handles non-Unix newlines poorly.
989
takes_args = ['file*']
990
takes_options = ['revision', 'diff-options']
991
aliases = ['di', 'dif']
994
def run(self, revision=None, file_list=None, diff_options=None):
995
from bzrlib.diff import diff_cmd_helper, show_diff_trees
997
tree1, file_list = internal_tree_files(file_list)
1001
except FileInWrongBranch:
1002
if len(file_list) != 2:
1003
raise BzrCommandError("Files are in different branches")
1005
tree1, file1 = WorkingTree.open_containing(file_list[0])
1006
tree2, file2 = WorkingTree.open_containing(file_list[1])
1007
if file1 != "" or file2 != "":
1008
# FIXME diff those two files. rbc 20051123
1009
raise BzrCommandError("Files are in different branches")
1011
if revision is not None:
1012
if tree2 is not None:
1013
raise BzrCommandError("Can't specify -r with two branches")
1014
if (len(revision) == 1) or (revision[1].spec is None):
1015
return diff_cmd_helper(tree1, file_list, diff_options,
1017
elif len(revision) == 2:
1018
return diff_cmd_helper(tree1, file_list, diff_options,
1019
revision[0], revision[1])
1021
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
1023
if tree2 is not None:
1024
return show_diff_trees(tree1, tree2, sys.stdout,
1025
specific_files=file_list,
1026
external_diff_options=diff_options)
1028
return diff_cmd_helper(tree1, file_list, diff_options)
1031
class cmd_deleted(Command):
1032
"""List files deleted in the working tree.
1034
# TODO: Show files deleted since a previous revision, or
1035
# between two revisions.
1036
# TODO: Much more efficient way to do this: read in new
1037
# directories with readdir, rather than stating each one. Same
1038
# level of effort but possibly much less IO. (Or possibly not,
1039
# if the directories are very large...)
1041
def run(self, show_ids=False):
1042
tree = WorkingTree.open_containing(u'.')[0]
1043
old = tree.basis_tree()
1044
for path, ie in old.inventory.iter_entries():
1045
if not tree.has_id(ie.file_id):
1047
print '%-50s %s' % (path, ie.file_id)
1052
class cmd_modified(Command):
1053
"""List files modified in working tree."""
1057
from bzrlib.delta import compare_trees
1059
tree = WorkingTree.open_containing(u'.')[0]
1060
td = compare_trees(tree.basis_tree(), tree)
1062
for path, id, kind, text_modified, meta_modified in td.modified:
1067
class cmd_added(Command):
1068
"""List files added in working tree."""
1072
wt = WorkingTree.open_containing(u'.')[0]
1073
basis_inv = wt.basis_tree().inventory
1076
if file_id in basis_inv:
1078
path = inv.id2path(file_id)
1079
if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
1085
class cmd_root(Command):
1086
"""Show the tree root directory.
1088
The root is the nearest enclosing directory with a .bzr control
1090
takes_args = ['filename?']
1092
def run(self, filename=None):
1093
"""Print the branch root."""
1094
tree = WorkingTree.open_containing(filename)[0]
1098
class cmd_log(Command):
1099
"""Show log of a branch, file, or directory.
1101
By default show the log of the branch containing the working directory.
1103
To request a range of logs, you can use the command -r begin..end
1104
-r revision requests a specific revision, -r ..end or -r begin.. are
1110
bzr log -r -10.. http://server/branch
1113
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1115
takes_args = ['location?']
1116
takes_options = [Option('forward',
1117
help='show from oldest to newest'),
1120
help='show files changed in each revision'),
1121
'show-ids', 'revision',
1125
help='show revisions whose message matches this regexp',
1130
def run(self, location=None, timezone='original',
1140
from bzrlib.log import log_formatter, show_log
1142
assert message is None or isinstance(message, basestring), \
1143
"invalid message argument %r" % message
1144
direction = (forward and 'forward') or 'reverse'
1149
# find the file id to log:
1151
dir, fp = bzrdir.BzrDir.open_containing(location)
1152
b = dir.open_branch()
1156
inv = dir.open_workingtree().inventory
1157
except (errors.NotBranchError, errors.NotLocalUrl):
1158
# either no tree, or is remote.
1159
inv = b.basis_tree().inventory
1160
file_id = inv.path2id(fp)
1163
# FIXME ? log the current subdir only RBC 20060203
1164
dir, relpath = bzrdir.BzrDir.open_containing('.')
1165
b = dir.open_branch()
1167
if revision is None:
1170
elif len(revision) == 1:
1171
rev1 = rev2 = revision[0].in_history(b).revno
1172
elif len(revision) == 2:
1173
if revision[0].spec is None:
1174
# missing begin-range means first revision
1177
rev1 = revision[0].in_history(b).revno
1179
if revision[1].spec is None:
1180
# missing end-range means last known revision
1183
rev2 = revision[1].in_history(b).revno
1185
raise BzrCommandError('bzr log --revision takes one or two values.')
1187
# By this point, the revision numbers are converted to the +ve
1188
# form if they were supplied in the -ve form, so we can do
1189
# this comparison in relative safety
1191
(rev2, rev1) = (rev1, rev2)
1193
mutter('encoding log as %r', bzrlib.user_encoding)
1195
# use 'replace' so that we don't abort if trying to write out
1196
# in e.g. the default C locale.
1197
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1199
if (log_format == None):
1200
default = bzrlib.config.BranchConfig(b).log_format()
1201
log_format = get_log_format(long=long, short=short, line=line, default=default)
1203
lf = log_formatter(log_format,
1206
show_timezone=timezone)
1212
direction=direction,
1213
start_revision=rev1,
1218
def get_log_format(long=False, short=False, line=False, default='long'):
1219
log_format = default
1223
log_format = 'short'
1229
class cmd_touching_revisions(Command):
1230
"""Return revision-ids which affected a particular file.
1232
A more user-friendly interface is "bzr log FILE"."""
1234
takes_args = ["filename"]
1236
def run(self, filename):
1237
tree, relpath = WorkingTree.open_containing(filename)
1239
inv = tree.read_working_inventory()
1240
file_id = inv.path2id(relpath)
1241
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1242
print "%6d %s" % (revno, what)
1245
class cmd_ls(Command):
1246
"""List files in a tree.
1248
# TODO: Take a revision or remote path and list that tree instead.
1250
takes_options = ['verbose', 'revision',
1251
Option('non-recursive',
1252
help='don\'t recurse into sub-directories'),
1254
help='Print all paths from the root of the branch.'),
1255
Option('unknown', help='Print unknown files'),
1256
Option('versioned', help='Print versioned files'),
1257
Option('ignored', help='Print ignored files'),
1259
Option('null', help='Null separate the files'),
1262
def run(self, revision=None, verbose=False,
1263
non_recursive=False, from_root=False,
1264
unknown=False, versioned=False, ignored=False,
1267
if verbose and null:
1268
raise BzrCommandError('Cannot set both --verbose and --null')
1269
all = not (unknown or versioned or ignored)
1271
selection = {'I':ignored, '?':unknown, 'V':versioned}
1273
tree, relpath = WorkingTree.open_containing(u'.')
1278
if revision is not None:
1279
tree = tree.branch.repository.revision_tree(
1280
revision[0].in_history(tree.branch).rev_id)
1281
for fp, fc, kind, fid, entry in tree.list_files():
1282
if fp.startswith(relpath):
1283
fp = fp[len(relpath):]
1284
if non_recursive and '/' in fp:
1286
if not all and not selection[fc]:
1289
kindch = entry.kind_character()
1290
print '%-8s %s%s' % (fc, fp, kindch)
1292
sys.stdout.write(fp)
1293
sys.stdout.write('\0')
1299
class cmd_unknowns(Command):
1300
"""List unknown files."""
1303
from bzrlib.osutils import quotefn
1304
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1308
class cmd_ignore(Command):
1309
"""Ignore a command or pattern.
1311
To remove patterns from the ignore list, edit the .bzrignore file.
1313
If the pattern contains a slash, it is compared to the whole path
1314
from the branch root. Otherwise, it is compared to only the last
1315
component of the path. To match a file only in the root directory,
1318
Ignore patterns are case-insensitive on case-insensitive systems.
1320
Note: wildcards must be quoted from the shell on Unix.
1323
bzr ignore ./Makefile
1324
bzr ignore '*.class'
1326
# TODO: Complain if the filename is absolute
1327
takes_args = ['name_pattern']
1329
def run(self, name_pattern):
1330
from bzrlib.atomicfile import AtomicFile
1333
tree, relpath = WorkingTree.open_containing(u'.')
1334
ifn = tree.abspath('.bzrignore')
1336
if os.path.exists(ifn):
1339
igns = f.read().decode('utf-8')
1345
# TODO: If the file already uses crlf-style termination, maybe
1346
# we should use that for the newly added lines?
1348
if igns and igns[-1] != '\n':
1350
igns += name_pattern + '\n'
1353
f = AtomicFile(ifn, 'wt')
1354
f.write(igns.encode('utf-8'))
1359
inv = tree.inventory
1360
if inv.path2id('.bzrignore'):
1361
mutter('.bzrignore is already versioned')
1363
mutter('need to make new .bzrignore file versioned')
1364
tree.add(['.bzrignore'])
1367
class cmd_ignored(Command):
1368
"""List ignored files and the patterns that matched them.
1370
See also: bzr ignore"""
1373
tree = WorkingTree.open_containing(u'.')[0]
1374
for path, file_class, kind, file_id, entry in tree.list_files():
1375
if file_class != 'I':
1377
## XXX: Slightly inefficient since this was already calculated
1378
pat = tree.is_ignored(path)
1379
print '%-50s %s' % (path, pat)
1382
class cmd_lookup_revision(Command):
1383
"""Lookup the revision-id from a revision-number
1386
bzr lookup-revision 33
1389
takes_args = ['revno']
1392
def run(self, revno):
1396
raise BzrCommandError("not a valid revision-number: %r" % revno)
1398
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1401
class cmd_export(Command):
1402
"""Export past revision to destination directory.
1404
If no revision is specified this exports the last committed revision.
1406
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1407
given, try to find the format with the extension. If no extension
1408
is found exports to a directory (equivalent to --format=dir).
1410
Root may be the top directory for tar, tgz and tbz2 formats. If none
1411
is given, the top directory will be the root name of the file.
1413
Note: export of tree with non-ascii filenames to zip is not supported.
1415
Supported formats Autodetected by extension
1416
----------------- -------------------------
1419
tbz2 .tar.bz2, .tbz2
1423
takes_args = ['dest']
1424
takes_options = ['revision', 'format', 'root']
1425
def run(self, dest, revision=None, format=None, root=None):
1427
from bzrlib.export import export
1428
tree = WorkingTree.open_containing(u'.')[0]
1430
if revision is None:
1431
# should be tree.last_revision FIXME
1432
rev_id = b.last_revision()
1434
if len(revision) != 1:
1435
raise BzrError('bzr export --revision takes exactly 1 argument')
1436
rev_id = revision[0].in_history(b).rev_id
1437
t = b.repository.revision_tree(rev_id)
1439
export(t, dest, format, root)
1440
except errors.NoSuchExportFormat, e:
1441
raise BzrCommandError('Unsupported export format: %s' % e.format)
1444
class cmd_cat(Command):
1445
"""Write a file's text from a previous revision."""
1447
takes_options = ['revision']
1448
takes_args = ['filename']
1451
def run(self, filename, revision=None):
1452
if revision is not None and len(revision) != 1:
1453
raise BzrCommandError("bzr cat --revision takes exactly one number")
1456
tree, relpath = WorkingTree.open_containing(filename)
1458
except NotBranchError:
1462
b, relpath = Branch.open_containing(filename)
1463
if revision is None:
1464
revision_id = b.last_revision()
1466
revision_id = revision[0].in_history(b).rev_id
1467
b.print_file(relpath, revision_id)
1470
class cmd_local_time_offset(Command):
1471
"""Show the offset in seconds from GMT to local time."""
1475
print bzrlib.osutils.local_time_offset()
1479
class cmd_commit(Command):
1480
"""Commit changes into a new revision.
1482
If no arguments are given, the entire tree is committed.
1484
If selected files are specified, only changes to those files are
1485
committed. If a directory is specified then the directory and everything
1486
within it is committed.
1488
A selected-file commit may fail in some cases where the committed
1489
tree would be invalid, such as trying to commit a file in a
1490
newly-added directory that is not itself committed.
1492
# TODO: Run hooks on tree to-be-committed, and after commit.
1494
# TODO: Strict commit that fails if there are deleted files.
1495
# (what does "deleted files" mean ??)
1497
# TODO: Give better message for -s, --summary, used by tla people
1499
# XXX: verbose currently does nothing
1501
takes_args = ['selected*']
1502
takes_options = ['message', 'verbose',
1504
help='commit even if nothing has changed'),
1505
Option('file', type=str,
1507
help='file containing commit message'),
1509
help="refuse to commit if there are unknown "
1510
"files in the working tree."),
1512
help="perform a local only commit in a bound "
1513
"branch. Such commits are not pushed to "
1514
"the master branch until a normal commit "
1518
aliases = ['ci', 'checkin']
1520
def run(self, message=None, file=None, verbose=True, selected_list=None,
1521
unchanged=False, strict=False, local=False):
1522
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1523
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1525
from bzrlib.msgeditor import edit_commit_message, \
1526
make_commit_message_template
1527
from tempfile import TemporaryFile
1530
# TODO: Need a blackbox test for invoking the external editor; may be
1531
# slightly problematic to run this cross-platform.
1533
# TODO: do more checks that the commit will succeed before
1534
# spending the user's valuable time typing a commit message.
1536
# TODO: if the commit *does* happen to fail, then save the commit
1537
# message to a temporary file where it can be recovered
1538
tree, selected_list = tree_files(selected_list)
1539
if local and not tree.branch.get_bound_location():
1540
raise errors.LocalRequiresBoundBranch()
1541
if message is None and not file:
1542
template = make_commit_message_template(tree, selected_list)
1543
message = edit_commit_message(template)
1545
raise BzrCommandError("please specify a commit message"
1546
" with either --message or --file")
1547
elif message and file:
1548
raise BzrCommandError("please specify either --message or --file")
1552
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1555
raise BzrCommandError("empty commit message specified")
1558
reporter = ReportCommitToLog()
1560
reporter = NullCommitReporter()
1563
tree.commit(message, specific_files=selected_list,
1564
allow_pointless=unchanged, strict=strict, local=local,
1566
except PointlessCommit:
1567
# FIXME: This should really happen before the file is read in;
1568
# perhaps prepare the commit; get the message; then actually commit
1569
raise BzrCommandError("no changes to commit",
1570
["use --unchanged to commit anyhow"])
1571
except ConflictsInTree:
1572
raise BzrCommandError("Conflicts detected in working tree. "
1573
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1574
except StrictCommitFailed:
1575
raise BzrCommandError("Commit refused because there are unknown "
1576
"files in the working tree.")
1577
except errors.BoundBranchOutOfDate, e:
1578
raise BzrCommandError(str(e)
1579
+ ' Either unbind, update, or'
1580
' pass --local to commit.')
1583
class cmd_check(Command):
1584
"""Validate consistency of branch history.
1586
This command checks various invariants about the branch storage to
1587
detect data corruption or bzr bugs.
1589
takes_args = ['branch?']
1590
takes_options = ['verbose']
1592
def run(self, branch=None, verbose=False):
1593
from bzrlib.check import check
1595
tree = WorkingTree.open_containing()[0]
1596
branch = tree.branch
1598
branch = Branch.open(branch)
1599
check(branch, verbose)
1602
class cmd_scan_cache(Command):
1605
from bzrlib.hashcache import HashCache
1611
print '%6d stats' % c.stat_count
1612
print '%6d in hashcache' % len(c._cache)
1613
print '%6d files removed from cache' % c.removed_count
1614
print '%6d hashes updated' % c.update_count
1615
print '%6d files changed too recently to cache' % c.danger_count
1621
class cmd_upgrade(Command):
1622
"""Upgrade branch storage to current format.
1624
The check command or bzr developers may sometimes advise you to run
1625
this command. When the default format has changed you may also be warned
1626
during other operations to upgrade.
1628
takes_args = ['url?']
1631
help='Upgrade to a specific format rather than the'
1632
' current default format. Currently this'
1633
' option accepts "weave", "metadir" and'
1635
type=get_format_type),
1639
def run(self, url='.', format=None):
1640
from bzrlib.upgrade import upgrade
1641
upgrade(url, format)
1644
class cmd_whoami(Command):
1645
"""Show bzr user id."""
1646
takes_options = ['email']
1649
def run(self, email=False):
1651
b = WorkingTree.open_containing(u'.')[0].branch
1652
config = bzrlib.config.BranchConfig(b)
1653
except NotBranchError:
1654
config = bzrlib.config.GlobalConfig()
1657
print config.user_email()
1659
print config.username()
1662
class cmd_nick(Command):
1663
"""Print or set the branch nickname.
1665
If unset, the tree root directory name is used as the nickname
1666
To print the current nickname, execute with no argument.
1668
takes_args = ['nickname?']
1669
def run(self, nickname=None):
1670
branch = Branch.open_containing(u'.')[0]
1671
if nickname is None:
1672
self.printme(branch)
1674
branch.nick = nickname
1677
def printme(self, branch):
1681
class cmd_selftest(Command):
1682
"""Run internal test suite.
1684
This creates temporary test directories in the working directory,
1685
but not existing data is affected. These directories are deleted
1686
if the tests pass, or left behind to help in debugging if they
1687
fail and --keep-output is specified.
1689
If arguments are given, they are regular expressions that say
1690
which tests should run.
1692
If the global option '--no-plugins' is given, plugins are not loaded
1693
before running the selftests. This has two effects: features provided or
1694
modified by plugins will not be tested, and tests provided by plugins will
1699
bzr --no-plugins selftest -v
1701
# TODO: --list should give a list of all available tests
1703
# NB: this is used from the class without creating an instance, which is
1704
# why it does not have a self parameter.
1705
def get_transport_type(typestring):
1706
"""Parse and return a transport specifier."""
1707
if typestring == "sftp":
1708
from bzrlib.transport.sftp import SFTPAbsoluteServer
1709
return SFTPAbsoluteServer
1710
if typestring == "memory":
1711
from bzrlib.transport.memory import MemoryServer
1713
if typestring == "fakenfs":
1714
from bzrlib.transport.fakenfs import FakeNFSServer
1715
return FakeNFSServer
1716
msg = "No known transport type %s. Supported types are: sftp\n" %\
1718
raise BzrCommandError(msg)
1721
takes_args = ['testspecs*']
1722
takes_options = ['verbose',
1723
Option('one', help='stop when one test fails'),
1724
Option('keep-output',
1725
help='keep output directories when tests fail'),
1727
help='Use a different transport by default '
1728
'throughout the test suite.',
1729
type=get_transport_type),
1732
def run(self, testspecs_list=None, verbose=False, one=False,
1733
keep_output=False, transport=None):
1735
from bzrlib.tests import selftest
1736
# we don't want progress meters from the tests to go to the
1737
# real output; and we don't want log messages cluttering up
1739
save_ui = bzrlib.ui.ui_factory
1740
bzrlib.trace.info('running tests...')
1742
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1743
if testspecs_list is not None:
1744
pattern = '|'.join(testspecs_list)
1747
result = selftest(verbose=verbose,
1749
stop_on_failure=one,
1750
keep_output=keep_output,
1751
transport=transport)
1753
bzrlib.trace.info('tests passed')
1755
bzrlib.trace.info('tests failed')
1756
return int(not result)
1758
bzrlib.ui.ui_factory = save_ui
1761
def _get_bzr_branch():
1762
"""If bzr is run from a branch, return Branch or None"""
1763
import bzrlib.errors
1764
from bzrlib.branch import Branch
1765
from bzrlib.osutils import abspath
1766
from os.path import dirname
1769
branch = Branch.open(dirname(abspath(dirname(__file__))))
1771
except bzrlib.errors.BzrError:
1776
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1777
# is bzrlib itself in a branch?
1778
branch = _get_bzr_branch()
1780
rh = branch.revision_history()
1782
print " bzr checkout, revision %d" % (revno,)
1783
print " nick: %s" % (branch.nick,)
1785
print " revid: %s" % (rh[-1],)
1786
print bzrlib.__copyright__
1787
print "http://bazaar-ng.org/"
1789
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1790
print "you may use, modify and redistribute it under the terms of the GNU"
1791
print "General Public License version 2 or later."
1794
class cmd_version(Command):
1795
"""Show version of bzr."""
1800
class cmd_rocks(Command):
1801
"""Statement of optimism."""
1805
print "it sure does!"
1808
class cmd_find_merge_base(Command):
1809
"""Find and print a base revision for merging two branches.
1811
# TODO: Options to specify revisions on either side, as if
1812
# merging only part of the history.
1813
takes_args = ['branch', 'other']
1817
def run(self, branch, other):
1818
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1820
branch1 = Branch.open_containing(branch)[0]
1821
branch2 = Branch.open_containing(other)[0]
1823
history_1 = branch1.revision_history()
1824
history_2 = branch2.revision_history()
1826
last1 = branch1.last_revision()
1827
last2 = branch2.last_revision()
1829
source = MultipleRevisionSources(branch1.repository,
1832
base_rev_id = common_ancestor(last1, last2, source)
1834
print 'merge base is revision %s' % base_rev_id
1838
if base_revno is None:
1839
raise bzrlib.errors.UnrelatedBranches()
1841
print ' r%-6d in %s' % (base_revno, branch)
1843
other_revno = branch2.revision_id_to_revno(base_revid)
1845
print ' r%-6d in %s' % (other_revno, other)
1849
class cmd_merge(Command):
1850
"""Perform a three-way merge.
1852
The branch is the branch you will merge from. By default, it will
1853
merge the latest revision. If you specify a revision, that
1854
revision will be merged. If you specify two revisions, the first
1855
will be used as a BASE, and the second one as OTHER. Revision
1856
numbers are always relative to the specified branch.
1858
By default, bzr will try to merge in all new work from the other
1859
branch, automatically determining an appropriate base. If this
1860
fails, you may need to give an explicit base.
1862
Merge will do its best to combine the changes in two branches, but there
1863
are some kinds of problems only a human can fix. When it encounters those,
1864
it will mark a conflict. A conflict means that you need to fix something,
1865
before you should commit.
1867
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
1869
If there is no default branch set, the first merge will set it. After
1870
that, you can omit the branch to use the default. To change the
1871
default, use --remember.
1875
To merge the latest revision from bzr.dev
1876
bzr merge ../bzr.dev
1878
To merge changes up to and including revision 82 from bzr.dev
1879
bzr merge -r 82 ../bzr.dev
1881
To merge the changes introduced by 82, without previous changes:
1882
bzr merge -r 81..82 ../bzr.dev
1884
merge refuses to run if there are any uncommitted changes, unless
1887
takes_args = ['branch?']
1888
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
1889
Option('show-base', help="Show base revision text in "
1892
def run(self, branch=None, revision=None, force=False, merge_type=None,
1893
show_base=False, reprocess=False, remember=False):
1894
if merge_type is None:
1895
merge_type = Merge3Merger
1897
tree = WorkingTree.open_containing(u'.')[0]
1898
stored_loc = tree.branch.get_parent()
1900
if stored_loc is None:
1901
raise BzrCommandError("No merge branch known or specified.")
1903
print "Using saved branch: %s" % stored_loc
1906
if tree.branch.get_parent() is None or remember:
1907
tree.branch.set_parent(branch)
1909
if revision is None or len(revision) < 1:
1911
other = [branch, -1]
1912
other_branch, path = Branch.open_containing(branch)
1914
if len(revision) == 1:
1916
other_branch, path = Branch.open_containing(branch)
1917
revno = revision[0].in_history(other_branch).revno
1918
other = [branch, revno]
1920
assert len(revision) == 2
1921
if None in revision:
1922
raise BzrCommandError(
1923
"Merge doesn't permit that revision specifier.")
1924
b, path = Branch.open_containing(branch)
1926
base = [branch, revision[0].in_history(b).revno]
1927
other = [branch, revision[1].in_history(b).revno]
1929
interesting_files = [path]
1931
interesting_files = None
1932
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1935
conflict_count = merge(other, base, check_clean=(not force),
1936
merge_type=merge_type,
1937
reprocess=reprocess,
1938
show_base=show_base,
1939
pb=pb, file_list=interesting_files)
1942
if conflict_count != 0:
1946
except bzrlib.errors.AmbiguousBase, e:
1947
m = ("sorry, bzr can't determine the right merge base yet\n"
1948
"candidates are:\n "
1949
+ "\n ".join(e.bases)
1951
"please specify an explicit base with -r,\n"
1952
"and (if you want) report this to the bzr developers\n")
1956
class cmd_remerge(Command):
1959
takes_args = ['file*']
1960
takes_options = ['merge-type', 'reprocess',
1961
Option('show-base', help="Show base revision text in "
1964
def run(self, file_list=None, merge_type=None, show_base=False,
1966
from bzrlib.merge import merge_inner, transform_tree
1967
if merge_type is None:
1968
merge_type = Merge3Merger
1969
tree, file_list = tree_files(file_list)
1972
pending_merges = tree.pending_merges()
1973
if len(pending_merges) != 1:
1974
raise BzrCommandError("Sorry, remerge only works after normal"
1975
+ " merges. Not cherrypicking or"
1977
repository = tree.branch.repository
1978
base_revision = common_ancestor(tree.branch.last_revision(),
1979
pending_merges[0], repository)
1980
base_tree = repository.revision_tree(base_revision)
1981
other_tree = repository.revision_tree(pending_merges[0])
1982
interesting_ids = None
1983
if file_list is not None:
1984
interesting_ids = set()
1985
for filename in file_list:
1986
file_id = tree.path2id(filename)
1988
raise NotVersionedError(filename)
1989
interesting_ids.add(file_id)
1990
if tree.kind(file_id) != "directory":
1993
for name, ie in tree.inventory.iter_entries(file_id):
1994
interesting_ids.add(ie.file_id)
1995
transform_tree(tree, tree.basis_tree(), interesting_ids)
1996
if file_list is None:
1997
restore_files = list(tree.iter_conflicts())
1999
restore_files = file_list
2000
for filename in restore_files:
2002
restore(tree.abspath(filename))
2003
except NotConflicted:
2005
conflicts = merge_inner(tree.branch, other_tree, base_tree,
2007
interesting_ids = interesting_ids,
2008
other_rev_id=pending_merges[0],
2009
merge_type=merge_type,
2010
show_base=show_base,
2011
reprocess=reprocess)
2019
class cmd_revert(Command):
2020
"""Reverse all changes since the last commit.
2022
Only versioned files are affected. Specify filenames to revert only
2023
those files. By default, any files that are changed will be backed up
2024
first. Backup files have a '~' appended to their name.
2026
takes_options = ['revision', 'no-backup']
2027
takes_args = ['file*']
2028
aliases = ['merge-revert']
2030
def run(self, revision=None, no_backup=False, file_list=None):
2031
from bzrlib.commands import parse_spec
2032
if file_list is not None:
2033
if len(file_list) == 0:
2034
raise BzrCommandError("No files specified")
2038
tree, file_list = tree_files(file_list)
2039
if revision is None:
2040
# FIXME should be tree.last_revision
2041
rev_id = tree.last_revision()
2042
elif len(revision) != 1:
2043
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
2045
rev_id = revision[0].in_history(tree.branch).rev_id
2046
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2048
tree.revert(file_list,
2049
tree.branch.repository.revision_tree(rev_id),
2055
class cmd_assert_fail(Command):
2056
"""Test reporting of assertion failures"""
2059
assert False, "always fails"
2062
class cmd_help(Command):
2063
"""Show help on a command or other topic.
2065
For a list of all available commands, say 'bzr help commands'."""
2066
takes_options = [Option('long', 'show help on all commands')]
2067
takes_args = ['topic?']
2068
aliases = ['?', '--help', '-?', '-h']
2071
def run(self, topic=None, long=False):
2073
if topic is None and long:
2078
class cmd_shell_complete(Command):
2079
"""Show appropriate completions for context.
2081
For a list of all available commands, say 'bzr shell-complete'."""
2082
takes_args = ['context?']
2087
def run(self, context=None):
2088
import shellcomplete
2089
shellcomplete.shellcomplete(context)
2092
class cmd_fetch(Command):
2093
"""Copy in history from another branch but don't merge it.
2095
This is an internal method used for pull and merge."""
2097
takes_args = ['from_branch', 'to_branch']
2098
def run(self, from_branch, to_branch):
2099
from bzrlib.fetch import Fetcher
2100
from bzrlib.branch import Branch
2101
from_b = Branch.open(from_branch)
2102
to_b = Branch.open(to_branch)
2103
Fetcher(to_b, from_b)
2106
class cmd_missing(Command):
2107
"""Show unmerged/unpulled revisions between two branches.
2109
OTHER_BRANCH may be local or remote."""
2110
takes_args = ['other_branch?']
2111
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2113
'Display changes in the local branch only'),
2114
Option('theirs-only',
2115
'Display changes in the remote branch only'),
2124
def run(self, other_branch=None, reverse=False, mine_only=False,
2125
theirs_only=False, log_format=None, long=False, short=False, line=False,
2126
show_ids=False, verbose=False):
2127
from bzrlib.missing import find_unmerged, iter_log_data
2128
from bzrlib.log import log_formatter
2129
local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
2130
parent = local_branch.get_parent()
2131
if other_branch is None:
2132
other_branch = parent
2133
if other_branch is None:
2134
raise BzrCommandError("No missing location known or specified.")
2135
print "Using last location: " + local_branch.get_parent()
2136
remote_branch = bzrlib.branch.Branch.open(other_branch)
2137
if remote_branch.base == local_branch.base:
2138
remote_branch = local_branch
2139
local_branch.lock_read()
2141
remote_branch.lock_read()
2143
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2144
if (log_format == None):
2145
default = bzrlib.config.BranchConfig(local_branch).log_format()
2146
log_format = get_log_format(long=long, short=short, line=line, default=default)
2147
lf = log_formatter(log_format, sys.stdout,
2149
show_timezone='original')
2150
if reverse is False:
2151
local_extra.reverse()
2152
remote_extra.reverse()
2153
if local_extra and not theirs_only:
2154
print "You have %d extra revision(s):" % len(local_extra)
2155
for data in iter_log_data(local_extra, local_branch.repository,
2158
printed_local = True
2160
printed_local = False
2161
if remote_extra and not mine_only:
2162
if printed_local is True:
2164
print "You are missing %d revision(s):" % len(remote_extra)
2165
for data in iter_log_data(remote_extra, remote_branch.repository,
2168
if not remote_extra and not local_extra:
2170
print "Branches are up to date."
2174
remote_branch.unlock()
2176
local_branch.unlock()
2177
if not status_code and parent is None and other_branch is not None:
2178
local_branch.lock_write()
2180
# handle race conditions - a parent might be set while we run.
2181
if local_branch.get_parent() is None:
2182
local_branch.set_parent(other_branch)
2184
local_branch.unlock()
2188
class cmd_plugins(Command):
2193
import bzrlib.plugin
2194
from inspect import getdoc
2195
for name, plugin in bzrlib.plugin.all_plugins().items():
2196
if hasattr(plugin, '__path__'):
2197
print plugin.__path__[0]
2198
elif hasattr(plugin, '__file__'):
2199
print plugin.__file__
2205
print '\t', d.split('\n')[0]
2208
class cmd_testament(Command):
2209
"""Show testament (signing-form) of a revision."""
2210
takes_options = ['revision', 'long']
2211
takes_args = ['branch?']
2213
def run(self, branch=u'.', revision=None, long=False):
2214
from bzrlib.testament import Testament
2215
b = WorkingTree.open_containing(branch)[0].branch
2218
if revision is None:
2219
rev_id = b.last_revision()
2221
rev_id = revision[0].in_history(b).rev_id
2222
t = Testament.from_revision(b.repository, rev_id)
2224
sys.stdout.writelines(t.as_text_lines())
2226
sys.stdout.write(t.as_short_text())
2231
class cmd_annotate(Command):
2232
"""Show the origin of each line in a file.
2234
This prints out the given file with an annotation on the left side
2235
indicating which revision, author and date introduced the change.
2237
If the origin is the same for a run of consecutive lines, it is
2238
shown only at the top, unless the --all option is given.
2240
# TODO: annotate directories; showing when each file was last changed
2241
# TODO: annotate a previous version of a file
2242
# TODO: if the working copy is modified, show annotations on that
2243
# with new uncommitted lines marked
2244
aliases = ['blame', 'praise']
2245
takes_args = ['filename']
2246
takes_options = [Option('all', help='show annotations on all lines'),
2247
Option('long', help='show date in annotations'),
2251
def run(self, filename, all=False, long=False):
2252
from bzrlib.annotate import annotate_file
2253
tree, relpath = WorkingTree.open_containing(filename)
2254
branch = tree.branch
2257
file_id = tree.inventory.path2id(relpath)
2258
tree = branch.repository.revision_tree(branch.last_revision())
2259
file_version = tree.inventory[file_id].revision
2260
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2265
class cmd_re_sign(Command):
2266
"""Create a digital signature for an existing revision."""
2267
# TODO be able to replace existing ones.
2269
hidden = True # is this right ?
2270
takes_args = ['revision_id*']
2271
takes_options = ['revision']
2273
def run(self, revision_id_list=None, revision=None):
2274
import bzrlib.config as config
2275
import bzrlib.gpg as gpg
2276
if revision_id_list is not None and revision is not None:
2277
raise BzrCommandError('You can only supply one of revision_id or --revision')
2278
if revision_id_list is None and revision is None:
2279
raise BzrCommandError('You must supply either --revision or a revision_id')
2280
b = WorkingTree.open_containing(u'.')[0].branch
2281
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
2282
if revision_id_list is not None:
2283
for revision_id in revision_id_list:
2284
b.repository.sign_revision(revision_id, gpg_strategy)
2285
elif revision is not None:
2286
if len(revision) == 1:
2287
revno, rev_id = revision[0].in_history(b)
2288
b.repository.sign_revision(rev_id, gpg_strategy)
2289
elif len(revision) == 2:
2290
# are they both on rh- if so we can walk between them
2291
# might be nice to have a range helper for arbitrary
2292
# revision paths. hmm.
2293
from_revno, from_revid = revision[0].in_history(b)
2294
to_revno, to_revid = revision[1].in_history(b)
2295
if to_revid is None:
2296
to_revno = b.revno()
2297
if from_revno is None or to_revno is None:
2298
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
2299
for revno in range(from_revno, to_revno + 1):
2300
b.repository.sign_revision(b.get_rev_id(revno),
2303
raise BzrCommandError('Please supply either one revision, or a range.')
2306
class cmd_bind(Command):
2307
"""Bind the current branch to a master branch.
2309
After binding, commits must succeed on the master branch
2310
before they are executed on the local one.
2313
takes_args = ['location']
2316
def run(self, location=None):
2317
b, relpath = Branch.open_containing(u'.')
2318
b_other = Branch.open(location)
2321
except DivergedBranches:
2322
raise BzrCommandError('These branches have diverged.'
2323
' Try merging, and then bind again.')
2326
class cmd_unbind(Command):
2327
"""Bind the current branch to its parent.
2329
After unbinding, the local branch is considered independent.
2336
b, relpath = Branch.open_containing(u'.')
2338
raise BzrCommandError('Local branch is not bound')
2341
class cmd_uncommit(bzrlib.commands.Command):
2342
"""Remove the last committed revision.
2344
By supplying the --all flag, it will not only remove the entry
2345
from revision_history, but also remove all of the entries in the
2348
--verbose will print out what is being removed.
2349
--dry-run will go through all the motions, but not actually
2352
In the future, uncommit will create a changeset, which can then
2356
# TODO: jam 20060108 Add an option to allow uncommit to remove
2357
# unreferenced information in 'branch-as-repostory' branches.
2358
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2359
# information in shared branches as well.
2360
takes_options = ['verbose', 'revision',
2361
Option('dry-run', help='Don\'t actually make changes'),
2362
Option('force', help='Say yes to all questions.')]
2363
takes_args = ['location?']
2366
def run(self, location=None,
2367
dry_run=False, verbose=False,
2368
revision=None, force=False):
2369
from bzrlib.branch import Branch
2370
from bzrlib.log import log_formatter
2372
from bzrlib.uncommit import uncommit
2374
if location is None:
2376
control, relpath = bzrdir.BzrDir.open_containing(location)
2378
tree = control.open_workingtree()
2380
except (errors.NoWorkingTree, errors.NotLocalUrl):
2382
b = control.open_branch()
2384
if revision is None:
2386
rev_id = b.last_revision()
2388
revno, rev_id = revision[0].in_history(b)
2390
print 'No revisions to uncommit.'
2392
for r in range(revno, b.revno()+1):
2393
rev_id = b.get_rev_id(r)
2394
lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
2395
lf.show(r, b.repository.get_revision(rev_id), None)
2398
print 'Dry-run, pretending to remove the above revisions.'
2400
val = raw_input('Press <enter> to continue')
2402
print 'The above revision(s) will be removed.'
2404
val = raw_input('Are you sure [y/N]? ')
2405
if val.lower() not in ('y', 'yes'):
2409
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2413
class cmd_break_lock(Command):
2414
"""Break a dead lock on a repository, branch or working directory.
2416
CAUTION: Locks should only be broken when you are sure that the process
2417
holding the lock has been stopped.
2422
takes_args = ['location']
2423
takes_options = [Option('show',
2424
help="just show information on the lock, " \
2427
def run(self, location, show=False):
2428
raise NotImplementedError("sorry, break-lock is not complete yet; "
2429
"you can remove the 'held' directory manually to break the lock")
2432
# command-line interpretation helper for merge-related commands
2433
def merge(other_revision, base_revision,
2434
check_clean=True, ignore_zero=False,
2435
this_dir=None, backup_files=False, merge_type=Merge3Merger,
2436
file_list=None, show_base=False, reprocess=False,
2437
pb=DummyProgress()):
2438
"""Merge changes into a tree.
2441
list(path, revno) Base for three-way merge.
2442
If [None, None] then a base will be automatically determined.
2444
list(path, revno) Other revision for three-way merge.
2446
Directory to merge changes into; '.' by default.
2448
If true, this_dir must have no uncommitted changes before the
2450
ignore_zero - If true, suppress the "zero conflicts" message when
2451
there are no conflicts; should be set when doing something we expect
2452
to complete perfectly.
2453
file_list - If supplied, merge only changes to selected files.
2455
All available ancestors of other_revision and base_revision are
2456
automatically pulled into the branch.
2458
The revno may be -1 to indicate the last revision on the branch, which is
2461
This function is intended for use from the command line; programmatic
2462
clients might prefer to call merge.merge_inner(), which has less magic
2465
from bzrlib.merge import Merger
2466
if this_dir is None:
2468
this_tree = WorkingTree.open_containing(this_dir)[0]
2469
if show_base and not merge_type is Merge3Merger:
2470
raise BzrCommandError("Show-base is not supported for this merge"
2471
" type. %s" % merge_type)
2472
if reprocess and not merge_type.supports_reprocess:
2473
raise BzrCommandError("Conflict reduction is not supported for merge"
2474
" type %s." % merge_type)
2475
if reprocess and show_base:
2476
raise BzrCommandError("Cannot do conflict reduction and show base.")
2478
merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
2479
merger.pp = ProgressPhase("Merge phase", 5, pb)
2480
merger.pp.next_phase()
2481
merger.check_basis(check_clean)
2482
merger.set_other(other_revision)
2483
merger.pp.next_phase()
2484
merger.set_base(base_revision)
2485
if merger.base_rev_id == merger.other_rev_id:
2486
note('Nothing to do.')
2488
merger.backup_files = backup_files
2489
merger.merge_type = merge_type
2490
merger.set_interesting_files(file_list)
2491
merger.show_base = show_base
2492
merger.reprocess = reprocess
2493
conflicts = merger.do_merge()
2494
if file_list is None:
2495
merger.set_pending()
2501
# these get imported and then picked up by the scan for cmd_*
2502
# TODO: Some more consistent way to split command definitions across files;
2503
# we do need to load at least some information about them to know of
2504
# aliases. ideally we would avoid loading the implementation until the
2505
# details were needed.
2506
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2507
from bzrlib.sign_my_commits import cmd_sign_my_commits
2508
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
2509
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
