1
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
22
from shutil import rmtree
27
from bzrlib.branch import Branch
28
import bzrlib.bzrdir as bzrdir
29
from bzrlib.commands import Command, display_command
30
from bzrlib.revision import common_ancestor
31
import bzrlib.errors as errors
32
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError,
33
NotBranchError, DivergedBranches, NotConflicted,
34
NoSuchFile, NoWorkingTree, FileInWrongBranch,
36
from bzrlib.log import show_one_log
37
from bzrlib.merge import Merge3Merger
38
from bzrlib.option import Option
39
from bzrlib.progress import DummyProgress, ProgressPhase
40
from bzrlib.revisionspec import RevisionSpec
42
from bzrlib.trace import mutter, note, log_error, warning, is_quiet
43
from bzrlib.transport.local import LocalTransport
45
from bzrlib.workingtree import WorkingTree
48
def tree_files(file_list, default_branch=u'.'):
50
return internal_tree_files(file_list, default_branch)
51
except FileInWrongBranch, e:
52
raise BzrCommandError("%s is not in the same branch as %s" %
53
(e.path, file_list[0]))
56
# XXX: Bad function name; should possibly also be a class method of
57
# WorkingTree rather than a function.
58
def internal_tree_files(file_list, default_branch=u'.'):
59
"""Convert command-line paths to a WorkingTree and relative paths.
61
This is typically used for command-line processors that take one or
62
more filenames, and infer the workingtree that contains them.
64
The filenames given are not required to exist.
66
:param file_list: Filenames to convert.
68
:param default_branch: Fallback tree path to use if file_list is empty or None.
70
:return: workingtree, [relative_paths]
72
if file_list is None or len(file_list) == 0:
73
return WorkingTree.open_containing(default_branch)[0], file_list
74
tree = WorkingTree.open_containing(file_list[0])[0]
76
for filename in file_list:
78
new_list.append(tree.relpath(filename))
79
except errors.PathNotChild:
80
raise FileInWrongBranch(tree.branch, filename)
84
def get_format_type(typestring):
85
"""Parse and return a format specifier."""
86
if typestring == "weave":
87
return bzrdir.BzrDirFormat6()
88
if typestring == "metadir":
89
return bzrdir.BzrDirMetaFormat1()
90
if typestring == "knit":
91
format = bzrdir.BzrDirMetaFormat1()
92
format.repository_format = bzrlib.repository.RepositoryFormatKnit1()
94
msg = "No known bzr-dir format %s. Supported types are: weave, metadir\n" %\
96
raise BzrCommandError(msg)
99
# TODO: Make sure no commands unconditionally use the working directory as a
100
# branch. If a filename argument is used, the first of them should be used to
101
# specify the branch. (Perhaps this can be factored out into some kind of
102
# Argument class, representing a file in a branch, where the first occurrence
105
class cmd_status(Command):
106
"""Display status summary.
108
This reports on versioned and unknown files, reporting them
109
grouped by state. Possible states are:
112
Versioned in the working copy but not in the previous revision.
115
Versioned in the previous revision but removed or deleted
119
Path of this file changed from the previous revision;
120
the text may also have changed. This includes files whose
121
parent directory was renamed.
124
Text has changed since the previous revision.
127
Nothing about this file has changed since the previous revision.
128
Only shown with --all.
131
Not versioned and not matching an ignore pattern.
133
To see ignored files use 'bzr ignored'. For details in the
134
changes to file texts, use 'bzr diff'.
136
If no arguments are specified, the status of the entire working
137
directory is shown. Otherwise, only the status of the specified
138
files or directories is reported. If a directory is given, status
139
is reported for everything inside that directory.
141
If a revision argument is given, the status is calculated against
142
that revision, or between two revisions if two are provided.
145
# TODO: --no-recurse, --recurse options
147
takes_args = ['file*']
148
takes_options = ['all', 'show-ids', 'revision']
149
aliases = ['st', 'stat']
152
def run(self, all=False, show_ids=False, file_list=None, revision=None):
153
tree, file_list = tree_files(file_list)
155
from bzrlib.status import show_tree_status
156
show_tree_status(tree, show_unchanged=all, show_ids=show_ids,
157
specific_files=file_list, revision=revision)
160
class cmd_cat_revision(Command):
161
"""Write out metadata for a revision.
163
The revision to print can either be specified by a specific
164
revision identifier, or you can use --revision.
168
takes_args = ['revision_id?']
169
takes_options = ['revision']
172
def run(self, revision_id=None, revision=None):
174
if revision_id is not None and revision is not None:
175
raise BzrCommandError('You can only supply one of revision_id or --revision')
176
if revision_id is None and revision is None:
177
raise BzrCommandError('You must supply either --revision or a revision_id')
178
b = WorkingTree.open_containing(u'.')[0].branch
179
if revision_id is not None:
180
sys.stdout.write(b.repository.get_revision_xml(revision_id))
181
elif revision is not None:
184
raise BzrCommandError('You cannot specify a NULL revision.')
185
revno, rev_id = rev.in_history(b)
186
sys.stdout.write(b.repository.get_revision_xml(rev_id))
189
class cmd_revno(Command):
190
"""Show current revision number.
192
This is equal to the number of revisions on this branch."""
193
takes_args = ['location?']
195
def run(self, location=u'.'):
196
print Branch.open_containing(location)[0].revno()
199
class cmd_revision_info(Command):
200
"""Show revision number and revision id for a given revision identifier.
203
takes_args = ['revision_info*']
204
takes_options = ['revision']
206
def run(self, revision=None, revision_info_list=[]):
209
if revision is not None:
210
revs.extend(revision)
211
if revision_info_list is not None:
212
for rev in revision_info_list:
213
revs.append(RevisionSpec(rev))
215
raise BzrCommandError('You must supply a revision identifier')
217
b = WorkingTree.open_containing(u'.')[0].branch
220
revinfo = rev.in_history(b)
221
if revinfo.revno is None:
222
print ' %s' % revinfo.rev_id
224
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
227
class cmd_add(Command):
228
"""Add specified files or directories.
230
In non-recursive mode, all the named items are added, regardless
231
of whether they were previously ignored. A warning is given if
232
any of the named files are already versioned.
234
In recursive mode (the default), files are treated the same way
235
but the behaviour for directories is different. Directories that
236
are already versioned do not give a warning. All directories,
237
whether already versioned or not, are searched for files or
238
subdirectories that are neither versioned or ignored, and these
239
are added. This search proceeds recursively into versioned
240
directories. If no names are given '.' is assumed.
242
Therefore simply saying 'bzr add' will version all files that
243
are currently unknown.
245
Adding a file whose parent directory is not versioned will
246
implicitly add the parent, and so on up to the root. This means
247
you should never need to explictly add a directory, they'll just
248
get added when you add a file in the directory.
250
--dry-run will show which files would be added, but not actually
253
takes_args = ['file*']
254
takes_options = ['no-recurse', 'dry-run', 'verbose']
256
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False):
261
# This is pointless, but I'd rather not raise an error
262
action = bzrlib.add.add_action_null
264
action = bzrlib.add.add_action_print
266
action = bzrlib.add.add_action_add
268
action = bzrlib.add.add_action_add_and_print
270
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
273
for glob in sorted(ignored.keys()):
274
match_len = len(ignored[glob])
276
for path in ignored[glob]:
277
print "ignored %s matching \"%s\"" % (path, glob)
279
print "ignored %d file(s) matching \"%s\"" % (match_len,
281
print "If you wish to add some of these files, please add them"\
285
class cmd_mkdir(Command):
286
"""Create a new versioned directory.
288
This is equivalent to creating the directory and then adding it.
290
takes_args = ['dir+']
292
def run(self, dir_list):
295
wt, dd = WorkingTree.open_containing(d)
300
class cmd_relpath(Command):
301
"""Show path of a file relative to root"""
302
takes_args = ['filename']
306
def run(self, filename):
307
tree, relpath = WorkingTree.open_containing(filename)
311
class cmd_inventory(Command):
312
"""Show inventory of the current working copy or a revision.
314
It is possible to limit the output to a particular entry
315
type using the --kind option. For example; --kind file.
317
takes_options = ['revision', 'show-ids', 'kind']
320
def run(self, revision=None, show_ids=False, kind=None):
321
if kind and kind not in ['file', 'directory', 'symlink']:
322
raise BzrCommandError('invalid kind specified')
323
tree = WorkingTree.open_containing(u'.')[0]
325
inv = tree.read_working_inventory()
327
if len(revision) > 1:
328
raise BzrCommandError('bzr inventory --revision takes'
329
' exactly one revision identifier')
330
inv = tree.branch.repository.get_revision_inventory(
331
revision[0].in_history(tree.branch).rev_id)
333
for path, entry in inv.entries():
334
if kind and kind != entry.kind:
337
print '%-50s %s' % (path, entry.file_id)
342
class cmd_mv(Command):
343
"""Move or rename a file.
346
bzr mv OLDNAME NEWNAME
347
bzr mv SOURCE... DESTINATION
349
If the last argument is a versioned directory, all the other names
350
are moved into it. Otherwise, there must be exactly two arguments
351
and the file is changed to a new name, which must not already exist.
353
Files cannot be moved between branches.
355
takes_args = ['names*']
356
aliases = ['move', 'rename']
358
def run(self, names_list):
359
if len(names_list) < 2:
360
raise BzrCommandError("missing file argument")
361
tree, rel_names = tree_files(names_list)
363
if os.path.isdir(names_list[-1]):
364
# move into existing directory
365
for pair in tree.move(rel_names[:-1], rel_names[-1]):
366
print "%s => %s" % pair
368
if len(names_list) != 2:
369
raise BzrCommandError('to mv multiple files the destination '
370
'must be a versioned directory')
371
tree.rename_one(rel_names[0], rel_names[1])
372
print "%s => %s" % (rel_names[0], rel_names[1])
375
class cmd_pull(Command):
376
"""Turn this branch into a mirror of another branch.
378
This command only works on branches that have not diverged. Branches are
379
considered diverged if the destination branch's most recent commit is one
380
that has not been merged (directly or indirectly) into the parent.
382
If branches have diverged, you can use 'bzr merge' to integrate the changes
383
from one into the other. Once one branch has merged, the other should
384
be able to pull it again.
386
If branches have diverged, you can use 'bzr merge' to pull the text changes
387
from one into the other. Once one branch has merged, the other should
388
be able to pull it again.
390
If you want to forget your local changes and just update your branch to
391
match the remote one, use pull --overwrite.
393
If there is no default location set, the first pull will set it. After
394
that, you can omit the location to use the default. To change the
395
default, use --remember.
397
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
398
takes_args = ['location?']
400
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
401
# FIXME: too much stuff is in the command class
403
tree_to = WorkingTree.open_containing(u'.')[0]
404
branch_to = tree_to.branch
405
except NoWorkingTree:
407
branch_to = Branch.open_containing(u'.')[0]
408
stored_loc = branch_to.get_parent()
410
if stored_loc is None:
411
raise BzrCommandError("No pull location known or specified.")
413
print "Using saved location: %s" % stored_loc
414
location = stored_loc
416
if branch_to.get_parent() is None or remember:
417
branch_to.set_parent(location)
419
branch_from = Branch.open(location)
423
elif len(revision) == 1:
424
rev_id = revision[0].in_history(branch_from).rev_id
426
raise BzrCommandError('bzr pull --revision takes one value.')
428
old_rh = branch_to.revision_history()
429
if tree_to is not None:
430
count = tree_to.pull(branch_from, overwrite, rev_id)
432
count = branch_to.pull(branch_from, overwrite, rev_id)
433
note('%d revision(s) pulled.' % (count,))
436
new_rh = branch_to.revision_history()
439
from bzrlib.log import show_changed_revisions
440
show_changed_revisions(branch_to, old_rh, new_rh)
443
class cmd_push(Command):
444
"""Update a mirror of this branch.
446
The target branch will not have its working tree populated because this
447
is both expensive, and is not supported on remote file systems.
449
Some smart servers or protocols *may* put the working tree in place in
452
This command only works on branches that have not diverged. Branches are
453
considered diverged if the destination branch's most recent commit is one
454
that has not been merged (directly or indirectly) by the source branch.
456
If branches have diverged, you can use 'bzr push --overwrite' to replace
457
the other branch completely, discarding its unmerged changes.
459
If you want to ensure you have the different changes in the other branch,
460
do a merge (see bzr help merge) from the other branch, and commit that.
461
After that you will be able to do a push without '--overwrite'.
463
If there is no default push location set, the first push will set it.
464
After that, you can omit the location to use the default. To change the
465
default, use --remember.
467
takes_options = ['remember', 'overwrite',
468
Option('create-prefix',
469
help='Create the path leading up to the branch '
470
'if it does not already exist')]
471
takes_args = ['location?']
473
def run(self, location=None, remember=False, overwrite=False,
474
create_prefix=False, verbose=False):
475
# FIXME: Way too big! Put this into a function called from the
477
from bzrlib.transport import get_transport
479
br_from = Branch.open_containing('.')[0]
480
stored_loc = br_from.get_push_location()
482
if stored_loc is None:
483
raise BzrCommandError("No push location known or specified.")
485
print "Using saved location: %s" % stored_loc
486
location = stored_loc
487
if br_from.get_push_location() is None or remember:
488
br_from.set_push_location(location)
490
dir_to = bzrlib.bzrdir.BzrDir.open(location)
491
br_to = dir_to.open_branch()
492
except NotBranchError:
494
transport = get_transport(location).clone('..')
495
if not create_prefix:
497
transport.mkdir(transport.relpath(location))
499
raise BzrCommandError("Parent directory of %s "
500
"does not exist." % location)
502
current = transport.base
503
needed = [(transport, transport.relpath(location))]
506
transport, relpath = needed[-1]
507
transport.mkdir(relpath)
510
new_transport = transport.clone('..')
511
needed.append((new_transport,
512
new_transport.relpath(transport.base)))
513
if new_transport.base == transport.base:
514
raise BzrCommandError("Could not create "
516
dir_to = br_from.bzrdir.clone(location)
517
br_to = dir_to.open_branch()
518
old_rh = br_to.revision_history()
521
tree_to = dir_to.open_workingtree()
522
except errors.NotLocalUrl:
523
# TODO: This should be updated for branches which don't have a
524
# working tree, as opposed to ones where we just couldn't
526
warning('This transport does not update the working '
527
'tree of: %s' % (br_to.base,))
528
count = br_to.pull(br_from, overwrite)
529
except NoWorkingTree:
530
count = br_to.pull(br_from, overwrite)
532
count = tree_to.pull(br_from, overwrite)
533
except DivergedBranches:
534
raise BzrCommandError("These branches have diverged."
535
" Try a merge then push with overwrite.")
536
note('%d revision(s) pushed.' % (count,))
539
new_rh = br_to.revision_history()
542
from bzrlib.log import show_changed_revisions
543
show_changed_revisions(br_to, old_rh, new_rh)
546
class cmd_branch(Command):
547
"""Create a new copy of a branch.
549
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
550
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
552
To retrieve the branch as of a particular revision, supply the --revision
553
parameter, as in "branch foo/bar -r 5".
555
--basis is to speed up branching from remote branches. When specified, it
556
copies all the file-contents, inventory and revision data from the basis
557
branch before copying anything from the remote branch.
559
takes_args = ['from_location', 'to_location?']
560
takes_options = ['revision', 'basis']
561
aliases = ['get', 'clone']
563
def run(self, from_location, to_location=None, revision=None, basis=None):
566
elif len(revision) > 1:
567
raise BzrCommandError(
568
'bzr branch --revision takes exactly 1 revision value')
570
br_from = Branch.open(from_location)
572
if e.errno == errno.ENOENT:
573
raise BzrCommandError('Source location "%s" does not'
574
' exist.' % to_location)
579
if basis is not None:
580
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
583
if len(revision) == 1 and revision[0] is not None:
584
revision_id = revision[0].in_history(br_from)[1]
586
# FIXME - wt.last_revision, fallback to branch, fall back to
587
# None or perhaps NULL_REVISION to mean copy nothing
589
revision_id = br_from.last_revision()
590
if to_location is None:
591
to_location = os.path.basename(from_location.rstrip("/\\"))
594
name = os.path.basename(to_location) + '\n'
596
os.mkdir(to_location)
598
if e.errno == errno.EEXIST:
599
raise BzrCommandError('Target directory "%s" already'
600
' exists.' % to_location)
601
if e.errno == errno.ENOENT:
602
raise BzrCommandError('Parent of "%s" does not exist.' %
607
# preserve whatever source format we have.
608
dir = br_from.bzrdir.sprout(to_location, revision_id, basis_dir)
609
branch = dir.open_branch()
610
except bzrlib.errors.NoSuchRevision:
612
msg = "The branch %s has no revision %s." % (from_location, revision[0])
613
raise BzrCommandError(msg)
614
except bzrlib.errors.UnlistableBranch:
616
msg = "The branch %s cannot be used as a --basis" % (basis,)
617
raise BzrCommandError(msg)
619
branch.control_files.put_utf8('branch-name', name)
621
note('Branched %d revision(s).' % branch.revno())
626
class cmd_checkout(Command):
627
"""Create a new checkout of an existing branch.
629
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
630
the branch found in '.'. This is useful if you have removed the working tree
631
or if it was never created - i.e. if you pushed the branch to its current
634
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
635
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
637
To retrieve the branch as of a particular revision, supply the --revision
638
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
639
out of date [so you cannot commit] but it may be useful (i.e. to examine old
642
--basis is to speed up checking out from remote branches. When specified, it
643
uses the inventory and file contents from the basis branch in preference to the
644
branch being checked out.
646
takes_args = ['branch_location?', 'to_location?']
647
takes_options = ['revision', # , 'basis']
648
Option('lightweight',
649
help="perform a lightweight checkout. Lightweight "
650
"checkouts depend on access to the branch for "
651
"every operation. Normal checkouts can perform "
652
"common operations like diff and status without "
653
"such access, and also support local commits."
657
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
661
elif len(revision) > 1:
662
raise BzrCommandError(
663
'bzr checkout --revision takes exactly 1 revision value')
664
if branch_location is None:
665
branch_location = bzrlib.osutils.getcwd()
666
to_location = branch_location
667
source = Branch.open(branch_location)
668
if len(revision) == 1 and revision[0] is not None:
669
revision_id = revision[0].in_history(source)[1]
672
if to_location is None:
673
to_location = os.path.basename(branch_location.rstrip("/\\"))
674
# if the source and to_location are the same,
675
# and there is no working tree,
676
# then reconstitute a branch
677
if (bzrlib.osutils.abspath(to_location) ==
678
bzrlib.osutils.abspath(branch_location)):
680
source.bzrdir.open_workingtree()
681
except errors.NoWorkingTree:
682
source.bzrdir.create_workingtree()
685
os.mkdir(to_location)
687
if e.errno == errno.EEXIST:
688
raise BzrCommandError('Target directory "%s" already'
689
' exists.' % to_location)
690
if e.errno == errno.ENOENT:
691
raise BzrCommandError('Parent of "%s" does not exist.' %
695
old_format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
696
bzrlib.bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
699
checkout = bzrdir.BzrDirMetaFormat1().initialize(to_location)
700
bzrlib.branch.BranchReferenceFormat().initialize(checkout, source)
702
checkout_branch = bzrlib.bzrdir.BzrDir.create_branch_convenience(
703
to_location, force_new_tree=False)
704
checkout = checkout_branch.bzrdir
705
checkout_branch.bind(source)
706
if revision_id is not None:
707
rh = checkout_branch.revision_history()
708
checkout_branch.set_revision_history(rh[:rh.index(revision_id) + 1])
709
checkout.create_workingtree(revision_id)
711
bzrlib.bzrdir.BzrDirFormat.set_default_format(old_format)
714
class cmd_renames(Command):
715
"""Show list of renamed files.
717
# TODO: Option to show renames between two historical versions.
719
# TODO: Only show renames under dir, rather than in the whole branch.
720
takes_args = ['dir?']
723
def run(self, dir=u'.'):
724
tree = WorkingTree.open_containing(dir)[0]
725
old_inv = tree.basis_tree().inventory
726
new_inv = tree.read_working_inventory()
728
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
730
for old_name, new_name in renames:
731
print "%s => %s" % (old_name, new_name)
734
class cmd_update(Command):
735
"""Update a tree to have the latest code committed to its branch.
737
This will perform a merge into the working tree, and may generate
738
conflicts. If you have any local changes, you will still
739
need to commit them after the update for the update to be complete.
741
If you want to discard your local changes, you can just do a
742
'bzr revert' instead of 'bzr commit' after the update.
744
takes_args = ['dir?']
746
def run(self, dir='.'):
747
tree = WorkingTree.open_containing(dir)[0]
750
if tree.last_revision() == tree.branch.last_revision():
751
# may be up to date, check master too.
752
master = tree.branch.get_master_branch()
753
if master is None or master.last_revision == tree.last_revision():
754
note("Tree is up to date.")
756
conflicts = tree.update()
757
note('Updated to revision %d.' %
758
(tree.branch.revision_id_to_revno(tree.last_revision()),))
767
class cmd_info(Command):
768
"""Show statistical information about a branch."""
769
takes_args = ['branch?']
770
takes_options = ['verbose']
773
def run(self, branch=None, verbose=False):
775
bzrlib.info.show_bzrdir_info(bzrdir.BzrDir.open_containing(branch)[0],
779
class cmd_remove(Command):
780
"""Make a file unversioned.
782
This makes bzr stop tracking changes to a versioned file. It does
783
not delete the working copy.
785
takes_args = ['file+']
786
takes_options = ['verbose']
789
def run(self, file_list, verbose=False):
790
tree, file_list = tree_files(file_list)
791
tree.remove(file_list, verbose=verbose)
794
class cmd_file_id(Command):
795
"""Print file_id of a particular file or directory.
797
The file_id is assigned when the file is first added and remains the
798
same through all revisions where the file exists, even when it is
802
takes_args = ['filename']
804
def run(self, filename):
805
tree, relpath = WorkingTree.open_containing(filename)
806
i = tree.inventory.path2id(relpath)
808
raise BzrError("%r is not a versioned file" % filename)
813
class cmd_file_path(Command):
814
"""Print path of file_ids to a file or directory.
816
This prints one line for each directory down to the target,
817
starting at the branch root."""
819
takes_args = ['filename']
821
def run(self, filename):
822
tree, relpath = WorkingTree.open_containing(filename)
824
fid = inv.path2id(relpath)
826
raise BzrError("%r is not a versioned file" % filename)
827
for fip in inv.get_idpath(fid):
831
class cmd_reconcile(Command):
832
"""Reconcile bzr metadata in a branch.
834
This can correct data mismatches that may have been caused by
835
previous ghost operations or bzr upgrades. You should only
836
need to run this command if 'bzr check' or a bzr developer
837
advises you to run it.
839
If a second branch is provided, cross-branch reconciliation is
840
also attempted, which will check that data like the tree root
841
id which was not present in very early bzr versions is represented
842
correctly in both branches.
844
At the same time it is run it may recompress data resulting in
845
a potential saving in disk space or performance gain.
847
The branch *MUST* be on a listable system such as local disk or sftp.
849
takes_args = ['branch?']
851
def run(self, branch="."):
852
from bzrlib.reconcile import reconcile
853
dir = bzrlib.bzrdir.BzrDir.open(branch)
857
class cmd_revision_history(Command):
858
"""Display list of revision ids on this branch."""
862
branch = WorkingTree.open_containing(u'.')[0].branch
863
for patchid in branch.revision_history():
867
class cmd_ancestry(Command):
868
"""List all revisions merged into this branch."""
872
tree = WorkingTree.open_containing(u'.')[0]
874
# FIXME. should be tree.last_revision
875
for revision_id in b.repository.get_ancestry(b.last_revision()):
879
class cmd_init(Command):
880
"""Make a directory into a versioned branch.
882
Use this to create an empty branch, or before importing an
885
If there is a repository in a parent directory of the location, then
886
the history of the branch will be stored in the repository. Otherwise
887
init creates a standalone branch which carries its own history in
890
If there is already a branch at the location but it has no working tree,
891
the tree can be populated with 'bzr checkout'.
893
Recipe for importing a tree of files:
898
bzr commit -m 'imported project'
900
takes_args = ['location?']
903
help='Create a specific format rather than the'
904
' current default format. Currently supports:'
905
' metadir, knit, and weave',
906
type=get_format_type),
908
def run(self, location=None, format=None):
909
from bzrlib.branch import Branch
913
# The path has to exist to initialize a
914
# branch inside of it.
915
# Just using os.mkdir, since I don't
916
# believe that we want to create a bunch of
917
# locations if the user supplies an extended path
918
if not os.path.exists(location):
921
existing_bzrdir = bzrdir.BzrDir.open(location)
922
except NotBranchError:
923
# really a NotBzrDir error...
924
bzrdir.BzrDir.create_branch_convenience(location, format=format)
926
if existing_bzrdir.has_branch():
927
if existing_bzrdir.has_workingtree():
928
raise errors.AlreadyBranchError(location)
930
raise errors.BranchExistsWithoutWorkingTree(location)
932
existing_bzrdir.create_branch()
933
existing_bzrdir.create_workingtree()
936
class cmd_init_repository(Command):
937
"""Create a shared repository to hold branches.
939
New branches created under the repository directory will store their revisions
940
in the repository, not in the branch directory, if the branch format supports
946
bzr checkout --lightweight repo/trunk trunk-checkout
950
takes_args = ["location"]
951
takes_options = [Option('format',
952
help='Use a specific format rather than the'
953
' current default format. Currently this'
954
' option accepts "weave", "metadir" and "knit"',
955
type=get_format_type),
957
help='Allows branches in repository to have'
959
aliases = ["init-repo"]
960
def run(self, location, format=None, trees=False):
961
from bzrlib.bzrdir import BzrDirMetaFormat1
962
from bzrlib.transport import get_transport
964
format = BzrDirMetaFormat1()
965
transport = get_transport(location)
966
if not transport.has('.'):
968
newdir = format.initialize_on_transport(transport)
969
repo = newdir.create_repository(shared=True)
970
repo.set_make_working_trees(trees)
973
class cmd_diff(Command):
974
"""Show differences in working tree.
976
If files are listed, only the changes in those files are listed.
977
Otherwise, all changes for the tree are listed.
979
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
980
produces patches suitable for "patch -p1".
986
bzr diff --diff-prefix old/:new/
988
# TODO: Option to use external diff command; could be GNU diff, wdiff,
989
# or a graphical diff.
991
# TODO: Python difflib is not exactly the same as unidiff; should
992
# either fix it up or prefer to use an external diff.
994
# TODO: Selected-file diff is inefficient and doesn't show you
997
# TODO: This probably handles non-Unix newlines poorly.
999
# TODO: When a prefix is given, it's also shown in the summary lines, e.g.
1000
# "modified file new/foo.c"; perhaps it would be better to omit it from
1003
takes_args = ['file*']
1004
takes_options = ['revision', 'diff-options', 'prefix']
1005
aliases = ['di', 'dif']
1008
def run(self, revision=None, file_list=None, diff_options=None,
1010
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1012
if (prefix is None) or (prefix == '0'):
1020
if not ':' in prefix:
1021
raise BzrError("--diff-prefix expects two values separated by a colon")
1022
old_label, new_label = prefix.split(":")
1025
tree1, file_list = internal_tree_files(file_list)
1029
except FileInWrongBranch:
1030
if len(file_list) != 2:
1031
raise BzrCommandError("Files are in different branches")
1033
tree1, file1 = WorkingTree.open_containing(file_list[0])
1034
tree2, file2 = WorkingTree.open_containing(file_list[1])
1035
if file1 != "" or file2 != "":
1036
# FIXME diff those two files. rbc 20051123
1037
raise BzrCommandError("Files are in different branches")
1039
if revision is not None:
1040
if tree2 is not None:
1041
raise BzrCommandError("Can't specify -r with two branches")
1042
if (len(revision) == 1) or (revision[1].spec is None):
1043
return diff_cmd_helper(tree1, file_list, diff_options,
1045
old_label=old_label, new_label=new_label)
1046
elif len(revision) == 2:
1047
return diff_cmd_helper(tree1, file_list, diff_options,
1048
revision[0], revision[1],
1049
old_label=old_label, new_label=new_label)
1051
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
1053
if tree2 is not None:
1054
return show_diff_trees(tree1, tree2, sys.stdout,
1055
specific_files=file_list,
1056
external_diff_options=diff_options,
1057
old_label=old_label, new_label=new_label)
1059
return diff_cmd_helper(tree1, file_list, diff_options,
1060
old_label=old_label, new_label=new_label)
1063
class cmd_deleted(Command):
1064
"""List files deleted in the working tree.
1066
# TODO: Show files deleted since a previous revision, or
1067
# between two revisions.
1068
# TODO: Much more efficient way to do this: read in new
1069
# directories with readdir, rather than stating each one. Same
1070
# level of effort but possibly much less IO. (Or possibly not,
1071
# if the directories are very large...)
1073
def run(self, show_ids=False):
1074
tree = WorkingTree.open_containing(u'.')[0]
1075
old = tree.basis_tree()
1076
for path, ie in old.inventory.iter_entries():
1077
if not tree.has_id(ie.file_id):
1079
print '%-50s %s' % (path, ie.file_id)
1084
class cmd_modified(Command):
1085
"""List files modified in working tree."""
1089
from bzrlib.delta import compare_trees
1091
tree = WorkingTree.open_containing(u'.')[0]
1092
td = compare_trees(tree.basis_tree(), tree)
1094
for path, id, kind, text_modified, meta_modified in td.modified:
1099
class cmd_added(Command):
1100
"""List files added in working tree."""
1104
wt = WorkingTree.open_containing(u'.')[0]
1105
basis_inv = wt.basis_tree().inventory
1108
if file_id in basis_inv:
1110
path = inv.id2path(file_id)
1111
if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
1117
class cmd_root(Command):
1118
"""Show the tree root directory.
1120
The root is the nearest enclosing directory with a .bzr control
1122
takes_args = ['filename?']
1124
def run(self, filename=None):
1125
"""Print the branch root."""
1126
tree = WorkingTree.open_containing(filename)[0]
1130
class cmd_log(Command):
1131
"""Show log of a branch, file, or directory.
1133
By default show the log of the branch containing the working directory.
1135
To request a range of logs, you can use the command -r begin..end
1136
-r revision requests a specific revision, -r ..end or -r begin.. are
1142
bzr log -r -10.. http://server/branch
1145
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1147
takes_args = ['location?']
1148
takes_options = [Option('forward',
1149
help='show from oldest to newest'),
1152
help='show files changed in each revision'),
1153
'show-ids', 'revision',
1157
help='show revisions whose message matches this regexp',
1162
def run(self, location=None, timezone='original',
1172
from bzrlib.log import log_formatter, show_log
1174
assert message is None or isinstance(message, basestring), \
1175
"invalid message argument %r" % message
1176
direction = (forward and 'forward') or 'reverse'
1181
# find the file id to log:
1183
dir, fp = bzrdir.BzrDir.open_containing(location)
1184
b = dir.open_branch()
1188
inv = dir.open_workingtree().inventory
1189
except (errors.NotBranchError, errors.NotLocalUrl):
1190
# either no tree, or is remote.
1191
inv = b.basis_tree().inventory
1192
file_id = inv.path2id(fp)
1195
# FIXME ? log the current subdir only RBC 20060203
1196
dir, relpath = bzrdir.BzrDir.open_containing('.')
1197
b = dir.open_branch()
1199
if revision is None:
1202
elif len(revision) == 1:
1203
rev1 = rev2 = revision[0].in_history(b).revno
1204
elif len(revision) == 2:
1205
if revision[0].spec is None:
1206
# missing begin-range means first revision
1209
rev1 = revision[0].in_history(b).revno
1211
if revision[1].spec is None:
1212
# missing end-range means last known revision
1215
rev2 = revision[1].in_history(b).revno
1217
raise BzrCommandError('bzr log --revision takes one or two values.')
1219
# By this point, the revision numbers are converted to the +ve
1220
# form if they were supplied in the -ve form, so we can do
1221
# this comparison in relative safety
1223
(rev2, rev1) = (rev1, rev2)
1225
mutter('encoding log as %r', bzrlib.user_encoding)
1227
# use 'replace' so that we don't abort if trying to write out
1228
# in e.g. the default C locale.
1229
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1231
if (log_format == None):
1232
default = bzrlib.config.BranchConfig(b).log_format()
1233
log_format = get_log_format(long=long, short=short, line=line, default=default)
1235
lf = log_formatter(log_format,
1238
show_timezone=timezone)
1244
direction=direction,
1245
start_revision=rev1,
1250
def get_log_format(long=False, short=False, line=False, default='long'):
1251
log_format = default
1255
log_format = 'short'
1261
class cmd_touching_revisions(Command):
1262
"""Return revision-ids which affected a particular file.
1264
A more user-friendly interface is "bzr log FILE"."""
1266
takes_args = ["filename"]
1268
def run(self, filename):
1269
tree, relpath = WorkingTree.open_containing(filename)
1271
inv = tree.read_working_inventory()
1272
file_id = inv.path2id(relpath)
1273
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1274
print "%6d %s" % (revno, what)
1277
class cmd_ls(Command):
1278
"""List files in a tree.
1280
# TODO: Take a revision or remote path and list that tree instead.
1282
takes_options = ['verbose', 'revision',
1283
Option('non-recursive',
1284
help='don\'t recurse into sub-directories'),
1286
help='Print all paths from the root of the branch.'),
1287
Option('unknown', help='Print unknown files'),
1288
Option('versioned', help='Print versioned files'),
1289
Option('ignored', help='Print ignored files'),
1291
Option('null', help='Null separate the files'),
1294
def run(self, revision=None, verbose=False,
1295
non_recursive=False, from_root=False,
1296
unknown=False, versioned=False, ignored=False,
1299
if verbose and null:
1300
raise BzrCommandError('Cannot set both --verbose and --null')
1301
all = not (unknown or versioned or ignored)
1303
selection = {'I':ignored, '?':unknown, 'V':versioned}
1305
tree, relpath = WorkingTree.open_containing(u'.')
1310
if revision is not None:
1311
tree = tree.branch.repository.revision_tree(
1312
revision[0].in_history(tree.branch).rev_id)
1313
for fp, fc, kind, fid, entry in tree.list_files():
1314
if fp.startswith(relpath):
1315
fp = fp[len(relpath):]
1316
if non_recursive and '/' in fp:
1318
if not all and not selection[fc]:
1321
kindch = entry.kind_character()
1322
print '%-8s %s%s' % (fc, fp, kindch)
1324
sys.stdout.write(fp)
1325
sys.stdout.write('\0')
1331
class cmd_unknowns(Command):
1332
"""List unknown files."""
1335
from bzrlib.osutils import quotefn
1336
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1340
class cmd_ignore(Command):
1341
"""Ignore a command or pattern.
1343
To remove patterns from the ignore list, edit the .bzrignore file.
1345
If the pattern contains a slash, it is compared to the whole path
1346
from the branch root. Otherwise, it is compared to only the last
1347
component of the path. To match a file only in the root directory,
1350
Ignore patterns are case-insensitive on case-insensitive systems.
1352
Note: wildcards must be quoted from the shell on Unix.
1355
bzr ignore ./Makefile
1356
bzr ignore '*.class'
1358
# TODO: Complain if the filename is absolute
1359
takes_args = ['name_pattern']
1361
def run(self, name_pattern):
1362
from bzrlib.atomicfile import AtomicFile
1365
tree, relpath = WorkingTree.open_containing(u'.')
1366
ifn = tree.abspath('.bzrignore')
1368
if os.path.exists(ifn):
1371
igns = f.read().decode('utf-8')
1377
# TODO: If the file already uses crlf-style termination, maybe
1378
# we should use that for the newly added lines?
1380
if igns and igns[-1] != '\n':
1382
igns += name_pattern + '\n'
1385
f = AtomicFile(ifn, 'wt')
1386
f.write(igns.encode('utf-8'))
1391
inv = tree.inventory
1392
if inv.path2id('.bzrignore'):
1393
mutter('.bzrignore is already versioned')
1395
mutter('need to make new .bzrignore file versioned')
1396
tree.add(['.bzrignore'])
1399
class cmd_ignored(Command):
1400
"""List ignored files and the patterns that matched them.
1402
See also: bzr ignore"""
1405
tree = WorkingTree.open_containing(u'.')[0]
1406
for path, file_class, kind, file_id, entry in tree.list_files():
1407
if file_class != 'I':
1409
## XXX: Slightly inefficient since this was already calculated
1410
pat = tree.is_ignored(path)
1411
print '%-50s %s' % (path, pat)
1414
class cmd_lookup_revision(Command):
1415
"""Lookup the revision-id from a revision-number
1418
bzr lookup-revision 33
1421
takes_args = ['revno']
1424
def run(self, revno):
1428
raise BzrCommandError("not a valid revision-number: %r" % revno)
1430
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1433
class cmd_export(Command):
1434
"""Export past revision to destination directory.
1436
If no revision is specified this exports the last committed revision.
1438
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1439
given, try to find the format with the extension. If no extension
1440
is found exports to a directory (equivalent to --format=dir).
1442
Root may be the top directory for tar, tgz and tbz2 formats. If none
1443
is given, the top directory will be the root name of the file.
1445
Note: export of tree with non-ascii filenames to zip is not supported.
1447
Supported formats Autodetected by extension
1448
----------------- -------------------------
1451
tbz2 .tar.bz2, .tbz2
1455
takes_args = ['dest']
1456
takes_options = ['revision', 'format', 'root']
1457
def run(self, dest, revision=None, format=None, root=None):
1459
from bzrlib.export import export
1460
tree = WorkingTree.open_containing(u'.')[0]
1462
if revision is None:
1463
# should be tree.last_revision FIXME
1464
rev_id = b.last_revision()
1466
if len(revision) != 1:
1467
raise BzrError('bzr export --revision takes exactly 1 argument')
1468
rev_id = revision[0].in_history(b).rev_id
1469
t = b.repository.revision_tree(rev_id)
1471
export(t, dest, format, root)
1472
except errors.NoSuchExportFormat, e:
1473
raise BzrCommandError('Unsupported export format: %s' % e.format)
1476
class cmd_cat(Command):
1477
"""Write a file's text from a previous revision."""
1479
takes_options = ['revision']
1480
takes_args = ['filename']
1483
def run(self, filename, revision=None):
1484
if revision is not None and len(revision) != 1:
1485
raise BzrCommandError("bzr cat --revision takes exactly one number")
1488
tree, relpath = WorkingTree.open_containing(filename)
1490
except NotBranchError:
1494
b, relpath = Branch.open_containing(filename)
1495
if revision is None:
1496
revision_id = b.last_revision()
1498
revision_id = revision[0].in_history(b).rev_id
1499
b.print_file(relpath, revision_id)
1502
class cmd_local_time_offset(Command):
1503
"""Show the offset in seconds from GMT to local time."""
1507
print bzrlib.osutils.local_time_offset()
1511
class cmd_commit(Command):
1512
"""Commit changes into a new revision.
1514
If no arguments are given, the entire tree is committed.
1516
If selected files are specified, only changes to those files are
1517
committed. If a directory is specified then the directory and everything
1518
within it is committed.
1520
A selected-file commit may fail in some cases where the committed
1521
tree would be invalid, such as trying to commit a file in a
1522
newly-added directory that is not itself committed.
1524
# TODO: Run hooks on tree to-be-committed, and after commit.
1526
# TODO: Strict commit that fails if there are deleted files.
1527
# (what does "deleted files" mean ??)
1529
# TODO: Give better message for -s, --summary, used by tla people
1531
# XXX: verbose currently does nothing
1533
takes_args = ['selected*']
1534
takes_options = ['message', 'verbose',
1536
help='commit even if nothing has changed'),
1537
Option('file', type=str,
1539
help='file containing commit message'),
1541
help="refuse to commit if there are unknown "
1542
"files in the working tree."),
1544
help="perform a local only commit in a bound "
1545
"branch. Such commits are not pushed to "
1546
"the master branch until a normal commit "
1550
aliases = ['ci', 'checkin']
1552
def run(self, message=None, file=None, verbose=True, selected_list=None,
1553
unchanged=False, strict=False, local=False):
1554
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1555
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1557
from bzrlib.msgeditor import edit_commit_message, \
1558
make_commit_message_template
1559
from tempfile import TemporaryFile
1562
# TODO: Need a blackbox test for invoking the external editor; may be
1563
# slightly problematic to run this cross-platform.
1565
# TODO: do more checks that the commit will succeed before
1566
# spending the user's valuable time typing a commit message.
1568
# TODO: if the commit *does* happen to fail, then save the commit
1569
# message to a temporary file where it can be recovered
1570
tree, selected_list = tree_files(selected_list)
1571
if local and not tree.branch.get_bound_location():
1572
raise errors.LocalRequiresBoundBranch()
1573
if message is None and not file:
1574
template = make_commit_message_template(tree, selected_list)
1575
message = edit_commit_message(template)
1577
raise BzrCommandError("please specify a commit message"
1578
" with either --message or --file")
1579
elif message and file:
1580
raise BzrCommandError("please specify either --message or --file")
1584
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1587
raise BzrCommandError("empty commit message specified")
1590
reporter = ReportCommitToLog()
1592
reporter = NullCommitReporter()
1595
tree.commit(message, specific_files=selected_list,
1596
allow_pointless=unchanged, strict=strict, local=local,
1598
except PointlessCommit:
1599
# FIXME: This should really happen before the file is read in;
1600
# perhaps prepare the commit; get the message; then actually commit
1601
raise BzrCommandError("no changes to commit",
1602
["use --unchanged to commit anyhow"])
1603
except ConflictsInTree:
1604
raise BzrCommandError("Conflicts detected in working tree. "
1605
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1606
except StrictCommitFailed:
1607
raise BzrCommandError("Commit refused because there are unknown "
1608
"files in the working tree.")
1609
except errors.BoundBranchOutOfDate, e:
1610
raise BzrCommandError(str(e)
1611
+ ' Either unbind, update, or'
1612
' pass --local to commit.')
1615
class cmd_check(Command):
1616
"""Validate consistency of branch history.
1618
This command checks various invariants about the branch storage to
1619
detect data corruption or bzr bugs.
1621
takes_args = ['branch?']
1622
takes_options = ['verbose']
1624
def run(self, branch=None, verbose=False):
1625
from bzrlib.check import check
1627
tree = WorkingTree.open_containing()[0]
1628
branch = tree.branch
1630
branch = Branch.open(branch)
1631
check(branch, verbose)
1634
class cmd_scan_cache(Command):
1637
from bzrlib.hashcache import HashCache
1643
print '%6d stats' % c.stat_count
1644
print '%6d in hashcache' % len(c._cache)
1645
print '%6d files removed from cache' % c.removed_count
1646
print '%6d hashes updated' % c.update_count
1647
print '%6d files changed too recently to cache' % c.danger_count
1653
class cmd_upgrade(Command):
1654
"""Upgrade branch storage to current format.
1656
The check command or bzr developers may sometimes advise you to run
1657
this command. When the default format has changed you may also be warned
1658
during other operations to upgrade.
1660
takes_args = ['url?']
1663
help='Upgrade to a specific format rather than the'
1664
' current default format. Currently this'
1665
' option accepts "weave", "metadir" and'
1667
type=get_format_type),
1671
def run(self, url='.', format=None):
1672
from bzrlib.upgrade import upgrade
1673
upgrade(url, format)
1676
class cmd_whoami(Command):
1677
"""Show bzr user id."""
1678
takes_options = ['email']
1681
def run(self, email=False):
1683
b = WorkingTree.open_containing(u'.')[0].branch
1684
config = bzrlib.config.BranchConfig(b)
1685
except NotBranchError:
1686
config = bzrlib.config.GlobalConfig()
1689
print config.user_email()
1691
print config.username()
1694
class cmd_nick(Command):
1695
"""Print or set the branch nickname.
1697
If unset, the tree root directory name is used as the nickname
1698
To print the current nickname, execute with no argument.
1700
takes_args = ['nickname?']
1701
def run(self, nickname=None):
1702
branch = Branch.open_containing(u'.')[0]
1703
if nickname is None:
1704
self.printme(branch)
1706
branch.nick = nickname
1709
def printme(self, branch):
1713
class cmd_selftest(Command):
1714
"""Run internal test suite.
1716
This creates temporary test directories in the working directory,
1717
but not existing data is affected. These directories are deleted
1718
if the tests pass, or left behind to help in debugging if they
1719
fail and --keep-output is specified.
1721
If arguments are given, they are regular expressions that say
1722
which tests should run.
1724
If the global option '--no-plugins' is given, plugins are not loaded
1725
before running the selftests. This has two effects: features provided or
1726
modified by plugins will not be tested, and tests provided by plugins will
1731
bzr --no-plugins selftest -v
1733
# TODO: --list should give a list of all available tests
1735
# NB: this is used from the class without creating an instance, which is
1736
# why it does not have a self parameter.
1737
def get_transport_type(typestring):
1738
"""Parse and return a transport specifier."""
1739
if typestring == "sftp":
1740
from bzrlib.transport.sftp import SFTPAbsoluteServer
1741
return SFTPAbsoluteServer
1742
if typestring == "memory":
1743
from bzrlib.transport.memory import MemoryServer
1745
if typestring == "fakenfs":
1746
from bzrlib.transport.fakenfs import FakeNFSServer
1747
return FakeNFSServer
1748
msg = "No known transport type %s. Supported types are: sftp\n" %\
1750
raise BzrCommandError(msg)
1753
takes_args = ['testspecs*']
1754
takes_options = ['verbose',
1755
Option('one', help='stop when one test fails'),
1756
Option('keep-output',
1757
help='keep output directories when tests fail'),
1759
help='Use a different transport by default '
1760
'throughout the test suite.',
1761
type=get_transport_type),
1764
def run(self, testspecs_list=None, verbose=False, one=False,
1765
keep_output=False, transport=None):
1767
from bzrlib.tests import selftest
1768
# we don't want progress meters from the tests to go to the
1769
# real output; and we don't want log messages cluttering up
1771
save_ui = bzrlib.ui.ui_factory
1772
bzrlib.trace.info('running tests...')
1774
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1775
if testspecs_list is not None:
1776
pattern = '|'.join(testspecs_list)
1779
result = selftest(verbose=verbose,
1781
stop_on_failure=one,
1782
keep_output=keep_output,
1783
transport=transport)
1785
bzrlib.trace.info('tests passed')
1787
bzrlib.trace.info('tests failed')
1788
return int(not result)
1790
bzrlib.ui.ui_factory = save_ui
1793
def _get_bzr_branch():
1794
"""If bzr is run from a branch, return Branch or None"""
1795
import bzrlib.errors
1796
from bzrlib.branch import Branch
1797
from bzrlib.osutils import abspath
1798
from os.path import dirname
1801
branch = Branch.open(dirname(abspath(dirname(__file__))))
1803
except bzrlib.errors.BzrError:
1808
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1809
# is bzrlib itself in a branch?
1810
branch = _get_bzr_branch()
1812
rh = branch.revision_history()
1814
print " bzr checkout, revision %d" % (revno,)
1815
print " nick: %s" % (branch.nick,)
1817
print " revid: %s" % (rh[-1],)
1818
print bzrlib.__copyright__
1819
print "http://bazaar-ng.org/"
1821
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1822
print "you may use, modify and redistribute it under the terms of the GNU"
1823
print "General Public License version 2 or later."
1826
class cmd_version(Command):
1827
"""Show version of bzr."""
1832
class cmd_rocks(Command):
1833
"""Statement of optimism."""
1837
print "it sure does!"
1840
class cmd_find_merge_base(Command):
1841
"""Find and print a base revision for merging two branches.
1843
# TODO: Options to specify revisions on either side, as if
1844
# merging only part of the history.
1845
takes_args = ['branch', 'other']
1849
def run(self, branch, other):
1850
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1852
branch1 = Branch.open_containing(branch)[0]
1853
branch2 = Branch.open_containing(other)[0]
1855
history_1 = branch1.revision_history()
1856
history_2 = branch2.revision_history()
1858
last1 = branch1.last_revision()
1859
last2 = branch2.last_revision()
1861
source = MultipleRevisionSources(branch1.repository,
1864
base_rev_id = common_ancestor(last1, last2, source)
1866
print 'merge base is revision %s' % base_rev_id
1870
if base_revno is None:
1871
raise bzrlib.errors.UnrelatedBranches()
1873
print ' r%-6d in %s' % (base_revno, branch)
1875
other_revno = branch2.revision_id_to_revno(base_revid)
1877
print ' r%-6d in %s' % (other_revno, other)
1881
class cmd_merge(Command):
1882
"""Perform a three-way merge.
1884
The branch is the branch you will merge from. By default, it will
1885
merge the latest revision. If you specify a revision, that
1886
revision will be merged. If you specify two revisions, the first
1887
will be used as a BASE, and the second one as OTHER. Revision
1888
numbers are always relative to the specified branch.
1890
By default, bzr will try to merge in all new work from the other
1891
branch, automatically determining an appropriate base. If this
1892
fails, you may need to give an explicit base.
1894
Merge will do its best to combine the changes in two branches, but there
1895
are some kinds of problems only a human can fix. When it encounters those,
1896
it will mark a conflict. A conflict means that you need to fix something,
1897
before you should commit.
1899
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
1901
If there is no default branch set, the first merge will set it. After
1902
that, you can omit the branch to use the default. To change the
1903
default, use --remember.
1907
To merge the latest revision from bzr.dev
1908
bzr merge ../bzr.dev
1910
To merge changes up to and including revision 82 from bzr.dev
1911
bzr merge -r 82 ../bzr.dev
1913
To merge the changes introduced by 82, without previous changes:
1914
bzr merge -r 81..82 ../bzr.dev
1916
merge refuses to run if there are any uncommitted changes, unless
1919
takes_args = ['branch?']
1920
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
1921
Option('show-base', help="Show base revision text in "
1924
def run(self, branch=None, revision=None, force=False, merge_type=None,
1925
show_base=False, reprocess=False, remember=False):
1926
if merge_type is None:
1927
merge_type = Merge3Merger
1929
tree = WorkingTree.open_containing(u'.')[0]
1930
stored_loc = tree.branch.get_parent()
1932
if stored_loc is None:
1933
raise BzrCommandError("No merge branch known or specified.")
1935
print "Using saved branch: %s" % stored_loc
1938
if tree.branch.get_parent() is None or remember:
1939
tree.branch.set_parent(branch)
1941
if revision is None or len(revision) < 1:
1943
other = [branch, -1]
1944
other_branch, path = Branch.open_containing(branch)
1946
if len(revision) == 1:
1948
other_branch, path = Branch.open_containing(branch)
1949
revno = revision[0].in_history(other_branch).revno
1950
other = [branch, revno]
1952
assert len(revision) == 2
1953
if None in revision:
1954
raise BzrCommandError(
1955
"Merge doesn't permit that revision specifier.")
1956
b, path = Branch.open_containing(branch)
1958
base = [branch, revision[0].in_history(b).revno]
1959
other = [branch, revision[1].in_history(b).revno]
1961
interesting_files = [path]
1963
interesting_files = None
1964
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1967
conflict_count = merge(other, base, check_clean=(not force),
1968
merge_type=merge_type,
1969
reprocess=reprocess,
1970
show_base=show_base,
1971
pb=pb, file_list=interesting_files)
1974
if conflict_count != 0:
1978
except bzrlib.errors.AmbiguousBase, e:
1979
m = ("sorry, bzr can't determine the right merge base yet\n"
1980
"candidates are:\n "
1981
+ "\n ".join(e.bases)
1983
"please specify an explicit base with -r,\n"
1984
"and (if you want) report this to the bzr developers\n")
1988
class cmd_remerge(Command):
1991
takes_args = ['file*']
1992
takes_options = ['merge-type', 'reprocess',
1993
Option('show-base', help="Show base revision text in "
1996
def run(self, file_list=None, merge_type=None, show_base=False,
1998
from bzrlib.merge import merge_inner, transform_tree
1999
if merge_type is None:
2000
merge_type = Merge3Merger
2001
tree, file_list = tree_files(file_list)
2004
pending_merges = tree.pending_merges()
2005
if len(pending_merges) != 1:
2006
raise BzrCommandError("Sorry, remerge only works after normal"
2007
+ " merges. Not cherrypicking or"
2009
repository = tree.branch.repository
2010
base_revision = common_ancestor(tree.branch.last_revision(),
2011
pending_merges[0], repository)
2012
base_tree = repository.revision_tree(base_revision)
2013
other_tree = repository.revision_tree(pending_merges[0])
2014
interesting_ids = None
2015
if file_list is not None:
2016
interesting_ids = set()
2017
for filename in file_list:
2018
file_id = tree.path2id(filename)
2020
raise NotVersionedError(filename)
2021
interesting_ids.add(file_id)
2022
if tree.kind(file_id) != "directory":
2025
for name, ie in tree.inventory.iter_entries(file_id):
2026
interesting_ids.add(ie.file_id)
2027
transform_tree(tree, tree.basis_tree(), interesting_ids)
2028
if file_list is None:
2029
restore_files = list(tree.iter_conflicts())
2031
restore_files = file_list
2032
for filename in restore_files:
2034
restore(tree.abspath(filename))
2035
except NotConflicted:
2037
conflicts = merge_inner(tree.branch, other_tree, base_tree,
2039
interesting_ids = interesting_ids,
2040
other_rev_id=pending_merges[0],
2041
merge_type=merge_type,
2042
show_base=show_base,
2043
reprocess=reprocess)
2051
class cmd_revert(Command):
2052
"""Reverse all changes since the last commit.
2054
Only versioned files are affected. Specify filenames to revert only
2055
those files. By default, any files that are changed will be backed up
2056
first. Backup files have a '~' appended to their name.
2058
takes_options = ['revision', 'no-backup']
2059
takes_args = ['file*']
2060
aliases = ['merge-revert']
2062
def run(self, revision=None, no_backup=False, file_list=None):
2063
from bzrlib.commands import parse_spec
2064
if file_list is not None:
2065
if len(file_list) == 0:
2066
raise BzrCommandError("No files specified")
2070
tree, file_list = tree_files(file_list)
2071
if revision is None:
2072
# FIXME should be tree.last_revision
2073
rev_id = tree.last_revision()
2074
elif len(revision) != 1:
2075
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
2077
rev_id = revision[0].in_history(tree.branch).rev_id
2078
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2080
tree.revert(file_list,
2081
tree.branch.repository.revision_tree(rev_id),
2087
class cmd_assert_fail(Command):
2088
"""Test reporting of assertion failures"""
2091
assert False, "always fails"
2094
class cmd_help(Command):
2095
"""Show help on a command or other topic.
2097
For a list of all available commands, say 'bzr help commands'."""
2098
takes_options = [Option('long', 'show help on all commands')]
2099
takes_args = ['topic?']
2100
aliases = ['?', '--help', '-?', '-h']
2103
def run(self, topic=None, long=False):
2105
if topic is None and long:
2110
class cmd_shell_complete(Command):
2111
"""Show appropriate completions for context.
2113
For a list of all available commands, say 'bzr shell-complete'."""
2114
takes_args = ['context?']
2119
def run(self, context=None):
2120
import shellcomplete
2121
shellcomplete.shellcomplete(context)
2124
class cmd_fetch(Command):
2125
"""Copy in history from another branch but don't merge it.
2127
This is an internal method used for pull and merge."""
2129
takes_args = ['from_branch', 'to_branch']
2130
def run(self, from_branch, to_branch):
2131
from bzrlib.fetch import Fetcher
2132
from bzrlib.branch import Branch
2133
from_b = Branch.open(from_branch)
2134
to_b = Branch.open(to_branch)
2135
Fetcher(to_b, from_b)
2138
class cmd_missing(Command):
2139
"""Show unmerged/unpulled revisions between two branches.
2141
OTHER_BRANCH may be local or remote."""
2142
takes_args = ['other_branch?']
2143
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2145
'Display changes in the local branch only'),
2146
Option('theirs-only',
2147
'Display changes in the remote branch only'),
2156
def run(self, other_branch=None, reverse=False, mine_only=False,
2157
theirs_only=False, log_format=None, long=False, short=False, line=False,
2158
show_ids=False, verbose=False):
2159
from bzrlib.missing import find_unmerged, iter_log_data
2160
from bzrlib.log import log_formatter
2161
local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
2162
parent = local_branch.get_parent()
2163
if other_branch is None:
2164
other_branch = parent
2165
if other_branch is None:
2166
raise BzrCommandError("No missing location known or specified.")
2167
print "Using last location: " + local_branch.get_parent()
2168
remote_branch = bzrlib.branch.Branch.open(other_branch)
2169
if remote_branch.base == local_branch.base:
2170
remote_branch = local_branch
2171
local_branch.lock_read()
2173
remote_branch.lock_read()
2175
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2176
if (log_format == None):
2177
default = bzrlib.config.BranchConfig(local_branch).log_format()
2178
log_format = get_log_format(long=long, short=short, line=line, default=default)
2179
lf = log_formatter(log_format, sys.stdout,
2181
show_timezone='original')
2182
if reverse is False:
2183
local_extra.reverse()
2184
remote_extra.reverse()
2185
if local_extra and not theirs_only:
2186
print "You have %d extra revision(s):" % len(local_extra)
2187
for data in iter_log_data(local_extra, local_branch.repository,
2190
printed_local = True
2192
printed_local = False
2193
if remote_extra and not mine_only:
2194
if printed_local is True:
2196
print "You are missing %d revision(s):" % len(remote_extra)
2197
for data in iter_log_data(remote_extra, remote_branch.repository,
2200
if not remote_extra and not local_extra:
2202
print "Branches are up to date."
2206
remote_branch.unlock()
2208
local_branch.unlock()
2209
if not status_code and parent is None and other_branch is not None:
2210
local_branch.lock_write()
2212
# handle race conditions - a parent might be set while we run.
2213
if local_branch.get_parent() is None:
2214
local_branch.set_parent(other_branch)
2216
local_branch.unlock()
2220
class cmd_plugins(Command):
2225
import bzrlib.plugin
2226
from inspect import getdoc
2227
for name, plugin in bzrlib.plugin.all_plugins().items():
2228
if hasattr(plugin, '__path__'):
2229
print plugin.__path__[0]
2230
elif hasattr(plugin, '__file__'):
2231
print plugin.__file__
2237
print '\t', d.split('\n')[0]
2240
class cmd_testament(Command):
2241
"""Show testament (signing-form) of a revision."""
2242
takes_options = ['revision', 'long']
2243
takes_args = ['branch?']
2245
def run(self, branch=u'.', revision=None, long=False):
2246
from bzrlib.testament import Testament
2247
b = WorkingTree.open_containing(branch)[0].branch
2250
if revision is None:
2251
rev_id = b.last_revision()
2253
rev_id = revision[0].in_history(b).rev_id
2254
t = Testament.from_revision(b.repository, rev_id)
2256
sys.stdout.writelines(t.as_text_lines())
2258
sys.stdout.write(t.as_short_text())
2263
class cmd_annotate(Command):
2264
"""Show the origin of each line in a file.
2266
This prints out the given file with an annotation on the left side
2267
indicating which revision, author and date introduced the change.
2269
If the origin is the same for a run of consecutive lines, it is
2270
shown only at the top, unless the --all option is given.
2272
# TODO: annotate directories; showing when each file was last changed
2273
# TODO: annotate a previous version of a file
2274
# TODO: if the working copy is modified, show annotations on that
2275
# with new uncommitted lines marked
2276
aliases = ['blame', 'praise']
2277
takes_args = ['filename']
2278
takes_options = [Option('all', help='show annotations on all lines'),
2279
Option('long', help='show date in annotations'),
2283
def run(self, filename, all=False, long=False):
2284
from bzrlib.annotate import annotate_file
2285
tree, relpath = WorkingTree.open_containing(filename)
2286
branch = tree.branch
2289
file_id = tree.inventory.path2id(relpath)
2290
tree = branch.repository.revision_tree(branch.last_revision())
2291
file_version = tree.inventory[file_id].revision
2292
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2297
class cmd_re_sign(Command):
2298
"""Create a digital signature for an existing revision."""
2299
# TODO be able to replace existing ones.
2301
hidden = True # is this right ?
2302
takes_args = ['revision_id*']
2303
takes_options = ['revision']
2305
def run(self, revision_id_list=None, revision=None):
2306
import bzrlib.config as config
2307
import bzrlib.gpg as gpg
2308
if revision_id_list is not None and revision is not None:
2309
raise BzrCommandError('You can only supply one of revision_id or --revision')
2310
if revision_id_list is None and revision is None:
2311
raise BzrCommandError('You must supply either --revision or a revision_id')
2312
b = WorkingTree.open_containing(u'.')[0].branch
2313
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
2314
if revision_id_list is not None:
2315
for revision_id in revision_id_list:
2316
b.repository.sign_revision(revision_id, gpg_strategy)
2317
elif revision is not None:
2318
if len(revision) == 1:
2319
revno, rev_id = revision[0].in_history(b)
2320
b.repository.sign_revision(rev_id, gpg_strategy)
2321
elif len(revision) == 2:
2322
# are they both on rh- if so we can walk between them
2323
# might be nice to have a range helper for arbitrary
2324
# revision paths. hmm.
2325
from_revno, from_revid = revision[0].in_history(b)
2326
to_revno, to_revid = revision[1].in_history(b)
2327
if to_revid is None:
2328
to_revno = b.revno()
2329
if from_revno is None or to_revno is None:
2330
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
2331
for revno in range(from_revno, to_revno + 1):
2332
b.repository.sign_revision(b.get_rev_id(revno),
2335
raise BzrCommandError('Please supply either one revision, or a range.')
2338
class cmd_bind(Command):
2339
"""Bind the current branch to a master branch.
2341
After binding, commits must succeed on the master branch
2342
before they are executed on the local one.
2345
takes_args = ['location']
2348
def run(self, location=None):
2349
b, relpath = Branch.open_containing(u'.')
2350
b_other = Branch.open(location)
2353
except DivergedBranches:
2354
raise BzrCommandError('These branches have diverged.'
2355
' Try merging, and then bind again.')
2358
class cmd_unbind(Command):
2359
"""Bind the current branch to its parent.
2361
After unbinding, the local branch is considered independent.
2368
b, relpath = Branch.open_containing(u'.')
2370
raise BzrCommandError('Local branch is not bound')
2373
class cmd_uncommit(bzrlib.commands.Command):
2374
"""Remove the last committed revision.
2376
By supplying the --all flag, it will not only remove the entry
2377
from revision_history, but also remove all of the entries in the
2380
--verbose will print out what is being removed.
2381
--dry-run will go through all the motions, but not actually
2384
In the future, uncommit will create a changeset, which can then
2388
# TODO: jam 20060108 Add an option to allow uncommit to remove
2389
# unreferenced information in 'branch-as-repostory' branches.
2390
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2391
# information in shared branches as well.
2392
takes_options = ['verbose', 'revision',
2393
Option('dry-run', help='Don\'t actually make changes'),
2394
Option('force', help='Say yes to all questions.')]
2395
takes_args = ['location?']
2398
def run(self, location=None,
2399
dry_run=False, verbose=False,
2400
revision=None, force=False):
2401
from bzrlib.branch import Branch
2402
from bzrlib.log import log_formatter
2404
from bzrlib.uncommit import uncommit
2406
if location is None:
2408
control, relpath = bzrdir.BzrDir.open_containing(location)
2410
tree = control.open_workingtree()
2412
except (errors.NoWorkingTree, errors.NotLocalUrl):
2414
b = control.open_branch()
2416
if revision is None:
2418
rev_id = b.last_revision()
2420
revno, rev_id = revision[0].in_history(b)
2422
print 'No revisions to uncommit.'
2424
for r in range(revno, b.revno()+1):
2425
rev_id = b.get_rev_id(r)
2426
lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
2427
lf.show(r, b.repository.get_revision(rev_id), None)
2430
print 'Dry-run, pretending to remove the above revisions.'
2432
val = raw_input('Press <enter> to continue')
2434
print 'The above revision(s) will be removed.'
2436
val = raw_input('Are you sure [y/N]? ')
2437
if val.lower() not in ('y', 'yes'):
2441
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2445
class cmd_break_lock(Command):
2446
"""Break a dead lock on a repository, branch or working directory.
2448
CAUTION: Locks should only be broken when you are sure that the process
2449
holding the lock has been stopped.
2454
takes_args = ['location']
2455
takes_options = [Option('show',
2456
help="just show information on the lock, " \
2459
def run(self, location, show=False):
2460
raise NotImplementedError("sorry, break-lock is not complete yet; "
2461
"you can remove the 'held' directory manually to break the lock")
2464
# command-line interpretation helper for merge-related commands
2465
def merge(other_revision, base_revision,
2466
check_clean=True, ignore_zero=False,
2467
this_dir=None, backup_files=False, merge_type=Merge3Merger,
2468
file_list=None, show_base=False, reprocess=False,
2469
pb=DummyProgress()):
2470
"""Merge changes into a tree.
2473
list(path, revno) Base for three-way merge.
2474
If [None, None] then a base will be automatically determined.
2476
list(path, revno) Other revision for three-way merge.
2478
Directory to merge changes into; '.' by default.
2480
If true, this_dir must have no uncommitted changes before the
2482
ignore_zero - If true, suppress the "zero conflicts" message when
2483
there are no conflicts; should be set when doing something we expect
2484
to complete perfectly.
2485
file_list - If supplied, merge only changes to selected files.
2487
All available ancestors of other_revision and base_revision are
2488
automatically pulled into the branch.
2490
The revno may be -1 to indicate the last revision on the branch, which is
2493
This function is intended for use from the command line; programmatic
2494
clients might prefer to call merge.merge_inner(), which has less magic
2497
from bzrlib.merge import Merger
2498
if this_dir is None:
2500
this_tree = WorkingTree.open_containing(this_dir)[0]
2501
if show_base and not merge_type is Merge3Merger:
2502
raise BzrCommandError("Show-base is not supported for this merge"
2503
" type. %s" % merge_type)
2504
if reprocess and not merge_type.supports_reprocess:
2505
raise BzrCommandError("Conflict reduction is not supported for merge"
2506
" type %s." % merge_type)
2507
if reprocess and show_base:
2508
raise BzrCommandError("Cannot do conflict reduction and show base.")
2510
merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
2511
merger.pp = ProgressPhase("Merge phase", 5, pb)
2512
merger.pp.next_phase()
2513
merger.check_basis(check_clean)
2514
merger.set_other(other_revision)
2515
merger.pp.next_phase()
2516
merger.set_base(base_revision)
2517
if merger.base_rev_id == merger.other_rev_id:
2518
note('Nothing to do.')
2520
merger.backup_files = backup_files
2521
merger.merge_type = merge_type
2522
merger.set_interesting_files(file_list)
2523
merger.show_base = show_base
2524
merger.reprocess = reprocess
2525
conflicts = merger.do_merge()
2526
if file_list is None:
2527
merger.set_pending()
2533
# these get imported and then picked up by the scan for cmd_*
2534
# TODO: Some more consistent way to split command definitions across files;
2535
# we do need to load at least some information about them to know of
2536
# aliases. ideally we would avoid loading the implementation until the
2537
# details were needed.
2538
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2539
from bzrlib.sign_my_commits import cmd_sign_my_commits
2540
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
2541
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
