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"""
23
from shutil import rmtree
28
from bzrlib.branch import Branch
29
import bzrlib.bzrdir as bzrdir
30
from bzrlib.commands import Command, display_command
31
from bzrlib.revision import common_ancestor
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError,
34
NotBranchError, DivergedBranches, NotConflicted,
35
NoSuchFile, NoWorkingTree, FileInWrongBranch,
37
from bzrlib.log import show_one_log
38
from bzrlib.merge import Merge3Merger
39
from bzrlib.option import Option
41
from bzrlib.progress import DummyProgress, ProgressPhase
42
from bzrlib.revisionspec import RevisionSpec
44
from bzrlib.trace import mutter, note, log_error, warning, is_quiet
45
from bzrlib.transport.local import LocalTransport
47
import bzrlib.urlutils as urlutils
48
from bzrlib.workingtree import WorkingTree
51
def tree_files(file_list, default_branch=u'.'):
53
return internal_tree_files(file_list, default_branch)
54
except FileInWrongBranch, e:
55
raise BzrCommandError("%s is not in the same branch as %s" %
56
(e.path, file_list[0]))
59
# XXX: Bad function name; should possibly also be a class method of
60
# WorkingTree rather than a function.
61
def internal_tree_files(file_list, default_branch=u'.'):
62
"""Convert command-line paths to a WorkingTree and relative paths.
64
This is typically used for command-line processors that take one or
65
more filenames, and infer the workingtree that contains them.
67
The filenames given are not required to exist.
69
:param file_list: Filenames to convert.
71
:param default_branch: Fallback tree path to use if file_list is empty or None.
73
:return: workingtree, [relative_paths]
75
if file_list is None or len(file_list) == 0:
76
return WorkingTree.open_containing(default_branch)[0], file_list
77
tree = WorkingTree.open_containing(file_list[0])[0]
79
for filename in file_list:
81
new_list.append(tree.relpath(filename))
82
except errors.PathNotChild:
83
raise FileInWrongBranch(tree.branch, filename)
87
def get_format_type(typestring):
88
"""Parse and return a format specifier."""
89
if typestring == "weave":
90
return bzrdir.BzrDirFormat6()
91
if typestring == "default":
92
return bzrdir.BzrDirMetaFormat1()
93
if typestring == "metaweave":
94
format = bzrdir.BzrDirMetaFormat1()
95
format.repository_format = bzrlib.repository.RepositoryFormat7()
97
if typestring == "knit":
98
format = bzrdir.BzrDirMetaFormat1()
99
format.repository_format = bzrlib.repository.RepositoryFormatKnit1()
101
msg = "Unknown bzr format %s. Current formats are: default, knit,\n" \
102
"metaweave and weave" % typestring
103
raise BzrCommandError(msg)
106
# TODO: Make sure no commands unconditionally use the working directory as a
107
# branch. If a filename argument is used, the first of them should be used to
108
# specify the branch. (Perhaps this can be factored out into some kind of
109
# Argument class, representing a file in a branch, where the first occurrence
112
class cmd_status(Command):
113
"""Display status summary.
115
This reports on versioned and unknown files, reporting them
116
grouped by state. Possible states are:
119
Versioned in the working copy but not in the previous revision.
122
Versioned in the previous revision but removed or deleted
126
Path of this file changed from the previous revision;
127
the text may also have changed. This includes files whose
128
parent directory was renamed.
131
Text has changed since the previous revision.
134
Nothing about this file has changed since the previous revision.
135
Only shown with --all.
138
Not versioned and not matching an ignore pattern.
140
To see ignored files use 'bzr ignored'. For details in the
141
changes to file texts, use 'bzr diff'.
143
If no arguments are specified, the status of the entire working
144
directory is shown. Otherwise, only the status of the specified
145
files or directories is reported. If a directory is given, status
146
is reported for everything inside that directory.
148
If a revision argument is given, the status is calculated against
149
that revision, or between two revisions if two are provided.
152
# TODO: --no-recurse, --recurse options
154
takes_args = ['file*']
155
takes_options = ['all', 'show-ids', 'revision']
156
aliases = ['st', 'stat']
158
encoding_type = 'replace'
161
def run(self, all=False, show_ids=False, file_list=None, revision=None):
162
from bzrlib.status import show_tree_status
164
tree, file_list = tree_files(file_list)
166
show_tree_status(tree, show_unchanged=all, show_ids=show_ids,
167
specific_files=file_list, revision=revision,
171
class cmd_cat_revision(Command):
172
"""Write out metadata for a revision.
174
The revision to print can either be specified by a specific
175
revision identifier, or you can use --revision.
179
takes_args = ['revision_id?']
180
takes_options = ['revision']
183
def run(self, revision_id=None, revision=None):
185
if revision_id is not None and revision is not None:
186
raise BzrCommandError('You can only supply one of revision_id or --revision')
187
if revision_id is None and revision is None:
188
raise BzrCommandError('You must supply either --revision or a revision_id')
189
b = WorkingTree.open_containing(u'.')[0].branch
191
# TODO: jam 20060112 should cat-revision always output utf-8?
192
if revision_id is not None:
193
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
194
elif revision is not None:
197
raise BzrCommandError('You cannot specify a NULL revision.')
198
revno, rev_id = rev.in_history(b)
199
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
202
class cmd_revno(Command):
203
"""Show current revision number.
205
This is equal to the number of revisions on this branch.
208
takes_args = ['location?']
211
def run(self, location=u'.'):
212
self.outf.write(str(Branch.open_containing(location)[0].revno()))
213
self.outf.write('\n')
216
class cmd_revision_info(Command):
217
"""Show revision number and revision id for a given revision identifier.
220
takes_args = ['revision_info*']
221
takes_options = ['revision']
224
def run(self, revision=None, revision_info_list=[]):
227
if revision is not None:
228
revs.extend(revision)
229
if revision_info_list is not None:
230
for rev in revision_info_list:
231
revs.append(RevisionSpec(rev))
233
raise BzrCommandError('You must supply a revision identifier')
235
b = WorkingTree.open_containing(u'.')[0].branch
238
revinfo = rev.in_history(b)
239
if revinfo.revno is None:
240
print ' %s' % revinfo.rev_id
242
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
245
class cmd_add(Command):
246
"""Add specified files or directories.
248
In non-recursive mode, all the named items are added, regardless
249
of whether they were previously ignored. A warning is given if
250
any of the named files are already versioned.
252
In recursive mode (the default), files are treated the same way
253
but the behaviour for directories is different. Directories that
254
are already versioned do not give a warning. All directories,
255
whether already versioned or not, are searched for files or
256
subdirectories that are neither versioned or ignored, and these
257
are added. This search proceeds recursively into versioned
258
directories. If no names are given '.' is assumed.
260
Therefore simply saying 'bzr add' will version all files that
261
are currently unknown.
263
Adding a file whose parent directory is not versioned will
264
implicitly add the parent, and so on up to the root. This means
265
you should never need to explictly add a directory, they'll just
266
get added when you add a file in the directory.
268
--dry-run will show which files would be added, but not actually
271
takes_args = ['file*']
272
takes_options = ['no-recurse', 'dry-run', 'verbose']
273
encoding_type = 'replace'
275
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False):
278
action = bzrlib.add.AddAction(to_file=self.outf,
279
should_add=(not dry_run), should_print=(not is_quiet()))
281
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
284
for glob in sorted(ignored.keys()):
285
match_len = len(ignored[glob])
287
for path in ignored[glob]:
288
self.outf.write("ignored %s matching \"%s\"\n"
291
self.outf.write("ignored %d file(s) matching \"%s\"\n"
293
self.outf.write("If you wish to add some of these files,"
294
" please add them by name.\n")
297
class cmd_mkdir(Command):
298
"""Create a new versioned directory.
300
This is equivalent to creating the directory and then adding it.
302
takes_args = ['dir+']
303
encoding_type = 'replace'
305
def run(self, dir_list):
308
wt, dd = WorkingTree.open_containing(d)
310
print >>self.outf, 'added', d
313
class cmd_relpath(Command):
314
"""Show path of a file relative to root"""
315
takes_args = ['filename']
319
def run(self, filename):
320
# TODO: jam 20050106 Can relpath return a munged path if
321
# sys.stdout encoding cannot represent it?
322
tree, relpath = WorkingTree.open_containing(filename)
323
self.outf.write(relpath)
324
self.outf.write('\n')
327
class cmd_inventory(Command):
328
"""Show inventory of the current working copy or a revision.
330
It is possible to limit the output to a particular entry
331
type using the --kind option. For example; --kind file.
333
takes_options = ['revision', 'show-ids', 'kind']
336
def run(self, revision=None, show_ids=False, kind=None):
337
if kind and kind not in ['file', 'directory', 'symlink']:
338
raise BzrCommandError('invalid kind specified')
339
tree = WorkingTree.open_containing(u'.')[0]
341
inv = tree.read_working_inventory()
343
if len(revision) > 1:
344
raise BzrCommandError('bzr inventory --revision takes'
345
' exactly one revision identifier')
346
inv = tree.branch.repository.get_revision_inventory(
347
revision[0].in_history(tree.branch).rev_id)
349
for path, entry in inv.entries():
350
if kind and kind != entry.kind:
353
self.outf.write('%-50s %s\n' % (path, entry.file_id))
355
self.outf.write(path)
356
self.outf.write('\n')
359
class cmd_mv(Command):
360
"""Move or rename a file.
363
bzr mv OLDNAME NEWNAME
364
bzr mv SOURCE... DESTINATION
366
If the last argument is a versioned directory, all the other names
367
are moved into it. Otherwise, there must be exactly two arguments
368
and the file is changed to a new name, which must not already exist.
370
Files cannot be moved between branches.
372
takes_args = ['names*']
373
aliases = ['move', 'rename']
375
encoding_type = 'replace'
377
def run(self, names_list):
378
if len(names_list) < 2:
379
raise BzrCommandError("missing file argument")
380
tree, rel_names = tree_files(names_list)
382
if os.path.isdir(names_list[-1]):
383
# move into existing directory
384
for pair in tree.move(rel_names[:-1], rel_names[-1]):
385
self.outf.write("%s => %s\n" % pair)
387
if len(names_list) != 2:
388
raise BzrCommandError('to mv multiple files the destination '
389
'must be a versioned directory')
390
tree.rename_one(rel_names[0], rel_names[1])
391
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
394
class cmd_pull(Command):
395
"""Turn this branch into a mirror of another branch.
397
This command only works on branches that have not diverged. Branches are
398
considered diverged if the destination branch's most recent commit is one
399
that has not been merged (directly or indirectly) into the parent.
401
If branches have diverged, you can use 'bzr merge' to integrate the changes
402
from one into the other. Once one branch has merged, the other should
403
be able to pull it again.
405
If branches have diverged, you can use 'bzr merge' to pull the text changes
406
from one into the other. Once one branch has merged, the other should
407
be able to pull it again.
409
If you want to forget your local changes and just update your branch to
410
match the remote one, use pull --overwrite.
412
If there is no default location set, the first pull will set it. After
413
that, you can omit the location to use the default. To change the
414
default, use --remember.
416
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
417
takes_args = ['location?']
418
encoding_type = 'replace'
420
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
421
# FIXME: too much stuff is in the command class
423
tree_to = WorkingTree.open_containing(u'.')[0]
424
branch_to = tree_to.branch
425
except NoWorkingTree:
427
branch_to = Branch.open_containing(u'.')[0]
428
stored_loc = branch_to.get_parent()
430
if stored_loc is None:
431
raise BzrCommandError("No pull location known or specified.")
433
self.outf.write("Using saved location: %s\n"
434
% urlutils.unescape_for_display(stored_loc))
435
location = stored_loc
437
branch_from = Branch.open(location)
439
if branch_to.get_parent() is None or remember:
440
branch_to.set_parent(branch_from.base)
445
elif len(revision) == 1:
446
rev_id = revision[0].in_history(branch_from).rev_id
448
raise BzrCommandError('bzr pull --revision takes one value.')
450
old_rh = branch_to.revision_history()
451
if tree_to is not None:
452
count = tree_to.pull(branch_from, overwrite, rev_id)
454
count = branch_to.pull(branch_from, overwrite, rev_id)
455
note('%d revision(s) pulled.' % (count,))
458
new_rh = branch_to.revision_history()
461
from bzrlib.log import show_changed_revisions
462
show_changed_revisions(branch_to, old_rh, new_rh,
466
class cmd_push(Command):
467
"""Update a mirror of this branch.
469
The target branch will not have its working tree populated because this
470
is both expensive, and is not supported on remote file systems.
472
Some smart servers or protocols *may* put the working tree in place in
475
This command only works on branches that have not diverged. Branches are
476
considered diverged if the destination branch's most recent commit is one
477
that has not been merged (directly or indirectly) by the source branch.
479
If branches have diverged, you can use 'bzr push --overwrite' to replace
480
the other branch completely, discarding its unmerged changes.
482
If you want to ensure you have the different changes in the other branch,
483
do a merge (see bzr help merge) from the other branch, and commit that.
484
After that you will be able to do a push without '--overwrite'.
486
If there is no default push location set, the first push will set it.
487
After that, you can omit the location to use the default. To change the
488
default, use --remember.
490
takes_options = ['remember', 'overwrite', 'verbose',
491
Option('create-prefix',
492
help='Create the path leading up to the branch '
493
'if it does not already exist')]
494
takes_args = ['location?']
495
encoding_type = 'replace'
497
def run(self, location=None, remember=False, overwrite=False,
498
create_prefix=False, verbose=False):
499
# FIXME: Way too big! Put this into a function called from the
501
from bzrlib.transport import get_transport
503
br_from = Branch.open_containing('.')[0]
504
stored_loc = br_from.get_push_location()
506
if stored_loc is None:
507
raise BzrCommandError("No push location known or specified.")
509
self.outf.write("Using saved location: %s"
510
% urlutils.unescape_for_display(stored_loc))
511
location = stored_loc
513
transport = get_transport(location)
514
location_url = transport.base
515
if br_from.get_push_location() is None or remember:
516
br_from.set_push_location(location_url)
518
dir_to = bzrlib.bzrdir.BzrDir.open(location_url)
519
br_to = dir_to.open_branch()
520
except NotBranchError:
522
transport = transport.clone('..')
523
if not create_prefix:
525
relurl = transport.relpath(location_url)
526
mutter('creating directory %s => %s', location_url, relurl)
527
transport.mkdir(relurl)
529
raise BzrCommandError("Parent directory of %s "
530
"does not exist." % location)
532
current = transport.base
533
needed = [(transport, transport.relpath(location_url))]
536
transport, relpath = needed[-1]
537
transport.mkdir(relpath)
540
new_transport = transport.clone('..')
541
needed.append((new_transport,
542
new_transport.relpath(transport.base)))
543
if new_transport.base == transport.base:
544
raise BzrCommandError("Could not create "
546
dir_to = br_from.bzrdir.clone(location_url)
547
br_to = dir_to.open_branch()
548
old_rh = br_to.revision_history()
551
tree_to = dir_to.open_workingtree()
552
except errors.NotLocalUrl:
553
# TODO: This should be updated for branches which don't have a
554
# working tree, as opposed to ones where we just couldn't
556
warning('This transport does not update the working '
557
'tree of: %s' % (br_to.base,))
558
count = br_to.pull(br_from, overwrite)
559
except NoWorkingTree:
560
count = br_to.pull(br_from, overwrite)
562
count = tree_to.pull(br_from, overwrite)
563
except DivergedBranches:
564
raise BzrCommandError("These branches have diverged."
565
" Try a merge then push with overwrite.")
566
note('%d revision(s) pushed.' % (count,))
569
new_rh = br_to.revision_history()
572
from bzrlib.log import show_changed_revisions
573
show_changed_revisions(br_to, old_rh, new_rh,
577
class cmd_branch(Command):
578
"""Create a new copy of a branch.
580
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
581
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
583
To retrieve the branch as of a particular revision, supply the --revision
584
parameter, as in "branch foo/bar -r 5".
586
--basis is to speed up branching from remote branches. When specified, it
587
copies all the file-contents, inventory and revision data from the basis
588
branch before copying anything from the remote branch.
590
takes_args = ['from_location', 'to_location?']
591
takes_options = ['revision', 'basis']
592
aliases = ['get', 'clone']
594
def run(self, from_location, to_location=None, revision=None, basis=None):
595
from bzrlib.transport import get_transport
596
from bzrlib.osutils import rmtree
599
elif len(revision) > 1:
600
raise BzrCommandError(
601
'bzr branch --revision takes exactly 1 revision value')
603
br_from = Branch.open(from_location)
605
if e.errno == errno.ENOENT:
606
raise BzrCommandError('Source location "%s" does not'
607
' exist.' % to_location)
612
if basis is not None:
613
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
616
if len(revision) == 1 and revision[0] is not None:
617
revision_id = revision[0].in_history(br_from)[1]
619
# FIXME - wt.last_revision, fallback to branch, fall back to
620
# None or perhaps NULL_REVISION to mean copy nothing
622
revision_id = br_from.last_revision()
623
if to_location is None:
624
to_location = os.path.basename(from_location.rstrip("/\\"))
627
name = os.path.basename(to_location) + '\n'
629
to_transport = get_transport(to_location)
631
to_transport.mkdir('.')
632
except bzrlib.errors.FileExists:
633
raise BzrCommandError('Target directory "%s" already'
634
' exists.' % to_location)
635
except bzrlib.errors.NoSuchFile:
636
raise BzrCommandError('Parent of "%s" does not exist.' %
639
# preserve whatever source format we have.
640
dir = br_from.bzrdir.sprout(to_transport.base,
641
revision_id, basis_dir)
642
branch = dir.open_branch()
643
except bzrlib.errors.NoSuchRevision:
644
# TODO: jam 20060426 This only works on local paths
645
# and it would be nice if 'bzr branch' could
646
# work on a remote path
648
msg = "The branch %s has no revision %s." % (from_location, revision[0])
649
raise BzrCommandError(msg)
650
except bzrlib.errors.UnlistableBranch:
652
msg = "The branch %s cannot be used as a --basis" % (basis,)
653
raise BzrCommandError(msg)
655
branch.control_files.put_utf8('branch-name', name)
656
note('Branched %d revision(s).' % branch.revno())
661
class cmd_checkout(Command):
662
"""Create a new checkout of an existing branch.
664
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
665
the branch found in '.'. This is useful if you have removed the working tree
666
or if it was never created - i.e. if you pushed the branch to its current
669
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
670
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
672
To retrieve the branch as of a particular revision, supply the --revision
673
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
674
out of date [so you cannot commit] but it may be useful (i.e. to examine old
677
--basis is to speed up checking out from remote branches. When specified, it
678
uses the inventory and file contents from the basis branch in preference to the
679
branch being checked out.
681
takes_args = ['branch_location?', 'to_location?']
682
takes_options = ['revision', # , 'basis']
683
Option('lightweight',
684
help="perform a lightweight checkout. Lightweight "
685
"checkouts depend on access to the branch for "
686
"every operation. Normal checkouts can perform "
687
"common operations like diff and status without "
688
"such access, and also support local commits."
692
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
696
elif len(revision) > 1:
697
raise BzrCommandError(
698
'bzr checkout --revision takes exactly 1 revision value')
699
if branch_location is None:
700
branch_location = bzrlib.osutils.getcwd()
701
to_location = branch_location
702
source = Branch.open(branch_location)
703
if len(revision) == 1 and revision[0] is not None:
704
revision_id = revision[0].in_history(source)[1]
707
if to_location is None:
708
to_location = os.path.basename(branch_location.rstrip("/\\"))
709
# if the source and to_location are the same,
710
# and there is no working tree,
711
# then reconstitute a branch
712
if (bzrlib.osutils.abspath(to_location) ==
713
bzrlib.osutils.abspath(branch_location)):
715
source.bzrdir.open_workingtree()
716
except errors.NoWorkingTree:
717
source.bzrdir.create_workingtree()
720
os.mkdir(to_location)
722
if e.errno == errno.EEXIST:
723
raise BzrCommandError('Target directory "%s" already'
724
' exists.' % to_location)
725
if e.errno == errno.ENOENT:
726
raise BzrCommandError('Parent of "%s" does not exist.' %
730
old_format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
731
bzrlib.bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
734
checkout = bzrdir.BzrDirMetaFormat1().initialize(to_location)
735
bzrlib.branch.BranchReferenceFormat().initialize(checkout, source)
737
checkout_branch = bzrlib.bzrdir.BzrDir.create_branch_convenience(
738
to_location, force_new_tree=False)
739
checkout = checkout_branch.bzrdir
740
checkout_branch.bind(source)
741
if revision_id is not None:
742
rh = checkout_branch.revision_history()
743
checkout_branch.set_revision_history(rh[:rh.index(revision_id) + 1])
744
checkout.create_workingtree(revision_id)
746
bzrlib.bzrdir.BzrDirFormat.set_default_format(old_format)
749
class cmd_renames(Command):
750
"""Show list of renamed files.
752
# TODO: Option to show renames between two historical versions.
754
# TODO: Only show renames under dir, rather than in the whole branch.
755
takes_args = ['dir?']
758
def run(self, dir=u'.'):
759
tree = WorkingTree.open_containing(dir)[0]
760
old_inv = tree.basis_tree().inventory
761
new_inv = tree.read_working_inventory()
763
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
765
for old_name, new_name in renames:
766
self.outf.write("%s => %s\n" % (old_name, new_name))
769
class cmd_update(Command):
770
"""Update a tree to have the latest code committed to its branch.
772
This will perform a merge into the working tree, and may generate
773
conflicts. If you have any local changes, you will still
774
need to commit them after the update for the update to be complete.
776
If you want to discard your local changes, you can just do a
777
'bzr revert' instead of 'bzr commit' after the update.
779
takes_args = ['dir?']
781
def run(self, dir='.'):
782
tree = WorkingTree.open_containing(dir)[0]
785
if tree.last_revision() == tree.branch.last_revision():
786
# may be up to date, check master too.
787
master = tree.branch.get_master_branch()
788
if master is None or master.last_revision == tree.last_revision():
789
note("Tree is up to date.")
791
conflicts = tree.update()
792
note('Updated to revision %d.' %
793
(tree.branch.revision_id_to_revno(tree.last_revision()),))
802
class cmd_info(Command):
803
"""Show information about a working tree, branch or repository.
805
This command will show all known locations and formats associated to the
806
tree, branch or repository. Statistical information is included with
809
Branches and working trees will also report any missing revisions.
811
takes_args = ['location?']
812
takes_options = ['verbose']
815
def run(self, location=None, verbose=False):
816
from bzrlib.info import show_bzrdir_info
817
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
821
class cmd_remove(Command):
822
"""Make a file unversioned.
824
This makes bzr stop tracking changes to a versioned file. It does
825
not delete the working copy.
827
takes_args = ['file+']
828
takes_options = ['verbose']
831
def run(self, file_list, verbose=False):
832
tree, file_list = tree_files(file_list)
833
tree.remove(file_list, verbose=verbose)
836
class cmd_file_id(Command):
837
"""Print file_id of a particular file or directory.
839
The file_id is assigned when the file is first added and remains the
840
same through all revisions where the file exists, even when it is
844
takes_args = ['filename']
847
def run(self, filename):
848
tree, relpath = WorkingTree.open_containing(filename)
849
i = tree.inventory.path2id(relpath)
851
raise BzrError("%r is not a versioned file" % filename)
854
self.outf.write('\n')
857
class cmd_file_path(Command):
858
"""Print path of file_ids to a file or directory.
860
This prints one line for each directory down to the target,
861
starting at the branch root.
864
takes_args = ['filename']
867
def run(self, filename):
868
tree, relpath = WorkingTree.open_containing(filename)
870
fid = inv.path2id(relpath)
872
raise BzrError("%r is not a versioned file" % filename)
873
for fip in inv.get_idpath(fid):
875
self.outf.write('\n')
878
class cmd_reconcile(Command):
879
"""Reconcile bzr metadata in a branch.
881
This can correct data mismatches that may have been caused by
882
previous ghost operations or bzr upgrades. You should only
883
need to run this command if 'bzr check' or a bzr developer
884
advises you to run it.
886
If a second branch is provided, cross-branch reconciliation is
887
also attempted, which will check that data like the tree root
888
id which was not present in very early bzr versions is represented
889
correctly in both branches.
891
At the same time it is run it may recompress data resulting in
892
a potential saving in disk space or performance gain.
894
The branch *MUST* be on a listable system such as local disk or sftp.
896
takes_args = ['branch?']
898
def run(self, branch="."):
899
from bzrlib.reconcile import reconcile
900
dir = bzrlib.bzrdir.BzrDir.open(branch)
904
class cmd_revision_history(Command):
905
"""Display list of revision ids on this branch."""
910
branch = WorkingTree.open_containing(u'.')[0].branch
911
for patchid in branch.revision_history():
912
self.outf.write(patchid)
913
self.outf.write('\n')
916
class cmd_ancestry(Command):
917
"""List all revisions merged into this branch."""
922
tree = WorkingTree.open_containing(u'.')[0]
924
# FIXME. should be tree.last_revision
925
for revision_id in b.repository.get_ancestry(b.last_revision()):
926
if revision_id is None:
928
self.outf.write(revision_id)
929
self.outf.write('\n')
932
class cmd_init(Command):
933
"""Make a directory into a versioned branch.
935
Use this to create an empty branch, or before importing an
938
If there is a repository in a parent directory of the location, then
939
the history of the branch will be stored in the repository. Otherwise
940
init creates a standalone branch which carries its own history in
943
If there is already a branch at the location but it has no working tree,
944
the tree can be populated with 'bzr checkout'.
946
Recipe for importing a tree of files:
951
bzr commit -m 'imported project'
953
takes_args = ['location?']
956
help='Specify a format for this branch. Current'
957
' formats are: default, knit, metaweave and'
958
' weave. Default is knit; metaweave and'
959
' weave are deprecated',
960
type=get_format_type),
962
def run(self, location=None, format=None):
963
from bzrlib.branch import Branch
965
format = get_format_type('default')
969
# The path has to exist to initialize a
970
# branch inside of it.
971
# Just using os.mkdir, since I don't
972
# believe that we want to create a bunch of
973
# locations if the user supplies an extended path
974
if not os.path.exists(location):
977
existing_bzrdir = bzrdir.BzrDir.open(location)
978
except NotBranchError:
979
# really a NotBzrDir error...
980
bzrdir.BzrDir.create_branch_convenience(location, format=format)
982
if existing_bzrdir.has_branch():
983
if existing_bzrdir.has_workingtree():
984
raise errors.AlreadyBranchError(location)
986
raise errors.BranchExistsWithoutWorkingTree(location)
988
existing_bzrdir.create_branch()
989
existing_bzrdir.create_workingtree()
992
class cmd_init_repository(Command):
993
"""Create a shared repository to hold branches.
995
New branches created under the repository directory will store their revisions
996
in the repository, not in the branch directory, if the branch format supports
1002
bzr checkout --lightweight repo/trunk trunk-checkout
1006
takes_args = ["location"]
1007
takes_options = [Option('format',
1008
help='Specify a format for this repository.'
1009
' Current formats are: default, knit,'
1010
' metaweave and weave. Default is knit;'
1011
' metaweave and weave are deprecated',
1012
type=get_format_type),
1014
help='Allows branches in repository to have'
1016
aliases = ["init-repo"]
1017
def run(self, location, format=None, trees=False):
1018
from bzrlib.transport import get_transport
1020
format = get_format_type('default')
1021
transport = get_transport(location)
1022
if not transport.has('.'):
1024
newdir = format.initialize_on_transport(transport)
1025
repo = newdir.create_repository(shared=True)
1026
repo.set_make_working_trees(trees)
1029
class cmd_diff(Command):
1030
"""Show differences in working tree.
1032
If files are listed, only the changes in those files are listed.
1033
Otherwise, all changes for the tree are listed.
1035
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1036
produces patches suitable for "patch -p1".
1042
bzr diff --diff-prefix old/:new/
1043
bzr diff bzr.mine bzr.dev
1046
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1047
# or a graphical diff.
1049
# TODO: Python difflib is not exactly the same as unidiff; should
1050
# either fix it up or prefer to use an external diff.
1052
# TODO: Selected-file diff is inefficient and doesn't show you
1055
# TODO: This probably handles non-Unix newlines poorly.
1057
takes_args = ['file*']
1058
takes_options = ['revision', 'diff-options', 'prefix']
1059
aliases = ['di', 'dif']
1060
encoding_type = 'exact'
1063
def run(self, revision=None, file_list=None, diff_options=None,
1065
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1067
if (prefix is None) or (prefix == '0'):
1075
if not ':' in prefix:
1076
raise BzrError("--diff-prefix expects two values separated by a colon")
1077
old_label, new_label = prefix.split(":")
1080
tree1, file_list = internal_tree_files(file_list)
1084
except FileInWrongBranch:
1085
if len(file_list) != 2:
1086
raise BzrCommandError("Files are in different branches")
1088
tree1, file1 = WorkingTree.open_containing(file_list[0])
1089
tree2, file2 = WorkingTree.open_containing(file_list[1])
1090
if file1 != "" or file2 != "":
1091
# FIXME diff those two files. rbc 20051123
1092
raise BzrCommandError("Files are in different branches")
1094
if revision is not None:
1095
if tree2 is not None:
1096
raise BzrCommandError("Can't specify -r with two branches")
1097
if (len(revision) == 1) or (revision[1].spec is None):
1098
return diff_cmd_helper(tree1, file_list, diff_options,
1100
old_label=old_label, new_label=new_label)
1101
elif len(revision) == 2:
1102
return diff_cmd_helper(tree1, file_list, diff_options,
1103
revision[0], revision[1],
1104
old_label=old_label, new_label=new_label)
1106
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
1108
if tree2 is not None:
1109
return show_diff_trees(tree1, tree2, sys.stdout,
1110
specific_files=file_list,
1111
external_diff_options=diff_options,
1112
old_label=old_label, new_label=new_label)
1114
return diff_cmd_helper(tree1, file_list, diff_options,
1115
old_label=old_label, new_label=new_label)
1118
class cmd_deleted(Command):
1119
"""List files deleted in the working tree.
1121
# TODO: Show files deleted since a previous revision, or
1122
# between two revisions.
1123
# TODO: Much more efficient way to do this: read in new
1124
# directories with readdir, rather than stating each one. Same
1125
# level of effort but possibly much less IO. (Or possibly not,
1126
# if the directories are very large...)
1127
takes_options = ['show-ids']
1130
def run(self, show_ids=False):
1131
tree = WorkingTree.open_containing(u'.')[0]
1132
old = tree.basis_tree()
1133
for path, ie in old.inventory.iter_entries():
1134
if not tree.has_id(ie.file_id):
1135
self.outf.write(path)
1137
self.outf.write(' ')
1138
self.outf.write(ie.file_id)
1139
self.outf.write('\n')
1142
class cmd_modified(Command):
1143
"""List files modified in working tree."""
1147
from bzrlib.delta import compare_trees
1149
tree = WorkingTree.open_containing(u'.')[0]
1150
td = compare_trees(tree.basis_tree(), tree)
1152
for path, id, kind, text_modified, meta_modified in td.modified:
1153
self.outf.write(path)
1154
self.outf.write('\n')
1157
class cmd_added(Command):
1158
"""List files added in working tree."""
1162
wt = WorkingTree.open_containing(u'.')[0]
1163
basis_inv = wt.basis_tree().inventory
1166
if file_id in basis_inv:
1168
path = inv.id2path(file_id)
1169
if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
1171
self.outf.write(path)
1172
self.outf.write('\n')
1175
class cmd_root(Command):
1176
"""Show the tree root directory.
1178
The root is the nearest enclosing directory with a .bzr control
1180
takes_args = ['filename?']
1182
def run(self, filename=None):
1183
"""Print the branch root."""
1184
tree = WorkingTree.open_containing(filename)[0]
1185
self.outf.write(tree.basedir)
1186
self.outf.write('\n')
1189
class cmd_log(Command):
1190
"""Show log of a branch, file, or directory.
1192
By default show the log of the branch containing the working directory.
1194
To request a range of logs, you can use the command -r begin..end
1195
-r revision requests a specific revision, -r ..end or -r begin.. are
1201
bzr log -r -10.. http://server/branch
1204
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1206
takes_args = ['location?']
1207
takes_options = [Option('forward',
1208
help='show from oldest to newest'),
1211
help='show files changed in each revision'),
1212
'show-ids', 'revision',
1216
help='show revisions whose message matches this regexp',
1220
encoding_type = 'replace'
1223
def run(self, location=None, timezone='original',
1233
from bzrlib.log import log_formatter, show_log
1234
assert message is None or isinstance(message, basestring), \
1235
"invalid message argument %r" % message
1236
direction = (forward and 'forward') or 'reverse'
1241
# find the file id to log:
1243
dir, fp = bzrdir.BzrDir.open_containing(location)
1244
b = dir.open_branch()
1248
inv = dir.open_workingtree().inventory
1249
except (errors.NotBranchError, errors.NotLocalUrl):
1250
# either no tree, or is remote.
1251
inv = b.basis_tree().inventory
1252
file_id = inv.path2id(fp)
1255
# FIXME ? log the current subdir only RBC 20060203
1256
dir, relpath = bzrdir.BzrDir.open_containing('.')
1257
b = dir.open_branch()
1259
if revision is None:
1262
elif len(revision) == 1:
1263
rev1 = rev2 = revision[0].in_history(b).revno
1264
elif len(revision) == 2:
1265
if revision[0].spec is None:
1266
# missing begin-range means first revision
1269
rev1 = revision[0].in_history(b).revno
1271
if revision[1].spec is None:
1272
# missing end-range means last known revision
1275
rev2 = revision[1].in_history(b).revno
1277
raise BzrCommandError('bzr log --revision takes one or two values.')
1279
# By this point, the revision numbers are converted to the +ve
1280
# form if they were supplied in the -ve form, so we can do
1281
# this comparison in relative safety
1283
(rev2, rev1) = (rev1, rev2)
1285
if (log_format == None):
1286
default = bzrlib.config.BranchConfig(b).log_format()
1287
log_format = get_log_format(long=long, short=short, line=line, default=default)
1288
lf = log_formatter(log_format,
1291
show_timezone=timezone)
1297
direction=direction,
1298
start_revision=rev1,
1303
def get_log_format(long=False, short=False, line=False, default='long'):
1304
log_format = default
1308
log_format = 'short'
1314
class cmd_touching_revisions(Command):
1315
"""Return revision-ids which affected a particular file.
1317
A more user-friendly interface is "bzr log FILE"."""
1319
takes_args = ["filename"]
1320
encoding_type = 'replace'
1323
def run(self, filename):
1324
tree, relpath = WorkingTree.open_containing(filename)
1326
inv = tree.read_working_inventory()
1327
file_id = inv.path2id(relpath)
1328
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1329
self.outf.write("%6d %s\n" % (revno, what))
1332
class cmd_ls(Command):
1333
"""List files in a tree.
1335
# TODO: Take a revision or remote path and list that tree instead.
1337
takes_options = ['verbose', 'revision',
1338
Option('non-recursive',
1339
help='don\'t recurse into sub-directories'),
1341
help='Print all paths from the root of the branch.'),
1342
Option('unknown', help='Print unknown files'),
1343
Option('versioned', help='Print versioned files'),
1344
Option('ignored', help='Print ignored files'),
1346
Option('null', help='Null separate the files'),
1349
def run(self, revision=None, verbose=False,
1350
non_recursive=False, from_root=False,
1351
unknown=False, versioned=False, ignored=False,
1354
if verbose and null:
1355
raise BzrCommandError('Cannot set both --verbose and --null')
1356
all = not (unknown or versioned or ignored)
1358
selection = {'I':ignored, '?':unknown, 'V':versioned}
1360
tree, relpath = WorkingTree.open_containing(u'.')
1365
if revision is not None:
1366
tree = tree.branch.repository.revision_tree(
1367
revision[0].in_history(tree.branch).rev_id)
1369
for fp, fc, kind, fid, entry in tree.list_files():
1370
if fp.startswith(relpath):
1371
fp = fp[len(relpath):]
1372
if non_recursive and '/' in fp:
1374
if not all and not selection[fc]:
1377
kindch = entry.kind_character()
1378
self.outf.write('%-8s %s%s\n' % (fc, fp, kindch))
1381
self.outf.write('\0')
1385
self.outf.write('\n')
1388
class cmd_unknowns(Command):
1389
"""List unknown files."""
1392
from bzrlib.osutils import quotefn
1393
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1394
self.outf.write(quotefn(f))
1395
self.outf.write('\n')
1398
class cmd_ignore(Command):
1399
"""Ignore a command or pattern.
1401
To remove patterns from the ignore list, edit the .bzrignore file.
1403
If the pattern contains a slash, it is compared to the whole path
1404
from the branch root. Otherwise, it is compared to only the last
1405
component of the path. To match a file only in the root directory,
1408
Ignore patterns are case-insensitive on case-insensitive systems.
1410
Note: wildcards must be quoted from the shell on Unix.
1413
bzr ignore ./Makefile
1414
bzr ignore '*.class'
1416
# TODO: Complain if the filename is absolute
1417
takes_args = ['name_pattern']
1419
def run(self, name_pattern):
1420
from bzrlib.atomicfile import AtomicFile
1423
tree, relpath = WorkingTree.open_containing(u'.')
1424
ifn = tree.abspath('.bzrignore')
1426
if os.path.exists(ifn):
1429
igns = f.read().decode('utf-8')
1435
# TODO: If the file already uses crlf-style termination, maybe
1436
# we should use that for the newly added lines?
1438
if igns and igns[-1] != '\n':
1440
igns += name_pattern + '\n'
1443
f = AtomicFile(ifn, 'wt')
1444
f.write(igns.encode('utf-8'))
1449
inv = tree.inventory
1450
if inv.path2id('.bzrignore'):
1451
mutter('.bzrignore is already versioned')
1453
mutter('need to make new .bzrignore file versioned')
1454
tree.add(['.bzrignore'])
1457
class cmd_ignored(Command):
1458
"""List ignored files and the patterns that matched them.
1460
See also: bzr ignore"""
1463
tree = WorkingTree.open_containing(u'.')[0]
1464
for path, file_class, kind, file_id, entry in tree.list_files():
1465
if file_class != 'I':
1467
## XXX: Slightly inefficient since this was already calculated
1468
pat = tree.is_ignored(path)
1469
print '%-50s %s' % (path, pat)
1472
class cmd_lookup_revision(Command):
1473
"""Lookup the revision-id from a revision-number
1476
bzr lookup-revision 33
1479
takes_args = ['revno']
1482
def run(self, revno):
1486
raise BzrCommandError("not a valid revision-number: %r" % revno)
1488
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1491
class cmd_export(Command):
1492
"""Export past revision to destination directory.
1494
If no revision is specified this exports the last committed revision.
1496
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1497
given, try to find the format with the extension. If no extension
1498
is found exports to a directory (equivalent to --format=dir).
1500
Root may be the top directory for tar, tgz and tbz2 formats. If none
1501
is given, the top directory will be the root name of the file.
1503
Note: export of tree with non-ascii filenames to zip is not supported.
1505
Supported formats Autodetected by extension
1506
----------------- -------------------------
1509
tbz2 .tar.bz2, .tbz2
1513
takes_args = ['dest']
1514
takes_options = ['revision', 'format', 'root']
1515
def run(self, dest, revision=None, format=None, root=None):
1517
from bzrlib.export import export
1518
tree = WorkingTree.open_containing(u'.')[0]
1520
if revision is None:
1521
# should be tree.last_revision FIXME
1522
rev_id = b.last_revision()
1524
if len(revision) != 1:
1525
raise BzrError('bzr export --revision takes exactly 1 argument')
1526
rev_id = revision[0].in_history(b).rev_id
1527
t = b.repository.revision_tree(rev_id)
1529
export(t, dest, format, root)
1530
except errors.NoSuchExportFormat, e:
1531
raise BzrCommandError('Unsupported export format: %s' % e.format)
1534
class cmd_cat(Command):
1535
"""Write a file's text from a previous revision."""
1537
takes_options = ['revision']
1538
takes_args = ['filename']
1541
def run(self, filename, revision=None):
1542
if revision is not None and len(revision) != 1:
1543
raise BzrCommandError("bzr cat --revision takes exactly one number")
1546
tree, relpath = WorkingTree.open_containing(filename)
1548
except NotBranchError:
1552
b, relpath = Branch.open_containing(filename)
1553
if revision is None:
1554
revision_id = b.last_revision()
1556
revision_id = revision[0].in_history(b).rev_id
1557
b.print_file(relpath, revision_id)
1560
class cmd_local_time_offset(Command):
1561
"""Show the offset in seconds from GMT to local time."""
1565
print bzrlib.osutils.local_time_offset()
1569
class cmd_commit(Command):
1570
"""Commit changes into a new revision.
1572
If no arguments are given, the entire tree is committed.
1574
If selected files are specified, only changes to those files are
1575
committed. If a directory is specified then the directory and everything
1576
within it is committed.
1578
A selected-file commit may fail in some cases where the committed
1579
tree would be invalid, such as trying to commit a file in a
1580
newly-added directory that is not itself committed.
1582
# TODO: Run hooks on tree to-be-committed, and after commit.
1584
# TODO: Strict commit that fails if there are deleted files.
1585
# (what does "deleted files" mean ??)
1587
# TODO: Give better message for -s, --summary, used by tla people
1589
# XXX: verbose currently does nothing
1591
takes_args = ['selected*']
1592
takes_options = ['message', 'verbose',
1594
help='commit even if nothing has changed'),
1595
Option('file', type=str,
1597
help='file containing commit message'),
1599
help="refuse to commit if there are unknown "
1600
"files in the working tree."),
1602
help="perform a local only commit in a bound "
1603
"branch. Such commits are not pushed to "
1604
"the master branch until a normal commit "
1608
aliases = ['ci', 'checkin']
1610
def run(self, message=None, file=None, verbose=True, selected_list=None,
1611
unchanged=False, strict=False, local=False):
1612
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1613
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1615
from bzrlib.msgeditor import edit_commit_message, \
1616
make_commit_message_template
1617
from tempfile import TemporaryFile
1619
# TODO: Need a blackbox test for invoking the external editor; may be
1620
# slightly problematic to run this cross-platform.
1622
# TODO: do more checks that the commit will succeed before
1623
# spending the user's valuable time typing a commit message.
1625
# TODO: if the commit *does* happen to fail, then save the commit
1626
# message to a temporary file where it can be recovered
1627
tree, selected_list = tree_files(selected_list)
1628
if local and not tree.branch.get_bound_location():
1629
raise errors.LocalRequiresBoundBranch()
1630
if message is None and not file:
1631
template = make_commit_message_template(tree, selected_list)
1632
message = edit_commit_message(template)
1634
raise BzrCommandError("please specify a commit message"
1635
" with either --message or --file")
1636
elif message and file:
1637
raise BzrCommandError("please specify either --message or --file")
1640
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1643
raise BzrCommandError("empty commit message specified")
1646
reporter = ReportCommitToLog()
1648
reporter = NullCommitReporter()
1651
tree.commit(message, specific_files=selected_list,
1652
allow_pointless=unchanged, strict=strict, local=local,
1654
except PointlessCommit:
1655
# FIXME: This should really happen before the file is read in;
1656
# perhaps prepare the commit; get the message; then actually commit
1657
raise BzrCommandError("no changes to commit",
1658
["use --unchanged to commit anyhow"])
1659
except ConflictsInTree:
1660
raise BzrCommandError("Conflicts detected in working tree. "
1661
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1662
except StrictCommitFailed:
1663
raise BzrCommandError("Commit refused because there are unknown "
1664
"files in the working tree.")
1665
except errors.BoundBranchOutOfDate, e:
1666
raise BzrCommandError(str(e)
1667
+ ' Either unbind, update, or'
1668
' pass --local to commit.')
1671
class cmd_check(Command):
1672
"""Validate consistency of branch history.
1674
This command checks various invariants about the branch storage to
1675
detect data corruption or bzr bugs.
1677
takes_args = ['branch?']
1678
takes_options = ['verbose']
1680
def run(self, branch=None, verbose=False):
1681
from bzrlib.check import check
1683
tree = WorkingTree.open_containing()[0]
1684
branch = tree.branch
1686
branch = Branch.open(branch)
1687
check(branch, verbose)
1690
class cmd_scan_cache(Command):
1693
from bzrlib.hashcache import HashCache
1699
print '%6d stats' % c.stat_count
1700
print '%6d in hashcache' % len(c._cache)
1701
print '%6d files removed from cache' % c.removed_count
1702
print '%6d hashes updated' % c.update_count
1703
print '%6d files changed too recently to cache' % c.danger_count
1709
class cmd_upgrade(Command):
1710
"""Upgrade branch storage to current format.
1712
The check command or bzr developers may sometimes advise you to run
1713
this command. When the default format has changed you may also be warned
1714
during other operations to upgrade.
1716
takes_args = ['url?']
1719
help='Upgrade to a specific format. Current formats'
1720
' are: default, knit, metaweave and weave.'
1721
' Default is knit; metaweave and weave are'
1723
type=get_format_type),
1727
def run(self, url='.', format=None):
1728
from bzrlib.upgrade import upgrade
1730
format = get_format_type('default')
1731
upgrade(url, format)
1734
class cmd_whoami(Command):
1735
"""Show bzr user id."""
1736
takes_options = ['email']
1739
def run(self, email=False):
1741
b = WorkingTree.open_containing(u'.')[0].branch
1742
config = bzrlib.config.BranchConfig(b)
1743
except NotBranchError:
1744
config = bzrlib.config.GlobalConfig()
1747
print config.user_email()
1749
print config.username()
1752
class cmd_nick(Command):
1753
"""Print or set the branch nickname.
1755
If unset, the tree root directory name is used as the nickname
1756
To print the current nickname, execute with no argument.
1758
takes_args = ['nickname?']
1759
def run(self, nickname=None):
1760
branch = Branch.open_containing(u'.')[0]
1761
if nickname is None:
1762
self.printme(branch)
1764
branch.nick = nickname
1767
def printme(self, branch):
1771
class cmd_selftest(Command):
1772
"""Run internal test suite.
1774
This creates temporary test directories in the working directory,
1775
but not existing data is affected. These directories are deleted
1776
if the tests pass, or left behind to help in debugging if they
1777
fail and --keep-output is specified.
1779
If arguments are given, they are regular expressions that say
1780
which tests should run.
1782
If the global option '--no-plugins' is given, plugins are not loaded
1783
before running the selftests. This has two effects: features provided or
1784
modified by plugins will not be tested, and tests provided by plugins will
1789
bzr --no-plugins selftest -v
1791
# TODO: --list should give a list of all available tests
1793
# NB: this is used from the class without creating an instance, which is
1794
# why it does not have a self parameter.
1795
def get_transport_type(typestring):
1796
"""Parse and return a transport specifier."""
1797
if typestring == "sftp":
1798
from bzrlib.transport.sftp import SFTPAbsoluteServer
1799
return SFTPAbsoluteServer
1800
if typestring == "memory":
1801
from bzrlib.transport.memory import MemoryServer
1803
if typestring == "fakenfs":
1804
from bzrlib.transport.fakenfs import FakeNFSServer
1805
return FakeNFSServer
1806
msg = "No known transport type %s. Supported types are: sftp\n" %\
1808
raise BzrCommandError(msg)
1811
takes_args = ['testspecs*']
1812
takes_options = ['verbose',
1813
Option('one', help='stop when one test fails'),
1814
Option('keep-output',
1815
help='keep output directories when tests fail'),
1817
help='Use a different transport by default '
1818
'throughout the test suite.',
1819
type=get_transport_type),
1822
def run(self, testspecs_list=None, verbose=False, one=False,
1823
keep_output=False, transport=None):
1825
from bzrlib.tests import selftest
1826
# we don't want progress meters from the tests to go to the
1827
# real output; and we don't want log messages cluttering up
1829
save_ui = bzrlib.ui.ui_factory
1830
bzrlib.trace.info('running tests...')
1832
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1833
if testspecs_list is not None:
1834
pattern = '|'.join(testspecs_list)
1837
result = selftest(verbose=verbose,
1839
stop_on_failure=one,
1840
keep_output=keep_output,
1841
transport=transport)
1843
bzrlib.trace.info('tests passed')
1845
bzrlib.trace.info('tests failed')
1846
return int(not result)
1848
bzrlib.ui.ui_factory = save_ui
1851
def _get_bzr_branch():
1852
"""If bzr is run from a branch, return Branch or None"""
1853
import bzrlib.errors
1854
from bzrlib.branch import Branch
1855
from bzrlib.osutils import abspath
1856
from os.path import dirname
1859
branch = Branch.open(dirname(abspath(dirname(__file__))))
1861
except bzrlib.errors.BzrError:
1866
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1867
# is bzrlib itself in a branch?
1868
branch = _get_bzr_branch()
1870
rh = branch.revision_history()
1872
print " bzr checkout, revision %d" % (revno,)
1873
print " nick: %s" % (branch.nick,)
1875
print " revid: %s" % (rh[-1],)
1876
print bzrlib.__copyright__
1877
print "http://bazaar-ng.org/"
1879
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1880
print "you may use, modify and redistribute it under the terms of the GNU"
1881
print "General Public License version 2 or later."
1884
class cmd_version(Command):
1885
"""Show version of bzr."""
1890
class cmd_rocks(Command):
1891
"""Statement of optimism."""
1895
print "it sure does!"
1898
class cmd_find_merge_base(Command):
1899
"""Find and print a base revision for merging two branches.
1901
# TODO: Options to specify revisions on either side, as if
1902
# merging only part of the history.
1903
takes_args = ['branch', 'other']
1907
def run(self, branch, other):
1908
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1910
branch1 = Branch.open_containing(branch)[0]
1911
branch2 = Branch.open_containing(other)[0]
1913
history_1 = branch1.revision_history()
1914
history_2 = branch2.revision_history()
1916
last1 = branch1.last_revision()
1917
last2 = branch2.last_revision()
1919
source = MultipleRevisionSources(branch1.repository,
1922
base_rev_id = common_ancestor(last1, last2, source)
1924
print 'merge base is revision %s' % base_rev_id
1928
if base_revno is None:
1929
raise bzrlib.errors.UnrelatedBranches()
1931
print ' r%-6d in %s' % (base_revno, branch)
1933
other_revno = branch2.revision_id_to_revno(base_revid)
1935
print ' r%-6d in %s' % (other_revno, other)
1939
class cmd_merge(Command):
1940
"""Perform a three-way merge.
1942
The branch is the branch you will merge from. By default, it will
1943
merge the latest revision. If you specify a revision, that
1944
revision will be merged. If you specify two revisions, the first
1945
will be used as a BASE, and the second one as OTHER. Revision
1946
numbers are always relative to the specified branch.
1948
By default, bzr will try to merge in all new work from the other
1949
branch, automatically determining an appropriate base. If this
1950
fails, you may need to give an explicit base.
1952
Merge will do its best to combine the changes in two branches, but there
1953
are some kinds of problems only a human can fix. When it encounters those,
1954
it will mark a conflict. A conflict means that you need to fix something,
1955
before you should commit.
1957
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
1959
If there is no default branch set, the first merge will set it. After
1960
that, you can omit the branch to use the default. To change the
1961
default, use --remember.
1965
To merge the latest revision from bzr.dev
1966
bzr merge ../bzr.dev
1968
To merge changes up to and including revision 82 from bzr.dev
1969
bzr merge -r 82 ../bzr.dev
1971
To merge the changes introduced by 82, without previous changes:
1972
bzr merge -r 81..82 ../bzr.dev
1974
merge refuses to run if there are any uncommitted changes, unless
1977
takes_args = ['branch?']
1978
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
1979
Option('show-base', help="Show base revision text in "
1982
def run(self, branch=None, revision=None, force=False, merge_type=None,
1983
show_base=False, reprocess=False, remember=False):
1984
if merge_type is None:
1985
merge_type = Merge3Merger
1987
tree = WorkingTree.open_containing(u'.')[0]
1988
stored_loc = tree.branch.get_parent()
1990
if stored_loc is None:
1991
raise BzrCommandError("No merge branch known or specified.")
1993
print (u"Using saved branch: %s"
1994
% urlutils.unescape_for_display(stored_loc))
1997
if revision is None or len(revision) < 1:
1999
other = [branch, -1]
2000
other_branch, path = Branch.open_containing(branch)
2002
if len(revision) == 1:
2004
other_branch, path = Branch.open_containing(branch)
2005
revno = revision[0].in_history(other_branch).revno
2006
other = [branch, revno]
2008
assert len(revision) == 2
2009
if None in revision:
2010
raise BzrCommandError(
2011
"Merge doesn't permit that revision specifier.")
2012
other_branch, path = Branch.open_containing(branch)
2014
base = [branch, revision[0].in_history(other_branch).revno]
2015
other = [branch, revision[1].in_history(other_branch).revno]
2017
if tree.branch.get_parent() is None or remember:
2018
tree.branch.set_parent(other_branch.base)
2021
interesting_files = [path]
2023
interesting_files = None
2024
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2027
conflict_count = merge(other, base, check_clean=(not force),
2028
merge_type=merge_type,
2029
reprocess=reprocess,
2030
show_base=show_base,
2031
pb=pb, file_list=interesting_files)
2034
if conflict_count != 0:
2038
except bzrlib.errors.AmbiguousBase, e:
2039
m = ("sorry, bzr can't determine the right merge base yet\n"
2040
"candidates are:\n "
2041
+ "\n ".join(e.bases)
2043
"please specify an explicit base with -r,\n"
2044
"and (if you want) report this to the bzr developers\n")
2048
class cmd_remerge(Command):
2051
takes_args = ['file*']
2052
takes_options = ['merge-type', 'reprocess',
2053
Option('show-base', help="Show base revision text in "
2056
def run(self, file_list=None, merge_type=None, show_base=False,
2058
from bzrlib.merge import merge_inner, transform_tree
2059
if merge_type is None:
2060
merge_type = Merge3Merger
2061
tree, file_list = tree_files(file_list)
2064
pending_merges = tree.pending_merges()
2065
if len(pending_merges) != 1:
2066
raise BzrCommandError("Sorry, remerge only works after normal"
2067
+ " merges. Not cherrypicking or"
2069
repository = tree.branch.repository
2070
base_revision = common_ancestor(tree.branch.last_revision(),
2071
pending_merges[0], repository)
2072
base_tree = repository.revision_tree(base_revision)
2073
other_tree = repository.revision_tree(pending_merges[0])
2074
interesting_ids = None
2075
if file_list is not None:
2076
interesting_ids = set()
2077
for filename in file_list:
2078
file_id = tree.path2id(filename)
2080
raise NotVersionedError(filename)
2081
interesting_ids.add(file_id)
2082
if tree.kind(file_id) != "directory":
2085
for name, ie in tree.inventory.iter_entries(file_id):
2086
interesting_ids.add(ie.file_id)
2087
transform_tree(tree, tree.basis_tree(), interesting_ids)
2088
if file_list is None:
2089
restore_files = list(tree.iter_conflicts())
2091
restore_files = file_list
2092
for filename in restore_files:
2094
restore(tree.abspath(filename))
2095
except NotConflicted:
2097
conflicts = merge_inner(tree.branch, other_tree, base_tree,
2099
interesting_ids = interesting_ids,
2100
other_rev_id=pending_merges[0],
2101
merge_type=merge_type,
2102
show_base=show_base,
2103
reprocess=reprocess)
2111
class cmd_revert(Command):
2112
"""Reverse all changes since the last commit.
2114
Only versioned files are affected. Specify filenames to revert only
2115
those files. By default, any files that are changed will be backed up
2116
first. Backup files have a '~' appended to their name.
2118
takes_options = ['revision', 'no-backup']
2119
takes_args = ['file*']
2120
aliases = ['merge-revert']
2122
def run(self, revision=None, no_backup=False, file_list=None):
2123
from bzrlib.commands import parse_spec
2124
if file_list is not None:
2125
if len(file_list) == 0:
2126
raise BzrCommandError("No files specified")
2130
tree, file_list = tree_files(file_list)
2131
if revision is None:
2132
# FIXME should be tree.last_revision
2133
rev_id = tree.last_revision()
2134
elif len(revision) != 1:
2135
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
2137
rev_id = revision[0].in_history(tree.branch).rev_id
2138
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2140
tree.revert(file_list,
2141
tree.branch.repository.revision_tree(rev_id),
2147
class cmd_assert_fail(Command):
2148
"""Test reporting of assertion failures"""
2151
assert False, "always fails"
2154
class cmd_help(Command):
2155
"""Show help on a command or other topic.
2157
For a list of all available commands, say 'bzr help commands'."""
2158
takes_options = [Option('long', 'show help on all commands')]
2159
takes_args = ['topic?']
2160
aliases = ['?', '--help', '-?', '-h']
2163
def run(self, topic=None, long=False):
2165
if topic is None and long:
2170
class cmd_shell_complete(Command):
2171
"""Show appropriate completions for context.
2173
For a list of all available commands, say 'bzr shell-complete'."""
2174
takes_args = ['context?']
2179
def run(self, context=None):
2180
import shellcomplete
2181
shellcomplete.shellcomplete(context)
2184
class cmd_fetch(Command):
2185
"""Copy in history from another branch but don't merge it.
2187
This is an internal method used for pull and merge."""
2189
takes_args = ['from_branch', 'to_branch']
2190
def run(self, from_branch, to_branch):
2191
from bzrlib.fetch import Fetcher
2192
from bzrlib.branch import Branch
2193
from_b = Branch.open(from_branch)
2194
to_b = Branch.open(to_branch)
2195
Fetcher(to_b, from_b)
2198
class cmd_missing(Command):
2199
"""Show unmerged/unpulled revisions between two branches.
2201
OTHER_BRANCH may be local or remote."""
2202
takes_args = ['other_branch?']
2203
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2205
'Display changes in the local branch only'),
2206
Option('theirs-only',
2207
'Display changes in the remote branch only'),
2216
def run(self, other_branch=None, reverse=False, mine_only=False,
2217
theirs_only=False, log_format=None, long=False, short=False, line=False,
2218
show_ids=False, verbose=False):
2219
from bzrlib.missing import find_unmerged, iter_log_data
2220
from bzrlib.log import log_formatter
2221
local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
2222
parent = local_branch.get_parent()
2223
if other_branch is None:
2224
other_branch = parent
2225
if other_branch is None:
2226
raise BzrCommandError("No missing location known or specified.")
2227
print "Using last location: " + local_branch.get_parent()
2228
remote_branch = bzrlib.branch.Branch.open(other_branch)
2229
if remote_branch.base == local_branch.base:
2230
remote_branch = local_branch
2231
local_branch.lock_read()
2233
remote_branch.lock_read()
2235
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2236
if (log_format == None):
2237
default = bzrlib.config.BranchConfig(local_branch).log_format()
2238
log_format = get_log_format(long=long, short=short, line=line, default=default)
2239
lf = log_formatter(log_format, sys.stdout,
2241
show_timezone='original')
2242
if reverse is False:
2243
local_extra.reverse()
2244
remote_extra.reverse()
2245
if local_extra and not theirs_only:
2246
print "You have %d extra revision(s):" % len(local_extra)
2247
for data in iter_log_data(local_extra, local_branch.repository,
2250
printed_local = True
2252
printed_local = False
2253
if remote_extra and not mine_only:
2254
if printed_local is True:
2256
print "You are missing %d revision(s):" % len(remote_extra)
2257
for data in iter_log_data(remote_extra, remote_branch.repository,
2260
if not remote_extra and not local_extra:
2262
print "Branches are up to date."
2266
remote_branch.unlock()
2268
local_branch.unlock()
2269
if not status_code and parent is None and other_branch is not None:
2270
local_branch.lock_write()
2272
# handle race conditions - a parent might be set while we run.
2273
if local_branch.get_parent() is None:
2274
local_branch.set_parent(remote_branch.base)
2276
local_branch.unlock()
2280
class cmd_plugins(Command):
2285
import bzrlib.plugin
2286
from inspect import getdoc
2287
for name, plugin in bzrlib.plugin.all_plugins().items():
2288
if hasattr(plugin, '__path__'):
2289
print plugin.__path__[0]
2290
elif hasattr(plugin, '__file__'):
2291
print plugin.__file__
2297
print '\t', d.split('\n')[0]
2300
class cmd_testament(Command):
2301
"""Show testament (signing-form) of a revision."""
2302
takes_options = ['revision', 'long']
2303
takes_args = ['branch?']
2305
def run(self, branch=u'.', revision=None, long=False):
2306
from bzrlib.testament import Testament
2307
b = WorkingTree.open_containing(branch)[0].branch
2310
if revision is None:
2311
rev_id = b.last_revision()
2313
rev_id = revision[0].in_history(b).rev_id
2314
t = Testament.from_revision(b.repository, rev_id)
2316
sys.stdout.writelines(t.as_text_lines())
2318
sys.stdout.write(t.as_short_text())
2323
class cmd_annotate(Command):
2324
"""Show the origin of each line in a file.
2326
This prints out the given file with an annotation on the left side
2327
indicating which revision, author and date introduced the change.
2329
If the origin is the same for a run of consecutive lines, it is
2330
shown only at the top, unless the --all option is given.
2332
# TODO: annotate directories; showing when each file was last changed
2333
# TODO: if the working copy is modified, show annotations on that
2334
# with new uncommitted lines marked
2335
aliases = ['blame', 'praise']
2336
takes_args = ['filename']
2337
takes_options = [Option('all', help='show annotations on all lines'),
2338
Option('long', help='show date in annotations'),
2343
def run(self, filename, all=False, long=False, revision=None):
2344
from bzrlib.annotate import annotate_file
2345
tree, relpath = WorkingTree.open_containing(filename)
2346
branch = tree.branch
2349
if revision is None:
2350
revision_id = branch.last_revision()
2351
elif len(revision) != 1:
2352
raise BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2354
revision_id = revision[0].in_history(branch).rev_id
2355
file_id = tree.inventory.path2id(relpath)
2356
tree = branch.repository.revision_tree(revision_id)
2357
file_version = tree.inventory[file_id].revision
2358
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2363
class cmd_re_sign(Command):
2364
"""Create a digital signature for an existing revision."""
2365
# TODO be able to replace existing ones.
2367
hidden = True # is this right ?
2368
takes_args = ['revision_id*']
2369
takes_options = ['revision']
2371
def run(self, revision_id_list=None, revision=None):
2372
import bzrlib.config as config
2373
import bzrlib.gpg as gpg
2374
if revision_id_list is not None and revision is not None:
2375
raise BzrCommandError('You can only supply one of revision_id or --revision')
2376
if revision_id_list is None and revision is None:
2377
raise BzrCommandError('You must supply either --revision or a revision_id')
2378
b = WorkingTree.open_containing(u'.')[0].branch
2379
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
2380
if revision_id_list is not None:
2381
for revision_id in revision_id_list:
2382
b.repository.sign_revision(revision_id, gpg_strategy)
2383
elif revision is not None:
2384
if len(revision) == 1:
2385
revno, rev_id = revision[0].in_history(b)
2386
b.repository.sign_revision(rev_id, gpg_strategy)
2387
elif len(revision) == 2:
2388
# are they both on rh- if so we can walk between them
2389
# might be nice to have a range helper for arbitrary
2390
# revision paths. hmm.
2391
from_revno, from_revid = revision[0].in_history(b)
2392
to_revno, to_revid = revision[1].in_history(b)
2393
if to_revid is None:
2394
to_revno = b.revno()
2395
if from_revno is None or to_revno is None:
2396
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
2397
for revno in range(from_revno, to_revno + 1):
2398
b.repository.sign_revision(b.get_rev_id(revno),
2401
raise BzrCommandError('Please supply either one revision, or a range.')
2404
class cmd_bind(Command):
2405
"""Bind the current branch to a master branch.
2407
After binding, commits must succeed on the master branch
2408
before they are executed on the local one.
2411
takes_args = ['location']
2414
def run(self, location=None):
2415
b, relpath = Branch.open_containing(u'.')
2416
b_other = Branch.open(location)
2419
except DivergedBranches:
2420
raise BzrCommandError('These branches have diverged.'
2421
' Try merging, and then bind again.')
2424
class cmd_unbind(Command):
2425
"""Unbind the current branch from its master branch.
2427
After unbinding, the local branch is considered independent.
2428
All subsequent commits will be local.
2435
b, relpath = Branch.open_containing(u'.')
2437
raise BzrCommandError('Local branch is not bound')
2440
class cmd_uncommit(bzrlib.commands.Command):
2441
"""Remove the last committed revision.
2443
By supplying the --all flag, it will not only remove the entry
2444
from revision_history, but also remove all of the entries in the
2447
--verbose will print out what is being removed.
2448
--dry-run will go through all the motions, but not actually
2451
In the future, uncommit will create a changeset, which can then
2455
# TODO: jam 20060108 Add an option to allow uncommit to remove
2456
# unreferenced information in 'branch-as-repostory' branches.
2457
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2458
# information in shared branches as well.
2459
takes_options = ['verbose', 'revision',
2460
Option('dry-run', help='Don\'t actually make changes'),
2461
Option('force', help='Say yes to all questions.')]
2462
takes_args = ['location?']
2465
def run(self, location=None,
2466
dry_run=False, verbose=False,
2467
revision=None, force=False):
2468
from bzrlib.branch import Branch
2469
from bzrlib.log import log_formatter
2471
from bzrlib.uncommit import uncommit
2473
if location is None:
2475
control, relpath = bzrdir.BzrDir.open_containing(location)
2477
tree = control.open_workingtree()
2479
except (errors.NoWorkingTree, errors.NotLocalUrl):
2481
b = control.open_branch()
2483
if revision is None:
2485
rev_id = b.last_revision()
2487
revno, rev_id = revision[0].in_history(b)
2489
print 'No revisions to uncommit.'
2491
for r in range(revno, b.revno()+1):
2492
rev_id = b.get_rev_id(r)
2493
lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
2494
lf.show(r, b.repository.get_revision(rev_id), None)
2497
print 'Dry-run, pretending to remove the above revisions.'
2499
val = raw_input('Press <enter> to continue')
2501
print 'The above revision(s) will be removed.'
2503
val = raw_input('Are you sure [y/N]? ')
2504
if val.lower() not in ('y', 'yes'):
2508
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2512
class cmd_break_lock(Command):
2513
"""Break a dead lock on a repository, branch or working directory.
2515
CAUTION: Locks should only be broken when you are sure that the process
2516
holding the lock has been stopped.
2518
You can get information on what locks are open via the 'bzr info' command.
2523
takes_args = ['location?']
2525
def run(self, location=None, show=False):
2526
if location is None:
2528
control, relpath = bzrdir.BzrDir.open_containing(location)
2530
control.break_lock()
2531
except NotImplementedError:
2536
# command-line interpretation helper for merge-related commands
2537
def merge(other_revision, base_revision,
2538
check_clean=True, ignore_zero=False,
2539
this_dir=None, backup_files=False, merge_type=Merge3Merger,
2540
file_list=None, show_base=False, reprocess=False,
2541
pb=DummyProgress()):
2542
"""Merge changes into a tree.
2545
list(path, revno) Base for three-way merge.
2546
If [None, None] then a base will be automatically determined.
2548
list(path, revno) Other revision for three-way merge.
2550
Directory to merge changes into; '.' by default.
2552
If true, this_dir must have no uncommitted changes before the
2554
ignore_zero - If true, suppress the "zero conflicts" message when
2555
there are no conflicts; should be set when doing something we expect
2556
to complete perfectly.
2557
file_list - If supplied, merge only changes to selected files.
2559
All available ancestors of other_revision and base_revision are
2560
automatically pulled into the branch.
2562
The revno may be -1 to indicate the last revision on the branch, which is
2565
This function is intended for use from the command line; programmatic
2566
clients might prefer to call merge.merge_inner(), which has less magic
2569
from bzrlib.merge import Merger
2570
if this_dir is None:
2572
this_tree = WorkingTree.open_containing(this_dir)[0]
2573
if show_base and not merge_type is Merge3Merger:
2574
raise BzrCommandError("Show-base is not supported for this merge"
2575
" type. %s" % merge_type)
2576
if reprocess and not merge_type.supports_reprocess:
2577
raise BzrCommandError("Conflict reduction is not supported for merge"
2578
" type %s." % merge_type)
2579
if reprocess and show_base:
2580
raise BzrCommandError("Cannot do conflict reduction and show base.")
2582
merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
2583
merger.pp = ProgressPhase("Merge phase", 5, pb)
2584
merger.pp.next_phase()
2585
merger.check_basis(check_clean)
2586
merger.set_other(other_revision)
2587
merger.pp.next_phase()
2588
merger.set_base(base_revision)
2589
if merger.base_rev_id == merger.other_rev_id:
2590
note('Nothing to do.')
2592
merger.backup_files = backup_files
2593
merger.merge_type = merge_type
2594
merger.set_interesting_files(file_list)
2595
merger.show_base = show_base
2596
merger.reprocess = reprocess
2597
conflicts = merger.do_merge()
2598
if file_list is None:
2599
merger.set_pending()
2605
# these get imported and then picked up by the scan for cmd_*
2606
# TODO: Some more consistent way to split command definitions across files;
2607
# we do need to load at least some information about them to know of
2608
# aliases. ideally we would avoid loading the implementation until the
2609
# details were needed.
2610
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2611
from bzrlib.sign_my_commits import cmd_sign_my_commits
2612
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
2613
cmd_weave_plan_merge, cmd_weave_merge_text