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(), """
48
from bzrlib.branch import Branch
49
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
50
from bzrlib.conflicts import ConflictList
51
from bzrlib.revision import common_ancestor
52
from bzrlib.revisionspec import RevisionSpec
53
from bzrlib.workingtree import WorkingTree
56
from bzrlib.commands import Command, display_command
57
from bzrlib.option import Option, RegistryOption
58
from bzrlib.progress import DummyProgress, ProgressPhase
59
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
62
def tree_files(file_list, default_branch=u'.'):
64
return internal_tree_files(file_list, default_branch)
65
except errors.FileInWrongBranch, e:
66
raise errors.BzrCommandError("%s is not in the same branch as %s" %
67
(e.path, file_list[0]))
70
# XXX: Bad function name; should possibly also be a class method of
71
# WorkingTree rather than a function.
72
def internal_tree_files(file_list, default_branch=u'.'):
73
"""Convert command-line paths to a WorkingTree and relative paths.
75
This is typically used for command-line processors that take one or
76
more filenames, and infer the workingtree that contains them.
78
The filenames given are not required to exist.
80
:param file_list: Filenames to convert.
82
:param default_branch: Fallback tree path to use if file_list is empty or
85
:return: workingtree, [relative_paths]
87
if file_list is None or len(file_list) == 0:
88
return WorkingTree.open_containing(default_branch)[0], file_list
89
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
91
for filename in file_list:
93
new_list.append(tree.relpath(osutils.dereference_path(filename)))
94
except errors.PathNotChild:
95
raise errors.FileInWrongBranch(tree.branch, filename)
99
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
100
def get_format_type(typestring):
101
"""Parse and return a format specifier."""
102
# Have to use BzrDirMetaFormat1 directly, so that
103
# RepositoryFormat.set_default_format works
104
if typestring == "default":
105
return bzrdir.BzrDirMetaFormat1()
107
return bzrdir.format_registry.make_bzrdir(typestring)
109
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
110
raise errors.BzrCommandError(msg)
113
# TODO: Make sure no commands unconditionally use the working directory as a
114
# branch. If a filename argument is used, the first of them should be used to
115
# specify the branch. (Perhaps this can be factored out into some kind of
116
# Argument class, representing a file in a branch, where the first occurrence
119
class cmd_status(Command):
120
"""Display status summary.
122
This reports on versioned and unknown files, reporting them
123
grouped by state. Possible states are:
126
Versioned in the working copy but not in the previous revision.
129
Versioned in the previous revision but removed or deleted
133
Path of this file changed from the previous revision;
134
the text may also have changed. This includes files whose
135
parent directory was renamed.
138
Text has changed since the previous revision.
141
File kind has been changed (e.g. from file to directory).
144
Not versioned and not matching an ignore pattern.
146
To see ignored files use 'bzr ignored'. For details in the
147
changes to file texts, use 'bzr diff'.
149
--short gives a status flags for each item, similar to the SVN's status
152
Column 1: versioning / renames
158
P Entry for a pending merge (not a file)
167
* The execute bit was changed
169
If no arguments are specified, the status of the entire working
170
directory is shown. Otherwise, only the status of the specified
171
files or directories is reported. If a directory is given, status
172
is reported for everything inside that directory.
174
If a revision argument is given, the status is calculated against
175
that revision, or between two revisions if two are provided.
178
# TODO: --no-recurse, --recurse options
180
takes_args = ['file*']
181
takes_options = ['show-ids', 'revision', 'short']
182
aliases = ['st', 'stat']
184
encoding_type = 'replace'
187
def run(self, show_ids=False, file_list=None, revision=None, short=False):
188
from bzrlib.status import show_tree_status
190
tree, file_list = tree_files(file_list)
192
show_tree_status(tree, show_ids=show_ids,
193
specific_files=file_list, revision=revision,
198
class cmd_cat_revision(Command):
199
"""Write out metadata for a revision.
201
The revision to print can either be specified by a specific
202
revision identifier, or you can use --revision.
206
takes_args = ['revision_id?']
207
takes_options = ['revision']
208
# cat-revision is more for frontends so should be exact
212
def run(self, revision_id=None, revision=None):
214
if revision_id is not None and revision is not None:
215
raise errors.BzrCommandError('You can only supply one of'
216
' revision_id or --revision')
217
if revision_id is None and revision is None:
218
raise errors.BzrCommandError('You must supply either'
219
' --revision or a revision_id')
220
b = WorkingTree.open_containing(u'.')[0].branch
222
# TODO: jam 20060112 should cat-revision always output utf-8?
223
if revision_id is not None:
224
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
225
elif revision is not None:
228
raise errors.BzrCommandError('You cannot specify a NULL'
230
revno, rev_id = rev.in_history(b)
231
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
234
class cmd_remove_tree(Command):
235
"""Remove the working tree from a given branch/checkout.
237
Since a lightweight checkout is little more than a working tree
238
this will refuse to run against one.
241
takes_args = ['location?']
243
def run(self, location='.'):
244
d = bzrdir.BzrDir.open(location)
247
working = d.open_workingtree()
248
except errors.NoWorkingTree:
249
raise errors.BzrCommandError("No working tree to remove")
250
except errors.NotLocalUrl:
251
raise errors.BzrCommandError("You cannot remove the working tree of a "
254
working_path = working.bzrdir.root_transport.base
255
branch_path = working.branch.bzrdir.root_transport.base
256
if working_path != branch_path:
257
raise errors.BzrCommandError("You cannot remove the working tree from "
258
"a lightweight checkout")
260
d.destroy_workingtree()
263
class cmd_revno(Command):
264
"""Show current revision number.
266
This is equal to the number of revisions on this branch.
269
takes_args = ['location?']
272
def run(self, location=u'.'):
273
self.outf.write(str(Branch.open_containing(location)[0].revno()))
274
self.outf.write('\n')
277
class cmd_revision_info(Command):
278
"""Show revision number and revision id for a given revision identifier.
281
takes_args = ['revision_info*']
282
takes_options = ['revision']
285
def run(self, revision=None, revision_info_list=[]):
288
if revision is not None:
289
revs.extend(revision)
290
if revision_info_list is not None:
291
for rev in revision_info_list:
292
revs.append(RevisionSpec.from_string(rev))
294
raise errors.BzrCommandError('You must supply a revision identifier')
296
b = WorkingTree.open_containing(u'.')[0].branch
299
revinfo = rev.in_history(b)
300
if revinfo.revno is None:
301
print ' %s' % revinfo.rev_id
303
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
306
class cmd_add(Command):
307
"""Add specified files or directories.
309
In non-recursive mode, all the named items are added, regardless
310
of whether they were previously ignored. A warning is given if
311
any of the named files are already versioned.
313
In recursive mode (the default), files are treated the same way
314
but the behaviour for directories is different. Directories that
315
are already versioned do not give a warning. All directories,
316
whether already versioned or not, are searched for files or
317
subdirectories that are neither versioned or ignored, and these
318
are added. This search proceeds recursively into versioned
319
directories. If no names are given '.' is assumed.
321
Therefore simply saying 'bzr add' will version all files that
322
are currently unknown.
324
Adding a file whose parent directory is not versioned will
325
implicitly add the parent, and so on up to the root. This means
326
you should never need to explicitly add a directory, they'll just
327
get added when you add a file in the directory.
329
--dry-run will show which files would be added, but not actually
332
--file-ids-from will try to use the file ids from the supplied path.
333
It looks up ids trying to find a matching parent directory with the
334
same filename, and then by pure path.
336
takes_args = ['file*']
337
takes_options = ['no-recurse', 'dry-run', 'verbose',
338
Option('file-ids-from', type=unicode,
339
help='Lookup file ids from here')]
340
encoding_type = 'replace'
342
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
346
if file_ids_from is not None:
348
base_tree, base_path = WorkingTree.open_containing(
350
except errors.NoWorkingTree:
351
base_branch, base_path = Branch.open_containing(
353
base_tree = base_branch.basis_tree()
355
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
356
to_file=self.outf, should_print=(not is_quiet()))
358
action = bzrlib.add.AddAction(to_file=self.outf,
359
should_print=(not is_quiet()))
361
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
362
action=action, save=not dry_run)
365
for glob in sorted(ignored.keys()):
366
for path in ignored[glob]:
367
self.outf.write("ignored %s matching \"%s\"\n"
371
for glob, paths in ignored.items():
372
match_len += len(paths)
373
self.outf.write("ignored %d file(s).\n" % match_len)
374
self.outf.write("If you wish to add some of these files,"
375
" please add them by name.\n")
378
class cmd_mkdir(Command):
379
"""Create a new versioned directory.
381
This is equivalent to creating the directory and then adding it.
384
takes_args = ['dir+']
385
encoding_type = 'replace'
387
def run(self, dir_list):
390
wt, dd = WorkingTree.open_containing(d)
392
self.outf.write('added %s\n' % d)
395
class cmd_relpath(Command):
396
"""Show path of a file relative to root"""
398
takes_args = ['filename']
402
def run(self, filename):
403
# TODO: jam 20050106 Can relpath return a munged path if
404
# sys.stdout encoding cannot represent it?
405
tree, relpath = WorkingTree.open_containing(filename)
406
self.outf.write(relpath)
407
self.outf.write('\n')
410
class cmd_inventory(Command):
411
"""Show inventory of the current working copy or a revision.
413
It is possible to limit the output to a particular entry
414
type using the --kind option. For example: --kind file.
416
It is also possible to restrict the list of files to a specific
417
set. For example: bzr inventory --show-ids this/file
424
takes_options = ['revision', 'show-ids', 'kind']
426
takes_args = ['file*']
429
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
430
if kind and kind not in ['file', 'directory', 'symlink']:
431
raise errors.BzrCommandError('invalid kind specified')
433
work_tree, file_list = tree_files(file_list)
435
if revision is not None:
436
if len(revision) > 1:
437
raise errors.BzrCommandError('bzr inventory --revision takes'
438
' exactly one revision identifier')
439
revision_id = revision[0].in_history(work_tree.branch).rev_id
440
tree = work_tree.branch.repository.revision_tree(revision_id)
442
# We include work_tree as well as 'tree' here
443
# So that doing '-r 10 path/foo' will lookup whatever file
444
# exists now at 'path/foo' even if it has been renamed, as
445
# well as whatever files existed in revision 10 at path/foo
446
trees = [tree, work_tree]
451
if file_list is not None:
452
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
453
require_versioned=True)
454
# find_ids_across_trees may include some paths that don't
456
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
457
for file_id in file_ids if file_id in tree)
459
entries = tree.inventory.entries()
461
for path, entry in entries:
462
if kind and kind != entry.kind:
465
self.outf.write('%-50s %s\n' % (path, entry.file_id))
467
self.outf.write(path)
468
self.outf.write('\n')
471
class cmd_mv(Command):
472
"""Move or rename a file.
475
bzr mv OLDNAME NEWNAME
476
bzr mv SOURCE... DESTINATION
478
If the last argument is a versioned directory, all the other names
479
are moved into it. Otherwise, there must be exactly two arguments
480
and the file is changed to a new name.
482
If OLDNAME does not exist on the filesystem but is versioned and
483
NEWNAME does exist on the filesystem but is not versioned, mv
484
assumes that the file has been manually moved and only updates
485
its internal inventory to reflect that change.
486
The same is valid when moving many SOURCE files to a DESTINATION.
488
Files cannot be moved between branches.
491
takes_args = ['names*']
492
takes_options = [Option("after", help="move only the bzr identifier"
493
" of the file (file has already been moved). Use this flag if"
494
" bzr is not able to detect this itself.")]
495
aliases = ['move', 'rename']
496
encoding_type = 'replace'
498
def run(self, names_list, after=False):
499
if names_list is None:
502
if len(names_list) < 2:
503
raise errors.BzrCommandError("missing file argument")
504
tree, rel_names = tree_files(names_list)
506
if os.path.isdir(names_list[-1]):
507
# move into existing directory
508
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
509
self.outf.write("%s => %s\n" % pair)
511
if len(names_list) != 2:
512
raise errors.BzrCommandError('to mv multiple files the'
513
' destination must be a versioned'
515
tree.rename_one(rel_names[0], rel_names[1], after=after)
516
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
519
class cmd_pull(Command):
520
"""Turn this branch into a mirror of another branch.
522
This command only works on branches that have not diverged. Branches are
523
considered diverged if the destination branch's most recent commit is one
524
that has not been merged (directly or indirectly) into the parent.
526
If branches have diverged, you can use 'bzr merge' to integrate the changes
527
from one into the other. Once one branch has merged, the other should
528
be able to pull it again.
530
If you want to forget your local changes and just update your branch to
531
match the remote one, use pull --overwrite.
533
If there is no default location set, the first pull will set it. After
534
that, you can omit the location to use the default. To change the
535
default, use --remember. The value will only be saved if the remote
536
location can be accessed.
539
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
541
help='branch to pull into, '
542
'rather than the one containing the working directory',
547
takes_args = ['location?']
548
encoding_type = 'replace'
550
def run(self, location=None, remember=False, overwrite=False,
551
revision=None, verbose=False,
553
from bzrlib.tag import _merge_tags_if_possible
554
# FIXME: too much stuff is in the command class
555
if directory is None:
558
tree_to = WorkingTree.open_containing(directory)[0]
559
branch_to = tree_to.branch
560
except errors.NoWorkingTree:
562
branch_to = Branch.open_containing(directory)[0]
565
if location is not None:
567
reader = bundle.read_bundle_from_url(location)
568
except errors.NotABundle:
569
pass # Continue on considering this url a Branch
571
stored_loc = branch_to.get_parent()
573
if stored_loc is None:
574
raise errors.BzrCommandError("No pull location known or"
577
display_url = urlutils.unescape_for_display(stored_loc,
579
self.outf.write("Using saved location: %s\n" % display_url)
580
location = stored_loc
582
if reader is not None:
583
install_bundle(branch_to.repository, reader)
584
branch_from = branch_to
586
branch_from = Branch.open(location)
588
if branch_to.get_parent() is None or remember:
589
branch_to.set_parent(branch_from.base)
593
if reader is not None:
594
rev_id = reader.target
595
elif len(revision) == 1:
596
rev_id = revision[0].in_history(branch_from).rev_id
598
raise errors.BzrCommandError('bzr pull --revision takes one value.')
600
old_rh = branch_to.revision_history()
601
if tree_to is not None:
602
result = tree_to.pull(branch_from, overwrite, rev_id,
603
delta.ChangeReporter(tree_to.inventory))
605
result = branch_to.pull(branch_from, overwrite, rev_id)
607
result.report(self.outf)
609
from bzrlib.log import show_changed_revisions
610
new_rh = branch_to.revision_history()
611
show_changed_revisions(branch_to, old_rh, new_rh, to_file=self.outf)
614
class cmd_push(Command):
615
"""Update a mirror of this branch.
617
The target branch will not have its working tree populated because this
618
is both expensive, and is not supported on remote file systems.
620
Some smart servers or protocols *may* put the working tree in place in
623
This command only works on branches that have not diverged. Branches are
624
considered diverged if the destination branch's most recent commit is one
625
that has not been merged (directly or indirectly) by the source branch.
627
If branches have diverged, you can use 'bzr push --overwrite' to replace
628
the other branch completely, discarding its unmerged changes.
630
If you want to ensure you have the different changes in the other branch,
631
do a merge (see bzr help merge) from the other branch, and commit that.
632
After that you will be able to do a push without '--overwrite'.
634
If there is no default push location set, the first push will set it.
635
After that, you can omit the location to use the default. To change the
636
default, use --remember. The value will only be saved if the remote
637
location can be accessed.
640
takes_options = ['remember', 'overwrite', 'verbose',
641
Option('create-prefix',
642
help='Create the path leading up to the branch '
643
'if it does not already exist'),
645
help='branch to push from, '
646
'rather than the one containing the working directory',
650
Option('use-existing-dir',
651
help='By default push will fail if the target'
652
' directory exists, but does not already'
653
' have a control directory. This flag will'
654
' allow push to proceed.'),
656
takes_args = ['location?']
657
encoding_type = 'replace'
659
def run(self, location=None, remember=False, overwrite=False,
660
create_prefix=False, verbose=False,
661
use_existing_dir=False,
663
# FIXME: Way too big! Put this into a function called from the
665
if directory is None:
667
br_from = Branch.open_containing(directory)[0]
668
stored_loc = br_from.get_push_location()
670
if stored_loc is None:
671
raise errors.BzrCommandError("No push location known or specified.")
673
display_url = urlutils.unescape_for_display(stored_loc,
675
self.outf.write("Using saved location: %s\n" % display_url)
676
location = stored_loc
678
to_transport = transport.get_transport(location)
679
location_url = to_transport.base
681
br_to = repository_to = dir_to = None
683
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
684
except errors.NotBranchError:
685
pass # Didn't find anything
687
# If we can open a branch, use its direct repository, otherwise see
688
# if there is a repository without a branch.
690
br_to = dir_to.open_branch()
691
except errors.NotBranchError:
692
# Didn't find a branch, can we find a repository?
694
repository_to = dir_to.find_repository()
695
except errors.NoRepositoryPresent:
698
# Found a branch, so we must have found a repository
699
repository_to = br_to.repository
703
# The destination doesn't exist; create it.
704
# XXX: Refactor the create_prefix/no_create_prefix code into a
705
# common helper function
707
to_transport.mkdir('.')
708
except errors.FileExists:
709
if not use_existing_dir:
710
raise errors.BzrCommandError("Target directory %s"
711
" already exists, but does not have a valid .bzr"
712
" directory. Supply --use-existing-dir to push"
713
" there anyway." % location)
714
except errors.NoSuchFile:
715
if not create_prefix:
716
raise errors.BzrCommandError("Parent directory of %s"
718
"\nYou may supply --create-prefix to create all"
719
" leading parent directories."
722
cur_transport = to_transport
723
needed = [cur_transport]
724
# Recurse upwards until we can create a directory successfully
726
new_transport = cur_transport.clone('..')
727
if new_transport.base == cur_transport.base:
728
raise errors.BzrCommandError("Failed to create path"
732
new_transport.mkdir('.')
733
except errors.NoSuchFile:
734
needed.append(new_transport)
735
cur_transport = new_transport
739
# Now we only need to create child directories
741
cur_transport = needed.pop()
742
cur_transport.mkdir('.')
744
# Now the target directory exists, but doesn't have a .bzr
745
# directory. So we need to create it, along with any work to create
746
# all of the dependent branches, etc.
747
dir_to = br_from.bzrdir.clone(location_url,
748
revision_id=br_from.last_revision())
749
br_to = dir_to.open_branch()
750
# TODO: Some more useful message about what was copied
751
note('Created new branch.')
752
# We successfully created the target, remember it
753
if br_from.get_push_location() is None or remember:
754
br_from.set_push_location(br_to.base)
755
elif repository_to is None:
756
# we have a bzrdir but no branch or repository
757
# XXX: Figure out what to do other than complain.
758
raise errors.BzrCommandError("At %s you have a valid .bzr control"
759
" directory, but not a branch or repository. This is an"
760
" unsupported configuration. Please move the target directory"
761
" out of the way and try again."
764
# We have a repository but no branch, copy the revisions, and then
766
last_revision_id = br_from.last_revision()
767
repository_to.fetch(br_from.repository,
768
revision_id=last_revision_id)
769
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
770
note('Created new branch.')
771
if br_from.get_push_location() is None or remember:
772
br_from.set_push_location(br_to.base)
773
else: # We have a valid to branch
774
# We were able to connect to the remote location, so remember it
775
# we don't need to successfully push because of possible divergence.
776
if br_from.get_push_location() is None or remember:
777
br_from.set_push_location(br_to.base)
778
old_rh = br_to.revision_history()
781
tree_to = dir_to.open_workingtree()
782
except errors.NotLocalUrl:
783
warning('This transport does not update the working '
784
'tree of: %s' % (br_to.base,))
785
push_result = br_from.push(br_to, overwrite)
786
except errors.NoWorkingTree:
787
push_result = br_from.push(br_to, overwrite)
791
push_result = br_from.push(tree_to.branch, overwrite)
795
except errors.DivergedBranches:
796
raise errors.BzrCommandError('These branches have diverged.'
797
' Try using "merge" and then "push".')
798
if push_result is not None:
799
push_result.report(self.outf)
801
new_rh = br_to.revision_history()
804
from bzrlib.log import show_changed_revisions
805
show_changed_revisions(br_to, old_rh, new_rh,
808
# we probably did a clone rather than a push, so a message was
813
class cmd_branch(Command):
814
"""Create a new copy of a branch.
816
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
817
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
819
To retrieve the branch as of a particular revision, supply the --revision
820
parameter, as in "branch foo/bar -r 5".
822
--basis is to speed up branching from remote branches. When specified, it
823
copies all the file-contents, inventory and revision data from the basis
824
branch before copying anything from the remote branch.
826
takes_args = ['from_location', 'to_location?']
827
takes_options = ['revision', 'basis']
828
aliases = ['get', 'clone']
830
def run(self, from_location, to_location=None, revision=None, basis=None):
831
from bzrlib.tag import _merge_tags_if_possible
834
elif len(revision) > 1:
835
raise errors.BzrCommandError(
836
'bzr branch --revision takes exactly 1 revision value')
838
br_from = Branch.open(from_location)
841
if basis is not None:
842
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
845
if len(revision) == 1 and revision[0] is not None:
846
revision_id = revision[0].in_history(br_from)[1]
848
# FIXME - wt.last_revision, fallback to branch, fall back to
849
# None or perhaps NULL_REVISION to mean copy nothing
851
revision_id = br_from.last_revision()
852
if to_location is None:
853
to_location = os.path.basename(from_location.rstrip("/\\"))
856
name = os.path.basename(to_location) + '\n'
858
to_transport = transport.get_transport(to_location)
860
to_transport.mkdir('.')
861
except errors.FileExists:
862
raise errors.BzrCommandError('Target directory "%s" already'
863
' exists.' % to_location)
864
except errors.NoSuchFile:
865
raise errors.BzrCommandError('Parent of "%s" does not exist.'
868
# preserve whatever source format we have.
869
dir = br_from.bzrdir.sprout(to_transport.base,
870
revision_id, basis_dir)
871
branch = dir.open_branch()
872
except errors.NoSuchRevision:
873
to_transport.delete_tree('.')
874
msg = "The branch %s has no revision %s." % (from_location, revision[0])
875
raise errors.BzrCommandError(msg)
876
except errors.UnlistableBranch:
877
osutils.rmtree(to_location)
878
msg = "The branch %s cannot be used as a --basis" % (basis,)
879
raise errors.BzrCommandError(msg)
881
branch.control_files.put_utf8('branch-name', name)
882
_merge_tags_if_possible(br_from, branch)
883
note('Branched %d revision(s).' % branch.revno())
888
class cmd_checkout(Command):
889
"""Create a new checkout of an existing branch.
891
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
892
the branch found in '.'. This is useful if you have removed the working tree
893
or if it was never created - i.e. if you pushed the branch to its current
896
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
897
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
899
To retrieve the branch as of a particular revision, supply the --revision
900
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
901
out of date [so you cannot commit] but it may be useful (i.e. to examine old
904
--basis is to speed up checking out from remote branches. When specified, it
905
uses the inventory and file contents from the basis branch in preference to the
906
branch being checked out.
908
See "help checkouts" for more information on checkouts.
910
takes_args = ['branch_location?', 'to_location?']
911
takes_options = ['revision', # , 'basis']
912
Option('lightweight',
913
help="perform a lightweight checkout. Lightweight "
914
"checkouts depend on access to the branch for "
915
"every operation. Normal checkouts can perform "
916
"common operations like diff and status without "
917
"such access, and also support local commits."
922
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
926
elif len(revision) > 1:
927
raise errors.BzrCommandError(
928
'bzr checkout --revision takes exactly 1 revision value')
929
if branch_location is None:
930
branch_location = osutils.getcwd()
931
to_location = branch_location
932
source = Branch.open(branch_location)
933
if len(revision) == 1 and revision[0] is not None:
934
revision_id = revision[0].in_history(source)[1]
937
if to_location is None:
938
to_location = os.path.basename(branch_location.rstrip("/\\"))
939
# if the source and to_location are the same,
940
# and there is no working tree,
941
# then reconstitute a branch
942
if (osutils.abspath(to_location) ==
943
osutils.abspath(branch_location)):
945
source.bzrdir.open_workingtree()
946
except errors.NoWorkingTree:
947
source.bzrdir.create_workingtree()
950
os.mkdir(to_location)
952
if e.errno == errno.EEXIST:
953
raise errors.BzrCommandError('Target directory "%s" already'
954
' exists.' % to_location)
955
if e.errno == errno.ENOENT:
956
raise errors.BzrCommandError('Parent of "%s" does not exist.'
960
source.create_checkout(to_location, revision_id, lightweight)
963
class cmd_renames(Command):
964
"""Show list of renamed files.
966
# TODO: Option to show renames between two historical versions.
968
# TODO: Only show renames under dir, rather than in the whole branch.
969
takes_args = ['dir?']
972
def run(self, dir=u'.'):
973
tree = WorkingTree.open_containing(dir)[0]
974
old_inv = tree.basis_tree().inventory
975
new_inv = tree.read_working_inventory()
976
renames = list(_mod_tree.find_renames(old_inv, new_inv))
978
for old_name, new_name in renames:
979
self.outf.write("%s => %s\n" % (old_name, new_name))
982
class cmd_update(Command):
983
"""Update a tree to have the latest code committed to its branch.
985
This will perform a merge into the working tree, and may generate
986
conflicts. If you have any local changes, you will still
987
need to commit them after the update for the update to be complete.
989
If you want to discard your local changes, you can just do a
990
'bzr revert' instead of 'bzr commit' after the update.
992
takes_args = ['dir?']
995
def run(self, dir='.'):
996
tree = WorkingTree.open_containing(dir)[0]
997
master = tree.branch.get_master_branch()
998
if master is not None:
1001
tree.lock_tree_write()
1003
existing_pending_merges = tree.get_parent_ids()[1:]
1004
last_rev = tree.last_revision()
1005
if last_rev == tree.branch.last_revision():
1006
# may be up to date, check master too.
1007
master = tree.branch.get_master_branch()
1008
if master is None or last_rev == master.last_revision():
1009
revno = tree.branch.revision_id_to_revno(last_rev)
1010
note("Tree is up to date at revision %d." % (revno,))
1012
conflicts = tree.update()
1013
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1014
note('Updated to revision %d.' % (revno,))
1015
if tree.get_parent_ids()[1:] != existing_pending_merges:
1016
note('Your local commits will now show as pending merges with '
1017
"'bzr status', and can be committed with 'bzr commit'.")
1026
class cmd_info(Command):
1027
"""Show information about a working tree, branch or repository.
1029
This command will show all known locations and formats associated to the
1030
tree, branch or repository. Statistical information is included with
1033
Branches and working trees will also report any missing revisions.
1035
takes_args = ['location?']
1036
takes_options = ['verbose']
1039
def run(self, location=None, verbose=False):
1040
from bzrlib.info import show_bzrdir_info
1041
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1045
class cmd_remove(Command):
1046
"""Make a file unversioned.
1048
This makes bzr stop tracking changes to a versioned file. It does
1049
not delete the working copy.
1051
You can specify one or more files, and/or --new. If you specify --new,
1052
only 'added' files will be removed. If you specify both, then new files
1053
in the specified directories will be removed. If the directories are
1054
also new, they will also be removed.
1056
takes_args = ['file*']
1057
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1059
encoding_type = 'replace'
1061
def run(self, file_list, verbose=False, new=False):
1062
tree, file_list = tree_files(file_list)
1064
if file_list is None:
1065
raise errors.BzrCommandError('Specify one or more files to'
1066
' remove, or use --new.')
1068
added = tree.changes_from(tree.basis_tree(),
1069
specific_files=file_list).added
1070
file_list = sorted([f[0] for f in added], reverse=True)
1071
if len(file_list) == 0:
1072
raise errors.BzrCommandError('No matching files.')
1073
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1076
class cmd_file_id(Command):
1077
"""Print file_id of a particular file or directory.
1079
The file_id is assigned when the file is first added and remains the
1080
same through all revisions where the file exists, even when it is
1085
takes_args = ['filename']
1088
def run(self, filename):
1089
tree, relpath = WorkingTree.open_containing(filename)
1090
i = tree.inventory.path2id(relpath)
1092
raise errors.NotVersionedError(filename)
1094
self.outf.write(i + '\n')
1097
class cmd_file_path(Command):
1098
"""Print path of file_ids to a file or directory.
1100
This prints one line for each directory down to the target,
1101
starting at the branch root.
1105
takes_args = ['filename']
1108
def run(self, filename):
1109
tree, relpath = WorkingTree.open_containing(filename)
1110
inv = tree.inventory
1111
fid = inv.path2id(relpath)
1113
raise errors.NotVersionedError(filename)
1114
for fip in inv.get_idpath(fid):
1115
self.outf.write(fip + '\n')
1118
class cmd_reconcile(Command):
1119
"""Reconcile bzr metadata in a branch.
1121
This can correct data mismatches that may have been caused by
1122
previous ghost operations or bzr upgrades. You should only
1123
need to run this command if 'bzr check' or a bzr developer
1124
advises you to run it.
1126
If a second branch is provided, cross-branch reconciliation is
1127
also attempted, which will check that data like the tree root
1128
id which was not present in very early bzr versions is represented
1129
correctly in both branches.
1131
At the same time it is run it may recompress data resulting in
1132
a potential saving in disk space or performance gain.
1134
The branch *MUST* be on a listable system such as local disk or sftp.
1136
takes_args = ['branch?']
1138
def run(self, branch="."):
1139
from bzrlib.reconcile import reconcile
1140
dir = bzrdir.BzrDir.open(branch)
1144
class cmd_revision_history(Command):
1145
"""Display the list of revision ids on a branch."""
1146
takes_args = ['location?']
1151
def run(self, location="."):
1152
branch = Branch.open_containing(location)[0]
1153
for revid in branch.revision_history():
1154
self.outf.write(revid)
1155
self.outf.write('\n')
1158
class cmd_ancestry(Command):
1159
"""List all revisions merged into this branch."""
1160
takes_args = ['location?']
1165
def run(self, location="."):
1167
wt = WorkingTree.open_containing(location)[0]
1168
except errors.NoWorkingTree:
1169
b = Branch.open(location)
1170
last_revision = b.last_revision()
1173
last_revision = wt.last_revision()
1175
revision_ids = b.repository.get_ancestry(last_revision)
1176
assert revision_ids[0] is None
1178
for revision_id in revision_ids:
1179
self.outf.write(revision_id + '\n')
1182
class cmd_init(Command):
1183
"""Make a directory into a versioned branch.
1185
Use this to create an empty branch, or before importing an
1188
If there is a repository in a parent directory of the location, then
1189
the history of the branch will be stored in the repository. Otherwise
1190
init creates a standalone branch which carries its own history in
1193
If there is already a branch at the location but it has no working tree,
1194
the tree can be populated with 'bzr checkout'.
1196
Recipe for importing a tree of files:
1201
bzr commit -m 'imported project'
1203
takes_args = ['location?']
1205
RegistryOption('format',
1206
help='Specify a format for this branch. '
1207
'See "help formats".',
1208
registry=bzrdir.format_registry,
1209
converter=bzrdir.format_registry.make_bzrdir,
1210
value_switches=True,
1211
title="Branch Format",
1213
Option('append-revisions-only',
1214
help='Never change revnos or the existing log.'
1215
' Append revisions to it only.')
1217
def run(self, location=None, format=None, append_revisions_only=False):
1219
format = bzrdir.format_registry.make_bzrdir('default')
1220
if location is None:
1223
to_transport = transport.get_transport(location)
1225
# The path has to exist to initialize a
1226
# branch inside of it.
1227
# Just using os.mkdir, since I don't
1228
# believe that we want to create a bunch of
1229
# locations if the user supplies an extended path
1230
# TODO: create-prefix
1232
to_transport.mkdir('.')
1233
except errors.FileExists:
1237
existing_bzrdir = bzrdir.BzrDir.open(location)
1238
except errors.NotBranchError:
1239
# really a NotBzrDir error...
1240
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1243
from bzrlib.transport.local import LocalTransport
1244
if existing_bzrdir.has_branch():
1245
if (isinstance(to_transport, LocalTransport)
1246
and not existing_bzrdir.has_workingtree()):
1247
raise errors.BranchExistsWithoutWorkingTree(location)
1248
raise errors.AlreadyBranchError(location)
1250
branch = existing_bzrdir.create_branch()
1251
existing_bzrdir.create_workingtree()
1252
if append_revisions_only:
1254
branch.set_append_revisions_only(True)
1255
except errors.UpgradeRequired:
1256
raise errors.BzrCommandError('This branch format cannot be set'
1257
' to append-revisions-only. Try --experimental-branch6')
1260
class cmd_init_repository(Command):
1261
"""Create a shared repository to hold branches.
1263
New branches created under the repository directory will store their revisions
1264
in the repository, not in the branch directory, if the branch format supports
1270
bzr checkout --lightweight repo/trunk trunk-checkout
1274
takes_args = ["location"]
1275
takes_options = [RegistryOption('format',
1276
help='Specify a format for this repository. See'
1277
' "bzr help formats" for details',
1278
registry=bzrdir.format_registry,
1279
converter=bzrdir.format_registry.make_bzrdir,
1280
value_switches=True, title='Repository format'),
1282
help='Allows branches in repository to have'
1284
aliases = ["init-repo"]
1285
def run(self, location, format=None, trees=False):
1287
format = bzrdir.format_registry.make_bzrdir('default')
1289
if location is None:
1292
to_transport = transport.get_transport(location)
1294
to_transport.mkdir('.')
1295
except errors.FileExists:
1298
newdir = format.initialize_on_transport(to_transport)
1299
repo = newdir.create_repository(shared=True)
1300
repo.set_make_working_trees(trees)
1303
class cmd_diff(Command):
1304
"""Show differences in the working tree or between revisions.
1306
If files are listed, only the changes in those files are listed.
1307
Otherwise, all changes for the tree are listed.
1309
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1310
produces patches suitable for "patch -p1".
1314
Shows the difference in the working tree versus the last commit
1316
Difference between the working tree and revision 1
1318
Difference between revision 2 and revision 1
1319
bzr diff --diff-prefix old/:new/
1320
Same as 'bzr diff' but prefix paths with old/ and new/
1321
bzr diff bzr.mine bzr.dev
1322
Show the differences between the two working trees
1324
Show just the differences for 'foo.c'
1326
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1327
# or a graphical diff.
1329
# TODO: Python difflib is not exactly the same as unidiff; should
1330
# either fix it up or prefer to use an external diff.
1332
# TODO: Selected-file diff is inefficient and doesn't show you
1335
# TODO: This probably handles non-Unix newlines poorly.
1337
takes_args = ['file*']
1338
takes_options = ['revision', 'diff-options',
1339
Option('prefix', type=str,
1341
help='Set prefixes to added to old and new filenames, as '
1342
'two values separated by a colon.'),
1344
aliases = ['di', 'dif']
1345
encoding_type = 'exact'
1348
def run(self, revision=None, file_list=None, diff_options=None,
1350
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1352
if (prefix is None) or (prefix == '0'):
1360
old_label, new_label = prefix.split(":")
1362
raise BzrCommandError(
1363
"--prefix expects two values separated by a colon")
1365
if revision and len(revision) > 2:
1366
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1367
' one or two revision specifiers')
1370
tree1, file_list = internal_tree_files(file_list)
1374
except errors.FileInWrongBranch:
1375
if len(file_list) != 2:
1376
raise errors.BzrCommandError("Files are in different branches")
1378
tree1, file1 = WorkingTree.open_containing(file_list[0])
1379
tree2, file2 = WorkingTree.open_containing(file_list[1])
1380
if file1 != "" or file2 != "":
1381
# FIXME diff those two files. rbc 20051123
1382
raise errors.BzrCommandError("Files are in different branches")
1384
except errors.NotBranchError:
1385
if (revision is not None and len(revision) == 2
1386
and not revision[0].needs_branch()
1387
and not revision[1].needs_branch()):
1388
# If both revision specs include a branch, we can
1389
# diff them without needing a local working tree
1390
tree1, tree2 = None, None
1394
if tree2 is not None:
1395
if revision is not None:
1396
# FIXME: but there should be a clean way to diff between
1397
# non-default versions of two trees, it's not hard to do
1399
raise errors.BzrCommandError(
1400
"Sorry, diffing arbitrary revisions across branches "
1401
"is not implemented yet")
1402
return show_diff_trees(tree1, tree2, sys.stdout,
1403
specific_files=file_list,
1404
external_diff_options=diff_options,
1405
old_label=old_label, new_label=new_label)
1407
return diff_cmd_helper(tree1, file_list, diff_options,
1408
revision_specs=revision,
1409
old_label=old_label, new_label=new_label)
1412
class cmd_deleted(Command):
1413
"""List files deleted in the working tree.
1415
# TODO: Show files deleted since a previous revision, or
1416
# between two revisions.
1417
# TODO: Much more efficient way to do this: read in new
1418
# directories with readdir, rather than stating each one. Same
1419
# level of effort but possibly much less IO. (Or possibly not,
1420
# if the directories are very large...)
1421
takes_options = ['show-ids']
1424
def run(self, show_ids=False):
1425
tree = WorkingTree.open_containing(u'.')[0]
1426
old = tree.basis_tree()
1427
for path, ie in old.inventory.iter_entries():
1428
if not tree.has_id(ie.file_id):
1429
self.outf.write(path)
1431
self.outf.write(' ')
1432
self.outf.write(ie.file_id)
1433
self.outf.write('\n')
1436
class cmd_modified(Command):
1437
"""List files modified in working tree.
1439
See also: "bzr status".
1446
tree = WorkingTree.open_containing(u'.')[0]
1447
td = tree.changes_from(tree.basis_tree())
1448
for path, id, kind, text_modified, meta_modified in td.modified:
1449
self.outf.write(path + '\n')
1452
class cmd_added(Command):
1453
"""List files added in working tree.
1455
See also: "bzr status".
1462
wt = WorkingTree.open_containing(u'.')[0]
1463
basis_inv = wt.basis_tree().inventory
1466
if file_id in basis_inv:
1468
if inv.is_root(file_id) and len(basis_inv) == 0:
1470
path = inv.id2path(file_id)
1471
if not os.access(osutils.abspath(path), os.F_OK):
1473
self.outf.write(path + '\n')
1476
class cmd_root(Command):
1477
"""Show the tree root directory.
1479
The root is the nearest enclosing directory with a .bzr control
1481
takes_args = ['filename?']
1483
def run(self, filename=None):
1484
"""Print the branch root."""
1485
tree = WorkingTree.open_containing(filename)[0]
1486
self.outf.write(tree.basedir + '\n')
1489
class cmd_log(Command):
1490
"""Show log of a branch, file, or directory.
1492
By default show the log of the branch containing the working directory.
1494
To request a range of logs, you can use the command -r begin..end
1495
-r revision requests a specific revision, -r ..end or -r begin.. are
1501
bzr log -r -10.. http://server/branch
1504
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1506
takes_args = ['location?']
1507
takes_options = [Option('forward',
1508
help='show from oldest to newest'),
1512
help='show files changed in each revision'),
1513
'show-ids', 'revision',
1517
help='show revisions whose message matches this regexp',
1520
encoding_type = 'replace'
1523
def run(self, location=None, timezone='original',
1530
from bzrlib.log import show_log
1531
assert message is None or isinstance(message, basestring), \
1532
"invalid message argument %r" % message
1533
direction = (forward and 'forward') or 'reverse'
1538
# find the file id to log:
1540
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1544
tree = b.basis_tree()
1545
inv = tree.inventory
1546
file_id = inv.path2id(fp)
1548
raise errors.BzrCommandError(
1549
"Path does not have any revision history: %s" %
1553
# FIXME ? log the current subdir only RBC 20060203
1554
if revision is not None \
1555
and len(revision) > 0 and revision[0].get_branch():
1556
location = revision[0].get_branch()
1559
dir, relpath = bzrdir.BzrDir.open_containing(location)
1560
b = dir.open_branch()
1564
if revision is None:
1567
elif len(revision) == 1:
1568
rev1 = rev2 = revision[0].in_history(b).revno
1569
elif len(revision) == 2:
1570
if revision[1].get_branch() != revision[0].get_branch():
1571
# b is taken from revision[0].get_branch(), and
1572
# show_log will use its revision_history. Having
1573
# different branches will lead to weird behaviors.
1574
raise errors.BzrCommandError(
1575
"Log doesn't accept two revisions in different"
1577
if revision[0].spec is None:
1578
# missing begin-range means first revision
1581
rev1 = revision[0].in_history(b).revno
1583
if revision[1].spec is None:
1584
# missing end-range means last known revision
1587
rev2 = revision[1].in_history(b).revno
1589
raise errors.BzrCommandError(
1590
'bzr log --revision takes one or two values.')
1592
# By this point, the revision numbers are converted to the +ve
1593
# form if they were supplied in the -ve form, so we can do
1594
# this comparison in relative safety
1596
(rev2, rev1) = (rev1, rev2)
1598
if log_format is None:
1599
log_format = log.log_formatter_registry.get_default(b)
1601
lf = log_format(show_ids=show_ids, to_file=self.outf,
1602
show_timezone=timezone)
1608
direction=direction,
1609
start_revision=rev1,
1616
def get_log_format(long=False, short=False, line=False, default='long'):
1617
log_format = default
1621
log_format = 'short'
1627
class cmd_touching_revisions(Command):
1628
"""Return revision-ids which affected a particular file.
1630
A more user-friendly interface is "bzr log FILE".
1634
takes_args = ["filename"]
1637
def run(self, filename):
1638
tree, relpath = WorkingTree.open_containing(filename)
1640
inv = tree.read_working_inventory()
1641
file_id = inv.path2id(relpath)
1642
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1643
self.outf.write("%6d %s\n" % (revno, what))
1646
class cmd_ls(Command):
1647
"""List files in a tree.
1650
takes_args = ['path?']
1651
# TODO: Take a revision or remote path and list that tree instead.
1652
takes_options = ['verbose', 'revision',
1653
Option('non-recursive',
1654
help='don\'t recurse into sub-directories'),
1656
help='Print all paths from the root of the branch.'),
1657
Option('unknown', help='Print unknown files'),
1658
Option('versioned', help='Print versioned files'),
1659
Option('ignored', help='Print ignored files'),
1661
Option('null', help='Null separate the files'),
1665
def run(self, revision=None, verbose=False,
1666
non_recursive=False, from_root=False,
1667
unknown=False, versioned=False, ignored=False,
1668
null=False, kind=None, show_ids=False, path=None):
1670
if kind and kind not in ('file', 'directory', 'symlink'):
1671
raise errors.BzrCommandError('invalid kind specified')
1673
if verbose and null:
1674
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1675
all = not (unknown or versioned or ignored)
1677
selection = {'I':ignored, '?':unknown, 'V':versioned}
1684
raise errors.BzrCommandError('cannot specify both --from-root'
1688
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1694
if revision is not None:
1695
tree = branch.repository.revision_tree(
1696
revision[0].in_history(branch).rev_id)
1698
tree = branch.basis_tree()
1700
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1701
if fp.startswith(relpath):
1702
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1703
if non_recursive and '/' in fp:
1705
if not all and not selection[fc]:
1707
if kind is not None and fkind != kind:
1710
kindch = entry.kind_character()
1711
outstring = '%-8s %s%s' % (fc, fp, kindch)
1712
if show_ids and fid is not None:
1713
outstring = "%-50s %s" % (outstring, fid)
1714
self.outf.write(outstring + '\n')
1716
self.outf.write(fp + '\0')
1719
self.outf.write(fid)
1720
self.outf.write('\0')
1728
self.outf.write('%-50s %s\n' % (fp, my_id))
1730
self.outf.write(fp + '\n')
1733
class cmd_unknowns(Command):
1734
"""List unknown files.
1736
See also: "bzr ls --unknown".
1743
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1744
self.outf.write(osutils.quotefn(f) + '\n')
1747
class cmd_ignore(Command):
1748
"""Ignore specified files or patterns.
1750
To remove patterns from the ignore list, edit the .bzrignore file.
1752
Trailing slashes on patterns are ignored.
1753
If the pattern contains a slash or is a regular expression, it is compared
1754
to the whole path from the branch root. Otherwise, it is compared to only
1755
the last component of the path. To match a file only in the root
1756
directory, prepend './'.
1758
Ignore patterns specifying absolute paths are not allowed.
1760
Ignore patterns may include globbing wildcards such as:
1761
? - Matches any single character except '/'
1762
* - Matches 0 or more characters except '/'
1763
/**/ - Matches 0 or more directories in a path
1764
[a-z] - Matches a single character from within a group of characters
1766
Ignore patterns may also be Python regular expressions.
1767
Regular expression ignore patterns are identified by a 'RE:' prefix
1768
followed by the regular expression. Regular expression ignore patterns
1769
may not include named or numbered groups.
1771
Note: ignore patterns containing shell wildcards must be quoted from
1775
bzr ignore ./Makefile
1776
bzr ignore '*.class'
1777
bzr ignore 'lib/**/*.o'
1778
bzr ignore 'RE:lib/.*\.o'
1780
takes_args = ['name_pattern*']
1782
Option('old-default-rules',
1783
help='Out the ignore rules bzr < 0.9 always used.')
1786
def run(self, name_pattern_list=None, old_default_rules=None):
1787
from bzrlib.atomicfile import AtomicFile
1788
if old_default_rules is not None:
1789
# dump the rules and exit
1790
for pattern in ignores.OLD_DEFAULTS:
1793
if not name_pattern_list:
1794
raise errors.BzrCommandError("ignore requires at least one "
1795
"NAME_PATTERN or --old-default-rules")
1796
name_pattern_list = [globbing.normalize_pattern(p)
1797
for p in name_pattern_list]
1798
for name_pattern in name_pattern_list:
1799
if (name_pattern[0] == '/' or
1800
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1801
raise errors.BzrCommandError(
1802
"NAME_PATTERN should not be an absolute path")
1803
tree, relpath = WorkingTree.open_containing(u'.')
1804
ifn = tree.abspath('.bzrignore')
1805
if os.path.exists(ifn):
1808
igns = f.read().decode('utf-8')
1814
# TODO: If the file already uses crlf-style termination, maybe
1815
# we should use that for the newly added lines?
1817
if igns and igns[-1] != '\n':
1819
for name_pattern in name_pattern_list:
1820
igns += name_pattern + '\n'
1822
f = AtomicFile(ifn, 'wb')
1824
f.write(igns.encode('utf-8'))
1829
inv = tree.inventory
1830
if inv.path2id('.bzrignore'):
1831
mutter('.bzrignore is already versioned')
1833
mutter('need to make new .bzrignore file versioned')
1834
tree.add(['.bzrignore'])
1837
class cmd_ignored(Command):
1838
"""List ignored files and the patterns that matched them.
1840
See also: bzr ignore"""
1843
tree = WorkingTree.open_containing(u'.')[0]
1844
for path, file_class, kind, file_id, entry in tree.list_files():
1845
if file_class != 'I':
1847
## XXX: Slightly inefficient since this was already calculated
1848
pat = tree.is_ignored(path)
1849
print '%-50s %s' % (path, pat)
1852
class cmd_lookup_revision(Command):
1853
"""Lookup the revision-id from a revision-number
1856
bzr lookup-revision 33
1859
takes_args = ['revno']
1862
def run(self, revno):
1866
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1868
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1871
class cmd_export(Command):
1872
"""Export past revision to destination directory.
1874
If no revision is specified this exports the last committed revision.
1876
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1877
given, try to find the format with the extension. If no extension
1878
is found exports to a directory (equivalent to --format=dir).
1880
Root may be the top directory for tar, tgz and tbz2 formats. If none
1881
is given, the top directory will be the root name of the file.
1883
If branch is omitted then the branch containing the CWD will be used.
1885
Note: export of tree with non-ascii filenames to zip is not supported.
1887
Supported formats Autodetected by extension
1888
----------------- -------------------------
1891
tbz2 .tar.bz2, .tbz2
1895
takes_args = ['dest', 'branch?']
1896
takes_options = ['revision', 'format', 'root']
1897
def run(self, dest, branch=None, revision=None, format=None, root=None):
1898
from bzrlib.export import export
1901
tree = WorkingTree.open_containing(u'.')[0]
1904
b = Branch.open(branch)
1906
if revision is None:
1907
# should be tree.last_revision FIXME
1908
rev_id = b.last_revision()
1910
if len(revision) != 1:
1911
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1912
rev_id = revision[0].in_history(b).rev_id
1913
t = b.repository.revision_tree(rev_id)
1915
export(t, dest, format, root)
1916
except errors.NoSuchExportFormat, e:
1917
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1920
class cmd_cat(Command):
1921
"""Write a file's text from a previous revision."""
1923
takes_options = ['revision', 'name-from-revision']
1924
takes_args = ['filename']
1925
encoding_type = 'exact'
1928
def run(self, filename, revision=None, name_from_revision=False):
1929
if revision is not None and len(revision) != 1:
1930
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1935
tree, b, relpath = \
1936
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
1937
except errors.NotBranchError:
1940
if revision is not None and revision[0].get_branch() is not None:
1941
b = Branch.open(revision[0].get_branch())
1943
tree = b.basis_tree()
1944
if revision is None:
1945
revision_id = b.last_revision()
1947
revision_id = revision[0].in_history(b).rev_id
1949
cur_file_id = tree.path2id(relpath)
1950
rev_tree = b.repository.revision_tree(revision_id)
1951
old_file_id = rev_tree.path2id(relpath)
1953
if name_from_revision:
1954
if old_file_id is None:
1955
raise errors.BzrCommandError("%r is not present in revision %s"
1956
% (filename, revision_id))
1958
rev_tree.print_file(old_file_id)
1959
elif cur_file_id is not None:
1960
rev_tree.print_file(cur_file_id)
1961
elif old_file_id is not None:
1962
rev_tree.print_file(old_file_id)
1964
raise errors.BzrCommandError("%r is not present in revision %s" %
1965
(filename, revision_id))
1968
class cmd_local_time_offset(Command):
1969
"""Show the offset in seconds from GMT to local time."""
1973
print osutils.local_time_offset()
1977
class cmd_commit(Command):
1978
"""Commit changes into a new revision.
1980
If no arguments are given, the entire tree is committed.
1982
If selected files are specified, only changes to those files are
1983
committed. If a directory is specified then the directory and everything
1984
within it is committed.
1986
A selected-file commit may fail in some cases where the committed
1987
tree would be invalid, such as trying to commit a file in a
1988
newly-added directory that is not itself committed.
1990
# TODO: Run hooks on tree to-be-committed, and after commit.
1992
# TODO: Strict commit that fails if there are deleted files.
1993
# (what does "deleted files" mean ??)
1995
# TODO: Give better message for -s, --summary, used by tla people
1997
# XXX: verbose currently does nothing
1999
takes_args = ['selected*']
2000
takes_options = ['message', 'verbose',
2002
help='commit even if nothing has changed'),
2003
Option('file', type=str,
2006
help='file containing commit message'),
2008
help="refuse to commit if there are unknown "
2009
"files in the working tree."),
2011
help="perform a local only commit in a bound "
2012
"branch. Such commits are not pushed to "
2013
"the master branch until a normal commit "
2017
aliases = ['ci', 'checkin']
2019
def run(self, message=None, file=None, verbose=True, selected_list=None,
2020
unchanged=False, strict=False, local=False):
2021
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2022
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2024
from bzrlib.msgeditor import edit_commit_message, \
2025
make_commit_message_template
2027
# TODO: Need a blackbox test for invoking the external editor; may be
2028
# slightly problematic to run this cross-platform.
2030
# TODO: do more checks that the commit will succeed before
2031
# spending the user's valuable time typing a commit message.
2032
tree, selected_list = tree_files(selected_list)
2033
if selected_list == ['']:
2034
# workaround - commit of root of tree should be exactly the same
2035
# as just default commit in that tree, and succeed even though
2036
# selected-file merge commit is not done yet
2039
if local and not tree.branch.get_bound_location():
2040
raise errors.LocalRequiresBoundBranch()
2042
def get_message(commit_obj):
2043
"""Callback to get commit message"""
2044
my_message = message
2045
if my_message is None and not file:
2046
template = make_commit_message_template(tree, selected_list)
2047
my_message = edit_commit_message(template)
2048
if my_message is None:
2049
raise errors.BzrCommandError("please specify a commit"
2050
" message with either --message or --file")
2051
elif my_message and file:
2052
raise errors.BzrCommandError(
2053
"please specify either --message or --file")
2055
my_message = codecs.open(file, 'rt',
2056
bzrlib.user_encoding).read()
2057
if my_message == "":
2058
raise errors.BzrCommandError("empty commit message specified")
2062
reporter = ReportCommitToLog()
2064
reporter = NullCommitReporter()
2067
tree.commit(message_callback=get_message,
2068
specific_files=selected_list,
2069
allow_pointless=unchanged, strict=strict, local=local,
2071
except PointlessCommit:
2072
# FIXME: This should really happen before the file is read in;
2073
# perhaps prepare the commit; get the message; then actually commit
2074
raise errors.BzrCommandError("no changes to commit."
2075
" use --unchanged to commit anyhow")
2076
except ConflictsInTree:
2077
raise errors.BzrCommandError('Conflicts detected in working '
2078
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2080
except StrictCommitFailed:
2081
raise errors.BzrCommandError("Commit refused because there are"
2082
" unknown files in the working tree.")
2083
except errors.BoundBranchOutOfDate, e:
2084
raise errors.BzrCommandError(str(e) + "\n"
2085
'To commit to master branch, run update and then commit.\n'
2086
'You can also pass --local to commit to continue working '
2090
class cmd_check(Command):
2091
"""Validate consistency of branch history.
2093
This command checks various invariants about the branch storage to
2094
detect data corruption or bzr bugs.
2096
takes_args = ['branch?']
2097
takes_options = ['verbose']
2099
def run(self, branch=None, verbose=False):
2100
from bzrlib.check import check
2102
tree = WorkingTree.open_containing()[0]
2103
branch = tree.branch
2105
branch = Branch.open(branch)
2106
check(branch, verbose)
2109
class cmd_upgrade(Command):
2110
"""Upgrade branch storage to current format.
2112
The check command or bzr developers may sometimes advise you to run
2113
this command. When the default format has changed you may also be warned
2114
during other operations to upgrade.
2116
takes_args = ['url?']
2118
RegistryOption('format',
2119
help='Upgrade to a specific format. See "bzr help'
2120
' formats" for details',
2121
registry=bzrdir.format_registry,
2122
converter=bzrdir.format_registry.make_bzrdir,
2123
value_switches=True, title='Branch format'),
2127
def run(self, url='.', format=None):
2128
from bzrlib.upgrade import upgrade
2130
format = bzrdir.format_registry.make_bzrdir('default')
2131
upgrade(url, format)
2134
class cmd_whoami(Command):
2135
"""Show or set bzr user id.
2139
bzr whoami 'Frank Chu <fchu@example.com>'
2141
takes_options = [ Option('email',
2142
help='display email address only'),
2144
help='set identity for the current branch instead of '
2147
takes_args = ['name?']
2148
encoding_type = 'replace'
2151
def run(self, email=False, branch=False, name=None):
2153
# use branch if we're inside one; otherwise global config
2155
c = Branch.open_containing('.')[0].get_config()
2156
except errors.NotBranchError:
2157
c = config.GlobalConfig()
2159
self.outf.write(c.user_email() + '\n')
2161
self.outf.write(c.username() + '\n')
2164
# display a warning if an email address isn't included in the given name.
2166
config.extract_email_address(name)
2167
except errors.NoEmailInUsername, e:
2168
warning('"%s" does not seem to contain an email address. '
2169
'This is allowed, but not recommended.', name)
2171
# use global config unless --branch given
2173
c = Branch.open_containing('.')[0].get_config()
2175
c = config.GlobalConfig()
2176
c.set_user_option('email', name)
2179
class cmd_nick(Command):
2180
"""Print or set the branch nickname.
2182
If unset, the tree root directory name is used as the nickname
2183
To print the current nickname, execute with no argument.
2185
takes_args = ['nickname?']
2186
def run(self, nickname=None):
2187
branch = Branch.open_containing(u'.')[0]
2188
if nickname is None:
2189
self.printme(branch)
2191
branch.nick = nickname
2194
def printme(self, branch):
2198
class cmd_selftest(Command):
2199
"""Run internal test suite.
2201
This creates temporary test directories in the working directory, but not
2202
existing data is affected. These directories are deleted if the tests
2203
pass, or left behind to help in debugging if they fail and --keep-output
2206
If arguments are given, they are regular expressions that say which tests
2207
should run. Tests matching any expression are run, and other tests are
2210
Alternatively if --first is given, matching tests are run first and then
2211
all other tests are run. This is useful if you have been working in a
2212
particular area, but want to make sure nothing else was broken.
2214
If the global option '--no-plugins' is given, plugins are not loaded
2215
before running the selftests. This has two effects: features provided or
2216
modified by plugins will not be tested, and tests provided by plugins will
2221
run only tests relating to 'ignore'
2222
bzr --no-plugins selftest -v
2223
disable plugins and list tests as they're run
2225
For each test, that needs actual disk access, bzr create their own
2226
subdirectory in the temporary testing directory (testXXXX.tmp).
2227
By default the name of such subdirectory is based on the name of the test.
2228
If option '--numbered-dirs' is given, bzr will use sequent numbers
2229
of running tests to create such subdirectories. This is default behavior
2230
on Windows because of path length limitation.
2232
# TODO: --list should give a list of all available tests
2234
# NB: this is used from the class without creating an instance, which is
2235
# why it does not have a self parameter.
2236
def get_transport_type(typestring):
2237
"""Parse and return a transport specifier."""
2238
if typestring == "sftp":
2239
from bzrlib.transport.sftp import SFTPAbsoluteServer
2240
return SFTPAbsoluteServer
2241
if typestring == "memory":
2242
from bzrlib.transport.memory import MemoryServer
2244
if typestring == "fakenfs":
2245
from bzrlib.transport.fakenfs import FakeNFSServer
2246
return FakeNFSServer
2247
msg = "No known transport type %s. Supported types are: sftp\n" %\
2249
raise errors.BzrCommandError(msg)
2252
takes_args = ['testspecs*']
2253
takes_options = ['verbose',
2254
Option('one', help='stop when one test fails'),
2255
Option('keep-output',
2256
help='keep output directories when tests fail'),
2258
help='Use a different transport by default '
2259
'throughout the test suite.',
2260
type=get_transport_type),
2261
Option('benchmark', help='run the bzr bencharks.'),
2262
Option('lsprof-timed',
2263
help='generate lsprof output for benchmarked'
2264
' sections of code.'),
2265
Option('cache-dir', type=str,
2266
help='a directory to cache intermediate'
2267
' benchmark steps'),
2268
Option('clean-output',
2269
help='clean temporary tests directories'
2270
' without running tests'),
2272
help='run all tests, but run specified tests first',
2274
Option('numbered-dirs',
2275
help='use numbered dirs for TestCaseInTempDir'),
2277
encoding_type = 'replace'
2279
def run(self, testspecs_list=None, verbose=None, one=False,
2280
keep_output=False, transport=None, benchmark=None,
2281
lsprof_timed=None, cache_dir=None, clean_output=False,
2282
first=False, numbered_dirs=None):
2284
from bzrlib.tests import selftest
2285
import bzrlib.benchmarks as benchmarks
2286
from bzrlib.benchmarks import tree_creator
2289
from bzrlib.tests import clean_selftest_output
2290
clean_selftest_output()
2293
if numbered_dirs is None and sys.platform == 'win32':
2294
numbered_dirs = True
2296
if cache_dir is not None:
2297
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2298
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2299
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2301
if testspecs_list is not None:
2302
pattern = '|'.join(testspecs_list)
2306
test_suite_factory = benchmarks.test_suite
2309
# TODO: should possibly lock the history file...
2310
benchfile = open(".perf_history", "at", buffering=1)
2312
test_suite_factory = None
2317
result = selftest(verbose=verbose,
2319
stop_on_failure=one,
2320
keep_output=keep_output,
2321
transport=transport,
2322
test_suite_factory=test_suite_factory,
2323
lsprof_timed=lsprof_timed,
2324
bench_history=benchfile,
2325
matching_tests_first=first,
2326
numbered_dirs=numbered_dirs,
2329
if benchfile is not None:
2332
info('tests passed')
2334
info('tests failed')
2335
return int(not result)
2338
class cmd_version(Command):
2339
"""Show version of bzr."""
2343
from bzrlib.version import show_version
2347
class cmd_rocks(Command):
2348
"""Statement of optimism."""
2354
print "It sure does!"
2357
class cmd_find_merge_base(Command):
2358
"""Find and print a base revision for merging two branches."""
2359
# TODO: Options to specify revisions on either side, as if
2360
# merging only part of the history.
2361
takes_args = ['branch', 'other']
2365
def run(self, branch, other):
2366
from bzrlib.revision import MultipleRevisionSources
2368
branch1 = Branch.open_containing(branch)[0]
2369
branch2 = Branch.open_containing(other)[0]
2371
last1 = branch1.last_revision()
2372
last2 = branch2.last_revision()
2374
source = MultipleRevisionSources(branch1.repository,
2377
base_rev_id = common_ancestor(last1, last2, source)
2379
print 'merge base is revision %s' % base_rev_id
2382
class cmd_merge(Command):
2383
"""Perform a three-way merge.
2385
The branch is the branch you will merge from. By default, it will merge
2386
the latest revision. If you specify a revision, that revision will be
2387
merged. If you specify two revisions, the first will be used as a BASE,
2388
and the second one as OTHER. Revision numbers are always relative to the
2391
By default, bzr will try to merge in all new work from the other
2392
branch, automatically determining an appropriate base. If this
2393
fails, you may need to give an explicit base.
2395
Merge will do its best to combine the changes in two branches, but there
2396
are some kinds of problems only a human can fix. When it encounters those,
2397
it will mark a conflict. A conflict means that you need to fix something,
2398
before you should commit.
2400
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2402
If there is no default branch set, the first merge will set it. After
2403
that, you can omit the branch to use the default. To change the
2404
default, use --remember. The value will only be saved if the remote
2405
location can be accessed.
2407
The results of the merge are placed into the destination working
2408
directory, where they can be reviewed (with bzr diff), tested, and then
2409
committed to record the result of the merge.
2413
To merge the latest revision from bzr.dev
2414
bzr merge ../bzr.dev
2416
To merge changes up to and including revision 82 from bzr.dev
2417
bzr merge -r 82 ../bzr.dev
2419
To merge the changes introduced by 82, without previous changes:
2420
bzr merge -r 81..82 ../bzr.dev
2422
merge refuses to run if there are any uncommitted changes, unless
2425
The following merge types are available:
2427
takes_args = ['branch?']
2428
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2429
Option('show-base', help="Show base revision text in "
2431
Option('uncommitted', help='Apply uncommitted changes'
2432
' from a working copy, instead of branch changes'),
2433
Option('pull', help='If the destination is already'
2434
' completely merged into the source, pull from the'
2435
' source rather than merging. When this happens,'
2436
' you do not need to commit the result.'),
2438
help='Branch to merge into, '
2439
'rather than the one containing the working directory',
2445
def run(self, branch=None, revision=None, force=False, merge_type=None,
2446
show_base=False, reprocess=False, remember=False,
2447
uncommitted=False, pull=False,
2450
from bzrlib.tag import _merge_tags_if_possible
2451
if merge_type is None:
2452
merge_type = _mod_merge.Merge3Merger
2454
if directory is None: directory = u'.'
2455
tree = WorkingTree.open_containing(directory)[0]
2456
change_reporter = delta.ChangeReporter(tree.inventory)
2458
if branch is not None:
2460
reader = bundle.read_bundle_from_url(branch)
2461
except errors.NotABundle:
2462
pass # Continue on considering this url a Branch
2464
conflicts = merge_bundle(reader, tree, not force, merge_type,
2465
reprocess, show_base, change_reporter)
2471
if revision is None \
2472
or len(revision) < 1 or revision[0].needs_branch():
2473
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2475
if revision is None or len(revision) < 1:
2478
other = [branch, None]
2481
other = [branch, -1]
2482
other_branch, path = Branch.open_containing(branch)
2485
raise errors.BzrCommandError('Cannot use --uncommitted and'
2486
' --revision at the same time.')
2487
branch = revision[0].get_branch() or branch
2488
if len(revision) == 1:
2490
other_branch, path = Branch.open_containing(branch)
2491
revno = revision[0].in_history(other_branch).revno
2492
other = [branch, revno]
2494
assert len(revision) == 2
2495
if None in revision:
2496
raise errors.BzrCommandError(
2497
"Merge doesn't permit empty revision specifier.")
2498
base_branch, path = Branch.open_containing(branch)
2499
branch1 = revision[1].get_branch() or branch
2500
other_branch, path1 = Branch.open_containing(branch1)
2501
if revision[0].get_branch() is not None:
2502
# then path was obtained from it, and is None.
2505
base = [branch, revision[0].in_history(base_branch).revno]
2506
other = [branch1, revision[1].in_history(other_branch).revno]
2508
if tree.branch.get_parent() is None or remember:
2509
tree.branch.set_parent(other_branch.base)
2511
# pull tags now... it's a bit inconsistent to do it ahead of copying
2512
# the history but that's done inside the merge code
2513
_merge_tags_if_possible(other_branch, tree.branch)
2516
interesting_files = [path]
2518
interesting_files = None
2519
pb = ui.ui_factory.nested_progress_bar()
2522
conflict_count = _merge_helper(
2523
other, base, check_clean=(not force),
2524
merge_type=merge_type,
2525
reprocess=reprocess,
2526
show_base=show_base,
2529
pb=pb, file_list=interesting_files,
2530
change_reporter=change_reporter)
2533
if conflict_count != 0:
2537
except errors.AmbiguousBase, e:
2538
m = ("sorry, bzr can't determine the right merge base yet\n"
2539
"candidates are:\n "
2540
+ "\n ".join(e.bases)
2542
"please specify an explicit base with -r,\n"
2543
"and (if you want) report this to the bzr developers\n")
2546
# TODO: move up to common parent; this isn't merge-specific anymore.
2547
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2548
"""Use tree.branch's parent if none was supplied.
2550
Report if the remembered location was used.
2552
if supplied_location is not None:
2553
return supplied_location
2554
stored_location = tree.branch.get_parent()
2555
mutter("%s", stored_location)
2556
if stored_location is None:
2557
raise errors.BzrCommandError("No location specified or remembered")
2558
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2559
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2560
return stored_location
2563
class cmd_remerge(Command):
2566
Use this if you want to try a different merge technique while resolving
2567
conflicts. Some merge techniques are better than others, and remerge
2568
lets you try different ones on different files.
2570
The options for remerge have the same meaning and defaults as the ones for
2571
merge. The difference is that remerge can (only) be run when there is a
2572
pending merge, and it lets you specify particular files.
2575
$ bzr remerge --show-base
2576
Re-do the merge of all conflicted files, and show the base text in
2577
conflict regions, in addition to the usual THIS and OTHER texts.
2579
$ bzr remerge --merge-type weave --reprocess foobar
2580
Re-do the merge of "foobar", using the weave merge algorithm, with
2581
additional processing to reduce the size of conflict regions.
2583
The following merge types are available:"""
2584
takes_args = ['file*']
2585
takes_options = ['merge-type', 'reprocess',
2586
Option('show-base', help="Show base revision text in "
2589
def run(self, file_list=None, merge_type=None, show_base=False,
2591
if merge_type is None:
2592
merge_type = _mod_merge.Merge3Merger
2593
tree, file_list = tree_files(file_list)
2596
parents = tree.get_parent_ids()
2597
if len(parents) != 2:
2598
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2599
" merges. Not cherrypicking or"
2601
repository = tree.branch.repository
2602
base_revision = common_ancestor(parents[0],
2603
parents[1], repository)
2604
base_tree = repository.revision_tree(base_revision)
2605
other_tree = repository.revision_tree(parents[1])
2606
interesting_ids = None
2608
conflicts = tree.conflicts()
2609
if file_list is not None:
2610
interesting_ids = set()
2611
for filename in file_list:
2612
file_id = tree.path2id(filename)
2614
raise errors.NotVersionedError(filename)
2615
interesting_ids.add(file_id)
2616
if tree.kind(file_id) != "directory":
2619
for name, ie in tree.inventory.iter_entries(file_id):
2620
interesting_ids.add(ie.file_id)
2621
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2623
# Remerge only supports resolving contents conflicts
2624
allowed_conflicts = ('text conflict', 'contents conflict')
2625
restore_files = [c.path for c in conflicts
2626
if c.typestring in allowed_conflicts]
2627
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2628
tree.set_conflicts(ConflictList(new_conflicts))
2629
if file_list is not None:
2630
restore_files = file_list
2631
for filename in restore_files:
2633
restore(tree.abspath(filename))
2634
except errors.NotConflicted:
2636
conflicts = _mod_merge.merge_inner(
2637
tree.branch, other_tree, base_tree,
2639
interesting_ids=interesting_ids,
2640
other_rev_id=parents[1],
2641
merge_type=merge_type,
2642
show_base=show_base,
2643
reprocess=reprocess)
2652
class cmd_revert(Command):
2653
"""Revert files to a previous revision.
2655
Giving a list of files will revert only those files. Otherwise, all files
2656
will be reverted. If the revision is not specified with '--revision', the
2657
last committed revision is used.
2659
To remove only some changes, without reverting to a prior version, use
2660
merge instead. For example, "merge . --r-2..-3" will remove the changes
2661
introduced by -2, without affecting the changes introduced by -1. Or
2662
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2664
By default, any files that have been manually changed will be backed up
2665
first. (Files changed only by merge are not backed up.) Backup files have
2666
'.~#~' appended to their name, where # is a number.
2668
When you provide files, you can use their current pathname or the pathname
2669
from the target revision. So you can use revert to "undelete" a file by
2670
name. If you name a directory, all the contents of that directory will be
2673
takes_options = ['revision', 'no-backup']
2674
takes_args = ['file*']
2675
aliases = ['merge-revert']
2677
def run(self, revision=None, no_backup=False, file_list=None):
2678
if file_list is not None:
2679
if len(file_list) == 0:
2680
raise errors.BzrCommandError("No files specified")
2684
tree, file_list = tree_files(file_list)
2685
if revision is None:
2686
# FIXME should be tree.last_revision
2687
rev_id = tree.last_revision()
2688
elif len(revision) != 1:
2689
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2691
rev_id = revision[0].in_history(tree.branch).rev_id
2692
pb = ui.ui_factory.nested_progress_bar()
2694
tree.revert(file_list,
2695
tree.branch.repository.revision_tree(rev_id),
2696
not no_backup, pb, report_changes=True)
2701
class cmd_assert_fail(Command):
2702
"""Test reporting of assertion failures"""
2703
# intended just for use in testing
2708
raise AssertionError("always fails")
2711
class cmd_help(Command):
2712
"""Show help on a command or other topic.
2714
For a list of all available commands, say 'bzr help commands'.
2716
takes_options = [Option('long', 'show help on all commands')]
2717
takes_args = ['topic?']
2718
aliases = ['?', '--help', '-?', '-h']
2721
def run(self, topic=None, long=False):
2723
if topic is None and long:
2725
bzrlib.help.help(topic)
2728
class cmd_shell_complete(Command):
2729
"""Show appropriate completions for context.
2731
For a list of all available commands, say 'bzr shell-complete'.
2733
takes_args = ['context?']
2738
def run(self, context=None):
2739
import shellcomplete
2740
shellcomplete.shellcomplete(context)
2743
class cmd_fetch(Command):
2744
"""Copy in history from another branch but don't merge it.
2746
This is an internal method used for pull and merge.
2749
takes_args = ['from_branch', 'to_branch']
2750
def run(self, from_branch, to_branch):
2751
from bzrlib.fetch import Fetcher
2752
from_b = Branch.open(from_branch)
2753
to_b = Branch.open(to_branch)
2754
Fetcher(to_b, from_b)
2757
class cmd_missing(Command):
2758
"""Show unmerged/unpulled revisions between two branches.
2760
OTHER_BRANCH may be local or remote.
2762
takes_args = ['other_branch?']
2763
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2765
'Display changes in the local branch only'),
2766
Option('theirs-only',
2767
'Display changes in the remote branch only'),
2772
encoding_type = 'replace'
2775
def run(self, other_branch=None, reverse=False, mine_only=False,
2776
theirs_only=False, log_format=None, long=False, short=False, line=False,
2777
show_ids=False, verbose=False):
2778
from bzrlib.missing import find_unmerged, iter_log_data
2779
from bzrlib.log import log_formatter
2780
local_branch = Branch.open_containing(u".")[0]
2781
parent = local_branch.get_parent()
2782
if other_branch is None:
2783
other_branch = parent
2784
if other_branch is None:
2785
raise errors.BzrCommandError("No peer location known or specified.")
2786
display_url = urlutils.unescape_for_display(parent,
2788
print "Using last location: " + display_url
2790
remote_branch = Branch.open(other_branch)
2791
if remote_branch.base == local_branch.base:
2792
remote_branch = local_branch
2793
local_branch.lock_read()
2795
remote_branch.lock_read()
2797
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2798
if (log_format is None):
2799
log_format = log.log_formatter_registry.get_default(
2801
lf = log_format(to_file=self.outf,
2803
show_timezone='original')
2804
if reverse is False:
2805
local_extra.reverse()
2806
remote_extra.reverse()
2807
if local_extra and not theirs_only:
2808
print "You have %d extra revision(s):" % len(local_extra)
2809
for data in iter_log_data(local_extra, local_branch.repository,
2812
printed_local = True
2814
printed_local = False
2815
if remote_extra and not mine_only:
2816
if printed_local is True:
2818
print "You are missing %d revision(s):" % len(remote_extra)
2819
for data in iter_log_data(remote_extra, remote_branch.repository,
2822
if not remote_extra and not local_extra:
2824
print "Branches are up to date."
2828
remote_branch.unlock()
2830
local_branch.unlock()
2831
if not status_code and parent is None and other_branch is not None:
2832
local_branch.lock_write()
2834
# handle race conditions - a parent might be set while we run.
2835
if local_branch.get_parent() is None:
2836
local_branch.set_parent(remote_branch.base)
2838
local_branch.unlock()
2842
class cmd_plugins(Command):
2847
import bzrlib.plugin
2848
from inspect import getdoc
2849
for name, plugin in bzrlib.plugin.all_plugins().items():
2850
if getattr(plugin, '__path__', None) is not None:
2851
print plugin.__path__[0]
2852
elif getattr(plugin, '__file__', None) is not None:
2853
print plugin.__file__
2859
print '\t', d.split('\n')[0]
2862
class cmd_testament(Command):
2863
"""Show testament (signing-form) of a revision."""
2864
takes_options = ['revision',
2865
Option('long', help='Produce long-format testament'),
2866
Option('strict', help='Produce a strict-format'
2868
takes_args = ['branch?']
2870
def run(self, branch=u'.', revision=None, long=False, strict=False):
2871
from bzrlib.testament import Testament, StrictTestament
2873
testament_class = StrictTestament
2875
testament_class = Testament
2876
b = WorkingTree.open_containing(branch)[0].branch
2879
if revision is None:
2880
rev_id = b.last_revision()
2882
rev_id = revision[0].in_history(b).rev_id
2883
t = testament_class.from_revision(b.repository, rev_id)
2885
sys.stdout.writelines(t.as_text_lines())
2887
sys.stdout.write(t.as_short_text())
2892
class cmd_annotate(Command):
2893
"""Show the origin of each line in a file.
2895
This prints out the given file with an annotation on the left side
2896
indicating which revision, author and date introduced the change.
2898
If the origin is the same for a run of consecutive lines, it is
2899
shown only at the top, unless the --all option is given.
2901
# TODO: annotate directories; showing when each file was last changed
2902
# TODO: if the working copy is modified, show annotations on that
2903
# with new uncommitted lines marked
2904
aliases = ['ann', 'blame', 'praise']
2905
takes_args = ['filename']
2906
takes_options = [Option('all', help='show annotations on all lines'),
2907
Option('long', help='show date in annotations'),
2913
def run(self, filename, all=False, long=False, revision=None,
2915
from bzrlib.annotate import annotate_file
2916
tree, relpath = WorkingTree.open_containing(filename)
2917
branch = tree.branch
2920
if revision is None:
2921
revision_id = branch.last_revision()
2922
elif len(revision) != 1:
2923
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2925
revision_id = revision[0].in_history(branch).rev_id
2926
file_id = tree.inventory.path2id(relpath)
2927
tree = branch.repository.revision_tree(revision_id)
2928
file_version = tree.inventory[file_id].revision
2929
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2935
class cmd_re_sign(Command):
2936
"""Create a digital signature for an existing revision."""
2937
# TODO be able to replace existing ones.
2939
hidden = True # is this right ?
2940
takes_args = ['revision_id*']
2941
takes_options = ['revision']
2943
def run(self, revision_id_list=None, revision=None):
2944
import bzrlib.gpg as gpg
2945
if revision_id_list is not None and revision is not None:
2946
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2947
if revision_id_list is None and revision is None:
2948
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2949
b = WorkingTree.open_containing(u'.')[0].branch
2950
gpg_strategy = gpg.GPGStrategy(b.get_config())
2951
if revision_id_list is not None:
2952
for revision_id in revision_id_list:
2953
b.repository.sign_revision(revision_id, gpg_strategy)
2954
elif revision is not None:
2955
if len(revision) == 1:
2956
revno, rev_id = revision[0].in_history(b)
2957
b.repository.sign_revision(rev_id, gpg_strategy)
2958
elif len(revision) == 2:
2959
# are they both on rh- if so we can walk between them
2960
# might be nice to have a range helper for arbitrary
2961
# revision paths. hmm.
2962
from_revno, from_revid = revision[0].in_history(b)
2963
to_revno, to_revid = revision[1].in_history(b)
2964
if to_revid is None:
2965
to_revno = b.revno()
2966
if from_revno is None or to_revno is None:
2967
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2968
for revno in range(from_revno, to_revno + 1):
2969
b.repository.sign_revision(b.get_rev_id(revno),
2972
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2975
class cmd_bind(Command):
2976
"""Convert the current branch into a checkout of the supplied branch.
2978
Once converted into a checkout, commits must succeed on the master branch
2979
before they will be applied to the local branch.
2981
See "help checkouts" for more information on checkouts.
2984
takes_args = ['location?']
2987
def run(self, location=None):
2988
b, relpath = Branch.open_containing(u'.')
2989
if location is None:
2991
location = b.get_old_bound_location()
2992
except errors.UpgradeRequired:
2993
raise errors.BzrCommandError('No location supplied. '
2994
'This format does not remember old locations.')
2996
if location is None:
2997
raise errors.BzrCommandError('No location supplied and no '
2998
'previous location known')
2999
b_other = Branch.open(location)
3002
except errors.DivergedBranches:
3003
raise errors.BzrCommandError('These branches have diverged.'
3004
' Try merging, and then bind again.')
3007
class cmd_unbind(Command):
3008
"""Convert the current checkout into a regular branch.
3010
After unbinding, the local branch is considered independent and subsequent
3011
commits will be local only.
3013
See "help checkouts" for more information on checkouts.
3020
b, relpath = Branch.open_containing(u'.')
3022
raise errors.BzrCommandError('Local branch is not bound')
3025
class cmd_uncommit(Command):
3026
"""Remove the last committed revision.
3028
--verbose will print out what is being removed.
3029
--dry-run will go through all the motions, but not actually
3032
In the future, uncommit will create a revision bundle, which can then
3036
# TODO: jam 20060108 Add an option to allow uncommit to remove
3037
# unreferenced information in 'branch-as-repository' branches.
3038
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3039
# information in shared branches as well.
3040
takes_options = ['verbose', 'revision',
3041
Option('dry-run', help='Don\'t actually make changes'),
3042
Option('force', help='Say yes to all questions.')]
3043
takes_args = ['location?']
3046
def run(self, location=None,
3047
dry_run=False, verbose=False,
3048
revision=None, force=False):
3049
from bzrlib.log import log_formatter, show_log
3051
from bzrlib.uncommit import uncommit
3053
if location is None:
3055
control, relpath = bzrdir.BzrDir.open_containing(location)
3057
tree = control.open_workingtree()
3059
except (errors.NoWorkingTree, errors.NotLocalUrl):
3061
b = control.open_branch()
3064
if revision is None:
3067
# 'bzr uncommit -r 10' actually means uncommit
3068
# so that the final tree is at revno 10.
3069
# but bzrlib.uncommit.uncommit() actually uncommits
3070
# the revisions that are supplied.
3071
# So we need to offset it by one
3072
revno = revision[0].in_history(b).revno+1
3074
if revno <= b.revno():
3075
rev_id = b.get_rev_id(revno)
3077
self.outf.write('No revisions to uncommit.\n')
3080
lf = log_formatter('short',
3082
show_timezone='original')
3087
direction='forward',
3088
start_revision=revno,
3089
end_revision=b.revno())
3092
print 'Dry-run, pretending to remove the above revisions.'
3094
val = raw_input('Press <enter> to continue')
3096
print 'The above revision(s) will be removed.'
3098
val = raw_input('Are you sure [y/N]? ')
3099
if val.lower() not in ('y', 'yes'):
3103
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3107
class cmd_break_lock(Command):
3108
"""Break a dead lock on a repository, branch or working directory.
3110
CAUTION: Locks should only be broken when you are sure that the process
3111
holding the lock has been stopped.
3113
You can get information on what locks are open via the 'bzr info' command.
3118
takes_args = ['location?']
3120
def run(self, location=None, show=False):
3121
if location is None:
3123
control, relpath = bzrdir.BzrDir.open_containing(location)
3125
control.break_lock()
3126
except NotImplementedError:
3130
class cmd_wait_until_signalled(Command):
3131
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3133
This just prints a line to signal when it is ready, then blocks on stdin.
3139
sys.stdout.write("running\n")
3141
sys.stdin.readline()
3144
class cmd_serve(Command):
3145
"""Run the bzr server."""
3147
aliases = ['server']
3151
help='serve on stdin/out for use from inetd or sshd'),
3153
help='listen for connections on nominated port of the form '
3154
'[hostname:]portnumber. Passing 0 as the port number will '
3155
'result in a dynamically allocated port. Default port is '
3159
help='serve contents of directory',
3161
Option('allow-writes',
3162
help='By default the server is a readonly server. Supplying '
3163
'--allow-writes enables write access to the contents of '
3164
'the served directory and below. '
3168
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3169
from bzrlib.transport import smart
3170
from bzrlib.transport import get_transport
3171
if directory is None:
3172
directory = os.getcwd()
3173
url = urlutils.local_path_to_url(directory)
3174
if not allow_writes:
3175
url = 'readonly+' + url
3176
t = get_transport(url)
3178
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3181
port = smart.BZR_DEFAULT_PORT
3185
host, port = port.split(':')
3189
server = smart.SmartTCPServer(t, host=host, port=port)
3190
print 'listening on port: ', server.port
3195
class cmd_tag(Command):
3196
"""Create a tag naming a revision.
3198
Tags give human-meaningful names to revisions. Commands that take a -r
3199
(--revision) option can be given -rtag:X, where X is any previously
3202
Tags are stored in the branch. Tags are copied from one branch to another
3203
along when you branch, push, pull or merge.
3205
It is an error to give a tag name that already exists unless you pass
3206
--force, in which case the tag is moved to point to the new revision.
3209
takes_args = ['tag_name']
3212
help='Delete this tag rather than placing it.',
3215
help='Branch in which to place the tag.',
3220
help='Replace existing tags',
3225
def run(self, tag_name,
3231
branch, relpath = Branch.open_containing(directory)
3235
branch.tags.delete_tag(tag_name)
3236
self.outf.write('Deleted tag %s.\n' % tag_name)
3239
if len(revision) != 1:
3240
raise errors.BzrCommandError(
3241
"Tags can only be placed on a single revision, "
3243
revision_id = revision[0].in_history(branch).rev_id
3245
revision_id = branch.last_revision()
3246
if (not force) and branch.tags.has_tag(tag_name):
3247
raise errors.TagAlreadyExists(tag_name)
3248
branch.tags.set_tag(tag_name, revision_id)
3249
self.outf.write('Created tag %s.\n' % tag_name)
3254
class cmd_tags(Command):
3257
This tag shows a table of tag names and the revisions they reference.
3262
help='Branch whose tags should be displayed',
3272
branch, relpath = Branch.open_containing(directory)
3273
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3274
self.outf.write('%-20s %s\n' % (tag_name, target))
3277
# command-line interpretation helper for merge-related commands
3278
def _merge_helper(other_revision, base_revision,
3279
check_clean=True, ignore_zero=False,
3280
this_dir=None, backup_files=False,
3282
file_list=None, show_base=False, reprocess=False,
3285
change_reporter=None):
3286
"""Merge changes into a tree.
3289
list(path, revno) Base for three-way merge.
3290
If [None, None] then a base will be automatically determined.
3292
list(path, revno) Other revision for three-way merge.
3294
Directory to merge changes into; '.' by default.
3296
If true, this_dir must have no uncommitted changes before the
3298
ignore_zero - If true, suppress the "zero conflicts" message when
3299
there are no conflicts; should be set when doing something we expect
3300
to complete perfectly.
3301
file_list - If supplied, merge only changes to selected files.
3303
All available ancestors of other_revision and base_revision are
3304
automatically pulled into the branch.
3306
The revno may be -1 to indicate the last revision on the branch, which is
3309
This function is intended for use from the command line; programmatic
3310
clients might prefer to call merge.merge_inner(), which has less magic
3313
# Loading it late, so that we don't always have to import bzrlib.merge
3314
if merge_type is None:
3315
merge_type = _mod_merge.Merge3Merger
3316
if this_dir is None:
3318
this_tree = WorkingTree.open_containing(this_dir)[0]
3319
if show_base and not merge_type is _mod_merge.Merge3Merger:
3320
raise errors.BzrCommandError("Show-base is not supported for this merge"
3321
" type. %s" % merge_type)
3322
if reprocess and not merge_type.supports_reprocess:
3323
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3324
" type %s." % merge_type)
3325
if reprocess and show_base:
3326
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3328
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3329
pb=pb, change_reporter=change_reporter)
3330
merger.pp = ProgressPhase("Merge phase", 5, pb)
3331
merger.pp.next_phase()
3332
merger.check_basis(check_clean)
3333
merger.set_other(other_revision)
3334
merger.pp.next_phase()
3335
merger.set_base(base_revision)
3336
if merger.base_rev_id == merger.other_rev_id:
3337
note('Nothing to do.')
3339
if file_list is None:
3340
if pull and merger.base_rev_id == merger.this_rev_id:
3341
# FIXME: deduplicate with pull
3342
result = merger.this_tree.pull(merger.this_branch,
3343
False, merger.other_rev_id)
3344
if result.old_revid == result.new_revid:
3345
note('No revisions to pull.')
3347
note('Now on revision %d.' % result.new_revno)
3349
merger.backup_files = backup_files
3350
merger.merge_type = merge_type
3351
merger.set_interesting_files(file_list)
3352
merger.show_base = show_base
3353
merger.reprocess = reprocess
3354
conflicts = merger.do_merge()
3355
if file_list is None:
3356
merger.set_pending()
3363
merge = _merge_helper
3366
# these get imported and then picked up by the scan for cmd_*
3367
# TODO: Some more consistent way to split command definitions across files;
3368
# we do need to load at least some information about them to know of
3369
# aliases. ideally we would avoid loading the implementation until the
3370
# details were needed.
3371
from bzrlib.cmd_version_info import cmd_version_info
3372
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3373
from bzrlib.bundle.commands import cmd_bundle_revisions
3374
from bzrlib.sign_my_commits import cmd_sign_my_commits
3375
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3376
cmd_weave_plan_merge, cmd_weave_merge_text