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.
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 information about a working tree, branch or repository.
771
This command will show all known locations and formats associated to the
772
tree, branch or repository. Statistical information is included with
775
Branches and working trees will also report any missing revisions.
777
takes_args = ['location?']
778
takes_options = ['verbose']
781
def run(self, location=None, verbose=False):
782
from bzrlib.info import show_bzrdir_info
783
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
787
class cmd_remove(Command):
788
"""Make a file unversioned.
790
This makes bzr stop tracking changes to a versioned file. It does
791
not delete the working copy.
793
takes_args = ['file+']
794
takes_options = ['verbose']
797
def run(self, file_list, verbose=False):
798
tree, file_list = tree_files(file_list)
799
tree.remove(file_list, verbose=verbose)
802
class cmd_file_id(Command):
803
"""Print file_id of a particular file or directory.
805
The file_id is assigned when the file is first added and remains the
806
same through all revisions where the file exists, even when it is
810
takes_args = ['filename']
812
def run(self, filename):
813
tree, relpath = WorkingTree.open_containing(filename)
814
i = tree.inventory.path2id(relpath)
816
raise BzrError("%r is not a versioned file" % filename)
821
class cmd_file_path(Command):
822
"""Print path of file_ids to a file or directory.
824
This prints one line for each directory down to the target,
825
starting at the branch root."""
827
takes_args = ['filename']
829
def run(self, filename):
830
tree, relpath = WorkingTree.open_containing(filename)
832
fid = inv.path2id(relpath)
834
raise BzrError("%r is not a versioned file" % filename)
835
for fip in inv.get_idpath(fid):
839
class cmd_reconcile(Command):
840
"""Reconcile bzr metadata in a branch.
842
This can correct data mismatches that may have been caused by
843
previous ghost operations or bzr upgrades. You should only
844
need to run this command if 'bzr check' or a bzr developer
845
advises you to run it.
847
If a second branch is provided, cross-branch reconciliation is
848
also attempted, which will check that data like the tree root
849
id which was not present in very early bzr versions is represented
850
correctly in both branches.
852
At the same time it is run it may recompress data resulting in
853
a potential saving in disk space or performance gain.
855
The branch *MUST* be on a listable system such as local disk or sftp.
857
takes_args = ['branch?']
859
def run(self, branch="."):
860
from bzrlib.reconcile import reconcile
861
dir = bzrlib.bzrdir.BzrDir.open(branch)
865
class cmd_revision_history(Command):
866
"""Display list of revision ids on this branch."""
870
branch = WorkingTree.open_containing(u'.')[0].branch
871
for patchid in branch.revision_history():
875
class cmd_ancestry(Command):
876
"""List all revisions merged into this branch."""
880
tree = WorkingTree.open_containing(u'.')[0]
882
# FIXME. should be tree.last_revision
883
for revision_id in b.repository.get_ancestry(b.last_revision()):
887
class cmd_init(Command):
888
"""Make a directory into a versioned branch.
890
Use this to create an empty branch, or before importing an
893
If there is a repository in a parent directory of the location, then
894
the history of the branch will be stored in the repository. Otherwise
895
init creates a standalone branch which carries its own history in
898
If there is already a branch at the location but it has no working tree,
899
the tree can be populated with 'bzr checkout'.
901
Recipe for importing a tree of files:
906
bzr commit -m 'imported project'
908
takes_args = ['location?']
911
help='Create a specific format rather than the'
912
' current default format. Currently supports:'
913
' metadir, knit, and weave',
914
type=get_format_type),
916
def run(self, location=None, format=None):
917
from bzrlib.branch import Branch
921
# The path has to exist to initialize a
922
# branch inside of it.
923
# Just using os.mkdir, since I don't
924
# believe that we want to create a bunch of
925
# locations if the user supplies an extended path
926
if not os.path.exists(location):
929
existing_bzrdir = bzrdir.BzrDir.open(location)
930
except NotBranchError:
931
# really a NotBzrDir error...
932
bzrdir.BzrDir.create_branch_convenience(location, format=format)
934
if existing_bzrdir.has_branch():
935
if existing_bzrdir.has_workingtree():
936
raise errors.AlreadyBranchError(location)
938
raise errors.BranchExistsWithoutWorkingTree(location)
940
existing_bzrdir.create_branch()
941
existing_bzrdir.create_workingtree()
944
class cmd_init_repository(Command):
945
"""Create a shared repository to hold branches.
947
New branches created under the repository directory will store their revisions
948
in the repository, not in the branch directory, if the branch format supports
954
bzr checkout --lightweight repo/trunk trunk-checkout
958
takes_args = ["location"]
959
takes_options = [Option('format',
960
help='Use a specific format rather than the'
961
' current default format. Currently this'
962
' option accepts "weave", "metadir" and "knit"',
963
type=get_format_type),
965
help='Allows branches in repository to have'
967
aliases = ["init-repo"]
968
def run(self, location, format=None, trees=False):
969
from bzrlib.bzrdir import BzrDirMetaFormat1
970
from bzrlib.transport import get_transport
972
format = BzrDirMetaFormat1()
973
transport = get_transport(location)
974
if not transport.has('.'):
976
newdir = format.initialize_on_transport(transport)
977
repo = newdir.create_repository(shared=True)
978
repo.set_make_working_trees(trees)
981
class cmd_diff(Command):
982
"""Show differences in working tree.
984
If files are listed, only the changes in those files are listed.
985
Otherwise, all changes for the tree are listed.
992
# TODO: Allow diff across branches.
993
# TODO: Option to use external diff command; could be GNU diff, wdiff,
994
# or a graphical diff.
996
# TODO: Python difflib is not exactly the same as unidiff; should
997
# either fix it up or prefer to use an external diff.
999
# TODO: If a directory is given, diff everything under that.
1001
# TODO: Selected-file diff is inefficient and doesn't show you
1004
# TODO: This probably handles non-Unix newlines poorly.
1006
takes_args = ['file*']
1007
takes_options = ['revision', 'diff-options', 'diff-prefix']
1008
aliases = ['di', 'dif']
1011
def run(self, revision=None, file_list=None, diff_options=None,
1013
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1016
if not ':' in diff_prefix:
1017
raise BzrError("--diff-prefix expects two values separated by a colon")
1018
old_label,new_label=diff_prefix.split(":")
1024
tree1, file_list = internal_tree_files(file_list)
1028
except FileInWrongBranch:
1029
if len(file_list) != 2:
1030
raise BzrCommandError("Files are in different branches")
1032
tree1, file1 = WorkingTree.open_containing(file_list[0])
1033
tree2, file2 = WorkingTree.open_containing(file_list[1])
1034
if file1 != "" or file2 != "":
1035
# FIXME diff those two files. rbc 20051123
1036
raise BzrCommandError("Files are in different branches")
1038
if revision is not None:
1039
if tree2 is not None:
1040
raise BzrCommandError("Can't specify -r with two branches")
1041
if (len(revision) == 1) or (revision[1].spec is None):
1042
return diff_cmd_helper(tree1, file_list, diff_options,
1044
old_label=old_label, new_label=new_label)
1045
elif len(revision) == 2:
1046
return diff_cmd_helper(tree1, file_list, diff_options,
1047
revision[0], revision[1],
1048
old_label=old_label, new_label=new_label)
1050
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
1052
if tree2 is not None:
1053
return show_diff_trees(tree1, tree2, sys.stdout,
1054
specific_files=file_list,
1055
external_diff_options=diff_options,
1056
old_label=old_label, new_label=new_label)
1058
return diff_cmd_helper(tree1, file_list, diff_options,
1059
old_label=old_label, new_label=new_label)
1062
class cmd_deleted(Command):
1063
"""List files deleted in the working tree.
1065
# TODO: Show files deleted since a previous revision, or
1066
# between two revisions.
1067
# TODO: Much more efficient way to do this: read in new
1068
# directories with readdir, rather than stating each one. Same
1069
# level of effort but possibly much less IO. (Or possibly not,
1070
# if the directories are very large...)
1072
def run(self, show_ids=False):
1073
tree = WorkingTree.open_containing(u'.')[0]
1074
old = tree.basis_tree()
1075
for path, ie in old.inventory.iter_entries():
1076
if not tree.has_id(ie.file_id):
1078
print '%-50s %s' % (path, ie.file_id)
1083
class cmd_modified(Command):
1084
"""List files modified in working tree."""
1088
from bzrlib.delta import compare_trees
1090
tree = WorkingTree.open_containing(u'.')[0]
1091
td = compare_trees(tree.basis_tree(), tree)
1093
for path, id, kind, text_modified, meta_modified in td.modified:
1098
class cmd_added(Command):
1099
"""List files added in working tree."""
1103
wt = WorkingTree.open_containing(u'.')[0]
1104
basis_inv = wt.basis_tree().inventory
1107
if file_id in basis_inv:
1109
path = inv.id2path(file_id)
1110
if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
1116
class cmd_root(Command):
1117
"""Show the tree root directory.
1119
The root is the nearest enclosing directory with a .bzr control
1121
takes_args = ['filename?']
1123
def run(self, filename=None):
1124
"""Print the branch root."""
1125
tree = WorkingTree.open_containing(filename)[0]
1129
class cmd_log(Command):
1130
"""Show log of a branch, file, or directory.
1132
By default show the log of the branch containing the working directory.
1134
To request a range of logs, you can use the command -r begin..end
1135
-r revision requests a specific revision, -r ..end or -r begin.. are
1141
bzr log -r -10.. http://server/branch
1144
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1146
takes_args = ['location?']
1147
takes_options = [Option('forward',
1148
help='show from oldest to newest'),
1151
help='show files changed in each revision'),
1152
'show-ids', 'revision',
1156
help='show revisions whose message matches this regexp',
1161
def run(self, location=None, timezone='original',
1171
from bzrlib.log import log_formatter, show_log
1173
assert message is None or isinstance(message, basestring), \
1174
"invalid message argument %r" % message
1175
direction = (forward and 'forward') or 'reverse'
1180
# find the file id to log:
1182
dir, fp = bzrdir.BzrDir.open_containing(location)
1183
b = dir.open_branch()
1187
inv = dir.open_workingtree().inventory
1188
except (errors.NotBranchError, errors.NotLocalUrl):
1189
# either no tree, or is remote.
1190
inv = b.basis_tree().inventory
1191
file_id = inv.path2id(fp)
1194
# FIXME ? log the current subdir only RBC 20060203
1195
dir, relpath = bzrdir.BzrDir.open_containing('.')
1196
b = dir.open_branch()
1198
if revision is None:
1201
elif len(revision) == 1:
1202
rev1 = rev2 = revision[0].in_history(b).revno
1203
elif len(revision) == 2:
1204
if revision[0].spec is None:
1205
# missing begin-range means first revision
1208
rev1 = revision[0].in_history(b).revno
1210
if revision[1].spec is None:
1211
# missing end-range means last known revision
1214
rev2 = revision[1].in_history(b).revno
1216
raise BzrCommandError('bzr log --revision takes one or two values.')
1218
# By this point, the revision numbers are converted to the +ve
1219
# form if they were supplied in the -ve form, so we can do
1220
# this comparison in relative safety
1222
(rev2, rev1) = (rev1, rev2)
1224
mutter('encoding log as %r', bzrlib.user_encoding)
1226
# use 'replace' so that we don't abort if trying to write out
1227
# in e.g. the default C locale.
1228
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1230
if (log_format == None):
1231
default = bzrlib.config.BranchConfig(b).log_format()
1232
log_format = get_log_format(long=long, short=short, line=line, default=default)
1234
lf = log_formatter(log_format,
1237
show_timezone=timezone)
1243
direction=direction,
1244
start_revision=rev1,
1249
def get_log_format(long=False, short=False, line=False, default='long'):
1250
log_format = default
1254
log_format = 'short'
1260
class cmd_touching_revisions(Command):
1261
"""Return revision-ids which affected a particular file.
1263
A more user-friendly interface is "bzr log FILE"."""
1265
takes_args = ["filename"]
1267
def run(self, filename):
1268
tree, relpath = WorkingTree.open_containing(filename)
1270
inv = tree.read_working_inventory()
1271
file_id = inv.path2id(relpath)
1272
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1273
print "%6d %s" % (revno, what)
1276
class cmd_ls(Command):
1277
"""List files in a tree.
1279
# TODO: Take a revision or remote path and list that tree instead.
1281
takes_options = ['verbose', 'revision',
1282
Option('non-recursive',
1283
help='don\'t recurse into sub-directories'),
1285
help='Print all paths from the root of the branch.'),
1286
Option('unknown', help='Print unknown files'),
1287
Option('versioned', help='Print versioned files'),
1288
Option('ignored', help='Print ignored files'),
1290
Option('null', help='Null separate the files'),
1293
def run(self, revision=None, verbose=False,
1294
non_recursive=False, from_root=False,
1295
unknown=False, versioned=False, ignored=False,
1298
if verbose and null:
1299
raise BzrCommandError('Cannot set both --verbose and --null')
1300
all = not (unknown or versioned or ignored)
1302
selection = {'I':ignored, '?':unknown, 'V':versioned}
1304
tree, relpath = WorkingTree.open_containing(u'.')
1309
if revision is not None:
1310
tree = tree.branch.repository.revision_tree(
1311
revision[0].in_history(tree.branch).rev_id)
1312
for fp, fc, kind, fid, entry in tree.list_files():
1313
if fp.startswith(relpath):
1314
fp = fp[len(relpath):]
1315
if non_recursive and '/' in fp:
1317
if not all and not selection[fc]:
1320
kindch = entry.kind_character()
1321
print '%-8s %s%s' % (fc, fp, kindch)
1323
sys.stdout.write(fp)
1324
sys.stdout.write('\0')
1330
class cmd_unknowns(Command):
1331
"""List unknown files."""
1334
from bzrlib.osutils import quotefn
1335
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1339
class cmd_ignore(Command):
1340
"""Ignore a command or pattern.
1342
To remove patterns from the ignore list, edit the .bzrignore file.
1344
If the pattern contains a slash, it is compared to the whole path
1345
from the branch root. Otherwise, it is compared to only the last
1346
component of the path. To match a file only in the root directory,
1349
Ignore patterns are case-insensitive on case-insensitive systems.
1351
Note: wildcards must be quoted from the shell on Unix.
1354
bzr ignore ./Makefile
1355
bzr ignore '*.class'
1357
# TODO: Complain if the filename is absolute
1358
takes_args = ['name_pattern']
1360
def run(self, name_pattern):
1361
from bzrlib.atomicfile import AtomicFile
1364
tree, relpath = WorkingTree.open_containing(u'.')
1365
ifn = tree.abspath('.bzrignore')
1367
if os.path.exists(ifn):
1370
igns = f.read().decode('utf-8')
1376
# TODO: If the file already uses crlf-style termination, maybe
1377
# we should use that for the newly added lines?
1379
if igns and igns[-1] != '\n':
1381
igns += name_pattern + '\n'
1384
f = AtomicFile(ifn, 'wt')
1385
f.write(igns.encode('utf-8'))
1390
inv = tree.inventory
1391
if inv.path2id('.bzrignore'):
1392
mutter('.bzrignore is already versioned')
1394
mutter('need to make new .bzrignore file versioned')
1395
tree.add(['.bzrignore'])
1398
class cmd_ignored(Command):
1399
"""List ignored files and the patterns that matched them.
1401
See also: bzr ignore"""
1404
tree = WorkingTree.open_containing(u'.')[0]
1405
for path, file_class, kind, file_id, entry in tree.list_files():
1406
if file_class != 'I':
1408
## XXX: Slightly inefficient since this was already calculated
1409
pat = tree.is_ignored(path)
1410
print '%-50s %s' % (path, pat)
1413
class cmd_lookup_revision(Command):
1414
"""Lookup the revision-id from a revision-number
1417
bzr lookup-revision 33
1420
takes_args = ['revno']
1423
def run(self, revno):
1427
raise BzrCommandError("not a valid revision-number: %r" % revno)
1429
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1432
class cmd_export(Command):
1433
"""Export past revision to destination directory.
1435
If no revision is specified this exports the last committed revision.
1437
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1438
given, try to find the format with the extension. If no extension
1439
is found exports to a directory (equivalent to --format=dir).
1441
Root may be the top directory for tar, tgz and tbz2 formats. If none
1442
is given, the top directory will be the root name of the file.
1444
Note: export of tree with non-ascii filenames to zip is not supported.
1446
Supported formats Autodetected by extension
1447
----------------- -------------------------
1450
tbz2 .tar.bz2, .tbz2
1454
takes_args = ['dest']
1455
takes_options = ['revision', 'format', 'root']
1456
def run(self, dest, revision=None, format=None, root=None):
1458
from bzrlib.export import export
1459
tree = WorkingTree.open_containing(u'.')[0]
1461
if revision is None:
1462
# should be tree.last_revision FIXME
1463
rev_id = b.last_revision()
1465
if len(revision) != 1:
1466
raise BzrError('bzr export --revision takes exactly 1 argument')
1467
rev_id = revision[0].in_history(b).rev_id
1468
t = b.repository.revision_tree(rev_id)
1470
export(t, dest, format, root)
1471
except errors.NoSuchExportFormat, e:
1472
raise BzrCommandError('Unsupported export format: %s' % e.format)
1475
class cmd_cat(Command):
1476
"""Write a file's text from a previous revision."""
1478
takes_options = ['revision']
1479
takes_args = ['filename']
1482
def run(self, filename, revision=None):
1483
if revision is not None and len(revision) != 1:
1484
raise BzrCommandError("bzr cat --revision takes exactly one number")
1487
tree, relpath = WorkingTree.open_containing(filename)
1489
except NotBranchError:
1493
b, relpath = Branch.open_containing(filename)
1494
if revision is None:
1495
revision_id = b.last_revision()
1497
revision_id = revision[0].in_history(b).rev_id
1498
b.print_file(relpath, revision_id)
1501
class cmd_local_time_offset(Command):
1502
"""Show the offset in seconds from GMT to local time."""
1506
print bzrlib.osutils.local_time_offset()
1510
class cmd_commit(Command):
1511
"""Commit changes into a new revision.
1513
If no arguments are given, the entire tree is committed.
1515
If selected files are specified, only changes to those files are
1516
committed. If a directory is specified then the directory and everything
1517
within it is committed.
1519
A selected-file commit may fail in some cases where the committed
1520
tree would be invalid, such as trying to commit a file in a
1521
newly-added directory that is not itself committed.
1523
# TODO: Run hooks on tree to-be-committed, and after commit.
1525
# TODO: Strict commit that fails if there are deleted files.
1526
# (what does "deleted files" mean ??)
1528
# TODO: Give better message for -s, --summary, used by tla people
1530
# XXX: verbose currently does nothing
1532
takes_args = ['selected*']
1533
takes_options = ['message', 'verbose',
1535
help='commit even if nothing has changed'),
1536
Option('file', type=str,
1538
help='file containing commit message'),
1540
help="refuse to commit if there are unknown "
1541
"files in the working tree."),
1543
help="perform a local only commit in a bound "
1544
"branch. Such commits are not pushed to "
1545
"the master branch until a normal commit "
1549
aliases = ['ci', 'checkin']
1551
def run(self, message=None, file=None, verbose=True, selected_list=None,
1552
unchanged=False, strict=False, local=False):
1553
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1554
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1556
from bzrlib.msgeditor import edit_commit_message, \
1557
make_commit_message_template
1558
from tempfile import TemporaryFile
1561
# TODO: Need a blackbox test for invoking the external editor; may be
1562
# slightly problematic to run this cross-platform.
1564
# TODO: do more checks that the commit will succeed before
1565
# spending the user's valuable time typing a commit message.
1567
# TODO: if the commit *does* happen to fail, then save the commit
1568
# message to a temporary file where it can be recovered
1569
tree, selected_list = tree_files(selected_list)
1570
if local and not tree.branch.get_bound_location():
1571
raise errors.LocalRequiresBoundBranch()
1572
if message is None and not file:
1573
template = make_commit_message_template(tree, selected_list)
1574
message = edit_commit_message(template)
1576
raise BzrCommandError("please specify a commit message"
1577
" with either --message or --file")
1578
elif message and file:
1579
raise BzrCommandError("please specify either --message or --file")
1583
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1586
raise BzrCommandError("empty commit message specified")
1589
reporter = ReportCommitToLog()
1591
reporter = NullCommitReporter()
1594
tree.commit(message, specific_files=selected_list,
1595
allow_pointless=unchanged, strict=strict, local=local,
1597
except PointlessCommit:
1598
# FIXME: This should really happen before the file is read in;
1599
# perhaps prepare the commit; get the message; then actually commit
1600
raise BzrCommandError("no changes to commit",
1601
["use --unchanged to commit anyhow"])
1602
except ConflictsInTree:
1603
raise BzrCommandError("Conflicts detected in working tree. "
1604
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1605
except StrictCommitFailed:
1606
raise BzrCommandError("Commit refused because there are unknown "
1607
"files in the working tree.")
1608
except errors.BoundBranchOutOfDate, e:
1609
raise BzrCommandError(str(e)
1610
+ ' Either unbind, update, or'
1611
' pass --local to commit.')
1614
class cmd_check(Command):
1615
"""Validate consistency of branch history.
1617
This command checks various invariants about the branch storage to
1618
detect data corruption or bzr bugs.
1620
takes_args = ['branch?']
1621
takes_options = ['verbose']
1623
def run(self, branch=None, verbose=False):
1624
from bzrlib.check import check
1626
tree = WorkingTree.open_containing()[0]
1627
branch = tree.branch
1629
branch = Branch.open(branch)
1630
check(branch, verbose)
1633
class cmd_scan_cache(Command):
1636
from bzrlib.hashcache import HashCache
1642
print '%6d stats' % c.stat_count
1643
print '%6d in hashcache' % len(c._cache)
1644
print '%6d files removed from cache' % c.removed_count
1645
print '%6d hashes updated' % c.update_count
1646
print '%6d files changed too recently to cache' % c.danger_count
1652
class cmd_upgrade(Command):
1653
"""Upgrade branch storage to current format.
1655
The check command or bzr developers may sometimes advise you to run
1656
this command. When the default format has changed you may also be warned
1657
during other operations to upgrade.
1659
takes_args = ['url?']
1662
help='Upgrade to a specific format rather than the'
1663
' current default format. Currently this'
1664
' option accepts "weave", "metadir" and'
1666
type=get_format_type),
1670
def run(self, url='.', format=None):
1671
from bzrlib.upgrade import upgrade
1672
upgrade(url, format)
1675
class cmd_whoami(Command):
1676
"""Show bzr user id."""
1677
takes_options = ['email']
1680
def run(self, email=False):
1682
b = WorkingTree.open_containing(u'.')[0].branch
1683
config = bzrlib.config.BranchConfig(b)
1684
except NotBranchError:
1685
config = bzrlib.config.GlobalConfig()
1688
print config.user_email()
1690
print config.username()
1693
class cmd_nick(Command):
1694
"""Print or set the branch nickname.
1696
If unset, the tree root directory name is used as the nickname
1697
To print the current nickname, execute with no argument.
1699
takes_args = ['nickname?']
1700
def run(self, nickname=None):
1701
branch = Branch.open_containing(u'.')[0]
1702
if nickname is None:
1703
self.printme(branch)
1705
branch.nick = nickname
1708
def printme(self, branch):
1712
class cmd_selftest(Command):
1713
"""Run internal test suite.
1715
This creates temporary test directories in the working directory,
1716
but not existing data is affected. These directories are deleted
1717
if the tests pass, or left behind to help in debugging if they
1718
fail and --keep-output is specified.
1720
If arguments are given, they are regular expressions that say
1721
which tests should run.
1723
If the global option '--no-plugins' is given, plugins are not loaded
1724
before running the selftests. This has two effects: features provided or
1725
modified by plugins will not be tested, and tests provided by plugins will
1730
bzr --no-plugins selftest -v
1732
# TODO: --list should give a list of all available tests
1734
# NB: this is used from the class without creating an instance, which is
1735
# why it does not have a self parameter.
1736
def get_transport_type(typestring):
1737
"""Parse and return a transport specifier."""
1738
if typestring == "sftp":
1739
from bzrlib.transport.sftp import SFTPAbsoluteServer
1740
return SFTPAbsoluteServer
1741
if typestring == "memory":
1742
from bzrlib.transport.memory import MemoryServer
1744
if typestring == "fakenfs":
1745
from bzrlib.transport.fakenfs import FakeNFSServer
1746
return FakeNFSServer
1747
msg = "No known transport type %s. Supported types are: sftp\n" %\
1749
raise BzrCommandError(msg)
1752
takes_args = ['testspecs*']
1753
takes_options = ['verbose',
1754
Option('one', help='stop when one test fails'),
1755
Option('keep-output',
1756
help='keep output directories when tests fail'),
1758
help='Use a different transport by default '
1759
'throughout the test suite.',
1760
type=get_transport_type),
1763
def run(self, testspecs_list=None, verbose=False, one=False,
1764
keep_output=False, transport=None):
1766
from bzrlib.tests import selftest
1767
# we don't want progress meters from the tests to go to the
1768
# real output; and we don't want log messages cluttering up
1770
save_ui = bzrlib.ui.ui_factory
1771
bzrlib.trace.info('running tests...')
1773
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1774
if testspecs_list is not None:
1775
pattern = '|'.join(testspecs_list)
1778
result = selftest(verbose=verbose,
1780
stop_on_failure=one,
1781
keep_output=keep_output,
1782
transport=transport)
1784
bzrlib.trace.info('tests passed')
1786
bzrlib.trace.info('tests failed')
1787
return int(not result)
1789
bzrlib.ui.ui_factory = save_ui
1792
def _get_bzr_branch():
1793
"""If bzr is run from a branch, return Branch or None"""
1794
import bzrlib.errors
1795
from bzrlib.branch import Branch
1796
from bzrlib.osutils import abspath
1797
from os.path import dirname
1800
branch = Branch.open(dirname(abspath(dirname(__file__))))
1802
except bzrlib.errors.BzrError:
1807
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1808
# is bzrlib itself in a branch?
1809
branch = _get_bzr_branch()
1811
rh = branch.revision_history()
1813
print " bzr checkout, revision %d" % (revno,)
1814
print " nick: %s" % (branch.nick,)
1816
print " revid: %s" % (rh[-1],)
1817
print bzrlib.__copyright__
1818
print "http://bazaar-ng.org/"
1820
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1821
print "you may use, modify and redistribute it under the terms of the GNU"
1822
print "General Public License version 2 or later."
1825
class cmd_version(Command):
1826
"""Show version of bzr."""
1831
class cmd_rocks(Command):
1832
"""Statement of optimism."""
1836
print "it sure does!"
1839
class cmd_find_merge_base(Command):
1840
"""Find and print a base revision for merging two branches.
1842
# TODO: Options to specify revisions on either side, as if
1843
# merging only part of the history.
1844
takes_args = ['branch', 'other']
1848
def run(self, branch, other):
1849
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1851
branch1 = Branch.open_containing(branch)[0]
1852
branch2 = Branch.open_containing(other)[0]
1854
history_1 = branch1.revision_history()
1855
history_2 = branch2.revision_history()
1857
last1 = branch1.last_revision()
1858
last2 = branch2.last_revision()
1860
source = MultipleRevisionSources(branch1.repository,
1863
base_rev_id = common_ancestor(last1, last2, source)
1865
print 'merge base is revision %s' % base_rev_id
1869
if base_revno is None:
1870
raise bzrlib.errors.UnrelatedBranches()
1872
print ' r%-6d in %s' % (base_revno, branch)
1874
other_revno = branch2.revision_id_to_revno(base_revid)
1876
print ' r%-6d in %s' % (other_revno, other)
1880
class cmd_merge(Command):
1881
"""Perform a three-way merge.
1883
The branch is the branch you will merge from. By default, it will
1884
merge the latest revision. If you specify a revision, that
1885
revision will be merged. If you specify two revisions, the first
1886
will be used as a BASE, and the second one as OTHER. Revision
1887
numbers are always relative to the specified branch.
1889
By default, bzr will try to merge in all new work from the other
1890
branch, automatically determining an appropriate base. If this
1891
fails, you may need to give an explicit base.
1893
Merge will do its best to combine the changes in two branches, but there
1894
are some kinds of problems only a human can fix. When it encounters those,
1895
it will mark a conflict. A conflict means that you need to fix something,
1896
before you should commit.
1898
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
1900
If there is no default branch set, the first merge will set it. After
1901
that, you can omit the branch to use the default. To change the
1902
default, use --remember.
1906
To merge the latest revision from bzr.dev
1907
bzr merge ../bzr.dev
1909
To merge changes up to and including revision 82 from bzr.dev
1910
bzr merge -r 82 ../bzr.dev
1912
To merge the changes introduced by 82, without previous changes:
1913
bzr merge -r 81..82 ../bzr.dev
1915
merge refuses to run if there are any uncommitted changes, unless
1918
takes_args = ['branch?']
1919
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
1920
Option('show-base', help="Show base revision text in "
1923
def run(self, branch=None, revision=None, force=False, merge_type=None,
1924
show_base=False, reprocess=False, remember=False):
1925
if merge_type is None:
1926
merge_type = Merge3Merger
1928
tree = WorkingTree.open_containing(u'.')[0]
1929
stored_loc = tree.branch.get_parent()
1931
if stored_loc is None:
1932
raise BzrCommandError("No merge branch known or specified.")
1934
print "Using saved branch: %s" % stored_loc
1937
if tree.branch.get_parent() is None or remember:
1938
tree.branch.set_parent(branch)
1940
if revision is None or len(revision) < 1:
1942
other = [branch, -1]
1943
other_branch, path = Branch.open_containing(branch)
1945
if len(revision) == 1:
1947
other_branch, path = Branch.open_containing(branch)
1948
revno = revision[0].in_history(other_branch).revno
1949
other = [branch, revno]
1951
assert len(revision) == 2
1952
if None in revision:
1953
raise BzrCommandError(
1954
"Merge doesn't permit that revision specifier.")
1955
b, path = Branch.open_containing(branch)
1957
base = [branch, revision[0].in_history(b).revno]
1958
other = [branch, revision[1].in_history(b).revno]
1960
interesting_files = [path]
1962
interesting_files = None
1963
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1966
conflict_count = merge(other, base, check_clean=(not force),
1967
merge_type=merge_type,
1968
reprocess=reprocess,
1969
show_base=show_base,
1970
pb=pb, file_list=interesting_files)
1973
if conflict_count != 0:
1977
except bzrlib.errors.AmbiguousBase, e:
1978
m = ("sorry, bzr can't determine the right merge base yet\n"
1979
"candidates are:\n "
1980
+ "\n ".join(e.bases)
1982
"please specify an explicit base with -r,\n"
1983
"and (if you want) report this to the bzr developers\n")
1987
class cmd_remerge(Command):
1990
takes_args = ['file*']
1991
takes_options = ['merge-type', 'reprocess',
1992
Option('show-base', help="Show base revision text in "
1995
def run(self, file_list=None, merge_type=None, show_base=False,
1997
from bzrlib.merge import merge_inner, transform_tree
1998
if merge_type is None:
1999
merge_type = Merge3Merger
2000
tree, file_list = tree_files(file_list)
2003
pending_merges = tree.pending_merges()
2004
if len(pending_merges) != 1:
2005
raise BzrCommandError("Sorry, remerge only works after normal"
2006
+ " merges. Not cherrypicking or"
2008
repository = tree.branch.repository
2009
base_revision = common_ancestor(tree.branch.last_revision(),
2010
pending_merges[0], repository)
2011
base_tree = repository.revision_tree(base_revision)
2012
other_tree = repository.revision_tree(pending_merges[0])
2013
interesting_ids = None
2014
if file_list is not None:
2015
interesting_ids = set()
2016
for filename in file_list:
2017
file_id = tree.path2id(filename)
2019
raise NotVersionedError(filename)
2020
interesting_ids.add(file_id)
2021
if tree.kind(file_id) != "directory":
2024
for name, ie in tree.inventory.iter_entries(file_id):
2025
interesting_ids.add(ie.file_id)
2026
transform_tree(tree, tree.basis_tree(), interesting_ids)
2027
if file_list is None:
2028
restore_files = list(tree.iter_conflicts())
2030
restore_files = file_list
2031
for filename in restore_files:
2033
restore(tree.abspath(filename))
2034
except NotConflicted:
2036
conflicts = merge_inner(tree.branch, other_tree, base_tree,
2038
interesting_ids = interesting_ids,
2039
other_rev_id=pending_merges[0],
2040
merge_type=merge_type,
2041
show_base=show_base,
2042
reprocess=reprocess)
2050
class cmd_revert(Command):
2051
"""Reverse all changes since the last commit.
2053
Only versioned files are affected. Specify filenames to revert only
2054
those files. By default, any files that are changed will be backed up
2055
first. Backup files have a '~' appended to their name.
2057
takes_options = ['revision', 'no-backup']
2058
takes_args = ['file*']
2059
aliases = ['merge-revert']
2061
def run(self, revision=None, no_backup=False, file_list=None):
2062
from bzrlib.commands import parse_spec
2063
if file_list is not None:
2064
if len(file_list) == 0:
2065
raise BzrCommandError("No files specified")
2069
tree, file_list = tree_files(file_list)
2070
if revision is None:
2071
# FIXME should be tree.last_revision
2072
rev_id = tree.last_revision()
2073
elif len(revision) != 1:
2074
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
2076
rev_id = revision[0].in_history(tree.branch).rev_id
2077
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2079
tree.revert(file_list,
2080
tree.branch.repository.revision_tree(rev_id),
2086
class cmd_assert_fail(Command):
2087
"""Test reporting of assertion failures"""
2090
assert False, "always fails"
2093
class cmd_help(Command):
2094
"""Show help on a command or other topic.
2096
For a list of all available commands, say 'bzr help commands'."""
2097
takes_options = [Option('long', 'show help on all commands')]
2098
takes_args = ['topic?']
2099
aliases = ['?', '--help', '-?', '-h']
2102
def run(self, topic=None, long=False):
2104
if topic is None and long:
2109
class cmd_shell_complete(Command):
2110
"""Show appropriate completions for context.
2112
For a list of all available commands, say 'bzr shell-complete'."""
2113
takes_args = ['context?']
2118
def run(self, context=None):
2119
import shellcomplete
2120
shellcomplete.shellcomplete(context)
2123
class cmd_fetch(Command):
2124
"""Copy in history from another branch but don't merge it.
2126
This is an internal method used for pull and merge."""
2128
takes_args = ['from_branch', 'to_branch']
2129
def run(self, from_branch, to_branch):
2130
from bzrlib.fetch import Fetcher
2131
from bzrlib.branch import Branch
2132
from_b = Branch.open(from_branch)
2133
to_b = Branch.open(to_branch)
2134
Fetcher(to_b, from_b)
2137
class cmd_missing(Command):
2138
"""Show unmerged/unpulled revisions between two branches.
2140
OTHER_BRANCH may be local or remote."""
2141
takes_args = ['other_branch?']
2142
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2144
'Display changes in the local branch only'),
2145
Option('theirs-only',
2146
'Display changes in the remote branch only'),
2155
def run(self, other_branch=None, reverse=False, mine_only=False,
2156
theirs_only=False, log_format=None, long=False, short=False, line=False,
2157
show_ids=False, verbose=False):
2158
from bzrlib.missing import find_unmerged, iter_log_data
2159
from bzrlib.log import log_formatter
2160
local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
2161
parent = local_branch.get_parent()
2162
if other_branch is None:
2163
other_branch = parent
2164
if other_branch is None:
2165
raise BzrCommandError("No missing location known or specified.")
2166
print "Using last location: " + local_branch.get_parent()
2167
remote_branch = bzrlib.branch.Branch.open(other_branch)
2168
if remote_branch.base == local_branch.base:
2169
remote_branch = local_branch
2170
local_branch.lock_read()
2172
remote_branch.lock_read()
2174
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2175
if (log_format == None):
2176
default = bzrlib.config.BranchConfig(local_branch).log_format()
2177
log_format = get_log_format(long=long, short=short, line=line, default=default)
2178
lf = log_formatter(log_format, sys.stdout,
2180
show_timezone='original')
2181
if reverse is False:
2182
local_extra.reverse()
2183
remote_extra.reverse()
2184
if local_extra and not theirs_only:
2185
print "You have %d extra revision(s):" % len(local_extra)
2186
for data in iter_log_data(local_extra, local_branch.repository,
2189
printed_local = True
2191
printed_local = False
2192
if remote_extra and not mine_only:
2193
if printed_local is True:
2195
print "You are missing %d revision(s):" % len(remote_extra)
2196
for data in iter_log_data(remote_extra, remote_branch.repository,
2199
if not remote_extra and not local_extra:
2201
print "Branches are up to date."
2205
remote_branch.unlock()
2207
local_branch.unlock()
2208
if not status_code and parent is None and other_branch is not None:
2209
local_branch.lock_write()
2211
# handle race conditions - a parent might be set while we run.
2212
if local_branch.get_parent() is None:
2213
local_branch.set_parent(other_branch)
2215
local_branch.unlock()
2219
class cmd_plugins(Command):
2224
import bzrlib.plugin
2225
from inspect import getdoc
2226
for name, plugin in bzrlib.plugin.all_plugins().items():
2227
if hasattr(plugin, '__path__'):
2228
print plugin.__path__[0]
2229
elif hasattr(plugin, '__file__'):
2230
print plugin.__file__
2236
print '\t', d.split('\n')[0]
2239
class cmd_testament(Command):
2240
"""Show testament (signing-form) of a revision."""
2241
takes_options = ['revision', 'long']
2242
takes_args = ['branch?']
2244
def run(self, branch=u'.', revision=None, long=False):
2245
from bzrlib.testament import Testament
2246
b = WorkingTree.open_containing(branch)[0].branch
2249
if revision is None:
2250
rev_id = b.last_revision()
2252
rev_id = revision[0].in_history(b).rev_id
2253
t = Testament.from_revision(b.repository, rev_id)
2255
sys.stdout.writelines(t.as_text_lines())
2257
sys.stdout.write(t.as_short_text())
2262
class cmd_annotate(Command):
2263
"""Show the origin of each line in a file.
2265
This prints out the given file with an annotation on the left side
2266
indicating which revision, author and date introduced the change.
2268
If the origin is the same for a run of consecutive lines, it is
2269
shown only at the top, unless the --all option is given.
2271
# TODO: annotate directories; showing when each file was last changed
2272
# TODO: annotate a previous version of a file
2273
# TODO: if the working copy is modified, show annotations on that
2274
# with new uncommitted lines marked
2275
aliases = ['blame', 'praise']
2276
takes_args = ['filename']
2277
takes_options = [Option('all', help='show annotations on all lines'),
2278
Option('long', help='show date in annotations'),
2282
def run(self, filename, all=False, long=False):
2283
from bzrlib.annotate import annotate_file
2284
tree, relpath = WorkingTree.open_containing(filename)
2285
branch = tree.branch
2288
file_id = tree.inventory.path2id(relpath)
2289
tree = branch.repository.revision_tree(branch.last_revision())
2290
file_version = tree.inventory[file_id].revision
2291
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2296
class cmd_re_sign(Command):
2297
"""Create a digital signature for an existing revision."""
2298
# TODO be able to replace existing ones.
2300
hidden = True # is this right ?
2301
takes_args = ['revision_id*']
2302
takes_options = ['revision']
2304
def run(self, revision_id_list=None, revision=None):
2305
import bzrlib.config as config
2306
import bzrlib.gpg as gpg
2307
if revision_id_list is not None and revision is not None:
2308
raise BzrCommandError('You can only supply one of revision_id or --revision')
2309
if revision_id_list is None and revision is None:
2310
raise BzrCommandError('You must supply either --revision or a revision_id')
2311
b = WorkingTree.open_containing(u'.')[0].branch
2312
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
2313
if revision_id_list is not None:
2314
for revision_id in revision_id_list:
2315
b.repository.sign_revision(revision_id, gpg_strategy)
2316
elif revision is not None:
2317
if len(revision) == 1:
2318
revno, rev_id = revision[0].in_history(b)
2319
b.repository.sign_revision(rev_id, gpg_strategy)
2320
elif len(revision) == 2:
2321
# are they both on rh- if so we can walk between them
2322
# might be nice to have a range helper for arbitrary
2323
# revision paths. hmm.
2324
from_revno, from_revid = revision[0].in_history(b)
2325
to_revno, to_revid = revision[1].in_history(b)
2326
if to_revid is None:
2327
to_revno = b.revno()
2328
if from_revno is None or to_revno is None:
2329
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
2330
for revno in range(from_revno, to_revno + 1):
2331
b.repository.sign_revision(b.get_rev_id(revno),
2334
raise BzrCommandError('Please supply either one revision, or a range.')
2337
class cmd_bind(Command):
2338
"""Bind the current branch to a master branch.
2340
After binding, commits must succeed on the master branch
2341
before they are executed on the local one.
2344
takes_args = ['location']
2347
def run(self, location=None):
2348
b, relpath = Branch.open_containing(u'.')
2349
b_other = Branch.open(location)
2352
except DivergedBranches:
2353
raise BzrCommandError('These branches have diverged.'
2354
' Try merging, and then bind again.')
2357
class cmd_unbind(Command):
2358
"""Bind the current branch to its parent.
2360
After unbinding, the local branch is considered independent.
2367
b, relpath = Branch.open_containing(u'.')
2369
raise BzrCommandError('Local branch is not bound')
2372
class cmd_uncommit(bzrlib.commands.Command):
2373
"""Remove the last committed revision.
2375
By supplying the --all flag, it will not only remove the entry
2376
from revision_history, but also remove all of the entries in the
2379
--verbose will print out what is being removed.
2380
--dry-run will go through all the motions, but not actually
2383
In the future, uncommit will create a changeset, which can then
2387
# TODO: jam 20060108 Add an option to allow uncommit to remove
2388
# unreferenced information in 'branch-as-repostory' branches.
2389
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2390
# information in shared branches as well.
2391
takes_options = ['verbose', 'revision',
2392
Option('dry-run', help='Don\'t actually make changes'),
2393
Option('force', help='Say yes to all questions.')]
2394
takes_args = ['location?']
2397
def run(self, location=None,
2398
dry_run=False, verbose=False,
2399
revision=None, force=False):
2400
from bzrlib.branch import Branch
2401
from bzrlib.log import log_formatter
2403
from bzrlib.uncommit import uncommit
2405
if location is None:
2407
control, relpath = bzrdir.BzrDir.open_containing(location)
2409
tree = control.open_workingtree()
2411
except (errors.NoWorkingTree, errors.NotLocalUrl):
2413
b = control.open_branch()
2415
if revision is None:
2417
rev_id = b.last_revision()
2419
revno, rev_id = revision[0].in_history(b)
2421
print 'No revisions to uncommit.'
2423
for r in range(revno, b.revno()+1):
2424
rev_id = b.get_rev_id(r)
2425
lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
2426
lf.show(r, b.repository.get_revision(rev_id), None)
2429
print 'Dry-run, pretending to remove the above revisions.'
2431
val = raw_input('Press <enter> to continue')
2433
print 'The above revision(s) will be removed.'
2435
val = raw_input('Are you sure [y/N]? ')
2436
if val.lower() not in ('y', 'yes'):
2440
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2444
class cmd_break_lock(Command):
2445
"""Break a dead lock on a repository, branch or working directory.
2447
CAUTION: Locks should only be broken when you are sure that the process
2448
holding the lock has been stopped.
2453
takes_args = ['location']
2454
takes_options = [Option('show',
2455
help="just show information on the lock, " \
2458
def run(self, location, show=False):
2459
raise NotImplementedError("sorry, break-lock is not complete yet; "
2460
"you can remove the 'held' directory manually to break the lock")
2463
# command-line interpretation helper for merge-related commands
2464
def merge(other_revision, base_revision,
2465
check_clean=True, ignore_zero=False,
2466
this_dir=None, backup_files=False, merge_type=Merge3Merger,
2467
file_list=None, show_base=False, reprocess=False,
2468
pb=DummyProgress()):
2469
"""Merge changes into a tree.
2472
list(path, revno) Base for three-way merge.
2473
If [None, None] then a base will be automatically determined.
2475
list(path, revno) Other revision for three-way merge.
2477
Directory to merge changes into; '.' by default.
2479
If true, this_dir must have no uncommitted changes before the
2481
ignore_zero - If true, suppress the "zero conflicts" message when
2482
there are no conflicts; should be set when doing something we expect
2483
to complete perfectly.
2484
file_list - If supplied, merge only changes to selected files.
2486
All available ancestors of other_revision and base_revision are
2487
automatically pulled into the branch.
2489
The revno may be -1 to indicate the last revision on the branch, which is
2492
This function is intended for use from the command line; programmatic
2493
clients might prefer to call merge.merge_inner(), which has less magic
2496
from bzrlib.merge import Merger
2497
if this_dir is None:
2499
this_tree = WorkingTree.open_containing(this_dir)[0]
2500
if show_base and not merge_type is Merge3Merger:
2501
raise BzrCommandError("Show-base is not supported for this merge"
2502
" type. %s" % merge_type)
2503
if reprocess and not merge_type.supports_reprocess:
2504
raise BzrCommandError("Conflict reduction is not supported for merge"
2505
" type %s." % merge_type)
2506
if reprocess and show_base:
2507
raise BzrCommandError("Cannot do conflict reduction and show base.")
2509
merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
2510
merger.pp = ProgressPhase("Merge phase", 5, pb)
2511
merger.pp.next_phase()
2512
merger.check_basis(check_clean)
2513
merger.set_other(other_revision)
2514
merger.pp.next_phase()
2515
merger.set_base(base_revision)
2516
if merger.base_rev_id == merger.other_rev_id:
2517
note('Nothing to do.')
2519
merger.backup_files = backup_files
2520
merger.merge_type = merge_type
2521
merger.set_interesting_files(file_list)
2522
merger.show_base = show_base
2523
merger.reprocess = reprocess
2524
conflicts = merger.do_merge()
2525
if file_list is None:
2526
merger.set_pending()
2532
# these get imported and then picked up by the scan for cmd_*
2533
# TODO: Some more consistent way to split command definitions across files;
2534
# we do need to load at least some information about them to know of
2535
# aliases. ideally we would avoid loading the implementation until the
2536
# details were needed.
2537
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2538
from bzrlib.sign_my_commits import cmd_sign_my_commits
2539
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
2540
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
