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
# Have to use BzrDirMetaFormat1 directly, so that
99
# RepositoryFormat.set_default_format works
100
if typestring == "default":
101
return bzrdir.BzrDirMetaFormat1()
103
return bzrdir.format_registry.make_bzrdir(typestring)
105
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
106
raise errors.BzrCommandError(msg)
109
# TODO: Make sure no commands unconditionally use the working directory as a
110
# branch. If a filename argument is used, the first of them should be used to
111
# specify the branch. (Perhaps this can be factored out into some kind of
112
# Argument class, representing a file in a branch, where the first occurrence
115
class cmd_status(Command):
116
"""Display status summary.
118
This reports on versioned and unknown files, reporting them
119
grouped by state. Possible states are:
122
Versioned in the working copy but not in the previous revision.
125
Versioned in the previous revision but removed or deleted
129
Path of this file changed from the previous revision;
130
the text may also have changed. This includes files whose
131
parent directory was renamed.
134
Text has changed since the previous revision.
137
Not versioned and not matching an ignore pattern.
139
To see ignored files use 'bzr ignored'. For details in the
140
changes to file texts, use 'bzr diff'.
142
--short gives a one character status flag for each item, similar
143
to the SVN's status command.
145
If no arguments are specified, the status of the entire working
146
directory is shown. Otherwise, only the status of the specified
147
files or directories is reported. If a directory is given, status
148
is reported for everything inside that directory.
150
If a revision argument is given, the status is calculated against
151
that revision, or between two revisions if two are provided.
154
# TODO: --no-recurse, --recurse options
156
takes_args = ['file*']
157
takes_options = ['show-ids', 'revision', 'short']
158
aliases = ['st', 'stat']
160
encoding_type = 'replace'
163
def run(self, show_ids=False, file_list=None, revision=None, short=False):
164
from bzrlib.status import show_tree_status
166
tree, file_list = tree_files(file_list)
168
show_tree_status(tree, show_ids=show_ids,
169
specific_files=file_list, revision=revision,
174
class cmd_cat_revision(Command):
175
"""Write out metadata for a revision.
177
The revision to print can either be specified by a specific
178
revision identifier, or you can use --revision.
182
takes_args = ['revision_id?']
183
takes_options = ['revision']
184
# cat-revision is more for frontends so should be exact
188
def run(self, revision_id=None, revision=None):
190
if revision_id is not None and revision is not None:
191
raise errors.BzrCommandError('You can only supply one of'
192
' revision_id or --revision')
193
if revision_id is None and revision is None:
194
raise errors.BzrCommandError('You must supply either'
195
' --revision or a revision_id')
196
b = WorkingTree.open_containing(u'.')[0].branch
198
# TODO: jam 20060112 should cat-revision always output utf-8?
199
if revision_id is not None:
200
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
201
elif revision is not None:
204
raise errors.BzrCommandError('You cannot specify a NULL'
206
revno, rev_id = rev.in_history(b)
207
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
210
class cmd_remove_tree(Command):
211
"""Remove the working tree from a given branch/checkout.
213
Since a lightweight checkout is little more than a working tree
214
this will refuse to run against one.
219
takes_args = ['location?']
221
def run(self, location='.'):
222
d = bzrdir.BzrDir.open(location)
225
working = d.open_workingtree()
226
except errors.NoWorkingTree:
227
raise errors.BzrCommandError("No working tree to remove")
228
except errors.NotLocalUrl:
229
raise errors.BzrCommandError("You cannot remove the working tree of a "
232
working_path = working.bzrdir.root_transport.base
233
branch_path = working.branch.bzrdir.root_transport.base
234
if working_path != branch_path:
235
raise errors.BzrCommandError("You cannot remove the working tree from "
236
"a lightweight checkout")
238
d.destroy_workingtree()
241
class cmd_revno(Command):
242
"""Show current revision number.
244
This is equal to the number of revisions on this branch.
247
takes_args = ['location?']
250
def run(self, location=u'.'):
251
self.outf.write(str(Branch.open_containing(location)[0].revno()))
252
self.outf.write('\n')
255
class cmd_revision_info(Command):
256
"""Show revision number and revision id for a given revision identifier.
259
takes_args = ['revision_info*']
260
takes_options = ['revision']
263
def run(self, revision=None, revision_info_list=[]):
266
if revision is not None:
267
revs.extend(revision)
268
if revision_info_list is not None:
269
for rev in revision_info_list:
270
revs.append(RevisionSpec.from_string(rev))
272
raise errors.BzrCommandError('You must supply a revision identifier')
274
b = WorkingTree.open_containing(u'.')[0].branch
277
revinfo = rev.in_history(b)
278
if revinfo.revno is None:
279
print ' %s' % revinfo.rev_id
281
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
284
class cmd_add(Command):
285
"""Add specified files or directories.
287
In non-recursive mode, all the named items are added, regardless
288
of whether they were previously ignored. A warning is given if
289
any of the named files are already versioned.
291
In recursive mode (the default), files are treated the same way
292
but the behaviour for directories is different. Directories that
293
are already versioned do not give a warning. All directories,
294
whether already versioned or not, are searched for files or
295
subdirectories that are neither versioned or ignored, and these
296
are added. This search proceeds recursively into versioned
297
directories. If no names are given '.' is assumed.
299
Therefore simply saying 'bzr add' will version all files that
300
are currently unknown.
302
Adding a file whose parent directory is not versioned will
303
implicitly add the parent, and so on up to the root. This means
304
you should never need to explicitly add a directory, they'll just
305
get added when you add a file in the directory.
307
--dry-run will show which files would be added, but not actually
310
--file-ids-from will try to use the file ids from the supplied path.
311
It looks up ids trying to find a matching parent directory with the
312
same filename, and then by pure path.
314
takes_args = ['file*']
315
takes_options = ['no-recurse', 'dry-run', 'verbose',
316
Option('file-ids-from', type=unicode,
317
help='Lookup file ids from here')]
318
encoding_type = 'replace'
320
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
324
if file_ids_from is not None:
326
base_tree, base_path = WorkingTree.open_containing(
328
except errors.NoWorkingTree:
329
base_branch, base_path = Branch.open_containing(
331
base_tree = base_branch.basis_tree()
333
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
334
to_file=self.outf, should_print=(not is_quiet()))
336
action = bzrlib.add.AddAction(to_file=self.outf,
337
should_print=(not is_quiet()))
339
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
340
action=action, save=not dry_run)
343
for glob in sorted(ignored.keys()):
344
for path in ignored[glob]:
345
self.outf.write("ignored %s matching \"%s\"\n"
349
for glob, paths in ignored.items():
350
match_len += len(paths)
351
self.outf.write("ignored %d file(s).\n" % match_len)
352
self.outf.write("If you wish to add some of these files,"
353
" please add them by name.\n")
356
class cmd_mkdir(Command):
357
"""Create a new versioned directory.
359
This is equivalent to creating the directory and then adding it.
362
takes_args = ['dir+']
363
encoding_type = 'replace'
365
def run(self, dir_list):
368
wt, dd = WorkingTree.open_containing(d)
370
self.outf.write('added %s\n' % d)
373
class cmd_relpath(Command):
374
"""Show path of a file relative to root"""
376
takes_args = ['filename']
380
def run(self, filename):
381
# TODO: jam 20050106 Can relpath return a munged path if
382
# sys.stdout encoding cannot represent it?
383
tree, relpath = WorkingTree.open_containing(filename)
384
self.outf.write(relpath)
385
self.outf.write('\n')
388
class cmd_inventory(Command):
389
"""Show inventory of the current working copy or a revision.
391
It is possible to limit the output to a particular entry
392
type using the --kind option. For example: --kind file.
394
It is also possible to restrict the list of files to a specific
395
set. For example: bzr inventory --show-ids this/file
398
takes_options = ['revision', 'show-ids', 'kind']
399
takes_args = ['file*']
402
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
403
if kind and kind not in ['file', 'directory', 'symlink']:
404
raise errors.BzrCommandError('invalid kind specified')
406
work_tree, file_list = tree_files(file_list)
408
if revision is not None:
409
if len(revision) > 1:
410
raise errors.BzrCommandError('bzr inventory --revision takes'
411
' exactly one revision identifier')
412
revision_id = revision[0].in_history(work_tree.branch).rev_id
413
tree = work_tree.branch.repository.revision_tree(revision_id)
415
# We include work_tree as well as 'tree' here
416
# So that doing '-r 10 path/foo' will lookup whatever file
417
# exists now at 'path/foo' even if it has been renamed, as
418
# well as whatever files existed in revision 10 at path/foo
419
trees = [tree, work_tree]
424
if file_list is not None:
425
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
426
require_versioned=True)
427
# find_ids_across_trees may include some paths that don't
429
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
430
for file_id in file_ids if file_id in tree)
432
entries = tree.inventory.entries()
434
for path, entry in entries:
435
if kind and kind != entry.kind:
438
self.outf.write('%-50s %s\n' % (path, entry.file_id))
440
self.outf.write(path)
441
self.outf.write('\n')
444
class cmd_mv(Command):
445
"""Move or rename a file.
448
bzr mv OLDNAME NEWNAME
449
bzr mv SOURCE... DESTINATION
451
If the last argument is a versioned directory, all the other names
452
are moved into it. Otherwise, there must be exactly two arguments
453
and the file is changed to a new name, which must not already exist.
455
Files cannot be moved between branches.
458
takes_args = ['names*']
459
aliases = ['move', 'rename']
460
encoding_type = 'replace'
462
def run(self, names_list):
463
if names_list is None:
466
if len(names_list) < 2:
467
raise errors.BzrCommandError("missing file argument")
468
tree, rel_names = tree_files(names_list)
470
if os.path.isdir(names_list[-1]):
471
# move into existing directory
472
for pair in tree.move(rel_names[:-1], rel_names[-1]):
473
self.outf.write("%s => %s\n" % pair)
475
if len(names_list) != 2:
476
raise errors.BzrCommandError('to mv multiple files the destination '
477
'must be a versioned directory')
478
tree.rename_one(rel_names[0], rel_names[1])
479
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
482
class cmd_pull(Command):
483
"""Turn this branch into a mirror of another branch.
485
This command only works on branches that have not diverged. Branches are
486
considered diverged if the destination branch's most recent commit is one
487
that has not been merged (directly or indirectly) into the parent.
489
If branches have diverged, you can use 'bzr merge' to integrate the changes
490
from one into the other. Once one branch has merged, the other should
491
be able to pull it again.
493
If you want to forget your local changes and just update your branch to
494
match the remote one, use pull --overwrite.
496
If there is no default location set, the first pull will set it. After
497
that, you can omit the location to use the default. To change the
498
default, use --remember. The value will only be saved if the remote
499
location can be accessed.
502
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
503
takes_args = ['location?']
504
encoding_type = 'replace'
506
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
507
# FIXME: too much stuff is in the command class
509
tree_to = WorkingTree.open_containing(u'.')[0]
510
branch_to = tree_to.branch
511
except errors.NoWorkingTree:
513
branch_to = Branch.open_containing(u'.')[0]
516
if location is not None:
518
reader = bundle.read_bundle_from_url(location)
519
except errors.NotABundle:
520
pass # Continue on considering this url a Branch
522
stored_loc = branch_to.get_parent()
524
if stored_loc is None:
525
raise errors.BzrCommandError("No pull location known or"
528
display_url = urlutils.unescape_for_display(stored_loc,
530
self.outf.write("Using saved location: %s\n" % display_url)
531
location = stored_loc
534
if reader is not None:
535
install_bundle(branch_to.repository, reader)
536
branch_from = branch_to
538
branch_from = Branch.open(location)
540
if branch_to.get_parent() is None or remember:
541
branch_to.set_parent(branch_from.base)
545
if reader is not None:
546
rev_id = reader.target
547
elif len(revision) == 1:
548
rev_id = revision[0].in_history(branch_from).rev_id
550
raise errors.BzrCommandError('bzr pull --revision takes one value.')
552
old_rh = branch_to.revision_history()
553
if tree_to is not None:
554
count = tree_to.pull(branch_from, overwrite, rev_id)
556
count = branch_to.pull(branch_from, overwrite, rev_id)
557
note('%d revision(s) pulled.' % (count,))
560
new_rh = branch_to.revision_history()
563
from bzrlib.log import show_changed_revisions
564
show_changed_revisions(branch_to, old_rh, new_rh,
568
class cmd_push(Command):
569
"""Update a mirror of this branch.
571
The target branch will not have its working tree populated because this
572
is both expensive, and is not supported on remote file systems.
574
Some smart servers or protocols *may* put the working tree in place in
577
This command only works on branches that have not diverged. Branches are
578
considered diverged if the destination branch's most recent commit is one
579
that has not been merged (directly or indirectly) by the source branch.
581
If branches have diverged, you can use 'bzr push --overwrite' to replace
582
the other branch completely, discarding its unmerged changes.
584
If you want to ensure you have the different changes in the other branch,
585
do a merge (see bzr help merge) from the other branch, and commit that.
586
After that you will be able to do a push without '--overwrite'.
588
If there is no default push location set, the first push will set it.
589
After that, you can omit the location to use the default. To change the
590
default, use --remember. The value will only be saved if the remote
591
location can be accessed.
594
takes_options = ['remember', 'overwrite', 'verbose',
595
Option('create-prefix',
596
help='Create the path leading up to the branch '
597
'if it does not already exist')]
598
takes_args = ['location?']
599
encoding_type = 'replace'
601
def run(self, location=None, remember=False, overwrite=False,
602
create_prefix=False, verbose=False):
603
# FIXME: Way too big! Put this into a function called from the
606
br_from = Branch.open_containing('.')[0]
607
stored_loc = br_from.get_push_location()
609
if stored_loc is None:
610
raise errors.BzrCommandError("No push location known or specified.")
612
display_url = urlutils.unescape_for_display(stored_loc,
614
self.outf.write("Using saved location: %s\n" % display_url)
615
location = stored_loc
617
to_transport = transport.get_transport(location)
618
location_url = to_transport.base
622
dir_to = bzrdir.BzrDir.open(location_url)
623
br_to = dir_to.open_branch()
624
except errors.NotBranchError:
626
to_transport = to_transport.clone('..')
627
if not create_prefix:
629
relurl = to_transport.relpath(location_url)
630
mutter('creating directory %s => %s', location_url, relurl)
631
to_transport.mkdir(relurl)
632
except errors.NoSuchFile:
633
raise errors.BzrCommandError("Parent directory of %s "
634
"does not exist." % location)
636
current = to_transport.base
637
needed = [(to_transport, to_transport.relpath(location_url))]
640
to_transport, relpath = needed[-1]
641
to_transport.mkdir(relpath)
643
except errors.NoSuchFile:
644
new_transport = to_transport.clone('..')
645
needed.append((new_transport,
646
new_transport.relpath(to_transport.base)))
647
if new_transport.base == to_transport.base:
648
raise errors.BzrCommandError("Could not create "
650
dir_to = br_from.bzrdir.clone(location_url,
651
revision_id=br_from.last_revision())
652
br_to = dir_to.open_branch()
653
count = len(br_to.revision_history())
654
# We successfully created the target, remember it
655
if br_from.get_push_location() is None or remember:
656
br_from.set_push_location(br_to.base)
658
# We were able to connect to the remote location, so remember it
659
# we don't need to successfully push because of possible divergence.
660
if br_from.get_push_location() is None or remember:
661
br_from.set_push_location(br_to.base)
662
old_rh = br_to.revision_history()
665
tree_to = dir_to.open_workingtree()
666
except errors.NotLocalUrl:
667
warning('This transport does not update the working '
668
'tree of: %s' % (br_to.base,))
669
count = br_to.pull(br_from, overwrite)
670
except errors.NoWorkingTree:
671
count = br_to.pull(br_from, overwrite)
673
count = tree_to.pull(br_from, overwrite)
674
except errors.DivergedBranches:
675
raise errors.BzrCommandError('These branches have diverged.'
676
' Try using "merge" and then "push".')
677
note('%d revision(s) pushed.' % (count,))
680
new_rh = br_to.revision_history()
683
from bzrlib.log import show_changed_revisions
684
show_changed_revisions(br_to, old_rh, new_rh,
688
class cmd_branch(Command):
689
"""Create a new copy of a branch.
691
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
692
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
694
To retrieve the branch as of a particular revision, supply the --revision
695
parameter, as in "branch foo/bar -r 5".
697
--basis is to speed up branching from remote branches. When specified, it
698
copies all the file-contents, inventory and revision data from the basis
699
branch before copying anything from the remote branch.
701
takes_args = ['from_location', 'to_location?']
702
takes_options = ['revision', 'basis']
703
aliases = ['get', 'clone']
705
def run(self, from_location, to_location=None, revision=None, basis=None):
708
elif len(revision) > 1:
709
raise errors.BzrCommandError(
710
'bzr branch --revision takes exactly 1 revision value')
712
br_from = Branch.open(from_location)
714
if e.errno == errno.ENOENT:
715
raise errors.BzrCommandError('Source location "%s" does not'
716
' exist.' % to_location)
721
if basis is not None:
722
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
725
if len(revision) == 1 and revision[0] is not None:
726
revision_id = revision[0].in_history(br_from)[1]
728
# FIXME - wt.last_revision, fallback to branch, fall back to
729
# None or perhaps NULL_REVISION to mean copy nothing
731
revision_id = br_from.last_revision()
732
if to_location is None:
733
to_location = os.path.basename(from_location.rstrip("/\\"))
736
name = os.path.basename(to_location) + '\n'
738
to_transport = transport.get_transport(to_location)
740
to_transport.mkdir('.')
741
except errors.FileExists:
742
raise errors.BzrCommandError('Target directory "%s" already'
743
' exists.' % to_location)
744
except errors.NoSuchFile:
745
raise errors.BzrCommandError('Parent of "%s" does not exist.'
748
# preserve whatever source format we have.
749
dir = br_from.bzrdir.sprout(to_transport.base,
750
revision_id, basis_dir)
751
branch = dir.open_branch()
752
except errors.NoSuchRevision:
753
to_transport.delete_tree('.')
754
msg = "The branch %s has no revision %s." % (from_location, revision[0])
755
raise errors.BzrCommandError(msg)
756
except errors.UnlistableBranch:
757
osutils.rmtree(to_location)
758
msg = "The branch %s cannot be used as a --basis" % (basis,)
759
raise errors.BzrCommandError(msg)
761
branch.control_files.put_utf8('branch-name', name)
762
note('Branched %d revision(s).' % branch.revno())
767
class cmd_checkout(Command):
768
"""Create a new checkout of an existing branch.
770
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
771
the branch found in '.'. This is useful if you have removed the working tree
772
or if it was never created - i.e. if you pushed the branch to its current
775
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
776
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
778
To retrieve the branch as of a particular revision, supply the --revision
779
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
780
out of date [so you cannot commit] but it may be useful (i.e. to examine old
783
--basis is to speed up checking out from remote branches. When specified, it
784
uses the inventory and file contents from the basis branch in preference to the
785
branch being checked out.
787
takes_args = ['branch_location?', 'to_location?']
788
takes_options = ['revision', # , 'basis']
789
Option('lightweight',
790
help="perform a lightweight checkout. Lightweight "
791
"checkouts depend on access to the branch for "
792
"every operation. Normal checkouts can perform "
793
"common operations like diff and status without "
794
"such access, and also support local commits."
799
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
803
elif len(revision) > 1:
804
raise errors.BzrCommandError(
805
'bzr checkout --revision takes exactly 1 revision value')
806
if branch_location is None:
807
branch_location = osutils.getcwd()
808
to_location = branch_location
809
source = Branch.open(branch_location)
810
if len(revision) == 1 and revision[0] is not None:
811
revision_id = revision[0].in_history(source)[1]
814
if to_location is None:
815
to_location = os.path.basename(branch_location.rstrip("/\\"))
816
# if the source and to_location are the same,
817
# and there is no working tree,
818
# then reconstitute a branch
819
if (osutils.abspath(to_location) ==
820
osutils.abspath(branch_location)):
822
source.bzrdir.open_workingtree()
823
except errors.NoWorkingTree:
824
source.bzrdir.create_workingtree()
827
os.mkdir(to_location)
829
if e.errno == errno.EEXIST:
830
raise errors.BzrCommandError('Target directory "%s" already'
831
' exists.' % to_location)
832
if e.errno == errno.ENOENT:
833
raise errors.BzrCommandError('Parent of "%s" does not exist.'
837
old_format = bzrdir.BzrDirFormat.get_default_format()
838
bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
840
source.create_checkout(to_location, revision_id, lightweight)
842
bzrdir.BzrDirFormat.set_default_format(old_format)
845
class cmd_renames(Command):
846
"""Show list of renamed files.
848
# TODO: Option to show renames between two historical versions.
850
# TODO: Only show renames under dir, rather than in the whole branch.
851
takes_args = ['dir?']
854
def run(self, dir=u'.'):
855
tree = WorkingTree.open_containing(dir)[0]
856
old_inv = tree.basis_tree().inventory
857
new_inv = tree.read_working_inventory()
858
renames = list(_mod_tree.find_renames(old_inv, new_inv))
860
for old_name, new_name in renames:
861
self.outf.write("%s => %s\n" % (old_name, new_name))
864
class cmd_update(Command):
865
"""Update a tree to have the latest code committed to its branch.
867
This will perform a merge into the working tree, and may generate
868
conflicts. If you have any local changes, you will still
869
need to commit them after the update for the update to be complete.
871
If you want to discard your local changes, you can just do a
872
'bzr revert' instead of 'bzr commit' after the update.
874
takes_args = ['dir?']
877
def run(self, dir='.'):
878
tree = WorkingTree.open_containing(dir)[0]
879
master = tree.branch.get_master_branch()
880
if master is not None:
883
tree.lock_tree_write()
885
existing_pending_merges = tree.get_parent_ids()[1:]
886
last_rev = tree.last_revision()
887
if last_rev == tree.branch.last_revision():
888
# may be up to date, check master too.
889
master = tree.branch.get_master_branch()
890
if master is None or last_rev == master.last_revision():
891
revno = tree.branch.revision_id_to_revno(last_rev)
892
note("Tree is up to date at revision %d." % (revno,))
894
conflicts = tree.update()
895
revno = tree.branch.revision_id_to_revno(tree.last_revision())
896
note('Updated to revision %d.' % (revno,))
897
if tree.get_parent_ids()[1:] != existing_pending_merges:
898
note('Your local commits will now show as pending merges with '
899
"'bzr status', and can be committed with 'bzr commit'.")
908
class cmd_info(Command):
909
"""Show information about a working tree, branch or repository.
911
This command will show all known locations and formats associated to the
912
tree, branch or repository. Statistical information is included with
915
Branches and working trees will also report any missing revisions.
917
takes_args = ['location?']
918
takes_options = ['verbose']
921
def run(self, location=None, verbose=False):
922
from bzrlib.info import show_bzrdir_info
923
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
927
class cmd_remove(Command):
928
"""Make a file unversioned.
930
This makes bzr stop tracking changes to a versioned file. It does
931
not delete the working copy.
933
You can specify one or more files, and/or --new. If you specify --new,
934
only 'added' files will be removed. If you specify both, then new files
935
in the specified directories will be removed. If the directories are
936
also new, they will also be removed.
938
takes_args = ['file*']
939
takes_options = ['verbose', Option('new', help='remove newly-added files')]
941
encoding_type = 'replace'
943
def run(self, file_list, verbose=False, new=False):
944
tree, file_list = tree_files(file_list)
946
if file_list is None:
947
raise errors.BzrCommandError('Specify one or more files to'
948
' remove, or use --new.')
950
added = tree.changes_from(tree.basis_tree(),
951
specific_files=file_list).added
952
file_list = sorted([f[0] for f in added], reverse=True)
953
if len(file_list) == 0:
954
raise errors.BzrCommandError('No matching files.')
955
tree.remove(file_list, verbose=verbose, to_file=self.outf)
958
class cmd_file_id(Command):
959
"""Print file_id of a particular file or directory.
961
The file_id is assigned when the file is first added and remains the
962
same through all revisions where the file exists, even when it is
967
takes_args = ['filename']
970
def run(self, filename):
971
tree, relpath = WorkingTree.open_containing(filename)
972
i = tree.inventory.path2id(relpath)
974
raise errors.NotVersionedError(filename)
976
self.outf.write(i + '\n')
979
class cmd_file_path(Command):
980
"""Print path of file_ids to a file or directory.
982
This prints one line for each directory down to the target,
983
starting at the branch root.
987
takes_args = ['filename']
990
def run(self, filename):
991
tree, relpath = WorkingTree.open_containing(filename)
993
fid = inv.path2id(relpath)
995
raise errors.NotVersionedError(filename)
996
for fip in inv.get_idpath(fid):
997
self.outf.write(fip + '\n')
1000
class cmd_reconcile(Command):
1001
"""Reconcile bzr metadata in a branch.
1003
This can correct data mismatches that may have been caused by
1004
previous ghost operations or bzr upgrades. You should only
1005
need to run this command if 'bzr check' or a bzr developer
1006
advises you to run it.
1008
If a second branch is provided, cross-branch reconciliation is
1009
also attempted, which will check that data like the tree root
1010
id which was not present in very early bzr versions is represented
1011
correctly in both branches.
1013
At the same time it is run it may recompress data resulting in
1014
a potential saving in disk space or performance gain.
1016
The branch *MUST* be on a listable system such as local disk or sftp.
1018
takes_args = ['branch?']
1020
def run(self, branch="."):
1021
from bzrlib.reconcile import reconcile
1022
dir = bzrdir.BzrDir.open(branch)
1026
class cmd_revision_history(Command):
1027
"""Display the list of revision ids on a branch."""
1028
takes_args = ['location?']
1033
def run(self, location="."):
1034
branch = Branch.open_containing(location)[0]
1035
for revid in branch.revision_history():
1036
self.outf.write(revid)
1037
self.outf.write('\n')
1040
class cmd_ancestry(Command):
1041
"""List all revisions merged into this branch."""
1042
takes_args = ['location?']
1047
def run(self, location="."):
1049
wt = WorkingTree.open_containing(location)[0]
1050
except errors.NoWorkingTree:
1051
b = Branch.open(location)
1052
last_revision = b.last_revision()
1055
last_revision = wt.last_revision()
1057
revision_ids = b.repository.get_ancestry(last_revision)
1058
assert revision_ids[0] is None
1060
for revision_id in revision_ids:
1061
self.outf.write(revision_id + '\n')
1064
class cmd_init(Command):
1065
"""Make a directory into a versioned branch.
1067
Use this to create an empty branch, or before importing an
1070
If there is a repository in a parent directory of the location, then
1071
the history of the branch will be stored in the repository. Otherwise
1072
init creates a standalone branch which carries its own history in
1075
If there is already a branch at the location but it has no working tree,
1076
the tree can be populated with 'bzr checkout'.
1078
Recipe for importing a tree of files:
1083
bzr commit -m 'imported project'
1085
takes_args = ['location?']
1088
help='Specify a format for this branch. Current'
1089
' formats are: default, knit, metaweave and'
1090
' weave. Default is knit; metaweave and'
1091
' weave are deprecated',
1092
type=get_format_type),
1094
def run(self, location=None, format=None):
1096
format = get_format_type('default')
1097
if location is None:
1100
to_transport = transport.get_transport(location)
1102
# The path has to exist to initialize a
1103
# branch inside of it.
1104
# Just using os.mkdir, since I don't
1105
# believe that we want to create a bunch of
1106
# locations if the user supplies an extended path
1107
# TODO: create-prefix
1109
to_transport.mkdir('.')
1110
except errors.FileExists:
1114
existing_bzrdir = bzrdir.BzrDir.open(location)
1115
except errors.NotBranchError:
1116
# really a NotBzrDir error...
1117
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1119
from bzrlib.transport.local import LocalTransport
1120
if existing_bzrdir.has_branch():
1121
if (isinstance(to_transport, LocalTransport)
1122
and not existing_bzrdir.has_workingtree()):
1123
raise errors.BranchExistsWithoutWorkingTree(location)
1124
raise errors.AlreadyBranchError(location)
1126
existing_bzrdir.create_branch()
1127
existing_bzrdir.create_workingtree()
1130
class cmd_init_repository(Command):
1131
"""Create a shared repository to hold branches.
1133
New branches created under the repository directory will store their revisions
1134
in the repository, not in the branch directory, if the branch format supports
1140
bzr checkout --lightweight repo/trunk trunk-checkout
1144
takes_args = ["location"]
1145
takes_options = [Option('format',
1146
help='Specify a format for this repository.'
1147
' Current formats are: default, knit,'
1148
' metaweave and weave. Default is knit;'
1149
' metaweave and weave are deprecated',
1150
type=get_format_type),
1152
help='Allows branches in repository to have'
1154
aliases = ["init-repo"]
1155
def run(self, location, format=None, trees=False):
1157
format = get_format_type('default')
1159
if location is None:
1162
to_transport = transport.get_transport(location)
1164
to_transport.mkdir('.')
1165
except errors.FileExists:
1168
newdir = format.initialize_on_transport(to_transport)
1169
repo = newdir.create_repository(shared=True)
1170
repo.set_make_working_trees(trees)
1173
class cmd_diff(Command):
1174
"""Show differences in the working tree or between revisions.
1176
If files are listed, only the changes in those files are listed.
1177
Otherwise, all changes for the tree are listed.
1179
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1180
produces patches suitable for "patch -p1".
1184
Shows the difference in the working tree versus the last commit
1186
Difference between the working tree and revision 1
1188
Difference between revision 2 and revision 1
1189
bzr diff --diff-prefix old/:new/
1190
Same as 'bzr diff' but prefix paths with old/ and new/
1191
bzr diff bzr.mine bzr.dev
1192
Show the differences between the two working trees
1194
Show just the differences for 'foo.c'
1196
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1197
# or a graphical diff.
1199
# TODO: Python difflib is not exactly the same as unidiff; should
1200
# either fix it up or prefer to use an external diff.
1202
# TODO: Selected-file diff is inefficient and doesn't show you
1205
# TODO: This probably handles non-Unix newlines poorly.
1207
takes_args = ['file*']
1208
takes_options = ['revision', 'diff-options',
1209
Option('prefix', type=str,
1211
help='Set prefixes to added to old and new filenames, as '
1212
'two values separated by a colon.'),
1214
aliases = ['di', 'dif']
1215
encoding_type = 'exact'
1218
def run(self, revision=None, file_list=None, diff_options=None,
1220
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1222
if (prefix is None) or (prefix == '0'):
1230
old_label, new_label = prefix.split(":")
1232
raise BzrCommandError(
1233
"--prefix expects two values separated by a colon")
1235
if revision and len(revision) > 2:
1236
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1237
' one or two revision specifiers')
1240
tree1, file_list = internal_tree_files(file_list)
1244
except errors.FileInWrongBranch:
1245
if len(file_list) != 2:
1246
raise errors.BzrCommandError("Files are in different branches")
1248
tree1, file1 = WorkingTree.open_containing(file_list[0])
1249
tree2, file2 = WorkingTree.open_containing(file_list[1])
1250
if file1 != "" or file2 != "":
1251
# FIXME diff those two files. rbc 20051123
1252
raise errors.BzrCommandError("Files are in different branches")
1254
except errors.NotBranchError:
1255
if (revision is not None and len(revision) == 2
1256
and not revision[0].needs_branch()
1257
and not revision[1].needs_branch()):
1258
# If both revision specs include a branch, we can
1259
# diff them without needing a local working tree
1260
tree1, tree2 = None, None
1264
if tree2 is not None:
1265
if revision is not None:
1266
# FIXME: but there should be a clean way to diff between
1267
# non-default versions of two trees, it's not hard to do
1269
raise errors.BzrCommandError(
1270
"Sorry, diffing arbitrary revisions across branches "
1271
"is not implemented yet")
1272
return show_diff_trees(tree1, tree2, sys.stdout,
1273
specific_files=file_list,
1274
external_diff_options=diff_options,
1275
old_label=old_label, new_label=new_label)
1277
return diff_cmd_helper(tree1, file_list, diff_options,
1278
revision_specs=revision,
1279
old_label=old_label, new_label=new_label)
1282
class cmd_deleted(Command):
1283
"""List files deleted in the working tree.
1285
# TODO: Show files deleted since a previous revision, or
1286
# between two revisions.
1287
# TODO: Much more efficient way to do this: read in new
1288
# directories with readdir, rather than stating each one. Same
1289
# level of effort but possibly much less IO. (Or possibly not,
1290
# if the directories are very large...)
1291
takes_options = ['show-ids']
1294
def run(self, show_ids=False):
1295
tree = WorkingTree.open_containing(u'.')[0]
1296
old = tree.basis_tree()
1297
for path, ie in old.inventory.iter_entries():
1298
if not tree.has_id(ie.file_id):
1299
self.outf.write(path)
1301
self.outf.write(' ')
1302
self.outf.write(ie.file_id)
1303
self.outf.write('\n')
1306
class cmd_modified(Command):
1307
"""List files modified in working tree."""
1311
tree = WorkingTree.open_containing(u'.')[0]
1312
td = tree.changes_from(tree.basis_tree())
1313
for path, id, kind, text_modified, meta_modified in td.modified:
1314
self.outf.write(path + '\n')
1317
class cmd_added(Command):
1318
"""List files added in working tree."""
1322
wt = WorkingTree.open_containing(u'.')[0]
1323
basis_inv = wt.basis_tree().inventory
1326
if file_id in basis_inv:
1328
if inv.is_root(file_id) and len(basis_inv) == 0:
1330
path = inv.id2path(file_id)
1331
if not os.access(osutils.abspath(path), os.F_OK):
1333
self.outf.write(path + '\n')
1336
class cmd_root(Command):
1337
"""Show the tree root directory.
1339
The root is the nearest enclosing directory with a .bzr control
1341
takes_args = ['filename?']
1343
def run(self, filename=None):
1344
"""Print the branch root."""
1345
tree = WorkingTree.open_containing(filename)[0]
1346
self.outf.write(tree.basedir + '\n')
1349
class cmd_log(Command):
1350
"""Show log of a branch, file, or directory.
1352
By default show the log of the branch containing the working directory.
1354
To request a range of logs, you can use the command -r begin..end
1355
-r revision requests a specific revision, -r ..end or -r begin.. are
1361
bzr log -r -10.. http://server/branch
1364
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1366
takes_args = ['location?']
1367
takes_options = [Option('forward',
1368
help='show from oldest to newest'),
1372
help='show files changed in each revision'),
1373
'show-ids', 'revision',
1378
help='show revisions whose message matches this regexp',
1382
encoding_type = 'replace'
1385
def run(self, location=None, timezone='original',
1395
from bzrlib.log import log_formatter, show_log
1396
assert message is None or isinstance(message, basestring), \
1397
"invalid message argument %r" % message
1398
direction = (forward and 'forward') or 'reverse'
1403
# find the file id to log:
1405
dir, fp = bzrdir.BzrDir.open_containing(location)
1406
b = dir.open_branch()
1410
inv = dir.open_workingtree().inventory
1411
except (errors.NotBranchError, errors.NotLocalUrl):
1412
# either no tree, or is remote.
1413
inv = b.basis_tree().inventory
1414
file_id = inv.path2id(fp)
1416
raise errors.BzrCommandError(
1417
"Path does not have any revision history: %s" %
1421
# FIXME ? log the current subdir only RBC 20060203
1422
if revision is not None \
1423
and len(revision) > 0 and revision[0].get_branch():
1424
location = revision[0].get_branch()
1427
dir, relpath = bzrdir.BzrDir.open_containing(location)
1428
b = dir.open_branch()
1430
if revision is None:
1433
elif len(revision) == 1:
1434
rev1 = rev2 = revision[0].in_history(b).revno
1435
elif len(revision) == 2:
1436
if revision[1].get_branch() != revision[0].get_branch():
1437
# b is taken from revision[0].get_branch(), and
1438
# show_log will use its revision_history. Having
1439
# different branches will lead to weird behaviors.
1440
raise errors.BzrCommandError(
1441
"Log doesn't accept two revisions in different branches.")
1442
if revision[0].spec is None:
1443
# missing begin-range means first revision
1446
rev1 = revision[0].in_history(b).revno
1448
if revision[1].spec is None:
1449
# missing end-range means last known revision
1452
rev2 = revision[1].in_history(b).revno
1454
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1456
# By this point, the revision numbers are converted to the +ve
1457
# form if they were supplied in the -ve form, so we can do
1458
# this comparison in relative safety
1460
(rev2, rev1) = (rev1, rev2)
1462
if (log_format is None):
1463
default = b.get_config().log_format()
1464
log_format = get_log_format(long=long, short=short, line=line,
1466
lf = log_formatter(log_format,
1469
show_timezone=timezone)
1475
direction=direction,
1476
start_revision=rev1,
1481
def get_log_format(long=False, short=False, line=False, default='long'):
1482
log_format = default
1486
log_format = 'short'
1492
class cmd_touching_revisions(Command):
1493
"""Return revision-ids which affected a particular file.
1495
A more user-friendly interface is "bzr log FILE".
1499
takes_args = ["filename"]
1502
def run(self, filename):
1503
tree, relpath = WorkingTree.open_containing(filename)
1505
inv = tree.read_working_inventory()
1506
file_id = inv.path2id(relpath)
1507
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1508
self.outf.write("%6d %s\n" % (revno, what))
1511
class cmd_ls(Command):
1512
"""List files in a tree.
1515
takes_args = ['path?']
1516
# TODO: Take a revision or remote path and list that tree instead.
1517
takes_options = ['verbose', 'revision',
1518
Option('non-recursive',
1519
help='don\'t recurse into sub-directories'),
1521
help='Print all paths from the root of the branch.'),
1522
Option('unknown', help='Print unknown files'),
1523
Option('versioned', help='Print versioned files'),
1524
Option('ignored', help='Print ignored files'),
1526
Option('null', help='Null separate the files'),
1530
def run(self, revision=None, verbose=False,
1531
non_recursive=False, from_root=False,
1532
unknown=False, versioned=False, ignored=False,
1533
null=False, kind=None, show_ids=False, path=None):
1535
if kind and kind not in ('file', 'directory', 'symlink'):
1536
raise errors.BzrCommandError('invalid kind specified')
1538
if verbose and null:
1539
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1540
all = not (unknown or versioned or ignored)
1542
selection = {'I':ignored, '?':unknown, 'V':versioned}
1549
raise errors.BzrCommandError('cannot specify both --from-root'
1553
tree, relpath = WorkingTree.open_containing(fs_path)
1558
if revision is not None:
1559
tree = tree.branch.repository.revision_tree(
1560
revision[0].in_history(tree.branch).rev_id)
1562
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1563
if fp.startswith(relpath):
1564
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1565
if non_recursive and '/' in fp:
1567
if not all and not selection[fc]:
1569
if kind is not None and fkind != kind:
1572
kindch = entry.kind_character()
1573
outstring = '%-8s %s%s' % (fc, fp, kindch)
1574
if show_ids and fid is not None:
1575
outstring = "%-50s %s" % (outstring, fid)
1576
self.outf.write(outstring + '\n')
1578
self.outf.write(fp + '\0')
1581
self.outf.write(fid)
1582
self.outf.write('\0')
1590
self.outf.write('%-50s %s\n' % (fp, my_id))
1592
self.outf.write(fp + '\n')
1595
class cmd_unknowns(Command):
1596
"""List unknown files."""
1599
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1600
self.outf.write(osutils.quotefn(f) + '\n')
1603
class cmd_ignore(Command):
1604
"""Ignore specified files or patterns.
1606
To remove patterns from the ignore list, edit the .bzrignore file.
1608
Trailing slashes on patterns are ignored.
1609
If the pattern contains a slash or is a regular expression, it is compared
1610
to the whole path from the branch root. Otherwise, it is compared to only
1611
the last component of the path. To match a file only in the root
1612
directory, prepend './'.
1614
Ignore patterns specifying absolute paths are not allowed.
1616
Ignore patterns may include globbing wildcards such as:
1617
? - Matches any single character except '/'
1618
* - Matches 0 or more characters except '/'
1619
/**/ - Matches 0 or more directories in a path
1620
[a-z] - Matches a single character from within a group of characters
1622
Ignore patterns may also be Python regular expressions.
1623
Regular expression ignore patterns are identified by a 'RE:' prefix
1624
followed by the regular expression. Regular expression ignore patterns
1625
may not include named or numbered groups.
1627
Note: ignore patterns containing shell wildcards must be quoted from
1631
bzr ignore ./Makefile
1632
bzr ignore '*.class'
1633
bzr ignore 'lib/**/*.o'
1634
bzr ignore 'RE:lib/.*\.o'
1636
takes_args = ['name_pattern*']
1638
Option('old-default-rules',
1639
help='Out the ignore rules bzr < 0.9 always used.')
1642
def run(self, name_pattern_list=None, old_default_rules=None):
1643
from bzrlib.atomicfile import AtomicFile
1644
if old_default_rules is not None:
1645
# dump the rules and exit
1646
for pattern in ignores.OLD_DEFAULTS:
1649
if not name_pattern_list:
1650
raise errors.BzrCommandError("ignore requires at least one "
1651
"NAME_PATTERN or --old-default-rules")
1652
for name_pattern in name_pattern_list:
1653
if name_pattern[0] == '/':
1654
raise errors.BzrCommandError(
1655
"NAME_PATTERN should not be an absolute path")
1656
tree, relpath = WorkingTree.open_containing(u'.')
1657
ifn = tree.abspath('.bzrignore')
1658
if os.path.exists(ifn):
1661
igns = f.read().decode('utf-8')
1667
# TODO: If the file already uses crlf-style termination, maybe
1668
# we should use that for the newly added lines?
1670
if igns and igns[-1] != '\n':
1672
for name_pattern in name_pattern_list:
1673
igns += name_pattern.rstrip('/') + '\n'
1675
f = AtomicFile(ifn, 'wb')
1677
f.write(igns.encode('utf-8'))
1682
inv = tree.inventory
1683
if inv.path2id('.bzrignore'):
1684
mutter('.bzrignore is already versioned')
1686
mutter('need to make new .bzrignore file versioned')
1687
tree.add(['.bzrignore'])
1690
class cmd_ignored(Command):
1691
"""List ignored files and the patterns that matched them.
1693
See also: bzr ignore"""
1696
tree = WorkingTree.open_containing(u'.')[0]
1697
for path, file_class, kind, file_id, entry in tree.list_files():
1698
if file_class != 'I':
1700
## XXX: Slightly inefficient since this was already calculated
1701
pat = tree.is_ignored(path)
1702
print '%-50s %s' % (path, pat)
1705
class cmd_lookup_revision(Command):
1706
"""Lookup the revision-id from a revision-number
1709
bzr lookup-revision 33
1712
takes_args = ['revno']
1715
def run(self, revno):
1719
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1721
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1724
class cmd_export(Command):
1725
"""Export past revision to destination directory.
1727
If no revision is specified this exports the last committed revision.
1729
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1730
given, try to find the format with the extension. If no extension
1731
is found exports to a directory (equivalent to --format=dir).
1733
Root may be the top directory for tar, tgz and tbz2 formats. If none
1734
is given, the top directory will be the root name of the file.
1736
If branch is omitted then the branch containing the CWD will be used.
1738
Note: export of tree with non-ascii filenames to zip is not supported.
1740
Supported formats Autodetected by extension
1741
----------------- -------------------------
1744
tbz2 .tar.bz2, .tbz2
1748
takes_args = ['dest', 'branch?']
1749
takes_options = ['revision', 'format', 'root']
1750
def run(self, dest, branch=None, revision=None, format=None, root=None):
1751
from bzrlib.export import export
1754
tree = WorkingTree.open_containing(u'.')[0]
1757
b = Branch.open(branch)
1759
if revision is None:
1760
# should be tree.last_revision FIXME
1761
rev_id = b.last_revision()
1763
if len(revision) != 1:
1764
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1765
rev_id = revision[0].in_history(b).rev_id
1766
t = b.repository.revision_tree(rev_id)
1768
export(t, dest, format, root)
1769
except errors.NoSuchExportFormat, e:
1770
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1773
class cmd_cat(Command):
1774
"""Write a file's text from a previous revision."""
1776
takes_options = ['revision', 'name-from-revision']
1777
takes_args = ['filename']
1778
encoding_type = 'exact'
1781
def run(self, filename, revision=None, name_from_revision=False):
1782
if revision is not None and len(revision) != 1:
1783
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1788
tree, relpath = WorkingTree.open_containing(filename)
1790
except (errors.NotBranchError, errors.NotLocalUrl):
1793
if revision is not None and revision[0].get_branch() is not None:
1794
b = Branch.open(revision[0].get_branch())
1796
b, relpath = Branch.open_containing(filename)
1797
tree = b.basis_tree()
1798
if revision is None:
1799
revision_id = b.last_revision()
1801
revision_id = revision[0].in_history(b).rev_id
1803
cur_file_id = tree.path2id(relpath)
1804
rev_tree = b.repository.revision_tree(revision_id)
1805
old_file_id = rev_tree.path2id(relpath)
1807
if name_from_revision:
1808
if old_file_id is None:
1809
raise errors.BzrCommandError("%r is not present in revision %s"
1810
% (filename, revision_id))
1812
rev_tree.print_file(old_file_id)
1813
elif cur_file_id is not None:
1814
rev_tree.print_file(cur_file_id)
1815
elif old_file_id is not None:
1816
rev_tree.print_file(old_file_id)
1818
raise errors.BzrCommandError("%r is not present in revision %s" %
1819
(filename, revision_id))
1822
class cmd_local_time_offset(Command):
1823
"""Show the offset in seconds from GMT to local time."""
1827
print osutils.local_time_offset()
1831
class cmd_commit(Command):
1832
"""Commit changes into a new revision.
1834
If no arguments are given, the entire tree is committed.
1836
If selected files are specified, only changes to those files are
1837
committed. If a directory is specified then the directory and everything
1838
within it is committed.
1840
A selected-file commit may fail in some cases where the committed
1841
tree would be invalid, such as trying to commit a file in a
1842
newly-added directory that is not itself committed.
1844
# TODO: Run hooks on tree to-be-committed, and after commit.
1846
# TODO: Strict commit that fails if there are deleted files.
1847
# (what does "deleted files" mean ??)
1849
# TODO: Give better message for -s, --summary, used by tla people
1851
# XXX: verbose currently does nothing
1853
takes_args = ['selected*']
1854
takes_options = ['message', 'verbose',
1856
help='commit even if nothing has changed'),
1857
Option('file', type=str,
1860
help='file containing commit message'),
1862
help="refuse to commit if there are unknown "
1863
"files in the working tree."),
1865
help="perform a local only commit in a bound "
1866
"branch. Such commits are not pushed to "
1867
"the master branch until a normal commit "
1871
aliases = ['ci', 'checkin']
1873
def run(self, message=None, file=None, verbose=True, selected_list=None,
1874
unchanged=False, strict=False, local=False):
1875
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1876
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1878
from bzrlib.msgeditor import edit_commit_message, \
1879
make_commit_message_template
1881
# TODO: Need a blackbox test for invoking the external editor; may be
1882
# slightly problematic to run this cross-platform.
1884
# TODO: do more checks that the commit will succeed before
1885
# spending the user's valuable time typing a commit message.
1886
tree, selected_list = tree_files(selected_list)
1887
if selected_list == ['']:
1888
# workaround - commit of root of tree should be exactly the same
1889
# as just default commit in that tree, and succeed even though
1890
# selected-file merge commit is not done yet
1893
if local and not tree.branch.get_bound_location():
1894
raise errors.LocalRequiresBoundBranch()
1896
def get_message(commit_obj):
1897
"""Callback to get commit message"""
1898
my_message = message
1899
if my_message is None and not file:
1900
template = make_commit_message_template(tree, selected_list)
1901
my_message = edit_commit_message(template)
1902
if my_message is None:
1903
raise errors.BzrCommandError("please specify a commit"
1904
" message with either --message or --file")
1905
elif my_message and file:
1906
raise errors.BzrCommandError(
1907
"please specify either --message or --file")
1909
my_message = codecs.open(file, 'rt',
1910
bzrlib.user_encoding).read()
1911
if my_message == "":
1912
raise errors.BzrCommandError("empty commit message specified")
1916
reporter = ReportCommitToLog()
1918
reporter = NullCommitReporter()
1921
tree.commit(message_callback=get_message,
1922
specific_files=selected_list,
1923
allow_pointless=unchanged, strict=strict, local=local,
1925
except PointlessCommit:
1926
# FIXME: This should really happen before the file is read in;
1927
# perhaps prepare the commit; get the message; then actually commit
1928
raise errors.BzrCommandError("no changes to commit."
1929
" use --unchanged to commit anyhow")
1930
except ConflictsInTree:
1931
raise errors.BzrCommandError('Conflicts detected in working '
1932
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
1934
except StrictCommitFailed:
1935
raise errors.BzrCommandError("Commit refused because there are"
1936
" unknown files in the working tree.")
1937
except errors.BoundBranchOutOfDate, e:
1938
raise errors.BzrCommandError(str(e) + "\n"
1939
'To commit to master branch, run update and then commit.\n'
1940
'You can also pass --local to commit to continue working '
1944
class cmd_check(Command):
1945
"""Validate consistency of branch history.
1947
This command checks various invariants about the branch storage to
1948
detect data corruption or bzr bugs.
1950
takes_args = ['branch?']
1951
takes_options = ['verbose']
1953
def run(self, branch=None, verbose=False):
1954
from bzrlib.check import check
1956
tree = WorkingTree.open_containing()[0]
1957
branch = tree.branch
1959
branch = Branch.open(branch)
1960
check(branch, verbose)
1963
class cmd_upgrade(Command):
1964
"""Upgrade branch storage to current format.
1966
The check command or bzr developers may sometimes advise you to run
1967
this command. When the default format has changed you may also be warned
1968
during other operations to upgrade.
1970
takes_args = ['url?']
1973
help='Upgrade to a specific format. Current formats'
1974
' are: default, knit, metaweave and weave.'
1975
' Default is knit; metaweave and weave are'
1977
type=get_format_type),
1981
def run(self, url='.', format=None):
1982
from bzrlib.upgrade import upgrade
1984
format = get_format_type('default')
1985
upgrade(url, format)
1988
class cmd_whoami(Command):
1989
"""Show or set bzr user id.
1993
bzr whoami 'Frank Chu <fchu@example.com>'
1995
takes_options = [ Option('email',
1996
help='display email address only'),
1998
help='set identity for the current branch instead of '
2001
takes_args = ['name?']
2002
encoding_type = 'replace'
2005
def run(self, email=False, branch=False, name=None):
2007
# use branch if we're inside one; otherwise global config
2009
c = Branch.open_containing('.')[0].get_config()
2010
except errors.NotBranchError:
2011
c = config.GlobalConfig()
2013
self.outf.write(c.user_email() + '\n')
2015
self.outf.write(c.username() + '\n')
2018
# display a warning if an email address isn't included in the given name.
2020
config.extract_email_address(name)
2021
except errors.NoEmailInUsername, e:
2022
warning('"%s" does not seem to contain an email address. '
2023
'This is allowed, but not recommended.', name)
2025
# use global config unless --branch given
2027
c = Branch.open_containing('.')[0].get_config()
2029
c = config.GlobalConfig()
2030
c.set_user_option('email', name)
2033
class cmd_nick(Command):
2034
"""Print or set the branch nickname.
2036
If unset, the tree root directory name is used as the nickname
2037
To print the current nickname, execute with no argument.
2039
takes_args = ['nickname?']
2040
def run(self, nickname=None):
2041
branch = Branch.open_containing(u'.')[0]
2042
if nickname is None:
2043
self.printme(branch)
2045
branch.nick = nickname
2048
def printme(self, branch):
2052
class cmd_selftest(Command):
2053
"""Run internal test suite.
2055
This creates temporary test directories in the working directory,
2056
but not existing data is affected. These directories are deleted
2057
if the tests pass, or left behind to help in debugging if they
2058
fail and --keep-output is specified.
2060
If arguments are given, they are regular expressions that say
2061
which tests should run.
2063
If the global option '--no-plugins' is given, plugins are not loaded
2064
before running the selftests. This has two effects: features provided or
2065
modified by plugins will not be tested, and tests provided by plugins will
2070
bzr --no-plugins selftest -v
2072
# TODO: --list should give a list of all available tests
2074
# NB: this is used from the class without creating an instance, which is
2075
# why it does not have a self parameter.
2076
def get_transport_type(typestring):
2077
"""Parse and return a transport specifier."""
2078
if typestring == "sftp":
2079
from bzrlib.transport.sftp import SFTPAbsoluteServer
2080
return SFTPAbsoluteServer
2081
if typestring == "memory":
2082
from bzrlib.transport.memory import MemoryServer
2084
if typestring == "fakenfs":
2085
from bzrlib.transport.fakenfs import FakeNFSServer
2086
return FakeNFSServer
2087
msg = "No known transport type %s. Supported types are: sftp\n" %\
2089
raise errors.BzrCommandError(msg)
2092
takes_args = ['testspecs*']
2093
takes_options = ['verbose',
2094
Option('one', help='stop when one test fails'),
2095
Option('keep-output',
2096
help='keep output directories when tests fail'),
2098
help='Use a different transport by default '
2099
'throughout the test suite.',
2100
type=get_transport_type),
2101
Option('benchmark', help='run the bzr bencharks.'),
2102
Option('lsprof-timed',
2103
help='generate lsprof output for benchmarked'
2104
' sections of code.'),
2105
Option('cache-dir', type=str,
2106
help='a directory to cache intermediate'
2107
' benchmark steps'),
2108
Option('clean-output',
2109
help='clean temporary tests directories'
2110
' without running tests'),
2112
encoding_type = 'replace'
2114
def run(self, testspecs_list=None, verbose=None, one=False,
2115
keep_output=False, transport=None, benchmark=None,
2116
lsprof_timed=None, cache_dir=None, clean_output=False):
2118
from bzrlib.tests import selftest
2119
import bzrlib.benchmarks as benchmarks
2120
from bzrlib.benchmarks import tree_creator
2123
from bzrlib.tests import clean_selftest_output
2124
clean_selftest_output()
2127
if cache_dir is not None:
2128
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2129
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2130
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2132
if testspecs_list is not None:
2133
pattern = '|'.join(testspecs_list)
2137
test_suite_factory = benchmarks.test_suite
2140
# TODO: should possibly lock the history file...
2141
benchfile = open(".perf_history", "at", buffering=1)
2143
test_suite_factory = None
2148
result = selftest(verbose=verbose,
2150
stop_on_failure=one,
2151
keep_output=keep_output,
2152
transport=transport,
2153
test_suite_factory=test_suite_factory,
2154
lsprof_timed=lsprof_timed,
2155
bench_history=benchfile)
2157
if benchfile is not None:
2160
info('tests passed')
2162
info('tests failed')
2163
return int(not result)
2166
class cmd_version(Command):
2167
"""Show version of bzr."""
2171
from bzrlib.version import show_version
2175
class cmd_rocks(Command):
2176
"""Statement of optimism."""
2182
print "it sure does!"
2185
class cmd_find_merge_base(Command):
2186
"""Find and print a base revision for merging two branches."""
2187
# TODO: Options to specify revisions on either side, as if
2188
# merging only part of the history.
2189
takes_args = ['branch', 'other']
2193
def run(self, branch, other):
2194
from bzrlib.revision import MultipleRevisionSources
2196
branch1 = Branch.open_containing(branch)[0]
2197
branch2 = Branch.open_containing(other)[0]
2199
history_1 = branch1.revision_history()
2200
history_2 = branch2.revision_history()
2202
last1 = branch1.last_revision()
2203
last2 = branch2.last_revision()
2205
source = MultipleRevisionSources(branch1.repository,
2208
base_rev_id = common_ancestor(last1, last2, source)
2210
print 'merge base is revision %s' % base_rev_id
2213
class cmd_merge(Command):
2214
"""Perform a three-way merge.
2216
The branch is the branch you will merge from. By default, it will merge
2217
the latest revision. If you specify a revision, that revision will be
2218
merged. If you specify two revisions, the first will be used as a BASE,
2219
and the second one as OTHER. Revision numbers are always relative to the
2222
By default, bzr will try to merge in all new work from the other
2223
branch, automatically determining an appropriate base. If this
2224
fails, you may need to give an explicit base.
2226
Merge will do its best to combine the changes in two branches, but there
2227
are some kinds of problems only a human can fix. When it encounters those,
2228
it will mark a conflict. A conflict means that you need to fix something,
2229
before you should commit.
2231
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2233
If there is no default branch set, the first merge will set it. After
2234
that, you can omit the branch to use the default. To change the
2235
default, use --remember. The value will only be saved if the remote
2236
location can be accessed.
2240
To merge the latest revision from bzr.dev
2241
bzr merge ../bzr.dev
2243
To merge changes up to and including revision 82 from bzr.dev
2244
bzr merge -r 82 ../bzr.dev
2246
To merge the changes introduced by 82, without previous changes:
2247
bzr merge -r 81..82 ../bzr.dev
2249
merge refuses to run if there are any uncommitted changes, unless
2252
The following merge types are available:
2254
takes_args = ['branch?']
2255
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2256
Option('show-base', help="Show base revision text in "
2258
Option('uncommitted', help='Apply uncommitted changes'
2259
' from a working copy, instead of branch changes'),
2260
Option('pull', help='If the destination is already'
2261
' completely merged into the source, pull from the'
2262
' source rather than merging. When this happens,'
2263
' you do not need to commit the result.'),
2267
from inspect import getdoc
2268
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2270
def run(self, branch=None, revision=None, force=False, merge_type=None,
2271
show_base=False, reprocess=False, remember=False,
2272
uncommitted=False, pull=False):
2273
if merge_type is None:
2274
merge_type = _mod_merge.Merge3Merger
2276
tree = WorkingTree.open_containing(u'.')[0]
2278
if branch is not None:
2280
reader = bundle.read_bundle_from_url(branch)
2281
except errors.NotABundle:
2282
pass # Continue on considering this url a Branch
2284
conflicts = merge_bundle(reader, tree, not force, merge_type,
2285
reprocess, show_base)
2291
if revision is None \
2292
or len(revision) < 1 or revision[0].needs_branch():
2293
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2295
if revision is None or len(revision) < 1:
2298
other = [branch, None]
2301
other = [branch, -1]
2302
other_branch, path = Branch.open_containing(branch)
2305
raise errors.BzrCommandError('Cannot use --uncommitted and'
2306
' --revision at the same time.')
2307
branch = revision[0].get_branch() or branch
2308
if len(revision) == 1:
2310
other_branch, path = Branch.open_containing(branch)
2311
revno = revision[0].in_history(other_branch).revno
2312
other = [branch, revno]
2314
assert len(revision) == 2
2315
if None in revision:
2316
raise errors.BzrCommandError(
2317
"Merge doesn't permit empty revision specifier.")
2318
base_branch, path = Branch.open_containing(branch)
2319
branch1 = revision[1].get_branch() or branch
2320
other_branch, path1 = Branch.open_containing(branch1)
2321
if revision[0].get_branch() is not None:
2322
# then path was obtained from it, and is None.
2325
base = [branch, revision[0].in_history(base_branch).revno]
2326
other = [branch1, revision[1].in_history(other_branch).revno]
2328
if tree.branch.get_parent() is None or remember:
2329
tree.branch.set_parent(other_branch.base)
2332
interesting_files = [path]
2334
interesting_files = None
2335
pb = ui.ui_factory.nested_progress_bar()
2338
conflict_count = _merge_helper(
2339
other, base, check_clean=(not force),
2340
merge_type=merge_type,
2341
reprocess=reprocess,
2342
show_base=show_base,
2344
pb=pb, file_list=interesting_files)
2347
if conflict_count != 0:
2351
except errors.AmbiguousBase, e:
2352
m = ("sorry, bzr can't determine the right merge base yet\n"
2353
"candidates are:\n "
2354
+ "\n ".join(e.bases)
2356
"please specify an explicit base with -r,\n"
2357
"and (if you want) report this to the bzr developers\n")
2360
# TODO: move up to common parent; this isn't merge-specific anymore.
2361
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2362
"""Use tree.branch's parent if none was supplied.
2364
Report if the remembered location was used.
2366
if supplied_location is not None:
2367
return supplied_location
2368
stored_location = tree.branch.get_parent()
2369
mutter("%s", stored_location)
2370
if stored_location is None:
2371
raise errors.BzrCommandError("No location specified or remembered")
2372
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2373
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2374
return stored_location
2377
class cmd_remerge(Command):
2380
Use this if you want to try a different merge technique while resolving
2381
conflicts. Some merge techniques are better than others, and remerge
2382
lets you try different ones on different files.
2384
The options for remerge have the same meaning and defaults as the ones for
2385
merge. The difference is that remerge can (only) be run when there is a
2386
pending merge, and it lets you specify particular files.
2389
$ bzr remerge --show-base
2390
Re-do the merge of all conflicted files, and show the base text in
2391
conflict regions, in addition to the usual THIS and OTHER texts.
2393
$ bzr remerge --merge-type weave --reprocess foobar
2394
Re-do the merge of "foobar", using the weave merge algorithm, with
2395
additional processing to reduce the size of conflict regions.
2397
The following merge types are available:"""
2398
takes_args = ['file*']
2399
takes_options = ['merge-type', 'reprocess',
2400
Option('show-base', help="Show base revision text in "
2404
from inspect import getdoc
2405
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2407
def run(self, file_list=None, merge_type=None, show_base=False,
2409
if merge_type is None:
2410
merge_type = _mod_merge.Merge3Merger
2411
tree, file_list = tree_files(file_list)
2414
parents = tree.get_parent_ids()
2415
if len(parents) != 2:
2416
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2417
" merges. Not cherrypicking or"
2419
repository = tree.branch.repository
2420
base_revision = common_ancestor(parents[0],
2421
parents[1], repository)
2422
base_tree = repository.revision_tree(base_revision)
2423
other_tree = repository.revision_tree(parents[1])
2424
interesting_ids = None
2426
conflicts = tree.conflicts()
2427
if file_list is not None:
2428
interesting_ids = set()
2429
for filename in file_list:
2430
file_id = tree.path2id(filename)
2432
raise errors.NotVersionedError(filename)
2433
interesting_ids.add(file_id)
2434
if tree.kind(file_id) != "directory":
2437
for name, ie in tree.inventory.iter_entries(file_id):
2438
interesting_ids.add(ie.file_id)
2439
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2441
# Remerge only supports resolving contents conflicts
2442
allowed_conflicts = ('text conflict', 'contents conflict')
2443
restore_files = [c.path for c in conflicts
2444
if c.typestring in allowed_conflicts]
2445
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2446
tree.set_conflicts(ConflictList(new_conflicts))
2447
if file_list is not None:
2448
restore_files = file_list
2449
for filename in restore_files:
2451
restore(tree.abspath(filename))
2452
except errors.NotConflicted:
2454
conflicts = _mod_merge.merge_inner(
2455
tree.branch, other_tree, base_tree,
2457
interesting_ids=interesting_ids,
2458
other_rev_id=parents[1],
2459
merge_type=merge_type,
2460
show_base=show_base,
2461
reprocess=reprocess)
2470
class cmd_revert(Command):
2471
"""Revert files to a previous revision.
2473
Giving a list of files will revert only those files. Otherwise, all files
2474
will be reverted. If the revision is not specified with '--revision', the
2475
last committed revision is used.
2477
To remove only some changes, without reverting to a prior version, use
2478
merge instead. For example, "merge . --r-2..-3" will remove the changes
2479
introduced by -2, without affecting the changes introduced by -1. Or
2480
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2482
By default, any files that have been manually changed will be backed up
2483
first. (Files changed only by merge are not backed up.) Backup files have
2484
'.~#~' appended to their name, where # is a number.
2486
When you provide files, you can use their current pathname or the pathname
2487
from the target revision. So you can use revert to "undelete" a file by
2488
name. If you name a directory, all the contents of that directory will be
2491
takes_options = ['revision', 'no-backup']
2492
takes_args = ['file*']
2493
aliases = ['merge-revert']
2495
def run(self, revision=None, no_backup=False, file_list=None):
2496
if file_list is not None:
2497
if len(file_list) == 0:
2498
raise errors.BzrCommandError("No files specified")
2502
tree, file_list = tree_files(file_list)
2503
if revision is None:
2504
# FIXME should be tree.last_revision
2505
rev_id = tree.last_revision()
2506
elif len(revision) != 1:
2507
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2509
rev_id = revision[0].in_history(tree.branch).rev_id
2510
pb = ui.ui_factory.nested_progress_bar()
2512
tree.revert(file_list,
2513
tree.branch.repository.revision_tree(rev_id),
2519
class cmd_assert_fail(Command):
2520
"""Test reporting of assertion failures"""
2521
# intended just for use in testing
2526
raise AssertionError("always fails")
2529
class cmd_help(Command):
2530
"""Show help on a command or other topic.
2532
For a list of all available commands, say 'bzr help commands'.
2534
takes_options = [Option('long', 'show help on all commands')]
2535
takes_args = ['topic?']
2536
aliases = ['?', '--help', '-?', '-h']
2539
def run(self, topic=None, long=False):
2541
if topic is None and long:
2543
bzrlib.help.help(topic)
2546
class cmd_shell_complete(Command):
2547
"""Show appropriate completions for context.
2549
For a list of all available commands, say 'bzr shell-complete'.
2551
takes_args = ['context?']
2556
def run(self, context=None):
2557
import shellcomplete
2558
shellcomplete.shellcomplete(context)
2561
class cmd_fetch(Command):
2562
"""Copy in history from another branch but don't merge it.
2564
This is an internal method used for pull and merge.
2567
takes_args = ['from_branch', 'to_branch']
2568
def run(self, from_branch, to_branch):
2569
from bzrlib.fetch import Fetcher
2570
from_b = Branch.open(from_branch)
2571
to_b = Branch.open(to_branch)
2572
Fetcher(to_b, from_b)
2575
class cmd_missing(Command):
2576
"""Show unmerged/unpulled revisions between two branches.
2578
OTHER_BRANCH may be local or remote.
2580
takes_args = ['other_branch?']
2581
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2583
'Display changes in the local branch only'),
2584
Option('theirs-only',
2585
'Display changes in the remote branch only'),
2593
encoding_type = 'replace'
2596
def run(self, other_branch=None, reverse=False, mine_only=False,
2597
theirs_only=False, log_format=None, long=False, short=False, line=False,
2598
show_ids=False, verbose=False):
2599
from bzrlib.missing import find_unmerged, iter_log_data
2600
from bzrlib.log import log_formatter
2601
local_branch = Branch.open_containing(u".")[0]
2602
parent = local_branch.get_parent()
2603
if other_branch is None:
2604
other_branch = parent
2605
if other_branch is None:
2606
raise errors.BzrCommandError("No peer location known or specified.")
2607
print "Using last location: " + local_branch.get_parent()
2608
remote_branch = Branch.open(other_branch)
2609
if remote_branch.base == local_branch.base:
2610
remote_branch = local_branch
2611
local_branch.lock_read()
2613
remote_branch.lock_read()
2615
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2616
if (log_format is None):
2617
default = local_branch.get_config().log_format()
2618
log_format = get_log_format(long=long, short=short,
2619
line=line, default=default)
2620
lf = log_formatter(log_format,
2623
show_timezone='original')
2624
if reverse is False:
2625
local_extra.reverse()
2626
remote_extra.reverse()
2627
if local_extra and not theirs_only:
2628
print "You have %d extra revision(s):" % len(local_extra)
2629
for data in iter_log_data(local_extra, local_branch.repository,
2632
printed_local = True
2634
printed_local = False
2635
if remote_extra and not mine_only:
2636
if printed_local is True:
2638
print "You are missing %d revision(s):" % len(remote_extra)
2639
for data in iter_log_data(remote_extra, remote_branch.repository,
2642
if not remote_extra and not local_extra:
2644
print "Branches are up to date."
2648
remote_branch.unlock()
2650
local_branch.unlock()
2651
if not status_code and parent is None and other_branch is not None:
2652
local_branch.lock_write()
2654
# handle race conditions - a parent might be set while we run.
2655
if local_branch.get_parent() is None:
2656
local_branch.set_parent(remote_branch.base)
2658
local_branch.unlock()
2662
class cmd_plugins(Command):
2667
import bzrlib.plugin
2668
from inspect import getdoc
2669
for name, plugin in bzrlib.plugin.all_plugins().items():
2670
if getattr(plugin, '__path__', None) is not None:
2671
print plugin.__path__[0]
2672
elif getattr(plugin, '__file__', None) is not None:
2673
print plugin.__file__
2679
print '\t', d.split('\n')[0]
2682
class cmd_testament(Command):
2683
"""Show testament (signing-form) of a revision."""
2684
takes_options = ['revision',
2685
Option('long', help='Produce long-format testament'),
2686
Option('strict', help='Produce a strict-format'
2688
takes_args = ['branch?']
2690
def run(self, branch=u'.', revision=None, long=False, strict=False):
2691
from bzrlib.testament import Testament, StrictTestament
2693
testament_class = StrictTestament
2695
testament_class = Testament
2696
b = WorkingTree.open_containing(branch)[0].branch
2699
if revision is None:
2700
rev_id = b.last_revision()
2702
rev_id = revision[0].in_history(b).rev_id
2703
t = testament_class.from_revision(b.repository, rev_id)
2705
sys.stdout.writelines(t.as_text_lines())
2707
sys.stdout.write(t.as_short_text())
2712
class cmd_annotate(Command):
2713
"""Show the origin of each line in a file.
2715
This prints out the given file with an annotation on the left side
2716
indicating which revision, author and date introduced the change.
2718
If the origin is the same for a run of consecutive lines, it is
2719
shown only at the top, unless the --all option is given.
2721
# TODO: annotate directories; showing when each file was last changed
2722
# TODO: if the working copy is modified, show annotations on that
2723
# with new uncommitted lines marked
2724
aliases = ['ann', 'blame', 'praise']
2725
takes_args = ['filename']
2726
takes_options = [Option('all', help='show annotations on all lines'),
2727
Option('long', help='show date in annotations'),
2733
def run(self, filename, all=False, long=False, revision=None,
2735
from bzrlib.annotate import annotate_file
2736
tree, relpath = WorkingTree.open_containing(filename)
2737
branch = tree.branch
2740
if revision is None:
2741
revision_id = branch.last_revision()
2742
elif len(revision) != 1:
2743
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2745
revision_id = revision[0].in_history(branch).rev_id
2746
file_id = tree.inventory.path2id(relpath)
2747
tree = branch.repository.revision_tree(revision_id)
2748
file_version = tree.inventory[file_id].revision
2749
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2755
class cmd_re_sign(Command):
2756
"""Create a digital signature for an existing revision."""
2757
# TODO be able to replace existing ones.
2759
hidden = True # is this right ?
2760
takes_args = ['revision_id*']
2761
takes_options = ['revision']
2763
def run(self, revision_id_list=None, revision=None):
2764
import bzrlib.gpg as gpg
2765
if revision_id_list is not None and revision is not None:
2766
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2767
if revision_id_list is None and revision is None:
2768
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2769
b = WorkingTree.open_containing(u'.')[0].branch
2770
gpg_strategy = gpg.GPGStrategy(b.get_config())
2771
if revision_id_list is not None:
2772
for revision_id in revision_id_list:
2773
b.repository.sign_revision(revision_id, gpg_strategy)
2774
elif revision is not None:
2775
if len(revision) == 1:
2776
revno, rev_id = revision[0].in_history(b)
2777
b.repository.sign_revision(rev_id, gpg_strategy)
2778
elif len(revision) == 2:
2779
# are they both on rh- if so we can walk between them
2780
# might be nice to have a range helper for arbitrary
2781
# revision paths. hmm.
2782
from_revno, from_revid = revision[0].in_history(b)
2783
to_revno, to_revid = revision[1].in_history(b)
2784
if to_revid is None:
2785
to_revno = b.revno()
2786
if from_revno is None or to_revno is None:
2787
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2788
for revno in range(from_revno, to_revno + 1):
2789
b.repository.sign_revision(b.get_rev_id(revno),
2792
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2795
class cmd_bind(Command):
2796
"""Bind the current branch to a master branch.
2798
After binding, commits must succeed on the master branch
2799
before they are executed on the local one.
2802
takes_args = ['location']
2805
def run(self, location=None):
2806
b, relpath = Branch.open_containing(u'.')
2807
b_other = Branch.open(location)
2810
except errors.DivergedBranches:
2811
raise errors.BzrCommandError('These branches have diverged.'
2812
' Try merging, and then bind again.')
2815
class cmd_unbind(Command):
2816
"""Unbind the current branch from its master branch.
2818
After unbinding, the local branch is considered independent.
2819
All subsequent commits will be local.
2826
b, relpath = Branch.open_containing(u'.')
2828
raise errors.BzrCommandError('Local branch is not bound')
2831
class cmd_uncommit(Command):
2832
"""Remove the last committed revision.
2834
--verbose will print out what is being removed.
2835
--dry-run will go through all the motions, but not actually
2838
In the future, uncommit will create a revision bundle, which can then
2842
# TODO: jam 20060108 Add an option to allow uncommit to remove
2843
# unreferenced information in 'branch-as-repository' branches.
2844
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2845
# information in shared branches as well.
2846
takes_options = ['verbose', 'revision',
2847
Option('dry-run', help='Don\'t actually make changes'),
2848
Option('force', help='Say yes to all questions.')]
2849
takes_args = ['location?']
2852
def run(self, location=None,
2853
dry_run=False, verbose=False,
2854
revision=None, force=False):
2855
from bzrlib.log import log_formatter, show_log
2857
from bzrlib.uncommit import uncommit
2859
if location is None:
2861
control, relpath = bzrdir.BzrDir.open_containing(location)
2863
tree = control.open_workingtree()
2865
except (errors.NoWorkingTree, errors.NotLocalUrl):
2867
b = control.open_branch()
2870
if revision is None:
2873
# 'bzr uncommit -r 10' actually means uncommit
2874
# so that the final tree is at revno 10.
2875
# but bzrlib.uncommit.uncommit() actually uncommits
2876
# the revisions that are supplied.
2877
# So we need to offset it by one
2878
revno = revision[0].in_history(b).revno+1
2880
if revno <= b.revno():
2881
rev_id = b.get_rev_id(revno)
2883
self.outf.write('No revisions to uncommit.\n')
2886
lf = log_formatter('short',
2888
show_timezone='original')
2893
direction='forward',
2894
start_revision=revno,
2895
end_revision=b.revno())
2898
print 'Dry-run, pretending to remove the above revisions.'
2900
val = raw_input('Press <enter> to continue')
2902
print 'The above revision(s) will be removed.'
2904
val = raw_input('Are you sure [y/N]? ')
2905
if val.lower() not in ('y', 'yes'):
2909
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2913
class cmd_break_lock(Command):
2914
"""Break a dead lock on a repository, branch or working directory.
2916
CAUTION: Locks should only be broken when you are sure that the process
2917
holding the lock has been stopped.
2919
You can get information on what locks are open via the 'bzr info' command.
2924
takes_args = ['location?']
2926
def run(self, location=None, show=False):
2927
if location is None:
2929
control, relpath = bzrdir.BzrDir.open_containing(location)
2931
control.break_lock()
2932
except NotImplementedError:
2936
class cmd_wait_until_signalled(Command):
2937
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
2939
This just prints a line to signal when it is ready, then blocks on stdin.
2945
sys.stdout.write("running\n")
2947
sys.stdin.readline()
2950
class cmd_serve(Command):
2951
"""Run the bzr server."""
2953
aliases = ['server']
2957
help='serve on stdin/out for use from inetd or sshd'),
2959
help='listen for connections on nominated port of the form '
2960
'[hostname:]portnumber. Passing 0 as the port number will '
2961
'result in a dynamically allocated port.',
2964
help='serve contents of directory',
2966
Option('allow-writes',
2967
help='By default the server is a readonly server. Supplying '
2968
'--allow-writes enables write access to the contents of '
2969
'the served directory and below. '
2973
def run(self, port=None, inet=False, directory=None, allow_writes=False):
2974
from bzrlib.transport import smart
2975
from bzrlib.transport import get_transport
2976
if directory is None:
2977
directory = os.getcwd()
2978
url = urlutils.local_path_to_url(directory)
2979
if not allow_writes:
2980
url = 'readonly+' + url
2981
t = get_transport(url)
2983
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
2984
elif port is not None:
2986
host, port = port.split(':')
2989
server = smart.SmartTCPServer(t, host=host, port=int(port))
2990
print 'listening on port: ', server.port
2993
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
2997
# command-line interpretation helper for merge-related commands
2998
def _merge_helper(other_revision, base_revision,
2999
check_clean=True, ignore_zero=False,
3000
this_dir=None, backup_files=False,
3002
file_list=None, show_base=False, reprocess=False,
3004
pb=DummyProgress()):
3005
"""Merge changes into a tree.
3008
list(path, revno) Base for three-way merge.
3009
If [None, None] then a base will be automatically determined.
3011
list(path, revno) Other revision for three-way merge.
3013
Directory to merge changes into; '.' by default.
3015
If true, this_dir must have no uncommitted changes before the
3017
ignore_zero - If true, suppress the "zero conflicts" message when
3018
there are no conflicts; should be set when doing something we expect
3019
to complete perfectly.
3020
file_list - If supplied, merge only changes to selected files.
3022
All available ancestors of other_revision and base_revision are
3023
automatically pulled into the branch.
3025
The revno may be -1 to indicate the last revision on the branch, which is
3028
This function is intended for use from the command line; programmatic
3029
clients might prefer to call merge.merge_inner(), which has less magic
3032
# Loading it late, so that we don't always have to import bzrlib.merge
3033
if merge_type is None:
3034
merge_type = _mod_merge.Merge3Merger
3035
if this_dir is None:
3037
this_tree = WorkingTree.open_containing(this_dir)[0]
3038
if show_base and not merge_type is _mod_merge.Merge3Merger:
3039
raise errors.BzrCommandError("Show-base is not supported for this merge"
3040
" type. %s" % merge_type)
3041
if reprocess and not merge_type.supports_reprocess:
3042
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3043
" type %s." % merge_type)
3044
if reprocess and show_base:
3045
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3047
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3049
merger.pp = ProgressPhase("Merge phase", 5, pb)
3050
merger.pp.next_phase()
3051
merger.check_basis(check_clean)
3052
merger.set_other(other_revision)
3053
merger.pp.next_phase()
3054
merger.set_base(base_revision)
3055
if merger.base_rev_id == merger.other_rev_id:
3056
note('Nothing to do.')
3058
if file_list is None:
3059
if pull and merger.base_rev_id == merger.this_rev_id:
3060
count = merger.this_tree.pull(merger.this_branch,
3061
False, merger.other_rev_id)
3062
note('%d revision(s) pulled.' % (count,))
3064
merger.backup_files = backup_files
3065
merger.merge_type = merge_type
3066
merger.set_interesting_files(file_list)
3067
merger.show_base = show_base
3068
merger.reprocess = reprocess
3069
conflicts = merger.do_merge()
3070
if file_list is None:
3071
merger.set_pending()
3078
merge = _merge_helper
3081
# these get imported and then picked up by the scan for cmd_*
3082
# TODO: Some more consistent way to split command definitions across files;
3083
# we do need to load at least some information about them to know of
3084
# aliases. ideally we would avoid loading the implementation until the
3085
# details were needed.
3086
from bzrlib.cmd_version_info import cmd_version_info
3087
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3088
from bzrlib.bundle.commands import cmd_bundle_revisions
3089
from bzrlib.sign_my_commits import cmd_sign_my_commits
3090
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3091
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
