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
from bzrlib.tag import _merge_tags_if_possible
553
# FIXME: too much stuff is in the command class
554
if directory is None:
557
tree_to = WorkingTree.open_containing(directory)[0]
558
branch_to = tree_to.branch
559
except errors.NoWorkingTree:
561
branch_to = Branch.open_containing(directory)[0]
564
if location is not None:
566
reader = bundle.read_bundle_from_url(location)
567
except errors.NotABundle:
568
pass # Continue on considering this url a Branch
570
stored_loc = branch_to.get_parent()
572
if stored_loc is None:
573
raise errors.BzrCommandError("No pull location known or"
576
display_url = urlutils.unescape_for_display(stored_loc,
578
self.outf.write("Using saved location: %s\n" % display_url)
579
location = stored_loc
581
if reader is not None:
582
install_bundle(branch_to.repository, reader)
583
branch_from = branch_to
585
branch_from = Branch.open(location)
587
if branch_to.get_parent() is None or remember:
588
branch_to.set_parent(branch_from.base)
592
if reader is not None:
593
rev_id = reader.target
594
elif len(revision) == 1:
595
rev_id = revision[0].in_history(branch_from).rev_id
597
raise errors.BzrCommandError('bzr pull --revision takes one value.')
599
old_rh = branch_to.revision_history()
600
if tree_to is not None:
601
result = tree_to.pull(branch_from, overwrite, rev_id,
602
delta.ChangeReporter(tree_to.inventory))
604
result = branch_to.pull(branch_from, overwrite, rev_id)
606
result.report(self.outf)
608
from bzrlib.log import show_changed_revisions
609
new_rh = branch_to.revision_history()
610
show_changed_revisions(branch_to, old_rh, new_rh, to_file=self.outf)
613
class cmd_push(Command):
614
"""Update a mirror of this branch.
616
The target branch will not have its working tree populated because this
617
is both expensive, and is not supported on remote file systems.
619
Some smart servers or protocols *may* put the working tree in place in
622
This command only works on branches that have not diverged. Branches are
623
considered diverged if the destination branch's most recent commit is one
624
that has not been merged (directly or indirectly) by the source branch.
626
If branches have diverged, you can use 'bzr push --overwrite' to replace
627
the other branch completely, discarding its unmerged changes.
629
If you want to ensure you have the different changes in the other branch,
630
do a merge (see bzr help merge) from the other branch, and commit that.
631
After that you will be able to do a push without '--overwrite'.
633
If there is no default push location set, the first push will set it.
634
After that, you can omit the location to use the default. To change the
635
default, use --remember. The value will only be saved if the remote
636
location can be accessed.
639
takes_options = ['remember', 'overwrite', 'verbose',
640
Option('create-prefix',
641
help='Create the path leading up to the branch '
642
'if it does not already exist'),
644
help='branch to push from, '
645
'rather than the one containing the working directory',
649
Option('use-existing-dir',
650
help='By default push will fail if the target'
651
' directory exists, but does not already'
652
' have a control directory. This flag will'
653
' allow push to proceed.'),
655
takes_args = ['location?']
656
encoding_type = 'replace'
658
def run(self, location=None, remember=False, overwrite=False,
659
create_prefix=False, verbose=False,
660
use_existing_dir=False,
662
# FIXME: Way too big! Put this into a function called from the
664
if directory is None:
666
br_from = Branch.open_containing(directory)[0]
667
stored_loc = br_from.get_push_location()
669
if stored_loc is None:
670
raise errors.BzrCommandError("No push location known or specified.")
672
display_url = urlutils.unescape_for_display(stored_loc,
674
self.outf.write("Using saved location: %s\n" % display_url)
675
location = stored_loc
677
to_transport = transport.get_transport(location)
678
location_url = to_transport.base
680
br_to = repository_to = dir_to = None
682
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
683
except errors.NotBranchError:
684
pass # Didn't find anything
686
# If we can open a branch, use its direct repository, otherwise see
687
# if there is a repository without a branch.
689
br_to = dir_to.open_branch()
690
except errors.NotBranchError:
691
# Didn't find a branch, can we find a repository?
693
repository_to = dir_to.find_repository()
694
except errors.NoRepositoryPresent:
697
# Found a branch, so we must have found a repository
698
repository_to = br_to.repository
702
# The destination doesn't exist; create it.
703
# XXX: Refactor the create_prefix/no_create_prefix code into a
704
# common helper function
706
to_transport.mkdir('.')
707
except errors.FileExists:
708
if not use_existing_dir:
709
raise errors.BzrCommandError("Target directory %s"
710
" already exists, but does not have a valid .bzr"
711
" directory. Supply --use-existing-dir to push"
712
" there anyway." % location)
713
except errors.NoSuchFile:
714
if not create_prefix:
715
raise errors.BzrCommandError("Parent directory of %s"
717
"\nYou may supply --create-prefix to create all"
718
" leading parent directories."
721
cur_transport = to_transport
722
needed = [cur_transport]
723
# Recurse upwards until we can create a directory successfully
725
new_transport = cur_transport.clone('..')
726
if new_transport.base == cur_transport.base:
727
raise errors.BzrCommandError("Failed to create path"
731
new_transport.mkdir('.')
732
except errors.NoSuchFile:
733
needed.append(new_transport)
734
cur_transport = new_transport
738
# Now we only need to create child directories
740
cur_transport = needed.pop()
741
cur_transport.mkdir('.')
743
# Now the target directory exists, but doesn't have a .bzr
744
# directory. So we need to create it, along with any work to create
745
# all of the dependent branches, etc.
746
dir_to = br_from.bzrdir.clone(location_url,
747
revision_id=br_from.last_revision())
748
br_to = dir_to.open_branch()
749
# TODO: Some more useful message about what was copied
750
note('Created new branch.')
751
# We successfully created the target, remember it
752
if br_from.get_push_location() is None or remember:
753
br_from.set_push_location(br_to.base)
754
elif repository_to is None:
755
# we have a bzrdir but no branch or repository
756
# XXX: Figure out what to do other than complain.
757
raise errors.BzrCommandError("At %s you have a valid .bzr control"
758
" directory, but not a branch or repository. This is an"
759
" unsupported configuration. Please move the target directory"
760
" out of the way and try again."
763
# We have a repository but no branch, copy the revisions, and then
765
last_revision_id = br_from.last_revision()
766
repository_to.fetch(br_from.repository,
767
revision_id=last_revision_id)
768
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
769
note('Created new branch.')
770
if br_from.get_push_location() is None or remember:
771
br_from.set_push_location(br_to.base)
772
else: # We have a valid to branch
773
# We were able to connect to the remote location, so remember it
774
# we don't need to successfully push because of possible divergence.
775
if br_from.get_push_location() is None or remember:
776
br_from.set_push_location(br_to.base)
777
old_rh = br_to.revision_history()
780
tree_to = dir_to.open_workingtree()
781
except errors.NotLocalUrl:
782
warning('This transport does not update the working '
783
'tree of: %s' % (br_to.base,))
784
push_result = br_from.push(br_to, overwrite)
785
except errors.NoWorkingTree:
786
push_result = br_from.push(br_to, overwrite)
790
push_result = br_from.push(tree_to.branch, overwrite)
794
except errors.DivergedBranches:
795
raise errors.BzrCommandError('These branches have diverged.'
796
' Try using "merge" and then "push".')
797
if push_result is not None:
798
push_result.report(self.outf)
800
new_rh = br_to.revision_history()
803
from bzrlib.log import show_changed_revisions
804
show_changed_revisions(br_to, old_rh, new_rh,
807
# we probably did a clone rather than a push, so a message was
812
class cmd_branch(Command):
813
"""Create a new copy of a branch.
815
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
816
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
818
To retrieve the branch as of a particular revision, supply the --revision
819
parameter, as in "branch foo/bar -r 5".
821
--basis is to speed up branching from remote branches. When specified, it
822
copies all the file-contents, inventory and revision data from the basis
823
branch before copying anything from the remote branch.
825
takes_args = ['from_location', 'to_location?']
826
takes_options = ['revision', 'basis']
827
aliases = ['get', 'clone']
829
def run(self, from_location, to_location=None, revision=None, basis=None):
830
from bzrlib.tag import _merge_tags_if_possible
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
_merge_tags_if_possible(br_from, branch)
882
note('Branched %d revision(s).' % branch.revno())
887
class cmd_checkout(Command):
888
"""Create a new checkout of an existing branch.
890
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
891
the branch found in '.'. This is useful if you have removed the working tree
892
or if it was never created - i.e. if you pushed the branch to its current
895
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
896
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
898
To retrieve the branch as of a particular revision, supply the --revision
899
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
900
out of date [so you cannot commit] but it may be useful (i.e. to examine old
903
--basis is to speed up checking out from remote branches. When specified, it
904
uses the inventory and file contents from the basis branch in preference to the
905
branch being checked out.
907
See "help checkouts" for more information on checkouts.
909
takes_args = ['branch_location?', 'to_location?']
910
takes_options = ['revision', # , 'basis']
911
Option('lightweight',
912
help="perform a lightweight checkout. Lightweight "
913
"checkouts depend on access to the branch for "
914
"every operation. Normal checkouts can perform "
915
"common operations like diff and status without "
916
"such access, and also support local commits."
921
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
925
elif len(revision) > 1:
926
raise errors.BzrCommandError(
927
'bzr checkout --revision takes exactly 1 revision value')
928
if branch_location is None:
929
branch_location = osutils.getcwd()
930
to_location = branch_location
931
source = Branch.open(branch_location)
932
if len(revision) == 1 and revision[0] is not None:
933
revision_id = revision[0].in_history(source)[1]
936
if to_location is None:
937
to_location = os.path.basename(branch_location.rstrip("/\\"))
938
# if the source and to_location are the same,
939
# and there is no working tree,
940
# then reconstitute a branch
941
if (osutils.abspath(to_location) ==
942
osutils.abspath(branch_location)):
944
source.bzrdir.open_workingtree()
945
except errors.NoWorkingTree:
946
source.bzrdir.create_workingtree()
949
os.mkdir(to_location)
951
if e.errno == errno.EEXIST:
952
raise errors.BzrCommandError('Target directory "%s" already'
953
' exists.' % to_location)
954
if e.errno == errno.ENOENT:
955
raise errors.BzrCommandError('Parent of "%s" does not exist.'
959
source.create_checkout(to_location, revision_id, lightweight)
962
class cmd_renames(Command):
963
"""Show list of renamed files.
965
# TODO: Option to show renames between two historical versions.
967
# TODO: Only show renames under dir, rather than in the whole branch.
968
takes_args = ['dir?']
971
def run(self, dir=u'.'):
972
tree = WorkingTree.open_containing(dir)[0]
973
old_inv = tree.basis_tree().inventory
974
new_inv = tree.read_working_inventory()
975
renames = list(_mod_tree.find_renames(old_inv, new_inv))
977
for old_name, new_name in renames:
978
self.outf.write("%s => %s\n" % (old_name, new_name))
981
class cmd_update(Command):
982
"""Update a tree to have the latest code committed to its branch.
984
This will perform a merge into the working tree, and may generate
985
conflicts. If you have any local changes, you will still
986
need to commit them after the update for the update to be complete.
988
If you want to discard your local changes, you can just do a
989
'bzr revert' instead of 'bzr commit' after the update.
991
takes_args = ['dir?']
994
def run(self, dir='.'):
995
tree = WorkingTree.open_containing(dir)[0]
996
master = tree.branch.get_master_branch()
997
if master is not None:
1000
tree.lock_tree_write()
1002
existing_pending_merges = tree.get_parent_ids()[1:]
1003
last_rev = tree.last_revision()
1004
if last_rev == tree.branch.last_revision():
1005
# may be up to date, check master too.
1006
master = tree.branch.get_master_branch()
1007
if master is None or last_rev == master.last_revision():
1008
revno = tree.branch.revision_id_to_revno(last_rev)
1009
note("Tree is up to date at revision %d." % (revno,))
1011
conflicts = tree.update()
1012
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1013
note('Updated to revision %d.' % (revno,))
1014
if tree.get_parent_ids()[1:] != existing_pending_merges:
1015
note('Your local commits will now show as pending merges with '
1016
"'bzr status', and can be committed with 'bzr commit'.")
1025
class cmd_info(Command):
1026
"""Show information about a working tree, branch or repository.
1028
This command will show all known locations and formats associated to the
1029
tree, branch or repository. Statistical information is included with
1032
Branches and working trees will also report any missing revisions.
1034
takes_args = ['location?']
1035
takes_options = ['verbose']
1038
def run(self, location=None, verbose=False):
1039
from bzrlib.info import show_bzrdir_info
1040
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1044
class cmd_remove(Command):
1045
"""Make a file unversioned.
1047
This makes bzr stop tracking changes to a versioned file. It does
1048
not delete the working copy.
1050
You can specify one or more files, and/or --new. If you specify --new,
1051
only 'added' files will be removed. If you specify both, then new files
1052
in the specified directories will be removed. If the directories are
1053
also new, they will also be removed.
1055
takes_args = ['file*']
1056
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1058
encoding_type = 'replace'
1060
def run(self, file_list, verbose=False, new=False):
1061
tree, file_list = tree_files(file_list)
1063
if file_list is None:
1064
raise errors.BzrCommandError('Specify one or more files to'
1065
' remove, or use --new.')
1067
added = tree.changes_from(tree.basis_tree(),
1068
specific_files=file_list).added
1069
file_list = sorted([f[0] for f in added], reverse=True)
1070
if len(file_list) == 0:
1071
raise errors.BzrCommandError('No matching files.')
1072
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1075
class cmd_file_id(Command):
1076
"""Print file_id of a particular file or directory.
1078
The file_id is assigned when the file is first added and remains the
1079
same through all revisions where the file exists, even when it is
1084
takes_args = ['filename']
1087
def run(self, filename):
1088
tree, relpath = WorkingTree.open_containing(filename)
1089
i = tree.inventory.path2id(relpath)
1091
raise errors.NotVersionedError(filename)
1093
self.outf.write(i + '\n')
1096
class cmd_file_path(Command):
1097
"""Print path of file_ids to a file or directory.
1099
This prints one line for each directory down to the target,
1100
starting at the branch root.
1104
takes_args = ['filename']
1107
def run(self, filename):
1108
tree, relpath = WorkingTree.open_containing(filename)
1109
inv = tree.inventory
1110
fid = inv.path2id(relpath)
1112
raise errors.NotVersionedError(filename)
1113
for fip in inv.get_idpath(fid):
1114
self.outf.write(fip + '\n')
1117
class cmd_reconcile(Command):
1118
"""Reconcile bzr metadata in a branch.
1120
This can correct data mismatches that may have been caused by
1121
previous ghost operations or bzr upgrades. You should only
1122
need to run this command if 'bzr check' or a bzr developer
1123
advises you to run it.
1125
If a second branch is provided, cross-branch reconciliation is
1126
also attempted, which will check that data like the tree root
1127
id which was not present in very early bzr versions is represented
1128
correctly in both branches.
1130
At the same time it is run it may recompress data resulting in
1131
a potential saving in disk space or performance gain.
1133
The branch *MUST* be on a listable system such as local disk or sftp.
1135
takes_args = ['branch?']
1137
def run(self, branch="."):
1138
from bzrlib.reconcile import reconcile
1139
dir = bzrdir.BzrDir.open(branch)
1143
class cmd_revision_history(Command):
1144
"""Display the list of revision ids on a branch."""
1145
takes_args = ['location?']
1150
def run(self, location="."):
1151
branch = Branch.open_containing(location)[0]
1152
for revid in branch.revision_history():
1153
self.outf.write(revid)
1154
self.outf.write('\n')
1157
class cmd_ancestry(Command):
1158
"""List all revisions merged into this branch."""
1159
takes_args = ['location?']
1164
def run(self, location="."):
1166
wt = WorkingTree.open_containing(location)[0]
1167
except errors.NoWorkingTree:
1168
b = Branch.open(location)
1169
last_revision = b.last_revision()
1172
last_revision = wt.last_revision()
1174
revision_ids = b.repository.get_ancestry(last_revision)
1175
assert revision_ids[0] is None
1177
for revision_id in revision_ids:
1178
self.outf.write(revision_id + '\n')
1181
class cmd_init(Command):
1182
"""Make a directory into a versioned branch.
1184
Use this to create an empty branch, or before importing an
1187
If there is a repository in a parent directory of the location, then
1188
the history of the branch will be stored in the repository. Otherwise
1189
init creates a standalone branch which carries its own history in
1192
If there is already a branch at the location but it has no working tree,
1193
the tree can be populated with 'bzr checkout'.
1195
Recipe for importing a tree of files:
1200
bzr commit -m 'imported project'
1202
takes_args = ['location?']
1204
RegistryOption('format',
1205
help='Specify a format for this branch. '
1206
'See "help formats".',
1207
registry=bzrdir.format_registry,
1208
converter=bzrdir.format_registry.make_bzrdir,
1209
value_switches=True,
1210
title="Branch Format",
1212
Option('append-revisions-only',
1213
help='Never change revnos or the existing log.'
1214
' Append revisions to it only.')
1216
def run(self, location=None, format=None, append_revisions_only=False):
1218
format = bzrdir.format_registry.make_bzrdir('default')
1219
if location is None:
1222
to_transport = transport.get_transport(location)
1224
# The path has to exist to initialize a
1225
# branch inside of it.
1226
# Just using os.mkdir, since I don't
1227
# believe that we want to create a bunch of
1228
# locations if the user supplies an extended path
1229
# TODO: create-prefix
1231
to_transport.mkdir('.')
1232
except errors.FileExists:
1236
existing_bzrdir = bzrdir.BzrDir.open(location)
1237
except errors.NotBranchError:
1238
# really a NotBzrDir error...
1239
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1242
from bzrlib.transport.local import LocalTransport
1243
if existing_bzrdir.has_branch():
1244
if (isinstance(to_transport, LocalTransport)
1245
and not existing_bzrdir.has_workingtree()):
1246
raise errors.BranchExistsWithoutWorkingTree(location)
1247
raise errors.AlreadyBranchError(location)
1249
branch = existing_bzrdir.create_branch()
1250
existing_bzrdir.create_workingtree()
1251
if append_revisions_only:
1253
branch.set_append_revisions_only(True)
1254
except errors.UpgradeRequired:
1255
raise errors.BzrCommandError('This branch format cannot be set'
1256
' to append-revisions-only. Try --experimental-branch6')
1259
class cmd_init_repository(Command):
1260
"""Create a shared repository to hold branches.
1262
New branches created under the repository directory will store their revisions
1263
in the repository, not in the branch directory, if the branch format supports
1269
bzr checkout --lightweight repo/trunk trunk-checkout
1273
takes_args = ["location"]
1274
takes_options = [RegistryOption('format',
1275
help='Specify a format for this repository. See'
1276
' "bzr help formats" for details',
1277
registry=bzrdir.format_registry,
1278
converter=bzrdir.format_registry.make_bzrdir,
1279
value_switches=True, title='Repository format'),
1281
help='Allows branches in repository to have'
1283
aliases = ["init-repo"]
1284
def run(self, location, format=None, trees=False):
1286
format = bzrdir.format_registry.make_bzrdir('default')
1288
if location is None:
1291
to_transport = transport.get_transport(location)
1293
to_transport.mkdir('.')
1294
except errors.FileExists:
1297
newdir = format.initialize_on_transport(to_transport)
1298
repo = newdir.create_repository(shared=True)
1299
repo.set_make_working_trees(trees)
1302
class cmd_diff(Command):
1303
"""Show differences in the working tree or between revisions.
1305
If files are listed, only the changes in those files are listed.
1306
Otherwise, all changes for the tree are listed.
1308
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1309
produces patches suitable for "patch -p1".
1313
Shows the difference in the working tree versus the last commit
1315
Difference between the working tree and revision 1
1317
Difference between revision 2 and revision 1
1318
bzr diff --diff-prefix old/:new/
1319
Same as 'bzr diff' but prefix paths with old/ and new/
1320
bzr diff bzr.mine bzr.dev
1321
Show the differences between the two working trees
1323
Show just the differences for 'foo.c'
1325
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1326
# or a graphical diff.
1328
# TODO: Python difflib is not exactly the same as unidiff; should
1329
# either fix it up or prefer to use an external diff.
1331
# TODO: Selected-file diff is inefficient and doesn't show you
1334
# TODO: This probably handles non-Unix newlines poorly.
1336
takes_args = ['file*']
1337
takes_options = ['revision', 'diff-options',
1338
Option('prefix', type=str,
1340
help='Set prefixes to added to old and new filenames, as '
1341
'two values separated by a colon.'),
1343
aliases = ['di', 'dif']
1344
encoding_type = 'exact'
1347
def run(self, revision=None, file_list=None, diff_options=None,
1349
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1351
if (prefix is None) or (prefix == '0'):
1359
old_label, new_label = prefix.split(":")
1361
raise BzrCommandError(
1362
"--prefix expects two values separated by a colon")
1364
if revision and len(revision) > 2:
1365
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1366
' one or two revision specifiers')
1369
tree1, file_list = internal_tree_files(file_list)
1373
except errors.FileInWrongBranch:
1374
if len(file_list) != 2:
1375
raise errors.BzrCommandError("Files are in different branches")
1377
tree1, file1 = WorkingTree.open_containing(file_list[0])
1378
tree2, file2 = WorkingTree.open_containing(file_list[1])
1379
if file1 != "" or file2 != "":
1380
# FIXME diff those two files. rbc 20051123
1381
raise errors.BzrCommandError("Files are in different branches")
1383
except errors.NotBranchError:
1384
if (revision is not None and len(revision) == 2
1385
and not revision[0].needs_branch()
1386
and not revision[1].needs_branch()):
1387
# If both revision specs include a branch, we can
1388
# diff them without needing a local working tree
1389
tree1, tree2 = None, None
1393
if tree2 is not None:
1394
if revision is not None:
1395
# FIXME: but there should be a clean way to diff between
1396
# non-default versions of two trees, it's not hard to do
1398
raise errors.BzrCommandError(
1399
"Sorry, diffing arbitrary revisions across branches "
1400
"is not implemented yet")
1401
return show_diff_trees(tree1, tree2, sys.stdout,
1402
specific_files=file_list,
1403
external_diff_options=diff_options,
1404
old_label=old_label, new_label=new_label)
1406
return diff_cmd_helper(tree1, file_list, diff_options,
1407
revision_specs=revision,
1408
old_label=old_label, new_label=new_label)
1411
class cmd_deleted(Command):
1412
"""List files deleted in the working tree.
1414
# TODO: Show files deleted since a previous revision, or
1415
# between two revisions.
1416
# TODO: Much more efficient way to do this: read in new
1417
# directories with readdir, rather than stating each one. Same
1418
# level of effort but possibly much less IO. (Or possibly not,
1419
# if the directories are very large...)
1420
takes_options = ['show-ids']
1423
def run(self, show_ids=False):
1424
tree = WorkingTree.open_containing(u'.')[0]
1425
old = tree.basis_tree()
1426
for path, ie in old.inventory.iter_entries():
1427
if not tree.has_id(ie.file_id):
1428
self.outf.write(path)
1430
self.outf.write(' ')
1431
self.outf.write(ie.file_id)
1432
self.outf.write('\n')
1435
class cmd_modified(Command):
1436
"""List files modified in working tree.
1438
See also: "bzr status".
1445
tree = WorkingTree.open_containing(u'.')[0]
1446
td = tree.changes_from(tree.basis_tree())
1447
for path, id, kind, text_modified, meta_modified in td.modified:
1448
self.outf.write(path + '\n')
1451
class cmd_added(Command):
1452
"""List files added in working tree.
1454
See also: "bzr status".
1461
wt = WorkingTree.open_containing(u'.')[0]
1462
basis_inv = wt.basis_tree().inventory
1465
if file_id in basis_inv:
1467
if inv.is_root(file_id) and len(basis_inv) == 0:
1469
path = inv.id2path(file_id)
1470
if not os.access(osutils.abspath(path), os.F_OK):
1472
self.outf.write(path + '\n')
1475
class cmd_root(Command):
1476
"""Show the tree root directory.
1478
The root is the nearest enclosing directory with a .bzr control
1480
takes_args = ['filename?']
1482
def run(self, filename=None):
1483
"""Print the branch root."""
1484
tree = WorkingTree.open_containing(filename)[0]
1485
self.outf.write(tree.basedir + '\n')
1488
class cmd_log(Command):
1489
"""Show log of a branch, file, or directory.
1491
By default show the log of the branch containing the working directory.
1493
To request a range of logs, you can use the command -r begin..end
1494
-r revision requests a specific revision, -r ..end or -r begin.. are
1500
bzr log -r -10.. http://server/branch
1503
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1505
takes_args = ['location?']
1506
takes_options = [Option('forward',
1507
help='show from oldest to newest'),
1511
help='show files changed in each revision'),
1512
'show-ids', 'revision',
1516
help='show revisions whose message matches this regexp',
1519
encoding_type = 'replace'
1522
def run(self, location=None, timezone='original',
1529
from bzrlib.log import show_log
1530
assert message is None or isinstance(message, basestring), \
1531
"invalid message argument %r" % message
1532
direction = (forward and 'forward') or 'reverse'
1537
# find the file id to log:
1539
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1543
tree = b.basis_tree()
1544
inv = tree.inventory
1545
file_id = inv.path2id(fp)
1547
raise errors.BzrCommandError(
1548
"Path does not have any revision history: %s" %
1552
# FIXME ? log the current subdir only RBC 20060203
1553
if revision is not None \
1554
and len(revision) > 0 and revision[0].get_branch():
1555
location = revision[0].get_branch()
1558
dir, relpath = bzrdir.BzrDir.open_containing(location)
1559
b = dir.open_branch()
1563
if revision is None:
1566
elif len(revision) == 1:
1567
rev1 = rev2 = revision[0].in_history(b).revno
1568
elif len(revision) == 2:
1569
if revision[1].get_branch() != revision[0].get_branch():
1570
# b is taken from revision[0].get_branch(), and
1571
# show_log will use its revision_history. Having
1572
# different branches will lead to weird behaviors.
1573
raise errors.BzrCommandError(
1574
"Log doesn't accept two revisions in different"
1576
if revision[0].spec is None:
1577
# missing begin-range means first revision
1580
rev1 = revision[0].in_history(b).revno
1582
if revision[1].spec is None:
1583
# missing end-range means last known revision
1586
rev2 = revision[1].in_history(b).revno
1588
raise errors.BzrCommandError(
1589
'bzr log --revision takes one or two values.')
1591
# By this point, the revision numbers are converted to the +ve
1592
# form if they were supplied in the -ve form, so we can do
1593
# this comparison in relative safety
1595
(rev2, rev1) = (rev1, rev2)
1597
if log_format is None:
1598
log_format = log.log_formatter_registry.get_default(b)
1600
lf = log_format(show_ids=show_ids, to_file=self.outf,
1601
show_timezone=timezone)
1607
direction=direction,
1608
start_revision=rev1,
1615
def get_log_format(long=False, short=False, line=False, default='long'):
1616
log_format = default
1620
log_format = 'short'
1626
class cmd_touching_revisions(Command):
1627
"""Return revision-ids which affected a particular file.
1629
A more user-friendly interface is "bzr log FILE".
1633
takes_args = ["filename"]
1636
def run(self, filename):
1637
tree, relpath = WorkingTree.open_containing(filename)
1639
inv = tree.read_working_inventory()
1640
file_id = inv.path2id(relpath)
1641
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1642
self.outf.write("%6d %s\n" % (revno, what))
1645
class cmd_ls(Command):
1646
"""List files in a tree.
1649
takes_args = ['path?']
1650
# TODO: Take a revision or remote path and list that tree instead.
1651
takes_options = ['verbose', 'revision',
1652
Option('non-recursive',
1653
help='don\'t recurse into sub-directories'),
1655
help='Print all paths from the root of the branch.'),
1656
Option('unknown', help='Print unknown files'),
1657
Option('versioned', help='Print versioned files'),
1658
Option('ignored', help='Print ignored files'),
1660
Option('null', help='Null separate the files'),
1664
def run(self, revision=None, verbose=False,
1665
non_recursive=False, from_root=False,
1666
unknown=False, versioned=False, ignored=False,
1667
null=False, kind=None, show_ids=False, path=None):
1669
if kind and kind not in ('file', 'directory', 'symlink'):
1670
raise errors.BzrCommandError('invalid kind specified')
1672
if verbose and null:
1673
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1674
all = not (unknown or versioned or ignored)
1676
selection = {'I':ignored, '?':unknown, 'V':versioned}
1683
raise errors.BzrCommandError('cannot specify both --from-root'
1687
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1693
if revision is not None:
1694
tree = branch.repository.revision_tree(
1695
revision[0].in_history(branch).rev_id)
1697
tree = branch.basis_tree()
1699
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1700
if fp.startswith(relpath):
1701
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1702
if non_recursive and '/' in fp:
1704
if not all and not selection[fc]:
1706
if kind is not None and fkind != kind:
1709
kindch = entry.kind_character()
1710
outstring = '%-8s %s%s' % (fc, fp, kindch)
1711
if show_ids and fid is not None:
1712
outstring = "%-50s %s" % (outstring, fid)
1713
self.outf.write(outstring + '\n')
1715
self.outf.write(fp + '\0')
1718
self.outf.write(fid)
1719
self.outf.write('\0')
1727
self.outf.write('%-50s %s\n' % (fp, my_id))
1729
self.outf.write(fp + '\n')
1732
class cmd_unknowns(Command):
1733
"""List unknown files.
1735
See also: "bzr ls --unknown".
1742
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1743
self.outf.write(osutils.quotefn(f) + '\n')
1746
class cmd_ignore(Command):
1747
"""Ignore specified files or patterns.
1749
To remove patterns from the ignore list, edit the .bzrignore file.
1751
Trailing slashes on patterns are ignored.
1752
If the pattern contains a slash or is a regular expression, it is compared
1753
to the whole path from the branch root. Otherwise, it is compared to only
1754
the last component of the path. To match a file only in the root
1755
directory, prepend './'.
1757
Ignore patterns specifying absolute paths are not allowed.
1759
Ignore patterns may include globbing wildcards such as:
1760
? - Matches any single character except '/'
1761
* - Matches 0 or more characters except '/'
1762
/**/ - Matches 0 or more directories in a path
1763
[a-z] - Matches a single character from within a group of characters
1765
Ignore patterns may also be Python regular expressions.
1766
Regular expression ignore patterns are identified by a 'RE:' prefix
1767
followed by the regular expression. Regular expression ignore patterns
1768
may not include named or numbered groups.
1770
Note: ignore patterns containing shell wildcards must be quoted from
1774
bzr ignore ./Makefile
1775
bzr ignore '*.class'
1776
bzr ignore 'lib/**/*.o'
1777
bzr ignore 'RE:lib/.*\.o'
1779
takes_args = ['name_pattern*']
1781
Option('old-default-rules',
1782
help='Out the ignore rules bzr < 0.9 always used.')
1785
def run(self, name_pattern_list=None, old_default_rules=None):
1786
from bzrlib.atomicfile import AtomicFile
1787
if old_default_rules is not None:
1788
# dump the rules and exit
1789
for pattern in ignores.OLD_DEFAULTS:
1792
if not name_pattern_list:
1793
raise errors.BzrCommandError("ignore requires at least one "
1794
"NAME_PATTERN or --old-default-rules")
1795
for name_pattern in name_pattern_list:
1796
if name_pattern[0] == '/':
1797
raise errors.BzrCommandError(
1798
"NAME_PATTERN should not be an absolute path")
1799
tree, relpath = WorkingTree.open_containing(u'.')
1800
ifn = tree.abspath('.bzrignore')
1801
if os.path.exists(ifn):
1804
igns = f.read().decode('utf-8')
1810
# TODO: If the file already uses crlf-style termination, maybe
1811
# we should use that for the newly added lines?
1813
if igns and igns[-1] != '\n':
1815
for name_pattern in name_pattern_list:
1816
igns += name_pattern.rstrip('/') + '\n'
1818
f = AtomicFile(ifn, 'wb')
1820
f.write(igns.encode('utf-8'))
1825
inv = tree.inventory
1826
if inv.path2id('.bzrignore'):
1827
mutter('.bzrignore is already versioned')
1829
mutter('need to make new .bzrignore file versioned')
1830
tree.add(['.bzrignore'])
1833
class cmd_ignored(Command):
1834
"""List ignored files and the patterns that matched them.
1836
See also: bzr ignore"""
1839
tree = WorkingTree.open_containing(u'.')[0]
1840
for path, file_class, kind, file_id, entry in tree.list_files():
1841
if file_class != 'I':
1843
## XXX: Slightly inefficient since this was already calculated
1844
pat = tree.is_ignored(path)
1845
print '%-50s %s' % (path, pat)
1848
class cmd_lookup_revision(Command):
1849
"""Lookup the revision-id from a revision-number
1852
bzr lookup-revision 33
1855
takes_args = ['revno']
1858
def run(self, revno):
1862
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1864
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1867
class cmd_export(Command):
1868
"""Export past revision to destination directory.
1870
If no revision is specified this exports the last committed revision.
1872
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1873
given, try to find the format with the extension. If no extension
1874
is found exports to a directory (equivalent to --format=dir).
1876
Root may be the top directory for tar, tgz and tbz2 formats. If none
1877
is given, the top directory will be the root name of the file.
1879
If branch is omitted then the branch containing the CWD will be used.
1881
Note: export of tree with non-ascii filenames to zip is not supported.
1883
Supported formats Autodetected by extension
1884
----------------- -------------------------
1887
tbz2 .tar.bz2, .tbz2
1891
takes_args = ['dest', 'branch?']
1892
takes_options = ['revision', 'format', 'root']
1893
def run(self, dest, branch=None, revision=None, format=None, root=None):
1894
from bzrlib.export import export
1897
tree = WorkingTree.open_containing(u'.')[0]
1900
b = Branch.open(branch)
1902
if revision is None:
1903
# should be tree.last_revision FIXME
1904
rev_id = b.last_revision()
1906
if len(revision) != 1:
1907
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1908
rev_id = revision[0].in_history(b).rev_id
1909
t = b.repository.revision_tree(rev_id)
1911
export(t, dest, format, root)
1912
except errors.NoSuchExportFormat, e:
1913
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1916
class cmd_cat(Command):
1917
"""Write a file's text from a previous revision."""
1919
takes_options = ['revision', 'name-from-revision']
1920
takes_args = ['filename']
1921
encoding_type = 'exact'
1924
def run(self, filename, revision=None, name_from_revision=False):
1925
if revision is not None and len(revision) != 1:
1926
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1931
tree, relpath = WorkingTree.open_containing(filename)
1933
except (errors.NotBranchError, errors.NotLocalUrl):
1936
if revision is not None and revision[0].get_branch() is not None:
1937
b = Branch.open(revision[0].get_branch())
1939
b, relpath = Branch.open_containing(filename)
1940
tree = b.basis_tree()
1941
if revision is None:
1942
revision_id = b.last_revision()
1944
revision_id = revision[0].in_history(b).rev_id
1946
cur_file_id = tree.path2id(relpath)
1947
rev_tree = b.repository.revision_tree(revision_id)
1948
old_file_id = rev_tree.path2id(relpath)
1950
if name_from_revision:
1951
if old_file_id is None:
1952
raise errors.BzrCommandError("%r is not present in revision %s"
1953
% (filename, revision_id))
1955
rev_tree.print_file(old_file_id)
1956
elif cur_file_id is not None:
1957
rev_tree.print_file(cur_file_id)
1958
elif old_file_id is not None:
1959
rev_tree.print_file(old_file_id)
1961
raise errors.BzrCommandError("%r is not present in revision %s" %
1962
(filename, revision_id))
1965
class cmd_local_time_offset(Command):
1966
"""Show the offset in seconds from GMT to local time."""
1970
print osutils.local_time_offset()
1974
class cmd_commit(Command):
1975
"""Commit changes into a new revision.
1977
If no arguments are given, the entire tree is committed.
1979
If selected files are specified, only changes to those files are
1980
committed. If a directory is specified then the directory and everything
1981
within it is committed.
1983
A selected-file commit may fail in some cases where the committed
1984
tree would be invalid, such as trying to commit a file in a
1985
newly-added directory that is not itself committed.
1987
# TODO: Run hooks on tree to-be-committed, and after commit.
1989
# TODO: Strict commit that fails if there are deleted files.
1990
# (what does "deleted files" mean ??)
1992
# TODO: Give better message for -s, --summary, used by tla people
1994
# XXX: verbose currently does nothing
1996
takes_args = ['selected*']
1997
takes_options = ['message', 'verbose',
1999
help='commit even if nothing has changed'),
2000
Option('file', type=str,
2003
help='file containing commit message'),
2005
help="refuse to commit if there are unknown "
2006
"files in the working tree."),
2008
help="perform a local only commit in a bound "
2009
"branch. Such commits are not pushed to "
2010
"the master branch until a normal commit "
2014
aliases = ['ci', 'checkin']
2016
def run(self, message=None, file=None, verbose=True, selected_list=None,
2017
unchanged=False, strict=False, local=False):
2018
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2019
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2021
from bzrlib.msgeditor import edit_commit_message, \
2022
make_commit_message_template
2024
# TODO: Need a blackbox test for invoking the external editor; may be
2025
# slightly problematic to run this cross-platform.
2027
# TODO: do more checks that the commit will succeed before
2028
# spending the user's valuable time typing a commit message.
2029
tree, selected_list = tree_files(selected_list)
2030
if selected_list == ['']:
2031
# workaround - commit of root of tree should be exactly the same
2032
# as just default commit in that tree, and succeed even though
2033
# selected-file merge commit is not done yet
2036
if local and not tree.branch.get_bound_location():
2037
raise errors.LocalRequiresBoundBranch()
2039
def get_message(commit_obj):
2040
"""Callback to get commit message"""
2041
my_message = message
2042
if my_message is None and not file:
2043
template = make_commit_message_template(tree, selected_list)
2044
my_message = edit_commit_message(template)
2045
if my_message is None:
2046
raise errors.BzrCommandError("please specify a commit"
2047
" message with either --message or --file")
2048
elif my_message and file:
2049
raise errors.BzrCommandError(
2050
"please specify either --message or --file")
2052
my_message = codecs.open(file, 'rt',
2053
bzrlib.user_encoding).read()
2054
if my_message == "":
2055
raise errors.BzrCommandError("empty commit message specified")
2059
reporter = ReportCommitToLog()
2061
reporter = NullCommitReporter()
2064
tree.commit(message_callback=get_message,
2065
specific_files=selected_list,
2066
allow_pointless=unchanged, strict=strict, local=local,
2068
except PointlessCommit:
2069
# FIXME: This should really happen before the file is read in;
2070
# perhaps prepare the commit; get the message; then actually commit
2071
raise errors.BzrCommandError("no changes to commit."
2072
" use --unchanged to commit anyhow")
2073
except ConflictsInTree:
2074
raise errors.BzrCommandError('Conflicts detected in working '
2075
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2077
except StrictCommitFailed:
2078
raise errors.BzrCommandError("Commit refused because there are"
2079
" unknown files in the working tree.")
2080
except errors.BoundBranchOutOfDate, e:
2081
raise errors.BzrCommandError(str(e) + "\n"
2082
'To commit to master branch, run update and then commit.\n'
2083
'You can also pass --local to commit to continue working '
2087
class cmd_check(Command):
2088
"""Validate consistency of branch history.
2090
This command checks various invariants about the branch storage to
2091
detect data corruption or bzr bugs.
2093
takes_args = ['branch?']
2094
takes_options = ['verbose']
2096
def run(self, branch=None, verbose=False):
2097
from bzrlib.check import check
2099
tree = WorkingTree.open_containing()[0]
2100
branch = tree.branch
2102
branch = Branch.open(branch)
2103
check(branch, verbose)
2106
class cmd_upgrade(Command):
2107
"""Upgrade branch storage to current format.
2109
The check command or bzr developers may sometimes advise you to run
2110
this command. When the default format has changed you may also be warned
2111
during other operations to upgrade.
2113
takes_args = ['url?']
2115
RegistryOption('format',
2116
help='Upgrade to a specific format. See "bzr help'
2117
' formats" for details',
2118
registry=bzrdir.format_registry,
2119
converter=bzrdir.format_registry.make_bzrdir,
2120
value_switches=True, title='Branch format'),
2124
def run(self, url='.', format=None):
2125
from bzrlib.upgrade import upgrade
2127
format = bzrdir.format_registry.make_bzrdir('default')
2128
upgrade(url, format)
2131
class cmd_whoami(Command):
2132
"""Show or set bzr user id.
2136
bzr whoami 'Frank Chu <fchu@example.com>'
2138
takes_options = [ Option('email',
2139
help='display email address only'),
2141
help='set identity for the current branch instead of '
2144
takes_args = ['name?']
2145
encoding_type = 'replace'
2148
def run(self, email=False, branch=False, name=None):
2150
# use branch if we're inside one; otherwise global config
2152
c = Branch.open_containing('.')[0].get_config()
2153
except errors.NotBranchError:
2154
c = config.GlobalConfig()
2156
self.outf.write(c.user_email() + '\n')
2158
self.outf.write(c.username() + '\n')
2161
# display a warning if an email address isn't included in the given name.
2163
config.extract_email_address(name)
2164
except errors.NoEmailInUsername, e:
2165
warning('"%s" does not seem to contain an email address. '
2166
'This is allowed, but not recommended.', name)
2168
# use global config unless --branch given
2170
c = Branch.open_containing('.')[0].get_config()
2172
c = config.GlobalConfig()
2173
c.set_user_option('email', name)
2176
class cmd_nick(Command):
2177
"""Print or set the branch nickname.
2179
If unset, the tree root directory name is used as the nickname
2180
To print the current nickname, execute with no argument.
2182
takes_args = ['nickname?']
2183
def run(self, nickname=None):
2184
branch = Branch.open_containing(u'.')[0]
2185
if nickname is None:
2186
self.printme(branch)
2188
branch.nick = nickname
2191
def printme(self, branch):
2195
class cmd_selftest(Command):
2196
"""Run internal test suite.
2198
This creates temporary test directories in the working directory, but not
2199
existing data is affected. These directories are deleted if the tests
2200
pass, or left behind to help in debugging if they fail and --keep-output
2203
If arguments are given, they are regular expressions that say which tests
2204
should run. Tests matching any expression are run, and other tests are
2207
Alternatively if --first is given, matching tests are run first and then
2208
all other tests are run. This is useful if you have been working in a
2209
particular area, but want to make sure nothing else was broken.
2211
If the global option '--no-plugins' is given, plugins are not loaded
2212
before running the selftests. This has two effects: features provided or
2213
modified by plugins will not be tested, and tests provided by plugins will
2218
run only tests relating to 'ignore'
2219
bzr --no-plugins selftest -v
2220
disable plugins and list tests as they're run
2222
# TODO: --list should give a list of all available tests
2224
# NB: this is used from the class without creating an instance, which is
2225
# why it does not have a self parameter.
2226
def get_transport_type(typestring):
2227
"""Parse and return a transport specifier."""
2228
if typestring == "sftp":
2229
from bzrlib.transport.sftp import SFTPAbsoluteServer
2230
return SFTPAbsoluteServer
2231
if typestring == "memory":
2232
from bzrlib.transport.memory import MemoryServer
2234
if typestring == "fakenfs":
2235
from bzrlib.transport.fakenfs import FakeNFSServer
2236
return FakeNFSServer
2237
msg = "No known transport type %s. Supported types are: sftp\n" %\
2239
raise errors.BzrCommandError(msg)
2242
takes_args = ['testspecs*']
2243
takes_options = ['verbose',
2244
Option('one', help='stop when one test fails'),
2245
Option('keep-output',
2246
help='keep output directories when tests fail'),
2248
help='Use a different transport by default '
2249
'throughout the test suite.',
2250
type=get_transport_type),
2251
Option('benchmark', help='run the bzr bencharks.'),
2252
Option('lsprof-timed',
2253
help='generate lsprof output for benchmarked'
2254
' sections of code.'),
2255
Option('cache-dir', type=str,
2256
help='a directory to cache intermediate'
2257
' benchmark steps'),
2258
Option('clean-output',
2259
help='clean temporary tests directories'
2260
' without running tests'),
2262
help='run all tests, but run specified tests first',
2265
encoding_type = 'replace'
2267
def run(self, testspecs_list=None, verbose=None, one=False,
2268
keep_output=False, transport=None, benchmark=None,
2269
lsprof_timed=None, cache_dir=None, clean_output=False,
2272
from bzrlib.tests import selftest
2273
import bzrlib.benchmarks as benchmarks
2274
from bzrlib.benchmarks import tree_creator
2277
from bzrlib.tests import clean_selftest_output
2278
clean_selftest_output()
2281
if cache_dir is not None:
2282
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2283
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2284
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2286
if testspecs_list is not None:
2287
pattern = '|'.join(testspecs_list)
2291
test_suite_factory = benchmarks.test_suite
2294
# TODO: should possibly lock the history file...
2295
benchfile = open(".perf_history", "at", buffering=1)
2297
test_suite_factory = None
2302
result = selftest(verbose=verbose,
2304
stop_on_failure=one,
2305
keep_output=keep_output,
2306
transport=transport,
2307
test_suite_factory=test_suite_factory,
2308
lsprof_timed=lsprof_timed,
2309
bench_history=benchfile,
2310
matching_tests_first=first,
2313
if benchfile is not None:
2316
info('tests passed')
2318
info('tests failed')
2319
return int(not result)
2322
class cmd_version(Command):
2323
"""Show version of bzr."""
2327
from bzrlib.version import show_version
2331
class cmd_rocks(Command):
2332
"""Statement of optimism."""
2338
print "It sure does!"
2341
class cmd_find_merge_base(Command):
2342
"""Find and print a base revision for merging two branches."""
2343
# TODO: Options to specify revisions on either side, as if
2344
# merging only part of the history.
2345
takes_args = ['branch', 'other']
2349
def run(self, branch, other):
2350
from bzrlib.revision import MultipleRevisionSources
2352
branch1 = Branch.open_containing(branch)[0]
2353
branch2 = Branch.open_containing(other)[0]
2355
last1 = branch1.last_revision()
2356
last2 = branch2.last_revision()
2358
source = MultipleRevisionSources(branch1.repository,
2361
base_rev_id = common_ancestor(last1, last2, source)
2363
print 'merge base is revision %s' % base_rev_id
2366
class cmd_merge(Command):
2367
"""Perform a three-way merge.
2369
The branch is the branch you will merge from. By default, it will merge
2370
the latest revision. If you specify a revision, that revision will be
2371
merged. If you specify two revisions, the first will be used as a BASE,
2372
and the second one as OTHER. Revision numbers are always relative to the
2375
By default, bzr will try to merge in all new work from the other
2376
branch, automatically determining an appropriate base. If this
2377
fails, you may need to give an explicit base.
2379
Merge will do its best to combine the changes in two branches, but there
2380
are some kinds of problems only a human can fix. When it encounters those,
2381
it will mark a conflict. A conflict means that you need to fix something,
2382
before you should commit.
2384
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2386
If there is no default branch set, the first merge will set it. After
2387
that, you can omit the branch to use the default. To change the
2388
default, use --remember. The value will only be saved if the remote
2389
location can be accessed.
2391
The results of the merge are placed into the destination working
2392
directory, where they can be reviewed (with bzr diff), tested, and then
2393
committed to record the result of the merge.
2397
To merge the latest revision from bzr.dev
2398
bzr merge ../bzr.dev
2400
To merge changes up to and including revision 82 from bzr.dev
2401
bzr merge -r 82 ../bzr.dev
2403
To merge the changes introduced by 82, without previous changes:
2404
bzr merge -r 81..82 ../bzr.dev
2406
merge refuses to run if there are any uncommitted changes, unless
2409
The following merge types are available:
2411
takes_args = ['branch?']
2412
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2413
Option('show-base', help="Show base revision text in "
2415
Option('uncommitted', help='Apply uncommitted changes'
2416
' from a working copy, instead of branch changes'),
2417
Option('pull', help='If the destination is already'
2418
' completely merged into the source, pull from the'
2419
' source rather than merging. When this happens,'
2420
' you do not need to commit the result.'),
2422
help='Branch to merge into, '
2423
'rather than the one containing the working directory',
2429
def run(self, branch=None, revision=None, force=False, merge_type=None,
2430
show_base=False, reprocess=False, remember=False,
2431
uncommitted=False, pull=False,
2434
from bzrlib.tag import _merge_tags_if_possible
2435
if merge_type is None:
2436
merge_type = _mod_merge.Merge3Merger
2438
if directory is None: directory = u'.'
2439
tree = WorkingTree.open_containing(directory)[0]
2440
change_reporter = delta.ChangeReporter(tree.inventory)
2442
if branch is not None:
2444
reader = bundle.read_bundle_from_url(branch)
2445
except errors.NotABundle:
2446
pass # Continue on considering this url a Branch
2448
conflicts = merge_bundle(reader, tree, not force, merge_type,
2449
reprocess, show_base, change_reporter)
2455
if revision is None \
2456
or len(revision) < 1 or revision[0].needs_branch():
2457
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2459
if revision is None or len(revision) < 1:
2462
other = [branch, None]
2465
other = [branch, -1]
2466
other_branch, path = Branch.open_containing(branch)
2469
raise errors.BzrCommandError('Cannot use --uncommitted and'
2470
' --revision at the same time.')
2471
branch = revision[0].get_branch() or branch
2472
if len(revision) == 1:
2474
other_branch, path = Branch.open_containing(branch)
2475
revno = revision[0].in_history(other_branch).revno
2476
other = [branch, revno]
2478
assert len(revision) == 2
2479
if None in revision:
2480
raise errors.BzrCommandError(
2481
"Merge doesn't permit empty revision specifier.")
2482
base_branch, path = Branch.open_containing(branch)
2483
branch1 = revision[1].get_branch() or branch
2484
other_branch, path1 = Branch.open_containing(branch1)
2485
if revision[0].get_branch() is not None:
2486
# then path was obtained from it, and is None.
2489
base = [branch, revision[0].in_history(base_branch).revno]
2490
other = [branch1, revision[1].in_history(other_branch).revno]
2492
if tree.branch.get_parent() is None or remember:
2493
tree.branch.set_parent(other_branch.base)
2495
# pull tags now... it's a bit inconsistent to do it ahead of copying
2496
# the history but that's done inside the merge code
2497
_merge_tags_if_possible(other_branch, tree.branch)
2500
interesting_files = [path]
2502
interesting_files = None
2503
pb = ui.ui_factory.nested_progress_bar()
2506
conflict_count = _merge_helper(
2507
other, base, check_clean=(not force),
2508
merge_type=merge_type,
2509
reprocess=reprocess,
2510
show_base=show_base,
2513
pb=pb, file_list=interesting_files,
2514
change_reporter=change_reporter)
2517
if conflict_count != 0:
2521
except errors.AmbiguousBase, e:
2522
m = ("sorry, bzr can't determine the right merge base yet\n"
2523
"candidates are:\n "
2524
+ "\n ".join(e.bases)
2526
"please specify an explicit base with -r,\n"
2527
"and (if you want) report this to the bzr developers\n")
2530
# TODO: move up to common parent; this isn't merge-specific anymore.
2531
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2532
"""Use tree.branch's parent if none was supplied.
2534
Report if the remembered location was used.
2536
if supplied_location is not None:
2537
return supplied_location
2538
stored_location = tree.branch.get_parent()
2539
mutter("%s", stored_location)
2540
if stored_location is None:
2541
raise errors.BzrCommandError("No location specified or remembered")
2542
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2543
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2544
return stored_location
2547
class cmd_remerge(Command):
2550
Use this if you want to try a different merge technique while resolving
2551
conflicts. Some merge techniques are better than others, and remerge
2552
lets you try different ones on different files.
2554
The options for remerge have the same meaning and defaults as the ones for
2555
merge. The difference is that remerge can (only) be run when there is a
2556
pending merge, and it lets you specify particular files.
2559
$ bzr remerge --show-base
2560
Re-do the merge of all conflicted files, and show the base text in
2561
conflict regions, in addition to the usual THIS and OTHER texts.
2563
$ bzr remerge --merge-type weave --reprocess foobar
2564
Re-do the merge of "foobar", using the weave merge algorithm, with
2565
additional processing to reduce the size of conflict regions.
2567
The following merge types are available:"""
2568
takes_args = ['file*']
2569
takes_options = ['merge-type', 'reprocess',
2570
Option('show-base', help="Show base revision text in "
2573
def run(self, file_list=None, merge_type=None, show_base=False,
2575
if merge_type is None:
2576
merge_type = _mod_merge.Merge3Merger
2577
tree, file_list = tree_files(file_list)
2580
parents = tree.get_parent_ids()
2581
if len(parents) != 2:
2582
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2583
" merges. Not cherrypicking or"
2585
repository = tree.branch.repository
2586
base_revision = common_ancestor(parents[0],
2587
parents[1], repository)
2588
base_tree = repository.revision_tree(base_revision)
2589
other_tree = repository.revision_tree(parents[1])
2590
interesting_ids = None
2592
conflicts = tree.conflicts()
2593
if file_list is not None:
2594
interesting_ids = set()
2595
for filename in file_list:
2596
file_id = tree.path2id(filename)
2598
raise errors.NotVersionedError(filename)
2599
interesting_ids.add(file_id)
2600
if tree.kind(file_id) != "directory":
2603
for name, ie in tree.inventory.iter_entries(file_id):
2604
interesting_ids.add(ie.file_id)
2605
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2607
# Remerge only supports resolving contents conflicts
2608
allowed_conflicts = ('text conflict', 'contents conflict')
2609
restore_files = [c.path for c in conflicts
2610
if c.typestring in allowed_conflicts]
2611
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2612
tree.set_conflicts(ConflictList(new_conflicts))
2613
if file_list is not None:
2614
restore_files = file_list
2615
for filename in restore_files:
2617
restore(tree.abspath(filename))
2618
except errors.NotConflicted:
2620
conflicts = _mod_merge.merge_inner(
2621
tree.branch, other_tree, base_tree,
2623
interesting_ids=interesting_ids,
2624
other_rev_id=parents[1],
2625
merge_type=merge_type,
2626
show_base=show_base,
2627
reprocess=reprocess)
2636
class cmd_revert(Command):
2637
"""Revert files to a previous revision.
2639
Giving a list of files will revert only those files. Otherwise, all files
2640
will be reverted. If the revision is not specified with '--revision', the
2641
last committed revision is used.
2643
To remove only some changes, without reverting to a prior version, use
2644
merge instead. For example, "merge . --r-2..-3" will remove the changes
2645
introduced by -2, without affecting the changes introduced by -1. Or
2646
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2648
By default, any files that have been manually changed will be backed up
2649
first. (Files changed only by merge are not backed up.) Backup files have
2650
'.~#~' appended to their name, where # is a number.
2652
When you provide files, you can use their current pathname or the pathname
2653
from the target revision. So you can use revert to "undelete" a file by
2654
name. If you name a directory, all the contents of that directory will be
2657
takes_options = ['revision', 'no-backup']
2658
takes_args = ['file*']
2659
aliases = ['merge-revert']
2661
def run(self, revision=None, no_backup=False, file_list=None):
2662
if file_list is not None:
2663
if len(file_list) == 0:
2664
raise errors.BzrCommandError("No files specified")
2668
tree, file_list = tree_files(file_list)
2669
if revision is None:
2670
# FIXME should be tree.last_revision
2671
rev_id = tree.last_revision()
2672
elif len(revision) != 1:
2673
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2675
rev_id = revision[0].in_history(tree.branch).rev_id
2676
pb = ui.ui_factory.nested_progress_bar()
2678
tree.revert(file_list,
2679
tree.branch.repository.revision_tree(rev_id),
2680
not no_backup, pb, report_changes=True)
2685
class cmd_assert_fail(Command):
2686
"""Test reporting of assertion failures"""
2687
# intended just for use in testing
2692
raise AssertionError("always fails")
2695
class cmd_help(Command):
2696
"""Show help on a command or other topic.
2698
For a list of all available commands, say 'bzr help commands'.
2700
takes_options = [Option('long', 'show help on all commands')]
2701
takes_args = ['topic?']
2702
aliases = ['?', '--help', '-?', '-h']
2705
def run(self, topic=None, long=False):
2707
if topic is None and long:
2709
bzrlib.help.help(topic)
2712
class cmd_shell_complete(Command):
2713
"""Show appropriate completions for context.
2715
For a list of all available commands, say 'bzr shell-complete'.
2717
takes_args = ['context?']
2722
def run(self, context=None):
2723
import shellcomplete
2724
shellcomplete.shellcomplete(context)
2727
class cmd_fetch(Command):
2728
"""Copy in history from another branch but don't merge it.
2730
This is an internal method used for pull and merge.
2733
takes_args = ['from_branch', 'to_branch']
2734
def run(self, from_branch, to_branch):
2735
from bzrlib.fetch import Fetcher
2736
from_b = Branch.open(from_branch)
2737
to_b = Branch.open(to_branch)
2738
Fetcher(to_b, from_b)
2741
class cmd_missing(Command):
2742
"""Show unmerged/unpulled revisions between two branches.
2744
OTHER_BRANCH may be local or remote.
2746
takes_args = ['other_branch?']
2747
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2749
'Display changes in the local branch only'),
2750
Option('theirs-only',
2751
'Display changes in the remote branch only'),
2756
encoding_type = 'replace'
2759
def run(self, other_branch=None, reverse=False, mine_only=False,
2760
theirs_only=False, log_format=None, long=False, short=False, line=False,
2761
show_ids=False, verbose=False):
2762
from bzrlib.missing import find_unmerged, iter_log_data
2763
from bzrlib.log import log_formatter
2764
local_branch = Branch.open_containing(u".")[0]
2765
parent = local_branch.get_parent()
2766
if other_branch is None:
2767
other_branch = parent
2768
if other_branch is None:
2769
raise errors.BzrCommandError("No peer location known or specified.")
2770
display_url = urlutils.unescape_for_display(parent,
2772
print "Using last location: " + display_url
2774
remote_branch = Branch.open(other_branch)
2775
if remote_branch.base == local_branch.base:
2776
remote_branch = local_branch
2777
local_branch.lock_read()
2779
remote_branch.lock_read()
2781
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2782
if (log_format is None):
2783
log_format = log.log_formatter_registry.get_default(
2785
lf = log_format(to_file=self.outf,
2787
show_timezone='original')
2788
if reverse is False:
2789
local_extra.reverse()
2790
remote_extra.reverse()
2791
if local_extra and not theirs_only:
2792
print "You have %d extra revision(s):" % len(local_extra)
2793
for data in iter_log_data(local_extra, local_branch.repository,
2796
printed_local = True
2798
printed_local = False
2799
if remote_extra and not mine_only:
2800
if printed_local is True:
2802
print "You are missing %d revision(s):" % len(remote_extra)
2803
for data in iter_log_data(remote_extra, remote_branch.repository,
2806
if not remote_extra and not local_extra:
2808
print "Branches are up to date."
2812
remote_branch.unlock()
2814
local_branch.unlock()
2815
if not status_code and parent is None and other_branch is not None:
2816
local_branch.lock_write()
2818
# handle race conditions - a parent might be set while we run.
2819
if local_branch.get_parent() is None:
2820
local_branch.set_parent(remote_branch.base)
2822
local_branch.unlock()
2826
class cmd_plugins(Command):
2831
import bzrlib.plugin
2832
from inspect import getdoc
2833
for name, plugin in bzrlib.plugin.all_plugins().items():
2834
if getattr(plugin, '__path__', None) is not None:
2835
print plugin.__path__[0]
2836
elif getattr(plugin, '__file__', None) is not None:
2837
print plugin.__file__
2843
print '\t', d.split('\n')[0]
2846
class cmd_testament(Command):
2847
"""Show testament (signing-form) of a revision."""
2848
takes_options = ['revision',
2849
Option('long', help='Produce long-format testament'),
2850
Option('strict', help='Produce a strict-format'
2852
takes_args = ['branch?']
2854
def run(self, branch=u'.', revision=None, long=False, strict=False):
2855
from bzrlib.testament import Testament, StrictTestament
2857
testament_class = StrictTestament
2859
testament_class = Testament
2860
b = WorkingTree.open_containing(branch)[0].branch
2863
if revision is None:
2864
rev_id = b.last_revision()
2866
rev_id = revision[0].in_history(b).rev_id
2867
t = testament_class.from_revision(b.repository, rev_id)
2869
sys.stdout.writelines(t.as_text_lines())
2871
sys.stdout.write(t.as_short_text())
2876
class cmd_annotate(Command):
2877
"""Show the origin of each line in a file.
2879
This prints out the given file with an annotation on the left side
2880
indicating which revision, author and date introduced the change.
2882
If the origin is the same for a run of consecutive lines, it is
2883
shown only at the top, unless the --all option is given.
2885
# TODO: annotate directories; showing when each file was last changed
2886
# TODO: if the working copy is modified, show annotations on that
2887
# with new uncommitted lines marked
2888
aliases = ['ann', 'blame', 'praise']
2889
takes_args = ['filename']
2890
takes_options = [Option('all', help='show annotations on all lines'),
2891
Option('long', help='show date in annotations'),
2897
def run(self, filename, all=False, long=False, revision=None,
2899
from bzrlib.annotate import annotate_file
2900
tree, relpath = WorkingTree.open_containing(filename)
2901
branch = tree.branch
2904
if revision is None:
2905
revision_id = branch.last_revision()
2906
elif len(revision) != 1:
2907
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2909
revision_id = revision[0].in_history(branch).rev_id
2910
file_id = tree.inventory.path2id(relpath)
2911
tree = branch.repository.revision_tree(revision_id)
2912
file_version = tree.inventory[file_id].revision
2913
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2919
class cmd_re_sign(Command):
2920
"""Create a digital signature for an existing revision."""
2921
# TODO be able to replace existing ones.
2923
hidden = True # is this right ?
2924
takes_args = ['revision_id*']
2925
takes_options = ['revision']
2927
def run(self, revision_id_list=None, revision=None):
2928
import bzrlib.gpg as gpg
2929
if revision_id_list is not None and revision is not None:
2930
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2931
if revision_id_list is None and revision is None:
2932
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2933
b = WorkingTree.open_containing(u'.')[0].branch
2934
gpg_strategy = gpg.GPGStrategy(b.get_config())
2935
if revision_id_list is not None:
2936
for revision_id in revision_id_list:
2937
b.repository.sign_revision(revision_id, gpg_strategy)
2938
elif revision is not None:
2939
if len(revision) == 1:
2940
revno, rev_id = revision[0].in_history(b)
2941
b.repository.sign_revision(rev_id, gpg_strategy)
2942
elif len(revision) == 2:
2943
# are they both on rh- if so we can walk between them
2944
# might be nice to have a range helper for arbitrary
2945
# revision paths. hmm.
2946
from_revno, from_revid = revision[0].in_history(b)
2947
to_revno, to_revid = revision[1].in_history(b)
2948
if to_revid is None:
2949
to_revno = b.revno()
2950
if from_revno is None or to_revno is None:
2951
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2952
for revno in range(from_revno, to_revno + 1):
2953
b.repository.sign_revision(b.get_rev_id(revno),
2956
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2959
class cmd_bind(Command):
2960
"""Convert the current branch into a checkout of the supplied branch.
2962
Once converted into a checkout, commits must succeed on the master branch
2963
before they will be applied to the local branch.
2965
See "help checkouts" for more information on checkouts.
2968
takes_args = ['location?']
2971
def run(self, location=None):
2972
b, relpath = Branch.open_containing(u'.')
2973
if location is None:
2975
location = b.get_old_bound_location()
2976
except errors.UpgradeRequired:
2977
raise errors.BzrCommandError('No location supplied. '
2978
'This format does not remember old locations.')
2980
if location is None:
2981
raise errors.BzrCommandError('No location supplied and no '
2982
'previous location known')
2983
b_other = Branch.open(location)
2986
except errors.DivergedBranches:
2987
raise errors.BzrCommandError('These branches have diverged.'
2988
' Try merging, and then bind again.')
2991
class cmd_unbind(Command):
2992
"""Convert the current checkout into a regular branch.
2994
After unbinding, the local branch is considered independent and subsequent
2995
commits will be local only.
2997
See "help checkouts" for more information on checkouts.
3004
b, relpath = Branch.open_containing(u'.')
3006
raise errors.BzrCommandError('Local branch is not bound')
3009
class cmd_uncommit(Command):
3010
"""Remove the last committed revision.
3012
--verbose will print out what is being removed.
3013
--dry-run will go through all the motions, but not actually
3016
In the future, uncommit will create a revision bundle, which can then
3020
# TODO: jam 20060108 Add an option to allow uncommit to remove
3021
# unreferenced information in 'branch-as-repository' branches.
3022
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3023
# information in shared branches as well.
3024
takes_options = ['verbose', 'revision',
3025
Option('dry-run', help='Don\'t actually make changes'),
3026
Option('force', help='Say yes to all questions.')]
3027
takes_args = ['location?']
3030
def run(self, location=None,
3031
dry_run=False, verbose=False,
3032
revision=None, force=False):
3033
from bzrlib.log import log_formatter, show_log
3035
from bzrlib.uncommit import uncommit
3037
if location is None:
3039
control, relpath = bzrdir.BzrDir.open_containing(location)
3041
tree = control.open_workingtree()
3043
except (errors.NoWorkingTree, errors.NotLocalUrl):
3045
b = control.open_branch()
3048
if revision is None:
3051
# 'bzr uncommit -r 10' actually means uncommit
3052
# so that the final tree is at revno 10.
3053
# but bzrlib.uncommit.uncommit() actually uncommits
3054
# the revisions that are supplied.
3055
# So we need to offset it by one
3056
revno = revision[0].in_history(b).revno+1
3058
if revno <= b.revno():
3059
rev_id = b.get_rev_id(revno)
3061
self.outf.write('No revisions to uncommit.\n')
3064
lf = log_formatter('short',
3066
show_timezone='original')
3071
direction='forward',
3072
start_revision=revno,
3073
end_revision=b.revno())
3076
print 'Dry-run, pretending to remove the above revisions.'
3078
val = raw_input('Press <enter> to continue')
3080
print 'The above revision(s) will be removed.'
3082
val = raw_input('Are you sure [y/N]? ')
3083
if val.lower() not in ('y', 'yes'):
3087
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3091
class cmd_break_lock(Command):
3092
"""Break a dead lock on a repository, branch or working directory.
3094
CAUTION: Locks should only be broken when you are sure that the process
3095
holding the lock has been stopped.
3097
You can get information on what locks are open via the 'bzr info' command.
3102
takes_args = ['location?']
3104
def run(self, location=None, show=False):
3105
if location is None:
3107
control, relpath = bzrdir.BzrDir.open_containing(location)
3109
control.break_lock()
3110
except NotImplementedError:
3114
class cmd_wait_until_signalled(Command):
3115
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3117
This just prints a line to signal when it is ready, then blocks on stdin.
3123
sys.stdout.write("running\n")
3125
sys.stdin.readline()
3128
class cmd_serve(Command):
3129
"""Run the bzr server."""
3131
aliases = ['server']
3135
help='serve on stdin/out for use from inetd or sshd'),
3137
help='listen for connections on nominated port of the form '
3138
'[hostname:]portnumber. Passing 0 as the port number will '
3139
'result in a dynamically allocated port. Default port is '
3143
help='serve contents of directory',
3145
Option('allow-writes',
3146
help='By default the server is a readonly server. Supplying '
3147
'--allow-writes enables write access to the contents of '
3148
'the served directory and below. '
3152
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3153
from bzrlib.transport import smart
3154
from bzrlib.transport import get_transport
3155
if directory is None:
3156
directory = os.getcwd()
3157
url = urlutils.local_path_to_url(directory)
3158
if not allow_writes:
3159
url = 'readonly+' + url
3160
t = get_transport(url)
3162
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3165
port = smart.BZR_DEFAULT_PORT
3169
host, port = port.split(':')
3173
server = smart.SmartTCPServer(t, host=host, port=port)
3174
print 'listening on port: ', server.port
3179
class cmd_tag(Command):
3180
"""Create a tag naming a revision.
3182
Tags give human-meaningful names to revisions. Commands that take a -r
3183
(--revision) option can be given -rtag:X, where X is any previously
3186
Tags are stored in the branch. Tags are copied from one branch to another
3187
along when you branch, push, pull or merge.
3189
It is an error to give a tag name that already exists unless you pass
3190
--force, in which case the tag is moved to point to the new revision.
3193
takes_args = ['tag_name']
3196
help='Delete this tag rather than placing it.',
3199
help='Branch in which to place the tag.',
3204
help='Replace existing tags',
3209
def run(self, tag_name,
3215
branch, relpath = Branch.open_containing(directory)
3219
branch.tags.delete_tag(tag_name)
3220
self.outf.write('Deleted tag %s.\n' % tag_name)
3223
if len(revision) != 1:
3224
raise errors.BzrCommandError(
3225
"Tags can only be placed on a single revision, "
3227
revision_id = revision[0].in_history(branch).rev_id
3229
revision_id = branch.last_revision()
3230
if (not force) and branch.tags.has_tag(tag_name):
3231
raise errors.TagAlreadyExists(tag_name)
3232
branch.tags.set_tag(tag_name, revision_id)
3233
self.outf.write('Created tag %s.\n' % tag_name)
3238
class cmd_tags(Command):
3241
This tag shows a table of tag names and the revisions they reference.
3246
help='Branch whose tags should be displayed',
3256
branch, relpath = Branch.open_containing(directory)
3257
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3258
self.outf.write('%-20s %s\n' % (tag_name, target))
3261
# command-line interpretation helper for merge-related commands
3262
def _merge_helper(other_revision, base_revision,
3263
check_clean=True, ignore_zero=False,
3264
this_dir=None, backup_files=False,
3266
file_list=None, show_base=False, reprocess=False,
3269
change_reporter=None):
3270
"""Merge changes into a tree.
3273
list(path, revno) Base for three-way merge.
3274
If [None, None] then a base will be automatically determined.
3276
list(path, revno) Other revision for three-way merge.
3278
Directory to merge changes into; '.' by default.
3280
If true, this_dir must have no uncommitted changes before the
3282
ignore_zero - If true, suppress the "zero conflicts" message when
3283
there are no conflicts; should be set when doing something we expect
3284
to complete perfectly.
3285
file_list - If supplied, merge only changes to selected files.
3287
All available ancestors of other_revision and base_revision are
3288
automatically pulled into the branch.
3290
The revno may be -1 to indicate the last revision on the branch, which is
3293
This function is intended for use from the command line; programmatic
3294
clients might prefer to call merge.merge_inner(), which has less magic
3297
# Loading it late, so that we don't always have to import bzrlib.merge
3298
if merge_type is None:
3299
merge_type = _mod_merge.Merge3Merger
3300
if this_dir is None:
3302
this_tree = WorkingTree.open_containing(this_dir)[0]
3303
if show_base and not merge_type is _mod_merge.Merge3Merger:
3304
raise errors.BzrCommandError("Show-base is not supported for this merge"
3305
" type. %s" % merge_type)
3306
if reprocess and not merge_type.supports_reprocess:
3307
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3308
" type %s." % merge_type)
3309
if reprocess and show_base:
3310
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3312
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3313
pb=pb, change_reporter=change_reporter)
3314
merger.pp = ProgressPhase("Merge phase", 5, pb)
3315
merger.pp.next_phase()
3316
merger.check_basis(check_clean)
3317
merger.set_other(other_revision)
3318
merger.pp.next_phase()
3319
merger.set_base(base_revision)
3320
if merger.base_rev_id == merger.other_rev_id:
3321
note('Nothing to do.')
3323
if file_list is None:
3324
if pull and merger.base_rev_id == merger.this_rev_id:
3325
# FIXME: deduplicate with pull
3326
result = merger.this_tree.pull(merger.this_branch,
3327
False, merger.other_rev_id)
3328
if result.old_revid == result.new_revid:
3329
note('No revisions to pull.')
3331
note('Now on revision %d.' % result.new_revno)
3333
merger.backup_files = backup_files
3334
merger.merge_type = merge_type
3335
merger.set_interesting_files(file_list)
3336
merger.show_base = show_base
3337
merger.reprocess = reprocess
3338
conflicts = merger.do_merge()
3339
if file_list is None:
3340
merger.set_pending()
3347
merge = _merge_helper
3350
# these get imported and then picked up by the scan for cmd_*
3351
# TODO: Some more consistent way to split command definitions across files;
3352
# we do need to load at least some information about them to know of
3353
# aliases. ideally we would avoid loading the implementation until the
3354
# details were needed.
3355
from bzrlib.cmd_version_info import cmd_version_info
3356
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3357
from bzrlib.bundle.commands import cmd_bundle_revisions
3358
from bzrlib.sign_my_commits import cmd_sign_my_commits
3359
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3360
cmd_weave_plan_merge, cmd_weave_merge_text