1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
45
from bzrlib.branch import Branch
46
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
47
from bzrlib.conflicts import ConflictList
48
from bzrlib.revision import common_ancestor
49
from bzrlib.revisionspec import RevisionSpec
50
from bzrlib.workingtree import WorkingTree
53
from bzrlib.commands import Command, display_command
54
from bzrlib.option import Option
55
from bzrlib.progress import DummyProgress, ProgressPhase
56
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
59
def tree_files(file_list, default_branch=u'.'):
61
return internal_tree_files(file_list, default_branch)
62
except errors.FileInWrongBranch, e:
63
raise errors.BzrCommandError("%s is not in the same branch as %s" %
64
(e.path, file_list[0]))
67
# XXX: Bad function name; should possibly also be a class method of
68
# WorkingTree rather than a function.
69
def internal_tree_files(file_list, default_branch=u'.'):
70
"""Convert command-line paths to a WorkingTree and relative paths.
72
This is typically used for command-line processors that take one or
73
more filenames, and infer the workingtree that contains them.
75
The filenames given are not required to exist.
77
:param file_list: Filenames to convert.
79
:param default_branch: Fallback tree path to use if file_list is empty or
82
:return: workingtree, [relative_paths]
84
if file_list is None or len(file_list) == 0:
85
return WorkingTree.open_containing(default_branch)[0], file_list
86
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
88
for filename in file_list:
90
new_list.append(tree.relpath(osutils.dereference_path(filename)))
91
except errors.PathNotChild:
92
raise errors.FileInWrongBranch(tree.branch, filename)
96
def get_format_type(typestring):
97
"""Parse and return a format specifier."""
98
if typestring == "weave":
99
return bzrdir.BzrDirFormat6()
100
if typestring == "default":
101
return bzrdir.BzrDirMetaFormat1()
102
if typestring == "metaweave":
103
format = bzrdir.BzrDirMetaFormat1()
104
format.repository_format = repository.RepositoryFormat7()
106
if typestring == "knit":
107
format = bzrdir.BzrDirMetaFormat1()
108
format.repository_format = repository.RepositoryFormatKnit1()
110
if typestring == "experimental-knit2":
111
format = bzrdir.BzrDirMetaFormat1()
112
format.repository_format = repository.RepositoryFormatKnit2()
114
msg = "Unknown bzr format %s. Current formats are: default, knit,\n" \
115
"metaweave and weave" % typestring
116
raise errors.BzrCommandError(msg)
119
# TODO: Make sure no commands unconditionally use the working directory as a
120
# branch. If a filename argument is used, the first of them should be used to
121
# specify the branch. (Perhaps this can be factored out into some kind of
122
# Argument class, representing a file in a branch, where the first occurrence
125
class cmd_status(Command):
126
"""Display status summary.
128
This reports on versioned and unknown files, reporting them
129
grouped by state. Possible states are:
132
Versioned in the working copy but not in the previous revision.
135
Versioned in the previous revision but removed or deleted
139
Path of this file changed from the previous revision;
140
the text may also have changed. This includes files whose
141
parent directory was renamed.
144
Text has changed since the previous revision.
147
Not versioned and not matching an ignore pattern.
149
To see ignored files use 'bzr ignored'. For details in the
150
changes to file texts, use 'bzr diff'.
152
If no arguments are specified, the status of the entire working
153
directory is shown. Otherwise, only the status of the specified
154
files or directories is reported. If a directory is given, status
155
is reported for everything inside that directory.
157
If a revision argument is given, the status is calculated against
158
that revision, or between two revisions if two are provided.
161
# TODO: --no-recurse, --recurse options
163
takes_args = ['file*']
164
takes_options = ['show-ids', 'revision']
165
aliases = ['st', 'stat']
167
encoding_type = 'replace'
170
def run(self, show_ids=False, file_list=None, revision=None):
171
from bzrlib.status import show_tree_status
173
tree, file_list = tree_files(file_list)
175
show_tree_status(tree, show_ids=show_ids,
176
specific_files=file_list, revision=revision,
180
class cmd_cat_revision(Command):
181
"""Write out metadata for a revision.
183
The revision to print can either be specified by a specific
184
revision identifier, or you can use --revision.
188
takes_args = ['revision_id?']
189
takes_options = ['revision']
190
# cat-revision is more for frontends so should be exact
194
def run(self, revision_id=None, revision=None):
196
if revision_id is not None and revision is not None:
197
raise errors.BzrCommandError('You can only supply one of'
198
' revision_id or --revision')
199
if revision_id is None and revision is None:
200
raise errors.BzrCommandError('You must supply either'
201
' --revision or a revision_id')
202
b = WorkingTree.open_containing(u'.')[0].branch
204
# TODO: jam 20060112 should cat-revision always output utf-8?
205
if revision_id is not None:
206
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
207
elif revision is not None:
210
raise errors.BzrCommandError('You cannot specify a NULL'
212
revno, rev_id = rev.in_history(b)
213
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
216
class cmd_revno(Command):
217
"""Show current revision number.
219
This is equal to the number of revisions on this branch.
222
takes_args = ['location?']
225
def run(self, location=u'.'):
226
self.outf.write(str(Branch.open_containing(location)[0].revno()))
227
self.outf.write('\n')
230
class cmd_revision_info(Command):
231
"""Show revision number and revision id for a given revision identifier.
234
takes_args = ['revision_info*']
235
takes_options = ['revision']
238
def run(self, revision=None, revision_info_list=[]):
241
if revision is not None:
242
revs.extend(revision)
243
if revision_info_list is not None:
244
for rev in revision_info_list:
245
revs.append(RevisionSpec.from_string(rev))
247
raise errors.BzrCommandError('You must supply a revision identifier')
249
b = WorkingTree.open_containing(u'.')[0].branch
252
revinfo = rev.in_history(b)
253
if revinfo.revno is None:
254
print ' %s' % revinfo.rev_id
256
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
259
class cmd_add(Command):
260
"""Add specified files or directories.
262
In non-recursive mode, all the named items are added, regardless
263
of whether they were previously ignored. A warning is given if
264
any of the named files are already versioned.
266
In recursive mode (the default), files are treated the same way
267
but the behaviour for directories is different. Directories that
268
are already versioned do not give a warning. All directories,
269
whether already versioned or not, are searched for files or
270
subdirectories that are neither versioned or ignored, and these
271
are added. This search proceeds recursively into versioned
272
directories. If no names are given '.' is assumed.
274
Therefore simply saying 'bzr add' will version all files that
275
are currently unknown.
277
Adding a file whose parent directory is not versioned will
278
implicitly add the parent, and so on up to the root. This means
279
you should never need to explicitly add a directory, they'll just
280
get added when you add a file in the directory.
282
--dry-run will show which files would be added, but not actually
285
--file-ids-from will try to use the file ids from the supplied path.
286
It looks up ids trying to find a matching parent directory with the
287
same filename, and then by pure path.
289
takes_args = ['file*']
290
takes_options = ['no-recurse', 'dry-run', 'verbose',
291
Option('file-ids-from', type=unicode,
292
help='Lookup file ids from here')]
293
encoding_type = 'replace'
295
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
299
if file_ids_from is not None:
301
base_tree, base_path = WorkingTree.open_containing(
303
except errors.NoWorkingTree:
304
base_branch, base_path = Branch.open_containing(
306
base_tree = base_branch.basis_tree()
308
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
309
to_file=self.outf, should_print=(not is_quiet()))
311
action = bzrlib.add.AddAction(to_file=self.outf,
312
should_print=(not is_quiet()))
314
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
315
action=action, save=not dry_run)
318
for glob in sorted(ignored.keys()):
319
for path in ignored[glob]:
320
self.outf.write("ignored %s matching \"%s\"\n"
324
for glob, paths in ignored.items():
325
match_len += len(paths)
326
self.outf.write("ignored %d file(s).\n" % match_len)
327
self.outf.write("If you wish to add some of these files,"
328
" please add them by name.\n")
331
class cmd_mkdir(Command):
332
"""Create a new versioned directory.
334
This is equivalent to creating the directory and then adding it.
337
takes_args = ['dir+']
338
encoding_type = 'replace'
340
def run(self, dir_list):
343
wt, dd = WorkingTree.open_containing(d)
345
self.outf.write('added %s\n' % d)
348
class cmd_relpath(Command):
349
"""Show path of a file relative to root"""
351
takes_args = ['filename']
355
def run(self, filename):
356
# TODO: jam 20050106 Can relpath return a munged path if
357
# sys.stdout encoding cannot represent it?
358
tree, relpath = WorkingTree.open_containing(filename)
359
self.outf.write(relpath)
360
self.outf.write('\n')
363
class cmd_inventory(Command):
364
"""Show inventory of the current working copy or a revision.
366
It is possible to limit the output to a particular entry
367
type using the --kind option. For example: --kind file.
369
It is also possible to restrict the list of files to a specific
370
set. For example: bzr inventory --show-ids this/file
373
takes_options = ['revision', 'show-ids', 'kind']
374
takes_args = ['file*']
377
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
378
if kind and kind not in ['file', 'directory', 'symlink']:
379
raise errors.BzrCommandError('invalid kind specified')
381
work_tree, file_list = tree_files(file_list)
383
if revision is not None:
384
if len(revision) > 1:
385
raise errors.BzrCommandError('bzr inventory --revision takes'
386
' exactly one revision identifier')
387
revision_id = revision[0].in_history(work_tree.branch).rev_id
388
tree = work_tree.branch.repository.revision_tree(revision_id)
390
# We include work_tree as well as 'tree' here
391
# So that doing '-r 10 path/foo' will lookup whatever file
392
# exists now at 'path/foo' even if it has been renamed, as
393
# well as whatever files existed in revision 10 at path/foo
394
trees = [tree, work_tree]
399
if file_list is not None:
400
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
401
require_versioned=True)
402
# find_ids_across_trees may include some paths that don't
404
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
405
for file_id in file_ids if file_id in tree)
407
entries = tree.inventory.entries()
409
for path, entry in entries:
410
if kind and kind != entry.kind:
413
self.outf.write('%-50s %s\n' % (path, entry.file_id))
415
self.outf.write(path)
416
self.outf.write('\n')
419
class cmd_mv(Command):
420
"""Move or rename a file.
423
bzr mv OLDNAME NEWNAME
424
bzr mv SOURCE... DESTINATION
426
If the last argument is a versioned directory, all the other names
427
are moved into it. Otherwise, there must be exactly two arguments
428
and the file is changed to a new name, which must not already exist.
430
Files cannot be moved between branches.
433
takes_args = ['names*']
434
aliases = ['move', 'rename']
435
encoding_type = 'replace'
437
def run(self, names_list):
438
if names_list is None:
441
if len(names_list) < 2:
442
raise errors.BzrCommandError("missing file argument")
443
tree, rel_names = tree_files(names_list)
445
if os.path.isdir(names_list[-1]):
446
# move into existing directory
447
for pair in tree.move(rel_names[:-1], rel_names[-1]):
448
self.outf.write("%s => %s\n" % pair)
450
if len(names_list) != 2:
451
raise errors.BzrCommandError('to mv multiple files the destination '
452
'must be a versioned directory')
453
tree.rename_one(rel_names[0], rel_names[1])
454
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
457
class cmd_pull(Command):
458
"""Turn this branch into a mirror of another branch.
460
This command only works on branches that have not diverged. Branches are
461
considered diverged if the destination branch's most recent commit is one
462
that has not been merged (directly or indirectly) into the parent.
464
If branches have diverged, you can use 'bzr merge' to integrate the changes
465
from one into the other. Once one branch has merged, the other should
466
be able to pull it again.
468
If you want to forget your local changes and just update your branch to
469
match the remote one, use pull --overwrite.
471
If there is no default location set, the first pull will set it. After
472
that, you can omit the location to use the default. To change the
473
default, use --remember. The value will only be saved if the remote
474
location can be accessed.
477
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
478
takes_args = ['location?']
479
encoding_type = 'replace'
481
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
482
# FIXME: too much stuff is in the command class
484
tree_to = WorkingTree.open_containing(u'.')[0]
485
branch_to = tree_to.branch
486
except errors.NoWorkingTree:
488
branch_to = Branch.open_containing(u'.')[0]
491
if location is not None:
493
reader = bundle.read_bundle_from_url(location)
494
except errors.NotABundle:
495
pass # Continue on considering this url a Branch
497
stored_loc = branch_to.get_parent()
499
if stored_loc is None:
500
raise errors.BzrCommandError("No pull location known or"
503
display_url = urlutils.unescape_for_display(stored_loc,
505
self.outf.write("Using saved location: %s\n" % display_url)
506
location = stored_loc
509
if reader is not None:
510
install_bundle(branch_to.repository, reader)
511
branch_from = branch_to
513
branch_from = Branch.open(location)
515
if branch_to.get_parent() is None or remember:
516
branch_to.set_parent(branch_from.base)
520
if reader is not None:
521
rev_id = reader.target
522
elif len(revision) == 1:
523
rev_id = revision[0].in_history(branch_from).rev_id
525
raise errors.BzrCommandError('bzr pull --revision takes one value.')
527
old_rh = branch_to.revision_history()
528
if tree_to is not None:
529
count = tree_to.pull(branch_from, overwrite, rev_id)
531
count = branch_to.pull(branch_from, overwrite, rev_id)
532
note('%d revision(s) pulled.' % (count,))
535
new_rh = branch_to.revision_history()
538
from bzrlib.log import show_changed_revisions
539
show_changed_revisions(branch_to, old_rh, new_rh,
543
class cmd_push(Command):
544
"""Update a mirror of this branch.
546
The target branch will not have its working tree populated because this
547
is both expensive, and is not supported on remote file systems.
549
Some smart servers or protocols *may* put the working tree in place in
552
This command only works on branches that have not diverged. Branches are
553
considered diverged if the destination branch's most recent commit is one
554
that has not been merged (directly or indirectly) by the source branch.
556
If branches have diverged, you can use 'bzr push --overwrite' to replace
557
the other branch completely, discarding its unmerged changes.
559
If you want to ensure you have the different changes in the other branch,
560
do a merge (see bzr help merge) from the other branch, and commit that.
561
After that you will be able to do a push without '--overwrite'.
563
If there is no default push location set, the first push will set it.
564
After that, you can omit the location to use the default. To change the
565
default, use --remember. The value will only be saved if the remote
566
location can be accessed.
569
takes_options = ['remember', 'overwrite', 'verbose',
570
Option('create-prefix',
571
help='Create the path leading up to the branch '
572
'if it does not already exist')]
573
takes_args = ['location?']
574
encoding_type = 'replace'
576
def run(self, location=None, remember=False, overwrite=False,
577
create_prefix=False, verbose=False):
578
# FIXME: Way too big! Put this into a function called from the
581
br_from = Branch.open_containing('.')[0]
582
stored_loc = br_from.get_push_location()
584
if stored_loc is None:
585
raise errors.BzrCommandError("No push location known or specified.")
587
display_url = urlutils.unescape_for_display(stored_loc,
589
self.outf.write("Using saved location: %s\n" % display_url)
590
location = stored_loc
592
to_transport = transport.get_transport(location)
593
location_url = to_transport.base
597
dir_to = bzrdir.BzrDir.open(location_url)
598
br_to = dir_to.open_branch()
599
except errors.NotBranchError:
601
to_transport = to_transport.clone('..')
602
if not create_prefix:
604
relurl = to_transport.relpath(location_url)
605
mutter('creating directory %s => %s', location_url, relurl)
606
to_transport.mkdir(relurl)
607
except errors.NoSuchFile:
608
raise errors.BzrCommandError("Parent directory of %s "
609
"does not exist." % location)
611
current = to_transport.base
612
needed = [(to_transport, to_transport.relpath(location_url))]
615
to_transport, relpath = needed[-1]
616
to_transport.mkdir(relpath)
618
except errors.NoSuchFile:
619
new_transport = to_transport.clone('..')
620
needed.append((new_transport,
621
new_transport.relpath(to_transport.base)))
622
if new_transport.base == to_transport.base:
623
raise errors.BzrCommandError("Could not create "
625
dir_to = br_from.bzrdir.clone(location_url,
626
revision_id=br_from.last_revision())
627
br_to = dir_to.open_branch()
628
count = len(br_to.revision_history())
629
# We successfully created the target, remember it
630
if br_from.get_push_location() is None or remember:
631
br_from.set_push_location(br_to.base)
633
# We were able to connect to the remote location, so remember it
634
# we don't need to successfully push because of possible divergence.
635
if br_from.get_push_location() is None or remember:
636
br_from.set_push_location(br_to.base)
637
old_rh = br_to.revision_history()
640
tree_to = dir_to.open_workingtree()
641
except errors.NotLocalUrl:
642
warning('This transport does not update the working '
643
'tree of: %s' % (br_to.base,))
644
count = br_to.pull(br_from, overwrite)
645
except errors.NoWorkingTree:
646
count = br_to.pull(br_from, overwrite)
648
count = tree_to.pull(br_from, overwrite)
649
except errors.DivergedBranches:
650
raise errors.BzrCommandError('These branches have diverged.'
651
' Try using "merge" and then "push".')
652
note('%d revision(s) pushed.' % (count,))
655
new_rh = br_to.revision_history()
658
from bzrlib.log import show_changed_revisions
659
show_changed_revisions(br_to, old_rh, new_rh,
663
class cmd_branch(Command):
664
"""Create a new copy of a branch.
666
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
667
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
669
To retrieve the branch as of a particular revision, supply the --revision
670
parameter, as in "branch foo/bar -r 5".
672
--basis is to speed up branching from remote branches. When specified, it
673
copies all the file-contents, inventory and revision data from the basis
674
branch before copying anything from the remote branch.
676
takes_args = ['from_location', 'to_location?']
677
takes_options = ['revision', 'basis']
678
aliases = ['get', 'clone']
680
def run(self, from_location, to_location=None, revision=None, basis=None):
683
elif len(revision) > 1:
684
raise errors.BzrCommandError(
685
'bzr branch --revision takes exactly 1 revision value')
687
br_from = Branch.open(from_location)
689
if e.errno == errno.ENOENT:
690
raise errors.BzrCommandError('Source location "%s" does not'
691
' exist.' % to_location)
696
if basis is not None:
697
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
700
if len(revision) == 1 and revision[0] is not None:
701
revision_id = revision[0].in_history(br_from)[1]
703
# FIXME - wt.last_revision, fallback to branch, fall back to
704
# None or perhaps NULL_REVISION to mean copy nothing
706
revision_id = br_from.last_revision()
707
if to_location is None:
708
to_location = os.path.basename(from_location.rstrip("/\\"))
711
name = os.path.basename(to_location) + '\n'
713
to_transport = transport.get_transport(to_location)
715
to_transport.mkdir('.')
716
except errors.FileExists:
717
raise errors.BzrCommandError('Target directory "%s" already'
718
' exists.' % to_location)
719
except errors.NoSuchFile:
720
raise errors.BzrCommandError('Parent of "%s" does not exist.'
723
# preserve whatever source format we have.
724
dir = br_from.bzrdir.sprout(to_transport.base,
725
revision_id, basis_dir)
726
branch = dir.open_branch()
727
except errors.NoSuchRevision:
728
to_transport.delete_tree('.')
729
msg = "The branch %s has no revision %s." % (from_location, revision[0])
730
raise errors.BzrCommandError(msg)
731
except errors.UnlistableBranch:
732
osutils.rmtree(to_location)
733
msg = "The branch %s cannot be used as a --basis" % (basis,)
734
raise errors.BzrCommandError(msg)
736
branch.control_files.put_utf8('branch-name', name)
737
note('Branched %d revision(s).' % branch.revno())
742
class cmd_checkout(Command):
743
"""Create a new checkout of an existing branch.
745
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
746
the branch found in '.'. This is useful if you have removed the working tree
747
or if it was never created - i.e. if you pushed the branch to its current
750
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
751
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
753
To retrieve the branch as of a particular revision, supply the --revision
754
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
755
out of date [so you cannot commit] but it may be useful (i.e. to examine old
758
--basis is to speed up checking out from remote branches. When specified, it
759
uses the inventory and file contents from the basis branch in preference to the
760
branch being checked out.
762
takes_args = ['branch_location?', 'to_location?']
763
takes_options = ['revision', # , 'basis']
764
Option('lightweight',
765
help="perform a lightweight checkout. Lightweight "
766
"checkouts depend on access to the branch for "
767
"every operation. Normal checkouts can perform "
768
"common operations like diff and status without "
769
"such access, and also support local commits."
774
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
778
elif len(revision) > 1:
779
raise errors.BzrCommandError(
780
'bzr checkout --revision takes exactly 1 revision value')
781
if branch_location is None:
782
branch_location = osutils.getcwd()
783
to_location = branch_location
784
source = Branch.open(branch_location)
785
if len(revision) == 1 and revision[0] is not None:
786
revision_id = revision[0].in_history(source)[1]
789
if to_location is None:
790
to_location = os.path.basename(branch_location.rstrip("/\\"))
791
# if the source and to_location are the same,
792
# and there is no working tree,
793
# then reconstitute a branch
794
if (osutils.abspath(to_location) ==
795
osutils.abspath(branch_location)):
797
source.bzrdir.open_workingtree()
798
except errors.NoWorkingTree:
799
source.bzrdir.create_workingtree()
802
os.mkdir(to_location)
804
if e.errno == errno.EEXIST:
805
raise errors.BzrCommandError('Target directory "%s" already'
806
' exists.' % to_location)
807
if e.errno == errno.ENOENT:
808
raise errors.BzrCommandError('Parent of "%s" does not exist.'
812
old_format = bzrdir.BzrDirFormat.get_default_format()
813
bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
815
source.create_checkout(to_location, revision_id, lightweight)
817
bzrdir.BzrDirFormat.set_default_format(old_format)
820
class cmd_renames(Command):
821
"""Show list of renamed files.
823
# TODO: Option to show renames between two historical versions.
825
# TODO: Only show renames under dir, rather than in the whole branch.
826
takes_args = ['dir?']
829
def run(self, dir=u'.'):
830
tree = WorkingTree.open_containing(dir)[0]
831
old_inv = tree.basis_tree().inventory
832
new_inv = tree.read_working_inventory()
833
renames = list(_mod_tree.find_renames(old_inv, new_inv))
835
for old_name, new_name in renames:
836
self.outf.write("%s => %s\n" % (old_name, new_name))
839
class cmd_update(Command):
840
"""Update a tree to have the latest code committed to its branch.
842
This will perform a merge into the working tree, and may generate
843
conflicts. If you have any local changes, you will still
844
need to commit them after the update for the update to be complete.
846
If you want to discard your local changes, you can just do a
847
'bzr revert' instead of 'bzr commit' after the update.
849
takes_args = ['dir?']
852
def run(self, dir='.'):
853
tree = WorkingTree.open_containing(dir)[0]
854
master = tree.branch.get_master_branch()
855
if master is not None:
858
tree.lock_tree_write()
860
existing_pending_merges = tree.get_parent_ids()[1:]
861
last_rev = tree.last_revision()
862
if last_rev == tree.branch.last_revision():
863
# may be up to date, check master too.
864
master = tree.branch.get_master_branch()
865
if master is None or last_rev == master.last_revision():
866
revno = tree.branch.revision_id_to_revno(last_rev)
867
note("Tree is up to date at revision %d." % (revno,))
869
conflicts = tree.update()
870
revno = tree.branch.revision_id_to_revno(tree.last_revision())
871
note('Updated to revision %d.' % (revno,))
872
if tree.get_parent_ids()[1:] != existing_pending_merges:
873
note('Your local commits will now show as pending merges with '
874
"'bzr status', and can be committed with 'bzr commit'.")
883
class cmd_info(Command):
884
"""Show information about a working tree, branch or repository.
886
This command will show all known locations and formats associated to the
887
tree, branch or repository. Statistical information is included with
890
Branches and working trees will also report any missing revisions.
892
takes_args = ['location?']
893
takes_options = ['verbose']
896
def run(self, location=None, verbose=False):
897
from bzrlib.info import show_bzrdir_info
898
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
902
class cmd_remove(Command):
903
"""Make a file unversioned.
905
This makes bzr stop tracking changes to a versioned file. It does
906
not delete the working copy.
908
You can specify one or more files, and/or --new. If you specify --new,
909
only 'added' files will be removed. If you specify both, then new files
910
in the specified directories will be removed. If the directories are
911
also new, they will also be removed.
913
takes_args = ['file*']
914
takes_options = ['verbose', Option('new', help='remove newly-added files')]
916
encoding_type = 'replace'
918
def run(self, file_list, verbose=False, new=False):
919
tree, file_list = tree_files(file_list)
921
if file_list is None:
922
raise errors.BzrCommandError('Specify one or more files to'
923
' remove, or use --new.')
925
added = tree.changes_from(tree.basis_tree(),
926
specific_files=file_list).added
927
file_list = sorted([f[0] for f in added], reverse=True)
928
if len(file_list) == 0:
929
raise errors.BzrCommandError('No matching files.')
930
tree.remove(file_list, verbose=verbose, to_file=self.outf)
933
class cmd_file_id(Command):
934
"""Print file_id of a particular file or directory.
936
The file_id is assigned when the file is first added and remains the
937
same through all revisions where the file exists, even when it is
942
takes_args = ['filename']
945
def run(self, filename):
946
tree, relpath = WorkingTree.open_containing(filename)
947
i = tree.inventory.path2id(relpath)
949
raise errors.BzrError("%r is not a versioned file" % filename)
951
self.outf.write(i + '\n')
954
class cmd_file_path(Command):
955
"""Print path of file_ids to a file or directory.
957
This prints one line for each directory down to the target,
958
starting at the branch root.
962
takes_args = ['filename']
965
def run(self, filename):
966
tree, relpath = WorkingTree.open_containing(filename)
968
fid = inv.path2id(relpath)
970
raise errors.BzrError("%r is not a versioned file" % filename)
971
for fip in inv.get_idpath(fid):
972
self.outf.write(fip + '\n')
975
class cmd_reconcile(Command):
976
"""Reconcile bzr metadata in a branch.
978
This can correct data mismatches that may have been caused by
979
previous ghost operations or bzr upgrades. You should only
980
need to run this command if 'bzr check' or a bzr developer
981
advises you to run it.
983
If a second branch is provided, cross-branch reconciliation is
984
also attempted, which will check that data like the tree root
985
id which was not present in very early bzr versions is represented
986
correctly in both branches.
988
At the same time it is run it may recompress data resulting in
989
a potential saving in disk space or performance gain.
991
The branch *MUST* be on a listable system such as local disk or sftp.
993
takes_args = ['branch?']
995
def run(self, branch="."):
996
from bzrlib.reconcile import reconcile
997
dir = bzrdir.BzrDir.open(branch)
1001
class cmd_revision_history(Command):
1002
"""Display the list of revision ids on a branch."""
1003
takes_args = ['location?']
1008
def run(self, location="."):
1009
branch = Branch.open_containing(location)[0]
1010
for revid in branch.revision_history():
1011
self.outf.write(revid)
1012
self.outf.write('\n')
1015
class cmd_ancestry(Command):
1016
"""List all revisions merged into this branch."""
1017
takes_args = ['location?']
1022
def run(self, location="."):
1024
wt = WorkingTree.open_containing(location)[0]
1025
except errors.NoWorkingTree:
1026
b = Branch.open(location)
1027
last_revision = b.last_revision()
1030
last_revision = wt.last_revision()
1032
revision_ids = b.repository.get_ancestry(last_revision)
1033
assert revision_ids[0] is None
1035
for revision_id in revision_ids:
1036
self.outf.write(revision_id + '\n')
1039
class cmd_init(Command):
1040
"""Make a directory into a versioned branch.
1042
Use this to create an empty branch, or before importing an
1045
If there is a repository in a parent directory of the location, then
1046
the history of the branch will be stored in the repository. Otherwise
1047
init creates a standalone branch which carries its own history in
1050
If there is already a branch at the location but it has no working tree,
1051
the tree can be populated with 'bzr checkout'.
1053
Recipe for importing a tree of files:
1058
bzr commit -m 'imported project'
1060
takes_args = ['location?']
1063
help='Specify a format for this branch. Current'
1064
' formats are: default, knit, metaweave and'
1065
' weave. Default is knit; metaweave and'
1066
' weave are deprecated',
1067
type=get_format_type),
1069
def run(self, location=None, format=None):
1071
format = get_format_type('default')
1072
if location is None:
1075
to_transport = transport.get_transport(location)
1077
# The path has to exist to initialize a
1078
# branch inside of it.
1079
# Just using os.mkdir, since I don't
1080
# believe that we want to create a bunch of
1081
# locations if the user supplies an extended path
1082
# TODO: create-prefix
1084
to_transport.mkdir('.')
1085
except errors.FileExists:
1089
existing_bzrdir = bzrdir.BzrDir.open(location)
1090
except errors.NotBranchError:
1091
# really a NotBzrDir error...
1092
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1094
from bzrlib.transport.local import LocalTransport
1095
if existing_bzrdir.has_branch():
1096
if (isinstance(to_transport, LocalTransport)
1097
and not existing_bzrdir.has_workingtree()):
1098
raise errors.BranchExistsWithoutWorkingTree(location)
1099
raise errors.AlreadyBranchError(location)
1101
existing_bzrdir.create_branch()
1102
existing_bzrdir.create_workingtree()
1105
class cmd_init_repository(Command):
1106
"""Create a shared repository to hold branches.
1108
New branches created under the repository directory will store their revisions
1109
in the repository, not in the branch directory, if the branch format supports
1115
bzr checkout --lightweight repo/trunk trunk-checkout
1119
takes_args = ["location"]
1120
takes_options = [Option('format',
1121
help='Specify a format for this repository.'
1122
' Current formats are: default, knit,'
1123
' metaweave and weave. Default is knit;'
1124
' metaweave and weave are deprecated',
1125
type=get_format_type),
1127
help='Allows branches in repository to have'
1129
aliases = ["init-repo"]
1130
def run(self, location, format=None, trees=False):
1132
format = get_format_type('default')
1134
if location is None:
1137
to_transport = transport.get_transport(location)
1139
to_transport.mkdir('.')
1140
except errors.FileExists:
1143
newdir = format.initialize_on_transport(to_transport)
1144
repo = newdir.create_repository(shared=True)
1145
repo.set_make_working_trees(trees)
1148
class cmd_diff(Command):
1149
"""Show differences in the working tree or between revisions.
1151
If files are listed, only the changes in those files are listed.
1152
Otherwise, all changes for the tree are listed.
1154
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1155
produces patches suitable for "patch -p1".
1159
Shows the difference in the working tree versus the last commit
1161
Difference between the working tree and revision 1
1163
Difference between revision 2 and revision 1
1164
bzr diff --diff-prefix old/:new/
1165
Same as 'bzr diff' but prefix paths with old/ and new/
1166
bzr diff bzr.mine bzr.dev
1167
Show the differences between the two working trees
1169
Show just the differences for 'foo.c'
1171
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1172
# or a graphical diff.
1174
# TODO: Python difflib is not exactly the same as unidiff; should
1175
# either fix it up or prefer to use an external diff.
1177
# TODO: Selected-file diff is inefficient and doesn't show you
1180
# TODO: This probably handles non-Unix newlines poorly.
1182
takes_args = ['file*']
1183
takes_options = ['revision', 'diff-options', 'prefix']
1184
aliases = ['di', 'dif']
1185
encoding_type = 'exact'
1188
def run(self, revision=None, file_list=None, diff_options=None,
1190
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1192
if (prefix is None) or (prefix == '0'):
1200
if not ':' in prefix:
1201
raise errors.BzrError("--diff-prefix expects two values"
1202
" separated by a colon")
1203
old_label, new_label = prefix.split(":")
1206
tree1, file_list = internal_tree_files(file_list)
1210
except errors.FileInWrongBranch:
1211
if len(file_list) != 2:
1212
raise errors.BzrCommandError("Files are in different branches")
1214
tree1, file1 = WorkingTree.open_containing(file_list[0])
1215
tree2, file2 = WorkingTree.open_containing(file_list[1])
1216
if file1 != "" or file2 != "":
1217
# FIXME diff those two files. rbc 20051123
1218
raise errors.BzrCommandError("Files are in different branches")
1220
except errors.NotBranchError:
1221
if (revision is not None and len(revision) == 2
1222
and not revision[0].needs_branch()
1223
and not revision[1].needs_branch()):
1224
# If both revision specs include a branch, we can
1225
# diff them without needing a local working tree
1226
tree1, tree2 = None, None
1229
if revision is not None:
1230
if tree2 is not None:
1231
raise errors.BzrCommandError("Can't specify -r with two branches")
1232
if (len(revision) == 1) or (revision[1].spec is None):
1233
return diff_cmd_helper(tree1, file_list, diff_options,
1235
old_label=old_label, new_label=new_label)
1236
elif len(revision) == 2:
1237
return diff_cmd_helper(tree1, file_list, diff_options,
1238
revision[0], revision[1],
1239
old_label=old_label, new_label=new_label)
1241
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1242
' one or two revision identifiers')
1244
if tree2 is not None:
1245
return show_diff_trees(tree1, tree2, sys.stdout,
1246
specific_files=file_list,
1247
external_diff_options=diff_options,
1248
old_label=old_label, new_label=new_label)
1250
return diff_cmd_helper(tree1, file_list, diff_options,
1251
old_label=old_label, new_label=new_label)
1254
class cmd_deleted(Command):
1255
"""List files deleted in the working tree.
1257
# TODO: Show files deleted since a previous revision, or
1258
# between two revisions.
1259
# TODO: Much more efficient way to do this: read in new
1260
# directories with readdir, rather than stating each one. Same
1261
# level of effort but possibly much less IO. (Or possibly not,
1262
# if the directories are very large...)
1263
takes_options = ['show-ids']
1266
def run(self, show_ids=False):
1267
tree = WorkingTree.open_containing(u'.')[0]
1268
old = tree.basis_tree()
1269
for path, ie in old.inventory.iter_entries():
1270
if not tree.has_id(ie.file_id):
1271
self.outf.write(path)
1273
self.outf.write(' ')
1274
self.outf.write(ie.file_id)
1275
self.outf.write('\n')
1278
class cmd_modified(Command):
1279
"""List files modified in working tree."""
1283
tree = WorkingTree.open_containing(u'.')[0]
1284
td = tree.changes_from(tree.basis_tree())
1285
for path, id, kind, text_modified, meta_modified in td.modified:
1286
self.outf.write(path + '\n')
1289
class cmd_added(Command):
1290
"""List files added in working tree."""
1294
wt = WorkingTree.open_containing(u'.')[0]
1295
basis_inv = wt.basis_tree().inventory
1298
if file_id in basis_inv:
1300
if inv.is_root(file_id) and len(basis_inv) == 0:
1302
path = inv.id2path(file_id)
1303
if not os.access(osutils.abspath(path), os.F_OK):
1305
self.outf.write(path + '\n')
1308
class cmd_root(Command):
1309
"""Show the tree root directory.
1311
The root is the nearest enclosing directory with a .bzr control
1313
takes_args = ['filename?']
1315
def run(self, filename=None):
1316
"""Print the branch root."""
1317
tree = WorkingTree.open_containing(filename)[0]
1318
self.outf.write(tree.basedir + '\n')
1321
class cmd_log(Command):
1322
"""Show log of a branch, file, or directory.
1324
By default show the log of the branch containing the working directory.
1326
To request a range of logs, you can use the command -r begin..end
1327
-r revision requests a specific revision, -r ..end or -r begin.. are
1333
bzr log -r -10.. http://server/branch
1336
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1338
takes_args = ['location?']
1339
takes_options = [Option('forward',
1340
help='show from oldest to newest'),
1343
help='show files changed in each revision'),
1344
'show-ids', 'revision',
1348
help='show revisions whose message matches this regexp',
1352
encoding_type = 'replace'
1355
def run(self, location=None, timezone='original',
1365
from bzrlib.log import log_formatter, show_log
1366
assert message is None or isinstance(message, basestring), \
1367
"invalid message argument %r" % message
1368
direction = (forward and 'forward') or 'reverse'
1373
# find the file id to log:
1375
dir, fp = bzrdir.BzrDir.open_containing(location)
1376
b = dir.open_branch()
1380
inv = dir.open_workingtree().inventory
1381
except (errors.NotBranchError, errors.NotLocalUrl):
1382
# either no tree, or is remote.
1383
inv = b.basis_tree().inventory
1384
file_id = inv.path2id(fp)
1386
raise errors.BzrCommandError(
1387
"Path does not have any revision history: %s" %
1391
# FIXME ? log the current subdir only RBC 20060203
1392
if revision is not None \
1393
and len(revision) > 0 and revision[0].get_branch():
1394
location = revision[0].get_branch()
1397
dir, relpath = bzrdir.BzrDir.open_containing(location)
1398
b = dir.open_branch()
1400
if revision is None:
1403
elif len(revision) == 1:
1404
rev1 = rev2 = revision[0].in_history(b).revno
1405
elif len(revision) == 2:
1406
if revision[1].get_branch() != revision[0].get_branch():
1407
# b is taken from revision[0].get_branch(), and
1408
# show_log will use its revision_history. Having
1409
# different branches will lead to weird behaviors.
1410
raise errors.BzrCommandError(
1411
"Log doesn't accept two revisions in different branches.")
1412
if revision[0].spec is None:
1413
# missing begin-range means first revision
1416
rev1 = revision[0].in_history(b).revno
1418
if revision[1].spec is None:
1419
# missing end-range means last known revision
1422
rev2 = revision[1].in_history(b).revno
1424
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1426
# By this point, the revision numbers are converted to the +ve
1427
# form if they were supplied in the -ve form, so we can do
1428
# this comparison in relative safety
1430
(rev2, rev1) = (rev1, rev2)
1432
if (log_format is None):
1433
default = b.get_config().log_format()
1434
log_format = get_log_format(long=long, short=short, line=line,
1436
lf = log_formatter(log_format,
1439
show_timezone=timezone)
1445
direction=direction,
1446
start_revision=rev1,
1451
def get_log_format(long=False, short=False, line=False, default='long'):
1452
log_format = default
1456
log_format = 'short'
1462
class cmd_touching_revisions(Command):
1463
"""Return revision-ids which affected a particular file.
1465
A more user-friendly interface is "bzr log FILE".
1469
takes_args = ["filename"]
1472
def run(self, filename):
1473
tree, relpath = WorkingTree.open_containing(filename)
1475
inv = tree.read_working_inventory()
1476
file_id = inv.path2id(relpath)
1477
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1478
self.outf.write("%6d %s\n" % (revno, what))
1481
class cmd_ls(Command):
1482
"""List files in a tree.
1484
# TODO: Take a revision or remote path and list that tree instead.
1486
takes_options = ['verbose', 'revision',
1487
Option('non-recursive',
1488
help='don\'t recurse into sub-directories'),
1490
help='Print all paths from the root of the branch.'),
1491
Option('unknown', help='Print unknown files'),
1492
Option('versioned', help='Print versioned files'),
1493
Option('ignored', help='Print ignored files'),
1495
Option('null', help='Null separate the files'),
1498
def run(self, revision=None, verbose=False,
1499
non_recursive=False, from_root=False,
1500
unknown=False, versioned=False, ignored=False,
1503
if verbose and null:
1504
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1505
all = not (unknown or versioned or ignored)
1507
selection = {'I':ignored, '?':unknown, 'V':versioned}
1509
tree, relpath = WorkingTree.open_containing(u'.')
1514
if revision is not None:
1515
tree = tree.branch.repository.revision_tree(
1516
revision[0].in_history(tree.branch).rev_id)
1518
for fp, fc, kind, fid, entry in tree.list_files(include_root=False):
1519
if fp.startswith(relpath):
1520
fp = fp[len(relpath):]
1521
if non_recursive and '/' in fp:
1523
if not all and not selection[fc]:
1526
kindch = entry.kind_character()
1527
self.outf.write('%-8s %s%s\n' % (fc, fp, kindch))
1529
self.outf.write(fp + '\0')
1532
self.outf.write(fp + '\n')
1535
class cmd_unknowns(Command):
1536
"""List unknown files."""
1539
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1540
self.outf.write(osutils.quotefn(f) + '\n')
1543
class cmd_ignore(Command):
1544
"""Ignore specified files or patterns.
1546
To remove patterns from the ignore list, edit the .bzrignore file.
1548
Trailing slashes on patterns are ignored.
1549
If the pattern contains a slash, it is compared to the whole path
1550
from the branch root. Otherwise, it is compared to only the last
1551
component of the path. To match a file only in the root directory,
1554
Ignore patterns specifying absolute paths are not allowed.
1556
Ignore patterns are case-insensitive on case-insensitive systems.
1558
Note: wildcards must be quoted from the shell on Unix.
1561
bzr ignore ./Makefile
1562
bzr ignore '*.class'
1564
takes_args = ['name_pattern*']
1566
Option('old-default-rules',
1567
help='Out the ignore rules bzr < 0.9 always used.')
1570
def run(self, name_pattern_list=None, old_default_rules=None):
1571
from bzrlib.atomicfile import AtomicFile
1572
if old_default_rules is not None:
1573
# dump the rules and exit
1574
for pattern in ignores.OLD_DEFAULTS:
1577
if not name_pattern_list:
1578
raise errors.BzrCommandError("ignore requires at least one "
1579
"NAME_PATTERN or --old-default-rules")
1580
for name_pattern in name_pattern_list:
1581
if name_pattern[0] == '/':
1582
raise errors.BzrCommandError(
1583
"NAME_PATTERN should not be an absolute path")
1584
tree, relpath = WorkingTree.open_containing(u'.')
1585
ifn = tree.abspath('.bzrignore')
1586
if os.path.exists(ifn):
1589
igns = f.read().decode('utf-8')
1595
# TODO: If the file already uses crlf-style termination, maybe
1596
# we should use that for the newly added lines?
1598
if igns and igns[-1] != '\n':
1600
for name_pattern in name_pattern_list:
1601
igns += name_pattern.rstrip('/') + '\n'
1603
f = AtomicFile(ifn, 'wb')
1605
f.write(igns.encode('utf-8'))
1610
inv = tree.inventory
1611
if inv.path2id('.bzrignore'):
1612
mutter('.bzrignore is already versioned')
1614
mutter('need to make new .bzrignore file versioned')
1615
tree.add(['.bzrignore'])
1618
class cmd_ignored(Command):
1619
"""List ignored files and the patterns that matched them.
1621
See also: bzr ignore"""
1624
tree = WorkingTree.open_containing(u'.')[0]
1625
for path, file_class, kind, file_id, entry in tree.list_files():
1626
if file_class != 'I':
1628
## XXX: Slightly inefficient since this was already calculated
1629
pat = tree.is_ignored(path)
1630
print '%-50s %s' % (path, pat)
1633
class cmd_lookup_revision(Command):
1634
"""Lookup the revision-id from a revision-number
1637
bzr lookup-revision 33
1640
takes_args = ['revno']
1643
def run(self, revno):
1647
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1649
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1652
class cmd_export(Command):
1653
"""Export past revision to destination directory.
1655
If no revision is specified this exports the last committed revision.
1657
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1658
given, try to find the format with the extension. If no extension
1659
is found exports to a directory (equivalent to --format=dir).
1661
Root may be the top directory for tar, tgz and tbz2 formats. If none
1662
is given, the top directory will be the root name of the file.
1664
If branch is omitted then the branch containing the CWD will be used.
1666
Note: export of tree with non-ascii filenames to zip is not supported.
1668
Supported formats Autodetected by extension
1669
----------------- -------------------------
1672
tbz2 .tar.bz2, .tbz2
1676
takes_args = ['dest', 'branch?']
1677
takes_options = ['revision', 'format', 'root']
1678
def run(self, dest, branch=None, revision=None, format=None, root=None):
1679
from bzrlib.export import export
1682
tree = WorkingTree.open_containing(u'.')[0]
1685
b = Branch.open(branch)
1687
if revision is None:
1688
# should be tree.last_revision FIXME
1689
rev_id = b.last_revision()
1691
if len(revision) != 1:
1692
raise errors.BzrError('bzr export --revision takes exactly'
1694
rev_id = revision[0].in_history(b).rev_id
1695
t = b.repository.revision_tree(rev_id)
1697
export(t, dest, format, root)
1698
except errors.NoSuchExportFormat, e:
1699
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1702
class cmd_cat(Command):
1703
"""Write a file's text from a previous revision."""
1705
takes_options = ['revision', 'name-from-revision']
1706
takes_args = ['filename']
1709
def run(self, filename, revision=None, name_from_revision=False):
1710
if revision is not None and len(revision) != 1:
1711
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1716
tree, relpath = WorkingTree.open_containing(filename)
1718
except errors.NotBranchError:
1722
b, relpath = Branch.open_containing(filename)
1723
if revision is not None and revision[0].get_branch() is not None:
1724
b = Branch.open(revision[0].get_branch())
1725
if revision is None:
1726
revision_id = b.last_revision()
1728
revision_id = revision[0].in_history(b).rev_id
1730
cur_file_id = tree.path2id(relpath)
1731
rev_tree = b.repository.revision_tree(revision_id)
1732
old_file_id = rev_tree.path2id(relpath)
1734
if name_from_revision:
1735
if old_file_id is None:
1736
raise errors.BzrCommandError("%r is not present in revision %s"
1737
% (filename, revision_id))
1739
rev_tree.print_file(old_file_id)
1740
elif cur_file_id is not None:
1741
rev_tree.print_file(cur_file_id)
1742
elif old_file_id is not None:
1743
rev_tree.print_file(old_file_id)
1745
raise errors.BzrCommandError("%r is not present in revision %s" %
1746
(filename, revision_id))
1749
class cmd_local_time_offset(Command):
1750
"""Show the offset in seconds from GMT to local time."""
1754
print osutils.local_time_offset()
1758
class cmd_commit(Command):
1759
"""Commit changes into a new revision.
1761
If no arguments are given, the entire tree is committed.
1763
If selected files are specified, only changes to those files are
1764
committed. If a directory is specified then the directory and everything
1765
within it is committed.
1767
A selected-file commit may fail in some cases where the committed
1768
tree would be invalid, such as trying to commit a file in a
1769
newly-added directory that is not itself committed.
1771
# TODO: Run hooks on tree to-be-committed, and after commit.
1773
# TODO: Strict commit that fails if there are deleted files.
1774
# (what does "deleted files" mean ??)
1776
# TODO: Give better message for -s, --summary, used by tla people
1778
# XXX: verbose currently does nothing
1780
takes_args = ['selected*']
1781
takes_options = ['message', 'verbose',
1783
help='commit even if nothing has changed'),
1784
Option('file', type=str,
1786
help='file containing commit message'),
1788
help="refuse to commit if there are unknown "
1789
"files in the working tree."),
1791
help="perform a local only commit in a bound "
1792
"branch. Such commits are not pushed to "
1793
"the master branch until a normal commit "
1797
aliases = ['ci', 'checkin']
1799
def run(self, message=None, file=None, verbose=True, selected_list=None,
1800
unchanged=False, strict=False, local=False):
1801
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1802
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1804
from bzrlib.msgeditor import edit_commit_message, \
1805
make_commit_message_template
1807
# TODO: Need a blackbox test for invoking the external editor; may be
1808
# slightly problematic to run this cross-platform.
1810
# TODO: do more checks that the commit will succeed before
1811
# spending the user's valuable time typing a commit message.
1812
tree, selected_list = tree_files(selected_list)
1813
if selected_list == ['']:
1814
# workaround - commit of root of tree should be exactly the same
1815
# as just default commit in that tree, and succeed even though
1816
# selected-file merge commit is not done yet
1819
if local and not tree.branch.get_bound_location():
1820
raise errors.LocalRequiresBoundBranch()
1821
if message is None and not file:
1822
template = make_commit_message_template(tree, selected_list)
1823
message = edit_commit_message(template)
1825
raise errors.BzrCommandError("please specify a commit message"
1826
" with either --message or --file")
1827
elif message and file:
1828
raise errors.BzrCommandError("please specify either --message or --file")
1831
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1834
raise errors.BzrCommandError("empty commit message specified")
1837
reporter = ReportCommitToLog()
1839
reporter = NullCommitReporter()
1841
msgfilename = self._save_commit_message(message, tree.basedir)
1843
tree.commit(message, specific_files=selected_list,
1844
allow_pointless=unchanged, strict=strict, local=local,
1846
if msgfilename is not None:
1848
os.unlink(msgfilename)
1850
warning("failed to unlink %s: %s; ignored", msgfilename, e)
1851
except PointlessCommit:
1852
# FIXME: This should really happen before the file is read in;
1853
# perhaps prepare the commit; get the message; then actually commit
1854
if msgfilename is not None:
1855
raise errors.BzrCommandError("no changes to commit."
1856
" use --unchanged to commit anyhow\n"
1857
"Commit message saved. To reuse the message,"
1858
" do\nbzr commit --file " + msgfilename)
1860
raise errors.BzrCommandError("no changes to commit."
1861
" use --unchanged to commit anyhow")
1862
except ConflictsInTree:
1863
if msgfilename is not None:
1864
raise errors.BzrCommandError('Conflicts detected in working '
1865
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
1867
'Commit message saved. To reuse the message,'
1868
' do\nbzr commit --file ' + msgfilename)
1870
raise errors.BzrCommandError('Conflicts detected in working '
1871
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
1873
except StrictCommitFailed:
1874
if msgfilename is not None:
1875
raise errors.BzrCommandError("Commit refused because there are"
1876
" unknown files in the working tree.\n"
1877
"Commit message saved. To reuse the message,"
1878
" do\nbzr commit --file " + msgfilename)
1880
raise errors.BzrCommandError("Commit refused because there are"
1881
" unknown files in the working tree.")
1882
except errors.BoundBranchOutOfDate, e:
1883
if msgfilename is not None:
1884
raise errors.BzrCommandError(str(e) + "\n"
1885
'To commit to master branch, run update and then commit.\n'
1886
'You can also pass --local to commit to continue working '
1888
'Commit message saved. To reuse the message,'
1889
' do\nbzr commit --file ' + msgfilename)
1891
raise errors.BzrCommandError(str(e) + "\n"
1892
'To commit to master branch, run update and then commit.\n'
1893
'You can also pass --local to commit to continue working '
1896
def _save_commit_message(self, message, basedir):
1897
# save the commit message and only unlink it if the commit was
1901
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr-commit-',
1905
# No access to working dir, try $TMP
1906
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr-commit-')
1908
# We can't create a temp file, try to work without it
1911
os.write(tmp_fileno, message.encode(bzrlib.user_encoding, 'replace'))
1913
os.close(tmp_fileno)
1917
class cmd_check(Command):
1918
"""Validate consistency of branch history.
1920
This command checks various invariants about the branch storage to
1921
detect data corruption or bzr bugs.
1923
takes_args = ['branch?']
1924
takes_options = ['verbose']
1926
def run(self, branch=None, verbose=False):
1927
from bzrlib.check import check
1929
tree = WorkingTree.open_containing()[0]
1930
branch = tree.branch
1932
branch = Branch.open(branch)
1933
check(branch, verbose)
1936
class cmd_upgrade(Command):
1937
"""Upgrade branch storage to current format.
1939
The check command or bzr developers may sometimes advise you to run
1940
this command. When the default format has changed you may also be warned
1941
during other operations to upgrade.
1943
takes_args = ['url?']
1946
help='Upgrade to a specific format. Current formats'
1947
' are: default, knit, metaweave and weave.'
1948
' Default is knit; metaweave and weave are'
1950
type=get_format_type),
1954
def run(self, url='.', format=None):
1955
from bzrlib.upgrade import upgrade
1957
format = get_format_type('default')
1958
upgrade(url, format)
1961
class cmd_whoami(Command):
1962
"""Show or set bzr user id.
1966
bzr whoami 'Frank Chu <fchu@example.com>'
1968
takes_options = [ Option('email',
1969
help='display email address only'),
1971
help='set identity for the current branch instead of '
1974
takes_args = ['name?']
1975
encoding_type = 'replace'
1978
def run(self, email=False, branch=False, name=None):
1980
# use branch if we're inside one; otherwise global config
1982
c = Branch.open_containing('.')[0].get_config()
1983
except errors.NotBranchError:
1984
c = config.GlobalConfig()
1986
self.outf.write(c.user_email() + '\n')
1988
self.outf.write(c.username() + '\n')
1991
# display a warning if an email address isn't included in the given name.
1993
config.extract_email_address(name)
1994
except errors.NoEmailInUsername, e:
1995
warning('"%s" does not seem to contain an email address. '
1996
'This is allowed, but not recommended.', name)
1998
# use global config unless --branch given
2000
c = Branch.open_containing('.')[0].get_config()
2002
c = config.GlobalConfig()
2003
c.set_user_option('email', name)
2006
class cmd_nick(Command):
2007
"""Print or set the branch nickname.
2009
If unset, the tree root directory name is used as the nickname
2010
To print the current nickname, execute with no argument.
2012
takes_args = ['nickname?']
2013
def run(self, nickname=None):
2014
branch = Branch.open_containing(u'.')[0]
2015
if nickname is None:
2016
self.printme(branch)
2018
branch.nick = nickname
2021
def printme(self, branch):
2025
class cmd_selftest(Command):
2026
"""Run internal test suite.
2028
This creates temporary test directories in the working directory,
2029
but not existing data is affected. These directories are deleted
2030
if the tests pass, or left behind to help in debugging if they
2031
fail and --keep-output is specified.
2033
If arguments are given, they are regular expressions that say
2034
which tests should run.
2036
If the global option '--no-plugins' is given, plugins are not loaded
2037
before running the selftests. This has two effects: features provided or
2038
modified by plugins will not be tested, and tests provided by plugins will
2043
bzr --no-plugins selftest -v
2045
# TODO: --list should give a list of all available tests
2047
# NB: this is used from the class without creating an instance, which is
2048
# why it does not have a self parameter.
2049
def get_transport_type(typestring):
2050
"""Parse and return a transport specifier."""
2051
if typestring == "sftp":
2052
from bzrlib.transport.sftp import SFTPAbsoluteServer
2053
return SFTPAbsoluteServer
2054
if typestring == "memory":
2055
from bzrlib.transport.memory import MemoryServer
2057
if typestring == "fakenfs":
2058
from bzrlib.transport.fakenfs import FakeNFSServer
2059
return FakeNFSServer
2060
msg = "No known transport type %s. Supported types are: sftp\n" %\
2062
raise errors.BzrCommandError(msg)
2065
takes_args = ['testspecs*']
2066
takes_options = ['verbose',
2067
Option('one', help='stop when one test fails'),
2068
Option('keep-output',
2069
help='keep output directories when tests fail'),
2071
help='Use a different transport by default '
2072
'throughout the test suite.',
2073
type=get_transport_type),
2074
Option('benchmark', help='run the bzr bencharks.'),
2075
Option('lsprof-timed',
2076
help='generate lsprof output for benchmarked'
2077
' sections of code.'),
2078
Option('cache-dir', type=str,
2079
help='a directory to cache intermediate'
2080
' benchmark steps'),
2083
def run(self, testspecs_list=None, verbose=None, one=False,
2084
keep_output=False, transport=None, benchmark=None,
2085
lsprof_timed=None, cache_dir=None):
2087
from bzrlib.tests import selftest
2088
import bzrlib.benchmarks as benchmarks
2089
from bzrlib.benchmarks import tree_creator
2091
if cache_dir is not None:
2092
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2093
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2094
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2096
if testspecs_list is not None:
2097
pattern = '|'.join(testspecs_list)
2101
test_suite_factory = benchmarks.test_suite
2104
# TODO: should possibly lock the history file...
2105
benchfile = open(".perf_history", "at")
2107
test_suite_factory = None
2112
result = selftest(verbose=verbose,
2114
stop_on_failure=one,
2115
keep_output=keep_output,
2116
transport=transport,
2117
test_suite_factory=test_suite_factory,
2118
lsprof_timed=lsprof_timed,
2119
bench_history=benchfile)
2121
if benchfile is not None:
2124
info('tests passed')
2126
info('tests failed')
2127
return int(not result)
2130
class cmd_version(Command):
2131
"""Show version of bzr."""
2135
from bzrlib.version import show_version
2139
class cmd_rocks(Command):
2140
"""Statement of optimism."""
2146
print "it sure does!"
2149
class cmd_find_merge_base(Command):
2150
"""Find and print a base revision for merging two branches."""
2151
# TODO: Options to specify revisions on either side, as if
2152
# merging only part of the history.
2153
takes_args = ['branch', 'other']
2157
def run(self, branch, other):
2158
from bzrlib.revision import MultipleRevisionSources
2160
branch1 = Branch.open_containing(branch)[0]
2161
branch2 = Branch.open_containing(other)[0]
2163
history_1 = branch1.revision_history()
2164
history_2 = branch2.revision_history()
2166
last1 = branch1.last_revision()
2167
last2 = branch2.last_revision()
2169
source = MultipleRevisionSources(branch1.repository,
2172
base_rev_id = common_ancestor(last1, last2, source)
2174
print 'merge base is revision %s' % base_rev_id
2177
class cmd_merge(Command):
2178
"""Perform a three-way merge.
2180
The branch is the branch you will merge from. By default, it will merge
2181
the latest revision. If you specify a revision, that revision will be
2182
merged. If you specify two revisions, the first will be used as a BASE,
2183
and the second one as OTHER. Revision numbers are always relative to the
2186
By default, bzr will try to merge in all new work from the other
2187
branch, automatically determining an appropriate base. If this
2188
fails, you may need to give an explicit base.
2190
Merge will do its best to combine the changes in two branches, but there
2191
are some kinds of problems only a human can fix. When it encounters those,
2192
it will mark a conflict. A conflict means that you need to fix something,
2193
before you should commit.
2195
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2197
If there is no default branch set, the first merge will set it. After
2198
that, you can omit the branch to use the default. To change the
2199
default, use --remember. The value will only be saved if the remote
2200
location can be accessed.
2204
To merge the latest revision from bzr.dev
2205
bzr merge ../bzr.dev
2207
To merge changes up to and including revision 82 from bzr.dev
2208
bzr merge -r 82 ../bzr.dev
2210
To merge the changes introduced by 82, without previous changes:
2211
bzr merge -r 81..82 ../bzr.dev
2213
merge refuses to run if there are any uncommitted changes, unless
2216
The following merge types are available:
2218
takes_args = ['branch?']
2219
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2220
Option('show-base', help="Show base revision text in "
2222
Option('uncommitted', help='Apply uncommitted changes'
2223
' from a working copy, instead of branch changes')]
2226
from inspect import getdoc
2227
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2229
def run(self, branch=None, revision=None, force=False, merge_type=None,
2230
show_base=False, reprocess=False, remember=False,
2232
if merge_type is None:
2233
merge_type = _mod_merge.Merge3Merger
2235
tree = WorkingTree.open_containing(u'.')[0]
2237
if branch is not None:
2239
reader = bundle.read_bundle_from_url(branch)
2240
except errors.NotABundle:
2241
pass # Continue on considering this url a Branch
2243
conflicts = merge_bundle(reader, tree, not force, merge_type,
2244
reprocess, show_base)
2250
if revision is None \
2251
or len(revision) < 1 or revision[0].needs_branch():
2252
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2254
if revision is None or len(revision) < 1:
2257
other = [branch, None]
2260
other = [branch, -1]
2261
other_branch, path = Branch.open_containing(branch)
2264
raise errors.BzrCommandError('Cannot use --uncommitted and'
2265
' --revision at the same time.')
2266
branch = revision[0].get_branch() or branch
2267
if len(revision) == 1:
2269
other_branch, path = Branch.open_containing(branch)
2270
revno = revision[0].in_history(other_branch).revno
2271
other = [branch, revno]
2273
assert len(revision) == 2
2274
if None in revision:
2275
raise errors.BzrCommandError(
2276
"Merge doesn't permit empty revision specifier.")
2277
base_branch, path = Branch.open_containing(branch)
2278
branch1 = revision[1].get_branch() or branch
2279
other_branch, path1 = Branch.open_containing(branch1)
2280
if revision[0].get_branch() is not None:
2281
# then path was obtained from it, and is None.
2284
base = [branch, revision[0].in_history(base_branch).revno]
2285
other = [branch1, revision[1].in_history(other_branch).revno]
2287
if tree.branch.get_parent() is None or remember:
2288
tree.branch.set_parent(other_branch.base)
2291
interesting_files = [path]
2293
interesting_files = None
2294
pb = ui.ui_factory.nested_progress_bar()
2297
conflict_count = _merge_helper(
2298
other, base, check_clean=(not force),
2299
merge_type=merge_type,
2300
reprocess=reprocess,
2301
show_base=show_base,
2302
pb=pb, file_list=interesting_files)
2305
if conflict_count != 0:
2309
except errors.AmbiguousBase, e:
2310
m = ("sorry, bzr can't determine the right merge base yet\n"
2311
"candidates are:\n "
2312
+ "\n ".join(e.bases)
2314
"please specify an explicit base with -r,\n"
2315
"and (if you want) report this to the bzr developers\n")
2318
# TODO: move up to common parent; this isn't merge-specific anymore.
2319
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2320
"""Use tree.branch's parent if none was supplied.
2322
Report if the remembered location was used.
2324
if supplied_location is not None:
2325
return supplied_location
2326
stored_location = tree.branch.get_parent()
2327
mutter("%s", stored_location)
2328
if stored_location is None:
2329
raise errors.BzrCommandError("No location specified or remembered")
2330
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2331
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2332
return stored_location
2335
class cmd_remerge(Command):
2338
Use this if you want to try a different merge technique while resolving
2339
conflicts. Some merge techniques are better than others, and remerge
2340
lets you try different ones on different files.
2342
The options for remerge have the same meaning and defaults as the ones for
2343
merge. The difference is that remerge can (only) be run when there is a
2344
pending merge, and it lets you specify particular files.
2347
$ bzr remerge --show-base
2348
Re-do the merge of all conflicted files, and show the base text in
2349
conflict regions, in addition to the usual THIS and OTHER texts.
2351
$ bzr remerge --merge-type weave --reprocess foobar
2352
Re-do the merge of "foobar", using the weave merge algorithm, with
2353
additional processing to reduce the size of conflict regions.
2355
The following merge types are available:"""
2356
takes_args = ['file*']
2357
takes_options = ['merge-type', 'reprocess',
2358
Option('show-base', help="Show base revision text in "
2362
from inspect import getdoc
2363
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2365
def run(self, file_list=None, merge_type=None, show_base=False,
2367
if merge_type is None:
2368
merge_type = _mod_merge.Merge3Merger
2369
tree, file_list = tree_files(file_list)
2372
parents = tree.get_parent_ids()
2373
if len(parents) != 2:
2374
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2375
" merges. Not cherrypicking or"
2377
repository = tree.branch.repository
2378
base_revision = common_ancestor(parents[0],
2379
parents[1], repository)
2380
base_tree = repository.revision_tree(base_revision)
2381
other_tree = repository.revision_tree(parents[1])
2382
interesting_ids = None
2384
conflicts = tree.conflicts()
2385
if file_list is not None:
2386
interesting_ids = set()
2387
for filename in file_list:
2388
file_id = tree.path2id(filename)
2390
raise errors.NotVersionedError(filename)
2391
interesting_ids.add(file_id)
2392
if tree.kind(file_id) != "directory":
2395
for name, ie in tree.inventory.iter_entries(file_id):
2396
interesting_ids.add(ie.file_id)
2397
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2399
# Remerge only supports resolving contents conflicts
2400
allowed_conflicts = ('text conflict', 'contents conflict')
2401
restore_files = [c.path for c in conflicts
2402
if c.typestring in allowed_conflicts]
2403
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2404
tree.set_conflicts(ConflictList(new_conflicts))
2405
if file_list is not None:
2406
restore_files = file_list
2407
for filename in restore_files:
2409
restore(tree.abspath(filename))
2410
except errors.NotConflicted:
2412
conflicts = _mod_merge.merge_inner(
2413
tree.branch, other_tree, base_tree,
2415
interesting_ids=interesting_ids,
2416
other_rev_id=parents[1],
2417
merge_type=merge_type,
2418
show_base=show_base,
2419
reprocess=reprocess)
2427
class cmd_revert(Command):
2428
"""Revert files to a previous revision.
2430
Giving a list of files will revert only those files. Otherwise, all files
2431
will be reverted. If the revision is not specified with '--revision', the
2432
last committed revision is used.
2434
To remove only some changes, without reverting to a prior version, use
2435
merge instead. For example, "merge . --r-2..-3" will remove the changes
2436
introduced by -2, without affecting the changes introduced by -1. Or
2437
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2439
By default, any files that have been manually changed will be backed up
2440
first. (Files changed only by merge are not backed up.) Backup files have
2441
'.~#~' appended to their name, where # is a number.
2443
When you provide files, you can use their current pathname or the pathname
2444
from the target revision. So you can use revert to "undelete" a file by
2445
name. If you name a directory, all the contents of that directory will be
2448
takes_options = ['revision', 'no-backup']
2449
takes_args = ['file*']
2450
aliases = ['merge-revert']
2452
def run(self, revision=None, no_backup=False, file_list=None):
2453
if file_list is not None:
2454
if len(file_list) == 0:
2455
raise errors.BzrCommandError("No files specified")
2459
tree, file_list = tree_files(file_list)
2460
if revision is None:
2461
# FIXME should be tree.last_revision
2462
rev_id = tree.last_revision()
2463
elif len(revision) != 1:
2464
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2466
rev_id = revision[0].in_history(tree.branch).rev_id
2467
pb = ui.ui_factory.nested_progress_bar()
2469
tree.revert(file_list,
2470
tree.branch.repository.revision_tree(rev_id),
2476
class cmd_assert_fail(Command):
2477
"""Test reporting of assertion failures"""
2478
# intended just for use in testing
2483
raise AssertionError("always fails")
2486
class cmd_help(Command):
2487
"""Show help on a command or other topic.
2489
For a list of all available commands, say 'bzr help commands'."""
2490
takes_options = [Option('long', 'show help on all commands')]
2491
takes_args = ['topic?']
2492
aliases = ['?', '--help', '-?', '-h']
2495
def run(self, topic=None, long=False):
2497
if topic is None and long:
2502
class cmd_shell_complete(Command):
2503
"""Show appropriate completions for context.
2505
For a list of all available commands, say 'bzr shell-complete'."""
2506
takes_args = ['context?']
2511
def run(self, context=None):
2512
import shellcomplete
2513
shellcomplete.shellcomplete(context)
2516
class cmd_fetch(Command):
2517
"""Copy in history from another branch but don't merge it.
2519
This is an internal method used for pull and merge."""
2521
takes_args = ['from_branch', 'to_branch']
2522
def run(self, from_branch, to_branch):
2523
from bzrlib.fetch import Fetcher
2524
from_b = Branch.open(from_branch)
2525
to_b = Branch.open(to_branch)
2526
Fetcher(to_b, from_b)
2529
class cmd_missing(Command):
2530
"""Show unmerged/unpulled revisions between two branches.
2532
OTHER_BRANCH may be local or remote."""
2533
takes_args = ['other_branch?']
2534
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2536
'Display changes in the local branch only'),
2537
Option('theirs-only',
2538
'Display changes in the remote branch only'),
2546
encoding_type = 'replace'
2549
def run(self, other_branch=None, reverse=False, mine_only=False,
2550
theirs_only=False, log_format=None, long=False, short=False, line=False,
2551
show_ids=False, verbose=False):
2552
from bzrlib.missing import find_unmerged, iter_log_data
2553
from bzrlib.log import log_formatter
2554
local_branch = Branch.open_containing(u".")[0]
2555
parent = local_branch.get_parent()
2556
if other_branch is None:
2557
other_branch = parent
2558
if other_branch is None:
2559
raise errors.BzrCommandError("No peer location known or specified.")
2560
print "Using last location: " + local_branch.get_parent()
2561
remote_branch = Branch.open(other_branch)
2562
if remote_branch.base == local_branch.base:
2563
remote_branch = local_branch
2564
local_branch.lock_read()
2566
remote_branch.lock_read()
2568
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2569
if (log_format is None):
2570
default = local_branch.get_config().log_format()
2571
log_format = get_log_format(long=long, short=short,
2572
line=line, default=default)
2573
lf = log_formatter(log_format,
2576
show_timezone='original')
2577
if reverse is False:
2578
local_extra.reverse()
2579
remote_extra.reverse()
2580
if local_extra and not theirs_only:
2581
print "You have %d extra revision(s):" % len(local_extra)
2582
for data in iter_log_data(local_extra, local_branch.repository,
2585
printed_local = True
2587
printed_local = False
2588
if remote_extra and not mine_only:
2589
if printed_local is True:
2591
print "You are missing %d revision(s):" % len(remote_extra)
2592
for data in iter_log_data(remote_extra, remote_branch.repository,
2595
if not remote_extra and not local_extra:
2597
print "Branches are up to date."
2601
remote_branch.unlock()
2603
local_branch.unlock()
2604
if not status_code and parent is None and other_branch is not None:
2605
local_branch.lock_write()
2607
# handle race conditions - a parent might be set while we run.
2608
if local_branch.get_parent() is None:
2609
local_branch.set_parent(remote_branch.base)
2611
local_branch.unlock()
2615
class cmd_plugins(Command):
2620
import bzrlib.plugin
2621
from inspect import getdoc
2622
for name, plugin in bzrlib.plugin.all_plugins().items():
2623
if getattr(plugin, '__path__', None) is not None:
2624
print plugin.__path__[0]
2625
elif getattr(plugin, '__file__', None) is not None:
2626
print plugin.__file__
2632
print '\t', d.split('\n')[0]
2635
class cmd_testament(Command):
2636
"""Show testament (signing-form) of a revision."""
2637
takes_options = ['revision',
2638
Option('long', help='Produce long-format testament'),
2639
Option('strict', help='Produce a strict-format'
2641
takes_args = ['branch?']
2643
def run(self, branch=u'.', revision=None, long=False, strict=False):
2644
from bzrlib.testament import Testament, StrictTestament
2646
testament_class = StrictTestament
2648
testament_class = Testament
2649
b = WorkingTree.open_containing(branch)[0].branch
2652
if revision is None:
2653
rev_id = b.last_revision()
2655
rev_id = revision[0].in_history(b).rev_id
2656
t = testament_class.from_revision(b.repository, rev_id)
2658
sys.stdout.writelines(t.as_text_lines())
2660
sys.stdout.write(t.as_short_text())
2665
class cmd_annotate(Command):
2666
"""Show the origin of each line in a file.
2668
This prints out the given file with an annotation on the left side
2669
indicating which revision, author and date introduced the change.
2671
If the origin is the same for a run of consecutive lines, it is
2672
shown only at the top, unless the --all option is given.
2674
# TODO: annotate directories; showing when each file was last changed
2675
# TODO: if the working copy is modified, show annotations on that
2676
# with new uncommitted lines marked
2677
aliases = ['ann', 'blame', 'praise']
2678
takes_args = ['filename']
2679
takes_options = [Option('all', help='show annotations on all lines'),
2680
Option('long', help='show date in annotations'),
2685
def run(self, filename, all=False, long=False, revision=None):
2686
from bzrlib.annotate import annotate_file
2687
tree, relpath = WorkingTree.open_containing(filename)
2688
branch = tree.branch
2691
if revision is None:
2692
revision_id = branch.last_revision()
2693
elif len(revision) != 1:
2694
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2696
revision_id = revision[0].in_history(branch).rev_id
2697
file_id = tree.inventory.path2id(relpath)
2698
tree = branch.repository.revision_tree(revision_id)
2699
file_version = tree.inventory[file_id].revision
2700
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2705
class cmd_re_sign(Command):
2706
"""Create a digital signature for an existing revision."""
2707
# TODO be able to replace existing ones.
2709
hidden = True # is this right ?
2710
takes_args = ['revision_id*']
2711
takes_options = ['revision']
2713
def run(self, revision_id_list=None, revision=None):
2714
import bzrlib.gpg as gpg
2715
if revision_id_list is not None and revision is not None:
2716
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2717
if revision_id_list is None and revision is None:
2718
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2719
b = WorkingTree.open_containing(u'.')[0].branch
2720
gpg_strategy = gpg.GPGStrategy(b.get_config())
2721
if revision_id_list is not None:
2722
for revision_id in revision_id_list:
2723
b.repository.sign_revision(revision_id, gpg_strategy)
2724
elif revision is not None:
2725
if len(revision) == 1:
2726
revno, rev_id = revision[0].in_history(b)
2727
b.repository.sign_revision(rev_id, gpg_strategy)
2728
elif len(revision) == 2:
2729
# are they both on rh- if so we can walk between them
2730
# might be nice to have a range helper for arbitrary
2731
# revision paths. hmm.
2732
from_revno, from_revid = revision[0].in_history(b)
2733
to_revno, to_revid = revision[1].in_history(b)
2734
if to_revid is None:
2735
to_revno = b.revno()
2736
if from_revno is None or to_revno is None:
2737
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2738
for revno in range(from_revno, to_revno + 1):
2739
b.repository.sign_revision(b.get_rev_id(revno),
2742
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2745
class cmd_bind(Command):
2746
"""Bind the current branch to a master branch.
2748
After binding, commits must succeed on the master branch
2749
before they are executed on the local one.
2752
takes_args = ['location']
2755
def run(self, location=None):
2756
b, relpath = Branch.open_containing(u'.')
2757
b_other = Branch.open(location)
2760
except errors.DivergedBranches:
2761
raise errors.BzrCommandError('These branches have diverged.'
2762
' Try merging, and then bind again.')
2765
class cmd_unbind(Command):
2766
"""Unbind the current branch from its master branch.
2768
After unbinding, the local branch is considered independent.
2769
All subsequent commits will be local.
2776
b, relpath = Branch.open_containing(u'.')
2778
raise errors.BzrCommandError('Local branch is not bound')
2781
class cmd_uncommit(Command):
2782
"""Remove the last committed revision.
2784
--verbose will print out what is being removed.
2785
--dry-run will go through all the motions, but not actually
2788
In the future, uncommit will create a revision bundle, which can then
2792
# TODO: jam 20060108 Add an option to allow uncommit to remove
2793
# unreferenced information in 'branch-as-repository' branches.
2794
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2795
# information in shared branches as well.
2796
takes_options = ['verbose', 'revision',
2797
Option('dry-run', help='Don\'t actually make changes'),
2798
Option('force', help='Say yes to all questions.')]
2799
takes_args = ['location?']
2802
def run(self, location=None,
2803
dry_run=False, verbose=False,
2804
revision=None, force=False):
2805
from bzrlib.log import log_formatter, show_log
2807
from bzrlib.uncommit import uncommit
2809
if location is None:
2811
control, relpath = bzrdir.BzrDir.open_containing(location)
2813
tree = control.open_workingtree()
2815
except (errors.NoWorkingTree, errors.NotLocalUrl):
2817
b = control.open_branch()
2820
if revision is None:
2823
# 'bzr uncommit -r 10' actually means uncommit
2824
# so that the final tree is at revno 10.
2825
# but bzrlib.uncommit.uncommit() actually uncommits
2826
# the revisions that are supplied.
2827
# So we need to offset it by one
2828
revno = revision[0].in_history(b).revno+1
2830
if revno <= b.revno():
2831
rev_id = b.get_rev_id(revno)
2833
self.outf.write('No revisions to uncommit.\n')
2836
lf = log_formatter('short',
2838
show_timezone='original')
2843
direction='forward',
2844
start_revision=revno,
2845
end_revision=b.revno())
2848
print 'Dry-run, pretending to remove the above revisions.'
2850
val = raw_input('Press <enter> to continue')
2852
print 'The above revision(s) will be removed.'
2854
val = raw_input('Are you sure [y/N]? ')
2855
if val.lower() not in ('y', 'yes'):
2859
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2863
class cmd_break_lock(Command):
2864
"""Break a dead lock on a repository, branch or working directory.
2866
CAUTION: Locks should only be broken when you are sure that the process
2867
holding the lock has been stopped.
2869
You can get information on what locks are open via the 'bzr info' command.
2874
takes_args = ['location?']
2876
def run(self, location=None, show=False):
2877
if location is None:
2879
control, relpath = bzrdir.BzrDir.open_containing(location)
2881
control.break_lock()
2882
except NotImplementedError:
2886
class cmd_wait_until_signalled(Command):
2887
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
2889
This just prints a line to signal when it is ready, then blocks on stdin.
2895
sys.stdout.write("running\n")
2897
sys.stdin.readline()
2900
class cmd_serve(Command):
2901
"""Run the bzr server."""
2903
aliases = ['server']
2907
help='serve on stdin/out for use from inetd or sshd'),
2909
help='listen for connections on nominated port of the form '
2910
'[hostname:]portnumber. Passing 0 as the port number will '
2911
'result in a dynamically allocated port.',
2914
help='serve contents of directory',
2916
Option('allow-writes',
2917
help='By default the server is a readonly server. Supplying '
2918
'--allow-writes enables write access to the contents of '
2919
'the served directory and below. '
2923
def run(self, port=None, inet=False, directory=None, allow_writes=False):
2924
from bzrlib.transport import smart
2925
from bzrlib.transport import get_transport
2926
if directory is None:
2927
directory = os.getcwd()
2928
url = urlutils.local_path_to_url(directory)
2929
if not allow_writes:
2930
url = 'readonly+' + url
2931
t = get_transport(url)
2933
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
2934
elif port is not None:
2936
host, port = port.split(':')
2939
server = smart.SmartTCPServer(t, host=host, port=int(port))
2940
print 'listening on port: ', server.port
2943
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
2947
# command-line interpretation helper for merge-related commands
2948
def _merge_helper(other_revision, base_revision,
2949
check_clean=True, ignore_zero=False,
2950
this_dir=None, backup_files=False,
2952
file_list=None, show_base=False, reprocess=False,
2953
pb=DummyProgress()):
2954
"""Merge changes into a tree.
2957
list(path, revno) Base for three-way merge.
2958
If [None, None] then a base will be automatically determined.
2960
list(path, revno) Other revision for three-way merge.
2962
Directory to merge changes into; '.' by default.
2964
If true, this_dir must have no uncommitted changes before the
2966
ignore_zero - If true, suppress the "zero conflicts" message when
2967
there are no conflicts; should be set when doing something we expect
2968
to complete perfectly.
2969
file_list - If supplied, merge only changes to selected files.
2971
All available ancestors of other_revision and base_revision are
2972
automatically pulled into the branch.
2974
The revno may be -1 to indicate the last revision on the branch, which is
2977
This function is intended for use from the command line; programmatic
2978
clients might prefer to call merge.merge_inner(), which has less magic
2981
# Loading it late, so that we don't always have to import bzrlib.merge
2982
if merge_type is None:
2983
merge_type = _mod_merge.Merge3Merger
2984
if this_dir is None:
2986
this_tree = WorkingTree.open_containing(this_dir)[0]
2987
if show_base and not merge_type is _mod_merge.Merge3Merger:
2988
raise errors.BzrCommandError("Show-base is not supported for this merge"
2989
" type. %s" % merge_type)
2990
if reprocess and not merge_type.supports_reprocess:
2991
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
2992
" type %s." % merge_type)
2993
if reprocess and show_base:
2994
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
2996
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
2998
merger.pp = ProgressPhase("Merge phase", 5, pb)
2999
merger.pp.next_phase()
3000
merger.check_basis(check_clean)
3001
merger.set_other(other_revision)
3002
merger.pp.next_phase()
3003
merger.set_base(base_revision)
3004
if merger.base_rev_id == merger.other_rev_id:
3005
note('Nothing to do.')
3007
merger.backup_files = backup_files
3008
merger.merge_type = merge_type
3009
merger.set_interesting_files(file_list)
3010
merger.show_base = show_base
3011
merger.reprocess = reprocess
3012
conflicts = merger.do_merge()
3013
if file_list is None:
3014
merger.set_pending()
3021
merge = _merge_helper
3024
# these get imported and then picked up by the scan for cmd_*
3025
# TODO: Some more consistent way to split command definitions across files;
3026
# we do need to load at least some information about them to know of
3027
# aliases. ideally we would avoid loading the implementation until the
3028
# details were needed.
3029
from bzrlib.cmd_version_info import cmd_version_info
3030
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3031
from bzrlib.bundle.commands import cmd_bundle_revisions
3032
from bzrlib.sign_my_commits import cmd_sign_my_commits
3033
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3034
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
