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(), """
46
from bzrlib.branch import Branch
47
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
48
from bzrlib.conflicts import ConflictList
49
from bzrlib.revision import common_ancestor
50
from bzrlib.revisionspec import RevisionSpec
51
from bzrlib.workingtree import WorkingTree
54
from bzrlib.commands import Command, display_command
55
from bzrlib.option import Option
56
from bzrlib.progress import DummyProgress, ProgressPhase
57
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
60
def tree_files(file_list, default_branch=u'.'):
62
return internal_tree_files(file_list, default_branch)
63
except errors.FileInWrongBranch, e:
64
raise errors.BzrCommandError("%s is not in the same branch as %s" %
65
(e.path, file_list[0]))
68
# XXX: Bad function name; should possibly also be a class method of
69
# WorkingTree rather than a function.
70
def internal_tree_files(file_list, default_branch=u'.'):
71
"""Convert command-line paths to a WorkingTree and relative paths.
73
This is typically used for command-line processors that take one or
74
more filenames, and infer the workingtree that contains them.
76
The filenames given are not required to exist.
78
:param file_list: Filenames to convert.
80
:param default_branch: Fallback tree path to use if file_list is empty or
83
:return: workingtree, [relative_paths]
85
if file_list is None or len(file_list) == 0:
86
return WorkingTree.open_containing(default_branch)[0], file_list
87
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
89
for filename in file_list:
91
new_list.append(tree.relpath(osutils.dereference_path(filename)))
92
except errors.PathNotChild:
93
raise errors.FileInWrongBranch(tree.branch, filename)
97
def get_format_type(typestring):
98
"""Parse and return a format specifier."""
99
# Have to use BzrDirMetaFormat1 directly, so that
100
# RepositoryFormat.set_default_format works
101
if typestring == "default":
102
return bzrdir.BzrDirMetaFormat1()
104
return bzrdir.format_registry.make_bzrdir(typestring)
106
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
107
raise errors.BzrCommandError(msg)
110
# TODO: Make sure no commands unconditionally use the working directory as a
111
# branch. If a filename argument is used, the first of them should be used to
112
# specify the branch. (Perhaps this can be factored out into some kind of
113
# Argument class, representing a file in a branch, where the first occurrence
116
class cmd_status(Command):
117
"""Display status summary.
119
This reports on versioned and unknown files, reporting them
120
grouped by state. Possible states are:
123
Versioned in the working copy but not in the previous revision.
126
Versioned in the previous revision but removed or deleted
130
Path of this file changed from the previous revision;
131
the text may also have changed. This includes files whose
132
parent directory was renamed.
135
Text has changed since the previous revision.
138
Not versioned and not matching an ignore pattern.
140
To see ignored files use 'bzr ignored'. For details in the
141
changes to file texts, use 'bzr diff'.
143
--short gives a one character status flag for each item, similar
144
to the SVN's status command.
146
If no arguments are specified, the status of the entire working
147
directory is shown. Otherwise, only the status of the specified
148
files or directories is reported. If a directory is given, status
149
is reported for everything inside that directory.
151
If a revision argument is given, the status is calculated against
152
that revision, or between two revisions if two are provided.
155
# TODO: --no-recurse, --recurse options
157
takes_args = ['file*']
158
takes_options = ['show-ids', 'revision', 'short']
159
aliases = ['st', 'stat']
161
encoding_type = 'replace'
164
def run(self, show_ids=False, file_list=None, revision=None, short=False):
165
from bzrlib.status import show_tree_status
167
tree, file_list = tree_files(file_list)
169
show_tree_status(tree, show_ids=show_ids,
170
specific_files=file_list, revision=revision,
175
class cmd_cat_revision(Command):
176
"""Write out metadata for a revision.
178
The revision to print can either be specified by a specific
179
revision identifier, or you can use --revision.
183
takes_args = ['revision_id?']
184
takes_options = ['revision']
185
# cat-revision is more for frontends so should be exact
189
def run(self, revision_id=None, revision=None):
191
if revision_id is not None and revision is not None:
192
raise errors.BzrCommandError('You can only supply one of'
193
' revision_id or --revision')
194
if revision_id is None and revision is None:
195
raise errors.BzrCommandError('You must supply either'
196
' --revision or a revision_id')
197
b = WorkingTree.open_containing(u'.')[0].branch
199
# TODO: jam 20060112 should cat-revision always output utf-8?
200
if revision_id is not None:
201
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
202
elif revision is not None:
205
raise errors.BzrCommandError('You cannot specify a NULL'
207
revno, rev_id = rev.in_history(b)
208
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
211
class cmd_remove_tree(Command):
212
"""Remove the working tree from a given branch/checkout.
214
Since a lightweight checkout is little more than a working tree
215
this will refuse to run against one.
220
takes_args = ['location?']
222
def run(self, location='.'):
223
d = bzrdir.BzrDir.open(location)
226
working = d.open_workingtree()
227
except errors.NoWorkingTree:
228
raise errors.BzrCommandError("No working tree to remove")
229
except errors.NotLocalUrl:
230
raise errors.BzrCommandError("You cannot remove the working tree of a "
233
working_path = working.bzrdir.root_transport.base
234
branch_path = working.branch.bzrdir.root_transport.base
235
if working_path != branch_path:
236
raise errors.BzrCommandError("You cannot remove the working tree from "
237
"a lightweight checkout")
239
d.destroy_workingtree()
242
class cmd_revno(Command):
243
"""Show current revision number.
245
This is equal to the number of revisions on this branch.
248
takes_args = ['location?']
251
def run(self, location=u'.'):
252
self.outf.write(str(Branch.open_containing(location)[0].revno()))
253
self.outf.write('\n')
256
class cmd_revision_info(Command):
257
"""Show revision number and revision id for a given revision identifier.
260
takes_args = ['revision_info*']
261
takes_options = ['revision']
264
def run(self, revision=None, revision_info_list=[]):
267
if revision is not None:
268
revs.extend(revision)
269
if revision_info_list is not None:
270
for rev in revision_info_list:
271
revs.append(RevisionSpec.from_string(rev))
273
raise errors.BzrCommandError('You must supply a revision identifier')
275
b = WorkingTree.open_containing(u'.')[0].branch
278
revinfo = rev.in_history(b)
279
if revinfo.revno is None:
280
print ' %s' % revinfo.rev_id
282
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
285
class cmd_add(Command):
286
"""Add specified files or directories.
288
In non-recursive mode, all the named items are added, regardless
289
of whether they were previously ignored. A warning is given if
290
any of the named files are already versioned.
292
In recursive mode (the default), files are treated the same way
293
but the behaviour for directories is different. Directories that
294
are already versioned do not give a warning. All directories,
295
whether already versioned or not, are searched for files or
296
subdirectories that are neither versioned or ignored, and these
297
are added. This search proceeds recursively into versioned
298
directories. If no names are given '.' is assumed.
300
Therefore simply saying 'bzr add' will version all files that
301
are currently unknown.
303
Adding a file whose parent directory is not versioned will
304
implicitly add the parent, and so on up to the root. This means
305
you should never need to explicitly add a directory, they'll just
306
get added when you add a file in the directory.
308
--dry-run will show which files would be added, but not actually
311
--file-ids-from will try to use the file ids from the supplied path.
312
It looks up ids trying to find a matching parent directory with the
313
same filename, and then by pure path.
315
takes_args = ['file*']
316
takes_options = ['no-recurse', 'dry-run', 'verbose',
317
Option('file-ids-from', type=unicode,
318
help='Lookup file ids from here')]
319
encoding_type = 'replace'
321
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
325
if file_ids_from is not None:
327
base_tree, base_path = WorkingTree.open_containing(
329
except errors.NoWorkingTree:
330
base_branch, base_path = Branch.open_containing(
332
base_tree = base_branch.basis_tree()
334
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
335
to_file=self.outf, should_print=(not is_quiet()))
337
action = bzrlib.add.AddAction(to_file=self.outf,
338
should_print=(not is_quiet()))
340
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
341
action=action, save=not dry_run)
344
for glob in sorted(ignored.keys()):
345
for path in ignored[glob]:
346
self.outf.write("ignored %s matching \"%s\"\n"
350
for glob, paths in ignored.items():
351
match_len += len(paths)
352
self.outf.write("ignored %d file(s).\n" % match_len)
353
self.outf.write("If you wish to add some of these files,"
354
" please add them by name.\n")
357
class cmd_mkdir(Command):
358
"""Create a new versioned directory.
360
This is equivalent to creating the directory and then adding it.
363
takes_args = ['dir+']
364
encoding_type = 'replace'
366
def run(self, dir_list):
369
wt, dd = WorkingTree.open_containing(d)
371
self.outf.write('added %s\n' % d)
374
class cmd_relpath(Command):
375
"""Show path of a file relative to root"""
377
takes_args = ['filename']
381
def run(self, filename):
382
# TODO: jam 20050106 Can relpath return a munged path if
383
# sys.stdout encoding cannot represent it?
384
tree, relpath = WorkingTree.open_containing(filename)
385
self.outf.write(relpath)
386
self.outf.write('\n')
389
class cmd_inventory(Command):
390
"""Show inventory of the current working copy or a revision.
392
It is possible to limit the output to a particular entry
393
type using the --kind option. For example: --kind file.
395
It is also possible to restrict the list of files to a specific
396
set. For example: bzr inventory --show-ids this/file
399
takes_options = ['revision', 'show-ids', 'kind']
400
takes_args = ['file*']
403
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
404
if kind and kind not in ['file', 'directory', 'symlink']:
405
raise errors.BzrCommandError('invalid kind specified')
407
work_tree, file_list = tree_files(file_list)
409
if revision is not None:
410
if len(revision) > 1:
411
raise errors.BzrCommandError('bzr inventory --revision takes'
412
' exactly one revision identifier')
413
revision_id = revision[0].in_history(work_tree.branch).rev_id
414
tree = work_tree.branch.repository.revision_tree(revision_id)
416
# We include work_tree as well as 'tree' here
417
# So that doing '-r 10 path/foo' will lookup whatever file
418
# exists now at 'path/foo' even if it has been renamed, as
419
# well as whatever files existed in revision 10 at path/foo
420
trees = [tree, work_tree]
425
if file_list is not None:
426
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
427
require_versioned=True)
428
# find_ids_across_trees may include some paths that don't
430
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
431
for file_id in file_ids if file_id in tree)
433
entries = tree.inventory.entries()
435
for path, entry in entries:
436
if kind and kind != entry.kind:
439
self.outf.write('%-50s %s\n' % (path, entry.file_id))
441
self.outf.write(path)
442
self.outf.write('\n')
445
class cmd_mv(Command):
446
"""Move or rename a file.
449
bzr mv OLDNAME NEWNAME
450
bzr mv SOURCE... DESTINATION
452
If the last argument is a versioned directory, all the other names
453
are moved into it. Otherwise, there must be exactly two arguments
454
and the file is changed to a new name, which must not already exist.
456
Files cannot be moved between branches.
459
takes_args = ['names*']
460
aliases = ['move', 'rename']
461
encoding_type = 'replace'
463
def run(self, names_list):
464
if names_list is None:
467
if len(names_list) < 2:
468
raise errors.BzrCommandError("missing file argument")
469
tree, rel_names = tree_files(names_list)
471
if os.path.isdir(names_list[-1]):
472
# move into existing directory
473
for pair in tree.move(rel_names[:-1], rel_names[-1]):
474
self.outf.write("%s => %s\n" % pair)
476
if len(names_list) != 2:
477
raise errors.BzrCommandError('to mv multiple files the destination '
478
'must be a versioned directory')
479
tree.rename_one(rel_names[0], rel_names[1])
480
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
483
class cmd_pull(Command):
484
"""Turn this branch into a mirror of another branch.
486
This command only works on branches that have not diverged. Branches are
487
considered diverged if the destination branch's most recent commit is one
488
that has not been merged (directly or indirectly) into the parent.
490
If branches have diverged, you can use 'bzr merge' to integrate the changes
491
from one into the other. Once one branch has merged, the other should
492
be able to pull it again.
494
If you want to forget your local changes and just update your branch to
495
match the remote one, use pull --overwrite.
497
If there is no default location set, the first pull will set it. After
498
that, you can omit the location to use the default. To change the
499
default, use --remember. The value will only be saved if the remote
500
location can be accessed.
503
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
504
takes_args = ['location?']
505
encoding_type = 'replace'
507
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
508
# FIXME: too much stuff is in the command class
510
tree_to = WorkingTree.open_containing(u'.')[0]
511
branch_to = tree_to.branch
512
except errors.NoWorkingTree:
514
branch_to = Branch.open_containing(u'.')[0]
517
if location is not None:
519
reader = bundle.read_bundle_from_url(location)
520
except errors.NotABundle:
521
pass # Continue on considering this url a Branch
523
stored_loc = branch_to.get_parent()
525
if stored_loc is None:
526
raise errors.BzrCommandError("No pull location known or"
529
display_url = urlutils.unescape_for_display(stored_loc,
531
self.outf.write("Using saved location: %s\n" % display_url)
532
location = stored_loc
535
if reader is not None:
536
install_bundle(branch_to.repository, reader)
537
branch_from = branch_to
539
branch_from = Branch.open(location)
541
if branch_to.get_parent() is None or remember:
542
branch_to.set_parent(branch_from.base)
546
if reader is not None:
547
rev_id = reader.target
548
elif len(revision) == 1:
549
rev_id = revision[0].in_history(branch_from).rev_id
551
raise errors.BzrCommandError('bzr pull --revision takes one value.')
553
old_rh = branch_to.revision_history()
554
if tree_to is not None:
555
count = tree_to.pull(branch_from, overwrite, rev_id)
557
count = branch_to.pull(branch_from, overwrite, rev_id)
558
note('%d revision(s) pulled.' % (count,))
561
new_rh = branch_to.revision_history()
564
from bzrlib.log import show_changed_revisions
565
show_changed_revisions(branch_to, old_rh, new_rh,
569
class cmd_push(Command):
570
"""Update a mirror of this branch.
572
The target branch will not have its working tree populated because this
573
is both expensive, and is not supported on remote file systems.
575
Some smart servers or protocols *may* put the working tree in place in
578
This command only works on branches that have not diverged. Branches are
579
considered diverged if the destination branch's most recent commit is one
580
that has not been merged (directly or indirectly) by the source branch.
582
If branches have diverged, you can use 'bzr push --overwrite' to replace
583
the other branch completely, discarding its unmerged changes.
585
If you want to ensure you have the different changes in the other branch,
586
do a merge (see bzr help merge) from the other branch, and commit that.
587
After that you will be able to do a push without '--overwrite'.
589
If there is no default push location set, the first push will set it.
590
After that, you can omit the location to use the default. To change the
591
default, use --remember. The value will only be saved if the remote
592
location can be accessed.
595
takes_options = ['remember', 'overwrite', 'verbose',
596
Option('create-prefix',
597
help='Create the path leading up to the branch '
598
'if it does not already exist')]
599
takes_args = ['location?']
600
encoding_type = 'replace'
602
def run(self, location=None, remember=False, overwrite=False,
603
create_prefix=False, verbose=False):
604
# FIXME: Way too big! Put this into a function called from the
607
br_from = Branch.open_containing('.')[0]
608
stored_loc = br_from.get_push_location()
610
if stored_loc is None:
611
raise errors.BzrCommandError("No push location known or specified.")
613
display_url = urlutils.unescape_for_display(stored_loc,
615
self.outf.write("Using saved location: %s\n" % display_url)
616
location = stored_loc
618
to_transport = transport.get_transport(location)
619
location_url = to_transport.base
623
dir_to = bzrdir.BzrDir.open(location_url)
624
br_to = dir_to.open_branch()
625
except errors.NotBranchError:
627
to_transport = to_transport.clone('..')
628
if not create_prefix:
630
relurl = to_transport.relpath(location_url)
631
mutter('creating directory %s => %s', location_url, relurl)
632
to_transport.mkdir(relurl)
633
except errors.NoSuchFile:
634
raise errors.BzrCommandError("Parent directory of %s "
635
"does not exist." % location)
637
current = to_transport.base
638
needed = [(to_transport, to_transport.relpath(location_url))]
641
to_transport, relpath = needed[-1]
642
to_transport.mkdir(relpath)
644
except errors.NoSuchFile:
645
new_transport = to_transport.clone('..')
646
needed.append((new_transport,
647
new_transport.relpath(to_transport.base)))
648
if new_transport.base == to_transport.base:
649
raise errors.BzrCommandError("Could not create "
651
dir_to = br_from.bzrdir.clone(location_url,
652
revision_id=br_from.last_revision())
653
br_to = dir_to.open_branch()
654
count = len(br_to.revision_history())
655
# We successfully created the target, remember it
656
if br_from.get_push_location() is None or remember:
657
br_from.set_push_location(br_to.base)
659
# We were able to connect to the remote location, so remember it
660
# we don't need to successfully push because of possible divergence.
661
if br_from.get_push_location() is None or remember:
662
br_from.set_push_location(br_to.base)
663
old_rh = br_to.revision_history()
666
tree_to = dir_to.open_workingtree()
667
except errors.NotLocalUrl:
668
warning('This transport does not update the working '
669
'tree of: %s' % (br_to.base,))
670
count = br_to.pull(br_from, overwrite)
671
except errors.NoWorkingTree:
672
count = br_to.pull(br_from, overwrite)
674
count = tree_to.pull(br_from, overwrite)
675
except errors.DivergedBranches:
676
raise errors.BzrCommandError('These branches have diverged.'
677
' Try using "merge" and then "push".')
678
note('%d revision(s) pushed.' % (count,))
681
new_rh = br_to.revision_history()
684
from bzrlib.log import show_changed_revisions
685
show_changed_revisions(br_to, old_rh, new_rh,
689
class cmd_branch(Command):
690
"""Create a new copy of a branch.
692
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
693
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
695
To retrieve the branch as of a particular revision, supply the --revision
696
parameter, as in "branch foo/bar -r 5".
698
--basis is to speed up branching from remote branches. When specified, it
699
copies all the file-contents, inventory and revision data from the basis
700
branch before copying anything from the remote branch.
702
takes_args = ['from_location', 'to_location?']
703
takes_options = ['revision', 'basis']
704
aliases = ['get', 'clone']
706
def run(self, from_location, to_location=None, revision=None, basis=None):
709
elif len(revision) > 1:
710
raise errors.BzrCommandError(
711
'bzr branch --revision takes exactly 1 revision value')
713
br_from = Branch.open(from_location)
715
if e.errno == errno.ENOENT:
716
raise errors.BzrCommandError('Source location "%s" does not'
717
' exist.' % to_location)
722
if basis is not None:
723
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
726
if len(revision) == 1 and revision[0] is not None:
727
revision_id = revision[0].in_history(br_from)[1]
729
# FIXME - wt.last_revision, fallback to branch, fall back to
730
# None or perhaps NULL_REVISION to mean copy nothing
732
revision_id = br_from.last_revision()
733
if to_location is None:
734
to_location = os.path.basename(from_location.rstrip("/\\"))
737
name = os.path.basename(to_location) + '\n'
739
to_transport = transport.get_transport(to_location)
741
to_transport.mkdir('.')
742
except errors.FileExists:
743
raise errors.BzrCommandError('Target directory "%s" already'
744
' exists.' % to_location)
745
except errors.NoSuchFile:
746
raise errors.BzrCommandError('Parent of "%s" does not exist.'
749
# preserve whatever source format we have.
750
dir = br_from.bzrdir.sprout(to_transport.base,
751
revision_id, basis_dir)
752
branch = dir.open_branch()
753
except errors.NoSuchRevision:
754
to_transport.delete_tree('.')
755
msg = "The branch %s has no revision %s." % (from_location, revision[0])
756
raise errors.BzrCommandError(msg)
757
except errors.UnlistableBranch:
758
osutils.rmtree(to_location)
759
msg = "The branch %s cannot be used as a --basis" % (basis,)
760
raise errors.BzrCommandError(msg)
762
branch.control_files.put_utf8('branch-name', name)
763
note('Branched %d revision(s).' % branch.revno())
768
class cmd_checkout(Command):
769
"""Create a new checkout of an existing branch.
771
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
772
the branch found in '.'. This is useful if you have removed the working tree
773
or if it was never created - i.e. if you pushed the branch to its current
776
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
777
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
779
To retrieve the branch as of a particular revision, supply the --revision
780
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
781
out of date [so you cannot commit] but it may be useful (i.e. to examine old
784
--basis is to speed up checking out from remote branches. When specified, it
785
uses the inventory and file contents from the basis branch in preference to the
786
branch being checked out.
788
takes_args = ['branch_location?', 'to_location?']
789
takes_options = ['revision', # , 'basis']
790
Option('lightweight',
791
help="perform a lightweight checkout. Lightweight "
792
"checkouts depend on access to the branch for "
793
"every operation. Normal checkouts can perform "
794
"common operations like diff and status without "
795
"such access, and also support local commits."
800
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
804
elif len(revision) > 1:
805
raise errors.BzrCommandError(
806
'bzr checkout --revision takes exactly 1 revision value')
807
if branch_location is None:
808
branch_location = osutils.getcwd()
809
to_location = branch_location
810
source = Branch.open(branch_location)
811
if len(revision) == 1 and revision[0] is not None:
812
revision_id = revision[0].in_history(source)[1]
815
if to_location is None:
816
to_location = os.path.basename(branch_location.rstrip("/\\"))
817
# if the source and to_location are the same,
818
# and there is no working tree,
819
# then reconstitute a branch
820
if (osutils.abspath(to_location) ==
821
osutils.abspath(branch_location)):
823
source.bzrdir.open_workingtree()
824
except errors.NoWorkingTree:
825
source.bzrdir.create_workingtree()
828
os.mkdir(to_location)
830
if e.errno == errno.EEXIST:
831
raise errors.BzrCommandError('Target directory "%s" already'
832
' exists.' % to_location)
833
if e.errno == errno.ENOENT:
834
raise errors.BzrCommandError('Parent of "%s" does not exist.'
838
old_format = bzrdir.BzrDirFormat.get_default_format()
839
bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
841
source.create_checkout(to_location, revision_id, lightweight)
843
bzrdir.BzrDirFormat.set_default_format(old_format)
846
class cmd_renames(Command):
847
"""Show list of renamed files.
849
# TODO: Option to show renames between two historical versions.
851
# TODO: Only show renames under dir, rather than in the whole branch.
852
takes_args = ['dir?']
855
def run(self, dir=u'.'):
856
tree = WorkingTree.open_containing(dir)[0]
857
old_inv = tree.basis_tree().inventory
858
new_inv = tree.read_working_inventory()
859
renames = list(_mod_tree.find_renames(old_inv, new_inv))
861
for old_name, new_name in renames:
862
self.outf.write("%s => %s\n" % (old_name, new_name))
865
class cmd_update(Command):
866
"""Update a tree to have the latest code committed to its branch.
868
This will perform a merge into the working tree, and may generate
869
conflicts. If you have any local changes, you will still
870
need to commit them after the update for the update to be complete.
872
If you want to discard your local changes, you can just do a
873
'bzr revert' instead of 'bzr commit' after the update.
875
takes_args = ['dir?']
878
def run(self, dir='.'):
879
tree = WorkingTree.open_containing(dir)[0]
880
master = tree.branch.get_master_branch()
881
if master is not None:
884
tree.lock_tree_write()
886
existing_pending_merges = tree.get_parent_ids()[1:]
887
last_rev = tree.last_revision()
888
if last_rev == tree.branch.last_revision():
889
# may be up to date, check master too.
890
master = tree.branch.get_master_branch()
891
if master is None or last_rev == master.last_revision():
892
revno = tree.branch.revision_id_to_revno(last_rev)
893
note("Tree is up to date at revision %d." % (revno,))
895
conflicts = tree.update()
896
revno = tree.branch.revision_id_to_revno(tree.last_revision())
897
note('Updated to revision %d.' % (revno,))
898
if tree.get_parent_ids()[1:] != existing_pending_merges:
899
note('Your local commits will now show as pending merges with '
900
"'bzr status', and can be committed with 'bzr commit'.")
909
class cmd_info(Command):
910
"""Show information about a working tree, branch or repository.
912
This command will show all known locations and formats associated to the
913
tree, branch or repository. Statistical information is included with
916
Branches and working trees will also report any missing revisions.
918
takes_args = ['location?']
919
takes_options = ['verbose']
922
def run(self, location=None, verbose=False):
923
from bzrlib.info import show_bzrdir_info
924
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
928
class cmd_remove(Command):
929
"""Make a file unversioned.
931
This makes bzr stop tracking changes to a versioned file. It does
932
not delete the working copy.
934
You can specify one or more files, and/or --new. If you specify --new,
935
only 'added' files will be removed. If you specify both, then new files
936
in the specified directories will be removed. If the directories are
937
also new, they will also be removed.
939
takes_args = ['file*']
940
takes_options = ['verbose', Option('new', help='remove newly-added files')]
942
encoding_type = 'replace'
944
def run(self, file_list, verbose=False, new=False):
945
tree, file_list = tree_files(file_list)
947
if file_list is None:
948
raise errors.BzrCommandError('Specify one or more files to'
949
' remove, or use --new.')
951
added = tree.changes_from(tree.basis_tree(),
952
specific_files=file_list).added
953
file_list = sorted([f[0] for f in added], reverse=True)
954
if len(file_list) == 0:
955
raise errors.BzrCommandError('No matching files.')
956
tree.remove(file_list, verbose=verbose, to_file=self.outf)
959
class cmd_file_id(Command):
960
"""Print file_id of a particular file or directory.
962
The file_id is assigned when the file is first added and remains the
963
same through all revisions where the file exists, even when it is
968
takes_args = ['filename']
971
def run(self, filename):
972
tree, relpath = WorkingTree.open_containing(filename)
973
i = tree.inventory.path2id(relpath)
975
raise errors.NotVersionedError(filename)
977
self.outf.write(i + '\n')
980
class cmd_file_path(Command):
981
"""Print path of file_ids to a file or directory.
983
This prints one line for each directory down to the target,
984
starting at the branch root.
988
takes_args = ['filename']
991
def run(self, filename):
992
tree, relpath = WorkingTree.open_containing(filename)
994
fid = inv.path2id(relpath)
996
raise errors.NotVersionedError(filename)
997
for fip in inv.get_idpath(fid):
998
self.outf.write(fip + '\n')
1001
class cmd_reconcile(Command):
1002
"""Reconcile bzr metadata in a branch.
1004
This can correct data mismatches that may have been caused by
1005
previous ghost operations or bzr upgrades. You should only
1006
need to run this command if 'bzr check' or a bzr developer
1007
advises you to run it.
1009
If a second branch is provided, cross-branch reconciliation is
1010
also attempted, which will check that data like the tree root
1011
id which was not present in very early bzr versions is represented
1012
correctly in both branches.
1014
At the same time it is run it may recompress data resulting in
1015
a potential saving in disk space or performance gain.
1017
The branch *MUST* be on a listable system such as local disk or sftp.
1019
takes_args = ['branch?']
1021
def run(self, branch="."):
1022
from bzrlib.reconcile import reconcile
1023
dir = bzrdir.BzrDir.open(branch)
1027
class cmd_revision_history(Command):
1028
"""Display the list of revision ids on a branch."""
1029
takes_args = ['location?']
1034
def run(self, location="."):
1035
branch = Branch.open_containing(location)[0]
1036
for revid in branch.revision_history():
1037
self.outf.write(revid)
1038
self.outf.write('\n')
1041
class cmd_ancestry(Command):
1042
"""List all revisions merged into this branch."""
1043
takes_args = ['location?']
1048
def run(self, location="."):
1050
wt = WorkingTree.open_containing(location)[0]
1051
except errors.NoWorkingTree:
1052
b = Branch.open(location)
1053
last_revision = b.last_revision()
1056
last_revision = wt.last_revision()
1058
revision_ids = b.repository.get_ancestry(last_revision)
1059
assert revision_ids[0] is None
1061
for revision_id in revision_ids:
1062
self.outf.write(revision_id + '\n')
1065
class cmd_init(Command):
1066
"""Make a directory into a versioned branch.
1068
Use this to create an empty branch, or before importing an
1071
If there is a repository in a parent directory of the location, then
1072
the history of the branch will be stored in the repository. Otherwise
1073
init creates a standalone branch which carries its own history in
1076
If there is already a branch at the location but it has no working tree,
1077
the tree can be populated with 'bzr checkout'.
1079
Recipe for importing a tree of files:
1084
bzr commit -m 'imported project'
1086
takes_args = ['location?']
1089
help='Specify a format for this branch. Current'
1090
' formats are: default, knit, metaweave and'
1091
' weave. Default is knit; metaweave and'
1092
' weave are deprecated',
1093
type=get_format_type),
1095
def run(self, location=None, format=None):
1097
format = get_format_type('default')
1098
if location is None:
1101
to_transport = transport.get_transport(location)
1103
# The path has to exist to initialize a
1104
# branch inside of it.
1105
# Just using os.mkdir, since I don't
1106
# believe that we want to create a bunch of
1107
# locations if the user supplies an extended path
1108
# TODO: create-prefix
1110
to_transport.mkdir('.')
1111
except errors.FileExists:
1115
existing_bzrdir = bzrdir.BzrDir.open(location)
1116
except errors.NotBranchError:
1117
# really a NotBzrDir error...
1118
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1120
from bzrlib.transport.local import LocalTransport
1121
if existing_bzrdir.has_branch():
1122
if (isinstance(to_transport, LocalTransport)
1123
and not existing_bzrdir.has_workingtree()):
1124
raise errors.BranchExistsWithoutWorkingTree(location)
1125
raise errors.AlreadyBranchError(location)
1127
existing_bzrdir.create_branch()
1128
existing_bzrdir.create_workingtree()
1131
class cmd_init_repository(Command):
1132
"""Create a shared repository to hold branches.
1134
New branches created under the repository directory will store their revisions
1135
in the repository, not in the branch directory, if the branch format supports
1141
bzr checkout --lightweight repo/trunk trunk-checkout
1145
takes_args = ["location"]
1146
takes_options = [Option('format',
1147
help='Specify a format for this repository.'
1148
' Current formats are: default, knit,'
1149
' metaweave and weave. Default is knit;'
1150
' metaweave and weave are deprecated',
1151
type=get_format_type),
1153
help='Allows branches in repository to have'
1155
aliases = ["init-repo"]
1156
def run(self, location, format=None, trees=False):
1158
format = get_format_type('default')
1160
if location is None:
1163
to_transport = transport.get_transport(location)
1165
to_transport.mkdir('.')
1166
except errors.FileExists:
1169
newdir = format.initialize_on_transport(to_transport)
1170
repo = newdir.create_repository(shared=True)
1171
repo.set_make_working_trees(trees)
1174
class cmd_diff(Command):
1175
"""Show differences in the working tree or between revisions.
1177
If files are listed, only the changes in those files are listed.
1178
Otherwise, all changes for the tree are listed.
1180
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1181
produces patches suitable for "patch -p1".
1185
Shows the difference in the working tree versus the last commit
1187
Difference between the working tree and revision 1
1189
Difference between revision 2 and revision 1
1190
bzr diff --diff-prefix old/:new/
1191
Same as 'bzr diff' but prefix paths with old/ and new/
1192
bzr diff bzr.mine bzr.dev
1193
Show the differences between the two working trees
1195
Show just the differences for 'foo.c'
1197
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1198
# or a graphical diff.
1200
# TODO: Python difflib is not exactly the same as unidiff; should
1201
# either fix it up or prefer to use an external diff.
1203
# TODO: Selected-file diff is inefficient and doesn't show you
1206
# TODO: This probably handles non-Unix newlines poorly.
1208
takes_args = ['file*']
1209
takes_options = ['revision', 'diff-options',
1210
Option('prefix', type=str,
1212
help='Set prefixes to added to old and new filenames, as '
1213
'two values separated by a colon.'),
1215
aliases = ['di', 'dif']
1216
encoding_type = 'exact'
1219
def run(self, revision=None, file_list=None, diff_options=None,
1221
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1223
if (prefix is None) or (prefix == '0'):
1231
old_label, new_label = prefix.split(":")
1233
raise BzrCommandError(
1234
"--prefix expects two values separated by a colon")
1236
if revision and len(revision) > 2:
1237
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1238
' one or two revision specifiers')
1241
tree1, file_list = internal_tree_files(file_list)
1245
except errors.FileInWrongBranch:
1246
if len(file_list) != 2:
1247
raise errors.BzrCommandError("Files are in different branches")
1249
tree1, file1 = WorkingTree.open_containing(file_list[0])
1250
tree2, file2 = WorkingTree.open_containing(file_list[1])
1251
if file1 != "" or file2 != "":
1252
# FIXME diff those two files. rbc 20051123
1253
raise errors.BzrCommandError("Files are in different branches")
1255
except errors.NotBranchError:
1256
if (revision is not None and len(revision) == 2
1257
and not revision[0].needs_branch()
1258
and not revision[1].needs_branch()):
1259
# If both revision specs include a branch, we can
1260
# diff them without needing a local working tree
1261
tree1, tree2 = None, None
1265
if tree2 is not None:
1266
if revision is not None:
1267
# FIXME: but there should be a clean way to diff between
1268
# non-default versions of two trees, it's not hard to do
1270
raise errors.BzrCommandError(
1271
"Sorry, diffing arbitrary revisions across branches "
1272
"is not implemented yet")
1273
return show_diff_trees(tree1, tree2, sys.stdout,
1274
specific_files=file_list,
1275
external_diff_options=diff_options,
1276
old_label=old_label, new_label=new_label)
1278
return diff_cmd_helper(tree1, file_list, diff_options,
1279
revision_specs=revision,
1280
old_label=old_label, new_label=new_label)
1283
class cmd_deleted(Command):
1284
"""List files deleted in the working tree.
1286
# TODO: Show files deleted since a previous revision, or
1287
# between two revisions.
1288
# TODO: Much more efficient way to do this: read in new
1289
# directories with readdir, rather than stating each one. Same
1290
# level of effort but possibly much less IO. (Or possibly not,
1291
# if the directories are very large...)
1292
takes_options = ['show-ids']
1295
def run(self, show_ids=False):
1296
tree = WorkingTree.open_containing(u'.')[0]
1297
old = tree.basis_tree()
1298
for path, ie in old.inventory.iter_entries():
1299
if not tree.has_id(ie.file_id):
1300
self.outf.write(path)
1302
self.outf.write(' ')
1303
self.outf.write(ie.file_id)
1304
self.outf.write('\n')
1307
class cmd_modified(Command):
1308
"""List files modified in working tree."""
1312
tree = WorkingTree.open_containing(u'.')[0]
1313
td = tree.changes_from(tree.basis_tree())
1314
for path, id, kind, text_modified, meta_modified in td.modified:
1315
self.outf.write(path + '\n')
1318
class cmd_added(Command):
1319
"""List files added in working tree."""
1323
wt = WorkingTree.open_containing(u'.')[0]
1324
basis_inv = wt.basis_tree().inventory
1327
if file_id in basis_inv:
1329
if inv.is_root(file_id) and len(basis_inv) == 0:
1331
path = inv.id2path(file_id)
1332
if not os.access(osutils.abspath(path), os.F_OK):
1334
self.outf.write(path + '\n')
1337
class cmd_root(Command):
1338
"""Show the tree root directory.
1340
The root is the nearest enclosing directory with a .bzr control
1342
takes_args = ['filename?']
1344
def run(self, filename=None):
1345
"""Print the branch root."""
1346
tree = WorkingTree.open_containing(filename)[0]
1347
self.outf.write(tree.basedir + '\n')
1350
class cmd_log(Command):
1351
"""Show log of a branch, file, or directory.
1353
By default show the log of the branch containing the working directory.
1355
To request a range of logs, you can use the command -r begin..end
1356
-r revision requests a specific revision, -r ..end or -r begin.. are
1362
bzr log -r -10.. http://server/branch
1365
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1367
takes_args = ['location?']
1368
takes_options = [Option('forward',
1369
help='show from oldest to newest'),
1373
help='show files changed in each revision'),
1374
'show-ids', 'revision',
1379
help='show revisions whose message matches this regexp',
1383
encoding_type = 'replace'
1386
def run(self, location=None, timezone='original',
1396
from bzrlib.log import log_formatter, show_log
1397
assert message is None or isinstance(message, basestring), \
1398
"invalid message argument %r" % message
1399
direction = (forward and 'forward') or 'reverse'
1404
# find the file id to log:
1406
dir, fp = bzrdir.BzrDir.open_containing(location)
1407
b = dir.open_branch()
1411
inv = dir.open_workingtree().inventory
1412
except (errors.NotBranchError, errors.NotLocalUrl):
1413
# either no tree, or is remote.
1414
inv = b.basis_tree().inventory
1415
file_id = inv.path2id(fp)
1417
raise errors.BzrCommandError(
1418
"Path does not have any revision history: %s" %
1422
# FIXME ? log the current subdir only RBC 20060203
1423
if revision is not None \
1424
and len(revision) > 0 and revision[0].get_branch():
1425
location = revision[0].get_branch()
1428
dir, relpath = bzrdir.BzrDir.open_containing(location)
1429
b = dir.open_branch()
1431
if revision is None:
1434
elif len(revision) == 1:
1435
rev1 = rev2 = revision[0].in_history(b).revno
1436
elif len(revision) == 2:
1437
if revision[1].get_branch() != revision[0].get_branch():
1438
# b is taken from revision[0].get_branch(), and
1439
# show_log will use its revision_history. Having
1440
# different branches will lead to weird behaviors.
1441
raise errors.BzrCommandError(
1442
"Log doesn't accept two revisions in different branches.")
1443
if revision[0].spec is None:
1444
# missing begin-range means first revision
1447
rev1 = revision[0].in_history(b).revno
1449
if revision[1].spec is None:
1450
# missing end-range means last known revision
1453
rev2 = revision[1].in_history(b).revno
1455
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1457
# By this point, the revision numbers are converted to the +ve
1458
# form if they were supplied in the -ve form, so we can do
1459
# this comparison in relative safety
1461
(rev2, rev1) = (rev1, rev2)
1463
if (log_format is None):
1464
default = b.get_config().log_format()
1465
log_format = get_log_format(long=long, short=short, line=line,
1467
lf = log_formatter(log_format,
1470
show_timezone=timezone)
1476
direction=direction,
1477
start_revision=rev1,
1482
def get_log_format(long=False, short=False, line=False, default='long'):
1483
log_format = default
1487
log_format = 'short'
1493
class cmd_touching_revisions(Command):
1494
"""Return revision-ids which affected a particular file.
1496
A more user-friendly interface is "bzr log FILE".
1500
takes_args = ["filename"]
1503
def run(self, filename):
1504
tree, relpath = WorkingTree.open_containing(filename)
1506
inv = tree.read_working_inventory()
1507
file_id = inv.path2id(relpath)
1508
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1509
self.outf.write("%6d %s\n" % (revno, what))
1512
class cmd_ls(Command):
1513
"""List files in a tree.
1516
takes_args = ['path?']
1517
# TODO: Take a revision or remote path and list that tree instead.
1518
takes_options = ['verbose', 'revision',
1519
Option('non-recursive',
1520
help='don\'t recurse into sub-directories'),
1522
help='Print all paths from the root of the branch.'),
1523
Option('unknown', help='Print unknown files'),
1524
Option('versioned', help='Print versioned files'),
1525
Option('ignored', help='Print ignored files'),
1527
Option('null', help='Null separate the files'),
1531
def run(self, revision=None, verbose=False,
1532
non_recursive=False, from_root=False,
1533
unknown=False, versioned=False, ignored=False,
1534
null=False, kind=None, show_ids=False, path=None):
1536
if kind and kind not in ('file', 'directory', 'symlink'):
1537
raise errors.BzrCommandError('invalid kind specified')
1539
if verbose and null:
1540
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1541
all = not (unknown or versioned or ignored)
1543
selection = {'I':ignored, '?':unknown, 'V':versioned}
1550
raise errors.BzrCommandError('cannot specify both --from-root'
1554
tree, relpath = WorkingTree.open_containing(fs_path)
1559
if revision is not None:
1560
tree = tree.branch.repository.revision_tree(
1561
revision[0].in_history(tree.branch).rev_id)
1563
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1564
if fp.startswith(relpath):
1565
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1566
if non_recursive and '/' in fp:
1568
if not all and not selection[fc]:
1570
if kind is not None and fkind != kind:
1573
kindch = entry.kind_character()
1574
outstring = '%-8s %s%s' % (fc, fp, kindch)
1575
if show_ids and fid is not None:
1576
outstring = "%-50s %s" % (outstring, fid)
1577
self.outf.write(outstring + '\n')
1579
self.outf.write(fp + '\0')
1582
self.outf.write(fid)
1583
self.outf.write('\0')
1591
self.outf.write('%-50s %s\n' % (fp, my_id))
1593
self.outf.write(fp + '\n')
1596
class cmd_unknowns(Command):
1597
"""List unknown files."""
1600
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1601
self.outf.write(osutils.quotefn(f) + '\n')
1604
class cmd_ignore(Command):
1605
"""Ignore specified files or patterns.
1607
To remove patterns from the ignore list, edit the .bzrignore file.
1609
Trailing slashes on patterns are ignored.
1610
If the pattern contains a slash or is a regular expression, it is compared
1611
to the whole path from the branch root. Otherwise, it is compared to only
1612
the last component of the path. To match a file only in the root
1613
directory, prepend './'.
1615
Ignore patterns specifying absolute paths are not allowed.
1617
Ignore patterns may include globbing wildcards such as:
1618
? - Matches any single character except '/'
1619
* - Matches 0 or more characters except '/'
1620
/**/ - Matches 0 or more directories in a path
1621
[a-z] - Matches a single character from within a group of characters
1623
Ignore patterns may also be Python regular expressions.
1624
Regular expression ignore patterns are identified by a 'RE:' prefix
1625
followed by the regular expression. Regular expression ignore patterns
1626
may not include named or numbered groups.
1628
Note: ignore patterns containing shell wildcards must be quoted from
1632
bzr ignore ./Makefile
1633
bzr ignore '*.class'
1634
bzr ignore 'lib/**/*.o'
1635
bzr ignore 'RE:lib/.*\.o'
1637
takes_args = ['name_pattern*']
1639
Option('old-default-rules',
1640
help='Out the ignore rules bzr < 0.9 always used.')
1643
def run(self, name_pattern_list=None, old_default_rules=None):
1644
from bzrlib.atomicfile import AtomicFile
1645
if old_default_rules is not None:
1646
# dump the rules and exit
1647
for pattern in ignores.OLD_DEFAULTS:
1650
if not name_pattern_list:
1651
raise errors.BzrCommandError("ignore requires at least one "
1652
"NAME_PATTERN or --old-default-rules")
1653
for name_pattern in name_pattern_list:
1654
if name_pattern[0] == '/':
1655
raise errors.BzrCommandError(
1656
"NAME_PATTERN should not be an absolute path")
1657
tree, relpath = WorkingTree.open_containing(u'.')
1658
ifn = tree.abspath('.bzrignore')
1659
if os.path.exists(ifn):
1662
igns = f.read().decode('utf-8')
1668
# TODO: If the file already uses crlf-style termination, maybe
1669
# we should use that for the newly added lines?
1671
if igns and igns[-1] != '\n':
1673
for name_pattern in name_pattern_list:
1674
igns += name_pattern.rstrip('/') + '\n'
1676
f = AtomicFile(ifn, 'wb')
1678
f.write(igns.encode('utf-8'))
1683
inv = tree.inventory
1684
if inv.path2id('.bzrignore'):
1685
mutter('.bzrignore is already versioned')
1687
mutter('need to make new .bzrignore file versioned')
1688
tree.add(['.bzrignore'])
1691
class cmd_ignored(Command):
1692
"""List ignored files and the patterns that matched them.
1694
See also: bzr ignore"""
1697
tree = WorkingTree.open_containing(u'.')[0]
1698
for path, file_class, kind, file_id, entry in tree.list_files():
1699
if file_class != 'I':
1701
## XXX: Slightly inefficient since this was already calculated
1702
pat = tree.is_ignored(path)
1703
print '%-50s %s' % (path, pat)
1706
class cmd_lookup_revision(Command):
1707
"""Lookup the revision-id from a revision-number
1710
bzr lookup-revision 33
1713
takes_args = ['revno']
1716
def run(self, revno):
1720
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1722
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1725
class cmd_export(Command):
1726
"""Export past revision to destination directory.
1728
If no revision is specified this exports the last committed revision.
1730
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1731
given, try to find the format with the extension. If no extension
1732
is found exports to a directory (equivalent to --format=dir).
1734
Root may be the top directory for tar, tgz and tbz2 formats. If none
1735
is given, the top directory will be the root name of the file.
1737
If branch is omitted then the branch containing the CWD will be used.
1739
Note: export of tree with non-ascii filenames to zip is not supported.
1741
Supported formats Autodetected by extension
1742
----------------- -------------------------
1745
tbz2 .tar.bz2, .tbz2
1749
takes_args = ['dest', 'branch?']
1750
takes_options = ['revision', 'format', 'root']
1751
def run(self, dest, branch=None, revision=None, format=None, root=None):
1752
from bzrlib.export import export
1755
tree = WorkingTree.open_containing(u'.')[0]
1758
b = Branch.open(branch)
1760
if revision is None:
1761
# should be tree.last_revision FIXME
1762
rev_id = b.last_revision()
1764
if len(revision) != 1:
1765
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1766
rev_id = revision[0].in_history(b).rev_id
1767
t = b.repository.revision_tree(rev_id)
1769
export(t, dest, format, root)
1770
except errors.NoSuchExportFormat, e:
1771
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1774
class cmd_cat(Command):
1775
"""Write a file's text from a previous revision."""
1777
takes_options = ['revision', 'name-from-revision']
1778
takes_args = ['filename']
1779
encoding_type = 'exact'
1782
def run(self, filename, revision=None, name_from_revision=False):
1783
if revision is not None and len(revision) != 1:
1784
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1789
tree, relpath = WorkingTree.open_containing(filename)
1791
except (errors.NotBranchError, errors.NotLocalUrl):
1794
if revision is not None and revision[0].get_branch() is not None:
1795
b = Branch.open(revision[0].get_branch())
1797
b, relpath = Branch.open_containing(filename)
1798
tree = b.basis_tree()
1799
if revision is None:
1800
revision_id = b.last_revision()
1802
revision_id = revision[0].in_history(b).rev_id
1804
cur_file_id = tree.path2id(relpath)
1805
rev_tree = b.repository.revision_tree(revision_id)
1806
old_file_id = rev_tree.path2id(relpath)
1808
if name_from_revision:
1809
if old_file_id is None:
1810
raise errors.BzrCommandError("%r is not present in revision %s"
1811
% (filename, revision_id))
1813
rev_tree.print_file(old_file_id)
1814
elif cur_file_id is not None:
1815
rev_tree.print_file(cur_file_id)
1816
elif old_file_id is not None:
1817
rev_tree.print_file(old_file_id)
1819
raise errors.BzrCommandError("%r is not present in revision %s" %
1820
(filename, revision_id))
1823
class cmd_local_time_offset(Command):
1824
"""Show the offset in seconds from GMT to local time."""
1828
print osutils.local_time_offset()
1832
class cmd_commit(Command):
1833
"""Commit changes into a new revision.
1835
If no arguments are given, the entire tree is committed.
1837
If selected files are specified, only changes to those files are
1838
committed. If a directory is specified then the directory and everything
1839
within it is committed.
1841
A selected-file commit may fail in some cases where the committed
1842
tree would be invalid, such as trying to commit a file in a
1843
newly-added directory that is not itself committed.
1845
# TODO: Run hooks on tree to-be-committed, and after commit.
1847
# TODO: Strict commit that fails if there are deleted files.
1848
# (what does "deleted files" mean ??)
1850
# TODO: Give better message for -s, --summary, used by tla people
1852
# XXX: verbose currently does nothing
1854
takes_args = ['selected*']
1855
takes_options = ['message', 'verbose',
1857
help='commit even if nothing has changed'),
1858
Option('file', type=str,
1861
help='file containing commit message'),
1863
help="refuse to commit if there are unknown "
1864
"files in the working tree."),
1866
help="perform a local only commit in a bound "
1867
"branch. Such commits are not pushed to "
1868
"the master branch until a normal commit "
1872
aliases = ['ci', 'checkin']
1874
def run(self, message=None, file=None, verbose=True, selected_list=None,
1875
unchanged=False, strict=False, local=False):
1876
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1877
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1879
from bzrlib.msgeditor import edit_commit_message, \
1880
make_commit_message_template
1882
# TODO: Need a blackbox test for invoking the external editor; may be
1883
# slightly problematic to run this cross-platform.
1885
# TODO: do more checks that the commit will succeed before
1886
# spending the user's valuable time typing a commit message.
1887
tree, selected_list = tree_files(selected_list)
1888
if selected_list == ['']:
1889
# workaround - commit of root of tree should be exactly the same
1890
# as just default commit in that tree, and succeed even though
1891
# selected-file merge commit is not done yet
1894
if local and not tree.branch.get_bound_location():
1895
raise errors.LocalRequiresBoundBranch()
1897
def get_message(commit_obj):
1898
"""Callback to get commit message"""
1899
my_message = message
1900
if my_message is None and not file:
1901
template = make_commit_message_template(tree, selected_list)
1902
my_message = edit_commit_message(template)
1903
if my_message is None:
1904
raise errors.BzrCommandError("please specify a commit"
1905
" message with either --message or --file")
1906
elif my_message and file:
1907
raise errors.BzrCommandError(
1908
"please specify either --message or --file")
1910
my_message = codecs.open(file, 'rt',
1911
bzrlib.user_encoding).read()
1912
if my_message == "":
1913
raise errors.BzrCommandError("empty commit message specified")
1917
reporter = ReportCommitToLog()
1919
reporter = NullCommitReporter()
1922
tree.commit(message_callback=get_message,
1923
specific_files=selected_list,
1924
allow_pointless=unchanged, strict=strict, local=local,
1926
except PointlessCommit:
1927
# FIXME: This should really happen before the file is read in;
1928
# perhaps prepare the commit; get the message; then actually commit
1929
raise errors.BzrCommandError("no changes to commit."
1930
" use --unchanged to commit anyhow")
1931
except ConflictsInTree:
1932
raise errors.BzrCommandError('Conflicts detected in working '
1933
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
1935
except StrictCommitFailed:
1936
raise errors.BzrCommandError("Commit refused because there are"
1937
" unknown files in the working tree.")
1938
except errors.BoundBranchOutOfDate, e:
1939
raise errors.BzrCommandError(str(e) + "\n"
1940
'To commit to master branch, run update and then commit.\n'
1941
'You can also pass --local to commit to continue working '
1945
class cmd_check(Command):
1946
"""Validate consistency of branch history.
1948
This command checks various invariants about the branch storage to
1949
detect data corruption or bzr bugs.
1951
takes_args = ['branch?']
1952
takes_options = ['verbose']
1954
def run(self, branch=None, verbose=False):
1955
from bzrlib.check import check
1957
tree = WorkingTree.open_containing()[0]
1958
branch = tree.branch
1960
branch = Branch.open(branch)
1961
check(branch, verbose)
1964
class cmd_upgrade(Command):
1965
"""Upgrade branch storage to current format.
1967
The check command or bzr developers may sometimes advise you to run
1968
this command. When the default format has changed you may also be warned
1969
during other operations to upgrade.
1971
takes_args = ['url?']
1974
help='Upgrade to a specific format. Current formats'
1975
' are: default, knit, metaweave and weave.'
1976
' Default is knit; metaweave and weave are'
1978
type=get_format_type),
1982
def run(self, url='.', format=None):
1983
from bzrlib.upgrade import upgrade
1985
format = get_format_type('default')
1986
upgrade(url, format)
1989
class cmd_whoami(Command):
1990
"""Show or set bzr user id.
1994
bzr whoami 'Frank Chu <fchu@example.com>'
1996
takes_options = [ Option('email',
1997
help='display email address only'),
1999
help='set identity for the current branch instead of '
2002
takes_args = ['name?']
2003
encoding_type = 'replace'
2006
def run(self, email=False, branch=False, name=None):
2008
# use branch if we're inside one; otherwise global config
2010
c = Branch.open_containing('.')[0].get_config()
2011
except errors.NotBranchError:
2012
c = config.GlobalConfig()
2014
self.outf.write(c.user_email() + '\n')
2016
self.outf.write(c.username() + '\n')
2019
# display a warning if an email address isn't included in the given name.
2021
config.extract_email_address(name)
2022
except errors.NoEmailInUsername, e:
2023
warning('"%s" does not seem to contain an email address. '
2024
'This is allowed, but not recommended.', name)
2026
# use global config unless --branch given
2028
c = Branch.open_containing('.')[0].get_config()
2030
c = config.GlobalConfig()
2031
c.set_user_option('email', name)
2034
class cmd_nick(Command):
2035
"""Print or set the branch nickname.
2037
If unset, the tree root directory name is used as the nickname
2038
To print the current nickname, execute with no argument.
2040
takes_args = ['nickname?']
2041
def run(self, nickname=None):
2042
branch = Branch.open_containing(u'.')[0]
2043
if nickname is None:
2044
self.printme(branch)
2046
branch.nick = nickname
2049
def printme(self, branch):
2053
class cmd_selftest(Command):
2054
"""Run internal test suite.
2056
This creates temporary test directories in the working directory,
2057
but not existing data is affected. These directories are deleted
2058
if the tests pass, or left behind to help in debugging if they
2059
fail and --keep-output is specified.
2061
If arguments are given, they are regular expressions that say
2062
which tests should run.
2064
If the global option '--no-plugins' is given, plugins are not loaded
2065
before running the selftests. This has two effects: features provided or
2066
modified by plugins will not be tested, and tests provided by plugins will
2071
bzr --no-plugins selftest -v
2073
# TODO: --list should give a list of all available tests
2075
# NB: this is used from the class without creating an instance, which is
2076
# why it does not have a self parameter.
2077
def get_transport_type(typestring):
2078
"""Parse and return a transport specifier."""
2079
if typestring == "sftp":
2080
from bzrlib.transport.sftp import SFTPAbsoluteServer
2081
return SFTPAbsoluteServer
2082
if typestring == "memory":
2083
from bzrlib.transport.memory import MemoryServer
2085
if typestring == "fakenfs":
2086
from bzrlib.transport.fakenfs import FakeNFSServer
2087
return FakeNFSServer
2088
msg = "No known transport type %s. Supported types are: sftp\n" %\
2090
raise errors.BzrCommandError(msg)
2093
takes_args = ['testspecs*']
2094
takes_options = ['verbose',
2095
Option('one', help='stop when one test fails'),
2096
Option('keep-output',
2097
help='keep output directories when tests fail'),
2099
help='Use a different transport by default '
2100
'throughout the test suite.',
2101
type=get_transport_type),
2102
Option('benchmark', help='run the bzr bencharks.'),
2103
Option('lsprof-timed',
2104
help='generate lsprof output for benchmarked'
2105
' sections of code.'),
2106
Option('cache-dir', type=str,
2107
help='a directory to cache intermediate'
2108
' benchmark steps'),
2109
Option('clean-output',
2110
help='clean temporary tests directories'
2111
' without running tests'),
2113
encoding_type = 'replace'
2115
def run(self, testspecs_list=None, verbose=None, one=False,
2116
keep_output=False, transport=None, benchmark=None,
2117
lsprof_timed=None, cache_dir=None, clean_output=False):
2119
from bzrlib.tests import selftest
2120
import bzrlib.benchmarks as benchmarks
2121
from bzrlib.benchmarks import tree_creator
2124
from bzrlib.tests import clean_selftest_output
2125
clean_selftest_output()
2128
if cache_dir is not None:
2129
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2130
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2131
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2133
if testspecs_list is not None:
2134
pattern = '|'.join(testspecs_list)
2138
test_suite_factory = benchmarks.test_suite
2141
# TODO: should possibly lock the history file...
2142
benchfile = open(".perf_history", "at", buffering=1)
2144
test_suite_factory = None
2149
result = selftest(verbose=verbose,
2151
stop_on_failure=one,
2152
keep_output=keep_output,
2153
transport=transport,
2154
test_suite_factory=test_suite_factory,
2155
lsprof_timed=lsprof_timed,
2156
bench_history=benchfile)
2158
if benchfile is not None:
2161
info('tests passed')
2163
info('tests failed')
2164
return int(not result)
2167
class cmd_version(Command):
2168
"""Show version of bzr."""
2172
from bzrlib.version import show_version
2176
class cmd_rocks(Command):
2177
"""Statement of optimism."""
2183
print "it sure does!"
2186
class cmd_find_merge_base(Command):
2187
"""Find and print a base revision for merging two branches."""
2188
# TODO: Options to specify revisions on either side, as if
2189
# merging only part of the history.
2190
takes_args = ['branch', 'other']
2194
def run(self, branch, other):
2195
from bzrlib.revision import MultipleRevisionSources
2197
branch1 = Branch.open_containing(branch)[0]
2198
branch2 = Branch.open_containing(other)[0]
2200
history_1 = branch1.revision_history()
2201
history_2 = branch2.revision_history()
2203
last1 = branch1.last_revision()
2204
last2 = branch2.last_revision()
2206
source = MultipleRevisionSources(branch1.repository,
2209
base_rev_id = common_ancestor(last1, last2, source)
2211
print 'merge base is revision %s' % base_rev_id
2214
class cmd_merge(Command):
2215
"""Perform a three-way merge.
2217
The branch is the branch you will merge from. By default, it will merge
2218
the latest revision. If you specify a revision, that revision will be
2219
merged. If you specify two revisions, the first will be used as a BASE,
2220
and the second one as OTHER. Revision numbers are always relative to the
2223
By default, bzr will try to merge in all new work from the other
2224
branch, automatically determining an appropriate base. If this
2225
fails, you may need to give an explicit base.
2227
Merge will do its best to combine the changes in two branches, but there
2228
are some kinds of problems only a human can fix. When it encounters those,
2229
it will mark a conflict. A conflict means that you need to fix something,
2230
before you should commit.
2232
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2234
If there is no default branch set, the first merge will set it. After
2235
that, you can omit the branch to use the default. To change the
2236
default, use --remember. The value will only be saved if the remote
2237
location can be accessed.
2241
To merge the latest revision from bzr.dev
2242
bzr merge ../bzr.dev
2244
To merge changes up to and including revision 82 from bzr.dev
2245
bzr merge -r 82 ../bzr.dev
2247
To merge the changes introduced by 82, without previous changes:
2248
bzr merge -r 81..82 ../bzr.dev
2250
merge refuses to run if there are any uncommitted changes, unless
2253
The following merge types are available:
2255
takes_args = ['branch?']
2256
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2257
Option('show-base', help="Show base revision text in "
2259
Option('uncommitted', help='Apply uncommitted changes'
2260
' from a working copy, instead of branch changes'),
2261
Option('pull', help='If the destination is already'
2262
' completely merged into the source, pull from the'
2263
' source rather than merging. When this happens,'
2264
' you do not need to commit the result.'),
2268
from inspect import getdoc
2269
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2271
def run(self, branch=None, revision=None, force=False, merge_type=None,
2272
show_base=False, reprocess=False, remember=False,
2273
uncommitted=False, pull=False):
2274
if merge_type is None:
2275
merge_type = _mod_merge.Merge3Merger
2277
tree = WorkingTree.open_containing(u'.')[0]
2279
if branch is not None:
2281
reader = bundle.read_bundle_from_url(branch)
2282
except errors.NotABundle:
2283
pass # Continue on considering this url a Branch
2285
conflicts = merge_bundle(reader, tree, not force, merge_type,
2286
reprocess, show_base)
2292
if revision is None \
2293
or len(revision) < 1 or revision[0].needs_branch():
2294
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2296
if revision is None or len(revision) < 1:
2299
other = [branch, None]
2302
other = [branch, -1]
2303
other_branch, path = Branch.open_containing(branch)
2306
raise errors.BzrCommandError('Cannot use --uncommitted and'
2307
' --revision at the same time.')
2308
branch = revision[0].get_branch() or branch
2309
if len(revision) == 1:
2311
other_branch, path = Branch.open_containing(branch)
2312
revno = revision[0].in_history(other_branch).revno
2313
other = [branch, revno]
2315
assert len(revision) == 2
2316
if None in revision:
2317
raise errors.BzrCommandError(
2318
"Merge doesn't permit empty revision specifier.")
2319
base_branch, path = Branch.open_containing(branch)
2320
branch1 = revision[1].get_branch() or branch
2321
other_branch, path1 = Branch.open_containing(branch1)
2322
if revision[0].get_branch() is not None:
2323
# then path was obtained from it, and is None.
2326
base = [branch, revision[0].in_history(base_branch).revno]
2327
other = [branch1, revision[1].in_history(other_branch).revno]
2329
if tree.branch.get_parent() is None or remember:
2330
tree.branch.set_parent(other_branch.base)
2333
interesting_files = [path]
2335
interesting_files = None
2336
pb = ui.ui_factory.nested_progress_bar()
2339
conflict_count = _merge_helper(
2340
other, base, check_clean=(not force),
2341
merge_type=merge_type,
2342
reprocess=reprocess,
2343
show_base=show_base,
2345
pb=pb, file_list=interesting_files)
2348
if conflict_count != 0:
2352
except errors.AmbiguousBase, e:
2353
m = ("sorry, bzr can't determine the right merge base yet\n"
2354
"candidates are:\n "
2355
+ "\n ".join(e.bases)
2357
"please specify an explicit base with -r,\n"
2358
"and (if you want) report this to the bzr developers\n")
2361
# TODO: move up to common parent; this isn't merge-specific anymore.
2362
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2363
"""Use tree.branch's parent if none was supplied.
2365
Report if the remembered location was used.
2367
if supplied_location is not None:
2368
return supplied_location
2369
stored_location = tree.branch.get_parent()
2370
mutter("%s", stored_location)
2371
if stored_location is None:
2372
raise errors.BzrCommandError("No location specified or remembered")
2373
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2374
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2375
return stored_location
2378
class cmd_remerge(Command):
2381
Use this if you want to try a different merge technique while resolving
2382
conflicts. Some merge techniques are better than others, and remerge
2383
lets you try different ones on different files.
2385
The options for remerge have the same meaning and defaults as the ones for
2386
merge. The difference is that remerge can (only) be run when there is a
2387
pending merge, and it lets you specify particular files.
2390
$ bzr remerge --show-base
2391
Re-do the merge of all conflicted files, and show the base text in
2392
conflict regions, in addition to the usual THIS and OTHER texts.
2394
$ bzr remerge --merge-type weave --reprocess foobar
2395
Re-do the merge of "foobar", using the weave merge algorithm, with
2396
additional processing to reduce the size of conflict regions.
2398
The following merge types are available:"""
2399
takes_args = ['file*']
2400
takes_options = ['merge-type', 'reprocess',
2401
Option('show-base', help="Show base revision text in "
2405
from inspect import getdoc
2406
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2408
def run(self, file_list=None, merge_type=None, show_base=False,
2410
if merge_type is None:
2411
merge_type = _mod_merge.Merge3Merger
2412
tree, file_list = tree_files(file_list)
2415
parents = tree.get_parent_ids()
2416
if len(parents) != 2:
2417
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2418
" merges. Not cherrypicking or"
2420
repository = tree.branch.repository
2421
base_revision = common_ancestor(parents[0],
2422
parents[1], repository)
2423
base_tree = repository.revision_tree(base_revision)
2424
other_tree = repository.revision_tree(parents[1])
2425
interesting_ids = None
2427
conflicts = tree.conflicts()
2428
if file_list is not None:
2429
interesting_ids = set()
2430
for filename in file_list:
2431
file_id = tree.path2id(filename)
2433
raise errors.NotVersionedError(filename)
2434
interesting_ids.add(file_id)
2435
if tree.kind(file_id) != "directory":
2438
for name, ie in tree.inventory.iter_entries(file_id):
2439
interesting_ids.add(ie.file_id)
2440
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2442
# Remerge only supports resolving contents conflicts
2443
allowed_conflicts = ('text conflict', 'contents conflict')
2444
restore_files = [c.path for c in conflicts
2445
if c.typestring in allowed_conflicts]
2446
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2447
tree.set_conflicts(ConflictList(new_conflicts))
2448
if file_list is not None:
2449
restore_files = file_list
2450
for filename in restore_files:
2452
restore(tree.abspath(filename))
2453
except errors.NotConflicted:
2455
conflicts = _mod_merge.merge_inner(
2456
tree.branch, other_tree, base_tree,
2458
interesting_ids=interesting_ids,
2459
other_rev_id=parents[1],
2460
merge_type=merge_type,
2461
show_base=show_base,
2462
reprocess=reprocess)
2471
class cmd_revert(Command):
2472
"""Revert files to a previous revision.
2474
Giving a list of files will revert only those files. Otherwise, all files
2475
will be reverted. If the revision is not specified with '--revision', the
2476
last committed revision is used.
2478
To remove only some changes, without reverting to a prior version, use
2479
merge instead. For example, "merge . --r-2..-3" will remove the changes
2480
introduced by -2, without affecting the changes introduced by -1. Or
2481
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2483
By default, any files that have been manually changed will be backed up
2484
first. (Files changed only by merge are not backed up.) Backup files have
2485
'.~#~' appended to their name, where # is a number.
2487
When you provide files, you can use their current pathname or the pathname
2488
from the target revision. So you can use revert to "undelete" a file by
2489
name. If you name a directory, all the contents of that directory will be
2492
takes_options = ['revision', 'no-backup']
2493
takes_args = ['file*']
2494
aliases = ['merge-revert']
2496
def run(self, revision=None, no_backup=False, file_list=None):
2497
if file_list is not None:
2498
if len(file_list) == 0:
2499
raise errors.BzrCommandError("No files specified")
2503
tree, file_list = tree_files(file_list)
2504
if revision is None:
2505
# FIXME should be tree.last_revision
2506
rev_id = tree.last_revision()
2507
elif len(revision) != 1:
2508
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2510
rev_id = revision[0].in_history(tree.branch).rev_id
2511
pb = ui.ui_factory.nested_progress_bar()
2513
tree.revert(file_list,
2514
tree.branch.repository.revision_tree(rev_id),
2515
not no_backup, pb, report_changes=True)
2520
class cmd_assert_fail(Command):
2521
"""Test reporting of assertion failures"""
2522
# intended just for use in testing
2527
raise AssertionError("always fails")
2530
class cmd_help(Command):
2531
"""Show help on a command or other topic.
2533
For a list of all available commands, say 'bzr help commands'.
2535
takes_options = [Option('long', 'show help on all commands')]
2536
takes_args = ['topic?']
2537
aliases = ['?', '--help', '-?', '-h']
2540
def run(self, topic=None, long=False):
2542
if topic is None and long:
2544
bzrlib.help.help(topic)
2547
class cmd_shell_complete(Command):
2548
"""Show appropriate completions for context.
2550
For a list of all available commands, say 'bzr shell-complete'.
2552
takes_args = ['context?']
2557
def run(self, context=None):
2558
import shellcomplete
2559
shellcomplete.shellcomplete(context)
2562
class cmd_fetch(Command):
2563
"""Copy in history from another branch but don't merge it.
2565
This is an internal method used for pull and merge.
2568
takes_args = ['from_branch', 'to_branch']
2569
def run(self, from_branch, to_branch):
2570
from bzrlib.fetch import Fetcher
2571
from_b = Branch.open(from_branch)
2572
to_b = Branch.open(to_branch)
2573
Fetcher(to_b, from_b)
2576
class cmd_missing(Command):
2577
"""Show unmerged/unpulled revisions between two branches.
2579
OTHER_BRANCH may be local or remote.
2581
takes_args = ['other_branch?']
2582
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2584
'Display changes in the local branch only'),
2585
Option('theirs-only',
2586
'Display changes in the remote branch only'),
2594
encoding_type = 'replace'
2597
def run(self, other_branch=None, reverse=False, mine_only=False,
2598
theirs_only=False, log_format=None, long=False, short=False, line=False,
2599
show_ids=False, verbose=False):
2600
from bzrlib.missing import find_unmerged, iter_log_data
2601
from bzrlib.log import log_formatter
2602
local_branch = Branch.open_containing(u".")[0]
2603
parent = local_branch.get_parent()
2604
if other_branch is None:
2605
other_branch = parent
2606
if other_branch is None:
2607
raise errors.BzrCommandError("No peer location known or specified.")
2608
print "Using last location: " + local_branch.get_parent()
2609
remote_branch = Branch.open(other_branch)
2610
if remote_branch.base == local_branch.base:
2611
remote_branch = local_branch
2612
local_branch.lock_read()
2614
remote_branch.lock_read()
2616
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2617
if (log_format is None):
2618
default = local_branch.get_config().log_format()
2619
log_format = get_log_format(long=long, short=short,
2620
line=line, default=default)
2621
lf = log_formatter(log_format,
2624
show_timezone='original')
2625
if reverse is False:
2626
local_extra.reverse()
2627
remote_extra.reverse()
2628
if local_extra and not theirs_only:
2629
print "You have %d extra revision(s):" % len(local_extra)
2630
for data in iter_log_data(local_extra, local_branch.repository,
2633
printed_local = True
2635
printed_local = False
2636
if remote_extra and not mine_only:
2637
if printed_local is True:
2639
print "You are missing %d revision(s):" % len(remote_extra)
2640
for data in iter_log_data(remote_extra, remote_branch.repository,
2643
if not remote_extra and not local_extra:
2645
print "Branches are up to date."
2649
remote_branch.unlock()
2651
local_branch.unlock()
2652
if not status_code and parent is None and other_branch is not None:
2653
local_branch.lock_write()
2655
# handle race conditions - a parent might be set while we run.
2656
if local_branch.get_parent() is None:
2657
local_branch.set_parent(remote_branch.base)
2659
local_branch.unlock()
2663
class cmd_plugins(Command):
2668
import bzrlib.plugin
2669
from inspect import getdoc
2670
for name, plugin in bzrlib.plugin.all_plugins().items():
2671
if getattr(plugin, '__path__', None) is not None:
2672
print plugin.__path__[0]
2673
elif getattr(plugin, '__file__', None) is not None:
2674
print plugin.__file__
2680
print '\t', d.split('\n')[0]
2683
class cmd_testament(Command):
2684
"""Show testament (signing-form) of a revision."""
2685
takes_options = ['revision',
2686
Option('long', help='Produce long-format testament'),
2687
Option('strict', help='Produce a strict-format'
2689
takes_args = ['branch?']
2691
def run(self, branch=u'.', revision=None, long=False, strict=False):
2692
from bzrlib.testament import Testament, StrictTestament
2694
testament_class = StrictTestament
2696
testament_class = Testament
2697
b = WorkingTree.open_containing(branch)[0].branch
2700
if revision is None:
2701
rev_id = b.last_revision()
2703
rev_id = revision[0].in_history(b).rev_id
2704
t = testament_class.from_revision(b.repository, rev_id)
2706
sys.stdout.writelines(t.as_text_lines())
2708
sys.stdout.write(t.as_short_text())
2713
class cmd_annotate(Command):
2714
"""Show the origin of each line in a file.
2716
This prints out the given file with an annotation on the left side
2717
indicating which revision, author and date introduced the change.
2719
If the origin is the same for a run of consecutive lines, it is
2720
shown only at the top, unless the --all option is given.
2722
# TODO: annotate directories; showing when each file was last changed
2723
# TODO: if the working copy is modified, show annotations on that
2724
# with new uncommitted lines marked
2725
aliases = ['ann', 'blame', 'praise']
2726
takes_args = ['filename']
2727
takes_options = [Option('all', help='show annotations on all lines'),
2728
Option('long', help='show date in annotations'),
2734
def run(self, filename, all=False, long=False, revision=None,
2736
from bzrlib.annotate import annotate_file
2737
tree, relpath = WorkingTree.open_containing(filename)
2738
branch = tree.branch
2741
if revision is None:
2742
revision_id = branch.last_revision()
2743
elif len(revision) != 1:
2744
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2746
revision_id = revision[0].in_history(branch).rev_id
2747
file_id = tree.inventory.path2id(relpath)
2748
tree = branch.repository.revision_tree(revision_id)
2749
file_version = tree.inventory[file_id].revision
2750
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2756
class cmd_re_sign(Command):
2757
"""Create a digital signature for an existing revision."""
2758
# TODO be able to replace existing ones.
2760
hidden = True # is this right ?
2761
takes_args = ['revision_id*']
2762
takes_options = ['revision']
2764
def run(self, revision_id_list=None, revision=None):
2765
import bzrlib.gpg as gpg
2766
if revision_id_list is not None and revision is not None:
2767
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2768
if revision_id_list is None and revision is None:
2769
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2770
b = WorkingTree.open_containing(u'.')[0].branch
2771
gpg_strategy = gpg.GPGStrategy(b.get_config())
2772
if revision_id_list is not None:
2773
for revision_id in revision_id_list:
2774
b.repository.sign_revision(revision_id, gpg_strategy)
2775
elif revision is not None:
2776
if len(revision) == 1:
2777
revno, rev_id = revision[0].in_history(b)
2778
b.repository.sign_revision(rev_id, gpg_strategy)
2779
elif len(revision) == 2:
2780
# are they both on rh- if so we can walk between them
2781
# might be nice to have a range helper for arbitrary
2782
# revision paths. hmm.
2783
from_revno, from_revid = revision[0].in_history(b)
2784
to_revno, to_revid = revision[1].in_history(b)
2785
if to_revid is None:
2786
to_revno = b.revno()
2787
if from_revno is None or to_revno is None:
2788
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2789
for revno in range(from_revno, to_revno + 1):
2790
b.repository.sign_revision(b.get_rev_id(revno),
2793
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2796
class cmd_bind(Command):
2797
"""Bind the current branch to a master branch.
2799
After binding, commits must succeed on the master branch
2800
before they are executed on the local one.
2803
takes_args = ['location']
2806
def run(self, location=None):
2807
b, relpath = Branch.open_containing(u'.')
2808
b_other = Branch.open(location)
2811
except errors.DivergedBranches:
2812
raise errors.BzrCommandError('These branches have diverged.'
2813
' Try merging, and then bind again.')
2816
class cmd_unbind(Command):
2817
"""Unbind the current branch from its master branch.
2819
After unbinding, the local branch is considered independent.
2820
All subsequent commits will be local.
2827
b, relpath = Branch.open_containing(u'.')
2829
raise errors.BzrCommandError('Local branch is not bound')
2832
class cmd_uncommit(Command):
2833
"""Remove the last committed revision.
2835
--verbose will print out what is being removed.
2836
--dry-run will go through all the motions, but not actually
2839
In the future, uncommit will create a revision bundle, which can then
2843
# TODO: jam 20060108 Add an option to allow uncommit to remove
2844
# unreferenced information in 'branch-as-repository' branches.
2845
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2846
# information in shared branches as well.
2847
takes_options = ['verbose', 'revision',
2848
Option('dry-run', help='Don\'t actually make changes'),
2849
Option('force', help='Say yes to all questions.')]
2850
takes_args = ['location?']
2853
def run(self, location=None,
2854
dry_run=False, verbose=False,
2855
revision=None, force=False):
2856
from bzrlib.log import log_formatter, show_log
2858
from bzrlib.uncommit import uncommit
2860
if location is None:
2862
control, relpath = bzrdir.BzrDir.open_containing(location)
2864
tree = control.open_workingtree()
2866
except (errors.NoWorkingTree, errors.NotLocalUrl):
2868
b = control.open_branch()
2871
if revision is None:
2874
# 'bzr uncommit -r 10' actually means uncommit
2875
# so that the final tree is at revno 10.
2876
# but bzrlib.uncommit.uncommit() actually uncommits
2877
# the revisions that are supplied.
2878
# So we need to offset it by one
2879
revno = revision[0].in_history(b).revno+1
2881
if revno <= b.revno():
2882
rev_id = b.get_rev_id(revno)
2884
self.outf.write('No revisions to uncommit.\n')
2887
lf = log_formatter('short',
2889
show_timezone='original')
2894
direction='forward',
2895
start_revision=revno,
2896
end_revision=b.revno())
2899
print 'Dry-run, pretending to remove the above revisions.'
2901
val = raw_input('Press <enter> to continue')
2903
print 'The above revision(s) will be removed.'
2905
val = raw_input('Are you sure [y/N]? ')
2906
if val.lower() not in ('y', 'yes'):
2910
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2914
class cmd_break_lock(Command):
2915
"""Break a dead lock on a repository, branch or working directory.
2917
CAUTION: Locks should only be broken when you are sure that the process
2918
holding the lock has been stopped.
2920
You can get information on what locks are open via the 'bzr info' command.
2925
takes_args = ['location?']
2927
def run(self, location=None, show=False):
2928
if location is None:
2930
control, relpath = bzrdir.BzrDir.open_containing(location)
2932
control.break_lock()
2933
except NotImplementedError:
2937
class cmd_wait_until_signalled(Command):
2938
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
2940
This just prints a line to signal when it is ready, then blocks on stdin.
2946
sys.stdout.write("running\n")
2948
sys.stdin.readline()
2951
class cmd_serve(Command):
2952
"""Run the bzr server."""
2954
aliases = ['server']
2958
help='serve on stdin/out for use from inetd or sshd'),
2960
help='listen for connections on nominated port of the form '
2961
'[hostname:]portnumber. Passing 0 as the port number will '
2962
'result in a dynamically allocated port.',
2965
help='serve contents of directory',
2967
Option('allow-writes',
2968
help='By default the server is a readonly server. Supplying '
2969
'--allow-writes enables write access to the contents of '
2970
'the served directory and below. '
2974
def run(self, port=None, inet=False, directory=None, allow_writes=False):
2975
from bzrlib.transport import smart
2976
from bzrlib.transport import get_transport
2977
if directory is None:
2978
directory = os.getcwd()
2979
url = urlutils.local_path_to_url(directory)
2980
if not allow_writes:
2981
url = 'readonly+' + url
2982
t = get_transport(url)
2984
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
2985
elif port is not None:
2987
host, port = port.split(':')
2990
server = smart.SmartTCPServer(t, host=host, port=int(port))
2991
print 'listening on port: ', server.port
2994
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
2998
# command-line interpretation helper for merge-related commands
2999
def _merge_helper(other_revision, base_revision,
3000
check_clean=True, ignore_zero=False,
3001
this_dir=None, backup_files=False,
3003
file_list=None, show_base=False, reprocess=False,
3005
pb=DummyProgress()):
3006
"""Merge changes into a tree.
3009
list(path, revno) Base for three-way merge.
3010
If [None, None] then a base will be automatically determined.
3012
list(path, revno) Other revision for three-way merge.
3014
Directory to merge changes into; '.' by default.
3016
If true, this_dir must have no uncommitted changes before the
3018
ignore_zero - If true, suppress the "zero conflicts" message when
3019
there are no conflicts; should be set when doing something we expect
3020
to complete perfectly.
3021
file_list - If supplied, merge only changes to selected files.
3023
All available ancestors of other_revision and base_revision are
3024
automatically pulled into the branch.
3026
The revno may be -1 to indicate the last revision on the branch, which is
3029
This function is intended for use from the command line; programmatic
3030
clients might prefer to call merge.merge_inner(), which has less magic
3033
# Loading it late, so that we don't always have to import bzrlib.merge
3034
if merge_type is None:
3035
merge_type = _mod_merge.Merge3Merger
3036
if this_dir is None:
3038
this_tree = WorkingTree.open_containing(this_dir)[0]
3039
if show_base and not merge_type is _mod_merge.Merge3Merger:
3040
raise errors.BzrCommandError("Show-base is not supported for this merge"
3041
" type. %s" % merge_type)
3042
if reprocess and not merge_type.supports_reprocess:
3043
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3044
" type %s." % merge_type)
3045
if reprocess and show_base:
3046
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3048
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3050
merger.pp = ProgressPhase("Merge phase", 5, pb)
3051
merger.pp.next_phase()
3052
merger.check_basis(check_clean)
3053
merger.set_other(other_revision)
3054
merger.pp.next_phase()
3055
merger.set_base(base_revision)
3056
if merger.base_rev_id == merger.other_rev_id:
3057
note('Nothing to do.')
3059
if file_list is None:
3060
if pull and merger.base_rev_id == merger.this_rev_id:
3061
count = merger.this_tree.pull(merger.this_branch,
3062
False, merger.other_rev_id)
3063
note('%d revision(s) pulled.' % (count,))
3065
merger.backup_files = backup_files
3066
merger.merge_type = merge_type
3067
merger.set_interesting_files(file_list)
3068
merger.show_base = show_base
3069
merger.reprocess = reprocess
3070
conflicts = merger.do_merge()
3071
if file_list is None:
3072
merger.set_pending()
3079
merge = _merge_helper
3082
# these get imported and then picked up by the scan for cmd_*
3083
# TODO: Some more consistent way to split command definitions across files;
3084
# we do need to load at least some information about them to know of
3085
# aliases. ideally we would avoid loading the implementation until the
3086
# details were needed.
3087
from bzrlib.cmd_version_info import cmd_version_info
3088
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3089
from bzrlib.bundle.commands import cmd_bundle_revisions
3090
from bzrlib.sign_my_commits import cmd_sign_my_commits
3091
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3092
cmd_weave_plan_merge, cmd_weave_merge_text