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(), """
44
from bzrlib.branch import Branch
45
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
46
from bzrlib.conflicts import ConflictList
47
from bzrlib.revision import common_ancestor
48
from bzrlib.revisionspec import RevisionSpec
49
from bzrlib.workingtree import WorkingTree
52
from bzrlib.commands import Command, display_command
53
from bzrlib.option import Option
54
from bzrlib.progress import DummyProgress, ProgressPhase
55
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
58
def tree_files(file_list, default_branch=u'.'):
60
return internal_tree_files(file_list, default_branch)
61
except errors.FileInWrongBranch, e:
62
raise errors.BzrCommandError("%s is not in the same branch as %s" %
63
(e.path, file_list[0]))
66
# XXX: Bad function name; should possibly also be a class method of
67
# WorkingTree rather than a function.
68
def internal_tree_files(file_list, default_branch=u'.'):
69
"""Convert command-line paths to a WorkingTree and relative paths.
71
This is typically used for command-line processors that take one or
72
more filenames, and infer the workingtree that contains them.
74
The filenames given are not required to exist.
76
:param file_list: Filenames to convert.
78
:param default_branch: Fallback tree path to use if file_list is empty or
81
:return: workingtree, [relative_paths]
83
if file_list is None or len(file_list) == 0:
84
return WorkingTree.open_containing(default_branch)[0], file_list
85
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
87
for filename in file_list:
89
new_list.append(tree.relpath(osutils.dereference_path(filename)))
90
except errors.PathNotChild:
91
raise errors.FileInWrongBranch(tree.branch, filename)
95
def get_format_type(typestring):
96
"""Parse and return a format specifier."""
97
if typestring == "weave":
98
return bzrdir.BzrDirFormat6()
99
if typestring == "default":
100
return bzrdir.BzrDirMetaFormat1()
101
if typestring == "metaweave":
102
format = bzrdir.BzrDirMetaFormat1()
103
format.repository_format = repository.RepositoryFormat7()
105
if typestring == "knit":
106
format = bzrdir.BzrDirMetaFormat1()
107
format.repository_format = repository.RepositoryFormatKnit1()
109
if typestring == "experimental-knit2":
110
format = bzrdir.BzrDirMetaFormat1()
111
format.repository_format = repository.RepositoryFormatKnit2()
113
msg = "Unknown bzr format %s. Current formats are: default, knit,\n" \
114
"metaweave and weave" % typestring
115
raise errors.BzrCommandError(msg)
118
# TODO: Make sure no commands unconditionally use the working directory as a
119
# branch. If a filename argument is used, the first of them should be used to
120
# specify the branch. (Perhaps this can be factored out into some kind of
121
# Argument class, representing a file in a branch, where the first occurrence
124
class cmd_status(Command):
125
"""Display status summary.
127
This reports on versioned and unknown files, reporting them
128
grouped by state. Possible states are:
131
Versioned in the working copy but not in the previous revision.
134
Versioned in the previous revision but removed or deleted
138
Path of this file changed from the previous revision;
139
the text may also have changed. This includes files whose
140
parent directory was renamed.
143
Text has changed since the previous revision.
146
Not versioned and not matching an ignore pattern.
148
To see ignored files use 'bzr ignored'. For details in the
149
changes to file texts, use 'bzr diff'.
151
If no arguments are specified, the status of the entire working
152
directory is shown. Otherwise, only the status of the specified
153
files or directories is reported. If a directory is given, status
154
is reported for everything inside that directory.
156
If a revision argument is given, the status is calculated against
157
that revision, or between two revisions if two are provided.
160
# TODO: --no-recurse, --recurse options
162
takes_args = ['file*']
163
takes_options = ['show-ids', 'revision']
164
aliases = ['st', 'stat']
166
encoding_type = 'replace'
169
def run(self, show_ids=False, file_list=None, revision=None):
170
from bzrlib.status import show_tree_status
172
tree, file_list = tree_files(file_list)
174
show_tree_status(tree, show_ids=show_ids,
175
specific_files=file_list, revision=revision,
179
class cmd_cat_revision(Command):
180
"""Write out metadata for a revision.
182
The revision to print can either be specified by a specific
183
revision identifier, or you can use --revision.
187
takes_args = ['revision_id?']
188
takes_options = ['revision']
189
# cat-revision is more for frontends so should be exact
193
def run(self, revision_id=None, revision=None):
195
if revision_id is not None and revision is not None:
196
raise errors.BzrCommandError('You can only supply one of'
197
' revision_id or --revision')
198
if revision_id is None and revision is None:
199
raise errors.BzrCommandError('You must supply either'
200
' --revision or a revision_id')
201
b = WorkingTree.open_containing(u'.')[0].branch
203
# TODO: jam 20060112 should cat-revision always output utf-8?
204
if revision_id is not None:
205
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
206
elif revision is not None:
209
raise errors.BzrCommandError('You cannot specify a NULL'
211
revno, rev_id = rev.in_history(b)
212
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
215
class cmd_revno(Command):
216
"""Show current revision number.
218
This is equal to the number of revisions on this branch.
221
takes_args = ['location?']
224
def run(self, location=u'.'):
225
self.outf.write(str(Branch.open_containing(location)[0].revno()))
226
self.outf.write('\n')
229
class cmd_revision_info(Command):
230
"""Show revision number and revision id for a given revision identifier.
233
takes_args = ['revision_info*']
234
takes_options = ['revision']
237
def run(self, revision=None, revision_info_list=[]):
240
if revision is not None:
241
revs.extend(revision)
242
if revision_info_list is not None:
243
for rev in revision_info_list:
244
revs.append(RevisionSpec.from_string(rev))
246
raise errors.BzrCommandError('You must supply a revision identifier')
248
b = WorkingTree.open_containing(u'.')[0].branch
251
revinfo = rev.in_history(b)
252
if revinfo.revno is None:
253
print ' %s' % revinfo.rev_id
255
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
258
class cmd_add(Command):
259
"""Add specified files or directories.
261
In non-recursive mode, all the named items are added, regardless
262
of whether they were previously ignored. A warning is given if
263
any of the named files are already versioned.
265
In recursive mode (the default), files are treated the same way
266
but the behaviour for directories is different. Directories that
267
are already versioned do not give a warning. All directories,
268
whether already versioned or not, are searched for files or
269
subdirectories that are neither versioned or ignored, and these
270
are added. This search proceeds recursively into versioned
271
directories. If no names are given '.' is assumed.
273
Therefore simply saying 'bzr add' will version all files that
274
are currently unknown.
276
Adding a file whose parent directory is not versioned will
277
implicitly add the parent, and so on up to the root. This means
278
you should never need to explicitly add a directory, they'll just
279
get added when you add a file in the directory.
281
--dry-run will show which files would be added, but not actually
284
--file-ids-from will try to use the file ids from the supplied path.
285
It looks up ids trying to find a matching parent directory with the
286
same filename, and then by pure path.
288
takes_args = ['file*']
289
takes_options = ['no-recurse', 'dry-run', 'verbose',
290
Option('file-ids-from', type=unicode,
291
help='Lookup file ids from here')]
292
encoding_type = 'replace'
294
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
298
if file_ids_from is not None:
300
base_tree, base_path = WorkingTree.open_containing(
302
except errors.NoWorkingTree:
303
base_branch, base_path = Branch.open_containing(
305
base_tree = base_branch.basis_tree()
307
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
308
to_file=self.outf, should_print=(not is_quiet()))
310
action = bzrlib.add.AddAction(to_file=self.outf,
311
should_print=(not is_quiet()))
313
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
314
action=action, save=not dry_run)
317
for glob in sorted(ignored.keys()):
318
for path in ignored[glob]:
319
self.outf.write("ignored %s matching \"%s\"\n"
323
for glob, paths in ignored.items():
324
match_len += len(paths)
325
self.outf.write("ignored %d file(s).\n" % match_len)
326
self.outf.write("If you wish to add some of these files,"
327
" please add them by name.\n")
330
class cmd_mkdir(Command):
331
"""Create a new versioned directory.
333
This is equivalent to creating the directory and then adding it.
336
takes_args = ['dir+']
337
encoding_type = 'replace'
339
def run(self, dir_list):
342
wt, dd = WorkingTree.open_containing(d)
344
self.outf.write('added %s\n' % d)
347
class cmd_relpath(Command):
348
"""Show path of a file relative to root"""
350
takes_args = ['filename']
354
def run(self, filename):
355
# TODO: jam 20050106 Can relpath return a munged path if
356
# sys.stdout encoding cannot represent it?
357
tree, relpath = WorkingTree.open_containing(filename)
358
self.outf.write(relpath)
359
self.outf.write('\n')
362
class cmd_inventory(Command):
363
"""Show inventory of the current working copy or a revision.
365
It is possible to limit the output to a particular entry
366
type using the --kind option. For example: --kind file.
368
It is also possible to restrict the list of files to a specific
369
set. For example: bzr inventory --show-ids this/file
372
takes_options = ['revision', 'show-ids', 'kind']
373
takes_args = ['file*']
376
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
377
if kind and kind not in ['file', 'directory', 'symlink']:
378
raise errors.BzrCommandError('invalid kind specified')
380
work_tree, file_list = tree_files(file_list)
382
if revision is not None:
383
if len(revision) > 1:
384
raise errors.BzrCommandError('bzr inventory --revision takes'
385
' exactly one revision identifier')
386
revision_id = revision[0].in_history(work_tree.branch).rev_id
387
tree = work_tree.branch.repository.revision_tree(revision_id)
389
# We include work_tree as well as 'tree' here
390
# So that doing '-r 10 path/foo' will lookup whatever file
391
# exists now at 'path/foo' even if it has been renamed, as
392
# well as whatever files existed in revision 10 at path/foo
393
trees = [tree, work_tree]
398
if file_list is not None:
399
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
400
require_versioned=True)
401
# find_ids_across_trees may include some paths that don't
403
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
404
for file_id in file_ids if file_id in tree)
406
entries = tree.inventory.entries()
408
for path, entry in entries:
409
if kind and kind != entry.kind:
412
self.outf.write('%-50s %s\n' % (path, entry.file_id))
414
self.outf.write(path)
415
self.outf.write('\n')
418
class cmd_mv(Command):
419
"""Move or rename a file.
422
bzr mv OLDNAME NEWNAME
423
bzr mv SOURCE... DESTINATION
425
If the last argument is a versioned directory, all the other names
426
are moved into it. Otherwise, there must be exactly two arguments
427
and the file is changed to a new name, which must not already exist.
429
Files cannot be moved between branches.
432
takes_args = ['names*']
433
aliases = ['move', 'rename']
434
encoding_type = 'replace'
436
def run(self, names_list):
437
if names_list is None:
440
if len(names_list) < 2:
441
raise errors.BzrCommandError("missing file argument")
442
tree, rel_names = tree_files(names_list)
444
if os.path.isdir(names_list[-1]):
445
# move into existing directory
446
for pair in tree.move(rel_names[:-1], rel_names[-1]):
447
self.outf.write("%s => %s\n" % pair)
449
if len(names_list) != 2:
450
raise errors.BzrCommandError('to mv multiple files the destination '
451
'must be a versioned directory')
452
tree.rename_one(rel_names[0], rel_names[1])
453
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
456
class cmd_pull(Command):
457
"""Turn this branch into a mirror of another branch.
459
This command only works on branches that have not diverged. Branches are
460
considered diverged if the destination branch's most recent commit is one
461
that has not been merged (directly or indirectly) into the parent.
463
If branches have diverged, you can use 'bzr merge' to integrate the changes
464
from one into the other. Once one branch has merged, the other should
465
be able to pull it again.
467
If you want to forget your local changes and just update your branch to
468
match the remote one, use pull --overwrite.
470
If there is no default location set, the first pull will set it. After
471
that, you can omit the location to use the default. To change the
472
default, use --remember. The value will only be saved if the remote
473
location can be accessed.
476
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
477
takes_args = ['location?']
478
encoding_type = 'replace'
480
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
481
# FIXME: too much stuff is in the command class
483
tree_to = WorkingTree.open_containing(u'.')[0]
484
branch_to = tree_to.branch
485
except errors.NoWorkingTree:
487
branch_to = Branch.open_containing(u'.')[0]
490
if location is not None:
492
reader = bundle.read_bundle_from_url(location)
493
except errors.NotABundle:
494
pass # Continue on considering this url a Branch
496
stored_loc = branch_to.get_parent()
498
if stored_loc is None:
499
raise errors.BzrCommandError("No pull location known or"
502
display_url = urlutils.unescape_for_display(stored_loc,
504
self.outf.write("Using saved location: %s\n" % display_url)
505
location = stored_loc
508
if reader is not None:
509
install_bundle(branch_to.repository, reader)
510
branch_from = branch_to
512
branch_from = Branch.open(location)
514
if branch_to.get_parent() is None or remember:
515
branch_to.set_parent(branch_from.base)
519
if reader is not None:
520
rev_id = reader.target
521
elif len(revision) == 1:
522
rev_id = revision[0].in_history(branch_from).rev_id
524
raise errors.BzrCommandError('bzr pull --revision takes one value.')
526
old_rh = branch_to.revision_history()
527
if tree_to is not None:
528
count = tree_to.pull(branch_from, overwrite, rev_id)
530
count = branch_to.pull(branch_from, overwrite, rev_id)
531
note('%d revision(s) pulled.' % (count,))
534
new_rh = branch_to.revision_history()
537
from bzrlib.log import show_changed_revisions
538
show_changed_revisions(branch_to, old_rh, new_rh,
542
class cmd_push(Command):
543
"""Update a mirror of this branch.
545
The target branch will not have its working tree populated because this
546
is both expensive, and is not supported on remote file systems.
548
Some smart servers or protocols *may* put the working tree in place in
551
This command only works on branches that have not diverged. Branches are
552
considered diverged if the destination branch's most recent commit is one
553
that has not been merged (directly or indirectly) by the source branch.
555
If branches have diverged, you can use 'bzr push --overwrite' to replace
556
the other branch completely, discarding its unmerged changes.
558
If you want to ensure you have the different changes in the other branch,
559
do a merge (see bzr help merge) from the other branch, and commit that.
560
After that you will be able to do a push without '--overwrite'.
562
If there is no default push location set, the first push will set it.
563
After that, you can omit the location to use the default. To change the
564
default, use --remember. The value will only be saved if the remote
565
location can be accessed.
568
takes_options = ['remember', 'overwrite', 'verbose',
569
Option('create-prefix',
570
help='Create the path leading up to the branch '
571
'if it does not already exist')]
572
takes_args = ['location?']
573
encoding_type = 'replace'
575
def run(self, location=None, remember=False, overwrite=False,
576
create_prefix=False, verbose=False):
577
# FIXME: Way too big! Put this into a function called from the
580
br_from = Branch.open_containing('.')[0]
581
stored_loc = br_from.get_push_location()
583
if stored_loc is None:
584
raise errors.BzrCommandError("No push location known or specified.")
586
display_url = urlutils.unescape_for_display(stored_loc,
588
self.outf.write("Using saved location: %s\n" % display_url)
589
location = stored_loc
591
to_transport = transport.get_transport(location)
592
location_url = to_transport.base
596
dir_to = bzrdir.BzrDir.open(location_url)
597
br_to = dir_to.open_branch()
598
except errors.NotBranchError:
600
to_transport = to_transport.clone('..')
601
if not create_prefix:
603
relurl = to_transport.relpath(location_url)
604
mutter('creating directory %s => %s', location_url, relurl)
605
to_transport.mkdir(relurl)
606
except errors.NoSuchFile:
607
raise errors.BzrCommandError("Parent directory of %s "
608
"does not exist." % location)
610
current = to_transport.base
611
needed = [(to_transport, to_transport.relpath(location_url))]
614
to_transport, relpath = needed[-1]
615
to_transport.mkdir(relpath)
617
except errors.NoSuchFile:
618
new_transport = to_transport.clone('..')
619
needed.append((new_transport,
620
new_transport.relpath(to_transport.base)))
621
if new_transport.base == to_transport.base:
622
raise errors.BzrCommandError("Could not create "
624
dir_to = br_from.bzrdir.clone(location_url,
625
revision_id=br_from.last_revision())
626
br_to = dir_to.open_branch()
627
count = len(br_to.revision_history())
628
# We successfully created the target, remember it
629
if br_from.get_push_location() is None or remember:
630
br_from.set_push_location(br_to.base)
632
# We were able to connect to the remote location, so remember it
633
# we don't need to successfully push because of possible divergence.
634
if br_from.get_push_location() is None or remember:
635
br_from.set_push_location(br_to.base)
636
old_rh = br_to.revision_history()
639
tree_to = dir_to.open_workingtree()
640
except errors.NotLocalUrl:
641
warning('This transport does not update the working '
642
'tree of: %s' % (br_to.base,))
643
count = br_to.pull(br_from, overwrite)
644
except errors.NoWorkingTree:
645
count = br_to.pull(br_from, overwrite)
647
count = tree_to.pull(br_from, overwrite)
648
except errors.DivergedBranches:
649
raise errors.BzrCommandError('These branches have diverged.'
650
' Try using "merge" and then "push".')
651
note('%d revision(s) pushed.' % (count,))
654
new_rh = br_to.revision_history()
657
from bzrlib.log import show_changed_revisions
658
show_changed_revisions(br_to, old_rh, new_rh,
662
class cmd_branch(Command):
663
"""Create a new copy of a branch.
665
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
666
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
668
To retrieve the branch as of a particular revision, supply the --revision
669
parameter, as in "branch foo/bar -r 5".
671
--basis is to speed up branching from remote branches. When specified, it
672
copies all the file-contents, inventory and revision data from the basis
673
branch before copying anything from the remote branch.
675
takes_args = ['from_location', 'to_location?']
676
takes_options = ['revision', 'basis']
677
aliases = ['get', 'clone']
679
def run(self, from_location, to_location=None, revision=None, basis=None):
682
elif len(revision) > 1:
683
raise errors.BzrCommandError(
684
'bzr branch --revision takes exactly 1 revision value')
686
br_from = Branch.open(from_location)
688
if e.errno == errno.ENOENT:
689
raise errors.BzrCommandError('Source location "%s" does not'
690
' exist.' % to_location)
695
if basis is not None:
696
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
699
if len(revision) == 1 and revision[0] is not None:
700
revision_id = revision[0].in_history(br_from)[1]
702
# FIXME - wt.last_revision, fallback to branch, fall back to
703
# None or perhaps NULL_REVISION to mean copy nothing
705
revision_id = br_from.last_revision()
706
if to_location is None:
707
to_location = os.path.basename(from_location.rstrip("/\\"))
710
name = os.path.basename(to_location) + '\n'
712
to_transport = transport.get_transport(to_location)
714
to_transport.mkdir('.')
715
except errors.FileExists:
716
raise errors.BzrCommandError('Target directory "%s" already'
717
' exists.' % to_location)
718
except errors.NoSuchFile:
719
raise errors.BzrCommandError('Parent of "%s" does not exist.'
722
# preserve whatever source format we have.
723
dir = br_from.bzrdir.sprout(to_transport.base,
724
revision_id, basis_dir)
725
branch = dir.open_branch()
726
except errors.NoSuchRevision:
727
to_transport.delete_tree('.')
728
msg = "The branch %s has no revision %s." % (from_location, revision[0])
729
raise errors.BzrCommandError(msg)
730
except errors.UnlistableBranch:
731
osutils.rmtree(to_location)
732
msg = "The branch %s cannot be used as a --basis" % (basis,)
733
raise errors.BzrCommandError(msg)
735
branch.control_files.put_utf8('branch-name', name)
736
note('Branched %d revision(s).' % branch.revno())
741
class cmd_checkout(Command):
742
"""Create a new checkout of an existing branch.
744
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
745
the branch found in '.'. This is useful if you have removed the working tree
746
or if it was never created - i.e. if you pushed the branch to its current
749
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
750
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
752
To retrieve the branch as of a particular revision, supply the --revision
753
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
754
out of date [so you cannot commit] but it may be useful (i.e. to examine old
757
--basis is to speed up checking out from remote branches. When specified, it
758
uses the inventory and file contents from the basis branch in preference to the
759
branch being checked out.
761
takes_args = ['branch_location?', 'to_location?']
762
takes_options = ['revision', # , 'basis']
763
Option('lightweight',
764
help="perform a lightweight checkout. Lightweight "
765
"checkouts depend on access to the branch for "
766
"every operation. Normal checkouts can perform "
767
"common operations like diff and status without "
768
"such access, and also support local commits."
773
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
777
elif len(revision) > 1:
778
raise errors.BzrCommandError(
779
'bzr checkout --revision takes exactly 1 revision value')
780
if branch_location is None:
781
branch_location = osutils.getcwd()
782
to_location = branch_location
783
source = Branch.open(branch_location)
784
if len(revision) == 1 and revision[0] is not None:
785
revision_id = revision[0].in_history(source)[1]
788
if to_location is None:
789
to_location = os.path.basename(branch_location.rstrip("/\\"))
790
# if the source and to_location are the same,
791
# and there is no working tree,
792
# then reconstitute a branch
793
if (osutils.abspath(to_location) ==
794
osutils.abspath(branch_location)):
796
source.bzrdir.open_workingtree()
797
except errors.NoWorkingTree:
798
source.bzrdir.create_workingtree()
801
os.mkdir(to_location)
803
if e.errno == errno.EEXIST:
804
raise errors.BzrCommandError('Target directory "%s" already'
805
' exists.' % to_location)
806
if e.errno == errno.ENOENT:
807
raise errors.BzrCommandError('Parent of "%s" does not exist.'
811
old_format = bzrdir.BzrDirFormat.get_default_format()
812
bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
814
source.create_checkout(to_location, revision_id, lightweight)
816
bzrdir.BzrDirFormat.set_default_format(old_format)
819
class cmd_renames(Command):
820
"""Show list of renamed files.
822
# TODO: Option to show renames between two historical versions.
824
# TODO: Only show renames under dir, rather than in the whole branch.
825
takes_args = ['dir?']
828
def run(self, dir=u'.'):
829
tree = WorkingTree.open_containing(dir)[0]
830
old_inv = tree.basis_tree().inventory
831
new_inv = tree.read_working_inventory()
832
renames = list(_mod_tree.find_renames(old_inv, new_inv))
834
for old_name, new_name in renames:
835
self.outf.write("%s => %s\n" % (old_name, new_name))
838
class cmd_update(Command):
839
"""Update a tree to have the latest code committed to its branch.
841
This will perform a merge into the working tree, and may generate
842
conflicts. If you have any local changes, you will still
843
need to commit them after the update for the update to be complete.
845
If you want to discard your local changes, you can just do a
846
'bzr revert' instead of 'bzr commit' after the update.
848
takes_args = ['dir?']
851
def run(self, dir='.'):
852
tree = WorkingTree.open_containing(dir)[0]
853
master = tree.branch.get_master_branch()
854
if master is not None:
857
tree.lock_tree_write()
859
existing_pending_merges = tree.get_parent_ids()[1:]
860
last_rev = tree.last_revision()
861
if last_rev == tree.branch.last_revision():
862
# may be up to date, check master too.
863
master = tree.branch.get_master_branch()
864
if master is None or last_rev == master.last_revision():
865
revno = tree.branch.revision_id_to_revno(last_rev)
866
note("Tree is up to date at revision %d." % (revno,))
868
conflicts = tree.update()
869
revno = tree.branch.revision_id_to_revno(tree.last_revision())
870
note('Updated to revision %d.' % (revno,))
871
if tree.get_parent_ids()[1:] != existing_pending_merges:
872
note('Your local commits will now show as pending merges with '
873
"'bzr status', and can be committed with 'bzr commit'.")
882
class cmd_info(Command):
883
"""Show information about a working tree, branch or repository.
885
This command will show all known locations and formats associated to the
886
tree, branch or repository. Statistical information is included with
889
Branches and working trees will also report any missing revisions.
891
takes_args = ['location?']
892
takes_options = ['verbose']
895
def run(self, location=None, verbose=False):
896
from bzrlib.info import show_bzrdir_info
897
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
901
class cmd_remove(Command):
902
"""Make a file unversioned.
904
This makes bzr stop tracking changes to a versioned file. It does
905
not delete the working copy.
907
You can specify one or more files, and/or --new. If you specify --new,
908
only 'added' files will be removed. If you specify both, then new files
909
in the specified directories will be removed. If the directories are
910
also new, they will also be removed.
912
takes_args = ['file*']
913
takes_options = ['verbose', Option('new', help='remove newly-added files')]
915
encoding_type = 'replace'
917
def run(self, file_list, verbose=False, new=False):
918
tree, file_list = tree_files(file_list)
920
if file_list is None:
921
raise errors.BzrCommandError('Specify one or more files to'
922
' remove, or use --new.')
924
added = tree.changes_from(tree.basis_tree(),
925
specific_files=file_list).added
926
file_list = sorted([f[0] for f in added], reverse=True)
927
if len(file_list) == 0:
928
raise errors.BzrCommandError('No matching files.')
929
tree.remove(file_list, verbose=verbose, to_file=self.outf)
932
class cmd_file_id(Command):
933
"""Print file_id of a particular file or directory.
935
The file_id is assigned when the file is first added and remains the
936
same through all revisions where the file exists, even when it is
941
takes_args = ['filename']
944
def run(self, filename):
945
tree, relpath = WorkingTree.open_containing(filename)
946
i = tree.inventory.path2id(relpath)
948
raise errors.BzrError("%r is not a versioned file" % filename)
950
self.outf.write(i + '\n')
953
class cmd_file_path(Command):
954
"""Print path of file_ids to a file or directory.
956
This prints one line for each directory down to the target,
957
starting at the branch root.
961
takes_args = ['filename']
964
def run(self, filename):
965
tree, relpath = WorkingTree.open_containing(filename)
967
fid = inv.path2id(relpath)
969
raise errors.BzrError("%r is not a versioned file" % filename)
970
for fip in inv.get_idpath(fid):
971
self.outf.write(fip + '\n')
974
class cmd_reconcile(Command):
975
"""Reconcile bzr metadata in a branch.
977
This can correct data mismatches that may have been caused by
978
previous ghost operations or bzr upgrades. You should only
979
need to run this command if 'bzr check' or a bzr developer
980
advises you to run it.
982
If a second branch is provided, cross-branch reconciliation is
983
also attempted, which will check that data like the tree root
984
id which was not present in very early bzr versions is represented
985
correctly in both branches.
987
At the same time it is run it may recompress data resulting in
988
a potential saving in disk space or performance gain.
990
The branch *MUST* be on a listable system such as local disk or sftp.
992
takes_args = ['branch?']
994
def run(self, branch="."):
995
from bzrlib.reconcile import reconcile
996
dir = bzrdir.BzrDir.open(branch)
1000
class cmd_revision_history(Command):
1001
"""Display the list of revision ids on a branch."""
1002
takes_args = ['location?']
1007
def run(self, location="."):
1008
branch = Branch.open_containing(location)[0]
1009
for revid in branch.revision_history():
1010
self.outf.write(revid)
1011
self.outf.write('\n')
1014
class cmd_ancestry(Command):
1015
"""List all revisions merged into this branch."""
1016
takes_args = ['location?']
1021
def run(self, location="."):
1023
wt = WorkingTree.open_containing(location)[0]
1024
except errors.NoWorkingTree:
1025
b = Branch.open(location)
1026
last_revision = b.last_revision()
1029
last_revision = wt.last_revision()
1031
revision_ids = b.repository.get_ancestry(last_revision)
1032
assert revision_ids[0] is None
1034
for revision_id in revision_ids:
1035
self.outf.write(revision_id + '\n')
1038
class cmd_init(Command):
1039
"""Make a directory into a versioned branch.
1041
Use this to create an empty branch, or before importing an
1044
If there is a repository in a parent directory of the location, then
1045
the history of the branch will be stored in the repository. Otherwise
1046
init creates a standalone branch which carries its own history in
1049
If there is already a branch at the location but it has no working tree,
1050
the tree can be populated with 'bzr checkout'.
1052
Recipe for importing a tree of files:
1057
bzr commit -m 'imported project'
1059
takes_args = ['location?']
1062
help='Specify a format for this branch. Current'
1063
' formats are: default, knit, metaweave and'
1064
' weave. Default is knit; metaweave and'
1065
' weave are deprecated',
1066
type=get_format_type),
1068
def run(self, location=None, format=None):
1070
format = get_format_type('default')
1071
if location is None:
1074
to_transport = transport.get_transport(location)
1076
# The path has to exist to initialize a
1077
# branch inside of it.
1078
# Just using os.mkdir, since I don't
1079
# believe that we want to create a bunch of
1080
# locations if the user supplies an extended path
1081
# TODO: create-prefix
1083
to_transport.mkdir('.')
1084
except errors.FileExists:
1088
existing_bzrdir = bzrdir.BzrDir.open(location)
1089
except errors.NotBranchError:
1090
# really a NotBzrDir error...
1091
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1093
from bzrlib.transport.local import LocalTransport
1094
if existing_bzrdir.has_branch():
1095
if (isinstance(to_transport, LocalTransport)
1096
and not existing_bzrdir.has_workingtree()):
1097
raise errors.BranchExistsWithoutWorkingTree(location)
1098
raise errors.AlreadyBranchError(location)
1100
existing_bzrdir.create_branch()
1101
existing_bzrdir.create_workingtree()
1104
class cmd_init_repository(Command):
1105
"""Create a shared repository to hold branches.
1107
New branches created under the repository directory will store their revisions
1108
in the repository, not in the branch directory, if the branch format supports
1114
bzr checkout --lightweight repo/trunk trunk-checkout
1118
takes_args = ["location"]
1119
takes_options = [Option('format',
1120
help='Specify a format for this repository.'
1121
' Current formats are: default, knit,'
1122
' metaweave and weave. Default is knit;'
1123
' metaweave and weave are deprecated',
1124
type=get_format_type),
1126
help='Allows branches in repository to have'
1128
aliases = ["init-repo"]
1129
def run(self, location, format=None, trees=False):
1131
format = get_format_type('default')
1133
if location is None:
1136
to_transport = transport.get_transport(location)
1138
to_transport.mkdir('.')
1139
except errors.FileExists:
1142
newdir = format.initialize_on_transport(to_transport)
1143
repo = newdir.create_repository(shared=True)
1144
repo.set_make_working_trees(trees)
1147
class cmd_diff(Command):
1148
"""Show differences in the working tree or between revisions.
1150
If files are listed, only the changes in those files are listed.
1151
Otherwise, all changes for the tree are listed.
1153
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1154
produces patches suitable for "patch -p1".
1158
Shows the difference in the working tree versus the last commit
1160
Difference between the working tree and revision 1
1162
Difference between revision 2 and revision 1
1163
bzr diff --diff-prefix old/:new/
1164
Same as 'bzr diff' but prefix paths with old/ and new/
1165
bzr diff bzr.mine bzr.dev
1166
Show the differences between the two working trees
1168
Show just the differences for 'foo.c'
1170
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1171
# or a graphical diff.
1173
# TODO: Python difflib is not exactly the same as unidiff; should
1174
# either fix it up or prefer to use an external diff.
1176
# TODO: Selected-file diff is inefficient and doesn't show you
1179
# TODO: This probably handles non-Unix newlines poorly.
1181
takes_args = ['file*']
1182
takes_options = ['revision', 'diff-options', 'prefix']
1183
aliases = ['di', 'dif']
1184
encoding_type = 'exact'
1187
def run(self, revision=None, file_list=None, diff_options=None,
1189
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1191
if (prefix is None) or (prefix == '0'):
1199
if not ':' in prefix:
1200
raise errors.BzrError("--diff-prefix expects two values"
1201
" separated by a colon")
1202
old_label, new_label = prefix.split(":")
1205
tree1, file_list = internal_tree_files(file_list)
1209
except errors.FileInWrongBranch:
1210
if len(file_list) != 2:
1211
raise errors.BzrCommandError("Files are in different branches")
1213
tree1, file1 = WorkingTree.open_containing(file_list[0])
1214
tree2, file2 = WorkingTree.open_containing(file_list[1])
1215
if file1 != "" or file2 != "":
1216
# FIXME diff those two files. rbc 20051123
1217
raise errors.BzrCommandError("Files are in different branches")
1219
except errors.NotBranchError:
1220
if (revision is not None and len(revision) == 2
1221
and not revision[0].needs_branch()
1222
and not revision[1].needs_branch()):
1223
# If both revision specs include a branch, we can
1224
# diff them without needing a local working tree
1225
tree1, tree2 = None, None
1228
if revision is not None:
1229
if tree2 is not None:
1230
raise errors.BzrCommandError("Can't specify -r with two branches")
1231
if (len(revision) == 1) or (revision[1].spec is None):
1232
return diff_cmd_helper(tree1, file_list, diff_options,
1234
old_label=old_label, new_label=new_label)
1235
elif len(revision) == 2:
1236
return diff_cmd_helper(tree1, file_list, diff_options,
1237
revision[0], revision[1],
1238
old_label=old_label, new_label=new_label)
1240
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1241
' one or two revision identifiers')
1243
if tree2 is not None:
1244
return show_diff_trees(tree1, tree2, sys.stdout,
1245
specific_files=file_list,
1246
external_diff_options=diff_options,
1247
old_label=old_label, new_label=new_label)
1249
return diff_cmd_helper(tree1, file_list, diff_options,
1250
old_label=old_label, new_label=new_label)
1253
class cmd_deleted(Command):
1254
"""List files deleted in the working tree.
1256
# TODO: Show files deleted since a previous revision, or
1257
# between two revisions.
1258
# TODO: Much more efficient way to do this: read in new
1259
# directories with readdir, rather than stating each one. Same
1260
# level of effort but possibly much less IO. (Or possibly not,
1261
# if the directories are very large...)
1262
takes_options = ['show-ids']
1265
def run(self, show_ids=False):
1266
tree = WorkingTree.open_containing(u'.')[0]
1267
old = tree.basis_tree()
1268
for path, ie in old.inventory.iter_entries():
1269
if not tree.has_id(ie.file_id):
1270
self.outf.write(path)
1272
self.outf.write(' ')
1273
self.outf.write(ie.file_id)
1274
self.outf.write('\n')
1277
class cmd_modified(Command):
1278
"""List files modified in working tree."""
1282
tree = WorkingTree.open_containing(u'.')[0]
1283
td = tree.changes_from(tree.basis_tree())
1284
for path, id, kind, text_modified, meta_modified in td.modified:
1285
self.outf.write(path + '\n')
1288
class cmd_added(Command):
1289
"""List files added in working tree."""
1293
wt = WorkingTree.open_containing(u'.')[0]
1294
basis_inv = wt.basis_tree().inventory
1297
if file_id in basis_inv:
1299
if inv.is_root(file_id) and len(basis_inv) == 0:
1301
path = inv.id2path(file_id)
1302
if not os.access(osutils.abspath(path), os.F_OK):
1304
self.outf.write(path + '\n')
1307
class cmd_root(Command):
1308
"""Show the tree root directory.
1310
The root is the nearest enclosing directory with a .bzr control
1312
takes_args = ['filename?']
1314
def run(self, filename=None):
1315
"""Print the branch root."""
1316
tree = WorkingTree.open_containing(filename)[0]
1317
self.outf.write(tree.basedir + '\n')
1320
class cmd_log(Command):
1321
"""Show log of a branch, file, or directory.
1323
By default show the log of the branch containing the working directory.
1325
To request a range of logs, you can use the command -r begin..end
1326
-r revision requests a specific revision, -r ..end or -r begin.. are
1332
bzr log -r -10.. http://server/branch
1335
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1337
takes_args = ['location?']
1338
takes_options = [Option('forward',
1339
help='show from oldest to newest'),
1342
help='show files changed in each revision'),
1343
'show-ids', 'revision',
1347
help='show revisions whose message matches this regexp',
1351
encoding_type = 'replace'
1354
def run(self, location=None, timezone='original',
1364
from bzrlib.log import log_formatter, show_log
1365
assert message is None or isinstance(message, basestring), \
1366
"invalid message argument %r" % message
1367
direction = (forward and 'forward') or 'reverse'
1372
# find the file id to log:
1374
dir, fp = bzrdir.BzrDir.open_containing(location)
1375
b = dir.open_branch()
1379
inv = dir.open_workingtree().inventory
1380
except (errors.NotBranchError, errors.NotLocalUrl):
1381
# either no tree, or is remote.
1382
inv = b.basis_tree().inventory
1383
file_id = inv.path2id(fp)
1386
# FIXME ? log the current subdir only RBC 20060203
1387
if revision is not None \
1388
and len(revision) > 0 and revision[0].get_branch():
1389
location = revision[0].get_branch()
1392
dir, relpath = bzrdir.BzrDir.open_containing(location)
1393
b = dir.open_branch()
1395
if revision is None:
1398
elif len(revision) == 1:
1399
rev1 = rev2 = revision[0].in_history(b).revno
1400
elif len(revision) == 2:
1401
if revision[1].get_branch() != revision[0].get_branch():
1402
# b is taken from revision[0].get_branch(), and
1403
# show_log will use its revision_history. Having
1404
# different branches will lead to weird behaviors.
1405
raise errors.BzrCommandError(
1406
"Log doesn't accept two revisions in different branches.")
1407
if revision[0].spec is None:
1408
# missing begin-range means first revision
1411
rev1 = revision[0].in_history(b).revno
1413
if revision[1].spec is None:
1414
# missing end-range means last known revision
1417
rev2 = revision[1].in_history(b).revno
1419
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1421
# By this point, the revision numbers are converted to the +ve
1422
# form if they were supplied in the -ve form, so we can do
1423
# this comparison in relative safety
1425
(rev2, rev1) = (rev1, rev2)
1427
if (log_format is None):
1428
default = b.get_config().log_format()
1429
log_format = get_log_format(long=long, short=short, line=line,
1431
lf = log_formatter(log_format,
1434
show_timezone=timezone)
1440
direction=direction,
1441
start_revision=rev1,
1446
def get_log_format(long=False, short=False, line=False, default='long'):
1447
log_format = default
1451
log_format = 'short'
1457
class cmd_touching_revisions(Command):
1458
"""Return revision-ids which affected a particular file.
1460
A more user-friendly interface is "bzr log FILE".
1464
takes_args = ["filename"]
1467
def run(self, filename):
1468
tree, relpath = WorkingTree.open_containing(filename)
1470
inv = tree.read_working_inventory()
1471
file_id = inv.path2id(relpath)
1472
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1473
self.outf.write("%6d %s\n" % (revno, what))
1476
class cmd_ls(Command):
1477
"""List files in a tree.
1479
# TODO: Take a revision or remote path and list that tree instead.
1481
takes_options = ['verbose', 'revision',
1482
Option('non-recursive',
1483
help='don\'t recurse into sub-directories'),
1485
help='Print all paths from the root of the branch.'),
1486
Option('unknown', help='Print unknown files'),
1487
Option('versioned', help='Print versioned files'),
1488
Option('ignored', help='Print ignored files'),
1490
Option('null', help='Null separate the files'),
1493
def run(self, revision=None, verbose=False,
1494
non_recursive=False, from_root=False,
1495
unknown=False, versioned=False, ignored=False,
1498
if verbose and null:
1499
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1500
all = not (unknown or versioned or ignored)
1502
selection = {'I':ignored, '?':unknown, 'V':versioned}
1504
tree, relpath = WorkingTree.open_containing(u'.')
1509
if revision is not None:
1510
tree = tree.branch.repository.revision_tree(
1511
revision[0].in_history(tree.branch).rev_id)
1513
for fp, fc, kind, fid, entry in tree.list_files(include_root=False):
1514
if fp.startswith(relpath):
1515
fp = fp[len(relpath):]
1516
if non_recursive and '/' in fp:
1518
if not all and not selection[fc]:
1521
kindch = entry.kind_character()
1522
self.outf.write('%-8s %s%s\n' % (fc, fp, kindch))
1524
self.outf.write(fp + '\0')
1527
self.outf.write(fp + '\n')
1530
class cmd_unknowns(Command):
1531
"""List unknown files."""
1534
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1535
self.outf.write(osutils.quotefn(f) + '\n')
1538
class cmd_ignore(Command):
1539
"""Ignore a command or pattern.
1541
To remove patterns from the ignore list, edit the .bzrignore file.
1543
If the pattern contains a slash, it is compared to the whole path
1544
from the branch root. Otherwise, it is compared to only the last
1545
component of the path. To match a file only in the root directory,
1548
Ignore patterns are case-insensitive on case-insensitive systems.
1550
Note: wildcards must be quoted from the shell on Unix.
1553
bzr ignore ./Makefile
1554
bzr ignore '*.class'
1556
# TODO: Complain if the filename is absolute
1557
takes_args = ['name_pattern?']
1559
Option('old-default-rules',
1560
help='Out the ignore rules bzr < 0.9 always used.')
1563
def run(self, name_pattern=None, old_default_rules=None):
1564
from bzrlib.atomicfile import AtomicFile
1565
if old_default_rules is not None:
1566
# dump the rules and exit
1567
for pattern in ignores.OLD_DEFAULTS:
1570
if name_pattern is None:
1571
raise errors.BzrCommandError("ignore requires a NAME_PATTERN")
1572
tree, relpath = WorkingTree.open_containing(u'.')
1573
ifn = tree.abspath('.bzrignore')
1574
if os.path.exists(ifn):
1577
igns = f.read().decode('utf-8')
1583
# TODO: If the file already uses crlf-style termination, maybe
1584
# we should use that for the newly added lines?
1586
if igns and igns[-1] != '\n':
1588
igns += name_pattern + '\n'
1590
f = AtomicFile(ifn, 'wt')
1592
f.write(igns.encode('utf-8'))
1597
inv = tree.inventory
1598
if inv.path2id('.bzrignore'):
1599
mutter('.bzrignore is already versioned')
1601
mutter('need to make new .bzrignore file versioned')
1602
tree.add(['.bzrignore'])
1605
class cmd_ignored(Command):
1606
"""List ignored files and the patterns that matched them.
1608
See also: bzr ignore"""
1611
tree = WorkingTree.open_containing(u'.')[0]
1612
for path, file_class, kind, file_id, entry in tree.list_files():
1613
if file_class != 'I':
1615
## XXX: Slightly inefficient since this was already calculated
1616
pat = tree.is_ignored(path)
1617
print '%-50s %s' % (path, pat)
1620
class cmd_lookup_revision(Command):
1621
"""Lookup the revision-id from a revision-number
1624
bzr lookup-revision 33
1627
takes_args = ['revno']
1630
def run(self, revno):
1634
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1636
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1639
class cmd_export(Command):
1640
"""Export past revision to destination directory.
1642
If no revision is specified this exports the last committed revision.
1644
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1645
given, try to find the format with the extension. If no extension
1646
is found exports to a directory (equivalent to --format=dir).
1648
Root may be the top directory for tar, tgz and tbz2 formats. If none
1649
is given, the top directory will be the root name of the file.
1651
Note: export of tree with non-ascii filenames to zip is not supported.
1653
Supported formats Autodetected by extension
1654
----------------- -------------------------
1657
tbz2 .tar.bz2, .tbz2
1661
takes_args = ['dest']
1662
takes_options = ['revision', 'format', 'root']
1663
def run(self, dest, revision=None, format=None, root=None):
1664
from bzrlib.export import export
1665
tree = WorkingTree.open_containing(u'.')[0]
1667
if revision is None:
1668
# should be tree.last_revision FIXME
1669
rev_id = b.last_revision()
1671
if len(revision) != 1:
1672
raise errors.BzrError('bzr export --revision takes exactly'
1674
rev_id = revision[0].in_history(b).rev_id
1675
t = b.repository.revision_tree(rev_id)
1677
export(t, dest, format, root)
1678
except errors.NoSuchExportFormat, e:
1679
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1682
class cmd_cat(Command):
1683
"""Write a file's text from a previous revision."""
1685
takes_options = ['revision']
1686
takes_args = ['filename']
1689
def run(self, filename, revision=None):
1690
if revision is not None and len(revision) != 1:
1691
raise errors.BzrCommandError("bzr cat --revision takes exactly one number")
1694
tree, relpath = WorkingTree.open_containing(filename)
1696
except errors.NotBranchError:
1700
b, relpath = Branch.open_containing(filename)
1701
if revision is not None and revision[0].get_branch() is not None:
1702
b = Branch.open(revision[0].get_branch())
1703
if revision is None:
1704
revision_id = b.last_revision()
1706
revision_id = revision[0].in_history(b).rev_id
1707
b.print_file(relpath, revision_id)
1710
class cmd_local_time_offset(Command):
1711
"""Show the offset in seconds from GMT to local time."""
1715
print osutils.local_time_offset()
1719
class cmd_commit(Command):
1720
"""Commit changes into a new revision.
1722
If no arguments are given, the entire tree is committed.
1724
If selected files are specified, only changes to those files are
1725
committed. If a directory is specified then the directory and everything
1726
within it is committed.
1728
A selected-file commit may fail in some cases where the committed
1729
tree would be invalid, such as trying to commit a file in a
1730
newly-added directory that is not itself committed.
1732
# TODO: Run hooks on tree to-be-committed, and after commit.
1734
# TODO: Strict commit that fails if there are deleted files.
1735
# (what does "deleted files" mean ??)
1737
# TODO: Give better message for -s, --summary, used by tla people
1739
# XXX: verbose currently does nothing
1741
takes_args = ['selected*']
1742
takes_options = ['message', 'verbose',
1744
help='commit even if nothing has changed'),
1745
Option('file', type=str,
1747
help='file containing commit message'),
1749
help="refuse to commit if there are unknown "
1750
"files in the working tree."),
1752
help="perform a local only commit in a bound "
1753
"branch. Such commits are not pushed to "
1754
"the master branch until a normal commit "
1758
aliases = ['ci', 'checkin']
1760
def run(self, message=None, file=None, verbose=True, selected_list=None,
1761
unchanged=False, strict=False, local=False):
1762
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1763
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1765
from bzrlib.msgeditor import edit_commit_message, \
1766
make_commit_message_template
1767
from tempfile import TemporaryFile
1769
# TODO: Need a blackbox test for invoking the external editor; may be
1770
# slightly problematic to run this cross-platform.
1772
# TODO: do more checks that the commit will succeed before
1773
# spending the user's valuable time typing a commit message.
1775
# TODO: if the commit *does* happen to fail, then save the commit
1776
# message to a temporary file where it can be recovered
1777
tree, selected_list = tree_files(selected_list)
1778
if selected_list == ['']:
1779
# workaround - commit of root of tree should be exactly the same
1780
# as just default commit in that tree, and succeed even though
1781
# selected-file merge commit is not done yet
1784
if local and not tree.branch.get_bound_location():
1785
raise errors.LocalRequiresBoundBranch()
1786
if message is None and not file:
1787
template = make_commit_message_template(tree, selected_list)
1788
message = edit_commit_message(template)
1790
raise errors.BzrCommandError("please specify a commit message"
1791
" with either --message or --file")
1792
elif message and file:
1793
raise errors.BzrCommandError("please specify either --message or --file")
1796
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1799
raise errors.BzrCommandError("empty commit message specified")
1802
reporter = ReportCommitToLog()
1804
reporter = NullCommitReporter()
1807
tree.commit(message, specific_files=selected_list,
1808
allow_pointless=unchanged, strict=strict, local=local,
1810
except PointlessCommit:
1811
# FIXME: This should really happen before the file is read in;
1812
# perhaps prepare the commit; get the message; then actually commit
1813
raise errors.BzrCommandError("no changes to commit."
1814
" use --unchanged to commit anyhow")
1815
except ConflictsInTree:
1816
raise errors.BzrCommandError("Conflicts detected in working tree. "
1817
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1818
except StrictCommitFailed:
1819
raise errors.BzrCommandError("Commit refused because there are unknown "
1820
"files in the working tree.")
1821
except errors.BoundBranchOutOfDate, e:
1822
raise errors.BzrCommandError(str(e) + "\n"
1823
'To commit to master branch, run update and then commit.\n'
1824
'You can also pass --local to commit to continue working '
1827
class cmd_check(Command):
1828
"""Validate consistency of branch history.
1830
This command checks various invariants about the branch storage to
1831
detect data corruption or bzr bugs.
1833
takes_args = ['branch?']
1834
takes_options = ['verbose']
1836
def run(self, branch=None, verbose=False):
1837
from bzrlib.check import check
1839
tree = WorkingTree.open_containing()[0]
1840
branch = tree.branch
1842
branch = Branch.open(branch)
1843
check(branch, verbose)
1846
class cmd_scan_cache(Command):
1849
from bzrlib.hashcache import HashCache
1855
print '%6d stats' % c.stat_count
1856
print '%6d in hashcache' % len(c._cache)
1857
print '%6d files removed from cache' % c.removed_count
1858
print '%6d hashes updated' % c.update_count
1859
print '%6d files changed too recently to cache' % c.danger_count
1865
class cmd_upgrade(Command):
1866
"""Upgrade branch storage to current format.
1868
The check command or bzr developers may sometimes advise you to run
1869
this command. When the default format has changed you may also be warned
1870
during other operations to upgrade.
1872
takes_args = ['url?']
1875
help='Upgrade to a specific format. Current formats'
1876
' are: default, knit, metaweave and weave.'
1877
' Default is knit; metaweave and weave are'
1879
type=get_format_type),
1883
def run(self, url='.', format=None):
1884
from bzrlib.upgrade import upgrade
1886
format = get_format_type('default')
1887
upgrade(url, format)
1890
class cmd_whoami(Command):
1891
"""Show or set bzr user id.
1895
bzr whoami 'Frank Chu <fchu@example.com>'
1897
takes_options = [ Option('email',
1898
help='display email address only'),
1900
help='set identity for the current branch instead of '
1903
takes_args = ['name?']
1904
encoding_type = 'replace'
1907
def run(self, email=False, branch=False, name=None):
1909
# use branch if we're inside one; otherwise global config
1911
c = Branch.open_containing('.')[0].get_config()
1912
except errors.NotBranchError:
1913
c = config.GlobalConfig()
1915
self.outf.write(c.user_email() + '\n')
1917
self.outf.write(c.username() + '\n')
1920
# display a warning if an email address isn't included in the given name.
1922
config.extract_email_address(name)
1923
except errors.NoEmailInUsername, e:
1924
warning('"%s" does not seem to contain an email address. '
1925
'This is allowed, but not recommended.', name)
1927
# use global config unless --branch given
1929
c = Branch.open_containing('.')[0].get_config()
1931
c = config.GlobalConfig()
1932
c.set_user_option('email', name)
1935
class cmd_nick(Command):
1936
"""Print or set the branch nickname.
1938
If unset, the tree root directory name is used as the nickname
1939
To print the current nickname, execute with no argument.
1941
takes_args = ['nickname?']
1942
def run(self, nickname=None):
1943
branch = Branch.open_containing(u'.')[0]
1944
if nickname is None:
1945
self.printme(branch)
1947
branch.nick = nickname
1950
def printme(self, branch):
1954
class cmd_selftest(Command):
1955
"""Run internal test suite.
1957
This creates temporary test directories in the working directory,
1958
but not existing data is affected. These directories are deleted
1959
if the tests pass, or left behind to help in debugging if they
1960
fail and --keep-output is specified.
1962
If arguments are given, they are regular expressions that say
1963
which tests should run.
1965
If the global option '--no-plugins' is given, plugins are not loaded
1966
before running the selftests. This has two effects: features provided or
1967
modified by plugins will not be tested, and tests provided by plugins will
1972
bzr --no-plugins selftest -v
1974
# TODO: --list should give a list of all available tests
1976
# NB: this is used from the class without creating an instance, which is
1977
# why it does not have a self parameter.
1978
def get_transport_type(typestring):
1979
"""Parse and return a transport specifier."""
1980
if typestring == "sftp":
1981
from bzrlib.transport.sftp import SFTPAbsoluteServer
1982
return SFTPAbsoluteServer
1983
if typestring == "memory":
1984
from bzrlib.transport.memory import MemoryServer
1986
if typestring == "fakenfs":
1987
from bzrlib.transport.fakenfs import FakeNFSServer
1988
return FakeNFSServer
1989
msg = "No known transport type %s. Supported types are: sftp\n" %\
1991
raise errors.BzrCommandError(msg)
1994
takes_args = ['testspecs*']
1995
takes_options = ['verbose',
1996
Option('one', help='stop when one test fails'),
1997
Option('keep-output',
1998
help='keep output directories when tests fail'),
2000
help='Use a different transport by default '
2001
'throughout the test suite.',
2002
type=get_transport_type),
2003
Option('benchmark', help='run the bzr bencharks.'),
2004
Option('lsprof-timed',
2005
help='generate lsprof output for benchmarked'
2006
' sections of code.'),
2007
Option('cache-dir', type=str,
2008
help='a directory to cache intermediate'
2009
' benchmark steps'),
2012
def run(self, testspecs_list=None, verbose=None, one=False,
2013
keep_output=False, transport=None, benchmark=None,
2014
lsprof_timed=None, cache_dir=None):
2016
from bzrlib.tests import selftest
2017
import bzrlib.benchmarks as benchmarks
2018
from bzrlib.benchmarks import tree_creator
2020
if cache_dir is not None:
2021
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2022
# we don't want progress meters from the tests to go to the
2023
# real output; and we don't want log messages cluttering up
2025
save_ui = ui.ui_factory
2026
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2027
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2029
info('running tests...')
2031
ui.ui_factory = ui.SilentUIFactory()
2032
if testspecs_list is not None:
2033
pattern = '|'.join(testspecs_list)
2037
test_suite_factory = benchmarks.test_suite
2040
# TODO: should possibly lock the history file...
2041
benchfile = open(".perf_history", "at")
2043
test_suite_factory = None
2048
result = selftest(verbose=verbose,
2050
stop_on_failure=one,
2051
keep_output=keep_output,
2052
transport=transport,
2053
test_suite_factory=test_suite_factory,
2054
lsprof_timed=lsprof_timed,
2055
bench_history=benchfile)
2057
if benchfile is not None:
2060
info('tests passed')
2062
info('tests failed')
2063
return int(not result)
2065
ui.ui_factory = save_ui
2068
class cmd_version(Command):
2069
"""Show version of bzr."""
2073
from bzrlib.version import show_version
2077
class cmd_rocks(Command):
2078
"""Statement of optimism."""
2084
print "it sure does!"
2087
class cmd_find_merge_base(Command):
2088
"""Find and print a base revision for merging two branches."""
2089
# TODO: Options to specify revisions on either side, as if
2090
# merging only part of the history.
2091
takes_args = ['branch', 'other']
2095
def run(self, branch, other):
2096
from bzrlib.revision import MultipleRevisionSources
2098
branch1 = Branch.open_containing(branch)[0]
2099
branch2 = Branch.open_containing(other)[0]
2101
history_1 = branch1.revision_history()
2102
history_2 = branch2.revision_history()
2104
last1 = branch1.last_revision()
2105
last2 = branch2.last_revision()
2107
source = MultipleRevisionSources(branch1.repository,
2110
base_rev_id = common_ancestor(last1, last2, source)
2112
print 'merge base is revision %s' % base_rev_id
2115
class cmd_merge(Command):
2116
"""Perform a three-way merge.
2118
The branch is the branch you will merge from. By default, it will merge
2119
the latest revision. If you specify a revision, that revision will be
2120
merged. If you specify two revisions, the first will be used as a BASE,
2121
and the second one as OTHER. Revision numbers are always relative to the
2124
By default, bzr will try to merge in all new work from the other
2125
branch, automatically determining an appropriate base. If this
2126
fails, you may need to give an explicit base.
2128
Merge will do its best to combine the changes in two branches, but there
2129
are some kinds of problems only a human can fix. When it encounters those,
2130
it will mark a conflict. A conflict means that you need to fix something,
2131
before you should commit.
2133
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2135
If there is no default branch set, the first merge will set it. After
2136
that, you can omit the branch to use the default. To change the
2137
default, use --remember. The value will only be saved if the remote
2138
location can be accessed.
2142
To merge the latest revision from bzr.dev
2143
bzr merge ../bzr.dev
2145
To merge changes up to and including revision 82 from bzr.dev
2146
bzr merge -r 82 ../bzr.dev
2148
To merge the changes introduced by 82, without previous changes:
2149
bzr merge -r 81..82 ../bzr.dev
2151
merge refuses to run if there are any uncommitted changes, unless
2154
The following merge types are available:
2156
takes_args = ['branch?']
2157
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2158
Option('show-base', help="Show base revision text in "
2160
Option('uncommitted', help='Apply uncommitted changes'
2161
' from a working copy, instead of branch changes')]
2164
from inspect import getdoc
2165
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2167
def run(self, branch=None, revision=None, force=False, merge_type=None,
2168
show_base=False, reprocess=False, remember=False,
2170
if merge_type is None:
2171
merge_type = _mod_merge.Merge3Merger
2173
tree = WorkingTree.open_containing(u'.')[0]
2175
if branch is not None:
2177
reader = bundle.read_bundle_from_url(branch)
2178
except errors.NotABundle:
2179
pass # Continue on considering this url a Branch
2181
conflicts = merge_bundle(reader, tree, not force, merge_type,
2182
reprocess, show_base)
2188
if revision is None \
2189
or len(revision) < 1 or revision[0].needs_branch():
2190
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2192
if revision is None or len(revision) < 1:
2195
other = [branch, None]
2198
other = [branch, -1]
2199
other_branch, path = Branch.open_containing(branch)
2202
raise errors.BzrCommandError('Cannot use --uncommitted and'
2203
' --revision at the same time.')
2204
branch = revision[0].get_branch() or branch
2205
if len(revision) == 1:
2207
other_branch, path = Branch.open_containing(branch)
2208
revno = revision[0].in_history(other_branch).revno
2209
other = [branch, revno]
2211
assert len(revision) == 2
2212
if None in revision:
2213
raise errors.BzrCommandError(
2214
"Merge doesn't permit empty revision specifier.")
2215
base_branch, path = Branch.open_containing(branch)
2216
branch1 = revision[1].get_branch() or branch
2217
other_branch, path1 = Branch.open_containing(branch1)
2218
if revision[0].get_branch() is not None:
2219
# then path was obtained from it, and is None.
2222
base = [branch, revision[0].in_history(base_branch).revno]
2223
other = [branch1, revision[1].in_history(other_branch).revno]
2225
if tree.branch.get_parent() is None or remember:
2226
tree.branch.set_parent(other_branch.base)
2229
interesting_files = [path]
2231
interesting_files = None
2232
pb = ui.ui_factory.nested_progress_bar()
2235
conflict_count = _merge_helper(
2236
other, base, check_clean=(not force),
2237
merge_type=merge_type,
2238
reprocess=reprocess,
2239
show_base=show_base,
2240
pb=pb, file_list=interesting_files)
2243
if conflict_count != 0:
2247
except errors.AmbiguousBase, e:
2248
m = ("sorry, bzr can't determine the right merge base yet\n"
2249
"candidates are:\n "
2250
+ "\n ".join(e.bases)
2252
"please specify an explicit base with -r,\n"
2253
"and (if you want) report this to the bzr developers\n")
2256
# TODO: move up to common parent; this isn't merge-specific anymore.
2257
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2258
"""Use tree.branch's parent if none was supplied.
2260
Report if the remembered location was used.
2262
if supplied_location is not None:
2263
return supplied_location
2264
stored_location = tree.branch.get_parent()
2265
mutter("%s", stored_location)
2266
if stored_location is None:
2267
raise errors.BzrCommandError("No location specified or remembered")
2268
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2269
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2270
return stored_location
2273
class cmd_remerge(Command):
2276
Use this if you want to try a different merge technique while resolving
2277
conflicts. Some merge techniques are better than others, and remerge
2278
lets you try different ones on different files.
2280
The options for remerge have the same meaning and defaults as the ones for
2281
merge. The difference is that remerge can (only) be run when there is a
2282
pending merge, and it lets you specify particular files.
2285
$ bzr remerge --show-base
2286
Re-do the merge of all conflicted files, and show the base text in
2287
conflict regions, in addition to the usual THIS and OTHER texts.
2289
$ bzr remerge --merge-type weave --reprocess foobar
2290
Re-do the merge of "foobar", using the weave merge algorithm, with
2291
additional processing to reduce the size of conflict regions.
2293
The following merge types are available:"""
2294
takes_args = ['file*']
2295
takes_options = ['merge-type', 'reprocess',
2296
Option('show-base', help="Show base revision text in "
2300
from inspect import getdoc
2301
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2303
def run(self, file_list=None, merge_type=None, show_base=False,
2305
if merge_type is None:
2306
merge_type = _mod_merge.Merge3Merger
2307
tree, file_list = tree_files(file_list)
2310
parents = tree.get_parent_ids()
2311
if len(parents) != 2:
2312
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2313
" merges. Not cherrypicking or"
2315
repository = tree.branch.repository
2316
base_revision = common_ancestor(parents[0],
2317
parents[1], repository)
2318
base_tree = repository.revision_tree(base_revision)
2319
other_tree = repository.revision_tree(parents[1])
2320
interesting_ids = None
2322
conflicts = tree.conflicts()
2323
if file_list is not None:
2324
interesting_ids = set()
2325
for filename in file_list:
2326
file_id = tree.path2id(filename)
2328
raise errors.NotVersionedError(filename)
2329
interesting_ids.add(file_id)
2330
if tree.kind(file_id) != "directory":
2333
for name, ie in tree.inventory.iter_entries(file_id):
2334
interesting_ids.add(ie.file_id)
2335
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2337
# Remerge only supports resolving contents conflicts
2338
allowed_conflicts = ('text conflict', 'contents conflict')
2339
restore_files = [c.path for c in conflicts
2340
if c.typestring in allowed_conflicts]
2341
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2342
tree.set_conflicts(ConflictList(new_conflicts))
2343
if file_list is not None:
2344
restore_files = file_list
2345
for filename in restore_files:
2347
restore(tree.abspath(filename))
2348
except errors.NotConflicted:
2350
conflicts = _mod_merge.merge_inner(
2351
tree.branch, other_tree, base_tree,
2353
interesting_ids=interesting_ids,
2354
other_rev_id=parents[1],
2355
merge_type=merge_type,
2356
show_base=show_base,
2357
reprocess=reprocess)
2365
class cmd_revert(Command):
2366
"""Revert files to a previous revision.
2368
Giving a list of files will revert only those files. Otherwise, all files
2369
will be reverted. If the revision is not specified with '--revision', the
2370
last committed revision is used.
2372
To remove only some changes, without reverting to a prior version, use
2373
merge instead. For example, "merge . --r-2..-3" will remove the changes
2374
introduced by -2, without affecting the changes introduced by -1. Or
2375
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2377
By default, any files that have been manually changed will be backed up
2378
first. (Files changed only by merge are not backed up.) Backup files have
2379
'.~#~' appended to their name, where # is a number.
2381
When you provide files, you can use their current pathname or the pathname
2382
from the target revision. So you can use revert to "undelete" a file by
2383
name. If you name a directory, all the contents of that directory will be
2386
takes_options = ['revision', 'no-backup']
2387
takes_args = ['file*']
2388
aliases = ['merge-revert']
2390
def run(self, revision=None, no_backup=False, file_list=None):
2391
if file_list is not None:
2392
if len(file_list) == 0:
2393
raise errors.BzrCommandError("No files specified")
2397
tree, file_list = tree_files(file_list)
2398
if revision is None:
2399
# FIXME should be tree.last_revision
2400
rev_id = tree.last_revision()
2401
elif len(revision) != 1:
2402
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2404
rev_id = revision[0].in_history(tree.branch).rev_id
2405
pb = ui.ui_factory.nested_progress_bar()
2407
tree.revert(file_list,
2408
tree.branch.repository.revision_tree(rev_id),
2414
class cmd_assert_fail(Command):
2415
"""Test reporting of assertion failures"""
2418
assert False, "always fails"
2421
class cmd_help(Command):
2422
"""Show help on a command or other topic.
2424
For a list of all available commands, say 'bzr help commands'."""
2425
takes_options = [Option('long', 'show help on all commands')]
2426
takes_args = ['topic?']
2427
aliases = ['?', '--help', '-?', '-h']
2430
def run(self, topic=None, long=False):
2432
if topic is None and long:
2437
class cmd_shell_complete(Command):
2438
"""Show appropriate completions for context.
2440
For a list of all available commands, say 'bzr shell-complete'."""
2441
takes_args = ['context?']
2446
def run(self, context=None):
2447
import shellcomplete
2448
shellcomplete.shellcomplete(context)
2451
class cmd_fetch(Command):
2452
"""Copy in history from another branch but don't merge it.
2454
This is an internal method used for pull and merge."""
2456
takes_args = ['from_branch', 'to_branch']
2457
def run(self, from_branch, to_branch):
2458
from bzrlib.fetch import Fetcher
2459
from_b = Branch.open(from_branch)
2460
to_b = Branch.open(to_branch)
2461
Fetcher(to_b, from_b)
2464
class cmd_missing(Command):
2465
"""Show unmerged/unpulled revisions between two branches.
2467
OTHER_BRANCH may be local or remote."""
2468
takes_args = ['other_branch?']
2469
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2471
'Display changes in the local branch only'),
2472
Option('theirs-only',
2473
'Display changes in the remote branch only'),
2481
encoding_type = 'replace'
2484
def run(self, other_branch=None, reverse=False, mine_only=False,
2485
theirs_only=False, log_format=None, long=False, short=False, line=False,
2486
show_ids=False, verbose=False):
2487
from bzrlib.missing import find_unmerged, iter_log_data
2488
from bzrlib.log import log_formatter
2489
local_branch = Branch.open_containing(u".")[0]
2490
parent = local_branch.get_parent()
2491
if other_branch is None:
2492
other_branch = parent
2493
if other_branch is None:
2494
raise errors.BzrCommandError("No peer location known or specified.")
2495
print "Using last location: " + local_branch.get_parent()
2496
remote_branch = Branch.open(other_branch)
2497
if remote_branch.base == local_branch.base:
2498
remote_branch = local_branch
2499
local_branch.lock_read()
2501
remote_branch.lock_read()
2503
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2504
if (log_format is None):
2505
default = local_branch.get_config().log_format()
2506
log_format = get_log_format(long=long, short=short,
2507
line=line, default=default)
2508
lf = log_formatter(log_format,
2511
show_timezone='original')
2512
if reverse is False:
2513
local_extra.reverse()
2514
remote_extra.reverse()
2515
if local_extra and not theirs_only:
2516
print "You have %d extra revision(s):" % len(local_extra)
2517
for data in iter_log_data(local_extra, local_branch.repository,
2520
printed_local = True
2522
printed_local = False
2523
if remote_extra and not mine_only:
2524
if printed_local is True:
2526
print "You are missing %d revision(s):" % len(remote_extra)
2527
for data in iter_log_data(remote_extra, remote_branch.repository,
2530
if not remote_extra and not local_extra:
2532
print "Branches are up to date."
2536
remote_branch.unlock()
2538
local_branch.unlock()
2539
if not status_code and parent is None and other_branch is not None:
2540
local_branch.lock_write()
2542
# handle race conditions - a parent might be set while we run.
2543
if local_branch.get_parent() is None:
2544
local_branch.set_parent(remote_branch.base)
2546
local_branch.unlock()
2550
class cmd_plugins(Command):
2555
import bzrlib.plugin
2556
from inspect import getdoc
2557
for name, plugin in bzrlib.plugin.all_plugins().items():
2558
if getattr(plugin, '__path__', None) is not None:
2559
print plugin.__path__[0]
2560
elif getattr(plugin, '__file__', None) is not None:
2561
print plugin.__file__
2567
print '\t', d.split('\n')[0]
2570
class cmd_testament(Command):
2571
"""Show testament (signing-form) of a revision."""
2572
takes_options = ['revision',
2573
Option('long', help='Produce long-format testament'),
2574
Option('strict', help='Produce a strict-format'
2576
takes_args = ['branch?']
2578
def run(self, branch=u'.', revision=None, long=False, strict=False):
2579
from bzrlib.testament import Testament, StrictTestament
2581
testament_class = StrictTestament
2583
testament_class = Testament
2584
b = WorkingTree.open_containing(branch)[0].branch
2587
if revision is None:
2588
rev_id = b.last_revision()
2590
rev_id = revision[0].in_history(b).rev_id
2591
t = testament_class.from_revision(b.repository, rev_id)
2593
sys.stdout.writelines(t.as_text_lines())
2595
sys.stdout.write(t.as_short_text())
2600
class cmd_annotate(Command):
2601
"""Show the origin of each line in a file.
2603
This prints out the given file with an annotation on the left side
2604
indicating which revision, author and date introduced the change.
2606
If the origin is the same for a run of consecutive lines, it is
2607
shown only at the top, unless the --all option is given.
2609
# TODO: annotate directories; showing when each file was last changed
2610
# TODO: if the working copy is modified, show annotations on that
2611
# with new uncommitted lines marked
2612
aliases = ['ann', 'blame', 'praise']
2613
takes_args = ['filename']
2614
takes_options = [Option('all', help='show annotations on all lines'),
2615
Option('long', help='show date in annotations'),
2620
def run(self, filename, all=False, long=False, revision=None):
2621
from bzrlib.annotate import annotate_file
2622
tree, relpath = WorkingTree.open_containing(filename)
2623
branch = tree.branch
2626
if revision is None:
2627
revision_id = branch.last_revision()
2628
elif len(revision) != 1:
2629
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2631
revision_id = revision[0].in_history(branch).rev_id
2632
file_id = tree.inventory.path2id(relpath)
2633
tree = branch.repository.revision_tree(revision_id)
2634
file_version = tree.inventory[file_id].revision
2635
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2640
class cmd_re_sign(Command):
2641
"""Create a digital signature for an existing revision."""
2642
# TODO be able to replace existing ones.
2644
hidden = True # is this right ?
2645
takes_args = ['revision_id*']
2646
takes_options = ['revision']
2648
def run(self, revision_id_list=None, revision=None):
2649
import bzrlib.gpg as gpg
2650
if revision_id_list is not None and revision is not None:
2651
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2652
if revision_id_list is None and revision is None:
2653
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2654
b = WorkingTree.open_containing(u'.')[0].branch
2655
gpg_strategy = gpg.GPGStrategy(b.get_config())
2656
if revision_id_list is not None:
2657
for revision_id in revision_id_list:
2658
b.repository.sign_revision(revision_id, gpg_strategy)
2659
elif revision is not None:
2660
if len(revision) == 1:
2661
revno, rev_id = revision[0].in_history(b)
2662
b.repository.sign_revision(rev_id, gpg_strategy)
2663
elif len(revision) == 2:
2664
# are they both on rh- if so we can walk between them
2665
# might be nice to have a range helper for arbitrary
2666
# revision paths. hmm.
2667
from_revno, from_revid = revision[0].in_history(b)
2668
to_revno, to_revid = revision[1].in_history(b)
2669
if to_revid is None:
2670
to_revno = b.revno()
2671
if from_revno is None or to_revno is None:
2672
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2673
for revno in range(from_revno, to_revno + 1):
2674
b.repository.sign_revision(b.get_rev_id(revno),
2677
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2680
class cmd_bind(Command):
2681
"""Bind the current branch to a master branch.
2683
After binding, commits must succeed on the master branch
2684
before they are executed on the local one.
2687
takes_args = ['location']
2690
def run(self, location=None):
2691
b, relpath = Branch.open_containing(u'.')
2692
b_other = Branch.open(location)
2695
except errors.DivergedBranches:
2696
raise errors.BzrCommandError('These branches have diverged.'
2697
' Try merging, and then bind again.')
2700
class cmd_unbind(Command):
2701
"""Unbind the current branch from its master branch.
2703
After unbinding, the local branch is considered independent.
2704
All subsequent commits will be local.
2711
b, relpath = Branch.open_containing(u'.')
2713
raise errors.BzrCommandError('Local branch is not bound')
2716
class cmd_uncommit(Command):
2717
"""Remove the last committed revision.
2719
--verbose will print out what is being removed.
2720
--dry-run will go through all the motions, but not actually
2723
In the future, uncommit will create a revision bundle, which can then
2727
# TODO: jam 20060108 Add an option to allow uncommit to remove
2728
# unreferenced information in 'branch-as-repository' branches.
2729
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2730
# information in shared branches as well.
2731
takes_options = ['verbose', 'revision',
2732
Option('dry-run', help='Don\'t actually make changes'),
2733
Option('force', help='Say yes to all questions.')]
2734
takes_args = ['location?']
2737
def run(self, location=None,
2738
dry_run=False, verbose=False,
2739
revision=None, force=False):
2740
from bzrlib.log import log_formatter, show_log
2742
from bzrlib.uncommit import uncommit
2744
if location is None:
2746
control, relpath = bzrdir.BzrDir.open_containing(location)
2748
tree = control.open_workingtree()
2750
except (errors.NoWorkingTree, errors.NotLocalUrl):
2752
b = control.open_branch()
2755
if revision is None:
2758
# 'bzr uncommit -r 10' actually means uncommit
2759
# so that the final tree is at revno 10.
2760
# but bzrlib.uncommit.uncommit() actually uncommits
2761
# the revisions that are supplied.
2762
# So we need to offset it by one
2763
revno = revision[0].in_history(b).revno+1
2765
if revno <= b.revno():
2766
rev_id = b.get_rev_id(revno)
2768
self.outf.write('No revisions to uncommit.\n')
2771
lf = log_formatter('short',
2773
show_timezone='original')
2778
direction='forward',
2779
start_revision=revno,
2780
end_revision=b.revno())
2783
print 'Dry-run, pretending to remove the above revisions.'
2785
val = raw_input('Press <enter> to continue')
2787
print 'The above revision(s) will be removed.'
2789
val = raw_input('Are you sure [y/N]? ')
2790
if val.lower() not in ('y', 'yes'):
2794
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2798
class cmd_break_lock(Command):
2799
"""Break a dead lock on a repository, branch or working directory.
2801
CAUTION: Locks should only be broken when you are sure that the process
2802
holding the lock has been stopped.
2804
You can get information on what locks are open via the 'bzr info' command.
2809
takes_args = ['location?']
2811
def run(self, location=None, show=False):
2812
if location is None:
2814
control, relpath = bzrdir.BzrDir.open_containing(location)
2816
control.break_lock()
2817
except NotImplementedError:
2821
class cmd_wait_until_signalled(Command):
2822
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
2824
This just prints a line to signal when it is ready, then blocks on stdin.
2830
sys.stdout.write("running\n")
2832
sys.stdin.readline()
2835
class cmd_serve(Command):
2836
"""Run the bzr server."""
2838
aliases = ['server']
2842
help='serve on stdin/out for use from inetd or sshd'),
2844
help='listen for connections on nominated port of the form '
2845
'[hostname:]portnumber. Passing 0 as the port number will '
2846
'result in a dynamically allocated port.',
2849
help='serve contents of directory',
2851
Option('allow-writes',
2852
help='By default the server is a readonly server. Supplying '
2853
'--allow-writes enables write access to the contents of '
2854
'the served directory and below. '
2858
def run(self, port=None, inet=False, directory=None, allow_writes=False):
2859
from bzrlib.transport import smart
2860
from bzrlib.transport import get_transport
2861
if directory is None:
2862
directory = os.getcwd()
2863
url = urlutils.local_path_to_url(directory)
2864
if not allow_writes:
2865
url = 'readonly+' + url
2866
t = get_transport(url)
2868
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
2869
elif port is not None:
2871
host, port = port.split(':')
2874
server = smart.SmartTCPServer(t, host=host, port=int(port))
2875
print 'listening on port: ', server.port
2878
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
2882
# command-line interpretation helper for merge-related commands
2883
def _merge_helper(other_revision, base_revision,
2884
check_clean=True, ignore_zero=False,
2885
this_dir=None, backup_files=False,
2887
file_list=None, show_base=False, reprocess=False,
2888
pb=DummyProgress()):
2889
"""Merge changes into a tree.
2892
list(path, revno) Base for three-way merge.
2893
If [None, None] then a base will be automatically determined.
2895
list(path, revno) Other revision for three-way merge.
2897
Directory to merge changes into; '.' by default.
2899
If true, this_dir must have no uncommitted changes before the
2901
ignore_zero - If true, suppress the "zero conflicts" message when
2902
there are no conflicts; should be set when doing something we expect
2903
to complete perfectly.
2904
file_list - If supplied, merge only changes to selected files.
2906
All available ancestors of other_revision and base_revision are
2907
automatically pulled into the branch.
2909
The revno may be -1 to indicate the last revision on the branch, which is
2912
This function is intended for use from the command line; programmatic
2913
clients might prefer to call merge.merge_inner(), which has less magic
2916
# Loading it late, so that we don't always have to import bzrlib.merge
2917
if merge_type is None:
2918
merge_type = _mod_merge.Merge3Merger
2919
if this_dir is None:
2921
this_tree = WorkingTree.open_containing(this_dir)[0]
2922
if show_base and not merge_type is _mod_merge.Merge3Merger:
2923
raise errors.BzrCommandError("Show-base is not supported for this merge"
2924
" type. %s" % merge_type)
2925
if reprocess and not merge_type.supports_reprocess:
2926
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
2927
" type %s." % merge_type)
2928
if reprocess and show_base:
2929
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
2931
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
2933
merger.pp = ProgressPhase("Merge phase", 5, pb)
2934
merger.pp.next_phase()
2935
merger.check_basis(check_clean)
2936
merger.set_other(other_revision)
2937
merger.pp.next_phase()
2938
merger.set_base(base_revision)
2939
if merger.base_rev_id == merger.other_rev_id:
2940
note('Nothing to do.')
2942
merger.backup_files = backup_files
2943
merger.merge_type = merge_type
2944
merger.set_interesting_files(file_list)
2945
merger.show_base = show_base
2946
merger.reprocess = reprocess
2947
conflicts = merger.do_merge()
2948
if file_list is None:
2949
merger.set_pending()
2956
merge = _merge_helper
2959
# these get imported and then picked up by the scan for cmd_*
2960
# TODO: Some more consistent way to split command definitions across files;
2961
# we do need to load at least some information about them to know of
2962
# aliases. ideally we would avoid loading the implementation until the
2963
# details were needed.
2964
from bzrlib.cmd_version_info import cmd_version_info
2965
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2966
from bzrlib.bundle.commands import cmd_bundle_revisions
2967
from bzrlib.sign_my_commits import cmd_sign_my_commits
2968
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
2969
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
