1
# Copyright (C) 2004, 2005, 2006, 2007 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(), """
47
from bzrlib.branch import Branch
48
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
49
from bzrlib.conflicts import ConflictList
50
from bzrlib.revision import common_ancestor
51
from bzrlib.revisionspec import RevisionSpec
52
from bzrlib.workingtree import WorkingTree
55
from bzrlib.commands import Command, display_command
56
from bzrlib.option import Option, RegistryOption
57
from bzrlib.progress import DummyProgress, ProgressPhase
58
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
61
def tree_files(file_list, default_branch=u'.'):
63
return internal_tree_files(file_list, default_branch)
64
except errors.FileInWrongBranch, e:
65
raise errors.BzrCommandError("%s is not in the same branch as %s" %
66
(e.path, file_list[0]))
69
# XXX: Bad function name; should possibly also be a class method of
70
# WorkingTree rather than a function.
71
def internal_tree_files(file_list, default_branch=u'.'):
72
"""Convert command-line paths to a WorkingTree and relative paths.
74
This is typically used for command-line processors that take one or
75
more filenames, and infer the workingtree that contains them.
77
The filenames given are not required to exist.
79
:param file_list: Filenames to convert.
81
:param default_branch: Fallback tree path to use if file_list is empty or
84
:return: workingtree, [relative_paths]
86
if file_list is None or len(file_list) == 0:
87
return WorkingTree.open_containing(default_branch)[0], file_list
88
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
90
for filename in file_list:
92
new_list.append(tree.relpath(osutils.dereference_path(filename)))
93
except errors.PathNotChild:
94
raise errors.FileInWrongBranch(tree.branch, filename)
98
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
99
def get_format_type(typestring):
100
"""Parse and return a format specifier."""
101
# Have to use BzrDirMetaFormat1 directly, so that
102
# RepositoryFormat.set_default_format works
103
if typestring == "default":
104
return bzrdir.BzrDirMetaFormat1()
106
return bzrdir.format_registry.make_bzrdir(typestring)
108
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
109
raise errors.BzrCommandError(msg)
112
# TODO: Make sure no commands unconditionally use the working directory as a
113
# branch. If a filename argument is used, the first of them should be used to
114
# specify the branch. (Perhaps this can be factored out into some kind of
115
# Argument class, representing a file in a branch, where the first occurrence
118
class cmd_status(Command):
119
"""Display status summary.
121
This reports on versioned and unknown files, reporting them
122
grouped by state. Possible states are:
125
Versioned in the working copy but not in the previous revision.
128
Versioned in the previous revision but removed or deleted
132
Path of this file changed from the previous revision;
133
the text may also have changed. This includes files whose
134
parent directory was renamed.
137
Text has changed since the previous revision.
140
File kind has been changed (e.g. from file to directory).
143
Not versioned and not matching an ignore pattern.
145
To see ignored files use 'bzr ignored'. For details in the
146
changes to file texts, use 'bzr diff'.
148
--short gives a status flags for each item, similar to the SVN's status
151
Column 1: versioning / renames
157
P Entry for a pending merge (not a file)
166
* The execute bit was changed
168
If no arguments are specified, the status of the entire working
169
directory is shown. Otherwise, only the status of the specified
170
files or directories is reported. If a directory is given, status
171
is reported for everything inside that directory.
173
If a revision argument is given, the status is calculated against
174
that revision, or between two revisions if two are provided.
177
# TODO: --no-recurse, --recurse options
179
takes_args = ['file*']
180
takes_options = ['show-ids', 'revision', 'short']
181
aliases = ['st', 'stat']
183
encoding_type = 'replace'
186
def run(self, show_ids=False, file_list=None, revision=None, short=False):
187
from bzrlib.status import show_tree_status
189
tree, file_list = tree_files(file_list)
191
show_tree_status(tree, show_ids=show_ids,
192
specific_files=file_list, revision=revision,
197
class cmd_cat_revision(Command):
198
"""Write out metadata for a revision.
200
The revision to print can either be specified by a specific
201
revision identifier, or you can use --revision.
205
takes_args = ['revision_id?']
206
takes_options = ['revision']
207
# cat-revision is more for frontends so should be exact
211
def run(self, revision_id=None, revision=None):
213
if revision_id is not None and revision is not None:
214
raise errors.BzrCommandError('You can only supply one of'
215
' revision_id or --revision')
216
if revision_id is None and revision is None:
217
raise errors.BzrCommandError('You must supply either'
218
' --revision or a revision_id')
219
b = WorkingTree.open_containing(u'.')[0].branch
221
# TODO: jam 20060112 should cat-revision always output utf-8?
222
if revision_id is not None:
223
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
224
elif revision is not None:
227
raise errors.BzrCommandError('You cannot specify a NULL'
229
revno, rev_id = rev.in_history(b)
230
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
233
class cmd_remove_tree(Command):
234
"""Remove the working tree from a given branch/checkout.
236
Since a lightweight checkout is little more than a working tree
237
this will refuse to run against one.
240
takes_args = ['location?']
242
def run(self, location='.'):
243
d = bzrdir.BzrDir.open(location)
246
working = d.open_workingtree()
247
except errors.NoWorkingTree:
248
raise errors.BzrCommandError("No working tree to remove")
249
except errors.NotLocalUrl:
250
raise errors.BzrCommandError("You cannot remove the working tree of a "
253
working_path = working.bzrdir.root_transport.base
254
branch_path = working.branch.bzrdir.root_transport.base
255
if working_path != branch_path:
256
raise errors.BzrCommandError("You cannot remove the working tree from "
257
"a lightweight checkout")
259
d.destroy_workingtree()
262
class cmd_revno(Command):
263
"""Show current revision number.
265
This is equal to the number of revisions on this branch.
268
takes_args = ['location?']
271
def run(self, location=u'.'):
272
self.outf.write(str(Branch.open_containing(location)[0].revno()))
273
self.outf.write('\n')
276
class cmd_revision_info(Command):
277
"""Show revision number and revision id for a given revision identifier.
280
takes_args = ['revision_info*']
281
takes_options = ['revision']
284
def run(self, revision=None, revision_info_list=[]):
287
if revision is not None:
288
revs.extend(revision)
289
if revision_info_list is not None:
290
for rev in revision_info_list:
291
revs.append(RevisionSpec.from_string(rev))
293
raise errors.BzrCommandError('You must supply a revision identifier')
295
b = WorkingTree.open_containing(u'.')[0].branch
298
revinfo = rev.in_history(b)
299
if revinfo.revno is None:
300
print ' %s' % revinfo.rev_id
302
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
305
class cmd_add(Command):
306
"""Add specified files or directories.
308
In non-recursive mode, all the named items are added, regardless
309
of whether they were previously ignored. A warning is given if
310
any of the named files are already versioned.
312
In recursive mode (the default), files are treated the same way
313
but the behaviour for directories is different. Directories that
314
are already versioned do not give a warning. All directories,
315
whether already versioned or not, are searched for files or
316
subdirectories that are neither versioned or ignored, and these
317
are added. This search proceeds recursively into versioned
318
directories. If no names are given '.' is assumed.
320
Therefore simply saying 'bzr add' will version all files that
321
are currently unknown.
323
Adding a file whose parent directory is not versioned will
324
implicitly add the parent, and so on up to the root. This means
325
you should never need to explicitly add a directory, they'll just
326
get added when you add a file in the directory.
328
--dry-run will show which files would be added, but not actually
331
--file-ids-from will try to use the file ids from the supplied path.
332
It looks up ids trying to find a matching parent directory with the
333
same filename, and then by pure path.
335
takes_args = ['file*']
336
takes_options = ['no-recurse', 'dry-run', 'verbose',
337
Option('file-ids-from', type=unicode,
338
help='Lookup file ids from here')]
339
encoding_type = 'replace'
341
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
346
if file_ids_from is not None:
348
base_tree, base_path = WorkingTree.open_containing(
350
except errors.NoWorkingTree:
351
base_branch, base_path = Branch.open_containing(
353
base_tree = base_branch.basis_tree()
355
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
356
to_file=self.outf, should_print=(not is_quiet()))
358
action = bzrlib.add.AddAction(to_file=self.outf,
359
should_print=(not is_quiet()))
362
base_tree.lock_read()
364
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
365
action=action, save=not dry_run)
367
if base_tree is not None:
371
for glob in sorted(ignored.keys()):
372
for path in ignored[glob]:
373
self.outf.write("ignored %s matching \"%s\"\n"
377
for glob, paths in ignored.items():
378
match_len += len(paths)
379
self.outf.write("ignored %d file(s).\n" % match_len)
380
self.outf.write("If you wish to add some of these files,"
381
" please add them by name.\n")
384
class cmd_mkdir(Command):
385
"""Create a new versioned directory.
387
This is equivalent to creating the directory and then adding it.
390
takes_args = ['dir+']
391
encoding_type = 'replace'
393
def run(self, dir_list):
396
wt, dd = WorkingTree.open_containing(d)
398
self.outf.write('added %s\n' % d)
401
class cmd_relpath(Command):
402
"""Show path of a file relative to root"""
404
takes_args = ['filename']
408
def run(self, filename):
409
# TODO: jam 20050106 Can relpath return a munged path if
410
# sys.stdout encoding cannot represent it?
411
tree, relpath = WorkingTree.open_containing(filename)
412
self.outf.write(relpath)
413
self.outf.write('\n')
416
class cmd_inventory(Command):
417
"""Show inventory of the current working copy or a revision.
419
It is possible to limit the output to a particular entry
420
type using the --kind option. For example: --kind file.
422
It is also possible to restrict the list of files to a specific
423
set. For example: bzr inventory --show-ids this/file
430
takes_options = ['revision', 'show-ids', 'kind']
432
takes_args = ['file*']
435
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
436
if kind and kind not in ['file', 'directory', 'symlink']:
437
raise errors.BzrCommandError('invalid kind specified')
439
work_tree, file_list = tree_files(file_list)
440
work_tree.lock_read()
442
if revision is not None:
443
if len(revision) > 1:
444
raise errors.BzrCommandError(
445
'bzr inventory --revision takes exactly one revision'
447
revision_id = revision[0].in_history(work_tree.branch).rev_id
448
tree = work_tree.branch.repository.revision_tree(revision_id)
450
extra_trees = [work_tree]
456
if file_list is not None:
457
file_ids = tree.paths2ids(file_list, trees=extra_trees,
458
require_versioned=True)
459
# find_ids_across_trees may include some paths that don't
461
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
462
for file_id in file_ids if file_id in tree)
464
entries = tree.inventory.entries()
467
if tree is not work_tree:
470
for path, entry in entries:
471
if kind and kind != entry.kind:
474
self.outf.write('%-50s %s\n' % (path, entry.file_id))
476
self.outf.write(path)
477
self.outf.write('\n')
480
class cmd_mv(Command):
481
"""Move or rename a file.
484
bzr mv OLDNAME NEWNAME
485
bzr mv SOURCE... DESTINATION
487
If the last argument is a versioned directory, all the other names
488
are moved into it. Otherwise, there must be exactly two arguments
489
and the file is changed to a new name.
491
If OLDNAME does not exist on the filesystem but is versioned and
492
NEWNAME does exist on the filesystem but is not versioned, mv
493
assumes that the file has been manually moved and only updates
494
its internal inventory to reflect that change.
495
The same is valid when moving many SOURCE files to a DESTINATION.
497
Files cannot be moved between branches.
500
takes_args = ['names*']
501
takes_options = [Option("after", help="move only the bzr identifier"
502
" of the file (file has already been moved). Use this flag if"
503
" bzr is not able to detect this itself.")]
504
aliases = ['move', 'rename']
505
encoding_type = 'replace'
507
def run(self, names_list, after=False):
508
if names_list is None:
511
if len(names_list) < 2:
512
raise errors.BzrCommandError("missing file argument")
513
tree, rel_names = tree_files(names_list)
515
if os.path.isdir(names_list[-1]):
516
# move into existing directory
517
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
518
self.outf.write("%s => %s\n" % pair)
520
if len(names_list) != 2:
521
raise errors.BzrCommandError('to mv multiple files the'
522
' destination must be a versioned'
524
tree.rename_one(rel_names[0], rel_names[1], after=after)
525
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
528
class cmd_pull(Command):
529
"""Turn this branch into a mirror of another branch.
531
This command only works on branches that have not diverged. Branches are
532
considered diverged if the destination branch's most recent commit is one
533
that has not been merged (directly or indirectly) into the parent.
535
If branches have diverged, you can use 'bzr merge' to integrate the changes
536
from one into the other. Once one branch has merged, the other should
537
be able to pull it again.
539
If you want to forget your local changes and just update your branch to
540
match the remote one, use pull --overwrite.
542
If there is no default location set, the first pull will set it. After
543
that, you can omit the location to use the default. To change the
544
default, use --remember. The value will only be saved if the remote
545
location can be accessed.
548
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
550
help='branch to pull into, '
551
'rather than the one containing the working directory',
556
takes_args = ['location?']
557
encoding_type = 'replace'
559
def run(self, location=None, remember=False, overwrite=False,
560
revision=None, verbose=False,
562
from bzrlib.tag import _merge_tags_if_possible
563
# FIXME: too much stuff is in the command class
564
if directory is None:
567
tree_to = WorkingTree.open_containing(directory)[0]
568
branch_to = tree_to.branch
569
except errors.NoWorkingTree:
571
branch_to = Branch.open_containing(directory)[0]
574
if location is not None:
576
reader = bundle.read_bundle_from_url(location)
577
except errors.NotABundle:
578
pass # Continue on considering this url a Branch
580
stored_loc = branch_to.get_parent()
582
if stored_loc is None:
583
raise errors.BzrCommandError("No pull location known or"
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
if reader is not None:
592
install_bundle(branch_to.repository, reader)
593
branch_from = branch_to
595
branch_from = Branch.open(location)
597
if branch_to.get_parent() is None or remember:
598
branch_to.set_parent(branch_from.base)
602
if reader is not None:
603
rev_id = reader.target
604
elif len(revision) == 1:
605
rev_id = revision[0].in_history(branch_from).rev_id
607
raise errors.BzrCommandError('bzr pull --revision takes one value.')
609
old_rh = branch_to.revision_history()
610
if tree_to is not None:
611
result = tree_to.pull(branch_from, overwrite, rev_id,
612
delta.ChangeReporter(unversioned_filter=tree_to.is_ignored))
614
result = branch_to.pull(branch_from, overwrite, rev_id)
616
result.report(self.outf)
618
from bzrlib.log import show_changed_revisions
619
new_rh = branch_to.revision_history()
620
show_changed_revisions(branch_to, old_rh, new_rh, to_file=self.outf)
623
class cmd_push(Command):
624
"""Update a mirror of this branch.
626
The target branch will not have its working tree populated because this
627
is both expensive, and is not supported on remote file systems.
629
Some smart servers or protocols *may* put the working tree in place in
632
This command only works on branches that have not diverged. Branches are
633
considered diverged if the destination branch's most recent commit is one
634
that has not been merged (directly or indirectly) by the source branch.
636
If branches have diverged, you can use 'bzr push --overwrite' to replace
637
the other branch completely, discarding its unmerged changes.
639
If you want to ensure you have the different changes in the other branch,
640
do a merge (see bzr help merge) from the other branch, and commit that.
641
After that you will be able to do a push without '--overwrite'.
643
If there is no default push location set, the first push will set it.
644
After that, you can omit the location to use the default. To change the
645
default, use --remember. The value will only be saved if the remote
646
location can be accessed.
649
takes_options = ['remember', 'overwrite', 'verbose',
650
Option('create-prefix',
651
help='Create the path leading up to the branch '
652
'if it does not already exist'),
654
help='branch to push from, '
655
'rather than the one containing the working directory',
659
Option('use-existing-dir',
660
help='By default push will fail if the target'
661
' directory exists, but does not already'
662
' have a control directory. This flag will'
663
' allow push to proceed.'),
665
takes_args = ['location?']
666
encoding_type = 'replace'
668
def run(self, location=None, remember=False, overwrite=False,
669
create_prefix=False, verbose=False,
670
use_existing_dir=False,
672
# FIXME: Way too big! Put this into a function called from the
674
if directory is None:
676
br_from = Branch.open_containing(directory)[0]
677
stored_loc = br_from.get_push_location()
679
if stored_loc is None:
680
raise errors.BzrCommandError("No push location known or specified.")
682
display_url = urlutils.unescape_for_display(stored_loc,
684
self.outf.write("Using saved location: %s\n" % display_url)
685
location = stored_loc
687
to_transport = transport.get_transport(location)
688
location_url = to_transport.base
690
br_to = repository_to = dir_to = None
692
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
693
except errors.NotBranchError:
694
pass # Didn't find anything
696
# If we can open a branch, use its direct repository, otherwise see
697
# if there is a repository without a branch.
699
br_to = dir_to.open_branch()
700
except errors.NotBranchError:
701
# Didn't find a branch, can we find a repository?
703
repository_to = dir_to.find_repository()
704
except errors.NoRepositoryPresent:
707
# Found a branch, so we must have found a repository
708
repository_to = br_to.repository
712
# The destination doesn't exist; create it.
713
# XXX: Refactor the create_prefix/no_create_prefix code into a
714
# common helper function
716
to_transport.mkdir('.')
717
except errors.FileExists:
718
if not use_existing_dir:
719
raise errors.BzrCommandError("Target directory %s"
720
" already exists, but does not have a valid .bzr"
721
" directory. Supply --use-existing-dir to push"
722
" there anyway." % location)
723
except errors.NoSuchFile:
724
if not create_prefix:
725
raise errors.BzrCommandError("Parent directory of %s"
727
"\nYou may supply --create-prefix to create all"
728
" leading parent directories."
731
cur_transport = to_transport
732
needed = [cur_transport]
733
# Recurse upwards until we can create a directory successfully
735
new_transport = cur_transport.clone('..')
736
if new_transport.base == cur_transport.base:
737
raise errors.BzrCommandError("Failed to create path"
741
new_transport.mkdir('.')
742
except errors.NoSuchFile:
743
needed.append(new_transport)
744
cur_transport = new_transport
748
# Now we only need to create child directories
750
cur_transport = needed.pop()
751
cur_transport.mkdir('.')
753
# Now the target directory exists, but doesn't have a .bzr
754
# directory. So we need to create it, along with any work to create
755
# all of the dependent branches, etc.
756
dir_to = br_from.bzrdir.clone(location_url,
757
revision_id=br_from.last_revision())
758
br_to = dir_to.open_branch()
759
# TODO: Some more useful message about what was copied
760
note('Created new branch.')
761
# We successfully created the target, remember it
762
if br_from.get_push_location() is None or remember:
763
br_from.set_push_location(br_to.base)
764
elif repository_to is None:
765
# we have a bzrdir but no branch or repository
766
# XXX: Figure out what to do other than complain.
767
raise errors.BzrCommandError("At %s you have a valid .bzr control"
768
" directory, but not a branch or repository. This is an"
769
" unsupported configuration. Please move the target directory"
770
" out of the way and try again."
773
# We have a repository but no branch, copy the revisions, and then
775
last_revision_id = br_from.last_revision()
776
repository_to.fetch(br_from.repository,
777
revision_id=last_revision_id)
778
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
779
note('Created new branch.')
780
if br_from.get_push_location() is None or remember:
781
br_from.set_push_location(br_to.base)
782
else: # We have a valid to branch
783
# We were able to connect to the remote location, so remember it
784
# we don't need to successfully push because of possible divergence.
785
if br_from.get_push_location() is None or remember:
786
br_from.set_push_location(br_to.base)
787
old_rh = br_to.revision_history()
790
tree_to = dir_to.open_workingtree()
791
except errors.NotLocalUrl:
792
warning('This transport does not update the working '
793
'tree of: %s' % (br_to.base,))
794
push_result = br_from.push(br_to, overwrite)
795
except errors.NoWorkingTree:
796
push_result = br_from.push(br_to, overwrite)
800
push_result = br_from.push(tree_to.branch, overwrite)
804
except errors.DivergedBranches:
805
raise errors.BzrCommandError('These branches have diverged.'
806
' Try using "merge" and then "push".')
807
if push_result is not None:
808
push_result.report(self.outf)
810
new_rh = br_to.revision_history()
813
from bzrlib.log import show_changed_revisions
814
show_changed_revisions(br_to, old_rh, new_rh,
817
# we probably did a clone rather than a push, so a message was
822
class cmd_branch(Command):
823
"""Create a new copy of a branch.
825
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
826
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
828
To retrieve the branch as of a particular revision, supply the --revision
829
parameter, as in "branch foo/bar -r 5".
831
--basis is to speed up branching from remote branches. When specified, it
832
copies all the file-contents, inventory and revision data from the basis
833
branch before copying anything from the remote branch.
835
takes_args = ['from_location', 'to_location?']
836
takes_options = ['revision', 'basis']
837
aliases = ['get', 'clone']
839
def run(self, from_location, to_location=None, revision=None, basis=None):
840
from bzrlib.tag import _merge_tags_if_possible
843
elif len(revision) > 1:
844
raise errors.BzrCommandError(
845
'bzr branch --revision takes exactly 1 revision value')
847
br_from = Branch.open(from_location)
850
if basis is not None:
851
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
854
if len(revision) == 1 and revision[0] is not None:
855
revision_id = revision[0].in_history(br_from)[1]
857
# FIXME - wt.last_revision, fallback to branch, fall back to
858
# None or perhaps NULL_REVISION to mean copy nothing
860
revision_id = br_from.last_revision()
861
if to_location is None:
862
to_location = os.path.basename(from_location.rstrip("/\\"))
865
name = os.path.basename(to_location) + '\n'
867
to_transport = transport.get_transport(to_location)
869
to_transport.mkdir('.')
870
except errors.FileExists:
871
raise errors.BzrCommandError('Target directory "%s" already'
872
' exists.' % to_location)
873
except errors.NoSuchFile:
874
raise errors.BzrCommandError('Parent of "%s" does not exist.'
877
# preserve whatever source format we have.
878
dir = br_from.bzrdir.sprout(to_transport.base,
879
revision_id, basis_dir)
880
branch = dir.open_branch()
881
except errors.NoSuchRevision:
882
to_transport.delete_tree('.')
883
msg = "The branch %s has no revision %s." % (from_location, revision[0])
884
raise errors.BzrCommandError(msg)
885
except errors.UnlistableBranch:
886
osutils.rmtree(to_location)
887
msg = "The branch %s cannot be used as a --basis" % (basis,)
888
raise errors.BzrCommandError(msg)
890
branch.control_files.put_utf8('branch-name', name)
891
_merge_tags_if_possible(br_from, branch)
892
note('Branched %d revision(s).' % branch.revno())
897
class cmd_checkout(Command):
898
"""Create a new checkout of an existing branch.
900
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
901
the branch found in '.'. This is useful if you have removed the working tree
902
or if it was never created - i.e. if you pushed the branch to its current
905
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
906
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
908
To retrieve the branch as of a particular revision, supply the --revision
909
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
910
out of date [so you cannot commit] but it may be useful (i.e. to examine old
913
--basis is to speed up checking out from remote branches. When specified, it
914
uses the inventory and file contents from the basis branch in preference to the
915
branch being checked out.
917
See "help checkouts" for more information on checkouts.
919
takes_args = ['branch_location?', 'to_location?']
920
takes_options = ['revision', # , 'basis']
921
Option('lightweight',
922
help="perform a lightweight checkout. Lightweight "
923
"checkouts depend on access to the branch for "
924
"every operation. Normal checkouts can perform "
925
"common operations like diff and status without "
926
"such access, and also support local commits."
931
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
935
elif len(revision) > 1:
936
raise errors.BzrCommandError(
937
'bzr checkout --revision takes exactly 1 revision value')
938
if branch_location is None:
939
branch_location = osutils.getcwd()
940
to_location = branch_location
941
source = Branch.open(branch_location)
942
if len(revision) == 1 and revision[0] is not None:
943
revision_id = revision[0].in_history(source)[1]
946
if to_location is None:
947
to_location = os.path.basename(branch_location.rstrip("/\\"))
948
# if the source and to_location are the same,
949
# and there is no working tree,
950
# then reconstitute a branch
951
if (osutils.abspath(to_location) ==
952
osutils.abspath(branch_location)):
954
source.bzrdir.open_workingtree()
955
except errors.NoWorkingTree:
956
source.bzrdir.create_workingtree()
959
os.mkdir(to_location)
961
if e.errno == errno.EEXIST:
962
raise errors.BzrCommandError('Target directory "%s" already'
963
' exists.' % to_location)
964
if e.errno == errno.ENOENT:
965
raise errors.BzrCommandError('Parent of "%s" does not exist.'
969
source.create_checkout(to_location, revision_id, lightweight)
972
class cmd_renames(Command):
973
"""Show list of renamed files.
975
# TODO: Option to show renames between two historical versions.
977
# TODO: Only show renames under dir, rather than in the whole branch.
978
takes_args = ['dir?']
981
def run(self, dir=u'.'):
982
tree = WorkingTree.open_containing(dir)[0]
985
new_inv = tree.inventory
986
old_tree = tree.basis_tree()
989
old_inv = old_tree.inventory
990
renames = list(_mod_tree.find_renames(old_inv, new_inv))
992
for old_name, new_name in renames:
993
self.outf.write("%s => %s\n" % (old_name, new_name))
1000
class cmd_update(Command):
1001
"""Update a tree to have the latest code committed to its branch.
1003
This will perform a merge into the working tree, and may generate
1004
conflicts. If you have any local changes, you will still
1005
need to commit them after the update for the update to be complete.
1007
If you want to discard your local changes, you can just do a
1008
'bzr revert' instead of 'bzr commit' after the update.
1010
takes_args = ['dir?']
1013
def run(self, dir='.'):
1014
tree = WorkingTree.open_containing(dir)[0]
1015
master = tree.branch.get_master_branch()
1016
if master is not None:
1019
tree.lock_tree_write()
1021
existing_pending_merges = tree.get_parent_ids()[1:]
1022
last_rev = tree.last_revision()
1023
if last_rev == tree.branch.last_revision():
1024
# may be up to date, check master too.
1025
master = tree.branch.get_master_branch()
1026
if master is None or last_rev == master.last_revision():
1027
revno = tree.branch.revision_id_to_revno(last_rev)
1028
note("Tree is up to date at revision %d." % (revno,))
1030
conflicts = tree.update()
1031
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1032
note('Updated to revision %d.' % (revno,))
1033
if tree.get_parent_ids()[1:] != existing_pending_merges:
1034
note('Your local commits will now show as pending merges with '
1035
"'bzr status', and can be committed with 'bzr commit'.")
1044
class cmd_info(Command):
1045
"""Show information about a working tree, branch or repository.
1047
This command will show all known locations and formats associated to the
1048
tree, branch or repository. Statistical information is included with
1051
Branches and working trees will also report any missing revisions.
1053
takes_args = ['location?']
1054
takes_options = ['verbose']
1057
def run(self, location=None, verbose=False):
1058
from bzrlib.info import show_bzrdir_info
1059
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1063
class cmd_remove(Command):
1064
"""Make a file unversioned.
1066
This makes bzr stop tracking changes to a versioned file. It does
1067
not delete the working copy.
1069
You can specify one or more files, and/or --new. If you specify --new,
1070
only 'added' files will be removed. If you specify both, then new files
1071
in the specified directories will be removed. If the directories are
1072
also new, they will also be removed.
1074
takes_args = ['file*']
1075
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1077
encoding_type = 'replace'
1079
def run(self, file_list, verbose=False, new=False):
1080
tree, file_list = tree_files(file_list)
1082
if file_list is None:
1083
raise errors.BzrCommandError('Specify one or more files to'
1084
' remove, or use --new.')
1086
added = tree.changes_from(tree.basis_tree(),
1087
specific_files=file_list).added
1088
file_list = sorted([f[0] for f in added], reverse=True)
1089
if len(file_list) == 0:
1090
raise errors.BzrCommandError('No matching files.')
1091
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1094
class cmd_file_id(Command):
1095
"""Print file_id of a particular file or directory.
1097
The file_id is assigned when the file is first added and remains the
1098
same through all revisions where the file exists, even when it is
1103
takes_args = ['filename']
1106
def run(self, filename):
1107
tree, relpath = WorkingTree.open_containing(filename)
1108
i = tree.path2id(relpath)
1110
raise errors.NotVersionedError(filename)
1112
self.outf.write(i + '\n')
1115
class cmd_file_path(Command):
1116
"""Print path of file_ids to a file or directory.
1118
This prints one line for each directory down to the target,
1119
starting at the branch root.
1123
takes_args = ['filename']
1126
def run(self, filename):
1127
tree, relpath = WorkingTree.open_containing(filename)
1128
fid = tree.path2id(relpath)
1130
raise errors.NotVersionedError(filename)
1131
segments = osutils.splitpath(relpath)
1132
for pos in range(1, len(segments) + 1):
1133
path = osutils.joinpath(segments[:pos])
1134
self.outf.write("%s\n" % tree.path2id(path))
1137
class cmd_reconcile(Command):
1138
"""Reconcile bzr metadata in a branch.
1140
This can correct data mismatches that may have been caused by
1141
previous ghost operations or bzr upgrades. You should only
1142
need to run this command if 'bzr check' or a bzr developer
1143
advises you to run it.
1145
If a second branch is provided, cross-branch reconciliation is
1146
also attempted, which will check that data like the tree root
1147
id which was not present in very early bzr versions is represented
1148
correctly in both branches.
1150
At the same time it is run it may recompress data resulting in
1151
a potential saving in disk space or performance gain.
1153
The branch *MUST* be on a listable system such as local disk or sftp.
1155
takes_args = ['branch?']
1157
def run(self, branch="."):
1158
from bzrlib.reconcile import reconcile
1159
dir = bzrdir.BzrDir.open(branch)
1163
class cmd_revision_history(Command):
1164
"""Display the list of revision ids on a branch."""
1165
takes_args = ['location?']
1170
def run(self, location="."):
1171
branch = Branch.open_containing(location)[0]
1172
for revid in branch.revision_history():
1173
self.outf.write(revid)
1174
self.outf.write('\n')
1177
class cmd_ancestry(Command):
1178
"""List all revisions merged into this branch."""
1179
takes_args = ['location?']
1184
def run(self, location="."):
1186
wt = WorkingTree.open_containing(location)[0]
1187
except errors.NoWorkingTree:
1188
b = Branch.open(location)
1189
last_revision = b.last_revision()
1192
last_revision = wt.last_revision()
1194
revision_ids = b.repository.get_ancestry(last_revision)
1195
assert revision_ids[0] is None
1197
for revision_id in revision_ids:
1198
self.outf.write(revision_id + '\n')
1201
class cmd_init(Command):
1202
"""Make a directory into a versioned branch.
1204
Use this to create an empty branch, or before importing an
1207
If there is a repository in a parent directory of the location, then
1208
the history of the branch will be stored in the repository. Otherwise
1209
init creates a standalone branch which carries its own history in
1212
If there is already a branch at the location but it has no working tree,
1213
the tree can be populated with 'bzr checkout'.
1215
Recipe for importing a tree of files:
1220
bzr commit -m 'imported project'
1222
takes_args = ['location?']
1224
RegistryOption('format',
1225
help='Specify a format for this branch. '
1226
'See "help formats".',
1227
registry=bzrdir.format_registry,
1228
converter=bzrdir.format_registry.make_bzrdir,
1229
value_switches=True,
1230
title="Branch Format",
1232
Option('append-revisions-only',
1233
help='Never change revnos or the existing log.'
1234
' Append revisions to it only.')
1236
def run(self, location=None, format=None, append_revisions_only=False):
1238
format = bzrdir.format_registry.make_bzrdir('default')
1239
if location is None:
1242
to_transport = transport.get_transport(location)
1244
# The path has to exist to initialize a
1245
# branch inside of it.
1246
# Just using os.mkdir, since I don't
1247
# believe that we want to create a bunch of
1248
# locations if the user supplies an extended path
1249
# TODO: create-prefix
1251
to_transport.mkdir('.')
1252
except errors.FileExists:
1256
existing_bzrdir = bzrdir.BzrDir.open(location)
1257
except errors.NotBranchError:
1258
# really a NotBzrDir error...
1259
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1262
from bzrlib.transport.local import LocalTransport
1263
if existing_bzrdir.has_branch():
1264
if (isinstance(to_transport, LocalTransport)
1265
and not existing_bzrdir.has_workingtree()):
1266
raise errors.BranchExistsWithoutWorkingTree(location)
1267
raise errors.AlreadyBranchError(location)
1269
branch = existing_bzrdir.create_branch()
1270
existing_bzrdir.create_workingtree()
1271
if append_revisions_only:
1273
branch.set_append_revisions_only(True)
1274
except errors.UpgradeRequired:
1275
raise errors.BzrCommandError('This branch format cannot be set'
1276
' to append-revisions-only. Try --experimental-branch6')
1279
class cmd_init_repository(Command):
1280
"""Create a shared repository to hold branches.
1282
New branches created under the repository directory will store their revisions
1283
in the repository, not in the branch directory, if the branch format supports
1289
bzr checkout --lightweight repo/trunk trunk-checkout
1293
takes_args = ["location"]
1294
takes_options = [RegistryOption('format',
1295
help='Specify a format for this repository. See'
1296
' "bzr help formats" for details',
1297
registry=bzrdir.format_registry,
1298
converter=bzrdir.format_registry.make_bzrdir,
1299
value_switches=True, title='Repository format'),
1301
help='Allows branches in repository to have'
1303
aliases = ["init-repo"]
1304
def run(self, location, format=None, trees=False):
1306
format = bzrdir.format_registry.make_bzrdir('default')
1308
if location is None:
1311
to_transport = transport.get_transport(location)
1313
to_transport.mkdir('.')
1314
except errors.FileExists:
1317
newdir = format.initialize_on_transport(to_transport)
1318
repo = newdir.create_repository(shared=True)
1319
repo.set_make_working_trees(trees)
1322
class cmd_diff(Command):
1323
"""Show differences in the working tree or between revisions.
1325
If files are listed, only the changes in those files are listed.
1326
Otherwise, all changes for the tree are listed.
1328
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1329
produces patches suitable for "patch -p1".
1333
Shows the difference in the working tree versus the last commit
1335
Difference between the working tree and revision 1
1337
Difference between revision 2 and revision 1
1338
bzr diff --diff-prefix old/:new/
1339
Same as 'bzr diff' but prefix paths with old/ and new/
1340
bzr diff bzr.mine bzr.dev
1341
Show the differences between the two working trees
1343
Show just the differences for 'foo.c'
1345
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1346
# or a graphical diff.
1348
# TODO: Python difflib is not exactly the same as unidiff; should
1349
# either fix it up or prefer to use an external diff.
1351
# TODO: Selected-file diff is inefficient and doesn't show you
1354
# TODO: This probably handles non-Unix newlines poorly.
1356
takes_args = ['file*']
1357
takes_options = ['revision', 'diff-options',
1358
Option('prefix', type=str,
1360
help='Set prefixes to added to old and new filenames, as '
1361
'two values separated by a colon.'),
1363
aliases = ['di', 'dif']
1364
encoding_type = 'exact'
1367
def run(self, revision=None, file_list=None, diff_options=None,
1369
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1371
if (prefix is None) or (prefix == '0'):
1379
old_label, new_label = prefix.split(":")
1381
raise BzrCommandError(
1382
"--prefix expects two values separated by a colon")
1384
if revision and len(revision) > 2:
1385
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1386
' one or two revision specifiers')
1389
tree1, file_list = internal_tree_files(file_list)
1393
except errors.FileInWrongBranch:
1394
if len(file_list) != 2:
1395
raise errors.BzrCommandError("Files are in different branches")
1397
tree1, file1 = WorkingTree.open_containing(file_list[0])
1398
tree2, file2 = WorkingTree.open_containing(file_list[1])
1399
if file1 != "" or file2 != "":
1400
# FIXME diff those two files. rbc 20051123
1401
raise errors.BzrCommandError("Files are in different branches")
1403
except errors.NotBranchError:
1404
if (revision is not None and len(revision) == 2
1405
and not revision[0].needs_branch()
1406
and not revision[1].needs_branch()):
1407
# If both revision specs include a branch, we can
1408
# diff them without needing a local working tree
1409
tree1, tree2 = None, None
1413
if tree2 is not None:
1414
if revision is not None:
1415
# FIXME: but there should be a clean way to diff between
1416
# non-default versions of two trees, it's not hard to do
1418
raise errors.BzrCommandError(
1419
"Sorry, diffing arbitrary revisions across branches "
1420
"is not implemented yet")
1421
return show_diff_trees(tree1, tree2, sys.stdout,
1422
specific_files=file_list,
1423
external_diff_options=diff_options,
1424
old_label=old_label, new_label=new_label)
1426
return diff_cmd_helper(tree1, file_list, diff_options,
1427
revision_specs=revision,
1428
old_label=old_label, new_label=new_label)
1431
class cmd_deleted(Command):
1432
"""List files deleted in the working tree.
1434
# TODO: Show files deleted since a previous revision, or
1435
# between two revisions.
1436
# TODO: Much more efficient way to do this: read in new
1437
# directories with readdir, rather than stating each one. Same
1438
# level of effort but possibly much less IO. (Or possibly not,
1439
# if the directories are very large...)
1440
takes_options = ['show-ids']
1443
def run(self, show_ids=False):
1444
tree = WorkingTree.open_containing(u'.')[0]
1447
old = tree.basis_tree()
1450
for path, ie in old.inventory.iter_entries():
1451
if not tree.has_id(ie.file_id):
1452
self.outf.write(path)
1454
self.outf.write(' ')
1455
self.outf.write(ie.file_id)
1456
self.outf.write('\n')
1463
class cmd_modified(Command):
1464
"""List files modified in working tree.
1466
See also: "bzr status".
1473
tree = WorkingTree.open_containing(u'.')[0]
1474
td = tree.changes_from(tree.basis_tree())
1475
for path, id, kind, text_modified, meta_modified in td.modified:
1476
self.outf.write(path + '\n')
1479
class cmd_added(Command):
1480
"""List files added in working tree.
1482
See also: "bzr status".
1489
wt = WorkingTree.open_containing(u'.')[0]
1492
basis = wt.basis_tree()
1495
basis_inv = basis.inventory
1498
if file_id in basis_inv:
1500
if inv.is_root(file_id) and len(basis_inv) == 0:
1502
path = inv.id2path(file_id)
1503
if not os.access(osutils.abspath(path), os.F_OK):
1505
self.outf.write(path + '\n')
1512
class cmd_root(Command):
1513
"""Show the tree root directory.
1515
The root is the nearest enclosing directory with a .bzr control
1517
takes_args = ['filename?']
1519
def run(self, filename=None):
1520
"""Print the branch root."""
1521
tree = WorkingTree.open_containing(filename)[0]
1522
self.outf.write(tree.basedir + '\n')
1525
class cmd_log(Command):
1526
"""Show log of a branch, file, or directory.
1528
By default show the log of the branch containing the working directory.
1530
To request a range of logs, you can use the command -r begin..end
1531
-r revision requests a specific revision, -r ..end or -r begin.. are
1537
bzr log -r -10.. http://server/branch
1540
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1542
takes_args = ['location?']
1543
takes_options = [Option('forward',
1544
help='show from oldest to newest'),
1548
help='show files changed in each revision'),
1549
'show-ids', 'revision',
1553
help='show revisions whose message matches this regexp',
1556
encoding_type = 'replace'
1559
def run(self, location=None, timezone='original',
1566
from bzrlib.log import show_log
1567
assert message is None or isinstance(message, basestring), \
1568
"invalid message argument %r" % message
1569
direction = (forward and 'forward') or 'reverse'
1574
# find the file id to log:
1576
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1580
tree = b.basis_tree()
1581
file_id = tree.path2id(fp)
1583
raise errors.BzrCommandError(
1584
"Path does not have any revision history: %s" %
1588
# FIXME ? log the current subdir only RBC 20060203
1589
if revision is not None \
1590
and len(revision) > 0 and revision[0].get_branch():
1591
location = revision[0].get_branch()
1594
dir, relpath = bzrdir.BzrDir.open_containing(location)
1595
b = dir.open_branch()
1599
if revision is None:
1602
elif len(revision) == 1:
1603
rev1 = rev2 = revision[0].in_history(b).revno
1604
elif len(revision) == 2:
1605
if revision[1].get_branch() != revision[0].get_branch():
1606
# b is taken from revision[0].get_branch(), and
1607
# show_log will use its revision_history. Having
1608
# different branches will lead to weird behaviors.
1609
raise errors.BzrCommandError(
1610
"Log doesn't accept two revisions in different"
1612
if revision[0].spec is None:
1613
# missing begin-range means first revision
1616
rev1 = revision[0].in_history(b).revno
1618
if revision[1].spec is None:
1619
# missing end-range means last known revision
1622
rev2 = revision[1].in_history(b).revno
1624
raise errors.BzrCommandError(
1625
'bzr log --revision takes one or two values.')
1627
# By this point, the revision numbers are converted to the +ve
1628
# form if they were supplied in the -ve form, so we can do
1629
# this comparison in relative safety
1631
(rev2, rev1) = (rev1, rev2)
1633
if log_format is None:
1634
log_format = log.log_formatter_registry.get_default(b)
1636
lf = log_format(show_ids=show_ids, to_file=self.outf,
1637
show_timezone=timezone)
1643
direction=direction,
1644
start_revision=rev1,
1651
def get_log_format(long=False, short=False, line=False, default='long'):
1652
log_format = default
1656
log_format = 'short'
1662
class cmd_touching_revisions(Command):
1663
"""Return revision-ids which affected a particular file.
1665
A more user-friendly interface is "bzr log FILE".
1669
takes_args = ["filename"]
1672
def run(self, filename):
1673
tree, relpath = WorkingTree.open_containing(filename)
1675
file_id = tree.path2id(relpath)
1676
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1677
self.outf.write("%6d %s\n" % (revno, what))
1680
class cmd_ls(Command):
1681
"""List files in a tree.
1684
takes_args = ['path?']
1685
# TODO: Take a revision or remote path and list that tree instead.
1686
takes_options = ['verbose', 'revision',
1687
Option('non-recursive',
1688
help='don\'t recurse into sub-directories'),
1690
help='Print all paths from the root of the branch.'),
1691
Option('unknown', help='Print unknown files'),
1692
Option('versioned', help='Print versioned files'),
1693
Option('ignored', help='Print ignored files'),
1695
Option('null', help='Null separate the files'),
1699
def run(self, revision=None, verbose=False,
1700
non_recursive=False, from_root=False,
1701
unknown=False, versioned=False, ignored=False,
1702
null=False, kind=None, show_ids=False, path=None):
1704
if kind and kind not in ('file', 'directory', 'symlink'):
1705
raise errors.BzrCommandError('invalid kind specified')
1707
if verbose and null:
1708
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1709
all = not (unknown or versioned or ignored)
1711
selection = {'I':ignored, '?':unknown, 'V':versioned}
1718
raise errors.BzrCommandError('cannot specify both --from-root'
1722
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1728
if revision is not None:
1729
tree = branch.repository.revision_tree(
1730
revision[0].in_history(branch).rev_id)
1732
tree = branch.basis_tree()
1736
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1737
if fp.startswith(relpath):
1738
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1739
if non_recursive and '/' in fp:
1741
if not all and not selection[fc]:
1743
if kind is not None and fkind != kind:
1746
kindch = entry.kind_character()
1747
outstring = '%-8s %s%s' % (fc, fp, kindch)
1748
if show_ids and fid is not None:
1749
outstring = "%-50s %s" % (outstring, fid)
1750
self.outf.write(outstring + '\n')
1752
self.outf.write(fp + '\0')
1755
self.outf.write(fid)
1756
self.outf.write('\0')
1764
self.outf.write('%-50s %s\n' % (fp, my_id))
1766
self.outf.write(fp + '\n')
1771
class cmd_unknowns(Command):
1772
"""List unknown files.
1774
See also: "bzr ls --unknown".
1781
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1782
self.outf.write(osutils.quotefn(f) + '\n')
1785
class cmd_ignore(Command):
1786
"""Ignore specified files or patterns.
1788
To remove patterns from the ignore list, edit the .bzrignore file.
1790
Trailing slashes on patterns are ignored.
1791
If the pattern contains a slash or is a regular expression, it is compared
1792
to the whole path from the branch root. Otherwise, it is compared to only
1793
the last component of the path. To match a file only in the root
1794
directory, prepend './'.
1796
Ignore patterns specifying absolute paths are not allowed.
1798
Ignore patterns may include globbing wildcards such as:
1799
? - Matches any single character except '/'
1800
* - Matches 0 or more characters except '/'
1801
/**/ - Matches 0 or more directories in a path
1802
[a-z] - Matches a single character from within a group of characters
1804
Ignore patterns may also be Python regular expressions.
1805
Regular expression ignore patterns are identified by a 'RE:' prefix
1806
followed by the regular expression. Regular expression ignore patterns
1807
may not include named or numbered groups.
1809
Note: ignore patterns containing shell wildcards must be quoted from
1813
bzr ignore ./Makefile
1814
bzr ignore '*.class'
1815
bzr ignore 'lib/**/*.o'
1816
bzr ignore 'RE:lib/.*\.o'
1818
takes_args = ['name_pattern*']
1820
Option('old-default-rules',
1821
help='Out the ignore rules bzr < 0.9 always used.')
1824
def run(self, name_pattern_list=None, old_default_rules=None):
1825
from bzrlib.atomicfile import AtomicFile
1826
if old_default_rules is not None:
1827
# dump the rules and exit
1828
for pattern in ignores.OLD_DEFAULTS:
1831
if not name_pattern_list:
1832
raise errors.BzrCommandError("ignore requires at least one "
1833
"NAME_PATTERN or --old-default-rules")
1834
for name_pattern in name_pattern_list:
1835
if name_pattern[0] == '/':
1836
raise errors.BzrCommandError(
1837
"NAME_PATTERN should not be an absolute path")
1838
tree, relpath = WorkingTree.open_containing(u'.')
1839
ifn = tree.abspath('.bzrignore')
1840
if os.path.exists(ifn):
1843
igns = f.read().decode('utf-8')
1849
# TODO: If the file already uses crlf-style termination, maybe
1850
# we should use that for the newly added lines?
1852
if igns and igns[-1] != '\n':
1854
for name_pattern in name_pattern_list:
1855
igns += name_pattern.rstrip('/') + '\n'
1857
f = AtomicFile(ifn, 'wb')
1859
f.write(igns.encode('utf-8'))
1864
if not tree.path2id('.bzrignore'):
1865
tree.add(['.bzrignore'])
1868
class cmd_ignored(Command):
1869
"""List ignored files and the patterns that matched them.
1871
See also: bzr ignore"""
1874
tree = WorkingTree.open_containing(u'.')[0]
1877
for path, file_class, kind, file_id, entry in tree.list_files():
1878
if file_class != 'I':
1880
## XXX: Slightly inefficient since this was already calculated
1881
pat = tree.is_ignored(path)
1882
print '%-50s %s' % (path, pat)
1887
class cmd_lookup_revision(Command):
1888
"""Lookup the revision-id from a revision-number
1891
bzr lookup-revision 33
1894
takes_args = ['revno']
1897
def run(self, revno):
1901
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1903
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1906
class cmd_export(Command):
1907
"""Export past revision to destination directory.
1909
If no revision is specified this exports the last committed revision.
1911
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1912
given, try to find the format with the extension. If no extension
1913
is found exports to a directory (equivalent to --format=dir).
1915
Root may be the top directory for tar, tgz and tbz2 formats. If none
1916
is given, the top directory will be the root name of the file.
1918
If branch is omitted then the branch containing the CWD will be used.
1920
Note: export of tree with non-ascii filenames to zip is not supported.
1922
Supported formats Autodetected by extension
1923
----------------- -------------------------
1926
tbz2 .tar.bz2, .tbz2
1930
takes_args = ['dest', 'branch?']
1931
takes_options = ['revision', 'format', 'root']
1932
def run(self, dest, branch=None, revision=None, format=None, root=None):
1933
from bzrlib.export import export
1936
tree = WorkingTree.open_containing(u'.')[0]
1939
b = Branch.open(branch)
1941
if revision is None:
1942
# should be tree.last_revision FIXME
1943
rev_id = b.last_revision()
1945
if len(revision) != 1:
1946
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1947
rev_id = revision[0].in_history(b).rev_id
1948
t = b.repository.revision_tree(rev_id)
1950
export(t, dest, format, root)
1951
except errors.NoSuchExportFormat, e:
1952
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1955
class cmd_cat(Command):
1956
"""Write a file's text from a previous revision."""
1958
takes_options = ['revision', 'name-from-revision']
1959
takes_args = ['filename']
1960
encoding_type = 'exact'
1963
def run(self, filename, revision=None, name_from_revision=False):
1964
if revision is not None and len(revision) != 1:
1965
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1970
tree, b, relpath = \
1971
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
1972
except errors.NotBranchError:
1975
if revision is not None and revision[0].get_branch() is not None:
1976
b = Branch.open(revision[0].get_branch())
1978
tree = b.basis_tree()
1979
if revision is None:
1980
revision_id = b.last_revision()
1982
revision_id = revision[0].in_history(b).rev_id
1984
cur_file_id = tree.path2id(relpath)
1985
rev_tree = b.repository.revision_tree(revision_id)
1986
old_file_id = rev_tree.path2id(relpath)
1988
if name_from_revision:
1989
if old_file_id is None:
1990
raise errors.BzrCommandError("%r is not present in revision %s"
1991
% (filename, revision_id))
1993
rev_tree.print_file(old_file_id)
1994
elif cur_file_id is not None:
1995
rev_tree.print_file(cur_file_id)
1996
elif old_file_id is not None:
1997
rev_tree.print_file(old_file_id)
1999
raise errors.BzrCommandError("%r is not present in revision %s" %
2000
(filename, revision_id))
2003
class cmd_local_time_offset(Command):
2004
"""Show the offset in seconds from GMT to local time."""
2008
print osutils.local_time_offset()
2012
class cmd_commit(Command):
2013
"""Commit changes into a new revision.
2015
If no arguments are given, the entire tree is committed.
2017
If selected files are specified, only changes to those files are
2018
committed. If a directory is specified then the directory and everything
2019
within it is committed.
2021
A selected-file commit may fail in some cases where the committed
2022
tree would be invalid, such as trying to commit a file in a
2023
newly-added directory that is not itself committed.
2025
# TODO: Run hooks on tree to-be-committed, and after commit.
2027
# TODO: Strict commit that fails if there are deleted files.
2028
# (what does "deleted files" mean ??)
2030
# TODO: Give better message for -s, --summary, used by tla people
2032
# XXX: verbose currently does nothing
2034
takes_args = ['selected*']
2035
takes_options = ['message', 'verbose',
2037
help='commit even if nothing has changed'),
2038
Option('file', type=str,
2041
help='file containing commit message'),
2043
help="refuse to commit if there are unknown "
2044
"files in the working tree."),
2046
help="perform a local only commit in a bound "
2047
"branch. Such commits are not pushed to "
2048
"the master branch until a normal commit "
2052
aliases = ['ci', 'checkin']
2054
def run(self, message=None, file=None, verbose=True, selected_list=None,
2055
unchanged=False, strict=False, local=False):
2056
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2057
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2059
from bzrlib.msgeditor import edit_commit_message, \
2060
make_commit_message_template
2062
# TODO: Need a blackbox test for invoking the external editor; may be
2063
# slightly problematic to run this cross-platform.
2065
# TODO: do more checks that the commit will succeed before
2066
# spending the user's valuable time typing a commit message.
2067
tree, selected_list = tree_files(selected_list)
2068
if selected_list == ['']:
2069
# workaround - commit of root of tree should be exactly the same
2070
# as just default commit in that tree, and succeed even though
2071
# selected-file merge commit is not done yet
2074
if local and not tree.branch.get_bound_location():
2075
raise errors.LocalRequiresBoundBranch()
2077
def get_message(commit_obj):
2078
"""Callback to get commit message"""
2079
my_message = message
2080
if my_message is None and not file:
2081
template = make_commit_message_template(tree, selected_list)
2082
my_message = edit_commit_message(template)
2083
if my_message is None:
2084
raise errors.BzrCommandError("please specify a commit"
2085
" message with either --message or --file")
2086
elif my_message and file:
2087
raise errors.BzrCommandError(
2088
"please specify either --message or --file")
2090
my_message = codecs.open(file, 'rt',
2091
bzrlib.user_encoding).read()
2092
if my_message == "":
2093
raise errors.BzrCommandError("empty commit message specified")
2097
reporter = ReportCommitToLog()
2099
reporter = NullCommitReporter()
2102
tree.commit(message_callback=get_message,
2103
specific_files=selected_list,
2104
allow_pointless=unchanged, strict=strict, local=local,
2106
except PointlessCommit:
2107
# FIXME: This should really happen before the file is read in;
2108
# perhaps prepare the commit; get the message; then actually commit
2109
raise errors.BzrCommandError("no changes to commit."
2110
" use --unchanged to commit anyhow")
2111
except ConflictsInTree:
2112
raise errors.BzrCommandError('Conflicts detected in working '
2113
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2115
except StrictCommitFailed:
2116
raise errors.BzrCommandError("Commit refused because there are"
2117
" unknown files in the working tree.")
2118
except errors.BoundBranchOutOfDate, e:
2119
raise errors.BzrCommandError(str(e) + "\n"
2120
'To commit to master branch, run update and then commit.\n'
2121
'You can also pass --local to commit to continue working '
2125
class cmd_check(Command):
2126
"""Validate consistency of branch history.
2128
This command checks various invariants about the branch storage to
2129
detect data corruption or bzr bugs.
2131
takes_args = ['branch?']
2132
takes_options = ['verbose']
2134
def run(self, branch=None, verbose=False):
2135
from bzrlib.check import check
2137
tree = WorkingTree.open_containing()[0]
2138
branch = tree.branch
2140
branch = Branch.open(branch)
2141
check(branch, verbose)
2144
class cmd_upgrade(Command):
2145
"""Upgrade branch storage to current format.
2147
The check command or bzr developers may sometimes advise you to run
2148
this command. When the default format has changed you may also be warned
2149
during other operations to upgrade.
2151
takes_args = ['url?']
2153
RegistryOption('format',
2154
help='Upgrade to a specific format. See "bzr help'
2155
' formats" for details',
2156
registry=bzrdir.format_registry,
2157
converter=bzrdir.format_registry.make_bzrdir,
2158
value_switches=True, title='Branch format'),
2162
def run(self, url='.', format=None):
2163
from bzrlib.upgrade import upgrade
2165
format = bzrdir.format_registry.make_bzrdir('default')
2166
upgrade(url, format)
2169
class cmd_whoami(Command):
2170
"""Show or set bzr user id.
2174
bzr whoami 'Frank Chu <fchu@example.com>'
2176
takes_options = [ Option('email',
2177
help='display email address only'),
2179
help='set identity for the current branch instead of '
2182
takes_args = ['name?']
2183
encoding_type = 'replace'
2186
def run(self, email=False, branch=False, name=None):
2188
# use branch if we're inside one; otherwise global config
2190
c = Branch.open_containing('.')[0].get_config()
2191
except errors.NotBranchError:
2192
c = config.GlobalConfig()
2194
self.outf.write(c.user_email() + '\n')
2196
self.outf.write(c.username() + '\n')
2199
# display a warning if an email address isn't included in the given name.
2201
config.extract_email_address(name)
2202
except errors.NoEmailInUsername, e:
2203
warning('"%s" does not seem to contain an email address. '
2204
'This is allowed, but not recommended.', name)
2206
# use global config unless --branch given
2208
c = Branch.open_containing('.')[0].get_config()
2210
c = config.GlobalConfig()
2211
c.set_user_option('email', name)
2214
class cmd_nick(Command):
2215
"""Print or set the branch nickname.
2217
If unset, the tree root directory name is used as the nickname
2218
To print the current nickname, execute with no argument.
2220
takes_args = ['nickname?']
2221
def run(self, nickname=None):
2222
branch = Branch.open_containing(u'.')[0]
2223
if nickname is None:
2224
self.printme(branch)
2226
branch.nick = nickname
2229
def printme(self, branch):
2233
class cmd_selftest(Command):
2234
"""Run internal test suite.
2236
This creates temporary test directories in the working directory, but not
2237
existing data is affected. These directories are deleted if the tests
2238
pass, or left behind to help in debugging if they fail and --keep-output
2241
If arguments are given, they are regular expressions that say which tests
2242
should run. Tests matching any expression are run, and other tests are
2245
Alternatively if --first is given, matching tests are run first and then
2246
all other tests are run. This is useful if you have been working in a
2247
particular area, but want to make sure nothing else was broken.
2249
If the global option '--no-plugins' is given, plugins are not loaded
2250
before running the selftests. This has two effects: features provided or
2251
modified by plugins will not be tested, and tests provided by plugins will
2256
run only tests relating to 'ignore'
2257
bzr --no-plugins selftest -v
2258
disable plugins and list tests as they're run
2260
# TODO: --list should give a list of all available tests
2262
# NB: this is used from the class without creating an instance, which is
2263
# why it does not have a self parameter.
2264
def get_transport_type(typestring):
2265
"""Parse and return a transport specifier."""
2266
if typestring == "sftp":
2267
from bzrlib.transport.sftp import SFTPAbsoluteServer
2268
return SFTPAbsoluteServer
2269
if typestring == "memory":
2270
from bzrlib.transport.memory import MemoryServer
2272
if typestring == "fakenfs":
2273
from bzrlib.transport.fakenfs import FakeNFSServer
2274
return FakeNFSServer
2275
msg = "No known transport type %s. Supported types are: sftp\n" %\
2277
raise errors.BzrCommandError(msg)
2280
takes_args = ['testspecs*']
2281
takes_options = ['verbose',
2282
Option('one', help='stop when one test fails'),
2283
Option('keep-output',
2284
help='keep output directories when tests fail'),
2286
help='Use a different transport by default '
2287
'throughout the test suite.',
2288
type=get_transport_type),
2289
Option('benchmark', help='run the bzr bencharks.'),
2290
Option('lsprof-timed',
2291
help='generate lsprof output for benchmarked'
2292
' sections of code.'),
2293
Option('cache-dir', type=str,
2294
help='a directory to cache intermediate'
2295
' benchmark steps'),
2296
Option('clean-output',
2297
help='clean temporary tests directories'
2298
' without running tests'),
2300
help='run all tests, but run specified tests first',
2303
encoding_type = 'replace'
2305
def run(self, testspecs_list=None, verbose=None, one=False,
2306
keep_output=False, transport=None, benchmark=None,
2307
lsprof_timed=None, cache_dir=None, clean_output=False,
2310
from bzrlib.tests import selftest
2311
import bzrlib.benchmarks as benchmarks
2312
from bzrlib.benchmarks import tree_creator
2315
from bzrlib.tests import clean_selftest_output
2316
clean_selftest_output()
2319
if cache_dir is not None:
2320
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2321
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2322
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2324
if testspecs_list is not None:
2325
pattern = '|'.join(testspecs_list)
2329
test_suite_factory = benchmarks.test_suite
2332
# TODO: should possibly lock the history file...
2333
benchfile = open(".perf_history", "at", buffering=1)
2335
test_suite_factory = None
2340
result = selftest(verbose=verbose,
2342
stop_on_failure=one,
2343
keep_output=keep_output,
2344
transport=transport,
2345
test_suite_factory=test_suite_factory,
2346
lsprof_timed=lsprof_timed,
2347
bench_history=benchfile,
2348
matching_tests_first=first,
2351
if benchfile is not None:
2354
info('tests passed')
2356
info('tests failed')
2357
return int(not result)
2360
class cmd_version(Command):
2361
"""Show version of bzr."""
2365
from bzrlib.version import show_version
2369
class cmd_rocks(Command):
2370
"""Statement of optimism."""
2376
print "It sure does!"
2379
class cmd_find_merge_base(Command):
2380
"""Find and print a base revision for merging two branches."""
2381
# TODO: Options to specify revisions on either side, as if
2382
# merging only part of the history.
2383
takes_args = ['branch', 'other']
2387
def run(self, branch, other):
2388
from bzrlib.revision import MultipleRevisionSources
2390
branch1 = Branch.open_containing(branch)[0]
2391
branch2 = Branch.open_containing(other)[0]
2393
last1 = branch1.last_revision()
2394
last2 = branch2.last_revision()
2396
source = MultipleRevisionSources(branch1.repository,
2399
base_rev_id = common_ancestor(last1, last2, source)
2401
print 'merge base is revision %s' % base_rev_id
2404
class cmd_merge(Command):
2405
"""Perform a three-way merge.
2407
The branch is the branch you will merge from. By default, it will merge
2408
the latest revision. If you specify a revision, that revision will be
2409
merged. If you specify two revisions, the first will be used as a BASE,
2410
and the second one as OTHER. Revision numbers are always relative to the
2413
By default, bzr will try to merge in all new work from the other
2414
branch, automatically determining an appropriate base. If this
2415
fails, you may need to give an explicit base.
2417
Merge will do its best to combine the changes in two branches, but there
2418
are some kinds of problems only a human can fix. When it encounters those,
2419
it will mark a conflict. A conflict means that you need to fix something,
2420
before you should commit.
2422
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2424
If there is no default branch set, the first merge will set it. After
2425
that, you can omit the branch to use the default. To change the
2426
default, use --remember. The value will only be saved if the remote
2427
location can be accessed.
2429
The results of the merge are placed into the destination working
2430
directory, where they can be reviewed (with bzr diff), tested, and then
2431
committed to record the result of the merge.
2435
To merge the latest revision from bzr.dev
2436
bzr merge ../bzr.dev
2438
To merge changes up to and including revision 82 from bzr.dev
2439
bzr merge -r 82 ../bzr.dev
2441
To merge the changes introduced by 82, without previous changes:
2442
bzr merge -r 81..82 ../bzr.dev
2444
merge refuses to run if there are any uncommitted changes, unless
2447
The following merge types are available:
2449
takes_args = ['branch?']
2450
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2451
Option('show-base', help="Show base revision text in "
2453
Option('uncommitted', help='Apply uncommitted changes'
2454
' from a working copy, instead of branch changes'),
2455
Option('pull', help='If the destination is already'
2456
' completely merged into the source, pull from the'
2457
' source rather than merging. When this happens,'
2458
' you do not need to commit the result.'),
2460
help='Branch to merge into, '
2461
'rather than the one containing the working directory',
2467
def run(self, branch=None, revision=None, force=False, merge_type=None,
2468
show_base=False, reprocess=False, remember=False,
2469
uncommitted=False, pull=False,
2472
from bzrlib.tag import _merge_tags_if_possible
2473
if merge_type is None:
2474
merge_type = _mod_merge.Merge3Merger
2476
if directory is None: directory = u'.'
2477
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2478
# inventory. Because merge is a mutating operation, it really
2479
# should be a lock_write() for the whole cmd_merge operation.
2480
# However, cmd_merge open's its own tree in _merge_helper, which
2481
# means if we lock here, the later lock_write() will always block.
2482
# Either the merge helper code should be updated to take a tree,
2483
# (What about tree.merge_from_branch?)
2484
tree = WorkingTree.open_containing(directory)[0]
2485
change_reporter = delta.ChangeReporter(
2486
unversioned_filter=tree.is_ignored)
2488
if branch is not None:
2490
reader = bundle.read_bundle_from_url(branch)
2491
except errors.NotABundle:
2492
pass # Continue on considering this url a Branch
2494
conflicts = merge_bundle(reader, tree, not force, merge_type,
2495
reprocess, show_base, change_reporter)
2501
if revision is None \
2502
or len(revision) < 1 or revision[0].needs_branch():
2503
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2505
if revision is None or len(revision) < 1:
2508
other = [branch, None]
2511
other = [branch, -1]
2512
other_branch, path = Branch.open_containing(branch)
2515
raise errors.BzrCommandError('Cannot use --uncommitted and'
2516
' --revision at the same time.')
2517
branch = revision[0].get_branch() or branch
2518
if len(revision) == 1:
2520
other_branch, path = Branch.open_containing(branch)
2521
revno = revision[0].in_history(other_branch).revno
2522
other = [branch, revno]
2524
assert len(revision) == 2
2525
if None in revision:
2526
raise errors.BzrCommandError(
2527
"Merge doesn't permit empty revision specifier.")
2528
base_branch, path = Branch.open_containing(branch)
2529
branch1 = revision[1].get_branch() or branch
2530
other_branch, path1 = Branch.open_containing(branch1)
2531
if revision[0].get_branch() is not None:
2532
# then path was obtained from it, and is None.
2535
base = [branch, revision[0].in_history(base_branch).revno]
2536
other = [branch1, revision[1].in_history(other_branch).revno]
2538
if tree.branch.get_parent() is None or remember:
2539
tree.branch.set_parent(other_branch.base)
2541
# pull tags now... it's a bit inconsistent to do it ahead of copying
2542
# the history but that's done inside the merge code
2543
_merge_tags_if_possible(other_branch, tree.branch)
2546
interesting_files = [path]
2548
interesting_files = None
2549
pb = ui.ui_factory.nested_progress_bar()
2552
conflict_count = _merge_helper(
2553
other, base, check_clean=(not force),
2554
merge_type=merge_type,
2555
reprocess=reprocess,
2556
show_base=show_base,
2559
pb=pb, file_list=interesting_files,
2560
change_reporter=change_reporter)
2563
if conflict_count != 0:
2567
except errors.AmbiguousBase, e:
2568
m = ("sorry, bzr can't determine the right merge base yet\n"
2569
"candidates are:\n "
2570
+ "\n ".join(e.bases)
2572
"please specify an explicit base with -r,\n"
2573
"and (if you want) report this to the bzr developers\n")
2576
# TODO: move up to common parent; this isn't merge-specific anymore.
2577
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2578
"""Use tree.branch's parent if none was supplied.
2580
Report if the remembered location was used.
2582
if supplied_location is not None:
2583
return supplied_location
2584
stored_location = tree.branch.get_parent()
2585
mutter("%s", stored_location)
2586
if stored_location is None:
2587
raise errors.BzrCommandError("No location specified or remembered")
2588
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2589
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2590
return stored_location
2593
class cmd_remerge(Command):
2596
Use this if you want to try a different merge technique while resolving
2597
conflicts. Some merge techniques are better than others, and remerge
2598
lets you try different ones on different files.
2600
The options for remerge have the same meaning and defaults as the ones for
2601
merge. The difference is that remerge can (only) be run when there is a
2602
pending merge, and it lets you specify particular files.
2605
$ bzr remerge --show-base
2606
Re-do the merge of all conflicted files, and show the base text in
2607
conflict regions, in addition to the usual THIS and OTHER texts.
2609
$ bzr remerge --merge-type weave --reprocess foobar
2610
Re-do the merge of "foobar", using the weave merge algorithm, with
2611
additional processing to reduce the size of conflict regions.
2613
The following merge types are available:"""
2614
takes_args = ['file*']
2615
takes_options = ['merge-type', 'reprocess',
2616
Option('show-base', help="Show base revision text in "
2619
def run(self, file_list=None, merge_type=None, show_base=False,
2621
if merge_type is None:
2622
merge_type = _mod_merge.Merge3Merger
2623
tree, file_list = tree_files(file_list)
2626
parents = tree.get_parent_ids()
2627
if len(parents) != 2:
2628
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2629
" merges. Not cherrypicking or"
2631
repository = tree.branch.repository
2632
base_revision = common_ancestor(parents[0],
2633
parents[1], repository)
2634
base_tree = repository.revision_tree(base_revision)
2635
other_tree = repository.revision_tree(parents[1])
2636
interesting_ids = None
2638
conflicts = tree.conflicts()
2639
if file_list is not None:
2640
interesting_ids = set()
2641
for filename in file_list:
2642
file_id = tree.path2id(filename)
2644
raise errors.NotVersionedError(filename)
2645
interesting_ids.add(file_id)
2646
if tree.kind(file_id) != "directory":
2649
for name, ie in tree.inventory.iter_entries(file_id):
2650
interesting_ids.add(ie.file_id)
2651
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2653
# Remerge only supports resolving contents conflicts
2654
allowed_conflicts = ('text conflict', 'contents conflict')
2655
restore_files = [c.path for c in conflicts
2656
if c.typestring in allowed_conflicts]
2657
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2658
tree.set_conflicts(ConflictList(new_conflicts))
2659
if file_list is not None:
2660
restore_files = file_list
2661
for filename in restore_files:
2663
restore(tree.abspath(filename))
2664
except errors.NotConflicted:
2666
conflicts = _mod_merge.merge_inner(
2667
tree.branch, other_tree, base_tree,
2669
interesting_ids=interesting_ids,
2670
other_rev_id=parents[1],
2671
merge_type=merge_type,
2672
show_base=show_base,
2673
reprocess=reprocess)
2682
class cmd_revert(Command):
2683
"""Revert files to a previous revision.
2685
Giving a list of files will revert only those files. Otherwise, all files
2686
will be reverted. If the revision is not specified with '--revision', the
2687
last committed revision is used.
2689
To remove only some changes, without reverting to a prior version, use
2690
merge instead. For example, "merge . --r-2..-3" will remove the changes
2691
introduced by -2, without affecting the changes introduced by -1. Or
2692
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2694
By default, any files that have been manually changed will be backed up
2695
first. (Files changed only by merge are not backed up.) Backup files have
2696
'.~#~' appended to their name, where # is a number.
2698
When you provide files, you can use their current pathname or the pathname
2699
from the target revision. So you can use revert to "undelete" a file by
2700
name. If you name a directory, all the contents of that directory will be
2703
takes_options = ['revision', 'no-backup']
2704
takes_args = ['file*']
2705
aliases = ['merge-revert']
2707
def run(self, revision=None, no_backup=False, file_list=None):
2708
if file_list is not None:
2709
if len(file_list) == 0:
2710
raise errors.BzrCommandError("No files specified")
2714
tree, file_list = tree_files(file_list)
2715
if revision is None:
2716
# FIXME should be tree.last_revision
2717
rev_id = tree.last_revision()
2718
elif len(revision) != 1:
2719
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2721
rev_id = revision[0].in_history(tree.branch).rev_id
2722
pb = ui.ui_factory.nested_progress_bar()
2724
tree.revert(file_list,
2725
tree.branch.repository.revision_tree(rev_id),
2726
not no_backup, pb, report_changes=True)
2731
class cmd_assert_fail(Command):
2732
"""Test reporting of assertion failures"""
2733
# intended just for use in testing
2738
raise AssertionError("always fails")
2741
class cmd_help(Command):
2742
"""Show help on a command or other topic.
2744
For a list of all available commands, say 'bzr help commands'.
2746
takes_options = [Option('long', 'show help on all commands')]
2747
takes_args = ['topic?']
2748
aliases = ['?', '--help', '-?', '-h']
2751
def run(self, topic=None, long=False):
2753
if topic is None and long:
2755
bzrlib.help.help(topic)
2758
class cmd_shell_complete(Command):
2759
"""Show appropriate completions for context.
2761
For a list of all available commands, say 'bzr shell-complete'.
2763
takes_args = ['context?']
2768
def run(self, context=None):
2769
import shellcomplete
2770
shellcomplete.shellcomplete(context)
2773
class cmd_fetch(Command):
2774
"""Copy in history from another branch but don't merge it.
2776
This is an internal method used for pull and merge.
2779
takes_args = ['from_branch', 'to_branch']
2780
def run(self, from_branch, to_branch):
2781
from bzrlib.fetch import Fetcher
2782
from_b = Branch.open(from_branch)
2783
to_b = Branch.open(to_branch)
2784
Fetcher(to_b, from_b)
2787
class cmd_missing(Command):
2788
"""Show unmerged/unpulled revisions between two branches.
2790
OTHER_BRANCH may be local or remote.
2792
takes_args = ['other_branch?']
2793
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2795
'Display changes in the local branch only'),
2796
Option('theirs-only',
2797
'Display changes in the remote branch only'),
2802
encoding_type = 'replace'
2805
def run(self, other_branch=None, reverse=False, mine_only=False,
2806
theirs_only=False, log_format=None, long=False, short=False, line=False,
2807
show_ids=False, verbose=False):
2808
from bzrlib.missing import find_unmerged, iter_log_data
2809
from bzrlib.log import log_formatter
2810
local_branch = Branch.open_containing(u".")[0]
2811
parent = local_branch.get_parent()
2812
if other_branch is None:
2813
other_branch = parent
2814
if other_branch is None:
2815
raise errors.BzrCommandError("No peer location known or specified.")
2816
display_url = urlutils.unescape_for_display(parent,
2818
print "Using last location: " + display_url
2820
remote_branch = Branch.open(other_branch)
2821
if remote_branch.base == local_branch.base:
2822
remote_branch = local_branch
2823
local_branch.lock_read()
2825
remote_branch.lock_read()
2827
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2828
if (log_format is None):
2829
log_format = log.log_formatter_registry.get_default(
2831
lf = log_format(to_file=self.outf,
2833
show_timezone='original')
2834
if reverse is False:
2835
local_extra.reverse()
2836
remote_extra.reverse()
2837
if local_extra and not theirs_only:
2838
print "You have %d extra revision(s):" % len(local_extra)
2839
for data in iter_log_data(local_extra, local_branch.repository,
2842
printed_local = True
2844
printed_local = False
2845
if remote_extra and not mine_only:
2846
if printed_local is True:
2848
print "You are missing %d revision(s):" % len(remote_extra)
2849
for data in iter_log_data(remote_extra, remote_branch.repository,
2852
if not remote_extra and not local_extra:
2854
print "Branches are up to date."
2858
remote_branch.unlock()
2860
local_branch.unlock()
2861
if not status_code and parent is None and other_branch is not None:
2862
local_branch.lock_write()
2864
# handle race conditions - a parent might be set while we run.
2865
if local_branch.get_parent() is None:
2866
local_branch.set_parent(remote_branch.base)
2868
local_branch.unlock()
2872
class cmd_plugins(Command):
2877
import bzrlib.plugin
2878
from inspect import getdoc
2879
for name, plugin in bzrlib.plugin.all_plugins().items():
2880
if getattr(plugin, '__path__', None) is not None:
2881
print plugin.__path__[0]
2882
elif getattr(plugin, '__file__', None) is not None:
2883
print plugin.__file__
2889
print '\t', d.split('\n')[0]
2892
class cmd_testament(Command):
2893
"""Show testament (signing-form) of a revision."""
2894
takes_options = ['revision',
2895
Option('long', help='Produce long-format testament'),
2896
Option('strict', help='Produce a strict-format'
2898
takes_args = ['branch?']
2900
def run(self, branch=u'.', revision=None, long=False, strict=False):
2901
from bzrlib.testament import Testament, StrictTestament
2903
testament_class = StrictTestament
2905
testament_class = Testament
2906
b = WorkingTree.open_containing(branch)[0].branch
2909
if revision is None:
2910
rev_id = b.last_revision()
2912
rev_id = revision[0].in_history(b).rev_id
2913
t = testament_class.from_revision(b.repository, rev_id)
2915
sys.stdout.writelines(t.as_text_lines())
2917
sys.stdout.write(t.as_short_text())
2922
class cmd_annotate(Command):
2923
"""Show the origin of each line in a file.
2925
This prints out the given file with an annotation on the left side
2926
indicating which revision, author and date introduced the change.
2928
If the origin is the same for a run of consecutive lines, it is
2929
shown only at the top, unless the --all option is given.
2931
# TODO: annotate directories; showing when each file was last changed
2932
# TODO: if the working copy is modified, show annotations on that
2933
# with new uncommitted lines marked
2934
aliases = ['ann', 'blame', 'praise']
2935
takes_args = ['filename']
2936
takes_options = [Option('all', help='show annotations on all lines'),
2937
Option('long', help='show date in annotations'),
2943
def run(self, filename, all=False, long=False, revision=None,
2945
from bzrlib.annotate import annotate_file
2946
tree, relpath = WorkingTree.open_containing(filename)
2947
branch = tree.branch
2950
if revision is None:
2951
revision_id = branch.last_revision()
2952
elif len(revision) != 1:
2953
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2955
revision_id = revision[0].in_history(branch).rev_id
2956
file_id = tree.path2id(relpath)
2957
tree = branch.repository.revision_tree(revision_id)
2958
file_version = tree.inventory[file_id].revision
2959
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2965
class cmd_re_sign(Command):
2966
"""Create a digital signature for an existing revision."""
2967
# TODO be able to replace existing ones.
2969
hidden = True # is this right ?
2970
takes_args = ['revision_id*']
2971
takes_options = ['revision']
2973
def run(self, revision_id_list=None, revision=None):
2974
import bzrlib.gpg as gpg
2975
if revision_id_list is not None and revision is not None:
2976
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2977
if revision_id_list is None and revision is None:
2978
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2979
b = WorkingTree.open_containing(u'.')[0].branch
2980
gpg_strategy = gpg.GPGStrategy(b.get_config())
2981
if revision_id_list is not None:
2982
for revision_id in revision_id_list:
2983
b.repository.sign_revision(revision_id, gpg_strategy)
2984
elif revision is not None:
2985
if len(revision) == 1:
2986
revno, rev_id = revision[0].in_history(b)
2987
b.repository.sign_revision(rev_id, gpg_strategy)
2988
elif len(revision) == 2:
2989
# are they both on rh- if so we can walk between them
2990
# might be nice to have a range helper for arbitrary
2991
# revision paths. hmm.
2992
from_revno, from_revid = revision[0].in_history(b)
2993
to_revno, to_revid = revision[1].in_history(b)
2994
if to_revid is None:
2995
to_revno = b.revno()
2996
if from_revno is None or to_revno is None:
2997
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2998
for revno in range(from_revno, to_revno + 1):
2999
b.repository.sign_revision(b.get_rev_id(revno),
3002
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3005
class cmd_bind(Command):
3006
"""Convert the current branch into a checkout of the supplied branch.
3008
Once converted into a checkout, commits must succeed on the master branch
3009
before they will be applied to the local branch.
3011
See "help checkouts" for more information on checkouts.
3014
takes_args = ['location?']
3017
def run(self, location=None):
3018
b, relpath = Branch.open_containing(u'.')
3019
if location is None:
3021
location = b.get_old_bound_location()
3022
except errors.UpgradeRequired:
3023
raise errors.BzrCommandError('No location supplied. '
3024
'This format does not remember old locations.')
3026
if location is None:
3027
raise errors.BzrCommandError('No location supplied and no '
3028
'previous location known')
3029
b_other = Branch.open(location)
3032
except errors.DivergedBranches:
3033
raise errors.BzrCommandError('These branches have diverged.'
3034
' Try merging, and then bind again.')
3037
class cmd_unbind(Command):
3038
"""Convert the current checkout into a regular branch.
3040
After unbinding, the local branch is considered independent and subsequent
3041
commits will be local only.
3043
See "help checkouts" for more information on checkouts.
3050
b, relpath = Branch.open_containing(u'.')
3052
raise errors.BzrCommandError('Local branch is not bound')
3055
class cmd_uncommit(Command):
3056
"""Remove the last committed revision.
3058
--verbose will print out what is being removed.
3059
--dry-run will go through all the motions, but not actually
3062
In the future, uncommit will create a revision bundle, which can then
3066
# TODO: jam 20060108 Add an option to allow uncommit to remove
3067
# unreferenced information in 'branch-as-repository' branches.
3068
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3069
# information in shared branches as well.
3070
takes_options = ['verbose', 'revision',
3071
Option('dry-run', help='Don\'t actually make changes'),
3072
Option('force', help='Say yes to all questions.')]
3073
takes_args = ['location?']
3076
def run(self, location=None,
3077
dry_run=False, verbose=False,
3078
revision=None, force=False):
3079
from bzrlib.log import log_formatter, show_log
3081
from bzrlib.uncommit import uncommit
3083
if location is None:
3085
control, relpath = bzrdir.BzrDir.open_containing(location)
3087
tree = control.open_workingtree()
3089
except (errors.NoWorkingTree, errors.NotLocalUrl):
3091
b = control.open_branch()
3094
if revision is None:
3097
# 'bzr uncommit -r 10' actually means uncommit
3098
# so that the final tree is at revno 10.
3099
# but bzrlib.uncommit.uncommit() actually uncommits
3100
# the revisions that are supplied.
3101
# So we need to offset it by one
3102
revno = revision[0].in_history(b).revno+1
3104
if revno <= b.revno():
3105
rev_id = b.get_rev_id(revno)
3107
self.outf.write('No revisions to uncommit.\n')
3110
lf = log_formatter('short',
3112
show_timezone='original')
3117
direction='forward',
3118
start_revision=revno,
3119
end_revision=b.revno())
3122
print 'Dry-run, pretending to remove the above revisions.'
3124
val = raw_input('Press <enter> to continue')
3126
print 'The above revision(s) will be removed.'
3128
val = raw_input('Are you sure [y/N]? ')
3129
if val.lower() not in ('y', 'yes'):
3133
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3137
class cmd_break_lock(Command):
3138
"""Break a dead lock on a repository, branch or working directory.
3140
CAUTION: Locks should only be broken when you are sure that the process
3141
holding the lock has been stopped.
3143
You can get information on what locks are open via the 'bzr info' command.
3148
takes_args = ['location?']
3150
def run(self, location=None, show=False):
3151
if location is None:
3153
control, relpath = bzrdir.BzrDir.open_containing(location)
3155
control.break_lock()
3156
except NotImplementedError:
3160
class cmd_wait_until_signalled(Command):
3161
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3163
This just prints a line to signal when it is ready, then blocks on stdin.
3169
sys.stdout.write("running\n")
3171
sys.stdin.readline()
3174
class cmd_serve(Command):
3175
"""Run the bzr server."""
3177
aliases = ['server']
3181
help='serve on stdin/out for use from inetd or sshd'),
3183
help='listen for connections on nominated port of the form '
3184
'[hostname:]portnumber. Passing 0 as the port number will '
3185
'result in a dynamically allocated port. Default port is '
3189
help='serve contents of directory',
3191
Option('allow-writes',
3192
help='By default the server is a readonly server. Supplying '
3193
'--allow-writes enables write access to the contents of '
3194
'the served directory and below. '
3198
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3199
from bzrlib.transport import smart
3200
from bzrlib.transport import get_transport
3201
if directory is None:
3202
directory = os.getcwd()
3203
url = urlutils.local_path_to_url(directory)
3204
if not allow_writes:
3205
url = 'readonly+' + url
3206
t = get_transport(url)
3208
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3211
port = smart.BZR_DEFAULT_PORT
3215
host, port = port.split(':')
3219
server = smart.SmartTCPServer(t, host=host, port=port)
3220
print 'listening on port: ', server.port
3224
class cmd_join(Command):
3225
"""Combine a subtree into its containing tree.
3227
This is marked as a merge of the subtree into the containing tree, and all
3228
history is preserved.
3231
takes_args = ['tree']
3232
takes_options = [Option('reference', 'join by reference')]
3234
def run(self, tree, reference=False):
3235
sub_tree = WorkingTree.open(tree)
3236
parent_dir = osutils.dirname(sub_tree.basedir)
3237
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3240
containing_tree.add_reference(sub_tree)
3241
except errors.BadReferenceTarget:
3242
raise errors.BzrCommandError("Cannot join %s. %s" %
3246
containing_tree.subsume(sub_tree)
3247
except errors.BadSubsumeSource, e:
3248
raise errors.BzrCommandError("Cannot join %s. %s" %
3252
class cmd_split(Command):
3253
"""Split a tree into two trees.
3256
takes_args = ['tree']
3258
def run(self, tree):
3259
containing_tree, subdir = WorkingTree.open_containing(tree)
3260
sub_id = containing_tree.path2id(subdir)
3262
raise errors.NotVersionedError(subdir)
3264
containing_tree.extract(sub_id)
3265
except errors.RootNotRich:
3266
raise errors.UpgradeRequired(containing_tree.branch.base)
3270
class cmd_tag(Command):
3271
"""Create a tag naming a revision.
3273
Tags give human-meaningful names to revisions. Commands that take a -r
3274
(--revision) option can be given -rtag:X, where X is any previously
3277
Tags are stored in the branch. Tags are copied from one branch to another
3278
along when you branch, push, pull or merge.
3280
It is an error to give a tag name that already exists unless you pass
3281
--force, in which case the tag is moved to point to the new revision.
3284
takes_args = ['tag_name']
3287
help='Delete this tag rather than placing it.',
3290
help='Branch in which to place the tag.',
3295
help='Replace existing tags',
3300
def run(self, tag_name,
3306
branch, relpath = Branch.open_containing(directory)
3310
branch.tags.delete_tag(tag_name)
3311
self.outf.write('Deleted tag %s.\n' % tag_name)
3314
if len(revision) != 1:
3315
raise errors.BzrCommandError(
3316
"Tags can only be placed on a single revision, "
3318
revision_id = revision[0].in_history(branch).rev_id
3320
revision_id = branch.last_revision()
3321
if (not force) and branch.tags.has_tag(tag_name):
3322
raise errors.TagAlreadyExists(tag_name)
3323
branch.tags.set_tag(tag_name, revision_id)
3324
self.outf.write('Created tag %s.\n' % tag_name)
3329
class cmd_tags(Command):
3332
This tag shows a table of tag names and the revisions they reference.
3337
help='Branch whose tags should be displayed',
3347
branch, relpath = Branch.open_containing(directory)
3348
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3349
self.outf.write('%-20s %s\n' % (tag_name, target))
3352
# command-line interpretation helper for merge-related commands
3353
def _merge_helper(other_revision, base_revision,
3354
check_clean=True, ignore_zero=False,
3355
this_dir=None, backup_files=False,
3357
file_list=None, show_base=False, reprocess=False,
3360
change_reporter=None):
3361
"""Merge changes into a tree.
3364
list(path, revno) Base for three-way merge.
3365
If [None, None] then a base will be automatically determined.
3367
list(path, revno) Other revision for three-way merge.
3369
Directory to merge changes into; '.' by default.
3371
If true, this_dir must have no uncommitted changes before the
3373
ignore_zero - If true, suppress the "zero conflicts" message when
3374
there are no conflicts; should be set when doing something we expect
3375
to complete perfectly.
3376
file_list - If supplied, merge only changes to selected files.
3378
All available ancestors of other_revision and base_revision are
3379
automatically pulled into the branch.
3381
The revno may be -1 to indicate the last revision on the branch, which is
3384
This function is intended for use from the command line; programmatic
3385
clients might prefer to call merge.merge_inner(), which has less magic
3388
# Loading it late, so that we don't always have to import bzrlib.merge
3389
if merge_type is None:
3390
merge_type = _mod_merge.Merge3Merger
3391
if this_dir is None:
3393
this_tree = WorkingTree.open_containing(this_dir)[0]
3394
if show_base and not merge_type is _mod_merge.Merge3Merger:
3395
raise errors.BzrCommandError("Show-base is not supported for this merge"
3396
" type. %s" % merge_type)
3397
if reprocess and not merge_type.supports_reprocess:
3398
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3399
" type %s." % merge_type)
3400
if reprocess and show_base:
3401
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3402
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3403
# only want to take out a lock_tree_write() if we don't have to pull
3404
# any ancestry. But merge might fetch ancestry in the middle, in
3405
# which case we would need a lock_write().
3406
# Because we cannot upgrade locks, for now we live with the fact that
3407
# the tree will be locked multiple times during a merge. (Maybe
3408
# read-only some of the time, but it means things will get read
3411
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3412
pb=pb, change_reporter=change_reporter)
3413
merger.pp = ProgressPhase("Merge phase", 5, pb)
3414
merger.pp.next_phase()
3415
merger.check_basis(check_clean)
3416
merger.set_other(other_revision)
3417
merger.pp.next_phase()
3418
merger.set_base(base_revision)
3419
if merger.base_rev_id == merger.other_rev_id:
3420
note('Nothing to do.')
3422
if file_list is None:
3423
if pull and merger.base_rev_id == merger.this_rev_id:
3424
# FIXME: deduplicate with pull
3425
result = merger.this_tree.pull(merger.this_branch,
3426
False, merger.other_rev_id)
3427
if result.old_revid == result.new_revid:
3428
note('No revisions to pull.')
3430
note('Now on revision %d.' % result.new_revno)
3432
merger.backup_files = backup_files
3433
merger.merge_type = merge_type
3434
merger.set_interesting_files(file_list)
3435
merger.show_base = show_base
3436
merger.reprocess = reprocess
3437
conflicts = merger.do_merge()
3438
if file_list is None:
3439
merger.set_pending()
3446
merge = _merge_helper
3449
# these get imported and then picked up by the scan for cmd_*
3450
# TODO: Some more consistent way to split command definitions across files;
3451
# we do need to load at least some information about them to know of
3452
# aliases. ideally we would avoid loading the implementation until the
3453
# details were needed.
3454
from bzrlib.cmd_version_info import cmd_version_info
3455
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3456
from bzrlib.bundle.commands import cmd_bundle_revisions
3457
from bzrlib.sign_my_commits import cmd_sign_my_commits
3458
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3459
cmd_weave_plan_merge, cmd_weave_merge_text