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
936
bzr init --format=metadir repo/trunk
940
takes_args = ["location"]
941
takes_options = [Option('format',
942
help='Use a specific format rather than the'
943
' current default format. Currently this'
944
' option only accepts "metadir" and "knit"'
945
' WARNING: the knit format is currently unstable'
946
' and only for experimental use.',
947
type=get_format_type),
949
help='Allows branches in repository to have'
951
aliases = ["init-repo"]
952
def run(self, location, format=None, trees=False):
953
from bzrlib.bzrdir import BzrDirMetaFormat1
954
from bzrlib.transport import get_transport
956
format = BzrDirMetaFormat1()
957
transport = get_transport(location)
958
if not transport.has('.'):
960
newdir = format.initialize_on_transport(transport)
961
repo = newdir.create_repository(shared=True)
962
repo.set_make_working_trees(trees)
965
class cmd_diff(Command):
966
"""Show differences in working tree.
968
If files are listed, only the changes in those files are listed.
969
Otherwise, all changes for the tree are listed.
976
# TODO: Allow diff across branches.
977
# TODO: Option to use external diff command; could be GNU diff, wdiff,
978
# or a graphical diff.
980
# TODO: Python difflib is not exactly the same as unidiff; should
981
# either fix it up or prefer to use an external diff.
983
# TODO: If a directory is given, diff everything under that.
985
# TODO: Selected-file diff is inefficient and doesn't show you
988
# TODO: This probably handles non-Unix newlines poorly.
990
takes_args = ['file*']
991
takes_options = ['revision', 'diff-options']
992
aliases = ['di', 'dif']
995
def run(self, revision=None, file_list=None, diff_options=None):
996
from bzrlib.diff import diff_cmd_helper, show_diff_trees
998
tree1, file_list = internal_tree_files(file_list)
1002
except FileInWrongBranch:
1003
if len(file_list) != 2:
1004
raise BzrCommandError("Files are in different branches")
1006
tree1, file1 = WorkingTree.open_containing(file_list[0])
1007
tree2, file2 = WorkingTree.open_containing(file_list[1])
1008
if file1 != "" or file2 != "":
1009
# FIXME diff those two files. rbc 20051123
1010
raise BzrCommandError("Files are in different branches")
1012
if revision is not None:
1013
if tree2 is not None:
1014
raise BzrCommandError("Can't specify -r with two branches")
1015
if (len(revision) == 1) or (revision[1].spec is None):
1016
return diff_cmd_helper(tree1, file_list, diff_options,
1018
elif len(revision) == 2:
1019
return diff_cmd_helper(tree1, file_list, diff_options,
1020
revision[0], revision[1])
1022
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
1024
if tree2 is not None:
1025
return show_diff_trees(tree1, tree2, sys.stdout,
1026
specific_files=file_list,
1027
external_diff_options=diff_options)
1029
return diff_cmd_helper(tree1, file_list, diff_options)
1032
class cmd_deleted(Command):
1033
"""List files deleted in the working tree.
1035
# TODO: Show files deleted since a previous revision, or
1036
# between two revisions.
1037
# TODO: Much more efficient way to do this: read in new
1038
# directories with readdir, rather than stating each one. Same
1039
# level of effort but possibly much less IO. (Or possibly not,
1040
# if the directories are very large...)
1042
def run(self, show_ids=False):
1043
tree = WorkingTree.open_containing(u'.')[0]
1044
old = tree.basis_tree()
1045
for path, ie in old.inventory.iter_entries():
1046
if not tree.has_id(ie.file_id):
1048
print '%-50s %s' % (path, ie.file_id)
1053
class cmd_modified(Command):
1054
"""List files modified in working tree."""
1058
from bzrlib.delta import compare_trees
1060
tree = WorkingTree.open_containing(u'.')[0]
1061
td = compare_trees(tree.basis_tree(), tree)
1063
for path, id, kind, text_modified, meta_modified in td.modified:
1068
class cmd_added(Command):
1069
"""List files added in working tree."""
1073
wt = WorkingTree.open_containing(u'.')[0]
1074
basis_inv = wt.basis_tree().inventory
1077
if file_id in basis_inv:
1079
path = inv.id2path(file_id)
1080
if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
1086
class cmd_root(Command):
1087
"""Show the tree root directory.
1089
The root is the nearest enclosing directory with a .bzr control
1091
takes_args = ['filename?']
1093
def run(self, filename=None):
1094
"""Print the branch root."""
1095
tree = WorkingTree.open_containing(filename)[0]
1099
class cmd_log(Command):
1100
"""Show log of a branch, file, or directory.
1102
By default show the log of the branch containing the working directory.
1104
To request a range of logs, you can use the command -r begin..end
1105
-r revision requests a specific revision, -r ..end or -r begin.. are
1111
bzr log -r -10.. http://server/branch
1114
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1116
takes_args = ['location?']
1117
takes_options = [Option('forward',
1118
help='show from oldest to newest'),
1121
help='show files changed in each revision'),
1122
'show-ids', 'revision',
1126
help='show revisions whose message matches this regexp',
1131
def run(self, location=None, timezone='original',
1141
from bzrlib.log import log_formatter, show_log
1143
assert message is None or isinstance(message, basestring), \
1144
"invalid message argument %r" % message
1145
direction = (forward and 'forward') or 'reverse'
1150
# find the file id to log:
1152
dir, fp = bzrdir.BzrDir.open_containing(location)
1153
b = dir.open_branch()
1157
inv = dir.open_workingtree().inventory
1158
except (errors.NotBranchError, errors.NotLocalUrl):
1159
# either no tree, or is remote.
1160
inv = b.basis_tree().inventory
1161
file_id = inv.path2id(fp)
1164
# FIXME ? log the current subdir only RBC 20060203
1165
dir, relpath = bzrdir.BzrDir.open_containing('.')
1166
b = dir.open_branch()
1168
if revision is None:
1171
elif len(revision) == 1:
1172
rev1 = rev2 = revision[0].in_history(b).revno
1173
elif len(revision) == 2:
1174
if revision[0].spec is None:
1175
# missing begin-range means first revision
1178
rev1 = revision[0].in_history(b).revno
1180
if revision[1].spec is None:
1181
# missing end-range means last known revision
1184
rev2 = revision[1].in_history(b).revno
1186
raise BzrCommandError('bzr log --revision takes one or two values.')
1188
# By this point, the revision numbers are converted to the +ve
1189
# form if they were supplied in the -ve form, so we can do
1190
# this comparison in relative safety
1192
(rev2, rev1) = (rev1, rev2)
1194
mutter('encoding log as %r', bzrlib.user_encoding)
1196
# use 'replace' so that we don't abort if trying to write out
1197
# in e.g. the default C locale.
1198
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1200
if (log_format == None):
1201
default = bzrlib.config.BranchConfig(b).log_format()
1202
log_format = get_log_format(long=long, short=short, line=line, default=default)
1204
lf = log_formatter(log_format,
1207
show_timezone=timezone)
1213
direction=direction,
1214
start_revision=rev1,
1219
def get_log_format(long=False, short=False, line=False, default='long'):
1220
log_format = default
1224
log_format = 'short'
1230
class cmd_touching_revisions(Command):
1231
"""Return revision-ids which affected a particular file.
1233
A more user-friendly interface is "bzr log FILE"."""
1235
takes_args = ["filename"]
1237
def run(self, filename):
1238
tree, relpath = WorkingTree.open_containing(filename)
1240
inv = tree.read_working_inventory()
1241
file_id = inv.path2id(relpath)
1242
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1243
print "%6d %s" % (revno, what)
1246
class cmd_ls(Command):
1247
"""List files in a tree.
1249
# TODO: Take a revision or remote path and list that tree instead.
1251
takes_options = ['verbose', 'revision',
1252
Option('non-recursive',
1253
help='don\'t recurse into sub-directories'),
1255
help='Print all paths from the root of the branch.'),
1256
Option('unknown', help='Print unknown files'),
1257
Option('versioned', help='Print versioned files'),
1258
Option('ignored', help='Print ignored files'),
1260
Option('null', help='Null separate the files'),
1263
def run(self, revision=None, verbose=False,
1264
non_recursive=False, from_root=False,
1265
unknown=False, versioned=False, ignored=False,
1268
if verbose and null:
1269
raise BzrCommandError('Cannot set both --verbose and --null')
1270
all = not (unknown or versioned or ignored)
1272
selection = {'I':ignored, '?':unknown, 'V':versioned}
1274
tree, relpath = WorkingTree.open_containing(u'.')
1279
if revision is not None:
1280
tree = tree.branch.repository.revision_tree(
1281
revision[0].in_history(tree.branch).rev_id)
1282
for fp, fc, kind, fid, entry in tree.list_files():
1283
if fp.startswith(relpath):
1284
fp = fp[len(relpath):]
1285
if non_recursive and '/' in fp:
1287
if not all and not selection[fc]:
1290
kindch = entry.kind_character()
1291
print '%-8s %s%s' % (fc, fp, kindch)
1293
sys.stdout.write(fp)
1294
sys.stdout.write('\0')
1300
class cmd_unknowns(Command):
1301
"""List unknown files."""
1304
from bzrlib.osutils import quotefn
1305
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1309
class cmd_ignore(Command):
1310
"""Ignore a command or pattern.
1312
To remove patterns from the ignore list, edit the .bzrignore file.
1314
If the pattern contains a slash, it is compared to the whole path
1315
from the branch root. Otherwise, it is compared to only the last
1316
component of the path. To match a file only in the root directory,
1319
Ignore patterns are case-insensitive on case-insensitive systems.
1321
Note: wildcards must be quoted from the shell on Unix.
1324
bzr ignore ./Makefile
1325
bzr ignore '*.class'
1327
# TODO: Complain if the filename is absolute
1328
takes_args = ['name_pattern']
1330
def run(self, name_pattern):
1331
from bzrlib.atomicfile import AtomicFile
1334
tree, relpath = WorkingTree.open_containing(u'.')
1335
ifn = tree.abspath('.bzrignore')
1337
if os.path.exists(ifn):
1340
igns = f.read().decode('utf-8')
1346
# TODO: If the file already uses crlf-style termination, maybe
1347
# we should use that for the newly added lines?
1349
if igns and igns[-1] != '\n':
1351
igns += name_pattern + '\n'
1354
f = AtomicFile(ifn, 'wt')
1355
f.write(igns.encode('utf-8'))
1360
inv = tree.inventory
1361
if inv.path2id('.bzrignore'):
1362
mutter('.bzrignore is already versioned')
1364
mutter('need to make new .bzrignore file versioned')
1365
tree.add(['.bzrignore'])
1368
class cmd_ignored(Command):
1369
"""List ignored files and the patterns that matched them.
1371
See also: bzr ignore"""
1374
tree = WorkingTree.open_containing(u'.')[0]
1375
for path, file_class, kind, file_id, entry in tree.list_files():
1376
if file_class != 'I':
1378
## XXX: Slightly inefficient since this was already calculated
1379
pat = tree.is_ignored(path)
1380
print '%-50s %s' % (path, pat)
1383
class cmd_lookup_revision(Command):
1384
"""Lookup the revision-id from a revision-number
1387
bzr lookup-revision 33
1390
takes_args = ['revno']
1393
def run(self, revno):
1397
raise BzrCommandError("not a valid revision-number: %r" % revno)
1399
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1402
class cmd_export(Command):
1403
"""Export past revision to destination directory.
1405
If no revision is specified this exports the last committed revision.
1407
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1408
given, try to find the format with the extension. If no extension
1409
is found exports to a directory (equivalent to --format=dir).
1411
Root may be the top directory for tar, tgz and tbz2 formats. If none
1412
is given, the top directory will be the root name of the file.
1414
Note: export of tree with non-ascii filenames to zip is not supported.
1416
Supported formats Autodetected by extension
1417
----------------- -------------------------
1420
tbz2 .tar.bz2, .tbz2
1424
takes_args = ['dest']
1425
takes_options = ['revision', 'format', 'root']
1426
def run(self, dest, revision=None, format=None, root=None):
1428
from bzrlib.export import export
1429
tree = WorkingTree.open_containing(u'.')[0]
1431
if revision is None:
1432
# should be tree.last_revision FIXME
1433
rev_id = b.last_revision()
1435
if len(revision) != 1:
1436
raise BzrError('bzr export --revision takes exactly 1 argument')
1437
rev_id = revision[0].in_history(b).rev_id
1438
t = b.repository.revision_tree(rev_id)
1440
export(t, dest, format, root)
1441
except errors.NoSuchExportFormat, e:
1442
raise BzrCommandError('Unsupported export format: %s' % e.format)
1445
class cmd_cat(Command):
1446
"""Write a file's text from a previous revision."""
1448
takes_options = ['revision']
1449
takes_args = ['filename']
1452
def run(self, filename, revision=None):
1453
if revision is not None and len(revision) != 1:
1454
raise BzrCommandError("bzr cat --revision takes exactly one number")
1457
tree, relpath = WorkingTree.open_containing(filename)
1459
except NotBranchError:
1463
b, relpath = Branch.open_containing(filename)
1464
if revision is None:
1465
revision_id = b.last_revision()
1467
revision_id = revision[0].in_history(b).rev_id
1468
b.print_file(relpath, revision_id)
1471
class cmd_local_time_offset(Command):
1472
"""Show the offset in seconds from GMT to local time."""
1476
print bzrlib.osutils.local_time_offset()
1480
class cmd_commit(Command):
1481
"""Commit changes into a new revision.
1483
If no arguments are given, the entire tree is committed.
1485
If selected files are specified, only changes to those files are
1486
committed. If a directory is specified then the directory and everything
1487
within it is committed.
1489
A selected-file commit may fail in some cases where the committed
1490
tree would be invalid, such as trying to commit a file in a
1491
newly-added directory that is not itself committed.
1493
# TODO: Run hooks on tree to-be-committed, and after commit.
1495
# TODO: Strict commit that fails if there are deleted files.
1496
# (what does "deleted files" mean ??)
1498
# TODO: Give better message for -s, --summary, used by tla people
1500
# XXX: verbose currently does nothing
1502
takes_args = ['selected*']
1503
takes_options = ['message', 'verbose',
1505
help='commit even if nothing has changed'),
1506
Option('file', type=str,
1508
help='file containing commit message'),
1510
help="refuse to commit if there are unknown "
1511
"files in the working tree."),
1513
help="perform a local only commit in a bound "
1514
"branch. Such commits are not pushed to "
1515
"the master branch until a normal commit "
1519
aliases = ['ci', 'checkin']
1521
def run(self, message=None, file=None, verbose=True, selected_list=None,
1522
unchanged=False, strict=False, local=False):
1523
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1524
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1526
from bzrlib.msgeditor import edit_commit_message, \
1527
make_commit_message_template
1528
from tempfile import TemporaryFile
1531
# TODO: Need a blackbox test for invoking the external editor; may be
1532
# slightly problematic to run this cross-platform.
1534
# TODO: do more checks that the commit will succeed before
1535
# spending the user's valuable time typing a commit message.
1537
# TODO: if the commit *does* happen to fail, then save the commit
1538
# message to a temporary file where it can be recovered
1539
tree, selected_list = tree_files(selected_list)
1540
if local and not tree.branch.get_bound_location():
1541
raise errors.LocalRequiresBoundBranch()
1542
if message is None and not file:
1543
template = make_commit_message_template(tree, selected_list)
1544
message = edit_commit_message(template)
1546
raise BzrCommandError("please specify a commit message"
1547
" with either --message or --file")
1548
elif message and file:
1549
raise BzrCommandError("please specify either --message or --file")
1553
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1556
raise BzrCommandError("empty commit message specified")
1559
reporter = ReportCommitToLog()
1561
reporter = NullCommitReporter()
1564
tree.commit(message, specific_files=selected_list,
1565
allow_pointless=unchanged, strict=strict, local=local,
1567
except PointlessCommit:
1568
# FIXME: This should really happen before the file is read in;
1569
# perhaps prepare the commit; get the message; then actually commit
1570
raise BzrCommandError("no changes to commit",
1571
["use --unchanged to commit anyhow"])
1572
except ConflictsInTree:
1573
raise BzrCommandError("Conflicts detected in working tree. "
1574
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1575
except StrictCommitFailed:
1576
raise BzrCommandError("Commit refused because there are unknown "
1577
"files in the working tree.")
1578
except errors.BoundBranchOutOfDate, e:
1579
raise BzrCommandError(str(e)
1580
+ ' Either unbind, update, or'
1581
' pass --local to commit.')
1584
class cmd_check(Command):
1585
"""Validate consistency of branch history.
1587
This command checks various invariants about the branch storage to
1588
detect data corruption or bzr bugs.
1590
takes_args = ['branch?']
1591
takes_options = ['verbose']
1593
def run(self, branch=None, verbose=False):
1594
from bzrlib.check import check
1596
tree = WorkingTree.open_containing()[0]
1597
branch = tree.branch
1599
branch = Branch.open(branch)
1600
check(branch, verbose)
1603
class cmd_scan_cache(Command):
1606
from bzrlib.hashcache import HashCache
1612
print '%6d stats' % c.stat_count
1613
print '%6d in hashcache' % len(c._cache)
1614
print '%6d files removed from cache' % c.removed_count
1615
print '%6d hashes updated' % c.update_count
1616
print '%6d files changed too recently to cache' % c.danger_count
1622
class cmd_upgrade(Command):
1623
"""Upgrade branch storage to current format.
1625
The check command or bzr developers may sometimes advise you to run
1626
this command. When the default format has changed you may also be warned
1627
during other operations to upgrade.
1629
takes_args = ['url?']
1632
help='Upgrade to a specific format rather than the'
1633
' current default format. Currently this'
1634
' option only accepts "metadir" and "knit".'
1635
' WARNING: the knit format is currently'
1636
' unstable and only for experimental use.',
1637
type=get_format_type),
1641
def run(self, url='.', format=None):
1642
from bzrlib.upgrade import upgrade
1643
upgrade(url, format)
1646
class cmd_whoami(Command):
1647
"""Show bzr user id."""
1648
takes_options = ['email']
1651
def run(self, email=False):
1653
b = WorkingTree.open_containing(u'.')[0].branch
1654
config = bzrlib.config.BranchConfig(b)
1655
except NotBranchError:
1656
config = bzrlib.config.GlobalConfig()
1659
print config.user_email()
1661
print config.username()
1664
class cmd_nick(Command):
1665
"""Print or set the branch nickname.
1667
If unset, the tree root directory name is used as the nickname
1668
To print the current nickname, execute with no argument.
1670
takes_args = ['nickname?']
1671
def run(self, nickname=None):
1672
branch = Branch.open_containing(u'.')[0]
1673
if nickname is None:
1674
self.printme(branch)
1676
branch.nick = nickname
1679
def printme(self, branch):
1683
class cmd_selftest(Command):
1684
"""Run internal test suite.
1686
This creates temporary test directories in the working directory,
1687
but not existing data is affected. These directories are deleted
1688
if the tests pass, or left behind to help in debugging if they
1689
fail and --keep-output is specified.
1691
If arguments are given, they are regular expressions that say
1692
which tests should run.
1694
If the global option '--no-plugins' is given, plugins are not loaded
1695
before running the selftests. This has two effects: features provided or
1696
modified by plugins will not be tested, and tests provided by plugins will
1701
bzr --no-plugins selftest -v
1703
# TODO: --list should give a list of all available tests
1705
# NB: this is used from the class without creating an instance, which is
1706
# why it does not have a self parameter.
1707
def get_transport_type(typestring):
1708
"""Parse and return a transport specifier."""
1709
if typestring == "sftp":
1710
from bzrlib.transport.sftp import SFTPAbsoluteServer
1711
return SFTPAbsoluteServer
1712
if typestring == "memory":
1713
from bzrlib.transport.memory import MemoryServer
1715
if typestring == "fakenfs":
1716
from bzrlib.transport.fakenfs import FakeNFSServer
1717
return FakeNFSServer
1718
msg = "No known transport type %s. Supported types are: sftp\n" %\
1720
raise BzrCommandError(msg)
1723
takes_args = ['testspecs*']
1724
takes_options = ['verbose',
1725
Option('one', help='stop when one test fails'),
1726
Option('keep-output',
1727
help='keep output directories when tests fail'),
1729
help='Use a different transport by default '
1730
'throughout the test suite.',
1731
type=get_transport_type),
1734
def run(self, testspecs_list=None, verbose=False, one=False,
1735
keep_output=False, transport=None):
1737
from bzrlib.tests import selftest
1738
# we don't want progress meters from the tests to go to the
1739
# real output; and we don't want log messages cluttering up
1741
save_ui = bzrlib.ui.ui_factory
1742
bzrlib.trace.info('running tests...')
1744
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1745
if testspecs_list is not None:
1746
pattern = '|'.join(testspecs_list)
1749
result = selftest(verbose=verbose,
1751
stop_on_failure=one,
1752
keep_output=keep_output,
1753
transport=transport)
1755
bzrlib.trace.info('tests passed')
1757
bzrlib.trace.info('tests failed')
1758
return int(not result)
1760
bzrlib.ui.ui_factory = save_ui
1763
def _get_bzr_branch():
1764
"""If bzr is run from a branch, return Branch or None"""
1765
import bzrlib.errors
1766
from bzrlib.branch import Branch
1767
from bzrlib.osutils import abspath
1768
from os.path import dirname
1771
branch = Branch.open(dirname(abspath(dirname(__file__))))
1773
except bzrlib.errors.BzrError:
1778
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1779
# is bzrlib itself in a branch?
1780
branch = _get_bzr_branch()
1782
rh = branch.revision_history()
1784
print " bzr checkout, revision %d" % (revno,)
1785
print " nick: %s" % (branch.nick,)
1787
print " revid: %s" % (rh[-1],)
1788
print bzrlib.__copyright__
1789
print "http://bazaar-ng.org/"
1791
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1792
print "you may use, modify and redistribute it under the terms of the GNU"
1793
print "General Public License version 2 or later."
1796
class cmd_version(Command):
1797
"""Show version of bzr."""
1802
class cmd_rocks(Command):
1803
"""Statement of optimism."""
1807
print "it sure does!"
1810
class cmd_find_merge_base(Command):
1811
"""Find and print a base revision for merging two branches.
1813
# TODO: Options to specify revisions on either side, as if
1814
# merging only part of the history.
1815
takes_args = ['branch', 'other']
1819
def run(self, branch, other):
1820
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1822
branch1 = Branch.open_containing(branch)[0]
1823
branch2 = Branch.open_containing(other)[0]
1825
history_1 = branch1.revision_history()
1826
history_2 = branch2.revision_history()
1828
last1 = branch1.last_revision()
1829
last2 = branch2.last_revision()
1831
source = MultipleRevisionSources(branch1.repository,
1834
base_rev_id = common_ancestor(last1, last2, source)
1836
print 'merge base is revision %s' % base_rev_id
1840
if base_revno is None:
1841
raise bzrlib.errors.UnrelatedBranches()
1843
print ' r%-6d in %s' % (base_revno, branch)
1845
other_revno = branch2.revision_id_to_revno(base_revid)
1847
print ' r%-6d in %s' % (other_revno, other)
1851
class cmd_merge(Command):
1852
"""Perform a three-way merge.
1854
The branch is the branch you will merge from. By default, it will
1855
merge the latest revision. If you specify a revision, that
1856
revision will be merged. If you specify two revisions, the first
1857
will be used as a BASE, and the second one as OTHER. Revision
1858
numbers are always relative to the specified branch.
1860
By default, bzr will try to merge in all new work from the other
1861
branch, automatically determining an appropriate base. If this
1862
fails, you may need to give an explicit base.
1864
Merge will do its best to combine the changes in two branches, but there
1865
are some kinds of problems only a human can fix. When it encounters those,
1866
it will mark a conflict. A conflict means that you need to fix something,
1867
before you should commit.
1869
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
1871
If there is no default branch set, the first merge will set it. After
1872
that, you can omit the branch to use the default. To change the
1873
default, use --remember.
1877
To merge the latest revision from bzr.dev
1878
bzr merge ../bzr.dev
1880
To merge changes up to and including revision 82 from bzr.dev
1881
bzr merge -r 82 ../bzr.dev
1883
To merge the changes introduced by 82, without previous changes:
1884
bzr merge -r 81..82 ../bzr.dev
1886
merge refuses to run if there are any uncommitted changes, unless
1889
takes_args = ['branch?']
1890
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
1891
Option('show-base', help="Show base revision text in "
1894
def run(self, branch=None, revision=None, force=False, merge_type=None,
1895
show_base=False, reprocess=False, remember=False):
1896
if merge_type is None:
1897
merge_type = Merge3Merger
1899
tree = WorkingTree.open_containing(u'.')[0]
1900
stored_loc = tree.branch.get_parent()
1902
if stored_loc is None:
1903
raise BzrCommandError("No merge branch known or specified.")
1905
print "Using saved branch: %s" % stored_loc
1908
if tree.branch.get_parent() is None or remember:
1909
tree.branch.set_parent(branch)
1911
if revision is None or len(revision) < 1:
1913
other = [branch, -1]
1914
other_branch, path = Branch.open_containing(branch)
1916
if len(revision) == 1:
1918
other_branch, path = Branch.open_containing(branch)
1919
revno = revision[0].in_history(other_branch).revno
1920
other = [branch, revno]
1922
assert len(revision) == 2
1923
if None in revision:
1924
raise BzrCommandError(
1925
"Merge doesn't permit that revision specifier.")
1926
b, path = Branch.open_containing(branch)
1928
base = [branch, revision[0].in_history(b).revno]
1929
other = [branch, revision[1].in_history(b).revno]
1931
interesting_files = [path]
1933
interesting_files = None
1934
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1937
conflict_count = merge(other, base, check_clean=(not force),
1938
merge_type=merge_type,
1939
reprocess=reprocess,
1940
show_base=show_base,
1941
pb=pb, file_list=interesting_files)
1944
if conflict_count != 0:
1948
except bzrlib.errors.AmbiguousBase, e:
1949
m = ("sorry, bzr can't determine the right merge base yet\n"
1950
"candidates are:\n "
1951
+ "\n ".join(e.bases)
1953
"please specify an explicit base with -r,\n"
1954
"and (if you want) report this to the bzr developers\n")
1958
class cmd_remerge(Command):
1961
takes_args = ['file*']
1962
takes_options = ['merge-type', 'reprocess',
1963
Option('show-base', help="Show base revision text in "
1966
def run(self, file_list=None, merge_type=None, show_base=False,
1968
from bzrlib.merge import merge_inner, transform_tree
1969
if merge_type is None:
1970
merge_type = Merge3Merger
1971
tree, file_list = tree_files(file_list)
1974
pending_merges = tree.pending_merges()
1975
if len(pending_merges) != 1:
1976
raise BzrCommandError("Sorry, remerge only works after normal"
1977
+ " merges. Not cherrypicking or"
1979
repository = tree.branch.repository
1980
base_revision = common_ancestor(tree.branch.last_revision(),
1981
pending_merges[0], repository)
1982
base_tree = repository.revision_tree(base_revision)
1983
other_tree = repository.revision_tree(pending_merges[0])
1984
interesting_ids = None
1985
if file_list is not None:
1986
interesting_ids = set()
1987
for filename in file_list:
1988
file_id = tree.path2id(filename)
1990
raise NotVersionedError(filename)
1991
interesting_ids.add(file_id)
1992
if tree.kind(file_id) != "directory":
1995
for name, ie in tree.inventory.iter_entries(file_id):
1996
interesting_ids.add(ie.file_id)
1997
transform_tree(tree, tree.basis_tree(), interesting_ids)
1998
if file_list is None:
1999
restore_files = list(tree.iter_conflicts())
2001
restore_files = file_list
2002
for filename in restore_files:
2004
restore(tree.abspath(filename))
2005
except NotConflicted:
2007
conflicts = merge_inner(tree.branch, other_tree, base_tree,
2009
interesting_ids = interesting_ids,
2010
other_rev_id=pending_merges[0],
2011
merge_type=merge_type,
2012
show_base=show_base,
2013
reprocess=reprocess)
2021
class cmd_revert(Command):
2022
"""Reverse all changes since the last commit.
2024
Only versioned files are affected. Specify filenames to revert only
2025
those files. By default, any files that are changed will be backed up
2026
first. Backup files have a '~' appended to their name.
2028
takes_options = ['revision', 'no-backup']
2029
takes_args = ['file*']
2030
aliases = ['merge-revert']
2032
def run(self, revision=None, no_backup=False, file_list=None):
2033
from bzrlib.commands import parse_spec
2034
if file_list is not None:
2035
if len(file_list) == 0:
2036
raise BzrCommandError("No files specified")
2040
tree, file_list = tree_files(file_list)
2041
if revision is None:
2042
# FIXME should be tree.last_revision
2043
rev_id = tree.last_revision()
2044
elif len(revision) != 1:
2045
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
2047
rev_id = revision[0].in_history(tree.branch).rev_id
2048
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2050
tree.revert(file_list,
2051
tree.branch.repository.revision_tree(rev_id),
2057
class cmd_assert_fail(Command):
2058
"""Test reporting of assertion failures"""
2061
assert False, "always fails"
2064
class cmd_help(Command):
2065
"""Show help on a command or other topic.
2067
For a list of all available commands, say 'bzr help commands'."""
2068
takes_options = [Option('long', 'show help on all commands')]
2069
takes_args = ['topic?']
2070
aliases = ['?', '--help', '-?', '-h']
2073
def run(self, topic=None, long=False):
2075
if topic is None and long:
2080
class cmd_shell_complete(Command):
2081
"""Show appropriate completions for context.
2083
For a list of all available commands, say 'bzr shell-complete'."""
2084
takes_args = ['context?']
2089
def run(self, context=None):
2090
import shellcomplete
2091
shellcomplete.shellcomplete(context)
2094
class cmd_fetch(Command):
2095
"""Copy in history from another branch but don't merge it.
2097
This is an internal method used for pull and merge."""
2099
takes_args = ['from_branch', 'to_branch']
2100
def run(self, from_branch, to_branch):
2101
from bzrlib.fetch import Fetcher
2102
from bzrlib.branch import Branch
2103
from_b = Branch.open(from_branch)
2104
to_b = Branch.open(to_branch)
2105
Fetcher(to_b, from_b)
2108
class cmd_missing(Command):
2109
"""Show unmerged/unpulled revisions between two branches.
2111
OTHER_BRANCH may be local or remote."""
2112
takes_args = ['other_branch?']
2113
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2115
'Display changes in the local branch only'),
2116
Option('theirs-only',
2117
'Display changes in the remote branch only'),
2126
def run(self, other_branch=None, reverse=False, mine_only=False,
2127
theirs_only=False, log_format=None, long=False, short=False, line=False,
2128
show_ids=False, verbose=False):
2129
from bzrlib.missing import find_unmerged, iter_log_data
2130
from bzrlib.log import log_formatter
2131
local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
2132
parent = local_branch.get_parent()
2133
if other_branch is None:
2134
other_branch = parent
2135
if other_branch is None:
2136
raise BzrCommandError("No missing location known or specified.")
2137
print "Using last location: " + local_branch.get_parent()
2138
remote_branch = bzrlib.branch.Branch.open(other_branch)
2139
local_branch.lock_write()
2140
if remote_branch.base == local_branch.base:
2141
remote_branch = local_branch
2143
remote_branch.lock_read()
2145
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2146
if (log_format == None):
2147
default = bzrlib.config.BranchConfig(local_branch).log_format()
2148
log_format = get_log_format(long=long, short=short, line=line, default=default)
2149
lf = log_formatter(log_format, sys.stdout,
2151
show_timezone='original')
2152
if reverse is False:
2153
local_extra.reverse()
2154
remote_extra.reverse()
2155
if local_extra and not theirs_only:
2156
print "You have %d extra revision(s):" % len(local_extra)
2157
for data in iter_log_data(local_extra, local_branch.repository,
2160
printed_local = True
2162
printed_local = False
2163
if remote_extra and not mine_only:
2164
if printed_local is True:
2166
print "You are missing %d revision(s):" % len(remote_extra)
2167
for data in iter_log_data(remote_extra, remote_branch.repository,
2170
if not remote_extra and not local_extra:
2172
print "Branches are up to date."
2175
if parent is None and other_branch is not None:
2176
local_branch.set_parent(other_branch)
2179
local_branch.unlock()
2181
remote_branch.unlock()
2184
class cmd_plugins(Command):
2189
import bzrlib.plugin
2190
from inspect import getdoc
2191
for name, plugin in bzrlib.plugin.all_plugins().items():
2192
if hasattr(plugin, '__path__'):
2193
print plugin.__path__[0]
2194
elif hasattr(plugin, '__file__'):
2195
print plugin.__file__
2201
print '\t', d.split('\n')[0]
2204
class cmd_testament(Command):
2205
"""Show testament (signing-form) of a revision."""
2206
takes_options = ['revision', 'long']
2207
takes_args = ['branch?']
2209
def run(self, branch=u'.', revision=None, long=False):
2210
from bzrlib.testament import Testament
2211
b = WorkingTree.open_containing(branch)[0].branch
2214
if revision is None:
2215
rev_id = b.last_revision()
2217
rev_id = revision[0].in_history(b).rev_id
2218
t = Testament.from_revision(b.repository, rev_id)
2220
sys.stdout.writelines(t.as_text_lines())
2222
sys.stdout.write(t.as_short_text())
2227
class cmd_annotate(Command):
2228
"""Show the origin of each line in a file.
2230
This prints out the given file with an annotation on the left side
2231
indicating which revision, author and date introduced the change.
2233
If the origin is the same for a run of consecutive lines, it is
2234
shown only at the top, unless the --all option is given.
2236
# TODO: annotate directories; showing when each file was last changed
2237
# TODO: annotate a previous version of a file
2238
# TODO: if the working copy is modified, show annotations on that
2239
# with new uncommitted lines marked
2240
aliases = ['blame', 'praise']
2241
takes_args = ['filename']
2242
takes_options = [Option('all', help='show annotations on all lines'),
2243
Option('long', help='show date in annotations'),
2247
def run(self, filename, all=False, long=False):
2248
from bzrlib.annotate import annotate_file
2249
tree, relpath = WorkingTree.open_containing(filename)
2250
branch = tree.branch
2253
file_id = tree.inventory.path2id(relpath)
2254
tree = branch.repository.revision_tree(branch.last_revision())
2255
file_version = tree.inventory[file_id].revision
2256
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2261
class cmd_re_sign(Command):
2262
"""Create a digital signature for an existing revision."""
2263
# TODO be able to replace existing ones.
2265
hidden = True # is this right ?
2266
takes_args = ['revision_id*']
2267
takes_options = ['revision']
2269
def run(self, revision_id_list=None, revision=None):
2270
import bzrlib.config as config
2271
import bzrlib.gpg as gpg
2272
if revision_id_list is not None and revision is not None:
2273
raise BzrCommandError('You can only supply one of revision_id or --revision')
2274
if revision_id_list is None and revision is None:
2275
raise BzrCommandError('You must supply either --revision or a revision_id')
2276
b = WorkingTree.open_containing(u'.')[0].branch
2277
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
2278
if revision_id_list is not None:
2279
for revision_id in revision_id_list:
2280
b.repository.sign_revision(revision_id, gpg_strategy)
2281
elif revision is not None:
2282
if len(revision) == 1:
2283
revno, rev_id = revision[0].in_history(b)
2284
b.repository.sign_revision(rev_id, gpg_strategy)
2285
elif len(revision) == 2:
2286
# are they both on rh- if so we can walk between them
2287
# might be nice to have a range helper for arbitrary
2288
# revision paths. hmm.
2289
from_revno, from_revid = revision[0].in_history(b)
2290
to_revno, to_revid = revision[1].in_history(b)
2291
if to_revid is None:
2292
to_revno = b.revno()
2293
if from_revno is None or to_revno is None:
2294
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
2295
for revno in range(from_revno, to_revno + 1):
2296
b.repository.sign_revision(b.get_rev_id(revno),
2299
raise BzrCommandError('Please supply either one revision, or a range.')
2302
class cmd_bind(Command):
2303
"""Bind the current branch to a master branch.
2305
After binding, commits must succeed on the master branch
2306
before they are executed on the local one.
2309
takes_args = ['location']
2312
def run(self, location=None):
2313
b, relpath = Branch.open_containing(u'.')
2314
b_other = Branch.open(location)
2317
except DivergedBranches:
2318
raise BzrCommandError('These branches have diverged.'
2319
' Try merging, and then bind again.')
2322
class cmd_unbind(Command):
2323
"""Bind the current branch to its parent.
2325
After unbinding, the local branch is considered independent.
2332
b, relpath = Branch.open_containing(u'.')
2334
raise BzrCommandError('Local branch is not bound')
2337
class cmd_uncommit(bzrlib.commands.Command):
2338
"""Remove the last committed revision.
2340
By supplying the --all flag, it will not only remove the entry
2341
from revision_history, but also remove all of the entries in the
2344
--verbose will print out what is being removed.
2345
--dry-run will go through all the motions, but not actually
2348
In the future, uncommit will create a changeset, which can then
2352
# TODO: jam 20060108 Add an option to allow uncommit to remove
2353
# unreferenced information in 'branch-as-repostory' branches.
2354
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2355
# information in shared branches as well.
2356
takes_options = ['verbose', 'revision',
2357
Option('dry-run', help='Don\'t actually make changes'),
2358
Option('force', help='Say yes to all questions.')]
2359
takes_args = ['location?']
2362
def run(self, location=None,
2363
dry_run=False, verbose=False,
2364
revision=None, force=False):
2365
from bzrlib.branch import Branch
2366
from bzrlib.log import log_formatter
2368
from bzrlib.uncommit import uncommit
2370
if location is None:
2372
control, relpath = bzrdir.BzrDir.open_containing(location)
2374
tree = control.open_workingtree()
2376
except (errors.NoWorkingTree, errors.NotLocalUrl):
2378
b = control.open_branch()
2380
if revision is None:
2382
rev_id = b.last_revision()
2384
revno, rev_id = revision[0].in_history(b)
2386
print 'No revisions to uncommit.'
2388
for r in range(revno, b.revno()+1):
2389
rev_id = b.get_rev_id(r)
2390
lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
2391
lf.show(r, b.repository.get_revision(rev_id), None)
2394
print 'Dry-run, pretending to remove the above revisions.'
2396
val = raw_input('Press <enter> to continue')
2398
print 'The above revision(s) will be removed.'
2400
val = raw_input('Are you sure [y/N]? ')
2401
if val.lower() not in ('y', 'yes'):
2405
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2409
class cmd_break_lock(Command):
2410
"""Break a dead lock on a repository, branch or working directory.
2412
CAUTION: Locks should only be broken when you are sure that the process
2413
holding the lock has been stopped.
2418
takes_args = ['location']
2419
takes_options = [Option('show',
2420
help="just show information on the lock, " \
2423
def run(self, location, show=False):
2424
raise NotImplementedError("sorry, break-lock is not complete yet; "
2425
"you can remove the 'held' directory manually to break the lock")
2428
# command-line interpretation helper for merge-related commands
2429
def merge(other_revision, base_revision,
2430
check_clean=True, ignore_zero=False,
2431
this_dir=None, backup_files=False, merge_type=Merge3Merger,
2432
file_list=None, show_base=False, reprocess=False,
2433
pb=DummyProgress()):
2434
"""Merge changes into a tree.
2437
list(path, revno) Base for three-way merge.
2438
If [None, None] then a base will be automatically determined.
2440
list(path, revno) Other revision for three-way merge.
2442
Directory to merge changes into; '.' by default.
2444
If true, this_dir must have no uncommitted changes before the
2446
ignore_zero - If true, suppress the "zero conflicts" message when
2447
there are no conflicts; should be set when doing something we expect
2448
to complete perfectly.
2449
file_list - If supplied, merge only changes to selected files.
2451
All available ancestors of other_revision and base_revision are
2452
automatically pulled into the branch.
2454
The revno may be -1 to indicate the last revision on the branch, which is
2457
This function is intended for use from the command line; programmatic
2458
clients might prefer to call merge.merge_inner(), which has less magic
2461
from bzrlib.merge import Merger
2462
if this_dir is None:
2464
this_tree = WorkingTree.open_containing(this_dir)[0]
2465
if show_base and not merge_type is Merge3Merger:
2466
raise BzrCommandError("Show-base is not supported for this merge"
2467
" type. %s" % merge_type)
2468
if reprocess and not merge_type.supports_reprocess:
2469
raise BzrCommandError("Conflict reduction is not supported for merge"
2470
" type %s." % merge_type)
2471
if reprocess and show_base:
2472
raise BzrCommandError("Cannot do conflict reduction and show base.")
2474
merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
2475
merger.pp = ProgressPhase("Merge phase", 5, pb)
2476
merger.pp.next_phase()
2477
merger.check_basis(check_clean)
2478
merger.set_other(other_revision)
2479
merger.pp.next_phase()
2480
merger.set_base(base_revision)
2481
if merger.base_rev_id == merger.other_rev_id:
2482
note('Nothing to do.')
2484
merger.backup_files = backup_files
2485
merger.merge_type = merge_type
2486
merger.set_interesting_files(file_list)
2487
merger.show_base = show_base
2488
merger.reprocess = reprocess
2489
conflicts = merger.do_merge()
2490
if file_list is None:
2491
merger.set_pending()
2497
# these get imported and then picked up by the scan for cmd_*
2498
# TODO: Some more consistent way to split command definitions across files;
2499
# we do need to load at least some information about them to know of
2500
# aliases. ideally we would avoid loading the implementation until the
2501
# details were needed.
2502
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2503
from bzrlib.sign_my_commits import cmd_sign_my_commits
2504
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
2505
cmd_weave_plan_merge, cmd_weave_merge_text