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,
345
if file_ids_from is not None:
347
base_tree, base_path = WorkingTree.open_containing(
349
except errors.NoWorkingTree:
350
base_branch, base_path = Branch.open_containing(
352
base_tree = base_branch.basis_tree()
354
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
355
to_file=self.outf, should_print=(not is_quiet()))
357
action = bzrlib.add.AddAction(to_file=self.outf,
358
should_print=(not is_quiet()))
360
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
361
action=action, save=not dry_run)
364
for glob in sorted(ignored.keys()):
365
for path in ignored[glob]:
366
self.outf.write("ignored %s matching \"%s\"\n"
370
for glob, paths in ignored.items():
371
match_len += len(paths)
372
self.outf.write("ignored %d file(s).\n" % match_len)
373
self.outf.write("If you wish to add some of these files,"
374
" please add them by name.\n")
377
class cmd_mkdir(Command):
378
"""Create a new versioned directory.
380
This is equivalent to creating the directory and then adding it.
383
takes_args = ['dir+']
384
encoding_type = 'replace'
386
def run(self, dir_list):
389
wt, dd = WorkingTree.open_containing(d)
391
self.outf.write('added %s\n' % d)
394
class cmd_relpath(Command):
395
"""Show path of a file relative to root"""
397
takes_args = ['filename']
401
def run(self, filename):
402
# TODO: jam 20050106 Can relpath return a munged path if
403
# sys.stdout encoding cannot represent it?
404
tree, relpath = WorkingTree.open_containing(filename)
405
self.outf.write(relpath)
406
self.outf.write('\n')
409
class cmd_inventory(Command):
410
"""Show inventory of the current working copy or a revision.
412
It is possible to limit the output to a particular entry
413
type using the --kind option. For example: --kind file.
415
It is also possible to restrict the list of files to a specific
416
set. For example: bzr inventory --show-ids this/file
423
takes_options = ['revision', 'show-ids', 'kind']
425
takes_args = ['file*']
428
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
429
if kind and kind not in ['file', 'directory', 'symlink']:
430
raise errors.BzrCommandError('invalid kind specified')
432
work_tree, file_list = tree_files(file_list)
434
if revision is not None:
435
if len(revision) > 1:
436
raise errors.BzrCommandError('bzr inventory --revision takes'
437
' exactly one revision identifier')
438
revision_id = revision[0].in_history(work_tree.branch).rev_id
439
tree = work_tree.branch.repository.revision_tree(revision_id)
441
# We include work_tree as well as 'tree' here
442
# So that doing '-r 10 path/foo' will lookup whatever file
443
# exists now at 'path/foo' even if it has been renamed, as
444
# well as whatever files existed in revision 10 at path/foo
445
trees = [tree, work_tree]
450
if file_list is not None:
451
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
452
require_versioned=True)
453
# find_ids_across_trees may include some paths that don't
455
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
456
for file_id in file_ids if file_id in tree)
458
entries = tree.inventory.entries()
460
for path, entry in entries:
461
if kind and kind != entry.kind:
464
self.outf.write('%-50s %s\n' % (path, entry.file_id))
466
self.outf.write(path)
467
self.outf.write('\n')
470
class cmd_mv(Command):
471
"""Move or rename a file.
474
bzr mv OLDNAME NEWNAME
475
bzr mv SOURCE... DESTINATION
477
If the last argument is a versioned directory, all the other names
478
are moved into it. Otherwise, there must be exactly two arguments
479
and the file is changed to a new name.
481
If OLDNAME does not exist on the filesystem but is versioned and
482
NEWNAME does exist on the filesystem but is not versioned, mv
483
assumes that the file has been manually moved and only updates
484
its internal inventory to reflect that change.
485
The same is valid when moving many SOURCE files to a DESTINATION.
487
Files cannot be moved between branches.
490
takes_args = ['names*']
491
takes_options = [Option("after", help="move only the bzr identifier"
492
" of the file (file has already been moved). Use this flag if"
493
" bzr is not able to detect this itself.")]
494
aliases = ['move', 'rename']
495
encoding_type = 'replace'
497
def run(self, names_list, after=False):
498
if names_list is None:
501
if len(names_list) < 2:
502
raise errors.BzrCommandError("missing file argument")
503
tree, rel_names = tree_files(names_list)
505
if os.path.isdir(names_list[-1]):
506
# move into existing directory
507
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
508
self.outf.write("%s => %s\n" % pair)
510
if len(names_list) != 2:
511
raise errors.BzrCommandError('to mv multiple files the'
512
' destination must be a versioned'
514
tree.rename_one(rel_names[0], rel_names[1], after=after)
515
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
518
class cmd_pull(Command):
519
"""Turn this branch into a mirror of another branch.
521
This command only works on branches that have not diverged. Branches are
522
considered diverged if the destination branch's most recent commit is one
523
that has not been merged (directly or indirectly) into the parent.
525
If branches have diverged, you can use 'bzr merge' to integrate the changes
526
from one into the other. Once one branch has merged, the other should
527
be able to pull it again.
529
If you want to forget your local changes and just update your branch to
530
match the remote one, use pull --overwrite.
532
If there is no default location set, the first pull will set it. After
533
that, you can omit the location to use the default. To change the
534
default, use --remember. The value will only be saved if the remote
535
location can be accessed.
538
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
540
help='branch to pull into, '
541
'rather than the one containing the working directory',
546
takes_args = ['location?']
547
encoding_type = 'replace'
549
def run(self, location=None, remember=False, overwrite=False,
550
revision=None, verbose=False,
552
# FIXME: too much stuff is in the command class
553
if directory is None:
556
tree_to = WorkingTree.open_containing(directory)[0]
557
branch_to = tree_to.branch
558
except errors.NoWorkingTree:
560
branch_to = Branch.open_containing(directory)[0]
563
if location is not None:
565
reader = bundle.read_bundle_from_url(location)
566
except errors.NotABundle:
567
pass # Continue on considering this url a Branch
569
stored_loc = branch_to.get_parent()
571
if stored_loc is None:
572
raise errors.BzrCommandError("No pull location known or"
575
display_url = urlutils.unescape_for_display(stored_loc,
577
self.outf.write("Using saved location: %s\n" % display_url)
578
location = stored_loc
580
if reader is not None:
581
install_bundle(branch_to.repository, reader)
582
branch_from = branch_to
584
branch_from = Branch.open(location)
586
if branch_to.get_parent() is None or remember:
587
branch_to.set_parent(branch_from.base)
591
if reader is not None:
592
rev_id = reader.target
593
elif len(revision) == 1:
594
rev_id = revision[0].in_history(branch_from).rev_id
596
raise errors.BzrCommandError('bzr pull --revision takes one value.')
598
old_rh = branch_to.revision_history()
599
if tree_to is not None:
600
count = tree_to.pull(branch_from, overwrite, rev_id,
601
delta.ChangeReporter(tree_to.inventory))
603
count = branch_to.pull(branch_from, overwrite, rev_id)
604
_copy_tags_maybe(branch_from, branch_to)
605
note('%d revision(s) pulled.' % (count,))
608
new_rh = branch_to.revision_history()
611
from bzrlib.log import show_changed_revisions
612
show_changed_revisions(branch_to, old_rh, new_rh,
616
class cmd_push(Command):
617
"""Update a mirror of this branch.
619
The target branch will not have its working tree populated because this
620
is both expensive, and is not supported on remote file systems.
622
Some smart servers or protocols *may* put the working tree in place in
625
This command only works on branches that have not diverged. Branches are
626
considered diverged if the destination branch's most recent commit is one
627
that has not been merged (directly or indirectly) by the source branch.
629
If branches have diverged, you can use 'bzr push --overwrite' to replace
630
the other branch completely, discarding its unmerged changes.
632
If you want to ensure you have the different changes in the other branch,
633
do a merge (see bzr help merge) from the other branch, and commit that.
634
After that you will be able to do a push without '--overwrite'.
636
If there is no default push location set, the first push will set it.
637
After that, you can omit the location to use the default. To change the
638
default, use --remember. The value will only be saved if the remote
639
location can be accessed.
642
takes_options = ['remember', 'overwrite', 'verbose',
643
Option('create-prefix',
644
help='Create the path leading up to the branch '
645
'if it does not already exist'),
647
help='branch to push from, '
648
'rather than the one containing the working directory',
652
Option('use-existing-dir',
653
help='By default push will fail if the target'
654
' directory exists, but does not already'
655
' have a control directory. This flag will'
656
' allow push to proceed.'),
658
takes_args = ['location?']
659
encoding_type = 'replace'
661
def run(self, location=None, remember=False, overwrite=False,
662
create_prefix=False, verbose=False,
663
use_existing_dir=False,
665
# FIXME: Way too big! Put this into a function called from the
667
if directory is None:
669
br_from = Branch.open_containing(directory)[0]
670
stored_loc = br_from.get_push_location()
672
if stored_loc is None:
673
raise errors.BzrCommandError("No push location known or specified.")
675
display_url = urlutils.unescape_for_display(stored_loc,
677
self.outf.write("Using saved location: %s\n" % display_url)
678
location = stored_loc
680
to_transport = transport.get_transport(location)
681
location_url = to_transport.base
686
br_to = repository_to = dir_to = None
688
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
689
except errors.NotBranchError:
690
pass # Didn't find anything
692
# If we can open a branch, use its direct repository, otherwise see
693
# if there is a repository without a branch.
695
br_to = dir_to.open_branch()
696
except errors.NotBranchError:
697
# Didn't find a branch, can we find a repository?
699
repository_to = dir_to.find_repository()
700
except errors.NoRepositoryPresent:
703
# Found a branch, so we must have found a repository
704
repository_to = br_to.repository
708
# XXX: Refactor the create_prefix/no_create_prefix code into a
709
# common helper function
711
to_transport.mkdir('.')
712
except errors.FileExists:
713
if not use_existing_dir:
714
raise errors.BzrCommandError("Target directory %s"
715
" already exists, but does not have a valid .bzr"
716
" directory. Supply --use-existing-dir to push"
717
" there anyway." % location)
718
except errors.NoSuchFile:
719
if not create_prefix:
720
raise errors.BzrCommandError("Parent directory of %s"
722
"\nYou may supply --create-prefix to create all"
723
" leading parent directories."
726
cur_transport = to_transport
727
needed = [cur_transport]
728
# Recurse upwards until we can create a directory successfully
730
new_transport = cur_transport.clone('..')
731
if new_transport.base == cur_transport.base:
732
raise errors.BzrCommandError("Failed to create path"
736
new_transport.mkdir('.')
737
except errors.NoSuchFile:
738
needed.append(new_transport)
739
cur_transport = new_transport
743
# Now we only need to create child directories
745
cur_transport = needed.pop()
746
cur_transport.mkdir('.')
748
# Now the target directory exists, but doesn't have a .bzr
749
# directory. So we need to create it, along with any work to create
750
# all of the dependent branches, etc.
751
dir_to = br_from.bzrdir.clone(location_url,
752
revision_id=br_from.last_revision())
753
br_to = dir_to.open_branch()
754
count = br_to.last_revision_info()[0]
755
# We successfully created the target, remember it
756
if br_from.get_push_location() is None or remember:
757
br_from.set_push_location(br_to.base)
758
elif repository_to is None:
759
# we have a bzrdir but no branch or repository
760
# XXX: Figure out what to do other than complain.
761
raise errors.BzrCommandError("At %s you have a valid .bzr control"
762
" directory, but not a branch or repository. This is an"
763
" unsupported configuration. Please move the target directory"
764
" out of the way and try again."
767
# We have a repository but no branch, copy the revisions, and then
769
last_revision_id = br_from.last_revision()
770
repository_to.fetch(br_from.repository,
771
revision_id=last_revision_id)
772
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
773
count = len(br_to.revision_history())
774
if br_from.get_push_location() is None or remember:
775
br_from.set_push_location(br_to.base)
776
else: # We have a valid to branch
777
# We were able to connect to the remote location, so remember it
778
# we don't need to successfully push because of possible divergence.
779
if br_from.get_push_location() is None or remember:
780
br_from.set_push_location(br_to.base)
781
old_rh = br_to.revision_history()
784
tree_to = dir_to.open_workingtree()
785
except errors.NotLocalUrl:
786
warning('This transport does not update the working '
787
'tree of: %s' % (br_to.base,))
788
count = br_from.push(br_to, overwrite)
789
except errors.NoWorkingTree:
790
count = br_from.push(br_to, overwrite)
794
count = br_from.push(tree_to.branch, overwrite)
798
except errors.DivergedBranches:
799
raise errors.BzrCommandError('These branches have diverged.'
800
' Try using "merge" and then "push".')
801
_copy_tags_maybe(br_from, br_to)
802
note('%d revision(s) pushed.' % (count,))
805
new_rh = br_to.revision_history()
808
from bzrlib.log import show_changed_revisions
809
show_changed_revisions(br_to, old_rh, new_rh,
813
class cmd_branch(Command):
814
"""Create a new copy of a branch.
816
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
817
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
819
To retrieve the branch as of a particular revision, supply the --revision
820
parameter, as in "branch foo/bar -r 5".
822
--basis is to speed up branching from remote branches. When specified, it
823
copies all the file-contents, inventory and revision data from the basis
824
branch before copying anything from the remote branch.
826
takes_args = ['from_location', 'to_location?']
827
takes_options = ['revision', 'basis']
828
aliases = ['get', 'clone']
830
def run(self, from_location, to_location=None, revision=None, basis=None):
833
elif len(revision) > 1:
834
raise errors.BzrCommandError(
835
'bzr branch --revision takes exactly 1 revision value')
837
br_from = Branch.open(from_location)
840
if basis is not None:
841
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
844
if len(revision) == 1 and revision[0] is not None:
845
revision_id = revision[0].in_history(br_from)[1]
847
# FIXME - wt.last_revision, fallback to branch, fall back to
848
# None or perhaps NULL_REVISION to mean copy nothing
850
revision_id = br_from.last_revision()
851
if to_location is None:
852
to_location = os.path.basename(from_location.rstrip("/\\"))
855
name = os.path.basename(to_location) + '\n'
857
to_transport = transport.get_transport(to_location)
859
to_transport.mkdir('.')
860
except errors.FileExists:
861
raise errors.BzrCommandError('Target directory "%s" already'
862
' exists.' % to_location)
863
except errors.NoSuchFile:
864
raise errors.BzrCommandError('Parent of "%s" does not exist.'
867
# preserve whatever source format we have.
868
dir = br_from.bzrdir.sprout(to_transport.base,
869
revision_id, basis_dir)
870
branch = dir.open_branch()
871
except errors.NoSuchRevision:
872
to_transport.delete_tree('.')
873
msg = "The branch %s has no revision %s." % (from_location, revision[0])
874
raise errors.BzrCommandError(msg)
875
except errors.UnlistableBranch:
876
osutils.rmtree(to_location)
877
msg = "The branch %s cannot be used as a --basis" % (basis,)
878
raise errors.BzrCommandError(msg)
880
branch.control_files.put_utf8('branch-name', name)
881
_copy_tags_maybe(br_from, branch)
882
note('Branched %d revision(s).' % branch.revno())
887
def _copy_tags_maybe(from_branch, to_branch):
888
"""Copy tags between repositories if necessary and possible.
890
This method has common command-line behaviour about handling
893
if not from_branch.tags.supports_tags():
894
# obviously nothing to copy
896
# TODO: give a warning if the source format supports tags and actually has
897
# tags, but the destination doesn't accept them.
898
from_branch.copy_tags_to(to_branch)
901
class cmd_checkout(Command):
902
"""Create a new checkout of an existing branch.
904
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
905
the branch found in '.'. This is useful if you have removed the working tree
906
or if it was never created - i.e. if you pushed the branch to its current
909
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
910
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
912
To retrieve the branch as of a particular revision, supply the --revision
913
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
914
out of date [so you cannot commit] but it may be useful (i.e. to examine old
917
--basis is to speed up checking out from remote branches. When specified, it
918
uses the inventory and file contents from the basis branch in preference to the
919
branch being checked out.
921
See "help checkouts" for more information on checkouts.
923
takes_args = ['branch_location?', 'to_location?']
924
takes_options = ['revision', # , 'basis']
925
Option('lightweight',
926
help="perform a lightweight checkout. Lightweight "
927
"checkouts depend on access to the branch for "
928
"every operation. Normal checkouts can perform "
929
"common operations like diff and status without "
930
"such access, and also support local commits."
935
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
939
elif len(revision) > 1:
940
raise errors.BzrCommandError(
941
'bzr checkout --revision takes exactly 1 revision value')
942
if branch_location is None:
943
branch_location = osutils.getcwd()
944
to_location = branch_location
945
source = Branch.open(branch_location)
946
if len(revision) == 1 and revision[0] is not None:
947
revision_id = revision[0].in_history(source)[1]
950
if to_location is None:
951
to_location = os.path.basename(branch_location.rstrip("/\\"))
952
# if the source and to_location are the same,
953
# and there is no working tree,
954
# then reconstitute a branch
955
if (osutils.abspath(to_location) ==
956
osutils.abspath(branch_location)):
958
source.bzrdir.open_workingtree()
959
except errors.NoWorkingTree:
960
source.bzrdir.create_workingtree()
963
os.mkdir(to_location)
965
if e.errno == errno.EEXIST:
966
raise errors.BzrCommandError('Target directory "%s" already'
967
' exists.' % to_location)
968
if e.errno == errno.ENOENT:
969
raise errors.BzrCommandError('Parent of "%s" does not exist.'
973
source.create_checkout(to_location, revision_id, lightweight)
976
class cmd_renames(Command):
977
"""Show list of renamed files.
979
# TODO: Option to show renames between two historical versions.
981
# TODO: Only show renames under dir, rather than in the whole branch.
982
takes_args = ['dir?']
985
def run(self, dir=u'.'):
986
tree = WorkingTree.open_containing(dir)[0]
987
old_inv = tree.basis_tree().inventory
988
new_inv = tree.read_working_inventory()
989
renames = list(_mod_tree.find_renames(old_inv, new_inv))
991
for old_name, new_name in renames:
992
self.outf.write("%s => %s\n" % (old_name, new_name))
995
class cmd_update(Command):
996
"""Update a tree to have the latest code committed to its branch.
998
This will perform a merge into the working tree, and may generate
999
conflicts. If you have any local changes, you will still
1000
need to commit them after the update for the update to be complete.
1002
If you want to discard your local changes, you can just do a
1003
'bzr revert' instead of 'bzr commit' after the update.
1005
takes_args = ['dir?']
1008
def run(self, dir='.'):
1009
tree = WorkingTree.open_containing(dir)[0]
1010
master = tree.branch.get_master_branch()
1011
if master is not None:
1014
tree.lock_tree_write()
1016
existing_pending_merges = tree.get_parent_ids()[1:]
1017
last_rev = tree.last_revision()
1018
if last_rev == tree.branch.last_revision():
1019
# may be up to date, check master too.
1020
master = tree.branch.get_master_branch()
1021
if master is None or last_rev == master.last_revision():
1022
revno = tree.branch.revision_id_to_revno(last_rev)
1023
note("Tree is up to date at revision %d." % (revno,))
1025
conflicts = tree.update()
1026
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1027
note('Updated to revision %d.' % (revno,))
1028
if tree.get_parent_ids()[1:] != existing_pending_merges:
1029
note('Your local commits will now show as pending merges with '
1030
"'bzr status', and can be committed with 'bzr commit'.")
1039
class cmd_info(Command):
1040
"""Show information about a working tree, branch or repository.
1042
This command will show all known locations and formats associated to the
1043
tree, branch or repository. Statistical information is included with
1046
Branches and working trees will also report any missing revisions.
1048
takes_args = ['location?']
1049
takes_options = ['verbose']
1052
def run(self, location=None, verbose=False):
1053
from bzrlib.info import show_bzrdir_info
1054
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1058
class cmd_remove(Command):
1059
"""Make a file unversioned.
1061
This makes bzr stop tracking changes to a versioned file. It does
1062
not delete the working copy.
1064
You can specify one or more files, and/or --new. If you specify --new,
1065
only 'added' files will be removed. If you specify both, then new files
1066
in the specified directories will be removed. If the directories are
1067
also new, they will also be removed.
1069
takes_args = ['file*']
1070
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1072
encoding_type = 'replace'
1074
def run(self, file_list, verbose=False, new=False):
1075
tree, file_list = tree_files(file_list)
1077
if file_list is None:
1078
raise errors.BzrCommandError('Specify one or more files to'
1079
' remove, or use --new.')
1081
added = tree.changes_from(tree.basis_tree(),
1082
specific_files=file_list).added
1083
file_list = sorted([f[0] for f in added], reverse=True)
1084
if len(file_list) == 0:
1085
raise errors.BzrCommandError('No matching files.')
1086
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1089
class cmd_file_id(Command):
1090
"""Print file_id of a particular file or directory.
1092
The file_id is assigned when the file is first added and remains the
1093
same through all revisions where the file exists, even when it is
1098
takes_args = ['filename']
1101
def run(self, filename):
1102
tree, relpath = WorkingTree.open_containing(filename)
1103
i = tree.inventory.path2id(relpath)
1105
raise errors.NotVersionedError(filename)
1107
self.outf.write(i + '\n')
1110
class cmd_file_path(Command):
1111
"""Print path of file_ids to a file or directory.
1113
This prints one line for each directory down to the target,
1114
starting at the branch root.
1118
takes_args = ['filename']
1121
def run(self, filename):
1122
tree, relpath = WorkingTree.open_containing(filename)
1123
inv = tree.inventory
1124
fid = inv.path2id(relpath)
1126
raise errors.NotVersionedError(filename)
1127
for fip in inv.get_idpath(fid):
1128
self.outf.write(fip + '\n')
1131
class cmd_reconcile(Command):
1132
"""Reconcile bzr metadata in a branch.
1134
This can correct data mismatches that may have been caused by
1135
previous ghost operations or bzr upgrades. You should only
1136
need to run this command if 'bzr check' or a bzr developer
1137
advises you to run it.
1139
If a second branch is provided, cross-branch reconciliation is
1140
also attempted, which will check that data like the tree root
1141
id which was not present in very early bzr versions is represented
1142
correctly in both branches.
1144
At the same time it is run it may recompress data resulting in
1145
a potential saving in disk space or performance gain.
1147
The branch *MUST* be on a listable system such as local disk or sftp.
1149
takes_args = ['branch?']
1151
def run(self, branch="."):
1152
from bzrlib.reconcile import reconcile
1153
dir = bzrdir.BzrDir.open(branch)
1157
class cmd_revision_history(Command):
1158
"""Display the list of revision ids on a branch."""
1159
takes_args = ['location?']
1164
def run(self, location="."):
1165
branch = Branch.open_containing(location)[0]
1166
for revid in branch.revision_history():
1167
self.outf.write(revid)
1168
self.outf.write('\n')
1171
class cmd_ancestry(Command):
1172
"""List all revisions merged into this branch."""
1173
takes_args = ['location?']
1178
def run(self, location="."):
1180
wt = WorkingTree.open_containing(location)[0]
1181
except errors.NoWorkingTree:
1182
b = Branch.open(location)
1183
last_revision = b.last_revision()
1186
last_revision = wt.last_revision()
1188
revision_ids = b.repository.get_ancestry(last_revision)
1189
assert revision_ids[0] is None
1191
for revision_id in revision_ids:
1192
self.outf.write(revision_id + '\n')
1195
class cmd_init(Command):
1196
"""Make a directory into a versioned branch.
1198
Use this to create an empty branch, or before importing an
1201
If there is a repository in a parent directory of the location, then
1202
the history of the branch will be stored in the repository. Otherwise
1203
init creates a standalone branch which carries its own history in
1206
If there is already a branch at the location but it has no working tree,
1207
the tree can be populated with 'bzr checkout'.
1209
Recipe for importing a tree of files:
1214
bzr commit -m 'imported project'
1216
takes_args = ['location?']
1218
RegistryOption('format',
1219
help='Specify a format for this branch. '
1220
'See "help formats".',
1221
registry=bzrdir.format_registry,
1222
converter=bzrdir.format_registry.make_bzrdir,
1223
value_switches=True,
1224
title="Branch Format",
1226
Option('append-revisions-only',
1227
help='Never change revnos or the existing log.'
1228
' Append revisions to it only.')
1230
def run(self, location=None, format=None, append_revisions_only=False):
1232
format = bzrdir.format_registry.make_bzrdir('default')
1233
if location is None:
1236
to_transport = transport.get_transport(location)
1238
# The path has to exist to initialize a
1239
# branch inside of it.
1240
# Just using os.mkdir, since I don't
1241
# believe that we want to create a bunch of
1242
# locations if the user supplies an extended path
1243
# TODO: create-prefix
1245
to_transport.mkdir('.')
1246
except errors.FileExists:
1250
existing_bzrdir = bzrdir.BzrDir.open(location)
1251
except errors.NotBranchError:
1252
# really a NotBzrDir error...
1253
branch = bzrdir.BzrDir.create_branch_convenience(location,
1256
from bzrlib.transport.local import LocalTransport
1257
if existing_bzrdir.has_branch():
1258
if (isinstance(to_transport, LocalTransport)
1259
and not existing_bzrdir.has_workingtree()):
1260
raise errors.BranchExistsWithoutWorkingTree(location)
1261
raise errors.AlreadyBranchError(location)
1263
branch = existing_bzrdir.create_branch()
1264
existing_bzrdir.create_workingtree()
1265
if append_revisions_only:
1267
branch.set_append_revisions_only(True)
1268
except errors.UpgradeRequired:
1269
raise errors.BzrCommandError('This branch format cannot be set'
1270
' to append-revisions-only. Try --experimental-branch6')
1273
class cmd_init_repository(Command):
1274
"""Create a shared repository to hold branches.
1276
New branches created under the repository directory will store their revisions
1277
in the repository, not in the branch directory, if the branch format supports
1283
bzr checkout --lightweight repo/trunk trunk-checkout
1287
takes_args = ["location"]
1288
takes_options = [RegistryOption('format',
1289
help='Specify a format for this repository. See'
1290
' "bzr help formats" for details',
1291
registry=bzrdir.format_registry,
1292
converter=bzrdir.format_registry.make_bzrdir,
1293
value_switches=True, title='Repository format'),
1295
help='Allows branches in repository to have'
1297
aliases = ["init-repo"]
1298
def run(self, location, format=None, trees=False):
1300
format = bzrdir.format_registry.make_bzrdir('default')
1302
if location is None:
1305
to_transport = transport.get_transport(location)
1307
to_transport.mkdir('.')
1308
except errors.FileExists:
1311
newdir = format.initialize_on_transport(to_transport)
1312
repo = newdir.create_repository(shared=True)
1313
repo.set_make_working_trees(trees)
1316
class cmd_diff(Command):
1317
"""Show differences in the working tree or between revisions.
1319
If files are listed, only the changes in those files are listed.
1320
Otherwise, all changes for the tree are listed.
1322
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1323
produces patches suitable for "patch -p1".
1327
Shows the difference in the working tree versus the last commit
1329
Difference between the working tree and revision 1
1331
Difference between revision 2 and revision 1
1332
bzr diff --diff-prefix old/:new/
1333
Same as 'bzr diff' but prefix paths with old/ and new/
1334
bzr diff bzr.mine bzr.dev
1335
Show the differences between the two working trees
1337
Show just the differences for 'foo.c'
1339
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1340
# or a graphical diff.
1342
# TODO: Python difflib is not exactly the same as unidiff; should
1343
# either fix it up or prefer to use an external diff.
1345
# TODO: Selected-file diff is inefficient and doesn't show you
1348
# TODO: This probably handles non-Unix newlines poorly.
1350
takes_args = ['file*']
1351
takes_options = ['revision', 'diff-options',
1352
Option('prefix', type=str,
1354
help='Set prefixes to added to old and new filenames, as '
1355
'two values separated by a colon.'),
1357
aliases = ['di', 'dif']
1358
encoding_type = 'exact'
1361
def run(self, revision=None, file_list=None, diff_options=None,
1363
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1365
if (prefix is None) or (prefix == '0'):
1373
old_label, new_label = prefix.split(":")
1375
raise BzrCommandError(
1376
"--prefix expects two values separated by a colon")
1378
if revision and len(revision) > 2:
1379
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1380
' one or two revision specifiers')
1383
tree1, file_list = internal_tree_files(file_list)
1387
except errors.FileInWrongBranch:
1388
if len(file_list) != 2:
1389
raise errors.BzrCommandError("Files are in different branches")
1391
tree1, file1 = WorkingTree.open_containing(file_list[0])
1392
tree2, file2 = WorkingTree.open_containing(file_list[1])
1393
if file1 != "" or file2 != "":
1394
# FIXME diff those two files. rbc 20051123
1395
raise errors.BzrCommandError("Files are in different branches")
1397
except errors.NotBranchError:
1398
if (revision is not None and len(revision) == 2
1399
and not revision[0].needs_branch()
1400
and not revision[1].needs_branch()):
1401
# If both revision specs include a branch, we can
1402
# diff them without needing a local working tree
1403
tree1, tree2 = None, None
1407
if tree2 is not None:
1408
if revision is not None:
1409
# FIXME: but there should be a clean way to diff between
1410
# non-default versions of two trees, it's not hard to do
1412
raise errors.BzrCommandError(
1413
"Sorry, diffing arbitrary revisions across branches "
1414
"is not implemented yet")
1415
return show_diff_trees(tree1, tree2, sys.stdout,
1416
specific_files=file_list,
1417
external_diff_options=diff_options,
1418
old_label=old_label, new_label=new_label)
1420
return diff_cmd_helper(tree1, file_list, diff_options,
1421
revision_specs=revision,
1422
old_label=old_label, new_label=new_label)
1425
class cmd_deleted(Command):
1426
"""List files deleted in the working tree.
1428
# TODO: Show files deleted since a previous revision, or
1429
# between two revisions.
1430
# TODO: Much more efficient way to do this: read in new
1431
# directories with readdir, rather than stating each one. Same
1432
# level of effort but possibly much less IO. (Or possibly not,
1433
# if the directories are very large...)
1434
takes_options = ['show-ids']
1437
def run(self, show_ids=False):
1438
tree = WorkingTree.open_containing(u'.')[0]
1439
old = tree.basis_tree()
1440
for path, ie in old.inventory.iter_entries():
1441
if not tree.has_id(ie.file_id):
1442
self.outf.write(path)
1444
self.outf.write(' ')
1445
self.outf.write(ie.file_id)
1446
self.outf.write('\n')
1449
class cmd_modified(Command):
1450
"""List files modified in working tree.
1452
See also: "bzr status".
1459
tree = WorkingTree.open_containing(u'.')[0]
1460
td = tree.changes_from(tree.basis_tree())
1461
for path, id, kind, text_modified, meta_modified in td.modified:
1462
self.outf.write(path + '\n')
1465
class cmd_added(Command):
1466
"""List files added in working tree.
1468
See also: "bzr status".
1475
wt = WorkingTree.open_containing(u'.')[0]
1476
basis_inv = wt.basis_tree().inventory
1479
if file_id in basis_inv:
1481
if inv.is_root(file_id) and len(basis_inv) == 0:
1483
path = inv.id2path(file_id)
1484
if not os.access(osutils.abspath(path), os.F_OK):
1486
self.outf.write(path + '\n')
1489
class cmd_root(Command):
1490
"""Show the tree root directory.
1492
The root is the nearest enclosing directory with a .bzr control
1494
takes_args = ['filename?']
1496
def run(self, filename=None):
1497
"""Print the branch root."""
1498
tree = WorkingTree.open_containing(filename)[0]
1499
self.outf.write(tree.basedir + '\n')
1502
class cmd_log(Command):
1503
"""Show log of a branch, file, or directory.
1505
By default show the log of the branch containing the working directory.
1507
To request a range of logs, you can use the command -r begin..end
1508
-r revision requests a specific revision, -r ..end or -r begin.. are
1514
bzr log -r -10.. http://server/branch
1517
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1519
takes_args = ['location?']
1520
takes_options = [Option('forward',
1521
help='show from oldest to newest'),
1525
help='show files changed in each revision'),
1526
'show-ids', 'revision',
1530
help='show revisions whose message matches this regexp',
1533
encoding_type = 'replace'
1536
def run(self, location=None, timezone='original',
1543
from bzrlib.log import show_log
1544
assert message is None or isinstance(message, basestring), \
1545
"invalid message argument %r" % message
1546
direction = (forward and 'forward') or 'reverse'
1551
# find the file id to log:
1553
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1557
tree = b.basis_tree()
1558
inv = tree.inventory
1559
file_id = inv.path2id(fp)
1561
raise errors.BzrCommandError(
1562
"Path does not have any revision history: %s" %
1566
# FIXME ? log the current subdir only RBC 20060203
1567
if revision is not None \
1568
and len(revision) > 0 and revision[0].get_branch():
1569
location = revision[0].get_branch()
1572
dir, relpath = bzrdir.BzrDir.open_containing(location)
1573
b = dir.open_branch()
1577
if revision is None:
1580
elif len(revision) == 1:
1581
rev1 = rev2 = revision[0].in_history(b).revno
1582
elif len(revision) == 2:
1583
if revision[1].get_branch() != revision[0].get_branch():
1584
# b is taken from revision[0].get_branch(), and
1585
# show_log will use its revision_history. Having
1586
# different branches will lead to weird behaviors.
1587
raise errors.BzrCommandError(
1588
"Log doesn't accept two revisions in different"
1590
if revision[0].spec is None:
1591
# missing begin-range means first revision
1594
rev1 = revision[0].in_history(b).revno
1596
if revision[1].spec is None:
1597
# missing end-range means last known revision
1600
rev2 = revision[1].in_history(b).revno
1602
raise errors.BzrCommandError(
1603
'bzr log --revision takes one or two values.')
1605
# By this point, the revision numbers are converted to the +ve
1606
# form if they were supplied in the -ve form, so we can do
1607
# this comparison in relative safety
1609
(rev2, rev1) = (rev1, rev2)
1611
if log_format is None:
1612
log_format = log.log_formatter_registry.get_default(b)
1614
lf = log_format(show_ids=show_ids, to_file=self.outf,
1615
show_timezone=timezone)
1621
direction=direction,
1622
start_revision=rev1,
1629
def get_log_format(long=False, short=False, line=False, default='long'):
1630
log_format = default
1634
log_format = 'short'
1640
class cmd_touching_revisions(Command):
1641
"""Return revision-ids which affected a particular file.
1643
A more user-friendly interface is "bzr log FILE".
1647
takes_args = ["filename"]
1650
def run(self, filename):
1651
tree, relpath = WorkingTree.open_containing(filename)
1653
inv = tree.read_working_inventory()
1654
file_id = inv.path2id(relpath)
1655
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1656
self.outf.write("%6d %s\n" % (revno, what))
1659
class cmd_ls(Command):
1660
"""List files in a tree.
1663
takes_args = ['path?']
1664
# TODO: Take a revision or remote path and list that tree instead.
1665
takes_options = ['verbose', 'revision',
1666
Option('non-recursive',
1667
help='don\'t recurse into sub-directories'),
1669
help='Print all paths from the root of the branch.'),
1670
Option('unknown', help='Print unknown files'),
1671
Option('versioned', help='Print versioned files'),
1672
Option('ignored', help='Print ignored files'),
1674
Option('null', help='Null separate the files'),
1678
def run(self, revision=None, verbose=False,
1679
non_recursive=False, from_root=False,
1680
unknown=False, versioned=False, ignored=False,
1681
null=False, kind=None, show_ids=False, path=None):
1683
if kind and kind not in ('file', 'directory', 'symlink'):
1684
raise errors.BzrCommandError('invalid kind specified')
1686
if verbose and null:
1687
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1688
all = not (unknown or versioned or ignored)
1690
selection = {'I':ignored, '?':unknown, 'V':versioned}
1697
raise errors.BzrCommandError('cannot specify both --from-root'
1701
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1707
if revision is not None:
1708
tree = branch.repository.revision_tree(
1709
revision[0].in_history(branch).rev_id)
1711
tree = branch.basis_tree()
1713
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1714
if fp.startswith(relpath):
1715
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1716
if non_recursive and '/' in fp:
1718
if not all and not selection[fc]:
1720
if kind is not None and fkind != kind:
1723
kindch = entry.kind_character()
1724
outstring = '%-8s %s%s' % (fc, fp, kindch)
1725
if show_ids and fid is not None:
1726
outstring = "%-50s %s" % (outstring, fid)
1727
self.outf.write(outstring + '\n')
1729
self.outf.write(fp + '\0')
1732
self.outf.write(fid)
1733
self.outf.write('\0')
1741
self.outf.write('%-50s %s\n' % (fp, my_id))
1743
self.outf.write(fp + '\n')
1746
class cmd_unknowns(Command):
1747
"""List unknown files.
1749
See also: "bzr ls --unknown".
1756
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1757
self.outf.write(osutils.quotefn(f) + '\n')
1760
class cmd_ignore(Command):
1761
"""Ignore specified files or patterns.
1763
To remove patterns from the ignore list, edit the .bzrignore file.
1765
Trailing slashes on patterns are ignored.
1766
If the pattern contains a slash or is a regular expression, it is compared
1767
to the whole path from the branch root. Otherwise, it is compared to only
1768
the last component of the path. To match a file only in the root
1769
directory, prepend './'.
1771
Ignore patterns specifying absolute paths are not allowed.
1773
Ignore patterns may include globbing wildcards such as:
1774
? - Matches any single character except '/'
1775
* - Matches 0 or more characters except '/'
1776
/**/ - Matches 0 or more directories in a path
1777
[a-z] - Matches a single character from within a group of characters
1779
Ignore patterns may also be Python regular expressions.
1780
Regular expression ignore patterns are identified by a 'RE:' prefix
1781
followed by the regular expression. Regular expression ignore patterns
1782
may not include named or numbered groups.
1784
Note: ignore patterns containing shell wildcards must be quoted from
1788
bzr ignore ./Makefile
1789
bzr ignore '*.class'
1790
bzr ignore 'lib/**/*.o'
1791
bzr ignore 'RE:lib/.*\.o'
1793
takes_args = ['name_pattern*']
1795
Option('old-default-rules',
1796
help='Out the ignore rules bzr < 0.9 always used.')
1799
def run(self, name_pattern_list=None, old_default_rules=None):
1800
from bzrlib.atomicfile import AtomicFile
1801
if old_default_rules is not None:
1802
# dump the rules and exit
1803
for pattern in ignores.OLD_DEFAULTS:
1806
if not name_pattern_list:
1807
raise errors.BzrCommandError("ignore requires at least one "
1808
"NAME_PATTERN or --old-default-rules")
1809
for name_pattern in name_pattern_list:
1810
if name_pattern[0] == '/':
1811
raise errors.BzrCommandError(
1812
"NAME_PATTERN should not be an absolute path")
1813
tree, relpath = WorkingTree.open_containing(u'.')
1814
ifn = tree.abspath('.bzrignore')
1815
if os.path.exists(ifn):
1818
igns = f.read().decode('utf-8')
1824
# TODO: If the file already uses crlf-style termination, maybe
1825
# we should use that for the newly added lines?
1827
if igns and igns[-1] != '\n':
1829
for name_pattern in name_pattern_list:
1830
igns += name_pattern.rstrip('/') + '\n'
1832
f = AtomicFile(ifn, 'wb')
1834
f.write(igns.encode('utf-8'))
1839
inv = tree.inventory
1840
if inv.path2id('.bzrignore'):
1841
mutter('.bzrignore is already versioned')
1843
mutter('need to make new .bzrignore file versioned')
1844
tree.add(['.bzrignore'])
1847
class cmd_ignored(Command):
1848
"""List ignored files and the patterns that matched them.
1850
See also: bzr ignore"""
1853
tree = WorkingTree.open_containing(u'.')[0]
1854
for path, file_class, kind, file_id, entry in tree.list_files():
1855
if file_class != 'I':
1857
## XXX: Slightly inefficient since this was already calculated
1858
pat = tree.is_ignored(path)
1859
print '%-50s %s' % (path, pat)
1862
class cmd_lookup_revision(Command):
1863
"""Lookup the revision-id from a revision-number
1866
bzr lookup-revision 33
1869
takes_args = ['revno']
1872
def run(self, revno):
1876
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1878
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1881
class cmd_export(Command):
1882
"""Export past revision to destination directory.
1884
If no revision is specified this exports the last committed revision.
1886
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1887
given, try to find the format with the extension. If no extension
1888
is found exports to a directory (equivalent to --format=dir).
1890
Root may be the top directory for tar, tgz and tbz2 formats. If none
1891
is given, the top directory will be the root name of the file.
1893
If branch is omitted then the branch containing the CWD will be used.
1895
Note: export of tree with non-ascii filenames to zip is not supported.
1897
Supported formats Autodetected by extension
1898
----------------- -------------------------
1901
tbz2 .tar.bz2, .tbz2
1905
takes_args = ['dest', 'branch?']
1906
takes_options = ['revision', 'format', 'root']
1907
def run(self, dest, branch=None, revision=None, format=None, root=None):
1908
from bzrlib.export import export
1911
tree = WorkingTree.open_containing(u'.')[0]
1914
b = Branch.open(branch)
1916
if revision is None:
1917
# should be tree.last_revision FIXME
1918
rev_id = b.last_revision()
1920
if len(revision) != 1:
1921
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1922
rev_id = revision[0].in_history(b).rev_id
1923
t = b.repository.revision_tree(rev_id)
1925
export(t, dest, format, root)
1926
except errors.NoSuchExportFormat, e:
1927
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1930
class cmd_cat(Command):
1931
"""Write a file's text from a previous revision."""
1933
takes_options = ['revision', 'name-from-revision']
1934
takes_args = ['filename']
1935
encoding_type = 'exact'
1938
def run(self, filename, revision=None, name_from_revision=False):
1939
if revision is not None and len(revision) != 1:
1940
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1945
tree, relpath = WorkingTree.open_containing(filename)
1947
except (errors.NotBranchError, errors.NotLocalUrl):
1950
if revision is not None and revision[0].get_branch() is not None:
1951
b = Branch.open(revision[0].get_branch())
1953
b, relpath = Branch.open_containing(filename)
1954
tree = b.basis_tree()
1955
if revision is None:
1956
revision_id = b.last_revision()
1958
revision_id = revision[0].in_history(b).rev_id
1960
cur_file_id = tree.path2id(relpath)
1961
rev_tree = b.repository.revision_tree(revision_id)
1962
old_file_id = rev_tree.path2id(relpath)
1964
if name_from_revision:
1965
if old_file_id is None:
1966
raise errors.BzrCommandError("%r is not present in revision %s"
1967
% (filename, revision_id))
1969
rev_tree.print_file(old_file_id)
1970
elif cur_file_id is not None:
1971
rev_tree.print_file(cur_file_id)
1972
elif old_file_id is not None:
1973
rev_tree.print_file(old_file_id)
1975
raise errors.BzrCommandError("%r is not present in revision %s" %
1976
(filename, revision_id))
1979
class cmd_local_time_offset(Command):
1980
"""Show the offset in seconds from GMT to local time."""
1984
print osutils.local_time_offset()
1988
class cmd_commit(Command):
1989
"""Commit changes into a new revision.
1991
If no arguments are given, the entire tree is committed.
1993
If selected files are specified, only changes to those files are
1994
committed. If a directory is specified then the directory and everything
1995
within it is committed.
1997
A selected-file commit may fail in some cases where the committed
1998
tree would be invalid, such as trying to commit a file in a
1999
newly-added directory that is not itself committed.
2001
# TODO: Run hooks on tree to-be-committed, and after commit.
2003
# TODO: Strict commit that fails if there are deleted files.
2004
# (what does "deleted files" mean ??)
2006
# TODO: Give better message for -s, --summary, used by tla people
2008
# XXX: verbose currently does nothing
2010
takes_args = ['selected*']
2011
takes_options = ['message', 'verbose',
2013
help='commit even if nothing has changed'),
2014
Option('file', type=str,
2017
help='file containing commit message'),
2019
help="refuse to commit if there are unknown "
2020
"files in the working tree."),
2022
help="perform a local only commit in a bound "
2023
"branch. Such commits are not pushed to "
2024
"the master branch until a normal commit "
2028
aliases = ['ci', 'checkin']
2030
def run(self, message=None, file=None, verbose=True, selected_list=None,
2031
unchanged=False, strict=False, local=False):
2032
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2033
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2035
from bzrlib.msgeditor import edit_commit_message, \
2036
make_commit_message_template
2038
# TODO: Need a blackbox test for invoking the external editor; may be
2039
# slightly problematic to run this cross-platform.
2041
# TODO: do more checks that the commit will succeed before
2042
# spending the user's valuable time typing a commit message.
2043
tree, selected_list = tree_files(selected_list)
2044
if selected_list == ['']:
2045
# workaround - commit of root of tree should be exactly the same
2046
# as just default commit in that tree, and succeed even though
2047
# selected-file merge commit is not done yet
2050
if local and not tree.branch.get_bound_location():
2051
raise errors.LocalRequiresBoundBranch()
2053
def get_message(commit_obj):
2054
"""Callback to get commit message"""
2055
my_message = message
2056
if my_message is None and not file:
2057
template = make_commit_message_template(tree, selected_list)
2058
my_message = edit_commit_message(template)
2059
if my_message is None:
2060
raise errors.BzrCommandError("please specify a commit"
2061
" message with either --message or --file")
2062
elif my_message and file:
2063
raise errors.BzrCommandError(
2064
"please specify either --message or --file")
2066
my_message = codecs.open(file, 'rt',
2067
bzrlib.user_encoding).read()
2068
if my_message == "":
2069
raise errors.BzrCommandError("empty commit message specified")
2073
reporter = ReportCommitToLog()
2075
reporter = NullCommitReporter()
2078
tree.commit(message_callback=get_message,
2079
specific_files=selected_list,
2080
allow_pointless=unchanged, strict=strict, local=local,
2082
except PointlessCommit:
2083
# FIXME: This should really happen before the file is read in;
2084
# perhaps prepare the commit; get the message; then actually commit
2085
raise errors.BzrCommandError("no changes to commit."
2086
" use --unchanged to commit anyhow")
2087
except ConflictsInTree:
2088
raise errors.BzrCommandError('Conflicts detected in working '
2089
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2091
except StrictCommitFailed:
2092
raise errors.BzrCommandError("Commit refused because there are"
2093
" unknown files in the working tree.")
2094
except errors.BoundBranchOutOfDate, e:
2095
raise errors.BzrCommandError(str(e) + "\n"
2096
'To commit to master branch, run update and then commit.\n'
2097
'You can also pass --local to commit to continue working '
2101
class cmd_check(Command):
2102
"""Validate consistency of branch history.
2104
This command checks various invariants about the branch storage to
2105
detect data corruption or bzr bugs.
2107
takes_args = ['branch?']
2108
takes_options = ['verbose']
2110
def run(self, branch=None, verbose=False):
2111
from bzrlib.check import check
2113
tree = WorkingTree.open_containing()[0]
2114
branch = tree.branch
2116
branch = Branch.open(branch)
2117
check(branch, verbose)
2120
class cmd_upgrade(Command):
2121
"""Upgrade branch storage to current format.
2123
The check command or bzr developers may sometimes advise you to run
2124
this command. When the default format has changed you may also be warned
2125
during other operations to upgrade.
2127
takes_args = ['url?']
2129
RegistryOption('format',
2130
help='Upgrade to a specific format. See "bzr help'
2131
' formats" for details',
2132
registry=bzrdir.format_registry,
2133
converter=bzrdir.format_registry.make_bzrdir,
2134
value_switches=True, title='Branch format'),
2138
def run(self, url='.', format=None):
2139
from bzrlib.upgrade import upgrade
2141
format = bzrdir.format_registry.make_bzrdir('default')
2142
upgrade(url, format)
2145
class cmd_whoami(Command):
2146
"""Show or set bzr user id.
2150
bzr whoami 'Frank Chu <fchu@example.com>'
2152
takes_options = [ Option('email',
2153
help='display email address only'),
2155
help='set identity for the current branch instead of '
2158
takes_args = ['name?']
2159
encoding_type = 'replace'
2162
def run(self, email=False, branch=False, name=None):
2164
# use branch if we're inside one; otherwise global config
2166
c = Branch.open_containing('.')[0].get_config()
2167
except errors.NotBranchError:
2168
c = config.GlobalConfig()
2170
self.outf.write(c.user_email() + '\n')
2172
self.outf.write(c.username() + '\n')
2175
# display a warning if an email address isn't included in the given name.
2177
config.extract_email_address(name)
2178
except errors.NoEmailInUsername, e:
2179
warning('"%s" does not seem to contain an email address. '
2180
'This is allowed, but not recommended.', name)
2182
# use global config unless --branch given
2184
c = Branch.open_containing('.')[0].get_config()
2186
c = config.GlobalConfig()
2187
c.set_user_option('email', name)
2190
class cmd_nick(Command):
2191
"""Print or set the branch nickname.
2193
If unset, the tree root directory name is used as the nickname
2194
To print the current nickname, execute with no argument.
2196
takes_args = ['nickname?']
2197
def run(self, nickname=None):
2198
branch = Branch.open_containing(u'.')[0]
2199
if nickname is None:
2200
self.printme(branch)
2202
branch.nick = nickname
2205
def printme(self, branch):
2209
class cmd_selftest(Command):
2210
"""Run internal test suite.
2212
This creates temporary test directories in the working directory, but not
2213
existing data is affected. These directories are deleted if the tests
2214
pass, or left behind to help in debugging if they fail and --keep-output
2217
If arguments are given, they are regular expressions that say which tests
2218
should run. Tests matching any expression are run, and other tests are
2221
Alternatively if --first is given, matching tests are run first and then
2222
all other tests are run. This is useful if you have been working in a
2223
particular area, but want to make sure nothing else was broken.
2225
If the global option '--no-plugins' is given, plugins are not loaded
2226
before running the selftests. This has two effects: features provided or
2227
modified by plugins will not be tested, and tests provided by plugins will
2232
run only tests relating to 'ignore'
2233
bzr --no-plugins selftest -v
2234
disable plugins and list tests as they're run
2236
# TODO: --list should give a list of all available tests
2238
# NB: this is used from the class without creating an instance, which is
2239
# why it does not have a self parameter.
2240
def get_transport_type(typestring):
2241
"""Parse and return a transport specifier."""
2242
if typestring == "sftp":
2243
from bzrlib.transport.sftp import SFTPAbsoluteServer
2244
return SFTPAbsoluteServer
2245
if typestring == "memory":
2246
from bzrlib.transport.memory import MemoryServer
2248
if typestring == "fakenfs":
2249
from bzrlib.transport.fakenfs import FakeNFSServer
2250
return FakeNFSServer
2251
msg = "No known transport type %s. Supported types are: sftp\n" %\
2253
raise errors.BzrCommandError(msg)
2256
takes_args = ['testspecs*']
2257
takes_options = ['verbose',
2258
Option('one', help='stop when one test fails'),
2259
Option('keep-output',
2260
help='keep output directories when tests fail'),
2262
help='Use a different transport by default '
2263
'throughout the test suite.',
2264
type=get_transport_type),
2265
Option('benchmark', help='run the bzr bencharks.'),
2266
Option('lsprof-timed',
2267
help='generate lsprof output for benchmarked'
2268
' sections of code.'),
2269
Option('cache-dir', type=str,
2270
help='a directory to cache intermediate'
2271
' benchmark steps'),
2272
Option('clean-output',
2273
help='clean temporary tests directories'
2274
' without running tests'),
2276
help='run all tests, but run specified tests first',
2279
encoding_type = 'replace'
2281
def run(self, testspecs_list=None, verbose=None, one=False,
2282
keep_output=False, transport=None, benchmark=None,
2283
lsprof_timed=None, cache_dir=None, clean_output=False,
2286
from bzrlib.tests import selftest
2287
import bzrlib.benchmarks as benchmarks
2288
from bzrlib.benchmarks import tree_creator
2291
from bzrlib.tests import clean_selftest_output
2292
clean_selftest_output()
2295
if cache_dir is not None:
2296
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2297
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2298
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2300
if testspecs_list is not None:
2301
pattern = '|'.join(testspecs_list)
2305
test_suite_factory = benchmarks.test_suite
2308
# TODO: should possibly lock the history file...
2309
benchfile = open(".perf_history", "at", buffering=1)
2311
test_suite_factory = None
2316
result = selftest(verbose=verbose,
2318
stop_on_failure=one,
2319
keep_output=keep_output,
2320
transport=transport,
2321
test_suite_factory=test_suite_factory,
2322
lsprof_timed=lsprof_timed,
2323
bench_history=benchfile,
2324
matching_tests_first=first,
2327
if benchfile is not None:
2330
info('tests passed')
2332
info('tests failed')
2333
return int(not result)
2336
class cmd_version(Command):
2337
"""Show version of bzr."""
2341
from bzrlib.version import show_version
2345
class cmd_rocks(Command):
2346
"""Statement of optimism."""
2352
print "it sure does!"
2355
class cmd_find_merge_base(Command):
2356
"""Find and print a base revision for merging two branches."""
2357
# TODO: Options to specify revisions on either side, as if
2358
# merging only part of the history.
2359
takes_args = ['branch', 'other']
2363
def run(self, branch, other):
2364
from bzrlib.revision import MultipleRevisionSources
2366
branch1 = Branch.open_containing(branch)[0]
2367
branch2 = Branch.open_containing(other)[0]
2369
last1 = branch1.last_revision()
2370
last2 = branch2.last_revision()
2372
source = MultipleRevisionSources(branch1.repository,
2375
base_rev_id = common_ancestor(last1, last2, source)
2377
print 'merge base is revision %s' % base_rev_id
2380
class cmd_merge(Command):
2381
"""Perform a three-way merge.
2383
The branch is the branch you will merge from. By default, it will merge
2384
the latest revision. If you specify a revision, that revision will be
2385
merged. If you specify two revisions, the first will be used as a BASE,
2386
and the second one as OTHER. Revision numbers are always relative to the
2389
By default, bzr will try to merge in all new work from the other
2390
branch, automatically determining an appropriate base. If this
2391
fails, you may need to give an explicit base.
2393
Merge will do its best to combine the changes in two branches, but there
2394
are some kinds of problems only a human can fix. When it encounters those,
2395
it will mark a conflict. A conflict means that you need to fix something,
2396
before you should commit.
2398
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2400
If there is no default branch set, the first merge will set it. After
2401
that, you can omit the branch to use the default. To change the
2402
default, use --remember. The value will only be saved if the remote
2403
location can be accessed.
2405
The results of the merge are placed into the destination working
2406
directory, where they can be reviewed (with bzr diff), tested, and then
2407
committed to record the result of the merge.
2411
To merge the latest revision from bzr.dev
2412
bzr merge ../bzr.dev
2414
To merge changes up to and including revision 82 from bzr.dev
2415
bzr merge -r 82 ../bzr.dev
2417
To merge the changes introduced by 82, without previous changes:
2418
bzr merge -r 81..82 ../bzr.dev
2420
merge refuses to run if there are any uncommitted changes, unless
2423
The following merge types are available:
2425
takes_args = ['branch?']
2426
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2427
Option('show-base', help="Show base revision text in "
2429
Option('uncommitted', help='Apply uncommitted changes'
2430
' from a working copy, instead of branch changes'),
2431
Option('pull', help='If the destination is already'
2432
' completely merged into the source, pull from the'
2433
' source rather than merging. When this happens,'
2434
' you do not need to commit the result.'),
2436
help='Branch to merge into, '
2437
'rather than the one containing the working directory',
2443
def run(self, branch=None, revision=None, force=False, merge_type=None,
2444
show_base=False, reprocess=False, remember=False,
2445
uncommitted=False, pull=False,
2448
if merge_type is None:
2449
merge_type = _mod_merge.Merge3Merger
2451
if directory is None: directory = u'.'
2452
tree = WorkingTree.open_containing(directory)[0]
2453
change_reporter = delta.ChangeReporter(tree.inventory)
2455
if branch is not None:
2457
reader = bundle.read_bundle_from_url(branch)
2458
except errors.NotABundle:
2459
pass # Continue on considering this url a Branch
2461
conflicts = merge_bundle(reader, tree, not force, merge_type,
2462
reprocess, show_base, change_reporter)
2468
if revision is None \
2469
or len(revision) < 1 or revision[0].needs_branch():
2470
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2472
if revision is None or len(revision) < 1:
2475
other = [branch, None]
2478
other = [branch, -1]
2479
other_branch, path = Branch.open_containing(branch)
2482
raise errors.BzrCommandError('Cannot use --uncommitted and'
2483
' --revision at the same time.')
2484
branch = revision[0].get_branch() or branch
2485
if len(revision) == 1:
2487
other_branch, path = Branch.open_containing(branch)
2488
revno = revision[0].in_history(other_branch).revno
2489
other = [branch, revno]
2491
assert len(revision) == 2
2492
if None in revision:
2493
raise errors.BzrCommandError(
2494
"Merge doesn't permit empty revision specifier.")
2495
base_branch, path = Branch.open_containing(branch)
2496
branch1 = revision[1].get_branch() or branch
2497
other_branch, path1 = Branch.open_containing(branch1)
2498
if revision[0].get_branch() is not None:
2499
# then path was obtained from it, and is None.
2502
base = [branch, revision[0].in_history(base_branch).revno]
2503
other = [branch1, revision[1].in_history(other_branch).revno]
2505
if tree.branch.get_parent() is None or remember:
2506
tree.branch.set_parent(other_branch.base)
2508
# pull tags now... it's a bit inconsistent to do it ahead of copying
2509
# the history but that's done inside the merge code
2510
_copy_tags_maybe(other_branch, tree.branch)
2513
interesting_files = [path]
2515
interesting_files = None
2516
pb = ui.ui_factory.nested_progress_bar()
2519
conflict_count = _merge_helper(
2520
other, base, check_clean=(not force),
2521
merge_type=merge_type,
2522
reprocess=reprocess,
2523
show_base=show_base,
2526
pb=pb, file_list=interesting_files,
2527
change_reporter=change_reporter)
2530
if conflict_count != 0:
2534
except errors.AmbiguousBase, e:
2535
m = ("sorry, bzr can't determine the right merge base yet\n"
2536
"candidates are:\n "
2537
+ "\n ".join(e.bases)
2539
"please specify an explicit base with -r,\n"
2540
"and (if you want) report this to the bzr developers\n")
2543
# TODO: move up to common parent; this isn't merge-specific anymore.
2544
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2545
"""Use tree.branch's parent if none was supplied.
2547
Report if the remembered location was used.
2549
if supplied_location is not None:
2550
return supplied_location
2551
stored_location = tree.branch.get_parent()
2552
mutter("%s", stored_location)
2553
if stored_location is None:
2554
raise errors.BzrCommandError("No location specified or remembered")
2555
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2556
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2557
return stored_location
2560
class cmd_remerge(Command):
2563
Use this if you want to try a different merge technique while resolving
2564
conflicts. Some merge techniques are better than others, and remerge
2565
lets you try different ones on different files.
2567
The options for remerge have the same meaning and defaults as the ones for
2568
merge. The difference is that remerge can (only) be run when there is a
2569
pending merge, and it lets you specify particular files.
2572
$ bzr remerge --show-base
2573
Re-do the merge of all conflicted files, and show the base text in
2574
conflict regions, in addition to the usual THIS and OTHER texts.
2576
$ bzr remerge --merge-type weave --reprocess foobar
2577
Re-do the merge of "foobar", using the weave merge algorithm, with
2578
additional processing to reduce the size of conflict regions.
2580
The following merge types are available:"""
2581
takes_args = ['file*']
2582
takes_options = ['merge-type', 'reprocess',
2583
Option('show-base', help="Show base revision text in "
2586
def run(self, file_list=None, merge_type=None, show_base=False,
2588
if merge_type is None:
2589
merge_type = _mod_merge.Merge3Merger
2590
tree, file_list = tree_files(file_list)
2593
parents = tree.get_parent_ids()
2594
if len(parents) != 2:
2595
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2596
" merges. Not cherrypicking or"
2598
repository = tree.branch.repository
2599
base_revision = common_ancestor(parents[0],
2600
parents[1], repository)
2601
base_tree = repository.revision_tree(base_revision)
2602
other_tree = repository.revision_tree(parents[1])
2603
interesting_ids = None
2605
conflicts = tree.conflicts()
2606
if file_list is not None:
2607
interesting_ids = set()
2608
for filename in file_list:
2609
file_id = tree.path2id(filename)
2611
raise errors.NotVersionedError(filename)
2612
interesting_ids.add(file_id)
2613
if tree.kind(file_id) != "directory":
2616
for name, ie in tree.inventory.iter_entries(file_id):
2617
interesting_ids.add(ie.file_id)
2618
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2620
# Remerge only supports resolving contents conflicts
2621
allowed_conflicts = ('text conflict', 'contents conflict')
2622
restore_files = [c.path for c in conflicts
2623
if c.typestring in allowed_conflicts]
2624
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2625
tree.set_conflicts(ConflictList(new_conflicts))
2626
if file_list is not None:
2627
restore_files = file_list
2628
for filename in restore_files:
2630
restore(tree.abspath(filename))
2631
except errors.NotConflicted:
2633
conflicts = _mod_merge.merge_inner(
2634
tree.branch, other_tree, base_tree,
2636
interesting_ids=interesting_ids,
2637
other_rev_id=parents[1],
2638
merge_type=merge_type,
2639
show_base=show_base,
2640
reprocess=reprocess)
2649
class cmd_revert(Command):
2650
"""Revert files to a previous revision.
2652
Giving a list of files will revert only those files. Otherwise, all files
2653
will be reverted. If the revision is not specified with '--revision', the
2654
last committed revision is used.
2656
To remove only some changes, without reverting to a prior version, use
2657
merge instead. For example, "merge . --r-2..-3" will remove the changes
2658
introduced by -2, without affecting the changes introduced by -1. Or
2659
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2661
By default, any files that have been manually changed will be backed up
2662
first. (Files changed only by merge are not backed up.) Backup files have
2663
'.~#~' appended to their name, where # is a number.
2665
When you provide files, you can use their current pathname or the pathname
2666
from the target revision. So you can use revert to "undelete" a file by
2667
name. If you name a directory, all the contents of that directory will be
2670
takes_options = ['revision', 'no-backup']
2671
takes_args = ['file*']
2672
aliases = ['merge-revert']
2674
def run(self, revision=None, no_backup=False, file_list=None):
2675
if file_list is not None:
2676
if len(file_list) == 0:
2677
raise errors.BzrCommandError("No files specified")
2681
tree, file_list = tree_files(file_list)
2682
if revision is None:
2683
# FIXME should be tree.last_revision
2684
rev_id = tree.last_revision()
2685
elif len(revision) != 1:
2686
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2688
rev_id = revision[0].in_history(tree.branch).rev_id
2689
pb = ui.ui_factory.nested_progress_bar()
2691
tree.revert(file_list,
2692
tree.branch.repository.revision_tree(rev_id),
2693
not no_backup, pb, report_changes=True)
2698
class cmd_assert_fail(Command):
2699
"""Test reporting of assertion failures"""
2700
# intended just for use in testing
2705
raise AssertionError("always fails")
2708
class cmd_help(Command):
2709
"""Show help on a command or other topic.
2711
For a list of all available commands, say 'bzr help commands'.
2713
takes_options = [Option('long', 'show help on all commands')]
2714
takes_args = ['topic?']
2715
aliases = ['?', '--help', '-?', '-h']
2718
def run(self, topic=None, long=False):
2720
if topic is None and long:
2722
bzrlib.help.help(topic)
2725
class cmd_shell_complete(Command):
2726
"""Show appropriate completions for context.
2728
For a list of all available commands, say 'bzr shell-complete'.
2730
takes_args = ['context?']
2735
def run(self, context=None):
2736
import shellcomplete
2737
shellcomplete.shellcomplete(context)
2740
class cmd_fetch(Command):
2741
"""Copy in history from another branch but don't merge it.
2743
This is an internal method used for pull and merge.
2746
takes_args = ['from_branch', 'to_branch']
2747
def run(self, from_branch, to_branch):
2748
from bzrlib.fetch import Fetcher
2749
from_b = Branch.open(from_branch)
2750
to_b = Branch.open(to_branch)
2751
Fetcher(to_b, from_b)
2754
class cmd_missing(Command):
2755
"""Show unmerged/unpulled revisions between two branches.
2757
OTHER_BRANCH may be local or remote.
2759
takes_args = ['other_branch?']
2760
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2762
'Display changes in the local branch only'),
2763
Option('theirs-only',
2764
'Display changes in the remote branch only'),
2769
encoding_type = 'replace'
2772
def run(self, other_branch=None, reverse=False, mine_only=False,
2773
theirs_only=False, log_format=None, long=False, short=False, line=False,
2774
show_ids=False, verbose=False):
2775
from bzrlib.missing import find_unmerged, iter_log_data
2776
from bzrlib.log import log_formatter
2777
local_branch = Branch.open_containing(u".")[0]
2778
parent = local_branch.get_parent()
2779
if other_branch is None:
2780
other_branch = parent
2781
if other_branch is None:
2782
raise errors.BzrCommandError("No peer location known or specified.")
2783
display_url = urlutils.unescape_for_display(parent,
2785
print "Using last location: " + display_url
2787
remote_branch = Branch.open(other_branch)
2788
if remote_branch.base == local_branch.base:
2789
remote_branch = local_branch
2790
local_branch.lock_read()
2792
remote_branch.lock_read()
2794
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2795
if (log_format is None):
2796
log_format = log.log_formatter_registry.get_default(
2798
lf = log_format(to_file=self.outf,
2800
show_timezone='original')
2801
if reverse is False:
2802
local_extra.reverse()
2803
remote_extra.reverse()
2804
if local_extra and not theirs_only:
2805
print "You have %d extra revision(s):" % len(local_extra)
2806
for data in iter_log_data(local_extra, local_branch.repository,
2809
printed_local = True
2811
printed_local = False
2812
if remote_extra and not mine_only:
2813
if printed_local is True:
2815
print "You are missing %d revision(s):" % len(remote_extra)
2816
for data in iter_log_data(remote_extra, remote_branch.repository,
2819
if not remote_extra and not local_extra:
2821
print "Branches are up to date."
2825
remote_branch.unlock()
2827
local_branch.unlock()
2828
if not status_code and parent is None and other_branch is not None:
2829
local_branch.lock_write()
2831
# handle race conditions - a parent might be set while we run.
2832
if local_branch.get_parent() is None:
2833
local_branch.set_parent(remote_branch.base)
2835
local_branch.unlock()
2839
class cmd_plugins(Command):
2844
import bzrlib.plugin
2845
from inspect import getdoc
2846
for name, plugin in bzrlib.plugin.all_plugins().items():
2847
if getattr(plugin, '__path__', None) is not None:
2848
print plugin.__path__[0]
2849
elif getattr(plugin, '__file__', None) is not None:
2850
print plugin.__file__
2856
print '\t', d.split('\n')[0]
2859
class cmd_testament(Command):
2860
"""Show testament (signing-form) of a revision."""
2861
takes_options = ['revision',
2862
Option('long', help='Produce long-format testament'),
2863
Option('strict', help='Produce a strict-format'
2865
takes_args = ['branch?']
2867
def run(self, branch=u'.', revision=None, long=False, strict=False):
2868
from bzrlib.testament import Testament, StrictTestament
2870
testament_class = StrictTestament
2872
testament_class = Testament
2873
b = WorkingTree.open_containing(branch)[0].branch
2876
if revision is None:
2877
rev_id = b.last_revision()
2879
rev_id = revision[0].in_history(b).rev_id
2880
t = testament_class.from_revision(b.repository, rev_id)
2882
sys.stdout.writelines(t.as_text_lines())
2884
sys.stdout.write(t.as_short_text())
2889
class cmd_annotate(Command):
2890
"""Show the origin of each line in a file.
2892
This prints out the given file with an annotation on the left side
2893
indicating which revision, author and date introduced the change.
2895
If the origin is the same for a run of consecutive lines, it is
2896
shown only at the top, unless the --all option is given.
2898
# TODO: annotate directories; showing when each file was last changed
2899
# TODO: if the working copy is modified, show annotations on that
2900
# with new uncommitted lines marked
2901
aliases = ['ann', 'blame', 'praise']
2902
takes_args = ['filename']
2903
takes_options = [Option('all', help='show annotations on all lines'),
2904
Option('long', help='show date in annotations'),
2910
def run(self, filename, all=False, long=False, revision=None,
2912
from bzrlib.annotate import annotate_file
2913
tree, relpath = WorkingTree.open_containing(filename)
2914
branch = tree.branch
2917
if revision is None:
2918
revision_id = branch.last_revision()
2919
elif len(revision) != 1:
2920
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2922
revision_id = revision[0].in_history(branch).rev_id
2923
file_id = tree.inventory.path2id(relpath)
2924
tree = branch.repository.revision_tree(revision_id)
2925
file_version = tree.inventory[file_id].revision
2926
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2932
class cmd_re_sign(Command):
2933
"""Create a digital signature for an existing revision."""
2934
# TODO be able to replace existing ones.
2936
hidden = True # is this right ?
2937
takes_args = ['revision_id*']
2938
takes_options = ['revision']
2940
def run(self, revision_id_list=None, revision=None):
2941
import bzrlib.gpg as gpg
2942
if revision_id_list is not None and revision is not None:
2943
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2944
if revision_id_list is None and revision is None:
2945
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2946
b = WorkingTree.open_containing(u'.')[0].branch
2947
gpg_strategy = gpg.GPGStrategy(b.get_config())
2948
if revision_id_list is not None:
2949
for revision_id in revision_id_list:
2950
b.repository.sign_revision(revision_id, gpg_strategy)
2951
elif revision is not None:
2952
if len(revision) == 1:
2953
revno, rev_id = revision[0].in_history(b)
2954
b.repository.sign_revision(rev_id, gpg_strategy)
2955
elif len(revision) == 2:
2956
# are they both on rh- if so we can walk between them
2957
# might be nice to have a range helper for arbitrary
2958
# revision paths. hmm.
2959
from_revno, from_revid = revision[0].in_history(b)
2960
to_revno, to_revid = revision[1].in_history(b)
2961
if to_revid is None:
2962
to_revno = b.revno()
2963
if from_revno is None or to_revno is None:
2964
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2965
for revno in range(from_revno, to_revno + 1):
2966
b.repository.sign_revision(b.get_rev_id(revno),
2969
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2972
class cmd_bind(Command):
2973
"""Convert the current branch into a checkout of the supplied branch.
2975
Once converted into a checkout, commits must succeed on the master branch
2976
before they will be applied to the local branch.
2978
See "help checkouts" for more information on checkouts.
2981
takes_args = ['location?']
2984
def run(self, location=None):
2985
b, relpath = Branch.open_containing(u'.')
2986
if location is None:
2988
location = b.get_old_bound_location()
2989
except errors.UpgradeRequired:
2990
raise errors.BzrCommandError('No location supplied. '
2991
'This format does not remember old locations.')
2993
if location is None:
2994
raise errors.BzrCommandError('No location supplied and no '
2995
'previous location known')
2996
b_other = Branch.open(location)
2999
except errors.DivergedBranches:
3000
raise errors.BzrCommandError('These branches have diverged.'
3001
' Try merging, and then bind again.')
3004
class cmd_unbind(Command):
3005
"""Convert the current checkout into a regular branch.
3007
After unbinding, the local branch is considered independent and subsequent
3008
commits will be local only.
3010
See "help checkouts" for more information on checkouts.
3017
b, relpath = Branch.open_containing(u'.')
3019
raise errors.BzrCommandError('Local branch is not bound')
3022
class cmd_uncommit(Command):
3023
"""Remove the last committed revision.
3025
--verbose will print out what is being removed.
3026
--dry-run will go through all the motions, but not actually
3029
In the future, uncommit will create a revision bundle, which can then
3033
# TODO: jam 20060108 Add an option to allow uncommit to remove
3034
# unreferenced information in 'branch-as-repository' branches.
3035
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3036
# information in shared branches as well.
3037
takes_options = ['verbose', 'revision',
3038
Option('dry-run', help='Don\'t actually make changes'),
3039
Option('force', help='Say yes to all questions.')]
3040
takes_args = ['location?']
3043
def run(self, location=None,
3044
dry_run=False, verbose=False,
3045
revision=None, force=False):
3046
from bzrlib.log import log_formatter, show_log
3048
from bzrlib.uncommit import uncommit
3050
if location is None:
3052
control, relpath = bzrdir.BzrDir.open_containing(location)
3054
tree = control.open_workingtree()
3056
except (errors.NoWorkingTree, errors.NotLocalUrl):
3058
b = control.open_branch()
3061
if revision is None:
3064
# 'bzr uncommit -r 10' actually means uncommit
3065
# so that the final tree is at revno 10.
3066
# but bzrlib.uncommit.uncommit() actually uncommits
3067
# the revisions that are supplied.
3068
# So we need to offset it by one
3069
revno = revision[0].in_history(b).revno+1
3071
if revno <= b.revno():
3072
rev_id = b.get_rev_id(revno)
3074
self.outf.write('No revisions to uncommit.\n')
3077
lf = log_formatter('short',
3079
show_timezone='original')
3084
direction='forward',
3085
start_revision=revno,
3086
end_revision=b.revno())
3089
print 'Dry-run, pretending to remove the above revisions.'
3091
val = raw_input('Press <enter> to continue')
3093
print 'The above revision(s) will be removed.'
3095
val = raw_input('Are you sure [y/N]? ')
3096
if val.lower() not in ('y', 'yes'):
3100
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3104
class cmd_break_lock(Command):
3105
"""Break a dead lock on a repository, branch or working directory.
3107
CAUTION: Locks should only be broken when you are sure that the process
3108
holding the lock has been stopped.
3110
You can get information on what locks are open via the 'bzr info' command.
3115
takes_args = ['location?']
3117
def run(self, location=None, show=False):
3118
if location is None:
3120
control, relpath = bzrdir.BzrDir.open_containing(location)
3122
control.break_lock()
3123
except NotImplementedError:
3127
class cmd_wait_until_signalled(Command):
3128
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3130
This just prints a line to signal when it is ready, then blocks on stdin.
3136
sys.stdout.write("running\n")
3138
sys.stdin.readline()
3141
class cmd_serve(Command):
3142
"""Run the bzr server."""
3144
aliases = ['server']
3148
help='serve on stdin/out for use from inetd or sshd'),
3150
help='listen for connections on nominated port of the form '
3151
'[hostname:]portnumber. Passing 0 as the port number will '
3152
'result in a dynamically allocated port.',
3155
help='serve contents of directory',
3157
Option('allow-writes',
3158
help='By default the server is a readonly server. Supplying '
3159
'--allow-writes enables write access to the contents of '
3160
'the served directory and below. '
3164
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3165
from bzrlib.transport import smart
3166
from bzrlib.transport import get_transport
3167
if directory is None:
3168
directory = os.getcwd()
3169
url = urlutils.local_path_to_url(directory)
3170
if not allow_writes:
3171
url = 'readonly+' + url
3172
t = get_transport(url)
3174
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3175
elif port is not None:
3177
host, port = port.split(':')
3180
server = smart.SmartTCPServer(t, host=host, port=int(port))
3181
print 'listening on port: ', server.port
3184
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
3188
class cmd_tag(Command):
3189
"""Create a tag naming a revision.
3191
Tags give human-meaningful names to revisions. Commands that take a -r
3192
(--revision) option can be given -rtag:X, where X is any previously
3195
Tags are stored in the repository, and apply to all branches stored
3196
in the repository. Tags are copied from one branch to another along
3197
when you branch, push, pull or merge.
3200
takes_args = ['tag_name']
3203
help='branch in which to place the tag',
3208
help='Delete this tag rather than placing it',
3213
def run(self, tag_name, directory='.',
3216
branch, relpath = Branch.open_containing(directory)
3218
branch.tags.delete_tag(tag_name)
3219
self.outf.write('deleted tag %s' % tag_name)
3222
if len(revision) != 1:
3223
raise errors.BzrCommandError(
3224
"Tags can only be placed on a single revision, "
3226
revision_id = revision[0].in_history(branch).rev_id
3228
revision_id = branch.last_revision()
3229
branch.tags.set_tag(tag_name, revision_id)
3230
self.outf.write('created tag %s' % tag_name)
3233
class cmd_tags(Command):
3236
This tag shows a table of tag names and the revisions they reference.
3241
help='Branch whose tags should be displayed',
3251
branch, relpath = Branch.open_containing(directory)
3252
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3253
self.outf.write('%-40s %s' % (tag_name, target))
3256
# command-line interpretation helper for merge-related commands
3257
def _merge_helper(other_revision, base_revision,
3258
check_clean=True, ignore_zero=False,
3259
this_dir=None, backup_files=False,
3261
file_list=None, show_base=False, reprocess=False,
3264
change_reporter=None):
3265
"""Merge changes into a tree.
3268
list(path, revno) Base for three-way merge.
3269
If [None, None] then a base will be automatically determined.
3271
list(path, revno) Other revision for three-way merge.
3273
Directory to merge changes into; '.' by default.
3275
If true, this_dir must have no uncommitted changes before the
3277
ignore_zero - If true, suppress the "zero conflicts" message when
3278
there are no conflicts; should be set when doing something we expect
3279
to complete perfectly.
3280
file_list - If supplied, merge only changes to selected files.
3282
All available ancestors of other_revision and base_revision are
3283
automatically pulled into the branch.
3285
The revno may be -1 to indicate the last revision on the branch, which is
3288
This function is intended for use from the command line; programmatic
3289
clients might prefer to call merge.merge_inner(), which has less magic
3292
# Loading it late, so that we don't always have to import bzrlib.merge
3293
if merge_type is None:
3294
merge_type = _mod_merge.Merge3Merger
3295
if this_dir is None:
3297
this_tree = WorkingTree.open_containing(this_dir)[0]
3298
if show_base and not merge_type is _mod_merge.Merge3Merger:
3299
raise errors.BzrCommandError("Show-base is not supported for this merge"
3300
" type. %s" % merge_type)
3301
if reprocess and not merge_type.supports_reprocess:
3302
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3303
" type %s." % merge_type)
3304
if reprocess and show_base:
3305
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3307
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3308
pb=pb, change_reporter=change_reporter)
3309
merger.pp = ProgressPhase("Merge phase", 5, pb)
3310
merger.pp.next_phase()
3311
merger.check_basis(check_clean)
3312
merger.set_other(other_revision)
3313
merger.pp.next_phase()
3314
merger.set_base(base_revision)
3315
if merger.base_rev_id == merger.other_rev_id:
3316
note('Nothing to do.')
3318
if file_list is None:
3319
if pull and merger.base_rev_id == merger.this_rev_id:
3320
count = merger.this_tree.pull(merger.this_branch,
3321
False, merger.other_rev_id)
3322
note('%d revision(s) pulled.' % (count,))
3324
merger.backup_files = backup_files
3325
merger.merge_type = merge_type
3326
merger.set_interesting_files(file_list)
3327
merger.show_base = show_base
3328
merger.reprocess = reprocess
3329
conflicts = merger.do_merge()
3330
if file_list is None:
3331
merger.set_pending()
3338
merge = _merge_helper
3341
# these get imported and then picked up by the scan for cmd_*
3342
# TODO: Some more consistent way to split command definitions across files;
3343
# we do need to load at least some information about them to know of
3344
# aliases. ideally we would avoid loading the implementation until the
3345
# details were needed.
3346
from bzrlib.cmd_version_info import cmd_version_info
3347
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3348
from bzrlib.bundle.commands import cmd_bundle_revisions
3349
from bzrlib.sign_my_commits import cmd_sign_my_commits
3350
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3351
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
