1
# Copyright (C) 2004, 2005, 2006 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"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
45
from bzrlib.branch import Branch
46
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
47
from bzrlib.conflicts import ConflictList
48
from bzrlib.revision import common_ancestor
49
from bzrlib.revisionspec import RevisionSpec
50
from bzrlib.workingtree import WorkingTree
53
from bzrlib.commands import Command, display_command
54
from bzrlib.option import Option
55
from bzrlib.progress import DummyProgress, ProgressPhase
56
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
59
def tree_files(file_list, default_branch=u'.'):
61
return internal_tree_files(file_list, default_branch)
62
except errors.FileInWrongBranch, e:
63
raise errors.BzrCommandError("%s is not in the same branch as %s" %
64
(e.path, file_list[0]))
67
# XXX: Bad function name; should possibly also be a class method of
68
# WorkingTree rather than a function.
69
def internal_tree_files(file_list, default_branch=u'.'):
70
"""Convert command-line paths to a WorkingTree and relative paths.
72
This is typically used for command-line processors that take one or
73
more filenames, and infer the workingtree that contains them.
75
The filenames given are not required to exist.
77
:param file_list: Filenames to convert.
79
:param default_branch: Fallback tree path to use if file_list is empty or
82
:return: workingtree, [relative_paths]
84
if file_list is None or len(file_list) == 0:
85
return WorkingTree.open_containing(default_branch)[0], file_list
86
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
88
for filename in file_list:
90
new_list.append(tree.relpath(osutils.dereference_path(filename)))
91
except errors.PathNotChild:
92
raise errors.FileInWrongBranch(tree.branch, filename)
96
def get_format_type(typestring):
97
"""Parse and return a format specifier."""
98
if typestring == "weave":
99
return bzrdir.BzrDirFormat6()
100
if typestring == "default":
101
return bzrdir.BzrDirMetaFormat1()
102
if typestring == "metaweave":
103
format = bzrdir.BzrDirMetaFormat1()
104
format.repository_format = repository.RepositoryFormat7()
106
if typestring == "knit":
107
format = bzrdir.BzrDirMetaFormat1()
108
format.repository_format = repository.RepositoryFormatKnit1()
110
if typestring == "experimental-knit2":
111
format = bzrdir.BzrDirMetaFormat1()
112
format.repository_format = repository.RepositoryFormatKnit2()
114
msg = "Unknown bzr format %s. Current formats are: default, knit,\n" \
115
"metaweave and weave" % typestring
116
raise errors.BzrCommandError(msg)
119
# TODO: Make sure no commands unconditionally use the working directory as a
120
# branch. If a filename argument is used, the first of them should be used to
121
# specify the branch. (Perhaps this can be factored out into some kind of
122
# Argument class, representing a file in a branch, where the first occurrence
125
class cmd_status(Command):
126
"""Display status summary.
128
This reports on versioned and unknown files, reporting them
129
grouped by state. Possible states are:
132
Versioned in the working copy but not in the previous revision.
135
Versioned in the previous revision but removed or deleted
139
Path of this file changed from the previous revision;
140
the text may also have changed. This includes files whose
141
parent directory was renamed.
144
Text has changed since the previous revision.
147
Not versioned and not matching an ignore pattern.
149
To see ignored files use 'bzr ignored'. For details in the
150
changes to file texts, use 'bzr diff'.
152
--short gives a one character status flag for each item, similar
153
to the SVN's status command.
155
If no arguments are specified, the status of the entire working
156
directory is shown. Otherwise, only the status of the specified
157
files or directories is reported. If a directory is given, status
158
is reported for everything inside that directory.
160
If a revision argument is given, the status is calculated against
161
that revision, or between two revisions if two are provided.
164
# TODO: --no-recurse, --recurse options
166
takes_args = ['file*']
167
takes_options = ['show-ids', 'revision', 'short']
168
aliases = ['st', 'stat']
170
encoding_type = 'replace'
173
def run(self, show_ids=False, file_list=None, revision=None, short=False):
174
from bzrlib.status import show_tree_status
176
tree, file_list = tree_files(file_list)
178
show_tree_status(tree, show_ids=show_ids,
179
specific_files=file_list, revision=revision,
184
class cmd_cat_revision(Command):
185
"""Write out metadata for a revision.
187
The revision to print can either be specified by a specific
188
revision identifier, or you can use --revision.
192
takes_args = ['revision_id?']
193
takes_options = ['revision']
194
# cat-revision is more for frontends so should be exact
198
def run(self, revision_id=None, revision=None):
200
if revision_id is not None and revision is not None:
201
raise errors.BzrCommandError('You can only supply one of'
202
' revision_id or --revision')
203
if revision_id is None and revision is None:
204
raise errors.BzrCommandError('You must supply either'
205
' --revision or a revision_id')
206
b = WorkingTree.open_containing(u'.')[0].branch
208
# TODO: jam 20060112 should cat-revision always output utf-8?
209
if revision_id is not None:
210
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
211
elif revision is not None:
214
raise errors.BzrCommandError('You cannot specify a NULL'
216
revno, rev_id = rev.in_history(b)
217
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
220
class cmd_remove_tree(Command):
221
"""Remove the working tree from a given branch/checkout.
223
Since a lightweight checkout is little more than a working tree
224
this will refuse to run against one.
229
takes_args = ['location?']
231
def run(self, location='.'):
232
d = bzrdir.BzrDir.open(location)
235
working = d.open_workingtree()
236
except errors.NoWorkingTree:
237
raise errors.BzrCommandError("No working tree to remove")
238
except errors.NotLocalUrl:
239
raise errors.BzrCommandError("You cannot remove the working tree of a "
242
working_path = working.bzrdir.root_transport.base
243
branch_path = working.branch.bzrdir.root_transport.base
244
if working_path != branch_path:
245
raise errors.BzrCommandError("You cannot remove the working tree from "
246
"a lightweight checkout")
248
d.destroy_workingtree()
251
class cmd_revno(Command):
252
"""Show current revision number.
254
This is equal to the number of revisions on this branch.
257
takes_args = ['location?']
260
def run(self, location=u'.'):
261
self.outf.write(str(Branch.open_containing(location)[0].revno()))
262
self.outf.write('\n')
265
class cmd_revision_info(Command):
266
"""Show revision number and revision id for a given revision identifier.
269
takes_args = ['revision_info*']
270
takes_options = ['revision']
273
def run(self, revision=None, revision_info_list=[]):
276
if revision is not None:
277
revs.extend(revision)
278
if revision_info_list is not None:
279
for rev in revision_info_list:
280
revs.append(RevisionSpec.from_string(rev))
282
raise errors.BzrCommandError('You must supply a revision identifier')
284
b = WorkingTree.open_containing(u'.')[0].branch
287
revinfo = rev.in_history(b)
288
if revinfo.revno is None:
289
print ' %s' % revinfo.rev_id
291
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
294
class cmd_add(Command):
295
"""Add specified files or directories.
297
In non-recursive mode, all the named items are added, regardless
298
of whether they were previously ignored. A warning is given if
299
any of the named files are already versioned.
301
In recursive mode (the default), files are treated the same way
302
but the behaviour for directories is different. Directories that
303
are already versioned do not give a warning. All directories,
304
whether already versioned or not, are searched for files or
305
subdirectories that are neither versioned or ignored, and these
306
are added. This search proceeds recursively into versioned
307
directories. If no names are given '.' is assumed.
309
Therefore simply saying 'bzr add' will version all files that
310
are currently unknown.
312
Adding a file whose parent directory is not versioned will
313
implicitly add the parent, and so on up to the root. This means
314
you should never need to explicitly add a directory, they'll just
315
get added when you add a file in the directory.
317
--dry-run will show which files would be added, but not actually
320
--file-ids-from will try to use the file ids from the supplied path.
321
It looks up ids trying to find a matching parent directory with the
322
same filename, and then by pure path.
324
takes_args = ['file*']
325
takes_options = ['no-recurse', 'dry-run', 'verbose',
326
Option('file-ids-from', type=unicode,
327
help='Lookup file ids from here')]
328
encoding_type = 'replace'
330
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
334
if file_ids_from is not None:
336
base_tree, base_path = WorkingTree.open_containing(
338
except errors.NoWorkingTree:
339
base_branch, base_path = Branch.open_containing(
341
base_tree = base_branch.basis_tree()
343
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
344
to_file=self.outf, should_print=(not is_quiet()))
346
action = bzrlib.add.AddAction(to_file=self.outf,
347
should_print=(not is_quiet()))
349
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
350
action=action, save=not dry_run)
353
for glob in sorted(ignored.keys()):
354
for path in ignored[glob]:
355
self.outf.write("ignored %s matching \"%s\"\n"
359
for glob, paths in ignored.items():
360
match_len += len(paths)
361
self.outf.write("ignored %d file(s).\n" % match_len)
362
self.outf.write("If you wish to add some of these files,"
363
" please add them by name.\n")
366
class cmd_mkdir(Command):
367
"""Create a new versioned directory.
369
This is equivalent to creating the directory and then adding it.
372
takes_args = ['dir+']
373
encoding_type = 'replace'
375
def run(self, dir_list):
378
wt, dd = WorkingTree.open_containing(d)
380
self.outf.write('added %s\n' % d)
383
class cmd_relpath(Command):
384
"""Show path of a file relative to root"""
386
takes_args = ['filename']
390
def run(self, filename):
391
# TODO: jam 20050106 Can relpath return a munged path if
392
# sys.stdout encoding cannot represent it?
393
tree, relpath = WorkingTree.open_containing(filename)
394
self.outf.write(relpath)
395
self.outf.write('\n')
398
class cmd_inventory(Command):
399
"""Show inventory of the current working copy or a revision.
401
It is possible to limit the output to a particular entry
402
type using the --kind option. For example: --kind file.
404
It is also possible to restrict the list of files to a specific
405
set. For example: bzr inventory --show-ids this/file
408
takes_options = ['revision', 'show-ids', 'kind']
409
takes_args = ['file*']
412
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
413
if kind and kind not in ['file', 'directory', 'symlink']:
414
raise errors.BzrCommandError('invalid kind specified')
416
work_tree, file_list = tree_files(file_list)
418
if revision is not None:
419
if len(revision) > 1:
420
raise errors.BzrCommandError('bzr inventory --revision takes'
421
' exactly one revision identifier')
422
revision_id = revision[0].in_history(work_tree.branch).rev_id
423
tree = work_tree.branch.repository.revision_tree(revision_id)
425
# We include work_tree as well as 'tree' here
426
# So that doing '-r 10 path/foo' will lookup whatever file
427
# exists now at 'path/foo' even if it has been renamed, as
428
# well as whatever files existed in revision 10 at path/foo
429
trees = [tree, work_tree]
434
if file_list is not None:
435
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
436
require_versioned=True)
437
# find_ids_across_trees may include some paths that don't
439
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
440
for file_id in file_ids if file_id in tree)
442
entries = tree.inventory.entries()
444
for path, entry in entries:
445
if kind and kind != entry.kind:
448
self.outf.write('%-50s %s\n' % (path, entry.file_id))
450
self.outf.write(path)
451
self.outf.write('\n')
454
class cmd_mv(Command):
455
"""Move or rename a file.
458
bzr mv OLDNAME NEWNAME
459
bzr mv SOURCE... DESTINATION
461
If the last argument is a versioned directory, all the other names
462
are moved into it. Otherwise, there must be exactly two arguments
463
and the file is changed to a new name, which must not already exist.
465
Files cannot be moved between branches.
468
takes_args = ['names*']
469
aliases = ['move', 'rename']
470
encoding_type = 'replace'
472
def run(self, names_list):
473
if names_list is None:
476
if len(names_list) < 2:
477
raise errors.BzrCommandError("missing file argument")
478
tree, rel_names = tree_files(names_list)
480
if os.path.isdir(names_list[-1]):
481
# move into existing directory
482
for pair in tree.move(rel_names[:-1], rel_names[-1]):
483
self.outf.write("%s => %s\n" % pair)
485
if len(names_list) != 2:
486
raise errors.BzrCommandError('to mv multiple files the destination '
487
'must be a versioned directory')
488
tree.rename_one(rel_names[0], rel_names[1])
489
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
492
class cmd_pull(Command):
493
"""Turn this branch into a mirror of another branch.
495
This command only works on branches that have not diverged. Branches are
496
considered diverged if the destination branch's most recent commit is one
497
that has not been merged (directly or indirectly) into the parent.
499
If branches have diverged, you can use 'bzr merge' to integrate the changes
500
from one into the other. Once one branch has merged, the other should
501
be able to pull it again.
503
If you want to forget your local changes and just update your branch to
504
match the remote one, use pull --overwrite.
506
If there is no default location set, the first pull will set it. After
507
that, you can omit the location to use the default. To change the
508
default, use --remember. The value will only be saved if the remote
509
location can be accessed.
512
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
513
takes_args = ['location?']
514
encoding_type = 'replace'
516
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
517
# FIXME: too much stuff is in the command class
519
tree_to = WorkingTree.open_containing(u'.')[0]
520
branch_to = tree_to.branch
521
except errors.NoWorkingTree:
523
branch_to = Branch.open_containing(u'.')[0]
526
if location is not None:
528
reader = bundle.read_bundle_from_url(location)
529
except errors.NotABundle:
530
pass # Continue on considering this url a Branch
532
stored_loc = branch_to.get_parent()
534
if stored_loc is None:
535
raise errors.BzrCommandError("No pull location known or"
538
display_url = urlutils.unescape_for_display(stored_loc,
540
self.outf.write("Using saved location: %s\n" % display_url)
541
location = stored_loc
544
if reader is not None:
545
install_bundle(branch_to.repository, reader)
546
branch_from = branch_to
548
branch_from = Branch.open(location)
550
if branch_to.get_parent() is None or remember:
551
branch_to.set_parent(branch_from.base)
555
if reader is not None:
556
rev_id = reader.target
557
elif len(revision) == 1:
558
rev_id = revision[0].in_history(branch_from).rev_id
560
raise errors.BzrCommandError('bzr pull --revision takes one value.')
562
old_rh = branch_to.revision_history()
563
if tree_to is not None:
564
count = tree_to.pull(branch_from, overwrite, rev_id)
566
count = branch_to.pull(branch_from, overwrite, rev_id)
567
note('%d revision(s) pulled.' % (count,))
570
new_rh = branch_to.revision_history()
573
from bzrlib.log import show_changed_revisions
574
show_changed_revisions(branch_to, old_rh, new_rh,
578
class cmd_push(Command):
579
"""Update a mirror of this branch.
581
The target branch will not have its working tree populated because this
582
is both expensive, and is not supported on remote file systems.
584
Some smart servers or protocols *may* put the working tree in place in
587
This command only works on branches that have not diverged. Branches are
588
considered diverged if the destination branch's most recent commit is one
589
that has not been merged (directly or indirectly) by the source branch.
591
If branches have diverged, you can use 'bzr push --overwrite' to replace
592
the other branch completely, discarding its unmerged changes.
594
If you want to ensure you have the different changes in the other branch,
595
do a merge (see bzr help merge) from the other branch, and commit that.
596
After that you will be able to do a push without '--overwrite'.
598
If there is no default push location set, the first push will set it.
599
After that, you can omit the location to use the default. To change the
600
default, use --remember. The value will only be saved if the remote
601
location can be accessed.
604
takes_options = ['remember', 'overwrite', 'verbose',
605
Option('create-prefix',
606
help='Create the path leading up to the branch '
607
'if it does not already exist')]
608
takes_args = ['location?']
609
encoding_type = 'replace'
611
def run(self, location=None, remember=False, overwrite=False,
612
create_prefix=False, verbose=False):
613
# FIXME: Way too big! Put this into a function called from the
616
br_from = Branch.open_containing('.')[0]
617
stored_loc = br_from.get_push_location()
619
if stored_loc is None:
620
raise errors.BzrCommandError("No push location known or specified.")
622
display_url = urlutils.unescape_for_display(stored_loc,
624
self.outf.write("Using saved location: %s\n" % display_url)
625
location = stored_loc
627
to_transport = transport.get_transport(location)
628
location_url = to_transport.base
632
dir_to = bzrdir.BzrDir.open(location_url)
633
br_to = dir_to.open_branch()
634
except errors.NotBranchError:
636
to_transport = to_transport.clone('..')
637
if not create_prefix:
639
relurl = to_transport.relpath(location_url)
640
mutter('creating directory %s => %s', location_url, relurl)
641
to_transport.mkdir(relurl)
642
except errors.NoSuchFile:
643
raise errors.BzrCommandError("Parent directory of %s "
644
"does not exist." % location)
646
current = to_transport.base
647
needed = [(to_transport, to_transport.relpath(location_url))]
650
to_transport, relpath = needed[-1]
651
to_transport.mkdir(relpath)
653
except errors.NoSuchFile:
654
new_transport = to_transport.clone('..')
655
needed.append((new_transport,
656
new_transport.relpath(to_transport.base)))
657
if new_transport.base == to_transport.base:
658
raise errors.BzrCommandError("Could not create "
660
dir_to = br_from.bzrdir.clone(location_url,
661
revision_id=br_from.last_revision())
662
br_to = dir_to.open_branch()
663
count = len(br_to.revision_history())
664
# We successfully created the target, remember it
665
if br_from.get_push_location() is None or remember:
666
br_from.set_push_location(br_to.base)
668
# We were able to connect to the remote location, so remember it
669
# we don't need to successfully push because of possible divergence.
670
if br_from.get_push_location() is None or remember:
671
br_from.set_push_location(br_to.base)
672
old_rh = br_to.revision_history()
675
tree_to = dir_to.open_workingtree()
676
except errors.NotLocalUrl:
677
warning('This transport does not update the working '
678
'tree of: %s' % (br_to.base,))
679
count = br_to.pull(br_from, overwrite)
680
except errors.NoWorkingTree:
681
count = br_to.pull(br_from, overwrite)
683
count = tree_to.pull(br_from, overwrite)
684
except errors.DivergedBranches:
685
raise errors.BzrCommandError('These branches have diverged.'
686
' Try using "merge" and then "push".')
687
note('%d revision(s) pushed.' % (count,))
690
new_rh = br_to.revision_history()
693
from bzrlib.log import show_changed_revisions
694
show_changed_revisions(br_to, old_rh, new_rh,
698
class cmd_branch(Command):
699
"""Create a new copy of a branch.
701
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
702
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
704
To retrieve the branch as of a particular revision, supply the --revision
705
parameter, as in "branch foo/bar -r 5".
707
--basis is to speed up branching from remote branches. When specified, it
708
copies all the file-contents, inventory and revision data from the basis
709
branch before copying anything from the remote branch.
711
takes_args = ['from_location', 'to_location?']
712
takes_options = ['revision', 'basis']
713
aliases = ['get', 'clone']
715
def run(self, from_location, to_location=None, revision=None, basis=None):
718
elif len(revision) > 1:
719
raise errors.BzrCommandError(
720
'bzr branch --revision takes exactly 1 revision value')
722
br_from = Branch.open(from_location)
724
if e.errno == errno.ENOENT:
725
raise errors.BzrCommandError('Source location "%s" does not'
726
' exist.' % to_location)
731
if basis is not None:
732
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
735
if len(revision) == 1 and revision[0] is not None:
736
revision_id = revision[0].in_history(br_from)[1]
738
# FIXME - wt.last_revision, fallback to branch, fall back to
739
# None or perhaps NULL_REVISION to mean copy nothing
741
revision_id = br_from.last_revision()
742
if to_location is None:
743
to_location = os.path.basename(from_location.rstrip("/\\"))
746
name = os.path.basename(to_location) + '\n'
748
to_transport = transport.get_transport(to_location)
750
to_transport.mkdir('.')
751
except errors.FileExists:
752
raise errors.BzrCommandError('Target directory "%s" already'
753
' exists.' % to_location)
754
except errors.NoSuchFile:
755
raise errors.BzrCommandError('Parent of "%s" does not exist.'
758
# preserve whatever source format we have.
759
dir = br_from.bzrdir.sprout(to_transport.base,
760
revision_id, basis_dir)
761
branch = dir.open_branch()
762
except errors.NoSuchRevision:
763
to_transport.delete_tree('.')
764
msg = "The branch %s has no revision %s." % (from_location, revision[0])
765
raise errors.BzrCommandError(msg)
766
except errors.UnlistableBranch:
767
osutils.rmtree(to_location)
768
msg = "The branch %s cannot be used as a --basis" % (basis,)
769
raise errors.BzrCommandError(msg)
771
branch.control_files.put_utf8('branch-name', name)
772
note('Branched %d revision(s).' % branch.revno())
777
class cmd_checkout(Command):
778
"""Create a new checkout of an existing branch.
780
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
781
the branch found in '.'. This is useful if you have removed the working tree
782
or if it was never created - i.e. if you pushed the branch to its current
785
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
786
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
788
To retrieve the branch as of a particular revision, supply the --revision
789
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
790
out of date [so you cannot commit] but it may be useful (i.e. to examine old
793
--basis is to speed up checking out from remote branches. When specified, it
794
uses the inventory and file contents from the basis branch in preference to the
795
branch being checked out.
797
takes_args = ['branch_location?', 'to_location?']
798
takes_options = ['revision', # , 'basis']
799
Option('lightweight',
800
help="perform a lightweight checkout. Lightweight "
801
"checkouts depend on access to the branch for "
802
"every operation. Normal checkouts can perform "
803
"common operations like diff and status without "
804
"such access, and also support local commits."
809
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
813
elif len(revision) > 1:
814
raise errors.BzrCommandError(
815
'bzr checkout --revision takes exactly 1 revision value')
816
if branch_location is None:
817
branch_location = osutils.getcwd()
818
to_location = branch_location
819
source = Branch.open(branch_location)
820
if len(revision) == 1 and revision[0] is not None:
821
revision_id = revision[0].in_history(source)[1]
824
if to_location is None:
825
to_location = os.path.basename(branch_location.rstrip("/\\"))
826
# if the source and to_location are the same,
827
# and there is no working tree,
828
# then reconstitute a branch
829
if (osutils.abspath(to_location) ==
830
osutils.abspath(branch_location)):
832
source.bzrdir.open_workingtree()
833
except errors.NoWorkingTree:
834
source.bzrdir.create_workingtree()
837
os.mkdir(to_location)
839
if e.errno == errno.EEXIST:
840
raise errors.BzrCommandError('Target directory "%s" already'
841
' exists.' % to_location)
842
if e.errno == errno.ENOENT:
843
raise errors.BzrCommandError('Parent of "%s" does not exist.'
847
old_format = bzrdir.BzrDirFormat.get_default_format()
848
bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
850
source.create_checkout(to_location, revision_id, lightweight)
852
bzrdir.BzrDirFormat.set_default_format(old_format)
855
class cmd_renames(Command):
856
"""Show list of renamed files.
858
# TODO: Option to show renames between two historical versions.
860
# TODO: Only show renames under dir, rather than in the whole branch.
861
takes_args = ['dir?']
864
def run(self, dir=u'.'):
865
tree = WorkingTree.open_containing(dir)[0]
866
old_inv = tree.basis_tree().inventory
867
new_inv = tree.read_working_inventory()
868
renames = list(_mod_tree.find_renames(old_inv, new_inv))
870
for old_name, new_name in renames:
871
self.outf.write("%s => %s\n" % (old_name, new_name))
874
class cmd_update(Command):
875
"""Update a tree to have the latest code committed to its branch.
877
This will perform a merge into the working tree, and may generate
878
conflicts. If you have any local changes, you will still
879
need to commit them after the update for the update to be complete.
881
If you want to discard your local changes, you can just do a
882
'bzr revert' instead of 'bzr commit' after the update.
884
takes_args = ['dir?']
887
def run(self, dir='.'):
888
tree = WorkingTree.open_containing(dir)[0]
889
master = tree.branch.get_master_branch()
890
if master is not None:
893
tree.lock_tree_write()
895
existing_pending_merges = tree.get_parent_ids()[1:]
896
last_rev = tree.last_revision()
897
if last_rev == tree.branch.last_revision():
898
# may be up to date, check master too.
899
master = tree.branch.get_master_branch()
900
if master is None or last_rev == master.last_revision():
901
revno = tree.branch.revision_id_to_revno(last_rev)
902
note("Tree is up to date at revision %d." % (revno,))
904
conflicts = tree.update()
905
revno = tree.branch.revision_id_to_revno(tree.last_revision())
906
note('Updated to revision %d.' % (revno,))
907
if tree.get_parent_ids()[1:] != existing_pending_merges:
908
note('Your local commits will now show as pending merges with '
909
"'bzr status', and can be committed with 'bzr commit'.")
918
class cmd_info(Command):
919
"""Show information about a working tree, branch or repository.
921
This command will show all known locations and formats associated to the
922
tree, branch or repository. Statistical information is included with
925
Branches and working trees will also report any missing revisions.
927
takes_args = ['location?']
928
takes_options = ['verbose']
931
def run(self, location=None, verbose=False):
932
from bzrlib.info import show_bzrdir_info
933
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
937
class cmd_remove(Command):
938
"""Make a file unversioned.
940
This makes bzr stop tracking changes to a versioned file. It does
941
not delete the working copy.
943
You can specify one or more files, and/or --new. If you specify --new,
944
only 'added' files will be removed. If you specify both, then new files
945
in the specified directories will be removed. If the directories are
946
also new, they will also be removed.
948
takes_args = ['file*']
949
takes_options = ['verbose', Option('new', help='remove newly-added files')]
951
encoding_type = 'replace'
953
def run(self, file_list, verbose=False, new=False):
954
tree, file_list = tree_files(file_list)
956
if file_list is None:
957
raise errors.BzrCommandError('Specify one or more files to'
958
' remove, or use --new.')
960
added = tree.changes_from(tree.basis_tree(),
961
specific_files=file_list).added
962
file_list = sorted([f[0] for f in added], reverse=True)
963
if len(file_list) == 0:
964
raise errors.BzrCommandError('No matching files.')
965
tree.remove(file_list, verbose=verbose, to_file=self.outf)
968
class cmd_file_id(Command):
969
"""Print file_id of a particular file or directory.
971
The file_id is assigned when the file is first added and remains the
972
same through all revisions where the file exists, even when it is
977
takes_args = ['filename']
980
def run(self, filename):
981
tree, relpath = WorkingTree.open_containing(filename)
982
i = tree.inventory.path2id(relpath)
984
raise errors.NotVersionedError(filename)
986
self.outf.write(i + '\n')
989
class cmd_file_path(Command):
990
"""Print path of file_ids to a file or directory.
992
This prints one line for each directory down to the target,
993
starting at the branch root.
997
takes_args = ['filename']
1000
def run(self, filename):
1001
tree, relpath = WorkingTree.open_containing(filename)
1002
inv = tree.inventory
1003
fid = inv.path2id(relpath)
1005
raise errors.NotVersionedError(filename)
1006
for fip in inv.get_idpath(fid):
1007
self.outf.write(fip + '\n')
1010
class cmd_reconcile(Command):
1011
"""Reconcile bzr metadata in a branch.
1013
This can correct data mismatches that may have been caused by
1014
previous ghost operations or bzr upgrades. You should only
1015
need to run this command if 'bzr check' or a bzr developer
1016
advises you to run it.
1018
If a second branch is provided, cross-branch reconciliation is
1019
also attempted, which will check that data like the tree root
1020
id which was not present in very early bzr versions is represented
1021
correctly in both branches.
1023
At the same time it is run it may recompress data resulting in
1024
a potential saving in disk space or performance gain.
1026
The branch *MUST* be on a listable system such as local disk or sftp.
1028
takes_args = ['branch?']
1030
def run(self, branch="."):
1031
from bzrlib.reconcile import reconcile
1032
dir = bzrdir.BzrDir.open(branch)
1036
class cmd_revision_history(Command):
1037
"""Display the list of revision ids on a branch."""
1038
takes_args = ['location?']
1043
def run(self, location="."):
1044
branch = Branch.open_containing(location)[0]
1045
for revid in branch.revision_history():
1046
self.outf.write(revid)
1047
self.outf.write('\n')
1050
class cmd_ancestry(Command):
1051
"""List all revisions merged into this branch."""
1052
takes_args = ['location?']
1057
def run(self, location="."):
1059
wt = WorkingTree.open_containing(location)[0]
1060
except errors.NoWorkingTree:
1061
b = Branch.open(location)
1062
last_revision = b.last_revision()
1065
last_revision = wt.last_revision()
1067
revision_ids = b.repository.get_ancestry(last_revision)
1068
assert revision_ids[0] is None
1070
for revision_id in revision_ids:
1071
self.outf.write(revision_id + '\n')
1074
class cmd_init(Command):
1075
"""Make a directory into a versioned branch.
1077
Use this to create an empty branch, or before importing an
1080
If there is a repository in a parent directory of the location, then
1081
the history of the branch will be stored in the repository. Otherwise
1082
init creates a standalone branch which carries its own history in
1085
If there is already a branch at the location but it has no working tree,
1086
the tree can be populated with 'bzr checkout'.
1088
Recipe for importing a tree of files:
1093
bzr commit -m 'imported project'
1095
takes_args = ['location?']
1098
help='Specify a format for this branch. Current'
1099
' formats are: default, knit, metaweave and'
1100
' weave. Default is knit; metaweave and'
1101
' weave are deprecated',
1102
type=get_format_type),
1104
def run(self, location=None, format=None):
1106
format = get_format_type('default')
1107
if location is None:
1110
to_transport = transport.get_transport(location)
1112
# The path has to exist to initialize a
1113
# branch inside of it.
1114
# Just using os.mkdir, since I don't
1115
# believe that we want to create a bunch of
1116
# locations if the user supplies an extended path
1117
# TODO: create-prefix
1119
to_transport.mkdir('.')
1120
except errors.FileExists:
1124
existing_bzrdir = bzrdir.BzrDir.open(location)
1125
except errors.NotBranchError:
1126
# really a NotBzrDir error...
1127
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1129
from bzrlib.transport.local import LocalTransport
1130
if existing_bzrdir.has_branch():
1131
if (isinstance(to_transport, LocalTransport)
1132
and not existing_bzrdir.has_workingtree()):
1133
raise errors.BranchExistsWithoutWorkingTree(location)
1134
raise errors.AlreadyBranchError(location)
1136
existing_bzrdir.create_branch()
1137
existing_bzrdir.create_workingtree()
1140
class cmd_init_repository(Command):
1141
"""Create a shared repository to hold branches.
1143
New branches created under the repository directory will store their revisions
1144
in the repository, not in the branch directory, if the branch format supports
1150
bzr checkout --lightweight repo/trunk trunk-checkout
1154
takes_args = ["location"]
1155
takes_options = [Option('format',
1156
help='Specify a format for this repository.'
1157
' Current formats are: default, knit,'
1158
' metaweave and weave. Default is knit;'
1159
' metaweave and weave are deprecated',
1160
type=get_format_type),
1162
help='Allows branches in repository to have'
1164
aliases = ["init-repo"]
1165
def run(self, location, format=None, trees=False):
1167
format = get_format_type('default')
1169
if location is None:
1172
to_transport = transport.get_transport(location)
1174
to_transport.mkdir('.')
1175
except errors.FileExists:
1178
newdir = format.initialize_on_transport(to_transport)
1179
repo = newdir.create_repository(shared=True)
1180
repo.set_make_working_trees(trees)
1183
class cmd_diff(Command):
1184
"""Show differences in the working tree or between revisions.
1186
If files are listed, only the changes in those files are listed.
1187
Otherwise, all changes for the tree are listed.
1189
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1190
produces patches suitable for "patch -p1".
1194
Shows the difference in the working tree versus the last commit
1196
Difference between the working tree and revision 1
1198
Difference between revision 2 and revision 1
1199
bzr diff --diff-prefix old/:new/
1200
Same as 'bzr diff' but prefix paths with old/ and new/
1201
bzr diff bzr.mine bzr.dev
1202
Show the differences between the two working trees
1204
Show just the differences for 'foo.c'
1206
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1207
# or a graphical diff.
1209
# TODO: Python difflib is not exactly the same as unidiff; should
1210
# either fix it up or prefer to use an external diff.
1212
# TODO: Selected-file diff is inefficient and doesn't show you
1215
# TODO: This probably handles non-Unix newlines poorly.
1217
takes_args = ['file*']
1218
takes_options = ['revision', 'diff-options',
1219
Option('prefix', type=str,
1220
help='Set prefixes to added to old and new filenames, as '
1221
'two values separated by a colon.'),
1223
aliases = ['di', 'dif']
1224
encoding_type = 'exact'
1227
def run(self, revision=None, file_list=None, diff_options=None,
1229
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1231
if (prefix is None) or (prefix == '0'):
1239
if not ':' in prefix:
1240
raise BzrCommandError(
1241
"--prefix expects two values separated by a colon")
1242
old_label, new_label = prefix.split(":")
1245
tree1, file_list = internal_tree_files(file_list)
1249
except errors.FileInWrongBranch:
1250
if len(file_list) != 2:
1251
raise errors.BzrCommandError("Files are in different branches")
1253
tree1, file1 = WorkingTree.open_containing(file_list[0])
1254
tree2, file2 = WorkingTree.open_containing(file_list[1])
1255
if file1 != "" or file2 != "":
1256
# FIXME diff those two files. rbc 20051123
1257
raise errors.BzrCommandError("Files are in different branches")
1259
except errors.NotBranchError:
1260
if (revision is not None and len(revision) == 2
1261
and not revision[0].needs_branch()
1262
and not revision[1].needs_branch()):
1263
# If both revision specs include a branch, we can
1264
# diff them without needing a local working tree
1265
tree1, tree2 = None, None
1268
if revision is not None:
1269
if tree2 is not None:
1270
raise errors.BzrCommandError("Can't specify -r with two branches")
1271
if (len(revision) == 1) or (revision[1].spec is None):
1272
return diff_cmd_helper(tree1, file_list, diff_options,
1274
old_label=old_label, new_label=new_label)
1275
elif len(revision) == 2:
1276
return diff_cmd_helper(tree1, file_list, diff_options,
1277
revision[0], revision[1],
1278
old_label=old_label, new_label=new_label)
1280
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1281
' one or two revision identifiers')
1283
if tree2 is not None:
1284
return show_diff_trees(tree1, tree2, sys.stdout,
1285
specific_files=file_list,
1286
external_diff_options=diff_options,
1287
old_label=old_label, new_label=new_label)
1289
return diff_cmd_helper(tree1, file_list, diff_options,
1290
old_label=old_label, new_label=new_label)
1293
class cmd_deleted(Command):
1294
"""List files deleted in the working tree.
1296
# TODO: Show files deleted since a previous revision, or
1297
# between two revisions.
1298
# TODO: Much more efficient way to do this: read in new
1299
# directories with readdir, rather than stating each one. Same
1300
# level of effort but possibly much less IO. (Or possibly not,
1301
# if the directories are very large...)
1302
takes_options = ['show-ids']
1305
def run(self, show_ids=False):
1306
tree = WorkingTree.open_containing(u'.')[0]
1307
old = tree.basis_tree()
1308
for path, ie in old.inventory.iter_entries():
1309
if not tree.has_id(ie.file_id):
1310
self.outf.write(path)
1312
self.outf.write(' ')
1313
self.outf.write(ie.file_id)
1314
self.outf.write('\n')
1317
class cmd_modified(Command):
1318
"""List files modified in working tree."""
1322
tree = WorkingTree.open_containing(u'.')[0]
1323
td = tree.changes_from(tree.basis_tree())
1324
for path, id, kind, text_modified, meta_modified in td.modified:
1325
self.outf.write(path + '\n')
1328
class cmd_added(Command):
1329
"""List files added in working tree."""
1333
wt = WorkingTree.open_containing(u'.')[0]
1334
basis_inv = wt.basis_tree().inventory
1337
if file_id in basis_inv:
1339
if inv.is_root(file_id) and len(basis_inv) == 0:
1341
path = inv.id2path(file_id)
1342
if not os.access(osutils.abspath(path), os.F_OK):
1344
self.outf.write(path + '\n')
1347
class cmd_root(Command):
1348
"""Show the tree root directory.
1350
The root is the nearest enclosing directory with a .bzr control
1352
takes_args = ['filename?']
1354
def run(self, filename=None):
1355
"""Print the branch root."""
1356
tree = WorkingTree.open_containing(filename)[0]
1357
self.outf.write(tree.basedir + '\n')
1360
class cmd_log(Command):
1361
"""Show log of a branch, file, or directory.
1363
By default show the log of the branch containing the working directory.
1365
To request a range of logs, you can use the command -r begin..end
1366
-r revision requests a specific revision, -r ..end or -r begin.. are
1372
bzr log -r -10.. http://server/branch
1375
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1377
takes_args = ['location?']
1378
takes_options = [Option('forward',
1379
help='show from oldest to newest'),
1382
help='show files changed in each revision'),
1383
'show-ids', 'revision',
1387
help='show revisions whose message matches this regexp',
1391
encoding_type = 'replace'
1394
def run(self, location=None, timezone='original',
1404
from bzrlib.log import log_formatter, show_log
1405
assert message is None or isinstance(message, basestring), \
1406
"invalid message argument %r" % message
1407
direction = (forward and 'forward') or 'reverse'
1412
# find the file id to log:
1414
dir, fp = bzrdir.BzrDir.open_containing(location)
1415
b = dir.open_branch()
1419
inv = dir.open_workingtree().inventory
1420
except (errors.NotBranchError, errors.NotLocalUrl):
1421
# either no tree, or is remote.
1422
inv = b.basis_tree().inventory
1423
file_id = inv.path2id(fp)
1425
raise errors.BzrCommandError(
1426
"Path does not have any revision history: %s" %
1430
# FIXME ? log the current subdir only RBC 20060203
1431
if revision is not None \
1432
and len(revision) > 0 and revision[0].get_branch():
1433
location = revision[0].get_branch()
1436
dir, relpath = bzrdir.BzrDir.open_containing(location)
1437
b = dir.open_branch()
1439
if revision is None:
1442
elif len(revision) == 1:
1443
rev1 = rev2 = revision[0].in_history(b).revno
1444
elif len(revision) == 2:
1445
if revision[1].get_branch() != revision[0].get_branch():
1446
# b is taken from revision[0].get_branch(), and
1447
# show_log will use its revision_history. Having
1448
# different branches will lead to weird behaviors.
1449
raise errors.BzrCommandError(
1450
"Log doesn't accept two revisions in different branches.")
1451
if revision[0].spec is None:
1452
# missing begin-range means first revision
1455
rev1 = revision[0].in_history(b).revno
1457
if revision[1].spec is None:
1458
# missing end-range means last known revision
1461
rev2 = revision[1].in_history(b).revno
1463
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1465
# By this point, the revision numbers are converted to the +ve
1466
# form if they were supplied in the -ve form, so we can do
1467
# this comparison in relative safety
1469
(rev2, rev1) = (rev1, rev2)
1471
if (log_format is None):
1472
default = b.get_config().log_format()
1473
log_format = get_log_format(long=long, short=short, line=line,
1475
lf = log_formatter(log_format,
1478
show_timezone=timezone)
1484
direction=direction,
1485
start_revision=rev1,
1490
def get_log_format(long=False, short=False, line=False, default='long'):
1491
log_format = default
1495
log_format = 'short'
1501
class cmd_touching_revisions(Command):
1502
"""Return revision-ids which affected a particular file.
1504
A more user-friendly interface is "bzr log FILE".
1508
takes_args = ["filename"]
1511
def run(self, filename):
1512
tree, relpath = WorkingTree.open_containing(filename)
1514
inv = tree.read_working_inventory()
1515
file_id = inv.path2id(relpath)
1516
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1517
self.outf.write("%6d %s\n" % (revno, what))
1520
class cmd_ls(Command):
1521
"""List files in a tree.
1523
# TODO: Take a revision or remote path and list that tree instead.
1525
takes_options = ['verbose', 'revision',
1526
Option('non-recursive',
1527
help='don\'t recurse into sub-directories'),
1529
help='Print all paths from the root of the branch.'),
1530
Option('unknown', help='Print unknown files'),
1531
Option('versioned', help='Print versioned files'),
1532
Option('ignored', help='Print ignored files'),
1534
Option('null', help='Null separate the files'),
1537
def run(self, revision=None, verbose=False,
1538
non_recursive=False, from_root=False,
1539
unknown=False, versioned=False, ignored=False,
1542
if verbose and null:
1543
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1544
all = not (unknown or versioned or ignored)
1546
selection = {'I':ignored, '?':unknown, 'V':versioned}
1548
tree, relpath = WorkingTree.open_containing(u'.')
1553
if revision is not None:
1554
tree = tree.branch.repository.revision_tree(
1555
revision[0].in_history(tree.branch).rev_id)
1557
for fp, fc, kind, fid, entry in tree.list_files(include_root=False):
1558
if fp.startswith(relpath):
1559
fp = fp[len(relpath):]
1560
if non_recursive and '/' in fp:
1562
if not all and not selection[fc]:
1565
kindch = entry.kind_character()
1566
self.outf.write('%-8s %s%s\n' % (fc, fp, kindch))
1568
self.outf.write(fp + '\0')
1571
self.outf.write(fp + '\n')
1574
class cmd_unknowns(Command):
1575
"""List unknown files."""
1578
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1579
self.outf.write(osutils.quotefn(f) + '\n')
1582
class cmd_ignore(Command):
1583
"""Ignore specified files or patterns.
1585
To remove patterns from the ignore list, edit the .bzrignore file.
1587
Trailing slashes on patterns are ignored.
1588
If the pattern contains a slash or is a regular expression, it is compared
1589
to the whole path from the branch root. Otherwise, it is compared to only
1590
the last component of the path. To match a file only in the root
1591
directory, prepend './'.
1593
Ignore patterns specifying absolute paths are not allowed.
1595
Ignore patterns may include globbing wildcards such as:
1596
? - Matches any single character except '/'
1597
* - Matches 0 or more characters except '/'
1598
/**/ - Matches 0 or more directories in a path
1599
[a-z] - Matches a single character from within a group of characters
1601
Ignore patterns may also be Python regular expressions.
1602
Regular expression ignore patterns are identified by a 'RE:' prefix
1603
followed by the regular expression. Regular expression ignore patterns
1604
may not include named or numbered groups.
1606
Note: ignore patterns containing shell wildcards must be quoted from
1610
bzr ignore ./Makefile
1611
bzr ignore '*.class'
1612
bzr ignore 'lib/**/*.o'
1613
bzr ignore 'RE:lib/.*\.o'
1615
takes_args = ['name_pattern*']
1617
Option('old-default-rules',
1618
help='Out the ignore rules bzr < 0.9 always used.')
1621
def run(self, name_pattern_list=None, old_default_rules=None):
1622
from bzrlib.atomicfile import AtomicFile
1623
if old_default_rules is not None:
1624
# dump the rules and exit
1625
for pattern in ignores.OLD_DEFAULTS:
1628
if not name_pattern_list:
1629
raise errors.BzrCommandError("ignore requires at least one "
1630
"NAME_PATTERN or --old-default-rules")
1631
for name_pattern in name_pattern_list:
1632
if name_pattern[0] == '/':
1633
raise errors.BzrCommandError(
1634
"NAME_PATTERN should not be an absolute path")
1635
tree, relpath = WorkingTree.open_containing(u'.')
1636
ifn = tree.abspath('.bzrignore')
1637
if os.path.exists(ifn):
1640
igns = f.read().decode('utf-8')
1646
# TODO: If the file already uses crlf-style termination, maybe
1647
# we should use that for the newly added lines?
1649
if igns and igns[-1] != '\n':
1651
for name_pattern in name_pattern_list:
1652
igns += name_pattern.rstrip('/') + '\n'
1654
f = AtomicFile(ifn, 'wb')
1656
f.write(igns.encode('utf-8'))
1661
inv = tree.inventory
1662
if inv.path2id('.bzrignore'):
1663
mutter('.bzrignore is already versioned')
1665
mutter('need to make new .bzrignore file versioned')
1666
tree.add(['.bzrignore'])
1669
class cmd_ignored(Command):
1670
"""List ignored files and the patterns that matched them.
1672
See also: bzr ignore"""
1675
tree = WorkingTree.open_containing(u'.')[0]
1676
for path, file_class, kind, file_id, entry in tree.list_files():
1677
if file_class != 'I':
1679
## XXX: Slightly inefficient since this was already calculated
1680
pat = tree.is_ignored(path)
1681
print '%-50s %s' % (path, pat)
1684
class cmd_lookup_revision(Command):
1685
"""Lookup the revision-id from a revision-number
1688
bzr lookup-revision 33
1691
takes_args = ['revno']
1694
def run(self, revno):
1698
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1700
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1703
class cmd_export(Command):
1704
"""Export past revision to destination directory.
1706
If no revision is specified this exports the last committed revision.
1708
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1709
given, try to find the format with the extension. If no extension
1710
is found exports to a directory (equivalent to --format=dir).
1712
Root may be the top directory for tar, tgz and tbz2 formats. If none
1713
is given, the top directory will be the root name of the file.
1715
If branch is omitted then the branch containing the CWD will be used.
1717
Note: export of tree with non-ascii filenames to zip is not supported.
1719
Supported formats Autodetected by extension
1720
----------------- -------------------------
1723
tbz2 .tar.bz2, .tbz2
1727
takes_args = ['dest', 'branch?']
1728
takes_options = ['revision', 'format', 'root']
1729
def run(self, dest, branch=None, revision=None, format=None, root=None):
1730
from bzrlib.export import export
1733
tree = WorkingTree.open_containing(u'.')[0]
1736
b = Branch.open(branch)
1738
if revision is None:
1739
# should be tree.last_revision FIXME
1740
rev_id = b.last_revision()
1742
if len(revision) != 1:
1743
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1744
rev_id = revision[0].in_history(b).rev_id
1745
t = b.repository.revision_tree(rev_id)
1747
export(t, dest, format, root)
1748
except errors.NoSuchExportFormat, e:
1749
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1752
class cmd_cat(Command):
1753
"""Write a file's text from a previous revision."""
1755
takes_options = ['revision', 'name-from-revision']
1756
takes_args = ['filename']
1759
def run(self, filename, revision=None, name_from_revision=False):
1760
if revision is not None and len(revision) != 1:
1761
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1766
tree, relpath = WorkingTree.open_containing(filename)
1768
except (errors.NotBranchError, errors.NotLocalUrl):
1771
if revision is not None and revision[0].get_branch() is not None:
1772
b = Branch.open(revision[0].get_branch())
1774
b, relpath = Branch.open_containing(filename)
1775
tree = b.basis_tree()
1776
if revision is None:
1777
revision_id = b.last_revision()
1779
revision_id = revision[0].in_history(b).rev_id
1781
cur_file_id = tree.path2id(relpath)
1782
rev_tree = b.repository.revision_tree(revision_id)
1783
old_file_id = rev_tree.path2id(relpath)
1785
if name_from_revision:
1786
if old_file_id is None:
1787
raise errors.BzrCommandError("%r is not present in revision %s"
1788
% (filename, revision_id))
1790
rev_tree.print_file(old_file_id)
1791
elif cur_file_id is not None:
1792
rev_tree.print_file(cur_file_id)
1793
elif old_file_id is not None:
1794
rev_tree.print_file(old_file_id)
1796
raise errors.BzrCommandError("%r is not present in revision %s" %
1797
(filename, revision_id))
1800
class cmd_local_time_offset(Command):
1801
"""Show the offset in seconds from GMT to local time."""
1805
print osutils.local_time_offset()
1809
class cmd_commit(Command):
1810
"""Commit changes into a new revision.
1812
If no arguments are given, the entire tree is committed.
1814
If selected files are specified, only changes to those files are
1815
committed. If a directory is specified then the directory and everything
1816
within it is committed.
1818
A selected-file commit may fail in some cases where the committed
1819
tree would be invalid, such as trying to commit a file in a
1820
newly-added directory that is not itself committed.
1822
# TODO: Run hooks on tree to-be-committed, and after commit.
1824
# TODO: Strict commit that fails if there are deleted files.
1825
# (what does "deleted files" mean ??)
1827
# TODO: Give better message for -s, --summary, used by tla people
1829
# XXX: verbose currently does nothing
1831
takes_args = ['selected*']
1832
takes_options = ['message', 'verbose',
1834
help='commit even if nothing has changed'),
1835
Option('file', type=str,
1837
help='file containing commit message'),
1839
help="refuse to commit if there are unknown "
1840
"files in the working tree."),
1842
help="perform a local only commit in a bound "
1843
"branch. Such commits are not pushed to "
1844
"the master branch until a normal commit "
1848
aliases = ['ci', 'checkin']
1850
def run(self, message=None, file=None, verbose=True, selected_list=None,
1851
unchanged=False, strict=False, local=False):
1852
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1853
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1855
from bzrlib.msgeditor import edit_commit_message, \
1856
make_commit_message_template
1858
# TODO: Need a blackbox test for invoking the external editor; may be
1859
# slightly problematic to run this cross-platform.
1861
# TODO: do more checks that the commit will succeed before
1862
# spending the user's valuable time typing a commit message.
1863
tree, selected_list = tree_files(selected_list)
1864
if selected_list == ['']:
1865
# workaround - commit of root of tree should be exactly the same
1866
# as just default commit in that tree, and succeed even though
1867
# selected-file merge commit is not done yet
1870
if local and not tree.branch.get_bound_location():
1871
raise errors.LocalRequiresBoundBranch()
1873
def get_message(commit_obj):
1874
"""Callback to get commit message"""
1875
my_message = message
1876
if my_message is None and not file:
1877
template = make_commit_message_template(tree, selected_list)
1878
my_message = edit_commit_message(template)
1879
if my_message is None:
1880
raise errors.BzrCommandError("please specify a commit"
1881
" message with either --message or --file")
1882
elif my_message and file:
1883
raise errors.BzrCommandError(
1884
"please specify either --message or --file")
1886
my_message = codecs.open(file, 'rt',
1887
bzrlib.user_encoding).read()
1888
if my_message == "":
1889
raise errors.BzrCommandError("empty commit message specified")
1893
reporter = ReportCommitToLog()
1895
reporter = NullCommitReporter()
1898
tree.commit(message_callback=get_message,
1899
specific_files=selected_list,
1900
allow_pointless=unchanged, strict=strict, local=local,
1902
except PointlessCommit:
1903
# FIXME: This should really happen before the file is read in;
1904
# perhaps prepare the commit; get the message; then actually commit
1905
raise errors.BzrCommandError("no changes to commit."
1906
" use --unchanged to commit anyhow")
1907
except ConflictsInTree:
1908
raise errors.BzrCommandError('Conflicts detected in working '
1909
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
1911
except StrictCommitFailed:
1912
raise errors.BzrCommandError("Commit refused because there are"
1913
" unknown files in the working tree.")
1914
except errors.BoundBranchOutOfDate, e:
1915
raise errors.BzrCommandError(str(e) + "\n"
1916
'To commit to master branch, run update and then commit.\n'
1917
'You can also pass --local to commit to continue working '
1921
class cmd_check(Command):
1922
"""Validate consistency of branch history.
1924
This command checks various invariants about the branch storage to
1925
detect data corruption or bzr bugs.
1927
takes_args = ['branch?']
1928
takes_options = ['verbose']
1930
def run(self, branch=None, verbose=False):
1931
from bzrlib.check import check
1933
tree = WorkingTree.open_containing()[0]
1934
branch = tree.branch
1936
branch = Branch.open(branch)
1937
check(branch, verbose)
1940
class cmd_upgrade(Command):
1941
"""Upgrade branch storage to current format.
1943
The check command or bzr developers may sometimes advise you to run
1944
this command. When the default format has changed you may also be warned
1945
during other operations to upgrade.
1947
takes_args = ['url?']
1950
help='Upgrade to a specific format. Current formats'
1951
' are: default, knit, metaweave and weave.'
1952
' Default is knit; metaweave and weave are'
1954
type=get_format_type),
1958
def run(self, url='.', format=None):
1959
from bzrlib.upgrade import upgrade
1961
format = get_format_type('default')
1962
upgrade(url, format)
1965
class cmd_whoami(Command):
1966
"""Show or set bzr user id.
1970
bzr whoami 'Frank Chu <fchu@example.com>'
1972
takes_options = [ Option('email',
1973
help='display email address only'),
1975
help='set identity for the current branch instead of '
1978
takes_args = ['name?']
1979
encoding_type = 'replace'
1982
def run(self, email=False, branch=False, name=None):
1984
# use branch if we're inside one; otherwise global config
1986
c = Branch.open_containing('.')[0].get_config()
1987
except errors.NotBranchError:
1988
c = config.GlobalConfig()
1990
self.outf.write(c.user_email() + '\n')
1992
self.outf.write(c.username() + '\n')
1995
# display a warning if an email address isn't included in the given name.
1997
config.extract_email_address(name)
1998
except errors.NoEmailInUsername, e:
1999
warning('"%s" does not seem to contain an email address. '
2000
'This is allowed, but not recommended.', name)
2002
# use global config unless --branch given
2004
c = Branch.open_containing('.')[0].get_config()
2006
c = config.GlobalConfig()
2007
c.set_user_option('email', name)
2010
class cmd_nick(Command):
2011
"""Print or set the branch nickname.
2013
If unset, the tree root directory name is used as the nickname
2014
To print the current nickname, execute with no argument.
2016
takes_args = ['nickname?']
2017
def run(self, nickname=None):
2018
branch = Branch.open_containing(u'.')[0]
2019
if nickname is None:
2020
self.printme(branch)
2022
branch.nick = nickname
2025
def printme(self, branch):
2029
class cmd_selftest(Command):
2030
"""Run internal test suite.
2032
This creates temporary test directories in the working directory,
2033
but not existing data is affected. These directories are deleted
2034
if the tests pass, or left behind to help in debugging if they
2035
fail and --keep-output is specified.
2037
If arguments are given, they are regular expressions that say
2038
which tests should run.
2040
If the global option '--no-plugins' is given, plugins are not loaded
2041
before running the selftests. This has two effects: features provided or
2042
modified by plugins will not be tested, and tests provided by plugins will
2047
bzr --no-plugins selftest -v
2049
# TODO: --list should give a list of all available tests
2051
# NB: this is used from the class without creating an instance, which is
2052
# why it does not have a self parameter.
2053
def get_transport_type(typestring):
2054
"""Parse and return a transport specifier."""
2055
if typestring == "sftp":
2056
from bzrlib.transport.sftp import SFTPAbsoluteServer
2057
return SFTPAbsoluteServer
2058
if typestring == "memory":
2059
from bzrlib.transport.memory import MemoryServer
2061
if typestring == "fakenfs":
2062
from bzrlib.transport.fakenfs import FakeNFSServer
2063
return FakeNFSServer
2064
msg = "No known transport type %s. Supported types are: sftp\n" %\
2066
raise errors.BzrCommandError(msg)
2069
takes_args = ['testspecs*']
2070
takes_options = ['verbose',
2071
Option('one', help='stop when one test fails'),
2072
Option('keep-output',
2073
help='keep output directories when tests fail'),
2075
help='Use a different transport by default '
2076
'throughout the test suite.',
2077
type=get_transport_type),
2078
Option('benchmark', help='run the bzr bencharks.'),
2079
Option('lsprof-timed',
2080
help='generate lsprof output for benchmarked'
2081
' sections of code.'),
2082
Option('cache-dir', type=str,
2083
help='a directory to cache intermediate'
2084
' benchmark steps'),
2085
Option('clean-output',
2086
help='clean temporary tests directories'
2087
' without running tests'),
2090
def run(self, testspecs_list=None, verbose=None, one=False,
2091
keep_output=False, transport=None, benchmark=None,
2092
lsprof_timed=None, cache_dir=None, clean_output=False):
2094
from bzrlib.tests import selftest
2095
import bzrlib.benchmarks as benchmarks
2096
from bzrlib.benchmarks import tree_creator
2099
from bzrlib.tests import clean_selftest_output
2100
clean_selftest_output()
2103
if cache_dir is not None:
2104
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2105
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2106
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2108
if testspecs_list is not None:
2109
pattern = '|'.join(testspecs_list)
2113
test_suite_factory = benchmarks.test_suite
2116
# TODO: should possibly lock the history file...
2117
benchfile = open(".perf_history", "at")
2119
test_suite_factory = None
2124
result = selftest(verbose=verbose,
2126
stop_on_failure=one,
2127
keep_output=keep_output,
2128
transport=transport,
2129
test_suite_factory=test_suite_factory,
2130
lsprof_timed=lsprof_timed,
2131
bench_history=benchfile)
2133
if benchfile is not None:
2136
info('tests passed')
2138
info('tests failed')
2139
return int(not result)
2142
class cmd_version(Command):
2143
"""Show version of bzr."""
2147
from bzrlib.version import show_version
2151
class cmd_rocks(Command):
2152
"""Statement of optimism."""
2158
print "it sure does!"
2161
class cmd_find_merge_base(Command):
2162
"""Find and print a base revision for merging two branches."""
2163
# TODO: Options to specify revisions on either side, as if
2164
# merging only part of the history.
2165
takes_args = ['branch', 'other']
2169
def run(self, branch, other):
2170
from bzrlib.revision import MultipleRevisionSources
2172
branch1 = Branch.open_containing(branch)[0]
2173
branch2 = Branch.open_containing(other)[0]
2175
history_1 = branch1.revision_history()
2176
history_2 = branch2.revision_history()
2178
last1 = branch1.last_revision()
2179
last2 = branch2.last_revision()
2181
source = MultipleRevisionSources(branch1.repository,
2184
base_rev_id = common_ancestor(last1, last2, source)
2186
print 'merge base is revision %s' % base_rev_id
2189
class cmd_merge(Command):
2190
"""Perform a three-way merge.
2192
The branch is the branch you will merge from. By default, it will merge
2193
the latest revision. If you specify a revision, that revision will be
2194
merged. If you specify two revisions, the first will be used as a BASE,
2195
and the second one as OTHER. Revision numbers are always relative to the
2198
By default, bzr will try to merge in all new work from the other
2199
branch, automatically determining an appropriate base. If this
2200
fails, you may need to give an explicit base.
2202
Merge will do its best to combine the changes in two branches, but there
2203
are some kinds of problems only a human can fix. When it encounters those,
2204
it will mark a conflict. A conflict means that you need to fix something,
2205
before you should commit.
2207
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2209
If there is no default branch set, the first merge will set it. After
2210
that, you can omit the branch to use the default. To change the
2211
default, use --remember. The value will only be saved if the remote
2212
location can be accessed.
2216
To merge the latest revision from bzr.dev
2217
bzr merge ../bzr.dev
2219
To merge changes up to and including revision 82 from bzr.dev
2220
bzr merge -r 82 ../bzr.dev
2222
To merge the changes introduced by 82, without previous changes:
2223
bzr merge -r 81..82 ../bzr.dev
2225
merge refuses to run if there are any uncommitted changes, unless
2228
The following merge types are available:
2230
takes_args = ['branch?']
2231
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2232
Option('show-base', help="Show base revision text in "
2234
Option('uncommitted', help='Apply uncommitted changes'
2235
' from a working copy, instead of branch changes')]
2238
from inspect import getdoc
2239
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2241
def run(self, branch=None, revision=None, force=False, merge_type=None,
2242
show_base=False, reprocess=False, remember=False,
2244
if merge_type is None:
2245
merge_type = _mod_merge.Merge3Merger
2247
tree = WorkingTree.open_containing(u'.')[0]
2249
if branch is not None:
2251
reader = bundle.read_bundle_from_url(branch)
2252
except errors.NotABundle:
2253
pass # Continue on considering this url a Branch
2255
conflicts = merge_bundle(reader, tree, not force, merge_type,
2256
reprocess, show_base)
2262
if revision is None \
2263
or len(revision) < 1 or revision[0].needs_branch():
2264
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2266
if revision is None or len(revision) < 1:
2269
other = [branch, None]
2272
other = [branch, -1]
2273
other_branch, path = Branch.open_containing(branch)
2276
raise errors.BzrCommandError('Cannot use --uncommitted and'
2277
' --revision at the same time.')
2278
branch = revision[0].get_branch() or branch
2279
if len(revision) == 1:
2281
other_branch, path = Branch.open_containing(branch)
2282
revno = revision[0].in_history(other_branch).revno
2283
other = [branch, revno]
2285
assert len(revision) == 2
2286
if None in revision:
2287
raise errors.BzrCommandError(
2288
"Merge doesn't permit empty revision specifier.")
2289
base_branch, path = Branch.open_containing(branch)
2290
branch1 = revision[1].get_branch() or branch
2291
other_branch, path1 = Branch.open_containing(branch1)
2292
if revision[0].get_branch() is not None:
2293
# then path was obtained from it, and is None.
2296
base = [branch, revision[0].in_history(base_branch).revno]
2297
other = [branch1, revision[1].in_history(other_branch).revno]
2299
if tree.branch.get_parent() is None or remember:
2300
tree.branch.set_parent(other_branch.base)
2303
interesting_files = [path]
2305
interesting_files = None
2306
pb = ui.ui_factory.nested_progress_bar()
2309
conflict_count = _merge_helper(
2310
other, base, check_clean=(not force),
2311
merge_type=merge_type,
2312
reprocess=reprocess,
2313
show_base=show_base,
2314
pb=pb, file_list=interesting_files)
2317
if conflict_count != 0:
2321
except errors.AmbiguousBase, e:
2322
m = ("sorry, bzr can't determine the right merge base yet\n"
2323
"candidates are:\n "
2324
+ "\n ".join(e.bases)
2326
"please specify an explicit base with -r,\n"
2327
"and (if you want) report this to the bzr developers\n")
2330
# TODO: move up to common parent; this isn't merge-specific anymore.
2331
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2332
"""Use tree.branch's parent if none was supplied.
2334
Report if the remembered location was used.
2336
if supplied_location is not None:
2337
return supplied_location
2338
stored_location = tree.branch.get_parent()
2339
mutter("%s", stored_location)
2340
if stored_location is None:
2341
raise errors.BzrCommandError("No location specified or remembered")
2342
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2343
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2344
return stored_location
2347
class cmd_remerge(Command):
2350
Use this if you want to try a different merge technique while resolving
2351
conflicts. Some merge techniques are better than others, and remerge
2352
lets you try different ones on different files.
2354
The options for remerge have the same meaning and defaults as the ones for
2355
merge. The difference is that remerge can (only) be run when there is a
2356
pending merge, and it lets you specify particular files.
2359
$ bzr remerge --show-base
2360
Re-do the merge of all conflicted files, and show the base text in
2361
conflict regions, in addition to the usual THIS and OTHER texts.
2363
$ bzr remerge --merge-type weave --reprocess foobar
2364
Re-do the merge of "foobar", using the weave merge algorithm, with
2365
additional processing to reduce the size of conflict regions.
2367
The following merge types are available:"""
2368
takes_args = ['file*']
2369
takes_options = ['merge-type', 'reprocess',
2370
Option('show-base', help="Show base revision text in "
2374
from inspect import getdoc
2375
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2377
def run(self, file_list=None, merge_type=None, show_base=False,
2379
if merge_type is None:
2380
merge_type = _mod_merge.Merge3Merger
2381
tree, file_list = tree_files(file_list)
2384
parents = tree.get_parent_ids()
2385
if len(parents) != 2:
2386
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2387
" merges. Not cherrypicking or"
2389
repository = tree.branch.repository
2390
base_revision = common_ancestor(parents[0],
2391
parents[1], repository)
2392
base_tree = repository.revision_tree(base_revision)
2393
other_tree = repository.revision_tree(parents[1])
2394
interesting_ids = None
2396
conflicts = tree.conflicts()
2397
if file_list is not None:
2398
interesting_ids = set()
2399
for filename in file_list:
2400
file_id = tree.path2id(filename)
2402
raise errors.NotVersionedError(filename)
2403
interesting_ids.add(file_id)
2404
if tree.kind(file_id) != "directory":
2407
for name, ie in tree.inventory.iter_entries(file_id):
2408
interesting_ids.add(ie.file_id)
2409
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2411
# Remerge only supports resolving contents conflicts
2412
allowed_conflicts = ('text conflict', 'contents conflict')
2413
restore_files = [c.path for c in conflicts
2414
if c.typestring in allowed_conflicts]
2415
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2416
tree.set_conflicts(ConflictList(new_conflicts))
2417
if file_list is not None:
2418
restore_files = file_list
2419
for filename in restore_files:
2421
restore(tree.abspath(filename))
2422
except errors.NotConflicted:
2424
conflicts = _mod_merge.merge_inner(
2425
tree.branch, other_tree, base_tree,
2427
interesting_ids=interesting_ids,
2428
other_rev_id=parents[1],
2429
merge_type=merge_type,
2430
show_base=show_base,
2431
reprocess=reprocess)
2440
class cmd_revert(Command):
2441
"""Revert files to a previous revision.
2443
Giving a list of files will revert only those files. Otherwise, all files
2444
will be reverted. If the revision is not specified with '--revision', the
2445
last committed revision is used.
2447
To remove only some changes, without reverting to a prior version, use
2448
merge instead. For example, "merge . --r-2..-3" will remove the changes
2449
introduced by -2, without affecting the changes introduced by -1. Or
2450
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2452
By default, any files that have been manually changed will be backed up
2453
first. (Files changed only by merge are not backed up.) Backup files have
2454
'.~#~' appended to their name, where # is a number.
2456
When you provide files, you can use their current pathname or the pathname
2457
from the target revision. So you can use revert to "undelete" a file by
2458
name. If you name a directory, all the contents of that directory will be
2461
takes_options = ['revision', 'no-backup']
2462
takes_args = ['file*']
2463
aliases = ['merge-revert']
2465
def run(self, revision=None, no_backup=False, file_list=None):
2466
if file_list is not None:
2467
if len(file_list) == 0:
2468
raise errors.BzrCommandError("No files specified")
2472
tree, file_list = tree_files(file_list)
2473
if revision is None:
2474
# FIXME should be tree.last_revision
2475
rev_id = tree.last_revision()
2476
elif len(revision) != 1:
2477
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2479
rev_id = revision[0].in_history(tree.branch).rev_id
2480
pb = ui.ui_factory.nested_progress_bar()
2482
tree.revert(file_list,
2483
tree.branch.repository.revision_tree(rev_id),
2489
class cmd_assert_fail(Command):
2490
"""Test reporting of assertion failures"""
2491
# intended just for use in testing
2496
raise AssertionError("always fails")
2499
class cmd_help(Command):
2500
"""Show help on a command or other topic.
2502
For a list of all available commands, say 'bzr help commands'.
2504
takes_options = [Option('long', 'show help on all commands')]
2505
takes_args = ['topic?']
2506
aliases = ['?', '--help', '-?', '-h']
2509
def run(self, topic=None, long=False):
2511
if topic is None and long:
2513
bzrlib.help.help(topic)
2516
class cmd_shell_complete(Command):
2517
"""Show appropriate completions for context.
2519
For a list of all available commands, say 'bzr shell-complete'.
2521
takes_args = ['context?']
2526
def run(self, context=None):
2527
import shellcomplete
2528
shellcomplete.shellcomplete(context)
2531
class cmd_fetch(Command):
2532
"""Copy in history from another branch but don't merge it.
2534
This is an internal method used for pull and merge.
2537
takes_args = ['from_branch', 'to_branch']
2538
def run(self, from_branch, to_branch):
2539
from bzrlib.fetch import Fetcher
2540
from_b = Branch.open(from_branch)
2541
to_b = Branch.open(to_branch)
2542
Fetcher(to_b, from_b)
2545
class cmd_missing(Command):
2546
"""Show unmerged/unpulled revisions between two branches.
2548
OTHER_BRANCH may be local or remote.
2550
takes_args = ['other_branch?']
2551
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2553
'Display changes in the local branch only'),
2554
Option('theirs-only',
2555
'Display changes in the remote branch only'),
2563
encoding_type = 'replace'
2566
def run(self, other_branch=None, reverse=False, mine_only=False,
2567
theirs_only=False, log_format=None, long=False, short=False, line=False,
2568
show_ids=False, verbose=False):
2569
from bzrlib.missing import find_unmerged, iter_log_data
2570
from bzrlib.log import log_formatter
2571
local_branch = Branch.open_containing(u".")[0]
2572
parent = local_branch.get_parent()
2573
if other_branch is None:
2574
other_branch = parent
2575
if other_branch is None:
2576
raise errors.BzrCommandError("No peer location known or specified.")
2577
print "Using last location: " + local_branch.get_parent()
2578
remote_branch = Branch.open(other_branch)
2579
if remote_branch.base == local_branch.base:
2580
remote_branch = local_branch
2581
local_branch.lock_read()
2583
remote_branch.lock_read()
2585
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2586
if (log_format is None):
2587
default = local_branch.get_config().log_format()
2588
log_format = get_log_format(long=long, short=short,
2589
line=line, default=default)
2590
lf = log_formatter(log_format,
2593
show_timezone='original')
2594
if reverse is False:
2595
local_extra.reverse()
2596
remote_extra.reverse()
2597
if local_extra and not theirs_only:
2598
print "You have %d extra revision(s):" % len(local_extra)
2599
for data in iter_log_data(local_extra, local_branch.repository,
2602
printed_local = True
2604
printed_local = False
2605
if remote_extra and not mine_only:
2606
if printed_local is True:
2608
print "You are missing %d revision(s):" % len(remote_extra)
2609
for data in iter_log_data(remote_extra, remote_branch.repository,
2612
if not remote_extra and not local_extra:
2614
print "Branches are up to date."
2618
remote_branch.unlock()
2620
local_branch.unlock()
2621
if not status_code and parent is None and other_branch is not None:
2622
local_branch.lock_write()
2624
# handle race conditions - a parent might be set while we run.
2625
if local_branch.get_parent() is None:
2626
local_branch.set_parent(remote_branch.base)
2628
local_branch.unlock()
2632
class cmd_plugins(Command):
2637
import bzrlib.plugin
2638
from inspect import getdoc
2639
for name, plugin in bzrlib.plugin.all_plugins().items():
2640
if getattr(plugin, '__path__', None) is not None:
2641
print plugin.__path__[0]
2642
elif getattr(plugin, '__file__', None) is not None:
2643
print plugin.__file__
2649
print '\t', d.split('\n')[0]
2652
class cmd_testament(Command):
2653
"""Show testament (signing-form) of a revision."""
2654
takes_options = ['revision',
2655
Option('long', help='Produce long-format testament'),
2656
Option('strict', help='Produce a strict-format'
2658
takes_args = ['branch?']
2660
def run(self, branch=u'.', revision=None, long=False, strict=False):
2661
from bzrlib.testament import Testament, StrictTestament
2663
testament_class = StrictTestament
2665
testament_class = Testament
2666
b = WorkingTree.open_containing(branch)[0].branch
2669
if revision is None:
2670
rev_id = b.last_revision()
2672
rev_id = revision[0].in_history(b).rev_id
2673
t = testament_class.from_revision(b.repository, rev_id)
2675
sys.stdout.writelines(t.as_text_lines())
2677
sys.stdout.write(t.as_short_text())
2682
class cmd_annotate(Command):
2683
"""Show the origin of each line in a file.
2685
This prints out the given file with an annotation on the left side
2686
indicating which revision, author and date introduced the change.
2688
If the origin is the same for a run of consecutive lines, it is
2689
shown only at the top, unless the --all option is given.
2691
# TODO: annotate directories; showing when each file was last changed
2692
# TODO: if the working copy is modified, show annotations on that
2693
# with new uncommitted lines marked
2694
aliases = ['ann', 'blame', 'praise']
2695
takes_args = ['filename']
2696
takes_options = [Option('all', help='show annotations on all lines'),
2697
Option('long', help='show date in annotations'),
2703
def run(self, filename, all=False, long=False, revision=None,
2705
from bzrlib.annotate import annotate_file
2706
tree, relpath = WorkingTree.open_containing(filename)
2707
branch = tree.branch
2710
if revision is None:
2711
revision_id = branch.last_revision()
2712
elif len(revision) != 1:
2713
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2715
revision_id = revision[0].in_history(branch).rev_id
2716
file_id = tree.inventory.path2id(relpath)
2717
tree = branch.repository.revision_tree(revision_id)
2718
file_version = tree.inventory[file_id].revision
2719
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2725
class cmd_re_sign(Command):
2726
"""Create a digital signature for an existing revision."""
2727
# TODO be able to replace existing ones.
2729
hidden = True # is this right ?
2730
takes_args = ['revision_id*']
2731
takes_options = ['revision']
2733
def run(self, revision_id_list=None, revision=None):
2734
import bzrlib.gpg as gpg
2735
if revision_id_list is not None and revision is not None:
2736
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2737
if revision_id_list is None and revision is None:
2738
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2739
b = WorkingTree.open_containing(u'.')[0].branch
2740
gpg_strategy = gpg.GPGStrategy(b.get_config())
2741
if revision_id_list is not None:
2742
for revision_id in revision_id_list:
2743
b.repository.sign_revision(revision_id, gpg_strategy)
2744
elif revision is not None:
2745
if len(revision) == 1:
2746
revno, rev_id = revision[0].in_history(b)
2747
b.repository.sign_revision(rev_id, gpg_strategy)
2748
elif len(revision) == 2:
2749
# are they both on rh- if so we can walk between them
2750
# might be nice to have a range helper for arbitrary
2751
# revision paths. hmm.
2752
from_revno, from_revid = revision[0].in_history(b)
2753
to_revno, to_revid = revision[1].in_history(b)
2754
if to_revid is None:
2755
to_revno = b.revno()
2756
if from_revno is None or to_revno is None:
2757
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2758
for revno in range(from_revno, to_revno + 1):
2759
b.repository.sign_revision(b.get_rev_id(revno),
2762
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2765
class cmd_bind(Command):
2766
"""Bind the current branch to a master branch.
2768
After binding, commits must succeed on the master branch
2769
before they are executed on the local one.
2772
takes_args = ['location']
2775
def run(self, location=None):
2776
b, relpath = Branch.open_containing(u'.')
2777
b_other = Branch.open(location)
2780
except errors.DivergedBranches:
2781
raise errors.BzrCommandError('These branches have diverged.'
2782
' Try merging, and then bind again.')
2785
class cmd_unbind(Command):
2786
"""Unbind the current branch from its master branch.
2788
After unbinding, the local branch is considered independent.
2789
All subsequent commits will be local.
2796
b, relpath = Branch.open_containing(u'.')
2798
raise errors.BzrCommandError('Local branch is not bound')
2801
class cmd_uncommit(Command):
2802
"""Remove the last committed revision.
2804
--verbose will print out what is being removed.
2805
--dry-run will go through all the motions, but not actually
2808
In the future, uncommit will create a revision bundle, which can then
2812
# TODO: jam 20060108 Add an option to allow uncommit to remove
2813
# unreferenced information in 'branch-as-repository' branches.
2814
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2815
# information in shared branches as well.
2816
takes_options = ['verbose', 'revision',
2817
Option('dry-run', help='Don\'t actually make changes'),
2818
Option('force', help='Say yes to all questions.')]
2819
takes_args = ['location?']
2822
def run(self, location=None,
2823
dry_run=False, verbose=False,
2824
revision=None, force=False):
2825
from bzrlib.log import log_formatter, show_log
2827
from bzrlib.uncommit import uncommit
2829
if location is None:
2831
control, relpath = bzrdir.BzrDir.open_containing(location)
2833
tree = control.open_workingtree()
2835
except (errors.NoWorkingTree, errors.NotLocalUrl):
2837
b = control.open_branch()
2840
if revision is None:
2843
# 'bzr uncommit -r 10' actually means uncommit
2844
# so that the final tree is at revno 10.
2845
# but bzrlib.uncommit.uncommit() actually uncommits
2846
# the revisions that are supplied.
2847
# So we need to offset it by one
2848
revno = revision[0].in_history(b).revno+1
2850
if revno <= b.revno():
2851
rev_id = b.get_rev_id(revno)
2853
self.outf.write('No revisions to uncommit.\n')
2856
lf = log_formatter('short',
2858
show_timezone='original')
2863
direction='forward',
2864
start_revision=revno,
2865
end_revision=b.revno())
2868
print 'Dry-run, pretending to remove the above revisions.'
2870
val = raw_input('Press <enter> to continue')
2872
print 'The above revision(s) will be removed.'
2874
val = raw_input('Are you sure [y/N]? ')
2875
if val.lower() not in ('y', 'yes'):
2879
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2883
class cmd_break_lock(Command):
2884
"""Break a dead lock on a repository, branch or working directory.
2886
CAUTION: Locks should only be broken when you are sure that the process
2887
holding the lock has been stopped.
2889
You can get information on what locks are open via the 'bzr info' command.
2894
takes_args = ['location?']
2896
def run(self, location=None, show=False):
2897
if location is None:
2899
control, relpath = bzrdir.BzrDir.open_containing(location)
2901
control.break_lock()
2902
except NotImplementedError:
2906
class cmd_wait_until_signalled(Command):
2907
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
2909
This just prints a line to signal when it is ready, then blocks on stdin.
2915
sys.stdout.write("running\n")
2917
sys.stdin.readline()
2920
class cmd_serve(Command):
2921
"""Run the bzr server."""
2923
aliases = ['server']
2927
help='serve on stdin/out for use from inetd or sshd'),
2929
help='listen for connections on nominated port of the form '
2930
'[hostname:]portnumber. Passing 0 as the port number will '
2931
'result in a dynamically allocated port.',
2934
help='serve contents of directory',
2936
Option('allow-writes',
2937
help='By default the server is a readonly server. Supplying '
2938
'--allow-writes enables write access to the contents of '
2939
'the served directory and below. '
2943
def run(self, port=None, inet=False, directory=None, allow_writes=False):
2944
from bzrlib.transport import smart
2945
from bzrlib.transport import get_transport
2946
if directory is None:
2947
directory = os.getcwd()
2948
url = urlutils.local_path_to_url(directory)
2949
if not allow_writes:
2950
url = 'readonly+' + url
2951
t = get_transport(url)
2953
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
2954
elif port is not None:
2956
host, port = port.split(':')
2959
server = smart.SmartTCPServer(t, host=host, port=int(port))
2960
print 'listening on port: ', server.port
2963
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
2967
# command-line interpretation helper for merge-related commands
2968
def _merge_helper(other_revision, base_revision,
2969
check_clean=True, ignore_zero=False,
2970
this_dir=None, backup_files=False,
2972
file_list=None, show_base=False, reprocess=False,
2973
pb=DummyProgress()):
2974
"""Merge changes into a tree.
2977
list(path, revno) Base for three-way merge.
2978
If [None, None] then a base will be automatically determined.
2980
list(path, revno) Other revision for three-way merge.
2982
Directory to merge changes into; '.' by default.
2984
If true, this_dir must have no uncommitted changes before the
2986
ignore_zero - If true, suppress the "zero conflicts" message when
2987
there are no conflicts; should be set when doing something we expect
2988
to complete perfectly.
2989
file_list - If supplied, merge only changes to selected files.
2991
All available ancestors of other_revision and base_revision are
2992
automatically pulled into the branch.
2994
The revno may be -1 to indicate the last revision on the branch, which is
2997
This function is intended for use from the command line; programmatic
2998
clients might prefer to call merge.merge_inner(), which has less magic
3001
# Loading it late, so that we don't always have to import bzrlib.merge
3002
if merge_type is None:
3003
merge_type = _mod_merge.Merge3Merger
3004
if this_dir is None:
3006
this_tree = WorkingTree.open_containing(this_dir)[0]
3007
if show_base and not merge_type is _mod_merge.Merge3Merger:
3008
raise errors.BzrCommandError("Show-base is not supported for this merge"
3009
" type. %s" % merge_type)
3010
if reprocess and not merge_type.supports_reprocess:
3011
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3012
" type %s." % merge_type)
3013
if reprocess and show_base:
3014
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3016
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3018
merger.pp = ProgressPhase("Merge phase", 5, pb)
3019
merger.pp.next_phase()
3020
merger.check_basis(check_clean)
3021
merger.set_other(other_revision)
3022
merger.pp.next_phase()
3023
merger.set_base(base_revision)
3024
if merger.base_rev_id == merger.other_rev_id:
3025
note('Nothing to do.')
3027
merger.backup_files = backup_files
3028
merger.merge_type = merge_type
3029
merger.set_interesting_files(file_list)
3030
merger.show_base = show_base
3031
merger.reprocess = reprocess
3032
conflicts = merger.do_merge()
3033
if file_list is None:
3034
merger.set_pending()
3041
merge = _merge_helper
3044
# these get imported and then picked up by the scan for cmd_*
3045
# TODO: Some more consistent way to split command definitions across files;
3046
# we do need to load at least some information about them to know of
3047
# aliases. ideally we would avoid loading the implementation until the
3048
# details were needed.
3049
from bzrlib.cmd_version_info import cmd_version_info
3050
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3051
from bzrlib.bundle.commands import cmd_bundle_revisions
3052
from bzrlib.sign_my_commits import cmd_sign_my_commits
3053
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3054
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
